From: swarren@wwwdotorg•org (Stephen Warren)
To: linux-arm-kernel@lists•infradead.org
Subject: [PATCH 1/4] i2c: busses: i2c-st: Add ST I2C controller
Date: Tue, 01 Oct 2013 14:45:32 -0600 [thread overview]
Message-ID: <524B346C.8070607@wwwdotorg.org> (raw)
In-Reply-To: <1380623952-4252-2-git-send-email-maxime.coquelin@st.com>
On 10/01/2013 04:39 AM, Maxime COQUELIN wrote:
> This patch adds support to SSC (Synchronous Serial Controller)
> I2C driver. This IP also supports SPI protocol, but this is not
> the aim of this driver.
>
> This IP is embedded in all ST SoCs for Set-top box platorms, and
> supports I2C Standard and Fast modes.
> diff --git a/Documentation/devicetree/bindings/i2c/i2c-st.txt b/Documentation/devicetree/bindings/i2c/i2c-st.txt
> +Required properties :
> +- clocks : phandle to the I2C clock source
> +- clock-names : from common clock binding: Shall be "ssc"
I'd prefer to define that as:
clock-names: Must contain "ssc".
clocks: Must contain an entry for each name in clock-names. See the
common clock bindings.
That way, it makes it clear that clock-names is the primary lookup
mechanism, rather than some auxiliary documentation.
> +Recommended properties :
> +- clock-frequency : Desired I2C bus clock frequency in Hz. Otherwise
s/Otherwise/If not specified,/
> + the default 100 kHz frequency will be used. As only Normal and Fast modes
> + are supported, possible values are 100000 and 400000.
I think that's just optional. Since there's a well-defined sensible
default, there's no need to recommend it.
> +Optional properties :
> +- i2c-min-scl-pulse-width-us : The minimum valid SCL pulse width that is allowed
> + through the deglitch circuit. In units of us.
> +- i2c-min-sda-pulse-width-us : The minimum valid SDA pulse width that is allowed
> + through the deglitch circuit. In units of us.
Are those properties specific to this binding, or intended to be
generic? If specific to this binding, a vendor prefix should be present
in the property name. If not, you probably want to document the
properties in some common file.
> +Examples :
s/Examples/Example/ since there's just one.
> +i2c0: i2c at fed40000 {
> + compatible = "st,comms-ssc-i2c";
> + reg = <0xfed40000 0x110>;
> + interrupts = <GIC_SPI 187 IRQ_TYPE_EDGE_RISING>;
> + clocks = <&CLK_S_ICN_REG_0>;
> + clock-names = "ssc";
> + clock-frequency = <400000>;
> + pinctrl-names = "default";
> + pinctrl-0 = <&pinctrl_i2c0_default>;
That wasn't mentioned in the binding definition. You'd probably want to
document the requirement for those two properties by saying something like:
A pinctrl state named "default" must be defined, using the bindings in
../pinctrl/pinctrl-binding.txt.
next prev parent reply other threads:[~2013-10-01 20:45 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-10-01 10:39 [PATCH v3 0/4] Add I2C support to ST SoCs Maxime COQUELIN
2013-10-01 10:39 ` [PATCH 1/4] i2c: busses: i2c-st: Add ST I2C controller Maxime COQUELIN
2013-10-01 20:45 ` Stephen Warren [this message]
2013-10-02 8:36 ` Maxime COQUELIN
2013-10-02 9:02 ` Wolfram Sang
2013-10-02 9:35 ` Maxime COQUELIN
2013-10-02 13:56 ` Maxime COQUELIN
2013-10-01 10:39 ` [PATCH 2/4] ARM: STi: Supply I2C configuration to STiH416 SoC Maxime COQUELIN
2013-10-01 10:39 ` [PATCH 3/4] ARM: STi: Supply I2C configuration to STiH415 SoC Maxime COQUELIN
2013-10-01 10:39 ` [PATCH 4/4] ARM: STi: Add I2C config to B2000 and B2020 boards Maxime COQUELIN
-- strict thread matches above, loose matches on Subject: below --
2013-09-18 10:01 [PATCH 0/4] Add I2C support to ST SoCs Maxime COQUELIN
2013-09-18 10:01 ` [PATCH 1/4] i2c: busses: i2c-st: Add ST I2C controller Maxime COQUELIN
2013-09-18 12:47 ` Gabriel FERNANDEZ
2013-09-23 20:55 ` Stephen Warren
2013-09-23 21:06 ` Stephen Warren
2013-09-24 15:38 ` Maxime COQUELIN
2013-09-24 15:59 ` Wolfram Sang
2013-09-26 9:30 ` Maxime COQUELIN
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=524B346C.8070607@wwwdotorg.org \
--to=swarren@wwwdotorg$(echo .)org \
--cc=linux-arm-kernel@lists$(echo .)infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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