docs: Complete NVIDIA documentation conversion and branding update

acoifmannvidia · acoifmannvidia · commit b7aea2c34e1a · 2025-09-08T00:07:53.000+03:00
- Review comprehensive sysfs attribute documentation
- Update man pages with technical details and current branding
- Expand README with updated supported systems
- Update all documentation files, scripts, and configuration files

Signed-off-by: Abraham Coifman &lt;acoifman@nvidia.com&gt;
diff --git a/Documentation/Chassis_Management_for_Mellanox_Switch_Systems_with_Sysfs_rev.2.8.pdf b/Documentation/Chassis_Management_for_Mellanox_Switch_Systems_with_Sysfs_rev.2.8.pdf
diff --git a/Documentation/Chassis_Management_for_NVIDIA_Switch_Systems_with_Sysfs_rev.3.0.md b/Documentation/Chassis_Management_for_NVIDIA_Switch_Systems_with_Sysfs_rev.3.0.md
diff --git a/Documentation/Thermal Monitoring for Mellanox Systems with third party OS.pdf b/Documentation/Thermal Monitoring for Mellanox Systems with third party OS.pdf
diff --git a/Documentation/Thermal_Monitoring_for_NVIDIA_Systems_with_third_party_OS.md b/Documentation/Thermal_Monitoring_for_NVIDIA_Systems_with_third_party_OS.md
diff --git a/Documentation/images/logo.png b/Documentation/images/logo.png
diff --git a/Documentation/images/sysfs-layout.png b/Documentation/images/sysfs-layout.png
diff --git a/Documentation/images/system-arc-layout.png b/Documentation/images/system-arc-layout.png
diff --git a/Documentation/images/thermal-control-core.png b/Documentation/images/thermal-control-core.png
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
-# Mellanox Hardware Management package
-This package supports thermal control and hardware management for Mellanox switches by using a virtual file system provided by the Linux Kernel called `sysfs`.  
+# NVIDIA Hardware Management package
+This package supports thermal control and hardware management for NVIDIA switches by using a virtual file system provided by the Linux Kernel called `sysfs`.  
 
 The major advantage of working with sysfs is that it makes HW hierarchy easy to understand and control without having to learn about HW component location and the buses through which they are connected.
 For detailed information, see the documentation [here](https://github.com/Mellanox/hw-mgmt/tree/master/Documentation).
@@ -17,25 +17,60 @@ For detailed information, see the documentation [here](https://github.com/Mellan
 - MSN2740
 - MSN2100
 - MSN2410
+- MSN24102
 - MSN2700
 - MSN2700-A1
+- MSN27002
 - MSN2010
 - MQMB7800
 - MSN3420
+- MSN3510
 - MSN3700
 - MSN3700C
 - MSN3700S
 - MSN3750SX
 - MSN3800
+- MSN38XX
 - MSN4410
-- MSN4700
-- MSN4600C
 - MSN4600
-- MQM9700
+- MSN4600C
+- MSN46XX
+- MSN4700
+- MSN47XX
 - MSN4800
 - MSN5600
+- MSN5600d
+- MSN5700
+- MQM8700
+- MQM87XX
+- MQM9700
+- MQM97XX
+- MSB78002
+- MSB87XX
+- MSX87XX
 - SGN2410
 - SN2201
+- SN4280
+- SN5400
+- SN5600
+- SN5610
+- SN5640
+- SN5700
+- N5100LD
+- N5101LD
+- N5110LD
+- N5112LD
+- N5200LD
+- N5240LD
+- N5300LD
+- N5500LD
+- N61XX_LD
+- Q3200
+- Q3400
+- Q3401
+- Q3450
+- Q3451
+- XH3000
 - E3597
 - P4697
 - P2317
@@ -322,7 +357,7 @@ The package depends on the next packages:
 
 Package contains the folder Debian, with the rules for Debian package build.
 Location: `https://github.com/Mellanox/hw-mgmt`
-To get package sources: `git clone https://mellanoxbsp@github.com/Mellanox/hw-mgmt`
+To get package sources: `git clone https://github.com/Mellanox/hw-mgmt`
 
 **For Debian package build:**
 On a debian-based system, install the following programs:
@@ -388,4 +423,4 @@ This project is Licensed under the GNU General Public License Version 2.
 
 ## Acknowledgments
 
-* Mellanox Low-Level Team.
+* NVIDIA Low-Level Team.
diff --git a/doc/man/hw-management-tc.service.8 b/doc/man/hw-management-tc.service.8
@@ -1,13 +1,21 @@
-.TH HW-MANAGEMENT-TC "8" "June 2020" "hw-management-tc " "hw-management"
+.TH HW-MANAGEMENT-TC "8" "September 2025" "hw-management-tc " "hw-management"
 .SH NAME
-hw-management-tc.service \- service used to run hw-management-thermal-control.sh
+hw-management-tc.service \- service used to run hw_management_thermal_control.py
 .SH SYNOPSIS
-Thermal control for Mellanox systems.
-A method for performing switch or router system thermal control monitoring, such as that employed
-for complex system's configuration with a single FAN control and with multi-points of temperature
-measure is disclosed. The technique referred to as the Optimized Thermal Monitoring Algorithm
-(OTMA) approach, periodically re-calculates the highest temperature score of all thermal zones
-and enforce thermal control to following the thermal zone with the highest score.
+Thermal control for NVIDIA systems.
+The thermal control service provides advanced thermal management for NVIDIA switch systems.
+It implements the Optimized Thermal Monitoring Algorithm (OTMA) that periodically
+re-calculates the highest temperature score of all thermal zones and enforces thermal
+control following the thermal zone with the highest score.
+
+The service supports multiple thermal control versions:
+- TC v2.0: Standard thermal control implementation
+- TC v2.5: Enhanced thermal control with improved algorithms for newer systems
+
+The service automatically selects the appropriate thermal control version based on
+the hardware platform and runs the corresponding Python script:
+- /usr/bin/hw_management_thermal_control.py (TC v2.0)
+- /usr/bin/hw_management_thermal_control_2_5.py (TC v2.5)
 .SH OPTIONS
 .TP
 start
diff --git a/doc/man/hw-management.1 b/doc/man/hw-management.1
@@ -1,8 +1,8 @@
-.TH HW-MANAGEMENT.SH "1" "June 2020" "hw-management.sh " "User Commands"
+.TH HW-MANAGEMENT.SH "1" "September 2025" "hw-management.sh " "User Commands"
 .SH NAME
-hw-management.sh \- Chassis management for Mellanox systems
+hw-management.sh \- Chassis management for NVIDIA systems
 .SH SYNOPSIS
-Mellanox hw-management package uses a virtual file system provided by the Linux kernel
+NVIDIA hw-management package uses a virtual file system provided by the Linux kernel
 called sysfs.
 The sysfs file system enumerates the devices and buses attached to the system in a file
 system hierarchy that can be accessed from the user space.
@@ -34,19 +34,29 @@ Manual de\-activation of ASIC I2C driver.
 chipupen
 Set 'chipup_dis' attribute to zero.
 .TP
-chipupdis <n>
-Set 'chipup_dis' attribute to <n>, when <n>
+chipupdis [n]
+Set 'chipup_dis' attribute to n (default: 1 if n not specified)
 .TP
 thermsuspend
 Suspend thermal control (if thermal control is
-activated by hw\-management package.
+activated by hw\-management package).
 Not relevant for users who disable hw\-management
 thermal control.
 .TP
 thermresume
 Resume thermal control.
 Not relevant for users who disable hw\-management
 thermal control.
-.IP
+.TP
 restart
-force\-reload    Performs hw\-management 'stop' and the 'start.
+force\-reload    Performs hw\-management 'stop' and then 'start'.
+.TP
+reset\-cause     Output system reset cause.
+.SH THERMAL CONTROL SERVICE
+The hw\-management package includes a separate thermal control service
+(hw\-management\-tc.service) that runs independently from the main
+hw\-management service. This service provides advanced thermal control
+algorithms and monitoring capabilities.
+.SH SEE ALSO
+\fBhw-management.service\fR(8)
+\fBhw-management-tc.service\fR(8)
diff --git a/doc/man/hw-management.service.8 b/doc/man/hw-management.service.8
@@ -1,9 +1,9 @@
-.TH HW-MANAGEMENT "8" "June 2020" "hw-management " "hw-management"
+.TH HW-MANAGEMENT "8" "September 2025" "hw-management " "hw-management"
 .SH NAME
 hw-management.service \- service used to run hw-management.sh
 .SH SYNOPSIS
-Chassis management for Mellanox systems.
-Mellanox hw-management package uses a virtual file system provided by the Linux kernel
+Chassis management for NVIDIA systems.
+NVIDIA hw-management package uses a virtual file system provided by the Linux kernel
 called sysfs.
 The sysfs file system enumerates the devices and buses attached to the system in a file
 system hierarchy that can be accessed from the user space.
diff --git a/docker_build/dockerfile_hw_mgmt b/docker_build/dockerfile_hw_mgmt
@@ -1,5 +1,5 @@
 FROM debian:bullseye
-MAINTAINER Oleksandr Shamray <oleksandrs@mellanox.com>
+MAINTAINER Oleksandr Shamray <oleksandrs@nvidia.com>
 RUN apt-get update \
     && apt-get install -y --no-install-recommends \
                build-essential \
diff --git a/examples/src/ev_hndl/lc_event_handler.py b/examples/src/ev_hndl/lc_event_handler.py
@@ -20,10 +20,10 @@
 """
 
 @copyright:
-     Copyright (C) Mellanox Technologies Ltd. 2001-2020.  ALL RIGHTS RESERVED.
+     Copyright (C) NVIDIA CORPORATION & AFFILIATES 2001-2025.  ALL RIGHTS RESERVED.
 
-    This software product is a proprietary product of Mellanox Technologies
-    Ltd. (the "Company") and all right, title, and interest in and to the
+    This software product is a proprietary product of NVIDIA CORPORATION & AFFILIATES
+    (the "Company") and all right, title, and interest in and to the
     software product, including all associated intellectual property rights,
     are and shall remain exclusively with the Company.
 
diff --git a/examples/src/iorw/README b/examples/src/iorw/README
@@ -1,5 +1,5 @@
 ########################################################################
-# Copyright (c) 2019 Mellanox Technologies. All rights reserved.
+# Copyright (c) 2019 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
diff --git a/recipes-kernel/linux/linux-5.10/0017-mlxsw-reg-Extend-MTMP-register-with-new-threshold-fi.patch b/recipes-kernel/linux/linux-5.10/0017-mlxsw-reg-Extend-MTMP-register-with-new-threshold-fi.patch
@@ -1,5 +1,5 @@
 From 91f0e76459d7a0e3156e7427d6ad347d345e2909 Mon Sep 17 00:00:00 2001
-From: Mykola Kostenok <c_mykolak@nvidia.com>
+From: Mykola Kostenok <c_mykolak@mellanox.com>
 Date: Tue, 8 Jun 2021 15:44:11 +0300
 Subject: [PATCH backport 5.10 017/182] mlxsw: reg: Extend MTMP register with
  new threshold field
@@ -12,7 +12,7 @@ providing high and maximum temperature thresholds. For modules, these
 thresholds correspond to critical and emergency thresholds that are read
 from the module's EEPROM.
 
-Signed-off-by: Mykola Kostenok <c_mykolak@nvidia.com>
+Signed-off-by: Mykola Kostenok <c_mykolak@mellanox.com>
 Acked-by: Vadim Pasternak <vadimp@nvidia.com>
 Signed-off-by: Ido Schimmel <idosch@nvidia.com>
 Signed-off-by: David S. Miller <davem@davemloft.net>
diff --git a/recipes-kernel/linux/linux-5.10/0018-mlxsw-thermal-Add-function-for-reading-module-temper.patch b/recipes-kernel/linux/linux-5.10/0018-mlxsw-thermal-Add-function-for-reading-module-temper.patch
@@ -1,5 +1,5 @@
 From 890ffa911705403d5f56ec57bf92f74b65758c87 Mon Sep 17 00:00:00 2001
-From: Mykola Kostenok <c_mykolak@nvidia.com>
+From: Mykola Kostenok <c_mykolak@mellanox.com>
 Date: Tue, 8 Jun 2021 15:44:13 +0300
 Subject: [PATCH backport 5.10 018/182] mlxsw: thermal: Add function for
  reading module temperature and thresholds
@@ -13,7 +13,7 @@ Currently, the sole caller of the function is only using it to read the
 module's temperature. The next patch will also use it to query the
 module's temperature thresholds.
 
-Signed-off-by: Mykola Kostenok <c_mykolak@nvidia.com>
+Signed-off-by: Mykola Kostenok <c_mykolak@mellanox.com>
 Acked-by: Vadim Pasternak <vadimp@nvidia.com>
 Signed-off-by: Ido Schimmel <idosch@nvidia.com>
 Signed-off-by: David S. Miller <davem@davemloft.net>
diff --git a/recipes-kernel/linux/linux-5.10/0019-mlxsw-thermal-Read-module-temperature-thresholds-usi.patch b/recipes-kernel/linux/linux-5.10/0019-mlxsw-thermal-Read-module-temperature-thresholds-usi.patch
@@ -1,5 +1,5 @@
 From 5e6f570de0f814bd843fdc5b36251538bdf7405f Mon Sep 17 00:00:00 2001
-From: Mykola Kostenok <c_mykolak@nvidia.com>
+From: Mykola Kostenok <c_mykolak@mellanox.com>
 Date: Tue, 8 Jun 2021 15:44:14 +0300
 Subject: [PATCH backport 5.10 019/182] mlxsw: thermal: Read module temperature
  thresholds using MTMP register
@@ -19,7 +19,7 @@ This is both more reliable and more efficient than current method, as
 temperature and thresholds are queried in one transaction instead of
 three. This is significant when working over a slow bus such as I2C.
 
-Signed-off-by: Mykola Kostenok <c_mykolak@nvidia.com>
+Signed-off-by: Mykola Kostenok <c_mykolak@mellanox.com>
 Acked-by: Vadim Pasternak <vadimp@nvidia.com>
 Signed-off-by: Ido Schimmel <idosch@nvidia.com>
 Signed-off-by: David S. Miller <davem@davemloft.net>
diff --git a/recipes-kernel/linux/linux-5.10/0031-mlxsw-core_env-Read-module-temperature-thresholds-us.patch b/recipes-kernel/linux/linux-5.10/0031-mlxsw-core_env-Read-module-temperature-thresholds-us.patch
@@ -1,5 +1,5 @@
 From b99eea2d9ce7ba73de38b82a7ed2057a777d4893 Mon Sep 17 00:00:00 2001
-From: Mykola Kostenok <c_mykolak@nvidia.com>
+From: Mykola Kostenok <c_mykolak@mellanox.com>
 Date: Tue, 8 Jun 2021 15:44:12 +0300
 Subject: [PATCH backport 5.10 031/182] mlxsw: core_env: Read module
  temperature thresholds using MTMP register
@@ -18,7 +18,7 @@ thresholds through MTMP field 'max_operational_temperature' - if it is
 not zero, feature is supported. Otherwise fallback to old method and get
 the thresholds through MCIA.
 
-Signed-off-by: Mykola Kostenok <c_mykolak@nvidia.com>
+Signed-off-by: Mykola Kostenok <c_mykolak@mellanox.com>
 Acked-by: Vadim Pasternak <vadimp@nvidia.com>
 Signed-off-by: Ido Schimmel <idosch@nvidia.com>
 Signed-off-by: David S. Miller <davem@davemloft.net>
diff --git a/recipes-kernel/linux/linux-5.10/0033-mlxsw-core-Set-thermal-zone-polling-delay-argument-t.patch b/recipes-kernel/linux/linux-5.10/0033-mlxsw-core-Set-thermal-zone-polling-delay-argument-t.patch
@@ -1,5 +1,5 @@
 From 31780a1a30b26ffc6f2551e43d7d4593cec8599c Mon Sep 17 00:00:00 2001
-From: Mykola Kostenok <c_mykolak@nvidia.com>
+From: Mykola Kostenok <c_mykolak@mellanox.com>
 Date: Sun, 6 Jun 2021 11:24:32 +0300
 Subject: [PATCH backport v5.10.43 33/67] mlxsw: core: Set thermal zone polling
  delay argument to real value at init
@@ -17,7 +17,7 @@ thus, the relevant thermal zones will perform thermal monitoring.
 Cc: Andrzej Pietrasiewicz <andrzej.p@collabora.com>
 Fixes: 5d7bd8aa7c35 ("thermal: Simplify or eliminate unnecessary set_mode() methods")
 Fixes: 1ee14820fd8e ("thermal: remove get_mode() operation of drivers")
-Signed-off-by: Mykola Kostenok <c_mykolak@nvidia.com>
+Signed-off-by: Mykola Kostenok <c_mykolak@mellanox.com>
 Acked-by: Vadim Pasternak <vadimp@nvidia.com>
 Reviewed-by: Jiri Pirko <jiri@nvidia.com>
 Signed-off-by: Ido Schimmel <idosch@nvidia.com>
diff --git a/rpm/hw-management.spec b/rpm/hw-management.spec
@@ -1,7 +1,7 @@
 Name: hw-management
 Version: %{version}
 Release: 1
-Summary: Thermal control and chassis management for Mellanox systems
+Summary: Thermal control and chassis management for NVIDIA systems
 License: see /usr/share/doc/hw-management/copyright
 Distribution: Centos
 Group: Converted/utils
diff --git a/usr/lib/udev/rules.d/50-hw-management-events.rules b/usr/lib/udev/rules.d/50-hw-management-events.rules
@@ -31,7 +31,7 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #
 
-# The below rules contains sysfs attributes, related to Mellanox thermal
+# The below rules contains sysfs attributes, related to NVIDIA thermal
 # control. These rules are supposed to catch the following attributes,
 # related to the next components: ASIC and port thermal zone mode, cooling
 # device current state,  statues of hot-pluggable devices, FAN faults, port
diff --git a/usr/usr/bin/hw-management-vpd-parser.py b/usr/usr/bin/hw-management-vpd-parser.py
@@ -56,7 +56,7 @@
 '''
 Created on Nov 05, 2020
 
-Author: Oleksandr Shamray <oleksandrs@mellanox.com>
+Author: Oleksandr Shamray <oleksandrs@nvidia.com>
 Version: 1.0
 
 Description: This util converting FRU data file and saving it to file
@@ -622,7 +622,7 @@ def parse_fru_onie_bin(data, FRU_ITEMS, verbose=False):
                          ['MFGDate', '123456789abcdefghij'],
                          ['device_sw_id', 0],
                          ['device_hw_revision', 0],
-                         ['Manufacturer', 'Mellanox'],
+                         ['Manufacturer', 'NVIDIA'],
                          ['max_power', '10000000'],
                          ['CRC32', '0x78563412']],
             'tlv_header': 'TlvInfo',
diff --git a/usr/usr/bin/hw_management_psu_fw_update_common.py b/usr/usr/bin/hw_management_psu_fw_update_common.py
@@ -37,7 +37,7 @@
 '''
 Created on June 10, 2021
 
-Author: Mykola Kostenok <c_mykolak@nvidia.com>
+Author: Mykola Kostenok <c_mykolak@mellanox.com>
 Version: 0.1
 
 Description:
diff --git a/usr/usr/bin/hw_management_psu_fw_update_delta.py b/usr/usr/bin/hw_management_psu_fw_update_delta.py
@@ -37,7 +37,7 @@
 '''
 Created on June 10, 2021
 
-Author: Mykola Kostenok <c_mykolak@nvidia.com>
+Author: Mykola Kostenok <c_mykolak@mellanox.com>
 
 Description:
 Delta and Acbel PSU FW update tool.
diff --git a/usr/usr/bin/hw_management_psu_fw_update_murata.py b/usr/usr/bin/hw_management_psu_fw_update_murata.py
@@ -37,7 +37,7 @@
 '''
 Created on June 15, 2021
 
-Author: Mykola Kostenok <c_mykolak@nvidia.com>
+Author: Mykola Kostenok <c_mykolak@mellanox.com>
 Version: 1.0
 
 Description:
