summaryrefslogtreecommitdiffstats
path: root/common/print.h
blob: 930e84be99d555871aec946f27cf2c49f909eb76 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/* Copyright 2012 Jun Wako <wakojun@gmail.com> */
/* Very basic print functions, intended to be used with usb_debug_only.c
 * http://www.pjrc.com/teensy/
 * Copyright (c) 2008 PJRC.COM, LLC
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef PRINT_H__
#define PRINT_H__ 1

#include <stdint.h>
#include <stdbool.h>
#include <avr/pgmspace.h>
#include "xprintf.h"
#include "util.h"


// this macro allows you to write print("some text") and
// the string is automatically placed into flash memory :)
// TODO: avoid collision with arduino/Print.h
#ifndef __cplusplus
#define print(s)                print_P(PSTR(s))
#endif
#define println(s)              print_P(PSTR(s "\n"))

/* for old name */
#define pdec(data)              print_dec(data)
#define pdec16(data)            print_dec(data)
#define phex(data)              print_hex8(data)
#define phex16(data)            print_hex16(data)
#define pbin(data)              print_bin8(data)
#define pbin16(data)            print_bin16(data)
#define pbin_reverse(data)      print_bin_reverse8(data)
#define pbin_reverse16(data)    print_bin_reverse16(data)

/* print value utility */
#define print_val_dec(v)           xprintf(#v ": %u\n", v)
#define print_val_decs(v)          xprintf(#v ": %d\n", v)
#define print_val_hex8(v)          xprintf(#v ": %X\n", v)
#define print_val_hex16(v)         xprintf(#v ": %02X\n", v)
#define print_val_hex32(v)         xprintf(#v ": %04lX\n", v)
#define print_val_bin8(v)          xprintf(#v ": %08b\n", v)
#define print_val_bin16(v)         xprintf(#v ": %016b\n", v)
#define print_val_bin32(v)         xprintf(#v ": %032lb\n", v)
#define print_val_bin_reverse8(v)  xprintf(#v ": %08b\n", bitrev(v))
#define print_val_bin_reverse16(v) xprintf(#v ": %016b\n", bitrev16(v))
#define print_val_bin_reverse32(v) xprintf(#v ": %032lb\n", bitrev32(v))



#ifndef NO_PRINT

#ifdef __cplusplus
extern "C" {
#endif

/* function pointer of sendchar to be used by print utility */
void print_set_sendchar(int8_t (*print_sendchar_func)(uint8_t));

/* print string stored in data memory(SRAM)
 *     print_S("hello world");
 * This consumes precious SRAM memory space for string.
 */
void print_S(const char *s);

void print_lf(void);
void print_crlf(void);


/* print string stored in program memory(FLASH)
 *     print_P(PSTR("hello world");
 * This consumes relatively abundant FLASH memory area not SRAM.
 */
#define print_P(s)          xputs(s)

/* decimal */
#define print_dec(i)        xprintf("%u", i)
#define print_decs(i)       xprintf("%d", i)

/* hex */
#define print_hex4(i)       xprintf("%X", i)
#define print_hex8(i)       xprintf("%02X", i)
#define print_hex16(i)      xprintf("%04X", i)
#define print_hex32(i)      xprintf("%08lX", i)

/* binary */
#define print_bin4(i)       xprintf("%04b", i)
#define print_bin8(i)       xprintf("%08b", i)
#define print_bin16(i)      xprintf("%016b", i)
#define print_bin32(i)      xprintf("%032lb", i)

#define print_bin_reverse8(i)   xprintf("%08b", bitrev(i))
#define print_bin_reverse16(i)  xprintf("%016b", bitrev16(i))
#define print_bin_reverse32(i)  xprintf("%032lb", bitrev32(i))

#ifdef __cplusplus
}
#endif

#else

#define print_set_sendchar(func)
#define print_S(s)
#define print_P(s)
#define print_dec(data)
#define print_decs(data)
#define print_hex4(data)
#define print_hex8(data)
#define print_hex16(data)
#define print_hex32(data)
#define print_bin4(data)
#define print_bin8(data)
#define print_bin16(data)
#define print_bin32(data)
#define print_bin_reverse8(data)
#define print_bin_reverse16(data)
#define print_bin_reverse32(data)

#endif


#endif