X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/32f0f605efa293430a47d60bb857695ff6937d21..d47df1cd3a340306255b26a7112d7ff7fa6cd4e4:/LUFA/CompileTimeTokens.txt
diff --git a/LUFA/CompileTimeTokens.txt b/LUFA/CompileTimeTokens.txt
index bb235e172..dcb5816de 100644
--- a/LUFA/CompileTimeTokens.txt
+++ b/LUFA/CompileTimeTokens.txt
@@ -20,19 +20,6 @@
* this token is defined, all ANSI control codes in the application code from the TerminalCodes.h header are removed from
* the source code at compile time.
*
- * NUM_BLOCKS - ( \ref Group_MemoryAllocator ) \n
- * Sets the number of allocable blocks in the pseudo-heap of the dynamic memory allocation driver. This should be
- * defined as a constant larger than zero.
- *
- * BLOCK_SIZE - ( \ref Group_MemoryAllocator ) \n
- * Sets the size of each allocable block in the pseudo-heap of the dynamic memory allocation driver. This should be
- * defined as a constant larger than zero.
- *
- * NUM_HANDLES - ( \ref Group_MemoryAllocator ) \n
- * Sets the maximum number of managed memory handles which can be handed out by the dynamic memory allocation driver
- * simultaneously, before a handle (and its associated allocated memory) must be freed.
- *
- *
* \section Sec_SummaryUSBClassTokens USB Class Driver Related Tokens
* This section describes compile tokens which affect USB class-specific drivers in the LUFA library.
*
@@ -50,27 +37,27 @@
* HID_STATETABLE_STACK_DEPTH - ( \ref Group_HIDParser ) \n
* HID reports may contain PUSH and POP elements, to store and retrieve the current HID state table onto a stack. This
* allows for reports to save the state table before modifying it slightly for a data item, and then restore the previous
- * state table in a compact manner. This token may be defined to a non-zero value to give the maximum depth of the state
+ * 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
* table stack. If not defined, this defaults to the value indicated in the HID.h file documentation.
*
* HID_USAGE_STACK_DEPTH - ( \ref Group_HIDParser ) \n
* HID reports generally contain many USAGE elements, which are assigned to INPUT, OUTPUT and FEATURE items in succession
* when multiple items are defined at once (via REPORT COUNT elements). This allows for several items to be defined with
- * different usages in a compact manner. This token may be defined to a non-zero value to set the maximum depth of the
+ * 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
* usage stack, indicating the maximum number of USAGE items which can be stored temporarily until the next INPUT, OUTPUT
* and FEATURE item. If not defined, this defaults to the value indicated in the HID.h file documentation.
*
* HID_MAX_COLLECTIONS - ( \ref Group_HIDParser ) \n
* HID reports generally contain several COLLECTION elements, used to group related data items together. Collection information
* is stored separately in the processed usage structure (and referred to by the data elements in the structure) to save space.
- * This token may be defined to a non-zero value to set the maximum number of COLLECTION items which can be processed by the
+ * 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
* parser into the resultant processed report structure. If not defined, this defaults to the value indicated in the HID.h file
* documentation.
*
* HID_MAX_REPORTITEMS - ( \ref Group_HIDParser ) \n
* 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
* device. Each item has associated usages, bit offsets in the item reports and other associated data indicating the manner in which
- * 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
+ * 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
* data elements which can be stored in the processed HID report structure, including INPUT, OUTPUT and (if enabled) FEATURE items.
* 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
* processed HID report table. If not defined, this defaults to the value indicated in the HID.h file documentation.
@@ -121,14 +108,14 @@
*
* USB_HOST_TIMEOUT_MS - ( \ref Group_Host ) \n
* When a control transfer is initiated in host mode to an attached device, a timeout is used to abort the transfer if the attached
- * device fails to respond within the timeout period. This token may be defined to a non-zero value to set the timeout period for
+ * 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
* control transfers, specified in milliseconds. If not defined, the default value specified in Host.h is used instead.
*
* HOST_DEVICE_SETTLE_DELAY_MS - ( \ref Group_Host ) \n
* Some devices require a delay of up to 5 seconds after they are connected to VBUS before the enumeration process can be started, or
* they will fail to enumerate correctly. By placing a delay before the enumeration process, it can be ensured that the bus has settled
- * back to a known idle state before communications occur with the device. This token may be defined to a non-zero value to set the
- * device settle period, specified in milliseconds. If not defined, the default value specified in Host.h is used instead.
+ * back to a known idle state before communications occur with the device. This token may be defined to a non-zero 16-bit value to set
+ * the device settle period, specified in milliseconds. If not defined, the default value specified in Host.h is used instead.
*
* USE_STATIC_OPTIONS - ( \ref Group_USBManagement ) \n
* By default, the USB_Init() function accepts dynamic options at runtime to alter the library behaviour, including whether the USB pad
@@ -148,7 +135,7 @@
*
* USB_STREAM_TIMEOUT_MS - ( \ref Group_USBManagement ) \n
* When endpoint and/or pipe stream functions are used, by default there is a timeout between each transfer which the connected device or host
- * must satisfy, or the stream function aborts the remaining data transfer. This token may be defined to a non-zero value to set the timeout
+ * 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
* period for stream transfers, specified in milliseconds. If not defined, the default value specified in LowLevel.h is used instead.
*
* NO_LIMITED_CONTROLLER_CONNECT - ( \ref Group_Events ) \n