xref: /linux/sound/hda/hdac_device.c (revision b7019ac550eb3916f34d79db583e9b7ea2524afa)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * HD-audio codec core device
4  */
5 
6 #include <linux/init.h>
7 #include <linux/delay.h>
8 #include <linux/device.h>
9 #include <linux/slab.h>
10 #include <linux/module.h>
11 #include <linux/export.h>
12 #include <linux/pm_runtime.h>
13 #include <sound/hdaudio.h>
14 #include <sound/hda_regmap.h>
15 #include <sound/pcm.h>
16 #include "local.h"
17 
18 static void setup_fg_nodes(struct hdac_device *codec);
19 static int get_codec_vendor_name(struct hdac_device *codec);
20 
21 static void default_release(struct device *dev)
22 {
23 	snd_hdac_device_exit(container_of(dev, struct hdac_device, dev));
24 }
25 
26 /**
27  * snd_hdac_device_init - initialize the HD-audio codec base device
28  * @codec: device to initialize
29  * @bus: but to attach
30  * @name: device name string
31  * @addr: codec address
32  *
33  * Returns zero for success or a negative error code.
34  *
35  * This function increments the runtime PM counter and marks it active.
36  * The caller needs to turn it off appropriately later.
37  *
38  * The caller needs to set the device's release op properly by itself.
39  */
40 int snd_hdac_device_init(struct hdac_device *codec, struct hdac_bus *bus,
41 			 const char *name, unsigned int addr)
42 {
43 	struct device *dev;
44 	hda_nid_t fg;
45 	int err;
46 
47 	dev = &codec->dev;
48 	device_initialize(dev);
49 	dev->parent = bus->dev;
50 	dev->bus = &snd_hda_bus_type;
51 	dev->release = default_release;
52 	dev->groups = hdac_dev_attr_groups;
53 	dev_set_name(dev, "%s", name);
54 	device_enable_async_suspend(dev);
55 
56 	codec->bus = bus;
57 	codec->addr = addr;
58 	codec->type = HDA_DEV_CORE;
59 	mutex_init(&codec->widget_lock);
60 	pm_runtime_set_active(&codec->dev);
61 	pm_runtime_get_noresume(&codec->dev);
62 	atomic_set(&codec->in_pm, 0);
63 
64 	err = snd_hdac_bus_add_device(bus, codec);
65 	if (err < 0)
66 		goto error;
67 
68 	/* fill parameters */
69 	codec->vendor_id = snd_hdac_read_parm(codec, AC_NODE_ROOT,
70 					      AC_PAR_VENDOR_ID);
71 	if (codec->vendor_id == -1) {
72 		/* read again, hopefully the access method was corrected
73 		 * in the last read...
74 		 */
75 		codec->vendor_id = snd_hdac_read_parm(codec, AC_NODE_ROOT,
76 						      AC_PAR_VENDOR_ID);
77 	}
78 
79 	codec->subsystem_id = snd_hdac_read_parm(codec, AC_NODE_ROOT,
80 						 AC_PAR_SUBSYSTEM_ID);
81 	codec->revision_id = snd_hdac_read_parm(codec, AC_NODE_ROOT,
82 						AC_PAR_REV_ID);
83 
84 	setup_fg_nodes(codec);
85 	if (!codec->afg && !codec->mfg) {
86 		dev_err(dev, "no AFG or MFG node found\n");
87 		err = -ENODEV;
88 		goto error;
89 	}
90 
91 	fg = codec->afg ? codec->afg : codec->mfg;
92 
93 	err = snd_hdac_refresh_widgets(codec, false);
94 	if (err < 0)
95 		goto error;
96 
97 	codec->power_caps = snd_hdac_read_parm(codec, fg, AC_PAR_POWER_STATE);
98 	/* reread ssid if not set by parameter */
99 	if (codec->subsystem_id == -1 || codec->subsystem_id == 0)
100 		snd_hdac_read(codec, fg, AC_VERB_GET_SUBSYSTEM_ID, 0,
101 			      &codec->subsystem_id);
102 
103 	err = get_codec_vendor_name(codec);
104 	if (err < 0)
105 		goto error;
106 
107 	codec->chip_name = kasprintf(GFP_KERNEL, "ID %x",
108 				     codec->vendor_id & 0xffff);
109 	if (!codec->chip_name) {
110 		err = -ENOMEM;
111 		goto error;
112 	}
113 
114 	return 0;
115 
116  error:
117 	put_device(&codec->dev);
118 	return err;
119 }
120 EXPORT_SYMBOL_GPL(snd_hdac_device_init);
121 
122 /**
123  * snd_hdac_device_exit - clean up the HD-audio codec base device
124  * @codec: device to clean up
125  */
126 void snd_hdac_device_exit(struct hdac_device *codec)
127 {
128 	pm_runtime_put_noidle(&codec->dev);
129 	snd_hdac_bus_remove_device(codec->bus, codec);
130 	kfree(codec->vendor_name);
131 	kfree(codec->chip_name);
132 }
133 EXPORT_SYMBOL_GPL(snd_hdac_device_exit);
134 
135 /**
136  * snd_hdac_device_register - register the hd-audio codec base device
137  * codec: the device to register
138  */
139 int snd_hdac_device_register(struct hdac_device *codec)
140 {
141 	int err;
142 
143 	err = device_add(&codec->dev);
144 	if (err < 0)
145 		return err;
146 	mutex_lock(&codec->widget_lock);
147 	err = hda_widget_sysfs_init(codec);
148 	mutex_unlock(&codec->widget_lock);
149 	if (err < 0) {
150 		device_del(&codec->dev);
151 		return err;
152 	}
153 
154 	return 0;
155 }
156 EXPORT_SYMBOL_GPL(snd_hdac_device_register);
157 
158 /**
159  * snd_hdac_device_unregister - unregister the hd-audio codec base device
160  * codec: the device to unregister
161  */
162 void snd_hdac_device_unregister(struct hdac_device *codec)
163 {
164 	if (device_is_registered(&codec->dev)) {
165 		mutex_lock(&codec->widget_lock);
166 		hda_widget_sysfs_exit(codec);
167 		mutex_unlock(&codec->widget_lock);
168 		device_del(&codec->dev);
169 		snd_hdac_bus_remove_device(codec->bus, codec);
170 	}
171 }
172 EXPORT_SYMBOL_GPL(snd_hdac_device_unregister);
173 
174 /**
175  * snd_hdac_device_set_chip_name - set/update the codec name
176  * @codec: the HDAC device
177  * @name: name string to set
178  *
179  * Returns 0 if the name is set or updated, or a negative error code.
180  */
181 int snd_hdac_device_set_chip_name(struct hdac_device *codec, const char *name)
182 {
183 	char *newname;
184 
185 	if (!name)
186 		return 0;
187 	newname = kstrdup(name, GFP_KERNEL);
188 	if (!newname)
189 		return -ENOMEM;
190 	kfree(codec->chip_name);
191 	codec->chip_name = newname;
192 	return 0;
193 }
194 EXPORT_SYMBOL_GPL(snd_hdac_device_set_chip_name);
195 
196 /**
197  * snd_hdac_codec_modalias - give the module alias name
198  * @codec: HDAC device
199  * @buf: string buffer to store
200  * @size: string buffer size
201  *
202  * Returns the size of string, like snprintf(), or a negative error code.
203  */
204 int snd_hdac_codec_modalias(struct hdac_device *codec, char *buf, size_t size)
205 {
206 	return snprintf(buf, size, "hdaudio:v%08Xr%08Xa%02X\n",
207 			codec->vendor_id, codec->revision_id, codec->type);
208 }
209 EXPORT_SYMBOL_GPL(snd_hdac_codec_modalias);
210 
211 /**
212  * snd_hdac_make_cmd - compose a 32bit command word to be sent to the
213  *	HD-audio controller
214  * @codec: the codec object
215  * @nid: NID to encode
216  * @verb: verb to encode
217  * @parm: parameter to encode
218  *
219  * Return an encoded command verb or -1 for error.
220  */
221 unsigned int snd_hdac_make_cmd(struct hdac_device *codec, hda_nid_t nid,
222 			       unsigned int verb, unsigned int parm)
223 {
224 	u32 val, addr;
225 
226 	addr = codec->addr;
227 	if ((addr & ~0xf) || (nid & ~0x7f) ||
228 	    (verb & ~0xfff) || (parm & ~0xffff)) {
229 		dev_err(&codec->dev, "out of range cmd %x:%x:%x:%x\n",
230 			addr, nid, verb, parm);
231 		return -1;
232 	}
233 
234 	val = addr << 28;
235 	val |= (u32)nid << 20;
236 	val |= verb << 8;
237 	val |= parm;
238 	return val;
239 }
240 EXPORT_SYMBOL_GPL(snd_hdac_make_cmd);
241 
242 /**
243  * snd_hdac_exec_verb - execute an encoded verb
244  * @codec: the codec object
245  * @cmd: encoded verb to execute
246  * @flags: optional flags, pass zero for default
247  * @res: the pointer to store the result, NULL if running async
248  *
249  * Returns zero if successful, or a negative error code.
250  *
251  * This calls the exec_verb op when set in hdac_codec.  If not,
252  * call the default snd_hdac_bus_exec_verb().
253  */
254 int snd_hdac_exec_verb(struct hdac_device *codec, unsigned int cmd,
255 		       unsigned int flags, unsigned int *res)
256 {
257 	if (codec->exec_verb)
258 		return codec->exec_verb(codec, cmd, flags, res);
259 	return snd_hdac_bus_exec_verb(codec->bus, codec->addr, cmd, res);
260 }
261 EXPORT_SYMBOL_GPL(snd_hdac_exec_verb);
262 
263 
264 /**
265  * snd_hdac_read - execute a verb
266  * @codec: the codec object
267  * @nid: NID to execute a verb
268  * @verb: verb to execute
269  * @parm: parameter for a verb
270  * @res: the pointer to store the result, NULL if running async
271  *
272  * Returns zero if successful, or a negative error code.
273  */
274 int snd_hdac_read(struct hdac_device *codec, hda_nid_t nid,
275 		  unsigned int verb, unsigned int parm, unsigned int *res)
276 {
277 	unsigned int cmd = snd_hdac_make_cmd(codec, nid, verb, parm);
278 
279 	return snd_hdac_exec_verb(codec, cmd, 0, res);
280 }
281 EXPORT_SYMBOL_GPL(snd_hdac_read);
282 
283 /**
284  * _snd_hdac_read_parm - read a parmeter
285  *
286  * This function returns zero or an error unlike snd_hdac_read_parm().
287  */
288 int _snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid, int parm,
289 			unsigned int *res)
290 {
291 	unsigned int cmd;
292 
293 	cmd = snd_hdac_regmap_encode_verb(nid, AC_VERB_PARAMETERS) | parm;
294 	return snd_hdac_regmap_read_raw(codec, cmd, res);
295 }
296 EXPORT_SYMBOL_GPL(_snd_hdac_read_parm);
297 
298 /**
299  * snd_hdac_read_parm_uncached - read a codec parameter without caching
300  * @codec: the codec object
301  * @nid: NID to read a parameter
302  * @parm: parameter to read
303  *
304  * Returns -1 for error.  If you need to distinguish the error more
305  * strictly, use snd_hdac_read() directly.
306  */
307 int snd_hdac_read_parm_uncached(struct hdac_device *codec, hda_nid_t nid,
308 				int parm)
309 {
310 	unsigned int cmd, val;
311 
312 	cmd = snd_hdac_regmap_encode_verb(nid, AC_VERB_PARAMETERS) | parm;
313 	if (snd_hdac_regmap_read_raw_uncached(codec, cmd, &val) < 0)
314 		return -1;
315 	return val;
316 }
317 EXPORT_SYMBOL_GPL(snd_hdac_read_parm_uncached);
318 
319 /**
320  * snd_hdac_override_parm - override read-only parameters
321  * @codec: the codec object
322  * @nid: NID for the parameter
323  * @parm: the parameter to change
324  * @val: the parameter value to overwrite
325  */
326 int snd_hdac_override_parm(struct hdac_device *codec, hda_nid_t nid,
327 			   unsigned int parm, unsigned int val)
328 {
329 	unsigned int verb = (AC_VERB_PARAMETERS << 8) | (nid << 20) | parm;
330 	int err;
331 
332 	if (!codec->regmap)
333 		return -EINVAL;
334 
335 	codec->caps_overwriting = true;
336 	err = snd_hdac_regmap_write_raw(codec, verb, val);
337 	codec->caps_overwriting = false;
338 	return err;
339 }
340 EXPORT_SYMBOL_GPL(snd_hdac_override_parm);
341 
342 /**
343  * snd_hdac_get_sub_nodes - get start NID and number of subtree nodes
344  * @codec: the codec object
345  * @nid: NID to inspect
346  * @start_id: the pointer to store the starting NID
347  *
348  * Returns the number of subtree nodes or zero if not found.
349  * This function reads parameters always without caching.
350  */
351 int snd_hdac_get_sub_nodes(struct hdac_device *codec, hda_nid_t nid,
352 			   hda_nid_t *start_id)
353 {
354 	unsigned int parm;
355 
356 	parm = snd_hdac_read_parm_uncached(codec, nid, AC_PAR_NODE_COUNT);
357 	if (parm == -1) {
358 		*start_id = 0;
359 		return 0;
360 	}
361 	*start_id = (parm >> 16) & 0x7fff;
362 	return (int)(parm & 0x7fff);
363 }
364 EXPORT_SYMBOL_GPL(snd_hdac_get_sub_nodes);
365 
366 /*
367  * look for an AFG and MFG nodes
368  */
369 static void setup_fg_nodes(struct hdac_device *codec)
370 {
371 	int i, total_nodes, function_id;
372 	hda_nid_t nid;
373 
374 	total_nodes = snd_hdac_get_sub_nodes(codec, AC_NODE_ROOT, &nid);
375 	for (i = 0; i < total_nodes; i++, nid++) {
376 		function_id = snd_hdac_read_parm(codec, nid,
377 						 AC_PAR_FUNCTION_TYPE);
378 		switch (function_id & 0xff) {
379 		case AC_GRP_AUDIO_FUNCTION:
380 			codec->afg = nid;
381 			codec->afg_function_id = function_id & 0xff;
382 			codec->afg_unsol = (function_id >> 8) & 1;
383 			break;
384 		case AC_GRP_MODEM_FUNCTION:
385 			codec->mfg = nid;
386 			codec->mfg_function_id = function_id & 0xff;
387 			codec->mfg_unsol = (function_id >> 8) & 1;
388 			break;
389 		default:
390 			break;
391 		}
392 	}
393 }
394 
395 /**
396  * snd_hdac_refresh_widgets - Reset the widget start/end nodes
397  * @codec: the codec object
398  * @sysfs: re-initialize sysfs tree, too
399  */
400 int snd_hdac_refresh_widgets(struct hdac_device *codec, bool sysfs)
401 {
402 	hda_nid_t start_nid;
403 	int nums, err;
404 
405 	nums = snd_hdac_get_sub_nodes(codec, codec->afg, &start_nid);
406 	if (!start_nid || nums <= 0 || nums >= 0xff) {
407 		dev_err(&codec->dev, "cannot read sub nodes for FG 0x%02x\n",
408 			codec->afg);
409 		return -EINVAL;
410 	}
411 
412 	if (sysfs) {
413 		mutex_lock(&codec->widget_lock);
414 		err = hda_widget_sysfs_reinit(codec, start_nid, nums);
415 		mutex_unlock(&codec->widget_lock);
416 		if (err < 0)
417 			return err;
418 	}
419 
420 	codec->num_nodes = nums;
421 	codec->start_nid = start_nid;
422 	codec->end_nid = start_nid + nums;
423 	return 0;
424 }
425 EXPORT_SYMBOL_GPL(snd_hdac_refresh_widgets);
426 
427 /* return CONNLIST_LEN parameter of the given widget */
428 static unsigned int get_num_conns(struct hdac_device *codec, hda_nid_t nid)
429 {
430 	unsigned int wcaps = get_wcaps(codec, nid);
431 	unsigned int parm;
432 
433 	if (!(wcaps & AC_WCAP_CONN_LIST) &&
434 	    get_wcaps_type(wcaps) != AC_WID_VOL_KNB)
435 		return 0;
436 
437 	parm = snd_hdac_read_parm(codec, nid, AC_PAR_CONNLIST_LEN);
438 	if (parm == -1)
439 		parm = 0;
440 	return parm;
441 }
442 
443 /**
444  * snd_hdac_get_connections - get a widget connection list
445  * @codec: the codec object
446  * @nid: NID
447  * @conn_list: the array to store the results, can be NULL
448  * @max_conns: the max size of the given array
449  *
450  * Returns the number of connected widgets, zero for no connection, or a
451  * negative error code.  When the number of elements don't fit with the
452  * given array size, it returns -ENOSPC.
453  *
454  * When @conn_list is NULL, it just checks the number of connections.
455  */
456 int snd_hdac_get_connections(struct hdac_device *codec, hda_nid_t nid,
457 			     hda_nid_t *conn_list, int max_conns)
458 {
459 	unsigned int parm;
460 	int i, conn_len, conns, err;
461 	unsigned int shift, num_elems, mask;
462 	hda_nid_t prev_nid;
463 	int null_count = 0;
464 
465 	parm = get_num_conns(codec, nid);
466 	if (!parm)
467 		return 0;
468 
469 	if (parm & AC_CLIST_LONG) {
470 		/* long form */
471 		shift = 16;
472 		num_elems = 2;
473 	} else {
474 		/* short form */
475 		shift = 8;
476 		num_elems = 4;
477 	}
478 	conn_len = parm & AC_CLIST_LENGTH;
479 	mask = (1 << (shift-1)) - 1;
480 
481 	if (!conn_len)
482 		return 0; /* no connection */
483 
484 	if (conn_len == 1) {
485 		/* single connection */
486 		err = snd_hdac_read(codec, nid, AC_VERB_GET_CONNECT_LIST, 0,
487 				    &parm);
488 		if (err < 0)
489 			return err;
490 		if (conn_list)
491 			conn_list[0] = parm & mask;
492 		return 1;
493 	}
494 
495 	/* multi connection */
496 	conns = 0;
497 	prev_nid = 0;
498 	for (i = 0; i < conn_len; i++) {
499 		int range_val;
500 		hda_nid_t val, n;
501 
502 		if (i % num_elems == 0) {
503 			err = snd_hdac_read(codec, nid,
504 					    AC_VERB_GET_CONNECT_LIST, i,
505 					    &parm);
506 			if (err < 0)
507 				return -EIO;
508 		}
509 		range_val = !!(parm & (1 << (shift-1))); /* ranges */
510 		val = parm & mask;
511 		if (val == 0 && null_count++) {  /* no second chance */
512 			dev_dbg(&codec->dev,
513 				"invalid CONNECT_LIST verb %x[%i]:%x\n",
514 				nid, i, parm);
515 			return 0;
516 		}
517 		parm >>= shift;
518 		if (range_val) {
519 			/* ranges between the previous and this one */
520 			if (!prev_nid || prev_nid >= val) {
521 				dev_warn(&codec->dev,
522 					 "invalid dep_range_val %x:%x\n",
523 					 prev_nid, val);
524 				continue;
525 			}
526 			for (n = prev_nid + 1; n <= val; n++) {
527 				if (conn_list) {
528 					if (conns >= max_conns)
529 						return -ENOSPC;
530 					conn_list[conns] = n;
531 				}
532 				conns++;
533 			}
534 		} else {
535 			if (conn_list) {
536 				if (conns >= max_conns)
537 					return -ENOSPC;
538 				conn_list[conns] = val;
539 			}
540 			conns++;
541 		}
542 		prev_nid = val;
543 	}
544 	return conns;
545 }
546 EXPORT_SYMBOL_GPL(snd_hdac_get_connections);
547 
548 #ifdef CONFIG_PM
549 /**
550  * snd_hdac_power_up - power up the codec
551  * @codec: the codec object
552  *
553  * This function calls the runtime PM helper to power up the given codec.
554  * Unlike snd_hdac_power_up_pm(), you should call this only for the code
555  * path that isn't included in PM path.  Otherwise it gets stuck.
556  *
557  * Returns zero if successful, or a negative error code.
558  */
559 int snd_hdac_power_up(struct hdac_device *codec)
560 {
561 	return pm_runtime_get_sync(&codec->dev);
562 }
563 EXPORT_SYMBOL_GPL(snd_hdac_power_up);
564 
565 /**
566  * snd_hdac_power_down - power down the codec
567  * @codec: the codec object
568  *
569  * Returns zero if successful, or a negative error code.
570  */
571 int snd_hdac_power_down(struct hdac_device *codec)
572 {
573 	struct device *dev = &codec->dev;
574 
575 	pm_runtime_mark_last_busy(dev);
576 	return pm_runtime_put_autosuspend(dev);
577 }
578 EXPORT_SYMBOL_GPL(snd_hdac_power_down);
579 
580 /**
581  * snd_hdac_power_up_pm - power up the codec
582  * @codec: the codec object
583  *
584  * This function can be called in a recursive code path like init code
585  * which may be called by PM suspend/resume again.  OTOH, if a power-up
586  * call must wake up the sleeper (e.g. in a kctl callback), use
587  * snd_hdac_power_up() instead.
588  *
589  * Returns zero if successful, or a negative error code.
590  */
591 int snd_hdac_power_up_pm(struct hdac_device *codec)
592 {
593 	if (!atomic_inc_not_zero(&codec->in_pm))
594 		return snd_hdac_power_up(codec);
595 	return 0;
596 }
597 EXPORT_SYMBOL_GPL(snd_hdac_power_up_pm);
598 
599 /* like snd_hdac_power_up_pm(), but only increment the pm count when
600  * already powered up.  Returns -1 if not powered up, 1 if incremented
601  * or 0 if unchanged.  Only used in hdac_regmap.c
602  */
603 int snd_hdac_keep_power_up(struct hdac_device *codec)
604 {
605 	if (!atomic_inc_not_zero(&codec->in_pm)) {
606 		int ret = pm_runtime_get_if_in_use(&codec->dev);
607 		if (!ret)
608 			return -1;
609 		if (ret < 0)
610 			return 0;
611 	}
612 	return 1;
613 }
614 
615 /**
616  * snd_hdac_power_down_pm - power down the codec
617  * @codec: the codec object
618  *
619  * Like snd_hdac_power_up_pm(), this function is used in a recursive
620  * code path like init code which may be called by PM suspend/resume again.
621  *
622  * Returns zero if successful, or a negative error code.
623  */
624 int snd_hdac_power_down_pm(struct hdac_device *codec)
625 {
626 	if (atomic_dec_if_positive(&codec->in_pm) < 0)
627 		return snd_hdac_power_down(codec);
628 	return 0;
629 }
630 EXPORT_SYMBOL_GPL(snd_hdac_power_down_pm);
631 #endif
632 
633 /* codec vendor labels */
634 struct hda_vendor_id {
635 	unsigned int id;
636 	const char *name;
637 };
638 
639 static struct hda_vendor_id hda_vendor_ids[] = {
640 	{ 0x1002, "ATI" },
641 	{ 0x1013, "Cirrus Logic" },
642 	{ 0x1057, "Motorola" },
643 	{ 0x1095, "Silicon Image" },
644 	{ 0x10de, "Nvidia" },
645 	{ 0x10ec, "Realtek" },
646 	{ 0x1102, "Creative" },
647 	{ 0x1106, "VIA" },
648 	{ 0x111d, "IDT" },
649 	{ 0x11c1, "LSI" },
650 	{ 0x11d4, "Analog Devices" },
651 	{ 0x13f6, "C-Media" },
652 	{ 0x14f1, "Conexant" },
653 	{ 0x17e8, "Chrontel" },
654 	{ 0x1854, "LG" },
655 	{ 0x1aec, "Wolfson Microelectronics" },
656 	{ 0x1af4, "QEMU" },
657 	{ 0x434d, "C-Media" },
658 	{ 0x8086, "Intel" },
659 	{ 0x8384, "SigmaTel" },
660 	{} /* terminator */
661 };
662 
663 /* store the codec vendor name */
664 static int get_codec_vendor_name(struct hdac_device *codec)
665 {
666 	const struct hda_vendor_id *c;
667 	u16 vendor_id = codec->vendor_id >> 16;
668 
669 	for (c = hda_vendor_ids; c->id; c++) {
670 		if (c->id == vendor_id) {
671 			codec->vendor_name = kstrdup(c->name, GFP_KERNEL);
672 			return codec->vendor_name ? 0 : -ENOMEM;
673 		}
674 	}
675 
676 	codec->vendor_name = kasprintf(GFP_KERNEL, "Generic %04x", vendor_id);
677 	return codec->vendor_name ? 0 : -ENOMEM;
678 }
679 
680 /*
681  * stream formats
682  */
683 struct hda_rate_tbl {
684 	unsigned int hz;
685 	unsigned int alsa_bits;
686 	unsigned int hda_fmt;
687 };
688 
689 /* rate = base * mult / div */
690 #define HDA_RATE(base, mult, div) \
691 	(AC_FMT_BASE_##base##K | (((mult) - 1) << AC_FMT_MULT_SHIFT) | \
692 	 (((div) - 1) << AC_FMT_DIV_SHIFT))
693 
694 static struct hda_rate_tbl rate_bits[] = {
695 	/* rate in Hz, ALSA rate bitmask, HDA format value */
696 
697 	/* autodetected value used in snd_hda_query_supported_pcm */
698 	{ 8000, SNDRV_PCM_RATE_8000, HDA_RATE(48, 1, 6) },
699 	{ 11025, SNDRV_PCM_RATE_11025, HDA_RATE(44, 1, 4) },
700 	{ 16000, SNDRV_PCM_RATE_16000, HDA_RATE(48, 1, 3) },
701 	{ 22050, SNDRV_PCM_RATE_22050, HDA_RATE(44, 1, 2) },
702 	{ 32000, SNDRV_PCM_RATE_32000, HDA_RATE(48, 2, 3) },
703 	{ 44100, SNDRV_PCM_RATE_44100, HDA_RATE(44, 1, 1) },
704 	{ 48000, SNDRV_PCM_RATE_48000, HDA_RATE(48, 1, 1) },
705 	{ 88200, SNDRV_PCM_RATE_88200, HDA_RATE(44, 2, 1) },
706 	{ 96000, SNDRV_PCM_RATE_96000, HDA_RATE(48, 2, 1) },
707 	{ 176400, SNDRV_PCM_RATE_176400, HDA_RATE(44, 4, 1) },
708 	{ 192000, SNDRV_PCM_RATE_192000, HDA_RATE(48, 4, 1) },
709 #define AC_PAR_PCM_RATE_BITS	11
710 	/* up to bits 10, 384kHZ isn't supported properly */
711 
712 	/* not autodetected value */
713 	{ 9600, SNDRV_PCM_RATE_KNOT, HDA_RATE(48, 1, 5) },
714 
715 	{ 0 } /* terminator */
716 };
717 
718 /**
719  * snd_hdac_calc_stream_format - calculate the format bitset
720  * @rate: the sample rate
721  * @channels: the number of channels
722  * @format: the PCM format (SNDRV_PCM_FORMAT_XXX)
723  * @maxbps: the max. bps
724  * @spdif_ctls: HD-audio SPDIF status bits (0 if irrelevant)
725  *
726  * Calculate the format bitset from the given rate, channels and th PCM format.
727  *
728  * Return zero if invalid.
729  */
730 unsigned int snd_hdac_calc_stream_format(unsigned int rate,
731 					 unsigned int channels,
732 					 snd_pcm_format_t format,
733 					 unsigned int maxbps,
734 					 unsigned short spdif_ctls)
735 {
736 	int i;
737 	unsigned int val = 0;
738 
739 	for (i = 0; rate_bits[i].hz; i++)
740 		if (rate_bits[i].hz == rate) {
741 			val = rate_bits[i].hda_fmt;
742 			break;
743 		}
744 	if (!rate_bits[i].hz)
745 		return 0;
746 
747 	if (channels == 0 || channels > 8)
748 		return 0;
749 	val |= channels - 1;
750 
751 	switch (snd_pcm_format_width(format)) {
752 	case 8:
753 		val |= AC_FMT_BITS_8;
754 		break;
755 	case 16:
756 		val |= AC_FMT_BITS_16;
757 		break;
758 	case 20:
759 	case 24:
760 	case 32:
761 		if (maxbps >= 32 || format == SNDRV_PCM_FORMAT_FLOAT_LE)
762 			val |= AC_FMT_BITS_32;
763 		else if (maxbps >= 24)
764 			val |= AC_FMT_BITS_24;
765 		else
766 			val |= AC_FMT_BITS_20;
767 		break;
768 	default:
769 		return 0;
770 	}
771 
772 	if (spdif_ctls & AC_DIG1_NONAUDIO)
773 		val |= AC_FMT_TYPE_NON_PCM;
774 
775 	return val;
776 }
777 EXPORT_SYMBOL_GPL(snd_hdac_calc_stream_format);
778 
779 static unsigned int query_pcm_param(struct hdac_device *codec, hda_nid_t nid)
780 {
781 	unsigned int val = 0;
782 
783 	if (nid != codec->afg &&
784 	    (get_wcaps(codec, nid) & AC_WCAP_FORMAT_OVRD))
785 		val = snd_hdac_read_parm(codec, nid, AC_PAR_PCM);
786 	if (!val || val == -1)
787 		val = snd_hdac_read_parm(codec, codec->afg, AC_PAR_PCM);
788 	if (!val || val == -1)
789 		return 0;
790 	return val;
791 }
792 
793 static unsigned int query_stream_param(struct hdac_device *codec, hda_nid_t nid)
794 {
795 	unsigned int streams = snd_hdac_read_parm(codec, nid, AC_PAR_STREAM);
796 
797 	if (!streams || streams == -1)
798 		streams = snd_hdac_read_parm(codec, codec->afg, AC_PAR_STREAM);
799 	if (!streams || streams == -1)
800 		return 0;
801 	return streams;
802 }
803 
804 /**
805  * snd_hdac_query_supported_pcm - query the supported PCM rates and formats
806  * @codec: the codec object
807  * @nid: NID to query
808  * @ratesp: the pointer to store the detected rate bitflags
809  * @formatsp: the pointer to store the detected formats
810  * @bpsp: the pointer to store the detected format widths
811  *
812  * Queries the supported PCM rates and formats.  The NULL @ratesp, @formatsp
813  * or @bsps argument is ignored.
814  *
815  * Returns 0 if successful, otherwise a negative error code.
816  */
817 int snd_hdac_query_supported_pcm(struct hdac_device *codec, hda_nid_t nid,
818 				 u32 *ratesp, u64 *formatsp, unsigned int *bpsp)
819 {
820 	unsigned int i, val, wcaps;
821 
822 	wcaps = get_wcaps(codec, nid);
823 	val = query_pcm_param(codec, nid);
824 
825 	if (ratesp) {
826 		u32 rates = 0;
827 		for (i = 0; i < AC_PAR_PCM_RATE_BITS; i++) {
828 			if (val & (1 << i))
829 				rates |= rate_bits[i].alsa_bits;
830 		}
831 		if (rates == 0) {
832 			dev_err(&codec->dev,
833 				"rates == 0 (nid=0x%x, val=0x%x, ovrd=%i)\n",
834 				nid, val,
835 				(wcaps & AC_WCAP_FORMAT_OVRD) ? 1 : 0);
836 			return -EIO;
837 		}
838 		*ratesp = rates;
839 	}
840 
841 	if (formatsp || bpsp) {
842 		u64 formats = 0;
843 		unsigned int streams, bps;
844 
845 		streams = query_stream_param(codec, nid);
846 		if (!streams)
847 			return -EIO;
848 
849 		bps = 0;
850 		if (streams & AC_SUPFMT_PCM) {
851 			if (val & AC_SUPPCM_BITS_8) {
852 				formats |= SNDRV_PCM_FMTBIT_U8;
853 				bps = 8;
854 			}
855 			if (val & AC_SUPPCM_BITS_16) {
856 				formats |= SNDRV_PCM_FMTBIT_S16_LE;
857 				bps = 16;
858 			}
859 			if (wcaps & AC_WCAP_DIGITAL) {
860 				if (val & AC_SUPPCM_BITS_32)
861 					formats |= SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE;
862 				if (val & (AC_SUPPCM_BITS_20|AC_SUPPCM_BITS_24))
863 					formats |= SNDRV_PCM_FMTBIT_S32_LE;
864 				if (val & AC_SUPPCM_BITS_24)
865 					bps = 24;
866 				else if (val & AC_SUPPCM_BITS_20)
867 					bps = 20;
868 			} else if (val & (AC_SUPPCM_BITS_20|AC_SUPPCM_BITS_24|
869 					  AC_SUPPCM_BITS_32)) {
870 				formats |= SNDRV_PCM_FMTBIT_S32_LE;
871 				if (val & AC_SUPPCM_BITS_32)
872 					bps = 32;
873 				else if (val & AC_SUPPCM_BITS_24)
874 					bps = 24;
875 				else if (val & AC_SUPPCM_BITS_20)
876 					bps = 20;
877 			}
878 		}
879 #if 0 /* FIXME: CS4206 doesn't work, which is the only codec supporting float */
880 		if (streams & AC_SUPFMT_FLOAT32) {
881 			formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
882 			if (!bps)
883 				bps = 32;
884 		}
885 #endif
886 		if (streams == AC_SUPFMT_AC3) {
887 			/* should be exclusive */
888 			/* temporary hack: we have still no proper support
889 			 * for the direct AC3 stream...
890 			 */
891 			formats |= SNDRV_PCM_FMTBIT_U8;
892 			bps = 8;
893 		}
894 		if (formats == 0) {
895 			dev_err(&codec->dev,
896 				"formats == 0 (nid=0x%x, val=0x%x, ovrd=%i, streams=0x%x)\n",
897 				nid, val,
898 				(wcaps & AC_WCAP_FORMAT_OVRD) ? 1 : 0,
899 				streams);
900 			return -EIO;
901 		}
902 		if (formatsp)
903 			*formatsp = formats;
904 		if (bpsp)
905 			*bpsp = bps;
906 	}
907 
908 	return 0;
909 }
910 EXPORT_SYMBOL_GPL(snd_hdac_query_supported_pcm);
911 
912 /**
913  * snd_hdac_is_supported_format - Check the validity of the format
914  * @codec: the codec object
915  * @nid: NID to check
916  * @format: the HD-audio format value to check
917  *
918  * Check whether the given node supports the format value.
919  *
920  * Returns true if supported, false if not.
921  */
922 bool snd_hdac_is_supported_format(struct hdac_device *codec, hda_nid_t nid,
923 				  unsigned int format)
924 {
925 	int i;
926 	unsigned int val = 0, rate, stream;
927 
928 	val = query_pcm_param(codec, nid);
929 	if (!val)
930 		return false;
931 
932 	rate = format & 0xff00;
933 	for (i = 0; i < AC_PAR_PCM_RATE_BITS; i++)
934 		if (rate_bits[i].hda_fmt == rate) {
935 			if (val & (1 << i))
936 				break;
937 			return false;
938 		}
939 	if (i >= AC_PAR_PCM_RATE_BITS)
940 		return false;
941 
942 	stream = query_stream_param(codec, nid);
943 	if (!stream)
944 		return false;
945 
946 	if (stream & AC_SUPFMT_PCM) {
947 		switch (format & 0xf0) {
948 		case 0x00:
949 			if (!(val & AC_SUPPCM_BITS_8))
950 				return false;
951 			break;
952 		case 0x10:
953 			if (!(val & AC_SUPPCM_BITS_16))
954 				return false;
955 			break;
956 		case 0x20:
957 			if (!(val & AC_SUPPCM_BITS_20))
958 				return false;
959 			break;
960 		case 0x30:
961 			if (!(val & AC_SUPPCM_BITS_24))
962 				return false;
963 			break;
964 		case 0x40:
965 			if (!(val & AC_SUPPCM_BITS_32))
966 				return false;
967 			break;
968 		default:
969 			return false;
970 		}
971 	} else {
972 		/* FIXME: check for float32 and AC3? */
973 	}
974 
975 	return true;
976 }
977 EXPORT_SYMBOL_GPL(snd_hdac_is_supported_format);
978 
979 static unsigned int codec_read(struct hdac_device *hdac, hda_nid_t nid,
980 			int flags, unsigned int verb, unsigned int parm)
981 {
982 	unsigned int cmd = snd_hdac_make_cmd(hdac, nid, verb, parm);
983 	unsigned int res;
984 
985 	if (snd_hdac_exec_verb(hdac, cmd, flags, &res))
986 		return -1;
987 
988 	return res;
989 }
990 
991 static int codec_write(struct hdac_device *hdac, hda_nid_t nid,
992 			int flags, unsigned int verb, unsigned int parm)
993 {
994 	unsigned int cmd = snd_hdac_make_cmd(hdac, nid, verb, parm);
995 
996 	return snd_hdac_exec_verb(hdac, cmd, flags, NULL);
997 }
998 
999 /**
1000  * snd_hdac_codec_read - send a command and get the response
1001  * @hdac: the HDAC device
1002  * @nid: NID to send the command
1003  * @flags: optional bit flags
1004  * @verb: the verb to send
1005  * @parm: the parameter for the verb
1006  *
1007  * Send a single command and read the corresponding response.
1008  *
1009  * Returns the obtained response value, or -1 for an error.
1010  */
1011 int snd_hdac_codec_read(struct hdac_device *hdac, hda_nid_t nid,
1012 			int flags, unsigned int verb, unsigned int parm)
1013 {
1014 	return codec_read(hdac, nid, flags, verb, parm);
1015 }
1016 EXPORT_SYMBOL_GPL(snd_hdac_codec_read);
1017 
1018 /**
1019  * snd_hdac_codec_write - send a single command without waiting for response
1020  * @hdac: the HDAC device
1021  * @nid: NID to send the command
1022  * @flags: optional bit flags
1023  * @verb: the verb to send
1024  * @parm: the parameter for the verb
1025  *
1026  * Send a single command without waiting for response.
1027  *
1028  * Returns 0 if successful, or a negative error code.
1029  */
1030 int snd_hdac_codec_write(struct hdac_device *hdac, hda_nid_t nid,
1031 			int flags, unsigned int verb, unsigned int parm)
1032 {
1033 	return codec_write(hdac, nid, flags, verb, parm);
1034 }
1035 EXPORT_SYMBOL_GPL(snd_hdac_codec_write);
1036 
1037 /**
1038  * snd_hdac_check_power_state - check whether the actual power state matches
1039  * with the target state
1040  *
1041  * @hdac: the HDAC device
1042  * @nid: NID to send the command
1043  * @target_state: target state to check for
1044  *
1045  * Return true if state matches, false if not
1046  */
1047 bool snd_hdac_check_power_state(struct hdac_device *hdac,
1048 		hda_nid_t nid, unsigned int target_state)
1049 {
1050 	unsigned int state = codec_read(hdac, nid, 0,
1051 				AC_VERB_GET_POWER_STATE, 0);
1052 
1053 	if (state & AC_PWRST_ERROR)
1054 		return true;
1055 	state = (state >> 4) & 0x0f;
1056 	return (state == target_state);
1057 }
1058 EXPORT_SYMBOL_GPL(snd_hdac_check_power_state);
1059 /**
1060  * snd_hdac_sync_power_state - wait until actual power state matches
1061  * with the target state
1062  *
1063  * @hdac: the HDAC device
1064  * @nid: NID to send the command
1065  * @target_state: target state to check for
1066  *
1067  * Return power state or PS_ERROR if codec rejects GET verb.
1068  */
1069 unsigned int snd_hdac_sync_power_state(struct hdac_device *codec,
1070 			hda_nid_t nid, unsigned int power_state)
1071 {
1072 	unsigned long end_time = jiffies + msecs_to_jiffies(500);
1073 	unsigned int state, actual_state, count;
1074 
1075 	for (count = 0; count < 500; count++) {
1076 		state = snd_hdac_codec_read(codec, nid, 0,
1077 				AC_VERB_GET_POWER_STATE, 0);
1078 		if (state & AC_PWRST_ERROR) {
1079 			msleep(20);
1080 			break;
1081 		}
1082 		actual_state = (state >> 4) & 0x0f;
1083 		if (actual_state == power_state)
1084 			break;
1085 		if (time_after_eq(jiffies, end_time))
1086 			break;
1087 		/* wait until the codec reachs to the target state */
1088 		msleep(1);
1089 	}
1090 	return state;
1091 }
1092 EXPORT_SYMBOL_GPL(snd_hdac_sync_power_state);
1093