Renamed functions in the HID parser to have a "USB_" prefix and the acronym "HID" in the name.
Further module-level documentation updates.
uint8_t FoundEndpoints = 0;\r
\r
/* Get Configuration Descriptor size from the device */\r
- if (USB_Host_GetDeviceConfigDescriptor(&ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)\r
+ if (USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)\r
return ControlError;\r
\r
/* Ensure that the Configuration Descriptor isn't too large */\r
ConfigDescriptorData = alloca(ConfigDescriptorSize);\r
\r
/* Retrieve the entire configuration descriptor into the allocated buffer */\r
- USB_Host_GetDeviceConfigDescriptor(&ConfigDescriptorSize, ConfigDescriptorData);\r
+ USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, ConfigDescriptorData);\r
\r
/* Validate returned data - ensure first entry is a configuration header descriptor */\r
if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)\r
return InvalidConfigDataReturned;\r
\r
/* Get the CDC control interface from the configuration descriptor */\r
- if (USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextCDCControlInterface))\r
+ if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextCDCControlInterface))\r
{\r
/* Descriptor not found, error out */\r
return NoCDCInterfaceFound;\r
while (FoundEndpoints != ((1 << CDC_NOTIFICATIONPIPE) | (1 << CDC_DATAPIPE_IN) | (1 << CDC_DATAPIPE_OUT)))\r
{\r
/* Fetch the next bulk or interrupt endpoint from the current CDC interface */\r
- if (USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
+ if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
NextInterfaceCDCDataEndpoint))\r
{\r
/* Check to see if the control interface's notification pipe has been found, if so search for the data interface */\r
if (FoundEndpoints & (1 << CDC_NOTIFICATIONPIPE))\r
{\r
/* Get the next CDC data interface from the configuration descriptor (CDC class has two CDC interfaces) */\r
- if (USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextCDCDataInterface))\r
+ if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextCDCDataInterface))\r
{\r
/* Descriptor not found, error out */\r
return NoCDCInterfaceFound;\r
else\r
{\r
/* Get the next CDC control interface from the configuration descriptor (CDC class has two CDC interfaces) */\r
- if (USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextCDCControlInterface))\r
+ if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextCDCControlInterface))\r
{\r
/* Descriptor not found, error out */\r
return NoCDCInterfaceFound;\r
}\r
\r
/* Fetch the next bulk or interrupt endpoint from the current CDC interface */\r
- if (USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
+ if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
NextInterfaceCDCDataEndpoint))\r
{\r
/* Descriptor not found, error out */\r
uint8_t FoundEndpoints = 0;\r
\r
/* Get Configuration Descriptor size from the device */\r
- if (USB_Host_GetDeviceConfigDescriptor(&ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)\r
+ if (USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)\r
return ControlError;\r
\r
/* Ensure that the Configuration Descriptor isn't too large */\r
ConfigDescriptorData = alloca(ConfigDescriptorSize);\r
\r
/* Retrieve the entire configuration descriptor into the allocated buffer */\r
- USB_Host_GetDeviceConfigDescriptor(&ConfigDescriptorSize, ConfigDescriptorData);\r
+ USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, ConfigDescriptorData);\r
\r
/* Validate returned data - ensure first entry is a configuration header descriptor */\r
if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)\r
return InvalidConfigDataReturned;\r
\r
/* Get the HID interface from the configuration descriptor */\r
- if (USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextHIDInterface))\r
+ if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextHIDInterface))\r
{\r
/* Descriptor not found, error out */\r
return NoHIDInterfaceFound;\r
while (FoundEndpoints != ((1 << HID_DATA_IN_PIPE) | (1 << HID_DATA_OUT_PIPE)))\r
{\r
/* Get the next HID interface's data endpoint descriptor */\r
- if (USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
- NextInterfaceHIDDataEndpoint))\r
+ if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextInterfaceHIDDataEndpoint))\r
{\r
/* Not all HID devices have an OUT endpoint - if we've reached the end of the HID descriptor\r
* but only found the mandatory IN endpoint, it's safe to continue with the device enumeration */\r
uint16_t ConfigDescriptorSize;\r
\r
/* Get Configuration Descriptor size from the device */\r
- if (USB_Host_GetDeviceConfigDescriptor(&ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)\r
+ if (USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)\r
return ControlError;\r
\r
/* Ensure that the Configuration Descriptor isn't too large */\r
ConfigDescriptorData = alloca(ConfigDescriptorSize);\r
\r
/* Retrieve the entire configuration descriptor into the allocated buffer */\r
- USB_Host_GetDeviceConfigDescriptor(&ConfigDescriptorSize, ConfigDescriptorData);\r
+ USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, ConfigDescriptorData);\r
\r
/* Validate returned data - ensure first entry is a configuration header descriptor */\r
if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)\r
return InvalidConfigDataReturned;\r
\r
/* Get the keyboard interface from the configuration descriptor */\r
- if (USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextKeyboardInterface))\r
+ if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextKeyboardInterface))\r
{\r
/* Descriptor not found, error out */\r
return NoHIDInterfaceFound;\r
}\r
\r
/* Get the keyboard interface's data endpoint descriptor */\r
- if (USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
+ if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
NextInterfaceKeyboardDataEndpoint))\r
{\r
/* Descriptor not found, error out */\r
uint8_t ErrorCode;\r
\r
/* Get Configuration Descriptor size from the device */\r
- if (USB_Host_GetDeviceConfigDescriptor(&ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)\r
+ if (USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)\r
return ControlError;\r
\r
/* Ensure that the Configuration Descriptor isn't too large */\r
ConfigDescriptorData = alloca(ConfigDescriptorSize);\r
\r
/* Retrieve the entire configuration descriptor into the allocated buffer */\r
- USB_Host_GetDeviceConfigDescriptor(&ConfigDescriptorSize, ConfigDescriptorData);\r
+ USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, ConfigDescriptorData);\r
\r
/* Validate returned data - ensure first entry is a configuration header descriptor */\r
if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)\r
return InvalidConfigDataReturned;\r
\r
/* Get the keyboard interface from the configuration descriptor */\r
- if ((ErrorCode = USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextKeyboardInterface)))\r
+ if ((ErrorCode = USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextKeyboardInterface)))\r
{\r
/* Descriptor not found, error out */\r
return NoHIDInterfaceFound;\r
}\r
\r
/* Get the keyboard interface's HID descriptor */\r
- if ((ErrorCode = USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextHID)))\r
+ if ((ErrorCode = USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextHID)))\r
{\r
/* Descriptor not found, error out */\r
return NoHIDDescriptorFound;\r
HIDReportSize = DESCRIPTOR_CAST(ConfigDescriptorData, USB_Descriptor_HID_t).HIDReportLength;\r
\r
/* Get the keyboard interface's data endpoint descriptor */\r
- if ((ErrorCode = USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
+ if ((ErrorCode = USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
NextInterfaceKeyboardDataEndpoint)))\r
{\r
/* Descriptor not found, error out */\r
uint8_t FoundEndpoints = 0;\r
\r
/* Get Configuration Descriptor size from the device */\r
- if (USB_Host_GetDeviceConfigDescriptor(&ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)\r
+ if (USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)\r
return ControlError;\r
\r
/* Ensure that the Configuration Descriptor isn't too large */\r
ConfigDescriptorData = alloca(ConfigDescriptorSize);\r
\r
/* Retrieve the entire configuration descriptor into the allocated buffer */\r
- USB_Host_GetDeviceConfigDescriptor(&ConfigDescriptorSize, ConfigDescriptorData);\r
+ USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, ConfigDescriptorData);\r
\r
/* Validate returned data - ensure first entry is a configuration header descriptor */\r
if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)\r
return InvalidConfigDataReturned;\r
\r
/* Get the mass storage interface from the configuration descriptor */\r
- if ((ErrorCode = USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
+ if ((ErrorCode = USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
NextMassStorageInterface)))\r
{\r
/* Descriptor not found, error out */\r
while (FoundEndpoints != ((1 << MASS_STORE_DATA_IN_PIPE) | (1 << MASS_STORE_DATA_OUT_PIPE)))\r
{\r
/* Fetch the next bulk endpoint from the current mass storage interface */\r
- if ((ErrorCode = USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
+ if ((ErrorCode = USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
NextInterfaceBulkDataEndpoint)))\r
{\r
/* Descriptor not found, error out */\r
uint16_t ConfigDescriptorSize;\r
\r
/* Get Configuration Descriptor size from the device */\r
- if (USB_Host_GetDeviceConfigDescriptor(&ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)\r
+ if (USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)\r
return ControlError;\r
\r
/* Ensure that the Configuration Descriptor isn't too large */\r
ConfigDescriptorData = alloca(ConfigDescriptorSize);\r
\r
/* Retrieve the entire configuration descriptor into the allocated buffer */\r
- USB_Host_GetDeviceConfigDescriptor(&ConfigDescriptorSize, ConfigDescriptorData);\r
+ USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, ConfigDescriptorData);\r
\r
/* Validate returned data - ensure first entry is a configuration header descriptor */\r
if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)\r
uint8_t ErrorCode;\r
\r
/* Get Configuration Descriptor size from the device */\r
- if (USB_Host_GetDeviceConfigDescriptor(&ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)\r
+ if (USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)\r
return ControlError;\r
\r
/* Ensure that the Configuration Descriptor isn't too large */\r
ConfigDescriptorData = alloca(ConfigDescriptorSize);\r
\r
/* Retrieve the entire configuration descriptor into the allocated buffer */\r
- USB_Host_GetDeviceConfigDescriptor(&ConfigDescriptorSize, ConfigDescriptorData);\r
+ USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, ConfigDescriptorData);\r
\r
/* Validate returned data - ensure first entry is a configuration header descriptor */\r
if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)\r
return InvalidConfigDataReturned;\r
\r
/* Get the mouse interface from the configuration descriptor */\r
- if ((ErrorCode = USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextMouseInterface)))\r
+ if ((ErrorCode = USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextMouseInterface)))\r
{\r
/* Descriptor not found, error out */\r
return NoHIDInterfaceFound;\r
}\r
\r
/* Get the mouse interface's HID descriptor */\r
- if ((ErrorCode = USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextHID)))\r
+ if ((ErrorCode = USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextHID)))\r
{\r
/* Descriptor not found, error out */\r
return NoHIDDescriptorFound;\r
HIDReportSize = DESCRIPTOR_CAST(ConfigDescriptorData, USB_Descriptor_HID_t).HIDReportLength;\r
\r
/* Get the mouse interface's data endpoint descriptor */\r
- if ((ErrorCode = USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
+ if ((ErrorCode = USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
NextInterfaceMouseDataEndpoint)))\r
{\r
/* Descriptor not found, error out */\r
uint8_t FoundEndpoints = 0;\r
\r
/* Get Configuration Descriptor size from the device */\r
- if (USB_Host_GetDeviceConfigDescriptor(&ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)\r
+ if (USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)\r
return ControlError;\r
\r
/* Ensure that the Configuration Descriptor isn't too large */\r
ConfigDescriptorData = alloca(ConfigDescriptorSize);\r
\r
/* Retrieve the entire configuration descriptor into the allocated buffer */\r
- USB_Host_GetDeviceConfigDescriptor(&ConfigDescriptorSize, ConfigDescriptorData);\r
+ USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, ConfigDescriptorData);\r
\r
/* Validate returned data - ensure first entry is a configuration header descriptor */\r
if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)\r
return InvalidConfigDataReturned;\r
\r
/* Get the Still Image interface from the configuration descriptor */\r
- if (USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextStillImageInterface))\r
+ if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextStillImageInterface))\r
{\r
/* Descriptor not found, error out */\r
return NoInterfaceFound;\r
while (FoundEndpoints != ((1 << SIMAGE_EVENTS_PIPE) | (1 << SIMAGE_DATA_IN_PIPE) | (1 << SIMAGE_DATA_OUT_PIPE)))\r
{\r
/* Fetch the next endpoint from the current Still Image interface */\r
- if (USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
+ if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
NextSImageInterfaceDataEndpoint))\r
{\r
/* Descriptor not found, error out */\r
* - Removed the ButtLoadTag.h header file, as no one used for its intended purpose anyway\r
* - Renamed the main Drivers/AT90USBXXX directory to Drivers/Peripheral, renamed the Serial_Stream driver to SerialStream\r
* - Fixed CDC and USBtoSerial demos freezing where buffers were full while still transmitting or receiving (thanks to Peter Hand)\r
+ * - Removed "Host_" section of the function names in ConfigDescriptor.h, as most of the routines can now be used in device mode on the\r
+ * device descriptor\r
+ * - Renamed functions in the HID parser to have a "USB_" prefix and the acronym "HID" in the name\r
* \r
*\r
* \section Sec_ChangeLog090401 Version 090401\r
* \section Sec_SummaryNonUSBTokens Non USB Related Tokens\r
* This section describes compile tokens which affect non-USB sections of the LUFA library.\r
*\r
- * <b>DISABLE_TERMINAL_CODES</b> - TerminalCodes.h \n\r
+ * <b>DISABLE_TERMINAL_CODES</b> - ( \ref Group_Terminal ) \n\r
* If an application contains ANSI terminal control codes listed in TerminalCodes.h, it might be desired to remove them\r
* at compile time for use with a terminal which is non-ANSI control code aware, without modifying the source code. If\r
* this token is defined, all ANSI control codes in the application code from the TerminalCodes.h header are removed from\r
* the source code at compile time.\r
*\r
- * <b>NUM_BLOCKS</b> - DynAlloc.h \n\r
+ * <b>NUM_BLOCKS</b> - ( \ref Group_MemoryAllocator ) \n\r
* Sets the number of allocable blocks in the psudo-heap of the dynamic memory allocation driver. This should be\r
* defined as a constant larger than zero.\r
*\r
- * <b>BLOCK_SIZE</b> - DynAlloc.h \n\r
+ * <b>BLOCK_SIZE</b> - ( \ref Group_MemoryAllocator ) \n\r
* Sets the size of each allocable block in the psudo-heap of the dynamic memory allocation driver. This should be\r
* defined as a constant larger than zero.\r
*\r
- * <b>NUM_HANDLES</b> - DynAlloc.h \n\r
+ * <b>NUM_HANDLES</b> - ( \ref Group_MemoryAllocator ) \n\r
* Sets the maximum number of managed memory handles which can be handed out by the dynamic memory allocation driver\r
* simultaneously, before a handle (and its associated allocated memory) must be freed.\r
*\r
* \section Sec_SummaryUSBClassTokens USB Class Driver Related Tokens\r
* This section describes compile tokens which affect USB class-specific drivers in the LUFA library.\r
*\r
- * <b>HID_ENABLE_FEATURE_PROCESSING</b> - HIDParser.h \n\r
+ * <b>HID_ENABLE_FEATURE_PROCESSING</b> - ( \ref Group_HIDParser ) \n\r
* Define this token to enable the processing of FEATURE HID report items, if any, into the processed HID structure.\r
* By default FEATURE items (which are device features settable by the host but not directly visible by the user) are\r
* skipped when processing a device HID report.\r
*\r
- * <b>HID_INCLUDE_CONSTANT_DATA_ITEMS</b> - HIDParser.h \n\r
+ * <b>HID_INCLUDE_CONSTANT_DATA_ITEMS</b> - ( \ref Group_HIDParser ) \n\r
* By default, constant data items (usually used as spacers to align seperate report items to a byte or word boundary)\r
* in the HID report are skipped during report processing. It is highly unusual for an application to make any use of\r
* constant data items (as they do not carry any useful data and only occupy limited RAM) however if required defining\r
* this switch will put constant data items into the processed HID report structure.\r
*\r
- * <b>HID_STATETABLE_STACK_DEPTH</b> - HIDParser.h \n\r
+ * <b>HID_STATETABLE_STACK_DEPTH</b> - ( \ref Group_HIDParser ) \n\r
* HID reports may contain PUSH and POP elements, to store and retrieve the current HID state table onto a stack. This\r
* allows for reports to save the state table before modifying it slightly for a data item, and then restore the previous\r
* state table in a compact manner. This token may be defined to a non-zero value to give the maximum depth of the state\r
* table stack. If not defined, this defaults to the value indicated in the HID.h file documentation.\r
*\r
- * <b>HID_USAGE_STACK_DEPTH</b> - HIDParser.h \n\r
+ * <b>HID_USAGE_STACK_DEPTH</b> - ( \ref Group_HIDParser ) \n\r
* HID reports generally contain many USAGE elements, which are assigned to INPUT, OUTPUT and FEATURE items in succession\r
* when multiple items are defined at once (via REPORT COUNT elements). This allows for several items to be defined with\r
* different usages in a compact manner. This token may be defined to a non-zero value to set the maximum depth of the\r
* usage stack, indicating the maximum number of USAGE items which can be stored tempoarily until the next INPUT, OUTPUT\r
* and FEATURE item. If not defined, this defaults to the value indicated in the HID.h file documentation.\r
*\r
- * <b>HID_MAX_COLLECTIONS</b> - HIDParser.h \n\r
+ * <b>HID_MAX_COLLECTIONS</b> - ( \ref Group_HIDParser ) \n\r
* HID reports generally contain several COLLECTION elements, used to group related data items together. Collection information\r
* is stored seperately in the processed usage structure (and referred to by the data elements in the structure) to save space.\r
* This token may be defined to a non-zero value to set the maximum number of COLLECTION items which can be processed by the\r
* parser into the resultant processed report structure. If not defined, this defaults to the value indicated in the HID.h file\r
* documentation.\r
*\r
- * <b>HID_MAX_REPORTITEMS</b> - HIDParser.h \n\r
+ * <b>HID_MAX_REPORTITEMS</b> - ( \ref Group_HIDParser ) \n\r
* All HID reports contain one or more INPUT, OUTPUT and/or FEATURE items describing the data which can be sent to and from the HID\r
* device. Each item has associated usages, bit offsets in the item reports and other associated data indicating the manner in which\r
* the report data should be interpreted by the host. This token may be defined to a non-zero value to set the maximum number of\r
* \section Sec_SummaryUSBTokens USB Driver Related Tokens\r
* This section describes compile tokens which affect USB driver stack as a whole in the LUFA library.\r
*\r
- * <b>USE_RAM_DESCRIPTORS</b> - StdDescriptors.h \n\r
+ * <b>USE_RAM_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n\r
* Define this token to indicate to the USB driver that device descriptors are stored in RAM, rather than the default of\r
* the AVR's flash. RAM descriptors may be desirable in applications where speed or minimizing flash usage is more important\r
* than RAM usage, or applications where the descriptors need to be modified at runtime.\r
*\r
- * <b>USE_EEPROM_DESCRIPTORS</b> - StdDescriptors.h \n\r
+ * <b>USE_EEPROM_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n\r
* Similar to USE_RAM_DESCRIPTORS, but descriptors are stored in the AVR's EEPROM memory rather than RAM.\r
*\r
- * <b>USE_NONSTANDARD_DESCRIPTOR_NAMES</b> - StdDescriptors.h \n\r
+ * <b>USE_NONSTANDARD_DESCRIPTOR_NAMES</b> - ( \ref Group_Descriptors ) \n\r
* The USB 2.0 standard gives some rather obscure names for the elements in the standard descriptor types (device, configuration,\r
* string, endpoint, etc.). By default the LUFA library uses these names in its predefined descriptor structure types for\r
* compatibility. If this token is defined, the structure element names are switched to the LUFA-specific but more descriptive\r
* names documented in the StdDescriptors.h source file.\r
*\r
- * <b>FIXED_CONTROL_ENDPOINT_SIZE</b> - Endpoint.h \n\r
+ * <b>FIXED_CONTROL_ENDPOINT_SIZE</b> - ( \ref Group_EndpointManagement ) \n\r
* By default, the library determines the size of the control endpoint (when in device mode) by reading the device descriptor.\r
* Normally this reduces the amount of configuration required for the library, allows the value to change dynamically (if\r
* descriptors are stored in EEPROM or RAM rather than flash memory) and reduces code maintenance. However, this token can be\r
* defined to a non-zero value instead to give the size in bytes of the control endpoint, to reduce the size of the compiled\r
* binary at the expense of flexibility.\r
*\r
- * <b>STATIC_ENDPOINT_CONFIGURATION</b> - Endpoint.h \n\r
+ * <b>STATIC_ENDPOINT_CONFIGURATION</b> - ( \ref Group_EndpointManagement ) \n\r
* By default, the endpoint configuration routine is designed to accept dynamic inputs, so that the endpoints can be configured\r
* using variable values known only at runtime. This allows for a great deal of flexibility, however uses a small amount of binary\r
* space which may be wasted if all endpoint configurations are static and known at compile time. Define this token via the -D switch\r
* flexibility. Note that with this option dynamic values may still be used, but will result in many times more code to be generated than\r
* if the option was disabled. This is designed to be used only if the FIXED_CONTROL_ENDPOINT_SIZE option is also used.\r
*\r
- * <b>USE_SINGLE_DEVICE_CONFIGURATION</b> - DevChapter9.h \n\r
+ * <b>USE_SINGLE_DEVICE_CONFIGURATION</b> - ( \ref Group_Device ) \n\r
* By default, the library determines the number of configurations a USB device supports by reading the device descriptor. This reduces\r
* the amount of configuration required to set up the library, and allows the value to change dynamically (if descriptors are stored in\r
* EEPROM or RAM rather than flash memory) and reduces code maintenance. However, many USB device projects use only a single configuration.\r
* Defining this token enables single-configuration mode, reducing the compiled size of the binary at the expense of flexibility.\r
*\r
- * <b>FEATURELESS_CONTROL_ONLY_DEVICE</b> - DevChapter9.h \n\r
+ * <b>FEATURELESS_CONTROL_ONLY_DEVICE</b> \n\r
* In some limited USB device applications, device features (other than self-power) and endpoints other than the control endpoint aren't\r
* used. In such limited situations, this token may be defined to remove the handling of the Set Feature Chapter 9 request entirely and\r
- * parts of the Get Feature chapter 9 request to save space. Generally, this is usually only useful in (some) bootloaders.\r
+ * parts of the Get Feature chapter 9 request to save space. Generally, this is usually only useful in (some) bootloaders and is best avoided.\r
*\r
- * <b>NO_STREAM_CALLBACKS</b> - Endpoint.h, Pipe.h \n\r
+ * <b>NO_STREAM_CALLBACKS</b> - ( \ref Group_EndpointPacketManagement , \ref Group_PipePacketManagement )\n\r
* Both the endpoint and the pipe driver code contains stream functions, allowing for arrays of data to be sent to or from the\r
* host easily via a single function call (rather than complex routines worrying about sending full packets, waiting for the endpoint/\r
* pipe to become ready, etc.). By default, these stream functions require a callback function which is executed after each byte processed,\r
* by defining this token, reducing the compiled binary size. When removed, the stream functions no longer accept a callback function as\r
* a parameter.\r
*\r
- * <b>USB_HOST_TIMEOUT_MS</b> - Host.h \n\r
+ * <b>USB_HOST_TIMEOUT_MS</b> - ( \ref Group_Host ) \n\r
* When a control transfer is initiated in host mode to an attached device, a timeout is used to abort the transfer if the attached\r
* device fails to respond within the timeout period. This token may be defined to a non-zero value to set the timeout period for\r
* control transfers, specified in milliseconds. If not defined, the default value specified in Host.h is used instead.\r
*\r
- * <b>HOST_DEVICE_SETTLE_DELAY_MS</b> - Host.h \n\r
+ * <b>HOST_DEVICE_SETTLE_DELAY_MS</b> - ( \ref Group_Host ) \n\r
* Some devices require a delay of up to 5 seconds after they are connected to VBUS before the enumeration process can be started, or\r
* they will fail to enumerate correctly. By placing a delay before the enumeration process, it can be ensured that the bus has settled\r
* back to a known idle state before communications occur with the device. This token may be defined to a non-zero value to set the\r
* device settle period, specified in milliseconds. If not defined, the default value specified in Host.h is used instead.\r
*\r
- * <b>USE_STATIC_OPTIONS</b> - LowLevel.h \n\r
+ * <b>USE_STATIC_OPTIONS</b> - ( \ref Group_USBManagement ) \n\r
* By default, the USB_Init() function accepts dynamic options at runtime to alter the library behaviour, including whether the USB pad\r
* voltage regulator is enabled, and the device speed when in device mode. By defining this token to a mask comprised of the USB options\r
* mask defines usually passed as the Options parameter to USB_Init(), the resulting compiled binary can be decreased in size by removing\r
* the dynamic options code, and replacing it with the statically set options. When defined, the USB_Init() function no longer accepts an\r
* Options parameter.\r
*\r
- * <b>USB_DEVICE_ONLY</b> - LowLevel.h \n\r
+ * <b>USB_DEVICE_ONLY</b> - ( \ref Group_USBManagement ) \n\r
* For the USB AVR models supporting both device and host USB modes, the USB_Init() function contains a Mode parameter which specifies the\r
* mode the library should be initialized to. If only device mode is required, the code for USB host mode can be removed from the binary to\r
* save space. When defined, the USB_Init() function no longer accepts a Mode parameter. This define is irrelevent on smaller USB AVRs which\r
* do not support host mode.\r
*\r
- * <b>USB_HOST_ONLY</b> - LowLevel.h \n\r
+ * <b>USB_HOST_ONLY</b> - ( \ref Group_USBManagement ) \n\r
* Same as USB_DEVICE_ONLY, except the library is fixed to USB host mode rather than USB device mode. Not available on some USB AVR models.\r
*\r
- * <b>USB_STREAM_TIMEOUT_MS</b> - LowLevel.h \n\r
+ * <b>USB_STREAM_TIMEOUT_MS</b> - ( \ref Group_USBManagement ) \n\r
* When endpoint and/or pipe stream functions are used, by default there is a timeout between each transfer which the connected device or host\r
* must satisfy, or the stream function aborts the remaining data transfer. This token may be defined to a non-zero value to set the timeout\r
* period for stream transfers, specified in milliseconds. If not defined, the default value specified in LowLevel.h is used instead.\r
*\r
- * <b>NO_LIMITED_CONTROLLER_CONNECT</b> - Events.h \n\r
+ * <b>NO_LIMITED_CONTROLLER_CONNECT</b> - ( \ref Group_Events ) \n\r
* On the smaller USB AVRs, the USB controller lacks VBUS events to determine the physical connection state of the USB bus to a host. In lieu of\r
* VBUS events, the library attempts to determine the connection state via the bus suspension and wake up events instead. This however may be\r
* slightly inaccurate due to the possibility of the host suspending the bus while the device is still connected. If accurate connection status is\r
this software.\r
*/\r
\r
-#include "../HighLevel/USBMode.h"\r
-\r
-#if defined(USB_CAN_BE_HOST)\r
-\r
#include "ConfigDescriptor.h"\r
\r
-uint8_t USB_Host_GetDeviceConfigDescriptor(uint16_t* const ConfigSizePtr, void* BufferPtr)\r
+#if defined(USB_CAN_BE_HOST)\r
+uint8_t USB_GetDeviceConfigDescriptor(uint16_t* const ConfigSizePtr, void* BufferPtr)\r
{\r
uint8_t ErrorCode;\r
\r
\r
return ErrorCode;\r
}\r
+#endif\r
\r
-void USB_Host_GetNextDescriptorOfType(uint16_t* const BytesRem,\r
- uint8_t** const CurrConfigLoc,\r
- const uint8_t Type)\r
+void USB_GetNextDescriptorOfType(uint16_t* const BytesRem,\r
+ uint8_t** const CurrConfigLoc,\r
+ const uint8_t Type)\r
{\r
while (*BytesRem)\r
{\r
- USB_Host_GetNextDescriptor(BytesRem, CurrConfigLoc); \r
+ USB_GetNextDescriptor(BytesRem, CurrConfigLoc); \r
\r
if (DESCRIPTOR_TYPE(*CurrConfigLoc) == Type)\r
return;\r
}\r
}\r
\r
-void USB_Host_GetNextDescriptorOfTypeBefore(uint16_t* const BytesRem,\r
- uint8_t** const CurrConfigLoc,\r
- const uint8_t Type,\r
- const uint8_t BeforeType)\r
+void USB_GetNextDescriptorOfTypeBefore(uint16_t* const BytesRem,\r
+ uint8_t** const CurrConfigLoc,\r
+ const uint8_t Type,\r
+ const uint8_t BeforeType)\r
{\r
while (*BytesRem)\r
{\r
- USB_Host_GetNextDescriptor(BytesRem, CurrConfigLoc);\r
+ USB_GetNextDescriptor(BytesRem, CurrConfigLoc);\r
\r
if (DESCRIPTOR_TYPE(*CurrConfigLoc) == Type)\r
{\r
}\r
}\r
\r
-void USB_Host_GetNextDescriptorOfTypeAfter(uint16_t* const BytesRem,\r
- uint8_t** const CurrConfigLoc,\r
- const uint8_t Type,\r
- const uint8_t AfterType)\r
+void USB_GetNextDescriptorOfTypeAfter(uint16_t* const BytesRem,\r
+ uint8_t** const CurrConfigLoc,\r
+ const uint8_t Type,\r
+ const uint8_t AfterType)\r
{\r
- USB_Host_GetNextDescriptorOfType(BytesRem, CurrConfigLoc, AfterType);\r
+ USB_GetNextDescriptorOfType(BytesRem, CurrConfigLoc, AfterType);\r
\r
if (*BytesRem)\r
- USB_Host_GetNextDescriptorOfType(BytesRem, CurrConfigLoc, Type);\r
+ USB_GetNextDescriptorOfType(BytesRem, CurrConfigLoc, Type);\r
}\r
\r
-uint8_t USB_Host_GetNextDescriptorComp_P(uint16_t* BytesRem, uint8_t** CurrConfigLoc,\r
- uint8_t (* const ComparatorRoutine)(void*))\r
+uint8_t USB_GetNextDescriptorComp_P(uint16_t* BytesRem, uint8_t** CurrConfigLoc, ComparatorPtr_t ComparatorRoutine)\r
{\r
uint8_t ErrorCode;\r
\r
uint8_t* PrevDescLoc = *CurrConfigLoc;\r
uint16_t PrevBytesRem = *BytesRem;\r
\r
- USB_Host_GetNextDescriptor(BytesRem, CurrConfigLoc);\r
+ USB_GetNextDescriptor(BytesRem, CurrConfigLoc);\r
\r
if ((ErrorCode = ComparatorRoutine(*CurrConfigLoc)) != Descriptor_Search_NotFound)\r
{\r
\r
return Descriptor_Search_Comp_EndOfDescriptor;\r
}\r
-\r
-#endif\r
#include <avr/io.h>\r
\r
#include "../../../Common/Common.h"\r
+ #include "../HighLevel/USBMode.h"\r
#include "../LowLevel/HostChapter9.h"\r
#include "../HighLevel/StdDescriptors.h"\r
\r
extern "C" {\r
#endif\r
\r
- /* Public Interface - May be used in end-application: */\r
+ /* Public Interface - May be used in end-application: */ \r
/* Macros: */\r
/** Mask for determining the type of an endpoint from an endpoint descriptor. This should then be compared\r
* with the EP_TYPE_* masks to determine the exact type of the endpoint.\r
*/\r
#define DESCRIPTOR_COMPARATOR(name) uint8_t DCOMP_##name (void* const CurrentDescriptor)\r
\r
- /** Searches for the next descriptor in the given configuration descriptor using a premade comparator\r
- * function. The routine updates the position and remaining configuration descriptor bytes values\r
- * automatically. If a comparator routine fails a search, the descriptor pointer is retreated back\r
- * so that the next descriptor search invocation will start from the descriptor which first caused the\r
- * original search to fail. This behaviour allows for one comparator to be used immediately after another\r
- * has failed, starting the second search from the descriptor which failed the first.\r
- *\r
- * \param DSize Pointer to an int storing the remaining bytes in the configuration descriptor\r
- * \param DPos Pointer to the current position in the configuration descriptor\r
- * \param DSearch Name of the comparator search function to use on the configuration descriptor\r
- *\r
- * \return Value of one of the members of the DSearch_Comp_Return_ErrorCodes_t enum\r
- *\r
- * Usage Example:\r
- * \code\r
- * DESCRIPTOR_COMPARATOR(EndpointSearcher); // Comparator Prototype\r
- *\r
- * DESCRIPTOR_COMPARATOR(EndpointSearcher)\r
- * {\r
- * if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)\r
- * return Descriptor_Search_Found;\r
- * else\r
- * return Descriptor_Search_NotFound;\r
- * }\r
- *\r
- * //...\r
- * // After retrieving configuration descriptor:\r
- * if (USB_Host_GetNextDescriptorComp(&BytesRemaining, &ConfigDescriptorData, EndpointSearcher) ==\r
- * Descriptor_Search_Comp_Found)\r
- * {\r
- * // Do something with the endpoint descriptor\r
- * }\r
- * \endcode\r
- */\r
- #define USB_Host_GetNextDescriptorComp(DSize, DPos, DSearch) \\r
- USB_Host_GetNextDescriptorComp_P(DSize, DPos, DCOMP_##DSearch)\r
+ /* Psuedo-Functions: */\r
+ #if defined(__DOXYGEN__)\r
+ /** Searches for the next descriptor in the given configuration descriptor using a premade comparator\r
+ * function. The routine updates the position and remaining configuration descriptor bytes values\r
+ * automatically. If a comparator routine fails a search, the descriptor pointer is retreated back\r
+ * so that the next descriptor search invocation will start from the descriptor which first caused the\r
+ * original search to fail. This behaviour allows for one comparator to be used immediately after another\r
+ * has failed, starting the second search from the descriptor which failed the first.\r
+ *\r
+ * \note This function is available in USB Host mode only.\r
+ *\r
+ * \param BytesRem Pointer to an int storing the remaining bytes in the configuration descriptor\r
+ * \param CurrConfigLoc Pointer to the current position in the configuration descriptor\r
+ * \param ComparatorRoutine Name of the comparator search function to use on the configuration descriptor\r
+ *\r
+ * \return Value of one of the members of the DSearch_Comp_Return_ErrorCodes_t enum\r
+ *\r
+ * Usage Example:\r
+ * \code\r
+ * DESCRIPTOR_COMPARATOR(EndpointSearcher); // Comparator Prototype\r
+ *\r
+ * DESCRIPTOR_COMPARATOR(EndpointSearcher)\r
+ * {\r
+ * if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)\r
+ * return Descriptor_Search_Found;\r
+ * else\r
+ * return Descriptor_Search_NotFound;\r
+ * }\r
+ *\r
+ * //...\r
+ * // After retrieving configuration descriptor:\r
+ * if (USB_Host_GetNextDescriptorComp(&BytesRemaining, &ConfigDescriptorData, EndpointSearcher) ==\r
+ * Descriptor_Search_Comp_Found)\r
+ * {\r
+ * // Do something with the endpoint descriptor\r
+ * }\r
+ * \endcode\r
+ */\r
+ uint8_t USB_GetNextDescriptorComp(uint16_t* BytesRem, uint8_t** CurrConfigLoc, ComparatorPtr_t ComparatorRoutine);\r
+ #else\r
+ #define USB_GetNextDescriptorComp(DSize, DPos, DSearch) USB_GetNextDescriptorComp_P(DSize, DPos, DCOMP_##DSearch)\r
+ #endif\r
+ \r
/* Enums: */\r
/** Enum for return values of a descriptor comparator made with DESCRIPTOR_COMPARATOR. */\r
enum DSearch_Return_ErrorCodes_t\r
Descriptor_Search_NotFound = 2, /**< Current descriptor does not match comparator criteria. */\r
};\r
\r
- /** Enum for return values of USB_Host_GetNextDescriptorComp() */\r
+ /** Enum for return values of USB_GetNextDescriptorComp(). */\r
enum DSearch_Comp_Return_ErrorCodes_t\r
{\r
Descriptor_Search_Comp_Found = 0, /**< Configuration descriptor now points to descriptor which matches\r
* of bytes indicated by ConfigSizePtr of the configuration descriptor will be loaded\r
* into the buffer\r
*/\r
- uint8_t USB_Host_GetDeviceConfigDescriptor(uint16_t* const ConfigSizePtr, void* BufferPtr)\r
- ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /* Inline Functions: */\r
- /** Skips over the current sub-descriptor inside the configuration descriptor, so that the pointer then\r
- points to the next sub-descriptor. The bytes remaining value is automatically decremented.\r
- *\r
- * \param BytesRem Pointer to the number of bytes remaining of the configuration descriptor\r
- * \param CurrConfigLoc Pointer to the current descriptor inside the configuration descriptor\r
- */\r
- static inline void USB_Host_GetNextDescriptor(uint16_t* const BytesRem,\r
- uint8_t** const CurrConfigLoc) \r
- ATTR_NON_NULL_PTR_ARG(1, 2); \r
- static inline void USB_Host_GetNextDescriptor(uint16_t* const BytesRem,\r
- uint8_t** const CurrConfigLoc)\r
- {\r
- #if defined(USE_NONSTANDARD_DESCRIPTOR_NAMES)\r
- uint16_t CurrDescriptorSize = DESCRIPTOR_CAST(*CurrConfigLoc, USB_Descriptor_Header_t).Size;\r
- #else\r
- uint16_t CurrDescriptorSize = DESCRIPTOR_CAST(*CurrConfigLoc, USB_Descriptor_Header_t).bLength; \r
- #endif\r
-\r
- *CurrConfigLoc += CurrDescriptorSize;\r
- *BytesRem -= CurrDescriptorSize;\r
- }\r
+ uint8_t USB_GetDeviceConfigDescriptor(uint16_t* const ConfigSizePtr, void* BufferPtr)\r
+ ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value.\r
* The bytes remaining value is automatically decremented.\r
* \param CurrConfigLoc Pointer to the current descriptor inside the configuration descriptor\r
* \param Type Descriptor type value to search for\r
*/\r
- void USB_Host_GetNextDescriptorOfType(uint16_t* const BytesRem,\r
- uint8_t** const CurrConfigLoc,\r
- const uint8_t Type)\r
- ATTR_NON_NULL_PTR_ARG(1, 2);\r
+ void USB_GetNextDescriptorOfType(uint16_t* const BytesRem,\r
+ uint8_t** const CurrConfigLoc,\r
+ const uint8_t Type)\r
+ ATTR_NON_NULL_PTR_ARG(1, 2);\r
\r
/** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value,\r
* which must come before a descriptor of the second given type value. If the BeforeType type\r
* \param Type Descriptor type value to search for\r
* \param BeforeType Descriptor type value which must not be reached before the given Type descriptor\r
*/\r
- void USB_Host_GetNextDescriptorOfTypeBefore(uint16_t* const BytesRem,\r
- uint8_t** const CurrConfigLoc,\r
- const uint8_t Type,\r
- const uint8_t BeforeType)\r
- ATTR_NON_NULL_PTR_ARG(1, 2);\r
+ void USB_GetNextDescriptorOfTypeBefore(uint16_t* const BytesRem,\r
+ uint8_t** const CurrConfigLoc,\r
+ const uint8_t Type,\r
+ const uint8_t BeforeType)\r
+ ATTR_NON_NULL_PTR_ARG(1, 2);\r
\r
/** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value,\r
* which must come after a descriptor of the second given type value. The bytes remaining value is\r
* \param Type Descriptor type value to search for\r
* \param AfterType Descriptor type value which must be reached before the given Type descriptor\r
*/\r
- void USB_Host_GetNextDescriptorOfTypeAfter(uint16_t* const BytesRem,\r
- uint8_t** const CurrConfigLoc,\r
- const uint8_t Type,\r
- const uint8_t AfterType)\r
- ATTR_NON_NULL_PTR_ARG(1, 2);\r
+ void USB_GetNextDescriptorOfTypeAfter(uint16_t* const BytesRem,\r
+ uint8_t** const CurrConfigLoc,\r
+ const uint8_t Type,\r
+ const uint8_t AfterType)\r
+ ATTR_NON_NULL_PTR_ARG(1, 2);\r
+\r
+ /* Inline Functions: */\r
+ /** Skips over the current sub-descriptor inside the configuration descriptor, so that the pointer then\r
+ points to the next sub-descriptor. The bytes remaining value is automatically decremented.\r
+ *\r
+ * \param BytesRem Pointer to the number of bytes remaining of the configuration descriptor\r
+ * \param CurrConfigLoc Pointer to the current descriptor inside the configuration descriptor\r
+ */\r
+ static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,\r
+ uint8_t** const CurrConfigLoc) \r
+ ATTR_NON_NULL_PTR_ARG(1, 2); \r
+ static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,\r
+ uint8_t** const CurrConfigLoc)\r
+ {\r
+ #if defined(USE_NONSTANDARD_DESCRIPTOR_NAMES)\r
+ uint16_t CurrDescriptorSize = DESCRIPTOR_CAST(*CurrConfigLoc, USB_Descriptor_Header_t).Size;\r
+ #else\r
+ uint16_t CurrDescriptorSize = DESCRIPTOR_CAST(*CurrConfigLoc, USB_Descriptor_Header_t).bLength; \r
+ #endif\r
+\r
+ *CurrConfigLoc += CurrDescriptorSize;\r
+ *BytesRem -= CurrDescriptorSize;\r
+ }\r
\r
/* Private Interface - For use in library only: */\r
#if !defined(__DOXYGEN__)\r
+ /* Type Defines: */\r
+ typedef uint8_t (* const ComparatorPtr_t)(void* const);\r
+\r
/* Function Prototypes: */\r
- uint8_t USB_Host_GetNextDescriptorComp_P(uint16_t* BytesRem, uint8_t** CurrConfigLoc,\r
- uint8_t (* const ComparatorRoutine)(void* const));\r
+ uint8_t USB_GetNextDescriptorComp_P(uint16_t* BytesRem, uint8_t** CurrConfigLoc, ComparatorPtr_t ComparatorRoutine);\r
#endif\r
\r
/* Disable C linkage for C++ Compilers: */\r
*\r
* \return A value in the HID_Parse_ErrorCodes_t enum\r
*/\r
- uint8_t ProcessHIDReport(const uint8_t* ReportData, uint16_t ReportSize, HID_ReportInfo_t* const ParserData)\r
- ATTR_NON_NULL_PTR_ARG(1, 3);\r
+ uint8_t USB_ProcessHIDReport(const uint8_t* ReportData, uint16_t ReportSize, HID_ReportInfo_t* const ParserData)\r
+ ATTR_NON_NULL_PTR_ARG(1, 3);\r
\r
/** Extracts the given report item's value out of the given HID report and places it into the Value\r
* member of the report item's HID_ReportItem_t structure.\r
*\r
* \returns Boolean true if the item to retrieve was located in the given report, false otherwise\r
*/\r
- bool GetReportItemInfo(const uint8_t* ReportData, HID_ReportItem_t* const ReportItem)\r
- ATTR_NON_NULL_PTR_ARG(1, 2);\r
+ bool USB_GetHIDReportItemInfo(const uint8_t* ReportData, HID_ReportItem_t* const ReportItem)\r
+ ATTR_NON_NULL_PTR_ARG(1, 2);\r
\r
/** Retrieves the given report item's value out of the Value member of the report item's\r
* HID_ReportItem_t structure and places it into the correct position in the HID report\r
* \param ReportData Buffer holding the current OUT report data\r
* \param ReportItem Pointer to the report item of interest in a HID_ReportInfo_t ReportItem array\r
*/\r
- void SetReportItemInfo(uint8_t* ReportData, const HID_ReportItem_t* ReportItem)\r
- ATTR_NON_NULL_PTR_ARG(1, 2);\r
+ void USB_SetHIDReportItemInfo(uint8_t* ReportData, const HID_ReportItem_t* ReportItem)\r
+ ATTR_NON_NULL_PTR_ARG(1, 2);\r
\r
/* Private Interface - For use in library only: */\r
#if !defined(__DOXYGEN__)\r
/** \ingroup Group_USB\r
* @defgroup Group_USBInterrupt Endpoint and Pipe Interrupts\r
*\r
- * Main USB interrupt vector handler. This file manages the main USB interrupt vector, for handling such\r
- * events as VBUS interrupts (on supported USB AVR models), device connections and disconnections, etc.\r
- * as well as providing easy to use macros for the management of the Endpoint/Pipe interrupt vector.\r
+ * This module manages the main USB interrupt vector, for handling such events as VBUS interrupts\r
+ * (on supported USB AVR models), device connections and disconnections, etc. as well as providing\r
+ * easy to use macros for the management of the unified Endpoint/Pipe interrupt vector.\r
*\r
* @{\r
*/\r
* - The Pipe_Ignore_Word() function has been renamed to Pipe_Discard_Word() to remain consistent with the rest of the pipe API.\r
* - It is no longer needed to manually include the headers from LUFA/Drivers/USB/Class, as they are now included along with the rest\r
* of the USB headers when LUFA/Drivers/USB/USB.h is included.\r
+ * - Functions in the ConfigDescriptor.h header file no longer have "Host_" as part of their names.\r
+ * - The ProcessHIDReport() has been renamed to USB_ProcessHIDReport(), GetReportItemInfo() has been renamed to USB_GetHIDReportItemInfo()\r
+ * and SetReportItemInfo() has been renamed to USB_GetHIDReportItemInfo().\r
*\r
*\r
* \section Sec_Migration090401 Migrating from 090209 to 090401\r
projects / pub / lufa.git / commitdiff