SRV_PCOUP_Set_Config Function

C

bool SRV_PCOUP_Set_Config(DRV_HANDLE handle, SRV_PLC_PCOUP_BRANCH branch);

Summary

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

Description

This function allows to set the PLC PHY Coupling parameters for the specified transmission branch, using the PLC Driver PIB interface (DRV_PLC_PHY_PIBSet or DRV_G3_MACRT_PIBSet).

Precondition

The PLC driver's open routine (DRV_PLC_PHY_Open or DRV_G3_MACRT_Open) must have been called to obtain a valid opened device handle.

Parameters


Param	Description
handle	A valid instance handle, returned from the PLC driver's open routine
branch	Transmission branch (SRV_PLC_PCOUP_BRANCH Enum) for which the parameters will be set

Returns

true
- Successful configuration
false
- if branch parameter is not valid
- if there is an error when using the PLC Driver PIB interface

Example

// 'handle', returned from DRV_PLC_PHY_Open or DRV_G3_MACRT_Open
bool result;

result = SRV_PCOUP_Set_Config(handle, SRV_PLC_PCOUP_MAIN_BRANCH);

Remarks

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