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>
Subject: [PATCH 56/57] docs: phy: convert samsung-usb2.txt to ReST format
Date: Mon, 15 Apr 2019 23:56:21 -0300 [thread overview]
Message-ID: <3cc9e974c100a5e92da7fca7d3aee352d0d8a68d.1555382110.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <cover.1555382110.git.mchehab+samsung@kernel.org>
In order to merge it into a Sphinx book, we need first to
convert to ReST.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/phy/samsung-usb2.txt | 60 +++++++++++++++---------------
1 file changed, 31 insertions(+), 29 deletions(-)
diff --git a/Documentation/phy/samsung-usb2.txt b/Documentation/phy/samsung-usb2.txt
index ed12d437189d..c48c8b9797b9 100644
--- a/Documentation/phy/samsung-usb2.txt
+++ b/Documentation/phy/samsung-usb2.txt
@@ -1,9 +1,9 @@
-.------------------------------------------------------------------------------+
-| Samsung USB 2.0 PHY adaptation layer |
-+-----------------------------------------------------------------------------+'
+====================================
+Samsung USB 2.0 PHY adaptation layer
+====================================
-| 1. Description
-+----------------
+1. Description
+--------------
The architecture of the USB 2.0 PHY module in Samsung SoCs is similar
among many SoCs. In spite of the similarities it proved difficult to
@@ -14,8 +14,8 @@ the PHY powering up process had to be altered. This adaptation layer is
a compromise between having separate drivers and having a single driver
with added support for many special cases.
-| 2. Files description
-+----------------------
+2. Files description
+--------------------
- phy-samsung-usb2.c
This is the main file of the adaptation layer. This file contains
@@ -32,44 +32,45 @@ with added support for many special cases.
driver. In addition it should contain extern declarations for
structures that describe particular SoCs.
-| 3. Supporting SoCs
-+--------------------
+3. Supporting SoCs
+------------------
To support a new SoC a new file should be added to the drivers/phy
directory. Each SoC's configuration is stored in an instance of the
-struct samsung_usb2_phy_config.
+struct samsung_usb2_phy_config::
-struct samsung_usb2_phy_config {
+ struct samsung_usb2_phy_config {
const struct samsung_usb2_common_phy *phys;
int (*rate_to_clk)(unsigned long, u32 *);
unsigned int num_phys;
bool has_mode_switch;
-};
+ };
-The num_phys is the number of phys handled by the driver. *phys is an
+The num_phys is the number of phys handled by the driver. `*phys` is an
array that contains the configuration for each phy. The has_mode_switch
property is a boolean flag that determines whether the SoC has USB host
and device on a single pair of pins. If so, a special register has to
be modified to change the internal routing of these pins between a USB
device or host module.
-For example the configuration for Exynos 4210 is following:
+For example the configuration for Exynos 4210 is following::
-const struct samsung_usb2_phy_config exynos4210_usb2_phy_config = {
+ const struct samsung_usb2_phy_config exynos4210_usb2_phy_config = {
.has_mode_switch = 0,
.num_phys = EXYNOS4210_NUM_PHYS,
.phys = exynos4210_phys,
.rate_to_clk = exynos4210_rate_to_clk,
-}
+ }
+
+- `int (*rate_to_clk)(unsigned long, u32 *)`
-- int (*rate_to_clk)(unsigned long, u32 *)
The rate_to_clk callback is to convert the rate of the clock
used as the reference clock for the PHY module to the value
that should be written in the hardware register.
-The exynos4210_phys configuration array is as follows:
+The exynos4210_phys configuration array is as follows::
-static const struct samsung_usb2_common_phy exynos4210_phys[] = {
+ static const struct samsung_usb2_common_phy exynos4210_phys[] = {
{
.label = "device",
.id = EXYNOS4210_DEVICE,
@@ -95,29 +96,30 @@ static const struct samsung_usb2_common_phy exynos4210_phys[] = {
.power_off = exynos4210_power_off,
},
{},
-};
+ };
+
+- `int (*power_on)(struct samsung_usb2_phy_instance *);`
+ `int (*power_off)(struct samsung_usb2_phy_instance *);`
-- int (*power_on)(struct samsung_usb2_phy_instance *);
-- int (*power_off)(struct samsung_usb2_phy_instance *);
These two callbacks are used to power on and power off the phy
by modifying appropriate registers.
Final change to the driver is adding appropriate compatible value to the
phy-samsung-usb2.c file. In case of Exynos 4210 the following lines were
-added to the struct of_device_id samsung_usb2_phy_of_match[] array:
+added to the struct of_device_id samsung_usb2_phy_of_match[] array::
-#ifdef CONFIG_PHY_EXYNOS4210_USB2
+ #ifdef CONFIG_PHY_EXYNOS4210_USB2
{
.compatible = "samsung,exynos4210-usb2-phy",
.data = &exynos4210_usb2_phy_config,
},
-#endif
+ #endif
To add further flexibility to the driver the Kconfig file enables to
include support for selected SoCs in the compiled driver. The Kconfig
-entry for Exynos 4210 is following:
+entry for Exynos 4210 is following::
-config PHY_EXYNOS4210_USB2
+ config PHY_EXYNOS4210_USB2
bool "Support for Exynos 4210"
depends on PHY_SAMSUNG_USB2
depends on CPU_EXYNOS4210
@@ -128,8 +130,8 @@ config PHY_EXYNOS4210_USB2
phys are available - device, host, HSCI0 and HSCI1.
The newly created file that supports the new SoC has to be also added to the
-Makefile. In case of Exynos 4210 the added line is following:
+Makefile. In case of Exynos 4210 the added line is following::
-obj-$(CONFIG_PHY_EXYNOS4210_USB2) += phy-exynos4210-usb2.o
+ obj-$(CONFIG_PHY_EXYNOS4210_USB2) += phy-exynos4210-usb2.o
After completing these steps the support for the new SoC should be ready.
--
2.20.1
next prev parent reply other threads:[~2019-04-16 2:59 UTC|newest]
Thread overview: 91+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-16 2:55 [PATCH 00/57] Convert files to ReST Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 01/57] docs: trace: fix some Sphinx warnings Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 02/57] docs: acpi: convert text files to ReST Mauro Carvalho Chehab
2019-04-16 8:17 ` Rafael J. Wysocki
2019-04-16 9:54 ` Mauro Carvalho Chehab
2019-04-16 10:17 ` Rafael J. Wysocki
2019-04-16 14:55 ` Changbin Du
2019-04-22 13:31 ` Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 03/57] docs: aoe: " Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 04/57] docs: arm64: convert documentation to ReST format Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 05/57] docs: cdrom/cdrom-standard.tex: convert from LaTeX to ReST Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 06/57] docs: cdrom: convert remaining files " Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 07/57] docs: cgroup-v1: convert to ReST file format Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 08/57] docs: cgroup-v1/blkio-controller.rst: add a note about CFQ scheduler Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 09/57] docs: cpu-freq: convert files to ReST Mauro Carvalho Chehab
2019-04-16 8:21 ` Rafael J. Wysocki
2019-04-16 9:58 ` Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 10/57] docs: device-mapper: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 13:28 ` Mike Snitzer
2019-04-16 14:00 ` Jonathan Corbet
2019-04-16 14:33 ` Mauro Carvalho Chehab
2019-04-16 15:48 ` Mike Snitzer
2019-04-16 17:27 ` Jonathan Corbet
2019-04-16 18:14 ` Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 11/57] docs: extcon: move it to acpi dir and convert it to ReST Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 12/57] docs: fault-injection: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 13/57] docs: fb: convert documentation " Mauro Carvalho Chehab
2019-05-06 13:36 ` Bartlomiej Zolnierkiewicz
2019-04-16 2:55 ` [PATCH 14/57] docs: fpga: convert it to ReST Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 15/57] docs: gpio: " Mauro Carvalho Chehab
2019-04-23 10:52 ` Linus Walleij
2019-04-23 12:38 ` Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 16/57] docs: ide: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 17/57] docs: infiniband: " Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 18/57] docs: kbuild: convert it to ReST output Mauro Carvalho Chehab
2019-04-18 9:25 ` Masahiro Yamada
2019-04-18 10:26 ` Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 19/57] docs: kdump: convert it to ReST Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 20/57] docs: livepatch: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 8:43 ` Petr Mladek
2019-04-16 11:47 ` Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 21/57] docs: locking: convert docs " Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 22/57] docs: mic: convert it " Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 23/57] docs: netlabel: convert it to ReST Mauro Carvalho Chehab
2019-04-17 14:36 ` Paul Moore
2019-04-16 2:55 ` [PATCH 24/57] docs: pcmcia: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 4:58 ` Dominik Brodowski
2019-04-16 2:55 ` [PATCH 25/57] docs: power: convert docs to ReST Mauro Carvalho Chehab
2019-04-16 7:20 ` Pavel Machek
2019-04-16 8:59 ` Rafael J. Wysocki
2019-04-16 10:41 ` Mauro Carvalho Chehab
2019-04-16 10:47 ` Rafael J. Wysocki
2019-04-16 2:55 ` [PATCH 26/57] docs: powerpc: " Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 27/57] docs: pps/pps.txt convert it to ReST and move to API book Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 28/57] docs: ptp.txt: convert to ReST and move to driver-api Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 29/57] docs: riscv: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 30/57] docs: s390: Debugging390.txt: convert table to ascii artwork Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 31/57] docs: s390: convert text files to ReST format Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 32/57] s390: include/asm/debug.h add kerneldoc markups Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 33/57] docs: serial: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 34/57] docs: target: " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 35/57] docs: timers: convert documentation to ReST Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 36/57] docs: usb: convert documents " Mauro Carvalho Chehab
2019-04-16 6:12 ` Felipe Balbi
2019-04-16 11:43 ` Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 37/57] docs: watchdog: convert documents to ReST format Mauro Carvalho Chehab
2019-04-17 17:53 ` Guenter Roeck
2019-04-16 2:56 ` [PATCH 38/57] docs: x86: convert text files to ReST Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 39/57] docs: xilinx: convert eemi.txt " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 40/57] docs: scheduler: convert files " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 41/57] docs: EDID/HOWTO.txt: convert to ReST and move to kernel-API Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 42/57] docs: connector.txt: convert to ReST Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 43/57] docs: lcd-panel-cgram.txt convert it to ReST and move to admin-guide Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 44/57] docs: lp855x-driver.txt: convert to ReST and move to kernel-api Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 45/57] docs: m68k: convert it to ReST file format and add to arch bookset Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 46/57] docs: cma/debugfs.txt: convert to ReST and move to admin-guide/mm Mauro Carvalho Chehab
2019-04-16 5:21 ` Mike Rapoport
2019-04-16 11:35 ` Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 47/57] docs: console.txt: convert to ReST format Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 48/57] docs: pti_intel_mid.txt: convert to ReST Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 49/57] docs: early-userspace: convert docs " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 50/57] docs: driver-model: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 51/57] docs: arm: convert text files " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 52/57] docs: memory-devices: convert ti-emif.txt " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 53/57] docs: xen-tpmfront.txt: convert the file " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 54/57] docs: bus-devices: ti-gpmc.txt: convert it to ReST Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 55/57] docs: nvmem: convert file to ReST format Mauro Carvalho Chehab
2019-04-16 2:56 ` Mauro Carvalho Chehab [this message]
2019-04-16 2:56 ` [PATCH 57/57] docs: Prepare files to be renamed to *.rst Mauro Carvalho Chehab
2019-04-18 12:42 ` Avoiding merge conflicts while adding new docs - Was: Re: [PATCH 00/57] Convert files to ReST Mauro Carvalho Chehab
2019-04-19 22:10 ` Jonathan Corbet
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=3cc9e974c100a5e92da7fca7d3aee352d0d8a68d.1555382110.git.mchehab+samsung@kernel.org \
--to=mchehab+samsung@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--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 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).