Functions

General Description

• The VCM library internally creates multiple threads; the created threads are executed with the "CY_RTOS_PRIORITY_ABOVENORMAL" priority.
• The definition of the CY_RTOS_PRIORITY_ABOVENORMAL macro is located at "mtb-shared/abstraction-rtos/include/COMPONENT_FREERTOS/cyabs_rtos_impl.h".
• The VCM APIs are thread-safe.

Functions
cy_rslt_t	cy_vcm_init (cy_vcm_config_t *config)
	Initializes the virtual connectivity manager. More...
cy_rslt_t	cy_vcm_deinit ()
	De-initializes the virtual connectivity manager. More...

Function Documentation

cy_vcm_init()

cy_rslt_t cy_vcm_init

(

cy_vcm_config_t *

config

)

Initializes the virtual connectivity manager.

This function initializes the VCM resources, and HAL resources(queues) for the user given IPC channel. This function should be called in both cores before calling any virtual APIs.

Note

The core which executes first, should initialize VCM before enabling the other core, and should set config.hal_resource_opt to CY_VCM_CREATE_HAL_RESOURCE. The other core should initialize VCM with config.hal_resource_opt set to CY_VCM_USE_HAL_RESOURCE.

Parameters

[in]

config

Pointer to the config structure filled by the user cy_vcm_config_t

Returns

CY_RSLT_SUCCESS if successful; failure code otherwise.

cy_vcm_deinit()

cy_rslt_t cy_vcm_deinit

(

)

De-initializes the virtual connectivity manager.

Note

User should de-register all the virtual callbacks registered with WCM and/or MQTT before calling cy_vcm_deinit.

After invoking cy_vcm_deinit on either core, cy_vcm_init cannot be invoked again. The expectation is that cy_vcm_init and cy_vcm_deinit should be invoked only once.

Returns

CY_RSLT_SUCCESS if successful; failure code otherwise.