2 Copyright 2011 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.
39 #include <util/delay.h>
41 #include <avr/interrupt.h>
46 static inline void data_lo(void);
47 static inline void data_hi(void);
48 static inline bool data_in(void);
50 static inline void psw_lo(void);
51 static inline void psw_hi(void);
52 static inline bool psw_in(void);
55 static inline void attention(void);
56 static inline void place_bit0(void);
57 static inline void place_bit1(void);
58 static inline void send_byte(uint8_t data);
59 static inline bool read_bit(void);
60 static inline uint8_t read_byte(void);
61 static inline uint8_t wait_data_lo(uint16_t us);
62 static inline uint8_t wait_data_hi(uint8_t us);
65 void adb_host_init(void)
72 // Enable keyboard left/right modifier distinction
73 // Addr:Keyboard(0010), Cmd:Listen(10), Register3(11)
74 // upper byte: reserved bits 0000, device address 0010
75 // lower byte: device handler 00000011
76 adb_host_listen(0x2B,0x02,0x03);
80 bool adb_host_psw(void)
87 * Don't call this in a row without the delay, otherwise it makes some of poor controllers
88 * overloaded and misses strokes. Recommended delay is 16ms.
90 * Thanks a lot, blargg! <http://geekhack.org/index.php?topic=14290.msg1068919#msg1068919>
92 uint16_t adb_host_kbd_recv(void)
96 send_byte(0x2C); // Addr:Keyboard(0010), Cmd:Talk(11), Register0(00)
97 place_bit0(); // Stopbit(0)
98 if (!wait_data_lo(500)) { // Tlt/Stop to Start(140-260us)
99 return 0; // No data to send
101 if (!read_bit()) { // Startbit(1)
103 dprintf("Startbit ERROR\n");
107 // ad hoc fix: without block inerrupt read wrong bit occasionally and get keys stuck
110 data = (data<<8) | read_byte();
111 uint8_t stop = read_bit(); // Stopbit(0)
115 dprintf("Stopbit ERROR\n");
121 void adb_host_listen(uint8_t cmd, uint8_t data_h, uint8_t data_l)
125 place_bit0(); // Stopbit(0)
126 _delay_us(200); // Tlt/Stop to Start
127 place_bit1(); // Startbit(1)
130 place_bit0(); // Stopbit(0);
133 // send state of LEDs
134 void adb_host_kbd_led(uint8_t led)
136 // Addr:Keyboard(0010), Cmd:Listen(10), Register2(10)
137 // send upper byte (not used)
138 // send lower byte (bit2: ScrollLock, bit1: CapsLock, bit0:
139 adb_host_listen(0x2A,0,led&0x07);
143 static inline void data_lo()
145 ADB_DDR |= (1<<ADB_DATA_BIT);
146 ADB_PORT &= ~(1<<ADB_DATA_BIT);
148 static inline void data_hi()
150 ADB_PORT |= (1<<ADB_DATA_BIT);
151 ADB_DDR &= ~(1<<ADB_DATA_BIT);
153 static inline bool data_in()
155 ADB_PORT |= (1<<ADB_DATA_BIT);
156 ADB_DDR &= ~(1<<ADB_DATA_BIT);
157 return ADB_PIN&(1<<ADB_DATA_BIT);
161 static inline void psw_lo()
163 ADB_DDR |= (1<<ADB_PSW_BIT);
164 ADB_PORT &= ~(1<<ADB_PSW_BIT);
166 static inline void psw_hi()
168 ADB_PORT |= (1<<ADB_PSW_BIT);
169 ADB_DDR &= ~(1<<ADB_PSW_BIT);
171 static inline bool psw_in()
173 ADB_PORT |= (1<<ADB_PSW_BIT);
174 ADB_DDR &= ~(1<<ADB_PSW_BIT);
175 return ADB_PIN&(1<<ADB_PSW_BIT);
179 static inline void attention(void)
186 static inline void place_bit0(void)
194 static inline void place_bit1(void)
202 static inline void send_byte(uint8_t data)
204 for (int i = 0; i < 8; i++) {
212 static inline bool read_bit(void)
216 // bit cell time: 70-130us
217 // low part of bit0: 60-70% of bit cell
218 // low part of bit1: 30-40% of bit cell
220 // bit cell time 70us 130us
221 // --------------------------------------------
222 // low part of bit0 42-49 78-91
223 // high part of bit0 21-28 39-52
224 // low part of bit1 21-28 39-52
225 // high part of bit1 42-49 78-91
230 // ____________~~~~~~
234 // ____________~~~~~~
239 // ______~~~~~~~~~~~~
243 // ______~~~~~~~~~~~~
247 // ________|~~~~~~~~~
249 // Read data line after 55us. If data line is low/high then bit is 0/1.
250 // This method might not work at <90us bit cell time.
252 // [from Apple IIgs Hardware Reference Second Edition]
254 wait_data_lo(75); // wait the start of bit cell at least 130ms(55+0+75)
257 wait_data_hi(36); // wait high part of bit cell at least 91ms(55+36)
261 static inline uint8_t read_byte(void)
264 for (int i = 0; i < 8; i++) {
272 static inline uint8_t wait_data_lo(uint16_t us)
274 while (data_in() && us) {
281 static inline uint8_t wait_data_hi(uint8_t us)
283 while (!data_in() && us) {
297 ADB - The Untold Story: Space Aliens Ate My Mouse
298 http://developer.apple.com/legacy/mac/library/#technotes/hw/hw_01.html
300 http://developer.apple.com/legacy/mac/library/documentation/mac/pdf/Devices/ADB_Manager.pdf
301 Service request(5-17)
302 Apple IIgs Hardware Reference Second Edition [Chapter6 p121]
303 ftp://ftp.apple.asimov.net/pub/apple_II/documentation/Apple%20IIgs%20Hardware%20Reference.pdf
305 http://72.0.193.250/Documentation/macppc/adbkeycodes/
306 http://m0115.web.fc2.com/m0115.jpg
307 [Inside Macintosh volume V, pages 191-192]
308 http://www.opensource.apple.com/source/IOHIDFamily/IOHIDFamily-421.18.3/IOHIDFamily/Cosmo_USB2ADB.c
310 http://kbdbabel.sourceforge.net/doc/kbd_signaling_pcxt_ps2_adb.pdf
311 ADB Overview & History
312 http://en.wikipedia.org/wiki/Apple_Desktop_Bus
313 Microchip Application Note: ADB device(with code for PIC16C)
314 http://www.microchip.com/stellent/idcplg?IdcService=SS_GET_PAGE&nodeId=1824&appnote=en011062
315 AVR ATtiny2131 ADB to PS/2 converter(Japanese)
316 http://hp.vector.co.jp/authors/VA000177/html/KeyBoardA5DEA5CBA5A2II.html
321 ADB female socket from the front:
327 |________| <--- bottom
331 ADB female socket from bottom:
333 ========== <--- front
341 2: Power SW(low when press Power key)
348 ADB command is 1byte and consists of 4bit-address, 2bit-command
349 type and 2bit-register. The commands are always sent by Host.
353 | | | |------------ address
354 | |-------- command type
358 ------------------------------------------------------
359 - - - - 0 0 0 0 Send Request(reset all devices)
360 A A A A 0 0 0 1 Flush(reset a device)
361 - - - - 0 0 1 0 Reserved
362 - - - - 0 0 1 1 Reserved
363 - - - - 0 1 - - Reserved
364 A A A A 1 0 R R Listen(write to a device)
365 A A A A 1 1 R R Talk(read from a device)
367 The command to read keycodes from keyboard is 0x2C which
368 consist of keyboard address 2 and Talk against register 0.
375 0: application(keyobard uses this to store its data.)
377 2: application(keyboard uses this for LEDs and state of modifiers)
378 3: status and command
383 This is a minimum information for keyboard communication.
384 See "Resources" for detail.
388 ~~~~____________~~||||||||||||__~~~~~_~~|||||||||||||||__~~~~
390 |800us | |7 Command 0| | | |15-64 Data 0|Stopbit(0)
391 +Attention | | | +Startbit(1)
392 +Startbit(1) | +Tlt(140-260us)
403 bit0 low time: 60-70% of bit cell(42-91us)
404 bit1 low time: 30-40% of bit cell(21-52us)
405 bit cell time: 70-130us
406 [from Apple IIgs Hardware Reference Second Edition]
408 Criterion for bit0/1:
409 After 55us if line is low/high then bit is 0/1.
411 Attention & start bit:
412 Host asserts low in 560-1040us then places start bit(1).
415 Bus stays high in 140-260us then device places start bit(1).
418 Host asserts low in 2.8-5.2ms. All devices are forced to reset.
420 Service request from device(Srq):
421 Device can request to send at commad(Global only?) stop bit.
422 Requesting device keeps low for 140-260us at stop bit of command.
425 Keyboard Data(Register0)
426 This 16bit data can contains two keycodes and two released flags.
427 First keycode is palced in upper byte. When one keyocode is sent,
429 Release flag is 1 when key is released.
431 1514 . . . . . 8 7 6 . . . . . 0
432 | | | | | | | | | +-+-+-+-+-+-+- Keycode2
433 | | | | | | | | +--------------- Released2(1 when the key is released)
434 | +-+-+-+-+-+-+----------------- Keycode1
435 +------------------------------- Released1(1 when the key is released)
438 Scancode consists of 7bit keycode and 1bit release flag.
439 Device can send two keycodes at once. If just one keycode is sent
440 keycode1 contains it and keyocode2 is 0xFF.
443 You can read the state from PSW line(active low) however
444 the switch has a special scancode 0x7F7F, so you can
445 also read from Data line. It uses 0xFFFF for release scancode.
447 Keyboard LEDs & state of keys(Register2)
448 This register hold current state of three LEDs and nine keys.
449 The state of LEDs can be changed by sending Listen command.
451 1514 . . . . . . 7 6 5 . 3 2 1 0
452 | | | | | | | | | | | | | | | +- LED1(NumLock)
453 | | | | | | | | | | | | | | +--- LED2(CapsLock)
454 | | | | | | | | | | | | | +----- LED3(ScrollLock)
455 | | | | | | | | | | +-+-+------- Reserved
456 | | | | | | | | | +------------- ScrollLock
457 | | | | | | | | +--------------- NumLock
458 | | | | | | | +----------------- Apple/Command
459 | | | | | | +------------------- Option
460 | | | | | +--------------------- Shift
461 | | | | +----------------------- Control
462 | | | +------------------------- Reset/Power
463 | | +--------------------------- CapsLock
464 | +----------------------------- Delete
465 +------------------------------- Reserved