2 Copyright 2010,2011,2012,2013,2019 Jun WAKO <wakojun@gmail.com>
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.
10 Redistribution and use in source and binary forms, with or without
11 modification, are permitted provided that the following conditions are met:
13 * Redistributions of source code must retain the above copyright
14 notice, this list of conditions and the following disclaimer.
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
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.
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.
46 * IBM PC keyboard protocol
50 * [1] The PS/2 Mouse/Keyboard Protocol
51 * http://www.computer-engineering.org/ps2protocol/
52 * Concise and thorough primer of PS/2 protocol.
54 * [2] Keyboard and Auxiliary Device Controller
55 * http://www.mcamafia.de/pdf/ibm_hitrc07.pdf
56 * Signal Timing and Format
58 * [3] Keyboards(101- and 102-key)
59 * http://www.mcamafia.de/pdf/ibm_hitrc11.pdf
60 * Keyboard Layout, Scan Code Set, POR, and Commands.
62 * [4] PS/2 Reference Manuals
63 * http://www.mcamafia.de/pdf/ibm_hitrc07.pdf
64 * Collection of IBM Personal System/2 documents.
66 * [5] TrackPoint Engineering Specifications for version 3E
67 * https://web.archive.org/web/20100526161812/http://wwwcssrv.almaden.ibm.com/trackpoint/download.html
69 #define IBMPC_ACK 0xFA
70 #define IBMPC_RESEND 0xFE
71 #define IBMPC_SET_LED 0xED
73 #define IBMPC_PROTOCOL_AT 0
74 #define IBMPC_PROTOCOL_XT 1
76 // TODO: error numbers
77 #define IBMPC_ERR_NONE 0
78 #define IBMPC_ERR_RECV 0x00
79 #define IBMPC_ERR_SEND 0x10
80 #define IBMPC_ERR_TIMEOUT 0x20
81 #define IBMPC_ERR_FULL 0x40
82 #define IBMPC_ERR_ILLEGAL 0x80
84 #define IBMPC_LED_SCROLL_LOCK 0
85 #define IBMPC_LED_NUM_LOCK 1
86 #define IBMPC_LED_CAPS_LOCK 2
89 extern volatile uint8_t ibmpc_protocol;
90 extern volatile uint8_t ibmpc_error;
92 void ibmpc_host_init(void);
93 void ibmpc_host_enable(void);
94 void ibmpc_host_disable(void);
95 int16_t ibmpc_host_send(uint8_t data);
96 int16_t ibmpc_host_recv_response(void);
97 int16_t ibmpc_host_recv(void);
98 void ibmpc_host_isr_clear(void);
99 void ibmpc_host_set_led(uint8_t usb_led);
102 /*--------------------------------------------------------------------
104 *------------------------------------------------------------------*/
109 static inline void clock_lo(void)
111 IBMPC_CLOCK_PORT &= ~(1<<IBMPC_CLOCK_BIT);
112 IBMPC_CLOCK_DDR |= (1<<IBMPC_CLOCK_BIT);
115 static inline void clock_hi(void)
117 /* input with pull up */
118 IBMPC_CLOCK_DDR &= ~(1<<IBMPC_CLOCK_BIT);
119 IBMPC_CLOCK_PORT |= (1<<IBMPC_CLOCK_BIT);
122 static inline bool clock_in(void)
124 IBMPC_CLOCK_DDR &= ~(1<<IBMPC_CLOCK_BIT);
125 IBMPC_CLOCK_PORT |= (1<<IBMPC_CLOCK_BIT);
127 return IBMPC_CLOCK_PIN&(1<<IBMPC_CLOCK_BIT);
133 static inline void data_lo(void)
135 IBMPC_DATA_PORT &= ~(1<<IBMPC_DATA_BIT);
136 IBMPC_DATA_DDR |= (1<<IBMPC_DATA_BIT);
139 static inline void data_hi(void)
141 /* input with pull up */
142 IBMPC_DATA_DDR &= ~(1<<IBMPC_DATA_BIT);
143 IBMPC_DATA_PORT |= (1<<IBMPC_DATA_BIT);
146 static inline bool data_in(void)
148 IBMPC_DATA_DDR &= ~(1<<IBMPC_DATA_BIT);
149 IBMPC_DATA_PORT |= (1<<IBMPC_DATA_BIT);
151 return IBMPC_DATA_PIN&(1<<IBMPC_DATA_BIT);
156 static inline uint16_t wait_clock_lo(uint16_t us)
158 while (clock_in() && us) { asm(""); wait_us(1); us--; }
161 static inline uint16_t wait_clock_hi(uint16_t us)
163 while (!clock_in() && us) { asm(""); wait_us(1); us--; }
166 static inline uint16_t wait_data_lo(uint16_t us)
168 while (data_in() && us) { asm(""); wait_us(1); us--; }
171 static inline uint16_t wait_data_hi(uint16_t us)
173 while (!data_in() && us) { asm(""); wait_us(1); us--; }
177 /* idle state that device can send */
178 static inline void idle(void)
184 /* inhibit device to send */
185 static inline void inhibit(void)