Jump to main content

##

# 2.5.4 Library Interface

This section describes the Application Programming Interface (API) functions of the USB CDC Device Library.

Refer to each section for a detailed description.

a) Functions

Name | Description
USB_DEVICE_CDC_EventHandlerSet | This function registers a event handler for the specified CDC function driver instance.
USB_DEVICE_CDC_Read | This function requests a data read from the USB Device CDC Function Driver Layer.
USB_DEVICE_CDC_Write | This function requests a data write to the USB Device CDC Function Driver Layer.
USB_DEVICE_CDC_SerialStateNotificationSend | This function schedules a request to send serial state notification to the host.

b) Data Types and Constants

Name | Description
USB_DEVICE_CDC_EVENT_DATA_READ_COMPLETE | USB Device CDC Function Driver Read and Write Complete Event Data.
USB_DEVICE_CDC_EVENT_DATA_SERIAL_STATE_NOTIFICATION_COMPLETE | USB Device CDC Function Driver Read and Write Complete Event Data.
USB_DEVICE_CDC_EVENT_DATA_WRITE_COMPLETE | USB Device CDC Function Driver Read and Write Complete Event Data.
USB_DEVICE_CDC_INIT | USB Device CDC Function Driver Initialization Data Structure.
USB_DEVICE_CDC_EVENT_DATA_SEND_BREAK | USB Device CDC Function Driver Send Break Event Data.
USB_DEVICE_CDC_EVENT | USB Device CDC Function Driver Events.
USB_DEVICE_CDC_EVENT_HANDLER | USB Device CDC Event Handler Function Pointer Type.
USB_DEVICE_CDC_EVENT_RESPONSE | USB Device CDC Function Driver Event Callback Response Type.
USB_DEVICE_CDC_INDEX | USB Device CDC Function Driver Index.
USB_DEVICE_CDC_RESULT | USB Device CDC Function Driver USB Device CDC Result enumeration.
USB_DEVICE_CDC_TRANSFER_FLAGS | USB Device CDC Function Driver Transfer Flags.
USB_DEVICE_CDC_TRANSFER_HANDLE | USB Device CDC Function Driver Transfer Handle Definition.
USB_DEVICE_CDC_EVENT_RESPONSE_NONE | USB Device CDC Function Driver Event Handler Response Type None.
USB_DEVICE_CDC_TRANSFER_HANDLE_INVALID | USB Device CDC Function Driver Invalid Transfer Handle Definition.
USB_DEVICE_CDC_FUNCTION_DRIVER | USB Device CDC Function Driver Function pointer.
USB_CDC_LINESTATE_CARRIER | Bit code information in line state.
USB_CDC_LINESTATE_DTR | Bit code information in line state.
USB_CDC_DESCRIPTOR_TYPE | Identifies the descriptor types in the CDC.
USB_CDC_INF_PROTOCOL | Identifies the protocol codes.
USB_CDC_INTERFACE_TYPE | Identifies the CDC interface type.
USB_CDC_NOTIFICATION | Identifies the notification codes available for CDC.
USB_CDC_REQUEST | Identifies the CDC specific request codes.
USB_CDC_FUNCTIONAL_DESCRIPTOR | Identifies the CDC function header type.
USB_CDC_SUBCLASS | Identifies the subclass codes for communication interface.
USB_CDC_UNION_FUNCTIONAL_DESCRIPTOR_SUBORDINATE | This is type USB_CDC_UNION_FUNCTIONAL_DESCRIPTOR_SUBORDINATE.
CS_INTERFACE | This is macro CS_INTERFACE.
USB_CDC_ACM_SUPPORT_BREAK | This is macro USB_CDC_ACM_SUPPORT_BREAK.
USB_CDC_ACM_SUPPORT_COMM_FEATURE | This is macro USB_CDC_ACM_SUPPORT_COMM_FEATURE.
USB_CDC_ACM_SUPPORT_LINE_CODING_LINE_STATE_AND_NOTIFICATION | This is macro USB_CDC_ACM_SUPPORT_LINE_CODING_LINE_STATE_AND_NOTIFICATION.
USB_CDC_ACM_SUPPORT_NETWORK_NOTIFICATION | This is macro USB_CDC_ACM_SUPPORT_NETWORK_NOTIFICATION.
USB_CDC_ACM_SUPPORT_NONE | Identifies the CDC ACM sub-class capabilities.
USB_CDC_CLASS_CODE | Identifies the CDC Interface Class, Subclass and protocol constants.
USB_CDC_COMMUNICATIONS_INTERFACE_CLASS_CODE | This is macro USB_CDC_COMMUNICATIONS_INTERFACE_CLASS_CODE.
USB_CDC_DATA_INTERFACE_CLASS_CODE | This is macro USB_CDC_DATA_INTERFACE_CLASS_CODE.
USB_CDC_DATA_INTERFACE_PROTOCOL | This is macro USB_CDC_DATA_INTERFACE_PROTOCOL.
USB_CDC_DATA_INTERFACE_SUBCLASS_CODE | This is macro USB_CDC_DATA_INTERFACE_SUBCLASS_CODE.
USB_CDC_REQUEST_CLASS_SPECIFIC | CDC specific request.
USB_CDC_SUBCLASS_CODE | This is macro USB_CDC_SUBCLASS_CODE.
USB_DEVICE_CDC_INDEX_0 | Use this to specify CDC Function Driver Instance 0.
USB_DEVICE_CDC_INDEX_1 | Use this to specify CDC Function Driver Instance 1.
USB_DEVICE_CDC_INDEX_2 | Use this to specify CDC Function Driver Instance 2.
USB_DEVICE_CDC_INDEX_3 | Use this to specify CDC Function Driver Instance 3.
USB_DEVICE_CDC_INDEX_4 | Use this to specify CDC Function Driver Instance 4.
USB_DEVICE_CDC_INDEX_5 | Use this to specify CDC Function Driver Instance 5.
USB_DEVICE_CDC_INDEX_6 | Use this to specify CDC Function Driver Instance 6.
USB_DEVICE_CDC_INDEX_7 | Use this to specify CDC Function Driver Instance 7.