doc: fix naming of NVIDIA devices
Checks
Commit Message
The networking NVIDIA devices may be named as the following,
using 0 and Ax as fake suffixes:
- ConnectX-0
- ConnectX-0 Ax
- BlueField-0
Casing and missing hyphens are fixed to avoid future wrong copy/paste.
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
doc/guides/nics/mlx5.rst | 8 ++++----
doc/guides/platform/bluefield.rst | 2 +-
doc/guides/rel_notes/release_20_08.rst | 2 +-
doc/guides/rel_notes/release_20_11.rst | 2 +-
doc/guides/rel_notes/release_21_02.rst | 4 ++--
doc/guides/rel_notes/release_21_05.rst | 2 +-
doc/guides/rel_notes/release_21_08.rst | 2 +-
doc/guides/rel_notes/release_21_11.rst | 4 ++--
doc/guides/rel_notes/release_22_03.rst | 2 +-
doc/guides/rel_notes/release_22_07.rst | 4 ++--
drivers/net/mlx5/mlx5_mac.c | 2 +-
11 files changed, 17 insertions(+), 17 deletions(-)
Comments
Hi,
> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Tuesday, March 7, 2023 5:28 PM
> To: dev@dpdk.org
> Cc: Matan Raz <mraz@nvidia.com>; Gal Cohen (ProdM) <galco@nvidia.com>;
> Asaf Penso <asafp@nvidia.com>; Raslan Darawsheh <rasland@nvidia.com>;
> Matan Azrad <matan@nvidia.com>; Slava Ovsiienko <viacheslavo@nvidia.com>
> Subject: [PATCH] doc: fix naming of NVIDIA devices
>
> The networking NVIDIA devices may be named as the following, using 0 and Ax
> as fake suffixes:
> - ConnectX-0
> - ConnectX-0 Ax
> - BlueField-0
>
> Casing and missing hyphens are fixed to avoid future wrong copy/paste.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Patch applied to next-net-mlx,
Kindest regards,
Raslan Darawsheh
@@ -150,7 +150,7 @@ Limitations
- Host shaper:
- - Support BlueField series NIC from BlueField 2.
+ - Support BlueField series NIC from BlueField-2.
- When configuring host shaper with MLX5_HOST_SHAPER_FLAG_AVAIL_THRESH_TRIGGERED flag set,
only rates 0 and 100Mbps are supported.
@@ -398,9 +398,9 @@ Limitations
- E-Switch Manager matching:
- - For Bluefield with old FW
+ - For BlueField with old FW
which doesn't expose the E-Switch Manager vport ID in the capability,
- matching E-Switch Manager should be used only in Bluefield embedded CPU mode.
+ matching E-Switch Manager should be used only in BlueField embedded CPU mode.
- Raw encapsulation:
@@ -1916,7 +1916,7 @@ Then the PMD call the callback registered previously,
which will delay a while to let Rx queue empty,
then disable host shaper.
-Let's assume we have a simple BlueField 2 setup:
+Let's assume we have a simple BlueField-2 setup:
port 0 is uplink, port 1 is VF representor.
Each port has 2 Rx queues.
To control traffic from the host to the Arm device,
@@ -18,7 +18,7 @@ and common offload HW drivers of **NVIDIA BlueField** family SoC.
Supported BlueField Platforms
-----------------------------
-- `BlueField 2 <https://docs.nvidia.com/networking/display/BlueField2DPUENUG/Introduction>`_
+- `BlueField-2 <https://docs.nvidia.com/networking/display/BlueField2DPUENUG/Introduction>`_
Common Offload HW Drivers
@@ -466,7 +466,7 @@ Tested Platforms
* Mellanox\ |reg| BlueField\ |reg| SmartNIC
- * Mellanox\ |reg| BlueField\ |reg| 2 SmartNIC MT41686 - MBF2H332A-AEEOT (2x25G)
+ * Mellanox\ |reg| BlueField\ |reg|-2 SmartNIC MT41686 - MBF2H332A-AEEOT (2x25G)
* Host interface: PCI Express 3.0 x16
* Device ID: 15b3:a2d2
@@ -880,7 +880,7 @@ Tested Platforms
* Mellanox\ |reg| BlueField\ |reg| SmartNIC
- * Mellanox\ |reg| BlueField\ |reg| 2 SmartNIC MT41686 - MBF2H332A-AEEOT (2x25G)
+ * Mellanox\ |reg| BlueField\ |reg|-2 SmartNIC MT41686 - MBF2H332A-AEEOT (2x25G)
* Host interface: PCI Express 3.0 x16
* Device ID: 15b3:a2d2
@@ -135,7 +135,7 @@ New Features
* **Added mlx5 compress PMD.**
- Added a new compress PMD for Bluefield 2 adapters.
+ Added a new compress PMD for BlueField-2 adapters.
See the :doc:`../compressdevs/mlx5` for more details.
@@ -443,7 +443,7 @@ Tested Platforms
* Mellanox\ |reg| BlueField\ |reg| SmartNIC
- * Mellanox\ |reg| BlueField\ |reg| 2 SmartNIC MT41686 - MBF2H332A-AEEOT (2x25G)
+ * Mellanox\ |reg| BlueField\ |reg|-2 SmartNIC MT41686 - MBF2H332A-AEEOT (2x25G)
* Host interface: PCI Express 3.0 x16
* Device ID: 15b3:a2d2
@@ -566,7 +566,7 @@ Tested Platforms
* Mellanox\ |reg| BlueField\ |reg| SmartNIC
- * Mellanox\ |reg| BlueField\ |reg| 2 SmartNIC MT41686 - MBF2H332A-AEEOT_A1 (2x25G)
+ * Mellanox\ |reg| BlueField\ |reg|-2 SmartNIC MT41686 - MBF2H332A-AEEOT_A1 (2x25G)
* Host interface: PCI Express 3.0 x16
* Device ID: 15b3:a2d2
@@ -392,7 +392,7 @@ Tested Platforms
* Mellanox\ |reg| BlueField\ |reg| SmartNIC
- * Mellanox\ |reg| BlueField\ |reg| 2 SmartNIC MT41686 - MBF2H332A-AEEOT_A1 (2x25G)
+ * Mellanox\ |reg| BlueField\ |reg|-2 SmartNIC MT41686 - MBF2H332A-AEEOT_A1 (2x25G)
* Host interface: PCI Express 3.0 x16
* Device ID: 15b3:a2d6
@@ -272,7 +272,7 @@ New Features
* **Updated Mellanox mlx5 crypto driver.**
* Added Windows support.
- * Added support for BlueField 2 and ConnectX-6 Dx.
+ * Added support for BlueField-2 and ConnectX-6 Dx.
* **Updated NXP dpaa_sec crypto PMD.**
@@ -828,7 +828,7 @@ Tested Platforms
* Mellanox\ |reg| BlueField\ |reg| SmartNIC
- * Mellanox\ |reg| BlueField\ |reg| 2 SmartNIC MT41686 - MBF2H332A-AEEOT_A1 (2x25G)
+ * Mellanox\ |reg| BlueField\ |reg|-2 SmartNIC MT41686 - MBF2H332A-AEEOT_A1 (2x25G)
* Host interface: PCI Express 3.0 x16
* Device ID: 15b3:a2d6
@@ -447,7 +447,7 @@ Tested Platforms
* Mellanox\ |reg| BlueField\ |reg| SmartNIC
- * Mellanox\ |reg| BlueField\ |reg| 2 SmartNIC MT41686 - MBF2H332A-AEEOT_A1 (2x25G)
+ * Mellanox\ |reg| BlueField\ |reg|-2 SmartNIC MT41686 - MBF2H332A-AEEOT_A1 (2x25G)
* Host interface: PCI Express 3.0 x16
* Device ID: 15b3:a2d6
@@ -451,7 +451,7 @@ Tested Platforms
* Device ID: 15b3:101f
* Firmware version: 26.33.1048 and above
- * NVIDIA\ |reg| ConnectX\ |reg| 7 200G CX713106AE-HEA_QP1_Ax (2x200G)
+ * NVIDIA\ |reg| ConnectX\ |reg|-7 200G CX713106AE-HEA_QP1_Ax (2x200G)
* Host interface: PCI Express 5.0 x16
* Device ID: 15b3:1021
@@ -459,7 +459,7 @@ Tested Platforms
* NVIDIA \ |reg| BlueField\ |reg| SmartNIC
- * NVIDIA\ |reg| BlueField\ |reg| 2 SmartNIC MT41686 - MBF2H332A-AEEOT_A1 (2x25G)
+ * NVIDIA\ |reg| BlueField\ |reg|-2 SmartNIC MT41686 - MBF2H332A-AEEOT_A1 (2x25G)
* Host interface: PCI Express 3.0 x16
* Device ID: 15b3:a2d6
@@ -157,7 +157,7 @@ mlx5_mac_addr_set(struct rte_eth_dev *dev, struct rte_ether_addr *mac_addr)
/*
* Configuring the VF instead of its representor,
- * need to skip the special case of HPF on Bluefield.
+ * need to skip the special case of HPF on BlueField.
*/
if (priv->representor && !mlx5_is_hpf(dev) && !mlx5_is_sf_repr(dev)) {
DRV_LOG(DEBUG, "VF represented by port %u setting primary MAC address",