Fixed Device mode HID Class driver not explicitly initializing the ReportSize paramet...

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

diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt
index f11dff2..387af21 100644 (file)
--- a/LUFA/ManPages/CompileTimeTokens.txt
+++ b/LUFA/ManPages/CompileTimeTokens.txt
@@ -95,7 +95,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
- *  <b>TOTAL_NUM_CONFIGURATIONS</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
+ *  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>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>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
@@ -158,8 +172,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
- *  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