USB Device CDC API#

sl_usbd_cdc_async_function_t#

typedef void(* sl_usbd_cdc_async_function_t) (uint8_t class_nbr, void *p_buf, uint32_t buf_len, uint32_t xfer_len, void *p_callback_arg, sl_status_t status) )(uint8_t class_nbr, void *p_buf, uint32_t buf_len, uint32_t xfer_len, void *p_callback_arg, sl_status_t status)

Async comm callback.

sl_usbd_cdc_init#

sl_status_t sl_usbd_cdc_init (void )

FUNCTION PROTOTYPES.

CDC FUNCTIONS

Initializes CDC class.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_cdc_create_instance#

sl_status_t sl_usbd_cdc_create_instance (uint8_t subclass, sl_usbd_cdc_subclass_driver_t * p_subclass_drv, void * p_subclass_arg, uint8_t protocol, bool notify_en, uint16_t notify_interval, uint8_t * p_class_nbr)

Add a new instance of the CDC class.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) Communication class subclass codes are defined in 'sl_usbd_class_cdc.h' 'SL_USBD_CDC_SUBCLASS_XXXX'.

sl_usbd_cdc_add_to_configuration#

sl_status_t sl_usbd_cdc_add_to_configuration (uint8_t class_nbr, uint8_t config_nbr)

Add a CDC instance into the USB device configuration.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_cdc_is_enabled#

sl_status_t sl_usbd_cdc_is_enabled (uint8_t class_nbr, bool * p_enabled)

Get the CDC class enable state.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_cdc_add_data_interface#

sl_status_t sl_usbd_cdc_add_data_interface (uint8_t class_nbr, bool isoc_en, uint8_t protocol, uint8_t * p_if_nbr)

Add a data interface class to the CDC communication interface class.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) The value of 'isoc_en' must be false. Isochronous EPs are not supported.

sl_usbd_cdc_read_data#

sl_status_t sl_usbd_cdc_read_data (uint8_t class_nbr, uint8_t data_if_nbr, uint8_t * p_buf, uint32_t buf_len, uint16_t timeout, uint32_t * p_xfer_len)

Receive data on the CDC data interface.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_cdc_read_data_async#

sl_status_t sl_usbd_cdc_read_data_async (uint8_t class_nbr, uint8_t data_if_nbr, uint8_t * p_buf, uint32_t buf_len, sl_usbd_cdc_async_function_t async_fnct, void * p_async_arg)

Receive data on the CDC data interface asynchronously.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_cdc_write_data#

sl_status_t sl_usbd_cdc_write_data (uint8_t class_nbr, uint8_t data_if_nbr, uint8_t * p_buf, uint32_t buf_len, uint16_t timeout, uint32_t * p_xfer_len)

Send data on the CDC data interface.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_cdc_write_data_async#

sl_status_t sl_usbd_cdc_write_data_async (uint8_t class_nbr, uint8_t data_if_nbr, uint8_t * p_buf, uint32_t buf_len, sl_usbd_cdc_async_function_t async_fnct, void * p_async_arg)

Send data on the CDC data interface asynchronously.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_cdc_notify_host#

sl_status_t sl_usbd_cdc_notify_host (uint8_t class_nbr, uint8_t notification, uint16_t value, uint8_t * p_buf, uint16_t data_len, bool * p_result)

Send a communication interface class notification to the host.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) The notification buffer MUST contain space for the notification header 'SL_USBD_CDC_NOTIFICATION_HEADER' plus the variable-length data portion.

SL_USBD_CDC_NBR_NONE#

#define SL_USBD_CDC_NBR_NONE

255u

MODULE.

INCLUDE FILES DEFINES CDC INVALID INSTANCE NUMBERS DEFINES

SL_USBD_CDC_DATA_IF_NBR_NONE#

#define SL_USBD_CDC_DATA_IF_NBR_NONE

255u

SL_USBD_CDC_SUBCLASS_RSVD#

#define SL_USBD_CDC_SUBCLASS_RSVD

0x00u

COMMUNICATIONS CLASS SUBCLASS CODES DEFINES.

Note(s) : (1) Communication class subclass codes are defined in table 4 from the CDC specification revision 1.2.

SL_USBD_CDC_SUBCLASS_DLCM#

#define SL_USBD_CDC_SUBCLASS_DLCM

0x01u

SL_USBD_CDC_SUBCLASS_ACM#

#define SL_USBD_CDC_SUBCLASS_ACM

0x02u

SL_USBD_CDC_SUBCLASS_TCM#

#define SL_USBD_CDC_SUBCLASS_TCM

0x03u

SL_USBD_CDC_SUBCLASS_MCCM#

#define SL_USBD_CDC_SUBCLASS_MCCM

0x04u

SL_USBD_CDC_SUBCLASS_CAPICM#

#define SL_USBD_CDC_SUBCLASS_CAPICM

0x05u

SL_USBD_CDC_SUBCLASS_ENCM#

#define SL_USBD_CDC_SUBCLASS_ENCM

0x06u

SL_USBD_CDC_SUBCLASS_ATM#

#define SL_USBD_CDC_SUBCLASS_ATM

0x07u

SL_USBD_CDC_SUBCLASS_WHCM#

#define SL_USBD_CDC_SUBCLASS_WHCM

0x08u

SL_USBD_CDC_SUBCLASS_DEV_MGMT#

#define SL_USBD_CDC_SUBCLASS_DEV_MGMT

0x09u

SL_USBD_CDC_SUBCLASS_MDLM#

#define SL_USBD_CDC_SUBCLASS_MDLM

0x0Au

SL_USBD_CDC_SUBCLASS_OBEX#

#define SL_USBD_CDC_SUBCLASS_OBEX

0x0Bu

SL_USBD_CDC_SUBCLASS_EEM#

#define SL_USBD_CDC_SUBCLASS_EEM

0x0Cu

SL_USBD_CDC_SUBCLASS_NCM#

#define SL_USBD_CDC_SUBCLASS_NCM

0x0Du

SL_USBD_CDC_SUBCLASS_VENDOR#

#define SL_USBD_CDC_SUBCLASS_VENDOR

0xFEu

SL_USBD_CDC_COMM_PROTOCOL_NONE#

#define SL_USBD_CDC_COMM_PROTOCOL_NONE

0x00u

COMMUNICATION CLASS PROTOCOL CODES DEFINES.

Note(s) : (1) Communication class protocol codes are defined in table 5 from the CDC specification revision 1.2.

SL_USBD_CDC_COMM_PROTOCOL_AT_V250#

#define SL_USBD_CDC_COMM_PROTOCOL_AT_V250

0x01u

SL_USBD_CDC_COMM_PROTOCOL_AT_PCCA_101#

#define SL_USBD_CDC_COMM_PROTOCOL_AT_PCCA_101

0x02u

SL_USBD_CDC_COMM_PROTOCOL_AT_PCCA_101_ANNEX#

#define SL_USBD_CDC_COMM_PROTOCOL_AT_PCCA_101_ANNEX

0x03u

SL_USBD_CDC_COMM_PROTOCOL_AT_GSM_7_07#

#define SL_USBD_CDC_COMM_PROTOCOL_AT_GSM_7_07

0x04u

SL_USBD_CDC_COMM_PROTOCOL_AT_3GPP_27_07#

#define SL_USBD_CDC_COMM_PROTOCOL_AT_3GPP_27_07

0x05u

SL_USBD_CDC_COMM_PROTOCOL_AT_TIA_CDMA#

#define SL_USBD_CDC_COMM_PROTOCOL_AT_TIA_CDMA

0x06u

SL_USBD_CDC_COMM_PROTOCOL_EEM#

#define SL_USBD_CDC_COMM_PROTOCOL_EEM

0x07u

SL_USBD_CDC_COMM_PROTOCOL_EXT#

#define SL_USBD_CDC_COMM_PROTOCOL_EXT

0xFEu

SL_USBD_CDC_COMM_PROTOCOL_VENDOR#

#define SL_USBD_CDC_COMM_PROTOCOL_VENDOR

0xFFu

SL_USBD_CDC_DATA_PROTOCOL_NONE#

#define SL_USBD_CDC_DATA_PROTOCOL_NONE

0x00u

DATA INTERFACE CLASS PROTOCOL CODES DEFINES.

Note(s) : (1) Data interface class protocol codes are defined in table 7 from the CDC specification revision 1.2.

SL_USBD_CDC_DATA_PROTOCOL_NTB#

#define SL_USBD_CDC_DATA_PROTOCOL_NTB

0x01u

SL_USBD_CDC_DATA_PROTOCOL_PHY#

#define SL_USBD_CDC_DATA_PROTOCOL_PHY

0x30u

SL_USBD_CDC_DATA_PROTOCOL_HDLC#

#define SL_USBD_CDC_DATA_PROTOCOL_HDLC

0x31u

SL_USBD_CDC_DATA_PROTOCOL_TRANS#

#define SL_USBD_CDC_DATA_PROTOCOL_TRANS

0x32u

SL_USBD_CDC_DATA_PROTOCOL_Q921M#

#define SL_USBD_CDC_DATA_PROTOCOL_Q921M

0x50u

SL_USBD_CDC_DATA_PROTOCOL_Q921#

#define SL_USBD_CDC_DATA_PROTOCOL_Q921

0x51u

SL_USBD_CDC_DATA_PROTOCOL_Q921TM#

#define SL_USBD_CDC_DATA_PROTOCOL_Q921TM

0x52u

SL_USBD_CDC_DATA_PROTOCOL_COMPRES#

#define SL_USBD_CDC_DATA_PROTOCOL_COMPRES

0x90u

SL_USBD_CDC_DATA_PROTOCOL_Q9131#

#define SL_USBD_CDC_DATA_PROTOCOL_Q9131

0x91u

SL_USBD_CDC_DATA_PROTOCOL_V24#

#define SL_USBD_CDC_DATA_PROTOCOL_V24

0x92u

SL_USBD_CDC_DATA_PROTOCOL_CAPI#

#define SL_USBD_CDC_DATA_PROTOCOL_CAPI

0x93u

SL_USBD_CDC_DATA_PROTOCOL_HOST#

#define SL_USBD_CDC_DATA_PROTOCOL_HOST

0xFDu

SL_USBD_CDC_DATA_PROTOCOL_CDC#

#define SL_USBD_CDC_DATA_PROTOCOL_CDC

0xFEu

SL_USBD_CDC_DATA_PROTOCOL_VENDOR#

#define SL_USBD_CDC_DATA_PROTOCOL_VENDOR

0xFFu

SL_USBD_CDC_REQ_SEND_ENCAP_COMM#

#define SL_USBD_CDC_REQ_SEND_ENCAP_COMM

0x00u

MANAGEMENT ELEMENTS REQUESTS DEFINES.

Note(s) : (1) Management elements requests are defined in table 19 from the CDC specification revision 1.2.

SL_USBD_CDC_REQ_GET_ENCAP_RESP#

#define SL_USBD_CDC_REQ_GET_ENCAP_RESP

0x01u

SL_USBD_CDC_REQ_SET_COMM_FEATURE#

#define SL_USBD_CDC_REQ_SET_COMM_FEATURE

0x02u

SL_USBD_CDC_REQ_GET_COMM_FEATURE#

#define SL_USBD_CDC_REQ_GET_COMM_FEATURE

0x03u

SL_USBD_CDC_REQ_CLR_COMM_FEATURE#

#define SL_USBD_CDC_REQ_CLR_COMM_FEATURE

0x04u

SL_USBD_CDC_REQ_SET_AUX_LINE_STATE#

#define SL_USBD_CDC_REQ_SET_AUX_LINE_STATE

0x10u

SL_USBD_CDC_REQ_SET_HOOK_STATE#

#define SL_USBD_CDC_REQ_SET_HOOK_STATE

0x11u

SL_USBD_CDC_REQ_PULSE_SETUP#

#define SL_USBD_CDC_REQ_PULSE_SETUP

0x12u

SL_USBD_CDC_REQ_SEND_PULSE#

#define SL_USBD_CDC_REQ_SEND_PULSE

0x13u

SL_USBD_CDC_REQ_SET_PULSE_TIME#

#define SL_USBD_CDC_REQ_SET_PULSE_TIME

0x14u

SL_USBD_CDC_REQ_RING_AUX_JACK#

#define SL_USBD_CDC_REQ_RING_AUX_JACK

0x15u

SL_USBD_CDC_REQ_SET_LINE_CODING#

#define SL_USBD_CDC_REQ_SET_LINE_CODING

0x20u

SL_USBD_CDC_REQ_GET_LINE_CODING#

#define SL_USBD_CDC_REQ_GET_LINE_CODING

0x21u

SL_USBD_CDC_REQ_SET_CTRL_LINE_STATE#

#define SL_USBD_CDC_REQ_SET_CTRL_LINE_STATE

0x22u

SL_USBD_CDC_REQ_SEND_BREAK#

#define SL_USBD_CDC_REQ_SEND_BREAK

0x23u

SL_USBD_CDC_REQ_SET_RINGER_PAARMS#

#define SL_USBD_CDC_REQ_SET_RINGER_PAARMS

0x30u

SL_USBD_CDC_REQ_GET_RINGER_PARAMS#

#define SL_USBD_CDC_REQ_GET_RINGER_PARAMS

0x31u

SL_USBD_CDC_REQ_SET_OPERATION_PARAMS#

#define SL_USBD_CDC_REQ_SET_OPERATION_PARAMS

0x32u

SL_USBD_CDC_REQ_GET_OPERATION_PARAMS#

#define SL_USBD_CDC_REQ_GET_OPERATION_PARAMS

0x33u

SL_USBD_CDC_REQ_SET_LINE_PARAMS#

#define SL_USBD_CDC_REQ_SET_LINE_PARAMS

0x34u

SL_USBD_CDC_REQ_GET_LINE_PARAMS#

#define SL_USBD_CDC_REQ_GET_LINE_PARAMS

0x35u

SL_USBD_CDC_REQ_DIAL_DIGITS#

#define SL_USBD_CDC_REQ_DIAL_DIGITS

0x36u

SL_USBD_CDC_REQ_SET_UNIT_PARAM#

#define SL_USBD_CDC_REQ_SET_UNIT_PARAM

0x37u

SL_USBD_CDC_REQ_GET_UNIT_PARAM#

#define SL_USBD_CDC_REQ_GET_UNIT_PARAM

0x38u

SL_USBD_CDC_REQ_CLR_UNUT_PARAM#

#define SL_USBD_CDC_REQ_CLR_UNUT_PARAM

0x39u

SL_USBD_CDC_REQ_GET_PROFILE#

#define SL_USBD_CDC_REQ_GET_PROFILE

0x3Au

SL_USBD_CDC_REQ_SET_ETHER_MULTI_FILTER#

#define SL_USBD_CDC_REQ_SET_ETHER_MULTI_FILTER

0x40u

SL_USBD_CDC_REQ_SET_ETHER_PWR_MGT_FILTER#

#define SL_USBD_CDC_REQ_SET_ETHER_PWR_MGT_FILTER

0x41u

SL_USBD_CDC_REQ_GET_ETHER_PWR_MGT_FILTER#

#define SL_USBD_CDC_REQ_GET_ETHER_PWR_MGT_FILTER

0x42u

SL_USBD_CDC_REQ_SET_ETHER_PKT_FILTER#

#define SL_USBD_CDC_REQ_SET_ETHER_PKT_FILTER

0x43u

SL_USBD_CDC_REQ_GET_ETHER_STAT#

#define SL_USBD_CDC_REQ_GET_ETHER_STAT

0x44u

SL_USBD_CDC_REQ_SET_ATM_DATA_FMT#

#define SL_USBD_CDC_REQ_SET_ATM_DATA_FMT

0x50u

SL_USBD_CDC_REQ_GET_ATM_DATA_FMT#

#define SL_USBD_CDC_REQ_GET_ATM_DATA_FMT

0x51u

SL_USBD_CDC_REQ_GET_ATM_DEV_STAT#

#define SL_USBD_CDC_REQ_GET_ATM_DEV_STAT

0x52u

SL_USBD_CDC_REQ_SET_ATM_DFLT_VC#

#define SL_USBD_CDC_REQ_SET_ATM_DFLT_VC

0x53u

SL_USBD_CDC_REQ_GET_ATM_VC_STAT#

#define SL_USBD_CDC_REQ_GET_ATM_VC_STAT

0x54u

SL_USBD_CDC_REQ_GET_NTB_PARAM2#

#define SL_USBD_CDC_REQ_GET_NTB_PARAM2

0x80u

SL_USBD_CDC_REQ_GET_NET_ADDR#

#define SL_USBD_CDC_REQ_GET_NET_ADDR

0x81u

SL_USBD_CDC_REQ_SET_NET_ADDR#

#define SL_USBD_CDC_REQ_SET_NET_ADDR

0x82u

SL_USBD_CDC_REQ_GET_NTB_FMT#

#define SL_USBD_CDC_REQ_GET_NTB_FMT

0x83u

SL_USBD_CDC_REQ_SET_NTB_FMT#

#define SL_USBD_CDC_REQ_SET_NTB_FMT

0x84u

SL_USBD_CDC_REQ_GET_NTB_INPUT_SIZE#

#define SL_USBD_CDC_REQ_GET_NTB_INPUT_SIZE

0x85u

SL_USBD_CDC_REQ_SET_NTB_INPUT_SIZE#

#define SL_USBD_CDC_REQ_SET_NTB_INPUT_SIZE

0x86u

SL_USBD_CDC_REQ_GET_MAX_DATAGRAM_SIZE#

#define SL_USBD_CDC_REQ_GET_MAX_DATAGRAM_SIZE

0x87u

SL_USBD_CDC_REQ_SET_MAX_DATAGRAM_SIZE#

#define SL_USBD_CDC_REQ_SET_MAX_DATAGRAM_SIZE

0x88u

SL_USBD_CDC_REQ_GET_CRC_MODE#

#define SL_USBD_CDC_REQ_GET_CRC_MODE

0x89u

SL_USBD_CDC_REQ_SET_CRC_MODE#

#define SL_USBD_CDC_REQ_SET_CRC_MODE

0x8Au

SL_USBD_CDC_DESC_TYPE_CS_IF#

#define SL_USBD_CDC_DESC_TYPE_CS_IF

0x24u

CDC FUNCTIONAL DESCRIPTOR TYPE DEFINES.

Note(s) : (1) Functional descriptors types are defined in table 12 from the CDC specification revision 1.2.

SL_USBD_CDC_DESC_TYPE_CS_EP#

#define SL_USBD_CDC_DESC_TYPE_CS_EP

0x25u

SL_USBD_CDC_DESC_SUBTYPE_HEADER#

#define SL_USBD_CDC_DESC_SUBTYPE_HEADER

0x00u

CDC FUNCTIONAL DESCRIPTOR SUBTYPE DEFINES.

Note(s) : (1) Functional descriptors subtypes are defined in table 13 from the CDC specification revision 1.2.

SL_USBD_CDC_DESC_SUBTYPE_CALL_MGMT#

#define SL_USBD_CDC_DESC_SUBTYPE_CALL_MGMT

0x01u

SL_USBD_CDC_DESC_SUBTYPE_ACM#

#define SL_USBD_CDC_DESC_SUBTYPE_ACM

0x02u

SL_USBD_CDC_DESC_SUBTYPE_DLM#

#define SL_USBD_CDC_DESC_SUBTYPE_DLM

0x03u

SL_USBD_CDC_DESC_SUBTYPE_TEL_RINGER#

#define SL_USBD_CDC_DESC_SUBTYPE_TEL_RINGER

0x04u

SL_USBD_CDC_DESC_SUBTYPE_TEL_CALL_LINE#

#define SL_USBD_CDC_DESC_SUBTYPE_TEL_CALL_LINE

0x05u

SL_USBD_CDC_DESC_SUBTYPE_UNION#

#define SL_USBD_CDC_DESC_SUBTYPE_UNION

0x06u

SL_USBD_CDC_DESC_SUBTYPE_COUNTRY_SEL#

#define SL_USBD_CDC_DESC_SUBTYPE_COUNTRY_SEL

0x07u

SL_USBD_CDC_DESC_SUBTYPE_TEL_OPERA#

#define SL_USBD_CDC_DESC_SUBTYPE_TEL_OPERA

0x08u

SL_USBD_CDC_DESC_SUBTYPE_USB_TERM#

#define SL_USBD_CDC_DESC_SUBTYPE_USB_TERM

0x09u

SL_USBD_CDC_DESC_SUBTYPE_NET_CH_TERM#

#define SL_USBD_CDC_DESC_SUBTYPE_NET_CH_TERM

0x0Au

SL_USBD_CDC_DESC_SUBTYPE_PROTOCOL_UNIT#

#define SL_USBD_CDC_DESC_SUBTYPE_PROTOCOL_UNIT

0x0Bu

SL_USBD_CDC_DESC_SUBTYPE_EXT_UNIT#

#define SL_USBD_CDC_DESC_SUBTYPE_EXT_UNIT

0x0Cu

SL_USBD_CDC_DESC_SUBTYPE_MULTI_CH_MGMT#

#define SL_USBD_CDC_DESC_SUBTYPE_MULTI_CH_MGMT

0x0Du

SL_USBD_CDC_DESC_SUBTYPE_CAPI_CTRL#

#define SL_USBD_CDC_DESC_SUBTYPE_CAPI_CTRL

0x0Eu

SL_USBD_CDC_DESC_SUBTYPE_ETHER_NET#

#define SL_USBD_CDC_DESC_SUBTYPE_ETHER_NET

0x0Fu

SL_USBD_CDC_DESC_SUBTYPE_ATM_NET#

#define SL_USBD_CDC_DESC_SUBTYPE_ATM_NET

0x10u

SL_USBD_CDC_DESC_SUBTYPE_WIRELESS_CTRL#

#define SL_USBD_CDC_DESC_SUBTYPE_WIRELESS_CTRL

0x11u

SL_USBD_CDC_DESC_SUBTYPE_MOBILE#

#define SL_USBD_CDC_DESC_SUBTYPE_MOBILE

DLM              0x12u

SL_USBD_CDC_DESC_SUBTYPE_DETAIL#

#define SL_USBD_CDC_DESC_SUBTYPE_DETAIL

0x13u

SL_USBD_CDC_DESC_SUBTYPE_DEV_MGMT#

#define SL_USBD_CDC_DESC_SUBTYPE_DEV_MGMT

0x14u

SL_USBD_CDC_DESC_SUBTYPE_OBEX#

#define SL_USBD_CDC_DESC_SUBTYPE_OBEX

0x15u

SL_USBD_CDC_DESC_SUBTYPE_CMD_SET#

#define SL_USBD_CDC_DESC_SUBTYPE_CMD_SET

0x16u

SL_USBD_CDC_DESC_SUBTYPE_CMD_SET_DETAIL#

#define SL_USBD_CDC_DESC_SUBTYPE_CMD_SET_DETAIL

0x17u

SL_USBD_CDC_DESC_SUBTYPE_TCM#

#define SL_USBD_CDC_DESC_SUBTYPE_TCM

0x18u

SL_USBD_CDC_DESC_SUBTYPE_OBEX_SERV#

#define SL_USBD_CDC_DESC_SUBTYPE_OBEX_SERV

0x19u

SL_USBD_CDC_DESC_SUBTYPE_NCM#

#define SL_USBD_CDC_DESC_SUBTYPE_NCM

0x1Au

SL_USBD_CDC_DESC_SUBTYPE_VENDOR#

#define SL_USBD_CDC_DESC_SUBTYPE_VENDOR

0xFEu

SL_USBD_CDC_NOTIFICATION_HEADER#

#define SL_USBD_CDC_NOTIFICATION_HEADER

8u

CDC NOTIFICATION DEFINES.