Table of Contents Index NMS Glossary Previous Page Next Page (Page 5 of 20 in this chapter) Version


cdiGetBoardStatus

Description

Queries the current board status.

Prototype

DWORD cdiGetBoardStatus (CTAHD ctahd,
CDI_BOARD_STATUS *board_status )

ctahd CTA context handle.

board_status Pointer to the CDI_BOARD_STATUS structure containing status information. See Details for more 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;

Return Values

Events

None.

Details

CTA_BOARD_STATUS is defined in cdidef.h. The values for the fields in this structure are described in the following tables:
voltage_presence field

Value

Description

CDI_VOLTAGE_LOW_BATTERY

0x0001

Low battery voltage is detected.

CDI_VOLTAGE_HIGH_BATTERY

0x0002

High battery voltage is detected.

CDI_VOLTAGE_RING_VOLTAGE

0x0004

Ring voltage is detected.

CDI_VOLTAGE_EXT_RINGER

0x0008

The exernal ringer is enabled.

board_presence field

Value

Description

CDI_BOARD_FIRST_STATION_GROUP

0x0001

Station group on the base board is present.

CDI_BOARD_SECOND_STATION_GROUP

0x0002

Station group on the first station interface module is present.

CDI_BOARD_THIRD_STATION_GROUP

0x0004

Station group on the second station interface module is present.

CDI_BOARD_REAR_BOARD

0x0008

CX 2000C rear transition board is present.

thermometer_presence field (corresponds to each sensor)

Value

Description

CDI_THERMOMETER_0_POPULATED

0x0001

Thermometer 0 is enabled.

CDI_THERMOMETER_1_POPULATED

0x0002

Thermometer 1 is enabled.

CDI_THERMOMETER_2_POPULATED

0x0004

Thermometer 2 is enabled.

CDI_THERMOMETER_3_POPULATED

0x0008

Thermometer 3 is enabled.

CDI_THERMOMETER_4_POPULATED

0x0010

Thermometer 4 is enabled.

thermal_state field

Value1

Description

CDI_THERMAL_NORMAL

0x0001

Temperature is within normal operating range.

CDI_THERMAL_WARNING

0x0002

Temperature has reached warning range.

CDI_THERMAL_PROTECTION

0x0003

Temperature has reached protection range.

1 These values cannot be combined.

hmic_error field

Value

Description

[no error]

0

CDI_HMIC_ERROR_SYSTEM

0x0001

Reserved.

CDI_HMIC_ERROR_CLOCK

0x0002

Reserved.

CDI_BSP_SYNC_ERROR

0x0004

A clock error was detected and resynchronization was done.

slic_error[0] to slic_error[2] is an 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.

For more information about monitoring board status, refer to Chapter 4.

See Also

cdiStartStatusMonitoring, cdiStopStatusMonitoring



Table of Contents Index NMS Glossary Previous Page Next Page (Page 5 of 20 in this chapter) Version


Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2000, Natural MicroSystems, Inc. All rights reserved.