Merge tag 'for-linus-5.4-rc2-tag' of git://git.kernel.org/pub/scm/linux/kernel/git...
[platform/kernel/linux-starfive.git] / Documentation / hwmon / pxe1610.rst
1 Kernel driver pxe1610
2 =====================
3
4 Supported chips:
5
6   * Infineon PXE1610
7
8     Prefix: 'pxe1610'
9
10     Addresses scanned: -
11
12     Datasheet: Datasheet is not publicly available.
13
14   * Infineon PXE1110
15
16     Prefix: 'pxe1110'
17
18     Addresses scanned: -
19
20     Datasheet: Datasheet is not publicly available.
21
22   * Infineon PXM1310
23
24     Prefix: 'pxm1310'
25
26     Addresses scanned: -
27
28     Datasheet: Datasheet is not publicly available.
29
30 Author: Vijay Khemka <vijaykhemka@fb.com>
31
32
33 Description
34 -----------
35
36 PXE1610/PXE1110 are Multi-rail/Multiphase Digital Controllers
37 and compliant to
38
39         - Intel VR13 DC-DC converter specifications.
40         - Intel SVID protocol.
41
42 Used for Vcore power regulation for Intel VR13 based microprocessors
43
44         - Servers, Workstations, and High-end desktops
45
46 PXM1310 is a Multi-rail Controller and it is compliant to
47
48         - Intel VR13 DC-DC converter specifications.
49         - Intel SVID protocol.
50
51 Used for DDR3/DDR4 Memory power regulation for Intel VR13 and
52 IMVP8 based systems
53
54
55 Usage Notes
56 -----------
57
58 This driver does not probe for PMBus devices. You will have
59 to instantiate devices explicitly.
60
61 Example: the following commands will load the driver for an PXE1610
62 at address 0x70 on I2C bus #4::
63
64     # modprobe pxe1610
65     # echo pxe1610 0x70 > /sys/bus/i2c/devices/i2c-4/new_device
66
67 It can also be instantiated by declaring in device tree
68
69
70 Sysfs attributes
71 ----------------
72
73 ======================  ====================================
74 curr1_label             "iin"
75 curr1_input             Measured input current
76 curr1_alarm             Current high alarm
77
78 curr[2-4]_label         "iout[1-3]"
79 curr[2-4]_input         Measured output current
80 curr[2-4]_crit          Critical maximum current
81 curr[2-4]_crit_alarm    Current critical high alarm
82
83 in1_label               "vin"
84 in1_input               Measured input voltage
85 in1_crit                Critical maximum input voltage
86 in1_crit_alarm          Input voltage critical high alarm
87
88 in[2-4]_label           "vout[1-3]"
89 in[2-4]_input           Measured output voltage
90 in[2-4]_lcrit           Critical minimum output voltage
91 in[2-4]_lcrit_alarm     Output voltage critical low alarm
92 in[2-4]_crit            Critical maximum output voltage
93 in[2-4]_crit_alarm      Output voltage critical high alarm
94
95 power1_label            "pin"
96 power1_input            Measured input power
97 power1_alarm            Input power high alarm
98
99 power[2-4]_label        "pout[1-3]"
100 power[2-4]_input        Measured output power
101
102 temp[1-3]_input         Measured temperature
103 temp[1-3]_crit          Critical high temperature
104 temp[1-3]_crit_alarm    Chip temperature critical high alarm
105 temp[1-3]_max           Maximum temperature
106 temp[1-3]_max_alarm     Chip temperature high alarm
107 ======================  ====================================