Added new Pipe_BoundEndpointNumber() and Pipe_IsEndpointBound() functions.
[pub/lufa.git] / LUFA / ManPages / CompileTimeTokens.txt
index 3d15759..f11dff2 100644 (file)
  *  This section describes compile tokens which affect USB driver stack as a whole in the LUFA library.\r
  *\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
+ *  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
+ *\r
+ *  <b>USE_FLASH_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n\r
+ *  Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's FLASH memory rather than RAM.\r
  *\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
+ *  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
  *  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>USE_SINGLE_DEVICE_CONFIGURATION</b> - ( \ref Group_Device ) \n\r
+ *  <b>TOTAL_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, 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
+ *  EEPROM or RAM rather than flash memory) and reduces code maintenance. However, this value may be fixed via this token in the project\r
+ *  makefile to reduce the compiled size of the binary at the expense of flexibility.\r
  *\r
  *  <b>CONTROL_ONLY_DEVICE</b> \n\r
  *  In some limited USB device applications, there are no device endpoints other than the control endpoint; i.e. all device communication\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_IsConnected global\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