USB Device ACM API#

sl_usbd_cdc_acm_init#

sl_status_t sl_usbd_cdc_acm_init (void )

GLOBAL VARIABLES.

MACROS GLOBAL CONSTANTS FUNCTION PROTOTYPES CDC ACM FUNCTIONS

Initialize the CDC ACM serial emulation subclass.

Returns

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

sl_usbd_cdc_acm_create_instance#

sl_status_t sl_usbd_cdc_acm_create_instance (uint16_t line_state_interval, uint16_t call_mgmt_capabilities, sl_usbd_cdc_acm_callbacks_t * p_acm_callbacks, uint8_t * p_subclass_nbr)

Add a new instance of the CDC ACM serial emulation subclass.

Returns

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

sl_usbd_cdc_acm_add_to_configuration#

sl_status_t sl_usbd_cdc_acm_add_to_configuration (uint8_t subclass_nbr, uint8_t config_nbr)

Add a CDC ACM subclass class instance into USB device configuration.

Returns

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

sl_usbd_cdc_acm_is_enabled#

sl_status_t sl_usbd_cdc_acm_is_enabled (uint8_t subclass_nbr, bool * p_enabled)

Get the CDC ACM serial emulation subclass enable state.

Returns

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

sl_usbd_cdc_acm_read#

sl_status_t sl_usbd_cdc_acm_read (uint8_t subclass_nbr, uint8_t * p_buf, uint32_t buf_len, uint16_t timeout, uint32_t * p_xfer_len)

Receive data on the CDC ACM serial emulation subclass.

Returns

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

sl_usbd_cdc_acm_read_async#

sl_status_t sl_usbd_cdc_acm_read_async (uint8_t subclass_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 ACM serial emulation subclass asynchronously.

Returns

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

sl_usbd_cdc_acm_write#

sl_status_t sl_usbd_cdc_acm_write (uint8_t subclass_nbr, uint8_t * p_buf, uint32_t buf_len, uint16_t timeout, uint32_t * p_xfer_len)

Send data on the CDC ACM serial emulation subclass.

Returns

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

sl_usbd_cdc_acm_write_async#

sl_status_t sl_usbd_cdc_acm_write_async (uint8_t subclass_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 ACM serial emulation subclass asynchronously.

Returns

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

sl_usbd_cdc_acm_get_line_control_state#

sl_status_t sl_usbd_cdc_acm_get_line_control_state (uint8_t subclass_nbr, uint8_t * p_line_ctrl)

Return the state of control lines.

Returns

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

sl_usbd_cdc_acm_get_line_coding#

sl_status_t sl_usbd_cdc_acm_get_line_coding (uint8_t subclass_nbr, sl_usbd_cdc_acm_line_coding_t * p_line_coding)

Get the current state of the line coding.

Returns

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

sl_usbd_cdc_acm_set_line_coding#

sl_status_t sl_usbd_cdc_acm_set_line_coding (uint8_t subclass_nbr, sl_usbd_cdc_acm_line_coding_t * p_line_coding)

Set a new line coding.

Returns

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

sl_usbd_cdc_acm_set_line_state_event#

sl_status_t sl_usbd_cdc_acm_set_line_state_event (uint8_t subclass_nbr, uint8_t events)

Set a line state event(s).

Returns

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

sl_usbd_cdc_acm_clear_line_state_event#

sl_status_t sl_usbd_cdc_acm_clear_line_state_event (uint8_t subclass_nbr, uint8_t events)

Clear a line state event(s).

Returns

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

Note

• (1) USB PSTN spec ver 1.20 states: "For the irregular signals like break, the incoming ring signal, or the overrun error state, this will reset their values to zero and again will not send another notification until their state changes." The irregular events are automatically cleared by the ACM serial emulation subclass.

SL_USBD_CDC_ACM_NBR_NONE#

#define SL_USBD_CDC_ACM_NBR_NONE

255u

MODULE.

INCLUDE FILES DEFINES

SL_USBD_CDC_ACM_PARITY_NONE#

#define SL_USBD_CDC_ACM_PARITY_NONE

0u

PORT SETTINGS DEFINES.

SL_USBD_CDC_ACM_PARITY_ODD#

#define SL_USBD_CDC_ACM_PARITY_ODD

1u

SL_USBD_CDC_ACM_PARITY_EVEN#

#define SL_USBD_CDC_ACM_PARITY_EVEN

2u

SL_USBD_CDC_ACM_PARITY_MARK#

#define SL_USBD_CDC_ACM_PARITY_MARK

3u

SL_USBD_CDC_ACM_PARITY_SPACE#

#define SL_USBD_CDC_ACM_PARITY_SPACE

4u

SL_USBD_CDC_ACM_STOP_BIT_1#

#define SL_USBD_CDC_ACM_STOP_BIT_1

0u

SL_USBD_CDC_ACM_STOP_BIT_1_5#

#define SL_USBD_CDC_ACM_STOP_BIT_1_5

1u

SL_USBD_CDC_ACM_STOP_BIT_2#

#define SL_USBD_CDC_ACM_STOP_BIT_2

2u

SL_USBD_CDC_ACM_CTRL_BREAK#

#define SL_USBD_CDC_ACM_CTRL_BREAK

0x01u

LINE EVENTS FLAGS DEFINES.

SL_USBD_CDC_ACM_CTRL_RTS#

#define SL_USBD_CDC_ACM_CTRL_RTS

0x02u

SL_USBD_CDC_ACM_CTRL_DTR#

#define SL_USBD_CDC_ACM_CTRL_DTR

0x04u

SL_USBD_CDC_ACM_STATE_DCD#

#define SL_USBD_CDC_ACM_STATE_DCD

0x01u

SL_USBD_CDC_ACM_STATE_DSR#

#define SL_USBD_CDC_ACM_STATE_DSR

0x02u

SL_USBD_CDC_ACM_STATE_BREAK#

#define SL_USBD_CDC_ACM_STATE_BREAK

0x04u

SL_USBD_CDC_ACM_STATE_RING#

#define SL_USBD_CDC_ACM_STATE_RING

0x08u

SL_USBD_CDC_ACM_STATE_FRAMING#

#define SL_USBD_CDC_ACM_STATE_FRAMING

0x10u

SL_USBD_CDC_ACM_STATE_PARITY#

#define SL_USBD_CDC_ACM_STATE_PARITY

0x20u

SL_USBD_CDC_ACM_STATE_OVERUN#

#define SL_USBD_CDC_ACM_STATE_OVERUN

0x40u

SL_USBD_CDC_ACM_CALL_MGMT_DEV#

#define SL_USBD_CDC_ACM_CALL_MGMT_DEV

0x01u

CALL MANAGEMENT CAPABILITIES.

Note(s) : (1) See 'USB, Communications Class, Subclass Specification for PSTN Devices, Revision 1.2, February 9 2007', section '5.3.1 Call Management Functional Descriptor' for more details about the Call Management capabilities.

SL_USBD_CDC_ACM_CALL_MGMT_DATA_CCI_DCI#

#define SL_USBD_CDC_ACM_CALL_MGMT_DATA_CCI_DCI

0x02u

SL_USBD_CDC_ACM_CALL_MGMT_DATA_OVER_DCI#

#define SL_USBD_CDC_ACM_CALL_MGMT_DATA_OVER_DCI

(0x02u | 0x01u)