* as a USB microphone. Incoming audio from the ADC channel 1 will\r
* be sampled and sent to the host computer.\r
* \r
- * To use, connect a microphone to the ADC channel 2.\r
+ * To use, connect a microphone to the ADC channel 1.\r
* \r
* Under Windows, if a driver request dialogue pops up, select the option\r
* to automatically install the appropriate drivers.\r
# the time of a run. So in most cases it will be better to enable call graphs \r
# for selected functions only using the \callgraph command.\r
\r
-CALL_GRAPH = YES\r
+CALL_GRAPH = NO\r
\r
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then \r
# doxygen will generate a caller dependency graph for every global function \r
* - None\r
*\r
* \section Module Description\r
- * Functions, macros, variables, enums and types related to the control of physical board GPIO buttons.\r
+ * Hardware buttons driver. This provides an easy to use driver for the hardware buttons present on many boards.\r
+ * It provides a way to easily configure and check the status of all the buttons on the board so that appropriate\r
+ * actions can be taken.\r
*\r
* If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project\r
* directory. Otherwise, it will include the appropriate built in board driver header file.\r
* - None\r
*\r
* \section Module Description\r
- * Functions, macros, variables, enums and types related to the control of board Dataflash ICs.\r
+ * Dataflash driver. This module provides an easy to use interface for the Dataflash ICs located on many boards,\r
+ * for the storage of large amounts of data into the Dataflash's non-volatile memory.\r
*\r
* If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project\r
* directory. Otherwise, it will include the appropriate built in board driver header file.\r
* - None\r
*\r
* \section Module Description\r
- * Functions, macros, variables, enums and types related to the control of board joystick.\r
+ * Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick\r
+ * located on many boards.\r
*\r
* If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project\r
* directory. Otherwise, it will include the appropriate built in board driver header file.\r
* - None\r
*\r
* \section Module Description\r
- * Functions, macros, variables, enums and types related to the control of board LEDs.\r
+ * Hardware LEDs driver. This provides an easy to use driver for the hardware LEDs present on many boards. It\r
+ * provides an interface to configure, test and change the status of all the board LEDs.\r
*\r
* If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project\r
* directory. Otherwise, it will include the appropriate built in board driver header file.\r
* - LUFA/Drivers/Board/Temperature.c\r
*\r
* \section Module Description\r
- * Functions, macros, variables, enums and types related to the control of board temperature sensors.\r
+ * Temperature sensor driver. This provides an easy to use interface for the hardware temperature sensor located\r
+ * on many boards. It provides an interface to configure the sensor and appropriate ADC channel, plus read out the\r
+ * current temperature in degrees C. It is designed for and will only work with the temperature sensor located on the\r
+ * official Atmel USB AVR boards, as each sensor has different characteristics.\r
*\r
* @{\r
*/\r
* - None\r
*\r
* \section Module Description\r
- * Functions, macros, variables, enums and types related to the setup of a the ADC subsystem.\r
+ * Hardware ADC driver. This module provides an easy to use driver for the hardware\r
+ * ADC present on many AVR models, for the conversion of analogue signals into the\r
+ * digital domain.\r
*/\r
\r
#ifndef __ADC_H__\r
* - None\r
*\r
* \section Module Description\r
- * Functions, macros, variables, enums and types related to the setup of a the SPI port.\r
+ * Driver for the hardware SPI port avaliable on most AVR models. This module provides\r
+ * an easy to use driver for the setup of and transfer of data over the AVR's SPI port.\r
*\r
* @{\r
*/\r
* - LUFA/Drivers/Peripheral/Serial.c\r
*\r
* \section Module Description\r
- * Functions, macros, variables, enums and types related to the setup of the USART for serial communications.\r
+ * Hardware serial USART driver. This module provides an easy to use driver for\r
+ * the setup of and transfer of data over the AVR's USART port.\r
*\r
* @{\r
*/\r
* - LUFA/Drivers/USB/HighLevel/ConfigDescriptor.c\r
*\r
* \section Module Description\r
- * Functions, macros, variables, enums and types related to the management of USB communications.\r
+ * Driver and framework for the USB controller hardware on the USB series of AVR microcontrollers. This module\r
+ * consists of many submodules, and is designed to provide an easy way to configure and control USB host, device\r
+ * or OTG mode USB applications.\r
*/\r
\r
/** \ingroup Group_USB\r
* -# Re-enable Host mode Class driver builds after completion\r
* -# Update Host mode Class Driver demo .txt files\r
* - Add standardized descriptor names to device and host class driver structures\r
- * - Add in INTERRUPT_CONTROL_PIPE to use HSOFI to trigger calls to the host state machine\r
- * - Debug mode for pipe/endpoint calls\r
*\r
* <b>Targeted for Future Releases:</b>\r
* - Remake AVRStudio project files\r
* - Add detailed overviews of how each demo works\r
* - Master LUFA include file rather than per-module includes\r
* - Stream reads - return number of bytes not read?\r
- * - Convert CDC demos to use stdio streams?\r
* - Add multiple-report HID demo to the library\r
* - Add dual role Mouse Host/Keyboard Device demo to the library\r
* - Add hub support to match Atmel's stack\r
* - CAMTRIG, a remote Camera Trigger device: http://code.astraw.com/projects/motmot/camtrig\r
* - Opendous-JTAG, an open source JTAG device: http://code.google.com/p/opendous-jtag/\r
* - Openkubus, an open source hardware-based authentication dongle: http://code.google.com/p/openkubus/\r
+ * - Orbee, a USB connected RGB Orb for notifications: http://www.franksworkshop.com.au/Electronics/Orbee/Orbee.htm\r
* - Reprap with LUFA, a LUFA powered 3D printer: http://code.google.com/p/at90usb1287-code-for-arduino-and-eclipse/\r
* - SEGA Megadrive/Genesis Development Cartridge: http://www.spritesmind.net/_GenDev/forum/viewtopic.php?t=464\r
* - Stripe Snoop, a Magnetic Card reader: http://www.ossguy.com/ss_usb/\r
\r
/** \page Page_LibraryApps Included Library Applications\r
*\r
- * The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory.\r
- * If this directory is missing, please re-download the project from the project homepage. Within this directory the demos\r
- * are seperated by USB mode (Device, Host, OTG) and further seperated by the use or non-use of the library USB Class drivers.\r
+ * The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory. Within this\r
+ * directory the demos are seperated by USB mode (Device, Host, OTG) and further seperated by the use or non-use of the\r
+ * library USB Class drivers (which abstract out the actual implementation of the USB classes to simplify development even\r
+ * further at the expense of a loss of flexibility).\r
+ *\r
* With one or two exceptions (e.g. proprietary classes such as RNDIS) all the included demos will work across all OSes without\r
* the need for special drivers. One Windows, some demos require the supplied .INF file to be used as the device driver, which\r
* directs the OS to use its inbuilt class drivers for the device.\r
* For author and donation information, see \ref Page_Donating.\r
*\r
* LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license. It supports\r
- * a large number of USB AVR models and boards (see \ref Page_DeviceSupport).\r
+ * a large number of USB AVR models and boards (see \ref Page_DeviceSupport). It is designed to provide an easy to use, feature\r
+ * rich framework for the development of USB peripherals and hosts.\r
+ *\r
+ * LUFA focuses on the microcontroller side of USB development only; it includes no host USB driver development facilities. While\r
+ * custom USB devices can be made with LUFA, the included demos all use the inbuilt OS drivers for each USB class for simplicity.\r
*\r
* The library is currently in a stable release, suitable for download and incorporation into user projects for\r
* both host and device modes. For information about the project progression, check out my blog.\r
*\r
* Once you have built an application, you will need a way to program in the resulting ".HEX" file (and, if your\r
* application uses EEPROM variables with initial values, also a ".EEP" file) into your USB AVR. Normally, the\r
- * reprogramming an AVR device must be performed using a special piece of programming hardware, through one of the\r
+ * reprogramming of an AVR device must be performed using a special piece of programming hardware, through one of the\r
* supported AVR programming protocols - ISP, HVSP, HVPP, JTAG or dW. This can be done through a custom programmer,\r
* a third party programmer, or an official Atmel AVR tool - for more information, see the Atmel.com website.\r
*\r
projects / pub / USBasp.git / commitdiff