More minor renaming of library enums and events to try to create a consistent API.
[pub/lufa.git] / LUFA / CompileTimeTokens.txt
index 371c2c7..e3afc59 100644 (file)
  *  the source code at compile time.\r
  *\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
+ *  Sets the number of allocable blocks in the pseudo-heap of the dynamic memory allocation driver. This should be\r
  *  defined as a constant larger than zero.\r
  *\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
+ *  Sets the size of each allocable block in the pseudo-heap of the dynamic memory allocation driver. This should be\r
  *  defined as a constant larger than zero.\r
  *\r
  *  <b>NUM_HANDLES</b> - ( \ref Group_MemoryAllocator ) \n\r
@@ -42,7 +42,7 @@
  *  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 seperate report items to a byte or word boundary)\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
  *  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
+ *  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
  *  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
+ *  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 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
@@ -71,8 +71,8 @@
  *  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
- *  data elements which can be stored in the processed HID report strucuture, including INPUT, OUTPUT and (if enabled) FEATURE items.\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 seperately in the\r
+ *  data elements which can be stored in the processed HID report structure, including INPUT, OUTPUT and (if enabled) FEATURE items.\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
  *\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> - ( \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
- *  to optimize the endpoint configuration routine for constant inputs, to reduce the size of the compiled binary at the expense of\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
+ *  binary.\r
  *\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
  *  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> \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 and is best avoided.\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
+ *  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
  *  <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
+ *  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
  *  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
  *  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 aformentioned suspension and wake up events.\r
+ *  the library's auto-detection of the connection state by the aforementioned suspension and wake up events.\r
  */\r