Added USE_INTERNAL_SERIAL compile time option to automatically read out the internal...

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

diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt
index d8a7cf7..e1f248d 100644 (file)
--- a/LUFA/ManPages/CompileTimeTokens.txt
+++ b/LUFA/ManPages/CompileTimeTokens.txt
@@ -80,6 +80,14 @@
  *  compatibility. If this token is defined, the structure element names are switched to the LUFA-specific but more descriptive\r
  *  names documented in the StdDescriptors.h source file.\r
  *\r
+ *  <b>USE_INTERNAL_SERIAL</b> - ( \ref Group_Descriptors ) \n\r
+ *  Some AVR models contain a unique 20-digit serial number which can be used as the device serial number, while in device mode. This\r
+ *  allows the host to uniquely identify the device regardless of if it is moved between USB ports on the same computer, allowing\r
+ *  allocated resources (such as drivers, COM Port number allocations) to be preserved. To make the library use this value for the\r
+ *  device's serial number, define this token in the project makefile, set it to a unique string descriptor index (i.e. one not used\r
+ *  elsewhere in the device for a string descriptor) and set the Device Descriptor's serial number descriptor index entry to the\r
+ *  USE_INTERNAL_SERIAL value.\r
+ *\r
  *  <b>FIXED_CONTROL_ENDPOINT_SIZE</b> - ( \ref Group_EndpointManagement ) \n\r
  *  By default, the library determines the size of the control endpoint (when in device mode) by reading the device descriptor.\r
  *  Normally this reduces the amount of configuration required for the library, allows the value to change dynamically (if\r