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