SRV_PCOUP_Get_Phy_Band Function

C

uint8_t SRV_PCOUP_Get_Phy_Band(SRV_PLC_PCOUP_BRANCH branch);

Summary

Get the G3-PLC PHY band associated to the specified transmission branch.

Description

This function allows to get the G3-PLC PHY band associated to the specified transmission branch.

Precondition

None.

Returns

G3-PLC PHY band associated to the specified transmission branch (see drv_plc_phy_comm.h or drv_g3_macrt_comm.h):

  • 0: G3_CEN_A

  • 1: G3_CEN_B

  • 2: G3_FCC

  • 3: G3_ARIB

  • 0xFF: G3_INVALID (if transmission branch is not valid)

Example

uint8_t phyBand;

phyBand = SRV_PCOUP_Get_Phy_Band(SRV_PLC_PCOUP_MAIN_BRANCH);

if (phyBand == G3_CEN_A)
{
    // G3 CEN-A band
}

Remarks

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