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
  40 #if defined(__AVR__)
  41
  42 #include "avr/xprintf.h"
  43 #define print(s)    xputs(PSTR(s))
  44 #define println(s)  xputs(PSTR(s "\r\n"))
  45
  46 #ifdef __cplusplus
  47 extern "C"
  48 #endif
  49 /* function pointer of sendchar to be used by print utility */
  50 void print_set_sendchar(int8_t (*print_sendchar_func)(uint8_t));
  51
  52 #elif defined(PROTOCOL_CHIBIOS) /* __AVR__ */
  53
  54 #include "chibios/printf.h"
  55
  56 #define print(s)    printf(s)
  57 #define println(s)  printf(s "\r\n")
  58 #define xprintf  printf
  59
  60 #elif defined(__arm__) /* __AVR__ */
  61
  62 #include "mbed/xprintf.h"
  63
  64 #define print(s)    xprintf(s)
  65 #define println(s)  xprintf(s "\r\n")
  66
  67 /* TODO: to select output destinations: UART/USBSerial */
  68 #define print_set_sendchar(func)
  69
  70 #endif /* __AVR__ */
  71
  72
  73 /* decimal */
  74 #define print_dec(i)                xprintf("%u", i)
  75 #define print_decs(i)               xprintf("%d", i)
  76 /* hex */
  77 #define print_hex4(i)               xprintf("%X", i)
  78 #define print_hex8(i)               xprintf("%02X", i)
  79 #define print_hex16(i)              xprintf("%04X", i)
  80 #define print_hex32(i)              xprintf("%08lX", i)
  81 /* binary */
  82 #define print_bin4(i)               xprintf("%04b", i)
  83 #define print_bin8(i)               xprintf("%08b", i)
  84 #define print_bin16(i)              xprintf("%016b", i)
  85 #define print_bin32(i)              xprintf("%032lb", i)
  86 #define print_bin_reverse8(i)       xprintf("%08b", bitrev(i))
  87 #define print_bin_reverse16(i)      xprintf("%016b", bitrev16(i))
  88 #define print_bin_reverse32(i)      xprintf("%032lb", bitrev32(i))
  89 /* print value utility */
  90 #define print_val_dec(v)            xprintf(#v ": %u\n", v)
  91 #define print_val_decs(v)           xprintf(#v ": %d\n", v)
  92 #define print_val_hex8(v)           xprintf(#v ": %X\n", v)
  93 #define print_val_hex16(v)          xprintf(#v ": %02X\n", v)
  94 #define print_val_hex32(v)          xprintf(#v ": %04lX\n", v)
  95 #define print_val_bin8(v)           xprintf(#v ": %08b\n", v)
  96 #define print_val_bin16(v)          xprintf(#v ": %016b\n", v)
  97 #define print_val_bin32(v)          xprintf(#v ": %032lb\n", v)
  98 #define print_val_bin_reverse8(v)   xprintf(#v ": %08b\n", bitrev(v))
  99 #define print_val_bin_reverse16(v)  xprintf(#v ": %016b\n", bitrev16(v))
 100 #define print_val_bin_reverse32(v)  xprintf(#v ": %032lb\n", bitrev32(v))
 101
 102 #else   /* NO_PRINT */
 103
 104 #define xprintf(fmt, ...)
 105 #define print(s)
 106 #define println(s)
 107 #define print_set_sendchar(func)
 108 #define print_dec(data)
 109 #define print_decs(data)
 110 #define print_hex4(data)
 111 #define print_hex8(data)
 112 #define print_hex16(data)
 113 #define print_hex32(data)
 114 #define print_bin4(data)
 115 #define print_bin8(data)
 116 #define print_bin16(data)
 117 #define print_bin32(data)
 118 #define print_bin_reverse8(data)
 119 #define print_bin_reverse16(data)
 120 #define print_bin_reverse32(data)
 121 #define print_val_dec(v)
 122 #define print_val_decs(v)
 123 #define print_val_hex8(v)
 124 #define print_val_hex16(v)
 125 #define print_val_hex32(v)
 126 #define print_val_bin8(v)
 127 #define print_val_bin16(v)
 128 #define print_val_bin32(v)
 129 #define print_val_bin_reverse8(v)
 130 #define print_val_bin_reverse16(v)
 131 #define print_val_bin_reverse32(v)
 132
 133 #endif  /* NO_PRINT */
 134
 135
 136 /* Backward compatiblitly for old name */
 137 #define pdec(data)              print_dec(data)
 138 #define pdec16(data)            print_dec(data)
 139 #define phex(data)              print_hex8(data)
 140 #define phex16(data)            print_hex16(data)
 141 #define pbin(data)              print_bin8(data)
 142 #define pbin16(data)            print_bin16(data)
 143 #define pbin_reverse(data)      print_bin_reverse8(data)
 144 #define pbin_reverse16(data)    print_bin_reverse16(data)
 145
 146
 147 #endif