Fix LUFA event list generation rule in the main LUFA makefile (thanks to Thomas Bleeker).

[pub/lufa.git] / LUFA / ManPages / CompileTimeTokens.txt

diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt
index 130a2e8..8213c67 100644 (file)
--- a/LUFA/ManPages/CompileTimeTokens.txt
+++ b/LUFA/ManPages/CompileTimeTokens.txt
@@ -23,17 +23,6 @@
  *  \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
  *  \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
  *  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
  *  <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


@@ -62,6 +51,13 @@
  *  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
  *  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> - ( \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
  *  \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
  *  \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


@@ -76,12 +72,6 @@
  *  <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_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
  *  <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


@@ -95,19 +85,21 @@
  *  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
  *  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
  *  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
+ *  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
  *\r

- *  <b>HOST_STATE_AS_GPIOR1</b> - ( \ref Group_Host ) \n\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
  *  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
  *\r

- *  <b>TOTAL_NUM_CONFIGURATIONS</b> - ( \ref Group_Device ) \n\r
+ *  <b>FIXED_NUM_CONFIGURATIONS</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, this value may be fixed via this token in the project\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


@@ -170,8 +162,8 @@
  *  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
  *  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
+ *  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
  *  <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
  *\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