mirror of
https://github.com/felis/USB_Host_Shield_2.0.git
synced 2024-03-22 11:31:26 +01:00
495 lines
11 KiB
C++
495 lines
11 KiB
C++
/* 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 : support@circuitsathome.com
|
|
*/
|
|
#if !defined(__HIDBOOT_H__)
|
|
#define __HIDBOOT_H__
|
|
|
|
#include <inttypes.h>
|
|
#include <avr/pgmspace.h>
|
|
#include "avrpins.h"
|
|
#include "max3421e.h"
|
|
#include "usbhost.h"
|
|
#include "usb_ch9.h"
|
|
#include "Usb.h"
|
|
#include "hid.h"
|
|
|
|
#if defined(ARDUINO) && ARDUINO >=100
|
|
#include "Arduino.h"
|
|
#else
|
|
#include <WProgram.h>
|
|
#endif
|
|
|
|
#include "printhex.h"
|
|
#include "hexdump.h"
|
|
#include "message.h"
|
|
|
|
#include "confdescparser.h"
|
|
|
|
#define KEY_SPACE 0x2c
|
|
#define KEY_ZERO 0x27
|
|
#define KEY_ZERO2 0x62
|
|
#define KEY_ENTER 0x28
|
|
#define KEY_PERIOD 0x63
|
|
|
|
struct MOUSEINFO
|
|
{
|
|
struct
|
|
{
|
|
uint8_t bmLeftButton : 1;
|
|
uint8_t bmRightButton : 1;
|
|
uint8_t bmMiddleButton : 1;
|
|
uint8_t bmDummy : 1;
|
|
};
|
|
int8_t dX;
|
|
int8_t dY;
|
|
};
|
|
|
|
class MouseReportParser : public HIDReportParser
|
|
{
|
|
union
|
|
{
|
|
MOUSEINFO mouseInfo;
|
|
uint8_t bInfo[3];
|
|
} prevState;
|
|
|
|
public:
|
|
virtual 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;
|
|
};
|
|
|
|
#define KEY_NUM_LOCK 0x53
|
|
#define KEY_CAPS_LOCK 0x39
|
|
#define KEY_SCROLL_LOCK 0x47
|
|
|
|
class KeyboardReportParser : public HIDReportParser
|
|
{
|
|
static const uint8_t numKeys[];
|
|
static const uint8_t symKeysUp[];
|
|
static const uint8_t symKeysLo[];
|
|
static const uint8_t padKeys[];
|
|
|
|
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; };
|
|
|
|
virtual void Parse(HID *hid, bool is_rpt_id, uint8_t len, uint8_t *buf);
|
|
|
|
protected:
|
|
uint8_t HandleLockingKeys(HID* hid, uint8_t key);
|
|
|
|
virtual void OnKeyDown (uint8_t mod, uint8_t key) {};
|
|
virtual void OnKeyUp (uint8_t mod, uint8_t key) {};
|
|
};
|
|
|
|
#define totalEndpoints 2
|
|
|
|
#define HID_MAX_HID_CLASS_DESCRIPTORS 5
|
|
|
|
template <const uint8_t BOOT_PROTOCOL>
|
|
class HIDBoot : public HID //public USBDeviceConfig, public UsbConfigXtracter
|
|
{
|
|
EpInfo epInfo[totalEndpoints];
|
|
|
|
HIDReportParser *pRptParser;
|
|
|
|
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
|
|
|
|
void Initialize();
|
|
|
|
virtual HIDReportParser* GetReportParser(uint8_t id) { return pRptParser; };
|
|
|
|
public:
|
|
HIDBoot(USB *p);
|
|
|
|
virtual bool SetReportParser(uint8_t id, HIDReportParser *prs) { pRptParser = prs; };
|
|
|
|
// USBDeviceConfig implementation
|
|
virtual uint8_t Init(uint8_t parent, uint8_t port, bool lowspeed);
|
|
virtual uint8_t Release();
|
|
virtual uint8_t Poll();
|
|
virtual uint8_t GetAddress() { return bAddress; };
|
|
|
|
// UsbConfigXtracter implementation
|
|
virtual void EndpointXtract(uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const USB_ENDPOINT_DESCRIPTOR *ep);
|
|
};
|
|
|
|
template <const uint8_t BOOT_PROTOCOL>
|
|
HIDBoot<BOOT_PROTOCOL>::HIDBoot(USB *p) :
|
|
HID(p),
|
|
qNextPollTime(0),
|
|
bPollEnable(false),
|
|
pRptParser(NULL)
|
|
{
|
|
Initialize();
|
|
|
|
if (pUsb)
|
|
pUsb->RegisterDeviceClass(this);
|
|
}
|
|
|
|
template <const uint8_t BOOT_PROTOCOL>
|
|
void HIDBoot<BOOT_PROTOCOL>::Initialize()
|
|
{
|
|
for(uint8_t i=0; i<totalEndpoints; 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");
|
|
|
|
if (bAddress)
|
|
return USB_ERROR_CLASS_INSTANCE_ALREADY_IN_USE;
|
|
|
|
// 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;
|
|
}
|
|
|
|
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;
|
|
|
|
// Assign epInfo to epinfo pointer
|
|
rcode = pUsb->setEpInfoEntry(bAddress, 1, epInfo);
|
|
|
|
if (rcode)
|
|
goto FailSetDevTblEntry;
|
|
|
|
//USBTRACE2("NC:", num_of_conf);
|
|
|
|
for (uint8_t i=0; i<num_of_conf; i++)
|
|
{
|
|
//HexDumper<USBReadParser, uint16_t, uint16_t> HexDump;
|
|
ConfigDescParser<
|
|
USB_CLASS_HID,
|
|
HID_BOOT_INTF_SUBCLASS,
|
|
BOOT_PROTOCOL,
|
|
CP_MASK_COMPARE_ALL> confDescrParser(this);
|
|
|
|
//rcode = pUsb->getConfDescr(bAddress, 0, i, &HexDump);
|
|
rcode = pUsb->getConfDescr(bAddress, 0, i, &confDescrParser);
|
|
|
|
if (bNumEP > 1)
|
|
break;
|
|
} // for
|
|
|
|
if (bNumEP < 2)
|
|
return USB_DEV_CONFIG_ERROR_DEVICE_NOT_SUPPORTED;
|
|
|
|
//USBTRACE2("\r\nbAddr:", bAddress);
|
|
//USBTRACE2("\r\nbNumEP:", bNumEP);
|
|
|
|
// Assign epInfo to epinfo pointer
|
|
rcode = pUsb->setEpInfoEntry(bAddress, bNumEP, epInfo);
|
|
|
|
//USBTRACE2("\r\nCnf:", bConfNum);
|
|
|
|
// Set Configuration Value
|
|
rcode = pUsb->setConf(bAddress, 0, bConfNum);
|
|
|
|
if (rcode)
|
|
goto FailSetConfDescr;
|
|
|
|
//USBTRACE2("\r\nIf:", bIfaceNum);
|
|
|
|
rcode = SetProtocol(bIfaceNum, HID_BOOT_PROTOCOL);
|
|
|
|
if (rcode)
|
|
goto FailSetProtocol;
|
|
|
|
if (BOOT_PROTOCOL == 1)
|
|
{
|
|
rcode = SetIdle(bIfaceNum, 0, 0);
|
|
|
|
if (rcode)
|
|
goto FailSetIdle;
|
|
}
|
|
USBTRACE("BM configured\r\n");
|
|
|
|
bPollEnable = true;
|
|
return 0;
|
|
|
|
FailGetDevDescr:
|
|
USBTRACE("getDevDescr:");
|
|
goto Fail;
|
|
|
|
FailSetDevTblEntry:
|
|
USBTRACE("setDevTblEn:");
|
|
goto Fail;
|
|
|
|
FailGetConfDescr:
|
|
USBTRACE("getConf:");
|
|
goto Fail;
|
|
|
|
FailSetProtocol:
|
|
USBTRACE("SetProto:");
|
|
goto Fail;
|
|
|
|
FailSetIdle:
|
|
USBTRACE("SetIdle:");
|
|
goto Fail;
|
|
|
|
FailSetConfDescr:
|
|
USBTRACE("setConf:");
|
|
goto Fail;
|
|
|
|
Fail:
|
|
Serial.println(rcode, HEX);
|
|
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 concidered.
|
|
if (bNumEP > 1 && conf != bConfNum)
|
|
return;
|
|
|
|
//ErrorMessage<uint8_t>(PSTR("\r\nConf.Val"), conf);
|
|
//ErrorMessage<uint8_t>(PSTR("Iface Num"), iface);
|
|
//ErrorMessage<uint8_t>(PSTR("Alt.Set"), alt);
|
|
|
|
bConfNum = conf;
|
|
bIfaceNum = iface;
|
|
|
|
uint8_t index;
|
|
|
|
if ((pep->bmAttributes & 0x03) == 3 && (pep->bEndpointAddress & 0x80) == 0x80)
|
|
{
|
|
index = epInterruptInIndex;
|
|
|
|
// Fill in the endpoint info structure
|
|
epInfo[index].epAddr = (pep->bEndpointAddress & 0x0F);
|
|
epInfo[index].maxPktSize = (uint8_t)pep->wMaxPacketSize;
|
|
epInfo[index].epAttribs = 0;
|
|
|
|
bNumEP ++;
|
|
|
|
//PrintEndpointDescriptor(pep);
|
|
}
|
|
}
|
|
|
|
|
|
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)
|
|
return 0;
|
|
|
|
if (qNextPollTime <= millis())
|
|
{
|
|
qNextPollTime = millis() + 10;
|
|
|
|
const uint8_t const_buff_len = 16;
|
|
uint8_t buf[const_buff_len];
|
|
|
|
uint16_t read = (uint16_t)epInfo[epInterruptInIndex].maxPktSize;
|
|
|
|
uint8_t rcode = pUsb->inTransfer(bAddress, epInfo[epInterruptInIndex].epAddr, &read, buf);
|
|
|
|
if (rcode)
|
|
{
|
|
if (rcode != hrNAK)
|
|
USBTRACE2("Poll:", rcode);
|
|
return rcode;
|
|
}
|
|
//for (uint8_t i=0; i<read; i++)
|
|
// PrintHex<uint8_t>(buf[i]);
|
|
//if (read)
|
|
// Serial.println("");
|
|
|
|
if (pRptParser)
|
|
pRptParser->Parse((HID*)this, 0, (uint8_t)read, buf);
|
|
}
|
|
return rcode;
|
|
}
|
|
|
|
|
|
#endif // __HIDBOOTMOUSE_H__
|