| Message ID | 1408096156-29772-4-git-send-email-bhupesh.sharma@freescale.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
[devicetree-discuss is no more, fixing up to devicetree@vger.kernel.org] Hi, On Fri, Aug 15, 2014 at 10:49:12AM +0100, Bhupesh Sharma wrote: > This patch adds a devicetree binding documentation for FSL's > Management Complex. > > Management Complex is a hardware resource manager that manages > specialized hardware objects used in network-oriented packet > processing applications > > Signed-off-by: Bhupesh Sharma <bhupesh.sharma@freescale.com> > Signed-off-by: Stuart Yoder <stuart.yoder@freescale.com> > Signed-off-by: J. German Rivera <German.Rivera@freescale.com> > --- > .../devicetree/bindings/misc/fsl,qoriq-mc.txt | 40 ++++++++++++++++++++ > 1 file changed, 40 insertions(+) > create mode 100644 Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt > > diff --git a/Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt b/Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt > new file mode 100644 > index 0000000..608529e > --- /dev/null > +++ b/Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt > @@ -0,0 +1,40 @@ > +* Freescale Management Complex > + > +The Freescale Management Complex (fsl-mc) is a hardware resource > +manager that manages specialized hardware objects used in > +network-oriented packet processing applications. After the fsl-mc > +block is enabled, pools of hardware resources are available, such as > +queues, buffer pools, I/O interfaces. These resources are building > +blocks that can be used to create functional hardware objects/devices > +such as network interfaces, crypto accelerator instances, L2 switches, > +etc. > + > +Required properties: > + > + - compatible > + Value type: <string> > + Definition: Must be "fsl,qoriq-mc". A Freescale Management Complex > + compatible with this binding must have Block Revision > + Registers BRR1 and BRR2 at offset 0x0BF8 and 0x0BFC in > + the MC control register region. > + > + - reg > + Value type: <prop-encoded-array> > + Definition: A standard property. Specifies one or two regions > + defining the MC's registers: > + > + -the first region is the command portal for the > + this machine and must always be present > + > + -the second region is the MC control registers. This > + region may not be present in some scenarios, such > + as in the device tree presented to a virtual machine. This looks extremely simple. Is this unit self-contained or does it relate to other blocks which will be described separately? > + > +Example: > + > + fsl_mc: fsl-mc@80c000000 { > + compatible = "fsl,qoriq-mc"; > + reg = <0x00000008 0x0c000000 0 0x40 // MC portal base > + 0x00000000 0x08340000 0 0x40000 >; // MC control reg Nit: could we bracket list entries individually please? Thanks, Mark.
> -----Original Message----- > From: Mark Rutland [mailto:mark.rutland@arm.com] > Sent: Friday, August 15, 2014 6:00 AM > To: Sharma Bhupesh-B45370 > Cc: devicetree@vger.kernel.org; Catalin Marinas; arnd@arndb.de; Rivera Jose- > B46482; Will Deacon; Yoder Stuart-B08248; grant.likely@secretlab.ca; Basu > Arnab-B45036; linux-arm-kernel@lists.infradead.org > Subject: Re: [PATCH 3/6] Documentation: DT: Add entry for FSL Management > Complex > > [devicetree-discuss is no more, fixing up to devicetree@vger.kernel.org] > > Hi, > > On Fri, Aug 15, 2014 at 10:49:12AM +0100, Bhupesh Sharma wrote: > > This patch adds a devicetree binding documentation for FSL's > > Management Complex. > > > > Management Complex is a hardware resource manager that manages > > specialized hardware objects used in network-oriented packet > > processing applications > > > > Signed-off-by: Bhupesh Sharma <bhupesh.sharma@freescale.com> > > Signed-off-by: Stuart Yoder <stuart.yoder@freescale.com> > > Signed-off-by: J. German Rivera <German.Rivera@freescale.com> > > --- > > .../devicetree/bindings/misc/fsl,qoriq-mc.txt | 40 > ++++++++++++++++++++ > > 1 file changed, 40 insertions(+) > > create mode 100644 Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt > > > > diff --git a/Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt > b/Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt > > new file mode 100644 > > index 0000000..608529e > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt > > @@ -0,0 +1,40 @@ > > +* Freescale Management Complex > > + > > +The Freescale Management Complex (fsl-mc) is a hardware resource > > +manager that manages specialized hardware objects used in > > +network-oriented packet processing applications. After the fsl-mc > > +block is enabled, pools of hardware resources are available, such as > > +queues, buffer pools, I/O interfaces. These resources are building > > +blocks that can be used to create functional hardware objects/devices > > +such as network interfaces, crypto accelerator instances, L2 switches, > > +etc. > > + > > +Required properties: > > + > > + - compatible > > + Value type: <string> > > + Definition: Must be "fsl,qoriq-mc". A Freescale Management Complex > > + compatible with this binding must have Block Revision > > + Registers BRR1 and BRR2 at offset 0x0BF8 and 0x0BFC in > > + the MC control register region. > > + > > + - reg > > + Value type: <prop-encoded-array> > > + Definition: A standard property. Specifies one or two regions > > + defining the MC's registers: > > + > > + -the first region is the command portal for the > > + this machine and must always be present > > + > > + -the second region is the MC control registers. This > > + region may not be present in some scenarios, such > > + as in the device tree presented to a virtual > machine. > > This looks extremely simple. Is this unit self-contained or does it > relate to other blocks which will be described separately? The block is self-contained. It's a complicated block, but all interactions with happen through the command interface (1st reg region). [The MC can do DMA and thus will relate to the SMMU, but there is some present churn around the SMMU and we'll define the needed properties (#stream-id-cells or whatever) when that is clear.] Stuart
On Aug 15, 2014, at 6:00 AM, Mark Rutland <mark.rutland@arm.com> wrote: > [devicetree-discuss is no more, fixing up to devicetree@vger.kernel.org] > > Hi, > > On Fri, Aug 15, 2014 at 10:49:12AM +0100, Bhupesh Sharma wrote: >> This patch adds a devicetree binding documentation for FSL's >> Management Complex. >> >> Management Complex is a hardware resource manager that manages >> specialized hardware objects used in network-oriented packet >> processing applications >> >> Signed-off-by: Bhupesh Sharma <bhupesh.sharma@freescale.com> >> Signed-off-by: Stuart Yoder <stuart.yoder@freescale.com> >> Signed-off-by: J. German Rivera <German.Rivera@freescale.com> >> --- >> .../devicetree/bindings/misc/fsl,qoriq-mc.txt | 40 ++++++++++++++++++++ I’d probably start this off in bindings/soc/fsl/ >> 1 file changed, 40 insertions(+) >> create mode 100644 Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt >> >> diff --git a/Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt b/Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt >> new file mode 100644 >> index 0000000..608529e >> --- /dev/null >> +++ b/Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt >> @@ -0,0 +1,40 @@ >> +* Freescale Management Complex >> + >> +The Freescale Management Complex (fsl-mc) is a hardware resource >> +manager that manages specialized hardware objects used in >> +network-oriented packet processing applications. After the fsl-mc >> +block is enabled, pools of hardware resources are available, such as >> +queues, buffer pools, I/O interfaces. These resources are building >> +blocks that can be used to create functional hardware objects/devices >> +such as network interfaces, crypto accelerator instances, L2 switches, >> +etc. >> + >> +Required properties: >> + >> + - compatible >> + Value type: <string> >> + Definition: Must be "fsl,qoriq-mc". A Freescale Management Complex >> + compatible with this binding must have Block Revision >> + Registers BRR1 and BRR2 at offset 0x0BF8 and 0x0BFC in >> + the MC control register region. Hmm, this BRR1/BRR2 comments are a little odd, if we keep those, we should probably also state what value is BRR1 (I think that was the one that contented the IP ID). >> + >> + - reg >> + Value type: <prop-encoded-array> >> + Definition: A standard property. Specifies one or two regions >> + defining the MC's registers: >> + >> + -the first region is the command portal for the >> + this machine and must always be present >> + >> + -the second region is the MC control registers. This >> + region may not be present in some scenarios, such >> + as in the device tree presented to a virtual machine. Should we distinguish the second case w/a different compat? It seems like a major driver change if the second region isn’t there, or a different driver? > > This looks extremely simple. Is this unit self-contained or does it > relate to other blocks which will be described separately? > >> + >> +Example: >> + >> + fsl_mc: fsl-mc@80c000000 { >> + compatible = "fsl,qoriq-mc"; >> + reg = <0x00000008 0x0c000000 0 0x40 // MC portal base >> + 0x00000000 0x08340000 0 0x40000 >; // MC control reg > > Nit: could we bracket list entries individually please? > > Thanks, > Mark. > > _______________________________________________ - k
diff --git a/Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt b/Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt new file mode 100644 index 0000000..608529e --- /dev/null +++ b/Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt @@ -0,0 +1,40 @@ +* Freescale Management Complex + +The Freescale Management Complex (fsl-mc) is a hardware resource +manager that manages specialized hardware objects used in +network-oriented packet processing applications. After the fsl-mc +block is enabled, pools of hardware resources are available, such as +queues, buffer pools, I/O interfaces. These resources are building +blocks that can be used to create functional hardware objects/devices +such as network interfaces, crypto accelerator instances, L2 switches, +etc. + +Required properties: + + - compatible + Value type: <string> + Definition: Must be "fsl,qoriq-mc". A Freescale Management Complex + compatible with this binding must have Block Revision + Registers BRR1 and BRR2 at offset 0x0BF8 and 0x0BFC in + the MC control register region. + + - reg + Value type: <prop-encoded-array> + Definition: A standard property. Specifies one or two regions + defining the MC's registers: + + -the first region is the command portal for the + this machine and must always be present + + -the second region is the MC control registers. This + region may not be present in some scenarios, such + as in the device tree presented to a virtual machine. + +Example: + + fsl_mc: fsl-mc@80c000000 { + compatible = "fsl,qoriq-mc"; + reg = <0x00000008 0x0c000000 0 0x40 // MC portal base + 0x00000000 0x08340000 0 0x40000 >; // MC control reg + }; +