[PATCH v7 0/3] Add documentation and machine driver for SC7180 sound card
Note: - The machine driver patch is made by the collaboration of Cheng-Yi Chiang cychiang@chromium.org Rohit kumar rohitkr@codeaurora.org Ajit Pandey ajitp@codeaurora.org But Ajit has left codeaurora. - This patch series needs HDMI DAI name defined in sc7180-lpass.h. https://patchwork.kernel.org/patch/11745565/
Changes from v1 to v2: - Ducumentation: Addressed all suggestions from Doug. - Machine driver: - Fix comment style for license. - Sort includes. - Remove sc7180_snd_hw_params. - Remove sc7180_dai_init and use aux device instead for headset jack registration. - Statically define format for Primary MI2S. - Atomic is not a concern because there is mutex in card to make sure startup and shutdown happen sequentially. - Fix missing return -EINVAL in startup. - Use static sound card. - Use devm_kzalloc to avoid kfree.
Changes from v2 to v3: - Ducumentation: Addressed suggestions from Srini. - Machine driver: - Reuse qcom_snd_parse_of to parse properties. - Remove playback-only and capture-only. - Misc fixes to address comments.
Changes from v3 to v4: - Ducumentation: Addressed suggestions from Rob. - Remove definition of dai. - Use 'sound-dai: true' for sound-dai schema. - Add reg property to pass 'make dt_binding_check' check although reg is not used in the driver. - Machine driver: - Add Reviewed-by: Tzung-Bi Shih tzungbi@google.com
Changes from v4 to v5: - Documentation: Addressed suggestions from Rob. - Add definition for "#address-cells" and "#size-cells". - Add additionalProperties: false - Add required properties.
Changes from v5 to v6: - Documentation: Addressed suggestions from Rob. - Drop contains in compatible strings. - Only allow dai-link@[0-9] - Remove reg ref since it has a type definition already.
Changes from v6 to v7 - Documentation: - Add headset-jack and hdmi-jack to specify the codec responsible for jack detection. - HDMI codec driver: - Use component set_jack ops instead of exporting hdmi_codec_set_jack_detect. - Machine driver: - Removed aux device following Stephan's suggestion. - Use headset-jack and hdmi-jack to specify the codec responsible for jack detection. - Add support for HDMI(actually DP) playback.
Ajit Pandey (1): ASoC: qcom: sc7180: Add machine driver for sound card registration
Cheng-Yi Chiang (2): ASoC: hdmi-codec: Use set_jack ops to set jack ASoC: qcom: dt-bindings: Add sc7180 machine bindings
.../bindings/sound/qcom,sc7180.yaml | 143 +++++++++ include/sound/hdmi-codec.h | 3 - sound/soc/codecs/hdmi-codec.c | 12 +- sound/soc/mediatek/mt8173/mt8173-rt5650.c | 5 +- .../mediatek/mt8183/mt8183-da7219-max98357.c | 5 +- .../mt8183/mt8183-mt6358-ts3a227-max98357.c | 5 +- sound/soc/qcom/Kconfig | 12 + sound/soc/qcom/Makefile | 2 + sound/soc/qcom/sc7180.c | 288 ++++++++++++++++++ sound/soc/rockchip/rockchip_max98090.c | 3 +- 10 files changed, 456 insertions(+), 22 deletions(-) create mode 100644 Documentation/devicetree/bindings/sound/qcom,sc7180.yaml create mode 100644 sound/soc/qcom/sc7180.c
Use set_jack ops to set jack so machine drivers do not need to include hdmi-codec.h explicitly.
Signed-off-by: Cheng-Yi Chiang cychiang@chromium.org --- include/sound/hdmi-codec.h | 3 --- sound/soc/codecs/hdmi-codec.c | 12 ++++-------- sound/soc/mediatek/mt8173/mt8173-rt5650.c | 5 ++--- sound/soc/mediatek/mt8183/mt8183-da7219-max98357.c | 5 ++--- .../mediatek/mt8183/mt8183-mt6358-ts3a227-max98357.c | 5 ++--- sound/soc/rockchip/rockchip_max98090.c | 3 +-- 6 files changed, 11 insertions(+), 22 deletions(-)
diff --git a/include/sound/hdmi-codec.h b/include/sound/hdmi-codec.h index 7754631a3102..b55970859a13 100644 --- a/include/sound/hdmi-codec.h +++ b/include/sound/hdmi-codec.h @@ -117,9 +117,6 @@ struct hdmi_codec_pdata { struct snd_soc_component; struct snd_soc_jack;
-int hdmi_codec_set_jack_detect(struct snd_soc_component *component, - struct snd_soc_jack *jack); - #define HDMI_CODEC_DRV_NAME "hdmi-audio-codec"
#endif /* __HDMI_CODEC_H__ */ diff --git a/sound/soc/codecs/hdmi-codec.c b/sound/soc/codecs/hdmi-codec.c index 8c6f540533ba..d1de5bcd5daa 100644 --- a/sound/soc/codecs/hdmi-codec.c +++ b/sound/soc/codecs/hdmi-codec.c @@ -698,13 +698,9 @@ static void plugged_cb(struct device *dev, bool plugged) hdmi_codec_jack_report(hcp, 0); }
-/** - * hdmi_codec_set_jack_detect - register HDMI plugged callback - * @component: the hdmi-codec instance - * @jack: ASoC jack to report (dis)connection events on - */ -int hdmi_codec_set_jack_detect(struct snd_soc_component *component, - struct snd_soc_jack *jack) +static int hdmi_codec_set_jack_detect(struct snd_soc_component *component, + struct snd_soc_jack *jack, + void *data) { struct hdmi_codec_priv *hcp = snd_soc_component_get_drvdata(component); int ret = -EOPNOTSUPP; @@ -720,7 +716,6 @@ int hdmi_codec_set_jack_detect(struct snd_soc_component *component, } return ret; } -EXPORT_SYMBOL_GPL(hdmi_codec_set_jack_detect);
static int hdmi_dai_spdif_probe(struct snd_soc_dai *dai) { @@ -806,6 +801,7 @@ static const struct snd_soc_component_driver hdmi_driver = { .use_pmdown_time = 1, .endianness = 1, .non_legacy_dai_naming = 1, + .set_jack = hdmi_codec_set_jack_detect, };
static int hdmi_codec_probe(struct platform_device *pdev) diff --git a/sound/soc/mediatek/mt8173/mt8173-rt5650.c b/sound/soc/mediatek/mt8173/mt8173-rt5650.c index 347b095d478d..c28ebf891cb0 100644 --- a/sound/soc/mediatek/mt8173/mt8173-rt5650.c +++ b/sound/soc/mediatek/mt8173/mt8173-rt5650.c @@ -11,7 +11,6 @@ #include <linux/of_gpio.h> #include <sound/soc.h> #include <sound/jack.h> -#include <sound/hdmi-codec.h> #include "../../codecs/rt5645.h"
#define MCLK_FOR_CODECS 12288000 @@ -154,8 +153,8 @@ static int mt8173_rt5650_hdmi_init(struct snd_soc_pcm_runtime *rtd) if (ret) return ret;
- return hdmi_codec_set_jack_detect(asoc_rtd_to_codec(rtd, 0)->component, - &mt8173_rt5650_hdmi_jack); + return snd_soc_component_set_jack(asoc_rtd_to_codec(rtd, 0)->component, + &mt8173_rt5650_hdmi_jack, NULL); }
enum { diff --git a/sound/soc/mediatek/mt8183/mt8183-da7219-max98357.c b/sound/soc/mediatek/mt8183/mt8183-da7219-max98357.c index 06d0a4f80fc1..e53c6200d5a7 100644 --- a/sound/soc/mediatek/mt8183/mt8183-da7219-max98357.c +++ b/sound/soc/mediatek/mt8183/mt8183-da7219-max98357.c @@ -10,7 +10,6 @@ #include <linux/module.h> #include <linux/of_device.h> #include <linux/pinctrl/consumer.h> -#include <sound/hdmi-codec.h> #include <sound/jack.h> #include <sound/pcm_params.h> #include <sound/soc.h> @@ -369,8 +368,8 @@ static int mt8183_da7219_max98357_hdmi_init(struct snd_soc_pcm_runtime *rtd) if (ret) return ret;
- return hdmi_codec_set_jack_detect(asoc_rtd_to_codec(rtd, 0)->component, - &priv->hdmi_jack); + return snd_soc_component_set_jack(asoc_rtd_to_codec(rtd, 0)->component, + &priv->hdmi_jack, NULL); }
static struct snd_soc_dai_link mt8183_da7219_dai_links[] = { diff --git a/sound/soc/mediatek/mt8183/mt8183-mt6358-ts3a227-max98357.c b/sound/soc/mediatek/mt8183/mt8183-mt6358-ts3a227-max98357.c index 07410d7afaa9..327dfad41e31 100644 --- a/sound/soc/mediatek/mt8183/mt8183-mt6358-ts3a227-max98357.c +++ b/sound/soc/mediatek/mt8183/mt8183-mt6358-ts3a227-max98357.c @@ -9,7 +9,6 @@ #include <linux/module.h> #include <linux/of_device.h> #include <linux/pinctrl/consumer.h> -#include <sound/hdmi-codec.h> #include <sound/jack.h> #include <sound/pcm_params.h> #include <sound/soc.h> @@ -350,8 +349,8 @@ mt8183_mt6358_ts3a227_max98357_hdmi_init(struct snd_soc_pcm_runtime *rtd) if (ret) return ret;
- return hdmi_codec_set_jack_detect(asoc_rtd_to_codec(rtd, 0)->component, - &priv->hdmi_jack); + return snd_soc_component_set_jack(asoc_rtd_to_codec(rtd, 0)->component, + &priv->hdmi_jack, NULL); }
static struct snd_soc_dai_link mt8183_mt6358_ts3a227_dai_links[] = { diff --git a/sound/soc/rockchip/rockchip_max98090.c b/sound/soc/rockchip/rockchip_max98090.c index 9acfd024aa5d..c8f1a28a92b7 100644 --- a/sound/soc/rockchip/rockchip_max98090.c +++ b/sound/soc/rockchip/rockchip_max98090.c @@ -12,7 +12,6 @@ #include <linux/gpio.h> #include <linux/of_gpio.h> #include <sound/core.h> -#include <sound/hdmi-codec.h> #include <sound/jack.h> #include <sound/pcm.h> #include <sound/pcm_params.h> @@ -238,7 +237,7 @@ static int rk_hdmi_init(struct snd_soc_pcm_runtime *runtime) return ret; }
- return hdmi_codec_set_jack_detect(component, &rk_hdmi_jack); + return snd_soc_component_set_jack(component, &rk_hdmi_jack, NULL); }
/* max98090 dai_link */
Add devicetree bindings documentation file for sc7180 sound card.
Signed-off-by: Cheng-Yi Chiang cychiang@chromium.org --- .../bindings/sound/qcom,sc7180.yaml | 143 ++++++++++++++++++ 1 file changed, 143 insertions(+) create mode 100644 Documentation/devicetree/bindings/sound/qcom,sc7180.yaml
diff --git a/Documentation/devicetree/bindings/sound/qcom,sc7180.yaml b/Documentation/devicetree/bindings/sound/qcom,sc7180.yaml new file mode 100644 index 000000000000..ae809346ca80 --- /dev/null +++ b/Documentation/devicetree/bindings/sound/qcom,sc7180.yaml @@ -0,0 +1,143 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/sound/qcom,sc7180.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Qualcomm Technologies Inc. SC7180 ASoC sound card driver + +maintainers: + - Rohit kumar rohitkr@codeaurora.org + - Cheng-Yi Chiang cychiang@chromium.org + +description: + This binding describes the SC7180 sound card which uses LPASS for audio. + +properties: + compatible: + const: qcom,sc7180-sndcard + + audio-routing: + $ref: /schemas/types.yaml#/definitions/non-unique-string-array + description: + A list of the connections between audio components. Each entry is a + pair of strings, the first being the connection's sink, the second + being the connection's source. + + model: + $ref: /schemas/types.yaml#/definitions/string + description: User specified audio sound card name + + headset-jack: + $ref: /schemas/types.yaml#/definitions/phandle + description: phandle of the codec for headset detection + + hdmi-jack: + $ref: /schemas/types.yaml#/definitions/phandle + description: phandle of the codec for hdmi jack detection + + "#address-cells": + const: 1 + + "#size-cells": + const: 0 + +patternProperties: + "^dai-link(@[0-9])?$": + description: + Each subnode represents a dai link. Subnodes of each dai links would be + cpu/codec dais. + + type: object + + properties: + link-name: + description: Indicates dai-link name and PCM stream name. + $ref: /schemas/types.yaml#/definitions/string + maxItems: 1 + + reg: + description: dai link address. + + cpu: + description: Holds subnode which indicates cpu dai. + type: object + properties: + sound-dai: true + + codec: + description: Holds subnode which indicates codec dai. + type: object + properties: + sound-dai: true + + required: + - link-name + - cpu + - codec + + additionalProperties: false + +required: + - compatible + - model + - headset-jack + - hdmi-jack + - "#address-cells" + - "#size-cells" + +additionalProperties: false + +examples: + + - | + sound { + compatible = "qcom,sc7180-sndcard"; + model = "sc7180-snd-card"; + + audio-routing = + "Headphone Jack", "HPOL", + "Headphone Jack", "HPOR"; + + headset-jack = <&alc5682>; + hdmi-jack = <&msm_dp>; + + #address-cells = <1>; + #size-cells = <0>; + + dai-link@0 { + link-name = "MultiMedia0"; + reg = <0>; + cpu { + sound-dai = <&lpass_cpu 0>; + }; + + codec { + sound-dai = <&alc5682 0>; + }; + }; + + dai-link@1 { + link-name = "MultiMedia1"; + reg = <1>; + cpu { + sound-dai = <&lpass_cpu 1>; + }; + + codec { + sound-dai = <&max98357a>; + }; + }; + + dai-link@2 { + link-name = "MultiMedia2"; + reg = <2>; + cpu { + sound-dai = <&lpass_hdmi 0>; + }; + + codec { + sound-dai = <&msm_dp>; + }; + }; + };
On Mon, Sep 07, 2020 at 06:00:38PM +0800, Cheng-Yi Chiang wrote:
Add devicetree bindings documentation file for sc7180 sound card.
Signed-off-by: Cheng-Yi Chiang cychiang@chromium.org
.../bindings/sound/qcom,sc7180.yaml | 143 ++++++++++++++++++ 1 file changed, 143 insertions(+) create mode 100644 Documentation/devicetree/bindings/sound/qcom,sc7180.yaml
diff --git a/Documentation/devicetree/bindings/sound/qcom,sc7180.yaml b/Documentation/devicetree/bindings/sound/qcom,sc7180.yaml new file mode 100644 index 000000000000..ae809346ca80 --- /dev/null +++ b/Documentation/devicetree/bindings/sound/qcom,sc7180.yaml @@ -0,0 +1,143 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/sound/qcom,sc7180.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml#
+title: Qualcomm Technologies Inc. SC7180 ASoC sound card driver
+maintainers:
- Rohit kumar rohitkr@codeaurora.org
- Cheng-Yi Chiang cychiang@chromium.org
+description:
- This binding describes the SC7180 sound card which uses LPASS for audio.
+properties:
- compatible:
- const: qcom,sc7180-sndcard
- audio-routing:
- $ref: /schemas/types.yaml#/definitions/non-unique-string-array
- description:
A list of the connections between audio components. Each entry is apair of strings, the first being the connection's sink, the secondbeing the connection's source.- model:
- $ref: /schemas/types.yaml#/definitions/string
- description: User specified audio sound card name
- headset-jack:
- $ref: /schemas/types.yaml#/definitions/phandle
- description: phandle of the codec for headset detection
- hdmi-jack:
- $ref: /schemas/types.yaml#/definitions/phandle
- description: phandle of the codec for hdmi jack detection
You already have links to these devices. Why duplicate it here?
What if you had 2 headsets? This doesn't scale.
Rob
On Wed, Sep 9, 2020 at 4:34 AM Rob Herring robh@kernel.org wrote:
On Mon, Sep 07, 2020 at 06:00:38PM +0800, Cheng-Yi Chiang wrote:
Add devicetree bindings documentation file for sc7180 sound card.
Signed-off-by: Cheng-Yi Chiang cychiang@chromium.org
.../bindings/sound/qcom,sc7180.yaml | 143 ++++++++++++++++++ 1 file changed, 143 insertions(+) create mode 100644 Documentation/devicetree/bindings/sound/qcom,sc7180.yaml
diff --git a/Documentation/devicetree/bindings/sound/qcom,sc7180.yaml b/Documentation/devicetree/bindings/sound/qcom,sc7180.yaml new file mode 100644 index 000000000000..ae809346ca80 --- /dev/null +++ b/Documentation/devicetree/bindings/sound/qcom,sc7180.yaml @@ -0,0 +1,143 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/sound/qcom,sc7180.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml#
+title: Qualcomm Technologies Inc. SC7180 ASoC sound card driver
+maintainers:
- Rohit kumar rohitkr@codeaurora.org
- Cheng-Yi Chiang cychiang@chromium.org
+description:
- This binding describes the SC7180 sound card which uses LPASS for audio.
+properties:
- compatible:
- const: qcom,sc7180-sndcard
- audio-routing:
- $ref: /schemas/types.yaml#/definitions/non-unique-string-array
- description:
A list of the connections between audio components. Each entry is apair of strings, the first being the connection's sink, the secondbeing the connection's source.- model:
- $ref: /schemas/types.yaml#/definitions/string
- description: User specified audio sound card name
- headset-jack:
- $ref: /schemas/types.yaml#/definitions/phandle
- description: phandle of the codec for headset detection
- hdmi-jack:
- $ref: /schemas/types.yaml#/definitions/phandle
- description: phandle of the codec for hdmi jack detection
You already have links to these devices. Why duplicate it here?
What if you had 2 headsets? This doesn't scale.
Hi Rob, thanks for reviewing. There was some discussion in https://patchwork.kernel.org/patch/11737905/#23571643 about how to specify the dailink that has a headset jack. I would like to pass the information of headset jack and hdmi jack to the machine driver so the machine driver can call snd_soc_component_set_jack to set jack when init the corresponding link. Headset jack and hdmi jack will be treated differently for button and event type. Because of this, we can not just set a property "jack" in the link.
As for the 2 headsets case (I guess you mean hp jack and mic jack), on this board we will not have this use case. If someone really wants to build hp jack and mic jack on the board based on this machine driver, we can add two more property hp-jack and mic-jack to specify that, as the machine driver will need to know the different jack types anyway. What do you think ?
Or could you please suggest a proper way to pass such information ?
Thanks!
Rob
On Wed, Sep 9, 2020 at 5:23 PM Cheng-yi Chiang cychiang@chromium.org wrote:
On Wed, Sep 9, 2020 at 4:34 AM Rob Herring robh@kernel.org wrote:
On Mon, Sep 07, 2020 at 06:00:38PM +0800, Cheng-Yi Chiang wrote:
Add devicetree bindings documentation file for sc7180 sound card.
Signed-off-by: Cheng-Yi Chiang cychiang@chromium.org
.../bindings/sound/qcom,sc7180.yaml | 143 ++++++++++++++++++ 1 file changed, 143 insertions(+) create mode 100644 Documentation/devicetree/bindings/sound/qcom,sc7180.yaml
diff --git a/Documentation/devicetree/bindings/sound/qcom,sc7180.yaml b/Documentation/devicetree/bindings/sound/qcom,sc7180.yaml new file mode 100644 index 000000000000..ae809346ca80 --- /dev/null +++ b/Documentation/devicetree/bindings/sound/qcom,sc7180.yaml @@ -0,0 +1,143 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/sound/qcom,sc7180.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml#
+title: Qualcomm Technologies Inc. SC7180 ASoC sound card driver
+maintainers:
- Rohit kumar rohitkr@codeaurora.org
- Cheng-Yi Chiang cychiang@chromium.org
+description:
- This binding describes the SC7180 sound card which uses LPASS for audio.
+properties:
- compatible:
- const: qcom,sc7180-sndcard
- audio-routing:
- $ref: /schemas/types.yaml#/definitions/non-unique-string-array
- description:
A list of the connections between audio components. Each entry is apair of strings, the first being the connection's sink, the secondbeing the connection's source.- model:
- $ref: /schemas/types.yaml#/definitions/string
- description: User specified audio sound card name
- headset-jack:
- $ref: /schemas/types.yaml#/definitions/phandle
- description: phandle of the codec for headset detection
- hdmi-jack:
- $ref: /schemas/types.yaml#/definitions/phandle
- description: phandle of the codec for hdmi jack detection
You already have links to these devices. Why duplicate it here?
What if you had 2 headsets? This doesn't scale.
Hi Rob, thanks for reviewing. There was some discussion in https://patchwork.kernel.org/patch/11737905/#23571643 about how to specify the dailink that has a headset jack. I would like to pass the information of headset jack and hdmi jack to the machine driver so the machine driver can call snd_soc_component_set_jack to set jack when init the corresponding link. Headset jack and hdmi jack will be treated differently for button and event type. Because of this, we can not just set a property "jack" in the link.
As for the 2 headsets case (I guess you mean hp jack and mic jack), on this board we will not have this use case. If someone really wants to build hp jack and mic jack on the board based on this machine driver, we can add two more property hp-jack and mic-jack to specify that, as the machine driver will need to know the different jack types anyway. What do you think ?
Or could you please suggest a proper way to pass such information ?
Thanks!
Alternatively we can probably do
dai-link@0 { link-name = "MultiMedia0"; reg = <0>; cpu { sound-dai = <&lpass_cpu 0>; }; headset_jack; codec { sound-dai = <&alc5682 0>; }; }; dai-link@2 { link-name = "MultiMedia2"; reg = <2>; cpu { sound-dai = <&lpass_hdmi 0>; }; hdmi_jack; codec { sound-dai = <&msm_dp>; }; };
Or even put the flag into codec {}. Please let me know if you feel this is a better way. I think it will make the driver code a little more complicated, but the interface on dts might looks cleaner. Thanks!
Rob
On Wed, Sep 9, 2020 at 3:24 AM Cheng-yi Chiang cychiang@chromium.org wrote:
On Wed, Sep 9, 2020 at 4:34 AM Rob Herring robh@kernel.org wrote:
On Mon, Sep 07, 2020 at 06:00:38PM +0800, Cheng-Yi Chiang wrote:
Add devicetree bindings documentation file for sc7180 sound card.
Signed-off-by: Cheng-Yi Chiang cychiang@chromium.org
.../bindings/sound/qcom,sc7180.yaml | 143 ++++++++++++++++++ 1 file changed, 143 insertions(+) create mode 100644 Documentation/devicetree/bindings/sound/qcom,sc7180.yaml
diff --git a/Documentation/devicetree/bindings/sound/qcom,sc7180.yaml b/Documentation/devicetree/bindings/sound/qcom,sc7180.yaml new file mode 100644 index 000000000000..ae809346ca80 --- /dev/null +++ b/Documentation/devicetree/bindings/sound/qcom,sc7180.yaml @@ -0,0 +1,143 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/sound/qcom,sc7180.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml#
+title: Qualcomm Technologies Inc. SC7180 ASoC sound card driver
+maintainers:
- Rohit kumar rohitkr@codeaurora.org
- Cheng-Yi Chiang cychiang@chromium.org
+description:
- This binding describes the SC7180 sound card which uses LPASS for audio.
+properties:
- compatible:
- const: qcom,sc7180-sndcard
- audio-routing:
- $ref: /schemas/types.yaml#/definitions/non-unique-string-array
- description:
A list of the connections between audio components. Each entry is apair of strings, the first being the connection's sink, the secondbeing the connection's source.- model:
- $ref: /schemas/types.yaml#/definitions/string
- description: User specified audio sound card name
- headset-jack:
- $ref: /schemas/types.yaml#/definitions/phandle
- description: phandle of the codec for headset detection
- hdmi-jack:
- $ref: /schemas/types.yaml#/definitions/phandle
- description: phandle of the codec for hdmi jack detection
You already have links to these devices. Why duplicate it here?
What if you had 2 headsets? This doesn't scale.
Hi Rob, thanks for reviewing. There was some discussion in https://patchwork.kernel.org/patch/11737905/#23571643 about how to specify the dailink that has a headset jack. I would like to pass the information of headset jack and hdmi jack to the machine driver so the machine driver can call snd_soc_component_set_jack to set jack when init the corresponding link. Headset jack and hdmi jack will be treated differently for button and event type. Because of this, we can not just set a property "jack" in the link.
Don't design your binding around some driver architecture. Limitations of ASoC are not reasons for your binding.
For DP and HDMI, we assume HPD is supported generally as that's a standard function for HDMI/DP controllers. There's a 'no-hpd' property for cases of broken HPD. That hardware description is part of the device HPD is connected to which is the HDMI/DP controller/bridge or the connector node in the case of a GPIO line. That doesn't belong in the virtual sound card.
I would assume a codec to be similar. The codec node (the alc5682 node) should have any jack related properties (or possibly implicitly support it by default).
As for the 2 headsets case (I guess you mean hp jack and mic jack), on this board we will not have this use case. If someone really wants to build hp jack and mic jack on the board based on this machine driver, we can add two more property hp-jack and mic-jack to specify that, as the machine driver will need to know the different jack types anyway. What do you think ?
I was thinking more of a case of having 2 of the same thing. Perhaps 2 HDMI outputs. Or if you have DP instead of HDMI? Just going to add 'dp-jack'?
Rob
On Thu, Sep 10, 2020 at 1:49 AM Rob Herring robh@kernel.org wrote:
On Wed, Sep 9, 2020 at 3:24 AM Cheng-yi Chiang cychiang@chromium.org wrote:
On Wed, Sep 9, 2020 at 4:34 AM Rob Herring robh@kernel.org wrote:
On Mon, Sep 07, 2020 at 06:00:38PM +0800, Cheng-Yi Chiang wrote:
Add devicetree bindings documentation file for sc7180 sound card.
Signed-off-by: Cheng-Yi Chiang cychiang@chromium.org
.../bindings/sound/qcom,sc7180.yaml | 143 ++++++++++++++++++ 1 file changed, 143 insertions(+) create mode 100644 Documentation/devicetree/bindings/sound/qcom,sc7180.yaml
diff --git a/Documentation/devicetree/bindings/sound/qcom,sc7180.yaml b/Documentation/devicetree/bindings/sound/qcom,sc7180.yaml new file mode 100644 index 000000000000..ae809346ca80 --- /dev/null +++ b/Documentation/devicetree/bindings/sound/qcom,sc7180.yaml @@ -0,0 +1,143 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/sound/qcom,sc7180.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml#
+title: Qualcomm Technologies Inc. SC7180 ASoC sound card driver
+maintainers:
- Rohit kumar rohitkr@codeaurora.org
- Cheng-Yi Chiang cychiang@chromium.org
+description:
- This binding describes the SC7180 sound card which uses LPASS for audio.
+properties:
- compatible:
- const: qcom,sc7180-sndcard
- audio-routing:
- $ref: /schemas/types.yaml#/definitions/non-unique-string-array
- description:
A list of the connections between audio components. Each entry is apair of strings, the first being the connection's sink, the secondbeing the connection's source.- model:
- $ref: /schemas/types.yaml#/definitions/string
- description: User specified audio sound card name
- headset-jack:
- $ref: /schemas/types.yaml#/definitions/phandle
- description: phandle of the codec for headset detection
- hdmi-jack:
- $ref: /schemas/types.yaml#/definitions/phandle
- description: phandle of the codec for hdmi jack detection
You already have links to these devices. Why duplicate it here?
What if you had 2 headsets? This doesn't scale.
Hi Rob, thanks for reviewing. There was some discussion in https://patchwork.kernel.org/patch/11737905/#23571643 about how to specify the dailink that has a headset jack. I would like to pass the information of headset jack and hdmi jack to the machine driver so the machine driver can call snd_soc_component_set_jack to set jack when init the corresponding link. Headset jack and hdmi jack will be treated differently for button and event type. Because of this, we can not just set a property "jack" in the link.
Don't design your binding around some driver architecture. Limitations of ASoC are not reasons for your binding.
For DP and HDMI, we assume HPD is supported generally as that's a standard function for HDMI/DP controllers. There's a 'no-hpd' property for cases of broken HPD. That hardware description is part of the device HPD is connected to which is the HDMI/DP controller/bridge or the connector node in the case of a GPIO line. That doesn't belong in the virtual sound card.
I would assume a codec to be similar. The codec node (the alc5682 node) should have any jack related properties (or possibly implicitly support it by default).
Thanks for the explanation. Now I can follow your thoughts. I see that the sound card driver should assume that there is jack/hpd available on HDMI/codec unless it is specified in HDMI/codec node (should not specified in sound card).
As for the 2 headsets case (I guess you mean hp jack and mic jack), on this board we will not have this use case. If someone really wants to build hp jack and mic jack on the board based on this machine driver, we can add two more property hp-jack and mic-jack to specify that, as the machine driver will need to know the different jack types anyway. What do you think ?
I was thinking more of a case of having 2 of the same thing. Perhaps 2 HDMI outputs. Or if you have DP instead of HDMI? Just going to add 'dp-jack'?
I agree that this may not scale. It will become an abuse of binding interface. Sound card drivers should have more knowledge/control on this kind of configuration. I think this can be taken care of inside the sound card driver. If a machine wants a different configuration, we can use compatible strings to achieve that. This will be more flexible than the limited binding interface.
Thanks for the discussion, I will remove headset-jack and hdmi-jack in v8.
Rob
On Wed, Sep 09, 2020 at 11:49:22AM -0600, Rob Herring wrote:
I would assume a codec to be similar. The codec node (the alc5682 node) should have any jack related properties (or possibly implicitly support it by default).
This isn't always clear - some jack detection is implemented entirely by integrating simple components like GPIOs and ADCs or by integrating limited support in one device with some external components to get more features (like bolting an ADC on the side for button detect). I would not expect to ever see a device with jack detection support that could just be unconditionally enabled, it will always require some board level wiring up to provide the connections required to function.
From: Ajit Pandey ajitp@codeaurora.org
Add new driver to register sound card on sc7180 trogdor board and do the required configuration for lpass cpu dai and external codecs connected over MI2S interfaces.
Signed-off-by: Ajit Pandey ajitp@codeaurora.org Signed-off-by: Cheng-Yi Chiang cychiang@chromium.org Reviewed-by: Tzung-Bi Shih tzungbi@google.com --- sound/soc/qcom/Kconfig | 12 ++ sound/soc/qcom/Makefile | 2 + sound/soc/qcom/sc7180.c | 288 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 302 insertions(+) create mode 100644 sound/soc/qcom/sc7180.c
diff --git a/sound/soc/qcom/Kconfig b/sound/soc/qcom/Kconfig index a607ace8b089..0459185ee243 100644 --- a/sound/soc/qcom/Kconfig +++ b/sound/soc/qcom/Kconfig @@ -116,4 +116,16 @@ config SND_SOC_SDM845 SDM845 SoC-based systems. Say Y if you want to use audio device on this SoCs.
+config SND_SOC_SC7180 + tristate "SoC Machine driver for SC7180 boards" + depends on I2C + select SND_SOC_QCOM_COMMON + select SND_SOC_LPASS_SC7180 + select SND_SOC_MAX98357A + select SND_SOC_RT5682_I2C + help + To add support for audio on Qualcomm Technologies Inc. + SC7180 SoC-based systems. + Say Y if you want to use audio device on this SoCs. + endif #SND_SOC_QCOM diff --git a/sound/soc/qcom/Makefile b/sound/soc/qcom/Makefile index 7972c9479ab0..0cdcbf367ef1 100644 --- a/sound/soc/qcom/Makefile +++ b/sound/soc/qcom/Makefile @@ -17,12 +17,14 @@ snd-soc-storm-objs := storm.o snd-soc-apq8016-sbc-objs := apq8016_sbc.o snd-soc-apq8096-objs := apq8096.o snd-soc-sdm845-objs := sdm845.o +snd-soc-sc7180-objs := sc7180.o snd-soc-qcom-common-objs := common.o
obj-$(CONFIG_SND_SOC_STORM) += snd-soc-storm.o obj-$(CONFIG_SND_SOC_APQ8016_SBC) += snd-soc-apq8016-sbc.o obj-$(CONFIG_SND_SOC_MSM8996) += snd-soc-apq8096.o obj-$(CONFIG_SND_SOC_SDM845) += snd-soc-sdm845.o +obj-$(CONFIG_SND_SOC_SC7180) += snd-soc-sc7180.o obj-$(CONFIG_SND_SOC_QCOM_COMMON) += snd-soc-qcom-common.o
#DSP lib diff --git a/sound/soc/qcom/sc7180.c b/sound/soc/qcom/sc7180.c new file mode 100644 index 000000000000..175a2f36842c --- /dev/null +++ b/sound/soc/qcom/sc7180.c @@ -0,0 +1,288 @@ +// SPDX-License-Identifier: GPL-2.0-only +// +// Copyright (c) 2020, The Linux Foundation. All rights reserved. +// +// sc7180.c -- ALSA SoC Machine driver for SC7180 + +#include <dt-bindings/sound/sc7180-lpass.h> +#include <linux/module.h> +#include <linux/of_device.h> +#include <linux/platform_device.h> +#include <sound/core.h> +#include <sound/jack.h> +#include <sound/pcm.h> +#include <sound/pcm_params.h> +#include <sound/soc.h> +#include <uapi/linux/input-event-codes.h> + +#include "../codecs/rt5682.h" +#include "common.h" +#include "lpass.h" + +#define DEFAULT_SAMPLE_RATE_48K 48000 +#define DEFAULT_MCLK_RATE 19200000 +#define RT5682_PLL1_FREQ (48000 * 512) + +struct sc7180_snd_data { + u32 pri_mi2s_clk_count; + struct snd_soc_jack hs_jack; + struct device_node *hs_jack_of_node; + struct snd_soc_jack hdmi_jack; + struct device_node *hdmi_jack_of_node; +}; + +static void sc7180_jack_free(struct snd_jack *jack) +{ + struct snd_soc_component *component = jack->private_data; + + snd_soc_component_set_jack(component, NULL, NULL); +} + +static int sc7180_headset_init(struct snd_soc_pcm_runtime *rtd) +{ + struct snd_soc_card *card = rtd->card; + struct sc7180_snd_data *pdata = snd_soc_card_get_drvdata(card); + struct snd_soc_dai *codec_dai = asoc_rtd_to_codec(rtd, 0); + struct snd_soc_component *component = codec_dai->component; + struct snd_jack *jack; + int rval; + + rval = snd_soc_card_jack_new( + card, "Headset Jack", + SND_JACK_HEADSET | + SND_JACK_HEADPHONE | + SND_JACK_BTN_0 | SND_JACK_BTN_1 | + SND_JACK_BTN_2 | SND_JACK_BTN_3, + &pdata->hs_jack, NULL, 0); + + if (rval < 0) { + dev_err(card->dev, "Unable to add Headset Jack\n"); + return rval; + } + + jack = pdata->hs_jack.jack; + + snd_jack_set_key(jack, SND_JACK_BTN_0, KEY_PLAYPAUSE); + snd_jack_set_key(jack, SND_JACK_BTN_1, KEY_VOICECOMMAND); + snd_jack_set_key(jack, SND_JACK_BTN_2, KEY_VOLUMEUP); + snd_jack_set_key(jack, SND_JACK_BTN_3, KEY_VOLUMEDOWN); + + jack->private_data = component; + jack->private_free = sc7180_jack_free; + + return snd_soc_component_set_jack(component, &pdata->hs_jack, NULL); +} + +static int sc7180_hdmi_init(struct snd_soc_pcm_runtime *rtd) +{ + struct snd_soc_card *card = rtd->card; + struct sc7180_snd_data *pdata = snd_soc_card_get_drvdata(card); + struct snd_soc_dai *codec_dai = asoc_rtd_to_codec(rtd, 0); + struct snd_soc_component *component = codec_dai->component; + struct snd_jack *jack; + int rval; + + rval = snd_soc_card_jack_new( + card, "HDMI Jack", + SND_JACK_LINEOUT, + &pdata->hdmi_jack, NULL, 0); + + if (rval < 0) { + dev_err(card->dev, "Unable to add HDMI Jack\n"); + return rval; + } + + jack = pdata->hdmi_jack.jack; + jack->private_data = component; + jack->private_free = sc7180_jack_free; + + return snd_soc_component_set_jack(component, &pdata->hdmi_jack, NULL); +} + +static int sc7180_snd_startup(struct snd_pcm_substream *substream) +{ + struct snd_soc_pcm_runtime *rtd = substream->private_data; + struct snd_soc_card *card = rtd->card; + struct sc7180_snd_data *data = snd_soc_card_get_drvdata(card); + struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(rtd, 0); + struct snd_soc_dai *codec_dai = asoc_rtd_to_codec(rtd, 0); + int ret; + + switch (cpu_dai->id) { + case MI2S_PRIMARY: + if (++data->pri_mi2s_clk_count == 1) { + snd_soc_dai_set_sysclk(cpu_dai, + LPASS_MCLK0, + DEFAULT_MCLK_RATE, + SNDRV_PCM_STREAM_PLAYBACK); + } + + snd_soc_dai_set_fmt(codec_dai, + SND_SOC_DAIFMT_CBS_CFS | + SND_SOC_DAIFMT_NB_NF | + SND_SOC_DAIFMT_I2S); + + /* Configure PLL1 for codec */ + ret = snd_soc_dai_set_pll(codec_dai, 0, RT5682_PLL1_S_MCLK, + DEFAULT_MCLK_RATE, RT5682_PLL1_FREQ); + if (ret) { + dev_err(rtd->dev, "can't set codec pll: %d\n", ret); + return ret; + } + + /* Configure sysclk for codec */ + ret = snd_soc_dai_set_sysclk(codec_dai, RT5682_SCLK_S_PLL1, + RT5682_PLL1_FREQ, + SND_SOC_CLOCK_IN); + if (ret) + dev_err(rtd->dev, "snd_soc_dai_set_sysclk err = %d\n", + ret); + + break; + case MI2S_SECONDARY: + break; + case HDMI: + break; + default: + dev_err(rtd->dev, "%s: invalid dai id 0x%x\n", __func__, + cpu_dai->id); + return -EINVAL; + } + return 0; +} + +static void sc7180_snd_shutdown(struct snd_pcm_substream *substream) +{ + struct snd_soc_pcm_runtime *rtd = substream->private_data; + struct snd_soc_card *card = rtd->card; + struct sc7180_snd_data *data = snd_soc_card_get_drvdata(card); + struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(rtd, 0); + + switch (cpu_dai->id) { + case MI2S_PRIMARY: + if (--data->pri_mi2s_clk_count == 0) { + snd_soc_dai_set_sysclk(cpu_dai, + LPASS_MCLK0, + 0, + SNDRV_PCM_STREAM_PLAYBACK); + } + break; + case MI2S_SECONDARY: + break; + case HDMI: + break; + default: + dev_err(rtd->dev, "%s: invalid dai id 0x%x\n", __func__, + cpu_dai->id); + break; + } +} + +static const struct snd_soc_ops sc7180_ops = { + .startup = sc7180_snd_startup, + .shutdown = sc7180_snd_shutdown, +}; + +static const struct snd_soc_dapm_widget sc7180_snd_widgets[] = { + SND_SOC_DAPM_HP("Headphone Jack", NULL), + SND_SOC_DAPM_MIC("Headset Mic", NULL), +}; + +static struct snd_soc_card sc7180_card = { + .owner = THIS_MODULE, + .dapm_widgets = sc7180_snd_widgets, + .num_dapm_widgets = ARRAY_SIZE(sc7180_snd_widgets), +}; + +static int sc7180_parse_headset_jack_of(struct sc7180_snd_data *data, struct device *dev) +{ + data->hs_jack_of_node = of_parse_phandle(dev->of_node, "headset-jack", 0); + if (!data->hs_jack_of_node) + return -EINVAL; + return 0; +} + +static int sc7180_parse_hdmi_jack_of(struct sc7180_snd_data *data, struct device *dev) +{ + data->hdmi_jack_of_node = of_parse_phandle( + dev->of_node, "hdmi-jack", 0); + if (!data->hdmi_jack_of_node) + return -EINVAL; + return 0; +} + +static void sc7180_add_ops(struct snd_soc_card *card) +{ + struct snd_soc_dai_link *link; + int i; + struct sc7180_snd_data *pdata = snd_soc_card_get_drvdata(card); + + for_each_card_prelinks(card, i, link) { + link->ops = &sc7180_ops; + if (link->codecs && + link->codecs->of_node == pdata->hs_jack_of_node) { + link->init = sc7180_headset_init; + } + if (link->codecs && + link->codecs->of_node == pdata->hdmi_jack_of_node) { + link->init = sc7180_hdmi_init; + } + } +} + +static int sc7180_snd_platform_probe(struct platform_device *pdev) +{ + struct snd_soc_card *card = &sc7180_card; + struct sc7180_snd_data *data; + struct device *dev = &pdev->dev; + int ret; + + /* Allocate the private data */ + data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL); + if (!data) + return -ENOMEM; + + card->dev = dev; + + ret = qcom_snd_parse_of(card); + if (ret) { + dev_err(dev, "Error parsing OF data\n"); + return ret; + } + + snd_soc_card_set_drvdata(card, data); + + ret = sc7180_parse_headset_jack_of(data, dev); + if (ret) { + dev_err(dev, "Failed to parse OF for headset jack device\n"); + return ret; + } + + ret = sc7180_parse_hdmi_jack_of(data, dev); + if (ret) { + dev_err(dev, "Failed to parse OF for hdmi jack device\n"); + return ret; + } + + sc7180_add_ops(card); + + return devm_snd_soc_register_card(dev, card); +} + +static const struct of_device_id sc7180_snd_device_id[] = { + { .compatible = "qcom,sc7180-sndcard" }, + {}, +}; +MODULE_DEVICE_TABLE(of, sc7180_snd_device_id); + +static struct platform_driver sc7180_snd_driver = { + .probe = sc7180_snd_platform_probe, + .driver = { + .name = "msm-snd-sc7180", + .of_match_table = sc7180_snd_device_id, + }, +}; +module_platform_driver(sc7180_snd_driver); + +MODULE_DESCRIPTION("sc7180 ASoC Machine Driver"); +MODULE_LICENSE("GPL v2");
participants (3)
-
Cheng-Yi Chiang -
Mark Brown -
Rob Herring