2 * HWDEP Interface for HD-audio codec
4 * Copyright (c) 2007 Takashi Iwai <tiwai@suse.de>
6 * This driver is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This driver is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #include <linux/init.h>
22 #include <linux/slab.h>
23 #include <linux/pci.h>
24 #include <linux/compat.h>
25 #include <linux/mutex.h>
26 #include <linux/ctype.h>
27 #include <linux/string.h>
28 #include <linux/export.h>
29 #include <sound/core.h>
30 #include "hda_codec.h"
31 #include "hda_local.h"
32 #include <sound/hda_hwdep.h>
33 #include <sound/minors.h>
35 /* hint string pair */
38 const char *val
; /* contained in the same alloc as key */
42 * write/read an out-of-bound verb
44 static int verb_write_ioctl(struct hda_codec
*codec
,
45 struct hda_verb_ioctl __user
*arg
)
49 if (get_user(verb
, &arg
->verb
))
51 res
= snd_hda_codec_read(codec
, verb
>> 24, 0,
52 (verb
>> 8) & 0xffff, verb
& 0xff);
53 if (put_user(res
, &arg
->res
))
58 static int get_wcap_ioctl(struct hda_codec
*codec
,
59 struct hda_verb_ioctl __user
*arg
)
63 if (get_user(verb
, &arg
->verb
))
65 res
= get_wcaps(codec
, verb
>> 24);
66 if (put_user(res
, &arg
->res
))
74 static int hda_hwdep_ioctl(struct snd_hwdep
*hw
, struct file
*file
,
75 unsigned int cmd
, unsigned long arg
)
77 struct hda_codec
*codec
= hw
->private_data
;
78 void __user
*argp
= (void __user
*)arg
;
81 case HDA_IOCTL_PVERSION
:
82 return put_user(HDA_HWDEP_VERSION
, (int __user
*)argp
);
83 case HDA_IOCTL_VERB_WRITE
:
84 return verb_write_ioctl(codec
, argp
);
85 case HDA_IOCTL_GET_WCAP
:
86 return get_wcap_ioctl(codec
, argp
);
92 static int hda_hwdep_ioctl_compat(struct snd_hwdep
*hw
, struct file
*file
,
93 unsigned int cmd
, unsigned long arg
)
95 return hda_hwdep_ioctl(hw
, file
, cmd
, (unsigned long)compat_ptr(arg
));
99 static int hda_hwdep_open(struct snd_hwdep
*hw
, struct file
*file
)
101 #ifndef CONFIG_SND_DEBUG_VERBOSE
102 if (!capable(CAP_SYS_RAWIO
))
108 static void clear_hwdep_elements(struct hda_codec
*codec
)
112 /* clear init verbs */
113 snd_array_free(&codec
->init_verbs
);
115 for (i
= 0; i
< codec
->hints
.used
; i
++) {
116 struct hda_hint
*hint
= snd_array_elem(&codec
->hints
, i
);
117 kfree(hint
->key
); /* we don't need to free hint->val */
119 snd_array_free(&codec
->hints
);
120 snd_array_free(&codec
->user_pins
);
123 static void hwdep_free(struct snd_hwdep
*hwdep
)
125 clear_hwdep_elements(hwdep
->private_data
);
128 int snd_hda_create_hwdep(struct hda_codec
*codec
)
131 struct snd_hwdep
*hwdep
;
134 sprintf(hwname
, "HDA Codec %d", codec
->addr
);
135 err
= snd_hwdep_new(codec
->bus
->card
, hwname
, codec
->addr
, &hwdep
);
138 codec
->hwdep
= hwdep
;
139 sprintf(hwdep
->name
, "HDA Codec %d", codec
->addr
);
140 hwdep
->iface
= SNDRV_HWDEP_IFACE_HDA
;
141 hwdep
->private_data
= codec
;
142 hwdep
->private_free
= hwdep_free
;
143 hwdep
->exclusive
= 1;
145 hwdep
->ops
.open
= hda_hwdep_open
;
146 hwdep
->ops
.ioctl
= hda_hwdep_ioctl
;
148 hwdep
->ops
.ioctl_compat
= hda_hwdep_ioctl_compat
;
151 snd_array_init(&codec
->init_verbs
, sizeof(struct hda_verb
), 32);
152 snd_array_init(&codec
->hints
, sizeof(struct hda_hint
), 32);
153 snd_array_init(&codec
->user_pins
, sizeof(struct hda_pincfg
), 16);
159 static ssize_t
power_on_acct_show(struct device
*dev
,
160 struct device_attribute
*attr
,
163 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
164 struct hda_codec
*codec
= hwdep
->private_data
;
165 snd_hda_update_power_acct(codec
);
166 return sprintf(buf
, "%u\n", jiffies_to_msecs(codec
->power_on_acct
));
169 static ssize_t
power_off_acct_show(struct device
*dev
,
170 struct device_attribute
*attr
,
173 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
174 struct hda_codec
*codec
= hwdep
->private_data
;
175 snd_hda_update_power_acct(codec
);
176 return sprintf(buf
, "%u\n", jiffies_to_msecs(codec
->power_off_acct
));
179 static struct device_attribute power_attrs
[] = {
180 __ATTR_RO(power_on_acct
),
181 __ATTR_RO(power_off_acct
),
184 int snd_hda_hwdep_add_power_sysfs(struct hda_codec
*codec
)
186 struct snd_hwdep
*hwdep
= codec
->hwdep
;
189 for (i
= 0; i
< ARRAY_SIZE(power_attrs
); i
++)
190 snd_add_device_sysfs_file(SNDRV_DEVICE_TYPE_HWDEP
, hwdep
->card
,
191 hwdep
->device
, &power_attrs
[i
]);
194 #endif /* CONFIG_PM */
196 #ifdef CONFIG_SND_HDA_RECONFIG
202 static int clear_codec(struct hda_codec
*codec
)
206 err
= snd_hda_codec_reset(codec
);
208 snd_printk(KERN_ERR
"The codec is being used, can't free.\n");
211 clear_hwdep_elements(codec
);
215 static int reconfig_codec(struct hda_codec
*codec
)
219 snd_hda_power_up(codec
);
220 snd_printk(KERN_INFO
"hda-codec: reconfiguring\n");
221 err
= snd_hda_codec_reset(codec
);
224 "The codec is being used, can't reconfigure.\n");
227 err
= snd_hda_codec_configure(codec
);
231 err
= snd_hda_codec_build_pcms(codec
);
235 err
= snd_hda_codec_build_controls(codec
);
238 err
= snd_card_register(codec
->bus
->card
);
240 snd_hda_power_down(codec
);
245 * allocate a string at most len chars, and remove the trailing EOL
247 static char *kstrndup_noeol(const char *src
, size_t len
)
249 char *s
= kstrndup(src
, len
, GFP_KERNEL
);
259 #define CODEC_INFO_SHOW(type) \
260 static ssize_t type##_show(struct device *dev, \
261 struct device_attribute *attr, \
264 struct snd_hwdep *hwdep = dev_get_drvdata(dev); \
265 struct hda_codec *codec = hwdep->private_data; \
266 return sprintf(buf, "0x%x\n", codec->type); \
269 #define CODEC_INFO_STR_SHOW(type) \
270 static ssize_t type##_show(struct device *dev, \
271 struct device_attribute *attr, \
274 struct snd_hwdep *hwdep = dev_get_drvdata(dev); \
275 struct hda_codec *codec = hwdep->private_data; \
276 return sprintf(buf, "%s\n", \
277 codec->type ? codec->type : ""); \
280 CODEC_INFO_SHOW(vendor_id
);
281 CODEC_INFO_SHOW(subsystem_id
);
282 CODEC_INFO_SHOW(revision_id
);
283 CODEC_INFO_SHOW(afg
);
284 CODEC_INFO_SHOW(mfg
);
285 CODEC_INFO_STR_SHOW(vendor_name
);
286 CODEC_INFO_STR_SHOW(chip_name
);
287 CODEC_INFO_STR_SHOW(modelname
);
289 #define CODEC_INFO_STORE(type) \
290 static ssize_t type##_store(struct device *dev, \
291 struct device_attribute *attr, \
292 const char *buf, size_t count) \
294 struct snd_hwdep *hwdep = dev_get_drvdata(dev); \
295 struct hda_codec *codec = hwdep->private_data; \
297 int err = strict_strtoul(buf, 0, &val); \
304 #define CODEC_INFO_STR_STORE(type) \
305 static ssize_t type##_store(struct device *dev, \
306 struct device_attribute *attr, \
307 const char *buf, size_t count) \
309 struct snd_hwdep *hwdep = dev_get_drvdata(dev); \
310 struct hda_codec *codec = hwdep->private_data; \
311 char *s = kstrndup_noeol(buf, 64); \
314 kfree(codec->type); \
319 CODEC_INFO_STORE(vendor_id
);
320 CODEC_INFO_STORE(subsystem_id
);
321 CODEC_INFO_STORE(revision_id
);
322 CODEC_INFO_STR_STORE(vendor_name
);
323 CODEC_INFO_STR_STORE(chip_name
);
324 CODEC_INFO_STR_STORE(modelname
);
326 #define CODEC_ACTION_STORE(type) \
327 static ssize_t type##_store(struct device *dev, \
328 struct device_attribute *attr, \
329 const char *buf, size_t count) \
331 struct snd_hwdep *hwdep = dev_get_drvdata(dev); \
332 struct hda_codec *codec = hwdep->private_data; \
335 err = type##_codec(codec); \
336 return err < 0 ? err : count; \
339 CODEC_ACTION_STORE(reconfig
);
340 CODEC_ACTION_STORE(clear
);
342 static ssize_t
init_verbs_show(struct device
*dev
,
343 struct device_attribute
*attr
,
346 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
347 struct hda_codec
*codec
= hwdep
->private_data
;
349 for (i
= 0; i
< codec
->init_verbs
.used
; i
++) {
350 struct hda_verb
*v
= snd_array_elem(&codec
->init_verbs
, i
);
351 len
+= snprintf(buf
+ len
, PAGE_SIZE
- len
,
352 "0x%02x 0x%03x 0x%04x\n",
353 v
->nid
, v
->verb
, v
->param
);
358 static int parse_init_verbs(struct hda_codec
*codec
, const char *buf
)
361 int nid
, verb
, param
;
363 if (sscanf(buf
, "%i %i %i", &nid
, &verb
, ¶m
) != 3)
367 v
= snd_array_new(&codec
->init_verbs
);
376 static ssize_t
init_verbs_store(struct device
*dev
,
377 struct device_attribute
*attr
,
378 const char *buf
, size_t count
)
380 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
381 struct hda_codec
*codec
= hwdep
->private_data
;
382 int err
= parse_init_verbs(codec
, buf
);
388 static ssize_t
hints_show(struct device
*dev
,
389 struct device_attribute
*attr
,
392 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
393 struct hda_codec
*codec
= hwdep
->private_data
;
395 for (i
= 0; i
< codec
->hints
.used
; i
++) {
396 struct hda_hint
*hint
= snd_array_elem(&codec
->hints
, i
);
397 len
+= snprintf(buf
+ len
, PAGE_SIZE
- len
,
398 "%s = %s\n", hint
->key
, hint
->val
);
403 static struct hda_hint
*get_hint(struct hda_codec
*codec
, const char *key
)
407 for (i
= 0; i
< codec
->hints
.used
; i
++) {
408 struct hda_hint
*hint
= snd_array_elem(&codec
->hints
, i
);
409 if (!strcmp(hint
->key
, key
))
415 static void remove_trail_spaces(char *str
)
420 p
= str
+ strlen(str
) - 1;
421 for (; isspace(*p
); p
--) {
428 #define MAX_HINTS 1024
430 static int parse_hints(struct hda_codec
*codec
, const char *buf
)
433 struct hda_hint
*hint
;
435 buf
= skip_spaces(buf
);
436 if (!*buf
|| *buf
== '#' || *buf
== '\n')
440 key
= kstrndup_noeol(buf
, 1024);
443 /* extract key and val */
444 val
= strchr(key
, '=');
450 val
= skip_spaces(val
);
451 remove_trail_spaces(key
);
452 remove_trail_spaces(val
);
453 hint
= get_hint(codec
, key
);
461 /* allocate a new hint entry */
462 if (codec
->hints
.used
>= MAX_HINTS
)
465 hint
= snd_array_new(&codec
->hints
);
475 static ssize_t
hints_store(struct device
*dev
,
476 struct device_attribute
*attr
,
477 const char *buf
, size_t count
)
479 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
480 struct hda_codec
*codec
= hwdep
->private_data
;
481 int err
= parse_hints(codec
, buf
);
487 static ssize_t
pin_configs_show(struct hda_codec
*codec
,
488 struct snd_array
*list
,
492 for (i
= 0; i
< list
->used
; i
++) {
493 struct hda_pincfg
*pin
= snd_array_elem(list
, i
);
494 len
+= sprintf(buf
+ len
, "0x%02x 0x%08x\n",
500 static ssize_t
init_pin_configs_show(struct device
*dev
,
501 struct device_attribute
*attr
,
504 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
505 struct hda_codec
*codec
= hwdep
->private_data
;
506 return pin_configs_show(codec
, &codec
->init_pins
, buf
);
509 static ssize_t
user_pin_configs_show(struct device
*dev
,
510 struct device_attribute
*attr
,
513 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
514 struct hda_codec
*codec
= hwdep
->private_data
;
515 return pin_configs_show(codec
, &codec
->user_pins
, buf
);
518 static ssize_t
driver_pin_configs_show(struct device
*dev
,
519 struct device_attribute
*attr
,
522 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
523 struct hda_codec
*codec
= hwdep
->private_data
;
524 return pin_configs_show(codec
, &codec
->driver_pins
, buf
);
527 #define MAX_PIN_CONFIGS 32
529 static int parse_user_pin_configs(struct hda_codec
*codec
, const char *buf
)
533 if (sscanf(buf
, "%i %i", &nid
, &cfg
) != 2)
537 return snd_hda_add_pincfg(codec
, &codec
->user_pins
, nid
, cfg
);
540 static ssize_t
user_pin_configs_store(struct device
*dev
,
541 struct device_attribute
*attr
,
542 const char *buf
, size_t count
)
544 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
545 struct hda_codec
*codec
= hwdep
->private_data
;
546 int err
= parse_user_pin_configs(codec
, buf
);
552 #define CODEC_ATTR_RW(type) \
553 __ATTR(type, 0644, type##_show, type##_store)
554 #define CODEC_ATTR_RO(type) \
556 #define CODEC_ATTR_WO(type) \
557 __ATTR(type, 0200, NULL, type##_store)
559 static struct device_attribute codec_attrs
[] = {
560 CODEC_ATTR_RW(vendor_id
),
561 CODEC_ATTR_RW(subsystem_id
),
562 CODEC_ATTR_RW(revision_id
),
565 CODEC_ATTR_RW(vendor_name
),
566 CODEC_ATTR_RW(chip_name
),
567 CODEC_ATTR_RW(modelname
),
568 CODEC_ATTR_RW(init_verbs
),
569 CODEC_ATTR_RW(hints
),
570 CODEC_ATTR_RO(init_pin_configs
),
571 CODEC_ATTR_RW(user_pin_configs
),
572 CODEC_ATTR_RO(driver_pin_configs
),
573 CODEC_ATTR_WO(reconfig
),
574 CODEC_ATTR_WO(clear
),
578 * create sysfs files on hwdep directory
580 int snd_hda_hwdep_add_sysfs(struct hda_codec
*codec
)
582 struct snd_hwdep
*hwdep
= codec
->hwdep
;
585 for (i
= 0; i
< ARRAY_SIZE(codec_attrs
); i
++)
586 snd_add_device_sysfs_file(SNDRV_DEVICE_TYPE_HWDEP
, hwdep
->card
,
587 hwdep
->device
, &codec_attrs
[i
]);
592 * Look for hint string
594 const char *snd_hda_get_hint(struct hda_codec
*codec
, const char *key
)
596 struct hda_hint
*hint
= get_hint(codec
, key
);
597 return hint
? hint
->val
: NULL
;
599 EXPORT_SYMBOL_HDA(snd_hda_get_hint
);
601 int snd_hda_get_bool_hint(struct hda_codec
*codec
, const char *key
)
603 const char *p
= snd_hda_get_hint(codec
, key
);
606 switch (toupper(*p
)) {
614 EXPORT_SYMBOL_HDA(snd_hda_get_bool_hint
);
616 #endif /* CONFIG_SND_HDA_RECONFIG */
618 #ifdef CONFIG_SND_HDA_PATCH_LOADER
629 LINE_MODE_SUBSYSTEM_ID
,
630 LINE_MODE_REVISION_ID
,
635 static inline int strmatch(const char *a
, const char *b
)
637 return strnicmp(a
, b
, strlen(b
)) == 0;
640 /* parse the contents after the line "[codec]"
641 * accept only the line with three numbers, and assign the current codec
643 static void parse_codec_mode(char *buf
, struct hda_bus
*bus
,
644 struct hda_codec
**codecp
)
646 int vendorid
, subid
, caddr
;
647 struct hda_codec
*codec
;
650 if (sscanf(buf
, "%i %i %i", &vendorid
, &subid
, &caddr
) == 3) {
651 list_for_each_entry(codec
, &bus
->codec_list
, list
) {
652 if ((vendorid
<= 0 || codec
->vendor_id
== vendorid
) &&
653 (subid
<= 0 || codec
->subsystem_id
== subid
) &&
654 codec
->addr
== caddr
) {
662 /* parse the contents after the other command tags, [pincfg], [verb],
663 * [vendor_id], [subsystem_id], [revision_id], [chip_name], [hint] and [model]
664 * just pass to the sysfs helper (only when any codec was specified)
666 static void parse_pincfg_mode(char *buf
, struct hda_bus
*bus
,
667 struct hda_codec
**codecp
)
669 parse_user_pin_configs(*codecp
, buf
);
672 static void parse_verb_mode(char *buf
, struct hda_bus
*bus
,
673 struct hda_codec
**codecp
)
675 parse_init_verbs(*codecp
, buf
);
678 static void parse_hint_mode(char *buf
, struct hda_bus
*bus
,
679 struct hda_codec
**codecp
)
681 parse_hints(*codecp
, buf
);
684 static void parse_model_mode(char *buf
, struct hda_bus
*bus
,
685 struct hda_codec
**codecp
)
687 kfree((*codecp
)->modelname
);
688 (*codecp
)->modelname
= kstrdup(buf
, GFP_KERNEL
);
691 static void parse_chip_name_mode(char *buf
, struct hda_bus
*bus
,
692 struct hda_codec
**codecp
)
694 kfree((*codecp
)->chip_name
);
695 (*codecp
)->chip_name
= kstrdup(buf
, GFP_KERNEL
);
698 #define DEFINE_PARSE_ID_MODE(name) \
699 static void parse_##name##_mode(char *buf, struct hda_bus *bus, \
700 struct hda_codec **codecp) \
703 if (!strict_strtoul(buf, 0, &val)) \
704 (*codecp)->name = val; \
707 DEFINE_PARSE_ID_MODE(vendor_id
);
708 DEFINE_PARSE_ID_MODE(subsystem_id
);
709 DEFINE_PARSE_ID_MODE(revision_id
);
712 struct hda_patch_item
{
714 void (*parser
)(char *buf
, struct hda_bus
*bus
, struct hda_codec
**retc
);
718 static struct hda_patch_item patch_items
[NUM_LINE_MODES
] = {
719 [LINE_MODE_CODEC
] = { "[codec]", parse_codec_mode
, 0 },
720 [LINE_MODE_MODEL
] = { "[model]", parse_model_mode
, 1 },
721 [LINE_MODE_VERB
] = { "[verb]", parse_verb_mode
, 1 },
722 [LINE_MODE_PINCFG
] = { "[pincfg]", parse_pincfg_mode
, 1 },
723 [LINE_MODE_HINT
] = { "[hint]", parse_hint_mode
, 1 },
724 [LINE_MODE_VENDOR_ID
] = { "[vendor_id]", parse_vendor_id_mode
, 1 },
725 [LINE_MODE_SUBSYSTEM_ID
] = { "[subsystem_id]", parse_subsystem_id_mode
, 1 },
726 [LINE_MODE_REVISION_ID
] = { "[revision_id]", parse_revision_id_mode
, 1 },
727 [LINE_MODE_CHIP_NAME
] = { "[chip_name]", parse_chip_name_mode
, 1 },
730 /* check the line starting with '[' -- change the parser mode accodingly */
731 static int parse_line_mode(char *buf
, struct hda_bus
*bus
)
734 for (i
= 0; i
< ARRAY_SIZE(patch_items
); i
++) {
735 if (!patch_items
[i
].tag
)
737 if (strmatch(buf
, patch_items
[i
].tag
))
740 return LINE_MODE_NONE
;
743 /* copy one line from the buffer in fw, and update the fields in fw
744 * return zero if it reaches to the end of the buffer, or non-zero
745 * if successfully copied a line
747 * the spaces at the beginning and the end of the line are stripped
749 static int get_line_from_fw(char *buf
, int size
, size_t *fw_size_p
,
750 const void **fw_data_p
)
753 size_t fw_size
= *fw_size_p
;
754 const char *p
= *fw_data_p
;
756 while (isspace(*p
) && fw_size
) {
763 for (len
= 0; len
< fw_size
; len
++) {
775 *fw_size_p
= fw_size
- len
;
777 remove_trail_spaces(buf
);
782 * load a "patch" firmware file and parse it
784 int snd_hda_load_patch(struct hda_bus
*bus
, size_t fw_size
, const void *fw_buf
)
787 struct hda_codec
*codec
;
790 line_mode
= LINE_MODE_NONE
;
792 while (get_line_from_fw(buf
, sizeof(buf
) - 1, &fw_size
, &fw_buf
)) {
793 if (!*buf
|| *buf
== '#' || *buf
== '\n')
796 line_mode
= parse_line_mode(buf
, bus
);
797 else if (patch_items
[line_mode
].parser
&&
798 (codec
|| !patch_items
[line_mode
].need_codec
))
799 patch_items
[line_mode
].parser(buf
, bus
, &codec
);
803 EXPORT_SYMBOL_HDA(snd_hda_load_patch
);
804 #endif /* CONFIG_SND_HDA_PATCH_LOADER */