Keyboard firmwares for Atmel AVR and Cortex-M
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

VirtualSerialMassStorage.txt 3.2KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  1. /** \file
  2. *
  3. * This file contains special DoxyGen information for the generation of the main page and other special
  4. * documentation pages. It is not a project source file.
  5. */
  6. /** \mainpage Communications Device Class (Virtual Serial Port) and Mass Storage Demo
  7. *
  8. * \section Sec_Compat Demo Compatibility:
  9. *
  10. * The following list indicates what microcontrollers are compatible with this demo.
  11. *
  12. * \li Series 7 USB AVRs (AT90USBxxx7)
  13. * \li Series 6 USB AVRs (AT90USBxxx6)
  14. * \li Series 4 USB AVRs (ATMEGAxxU4)
  15. * \li Series AU XMEGA AVRs (ATXMEGAxxxAxU)
  16. * \li Series B XMEGA AVRs (ATXMEGAxxxBxU)
  17. * \li Series C XMEGA AVRs (ATXMEGAxxxCxU)
  18. *
  19. * \section Sec_Info USB Information:
  20. *
  21. * The following table gives a rundown of the USB utilization of this demo.
  22. *
  23. * <table>
  24. * <tr>
  25. * <td><b>USB Mode:</b></td>
  26. * <td>Device</td>
  27. * </tr>
  28. * <tr>
  29. * <td><b>USB Class:</b></td>
  30. * <td>Communications Device Class (CDC) \n
  31. * Mass Storage Device</td>
  32. * </tr>
  33. * <tr>
  34. * <td><b>USB Subclass:</b></td>
  35. * <td>Abstract Control Model (ACM) \n
  36. * Bulk-Only Transport</td>
  37. * </tr>
  38. * <tr>
  39. * <td><b>Relevant Standards:</b></td>
  40. * <td>USBIF CDC Class Standard \n
  41. * USBIF Mass Storage Standard \n
  42. * USB Bulk-Only Transport Standard \n
  43. * SCSI Primary Commands Specification \n
  44. * SCSI Block Commands Specification</td>
  45. * </tr>
  46. * <tr>
  47. * <td><b>Supported USB Speeds:</b></td>
  48. * <td>Full Speed Mode</td>
  49. * </tr>
  50. * </table>
  51. *
  52. * \section Sec_Description Project Description:
  53. *
  54. * Combined Communications Device Class/Mass Storage demonstration application.
  55. * This gives a simple reference application for implementing a combined
  56. * CDC and Mass Storage device acting as a both a virtual serial port and a flash
  57. * drive. Joystick actions are transmitted to the host as strings, and data can be
  58. * written to or read from the exposed flash drive interface in the same manner as
  59. * other USB flash drives. The device does not respond to serial data sent from the
  60. * host.
  61. *
  62. * After running this demo for the first time on a new computer,
  63. * you will need to supply the .INF file located in this demo
  64. * project's directory as the device's driver when running under
  65. * Windows. This will enable Windows to use its inbuilt CDC drivers,
  66. * negating the need for custom drivers for the device. Other
  67. * Operating Systems should automatically use their own inbuilt
  68. * CDC-ACM drivers.
  69. *
  70. * \section Sec_Options Project Options
  71. *
  72. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  73. *
  74. * <table>
  75. * <tr>
  76. * <th><b>Define Name:</b></th>
  77. * <th><b>Location:</b></th>
  78. * <th><b>Description:</b></th>
  79. * </tr>
  80. * <tr>
  81. * <td>TOTAL_LUNS</td>
  82. * <td>AppConfig.h</td>
  83. * <td>Total number of Logical Units (drives) in the device. The total device capacity is shared equally between each drive -
  84. * this can be set to any positive non-zero amount.</td>
  85. * </tr>
  86. * <tr>
  87. * <td>DISK_READ_ONLY</td>
  88. * <td>AppConfig.h</td>
  89. * <td>Configuration define, indicating if the disk should be write protected or not.</td>
  90. * </tr>
  91. */