Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1241489 > unrolled thread

[PATCH v2 3/3] ASoC: da7213: Add bindings documentation for codec driver

Started byAdam Thomson <Adam.Thomson.Opensource@diasemi.com>
First post2015-10-07 15:30 +0200
Last post2015-10-08 18:40 +0200
Articles 5 — 4 participants

Back to article view | Back to linux.kernel

This discussion starts older than the indexed window; earlier articles aren't shown. The article labeled Started by below is the oldest one visible, not the original post.

Contents

  [PATCH v2 3/3] ASoC: da7213: Add bindings documentation for codec driver Adam Thomson <Adam.Thomson.Opensource@diasemi.com> - 2015-10-07 15:30 +0200
    Re: [PATCH v2 3/3] ASoC: da7213: Add bindings documentation for codec driver Rob Herring <robherring2@gmail.com> - 2015-10-07 18:30 +0200
      RE: [PATCH v2 3/3] ASoC: da7213: Add bindings documentation for  codec driver "Opensource [Adam Thomson]" <Adam.Thomson.Opensource@diasemi.com> - 2015-10-08 10:50 +0200
        Re: [PATCH v2 3/3] ASoC: da7213: Add bindings documentation for codec driver Rob Herring <robh@kernel.org> - 2015-10-08 15:20 +0200
          RE: [PATCH v2 3/3] ASoC: da7213: Add bindings documentation for  codec driver "Opensource [Adam Thomson]" <Adam.Thomson.Opensource@diasemi.com> - 2015-10-08 18:40 +0200

#1241489 — [PATCH v2 3/3] ASoC: da7213: Add bindings documentation for codec driver

FromAdam Thomson <Adam.Thomson.Opensource@diasemi.com>
Date2015-10-07 15:30 +0200
Subject[PATCH v2 3/3] ASoC: da7213: Add bindings documentation for codec driver
Message-ID<qgWX9-65g-37@gated-at.bofh.it>
Signed-off-by: Adam Thomson <Adam.Thomson.Opensource@diasemi.com>
---
 Documentation/devicetree/bindings/sound/da7213.txt | 41 ++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/da7213.txt

diff --git a/Documentation/devicetree/bindings/sound/da7213.txt b/Documentation/devicetree/bindings/sound/da7213.txt
new file mode 100644
index 0000000..7280e82
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/da7213.txt
@@ -0,0 +1,41 @@
+Dialog Semiconductor DA7213 Audio Codec bindings
+
+======
+
+Required properties:
+- compatible : Should be "dlg,da7213"
+- reg: Specifies the I2C slave address
+
+Optional properties:
+- clocks : phandle and clock specifier for codec MCLK.
+- clock-names : Clock name string for 'clocks' attribute, should be "mclk".
+
+- dlg,micbias1-lvl : Voltage (mV) for Mic Bias 1
+	[<1600>, <2200>, <2500>, <3000>]
+- dlg,micbias2-lvl : Voltage (mV) for Mic Bias 2
+	[<1600>, <2200>, <2500>, <3000>]
+- dlg,dmic-data-sel : DMIC channel select based on clock edge.
+	["lrise_rfall", "lfall_rrise"]
+- dlg,dmic-samplephase : When to sample audio from DMIC.
+	["on_clkedge", "between_clkedge"]
+- dlg,dmic-clkrate : DMIC clock frequency (MHz).
+	[<1500000>, <3000000>]
+
+======
+
+Example:
+
+	codec_i2c: da7213@1a {
+		compatible = "dlg,da7213";
+ 		reg = <0x1a>;
+
+ 		clocks = <&clks 201>;
+		clock-names = "mclk";
+
+		dlg,micbias1-lvl = <2500>;
+		dlg,micbias2-lvl = <2500>;
+
+		dlg,dmic-data-sel = "lrise_rfall";
+		dlg,dmic-samplephase = "between_clkedge";
+		dlg,dmic-clkrate = <3000000>;
+	};
--
1.9.3

--
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/

[toc] | [next] | [standalone]

#1241661

FromRob Herring <robherring2@gmail.com>
Date2015-10-07 18:30 +0200
Message-ID<qgZLk-1IJ-21@gated-at.bofh.it>
In reply to#1241489
On Wed, Oct 7, 2015 at 8:27 AM, Adam Thomson
<Adam.Thomson.Opensource@diasemi.com> wrote:
> Signed-off-by: Adam Thomson <Adam.Thomson.Opensource@diasemi.com>
> ---
>  Documentation/devicetree/bindings/sound/da7213.txt | 41 ++++++++++++++++++++++
>  1 file changed, 41 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/da7213.txt
>
> diff --git a/Documentation/devicetree/bindings/sound/da7213.txt b/Documentation/devicetree/bindings/sound/da7213.txt
> new file mode 100644
> index 0000000..7280e82
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/da7213.txt
> @@ -0,0 +1,41 @@
> +Dialog Semiconductor DA7213 Audio Codec bindings
> +
> +======
> +
> +Required properties:
> +- compatible : Should be "dlg,da7213"
> +- reg: Specifies the I2C slave address
> +
> +Optional properties:
> +- clocks : phandle and clock specifier for codec MCLK.
> +- clock-names : Clock name string for 'clocks' attribute, should be "mclk".
> +
> +- dlg,micbias1-lvl : Voltage (mV) for Mic Bias 1
> +       [<1600>, <2200>, <2500>, <3000>]
> +- dlg,micbias2-lvl : Voltage (mV) for Mic Bias 2
> +       [<1600>, <2200>, <2500>, <3000>]

Please append the units (-microvolt).

> +- dlg,dmic-data-sel : DMIC channel select based on clock edge.
> +       ["lrise_rfall", "lfall_rrise"]
> +- dlg,dmic-samplephase : When to sample audio from DMIC.
> +       ["on_clkedge", "between_clkedge"]

How about boolean for these two.

> +- dlg,dmic-clkrate : DMIC clock frequency (MHz).
> +       [<1500000>, <3000000>]

So 1.5GHz or 3GHz?

Add units (-hz).

> +
> +======
> +
> +Example:
> +
> +       codec_i2c: da7213@1a {
> +               compatible = "dlg,da7213";
> +               reg = <0x1a>;
> +
> +               clocks = <&clks 201>;
> +               clock-names = "mclk";
> +
> +               dlg,micbias1-lvl = <2500>;
> +               dlg,micbias2-lvl = <2500>;
> +
> +               dlg,dmic-data-sel = "lrise_rfall";
> +               dlg,dmic-samplephase = "between_clkedge";
> +               dlg,dmic-clkrate = <3000000>;
> +       };
> --
> 1.9.3
>
--
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/

[toc] | [prev] | [next] | [standalone]

#1242078 — RE: [PATCH v2 3/3] ASoC: da7213: Add bindings documentation for codec driver

From"Opensource [Adam Thomson]" <Adam.Thomson.Opensource@diasemi.com>
Date2015-10-08 10:50 +0200
SubjectRE: [PATCH v2 3/3] ASoC: da7213: Add bindings documentation for codec driver
Message-ID<qhf3I-6MG-5@gated-at.bofh.it>
In reply to#1241661
T24gT2N0b2JlciAwNywgMjAxNSAxNzoyMiwgUm9iIEhlcnJpbmcgd3JvdGU6DQoNCj4gPiArLSBk
bGcsbWljYmlhczEtbHZsIDogVm9sdGFnZSAobVYpIGZvciBNaWMgQmlhcyAxDQo+ID4gKyAgICAg
ICBbPDE2MDA+LCA8MjIwMD4sIDwyNTAwPiwgPDMwMDA+XQ0KPiA+ICstIGRsZyxtaWNiaWFzMi1s
dmwgOiBWb2x0YWdlIChtVikgZm9yIE1pYyBCaWFzIDINCj4gPiArICAgICAgIFs8MTYwMD4sIDwy
MjAwPiwgPDI1MDA+LCA8MzAwMD5dDQo+IA0KPiBQbGVhc2UgYXBwZW5kIHRoZSB1bml0cyAoLW1p
Y3Jvdm9sdCkuDQoNCkdpdmVuIHRoYXQgYSB1c2VyIG5lZWRzIHRvIHJlYWQgdGhlIGJpbmRpbmdz
IGRvY3VtZW50IHRvIHVuZGVyc3RhbmQgd2hhdCBpcw0KYXZhaWxhYmxlLCBhbmQgd2hhdCB0aGV5
J3JlIGZvciwgdGhpcyBzZWVtcyBhIGxpdHRsZSB1bm5lY2Vzc2FyeS4gDQoNCj4gDQo+ID4gKy0g
ZGxnLGRtaWMtZGF0YS1zZWwgOiBETUlDIGNoYW5uZWwgc2VsZWN0IGJhc2VkIG9uIGNsb2NrIGVk
Z2UuDQo+ID4gKyAgICAgICBbImxyaXNlX3JmYWxsIiwgImxmYWxsX3JyaXNlIl0NCj4gPiArLSBk
bGcsZG1pYy1zYW1wbGVwaGFzZSA6IFdoZW4gdG8gc2FtcGxlIGF1ZGlvIGZyb20gRE1JQy4NCj4g
PiArICAgICAgIFsib25fY2xrZWRnZSIsICJiZXR3ZWVuX2Nsa2VkZ2UiXQ0KPiANCj4gSG93IGFi
b3V0IGJvb2xlYW4gZm9yIHRoZXNlIHR3by4NCg0KV2FudGVkIHRoZXNlIHRvIGJlIGV4cGxpY2l0
LCBoZW5jZSBub3QgY2hvb3NpbmcgYm9vbGVhbi4gV291bGQgcHJlZmVyIHRvIGtlZXANCnRoZW0g
YXMgaXMuDQoNCj4gDQo+ID4gKy0gZGxnLGRtaWMtY2xrcmF0ZSA6IERNSUMgY2xvY2sgZnJlcXVl
bmN5IChNSHopLg0KPiA+ICsgICAgICAgWzwxNTAwMDAwPiwgPDMwMDAwMDA+XQ0KPiANCj4gU28g
MS41R0h6IG9yIDNHSHo/DQo+IA0KPiBBZGQgdW5pdHMgKC1oeikuDQoNCkFncmVlZCwgdGhlIGRl
c2NyaXB0aW9uIG9mIE1IeiBpcyBtaXNsZWFkaW5nIHNvIHdpbGwgdXBkYXRlIHRvIEh6LiBUaGFu
a3MuDQpBZ2FpbiB0aG91Z2gsIEkgZG9uJ3Qgc2VlIHdoYXQgdGhlIHN1ZmZpeCBnaXZlcyB5b3Us
IGFuZCB3b3VsZCBwcmVmZXIgdG8gbGVhdmUNCnRoZSBiaW5kaW5nIGFzIGlzLg0K
--
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/

[toc] | [prev] | [next] | [standalone]

#1242332

FromRob Herring <robh@kernel.org>
Date2015-10-08 15:20 +0200
Message-ID<qhjgZ-4AF-5@gated-at.bofh.it>
In reply to#1242078
On Thu, Oct 8, 2015 at 3:42 AM, Opensource [Adam Thomson]
<Adam.Thomson.Opensource@diasemi.com> wrote:
> On October 07, 2015 17:22, Rob Herring wrote:
>
>> > +- dlg,micbias1-lvl : Voltage (mV) for Mic Bias 1
>> > +       [<1600>, <2200>, <2500>, <3000>]
>> > +- dlg,micbias2-lvl : Voltage (mV) for Mic Bias 2
>> > +       [<1600>, <2200>, <2500>, <3000>]
>>
>> Please append the units (-microvolt).
>
> Given that a user needs to read the bindings document to understand what is
> available, and what they're for, this seems a little unnecessary.

You may think so, but it is standard practice.

>>
>> > +- dlg,dmic-data-sel : DMIC channel select based on clock edge.
>> > +       ["lrise_rfall", "lfall_rrise"]
>> > +- dlg,dmic-samplephase : When to sample audio from DMIC.
>> > +       ["on_clkedge", "between_clkedge"]
>>
>> How about boolean for these two.
>
> Wanted these to be explicit, hence not choosing boolean. Would prefer to keep
> them as is.
>
>>
>> > +- dlg,dmic-clkrate : DMIC clock frequency (MHz).
>> > +       [<1500000>, <3000000>]
>>
>> So 1.5GHz or 3GHz?
>>
>> Add units (-hz).
>
> Agreed, the description of MHz is misleading so will update to Hz. Thanks.
> Again though, I don't see what the suffix gives you, and would prefer to leave
> the binding as is.

It tells someone reading the dts what the units are without having to
find the documentation and helps prevent people using properties with
differing units.

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/

[toc] | [prev] | [next] | [standalone]

#1242592 — RE: [PATCH v2 3/3] ASoC: da7213: Add bindings documentation for codec driver

From"Opensource [Adam Thomson]" <Adam.Thomson.Opensource@diasemi.com>
Date2015-10-08 18:40 +0200
SubjectRE: [PATCH v2 3/3] ASoC: da7213: Add bindings documentation for codec driver
Message-ID<qhmox-y3-13@gated-at.bofh.it>
In reply to#1242332
T24gT2N0b2JlciAwOCwgMjAxNSAxNDoxNiwgUm9iIEhlcnJpbmcgd3JvdGU6DQoNCj4gPj4gPiAr
LSBkbGcsbWljYmlhczEtbHZsIDogVm9sdGFnZSAobVYpIGZvciBNaWMgQmlhcyAxDQo+ID4+ID4g
KyAgICAgICBbPDE2MDA+LCA8MjIwMD4sIDwyNTAwPiwgPDMwMDA+XQ0KPiA+PiA+ICstIGRsZyxt
aWNiaWFzMi1sdmwgOiBWb2x0YWdlIChtVikgZm9yIE1pYyBCaWFzIDINCj4gPj4gPiArICAgICAg
IFs8MTYwMD4sIDwyMjAwPiwgPDI1MDA+LCA8MzAwMD5dDQo+ID4+DQo+ID4+IFBsZWFzZSBhcHBl
bmQgdGhlIHVuaXRzICgtbWljcm92b2x0KS4NCj4gPg0KPiA+IEdpdmVuIHRoYXQgYSB1c2VyIG5l
ZWRzIHRvIHJlYWQgdGhlIGJpbmRpbmdzIGRvY3VtZW50IHRvIHVuZGVyc3RhbmQgd2hhdCBpcw0K
PiA+IGF2YWlsYWJsZSwgYW5kIHdoYXQgdGhleSdyZSBmb3IsIHRoaXMgc2VlbXMgYSBsaXR0bGUg
dW5uZWNlc3NhcnkuDQo+IA0KPiBZb3UgbWF5IHRoaW5rIHNvLCBidXQgaXQgaXMgc3RhbmRhcmQg
cHJhY3RpY2UuDQogDQpJIGNhbiBmaW5kIGEgbnVtYmVyIG9mIHNpdHVhdGlvbnMgaW4gdGhlIGtl
cm5lbCwgd2hlcmUgdGhpcyBqdXN0IGlzbid0IGZvbGxvd2VkLA0KZm9yIGRldmljZSBzcGVjaWZp
YyBiaW5kaW5ncy4gV2hhdCBwZXJjZW50YWdlIGhhdmUgdG8gZm9sbG93IHRoaXMgZm9yIGl0IHRv
IGJlDQonc3RhbmRhcmQnPyBJcyB0aGlzIGRvY3VtZW50ZWQgc29tZXdoZXJlIHNvIGl0J3MgY2xl
YXIgZm9yIHRob3NlIHdyaXRpbmcNCmRyaXZlcnMgd2hpY2ggbmVlZCB0byB1c2UgRFQgYmluZGlu
Z3M/IEkgaGFkIGEgcXVpY2sgbG9vayBhbmQgY291bGRuJ3QgZmluZA0KYW55dGhpbmcgb24gdGhp
cy4NCg0KPiA+Pg0KPiA+PiA+ICstIGRsZyxkbWljLWNsa3JhdGUgOiBETUlDIGNsb2NrIGZyZXF1
ZW5jeSAoTUh6KS4NCj4gPj4gPiArICAgICAgIFs8MTUwMDAwMD4sIDwzMDAwMDAwPl0NCj4gPj4N
Cj4gPj4gU28gMS41R0h6IG9yIDNHSHo/DQo+ID4+DQo+ID4+IEFkZCB1bml0cyAoLWh6KS4NCj4g
Pg0KPiA+IEFncmVlZCwgdGhlIGRlc2NyaXB0aW9uIG9mIE1IeiBpcyBtaXNsZWFkaW5nIHNvIHdp
bGwgdXBkYXRlIHRvIEh6LiBUaGFua3MuDQo+ID4gQWdhaW4gdGhvdWdoLCBJIGRvbid0IHNlZSB3
aGF0IHRoZSBzdWZmaXggZ2l2ZXMgeW91LCBhbmQgd291bGQgcHJlZmVyIHRvIGxlYXZlDQo+ID4g
dGhlIGJpbmRpbmcgYXMgaXMuDQo+IA0KPiBJdCB0ZWxscyBzb21lb25lIHJlYWRpbmcgdGhlIGR0
cyB3aGF0IHRoZSB1bml0cyBhcmUgd2l0aG91dCBoYXZpbmcgdG8NCj4gZmluZCB0aGUgZG9jdW1l
bnRhdGlvbiBhbmQgaGVscHMgcHJldmVudCBwZW9wbGUgdXNpbmcgcHJvcGVydGllcyB3aXRoDQo+
IGRpZmZlcmluZyB1bml0cy4NCg0KRm9yIGEgbG90IG9mIGRldmljZSBzcGVjaWZpYyBiaW5kaW5n
cywgeW91IHdpbGwgbmVlZCB0byByZWFkIHRoZSBhc3NvY2lhdGVkDQpkb2N1bWVudGF0aW9uLCBh
bmQgcG9zc2libHkgdGhlIGRhdGFzaGVldCwgdG8gdW5kZXJzdGFuZCB3aGF0IGl0J3MgZm9yLCBh
bmQgd2hhdA0KdmFsdWVzIGFyZSB2YWxpZC4gSSBkb24ndCBzZWUgdGhpcyBzdWZmaXggcmVhbGx5
IHNhdmluZyB5b3UgYW55IHRpbWUuIEZvcg0Kc3RhbmRhcmQgZnJhbWV3b3JrcyBvaywgYnV0IGhl
cmUgaXQgc2VlbXMgb3ZlcmtpbGwuDQo=
--
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/

[toc] | [prev] | [standalone]

Back to top | Article view | linux.kernel

csiph-web