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 int snd_jack_dev_disconnect(struct snd_device *device)
42 #ifdef CONFIG_SND_JACK_INPUT_DEV
43 struct snd_jack *jack = device->device_data;
48 /* If the input device is registered with the input subsystem
49 * then we need to use a different deallocator. */
51 input_unregister_device(jack->input_dev);
53 input_free_device(jack->input_dev);
54 jack->input_dev = NULL;
55 #endif /* CONFIG_SND_JACK_INPUT_DEV */
59 static int snd_jack_dev_free(struct snd_device *device)
61 struct snd_jack *jack = device->device_data;
62 struct snd_card *card = device->card;
63 struct snd_jack_kctl *jack_kctl, *tmp_jack_kctl;
65 list_for_each_entry_safe(jack_kctl, tmp_jack_kctl, &jack->kctl_list, list) {
66 list_del_init(&jack_kctl->list);
67 snd_ctl_remove(card, jack_kctl->kctl);
69 if (jack->private_free)
70 jack->private_free(jack);
72 snd_jack_dev_disconnect(device);
80 #ifdef CONFIG_SND_JACK_INPUT_DEV
81 static int snd_jack_dev_register(struct snd_device *device)
83 struct snd_jack *jack = device->device_data;
84 struct snd_card *card = device->card;
87 snprintf(jack->name, sizeof(jack->name), "%s %s",
88 card->shortname, jack->id);
93 jack->input_dev->name = jack->name;
95 /* Default to the sound card device. */
96 if (!jack->input_dev->dev.parent)
97 jack->input_dev->dev.parent = snd_card_get_device_link(card);
99 /* Add capabilities for any keys that are enabled */
100 for (i = 0; i < ARRAY_SIZE(jack->key); i++) {
101 int testbit = SND_JACK_BTN_0 >> i;
103 if (!(jack->type & testbit))
107 jack->key[i] = BTN_0 + i;
109 input_set_capability(jack->input_dev, EV_KEY, jack->key[i]);
112 err = input_register_device(jack->input_dev);
114 jack->registered = 1;
118 #endif /* CONFIG_SND_JACK_INPUT_DEV */
120 #ifdef CONFIG_SND_JACK_INJECTION_DEBUG
121 static void snd_jack_inject_report(struct snd_jack_kctl *jack_kctl, int status)
123 struct snd_jack *jack;
124 #ifdef CONFIG_SND_JACK_INPUT_DEV
130 jack = jack_kctl->jack;
132 if (jack_kctl->sw_inject_enable)
133 snd_kctl_jack_report(jack->card, jack_kctl->kctl,
134 status & jack_kctl->mask_bits);
136 #ifdef CONFIG_SND_JACK_INPUT_DEV
137 if (!jack->input_dev)
140 for (i = 0; i < ARRAY_SIZE(jack->key); i++) {
141 int testbit = ((SND_JACK_BTN_0 >> i) & jack_kctl->mask_bits);
143 if (jack->type & testbit)
144 input_report_key(jack->input_dev, jack->key[i],
148 for (i = 0; i < ARRAY_SIZE(jack_switch_types); i++) {
149 int testbit = ((1 << i) & jack_kctl->mask_bits);
151 if (jack->type & testbit)
152 input_report_switch(jack->input_dev,
153 jack_switch_types[i],
157 input_sync(jack->input_dev);
158 #endif /* CONFIG_SND_JACK_INPUT_DEV */
161 static ssize_t sw_inject_enable_read(struct file *file,
162 char __user *to, size_t count, loff_t *ppos)
164 struct snd_jack_kctl *jack_kctl = file->private_data;
168 len = scnprintf(buf, sizeof(buf), "%s: %s\t\t%s: %i\n", "Jack", jack_kctl->kctl->id.name,
169 "Inject Enabled", jack_kctl->sw_inject_enable);
170 ret = simple_read_from_buffer(to, count, ppos, buf, len);
175 static ssize_t sw_inject_enable_write(struct file *file,
176 const char __user *from, size_t count, loff_t *ppos)
178 struct snd_jack_kctl *jack_kctl = file->private_data;
180 unsigned long enable;
183 ret = simple_write_to_buffer(buf, sizeof(buf) - 1, ppos, from, count);
184 err = kstrtoul(buf, 0, &enable);
188 if (jack_kctl->sw_inject_enable == (!!enable))
191 jack_kctl->sw_inject_enable = !!enable;
193 if (!jack_kctl->sw_inject_enable)
194 snd_jack_report(jack_kctl->jack, jack_kctl->jack->hw_status_cache);
199 static ssize_t jackin_inject_write(struct file *file,
200 const char __user *from, size_t count, loff_t *ppos)
202 struct snd_jack_kctl *jack_kctl = file->private_data;
204 unsigned long enable;
207 if (!jack_kctl->sw_inject_enable)
210 ret = simple_write_to_buffer(buf, sizeof(buf) - 1, ppos, from, count);
211 err = kstrtoul(buf, 0, &enable);
215 snd_jack_inject_report(jack_kctl, !!enable ? jack_kctl->mask_bits : 0);
220 static ssize_t jack_kctl_id_read(struct file *file,
221 char __user *to, size_t count, loff_t *ppos)
223 struct snd_jack_kctl *jack_kctl = file->private_data;
227 len = scnprintf(buf, sizeof(buf), "%s\n", jack_kctl->kctl->id.name);
228 ret = simple_read_from_buffer(to, count, ppos, buf, len);
233 /* the bit definition is aligned with snd_jack_types in jack.h */
234 static const char * const jack_events_name[] = {
235 "HEADPHONE(0x0001)", "MICROPHONE(0x0002)", "LINEOUT(0x0004)",
236 "MECHANICAL(0x0008)", "VIDEOOUT(0x0010)", "LINEIN(0x0020)",
237 "", "", "", "BTN_5(0x0200)", "BTN_4(0x0400)", "BTN_3(0x0800)",
238 "BTN_2(0x1000)", "BTN_1(0x2000)", "BTN_0(0x4000)", "",
241 /* the recommended buffer size is 256 */
242 static int parse_mask_bits(unsigned int mask_bits, char *buf, size_t buf_size)
246 scnprintf(buf, buf_size, "0x%04x", mask_bits);
248 for (i = 0; i < ARRAY_SIZE(jack_events_name); i++)
249 if (mask_bits & (1 << i)) {
250 strlcat(buf, " ", buf_size);
251 strlcat(buf, jack_events_name[i], buf_size);
253 strlcat(buf, "\n", buf_size);
258 static ssize_t jack_kctl_mask_bits_read(struct file *file,
259 char __user *to, size_t count, loff_t *ppos)
261 struct snd_jack_kctl *jack_kctl = file->private_data;
265 len = parse_mask_bits(jack_kctl->mask_bits, buf, sizeof(buf));
266 ret = simple_read_from_buffer(to, count, ppos, buf, len);
271 static ssize_t jack_kctl_status_read(struct file *file,
272 char __user *to, size_t count, loff_t *ppos)
274 struct snd_jack_kctl *jack_kctl = file->private_data;
278 len = scnprintf(buf, sizeof(buf), "%s\n", jack_kctl->kctl->private_value ?
279 "Plugged" : "Unplugged");
280 ret = simple_read_from_buffer(to, count, ppos, buf, len);
285 #ifdef CONFIG_SND_JACK_INPUT_DEV
286 static ssize_t jack_type_read(struct file *file,
287 char __user *to, size_t count, loff_t *ppos)
289 struct snd_jack_kctl *jack_kctl = file->private_data;
293 len = parse_mask_bits(jack_kctl->jack->type, buf, sizeof(buf));
294 ret = simple_read_from_buffer(to, count, ppos, buf, len);
299 static const struct file_operations jack_type_fops = {
301 .read = jack_type_read,
302 .llseek = default_llseek,
306 static const struct file_operations sw_inject_enable_fops = {
308 .read = sw_inject_enable_read,
309 .write = sw_inject_enable_write,
310 .llseek = default_llseek,
313 static const struct file_operations jackin_inject_fops = {
315 .write = jackin_inject_write,
316 .llseek = default_llseek,
319 static const struct file_operations jack_kctl_id_fops = {
321 .read = jack_kctl_id_read,
322 .llseek = default_llseek,
325 static const struct file_operations jack_kctl_mask_bits_fops = {
327 .read = jack_kctl_mask_bits_read,
328 .llseek = default_llseek,
331 static const struct file_operations jack_kctl_status_fops = {
333 .read = jack_kctl_status_read,
334 .llseek = default_llseek,
337 static int snd_jack_debugfs_add_inject_node(struct snd_jack *jack,
338 struct snd_jack_kctl *jack_kctl)
343 /* Don't create injection interface for Phantom jacks */
344 if (strstr(jack_kctl->kctl->id.name, "Phantom"))
347 tname = kstrdup(jack_kctl->kctl->id.name, GFP_KERNEL);
351 /* replace the chars which are not suitable for folder's name with _ */
352 for (i = 0; tname[i]; i++)
353 if (!isalnum(tname[i]))
356 jack_kctl->jack_debugfs_root = debugfs_create_dir(tname, jack->card->debugfs_root);
359 debugfs_create_file("sw_inject_enable", 0644, jack_kctl->jack_debugfs_root, jack_kctl,
360 &sw_inject_enable_fops);
362 debugfs_create_file("jackin_inject", 0200, jack_kctl->jack_debugfs_root, jack_kctl,
363 &jackin_inject_fops);
365 debugfs_create_file("kctl_id", 0444, jack_kctl->jack_debugfs_root, jack_kctl,
368 debugfs_create_file("mask_bits", 0444, jack_kctl->jack_debugfs_root, jack_kctl,
369 &jack_kctl_mask_bits_fops);
371 debugfs_create_file("status", 0444, jack_kctl->jack_debugfs_root, jack_kctl,
372 &jack_kctl_status_fops);
374 #ifdef CONFIG_SND_JACK_INPUT_DEV
375 debugfs_create_file("type", 0444, jack_kctl->jack_debugfs_root, jack_kctl,
381 static void snd_jack_debugfs_clear_inject_node(struct snd_jack_kctl *jack_kctl)
383 debugfs_remove(jack_kctl->jack_debugfs_root);
384 jack_kctl->jack_debugfs_root = NULL;
386 #else /* CONFIG_SND_JACK_INJECTION_DEBUG */
387 static int snd_jack_debugfs_add_inject_node(struct snd_jack *jack,
388 struct snd_jack_kctl *jack_kctl)
393 static void snd_jack_debugfs_clear_inject_node(struct snd_jack_kctl *jack_kctl)
396 #endif /* CONFIG_SND_JACK_INJECTION_DEBUG */
398 static void snd_jack_kctl_private_free(struct snd_kcontrol *kctl)
400 struct snd_jack_kctl *jack_kctl;
402 jack_kctl = kctl->private_data;
404 snd_jack_debugfs_clear_inject_node(jack_kctl);
405 list_del(&jack_kctl->list);
410 static void snd_jack_kctl_add(struct snd_jack *jack, struct snd_jack_kctl *jack_kctl)
412 jack_kctl->jack = jack;
413 list_add_tail(&jack_kctl->list, &jack->kctl_list);
414 snd_jack_debugfs_add_inject_node(jack, jack_kctl);
417 static struct snd_jack_kctl * snd_jack_kctl_new(struct snd_card *card, const char *name, unsigned int mask)
419 struct snd_kcontrol *kctl;
420 struct snd_jack_kctl *jack_kctl;
423 kctl = snd_kctl_jack_new(name, card);
427 err = snd_ctl_add(card, kctl);
431 jack_kctl = kzalloc(sizeof(*jack_kctl), GFP_KERNEL);
436 jack_kctl->kctl = kctl;
437 jack_kctl->mask_bits = mask;
439 kctl->private_data = jack_kctl;
440 kctl->private_free = snd_jack_kctl_private_free;
444 snd_ctl_free_one(kctl);
449 * snd_jack_add_new_kctl - Create a new snd_jack_kctl and add it to jack
450 * @jack: the jack instance which the kctl will attaching to
451 * @name: the name for the snd_kcontrol object
452 * @mask: a bitmask of enum snd_jack_type values that can be detected
453 * by this snd_jack_kctl object.
455 * Creates a new snd_kcontrol object and adds it to the jack kctl_list.
457 * Return: Zero if successful, or a negative error code on failure.
459 int snd_jack_add_new_kctl(struct snd_jack *jack, const char * name, int mask)
461 struct snd_jack_kctl *jack_kctl;
463 jack_kctl = snd_jack_kctl_new(jack->card, name, mask);
467 snd_jack_kctl_add(jack, jack_kctl);
470 EXPORT_SYMBOL(snd_jack_add_new_kctl);
473 * snd_jack_new - Create a new jack
474 * @card: the card instance
475 * @id: an identifying string for this jack
476 * @type: a bitmask of enum snd_jack_type values that can be detected by
478 * @jjack: Used to provide the allocated jack object to the caller.
479 * @initial_kctl: if true, create a kcontrol and add it to the jack list.
480 * @phantom_jack: Don't create a input device for phantom jacks.
482 * Creates a new jack object.
484 * Return: Zero if successful, or a negative error code on failure.
485 * On success @jjack will be initialised.
487 int snd_jack_new(struct snd_card *card, const char *id, int type,
488 struct snd_jack **jjack, bool initial_kctl, bool phantom_jack)
490 struct snd_jack *jack;
491 struct snd_jack_kctl *jack_kctl = NULL;
493 static const struct snd_device_ops ops = {
494 .dev_free = snd_jack_dev_free,
495 #ifdef CONFIG_SND_JACK_INPUT_DEV
496 .dev_register = snd_jack_dev_register,
497 .dev_disconnect = snd_jack_dev_disconnect,
498 #endif /* CONFIG_SND_JACK_INPUT_DEV */
502 jack_kctl = snd_jack_kctl_new(card, id, type);
507 jack = kzalloc(sizeof(struct snd_jack), GFP_KERNEL);
511 jack->id = kstrdup(id, GFP_KERNEL);
513 /* don't creat input device for phantom jack */
515 #ifdef CONFIG_SND_JACK_INPUT_DEV
518 jack->input_dev = input_allocate_device();
519 if (jack->input_dev == NULL) {
524 jack->input_dev->phys = "ALSA";
528 for (i = 0; i < SND_JACK_SWITCH_TYPES; i++)
530 input_set_capability(jack->input_dev, EV_SW,
531 jack_switch_types[i]);
533 #endif /* CONFIG_SND_JACK_INPUT_DEV */
536 err = snd_device_new(card, SNDRV_DEV_JACK, jack, &ops);
541 INIT_LIST_HEAD(&jack->kctl_list);
544 snd_jack_kctl_add(jack, jack_kctl);
551 #ifdef CONFIG_SND_JACK_INPUT_DEV
552 input_free_device(jack->input_dev);
558 EXPORT_SYMBOL(snd_jack_new);
560 #ifdef CONFIG_SND_JACK_INPUT_DEV
562 * snd_jack_set_parent - Set the parent device for a jack
564 * @jack: The jack to configure
565 * @parent: The device to set as parent for the jack.
567 * Set the parent for the jack devices in the device tree. This
568 * function is only valid prior to registration of the jack. If no
569 * parent is configured then the parent device will be the sound card.
571 void snd_jack_set_parent(struct snd_jack *jack, struct device *parent)
573 WARN_ON(jack->registered);
574 if (!jack->input_dev)
577 jack->input_dev->dev.parent = parent;
579 EXPORT_SYMBOL(snd_jack_set_parent);
582 * snd_jack_set_key - Set a key mapping on a jack
584 * @jack: The jack to configure
585 * @type: Jack report type for this key
586 * @keytype: Input layer key type to be reported
588 * Map a SND_JACK_BTN_* button type to an input layer key, allowing
589 * reporting of keys on accessories via the jack abstraction. If no
590 * mapping is provided but keys are enabled in the jack type then
591 * BTN_n numeric buttons will be reported.
593 * If jacks are not reporting via the input API this call will have no
596 * Note that this is intended to be use by simple devices with small
597 * numbers of keys that can be reported. It is also possible to
598 * access the input device directly - devices with complex input
599 * capabilities on accessories should consider doing this rather than
600 * using this abstraction.
602 * This function may only be called prior to registration of the jack.
604 * Return: Zero if successful, or a negative error code on failure.
606 int snd_jack_set_key(struct snd_jack *jack, enum snd_jack_types type,
609 int key = fls(SND_JACK_BTN_0) - fls(type);
611 WARN_ON(jack->registered);
613 if (!keytype || key >= ARRAY_SIZE(jack->key))
617 jack->key[key] = keytype;
620 EXPORT_SYMBOL(snd_jack_set_key);
621 #endif /* CONFIG_SND_JACK_INPUT_DEV */
624 * snd_jack_report - Report the current status of a jack
626 * @jack: The jack to report status for
627 * @status: The current status of the jack
629 void snd_jack_report(struct snd_jack *jack, int status)
631 struct snd_jack_kctl *jack_kctl;
632 unsigned int mask_bits = 0;
633 #ifdef CONFIG_SND_JACK_INPUT_DEV
640 jack->hw_status_cache = status;
642 list_for_each_entry(jack_kctl, &jack->kctl_list, list)
643 if (jack_kctl->sw_inject_enable)
644 mask_bits |= jack_kctl->mask_bits;
646 snd_kctl_jack_report(jack->card, jack_kctl->kctl,
647 status & jack_kctl->mask_bits);
649 #ifdef CONFIG_SND_JACK_INPUT_DEV
650 if (!jack->input_dev)
653 for (i = 0; i < ARRAY_SIZE(jack->key); i++) {
654 int testbit = ((SND_JACK_BTN_0 >> i) & ~mask_bits);
656 if (jack->type & testbit)
657 input_report_key(jack->input_dev, jack->key[i],
661 for (i = 0; i < ARRAY_SIZE(jack_switch_types); i++) {
662 int testbit = ((1 << i) & ~mask_bits);
664 if (jack->type & testbit)
665 input_report_switch(jack->input_dev,
666 jack_switch_types[i],
670 input_sync(jack->input_dev);
671 #endif /* CONFIG_SND_JACK_INPUT_DEV */
673 EXPORT_SYMBOL(snd_jack_report);