sx_api_dbg.h File Reference

Go to the source code of this file.

Functions
sx_status_t	sx_api_dbg_generate_dump (const sx_api_handle_t handle, const char *dump_file_path)
sx_status_t	sx_api_dbg_atcam (const sx_api_handle_t handle, sx_dbg_atcam_cmd_info_t *cmd_p)

Function Documentation

sx_api_dbg_generate_dump()

sx_status_t sx_api_dbg_generate_dump	(	const sx_api_handle_t	handle,
		const char *	dump_file_path
	)

This API generates debug dump of all SDK modules, SX-core and driver. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	dump_file_path	- Full path file name.

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any input parameters is invalid

SX_STATUS_PARAM_EXCEEDS_RANGE if the path string length is greater than 256

SX_STATUS_ERROR general error

sx_api_dbg_atcam()

sx_status_t sx_api_dbg_atcam	(	const sx_api_handle_t	handle,
		sx_dbg_atcam_cmd_info_t *	cmd_p
	)

This API should be used only for debug purposes. It is used to access internal commands for the ATcam (SPACE) module. Supported devices: Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	sx_dbg_atcam_cmd_info_t	- One of the supported within atcam module to execute directly

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any input parameters is invalid

SX_STATUS_ERROR general error