Evolution-x-devices/kernel_xiaomi_sm8450-devicetrees
2
0
Fork 0
mirror of https://github.com/Evolution-X-Devices/kernel_xiaomi_sm8450-devicetrees synced 2026-02-01 04:59:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

bindings: Documentation: add QTI audio documentation

Browse Source 
Add QTI audio documentation for Lahaina.

Change-Id: I6f735fdce2ba30f81868378e86c5b4d65b250134
This commit is contained in:
Vignesh Kulothungan
2020-01-07 11:40:30 -08:00
parent dd765312c3
commit 4685ce1971
3 changed files with 2859 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

202
bindings/pinctrl/qcom,lpi-pinctrl.txt Normal file
View File

@@ -0,0 +1,202 @@
Qualcomm Technologies, Inc. LPI GPIO controller driver
This DT bindings describes the GPIO controller driver
being added for supporting LPI (Low Power Island) TLMM
from QTI chipsets.
Following properties are for LPI GPIO controller device main node.
- compatible:
Usage: required
Value type: <string>
Definition: must be "qcom,lpi-pinctrl"
- reg:
Usage: required
Value type: <prop-encoded-array>
Definition: Register base of the GPIO controller and length.
- qcom,num-gpios:
Usage: required
Value type: <u32>
Definition: Number of GPIOs supported by the controller.
- qcom,lpi-offset-tbl
Usage: required
Value type: <u32-array>
Definition: Offset table of GPIOs supported by the controller.
- gpio-controller:
Usage: required
Value type: <none>
Definition: Used to mark the device node as a GPIO controller.
- #gpio-cells:
Usage: required
Value type: <u32>
Definition: Must be 2;
The first cell will be used to define gpio number and the
second denotes the flags for this gpio.
- #qcom,slew-reg:
Usage: optional
Value type: <prop-encoded-array>
Definition: Register base of the slew register and length.
- #qcom,lpi-slew-offset-tbl:
Usage: optional
Value type: <u32-array>
Definition: Offset table that points to each pin's shift value
position in bits in the slew register base for slew
settings.
- #qcom,lpi-slew-base-tbl:
Usage: optional
Value type: <u32-array>
Definition: Table points to physical address for corresponding
slew registers.
Please refer to ../gpio/gpio.txt for general description of GPIO bindings.
Please refer to pinctrl-bindings.txt in this directory for details of the
common pinctrl bindings used by client devices, including the meaning of the
phrase "pin configuration node".
The pin configuration nodes act as a container for an arbitrary number of
subnodes. Each of these subnodes represents some desired configuration for a
pin or a list of pins. This configuration can include the
mux function to select on those pin(s), and various pin configuration
parameters, as listed below.
SUBNODES:
The name of each subnode is not important; all subnodes should be enumerated
and processed purely based on their content.
Each subnode only affects those parameters that are explicitly listed. In
other words, a subnode that lists a mux function but no pin configuration
parameters implies no information about any pin configuration parameters.
Similarly, a pin subnode that describes a pullup parameter implies no
information about e.g. the mux function.
The following generic properties as defined in pinctrl-bindings.txt are valid
to specify in a pin configuration subnode:
- pins:
Usage: required
Value type: <string-array>
Definition: List of gpio pins affected by the properties specified in
this subnode. Valid pins are: gpio0-gpio31 for LPI.
- function:
Usage: required
Value type: <string>
Definition: Specify the alternative function to be configured for the
specified pins. Valid values are:
"gpio",
"func1",
"func2",
"func3",
"func4",
"func5"
- bias-disable:
Usage: optional
Value type: <none>
Definition: The specified pins should be configured as no pull.
- bias-pull-down:
Usage: optional
Value type: <none>
Definition: The specified pins should be configured as pull down.
- bias-bus-hold:
Usage: optional
Value type: <none>
Definition: The specified pins should be configured as bus-keeper mode.
- bias-pull-up:
Usage: optional
Value type: <empty>
Definition: The specified pins should be configured as pull up.
- input-enable:
Usage: optional
Value type: <none>
Definition: The specified pins are put in input mode.
- output-high:
Usage: optional
Value type: <none>
Definition: The specified pins are configured in output mode, driven
high.
- output-low:
Usage: optional
Value type: <none>
Definition: The specified pins are configured in output mode, driven
low.
- qcom,drive-strength:
Usage: optional
Value type: <u32>
Definition: Selects the drive strength for the specified pins.
- slew-rate:
Usage: optional
Value type: <u32>
Definition: Selects the slew rate for the specified pins.
Example:
lpi_tlmm: lpi_pinctrl@152c000 {
compatible = "qcom,lpi-pinctrl";
qcom,num-gpios = <32>;
reg = <0x152c000 0>;
qcom,slew-reg = <0x355a000 0x0>;
gpio-controller;
#gpio-cells = <2>;
qcom,lpi-offset-tbl = <0x00000010>, <0x00000020>,
<0x00000030>, <0x00000040>,
<0x00000050>, <0x00000060>,
<0x00000070>, <0x00000080>,
<0x00000090>, <0x00000100>,
<0x00000110>, <0x00000120>,
<0x00000130>, <0x00000140>,
<0x00000150>, <0x00000160>,
<0x00000170>, <0x00000180>,
<0x00000190>, <0x00000200>,
<0x00000210>;
qcom,lpi-slew-offset-tbl = <0x00000000>, <0x00000002>,
<0x00000004>, <0x00000008>,
<0x0000000A>, <0x0000000C>,
<0x00000000>, <0x00000000>,
<0x00000000>, <0x00000000>,
<0x00000010>, <0x00000012>,
<0x00000000>, <0x00000000>;
hph_comp_active: hph_comp_active {
mux {
pins = "gpio22";
function = "func1";
};
config {
pins = "gpio22";
output-high;
qcom,drive-strength = <8>;
};
};
hph_comp_sleep: hph_comp_sleep {
mux {
pins = "gpio22";
function = "func1";
};
config {
pins = "gpio22";
qcom,drive-strength = <2>;
slew-rate = <1>;
};
};
};

2246
bindings/sound/qcom-audio-dev.txt Normal file
View File

File diff suppressed because it is too large Load Diff

411
bindings/sound/wcd_codec.txt Normal file
View File

@@ -0,0 +1,411 @@
Qualcomm Technologies, Inc. WCD audio CODEC
WSA macro in Bolero codec
Required properties:
- compatible = "qcom,wsa-macro";
- reg: Specifies the WSA macro base address for Bolero
soundwire core registers.
- clock-names : clock names defined for WSA macro
- clocks : clock handles defined for WSA macro
- qcom,default-clk-id: Default clk ID used for WSA macro
- qcom,wsa-swr-gpios: phandle for SWR data and clock GPIOs of WSA macro
- qcom,wsa-bcl-pmic-params: u8 array of PMIC ID, SID and PPID in same order
required to be configured to receive interrupts
in BCL block of WSA macro
WSA slave device as child of Bolero codec
Required properties:
- compatible = "qcom,wsa881x";
- reg: Specifies the WSA slave device base address.
- qcom,spkr-sd-n-gpio: speaker reset gpio
Optional properties:
- bolero-handle: phandle to bolero codec
Example:
&bolero {
wsa_macro: wsa-macro {
compatible = "qcom,wsa-macro";
reg = <0x0C2C0000 0x0>;
clock-names = "wsa_core_clk", "wsa_npl_clk";
clocks = <&clock_audio_wsa_1 0>,
<&clock_audio_wsa_2 0>;
qcom,wsa-swr-gpios = &wsa_swr_gpios;
qcom,wsa-bcl-pmic-params = /bits/ 8 <0x00 0x00 0x1E>;
qcom,default-clk-id = <TX_CORE_CLK>;
swr_0: wsa_swr_master {
compatible = "qcom,swr-mstr";
wsa881x_1: wsa881x@20170212 {
compatible = "qcom,wsa881x";
reg = <0x00 0x20170212>;
qcom,spkr-sd-n-gpio = <&tlmm 80 0>;
bolero-handle = <&bolero>;
};
};
};
};
VA macro in bolero codec
Required properties:
- compatible = "qcom,va-macro";
- reg: Specifies the VA macro base address for Bolero
soundwire core registers.
- clock-names : clock names defined for VA macro
- clocks : clock handles defined for VA macro
- qcom,default-clk-id: Default clk ID used for VA macro
- va-vdd-micb-supply： phandle of mic bias supply's regulator device tree node
- qcom,va-vdd-micb-voltage： mic bias supply's voltage level min and max in mV
- qcom,va-vdd-micb-current： mic bias supply's max current in mA
- qcom,va-dmic-sample-rate： Sample rate defined for DMIC connected to VA macro
Optional properties:
- qcom,va-clk-mux-select： VA macro MCLK MUX selection
- qcom,va-island-mode-muxsel： VA macro island mode MUX selection
This property is required if qcom,va-clk-mux-select is provided
Example:
&bolero {
va_macro: va-macro {
compatible = "qcom,va-macro";
reg = <0x0C490000 0x0>;
clock-names = "va_core_clk";
clocks = <&clock_audio_va 0>;
qcom,default-clk-id = <TX_CORE_CLK>;
va-vdd-micb-supply = <&S4A>;
qcom,va-vdd-micb-voltage = <1800000 1800000>;
qcom,va-vdd-micb-current = <11200>;
qcom,va-dmic-sample-rate = <4800000>;
qcom,va-clk-mux-select = <1>;
qcom,va-island-mode-muxsel = <0x033A0000>;
};
};
RX macro in bolero codec
Required properties:
- compatible = "qcom,rx-macro";
- reg: Specifies the Rx macro base address for Bolero
soundwire core registers.
- clock-names : clock names defined for RX macro
- clocks : clock handles defined for RX macro
- qcom,default-clk-id: Default clk ID used for RX macro
- qcom,rx-swr-gpios: phandle for SWR data and clock GPIOs of RX macro
- qcom,rx_mclk_mode_muxsel: register address for RX macro MCLK mode mux select
- qcom,rx-bcl-pmic-params: u8 array of PMIC ID, SID and PPID in same order
required to be configured to receive interrupts
in BCL block of WSA macro
Example:
&bolero {
rx_macro: rx-macro {
compatible = "qcom,rx-macro";
reg = <0x62EE0000 0x0>;
clock-names = "rx_core_clk", "rx_npl_clk";
clocks = <&clock_audio_rx_1 0>,
<&clock_audio_rx_2 0>;
qcom,rx-swr-gpios = <&rx_swr_gpios>;
qcom,rx_mclk_mode_muxsel = <0x62C25020>;
qcom,rx-bcl-pmic-params = /bits/ 8 <0x00 0x00 0x1E>;
qcom,default-clk-id = <TX_CORE_CLK>;
swr_1: rx_swr_master {
compatible = "qcom,swr-mstr";
wcd938x_rx_slave: wcd938x-rx-slave {
compatible = "qcom,wcd938x-slave";
};
};
};
};
TX macro in bolero codec
Required properties:
- compatible = "qcom,tx-macro";
- reg: Specifies the Tx macro base address for Bolero
soundwire core registers.
- clock-names : clock names defined for TX macro
- clocks : clock handles defined for TX macro
- qcom,tx-swr-gpios: phandle for SWR data and clock GPIOs of TX macro
- qcom,tx-dmic-sample-rate: Sample rate defined for DMICs connected to TX macro
Optional properties:
- compatible = "qcom,swr-mstr";
- Child of TX macro represent TX SWR master.
- qcom,swrm-hctl-reg: HW_CTL and CLK_ENABLE bits of SWR module.
Need Disable HW_CTL bit(to gate HW control)
for particular Soundwire master version as SW workaround.
Example:
&bolero {
tx_macro: tx-macro {
compatible = "qcom,tx-macro";
reg = <0x62EC0000 0x0>;
clock-names = "tx_core_clk", "tx_npl_clk";
clocks = <&clock_audio_tx_1 0>
<&clock_audio_tx_2 0>;
qcom,tx-swr-gpios = <&tx_swr_gpios>;
qcom,tx-dmic-sample-rate = <4800000>;
swr_2: tx_swr_master {
compatible = "qcom,swr-mstr";
qcom,swrm-hctl-reg = <0xa53a400>;
wcd938x_tx_slave: wcd938x-tx-slave {
compatible = "qcom,wcd938x-slave";
};
};
};
};
&bolero {
rx_macro: rx-macro {
compatible = "qcom,tx-macro";
reg = <0x62EC0000 0x0>;
clock-names = "rx_core_clk", "rx_npl_clk";
clocks = <&clock_audio_rx_1 0>
<&clock_audio_rx_2 0>;
qcom,rx-swr-gpios = <&rx_swr_gpios>;
swr_2: rx_swr_master {
compatible = "qcom,swr-mstr";
wcd937x_rx_slave: wcd937x-rx-slave {
compatible = "qcom,wcd937x-slave";
};
};
};
};
Tanggu Codec
Required properties:
- compatible: "qcom,wcd937x-codec";
- qcom,rx_swr_ch_map: mapping of swr rx slave port configuration to port_type and also
corresponding master port type it need to attach.
format: <port_id, slave_port_type, ch_mask, ch_rate, master_port_type>
same port_id configurations have to be grouped, and in ascending order.
- qcom,tx_swr_ch_map: mapping of swr tx slave port configuration to port_type and also
corresponding master port type it need to attach.
format: <port_id,slave_port_type, ch_mask, ch_rate, master_port_type>
same port_id configurations have to be grouped, and in ascending order.
- qcom,wcd-rst-gpio-node: Phandle reference to the DT node having codec reset gpio
configuration. If this property is not defined, it is
expected to atleast define "qcom,cdc-reset-gpio" property.
- qcom,rx-slave: phandle reference of Soundwire Rx slave device.
- qcom,tx-slave: phandle reference of Soundwire Tx slave device.
Optional properties:
- cdc-vdd-rxtx-supply: phandle of rxtx supply's regulator device tree node.
- qcom,cdc-vdd-rxtx-voltage: rxtx supply's voltage level min and max in mV.
- qcom,cdc-vdd-rxtx-current: rxtx supply's max current in mA.
- cdc-vddio-supply: phandle of io supply's regulator device tree node.
- qcom,cdc-vddio-voltage: io supply's voltage level min and max in mV.
- qcom,cdc-vddio-current: io supply's max current in mA.
- cdc-vdd-buck-supply: phandle of buck supply's regulator device tree node.
- qcom,cdc-vdd-buck-voltage: buck supply's voltage level min and max in mV.
- qcom,cdc-vdd-buck-current: buck supply's max current in mA.
- cdc-vdd-mic-bias-supply: phandle of mic bias supply's regulator device tree node.
- qcom,cdc-vdd-mic-bias-voltage: mic bias supply's voltage level min and max in mV.
- qcom,cdc-vdd-mic-bias-current: mic bias supply's max current in mA.
- qcom,cdc-static-supplies: List of supplies to be enabled prior to codec
hardware probe. Supplies in this list will be
stay enabled.
- qcom,cdc-on-demand-supplies: List of supplies which can be enabled
dynamically.
Supplies in this list are off by default.
Example:
wcd937x_codec: wcd937x-codec {
compatible = "qcom,wcd937x-codec";
qcom,rx_swr_ch_map = <0 HPH_L 0x1 0 HPH_L>,
<0 HPH_R 0x2 0 HPH_R>, <1 CLSH 0x3 0 CLSH>,
<2 COMP_L 0x1 0 COMP_L>, <2 COMP_R 0x2 0 COMP_R>,
<3 LO 0x1 0 LO>, <4 DSD_L 0x1 0 DSD_L>,
<4 DSD_R 0x2 0 DSD_R>;
qcom,tx_swr_ch_map = <0 ADC1 0x1 0 ADC1>,
<1 ADC2 0x1 0 ADC3>, <1 ADC3 0x2 0 ADC4>,
<2 DMIC0 0x1 0 DMIC0>, <2 DMIC1 0x2 0 DMIC1>,
<2 MBHC 0x4 0 DMIC2>, <3 DMIC2 0x1 0 DMIC4>,
<3 DMIC3 0x2 0 DMIC5>, <3 DMIC4 0x4 0 DMIC6>,
<3 DMIC5 0x8 0 DMIC7>;
qcom,wcd-rst-gpio-node = <&wcd937x_rst_gpio>;
qcom,rx-slave = <&wcd937x_rx_slave>;
qcom,tx-slave = <&wcd937x_tx_slave>;
cdc-vdd-buck-supply = <&S4A>;
qcom,cdc-vdd-buck-voltage = <1800000 1800000>;
qcom,cdc-vdd-buck-current = <650000>;
cdc-vdd-rxtx-supply = <&S4A>;
qcom,cdc-vdd-rxtx-voltage = <1800000 1800000>;
qcom,cdc-vdd-rxtx-current = <30000>;
cdc-vddio-supply = <&S4A>;
qcom,cdc-vddio-voltage = <1800000 1800000>;
qcom,cdc-vddio-current = <30000>;
cdc-vdd-mic-bias-supply = <&BOB>;
qcom,cdc-vdd-mic-bias-voltage = <3296000 3296000>;
qcom,cdc-vdd-mic-bias-current = <30000>;
qcom,cdc-static-supplies = "cdc-vdd-rxtx",
"cdc-vddio";
qcom,cdc-on-demand-supplies = "cdc-vdd-buck",
"cdc-vdd-mic-bias";
};
Traverso Codec
Required properties:
- compatible: "qcom,wcd938x-codec";
- qcom,rx_swr_ch_map: mapping of swr rx slave port configuration to port_type and also
corresponding master port type it need to attach.
format: <port_id, slave_port_type, ch_mask, ch_rate, master_port_type>
same port_id configurations have to be grouped, and in ascending order.
- qcom,tx_swr_ch_map: mapping of swr tx slave port configuration to port_type and also
corresponding master port type it need to attach.
format: <port_id,slave_port_type, ch_mask, ch_rate, master_port_type>
same port_id configurations have to be grouped, and in ascending order.
- qcom,wcd-rst-gpio-node: Phandle reference to the DT node having codec reset gpio
configuration. If this property is not defined, it is
expected to atleast define "qcom,cdc-reset-gpio" property.
- qcom,rx-slave: phandle reference of Soundwire Rx slave device.
- qcom,tx-slave: phandle reference of Soundwire Tx slave device.
Optional properties:
- cdc-vdd-rxtx-supply: phandle of rxtx supply's regulator device tree node.
- qcom,cdc-vdd-rxtx-voltage: rxtx supply's voltage level min and max in mV.
- qcom,cdc-vdd-rxtx-current: rxtx supply's max current in mA.
- cdc-vddio-supply: phandle of io supply's regulator device tree node.
- qcom,cdc-vddio-voltage: io supply's voltage level min and max in mV.
- qcom,cdc-vddio-current: io supply's max current in mA.
- cdc-vdd-buck-supply: phandle of buck supply's regulator device tree node.
- qcom,cdc-vdd-buck-voltage: buck supply's voltage level min and max in mV.
- qcom,cdc-vdd-buck-current: buck supply's max current in mA.
- cdc-vdd-mic-bias-supply: phandle of mic bias supply's regulator device tree node.
- qcom,cdc-vdd-mic-bias-voltage: mic bias supply's voltage level min and max in mV.
- qcom,cdc-vdd-mic-bias-current: mic bias supply's max current in mA.
- qcom,cdc-static-supplies: List of supplies to be enabled prior to codec
hardware probe. Supplies in this list will be
stay enabled.
- qcom,cdc-on-demand-supplies: List of supplies which can be enabled
dynamically.
Supplies in this list are off by default.
Example:
wcd938x_codec: wcd938x-codec {
compatible = "qcom,wcd938x-codec";
qcom,rx_swr_ch_map = <0 HPH_L 0x1 0 HPH_L>,
<0 HPH_R 0x2 0 HPH_R>, <1 CLSH 0x3 0 CLSH>,
<2 COMP_L 0x1 0 COMP_L>, <2 COMP_R 0x2 0 COMP_R>,
<3 LO 0x1 0 LO>, <4 DSD_L 0x1 0 DSD_L>,
<4 DSD_R 0x2 0 DSD_R>;
qcom,tx_swr_ch_map = <0 ADC1 0x1 0 ADC1>,
<1 ADC2 0x1 0 ADC3>, <1 ADC3 0x2 0 ADC4>,
<2 DMIC0 0x1 0 DMIC0>, <2 DMIC1 0x2 0 DMIC1>,
<2 MBHC 0x4 0 DMIC2>, <3 DMIC2 0x1 0 DMIC4>,
<3 DMIC3 0x2 0 DMIC5>, <3 DMIC4 0x4 0 DMIC6>,
<3 DMIC5 0x8 0 DMIC7>;
qcom,wcd-rst-gpio-node = <&wcd938x_rst_gpio>;
qcom,rx-slave = <&wcd938x_rx_slave>;
qcom,tx-slave = <&wcd938x_tx_slave>;
cdc-vdd-buck-supply = <&S4A>;
qcom,cdc-vdd-buck-voltage = <1800000 1800000>;
qcom,cdc-vdd-buck-current = <650000>;
cdc-vdd-rxtx-supply = <&S4A>;
qcom,cdc-vdd-rxtx-voltage = <1800000 1800000>;
qcom,cdc-vdd-rxtx-current = <30000>;
cdc-vddio-supply = <&S4A>;
qcom,cdc-vddio-voltage = <1800000 1800000>;
qcom,cdc-vddio-current = <30000>;
cdc-vdd-mic-bias-supply = <&BOB>;
qcom,cdc-vdd-mic-bias-voltage = <3296000 3296000>;
qcom,cdc-vdd-mic-bias-current = <30000>;
qcom,cdc-static-supplies = "cdc-vdd-rxtx",
"cdc-vddio";
qcom,cdc-on-demand-supplies = "cdc-vdd-buck",
"cdc-vdd-mic-bias";
};
Bolero Clock Resource Manager
Required Properties:
- compatible = "qcom,bolero-clk-rsc-mngr";
- qcom,fs-gen-sequence: Register sequence for fs clock generation
- clock-names : clock names defined for WSA macro
- clocks : clock handles defined for WSA macro
Optional Properties:
- qcom,rx_mclk_mode_muxsel: register address for RX macro MCLK mode mux select
- qcom,wsa_mclk_mode_muxsel: register address for WSA macro MCLK mux select
- qcom,va_mclk_mode_muxsel: register address for VA macro MCLK mode mux select
Example:
&bolero {
bolero-clock-rsc-manager {
compatible = "qcom,bolero-clk-rsc-mngr";
qcom,fs-gen-sequence = <0x3000 0x1>,
<0x3004 0x1>, <0x3080 0x2>;
qcom,rx_mclk_mode_muxsel = <0x033240D8>;
qcom,wsa_mclk_mode_muxsel = <0x033220D8>;
qcom,va_mclk_mode_muxsel = <0x033A0000>;
clock-names = "tx_core_clk", "tx_npl_clk", "rx_core_clk",
"rx_npl_clk", "wsa_core_clk", "wsa_npl_clk",
"va_core_clk", "va_npl_clk";
clocks = <&clock_audio_tx_1 0>, <&clock_audio_tx_2 0>,
<&clock_audio_rx_1 0>, <&clock_audio_rx_2 0>,
<&clock_audio_wsa_1 0>, <&clock_audio_wsa_2 0>,
<&clock_audio_va_1 0>, <&clock_audio_va_2 0>;
};
};
WSA Analog Codec
Required Properties:
- compatible = "qcom,wsa881x-i2c-codec";
- reg: Specifies the I2C chip address.
- clock-names : clock names defined for WSA master clock
- clocks : clock handles defined for WSA master clock
- qcom,wsa-analog-clk-gpio: Specificies WSA_MCLK GPIO handle
- qcom,wsa-analog-reset-gpio: Specifies WSA reset GPIO handle
Optional Properties:
- qcom,wsa-analog-vi-gpio: Specifies WSA VI sense GPIO handle
Example:
&qupv3_se1_i2c {
wsa881x_i2c_f: wsa881x-i2c-codec@f {
compatible = "qcom,wsa881x-i2c-codec";
reg = <0x0f>;
clock-names = "wsa_mclk";
clocks = <&wsa881x_analog_clk 0>;
qcom,wsa-analog-clk-gpio = <&wsa881x_analog_clk_gpio>;
qcom,wsa-analog-reset-gpio = <&wsa881x_analog_reset_gpio>;
};
wsa881x_i2c_45: wsa881x-i2c-codec@45 {
compatible = "qcom,wsa881x-i2c-codec";
reg = <0x045>;
};
};