rte_pmd_ixgbe.h File Reference

#include <rte_ethdev.h>

Go to the source code of this file.

Data Structures
struct	rte_pmd_ixgbe_mb_event_param

Enumerations
enum	rte_pmd_ixgbe_mb_event_rsp { RTE_PMD_IXGBE_MB_EVENT_NOOP_ACK, RTE_PMD_IXGBE_MB_EVENT_NOOP_NACK, RTE_PMD_IXGBE_MB_EVENT_PROCEED, RTE_PMD_IXGBE_MB_EVENT_MAX }

Functions
int	rte_pmd_ixgbe_set_vf_mac_addr (uint8_t port, uint16_t vf, struct ether_addr *mac_addr)
int	rte_pmd_ixgbe_set_vf_vlan_anti_spoof (uint8_t port, uint16_t vf, uint8_t on)
int	rte_pmd_ixgbe_set_vf_mac_anti_spoof (uint8_t port, uint16_t vf, uint8_t on)
int	rte_pmd_ixgbe_set_vf_vlan_insert (uint8_t port, uint16_t vf, uint16_t vlan_id)
int	rte_pmd_ixgbe_set_tx_loopback (uint8_t port, uint8_t on)
int	rte_pmd_ixgbe_set_all_queues_drop_en (uint8_t port, uint8_t on)
int	rte_pmd_ixgbe_set_vf_split_drop_en (uint8_t port, uint16_t vf, uint8_t on)
int	rte_pmd_ixgbe_set_vf_vlan_stripq (uint8_t port, uint16_t vf, uint8_t on)
int	rte_pmd_ixgbe_macsec_enable (uint8_t port, uint8_t en, uint8_t rp)
int	rte_pmd_ixgbe_macsec_disable (uint8_t port)
int	rte_pmd_ixgbe_macsec_config_txsc (uint8_t port, uint8_t *mac)
int	rte_pmd_ixgbe_macsec_config_rxsc (uint8_t port, uint8_t *mac, uint16_t pi)
int	rte_pmd_ixgbe_macsec_select_txsa (uint8_t port, uint8_t idx, uint8_t an, uint32_t pn, uint8_t *key)
int	rte_pmd_ixgbe_macsec_select_rxsa (uint8_t port, uint8_t idx, uint8_t an, uint32_t pn, uint8_t *key)
int	rte_pmd_ixgbe_set_vf_rxmode (uint8_t port, uint16_t vf, uint16_t rx_mask, uint8_t on)
int	rte_pmd_ixgbe_set_vf_rx (uint8_t port, uint16_t vf, uint8_t on)
int	rte_pmd_ixgbe_set_vf_tx (uint8_t port, uint16_t vf, uint8_t on)
int	rte_pmd_ixgbe_set_vf_vlan_filter (uint8_t port, uint16_t vlan, uint64_t vf_mask, uint8_t vlan_on)
int	rte_pmd_ixgbe_set_vf_rate_limit (uint8_t port, uint16_t vf, uint16_t tx_rate, uint64_t q_msk)

Detailed Description

ixgbe PMD specific functions.

Definition in file rte_pmd_ixgbe.h.

Enumeration Type Documentation

enum rte_pmd_ixgbe_mb_event_rsp

Response sent back to ixgbe driver from user app after callback

Enumerator:

RTE_PMD_IXGBE_MB_EVENT_NOOP_ACK	skip mbox request and ACK
RTE_PMD_IXGBE_MB_EVENT_NOOP_NACK	skip mbox request and NACK
RTE_PMD_IXGBE_MB_EVENT_PROCEED	proceed with mbox request
RTE_PMD_IXGBE_MB_EVENT_MAX	max value of this enum

Definition at line 396 of file rte_pmd_ixgbe.h.

Function Documentation

int rte_pmd_ixgbe_set_vf_mac_addr	(	uint8_t	port,
		uint16_t	vf,
		struct ether_addr *	mac_addr
	)

Set the VF MAC address.

Parameters

port	The port identifier of the Ethernet device.
vf	VF id.
mac_addr	VF MAC address.

Returns

• (0) if successful.
• (-ENODEV) if port invalid.
• (-EINVAL) if vf or mac_addr is invalid.

int rte_pmd_ixgbe_set_vf_vlan_anti_spoof	(	uint8_t	port,
		uint16_t	vf,
		uint8_t	on
	)

Enable/Disable VF VLAN anti spoofing.

Parameters

port	The port identifier of the Ethernet device.
vf	VF on which to set VLAN anti spoofing.
on	1 - Enable VFs VLAN anti spoofing. 0 - Disable VFs VLAN anti spoofing.

Returns

• (0) if successful.
• (-ENODEV) if port invalid.
• (-EINVAL) if bad parameter.

int rte_pmd_ixgbe_set_vf_mac_anti_spoof	(	uint8_t	port,
		uint16_t	vf,
		uint8_t	on
	)

Enable/Disable VF MAC anti spoofing.

Parameters

port	The port identifier of the Ethernet device.
vf	VF on which to set MAC anti spoofing.
on	1 - Enable VFs MAC anti spoofing. 0 - Disable VFs MAC anti spoofing.

Returns

• (0) if successful.
• (-ENODEV) if port invalid.
• (-EINVAL) if bad parameter.

int rte_pmd_ixgbe_set_vf_vlan_insert	(	uint8_t	port,
		uint16_t	vf,
		uint16_t	vlan_id
	)

Enable/Disable vf vlan insert

Parameters

port	The port identifier of the Ethernet device.
vf	ID specifying VF.
vlan_id	0 - Disable VF's vlan insert. n - Enable; n is inserted as the vlan id.

Returns

• (0) if successful.
• (-ENODEV) if port invalid.
• (-EINVAL) if bad parameter.

int rte_pmd_ixgbe_set_tx_loopback	(	uint8_t	port,
		uint8_t	on
	)

Enable/Disable tx loopback

Parameters

port	The port identifier of the Ethernet device.
on	1 - Enable tx loopback. 0 - Disable tx loopback.

Returns

• (0) if successful.
• (-ENODEV) if port invalid.
• (-EINVAL) if bad parameter.

int rte_pmd_ixgbe_set_all_queues_drop_en	(	uint8_t	port,
		uint8_t	on
	)

set all queues drop enable bit

Parameters

port	The port identifier of the Ethernet device.
on	1 - set the queue drop enable bit for all pools. 0 - reset the queue drop enable bit for all pools.

Returns

• (0) if successful.
• (-ENODEV) if port invalid.
• (-EINVAL) if bad parameter.

int rte_pmd_ixgbe_set_vf_split_drop_en	(	uint8_t	port,
		uint16_t	vf,
		uint8_t	on
	)

set drop enable bit in the VF split rx control register

Parameters

port	The port identifier of the Ethernet device.
vf	ID specifying VF.
on	1 - set the drop enable bit in the split rx control register. 0 - reset the drop enable bit in the split rx control register.

Returns

• (0) if successful.
• (-ENODEV) if port invalid.
• (-EINVAL) if bad parameter.

int rte_pmd_ixgbe_set_vf_vlan_stripq	(	uint8_t	port,
		uint16_t	vf,
		uint8_t	on
	)

Enable/Disable vf vlan strip for all queues in a pool

Parameters

port	The port identifier of the Ethernet device.
vf	ID specifying VF.
on	1 - Enable VF's vlan strip on RX queues. 0 - Disable VF's vlan strip on RX queues.

Returns

• (0) if successful.
• (-ENOTSUP) if hardware doesn't support this feature.
• (-ENODEV) if port invalid.
• (-EINVAL) if bad parameter.

int rte_pmd_ixgbe_macsec_enable	(	uint8_t	port,
		uint8_t	en,
		uint8_t	rp
	)

Enable MACsec offload.

Parameters

port	The port identifier of the Ethernet device.
en	1 - Enable encryption (encrypt and add integrity signature). 0 - Disable encryption (only add integrity signature).
rp	1 - Enable replay protection. 0 - Disable replay protection.

Returns

• (0) if successful.
• (-ENODEV) if port invalid.
• (-ENOTSUP) if hardware doesn't support this feature.

int rte_pmd_ixgbe_macsec_disable

(

uint8_t

port

)

Disable MACsec offload.

Parameters

port	The port identifier of the Ethernet device.

Returns

• (0) if successful.
• (-ENODEV) if port invalid.
• (-ENOTSUP) if hardware doesn't support this feature.

int rte_pmd_ixgbe_macsec_config_txsc	(	uint8_t	port,
		uint8_t *	mac
	)

Configure Tx SC (Secure Connection).

Parameters

port	The port identifier of the Ethernet device.
mac	The MAC address on the local side.

Returns

• (0) if successful.
• (-ENODEV) if port invalid.
• (-ENOTSUP) if hardware doesn't support this feature.

int rte_pmd_ixgbe_macsec_config_rxsc	(	uint8_t	port,
		uint8_t *	mac,
		uint16_t	pi
	)

Configure Rx SC (Secure Connection).

Parameters

port	The port identifier of the Ethernet device.
mac	The MAC address on the remote side.
pi	The PI (port identifier) on the remote side.

Returns

• (0) if successful.
• (-ENODEV) if port invalid.
• (-ENOTSUP) if hardware doesn't support this feature.

int rte_pmd_ixgbe_macsec_select_txsa	(	uint8_t	port,
		uint8_t	idx,
		uint8_t	an,
		uint32_t	pn,
		uint8_t *	key
	)

Enable Tx SA (Secure Association).

Parameters

port	The port identifier of the Ethernet device.
idx	The SA to be enabled (0 or 1).
an	The association number on the local side.
pn	The packet number on the local side.
key	The key on the local side.

Returns

• (0) if successful.
• (-ENODEV) if port invalid.
• (-ENOTSUP) if hardware doesn't support this feature.
• (-EINVAL) if bad parameter.

int rte_pmd_ixgbe_macsec_select_rxsa	(	uint8_t	port,
		uint8_t	idx,
		uint8_t	an,
		uint32_t	pn,
		uint8_t *	key
	)

Enable Rx SA (Secure Association).

Parameters

port	The port identifier of the Ethernet device.
idx	The SA to be enabled (0 or 1)
an	The association number on the remote side.
pn	The packet number on the remote side.
key	The key on the remote side.

Returns

• (0) if successful.
• (-ENODEV) if port invalid.
• (-ENOTSUP) if hardware doesn't support this feature.
• (-EINVAL) if bad parameter.

int rte_pmd_ixgbe_set_vf_rxmode	(	uint8_t	port,
		uint16_t	vf,
		uint16_t	rx_mask,
		uint8_t	on
	)

Set RX L2 Filtering mode of a VF of an Ethernet device.

Parameters

port	The port identifier of the Ethernet device.
vf	VF id.
rx_mask	The RX mode mask, which is one or more of accepting Untagged Packets, packets that match the PFUTA table, Broadcast and Multicast Promiscuous. ETH_VMDQ_ACCEPT_UNTAG,ETH_VMDQ_ACCEPT_HASH_UC, ETH_VMDQ_ACCEPT_BROADCAST and ETH_VMDQ_ACCEPT_MULTICAST will be used in rx_mode.
on	1 - Enable a VF RX mode. 0 - Disable a VF RX mode.

Returns

• (0) if successful.
• (-ENOTSUP) if hardware doesn't support.
• (-ENODEV) if port_id invalid.
• (-EINVAL) if bad parameter.

Examples:

examples/ethtool/lib/rte_ethtool.c.

int rte_pmd_ixgbe_set_vf_rx	(	uint8_t	port,
		uint16_t	vf,
		uint8_t	on
	)

Enable or disable a VF traffic receive of an Ethernet device.

Parameters

port	The port identifier of the Ethernet device.
vf	VF id.
on	1 - Enable a VF traffic receive. 0 - Disable a VF traffic receive.

Returns

• (0) if successful.
• (-ENOTSUP) if hardware doesn't support.
• (-ENODEV) if port_id invalid.
• (-EINVAL) if bad parameter.

int rte_pmd_ixgbe_set_vf_tx	(	uint8_t	port,
		uint16_t	vf,
		uint8_t	on
	)

Enable or disable a VF traffic transmit of the Ethernet device.

Parameters

port	The port identifier of the Ethernet device.
vf	VF id.
on	1 - Enable a VF traffic transmit. 0 - Disable a VF traffic transmit.

Returns

• (0) if successful.
• (-ENODEV) if port_id invalid.
• (-ENOTSUP) if hardware doesn't support.
• (-EINVAL) if bad parameter.

int rte_pmd_ixgbe_set_vf_vlan_filter	(	uint8_t	port,
		uint16_t	vlan,
		uint64_t	vf_mask,
		uint8_t	vlan_on
	)

Enable/Disable hardware VF VLAN filtering by an Ethernet device of received VLAN packets tagged with a given VLAN Tag Identifier.

Parameters

port	The port identifier of the Ethernet device.
vlan	The VLAN Tag Identifier whose filtering must be enabled or disabled.
vf_mask	Bitmap listing which VFs participate in the VLAN filtering.
vlan_on	1 - Enable VFs VLAN filtering. 0 - Disable VFs VLAN filtering.

Returns

• (0) if successful.
• (-ENOTSUP) if hardware doesn't support.
• (-ENODEV) if port_id invalid.
• (-EINVAL) if bad parameter.

int rte_pmd_ixgbe_set_vf_rate_limit	(	uint8_t	port,
		uint16_t	vf,
		uint16_t	tx_rate,
		uint64_t	q_msk
	)

Set the rate limitation for a vf on an Ethernet device.

Parameters

port	The port identifier of the Ethernet device.
vf	VF id.
tx_rate	The tx rate allocated from the total link speed for this VF id.
q_msk	The queue mask which need to set the rate.

Returns

• (0) if successful.
• (-ENOTSUP) if hardware doesn't support this feature.
• (-ENODEV) if port_id invalid.
• (-EINVAL) if bad parameter.