/********************************************************************
Function:
void USBCheckVendorRequest(void)
Summary:
This routine handles vendor class specific requests that happen on EP0.
This function should be called from the USBCBCheckOtherReq() call back
function whenever implementing a custom/vendor class device.
Description:
This routine handles vendor specific requests that may arrive on EP0 as
a control transfer. These can include, but are not necessarily
limited to, requests for Microsft specific OS feature descriptor(s).
This function should be called from the USBCBCheckOtherReq() call back
function whenever using a vendor class device.
Typical Usage:
<code>
void USBCBCheckOtherReq(void)
{
//Since the stack didn't handle the request I need to check
// my class drivers to see if it is for them
USBCheckVendorRequest();
}
</code>
PreCondition:
None
Parameters:
Although this function has a void input, this handler function will
typically need to look at the 8-byte SETUP packet contents that the
host just sent, which may contain the vendor class specific request.
Therefore, the statically allocated SetupPkt structure may be looked
at while in the context of this function, and it will contain the most
recently received 8-byte SETUP packet data.
Return Values:
None
Remarks:
This function normally gets called within the same context as the
USBDeviceTasks() function, just after a new control transfer request
from the host has arrived. If the USB stack is operated in
USB_INTERRUPT mode (a usb_config.h option), then this function
will be executed in the interrupt context. If however the USB stack
is operated in the USB_POLLING mode, then this function executes in the
main loop context.
In order to respond to class specific control transfer request(s) in
this handler function, it is suggested to use one or more of the
USBEP0SendRAMPtr(), USBEP0SendROMPtr(), or USBEP0Receive() API
functions.
*******************************************************************/
void USBCheckVendorRequest(void)
{
#if defined(IMPLEMENT_MICROSOFT_OS_DESCRIPTOR)
WORD Length;
//Check if the most recent SETUP request is class specific
if(SetupPkt.bmRequestType == 0b11000000) //Class specific, device to host, device level target
{
//Check if the host is requesting an MS feature descriptor
if(SetupPkt.bRequest == GET_MS_DESCRIPTOR)
{
//Figure out which descriptor is being requested
if(SetupPkt.wIndex == EXTENDED_COMPAT_ID)
{
//Determine number of bytes to send to host
//Lesser of: requested amount, or total size of the descriptor
Length = CompatIDFeatureDescriptor.dwLength;
if(SetupPkt.wLength < Length)
{
Length = SetupPkt.wLength;
}
//Prepare to send the requested descriptor to the host
USBEP0SendROMPtr((ROM BYTE*)&CompatIDFeatureDescriptor, Length, USB_EP0_ROM | USB_EP0_INCLUDE_ZERO);
}
}
}//if(SetupPkt.bmRequestType == 0b11000000)
else if(SetupPkt.bmRequestType == 0b11000001) //Class specific, device to host, interface target
{
//Check if the host is requesting an MS feature descriptor
if(SetupPkt.bRequest == GET_MS_DESCRIPTOR)
{
//Figure out which descriptor is being requested
if(SetupPkt.wIndex == EXTENDED_PROPERTIES)
{
//Determine number of bytes to send to host
//Lesser of: requested amount, or total size of the descriptor
Length = ExtPropertyFeatureDescriptor.dwLength;
if(SetupPkt.wLength < Length)
{
Length = SetupPkt.wLength;
}
//Prepare to send the requested descriptor to the host
USBEP0SendROMPtr((ROM BYTE*)&ExtPropertyFeatureDescriptor, Length, USB_EP0_ROM | USB_EP0_INCLUDE_ZERO);
}
}
}//else if(SetupPkt.bmRequestType == 0b11000001)
#endif //#if defined(IMPLEMENT_MICROSOFT_OS_DESCRIPTOR)
}//void USBCheckVendorRequest(void)
void ChipKITUSBEP0SendROMPtr(BYTE* src, WORD size, BYTE Options)
{
USBEP0SendROMPtr(src, size, Options);
}
/********************************************************************
Function:
void USBCheckHIDRequest(void)
Summary:
This routine handles HID specific request that happen on EP0.
This function should be called from the USBCBCheckOtherReq() call back
function whenever implementing a HID device.
Description:
This routine handles HID specific request that happen on EP0. These
include, but are not limited to, requests for the HID report
descriptors. This function should be called from the
USBCBCheckOtherReq() call back function whenever using an HID device.
Typical Usage:
<code>
void USBCBCheckOtherReq(void)
{
//Since the stack didn't handle the request I need to check
// my class drivers to see if it is for them
USBCheckHIDRequest();
}
</code>
PreCondition:
None
Parameters:
None
Return Values:
None
Remarks:
None
*******************************************************************/
void USBCheckHIDRequest(void)
{
if(SetupPkt.Recipient != USB_SETUP_RECIPIENT_INTERFACE_BITFIELD) return;
if(SetupPkt.bIntfID != HID_INTF_ID) return;
/*
* There are two standard requests that hid.c may support.
* 1. GET_DSC(DSC_HID,DSC_RPT,DSC_PHY);
* 2. SET_DSC(DSC_HID,DSC_RPT,DSC_PHY);
*/
if(SetupPkt.bRequest == USB_REQUEST_GET_DESCRIPTOR)
{
switch(SetupPkt.bDescriptorType)
{
case DSC_HID:
if(USBActiveConfiguration == 1)
{
USBEP0SendROMPtr(
(ROM BYTE*)&configDescriptor1 + 18,
sizeof(USB_HID_DSC)+3,
USB_EP0_INCLUDE_ZERO);
}
break;
case DSC_RPT:
if(USBActiveConfiguration == 1)
{
USBEP0SendROMPtr(
(ROM BYTE*)&hid_rpt01,
sizeof(hid_rpt01), //See usbcfg.h
USB_EP0_INCLUDE_ZERO);
}
break;
case DSC_PHY:
USBEP0Transmit(USB_EP0_NO_DATA);
break;
}//end switch(SetupPkt.bDescriptorType)
}//end if(SetupPkt.bRequest == GET_DSC)
if(SetupPkt.RequestType != USB_SETUP_TYPE_CLASS_BITFIELD)
{
return;
}
switch(SetupPkt.bRequest)
{
case GET_REPORT:
#if defined USER_GET_REPORT_HANDLER
USER_GET_REPORT_HANDLER();
#endif
break;
case SET_REPORT:
#if defined USER_SET_REPORT_HANDLER
USER_SET_REPORT_HANDLER();
#endif
break;
case GET_IDLE:
USBEP0SendRAMPtr(
(BYTE*)&idle_rate,
1,
USB_EP0_INCLUDE_ZERO);
break;
case SET_IDLE:
USBEP0Transmit(USB_EP0_NO_DATA);
idle_rate = SetupPkt.W_Value.byte.HB;
break;
case GET_PROTOCOL:
USBEP0SendRAMPtr(
(BYTE*)&active_protocol,
1,
USB_EP0_NO_OPTIONS);
break;
case SET_PROTOCOL:
USBEP0Transmit(USB_EP0_NO_DATA);
active_protocol = SetupPkt.W_Value.byte.LB;
break;
}//end switch(SetupPkt.bRequest)
}//end USBCheckHIDRequest
/********************************************************************
Function:
void USBCheckHIDRequest(void)
Summary:
This routine handles HID specific request that happen on EP0.
This function should be called from the USBCBCheckOtherReq() call back
function whenever implementing a HID device.
Description:
This routine handles HID specific request that happen on EP0. These
include, but are not limited to, requests for the HID report
descriptors. This function should be called from the
USBCBCheckOtherReq() call back function whenever using an HID device.
Typical Usage:
<code>
void USBCBCheckOtherReq(void)
{
//Since the stack didn't handle the request I need to check
// my class drivers to see if it is for them
USBCheckHIDRequest();
}
</code>
PreCondition:
None
Parameters:
None
Return Values:
None
Remarks:
None
*******************************************************************/
void USBCheckHIDRequest(void)
{
if(SetupPkt.Recipient != USB_SETUP_RECIPIENT_INTERFACE_BITFIELD) return;
if(SetupPkt.bIntfID != HID_INTF_ID) return;
/*
* There are two standard requests that hid.c may support.
* 1. GET_DSC(DSC_HID,DSC_RPT,DSC_PHY);
* 2. SET_DSC(DSC_HID,DSC_RPT,DSC_PHY);
*/
if(SetupPkt.bRequest == USB_REQUEST_GET_DESCRIPTOR)
{
switch(SetupPkt.bDescriptorType)
{
case DSC_HID: //HID Descriptor
if(USBActiveConfiguration == 1)
{
USBEP0SendROMPtr(
(ROM BYTE*)&configDescriptor1 + 18, //18 is a magic number. It is the offset from start of the configuration descriptor to the start of the HID descriptor.
sizeof(USB_HID_DSC)+3,
USB_EP0_INCLUDE_ZERO);
}
break;
case DSC_RPT: //Report Descriptor
//if(USBActiveConfiguration == 1)
{
USBEP0SendROMPtr(
(ROM BYTE*)&hid_rpt01,
HID_RPT01_SIZE, //See usbcfg.h
USB_EP0_INCLUDE_ZERO);
}
break;
case DSC_PHY: //Physical Descriptor
//Note: The below placeholder code is commented out. HID Physical Descriptors are optional and are not used
//in many types of HID applications. If an application does not have a physical descriptor,
//then the device should return STALL in response to this request (stack will do this automatically
//if no-one claims ownership of the control transfer).
//If an application does implement a physical descriptor, then make sure to declare
//hid_phy01 (rom structure containing the descriptor data), and hid_phy01 (the size of the descriptors in bytes),
//and then uncomment the below code.
//if(USBActiveConfiguration == 1)
//{
// USBEP0SendROMPtr((ROM BYTE*)&hid_phy01, sizeof(hid_phy01), USB_EP0_INCLUDE_ZERO);
//}
break;
}//end switch(SetupPkt.bDescriptorType)
}//end if(SetupPkt.bRequest == GET_DSC)
if(SetupPkt.RequestType != USB_SETUP_TYPE_CLASS_BITFIELD)
{
return;
}
switch(SetupPkt.bRequest)
{
case GET_REPORT:
#if defined USER_GET_REPORT_HANDLER
USER_GET_REPORT_HANDLER();
#endif
break;
case SET_REPORT:
#if defined USER_SET_REPORT_HANDLER
USER_SET_REPORT_HANDLER();
#endif
break;
case GET_IDLE:
USBEP0SendRAMPtr(
(BYTE*)&idle_rate,
1,
USB_EP0_INCLUDE_ZERO);
break;
case SET_IDLE:
USBEP0Transmit(USB_EP0_NO_DATA);
idle_rate = SetupPkt.W_Value.byte.HB;
break;
case GET_PROTOCOL:
USBEP0SendRAMPtr(
(BYTE*)&active_protocol,
1,
USB_EP0_NO_OPTIONS);
break;
case SET_PROTOCOL:
USBEP0Transmit(USB_EP0_NO_DATA);
active_protocol = SetupPkt.W_Value.byte.LB;
break;
}//end switch(SetupPkt.bRequest)
}//end USBCheckHIDRequest
