Remove MIDI ClassDriver device demo's accidental inclusion of the unused ADC peripher...

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

diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt
index 6f2e804..d74cb43 100644 (file)
--- a/LUFA/ManPages/CompileTimeTokens.txt
+++ b/LUFA/ManPages/CompileTimeTokens.txt
@@ -7,7 +7,7 @@
 /** \page Page_TokenSummary Summary of Compile Tokens
  *
  *  The following lists all the possible tokens which can be defined in a project makefile, and passed to the
- *  compiler via the -D switch, to alter the LUFA library code. These tokens may alter the library behavior,
+ *  compiler via the -D switch, to alter the LUFA library code. These tokens may alter the library behaviour,
  *  or remove features unused by a given application in order to save flash space.
  *
  *
@@ -87,7 +87,7 @@
  *  due to the extra code required to deal with byte alignment.
  *
  *  <b>USE_STATIC_OPTIONS</b>=<i>x</i> - ( \ref Group_USBManagement ) \n
- *  By default, the USB_Init() function accepts dynamic options at runtime to alter the library behavior, including whether the USB pad
+ *  By default, the USB_Init() function accepts dynamic options at runtime to alter the library behaviour, including whether the USB pad
  *  voltage regulator is enabled, and the device speed when in device mode. By defining this token to a mask comprised of the USB options
  *  mask defines usually passed as the Options parameter to USB_Init(), the resulting compiled binary can be decreased in size by removing
  *  the dynamic options code, and replacing it with the statically set options. When defined, the USB_Init() function no longer accepts an
@@ -115,6 +115,11 @@
  *  can be accurately set and the \ref EVENT_USB_Device_Connect() and \ref EVENT_USB_Device_Disconnect() events manually raised by the RAISE_EVENT macro.
  *  When defined, this token disables the library's auto-detection of the connection state by the aforementioned suspension and wake up events.
  *
+ *  <b>NO_SOF_EVENTS</b> - ( \ref Group_Events ) \n
+ *  By default, there exists a LUFA application event for the start of each USB frame while the USB bus is not suspended in either host or device mode.
+ *  This event can be selectively enabled or disabled by calling the appropriate device or host mode function. When this compile time token is defined,
+ *  the ability to receive USB Start of Frame events via the \ref EVENT_USB_Device_StartOfFrame() or \ref EVENT_USB_Host_StartOfFrame() events is removed,
+ *  reducing the compiled program's binary size.
  *
  *  \section Sec_SummaryUSBDeviceTokens USB Device Mode Driver Related Tokens
  *  This section describes compile tokens which affect USB driver stack of the LUFA library when used in Device mode.