Re: [PATCH 1/3] doc: bindings: Add bindings documentation for mtd nvmem
From: Boris Brezillon
Date: Fri Mar 03 2017 - 07:45:56 EST
On Fri, 3 Mar 2017 11:27:34 +0000
Srinivas Kandagatla <srinivas.kandagatla@xxxxxxxxxx> wrote:
> On 02/03/17 19:50, Alban wrote:
> > Add the binding to expose MTD partitions as nvmem providers.
>
> It would be nice to see more description of this patch, explaining the
> real use case.
> >
> > Signed-off-by: Alban <albeu@xxxxxxx>
> > ---
> > .../devicetree/bindings/nvmem/mtd-nvmem.txt | 29 ++++++++++++++++++++++
> > 1 file changed, 29 insertions(+)
> > create mode 100644 Documentation/devicetree/bindings/nvmem/mtd-nvmem.txt
> >
> > diff --git a/Documentation/devicetree/bindings/nvmem/mtd-nvmem.txt b/Documentation/devicetree/bindings/nvmem/mtd-nvmem.txt
> > new file mode 100644
> > index 0000000..47602f7
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/nvmem/mtd-nvmem.txt
> > @@ -0,0 +1,29 @@
> > += NVMEM in MTD =
> > +
> > +Config data for drivers is often stored in MTD devices. This binding
> > +define how such data can be represented in device tree.
> > +
> > +An MTD can be defined as an NVMEM provider by adding the `nvmem-provider`
> We should prefix this property with "mtd" to make it more explicit that
> this is specific to mtd devices.
MTD is a linux-ism, not sure DT maintainers will like it ;-).
>
> May be we should put this under "Required Properties" section, marking
> it as mandatory for mtd nvmem providers.
It's definitely optional. It's really a choice to provide a nvmem cells
under an MTD partition.
>
> > +property to their node. Data cells can then be defined as child nodes
> > +of the partition as defined in nvmem.txt.
> > +
> > +Example:
> > +
> > + flash@0 {
> > + ...
> > +
> > + partition@2 {
> > + label = "art";
> > + reg = <0x7F0000 0x010000>;
> > + read-only;
> > +
> > + nvmem-provider;
> > + #address-cells = <1>;
> > + #size-cells = <1>;
> > +
> > + eeprom@1000 {
> > + label = "wmac-eeprom";
> > + reg = <0x1000 0x1000>;
> > + };
> > + };
> > + };
> >