Merge tag 'dlm-5.15' of git://git.kernel.org/pub/scm/linux/kernel/git/teigland/linux-dlm
[linux-2.6-microblaze.git] / Documentation / hwmon / pim4328.rst
1 .. SPDX-License-Identifier: GPL-2.0
2
3 Kernel driver pim4328
4 =====================
5
6 Supported chips:
7
8   * Flex PIM4328
9
10     Prefix: 'pim4328', 'bmr455'
11
12     Addresses scanned: -
13
14     Datasheet:
15
16 https://flexpowermodules.com/resources/fpm-techspec-pim4328
17
18   * Flex PIM4820
19
20     Prefixes: 'pim4820'
21
22     Addresses scanned: -
23
24     Datasheet: https://flexpowermodules.com/resources/fpm-techspec-pim4820
25
26   * Flex PIM4006, PIM4106, PIM4206, PIM4306, PIM4406
27
28     Prefixes: 'pim4006', 'pim4106', 'pim4206', 'pim4306', 'pim4406'
29
30     Addresses scanned: -
31
32     Datasheet: https://flexpowermodules.com/resources/fpm-techspec-pim4006
33
34 Author: Erik Rosen <erik.rosen@metormote.com>
35
36
37 Description
38 -----------
39
40 This driver supports hardware monitoring for Flex PIM4328 and
41 compatible digital power interface modules.
42
43 The driver is a client driver to the core PMBus driver. Please see
44 Documentation/hwmon/pmbus.rst and Documentation.hwmon/pmbus-core for details
45 on PMBus client drivers.
46
47
48 Usage Notes
49 -----------
50
51 This driver does not auto-detect devices. You will have to instantiate the
52 devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
53 details.
54
55
56 Platform data support
57 ---------------------
58
59 The driver supports standard PMBus driver platform data.
60
61
62 Sysfs entries
63 -------------
64
65 The following attributes are supported. All attributes are read-only.
66
67 ======================= ========================================================
68 in1_label               "vin"
69 in1_input               Measured input voltage.
70 in1_alarm               Input voltage alarm.
71
72 in2_label               "vin.0"
73 in2_input               Measured input voltage on input A.
74
75                         PIM4328 and PIM4X06
76
77 in3_label               "vin.1"
78 in3_input               Measured input voltage on input B.
79
80                         PIM4328 and PIM4X06
81
82 in4_label               "vcap"
83 in4_input               Measured voltage on holdup capacitor.
84
85                         PIM4328
86
87 curr1_label             "iin.0"
88 curr1_input             Measured input current on input A.
89
90                         PIM4X06
91
92 curr2_label             "iin.1"
93 curr2_input             Measured input current on input B.
94
95                         PIM4X06
96
97 currX_label             "iout1"
98 currX_input             Measured output current.
99 currX_alarm             Output current alarm.
100
101                         X is 1 for PIM4820, 3 otherwise.
102
103 temp1_input             Measured temperature.
104 temp1_alarm             High temperature alarm.
105 ======================= ========================================================