diff mbox

[RESEND,v2,2/2] ASoC: atmel-classd: DT binding for PDMIC driver

Message ID 1450345800-21299-3-git-send-email-songjun.wu@atmel.com (mailing list archive)
State New, archived
Headers show

Commit Message

Songjun Wu Dec. 17, 2015, 9:50 a.m. UTC
DT binding documentation for this new ASoC driver.

Signed-off-by: Songjun Wu <songjun.wu@atmel.com>
---

Changes in v2: None

 .../devicetree/bindings/sound/atmel-pdmic.txt      |   55 ++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/atmel-pdmic.txt

Comments

Rob Herring (Arm) Dec. 19, 2015, 4:17 a.m. UTC | #1
On Thu, Dec 17, 2015 at 05:50:00PM +0800, Songjun Wu wrote:
> DT binding documentation for this new ASoC driver.
> 
> Signed-off-by: Songjun Wu <songjun.wu@atmel.com>
> ---
> 
> Changes in v2: None
> 
>  .../devicetree/bindings/sound/atmel-pdmic.txt      |   55 ++++++++++++++++++++
>  1 file changed, 55 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/atmel-pdmic.txt
> 
> diff --git a/Documentation/devicetree/bindings/sound/atmel-pdmic.txt b/Documentation/devicetree/bindings/sound/atmel-pdmic.txt
> new file mode 100644
> index 0000000..e0875f1
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/atmel-pdmic.txt
> @@ -0,0 +1,55 @@
> +* Atmel PDMIC driver under ALSA SoC architecture
> +
> +Required properties:
> +- compatible
> +	Should be "atmel,sama5d2-pdmic".
> +- reg
> +	Should contain PDMIC registers location and length.
> +- interrupts
> +	Should contain the IRQ line for the PDMIC.
> +- dmas
> +	One DMA specifiers as described in atmel-dma.txt and dma.txt files.
> +- dma-names
> +	Must be "rx".
> +- clock-names
> +	Required elements:
> +	- "pclk"	peripheral clock
> +	- "gclk"	generated clock
> +- clocks
> +	Must contain an entry for each required entry in clock-names.
> +	Please refer to clock-bindings.txt.
> +- atmel,mic-min-freq
> +	The minimal frequency that the micphone supports.
> +- atmel,mic-max-freq
> +	The maximal frequency that the micphone supports.

Please append units to these 2 (-hz).

 
> +Optional properties:
> +- pinctrl-names, pinctrl-0
> +	Please refer to pinctrl-bindings.txt.
> +- atmel,model
> +	The user-visible name of this sound card.
> +	The default value is "PDMIC".

When and why would this be different than the default?

"label" can be used here if this is really needed.

> +- atmel,mic-offset
> +	The offset that should be added.
> +	The range is from -32768 to 32767.
> +	The default value is 0.
> +
> +Example:
> +	pdmic@f8018000 {
> +				compatible = "atmel,sama5d2-pdmic";
> +				reg = <0xf8018000 0x124>;
> +				interrupts = <48 IRQ_TYPE_LEVEL_HIGH 7>;
> +				dmas = <&dma0
> +					(AT91_XDMAC_DT_MEM_IF(0) | AT91_XDMAC_DT_PER_IF(1)
> +					| AT91_XDMAC_DT_PERID(50))>;
> +				dma-names = "rx";
> +				clocks = <&pdmic_clk>, <&pdmic_gclk>;
> +				clock-names = "pclk", "gclk";
> +
> +				pinctrl-names = "default";
> +				pinctrl-0 = <&pinctrl_pdmic_default>;
> +				atmel,model = "PDMIC @ sama5d2_xplained";
> +				atmel,mic-min-freq = <1000000>;
> +				atmel,mic-max-freq = <3246000>;
> +				atmel,mic-offset = <0x0>;
> +	};
> -- 
> 1.7.9.5
>
Mark Brown Dec. 19, 2015, 11:30 a.m. UTC | #2
On Fri, Dec 18, 2015 at 01:56:21PM -0600, Rob Herring wrote:
> On Thu, Dec 17, 2015 at 05:50:00PM +0800, Songjun Wu wrote:

> > +- atmel,model
> > +	The user-visible name of this sound card.
> > +	The default value is "PDMIC".

> When and why would this be different than the default?

> "label" can be used here if this is really needed.

The plastics for the system are often very important for audio
configuration - we need userspace to be able to distinguish between
systems that are identical even on the electrical level.
Rob Herring (Arm) Dec. 22, 2015, 6:37 p.m. UTC | #3
On Sat, Dec 19, 2015 at 5:30 AM, Mark Brown <broonie@kernel.org> wrote:
> On Fri, Dec 18, 2015 at 01:56:21PM -0600, Rob Herring wrote:
>> On Thu, Dec 17, 2015 at 05:50:00PM +0800, Songjun Wu wrote:
>
>> > +- atmel,model
>> > +   The user-visible name of this sound card.
>> > +   The default value is "PDMIC".
>
>> When and why would this be different than the default?
>
>> "label" can be used here if this is really needed.
>
> The plastics for the system are often very important for audio
> configuration - we need userspace to be able to distinguish between
> systems that are identical even on the electrical level.

Okay. That is exactly what label is for, so please use it.

Rob
Mark Brown Dec. 22, 2015, 11:49 p.m. UTC | #4
On Tue, Dec 22, 2015 at 12:37:24PM -0600, Rob Herring wrote:
> On Sat, Dec 19, 2015 at 5:30 AM, Mark Brown <broonie@kernel.org> wrote:

> >> "label" can be used here if this is really needed.

> > The plastics for the system are often very important for audio
> > configuration - we need userspace to be able to distinguish between
> > systems that are identical even on the electrical level.

> Okay. That is exactly what label is for, so please use it.

Can you send fixes for this please?  There's rather a lot of existing
bindings using the current scheme, together with some subsystem code to
help parse them.
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/sound/atmel-pdmic.txt b/Documentation/devicetree/bindings/sound/atmel-pdmic.txt
new file mode 100644
index 0000000..e0875f1
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/atmel-pdmic.txt
@@ -0,0 +1,55 @@ 
+* Atmel PDMIC driver under ALSA SoC architecture
+
+Required properties:
+- compatible
+	Should be "atmel,sama5d2-pdmic".
+- reg
+	Should contain PDMIC registers location and length.
+- interrupts
+	Should contain the IRQ line for the PDMIC.
+- dmas
+	One DMA specifiers as described in atmel-dma.txt and dma.txt files.
+- dma-names
+	Must be "rx".
+- clock-names
+	Required elements:
+	- "pclk"	peripheral clock
+	- "gclk"	generated clock
+- clocks
+	Must contain an entry for each required entry in clock-names.
+	Please refer to clock-bindings.txt.
+- atmel,mic-min-freq
+	The minimal frequency that the micphone supports.
+- atmel,mic-max-freq
+	The maximal frequency that the micphone supports.
+
+Optional properties:
+- pinctrl-names, pinctrl-0
+	Please refer to pinctrl-bindings.txt.
+- atmel,model
+	The user-visible name of this sound card.
+	The default value is "PDMIC".
+- atmel,mic-offset
+	The offset that should be added.
+	The range is from -32768 to 32767.
+	The default value is 0.
+
+Example:
+	pdmic@f8018000 {
+				compatible = "atmel,sama5d2-pdmic";
+				reg = <0xf8018000 0x124>;
+				interrupts = <48 IRQ_TYPE_LEVEL_HIGH 7>;
+				dmas = <&dma0
+					(AT91_XDMAC_DT_MEM_IF(0) | AT91_XDMAC_DT_PER_IF(1)
+					| AT91_XDMAC_DT_PERID(50))>;
+				dma-names = "rx";
+				clocks = <&pdmic_clk>, <&pdmic_gclk>;
+				clock-names = "pclk", "gclk";
+
+				pinctrl-names = "default";
+				pinctrl-0 = <&pinctrl_pdmic_default>;
+				atmel,model = "PDMIC @ sama5d2_xplained";
+				atmel,mic-min-freq = <1000000>;
+				atmel,mic-max-freq = <3246000>;
+				atmel,mic-offset = <0x0>;
+	};