1 // SPDX-License-Identifier: GPL-2.0
2 // hdac_component.c - routines for sync between HD-A core and DRM driver
4 #include <linux/init.h>
5 #include <linux/module.h>
7 #include <linux/component.h>
8 #include <sound/core.h>
9 #include <sound/hdaudio.h>
10 #include <sound/hda_component.h>
11 #include <sound/hda_register.h>
13 static void hdac_acomp_release(struct device *dev, void *res)
17 static struct drm_audio_component *hdac_get_acomp(struct device *dev)
19 return devres_find(dev, hdac_acomp_release, NULL, NULL);
23 * snd_hdac_set_codec_wakeup - Enable / disable HDMI/DP codec wakeup
25 * @enable: enable or disable the wakeup
27 * This function is supposed to be used only by a HD-audio controller
28 * driver that needs the interaction with graphics driver.
30 * This function should be called during the chip reset, also called at
31 * resume for updating STATESTS register read.
33 * Returns zero for success or a negative error code.
35 int snd_hdac_set_codec_wakeup(struct hdac_bus *bus, bool enable)
37 struct drm_audio_component *acomp = bus->audio_component;
39 if (!acomp || !acomp->ops)
42 if (!acomp->ops->codec_wake_override)
45 dev_dbg(bus->dev, "%s codec wakeup\n",
46 enable ? "enable" : "disable");
48 acomp->ops->codec_wake_override(acomp->dev, enable);
52 EXPORT_SYMBOL_GPL(snd_hdac_set_codec_wakeup);
55 * snd_hdac_display_power - Power up / down the power refcount
57 * @idx: HDA codec address, pass HDA_CODEC_IDX_CONTROLLER for controller
58 * @enable: power up or down
60 * This function is used by either HD-audio controller or codec driver that
61 * needs the interaction with graphics driver.
63 * This function updates the power status, and calls the get_power() and
64 * put_power() ops accordingly, toggling the codec wakeup, too.
66 void snd_hdac_display_power(struct hdac_bus *bus, unsigned int idx, bool enable)
68 struct drm_audio_component *acomp = bus->audio_component;
70 dev_dbg(bus->dev, "display power %s\n",
71 enable ? "enable" : "disable");
73 mutex_lock(&bus->lock);
75 set_bit(idx, &bus->display_power_status);
77 clear_bit(idx, &bus->display_power_status);
79 if (!acomp || !acomp->ops)
82 if (bus->display_power_status) {
83 if (!bus->display_power_active) {
84 if (acomp->ops->get_power)
85 acomp->ops->get_power(acomp->dev);
86 snd_hdac_set_codec_wakeup(bus, true);
87 snd_hdac_set_codec_wakeup(bus, false);
88 bus->display_power_active = true;
91 if (bus->display_power_active) {
92 if (acomp->ops->put_power)
93 acomp->ops->put_power(acomp->dev);
94 bus->display_power_active = false;
98 mutex_unlock(&bus->lock);
100 EXPORT_SYMBOL_GPL(snd_hdac_display_power);
103 * snd_hdac_sync_audio_rate - Set N/CTS based on the sample rate
105 * @nid: the pin widget NID
106 * @dev_id: device identifier
107 * @rate: the sample rate to set
109 * This function is supposed to be used only by a HD-audio controller
110 * driver that needs the interaction with graphics driver.
112 * This function sets N/CTS value based on the given sample rate.
113 * Returns zero for success, or a negative error code.
115 int snd_hdac_sync_audio_rate(struct hdac_device *codec, hda_nid_t nid,
116 int dev_id, int rate)
118 struct hdac_bus *bus = codec->bus;
119 struct drm_audio_component *acomp = bus->audio_component;
122 if (!acomp || !acomp->ops || !acomp->ops->sync_audio_rate)
125 if (acomp->audio_ops && acomp->audio_ops->pin2port) {
126 port = acomp->audio_ops->pin2port(codec, nid);
131 return acomp->ops->sync_audio_rate(acomp->dev, port, pipe, rate);
133 EXPORT_SYMBOL_GPL(snd_hdac_sync_audio_rate);
136 * snd_hdac_acomp_get_eld - Get the audio state and ELD via component
138 * @nid: the pin widget NID
139 * @dev_id: device identifier
140 * @audio_enabled: the pointer to store the current audio state
141 * @buffer: the buffer pointer to store ELD bytes
142 * @max_bytes: the max bytes to be stored on @buffer
144 * This function is supposed to be used only by a HD-audio controller
145 * driver that needs the interaction with graphics driver.
147 * This function queries the current state of the audio on the given
148 * digital port and fetches the ELD bytes onto the given buffer.
149 * It returns the number of bytes for the total ELD data, zero for
150 * invalid ELD, or a negative error code.
152 * The return size is the total bytes required for the whole ELD bytes,
153 * thus it may be over @max_bytes. If it's over @max_bytes, it implies
154 * that only a part of ELD bytes have been fetched.
156 int snd_hdac_acomp_get_eld(struct hdac_device *codec, hda_nid_t nid, int dev_id,
157 bool *audio_enabled, char *buffer, int max_bytes)
159 struct hdac_bus *bus = codec->bus;
160 struct drm_audio_component *acomp = bus->audio_component;
163 if (!acomp || !acomp->ops || !acomp->ops->get_eld)
167 if (acomp->audio_ops && acomp->audio_ops->pin2port) {
168 port = acomp->audio_ops->pin2port(codec, nid);
173 return acomp->ops->get_eld(acomp->dev, port, pipe, audio_enabled,
176 EXPORT_SYMBOL_GPL(snd_hdac_acomp_get_eld);
178 static int hdac_component_master_bind(struct device *dev)
180 struct drm_audio_component *acomp = hdac_get_acomp(dev);
186 ret = component_bind_all(dev, acomp);
190 if (WARN_ON(!(acomp->dev && acomp->ops))) {
195 /* pin the module to avoid dynamic unbinding, but only if given */
196 if (!try_module_get(acomp->ops->owner)) {
201 if (acomp->audio_ops && acomp->audio_ops->master_bind) {
202 ret = acomp->audio_ops->master_bind(dev, acomp);
210 module_put(acomp->ops->owner);
212 component_unbind_all(dev, acomp);
217 static void hdac_component_master_unbind(struct device *dev)
219 struct drm_audio_component *acomp = hdac_get_acomp(dev);
221 if (acomp->audio_ops && acomp->audio_ops->master_unbind)
222 acomp->audio_ops->master_unbind(dev, acomp);
223 module_put(acomp->ops->owner);
224 component_unbind_all(dev, acomp);
225 WARN_ON(acomp->ops || acomp->dev);
228 static const struct component_master_ops hdac_component_master_ops = {
229 .bind = hdac_component_master_bind,
230 .unbind = hdac_component_master_unbind,
234 * snd_hdac_acomp_register_notifier - Register audio component ops
236 * @aops: audio component ops
238 * This function is supposed to be used only by a HD-audio controller
239 * driver that needs the interaction with graphics driver.
241 * This function sets the given ops to be called by the graphics driver.
243 * Returns zero for success or a negative error code.
245 int snd_hdac_acomp_register_notifier(struct hdac_bus *bus,
246 const struct drm_audio_component_audio_ops *aops)
248 if (!bus->audio_component)
251 bus->audio_component->audio_ops = aops;
254 EXPORT_SYMBOL_GPL(snd_hdac_acomp_register_notifier);
257 * snd_hdac_acomp_init - Initialize audio component
259 * @match_master: match function for finding components
260 * @extra_size: Extra bytes to allocate
262 * This function is supposed to be used only by a HD-audio controller
263 * driver that needs the interaction with graphics driver.
265 * This function initializes and sets up the audio component to communicate
266 * with graphics driver.
268 * Unlike snd_hdac_i915_init(), this function doesn't synchronize with the
269 * binding with the DRM component. Each caller needs to sync via master_bind
272 * Returns zero for success or a negative error code.
274 int snd_hdac_acomp_init(struct hdac_bus *bus,
275 const struct drm_audio_component_audio_ops *aops,
276 int (*match_master)(struct device *, int, void *),
279 struct component_match *match = NULL;
280 struct device *dev = bus->dev;
281 struct drm_audio_component *acomp;
284 if (WARN_ON(hdac_get_acomp(dev)))
287 acomp = devres_alloc(hdac_acomp_release, sizeof(*acomp) + extra_size,
291 acomp->audio_ops = aops;
292 bus->audio_component = acomp;
293 devres_add(dev, acomp);
295 component_match_add_typed(dev, &match, match_master, bus);
296 ret = component_master_add_with_match(dev, &hdac_component_master_ops,
304 bus->audio_component = NULL;
305 devres_destroy(dev, hdac_acomp_release, NULL, NULL);
306 dev_info(dev, "failed to add audio component master (%d)\n", ret);
310 EXPORT_SYMBOL_GPL(snd_hdac_acomp_init);
313 * snd_hdac_acomp_exit - Finalize audio component
316 * This function is supposed to be used only by a HD-audio controller
317 * driver that needs the interaction with graphics driver.
319 * This function releases the audio component that has been used.
321 * Returns zero for success or a negative error code.
323 int snd_hdac_acomp_exit(struct hdac_bus *bus)
325 struct device *dev = bus->dev;
326 struct drm_audio_component *acomp = bus->audio_component;
331 if (WARN_ON(bus->display_power_active) && acomp->ops)
332 acomp->ops->put_power(acomp->dev);
334 bus->display_power_active = false;
335 bus->display_power_status = 0;
337 component_master_del(dev, &hdac_component_master_ops);
339 bus->audio_component = NULL;
340 devres_destroy(dev, hdac_acomp_release, NULL, NULL);
344 EXPORT_SYMBOL_GPL(snd_hdac_acomp_exit);