/*\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
this software.\r
*/\r
\r
-/** \file\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
- * \see Chapter 9 of the USB 2.0 specification.\r
- */\r
-\r
#ifndef __HOSTCHAPTER9_H__\r
#define __HOSTCHAPTER9_H__\r
\r
#endif\r
\r
/* Public Interface - May be used in end-application: */\r
- /* Type Defines: */\r
- /** Type define for a standard USB control request.\r
- *\r
- * \see StdRequestType.h for information on the request type and data.\r
- * \see The USB 2.0 specification for more information on standard control requests.\r
- *\r
- * \ingroup Group_PipeControlReq\r
- */\r
- typedef struct\r
- {\r
- uint8_t bmRequestType; /**< Type of the request. */\r
- uint8_t bRequest; /**< Request command code. */\r
- uint16_t wValue; /**< wValue parameter of the request. */\r
- uint16_t wIndex; /**< wIndex parameter of the request. */\r
- uint16_t wLength; /**< Length of the data to transfer in bytes. */\r
- } USB_Host_Request_Header_t;\r
-\r
/* Enums: */\r
- /** Enum for the USB_Host_SendControlRequest() return code, indicating the reason for the error\r
+ /** Enum for the \ref USB_Host_SendControlRequest() return code, indicating the reason for the error\r
* if the transfer of the request is unsuccessful.\r
*\r
* \ingroup Group_PipeControlReq\r
*/\r
enum USB_Host_SendControlErrorCodes_t\r
{\r
- HOST_SENDCONTROL_Successful = 0, /**< No error occurred in the request transfer. */\r
- HOST_SENDCONTROL_DeviceDisconnect = 1, /**< The attached device was disconnected during the\r
+ HOST_SENDCONTROL_Successful = 0, /**< No error occurred in the request transfer. */\r
+ HOST_SENDCONTROL_DeviceDisconnected = 1, /**< The attached device was disconnected during the\r
* request transfer.\r
*/\r
- HOST_SENDCONTROL_PipeError = 2, /**< An error occurred in the pipe while sending the request. */\r
- HOST_SENDCONTROL_SetupStalled = 3, /**< The attached device stalled the request, usually\r
+ HOST_SENDCONTROL_PipeError = 2, /**< An error occurred in the pipe while sending the request. */\r
+ HOST_SENDCONTROL_SetupStalled = 3, /**< The attached device stalled the request, usually\r
* indicating that the request is unsupported on the device.\r
*/\r
- HOST_SENDCONTROL_SoftwareTimeOut = 4, /**< The request or data transfer timed out. */\r
+ HOST_SENDCONTROL_SoftwareTimeOut = 4, /**< The request or data transfer timed out. */\r
};\r
\r
- /* Global Variables: */\r
- /** Global for the request to send via the USB_Host_SendControlRequest() function. This\r
- * global should be filled with the correct control request data before sending the request to\r
- * the attached device while in host mode.\r
- *\r
- * \ingroup Group_PipeControlReq\r
- */\r
- extern USB_Host_Request_Header_t USB_HostRequest;\r
- \r
/* Function Prototypes: */\r
- /** Sends the request stored in the USB_HostRequest global structure to the attached device,\r
+ /** Sends the request stored in the \ref USB_ControlRequest global structure to the attached device,\r
* and transfers the data stored in the buffer to the device, or from the device to the buffer\r
* as requested. The transfer is made on the currently selected pipe.\r
*\r
* \ingroup Group_PipeControlReq\r
*\r
- * \param BufferPtr Pointer to the start of the data buffer if the request has a data stage, or\r
- * NULL if the request transfers no data to or from the device.\r
+ * \param[in] BufferPtr Pointer to the start of the data buffer if the request has a data stage, or\r
+ * NULL if the request transfers no data to or from the device.\r
*\r
- * \return A value from the USB_Host_SendControlErrorCodes_t enum to indicate the result.\r
+ * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.\r
*/\r
uint8_t USB_Host_SendControlRequest(void* BufferPtr);\r
\r
\r
/* Function Prototypes: */\r
#if defined(INCLUDE_FROM_HOSTCHAPTER9_C)\r
- static uint8_t USB_Host_Wait_For_Setup_IOS(const uint8_t WaitType);\r
+ static uint8_t USB_Host_WaitForIOS(const uint8_t WaitType);\r
#endif\r
#endif\r
\r
projects / pub / USBasp.git / blobdiff