aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/ManPages/CompileTimeTokens.txt
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2010-10-07 11:55:20 +0000
committerDean Camera <dean@fourwalledcubicle.com>2010-10-07 11:55:20 +0000
commit292a631b62dc06454447110f54757cc2236b6e08 (patch)
tree5c8507c30b7feccf1e5ac500e14cd301440bfdd7 /LUFA/ManPages/CompileTimeTokens.txt
parentccc82ce74598a00bf484cdec3e186af609efcc50 (diff)
downloadlufa-292a631b62dc06454447110f54757cc2236b6e08.tar.gz
lufa-292a631b62dc06454447110f54757cc2236b6e08.tar.bz2
lufa-292a631b62dc06454447110f54757cc2236b6e08.zip
Added new NO_SOF_EVENTS compile time option, enabled in the bootloaders to reduce the compiled binary size.
Diffstat (limited to 'LUFA/ManPages/CompileTimeTokens.txt')
-rw-r--r--LUFA/ManPages/CompileTimeTokens.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt
index fbfbc3d98..d74cb4314 100644
--- a/LUFA/ManPages/CompileTimeTokens.txt
+++ b/LUFA/ManPages/CompileTimeTokens.txt
@@ -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.