From: Wolfram Sang <wsa@the-dreams.de>
To: linux-i2c@vger.kernel.org
Cc: linux-sh@vger.kernel.org, Magnus Damm <magnus.damm@gmail.com>,
Simon Horman <horms@verge.net.au>,
Laurent Pinchart <laurent.pinchart@ideasonboard.com>,
Geert Uytterhoeven <geert@linux-m68k.org>,
Wolfram Sang <wsa@the-dreams.de>,
Andrey Danin <danindrey@mail.ru>,
Stephen Warren <swarren@wwwdotorg.org>
Subject: [PATCH 10/10] i2c: dt: describe generic bindings
Date: Sat, 8 Aug 2015 22:33:27 +0200 [thread overview]
Message-ID: <1439066007-13951-11-git-send-email-wsa@the-dreams.de> (raw)
In-Reply-To: <1439066007-13951-1-git-send-email-wsa@the-dreams.de>
From: Wolfram Sang <wsa+renesas@sang-engineering.com>
Start a new file which describes the generic bindings used for I2C with
device tree. So we have a central place to look for them, increase
visibility of them, and hopefully reduce the amount of custom properties
introduced.
Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
---
Documentation/devicetree/bindings/i2c/i2c.txt | 33 +++++++++++++++++++++++++++
1 file changed, 33 insertions(+)
create mode 100644 Documentation/devicetree/bindings/i2c/i2c.txt
diff --git a/Documentation/devicetree/bindings/i2c/i2c.txt b/Documentation/devicetree/bindings/i2c/i2c.txt
new file mode 100644
index 00000000000000..1175efed4a41b5
--- /dev/null
+++ b/Documentation/devicetree/bindings/i2c/i2c.txt
@@ -0,0 +1,33 @@
+Generic device tree bindings for I2C busses
+===========================================
+
+This document describes generic bindings which can be used to describe I2C
+busses in a device tree.
+
+Required properties
+-------------------
+
+- #address-cells - should be <1>. Read more about addresses below.
+- #size-cells - should be <0>.
+- compatible - name of I2C bus controller following generic names
+ recommended practice.
+
+For other required properties e.g. to describe register sets, interrupts,
+clocks, etc. check the binding documentation of the specific driver.
+
+The cells properties above define that an address of children of an I2C bus
+are described by a single value. This is usually a 7 bit address. However,
+flags can be attached to the address. I2C_TEN_BIT_ADDRESS is used to mark a 10
+bit address. It is needed to avoid the ambiguity between e.g. a 7 bit address
+of 0x50 and a 10 bit address of 0x050 which, in theory, can be on the same bus.
+Another flag is I2C_OWN_SLAVE_ADDRESS to mark addresses on which we listen to
+be devices ourselves.
+
+Optional properties
+-------------------
+
+These properties may not be supported by all drivers. However, if a driver
+wants to support one of the below features, it should adapt the bindings below.
+
+- clock-frequency - frequency of bus clock in Hz
+- wakeup-source - device can be used as a wakeup source.
--
2.1.4
next prev parent reply other threads:[~2015-08-08 20:33 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-08-08 20:33 [PATCH 00/10] i2c: improve i2c client address spaces and their DT support Wolfram Sang
2015-08-08 20:33 ` [PATCH 01/10] dt-bindings: add header for generic I2C flags in bindings Wolfram Sang
2015-08-08 20:33 ` [PATCH 02/10] i2c: add a flag to mark clients as slaves Wolfram Sang
[not found] ` <1439066007-13951-1-git-send-email-wsa-z923LK4zBo2bacvFa/9K2g@public.gmane.org>
2015-08-08 20:33 ` [PATCH 03/10] i2c: apply address offset for slaves, too Wolfram Sang
2015-08-08 20:33 ` [PATCH 09/10] i2c: slave: print warning if slave flag not set Wolfram Sang
2015-08-08 20:33 ` [PATCH 04/10] i2c: rename address check functions Wolfram Sang
2015-08-08 20:33 ` [PATCH 05/10] i2c: make address check indpendent from client struct Wolfram Sang
2015-08-08 20:33 ` [PATCH 06/10] i2c: apply DT flags when probing Wolfram Sang
2015-08-08 20:33 ` [PATCH 07/10] i2c: take address space into account when checking for used addresses Wolfram Sang
2015-08-08 20:33 ` [PATCH 08/10] i2c: support 10 bit and slave addresses in sysfs 'new_device' Wolfram Sang
2015-08-10 13:17 ` Geert Uytterhoeven
2015-08-10 14:00 ` Wolfram Sang
2015-08-08 20:33 ` Wolfram Sang [this message]
2015-08-09 9:51 ` [PATCH 10/10] i2c: dt: describe generic bindings Vaibhav Hiremath
2015-08-09 12:15 ` Wolfram Sang
2015-08-09 12:17 ` Vaibhav Hiremath
2015-08-14 18:22 ` [PATCH 00/10] i2c: improve i2c client address spaces and their DT support Wolfram Sang
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=1439066007-13951-11-git-send-email-wsa@the-dreams.de \
--to=wsa@the-dreams.de \
--cc=danindrey@mail.ru \
--cc=geert@linux-m68k.org \
--cc=horms@verge.net.au \
--cc=laurent.pinchart@ideasonboard.com \
--cc=linux-i2c@vger.kernel.org \
--cc=linux-sh@vger.kernel.org \
--cc=magnus.damm@gmail.com \
--cc=swarren@wwwdotorg.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).