cdiGetBoardStatus

Queries the current board status.

Prototype

DWORD cdiGetBoardStatus ( CTAHD ctahd, CDI_BOARD_STATUS *board_status)

Argument

Description

ctahd

Context handle.

board_status

Pointer to the CDI_BOARD_STATUS structure containing status information:

typedef struct
{
     DWORD size;
     DWORD voltage_presence;
     DWORD board_presence;
     DWORD thermometer_presence;
     DWORD thermal_state;
     DWORD hmic_error;
     DWORD slic_error[3];
} CDI_BOARD_STATUS;

Refer to the Details section for field descriptions.


Return values

Return value

Description

SUCCESS

 

CTAERR_INVALID_CTAHD

Handle is invalid.


Details

CDI_BOARD_STATUS is defined in cdidef.h. The following table describes the values for the fields in this structure:

Field

Description

voltage_presence

Valid values:

CDI_VOLTAGE_LOW_BATTERY (0x0001) = Low battery voltage detected.

CDI_VOLTAGE_HIGH_BATTERY (0x0002) = High battery voltage detected.

CDI_VOLTAGE_RING_VOLTAGE (0x0004) = Ring voltage detected.

CDI_VOLTAGE_EXT_RINGER (0x0008) = External ringer enabled.

board_presence

Valid values:

CDI_BOARD_FIRST_STATION_GROUP (0x000) = Station group on base board present.

CDI_BOARD_SECOND_STATION_GROUP (0x0002) = Station group on first station interface module present.

CDI_BOARD_THIRD_STATION_GROUP (0x0004) = Station group on second station interface module present.

CDI_BOARD_REAR_BOARD (0x0008) = CX 2000C rear transition board present.

thermometer_presence

Corresponds to each sensor. Valid values:

CDI_THERMOMETER_0_POPULATED (0x0001) = Thermometer 0 enabled.

CDI_THERMOMETER_1_POPULATED (0x0002) = Thermometer 1 enabled.

CDI_THERMOMETER_2_POPULATED (0x0004) = Thermometer 2 enabled.

CDI_THERMOMETER_3_POPULATED (0x0008) = Thermometer 3 enabled.

CDI_THERMOMETER_4_POPULATED (0x0010) = Thermometer 4 enabled.

thermal_state

Valid values:

CDI_THERMAL_NORMAL (0x0001) = Temperature within normal operating range.

CDI_THERMAL_WARNING (0x0002) = Temperature reached warning range.

CDI_THERMAL_PROTECTION (0x0003) = Temperature reached protection range.

Note: The thermal_state field values cannot be combined.

hmic_error

Valid values:

No error

CDI_HMIC_ERROR_SYSTEM (0x0001) = Reserved.

CDI_HMIC_ERROR_CLOCK (0x0002) = Reserved.

CDI_BSP_SYNC_ERROR (0x0004) = Clock error detected and resynchronization done.

slic_error

Array representing the error status for each port group (1..3). The lowest 16 bits in each slic_error element represent the error status of the corresponding 16 individual ports.


Refer to Monitoring status changes for more information.

See also

cdiStartStatusMonitoring, cdiStopStatusMonitoring