From bfc8a222d3bca4c09a63de8b321bf7f825fa59ff Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Fri, 26 Jul 2019 09:51:32 -0300 Subject: docs: hwmon: pxe1610: convert to ReST format and add to the index This document was recently introduced. Convert it to ReST just like the other hwmon documents, adding it to the hwmon index. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet --- Documentation/hwmon/index.rst | 1 + Documentation/hwmon/pxe1610 | 90 --------------------------------- Documentation/hwmon/pxe1610.rst | 107 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 108 insertions(+), 90 deletions(-) delete mode 100644 Documentation/hwmon/pxe1610 create mode 100644 Documentation/hwmon/pxe1610.rst (limited to 'Documentation/hwmon') diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst index ee090e51653a..4d5f5fec43a3 100644 --- a/Documentation/hwmon/index.rst +++ b/Documentation/hwmon/index.rst @@ -130,6 +130,7 @@ Hardware Monitoring Kernel Drivers pcf8591 pmbus powr1220 + pxe1610 pwm-fan raspberrypi-hwmon sch5627 diff --git a/Documentation/hwmon/pxe1610 b/Documentation/hwmon/pxe1610 deleted file mode 100644 index 211cedeefb44..000000000000 --- a/Documentation/hwmon/pxe1610 +++ /dev/null @@ -1,90 +0,0 @@ -Kernel driver pxe1610 -===================== - -Supported chips: - * Infineon PXE1610 - Prefix: 'pxe1610' - Addresses scanned: - - Datasheet: Datasheet is not publicly available. - - * Infineon PXE1110 - Prefix: 'pxe1110' - Addresses scanned: - - Datasheet: Datasheet is not publicly available. - - * Infineon PXM1310 - Prefix: 'pxm1310' - Addresses scanned: - - Datasheet: Datasheet is not publicly available. - -Author: Vijay Khemka - - -Description ------------ - -PXE1610/PXE1110 are Multi-rail/Multiphase Digital Controllers -and compliant to - -- Intel VR13 DC-DC converter specifications. - -- Intel SVID protocol. -Used for Vcore power regulation for Intel VR13 based microprocessors - -- Servers, Workstations, and High-end desktops - -PXM1310 is a Multi-rail Controller and it is compliant to - -- Intel VR13 DC-DC converter specifications. - -- Intel SVID protocol. -Used for DDR3/DDR4 Memory power regulation for Intel VR13 and -IMVP8 based systems - - -Usage Notes ------------ - -This driver does not probe for PMBus devices. You will have -to instantiate devices explicitly. - -Example: the following commands will load the driver for an PXE1610 -at address 0x70 on I2C bus #4: - -# modprobe pxe1610 -# echo pxe1610 0x70 > /sys/bus/i2c/devices/i2c-4/new_device - -It can also be instantiated by declaring in device tree - - -Sysfs attributes ----------------- - -curr1_label "iin" -curr1_input Measured input current -curr1_alarm Current high alarm - -curr[2-4]_label "iout[1-3]" -curr[2-4]_input Measured output current -curr[2-4]_crit Critical maximum current -curr[2-4]_crit_alarm Current critical high alarm - -in1_label "vin" -in1_input Measured input voltage -in1_crit Critical maximum input voltage -in1_crit_alarm Input voltage critical high alarm - -in[2-4]_label "vout[1-3]" -in[2-4]_input Measured output voltage -in[2-4]_lcrit Critical minimum output voltage -in[2-4]_lcrit_alarm Output voltage critical low alarm -in[2-4]_crit Critical maximum output voltage -in[2-4]_crit_alarm Output voltage critical high alarm - -power1_label "pin" -power1_input Measured input power -power1_alarm Input power high alarm - -power[2-4]_label "pout[1-3]" -power[2-4]_input Measured output power - -temp[1-3]_input Measured temperature -temp[1-3]_crit Critical high temperature -temp[1-3]_crit_alarm Chip temperature critical high alarm -temp[1-3]_max Maximum temperature -temp[1-3]_max_alarm Chip temperature high alarm diff --git a/Documentation/hwmon/pxe1610.rst b/Documentation/hwmon/pxe1610.rst new file mode 100644 index 000000000000..4f2388840d06 --- /dev/null +++ b/Documentation/hwmon/pxe1610.rst @@ -0,0 +1,107 @@ +Kernel driver pxe1610 +===================== + +Supported chips: + + * Infineon PXE1610 + + Prefix: 'pxe1610' + + Addresses scanned: - + + Datasheet: Datasheet is not publicly available. + + * Infineon PXE1110 + + Prefix: 'pxe1110' + + Addresses scanned: - + + Datasheet: Datasheet is not publicly available. + + * Infineon PXM1310 + + Prefix: 'pxm1310' + + Addresses scanned: - + + Datasheet: Datasheet is not publicly available. + +Author: Vijay Khemka + + +Description +----------- + +PXE1610/PXE1110 are Multi-rail/Multiphase Digital Controllers +and compliant to + + - Intel VR13 DC-DC converter specifications. + - Intel SVID protocol. + +Used for Vcore power regulation for Intel VR13 based microprocessors + + - Servers, Workstations, and High-end desktops + +PXM1310 is a Multi-rail Controller and it is compliant to + + - Intel VR13 DC-DC converter specifications. + - Intel SVID protocol. + +Used for DDR3/DDR4 Memory power regulation for Intel VR13 and +IMVP8 based systems + + +Usage Notes +----------- + +This driver does not probe for PMBus devices. You will have +to instantiate devices explicitly. + +Example: the following commands will load the driver for an PXE1610 +at address 0x70 on I2C bus #4:: + + # modprobe pxe1610 + # echo pxe1610 0x70 > /sys/bus/i2c/devices/i2c-4/new_device + +It can also be instantiated by declaring in device tree + + +Sysfs attributes +---------------- + +====================== ==================================== +curr1_label "iin" +curr1_input Measured input current +curr1_alarm Current high alarm + +curr[2-4]_label "iout[1-3]" +curr[2-4]_input Measured output current +curr[2-4]_crit Critical maximum current +curr[2-4]_crit_alarm Current critical high alarm + +in1_label "vin" +in1_input Measured input voltage +in1_crit Critical maximum input voltage +in1_crit_alarm Input voltage critical high alarm + +in[2-4]_label "vout[1-3]" +in[2-4]_input Measured output voltage +in[2-4]_lcrit Critical minimum output voltage +in[2-4]_lcrit_alarm Output voltage critical low alarm +in[2-4]_crit Critical maximum output voltage +in[2-4]_crit_alarm Output voltage critical high alarm + +power1_label "pin" +power1_input Measured input power +power1_alarm Input power high alarm + +power[2-4]_label "pout[1-3]" +power[2-4]_input Measured output power + +temp[1-3]_input Measured temperature +temp[1-3]_crit Critical high temperature +temp[1-3]_crit_alarm Chip temperature critical high alarm +temp[1-3]_max Maximum temperature +temp[1-3]_max_alarm Chip temperature high alarm +====================== ==================================== -- cgit v1.2.3-59-g8ed1b