docs: hwmon: da9052, da9055: convert to ReST format

Convert da9052 and da9055 to ReST format, in order to allow
them to be parsed by Sphinx.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
This commit is contained in:
Mauro Carvalho Chehab 2019-04-17 06:46:24 -03:00 committed by Guenter Roeck
parent 4f1158b355
commit 08fae079ea
2 changed files with 44 additions and 17 deletions

View File

@ -1,6 +1,12 @@
Kernel driver da9052
====================
Supported chips: Supported chips:
* Dialog Semiconductors DA9052-BC and DA9053-AA/Bx PMICs * Dialog Semiconductors DA9052-BC and DA9053-AA/Bx PMICs
Prefix: 'da9052' Prefix: 'da9052'
Datasheet: Datasheet is not publicly available. Datasheet: Datasheet is not publicly available.
Authors: David Dajun Chen <dchen@diasemi.com> Authors: David Dajun Chen <dchen@diasemi.com>
@ -15,17 +21,20 @@ different inputs. The track and hold circuit ensures stable input voltages at
the input of the ADC during the conversion. the input of the ADC during the conversion.
The ADC is used to measure the following inputs: The ADC is used to measure the following inputs:
Channel 0: VDDOUT - measurement of the system voltage
Channel 1: ICH - internal battery charger current measurement ========= ===================================================================
Channel 2: TBAT - output from the battery NTC Channel 0 VDDOUT - measurement of the system voltage
Channel 3: VBAT - measurement of the battery voltage Channel 1 ICH - internal battery charger current measurement
Channel 4: ADC_IN4 - high impedance input (0 - 2.5V) Channel 2 TBAT - output from the battery NTC
Channel 5: ADC_IN5 - high impedance input (0 - 2.5V) Channel 3 VBAT - measurement of the battery voltage
Channel 6: ADC_IN6 - high impedance input (0 - 2.5V) Channel 4 ADC_IN4 - high impedance input (0 - 2.5V)
Channel 7: XY - TSI interface to measure the X and Y voltage of the touch Channel 5 ADC_IN5 - high impedance input (0 - 2.5V)
screen resistive potentiometers Channel 6 ADC_IN6 - high impedance input (0 - 2.5V)
Channel 8: Internal Tjunc. - sense (internal temp. sensor) Channel 7 XY - TSI interface to measure the X and Y voltage of the touch
Channel 9: VBBAT - measurement of the backup battery voltage screen resistive potentiometers
Channel 8 Internal Tjunc. - sense (internal temp. sensor)
Channel 9 VBBAT - measurement of the backup battery voltage
========= ===================================================================
By using sysfs attributes we can measure the system voltage VDDOUT, the battery By using sysfs attributes we can measure the system voltage VDDOUT, the battery
charging current ICH, battery temperature TBAT, battery junction temperature charging current ICH, battery temperature TBAT, battery junction temperature
@ -37,12 +46,15 @@ Voltage Monitoring
Voltages are sampled by a 10 bit ADC. Voltages are sampled by a 10 bit ADC.
The battery voltage is calculated as: The battery voltage is calculated as:
Milli volt = ((ADC value * 1000) / 512) + 2500 Milli volt = ((ADC value * 1000) / 512) + 2500
The backup battery voltage is calculated as: The backup battery voltage is calculated as:
Milli volt = (ADC value * 2500) / 512; Milli volt = (ADC value * 2500) / 512;
The voltages on ADC channels 4, 5 and 6 are calculated as: The voltages on ADC channels 4, 5 and 6 are calculated as:
Milli volt = (ADC value * 2500) / 1023 Milli volt = (ADC value * 2500) / 1023
Temperature Monitoring Temperature Monitoring
@ -52,10 +64,15 @@ Temperatures are sampled by a 10 bit ADC. Junction and battery temperatures
are monitored by the ADC channels. are monitored by the ADC channels.
The junction temperature is calculated: The junction temperature is calculated:
Degrees celsius = 1.708 * (TJUNC_RES - T_OFFSET) - 108.8 Degrees celsius = 1.708 * (TJUNC_RES - T_OFFSET) - 108.8
The junction temperature attribute is supported by the driver. The junction temperature attribute is supported by the driver.
The battery temperature is calculated: The battery temperature is calculated:
Degree Celsius = 1 / (t1 + 1/298)- 273
Degree Celsius = 1 / (t1 + 1/298) - 273
where t1 = (1/B)* ln(( ADCval * 2.5)/(R25*ITBAT*255)) where t1 = (1/B)* ln(( ADCval * 2.5)/(R25*ITBAT*255))
Default values of R25, B, ITBAT are 10e3, 3380 and 50e-6 respectively. Default values of R25, B, ITBAT are 10e3, 3380 and 50e-6 respectively.

View File

@ -1,6 +1,11 @@
Kernel driver da9055
====================
Supported chips: Supported chips:
* Dialog Semiconductors DA9055 PMIC * Dialog Semiconductors DA9055 PMIC
Prefix: 'da9055' Prefix: 'da9055'
Datasheet: Datasheet is not publicly available. Datasheet: Datasheet is not publicly available.
Authors: David Dajun Chen <dchen@diasemi.com> Authors: David Dajun Chen <dchen@diasemi.com>
@ -15,11 +20,12 @@ different inputs. The track and hold circuit ensures stable input voltages at
the input of the ADC during the conversion. the input of the ADC during the conversion.
The ADC is used to measure the following inputs: The ADC is used to measure the following inputs:
Channel 0: VDDOUT - measurement of the system voltage
Channel 1: ADC_IN1 - high impedance input (0 - 2.5V) - Channel 0: VDDOUT - measurement of the system voltage
Channel 2: ADC_IN2 - high impedance input (0 - 2.5V) - Channel 1: ADC_IN1 - high impedance input (0 - 2.5V)
Channel 3: ADC_IN3 - high impedance input (0 - 2.5V) - Channel 2: ADC_IN2 - high impedance input (0 - 2.5V)
Channel 4: Internal Tjunc. - sense (internal temp. sensor) - Channel 3: ADC_IN3 - high impedance input (0 - 2.5V)
- Channel 4: Internal Tjunc. - sense (internal temp. sensor)
By using sysfs attributes we can measure the system voltage VDDOUT, By using sysfs attributes we can measure the system voltage VDDOUT,
chip junction temperature and auxiliary channels voltages. chip junction temperature and auxiliary channels voltages.
@ -31,9 +37,11 @@ Voltages are sampled in a AUTO mode it can be manually sampled too and results
are stored in a 10 bit ADC. are stored in a 10 bit ADC.
The system voltage is calculated as: The system voltage is calculated as:
Milli volt = ((ADC value * 1000) / 85) + 2500 Milli volt = ((ADC value * 1000) / 85) + 2500
The voltages on ADC channels 1, 2 and 3 are calculated as: The voltages on ADC channels 1, 2 and 3 are calculated as:
Milli volt = (ADC value * 1000) / 102 Milli volt = (ADC value * 1000) / 102
Temperature Monitoring Temperature Monitoring
@ -43,5 +51,7 @@ Temperatures are sampled by a 10 bit ADC. Junction temperatures
are monitored by the ADC channels. are monitored by the ADC channels.
The junction temperature is calculated: The junction temperature is calculated:
Degrees celsius = -0.4084 * (ADC_RES - T_OFFSET) + 307.6332 Degrees celsius = -0.4084 * (ADC_RES - T_OFFSET) + 307.6332
The junction temperature attribute is supported by the driver. The junction temperature attribute is supported by the driver.