217 lines
6.0 KiB
YAML
217 lines
6.0 KiB
YAML
|
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
|
||
|
|
%YAML 1.2
|
||
|
|
---
|
||
|
|
$id: http://devicetree.org/schemas/sound/fsl,sai.yaml#
|
||
|
|
$schema: http://devicetree.org/meta-schemas/core.yaml#
|
||
|
|
|
||
|
|
title: Freescale Synchronous Audio Interface (SAI).
|
||
|
|
|
||
|
|
maintainers:
|
||
|
|
- Shengjiu Wang <shengjiu.wang@nxp.com>
|
||
|
|
|
||
|
|
description: |
|
||
|
|
The SAI is based on I2S module that used communicating with audio codecs,
|
||
|
|
which provides a synchronous audio interface that supports fullduplex
|
||
|
|
serial interfaces with frame synchronization such as I2S, AC97, TDM, and
|
||
|
|
codec/DSP interfaces.
|
||
|
|
|
||
|
|
properties:
|
||
|
|
compatible:
|
||
|
|
oneOf:
|
||
|
|
- enum:
|
||
|
|
- fsl,vf610-sai
|
||
|
|
- fsl,imx6sx-sai
|
||
|
|
- fsl,imx6ul-sai
|
||
|
|
- fsl,imx7ulp-sai
|
||
|
|
- fsl,imx8mq-sai
|
||
|
|
- fsl,imx8qm-sai
|
||
|
|
- fsl,imx8ulp-sai
|
||
|
|
- items:
|
||
|
|
- enum:
|
||
|
|
- fsl,imx8mm-sai
|
||
|
|
- fsl,imx8mn-sai
|
||
|
|
- fsl,imx8mp-sai
|
||
|
|
- const: fsl,imx8mq-sai
|
||
|
|
|
||
|
|
reg:
|
||
|
|
maxItems: 1
|
||
|
|
|
||
|
|
interrupts:
|
||
|
|
items:
|
||
|
|
- description: receive and transmit interrupt
|
||
|
|
|
||
|
|
dmas:
|
||
|
|
maxItems: 2
|
||
|
|
|
||
|
|
dma-names:
|
||
|
|
maxItems: 2
|
||
|
|
|
||
|
|
clocks:
|
||
|
|
items:
|
||
|
|
- description: The ipg clock for register access
|
||
|
|
- description: master clock source 0 (obsoleted)
|
||
|
|
- description: master clock source 1
|
||
|
|
- description: master clock source 2
|
||
|
|
- description: master clock source 3
|
||
|
|
- description: PLL clock source for 8kHz series
|
||
|
|
- description: PLL clock source for 11kHz series
|
||
|
|
minItems: 4
|
||
|
|
|
||
|
|
clock-names:
|
||
|
|
oneOf:
|
||
|
|
- items:
|
||
|
|
- const: bus
|
||
|
|
- const: mclk0
|
||
|
|
- const: mclk1
|
||
|
|
- const: mclk2
|
||
|
|
- const: mclk3
|
||
|
|
- const: pll8k
|
||
|
|
- const: pll11k
|
||
|
|
minItems: 4
|
||
|
|
- items:
|
||
|
|
- const: bus
|
||
|
|
- const: mclk1
|
||
|
|
- const: mclk2
|
||
|
|
- const: mclk3
|
||
|
|
- const: pll8k
|
||
|
|
- const: pll11k
|
||
|
|
minItems: 4
|
||
|
|
|
||
|
|
lsb-first:
|
||
|
|
description: |
|
||
|
|
Configures whether the LSB or the MSB is transmitted
|
||
|
|
first for the fifo data. If this property is absent,
|
||
|
|
the MSB is transmitted first as default, or the LSB
|
||
|
|
is transmitted first.
|
||
|
|
type: boolean
|
||
|
|
|
||
|
|
big-endian:
|
||
|
|
description: |
|
||
|
|
required if all the SAI registers are big-endian rather than little-endian.
|
||
|
|
type: boolean
|
||
|
|
|
||
|
|
fsl,sai-synchronous-rx:
|
||
|
|
description: |
|
||
|
|
SAI will work in the synchronous mode (sync Tx with Rx) which means
|
||
|
|
both the transmitter and the receiver will send and receive data by
|
||
|
|
following receiver's bit clocks and frame sync clocks.
|
||
|
|
type: boolean
|
||
|
|
|
||
|
|
fsl,sai-asynchronous:
|
||
|
|
description: |
|
||
|
|
SAI will work in the asynchronous mode, which means both transmitter
|
||
|
|
and receiver will send and receive data by following their own bit clocks
|
||
|
|
and frame sync clocks separately.
|
||
|
|
If both fsl,sai-asynchronous and fsl,sai-synchronous-rx are absent, the
|
||
|
|
default synchronous mode (sync Rx with Tx) will be used, which means both
|
||
|
|
transmitter and receiver will send and receive data by following clocks
|
||
|
|
of transmitter.
|
||
|
|
type: boolean
|
||
|
|
|
||
|
|
fsl,dataline:
|
||
|
|
$ref: /schemas/types.yaml#/definitions/uint32-matrix
|
||
|
|
description: |
|
||
|
|
Configure the dataline. It has 3 value for each configuration
|
||
|
|
maxItems: 16
|
||
|
|
items:
|
||
|
|
items:
|
||
|
|
- description: format Default(0), I2S(1) or PDM(2)
|
||
|
|
enum: [0, 1, 2]
|
||
|
|
- description: dataline mask for 'rx'
|
||
|
|
- description: dataline mask for 'tx'
|
||
|
|
|
||
|
|
fsl,sai-mclk-direction-output:
|
||
|
|
description: SAI will output the SAI MCLK clock.
|
||
|
|
type: boolean
|
||
|
|
|
||
|
|
fsl,shared-interrupt:
|
||
|
|
description: Interrupt is shared with other modules.
|
||
|
|
type: boolean
|
||
|
|
|
||
|
|
"#sound-dai-cells":
|
||
|
|
const: 0
|
||
|
|
description: optional, some dts node didn't add it.
|
||
|
|
|
||
|
|
allOf:
|
||
|
|
- if:
|
||
|
|
properties:
|
||
|
|
compatible:
|
||
|
|
contains:
|
||
|
|
const: fsl,vf610-sai
|
||
|
|
then:
|
||
|
|
properties:
|
||
|
|
dmas:
|
||
|
|
items:
|
||
|
|
- description: DMA controller phandle and request line for TX
|
||
|
|
- description: DMA controller phandle and request line for RX
|
||
|
|
dma-names:
|
||
|
|
items:
|
||
|
|
- const: tx
|
||
|
|
- const: rx
|
||
|
|
else:
|
||
|
|
properties:
|
||
|
|
dmas:
|
||
|
|
items:
|
||
|
|
- description: DMA controller phandle and request line for RX
|
||
|
|
- description: DMA controller phandle and request line for TX
|
||
|
|
dma-names:
|
||
|
|
items:
|
||
|
|
- const: rx
|
||
|
|
- const: tx
|
||
|
|
- if:
|
||
|
|
required:
|
||
|
|
- fsl,sai-asynchronous
|
||
|
|
then:
|
||
|
|
properties:
|
||
|
|
fsl,sai-synchronous-rx: false
|
||
|
|
|
||
|
|
required:
|
||
|
|
- compatible
|
||
|
|
- reg
|
||
|
|
- interrupts
|
||
|
|
- dmas
|
||
|
|
- dma-names
|
||
|
|
- clocks
|
||
|
|
- clock-names
|
||
|
|
|
||
|
|
additionalProperties: false
|
||
|
|
|
||
|
|
examples:
|
||
|
|
- |
|
||
|
|
#include <dt-bindings/interrupt-controller/arm-gic.h>
|
||
|
|
#include <dt-bindings/clock/vf610-clock.h>
|
||
|
|
sai2: sai@40031000 {
|
||
|
|
compatible = "fsl,vf610-sai";
|
||
|
|
reg = <0x40031000 0x1000>;
|
||
|
|
interrupts = <86 IRQ_TYPE_LEVEL_HIGH>;
|
||
|
|
pinctrl-names = "default";
|
||
|
|
pinctrl-0 = <&pinctrl_sai2_1>;
|
||
|
|
clocks = <&clks VF610_CLK_PLATFORM_BUS>,
|
||
|
|
<&clks VF610_CLK_SAI2>,
|
||
|
|
<&clks 0>, <&clks 0>;
|
||
|
|
clock-names = "bus", "mclk1", "mclk2", "mclk3";
|
||
|
|
dma-names = "tx", "rx";
|
||
|
|
dmas = <&edma0 0 21>,
|
||
|
|
<&edma0 0 20>;
|
||
|
|
big-endian;
|
||
|
|
lsb-first;
|
||
|
|
};
|
||
|
|
|
||
|
|
- |
|
||
|
|
#include <dt-bindings/interrupt-controller/arm-gic.h>
|
||
|
|
#include <dt-bindings/clock/imx8mm-clock.h>
|
||
|
|
sai1: sai@30010000 {
|
||
|
|
compatible = "fsl,imx8mm-sai", "fsl,imx8mq-sai";
|
||
|
|
reg = <0x30010000 0x10000>;
|
||
|
|
interrupts = <GIC_SPI 95 IRQ_TYPE_LEVEL_HIGH>;
|
||
|
|
clocks = <&clk IMX8MM_CLK_SAI1_IPG>,
|
||
|
|
<&clk IMX8MM_CLK_DUMMY>,
|
||
|
|
<&clk IMX8MM_CLK_SAI1_ROOT>,
|
||
|
|
<&clk IMX8MM_CLK_DUMMY>, <&clk IMX8MM_CLK_DUMMY>;
|
||
|
|
clock-names = "bus", "mclk0", "mclk1", "mclk2", "mclk3";
|
||
|
|
dmas = <&sdma2 0 2 0>, <&sdma2 1 2 0>;
|
||
|
|
dma-names = "rx", "tx";
|
||
|
|
fsl,dataline = <1 0xff 0xff 2 0xff 0x11>;
|
||
|
|
#sound-dai-cells = <0>;
|
||
|
|
};
|