tmk_core/protocol/adb.h

   1 /*
   2 Copyright 2011-19 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 ADB_H
  39 #define ADB_H
  40
  41 #include <stdint.h>
  42 #include <stdbool.h>
  43
  44 #if !(defined(ADB_PORT) && \
  45       defined(ADB_PIN)  && \
  46       defined(ADB_DDR)  && \
  47       defined(ADB_DATA_BIT))
  48 #   error "ADB port setting is required in config.h"
  49 #endif
  50
  51 #define ADB_POWER       0x7F
  52 #define ADB_CAPS        0x39
  53
  54
  55 /* ADB commands */
  56 // Default Address
  57 #define ADB_ADDR_0          0
  58 #define ADB_ADDR_DONGLE     1
  59 #define ADB_ADDR_KEYBOARD   2
  60 #define ADB_ADDR_MOUSE      3
  61 #define ADB_ADDR_TABLET     4
  62 #define ADB_ADDR_APPLIANCE  7
  63 #define ADB_ADDR_8          8
  64 #define ADB_ADDR_9          9
  65 #define ADB_ADDR_10         10
  66 #define ADB_ADDR_11         11
  67 #define ADB_ADDR_12         12
  68 #define ADB_ADDR_13         13
  69 #define ADB_ADDR_14         14
  70 #define ADB_ADDR_15         15
  71 // for temporary purpose, do not use for polling
  72 #define ADB_ADDR_TMP        15
  73 #define ADB_ADDR_MOUSE_POLL 10
  74 // Command Type
  75 #define ADB_CMD_RESET       0
  76 #define ADB_CMD_FLUSH       1
  77 #define ADB_CMD_LISTEN      8
  78 #define ADB_CMD_TALK        12
  79 // Register
  80 #define ADB_REG_0           0
  81 #define ADB_REG_1           1
  82 #define ADB_REG_2           2
  83 #define ADB_REG_3           3
  84
  85 /* ADB keyboard handler id */
  86 #define ADB_HANDLER_M0116               0x01
  87 #define ADB_HANDLER_IIGS                0x01
  88 #define ADB_HANDLER_M0115               0x02
  89 #define ADB_HANDLER_M3501               0x02
  90 #define ADB_HANDLER_M1242_ANSI          0x10
  91 #define ADB_HANDLER_EXTENDED_KEYBOARD   0x03
  92 #define ADB_HANDLER_CLASSIC1_MOUSE      0x01
  93 #define ADB_HANDLER_CLASSIC2_MOUSE      0x02
  94 #define ADB_HANDLER_EXTENDED_MOUSE      0x04
  95 #define ADB_HANDLER_TURBO_MOUSE         0x32
  96
  97
  98 // ADB host
  99 void     adb_host_init(void);
 100 bool     adb_host_psw(void);
 101 uint16_t adb_host_kbd_recv(uint8_t addr);
 102 uint16_t adb_host_talk(uint8_t addr, uint8_t reg);
 103 uint8_t  adb_host_talk_buf(uint8_t addr, uint8_t reg, uint8_t *buf, uint8_t len);
 104 void     adb_host_listen(uint8_t addr, uint8_t reg, uint8_t data_h, uint8_t data_l);
 105 void     adb_host_listen_buf(uint8_t addr, uint8_t reg, uint8_t *buf, uint8_t len);
 106 void     adb_host_flush(uint8_t addr);
 107 void     adb_host_kbd_led(uint8_t addr, uint8_t led);
 108 void     adb_mouse_task(void);
 109 void     adb_mouse_init(void);
 110
 111
 112 #endif