SRV_PCOUP_Get_Config Function

C

SRV_PLC_PCOUP_DATA * SRV_PCOUP_Get_Config(SRV_PLC_PCOUP_BRANCH branch);

Summary

Get the PLC PHY Coupling parameters for the specified transmission branch.

Description

This function allows to get the PLC PHY Coupling parameters for the specified transmission branch. These parameters can be sent to the PLC device through PLC Driver PIB interface (DRV_PLC_PHY_PIBSet or DRV_G3_MACRT_PIBSet).

Precondition

None.

Parameters


Param	Description
branch	Transmission branch (SRV_PLC_PCOUP_BRANCH Enum) for which the parameters are requested

Returns

Pointer to SRV_PLC_PCOUP_DATA Struct, containing the PLC PHY Coupling parameters
- if branch parameter is valid
NULL
- if branch parameter is not valid

Example

SRV_PLC_PCOUP_DATA *pCoupValues;

pCoupValues = SRV_PCOUP_Get_Config(SRV_PLC_PCOUP_MAIN_BRANCH);

Remarks

This function is only generated by MCC if the PLC Driver uses G3-PLC PHY.

If SRV_PCOUP_Set_Config function is used to set the PLC PHY Coupling parameters, this function is not needed.