+ /* Function Prototypes: */ \r
+ /** Configures the endpoints of a given CDC interface, ready for use. This should be linked to the library\r
+ * \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing\r
+ * the given CDC interface is selected.\r
+ *\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
+ *\r
+ * \return Boolean true if the endpoints were successfully configured, false otherwise\r
+ */\r
+ bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+ /** Processes incoming control requests from the host, that are directed to the given CDC class interface. This should be\r
+ * linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.\r
+ *\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
+ */\r
+ void CDC_Device_ProcessControlRequest(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+ /** General management task for a given CDC 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 a CDC Class configuration and state\r
+ */\r
+ void CDC_Device_USBTask(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+ /** CDC class driver event for a line encoding change on a CDC interface. This event fires each time the host requests a\r
+ * line encoding change (containing the serial parity, baud and other configuration information) and may be hooked in the\r
+ * user program by declaring a handler function with the same name and parameters listed here. The new line encoding\r
+ * settings are available in the LineEncoding structure inside the CDC interface structure passed as a parameter.\r
+ *\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
+ */\r
+ void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+ \r
+ /** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a\r
+ * control line state change (containing the virtual serial control line states, such as DTR) 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.HostToDevice value inside the CDC interface structure passed as a parameter, set as\r
+ * a mask of CDC_CONTROL_LINE_OUT_* masks.\r
+ *\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
+ */\r
+ void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+ /** Sends a given string to the attached USB host, if connected. If a host is not connected when the function is called, the\r
+ * string is discarded. Bytes will be queued for transmission to the host until either the endpoint bank becomes full, or the\r
+ * \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be \r
+ * packed into a single endpoint packet, increasing data throughput.\r
+ *\r
+ * \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or\r
+ * the call will fail.\r
+ *\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
+ * \param[in] Data Pointer to the string to send to the host\r
+ * \param[in] Length Size in bytes of the string to send to the host\r
+ *\r
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum\r
+ */\r
+ uint8_t CDC_Device_SendString(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo, char* const 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 host, if connected. If a host is not connected when the function is called, the\r
+ * byte is discarded. Bytes will be queued for transmission to the host until either the endpoint bank becomes full, or the\r
+ * \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be \r
+ * packed into a single endpoint packet, increasing data throughput.\r
+ *\r
+ * \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or\r
+ * the call will fail.\r
+ *\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
+ * \param[in] Data Byte of data to send to the host\r
+ *\r
+ * \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum\r
+ */\r
+ uint8_t CDC_Device_SendByte(USB_ClassInfo_CDC_Device_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 host, waiting to be read.\r
+ *\r
+ * \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or\r
+ * the call will fail.\r
+ *\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
+ *\r
+ * \return Total number of buffered bytes received from the host\r
+ */\r
+ uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+ \r
+ /** Reads a byte of data from the host. If no data is waiting to be read of if a USB host is not connected, the function\r
+ * returns 0. The \ref CDC_Device_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 Device state machine is in the DEVICE_STATE_Configured state or\r
+ * the call will fail.\r
+ *\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
+ *\r
+ * \return Next received byte from the host, or 0 if no data received\r
+ */\r
+ uint8_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_Device_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 Device state machine is in the DEVICE_STATE_Configured state or\r
+ * the call will fail.\r
+ *\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
+ *\r
+ * \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum\r
+ */\r
+ uint8_t CDC_Device_Flush(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+ \r
+ /** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial\r
+ * control lines (DCD, DSR, etc.) have changed states, or to give BREAK notifications to the host. Line states persist\r
+ * until they are cleared via a second notification. This should be called each time the CDC class driver's \r
+ * ControlLineStates.DeviceToHost value is updated to push the new states to the USB host.\r
+ *\r
+ * \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or\r
+ * the call will fail.\r
+ *\r
+ * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state\r
+ */\r
+ void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_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
+ * Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single\r
+ * fetch, as the endpoint will not be ready at some point in the transmission, aborting the transfer. However, this may\r
+ * be used when the read data is processed byte-per-bye (via getc()) or when the user application will implement its own\r
+ * line buffering.\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_Device_CreateStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream);\r
+\r
+ /** Identical to CDC_Device_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_Device_CreateBlockingStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream);\r
+\r
+ /* Private Interface - For use in library only: */\r
+ #if !defined(__DOXYGEN__)\r
+ /* Function Prototypes: */\r
+ #if defined(__INCLUDE_FROM_CDC_CLASS_DEVICE_C)\r
+ static int CDC_Device_putchar(char c, FILE* Stream);\r
+ static int CDC_Device_getchar(FILE* Stream);\r
+ static int CDC_Device_getchar_Blocking(FILE* Stream);\r
+ \r
+ void CDC_Device_Event_Stub(void);\r
+ void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)\r
+ ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);\r
+ void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)\r
+ ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);\r
+ #endif\r
+\r
+ #endif\r
projects / pub / USBasp.git / blobdiff