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/firmware.h>
29 #include <linux/export.h>
30 #include <sound/core.h>
31 #include "hda_codec.h"
32 #include "hda_local.h"
33 #include <sound/hda_hwdep.h>
34 #include <sound/minors.h>
36 /* hint string pair */
39 const char *val
; /* contained in the same alloc as key */
43 * write/read an out-of-bound verb
45 static int verb_write_ioctl(struct hda_codec
*codec
,
46 struct hda_verb_ioctl __user
*arg
)
50 if (get_user(verb
, &arg
->verb
))
52 res
= snd_hda_codec_read(codec
, verb
>> 24, 0,
53 (verb
>> 8) & 0xffff, verb
& 0xff);
54 if (put_user(res
, &arg
->res
))
59 static int get_wcap_ioctl(struct hda_codec
*codec
,
60 struct hda_verb_ioctl __user
*arg
)
64 if (get_user(verb
, &arg
->verb
))
66 res
= get_wcaps(codec
, verb
>> 24);
67 if (put_user(res
, &arg
->res
))
75 static int hda_hwdep_ioctl(struct snd_hwdep
*hw
, struct file
*file
,
76 unsigned int cmd
, unsigned long arg
)
78 struct hda_codec
*codec
= hw
->private_data
;
79 void __user
*argp
= (void __user
*)arg
;
82 case HDA_IOCTL_PVERSION
:
83 return put_user(HDA_HWDEP_VERSION
, (int __user
*)argp
);
84 case HDA_IOCTL_VERB_WRITE
:
85 return verb_write_ioctl(codec
, argp
);
86 case HDA_IOCTL_GET_WCAP
:
87 return get_wcap_ioctl(codec
, argp
);
93 static int hda_hwdep_ioctl_compat(struct snd_hwdep
*hw
, struct file
*file
,
94 unsigned int cmd
, unsigned long arg
)
96 return hda_hwdep_ioctl(hw
, file
, cmd
, (unsigned long)compat_ptr(arg
));
100 static int hda_hwdep_open(struct snd_hwdep
*hw
, struct file
*file
)
102 #ifndef CONFIG_SND_DEBUG_VERBOSE
103 if (!capable(CAP_SYS_RAWIO
))
109 static void clear_hwdep_elements(struct hda_codec
*codec
)
113 /* clear init verbs */
114 snd_array_free(&codec
->init_verbs
);
116 for (i
= 0; i
< codec
->hints
.used
; i
++) {
117 struct hda_hint
*hint
= snd_array_elem(&codec
->hints
, i
);
118 kfree(hint
->key
); /* we don't need to free hint->val */
120 snd_array_free(&codec
->hints
);
121 snd_array_free(&codec
->user_pins
);
124 static void hwdep_free(struct snd_hwdep
*hwdep
)
126 clear_hwdep_elements(hwdep
->private_data
);
129 int /*__devinit*/ snd_hda_create_hwdep(struct hda_codec
*codec
)
132 struct snd_hwdep
*hwdep
;
135 sprintf(hwname
, "HDA Codec %d", codec
->addr
);
136 err
= snd_hwdep_new(codec
->bus
->card
, hwname
, codec
->addr
, &hwdep
);
139 codec
->hwdep
= hwdep
;
140 sprintf(hwdep
->name
, "HDA Codec %d", codec
->addr
);
141 hwdep
->iface
= SNDRV_HWDEP_IFACE_HDA
;
142 hwdep
->private_data
= codec
;
143 hwdep
->private_free
= hwdep_free
;
144 hwdep
->exclusive
= 1;
146 hwdep
->ops
.open
= hda_hwdep_open
;
147 hwdep
->ops
.ioctl
= hda_hwdep_ioctl
;
149 hwdep
->ops
.ioctl_compat
= hda_hwdep_ioctl_compat
;
152 snd_array_init(&codec
->init_verbs
, sizeof(struct hda_verb
), 32);
153 snd_array_init(&codec
->hints
, sizeof(struct hda_hint
), 32);
154 snd_array_init(&codec
->user_pins
, sizeof(struct hda_pincfg
), 16);
159 #ifdef CONFIG_SND_HDA_POWER_SAVE
160 static ssize_t
power_on_acct_show(struct device
*dev
,
161 struct device_attribute
*attr
,
164 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
165 struct hda_codec
*codec
= hwdep
->private_data
;
166 snd_hda_update_power_acct(codec
);
167 return sprintf(buf
, "%u\n", jiffies_to_msecs(codec
->power_on_acct
));
170 static ssize_t
power_off_acct_show(struct device
*dev
,
171 struct device_attribute
*attr
,
174 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
175 struct hda_codec
*codec
= hwdep
->private_data
;
176 snd_hda_update_power_acct(codec
);
177 return sprintf(buf
, "%u\n", jiffies_to_msecs(codec
->power_off_acct
));
180 static struct device_attribute power_attrs
[] = {
181 __ATTR_RO(power_on_acct
),
182 __ATTR_RO(power_off_acct
),
185 int snd_hda_hwdep_add_power_sysfs(struct hda_codec
*codec
)
187 struct snd_hwdep
*hwdep
= codec
->hwdep
;
190 for (i
= 0; i
< ARRAY_SIZE(power_attrs
); i
++)
191 snd_add_device_sysfs_file(SNDRV_DEVICE_TYPE_HWDEP
, hwdep
->card
,
192 hwdep
->device
, &power_attrs
[i
]);
195 #endif /* CONFIG_SND_HDA_POWER_SAVE */
197 #ifdef CONFIG_SND_HDA_RECONFIG
203 static int clear_codec(struct hda_codec
*codec
)
207 err
= snd_hda_codec_reset(codec
);
209 snd_printk(KERN_ERR
"The codec is being used, can't free.\n");
212 clear_hwdep_elements(codec
);
216 static int reconfig_codec(struct hda_codec
*codec
)
220 snd_hda_power_up(codec
);
221 snd_printk(KERN_INFO
"hda-codec: reconfiguring\n");
222 err
= snd_hda_codec_reset(codec
);
225 "The codec is being used, can't reconfigure.\n");
228 err
= snd_hda_codec_configure(codec
);
232 err
= snd_hda_codec_build_pcms(codec
);
236 err
= snd_hda_codec_build_controls(codec
);
239 err
= snd_card_register(codec
->bus
->card
);
241 snd_hda_power_down(codec
);
246 * allocate a string at most len chars, and remove the trailing EOL
248 static char *kstrndup_noeol(const char *src
, size_t len
)
250 char *s
= kstrndup(src
, len
, GFP_KERNEL
);
260 #define CODEC_INFO_SHOW(type) \
261 static ssize_t type##_show(struct device *dev, \
262 struct device_attribute *attr, \
265 struct snd_hwdep *hwdep = dev_get_drvdata(dev); \
266 struct hda_codec *codec = hwdep->private_data; \
267 return sprintf(buf, "0x%x\n", codec->type); \
270 #define CODEC_INFO_STR_SHOW(type) \
271 static ssize_t type##_show(struct device *dev, \
272 struct device_attribute *attr, \
275 struct snd_hwdep *hwdep = dev_get_drvdata(dev); \
276 struct hda_codec *codec = hwdep->private_data; \
277 return sprintf(buf, "%s\n", \
278 codec->type ? codec->type : ""); \
281 CODEC_INFO_SHOW(vendor_id
);
282 CODEC_INFO_SHOW(subsystem_id
);
283 CODEC_INFO_SHOW(revision_id
);
284 CODEC_INFO_SHOW(afg
);
285 CODEC_INFO_SHOW(mfg
);
286 CODEC_INFO_STR_SHOW(vendor_name
);
287 CODEC_INFO_STR_SHOW(chip_name
);
288 CODEC_INFO_STR_SHOW(modelname
);
290 #define CODEC_INFO_STORE(type) \
291 static ssize_t type##_store(struct device *dev, \
292 struct device_attribute *attr, \
293 const char *buf, size_t count) \
295 struct snd_hwdep *hwdep = dev_get_drvdata(dev); \
296 struct hda_codec *codec = hwdep->private_data; \
298 int err = strict_strtoul(buf, 0, &val); \
305 #define CODEC_INFO_STR_STORE(type) \
306 static ssize_t type##_store(struct device *dev, \
307 struct device_attribute *attr, \
308 const char *buf, size_t count) \
310 struct snd_hwdep *hwdep = dev_get_drvdata(dev); \
311 struct hda_codec *codec = hwdep->private_data; \
312 char *s = kstrndup_noeol(buf, 64); \
315 kfree(codec->type); \
320 CODEC_INFO_STORE(vendor_id
);
321 CODEC_INFO_STORE(subsystem_id
);
322 CODEC_INFO_STORE(revision_id
);
323 CODEC_INFO_STR_STORE(vendor_name
);
324 CODEC_INFO_STR_STORE(chip_name
);
325 CODEC_INFO_STR_STORE(modelname
);
327 #define CODEC_ACTION_STORE(type) \
328 static ssize_t type##_store(struct device *dev, \
329 struct device_attribute *attr, \
330 const char *buf, size_t count) \
332 struct snd_hwdep *hwdep = dev_get_drvdata(dev); \
333 struct hda_codec *codec = hwdep->private_data; \
336 err = type##_codec(codec); \
337 return err < 0 ? err : count; \
340 CODEC_ACTION_STORE(reconfig
);
341 CODEC_ACTION_STORE(clear
);
343 static ssize_t
init_verbs_show(struct device
*dev
,
344 struct device_attribute
*attr
,
347 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
348 struct hda_codec
*codec
= hwdep
->private_data
;
350 for (i
= 0; i
< codec
->init_verbs
.used
; i
++) {
351 struct hda_verb
*v
= snd_array_elem(&codec
->init_verbs
, i
);
352 len
+= snprintf(buf
+ len
, PAGE_SIZE
- len
,
353 "0x%02x 0x%03x 0x%04x\n",
354 v
->nid
, v
->verb
, v
->param
);
359 static int parse_init_verbs(struct hda_codec
*codec
, const char *buf
)
362 int nid
, verb
, param
;
364 if (sscanf(buf
, "%i %i %i", &nid
, &verb
, ¶m
) != 3)
368 v
= snd_array_new(&codec
->init_verbs
);
377 static ssize_t
init_verbs_store(struct device
*dev
,
378 struct device_attribute
*attr
,
379 const char *buf
, size_t count
)
381 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
382 struct hda_codec
*codec
= hwdep
->private_data
;
383 int err
= parse_init_verbs(codec
, buf
);
389 static ssize_t
hints_show(struct device
*dev
,
390 struct device_attribute
*attr
,
393 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
394 struct hda_codec
*codec
= hwdep
->private_data
;
396 for (i
= 0; i
< codec
->hints
.used
; i
++) {
397 struct hda_hint
*hint
= snd_array_elem(&codec
->hints
, i
);
398 len
+= snprintf(buf
+ len
, PAGE_SIZE
- len
,
399 "%s = %s\n", hint
->key
, hint
->val
);
404 static struct hda_hint
*get_hint(struct hda_codec
*codec
, const char *key
)
408 for (i
= 0; i
< codec
->hints
.used
; i
++) {
409 struct hda_hint
*hint
= snd_array_elem(&codec
->hints
, i
);
410 if (!strcmp(hint
->key
, key
))
416 static void remove_trail_spaces(char *str
)
421 p
= str
+ strlen(str
) - 1;
422 for (; isspace(*p
); p
--) {
429 #define MAX_HINTS 1024
431 static int parse_hints(struct hda_codec
*codec
, const char *buf
)
434 struct hda_hint
*hint
;
436 buf
= skip_spaces(buf
);
437 if (!*buf
|| *buf
== '#' || *buf
== '\n')
441 key
= kstrndup_noeol(buf
, 1024);
444 /* extract key and val */
445 val
= strchr(key
, '=');
451 val
= skip_spaces(val
);
452 remove_trail_spaces(key
);
453 remove_trail_spaces(val
);
454 hint
= get_hint(codec
, key
);
462 /* allocate a new hint entry */
463 if (codec
->hints
.used
>= MAX_HINTS
)
466 hint
= snd_array_new(&codec
->hints
);
476 static ssize_t
hints_store(struct device
*dev
,
477 struct device_attribute
*attr
,
478 const char *buf
, size_t count
)
480 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
481 struct hda_codec
*codec
= hwdep
->private_data
;
482 int err
= parse_hints(codec
, buf
);
488 static ssize_t
pin_configs_show(struct hda_codec
*codec
,
489 struct snd_array
*list
,
493 for (i
= 0; i
< list
->used
; i
++) {
494 struct hda_pincfg
*pin
= snd_array_elem(list
, i
);
495 len
+= sprintf(buf
+ len
, "0x%02x 0x%08x\n",
501 static ssize_t
init_pin_configs_show(struct device
*dev
,
502 struct device_attribute
*attr
,
505 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
506 struct hda_codec
*codec
= hwdep
->private_data
;
507 return pin_configs_show(codec
, &codec
->init_pins
, buf
);
510 static ssize_t
user_pin_configs_show(struct device
*dev
,
511 struct device_attribute
*attr
,
514 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
515 struct hda_codec
*codec
= hwdep
->private_data
;
516 return pin_configs_show(codec
, &codec
->user_pins
, buf
);
519 static ssize_t
driver_pin_configs_show(struct device
*dev
,
520 struct device_attribute
*attr
,
523 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
524 struct hda_codec
*codec
= hwdep
->private_data
;
525 return pin_configs_show(codec
, &codec
->driver_pins
, buf
);
528 #define MAX_PIN_CONFIGS 32
530 static int parse_user_pin_configs(struct hda_codec
*codec
, const char *buf
)
534 if (sscanf(buf
, "%i %i", &nid
, &cfg
) != 2)
538 return snd_hda_add_pincfg(codec
, &codec
->user_pins
, nid
, cfg
);
541 static ssize_t
user_pin_configs_store(struct device
*dev
,
542 struct device_attribute
*attr
,
543 const char *buf
, size_t count
)
545 struct snd_hwdep
*hwdep
= dev_get_drvdata(dev
);
546 struct hda_codec
*codec
= hwdep
->private_data
;
547 int err
= parse_user_pin_configs(codec
, buf
);
553 #define CODEC_ATTR_RW(type) \
554 __ATTR(type, 0644, type##_show, type##_store)
555 #define CODEC_ATTR_RO(type) \
557 #define CODEC_ATTR_WO(type) \
558 __ATTR(type, 0200, NULL, type##_store)
560 static struct device_attribute codec_attrs
[] = {
561 CODEC_ATTR_RW(vendor_id
),
562 CODEC_ATTR_RW(subsystem_id
),
563 CODEC_ATTR_RW(revision_id
),
566 CODEC_ATTR_RW(vendor_name
),
567 CODEC_ATTR_RW(chip_name
),
568 CODEC_ATTR_RW(modelname
),
569 CODEC_ATTR_RW(init_verbs
),
570 CODEC_ATTR_RW(hints
),
571 CODEC_ATTR_RO(init_pin_configs
),
572 CODEC_ATTR_RW(user_pin_configs
),
573 CODEC_ATTR_RO(driver_pin_configs
),
574 CODEC_ATTR_WO(reconfig
),
575 CODEC_ATTR_WO(clear
),
579 * create sysfs files on hwdep directory
581 int snd_hda_hwdep_add_sysfs(struct hda_codec
*codec
)
583 struct snd_hwdep
*hwdep
= codec
->hwdep
;
586 for (i
= 0; i
< ARRAY_SIZE(codec_attrs
); i
++)
587 snd_add_device_sysfs_file(SNDRV_DEVICE_TYPE_HWDEP
, hwdep
->card
,
588 hwdep
->device
, &codec_attrs
[i
]);
593 * Look for hint string
595 const char *snd_hda_get_hint(struct hda_codec
*codec
, const char *key
)
597 struct hda_hint
*hint
= get_hint(codec
, key
);
598 return hint
? hint
->val
: NULL
;
600 EXPORT_SYMBOL_HDA(snd_hda_get_hint
);
602 int snd_hda_get_bool_hint(struct hda_codec
*codec
, const char *key
)
604 const char *p
= snd_hda_get_hint(codec
, key
);
607 switch (toupper(*p
)) {
615 EXPORT_SYMBOL_HDA(snd_hda_get_bool_hint
);
617 #endif /* CONFIG_SND_HDA_RECONFIG */
619 #ifdef CONFIG_SND_HDA_PATCH_LOADER
630 LINE_MODE_SUBSYSTEM_ID
,
631 LINE_MODE_REVISION_ID
,
636 static inline int strmatch(const char *a
, const char *b
)
638 return strnicmp(a
, b
, strlen(b
)) == 0;
641 /* parse the contents after the line "[codec]"
642 * accept only the line with three numbers, and assign the current codec
644 static void parse_codec_mode(char *buf
, struct hda_bus
*bus
,
645 struct hda_codec
**codecp
)
647 int vendorid
, subid
, caddr
;
648 struct hda_codec
*codec
;
651 if (sscanf(buf
, "%i %i %i", &vendorid
, &subid
, &caddr
) == 3) {
652 list_for_each_entry(codec
, &bus
->codec_list
, list
) {
653 if ((vendorid
<= 0 || codec
->vendor_id
== vendorid
) &&
654 (subid
<= 0 || codec
->subsystem_id
== subid
) &&
655 codec
->addr
== caddr
) {
663 /* parse the contents after the other command tags, [pincfg], [verb],
664 * [vendor_id], [subsystem_id], [revision_id], [chip_name], [hint] and [model]
665 * just pass to the sysfs helper (only when any codec was specified)
667 static void parse_pincfg_mode(char *buf
, struct hda_bus
*bus
,
668 struct hda_codec
**codecp
)
670 parse_user_pin_configs(*codecp
, buf
);
673 static void parse_verb_mode(char *buf
, struct hda_bus
*bus
,
674 struct hda_codec
**codecp
)
676 parse_init_verbs(*codecp
, buf
);
679 static void parse_hint_mode(char *buf
, struct hda_bus
*bus
,
680 struct hda_codec
**codecp
)
682 parse_hints(*codecp
, buf
);
685 static void parse_model_mode(char *buf
, struct hda_bus
*bus
,
686 struct hda_codec
**codecp
)
688 kfree((*codecp
)->modelname
);
689 (*codecp
)->modelname
= kstrdup(buf
, GFP_KERNEL
);
692 static void parse_chip_name_mode(char *buf
, struct hda_bus
*bus
,
693 struct hda_codec
**codecp
)
695 kfree((*codecp
)->chip_name
);
696 (*codecp
)->chip_name
= kstrdup(buf
, GFP_KERNEL
);
699 #define DEFINE_PARSE_ID_MODE(name) \
700 static void parse_##name##_mode(char *buf, struct hda_bus *bus, \
701 struct hda_codec **codecp) \
704 if (!strict_strtoul(buf, 0, &val)) \
705 (*codecp)->name = val; \
708 DEFINE_PARSE_ID_MODE(vendor_id
);
709 DEFINE_PARSE_ID_MODE(subsystem_id
);
710 DEFINE_PARSE_ID_MODE(revision_id
);
713 struct hda_patch_item
{
715 void (*parser
)(char *buf
, struct hda_bus
*bus
, struct hda_codec
**retc
);
719 static struct hda_patch_item patch_items
[NUM_LINE_MODES
] = {
720 [LINE_MODE_CODEC
] = { "[codec]", parse_codec_mode
, 0 },
721 [LINE_MODE_MODEL
] = { "[model]", parse_model_mode
, 1 },
722 [LINE_MODE_VERB
] = { "[verb]", parse_verb_mode
, 1 },
723 [LINE_MODE_PINCFG
] = { "[pincfg]", parse_pincfg_mode
, 1 },
724 [LINE_MODE_HINT
] = { "[hint]", parse_hint_mode
, 1 },
725 [LINE_MODE_VENDOR_ID
] = { "[vendor_id]", parse_vendor_id_mode
, 1 },
726 [LINE_MODE_SUBSYSTEM_ID
] = { "[subsystem_id]", parse_subsystem_id_mode
, 1 },
727 [LINE_MODE_REVISION_ID
] = { "[revision_id]", parse_revision_id_mode
, 1 },
728 [LINE_MODE_CHIP_NAME
] = { "[chip_name]", parse_chip_name_mode
, 1 },
731 /* check the line starting with '[' -- change the parser mode accodingly */
732 static int parse_line_mode(char *buf
, struct hda_bus
*bus
)
735 for (i
= 0; i
< ARRAY_SIZE(patch_items
); i
++) {
736 if (!patch_items
[i
].tag
)
738 if (strmatch(buf
, patch_items
[i
].tag
))
741 return LINE_MODE_NONE
;
744 /* copy one line from the buffer in fw, and update the fields in fw
745 * return zero if it reaches to the end of the buffer, or non-zero
746 * if successfully copied a line
748 * the spaces at the beginning and the end of the line are stripped
750 static int get_line_from_fw(char *buf
, int size
, struct firmware
*fw
)
753 const char *p
= fw
->data
;
754 while (isspace(*p
) && fw
->size
) {
761 for (len
= 0; len
< fw
->size
; len
++) {
775 remove_trail_spaces(buf
);
780 * load a "patch" firmware file and parse it
782 int snd_hda_load_patch(struct hda_bus
*bus
, const char *patch
)
785 const struct firmware
*fw
;
788 struct hda_codec
*codec
;
790 struct device
*dev
= bus
->card
->dev
;
792 if (snd_BUG_ON(!dev
))
794 err
= request_firmware(&fw
, patch
, dev
);
796 printk(KERN_ERR
"hda-codec: Cannot load the patch '%s'\n",
802 line_mode
= LINE_MODE_NONE
;
804 while (get_line_from_fw(buf
, sizeof(buf
) - 1, &tmp
)) {
805 if (!*buf
|| *buf
== '#' || *buf
== '\n')
808 line_mode
= parse_line_mode(buf
, bus
);
809 else if (patch_items
[line_mode
].parser
&&
810 (codec
|| !patch_items
[line_mode
].need_codec
))
811 patch_items
[line_mode
].parser(buf
, bus
, &codec
);
813 release_firmware(fw
);
816 EXPORT_SYMBOL_HDA(snd_hda_load_patch
);
817 #endif /* CONFIG_SND_HDA_PATCH_LOADER */