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.

DualVirtualSerial.txt 2.9KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  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 Dual Communications Device Class (Dual Virtual Serial Port) Device
  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)</td>
  31. * </tr>
  32. * <tr>
  33. * <td><b>USB Subclass:</b></td>
  34. * <td>Abstract Control Model (ACM)</td>
  35. * </tr>
  36. * <tr>
  37. * <td><b>Relevant Standards:</b></td>
  38. * <td>USBIF CDC Class Standard</td>
  39. * </tr>
  40. * <tr>
  41. * <td><b>Relevant Standards:</b></td>
  42. * <td>USBIF Interface Association Descriptor ECN \n
  43. * USBIF CDC Class Standard</td>
  44. * </tr>
  45. * <tr>
  46. * <td><b>Supported USB Speeds:</b></td>
  47. * <td>Full Speed Mode</td>
  48. * </tr>
  49. * </table>
  50. *
  51. * \section Sec_Description Project Description:
  52. *
  53. * Dual Communications Device Class demonstration application.
  54. * This gives a simple reference application for implementing
  55. * a composite device with dual CDC functions acting as a pair
  56. * of virtual serial ports. This demo uses Interface Association
  57. * Descriptors to link together the pair of related CDC
  58. * descriptors for each virtual serial port, which may not be
  59. * supported in all OSes - Windows Vista is supported, as is
  60. * XP (although the latter may need a hotfix to function).
  61. *
  62. * Joystick actions are transmitted to the host as strings
  63. * through the first serial port. The device does not respond to
  64. * serial data sent from the host in the first serial port.
  65. *
  66. * The second serial port echoes back data sent from the host.
  67. *
  68. * After running this demo for the first time on a new computer,
  69. * you will need to supply the .INF file located in this demo
  70. * project's directory as the device's driver when running under
  71. * Windows. This will enable Windows to use its inbuilt CDC drivers,
  72. * negating the need for custom drivers for the device. Other
  73. * Operating Systems should automatically use their own inbuilt
  74. * CDC-ACM drivers.
  75. *
  76. * \section Sec_Options Project Options
  77. *
  78. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  79. *
  80. * <table>
  81. * <tr>
  82. * <td>
  83. * None
  84. * </td>
  85. * </tr>
  86. * </table>
  87. */