Add FatFS library to the Webserver project, extend the HTTP server so that it now...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / CDC.h

diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h
index 79df489..466f141 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/CDC.h
+++ b/LUFA/Drivers/USB/Class/Host/CDC.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\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
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r

-  Copyright 2009  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
+  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 without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -47,6 +47,9 @@
        /* Includes: */\r
                #include "../../USB.h"\r
                #include "../Common/CDC.h"\r
        /* Includes: */\r
                #include "../../USB.h"\r
                #include "../Common/CDC.h"\r

+\r
+               #include <stdio.h>\r
+               #include <string.h>\r

                \r
        /* Enable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                \r
        /* Enable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r


@@ -64,21 +67,28 @@
                                const struct\r
                                {\r
                                        uint8_t  DataINPipeNumber; /**< Pipe number of the CDC interface's IN data pipe */\r
                                const struct\r
                                {\r
                                        uint8_t  DataINPipeNumber; /**< Pipe number of the CDC interface's IN data pipe */\r

+                                       bool     DataINPipeDoubleBank; /** Indicates if the CDC interface's IN data pipe should use double banking */\r
+\r

                                        uint8_t  DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe */\r
                                        uint8_t  DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe */\r

+                                       bool     DataOUTPipeDoubleBank; /** Indicates if the CDC interface's OUT data pipe should use double banking */\r
+\r

                                        uint8_t  NotificationPipeNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used */                   \r
                                        uint8_t  NotificationPipeNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used */                   \r

+                                       bool     NotificationPipeDoubleBank; /** Indicates if the CDC interface's notification pipe should use double banking */\r

                                } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
                                           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
                                           */\r
                                struct\r
                                {\r
                                } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
                                           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
                                           */\r
                                struct\r
                                {\r

-                                       bool Active; /**< Indicates if the current interface instance is connected to an attached device */\r
-                                       \r
+                                       bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid\r
+                                                       *   after \ref CDC_Host_ConfigurePipes() is called and the Host state machine is in the\r
+                                                       *   Configured state\r
+                                                       */\r

                                        uint8_t ControlInterfaceNumber; /**< Interface index of the CDC-ACM control interface within the attached device */\r
                                \r
                                        uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */\r
                                        uint16_t DataOUTPipeSize;  /**< Size in bytes of the CDC interface's OUT data pipe */\r
                                        uint8_t ControlInterfaceNumber; /**< Interface index of the CDC-ACM control interface within the attached device */\r
                                \r
                                        uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */\r
                                        uint16_t DataOUTPipeSize;  /**< Size in bytes of the CDC interface's OUT data pipe */\r

-                                       uint16_t NotificationPipeSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used */\r
-\r
+                                       uint16_t NotificationPipeSize;  /**< Size in bytes of the CDC interface's IN notification pipe, if used */\r
+                                       \r

                                        struct\r
                                        {\r
                                                uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_*\r
                                        struct\r
                                        {\r
                                                uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_*\r


@@ -91,8 +101,6 @@
                                        \r
                                        struct\r
                                        {\r
                                        \r
                                        struct\r
                                        {\r

-                                               bool Active; /**< Indicates if the interface is currently active, i.e. attached to the connected device */\r
-                                       \r

                                                uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */\r
                                                uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the\r
                                                                                          *   CDCDevice_CDC_LineCodingFormats_t enum\r
                                                uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */\r
                                                uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the\r
                                                                                          *   CDCDevice_CDC_LineCodingFormats_t enum\r


@@ -109,26 +117,154 @@
                        } USB_ClassInfo_CDC_Host_t;\r
                        \r
                /* Enums: */\r
                        } USB_ClassInfo_CDC_Host_t;\r
                        \r
                /* Enums: */\r

-                       enum\r
+                       /** Enum for the possible error codes returned by the \ref CDC_Host_ConfigurePipes() function. */\r
+                       enum CDCHost_EnumerationFailure_ErrorCodes_t\r

                        {\r
                                CDC_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */\r
                                CDC_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */\r
                                CDC_ENUMERROR_NoCDCInterfaceFound        = 2, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */\r
                                CDC_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible CDC endpoints were not found in the device's CDC interface */\r
                        {\r
                                CDC_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */\r
                                CDC_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */\r
                                CDC_ENUMERROR_NoCDCInterfaceFound        = 2, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */\r
                                CDC_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible CDC endpoints were not found in the device's CDC interface */\r

-                       } CDCHost_EnumerationFailure_ErrorCodes_t;\r
+                       };\r

        \r
                /* Function Prototypes: */\r
        \r
                /* Function Prototypes: */\r

-                       void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\r
-                       uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint16_t ConfigDescriptorLength,\r
-                                                       uint8_t* DeviceConfigDescriptor);\r
+                       /** General management task for a given CDC host class interface, required for the correct operation of the interface. This should\r
+                        *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing an CDC Class host configuration and state\r
+                        */\r
+                       void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+                       \r
+                       /** Host interface configuration routine, to configure a given CDC host interface instance using the Configuration\r
+                        *  Descriptor read from an attached USB device. This function automatically updates the given CDC Host instance's\r
+                        *  state values and configures the pipes required to communicate with the interface if it is found within the device.\r
+                        *  This should be called once after the stack has enumerated the attached device, while the host state machine is in\r
+                        *  the Addressed state.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing an CDC Class host configuration and state\r
+                        *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor\r
+                        *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor\r
+                        *\r
+                        *  \return A value from the \ref CDCHost_EnumerationFailure_ErrorCodes_t enum\r
+                        */\r
+                       uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, uint16_t ConfigDescriptorSize,\r
+                                                       void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);\r
+                       \r
+                       /** Sets the line encoding for the attached device's virtual serial port. This should be called when the LineEncoding\r
+                        *  values of the interface have been changed to push the new settings to the USB device.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state\r
+                        *\r
+                        *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum\r
+                        */\r
+                       uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+                       /** Sends a Serial Control Line State Change notification to the device. This should be called when the virtual serial\r
+                        *  control lines (DTR, RTS, etc.) have changed states. Line states persist until they are cleared via a second\r
+                        *  notification. This should be called each time the CDC class driver's ControlLineStates.HostToDevice value is updated\r
+                        *  to push the new states to the USB device.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state\r
+                        *\r
+                        *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum\r
+                        */\r
+                       uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

                        \r
                        \r

-                       uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\r
-                       uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\r
+                       /** Sends a given string to the attached USB device, if connected. If a device is not connected when the function is called, the\r
+                        *  string is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the\r
+                        *  \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be \r
+                        *  packed into a single pipe packet, increasing data throughput.\r
+                        *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state\r
+                        *  \param[in] Data  Pointer to the string to send to the device\r
+                        *  \param[in] Length  Size in bytes of the string to send to the device\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum\r
+                        */\r
+                       uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, char* Data, const uint16_t Length)\r
+                                                   ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
+                       \r
+                       /** Sends a given byte to the attached USB device, if connected. If a device is not connected when the function is called, the\r
+                        *  byte is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the\r
+                        *  \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be \r
+                        *  packed into a single pipe packet, increasing data throughput.\r
+                        *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state\r
+                        *  \param[in] Data  Byte of data to send to the device\r
+                        *\r
+                        *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum\r
+                        */\r
+                       uint8_t CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+                       /** Determines the number of bytes received by the CDC interface from the device, waiting to be read.\r
+                        *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state\r
+                        *\r
+                        *  \return Total number of buffered bytes received from the device\r
+                        */\r
+                       uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+                       /** Reads a byte of data from the device. If no data is waiting to be read of if a USB device is not connected, the function\r
+                        *  returns 0. The \ref CDC_Host_BytesReceived() function should be queried before data is received to ensure that no data\r
+                        *  underflow occurs.\r
+                        *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state\r
+                        *\r
+                        *  \return Next received byte from the device, or 0 if no data received\r
+                        */\r
+                       uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

                        \r
                        \r

-                       void CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, char* Data, uint16_t Length);\r
-                       void CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint8_t Data);\r
-                       uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\r
-                       uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\r
+                       /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.\r
+                        *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state\r
+                        *\r
+                        *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum\r
+                        */\r
+                       uint8_t CDC_Host_Flush(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+                       /** Creates a standard characer stream for the given CDC Device instance so that it can be used with all the regular\r
+                        *  functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created\r
+                        *  stream is bidirectional and can be used for both input and output functions.\r
+                        *\r
+                        *  \note The created stream can be given as stdout if desired to direct the standard output from all <stdio.h> functions\r
+                        *        to the given CDC interface.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        *  \param[in,out] Stream  Pointer to a FILE structure where the created stream should be placed\r
+                        */\r
+                       void CDC_Host_CreateStream(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, FILE* Stream);\r
+\r
+                       /** Identical to CDC_Host_CreateStream(), except that reads are blocking until the calling stream function terminates\r
+                        *  the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        *  \param[in,out] Stream  Pointer to a FILE structure where the created stream should be placed\r
+                        */\r
+                       void CDC_Host_CreateBlockingStream(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, FILE* Stream);\r
+\r
+                       /** CDC class driver event for a control line state change on a CDC host interface. This event fires each time the device notifies\r
+                        *  the host of a control line state change (containing the virtual serial control line states, such as DCD) and may be hooked in the\r
+                        *  user program by declaring a handler function with the same name and parameters listed here. The new control line states\r
+                        *  are available in the ControlLineStates.DeviceToHost value inside the CDC host interface structure passed as a parameter, set as\r
+                        *  a mask of CDC_CONTROL_LINE_IN_* masks.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state\r
+                        */\r
+                       void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

 \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
 \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r


@@ -142,16 +278,20 @@
                        \r
                        #define CDC_FOUND_DATAPIPE_IN           (1 << 0)\r
                        #define CDC_FOUND_DATAPIPE_OUT          (1 << 1)\r
                        \r
                        #define CDC_FOUND_DATAPIPE_IN           (1 << 0)\r
                        #define CDC_FOUND_DATAPIPE_OUT          (1 << 1)\r

-                       #define CDC_FOUND_DATAPIPE_NOTIFICATION (1 << 2)\r
+                       #define CDC_FOUND_NOTIFICATION_IN       (1 << 2)\r

 \r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)\r
 \r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)\r

+                               static int CDC_Host_putchar(char c, FILE* Stream);\r
+                               static int CDC_Host_getchar(FILE* Stream);\r
+                               static int CDC_Host_getchar_Blocking(FILE* Stream);\r
+\r

                                void CDC_Host_Event_Stub(void);\r
                                void CDC_Host_Event_Stub(void);\r

-                               void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo)\r
-                                                                          ATTR_WEAK ATTR_ALIAS(CDC_Host_Event_Stub);\r
-                               static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor);\r
-                               static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor);\r
-                               static uint8_t DComp_CDC_Host_NextInterfaceCDCDataEndpoint(void* CurrentDescriptor);\r
+                               void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo)\r
+                                                                          ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Host_Event_Stub);\r
+                               static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
+                               static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
+                               static uint8_t DComp_CDC_Host_NextCDCInterfaceEndpoint(void* const CurrentDescriptor);\r

                        #endif  \r
        #endif\r
                                \r
                        #endif  \r
        #endif\r
                                \r