USBHostKeyboard.cpp

00001 /* mbed USBHost Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 #include "USBHostKeyboard.h"
00018 
00019 #if USBHOST_KEYBOARD
00020 
00021 static uint8_t keymap[4][0x39] = {
00022     { 0, 0, 0, 0, 'a', 'b' /*0x05*/,
00023       'c', 'd', 'e', 'f', 'g' /*0x0a*/,
00024       'h', 'i', 'j', 'k', 'l'/*0x0f*/,
00025       'm', 'n', 'o', 'p', 'q'/*0x14*/,
00026       'r', 's', 't', 'u', 'v'/*0x19*/,
00027       'w', 'x', 'y', 'z', '1'/*0x1E*/,
00028       '2', '3', '4', '5', '6'/*0x23*/,
00029       '7', '8', '9', '0', 0x0A /*enter*/, /*0x28*/
00030       0x1B /*escape*/, 0x08 /*backspace*/, 0x09/*tab*/, 0x20/*space*/, '-', /*0x2d*/
00031       '=', '[', ']', '\\', '#', /*0x32*/
00032       ';', '\'', 0, ',', '.', /*0x37*/
00033       '/'},
00034 
00035     /* CTRL MODIFIER */
00036     { 0, 0, 0, 0, 0, 0 /*0x05*/,
00037       0, 0, 0, 0, 0 /*0x0a*/,
00038       0, 0, 0, 0, 0/*0x0f*/,
00039       0, 0, 0, 0, 0/*0x14*/,
00040       0, 0, 0, 0, 0/*0x19*/,
00041       0, 0, 0, 0, 0/*0x1E*/,
00042       0, 0, 0, 0, 0/*0x23*/,
00043       0, 0, 0, 0, 0 /*enter*/, /*0x28*/
00044       0, 0, 0, 0, 0, /*0x2d*/
00045       0, 0, 0, 0, 0, /*0x32*/
00046       0, 0, 0, 0, 0, /*0x37*/
00047       0},
00048 
00049     /* SHIFT MODIFIER */
00050     { 0, 0, 0, 0, 'A', 'B' /*0x05*/,
00051       'C', 'D', 'E', 'F', 'G' /*0x0a*/,
00052       'H', 'I', 'J', 'K', 'L'/*0x0f*/,
00053       'M', 'N', 'O', 'P', 'Q'/*0x14*/,
00054       'R', 'S', 'T', 'U', 'V'/*0x19*/,
00055       'W', 'X', 'Y', 'Z', '!'/*0x1E*/,
00056       '@', '#', '$', '%', '^'/*0x23*/,
00057       '&', '*', '(', ')', 0, /*0x28*/
00058       0, 0, 0, 0, 0, /*0x2d*/
00059       '+', '{', '}', '|', '~', /*0x32*/
00060       ':', '"', 0, '<', '>', /*0x37*/
00061       '?'},
00062 
00063     /* ALT MODIFIER */
00064     { 0, 0, 0, 0, 0, 0 /*0x05*/,
00065       0, 0, 0, 0, 0 /*0x0a*/,
00066       0, 0, 0, 0, 0/*0x0f*/,
00067       0, 0, 0, 0, 0/*0x14*/,
00068       0, 0, 0, 0, 0/*0x19*/,
00069       0, 0, 0, 0, 0/*0x1E*/,
00070       0, 0, 0, 0, 0/*0x23*/,
00071       0, 0, 0, 0, 0 /*enter*/, /*0x28*/
00072       0, 0, 0, 0, 0, /*0x2d*/
00073       0, 0, 0, 0, 0, /*0x32*/
00074       0, 0, 0, 0, 0, /*0x37*/
00075       0}
00076 
00077 };
00078 
00079 
00080 USBHostKeyboard::USBHostKeyboard() {
00081     host = USBHost::getHostInst();
00082     init();
00083 
00084     report = host->getSafeMem(9);
00085 }
00086 
00087 USBHostKeyboard::~USBHostKeyboard()
00088 {
00089     if (report != NULL) {
00090         host->returnSafeMem(report);
00091         report = NULL;
00092     }
00093 }
00094 
00095 void USBHostKeyboard::init() {
00096     dev = NULL;
00097     int_in = NULL;
00098     report_id = 0;
00099     onKey = NULL;
00100     onKeyCode = NULL;
00101     dev_connected = false;
00102     keyboard_intf = -1;
00103     keyboard_device_found = false;
00104 }
00105 
00106 bool USBHostKeyboard::connected() {
00107     return dev_connected;
00108 }
00109 
00110 
00111 bool USBHostKeyboard::connect() {
00112 
00113     if (dev_connected) {
00114         return true;
00115     }
00116 
00117     for (uint8_t i = 0; i < MAX_DEVICE_CONNECTED; i++) {
00118         if ((dev = host->getDevice(i)) != NULL) {
00119 
00120             if (host->enumerate(dev, this))
00121                 break;
00122 
00123             if (keyboard_device_found) {
00124                 int_in = dev->getEndpoint(keyboard_intf, INTERRUPT_ENDPOINT, IN);
00125 
00126                 if (!int_in)
00127                     break;
00128 
00129                 USB_INFO("New Keyboard device: VID:%04x PID:%04x [dev: %p - intf: %d]", dev->getVid(), dev->getPid(), dev, keyboard_intf);
00130                 dev->setName("Keyboard", keyboard_intf);
00131                 host->registerDriver(dev, keyboard_intf, this, &USBHostKeyboard::init);
00132 
00133                 int_in->attach(this, &USBHostKeyboard::rxHandler);
00134                 host->interruptRead(dev, int_in, report, int_in->getSize(), false);
00135 
00136                 dev_connected = true;
00137                 return true;
00138             }
00139         }
00140     }
00141     init();
00142     return false;
00143 }
00144 
00145 void USBHostKeyboard::rxHandler() {
00146     int len = int_in->getLengthTransferred();
00147     int index = (len == 9) ? 1 : 0;
00148     int len_listen = int_in->getSize();
00149     uint8_t key = 0;
00150     if (len == 8 || len == 9) {
00151         uint8_t modifier = (report[index] == 4) ? 3 : report[index];
00152         len_listen = len;
00153         
00154         // Original code gives 
00155         //  0 - no modifier
00156         //  1 - CTRL pressed
00157         // 32 - SHIFT pressed
00158         //  3 - ALT pressed
00159         //  8 - WIN pressed
00160         // 64 - ALT GR pressed
00161         //
00162         // The keymap at the top of this file only really support
00163         // "no" and SHIFT but SHIFT is at index 2 so it must be modified
00164         // to avoid reading out of bounds. Also block all modifiers >= 4
00165         // as those will be out of bounds.
00166         if (modifier == 32) {
00167             modifier = 2;
00168         }
00169         if (modifier < 4) {
00170             key = keymap[modifier][report[index + 2]];
00171             if (key && onKey) {
00172                 (*onKey)(key);
00173             }
00174         }
00175         if ((report[index + 2] || modifier) && onKeyCode) {
00176             (*onKeyCode)(report[index + 2], modifier);
00177         }
00178     }
00179     if (dev && int_in) {
00180         host->interruptRead(dev, int_in, report, len_listen, false);
00181     }
00182 }
00183 
00184 /*virtual*/ void USBHostKeyboard::setVidPid(uint16_t vid, uint16_t pid)
00185 {
00186     // we don't check VID/PID for keyboard driver
00187 }
00188 
00189 /*virtual*/ bool USBHostKeyboard::parseInterface(uint8_t intf_nb, uint8_t intf_class, uint8_t intf_subclass, uint8_t intf_protocol) //Must return true if the interface should be parsed
00190 {
00191     if ((keyboard_intf == -1) &&
00192         (intf_class == HID_CLASS) &&
00193         (intf_subclass == 0x01) &&
00194         (intf_protocol == 0x01)) {
00195         keyboard_intf = intf_nb;
00196         return true;
00197     }
00198     return false;
00199 }
00200 
00201 /*virtual*/ bool USBHostKeyboard::useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir) //Must return true if the endpoint will be used
00202 {
00203     if (intf_nb == keyboard_intf) {
00204         if (type == INTERRUPT_ENDPOINT && dir == IN) {
00205             keyboard_device_found = true;
00206             return true;
00207         }
00208     }
00209     return false;
00210 }
00211 
00212 #endif