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)
38 # if defined(__AVR__) /* __AVR__ */
40 # include "avr/xprintf.h"
42 # ifdef USER_PRINT /* USER_PRINT */
44 // Remove normal print defines
48 # define xprintf(fmt, ...)
50 // Create user print defines
51 # define uprint(s) xputs(PSTR(s))
52 # define uprintln(s) xputs(PSTR(s "\r\n"))
53 # define uprintf(fmt, ...) __xprintf(PSTR(fmt), ##__VA_ARGS__)
55 # else /* NORMAL PRINT */
57 // Create user & normal print defines
58 # define print(s) xputs(PSTR(s))
59 # define println(s) xputs(PSTR(s "\r\n"))
60 # define uprint(s) print(s)
61 # define uprintln(s) println(s)
62 # define uprintf(fmt, ...) xprintf(fmt, ##__VA_ARGS__)
64 # endif /* USER_PRINT / NORMAL PRINT */
70 /* function pointer of sendchar to be used by print utility */
71 void print_set_sendchar(int8_t (*print_sendchar_func)(uint8_t));
73 # elif defined(PROTOCOL_CHIBIOS) /* PROTOCOL_CHIBIOS */
75 # ifndef TERMINAL_ENABLE
76 # include "chibios/printf.h"
79 # ifdef USER_PRINT /* USER_PRINT */
81 // Remove normal print defines
84 # define xprintf(fmt, ...)
86 // Create user print defines
87 # define uprint(s) printf(s)
88 # define uprintln(s) printf(s "\r\n")
89 # define uprintf printf
91 # else /* NORMAL PRINT */
93 // Create user & normal print defines
94 # define print(s) printf(s)
95 # define println(s) printf(s "\r\n")
96 # define xprintf printf
97 # define uprint(s) printf(s)
98 # define uprintln(s) printf(s "\r\n")
99 # define uprintf printf
101 # endif /* USER_PRINT / NORMAL PRINT */
103 # elif defined(PROTOCOL_ARM_ATSAM) /* PROTOCOL_ARM_ATSAM */
105 # include "arm_atsam/printf.h"
107 # ifdef USER_PRINT /* USER_PRINT */
109 // Remove normal print defines
112 # define xprintf(fmt, ...)
114 // Create user print defines
115 # define uprintf(fmt, ...) __xprintf(fmt, ##__VA_ARGS__)
116 # define uprint(s) xprintf(s)
117 # define uprintln(s) xprintf(s "\r\n")
119 # else /* NORMAL PRINT */
121 // Create user & normal print defines
122 # define xprintf(fmt, ...) __xprintf(fmt, ##__VA_ARGS__)
123 # define print(s) xprintf(s)
124 # define println(s) xprintf(s "\r\n")
125 # define uprint(s) print(s)
126 # define uprintln(s) println(s)
127 # define uprintf(fmt, ...) xprintf(fmt, ##__VA_ARGS__)
129 # endif /* USER_PRINT / NORMAL PRINT */
131 # endif /* __AVR__ / PROTOCOL_CHIBIOS / PROTOCOL_ARM_ATSAM */
133 // User print disables the normal print messages in the body of QMK/TMK code and
134 // is meant as a lightweight alternative to NOPRINT. Use it when you only want to do
135 // a spot of debugging but lack flash resources for allowing all of the codebase to
136 // print (and store their wasteful strings).
138 // !!! DO NOT USE USER PRINT CALLS IN THE BODY OF QMK/TMK !!!
142 // Disable normal print
143 # define print_dec(data)
144 # define print_decs(data)
145 # define print_hex4(data)
146 # define print_hex8(data)
147 # define print_hex16(data)
148 # define print_hex32(data)
149 # define print_bin4(data)
150 # define print_bin8(data)
151 # define print_bin16(data)
152 # define print_bin32(data)
153 # define print_bin_reverse8(data)
154 # define print_bin_reverse16(data)
155 # define print_bin_reverse32(data)
156 # define print_val_dec(v)
157 # define print_val_decs(v)
158 # define print_val_hex8(v)
159 # define print_val_hex16(v)
160 # define print_val_hex32(v)
161 # define print_val_bin8(v)
162 # define print_val_bin16(v)
163 # define print_val_bin32(v)
164 # define print_val_bin_reverse8(v)
165 # define print_val_bin_reverse16(v)
166 # define print_val_bin_reverse32(v)
168 # else /* NORMAL_PRINT */
170 // Enable normal print
172 # define print_dec(i) xprintf("%u", i)
173 # define print_decs(i) xprintf("%d", i)
175 # define print_hex4(i) xprintf("%X", i)
176 # define print_hex8(i) xprintf("%02X", i)
177 # define print_hex16(i) xprintf("%04X", i)
178 # define print_hex32(i) xprintf("%08lX", i)
180 # define print_bin4(i) xprintf("%04b", i)
181 # define print_bin8(i) xprintf("%08b", i)
182 # define print_bin16(i) xprintf("%016b", i)
183 # define print_bin32(i) xprintf("%032lb", i)
184 # define print_bin_reverse8(i) xprintf("%08b", bitrev(i))
185 # define print_bin_reverse16(i) xprintf("%016b", bitrev16(i))
186 # define print_bin_reverse32(i) xprintf("%032lb", bitrev32(i))
187 /* print value utility */
188 # define print_val_dec(v) xprintf(# v ": %u\n", v)
189 # define print_val_decs(v) xprintf(# v ": %d\n", v)
190 # define print_val_hex8(v) xprintf(# v ": %X\n", v)
191 # define print_val_hex16(v) xprintf(# v ": %02X\n", v)
192 # define print_val_hex32(v) xprintf(# v ": %04lX\n", v)
193 # define print_val_bin8(v) xprintf(# v ": %08b\n", v)
194 # define print_val_bin16(v) xprintf(# v ": %016b\n", v)
195 # define print_val_bin32(v) xprintf(# v ": %032lb\n", v)
196 # define print_val_bin_reverse8(v) xprintf(# v ": %08b\n", bitrev(v))
197 # define print_val_bin_reverse16(v) xprintf(# v ": %016b\n", bitrev16(v))
198 # define print_val_bin_reverse32(v) xprintf(# v ": %032lb\n", bitrev32(v))
200 # endif /* USER_PRINT / NORMAL_PRINT */
205 # define uprint_dec(i) uprintf("%u", i)
206 # define uprint_decs(i) uprintf("%d", i)
208 # define uprint_hex4(i) uprintf("%X", i)
209 # define uprint_hex8(i) uprintf("%02X", i)
210 # define uprint_hex16(i) uprintf("%04X", i)
211 # define uprint_hex32(i) uprintf("%08lX", i)
213 # define uprint_bin4(i) uprintf("%04b", i)
214 # define uprint_bin8(i) uprintf("%08b", i)
215 # define uprint_bin16(i) uprintf("%016b", i)
216 # define uprint_bin32(i) uprintf("%032lb", i)
217 # define uprint_bin_reverse8(i) uprintf("%08b", bitrev(i))
218 # define uprint_bin_reverse16(i) uprintf("%016b", bitrev16(i))
219 # define uprint_bin_reverse32(i) uprintf("%032lb", bitrev32(i))
220 /* print value utility */
221 # define uprint_val_dec(v) uprintf(# v ": %u\n", v)
222 # define uprint_val_decs(v) uprintf(# v ": %d\n", v)
223 # define uprint_val_hex8(v) uprintf(# v ": %X\n", v)
224 # define uprint_val_hex16(v) uprintf(# v ": %02X\n", v)
225 # define uprint_val_hex32(v) uprintf(# v ": %04lX\n", v)
226 # define uprint_val_bin8(v) uprintf(# v ": %08b\n", v)
227 # define uprint_val_bin16(v) uprintf(# v ": %016b\n", v)
228 # define uprint_val_bin32(v) uprintf(# v ": %032lb\n", v)
229 # define uprint_val_bin_reverse8(v) uprintf(# v ": %08b\n", bitrev(v))
230 # define uprint_val_bin_reverse16(v) uprintf(# v ": %016b\n", bitrev16(v))
231 # define uprint_val_bin_reverse32(v) uprintf(# v ": %032lb\n", bitrev32(v))
235 # define xprintf(fmt, ...)
238 # define print_set_sendchar(func)
239 # define print_dec(data)
240 # define print_decs(data)
241 # define print_hex4(data)
242 # define print_hex8(data)
243 # define print_hex16(data)
244 # define print_hex32(data)
245 # define print_bin4(data)
246 # define print_bin8(data)
247 # define print_bin16(data)
248 # define print_bin32(data)
249 # define print_bin_reverse8(data)
250 # define print_bin_reverse16(data)
251 # define print_bin_reverse32(data)
252 # define print_val_dec(v)
253 # define print_val_decs(v)
254 # define print_val_hex8(v)
255 # define print_val_hex16(v)
256 # define print_val_hex32(v)
257 # define print_val_bin8(v)
258 # define print_val_bin16(v)
259 # define print_val_bin32(v)
260 # define print_val_bin_reverse8(v)
261 # define print_val_bin_reverse16(v)
262 # define print_val_bin_reverse32(v)
264 #endif /* NO_PRINT */
266 /* Backward compatiblitly for old name */
267 #define pdec(data) print_dec(data)
268 #define pdec16(data) print_dec(data)
269 #define phex(data) print_hex8(data)
270 #define phex16(data) print_hex16(data)
271 #define pbin(data) print_bin8(data)
272 #define pbin16(data) print_bin16(data)
273 #define pbin_reverse(data) print_bin_reverse8(data)
274 #define pbin_reverse16(data) print_bin_reverse16(data)