Commit 9257f4ab authored by Dean Camera's avatar Dean Camera
Browse files

Add briefs for the library core structures.

parent 05576760
......@@ -31,6 +31,8 @@
/** \file
* \brief Board specific Buttons driver header for the STK526.
*
* Board specific Buttons driver header for the STK526.
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
*/
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Board specific Dataflash driver header for the STK525.
*
* Board specific Dataflash driver header for the STK525.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.
*/
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Board specific joystick driver header for the STK526.
*
* Board specific joystick driver header for the STK526.
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver
* dispatch header located in LUFA/Drivers/Board/Joystick.h.
*/
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Board specific LED driver header for the STK526.
*
* Board specific LED driver header for the STK526.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*/
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Board specific LED driver header for the PJRC Teensy boards.
*
* Board specific LED driver header for the PJRC Teensy boards.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*/
......
......@@ -31,7 +31,7 @@
/** \file
* \brief Master include file for the board temperature sensor driver.
*
* Temperature sensor board driver for the USB boards which contain a temperature sensor.
* Master include file for the board temperature sensor driver, for the USB boards which contain a temperature sensor.
*/
/** \ingroup Group_BoardDrivers
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Board specific Dataflash commands header for the AT45DB642D as mounted on the USBKEY.
*
* Board specific Dataflash commands header for the AT45DB642D as mounted on the USBKEY.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.
*/
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Board specific Buttons driver header for the USBKEY.
*
* Board specific Buttons driver header for the USBKEY.
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.
*/
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Board specific Dataflash driver header for the USBKEY.
*
* Board specific Dataflash driver header for the USBKEY.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.
*/
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Board specific joystick driver header for the USBKEY.
*
* Board specific joystick driver header for the USBKEY.
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver
* dispatch header located in LUFA/Drivers/Board/Joystick.h.
*/
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Board specific LED driver header for the USBKEY.
*
* Board specific LED driver header for the USBKEY.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*/
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Board specific Dataflash commands header for the AT45DB642D as mounted on the XPLAIN.
*
* Board specific Dataflash commands header for the AT45DB642D as mounted on the XPLAIN.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.
*/
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Board specific Dataflash driver header for the XPLAIN.
*
* Board specific Dataflash driver header for the XPLAIN.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.
*/
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Board specific LED driver header for the XPLAIN.
*
* Board specific LED driver header for the XPLAIN.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.
*/
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Master include file for the library USB Audio Class driver.
*
* Master include file for the library USB Audio Class driver, for both host and device modes, where available.
*
* This file should be included in all user projects making use of this optional class driver, instead of
* including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.
*/
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Master include file for the library USB CDC-ACM Class driver.
*
* Master include file for the library USB CDC Class driver, for both host and device modes, where available.
*
* This file should be included in all user projects making use of this optional class driver, instead of
* including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.
*/
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Common definitions and declarations for the library USB Audio Class driver.
*
* Common definitions and declarations for the library USB Audio Class driver.
*
* \note This file should not be included directly. It is automatically included as needed by the class driver
* dispatch header located in LUFA/Drivers/USB/Class/Audio.h.
*/
......@@ -234,7 +236,9 @@
#define EP_ACCEPTS_SMALL_PACKETS (0 << 7)
/* Type Defines: */
/** Type define for an Audio class specific interface descriptor. This follows a regular interface descriptor to
/** \brief Audio Class Specific Interface Descriptor.
*
* Type define for an Audio class specific interface descriptor. This follows a regular interface descriptor to
* supply extra information about the audio device's layout to the host. See the USB Audio specification for more
* details.
*/
......@@ -250,7 +254,9 @@
uint8_t InterfaceNumbers[1]; /**< Interface numbers of each audio interface */
} USB_Audio_Interface_AC_t;
/** Type define for an Audio class specific Feature Unit descriptor. This indicates to the host what features
/** \brief Audio Class Specific Feature Unit Descriptor.
*
* Type define for an Audio class specific Feature Unit descriptor. This indicates to the host what features
* are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
* specification for more details.
*/
......@@ -268,7 +274,9 @@
uint8_t FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
} USB_Audio_FeatureUnit_t;
/** Type define for an Audio class specific input terminal descriptor. This indicates to the host that the device
/** \brief Audio Class Specific Input Terminal Descriptor.
*
* Type define for an Audio class specific input terminal descriptor. This indicates to the host that the device
* contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
* a USB endpoint). See the USB Audio specification for more details.
*/
......@@ -289,7 +297,9 @@
uint8_t TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
} USB_Audio_InputTerminal_t;
/** Type define for an Audio class specific output terminal descriptor. This indicates to the host that the device
/** \brief Audio Class Specific Output Terminal Descriptor.
*
* Type define for an Audio class specific output terminal descriptor. This indicates to the host that the device
* contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
* a USB endpoint). See the USB Audio specification for more details.
*/
......@@ -308,7 +318,9 @@
uint8_t TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
} USB_Audio_OutputTerminal_t;
/** Type define for an Audio class specific streaming interface descriptor. This indicates to the host
/** \brief Audio Class Specific Streaming Audio Interface Descriptor.
*
* Type define for an Audio class specific streaming interface descriptor. This indicates to the host
* how audio streams within the device are formatted. See the USB Audio specification for more details.
*/
typedef struct
......@@ -322,7 +334,9 @@
uint16_t AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification */
} USB_Audio_Interface_AS_t;
/** Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype,
/** \brief 24-Bit Audio Frequency Structure.
*
* Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype,
* this this structure is used to build up the value instead. Fill this structure with the SAMPLE_FREQ() macro.
*/
typedef struct
......@@ -331,7 +345,9 @@
uint8_t HighByte; /**< Upper 8 bits of the 24-bit value */
} USB_Audio_SampleFreq_t;
/** Type define for an Audio class specific audio format descriptor. This is used to give the host full details
/** \brief Audio Class Specific Format Descriptor.
*
* Type define for an Audio class specific audio format descriptor. This is used to give the host full details
* about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
* in the device's audio streams. See the USB Audio specification for more details.
*/
......@@ -350,7 +366,9 @@
USB_Audio_SampleFreq_t SampleFrequencies[AUDIO_TOTAL_SAMPLE_RATES]; /**< Sample frequencies supported by the device */
} USB_Audio_Format_t;
/** Type define for an Audio class specific endpoint descriptor. This contains a regular endpoint
/** \brief Audio Class Specific Streaming Endpoint Descriptor.
*
* Type define for an Audio class specific endpoint descriptor. This contains a regular endpoint
* descriptor with a few Audio-class specific extensions. See the USB Audio specification for more details.
*/
typedef struct
......@@ -361,7 +379,9 @@
uint8_t SyncEndpointNumber; /**< Endpoint address to send synchronization information to, if needed (zero otherwise) */
} USB_Audio_StreamEndpoint_Std_t;
/** Type define for an Audio class specific extended endpoint descriptor. This contains extra information
/** \brief Audio Class Specific Extended Endpoint Descriptor.
*
* Type define for an Audio class specific extended endpoint descriptor. This contains extra information
* on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
* class specific extended endpoint descriptor. See the USB Audio specification for more details.
*/
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Common definitions and declarations for the library USB CDC Class driver.
*
* Common definitions and declarations for the library USB CDC Class driver.
*
* \note This file should not be included directly. It is automatically included as needed by the class driver
* dispatch header located in LUFA/Drivers/USB/Class/CDC.h.
*/
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Common definitions and declarations for the library USB HID Class driver.
*
* Common definitions and declarations for the library USB HID Class driver.
*
* \note This file should not be included directly. It is automatically included as needed by the class driver
* dispatch header located in LUFA/Drivers/USB/Class/HID.h.
*/
......@@ -143,7 +145,9 @@
REPORT_ITEM_TYPE_Feature = 2, /**< Indicates that the item is a FEATURE report type. */
};
/** Type define for the HID class specific HID descriptor, to describe the HID device's specifications. Refer to the HID
/** \brief HID Class Specific HID Descriptor.
*
* Type define for the HID class specific HID descriptor, to describe the HID device's specifications. Refer to the HID
* specification for details on the structure elements.
*/
typedef struct
......@@ -159,7 +163,10 @@
uint16_t HIDReportLength;
} USB_HID_Descriptor_t;
/** Type define for a standard Boot Protocol Mouse report */
/** \brief Standard HID Boot Protocol Mouse Report.
*
* Type define for a standard Boot Protocol Mouse report
*/
typedef struct
{
uint8_t Button; /**< Button mask for currently pressed buttons in the mouse */
......@@ -167,7 +174,10 @@
int8_t Y; /**< Current delta Y movement on the mouse */
} USB_MouseReport_Data_t;
/** Type define for a standard Boot Protocol Keyboard report */
/** \brief Standard HID Boot Protocol Keyboard Report.
*
* Type define for a standard Boot Protocol Keyboard report
*/
typedef struct
{
uint8_t Modifier; /**< Keyboard modifier byte, indicating pressed modifier keys (a combination of
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Common definitions and declarations for the library USB MIDI Class driver.
*
* Common definitions and declarations for the library USB MIDI Class driver.
*
* \note This file should not be included directly. It is automatically included as needed by the class driver
* dispatch header located in LUFA/Drivers/USB/Class/MIDI.h.
*/
......@@ -97,7 +99,9 @@
#define MIDI_CHANNEL(channel) ((channel) - 1)
/* Type Defines: */
/** Type define for an Audio class specific MIDI streaming interface descriptor. This indicates to the host
/** \brief MIDI Class Specific Streaming Interface Descriptor.
*
* Type define for an Audio class specific MIDI streaming interface descriptor. This indicates to the host
* how MIDI the specification compliance of the device and the total length of the Audio class specific descriptors.
* See the USB Audio specification for more details.
*/
......@@ -110,7 +114,9 @@
uint16_t TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */
} USB_MIDI_AudioInterface_AS_t;
/** Type define for an Audio class specific MIDI IN jack. This gives information to the host on a MIDI input, either
/** \brief MIDI Class Specific Input Jack Descriptor.
*
* Type define for an Audio class specific MIDI IN jack. This gives information to the host on a MIDI input, either
* a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).
*/
typedef struct
......@@ -124,7 +130,9 @@
uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
} USB_MIDI_In_Jack_t;
/** Type define for an Audio class specific MIDI OUT jack. This gives information to the host on a MIDI output, either
/** \brief MIDI Class Specific Output Jack Descriptor.
*
* Type define for an Audio class specific MIDI OUT jack. This gives information to the host on a MIDI output, either
* a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).
*/
typedef struct
......@@ -142,7 +150,9 @@
uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
} USB_MIDI_Out_Jack_t;
/** Type define for an Audio class specific extended MIDI jack endpoint descriptor. This contains extra information
/** \brief Audio Class Specific Jack Endpoint Descriptor.
*
* Type define for an Audio class specific extended MIDI jack endpoint descriptor. This contains extra information
* on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio
* class specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.
*/
......@@ -155,7 +165,10 @@
uint8_t AssociatedJackID[1]; /**< IDs of each jack inside the endpoint */
} USB_MIDI_Jack_Endpoint_t;
/** Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface. */
/** \brief MIDI Class Driver Event Packet.
*
* Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface.
*/
typedef struct
{
unsigned char Command : 4; /**< Upper nibble of the MIDI command being sent or received in the event packet */
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment