xref: /openbmc/linux/Documentation/ABI/stable/sysfs-driver-mlxreg-io (revision 527cd54d)

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/asic_health
Date:		June 2018
KernelVersion:	4.19
Contact:	Vadim Pasternak <vadimpmellanox.com>
Description:	This file shows ASIC health status. The possible values are:
		0 - health failed, 2 - health OK, 3 - ASIC in booting state.

		The files are read only.

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/cpld1_version
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/cpld2_version
Date:		June 2018
KernelVersion:	4.19
Contact:	Vadim Pasternak <vadimpmellanox.com>
Description:	These files show with which CPLD versions have been burned
		on carrier and switch boards.

		The files are read only.

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/fan_dir
Date:		December 2018
KernelVersion:	5.0
Contact:	Vadim Pasternak <vadimpmellanox.com>
Description:	This file shows the system fans direction:
		forward direction - relevant bit is set 0;
		reversed direction - relevant bit is set 1.

		The files are read only.

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/cpld3_version
Date:		November 2018
KernelVersion:	5.0
Contact:	Vadim Pasternak <vadimpmellanox.com>
Description:	These files show with which CPLD versions have been burned
		on LED or Gearbox board.

		The files are read only.

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/jtag_enable
Date:		November 2018
KernelVersion:	5.0
Contact:	Vadim Pasternak <vadimpmellanox.com>
Description:	These files enable and disable the access to the JTAG domain.
		By default access to the JTAG domain is disabled.

		The file is read/write.

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/select_iio
Date:		June 2018
KernelVersion:	4.19
Contact:	Vadim Pasternak <vadimpmellanox.com>
Description:	This file allows iio devices selection.

		Attribute select_iio can be written with 0 or with 1. It
		selects which one of iio devices can be accessed.

		The file is read/write.

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/psu1_on
		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/psu2_on
		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/pwr_cycle
		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/pwr_down
Date:		June 2018
KernelVersion:	4.19
Contact:	Vadim Pasternak <vadimpmellanox.com>
Description:	These files allow asserting system power cycling, switching
		power supply units on and off and system's main power domain
		shutdown.
		Expected behavior:
		When pwr_cycle is written 1: auxiliary power domain will go
		down and after short period (about 1 second) up.
		When  psu1_on or psu2_on is written 1, related unit will be
		disconnected from the power source, when written 0 - connected.
		If both are written 1 - power supplies main power domain will
		go down.
		When pwr_down is written 1, system's main power domain will go
		down.

		The files are write only.

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_aux_pwr_or_ref
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_asic_thermal
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_hotswap_or_halt
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_hotswap_or_wd
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_fw_reset
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_long_pb
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_main_pwr_fail
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_short_pb
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_sw_reset
Date:		June 2018
KernelVersion:	4.19
Contact:	Vadim Pasternak <vadimpmellanox.com>
Description:	These files show the system reset cause, as following: power
		auxiliary outage or power refresh, ASIC thermal shutdown, halt,
		hotswap, watchdog, firmware reset, long press power button,
		short press power button, software reset. Value 1 in file means
		this is reset cause, 0 - otherwise. Only one of the above
		causes could be 1 at the same time, representing only last
		reset cause.

		The files are read only.

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_comex_pwr_fail
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_from_comex
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_system
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_voltmon_upgrade_fail
Date:		November 2018
KernelVersion:	5.0
Contact:	Vadim Pasternak <vadimpmellanox.com>
Description:	These files show the system reset cause, as following: ComEx
		power fail, reset from ComEx, system platform reset, reset
		due to voltage monitor devices upgrade failure,
		Value 1 in file means this is reset cause, 0 - otherwise.
		Only one bit could be 1 at the same time, representing only
		the last reset cause.

		The files are read only.

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/cpld4_version
Date:		November 2018
KernelVersion:	5.0
Contact:	Vadim Pasternak <vadimpmellanox.com>
Description:	These files show with which CPLD versions have been burned
		on LED board.

		The files are read only.

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_comex_thermal
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_comex_wd
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_from_asic
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_reload_bios
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_sff_wd
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_swb_wd
Date:		June 2019
KernelVersion:	5.3
Contact:	Vadim Pasternak <vadimpmellanox.com>
Description:	These files show the system reset cause, as following:
		COMEX thermal shutdown; wathchdog power off or reset was derived
		by one of the next components: COMEX, switch board or by Small Form
		Factor mezzanine, reset requested from ASIC, reset caused by BIOS
		reload. Value 1 in file means this is reset cause, 0 - otherwise.
		Only one of the above causes could be 1 at the same time, representing
		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 write
		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.

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/cpld1_pn
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/cpld2_pn
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/cpld3_pn
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/cpld4_pn
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/cpld1_version_min
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/cpld2_version_min
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/cpld3_version_min
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/cpld4_version_min
Date:		July 2020
KernelVersion:	5.9
Contact:	Vadim Pasternak <vadimpmellanox.com>
Description:	These files show with which CPLD part numbers and minor
		versions have been burned CPLD devices equipped on a
		system.

		The files are read only.

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/bios_active_image
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/bios_auth_fail
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/bios_upgrade_fail
Date:		October 2021
KernelVersion:	5.16
Contact:	Vadim Pasternak <vadimp@nvidia.com>
Description:	The files represent BIOS statuses:
		- bios_active_image: location of current active BIOS image:
		  0: Top, 1: Bottom.
		  The reported value should correspond to value expected by OS
		  in case of BIOS safe mode is 0. This bit is related to Intel
		  top-swap feature of DualBios on the same flash.
		- bios_auth_fail: BIOS upgrade is failed because provided BIOS
		  image is not signed correctly.
		- bios_upgrade_fail: BIOS upgrade is failed by some other
		  reason not because authentication. For example due to
		  physical SPI flash problem.

		The files are read only.

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc1_enable
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc2_enable
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc3_enable
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc4_enable
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc5_enable
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc6_enable
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc7_enable
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc8_enable
Date:		October 2021
KernelVersion:	5.16
Contact:	Vadim Pasternak <vadimp@nvidia.com>
Description:	These files allow line cards enable state control.
		Expected behavior:
		When  lc{n}_enable is written 1, related line card is released
		from the reset state, when 0 - is hold in reset state.

		The files are read/write.

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc1_pwr
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc2_pwr
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc3_pwr
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc4_pwr
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc5_pwr
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc6_pwr
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc7_pwr
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc8_pwr
Date:		October 2021
KernelVersion:	5.16
Contact:	Vadim Pasternak <vadimp@nvidia.com>
Description:	These files switching line cards power on and off.
		Expected behavior:
		When  lc{n}_pwr is written 1, related line card is powered
		on, when written 0 - powered off.

		The files are read/write.

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc1_rst_mask
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc2_rst_mask
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc3_rst_mask
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc4_rst_mask
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc5_rst_mask
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc6_rst_mask
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc7_rst_mask
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/lc8_rst_mask
Date:		October 2021
KernelVersion:	5.16
Contact:	Vadim Pasternak <vadimp@nvidia.com>
Description:	These files clear line card reset bit enforced by ASIC, when it
		sets it due to some abnormal ASIC behavior.
		Expected behavior:
		When lc{n}_rst_mask is written 1, related line card reset bit
		is cleared, when written 0 - no effect.

		The files are write only.

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/os_started
Date:		October 2021
KernelVersion:	5.16
Contact:	Vadim Pasternak <vadimp@nvidia.com>
Description:	This file, when written 1, indicates to programmable devices
		that OS is taking control over it.

		The file is read/write.

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/pm_mgmt_en
Date:		October 2021
KernelVersion:	5.16
Contact:	Vadim Pasternak <vadimp@nvidia.com>
Description:	This file assigns power management control ownership.
		When power management control is provided by hardware, hardware
		will automatically power off one or more line previously
		powered line cards in case system power budget is getting
		insufficient. It could be in case when some of power units lost
		power good state.
		When pm_mgmt_en is written 1, power management control by
		software is enabled, 0 - power management control by hardware.
		Note that for any setting of pm_mgmt_en attribute hardware will
		not allow to power on any new line card in case system power
		budget is insufficient.
		Same in case software will try to power on several line cards
		at once - hardware will power line cards while system has
		enough power budget.
		Default is 0.

		The file is read/write.

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/psu3_on
What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/psu4_on
Date:		October 2021
KernelVersion:	5.16
Contact:	Vadim Pasternak <vadimp@nvidia.com>
Description:	These files switching power supply units on and off.
		Expected behavior:
		When  psu3_on or psu4_on is written 1, related unit will be
		disconnected from the power source, when written 0 - connected.

		The files are write only.

What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/shutdown_unlock
Date:		October 2021
KernelVersion:	5.16
Contact:	Vadim Pasternak <vadimp@nvidia.com>
Description:	This file allows to unlock ASIC after thermal shutdown event.
		When system thermal shutdown is enforced by ASIC, ASIC is
		getting locked and after system boot it will not be available.
		Software can decide to unlock it by setting this attribute to
		1 and then perform system power cycle by setting pwr_cycle
		attribute to 1 (power cycle of main power domain).
		Before setting shutdown_unlock to 1 it is recommended to
		validate that system reboot cause is reset_asic_thermal or
		reset_thermal_spc_or_pciesw.
		In case shutdown_unlock is not set 1, the only way to release
		ASIC from locking - is full system power cycle through the
		external power distribution unit.
		Default is 1.

		The file is read/write.