Commit c1cb98c5 authored by Quan Nguyen's avatar Quan Nguyen Committed by Guenter Roeck
Browse files

docs: hwmon: (smpro-hwmon) Improve grammar and formatting 

Improve documentation grammar and formatting for the
Ampere(R)'s Altra(R) SMpro hwmon driver.

Thanks Bagas for the changes in the link below.

Link: https://lore.kernel.org/lkml/Y1aHiaZ1OpHZIzS9@google.com/T/#mfea2167b99384486a1b75d9304536015116c1821


Signed-off-by: default avatarQuan Nguyen <quan@os.amperecomputing.com>
Reviewed-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Link: https://lore.kernel.org/r/20221102062103.3135417-1-quan@os.amperecomputing.com


Signed-off-by: default avatarGuenter Roeck <linux@roeck-us.net>
parent 78d448a3

Documentation/hwmon/smpro-hwmon.rst

+56 −55
Original line number Diff line number Diff line
@@ -7,39 +7,39 @@ Supported chips: 


  * Ampere(R) Altra(R)



    Prefix: 'smpro'

    Prefix: ``smpro``



    Reference: Altra SoC BMC Interface Specification

    Reference: `Altra SoC BMC Interface Specification`



Author: Thu Nguyen <thu@os.amperecomputing.com>



Description

-----------

This driver supports hardware monitoring for Ampere(R) Altra(R) SoC's based on the

SMpro co-processor (SMpro).

The following sensor types are supported by the driver:

The smpro-hwmon driver supports hardware monitoring for Ampere(R) Altra(R)

SoCs based on the SMpro co-processor (SMpro).  The following sensor metrics

are supported by the driver:



  * temperature

  * voltage

  * current

  * power



The SMpro interface provides the registers to query the various sensors and

The interface provides the registers to query the various sensors and

their values which are then exported to userspace by this driver.



Usage Notes

-----------



SMpro hwmon driver creates at least two sysfs files for each sensor.

The driver creates at least two sysfs files for each sensor.



* File ``<sensor_type><idx>_label`` reports the sensor label.

* File ``<sensor_type><idx>_input`` returns the sensor value.

* ``<sensor_type><idx>_label`` reports the sensor label.

* ``<sensor_type><idx>_input`` returns the sensor value.



The sysfs files are allocated in the SMpro root fs folder.

There is one root folder for each SMpro instance.

The sysfs files are allocated in the SMpro rootfs folder, with one root

directory for each instance.



When the SoC is turned off, the driver will fail to read registers

and return -ENXIO.

When the SoC is turned off, the driver will fail to read registers and

return ``-ENXIO``.



Sysfs entries

-------------
@@ -50,43 +50,44 @@ The following sysfs files are supported: 


  ============    =============  ======  ===============================================

  Name            Unit           Perm    Description

temp1_input     milli Celsius   RO      SoC temperature

temp2_input     milli Celsius   RO      Max temperature reported among SoC VRDs

temp2_crit      milli Celsius   RO      SoC VRD HOT Threshold temperature

temp3_input     milli Celsius   RO      Max temperature reported among DIMM VRDs

temp4_input     milli Celsius   RO      Max temperature reported among Core VRDs

temp5_input     milli Celsius   RO      Temperature of DIMM0 on CH0

temp5_crit      milli Celsius   RO      MEM HOT Threshold for all DIMMs

temp6_input     milli Celsius   RO      Temperature of DIMM0 on CH1

temp6_crit      milli Celsius   RO      MEM HOT Threshold for all DIMMs

temp7_input     milli Celsius   RO      Temperature of DIMM0 on CH2

temp7_crit      milli Celsius   RO      MEM HOT Threshold for all DIMMs

temp8_input     milli Celsius   RO      Temperature of DIMM0 on CH3

temp8_crit      milli Celsius   RO      MEM HOT Threshold for all DIMMs

temp9_input     milli Celsius   RO      Temperature of DIMM0 on CH4

temp9_crit      milli Celsius   RO      MEM HOT Threshold for all DIMMs

temp10_input    milli Celsius   RO      Temperature of DIMM0 on CH5

temp10_crit     milli Celsius   RO      MEM HOT Threshold for all DIMMs

temp11_input    milli Celsius   RO      Temperature of DIMM0 on CH6

temp11_crit     milli Celsius   RO      MEM HOT Threshold for all DIMMs

temp12_input    milli Celsius   RO      Temperature of DIMM0 on CH7

temp12_crit     milli Celsius   RO      MEM HOT Threshold for all DIMMs

temp13_input    milli Celsius   RO      Max temperature reported among RCA VRDs

in0_input       milli Volts     RO      Core voltage

in1_input       milli Volts     RO      SoC voltage

in2_input       milli Volts     RO      DIMM VRD1 voltage

in3_input       milli Volts     RO      DIMM VRD2 voltage

in4_input       milli Volts     RO      RCA VRD voltage

cur1_input      milli Amperes   RO      Core VRD current

cur2_input      milli Amperes   RO      SoC VRD current

cur3_input      milli Amperes   RO      DIMM VRD1 current

cur4_input      milli Amperes   RO      DIMM VRD2 current

cur5_input      milli Amperes   RO      RCA VRD current

power1_input    micro Watts     RO      Core VRD power

power2_input    micro Watts     RO      SoC VRD power

power3_input    micro Watts     RO      DIMM VRD1 power

power4_input    micro Watts     RO      DIMM VRD2 power

power5_input    micro Watts     RO      RCA VRD power

  ============    =============  ======  ===============================================

  temp1_input     millicelsius   RO      SoC temperature

  temp2_input     millicelsius   RO      Max temperature reported among SoC VRDs

  temp2_crit      millicelsius   RO      SoC VRD HOT Threshold temperature

  temp3_input     millicelsius   RO      Max temperature reported among DIMM VRDs

  temp4_input     millicelsius   RO      Max temperature reported among Core VRDs

  temp5_input     millicelsius   RO      Temperature of DIMM0 on CH0

  temp5_crit      millicelsius   RO      MEM HOT Threshold for all DIMMs

  temp6_input     millicelsius   RO      Temperature of DIMM0 on CH1

  temp6_crit      millicelsius   RO      MEM HOT Threshold for all DIMMs

  temp7_input     millicelsius   RO      Temperature of DIMM0 on CH2

  temp7_crit      millicelsius   RO      MEM HOT Threshold for all DIMMs

  temp8_input     millicelsius   RO      Temperature of DIMM0 on CH3

  temp8_crit      millicelsius   RO      MEM HOT Threshold for all DIMMs

  temp9_input     millicelsius   RO      Temperature of DIMM0 on CH4

  temp9_crit      millicelsius   RO      MEM HOT Threshold for all DIMMs

  temp10_input    millicelsius   RO      Temperature of DIMM0 on CH5

  temp10_crit     millicelsius   RO      MEM HOT Threshold for all DIMMs

  temp11_input    millicelsius   RO      Temperature of DIMM0 on CH6

  temp11_crit     millicelsius   RO      MEM HOT Threshold for all DIMMs

  temp12_input    millicelsius   RO      Temperature of DIMM0 on CH7

  temp12_crit     millicelsius   RO      MEM HOT Threshold for all DIMMs

  temp13_input    millicelsius   RO      Max temperature reported among RCA VRDs

  in0_input       millivolts     RO      Core voltage

  in1_input       millivolts     RO      SoC voltage

  in2_input       millivolts     RO      DIMM VRD1 voltage

  in3_input       millivolts     RO      DIMM VRD2 voltage

  in4_input       millivolts     RO      RCA VRD voltage

  cur1_input      milliamperes   RO      Core VRD current

  cur2_input      milliamperes   RO      SoC VRD current

  cur3_input      milliamperes   RO      DIMM VRD1 current

  cur4_input      milliamperes   RO      DIMM VRD2 current

  cur5_input      milliamperes   RO      RCA VRD current

  power1_input    microwatts     RO      Core VRD power

  power2_input    microwatts     RO      SoC VRD power

  power3_input    microwatts     RO      DIMM VRD1 power

  power4_input    microwatts     RO      DIMM VRD2 power

  power5_input    microwatts     RO      RCA VRD power

  ============    =============  ======  ===============================================



  Example::