forksand
/
qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

Browse Source
pull/1469/head
Dean Camera 14 years ago
parent 2073b96d82
commit a8b66f318d
109 changed files with 357 additions and 318 deletions
Show Stats Download Patch File Download Diff File

8
Bootloaders/CDC/BootloaderCDC.txt
Unescape View File

@ -6,7 +6,7 @@
/** \mainpage CDC Class USB AVR Bootloader /** \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. * The following list indicates what microcontrollers are compatible with this demo.
* *
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4) * - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) * - 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. * The following table gives a rundown of the USB utilization of this demo.
* *
@ -42,7 +42,7 @@
* </tr> * </tr>
* </table> * </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 * 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. * 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 * 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. * 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. * 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
Unescape View File

@ -6,7 +6,7 @@
/** \mainpage DFU Class USB AVR Bootloader /** \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. * The following list indicates what microcontrollers are compatible with this demo.
* *
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4) * - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) * - 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. * The following table gives a rundown of the USB utilization of this demo.
* *
@ -42,7 +42,7 @@
* </tr> * </tr>
* </table> * </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 * This bootloader enumerates to the host as a DFU Class device, allowing for DFU-compatible programming
* software to load firmware onto the AVR. * 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 * 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. * 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. * 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
Unescape View File

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

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

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

@ -6,7 +6,7 @@
/** \mainpage Generic HID Device /** \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. * The following list indicates what microcontrollers are compatible with this demo.
* *
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4) * - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) * - 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. * The following table gives a rundown of the USB utilization of this demo.
* *
@ -44,7 +44,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* Generic HID device demonstration application. This gives a simple reference application * 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 * 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 * 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. * 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. * 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
Unescape View File

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

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

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

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

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

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

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

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

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

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

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

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

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

@ -6,7 +6,7 @@
/** \mainpage Generic HID Device /** \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. * The following list indicates what microcontrollers are compatible with this demo.
* *
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4) * - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) * - 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. * The following table gives a rundown of the USB utilization of this demo.
* *
@ -44,7 +44,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* Generic HID device demonstration application. This gives a simple reference application * 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 * 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 * 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. * 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. * 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
Unescape View File

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

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

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

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

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

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

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

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

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

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

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

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

@ -6,13 +6,13 @@
/** \mainpage MIDI Host Demo /** \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. * The following list indicates what microcontrollers are compatible with this demo.
* *
* - Series 7 USB AVRs (AT90USBxxx7) * - 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. * The following table gives a rundown of the USB utilization of this demo.
* *
@ -39,13 +39,13 @@
* </tr> * </tr>
* </table> * </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 * 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 * 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. * 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. * 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
Unescape View File

@ -6,13 +6,13 @@
/** \mainpage Mass Storage Host Demo /** \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. * The following list indicates what microcontrollers are compatible with this demo.
* *
* - Series 7 USB AVRs (AT90USBxxx7) * - 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. * The following table gives a rundown of the USB utilization of this demo.
* *
@ -42,7 +42,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* Mass Storage host demonstration application. This gives a simple reference * Mass Storage host demonstration application. This gives a simple reference
* application for implementing a USB Mass Storage host, for USB storage devices * 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 * 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. * 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. * 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
Unescape View File

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

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

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

@ -6,13 +6,13 @@
/** \mainpage RNDIS Host Demo /** \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. * The following list indicates what microcontrollers are compatible with this demo.
* *
* - Series 7 USB AVRs (AT90USBxxx7) * - 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. * The following table gives a rundown of the USB utilization of this demo.
* *
@ -39,7 +39,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* RNDIS host demonstration application. This gives a simple reference * RNDIS host demonstration application. This gives a simple reference
* application for implementing a RNDIS Ethernet host, for USB devices such as * 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 * 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. * 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. * 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
Unescape View File

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

@ -6,13 +6,13 @@
/** \mainpage CDC Host Demo /** \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. * The following list indicates what microcontrollers are compatible with this demo.
* *
* - Series 7 USB AVRs (AT90USBxxx7) * - 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. * The following table gives a rundown of the USB utilization of this demo.
* *
@ -39,7 +39,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* CDC host demonstration application. This gives a simple reference application * CDC host demonstration application. This gives a simple reference application
* for implementing a USB CDC host, for CDC devices using the standard ACM profile. * 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 * 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. * 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. * 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
Unescape View File

@ -6,13 +6,13 @@
/** \mainpage Generic HID Host Demo /** \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. * The following list indicates what microcontrollers are compatible with this demo.
* *
* - Series 7 USB AVRs (AT90USBxxx7) * - 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. * The following table gives a rundown of the USB utilization of this demo.
* *
@ -41,7 +41,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* Generic HID host demonstration application. This gives a simple reference * Generic HID host demonstration application. This gives a simple reference
* application for implementing a Generic HID USB host, for any device implementing * 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. * 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. * 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
Unescape View File

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

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

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

@ -6,13 +6,13 @@
/** \mainpage MIDI Host Demo /** \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. * The following list indicates what microcontrollers are compatible with this demo.
* *
* - Series 7 USB AVRs (AT90USBxxx7) * - 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. * The following table gives a rundown of the USB utilization of this demo.
* *
@ -39,13 +39,13 @@
* </tr> * </tr>
* </table> * </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 * 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 * 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. * 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. * 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
Unescape View File

@ -6,13 +6,13 @@
/** \mainpage Mass Storage Host Demo /** \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. * The following list indicates what microcontrollers are compatible with this demo.
* *
* - Series 7 USB AVRs (AT90USBxxx7) * - 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. * The following table gives a rundown of the USB utilization of this demo.
* *
@ -42,7 +42,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* Mass Storage host demonstration application. This gives a simple reference * Mass Storage host demonstration application. This gives a simple reference
* application for implementing a USB Mass Storage host, for USB storage devices * 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 * 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. * 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. * 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
Unescape View File

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

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

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

@ -6,13 +6,13 @@
/** \mainpage RNDIS Host Demo /** \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. * The following list indicates what microcontrollers are compatible with this demo.
* *
* - Series 7 USB AVRs (AT90USBxxx7) * - 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. * The following table gives a rundown of the USB utilization of this demo.
* *
@ -39,7 +39,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* RNDIS host demonstration application. This gives a simple reference * RNDIS host demonstration application. This gives a simple reference
* application for implementing a RNDIS Ethernet host, for USB devices such as * 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 * 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. * 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. * 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
Unescape View File

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

@ -6,13 +6,13 @@
/** \mainpage CDC Host Demo /** \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. * The following list indicates what microcontrollers are compatible with this demo.
* *
* - Series 7 USB AVRs (AT90USBxxx7) * - 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. * The following table gives a rundown of the USB utilization of this demo.
* *
@ -39,7 +39,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* CDC host demonstration application. This gives a simple reference application * CDC host demonstration application. This gives a simple reference application
* for implementing a USB CDC host, for CDC devices using the standard ACM profile. * 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 * 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. * 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. * 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
Unescape View File

@ -50,7 +50,7 @@
* The following files must be built with any user project that uses this module: * The following files must be built with any user project that uses this module:
* - None * - 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. * 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 * 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. * actions can be taken.
@ -60,7 +60,10 @@
* *
* For possible BOARD makefile values, see \ref Group_BoardTypes. * 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 * \code
* // Initialise the button driver before first use * // Initialise the button driver before first use
* Buttons_Init(); * Buttons_Init();

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

@ -50,7 +50,7 @@
* The following files must be built with any user project that uses this module: * The following files must be built with any user project that uses this module:
* - None * - 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, * 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. * 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. * 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 * \code
* // Initialise the SPI and board Dataflash drivers before first use * // 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 | * SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING |

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

@ -50,7 +50,7 @@
* The following files must be built with any user project that uses this module: * The following files must be built with any user project that uses this module:
* - None * - 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 * Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick
* located on many boards. * located on many boards.
* *
@ -59,7 +59,10 @@
* *
* For possible BOARD makefile values, see \ref Group_BoardTypes. * 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 * \code
* // Initialise the board Joystick driver before first use * // Initialise the board Joystick driver before first use
* Joystick_Init(); * Joystick_Init();

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

@ -50,7 +50,7 @@
* The following files must be built with any user project that uses this module: * The following files must be built with any user project that uses this module:
* - None * - 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 * 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. * 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) * 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. * 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 * \code
* // Initialise the board LED driver before first use * // Initialise the board LED driver before first use
* LEDs_Init(); * LEDs_Init();

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

@ -41,13 +41,16 @@
* The following files must be built with any user project that uses this module: * 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> * - 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 * 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 * 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 * 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. * 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 * \code
* // Initialise the ADC and board temperature sensor drivers before first use * // Initialise the ADC and board temperature sensor drivers before first use
* ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_128); * ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_128);

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

@ -47,7 +47,7 @@
* The following files must be built with any user project that uses this module: * The following files must be built with any user project that uses this module:
* - None * - None
* *
* \section Module Description * \section Sec_ModDescription Module Description
* Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of * Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of
* different sizes to suit different needs. * 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 * 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. * 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 * \code
* // Create the buffer structure and its underlying storage array * // Create the buffer structure and its underlying storage array
* RingBuff_t Buffer; * RingBuff_t Buffer;

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

@ -42,16 +42,22 @@
* The following files must be built with any user project that uses this module: * The following files must be built with any user project that uses this module:
* - None * - None
* *
* \section Module Description * \section Sec_ModDescription Module Description
* Escape code macros for ANSI compliant text terminals. * 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 * \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 * 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). * 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 * \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 * \endcode
* *
* @{ * @{

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

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

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

@ -47,7 +47,10 @@
* \note This file should not be included directly. It is automatically included as needed by the ADC driver * \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. * 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 * \code
* // Initialise the ADC driver before first use * // Initialise the ADC driver before first use
* ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_32); * ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_32);

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

@ -45,7 +45,10 @@
* \note This file should not be included directly. It is automatically included as needed by the TWI driver * \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. * 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 * \code
* // Initialise the TWI driver before first use * // Initialise the TWI driver before first use
* TWI_Init(); * TWI_Init();

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

@ -41,11 +41,14 @@
* The following files must be built with any user project that uses this module: * The following files must be built with any user project that uses this module:
* - None * - None
* *
* \section Module Description * \section Sec_ModDescription Module Description
* Driver for the hardware SPI port available on most AVR models. This module provides * 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. * 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 * \code
* // Initialise the SPI driver before first use * // Initialise the SPI driver before first use
* SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING | * SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING |

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

@ -41,11 +41,14 @@
* The following files must be built with any user project that uses this module: * 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> * - 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 * 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. * 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 * \code
* // Initialise the serial USART driver before first use, with 9600 baud (and no double-speed mode) * // Initialise the serial USART driver before first use, with 9600 baud (and no double-speed mode)
* Serial_Init(9600, false); * Serial_Init(9600, false);

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

@ -44,13 +44,16 @@
* The following files must be built with any user project that uses this module: * 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> * - 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 * 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, * 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 * puts, etc.) to work with the USART. Upon configuration, this will redirect the standard input and output
* streams to the USART. * 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 * \code
* // Initialise the Serial Stream driver before first use, with 9600 baud (and no double-speed mode) * // Initialise the Serial Stream driver before first use, with 9600 baud (and no double-speed mode)
* SerialStream_Init(9600, false); * SerialStream_Init(9600, false);

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

@ -45,7 +45,7 @@
* - LUFA/Drivers/Peripheral/TWI.c <i>(Makefile source module name: LUFA_SRC_TWI)</i> * - 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 * 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. * TWI present on many AVR models, for the transmission and reception of data on a TWI bus.
* *

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

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module: * 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> * - 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 * 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 * USB mode only. User applications can use this class driver instead of implementing the Audio class manually via
* the low-level LUFA APIs. * the low-level LUFA APIs.

2
LUFA/Drivers/USB/Class/CDC.h
Unescape 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/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> * - 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 * 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 * 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. * CDC class manually via the low-level LUFA APIs.

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

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassAudio /** \ingroup Group_USBClassAudio
* @defgroup Group_USBClassAudioCommon Common Class Definitions * @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 * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* Audio 1.0 Class. * Audio 1.0 Class.
* *

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

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassCDC /** \ingroup Group_USBClassCDC
* @defgroup Group_USBClassCDCCommon Common Class Definitions * @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 * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* CDC Class. * CDC Class.
* *

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

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassHID /** \ingroup Group_USBClassHID
* @defgroup Group_USBClassHIDCommon Common Class Definitions * @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 * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* HID Class. * HID Class.
* *

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

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassMIDI /** \ingroup Group_USBClassMIDI
* @defgroup Group_USBClassMIDICommon Common Class Definitions * @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 * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* MIDI Class. * MIDI Class.
* *

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

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassMS /** \ingroup Group_USBClassMS
* @defgroup Group_USBClassMSCommon Common Class Definitions * @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 * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* Mass Storage Class. * Mass Storage Class.
* *

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

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassPrinter /** \ingroup Group_USBClassPrinter
* @defgroup Group_USBClassPrinterCommon Common Class Definitions * @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 * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* Printer Class. * Printer Class.
* *

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

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassRNDIS /** \ingroup Group_USBClassRNDIS
* @defgroup Group_USBClassRNDISCommon Common Class Definitions * @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 * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* RNDIS Class. * RNDIS Class.
* *

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

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassSI /** \ingroup Group_USBClassSI
* @defgroup Group_USBClassSICommon Common Class Definitions * @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 * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* Still Image Class. * Still Image Class.
* *

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

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module: * 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> * - 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. * Device Mode USB Class driver framework interface, for the Audio 1.0 USB Class driver.
* *
* @{ * @{

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

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module: * 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> * - 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. * 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 * \note There are several major drawbacks to the CDC-ACM standard USB class, however

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

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module: * 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> * - 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. * Device Mode USB Class driver framework interface, for the HID USB Class driver.
* *
* @{ * @{

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

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module: * 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> * - 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. * Device Mode USB Class driver framework interface, for the MIDI USB Class driver.
* *
* @{ * @{

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

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module: * 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> * - 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. * Device Mode USB Class driver framework interface, for the Mass Storage USB Class driver.
* *
* @{ * @{

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

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module: * 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> * - 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. * Device Mode USB Class driver framework interface, for the RNDIS USB Class driver.
* *
* @{ * @{

2
LUFA/Drivers/USB/Class/HID.h
Unescape 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/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> * - 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 * 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 * and Host USB modes. User applications can use this class driver instead of implementing the HID class manually
* via the low-level LUFA APIs. * via the low-level LUFA APIs.

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

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module: * 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> * - 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. * Host Mode USB Class driver framework interface, for the CDC USB Class driver.
* *
* @{ * @{

2
LUFA/Drivers/USB/Class/Host/HID.h
Unescape 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/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> * - 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. * Host Mode USB Class driver framework interface, for the HID USB Class driver.
* *
* @{ * @{

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

@ -43,7 +43,7 @@
* The following files must be built with any user project that uses this module: * 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> * - 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. * 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 * 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
Unescape View File

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module: * 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> * - 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. * Host Mode USB Class driver framework interface, for the MIDI USB Class driver.
* *
* @{ * @{

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

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module: * 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> * - 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. * Host Mode USB Class driver framework interface, for the Mass Storage USB Class driver.
* *
* @{ * @{

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

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module: * 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> * - 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. * Host Mode USB Class driver framework interface, for the Printer USB Class driver.
* *
* @{ * @{

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

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module: * 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> * - 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 * Host Mode USB Class driver framework interface, for the Microsoft RNDIS Ethernet
* USB Class driver. * USB Class driver.
* *

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

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module: * 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> * - 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. * Host Mode USB Class driver framework interface, for the Still Image USB Class driver.
* *
* @{ * @{

2
LUFA/Drivers/USB/Class/MIDI.h
Unescape 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/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> * - 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 * 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 * and Host USB modes. User applications can use this class driver instead of implementing the MIDI class manually
* via the low-level LUFA APIs. * via the low-level LUFA APIs.

2
LUFA/Drivers/USB/Class/MassStorage.h
Unescape 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/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> * - 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 * 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 * 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. * manually via the low-level LUFA APIs.

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

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module: * 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> * - 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 * 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 * 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 * 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
Unescape 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/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> * - 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 * 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 * 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. * RNDIS class manually via the low-level LUFA APIs.

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

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module: * 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> * - 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, * 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 * 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. * manually via the low-level LUFA APIs.

6
LUFA/Drivers/USB/USB.h
Unescape 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/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> * - 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 * 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 * consists of many submodules, and is designed to provide an easy way to configure and control USB host, device
* or OTG mode USB applications. * 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 * slightly differently, and thus will be explained separately. For information on a specific class driver, read
* the class driver's module documentation. * 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, * 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 * 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 * 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 * read and write routines. See each driver's individual documentation for more information on the
* class-specific functions. * 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, * 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 * 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 * 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
Unescape View File

@ -45,7 +45,7 @@
* The following files must be built with any user project that uses this module: * 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> * - 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 * 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. * 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
Unescape View File

@ -6,7 +6,7 @@
/** \mainpage AVRISP MKII Programmer Project /** \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. * The following list indicates what microcontrollers are compatible with this project.
* *
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4) * - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) - <i>8KB versions with reduced features only</i> * - 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. * The following table gives a rundown of the USB utilization of this project.
* *
@ -42,7 +42,7 @@
* </tr> * </tr>
* </table> * </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 * 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 * 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 * 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). * 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>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 SSec_Options section</i> * <b><sup>2</sup></b> <i>See AUX line related tokens in the \ref Sec_Options section</i>
* *
* \section Sec_PDI PDI Connections * \section Sec_PDI PDI Connections
* Connections to the device for PDI programming (when enabled): * Connections to the device for PDI programming (when enabled):
@ -153,7 +153,7 @@
* </tr> * </tr>
* </table> * </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>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 * \section Sec_TPI TPI Connections
@ -197,11 +197,11 @@
* </tr> * </tr>
* </table> * </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>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. * 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
Unescape View File

@ -6,7 +6,7 @@
/** \mainpage Benito Arduino Programmer Project /** \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. * The following list indicates what microcontrollers are compatible with this project.
* *
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4) * - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) * - 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. * The following table gives a rundown of the USB utilization of this project.
* *
@ -43,7 +43,7 @@
* </tr> * </tr>
* </table> * </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 * 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 * 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 * 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. * 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. * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
* *

8
Projects/LEDNotifier/LEDNotifier.txt
Unescape View File

@ -6,13 +6,13 @@
/** \mainpage USB LED Notifier Project /** \mainpage USB LED Notifier Project
* *
* \section SSec_Compat Demo Compatibility: * \section Sec_Compat Demo Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this demo. * The following list indicates what microcontrollers are compatible with this demo.
* *
* - AT90USB646 * - AT90USB646
* *
* \section SSec_Info USB Information: * \section Sec_Info USB Information:
* *
* The following table gives a rundown of the USB utilization of this demo. * The following table gives a rundown of the USB utilization of this demo.
* *
@ -39,7 +39,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* USB LED Notifier Project. This project is designed for the Busware BUI board, however it can run easily on any * USB LED Notifier Project. This project is designed for the Busware BUI board, however it can run easily on any
* USB AVR. It is a generic RGB LED controller (via a three channel software PWM) which listens for commands from the * USB AVR. It is a generic RGB LED controller (via a three channel software PWM) which listens for commands from the
@ -48,7 +48,7 @@
* This can be controlled with any host application that can write to the virtual serial port, allowing it to become * This can be controlled with any host application that can write to the virtual serial port, allowing it to become
* a visual notification system for any number of custom host applications, such as a new unread email notifier. * a visual notification system for any number of custom host applications, such as a new unread email notifier.
* *
* \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. * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
* *

8
Projects/MIDIToneGenerator/MIDIToneGenerator.txt
Unescape View File

@ -6,7 +6,7 @@
/** \mainpage MIDI Tone Generator Project /** \mainpage MIDI Tone Generator Project
* *
* \section SSec_Compat Project Compatibility: * \section Sec_Compat Project Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this project. * The following list indicates what microcontrollers are compatible with this project.
* *
@ -14,7 +14,7 @@
* - Series 6 USB AVRs (AT90USBxxx6) * - Series 6 USB AVRs (AT90USBxxx6)
* - Series 4 USB AVRs (ATMEGAxxU4) * - 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 project. * The following table gives a rundown of the USB utilization of this project.
* *
@ -43,7 +43,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* MIDI note synthesiser project. This project implements a basic DDS frequency synthesiser, capable of producing 8-bit PWM sine * MIDI note synthesiser project. This project implements a basic DDS frequency synthesiser, capable of producing 8-bit PWM sine
* waves of variable frequency. When attached to a USB host, this project will allow for multiple MIDI notes to be synthesised into * waves of variable frequency. When attached to a USB host, this project will allow for multiple MIDI notes to be synthesised into
@ -52,7 +52,7 @@
* Outgoing audio will output in 8-bit PWM onto the timer 3 output compare channel A. Decouple the audio output with a capacitor * Outgoing audio will output in 8-bit PWM onto the timer 3 output compare channel A. Decouple the audio output with a capacitor
* and attach to a speaker to hear the audio. * and attach to a speaker to hear the audio.
* *
* \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. * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
* *

8
Projects/Magstripe/Magstripe.txt
Unescape View File

@ -6,14 +6,14 @@
/** \mainpage Denver Gingerich's USBSnoop Magnetic Card Reader Project /** \mainpage Denver Gingerich's USBSnoop Magnetic Card Reader Project
* *
* \section SSec_Compat Project Compatibility: * \section Sec_Compat Project Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this project. * The following list indicates what microcontrollers are compatible with this project.
* *
* - AT90USB1287 * - AT90USB1287
* - AT90USB1286 * - AT90USB1286
* *
* \section SSec_Info USB Information: * \section Sec_Info USB Information:
* *
* The following table gives a rundown of the USB utilization of this project. * The following table gives a rundown of the USB utilization of this project.
* *
@ -40,7 +40,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* Firmware for a USB AVR powered USB TTL magnetic stripe reader (using a card * Firmware for a USB AVR powered USB TTL magnetic stripe reader (using a card
* reader such as the Omron V3B-4K) by Denver Gingerich. This project is designed * reader such as the Omron V3B-4K) by Denver Gingerich. This project is designed
@ -95,7 +95,7 @@
* obtained from the magnetic stripe reader is "typed" through the keyboard * obtained from the magnetic stripe reader is "typed" through the keyboard
* driver as 0's and 1's. After every card swipe, the project will send a return key. * driver as 0's and 1's. After every card swipe, the project will send a return key.
* *
* \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. * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
* *

8
Projects/MissileLauncher/MissileLauncher.txt
Unescape View File

@ -6,13 +6,13 @@
/** \mainpage David Fletcher's Missile Launcher /** \mainpage David Fletcher's Missile Launcher
* *
* \section SSec_Compat Project Compatibility: * \section Sec_Compat Project Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this project. * The following list indicates what microcontrollers are compatible with this project.
* *
* - Series 7 USB AVRs (AT90USBxxx7) * - 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 project. * The following table gives a rundown of the USB utilization of this project.
* *
@ -39,13 +39,13 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* Missile Launcher host. This is a host driver for the popular USB-controller table top toy missile launchers, * Missile Launcher host. This is a host driver for the popular USB-controller table top toy missile launchers,
* which can typically aim and fire small foam "missiles" from a spring-loaded turret. This project controls the * which can typically aim and fire small foam "missiles" from a spring-loaded turret. This project controls the
* launcher via a joystick and button to aim and fire missiles at targets without a PC. * launcher via a joystick and button to aim and fire missiles at targets without a PC.
* *
* \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. * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
* *

6
Projects/RelayBoard/RelayBoard.txt
Unescape View File

@ -6,13 +6,13 @@
/** \mainpage OB's Quad-Relay outlet control using a Teensy2++ /** \mainpage OB's Quad-Relay outlet control using a Teensy2++
* *
* \section SSec_Compat Project Compatibility: * \section Sec_Compat Project Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this project. * The following list indicates what microcontrollers are compatible with this project.
* *
* - AT90USB1286 * - AT90USB1286
* *
* \section SSec_Info USB Information: * \section Sec_Info USB Information:
* *
* The following table gives a rundown of the USB utilization of this project. * The following table gives a rundown of the USB utilization of this project.
* *
@ -39,7 +39,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* Firmware for a Teensy2++ AVR-based miniboard to control four relays, using the * Firmware for a Teensy2++ AVR-based miniboard to control four relays, using the
* same protocol used by the commercially available Silver Shield PM power outlets * same protocol used by the commercially available Silver Shield PM power outlets

10
Projects/TempDataLogger/TemperatureDataLogger.txt
Unescape View File

@ -6,7 +6,7 @@
/** \mainpage Temperature Datalogger Project /** \mainpage Temperature Datalogger Project
* *
* \section SSec_Compat Demo Compatibility: * \section Sec_Compat Demo Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this demo. * The following list indicates what microcontrollers are compatible with this demo.
* *
@ -14,7 +14,7 @@
* - Series 6 USB AVRs (AT90USBxxx6) * - Series 6 USB AVRs (AT90USBxxx6)
* - Series 4 USB AVRs (ATMEGAxxU4) - <i>those with >16KB of FLASH memory only</i> * - Series 4 USB AVRs (ATMEGAxxU4) - <i>those with >16KB of FLASH memory only</i>
* *
* \section SSec_Info USB Information: * \section Sec_Info USB Information:
* *
* The following table gives a rundown of the USB utilization of this demo. * The following table gives a rundown of the USB utilization of this demo.
* *
@ -47,7 +47,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* Temperature Data Logger project. This project is a very basic USB data logger for the current temperature as reported by * Temperature Data Logger project. This project is a very basic USB data logger for the current temperature as reported by
* the board's temperature sensor, writing the temperature to a file stored on the board's Dataflash in a FAT filesystem * the board's temperature sensor, writing the temperature to a file stored on the board's Dataflash in a FAT filesystem
@ -57,7 +57,7 @@
* *
* A DS1307 or compatible RTC IC is designed to be attached to the AVR's TWI bus, for the management of timestamps on the * A DS1307 or compatible RTC IC is designed to be attached to the AVR's TWI bus, for the management of timestamps on the
* sampled data. This project will not function correctly if the RTC chip is omitted unless the DUMMY_RTC compile time token * sampled data. This project will not function correctly if the RTC chip is omitted unless the DUMMY_RTC compile time token
* is specified - see \ref SSec_Options. * is specified - see \ref Sec_Options.
* *
* Due to the host's need for exclusive access to the file system, the device will not log samples while connected to a host. * Due to the host's need for exclusive access to the file system, the device will not log samples while connected to a host.
* For the logger to store data, the Dataflash must first be formatted by the host so that it contains a valid FAT file system. * For the logger to store data, the Dataflash must first be formatted by the host so that it contains a valid FAT file system.
@ -65,7 +65,7 @@
* This project uses the FatFS library from ELM Chan (http://elm-chan.org/fsw/ff/00index_e.html) and the .NET HID device library * This project uses the FatFS library from ELM Chan (http://elm-chan.org/fsw/ff/00index_e.html) and the .NET HID device library
* LibHIDNet (http://sourceforge.net/projects/libhidnet/). * LibHIDNet (http://sourceforge.net/projects/libhidnet/).
* *
* \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. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
* *

8
Projects/USBtoSerial/USBtoSerial.txt
Unescape View File

@ -6,7 +6,7 @@
/** \mainpage USB to Serial Converter Project /** \mainpage USB to Serial Converter Project
* *
* \section SSec_Compat Project Compatibility: * \section Sec_Compat Project Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this project. * The following list indicates what microcontrollers are compatible with this project.
* *
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4) * - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) * - 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. * The following table gives a rundown of the USB utilization of this project.
* *
@ -42,7 +42,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* USB to Serial bridge project. This project allows a USB AVR to serve * USB to Serial bridge project. This project allows a USB AVR to serve
* as a USB to USART bridge between a USB host and a device lacking a * as a USB to USART bridge between a USB host and a device lacking a
@ -63,7 +63,7 @@
* Operating Systems should automatically use their own inbuilt * Operating Systems should automatically use their own inbuilt
* CDC-ACM drivers. * 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. * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
* *

12
Projects/Webserver/Webserver.txt
Unescape View File

@ -6,13 +6,13 @@
/** \mainpage uIP Powered Webserver Project /** \mainpage uIP Powered Webserver Project
* *
* \section SSec_Compat Project Compatibility: * \section Sec_Compat Project Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this project. * The following list indicates what microcontrollers are compatible with this project.
* *
* - Series 7 USB AVRs (AT90USBxxx7) * - 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 project. * The following table gives a rundown of the USB utilization of this project.
* *
@ -45,7 +45,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* Simple HTTP webserver project. This project combines the LUFA library with the uIP TCP/IP full network stack and FatFS * Simple HTTP webserver project. This project combines the LUFA library with the uIP TCP/IP full network stack and FatFS
* library to create a RNDIS host capable of serving out HTTP web pages to multiple hosts simultaneously. This project * library to create a RNDIS host capable of serving out HTTP web pages to multiple hosts simultaneously. This project
@ -55,19 +55,19 @@
* To use this project, plug the USB AVR into a computer, so that it enumerates as a standard Mass Storage device. Load * To use this project, plug the USB AVR into a computer, so that it enumerates as a standard Mass Storage device. Load
* HTML files onto the disk, so that they can be served out to clients -- the default file to serve should be called * HTML files onto the disk, so that they can be served out to clients -- the default file to serve should be called
* <i>index.htm</i>. Filenames must be in 8.3 format for them to be retrieved correctly by the webserver, and the total * <i>index.htm</i>. Filenames must be in 8.3 format for them to be retrieved correctly by the webserver, and the total
* requested file path must be equal to or less than the maximum URI length (\see \ref SSec_Options). * requested file path must be equal to or less than the maximum URI length (\see \ref Sec_Options).
* *
* When attached to a RNDIS class device, such as a USB (desktop) modem, the system will enumerate the device, set the * When attached to a RNDIS class device, such as a USB (desktop) modem, the system will enumerate the device, set the
* appropriate parameters needed for connectivity and begin listening for new HTTP connections on port 80 and TELNET * appropriate parameters needed for connectivity and begin listening for new HTTP connections on port 80 and TELNET
* connections on port 23. The device IP, netmask and default gateway IP must be set to values appropriate for the RNDIS * connections on port 23. The device IP, netmask and default gateway IP must be set to values appropriate for the RNDIS
* device being used for this project to work if the DHCP client is disabled (see \ref SSec_Options) - otherwise, the device * device being used for this project to work if the DHCP client is disabled (see \ref Sec_Options) - otherwise, the device
* will query the network's DHCP server for these parameters automatically. * will query the network's DHCP server for these parameters automatically.
* *
* When properly configured, the webserver can be accessed from any HTTP web browser by typing in the device's statically or * When properly configured, the webserver can be accessed from any HTTP web browser by typing in the device's statically or
* dynamically allocated IP address. The TELNET client can be accessed via any network socket app by connecting to the device * dynamically allocated IP address. The TELNET client can be accessed via any network socket app by connecting to the device
* on port 23 on the device's statically or dynamically allocated IP address. * on port 23 on the device's statically or dynamically allocated IP address.
* *
* \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. * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
* *

8
Projects/XPLAINBridge/XPLAINBridge.txt
Unescape View File

@ -6,13 +6,13 @@
/** \mainpage XPLAIN UART Bridge/PDI Programmer Project /** \mainpage XPLAIN UART Bridge/PDI Programmer Project
* *
* \section SSec_Compat Project Compatibility: * \section Sec_Compat Project Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this project. * The following list indicates what microcontrollers are compatible with this project.
* *
* - AT90USB1287 * - AT90USB1287
* *
* \section SSec_Info USB Information: * \section Sec_Info USB Information:
* *
* The following table gives a rundown of the USB utilization of this project. * The following table gives a rundown of the USB utilization of this project.
* *
@ -44,7 +44,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* This project serves a dual purpose. When loaded into the USB AVR on the XPLAIN board, it will act as either a USB to Serial * This project serves a dual purpose. When loaded into the USB AVR on the XPLAIN board, it will act as either a USB to Serial
* converter for the XPLAIN's hardware USART (at a speed of 9600 baud), or an AVRStudio compatible PDI programmer for the XMEGA. * converter for the XPLAIN's hardware USART (at a speed of 9600 baud), or an AVRStudio compatible PDI programmer for the XMEGA.
@ -68,7 +68,7 @@
* *
* This project relies on files from the LUFA AVRISP-MKII project for compilation. * This project relies on files from the LUFA AVRISP-MKII project for compilation.
* *
* \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. * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
* *

Write Preview
Loading…
Cancel
Save