Documentation/devicetree/bindings/sound/realtek,rt5682s.yaml

Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/sound/realtek,rt5682s.yaml

File Facts

System
Linux kernel
Corpus path
Documentation/devicetree/bindings/sound/realtek,rt5682s.yaml
Extension
.yaml
Size
3711 bytes
Lines
151
Domain
Support Tooling And Documentation
Bucket
Documentation
Inferred role
Support Tooling And Documentation: configuration, schema, or hardware description
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/sound/realtek,rt5682s.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Realtek rt5682s codec

maintainers:
  - Derek Fang <derek.fang@realtek.com>

description: |
  Rt5682s(ALC5682I-VS) is a rt5682i variant which supports I2C only.

allOf:
  - $ref: dai-common.yaml#

properties:
  compatible:
    const: realtek,rt5682s

  reg:
    maxItems: 1
    description: I2C address of the device.

  interrupts:
    maxItems: 1
    description: The CODEC's interrupt output.

  realtek,dmic1-data-pin:
    $ref: /schemas/types.yaml#/definitions/uint32
    enum:
      - 0 # dmic1 data is not used
      - 1 # using GPIO2 pin as dmic1 data pin
      - 2 # using GPIO5 pin as dmic1 data pin
    description: |
      Specify which GPIO pin be used as DMIC1 data pin.

  realtek,dmic1-clk-pin:
    $ref: /schemas/types.yaml#/definitions/uint32
    enum:
      - 0 # dmic1 clk is not used
      - 1 # using GPIO1 pin as dmic1 clock pin
      - 2 # using GPIO3 pin as dmic1 clock pin
    description: |
      Specify which GPIO pin be used as DMIC1 clk pin.

  realtek,jd-src:
    $ref: /schemas/types.yaml#/definitions/uint32
    enum:
      - 0 # No JD is used
      - 1 # using JD1 as JD source
    description: |
      Specify which JD source be used.

  realtek,ldo1-en-gpios:
    description: |
      The GPIO that controls the CODEC's LDO1_EN pin.

  realtek,dmic-clk-rate-hz:
    description: |
      Set the clock rate (hz) for the requirement of the particular DMIC.

  realtek,dmic-delay-ms:
    description: |
      Set the delay time (ms) for the requirement of the particular DMIC.

  realtek,amic-delay-ms:
    description: |
      Set the delay time (ms) for the requirement of the particular platform or AMIC.

Annotation

Implementation Notes