You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
178 lines
7.0 KiB
178 lines
7.0 KiB
![]()
7 years ago
|
/*
|
||
|
LUFA Library
|
||
|
Copyright (C) Dean Camera, 2017.
|
||
|
|
||
|
dean [at] fourwalledcubicle [dot] com
|
||
|
www.lufa-lib.org
|
||
|
*/
|
||
|
|
||
|
/*
|
||
|
Copyright 2017 Dean Camera (dean [at] fourwalledcubicle [dot] com)
|
||
|
|
||
|
Permission to use, copy, modify, distribute, and sell this
|
||
|
software and its documentation for any purpose is hereby granted
|
||
|
without fee, provided that the above copyright notice appear in
|
||
|
all copies and that both that the copyright notice and this
|
||
|
permission notice and warranty disclaimer appear in supporting
|
||
|
documentation, and that the name of the author not be used in
|
||
|
advertising or publicity pertaining to distribution of the
|
||
|
software without specific, written prior permission.
|
||
|
|
||
|
The author disclaims all warranties with regard to this
|
||
|
software, including all implied warranties of merchantability
|
||
|
and fitness. In no event shall the author be liable for any
|
||
|
special, indirect or consequential damages or any damages
|
||
|
whatsoever resulting from loss of use, data or profits, whether
|
||
|
in an action of contract, negligence or other tortious action,
|
||
|
arising out of or in connection with the use or performance of
|
||
|
this software.
|
||
|
*/
|
||
|
|
||
|
#include "ConfigDescriptor.h"
|
||
|
|
||
|
/** Interface number for the bidirectional Printer interface found within the device. */
|
||
|
uint8_t PrinterInterfaceNumber;
|
||
|
|
||
|
/** Interface Alternate Setting number for the bidirectional Printer interface found within the device. */
|
||
|
uint8_t PrinterAltSetting;
|
||
|
|
||
|
/** Reads and processes an attached device's descriptors, to determine compatibility and pipe configurations. This
|
||
|
* routine will read in the entire configuration descriptor, and configure the hosts pipes to correctly communicate
|
||
|
* with compatible devices.
|
||
|
*
|
||
|
* This routine searches for a bidirectional Printer interface descriptor containing bulk IN and OUT data endpoints.
|
||
|
*
|
||
|
* \return An error code from the \ref PrinterHost_GetConfigDescriptorDataCodes_t enum.
|
||
|
*/
|
||
|
uint8_t ProcessConfigurationDescriptor(void)
|
||
|
{
|
||
|
uint8_t ConfigDescriptorData[512];
|
||
|
void* CurrConfigLocation = ConfigDescriptorData;
|
||
|
uint16_t CurrConfigBytesRem;
|
||
|
|
||
|
USB_Descriptor_Interface_t* PrinterInterface = NULL;
|
||
|
USB_Descriptor_Endpoint_t* DataINEndpoint = NULL;
|
||
|
USB_Descriptor_Endpoint_t* DataOUTEndpoint = NULL;
|
||
|
|
||
|
/* Retrieve the entire configuration descriptor into the allocated buffer */
|
||
|
switch (USB_Host_GetDeviceConfigDescriptor(1, &CurrConfigBytesRem, ConfigDescriptorData, sizeof(ConfigDescriptorData)))
|
||
|
{
|
||
|
case HOST_GETCONFIG_Successful:
|
||
|
break;
|
||
|
case HOST_GETCONFIG_InvalidData:
|
||
|
return InvalidConfigDataReturned;
|
||
|
case HOST_GETCONFIG_BuffOverflow:
|
||
|
return DescriptorTooLarge;
|
||
|
default:
|
||
|
return ControlError;
|
||
|
}
|
||
|
|
||
|
while (!(DataINEndpoint) || !(DataOUTEndpoint))
|
||
|
{
|
||
|
/* See if we've found a likely compatible interface, and if there is an endpoint within that interface */
|
||
|
if (!(PrinterInterface) ||
|
||
|
USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,
|
||
|
DComp_NextPrinterInterfaceBulkDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
|
||
|
{
|
||
|
/* Get the next Printer interface from the configuration descriptor */
|
||
|
if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,
|
||
|
DComp_NextBidirectionalPrinterInterface) != DESCRIPTOR_SEARCH_COMP_Found)
|
||
|
{
|
||
|
/* Descriptor not found, error out */
|
||
|
return NoCompatibleInterfaceFound;
|
||
|
}
|
||
|
|
||
|
/* Save the interface in case we need to refer back to it later */
|
||
|
PrinterInterface = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Interface_t);
|
||
|
|
||
|
/* Clear any found endpoints */
|
||
|
DataINEndpoint = NULL;
|
||
|
DataOUTEndpoint = NULL;
|
||
|
|
||
|
/* Skip the remainder of the loop as we have not found an endpoint yet */
|
||
|
continue;
|
||
|
}
|
||
|
|
||
|
/* Retrieve the endpoint address from the endpoint descriptor */
|
||
|
USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Endpoint_t);
|
||
|
|
||
|
/* If the endpoint is a IN type endpoint */
|
||
|
if ((EndpointData->EndpointAddress & ENDPOINT_DIR_MASK) == ENDPOINT_DIR_IN)
|
||
|
DataINEndpoint = EndpointData;
|
||
|
else
|
||
|
DataOUTEndpoint = EndpointData;
|
||
|
}
|
||
|
|
||
|
/* Save Printer interface details for later use */
|
||
|
PrinterInterfaceNumber = PrinterInterface->InterfaceNumber;
|
||
|
PrinterAltSetting = PrinterInterface->AlternateSetting;
|
||
|
|
||
|
/* Configure the Printer data IN pipe */
|
||
|
Pipe_ConfigurePipe(PRINTER_DATA_IN_PIPE, EP_TYPE_BULK, DataINEndpoint->EndpointAddress, DataINEndpoint->EndpointSize, 1);
|
||
|
|
||
|
/* Configure the Printer data OUT pipe */
|
||
|
Pipe_ConfigurePipe(PRINTER_DATA_OUT_PIPE, EP_TYPE_BULK, DataOUTEndpoint->EndpointAddress, DataOUTEndpoint->EndpointSize, 1);
|
||
|
|
||
|
/* Valid data found, return success */
|
||
|
return SuccessfulConfigRead;
|
||
|
}
|
||
|
|
||
|
/** Descriptor comparator function. This comparator function is can be called while processing an attached USB device's
|
||
|
* configuration descriptor, to search for a specific sub descriptor. It can also be used to abort the configuration
|
||
|
* descriptor processing if an incompatible descriptor configuration is found.
|
||
|
*
|
||
|
* This comparator searches for the next Bidirectional Printer Interface descriptor of the current Printer interface,
|
||
|
* aborting the search if the end of the descriptors is found.
|
||
|
*
|
||
|
* \return A value from the DSEARCH_Return_ErrorCodes_t enum
|
||
|
*/
|
||
|
uint8_t DComp_NextBidirectionalPrinterInterface(void* CurrentDescriptor)
|
||
|
{
|
||
|
USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
|
||
|
|
||
|
if (Header->Type == DTYPE_Interface)
|
||
|
{
|
||
|
USB_Descriptor_Interface_t* Interface = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Interface_t);
|
||
|
|
||
|
/* Check the descriptor class, subclass and protocol, break out if correct value interface found */
|
||
|
if ((Interface->Class == PRNT_CSCP_PrinterClass) &&
|
||
|
(Interface->SubClass == PRNT_CSCP_PrinterSubclass) &&
|
||
|
(Interface->Protocol == PRNT_CSCP_BidirectionalProtocol))
|
||
|
{
|
||
|
return DESCRIPTOR_SEARCH_Found;
|
||
|
}
|
||
|
}
|
||
|
|
||
|
return DESCRIPTOR_SEARCH_NotFound;
|
||
|
}
|
||
|
|
||
|
/** Descriptor comparator function. This comparator function is can be called while processing an attached USB device's
|
||
|
* configuration descriptor, to search for a specific sub descriptor. It can also be used to abort the configuration
|
||
|
* descriptor processing if an incompatible descriptor configuration is found.
|
||
|
*
|
||
|
* This comparator searches for the next Bulk Endpoint descriptor of the current Printer interface, aborting the
|
||
|
* search if another interface descriptor is found before the next endpoint.
|
||
|
*
|
||
|
* \return A value from the DSEARCH_Return_ErrorCodes_t enum
|
||
|
*/
|
||
|
uint8_t DComp_NextPrinterInterfaceBulkDataEndpoint(void* CurrentDescriptor)
|
||
|
{
|
||
|
USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
|
||
|
|
||
|
if (Header->Type == DTYPE_Endpoint)
|
||
|
{
|
||
|
USB_Descriptor_Endpoint_t* Endpoint = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Endpoint_t);
|
||
|
|
||
|
/* Check the endpoint type, break out if correct BULK type endpoint found */
|
||
|
if ((Endpoint->Attributes & EP_TYPE_MASK) == EP_TYPE_BULK)
|
||
|
return DESCRIPTOR_SEARCH_Found;
|
||
|
}
|
||
|
else if (Header->Type == DTYPE_Interface)
|
||
|
{
|
||
|
return DESCRIPTOR_SEARCH_Fail;
|
||
|
}
|
||
|
|
||
|
return DESCRIPTOR_SEARCH_NotFound;
|
||
|
}
|
||
|
|