GxSmuGetStatusRegisterChannel

Applies To

GX3116e

Purpose

Returns the board specified channel’s status register.

Syntax

GxSmuGetStatusRegisterChannel (nHandle, nChannel, pdwStatusRegister, pnStatus)

Parameters

Name	Type	Description
nHandle	SHORT	Handle to a GX3116e board.
nChannel	SHORT	GX3116e: Specified channel number (0-15) is GX3116e_CHANNEL_1 to GX3116_CHANNEL_16
pdwStatusRegister	PDWORD	Returns the board specified channel’s status register (see comments for details): Channel mode in Constant Voltage: Bit 0: Raw Real Time Over Current Sink Bit 1: Real Time Over Current Sink Bit 2: Latched Over Current Sink Bit 3: Raw Real Time Over Current Source Bit 4: Real Time Over Current Source Bit 5: Latched Over Current Source Bit 6: Real Time Over Temp Bit 7: Latched Over Temp Bit 8: Group Real Time Over Temp Bit 9: Group Latched Over Temp Channel mode in Constat Current: Bit 0: Raw Real Time Over Current Sink Bit 1: Real Time Over Current Sink Bit 2: Latched Over Current Sink Bit 3: Raw Real Time Over Current Source Bit 4: Real Time Over Current Source Bit 5: Latched Over Current Source Bit 6: Real Time Over Temp Bit 7: Latched Over Temp Bit 8: Group Real Time Over Temp Bit 9: Group Latched Over Temp
pnStatus	PSHORT	Returned status: 0 on success, negative number on failure.

Comments

Channel’s operation mode is constant voltage:

Bit #	Description
0	Bit will be high if sink current exceeds sink clamp current settings at the time when the status register was read, Bit will be low if sink current does not exceed sink clamp current settings at the time when the status register was read. Bit will be active regardless if trip mode is enabled or disable
1	Bit will be high if sink current exceeded sink clamp current when status register was read, otherwise it will be set low. If trip mode is disabled this bit is set low
2	Bit will be high if sink current exceeded sink clamp current since the last time a GxSmuReset() API was called, otherwise it will be set low. If trip mode is disabled this bit is set low
3	Bit will be high if source current exceeds sink clamp current settings at the time when the status register was read, Bit will be low if source current does not exceed source clamp current settings at the time when the status register was read. Bit will be active regardless if trip mode is enabled or disable
4	Bit will be high if source current exceeded source clamp current when status register was read, otherwise it will be set low. If trip mode is disabled this bit is set low
5	Bit will be high if source current exceeded source clamp current since the last time a GxSmuReset() API was called, otherwise it will be set low. If trip mode is disabled this bit is set low
6	Internal thermal monitor, when the internal channel’s temperature exceeds +135°C was exceeded right now.
7	Internal thermal monitor, when the internal channel’s temperature exceeds +135°C was exceeded right now or since the last time a GxSmuReset() API was called.
8	One or more channels in the group of channels generated Real Time Over Temp: An internal thermal monitor, when the internal channel’s temperature exceeds +135°C was exceeded right now. Channels are grouped as follows: ch 1-8 are in one group, ch 9-16 in a second group.
9	One or more channels in the group of channels generated Latched Over Temp: An internal thermal monitor, when the internal channel’s temperature exceeds +135°C was exceeded right now or since the last time a GxSmuReset() API was called. Channels are grouped as follows: ch 1-8 are in one group, ch 9-16 in a second group.

Channel’s operation mode is constant current:

Bit #	Description
0	Bit will be high if sink current exceeds sink clamp current settings at the time when the status register was read, Bit will be low if sink current does not exceed sink clamp current settings at the time when the status register was read. Bit will be active regardless if trip mode is enable or disable
1	Bit will be high if sink current exceeded sink clamp current when status register was read, otherwise it will be set low. If trip mode is disabled this bit is set low
2	Bit will be high if sink current exceeded sink clamp current since the last time a GxSmuReset() API was called, otherwise it will be set low. If trip mode is disabled this bit is set low
3	Bit will be high if source current exceeds sink clamp current settings at the time when the status register was read, Bit will be low if source current does not exceed source clamp current settings at the time when the status register was read. Bit will be active regardless if trip mode is enable or disable
4	Bit will be high if source current exceeded source clamp current when status register was read, otherwise it will be set low. If trip mode is disabled this bit is set low
5	Bit will be high if source current exceeded source clamp current since the last time a GxSmuReset() API was called, otherwise it will be set low. If trip mode is disabled this bit is set low
6	Internal thermal monitor, when the internal channel’s temperature exceeds +135°C was exceeded right now.
7	Internal thermal monitor, when the internal channel’s temperature exceeds +135°C was exceeded right now or since the last time a GxSmuReset() API was called.
8	One or more channels in the group of channels (channels 1-8 or 9-16) generated Real Time Over Temp: An internal thermal monitor, when the internal channel’s temperature exceeds +135°C was exceeded right now.
9	One or more channels in the group of channels (channels 1-8 or 9-16) generated Latched Over Temp: An internal thermal monitor, when the internal channel’s temperature exceeds +135°C was exceeded right now or since the last time a GxSmuReset() API was called.

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

Example

The following example Returns the board channel 1 status register:

SHORT nBoardType, nStatus;

DWORD dwStatusRegisterChannel;

GxSmuGetStatusRegister (nHandle, GX3116_CHANNEL_1 , &dwStatusRegister, &nStatus);

GxSmuGetStatusRegisterChannel

Applies To

Purpose

Syntax

Parameters

Name

Type

Description

nHandle

SHORT

Handle to a GX3116e board.

nChannel

SHORT

GX3116e: Specified channel number (0-15) is GX3116e_CHANNEL_1 to GX3116_CHANNEL_16

pdwStatusRegister

PDWORD

Returns the board specified channel’s status register (see comments for details):

Channel mode in Constant Voltage:

Bit 0: Raw Real Time Over Current Sink

Bit 1: Real Time Over Current Sink

Bit 2: Latched Over Current Sink

Bit 3: Raw Real Time Over Current Source

Bit 4: Real Time Over Current Source

Bit 5: Latched Over Current Source

Bit 6: Real Time Over Temp

Bit 7: Latched Over Temp

Bit 8: Group Real Time Over Temp

Bit 9: Group Latched Over Temp

Channel mode in Constat Current:

Bit 0: Raw Real Time Over Current Sink

Bit 1: Real Time Over Current Sink

Bit 2: Latched Over Current Sink

Bit 3: Raw Real Time Over Current Source

Bit 4: Real Time Over Current Source

Bit 5: Latched Over Current Source

Bit 6: Real Time Over Temp

Bit 7: Latched Over Temp

Bit 8: Group Real Time Over Temp

Bit 9: Group Latched Over Temp

pnStatus

PSHORT

Returned status: 0 on success, negative number on failure.

Comments

Bit #

Description

0

1

Bit will be high if sink current exceeded sink clamp current when status register was read, otherwise it will be set low. If trip mode is disabled this bit is set low

2

Bit will be high if sink current exceeded sink clamp current since the last time a GxSmuReset() API was called, otherwise it will be set low. If trip mode is disabled this bit is set low

3

4

Bit will be high if source current exceeded source clamp current when status register was read, otherwise it will be set low. If trip mode is disabled this bit is set low

5

Bit will be high if source current exceeded source clamp current since the last time a GxSmuReset() API was called, otherwise it will be set low. If trip mode is disabled this bit is set low

6

Internal thermal monitor, when the internal channel’s temperature exceeds +135°C was exceeded right now.

7

Internal thermal monitor, when the internal channel’s temperature exceeds +135°C was exceeded right now or since the last time a GxSmuReset() API was called.

8

One or more channels in the group of channels generated Real Time Over Temp: An internal thermal monitor, when the internal channel’s temperature exceeds +135°C was exceeded right now. Channels are grouped as follows: ch 1-8 are in one group, ch 9-16 in a second group.

9

Bit #

Description

0

1

Bit will be high if sink current exceeded sink clamp current when status register was read, otherwise it will be set low. If trip mode is disabled this bit is set low

2

Bit will be high if sink current exceeded sink clamp current since the last time a GxSmuReset() API was called, otherwise it will be set low. If trip mode is disabled this bit is set low

3

4

Bit will be high if source current exceeded source clamp current when status register was read, otherwise it will be set low. If trip mode is disabled this bit is set low

5

Bit will be high if source current exceeded source clamp current since the last time a GxSmuReset() API was called, otherwise it will be set low. If trip mode is disabled this bit is set low

6

Internal thermal monitor, when the internal channel’s temperature exceeds +135°C was exceeded right now.

7

Internal thermal monitor, when the internal channel’s temperature exceeds +135°C was exceeded right now or since the last time a GxSmuReset() API was called.

8

One or more channels in the group of channels (channels 1-8 or 9-16) generated Real Time Over Temp: An internal thermal monitor, when the internal channel’s temperature exceeds +135°C was exceeded right now.