diff mbox series

doc: fix naming of NVIDIA devices

Message ID 20230307152825.263841-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Delegated to: Raslan Darawsheh
Headers
Series doc: fix naming of NVIDIA devices |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/github-robot: build success github build: passed
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-abi-testing success Testing PASS

Commit Message

Thomas Monjalon March 7, 2023, 3:28 p.m. UTC 
  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

Raslan Darawsheh March 19, 2023, 1:31 p.m. UTC | #1 
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
diff mbox series

Patch

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 6510e74fb9..b4714c0803 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -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,
diff --git a/doc/guides/platform/bluefield.rst b/doc/guides/platform/bluefield.rst
index 09486747b1..98df515241 100644
--- a/doc/guides/platform/bluefield.rst
+++ b/doc/guides/platform/bluefield.rst
@@ -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
diff --git a/doc/guides/rel_notes/release_20_08.rst b/doc/guides/rel_notes/release_20_08.rst
index 445e40fbac..619c3dd59f 100644
--- a/doc/guides/rel_notes/release_20_08.rst
+++ b/doc/guides/rel_notes/release_20_08.rst
@@ -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
diff --git a/doc/guides/rel_notes/release_20_11.rst b/doc/guides/rel_notes/release_20_11.rst
index 7fd15398e4..76fd7372b8 100644
--- a/doc/guides/rel_notes/release_20_11.rst
+++ b/doc/guides/rel_notes/release_20_11.rst
@@ -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
diff --git a/doc/guides/rel_notes/release_21_02.rst b/doc/guides/rel_notes/release_21_02.rst
index 5fbf5b3d43..b47593b214 100644
--- a/doc/guides/rel_notes/release_21_02.rst
+++ b/doc/guides/rel_notes/release_21_02.rst
@@ -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
diff --git a/doc/guides/rel_notes/release_21_05.rst b/doc/guides/rel_notes/release_21_05.rst
index 49044ed422..4dc0573266 100644
--- a/doc/guides/rel_notes/release_21_05.rst
+++ b/doc/guides/rel_notes/release_21_05.rst
@@ -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
diff --git a/doc/guides/rel_notes/release_21_08.rst b/doc/guides/rel_notes/release_21_08.rst
index ac1c081903..369452b40b 100644
--- a/doc/guides/rel_notes/release_21_08.rst
+++ b/doc/guides/rel_notes/release_21_08.rst
@@ -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
diff --git a/doc/guides/rel_notes/release_21_11.rst b/doc/guides/rel_notes/release_21_11.rst
index db09ec01ea..b9df58734b 100644
--- a/doc/guides/rel_notes/release_21_11.rst
+++ b/doc/guides/rel_notes/release_21_11.rst
@@ -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
diff --git a/doc/guides/rel_notes/release_22_03.rst b/doc/guides/rel_notes/release_22_03.rst
index 0923707cb8..3c25561f27 100644
--- a/doc/guides/rel_notes/release_22_03.rst
+++ b/doc/guides/rel_notes/release_22_03.rst
@@ -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
diff --git a/doc/guides/rel_notes/release_22_07.rst b/doc/guides/rel_notes/release_22_07.rst
index b710ac622c..7312a29789 100644
--- a/doc/guides/rel_notes/release_22_07.rst
+++ b/doc/guides/rel_notes/release_22_07.rst
@@ -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
diff --git a/drivers/net/mlx5/mlx5_mac.c b/drivers/net/mlx5/mlx5_mac.c
index a791fedc91..b9d1e33ac3 100644
--- a/drivers/net/mlx5/mlx5_mac.c
+++ b/drivers/net/mlx5/mlx5_mac.c
@@ -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",