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