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>
45 static inline void data_lo(void);
46 static inline void data_hi(void);
47 static inline bool data_in(void);
49 static inline void psw_lo(void);
50 static inline void psw_hi(void);
51 static inline bool psw_in(void);
54 static inline void attention(void);
55 static inline void place_bit0(void);
56 static inline void place_bit1(void);
57 static inline void send_byte(uint8_t data);
58 static inline bool read_bit(void);
59 static inline uint8_t read_byte(void);
60 static inline uint8_t wait_data_lo(uint16_t us);
61 static inline uint8_t wait_data_hi(uint8_t us);
64 void adb_host_init(void)
71 // Enable keyboard left/right modifier distinction
72 // Addr:Keyboard(0010), Cmd:Listen(10), Register3(11)
73 // upper byte: reserved bits 0000, device address 0010
74 // lower byte: device handler 00000011
75 adb_host_listen(0x2B,0x02,0x03);
79 bool adb_host_psw(void)
85 uint16_t adb_host_kbd_recv(void)
89 send_byte(0x2C); // Addr:Keyboard(0010), Cmd:Talk(11), Register0(00)
90 place_bit0(); // Stopbit(0)
91 if (!wait_data_lo(500)) { // Tlt/Stop to Start(140-260us)
92 return 0; // No data to send
94 if (!read_bit()) { // Startbit(1)
99 // ad hoc fix: without block inerrupt read wrong bit occasionally and get keys stuck
102 data = (data<<8) | read_byte();
103 uint8_t stop = read_bit(); // Stopbit(0)
112 void adb_host_listen(uint8_t cmd, uint8_t data_h, uint8_t data_l)
116 place_bit0(); // Stopbit(0)
117 _delay_us(200); // Tlt/Stop to Start
118 place_bit1(); // Startbit(1)
121 place_bit0(); // Stopbit(0);
124 // send state of LEDs
125 void adb_host_kbd_led(uint8_t led)
127 // Addr:Keyboard(0010), Cmd:Listen(10), Register2(10)
128 // send upper byte (not used)
129 // send lower byte (bit2: ScrollLock, bit1: CapsLock, bit0:
130 adb_host_listen(0x2A,0,led&0x07);
134 static inline void data_lo()
136 ADB_DDR |= (1<<ADB_DATA_BIT);
137 ADB_PORT &= ~(1<<ADB_DATA_BIT);
139 static inline void data_hi()
141 ADB_PORT |= (1<<ADB_DATA_BIT);
142 ADB_DDR &= ~(1<<ADB_DATA_BIT);
144 static inline bool data_in()
146 ADB_PORT |= (1<<ADB_DATA_BIT);
147 ADB_DDR &= ~(1<<ADB_DATA_BIT);
148 return ADB_PIN&(1<<ADB_DATA_BIT);
152 static inline void psw_lo()
154 ADB_DDR |= (1<<ADB_PSW_BIT);
155 ADB_PORT &= ~(1<<ADB_PSW_BIT);
157 static inline void psw_hi()
159 ADB_PORT |= (1<<ADB_PSW_BIT);
160 ADB_DDR &= ~(1<<ADB_PSW_BIT);
162 static inline bool psw_in()
164 ADB_PORT |= (1<<ADB_PSW_BIT);
165 ADB_DDR &= ~(1<<ADB_PSW_BIT);
166 return ADB_PIN&(1<<ADB_PSW_BIT);
170 static inline void attention(void)
177 static inline void place_bit0(void)
185 static inline void place_bit1(void)
193 static inline void send_byte(uint8_t data)
195 for (int i = 0; i < 8; i++) {
203 static inline bool read_bit(void)
207 // bit cell time: 70-130us
208 // low part of bit0: 60-70% of bit cell
209 // low part of bit1: 30-40% of bit cell
211 // bit cell time 70us 130us
212 // --------------------------------------------
213 // low part of bit0 42-49 78-91
214 // high part of bit0 21-28 39-52
215 // low part of bit1 21-28 39-52
216 // high part of bit1 42-49 78-91
221 // ____________~~~~~~
225 // ____________~~~~~~
230 // ______~~~~~~~~~~~~
234 // ______~~~~~~~~~~~~
238 // ________|~~~~~~~~~
240 // Read data line after 55us. If data line is low/high then bit is 0/1.
241 // This method might not work at <90us bit cell time.
243 // [from Apple IIgs Hardware Reference Second Edition]
245 wait_data_lo(75); // wait the start of bit cell at least 130ms(55+0+75)
248 wait_data_hi(36); // wait high part of bit cell at least 91ms(55+36)
252 static inline uint8_t read_byte(void)
255 for (int i = 0; i < 8; i++) {
263 static inline uint8_t wait_data_lo(uint16_t us)
265 while (data_in() && us) {
272 static inline uint8_t wait_data_hi(uint8_t us)
274 while (!data_in() && us) {
288 ADB - The Untold Story: Space Aliens Ate My Mouse
289 http://developer.apple.com/legacy/mac/library/#technotes/hw/hw_01.html
291 http://developer.apple.com/legacy/mac/library/documentation/mac/pdf/Devices/ADB_Manager.pdf
292 Service request(5-17)
293 Apple IIgs Hardware Reference Second Edition [Chapter6 p121]
294 ftp://ftp.apple.asimov.net/pub/apple_II/documentation/Apple%20IIgs%20Hardware%20Reference.pdf
296 http://72.0.193.250/Documentation/macppc/adbkeycodes/
297 http://m0115.web.fc2.com/m0115.jpg
298 [Inside Macintosh volume V, pages 191-192]
299 http://www.opensource.apple.com/source/IOHIDFamily/IOHIDFamily-421.18.3/IOHIDFamily/Cosmo_USB2ADB.c
301 http://kbdbabel.sourceforge.net/doc/kbd_signaling_pcxt_ps2_adb.pdf
302 ADB Overview & History
303 http://en.wikipedia.org/wiki/Apple_Desktop_Bus
304 Microchip Application Note: ADB device(with code for PIC16C)
305 http://www.microchip.com/stellent/idcplg?IdcService=SS_GET_PAGE&nodeId=1824&appnote=en011062
306 AVR ATtiny2131 ADB to PS/2 converter(Japanese)
307 http://hp.vector.co.jp/authors/VA000177/html/KeyBoardA5DEA5CBA5A2II.html
312 ADB female socket from the front:
318 |________| <--- bottom
322 ADB female socket from bottom:
324 ========== <--- front
332 2: Power SW(low when press Power key)
339 ADB command is 1byte and consists of 4bit-address, 2bit-command
340 type and 2bit-register. The commands are always sent by Host.
344 | | | |------------ address
345 | |-------- command type
349 ------------------------------------------------------
350 - - - - 0 0 0 0 Send Request(reset all devices)
351 A A A A 0 0 0 1 Flush(reset a device)
352 - - - - 0 0 1 0 Reserved
353 - - - - 0 0 1 1 Reserved
354 - - - - 0 1 - - Reserved
355 A A A A 1 0 R R Listen(write to a device)
356 A A A A 1 1 R R Talk(read from a device)
358 The command to read keycodes from keyboard is 0x2C which
359 consist of keyboard address 2 and Talk against register 0.
366 0: application(keyobard uses this to store its data.)
368 2: application(keyboard uses this for LEDs and state of modifiers)
369 3: status and command
374 This is a minimum information for keyboard communication.
375 See "Resources" for detail.
379 ~~~~____________~~||||||||||||__~~~~~_~~|||||||||||||||__~~~~
381 |800us | |7 Command 0| | | |15-64 Data 0|Stopbit(0)
382 +Attention | | | +Startbit(1)
383 +Startbit(1) | +Tlt(140-260us)
394 bit0 low time: 60-70% of bit cell(42-91us)
395 bit1 low time: 30-40% of bit cell(21-52us)
396 bit cell time: 70-130us
397 [from Apple IIgs Hardware Reference Second Edition]
399 Criterion for bit0/1:
400 After 55us if line is low/high then bit is 0/1.
402 Attention & start bit:
403 Host asserts low in 560-1040us then places start bit(1).
406 Bus stays high in 140-260us then device places start bit(1).
409 Host asserts low in 2.8-5.2ms. All devices are forced to reset.
411 Service request from device(Srq):
412 Device can request to send at commad(Global only?) stop bit.
413 Requesting device keeps low for 140-260us at stop bit of command.
416 Keyboard Data(Register0)
417 This 16bit data can contains two keycodes and two released flags.
418 First keycode is palced in upper byte. When one keyocode is sent,
420 Release flag is 1 when key is released.
422 1514 . . . . . 8 7 6 . . . . . 0
423 | | | | | | | | | +-+-+-+-+-+-+- Keycode2
424 | | | | | | | | +--------------- Released2(1 when the key is released)
425 | +-+-+-+-+-+-+----------------- Keycode1
426 +------------------------------- Released1(1 when the key is released)
429 Scancode consists of 7bit keycode and 1bit release flag.
430 Device can send two keycodes at once. If just one keycode is sent
431 keycode1 contains it and keyocode2 is 0xFF.
434 You can read the state from PSW line(active low) however
435 the switch has a special scancode 0x7F7F, so you can
436 also read from Data line. It uses 0xFFFF for release scancode.
438 Keyboard LEDs & state of keys(Register2)
439 This register hold current state of three LEDs and nine keys.
440 The state of LEDs can be changed by sending Listen command.
442 1514 . . . . . . 7 6 5 . 3 2 1 0
443 | | | | | | | | | | | | | | | +- LED1(NumLock)
444 | | | | | | | | | | | | | | +--- LED2(CapsLock)
445 | | | | | | | | | | | | | +----- LED3(ScrollLock)
446 | | | | | | | | | | +-+-+------- Reserved
447 | | | | | | | | | +------------- ScrollLock
448 | | | | | | | | +--------------- NumLock
449 | | | | | | | +----------------- Apple/Command
450 | | | | | | +------------------- Option
451 | | | | | +--------------------- Shift
452 | | | | +----------------------- Control
453 | | | +------------------------- Reset/Power
454 | | +--------------------------- CapsLock
455 | +----------------------------- Delete
456 +------------------------------- Reserved