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 Host mode driver for the library USB Still Image Class driver.
*
* Host mode driver for the library USB Still Image 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/StillImage.h.
*/
......@@ -71,6 +73,12 @@
#define SI_ERROR_LOGICAL_CMD_FAILED 0x80
/* Type Defines: */
/** \brief Still Image Class Host Mode Configuration and State Structure.
*
* Class state structure. An instance of this structure should be made within the user application,
* and passed to each of the Still Image class driver functions as the SIInterfaceInfo parameter. This
* stores each Still Image interface's configuration and state information.
*/
typedef struct
{
const struct
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Master include file for the library USB MIDI Class driver.
*
* Master include file for the library USB MIDI 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 Mass Storage Class driver.
*
* Master include file for the library USB Mass Storage 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 Printer Class driver.
*
* Master include file for the library USB Printer 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 RNDIS Class driver.
*
* Master include file for the library USB RNDIS 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 Still Image Class driver.
*
* Master include file for the library USB Still Image 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.
*/
......
......@@ -211,7 +211,9 @@
};
/* Type Defines: */
/** Type define for all descriptors standard header, indicating the descriptor's length and type. This structure
/** \brief Standard USB Descriptor Header (LUFA naming conventions).
*
* Type define for all descriptors' standard header, indicating the descriptor's length and type. This structure
* uses LUFA-specific element names to make each element's purpose clearer.
*
* \see \ref USB_StdDescriptor_Header_t for the version of this define with standard element names
......@@ -224,7 +226,9 @@
*/
} USB_Descriptor_Header_t;
/** Type define for all descriptors standard header, indicating the descriptor's length and type. This structure
/** \brief Standard USB Descriptor Header (USB-IF naming conventions).
*
* Type define for all descriptors' standard header, indicating the descriptor's length and type. This structure
* uses the relevant standard's given element names to ensure compatibility with the standard.
*
* \see \ref USB_Descriptor_Header_t for the version of this define with non-standard LUFA specific element names
......@@ -237,7 +241,9 @@
*/
} USB_StdDescriptor_Header_t;
/** Type define for a standard Device Descriptor. This structure uses LUFA-specific element names to make each
/** \brief Standard USB Device Descriptor (LUFA naming conventions).
*
* Type define for a standard Device Descriptor. This structure uses LUFA-specific element names to make each
* element's purpose clearer.
*
* \see \ref USB_StdDescriptor_Device_t for the version of this define with standard element names
......@@ -284,7 +290,9 @@
*/
} USB_Descriptor_Device_t;
/** Type define for a standard Device Descriptor. This structure uses the relevant standard's given element names
/** \brief Standard USB Device Descriptor (USB-IF naming conventions).
*
* Type define for a standard Device Descriptor. This structure uses the relevant standard's given element names
* to ensure compatibility with the standard.
*
* \see \ref USB_Descriptor_Device_t for the version of this define with non-standard LUFA specific element names
......@@ -330,7 +338,9 @@
*/
} USB_StdDescriptor_Device_t;
/** Type define for a standard Configuration Descriptor header. This structure uses LUFA-specific element names
/** \brief Standard USB Configuration Descriptor (LUFA naming conventions).
*
* Type define for a standard Configuration Descriptor header. This structure uses LUFA-specific element names
* to make each element's purpose clearer.
*
* \see \ref USB_StdDescriptor_Configuration_Header_t for the version of this define with standard element names
......@@ -357,7 +367,9 @@
*/
} USB_Descriptor_Configuration_Header_t;
/** Type define for a standard Configuration Descriptor header. This structure uses the relevant standard's given element names
/** \brief Standard USB Configuration Descriptor (USB-IF naming conventions).
*
* Type define for a standard Configuration Descriptor header. This structure uses the relevant standard's given element names
* to ensure compatibility with the standard.
*
* \see \ref USB_Descriptor_Device_t for the version of this define with non-standard LUFA specific element names
......@@ -383,7 +395,9 @@
*/
} USB_StdDescriptor_Configuration_Header_t;
/** Type define for a standard Interface Descriptor. This structure uses LUFA-specific element names
/** \brief Standard USB Interface Descriptor (LUFA naming conventions).
*
* Type define for a standard Interface Descriptor. This structure uses LUFA-specific element names
* to make each element's purpose clearer.
*
* \see \ref USB_StdDescriptor_Interface_t for the version of this define with standard element names
......@@ -409,7 +423,9 @@
*/
} USB_Descriptor_Interface_t;
/** Type define for a standard Interface Descriptor. This structure uses the relevant standard's given element names
/** \brief Standard USB Interface Descriptor (USB-IF naming conventions).
*
* Type define for a standard Interface Descriptor. This structure uses the relevant standard's given element names
* to ensure compatibility with the standard.
*
* \see \ref USB_Descriptor_Interface_t for the version of this define with non-standard LUFA specific element names
......@@ -435,7 +451,9 @@
*/
} USB_StdDescriptor_Interface_t;
/** Type define for a standard Interface Association Descriptor. This structure uses LUFA-specific element names
/** \brief Standard USB Interface Association Descriptor (LUFA naming conventions).
*
* Type define for a standard Interface Association Descriptor. This structure uses LUFA-specific element names
* to make each element's purpose clearer.
*
* This descriptor has been added as a supplement to the USB2.0 standard, in the ECN located at
......@@ -462,7 +480,9 @@
*/
} USB_Descriptor_Interface_Association_t;
/** Type define for a standard Interface Association Descriptor. This structure uses the relevant standard's given
/** \brief Standard USB Interface Association Descriptor (USB-IF naming conventions).
*
* Type define for a standard Interface Association Descriptor. This structure uses the relevant standard's given
* element names to ensure compatibility with the standard.
*
* This descriptor has been added as a supplement to the USB2.0 standard, in the ECN located at
......@@ -490,7 +510,9 @@
*/
} USB_StdDescriptor_Interface_Association_t;
/** Type define for a standard Endpoint Descriptor. This structure uses LUFA-specific element names
/** \brief Standard USB Endpoint Descriptor (LUFA naming conventions).
*
* Type define for a standard Endpoint Descriptor. This structure uses LUFA-specific element names
* to make each element's purpose clearer.
*
* \see \ref USB_StdDescriptor_Endpoint_t for the version of this define with standard element names
......@@ -516,7 +538,9 @@
*/
} USB_Descriptor_Endpoint_t;
/** Type define for a standard Endpoint Descriptor. This structure uses the relevant standard's given
/** \brief Standard USB Endpoint Descriptor (USB-IF naming conventions).
*
* Type define for a standard Endpoint Descriptor. This structure uses the relevant standard's given
* element names to ensure compatibility with the standard.
*
* \see \ref USB_Descriptor_Endpoint_t for the version of this define with non-standard LUFA specific
......@@ -544,7 +568,9 @@
*/
} USB_StdDescriptor_Endpoint_t;
/** Type define for a standard string descriptor. Unlike other standard descriptors, the length
/** \brief Standard USB String Descriptor (LUFA naming conventions).
*
* Type define for a standard string descriptor. Unlike other standard descriptors, the length
* of the descriptor for placement in the descriptor header must be determined by the \ref USB_STRING_LEN()
* macro rather than by the size of the descriptor structure, as the length is not fixed.
*
......@@ -572,7 +598,9 @@
*/
} USB_Descriptor_String_t;
/** Type define for a standard string descriptor. Unlike other standard descriptors, the length
/** \brief Standard USB String Descriptor (USB-IF naming conventions).
*
* Type define for a standard string descriptor. Unlike other standard descriptors, the length
* of the descriptor for placement in the descriptor header must be determined by the \ref USB_STRING_LEN()
* macro rather than by the size of the descriptor structure, as the length is not fixed.
*
......
......@@ -150,7 +150,9 @@
#define FEATURE_REMOTE_WAKEUP 0x01
/* Type Defines: */
/** Type define for a standard USB control request.
/** \brief Standard USB Control Request
*
* Type define for a standard USB control request.
*
* \see The USB 2.0 specification for more information on standard control requests.
*/
......
......@@ -31,6 +31,8 @@
/** \file
* \brief Master include file for the library USB functionality.
*
* Master include file for the library USB functionality.
*
* This file should be included in all user projects making use of the USB portions of the library, instead of
* including any headers in the USB/LowLevel/ or USB/HighLevel/ subdirectories.
*/
......
......@@ -15,6 +15,7 @@
* \section Sec_ProjectHelp Assistance With LUFA
* Discussion Group: http://groups.google.com/group/myusb-support-list \n
* Author's Email: dean [at] fourwalledcubicle [dot] com
* Author's Skype: abcminiuser
*
* \section Sec_InDevelopment Latest In-Development Source Code
* Official Releases, SVN Access, Issue Tracker: http://code.google.com/p/lufa-lib/ \n
......
......@@ -165,7 +165,10 @@
*/
typedef uint16_t SchedulerDelayCounter_t;
/** Structure for holding a single task's information in the scheduler task list. */
/** \brief Scheduler Task List Entry Structure.
*
* Structure for holding a single task's information in the scheduler task list.
*/
typedef struct
{
TaskPtr_t Task; /**< Pointer to the task to execute. */
......
......@@ -299,10 +299,6 @@ void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDI
{
Device_Report_t* ReportParams = (Device_Report_t*)ReportData;
GPIOR0 = ReportParams->Day;
GPIOR1 = ReportParams->Month;
GPIOR2 = ReportParams->Year;
DS1307_SetDate(ReportParams->Day, ReportParams->Month, ReportParams->Year);
DS1307_SetTime(ReportParams->Hour, ReportParams->Minute, ReportParams->Second);
......
......@@ -193,7 +193,7 @@ CSTANDARD = -std=gnu99
# Place -D or -U options here for C sources
CDEFS = -DF_CPU=$(F_CPU)UL -DF_CLOCK=$(F_CLOCK)UL -DBOARD=BOARD_$(BOARD) $(LUFA_OPTS)
#CDEFS += -DDUMMY_RTC
CDEFS += -DDUMMY_RTC
# Place -D or -U options here for ASM sources
......
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