LUFA/ManPages/CompileTimeTokens.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \page Page_TokenSummary Summary of Compile Tokens
   8  *
   9  *  The following lists all the possible tokens which can be defined in a project makefile, and passed to the
  10  *  compiler via the -D switch, to alter the LUFA library code. These tokens may alter the library behaviour,
  11  *  or remove features unused by a given application in order to save flash space.
  12  *
  13  *
  14  *  \section Sec_SummaryNonUSBTokens Non USB Related Tokens
  15  *  This section describes compile tokens which affect non-USB sections of the LUFA library.
  16  *
  17  *  <b>DISABLE_TERMINAL_CODES</b> - ( \ref Group_Terminal ) \n
  18  *  If an application contains ANSI terminal control codes listed in TerminalCodes.h, it might be desired to remove them
  19  *  at compile time for use with a terminal which is non-ANSI control code aware, without modifying the source code. If
  20  *  this token is defined, all ANSI control codes in the application code from the TerminalCodes.h header are removed from
  21  *  the source code at compile time.
  22  *
  23  *  \section Sec_SummaryUSBClassTokens USB Class Driver Related Tokens
  24  *  This section describes compile tokens which affect USB class-specific drivers in the LUFA library.
  25  *
  26  *  <b>HID_ENABLE_FEATURE_PROCESSING</b> - ( \ref Group_HIDParser ) \n
  27  *  Define this token to enable the processing of FEATURE HID report items, if any, into the processed HID structure.
  28  *  By default FEATURE items (which are device features settable by the host but not directly visible by the user) are
  29  *  skipped when processing a device HID report.
  30  *
  31  *  <b>HID_INCLUDE_CONSTANT_DATA_ITEMS</b> - ( \ref Group_HIDParser ) \n
  32  *  By default, constant data items (usually used as spacers to align separate report items to a byte or word boundary)
  33  *  in the HID report are skipped during report processing. It is highly unusual for an application to make any use of
  34  *  constant data items (as they do not carry any useful data and only occupy limited RAM) however if required defining
  35  *  this switch will put constant data items into the processed HID report structure.
  36  *
  37  *  <b>HID_STATETABLE_STACK_DEPTH</b> - ( \ref Group_HIDParser ) \n
  38  *  HID reports may contain PUSH and POP elements, to store and retrieve the current HID state table onto a stack. This
  39  *  allows for reports to save the state table before modifying it slightly for a data item, and then restore the previous
  40  *  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
  41  *  table stack. If not defined, this defaults to the value indicated in the HID.h file documentation.
  42  *
  43  *  <b>HID_USAGE_STACK_DEPTH</b> - ( \ref Group_HIDParser ) \n
  44  *  HID reports generally contain many USAGE elements, which are assigned to INPUT, OUTPUT and FEATURE items in succession
  45  *  when multiple items are defined at once (via REPORT COUNT elements). This allows for several items to be defined with
  46  *  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
  47  *  usage stack, indicating the maximum number of USAGE items which can be stored temporarily until the next INPUT, OUTPUT
  48  *  and FEATURE item. If not defined, this defaults to the value indicated in the HID.h file documentation.
  49  *
  50  *  <b>HID_MAX_COLLECTIONS</b> - ( \ref Group_HIDParser ) \n
  51  *  HID reports generally contain several COLLECTION elements, used to group related data items together. Collection information
  52  *  is stored separately in the processed usage structure (and referred to by the data elements in the structure) to save space.
  53  *  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
  54  *  parser into the resultant processed report structure. If not defined, this defaults to the value indicated in the HID.h file
  55  *  documentation.
  56  *
  57  *  <b>HID_MAX_REPORTITEMS</b> - ( \ref Group_HIDParser ) \n
  58  *  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
  59  *  device. Each item has associated usages, bit offsets in the item reports and other associated data indicating the manner in which
  60  *  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
  61  *  data elements which can be stored in the processed HID report structure, including INPUT, OUTPUT and (if enabled) FEATURE items.
  62  *  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
  63  *  processed HID report table. If not defined, this defaults to the value indicated in the HID.h file documentation.
  64  *
  65  *
  66  *  \section Sec_SummaryUSBTokens USB Driver Related Tokens
  67  *  This section describes compile tokens which affect USB driver stack as a whole in the LUFA library.
  68  *
  69  *  <b>USE_RAM_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n
  70  *  Define this token to indicate to the USB driver that all device descriptors are stored in RAM, rather than being located in any one
  71  *  of the AVR's memory spaces. RAM descriptors may be desirable in applications where the descriptors need to be modified at runtime.
  72  *
  73  *  <b>USE_FLASH_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n
  74  *  Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's FLASH memory rather than RAM.
  75  *
  76  *  <b>USE_EEPROM_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n
  77  *  Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's EEPROM memory rather than RAM.
  78  *
  79  *  <b>USE_NONSTANDARD_DESCRIPTOR_NAMES</b> - ( \ref Group_Descriptors ) \n
  80  *  The USB 2.0 standard gives some rather obscure names for the elements in the standard descriptor types (device, configuration,
  81  *  string, endpoint, etc.). By default the LUFA library uses these names in its predefined descriptor structure types for
  82  *  compatibility. If this token is defined, the structure element names are switched to the LUFA-specific but more descriptive
  83  *  names documented in the StdDescriptors.h source file.
  84  *
  85  *  <b>NO_INTERNAL_SERIAL</b> - ( \ref Group_Descriptors ) \n
  86  *  Some AVR models contain a unique 20-digit serial number which can be used as the device serial number, while in device mode. This
  87  *  allows the host to uniquely identify the device regardless of if it is moved between USB ports on the same computer, allowing
  88  *  allocated resources (such as drivers, COM Port number allocations) to be preserved. This is not needed in many apps, and so the
  89  *  code that performs this task can be disabled by defining this option and passing it to the compiler via the -D switch.
  90  *
  91  *  <b>FIXED_CONTROL_ENDPOINT_SIZE</b> - ( \ref Group_EndpointManagement ) \n
  92  *  By default, the library determines the size of the control endpoint (when in device mode) by reading the device descriptor.
  93  *  Normally this reduces the amount of configuration required for the library, allows the value to change dynamically (if
  94  *  descriptors are stored in EEPROM or RAM rather than flash memory) and reduces code maintenance. However, this token can be
  95  *  defined to a non-zero value instead to give the size in bytes of the control endpoint, to reduce the size of the compiled
  96  *  binary.
  97  *
  98  *  <b>TOTAL_NUM_CONFIGURATIONS</b> - ( \ref Group_Device ) \n
  99  *  By default, the library determines the number of configurations a USB device supports by reading the device descriptor. This reduces
 100  *  the amount of configuration required to set up the library, and allows the value to change dynamically (if descriptors are stored in
 101  *  EEPROM or RAM rather than flash memory) and reduces code maintenance. However, this value may be fixed via this token in the project
 102  *  makefile to reduce the compiled size of the binary at the expense of flexibility.
 103  *
 104  *  <b>CONTROL_ONLY_DEVICE</b> \n
 105  *  In some limited USB device applications, there are no device endpoints other than the control endpoint; i.e. all device communication
 106  *  is through control endpoint requests. Defining this token will remove several features related to the selection and control of device
 107  *  endpoints internally, saving space. Generally, this is usually only useful in (some) bootloaders and is best avoided.
 108  *
 109  *  <b>NO_STREAM_CALLBACKS</b> - ( \ref Group_EndpointPacketManagement , \ref Group_PipePacketManagement )\n
 110  *  Both the endpoint and the pipe driver code contains stream functions, allowing for arrays of data to be sent to or from the
 111  *  host easily via a single function call (rather than complex routines worrying about sending full packets, waiting for the endpoint/
 112  *  pipe to become ready, etc.). By default, these stream functions require a callback function which is executed after each byte processed,
 113  *  allowing for early-aborts of stream transfers by the application. If callbacks are not required in an application, they can be removed
 114  *  by defining this token, reducing the compiled binary size. When removed, the stream functions no longer accept a callback function as
 115  *  a parameter.
 116  *
 117  *  <b>FAST_STREAM_TRANSFERS</b> - ( \ref Group_EndpointPacketManagement , \ref Group_PipePacketManagement )\n
 118  *  By default, streams are transferred internally via a loop, sending or receiving one byte per iteration before checking for a bank full
 119  *  or empty condition. This allows for multiple stream functions to be chained together easily, as there are no alignment issues. However,
 120  *  this can lead to heavy performance penalties in applications where large streams are used frequently. When this compile time option is
 121  *  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
 122  *  due to the extra code required to deal with byte alignment.
 123  *
 124  *  <b>USB_HOST_TIMEOUT_MS</b> - ( \ref Group_Host ) \n
 125  *  When a control transfer is initiated in host mode to an attached device, a timeout is used to abort the transfer if the attached
 126  *  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
 127  *  control transfers, specified in milliseconds. If not defined, the default value specified in Host.h is used instead.
 128  *
 129  *  <b>HOST_DEVICE_SETTLE_DELAY_MS</b> - ( \ref Group_Host ) \n
 130  *  Some devices require a delay of up to 5 seconds after they are connected to VBUS before the enumeration process can be started, or
 131  *  they will fail to enumerate correctly. By placing a delay before the enumeration process, it can be ensured that the bus has settled
 132  *  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
 133  *  settle period, specified in milliseconds. If not defined, the default value specified in Host.h is used instead.
 134  *
 135  *  <b>USE_STATIC_OPTIONS</b> - ( \ref Group_USBManagement ) \n
 136  *  By default, the USB_Init() function accepts dynamic options at runtime to alter the library behaviour, including whether the USB pad
 137  *  voltage regulator is enabled, and the device speed when in device mode. By defining this token to a mask comprised of the USB options
 138  *  mask defines usually passed as the Options parameter to USB_Init(), the resulting compiled binary can be decreased in size by removing
 139  *  the dynamic options code, and replacing it with the statically set options. When defined, the USB_Init() function no longer accepts an
 140  *  Options parameter.
 141  *
 142  *  <b>USB_DEVICE_ONLY</b> - ( \ref Group_USBManagement ) \n
 143  *  For the USB AVR models supporting both device and host USB modes, the USB_Init() function contains a Mode parameter which specifies the
 144  *  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
 145  *  save space. When defined, the USB_Init() function no longer accepts a Mode parameter. This define is irrelevant on smaller USB AVRs which
 146  *  do not support host mode.
 147  *
 148  *  <b>USB_HOST_ONLY</b> - ( \ref Group_USBManagement ) \n
 149  *  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.
 150  *
 151  *  <b>USB_STREAM_TIMEOUT_MS</b> - ( \ref Group_USBManagement ) \n
 152  *  When endpoint and/or pipe stream functions are used, by default there is a timeout between each transfer which the connected device or host
 153  *  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
 154  *  period for stream transfers, specified in milliseconds. If not defined, the default value specified in LowLevel.h is used instead.
 155  *
 156  *  <b>NO_LIMITED_CONTROLLER_CONNECT</b> - ( \ref Group_Events ) \n
 157  *  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
 158  *  VBUS events, the library attempts to determine the connection state via the bus suspension and wake up events instead. This however may be
 159  *  slightly inaccurate due to the possibility of the host suspending the bus while the device is still connected. If accurate connection status is
 160  *  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
 161  *  can be accurately set and the USB_Connect and USB_Disconnect events manually raised by the RAISE_EVENT macro. When defined, this token disables
 162  *  the library's auto-detection of the connection state by the aforementioned suspension and wake up events.
 163  *
 164  *  <b>INTERRUPT_CONTROL_ENDPOINT</b> - ( \ref Group_USBManagement ) \n
 165  *  Some applications prefer to not call the USB_USBTask() management task reguarly while in device mode, as it can complicate code significantly.
 166  *  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
 167  *  endpoint entirely via interrupts asynchronously to the user application.
 168  */