mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Phil Edworthy <phil.edworthy@renesas.com>
To: Rob Herring <robh+dt@kernel.org>, Mark Rutland <mark.rutland@arm.com>
Cc: Geert Uytterhoeven <geert@linux-m68k.org>,
	linux-i2c@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-renesas-soc@vger.kernel.org,
	Phil Edworthy <phil.edworthy@renesas.com>,
	devicetree@vger.kernel.org
Subject: [PATCH 1/2] dt: snps,designware-i2c: Add clock bindings documentation
Date: Mon, 16 Jul 2018 09:59:12 +0100	[thread overview]
Message-ID: <1531731553-22979-2-git-send-email-phil.edworthy@renesas.com> (raw)
In-Reply-To: <1531731553-22979-1-git-send-email-phil.edworthy@renesas.com>

The driver requires an undocumented clock property, so detail it.
Add documentation for a separate bus clock.

Signed-off-by: Phil Edworthy <phil.edworthy@renesas.com>
---
 Documentation/devicetree/bindings/i2c/i2c-designware.txt | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/Documentation/devicetree/bindings/i2c/i2c-designware.txt b/Documentation/devicetree/bindings/i2c/i2c-designware.txt
index fbb0a6d..e9f4387 100644
--- a/Documentation/devicetree/bindings/i2c/i2c-designware.txt
+++ b/Documentation/devicetree/bindings/i2c/i2c-designware.txt
@@ -1,16 +1,21 @@
 * Synopsys DesignWare I2C
 
 Required properties :
-
  - compatible : should be "snps,designware-i2c"
  - reg : Offset and length of the register set for the device
  - interrupts : <IRQ> where IRQ is the interrupt number.
+ - clocks : phandles for the clocks, see the description of clock-names below.
+   The phandle for the "ic_clk" clock is required. The phandle for the "bus"
+   clock is optional. If a single clock is specified but no clock-name, it is
+   the "ic_clk" clock. If both clocks are listed, the "ic_clk" must be first.
 
 Recommended properties :
-
  - clock-frequency : desired I2C bus clock frequency in Hz.
 
 Optional properties :
+ - clock-names : Contains the names of the clocks:
+    "ic_clk", for the core clock used to generate the external I2C clock.
+    "bus", the bus clock, sometimes described as pclk, for register accesses.
  - i2c-sda-hold-time-ns : should contain the SDA hold time in nanoseconds.
    This option is only supported in hardware blocks version 1.11a or newer.
 
-- 
2.7.4


  reply	other threads:[~2018-07-16  8:59 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-07-16  8:59 [PATCH 0/2] i2c: designware: Add support for a bus clock Phil Edworthy
2018-07-16  8:59 ` Phil Edworthy [this message]
2018-07-20 16:19   ` [PATCH 1/2] dt: snps,designware-i2c: Add clock bindings documentation Rob Herring
2018-07-16  8:59 ` [PATCH 2/2] i2c: designware: Add support for a bus clock Phil Edworthy
2018-07-17 12:07   ` Simon Horman
2018-07-17 12:23     ` Andy Shevchenko
2018-07-17 12:42       ` Phil Edworthy
2018-07-17 13:01         ` Geert Uytterhoeven
2018-07-17 13:12           ` Phil Edworthy
2018-07-17 14:18         ` Andy Shevchenko
2018-07-17 14:40           ` Phil Edworthy
2018-07-17 14:47             ` Andy Shevchenko
2018-07-17 14:57               ` Phil Edworthy
2018-07-18  9:14                 ` Simon Horman
2018-07-18  9:21                   ` Phil Edworthy
2018-07-19  7:42                     ` Simon Horman
2018-07-18 11:06                   ` Geert Uytterhoeven
2018-07-18 12:52                     ` Andy Shevchenko

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=1531731553-22979-2-git-send-email-phil.edworthy@renesas.com \
    --to=phil.edworthy@renesas.com \
    --cc=devicetree@vger.kernel.org \
    --cc=geert@linux-m68k.org \
    --cc=linux-i2c@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-renesas-soc@vger.kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=robh+dt@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

all inboxes | Powered by JetHome®