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 06/21] docs: hwmon: pc87360: convert to ReST format
Date: Wed, 17 Apr 2019 06:46:14 -0300
Message-ID: <a45618c63e12dc75c2c72ac8c18accb661c4ecb1.1555494108.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <cover.1555494108.git.mchehab+samsung@kernel.org>

Convert pc87360 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/pc87360 | 38 +++++++++++++++++++++++++------------
 1 file changed, 26 insertions(+), 12 deletions(-)

diff --git a/Documentation/hwmon/pc87360 b/Documentation/hwmon/pc87360
index d5f5cf16ce59..4bad07bce54b 100644
--- a/Documentation/hwmon/pc87360
+++ b/Documentation/hwmon/pc87360
@@ -2,14 +2,19 @@ Kernel driver pc87360
 =====================
 
 Supported chips:
+
   * National Semiconductor PC87360, PC87363, PC87364, PC87365 and PC87366
+
     Prefixes: 'pc87360', 'pc87363', 'pc87364', 'pc87365', 'pc87366'
+
     Addresses scanned: none, address read from Super I/O config space
+
     Datasheets: No longer available
 
 Authors: Jean Delvare <jdelvare@suse.de>
 
 Thanks to Sandeep Mehta, Tonko de Rooy and Daniel Ceregatti for testing.
+
 Thanks to Rudolf Marek for helping me investigate conversion issues.
 
 
@@ -17,11 +22,13 @@ Module Parameters
 -----------------
 
 * init int
-  Chip initialization level:
-   0: None
-  *1: Forcibly enable internal voltage and temperature channels, except in9
-   2: Forcibly enable all voltage and temperature channels, except in9
-   3: Forcibly enable all voltage and temperature channels, including in9
+    Chip initialization level:
+
+    - 0: None
+    - **1**: Forcibly enable internal voltage and temperature channels,
+      except in9
+    - 2: Forcibly enable all voltage and temperature channels, except in9
+    - 3: Forcibly enable all voltage and temperature channels, including in9
 
 Note that this parameter has no effect for the PC87360, PC87363 and PC87364
 chips.
@@ -43,13 +50,15 @@ hardware monitoring chipsets, not only controlling and monitoring three fans,
 but also monitoring eleven voltage inputs and two (PC87365) or up to four
 (PC87366) temperatures.
 
+  =========== ======= ======= ======= ======= =====
   Chip        #vin    #fan    #pwm    #temp   devid
-
+  =========== ======= ======= ======= ======= =====
   PC87360     -       2       2       -       0xE1
   PC87363     -       2       2       -       0xE8
   PC87364     -       3       3       -       0xE4
   PC87365     11      3       3       2       0xE5
   PC87366     11      3       3       3-4     0xE9
+  =========== ======= ======= ======= ======= =====
 
 The driver assumes that no more than one chip is present, and one of the
 standard Super I/O addresses is used (0x2E/0x2F or 0x4E/0x4F)
@@ -68,18 +77,23 @@ have to care no more.
 
 For reference, here are a few values about clock dividers:
 
-                slowest         accuracy        highest
-                measurable      around 3000     accurate
+    =========== =============== =============== ===========
+		slowest         accuracy        highest
+		measurable      around 3000     accurate
     divider     speed (RPM)     RPM (RPM)       speed (RPM)
-         1        1882              18           6928
-         2         941              37           4898
-         4         470              74           3464
-         8         235             150           2449
+    =========== =============== =============== ===========
+	 1        1882              18           6928
+	 2         941              37           4898
+	 4         470              74           3464
+	 8         235             150           2449
+    =========== =============== =============== ===========
 
 For the curious, here is how the values above were computed:
+
  * slowest measurable speed: clock/(255*divider)
  * accuracy around 3000 RPM: 3000^2/clock
  * highest accurate speed: sqrt(clock*100)
+
 The clock speed for the PC87360 family is 480 kHz. I arbitrarily chose 100
 RPM as the lowest acceptable accuracy.
 
-- 
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 ` Mauro Carvalho Chehab [this message]
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 ` [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 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=a45618c63e12dc75c2c72ac8c18accb661c4ecb1.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