123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356 |
- /*
- Copyright 2011 Jun WAKO <[email protected]>
-
- This software is licensed with a Modified BSD License.
- All of this is supposed to be Free Software, Open Source, DFSG-free,
- GPL-compatible, and OK to use in both free and proprietary applications.
- Additions and corrections to this file are welcome.
-
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions are met:
-
- * Redistributions of source code must retain the above copyright
- notice, this list of conditions and the following disclaimer.
-
- * Redistributions in binary form must reproduce the above copyright
- notice, this list of conditions and the following disclaimer in
- the documentation and/or other materials provided with the
- distribution.
-
- * Neither the name of the copyright holders nor the names of
- contributors may be used to endorse or promote products derived
- from this software without specific prior written permission.
-
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
- LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- POSSIBILITY OF SUCH DAMAGE.
- */
-
- #include <stdbool.h>
- #include <avr/io.h>
- #include <avr/interrupt.h>
- #include <util/delay.h>
- #include "m0110.h"
- #include "debug.h"
-
-
- static inline void clock_lo(void);
- static inline void clock_hi(void);
- static inline bool clock_in(void);
- static inline void data_lo(void);
- static inline void data_hi(void);
- static inline bool data_in(void);
- static inline uint16_t wait_clock_lo(uint16_t us);
- static inline uint16_t wait_clock_hi(uint16_t us);
- static inline uint16_t wait_data_lo(uint16_t us);
- static inline uint16_t wait_data_hi(uint16_t us);
- static inline void idle(void);
- static inline void request(void);
-
-
- /*
- Primitive M0110 Library for AVR
- ==============================
-
-
- Signaling
- ---------
- CLOCK is always from KEYBOARD. DATA are sent with MSB first.
-
- 1) IDLE: both lines are high.
- CLOCK ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- DATA ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
- 2) KEYBOARD->HOST: HOST reads bit on rising edge.
- CLOCK ~~~~~~~~~~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~~~~~~~~~
- DATA ~~~~~~~~~~~~X777777X666666X555555X444444X333333X222222X111111X000000X~~~~~~~
- <--> 160us(clock low)
- <---> 180us(clock high)
-
- 3) HOST->KEYBOARD: HOST asserts bit on falling edge.
- CLOCK ~~~~~~~~~~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~~~~~~~~~
- DATA ~~~~~~|_____X777777X666666X555555X444444X333333X222222X111111X000000X~~~~~~~
- <----> 840us(request to send by host) <---> 80us(hold DATA)
- <--> 180us(clock low)
- <---> 220us(clock high)
-
-
- Protocol
- --------
- COMMAND:
- Inquiry 0x10 get key event
- Instant 0x12 get key event
- Model 0x14 get model number(M0110 responds with 0x09)
- bit 7 1 if another device connected(used when keypad exists?)
- bit4-6 next device model number
- bit1-3 keyboard model number
- bit 0 always 1
- Test 0x16 test(ACK:0x7D/NAK:0x77)
-
- KEY EVENT:
- bit 7 key state(0:press 1:release)
- bit 6-1 scan code(see below)
- bit 0 always 1
- To get scan code use this: ((bits&(1<<7)) | ((bits&0x7F))>>1).
-
- Note: On the M0110A, the numpad keys and the arrow keys are preceded by 0x79.
- Moreover, the numpad keys =, /, * and + are preceded by shift-down 0x71 on press and shift-up 0xF1 on release.
- So, the data transferred by nupmad 5 is "79 2F" whereas for numpad + it's "71 79 0D".
-
- SCAN CODE:
- m0111_recv_key() function returns follwing scan codes instead of raw key events.
- Scan codes are 1 byte long and bit7 is set when key is released.
-
- M0110
- ,---------------------------------------------------------.
- | `| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backs|
- |---------------------------------------------------------|
- |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \|
- |---------------------------------------------------------|
- |CapsLo| A| S| D| F| G| H| J| K| L| ;| '|Return|
- |---------------------------------------------------------|
- |Shift | Z| X| C| V| B| N| M| ,| ,| /| |
- `---------------------------------------------------------'
- |Opt|Mac | Space |Enter|Opt|
- `------------------------------------------------'
- ,---------------------------------------------------------.
- | 32| 12| 13| 14| 15| 17| 16| 1A| 1C| 19| 1D| 1B| 18| 33|
- |---------------------------------------------------------|
- | 30| 0C| 0D| 0E| 0F| 10| 11| 20| 22| 1F| 23| 21| 1E| 2A|
- |---------------------------------------------------------|
- | 39| 00| 01| 02| 03| 05| 04| 26| 28| 25| 29| 27| 24|
- |---------------------------------------------------------|
- | 38| 06| 07| 08| 09| 0B| 2D| 2E| 2B| 2F| 2C| 38|
- `---------------------------------------------------------'
- | 3A| 37| 31 | 34| 3A|
- `------------------------------------------------'
-
- M0110A
- ,---------------------------------------------------------. ,---------------.
- | `| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Bcksp| |Clr| =| /| *|
- |---------------------------------------------------------| |---------------|
- |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| | | 7| 8| 9| -|
- |-----------------------------------------------------' | |---------------|
- |CapsLo| A| S| D| F| G| H| J| K| L| ;| '|Return| | 4| 5| 6| +|
- |---------------------------------------------------------| |---------------|
- |Shift | Z| X| C| V| B| N| M| ,| ,| /|Shft|Up | | 1| 2| 3| |
- |---------------------------------------------------------' |-----------|Ent|
- |Optio|Mac | Space | \|Lft|Rgt|Dn | | 0| .| |
- `---------------------------------------------------------' `---------------'
- ,---------------------------------------------------------. ,---------------.
- | 32| 12| 13| 14| 15| 17| 16| 1A| 1C| 19| 1D| 1B| 18| 33| | 47| 68| 6D| 62|
- |---------------------------------------------------------| |---------------|
- | 30| 0C| 0D| 0E| 0F| 10| 11| 20| 22| 1F| 23| 21| 1E| | | 59| 5B| 5C| 4E|
- |-----------------------------------------------------' | |---------------|
- | 39| 00| 01| 02| 03| 05| 04| 26| 28| 25| 29| 27| 24| | 56| 57| 58| 66|
- |---------------------------------------------------------| |---------------|
- | 38| 06| 07| 08| 09| 0B| 2D| 2E| 2B| 2F| 2C| 38| 4D| | 53| 54| 55| |
- |---------------------------------------------------------' |-----------| 4C|
- | 3A| 37| 31 | 2A| 46| 42| 48| | 52| 41| |
- `---------------------------------------------------------' `---------------'
-
-
- References
- ----------
- Technical Info for 128K/512K and Plus
- ftp://ftp.apple.asimov.net/pub/apple_II/documentation/macintosh/Mac%20Hardware%20Info%20-%20Mac%20128K.pdf
- ftp://ftp.apple.asimov.net/pub/apple_II/documentation/macintosh/Mac%20Hardware%20Info%20-%20Mac%20Plus.pdf
- Protocol:
- Page 20 of Tech Info for 128K/512K
- http://www.mac.linux-m68k.org/devel/plushw.php
- Connector:
- Page 20 of Tech Info for 128K/512K
- http://www.kbdbabel.org/conn/kbd_connector_macplus.png
- Signaling:
- http://www.kbdbabel.org/signaling/kbd_signaling_mac.png
- http://typematic.blog.shinobi.jp/Entry/14/
- Scan Codes:
- Page 22 of Tech Info for 128K/512K
- Page 07 of Tech Info for Plus
- http://m0115.web.fc2.com/m0110.jpg
- http://m0115.web.fc2.com/m0110a.jpg
- */
-
-
- #define WAIT_US(stat, us, err) do { \
- if (!wait_##stat(us)) { \
- m0110_error = err; \
- goto ERROR; \
- } \
- } while (0)
-
- #define WAIT_MS(stat, ms, err) do { \
- uint16_t _ms = ms; \
- while (_ms) { \
- if (wait_##stat(1000)) { \
- break; \
- } \
- _ms--; \
- } \
- if (_ms == 0) { \
- m0110_error = err; \
- goto ERROR; \
- } \
- } while (0)
-
-
- uint8_t m0110_error = 0;
-
-
- void m0110_init(void)
- {
- uint8_t data;
- idle();
- _delay_ms(1000);
-
- // Model Number
- // M0110 : 0x09 00001001 : model number 4 (100)
- // M0110A: 0x0B 00001011 : model number 5 (101)
- // M0110 & M0120: ???
- m0110_send(M0110_MODEL);
- data = m0110_recv();
- print("m0110_init model: "); phex(data); print("\n");
-
- m0110_send(M0110_TEST);
- data = m0110_recv();
- print("m0110_init test: "); phex(data); print("\n");
- }
-
- uint8_t m0110_send(uint8_t data)
- {
- m0110_error = 0;
-
- request();
- WAIT_MS(clock_lo, 250, 1); // keyboard may block long time
- for (uint8_t bit = 0x80; bit; bit >>= 1) {
- WAIT_US(clock_lo, 250, 3);
- if (data&bit) {
- data_hi();
- } else {
- data_lo();
- }
- WAIT_US(clock_hi, 200, 4);
- }
- _delay_us(100); // hold last bit for 80us
- idle();
- return 1;
- ERROR:
- print("m0110_send err: "); phex(m0110_error); print("\n");
- _delay_ms(500);
- idle();
- return 0;
- }
-
- uint8_t m0110_recv(void)
- {
- uint8_t data = 0;
- m0110_error = 0;
-
- WAIT_MS(clock_lo, 250, 1); // keyboard may block long time
- for (uint8_t i = 0; i < 8; i++) {
- data <<= 1;
- WAIT_US(clock_lo, 200, 2);
- WAIT_US(clock_hi, 200, 3);
- if (data_in()) {
- data |= 1;
- }
- }
- idle();
- return data;
- ERROR:
- print("m0110_recv err: "); phex(m0110_error); print("\n");
- _delay_ms(500);
- idle();
- return 0xFF;
- }
-
- uint8_t m0110_recv_key(void)
- {
- uint8_t key;
- m0110_send(M0110_INQUIRY);
- key = m0110_recv();
- if (key == 0xFF || key == M0110_NULL)
- return M0110_NULL;
- else
- return M0110_RAW2SCAN(key);
- }
-
-
- static inline void clock_lo()
- {
- M0110_CLOCK_PORT &= ~(1<<M0110_CLOCK_BIT);
- M0110_CLOCK_DDR |= (1<<M0110_CLOCK_BIT);
- }
- static inline void clock_hi()
- {
- /* input with pull up */
- M0110_CLOCK_DDR &= ~(1<<M0110_CLOCK_BIT);
- M0110_CLOCK_PORT |= (1<<M0110_CLOCK_BIT);
- }
- static inline bool clock_in()
- {
- M0110_CLOCK_DDR &= ~(1<<M0110_CLOCK_BIT);
- M0110_CLOCK_PORT |= (1<<M0110_CLOCK_BIT);
- _delay_us(1);
- return M0110_CLOCK_PIN&(1<<M0110_CLOCK_BIT);
- }
- static inline void data_lo()
- {
- M0110_DATA_PORT &= ~(1<<M0110_DATA_BIT);
- M0110_DATA_DDR |= (1<<M0110_DATA_BIT);
- }
- static inline void data_hi()
- {
- /* input with pull up */
- M0110_DATA_DDR &= ~(1<<M0110_DATA_BIT);
- M0110_DATA_PORT |= (1<<M0110_DATA_BIT);
- }
- static inline bool data_in()
- {
- M0110_DATA_DDR &= ~(1<<M0110_DATA_BIT);
- M0110_DATA_PORT |= (1<<M0110_DATA_BIT);
- _delay_us(1);
- return M0110_DATA_PIN&(1<<M0110_DATA_BIT);
- }
-
- static inline uint16_t wait_clock_lo(uint16_t us)
- {
- while (clock_in() && us) { asm(""); _delay_us(1); us--; }
- return us;
- }
- static inline uint16_t wait_clock_hi(uint16_t us)
- {
- while (!clock_in() && us) { asm(""); _delay_us(1); us--; }
- return us;
- }
- static inline uint16_t wait_data_lo(uint16_t us)
- {
- while (data_in() && us) { asm(""); _delay_us(1); us--; }
- return us;
- }
- static inline uint16_t wait_data_hi(uint16_t us)
- {
- while (!data_in() && us) { asm(""); _delay_us(1); us--; }
- return us;
- }
-
- static inline void idle(void)
- {
- clock_hi();
- data_hi();
- }
-
- static inline void request(void)
- {
- clock_hi();
- data_lo();
- }
|