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 set_bit(idx, &bus->display_power_status);
75 clear_bit(idx, &bus->display_power_status);
77 if (!acomp || !acomp->ops)
80 if (bus->display_power_status) {
81 if (!bus->display_power_active) {
82 if (acomp->ops->get_power)
83 acomp->ops->get_power(acomp->dev);
84 snd_hdac_set_codec_wakeup(bus, true);
85 snd_hdac_set_codec_wakeup(bus, false);
86 bus->display_power_active = true;
89 if (bus->display_power_active) {
90 if (acomp->ops->put_power)
91 acomp->ops->put_power(acomp->dev);
92 bus->display_power_active = false;
96 EXPORT_SYMBOL_GPL(snd_hdac_display_power);
99 * snd_hdac_sync_audio_rate - Set N/CTS based on the sample rate
101 * @nid: the pin widget NID
102 * @dev_id: device identifier
103 * @rate: the sample rate to set
105 * This function is supposed to be used only by a HD-audio controller
106 * driver that needs the interaction with graphics driver.
108 * This function sets N/CTS value based on the given sample rate.
109 * Returns zero for success, or a negative error code.
111 int snd_hdac_sync_audio_rate(struct hdac_device *codec, hda_nid_t nid,
112 int dev_id, int rate)
114 struct hdac_bus *bus = codec->bus;
115 struct drm_audio_component *acomp = bus->audio_component;
118 if (!acomp || !acomp->ops || !acomp->ops->sync_audio_rate)
121 if (acomp->audio_ops && acomp->audio_ops->pin2port) {
122 port = acomp->audio_ops->pin2port(codec, nid);
127 return acomp->ops->sync_audio_rate(acomp->dev, port, pipe, rate);
129 EXPORT_SYMBOL_GPL(snd_hdac_sync_audio_rate);
132 * snd_hdac_acomp_get_eld - Get the audio state and ELD via component
134 * @nid: the pin widget NID
135 * @dev_id: device identifier
136 * @audio_enabled: the pointer to store the current audio state
137 * @buffer: the buffer pointer to store ELD bytes
138 * @max_bytes: the max bytes to be stored on @buffer
140 * This function is supposed to be used only by a HD-audio controller
141 * driver that needs the interaction with graphics driver.
143 * This function queries the current state of the audio on the given
144 * digital port and fetches the ELD bytes onto the given buffer.
145 * It returns the number of bytes for the total ELD data, zero for
146 * invalid ELD, or a negative error code.
148 * The return size is the total bytes required for the whole ELD bytes,
149 * thus it may be over @max_bytes. If it's over @max_bytes, it implies
150 * that only a part of ELD bytes have been fetched.
152 int snd_hdac_acomp_get_eld(struct hdac_device *codec, hda_nid_t nid, int dev_id,
153 bool *audio_enabled, char *buffer, int max_bytes)
155 struct hdac_bus *bus = codec->bus;
156 struct drm_audio_component *acomp = bus->audio_component;
159 if (!acomp || !acomp->ops || !acomp->ops->get_eld)
163 if (acomp->audio_ops && acomp->audio_ops->pin2port) {
164 port = acomp->audio_ops->pin2port(codec, nid);
169 return acomp->ops->get_eld(acomp->dev, port, pipe, audio_enabled,
172 EXPORT_SYMBOL_GPL(snd_hdac_acomp_get_eld);
174 static int hdac_component_master_bind(struct device *dev)
176 struct drm_audio_component *acomp = hdac_get_acomp(dev);
182 ret = component_bind_all(dev, acomp);
186 if (WARN_ON(!(acomp->dev && acomp->ops))) {
191 /* pin the module to avoid dynamic unbinding, but only if given */
192 if (!try_module_get(acomp->ops->owner)) {
197 if (acomp->audio_ops && acomp->audio_ops->master_bind) {
198 ret = acomp->audio_ops->master_bind(dev, acomp);
206 module_put(acomp->ops->owner);
208 component_unbind_all(dev, acomp);
213 static void hdac_component_master_unbind(struct device *dev)
215 struct drm_audio_component *acomp = hdac_get_acomp(dev);
217 if (acomp->audio_ops && acomp->audio_ops->master_unbind)
218 acomp->audio_ops->master_unbind(dev, acomp);
219 module_put(acomp->ops->owner);
220 component_unbind_all(dev, acomp);
221 WARN_ON(acomp->ops || acomp->dev);
224 static const struct component_master_ops hdac_component_master_ops = {
225 .bind = hdac_component_master_bind,
226 .unbind = hdac_component_master_unbind,
230 * snd_hdac_acomp_register_notifier - Register audio component ops
232 * @aops: audio component ops
234 * This function is supposed to be used only by a HD-audio controller
235 * driver that needs the interaction with graphics driver.
237 * This function sets the given ops to be called by the graphics driver.
239 * Returns zero for success or a negative error code.
241 int snd_hdac_acomp_register_notifier(struct hdac_bus *bus,
242 const struct drm_audio_component_audio_ops *aops)
244 if (!bus->audio_component)
247 bus->audio_component->audio_ops = aops;
250 EXPORT_SYMBOL_GPL(snd_hdac_acomp_register_notifier);
253 * snd_hdac_acomp_init - Initialize audio component
255 * @match_master: match function for finding components
256 * @extra_size: Extra bytes to allocate
258 * This function is supposed to be used only by a HD-audio controller
259 * driver that needs the interaction with graphics driver.
261 * This function initializes and sets up the audio component to communicate
262 * with graphics driver.
264 * Unlike snd_hdac_i915_init(), this function doesn't synchronize with the
265 * binding with the DRM component. Each caller needs to sync via master_bind
268 * Returns zero for success or a negative error code.
270 int snd_hdac_acomp_init(struct hdac_bus *bus,
271 const struct drm_audio_component_audio_ops *aops,
272 int (*match_master)(struct device *, int, void *),
275 struct component_match *match = NULL;
276 struct device *dev = bus->dev;
277 struct drm_audio_component *acomp;
280 if (WARN_ON(hdac_get_acomp(dev)))
283 acomp = devres_alloc(hdac_acomp_release, sizeof(*acomp) + extra_size,
287 acomp->audio_ops = aops;
288 bus->audio_component = acomp;
289 devres_add(dev, acomp);
291 component_match_add_typed(dev, &match, match_master, bus);
292 ret = component_master_add_with_match(dev, &hdac_component_master_ops,
300 bus->audio_component = NULL;
301 devres_destroy(dev, hdac_acomp_release, NULL, NULL);
302 dev_info(dev, "failed to add audio component master (%d)\n", ret);
306 EXPORT_SYMBOL_GPL(snd_hdac_acomp_init);
309 * snd_hdac_acomp_exit - Finalize audio component
312 * This function is supposed to be used only by a HD-audio controller
313 * driver that needs the interaction with graphics driver.
315 * This function releases the audio component that has been used.
317 * Returns zero for success or a negative error code.
319 int snd_hdac_acomp_exit(struct hdac_bus *bus)
321 struct device *dev = bus->dev;
322 struct drm_audio_component *acomp = bus->audio_component;
327 if (WARN_ON(bus->display_power_active) && acomp->ops)
328 acomp->ops->put_power(acomp->dev);
330 bus->display_power_active = false;
331 bus->display_power_status = 0;
333 component_master_del(dev, &hdac_component_master_ops);
335 bus->audio_component = NULL;
336 devres_destroy(dev, hdac_acomp_release, NULL, NULL);
340 EXPORT_SYMBOL_GPL(snd_hdac_acomp_exit);