*/\r
\r
/** \file\r
- * \brief Supported architecture defines.\r
+ * \brief Supported library architecture defines.\r
*\r
* \copydetails Group_Architectures\r
*\r
\r
/** \ingroup Group_Common\r
* \defgroup Group_Architectures Hardware Architectures\r
- * \brief Supported architecture defines.\r
+ * \brief Supported library architecture defines.\r
*\r
- * Macros for indicating the chosen hardware architecture to the library. These macros should be used when\r
- * defining the ARCH token to the chosen hardware via the -D switch in the project makefile.\r
+ * Architecture macros for selecting the desired target microcontroller architecture. One of these values should be\r
+ * defined as the value of \c ARCH in the user project makefile via the \c -D compiler switch to GCC, to select the\r
+ * target architecture.\r
+ *\r
+ * The selected architecture should remain consistent with the makefile \c ARCH value, which is used to select the\r
+ * underlying driver source files for each architecture.\r
*\r
* @{\r
*/\r
* \defgroup Group_GCCAttributes Function/Variable Attributes
* \brief AVR-GCC special function/variable attribute macros.
*
- * This file contains macros for applying GCC specific attributes to functions and variables to control various
+ * This module contains macros for applying GCC specific attributes to functions and variables to control various
* optimiser and code generation features of the compiler. Attributes may be placed in the function prototype
* or variable declaration in any order, and multiple attributes can be specified for a single item via a space
* separated list.
*
* On incompatible versions of GCC or on other compilers, these macros evaluate to nothing unless they are
- * critical to the code's function and thus must throw a compiler error when used.
+ * critical to the code's function and thus must throw a compile error when used.
*
* @{
*/
*/
/** \file
- * \brief Supported board hardware defines.
+ * \brief Supported pre-made board hardware defines.
*
* \copydetails Group_BoardTypes
*
/** \ingroup Group_Common
* \defgroup Group_BoardTypes Board Types
- * \brief Supported board hardware defines.
+ * \brief Supported pre-made board hardware defines.
*
- * Macros for indicating the chosen physical board hardware to the library. These macros should be used when
- * defining the BOARD token to the chosen hardware via the -D switch in the project makefile.
+ * Board macros for indicating the chosen physical board hardware to the library. These macros should be used when
+ * defining the \c BOARD token to the chosen hardware via the \c -D switch in the project makefile. If a custom
+ * board is used, the \ref BOARD_NONE or \ref BOARD_USER values should be selected.
*
* @{
*/
*/
/** \file
- * \brief Common library convenience macros and functions.
+ * \brief Common library convenience headers, macros and functions.
*
* \copydetails Group_Common
*/
/** \defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h
- * \brief Common library convenience macros and functions.
+ * \brief Common library convenience headers, macros and functions.
*
* Common utility headers containing macros, functions, enums and types which are common to all
* aspects of the library.
*/
/** \defgroup Group_Debugging Debugging Macros
+ * \brief Convenience macros to aid in debugging applications.
*
- * Macros for debugging use.
+ * Macros to aid debugging of a user application.
*/
/** \defgroup Group_BitManip Endian and Bit Macros
+ * \brief Convenience macros to aid in bit manipulations and endianness transforms.
*
- * Functions for swapping endianness and reversing bit orders.
+ * Functions for swapping endianness and reversing bit orders of data.
*/
#ifndef __LUFA_COMMON_H__
*/
/** \file
- * \brief Master include file for the board digital button driver.
+ * \brief Digital button board hardware driver.
*
* This file is the master dispatch header file for the board-specific Buttons driver, for boards containing
- * physical pushbuttons connected to the AVR's GPIO pins.
+ * physical pushbuttons connected to the microcontroller's GPIO pins.
*
* User code should include this file, which will in turn include the correct Button driver header file for the
* currently selected board.
/** \ingroup Group_BoardDrivers
* \defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h
+ * \brief Digital button board hardware driver.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:
/** \file
* \brief Master include file for the board dataflash IC driver.
+ * \brief Atmel Dataflash storage IC board hardware driver.
*
- * This file is the master dispatch header file for the board-specific dataflash driver, for boards containing
- * dataflash ICs for external non-volatile storage.
+ * This file is the master dispatch header file for the board-specific Atmel dataflash driver, for boards containing
+ * Atmel Dataflash ICs for external non-volatile storage.
*
* User code should include this file, which will in turn include the correct dataflash driver header file for
* the currently selected board.
/** \ingroup Group_BoardDrivers
* \defgroup Group_Dataflash Dataflash Driver - LUFA/Drivers/Board/Dataflash.h
+ * \brief Atmel Dataflash storage IC board hardware driver.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:
*/
/** \file
- * \brief Master include file for the board digital joystick driver.
+ * \brief Digital joystick board hardware driver.
*
* This file is the master dispatch header file for the board-specific Joystick driver, for boards containing a
- * 5-way joystick.
+ * digital joystick.
*
* User code should include this file, which will in turn include the correct joystick driver header file for the
* currently selected board.
/** \ingroup Group_BoardDrivers
* \defgroup Group_Joystick Joystick Driver - LUFA/Drivers/Board/Joystick.h
+ * \brief Digital joystick board hardware driver.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:
*/
/** \file
- * \brief Master include file for the board LEDs driver.
+ * \brief LED board hardware driver.
*
* This file is the master dispatch header file for the board-specific LED driver, for boards containing user
* controllable LEDs.
/** \ingroup Group_BoardDrivers
* \defgroup Group_LEDs LEDs Driver - LUFA/Drivers/Board/LEDs.h
+ * \brief LED board hardware driver.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:
*/
/** \file
- * \brief Master include file for the board temperature sensor driver.
+ * \brief NTC Temperature Sensor board hardware driver.
*
* Master include file for the board temperature sensor driver, for the USB boards which contain a temperature sensor.
*/
/** \ingroup Group_BoardDrivers
* \defgroup Group_Temperature Temperature Sensor Driver - LUFA/Drivers/Board/Temperature.h
+ * \brief NTC Temperature Sensor board hardware driver.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:
*/\r
\r
/** \file\r
- * \brief Lightweight ring buffer, for fast insertion/deletion.\r
+ * \brief Lightweight ring buffer, for fast insertion/deletion of bytes.\r
*\r
* Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of\r
* different sizes to suit different needs.\r
\r
/** \ingroup Group_MiscDrivers\r
* \defgroup Group_RingBuff Generic Byte Ring Buffer - LUFA/Drivers/Misc/RingBuffer.h\r
+ * \brief Lightweight ring buffer, for fast insertion/deletion of bytes.\r
*\r
* \section Sec_Dependencies Module Source Dependencies\r
* The following files must be built with any user project that uses this module:\r
/** \ingroup Group_MiscDrivers
* \defgroup Group_Terminal ANSI Terminal Escape Codes - LUFA/Drivers/Misc/TerminalCodes.h
+ * \brief ANSI terminal special escape code macros.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:
*/
/** \file
- * \brief Master include file for the ADC peripheral driver.
+ * \brief Hardware Analogue-to-Digital converter driver.
*
* This file is the master dispatch header file for the device-specific ADC driver, for microcontrollers
* containing an ADC.
/** \ingroup Group_PeripheralDrivers
* \defgroup Group_ADC ADC Driver - LUFA/Drivers/Peripheral/ADC.h
+ * \brief Hardware Analogue-to-Digital converter driver.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:
*/
/** \file
- * \brief Master include file for the SPI peripheral driver.
+ * \brief Hardware Serial Peripheral Interface driver.
*
* This file is the master dispatch header file for the device-specific SPI driver, for microcontrollers
* containing a hardware SPI.
/** \ingroup Group_PeripheralDrivers
* \defgroup Group_SPI SPI Driver - LUFA/Drivers/Peripheral/SPI.h
+ * \brief Hardware Serial Peripheral Interface driver.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:
*/
/** \file
- * \brief Master include file for the USART peripheral driver.
+ * \brief Hardware Serial USART driver.
*
* This file is the master dispatch header file for the device-specific USART driver, for microcontrollers
* containing a hardware USART.
/** \ingroup Group_PeripheralDrivers
* \defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h
+ * \brief Hardware Serial USART driver.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:
*/
/** \file
- * \brief Master include file for the TWI peripheral driver.
+ * \brief Hardware Two Wire Interface (I2C) driver.
*
* This file is the master dispatch header file for the device-specific SPI driver, for microcontrollers
* containing a hardware TWI.
/** \ingroup Group_PeripheralDrivers
* \defgroup Group_TWI TWI Driver - LUFA/Drivers/Peripheral/TWI.h
+ * \brief Hardware Two Wire Interface (I2C) driver.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:
/** \ingroup Group_USB
* \defgroup Group_HIDParser HID Report Parser
+ * \brief USB Human Interface Device (HID) Class report descriptor parser.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:
/** \ingroup Group_EndpointRW
* \defgroup Group_EndpointRW_AVR8 Endpoint Data Reading and Writing (AVR8)
- * \brief USB Endpoint definitions for the AVR8 microcontrollers.
+ * \brief Endpoint data read/write definitions for the Atmel AVR8 architecture.
*
* Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
*/
/** \ingroup Group_EndpointPrimitiveRW
* \defgroup Group_EndpointPrimitiveRW_AVR8 Read/Write of Primitive Data Types (AVR8)
+ * \brief Endpoint primative read/write definitions for the Atmel AVR8 architecture.
*
* Functions, macros, variables, enums and types related to data reading and writing of primitive data types
* from and to endpoints.
/** \ingroup Group_EndpointPacketManagement
* \defgroup Group_EndpointPacketManagement_AVR8 Endpoint Packet Management (AVR8)
+ * \brief Endpoint packet management definitions for the Atmel AVR8 architecture.
*
* Functions, macros, variables, enums and types related to packet management of endpoints.
*/
/** \ingroup Group_EndpointManagement
* \defgroup Group_EndpointManagement_AVR8 Endpoint Management (AVR8)
+ * \brief Endpoint management definitions for the Atmel AVR8 architecture.
*
* Functions, macros and enums related to endpoint management when in USB Device mode. This
* module contains the endpoint management macros, as well as endpoint interrupt and data
/** \ingroup Group_PipeRW
* \defgroup Group_PipeRW_AVR8 Pipe Data Reading and Writing (AVR8)
- * \brief USB Pipe definitions for the AVR8 microcontrollers.
+ * \brief Pipe data read/write definitions for the Atmel AVR8 architecture.
*
* Functions, macros, variables, enums and types related to data reading and writing from and to pipes.
*/
/** \ingroup Group_PipePrimitiveRW
* \defgroup Group_PipePrimitiveRW_AVR8 Read/Write of Primitive Data Types (AVR8)
+ * \brief Pipe primative data read/write definitions for the Atmel AVR8 architecture.
*
* Functions, macros, variables, enums and types related to data reading and writing of primitive data types
* from and to pipes.
/** \ingroup Group_PipePacketManagement
* \defgroup Group_PipePacketManagement_AVR8 Pipe Packet Management (AVR8)
+ * \brief Pipe packet management definitions for the Atmel AVR8 architecture.
*
* Functions, macros, variables, enums and types related to packet management of pipes.
*/
/** \ingroup Group_PipeControlReq
* \defgroup Group_PipeControlReq_AVR8 Pipe Control Request Management (AVR8)
+ * \brief Pipe control request management definitions for the Atmel AVR8 architecture.
*
* Module for host mode request processing. This module allows for the transmission of standard, class and
* vendor control requests to the default control endpoint of an attached device while in host mode.
/** \ingroup Group_PipeManagement
* \defgroup Group_PipeManagement_AVR8 Pipe Management (AVR8)
+ * \brief Pipe management definitions for the Atmel AVR8 architecture.
*
* This module contains functions, macros and enums related to pipe management when in USB Host mode. This
* module contains the pipe management macros, as well as pipe interrupt and data send/receive functions
\r
/** \ingroup Group_USB\r
* \defgroup Group_Device Device Management\r
- * \brief Common USB Device definitions for all architectures.\r
+ * \brief USB Device management definitions for USB device mode.\r
*\r
* USB Device mode related definitions common to all architectures. This module contains definitions which\r
* are used when the USB controller is initialized in device mode.\r
*/\r
\r
/** \file\r
- * \brief Common USB Endpoint definitions for all architectures.\r
+ * \brief USB Endpoint definitions for all architectures.\r
* \copydetails Group_EndpointManagement\r
*\r
* \note This file should not be included directly. It is automatically included as needed by the USB driver\r
\r
/** \ingroup Group_EndpointManagement\r
* \defgroup Group_EndpointRW Endpoint Data Reading and Writing\r
- * \brief Common USB Endpoint definitions for all architectures.\r
+ * \brief Endpoint data read/write definitions.\r
*\r
* Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.\r
*/\r
\r
/** \ingroup Group_EndpointRW\r
* \defgroup Group_EndpointPrimitiveRW Read/Write of Primitive Data Types\r
+ * \brief Endpoint data primative read/write definitions.\r
*\r
* Functions, macros, variables, enums and types related to data reading and writing of primitive data types\r
* from and to endpoints.\r
\r
/** \ingroup Group_EndpointManagement\r
* \defgroup Group_EndpointPacketManagement Endpoint Packet Management\r
+ * \brief USB Endpoint package management definitions.\r
*\r
* Functions, macros, variables, enums and types related to packet management of endpoints.\r
*/\r
\r
/** \ingroup Group_USB\r
* \defgroup Group_EndpointManagement Endpoint Management\r
+ * \brief Endpoint management definitions.\r
*\r
* Functions, macros and enums related to endpoint management when in USB Device mode. This\r
* module contains the endpoint management macros, as well as endpoint interrupt and data\r
\r
/** \ingroup Group_USB\r
* \defgroup Group_Host Host Management\r
- * \brief Common USB Host definitions for all architectures.\r
+ * \brief USB Host management definitions for USB host mode.\r
*\r
* USB Host mode related macros and enums. This module contains macros and enums which are used when\r
* the USB controller is initialized in host mode.\r
\r
/** \ingroup Group_USB\r
* \defgroup Group_OTG USB On The Go (OTG) Management\r
- * \brief Common USB OTG definitions for all architectures.\r
+ * \brief USB OTG management definitions.\r
*\r
* This module contains macros for embedded USB hosts with dual role On The Go capabilities, for managing role\r
* exchange. OTG is a way for two USB dual role devices to talk to one another directly without fixed device/host\r
\r
/** \ingroup Group_PipeManagement\r
* \defgroup Group_PipeRW Pipe Data Reading and Writing\r
- * \brief Common USB Pipe definitions for all architectures.\r
+ * \brief Pipe data read/write definitions.\r
*\r
* Functions, macros, variables, enums and types related to data reading and writing from and to pipes.\r
*/\r
\r
/** \ingroup Group_PipeRW\r
* \defgroup Group_PipePrimitiveRW Read/Write of Primitive Data Types\r
+ * \brief Pipe data primative read/write definitions.\r
*\r
* Functions, macros, variables, enums and types related to data reading and writing of primitive data types\r
* from and to pipes.\r
\r
/** \ingroup Group_PipeManagement\r
* \defgroup Group_PipePacketManagement Pipe Packet Management\r
+ * \brief Pipe packet management definitions.\r
*\r
* Functions, macros, variables, enums and types related to packet management of pipes.\r
*/\r
\r
/** \ingroup Group_PipeManagement\r
* \defgroup Group_PipeControlReq Pipe Control Request Management\r
+ * \brief Pipe control request definitions.\r
*\r
* Module for host mode request processing. This module allows for the transmission of standard, class and\r
* vendor control requests to the default control endpoint of an attached device while in host mode.\r
\r
/** \ingroup Group_USB\r
* \defgroup Group_PipeManagement Pipe Management\r
+ * \brief Pipe management definitions.\r
*\r
* This module contains functions, macros and enums related to pipe management when in USB Host mode. This\r
* module contains the pipe management macros, as well as pipe interrupt and data send/receive functions\r
*/
/** \file
- * \brief Common USB Descriptor definitions for all architectures.
+ * \brief Common standard USB Descriptor definitions for all architectures.
* \copydetails Group_StdDescriptors
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
/** \ingroup Group_USB
* \defgroup Group_StdDescriptors USB Descriptors
- * \brief Common USB Descriptor definitions for all architectures.
+ * \brief Standard USB Descriptor definitions.
*
* Standard USB device descriptor defines and retrieval routines, for USB devices. This module contains
* structures and macros for the easy creation of standard USB descriptors in USB device projects.
\r
/** \ingroup Group_USB\r
* \defgroup Group_USBManagement USB Interface Management\r
- * \brief Common USB Controller definitions for all architectures.\r
+ * \brief USB Controller definitions for general USB controller management.\r
*\r
* Functions, macros, variables, enums and types related to the setup and management of the USB interface.\r
*\r
*/
/** \defgroup Group_Scheduler Simple Task Scheduler - LUFA/Scheduler/Scheduler.h
+ * \brief Simple round-robbin pseudo-task scheduler.
*
* \deprecated This module is deprecated and will be removed in a future library release.
*
projects / pub / USBasp.git / commitdiff