Merge series "ASoC: qcom: Add AudioReach support" from Srinivas Kandagatla...

Qualcomm APR (Asynchronous Packet Router) binding

This binding describes the Qualcomm APR. APR is a IPC protocol for

communication between Application processor and QDSP. APR is mainly

used for audio/voice services on the QDSP.

- compatible:

	Usage: required

	Value type: <stringlist>

	Definition: must be "qcom,apr-v<VERSION-NUMBER>", example "qcom,apr-v2"

- qcom,apr-domain

	Usage: required

	Value type: <u32>

	Definition: Destination processor ID.

	Possible values are :

			1 - APR simulator

			2 - PC

			3 - MODEM

			4 - ADSP

			5 - APPS

			6 - MODEM2

			7 - APPS2

= APR SERVICES

Each subnode of the APR node represents service tied to this apr. The name

of the nodes are not important. The properties of these nodes are defined

by the individual bindings for the specific service

- All APR services MUST contain the following property:

- reg

	Usage: required

	Value type: <u32>

	Definition: APR Service ID

	Possible values are :

			3 - DSP Core Service

			4 - Audio Front End Service.

			5 - Voice Stream Manager Service.

			6 - Voice processing manager.

			7 - Audio Stream Manager Service.

			8 - Audio Device Manager Service.

			9 - Multimode voice manager.

			10 - Core voice stream.

			11 - Core voice processor.

			12 - Ultrasound stream manager.

			13 - Listen stream manager.

- qcom,protection-domain

	Usage: optional

	Value type: <stringlist>

	Definition: Must list the protection domain service name and path

		    that the particular apr service has a dependency on.

	Possible values are :

			"avs/audio", "msm/adsp/audio_pd".

			"kernel/elf_loader", "msm/modem/wlan_pd".

			"tms/servreg", "msm/adsp/audio_pd".

			"tms/servreg", "msm/modem/wlan_pd".

			"tms/servreg", "msm/slpi/sensor_pd".

= EXAMPLE

The following example represents a QDSP based sound card on a MSM8996 device

which uses apr as communication between Apps and QDSP.

	apr {

		compatible = "qcom,apr-v2";

		qcom,apr-domain = <APR_DOMAIN_ADSP>;

		apr-service@3 {

			compatible = "qcom,q6core";

			reg = <APR_SVC_ADSP_CORE>;

		};

		apr-service@4 {

			compatible = "qcom,q6afe";

			reg = <APR_SVC_AFE>;

			dais {

				#sound-dai-cells = <1>;

				dai@1 {

					reg = <HDMI_RX>;

				};

			};

		};

		apr-service@7 {

			compatible = "qcom,q6asm";

			reg = <APR_SVC_ASM>;

			...

		};

		apr-service@8 {

			compatible = "qcom,q6adm";

			reg = <APR_SVC_ADM>;

			...

		};

	};

= EXAMPLE 2

The following example represents a QDSP based sound card with protection domain

dependencies specified. Here some of the apr services are dependent on services

running on protection domain hosted on ADSP/SLPI remote processors while others

have no such dependency.

	apr {

		compatible = "qcom,apr-v2";

		qcom,glink-channels = "apr_audio_svc";

		qcom,apr-domain = <APR_DOMAIN_ADSP>;

		apr-service@3 {

			compatible = "qcom,q6core";

			reg = <APR_SVC_ADSP_CORE>;

		};

		q6afe: apr-service@4 {

			compatible = "qcom,q6afe";

			reg = <APR_SVC_AFE>;

			qcom,protection-domain = "avs/audio", "msm/adsp/audio_pd";

			...

		};

		q6asm: apr-service@7 {

			compatible = "qcom,q6asm";

			reg = <APR_SVC_ASM>;

			qcom,protection-domain = "tms/servreg", "msm/slpi/sensor_pd";

			...

		};

		q6adm: apr-service@8 {

			compatible = "qcom,q6adm";

			reg = <APR_SVC_ADM>;

			qcom,protection-domain = "avs/audio", "msm/adsp/audio_pd";

			...

		};

	};

# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)

%YAML 1.2

---

$id: "http://devicetree.org/schemas/soc/qcom/qcom,apr.yaml#"

$schema: "http://devicetree.org/meta-schemas/core.yaml#"

title: Qualcomm APR/GPR (Asynchronous/Generic Packet Router) binding

maintainers:

  - Srinivas Kandagatla <srinivas.kandagatla@linaro.org>

description: |

  This binding describes the Qualcomm APR/GPR, APR/GPR is a IPC protocol for

  communication between Application processor and QDSP. APR/GPR is mainly

  used for audio/voice services on the QDSP.

properties:

  compatible:

    enum:

      - qcom,apr-v2

      - qcom,gpr

  qcom,apr-domain:

    $ref: /schemas/types.yaml#/definitions/uint32

    enum: [1, 2, 3, 4, 5, 6, 7]

    description:

      Selects the processor domain for apr

        1 = APR simulator

        2 = PC Domain

        3 = Modem Domain

        4 = ADSP Domain

        5 = Application processor Domain

        6 = Modem2 Domain

        7 = Application Processor2 Domain

    deprecated: true

  qcom,domain:

    $ref: /schemas/types.yaml#/definitions/uint32

    minimum: 1

    maximum: 7

    description:

      Selects the processor domain for apr

        1 = APR simulator

        2 = PC Domain

        3 = Modem Domain

        4 = ADSP Domain

        5 = Application processor Domain

        6 = Modem2 Domain

        7 = Application Processor2 Domain

      Selects the processor domain for gpr

        1 = Modem Domain

        2 = Audio DSP Domain

        3 = Application Processor Domain

  '#address-cells':

    const: 1

  '#size-cells':

    const: 0

#APR/GPR Services

patternProperties:

  "^service@[1-9a-d]$":

    type: object

    description:

      APR/GPR node's client devices use subnodes for desired static port services.

    properties:

      compatible:

        enum:

          - qcom,q6core

          - qcom,q6asm

          - qcom,q6afe

          - qcom,q6adm

          - qcom,q6apm

          - qcom,q6prm

      reg:

        minimum: 1

        maximum: 13

        description:

          APR Service ID

            3 = DSP Core Service

            4 = Audio  Front End Service.

            5 = Voice Stream Manager Service.

            6 = Voice processing manager.

            7 = Audio Stream Manager Service.

            8 = Audio Device Manager Service.

            9 = Multimode voice manager.

            10 = Core voice stream.

            11 = Core voice processor.

            12 = Ultrasound stream manager.

            13 = Listen stream manager.

          GPR Service ID

            1 = Audio Process Manager Service

            2 = Proxy Resource Manager Service.

            3 = AMDB Service.

            4 = Voice processing manager.

      qcom,protection-domain:

        $ref: /schemas/types.yaml#/definitions/string-array

        description: protection domain service name and path for apr service

          possible values are

          "avs/audio", "msm/adsp/audio_pd".

          "kernel/elf_loader", "msm/modem/wlan_pd".

          "tms/servreg", "msm/adsp/audio_pd".

          "tms/servreg", "msm/modem/wlan_pd".

          "tms/servreg", "msm/slpi/sensor_pd".

      '#address-cells':

        const: 1

      '#size-cells':

        const: 0

    patternProperties:

      "^.*@[0-9a-f]+$":

        type: object

        description:

          Service based devices like clock controllers or digital audio interfaces.

    additionalProperties: false

required:

  - compatible

  - qcom,domain

additionalProperties: false

examples:

  - |

    #include <dt-bindings/soc/qcom,apr.h>

    apr {

        compatible = "qcom,apr-v2";

        qcom,domain = <APR_DOMAIN_ADSP>;

        #address-cells = <1>;

        #size-cells = <0>;

        q6core: service@3 {

          compatible = "qcom,q6core";

          reg = <APR_SVC_ADSP_CORE>;

          qcom,protection-domain = "avs/audio", "msm/adsp/audio_pd";

        };

        q6afe: service@4 {

          compatible = "qcom,q6afe";

          reg = <APR_SVC_AFE>;

          qcom,protection-domain = "avs/audio", "msm/adsp/audio_pd";

        };

        q6asm: service@7 {

          compatible = "qcom,q6asm";

          reg = <APR_SVC_ASM>;

          qcom,protection-domain = "avs/audio", "msm/adsp/audio_pd";

        };

        q6adm: service@8 {

          compatible = "qcom,q6adm";

          reg = <APR_SVC_ADM>;

          qcom,protection-domain = "avs/audio", "msm/adsp/audio_pd";

        };

    };

  - |

    #include <dt-bindings/soc/qcom,gpr.h>

    gpr {

        compatible = "qcom,gpr";

        qcom,domain = <GPR_DOMAIN_ID_ADSP>;

        #address-cells = <1>;

        #size-cells = <0>;

        service@1 {

          compatible = "qcom,q6apm";

          reg = <GPR_APM_MODULE_IID>;

          qcom,protection-domain = "avs/audio", "msm/adsp/audio_pd";

        };

    };

		  from DSP.

		  example "qcom,q6afe"

= AFE DAIs (Digital Audio Interface)

"dais" subnode of the AFE node. It represents afe dais, each afe dai is a

subnode of "dais" representing board specific dai setup.

"dais" node should have following properties followed by dai children.

- compatible:

	Usage: required

	Value type: <stringlist>

	Definition: must be "qcom,q6afe-dais"

- #sound-dai-cells

	Usage: required

	Value type: <u32>

	Definition: Must be 1

- #address-cells

	Usage: required

	Value type: <u32>

	Definition: Must be 1

- #size-cells

	Usage: required

	Value type: <u32>

	Definition: Must be 0

== AFE DAI is subnode of "dais" and represent a dai, it includes board specific

configuration of each dai. Must contain the following properties.

- reg

	Usage: required

	Value type: <u32>

	Definition: Must be dai id

- qcom,sd-lines

	Usage: required for mi2s interface

	Value type: <prop-encoded-array>

	Definition: Must be list of serial data lines used by this dai.

	should be one or more of the 0-3 sd lines.

 - qcom,tdm-sync-mode:

	Usage: required for tdm interface

	Value type: <prop-encoded-array>

	Definition: Synchronization mode.

		0 - Short sync bit mode

		1 - Long sync mode

		2 - Short sync slot mode

 - qcom,tdm-sync-src:

	Usage: required for tdm interface

	Value type: <prop-encoded-array>

	Definition: Synchronization source.

		0 - External source

		1 - Internal source

 - qcom,tdm-data-out:

	Usage: required for tdm interface

	Value type: <prop-encoded-array>

	Definition: Data out signal to drive with other masters.

		0 - Disable

		1 - Enable

 - qcom,tdm-invert-sync:

	Usage: required for tdm interface

	Value type: <prop-encoded-array>

	Definition: Invert the sync.

		0 - Normal

		1 - Invert

 - qcom,tdm-data-delay:

	Usage: required for tdm interface

	Value type: <prop-encoded-array>

	Definition: Number of bit clock to delay data

		with respect to sync edge.

		0 - 0 bit clock cycle

		1 - 1 bit clock cycle

		2 - 2 bit clock cycle

 - qcom,tdm-data-align:

	Usage: required for tdm interface

	Value type: <prop-encoded-array>

	Definition: Indicate how data is packed

		within the slot. For example, 32 slot width in case of

		sample bit width is 24.

		0 - MSB

		1 - LSB

= AFE CLOCKSS

"clocks" subnode of the AFE node. It represents q6afe clocks

"clocks" node should have following properties.

- compatible:

	Usage: required

	Value type: <stringlist>

	Definition: must be "qcom,q6afe-clocks"

- #clock-cells:

	Usage: required

	Value type: <u32>

	Definition: Must be 2. Clock Id followed by

		below valid clock coupling attributes.

		1 - for no coupled clock

		2 - for dividend of the coupled clock

		3 - for divisor of the coupled clock

		4 - for inverted and no couple clock

= EXAMPLE

apr-service@4 {

	compatible = "qcom,q6afe";

	reg = <APR_SVC_AFE>;

	dais {

		compatible = "qcom,q6afe-dais";

		#sound-dai-cells = <1>;

		#address-cells = <1>;

		#size-cells = <0>;

		dai@1 {

			reg = <HDMI_RX>;

		};

		dai@24 {

			reg = <PRIMARY_TDM_RX_0>;

			qcom,tdm-sync-mode = <1>:

			qcom,tdm-sync-src = <1>;

			qcom,tdm-data-out = <0>;

			qcom,tdm-invert-sync = <1>;

			qcom,tdm-data-delay = <1>;

			qcom,tdm-data-align = <0>;

		};

		dai@25 {

			reg = <PRIMARY_TDM_TX_0>;

			qcom,tdm-sync-mode = <1>:

			qcom,tdm-sync-src = <1>;

			qcom,tdm-data-out = <0>;

			qcom,tdm-invert-sync = <1>;

			qcom,tdm-data-delay <1>:

			qcom,tdm-data-align = <0>;

		};

		dai@16 {

			reg = <PRIMARY_MI2S_RX>;

			qcom,sd-lines = <0 2>;

		};

		dai@17 {

			reg = <PRIMARY_MI2S_TX>;

			qcom,sd-lines = <1>;

		};

		dai@18 {

			reg = <SECONDARY_MI2S_RX>;

			qcom,sd-lines = <0 3>;

		};

		dai@19 {

			reg = <SECONDARY_MI2S_TX>;

			qcom,sd-lines = <1>;

		};

		dai@20 {

			reg = <TERTIARY_MI2S_RX>;

			qcom,sd-lines = <1 3>;

		};

		dai@21 {

			reg = <TERTIARY_MI2S_TX>;

			qcom,sd-lines = <0>;

		};

		dai@22 {

			reg = <QUATERNARY_MI2S_RX>;

			qcom,sd-lines = <0>;

		};

		dai@23 {

			reg = <QUATERNARY_MI2S_TX>;

			qcom,sd-lines = <1>;

		};

	};

	clocks {

		compatible = "qcom,q6afe-clocks";

		#clock-cells = <2>;

	};

};

# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)

%YAML 1.2

---

$id: "http://devicetree.org/schemas/sound/qcom,q6apm-dai.yaml#"

$schema: "http://devicetree.org/meta-schemas/core.yaml#"

title: Qualcomm Audio Process Manager Digital Audio Interfaces binding

maintainers:

  - Srinivas Kandagatla <srinivas.kandagatla@linaro.org>

description: |

  This binding describes the Qualcomm APM DAIs in DSP

properties:

  compatible:

    const: qcom,q6apm-dais

  reg:

    maxItems: 1

  iommus:

    maxItems: 1

required:

  - compatible

  - iommus

  - reg

additionalProperties: false

examples:

  - |

    #include <dt-bindings/soc/qcom,gpr.h>

    gpr {

        compatible = "qcom,gpr";

        #address-cells = <1>;

        #size-cells = <0>;

        qcom,domain = <GPR_DOMAIN_ID_ADSP>;

        service@1 {

          compatible = "qcom,q6apm";

          reg = <1>;

          #address-cells = <1>;

          #size-cells = <0>;

          apm-dai@1 {

            compatible = "qcom,q6apm-dais";

            iommus = <&apps_smmu 0x1801 0x0>;

            reg = <1>;

          };

        };

    };

# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)

%YAML 1.2

---

$id: "http://devicetree.org/schemas/sound/qcom,q6dsp-lpass-clocks.yaml#"

$schema: "http://devicetree.org/meta-schemas/core.yaml#"

title: Qualcomm DSP LPASS Clock Controller binding

maintainers:

  - Srinivas Kandagatla <srinivas.kandagatla@linaro.org>

description: |

  This binding describes the Qualcomm DSP Clock Controller

properties:

  compatible:

    enum:

      - qcom,q6afe-clocks

      - qcom,q6prm-lpass-clocks

  reg:

    maxItems: 1

  '#clock-cells':

    const: 2

    description:

      Clock Id is followed by clock coupling attributes.

        1 = for no coupled clock

        2 = for dividend of the coupled clock

        3 = for divisor of the coupled clock

        4 = for inverted and no couple clock

required:

  - compatible

  - reg

  - "#clock-cells"

additionalProperties: false

examples:

  - |

    #include <dt-bindings/soc/qcom,apr.h>

    #include <dt-bindings/sound/qcom,q6afe.h>

    apr {

        #address-cells = <1>;

        #size-cells = <0>;

        apr-service@4 {

            reg = <APR_SVC_AFE>;

            #address-cells = <1>;

            #size-cells = <0>;

            clock-controller@2 {

              compatible = "qcom,q6afe-clocks";

              reg = <2>;

              #clock-cells = <2>;

            };

        };

      };

  - |

    #include <dt-bindings/soc/qcom,gpr.h>

    gpr {

        compatible = "qcom,gpr";

        qcom,domain = <GPR_DOMAIN_ID_ADSP>;

        #address-cells = <1>;

        #size-cells = <0>;

        service@2 {

            reg = <GPR_PRM_MODULE_IID>;

            compatible = "qcom,q6prm";

            #address-cells = <1>;

            #size-cells = <0>;

            clock-controller@2 {

              compatible = "qcom,q6prm-lpass-clocks";

              reg = <2>;

              #clock-cells = <2>;

            };

        };

      };