All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lucas Tanure <tanureal@opensource.cirrus.com>
To: Liam Girdwood <lgirdwood@gmail.com>,
	Mark Brown <broonie@kernel.org>, Rob Herring <robh+dt@kernel.org>,
	Jaroslav Kysela <perex@perex.cz>, Takashi Iwai <tiwai@suse.com>
Cc: <alsa-devel@alsa-project.org>, <patches@opensource.cirrus.com>,
	<devicetree@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
	David Rhodes <drhodes@opensource.cirrus.com>,
	Lucas Tanure <tanureal@opensource.cirrus.com>,
	Rob Herring <robh@kernel.org>
Subject: [PATCH v5 15/16] ASoC: cs35l41: Document CS35l41 External Boost
Date: Tue, 22 Mar 2022 15:18:18 +0000	[thread overview]
Message-ID: <20220322151819.4299-16-tanureal@opensource.cirrus.com> (raw)
In-Reply-To: <20220322151819.4299-1-tanureal@opensource.cirrus.com>

From: David Rhodes <drhodes@opensource.cirrus.com>

Document internal and external boost feature for ASoC CS35L41.
For internal boost the following properties are required:
- cirrus,boost-peak-milliamp
- cirrus,boost-ind-nanohenry
- cirrus,boost-cap-microfarad

For external boost, the GPIO1 must be configured as output,
so the following properties are required:
- cirrus,gpio1-src-select = <1>
- cirrus,gpio1-output-enable

Signed-off-by: David Rhodes <drhodes@opensource.cirrus.com>
Signed-off-by: Lucas Tanure <tanureal@opensource.cirrus.com>
Reviewed-by: Rob Herring <robh@kernel.org>
---
 .../bindings/sound/cirrus,cs35l41.yaml        | 44 +++++++++++++++++--
 1 file changed, 41 insertions(+), 3 deletions(-)

diff --git a/Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml b/Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml
index 3235702ce402..51d815d0c696 100644
--- a/Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml
+++ b/Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml
@@ -75,6 +75,19 @@ properties:
     maximum: 3
     default: 2
 
+  cirrus,boost-type:
+    description:
+      Configures the type of Boost being used.
+      Internal boost requires boost-peak-milliamp, boost-ind-nanohenry and
+      boost-cap-microfarad.
+      External Boost must have GPIO1 as GPIO output. GPIO1 will be set high to
+      enable boost voltage.
+      0 = Internal Boost
+      1 = External Boost
+    $ref: "/schemas/types.yaml#/definitions/uint32"
+    minimum: 0
+    maximum: 1
+
   cirrus,gpio1-polarity-invert:
     description:
       Boolean which specifies whether the GPIO1
@@ -131,9 +144,32 @@ required:
   - compatible
   - reg
   - "#sound-dai-cells"
-  - cirrus,boost-peak-milliamp
-  - cirrus,boost-ind-nanohenry
-  - cirrus,boost-cap-microfarad
+
+allOf:
+  - if:
+      properties:
+        cirrus,boost-type:
+          const: 0
+    then:
+      required:
+        - cirrus,boost-peak-milliamp
+        - cirrus,boost-ind-nanohenry
+        - cirrus,boost-cap-microfarad
+    else:
+      if:
+        properties:
+          cirrus,boost-type:
+            const: 1
+      then:
+        required:
+          - cirrus,gpio1-output-enable
+          - cirrus,gpio1-src-select
+        properties:
+          cirrus,boost-peak-milliamp: false
+          cirrus,boost-ind-nanohenry: false
+          cirrus,boost-cap-microfarad: false
+          cirrus,gpio1-src-select:
+            enum: [1]
 
 additionalProperties: false
 
@@ -150,6 +186,8 @@ examples:
           VA-supply = <&dummy_vreg>;
           VP-supply = <&dummy_vreg>;
           reset-gpios = <&gpio 110 0>;
+
+          cirrus,boost-type = <0>;
           cirrus,boost-peak-milliamp = <4500>;
           cirrus,boost-ind-nanohenry = <1000>;
           cirrus,boost-cap-microfarad = <15>;
-- 
2.35.1


WARNING: multiple messages have this Message-ID (diff)
From: Lucas Tanure <tanureal@opensource.cirrus.com>
To: Liam Girdwood <lgirdwood@gmail.com>,
	Mark Brown <broonie@kernel.org>, Rob Herring <robh+dt@kernel.org>,
	Jaroslav Kysela <perex@perex.cz>, Takashi Iwai <tiwai@suse.com>
Cc: David Rhodes <drhodes@opensource.cirrus.com>,
	devicetree@vger.kernel.org, alsa-devel@alsa-project.org,
	Lucas Tanure <tanureal@opensource.cirrus.com>,
	Rob Herring <robh@kernel.org>,
	patches@opensource.cirrus.com, linux-kernel@vger.kernel.org
Subject: [PATCH v5 15/16] ASoC: cs35l41: Document CS35l41 External Boost
Date: Tue, 22 Mar 2022 15:18:18 +0000	[thread overview]
Message-ID: <20220322151819.4299-16-tanureal@opensource.cirrus.com> (raw)
In-Reply-To: <20220322151819.4299-1-tanureal@opensource.cirrus.com>

From: David Rhodes <drhodes@opensource.cirrus.com>

Document internal and external boost feature for ASoC CS35L41.
For internal boost the following properties are required:
- cirrus,boost-peak-milliamp
- cirrus,boost-ind-nanohenry
- cirrus,boost-cap-microfarad

For external boost, the GPIO1 must be configured as output,
so the following properties are required:
- cirrus,gpio1-src-select = <1>
- cirrus,gpio1-output-enable

Signed-off-by: David Rhodes <drhodes@opensource.cirrus.com>
Signed-off-by: Lucas Tanure <tanureal@opensource.cirrus.com>
Reviewed-by: Rob Herring <robh@kernel.org>
---
 .../bindings/sound/cirrus,cs35l41.yaml        | 44 +++++++++++++++++--
 1 file changed, 41 insertions(+), 3 deletions(-)

diff --git a/Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml b/Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml
index 3235702ce402..51d815d0c696 100644
--- a/Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml
+++ b/Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml
@@ -75,6 +75,19 @@ properties:
     maximum: 3
     default: 2
 
+  cirrus,boost-type:
+    description:
+      Configures the type of Boost being used.
+      Internal boost requires boost-peak-milliamp, boost-ind-nanohenry and
+      boost-cap-microfarad.
+      External Boost must have GPIO1 as GPIO output. GPIO1 will be set high to
+      enable boost voltage.
+      0 = Internal Boost
+      1 = External Boost
+    $ref: "/schemas/types.yaml#/definitions/uint32"
+    minimum: 0
+    maximum: 1
+
   cirrus,gpio1-polarity-invert:
     description:
       Boolean which specifies whether the GPIO1
@@ -131,9 +144,32 @@ required:
   - compatible
   - reg
   - "#sound-dai-cells"
-  - cirrus,boost-peak-milliamp
-  - cirrus,boost-ind-nanohenry
-  - cirrus,boost-cap-microfarad
+
+allOf:
+  - if:
+      properties:
+        cirrus,boost-type:
+          const: 0
+    then:
+      required:
+        - cirrus,boost-peak-milliamp
+        - cirrus,boost-ind-nanohenry
+        - cirrus,boost-cap-microfarad
+    else:
+      if:
+        properties:
+          cirrus,boost-type:
+            const: 1
+      then:
+        required:
+          - cirrus,gpio1-output-enable
+          - cirrus,gpio1-src-select
+        properties:
+          cirrus,boost-peak-milliamp: false
+          cirrus,boost-ind-nanohenry: false
+          cirrus,boost-cap-microfarad: false
+          cirrus,gpio1-src-select:
+            enum: [1]
 
 additionalProperties: false
 
@@ -150,6 +186,8 @@ examples:
           VA-supply = <&dummy_vreg>;
           VP-supply = <&dummy_vreg>;
           reset-gpios = <&gpio 110 0>;
+
+          cirrus,boost-type = <0>;
           cirrus,boost-peak-milliamp = <4500>;
           cirrus,boost-ind-nanohenry = <1000>;
           cirrus,boost-cap-microfarad = <15>;
-- 
2.35.1


  parent reply	other threads:[~2022-03-22 15:19 UTC|newest]

Thread overview: 36+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-22 15:18 [PATCH v5 00/16] Support external boost at CS35l41 ASoC driver Lucas Tanure
2022-03-22 15:18 ` Lucas Tanure
2022-03-22 15:18 ` [PATCH v5 01/16] ALSA: cs35l41: Unify hardware configuration Lucas Tanure
2022-03-22 15:18   ` Lucas Tanure
2022-03-22 15:18 ` [PATCH v5 02/16] ALSA: cs35l41: Check hw_config before using it Lucas Tanure
2022-03-22 15:18   ` Lucas Tanure
2022-03-22 15:18 ` [PATCH v5 03/16] ALSA: cs35l41: Move cs35l41_gpio_config to shared lib Lucas Tanure
2022-03-22 15:18   ` Lucas Tanure
2022-03-22 15:18 ` [PATCH v5 04/16] ALSA: hda: cs35l41: Fix I2S params comments Lucas Tanure
2022-03-22 15:18   ` Lucas Tanure
2022-03-22 15:18 ` [PATCH v5 05/16] ALSA: hda: cs35l41: Always configure the DAI Lucas Tanure
2022-03-22 15:18   ` Lucas Tanure
2022-03-22 15:18 ` [PATCH v5 06/16] ALSA: hda: cs35l41: Add Boost type flag Lucas Tanure
2022-03-22 15:18   ` Lucas Tanure
2022-03-22 15:18 ` [PATCH v5 07/16] ALSA: hda: cs35l41: Put the device into safe mode for external boost Lucas Tanure
2022-03-22 15:18   ` Lucas Tanure
2022-03-22 15:18 ` [PATCH v5 08/16] ALSA: hda: cs35l41: Mute the device before shutdown Lucas Tanure
2022-03-22 15:18   ` Lucas Tanure
2022-03-22 15:18 ` [PATCH v5 09/16] ALSA: cs35l41: Enable Internal Boost in shared lib Lucas Tanure
2022-03-22 15:18   ` Lucas Tanure
2022-03-22 15:18 ` [PATCH v5 10/16] ALSA: hda: cs35l41: Move boost config to initialization code Lucas Tanure
2022-03-22 15:18   ` Lucas Tanure
2022-03-22 15:18 ` [PATCH v5 11/16] ALSA: hda: cs35l41: Remove cs35l41_hda_reg_sequence struct Lucas Tanure
2022-03-22 15:18   ` Lucas Tanure
2022-03-22 15:18 ` [PATCH v5 12/16] ALSA: hda: cs35l41: Reorganize log for playback actions Lucas Tanure
2022-03-22 15:18   ` Lucas Tanure
2022-03-22 15:18 ` [PATCH v5 13/16] ALSA: hda: cs35l41: Handle all external boost setups the same way Lucas Tanure
2022-03-22 15:18   ` Lucas Tanure
2022-03-22 15:18 ` [PATCH v5 14/16] ALSA: hda: cs35l41: Move external boost handling to lib for ASoC use Lucas Tanure
2022-03-22 15:18   ` Lucas Tanure
2022-03-22 15:18 ` Lucas Tanure [this message]
2022-03-22 15:18   ` [PATCH v5 15/16] ASoC: cs35l41: Document CS35l41 External Boost Lucas Tanure
2022-03-23  9:20   ` Charles Keepax
2022-03-23  9:20     ` Charles Keepax
2022-03-22 15:18 ` [PATCH v5 16/16] ASoC: cs35l41: Support external boost Lucas Tanure
2022-03-22 15:18   ` Lucas Tanure

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220322151819.4299-16-tanureal@opensource.cirrus.com \
    --to=tanureal@opensource.cirrus.com \
    --cc=alsa-devel@alsa-project.org \
    --cc=broonie@kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=drhodes@opensource.cirrus.com \
    --cc=lgirdwood@gmail.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=patches@opensource.cirrus.com \
    --cc=perex@perex.cz \
    --cc=robh+dt@kernel.org \
    --cc=robh@kernel.org \
    --cc=tiwai@suse.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.