| Message ID | 20220214135840.168236-3-conor.dooley@microchip.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Update the Icicle Kit device tree | expand |
Hey Rob, I removed the children and added a link to the documentation for the services. Could you take a look and see if this version meets your approval? Thanks. Conor On 14/02/2022 13:58, conor.dooley@microchip.com wrote: > From: Conor Dooley <conor.dooley@microchip.com> > > The services actually provided by the system controller are not > documented so add some words about what the system controller can > actually do. Add a link to the oneline documentation with the specific > details of each individual service. > Also, drop the unneeded label from the example. > > Signed-off-by: Conor Dooley <conor.dooley@microchip.com> > --- > .../soc/microchip/microchip,mpfs-sys-controller.yaml | 11 ++++++++--- > 1 file changed, 8 insertions(+), 3 deletions(-) > > diff --git a/Documentation/devicetree/bindings/soc/microchip/microchip,mpfs-sys-controller.yaml b/Documentation/devicetree/bindings/soc/microchip/microchip,mpfs-sys-controller.yaml > index f699772fedf3..b0dae51e1d42 100644 > --- a/Documentation/devicetree/bindings/soc/microchip/microchip,mpfs-sys-controller.yaml > +++ b/Documentation/devicetree/bindings/soc/microchip/microchip,mpfs-sys-controller.yaml > @@ -10,9 +10,14 @@ maintainers: > - Conor Dooley <conor.dooley@microchip.com> > > description: | > - The PolarFire SoC system controller is communicated with via a mailbox. > - This document describes the bindings for the client portion of that mailbox. > + PolarFire SoC devices include a microcontroller acting as the system controller, > + which provides "services" to the main processor and to the FPGA fabric. These > + services include hardware rng, reprogramming of the FPGA and verfification of the > + eNVM contents etc. More information on these services can be found online, at > + https://onlinedocs.microchip.com/pr/GUID-1409CF11-8EF9-4C24-A94E-70979A688632-en-US-1/index.html > > + Communication with the system controller is done via a mailbox, of which the client > + portion is documented here. > > properties: > mboxes: > @@ -29,7 +34,7 @@ additionalProperties: false > > examples: > - | > - syscontroller: syscontroller { > + syscontroller { > compatible = "microchip,mpfs-sys-controller"; > mboxes = <&mbox 0>; > };
On Mon, 14 Feb 2022 13:58:32 +0000, conor.dooley@microchip.com wrote: > From: Conor Dooley <conor.dooley@microchip.com> > > The services actually provided by the system controller are not > documented so add some words about what the system controller can > actually do. Add a link to the oneline documentation with the specific > details of each individual service. > Also, drop the unneeded label from the example. > > Signed-off-by: Conor Dooley <conor.dooley@microchip.com> > --- > .../soc/microchip/microchip,mpfs-sys-controller.yaml | 11 ++++++++--- > 1 file changed, 8 insertions(+), 3 deletions(-) > Reviewed-by: Rob Herring <robh@kernel.org>
diff --git a/Documentation/devicetree/bindings/soc/microchip/microchip,mpfs-sys-controller.yaml b/Documentation/devicetree/bindings/soc/microchip/microchip,mpfs-sys-controller.yaml index f699772fedf3..b0dae51e1d42 100644 --- a/Documentation/devicetree/bindings/soc/microchip/microchip,mpfs-sys-controller.yaml +++ b/Documentation/devicetree/bindings/soc/microchip/microchip,mpfs-sys-controller.yaml @@ -10,9 +10,14 @@ maintainers: - Conor Dooley <conor.dooley@microchip.com> description: | - The PolarFire SoC system controller is communicated with via a mailbox. - This document describes the bindings for the client portion of that mailbox. + PolarFire SoC devices include a microcontroller acting as the system controller, + which provides "services" to the main processor and to the FPGA fabric. These + services include hardware rng, reprogramming of the FPGA and verfification of the + eNVM contents etc. More information on these services can be found online, at + https://onlinedocs.microchip.com/pr/GUID-1409CF11-8EF9-4C24-A94E-70979A688632-en-US-1/index.html + Communication with the system controller is done via a mailbox, of which the client + portion is documented here. properties: mboxes: @@ -29,7 +34,7 @@ additionalProperties: false examples: - | - syscontroller: syscontroller { + syscontroller { compatible = "microchip,mpfs-sys-controller"; mboxes = <&mbox 0>; };