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.

VirtualSerial.txt 2.3KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  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) 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 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
  16. * \li Series AU XMEGA AVRs (ATXMEGAxxxAxU)
  17. * \li Series B XMEGA AVRs (ATXMEGAxxxBxU)
  18. * \li Series C XMEGA AVRs (ATXMEGAxxxCxU)
  19. *
  20. * \section Sec_Info USB Information:
  21. *
  22. * The following table gives a rundown of the USB utilization of this demo.
  23. *
  24. * <table>
  25. * <tr>
  26. * <td><b>USB Mode:</b></td>
  27. * <td>Device</td>
  28. * </tr>
  29. * <tr>
  30. * <td><b>USB Class:</b></td>
  31. * <td>Communications Device Class (CDC)</td>
  32. * </tr>
  33. * <tr>
  34. * <td><b>USB Subclass:</b></td>
  35. * <td>Abstract Control Model (ACM)</td>
  36. * </tr>
  37. * <tr>
  38. * <td><b>Relevant Standards:</b></td>
  39. * <td>USBIF CDC Class Standard</td>
  40. * </tr>
  41. * <tr>
  42. * <td><b>Supported USB Speeds:</b></td>
  43. * <td>Full Speed Mode</td>
  44. * </tr>
  45. * </table>
  46. *
  47. * \section Sec_Description Project Description:
  48. *
  49. * Communications Device Class demonstration application.
  50. * This gives a simple reference application for implementing
  51. * a CDC device acting as a virtual serial port. Joystick
  52. * actions are transmitted to the host as strings. The device
  53. * does not respond to serial data sent from the host.
  54. *
  55. * After running this demo for the first time on a new computer,
  56. * you will need to supply the .INF file located in this demo
  57. * project's directory as the device's driver when running under
  58. * Windows. This will enable Windows to use its inbuilt CDC drivers,
  59. * negating the need for custom drivers for the device. Other
  60. * Operating Systems should automatically use their own inbuilt
  61. * CDC-ACM drivers.
  62. *
  63. * \section Sec_Options Project Options
  64. *
  65. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  66. *
  67. * <table>
  68. * <tr>
  69. * <td>
  70. * None
  71. * </td>
  72. * </tr>
  73. * </table>
  74. */