|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618 |
- /* Copyright (C) 2011 Circuits At Home, LTD. All rights reserved.
-
- This software may be distributed and modified under the terms of the GNU
- General Public License version 2 (GPL2) as published by the Free Software
- Foundation and appearing in the file GPL2.TXT included in the packaging of
- this file. Please note that GPL2 Section 2[b] requires that all works based
- on this software must also be made publicly available under the terms of
- the GPL2 ("Copyleft").
-
- Contact information
- -------------------
-
- Circuits At Home, LTD
- Web : http://www.circuitsathome.com
- e-mail : [email protected]
- */
- #if !defined(__HIDBOOT_H__)
- #define __HIDBOOT_H__
-
- #include "hid.h"
-
- #define UHS_HID_BOOT_KEY_ZERO 0x27
- #define UHS_HID_BOOT_KEY_ENTER 0x28
- #define UHS_HID_BOOT_KEY_SPACE 0x2c
- #define UHS_HID_BOOT_KEY_CAPS_LOCK 0x39
- #define UHS_HID_BOOT_KEY_SCROLL_LOCK 0x47
- #define UHS_HID_BOOT_KEY_NUM_LOCK 0x53
- #define UHS_HID_BOOT_KEY_ZERO2 0x62
- #define UHS_HID_BOOT_KEY_PERIOD 0x63
-
- // Don't worry, GCC will optimize the result to a final value.
- #define bitsEndpoints(p) ((((p) & HID_PROTOCOL_KEYBOARD)? 2 : 0) | (((p) & HID_PROTOCOL_MOUSE)? 1 : 0))
- #define totalEndpoints(p) ((bitsEndpoints(p) == 3) ? 3 : 2)
- #define epMUL(p) ((((p) & HID_PROTOCOL_KEYBOARD)? 1 : 0) + (((p) & HID_PROTOCOL_MOUSE)? 1 : 0))
-
- // Already defined in hid.h
- // #define HID_MAX_HID_CLASS_DESCRIPTORS 5
-
- struct MOUSEINFO {
-
- struct {
- uint8_t bmLeftButton : 1;
- uint8_t bmRightButton : 1;
- uint8_t bmMiddleButton : 1;
- uint8_t bmDummy : 5;
- };
- int8_t dX;
- int8_t dY;
- };
-
- class MouseReportParser : public HIDReportParser {
-
- union {
- MOUSEINFO mouseInfo;
- uint8_t bInfo[sizeof (MOUSEINFO)];
- } prevState;
-
- public:
- void Parse(HID *hid, bool is_rpt_id, uint8_t len, uint8_t *buf);
-
- protected:
-
- virtual void OnMouseMove(MOUSEINFO *mi) {
- };
-
- virtual void OnLeftButtonUp(MOUSEINFO *mi) {
- };
-
- virtual void OnLeftButtonDown(MOUSEINFO *mi) {
- };
-
- virtual void OnRightButtonUp(MOUSEINFO *mi) {
- };
-
- virtual void OnRightButtonDown(MOUSEINFO *mi) {
- };
-
- virtual void OnMiddleButtonUp(MOUSEINFO *mi) {
- };
-
- virtual void OnMiddleButtonDown(MOUSEINFO *mi) {
- };
- };
-
- struct MODIFIERKEYS {
- uint8_t bmLeftCtrl : 1;
- uint8_t bmLeftShift : 1;
- uint8_t bmLeftAlt : 1;
- uint8_t bmLeftGUI : 1;
- uint8_t bmRightCtrl : 1;
- uint8_t bmRightShift : 1;
- uint8_t bmRightAlt : 1;
- uint8_t bmRightGUI : 1;
- };
-
- struct KBDINFO {
-
- struct {
- uint8_t bmLeftCtrl : 1;
- uint8_t bmLeftShift : 1;
- uint8_t bmLeftAlt : 1;
- uint8_t bmLeftGUI : 1;
- uint8_t bmRightCtrl : 1;
- uint8_t bmRightShift : 1;
- uint8_t bmRightAlt : 1;
- uint8_t bmRightGUI : 1;
- };
- uint8_t bReserved;
- uint8_t Keys[6];
- };
-
- struct KBDLEDS {
- uint8_t bmNumLock : 1;
- uint8_t bmCapsLock : 1;
- uint8_t bmScrollLock : 1;
- uint8_t bmCompose : 1;
- uint8_t bmKana : 1;
- uint8_t bmReserved : 3;
- };
-
- class KeyboardReportParser : public HIDReportParser {
- static const uint8_t numKeys[10];
- static const uint8_t symKeysUp[12];
- static const uint8_t symKeysLo[12];
- static const uint8_t padKeys[5];
-
- protected:
-
- union {
- KBDINFO kbdInfo;
- uint8_t bInfo[sizeof (KBDINFO)];
- } prevState;
-
- union {
- KBDLEDS kbdLeds;
- uint8_t bLeds;
- } kbdLockingKeys;
-
- uint8_t OemToAscii(uint8_t mod, uint8_t key);
-
- public:
-
- KeyboardReportParser() {
- kbdLockingKeys.bLeds = 0;
- };
-
- void Parse(HID *hid, bool is_rpt_id, uint8_t len, uint8_t *buf);
-
- protected:
-
- virtual uint8_t HandleLockingKeys(HID* hid, uint8_t key) {
- uint8_t old_keys = kbdLockingKeys.bLeds;
-
- switch(key) {
- case UHS_HID_BOOT_KEY_NUM_LOCK:
- kbdLockingKeys.kbdLeds.bmNumLock = ~kbdLockingKeys.kbdLeds.bmNumLock;
- break;
- case UHS_HID_BOOT_KEY_CAPS_LOCK:
- kbdLockingKeys.kbdLeds.bmCapsLock = ~kbdLockingKeys.kbdLeds.bmCapsLock;
- break;
- case UHS_HID_BOOT_KEY_SCROLL_LOCK:
- kbdLockingKeys.kbdLeds.bmScrollLock = ~kbdLockingKeys.kbdLeds.bmScrollLock;
- break;
- }
-
- if(old_keys != kbdLockingKeys.bLeds && hid)
- return (hid->SetReport(0, 0/*hid->GetIface()*/, 2, 0, 1, &kbdLockingKeys.bLeds));
-
- return 0;
- };
-
- virtual void OnControlKeysChanged(uint8_t before, uint8_t after) {
- };
-
- virtual void OnKeyDown(uint8_t mod, uint8_t key) {
- };
-
- virtual void OnKeyUp(uint8_t mod, uint8_t key) {
- };
-
- virtual const uint8_t *getNumKeys() {
- return numKeys;
- };
-
- virtual const uint8_t *getSymKeysUp() {
- return symKeysUp;
- };
-
- virtual const uint8_t *getSymKeysLo() {
- return symKeysLo;
- };
-
- virtual const uint8_t *getPadKeys() {
- return padKeys;
- };
- };
-
- template <const uint8_t BOOT_PROTOCOL>
- class HIDBoot : public HID //public USBDeviceConfig, public UsbConfigXtracter
- {
- EpInfo epInfo[totalEndpoints(BOOT_PROTOCOL)];
- HIDReportParser *pRptParser[epMUL(BOOT_PROTOCOL)];
-
- uint8_t bConfNum; // configuration number
- uint8_t bIfaceNum; // Interface Number
- uint8_t bNumIface; // number of interfaces in the configuration
- uint8_t bNumEP; // total number of EP in the configuration
- uint32_t qNextPollTime; // next poll time
- bool bPollEnable; // poll enable flag
- uint8_t bInterval; // largest interval
-
- void Initialize();
-
- virtual HIDReportParser* GetReportParser(uint8_t id) {
- return pRptParser[id];
- };
-
- public:
- HIDBoot(USB *p);
-
- virtual bool SetReportParser(uint8_t id, HIDReportParser *prs) {
- pRptParser[id] = prs;
- return true;
- };
-
- // USBDeviceConfig implementation
- uint8_t Init(uint8_t parent, uint8_t port, bool lowspeed);
- uint8_t Release();
- uint8_t Poll();
-
- virtual uint8_t GetAddress() {
- return bAddress;
- };
-
- virtual bool isReady() {
- return bPollEnable;
- };
-
- // UsbConfigXtracter implementation
- // Method should be defined here if virtual.
- virtual void EndpointXtract(uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const USB_ENDPOINT_DESCRIPTOR *ep);
-
- virtual bool DEVCLASSOK(uint8_t klass) {
- return (klass == USB_CLASS_HID);
- }
-
- virtual bool DEVSUBCLASSOK(uint8_t subklass) {
- return (subklass == BOOT_PROTOCOL);
- }
- };
-
- template <const uint8_t BOOT_PROTOCOL>
- HIDBoot<BOOT_PROTOCOL>::HIDBoot(USB *p) :
- HID(p),
- qNextPollTime(0),
- bPollEnable(false) {
- Initialize();
-
- for(int i = 0; i < epMUL(BOOT_PROTOCOL); i++) {
- pRptParser[i] = NULL;
- }
- if(pUsb)
- pUsb->RegisterDeviceClass(this);
- }
-
- template <const uint8_t BOOT_PROTOCOL>
- void HIDBoot<BOOT_PROTOCOL>::Initialize() {
- for(int i = 0; i < totalEndpoints(BOOT_PROTOCOL); i++) {
- epInfo[i].epAddr = 0;
- epInfo[i].maxPktSize = (i) ? 0 : 8;
- epInfo[i].epAttribs = 0;
- epInfo[i].bmNakPower = (i) ? USB_NAK_NOWAIT : USB_NAK_MAX_POWER;
- }
- bNumEP = 1;
- bNumIface = 0;
- bConfNum = 0;
- }
-
- template <const uint8_t BOOT_PROTOCOL>
- uint8_t HIDBoot<BOOT_PROTOCOL>::Init(uint8_t parent, uint8_t port, bool lowspeed) {
- const uint8_t constBufSize = sizeof (USB_DEVICE_DESCRIPTOR);
-
- uint8_t buf[constBufSize];
- uint8_t rcode;
- UsbDevice *p = NULL;
- EpInfo *oldep_ptr = NULL;
- uint8_t len = 0;
- //uint16_t cd_len = 0;
-
- uint8_t num_of_conf; // number of configurations
- //uint8_t num_of_intf; // number of interfaces
-
- AddressPool &addrPool = pUsb->GetAddressPool();
-
- USBTRACE("BM Init\r\n");
- //USBTRACE2("totalEndpoints:", (uint8_t) (totalEndpoints(BOOT_PROTOCOL)));
- //USBTRACE2("epMUL:", epMUL(BOOT_PROTOCOL));
-
- if(bAddress)
- return USB_ERROR_CLASS_INSTANCE_ALREADY_IN_USE;
-
- bInterval = 0;
- // Get pointer to pseudo device with address 0 assigned
- p = addrPool.GetUsbDevicePtr(0);
-
- if(!p)
- return USB_ERROR_ADDRESS_NOT_FOUND_IN_POOL;
-
- if(!p->epinfo) {
- USBTRACE("epinfo\r\n");
- return USB_ERROR_EPINFO_IS_NULL;
- }
-
- // Save old pointer to EP_RECORD of address 0
- oldep_ptr = p->epinfo;
-
- // Temporary assign new pointer to epInfo to p->epinfo in order to avoid toggle inconsistence
- p->epinfo = epInfo;
-
- p->lowspeed = lowspeed;
-
- // Get device descriptor
- rcode = pUsb->getDevDescr(0, 0, 8, (uint8_t*)buf);
-
- if(!rcode)
- len = (buf[0] > constBufSize) ? constBufSize : buf[0];
-
- if(rcode) {
- // Restore p->epinfo
- p->epinfo = oldep_ptr;
-
- goto FailGetDevDescr;
- }
-
- // Restore p->epinfo
- p->epinfo = oldep_ptr;
-
- // Allocate new address according to device class
- bAddress = addrPool.AllocAddress(parent, false, port);
-
- if(!bAddress)
- return USB_ERROR_OUT_OF_ADDRESS_SPACE_IN_POOL;
-
- // Extract Max Packet Size from the device descriptor
- epInfo[0].maxPktSize = (uint8_t)((USB_DEVICE_DESCRIPTOR*)buf)->bMaxPacketSize0;
-
- // Assign new address to the device
- rcode = pUsb->setAddr(0, 0, bAddress);
-
- if(rcode) {
- p->lowspeed = false;
- addrPool.FreeAddress(bAddress);
- bAddress = 0;
- USBTRACE2("setAddr:", rcode);
- return rcode;
- }
- //delay(2); //per USB 2.0 sect.9.2.6.3
-
- USBTRACE2("Addr:", bAddress);
-
- p->lowspeed = false;
-
- p = addrPool.GetUsbDevicePtr(bAddress);
-
- if(!p)
- return USB_ERROR_ADDRESS_NOT_FOUND_IN_POOL;
-
- p->lowspeed = lowspeed;
-
- if(len)
- rcode = pUsb->getDevDescr(bAddress, 0, len, (uint8_t*)buf);
-
- if(rcode)
- goto FailGetDevDescr;
-
- num_of_conf = ((USB_DEVICE_DESCRIPTOR*)buf)->bNumConfigurations;
-
- USBTRACE2("NC:", num_of_conf);
-
- // GCC will optimize unused stuff away.
- if((BOOT_PROTOCOL & (HID_PROTOCOL_KEYBOARD | HID_PROTOCOL_MOUSE)) == (HID_PROTOCOL_KEYBOARD | HID_PROTOCOL_MOUSE)) {
- USBTRACE("HID_PROTOCOL_KEYBOARD AND MOUSE\r\n");
- ConfigDescParser<
- USB_CLASS_HID,
- HID_BOOT_INTF_SUBCLASS,
- HID_PROTOCOL_KEYBOARD | HID_PROTOCOL_MOUSE,
- CP_MASK_COMPARE_ALL > confDescrParser(this);
- confDescrParser.SetOR(); // Use the OR variant.
- for(uint8_t i = 0; i < num_of_conf; i++) {
- pUsb->getConfDescr(bAddress, 0, i, &confDescrParser);
- if(bNumEP == (uint8_t)(totalEndpoints(BOOT_PROTOCOL)))
- break;
- }
- } else {
- // GCC will optimize unused stuff away.
- if(BOOT_PROTOCOL & HID_PROTOCOL_KEYBOARD) {
- USBTRACE("HID_PROTOCOL_KEYBOARD\r\n");
- for(uint8_t i = 0; i < num_of_conf; i++) {
- ConfigDescParser<
- USB_CLASS_HID,
- HID_BOOT_INTF_SUBCLASS,
- HID_PROTOCOL_KEYBOARD,
- CP_MASK_COMPARE_ALL> confDescrParserA(this);
-
- pUsb->getConfDescr(bAddress, 0, i, &confDescrParserA);
- if(bNumEP == (uint8_t)(totalEndpoints(BOOT_PROTOCOL)))
- break;
- }
- }
-
- // GCC will optimize unused stuff away.
- if(BOOT_PROTOCOL & HID_PROTOCOL_MOUSE) {
- USBTRACE("HID_PROTOCOL_MOUSE\r\n");
- for(uint8_t i = 0; i < num_of_conf; i++) {
- ConfigDescParser<
- USB_CLASS_HID,
- HID_BOOT_INTF_SUBCLASS,
- HID_PROTOCOL_MOUSE,
- CP_MASK_COMPARE_ALL> confDescrParserB(this);
-
- pUsb->getConfDescr(bAddress, 0, i, &confDescrParserB);
- if(bNumEP == ((uint8_t)(totalEndpoints(BOOT_PROTOCOL))))
- break;
-
- }
- }
- }
- USBTRACE2("bNumEP:", bNumEP);
-
- if(bNumEP != (uint8_t)(totalEndpoints(BOOT_PROTOCOL))) {
- rcode = USB_DEV_CONFIG_ERROR_DEVICE_NOT_SUPPORTED;
- goto Fail;
- }
-
- // Assign epInfo to epinfo pointer
- rcode = pUsb->setEpInfoEntry(bAddress, bNumEP, epInfo);
- //USBTRACE2("setEpInfoEntry returned ", rcode);
- USBTRACE2("Cnf:", bConfNum);
-
- delay(1000);
-
- // Set Configuration Value
- rcode = pUsb->setConf(bAddress, 0, bConfNum);
-
- if(rcode)
- goto FailSetConfDescr;
-
- delay(1000);
-
- USBTRACE2("bIfaceNum:", bIfaceNum);
- USBTRACE2("bNumIface:", bNumIface);
-
- // Yes, mouse wants SetProtocol and SetIdle too!
- for(uint8_t i = 0; i < epMUL(BOOT_PROTOCOL); i++) {
- USBTRACE2("\r\nInterface:", i);
- rcode = SetProtocol(i, HID_BOOT_PROTOCOL);
- if(rcode) goto FailSetProtocol;
- USBTRACE2("PROTOCOL SET HID_BOOT rcode:", rcode);
- rcode = SetIdle(i, 0, 0);
- USBTRACE2("SET_IDLE rcode:", rcode);
- // if(rcode) goto FailSetIdle; This can fail.
- // Get the RPIPE and just throw it away.
- SinkParser<USBReadParser, uint16_t, uint16_t> sink;
- rcode = GetReportDescr(i, &sink);
- USBTRACE2("RPIPE rcode:", rcode);
- }
-
- // Get RPIPE and throw it away.
-
- if(BOOT_PROTOCOL & HID_PROTOCOL_KEYBOARD) {
- // Wake keyboard interface by twinkling up to 5 LEDs that are in the spec.
- // kana, compose, scroll, caps, num
- rcode = 0x20; // Reuse rcode.
- while(rcode) {
- rcode >>= 1;
- // Ignore any error returned, we don't care if LED is not supported
- SetReport(0, 0, 2, 0, 1, &rcode); // Eventually becomes zero (All off)
- delay(25);
- }
- }
- USBTRACE("BM configured\r\n");
-
- bPollEnable = true;
- return 0;
-
- FailGetDevDescr:
- #ifdef DEBUG_USB_HOST
- NotifyFailGetDevDescr();
- goto Fail;
- #endif
-
- //FailSetDevTblEntry:
- //#ifdef DEBUG_USB_HOST
- // NotifyFailSetDevTblEntry();
- // goto Fail;
- //#endif
-
- //FailGetConfDescr:
- //#ifdef DEBUG_USB_HOST
- // NotifyFailGetConfDescr();
- // goto Fail;
- //#endif
-
- FailSetConfDescr:
- #ifdef DEBUG_USB_HOST
- NotifyFailSetConfDescr();
- goto Fail;
- #endif
-
- FailSetProtocol:
- #ifdef DEBUG_USB_HOST
- USBTRACE("SetProto:");
- goto Fail;
- #endif
-
- //FailSetIdle:
- //#ifdef DEBUG_USB_HOST
- // USBTRACE("SetIdle:");
- //#endif
-
- Fail:
- #ifdef DEBUG_USB_HOST
- NotifyFail(rcode);
- #endif
- Release();
-
- return rcode;
- }
-
- template <const uint8_t BOOT_PROTOCOL>
- void HIDBoot<BOOT_PROTOCOL>::EndpointXtract(uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const USB_ENDPOINT_DESCRIPTOR *pep) {
-
- // If the first configuration satisfies, the others are not considered.
- //if(bNumEP > 1 && conf != bConfNum)
- if(bNumEP == totalEndpoints(BOOT_PROTOCOL))
- return;
-
- bConfNum = conf;
- bIfaceNum = iface;
-
- if((pep->bmAttributes & 0x03) == 3 && (pep->bEndpointAddress & 0x80) == 0x80) {
- if(pep->bInterval > bInterval) bInterval = pep->bInterval;
-
- // Fill in the endpoint info structure
- epInfo[bNumEP].epAddr = (pep->bEndpointAddress & 0x0F);
- epInfo[bNumEP].maxPktSize = (uint8_t)pep->wMaxPacketSize;
- epInfo[bNumEP].epAttribs = 0;
- epInfo[bNumEP].bmNakPower = USB_NAK_NOWAIT;
- bNumEP++;
-
- }
- }
-
- template <const uint8_t BOOT_PROTOCOL>
- uint8_t HIDBoot<BOOT_PROTOCOL>::Release() {
- pUsb->GetAddressPool().FreeAddress(bAddress);
-
- bConfNum = 0;
- bIfaceNum = 0;
- bNumEP = 1;
- bAddress = 0;
- qNextPollTime = 0;
- bPollEnable = false;
-
- return 0;
- }
-
- template <const uint8_t BOOT_PROTOCOL>
- uint8_t HIDBoot<BOOT_PROTOCOL>::Poll() {
- uint8_t rcode = 0;
-
- if(bPollEnable && ((long)(millis() - qNextPollTime) >= 0L)) {
-
- // To-do: optimize manually, using the for loop only if needed.
- for(int i = 0; i < epMUL(BOOT_PROTOCOL); i++) {
- const uint16_t const_buff_len = 16;
- uint8_t buf[const_buff_len];
-
- USBTRACE3("(hidboot.h) i=", i, 0x81);
- USBTRACE3("(hidboot.h) epInfo[epInterruptInIndex + i].epAddr=", epInfo[epInterruptInIndex + i].epAddr, 0x81);
- USBTRACE3("(hidboot.h) epInfo[epInterruptInIndex + i].maxPktSize=", epInfo[epInterruptInIndex + i].maxPktSize, 0x81);
- uint16_t read = (uint16_t)epInfo[epInterruptInIndex + i].maxPktSize;
-
- rcode = pUsb->inTransfer(bAddress, epInfo[epInterruptInIndex + i].epAddr, &read, buf);
- // SOME buggy dongles report extra keys (like sleep) using a 2 byte packet on the wrong endpoint.
- // Since keyboard and mice must report at least 3 bytes, we ignore the extra data.
- if(!rcode && read > 2) {
- if(pRptParser[i])
- pRptParser[i]->Parse((HID*)this, 0, (uint8_t)read, buf);
- #ifdef DEBUG_USB_HOST
- // We really don't care about errors and anomalies unless we are debugging.
- } else {
- if(rcode != hrNAK) {
- USBTRACE3("(hidboot.h) Poll:", rcode, 0x81);
- }
- if(!rcode && read) {
- USBTRACE3("(hidboot.h) Strange read count: ", read, 0x80);
- USBTRACE3("(hidboot.h) Interface:", i, 0x80);
- }
- }
-
- if(!rcode && read && (UsbDEBUGlvl > 0x7f)) {
- for(uint8_t i = 0; i < read; i++) {
- PrintHex<uint8_t > (buf[i], 0x80);
- USBTRACE1(" ", 0x80);
- }
- if(read)
- USBTRACE1("\r\n", 0x80);
- #endif
- }
-
- }
- qNextPollTime = millis() + bInterval;
- }
- return rcode;
- }
-
- #endif // __HIDBOOTMOUSE_H__
|