diff mbox

i2c: designware: Fix falling time bindings doc

Message ID 1417805379-8999-1-git-send-email-dianders@chromium.org
State Accepted, archived
Commit 8e2596e81a9dd8f9efcf78476f3990f211e25edb
Headers show

Commit Message

Doug Anderson Dec. 5, 2014, 6:49 p.m. UTC
In (6468276 i2c: designware: make SCL and SDA falling time
configurable) new device tree properties were added for setting the
falling time of SDA and SCL.  The device tree bindings doc had a typo
in it: it forgot the "-ns" suffix for both properies in the prose of
the bindings.

I assume this is a typo because:
* The source code includes the "-ns"
* The example in the bindings includes the "-ns".

Fix the typo.

Signed-off-by: Doug Anderson <dianders@chromium.org>
Fixes: 6468276b2206 ("i2c: designware: make SCL and SDA falling time configurable")
---
 Documentation/devicetree/bindings/i2c/i2c-designware.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Romain Baeriswyl Dec. 8, 2014, 8:57 a.m. UTC | #1
Acked-by: Romain Baeriswyl <romain.baeriswyl@alitech.com>


On 2014-12-05 19:49, Doug Anderson wrote:
> In (6468276 i2c: designware: make SCL and SDA falling time
> configurable) new device tree properties were added for setting the
> falling time of SDA and SCL.  The device tree bindings doc had a typo
> in it: it forgot the "-ns" suffix for both properies in the prose of
> the bindings.
>
> I assume this is a typo because:
> * The source code includes the "-ns"
> * The example in the bindings includes the "-ns".
>
> Fix the typo.
>
> Signed-off-by: Doug Anderson <dianders@chromium.org>
> Fixes: 6468276b2206 ("i2c: designware: make SCL and SDA falling time configurable")
> ---
>   Documentation/devicetree/bindings/i2c/i2c-designware.txt | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/i2c/i2c-designware.txt b/Documentation/devicetree/bindings/i2c/i2c-designware.txt
> index 5199b0c..fee26dc 100644
> --- a/Documentation/devicetree/bindings/i2c/i2c-designware.txt
> +++ b/Documentation/devicetree/bindings/i2c/i2c-designware.txt
> @@ -14,10 +14,10 @@ Optional properties :
>    - 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.
>
> - - i2c-scl-falling-time : should contain the SCL falling time in nanoseconds.
> + - i2c-scl-falling-time-ns : should contain the SCL falling time in nanoseconds.
>      This value which is by default 300ns is used to compute the tLOW period.
>
> - - i2c-sda-falling-time : should contain the SDA falling time in nanoseconds.
> + - i2c-sda-falling-time-ns : should contain the SDA falling time in nanoseconds.
>      This value which is by default 300ns is used to compute the tHIGH period.
>
>   Example :
>

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Wolfram Sang Dec. 8, 2014, 9:51 a.m. UTC | #2
On Fri, Dec 05, 2014 at 10:49:39AM -0800, Doug Anderson wrote:
> In (6468276 i2c: designware: make SCL and SDA falling time
> configurable) new device tree properties were added for setting the
> falling time of SDA and SCL.  The device tree bindings doc had a typo
> in it: it forgot the "-ns" suffix for both properies in the prose of
> the bindings.
> 
> I assume this is a typo because:
> * The source code includes the "-ns"
> * The example in the bindings includes the "-ns".
> 
> Fix the typo.
> 
> Signed-off-by: Doug Anderson <dianders@chromium.org>
> Fixes: 6468276b2206 ("i2c: designware: make SCL and SDA falling time configurable")

Applied to for-next and added stable, thanks!
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/i2c/i2c-designware.txt b/Documentation/devicetree/bindings/i2c/i2c-designware.txt
index 5199b0c..fee26dc 100644
--- a/Documentation/devicetree/bindings/i2c/i2c-designware.txt
+++ b/Documentation/devicetree/bindings/i2c/i2c-designware.txt
@@ -14,10 +14,10 @@  Optional properties :
  - 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.
 
- - i2c-scl-falling-time : should contain the SCL falling time in nanoseconds.
+ - i2c-scl-falling-time-ns : should contain the SCL falling time in nanoseconds.
    This value which is by default 300ns is used to compute the tLOW period.
 
- - i2c-sda-falling-time : should contain the SDA falling time in nanoseconds.
+ - i2c-sda-falling-time-ns : should contain the SDA falling time in nanoseconds.
    This value which is by default 300ns is used to compute the tHIGH period.
 
 Example :