GxSmuGetStatusRegister

Applies To

GX3104, GX3116e

Purpose

Returns the board status register.

Syntax

GxSmuGetStatusRegister (nHandle, pdwStatusRegister, pnStatus)

Parameters

Name
Type
Description
nHandle
SHORT
Handle to a GX3104 or GX3116e board.
pdwStatusRegister
PDWORD
GX3104:
Returns the board thermal shutdown status, bits descriptions are as follows:
Bit 0: One or more channels is in thermal shutdown and all relays have been open.
Bit 1: Channel A is in thermal shutdown and all relays have been open.
Bit 2: Channel B is in thermal shutdown and all relays have been open.
Bit 3: Channel C is in thermal shutdown and all relays have been open.
Bit 4: Channel D is in thermal shutdown and all relays have been open.
GX3116e:
Bits 0-15: each channel’s over temperature status, bits 0 represents channel 1.
Bit 16: External Inhibit for channels 1-8, 1= External Inhibit is active
Bit 17: External Inhibit for channels 9-16, 1= External Inhibit is active
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

GX3104:

The function returns the board thermal shutdown status.

In order to continue, the user needs to call the GxSmuReset() API.

The function is supported by PCB Rev E and above. Use the GxSmuGetBoardSummary() API, to check the board’s PCB rev.

GX3116e:

In case of over temperature, the user can call GxSmuClearFaults() API to clear any over temperature faults.

Example

The following example returns the board status register:

 

SHORT  nBoardType, nStatus;

DWORD  dwStatusRegister;

GxSmuGetStatusRegister (nHandle, & dwStatusRegister, &nStatus);

 

See Also

GxSmuInitialize, GxSmuGetBoardSummary, GxSmuGetErrorString, GxSmuGetThermalOverloadStatus