Re: [PATCH v3 1/2] fsl: Add binding for RCPM

[Scott Wood <scottwood@freescale.com>]

On Thu, 2015-10-01 at 12:05 -0500, Yoder Stuart-B08248 wrote:
> > +++ b/Documentation/devicetree/bindings/soc/fsl/rcpm.txt
> > @@ -0,0 +1,63 @@
> > +* Run Control and Power Management
> > +-------------------------------------------
> > +The RCPM performs all device-level tasks associated with device run 
> > control
> > +and power management.
> > +
> > +Required properites:
> > +  - reg : Offset and length of the register set of RCPM block.
> 
> s/RCPM block/the RCPM block/
> 
> > +  - fsl,#rcpm-wakeup-cells : The number of cells in rcpm-wakeup property.
> 
> s/rcpm-wakeup-property/the rcpm-wakeup-property/
> 
> > +  - compatible : Sould contain a chip-specific RCPM block compatible 
> > string
> 
> s/Sould/Should
> 
> "Should" means it is recommended, but does not mean "must".  Is it really 
> optional?
> 
> > +       and (if applicable) may contain a chassis-version RCPM compatible
> > +       string. Chip-specific strings are of the form "fsl,<chip>-rcpm",
> > +       such as:
> > +       * "fsl,p2041-rcpm"
> > +       * "fsl,p3041-rcpm"
> > +       * "fsl,p4080-rcpm"
> > +       * "fsl,p5020-rcpm"
> > +       * "fsl,p5040-rcpm"
> > +       * "fsl,t4240-rcpm"
> > +       * "fsl,b4420-rcpm"
> > +       * "fsl,b4860-rcpm"
> 
> 2 or 3 examples is enough.
> 
> > +       Chassis-version strings are of the form "fsl,qoriq-rcpm-
> > <version>",
> > +       such as:
> > +       * "fsl,qoriq-rcpm-1.0": for chassis 1.0 rcpm
> > +       * "fsl,qoriq-rcpm-2.0": for chassis 2.0 rcpm
> > +       * "fsl,qoriq-rcpm-2.1": for chassis 2.1 rcpm
> > +
> > +All references to "1.0" and "2.0" refer to the QorIQ chassis version to
> > +which the chip complies.
> > +Chassis Version                Example Chips
> > +---------------                -------------------------------
> > +1.0                            p4080, p5020, p5040, p2041, p3041
> > +2.0                            t4240, b4860, b4420
> > +2.1                            t1040, ls1021
> 
> Not sure this binding is the place to maintain a table of chassis
> versions to SoCs.

This is something I've been encouraging, given that the block versions are 
not publicly documented.  It lets people find a manual that describes the 
advertised programming interface.

-Scott