Linux-Hwmon Archive on lore.kernel.org
 help / color / 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 v3 13/21] docs: hwmon: ads1015: convert to ReST format
Date: Wed, 17 Apr 2019 06:46:21 -0300
Message-ID: <1a1413f4f87db98026c59f79a278ed5e6cdd78d2.1555494108.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <cover.1555494108.git.mchehab+samsung@kernel.org>

Convert ads1015 to ReST format, in order to allow it to
be parsed by Sphinx.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/hwmon/ads1015 | 72 ++++++++++++++++++++++---------------
 1 file changed, 43 insertions(+), 29 deletions(-)

diff --git a/Documentation/hwmon/ads1015 b/Documentation/hwmon/ads1015
index 02d2a459385f..e0951c4e57bb 100644
--- a/Documentation/hwmon/ads1015
+++ b/Documentation/hwmon/ads1015
@@ -2,17 +2,25 @@ Kernel driver ads1015
 =====================
 
 Supported chips:
+
   * Texas Instruments ADS1015
+
     Prefix: 'ads1015'
-    Datasheet: Publicly available at the Texas Instruments website :
-               http://focus.ti.com/lit/ds/symlink/ads1015.pdf
+
+    Datasheet: Publicly available at the Texas Instruments website:
+
+	       http://focus.ti.com/lit/ds/symlink/ads1015.pdf
+
   * Texas Instruments ADS1115
+
     Prefix: 'ads1115'
-    Datasheet: Publicly available at the Texas Instruments website :
-               http://focus.ti.com/lit/ds/symlink/ads1115.pdf
+
+    Datasheet: Publicly available at the Texas Instruments website:
+
+	       http://focus.ti.com/lit/ds/symlink/ads1115.pdf
 
 Authors:
-        Dirk Eibach, Guntermann & Drunck GmbH <eibach@gdsys.de>
+	Dirk Eibach, Guntermann & Drunck GmbH <eibach@gdsys.de>
 
 Description
 -----------
@@ -24,14 +32,15 @@ This device is a 12/16-bit A-D converter with 4 inputs.
 The inputs can be used single ended or in certain differential combinations.
 
 The inputs can be made available by 8 sysfs input files in0_input - in7_input:
-in0: Voltage over AIN0 and AIN1.
-in1: Voltage over AIN0 and AIN3.
-in2: Voltage over AIN1 and AIN3.
-in3: Voltage over AIN2 and AIN3.
-in4: Voltage over AIN0 and GND.
-in5: Voltage over AIN1 and GND.
-in6: Voltage over AIN2 and GND.
-in7: Voltage over AIN3 and GND.
+
+  - in0: Voltage over AIN0 and AIN1.
+  - in1: Voltage over AIN0 and AIN3.
+  - in2: Voltage over AIN1 and AIN3.
+  - in3: Voltage over AIN2 and AIN3.
+  - in4: Voltage over AIN0 and GND.
+  - in5: Voltage over AIN1 and GND.
+  - in6: Voltage over AIN2 and GND.
+  - in7: Voltage over AIN3 and GND.
 
 Which inputs are available can be configured using platform data or devicetree.
 
@@ -42,29 +51,34 @@ Platform Data
 
 In linux/platform_data/ads1015.h platform data is defined, channel_data contains
 configuration data for the used input combinations:
+
 - pga is the programmable gain amplifier (values are full scale)
-  0: +/- 6.144 V
-  1: +/- 4.096 V
-  2: +/- 2.048 V
-  3: +/- 1.024 V
-  4: +/- 0.512 V
-  5: +/- 0.256 V
+
+    - 0: +/- 6.144 V
+    - 1: +/- 4.096 V
+    - 2: +/- 2.048 V
+    - 3: +/- 1.024 V
+    - 4: +/- 0.512 V
+    - 5: +/- 0.256 V
+
 - data_rate in samples per second
-  0: 128
-  1: 250
-  2: 490
-  3: 920
-  4: 1600
-  5: 2400
-  6: 3300
 
-Example:
-struct ads1015_platform_data data = {
+    - 0: 128
+    - 1: 250
+    - 2: 490
+    - 3: 920
+    - 4: 1600
+    - 5: 2400
+    - 6: 3300
+
+Example::
+
+  struct ads1015_platform_data data = {
 	.channel_data = {
 		[2] = { .enabled = true, .pga = 1, .data_rate = 0 },
 		[4] = { .enabled = true, .pga = 4, .data_rate = 5 },
 	}
-};
+  };
 
 In this case only in2_input (FS +/- 4.096 V, 128 SPS) and in4_input
 (FS +/- 0.512 V, 2400 SPS) would be created.
-- 
2.20.1


  parent reply index

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <cover.1555494108.git.mchehab+samsung@kernel.org>
2019-04-17  9:46 ` [PATCH v3 01/21] docs: hwmon: k10temp: " Mauro Carvalho Chehab
2019-04-17  9:46 ` [PATCH v3 02/21] docs: hwmon: vexpress: " Mauro Carvalho Chehab
2019-04-17 10:24   ` Liviu Dudau
2019-04-17 10:31     ` Mauro Carvalho Chehab
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 ` [PATCH v3 11/21] docs: hwmon: ibmpowernv: " Mauro Carvalho Chehab
2019-04-17  9:46 ` [PATCH v3 12/21] docs: hwmon: asc7621: " Mauro Carvalho Chehab
2019-04-17  9:46 ` Mauro Carvalho Chehab [this message]
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 21/21] docs: hwmon: Add an index file and rename docs to *.rst Mauro Carvalho Chehab
2019-04-17 11:31   ` Liviu Dudau
2019-04-17 16:47   ` Guenter Roeck
2019-04-17 16:54     ` Guenter Roeck
2019-04-17 17:13     ` Mauro Carvalho Chehab
2019-04-17 17:22       ` Mauro Carvalho Chehab
2019-04-17 17:43         ` Guenter Roeck
2019-04-17 17:47           ` Guenter Roeck
2019-04-18  9:44             ` Mauro Carvalho Chehab
2019-04-18 13:36               ` Guenter Roeck

Reply instructions:

You may reply publically 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=1a1413f4f87db98026c59f79a278ed5e6cdd78d2.1555494108.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

Linux-Hwmon Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-hwmon/0 linux-hwmon/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-hwmon linux-hwmon/ https://lore.kernel.org/linux-hwmon \
		linux-hwmon@vger.kernel.org linux-hwmon@archiver.kernel.org
	public-inbox-index linux-hwmon


Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-hwmon


AGPL code for this site: git clone https://public-inbox.org/ public-inbox