Re: [PATCH v3 2/6] Documentation: dt: mtd: gpmi: document the clocks and clock-names in DT property
From: Rob Herring
Date: Tue Jun 28 2016 - 16:59:01 EST
On Fri, Jun 24, 2016 at 04:40:07PM -0500, Han Xu wrote:
> add the clocks and clock-names in DT property, gpmi-io clock is
> mandatory for all platforms, but some platforms, such as i.MX6Q may
> need more extra clocks for submodules. More details please refer to the
> SoC reference manual.
>
> Signed-off-by: Han Xu <han.xu@xxxxxxx>
> ---
> Documentation/devicetree/bindings/mtd/gpmi-nand.txt | 9 +++++++++
> 1 file changed, 9 insertions(+)
>
> diff --git a/Documentation/devicetree/bindings/mtd/gpmi-nand.txt b/Documentation/devicetree/bindings/mtd/gpmi-nand.txt
> index d02acaf..a2fd034 100644
> --- a/Documentation/devicetree/bindings/mtd/gpmi-nand.txt
> +++ b/Documentation/devicetree/bindings/mtd/gpmi-nand.txt
> @@ -13,6 +13,13 @@ Required properties:
> and GPMI DMA channel ID.
> Refer to dma.txt and fsl-mxs-dma.txt for details.
> - dma-names: Must be "rx-tx".
> + - clocks : The clocks needed by the gpmi controller. This field varies
> + depends on the SoC design, "gpmi-io" is mandatory but some platforms may
> + need several extra clocks, such as i.MX6 series, which requires "gpmi_apb,
> + gpmi_bch, gpmi_bch_apb and per1_bch" for all submodules, while i.MX7 only
> + need gpmi_bch_apb. Please refer to the HW design manual.
> + - clock-names : the name of the clocks, please refer to the HW design
> + manual.
No please list the names here (I assume what is above?). Also need to
specify the order of the clocks. It would be clearest if you list things
by exact compatible strings.
Rob