Heartbeat APIs
These APIs check firmware/hardware status for a given device and are used as part of the Heartbeat functionality.
icp_sal_check_device
This function checks the status of the firmware/hardware for a given device and is used as part of the Heartbeat functionality.
Syntax
CpaStatus icp_sal_check_device(Cpa32U accelID);
Parameters
|
The device ID. |
Return Value
The icp_sal_check_device function returns one of the following codes:
|
Successful operation. |
|
Indicates a failure. |
icp_sal_check_all_devices
This function checks the status of the firmware/hardware for all devices and is used as part of the Heartbeat functionality.
Syntax
CpaStatus icp_sal_check_all_devices(void);
Parameters
None
Return Value
The icp_sal_check_all_devices function returns one of the following codes:
|
Successful operation. |
|
Indicates a failure. |
icp_sal_heartbeat_simulate_failure
This function simulates heartbeat failure for a specific device.
Syntax
CpaStatus icp_sal_heartbeat_simulate_failure(Cpa32U accelID);
Parameters
|
The device ID. |
Return Value
The icp_sal_heartbeat_simulate_failure function returns one of the following codes:
|
Successful operation. |
|
Indicates a failure. |