CPC#

sl_cpc_user_endpoint_id_t#

sl_cpc_user_endpoint_id_t

Enumeration representing user endpoint.

sl_cpc_endpoint_state_t#

sl_cpc_endpoint_state_t

Enumeration representing the possible endpoint state.

sl_cpc_endpoint_option_t#

sl_cpc_endpoint_option_t

Enumeration representing the possible configurable options for an endpoint.

sl_cpc_on_write_completed_t#

typedef void(* sl_cpc_on_write_completed_t) (sl_cpc_user_endpoint_id_t endpoint_id, void *buffer, void *arg, sl_status_t status) )(sl_cpc_user_endpoint_id_t endpoint_id, void *buffer, void *arg, sl_status_t status)

Typedef for the user - supplied callback function which is called when CPC is done with the provided buffer.

sl_cpc_on_data_reception_t#

typedef void(* sl_cpc_on_data_reception_t) (uint8_t endpoint_id, void *arg) )(uint8_t endpoint_id, void *arg)

Typedef for the user - supplied callback function which is called when CPC receive data on an endpoint.

sl_cpc_on_error_callback_t#

typedef void(* sl_cpc_on_error_callback_t) (uint8_t endpoint_id, void *arg) )(uint8_t endpoint_id, void *arg)

Typedef for the user-supplied callback function which is called when CPC detects a fatal error on an endpoint.

sl_cpc_on_connect_callback_t#

typedef void(* sl_cpc_on_connect_callback_t) (uint8_t endpoint_id, void *arg, sl_status_t status) )(uint8_t endpoint_id, void *arg, sl_status_t status)

Typedef for the user-supplied callback function which is called when CPC connection to a secondary completes, successfully or not.

Note

• If several users connect to the same endpoint on the host side, this callback will only be called only when the first connection occurs.

sl_cpc_init#

sl_status_t sl_cpc_init (void )

Global variable that contains the core debug information.

Initialize CPC module.

sl_cpc_init_user_endpoint#

sl_status_t sl_cpc_init_user_endpoint (sl_cpc_endpoint_handle_t * endpoint_handle, sl_cpc_user_endpoint_id_t id, uint8_t flags)

The bare metal process action function.

Initalize a user endpoint. Following the successful initialization of an endpoint, successive attempts to initialize an endpoint of the same ID will fail until the endpoint is freed.

sl_cpc_set_endpoint_option#

sl_status_t sl_cpc_set_endpoint_option (sl_cpc_endpoint_handle_t * endpoint_handle, sl_cpc_endpoint_option_t option, void * value)

Set endpoint option.

Returns

• Status code.

Return values

• SL_STATUS_OK: Set endpoint option successfully.

• Other: sl_status_t if error occurred.

Note

• Public options are: SL_CPC_ENDPOINT_ON_CONNECT: Set a callback that will be called when connection is established with the remote.

SL_CPC_ENDPOINT_ON_CONNECT_ARG: Set an on connect argument.

SL_CPC_ENDPOINT_ON_IFRAME_RECEIVE: Set an on iframe receive callback. value is a sl_cpc_on_data_reception_t type.

SL_CPC_ENDPOINT_ON_IFRAME_RECEIVE_ARG: Set an on iframe receive argument.

SL_CPC_ENDPOINT_ON_IFRAME_WRITE_COMPLETED: Set an on iframe write completed callback. value is a sl_cpc_on_write_completed_t type.

SL_CPC_ENDPOINT_ON_ERROR: Set an on error callback. value is a sl_cpc_on_error_callback_t type.

SL_CPC_ENDPOINT_ON_ERROR_ARG: Set an on error callback argument.

SL_CPC_ENDPOINT_SHUTDOWN_TIMEOUT: (RTOS Only) Set shutdown handshake timeout, in ticks.

SL_CPC_ENDPOINT_WRITE_TIMEOUT: (RTOS Only) Set the timeout time for blocking write in ticks.

sl_cpc_shutdown_endpoint#

sl_status_t sl_cpc_shutdown_endpoint (sl_cpc_endpoint_handle_t * endpoint_handle, uint8_t flags)

Shutdown endpoint connection.

Any pending TX frame will attempt to be transmitted.

Note

• In RTOS, this function is blocking by default. Use the SL_CPC_FLAG_NO_BLOCK flag to execute without blocking.

sl_cpc_terminate_endpoint#

sl_status_t sl_cpc_terminate_endpoint (sl_cpc_endpoint_handle_t * endpoint_handle, uint8_t flags)

Terminate an endpoint, effectively dropping any pending TX and RX frame.

In RTOS, this function will always block until all frames have been dropped.

Note

• This function must be called before attempting to reconnect an endpoint to the remote.

sl_cpc_free_endpoint#

sl_status_t sl_cpc_free_endpoint (sl_cpc_endpoint_handle_t * endpoint_handle)

Free the memory associated to an endpoint so it can be reused.

sl_cpc_abort_read#

sl_status_t sl_cpc_abort_read (sl_cpc_endpoint_handle_t * endpoint_handle)

Abort read; Allow unblocking task in blocked by a read.

Note

• This function can be called from an ISR.

sl_cpc_read#

sl_status_t sl_cpc_read (sl_cpc_endpoint_handle_t * endpoint_handle, void ** data, uint16_t * data_length, uint32_t timeout, uint8_t flags)

Read data.

sl_cpc_write#

sl_status_t sl_cpc_write (sl_cpc_endpoint_handle_t * endpoint_handle, void * data, uint16_t data_length, uint8_t flag, void * on_write_completed_arg)

Write data.

Note

• This function cannot be called from an ISR.

• When the write buffer is encrypted, the original content is lost and replaced by its encrypted counterpart.

sl_cpc_get_endpoint_state#

sl_cpc_endpoint_state_t sl_cpc_get_endpoint_state (sl_cpc_endpoint_handle_t * endpoint_handle)

Get endpoint state.

Returns

• Endpoint state.

sl_cpc_get_endpoint_encryption#

bool sl_cpc_get_endpoint_encryption (sl_cpc_endpoint_handle_t * endpoint_handle)

Get endpoint encryption state.

Returns

• Endpoint encryption state.

sl_cpc_free_rx_buffer#

sl_status_t sl_cpc_free_rx_buffer (void * data)

Free buffer returned by sl_cpc_read().

sl_cpc_get_tx_max_payload_length#

uint16_t sl_cpc_get_tx_max_payload_length (sl_cpc_endpoint_handle_t * endpoint_handle)

Get the maximum payload length that the remote can receive.

Returns

• the maximum tx payload length in function of whether the encryption is enabled on the endpoint or not

SL_CPC_ENDPOINT_FLAG_NONE#

#define SL_CPC_ENDPOINT_FLAG_NONE

0

sl cpc open endpoint flag none

SL_CPC_ENDPOINT_FLAG_DISABLE_ENCRYPTION#

#define SL_CPC_ENDPOINT_FLAG_DISABLE_ENCRYPTION

(0x01 << 3)

sl cpc open endpoint flag disable encryption

SL_CPC_OPEN_ENDPOINT_FLAG_NONE#

#define SL_CPC_OPEN_ENDPOINT_FLAG_NONE

SL_CPC_ENDPOINT_FLAG_NONE

SL_CPC_OPEN_ENDPOINT_FLAG_DISABLE_ENCRYPTION#

#define SL_CPC_OPEN_ENDPOINT_FLAG_DISABLE_ENCRYPTION

SL_CPC_ENDPOINT_FLAG_DISABLE_ENCRYPTION

SL_CPC_USER_ENDPOINT_ID_START#

#define SL_CPC_USER_ENDPOINT_ID_START

((uint8_t)SL_CPC_ENDPOINT_USER_ID_0)

Struct representing a core debug.

sl cpc endpoint id start.

SL_CPC_USER_ENDPOINT_ID_END#

#define SL_CPC_USER_ENDPOINT_ID_END

((uint8_t)(SL_CPC_ENDPOINT_USER_ID_0 + SL_CPC_USER_ENDPOINT_MAX_COUNT - 1))

sl cpc user endpoint id end.

SL_CPC_FLAG_NO_BLOCK#

#define SL_CPC_FLAG_NO_BLOCK

0x01

sl cpc flag no block.

SLI_CPC_SECURITY_TAG_LENGTH#

#define SLI_CPC_SECURITY_TAG_LENGTH

8

sli cpc security tag length.

SLI_CPC_LDMA_DESCRIPTOR_MAX_SIZE#

#define SLI_CPC_LDMA_DESCRIPTOR_MAX_SIZE

2048

sli cpc ldma desciptor max size.

SLI_CPC_HEADER_SIZE#

#define SLI_CPC_HEADER_SIZE

7

sli cpc header size.

SLI_CPC_PAYLOAD_CRC_SIZE#

#define SLI_CPC_PAYLOAD_CRC_SIZE

2

sli cpc payload crc size.

SL_CPC_TX_PAYLOAD_MAX_LENGTH#

#define SL_CPC_TX_PAYLOAD_MAX_LENGTH

((2 * SLI_CPC_LDMA_DESCRIPTOR_MAX_SIZE) - SLI_CPC_HEADER_SIZE - SLI_CPC_PAYLOAD_CRC_SIZE)

sl cpc tx payload max length.

SL_CPC_TX_PAYLOAD_MAX_LENGTH_WITH_SECURITY#

#define SL_CPC_TX_PAYLOAD_MAX_LENGTH_WITH_SECURITY

(SL_CPC_TX_PAYLOAD_MAX_LENGTH - SLI_CPC_SECURITY_TAG_LENGTH)

sl cpc tx payload max lenght with security.

SL_CPC_TRANSMIT_WINDOW_MIN_SIZE#

#define SL_CPC_TRANSMIT_WINDOW_MIN_SIZE

1

sl cpc transmit window min size.

SL_CPC_TRANSMIT_WINDOW_MAX_SIZE#

#define SL_CPC_TRANSMIT_WINDOW_MAX_SIZE

1

sl cpc transmit window max size.