* 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
+ *\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> - ( \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> - ( \ref Group_HIDParser ) \n\r
- * By default, constant data items (usually used as spacers to align separate 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> - ( \ref Group_HIDParser ) \n\r
+ * <b>HID_HOST_BOOT_PROTOCOL_ONLY</b> - ( \ref Group_USBClassHIDHost ) \n\r
+ * By default, the USB HID Host class driver is designed to work with HID devices using either the Boot or Report HID\r
+ * communication protocols. On devices where the Report protocol is not used (i.e. in applications where only basic\r
+ * Mouse or Keyboard operation is desired, using boot compatible devices), the code responsible for the Report protocol\r
+ * mode can be removed to save space in the compiled application by defining this token. When defined, it is still neccesary\r
+ * to explicitly put the attached device into Boot protocol mode via a call to \ref HID_Host_SetBootProtocol().\r
+ * \r
+ * <b>HID_STATETABLE_STACK_DEPTH</b>=<i>x</i> - ( \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 8-bit 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> - ( \ref Group_HIDParser ) \n\r
+ * <b>HID_USAGE_STACK_DEPTH</b>=<i>x</i> - ( \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 8-bit value to set the maximum depth of the\r
* usage stack, indicating the maximum number of USAGE items which can be stored temporarily 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> - ( \ref Group_HIDParser ) \n\r
+ * <b>HID_MAX_COLLECTIONS</b>=<i>x</i> - ( \ref Group_HIDParser ) \n\r
* HID reports generally contain several COLLECTION elements, used to group related data items together. Collection information\r
* is stored separately 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 8-bit 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> - ( \ref Group_HIDParser ) \n\r
+ * <b>HID_MAX_REPORTITEMS</b>=<i>x</i> - ( \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 8-bit value to set the maximum number of\r
* If a item has a multiple count (i.e. a REPORT COUNT of more than 1), each item in the report count is placed separately in the\r
* processed HID report table. If not defined, this defaults to the value indicated in the HID.h file documentation.\r
*\r
+ * <b>HID_MAX_REPORT_IDS</b>=<i>x</i> - ( \ref Group_HIDParser ) \n\r
+ * HID reports may contain several report IDs, to logically distinguish grouped device data from one another - for example, a combination\r
+ * keyboard and mouse might use report IDs to seperate the keyboard reports from the mouse reports. In order to determine the size of each\r
+ * report, and thus know how many bytes must be read or written, the size of each report (IN, OUT and FEATURE) must be calculated and\r
+ * stored. This token may be defined to a non-zero 8-bit value to set the maximum number of report IDs in a device which can be processed\r
+ * and their sizes calculated/stored into the resultant processed report structure. If not defined, this defaults to the value indicated in\r
+ * the HID.h file documentation.\r
+ *\r
*\r
- * \section Sec_SummaryUSBTokens USB Driver Related Tokens\r
+ * \section Sec_SummaryUSBTokens General 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>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
+ * allowing for early-aborts of stream transfers by the application. If callbacks are not required in an application, they can be removed\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>FAST_STREAM_TRANSFERS</b> - ( \ref Group_EndpointPacketManagement , \ref Group_PipePacketManagement )\n\r
+ * By default, streams are transferred internally via a loop, sending or receiving one byte per iteration before checking for a bank full\r
+ * or empty condition. This allows for multiple stream functions to be chained together easily, as there are no alignment issues. However,\r
+ * this can lead to heavy performance penalties in applications where large streams are used frequently. When this compile time option is\r
+ * used, bytes are sent or recevied in groups of 8 bytes at a time increasing performance at the expense of a larger flash memory consumption\r
+ * due to the extra code required to deal with byte alignment.\r
+ *\r
+ * <b>USE_STATIC_OPTIONS</b>=<i>x</i> - ( \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> - ( \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 irrelevant on smaller USB AVRs which\r
+ * do not support host mode.\r
+ *\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>=<i>x</i> - ( \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 16-bit 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> - ( \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
+ * required, the VBUS line of the USB connector should be routed to an AVR pin to detect its level, so that the USB_DeviceState global\r
+ * can be accurately set and the \ref EVENT_USB_Device_Connect() and \ref EVENT_USB_Device_Disconnect() events manually raised by the RAISE_EVENT macro.\r
+ * When defined, this token disables the library's auto-detection of the connection state by the aforementioned suspension and wake up events.\r
+ *\r
+ *\r
+ * \section Sec_SummaryUSBDeviceTokens USB Device Mode Driver Related Tokens\r
+ * This section describes compile tokens which affect USB driver stack of the LUFA library when used in Device mode.\r
+ *\r
* <b>USE_RAM_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n\r
* Define this token to indicate to the USB driver that all device descriptors are stored in RAM, rather than being located in any one\r
* of the AVR's memory spaces. RAM descriptors may be desirable in applications where the descriptors need to be modified at runtime.\r
* <b>USE_EEPROM_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n\r
* Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's EEPROM memory rather than RAM.\r
*\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>NO_INTERNAL_SERIAL</b> - ( \ref Group_Descriptors ) \n\r
* Some AVR models contain a unique 20-digit serial number which can be used as the device serial number, while in device mode. This\r
* allows the host to uniquely identify the device regardless of if it is moved between USB ports on the same computer, allowing\r
* allocated resources (such as drivers, COM Port number allocations) to be preserved. This is not needed in many apps, and so the\r
* code that performs this task can be disabled by defining this option and passing it to the compiler via the -D switch.\r
*\r
- * <b>FIXED_CONTROL_ENDPOINT_SIZE</b> - ( \ref Group_EndpointManagement ) \n\r
+ * <b>FIXED_CONTROL_ENDPOINT_SIZE</b>=<i>x</i> - ( \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.\r
*\r
- * <b>DEVICE_STATE_AS_GPIOR0</b> - ( \ref Group_Device ) \n\r
+ * <b>DEVICE_STATE_AS_GPIOR</b> - ( \ref Group_Device ) \n\r
* One of the most frequenty used global variables in the stack is the USB_DeviceState global, which indicates the current state of\r
* the Device State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token\r
- * make be defined to fix the state variable into one of the three general purpose IO registers inside the AVR reserved for application\r
- * use. When defined, the GPIOR0 register should not be used within the user application except implicitly via the library APIs.\r
- *\r
- * <b>HOST_STATE_AS_GPIOR1</b> - ( \ref Group_Host ) \n\r
- * One of the most frequenty used global variables in the stack is the USB_HostState global, which indicates the current state of\r
- * the Host State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token\r
- * make be defined to fix the state variable into one of the three general purpose IO registers inside the AVR reserved for application\r
- * use. When defined, the GPIOR1 register should not be used within the user application except implicitly via the library APIs.\r
+ * may be defined to a value between 0 and 2 to fix the state variable into one of the three general purpose IO registers inside the AVR\r
+ * reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except\r
+ * implicitly via the library APIs.\r
*\r
- * <b>TOTAL_NUM_CONFIGURATIONS</b> - ( \ref Group_Device ) \n\r
+ * <b>FIXED_NUM_CONFIGURATIONS</b>=<i>x</i> - ( \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, this value may be fixed via this token in the project\r
* is through control endpoint requests. Defining this token will remove several features related to the selection and control of device\r
* endpoints internally, saving space. Generally, this is usually only useful in (some) bootloaders and is best avoided.\r
*\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
- * allowing for early-aborts of stream transfers by the application. If callbacks are not required in an application, they can be removed\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
+ * <b>INTERRUPT_CONTROL_ENDPOINT</b> - ( \ref Group_USBManagement ) \n\r
+ * Some applications prefer to not call the USB_USBTask() management task reguarly while in device mode, as it can complicate code significantly.\r
+ * Instead, when device mode is used this token can be passed to the library via the -D switch to allow the library to manage the USB control\r
+ * endpoint entirely via USB controller interrupts asynchronously to the user application. When defined, USB_USBTask() does not need to be called\r
+ * when in USB device mode.\r
+ *\r
+ * <b>NO_DEVICE_REMOTE_WAKEUP</b> - (\ref Group_Device ) \n\r
+ * Many devices do not require the use of the Remote Wakeup features of USB, used to wake up the USB host when suspended. On these devices,\r
+ * the code required to manage device Remote Wakeup can be disabled by defining this token and passing it to the library via the -D switch.\r
+ *\r
+ * <b>NO_DEVICE_SELF_POWER</b> - (\ref Group_Device ) \n\r
+ * USB devices may be bus powered, self powered, or a combination of both. When a device can be both bus powered and self powered, the host may\r
+ * query the device to determine the current power source, via \ref USB_CurrentlySelfPowered. For solely bus powered devices, this global and the\r
+ * code required to manage it may be disabled by passing this token to the library via the -D switch.\r
*\r
- * <b>FAST_STREAM_TRANSFERS</b> - ( \ref Group_EndpointPacketManagement , \ref Group_PipePacketManagement )\n\r
- * By default, streams are transferred internally via a loop, sending or receiving one byte per iteration before checking for a bank full\r
- * or empty condition. This allows for multiple stream functions to be chained together easily, as there are no alignment issues. However,\r
- * this can lead to heavy performance penalties in applications where large streams are used frequently. When this compile time option is\r
- * used, bytes are sent or recevied in groups of 8 bytes at a time increasing performance at the expense of a larger flash memory consumption\r
- * due to the extra code required to deal with byte alignment.\r
*\r
- * <b>USB_HOST_TIMEOUT_MS</b> - ( \ref Group_Host ) \n\r
+ * \section Sec_SummaryUSBHostTokens USB Host Mode Driver Related Tokens\r
+ *\r
+ * This section describes compile tokens which affect USB driver stack of the LUFA library when used in Host mode.\r
+ *\r
+ * <b>HOST_STATE_AS_GPIOR</b> - ( \ref Group_Host ) \n\r
+ * One of the most frequenty used global variables in the stack is the USB_HostState global, which indicates the current state of\r
+ * the Host State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token\r
+ * may be defined to a value between 0 and 2 to fix the state variable into one of the three general purpose IO registers inside the AVR\r
+ * reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except\r
+ * implicitly via the library APIs.\r
+ *\r
+ * <b>USB_HOST_TIMEOUT_MS</b>=<i>x</i> - ( \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 16-bit 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> - ( \ref Group_Host ) \n\r
+ * <b>HOST_DEVICE_SETTLE_DELAY_MS</b>=<i>x</i> - ( \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 16-bit value to set the device\r
* 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> - ( \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> - ( \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 irrelevant on smaller USB AVRs which\r
- * do not support host mode.\r
- *\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> - ( \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 16-bit 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> - ( \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
- * required, the VBUS line of the USB connector should be routed to an AVR pin to detect its level, so that the USB_DeviceState global\r
- * can be accurately set and the USB_Connect and USB_Disconnect events manually raised by the RAISE_EVENT macro. When defined, this token disables\r
- * the library's auto-detection of the connection state by the aforementioned suspension and wake up events.\r
- *\r
- * <b>INTERRUPT_CONTROL_ENDPOINT</b> - ( \ref Group_USBManagement ) \n\r
- * Some applications prefer to not call the USB_USBTask() management task reguarly while in device mode, as it can complicate code significantly.\r
- * Instead, when device mode is used this token can be passed to the library via the -D switch to allow the library to manage the USB control\r
- * endpoint entirely via interrupts asynchronously to the user application.\r
*/\r
projects / pub / lufa.git / blobdiff