tmk_core/protocol/ps2.h

   1 /*
   2 Copyright 2010,2011,2012,2013 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 PS2_H
  39 #define PS2_H
  40
  41 #include <stdbool.h>
  42 #include "wait.h"
  43 #include "ps2_io.h"
  44 #include "print.h"
  45
  46 /*
  47  * Primitive PS/2 Library for AVR
  48  *
  49  * PS/2 Resources
  50  * --------------
  51  * [1] The PS/2 Mouse/Keyboard Protocol
  52  * http://www.computer-engineering.org/ps2protocol/
  53  * Concise and thorough primer of PS/2 protocol.
  54  *
  55  * [2] Keyboard and Auxiliary Device Controller
  56  * http://www.mcamafia.de/pdf/ibm_hitrc07.pdf
  57  * Signal Timing and Format
  58  *
  59  * [3] Keyboards(101- and 102-key)
  60  * http://www.mcamafia.de/pdf/ibm_hitrc11.pdf
  61  * Keyboard Layout, Scan Code Set, POR, and Commands.
  62  *
  63  * [4] PS/2 Reference Manuals
  64  * http://www.mcamafia.de/pdf/ibm_hitrc07.pdf
  65  * Collection of IBM Personal System/2 documents.
  66  *
  67  * [5] TrackPoint Engineering Specifications for version 3E
  68  * https://web.archive.org/web/20100526161812/http://wwwcssrv.almaden.ibm.com/trackpoint/download.html
  69  */
  70 #define PS2_ACK         0xFA
  71 #define PS2_RESEND      0xFE
  72 #define PS2_SET_LED     0xED
  73
  74 // TODO: error numbers
  75 #define PS2_ERR_NONE        0
  76 #define PS2_ERR_STARTBIT1   1
  77 #define PS2_ERR_STARTBIT2   2
  78 #define PS2_ERR_STARTBIT3   3
  79 #define PS2_ERR_PARITY      0x10
  80 #define PS2_ERR_NODATA      0x20
  81
  82 #define PS2_LED_SCROLL_LOCK 0
  83 #define PS2_LED_NUM_LOCK    1
  84 #define PS2_LED_CAPS_LOCK   2
  85
  86
  87 extern uint8_t ps2_error;
  88
  89 void ps2_host_init(void);
  90 uint8_t ps2_host_send(uint8_t data);
  91 uint8_t ps2_host_recv_response(void);
  92 uint8_t ps2_host_recv(void);
  93 void ps2_host_set_led(uint8_t usb_led);
  94
  95
  96 /*--------------------------------------------------------------------
  97  * static functions
  98  *------------------------------------------------------------------*/
  99 static inline uint16_t wait_clock_lo(uint16_t us)
 100 {
 101     while (clock_in()  && us) { asm(""); wait_us(1); us--; }
 102     return us;
 103 }
 104 static inline uint16_t wait_clock_hi(uint16_t us)
 105 {
 106     while (!clock_in() && us) { asm(""); wait_us(1); us--; }
 107     return us;
 108 }
 109 static inline uint16_t wait_data_lo(uint16_t us)
 110 {
 111     while (data_in() && us)  { asm(""); wait_us(1); us--; }
 112     return us;
 113 }
 114 static inline uint16_t wait_data_hi(uint16_t us)
 115 {
 116     while (!data_in() && us)  { asm(""); wait_us(1); us--; }
 117     return us;
 118 }
 119
 120 /* idle state that device can send */
 121 static inline void idle(void)
 122 {
 123     clock_hi();
 124     data_hi();
 125 }
 126
 127 /* inhibit device to send */
 128 static inline void inhibit(void)
 129 {
 130     clock_lo();
 131     data_hi();
 132 }
 133
 134 #endif