1.4.3.27 PAL_GetAGC Function

C

uint8_t PAL_GetAGC(uint16_t pch, uint8_t *mode, uint8_t *gain);

Summary

Get the Automatic Gain mode of the PHY PLC layer.

Description

This routine is used to get Automatic Gain mode (AGC) of the PHY PLC layer.

Precondition

The PAL_Initialize function should have been called before calling this function.

Parameters

ParametersDescription
pchPhysical channel
modeAuto/Manual mode
gainInitial receiving gain in Auto mode

Returns

  • PAL_CFG_SUCCESS: If successful
  • PAL_CFG_INVALID_INPUT: If unsuccessful

Example

 
    uint8_t result=PAL_CFG_SUCCESS;
    uint8_t mode=0;
    uint8_t gain=0;
    uint16_t pch=1;

    result = PAL_GetAGC(pch, &mode, &gain);

Remarks

Not available for PHY Serial and PHY RF.