Re: [PATCH platform-next v10 2/2] Documentation/ABI: Add new attribute for mlxreg-io sysfs interfaces

[ALOK TIWARI <alok.a.tiwari@oracle.com>]

On 30-04-2025 21:26, Vadim Pasternak wrote:
> Add documentation for the new attributes:
> - Request and response for access to protetced flashes:
[clip]
> +
> +What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/global_wp_request
> +Date:		May 2025
> +KernelVersion:	6.16
> +Contact:	Vadim Pasternak <vadimp@nvidia.com>
> +Description:	This file when written 1 activates request to allow access to
> +		the write protected flashes. Such request can be performed only
> +		for system equipped with BMC (Board Management Controller),
> +		which can grant access to protected flashes. In case BMC allows
> +		access - it will respond with "global_wp_response". BMC decides
> +		regarding time window of granted access. After granted window is
> +		expired, BMC will change value back to 0.
> +		Default value is 0.
> +
> +		The file is read/write.
> +
> +What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/global_wp_response
> +Date:		May 2025
> +KernelVersion:	6.16
> +Contact:	Vadim Pasternak <vadimp@nvidia.com>
> +Description:	This file, when set 1, indicates that access to protected
> +		flashes have been granted to host CPU by BMC.
> +		Default value is 0.
> +
> +		The file is read only.
> +
> +What:		/sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/shutdown_unlock
> +Date:		May 2025
> +KernelVersion:	6.16
> +Contact:	Vadim Pasternak vadimp@nvidia.com

email angle brackets (< >) for contact

> +Description:	When ASICs are getting overheated, system protection
> +		hardware mechanism enforces system reboot. After system
> +		reboot ASICs come up in locked state. To unlock ASICs,
> +		this file should be written 1
> +		Default value is 0.
> +
> +		The file is read/write.
> +
> +What:		/sys/devices/platform/mlxplat/i2c_mlxcpld.*/i2c-*/i2c-*/*-00**/mlxreg-io.*/hwmon/hwmon*/boot_progress
> +Date:		May 2025
> +KernelVersion:	6.16
> +Contact:	Vadim Pasternak <vadimp@nvidia.com>
> +Description:	These files show the Data Process Unit board boot progress
> +		state. Valid states are:
> +		- 4 : OS starting.
> +		- 5 : OS running.
> +		- 6 : Low-Power Standby.
> +
> +		The file is read only.
> +
> +What:		/sys/devices/platform/mlxplat/i2c_mlxcpld.*/i2c-*/i2c-*/*-00**/mlxreg-io.*/hwmon/hwmon*/dpu_id
> +Date:		May 2025
> +KernelVersion:	6.16
> +Contact:	Vadim Pasternak <vadimp@nvidia.com>
> +Description:	This file shows hardware Id of Data Process Unit board.
> +
> +		The file is read only.
> +
> +What:		/sys/devices/platform/mlxplat/i2c_mlxcpld.*/i2c-*/i2c-*/*-00**/mlxreg-io.*/hwmon/hwmon*/reset_aux_pwr_or_reload
> +What:		/sys/devices/platform/mlxplat/i2c_mlxcpld.*/i2c-*/i2c-*/*-00**/mlxreg-io.*/hwmon/hwmon*/reset_dpu_thermal
> +What:		/sys/devices/platform/mlxplat/i2c_mlxcpld.*/i2c-*/i2c-*/*-00**/mlxreg-io.*/hwmon/hwmon*/reset_from_main_board
> +Date:		May 2025
> +KernelVersion:	6.16
> +Contact:	Vadim Pasternak <vadimp@nvidia.com>
> +Description:	These files show the Data Process Unit board reset cause, as
> +		following: reset due to power auxiliary outage or power reload, reset
> +		due to thermal shutdown, reset due to request from main board.

better to break big sentence
These files expose the cause of the most recent reset of the
Data Processing Unit (DPU) board. The possible causes are:
  - Power auxiliary outage or power reload
  - Thermal shutdown
  - Reset request from the main board

> +		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.
> +


Thanks,
Alok