Re: [PATCH v3 1/2] ASoC: da7218: Add bindings documentation for DA7218 audio codec

From	Rob Herring <robh@kernel.org>
Newsgroups	linux.kernel
Subject	Re: [PATCH v3 1/2] ASoC: da7218: Add bindings documentation for DA7218 audio codec
Date	2015-11-20 17:00 +0100
Message-ID	<qwWgp-IS-11@gated-at.bofh.it> (permalink)
References	<qwy4q-1Ur-5@gated-at.bofh.it> <qwy4q-1Ur-3@gated-at.bofh.it>
Organization	linux.* mail to news gateway

Show all headers | View raw

On Thu, Nov 19, 2015 at 01:59:34PM +0000, Adam Thomson wrote:
> Signed-off-by: Adam Thomson <Adam.Thomson.Opensource@diasemi.com>
> ---
>  Documentation/devicetree/bindings/sound/da7218.txt | 104 +++++++++++++++++++++
>  1 file changed, 104 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/da7218.txt
> 
> diff --git a/Documentation/devicetree/bindings/sound/da7218.txt b/Documentation/devicetree/bindings/sound/da7218.txt
> new file mode 100644
> index 0000000..18f8f09
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/da7218.txt
> @@ -0,0 +1,104 @@
> +Dialog Semiconductor DA7218 Audio Codec bindings
> +
> +DA7218 is an audio codec with HP detect feature.
> +
> +======
> +
> +Required properties:
> +- compatible : Should be "dlg,da7217" or "dlg,da7218"
> +- reg: Specifies the I2C slave address
> +
> +- VDD-supply: VDD power supply for the device
> +- VDDMIC-supply: VDDMIC power supply for the device
> +- VDDIO-supply: VDDIO power supply for the device

These should be lower case (that is documented in ePAPR BTW :)).

> +  (See Documentation/devicetree/bindings/regulator/regulator.txt for further
> +   information relating to regulators)
> +
> +Optional properties:
> +- interrupt-parent: Specifies the phandle of the interrupt controller to which
> +  the IRQs from DA7218 are delivered to.
> +- interrupts: IRQ line info for DA7218 chip.
> +  (See Documentation/devicetree/bindings/interrupt-controller/interrupts.txt for
> +   further information relating to interrupt properties)
> +- interrupt-names : Name associated with interrupt line. Should be "wakeup" if
> +  interrupt is to be used to wake system, otherwise "irq" should be used.
> +- wakeup-source: Flag to indicate this device can wake system (suspend/resume).
> +
> +- clocks : phandle and clock specifier for codec MCLK.
> +- clock-names : Clock name string for 'clocks' attribute, should be "mclk".
> +
> +- dlg,micbias1-lvl-millivolt : Voltage (mV) for Mic Bias 1
> +	[<1200>, <1600>, <1800>, <2000>, <2200>, <2400>, <2600>, <2800>, <3000>]
> +- dlg,micbias2-lvl-millivolt : Voltage (mV) for Mic Bias 2
> +	[<1200>, <1600>, <1800>, <2000>, <2200>, <2400>, <2600>, <2800>, <3000>]
> +- dlg,mic1-amp-in-sel : Mic1 input source type
> +	["diff", "se_p", "se_n"]
> +- dlg,mic2-amp-in-sel : Mic2 input source type
> +	["diff", "se_p", "se_n"]
> +- dlg,dmic1-data-sel : DMIC1 channel select based on clock edge.
> +	["lrise_rfall", "lfall_rrise"]
> +- dlg,dmic1-samplephase : When to sample audio from DMIC1.
> +	["on_clkedge", "between_clkedge"]
> +- dlg,dmic1-clkrate-hertz : DMic1 clock frequency (Hz).

-hz

Documenting the unit suffixes is on my todo list...

> +	[<1500000>, <3000000>]
> +- dlg,dmic2-data-sel : DMic2 channel select based on clock edge.
> +	["lrise_rfall", "lfall_rrise"]
> +- dlg,dmic2-samplephase : When to sample audio from DMic2.
> +	["on_clkedge", "between_clkedge"]
> +- dlg,dmic2-clkrate-hertz : DMic2 clock frequency (Hz).

-hz

> +	[<1500000>, <3000000>]
> +- dlg,hp-diff-single-supply : Boolean flag, use single supply for HP
> +			      (DA7217 only)
> +
> +======
> +
> +Optional Child node - 'da7218_hpldet' (DA7218 only):
> +
> +Optional properties:
> +- dlg,jack-rate-microsecond : Time between jack detect measurements (us)

-us

Completely consistent, isn't it. Why we did -microvolt I don't know.

Rob

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

Thread

[PATCH v3 1/2] ASoC: da7218: Add bindings documentation for DA7218 audio  codec Adam Thomson <Adam.Thomson.Opensource@diasemi.com> - 2015-11-19 15:10 +0100
  Re: [PATCH v3 1/2] ASoC: da7218: Add bindings documentation for  DA7218 audio codec Rob Herring <robh@kernel.org> - 2015-11-20 17:00 +0100
    Re: [PATCH v3 1/2] ASoC: da7218: Add bindings documentation for  DA7218 audio codec Mark Brown <broonie@kernel.org> - 2015-11-21 14:00 +0100
    RE: [PATCH v3 1/2] ASoC: da7218: Add bindings documentation for  DA7218 audio codec "Opensource [Adam Thomson]" <Adam.Thomson.Opensource@diasemi.com> - 2015-11-23 13:00 +0100

csiph-web