tmk_core/protocol/m0110.h

   1 /*
   2 Copyright 2011,2012 Jun WAKO <wakojun@gmail.com>
   3
   4 This software is licensed with a Modified BSD License.
   5 All of this is supposed to be Free Software, Open Source, DFSG-free,
   6 GPL-compatible, and OK to use in both free and proprietary applications.
   7 Additions and corrections to this file are welcome.
   8
   9
  10 Redistribution and use in source and binary forms, with or without
  11 modification, are permitted provided that the following conditions are met:
  12
  13 * Redistributions of source code must retain the above copyright
  14   notice, this list of conditions and the following disclaimer.
  15
  16 * Redistributions in binary form must reproduce the above copyright
  17   notice, this list of conditions and the following disclaimer in
  18   the documentation and/or other materials provided with the
  19   distribution.
  20
  21 * Neither the name of the copyright holders nor the names of
  22   contributors may be used to endorse or promote products derived
  23   from this software without specific prior written permission.
  24
  25 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  26 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  29 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35 POSSIBILITY OF SUCH DAMAGE.
  36 */
  37
  38 #ifndef M0110_H
  39 #define M0110_H
  40
  41
  42 /* port settings for clock and data line */
  43 #if !(defined(M0110_CLOCK_PORT) && \
  44       defined(M0110_CLOCK_PIN) && \
  45       defined(M0110_CLOCK_DDR) && \
  46       defined(M0110_CLOCK_BIT))
  47 #   error "M0110 clock port setting is required in config.h"
  48 #endif
  49
  50 #if !(defined(M0110_DATA_PORT) && \
  51       defined(M0110_DATA_PIN) && \
  52       defined(M0110_DATA_DDR) && \
  53       defined(M0110_DATA_BIT))
  54 #   error "M0110 data port setting is required in config.h"
  55 #endif
  56
  57 /* Commands */
  58 #define M0110_INQUIRY       0x10
  59 #define M0110_INSTANT       0x14
  60 #define M0110_MODEL         0x16
  61 #define M0110_TEST          0x36
  62
  63 /* Response(raw byte from M0110) */
  64 #define M0110_NULL          0x7B
  65 #define M0110_KEYPAD        0x79
  66 #define M0110_TEST_ACK      0x7D
  67 #define M0110_TEST_NAK      0x77
  68 #define M0110_SHIFT         0x71
  69 #define M0110_ARROW_UP      0x1B
  70 #define M0110_ARROW_DOWN    0x11
  71 #define M0110_ARROW_LEFT    0x0D
  72 #define M0110_ARROW_RIGHT   0x05
  73
  74 /* This inidcates no response. */
  75 #define M0110_ERROR         0xFF
  76
  77 /* scan code offset for keypad and arrow keys */
  78 #define M0110_KEYPAD_OFFSET 0x40
  79 #define M0110_CALC_OFFSET   0x60
  80
  81
  82 extern uint8_t m0110_error;
  83
  84 /* host role */
  85 void m0110_init(void);
  86 uint8_t m0110_send(uint8_t data);
  87 uint8_t m0110_recv(void);
  88 uint8_t m0110_recv_key(void);
  89 uint8_t m0110_inquiry(void);
  90 uint8_t m0110_instant(void);
  91
  92 #endif