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.
		
		
		
		
		
			
		
			
				
					77 lines
				
				2.2 KiB
			
		
		
			
		
	
	
					77 lines
				
				2.2 KiB
			| 
								 
											8 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 Mouse Device Demo
							 | 
						||
| 
								 | 
							
								 *
							 | 
						||
| 
								 | 
							
								 *  \section Sec_Compat Demo Compatibility:
							 | 
						||
| 
								 | 
							
								 *
							 | 
						||
| 
								 | 
							
								 *  The following list indicates what microcontrollers are compatible with this demo.
							 | 
						||
| 
								 | 
							
								 *
							 | 
						||
| 
								 | 
							
								 *  \li Series 7 USB AVRs (AT90USBxxx7)
							 | 
						||
| 
								 | 
							
								 *  \li Series 6 USB AVRs (AT90USBxxx6)
							 | 
						||
| 
								 | 
							
								 *  \li Series 4 USB AVRs (ATMEGAxxU4)
							 | 
						||
| 
								 | 
							
								 *  \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
							 | 
						||
| 
								 | 
							
								 *  \li Series AU XMEGA AVRs (ATXMEGAxxxAxU)
							 | 
						||
| 
								 | 
							
								 *  \li Series B XMEGA AVRs (ATXMEGAxxxBx)
							 | 
						||
| 
								 | 
							
								 *  \li Series C XMEGA AVRs (ATXMEGAxxxCx)
							 | 
						||
| 
								 | 
							
								 *
							 | 
						||
| 
								 | 
							
								 *  \section Sec_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>Human Interface Device (HID)</td>
							 | 
						||
| 
								 | 
							
								 *   </tr>
							 | 
						||
| 
								 | 
							
								 *   <tr>
							 | 
						||
| 
								 | 
							
								 *    <td><b>USB Subclass:</b></td>
							 | 
						||
| 
								 | 
							
								 *    <td>N/A</td>
							 | 
						||
| 
								 | 
							
								 *   </tr>
							 | 
						||
| 
								 | 
							
								 *   <tr>
							 | 
						||
| 
								 | 
							
								 *    <td><b>Relevant Standards:</b></td>
							 | 
						||
| 
								 | 
							
								 *    <td>USBIF HID Specification \n
							 | 
						||
| 
								 | 
							
								 *        USBIF HID Usage Tables</td>
							 | 
						||
| 
								 | 
							
								 *   </tr>
							 | 
						||
| 
								 | 
							
								 *   <tr>
							 | 
						||
| 
								 | 
							
								 *    <td><b>Supported USB Speeds:</b></td>
							 | 
						||
| 
								 | 
							
								 *    <td>Low Speed Mode \n
							 | 
						||
| 
								 | 
							
								 *        Full Speed Mode</td>
							 | 
						||
| 
								 | 
							
								 *   </tr>
							 | 
						||
| 
								 | 
							
								 *  </table>
							 | 
						||
| 
								 | 
							
								 *
							 | 
						||
| 
								 | 
							
								 *  \section Sec_Description Project Description:
							 | 
						||
| 
								 | 
							
								 *
							 | 
						||
| 
								 | 
							
								 *  Mouse demonstration application. This gives a simple reference
							 | 
						||
| 
								 | 
							
								 *  application for implementing a USB Mouse using the basic USB HID
							 | 
						||
| 
								 | 
							
								 *  drivers in all modern OSes (i.e. no special drivers required). It is
							 | 
						||
| 
								 | 
							
								 *  boot protocol compatible, and thus works under compatible BIOS as if
							 | 
						||
| 
								 | 
							
								 *  it was a native mouse (e.g. PS/2).
							 | 
						||
| 
								 | 
							
								 *
							 | 
						||
| 
								 | 
							
								 *  On start-up the system will automatically enumerate and function
							 | 
						||
| 
								 | 
							
								 *  as a mouse when the USB connection to a host is present. To use
							 | 
						||
| 
								 | 
							
								 *  the mouse, move the joystick to move the pointer, and push the
							 | 
						||
| 
								 | 
							
								 *  joystick inwards to simulate a left-button click. The HWB serves as
							 | 
						||
| 
								 | 
							
								 *  the right mouse button.
							 | 
						||
| 
								 | 
							
								 *
							 | 
						||
| 
								 | 
							
								 *  \section Sec_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>
							 | 
						||
| 
								 | 
							
								 */
							 | 
						||
| 
								 | 
							
								
							 |