diff options
Diffstat (limited to 'tmk_core/protocol/iwrap')
| -rw-r--r-- | tmk_core/protocol/iwrap/iWRAP4.txt | 376 | ||||
| -rw-r--r-- | tmk_core/protocol/iwrap/iWRAP5.txt | 356 | ||||
| -rw-r--r-- | tmk_core/protocol/iwrap/iwrap.c | 469 | ||||
| -rw-r--r-- | tmk_core/protocol/iwrap/iwrap.h | 49 | ||||
| -rw-r--r-- | tmk_core/protocol/iwrap/main.c | 376 | ||||
| -rw-r--r-- | tmk_core/protocol/iwrap/mux_exit.rb | 7 | ||||
| -rw-r--r-- | tmk_core/protocol/iwrap/suart.S | 156 | ||||
| -rw-r--r-- | tmk_core/protocol/iwrap/suart.h | 8 | ||||
| -rw-r--r-- | tmk_core/protocol/iwrap/wd.h | 159 |
9 files changed, 1956 insertions, 0 deletions
diff --git a/tmk_core/protocol/iwrap/iWRAP4.txt b/tmk_core/protocol/iwrap/iWRAP4.txt new file mode 100644 index 0000000000..2a062d9d98 --- /dev/null +++ b/tmk_core/protocol/iwrap/iWRAP4.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 * 0000 +SET BT IDENT BT:47 f000 4.1.0 Bluegiga iWRAP +SET BT LAP 9e8b33 +SET BT PAGEMODE 4 2000 1 +SET BT PAIR 78:dd:08:b7:e4:a2 a191189cd7e51030ad6a07848ce879bb +SET BT POWER 3 3 3 +SET BT ROLE 0 f 7d00 +SET BT SNIFF 0 20 1 8 +SET BT SSP 2 1 +SET BT MTU 667 +SET CONTROL AUTOCALL 1124 3000 HID +SET CONTROL BAUD 38400,8n1 +SET CONTROL CD 00 0 +SET CONTROL ECHO 7 +SET CONTROL ESCAPE 43 00 1 +SET CONTROL GAIN 0 5 +SET CONTROL INIT SET CONTROL MUX 0 +SET CONTROL MSC DTE 00 00 00 00 00 00 +SET CONTROL MUX 1 +SET CONTROL PIO 00 00 +SET CONTROL READY 00 +SET PROFILE HID f HID +SET + +info config + +!!! THIS IS BETA RELEASE AND MAY BE USED FOR EVALUATION PURPOSES ONLY !!! + +WRAP THOR AI (4.1.0 build 435) +Copyright (c) 2003-2011 Bluegiga Technologies Inc. +Compiled on Jun 28 2011 17:19:51, running on WT12-A module, psr v31 + AVRCP BGIO FTP HFP HFP_AG HID HID_CONSUMER_PAGE HSP LEDS MAP OTA PBAP PIO=0x00fc SSP SUBRATE TEST VOLUME + - BOCK3 version 435 (Jun 28 2011 17:19:37) (max acl/sco 7/1) + - Bluetooth version 2.1, Power class 2 + - Loader 4279, firmware 6297 (56-bit encryption), native execution mode + - up 0 days, 06:23, 2 connections (pool 2) + - User configuration: +&028a = 0001 0000 0000 0011 0024 0000 0000 0010 0000 0080 0000 0000 0080 005f 009b 0034 00fb 0006 +&028b = 0000 0bb8 +&028d = 0001 +&0295 = 0000 0005 000b 0000 0003 0000 0000 0000 0000 0000 0000 +&0298 = a006 +&0299 = 0000 0000 +&02a3 = 0030 0030 0030 0030 +&02a4 = 009d 0000 +&02a5 = 0053 0045 0054 0020 0043 004f 004e 0054 0052 004f 004c 0020 004d 0055 0058 0020 0030 +&02a7 = 0000 05c0 +&02a8 = 4910 0000 0000 +&02aa = 0004 2000 0001 0033 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 +&02ac = 0000 0000 002b 0000 0000 0000 0000 0000 0000 0000 0002 0000 0000 0000 0010 0000 0000 0000 0000 029b 0000 0000 0000 0000 +&02ad = 4848 424b 7020 6f72 4220 0054 +&02b3 = 0005 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 +&02b7 = 000f 4948 0044 +&02bb = 8000 +READY. + + + + +2011/07/07 settings: +set +SET BT BDADDR 00:07:80:47:22:14 +SET BT NAME HHKB Pro BT +SET BT CLASS 0005c0 +SET BT AUTH * 000 +SET BT IDENT BT:47 f000 4.0.0 Bluegiga iWRAP +SET BT LAP 9e8b33 +SET BT PAGEMODE 4 2000 1 +SET BT PAIR 78:dd:08:b7:e4:a2 9e54d0aabb1b4d73cfccddb1ea4ef2d6 +SET BT POWER 3 3 3 +SET BT ROLE 0 f 7d00 +SET BT SNIFF 0 20 1 8 +SET BT SSP 3 0 +SET BT MTU 667 +SET CONTROL BAUD 38400,8n1 +SET CONTROL CD 00 0 +SET CONTROL ECHO 7 +SET CONTROL ESCAPE 255 00 1 +SET CONTROL GAIN 0 5 +SET CONTROL INIT set control mux 0 +SET CONTROL MSC DTE 00 00 00 00 00 00 +SET CONTROL PREAMP 1 1 +SET CONTROL READY 00 +SET PROFILE HID HID +SET PROFILE SPP Bluetooth Serial Port +SET + +info config +WRAP THOR AI (4.0.0 build 317) +Copyright (c) 2003-2010 Bluegiga Technologies Inc. +Compiled on Apr 20 2010 16:44:28, running on WT12-A module, psr v31 + AVRCP FTP PBAP PIO=0x00fc SSP SUBRATE VOLUME + - BOCK3 version 317 (Apr 20 2010 16:44:21) (max acl/sco 7/1) + - Bluetooth version 2.1, Power class 2 + - Loader 4279, firmware 6297 (56-bit encryption), native execution mode + - up 0 days, 00:00, 0 connections (pool 1) + - User configuration: +&028c = 0001 0020 0000 0001 0008 0000 +&028d = 0000 +&0296 = 0047 0001 f000 0400 6c42 6575 6967 6167 6920 5257 5041 +&0298 = c006 +&02a3 = 0030 0030 0030 +&02a4 = 009d 0000 +&02a5 = 0073 0065 0074 0020 0063 006f 006e 0074 0072 006f 006c 0020 006d 0075 0078 0020 0030 +&02a7 = 0000 05c0 +&02a8 = 0800 0000 0000 +&02ac = 0000 0000 00ff 0000 0000 0000 0000 0000 0000 0000 0002 0000 0000 0000 0010 0000 0000 0000 0000 029b 0000 0000 0000 0000 +&02ad = 4848 424b 5020 6f72 4220 0054 +&02b3 = 0004 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 +&02b7 = 0000 +&02bb = 6c42 6575 6f74 746f 2068 6553 6972 6c61 5020 726f 0074 +READY. + + + +2011/08/23: +SET BT BDADDR 00:07:80:47:22:14 +SET BT NAME HHKB pro BT +SET BT CLASS 0005c0 +SET BT AUTH * 0000 +SET BT IDENT BT:47 f000 4.1.0 Bluegiga iWRAP +SET BT LAP 9e8b33 +SET BT PAGEMODE 4 2000 1 +SET BT PAIRCOUNT 4 +SET BT POWER 3 3 3 +SET BT ROLE 1 f 12c0 +SET BT SNIFF 10 2 1 8 +SET BT SSP 3 0 +SET BT MTU 667 +SET CONTROL BAUD 38400,8n1 +SET CONTROL CD 00 0 +SET CONTROL ECHO 7 +SET CONTROL ESCAPE 43 00 1 +SET CONTROL GAIN 0 5 +SET CONTROL INIT SET CONTROL MUX 0 +SET CONTROL MSC DTE 00 00 00 00 00 00 +SET CONTROL MUX 1 +SET CONTROL PIO 00 00 +SET CONTROL READY 00 +SET PROFILE HID 7 HIDKeyboardMouse +SET + +SET CONTROL CONFIG 0000 0004 481e CLOCK_CACHE INTERLACED_INQ INTERLACED_PAGE DEEP_SLEEP INTERACTIVE_PIN UART_LATENCY 23D_NOKLUDGE + + + +2011/08/25: +SET BT BDADDR 00:07:80:47:22:14 +SET BT NAME HHKB pro BT +SET BT CLASS 0005c0 + +SET BT IDENT BT:47 f000 4.1.0 Bluegiga iWRAP +SET BT LAP 9e8b33 +SET BT PAGEMODE 4 2000 1 +SET BT PAIRCOUNT 4 +SET BT PAIR 78:dd:08:b7:e4:a2 0be83335a03fed8ededae42e99554e28 +SET BT POWER 3 3 3 +SET BT ROLE 1 f 12c0 +SET BT SNIFF 100 20 1 8 +SET BT SSP 3 0 +SET BT MTU 667 +SET CONTROL BAUD 38400,8n1 +SET CONTROL CD 00 0 +SET CONTROL ECHO 7 +SET CONTROL ESCAPE - 20 1 +SET CONTROL GAIN 0 5 +SET CONTROL INIT SET CONTROL MUX 0 +SET CONTROL MSC DTE 00 00 00 00 00 00 +SET CONTROL MUX 1 +SET CONTROL PIO 00 00 +SET CONTROL READY 00 +SET PROFILE HID f HIDKeyboardMouse +SET + + +SET CONTROL CONFIG 0000 0000 490e CLOCK_CACHE INTERLACED_INQ INTERLACED_PAGE KLUDGE INTERACTIVE_PIN UART_LATENCY + + +2011/09/08: +SET CONTROL CONFIG 0000 0000 410e CLOCK_CACHE INTERLACED_INQ INTERLACED_PAGE KLUDGE UART_LATENCY + + Removed INTERACTIVE_PIN to avoid interactive auth and use SET BT AUTH pin(0000). + + +EOF diff --git a/tmk_core/protocol/iwrap/iWRAP5.txt b/tmk_core/protocol/iwrap/iWRAP5.txt new file mode 100644 index 0000000000..ce3310f1bf --- /dev/null +++ b/tmk_core/protocol/iwrap/iWRAP5.txt @@ -0,0 +1,356 @@ +Terminology +=========== +PSM +HIDP HID Protocol +L2CAP Logical Link Control Adaptation Protocol +MTU Maximum Transmission Unit + + + +HID Protocol +============ +3 of HID_SPEC_V11.pdf + +Channel +------- +Control channel PSM=0x0011 +Interrupt channel PSM=0x0013 + +Message +------- +HANDSHAKE(0) +HID_CONTROL(1) + +GET_REPORT(4) + Host requests report(DATA payload on Control channel) from Device + Size Desc + ------------------------------------------------------------------------------ + HIDP-Hdr 1 7..4: HIDP Message TYpe(4: GET_REPORT) + 3: Size(1:2-octed buffer size, 0:size of the report) + 2: 0 + 1..0: Report Type(1:input, 2:output, 3: feature) + ReportID 1 Optional + BufferSize 2 Optional(specified when Size=1) + +SET_REPORT(5) +GET_PROTOCOL(6) +SET_PROTOCOL(7) + +DATA(A) + Input/Output Report: All DATA payloads flow on Interrupt channel. + Other: flows on Control channel. + Size Desc + ------------------------------------------------------------------------------ + HIDP-Hdr 1 7..4 0xA + 3..2 Reserved(0) + 1..0 Report Type(0:Other, 1:Input, 2:Output, 3:Feature) + Payload N Data + + + + +Boot Protocol +============= +3.3.2 +No report descriptor, fixed report descriptors defined. + +Device ReportID Size +--------------------------------- +Reserved 0 +Keyboard 1 9octets +Mouse 2 4octets +Reserved 3-255 + +Report descriptor +----------------- +Report ID is added to USB HID boot protocol descriptor. +Boot Protocol device doesn't need to supply descriptors. and can send extra data on end of boot report this data will be ignored unless host supports report descriptor. + +Report Protocol devices can have specific descriptors. Using Boot protocol descriptor followed by extra data may be useful for compatibility to Boot protocol only supported host. + +NOTE: +Bluegiga HID sample say report ID of mouse is 1 but 2? +Bluegiga HID sample say report ID of consumer page is 2 but 3? +** mouse.desc and consumer.desc were fixed. + size +keyboard.desc 67 0x43 +mouse.desc 60 0x3c +consumer.desc 82 0x52 +combo.desc 209 0xd1 + + + +SDP +=== +attributes(3.3.2) +---------- +HIDDeviceSubclass + which type is supported in Boot Protocol Mode + 7 6 + --- + 0 1 Keyboard + 1 0 Pointing device + 1 1 Combo keyboard/pointing device + +HIDBootDevice + TRUE +HIDReconnectInitiate + TRUE + + +Class of Device/Service +======================= +http://phys.sci.hokudai.ac.jp/LABS/yts/pic/GB002/Bluetooth_assigned_numbers_baseband.pdf + +0x0005C0 Keyboard and Pointing deivce(combo) + + + 23 16 15 8 7 0 + --------------------------------- + Service |Major |Minor |Format + + Format type + 1 0 + --- + 0 0 + + Minor Device Class of Peripheral Major + 7 6 + --- + 0 1 Keyboard + 1 0 Pointing device + 1 1 Combo keyboard/pointing device + + + Major device classes + 12 11 10 9 8 + -------------- + 0 0 0 0 0 Miscellaneous + 0 0 0 0 1 Computer + 0 0 0 1 0 Phone + 0 0 0 1 1 LAN /Network Access point + 0 0 1 0 0 Audio/Video (headset,speaker,stereo, video display, vcr..... + 0 0 1 0 1 *Peripheral (mouse, joystick, keyboards, ..... ) + 0 0 1 1 0 Imaging (printing, scanner, camera, display, ...) + 1 1 1 1 1 Uncategorized, specific device code not specified + X X X X X All other values reserved + + + Major service classes + bit + -------------------------------------- + 13 Limited Discoverable Mode [Ref #1] + 14 (reserved) + 15 (reserved) + 16 Positioning (Location identification) + 17 Networking (LAN, Ad hoc, ...) + 18 Rendering (Printing, Speaker, ...) + 19 Capturing (Scanner, Microphone, ...) + 20 Object Transfer (v-Inbox, v-Folder, ...) + 21 Audio (Speaker, Microphone, Headset service, ...) + 22 Telephony (Cordless telephony, Modem, Headset service, ...) + 23 Information (WEB-server, WAP-server, ...) + + + + +Authentication SSP +------------------- +SET BT SSP 2 0 PASS KEY entering +SET BT SSP 3 0 NO PASS KEY entering +SET BT SSP <capabilities> <mitm> + <capabilities>: 0:display only 1:display+yes/no button 2:keyboard only 3:none +SET BT SSP 2 1 # 2:keyboard only 1:Man-in-the-middle protection is needed +SET BT SSP 2 0 # 2:keyboard only 0:Man-in-the-middle protection is not needed + + +SET BT SSP 2 1 + bond only if MITM protection is supported by host +SET BT SSP 2 0 + bond even if MITM protection is not supported by host + +On Windows 'Add device' causes SSP PASSKEY event on iWRAP + SSP PASSKEY 78:dd:08:b7:e4:a2 ? + +If device has display(0 or 1) this event occurs. User should be shown this code on the device. + SSP CONFIRM 78:dd:08:b7:e4:a2 517572 + + +SET BT SSP 3 0 + No input/output, No MITM protection. + Without procedure of authentication the divice is bond to host. + + +Connect +======= +CALL 78:dd:08:b7:e4:a2 11 HID + + +Setting +======== +Following settings need to be done before wiring into keyboard. +- UART speed: 38400bps(115200bps didn't work with software serial) +- No SSP procedure(without MITM protection) +- No Power Saving + +# clear pairing record and set default +SET BT PAIR * +SET RESET + +SET CONTROL INIT SET CONTROL MUX 0 +SET CONTROL BAUD 38400,8n1 +SET BT NAME TMK Blootooth WT12 +SET BT CLASS 0005c0 +SET BT AUTH * 0000 +SET BT SSP 3 0 +SET CONTROL CONFIG 4800 +SET PROFILE HID 0f c0 0100 00 en 0409 TMK Bluetooth keyboard(WT12) +SET PROFILE SPP + +# power saving? +SET BT SNIFF 100 20 1 8 + + +# Report Descriptor +# combo keyboard + mouse + consumer +HID SET d2 05010906a1010507850119e029e715002501750195088102950175088101950575010508850119012905910295017503910395067508150025650507190029658100c005010902a1010901a1008502050919012908150025017501950881020501093009311581257f750895028106093895018106050c0a380295018106c0c0050c0901a1018503050c1500250109e909ea09e209cd19b529b87501950881020a8a010a21020a2a021a23022a27027501950881020a83010a96010a92010a9e010a94010a060209b209b4750195088102c0 + + + +SET PROFILE HID +--------------- + SET PROFILE HID 0d c0 100 0 en 0409 HHKB pro Bluetooth keyboard + {function bit} uint8 + {subclass} uint8 + {version} uint16 + {country} uint8 + {BTlang} char[2] + {USBlang} uint16 + {name} string + + +SET BT CLASS +------------ + See Class of Device + composite device: keyboard and mouse + SET BT CLASS 005c0 + + + + + + +---------- +after setting +---------- +set +SET BT BDADDR 00:07:80:47:22:14 +SET BT NAME TMK Blootooth WT12 +SET BT CLASS 0005c0 +SET BT AUTH * 0000 +SET BT IDENT BT:47 f000 5.0.1 Bluegiga iWRAP +SET BT LAP 9e8b33 +SET BT PAGEMODE 4 2000 1 +SET BT PAIR 78:dd:08:b7:e4:a2 9e3d85c91bcae73fef8cc10bec18b42f +SET BT POWER 3 3 3 +SET BT ROLE 0 f 7d00 +SET BT SNIFF 0 20 1 8 +SET BT SSP 3 0 +SET BT MTU 667 +SET CONTROL BAUD 38400,8n1 +SET CONTROL CD 00 0 +SET CONTROL ECHO 7 +SET CONTROL ESCAPE 43 00 1 +SET CONTROL GAIN 0 5 +SET CONTROL INIT SET CONTROL MUX 0 +SET CONTROL MSC DTE 00 00 00 00 00 00 +SET CONTROL MUX 1 +SET CONTROL PIO 00 00 +SET CONTROL READY 00 +SET PROFILE HID 0f c0 0100 00 en 0409 TMK Bluetooth keyboard(WT12) +SET + +set control config list +SET CONTROL CONFIG 0000 0000 0000 4900 KLUDGE INTERACTIVE_PIN UART_LATENCY + + +info config +WRAP THOR AI (5.0.1 build 620) +Copyright (c) 2003-2012 Bluegiga Technologies Inc. +Compiled on Oct 1 2012 10:56:21, running on WT12-A module, psr v31 + BGIO FTP HFP HFP_AG HID HID_CONSUMER_PAGE HSP MAP MDP OTA PBAP PIO=0x00fc SSP SUBRATE TEST VOLUME + - BOCK4 version 620 (Oct 1 2012 10:56:03) (max acl/sco 7/1) + - Bluetooth version 3.0, Power class 2 + - Loader 8615, firmware 8825 (56-bit encryption), native execution mode + - up 0 days, 01:50, 2 connections (pool 2) + - User configuration: +&028d = 0001 +&0295 = 0000 0005 000b 0000 0003 0000 0000 0000 0000 0000 0000 +&0298 = c053 +&0299 = 0000 0000 +&02a3 = 0030 0030 0030 0030 +&02a4 = 009d 0000 +&02a5 = 0053 0045 0054 0020 0043 004f 004e 0054 0052 004f 004c 0020 004d 0055 0058 0020 0030 +&02a7 = 0000 05c0 +&02a8 = 0800 0000 0000 0000 +&02aa = 0004 2000 0001 0033 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 +&02ac = 0000 0000 002b 0000 0000 0000 0000 0000 0000 0000 0002 0000 0000 0000 0010 0000 0000 0000 0000 029b 0000 0000 0000 0000 +&02ad = 4d54 204b 6c42 6f6f 6f74 746f 2068 5457 3231 +&02b0 = fa65 b0aa 934a 077b a600 d1cc fe58 8dd5 +&02b3 = 0004 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0005 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0005 +&02b7 = 000f 00c0 0100 0000 0065 006e 0409 4d54 204b 6c42 6575 6f74 746f &02bb = 8000 +READY. +---------- + + + +----- +After 5.0.1 Firmware update +Firmware: ai-5.0.1-620-25b.bc4.dfu +PSR: wt12-a.ai-5.0.1-620-25b.psrf +----- +info config +WRAP THOR AI (5.0.1 build 620) +Copyright (c) 2003-2012 Bluegiga Technologies Inc. +Compiled on Oct 1 2012 10:56:21, running on WT12-A module, psr v31 + BGIO FTP HFP HFP_AG HID HID_CONSUMER_PAGE HSP MAP MDP OTA PBAP PIO=0x00fc SSP SUBRATE TEST VOLUME + - BOCK4 version 620 (Oct 1 2012 10:56:03) (max acl/sco 7/1) + - Bluetooth version 3.0, Power class 2 + - Loader 8615, firmware 8825 (56-bit encryption), native execution mode + - up 0 days, 00:03, 0 connections (pool 1) + - User configuration: +&0295 = 0000 0005 000b 0000 0003 0000 0000 0000 0000 0000 0000 +&0299 = 0000 0000 +&02aa = 0004 2000 0001 0033 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 +&02ac = 0000 0000 002b 0000 0000 0000 0000 0000 0000 0000 0002 0000 0000 0000 0010 0000 0000 0000 0000 029b 0000 0000 0000 0000 +&02ad = 5457 3231 412d +&02b0 = fa65 b0aa 934a 077b a600 d1cc fe58 8dd5 +READY. + +set +SET BT BDADDR 00:07:80:47:22:14 +SET BT NAME WT12-A +SET BT CLASS 001f00 +SET BT IDENT BT:47 f000 5.0.1 Bluegiga iWRAP +SET BT LAP 9e8b33 +SET BT PAGEMODE 4 2000 1 +SET BT PAIR 78:dd:08:b7:e4:a2 af18f81faa107e6dd068762ef921f48b +SET BT POWER 3 3 3 +SET BT ROLE 0 f 7d00 +SET BT SNIFF 0 20 1 8 +SET BT SSP 3 0 +SET BT MTU 667 +SET CONTROL BAUD 115200,8n1 +SET CONTROL CD 00 0 +SET CONTROL ECHO 7 +SET CONTROL ESCAPE 43 00 1 +SET CONTROL GAIN 0 5 +SET CONTROL MSC DTE 00 00 00 00 00 00 +SET CONTROL PIO 00 00 +SET CONTROL READY 00 +SET PROFILE SPP Bluetooth Serial Port +SET + +set control config list +SET CONTROL CONFIG 0000 0000 0000 0100 KLUDGE +--------- diff --git a/tmk_core/protocol/iwrap/iwrap.c b/tmk_core/protocol/iwrap/iwrap.c new file mode 100644 index 0000000000..6a404116a1 --- /dev/null +++ b/tmk_core/protocol/iwrap/iwrap.c @@ -0,0 +1,469 @@ +/* +Copyright 2011 Jun Wako <wakojun@gmail.com> + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see <http://www.gnu.org/licenses/>. +*/ + +/* host driver for Bulegiga iWRAP */ +/* Bluegiga BT12 + * Connections + * Hardware UART Software UART BlueTooth + * PC=====UART=======AVR=====SUART====iWRAP(BT12)-----------PC + * + * - Hardware UART for Debug Console to communicate iWRAP + * - Software UART for iWRAP control to send keyboard/mouse data + */ + +#include <stdint.h> +#include <string.h> +#include <avr/interrupt.h> +#include <util/delay.h> +#include "keycode.h" +#include "suart.h" +#include "uart.h" +#include "report.h" +#include "host_driver.h" +#include "iwrap.h" +#include "print.h" + + +/* iWRAP MUX mode utils. 3.10 HID raw mode(iWRAP_HID_Application_Note.pdf) */ +#define MUX_HEADER(LINK, LENGTH) do { \ + xmit(0xbf); /* SOF */ \ + xmit(LINK); /* Link */ \ + xmit(0x00); /* Flags */ \ + xmit(LENGTH); /* Length */ \ +} while (0) +#define MUX_FOOTER(LINK) xmit(LINK^0xff) + + +static uint8_t connected = 0; +//static uint8_t channel = 1; + +/* iWRAP buffer */ +#define MUX_BUF_SIZE 64 +static char buf[MUX_BUF_SIZE]; +static uint8_t snd_pos = 0; + +#define MUX_RCV_BUF_SIZE 256 +static char rcv_buf[MUX_RCV_BUF_SIZE]; +static uint8_t rcv_head = 0; +static uint8_t rcv_tail = 0; + + +/* receive buffer */ +static void rcv_enq(char c) +{ + uint8_t next = (rcv_head + 1) % MUX_RCV_BUF_SIZE; + if (next != rcv_tail) { + rcv_buf[rcv_head] = c; + rcv_head = next; + } +} + +static char rcv_deq(void) +{ + char c = 0; + if (rcv_head != rcv_tail) { + c = rcv_buf[rcv_tail++]; + rcv_tail %= MUX_RCV_BUF_SIZE; + } + return c; +} + +/* +static char rcv_peek(void) +{ + if (rcv_head == rcv_tail) + return 0; + return rcv_buf[rcv_tail]; +} +*/ + +static void rcv_clear(void) +{ + rcv_tail = rcv_head = 0; +} + +/* iWRAP response */ +ISR(PCINT1_vect, ISR_BLOCK) // recv() runs away in case of ISR_NOBLOCK +{ + if ((SUART_IN_PIN & (1<<SUART_IN_BIT))) + return; + + static volatile uint8_t mux_state = 0xff; + static volatile uint8_t mux_link = 0xff; + uint8_t c = recv(); + switch (mux_state) { + case 0xff: // SOF + if (c == 0xbf) + mux_state--; + break; + case 0xfe: // Link + mux_state--; + mux_link = c; + break; + case 0xfd: // Flags + mux_state--; + break; + case 0xfc: // Length + mux_state = c; + break; + case 0x00: + mux_state = 0xff; + mux_link = 0xff; + break; + default: + if (mux_state--) { + uart_putchar(c); + rcv_enq(c); + } + } +} + + +/*------------------------------------------------------------------* + * iWRAP communication + *------------------------------------------------------------------*/ +void iwrap_init(void) +{ + // reset iWRAP if in already MUX mode after AVR software-reset + iwrap_send("RESET"); + iwrap_mux_send("RESET"); + _delay_ms(3000); + iwrap_send("\r\nSET CONTROL MUX 1\r\n"); + _delay_ms(500); + iwrap_check_connection(); +} + +void iwrap_mux_send(const char *s) +{ + rcv_clear(); + MUX_HEADER(0xff, strlen((char *)s)); + iwrap_send(s); + MUX_FOOTER(0xff); +} + +void iwrap_send(const char *s) +{ + while (*s) + xmit(*s++); +} + +/* send buffer */ +void iwrap_buf_add(uint8_t c) +{ + // need space for '\0' + if (snd_pos < MUX_BUF_SIZE-1) + buf[snd_pos++] = c; +} + +void iwrap_buf_del(void) +{ + if (snd_pos) + snd_pos--; +} + +void iwrap_buf_send(void) +{ + buf[snd_pos] = '\0'; + snd_pos = 0; + iwrap_mux_send(buf); +} + +void iwrap_call(void) +{ + char *p; + + iwrap_mux_send("SET BT PAIR"); + _delay_ms(500); + + p = rcv_buf + rcv_tail; + while (!strncmp(p, "SET BT PAIR", 11)) { + p += 7; + strncpy(p, "CALL", 4); + strncpy(p+22, " 11 HID\n\0", 9); + print_S(p); + iwrap_mux_send(p); + // TODO: skip to next line + p += 57; + + DEBUG_LED_CONFIG; + DEBUG_LED_ON; + _delay_ms(500); + DEBUG_LED_OFF; + _delay_ms(500); + DEBUG_LED_ON; + _delay_ms(500); + DEBUG_LED_OFF; + _delay_ms(500); + DEBUG_LED_ON; + _delay_ms(500); + DEBUG_LED_OFF; + _delay_ms(500); + DEBUG_LED_ON; + _delay_ms(500); + DEBUG_LED_OFF; + _delay_ms(500); + DEBUG_LED_ON; + _delay_ms(500); + DEBUG_LED_OFF; + _delay_ms(500); + } + iwrap_check_connection(); +} + +void iwrap_kill(void) +{ + char c; + iwrap_mux_send("LIST"); + _delay_ms(500); + + while ((c = rcv_deq()) && c != '\n') ; + if (strncmp(rcv_buf + rcv_tail, "LIST ", 5)) { + print("no connection to kill.\n"); + return; + } + // skip 10 'space' chars + for (uint8_t i = 10; i; i--) + while ((c = rcv_deq()) && c != ' ') ; + + char *p = rcv_buf + rcv_tail - 5; + strncpy(p, "KILL ", 5); + strncpy(p + 22, "\n\0", 2); + print_S(p); + iwrap_mux_send(p); + _delay_ms(500); + + iwrap_check_connection(); +} + +void iwrap_unpair(void) +{ + iwrap_mux_send("SET BT PAIR"); + _delay_ms(500); + + char *p = rcv_buf + rcv_tail; + if (!strncmp(p, "SET BT PAIR", 11)) { + strncpy(p+29, "\n\0", 2); + print_S(p); + iwrap_mux_send(p); + } +} + +void iwrap_sleep(void) +{ + iwrap_mux_send("SLEEP"); +} + +void iwrap_sniff(void) +{ +} + +void iwrap_subrate(void) +{ +} + +bool iwrap_failed(void) +{ + if (strncmp(rcv_buf, "SYNTAX ERROR", 12)) + return true; + else + return false; +} + +uint8_t iwrap_connected(void) +{ + return connected; +} + +uint8_t iwrap_check_connection(void) +{ + iwrap_mux_send("LIST"); + _delay_ms(100); + + if (strncmp(rcv_buf, "LIST ", 5) || !strncmp(rcv_buf, "LIST 0", 6)) + connected = 0; + else + connected = 1; + return connected; +} + + +/*------------------------------------------------------------------* + * Host driver + *------------------------------------------------------------------*/ +static uint8_t keyboard_leds(void); +static void send_keyboard(report_keyboard_t *report); +static void send_mouse(report_mouse_t *report); +static void send_system(uint16_t data); +static void send_consumer(uint16_t data); + +static host_driver_t driver = { + keyboard_leds, + send_keyboard, + send_mouse, + send_system, + send_consumer +}; + +host_driver_t *iwrap_driver(void) +{ + return &driver; +} + +static uint8_t keyboard_leds(void) { + return 0; +} + +static void send_keyboard(report_keyboard_t *report) +{ + if (!iwrap_connected() && !iwrap_check_connection()) return; + MUX_HEADER(0x01, 0x0c); + // HID raw mode header + xmit(0x9f); + xmit(0x0a); // Length + xmit(0xa1); // DATA(Input) + xmit(0x01); // Report ID + xmit(report->mods); + xmit(0x00); // reserved byte(always 0) + xmit(report->keys[0]); + xmit(report->keys[1]); + xmit(report->keys[2]); + xmit(report->keys[3]); + xmit(report->keys[4]); + xmit(report->keys[5]); + MUX_FOOTER(0x01); +} + +static void send_mouse(report_mouse_t *report) +{ +#if defined(MOUSEKEY_ENABLE) || defined(PS2_MOUSE_ENABLE) + if (!iwrap_connected() && !iwrap_check_connection()) return; + MUX_HEADER(0x01, 0x09); + // HID raw mode header + xmit(0x9f); + xmit(0x07); // Length + xmit(0xa1); // DATA(Input) + xmit(0x02); // Report ID + xmit(report->buttons); + xmit(report->x); + xmit(report->y); + xmit(report->v); + xmit(report->h); + MUX_FOOTER(0x01); +#endif +} + +static void send_system(uint16_t data) +{ + /* not supported */ +} + +static void send_consumer(uint16_t data) +{ +#ifdef EXTRAKEY_ENABLE + static uint16_t last_data = 0; + uint8_t bits1 = 0; + uint8_t bits2 = 0; + uint8_t bits3 = 0; + + if (!iwrap_connected() && !iwrap_check_connection()) return; + if (data == last_data) return; + last_data = data; + + // 3.10 HID raw mode(iWRAP_HID_Application_Note.pdf) + switch (data) { + case AUDIO_VOL_UP: + bits1 = 0x01; |