diff mbox

[net-next,3/3] powerpc/mpc5xxx: add OF platform binding doc for FSL MSCAN devices

Message ID 1262420274-16586-4-git-send-email-wg@grandegger.com
State Superseded, archived
Delegated to: David Miller
Headers show

Commit Message

Wolfgang Grandegger Jan. 2, 2010, 8:17 a.m. UTC
From: Wolfgang Grandegger <wg@denx.de>

This patch adds documentation for the MSCAN OF device bindings for
the MPC512x and moves the one for the MPC5200 to the new common file
"Documentation/powerpc/dts-bindings/fsl/can.txt".

Signed-off-by: Wolfgang Grandegger <wg@denx.de>
---
 Documentation/powerpc/dts-bindings/fsl/can.txt     |   53 ++++++++++++++++++++
 Documentation/powerpc/dts-bindings/fsl/mpc5200.txt |    9 +---
 2 files changed, 54 insertions(+), 8 deletions(-)
 create mode 100644 Documentation/powerpc/dts-bindings/fsl/can.txt

Comments

Wolfram Sang Jan. 2, 2010, 2:05 p.m. UTC | #1
On Sat, Jan 02, 2010 at 09:17:54AM +0100, Wolfgang Grandegger wrote:
> From: Wolfgang Grandegger <wg@denx.de>
> 
> This patch adds documentation for the MSCAN OF device bindings for
> the MPC512x and moves the one for the MPC5200 to the new common file
> "Documentation/powerpc/dts-bindings/fsl/can.txt".
> 
> Signed-off-by: Wolfgang Grandegger <wg@denx.de>

Looks good to me (except for the typos ;))

Acked-by: Wolfram Sang <w.sang@pengutronix.de>

> ---
>  Documentation/powerpc/dts-bindings/fsl/can.txt     |   53 ++++++++++++++++++++
>  Documentation/powerpc/dts-bindings/fsl/mpc5200.txt |    9 +---
>  2 files changed, 54 insertions(+), 8 deletions(-)
>  create mode 100644 Documentation/powerpc/dts-bindings/fsl/can.txt
> 
> diff --git a/Documentation/powerpc/dts-bindings/fsl/can.txt b/Documentation/powerpc/dts-bindings/fsl/can.txt
> new file mode 100644
> index 0000000..44cfb61
> --- /dev/null
> +++ b/Documentation/powerpc/dts-bindings/fsl/can.txt
> @@ -0,0 +1,53 @@
> +CAN Device Tree Bindings
> +------------------------
> +
> +(c) 2006-2009 Secret Lab Technologies Ltd
> +Grant Likely <grant.likely@secretlab.ca>
> +
> +fsl,mpc5200-mscan nodes
> +-----------------------
> +In addition to the required compatible-, reg- and interrupt-properites, you can

properties.

> +also specify which clock source shall be used for the controller:
> +
> +- fsl,mscan-clock-source : a string describing the clock source. Valid values
> +			   are:	"ip" for ip bus clock
> +				 "ref" for reference clock (XTAL)
> +			   "ref" is default in case this property is not
> +			   present.
> +
> +fsl,mpc5121-mscan nodes
> +-----------------------
> +In addition to the required compatible-, reg- and interrupt-properites, you can

properties.

> +also specify which clock source shall be used for the controller:
> +
> +- fsl,mscan-clock-source : a string describing the clock source. Valid values
> +			   are:	"ip" for ip bus clock
> +				"ref" for reference clock
> +				"sys" for system clock
> +			   If this property is not present, an optimal CAN
> +			   clock source and frequency based on the system
> +			   will be selected. If this is not possible, the
> +			   reference clock will be used.
> +
> +- fsl,mscan-clock-divider: for the reference and system clock an additional
> +			   clock divider can be specified. By default a

I wonder if there should be a comma after 'default'. Maybe a native speaker can
help?

> +			   value of 1 is used.
> +
> +Examples:
> +	can@1300 {
> +		compatible = "fsl,mpc5121-mscan";
> +		cell-index = <0>;
> +		interrupts = <12 0x8>;
> +		interrupt-parent = < &ipic >;
> +		reg = <0x1300 0x80>;
> +	};
> +
> +	can@1380 {
> +		compatible = "fsl,mpc5121-mscan";
> +		cell-index = <1>;
> +		interrupts = <13 0x8>;
> +		interrupt-parent = < &ipic >;
> +		reg = <0x1380 0x80>;
> +		fsl,mscan-clock-source = "ref";
> +		fsl,mscan-clock-divider = <3>;
> +	};
> diff --git a/Documentation/powerpc/dts-bindings/fsl/mpc5200.txt b/Documentation/powerpc/dts-bindings/fsl/mpc5200.txt
> index 5c6602d..4ccb2cd 100644
> --- a/Documentation/powerpc/dts-bindings/fsl/mpc5200.txt
> +++ b/Documentation/powerpc/dts-bindings/fsl/mpc5200.txt
> @@ -195,11 +195,4 @@ External interrupts:
>  
>  fsl,mpc5200-mscan nodes
>  -----------------------
> -In addition to the required compatible-, reg- and interrupt-properites, you can
> -also specify which clock source shall be used for the controller:
> -
> -- fsl,mscan-clock-source- a string describing the clock source. Valid values
> -			  are:	"ip" for ip bus clock
> -				"ref" for reference clock (XTAL)
> -			  "ref" is default in case this property is not
> -			  present.
> +See file can.txt in this directory.
> -- 
> 1.6.2.5
>
diff mbox

Patch

diff --git a/Documentation/powerpc/dts-bindings/fsl/can.txt b/Documentation/powerpc/dts-bindings/fsl/can.txt
new file mode 100644
index 0000000..44cfb61
--- /dev/null
+++ b/Documentation/powerpc/dts-bindings/fsl/can.txt
@@ -0,0 +1,53 @@ 
+CAN Device Tree Bindings
+------------------------
+
+(c) 2006-2009 Secret Lab Technologies Ltd
+Grant Likely <grant.likely@secretlab.ca>
+
+fsl,mpc5200-mscan nodes
+-----------------------
+In addition to the required compatible-, reg- and interrupt-properites, you can
+also specify which clock source shall be used for the controller:
+
+- fsl,mscan-clock-source : a string describing the clock source. Valid values
+			   are:	"ip" for ip bus clock
+				 "ref" for reference clock (XTAL)
+			   "ref" is default in case this property is not
+			   present.
+
+fsl,mpc5121-mscan nodes
+-----------------------
+In addition to the required compatible-, reg- and interrupt-properites, you can
+also specify which clock source shall be used for the controller:
+
+- fsl,mscan-clock-source : a string describing the clock source. Valid values
+			   are:	"ip" for ip bus clock
+				"ref" for reference clock
+				"sys" for system clock
+			   If this property is not present, an optimal CAN
+			   clock source and frequency based on the system
+			   will be selected. If this is not possible, the
+			   reference clock will be used.
+
+- fsl,mscan-clock-divider: for the reference and system clock an additional
+			   clock divider can be specified. By default a
+			   value of 1 is used.
+
+Examples:
+	can@1300 {
+		compatible = "fsl,mpc5121-mscan";
+		cell-index = <0>;
+		interrupts = <12 0x8>;
+		interrupt-parent = < &ipic >;
+		reg = <0x1300 0x80>;
+	};
+
+	can@1380 {
+		compatible = "fsl,mpc5121-mscan";
+		cell-index = <1>;
+		interrupts = <13 0x8>;
+		interrupt-parent = < &ipic >;
+		reg = <0x1380 0x80>;
+		fsl,mscan-clock-source = "ref";
+		fsl,mscan-clock-divider = <3>;
+	};
diff --git a/Documentation/powerpc/dts-bindings/fsl/mpc5200.txt b/Documentation/powerpc/dts-bindings/fsl/mpc5200.txt
index 5c6602d..4ccb2cd 100644
--- a/Documentation/powerpc/dts-bindings/fsl/mpc5200.txt
+++ b/Documentation/powerpc/dts-bindings/fsl/mpc5200.txt
@@ -195,11 +195,4 @@  External interrupts:
 
 fsl,mpc5200-mscan nodes
 -----------------------
-In addition to the required compatible-, reg- and interrupt-properites, you can
-also specify which clock source shall be used for the controller:
-
-- fsl,mscan-clock-source- a string describing the clock source. Valid values
-			  are:	"ip" for ip bus clock
-				"ref" for reference clock (XTAL)
-			  "ref" is default in case this property is not
-			  present.
+See file can.txt in this directory.