/*\r
LUFA Library\r
- Copyright (C) Dean Camera, 2009.\r
+ Copyright (C) Dean Camera, 2010.\r
\r
dean [at] fourwalledcubicle [dot] com\r
www.fourwalledcubicle.com\r
*/\r
\r
/*\r
- Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+ Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
\r
- Permission to use, copy, modify, and distribute this software\r
- and its documentation for any purpose and without fee is hereby\r
- granted, provided that the above copyright notice appear in all\r
- copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting\r
- documentation, and that the name of the author not be used in\r
- advertising or publicity pertaining to distribution of the\r
+ Permission to use, copy, modify, distribute, and sell this \r
+ software and its documentation for any purpose is hereby granted\r
+ without fee, provided that the above copyright notice appear in \r
+ all copies and that both that the copyright notice and this\r
+ permission notice and warranty disclaimer appear in supporting \r
+ documentation, and that the name of the author not be used in \r
+ advertising or publicity pertaining to distribution of the \r
software without specific, written prior permission.\r
\r
The author disclaim all warranties with regard to this\r
*/\r
\r
/** \file\r
+ * \brief Configuration descriptor parser API.\r
*\r
- * Configuration descriptor parser API. This section of the library gives a friendly API which can be used in\r
- * host applications to easily parse an attached device's configuration descriptor so that endpoint, interface\r
- * and other descriptor data can be extracted and used as needed.\r
+ * This section of the library gives a friendly API which can be used in host applications to easily\r
+ * parse an attached device's configuration descriptor so that endpoint, interface and other descriptor\r
+ * data can be extracted and used as needed.\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_Descriptors\r
extern "C" {\r
#endif\r
\r
+ /* Preprocessor Checks: */\r
+ #if !defined(__INCLUDE_FROM_USB_DRIVER)\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
/* Macros: */\r
/** Mask for determining the type of an endpoint from an endpoint descriptor. This should then be compared\r
*\r
* \see \ref USB_GetNextDescriptorComp function for more details\r
*/\r
- typedef uint8_t (* const ConfigComparatorPtr_t)(void* const);\r
+ typedef uint8_t (* const ConfigComparatorPtr_t)(void*);\r
\r
/* Function Prototypes: */\r
/** Searches for the next descriptor in the given configuration descriptor using a premade comparator\r
uint8_t USB_GetNextDescriptorComp(uint16_t* BytesRem, void** CurrConfigLoc, ConfigComparatorPtr_t ComparatorRoutine);\r
\r
/* Enums: */\r
- /** Enum for the possible return codes of the \ref USB_GetDeviceConfigDescriptor() function. */\r
+ /** Enum for the possible return codes of the \ref USB_Host_GetDeviceConfigDescriptor() function. */\r
enum USB_Host_GetConfigDescriptor_ErrorCodes_t\r
{\r
HOST_GETCONFIG_Successful = 0, /**< No error occurred while retrieving the configuration descriptor */\r
*\r
* \return A value from the \ref USB_Host_GetConfigDescriptor_ErrorCodes_t enum\r
*/\r
- uint8_t USB_GetDeviceConfigDescriptor(uint8_t ConfigNumber, uint16_t* const ConfigSizePtr, void* BufferPtr,\r
- uint16_t BufferSize) ATTR_NON_NULL_PTR_ARG(2, 3);\r
+ uint8_t USB_Host_GetDeviceConfigDescriptor(uint8_t ConfigNumber, uint16_t* const ConfigSizePtr, void* BufferPtr,\r
+ uint16_t BufferSize) ATTR_NON_NULL_PTR_ARG(2) ATTR_NON_NULL_PTR_ARG(3);\r
\r
/** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value.\r
* The bytes remaining value is automatically decremented.\r
void USB_GetNextDescriptorOfType(uint16_t* const BytesRem,\r
void** const CurrConfigLoc,\r
const uint8_t Type)\r
- ATTR_NON_NULL_PTR_ARG(1, 2);\r
+ ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
\r
/** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value,\r
* which must come before a descriptor of the second given type value. If the BeforeType type\r
void** const CurrConfigLoc,\r
const uint8_t Type,\r
const uint8_t BeforeType)\r
- ATTR_NON_NULL_PTR_ARG(1, 2);\r
+ ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
\r
/** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value,\r
* which must come after a descriptor of the second given type value. The bytes remaining value is\r
void** const CurrConfigLoc,\r
const uint8_t Type,\r
const uint8_t AfterType)\r
- ATTR_NON_NULL_PTR_ARG(1, 2);\r
+ ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
\r
/* Inline Functions: */\r
/** Skips over the current sub-descriptor inside the configuration descriptor, so that the pointer then\r
*/\r
static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,\r
void** const CurrConfigLoc) \r
- ATTR_NON_NULL_PTR_ARG(1, 2); \r
+ ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2); \r
static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,\r
void** const CurrConfigLoc)\r
{\r
projects / pub / USBasp.git / blobdiff