diff mbox

[7/7] ARM: meson: update documentation (uart, timer and vendors)

Message ID 1408272594-10814-8-git-send-email-carlo@caione.org (mailing list archive)
State New, archived
Headers show

Commit Message

Carlo Caione Aug. 17, 2014, 10:49 a.m. UTC
New UART and timer bindings are documented. A new vendor is added to the
vendors list.

Signed-off-by: Carlo Caione <carlo@caione.org>
---
 .../devicetree/bindings/serial/amlogic,meson-uart.txt   | 17 +++++++++++++++++
 .../devicetree/bindings/timer/amlogic,meson6-timer.txt  | 16 ++++++++++++++++
 Documentation/devicetree/bindings/vendor-prefixes.txt   |  1 +
 3 files changed, 34 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/serial/amlogic,meson-uart.txt
 create mode 100644 Documentation/devicetree/bindings/timer/amlogic,meson6-timer.txt

Comments

Matthias Brugger Aug. 18, 2014, 10:36 a.m. UTC | #1
On 17/08/14 12:49, Carlo Caione wrote:
> New UART and timer bindings are documented. A new vendor is added to the
> vendors list.
>
> Signed-off-by: Carlo Caione <carlo@caione.org>
> ---
>   .../devicetree/bindings/serial/amlogic,meson-uart.txt   | 17 +++++++++++++++++
>   .../devicetree/bindings/timer/amlogic,meson6-timer.txt  | 16 ++++++++++++++++
>   Documentation/devicetree/bindings/vendor-prefixes.txt   |  1 +
>   3 files changed, 34 insertions(+)
>   create mode 100644 Documentation/devicetree/bindings/serial/amlogic,meson-uart.txt
>   create mode 100644 Documentation/devicetree/bindings/timer/amlogic,meson6-timer.txt

This should be three patches for the different files. It might happen, 
that for example your timer driver get merged through a different tree 
then arm-soc. For the merge, the driver and the documentation should go 
togehter.

>
> diff --git a/Documentation/devicetree/bindings/serial/amlogic,meson-uart.txt b/Documentation/devicetree/bindings/serial/amlogic,meson-uart.txt
> new file mode 100644
> index 0000000..fa1935a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/serial/amlogic,meson-uart.txt
> @@ -0,0 +1,17 @@
> +Amlogic Meson UART
> +
> +Required properties:
> +- compatible : Should be "amlogic,meson-uart"
> +- reg : Address and length of the register set
> +- interrupts : Should contain uart interrupt
> +- clocks: phandle to the source clock
> +
> +Example:
> +
> +uart0: serial@c81004c0 {
> +	compatible = "amlogic,meson-uart";
> +	reg = <0xc81004c0 0x14>;
> +	interrupts = <0 90 1>;
> +	clocks = <&clk81>;
> +};
> +
> diff --git a/Documentation/devicetree/bindings/timer/amlogic,meson6-timer.txt b/Documentation/devicetree/bindings/timer/amlogic,meson6-timer.txt
> new file mode 100644
> index 0000000..cf89894
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/timer/amlogic,meson6-timer.txt
> @@ -0,0 +1,16 @@
> +Amlogic Meson6 SoCs Timer Controller
> +
> +Required properties:
> +
> +- compatible : should be "amlogic,meson6-timer.txt"
> +- reg : Specifies base physical address and size of the registers.
> +- interrupts : The interrupt of the first timer
> +
> +Example:
> +
> +timer@c1109940 {
> +	compatible = "amlogic,meson6-timer";
> +	reg = <0xc1109940 0x14>;
> +	interrupts = <0 10 1>;
> +};
> +
> diff --git a/Documentation/devicetree/bindings/vendor-prefixes.txt b/Documentation/devicetree/bindings/vendor-prefixes.txt
> index ac7269f..5cf0618 100644
> --- a/Documentation/devicetree/bindings/vendor-prefixes.txt
> +++ b/Documentation/devicetree/bindings/vendor-prefixes.txt
> @@ -14,6 +14,7 @@ allwinner	Allwinner Technology Co., Ltd.
>   altr	Altera Corp.
>   amcc	Applied Micro Circuits Corporation (APM, formally AMCC)
>   amd	Advanced Micro Devices (AMD), Inc.
> +amlogic	Amlogic, Inc.
>   ams	AMS AG
>   amstaos	AMS-Taos Inc.
>   apm	Applied Micro Circuits Corporation (APM)
>
Carlo Caione Aug. 18, 2014, 1:33 p.m. UTC | #2
On Mon, Aug 18, 2014 at 12:36:47PM +0200, Matthias Brugger wrote:
> 
> 
> On 17/08/14 12:49, Carlo Caione wrote:
> >New UART and timer bindings are documented. A new vendor is added to the
> >vendors list.
> >
> >Signed-off-by: Carlo Caione <carlo@caione.org>
> >---
> >  .../devicetree/bindings/serial/amlogic,meson-uart.txt   | 17 +++++++++++++++++
> >  .../devicetree/bindings/timer/amlogic,meson6-timer.txt  | 16 ++++++++++++++++
> >  Documentation/devicetree/bindings/vendor-prefixes.txt   |  1 +
> >  3 files changed, 34 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/serial/amlogic,meson-uart.txt
> >  create mode 100644 Documentation/devicetree/bindings/timer/amlogic,meson6-timer.txt
> 
> This should be three patches for the different files. It might
> happen, that for example your timer driver get merged through a
> different tree then arm-soc. For the merge, the driver and the
> documentation should go togehter.

Right. Thank you for pointing this out.

Best,
Andreas Färber Aug. 23, 2014, 12:24 p.m. UTC | #3
Am 17.08.2014 12:49, schrieb Carlo Caione:
> New UART and timer bindings are documented. A new vendor is added to the
> vendors list.
> 
> Signed-off-by: Carlo Caione <carlo@caione.org>
> ---
>  .../devicetree/bindings/serial/amlogic,meson-uart.txt   | 17 +++++++++++++++++
>  .../devicetree/bindings/timer/amlogic,meson6-timer.txt  | 16 ++++++++++++++++
>  Documentation/devicetree/bindings/vendor-prefixes.txt   |  1 +
>  3 files changed, 34 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/serial/amlogic,meson-uart.txt
>  create mode 100644 Documentation/devicetree/bindings/timer/amlogic,meson6-timer.txt
[...]
> diff --git a/Documentation/devicetree/bindings/vendor-prefixes.txt b/Documentation/devicetree/bindings/vendor-prefixes.txt
> index ac7269f..5cf0618 100644
> --- a/Documentation/devicetree/bindings/vendor-prefixes.txt
> +++ b/Documentation/devicetree/bindings/vendor-prefixes.txt
> @@ -14,6 +14,7 @@ allwinner	Allwinner Technology Co., Ltd.
>  altr	Altera Corp.
>  amcc	Applied Micro Circuits Corporation (APM, formally AMCC)
>  amd	Advanced Micro Devices (AMD), Inc.
> +amlogic	Amlogic, Inc.
>  ams	AMS AG
>  amstaos	AMS-Taos Inc.
>  apm	Applied Micro Circuits Corporation (APM)

Sorry, here's the vendor prefix I was asking about. Please split it off
into its own patch and best order it before the first use.

Documentation of SoC and board seem to be indeed missing though.

Cheers,
Andreas
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/serial/amlogic,meson-uart.txt b/Documentation/devicetree/bindings/serial/amlogic,meson-uart.txt
new file mode 100644
index 0000000..fa1935a
--- /dev/null
+++ b/Documentation/devicetree/bindings/serial/amlogic,meson-uart.txt
@@ -0,0 +1,17 @@ 
+Amlogic Meson UART
+
+Required properties:
+- compatible : Should be "amlogic,meson-uart"
+- reg : Address and length of the register set
+- interrupts : Should contain uart interrupt
+- clocks: phandle to the source clock
+
+Example:
+
+uart0: serial@c81004c0 {
+	compatible = "amlogic,meson-uart";
+	reg = <0xc81004c0 0x14>;
+	interrupts = <0 90 1>;
+	clocks = <&clk81>;
+};
+
diff --git a/Documentation/devicetree/bindings/timer/amlogic,meson6-timer.txt b/Documentation/devicetree/bindings/timer/amlogic,meson6-timer.txt
new file mode 100644
index 0000000..cf89894
--- /dev/null
+++ b/Documentation/devicetree/bindings/timer/amlogic,meson6-timer.txt
@@ -0,0 +1,16 @@ 
+Amlogic Meson6 SoCs Timer Controller
+
+Required properties:
+
+- compatible : should be "amlogic,meson6-timer.txt"
+- reg : Specifies base physical address and size of the registers.
+- interrupts : The interrupt of the first timer
+
+Example:
+
+timer@c1109940 {
+	compatible = "amlogic,meson6-timer";
+	reg = <0xc1109940 0x14>;
+	interrupts = <0 10 1>;
+};
+
diff --git a/Documentation/devicetree/bindings/vendor-prefixes.txt b/Documentation/devicetree/bindings/vendor-prefixes.txt
index ac7269f..5cf0618 100644
--- a/Documentation/devicetree/bindings/vendor-prefixes.txt
+++ b/Documentation/devicetree/bindings/vendor-prefixes.txt
@@ -14,6 +14,7 @@  allwinner	Allwinner Technology Co., Ltd.
 altr	Altera Corp.
 amcc	Applied Micro Circuits Corporation (APM, formally AMCC)
 amd	Advanced Micro Devices (AMD), Inc.
+amlogic	Amlogic, Inc.
 ams	AMS AG
 amstaos	AMS-Taos Inc.
 apm	Applied Micro Circuits Corporation (APM)