Remove accidentally duplicated model-specific peripheral driver files.
DeviceInfoPos += 8; // Skip to VendorExtensionDesc String\r
DeviceInfoPos += (1 + UNICODE_STRING_LENGTH(*DeviceInfoPos)); // Skip over VendorExtensionDesc String\r
DeviceInfoPos += 2; // Skip over FunctionalMode\r
- DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1)); // Skip over OperationCode Array\r
- DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1)); // Skip over EventCode Array\r
- DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1)); // Skip over DevicePropCode Array\r
- DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1)); // Skip over ObjectFormatCode Array\r
- DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1)); // Skip over ObjectFormatCode Array\r
+ DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1)); // Skip over Supported Operations Array\r
+ DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1)); // Skip over Supported Events Array\r
+ DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1)); // Skip over Supported Device Properties Array\r
+ DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1)); // Skip over Capture Formats Array\r
+ DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1)); // Skip over Image Formats Array\r
\r
/* Extract and convert the Manufacturer Unicode string to ASCII and print it through the USART */\r
char Manufacturer[*DeviceInfoPos];\r
*/\r
\r
/** \file\r
+ * \brief Supported board hardware defines.\r
*\r
* This file contains constants which can be passed to the compiler (via setting the macro BOARD) in the\r
* user project makefile using the -D option to configure the library board-specific drivers.\r
*/\r
\r
/** \file\r
+ * \brief Common library convenience macros and functions.\r
*\r
* This file contains macros which are common to all library elements, and which may be useful in user code. It\r
* also includes other common headers, such as Atomic.h, FunctionAttributes.h and BoardTypes.h.\r
*/\r
\r
/** \file\r
+ * \brief AVR-GCC special function attribute macros.\r
*\r
* This file contains macros for applying GCC specific attributes to functions to control various optimizer\r
* and code generation features of the compiler. Attributes may be placed in the function prototype in any\r
# the style sheet file to the HTML output directory, so don't put your own\r
# stylesheet in the HTML output directory as well, or it will be erased!\r
\r
-HTML_STYLESHEET =\r
+HTML_STYLESHEET = Doxygen.css\r
\r
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML\r
# page will contain the date and time when the page was generated. Setting\r
--- /dev/null
+/* The standard CSS for doxygen */\r
+\r
+body, table, div, p, dl {\r
+ font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif;\r
+ font-size: 12px;\r
+}\r
+\r
+/* @group Heading Levels */\r
+\r
+h1 {\r
+ text-align: center;\r
+ font-size: 150%;\r
+}\r
+\r
+h2 {\r
+ font-size: 120%;\r
+}\r
+\r
+h3 {\r
+ font-size: 100%;\r
+}\r
+\r
+dt {\r
+ font-weight: bold;\r
+}\r
+\r
+div.multicol {\r
+ -moz-column-gap: 1em;\r
+ -webkit-column-gap: 1em;\r
+ -moz-column-count: 3;\r
+ -webkit-column-count: 3;\r
+}\r
+\r
+p.startli, p.startdd, p.starttd {\r
+ margin-top: 2px;\r
+}\r
+\r
+p.endli {\r
+ margin-bottom: 0px;\r
+}\r
+\r
+p.enddd {\r
+ margin-bottom: 4px;\r
+}\r
+\r
+p.endtd {\r
+ margin-bottom: 2px;\r
+}\r
+\r
+/* @end */\r
+\r
+caption {\r
+ font-weight: bold;\r
+}\r
+\r
+span.legend {\r
+ font-size: 70%;\r
+ text-align: center;\r
+}\r
+\r
+h3.version {\r
+ font-size: 90%;\r
+ text-align: center;\r
+}\r
+\r
+div.qindex, div.navtab{\r
+ background-color: #e8eef2;\r
+ border: 1px solid #84b0c7;\r
+ text-align: center;\r
+ margin: 2px;\r
+ padding: 2px;\r
+}\r
+\r
+div.qindex, div.navpath {\r
+ width: 100%;\r
+ line-height: 140%;\r
+}\r
+\r
+div.navtab {\r
+ margin-right: 15px;\r
+}\r
+\r
+/* @group Link Styling */\r
+\r
+a {\r
+ color: #153788;\r
+ font-weight: normal;\r
+ text-decoration: none;\r
+}\r
+\r
+.contents a:visited {\r
+ color: #1b77c5;\r
+}\r
+\r
+a:hover {\r
+ text-decoration: underline;\r
+}\r
+\r
+a.qindex {\r
+ font-weight: bold;\r
+}\r
+\r
+a.qindexHL {\r
+ font-weight: bold;\r
+ background-color: #6666cc;\r
+ color: #ffffff;\r
+ border: 1px double #9295C2;\r
+}\r
+\r
+.contents a.qindexHL:visited {\r
+ color: #ffffff;\r
+}\r
+\r
+a.el {\r
+ font-weight: bold;\r
+}\r
+\r
+a.elRef {\r
+}\r
+\r
+a.code {\r
+ color: #3030f0;\r
+}\r
+\r
+a.codeRef {\r
+ color: #3030f0;\r
+}\r
+\r
+/* @end */\r
+\r
+dl.el {\r
+ margin-left: -1cm;\r
+}\r
+\r
+.fragment {\r
+ font-family: monospace, fixed;\r
+ font-size: 105%;\r
+}\r
+\r
+pre.fragment {\r
+ border: 1px solid #CCCCCC;\r
+ background-color: #f5f5f5;\r
+ padding: 4px 6px;\r
+ margin: 4px 8px 4px 2px;\r
+ overflow: auto;\r
+ word-wrap: break-word;\r
+ font-size: 9pt;\r
+ line-height: 125%;\r
+}\r
+\r
+div.ah {\r
+ background-color: black;\r
+ font-weight: bold;\r
+ color: #ffffff;\r
+ margin-bottom: 3px;\r
+ margin-top: 3px\r
+}\r
+\r
+div.groupHeader {\r
+ margin-left: 16px;\r
+ margin-top: 12px;\r
+ margin-bottom: 6px;\r
+ font-weight: bold;\r
+}\r
+\r
+div.groupText {\r
+ margin-left: 16px;\r
+ font-style: italic;\r
+}\r
+\r
+body {\r
+ background: white;\r
+ color: black;\r
+ margin-right: 20px;\r
+ margin-left: 20px;\r
+}\r
+\r
+td.indexkey {\r
+ background-color: #e8eef2;\r
+ font-weight: bold;\r
+ border: 1px solid #CCCCCC;\r
+ margin: 2px 0px 2px 0;\r
+ padding: 2px 10px;\r
+}\r
+\r
+td.indexvalue {\r
+ background-color: #e8eef2;\r
+ border: 1px solid #CCCCCC;\r
+ padding: 2px 10px;\r
+ margin: 2px 0px;\r
+}\r
+\r
+tr.memlist {\r
+ background-color: #f0f0f0;\r
+}\r
+\r
+p.formulaDsp {\r
+ text-align: center;\r
+}\r
+\r
+img.formulaDsp {\r
+ \r
+}\r
+\r
+img.formulaInl {\r
+ vertical-align: middle;\r
+}\r
+\r
+div.center {\r
+ text-align: center;\r
+ margin-top: 0px;\r
+ margin-bottom: 0px;\r
+ padding: 0px;\r
+}\r
+\r
+div.center img {\r
+ border: 0px;\r
+}\r
+\r
+img.footer {\r
+ border: 0px;\r
+ vertical-align: middle;\r
+}\r
+\r
+/* @group Code Colorization */\r
+\r
+span.keyword {\r
+ color: #008000\r
+}\r
+\r
+span.keywordtype {\r
+ color: #604020\r
+}\r
+\r
+span.keywordflow {\r
+ color: #e08000\r
+}\r
+\r
+span.comment {\r
+ color: #800000\r
+}\r
+\r
+span.preprocessor {\r
+ color: #806020\r
+}\r
+\r
+span.stringliteral {\r
+ color: #002080\r
+}\r
+\r
+span.charliteral {\r
+ color: #008080\r
+}\r
+\r
+span.vhdldigit { \r
+ color: #ff00ff \r
+}\r
+\r
+span.vhdlchar { \r
+ color: #000000 \r
+}\r
+\r
+span.vhdlkeyword { \r
+ color: #700070 \r
+}\r
+\r
+span.vhdllogic { \r
+ color: #ff0000 \r
+}\r
+\r
+/* @end */\r
+\r
+.search {\r
+ color: #003399;\r
+ font-weight: bold;\r
+}\r
+\r
+form.search {\r
+ margin-bottom: 0px;\r
+ margin-top: 0px;\r
+}\r
+\r
+input.search {\r
+ font-size: 75%;\r
+ color: #000080;\r
+ font-weight: normal;\r
+ background-color: #e8eef2;\r
+}\r
+\r
+td.tiny {\r
+ font-size: 75%;\r
+}\r
+\r
+.dirtab {\r
+ padding: 4px;\r
+ border-collapse: collapse;\r
+ border: 1px solid #84b0c7;\r
+}\r
+\r
+th.dirtab {\r
+ background: #e8eef2;\r
+ font-weight: bold;\r
+}\r
+\r
+hr {\r
+ height: 0px;\r
+ border: none;\r
+ border-top: 1px solid #666;\r
+}\r
+\r
+hr.footer {\r
+ height: 1px;\r
+}\r
+\r
+/* @group Member Descriptions */\r
+\r
+.mdescLeft, .mdescRight,\r
+.memItemLeft, .memItemRight,\r
+.memTemplItemLeft, .memTemplItemRight, .memTemplParams {\r
+ background-color: #FAFAFA;\r
+ border: none;\r
+ margin: 4px;\r
+ padding: 1px 0 0 8px;\r
+}\r
+\r
+.mdescLeft, .mdescRight {\r
+ padding: 0px 8px 4px 8px;\r
+ color: #555;\r
+}\r
+\r
+.memItemLeft, .memItemRight, .memTemplParams {\r
+ border-top: 1px solid #ccc;\r
+}\r
+\r
+.memItemLeft, .memTemplItemLeft {\r
+ white-space: nowrap;\r
+}\r
+\r
+.memTemplParams {\r
+ color: #606060;\r
+ white-space: nowrap;\r
+}\r
+\r
+/* @end */\r
+\r
+/* @group Member Details */\r
+\r
+/* Styles for detailed member documentation */\r
+\r
+.memtemplate {\r
+ font-size: 80%;\r
+ color: #606060;\r
+ font-weight: normal;\r
+ margin-left: 3px;\r
+}\r
+\r
+.memnav {\r
+ background-color: #e8eef2;\r
+ border: 1px solid #84b0c7;\r
+ text-align: center;\r
+ margin: 2px;\r
+ margin-right: 15px;\r
+ padding: 2px;\r
+}\r
+\r
+.memitem {\r
+ padding: 0;\r
+ margin-bottom: 10px;\r
+}\r
+\r
+.memname {\r
+ white-space: nowrap;\r
+ font-weight: bold;\r
+ margin-left: 6px;\r
+}\r
+\r
+.memproto {\r
+ border-top: 1px solid #84b0c7; \r
+ border-left: 1px solid #84b0c7; \r
+ border-right: 1px solid #84b0c7; \r
+ padding: 0;\r
+ background-color: #d5e1e8;\r
+ font-weight: bold;\r
+ /* firefox specific markup */\r
+ background-image: -moz-linear-gradient(rgba(228, 233, 245, 1.0) 0%, rgba(193, 205, 232, 1.0) 100%);\r
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;\r
+ -moz-border-radius-topright: 8px;\r
+ -moz-border-radius-topleft: 8px;\r
+ /* webkit specific markup */\r
+ background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(rgba(228, 233, 245, 1.0)), to(rgba(193, 205, 232, 1.0)));\r
+ -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);\r
+ -webkit-border-top-right-radius: 8px;\r
+ -webkit-border-top-left-radius: 8px;\r
+\r
+}\r
+\r
+.memdoc {\r
+ border-bottom: 1px solid #84b0c7; \r
+ border-left: 1px solid #84b0c7; \r
+ border-right: 1px solid #84b0c7; \r
+ padding: 2px 5px;\r
+ background-color: #eef3f5;\r
+ border-top-width: 0;\r
+ /* firefox specific markup */\r
+ -moz-border-radius-bottomleft: 8px;\r
+ -moz-border-radius-bottomright: 8px;\r
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;\r
+ /* webkit specific markup */\r
+ -webkit-border-bottom-left-radius: 8px;\r
+ -webkit-border-bottom-right-radius: 8px;\r
+ -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);\r
+}\r
+\r
+.paramkey {\r
+ text-align: right;\r
+}\r
+\r
+.paramtype {\r
+ white-space: nowrap;\r
+}\r
+\r
+.paramname {\r
+ color: #602020;\r
+ white-space: nowrap;\r
+}\r
+.paramname em {\r
+ font-style: normal;\r
+}\r
+\r
+/* @end */\r
+\r
+/* @group Directory (tree) */\r
+\r
+/* for the tree view */\r
+\r
+.ftvtree {\r
+ font-family: sans-serif;\r
+ margin: 0.5em;\r
+}\r
+\r
+/* these are for tree view when used as main index */\r
+\r
+.directory {\r
+ font-size: 9pt;\r
+ font-weight: bold;\r
+}\r
+\r
+.directory h3 {\r
+ margin: 0px;\r
+ margin-top: 1em;\r
+ font-size: 11pt;\r
+}\r
+\r
+/*\r
+The following two styles can be used to replace the root node title\r
+with an image of your choice. Simply uncomment the next two styles,\r
+specify the name of your image and be sure to set 'height' to the\r
+proper pixel height of your image.\r
+*/\r
+\r
+/*\r
+.directory h3.swap {\r
+ height: 61px;\r
+ background-repeat: no-repeat;\r
+ background-image: url("yourimage.gif");\r
+}\r
+.directory h3.swap span {\r
+ display: none;\r
+}\r
+*/\r
+\r
+.directory > h3 {\r
+ margin-top: 0;\r
+}\r
+\r
+.directory p {\r
+ margin: 0px;\r
+ white-space: nowrap;\r
+}\r
+\r
+.directory div {\r
+ display: none;\r
+ margin: 0px;\r
+}\r
+\r
+.directory img {\r
+ vertical-align: -30%;\r
+}\r
+\r
+/* these are for tree view when not used as main index */\r
+\r
+.directory-alt {\r
+ font-size: 100%;\r
+ font-weight: bold;\r
+}\r
+\r
+.directory-alt h3 {\r
+ margin: 0px;\r
+ margin-top: 1em;\r
+ font-size: 11pt;\r
+}\r
+\r
+.directory-alt > h3 {\r
+ margin-top: 0;\r
+}\r
+\r
+.directory-alt p {\r
+ margin: 0px;\r
+ white-space: nowrap;\r
+}\r
+\r
+.directory-alt div {\r
+ display: none;\r
+ margin: 0px;\r
+}\r
+\r
+.directory-alt img {\r
+ vertical-align: -30%;\r
+}\r
+\r
+/* @end */\r
+\r
+address {\r
+ font-style: normal;\r
+ color: #333;\r
+}\r
+\r
+table.doxtable {\r
+ border-collapse:collapse;\r
+}\r
+\r
+table.doxtable td, table.doxtable th {\r
+ border: 1px solid #153788;\r
+ padding: 3px 7px 2px;\r
+}\r
+\r
+table.doxtable th {\r
+ background-color: #254798;\r
+ color: #FFFFFF;\r
+ font-size: 110%;\r
+ padding-bottom: 4px;\r
+ padding-top: 5px;\r
+ text-align:left;\r
+}\r
+\r
+\r
+p {padding-left: 20px;}
\ No newline at end of file
*/\r
\r
/** \file\r
- *\r
- * Board specific Buttons driver header for the ATAVRUSBRF01.\r
+ * \brief Board specific Buttons driver header for the ATAVRUSBRF01.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver\r
* dispatch header located in LUFA/Drivers/Board/Buttons.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific LED driver header for the ATAVRUSBRF01.\r
+ * \brief Board specific LED driver header for the ATAVRUSBRF01.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
* dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
*/\r
\r
/** \file\r
+ * \brief Board specific Buttons driver header for the BUMBLEB.\r
*\r
- * Board specific Buttons driver header for the BUMBLEB. The BUMBLEB third-party board does not include any on-board\r
- * peripherals, but does have an officially recommended external peripheral layout for buttons, LEDs and a Joystick.\r
+ * The BUMBLEB third-party board does not include any on-board peripherals, but does have an officially recommended\r
+ * external peripheral layout for buttons, LEDs and a Joystick.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver\r
* dispatch header located in LUFA/Drivers/Board/Buttons.h.\r
*/\r
\r
/** \file\r
+ * \brief Board specific joystick driver header for the BUMLEB.\r
*\r
- * Board specific joystick driver header for the USBKEY. The BUMBLEB third-party board does not include any on-board\r
- * peripherals, but does have an officially recommended external peripheral layout for buttons, LEDs and a Joystick.\r
+ * The BUMBLEB third-party board does not include any on-board peripherals, but does have an officially recommended\r
+ * external peripheral layout for buttons, LEDs and a Joystick.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the joystick driver\r
* dispatch header located in LUFA/Drivers/Board/Joystick.h.\r
/** \ingroup Group_Joystick\r
* @defgroup Group_Joystick_BUMBLEB BUMBLEB\r
*\r
- * Board specific joystick driver header for the USBKEY. The BUMBLEB third-party board does not include any on-board\r
+ * Board specific joystick driver header for the BUMBLEB. The BUMBLEB third-party board does not include any on-board\r
* peripherals, but does have an officially recommended external peripheral layout for buttons, LEDs and a Joystick.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the joystick driver\r
*/\r
\r
/** \file\r
+ * \brief Board specific LED driver header for the BUMBLEB.\r
*\r
- * Board specific LED driver header for the BUMBLEB. The BUMBLEB third-party board does not include any on-board\r
- * peripherals, but does have an officially recommended external peripheral layout for buttons, LEDs and a Joystick.\r
+ * The BUMBLEB third-party board does not include any on-board peripherals, but does have an officially recommended\r
+ * external peripheral layout for buttons, LEDs and a Joystick.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
* dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
*/\r
\r
/** \file\r
+ * \brief Master include file for the board digital button driver.\r
*\r
* This file is the master dispatch header file for the board-specific Buttons driver, for boards containing\r
* physical pushbuttons connected to the AVR's GPIO pins.\r
*/\r
\r
/** \file\r
+ * \brief Master include file for the board dataflash IC driver.\r
*\r
* This file is the master dispatch header file for the board-specific dataflash driver, for boards containing\r
* dataflash ICs for external non-volatile storage.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific Dataflash commands header for the AT45DB321C as mounted on the EVK527.\r
+ * \brief Board specific Dataflash commands header for the AT45DB321C as mounted on the EVK527.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific Buttons driver header for the EVK527.\r
+ * \brief Board specific Buttons driver header for the EVK527.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver\r
* dispatch header located in LUFA/Drivers/Board/Buttons.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific Dataflash driver header for the EVK527.\r
+ * \brief Board specific Dataflash driver header for the EVK527.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific joystick driver header for the EVK527.\r
+ * \brief Board specific joystick driver header for the EVK527.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the joystick driver\r
* dispatch header located in LUFA/Drivers/Board/Joystick.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific LED driver header for the EVK527.\r
+ * \brief Board specific LED driver header for the EVK527.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
* dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
*/\r
\r
/** \file\r
+ * \brief Master include file for the board digital joystick driver.\r
*\r
* This file is the master dispatch header file for the board-specific Joystick driver, for boards containing a\r
* 5-way joystick.\r
*/\r
\r
/** \file\r
+ * \brief Master include file for the board LEDs driver.\r
*\r
* This file is the master dispatch header file for the board-specific LED driver, for boards containing user\r
* controllable LEDs.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific LED driver header for the RZUSBSTICK.\r
+ * \brief Board specific LED driver header for the RZUSBSTICK.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
* dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific Dataflash commands header for the AT45DB321C as mounted on the STK525.\r
+ * \brief Board specific Dataflash commands header for the AT45DB321C as mounted on the STK525.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific Buttons driver header for the STK525.\r
+ * \brief Board specific Buttons driver header for the STK525.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver\r
* dispatch header located in LUFA/Drivers/Board/Buttons.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific Dataflash driver header for the STK525.\r
+ * \brief Board specific Dataflash driver header for the STK525.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific joystick driver header for the STK525.\r
+ * \brief Board specific joystick driver header for the STK525.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the joystick driver\r
* dispatch header located in LUFA/Drivers/Board/Joystick.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific LED driver header for the STK525.\r
+ * \brief Board specific LED driver header for the STK525.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
* dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific Dataflash commands header for the AT45DB642D as mounted on the STK526.\r
+ * \brief Board specific Dataflash commands header for the AT45DB642D as mounted on the STK526.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific Buttons driver header for the STK526.\r
+ * \brief Board specific Buttons driver header for the STK526.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver\r
* dispatch header located in LUFA/Drivers/Board/Buttons.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific Dataflash driver header for the STK525.\r
+ * \brief Board specific Dataflash driver header for the STK525.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific joystick driver header for the STK526.\r
+ * \brief Board specific joystick driver header for the STK526.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the joystick driver\r
* dispatch header located in LUFA/Drivers/Board/Joystick.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific LED driver header for the STK526.\r
+ * \brief Board specific LED driver header for the STK526.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
* dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific LED driver header for the PJRC Teensy series boards.\r
+ * \brief Board specific LED driver header for the PJRC Teensy boards.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
* dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
*/\r
\r
/** \file\r
+ * \brief Master include file for the board temperature sensor driver.\r
*\r
* Temperature sensor board driver for the USB boards which contain a temperature sensor.\r
*/\r
*/\r
\r
/** \file\r
- *\r
- * Board specific Dataflash commands header for the AT45DB642D as mounted on the USBKEY.\r
+ * \brief Board specific Dataflash commands header for the AT45DB642D as mounted on the USBKEY.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific Buttons driver header for the USBKEY.\r
+ * \brief Board specific Buttons driver header for the USBKEY.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver\r
* dispatch header located in LUFA/Drivers/Board/Buttons.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific Dataflash driver header for the USBKEY.\r
+ * \brief Board specific Dataflash driver header for the USBKEY.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific joystick driver header for the USBKEY.\r
+ * \brief Board specific joystick driver header for the USBKEY.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the joystick driver\r
* dispatch header located in LUFA/Drivers/Board/Joystick.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific LED driver header for the USBKEY.\r
+ * \brief Board specific LED driver header for the USBKEY.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
* dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific Dataflash commands header for the AT45DB642D as mounted on the XPLAIN.\r
+ * \brief Board specific Dataflash commands header for the AT45DB642D as mounted on the XPLAIN.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific Dataflash driver header for the XPLAIN.\r
+ * \brief Board specific Dataflash driver header for the XPLAIN.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
*/\r
\r
/** \file\r
- *\r
- * Board specific LED driver header for the XPLAIN.\r
+ * \brief Board specific LED driver header for the XPLAIN.\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
* dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
*/\r
\r
/** \file\r
+ * \brief ANSI terminal special escape code macros.\r
*\r
* ANSI terminal compatible escape sequences. These escape sequences are designed to be concatenated with existing\r
* strings to modify their display on a compatible terminal application.\r
- *\r
*/\r
\r
/** \ingroup Group_MiscDrivers\r
*/\r
\r
/** \file\r
+ * \brief Master include file for the ADC peripheral driver.\r
*\r
* This file is the master dispatch header file for the device-specific ADC driver, for AVRs containing an ADC.\r
*\r
*/\r
\r
/** \file\r
+ * \brief ADC peripheral driver for the U7, U6 and U4 USB AVRs.\r
*\r
* ADC driver for the AT90USB1287, AT90USB1286, AT90USB647, AT90USB646, ATMEGA16U4 and ATMEGA32U4 AVRs.\r
*\r
+++ /dev/null
-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2010.\r
- \r
- dean [at] fourwalledcubicle [dot] com\r
- www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
- Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, distribute, and sell this \r
- software and its documentation for any purpose is hereby granted\r
- without fee, provided that the above copyright notice appear in \r
- all copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting \r
- documentation, and that the name of the author not be used in \r
- advertising or publicity pertaining to distribution of the \r
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- * SPI driver for the 8-bit AVRs.\r
- *\r
- * \note This file should not be included directly. It is automatically included as needed by the SPI driver\r
- * dispatch header located in LUFA/Drivers/Peripheral/SPI.h.\r
- */\r
- \r
-/** \ingroup Group_SPI\r
- * @defgroup Group_SPI_AVR8 8-Bit AVR SPI Driver\r
- *\r
- * SPI driver for the 8-bit AVRs.\r
- *\r
- * \note This file should not be included directly. It is automatically included as needed by the ADC driver\r
- * dispatch header located in LUFA/Drivers/Peripheral/SPI.h.\r
- *\r
- * @{\r
- */\r
-\r
-#ifndef __SPI_AVR8_H__\r
-#define __SPI_AVR8_H__\r
-\r
- /* Includes: */\r
- #include <stdbool.h>\r
-\r
- /* Preprocessor Checks: */\r
- #if !defined(__INCLUDE_FROM_SPI_H)\r
- #error Do not include this file directly. Include LUFA/Drivers/Peripheral/SPI.h instead.\r
- #endif\r
-\r
- /* Enable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\r
- extern "C" {\r
- #endif\r
-\r
- /* Private Interface - For use in library only: */\r
- #if !defined(__DOXYGEN__)\r
- /* Macros: */\r
- #define SPI_USE_DOUBLESPEED (1 << SPE)\r
- #endif\r
- \r
- /* Public Interface - May be used in end-application: */\r
- /* Macros: */\r
- /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 2. */\r
- #define SPI_SPEED_FCPU_DIV_2 SPI_USE_DOUBLESPEED\r
-\r
- /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 4. */\r
- #define SPI_SPEED_FCPU_DIV_4 0\r
-\r
- /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 8. */\r
- #define SPI_SPEED_FCPU_DIV_8 (SPI_USE_DOUBLESPEED | (1 << SPR0))\r
-\r
- /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 16. */\r
- #define SPI_SPEED_FCPU_DIV_16 (1 << SPR0)\r
-\r
- /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 32. */\r
- #define SPI_SPEED_FCPU_DIV_32 (SPI_USE_DOUBLESPEED | (1 << SPR1))\r
-\r
- /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 64. */\r
- #define SPI_SPEED_FCPU_DIV_64 (SPI_USE_DOUBLESPEED | (1 << SPR1) | (1 << SPR0))\r
-\r
- /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 128. */\r
- #define SPI_SPEED_FCPU_DIV_128 ((1 << SPR1) | (1 << SPR0))\r
- \r
- /** SPI clock polarity mask for SPI_Init(). Indicates that the SCK should lead on the rising edge. */\r
- #define SPI_SCK_LEAD_RISING (0 << CPOL)\r
-\r
- /** SPI clock polarity mask for SPI_Init(). Indicates that the SCK should lead on the falling edge. */\r
- #define SPI_SCK_LEAD_FALLING (1 << CPOL)\r
-\r
- /** SPI data sample mode mask for SPI_Init(). Indicates that the data should sampled on the leading edge. */\r
- #define SPI_SAMPLE_LEADING (0 << CPHA)\r
-\r
- /** SPI data sample mode mask for SPI_Init(). Indicates that the data should be sampled on the trailing edge. */\r
- #define SPI_SAMPLE_TRAILING (1 << CPHA)\r
- \r
- /** SPI mode mask for SPI_Init(). Indicates that the SPI interface should be initialized into slave mode. */\r
- #define SPI_MODE_SLAVE (0 << MSTR)\r
-\r
- /** SPI mode mask for SPI_Init(). Indicates that the SPI interface should be initialized into master mode. */\r
- #define SPI_MODE_MASTER (1 << MSTR)\r
-\r
- /* Inline Functions: */\r
- /** Initialises the SPI subsystem, ready for transfers. Must be called before calling any other\r
- * SPI routines.\r
- *\r
- * \param[in] SPIOptions SPI Options, a mask consisting of one of each of the SPI_SPEED_*,\r
- * SPI_SCK_*, SPI_SAMPLE_* and SPI_MODE_* masks\r
- */\r
- static inline void SPI_Init(const uint8_t SPIOptions)\r
- {\r
- DDRB |= ((1 << 1) | (1 << 2));\r
- PORTB |= ((1 << 0) | (1 << 3));\r
- \r
- SPCR = ((1 << SPE) | SPIOptions);\r
- \r
- if (SPIOptions & SPI_USE_DOUBLESPEED)\r
- SPSR |= (1 << SPI2X);\r
- else\r
- SPSR &= ~(1 << SPI2X);\r
- }\r
- \r
- /** Turns off the SPI driver, disabling and returning used hardware to their default configuration. */\r
- static inline void SPI_ShutDown(void)\r
- {\r
- DDRB &= ~((1 << 1) | (1 << 2));\r
- PORTB &= ~((1 << 0) | (1 << 3));\r
- \r
- SPCR = 0;\r
- SPSR = 0;\r
- }\r
- \r
- /** Sends and receives a byte through the SPI interface, blocking until the transfer is complete.\r
- *\r
- * \param[in] Byte Byte to send through the SPI interface\r
- *\r
- * \return Response byte from the attached SPI device\r
- */\r
- static inline uint8_t SPI_TransferByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;\r
- static inline uint8_t SPI_TransferByte(const uint8_t Byte)\r
- {\r
- SPDR = Byte;\r
- while (!(SPSR & (1 << SPIF)));\r
- return SPDR;\r
- }\r
-\r
- /** Sends a byte through the SPI interface, blocking until the transfer is complete. The response\r
- * byte sent to from the attached SPI device is ignored.\r
- *\r
- * \param[in] Byte Byte to send through the SPI interface\r
- */\r
- static inline void SPI_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;\r
- static inline void SPI_SendByte(const uint8_t Byte)\r
- {\r
- SPDR = Byte;\r
- while (!(SPSR & (1 << SPIF)));\r
- }\r
-\r
- /** Sends a dummy byte through the SPI interface, blocking until the transfer is complete. The response\r
- * byte from the attached SPI device is returned.\r
- *\r
- * \return The response byte from the attached SPI device\r
- */\r
- static inline uint8_t SPI_ReceiveByte(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;\r
- static inline uint8_t SPI_ReceiveByte(void)\r
- {\r
- SPDR = 0x00;\r
- while (!(SPSR & (1 << SPIF)));\r
- return SPDR;\r
- }\r
-\r
- /* Disable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\r
- }\r
- #endif\r
- \r
-#endif\r
-\r
-/** @} */\r
+++ /dev/null
-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2010.\r
- \r
- dean [at] fourwalledcubicle [dot] com\r
- www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
- Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, distribute, and sell this \r
- software and its documentation for any purpose is hereby granted\r
- without fee, provided that the above copyright notice appear in \r
- all copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting \r
- documentation, and that the name of the author not be used in \r
- advertising or publicity pertaining to distribution of the \r
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- * ADC driver for the 8-bit AVRs.\r
- *\r
- * \note This file should not be included directly. It is automatically included as needed by the USART driver\r
- * dispatch header located in LUFA/Drivers/Peripheral/Serial.h.\r
- */\r
- \r
-/** \ingroup Group_Serial\r
- * @defgroup Group_Serial_AVR8 8-Bit AVR Serial Driver\r
- *\r
- * Serial driver for the 8-bit AVRs.\r
- *\r
- * \note This file should not be included directly. It is automatically included as needed by the ADC driver\r
- * dispatch header located in LUFA/Drivers/Peripheral/USART.h.\r
- *\r
- * @{\r
- */\r
- \r
-#ifndef __SERIAL_AVR8_H__\r
-#define __SERIAL_AVR8_H__\r
-\r
- /* Includes: */\r
- #include <avr/io.h>\r
- #include <avr/pgmspace.h>\r
- #include <stdbool.h>\r
- \r
- /* Preprocessor Checks: */\r
- #if !defined(__INCLUDE_FROM_SERIAL_H)\r
- #error Do not include this file directly. Include LUFA/Drivers/Peripheral/Serial.h instead.\r
- #endif\r
-\r
- /* Public Interface - May be used in end-application: */\r
- /* Macros: */\r
- /** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is\r
- * not set.\r
- */\r
- #define SERIAL_UBBRVAL(baud) ((((F_CPU / 16) + (baud / 2)) / (baud)) - 1)\r
-\r
- /** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is\r
- * set.\r
- */\r
- #define SERIAL_2X_UBBRVAL(baud) ((((F_CPU / 8) + (baud / 2)) / (baud)) - 1)\r
-\r
- /* Pseudo-Function Macros: */\r
- #if defined(__DOXYGEN__)\r
- /** Indicates whether a character has been received through the USART.\r
- *\r
- * \return Boolean true if a character has been received, false otherwise\r
- */\r
- static inline bool Serial_IsCharReceived(void);\r
- #else\r
- #define Serial_IsCharReceived() ((UCSR1A & (1 << RXC1)) ? true : false)\r
- #endif\r
-\r
- /* Inline Functions: */\r
- /** Initializes the USART, ready for serial data transmission and reception. This initializes the interface to\r
- * standard 8-bit, no parity, 1 stop bit settings suitable for most applications.\r
- *\r
- * \param[in] BaudRate Serial baud rate, in bits per second\r
- * \param[in] DoubleSpeed Enables double speed mode when set, halving the sample time to double the baud rate\r
- */\r
- static inline void Serial_Init(const uint32_t BaudRate, const bool DoubleSpeed)\r
- {\r
- UCSR1A = (DoubleSpeed ? (1 << U2X1) : 0);\r
- UCSR1B = ((1 << TXEN1) | (1 << RXEN1));\r
- UCSR1C = ((1 << UCSZ11) | (1 << UCSZ10));\r
- \r
- DDRD |= (1 << 3); \r
- PORTD |= (1 << 2);\r
- \r
- UBRR1 = (DoubleSpeed ? SERIAL_2X_UBBRVAL(BaudRate) : SERIAL_UBBRVAL(BaudRate));\r
- }\r
-\r
- /** Turns off the USART driver, disabling and returning used hardware to their default configuration. */\r
- static inline void Serial_ShutDown(void)\r
- {\r
- UCSR1A = 0;\r
- UCSR1B = 0;\r
- UCSR1C = 0;\r
- \r
- DDRD &= ~(1 << 3); \r
- PORTD &= ~(1 << 2);\r
- \r
- UBRR1 = 0;\r
- }\r
- \r
- /** Transmits a given byte through the USART.\r
- *\r
- * \param[in] DataByte Byte to transmit through the USART\r
- */\r
- static inline void Serial_TxByte(const char DataByte)\r
- {\r
- while (!(UCSR1A & (1 << UDRE1)));\r
- UDR1 = DataByte;\r
- }\r
-\r
- /** Receives a byte from the USART.\r
- *\r
- * \return Byte received from the USART\r
- */\r
- static inline uint8_t Serial_RxByte(void)\r
- {\r
- while (!(UCSR1A & (1 << RXC1)));\r
- return UDR1; \r
- }\r
-\r
- /* Disable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\r
- }\r
- #endif\r
- \r
-#endif\r
-\r
-/** @} */\r
*/\r
\r
/** \file\r
+ * \brief TWI peripheral driver for the U7, U6 and U4 USB AVRs.\r
*\r
* Master mode TWI driver for the AT90USB1287, AT90USB1286, AT90USB647, AT90USB646, ATMEGA16U4 and ATMEGA32U4 AVRs.\r
*\r
*/\r
\r
/** \file\r
+ * \brief Master include file for the SPI peripheral driver.\r
*\r
* Hardware SPI subsystem driver for the supported USB AVRs models.\r
*/\r
*/\r
\r
/** \file\r
+ * \brief Master include file for the USART peripheral driver.\r
*\r
* Driver for the USART subsystem on supported USB AVRs.\r
*/\r
*/\r
\r
/** \file\r
+ * \brief Standard avr-libc character stream driver for the USART.\r
*\r
* Serial stream driver for the USART subsystem on supported USB AVRs. This makes use of the functions in the\r
- * regular USART driver, but allows the avr-libc standard stream functions (printf, puts, etc.) to work with the\r
+ * regular USART driver (see \ref Group_Serial), but allows the avr-libc standard stream functions (printf,\r
+ * puts, etc.) to work with the\r
* USART.\r
- **/\r
+ */\r
\r
/** \ingroup Group_PeripheralDrivers\r
* @defgroup Group_SerialStream Serial Stream Driver - LUFA/Drivers/Peripheral/SerialStream.h\r
*\r
* \section Module Description\r
* Serial stream driver for the USART subsystem on supported USB AVRs. This makes use of the functions in the\r
- * regular USART driver, but allows the avr-libc standard stream functions (printf, puts, etc.) to work with the\r
+ * regular USART driver (see \ref Group_Serial), but allows the avr-libc standard stream functions (printf,\r
+ * puts, etc.) to work with the\r
* USART.\r
*\r
* @{\r
*/\r
\r
/** \file\r
+ * \brief Master include file for the TWI peripheral driver.\r
*\r
* This file is the master dispatch header file for the device-specific ADC driver, for AVRs containing an ADC.\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Master include file for the library USB Audio Class driver.\r
+ *\r
+ * This file should be included in all user projects making use of this optional class driver, instead of\r
+ * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.\r
+ */\r
+\r
/** \ingroup Group_USBClassDrivers\r
* @defgroup Group_USBClassAudio Audio Class Driver - LUFA/Drivers/Class/Audio.h\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Master include file for the library USB CDC-ACM Class driver.\r
+ *\r
+ * This file should be included in all user projects making use of this optional class driver, instead of\r
+ * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.\r
+ */\r
+\r
/** \ingroup Group_USBClassDrivers\r
- * @defgroup Group_USBClassCDC CDC Class Driver - LUFA/Drivers/Class/CDC.h\r
+ * @defgroup Group_USBClassCDC CDC-ACM (Virtual Serial) Class Driver - LUFA/Drivers/Class/CDC.h\r
*\r
* \section Sec_Dependencies Module Source Dependencies\r
* The following files must be built with any user project that uses this module:\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Common definitions and declarations for the library USB Audio Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/Audio.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassAudio\r
* @defgroup Group_USBClassAudioCommon Common Class Definitions\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Common definitions and declarations for the library USB CDC Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/CDC.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassCDC\r
* @defgroup Group_USBClassCDCCommon Common Class Definitions\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Common definitions and declarations for the library USB HID Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/HID.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassHID\r
* @defgroup Group_USBClassHIDCommon Common Class Definitions\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Common definitions and declarations for the library USB MIDI Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/MIDI.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassMIDI\r
* @defgroup Group_USBClassMIDICommon Common Class Definitions\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Common definitions and declarations for the library USB Mass Storage Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/MassStorage.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassMS\r
* @defgroup Group_USBClassMSCommon Common Class Definitions\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Common definitions and declarations for the library USB Printer Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/Printer.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassMS\r
* @defgroup Group_USBClassPrinterCommon Common Class Definitions\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Common definitions and declarations for the library USB RNDIS Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/RNDIS.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassRNDIS\r
* @defgroup Group_USBClassRNDISCommon Common Class Definitions\r
*\r
*/\r
\r
/** \file\r
+ * \brief Common RNDIS class constant definitions.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/Audio.h.\r
+ */\r
+\r
+/** \file\r
*\r
* RNDIS specification related constants. For more information on these\r
* constants, please refer to the Microsoft RNDIS specification.\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Common definitions and declarations for the library USB Still Image Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/StillImage.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassSI\r
* @defgroup Group_USBClassSICommon Common Class Definitions\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Device mode driver for the library USB Audio Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/Audio.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassAudio\r
* @defgroup Group_USBClassAudioDevice Audio Class Device Mode Driver\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Device mode driver for the library USB CDC Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/CDC.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassCDC\r
* @defgroup Group_USBClassCDCDevice CDC Class Device Mode Driver\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Device mode driver for the library USB HID Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/HID.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassHID\r
* @defgroup Group_USBClassHIDDevice HID Class Device Mode Driver\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Device mode driver for the library USB MIDI Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/MIDI.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassMIDI\r
* @defgroup Group_USBClassMIDIDevice MIDI Class Device Mode Driver\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Device mode driver for the library USB Mass Storage Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/MassStorage.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassMS\r
* @defgroup Group_USBClassMSDevice Mass Storage Class Device Mode Driver\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Device mode driver for the library USB RNDIS Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/RNDIS.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassRNDIS\r
* @defgroup Group_USBClassRNDISDevice RNDIS Class Device Mode Driver\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Master include file for the library USB HID Class driver.\r
+ *\r
+ * This file should be included in all user projects making use of this optional class driver, instead of\r
+ * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.\r
+ */\r
+\r
/** \ingroup Group_USBClassDrivers\r
* @defgroup Group_USBClassHID HID Class Driver - LUFA/Drivers/Class/HID.h\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Host mode driver for the library USB Audio Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/Audio.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassCDC\r
* @defgroup Group_USBClassCDCHost CDC Class Host Mode Driver\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Host mode driver for the library USB HID Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/HID.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassHID\r
* @defgroup Group_USBClassHIDHost HID Class Host Mode Driver\r
*\r
*/\r
\r
/** \file\r
+ * \brief USB Human Interface Device (HID) Class report descriptor parser.\r
*\r
- * USB Human Interface Device (HID) Class report descriptor processing routines. This file allows for the easy\r
- * parsing of the complex HID report descriptor, which describes the data that the device transmits to the host.\r
- *\r
+ * This file allows for the easy parsing of the complex HID report descriptor, which describes the data that\r
+ * the device transmits to the host. It also provides an easy API for extracting and processing the data\r
+ * elements inside a HID report sent from an attached HID device.\r
*/\r
\r
/** \ingroup Group_USB\r
*/\r
\r
/** \file\r
+ * \brief Constants for HID report item attributes.\r
*\r
- * Constants for HID report item attributes. Refer to the HID specification for details on each\r
- * flag's meaning when applied to an IN, OUT or FEATURE item.\r
+ * Refer to the HID specification for details on each flag's meaning when applied to an IN, OUT or FEATURE item.\r
*/\r
\r
/** \ingroup Group_HIDParser\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Host mode driver for the library USB MIDI Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/MIDI.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassMIDI\r
* @defgroup Group_USBClassMIDIHost MIDI Class Host Mode Driver\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Host mode driver for the library USB Mass Storage Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/MassStorage.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassMS\r
* @defgroup Group_USBClassMassStorageHost Mass Storage Class Host Mode Driver\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Host mode driver for the library USB Printer Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/Printer.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassPrinter\r
* @defgroup Group_USBClassPrinterHost Printer Class Host Mode Driver\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Host mode driver for the library USB RNDIS Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/RNDIS.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassRNDIS\r
* @defgroup Group_USBClassRNDISHost RNDIS Class Host Mode Driver\r
*\r
if ((USB_HostState != HOST_STATE_Configured) || !(SIInterfaceInfo->State.IsActive))\r
return PIPE_RWSTREAM_DeviceDisconnected;\r
\r
- PIMAHeader->TransactionID = SIInterfaceInfo->State.TransactionID++;\r
+ if (SIInterfaceInfo->State.IsSessionOpen)\r
+ PIMAHeader->TransactionID = SIInterfaceInfo->State.TransactionID++;\r
\r
Pipe_SelectPipe(SIInterfaceInfo->Config.DataOUTPipeNumber);\r
Pipe_Unfreeze();\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Host mode driver for the library USB Still Image Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/StillImage.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassSI\r
* @defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Master include file for the library USB MIDI Class driver.\r
+ *\r
+ * This file should be included in all user projects making use of this optional class driver, instead of\r
+ * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.\r
+ */\r
+\r
/** \ingroup Group_USBClassDrivers\r
* @defgroup Group_USBClassMIDI MIDI Class Driver - LUFA/Drivers/Class/MIDI.h\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Master include file for the library USB Mass Storage Class driver.\r
+ *\r
+ * This file should be included in all user projects making use of this optional class driver, instead of\r
+ * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.\r
+ */\r
+\r
/** \ingroup Group_USBClassDrivers\r
* @defgroup Group_USBClassMS Mass Storage Class Driver - LUFA/Drivers/Class/MassStorage.h\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Master include file for the library USB Printer Class driver.\r
+ *\r
+ * This file should be included in all user projects making use of this optional class driver, instead of\r
+ * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.\r
+ */\r
+\r
/** \ingroup Group_USBClassDrivers\r
* @defgroup Group_USBClassPrinter Printer Class Driver - LUFA/Drivers/Class/Printer.h\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Master include file for the library USB RNDIS Class driver.\r
+ *\r
+ * This file should be included in all user projects making use of this optional class driver, instead of\r
+ * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.\r
+ */\r
+\r
/** \ingroup Group_USBClassDrivers\r
- * @defgroup Group_USBClassRNDIS RNDIS Class Driver - LUFA/Drivers/Class/RNDIS.h\r
+ * @defgroup Group_USBClassRNDIS RNDIS (Networking) Class Driver - LUFA/Drivers/Class/RNDIS.h\r
*\r
* \section Sec_Dependencies Module Source Dependencies\r
* The following files must be built with any user project that uses this module:\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief Master include file for the library USB Still Image Class driver.\r
+ *\r
+ * This file should be included in all user projects making use of this optional class driver, instead of\r
+ * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.\r
+ */\r
+\r
/** \ingroup Group_USBClassDrivers\r
* @defgroup Group_USBClassSI Still Image Class Driver - LUFA/Drivers/Class/StillImage.h\r
*\r
*/\r
\r
/** \file\r
+ * \brief Configuration descriptor parser API.\r
*\r
- * Configuration descriptor parser API. This section of the library gives a friendly API which can be used in\r
- * host applications to easily parse an attached device's configuration descriptor so that endpoint, interface\r
- * and other descriptor data can be extracted and used as needed.\r
+ * This section of the library gives a friendly API which can be used in host applications to easily\r
+ * parse an attached device's configuration descriptor so that endpoint, interface and other descriptor\r
+ * data can be extracted and used as needed.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
*/\r
\r
/** \ingroup Group_Descriptors\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief USB controller events manager.\r
+ *\r
+ * This file contains macros and functions relating to the management of library events, which are small\r
+ * pieces of code similar to ISRs which are run when a given condition is met. Each event can be fired from\r
+ * multiple places in the user or library code, which may or may not be inside an ISR, thus each handler\r
+ * should be written to be as small and fast as possible to prevent possible problems.\r
+ *\r
+ * Events can be hooked by the user application by declaring a handler function with the same name and parameters\r
+ * listed here. If an event with no user-associated handler is fired within the library, it by default maps to an\r
+ * internal empty stub function.\r
+ *\r
+ * Each event must only have one associated event handler, but can be raised by multiple sources by calling the\r
+ * event handler function (with any required event parameters).\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+\r
/** \ingroup Group_USB\r
* @defgroup Group_Events USB Events\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief USB standard descriptor definitions.\r
+ *\r
+ * This file contains structures and macros for the easy creation of standard USB descriptors in USB device projects.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+\r
/** \ingroup Group_USB\r
* @defgroup Group_Descriptors USB Descriptors\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief USB control endpoint request definitions.\r
+ *\r
+ * This file contains structures and macros for the easy creation and parsing of standard USB control requests.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+ \r
/** \ingroup Group_USB\r
* @defgroup Group_StdRequest Standard USB Requests\r
*\r
* This module contains definitions for the various control request parameters, so that the request\r
- * details (such as data direction, request recipient, etc.) can be extracted via masking.\r
+ * details (such as data direction, request recipient, etc.) can be extracted via masking.\r
*\r
* @{\r
*/\r
arising out of or in connection with the use or performance of\r
this software.\r
*/\r
+\r
+/** \file\r
+ * \brief USB endpoint/pipe stream callback management.\r
+ *\r
+ * This file contains definitions for the creation of optional callback routines which can be passed to the\r
+ * endpoint and/or pipe stream APIs, to abort the transfer currently in progress when a condition is met.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
\r
/** \ingroup Group_USB\r
* @defgroup Group_StreamCallbacks Endpoint and Pipe Stream Callbacks\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief USB controller interrupt service routine management.\r
+ *\r
+ * This file contains definitions required for the correct handling of low level USB service routine interrupts\r
+ * from the USB controller.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+ \r
#ifndef __USBINTERRUPT_H__\r
#define __USBINTERRUPT_H__\r
\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief USB mode and capability macros.\r
+ *\r
+ * This file defines macros indicating the type of USB controller the library is being compiled for, and its\r
+ * capabilities. These macros may then be referenced in the user application to selectively enable or disable\r
+ * code sections depending on if they are defined or not.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+\r
/** \ingroup Group_USB\r
* @defgroup Group_USBMode USB Mode Tokens\r
*\r
arising out of or in connection with the use or performance of\r
this software.\r
*/\r
- \r
+\r
+/** \file\r
+ * \brief Main USB service task management.\r
+ *\r
+ * This file contains the function definitions required for the main USB service task, which must be called\r
+ * from the user application to ensure that the USB connection to or from a connected USB device is maintained.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+\r
#ifndef __USBTASK_H__\r
#define __USBTASK_H__\r
\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief USB device standard request management.\r
+ *\r
+ * This file contains the function prototypes neccesary for the processing of incomming standard control requests\r
+ * when the library is in USB device mode.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+\r
#ifndef __DEVCHAPTER9_H__\r
#define __DEVCHAPTER9_H__\r
\r
arising out of or in connection with the use or performance of\r
this software.\r
*/\r
- \r
+\r
+/** \file\r
+ * \brief USB device mode definitions.\r
+ *\r
+ * This file contains structures, function prototypes and macros related to USB device mode.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+\r
/** \ingroup Group_USB\r
* @defgroup Group_Device Device Management\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief USB device endpoint management definitions.\r
+ *\r
+ * This file contains structures, function prototypes and macros related to the management of the device's\r
+ * data endpoints when the library is initialized in USB device mode.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+\r
/** \ingroup Group_USB\r
* @defgroup Group_EndpointManagement Endpoint Management\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief USB host mode definitions.\r
+ *\r
+ * This file contains structures, function prototypes and macros related to USB host mode.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+\r
/** \ingroup Group_USB\r
* @defgroup Group_Host Host Management\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief USB host standard request management.\r
+ *\r
+ * This file contains the function prototypes neccesary for the issuing of outgoing standard control requests\r
+ * when the library is in USB host mode.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+\r
#ifndef __HOSTCHAPTER9_H__\r
#define __HOSTCHAPTER9_H__\r
\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief USB low level USB controller definitions.\r
+ *\r
+ * This file contains structures, function prototypes and macros related to the low level configutation of the\r
+ * USB controller, to start, stop and reset the USB library core.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+ \r
/** \ingroup Group_USB\r
* @defgroup Group_USBManagement USB Interface Management\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief USB OTG mode definitions.\r
+ *\r
+ * This file contains structures, function prototypes and macros related to USB OTG mode, where two USB devices\r
+ * may be linked directly together and exchange host/device roles as needed.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+\r
/** \ingroup Group_USB\r
* @defgroup Group_OTG USB On The Go (OTG) Management\r
*\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief USB host pipe management definitions.\r
+ *\r
+ * This file contains structures, function prototypes and macros related to the management of the device's\r
+ * data pipes when the library is initialized in USB host mode.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */ \r
+\r
/** \ingroup Group_USB\r
* @defgroup Group_PipeManagement Pipe Management\r
*\r
*/\r
\r
/** \file\r
+ * \brief Master include file for the library USB functionality.\r
*\r
- * Master include file for the library USB functionality. This file should be included in all user projects making\r
- * use of the USB portions of the library, instead of including any headers in the USB/LowLevel or USB/HighLevel\r
- * directories.\r
+ * This file should be included in all user projects making use of the USB portions of the library, instead of\r
+ * including any headers in the USB/LowLevel/ or USB/HighLevel/ subdirectories.\r
*/\r
\r
/** @defgroup Group_USB USB - LUFA/Drivers/USB/USB.h\r
/**\r
* \page Page_AlternativeStacks Alternative USB AVR Stacks\r
*\r
- * LUFA is not the only stack available for the USB AVRs, although it is perhaps the best (\see Page_WhyUseLUFA).\r
+ * LUFA is not the only stack available for the USB AVRs, although it is perhaps the best (see \ref Page_WhyUseLUFA).\r
* In the interests of completeness and user choice, other known USB AVR stacks are listed here.\r
*\r
- * - Atmel USB AVR Stack (<i>Atmel Inc.</i>) \n\r
+ * - <b>Name:</b> Atmel USB AVR Stack (<i>Atmel Inc.</i>) \n\r
* <b>Cost:</b> Free \n\r
* <b>License:</b> Atmel Limited License (see Atmel download for details) \n\r
* <b>Website:</b> http://atmel.com/dyn/products/app_notes.asp?family_id=607#USB \n\r
* <b>Description:</b> This is the official Atmel USB AVR stack, for their 8-bit USB AVR lineup. Each series of\r
* USB AVR is seperated into a seperate download stack, which is both AVR-GCC and IAR compatible.\r
*\r
- * - Dr. Stefan Salewski's AT90USB1287 Stack (<i>Dr. Stefan Salewski</i>) \n\r
+ * - <b>Name:</b> Dr. Stefan Salewski's AT90USB1287 Stack (<i>Dr. Stefan Salewski</i>) \n\r
* <b>Cost:</b> Free \n\r
* <b>License:</b> GPL \n\r
* <b>Website:</b> http://www.ssalewski.de/AT90USB_firmware.html.en \n\r
* German Physicist. It compiles for AVR-GCC and can potentially be modified to work on other USB\r
* AVR models.\r
*\r
- * - PJRC Teensy Stack (<i>Paul Stoffregen</i>) \n\r
+ * - <b>Name:</b> PJRC Teensy Stack (<i>Paul Stoffregen</i>) \n\r
* <b>Cost:</b> Free \n\r
* <b>License:</b> BSD \n\r
* <b>Website:</b> http://www.pjrc.com/teensy/usb_debug_only.html \n\r
* <b>Description:</b> Not so much a complete stack as a collection of USB enabled demos, this library is specifically\r
* designed for the PJRC Teensy line of USB AVRs, and thus may need to be modified for other USB AVR\r
- * chips. These code samples shows the inner workings of the USB controller, without all the abstraction\r
- * present in most other USB AVR stacks. \r
+ * chips. These minimal code samples shows the inner workings of the USB controller, without all the \r
+ * abstraction present in most other USB AVR stacks. \r
*/\r
\ No newline at end of file
* - Added new Relay Controller Board project (thanks to OBinou)\r
*\r
* <b>Changed:</b>\r
- * - AVRISP programmer project now has a more robust timeout system, allowing for an increse of the software USART speed\r
+ * - AVRISP programmer project now has a more robust timeout system, allowing for an increase of the software USART speed\r
* for PDI and TPI programming\r
* - Added a timeout value to the TWI_StartTransmission() function, within which the addressed device must respond\r
* - Webserver project now uses the board LEDs to indicate the current IP configuration state\r
* - Fixed ADC routines not correctly returning the last result when multiple channels were read\r
* - Fixed ADC routines failing to read the extended channels (Channels 8 to 13, Internal Temperature Sensor) on the\r
* U4 series USB AVR parts\r
- * - Fixed LowLevel MassStorage demo broken on the U2 AVRs due to double-banked endpoints\r
+ * - Fixed LowLevel MassStorage demo broken on the U2 series USB AVRs due to unsupported double-banked endpoint modes used\r
* - Fixed compilation error in the AudioInput demos when MICROPHONE_BIASED_TO_HALF_RAIL is defined (thanks to C. Scott Ananian)\r
* - Fixed incorrect definition of HID_ALIGN_DATA() causing incorrect HID report item data alignment\r
* - Fixed Still Image Host class driver not resetting the transaction ID when a new session is opened, fixed driver not sending\r
* -# Finish MIDI class Bootloader\r
* -# Finish SideShow demo\r
* -# Finish StandaloneProgrammer project\r
+ * -# Finish MIDIToneGenerator project\r
* - Ports\r
* -# AVR32 UC3B series microcontrollers\r
* -# Atmel ARM7 series microcontrollers\r
* - <b>USBtoSerial</b> - USB to USART Serial Converter project\r
* - <b>Webserver</b> - RNDIS Host Webserver with DHCP client, powered by uIP TCP/IP stack project and FatFS library\r
* - <b>XPLAINBridge</b> - XPLAIN alternative PDI Programmer/USB to Serial Bridge firmware project\r
+ * - <b>Incomplete</b>\r
+ * - <b>MIDIToneGenerator</b> - Incomplete MIDI Tone Generator application, to convert MIDI note messages into audio tones\r
+ * - <b>StandaloneProgrammer</b> - Incomplete Standalone AVR Programmer application, to program AVRs directly from a Mass Storage disk\r
*\r
* </small>\r
*/
\ No newline at end of file
* Commercial entities can opt out of the public disclosure clause in this license\r
* for a one-time US$1500 payment. This provides a non-exclusive modified MIT licensed which\r
* allows for the free use of the LUFA library, bootloaders and (where the sole copyright\r
- * is attributed to Dean Camera) demos without public disclosure within an organisation. Please\r
- * contact the author for more information (<b>Note: Please do NOT pay this in advance through the\r
- * donation link shown on \ref Page_Donating - contact author for payment details.</b>).\r
+ * is attributed to Dean Camera) demos without public disclosure within an organisation, in\r
+ * addition to three free hours of consultation with the library author, and priority support.\r
+ * Please contact the author for more information via the address shown on on \ref Page_Resources.\r
*\r
* \verbatim\r
* Permission to use, copy, modify, and distribute this software\r
/**\r
* \mainpage\r
*\r
- * \n\r
* \image html LUFA.png\r
+ * <div align="center"><small><i>Logo design by <b>Ryo Yamauchi</b></i></small></div>\r
* \n\r
*\r
* <b>LUFA is donationware. For author and donation information, see \ref Page_Donating.</b>\r
*\r
- * LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license. It supports\r
- * a large number of USB AVR models and boards (see \ref Page_DeviceSupport). It is designed to provide an easy to use, feature\r
- * rich framework for the development of USB peripherals and hosts.\r
+ * LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license (see \ref Page_Licence).\r
+ * It supports a large number of USB AVR models and boards (see \ref Page_DeviceSupport). It is designed to provide an easy to use,\r
+ * feature rich framework for the development of USB peripherals and hosts.\r
*\r
* LUFA focuses on the microcontroller side of USB development only; it includes no host USB driver development facilities. While\r
* custom USB devices can be made with LUFA, the included demos all use the inbuilt OS drivers for each USB class for simplicity.\r
* and open source LUFA powered projects.\r
*\r
* <b>Subsections:</b>\r
- * - \subpage Page_WhyUseLUFA Why Use LUFA?\r
+ * - \subpage Page_WhyUseLUFA What are the advantages of using LUFA?\r
* - \subpage Page_LUFAvsAtmelStack How does LUFA compare to the Atmel USB AVR stack?\r
* - \subpage Page_AlternativeStacks Alternative USB AVR Stacks\r
- * - \subpage Page_Licence Project licence\r
+ * - \subpage Page_Licence Project source licence and commercial use information\r
* - \subpage Page_Donating Donating to support this project\r
* - \subpage Page_LibraryApps Overview of included Demos, Bootloaders and Projects\r
- *\r
- * <small><i>Logo design by <b>Ryo Yamauchi</b></i></small>\r
*/\r
*/\r
\r
/** \file\r
+ * \brief Simple round-robbin pseudo-task scheduler.\r
*\r
* Simple round-robbin cooperative scheduler for use in basic projects where non real-time tasks need\r
* to be executed. Each task is executed in sequence, and can be enabled or disabled individually or as a group.\r
/*\r
Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
\r
- Permission to use, copy, modify, distribute, and sell this software\r
- and its documentation for any purpose is hereby granted without fee,\r
- provided that the above copyright notice appear in all copies and that\r
- both that the copyright notice and this permission notice and warranty\r
- disclaimer appear in supporting documentation, and that the name of the\r
- author not be used in advertising or publicity pertaining to distribution\r
- of the software without specific, written prior permission.\r
+ Permission to use, copy, modify, distribute, and sell this \r
+ software and its documentation for any purpose is hereby granted\r
+ without fee, provided that the above copyright notice appear in \r
+ all copies and that both that the copyright notice and this\r
+ permission notice and warranty disclaimer appear in supporting \r
+ documentation, and that the name of the author not be used in \r
+ advertising or publicity pertaining to distribution of the \r
+ software without specific, written prior permission.\r
\r
The author disclaim all warranties with regard to this\r
software, including all implied warranties of merchantability\r
\r
/** \file\r
*\r
+ * \brief LUFA library version constants.\r
+ *\r
* Version constants for informational purposes and version-specific macro creation. This header file contains the\r
* current LUFA version number in several forms, for use in the user-application (for example, for printing out \r
* whilst debugging, or for testing for version compatibility).\r
This package contains the complete LUFA library, demos, user-submitted projects\r
and bootloaders for use with compatible microcontroller models. To get started,\r
you will need to install the "Doxygen" documentation generation tool from\r
-www.doxygen.org, and run "make doxygen" from the command line. From there, the\r
-generated HTML documentation for the library itself will be avaliable in the\r
-LUFA/Documentation/html/ directory. View this documentation in your chosen web\r
-browser for further Getting Started information.\r
+www.doxygen.org, and run "make doxygen" from the command line whilst inside the\r
+extracted LUFA download package directory. From there, the generated Doxygen \r
+HTML documentation for the library and included projects will be available in the\r
+generated Documentation/ subdirectories of the library core and projects. View\r
+the generated documentation for the library core in your chosen web browser for\r
+further Getting Started information.\r
\r
The documentation for the library itself (but not the documentation for the\r
individual demos, projects or bootloaders) is also available as a seperate\r
\r
# Call with "make all" to rebuild everything, "make clean" to clean everything,\r
# "make clean_list" to remove all intermediatary files but preserve any binaries,\r
-# "make doxygen" to document everything with DoxyGen (if installed) and\r
+# "make doxygen" to document everything with Doxygen (if installed) and\r
# "make clean_doxygen" to remove generated Doxygen documentation from everything.\r
\r
all:\r
projects / pub / USBasp.git / commitdiff