linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	linux-media@vger.kernel.org
Subject: [PATCH v2 13/22] media: docs: split uAPI info from saa7134-devel.rst
Date: Tue, 10 Mar 2020 14:43:04 +0100	[thread overview]
Message-ID: <b29aa35ac3639d2f75344cdd2b32bb4a834fae11.1583847556.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1583847556.git.mchehab+huawei@kernel.org>

This file contains both driver develompent documentation and
userspace API.

Split on two, as they're usually read by different audiences.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/media/v4l-drivers/index.rst     |  1 +
 .../media/v4l-drivers/saa7134-devel.rst       | 67 +++++++++++++++++++
 Documentation/media/v4l-drivers/saa7134.rst   | 54 ---------------
 3 files changed, 68 insertions(+), 54 deletions(-)
 create mode 100644 Documentation/media/v4l-drivers/saa7134-devel.rst

diff --git a/Documentation/media/v4l-drivers/index.rst b/Documentation/media/v4l-drivers/index.rst
index adf72937b119..6fdfd9a41913 100644
--- a/Documentation/media/v4l-drivers/index.rst
+++ b/Documentation/media/v4l-drivers/index.rst
@@ -71,6 +71,7 @@ For more details see the file COPYING in the source distribution of Linux.
 	cx88-devel
 	davinci-vpbe-devel
 	fimc-devel
+	saa7134-devel
 	vimc-devel
 
 	cx2341x-uapi
diff --git a/Documentation/media/v4l-drivers/saa7134-devel.rst b/Documentation/media/v4l-drivers/saa7134-devel.rst
new file mode 100644
index 000000000000..167fd729bc8c
--- /dev/null
+++ b/Documentation/media/v4l-drivers/saa7134-devel.rst
@@ -0,0 +1,67 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+The saa7134 driver
+==================
+
+Author Gerd Hoffmann
+
+
+Card Variations:
+----------------
+
+Cards can use either of these two crystals (xtal):
+
+- 32.11 MHz -> .audio_clock=0x187de7
+- 24.576MHz -> .audio_clock=0x200000 (xtal * .audio_clock = 51539600)
+
+Some details about 30/34/35:
+
+- saa7130 - low-price chip, doesn't have mute, that is why all those
+  cards should have .mute field defined in their tuner structure.
+
+- saa7134 - usual chip
+
+- saa7133/35 - saa7135 is probably a marketing decision, since all those
+  chips identifies itself as 33 on pci.
+
+LifeView GPIOs
+--------------
+
+This section was authored by: Peter Missel <peter.missel@onlinehome.de>
+
+- LifeView FlyTV Platinum FM (LR214WF)
+
+    - GP27    MDT2005 PB4 pin 10
+    - GP26    MDT2005 PB3 pin 9
+    - GP25    MDT2005 PB2 pin 8
+    - GP23    MDT2005 PB1 pin 7
+    - GP22    MDT2005 PB0 pin 6
+    - GP21    MDT2005 PB5 pin 11
+    - GP20    MDT2005 PB6 pin 12
+    - GP19    MDT2005 PB7 pin 13
+    - nc      MDT2005 PA3 pin 2
+    - Remote  MDT2005 PA2 pin 1
+    - GP18    MDT2005 PA1 pin 18
+    - nc      MDT2005 PA0 pin 17 strap low
+    - GP17    Strap "GP7"=High
+    - GP16    Strap "GP6"=High
+
+	- 0=Radio 1=TV
+	- Drives SA630D ENCH1 and HEF4052 A1 pinsto do FM radio through
+	  SIF input
+
+    - GP15    nc
+    - GP14    nc
+    - GP13    nc
+    - GP12    Strap "GP5" = High
+    - GP11    Strap "GP4" = High
+    - GP10    Strap "GP3" = High
+    - GP09    Strap "GP2" = Low
+    - GP08    Strap "GP1" = Low
+    - GP07.00 nc
+
+Credits
+-------
+
+andrew.stevens@philips.com + werner.leeb@philips.com for providing
+saa7134 hardware specs and sample board.
diff --git a/Documentation/media/v4l-drivers/saa7134.rst b/Documentation/media/v4l-drivers/saa7134.rst
index 15d06facdbc1..c84246dd81c0 100644
--- a/Documentation/media/v4l-drivers/saa7134.rst
+++ b/Documentation/media/v4l-drivers/saa7134.rst
@@ -54,60 +54,6 @@ Known Problems
   default might not work for you depending on which version you have.
   There is a tuner= insmod option to override the driver's default.
 
-Card Variations:
-----------------
-
-Cards can use either of these two crystals (xtal):
-
-- 32.11 MHz -> .audio_clock=0x187de7
-- 24.576MHz -> .audio_clock=0x200000 (xtal * .audio_clock = 51539600)
-
-Some details about 30/34/35:
-
-- saa7130 - low-price chip, doesn't have mute, that is why all those
-  cards should have .mute field defined in their tuner structure.
-
-- saa7134 - usual chip
-
-- saa7133/35 - saa7135 is probably a marketing decision, since all those
-  chips identifies itself as 33 on pci.
-
-LifeView GPIOs
---------------
-
-This section was authored by: Peter Missel <peter.missel@onlinehome.de>
-
-- LifeView FlyTV Platinum FM (LR214WF)
-
-    - GP27    MDT2005 PB4 pin 10
-    - GP26    MDT2005 PB3 pin 9
-    - GP25    MDT2005 PB2 pin 8
-    - GP23    MDT2005 PB1 pin 7
-    - GP22    MDT2005 PB0 pin 6
-    - GP21    MDT2005 PB5 pin 11
-    - GP20    MDT2005 PB6 pin 12
-    - GP19    MDT2005 PB7 pin 13
-    - nc      MDT2005 PA3 pin 2
-    - Remote  MDT2005 PA2 pin 1
-    - GP18    MDT2005 PA1 pin 18
-    - nc      MDT2005 PA0 pin 17 strap low
-    - GP17    Strap "GP7"=High
-    - GP16    Strap "GP6"=High
-
-	- 0=Radio 1=TV
-	- Drives SA630D ENCH1 and HEF4052 A1 pinsto do FM radio through
-	  SIF input
-
-    - GP15    nc
-    - GP14    nc
-    - GP13    nc
-    - GP12    Strap "GP5" = High
-    - GP11    Strap "GP4" = High
-    - GP10    Strap "GP3" = High
-    - GP09    Strap "GP2" = Low
-    - GP08    Strap "GP1" = Low
-    - GP07.00 nc
-
 Credits
 -------
 
-- 
2.24.1


  parent reply	other threads:[~2020-03-10 13:45 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-10 13:42 [PATCH v2 00/22] Move media documentation files Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 01/22] media: docs: avermedia.rst: mark a table as such Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 02/22] media: docs: move soc-camera.rst to staging Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 03/22] media: docs: split cpia2.rst on two files Mauro Carvalho Chehab
2020-03-12  7:18   ` Hans Verkuil
2020-03-10 13:42 ` [PATCH v2 04/22] media: docs: split ci.rst into uAPI and user guide docs Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 05/22] media: docs: split meye.rst into admin and uAPI docs Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 06/22] media: docs: split vimc.rst into devel and admin parts Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 07/22] media: docs: split development info from bttv.rst Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 08/22] media: docs: split development info from cx88.rst Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 09/22] media: docs: split cx2341x.rst into different audiences Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 10/22] media: docs: cx18-streams.c: fix broken references to docs Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 11/22] media: docs: split uAPI info from davinci-vpbe.rst Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 12/22] media: docs: split uAPI info from fimc.rst Mauro Carvalho Chehab
2020-03-10 13:43 ` Mauro Carvalho Chehab [this message]
2020-03-10 13:43 ` [PATCH v2 14/22] media: docs: split uAPI info from omap3isp.rst Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 15/22] media: docs: split uAPI info from imx.rst Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 17/22] media: docs: kAPI docs: move them to driver-api Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 18/22] media: docs: move fourcc file to the uAPI document Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 19/22] media: docs: move user-facing docs to the admin guide Mauro Carvalho Chehab
2020-03-12  7:25   ` Hans Verkuil
2020-03-10 13:43 ` [PATCH v2 20/22] media: docs: move driver-specific info to driver-api Mauro Carvalho Chehab
2020-03-12  7:26   ` Hans Verkuil
2020-03-10 13:43 ` [PATCH v2 21/22] media: docs: add an uAPI chapter for driver-specific stuff Mauro Carvalho Chehab
2020-03-12  7:31   ` Hans Verkuil
2020-03-10 13:43 ` [PATCH v2 22/22] media: docs: get rid of Documentation/media/ 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=b29aa35ac3639d2f75344cdd2b32bb4a834fae11.1583847556.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).