3.4.4.30 USB_HOST_CDC_EVENT Enumeration

C

typedef enum {
  USB_HOST_CDC_EVENT_READ_COMPLETE,
  USB_HOST_CDC_EVENT_WRITE_COMPLETE,
  USB_HOST_CDC_EVENT_ACM_SEND_BREAK_COMPLETE,
  USB_HOST_CDC_EVENT_ACM_SET_CONTROL_LINE_STATE_COMPLETE,
  USB_HOST_CDC_EVENT_ACM_SET_LINE_CODING_COMPLETE,
  USB_HOST_CDC_EVENT_ACM_GET_LINE_CODING_COMPLETE,
  USB_HOST_CDC_EVENT_SERIAL_STATE_NOTIFICATION_RECEIVED,
  USB_HOST_CDC_EVENT_DEVICE_DETACHED
} USB_HOST_CDC_EVENT;

Summary

CDC Class Driver Events

This enumeration identifies the possible events that the CDC Class Driver can generate. The application should register an event handler using the USB_HOST_CDC_EventHandlerSet function to receive CDC Class Driver events.

An event may have data associated with it. Events that are generated due to a transfer of data between the host and device are accompanied by data structures that provide the status of the transfer termination. For example, the USB_HOST_CDC_EVENT_ACM_SET_LINE_CODING_COMPLETE event is accompanied by a pointer to a USB_HOST_CDC_EVENT_ACM_SET_LINE_CODING_COMPLETE_DATA data structure. The transferStatus member of this data structure indicates the success or failure of the transfer. A transfer may fail due to device not responding on the bus, if the device stalls any stages of the transfer or due to NAK timeouts. The event description provides details on the nature of the event and the data that is associated with the event.

Members