Documentation/ABI: Add new attribute for mlxreg-io sysfs interfaces
authorVadim Pasternak <vadimp@mellanox.com>
Mon, 13 Jan 2020 16:28:34 +0000 (16:28 +0000)
committerAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Mon, 13 Jan 2020 19:02:46 +0000 (21:02 +0200)
Add documentation for the new attributes for:
- Exposing reset causes types asserted by: platform reset, SoC reset,
  AC power failure, software power off request.
- Setting and removing system VPD (EEPROM) hardware write protection.
- Voltage regulator devices configuration update status and firmware
  version.
- Setting PCIe ASIC reset to disable or enable state during PCIe root
  complex reset.
- System static topology identification, like system's static I2C
  topology, number and type of FPGA devices within the system and so on.

Signed-off-by: Vadim Pasternak <vadimp@mellanox.com>
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Documentation/ABI/stable/sysfs-driver-mlxreg-io

index eb6db73..b0d90cc 100644 (file)
@@ -143,3 +143,66 @@ Description:       These files show the system reset cause, as following:
                only last reset cause.
 
                The files are read only.
+
+What:          /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/config1
+What:          /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/config2
+Date:          January 2020
+KernelVersion: 5.6
+Contact:       Vadim Pasternak <vadimpmellanox.com>
+Description:   These files show system static topology identification
+               like system's static I2C topology, number and type of FPGA
+               devices within the system and so on.
+
+               The files are read only.
+
+What:          /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_ac_pwr_fail
+What:          /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_platform
+What:          /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_soc
+What:          /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_sw_pwr_off
+Date:          January 2020
+KernelVersion: 5.6
+Contact:       Vadim Pasternak <vadimpmellanox.com>
+Description:   These files show the system reset causes, as following: reset
+               due to AC power failure, reset invoked from software by
+               assertion reset signal through CPLD. reset caused by signal
+               asserted by SOC through ACPI register, reset invoked from
+               software by assertion power off signal through CPLD.
+
+               The files are read only.
+
+What:          /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/pcie_asic_reset_dis
+Date:          January 2020
+KernelVersion: 5.6
+Contact:       Vadim Pasternak <vadimpmellanox.com>
+Description:   This file allows to retain ASIC up during PCIe root complex
+               reset, when attribute is set 1.
+
+               The file is read/write.
+
+What:          /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/vpd_wp
+Date:          January 2020
+KernelVersion: 5.6
+Contact:       Vadim Pasternak <vadimpmellanox.com>
+Description:   This file allows to overwrite system VPD hardware wrtie
+               protection when attribute is set 1.
+
+               The file is read/write.
+
+What:          /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/voltreg_update_status
+Date:          January 2020
+KernelVersion: 5.6
+Contact:       Vadim Pasternak <vadimpmellanox.com>
+Description:   This file exposes the configuration update status of burnable
+               voltage regulator devices. The status values are as following:
+               0 - OK; 1 - CRC failure; 2 = I2C failure; 3 - in progress.
+
+               The file is read only.
+
+What:          /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/ufm_version
+Date:          January 2020
+KernelVersion: 5.6
+Contact:       Vadim Pasternak <vadimpmellanox.com>
+Description:   This file exposes the firmware version of burnable voltage
+               regulator devices.
+
+               The file is read only.