Moved files to common, protocol and doc directory

60 files changed, 13820 insertions, 0 deletions

diff --git a/protocol/adb.c b/protocol/adb.c
new file mode 100644
index 0000000000..116f612721
--- /dev/null
+++ b/protocol/adb.c
@@ -0,0 +1,407 @@
+/*
+Copyright 2011 Jun WAKO <wakojun@gmail.com>
+
+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 <util/delay.h>
+#include <avr/io.h>
+#include "adb.h"
+
+
+static inline void data_lo(void);
+static inline void data_hi(void);
+static inline bool data_in(void);
+#ifdef ADB_PSW_BIT
+static inline void psw_lo(void);
+static inline void psw_hi(void);
+static inline bool psw_in(void);
+#endif
+
+static inline void attention(void);
+static inline void place_bit0(void);
+static inline void place_bit1(void);
+static inline void send_byte(uint8_t data);
+static inline bool read_bit(void);
+static inline uint8_t read_byte(void);
+static inline uint8_t wait_data_lo(uint8_t us);
+static inline uint8_t wait_data_hi(uint8_t us);
+
+
+void adb_host_init(void)
+{
+    data_hi();
+#ifdef ADB_PSW_BIT
+    psw_hi();
+#endif
+}
+
+#ifdef ADB_PSW_BIT
+bool adb_host_psw(void)
+{
+    return psw_in();
+}
+#endif
+
+uint16_t adb_host_kbd_recv(void)
+{
+    uint16_t data = 0;
+    attention();
+    send_byte(0x2C);            // Addr:Keyboard(0010), Cmd:Talk(11), Register0(00)
+    place_bit0();               // Stopbit(0)
+    if (!wait_data_lo(0xFF))    // Tlt/Stop to Start(140-260us)
+        return 0;               // No data to send
+    if (!read_bit())            // Startbit(1)
+        return -2;
+    data = read_byte();
+    data = (data<<8) | read_byte();
+    if (read_bit())             // Stopbit(0)
+        return -3;
+    return data;
+}
+
+// send state of LEDs
+void adb_host_kbd_led(uint8_t led)
+{
+    attention();
+    send_byte(0x2A);            // Addr:Keyboard(0010), Cmd:Listen(10), Register2(10)
+    place_bit0();               // Stopbit(0)
+    _delay_us(200);             // Tlt/Stop to Start
+    place_bit1();               // Startbit(1)
+    send_byte(0);               // send upper byte (not used)
+    send_byte(led&0x07);        // send lower byte (bit2: ScrollLock, bit1: CapsLock, bit0: NumLock)
+    place_bit0();               // Stopbit(0);
+}
+
+
+static inline void data_lo()
+{
+    ADB_DDR  |=  (1<<ADB_DATA_BIT);
+    ADB_PORT &= ~(1<<ADB_DATA_BIT);
+}
+static inline void data_hi()
+{
+    ADB_PORT |=  (1<<ADB_DATA_BIT);
+    ADB_DDR  &= ~(1<<ADB_DATA_BIT);
+}
+static inline bool data_in()
+{
+    ADB_PORT |=  (1<<ADB_DATA_BIT);
+    ADB_DDR  &= ~(1<<ADB_DATA_BIT);
+    return ADB_PIN&(1<<ADB_DATA_BIT);
+}
+
+#ifdef ADB_PSW_BIT
+static inline void psw_lo()
+{
+    ADB_DDR  |=  (1<<ADB_PSW_BIT);
+    ADB_PORT &= ~(1<<ADB_PSW_BIT);
+}
+static inline void psw_hi()
+{
+    ADB_PORT |=  (1<<ADB_PSW_BIT);
+    ADB_DDR  &= ~(1<<ADB_PSW_BIT);
+}
+static inline bool psw_in()
+{
+    ADB_PORT |=  (1<<ADB_PSW_BIT);
+    ADB_DDR  &= ~(1<<ADB_PSW_BIT);
+    return ADB_PIN&(1<<ADB_PSW_BIT);
+}
+#endif
+
+static inline void attention(void)
+{
+    data_lo();
+    _delay_us(700);
+    place_bit1();
+}
+
+static inline void place_bit0(void)
+{
+    data_lo();
+    _delay_us(65);
+    data_hi();
+    _delay_us(35);
+}
+
+static inline void place_bit1(void)
+{
+    data_lo();
+    _delay_us(35);
+    data_hi();
+    _delay_us(65);
+}
+
+static inline void send_byte(uint8_t data)
+{
+    for (int i = 0; i < 8; i++) {
+        if (data&(0x80>>i))
+            place_bit1();
+        else
+            place_bit0();
+    }
+}
+
+static inline bool read_bit(void)
+{
+    // ADB Bit Cells
+    //
+    // bit0: ______~~~
+    //       65    :35us
+    //
+    // bit1: ___~~~~~~
+    //       35 :65us
+    //
+    // bit0 low time: 60-70% of bit cell(42-91us)
+    // bit1 low time: 30-40% of bit cell(21-52us)
+    // bit cell time: 70-130us
+    // [from Apple IIgs Hardware Reference Second Edition]
+    //
+    // After 55us if data line is low/high then bit is 0/1.
+    // Too simple to rely on?
+    bool bit;
+    wait_data_lo(75);   // wait the beginning of bit cell
+    _delay_us(55);
+    bit = data_in();
+    wait_data_hi(36);   // wait high part of bit cell
+    return bit;
+}
+
+static inline uint8_t read_byte(void)
+{
+    uint8_t data = 0;
+    for (int i = 0; i < 8; i++) {
+        data <<= 1;
+        if (read_bit())
+            data = data | 1;
+    }
+    return data;
+}
+
+static inline uint8_t wait_data_lo(uint8_t us)
+{
+    while (data_in() && us) {
+        _delay_us(1);
+        us--;
+    }
+    return us;
+}
+
+static inline uint8_t wait_data_hi(uint8_t us)
+{
+    while (!data_in() && us) {
+        _delay_us(1);
+        us--;
+    }
+    return us;
+}
+
+
+/*
+ADB Protocol
+============
+
+Resources
+---------
+ADB - The Untold Story: Space Aliens Ate My Mouse
+    http://developer.apple.com/legacy/mac/library/#technotes/hw/hw_01.html
+Apple IIgs Hardware Reference Second Edition [p80(Chapter6 p121)]
+    ftp://ftp.apple.asimov.net/pub/apple_II/documentation/Apple%20IIgs%20Hardware%20Reference.pdf
+ADB Keycode
+    http://72.0.193.250/Documentation/macppc/adbkeycodes/
+    http://m0115.web.fc2.com/m0115.jpg
+    [Inside Macintosh volume V, pages 191-192]
+ADB Signaling
+    http://kbdbabel.sourceforge.net/doc/kbd_signaling_pcxt_ps2_adb.pdf
+ADB Overview & History
+    http://en.wikipedia.org/wiki/Apple_Desktop_Bus
+Microchip Application Note: ADB device(with code for PIC16C)
+    http://www.microchip.com/stellent/idcplg?IdcService=SS_GET_PAGE&nodeId=1824&appnote=en011062
+AVR ATtiny2131 ADB to PS/2 converter(Japanese)
+    http://hp.vector.co.jp/authors/VA000177/html/KeyBoardA5DEA5CBA5A2II.html
+
+
+Pinouts
+-------
+    ADB female socket from the front:
+    __________
+    |        | <--- top
+    | 4o  o3 |
+    |2o    o1|
+    |   ==   |
+    |________| <--- bottom
+      |    |   <--- 4pins
+
+
+    ADB female socket from bottom:
+
+    ========== <--- front
+    |        |
+    |        |
+    |2o    o1|
+    |4o    o3|
+    ---------- <--- back
+
+    1: Data
+    2: Power SW(low when press Power key)
+    3: Vcc(5V)
+    4: GND
+
+
+Commands
+--------
+    ADB command is 1byte and consists of 4bit-address, 2bit-command
+    type and 2bit-register. The commands are always sent by Host.
+
+    Command format:
+    7 6 5 4 3 2 1 0
+    | | | |------------ address
+            | |-------- command type
+                | |---- register
+
+    bits                commands
+    ------------------------------------------------------
+    - - - - 0 0 0 0     Send Request(reset all devices)
+    A A A A 0 0 0 1     Flush(reset a device)
+    - - - - 0 0 1 0     Reserved
+    - - - - 0 0 1 1     Reserved
+    - - - - 0 1 - -     Reserved
+    A A A A 1 0 R R     Listen(write to a device)
+    A A A A 1 1 R R     Talk(read from a device)
+
+    The command to read keycodes from keyboard is 0x2C which
+    consist of keyboard address 2 and Talk against register 0. 
+
+    Address:
+    2:  keyboard
+    3:  mice
+
+    Registers:
+    0: application(keyobard uses this to store its data.)
+    1: application
+    2: application(keyboard uses this for LEDs and state of modifiers)
+    3: status and command
+
+
+Communication
+-------------
+    This is a minimum information for keyboard communication.
+    See "Resources" for detail.
+
+    Signaling:
+
+    ~~~~____________~~||||||||||||__~~~~~_~~|||||||||||||||__~~~~
+
+        |800us     |  |7 Command 0|  |   |  |15-64  Data  0|Stopbit(0)
+        +Attention |              |  |   +Startbit(1)
+                   +Startbit(1)   |  +Tlt(140-260us)
+                                  +stopbit(0)
+
+    Bit cells:
+
+    bit0: ______~~~
+          65    :35us
+
+    bit1: ___~~~~~~
+          35 :65us
+
+    bit0 low time: 60-70% of bit cell(42-91us)
+    bit1 low time: 30-40% of bit cell(21-52us)
+    bit cell time: 70-130us
+    [from Apple IIgs Hardware Reference Second Edition]
+
+    Criterion for bit0/1:
+    After 55us if line is low/high then bit is 0/1.
+
+    Attention & start bit:
+    Host asserts low in 560-1040us then places start bit(1).
+
+    Tlt(Stop to Start):
+    Bus stays high in 140-260us then device places start bit(1).
+
+    Global reset:
+    Host asserts low in 2.8-5.2ms. All devices are forced to reset.
+
+    Send request from device(Srq):
+    Device can request to send at commad(Global only?) stop bit.
+    keep low for 300us to request.
+
+
+Keyboard Data(Register0)
+    This 16bit data can contains two keycodes and two released flags.
+    First keycode is palced in upper byte. When one keyocode is sent,
+    lower byte is 0xFF.
+    Release flag is 1 when key is released.
+
+    1514 . . . . . 8 7 6 . . . . . 0
+     | | | | | | | | | +-+-+-+-+-+-+-   Keycode2
+     | | | | | | | | +---------------   Released2(1 when the key is released)
+     | +-+-+-+-+-+-+-----------------   Keycode1
+     +-------------------------------   Released1(1 when the key is released)
+
+    Keycodes:
+    Scancode consists of 7bit keycode and 1bit release flag.
+    Device can send two keycodes at once. If just one keycode is sent
+    keycode1 contains it and keyocode2 is 0xFF.
+
+    Power switch:
+    You can read the state from PSW line(active low) however
+    the switch has a special scancode 0x7F7F, so you can
+    also read from Data line. It uses 0xFFFF for release scancode.
+    Release code seems to delay about some 100ms. Due to Mac soft power?
+
+Keyboard LEDs & state of keys(Register2)
+    This register hold current state of three LEDs and nine keys.
+    The state of LEDs can be changed by sending Listen command.
+    
+    1514 . . . . . . 7 6 5 . 3 2 1 0
+     | | | | | | | | | | | | | | | +-   LED1(NumLock)
+     | | | | | | | | | | | | | | +---   LED2(CapsLock)
+     | | | | | | | | | | | | | +-----   LED3(ScrollLock)
+     | | | | | | | | | | +-+-+-------   Reserved
+     | | | | | | | | | +-------------   ScrollLock
+     | | | | | | | | +---------------   NumLock
+     | | | | | | | +-----------------   Apple/Command
+     | | | | | | +-------------------   Option
+     | | | | | +---------------------   Shift
+     | | | | +-----------------------   Control
+     | | | +-------------------------   Reset/Power
+     | | +---------------------------   CapsLock
+     | +-----------------------------   Delete
+     +-------------------------------   Reserved
+
+END_OF_ADB
+*/
diff --git a/protocol/adb.h b/protocol/adb.h
new file mode 100644
index 0000000000..177f413944
--- /dev/null
+++ b/protocol/adb.h
@@ -0,0 +1,56 @@
+/*
+Copyright 2011 Jun WAKO <wakojun@gmail.com>
+
+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.
+*/
+
+#ifndef ADB_H
+#define ADB_H
+
+#include <stdbool.h>
+
+#if !(defined(ADB_PORT) && \
+      defined(ADB_PIN)  && \
+      defined(ADB_DDR)  && \
+      defined(ADB_DATA_BIT))
+#   error "ADB port setting is required in config.h"
+#endif
+
+// ADB host
+void     adb_host_init(void);
+bool     adb_host_psw(void);
+uint16_t adb_host_kbd_recv(void);
+void     adb_host_kbd_led(uint8_t led);
+
+#endif
diff --git a/protocol/iwrap.mk b/protocol/iwrap.mk
new file mode 100644
index 0000000000..ea4a6e9720
--- /dev/null
+++ b/protocol/iwrap.mk
@@ -0,0 +1,10 @@
+OPT_DEFS += -DHOST_IWRAP
+
+SRC +=	iwrap.c \
+	suart.S \
+	sendchar_uart.c \
+	uart.c
+
+
+# Search Path
+VPATH += $(COMMON_DIR)/iwrap
diff --git a/protocol/iwrap/iWRAP.txt b/protocol/iwrap/iWRAP.txt
new file mode 100644
index 0000000000..2a062d9d98
--- /dev/null
+++ b/protocol/iwrap/iWRAP.txt
@@ -0,0 +1,376 @@
+Bulegiga WT12
+=============
+WT12 is a bluetooth module from Bluegiga. http://www.bluegiga.com/
+
+iWRAP
+    higher layer interface for bluetooth firmware
+    communicate with UART
+
+iWRAP HID
+default setting
+    115200  8bit/n/1/n
+
+
+TODO
+----
+KiCAD circuit/PCB design
+power saving
+    AVR sleep(15ms by watch dog timer)
+    WT12 sleep
+    measuring current consumption
+    measuring battery life of normal usage/idle/intensive usage
+software reset/bootloarder
+LED indicator(chaging/paring/connecting)
+license confirmation of suart.c
+consumer page is not working
+authenticate method/SSP
+SPP keyboard support
+SPP debug console support
+mouse wheel feature request to Bluegiga
+
+
+Problems
+--------
+power consumption
+no consumer page support(bug?)
+no mouse wheel support
+no paring management
+no interactive auth method
+
+
+UART hardware flow control
+--------------------------
+(iWRAP4 User Guide 9.5)
+Hardware flow control is enabled by default and it should not be disabled unless mandatory, because without the hardware flow control the data transmission may not be reliable.
+If the hardware flow control is enabled from PS-keys, but no flow control is used, the following steps should be implemented in the hardware design:
+- CTS pin must be grounded
+- RTS pin must be left floating
+
+
+Power Saving
+------------
+power consume
+    without opimization: 4hr to shutdown(310mAh)
+    2011/08/25: 9hr(310mAh) SNIFF MASTER sleep/WDTO_120MS
+
+measure current consumption
+    HHKB keyswitch matrix board
+        idle
+        scanning
+    Bluegiga WT12 module
+        SLEEP command
+        deep sleep on/off in config bits
+
+HHKB keyswich
+    how to power off
+        I/O pin configuration when sleeping
+        FET switch for 5V regulator
+
+Bluetooth module
+    power off when in USB mode
+    power off by FET switch
+
+AVR configuration
+    unused pins
+    ADC
+    
+
+
+SET CONTROL CONFIG
+------------------
+    SET CONTROL CONFIG 4810
+    SET CONTROL CONFIG LIST
+    SET CONTROL CONFIG 0000 0000 4910 DEEP_SLEEP KLUDGE INTERACTIVE_PIN UART_LATENCY
+
+    Bit14   UART low latency
+    Bit11   Interactive pairing mode
+    Bit04   Deep sleep
+
+
+Reconnection
+------------
+SET CONTROL AUTOCALL 1124 5000 HID
+    1124    HID service class
+    5000    interval ms
+
+HID profile
+-----------
+This is needed to configure only once.
+    SET PROFILE HID ON
+    RESET
+
+HID class
+---------
+    SET BT CLASS 005C0  // keyboard/mouse combined devie
+
+Pairing Security
+----------------
+Secure Simple Pairing(SSP)
+    SET BT SSP 2 0  // Enables SSP for keyboard and Man-in-the-middle protection
+    SET BT SSP 3 0  // Enables SSP just works mode
+
+for keyboard with SSP
+    SET BT AUTH * 0000
+    SET BT SSP 2 0
+    SET CONTROL CONFIG 800
+    RESET
+
+for keyboard without SSP
+    SET BT AUTH * 0000
+    SET CONTROL CONFIG 800
+    RESET
+
+AUTH
+    AUTH xx:xx:xx:xx:xx:xx?         // Pairing request event
+    AUTH xx:xx:xx:xx:xx:xx  0000
+
+    SSP PASSKEY 78:dd:08:b7:e4:a2 ?
+    SSP PASSKEY 78:dd:08:b7:e4:a2 xxxxx
+    (SSP COMPLETE 78:dd:08:b7:e4:a2 HCI_ERROR_AUTH_FAIL     // failed)
+    RING 0 78:dd:08:b7:e4:a2 11 HID
+
+Connecton
+    RING xx:xx:xx:xx:xx:xx xx HID   // connection event
+
+    KILL xx:xx:xx:xx:xx:xx
+
+Mode
+----
+Command mode
+Data mode
+    Raw mode
+    (Simple mode         not for a real keyboard)
+
+Raw mode
+    Keyboard:
+    0x9f, length(10), 0xa1, 0x01, mods, 0x00, key1, key2, key3, key4, key5, key6
+
+    Mouse:
+    0x9f, length(5), 0xa1, 0x02, buttons, X, Y
+
+    Consumer page:
+    0x9f, length(5), 0xa1, 0x03, bitfield1, bitfield2, bitfield3
+
+    consumer page suage
+    Bitfield 1:
+        0x01 Volume Increment
+        0x02 Volume Decrement
+        0x04 Mute
+        0x08 Play/Pause
+        0x10 Scan Next Track
+        0x20 Scan Previous Track
+        0x40 Stop
+        0x80 Eject
+    Bitfield 2:
+        0x01 Email Reader
+        0x02 Application Control Search
+        0x04 AC Bookmarks
+        0x08 AC Home
+        0x10 AC Back
+        0x20 AC Forward
+        0x40 AC Stop
+        0x80 AC Refresh
+    Bitfield 3:
+        0x01 Application Launch Generic Consumer Control
+        0x02 AL Internet Browser
+        0x04 AL Calculator
+        0x08 AL Terminal Lock / Screensaver
+        0x10 AL Local Machine Browser
+        0x20 AC Minimize
+        0x40 Record
+        0x80 Rewind
+
+
+
+
+
+2011/07/13
+set
+SET BT BDADDR 00:07:80:47:22:14
+SET BT NAME HHKB pro BT
+SET BT CLASS 0005c0
+SET BT AUTH