diff mbox

[5/5] of: Modify c_can binding documentation

Message ID 1346405361-29711-6-git-send-email-anilkumar@ti.com (mailing list archive)
State New, archived
Headers show

Commit Message

AnilKumar, Chimata Aug. 31, 2012, 9:29 a.m. UTC
Modify c_can binding documentation according to recent review comments
on device tree data addition patches.

Signed-off-by: AnilKumar Ch <anilkumar@ti.com>
---
 .../devicetree/bindings/net/can/c_can.txt          |   25 ++++++++++++++++----
 1 file changed, 20 insertions(+), 5 deletions(-)

Comments

AnilKumar, Chimata Sept. 1, 2012, 7:05 a.m. UTC | #1
Hi Marc,

On Fri, Aug 31, 2012 at 14:59:21, AnilKumar, Chimata wrote:
> Modify c_can binding documentation according to recent review comments
> on device tree data addition patches.
> 
> Signed-off-by: AnilKumar Ch <anilkumar@ti.com>
> ---
>  .../devicetree/bindings/net/can/c_can.txt          |   25 ++++++++++++++++----
>  1 file changed, 20 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/net/can/c_can.txt b/Documentation/devicetree/bindings/net/can/c_can.txt
> index a43f083..90a70be 100644
> --- a/Documentation/devicetree/bindings/net/can/c_can.txt
> +++ b/Documentation/devicetree/bindings/net/can/c_can.txt
> @@ -8,6 +8,8 @@ Required properties:
>  			  registers map
>  - interrupts		: property with a value describing the interrupt
>  			  number
> +- status		: describes the node status either "disabled" or
> +			  "okay"
>  
>  Optional properties:
>  - interrupt-parent	: The parent interrupt controller
> @@ -20,18 +22,31 @@ Future plan is to migrate hwmod data base contents into device tree
>  blob so that, all the required data will be used from device tree dts
>  file.
>  
> -Examples:
> +Example:
>  
> -	d_can@481D0000 {
> +Step1: SoC common .dtsi file
> +
> +	d_can1: d_can@481d0000 {
>  		compatible = "bosch,d_can";
> -		reg = <0x481D0000 0x1000>;
> -		interrupts = <55 0x4>;
> +		reg = <0x481d0000 0x2000>;
> +		interrupts = <55>;
>  		interrupt-parent = <&intc>;
> +		status = "disabled";
>  	};
>  
>  (or)
>  
> -	d_can@481D0000 {
> +	d_can1: d_can@481d0000 {
>  		compatible = "bosch,d_can";
>  		ti,hwmods = "d_can1";
> +		reg = <0x481d0000 0x2000>;
> +		interrupts = <55>;
> +		interrupt-parent = <&intc>;
> +		status = "disabled";
> +	};
> +
> +Step 2: board specific .dts file
> +
> +	&dcan1 {
> +		status = "okay";
>  	};
> -- 
> 1.7.9.5
> 
> 

Can you review this patch and push it to linux-can tree?
Because initial version of this file c_can.txt is in
linux-can tree.

Thanks
AnilKumar
Stephen Warren Sept. 2, 2012, 2:02 a.m. UTC | #2
On 09/01/2012 12:05 AM, AnilKumar, Chimata wrote:
> On Fri, Aug 31, 2012 at 14:59:21, AnilKumar, Chimata wrote:
>> Modify c_can binding documentation according to recent review comments
>> on device tree data addition patches.

>> diff --git a/Documentation/devicetree/bindings/net/can/c_can.txt b/Documentation/devicetree/bindings/net/can/c_can.txt
>> index a43f083..90a70be 100644
>> --- a/Documentation/devicetree/bindings/net/can/c_can.txt
>> +++ b/Documentation/devicetree/bindings/net/can/c_can.txt
>> @@ -8,6 +8,8 @@ Required properties:
>>  			  registers map
>>  - interrupts		: property with a value describing the interrupt
>>  			  number
>> +- status		: describes the node status either "disabled" or
>> +			  "okay"

That's a standrd property that applies to any node, and doesn't describe
data required by the device itself (as do regs/interrupts) by simply
whether the node is activated; I'm not sure it's worth mentioning it in
a device-specific binding.

A similar comment exists for the pre-existing description of
interrupt-parent below.

>>  Optional properties:
>>  - interrupt-parent	: The parent interrupt controller
AnilKumar, Chimata Sept. 3, 2012, 4:35 a.m. UTC | #3
Hi Stephen,

Thanks for the review,

On Sun, Sep 02, 2012 at 07:32:38, Stephen Warren wrote:
> On 09/01/2012 12:05 AM, AnilKumar, Chimata wrote:
> > On Fri, Aug 31, 2012 at 14:59:21, AnilKumar, Chimata wrote:
> >> Modify c_can binding documentation according to recent review comments
> >> on device tree data addition patches.
> 
> >> diff --git a/Documentation/devicetree/bindings/net/can/c_can.txt b/Documentation/devicetree/bindings/net/can/c_can.txt
> >> index a43f083..90a70be 100644
> >> --- a/Documentation/devicetree/bindings/net/can/c_can.txt
> >> +++ b/Documentation/devicetree/bindings/net/can/c_can.txt
> >> @@ -8,6 +8,8 @@ Required properties:
> >>  			  registers map
> >>  - interrupts		: property with a value describing the interrupt
> >>  			  number
> >> +- status		: describes the node status either "disabled" or
> >> +			  "okay"
> 
> That's a standrd property that applies to any node, and doesn't describe
> data required by the device itself (as do regs/interrupts) by simply
> whether the node is activated; I'm not sure it's worth mentioning it in
> a device-specific binding.
> 
> A similar comment exists for the pre-existing description of
> interrupt-parent below.
> 
> >>  Optional properties:
> >>  - interrupt-parent	: The parent interrupt controller
> 

Then, I will remove these properties from the doc.

Thanks
AnilKumar
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/net/can/c_can.txt b/Documentation/devicetree/bindings/net/can/c_can.txt
index a43f083..90a70be 100644
--- a/Documentation/devicetree/bindings/net/can/c_can.txt
+++ b/Documentation/devicetree/bindings/net/can/c_can.txt
@@ -8,6 +8,8 @@  Required properties:
 			  registers map
 - interrupts		: property with a value describing the interrupt
 			  number
+- status		: describes the node status either "disabled" or
+			  "okay"
 
 Optional properties:
 - interrupt-parent	: The parent interrupt controller
@@ -20,18 +22,31 @@  Future plan is to migrate hwmod data base contents into device tree
 blob so that, all the required data will be used from device tree dts
 file.
 
-Examples:
+Example:
 
-	d_can@481D0000 {
+Step1: SoC common .dtsi file
+
+	d_can1: d_can@481d0000 {
 		compatible = "bosch,d_can";
-		reg = <0x481D0000 0x1000>;
-		interrupts = <55 0x4>;
+		reg = <0x481d0000 0x2000>;
+		interrupts = <55>;
 		interrupt-parent = <&intc>;
+		status = "disabled";
 	};
 
 (or)
 
-	d_can@481D0000 {
+	d_can1: d_can@481d0000 {
 		compatible = "bosch,d_can";
 		ti,hwmods = "d_can1";
+		reg = <0x481d0000 0x2000>;
+		interrupts = <55>;
+		interrupt-parent = <&intc>;
+		status = "disabled";
+	};
+
+Step 2: board specific .dts file
+
+	&dcan1 {
+		status = "okay";
 	};