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
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
32 #if defined(PROTOCOL_CHIBIOS) || defined(PROTOCOL_ARM_ATSAM)
39 #if defined(__AVR__) /* __AVR__ */
41 # include "avr/xprintf.h"
43 # ifdef USER_PRINT /* USER_PRINT */
45 // Remove normal print defines
49 # define xprintf(fmt, ...)
51 // Create user print defines
52 # define uprint(s) xputs(PSTR(s))
53 # define uprintln(s) xputs(PSTR(s "\r\n"))
54 # define uprintf(fmt, ...) __xprintf(PSTR(fmt), ##__VA_ARGS__)
56 # else /* NORMAL PRINT */
58 // Create user & normal print defines
59 # define print(s) xputs(PSTR(s))
60 # define println(s) xputs(PSTR(s "\r\n"))
61 # define uprint(s) print(s)
62 # define uprintln(s) println(s)
63 # define uprintf(fmt, ...) xprintf(fmt, ##__VA_ARGS__)
65 # endif /* USER_PRINT / NORMAL PRINT */
71 /* function pointer of sendchar to be used by print utility */
72 void print_set_sendchar(int8_t (*print_sendchar_func)(uint8_t));
74 #elif defined(PROTOCOL_CHIBIOS) /* PROTOCOL_CHIBIOS */
76 #ifndef TERMINAL_ENABLE
77 # include "chibios/printf.h"
80 # ifdef USER_PRINT /* USER_PRINT */
82 // Remove normal print defines
85 # define xprintf(fmt, ...)
87 // Create user print defines
88 # define uprint(s) printf(s)
89 # define uprintln(s) printf(s "\r\n")
90 # define uprintf printf
92 # else /* NORMAL PRINT */
94 // Create user & normal print defines
95 # define print(s) printf(s)
96 # define println(s) printf(s "\r\n")
97 # define xprintf printf
98 # define uprint(s) printf(s)
99 # define uprintln(s) printf(s "\r\n")
100 # define uprintf printf
102 # endif /* USER_PRINT / NORMAL PRINT */
104 #elif defined(PROTOCOL_ARM_ATSAM) /* PROTOCOL_ARM_ATSAM */
106 # include "arm_atsam/printf.h"
108 # ifdef USER_PRINT /* USER_PRINT */
110 // Remove normal print defines
113 # define xprintf(fmt, ...)
115 // Create user print defines
116 # define uprintf(fmt, ...) __xprintf(fmt, ##__VA_ARGS__)
117 # define uprint(s) xprintf(s)
118 # define uprintln(s) xprintf(s "\r\n")
120 # else /* NORMAL PRINT */
122 // Create user & normal print defines
123 # define xprintf(fmt, ...) __xprintf(fmt, ##__VA_ARGS__)
124 # define print(s) xprintf(s)
125 # define println(s) xprintf(s "\r\n")
126 # define uprint(s) print(s)
127 # define uprintln(s) println(s)
128 # define uprintf(fmt, ...) xprintf(fmt, ##__VA_ARGS__)
130 # endif /* USER_PRINT / NORMAL PRINT */
132 #elif defined(__arm__) /* __arm__ */
134 # include "mbed/xprintf.h"
136 # ifdef USER_PRINT /* USER_PRINT */
138 // Remove normal print defines
141 # define xprintf(fmt, ...)
143 // Create user print defines
144 # define uprintf(fmt, ...) __xprintf(fmt, ##__VA_ARGS__)
145 # define uprint(s) xprintf(s)
146 # define uprintln(s) xprintf(s "\r\n")
148 # else /* NORMAL PRINT */
150 // Create user & normal print defines
151 # define xprintf(fmt, ...) __xprintf(fmt, ##__VA_ARGS__)
152 # define print(s) xprintf(s)
153 # define println(s) xprintf(s "\r\n")
154 # define uprint(s) print(s)
155 # define uprintln(s) println(s)
156 # define uprintf(fmt, ...) xprintf(fmt, ##__VA_ARGS__)
158 # endif /* USER_PRINT / NORMAL PRINT */
160 /* TODO: to select output destinations: UART/USBSerial */
161 # define print_set_sendchar(func)
163 #endif /* __AVR__ / PROTOCOL_CHIBIOS / PROTOCOL_ARM_ATSAM / __arm__ */
165 // User print disables the normal print messages in the body of QMK/TMK code and
166 // is meant as a lightweight alternative to NOPRINT. Use it when you only want to do
167 // a spot of debugging but lack flash resources for allowing all of the codebase to
168 // print (and store their wasteful strings).
170 // !!! DO NOT USE USER PRINT CALLS IN THE BODY OF QMK/TMK !!!
174 // Disable normal print
175 #define print_dec(data)
176 #define print_decs(data)
177 #define print_hex4(data)
178 #define print_hex8(data)
179 #define print_hex16(data)
180 #define print_hex32(data)
181 #define print_bin4(data)
182 #define print_bin8(data)
183 #define print_bin16(data)
184 #define print_bin32(data)
185 #define print_bin_reverse8(data)
186 #define print_bin_reverse16(data)
187 #define print_bin_reverse32(data)
188 #define print_val_dec(v)
189 #define print_val_decs(v)
190 #define print_val_hex8(v)
191 #define print_val_hex16(v)
192 #define print_val_hex32(v)
193 #define print_val_bin8(v)
194 #define print_val_bin16(v)
195 #define print_val_bin32(v)
196 #define print_val_bin_reverse8(v)
197 #define print_val_bin_reverse16(v)
198 #define print_val_bin_reverse32(v)
200 #else /* NORMAL_PRINT */
202 //Enable normal print
204 #define print_dec(i) xprintf("%u", i)
205 #define print_decs(i) xprintf("%d", i)
207 #define print_hex4(i) xprintf("%X", i)
208 #define print_hex8(i) xprintf("%02X", i)
209 #define print_hex16(i) xprintf("%04X", i)
210 #define print_hex32(i) xprintf("%08lX", i)
212 #define print_bin4(i) xprintf("%04b", i)
213 #define print_bin8(i) xprintf("%08b", i)
214 #define print_bin16(i) xprintf("%016b", i)
215 #define print_bin32(i) xprintf("%032lb", i)
216 #define print_bin_reverse8(i) xprintf("%08b", bitrev(i))
217 #define print_bin_reverse16(i) xprintf("%016b", bitrev16(i))
218 #define print_bin_reverse32(i) xprintf("%032lb", bitrev32(i))
219 /* print value utility */
220 #define print_val_dec(v) xprintf(#v ": %u\n", v)
221 #define print_val_decs(v) xprintf(#v ": %d\n", v)
222 #define print_val_hex8(v) xprintf(#v ": %X\n", v)
223 #define print_val_hex16(v) xprintf(#v ": %02X\n", v)
224 #define print_val_hex32(v) xprintf(#v ": %04lX\n", v)
225 #define print_val_bin8(v) xprintf(#v ": %08b\n", v)
226 #define print_val_bin16(v) xprintf(#v ": %016b\n", v)
227 #define print_val_bin32(v) xprintf(#v ": %032lb\n", v)
228 #define print_val_bin_reverse8(v) xprintf(#v ": %08b\n", bitrev(v))
229 #define print_val_bin_reverse16(v) xprintf(#v ": %016b\n", bitrev16(v))
230 #define print_val_bin_reverse32(v) xprintf(#v ": %032lb\n", bitrev32(v))
232 #endif /* USER_PRINT / NORMAL_PRINT */
237 #define uprint_dec(i) uprintf("%u", i)
238 #define uprint_decs(i) uprintf("%d", i)
240 #define uprint_hex4(i) uprintf("%X", i)
241 #define uprint_hex8(i) uprintf("%02X", i)
242 #define uprint_hex16(i) uprintf("%04X", i)
243 #define uprint_hex32(i) uprintf("%08lX", i)
245 #define uprint_bin4(i) uprintf("%04b", i)
246 #define uprint_bin8(i) uprintf("%08b", i)
247 #define uprint_bin16(i) uprintf("%016b", i)
248 #define uprint_bin32(i) uprintf("%032lb", i)
249 #define uprint_bin_reverse8(i) uprintf("%08b", bitrev(i))
250 #define uprint_bin_reverse16(i) uprintf("%016b", bitrev16(i))
251 #define uprint_bin_reverse32(i) uprintf("%032lb", bitrev32(i))
252 /* print value utility */
253 #define uprint_val_dec(v) uprintf(#v ": %u\n", v)
254 #define uprint_val_decs(v) uprintf(#v ": %d\n", v)
255 #define uprint_val_hex8(v) uprintf(#v ": %X\n", v)
256 #define uprint_val_hex16(v) uprintf(#v ": %02X\n", v)
257 #define uprint_val_hex32(v) uprintf(#v ": %04lX\n", v)
258 #define uprint_val_bin8(v) uprintf(#v ": %08b\n", v)
259 #define uprint_val_bin16(v) uprintf(#v ": %016b\n", v)
260 #define uprint_val_bin32(v) uprintf(#v ": %032lb\n", v)
261 #define uprint_val_bin_reverse8(v) uprintf(#v ": %08b\n", bitrev(v))
262 #define uprint_val_bin_reverse16(v) uprintf(#v ": %016b\n", bitrev16(v))
263 #define uprint_val_bin_reverse32(v) uprintf(#v ": %032lb\n", bitrev32(v))
267 #define xprintf(fmt, ...)
270 #define print_set_sendchar(func)
271 #define print_dec(data)
272 #define print_decs(data)
273 #define print_hex4(data)
274 #define print_hex8(data)
275 #define print_hex16(data)
276 #define print_hex32(data)
277 #define print_bin4(data)
278 #define print_bin8(data)
279 #define print_bin16(data)
280 #define print_bin32(data)
281 #define print_bin_reverse8(data)
282 #define print_bin_reverse16(data)
283 #define print_bin_reverse32(data)
284 #define print_val_dec(v)
285 #define print_val_decs(v)
286 #define print_val_hex8(v)
287 #define print_val_hex16(v)
288 #define print_val_hex32(v)
289 #define print_val_bin8(v)
290 #define print_val_bin16(v)
291 #define print_val_bin32(v)
292 #define print_val_bin_reverse8(v)
293 #define print_val_bin_reverse16(v)
294 #define print_val_bin_reverse32(v)
296 #endif /* NO_PRINT */
299 /* Backward compatiblitly for old name */
300 #define pdec(data) print_dec(data)
301 #define pdec16(data) print_dec(data)
302 #define phex(data) print_hex8(data)
303 #define phex16(data) print_hex16(data)
304 #define pbin(data) print_bin8(data)
305 #define pbin16(data) print_bin16(data)
306 #define pbin_reverse(data) print_bin_reverse8(data)
307 #define pbin_reverse16(data) print_bin_reverse16(data)