All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	Jean Delvare <jdelvare@suse.com>,
	Guenter Roeck <linux@roeck-us.net>,
	linux-hwmon@vger.kernel.org
Subject: [PATCH v2 16/21] docs: hwmon: da9052, da9055: convert to ReST format
Date: Wed, 10 Apr 2019 16:22:53 -0300	[thread overview]
Message-ID: <53f1f767bdef56b1d9d042b4dc2506625eb5ed05.1554923967.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <cover.1554923967.git.mchehab+samsung@kernel.org>

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>
---
 Documentation/hwmon/da9052 | 40 ++++++++++++++++++++++++++------------
 Documentation/hwmon/da9055 | 20 ++++++++++++++-----
 2 files changed, 43 insertions(+), 17 deletions(-)

diff --git a/Documentation/hwmon/da9052 b/Documentation/hwmon/da9052
index 5bc51346b689..556e2778b9e5 100644
--- a/Documentation/hwmon/da9052
+++ b/Documentation/hwmon/da9052
@@ -1,6 +1,12 @@
+Kernel driver da9052
+====================
+
 Supported chips:
+
   * Dialog Semiconductors DA9052-BC and DA9053-AA/Bx PMICs
+
     Prefix: 'da9052'
+
     Datasheet: Datasheet is not publicly available.
 
 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 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 3: VBAT - measurement of the battery voltage
-Channel 4: ADC_IN4 - high impedance input (0 - 2.5V)
-Channel 5: ADC_IN5 - high impedance input (0 - 2.5V)
-Channel 6: ADC_IN6 - high impedance input (0 - 2.5V)
-Channel 7: XY - TSI interface to measure the X and Y voltage of the touch
-	   screen resistive potentiometers
-Channel 8: Internal Tjunc. - sense (internal temp. sensor)
-Channel 9: VBBAT - measurement of the backup battery voltage
+
+========= ===================================================================
+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 3 VBAT - measurement of the battery voltage
+Channel 4 ADC_IN4 - high impedance input (0 - 2.5V)
+Channel 5 ADC_IN5 - high impedance input (0 - 2.5V)
+Channel 6 ADC_IN6 - high impedance input (0 - 2.5V)
+Channel 7 XY - TSI interface to measure the X and Y voltage of the touch
+	  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
 charging current ICH, battery temperature TBAT, battery junction temperature
@@ -37,12 +46,15 @@ Voltage Monitoring
 Voltages are sampled by a 10 bit ADC.
 
 The battery voltage is calculated as:
+
 	Milli volt = ((ADC value * 1000) / 512) + 2500
 
 The backup battery voltage is calculated as:
+
 	Milli volt = (ADC value * 2500) / 512;
 
 The voltages on ADC channels 4, 5 and 6 are calculated as:
+
 	Milli volt = (ADC value * 2500) / 1023
 
 Temperature Monitoring
@@ -52,10 +64,14 @@ Temperatures are sampled by a 10 bit ADC.  Junction and battery temperatures
 are monitored by the ADC channels.
 
 The junction temperature is calculated:
+
 	Degrees celsius = 1.708 * (TJUNC_RES - T_OFFSET) - 108.8
+
 The junction temperature attribute is supported by the driver.
 
 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))
 Default values of R25, B, ITBAT are 10e3, 3380 and 50e-6 respectively.
diff --git a/Documentation/hwmon/da9055 b/Documentation/hwmon/da9055
index 855c3f536e00..beae271a3312 100644
--- a/Documentation/hwmon/da9055
+++ b/Documentation/hwmon/da9055
@@ -1,6 +1,11 @@
+Kernel driver da9055
+====================
+
 Supported chips:
   * Dialog Semiconductors DA9055 PMIC
+
     Prefix: 'da9055'
+
     Datasheet: Datasheet is not publicly available.
 
 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 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 2: ADC_IN2 - high impedance input (0 - 2.5V)
-Channel 3: ADC_IN3 - high impedance input (0 - 2.5V)
-Channel 4: Internal Tjunc. - sense (internal temp. sensor)
+
+- Channel 0: VDDOUT - measurement of the system voltage
+- Channel 1: ADC_IN1 - high impedance input (0 - 2.5V)
+- Channel 2: ADC_IN2 - high impedance input (0 - 2.5V)
+- 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,
 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.
 
 The system voltage is calculated as:
+
 	Milli volt = ((ADC value * 1000) / 85) + 2500
 
 The voltages on ADC channels 1, 2 and 3 are calculated as:
+
 	Milli volt = (ADC value * 1000) / 102
 
 Temperature Monitoring
@@ -43,5 +51,7 @@ Temperatures are sampled by a 10 bit ADC.  Junction temperatures
 are monitored by the ADC channels.
 
 The junction temperature is calculated:
+
 	Degrees celsius = -0.4084 * (ADC_RES - T_OFFSET) + 307.6332
+
 The junction temperature attribute is supported by the driver.
-- 
2.20.1


  parent reply	other threads:[~2019-04-10 19:24 UTC|newest]

Thread overview: 150+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-04-10 19:22 [PATCH v2 00/21] Convert hwmon documentation to ReST Mauro Carvalho Chehab
2019-04-10 19:22 ` Mauro Carvalho Chehab
2019-04-10 19:22 ` Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 01/21] docs: hwmon: k10temp: convert to ReST format Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 02/21] docs: hwmon: vexpress: " Mauro Carvalho Chehab
2019-04-10 19:22   ` Mauro Carvalho Chehab
2019-04-11 13:05   ` Liviu Dudau
2019-04-11 13:05     ` Liviu Dudau
2019-04-10 19:22 ` [PATCH v2 03/21] docs: hwmon: menf21bmc: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 04/21] docs: hwmon: sch5627: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 05/21] docs: hwmon: emc2103: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 06/21] docs: hwmon: pc87360: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 07/21] docs: hwmon: fam15h_power: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 08/21] docs: hwmon: w83791d: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 09/21] docs: hwmon: coretemp: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 10/21] docs: hwmon: aspeed-pwm-tacho: " Mauro Carvalho Chehab
2019-04-10 19:22   ` Mauro Carvalho Chehab
2019-04-11  0:27   ` Andrew Jeffery
2019-04-11  0:27     ` Andrew Jeffery
2019-04-10 19:22 ` [PATCH v2 11/21] docs: hwmon: ibmpowernv: " Mauro Carvalho Chehab
2019-04-10 19:22   ` Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 12/21] docs: hwmon: asc7621: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 13/21] docs: hwmon: ads1015: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 14/21] docs: hwmon: dme1737, vt1211: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 15/21] docs: hwmon: wm831x, wm8350: " Mauro Carvalho Chehab
2019-04-10 19:22 ` Mauro Carvalho Chehab [this message]
2019-04-10 19:22 ` [PATCH v2 17/21] docs: hwmon: k8temp, w83793: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 18/21] docs: hwmon: pmbus files: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 19/21] docs: hwmon: misc " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 20/21] docs: hwmon: convert remaining files " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 21/21] docs: hwmon: Add an index file and rename docs to *.rst Mauro Carvalho Chehab
2019-04-10 19:22   ` Mauro Carvalho Chehab
2019-04-10 19:22   ` Mauro Carvalho Chehab
2019-04-10 19:22   ` Mauro Carvalho Chehab
2019-04-11 13:07   ` Liviu Dudau
2019-04-11 13:07     ` Liviu Dudau
2019-04-11 13:07     ` Liviu Dudau
2019-04-11 13:07     ` Liviu Dudau
2019-04-11 18:43 ` [PATCH v2 00/21] Convert hwmon documentation to ReST Jonathan Corbet
2019-04-11 18:43   ` Jonathan Corbet
2019-04-11 18:43   ` Jonathan Corbet
2019-04-11 20:43   ` Mauro Carvalho Chehab
2019-04-11 20:43     ` Mauro Carvalho Chehab
2019-04-11 20:43     ` Mauro Carvalho Chehab
2019-04-11 21:07     ` Guenter Roeck
2019-04-11 21:07       ` Guenter Roeck
2019-04-11 21:07       ` Guenter Roeck
2019-04-11 23:54       ` Mauro Carvalho Chehab
2019-04-11 23:54         ` Mauro Carvalho Chehab
2019-04-11 23:54         ` Mauro Carvalho Chehab
2019-04-12 16:04       ` Jonathan Corbet
2019-04-12 16:04         ` Jonathan Corbet
2019-04-12 16:04         ` Jonathan Corbet
2019-04-12 16:12         ` Guenter Roeck
2019-04-12 16:12           ` Guenter Roeck
2019-04-12 16:12           ` Guenter Roeck
2019-04-13  0:25           ` Mauro Carvalho Chehab
2019-04-13  0:25             ` Mauro Carvalho Chehab
2019-04-13  0:25             ` Mauro Carvalho Chehab
2019-04-13  0:52             ` Guenter Roeck
2019-04-13  0:52               ` Guenter Roeck
2019-04-13  0:52               ` Guenter Roeck
2019-04-13  3:09         ` Guenter Roeck
2019-04-13  3:09           ` Guenter Roeck
2019-04-13  3:09           ` Guenter Roeck
2019-04-16 20:19           ` Jonathan Corbet
2019-04-16 20:19             ` Jonathan Corbet
2019-04-16 20:19             ` Jonathan Corbet
2019-04-16 20:31             ` Guenter Roeck
2019-04-16 20:31               ` Guenter Roeck
2019-04-16 20:31               ` Guenter Roeck
2019-04-17  1:58               ` Mauro Carvalho Chehab
2019-04-17  1:58                 ` Mauro Carvalho Chehab
2019-04-17  1:58                 ` Mauro Carvalho Chehab
2019-04-17  3:49                 ` Guenter Roeck
2019-04-17  3:49                   ` Guenter Roeck
2019-04-17  3:49                   ` Guenter Roeck
2019-04-17  9:46                   ` [PATCH v3 00/21]Convert " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 01/21] docs: hwmon: k10temp: convert to ReST format Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 02/21] docs: hwmon: vexpress: " Mauro Carvalho Chehab
2019-04-17  9:46                       ` Mauro Carvalho Chehab
2019-04-17 10:24                       ` Liviu Dudau
2019-04-17 10:24                         ` Liviu Dudau
2019-04-17 10:31                         ` Mauro Carvalho Chehab
2019-04-17 10:31                           ` Mauro Carvalho Chehab
2019-04-17 11:29                       ` Liviu Dudau
2019-04-17 11:29                         ` Liviu Dudau
2019-04-17  9:46                     ` [PATCH v3 03/21] docs: hwmon: menf21bmc: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 04/21] docs: hwmon: sch5627: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 05/21] docs: hwmon: emc2103: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 06/21] docs: hwmon: pc87360: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 07/21] docs: hwmon: fam15h_power: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 08/21] docs: hwmon: w83791d: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 09/21] docs: hwmon: coretemp: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 10/21] docs: hwmon: aspeed-pwm-tacho: " Mauro Carvalho Chehab
2019-04-17  9:46                       ` Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 11/21] docs: hwmon: ibmpowernv: " Mauro Carvalho Chehab
2019-04-17  9:46                       ` Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 12/21] docs: hwmon: asc7621: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 13/21] docs: hwmon: ads1015: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 14/21] docs: hwmon: dme1737, vt1211: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 15/21] docs: hwmon: wm831x, wm8350: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 16/21] docs: hwmon: da9052, da9055: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 17/21] docs: hwmon: k8temp, w83793: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 18/21] docs: hwmon: pmbus files: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 19/21] docs: hwmon: misc " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 20/21] docs: hwmon: convert remaining files " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 21/21] docs: hwmon: Add an index file and rename docs to *.rst Mauro Carvalho Chehab
2019-04-17  9:46                       ` Mauro Carvalho Chehab
2019-04-17  9:46                       ` Mauro Carvalho Chehab
2019-04-17  9:46                       ` Mauro Carvalho Chehab
2019-04-17 11:31                       ` Liviu Dudau
2019-04-17 11:31                         ` Liviu Dudau
2019-04-17 11:31                         ` Liviu Dudau
2019-04-17 11:31                         ` Liviu Dudau
2019-04-17 16:47                       ` Guenter Roeck
2019-04-17 16:47                         ` Guenter Roeck
2019-04-17 16:47                         ` Guenter Roeck
2019-04-17 16:47                         ` Guenter Roeck
2019-04-17 16:54                         ` Guenter Roeck
2019-04-17 16:54                           ` Guenter Roeck
2019-04-17 16:54                           ` Guenter Roeck
2019-04-17 16:54                           ` Guenter Roeck
2019-04-17 17:13                         ` Mauro Carvalho Chehab
2019-04-17 17:13                           ` Mauro Carvalho Chehab
2019-04-17 17:13                           ` Mauro Carvalho Chehab
2019-04-17 17:13                           ` Mauro Carvalho Chehab
2019-04-17 17:22                           ` Mauro Carvalho Chehab
2019-04-17 17:22                             ` Mauro Carvalho Chehab
2019-04-17 17:22                             ` Mauro Carvalho Chehab
2019-04-17 17:22                             ` Mauro Carvalho Chehab
2019-04-17 17:43                             ` Guenter Roeck
2019-04-17 17:43                               ` Guenter Roeck
2019-04-17 17:43                               ` Guenter Roeck
2019-04-17 17:43                               ` Guenter Roeck
2019-04-17 17:47                               ` Guenter Roeck
2019-04-17 17:47                                 ` Guenter Roeck
2019-04-17 17:47                                 ` Guenter Roeck
2019-04-17 17:47                                 ` Guenter Roeck
2019-04-18  9:44                                 ` Mauro Carvalho Chehab
2019-04-18  9:44                                   ` Mauro Carvalho Chehab
2019-04-18  9:44                                   ` Mauro Carvalho Chehab
2019-04-18  9:44                                   ` Mauro Carvalho Chehab
2019-04-18 13:36                                   ` Guenter Roeck
2019-04-18 13:36                                     ` Guenter Roeck
2019-04-18 13:36                                     ` Guenter Roeck
2019-04-18 13:36                                     ` Guenter Roeck
2019-04-17  9:47                   ` [PATCH v2 00/21] Convert hwmon documentation to ReST Mauro Carvalho Chehab
2019-04-17  9:47                     ` Mauro Carvalho Chehab
2019-04-17  9:47                     ` Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=53f1f767bdef56b1d9d042b4dc2506625eb5ed05.1554923967.git.mchehab+samsung@kernel.org \
    --to=mchehab+samsung@kernel.org \
    --cc=corbet@lwn.net \
    --cc=jdelvare@suse.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-hwmon@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@roeck-us.net \
    --cc=mchehab@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.