tmk_core/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 "util.h"
  31
  32 #if defined(PROTOCOL_CHIBIOS) || defined(PROTOCOL_ARM_ATSAM)
  33 #    define PSTR(x) x
  34 #endif
  35
  36 #ifndef NO_PRINT
  37
  38 #    if defined(__AVR__) /* __AVR__ */
  39
  40 #        include "avr/xprintf.h"
  41
  42 #        ifdef USER_PRINT /* USER_PRINT */
  43
  44 // Remove normal print defines
  45 #            define print(s)
  46 #            define println(s)
  47 #            undef xprintf
  48 #            define xprintf(fmt, ...)
  49
  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__)
  54
  55 #        else /* NORMAL PRINT */
  56
  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__)
  63
  64 #        endif /* USER_PRINT / NORMAL PRINT */
  65
  66 #        ifdef __cplusplus
  67 extern "C"
  68 #        endif
  69
  70     /* function pointer of sendchar to be used by print utility */
  71     void print_set_sendchar(int8_t (*print_sendchar_func)(uint8_t));
  72
  73 #    elif defined(PROTOCOL_CHIBIOS) /* PROTOCOL_CHIBIOS */
  74
  75 #        ifndef TERMINAL_ENABLE
  76 #            include "chibios/printf.h"
  77 #        endif
  78
  79 #        ifdef USER_PRINT /* USER_PRINT */
  80
  81 // Remove normal print defines
  82 #            define print(s)
  83 #            define println(s)
  84 #            define xprintf(fmt, ...)
  85
  86 // Create user print defines
  87 #            define uprint(s) printf(s)
  88 #            define uprintln(s) printf(s "\r\n")
  89 #            define uprintf printf
  90
  91 #        else /* NORMAL PRINT */
  92
  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
 100
 101 #        endif /* USER_PRINT / NORMAL PRINT */
 102
 103 #    elif defined(PROTOCOL_ARM_ATSAM) /* PROTOCOL_ARM_ATSAM */
 104
 105 #        include "arm_atsam/printf.h"
 106
 107 #        ifdef USER_PRINT /* USER_PRINT */
 108
 109 // Remove normal print defines
 110 #            define print(s)
 111 #            define println(s)
 112 #            define xprintf(fmt, ...)
 113
 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")
 118
 119 #        else /* NORMAL PRINT */
 120
 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__)
 128
 129 #        endif /* USER_PRINT / NORMAL PRINT */
 130
 131 #    elif defined(__arm__) /* __arm__ */
 132
 133 #        include "mbed/xprintf.h"
 134
 135 #        ifdef USER_PRINT /* USER_PRINT */
 136
 137 // Remove normal print defines
 138 #            define print(s)
 139 #            define println(s)
 140 #            define xprintf(fmt, ...)
 141
 142 // Create user print defines
 143 #            define uprintf(fmt, ...) __xprintf(fmt, ##__VA_ARGS__)
 144 #            define uprint(s) xprintf(s)
 145 #            define uprintln(s) xprintf(s "\r\n")
 146
 147 #        else /* NORMAL PRINT */
 148
 149 // Create user & normal print defines
 150 #            define xprintf(fmt, ...) __xprintf(fmt, ##__VA_ARGS__)
 151 #            define print(s) xprintf(s)
 152 #            define println(s) xprintf(s "\r\n")
 153 #            define uprint(s) print(s)
 154 #            define uprintln(s) println(s)
 155 #            define uprintf(fmt, ...) xprintf(fmt, ##__VA_ARGS__)
 156
 157 #        endif /* USER_PRINT / NORMAL PRINT */
 158
 159 /* TODO: to select output destinations: UART/USBSerial */
 160 #        define print_set_sendchar(func)
 161
 162 #    endif /* __AVR__ / PROTOCOL_CHIBIOS / PROTOCOL_ARM_ATSAM / __arm__ */
 163
 164 // User print disables the normal print messages in the body of QMK/TMK code and
 165 // is meant as a lightweight alternative to NOPRINT. Use it when you only want to do
 166 // a spot of debugging but lack flash resources for allowing all of the codebase to
 167 // print (and store their wasteful strings).
 168 //
 169 // !!! DO NOT USE USER PRINT CALLS IN THE BODY OF QMK/TMK !!!
 170 //
 171 #    ifdef USER_PRINT
 172
 173 // Disable normal print
 174 #        define print_dec(data)
 175 #        define print_decs(data)
 176 #        define print_hex4(data)
 177 #        define print_hex8(data)
 178 #        define print_hex16(data)
 179 #        define print_hex32(data)
 180 #        define print_bin4(data)
 181 #        define print_bin8(data)
 182 #        define print_bin16(data)
 183 #        define print_bin32(data)
 184 #        define print_bin_reverse8(data)
 185 #        define print_bin_reverse16(data)
 186 #        define print_bin_reverse32(data)
 187 #        define print_val_dec(v)
 188 #        define print_val_decs(v)
 189 #        define print_val_hex8(v)
 190 #        define print_val_hex16(v)
 191 #        define print_val_hex32(v)
 192 #        define print_val_bin8(v)
 193 #        define print_val_bin16(v)
 194 #        define print_val_bin32(v)
 195 #        define print_val_bin_reverse8(v)
 196 #        define print_val_bin_reverse16(v)
 197 #        define print_val_bin_reverse32(v)
 198
 199 #    else /* NORMAL_PRINT */
 200
 201 // Enable normal print
 202 /* decimal */
 203 #        define print_dec(i) xprintf("%u", i)
 204 #        define print_decs(i) xprintf("%d", i)
 205 /* hex */
 206 #        define print_hex4(i) xprintf("%X", i)
 207 #        define print_hex8(i) xprintf("%02X", i)
 208 #        define print_hex16(i) xprintf("%04X", i)
 209 #        define print_hex32(i) xprintf("%08lX", i)
 210 /* binary */
 211 #        define print_bin4(i) xprintf("%04b", i)
 212 #        define print_bin8(i) xprintf("%08b", i)
 213 #        define print_bin16(i) xprintf("%016b", i)
 214 #        define print_bin32(i) xprintf("%032lb", i)
 215 #        define print_bin_reverse8(i) xprintf("%08b", bitrev(i))
 216 #        define print_bin_reverse16(i) xprintf("%016b", bitrev16(i))
 217 #        define print_bin_reverse32(i) xprintf("%032lb", bitrev32(i))
 218 /* print value utility */
 219 #        define print_val_dec(v) xprintf(#        v ": %u\n", v)
 220 #        define print_val_decs(v) xprintf(#        v ": %d\n", v)
 221 #        define print_val_hex8(v) xprintf(#        v ": %X\n", v)
 222 #        define print_val_hex16(v) xprintf(#        v ": %02X\n", v)
 223 #        define print_val_hex32(v) xprintf(#        v ": %04lX\n", v)
 224 #        define print_val_bin8(v) xprintf(#        v ": %08b\n", v)
 225 #        define print_val_bin16(v) xprintf(#        v ": %016b\n", v)
 226 #        define print_val_bin32(v) xprintf(#        v ": %032lb\n", v)
 227 #        define print_val_bin_reverse8(v) xprintf(#        v ": %08b\n", bitrev(v))
 228 #        define print_val_bin_reverse16(v) xprintf(#        v ": %016b\n", bitrev16(v))
 229 #        define print_val_bin_reverse32(v) xprintf(#        v ": %032lb\n", bitrev32(v))
 230
 231 #    endif /* USER_PRINT / NORMAL_PRINT */
 232
 233 // User Print
 234
 235 /* decimal */
 236 #    define uprint_dec(i) uprintf("%u", i)
 237 #    define uprint_decs(i) uprintf("%d", i)
 238 /* hex */
 239 #    define uprint_hex4(i) uprintf("%X", i)
 240 #    define uprint_hex8(i) uprintf("%02X", i)
 241 #    define uprint_hex16(i) uprintf("%04X", i)
 242 #    define uprint_hex32(i) uprintf("%08lX", i)
 243 /* binary */
 244 #    define uprint_bin4(i) uprintf("%04b", i)
 245 #    define uprint_bin8(i) uprintf("%08b", i)
 246 #    define uprint_bin16(i) uprintf("%016b", i)
 247 #    define uprint_bin32(i) uprintf("%032lb", i)
 248 #    define uprint_bin_reverse8(i) uprintf("%08b", bitrev(i))
 249 #    define uprint_bin_reverse16(i) uprintf("%016b", bitrev16(i))
 250 #    define uprint_bin_reverse32(i) uprintf("%032lb", bitrev32(i))
 251 /* print value utility */
 252 #    define uprint_val_dec(v) uprintf(#    v ": %u\n", v)
 253 #    define uprint_val_decs(v) uprintf(#    v ": %d\n", v)
 254 #    define uprint_val_hex8(v) uprintf(#    v ": %X\n", v)
 255 #    define uprint_val_hex16(v) uprintf(#    v ": %02X\n", v)
 256 #    define uprint_val_hex32(v) uprintf(#    v ": %04lX\n", v)
 257 #    define uprint_val_bin8(v) uprintf(#    v ": %08b\n", v)
 258 #    define uprint_val_bin16(v) uprintf(#    v ": %016b\n", v)
 259 #    define uprint_val_bin32(v) uprintf(#    v ": %032lb\n", v)
 260 #    define uprint_val_bin_reverse8(v) uprintf(#    v ": %08b\n", bitrev(v))
 261 #    define uprint_val_bin_reverse16(v) uprintf(#    v ": %016b\n", bitrev16(v))
 262 #    define uprint_val_bin_reverse32(v) uprintf(#    v ": %032lb\n", bitrev32(v))
 263
 264 #else /* NO_PRINT */
 265
 266 #    define xprintf(fmt, ...)
 267 #    define print(s)
 268 #    define println(s)
 269 #    define print_set_sendchar(func)
 270 #    define print_dec(data)
 271 #    define print_decs(data)
 272 #    define print_hex4(data)
 273 #    define print_hex8(data)
 274 #    define print_hex16(data)
 275 #    define print_hex32(data)
 276 #    define print_bin4(data)
 277 #    define print_bin8(data)
 278 #    define print_bin16(data)
 279 #    define print_bin32(data)
 280 #    define print_bin_reverse8(data)
 281 #    define print_bin_reverse16(data)
 282 #    define print_bin_reverse32(data)
 283 #    define print_val_dec(v)
 284 #    define print_val_decs(v)
 285 #    define print_val_hex8(v)
 286 #    define print_val_hex16(v)
 287 #    define print_val_hex32(v)
 288 #    define print_val_bin8(v)
 289 #    define print_val_bin16(v)
 290 #    define print_val_bin32(v)
 291 #    define print_val_bin_reverse8(v)
 292 #    define print_val_bin_reverse16(v)
 293 #    define print_val_bin_reverse32(v)
 294
 295 #endif /* NO_PRINT */
 296
 297 /* Backward compatiblitly for old name */
 298 #define pdec(data) print_dec(data)
 299 #define pdec16(data) print_dec(data)
 300 #define phex(data) print_hex8(data)
 301 #define phex16(data) print_hex16(data)
 302 #define pbin(data) print_bin8(data)
 303 #define pbin16(data) print_bin16(data)
 304 #define pbin_reverse(data) print_bin_reverse8(data)
 305 #define pbin_reverse16(data) print_bin_reverse16(data)
 306
 307 #endif