Documentation/devicetree/bindings/sound/fsl,ssi.yaml

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

File Facts

System
Linux kernel
Corpus path
Documentation/devicetree/bindings/sound/fsl,ssi.yaml
Extension
.yaml
Size
6337 bytes
Lines
195
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/fsl,ssi.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Freescale Synchronous Serial Interface

maintainers:
  - Shengjiu Wang <shengjiu.wang@nxp.com>

description:
  Notes on fsl,playback-dma and fsl,capture-dma
  On SOCs that have an SSI, specific DMA channels are hard-wired for playback
  and capture.  On the MPC8610, for example, SSI1 must use DMA channel 0 for
  playback and DMA channel 1 for capture.  SSI2 must use DMA channel 2 for
  playback and DMA channel 3 for capture.  The developer can choose which
  DMA controller to use, but the channels themselves are hard-wired.  The
  purpose of these two properties is to represent this hardware design.

  The device tree nodes for the DMA channels that are referenced by
  "fsl,playback-dma" and "fsl,capture-dma" must be marked as compatible with
  "fsl,ssi-dma-channel".  The SOC-specific compatible string (e.g.
  "fsl,mpc8610-dma-channel") can remain.  If these nodes are left as
  "fsl,elo-dma-channel" or "fsl,eloplus-dma-channel", then the generic Elo DMA
  drivers (fsldma) will attempt to use them, and it will conflict with the
  sound drivers.

properties:
  compatible:
    oneOf:
      - items:
          - enum:
              - fsl,imx50-ssi
              - fsl,imx53-ssi
          - const: fsl,imx51-ssi
          - const: fsl,imx21-ssi
      - items:
          - enum:
              - fsl,imx25-ssi
              - fsl,imx27-ssi
              - fsl,imx35-ssi
              - fsl,imx51-ssi
          - const: fsl,imx21-ssi
      - items:
          - enum:
              - fsl,imx6q-ssi
              - fsl,imx6sl-ssi
              - fsl,imx6sx-ssi
          - const: fsl,imx51-ssi
      - items:
          - const: fsl,imx21-ssi
      - items:
          - const: fsl,mpc8610-ssi

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  clocks:
    items:
      - description: The ipg clock for register access
      - description: clock for SSI master mode
    minItems: 1

  clock-names:
    items:
      - const: ipg

Annotation

Implementation Notes