-/** \file\r
- *\r
- * This file contains special DoxyGen information for the generation of the main page and other special\r
- * documentation pages. It is not a project source file.\r
- */\r
- \r
-/** \mainpage Mass Storage Device Demo\r
- *\r
- * \section SSec_Compat Demo Compatibility:\r
- *\r
- * The following list indicates what microcontrollers are compatible with this demo.\r
- *\r
- * - Series 7 USB AVRs\r
- * - Series 6 USB AVRs\r
- * - Series 4 USB AVRs\r
- * - Series 2 USB AVRs\r
- *\r
- * \section SSec_Info USB Information:\r
- *\r
- * The following table gives a rundown of the USB utilization of this demo.\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><b>USB Mode:</b></td>\r
- * <td>Device</td>\r
- * </tr>\r
- * <tr>\r
- * <td><b>USB Class:</b></td>\r
- * <td>Mass Storage Device</td>\r
- * </tr>\r
- * <tr> \r
- * <td><b>USB Subclass:</b></td>\r
- * <td>Bulk-Only Transport</td>\r
- * </tr>\r
- * <tr>\r
- * <td><b>Relevant Standards:</b></td>\r
- * <td>USBIF Mass Storage Standard</td>\r
- * <td>USB Bulk-Only Transport Standard</td>\r
- * <td>SCSI Primary Commands Specification</td>\r
- * <td>SCSI Block Commands Specification</td>\r
- * </tr>\r
- * <tr>\r
- * <td><b>Usable Speeds:</b></td>\r
- * <td>Full Speed Mode</td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_Description Project Description: \r
- *\r
- * Dual LUN Mass Storage demonstration application. This gives a simple\r
- * reference application for implementing a multiple LUN USB Mass Storage\r
- * device using the basic USB UFI drivers in all modern OSes (i.e. no\r
- * special drivers required).\r
- * \r
- * On start-up the system will automatically enumerate and function as an\r
- * external mass storage device with two LUNs (separate disks) which may\r
- * be formatted and used in the same manner as commercial USB Mass Storage\r
- * devices.\r
- * \r
- * You will need to format the mass storage drives upon first run of this\r
- * demonstration - as the device acts only as a data block transport between\r
- * the host and the storage media, it does not matter what file system is used,\r
- * as the data interpretation is performed by the host and not the USB device.\r
- * \r
- * This demo is not restricted to only two LUNs; by changing the TOTAL_LUNS\r
- * value in MassStorageDualLUN.h, any number of LUNs can be used (from 1 to\r
- * 255), with each LUN being allocated an equal portion of the available\r
- * Dataflash memory.\r
- *\r
- * The USB control endpoint is managed entirely by the library using endpoint\r
- * interrupts, as the INTERRUPT_CONTROL_ENDPOINT option is enabled. This allows for\r
- * the host to reset the Mass Storage device state during long transfers without\r
- * the need for complicated polling logic.\r
- *\r
- * \section SSec_Options Project Options\r
- *\r
- * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><b>Define Name:</b></td>\r
- * <td><b>Location:</b></td>\r
- * <td><b>Description:</b></td>\r
- * </tr>\r
- * <tr>\r
- * <td>TOTAL_LUNS</td>\r
- * <td>MassStorage.h</td>\r
- * <td>Total number of Logical Units (drives) in the device. The total device capacity is shared equally between each drive\r
- * - this can be set to any positive non-zero amount.</td>\r
- * </tr>\r
- * </table>\r
- */\r
+/** \file
+ *
+ * This file contains special DoxyGen information for the generation of the main page and other special
+ * documentation pages. It is not a project source file.
+ */
+
+/** \mainpage Mass Storage Device Demo
+ *
+ * \section SSec_Compat Demo Compatibility:
+ *
+ * The following list indicates what microcontrollers are compatible with this demo.
+ *
+ * - Series 7 USB AVRs
+ * - Series 6 USB AVRs
+ * - Series 4 USB AVRs
+ * - Series 2 USB AVRs
+ *
+ * \section SSec_Info USB Information:
+ *
+ * The following table gives a rundown of the USB utilization of this demo.
+ *
+ * <table>
+ * <tr>
+ * <td><b>USB Mode:</b></td>
+ * <td>Device</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Class:</b></td>
+ * <td>Mass Storage Device</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Subclass:</b></td>
+ * <td>Bulk-Only Transport</td>
+ * </tr>
+ * <tr>
+ * <td><b>Relevant Standards:</b></td>
+ * <td>USBIF Mass Storage Standard \n
+ * USB Bulk-Only Transport Standard \n
+ * SCSI Primary Commands Specification \n
+ * SCSI Block Commands Specification</td>
+ * </tr>
+ * <tr>
+ * <td><b>Usable Speeds:</b></td>
+ * <td>Full Speed Mode</td>
+ * </tr>
+ * </table>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * Dual LUN Mass Storage demonstration application. This gives a simple
+ * reference application for implementing a multiple LUN USB Mass Storage
+ * device using the basic USB UFI drivers in all modern OSes (i.e. no
+ * special drivers required).
+ *
+ * On start-up the system will automatically enumerate and function as an
+ * external mass storage device with two LUNs (separate disks) which may
+ * be formatted and used in the same manner as commercial USB Mass Storage
+ * devices.
+ *
+ * You will need to format the mass storage drives upon first run of this
+ * demonstration - as the device acts only as a data block transport between
+ * the host and the storage media, it does not matter what file system is used,
+ * as the data interpretation is performed by the host and not the USB device.
+ *
+ * This demo is not restricted to only two LUNs; by changing the TOTAL_LUNS
+ * value in MassStorageDualLUN.h, any number of LUNs can be used (from 1 to
+ * 255), with each LUN being allocated an equal portion of the available
+ * Dataflash memory.
+ *
+ * The USB control endpoint is managed entirely by the library using endpoint
+ * interrupts, as the INTERRUPT_CONTROL_ENDPOINT option is enabled. This allows for
+ * the host to reset the Mass Storage device state during long transfers without
+ * the need for complicated polling logic.
+ *
+ * \section SSec_Options Project Options
+ *
+ * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
+ *
+ * <table>
+ * <tr>
+ * <td><b>Define Name:</b></td>
+ * <td><b>Location:</b></td>
+ * <td><b>Description:</b></td>
+ * </tr>
+ * <tr>
+ * <td>TOTAL_LUNS</td>
+ * <td>MassStorage.h</td>
+ * <td>Total number of Logical Units (drives) in the device. The total device capacity is shared equally between each drive -
+ * this can be set to any positive non-zero amount.</td>
+ * </tr>
+ * </table>
+ */
projects / pub / USBasp.git / blobdiff