| Message ID | 20191010074234.7344-2-nuno.sa@analog.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 969d49b2cdc88c07b351df59013a172b55056297 |
| Headers | show |
| Series | [v3,1/2] ASOC: Add ADAU7118 8 Channel PDM-to-I2S/TDM Converter driver | expand |
On Thu, Oct 10, 2019 at 09:42:34AM +0200, Nuno Sá wrote: > Document the ADAU7118 8 channel PDM to I2S/TDM converter devicetree > bindings. > > Signed-off-by: Nuno Sá <nuno.sa@analog.com> > --- > Changes in v2: > * List regulators as required; > > Changes in v3: > * Set the correct license for new bindings. > > .../bindings/sound/adi,adau7118.yaml | 90 +++++++++++++++++++ > 1 file changed, 90 insertions(+) > create mode 100644 Documentation/devicetree/bindings/sound/adi,adau7118.yaml > > diff --git a/Documentation/devicetree/bindings/sound/adi,adau7118.yaml b/Documentation/devicetree/bindings/sound/adi,adau7118.yaml > new file mode 100644 > index 000000000000..cfcef602b3d9 > --- /dev/null > +++ b/Documentation/devicetree/bindings/sound/adi,adau7118.yaml > @@ -0,0 +1,90 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/sound/adi,adau7118.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > + > +title: Analog Devices ADAU7118 8 Channel PDM to I2S/TDM Converter > + > +maintainers: > + - Nuno Sá <nuno.sa@analog.com> > + > +description: | > + Analog Devices ADAU7118 8 Channel PDM to I2S/TDM Converter over I2C or HW > + standalone mode. > + https://www.analog.com/media/en/technical-documentation/data-sheets/ADAU7118.pdf > + > +properties: > + compatible: > + enum: > + - adi,adau7118 > + > + reg: > + maxItems: 1 > + > + "#sound-dai-cells": > + const: 0 > + > + IOVDD-supply: Use lowercase please. > + description: Digital Input/Output Power Supply. > + $ref: "/schemas/types.yaml#/definitions/phandle" *-supply already has a type, so just a description is enough. > + > + DVDD-supply: > + description: Internal Core Digital Power Supply. > + $ref: "/schemas/types.yaml#/definitions/phandle" Same here. > + > + adi,decimation-ratio: > + description: | > + This property set's the decimation ratio of PDM to PCM audio data. > + allOf: > + - $ref: /schemas/types.yaml#/definitions/uint32 > + - enum: [64, 32, 16] > + default: 64 > + > + adi,pdm-clk-map: > + description: | > + The ADAU7118 has two PDM clocks for the four Inputs. Each input must be > + assigned to one of these two clocks. This property set's the mapping > + between the clocks and the inputs. > + allOf: > + - $ref: /schemas/types.yaml#/definitions/uint32-array > + - minItems: 4 > + maxItems: 4 > + items: > + maximum: 1 > + default: [0, 0, 1, 1] > + > +required: > + - "#sound-dai-cells" > + - compatible > + - IOVDD-supply > + - DVDD-supply > + > +examples: > + - | > + i2c0 { i2c { > + /* example with i2c support */ > + #address-cells = <1>; > + #size-cells = <0>; > + status = "okay"; Don't show status in examples. > + adau7118_codec: adau7118-codec@14 { audio-codec@14 > + compatible = "adi,adau7118"; > + reg = <14>; > + #sound-dai-cells = <0>; > + status = "okay"; > + IOVDD-supply = <&supply>; > + DVDD-supply = <&supply>; > + adi,pdm-clk-map = <1 1 0 0>; > + adi,decimation-ratio = <16>; > + }; > + }; > + > + /* example with hw standalone mode */ > + adau7118_codec_hw: adau7118-codec-hw { > + compatible = "adi,adau7118"; > + #sound-dai-cells = <0>; > + status = "okay"; > + IOVDD-supply = <&supply>; > + DVDD-supply = <&supply>; > + }; > -- > 2.23.0 >
On Thu, Oct 10, 2019 at 4:08 PM Rob Herring <robh@kernel.org> wrote: > > On Thu, Oct 10, 2019 at 09:42:34AM +0200, Nuno Sá wrote: > > Document the ADAU7118 8 channel PDM to I2S/TDM converter devicetree > > bindings. > > > > Signed-off-by: Nuno Sá <nuno.sa@analog.com> > > --- > > Changes in v2: > > * List regulators as required; > > > > Changes in v3: > > * Set the correct license for new bindings. > > > > .../bindings/sound/adi,adau7118.yaml | 90 +++++++++++++++++++ > > 1 file changed, 90 insertions(+) > > create mode 100644 Documentation/devicetree/bindings/sound/adi,adau7118.yaml Looks like Mark already applied this. Please send a follow-up patch addressing my comments. > > > > diff --git a/Documentation/devicetree/bindings/sound/adi,adau7118.yaml b/Documentation/devicetree/bindings/sound/adi,adau7118.yaml > > new file mode 100644 > > index 000000000000..cfcef602b3d9 > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/sound/adi,adau7118.yaml > > @@ -0,0 +1,90 @@ > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/sound/adi,adau7118.yaml# > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > + > > +title: Analog Devices ADAU7118 8 Channel PDM to I2S/TDM Converter > > + > > +maintainers: > > + - Nuno Sá <nuno.sa@analog.com> > > + > > +description: | > > + Analog Devices ADAU7118 8 Channel PDM to I2S/TDM Converter over I2C or HW > > + standalone mode. > > + https://www.analog.com/media/en/technical-documentation/data-sheets/ADAU7118.pdf > > + > > +properties: > > + compatible: > > + enum: > > + - adi,adau7118 > > + > > + reg: > > + maxItems: 1 > > + > > + "#sound-dai-cells": > > + const: 0 > > + > > + IOVDD-supply: > > Use lowercase please. > > > + description: Digital Input/Output Power Supply. > > + $ref: "/schemas/types.yaml#/definitions/phandle" > > *-supply already has a type, so just a description is enough. > > > + > > + DVDD-supply: > > + description: Internal Core Digital Power Supply. > > + $ref: "/schemas/types.yaml#/definitions/phandle" > > Same here. > > > + > > + adi,decimation-ratio: > > + description: | > > + This property set's the decimation ratio of PDM to PCM audio data. > > + allOf: > > + - $ref: /schemas/types.yaml#/definitions/uint32 > > + - enum: [64, 32, 16] > > + default: 64 > > + > > + adi,pdm-clk-map: > > + description: | > > + The ADAU7118 has two PDM clocks for the four Inputs. Each input must be > > + assigned to one of these two clocks. This property set's the mapping > > + between the clocks and the inputs. > > + allOf: > > + - $ref: /schemas/types.yaml#/definitions/uint32-array > > + - minItems: 4 > > + maxItems: 4 > > + items: > > + maximum: 1 > > + default: [0, 0, 1, 1] > > + > > +required: > > + - "#sound-dai-cells" > > + - compatible > > + - IOVDD-supply > > + - DVDD-supply > > + > > +examples: > > + - | > > + i2c0 { > > i2c { > > > + /* example with i2c support */ > > + #address-cells = <1>; > > + #size-cells = <0>; > > + status = "okay"; > > Don't show status in examples. > > > + adau7118_codec: adau7118-codec@14 { > > audio-codec@14 > > > + compatible = "adi,adau7118"; > > + reg = <14>; > > + #sound-dai-cells = <0>; > > + status = "okay"; > > + IOVDD-supply = <&supply>; > > + DVDD-supply = <&supply>; > > + adi,pdm-clk-map = <1 1 0 0>; > > + adi,decimation-ratio = <16>; > > + }; > > + }; > > + > > + /* example with hw standalone mode */ > > + adau7118_codec_hw: adau7118-codec-hw { > > + compatible = "adi,adau7118"; > > + #sound-dai-cells = <0>; > > + status = "okay"; > > + IOVDD-supply = <&supply>; > > + DVDD-supply = <&supply>; > > + }; > > -- > > 2.23.0 > >
diff --git a/Documentation/devicetree/bindings/sound/adi,adau7118.yaml b/Documentation/devicetree/bindings/sound/adi,adau7118.yaml new file mode 100644 index 000000000000..cfcef602b3d9 --- /dev/null +++ b/Documentation/devicetree/bindings/sound/adi,adau7118.yaml @@ -0,0 +1,90 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/sound/adi,adau7118.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + + +title: Analog Devices ADAU7118 8 Channel PDM to I2S/TDM Converter + +maintainers: + - Nuno Sá <nuno.sa@analog.com> + +description: | + Analog Devices ADAU7118 8 Channel PDM to I2S/TDM Converter over I2C or HW + standalone mode. + https://www.analog.com/media/en/technical-documentation/data-sheets/ADAU7118.pdf + +properties: + compatible: + enum: + - adi,adau7118 + + reg: + maxItems: 1 + + "#sound-dai-cells": + const: 0 + + IOVDD-supply: + description: Digital Input/Output Power Supply. + $ref: "/schemas/types.yaml#/definitions/phandle" + + DVDD-supply: + description: Internal Core Digital Power Supply. + $ref: "/schemas/types.yaml#/definitions/phandle" + + adi,decimation-ratio: + description: | + This property set's the decimation ratio of PDM to PCM audio data. + allOf: + - $ref: /schemas/types.yaml#/definitions/uint32 + - enum: [64, 32, 16] + default: 64 + + adi,pdm-clk-map: + description: | + The ADAU7118 has two PDM clocks for the four Inputs. Each input must be + assigned to one of these two clocks. This property set's the mapping + between the clocks and the inputs. + allOf: + - $ref: /schemas/types.yaml#/definitions/uint32-array + - minItems: 4 + maxItems: 4 + items: + maximum: 1 + default: [0, 0, 1, 1] + +required: + - "#sound-dai-cells" + - compatible + - IOVDD-supply + - DVDD-supply + +examples: + - | + i2c0 { + /* example with i2c support */ + #address-cells = <1>; + #size-cells = <0>; + status = "okay"; + adau7118_codec: adau7118-codec@14 { + compatible = "adi,adau7118"; + reg = <14>; + #sound-dai-cells = <0>; + status = "okay"; + IOVDD-supply = <&supply>; + DVDD-supply = <&supply>; + adi,pdm-clk-map = <1 1 0 0>; + adi,decimation-ratio = <16>; + }; + }; + + /* example with hw standalone mode */ + adau7118_codec_hw: adau7118-codec-hw { + compatible = "adi,adau7118"; + #sound-dai-cells = <0>; + status = "okay"; + IOVDD-supply = <&supply>; + DVDD-supply = <&supply>; + };
Document the ADAU7118 8 channel PDM to I2S/TDM converter devicetree bindings. Signed-off-by: Nuno Sá <nuno.sa@analog.com> --- Changes in v2: * List regulators as required; Changes in v3: * Set the correct license for new bindings. .../bindings/sound/adi,adau7118.yaml | 90 +++++++++++++++++++ 1 file changed, 90 insertions(+) create mode 100644 Documentation/devicetree/bindings/sound/adi,adau7118.yaml