1.4.3.8 PAL_PLC_GetMacRtPib Function
C
PAL_PLC_PIB_RESULT PAL_PLC_GetMacRtPib(PAL_PLC_HANDLE handle, MAC_RT_PIB_OBJ *pibObj);
Summary
Gets value of G3 MAC-RT or G3 PHY PIB attribute.
Description
This routine allows a client to get information from PLC transceiver about MAC-RT and PHY information base (PIB).
Precondition
PAL_PLC_HandleGet must have been called to obtain a valid PLC PAL handle.
Parameters
Param | Description |
---|---|
handle | A valid handle, returned from PAL_PLC_HandleGet. |
pibObj | Pointer to PIB object to indicate the PIB to read. PIB object includes a data buffer to store the read value. |
Returns
Result of getting the PIB (see PAL_PLC_PIB_RESULT).
Example
// 'palPlcHandle', returned from the PAL_PLC_HandleGet
MAC_RT_PIB_OBJ pibObj;
uint32_t phyVersion;
pibObj.pib = MAC_RT_PIB_MANUF_PHY_PARAM;
pibObj.index = PHY_PIB_VERSION_NUM;
pibObj.length = 4;
if (PAL_PLC_GetMacRtPib(palPlcHandle, &pibObj) == PAL_PLC_PIB_SUCCESS)
{
phyVersion = *(uint32_t *)appPlcData.pibObj.pData;
}
Remarks
None.