Add svn:eol-style property to source files, so that the line endings are correctly...
[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / HostChapter9.h
index e38c67e..ab8348d 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2010.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\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
-  software, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-/** \file\r
- *  \brief USB host standard request management.\r
- *\r
- *  This file contains the function prototypes neccesary for the issuing of outgoing standard control requests\r
- *  when the library is in USB host mode.\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
-#ifndef __HOSTCHAPTER9_H__\r
-#define __HOSTCHAPTER9_H__\r
-\r
-       /* Includes: */\r
-               #include <avr/io.h>\r
-               #include <stdbool.h>\r
-               \r
-               #include "LowLevel.h"\r
-               #include "../HighLevel/USBMode.h"\r
-               #include "../HighLevel/StdRequestType.h"\r
-\r
-       /* Enable C linkage for C++ Compilers: */\r
-               #if defined(__cplusplus)\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
-               /* Enums: */\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_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
-                                                                       *   indicating that the request is unsupported on the device.\r
-                                                                       */\r
-                               HOST_SENDCONTROL_SoftwareTimeOut    = 4, /**< The request or data transfer timed out. */\r
-                       };\r
-                       \r
-               /* Function Prototypes: */\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[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 \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.\r
-                        */\r
-                       uint8_t USB_Host_SendControlRequest(void* BufferPtr);\r
-                       \r
-       /* Private Interface - For use in library only: */\r
-       #if !defined(__DOXYGEN__)\r
-               /* Enums: */\r
-                       enum USB_WaitForTypes_t\r
-                       {\r
-                               USB_HOST_WAITFOR_SetupSent,\r
-                               USB_HOST_WAITFOR_InReceived,\r
-                               USB_HOST_WAITFOR_OutReady,\r
-                       };\r
-       \r
-               /* Function Prototypes: */\r
-                       #if defined(__INCLUDE_FROM_HOSTCHAPTER9_C)\r
-                               static uint8_t USB_Host_WaitForIOS(const uint8_t WaitType);\r
-                       #endif\r
-       #endif\r
-\r
-       /* Disable C linkage for C++ Compilers: */\r
-               #if defined(__cplusplus)\r
-                       }\r
-               #endif\r
-               \r
-#endif\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2010.
+              
+  dean [at] fourwalledcubicle [dot] com
+      www.fourwalledcubicle.com
+*/
+
+/*
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this 
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in 
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting 
+  documentation, and that the name of the author not be used in 
+  advertising or publicity pertaining to distribution of the 
+  software without specific, written prior permission.
+
+  The author disclaim all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *  \brief USB host standard request management.
+ *
+ *  This file contains the function prototypes neccesary for the issuing of outgoing standard control requests
+ *  when the library is in USB host mode.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the USB driver
+ *        dispatch header located in LUFA/Drivers/USB/USB.h.
+ */
+
+#ifndef __HOSTCHAPTER9_H__
+#define __HOSTCHAPTER9_H__
+
+       /* Includes: */
+               #include <avr/io.h>
+               #include <stdbool.h>
+               
+               #include "LowLevel.h"
+               #include "../HighLevel/USBMode.h"
+               #include "../HighLevel/StdRequestType.h"
+
+       /* Enable C linkage for C++ Compilers: */
+               #if defined(__cplusplus)
+                       extern "C" {
+               #endif
+
+       /* Preprocessor Checks: */
+               #if !defined(__INCLUDE_FROM_USB_DRIVER)
+                       #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
+               #endif
+               
+       /* Public Interface - May be used in end-application: */
+               /* Enums: */
+                       /** Enum for the \ref USB_Host_SendControlRequest() return code, indicating the reason for the error
+                        *  if the transfer of the request is unsuccessful.
+                        *
+                        *  \ingroup Group_PipeControlReq
+                        */
+                       enum USB_Host_SendControlErrorCodes_t
+                       {
+                               HOST_SENDCONTROL_Successful         = 0, /**< No error occurred in the request transfer. */
+                               HOST_SENDCONTROL_DeviceDisconnected = 1, /**< The attached device was disconnected during the
+                                                                       *   request transfer.
+                                                                       */
+                               HOST_SENDCONTROL_PipeError          = 2, /**< An error occurred in the pipe while sending the request. */
+                               HOST_SENDCONTROL_SetupStalled       = 3, /**< The attached device stalled the request, usually
+                                                                       *   indicating that the request is unsupported on the device.
+                                                                       */
+                               HOST_SENDCONTROL_SoftwareTimeOut    = 4, /**< The request or data transfer timed out. */
+                       };
+                       
+               /* Function Prototypes: */
+                       /** Sends the request stored in the \ref USB_ControlRequest global structure to the attached device,
+                        *  and transfers the data stored in the buffer to the device, or from the device to the buffer
+                        *  as requested. The transfer is made on the currently selected pipe.
+                        *
+                        *  \ingroup Group_PipeControlReq
+                        *
+                        *  \param[in] BufferPtr  Pointer to the start of the data buffer if the request has a data stage, or
+                        *                        NULL if the request transfers no data to or from the device.
+                        *
+                        *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
+                        */
+                       uint8_t USB_Host_SendControlRequest(void* BufferPtr);
+                       
+       /* Private Interface - For use in library only: */
+       #if !defined(__DOXYGEN__)
+               /* Enums: */
+                       enum USB_WaitForTypes_t
+                       {
+                               USB_HOST_WAITFOR_SetupSent,
+                               USB_HOST_WAITFOR_InReceived,
+                               USB_HOST_WAITFOR_OutReady,
+                       };
+       
+               /* Function Prototypes: */
+                       #if defined(__INCLUDE_FROM_HOSTCHAPTER9_C)
+                               static uint8_t USB_Host_WaitForIOS(const uint8_t WaitType);
+                       #endif
+       #endif
+
+       /* Disable C linkage for C++ Compilers: */
+               #if defined(__cplusplus)
+                       }
+               #endif
+               
+#endif