[v2,1/4] dt-bindings: sound: gtm601: Add description

Message ID 6904cc6d877d28d92e9f9fa9f1bdc404614d9734.1691684726.git.agx@sigxcpu.org
State New
Headers
Series Device tree and config updates for the Librem 5 devkit |

Commit Message

Guido Günther Aug. 10, 2023, 5:59 p.m. UTC
  This allows to us to document the channel and sampling
rate requirements.

Signed-off-by: Guido Günther <agx@sigxcpu.org>
Acked-by: Conor Dooley <conor.dooley@microchip.com>
---
 Documentation/devicetree/bindings/sound/option,gtm601.yaml | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
  

Comments

Mark Brown Aug. 10, 2023, 6:02 p.m. UTC | #1
On Thu, Aug 10, 2023 at 07:59:49PM +0200, Guido Günther wrote:
> This allows to us to document the channel and sampling
> rate requirements.

Please do not submit new versions of already applied patches, please
submit incremental updates to the existing code.  Modifying existing
commits creates problems for other users building on top of those
commits so it's best practice to only change pubished git commits if
absolutely essential.
  

Patch

diff --git a/Documentation/devicetree/bindings/sound/option,gtm601.yaml b/Documentation/devicetree/bindings/sound/option,gtm601.yaml
index 69c2ccc79dc5..ff813d97fc59 100644
--- a/Documentation/devicetree/bindings/sound/option,gtm601.yaml
+++ b/Documentation/devicetree/bindings/sound/option,gtm601.yaml
@@ -16,10 +16,12 @@  description: >
 properties:
   compatible:
     oneOf:
-      - items:  # 48 kHz stereo
+      - description: Broadmobi BM818 (48Khz stereo)
+        items:
           - const: broadmobi,bm818
           - const: option,gtm601
-      - const: option,gtm601  # 8 kHz mono
+      - description: GTM601 (8kHz mono)
+        const: option,gtm601
 
   '#sound-dai-cells':
     const: 0