diff mbox

[v5,2/3] can: ti_hecc: Add TI HECC DT binding documentation

Message ID 1487346753-19286-3-git-send-email-yegorslists@googlemail.com
State Not Applicable, archived
Headers show

Commit Message

Yegor Yefremov Feb. 17, 2017, 3:52 p.m. UTC
From: Yegor Yefremov <yegorslists@googlemail.com>

DT binding documentation for TI High End CAN Controller

Signed-off-by: Anton Glukhov <anton.a.glukhov@gmail.com>
Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com>
---
 .../devicetree/bindings/net/can/ti_hecc.txt        | 33 ++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/can/ti_hecc.txt

Comments

Rob Herring (Arm) Feb. 27, 2017, 4:44 p.m. UTC | #1
On Fri, Feb 17, 2017 at 04:52:32PM +0100, yegorslists@googlemail.com wrote:
> From: Yegor Yefremov <yegorslists@googlemail.com>
> 
> DT binding documentation for TI High End CAN Controller
> 
> Signed-off-by: Anton Glukhov <anton.a.glukhov@gmail.com>
> Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com>
> ---
>  .../devicetree/bindings/net/can/ti_hecc.txt        | 33 ++++++++++++++++++++++
>  1 file changed, 33 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/net/can/ti_hecc.txt
> 
> diff --git a/Documentation/devicetree/bindings/net/can/ti_hecc.txt b/Documentation/devicetree/bindings/net/can/ti_hecc.txt
> new file mode 100644
> index 0000000..a7c601e
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/can/ti_hecc.txt
> @@ -0,0 +1,33 @@
> +Texas Instruments High End CAN Controller (HECC)
> +================================================
> +
> +This file provides information, what the device node
> +for the hecc interface contains.
> +
> +Required properties:
> +- compatible: "ti,am3517-hecc"
> +- reg: addresses and lengths of the register spaces for 'hecc', 'hecc-ram'
> +       and 'mbx'
> +- reg-names :"hecc", "hecc-ram", "mbx"
> +- interrupts: interrupt mapping for the hecc interrupts sources
> +- clocks: clock phandles (see clock bindings for details)
> +
> +Optional properties:
> +- ti,use-hecc1int: if provided configures HECC to produce all interrupts
> +		   on HECC1INT interrupt line. By default HECC0INT interrupt
> +		   line will be used.
> +- xceiver-supply: regulator that powers the CAN transceiver
> +
> +Example:
> +
> +For am3517evm board:
> +	hecc: can@0x5c050000 {

Drop the '0x'.

> +		compatible = "ti,am3517-hecc";
> +		status = "disabled";

No need to put status in examples.

With that,

Acked-by: Rob Herring <robh@kernel.org>

> +		reg = <0x5c050000 0x80>,
> +		      <0x5c053000 0x180>,
> +		      <0x5c052000 0x200>;
> +		reg-names = "hecc", "hecc-ram", "mbx";
> +		interrupts = <24>;
> +		clocks = <&hecc_ck>;
> +	};
> -- 
> 2.1.4
> 
--
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
Marc Kleine-Budde Feb. 28, 2017, 8:04 a.m. UTC | #2
On 02/27/2017 05:44 PM, Rob Herring wrote:
> On Fri, Feb 17, 2017 at 04:52:32PM +0100, yegorslists@googlemail.com wrote:
>> From: Yegor Yefremov <yegorslists@googlemail.com>
>>
>> DT binding documentation for TI High End CAN Controller
>>
>> Signed-off-by: Anton Glukhov <anton.a.glukhov@gmail.com>
>> Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com>
>> ---
>>  .../devicetree/bindings/net/can/ti_hecc.txt        | 33 ++++++++++++++++++++++
>>  1 file changed, 33 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/net/can/ti_hecc.txt
>>
>> diff --git a/Documentation/devicetree/bindings/net/can/ti_hecc.txt b/Documentation/devicetree/bindings/net/can/ti_hecc.txt
>> new file mode 100644
>> index 0000000..a7c601e
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/net/can/ti_hecc.txt
>> @@ -0,0 +1,33 @@
>> +Texas Instruments High End CAN Controller (HECC)
>> +================================================
>> +
>> +This file provides information, what the device node
>> +for the hecc interface contains.
>> +
>> +Required properties:
>> +- compatible: "ti,am3517-hecc"
>> +- reg: addresses and lengths of the register spaces for 'hecc', 'hecc-ram'
>> +       and 'mbx'
>> +- reg-names :"hecc", "hecc-ram", "mbx"
>> +- interrupts: interrupt mapping for the hecc interrupts sources
>> +- clocks: clock phandles (see clock bindings for details)
>> +
>> +Optional properties:
>> +- ti,use-hecc1int: if provided configures HECC to produce all interrupts
>> +		   on HECC1INT interrupt line. By default HECC0INT interrupt
>> +		   line will be used.
>> +- xceiver-supply: regulator that powers the CAN transceiver
>> +
>> +Example:
>> +
>> +For am3517evm board:
>> +	hecc: can@0x5c050000 {
> 
> Drop the '0x'.
> 
>> +		compatible = "ti,am3517-hecc";
>> +		status = "disabled";
> 
> No need to put status in examples.
> 
> With that,
> 
> Acked-by: Rob Herring <robh@kernel.org>

I've updated the patch.

tnx,
Marc
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/net/can/ti_hecc.txt b/Documentation/devicetree/bindings/net/can/ti_hecc.txt
new file mode 100644
index 0000000..a7c601e
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/can/ti_hecc.txt
@@ -0,0 +1,33 @@ 
+Texas Instruments High End CAN Controller (HECC)
+================================================
+
+This file provides information, what the device node
+for the hecc interface contains.
+
+Required properties:
+- compatible: "ti,am3517-hecc"
+- reg: addresses and lengths of the register spaces for 'hecc', 'hecc-ram'
+       and 'mbx'
+- reg-names :"hecc", "hecc-ram", "mbx"
+- interrupts: interrupt mapping for the hecc interrupts sources
+- clocks: clock phandles (see clock bindings for details)
+
+Optional properties:
+- ti,use-hecc1int: if provided configures HECC to produce all interrupts
+		   on HECC1INT interrupt line. By default HECC0INT interrupt
+		   line will be used.
+- xceiver-supply: regulator that powers the CAN transceiver
+
+Example:
+
+For am3517evm board:
+	hecc: can@0x5c050000 {
+		compatible = "ti,am3517-hecc";
+		status = "disabled";
+		reg = <0x5c050000 0x80>,
+		      <0x5c053000 0x180>,
+		      <0x5c052000 0x200>;
+		reg-names = "hecc", "hecc-ram", "mbx";
+		interrupts = <24>;
+		clocks = <&hecc_ck>;
+	};