eqmk
/
qmk_firmware
forked from mfulz_github/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Documentation improvements - put driver example code into its own section, fix incorrect and missing section names.

This commit is contained in:
Dean Camera 2010-12-26 14:55:26 +00:00
parent 2073b96d82
commit a8b66f318d
109 changed files with 357 additions and 318 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Bootloaders/CDC/BootloaderCDC.txt
View File

@ -6,7 +6,7 @@
/** \mainpage CDC Class USB AVR Bootloader
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -42,7 +42,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* This bootloader enumerates to the host as a CDC Class device (virtual serial port), allowing for AVR109
* protocol compatible programming software to load firmware onto the AVR.
@ -58,7 +58,7 @@
* 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
* \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.
*

8
Bootloaders/DFU/BootloaderDFU.txt
View File

@ -6,7 +6,7 @@
/** \mainpage DFU Class USB AVR Bootloader
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -42,7 +42,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* This bootloader enumerates to the host as a DFU Class device, allowing for DFU-compatible programming
* software to load firmware onto the AVR.
@ -69,7 +69,7 @@
* drivers included with FLIP will work. If you do not wish to use Atmel's ID codes, please
* manually change them in Descriptors.c and alter your driver's INF file accordingly.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/ClassDriver/AudioInput/AudioInput.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Audio Input Device Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -14,7 +14,7 @@
* - Series 6 USB AVRs (AT90USBxxx6)
* - Series 4 USB AVRs (ATMEGAxxU4)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -43,7 +43,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Audio demonstration application. This gives a simple reference
* application for implementing a USB Audio Input device using the
@ -61,7 +61,7 @@
* Under Windows, if a driver request dialogue pops up, select the option
* to automatically install the appropriate drivers.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Audio Output Device Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -14,7 +14,7 @@
* - Series 6 USB AVRs (AT90USBxxx6)
* - Series 4 USB AVRs (ATMEGAxxU4)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -43,7 +43,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Audio demonstration application. This gives a simple reference
* application for implementing a USB Audio Output device using the
@ -61,7 +61,7 @@
* Under Windows, if a driver request dialogue pops up, select the option
* to automatically install the appropriate drivers.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/ClassDriver/DualVirtualSerial/DualVirtualSerial.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Dual Communications Device Class (Dual Virtual Serial Port) Device
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -14,7 +14,7 @@
* - Series 6 USB AVRs (AT90USBxxx6)
* - Series 4 USB AVRs (ATMEGAxxU4)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -46,7 +46,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Dual Communications Device Class demonstration application.
* This gives a simple reference application for implementing
@ -71,7 +71,7 @@
* Operating Systems should automatically use their own inbuilt
* CDC-ACM drivers.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/ClassDriver/GenericHID/GenericHID.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Generic HID Device
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -44,7 +44,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Generic HID device demonstration application. This gives a simple reference application
* for implementing a generic HID device, using the basic USB HID drivers in all modern
@ -55,7 +55,7 @@
* When controlled by a custom HID class application, reports can be sent and received by
* both the standard data endpoint and control request methods defined in the HID specification.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/ClassDriver/Joystick/Joystick.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Joystick Device Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -44,7 +44,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Joystick demonstration application. This gives a simple reference
* application for implementing a USB Keyboard device, for USB Joysticks
@ -59,7 +59,7 @@
*
* Currently only single interface joysticks are supported.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/ClassDriver/Keyboard/Keyboard.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Keyboard Device Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -44,7 +44,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Keyboard demonstration application. This gives a simple reference application
* for implementing a USB Keyboard using the basic USB HID drivers in all modern
@ -58,7 +58,7 @@
* other LUFA Keyboard demos, this example shows explicitly how to send multiple key presses
* inside the same report to the host.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Dual HID Keyboard and Mouse Device Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -44,7 +44,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Keyboard/Mouse demonstration application. This gives a simple reference
* application for implementing a composite device containing both USB Keyboard
@ -63,7 +63,7 @@
* joystick to move the pointer, and push the joystick inwards to simulate a
* left-button click.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/ClassDriver/MIDI/MIDI.txt
View File

@ -6,7 +6,7 @@
/** \mainpage MIDI Input Device Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -44,7 +44,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* MIDI demonstration application. This gives a simple reference
* application for implementing the USB-MIDI class in USB devices.
@ -60,7 +60,7 @@
* This device implements MIDI-THRU mode, with the IN MIDI data being
* generated by the device itself. OUT MIDI data is discarded.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/ClassDriver/MassStorage/MassStorage.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Mass Storage Device Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -45,7 +45,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Dual LUN Mass Storage demonstration application. This gives a simple
* reference application for implementing a multiple LUN USB Mass Storage
@ -72,7 +72,7 @@
* the host to reset the Mass Storage device state during long transfers without
* the need for complicated polling logic.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Combined Mass Storage and Keyboard Device Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -49,7 +49,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Combined Mass Storage and Keyboard demonstration application. This gives a
* simple reference application for implementing a dual class USB Mass Storage
@ -72,7 +72,7 @@
* the host to reset the Mass Storage device state during long transfers without
* the need for complicated polling logic.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/ClassDriver/Mouse/Mouse.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Mouse Device Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -44,7 +44,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Mouse demonstration application. This gives a simple reference
* application for implementing a USB Mouse using the basic USB HID
@ -58,7 +58,7 @@
* joystick inwards to simulate a left-button click. The HWB serves as
* the right mouse button.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt
View File

@ -6,14 +6,14 @@
/** \mainpage RNDIS Class Ethernet Demo (with Webserver/Telnet)
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
* - Series 6 USB AVRs (AT90USBxxx6)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -40,7 +40,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Remote Network Driver Interface demonstration application.
* This gives a simple reference application for implementing
@ -73,7 +73,7 @@
* recommended that it be replaced with an external open source TCP/IP
* stack that is feature complete, such as the uIP stack.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/ClassDriver/VirtualSerial/VirtualSerial.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Communications Device Class (Virtual Serial Port) Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -42,7 +42,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Communications Device Class demonstration application.
* This gives a simple reference application for implementing
@ -58,7 +58,7 @@
* Operating Systems should automatically use their own inbuilt
* CDC-ACM drivers.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Combined Communications Device Class (Virtual Serial Port) and Mouse Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -46,7 +46,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Combined Communications Device Class/Mouse demonstration application.
* This gives a simple reference application for implementing a combined
@ -62,7 +62,7 @@
* Operating Systems should automatically use their own inbuilt
* CDC-ACM drivers.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/LowLevel/AudioInput/AudioInput.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Audio Input Device Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -14,7 +14,7 @@
* - Series 6 USB AVRs (AT90USBxxx6)
* - Series 4 USB AVRs (ATMEGAxxU4)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -43,7 +43,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Audio demonstration application. This gives a simple reference
* application for implementing a USB Audio Input device using the
@ -61,7 +61,7 @@
* Under Windows, if a driver request dialogue pops up, select the option
* to automatically install the appropriate drivers.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/LowLevel/AudioOutput/AudioOutput.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Audio Output Device Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -14,7 +14,7 @@
* - Series 6 USB AVRs (AT90USBxxx6)
* - Series 4 USB AVRs (ATMEGAxxU4)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -43,7 +43,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Audio demonstration application. This gives a simple reference
* application for implementing a USB Audio Output device using the
@ -61,7 +61,7 @@
* Under Windows, if a driver request dialogue pops up, select the option
* to automatically install the appropriate drivers.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/LowLevel/DualVirtualSerial/DualVirtualSerial.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Dual Communications Device Class (Dual Virtual Serial Port) Device
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -14,7 +14,7 @@
* - Series 6 USB AVRs (AT90USBxxx6)
* - Series 4 USB AVRs (ATMEGAxxU4)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -46,7 +46,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Dual Communications Device Class demonstration application.
* This gives a simple reference application for implementing
@ -71,7 +71,7 @@
* Operating Systems should automatically use their own inbuilt
* CDC-ACM drivers.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/LowLevel/GenericHID/GenericHID.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Generic HID Device
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -44,7 +44,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Generic HID device demonstration application. This gives a simple reference application
* for implementing a generic HID device, using the basic USB HID drivers in all modern
@ -55,7 +55,7 @@
* When controlled by a custom HID class application, reports can be sent and received by
* both the standard data endpoint and control request methods defined in the HID specification.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/LowLevel/Joystick/Joystick.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Joystick Device Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -44,7 +44,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Joystick demonstration application. This gives a simple reference
* application for implementing a USB Keyboard device, for USB Joysticks
@ -59,7 +59,7 @@
*
* Currently only single interface joysticks are supported.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/LowLevel/Keyboard/Keyboard.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Keyboard Device Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -44,7 +44,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Keyboard demonstration application. This gives a simple reference application
* for implementing a USB Keyboard using the basic USB HID drivers in all modern
@ -58,7 +58,7 @@
* other LUFA Keyboard demos, this example shows explicitly how to send multiple key presses
* inside the same report to the host.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/LowLevel/KeyboardMouse/KeyboardMouse.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Dual HID Keyboard and Mouse Device Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -44,7 +44,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Keyboard/Mouse demonstration application. This gives a simple reference
* application for implementing a composite device containing both USB Keyboard
@ -63,7 +63,7 @@
* joystick to move the pointer, and push the joystick inwards to simulate a
* left-button click.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/LowLevel/MIDI/MIDI.txt
View File

@ -6,7 +6,7 @@
/** \mainpage MIDI Input Device Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -44,7 +44,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* MIDI demonstration application. This gives a simple reference
* application for implementing the USB-MIDI class in USB devices.
@ -60,7 +60,7 @@
* This device implements MIDI-THRU mode, with the IN MIDI data being
* generated by the device itself. OUT MIDI data is discarded.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/LowLevel/MassStorage/MassStorage.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Mass Storage Device Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -45,7 +45,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Dual LUN Mass Storage demonstration application. This gives a simple
* reference application for implementing a multiple LUN USB Mass Storage
@ -72,7 +72,7 @@
* the host to reset the Mass Storage device state during long transfers without
* the need for complicated polling logic.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/LowLevel/Mouse/Mouse.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Mouse Device Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -44,7 +44,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Mouse demonstration application. This gives a simple reference
* application for implementing a USB Mouse using the basic USB HID
@ -58,7 +58,7 @@
* joystick inwards to simulate a left-button click. The HWB serves as
* the right mouse button.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.txt
View File

@ -6,14 +6,14 @@
/** \mainpage RNDIS Class Ethernet Demo (with Webserver/Telnet)
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
* - Series 6 USB AVRs (AT90USBxxx6)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -40,7 +40,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Remote Network Driver Interface demonstration application.
* This gives a simple reference application for implementing
@ -73,7 +73,7 @@
* recommended that it be replaced with an external open source TCP/IP
* stack that is feature complete, such as the uIP stack.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Device/LowLevel/VirtualSerial/VirtualSerial.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Communications Device Class (Virtual Serial Port) Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -42,7 +42,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Communications Device Class demonstration application.
* This gives a simple reference application for implementing
@ -58,7 +58,7 @@
* Operating Systems should automatically use their own inbuilt
* CDC-ACM drivers.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/DualRole/ClassDriver/MouseHostDevice/MouseHostDevice.txt
View File

@ -6,13 +6,13 @@
/** \mainpage Mouse Host/Device Dual Role Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -39,7 +39,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Mouse host/device dual role demonstration application. This gives a simple
* reference application for implementing a dual role USB Mouse, for USB mice
@ -65,7 +65,7 @@
* joystick inwards to simulate a left-button click. The HWB serves as
* the right mouse button.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/ClassDriver/JoystickHostWithParser/JoystickHostWithParser.txt
View File

@ -6,13 +6,13 @@
/** \mainpage Joystick Host With HID Descriptor Parser Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Joystick host demonstration application. This gives a simple reference
* application for implementing a USB Joystick host, for USB joysticks using
@ -56,7 +56,7 @@
*
* Currently only single interface joysticks are supported.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt
View File

@ -6,13 +6,13 @@
/** \mainpage Keyboard Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -39,7 +39,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Keyboard host demonstration application. This gives a simple reference
* application for implementing a USB keyboard, for USB keyboards using
@ -56,7 +56,7 @@
*
* Currently only single interface keyboards are supported.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.txt
View File

@ -6,13 +6,13 @@
/** \mainpage Keyboard Host With HID Descriptor Parser Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Keyboard host demonstration application. This gives a simple reference
* application for implementing a USB Keyboard host, for USB keyboards using
@ -56,7 +56,7 @@
*
* Currently only single interface keyboards are supported.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/ClassDriver/MIDIHost/MIDIHost.txt
View File

@ -6,13 +6,13 @@
/** \mainpage MIDI Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -39,13 +39,13 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* MIDI host demonstration application. This demo will enumerate an attached USB-MIDI device, and print incoming MIDI note
* on and off messages on any channel to the serial port. Pressing the board joystick will send note on and off messages to
* the attached MIDI device, with the board HWB controlling the note channel.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/ClassDriver/MassStorageHost/MassStorageHost.txt
View File

@ -6,13 +6,13 @@
/** \mainpage Mass Storage Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -42,7 +42,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Mass Storage host demonstration application. This gives a simple reference
* application for implementing a USB Mass Storage host, for USB storage devices
@ -53,7 +53,7 @@
* AVR. The device will then wait for HWB to be pressed, whereupon the entire ASCII contents
* of the disk will be dumped to the serial port.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/ClassDriver/MouseHost/MouseHost.txt
View File

@ -6,13 +6,13 @@
/** \mainpage Mouse Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Mouse host demonstration application. This gives a simple reference
* application for implementing a USB Mouse host, for USB mice using
@ -59,7 +59,7 @@
*
* Currently only single interface mice are supported.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.txt
View File

@ -6,13 +6,13 @@
/** \mainpage Mouse Host With HID Descriptor Parser Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Mouse host demonstration application. This gives a simple reference
* application for implementing a USB Mouse host, for USB mice using
@ -56,7 +56,7 @@
*
* Currently only single interface mice are supported.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/ClassDriver/PrinterHost/PrinterHost.txt
View File

@ -6,13 +6,13 @@
/** \mainpage Printer Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Printer host demonstration application. This gives a simple reference
* application for implementing a USB Printer host, for USB printers using
@ -51,7 +51,7 @@
* to the AVR's serial port, and a simple test page is printed using the PCL
* printer language.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/ClassDriver/RNDISEthernetHost/RNDISEthernetHost.txt
View File

@ -6,13 +6,13 @@
/** \mainpage RNDIS Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -39,7 +39,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* RNDIS host demonstration application. This gives a simple reference
* application for implementing a RNDIS Ethernet host, for USB devices such as
@ -48,7 +48,7 @@
* This demo will enumerate an attached USB RNDIS device, print out its vendor ID
* and any received packets in raw form through the serial USART.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/ClassDriver/StillImageHost/StillImageHost.txt
View File

@ -6,13 +6,13 @@
/** \mainpage Still Image Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -40,7 +40,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Still Image host demonstration application. This gives a simple reference
* application for implementing a Still Image host, for USB devices such as
@ -50,7 +50,7 @@
* information structure, open a session with the device and finally close the
* session.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/ClassDriver/VirtualSerialHost/VirtualSerialHost.txt
View File

@ -6,13 +6,13 @@
/** \mainpage CDC Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -39,7 +39,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* CDC host demonstration application. This gives a simple reference application
* for implementing a USB CDC host, for CDC devices using the standard ACM profile.
@ -51,7 +51,7 @@
* specific features, thus use vendor-specific class/subclass/protocol codes to force
* the user to use specialized drivers. This demo is not compatible with such devices.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/LowLevel/GenericHIDHost/GenericHIDHost.txt
View File

@ -6,13 +6,13 @@
/** \mainpage Generic HID Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Generic HID host demonstration application. This gives a simple reference
* application for implementing a Generic HID USB host, for any device implementing
@ -49,7 +49,7 @@
*
* Received reports from the attached device are printed to the serial port.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/LowLevel/JoystickHostWithParser/JoystickHostWithParser.txt
View File

@ -6,13 +6,13 @@
/** \mainpage Joystick Host With HID Descriptor Parser Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Joystick host demonstration application. This gives a simple reference
* application for implementing a USB Joystick host, for USB joysticks using
@ -56,7 +56,7 @@
*
* Currently only single interface joysticks are supported.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/LowLevel/KeyboardHost/KeyboardHost.txt
View File

@ -6,13 +6,13 @@
/** \mainpage Keyboard Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Keyboard host demonstration application. This gives a simple reference
* application for implementing a USB keyboard, for USB keyboards using
@ -58,7 +58,7 @@
*
* Currently only single interface keyboards are supported.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/LowLevel/KeyboardHostWithParser/KeyboardHostWithParser.txt
View File

@ -6,13 +6,13 @@
/** \mainpage Keyboard Host With HID Descriptor Parser Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Keyboard host demonstration application. This gives a simple reference
* application for implementing a USB Keyboard host, for USB keyboards using
@ -56,7 +56,7 @@
*
* Currently only single interface keyboards are supported.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/LowLevel/MIDIHost/MIDIHost.txt
View File

@ -6,13 +6,13 @@
/** \mainpage MIDI Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -39,13 +39,13 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* MIDI host demonstration application. This demo will enumerate an attached USB-MIDI device, and print incoming MIDI note
* on and off messages on any channel to the serial port. Pressing the board joystick will send note on and off messages to
* the attached MIDI device, with the board HWB controlling the note channel.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/LowLevel/MassStorageHost/MassStorageHost.txt
View File

@ -6,13 +6,13 @@
/** \mainpage Mass Storage Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -42,7 +42,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Mass Storage host demonstration application. This gives a simple reference
* application for implementing a USB Mass Storage host, for USB storage devices
@ -53,7 +53,7 @@
* AVR. The device will then wait for HWB to be pressed, whereupon the entire ASCII contents
* of the disk will be dumped to the serial port.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/LowLevel/MouseHost/MouseHost.txt
View File

@ -6,13 +6,13 @@
/** \mainpage Mouse Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Mouse host demonstration application. This gives a simple reference
* application for implementing a USB Mouse host, for USB mice using
@ -59,7 +59,7 @@
*
* Currently only single interface mice are supported.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/LowLevel/MouseHostWithParser/MouseHostWithParser.txt
View File

@ -6,13 +6,13 @@
/** \mainpage Mouse Host With HID Descriptor Parser Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Mouse host demonstration application. This gives a simple reference
* application for implementing a USB Mouse host, for USB mice using
@ -56,7 +56,7 @@
*
* Currently only single interface mice are supported.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/LowLevel/PrinterHost/PrinterHost.txt
View File

@ -6,13 +6,13 @@
/** \mainpage Printer Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -38,7 +38,7 @@
* Full Speed Mode</td>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Printer host demonstration application. This gives a simple reference
* application for implementing a USB Printer host, for USB printers using
@ -48,7 +48,7 @@
* to the AVR's serial port, and a simple test page is printed using the PCL
* printer language.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/LowLevel/RNDISEthernetHost/RNDISHost.txt
View File

@ -6,13 +6,13 @@
/** \mainpage RNDIS Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -39,7 +39,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* RNDIS host demonstration application. This gives a simple reference
* application for implementing a RNDIS Ethernet host, for USB devices such as
@ -48,7 +48,7 @@
* This demo will enumerate an attached USB RNDIS device, print out its vendor ID
* and any received packets in raw form through the serial USART.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/LowLevel/StillImageHost/StillImageHost.txt
View File

@ -6,13 +6,13 @@
/** \mainpage Still Image Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -40,7 +40,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Still Image host demonstration application. This gives a simple reference
* application for implementing a Still Image host, for USB devices such as
@ -50,7 +50,7 @@
* information structure, open a session with the device and finally close the
* session.
*
* \section SSec_Options Project Options
* \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.
*

8
Demos/Host/LowLevel/VirtualSerialHost/VirtualSerialHost.txt
View File

@ -6,13 +6,13 @@
/** \mainpage CDC Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -39,7 +39,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* CDC host demonstration application. This gives a simple reference application
* for implementing a USB CDC host, for CDC devices using the standard ACM profile.
@ -51,7 +51,7 @@
* specific features, thus use vendor-specific class/subclass/protocol codes to force
* the user to use specialized drivers. This demo is not compatible with such devices.
*
* \section SSec_Options Project Options
* \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.
*

7
LUFA/Drivers/Board/Buttons.h
View File

@ -50,7 +50,7 @@
* The following files must be built with any user project that uses this module:
* - None
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Hardware buttons driver. This provides an easy to use driver for the hardware buttons present on many boards.
* It provides a way to easily configure and check the status of all the buttons on the board so that appropriate
* actions can be taken.
@ -60,7 +60,10 @@
*
* For possible BOARD makefile values, see \ref Group_BoardTypes.
*
* <b>Example Usage:</b>
* \section Sec_ExampleUsage Example Usage
* The following snippet is an example of how this module may be used within a typical
* application.
*
* \code
* // Initialise the button driver before first use
* Buttons_Init();

7
LUFA/Drivers/Board/Dataflash.h
View File

@ -50,7 +50,7 @@
* The following files must be built with any user project that uses this module:
* - None
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Dataflash driver. This module provides an easy to use interface for the Dataflash ICs located on many boards,
* for the storage of large amounts of data into the Dataflash's non-volatile memory.
*
@ -59,7 +59,10 @@
*
* For possible BOARD makefile values, see \ref Group_BoardTypes.
*
* <b>Example Usage:</b>
* \section Sec_ExampleUsage Example Usage
* The following snippet is an example of how this module may be used within a typical
* application.
*
* \code
* // Initialise the SPI and board Dataflash drivers before first use
* SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING |

7
LUFA/Drivers/Board/Joystick.h
View File

@ -50,7 +50,7 @@
* The following files must be built with any user project that uses this module:
* - None
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick
* located on many boards.
*
@ -59,7 +59,10 @@
*
* For possible BOARD makefile values, see \ref Group_BoardTypes.
*
* <b>Example Usage:</b>
* \section Sec_ExampleUsage Example Usage
* The following snippet is an example of how this module may be used within a typical
* application.
*
* \code
* // Initialise the board Joystick driver before first use
* Joystick_Init();

7
LUFA/Drivers/Board/LEDs.h
View File

@ -50,7 +50,7 @@
* The following files must be built with any user project that uses this module:
* - None
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Hardware LEDs driver. This provides an easy to use driver for the hardware LEDs present on many boards. It
* provides an interface to configure, test and change the status of all the board LEDs.
*
@ -68,7 +68,10 @@
* compatible code for a board with no LEDs by making a board LED driver (see \ref Page_WritingBoardDrivers)
* which contains only stub functions and defines no LEDs.
*
* <b>Example Usage:</b>
* \section Sec_ExampleUsage Example Usage
* The following snippet is an example of how this module may be used within a typical
* application.
*
* \code
* // Initialise the board LED driver before first use
* LEDs_Init();

7
LUFA/Drivers/Board/Temperature.h
View File

@ -41,13 +41,16 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/Board/Temperature.c <i>(Makefile source module name: LUFA_SRC_TEMPERATURE)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Temperature sensor driver. This provides an easy to use interface for the hardware temperature sensor located
* on many boards. It provides an interface to configure the sensor and appropriate ADC channel, plus read out the
* current temperature in degrees C. It is designed for and will only work with the temperature sensor located on the
* official Atmel USB AVR boards, as each sensor has different characteristics.
*
* <b>Example Usage:</b>
* \section Sec_ExampleUsage Example Usage
* The following snippet is an example of how this module may be used within a typical
* application.
*
* \code
* // Initialise the ADC and board temperature sensor drivers before first use
* ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_128);

7
LUFA/Drivers/Misc/RingBuffer.h
View File

@ -47,7 +47,7 @@
* The following files must be built with any user project that uses this module:
* - None
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of
* different sizes to suit different needs.
*
@ -56,7 +56,10 @@
* or deletions) must not overlap. If there is possibility of two or more of the same kind of
* operating occuring at the same point in time, atomic (mutex) locking should be used.
*
* <b>Example Usage:</b>
* \section Sec_ExampleUsage Example Usage
* The following snippet is an example of how this module may be used within a typical
* application.
*
* \code
* // Create the buffer structure and its underlying storage array
* RingBuff_t Buffer;

12
LUFA/Drivers/Misc/TerminalCodes.h
View File

@ -42,16 +42,22 @@
* The following files must be built with any user project that uses this module:
* - None
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Escape code macros for ANSI compliant text terminals.
*
* \note If desired, the macro DISABLE_TERMINAL_CODES can be defined in the project makefile and passed to the GCC
* compiler via the -D switch to disable the terminal codes without modifying the source, for use with non
* compatible terminals (any terminal codes then equate to empty strings).
*
* <b>Example Usage:</b>
* \section Sec_ExampleUsage Example Usage
* The following snippet is an example of how this module may be used within a typical
* application.
*
* \code
* printf("Some String, " ESC_BOLD_ON " Some bold string");
* printf("Normal String, "
* ESC_BOLD_ON "Bold String, "
* ESC_UNDERLINE_ON "Bold and Underlined String"
* ESC_RESET ESC_FG_BLUE ESC_BG_YELLOW "Normal Blue-on-Yellow String");
* \endcode
*
* @{

2
LUFA/Drivers/Peripheral/ADC.h
View File

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - None
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Hardware ADC driver. This module provides an easy to use driver for the hardware
* ADC present on many AVR models, for the conversion of analogue signals into the
* digital domain.

5
LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h
View File

@ -47,7 +47,10 @@
* \note This file should not be included directly. It is automatically included as needed by the ADC driver
* dispatch header located in LUFA/Drivers/Peripheral/ADC.h.
*
* <b>Example Usage:</b>
* \section Sec_ExampleUsage Example Usage
* The following snippet is an example of how this module may be used within a typical
* application.
*
* \code
* // Initialise the ADC driver before first use
* ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_32);

5
LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
View File

@ -45,7 +45,10 @@
* \note This file should not be included directly. It is automatically included as needed by the TWI driver
* dispatch header located in LUFA/Drivers/Peripheral/TWI.h.
*
* <b>Example Usage:</b>
* \section Sec_ExampleUsage Example Usage
* The following snippet is an example of how this module may be used within a typical
* application.
*
* \code
* // Initialise the TWI driver before first use
* TWI_Init();

7
LUFA/Drivers/Peripheral/SPI.h
View File

@ -41,11 +41,14 @@
* The following files must be built with any user project that uses this module:
* - None
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Driver for the hardware SPI port available on most AVR models. This module provides
* an easy to use driver for the setup of and transfer of data over the AVR's SPI port.
*
* <b>Example Usage:</b>
* \section Sec_ExampleUsage Example Usage
* The following snippet is an example of how this module may be used within a typical
* application.
*
* \code
* // Initialise the SPI driver before first use
* SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING |

7
LUFA/Drivers/Peripheral/Serial.h
View File

@ -41,11 +41,14 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/Peripheral/Serial.c <i>(Makefile source module name: LUFA_SRC_SERIAL)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Hardware serial USART driver. This module provides an easy to use driver for
* the setup of and transfer of data over the AVR's USART port.
*
* <b>Example Usage:</b>
* \section Sec_ExampleUsage Example Usage
* The following snippet is an example of how this module may be used within a typical
* application.
*
* \code
* // Initialise the serial USART driver before first use, with 9600 baud (and no double-speed mode)
* Serial_Init(9600, false);

7
LUFA/Drivers/Peripheral/SerialStream.h
View File

@ -44,13 +44,16 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/Peripheral/SerialStream.c <i>(Makefile source module name: LUFA_SRC_SERIALSTREAM)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Serial stream driver for the USART subsystem on supported USB AVRs. This makes use of the functions in the
* regular USART driver (see \ref Group_Serial), but allows the avr-libc standard stream functions (printf,
* puts, etc.) to work with the USART. Upon configuration, this will redirect the standard input and output
* streams to the USART.
*
* <b>Example Usage:</b>
* \section Sec_ExampleUsage Example Usage
* The following snippet is an example of how this module may be used within a typical
* application.
*
* \code
* // Initialise the Serial Stream driver before first use, with 9600 baud (and no double-speed mode)
* SerialStream_Init(9600, false);

2
LUFA/Drivers/Peripheral/TWI.h
View File

@ -45,7 +45,7 @@
* - LUFA/Drivers/Peripheral/TWI.c <i>(Makefile source module name: LUFA_SRC_TWI)</i>
*
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Master Mode Hardware TWI driver. This module provides an easy to use driver for the hardware
* TWI present on many AVR models, for the transmission and reception of data on a TWI bus.
*

2
LUFA/Drivers/USB/Class/Audio.h
View File

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Device/Audio.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Audio Class Driver module. This module contains an internal implementation of the USB Audio 1.0 Class, for Device
* USB mode only. User applications can use this class driver instead of implementing the Audio class manually via
* the low-level LUFA APIs.

2
LUFA/Drivers/USB/Class/CDC.h
View File

@ -45,7 +45,7 @@
* - LUFA/Drivers/USB/Class/Device/CDC.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
* - LUFA/Drivers/USB/Class/Host/CDC.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* CDC Class Driver module. This module contains an internal implementation of the USB CDC-ACM class Virtual Serial
* Ports, for both Device and Host USB modes. User applications can use this class driver instead of implementing the
* CDC class manually via the low-level LUFA APIs.

2
LUFA/Drivers/USB/Class/Common/Audio.h
View File

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassAudio
* @defgroup Group_USBClassAudioCommon Common Class Definitions
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* Audio 1.0 Class.
*

2
LUFA/Drivers/USB/Class/Common/CDC.h
View File

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassCDC
* @defgroup Group_USBClassCDCCommon Common Class Definitions
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* CDC Class.
*

2
LUFA/Drivers/USB/Class/Common/HID.h
View File

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassHID
* @defgroup Group_USBClassHIDCommon Common Class Definitions
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* HID Class.
*

2
LUFA/Drivers/USB/Class/Common/MIDI.h
View File

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassMIDI
* @defgroup Group_USBClassMIDICommon Common Class Definitions
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* MIDI Class.
*

2
LUFA/Drivers/USB/Class/Common/MassStorage.h
View File

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassMS
* @defgroup Group_USBClassMSCommon Common Class Definitions
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* Mass Storage Class.
*

2
LUFA/Drivers/USB/Class/Common/Printer.h
View File

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassPrinter
* @defgroup Group_USBClassPrinterCommon Common Class Definitions
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* Printer Class.
*

2
LUFA/Drivers/USB/Class/Common/RNDIS.h
View File

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassRNDIS
* @defgroup Group_USBClassRNDISCommon Common Class Definitions
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* RNDIS Class.
*

2
LUFA/Drivers/USB/Class/Common/StillImage.h
View File

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassSI
* @defgroup Group_USBClassSICommon Common Class Definitions
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* Still Image Class.
*

2
LUFA/Drivers/USB/Class/Device/Audio.h
View File

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Device/Audio.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Device Mode USB Class driver framework interface, for the Audio 1.0 USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/Device/CDC.h
View File

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Device/CDC.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Device Mode USB Class driver framework interface, for the CDC USB Class driver.
*
* \note There are several major drawbacks to the CDC-ACM standard USB class, however

2
LUFA/Drivers/USB/Class/Device/HID.h
View File

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Device/HID.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Device Mode USB Class driver framework interface, for the HID USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/Device/MIDI.h
View File

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Device/MIDI.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Device Mode USB Class driver framework interface, for the MIDI USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/Device/MassStorage.h
View File

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Device/MassStorage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Device Mode USB Class driver framework interface, for the Mass Storage USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/Device/RNDIS.h
View File

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Device/RNDIS.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Device Mode USB Class driver framework interface, for the RNDIS USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/HID.h
View File

@ -46,7 +46,7 @@
* - LUFA/Drivers/USB/Class/Host/HID.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
* - LUFA/Drivers/USB/Class/Host/HIDParser.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* HID Class Driver module. This module contains an internal implementation of the USB HID Class, for both Device
* and Host USB modes. User applications can use this class driver instead of implementing the HID class manually
* via the low-level LUFA APIs.

2
LUFA/Drivers/USB/Class/Host/CDC.h
View File

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Host/CDC.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Host Mode USB Class driver framework interface, for the CDC USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/Host/HID.h
View File

@ -45,7 +45,7 @@
* - LUFA/Drivers/USB/Class/Host/HID.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
* - LUFA/Drivers/USB/Class/Host/HIDParser.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Host Mode USB Class driver framework interface, for the HID USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/Host/HIDParser.h
View File

@ -43,7 +43,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Host/HIDParser.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Functions, macros, variables, enums and types related to the parsing of HID class device report descriptors.
*
* The processed HID report is presented back to the user application as a flat structure containing each report

2
LUFA/Drivers/USB/Class/Host/MIDI.h
View File

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Host/MIDI.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Host Mode USB Class driver framework interface, for the MIDI USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/Host/MassStorage.h
View File

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Host/MassStorage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Host Mode USB Class driver framework interface, for the Mass Storage USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/Host/Printer.h
View File

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Host/Printer.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Host Mode USB Class driver framework interface, for the Printer USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/Host/RNDIS.h
View File

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Host/RNDIS.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Host Mode USB Class driver framework interface, for the Microsoft RNDIS Ethernet
* USB Class driver.
*

2
LUFA/Drivers/USB/Class/Host/StillImage.h
View File

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Host/StillImage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Host Mode USB Class driver framework interface, for the Still Image USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/MIDI.h
View File

@ -45,7 +45,7 @@
* - LUFA/Drivers/USB/Class/Device/MIDI.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
* - LUFA/Drivers/USB/Class/Host/MIDI.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* MIDI Class Driver module. This module contains an internal implementation of the USB MIDI Class, for both Device
* and Host USB modes. User applications can use this class driver instead of implementing the MIDI class manually
* via the low-level LUFA APIs.

2
LUFA/Drivers/USB/Class/MassStorage.h
View File

@ -45,7 +45,7 @@
* - LUFA/Drivers/USB/Class/Device/MassStorage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
* - LUFA/Drivers/USB/Class/Host/MassStorage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Mass Storage Class Driver module. This module contains an internal implementation of the USB Mass Storage Class, for both
* Device and Host USB modes. User applications can use this class driver instead of implementing the Mass Storage class
* manually via the low-level LUFA APIs.

2
LUFA/Drivers/USB/Class/Printer.h
View File

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Host/Printer.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Printer Class Driver module. This module contains an internal implementation of the USB Printer Class, for the base
* USB Printer transport layer for USB Host mode only. Note that printers are free to implement whatever printer language
* they choose on top of this (e.g. Postscript), and so this driver exposes low level data transport functions only rather

2
LUFA/Drivers/USB/Class/RNDIS.h
View File

@ -45,7 +45,7 @@
* - LUFA/Drivers/USB/Class/Device/RNDIS.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
* - LUFA/Drivers/USB/Class/Host/RNDIS.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* RNDIS Class Driver module. This module contains an internal implementation of the Microsoft USB RNDIS Networking
* Class, for both Device and Host USB modes. User applications can use this class driver instead of implementing the
* RNDIS class manually via the low-level LUFA APIs.

2
LUFA/Drivers/USB/Class/StillImage.h
View File

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Host/StillImage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Still Image Class Driver module. This module contains an internal implementation of the USB Still Image Class,
* for USB Host mode only. User applications can use this class driver instead of implementing the Still Image class
* manually via the low-level LUFA APIs.

6
LUFA/Drivers/USB/USB.h
View File

@ -55,7 +55,7 @@
* - LUFA/Drivers/USB/HighLevel/PipeStream.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
* - LUFA/Drivers/USB/HighLevel/USBTask.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Driver and framework for the USB controller hardware on the USB series of AVR microcontrollers. This module
* consists of many submodules, and is designed to provide an easy way to configure and control USB host, device
* or OTG mode USB applications.
@ -139,7 +139,7 @@
* slightly differently, and thus will be explained separately. For information on a specific class driver, read
* the class driver's module documentation.
*
* \subsection SSec_ClassDriverDevice Device Mode Class Drivers
* \subsection Sec_ClassDriverDevice Device Mode Class Drivers
* Implementing a Device Mode Class Driver in a user application requires a number of steps to be followed. Firstly,
* the module configuration and state structure must be added to the project source. These structures are named in a
* similar manner between classes, that of <i>USB_ClassInfo_<b>{Class Name}</b>_Device_t</i>, and are used to hold the
@ -238,7 +238,7 @@
* read and write routines. See each driver's individual documentation for more information on the
* class-specific functions.
*
* \subsection SSec_ClassDriverHost Host Mode Class Drivers
* \subsection Sec_ClassDriverHost Host Mode Class Drivers
* Implementing a Host Mode Class Driver in a user application requires a number of steps to be followed. Firstly,
* the module configuration and state structure must be added to the project source. These structures are named in a
* similar manner between classes, that of <i>USB_ClassInfo_<b>{Class Name}</b>_Host_t</i>, and are used to hold the

2
LUFA/Scheduler/Scheduler.h
View File

@ -45,7 +45,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Scheduler/Scheduler.c <i>(Makefile source module name: LUFA_SRC_SCHEDULER)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Simple round-robbin cooperative scheduler for use in basic projects where non real-time tasks need
* to be executed. Each task is executed in sequence, and can be enabled or disabled individually or as a group.
*

18
Projects/AVRISP-MKII/AVRISP-MKII.txt
View File

@ -6,7 +6,7 @@
/** \mainpage AVRISP MKII Programmer Project
*
* \section SSec_Compat Project Compatibility:
* \section Sec_Compat Project Compatibility:
*
* The following list indicates what microcontrollers are compatible with this project.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) - <i>8KB versions with reduced features only</i>
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this project.
*
@ -42,7 +42,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Firmware for an AVRStudio compatible AVRISP-MKII clone programmer. This project will enable the USB AVR series of
* microcontrollers to act as a clone of the official Atmel AVRISP-MKII programmer, usable within AVRStudio. In its
@ -109,8 +109,8 @@
* fuses have been mis-set. To use the recovery clock, connect the OCR1A pin of the USB AVR to the target AVR's
* XTAL1 pin, and set the ISP programming speed to 125KHz (note: other ISP speeds will not work correctly).
*
* <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n
* <b><sup>2</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i>
* <b><sup>1</sup></b> <i>Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only</i> \n
* <b><sup>2</sup></b> <i>See AUX line related tokens in the \ref Sec_Options section</i>
*
* \section Sec_PDI PDI Connections
* Connections to the device for PDI programming (when enabled):
@ -153,7 +153,7 @@
* </tr>
* </table>
*
* <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n
* <b><sup>1</sup></b> <i>Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only</i> \n
* <b><sup>2</sup></b> <i>The AVR's Tx and Rx become the DATA line when connected together via a pair of 220 ohm resistors</i> \n
*
* \section Sec_TPI TPI Connections
@ -197,11 +197,11 @@
* </tr>
* </table>
*
* <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n
* <b><sup>1</sup></b> <i>Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only</i> \n
* <b><sup>2</sup></b> <i>The AVR's Tx and Rx become the DATA line when connected together via a pair of 220 ohm resistors</i> \n
* <b><sup>3</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i>
* <b><sup>3</sup></b> <i>See AUX line related tokens in the \ref Sec_Options section</i>
*
* \section SSec_Options Project Options
* \section Sec_Options Project Options
*
* The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
*

8
Projects/Benito/Benito.txt
View File

@ -6,7 +6,7 @@
/** \mainpage Benito Arduino Programmer Project
*
* \section SSec_Compat Project Compatibility:
* \section Sec_Compat Project Compatibility:
*
* The following list indicates what microcontrollers are compatible with this project.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this project.
*
@ -43,7 +43,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Firmware for a USB AVR powered programmer for Arduino boards using the official Arduino bootloader. This
* project acts like a regular USB to Serial bridge, except that asserting the DTR line will cause a pulse
@ -56,7 +56,7 @@
* 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
* \section Sec_Options Project Options
*
* The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
*

Some files were not shown because too many files have changed in this diff Show More