930e84be99d555871aec946f27cf2c49f909eb76
[tmk_keyboard.git] / common / print.h
1 /* Copyright 2012 Jun Wako <wakojun@gmail.com> */
2 /* Very basic print functions, intended to be used with usb_debug_only.c
3 * http://www.pjrc.com/teensy/
4 * Copyright (c) 2008 PJRC.COM, LLC
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24
25 #ifndef PRINT_H__
26 #define PRINT_H__ 1
27
28 #include <stdint.h>
29 #include <stdbool.h>
30 #include <avr/pgmspace.h>
31 #include "xprintf.h"
32 #include "util.h"
33
34
35 // this macro allows you to write print("some text") and
36 // the string is automatically placed into flash memory :)
37 // TODO: avoid collision with arduino/Print.h
38 #ifndef __cplusplus
39 #define print(s) print_P(PSTR(s))
40 #endif
41 #define println(s) print_P(PSTR(s "\n"))
42
43 /* for old name */
44 #define pdec(data) print_dec(data)
45 #define pdec16(data) print_dec(data)
46 #define phex(data) print_hex8(data)
47 #define phex16(data) print_hex16(data)
48 #define pbin(data) print_bin8(data)
49 #define pbin16(data) print_bin16(data)
50 #define pbin_reverse(data) print_bin_reverse8(data)
51 #define pbin_reverse16(data) print_bin_reverse16(data)
52
53 /* print value utility */
54 #define print_val_dec(v) xprintf(#v ": %u\n", v)
55 #define print_val_decs(v) xprintf(#v ": %d\n", v)
56 #define print_val_hex8(v) xprintf(#v ": %X\n", v)
57 #define print_val_hex16(v) xprintf(#v ": %02X\n", v)
58 #define print_val_hex32(v) xprintf(#v ": %04lX\n", v)
59 #define print_val_bin8(v) xprintf(#v ": %08b\n", v)
60 #define print_val_bin16(v) xprintf(#v ": %016b\n", v)
61 #define print_val_bin32(v) xprintf(#v ": %032lb\n", v)
62 #define print_val_bin_reverse8(v) xprintf(#v ": %08b\n", bitrev(v))
63 #define print_val_bin_reverse16(v) xprintf(#v ": %016b\n", bitrev16(v))
64 #define print_val_bin_reverse32(v) xprintf(#v ": %032lb\n", bitrev32(v))
65
66
67
68 #ifndef NO_PRINT
69
70 #ifdef __cplusplus
71 extern "C" {
72 #endif
73
74 /* function pointer of sendchar to be used by print utility */
75 void print_set_sendchar(int8_t (*print_sendchar_func)(uint8_t));
76
77 /* print string stored in data memory(SRAM)
78 * print_S("hello world");
79 * This consumes precious SRAM memory space for string.
80 */
81 void print_S(const char *s);
82
83 void print_lf(void);
84 void print_crlf(void);
85
86
87 /* print string stored in program memory(FLASH)
88 * print_P(PSTR("hello world");
89 * This consumes relatively abundant FLASH memory area not SRAM.
90 */
91 #define print_P(s) xputs(s)
92
93 /* decimal */
94 #define print_dec(i) xprintf("%u", i)
95 #define print_decs(i) xprintf("%d", i)
96
97 /* hex */
98 #define print_hex4(i) xprintf("%X", i)
99 #define print_hex8(i) xprintf("%02X", i)
100 #define print_hex16(i) xprintf("%04X", i)
101 #define print_hex32(i) xprintf("%08lX", i)
102
103 /* binary */
104 #define print_bin4(i) xprintf("%04b", i)
105 #define print_bin8(i) xprintf("%08b", i)
106 #define print_bin16(i) xprintf("%016b", i)
107 #define print_bin32(i) xprintf("%032lb", i)
108
109 #define print_bin_reverse8(i) xprintf("%08b", bitrev(i))
110 #define print_bin_reverse16(i) xprintf("%016b", bitrev16(i))
111 #define print_bin_reverse32(i) xprintf("%032lb", bitrev32(i))
112
113 #ifdef __cplusplus
114 }
115 #endif
116
117 #else
118
119 #define print_set_sendchar(func)
120 #define print_S(s)
121 #define print_P(s)
122 #define print_dec(data)
123 #define print_decs(data)
124 #define print_hex4(data)
125 #define print_hex8(data)
126 #define print_hex16(data)
127 #define print_hex32(data)
128 #define print_bin4(data)
129 #define print_bin8(data)
130 #define print_bin16(data)
131 #define print_bin32(data)
132 #define print_bin_reverse8(data)
133 #define print_bin_reverse16(data)
134 #define print_bin_reverse32(data)
135
136 #endif
137
138
139 #endif
Imprint / Impressum