1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Jack abstraction layer
5 * Copyright 2008 Wolfson Microelectronics
8 #include <linux/input.h>
9 #include <linux/slab.h>
10 #include <linux/module.h>
11 #include <linux/ctype.h>
13 #include <linux/debugfs.h>
14 #include <sound/jack.h>
15 #include <sound/core.h>
16 #include <sound/control.h>
18 struct snd_jack_kctl {
19 struct snd_kcontrol *kctl;
20 struct list_head list; /* list of controls belong to the same jack */
21 unsigned int mask_bits; /* only masked status bits are reported via kctl */
22 struct snd_jack *jack; /* pointer to struct snd_jack */
23 bool sw_inject_enable; /* allow to inject plug event via debugfs */
24 #ifdef CONFIG_SND_JACK_INJECTION_DEBUG
25 struct dentry *jack_debugfs_root; /* jack_kctl debugfs root */
29 #ifdef CONFIG_SND_JACK_INPUT_DEV
30 static const int jack_switch_types[SND_JACK_SWITCH_TYPES] = {
34 SW_JACK_PHYSICAL_INSERT,
38 #endif /* CONFIG_SND_JACK_INPUT_DEV */
40 static void snd_jack_remove_debugfs(struct snd_jack *jack);
42 static int snd_jack_dev_disconnect(struct snd_device *device)
44 struct snd_jack *jack = device->device_data;
46 snd_jack_remove_debugfs(jack);
48 #ifdef CONFIG_SND_JACK_INPUT_DEV
49 guard(mutex)(&jack->input_dev_lock);
53 /* If the input device is registered with the input subsystem
54 * then we need to use a different deallocator. */
56 input_unregister_device(jack->input_dev);
58 input_free_device(jack->input_dev);
59 jack->input_dev = NULL;
60 #endif /* CONFIG_SND_JACK_INPUT_DEV */
64 static int snd_jack_dev_free(struct snd_device *device)
66 struct snd_jack *jack = device->device_data;
67 struct snd_card *card = device->card;
68 struct snd_jack_kctl *jack_kctl, *tmp_jack_kctl;
70 list_for_each_entry_safe(jack_kctl, tmp_jack_kctl, &jack->kctl_list, list) {
71 list_del_init(&jack_kctl->list);
72 snd_ctl_remove(card, jack_kctl->kctl);
75 if (jack->private_free)
76 jack->private_free(jack);
78 snd_jack_dev_disconnect(device);
86 #ifdef CONFIG_SND_JACK_INPUT_DEV
87 static int snd_jack_dev_register(struct snd_device *device)
89 struct snd_jack *jack = device->device_data;
90 struct snd_card *card = device->card;
93 snprintf(jack->name, sizeof(jack->name), "%s %s",
94 card->shortname, jack->id);
96 guard(mutex)(&jack->input_dev_lock);
100 jack->input_dev->name = jack->name;
102 /* Default to the sound card device. */
103 if (!jack->input_dev->dev.parent)
104 jack->input_dev->dev.parent = snd_card_get_device_link(card);
106 /* Add capabilities for any keys that are enabled */
107 for (i = 0; i < ARRAY_SIZE(jack->key); i++) {
108 int testbit = SND_JACK_BTN_0 >> i;
110 if (!(jack->type & testbit))
114 jack->key[i] = BTN_0 + i;
116 input_set_capability(jack->input_dev, EV_KEY, jack->key[i]);
119 err = input_register_device(jack->input_dev);
121 jack->registered = 1;
125 #endif /* CONFIG_SND_JACK_INPUT_DEV */
127 #ifdef CONFIG_SND_JACK_INJECTION_DEBUG
128 static void snd_jack_inject_report(struct snd_jack_kctl *jack_kctl, int status)
130 struct snd_jack *jack;
131 #ifdef CONFIG_SND_JACK_INPUT_DEV
137 jack = jack_kctl->jack;
139 if (jack_kctl->sw_inject_enable)
140 snd_kctl_jack_report(jack->card, jack_kctl->kctl,
141 status & jack_kctl->mask_bits);
143 #ifdef CONFIG_SND_JACK_INPUT_DEV
144 if (!jack->input_dev)
147 for (i = 0; i < ARRAY_SIZE(jack->key); i++) {
148 int testbit = ((SND_JACK_BTN_0 >> i) & jack_kctl->mask_bits);
150 if (jack->type & testbit)
151 input_report_key(jack->input_dev, jack->key[i],
155 for (i = 0; i < ARRAY_SIZE(jack_switch_types); i++) {
156 int testbit = ((1 << i) & jack_kctl->mask_bits);
158 if (jack->type & testbit)
159 input_report_switch(jack->input_dev,
160 jack_switch_types[i],
164 input_sync(jack->input_dev);
165 #endif /* CONFIG_SND_JACK_INPUT_DEV */
168 static ssize_t sw_inject_enable_read(struct file *file,
169 char __user *to, size_t count, loff_t *ppos)
171 struct snd_jack_kctl *jack_kctl = file->private_data;
175 len = scnprintf(buf, sizeof(buf), "%s: %s\t\t%s: %i\n", "Jack", jack_kctl->kctl->id.name,
176 "Inject Enabled", jack_kctl->sw_inject_enable);
177 ret = simple_read_from_buffer(to, count, ppos, buf, len);
182 static ssize_t sw_inject_enable_write(struct file *file,
183 const char __user *from, size_t count, loff_t *ppos)
185 struct snd_jack_kctl *jack_kctl = file->private_data;
187 unsigned long enable;
190 ret = simple_write_to_buffer(buf, sizeof(buf) - 1, ppos, from, count);
191 err = kstrtoul(buf, 0, &enable);
195 if (jack_kctl->sw_inject_enable == (!!enable))
198 jack_kctl->sw_inject_enable = !!enable;
200 if (!jack_kctl->sw_inject_enable)
201 snd_jack_report(jack_kctl->jack, jack_kctl->jack->hw_status_cache);
206 static ssize_t jackin_inject_write(struct file *file,
207 const char __user *from, size_t count, loff_t *ppos)
209 struct snd_jack_kctl *jack_kctl = file->private_data;
211 unsigned long enable;
214 if (!jack_kctl->sw_inject_enable)
217 ret = simple_write_to_buffer(buf, sizeof(buf) - 1, ppos, from, count);
218 err = kstrtoul(buf, 0, &enable);
222 snd_jack_inject_report(jack_kctl, !!enable ? jack_kctl->mask_bits : 0);
227 static ssize_t jack_kctl_id_read(struct file *file,
228 char __user *to, size_t count, loff_t *ppos)
230 struct snd_jack_kctl *jack_kctl = file->private_data;
234 len = scnprintf(buf, sizeof(buf), "%s\n", jack_kctl->kctl->id.name);
235 ret = simple_read_from_buffer(to, count, ppos, buf, len);
240 /* the bit definition is aligned with snd_jack_types in jack.h */
241 static const char * const jack_events_name[] = {
242 "HEADPHONE(0x0001)", "MICROPHONE(0x0002)", "LINEOUT(0x0004)",
243 "MECHANICAL(0x0008)", "VIDEOOUT(0x0010)", "LINEIN(0x0020)",
244 "", "", "", "BTN_5(0x0200)", "BTN_4(0x0400)", "BTN_3(0x0800)",
245 "BTN_2(0x1000)", "BTN_1(0x2000)", "BTN_0(0x4000)", "",
248 /* the recommended buffer size is 256 */
249 static int parse_mask_bits(unsigned int mask_bits, char *buf, size_t buf_size)
253 scnprintf(buf, buf_size, "0x%04x", mask_bits);
255 for (i = 0; i < ARRAY_SIZE(jack_events_name); i++)
256 if (mask_bits & (1 << i)) {
257 strlcat(buf, " ", buf_size);
258 strlcat(buf, jack_events_name[i], buf_size);
260 strlcat(buf, "\n", buf_size);
265 static ssize_t jack_kctl_mask_bits_read(struct file *file,
266 char __user *to, size_t count, loff_t *ppos)
268 struct snd_jack_kctl *jack_kctl = file->private_data;
272 len = parse_mask_bits(jack_kctl->mask_bits, buf, sizeof(buf));
273 ret = simple_read_from_buffer(to, count, ppos, buf, len);
278 static ssize_t jack_kctl_status_read(struct file *file,
279 char __user *to, size_t count, loff_t *ppos)
281 struct snd_jack_kctl *jack_kctl = file->private_data;
285 len = scnprintf(buf, sizeof(buf), "%s\n", jack_kctl->kctl->private_value ?
286 "Plugged" : "Unplugged");
287 ret = simple_read_from_buffer(to, count, ppos, buf, len);
292 #ifdef CONFIG_SND_JACK_INPUT_DEV
293 static ssize_t jack_type_read(struct file *file,
294 char __user *to, size_t count, loff_t *ppos)
296 struct snd_jack_kctl *jack_kctl = file->private_data;
300 len = parse_mask_bits(jack_kctl->jack->type, buf, sizeof(buf));
301 ret = simple_read_from_buffer(to, count, ppos, buf, len);
306 static const struct file_operations jack_type_fops = {
308 .read = jack_type_read,
309 .llseek = default_llseek,
313 static const struct file_operations sw_inject_enable_fops = {
315 .read = sw_inject_enable_read,
316 .write = sw_inject_enable_write,
317 .llseek = default_llseek,
320 static const struct file_operations jackin_inject_fops = {
322 .write = jackin_inject_write,
323 .llseek = default_llseek,
326 static const struct file_operations jack_kctl_id_fops = {
328 .read = jack_kctl_id_read,
329 .llseek = default_llseek,
332 static const struct file_operations jack_kctl_mask_bits_fops = {
334 .read = jack_kctl_mask_bits_read,
335 .llseek = default_llseek,
338 static const struct file_operations jack_kctl_status_fops = {
340 .read = jack_kctl_status_read,
341 .llseek = default_llseek,
344 static int snd_jack_debugfs_add_inject_node(struct snd_jack *jack,
345 struct snd_jack_kctl *jack_kctl)
350 /* Don't create injection interface for Phantom jacks */
351 if (strstr(jack_kctl->kctl->id.name, "Phantom"))
354 tname = kstrdup(jack_kctl->kctl->id.name, GFP_KERNEL);
358 /* replace the chars which are not suitable for folder's name with _ */
359 for (i = 0; tname[i]; i++)
360 if (!isalnum(tname[i]))
363 jack_kctl->jack_debugfs_root = debugfs_create_dir(tname, jack->card->debugfs_root);
366 debugfs_create_file("sw_inject_enable", 0644, jack_kctl->jack_debugfs_root, jack_kctl,
367 &sw_inject_enable_fops);
369 debugfs_create_file("jackin_inject", 0200, jack_kctl->jack_debugfs_root, jack_kctl,
370 &jackin_inject_fops);
372 debugfs_create_file("kctl_id", 0444, jack_kctl->jack_debugfs_root, jack_kctl,
375 debugfs_create_file("mask_bits", 0444, jack_kctl->jack_debugfs_root, jack_kctl,
376 &jack_kctl_mask_bits_fops);
378 debugfs_create_file("status", 0444, jack_kctl->jack_debugfs_root, jack_kctl,
379 &jack_kctl_status_fops);
381 #ifdef CONFIG_SND_JACK_INPUT_DEV
382 debugfs_create_file("type", 0444, jack_kctl->jack_debugfs_root, jack_kctl,
388 static void snd_jack_remove_debugfs(struct snd_jack *jack)
390 struct snd_jack_kctl *jack_kctl;
392 list_for_each_entry(jack_kctl, &jack->kctl_list, list) {
393 debugfs_remove(jack_kctl->jack_debugfs_root);
394 jack_kctl->jack_debugfs_root = NULL;
397 #else /* CONFIG_SND_JACK_INJECTION_DEBUG */
398 static int snd_jack_debugfs_add_inject_node(struct snd_jack *jack,
399 struct snd_jack_kctl *jack_kctl)
404 static void snd_jack_remove_debugfs(struct snd_jack *jack)
407 #endif /* CONFIG_SND_JACK_INJECTION_DEBUG */
409 static void snd_jack_kctl_private_free(struct snd_kcontrol *kctl)
411 struct snd_jack_kctl *jack_kctl;
413 jack_kctl = kctl->private_data;
415 list_del(&jack_kctl->list);
420 static void snd_jack_kctl_add(struct snd_jack *jack, struct snd_jack_kctl *jack_kctl)
422 jack_kctl->jack = jack;
423 list_add_tail(&jack_kctl->list, &jack->kctl_list);
424 snd_jack_debugfs_add_inject_node(jack, jack_kctl);
427 static struct snd_jack_kctl * snd_jack_kctl_new(struct snd_card *card, const char *name, unsigned int mask)
429 struct snd_kcontrol *kctl;
430 struct snd_jack_kctl *jack_kctl;
433 kctl = snd_kctl_jack_new(name, card);
437 err = snd_ctl_add(card, kctl);
441 jack_kctl = kzalloc(sizeof(*jack_kctl), GFP_KERNEL);
446 jack_kctl->kctl = kctl;
447 jack_kctl->mask_bits = mask;
449 kctl->private_data = jack_kctl;
450 kctl->private_free = snd_jack_kctl_private_free;
454 snd_ctl_free_one(kctl);
459 * snd_jack_add_new_kctl - Create a new snd_jack_kctl and add it to jack
460 * @jack: the jack instance which the kctl will attaching to
461 * @name: the name for the snd_kcontrol object
462 * @mask: a bitmask of enum snd_jack_type values that can be detected
463 * by this snd_jack_kctl object.
465 * Creates a new snd_kcontrol object and adds it to the jack kctl_list.
467 * Return: Zero if successful, or a negative error code on failure.
469 int snd_jack_add_new_kctl(struct snd_jack *jack, const char * name, int mask)
471 struct snd_jack_kctl *jack_kctl;
473 jack_kctl = snd_jack_kctl_new(jack->card, name, mask);
477 snd_jack_kctl_add(jack, jack_kctl);
480 EXPORT_SYMBOL(snd_jack_add_new_kctl);
483 * snd_jack_new - Create a new jack
484 * @card: the card instance
485 * @id: an identifying string for this jack
486 * @type: a bitmask of enum snd_jack_type values that can be detected by
488 * @jjack: Used to provide the allocated jack object to the caller.
489 * @initial_kctl: if true, create a kcontrol and add it to the jack list.
490 * @phantom_jack: Don't create a input device for phantom jacks.
492 * Creates a new jack object.
494 * Return: Zero if successful, or a negative error code on failure.
495 * On success @jjack will be initialised.
497 int snd_jack_new(struct snd_card *card, const char *id, int type,
498 struct snd_jack **jjack, bool initial_kctl, bool phantom_jack)
500 struct snd_jack *jack;
501 struct snd_jack_kctl *jack_kctl = NULL;
503 static const struct snd_device_ops ops = {
504 .dev_free = snd_jack_dev_free,
505 #ifdef CONFIG_SND_JACK_INPUT_DEV
506 .dev_register = snd_jack_dev_register,
507 #endif /* CONFIG_SND_JACK_INPUT_DEV */
508 .dev_disconnect = snd_jack_dev_disconnect,
512 jack_kctl = snd_jack_kctl_new(card, id, type);
517 jack = kzalloc(sizeof(struct snd_jack), GFP_KERNEL);
521 jack->id = kstrdup(id, GFP_KERNEL);
522 if (jack->id == NULL) {
527 #ifdef CONFIG_SND_JACK_INPUT_DEV
528 mutex_init(&jack->input_dev_lock);
530 /* don't create input device for phantom jack */
534 jack->input_dev = input_allocate_device();
535 if (jack->input_dev == NULL) {
540 jack->input_dev->phys = "ALSA";
544 for (i = 0; i < SND_JACK_SWITCH_TYPES; i++)
546 input_set_capability(jack->input_dev, EV_SW,
547 jack_switch_types[i]);
550 #endif /* CONFIG_SND_JACK_INPUT_DEV */
552 err = snd_device_new(card, SNDRV_DEV_JACK, jack, &ops);
557 INIT_LIST_HEAD(&jack->kctl_list);
560 snd_jack_kctl_add(jack, jack_kctl);
567 #ifdef CONFIG_SND_JACK_INPUT_DEV
568 input_free_device(jack->input_dev);
574 EXPORT_SYMBOL(snd_jack_new);
576 #ifdef CONFIG_SND_JACK_INPUT_DEV
578 * snd_jack_set_parent - Set the parent device for a jack
580 * @jack: The jack to configure
581 * @parent: The device to set as parent for the jack.
583 * Set the parent for the jack devices in the device tree. This
584 * function is only valid prior to registration of the jack. If no
585 * parent is configured then the parent device will be the sound card.
587 void snd_jack_set_parent(struct snd_jack *jack, struct device *parent)
589 WARN_ON(jack->registered);
590 guard(mutex)(&jack->input_dev_lock);
592 jack->input_dev->dev.parent = parent;
594 EXPORT_SYMBOL(snd_jack_set_parent);
597 * snd_jack_set_key - Set a key mapping on a jack
599 * @jack: The jack to configure
600 * @type: Jack report type for this key
601 * @keytype: Input layer key type to be reported
603 * Map a SND_JACK_BTN_* button type to an input layer key, allowing
604 * reporting of keys on accessories via the jack abstraction. If no
605 * mapping is provided but keys are enabled in the jack type then
606 * BTN_n numeric buttons will be reported.
608 * If jacks are not reporting via the input API this call will have no
611 * Note that this is intended to be use by simple devices with small
612 * numbers of keys that can be reported. It is also possible to
613 * access the input device directly - devices with complex input
614 * capabilities on accessories should consider doing this rather than
615 * using this abstraction.
617 * This function may only be called prior to registration of the jack.
619 * Return: Zero if successful, or a negative error code on failure.
621 int snd_jack_set_key(struct snd_jack *jack, enum snd_jack_types type,
624 int key = fls(SND_JACK_BTN_0) - fls(type);
626 WARN_ON(jack->registered);
628 if (!keytype || key >= ARRAY_SIZE(jack->key))
632 jack->key[key] = keytype;
635 EXPORT_SYMBOL(snd_jack_set_key);
636 #endif /* CONFIG_SND_JACK_INPUT_DEV */
639 * snd_jack_report - Report the current status of a jack
640 * Note: This function uses mutexes and should be called from a
641 * context which can sleep (such as a workqueue).
643 * @jack: The jack to report status for
644 * @status: The current status of the jack
646 void snd_jack_report(struct snd_jack *jack, int status)
648 struct snd_jack_kctl *jack_kctl;
649 unsigned int mask_bits = 0;
650 #ifdef CONFIG_SND_JACK_INPUT_DEV
651 struct input_dev *idev;
658 jack->hw_status_cache = status;
660 list_for_each_entry(jack_kctl, &jack->kctl_list, list)
661 if (jack_kctl->sw_inject_enable)
662 mask_bits |= jack_kctl->mask_bits;
664 snd_kctl_jack_report(jack->card, jack_kctl->kctl,
665 status & jack_kctl->mask_bits);
667 #ifdef CONFIG_SND_JACK_INPUT_DEV
668 idev = input_get_device(jack->input_dev);
672 for (i = 0; i < ARRAY_SIZE(jack->key); i++) {
673 int testbit = ((SND_JACK_BTN_0 >> i) & ~mask_bits);
675 if (jack->type & testbit)
676 input_report_key(idev, jack->key[i],
680 for (i = 0; i < ARRAY_SIZE(jack_switch_types); i++) {
681 int testbit = ((1 << i) & ~mask_bits);
683 if (jack->type & testbit)
684 input_report_switch(idev,
685 jack_switch_types[i],
690 input_put_device(idev);
691 #endif /* CONFIG_SND_JACK_INPUT_DEV */
693 EXPORT_SYMBOL(snd_jack_report);