Commit 42bab8ea authored by Vadim Pasternak's avatar Vadim Pasternak Committed by Hans de Goede
Browse files

Documentation/ABI: Add new attribute for mlxreg-io sysfs interfaces 



Add documentation for the new attributes:
- CPLD versioning: "cpld5_pn", "cpld5_version", "cpld5_version_min".
- JTAG capability: "jtag_cap", indicating the available method of
  CPLD/FPGA devices field update.
- System lid status: "lid_open".
- Reset caused by long press of power button: "reset_long_pwr_pb".
- Reset caused by switch board DC-DC converter device failure:
  "reset_swb_dc_dc_pwr_fail".

Signed-off-by: default avatarVadim Pasternak <vadimp@nvidia.com>
Reviewed-by: default avatarMichael Shych <michaelsh@nvidia.com>
Reviewed-by: default avatarHans de Goede <hdegoede@redhat.com>
Reviewed-by: default avatarIlpo Järvinen <ilpo.jarvinen@linux.intel.com>
Link: https://lore.kernel.org/r/20230822113451.13785-17-vadimp@nvidia.com


Signed-off-by: default avatarHans de Goede <hdegoede@redhat.com>
parent e2aabb7c

Documentation/ABI/stable/sysfs-driver-mlxreg-io

+53 −0
Original line number Diff line number Diff line
@@ -662,3 +662,56 @@ Description: This file shows the system reset cause due to AC power failure. 
		Value 1 in file means this is reset cause, 0 - otherwise.



		The file is read only.



What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/cpld5_pn

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/cpld5_version

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/cpld5_version_min

Date:		August 2023

KernelVersion:	6.6

Contact:	Vadim Pasternak <vadimp@nvidia.com>

Description:	These files show with which CPLD part numbers, version and minor

		versions have been burned the 5-th CPLD device equipped on a

		system.



		The files are read only.



What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/jtag_cap

Date:		August 2023

KernelVersion:	6.6

Contact:	Vadim Pasternak <vadimp@nvidia.com>

Description:	This file indicates the available method of CPLD/FPGA devices

		field update through the JTAG chain:



		b00 - field update through LPC bus register memory space.

		b01 - Reserved.

		b10 - Reserved.

		b11 - field update through CPU GPIOs bit-banging.



		The file is read only.



What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lid_open

Date:		August 2023

KernelVersion:	6.6

Contact:	Vadim Pasternak <vadimp@nvidia.com>

Description:	1 - indicates that system lid is opened, otherwise 0.



		The file is read only.



What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_long_pwr_pb

Date:		August 2023

KernelVersion:	6.6

Contact:	Vadim Pasternak <vadimp@nvidia.com>

Description:	This file if set 1 indicates that system has been reset by

		long press of power button.



		The file is read only.



What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_swb_dc_dc_pwr_fail

Date:		August 2023

KernelVersion:	6.6

Contact:	Vadim Pasternak <vadimp@nvidia.com>

Description:	This file shows 1 in case the system reset happened due to the

		failure of any DC-DC power converter devices equipped on the

		switch board.



		The file is read only.