ETHFW API Guide

Introduction

Data Structures

struct  EthFwVirtPort_VirtPortCfg
 Ethernet Firmware virtual port configuration. More...
 

Functions

static bool EthFwVirtPort_isSwitchPort (EthRemoteCfg_VirtPort portId)
 Check whether port is a virtual switch port or not. More...
 
static bool EthFwVirtPort_isMacPort (EthRemoteCfg_VirtPort portId)
 Check whether port is a virtual MAC port or not. More...
 
static uint32_t EthFwVirtPort_getPortNum (EthRemoteCfg_VirtPort portId)
 Get virtual port number. More...
 
static Enet_MacPort EthFwVirtPort_getMacPort (EthRemoteCfg_VirtPort portId)
 Get Enet MAC port number corresponding to a virtual port id. More...
 

Function Documentation

◆ EthFwVirtPort_isSwitchPort()

static bool EthFwVirtPort_isSwitchPort ( EthRemoteCfg_VirtPort  portId)
inlinestatic

Check whether port is a virtual switch port or not.

Parameters
portId[in] Virtual port id.
Returns
true if virtual switch port, false otherwise.

◆ EthFwVirtPort_isMacPort()

static bool EthFwVirtPort_isMacPort ( EthRemoteCfg_VirtPort  portId)
inlinestatic

Check whether port is a virtual MAC port or not.

Parameters
portId[in] Virtual port id.
Returns
true if virtual MAC port, false otherwise.

◆ EthFwVirtPort_getPortNum()

static uint32_t EthFwVirtPort_getPortNum ( EthRemoteCfg_VirtPort  portId)
inlinestatic

Get virtual port number.

Gets the port number of a virtual port. Virtual switch ports numbers are 0-relative and virtual MAC ports are 1-relative.

Parameters
portId[in] Virtual port id.
Returns
Port number.

◆ EthFwVirtPort_getMacPort()

static Enet_MacPort EthFwVirtPort_getMacPort ( EthRemoteCfg_VirtPort  portId)
inlinestatic

Get Enet MAC port number corresponding to a virtual port id.

Gets the Enet MAC port number corresponding to a virtual MAC port. It will return ENET_MAC_PORT_INV for virtual switch ports.

The returned value of this function could be used as is to populate the port number used for TX directed packets.

Parameters
portIdVirtual port id.
Returns
Enet MAC port number for virtual MAC ports, ENET_MAC_PORT_INV for virtual switch ports.