2 * sysfs interface for HD-audio codec
4 * Copyright (c) 2014 Takashi Iwai <tiwai@suse.de>
6 * split from hda_hwdep.c
9 #include <linux/init.h>
10 #include <linux/slab.h>
11 #include <linux/compat.h>
12 #include <linux/mutex.h>
13 #include <linux/ctype.h>
14 #include <linux/string.h>
15 #include <linux/export.h>
16 #include <sound/core.h>
17 #include "hda_codec.h"
18 #include "hda_local.h"
19 #include <sound/hda_hwdep.h>
20 #include <sound/minors.h>
22 /* hint string pair */
25 const char *val; /* contained in the same alloc as key */
29 static ssize_t power_on_acct_show(struct device *dev,
30 struct device_attribute *attr,
33 struct hda_codec *codec = dev_get_drvdata(dev);
34 snd_hda_update_power_acct(codec);
35 return sprintf(buf, "%u\n", jiffies_to_msecs(codec->power_on_acct));
38 static ssize_t power_off_acct_show(struct device *dev,
39 struct device_attribute *attr,
42 struct hda_codec *codec = dev_get_drvdata(dev);
43 snd_hda_update_power_acct(codec);
44 return sprintf(buf, "%u\n", jiffies_to_msecs(codec->power_off_acct));
47 static DEVICE_ATTR_RO(power_on_acct);
48 static DEVICE_ATTR_RO(power_off_acct);
49 #endif /* CONFIG_PM */
51 #define CODEC_INFO_SHOW(type) \
52 static ssize_t type##_show(struct device *dev, \
53 struct device_attribute *attr, \
56 struct hda_codec *codec = dev_get_drvdata(dev); \
57 return sprintf(buf, "0x%x\n", codec->type); \
60 #define CODEC_INFO_STR_SHOW(type) \
61 static ssize_t type##_show(struct device *dev, \
62 struct device_attribute *attr, \
65 struct hda_codec *codec = dev_get_drvdata(dev); \
66 return sprintf(buf, "%s\n", \
67 codec->type ? codec->type : ""); \
70 CODEC_INFO_SHOW(vendor_id);
71 CODEC_INFO_SHOW(subsystem_id);
72 CODEC_INFO_SHOW(revision_id);
75 CODEC_INFO_STR_SHOW(vendor_name);
76 CODEC_INFO_STR_SHOW(chip_name);
77 CODEC_INFO_STR_SHOW(modelname);
79 static ssize_t pin_configs_show(struct hda_codec *codec,
80 struct snd_array *list,
84 mutex_lock(&codec->user_mutex);
85 for (i = 0; i < list->used; i++) {
86 struct hda_pincfg *pin = snd_array_elem(list, i);
87 len += sprintf(buf + len, "0x%02x 0x%08x\n",
90 mutex_unlock(&codec->user_mutex);
94 static ssize_t init_pin_configs_show(struct device *dev,
95 struct device_attribute *attr,
98 struct hda_codec *codec = dev_get_drvdata(dev);
99 return pin_configs_show(codec, &codec->init_pins, buf);
102 static ssize_t driver_pin_configs_show(struct device *dev,
103 struct device_attribute *attr,
106 struct hda_codec *codec = dev_get_drvdata(dev);
107 return pin_configs_show(codec, &codec->driver_pins, buf);
110 #ifdef CONFIG_SND_HDA_RECONFIG
116 static int clear_codec(struct hda_codec *codec)
120 err = snd_hda_codec_reset(codec);
122 codec_err(codec, "The codec is being used, can't free.\n");
125 snd_hda_sysfs_clear(codec);
129 static int reconfig_codec(struct hda_codec *codec)
133 snd_hda_power_up(codec);
134 codec_info(codec, "hda-codec: reconfiguring\n");
135 err = snd_hda_codec_reset(codec);
138 "The codec is being used, can't reconfigure.\n");
141 err = snd_hda_codec_configure(codec);
145 err = snd_hda_codec_build_pcms(codec);
149 err = snd_hda_codec_build_controls(codec);
152 err = snd_card_register(codec->bus->card);
154 snd_hda_power_down(codec);
159 * allocate a string at most len chars, and remove the trailing EOL
161 static char *kstrndup_noeol(const char *src, size_t len)
163 char *s = kstrndup(src, len, GFP_KERNEL);
173 #define CODEC_INFO_STORE(type) \
174 static ssize_t type##_store(struct device *dev, \
175 struct device_attribute *attr, \
176 const char *buf, size_t count) \
178 struct hda_codec *codec = dev_get_drvdata(dev); \
180 int err = kstrtoul(buf, 0, &val); \
187 #define CODEC_INFO_STR_STORE(type) \
188 static ssize_t type##_store(struct device *dev, \
189 struct device_attribute *attr, \
190 const char *buf, size_t count) \
192 struct hda_codec *codec = dev_get_drvdata(dev); \
193 char *s = kstrndup_noeol(buf, 64); \
196 kfree(codec->type); \
201 CODEC_INFO_STORE(vendor_id);
202 CODEC_INFO_STORE(subsystem_id);
203 CODEC_INFO_STORE(revision_id);
204 CODEC_INFO_STR_STORE(vendor_name);
205 CODEC_INFO_STR_STORE(chip_name);
206 CODEC_INFO_STR_STORE(modelname);
208 #define CODEC_ACTION_STORE(type) \
209 static ssize_t type##_store(struct device *dev, \
210 struct device_attribute *attr, \
211 const char *buf, size_t count) \
213 struct hda_codec *codec = dev_get_drvdata(dev); \
216 err = type##_codec(codec); \
217 return err < 0 ? err : count; \
220 CODEC_ACTION_STORE(reconfig);
221 CODEC_ACTION_STORE(clear);
223 static ssize_t init_verbs_show(struct device *dev,
224 struct device_attribute *attr,
227 struct hda_codec *codec = dev_get_drvdata(dev);
229 mutex_lock(&codec->user_mutex);
230 for (i = 0; i < codec->init_verbs.used; i++) {
231 struct hda_verb *v = snd_array_elem(&codec->init_verbs, i);
232 len += snprintf(buf + len, PAGE_SIZE - len,
233 "0x%02x 0x%03x 0x%04x\n",
234 v->nid, v->verb, v->param);
236 mutex_unlock(&codec->user_mutex);
240 static int parse_init_verbs(struct hda_codec *codec, const char *buf)
243 int nid, verb, param;
245 if (sscanf(buf, "%i %i %i", &nid, &verb, ¶m) != 3)
249 mutex_lock(&codec->user_mutex);
250 v = snd_array_new(&codec->init_verbs);
252 mutex_unlock(&codec->user_mutex);
258 mutex_unlock(&codec->user_mutex);
262 static ssize_t init_verbs_store(struct device *dev,
263 struct device_attribute *attr,
264 const char *buf, size_t count)
266 struct hda_codec *codec = dev_get_drvdata(dev);
267 int err = parse_init_verbs(codec, buf);
273 static ssize_t hints_show(struct device *dev,
274 struct device_attribute *attr,
277 struct hda_codec *codec = dev_get_drvdata(dev);
279 mutex_lock(&codec->user_mutex);
280 for (i = 0; i < codec->hints.used; i++) {
281 struct hda_hint *hint = snd_array_elem(&codec->hints, i);
282 len += snprintf(buf + len, PAGE_SIZE - len,
283 "%s = %s\n", hint->key, hint->val);
285 mutex_unlock(&codec->user_mutex);
289 static struct hda_hint *get_hint(struct hda_codec *codec, const char *key)
293 for (i = 0; i < codec->hints.used; i++) {
294 struct hda_hint *hint = snd_array_elem(&codec->hints, i);
295 if (!strcmp(hint->key, key))
301 static void remove_trail_spaces(char *str)
306 p = str + strlen(str) - 1;
307 for (; isspace(*p); p--) {
314 #define MAX_HINTS 1024
316 static int parse_hints(struct hda_codec *codec, const char *buf)
319 struct hda_hint *hint;
322 buf = skip_spaces(buf);
323 if (!*buf || *buf == '#' || *buf == '\n')
327 key = kstrndup_noeol(buf, 1024);
330 /* extract key and val */
331 val = strchr(key, '=');
337 val = skip_spaces(val);
338 remove_trail_spaces(key);
339 remove_trail_spaces(val);
340 mutex_lock(&codec->user_mutex);
341 hint = get_hint(codec, key);
349 /* allocate a new hint entry */
350 if (codec->hints.used >= MAX_HINTS)
353 hint = snd_array_new(&codec->hints);
361 mutex_unlock(&codec->user_mutex);
367 static ssize_t hints_store(struct device *dev,
368 struct device_attribute *attr,
369 const char *buf, size_t count)
371 struct hda_codec *codec = dev_get_drvdata(dev);
372 int err = parse_hints(codec, buf);
378 static ssize_t user_pin_configs_show(struct device *dev,
379 struct device_attribute *attr,
382 struct hda_codec *codec = dev_get_drvdata(dev);
383 return pin_configs_show(codec, &codec->user_pins, buf);
386 #define MAX_PIN_CONFIGS 32
388 static int parse_user_pin_configs(struct hda_codec *codec, const char *buf)
392 if (sscanf(buf, "%i %i", &nid, &cfg) != 2)
396 mutex_lock(&codec->user_mutex);
397 err = snd_hda_add_pincfg(codec, &codec->user_pins, nid, cfg);
398 mutex_unlock(&codec->user_mutex);
402 static ssize_t user_pin_configs_store(struct device *dev,
403 struct device_attribute *attr,
404 const char *buf, size_t count)
406 struct hda_codec *codec = dev_get_drvdata(dev);
407 int err = parse_user_pin_configs(codec, buf);
413 /* sysfs attributes exposed only when CONFIG_SND_HDA_RECONFIG=y */
414 static DEVICE_ATTR_RW(init_verbs);
415 static DEVICE_ATTR_RW(hints);
416 static DEVICE_ATTR_RW(user_pin_configs);
417 static DEVICE_ATTR_WO(reconfig);
418 static DEVICE_ATTR_WO(clear);
421 * Look for hint string
423 const char *snd_hda_get_hint(struct hda_codec *codec, const char *key)
425 struct hda_hint *hint = get_hint(codec, key);
426 return hint ? hint->val : NULL;
428 EXPORT_SYMBOL_GPL(snd_hda_get_hint);
430 int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key)
435 mutex_lock(&codec->user_mutex);
436 p = snd_hda_get_hint(codec, key);
440 switch (toupper(*p)) {
451 mutex_unlock(&codec->user_mutex);
454 EXPORT_SYMBOL_GPL(snd_hda_get_bool_hint);
456 int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp)
462 mutex_lock(&codec->user_mutex);
463 p = snd_hda_get_hint(codec, key);
466 else if (kstrtoul(p, 0, &val))
472 mutex_unlock(&codec->user_mutex);
475 EXPORT_SYMBOL_GPL(snd_hda_get_int_hint);
476 #endif /* CONFIG_SND_HDA_RECONFIG */
479 * common sysfs attributes
481 #ifdef CONFIG_SND_HDA_RECONFIG
482 #define RECONFIG_DEVICE_ATTR(name) DEVICE_ATTR_RW(name)
484 #define RECONFIG_DEVICE_ATTR(name) DEVICE_ATTR_RO(name)
486 static RECONFIG_DEVICE_ATTR(vendor_id);
487 static RECONFIG_DEVICE_ATTR(subsystem_id);
488 static RECONFIG_DEVICE_ATTR(revision_id);
489 static DEVICE_ATTR_RO(afg);
490 static DEVICE_ATTR_RO(mfg);
491 static RECONFIG_DEVICE_ATTR(vendor_name);
492 static RECONFIG_DEVICE_ATTR(chip_name);
493 static RECONFIG_DEVICE_ATTR(modelname);
494 static DEVICE_ATTR_RO(init_pin_configs);
495 static DEVICE_ATTR_RO(driver_pin_configs);
498 #ifdef CONFIG_SND_HDA_PATCH_LOADER
509 LINE_MODE_SUBSYSTEM_ID,
510 LINE_MODE_REVISION_ID,
515 static inline int strmatch(const char *a, const char *b)
517 return strncasecmp(a, b, strlen(b)) == 0;
520 /* parse the contents after the line "[codec]"
521 * accept only the line with three numbers, and assign the current codec
523 static void parse_codec_mode(char *buf, struct hda_bus *bus,
524 struct hda_codec **codecp)
526 int vendorid, subid, caddr;
527 struct hda_codec *codec;
530 if (sscanf(buf, "%i %i %i", &vendorid, &subid, &caddr) == 3) {
531 list_for_each_entry(codec, &bus->codec_list, list) {
532 if ((vendorid <= 0 || codec->vendor_id == vendorid) &&
533 (subid <= 0 || codec->subsystem_id == subid) &&
534 codec->addr == caddr) {
542 /* parse the contents after the other command tags, [pincfg], [verb],
543 * [vendor_id], [subsystem_id], [revision_id], [chip_name], [hint] and [model]
544 * just pass to the sysfs helper (only when any codec was specified)
546 static void parse_pincfg_mode(char *buf, struct hda_bus *bus,
547 struct hda_codec **codecp)
549 parse_user_pin_configs(*codecp, buf);
552 static void parse_verb_mode(char *buf, struct hda_bus *bus,
553 struct hda_codec **codecp)
555 parse_init_verbs(*codecp, buf);
558 static void parse_hint_mode(char *buf, struct hda_bus *bus,
559 struct hda_codec **codecp)
561 parse_hints(*codecp, buf);
564 static void parse_model_mode(char *buf, struct hda_bus *bus,
565 struct hda_codec **codecp)
567 kfree((*codecp)->modelname);
568 (*codecp)->modelname = kstrdup(buf, GFP_KERNEL);
571 static void parse_chip_name_mode(char *buf, struct hda_bus *bus,
572 struct hda_codec **codecp)
574 kfree((*codecp)->chip_name);
575 (*codecp)->chip_name = kstrdup(buf, GFP_KERNEL);
578 #define DEFINE_PARSE_ID_MODE(name) \
579 static void parse_##name##_mode(char *buf, struct hda_bus *bus, \
580 struct hda_codec **codecp) \
583 if (!kstrtoul(buf, 0, &val)) \
584 (*codecp)->name = val; \
587 DEFINE_PARSE_ID_MODE(vendor_id);
588 DEFINE_PARSE_ID_MODE(subsystem_id);
589 DEFINE_PARSE_ID_MODE(revision_id);
592 struct hda_patch_item {
595 void (*parser)(char *buf, struct hda_bus *bus, struct hda_codec **retc);
598 static struct hda_patch_item patch_items[NUM_LINE_MODES] = {
599 [LINE_MODE_CODEC] = {
601 .parser = parse_codec_mode,
603 [LINE_MODE_MODEL] = {
605 .parser = parse_model_mode,
609 .alias = "[init_verbs]",
610 .parser = parse_verb_mode,
612 [LINE_MODE_PINCFG] = {
614 .alias = "[user_pin_configs]",
615 .parser = parse_pincfg_mode,
620 .parser = parse_hint_mode
622 [LINE_MODE_VENDOR_ID] = {
623 .tag = "[vendor_id]",
624 .parser = parse_vendor_id_mode,
626 [LINE_MODE_SUBSYSTEM_ID] = {
627 .tag = "[subsystem_id]",
628 .parser = parse_subsystem_id_mode,
630 [LINE_MODE_REVISION_ID] = {
631 .tag = "[revision_id]",
632 .parser = parse_revision_id_mode,
634 [LINE_MODE_CHIP_NAME] = {
635 .tag = "[chip_name]",
636 .parser = parse_chip_name_mode,
640 /* check the line starting with '[' -- change the parser mode accodingly */
641 static int parse_line_mode(char *buf, struct hda_bus *bus)
644 for (i = 0; i < ARRAY_SIZE(patch_items); i++) {
645 if (!patch_items[i].tag)
647 if (strmatch(buf, patch_items[i].tag))
649 if (patch_items[i].alias && strmatch(buf, patch_items[i].alias))
652 return LINE_MODE_NONE;
655 /* copy one line from the buffer in fw, and update the fields in fw
656 * return zero if it reaches to the end of the buffer, or non-zero
657 * if successfully copied a line
659 * the spaces at the beginning and the end of the line are stripped
661 static int get_line_from_fw(char *buf, int size, size_t *fw_size_p,
662 const void **fw_data_p)
665 size_t fw_size = *fw_size_p;
666 const char *p = *fw_data_p;
668 while (isspace(*p) && fw_size) {
675 for (len = 0; len < fw_size; len++) {
687 *fw_size_p = fw_size - len;
689 remove_trail_spaces(buf);
694 * load a "patch" firmware file and parse it
696 int snd_hda_load_patch(struct hda_bus *bus, size_t fw_size, const void *fw_buf)
699 struct hda_codec *codec;
702 line_mode = LINE_MODE_NONE;
704 while (get_line_from_fw(buf, sizeof(buf) - 1, &fw_size, &fw_buf)) {
705 if (!*buf || *buf == '#' || *buf == '\n')
708 line_mode = parse_line_mode(buf, bus);
709 else if (patch_items[line_mode].parser &&
710 (codec || line_mode <= LINE_MODE_CODEC))
711 patch_items[line_mode].parser(buf, bus, &codec);
715 EXPORT_SYMBOL_GPL(snd_hda_load_patch);
716 #endif /* CONFIG_SND_HDA_PATCH_LOADER */
721 static struct attribute *hda_dev_attrs[] = {
722 &dev_attr_vendor_id.attr,
723 &dev_attr_subsystem_id.attr,
724 &dev_attr_revision_id.attr,
727 &dev_attr_vendor_name.attr,
728 &dev_attr_chip_name.attr,
729 &dev_attr_modelname.attr,
730 &dev_attr_init_pin_configs.attr,
731 &dev_attr_driver_pin_configs.attr,
733 &dev_attr_power_on_acct.attr,
734 &dev_attr_power_off_acct.attr,
736 #ifdef CONFIG_SND_HDA_RECONFIG
737 &dev_attr_init_verbs.attr,
738 &dev_attr_hints.attr,
739 &dev_attr_user_pin_configs.attr,
740 &dev_attr_reconfig.attr,
741 &dev_attr_clear.attr,
746 static struct attribute_group hda_dev_attr_group = {
747 .attrs = hda_dev_attrs,
750 const struct attribute_group *snd_hda_dev_attr_groups[] = {
755 void snd_hda_sysfs_init(struct hda_codec *codec)
757 mutex_init(&codec->user_mutex);
758 #ifdef CONFIG_SND_HDA_RECONFIG
759 snd_array_init(&codec->init_verbs, sizeof(struct hda_verb), 32);
760 snd_array_init(&codec->hints, sizeof(struct hda_hint), 32);
761 snd_array_init(&codec->user_pins, sizeof(struct hda_pincfg), 16);
765 void snd_hda_sysfs_clear(struct hda_codec *codec)
767 #ifdef CONFIG_SND_HDA_RECONFIG
770 /* clear init verbs */
771 snd_array_free(&codec->init_verbs);
773 for (i = 0; i < codec->hints.used; i++) {
774 struct hda_hint *hint = snd_array_elem(&codec->hints, i);
775 kfree(hint->key); /* we don't need to free hint->val */
777 snd_array_free(&codec->hints);
778 snd_array_free(&codec->user_pins);