PM_GetAmp


C Specification

#include <nitro/spi.h>

u32 PM_GetAmp( PMAmpSwitch* swBuf );

Description

Gets the current settings of the programmable gain amp.

The value of the PMAmpSwitch enumerator type is saved in the swBuf argument and can contain either one of the following values:
PM_AMP_ON Amp is ON.
PM_AMP_OFF Amp is OFF.

This function uses PXI to send the command that performs the corresponding operation in the ARM7 processor. The ARM7 side that received that command is executed by operating the PMIC. Therefore, when you call the function, it may not operate promptly.

Before you use this function, initialize the PM library by using the PM_Init() function.

PM_Init() only has to be called once. Also, when you call OS_Init(), there is no need to call PM_Init() separately since it is called from within OS_Init().

Internal Operation

Reads the PMIC register OP_CTL value.

Arguments

swBuf buffer that saves the obtained results of the amp switch settings

Return Values

The PM_RESULT_SUCCESS return value indicates that the execution of the command has succeeded.

The PM_RESULT_ERROR return value indicates that an error has occurred in the ARM7 processor.

See Also

PM_Init, PM_SetAmp*

Revision History

08/09/2004 Initial version