IPC Module - Diagnostics Service

This page contains documentation of the System API.

Messages

message diagnostics_emmc_health_status_req

Return message:: diagnostics_emmc_health_status_rsp

Read eMMC Heath Status.

message diagnostics_emmc_health_status_rsp

Parameters:

device_life_time_estimation_type_a (uint8) – Device life time estimation type A: life time estimation for SLC eraseblocks, provided in steps of 10%, e.g.: 0x02 means 10%-20% device life time used.
device_life_time_estimation_type_b (uint8) – Device life time estimation type B: life time estimation for MLC eraseblocks, provided in steps of 10%, e.g.: 0x02 means 10%-20% device life time used.
pre_eol_information (enum diagnostics_pre_eol_information_type) – Pre EOL information: overall status for reserved blocks. Possible values are: 0x00 - Not defined. 0x01 - Normal: consumed less than 80% of the reserved blocks. 0x02 - Warning: consumed 80% of the reserved blocks. 0x03 - Urgent: consumed 90% of the reserved blocks.
result (enum diagnostics_result) – Result of operation

The values for the eMMC health are according to the eMMC 5.0 standard

message diagnostics_t1_health_indicators_req

Return message:: diagnostics_t1_health_indicators_rsp

Read T1 Health Indicators.

message diagnostics_t1_health_indicators_rsp

Parameters:

mse (uint16) – Mean Square Error: range: 0-511. Invalid if > 511
sqi (uint8) – SQI, 0-7, 7 is the best value.
pmse (uint8) – Peak MSE value, range: 0-63. 0xff if measurement is not possible
result (enum diagnostics_result) – Result of operation

Reads T1 health indicators

message diagnostics_antenna_status_req

Return message:: diagnostics_antenna_status_rsp

Read Antenna Status.

message diagnostics_antenna_status_rsp

Parameters:

internal_lte1_antenna_status (enum diagnostics_antenna_status) – Internal lte1 antenna status
internal_lte2_antenna_status (enum diagnostics_antenna_status) – Internal lte2 antenna status
internal_gnss_antenna_status (enum diagnostics_antenna_status) – Internal gnss antenna status
internal_wifi_antenna_status (enum diagnostics_antenna_status) – Internal wifi antenna status
internal_ble_antenna_status (enum diagnostics_antenna_status) – Internal ble antenna status
external_lte1_antenna_status (enum diagnostics_antenna_status) – External lte1 antenna status
external_lte2_antenna_status (enum diagnostics_antenna_status) – External lte2 antenna status
external_gnss_antenna_status (enum diagnostics_antenna_status) – External gnss antenna status
external_wifi_antenna_status (enum diagnostics_antenna_status) – External wifi antenna status
result (enum diagnostics_result) – Result of operation

message diagnostics_get_active_antenna_req

Parameters:: antenna (enum diagnostics_antenna_type) – Antenna type
Return message:: diagnostics_get_active_antenna_rsp

Get Active Antenna.

message diagnostics_get_active_antenna_rsp

Parameters:

location (enum diagnostics_antenna_location) – Antenna location
result (enum diagnostics_result) – Result of operation

message diagnostics_get_soc_temperature_req

Return message:: diagnostics_get_soc_temperature_rsp

Request to read the SoC temperature.

message diagnostics_get_soc_temperature_rsp

Parameters:

result (enum diagnostics_result) – Result of the operation
temperature (int16) – Measured temperature represented in C

message diagnostics_get_voltage_req

Parameters:: source (enum diagnostics_voltage_source) – Voltage to measure
Return message:: diagnostics_get_voltage_rsp

Request to measure a selected voltage source.

message diagnostics_get_voltage_rsp

Parameters:

source (enum diagnostics_voltage_source) – Measured voltage
result (enum diagnostics_result) – Result of the operation
voltage_mv (uint32) – The voltage in millivolts

Returns the measured voltage for the selected source.

Enums

enum diagnostics_result

Result codes.

Constant	Value	Description
OK	0	OK
ERROR_UNKNOWN	1	Error unknown
INVALID_INPUT	2	Invalid Input

enum diagnostics_pre_eol_information_type

pre EOL information type.

Constant	Value	Description
UNDEFINED	0	Undefined
NORMAL	1	Normal
WARNING	2	Warning
URGENT	3	Urgent

enum diagnostics_antenna_status

antenna status.

Constant	Value	Description
SHORT_TO_GND	0	Short to ground
NORMAL	1	Normal
OPEN_CIRCUIT	2	Open circuit
SHORT_TO_VBAT	3	Short to vbat
HW_NOT_MOUNTED	4	HW not mounted

enum diagnostics_antenna_type

Antenna type.

Constant	Value	Description
LTE1	0	LTE1
LTE2	1	LTE2
GNSS	2	GNSS
WLAN	3	WLAN
BT	4	BT

enum diagnostics_antenna_location

Antenna location.

Constant	Value	Description
INTERNAL	0	Internal
EXTERNAL	1	External

enum diagnostics_voltage_source

Voltage source.

Constant	Value	Description
VBAT	0	VBAT