[mirror_ubuntu-hirsute-kernel.git] / sound / hda / hdac_component.c

// SPDX-License-Identifier: GPL-2.0
// hdac_component.c - routines for sync between HD-A core and DRM driver

#include <linux/init.h>
#include <linux/module.h>
#include <linux/pci.h>
#include <linux/component.h>
#include <sound/core.h>
#include <sound/hdaudio.h>
#include <sound/hda_component.h>
#include <sound/hda_register.h>

static void hdac_acomp_release(struct device *dev, void *res)
{
}

static struct drm_audio_component *hdac_get_acomp(struct device *dev)
{
	return devres_find(dev, hdac_acomp_release, NULL, NULL);
}

/**
 * snd_hdac_set_codec_wakeup - Enable / disable HDMI/DP codec wakeup
 * @bus: HDA core bus
 * @enable: enable or disable the wakeup
 *
 * This function is supposed to be used only by a HD-audio controller
 * driver that needs the interaction with graphics driver.
 *
 * This function should be called during the chip reset, also called at
 * resume for updating STATESTS register read.
 *
 * Returns zero for success or a negative error code.
 */
int snd_hdac_set_codec_wakeup(struct hdac_bus *bus, bool enable)
{
	struct drm_audio_component *acomp = bus->audio_component;

	if (!acomp || !acomp->ops)
		return -ENODEV;

	if (!acomp->ops->codec_wake_override)
		return 0;

	dev_dbg(bus->dev, "%s codec wakeup\n",
		enable ? "enable" : "disable");

	acomp->ops->codec_wake_override(acomp->dev, enable);

	return 0;
}
EXPORT_SYMBOL_GPL(snd_hdac_set_codec_wakeup);

/**
 * snd_hdac_display_power - Power up / down the power refcount
 * @bus: HDA core bus
 * @idx: HDA codec address, pass HDA_CODEC_IDX_CONTROLLER for controller
 * @enable: power up or down
 *
 * This function is used by either HD-audio controller or codec driver that
 * needs the interaction with graphics driver.
 *
 * This function updates the power status, and calls the get_power() and
 * put_power() ops accordingly, toggling the codec wakeup, too.
 */
void snd_hdac_display_power(struct hdac_bus *bus, unsigned int idx, bool enable)
{
	struct drm_audio_component *acomp = bus->audio_component;

	dev_dbg(bus->dev, "display power %s\n",
		enable ? "enable" : "disable");

	mutex_lock(&bus->lock);
	if (enable)
		set_bit(idx, &bus->display_power_status);
	else
		clear_bit(idx, &bus->display_power_status);

	if (!acomp || !acomp->ops)
		goto unlock;

	if (bus->display_power_status) {
		if (!bus->display_power_active) {
			unsigned long cookie = -1;

			if (acomp->ops->get_power)
				cookie = acomp->ops->get_power(acomp->dev);

			snd_hdac_set_codec_wakeup(bus, true);
			snd_hdac_set_codec_wakeup(bus, false);
			bus->display_power_active = cookie;
		}
	} else {
		if (bus->display_power_active) {
			unsigned long cookie = bus->display_power_active;

			if (acomp->ops->put_power)
				acomp->ops->put_power(acomp->dev, cookie);

			bus->display_power_active = 0;
		}
	}
 unlock:
	mutex_unlock(&bus->lock);
}
EXPORT_SYMBOL_GPL(snd_hdac_display_power);

/**
 * snd_hdac_sync_audio_rate - Set N/CTS based on the sample rate
 * @codec: HDA codec
 * @nid: the pin widget NID
 * @dev_id: device identifier
 * @rate: the sample rate to set
 *
 * This function is supposed to be used only by a HD-audio controller
 * driver that needs the interaction with graphics driver.
 *
 * This function sets N/CTS value based on the given sample rate.
 * Returns zero for success, or a negative error code.
 */
int snd_hdac_sync_audio_rate(struct hdac_device *codec, hda_nid_t nid,
			     int dev_id, int rate)
{
	struct hdac_bus *bus = codec->bus;
	struct drm_audio_component *acomp = bus->audio_component;
	int port, pipe;

	if (!acomp || !acomp->ops || !acomp->ops->sync_audio_rate)
		return -ENODEV;
	port = nid;
	if (acomp->audio_ops && acomp->audio_ops->pin2port) {
		port = acomp->audio_ops->pin2port(codec, nid);
		if (port < 0)
			return -EINVAL;
	}
	pipe = dev_id;
	return acomp->ops->sync_audio_rate(acomp->dev, port, pipe, rate);
}
EXPORT_SYMBOL_GPL(snd_hdac_sync_audio_rate);

/**
 * snd_hdac_acomp_get_eld - Get the audio state and ELD via component
 * @codec: HDA codec
 * @nid: the pin widget NID
 * @dev_id: device identifier
 * @audio_enabled: the pointer to store the current audio state
 * @buffer: the buffer pointer to store ELD bytes
 * @max_bytes: the max bytes to be stored on @buffer
 *
 * This function is supposed to be used only by a HD-audio controller
 * driver that needs the interaction with graphics driver.
 *
 * This function queries the current state of the audio on the given
 * digital port and fetches the ELD bytes onto the given buffer.
 * It returns the number of bytes for the total ELD data, zero for
 * invalid ELD, or a negative error code.
 *
 * The return size is the total bytes required for the whole ELD bytes,
 * thus it may be over @max_bytes.  If it's over @max_bytes, it implies
 * that only a part of ELD bytes have been fetched.
 */
int snd_hdac_acomp_get_eld(struct hdac_device *codec, hda_nid_t nid, int dev_id,
			   bool *audio_enabled, char *buffer, int max_bytes)
{
	struct hdac_bus *bus = codec->bus;
	struct drm_audio_component *acomp = bus->audio_component;
	int port, pipe;

	if (!acomp || !acomp->ops || !acomp->ops->get_eld)
		return -ENODEV;

	port = nid;
	if (acomp->audio_ops && acomp->audio_ops->pin2port) {
		port = acomp->audio_ops->pin2port(codec, nid);
		if (port < 0)
			return -EINVAL;
	}
	pipe = dev_id;
	return acomp->ops->get_eld(acomp->dev, port, pipe, audio_enabled,
				   buffer, max_bytes);
}
EXPORT_SYMBOL_GPL(snd_hdac_acomp_get_eld);

static int hdac_component_master_bind(struct device *dev)
{
	struct drm_audio_component *acomp = hdac_get_acomp(dev);
	int ret;

	if (WARN_ON(!acomp))
		return -EINVAL;

	ret = component_bind_all(dev, acomp);
	if (ret < 0)
		return ret;

	if (WARN_ON(!(acomp->dev && acomp->ops))) {
		ret = -EINVAL;
		goto out_unbind;
	}

	/* pin the module to avoid dynamic unbinding, but only if given */
	if (!try_module_get(acomp->ops->owner)) {
		ret = -ENODEV;
		goto out_unbind;
	}

	if (acomp->audio_ops && acomp->audio_ops->master_bind) {
		ret = acomp->audio_ops->master_bind(dev, acomp);
		if (ret < 0)
			goto module_put;
	}

	return 0;

 module_put:
	module_put(acomp->ops->owner);
out_unbind:
	component_unbind_all(dev, acomp);

	return ret;
}

static void hdac_component_master_unbind(struct device *dev)
{
	struct drm_audio_component *acomp = hdac_get_acomp(dev);

	if (acomp->audio_ops && acomp->audio_ops->master_unbind)
		acomp->audio_ops->master_unbind(dev, acomp);
	module_put(acomp->ops->owner);
	component_unbind_all(dev, acomp);
	WARN_ON(acomp->ops || acomp->dev);
}

static const struct component_master_ops hdac_component_master_ops = {
	.bind = hdac_component_master_bind,
	.unbind = hdac_component_master_unbind,
};

/**
 * snd_hdac_acomp_register_notifier - Register audio component ops
 * @bus: HDA core bus
 * @aops: audio component ops
 *
 * This function is supposed to be used only by a HD-audio controller
 * driver that needs the interaction with graphics driver.
 *
 * This function sets the given ops to be called by the graphics driver.
 *
 * Returns zero for success or a negative error code.
 */
int snd_hdac_acomp_register_notifier(struct hdac_bus *bus,
				    const struct drm_audio_component_audio_ops *aops)
{
	if (!bus->audio_component)
		return -ENODEV;

	bus->audio_component->audio_ops = aops;
	return 0;
}
EXPORT_SYMBOL_GPL(snd_hdac_acomp_register_notifier);

/**
 * snd_hdac_acomp_init - Initialize audio component
 * @bus: HDA core bus
 * @aops: audio component ops
 * @match_master: match function for finding components
 * @extra_size: Extra bytes to allocate
 *
 * This function is supposed to be used only by a HD-audio controller
 * driver that needs the interaction with graphics driver.
 *
 * This function initializes and sets up the audio component to communicate
 * with graphics driver.
 *
 * Unlike snd_hdac_i915_init(), this function doesn't synchronize with the
 * binding with the DRM component.  Each caller needs to sync via master_bind
 * audio_ops.
 *
 * Returns zero for success or a negative error code.
 */
int snd_hdac_acomp_init(struct hdac_bus *bus,
			const struct drm_audio_component_audio_ops *aops,
			int (*match_master)(struct device *, int, void *),
			size_t extra_size)
{
	struct component_match *match = NULL;
	struct device *dev = bus->dev;
	struct drm_audio_component *acomp;
	int ret;

	if (WARN_ON(hdac_get_acomp(dev)))
		return -EBUSY;

	acomp = devres_alloc(hdac_acomp_release, sizeof(*acomp) + extra_size,
			     GFP_KERNEL);
	if (!acomp)
		return -ENOMEM;
	acomp->audio_ops = aops;
	bus->audio_component = acomp;
	devres_add(dev, acomp);

	component_match_add_typed(dev, &match, match_master, bus);
	ret = component_master_add_with_match(dev, &hdac_component_master_ops,
					      match);
	if (ret < 0)
		goto out_err;

	return 0;

out_err:
	bus->audio_component = NULL;
	devres_destroy(dev, hdac_acomp_release, NULL, NULL);
	dev_info(dev, "failed to add audio component master (%d)\n", ret);

	return ret;
}
EXPORT_SYMBOL_GPL(snd_hdac_acomp_init);

/**
 * snd_hdac_acomp_exit - Finalize audio component
 * @bus: HDA core bus
 *
 * This function is supposed to be used only by a HD-audio controller
 * driver that needs the interaction with graphics driver.
 *
 * This function releases the audio component that has been used.
 *
 * Returns zero for success or a negative error code.
 */
int snd_hdac_acomp_exit(struct hdac_bus *bus)
{
	struct device *dev = bus->dev;
	struct drm_audio_component *acomp = bus->audio_component;

	if (!acomp)
		return 0;

	if (WARN_ON(bus->display_power_active) && acomp->ops)
		acomp->ops->put_power(acomp->dev, bus->display_power_active);

	bus->display_power_active = 0;
	bus->display_power_status = 0;

	component_master_del(dev, &hdac_component_master_ops);

	bus->audio_component = NULL;
	devres_destroy(dev, hdac_acomp_release, NULL, NULL);

	return 0;
}
EXPORT_SYMBOL_GPL(snd_hdac_acomp_exit);
Commit	Line	Data
a57942bf TI	1	// SPDX-License-Identifier: GPL-2.0
	2	// hdac_component.c - routines for sync between HD-A core and DRM driver
	3
	4	#include <linux/init.h>
	5	#include <linux/module.h>
	6	#include <linux/pci.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>
	12
	13	static void hdac_acomp_release(struct device dev, void res)
	14	{
	15	}
	16
	17	static struct drm_audio_component hdac_get_acomp(struct device dev)
	18	{
	19	return devres_find(dev, hdac_acomp_release, NULL, NULL);
	20	}
	21
	22	/**
	23	* snd_hdac_set_codec_wakeup - Enable / disable HDMI/DP codec wakeup
	24	* @bus: HDA core bus
	25	* @enable: enable or disable the wakeup
	26	*
	27	* This function is supposed to be used only by a HD-audio controller
	28	* driver that needs the interaction with graphics driver.
	29	*
	30	* This function should be called during the chip reset, also called at
	31	* resume for updating STATESTS register read.
	32	*
	33	* Returns zero for success or a negative error code.
	34	*/
	35	int snd_hdac_set_codec_wakeup(struct hdac_bus *bus, bool enable)
	36	{
	37	struct drm_audio_component *acomp = bus->audio_component;
	38
	39	if (!acomp \|\| !acomp->ops)
	40	return -ENODEV;
	41
	42	if (!acomp->ops->codec_wake_override)
	43	return 0;
	44
	45	dev_dbg(bus->dev, "%s codec wakeup\n",
	46	enable ? "enable" : "disable");
	47
	48	acomp->ops->codec_wake_override(acomp->dev, enable);
	49
	50	return 0;
	51	}
	52	EXPORT_SYMBOL_GPL(snd_hdac_set_codec_wakeup);
	53
	54	/**
	55	* snd_hdac_display_power - Power up / down the power refcount
	56	* @bus: HDA core bus
029d92c2	57	* @idx: HDA codec address, pass HDA_CODEC_IDX_CONTROLLER for controller
a57942bf TI	58	* @enable: power up or down
a57942bf TI	59	*
029d92c2 TI	60	* This function is used by either HD-audio controller or codec driver that
029d92c2 TI	61	* needs the interaction with graphics driver.
a57942bf	62	*
029d92c2	63	* This function updates the power status, and calls the get_power() and
a57942bf	64	* put_power() ops accordingly, toggling the codec wakeup, too.
a57942bf	65	*/
4f799e73	66	void snd_hdac_display_power(struct hdac_bus *bus, unsigned int idx, bool enable)
a57942bf TI	67	{
	68	struct drm_audio_component *acomp = bus->audio_component;
	69
a57942bf TI	70	dev_dbg(bus->dev, "display power %s\n",
a57942bf TI	71	enable ? "enable" : "disable");
d7a181da TI	72
d7a181da TI	73	mutex_lock(&bus->lock);
029d92c2 TI	74	if (enable)
	75	set_bit(idx, &bus->display_power_status);
	76	else
	77	clear_bit(idx, &bus->display_power_status);
a57942bf	78
029d92c2	79	if (!acomp \|\| !acomp->ops)
d7a181da	80	goto unlock;
029d92c2 TI	81
	82	if (bus->display_power_status) {
	83	if (!bus->display_power_active) {
d31c85fc CW	84	unsigned long cookie = -1;
d31c85fc CW	85
a57942bf	86	if (acomp->ops->get_power)
d31c85fc CW	87	cookie = acomp->ops->get_power(acomp->dev);
d31c85fc CW	88
a57942bf TI	89	snd_hdac_set_codec_wakeup(bus, true);
a57942bf TI	90	snd_hdac_set_codec_wakeup(bus, false);
d31c85fc	91	bus->display_power_active = cookie;
a57942bf TI	92	}
a57942bf TI	93	} else {
029d92c2	94	if (bus->display_power_active) {
d31c85fc CW	95	unsigned long cookie = bus->display_power_active;
d31c85fc CW	96
a57942bf	97	if (acomp->ops->put_power)
d31c85fc CW	98	acomp->ops->put_power(acomp->dev, cookie);
	99
	100	bus->display_power_active = 0;
029d92c2	101	}
a57942bf	102	}
d7a181da TI	103	unlock:
d7a181da TI	104	mutex_unlock(&bus->lock);
a57942bf TI	105	}
	106	EXPORT_SYMBOL_GPL(snd_hdac_display_power);
	107
	108	/**
	109	* snd_hdac_sync_audio_rate - Set N/CTS based on the sample rate
	110	* @codec: HDA codec
	111	* @nid: the pin widget NID
	112	* @dev_id: device identifier
	113	* @rate: the sample rate to set
	114	*
	115	* This function is supposed to be used only by a HD-audio controller
	116	* driver that needs the interaction with graphics driver.
	117	*
	118	* This function sets N/CTS value based on the given sample rate.
	119	* Returns zero for success, or a negative error code.
	120	*/
	121	int snd_hdac_sync_audio_rate(struct hdac_device *codec, hda_nid_t nid,
	122	int dev_id, int rate)
	123	{
	124	struct hdac_bus *bus = codec->bus;
	125	struct drm_audio_component *acomp = bus->audio_component;
	126	int port, pipe;
	127
	128	if (!acomp \|\| !acomp->ops \|\| !acomp->ops->sync_audio_rate)
	129	return -ENODEV;
	130	port = nid;
	131	if (acomp->audio_ops && acomp->audio_ops->pin2port) {
	132	port = acomp->audio_ops->pin2port(codec, nid);
	133	if (port < 0)
	134	return -EINVAL;
	135	}
	136	pipe = dev_id;
	137	return acomp->ops->sync_audio_rate(acomp->dev, port, pipe, rate);
	138	}
	139	EXPORT_SYMBOL_GPL(snd_hdac_sync_audio_rate);
	140
	141	/**
	142	* snd_hdac_acomp_get_eld - Get the audio state and ELD via component
	143	* @codec: HDA codec
	144	* @nid: the pin widget NID
	145	* @dev_id: device identifier
	146	* @audio_enabled: the pointer to store the current audio state
	147	* @buffer: the buffer pointer to store ELD bytes
	148	* @max_bytes: the max bytes to be stored on @buffer
	149	*
	150	* This function is supposed to be used only by a HD-audio controller
	151	* driver that needs the interaction with graphics driver.
	152	*
	153	* This function queries the current state of the audio on the given
	154	* digital port and fetches the ELD bytes onto the given buffer.
	155	* It returns the number of bytes for the total ELD data, zero for
	156	* invalid ELD, or a negative error code.
	157	*
	158	* The return size is the total bytes required for the whole ELD bytes,
	159	* thus it may be over @max_bytes. If it's over @max_bytes, it implies
	160	* that only a part of ELD bytes have been fetched.
	161	*/
	162	int snd_hdac_acomp_get_eld(struct hdac_device *codec, hda_nid_t nid, int dev_id,
	163	bool audio_enabled, char buffer, int max_bytes)
	164	{
	165	struct hdac_bus *bus = codec->bus;
	166	struct drm_audio_component *acomp = bus->audio_component;
	167	int port, pipe;
	168
169	if (!acomp \|\| !acomp->ops \|\| !acomp->ops->get_eld)
170	return -ENODEV;
171
172	port = nid;
173	if (acomp->audio_ops && acomp->audio_ops->pin2port) {
174	port = acomp->audio_ops->pin2port(codec, nid);
175	if (port < 0)
176	return -EINVAL;
177	}
178	pipe = dev_id;
179	return acomp->ops->get_eld(acomp->dev, port, pipe, audio_enabled,
180	buffer, max_bytes);
181	}
182	EXPORT_SYMBOL_GPL(snd_hdac_acomp_get_eld);
183
184	static int hdac_component_master_bind(struct device *dev)
185	{
186	struct drm_audio_component *acomp = hdac_get_acomp(dev);
187	int ret;
188
189	if (WARN_ON(!acomp))
190	return -EINVAL;
191
192	ret = component_bind_all(dev, acomp);
193	if (ret < 0)
194	return ret;
195
196	if (WARN_ON(!(acomp->dev && acomp->ops))) {
197	ret = -EINVAL;
198	goto out_unbind;
199	}
200
201	/* pin the module to avoid dynamic unbinding, but only if given */
202	if (!try_module_get(acomp->ops->owner)) {
203	ret = -ENODEV;
204	goto out_unbind;
205	}
206
207	if (acomp->audio_ops && acomp->audio_ops->master_bind) {
208	ret = acomp->audio_ops->master_bind(dev, acomp);
209	if (ret < 0)
210	goto module_put;
211	}
212
213	return 0;
214
215	module_put:
216	module_put(acomp->ops->owner);
217	out_unbind:
218	component_unbind_all(dev, acomp);
219
220	return ret;
221	}
222
223	static void hdac_component_master_unbind(struct device *dev)
224	{
225	struct drm_audio_component *acomp = hdac_get_acomp(dev);
226
227	if (acomp->audio_ops && acomp->audio_ops->master_unbind)
228	acomp->audio_ops->master_unbind(dev, acomp);
229	module_put(acomp->ops->owner);
230	component_unbind_all(dev, acomp);
231	WARN_ON(acomp->ops \|\| acomp->dev);
232	}
233
234	static const struct component_master_ops hdac_component_master_ops = {
235	.bind = hdac_component_master_bind,
236	.unbind = hdac_component_master_unbind,
237	};
238
239	/**
240	* snd_hdac_acomp_register_notifier - Register audio component ops
241	* @bus: HDA core bus
242	* @aops: audio component ops
243	*
244	* This function is supposed to be used only by a HD-audio controller
245	* driver that needs the interaction with graphics driver.
246	*
247	* This function sets the given ops to be called by the graphics driver.
248	*
249	* Returns zero for success or a negative error code.
250	*/
251	int snd_hdac_acomp_register_notifier(struct hdac_bus *bus,
252	const struct drm_audio_component_audio_ops *aops)
253	{
254	if (!bus->audio_component)
255	return -ENODEV;
256
257	bus->audio_component->audio_ops = aops;
258	return 0;
259	}
260	EXPORT_SYMBOL_GPL(snd_hdac_acomp_register_notifier);
261
262	/**
263	* snd_hdac_acomp_init - Initialize audio component
264	* @bus: HDA core bus
6e57188f	265	* @aops: audio component ops
a57942bf TI	266	* @match_master: match function for finding components
	267	* @extra_size: Extra bytes to allocate
	268	*
	269	* This function is supposed to be used only by a HD-audio controller
	270	* driver that needs the interaction with graphics driver.
	271	*
	272	* This function initializes and sets up the audio component to communicate
	273	* with graphics driver.
	274	*
	275	* Unlike snd_hdac_i915_init(), this function doesn't synchronize with the
	276	* binding with the DRM component. Each caller needs to sync via master_bind
	277	* audio_ops.
	278	*
	279	* Returns zero for success or a negative error code.
	280	*/
	281	int snd_hdac_acomp_init(struct hdac_bus *bus,
	282	const struct drm_audio_component_audio_ops *aops,
8857c7d0	283	int (match_master)(struct device , int, void *),
a57942bf TI	284	size_t extra_size)
	285	{
	286	struct component_match *match = NULL;
	287	struct device *dev = bus->dev;
	288	struct drm_audio_component *acomp;
	289	int ret;
	290
	291	if (WARN_ON(hdac_get_acomp(dev)))
	292	return -EBUSY;
	293
	294	acomp = devres_alloc(hdac_acomp_release, sizeof(*acomp) + extra_size,
	295	GFP_KERNEL);
	296	if (!acomp)
	297	return -ENOMEM;
	298	acomp->audio_ops = aops;
	299	bus->audio_component = acomp;
	300	devres_add(dev, acomp);
	301
8857c7d0	302	component_match_add_typed(dev, &match, match_master, bus);
a57942bf TI	303	ret = component_master_add_with_match(dev, &hdac_component_master_ops,
	304	match);
	305	if (ret < 0)
	306	goto out_err;
	307
	308	return 0;
	309
	310	out_err:
	311	bus->audio_component = NULL;
	312	devres_destroy(dev, hdac_acomp_release, NULL, NULL);
	313	dev_info(dev, "failed to add audio component master (%d)\n", ret);
	314
	315	return ret;
	316	}
	317	EXPORT_SYMBOL_GPL(snd_hdac_acomp_init);
	318
	319	/**
	320	* snd_hdac_acomp_exit - Finalize audio component
	321	* @bus: HDA core bus
	322	*
	323	* This function is supposed to be used only by a HD-audio controller
	324	* driver that needs the interaction with graphics driver.
	325	*
	326	* This function releases the audio component that has been used.
	327	*
	328	* Returns zero for success or a negative error code.
	329	*/
	330	int snd_hdac_acomp_exit(struct hdac_bus *bus)
	331	{
	332	struct device *dev = bus->dev;
	333	struct drm_audio_component *acomp = bus->audio_component;
	334
	335	if (!acomp)
	336	return 0;
	337
029d92c2	338	if (WARN_ON(bus->display_power_active) && acomp->ops)
d31c85fc	339	acomp->ops->put_power(acomp->dev, bus->display_power_active);
a57942bf	340
d31c85fc	341	bus->display_power_active = 0;
029d92c2 TI	342	bus->display_power_status = 0;
029d92c2 TI	343
a57942bf TI	344	component_master_del(dev, &hdac_component_master_ops);
	345
	346	bus->audio_component = NULL;
	347	devres_destroy(dev, hdac_acomp_release, NULL, NULL);
	348
	349	return 0;
	350	}
	351	EXPORT_SYMBOL_GPL(snd_hdac_acomp_exit);