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.
		
		
		
		
		
			
		
			
				
					75 lines
				
				2.4 KiB
			
		
		
			
		
	
	
					75 lines
				
				2.4 KiB
			| 
								 
											16 years ago
										 
									 | 
							
								/** \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 Combined Communications Device Class (Virtual Serial Port) and Mouse 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>Communications Device Class (CDC)</td>
							 | 
						||
| 
								 | 
							
								 *    <td>Human Interface Device Class (HID)</td>
							 | 
						||
| 
								 | 
							
								 *   </tr>
							 | 
						||
| 
								 | 
							
								 *   <tr> 
							 | 
						||
| 
								 | 
							
								 *    <td><b>USB Subclass:</b></td>
							 | 
						||
| 
								 | 
							
								 *    <td>Abstract Control Model (ACM)</td>
							 | 
						||
| 
								 | 
							
								 *    <td>Mouse Subclass</td>
							 | 
						||
| 
								 | 
							
								 *   </tr>
							 | 
						||
| 
								 | 
							
								 *   <tr>
							 | 
						||
| 
								 | 
							
								 *    <td><b>Relevant Standards:</b></td>
							 | 
						||
| 
								 | 
							
								 *    <td>USBIF CDC Class Standard</td>
							 | 
						||
| 
								 | 
							
								 *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>
							 | 
						||
| 
								 | 
							
								 *   </tr>
							 | 
						||
| 
								 | 
							
								 *   <tr>
							 | 
						||
| 
								 | 
							
								 *    <td><b>Usable Speeds:</b></td>
							 | 
						||
| 
								 | 
							
								 *    <td>Full Speed Mode</td>
							 | 
						||
| 
								 | 
							
								 *   </tr>
							 | 
						||
| 
								 | 
							
								 *  </table>
							 | 
						||
| 
								 | 
							
								 *
							 | 
						||
| 
								 | 
							
								 *  \section SSec_Description Project Description: 
							 | 
						||
| 
								 | 
							
								 *
							 | 
						||
| 
								 | 
							
								 *  Combined Communications Device Class/Mouse demonstration application.
							 | 
						||
| 
								 | 
							
								 *  This gives a simple reference application for implementing a combined
							 | 
						||
| 
								 | 
							
								 *  CDC and HID device acting as a both a virtual serial port and a mouse.
							 | 
						||
| 
								 | 
							
								 *  Joystick actions are transmitted to the host as strings and as mouse
							 | 
						||
| 
								 | 
							
								 *  movements. The device does not respond to serial data sent from the host.
							 | 
						||
| 
								 | 
							
								 *  
							 | 
						||
| 
								 | 
							
								 *  After running this demo for the first time on a new computer,
							 | 
						||
| 
								 | 
							
								 *  you will need to supply the .INF file located in this demo
							 | 
						||
| 
								 | 
							
								 *  project's directory as the device's driver when running under
							 | 
						||
| 
								 | 
							
								 *  Windows. This will enable Windows to use its inbuilt CDC drivers,
							 | 
						||
| 
								 | 
							
								 *  negating the need for custom drivers for the device. Other
							 | 
						||
| 
								 | 
							
								 *  Operating Systems should automatically use their own inbuilt
							 | 
						||
| 
								 | 
							
								 *  CDC-ACM drivers.
							 | 
						||
| 
								 | 
							
								 *
							 | 
						||
| 
								 | 
							
								 *  \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>
							 | 
						||
| 
								 | 
							
								 *     None
							 | 
						||
| 
								 | 
							
								 *    </td>
							 | 
						||
| 
								 | 
							
								 *   </tr>
							 | 
						||
| 
								 | 
							
								 *  </table>
							 | 
						||
| 
								 | 
							
								 */
							 |