Documentation/devicetree/bindings/sound/gpio-audio-amp.yaml

File Facts

System

Linux kernel

Corpus path

Documentation/devicetree/bindings/sound/gpio-audio-amp.yaml

Extension

.yaml

Size

8926 bytes

Lines

271

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.

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

Dependency Surface

• dt-bindings/gpio/gpio.h

Detected Declarations

• No top-level syscall, struct, function, initcall, or export declaration detected by the generator.

Annotated Snippet

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

title: Audio amplifier driven by GPIOs

maintainers:
  - Herve Codina <herve.codina@bootlin.com>

description: |
  Audio GPIO amplifiers are driven by GPIO in order to control the gain value
  of the amplifier, its mute function and/or its bypass function.

  Those amplifiers are based on discrete components (analog switches, op-amps
  and more) where some of them, mostly analog switches, are controlled by GPIOs
  to adjust the gain value of the whole amplifier and/or to control
  the mute and/or bypass function.

  For instance, the following piece of hardware is a GPIO amplifier

                                         +5VA
                                           ^
                                        |\ |
                                        | \
        Vin >---------------------------|+ \
                                        |   +-------+-----> Vout
                .--\/\/\/--+------------|- /        |
                |          |            | /         |
                v          |            |/ |        |
               GND         o               v        |
                            \             GND       |
       gpio >----------->    \                      |
                         o    o                     |
                         |    |                     |
                         |    '--\/\/\/--.          |
                         |               +--\/\/\/--'
                         '---------------'

properties:
  compatible:
    oneOf:
      - const: gpio-audio-amp-mono
        description:
          A single channel amplifier. All features apply to this sole channel.

      - const: gpio-audio-amp-stereo
        description:
          A dual channel amplifier (left and right). All features apply to both
          channels producing the same effect on both channels at the same time.

  vdd-supply:
    description: Main power supply of the amplifier

  vddio-supply:
    description: Power supply related to the control path

  vdda1-supply:
    description: Analog power supply

  vdda2-supply:
    description: Additional analog power supply

  mute-gpios:
    description: GPIO to control the mute function
    maxItems: 1

  bypass-gpios:
    description: GPIO to control the bypass function

Annotation

• Immediate include surface: `dt-bindings/gpio/gpio.h`.
• Atlas domain: Support Tooling And Documentation / Documentation.
• Implementation status: atlas-only.

Implementation Notes

• This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
• Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
• Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.