this software.\r
*/\r
\r
+/** \file\r
+ * \brief USB standard descriptor definitions.\r
+ *\r
+ * This file contains structures and macros for the easy creation of standard USB descriptors in USB device projects.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+\r
/** \ingroup Group_USB\r
* @defgroup Group_Descriptors USB Descriptors\r
*\r
\r
/* Preprocessor Checks: */\r
#if !defined(__INCLUDE_FROM_USB_DRIVER)\r
- #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.\r
+ #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.\r
#endif\r
\r
/* Public Interface - May be used in end-application: */\r
#define USE_INTERNAL_SERIAL NO_DESCRIPTOR\r
#endif\r
\r
- /** Macro to calculate the power value for the device descriptor, from a given number of milliamps. */\r
+ /** Macro to calculate the power value for the configuration descriptor, from a given number of milliamps. */\r
#define USB_CONFIG_POWER_MA(mA) ((mA) >> 1)\r
\r
/** Macro to calculate the Unicode length of a string with a given number of Unicode characters.\r
*/\r
#define USB_CONFIG_ATTR_BUSPOWERED 0x80\r
\r
- \r
/** Can be masked with other configuration descriptor attributes for a \ref USB_Descriptor_Configuration_Header_t\r
* descriptor's ConfigAttributes value to indicate that the specified configuration can draw its power\r
* from the device's own power source.\r
};\r
\r
/* Type Defines: */\r
- /** Type define for all descriptors standard header, indicating the descriptor's length and type. This structure\r
+ /** \brief Standard USB Descriptor Header (LUFA naming conventions).\r
+ *\r
+ * Type define for all descriptors' standard header, indicating the descriptor's length and type. This structure\r
* uses LUFA-specific element names to make each element's purpose clearer.\r
*\r
* \see \ref USB_StdDescriptor_Header_t for the version of this define with standard element names\r
*/\r
} USB_Descriptor_Header_t;\r
\r
- /** Type define for all descriptors standard header, indicating the descriptor's length and type. This structure\r
+ /** \brief Standard USB Descriptor Header (USB-IF naming conventions).\r
+ *\r
+ * Type define for all descriptors' standard header, indicating the descriptor's length and type. This structure\r
* uses the relevant standard's given element names to ensure compatibility with the standard.\r
*\r
* \see \ref USB_Descriptor_Header_t for the version of this define with non-standard LUFA specific element names\r
*/\r
} USB_StdDescriptor_Header_t;\r
\r
- /** Type define for a standard Device Descriptor. This structure uses LUFA-specific element names to make each\r
+ /** \brief Standard USB Device Descriptor (LUFA naming conventions).\r
+ *\r
+ * Type define for a standard Device Descriptor. This structure uses LUFA-specific element names to make each\r
* element's purpose clearer.\r
*\r
* \see \ref USB_StdDescriptor_Device_t for the version of this define with standard element names\r
*/\r
} USB_Descriptor_Device_t;\r
\r
- /** Type define for a standard Device Descriptor. This structure uses the relevant standard's given element names\r
+ /** \brief Standard USB Device Descriptor (USB-IF naming conventions).\r
+ *\r
+ * Type define for a standard Device Descriptor. This structure uses the relevant standard's given element names\r
* to ensure compatibility with the standard.\r
*\r
* \see \ref USB_Descriptor_Device_t for the version of this define with non-standard LUFA specific element names\r
*/\r
} USB_StdDescriptor_Device_t;\r
\r
- /** Type define for a standard Configuration Descriptor header. This structure uses LUFA-specific element names\r
+ /** \brief Standard USB Configuration Descriptor (LUFA naming conventions).\r
+ *\r
+ * Type define for a standard Configuration Descriptor header. This structure uses LUFA-specific element names\r
* to make each element's purpose clearer.\r
*\r
* \see \ref USB_StdDescriptor_Configuration_Header_t for the version of this define with standard element names\r
*/\r
} USB_Descriptor_Configuration_Header_t;\r
\r
- /** Type define for a standard Configuration Descriptor header. This structure uses the relevant standard's given element names\r
+ /** \brief Standard USB Configuration Descriptor (USB-IF naming conventions).\r
+ *\r
+ * Type define for a standard Configuration Descriptor header. This structure uses the relevant standard's given element names\r
* to ensure compatibility with the standard.\r
*\r
* \see \ref USB_Descriptor_Device_t for the version of this define with non-standard LUFA specific element names\r
*/\r
} USB_StdDescriptor_Configuration_Header_t;\r
\r
- /** Type define for a standard Interface Descriptor. This structure uses LUFA-specific element names\r
+ /** \brief Standard USB Interface Descriptor (LUFA naming conventions).\r
+ *\r
+ * Type define for a standard Interface Descriptor. This structure uses LUFA-specific element names\r
* to make each element's purpose clearer.\r
*\r
* \see \ref USB_StdDescriptor_Interface_t for the version of this define with standard element names\r
*/\r
} USB_Descriptor_Interface_t;\r
\r
- /** Type define for a standard Interface Descriptor. This structure uses the relevant standard's given element names\r
+ /** \brief Standard USB Interface Descriptor (USB-IF naming conventions).\r
+ *\r
+ * Type define for a standard Interface Descriptor. This structure uses the relevant standard's given element names\r
* to ensure compatibility with the standard.\r
*\r
* \see \ref USB_Descriptor_Interface_t for the version of this define with non-standard LUFA specific element names\r
*/\r
} USB_StdDescriptor_Interface_t;\r
\r
- /** Type define for a standard Interface Association Descriptor. This structure uses LUFA-specific element names\r
+ /** \brief Standard USB Interface Association Descriptor (LUFA naming conventions).\r
+ *\r
+ * Type define for a standard Interface Association Descriptor. This structure uses LUFA-specific element names\r
* to make each element's purpose clearer.\r
*\r
* This descriptor has been added as a supplement to the USB2.0 standard, in the ECN located at\r
*/\r
} USB_Descriptor_Interface_Association_t;\r
\r
- /** Type define for a standard Interface Association Descriptor. This structure uses the relevant standard's given\r
+ /** \brief Standard USB Interface Association Descriptor (USB-IF naming conventions).\r
+ *\r
+ * Type define for a standard Interface Association Descriptor. This structure uses the relevant standard's given\r
* element names to ensure compatibility with the standard.\r
*\r
* This descriptor has been added as a supplement to the USB2.0 standard, in the ECN located at\r
*/\r
} USB_StdDescriptor_Interface_Association_t;\r
\r
- /** Type define for a standard Endpoint Descriptor. This structure uses LUFA-specific element names\r
+ /** \brief Standard USB Endpoint Descriptor (LUFA naming conventions).\r
+ *\r
+ * Type define for a standard Endpoint Descriptor. This structure uses LUFA-specific element names\r
* to make each element's purpose clearer.\r
*\r
* \see \ref USB_StdDescriptor_Endpoint_t for the version of this define with standard element names\r
*/\r
} USB_Descriptor_Endpoint_t;\r
\r
- /** Type define for a standard Endpoint Descriptor. This structure uses the relevant standard's given\r
+ /** \brief Standard USB Endpoint Descriptor (USB-IF naming conventions).\r
+ *\r
+ * Type define for a standard Endpoint Descriptor. This structure uses the relevant standard's given\r
* element names to ensure compatibility with the standard.\r
*\r
* \see \ref USB_Descriptor_Endpoint_t for the version of this define with non-standard LUFA specific\r
*/\r
} USB_StdDescriptor_Endpoint_t;\r
\r
- /** Type define for a standard string descriptor. Unlike other standard descriptors, the length\r
+ /** \brief Standard USB String Descriptor (LUFA naming conventions).\r
+ *\r
+ * Type define for a standard string descriptor. Unlike other standard descriptors, the length\r
* of the descriptor for placement in the descriptor header must be determined by the \ref USB_STRING_LEN()\r
* macro rather than by the size of the descriptor structure, as the length is not fixed.\r
*\r
*/\r
} USB_Descriptor_String_t;\r
\r
- /** Type define for a standard string descriptor. Unlike other standard descriptors, the length\r
+ /** \brief Standard USB String Descriptor (USB-IF naming conventions).\r
+ *\r
+ * Type define for a standard string descriptor. Unlike other standard descriptors, the length\r
* of the descriptor for placement in the descriptor header must be determined by the \ref USB_STRING_LEN()\r
* macro rather than by the size of the descriptor structure, as the length is not fixed.\r
*\r
projects / pub / USBasp.git / blobdiff