X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fnics%2Ffeatures.rst;h=f6d30d0af3207a395ce77ebf99f5f4caef2c7fba;hb=50c383793b7b377ed9f733a779976447dbfd8bda;hp=234bf066b9f6f202ac63d8e4e3d085d88c6835ab;hpb=68d99d00ae7adc05791625c5e478deb34fd3f4fd;p=dpdk.git diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst index 234bf066b9..f6d30d0af3 100644 --- a/doc/guides/nics/features.rst +++ b/doc/guides/nics/features.rst @@ -261,7 +261,7 @@ Supports enabling/disabling receiving multicast frames. Unicast MAC filter ------------------ -Supports adding MAC addresses to enable whitelist filtering to accept packets. +Supports adding MAC addresses to enable incoming filtering of packets. * **[implements] eth_dev_ops**: ``mac_addr_set``, ``mac_addr_add``, ``mac_addr_remove``. * **[implements] rte_eth_dev_data**: ``mac_addrs``. @@ -402,9 +402,9 @@ Supports configuring link flow control. Flow API -------- -Supports the DPDK Flow API for generic filtering. +Supports flow API family. -* **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_GENERIC``. +* **[implements] eth_dev_ops**: ``flow_ops_get``. * **[implements] rte_flow_ops**: ``All``. @@ -518,6 +518,21 @@ Supports QinQ (queue in queue) offload. ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_QINQ_INSERT``. +.. _nic_features_fec: + +FEC +--- + +Supports Forward error correction. Forward error correction (FEC) is a bit error correction mode. +It adds error correction information to data packets at the transmit end, and uses the error correction +information to correct the bit errors generated during data packet transmission at the receive end. This +improves signal quality but also brings a delay to signals. This function can be enabled or disabled as required. + +* **[implements] eth_dev_ops**: ``fec_get_capability``, ``fec_get``, ``fec_set``. +* **[provides] rte_eth_fec_capa**: ``speed:ETH_SPEED_NUM_*``, ``capa:RTE_ETH_FEC_MODE_TO_CAPA()``. +* **[related] API**: ``rte_eth_fec_get_capability()``, ``rte_eth_fec_get()``, ``rte_eth_fec_set()``. + + .. _nic_features_l3_checksum_offload: L3 checksum offload @@ -597,7 +612,7 @@ Supports inner packet L3 checksum. ``mbuf.ol_flags:PKT_TX_OUTER_IP_CKSUM``, ``mbuf.ol_flags:PKT_TX_OUTER_IPV4`` | ``PKT_TX_OUTER_IPV6``. * **[uses] mbuf**: ``mbuf.outer_l2_len``, ``mbuf.outer_l3_len``. -* **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_EIP_CKSUM_BAD``. +* **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_OUTER_IP_CKSUM_BAD``. * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM``, ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM``. @@ -785,38 +800,28 @@ Multiprocess aware Driver can be used for primary-secondary process model. -.. _nic_features_bsd_nic_uio: +.. _nic_features_freebsd: -BSD nic_uio ------------ +FreeBSD +------- -BSD ``nic_uio`` module supported. +Supports running on FreeBSD. -.. _nic_features_linux_uio: +.. _nic_features_linux: -Linux UIO ---------- - -Works with ``igb_uio`` kernel module. - -* **[provides] RTE_PMD_REGISTER_KMOD_DEP**: ``igb_uio``. - -.. _nic_features_linux_vfio: - -Linux VFIO ----------- +Linux +----- -Works with ``vfio-pci`` kernel module. +Supports running on Linux. -* **[provides] RTE_PMD_REGISTER_KMOD_DEP**: ``vfio-pci``. -.. _nic_features_other_kdrv: +.. _nic_features_windows: -Other kdrv ----------- +Windows +------- -Kernel module other than above ones supported. +Supports running on Windows. .. _nic_features_armv7: @@ -929,11 +934,8 @@ Other dev ops not represented by a Feature * ``vlan_strip_queue_set`` * ``vlan_pvid_set`` * ``rx_queue_count`` -* ``l2_tunnel_offload_set`` * ``uc_hash_table_set`` * ``uc_all_hash_table_set`` * ``udp_tunnel_port_add`` * ``udp_tunnel_port_del`` -* ``l2_tunnel_eth_type_conf`` -* ``l2_tunnel_offload_set`` * ``tx_pkt_prepare``