Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Date:   Wed, 16 Jun 2021 14:38:54 +0200
From:   Maxime Ripard <maxime@cerno.tech>
To:     =?utf-8?B?54+t5rab?= <fengzheng923@gmail.com>
Cc:     lgirdwood@gmail.com, broonie@kernel.org, robh+dt@kernel.org,
        wens@csie.org, jernej.skrabec@gmail.com,
        alsa-devel@alsa-project.org, devicetree@vger.kernel.org,
        linux-arm-kernel@lists.infradead.org, linux-sunxi@lists.linux.dev,
        linux-kernel@vger.kernel.org
Subject: Re: [PATCH 2/2] ASoC: sun50i-dmic: dt-bindings: add DT bindings for
 DMIC controller
Message-ID: <20210616123854.hcdlpqc6owyqn3fu@gilmour>
References: <20210615130737.2098-1-fengzheng923@gmail.com>
 <20210616084920.y6yjic4sau6ungv5@gilmour>
 <CAE=m619_52DDC_up=QqRXkF88uJR6CcAJqentnBzb=pxL7LhxA@mail.gmail.com>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha256;
        protocol="application/pgp-signature"; boundary="hi7zosja6vhzuga5"
Content-Disposition: inline
In-Reply-To: <CAE=m619_52DDC_up=QqRXkF88uJR6CcAJqentnBzb=pxL7LhxA@mail.gmail.com>
Precedence: bulk


--hi7zosja6vhzuga5
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Wed, Jun 16, 2021 at 06:56:25PM +0800, =E7=8F=AD=E6=B6=9B wrote:
> Hi,
>=20
> Maxime Ripard <maxime@cerno.tech> =E4=BA=8E2021=E5=B9=B46=E6=9C=8816=E6=
=97=A5=E5=91=A8=E4=B8=89 =E4=B8=8B=E5=8D=884:49=E5=86=99=E9=81=93=EF=BC=9A
> >
> > Hi,
> >
> > On Tue, Jun 15, 2021 at 09:07:37PM +0800, Ban Tao wrote:
> > > The Allwinner SoCs feature an I2S controller across multiple SoC
> > > generations.
> >
> > Which SoC generations?
> >
> > > Signed-off-by: Ban Tao <fengzheng923@gmail.com>
> > > ---
> > >  .../sound/allwinner,sun50i-h6-dmic.yaml       | 66 +++++++++++++++++=
++
> > >  1 file changed, 66 insertions(+)
> > >  create mode 100644 Documentation/devicetree/bindings/sound/allwinner=
,sun50i-h6-dmic.yaml
> > >
> > > diff --git a/Documentation/devicetree/bindings/sound/allwinner,sun50i=
-h6-dmic.yaml b/Documentation/devicetree/bindings/sound/allwinner,sun50i-h6=
-dmic.yaml
> > > new file mode 100644
> > > index 000000000000..81d40c374e44
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/sound/allwinner,sun50i-h6-dmi=
c.yaml
> > > @@ -0,0 +1,66 @@
> > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > > +%YAML 1.2
> > > +---
> > > +$id: http://devicetree.org/schemas/sound/allwinner,sun50i-h6-dmic.ya=
ml#
> > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > +
> > > +title: Allwinner H6 DMIC Controller Device Tree Bindings
> > > +
> > > +maintainers:
> > > +  - Ban Tao <fengzheng923@gmail.com>
> > > +
> > > +properties:
> > > +  "#sound-dai-cells":
> > > +    const: 0
> > > +
> > > +  compatible:
> > > +    const: allwinner,sun50i-h6-dmic
> > > +
> > > +  reg:
> > > +    maxItems: 1
> > > +
> > > +  clocks:
> > > +    items:
> > > +      - description: Bus Clock
> > > +      - description: Module Clock
> > > +
> > > +  clock-names:
> > > +    items:
> > > +      - const: apb
> > > +      - const: dmic
> >
> > The convention we use is bus and mod
> >
> > > +
> > > +  dmas:
> > > +    maxItems: 1
> > > +
> > > +  dma-names:
> > > +    const: rx
> > > +
> > > +  resets:
> > > +    maxItems: 1
> > > +
> > > +required:
> > > +  - "#sound-dai-cells"
> > > +  - compatible
> > > +  - reg
> > > +  - clocks
> > > +  - clock-names
> > > +  - dmas
> > > +  - dma-names
> > > +  - resets
> > > +
> > > +additionalProperties: false
> > > +
> > > +examples:
> > > +  - |
> > > +    spdif: spdif@5095000 {
> >
> > The label and node name seems wrong?
> >
> Yes, in fact, I don=E2=80=99t know much about yaml format files.
> The allwinner,sun50i-h6-dmic.yaml file is based on
> allwinner,sun4i-a10-spdif.yaml.
>
> So, How do i convert txt file to yaml file, for example:
> ---------------------------------------------
> Required properties:
>=20
>   - compatible         : should be one of the following:
>     - "allwinner,sun50i-h6-dmic": for the Allwinner H6 SoC
>=20
>   - reg                        : physical base address of the
> controller and length of memory mapped region.
>=20
>   - dmas               : Generic dma devicetree binding as described in
>                          Documentation/devicetree/bindings/dma/dma.txt.
>=20
>   - dma-names          : DMA have to be defined, "rx".
>=20
>   - clocks             : Contains an entry for each entry in clock-names.
>=20
>   - clock-names                : Includes the following entries:
>        "apb"             clock for the dmic bus.
>        "dmic"           clock for dmic controller.
>=20
>   - resets             : reset specifier for the ahb reset
>=20
> Example:
>=20
> dmic: dmic@5095000 {
>         #sound-dai-cells =3D <0>;
>         compatible =3D "allwinner,sun50i-h6-dmic";
>         reg =3D <0x05095000 0x400>;
>         clocks =3D <&ccu CLK_BUS_DMIC>, <&ccu CLK_DMIC>;
>         clock-names =3D "apb", "dmic";
>         dmas =3D <&dma 7>;
>         dma-names =3D "rx";
>         resets =3D <&ccu RST_BUS_DMIC>;
> };
> ---------------------------------------------

Just like you already did :)

Aside from the few comments, what you did is spot on. Just remember to
run make dt_binding_check after you wrote your schema

Maxime

--hi7zosja6vhzuga5
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iHUEABYIAB0WIQRcEzekXsqa64kGDp7j7w1vZxhRxQUCYMnw3gAKCRDj7w1vZxhR
xa8zAP9aN57ypYMSpS8opiH1Ou8RZBFJXFHjtm70c9SstASQUwD/TH9k2r8KZW88
mj/U7b8kdsCLrj8AkyMev6jhXIG3PgI=
=tDFN
-----END PGP SIGNATURE-----

--hi7zosja6vhzuga5--