xref: /linux/Documentation/hwmon/wm831x.rst (revision 7ebd8b66dd9e5a0b65e5ee5e2b8e7ca382ec97b7)
1*7ebd8b66SMauro Carvalho ChehabKernel driver wm831x-hwmon
2*7ebd8b66SMauro Carvalho Chehab==========================
3*7ebd8b66SMauro Carvalho Chehab
4*7ebd8b66SMauro Carvalho ChehabSupported chips:
5*7ebd8b66SMauro Carvalho Chehab  * Wolfson Microelectronics WM831x PMICs
6*7ebd8b66SMauro Carvalho Chehab
7*7ebd8b66SMauro Carvalho Chehab    Prefix: 'wm831x'
8*7ebd8b66SMauro Carvalho Chehab
9*7ebd8b66SMauro Carvalho Chehab    Datasheet:
10*7ebd8b66SMauro Carvalho Chehab
11*7ebd8b66SMauro Carvalho Chehab	- http://www.wolfsonmicro.com/products/WM8310
12*7ebd8b66SMauro Carvalho Chehab	- http://www.wolfsonmicro.com/products/WM8311
13*7ebd8b66SMauro Carvalho Chehab	- http://www.wolfsonmicro.com/products/WM8312
14*7ebd8b66SMauro Carvalho Chehab
15*7ebd8b66SMauro Carvalho ChehabAuthors: Mark Brown <broonie@opensource.wolfsonmicro.com>
16*7ebd8b66SMauro Carvalho Chehab
17*7ebd8b66SMauro Carvalho ChehabDescription
18*7ebd8b66SMauro Carvalho Chehab-----------
19*7ebd8b66SMauro Carvalho Chehab
20*7ebd8b66SMauro Carvalho ChehabThe WM831x series of PMICs include an AUXADC which can be used to
21*7ebd8b66SMauro Carvalho Chehabmonitor a range of system operating parameters, including the voltages
22*7ebd8b66SMauro Carvalho Chehabof the major supplies within the system.  Currently the driver provides
23*7ebd8b66SMauro Carvalho Chehabreporting of all the input values but does not provide any alarms.
24*7ebd8b66SMauro Carvalho Chehab
25*7ebd8b66SMauro Carvalho ChehabVoltage Monitoring
26*7ebd8b66SMauro Carvalho Chehab------------------
27*7ebd8b66SMauro Carvalho Chehab
28*7ebd8b66SMauro Carvalho ChehabVoltages are sampled by a 12 bit ADC.  Voltages in millivolts are 1.465
29*7ebd8b66SMauro Carvalho Chehabtimes the ADC value.
30*7ebd8b66SMauro Carvalho Chehab
31*7ebd8b66SMauro Carvalho ChehabTemperature Monitoring
32*7ebd8b66SMauro Carvalho Chehab----------------------
33*7ebd8b66SMauro Carvalho Chehab
34*7ebd8b66SMauro Carvalho ChehabTemperatures are sampled by a 12 bit ADC.  Chip and battery temperatures
35*7ebd8b66SMauro Carvalho Chehabare available.  The chip temperature is calculated as:
36*7ebd8b66SMauro Carvalho Chehab
37*7ebd8b66SMauro Carvalho Chehab	Degrees celsius = (512.18 - data) / 1.0983
38*7ebd8b66SMauro Carvalho Chehab
39*7ebd8b66SMauro Carvalho Chehabwhile the battery temperature calculation will depend on the NTC
40*7ebd8b66SMauro Carvalho Chehabthermistor component.
41