Jump to main content

##

# 2.5.5.1 usb_device_cdc.h

## File Name

usb_device_cdc.h

## Description

USB Device CDC Function Driver Interface

This file describes the USB Device CDC Function Driver interface. The application should include this file if it needs to use the CDC Function Driver API.

## Enumerations

Name | Description
USB_DEVICE_CDC_EVENT | USB Device CDC Function Driver Events.
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.

## 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_SerialStateNotificationSend | This function schedules a request to send serial state notification to the host.
USB_DEVICE_CDC_Write | This function requests a data write to the USB Device CDC Function Driver Layer.

## Macros

Name | Description
USB_DEVICE_CDC_EVENT_RESPONSE_NONE | USB Device CDC Function Driver Event Handler Response Type None
USB_DEVICE_CDC_FUNCTION_DRIVER | USB Device CDC Function Driver Function pointer
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
USB_DEVICE_CDC_TRANSFER_HANDLE_INVALID | USB Device CDC Function Driver Invalid Transfer Handle Definition

## Structures

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_SEND_BREAK | USB Device CDC Function Driver Send Break 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

## Types

Name | Description
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_TRANSFER_HANDLE | USB Device CDC Function Driver Transfer Handle Definition