xref: /openbmc/linux/sound/soc/sof/intel/hda-codec.c (revision 8931ddd8)
1 // SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause)
2 //
3 // This file is provided under a dual BSD/GPLv2 license.  When using or
4 // redistributing this file, you may do so under either license.
5 //
6 // Copyright(c) 2018 Intel Corporation. All rights reserved.
7 //
8 // Authors: Keyon Jie <yang.jie@linux.intel.com>
9 //
10 
11 #include <linux/module.h>
12 #include <sound/hdaudio_ext.h>
13 #include <sound/hda_register.h>
14 #include <sound/hda_codec.h>
15 #include <sound/hda_i915.h>
16 #include <sound/sof.h>
17 #include "../ops.h"
18 #include "hda.h"
19 #if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA_AUDIO_CODEC)
20 #include "../../codecs/hdac_hda.h"
21 #endif /* CONFIG_SND_SOC_SOF_HDA_AUDIO_CODEC */
22 
23 #define CODEC_PROBE_RETRIES	3
24 
25 #if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA_AUDIO_CODEC)
26 #define IDISP_VID_INTEL	0x80860000
27 
28 /* load the legacy HDA codec driver */
29 static int request_codec_module(struct hda_codec *codec)
30 {
31 #ifdef MODULE
32 	char alias[MODULE_NAME_LEN];
33 	const char *mod = NULL;
34 
35 	switch (codec->probe_id) {
36 	case HDA_CODEC_ID_GENERIC:
37 #if IS_MODULE(CONFIG_SND_HDA_GENERIC)
38 		mod = "snd-hda-codec-generic";
39 #endif
40 		break;
41 	default:
42 		snd_hdac_codec_modalias(&codec->core, alias, sizeof(alias));
43 		mod = alias;
44 		break;
45 	}
46 
47 	if (mod) {
48 		dev_dbg(&codec->core.dev, "loading codec module: %s\n", mod);
49 		request_module(mod);
50 	}
51 #endif /* MODULE */
52 	return device_attach(hda_codec_dev(codec));
53 }
54 
55 static int hda_codec_load_module(struct hda_codec *codec)
56 {
57 	int ret = request_codec_module(codec);
58 
59 	if (ret <= 0) {
60 		codec->probe_id = HDA_CODEC_ID_GENERIC;
61 		ret = request_codec_module(codec);
62 	}
63 
64 	return ret;
65 }
66 
67 /* enable controller wake up event for all codecs with jack connectors */
68 void hda_codec_jack_wake_enable(struct snd_sof_dev *sdev, bool enable)
69 {
70 	struct hda_bus *hbus = sof_to_hbus(sdev);
71 	struct hdac_bus *bus = sof_to_bus(sdev);
72 	struct hda_codec *codec;
73 	unsigned int mask = 0;
74 
75 	if (enable) {
76 		list_for_each_codec(codec, hbus)
77 			if (codec->jacktbl.used)
78 				mask |= BIT(codec->core.addr);
79 	}
80 
81 	snd_hdac_chip_updatew(bus, WAKEEN, STATESTS_INT_MASK, mask);
82 }
83 
84 /* check jack status after resuming from suspend mode */
85 void hda_codec_jack_check(struct snd_sof_dev *sdev)
86 {
87 	struct hda_bus *hbus = sof_to_hbus(sdev);
88 	struct hda_codec *codec;
89 
90 	list_for_each_codec(codec, hbus)
91 		/*
92 		 * Wake up all jack-detecting codecs regardless whether an event
93 		 * has been recorded in STATESTS
94 		 */
95 		if (codec->jacktbl.used)
96 			pm_request_resume(&codec->core.dev);
97 }
98 #else
99 void hda_codec_jack_wake_enable(struct snd_sof_dev *sdev, bool enable) {}
100 void hda_codec_jack_check(struct snd_sof_dev *sdev) {}
101 #endif /* CONFIG_SND_SOC_SOF_HDA_AUDIO_CODEC */
102 EXPORT_SYMBOL_NS(hda_codec_jack_wake_enable, SND_SOC_SOF_HDA_AUDIO_CODEC);
103 EXPORT_SYMBOL_NS(hda_codec_jack_check, SND_SOC_SOF_HDA_AUDIO_CODEC);
104 
105 #if IS_ENABLED(CONFIG_SND_HDA_GENERIC)
106 #define is_generic_config(bus) \
107 	((bus)->modelname && !strcmp((bus)->modelname, "generic"))
108 #else
109 #define is_generic_config(x)	0
110 #endif
111 
112 /* probe individual codec */
113 static int hda_codec_probe(struct snd_sof_dev *sdev, int address,
114 			   bool hda_codec_use_common_hdmi)
115 {
116 #if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA_AUDIO_CODEC)
117 	struct hdac_hda_priv *hda_priv;
118 	struct hda_codec *codec;
119 	int type = HDA_DEV_LEGACY;
120 #endif
121 	struct hda_bus *hbus = sof_to_hbus(sdev);
122 	struct hdac_device *hdev;
123 	u32 hda_cmd = (address << 28) | (AC_NODE_ROOT << 20) |
124 		(AC_VERB_PARAMETERS << 8) | AC_PAR_VENDOR_ID;
125 	u32 resp = -1;
126 	int ret, retry = 0;
127 
128 	do {
129 		mutex_lock(&hbus->core.cmd_mutex);
130 		snd_hdac_bus_send_cmd(&hbus->core, hda_cmd);
131 		snd_hdac_bus_get_response(&hbus->core, address, &resp);
132 		mutex_unlock(&hbus->core.cmd_mutex);
133 	} while (resp == -1 && retry++ < CODEC_PROBE_RETRIES);
134 
135 	if (resp == -1)
136 		return -EIO;
137 	dev_dbg(sdev->dev, "HDA codec #%d probed OK: response: %x\n",
138 		address, resp);
139 
140 #if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA_AUDIO_CODEC)
141 	hda_priv = devm_kzalloc(sdev->dev, sizeof(*hda_priv), GFP_KERNEL);
142 	if (!hda_priv)
143 		return -ENOMEM;
144 
145 	hda_priv->codec.bus = hbus;
146 	hdev = &hda_priv->codec.core;
147 	codec = &hda_priv->codec;
148 
149 	/* only probe ASoC codec drivers for HDAC-HDMI */
150 	if (!hda_codec_use_common_hdmi && (resp & 0xFFFF0000) == IDISP_VID_INTEL)
151 		type = HDA_DEV_ASOC;
152 
153 	ret = snd_hdac_ext_bus_device_init(&hbus->core, address, hdev, type);
154 	if (ret < 0)
155 		return ret;
156 
157 	if ((resp & 0xFFFF0000) == IDISP_VID_INTEL) {
158 		if (!hdev->bus->audio_component) {
159 			dev_dbg(sdev->dev,
160 				"iDisp hw present but no driver\n");
161 			ret = -ENOENT;
162 			goto out;
163 		}
164 		hda_priv->need_display_power = true;
165 	}
166 
167 	if (is_generic_config(hbus))
168 		codec->probe_id = HDA_CODEC_ID_GENERIC;
169 	else
170 		codec->probe_id = 0;
171 
172 	if (type == HDA_DEV_LEGACY) {
173 		ret = hda_codec_load_module(codec);
174 		/*
175 		 * handle ret==0 (no driver bound) as an error, but pass
176 		 * other return codes without modification
177 		 */
178 		if (ret == 0)
179 			ret = -ENOENT;
180 	}
181 
182 out:
183 	if (ret < 0) {
184 		snd_hdac_device_unregister(hdev);
185 		put_device(&hdev->dev);
186 	}
187 #else
188 	hdev = devm_kzalloc(sdev->dev, sizeof(*hdev), GFP_KERNEL);
189 	if (!hdev)
190 		return -ENOMEM;
191 
192 	ret = snd_hdac_ext_bus_device_init(&hbus->core, address, hdev, HDA_DEV_ASOC);
193 #endif
194 
195 	return ret;
196 }
197 
198 /* Codec initialization */
199 void hda_codec_probe_bus(struct snd_sof_dev *sdev,
200 			 bool hda_codec_use_common_hdmi)
201 {
202 	struct hdac_bus *bus = sof_to_bus(sdev);
203 	int i, ret;
204 
205 	/* probe codecs in avail slots */
206 	for (i = 0; i < HDA_MAX_CODECS; i++) {
207 
208 		if (!(bus->codec_mask & (1 << i)))
209 			continue;
210 
211 		ret = hda_codec_probe(sdev, i, hda_codec_use_common_hdmi);
212 		if (ret < 0) {
213 			dev_warn(bus->dev, "codec #%d probe error, ret: %d\n",
214 				 i, ret);
215 			bus->codec_mask &= ~BIT(i);
216 		}
217 	}
218 }
219 EXPORT_SYMBOL_NS(hda_codec_probe_bus, SND_SOC_SOF_HDA_AUDIO_CODEC);
220 
221 #if IS_ENABLED(CONFIG_SND_HDA_CODEC_HDMI) || \
222 	IS_ENABLED(CONFIG_SND_SOC_HDAC_HDMI)
223 
224 void hda_codec_i915_display_power(struct snd_sof_dev *sdev, bool enable)
225 {
226 	struct hdac_bus *bus = sof_to_bus(sdev);
227 
228 	if (HDA_IDISP_CODEC(bus->codec_mask)) {
229 		dev_dbg(bus->dev, "Turning i915 HDAC power %d\n", enable);
230 		snd_hdac_display_power(bus, HDA_CODEC_IDX_CONTROLLER, enable);
231 	}
232 }
233 EXPORT_SYMBOL_NS(hda_codec_i915_display_power, SND_SOC_SOF_HDA_AUDIO_CODEC_I915);
234 
235 int hda_codec_i915_init(struct snd_sof_dev *sdev)
236 {
237 	struct hdac_bus *bus = sof_to_bus(sdev);
238 	int ret;
239 
240 	/* i915 exposes a HDA codec for HDMI audio */
241 	ret = snd_hdac_i915_init(bus);
242 	if (ret < 0)
243 		return ret;
244 
245 	/* codec_mask not yet known, power up for probe */
246 	snd_hdac_display_power(bus, HDA_CODEC_IDX_CONTROLLER, true);
247 
248 	return 0;
249 }
250 EXPORT_SYMBOL_NS(hda_codec_i915_init, SND_SOC_SOF_HDA_AUDIO_CODEC_I915);
251 
252 int hda_codec_i915_exit(struct snd_sof_dev *sdev)
253 {
254 	struct hdac_bus *bus = sof_to_bus(sdev);
255 
256 	if (!bus->audio_component)
257 		return 0;
258 
259 	/* power down unconditionally */
260 	snd_hdac_display_power(bus, HDA_CODEC_IDX_CONTROLLER, false);
261 
262 	return snd_hdac_i915_exit(bus);
263 }
264 EXPORT_SYMBOL_NS(hda_codec_i915_exit, SND_SOC_SOF_HDA_AUDIO_CODEC_I915);
265 
266 #endif
267 
268 MODULE_LICENSE("Dual BSD/GPL");
269