-/*\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 Host mode driver for the library USB CDC Class driver.\r
- *\r
- * Host mode driver for the library USB CDC Class driver.\r
- *\r
- * \note This file should not be included directly. It is automatically included as needed by the class driver\r
- * dispatch header located in LUFA/Drivers/USB/Class/CDC.h.\r
- */\r
-\r
-/** \ingroup Group_USBClassCDC\r
- * @defgroup Group_USBClassCDCHost CDC Class Host Mode Driver\r
- *\r
- * \section Sec_Dependencies Module Source Dependencies\r
- * The following files must be built with any user project that uses this module:\r
- * - LUFA/Drivers/USB/Class/Host/CDC.c\r
- *\r
- * \section Module Description\r
- * Host Mode USB Class driver framework interface, for the CDC USB Class driver.\r
- *\r
- * @{\r
- */\r
-\r
-#ifndef __CDC_CLASS_HOST_H__\r
-#define __CDC_CLASS_HOST_H__\r
-\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
- extern "C" {\r
- #endif\r
-\r
- /* Preprocessor Checks: */\r
- #if !defined(__INCLUDE_FROM_CDC_DRIVER)\r
- #error Do not include this file directly. Include LUFA/Drivers/Class/CDC.h instead.\r
- #endif\r
-\r
- /* Public Interface - May be used in end-application: */\r
- /* Type Defines: */\r
- /** \brief CDC Class Host Mode Configuration and State Structure.\r
- *\r
- * Class state structure. An instance of this structure should be made within the user application,\r
- * and passed to each of the CDC class driver functions as the CDCInterfaceInfo parameter. This\r
- * stores each CDC interface's configuration and state information.\r
- */\r
- typedef struct\r
- {\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
- 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
- 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
- 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
- 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
- * masks - to notify the device of changes to these values, call the\r
- * \ref CDC_Host_SendControlLineStateChange() function.\r
- */\r
- uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_*\r
- * masks. This value is updated each time \ref CDC_Host_USBTask() is called.\r
- */\r
- } ControlLineStates; /**< Current states of the virtual serial port's control lines between the device and host. */\r
- \r
- struct\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
- */\r
- uint8_t ParityType; /**< Parity setting of the virtual serial port, a value from the\r
- * CDCDevice_LineCodingParity_t enum\r
- */\r
- uint8_t DataBits; /**< Bits of data per character of the virtual serial port */\r
- } LineEncoding; /** Line encoding used in the virtual serial port, for the device's information. This is generally\r
- * only used if the virtual serial port data is to be reconstructed on a physical UART. When set\r
- * by the host application, the \ref CDC_Host_SetLineEncoding() function must be called to push\r
- * the changes to the device.\r
- */\r
- } State; /**< State data for the USB class interface within the device. All elements in this section\r
- * <b>may</b> be set to initial values, but may also be ignored to default to sane values when\r
- * the interface is enumerated.\r
- */\r
- } USB_ClassInfo_CDC_Host_t;\r
- \r
- /* Enums: */\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
- \r
- /* Function Prototypes: */\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
- /** Sends a Send Break request to the device. This is generally used to seperate data data or to indicate a special condition\r
- * to the receiving device.\r
- *\r
- * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state\r
- * \param[in] Duration Duration of the break, in milliseconds\r
- *\r
- * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum\r
- */\r
- uint8_t CDC_Host_SendBreak(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, const uint8_t Duration) ATTR_NON_NULL_PTR_ARG(1);\r
- \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
- /** 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
- /* Macros: */\r
- #define CDC_CONTROL_CLASS 0x02\r
- #define CDC_CONTROL_SUBCLASS 0x02\r
- #define CDC_CONTROL_PROTOCOL 0x01\r
- #define CDC_DATA_CLASS 0x0A\r
- #define CDC_DATA_SUBCLASS 0x00\r
- #define CDC_DATA_PROTOCOL 0x00\r
- \r
- #define CDC_FOUND_DATAPIPE_IN (1 << 0)\r
- #define CDC_FOUND_DATAPIPE_OUT (1 << 1)\r
- #define CDC_FOUND_NOTIFICATION_IN (1 << 2)\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 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
- /* Disable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\r
- }\r
- #endif\r
-\r
-#endif\r
-\r
-/** @} */\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 Host mode driver for the library USB CDC Class driver.
+ *
+ * Host mode driver for the library USB CDC Class driver.
+ *
+ * \note This file should not be included directly. It is automatically included as needed by the class driver
+ * dispatch header located in LUFA/Drivers/USB/Class/CDC.h.
+ */
+
+/** \ingroup Group_USBClassCDC
+ * @defgroup Group_USBClassCDCHost CDC Class Host Mode Driver
+ *
+ * \section Sec_Dependencies Module Source Dependencies
+ * The following files must be built with any user project that uses this module:
+ * - LUFA/Drivers/USB/Class/Host/CDC.c
+ *
+ * \section Module Description
+ * Host Mode USB Class driver framework interface, for the CDC USB Class driver.
+ *
+ * @{
+ */
+
+#ifndef __CDC_CLASS_HOST_H__
+#define __CDC_CLASS_HOST_H__
+
+ /* Includes: */
+ #include "../../USB.h"
+ #include "../Common/CDC.h"
+
+ #include <stdio.h>
+ #include <string.h>
+
+ /* Enable C linkage for C++ Compilers: */
+ #if defined(__cplusplus)
+ extern "C" {
+ #endif
+
+ /* Preprocessor Checks: */
+ #if !defined(__INCLUDE_FROM_CDC_DRIVER)
+ #error Do not include this file directly. Include LUFA/Drivers/Class/CDC.h instead.
+ #endif
+
+ /* Public Interface - May be used in end-application: */
+ /* Type Defines: */
+ /** \brief CDC Class Host Mode Configuration and State Structure.
+ *
+ * Class state structure. An instance of this structure should be made within the user application,
+ * and passed to each of the CDC class driver functions as the CDCInterfaceInfo parameter. This
+ * stores each CDC interface's configuration and state information.
+ */
+ typedef struct
+ {
+ const struct
+ {
+ uint8_t DataINPipeNumber; /**< Pipe number of the CDC interface's IN data pipe */
+ bool DataINPipeDoubleBank; /** Indicates if the CDC interface's IN data pipe should use double banking */
+
+ uint8_t DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe */
+ bool DataOUTPipeDoubleBank; /** Indicates if the CDC interface's OUT data pipe should use double banking */
+
+ uint8_t NotificationPipeNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used */
+ bool NotificationPipeDoubleBank; /** Indicates if the CDC interface's notification pipe should use double banking */
+ } Config; /**< Config data for the USB class interface within the device. All elements in this section
+ * <b>must</b> be set or the interface will fail to enumerate and operate correctly.
+ */
+ struct
+ {
+ bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
+ * after \ref CDC_Host_ConfigurePipes() is called and the Host state machine is in the
+ * Configured state
+ */
+ uint8_t ControlInterfaceNumber; /**< Interface index of the CDC-ACM control interface within the attached device */
+
+ uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */
+ uint16_t DataOUTPipeSize; /**< Size in bytes of the CDC interface's OUT data pipe */
+ uint16_t NotificationPipeSize; /**< Size in bytes of the CDC interface's IN notification pipe, if used */
+
+ struct
+ {
+ uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_*
+ * masks - to notify the device of changes to these values, call the
+ * \ref CDC_Host_SendControlLineStateChange() function.
+ */
+ uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_*
+ * masks. This value is updated each time \ref CDC_Host_USBTask() is called.
+ */
+ } ControlLineStates; /**< Current states of the virtual serial port's control lines between the device and host. */
+
+ struct
+ {
+ uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */
+ uint8_t CharFormat; /**< Character format of the virtual serial port, a value from the
+ * CDCDevice_CDC_LineCodingFormats_t enum
+ */
+ uint8_t ParityType; /**< Parity setting of the virtual serial port, a value from the
+ * CDCDevice_LineCodingParity_t enum
+ */
+ uint8_t DataBits; /**< Bits of data per character of the virtual serial port */
+ } LineEncoding; /** Line encoding used in the virtual serial port, for the device's information. This is generally
+ * only used if the virtual serial port data is to be reconstructed on a physical UART. When set
+ * by the host application, the \ref CDC_Host_SetLineEncoding() function must be called to push
+ * the changes to the device.
+ */
+ } State; /**< State data for the USB class interface within the device. All elements in this section
+ * <b>may</b> be set to initial values, but may also be ignored to default to sane values when
+ * the interface is enumerated.
+ */
+ } USB_ClassInfo_CDC_Host_t;
+
+ /* Enums: */
+ /** Enum for the possible error codes returned by the \ref CDC_Host_ConfigurePipes() function. */
+ enum CDCHost_EnumerationFailure_ErrorCodes_t
+ {
+ CDC_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully */
+ CDC_ENUMERROR_InvalidConfigDescriptor = 1, /**< The device returned an invalid Configuration Descriptor */
+ CDC_ENUMERROR_NoCDCInterfaceFound = 2, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */
+ CDC_ENUMERROR_EndpointsNotFound = 3, /**< Compatible CDC endpoints were not found in the device's CDC interface */
+ };
+
+ /* Function Prototypes: */
+ /** General management task for a given CDC host class interface, required for the correct operation of the interface. This should
+ * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
+ *
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing an CDC Class host configuration and state
+ */
+ void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** Host interface configuration routine, to configure a given CDC host interface instance using the Configuration
+ * Descriptor read from an attached USB device. This function automatically updates the given CDC Host instance's
+ * state values and configures the pipes required to communicate with the interface if it is found within the device.
+ * This should be called once after the stack has enumerated the attached device, while the host state machine is in
+ * the Addressed state.
+ *
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing an CDC Class host configuration and state
+ * \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor
+ * \param[in] DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor
+ *
+ * \return A value from the \ref CDCHost_EnumerationFailure_ErrorCodes_t enum
+ */
+ uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, uint16_t ConfigDescriptorSize,
+ void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
+
+ /** Sets the line encoding for the attached device's virtual serial port. This should be called when the LineEncoding
+ * values of the interface have been changed to push the new settings to the USB device.
+ *
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
+ *
+ * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
+ */
+ uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** Sends a Serial Control Line State Change notification to the device. This should be called when the virtual serial
+ * control lines (DTR, RTS, etc.) have changed states. Line states persist until they are cleared via a second
+ * notification. This should be called each time the CDC class driver's ControlLineStates.HostToDevice value is updated
+ * to push the new states to the USB device.
+ *
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
+ *
+ * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
+ */
+ uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** Sends a Send Break request to the device. This is generally used to seperate data data or to indicate a special condition
+ * to the receiving device.
+ *
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
+ * \param[in] Duration Duration of the break, in milliseconds
+ *
+ * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
+ */
+ uint8_t CDC_Host_SendBreak(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, const uint8_t Duration) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** Sends a given string to the attached USB device, if connected. If a device is not connected when the function is called, the
+ * string is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the
+ * \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
+ * packed into a single pipe packet, increasing data throughput.
+ *
+ * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
+ * call will fail.
+ *
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
+ * \param[in] Data Pointer to the string to send to the device
+ * \param[in] Length Size in bytes of the string to send to the device
+ *
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
+ */
+ uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, char* Data, const uint16_t Length)
+ ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
+
+ /** Sends a given byte to the attached USB device, if connected. If a device is not connected when the function is called, the
+ * byte is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the
+ * \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
+ * packed into a single pipe packet, increasing data throughput.
+ *
+ * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
+ * call will fail.
+ *
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
+ * \param[in] Data Byte of data to send to the device
+ *
+ * \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum
+ */
+ uint8_t CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** Determines the number of bytes received by the CDC interface from the device, waiting to be read.
+ *
+ * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
+ * call will fail.
+ *
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
+ *
+ * \return Total number of buffered bytes received from the device
+ */
+ uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** 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
+ * returns 0. The \ref CDC_Host_BytesReceived() function should be queried before data is received to ensure that no data
+ * underflow occurs.
+ *
+ * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
+ * call will fail.
+ *
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
+ *
+ * \return Next received byte from the device, or 0 if no data received
+ */
+ uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.
+ *
+ * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
+ * call will fail.
+ *
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
+ *
+ * \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum
+ */
+ uint8_t CDC_Host_Flush(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** Creates a standard characer stream for the given CDC Device instance so that it can be used with all the regular
+ * functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created
+ * stream is bidirectional and can be used for both input and output functions.
+ *
+ * \note The created stream can be given as stdout if desired to direct the standard output from all <stdio.h> functions
+ * to the given CDC interface.
+ *
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
+ * \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed
+ */
+ void CDC_Host_CreateStream(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, FILE* Stream);
+
+ /** Identical to CDC_Host_CreateStream(), except that reads are blocking until the calling stream function terminates
+ * the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
+ *
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
+ * \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed
+ */
+ void CDC_Host_CreateBlockingStream(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, FILE* Stream);
+
+ /** CDC class driver event for a control line state change on a CDC host interface. This event fires each time the device notifies
+ * the host of a control line state change (containing the virtual serial control line states, such as DCD) and may be hooked in the
+ * user program by declaring a handler function with the same name and parameters listed here. The new control line states
+ * are available in the ControlLineStates.DeviceToHost value inside the CDC host interface structure passed as a parameter, set as
+ * a mask of CDC_CONTROL_LINE_IN_* masks.
+ *
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
+ */
+ void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
+
+ /* Private Interface - For use in library only: */
+ #if !defined(__DOXYGEN__)
+ /* Macros: */
+ #define CDC_CONTROL_CLASS 0x02
+ #define CDC_CONTROL_SUBCLASS 0x02
+ #define CDC_CONTROL_PROTOCOL 0x01
+ #define CDC_DATA_CLASS 0x0A
+ #define CDC_DATA_SUBCLASS 0x00
+ #define CDC_DATA_PROTOCOL 0x00
+
+ #define CDC_FOUND_DATAPIPE_IN (1 << 0)
+ #define CDC_FOUND_DATAPIPE_OUT (1 << 1)
+ #define CDC_FOUND_NOTIFICATION_IN (1 << 2)
+
+ /* Function Prototypes: */
+ #if defined(__INCLUDE_FROM_CDC_CLASS_HOST_C)
+ static int CDC_Host_putchar(char c, FILE* Stream);
+ static int CDC_Host_getchar(FILE* Stream);
+ static int CDC_Host_getchar_Blocking(FILE* Stream);
+
+ void CDC_Host_Event_Stub(void);
+ void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo)
+ ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Host_Event_Stub);
+ static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
+ static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
+ static uint8_t DComp_CDC_Host_NextCDCInterfaceEndpoint(void* const CurrentDescriptor);
+ #endif
+ #endif
+
+ /* Disable C linkage for C++ Compilers: */
+ #if defined(__cplusplus)
+ }
+ #endif
+
+#endif
+
+/** @} */
projects / pub / USBasp.git / blobdiff