[v2,2/3] ASoC: Documentation: Add google, cros-ec-codec
diff mbox series

Message ID 20181224083724.75618-2-cychiang@chromium.org
State New
Headers show
Series
  • [v2,1/3] mfd: cros_ec: Add commands to control codec
Related show

Commit Message

Cheng-yi Chiang Dec. 24, 2018, 8:37 a.m. UTC
Add documentation for Chrome EC codec driver.

Signed-off-by: Cheng-Yi Chiang <cychiang@chromium.org>
---
 Change in v2: Fixed name of driver in MAINTAINERS.

 .../bindings/sound/google,cros-ec-codec.txt   | 24 +++++++++++++++++++
 MAINTAINERS                                   |  5 ++++
 2 files changed, 29 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/google,cros-ec-codec.txt

Comments

Guenter Roeck Dec. 24, 2018, 2:38 p.m. UTC | #1
On Mon, Dec 24, 2018 at 12:39 AM Cheng-Yi Chiang <cychiang@chromium.org> wrote:
>
> Add documentation for Chrome EC codec driver.
>
> Signed-off-by: Cheng-Yi Chiang <cychiang@chromium.org>
> ---
>  Change in v2: Fixed name of driver in MAINTAINERS.
>
>  .../bindings/sound/google,cros-ec-codec.txt   | 24 +++++++++++++++++++

Since this is a devicetree binding, it will require an Ack from a DT
maintainer. You might want to check the output of
scripts/get_maintainer.pl to make sure you don't miss anyone
important.

Guenter

>  MAINTAINERS                                   |  5 ++++
>  2 files changed, 29 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/google,cros-ec-codec.txt
>
> diff --git a/Documentation/devicetree/bindings/sound/google,cros-ec-codec.txt b/Documentation/devicetree/bindings/sound/google,cros-ec-codec.txt
> new file mode 100644
> index 0000000000000..57718382b3a36
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/google,cros-ec-codec.txt
> @@ -0,0 +1,24 @@
> +* Audio codec controlled by ChromeOS EC
> +
> +Google's ChromeOS EC codec is a digital mic codec provided by the
> +Embedded Controller (EC) and is controlled via a host-command interface.
> +
> +An EC codec node should only be found as a sub-node of the EC node (see
> +Documentation/devicetree/bindings/mfd/cros-ec.txt).
> +
> +Required properties:
> +- compatible: Must contain "google,cros-ec-codec"
> +- #sound-dai-cells: Should be 1. The cell specifies number of DAIs.
> +
> +Example:
> +
> +cros-ec@0 {
> +       compatible = "google,cros-ec-spi";
> +
> +       ...
> +
> +       cros_ec_codec: ec-codec {
> +               compatible = "google,cros-ec-codec";
> +               #sound-dai-cells = <1>;
> +       };
> +};
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 5b9c6af98283b..05e1922624e58 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -3636,6 +3636,11 @@ S:       Maintained
>  T:     git git://git.kernel.org/pub/scm/linux/kernel/git/bleung/chrome-platform.git
>  F:     drivers/platform/chrome/
>
> +CHROMEOS EC CODEC DRIVER
> +M:     Cheng-Yi Chiang <cychiang@chromium.org>
> +S:     Maintained
> +F:     Documentation/devicetree/bindings/sound/google,cros-ec-codec.txt
> +
>  CIRRUS LOGIC AUDIO CODEC DRIVERS
>  M:     Brian Austin <brian.austin@cirrus.com>
>  M:     Paul Handrigan <Paul.Handrigan@cirrus.com>
> --
> 2.20.1.415.g653613c723-goog
>
Cheng-yi Chiang Dec. 26, 2018, 7:17 a.m. UTC | #2
On Mon, Dec 24, 2018 at 10:38 PM Guenter Roeck <groeck@google.com> wrote:
>
> On Mon, Dec 24, 2018 at 12:39 AM Cheng-Yi Chiang <cychiang@chromium.org> wrote:
> >
> > Add documentation for Chrome EC codec driver.
> >
> > Signed-off-by: Cheng-Yi Chiang <cychiang@chromium.org>
> > ---
> >  Change in v2: Fixed name of driver in MAINTAINERS.
> >
> >  .../bindings/sound/google,cros-ec-codec.txt   | 24 +++++++++++++++++++
>
> Since this is a devicetree binding, it will require an Ack from a DT
> maintainer. You might want to check the output of
> scripts/get_maintainer.pl to make sure you don't miss anyone
> important.
>
> Guenter
>

Thanks for the suggestion.
cc'ed Rob Herring in v3.

> >  MAINTAINERS                                   |  5 ++++
> >  2 files changed, 29 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/sound/google,cros-ec-codec.txt
> >
> > diff --git a/Documentation/devicetree/bindings/sound/google,cros-ec-codec.txt b/Documentation/devicetree/bindings/sound/google,cros-ec-codec.txt
> > new file mode 100644
> > index 0000000000000..57718382b3a36
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/sound/google,cros-ec-codec.txt
> > @@ -0,0 +1,24 @@
> > +* Audio codec controlled by ChromeOS EC
> > +
> > +Google's ChromeOS EC codec is a digital mic codec provided by the
> > +Embedded Controller (EC) and is controlled via a host-command interface.
> > +
> > +An EC codec node should only be found as a sub-node of the EC node (see
> > +Documentation/devicetree/bindings/mfd/cros-ec.txt).
> > +
> > +Required properties:
> > +- compatible: Must contain "google,cros-ec-codec"
> > +- #sound-dai-cells: Should be 1. The cell specifies number of DAIs.
> > +
> > +Example:
> > +
> > +cros-ec@0 {
> > +       compatible = "google,cros-ec-spi";
> > +
> > +       ...
> > +
> > +       cros_ec_codec: ec-codec {
> > +               compatible = "google,cros-ec-codec";
> > +               #sound-dai-cells = <1>;
> > +       };
> > +};
> > diff --git a/MAINTAINERS b/MAINTAINERS
> > index 5b9c6af98283b..05e1922624e58 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -3636,6 +3636,11 @@ S:       Maintained
> >  T:     git git://git.kernel.org/pub/scm/linux/kernel/git/bleung/chrome-platform.git
> >  F:     drivers/platform/chrome/
> >
> > +CHROMEOS EC CODEC DRIVER
> > +M:     Cheng-Yi Chiang <cychiang@chromium.org>
> > +S:     Maintained
> > +F:     Documentation/devicetree/bindings/sound/google,cros-ec-codec.txt
> > +
> >  CIRRUS LOGIC AUDIO CODEC DRIVERS
> >  M:     Brian Austin <brian.austin@cirrus.com>
> >  M:     Paul Handrigan <Paul.Handrigan@cirrus.com>
> > --
> > 2.20.1.415.g653613c723-goog
> >

Patch
diff mbox series

diff --git a/Documentation/devicetree/bindings/sound/google,cros-ec-codec.txt b/Documentation/devicetree/bindings/sound/google,cros-ec-codec.txt
new file mode 100644
index 0000000000000..57718382b3a36
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/google,cros-ec-codec.txt
@@ -0,0 +1,24 @@ 
+* Audio codec controlled by ChromeOS EC
+
+Google's ChromeOS EC codec is a digital mic codec provided by the
+Embedded Controller (EC) and is controlled via a host-command interface.
+
+An EC codec node should only be found as a sub-node of the EC node (see
+Documentation/devicetree/bindings/mfd/cros-ec.txt).
+
+Required properties:
+- compatible: Must contain "google,cros-ec-codec"
+- #sound-dai-cells: Should be 1. The cell specifies number of DAIs.
+
+Example:
+
+cros-ec@0 {
+	compatible = "google,cros-ec-spi";
+
+	...
+
+	cros_ec_codec: ec-codec {
+		compatible = "google,cros-ec-codec";
+		#sound-dai-cells = <1>;
+	};
+};
diff --git a/MAINTAINERS b/MAINTAINERS
index 5b9c6af98283b..05e1922624e58 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -3636,6 +3636,11 @@  S:	Maintained
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/bleung/chrome-platform.git
 F:	drivers/platform/chrome/
 
+CHROMEOS EC CODEC DRIVER
+M:	Cheng-Yi Chiang <cychiang@chromium.org>
+S:	Maintained
+F:	Documentation/devicetree/bindings/sound/google,cros-ec-codec.txt
+
 CIRRUS LOGIC AUDIO CODEC DRIVERS
 M:	Brian Austin <brian.austin@cirrus.com>
 M:	Paul Handrigan <Paul.Handrigan@cirrus.com>