usb_host_cdc.h

Microchip Technology Inc.

File Name

usb_host_cdc.h

Description

USB Host CDC Client Driver Interface Definition

This header file contains the function prototypes and definitions of the data types and constants that make up the interface to the USB Host CDC Client Driver.

Enumerations

	Name	Description
	USB_HOST_CDC_EVENT	Identifies the possible events that the CDC Class Driver can generate.
	USB_HOST_CDC_EVENT_RESPONSE	Return type of the USB CDC Host Client Driver Event Handler.
	USB_HOST_CDC_RESULT	USB Host CDC Client Driver Result enumeration.

Functions

	Name	Description
	USB_HOST_CDC_ACM_ControlLineStateSet	This function sends a request to the attached device to set its Control Line State.
	USB_HOST_CDC_ACM_LineCodingSet	This function sends a request to the attached device to set its Line Coding.
	USB_HOST_CDC_AttachEventHandlerSet	This function will set an attach event handler.
	USB_HOST_CDC_Close	This function closes the CDC device.
	USB_HOST_CDC_DeviceObjHandleGet	This function returns the Device Object Handle for this CDC device.
	USB_HOST_CDC_EventHandlerSet	Registers an event handler with the CDC Host Client Driver.
	USB_HOST_CDC_Open	This function opens the specified CDC device.
	USB_HOST_CDC_Read	This function will read data from the attached device.
	USB_HOST_CDC_SerialStateNotificationGet	This function will request Serial State Notification from the attached device.
	USB_HOST_CDC_Write	This function will write data to the attached device.

Macros

	Name	Description
	USB_HOST_CDC_HANDLE_INVALID	Defines an Invalid CDC Client Driver Handle.
	USB_HOST_CDC_INTERFACE	USB HOST CDC Client Driver Interface
	USB_HOST_CDC_REQUEST_HANDLE_INVALID	USB Host CDC Client Driver Invalid Request Handle
	USB_HOST_CDC_TRANSFER_HANDLE_INVALID	USB Host CDC Client Driver Invalid Transfer Handle Definition.

Structures

	Name	Description
	USB_HOST_CDC_EVENT_ACM_GET_LINE_CODING_COMPLETE_DATA	USB Host CDC Client Driver Command Event Data.
	USB_HOST_CDC_EVENT_ACM_SEND_BREAK_COMPLETE_DATA	USB Host CDC Client Driver Command Event Data.
	USB_HOST_CDC_EVENT_ACM_SET_CONTROL_LINE_STATE_COMPLETE_DATA	USB Host CDC Client Driver Command Event Data.
	USB_HOST_CDC_EVENT_ACM_SET_LINE_CODING_COMPLETE_DATA	USB Host CDC Client Driver Command Event Data.
	USB_HOST_CDC_EVENT_READ_COMPLETE_DATA	USB Host CDC Client Driver Event Data.
	USB_HOST_CDC_EVENT_SERIAL_STATE_NOTIFICATION_RECEIVED_DATA	USB Host CDC Client Driver Event Data.
	USB_HOST_CDC_EVENT_WRITE_COMPLETE_DATA	USB Host CDC Client Driver Event Data.

Types

	Name	Description
	USB_HOST_CDC_ATTACH_EVENT_HANDLER	USB Host CDC Client Driver Attach Event Handler Function Pointer Type.
	USB_HOST_CDC_EVENT_HANDLER	USB Host CDC Client Driver Event Handler Function Pointer Type.
	USB_HOST_CDC_HANDLE	Defines the type of the CDC Host Client Driver Handle
	USB_HOST_CDC_OBJ	Defines the type of the CDC Host Client Object.
	USB_HOST_CDC_REQUEST_HANDLE	USB Host CDC Client Driver Request Handle
	USB_HOST_CDC_TRANSFER_HANDLE	USB Host CDC Client Driver Transfer Handle

USB Libraries Help > USB Host Libraries > USB Audio v1.0 Host Client Driver Library > Files > usb_host_cdc.h

MPLAB Harmony USB Stack

Contents | Home

Previous | Up | Next

Documentation Feedback
Microchip Support