diff mbox series

[2/3] Documentation: DT: Add entry for DPAA2 console

Message ID 1545406240-3061-3-git-send-email-ioana.ciornei@nxp.com
State Changes Requested, archived
Headers show
Series soc: fsl: add DPAA2 log console support | expand

Checks

Context Check Description
robh/checkpatch success

Commit Message

Ioana Ciornei Dec. 21, 2018, 3:31 p.m. UTC 
This patch adds a devicetree binding documentation for
FSL's DPAA2 console.

Signed-off-by: Ioana Ciornei <ioana.ciornei@nxp.com>
---
 Documentation/devicetree/bindings/misc/dpaa2-console.txt | 11 +++++++++++
 MAINTAINERS                                              |  1 +
 2 files changed, 12 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/misc/dpaa2-console.txt

Comments

Rob Herring Jan. 3, 2019, 8:32 p.m. UTC | #1 
On Fri, Dec 21, 2018 at 03:31:11PM +0000, Ioana Ciornei wrote:
> This patch adds a devicetree binding documentation for
> FSL's DPAA2 console.
> 
> Signed-off-by: Ioana Ciornei <ioana.ciornei@nxp.com>
> ---
>  Documentation/devicetree/bindings/misc/dpaa2-console.txt | 11 +++++++++++
>  MAINTAINERS                                              |  1 +
>  2 files changed, 12 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/misc/dpaa2-console.txt
> 
> diff --git a/Documentation/devicetree/bindings/misc/dpaa2-console.txt b/Documentation/devicetree/bindings/misc/dpaa2-console.txt
> new file mode 100644
> index 0000000..f4e16b1
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/misc/dpaa2-console.txt
> @@ -0,0 +1,11 @@
> +DPAA2 console support
> +
> +Required properties:
> +
> +    - compatible
> +        Value type: <string>
> +        Definition: Must be "dpaa2-console".
> +    - reg
> +        Value type: <prop-encoded-array>
> +        Definition: A standard property.  Specifies the region where the MCFBA
> +                    (MC firmware base address) register can be found.

What's the relationship between MCFBA and the console? The binding 
should describe the h/w block or firmware interface not the feature you 
want to implement. Are there other functions provided by the MC 
firmware?

Rob
Ioana Ciornei Jan. 4, 2019, 5:50 p.m. UTC | #2 
> Subject: Re: [PATCH 2/3] Documentation: DT: Add entry for DPAA2 console
> 
> On Fri, Dec 21, 2018 at 03:31:11PM +0000, Ioana Ciornei wrote:
> > This patch adds a devicetree binding documentation for FSL's DPAA2
> > console.
> >
> > Signed-off-by: Ioana Ciornei <ioana.ciornei@nxp.com>
> > ---
> >  Documentation/devicetree/bindings/misc/dpaa2-console.txt | 11
> +++++++++++
> >  MAINTAINERS                                              |  1 +
> >  2 files changed, 12 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/misc/dpaa2-console.txt
> >
> > diff --git a/Documentation/devicetree/bindings/misc/dpaa2-console.txt
> > b/Documentation/devicetree/bindings/misc/dpaa2-console.txt
> > new file mode 100644
> > index 0000000..f4e16b1
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/misc/dpaa2-console.txt
> > @@ -0,0 +1,11 @@
> > +DPAA2 console support
> > +
> > +Required properties:
> > +
> > +    - compatible
> > +        Value type: <string>
> > +        Definition: Must be "dpaa2-console".
> > +    - reg
> > +        Value type: <prop-encoded-array>
> > +        Definition: A standard property.  Specifies the region where the MCFBA
> > +                    (MC firmware base address) register can be found.
> 
> What's the relationship between MCFBA and the console?

The console is basically a log buffer of the MC firmware, and is found at a known offset compared to the firmware image's runtime base address.

> The binding should describe the h/w block or firmware interface not the feature you want to
> implement. Are there other functions provided by the MC firmware?

The MC firmware manages all hardware resources related to networking or any other accelerators.
Any interaction with the firmware is made through commands put in memory mapped regions.
The fsl-mc bus driver is the one that already manages this interaction with the MC.

Ioana

> 
> Rob
Shawn Guo Jan. 22, 2019, 2:54 a.m. UTC | #3 
On Fri, Dec 21, 2018 at 03:31:11PM +0000, Ioana Ciornei wrote:
> This patch adds a devicetree binding documentation for
> FSL's DPAA2 console.
> 
> Signed-off-by: Ioana Ciornei <ioana.ciornei@nxp.com>
> ---
>  Documentation/devicetree/bindings/misc/dpaa2-console.txt | 11 +++++++++++
>  MAINTAINERS                                              |  1 +
>  2 files changed, 12 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/misc/dpaa2-console.txt
> 
> diff --git a/Documentation/devicetree/bindings/misc/dpaa2-console.txt b/Documentation/devicetree/bindings/misc/dpaa2-console.txt
> new file mode 100644
> index 0000000..f4e16b1
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/misc/dpaa2-console.txt
> @@ -0,0 +1,11 @@
> +DPAA2 console support
> +
> +Required properties:
> +
> +    - compatible
> +        Value type: <string>
> +        Definition: Must be "dpaa2-console".

Why this doesn't need a vendor prefix?

Shawn

> +    - reg
> +        Value type: <prop-encoded-array>
> +        Definition: A standard property.  Specifies the region where the MCFBA
> +                    (MC firmware base address) register can be found.
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 7b76a80..229d4fb 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -5969,6 +5969,7 @@ M:	Li Yang <leoyang.li@nxp.com>
>  L:	linuxppc-dev@lists.ozlabs.org
>  L:	linux-arm-kernel@lists.infradead.org
>  S:	Maintained
> +F:	Documentation/devicetree/bindings/misc/dpaa2-console.txt
>  F:	Documentation/devicetree/bindings/soc/fsl/
>  F:	drivers/soc/fsl/
>  F:	include/linux/fsl/
> -- 
> 1.9.1
> 
> 
> _______________________________________________
> linux-arm-kernel mailing list
> linux-arm-kernel@lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/misc/dpaa2-console.txt b/Documentation/devicetree/bindings/misc/dpaa2-console.txt
new file mode 100644
index 0000000..f4e16b1
--- /dev/null
+++ b/Documentation/devicetree/bindings/misc/dpaa2-console.txt
@@ -0,0 +1,11 @@ 
+DPAA2 console support
+
+Required properties:
+
+    - compatible
+        Value type: <string>
+        Definition: Must be "dpaa2-console".
+    - reg
+        Value type: <prop-encoded-array>
+        Definition: A standard property.  Specifies the region where the MCFBA
+                    (MC firmware base address) register can be found.
diff --git a/MAINTAINERS b/MAINTAINERS
index 7b76a80..229d4fb 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -5969,6 +5969,7 @@  M:	Li Yang <leoyang.li@nxp.com>
 L:	linuxppc-dev@lists.ozlabs.org
 L:	linux-arm-kernel@lists.infradead.org
 S:	Maintained
+F:	Documentation/devicetree/bindings/misc/dpaa2-console.txt
 F:	Documentation/devicetree/bindings/soc/fsl/
 F:	drivers/soc/fsl/
 F:	include/linux/fsl/