Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Jack abstraction layer
4 *
5 * Copyright 2008 Wolfson Microelectronics
6 */
7
8#include <linux/input.h>
9#include <linux/slab.h>
10#include <linux/module.h>
11#include <sound/jack.h>
12#include <sound/core.h>
13#include <sound/control.h>
14
15struct snd_jack_kctl {
16 struct snd_kcontrol *kctl;
17 struct list_head list; /* list of controls belong to the same jack */
18 unsigned int mask_bits; /* only masked status bits are reported via kctl */
19};
20
21#ifdef CONFIG_SND_JACK_INPUT_DEV
22static int jack_switch_types[SND_JACK_SWITCH_TYPES] = {
23 SW_HEADPHONE_INSERT,
24 SW_MICROPHONE_INSERT,
25 SW_LINEOUT_INSERT,
26 SW_JACK_PHYSICAL_INSERT,
27 SW_VIDEOOUT_INSERT,
28 SW_LINEIN_INSERT,
29};
30#endif /* CONFIG_SND_JACK_INPUT_DEV */
31
32static int snd_jack_dev_disconnect(struct snd_device *device)
33{
34#ifdef CONFIG_SND_JACK_INPUT_DEV
35 struct snd_jack *jack = device->device_data;
36
37 if (!jack->input_dev)
38 return 0;
39
40 /* If the input device is registered with the input subsystem
41 * then we need to use a different deallocator. */
42 if (jack->registered)
43 input_unregister_device(jack->input_dev);
44 else
45 input_free_device(jack->input_dev);
46 jack->input_dev = NULL;
47#endif /* CONFIG_SND_JACK_INPUT_DEV */
48 return 0;
49}
50
51static int snd_jack_dev_free(struct snd_device *device)
52{
53 struct snd_jack *jack = device->device_data;
54 struct snd_card *card = device->card;
55 struct snd_jack_kctl *jack_kctl, *tmp_jack_kctl;
56
57 list_for_each_entry_safe(jack_kctl, tmp_jack_kctl, &jack->kctl_list, list) {
58 list_del_init(&jack_kctl->list);
59 snd_ctl_remove(card, jack_kctl->kctl);
60 }
61 if (jack->private_free)
62 jack->private_free(jack);
63
64 snd_jack_dev_disconnect(device);
65
66 kfree(jack->id);
67 kfree(jack);
68
69 return 0;
70}
71
72#ifdef CONFIG_SND_JACK_INPUT_DEV
73static int snd_jack_dev_register(struct snd_device *device)
74{
75 struct snd_jack *jack = device->device_data;
76 struct snd_card *card = device->card;
77 int err, i;
78
79 snprintf(jack->name, sizeof(jack->name), "%s %s",
80 card->shortname, jack->id);
81
82 if (!jack->input_dev)
83 return 0;
84
85 jack->input_dev->name = jack->name;
86
87 /* Default to the sound card device. */
88 if (!jack->input_dev->dev.parent)
89 jack->input_dev->dev.parent = snd_card_get_device_link(card);
90
91 /* Add capabilities for any keys that are enabled */
92 for (i = 0; i < ARRAY_SIZE(jack->key); i++) {
93 int testbit = SND_JACK_BTN_0 >> i;
94
95 if (!(jack->type & testbit))
96 continue;
97
98 if (!jack->key[i])
99 jack->key[i] = BTN_0 + i;
100
101 input_set_capability(jack->input_dev, EV_KEY, jack->key[i]);
102 }
103
104 err = input_register_device(jack->input_dev);
105 if (err == 0)
106 jack->registered = 1;
107
108 return err;
109}
110#endif /* CONFIG_SND_JACK_INPUT_DEV */
111
112static void snd_jack_kctl_private_free(struct snd_kcontrol *kctl)
113{
114 struct snd_jack_kctl *jack_kctl;
115
116 jack_kctl = kctl->private_data;
117 if (jack_kctl) {
118 list_del(&jack_kctl->list);
119 kfree(jack_kctl);
120 }
121}
122
123static void snd_jack_kctl_add(struct snd_jack *jack, struct snd_jack_kctl *jack_kctl)
124{
125 list_add_tail(&jack_kctl->list, &jack->kctl_list);
126}
127
128static struct snd_jack_kctl * snd_jack_kctl_new(struct snd_card *card, const char *name, unsigned int mask)
129{
130 struct snd_kcontrol *kctl;
131 struct snd_jack_kctl *jack_kctl;
132 int err;
133
134 kctl = snd_kctl_jack_new(name, card);
135 if (!kctl)
136 return NULL;
137
138 err = snd_ctl_add(card, kctl);
139 if (err < 0)
140 return NULL;
141
142 jack_kctl = kzalloc(sizeof(*jack_kctl), GFP_KERNEL);
143
144 if (!jack_kctl)
145 goto error;
146
147 jack_kctl->kctl = kctl;
148 jack_kctl->mask_bits = mask;
149
150 kctl->private_data = jack_kctl;
151 kctl->private_free = snd_jack_kctl_private_free;
152
153 return jack_kctl;
154error:
155 snd_ctl_free_one(kctl);
156 return NULL;
157}
158
159/**
160 * snd_jack_add_new_kctl - Create a new snd_jack_kctl and add it to jack
161 * @jack: the jack instance which the kctl will attaching to
162 * @name: the name for the snd_kcontrol object
163 * @mask: a bitmask of enum snd_jack_type values that can be detected
164 * by this snd_jack_kctl object.
165 *
166 * Creates a new snd_kcontrol object and adds it to the jack kctl_list.
167 *
168 * Return: Zero if successful, or a negative error code on failure.
169 */
170int snd_jack_add_new_kctl(struct snd_jack *jack, const char * name, int mask)
171{
172 struct snd_jack_kctl *jack_kctl;
173
174 jack_kctl = snd_jack_kctl_new(jack->card, name, mask);
175 if (!jack_kctl)
176 return -ENOMEM;
177
178 snd_jack_kctl_add(jack, jack_kctl);
179 return 0;
180}
181EXPORT_SYMBOL(snd_jack_add_new_kctl);
182
183/**
184 * snd_jack_new - Create a new jack
185 * @card: the card instance
186 * @id: an identifying string for this jack
187 * @type: a bitmask of enum snd_jack_type values that can be detected by
188 * this jack
189 * @jjack: Used to provide the allocated jack object to the caller.
190 * @initial_kctl: if true, create a kcontrol and add it to the jack list.
191 * @phantom_jack: Don't create a input device for phantom jacks.
192 *
193 * Creates a new jack object.
194 *
195 * Return: Zero if successful, or a negative error code on failure.
196 * On success @jjack will be initialised.
197 */
198int snd_jack_new(struct snd_card *card, const char *id, int type,
199 struct snd_jack **jjack, bool initial_kctl, bool phantom_jack)
200{
201 struct snd_jack *jack;
202 struct snd_jack_kctl *jack_kctl = NULL;
203 int err;
204 static struct snd_device_ops ops = {
205 .dev_free = snd_jack_dev_free,
206#ifdef CONFIG_SND_JACK_INPUT_DEV
207 .dev_register = snd_jack_dev_register,
208 .dev_disconnect = snd_jack_dev_disconnect,
209#endif /* CONFIG_SND_JACK_INPUT_DEV */
210 };
211
212 if (initial_kctl) {
213 jack_kctl = snd_jack_kctl_new(card, id, type);
214 if (!jack_kctl)
215 return -ENOMEM;
216 }
217
218 jack = kzalloc(sizeof(struct snd_jack), GFP_KERNEL);
219 if (jack == NULL)
220 return -ENOMEM;
221
222 jack->id = kstrdup(id, GFP_KERNEL);
223
224 /* don't creat input device for phantom jack */
225 if (!phantom_jack) {
226#ifdef CONFIG_SND_JACK_INPUT_DEV
227 int i;
228
229 jack->input_dev = input_allocate_device();
230 if (jack->input_dev == NULL) {
231 err = -ENOMEM;
232 goto fail_input;
233 }
234
235 jack->input_dev->phys = "ALSA";
236
237 jack->type = type;
238
239 for (i = 0; i < SND_JACK_SWITCH_TYPES; i++)
240 if (type & (1 << i))
241 input_set_capability(jack->input_dev, EV_SW,
242 jack_switch_types[i]);
243
244#endif /* CONFIG_SND_JACK_INPUT_DEV */
245 }
246
247 err = snd_device_new(card, SNDRV_DEV_JACK, jack, &ops);
248 if (err < 0)
249 goto fail_input;
250
251 jack->card = card;
252 INIT_LIST_HEAD(&jack->kctl_list);
253
254 if (initial_kctl)
255 snd_jack_kctl_add(jack, jack_kctl);
256
257 *jjack = jack;
258
259 return 0;
260
261fail_input:
262#ifdef CONFIG_SND_JACK_INPUT_DEV
263 input_free_device(jack->input_dev);
264#endif
265 kfree(jack->id);
266 kfree(jack);
267 return err;
268}
269EXPORT_SYMBOL(snd_jack_new);
270
271#ifdef CONFIG_SND_JACK_INPUT_DEV
272/**
273 * snd_jack_set_parent - Set the parent device for a jack
274 *
275 * @jack: The jack to configure
276 * @parent: The device to set as parent for the jack.
277 *
278 * Set the parent for the jack devices in the device tree. This
279 * function is only valid prior to registration of the jack. If no
280 * parent is configured then the parent device will be the sound card.
281 */
282void snd_jack_set_parent(struct snd_jack *jack, struct device *parent)
283{
284 WARN_ON(jack->registered);
285 if (!jack->input_dev)
286 return;
287
288 jack->input_dev->dev.parent = parent;
289}
290EXPORT_SYMBOL(snd_jack_set_parent);
291
292/**
293 * snd_jack_set_key - Set a key mapping on a jack
294 *
295 * @jack: The jack to configure
296 * @type: Jack report type for this key
297 * @keytype: Input layer key type to be reported
298 *
299 * Map a SND_JACK_BTN_* button type to an input layer key, allowing
300 * reporting of keys on accessories via the jack abstraction. If no
301 * mapping is provided but keys are enabled in the jack type then
302 * BTN_n numeric buttons will be reported.
303 *
304 * If jacks are not reporting via the input API this call will have no
305 * effect.
306 *
307 * Note that this is intended to be use by simple devices with small
308 * numbers of keys that can be reported. It is also possible to
309 * access the input device directly - devices with complex input
310 * capabilities on accessories should consider doing this rather than
311 * using this abstraction.
312 *
313 * This function may only be called prior to registration of the jack.
314 *
315 * Return: Zero if successful, or a negative error code on failure.
316 */
317int snd_jack_set_key(struct snd_jack *jack, enum snd_jack_types type,
318 int keytype)
319{
320 int key = fls(SND_JACK_BTN_0) - fls(type);
321
322 WARN_ON(jack->registered);
323
324 if (!keytype || key >= ARRAY_SIZE(jack->key))
325 return -EINVAL;
326
327 jack->type |= type;
328 jack->key[key] = keytype;
329 return 0;
330}
331EXPORT_SYMBOL(snd_jack_set_key);
332#endif /* CONFIG_SND_JACK_INPUT_DEV */
333
334/**
335 * snd_jack_report - Report the current status of a jack
336 *
337 * @jack: The jack to report status for
338 * @status: The current status of the jack
339 */
340void snd_jack_report(struct snd_jack *jack, int status)
341{
342 struct snd_jack_kctl *jack_kctl;
343#ifdef CONFIG_SND_JACK_INPUT_DEV
344 int i;
345#endif
346
347 if (!jack)
348 return;
349
350 list_for_each_entry(jack_kctl, &jack->kctl_list, list)
351 snd_kctl_jack_report(jack->card, jack_kctl->kctl,
352 status & jack_kctl->mask_bits);
353
354#ifdef CONFIG_SND_JACK_INPUT_DEV
355 if (!jack->input_dev)
356 return;
357
358 for (i = 0; i < ARRAY_SIZE(jack->key); i++) {
359 int testbit = SND_JACK_BTN_0 >> i;
360
361 if (jack->type & testbit)
362 input_report_key(jack->input_dev, jack->key[i],
363 status & testbit);
364 }
365
366 for (i = 0; i < ARRAY_SIZE(jack_switch_types); i++) {
367 int testbit = 1 << i;
368 if (jack->type & testbit)
369 input_report_switch(jack->input_dev,
370 jack_switch_types[i],
371 status & testbit);
372 }
373
374 input_sync(jack->input_dev);
375#endif /* CONFIG_SND_JACK_INPUT_DEV */
376}
377EXPORT_SYMBOL(snd_jack_report);
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Jack abstraction layer
4 *
5 * Copyright 2008 Wolfson Microelectronics
6 */
7
8#include <linux/input.h>
9#include <linux/slab.h>
10#include <linux/module.h>
11#include <linux/ctype.h>
12#include <linux/mm.h>
13#include <linux/debugfs.h>
14#include <sound/jack.h>
15#include <sound/core.h>
16#include <sound/control.h>
17
18struct 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 */
26#endif
27};
28
29#ifdef CONFIG_SND_JACK_INPUT_DEV
30static const int jack_switch_types[SND_JACK_SWITCH_TYPES] = {
31 SW_HEADPHONE_INSERT,
32 SW_MICROPHONE_INSERT,
33 SW_LINEOUT_INSERT,
34 SW_JACK_PHYSICAL_INSERT,
35 SW_VIDEOOUT_INSERT,
36 SW_LINEIN_INSERT,
37};
38#endif /* CONFIG_SND_JACK_INPUT_DEV */
39
40static int snd_jack_dev_disconnect(struct snd_device *device)
41{
42#ifdef CONFIG_SND_JACK_INPUT_DEV
43 struct snd_jack *jack = device->device_data;
44
45 mutex_lock(&jack->input_dev_lock);
46 if (!jack->input_dev) {
47 mutex_unlock(&jack->input_dev_lock);
48 return 0;
49 }
50
51 /* If the input device is registered with the input subsystem
52 * then we need to use a different deallocator. */
53 if (jack->registered)
54 input_unregister_device(jack->input_dev);
55 else
56 input_free_device(jack->input_dev);
57 jack->input_dev = NULL;
58 mutex_unlock(&jack->input_dev_lock);
59#endif /* CONFIG_SND_JACK_INPUT_DEV */
60 return 0;
61}
62
63static int snd_jack_dev_free(struct snd_device *device)
64{
65 struct snd_jack *jack = device->device_data;
66 struct snd_card *card = device->card;
67 struct snd_jack_kctl *jack_kctl, *tmp_jack_kctl;
68
69 list_for_each_entry_safe(jack_kctl, tmp_jack_kctl, &jack->kctl_list, list) {
70 list_del_init(&jack_kctl->list);
71 snd_ctl_remove(card, jack_kctl->kctl);
72 }
73
74 if (jack->private_free)
75 jack->private_free(jack);
76
77 snd_jack_dev_disconnect(device);
78
79 kfree(jack->id);
80 kfree(jack);
81
82 return 0;
83}
84
85#ifdef CONFIG_SND_JACK_INPUT_DEV
86static int snd_jack_dev_register(struct snd_device *device)
87{
88 struct snd_jack *jack = device->device_data;
89 struct snd_card *card = device->card;
90 int err, i;
91
92 snprintf(jack->name, sizeof(jack->name), "%s %s",
93 card->shortname, jack->id);
94
95 mutex_lock(&jack->input_dev_lock);
96 if (!jack->input_dev) {
97 mutex_unlock(&jack->input_dev_lock);
98 return 0;
99 }
100
101 jack->input_dev->name = jack->name;
102
103 /* Default to the sound card device. */
104 if (!jack->input_dev->dev.parent)
105 jack->input_dev->dev.parent = snd_card_get_device_link(card);
106
107 /* Add capabilities for any keys that are enabled */
108 for (i = 0; i < ARRAY_SIZE(jack->key); i++) {
109 int testbit = SND_JACK_BTN_0 >> i;
110
111 if (!(jack->type & testbit))
112 continue;
113
114 if (!jack->key[i])
115 jack->key[i] = BTN_0 + i;
116
117 input_set_capability(jack->input_dev, EV_KEY, jack->key[i]);
118 }
119
120 err = input_register_device(jack->input_dev);
121 if (err == 0)
122 jack->registered = 1;
123
124 mutex_unlock(&jack->input_dev_lock);
125 return err;
126}
127#endif /* CONFIG_SND_JACK_INPUT_DEV */
128
129#ifdef CONFIG_SND_JACK_INJECTION_DEBUG
130static void snd_jack_inject_report(struct snd_jack_kctl *jack_kctl, int status)
131{
132 struct snd_jack *jack;
133#ifdef CONFIG_SND_JACK_INPUT_DEV
134 int i;
135#endif
136 if (!jack_kctl)
137 return;
138
139 jack = jack_kctl->jack;
140
141 if (jack_kctl->sw_inject_enable)
142 snd_kctl_jack_report(jack->card, jack_kctl->kctl,
143 status & jack_kctl->mask_bits);
144
145#ifdef CONFIG_SND_JACK_INPUT_DEV
146 if (!jack->input_dev)
147 return;
148
149 for (i = 0; i < ARRAY_SIZE(jack->key); i++) {
150 int testbit = ((SND_JACK_BTN_0 >> i) & jack_kctl->mask_bits);
151
152 if (jack->type & testbit)
153 input_report_key(jack->input_dev, jack->key[i],
154 status & testbit);
155 }
156
157 for (i = 0; i < ARRAY_SIZE(jack_switch_types); i++) {
158 int testbit = ((1 << i) & jack_kctl->mask_bits);
159
160 if (jack->type & testbit)
161 input_report_switch(jack->input_dev,
162 jack_switch_types[i],
163 status & testbit);
164 }
165
166 input_sync(jack->input_dev);
167#endif /* CONFIG_SND_JACK_INPUT_DEV */
168}
169
170static ssize_t sw_inject_enable_read(struct file *file,
171 char __user *to, size_t count, loff_t *ppos)
172{
173 struct snd_jack_kctl *jack_kctl = file->private_data;
174 int len, ret;
175 char buf[128];
176
177 len = scnprintf(buf, sizeof(buf), "%s: %s\t\t%s: %i\n", "Jack", jack_kctl->kctl->id.name,
178 "Inject Enabled", jack_kctl->sw_inject_enable);
179 ret = simple_read_from_buffer(to, count, ppos, buf, len);
180
181 return ret;
182}
183
184static ssize_t sw_inject_enable_write(struct file *file,
185 const char __user *from, size_t count, loff_t *ppos)
186{
187 struct snd_jack_kctl *jack_kctl = file->private_data;
188 int ret, err;
189 unsigned long enable;
190 char buf[8] = { 0 };
191
192 ret = simple_write_to_buffer(buf, sizeof(buf) - 1, ppos, from, count);
193 err = kstrtoul(buf, 0, &enable);
194 if (err)
195 return err;
196
197 if (jack_kctl->sw_inject_enable == (!!enable))
198 return ret;
199
200 jack_kctl->sw_inject_enable = !!enable;
201
202 if (!jack_kctl->sw_inject_enable)
203 snd_jack_report(jack_kctl->jack, jack_kctl->jack->hw_status_cache);
204
205 return ret;
206}
207
208static ssize_t jackin_inject_write(struct file *file,
209 const char __user *from, size_t count, loff_t *ppos)
210{
211 struct snd_jack_kctl *jack_kctl = file->private_data;
212 int ret, err;
213 unsigned long enable;
214 char buf[8] = { 0 };
215
216 if (!jack_kctl->sw_inject_enable)
217 return -EINVAL;
218
219 ret = simple_write_to_buffer(buf, sizeof(buf) - 1, ppos, from, count);
220 err = kstrtoul(buf, 0, &enable);
221 if (err)
222 return err;
223
224 snd_jack_inject_report(jack_kctl, !!enable ? jack_kctl->mask_bits : 0);
225
226 return ret;
227}
228
229static ssize_t jack_kctl_id_read(struct file *file,
230 char __user *to, size_t count, loff_t *ppos)
231{
232 struct snd_jack_kctl *jack_kctl = file->private_data;
233 char buf[64];
234 int len, ret;
235
236 len = scnprintf(buf, sizeof(buf), "%s\n", jack_kctl->kctl->id.name);
237 ret = simple_read_from_buffer(to, count, ppos, buf, len);
238
239 return ret;
240}
241
242/* the bit definition is aligned with snd_jack_types in jack.h */
243static const char * const jack_events_name[] = {
244 "HEADPHONE(0x0001)", "MICROPHONE(0x0002)", "LINEOUT(0x0004)",
245 "MECHANICAL(0x0008)", "VIDEOOUT(0x0010)", "LINEIN(0x0020)",
246 "", "", "", "BTN_5(0x0200)", "BTN_4(0x0400)", "BTN_3(0x0800)",
247 "BTN_2(0x1000)", "BTN_1(0x2000)", "BTN_0(0x4000)", "",
248};
249
250/* the recommended buffer size is 256 */
251static int parse_mask_bits(unsigned int mask_bits, char *buf, size_t buf_size)
252{
253 int i;
254
255 scnprintf(buf, buf_size, "0x%04x", mask_bits);
256
257 for (i = 0; i < ARRAY_SIZE(jack_events_name); i++)
258 if (mask_bits & (1 << i)) {
259 strlcat(buf, " ", buf_size);
260 strlcat(buf, jack_events_name[i], buf_size);
261 }
262 strlcat(buf, "\n", buf_size);
263
264 return strlen(buf);
265}
266
267static ssize_t jack_kctl_mask_bits_read(struct file *file,
268 char __user *to, size_t count, loff_t *ppos)
269{
270 struct snd_jack_kctl *jack_kctl = file->private_data;
271 char buf[256];
272 int len, ret;
273
274 len = parse_mask_bits(jack_kctl->mask_bits, buf, sizeof(buf));
275 ret = simple_read_from_buffer(to, count, ppos, buf, len);
276
277 return ret;
278}
279
280static ssize_t jack_kctl_status_read(struct file *file,
281 char __user *to, size_t count, loff_t *ppos)
282{
283 struct snd_jack_kctl *jack_kctl = file->private_data;
284 char buf[16];
285 int len, ret;
286
287 len = scnprintf(buf, sizeof(buf), "%s\n", jack_kctl->kctl->private_value ?
288 "Plugged" : "Unplugged");
289 ret = simple_read_from_buffer(to, count, ppos, buf, len);
290
291 return ret;
292}
293
294#ifdef CONFIG_SND_JACK_INPUT_DEV
295static ssize_t jack_type_read(struct file *file,
296 char __user *to, size_t count, loff_t *ppos)
297{
298 struct snd_jack_kctl *jack_kctl = file->private_data;
299 char buf[256];
300 int len, ret;
301
302 len = parse_mask_bits(jack_kctl->jack->type, buf, sizeof(buf));
303 ret = simple_read_from_buffer(to, count, ppos, buf, len);
304
305 return ret;
306}
307
308static const struct file_operations jack_type_fops = {
309 .open = simple_open,
310 .read = jack_type_read,
311 .llseek = default_llseek,
312};
313#endif
314
315static const struct file_operations sw_inject_enable_fops = {
316 .open = simple_open,
317 .read = sw_inject_enable_read,
318 .write = sw_inject_enable_write,
319 .llseek = default_llseek,
320};
321
322static const struct file_operations jackin_inject_fops = {
323 .open = simple_open,
324 .write = jackin_inject_write,
325 .llseek = default_llseek,
326};
327
328static const struct file_operations jack_kctl_id_fops = {
329 .open = simple_open,
330 .read = jack_kctl_id_read,
331 .llseek = default_llseek,
332};
333
334static const struct file_operations jack_kctl_mask_bits_fops = {
335 .open = simple_open,
336 .read = jack_kctl_mask_bits_read,
337 .llseek = default_llseek,
338};
339
340static const struct file_operations jack_kctl_status_fops = {
341 .open = simple_open,
342 .read = jack_kctl_status_read,
343 .llseek = default_llseek,
344};
345
346static int snd_jack_debugfs_add_inject_node(struct snd_jack *jack,
347 struct snd_jack_kctl *jack_kctl)
348{
349 char *tname;
350 int i;
351
352 /* Don't create injection interface for Phantom jacks */
353 if (strstr(jack_kctl->kctl->id.name, "Phantom"))
354 return 0;
355
356 tname = kstrdup(jack_kctl->kctl->id.name, GFP_KERNEL);
357 if (!tname)
358 return -ENOMEM;
359
360 /* replace the chars which are not suitable for folder's name with _ */
361 for (i = 0; tname[i]; i++)
362 if (!isalnum(tname[i]))
363 tname[i] = '_';
364
365 jack_kctl->jack_debugfs_root = debugfs_create_dir(tname, jack->card->debugfs_root);
366 kfree(tname);
367
368 debugfs_create_file("sw_inject_enable", 0644, jack_kctl->jack_debugfs_root, jack_kctl,
369 &sw_inject_enable_fops);
370
371 debugfs_create_file("jackin_inject", 0200, jack_kctl->jack_debugfs_root, jack_kctl,
372 &jackin_inject_fops);
373
374 debugfs_create_file("kctl_id", 0444, jack_kctl->jack_debugfs_root, jack_kctl,
375 &jack_kctl_id_fops);
376
377 debugfs_create_file("mask_bits", 0444, jack_kctl->jack_debugfs_root, jack_kctl,
378 &jack_kctl_mask_bits_fops);
379
380 debugfs_create_file("status", 0444, jack_kctl->jack_debugfs_root, jack_kctl,
381 &jack_kctl_status_fops);
382
383#ifdef CONFIG_SND_JACK_INPUT_DEV
384 debugfs_create_file("type", 0444, jack_kctl->jack_debugfs_root, jack_kctl,
385 &jack_type_fops);
386#endif
387 return 0;
388}
389
390static void snd_jack_debugfs_clear_inject_node(struct snd_jack_kctl *jack_kctl)
391{
392 debugfs_remove(jack_kctl->jack_debugfs_root);
393 jack_kctl->jack_debugfs_root = NULL;
394}
395#else /* CONFIG_SND_JACK_INJECTION_DEBUG */
396static int snd_jack_debugfs_add_inject_node(struct snd_jack *jack,
397 struct snd_jack_kctl *jack_kctl)
398{
399 return 0;
400}
401
402static void snd_jack_debugfs_clear_inject_node(struct snd_jack_kctl *jack_kctl)
403{
404}
405#endif /* CONFIG_SND_JACK_INJECTION_DEBUG */
406
407static void snd_jack_kctl_private_free(struct snd_kcontrol *kctl)
408{
409 struct snd_jack_kctl *jack_kctl;
410
411 jack_kctl = kctl->private_data;
412 if (jack_kctl) {
413 snd_jack_debugfs_clear_inject_node(jack_kctl);
414 list_del(&jack_kctl->list);
415 kfree(jack_kctl);
416 }
417}
418
419static void snd_jack_kctl_add(struct snd_jack *jack, struct snd_jack_kctl *jack_kctl)
420{
421 jack_kctl->jack = jack;
422 list_add_tail(&jack_kctl->list, &jack->kctl_list);
423 snd_jack_debugfs_add_inject_node(jack, jack_kctl);
424}
425
426static struct snd_jack_kctl * snd_jack_kctl_new(struct snd_card *card, const char *name, unsigned int mask)
427{
428 struct snd_kcontrol *kctl;
429 struct snd_jack_kctl *jack_kctl;
430 int err;
431
432 kctl = snd_kctl_jack_new(name, card);
433 if (!kctl)
434 return NULL;
435
436 err = snd_ctl_add(card, kctl);
437 if (err < 0)
438 return NULL;
439
440 jack_kctl = kzalloc(sizeof(*jack_kctl), GFP_KERNEL);
441
442 if (!jack_kctl)
443 goto error;
444
445 jack_kctl->kctl = kctl;
446 jack_kctl->mask_bits = mask;
447
448 kctl->private_data = jack_kctl;
449 kctl->private_free = snd_jack_kctl_private_free;
450
451 return jack_kctl;
452error:
453 snd_ctl_free_one(kctl);
454 return NULL;
455}
456
457/**
458 * snd_jack_add_new_kctl - Create a new snd_jack_kctl and add it to jack
459 * @jack: the jack instance which the kctl will attaching to
460 * @name: the name for the snd_kcontrol object
461 * @mask: a bitmask of enum snd_jack_type values that can be detected
462 * by this snd_jack_kctl object.
463 *
464 * Creates a new snd_kcontrol object and adds it to the jack kctl_list.
465 *
466 * Return: Zero if successful, or a negative error code on failure.
467 */
468int snd_jack_add_new_kctl(struct snd_jack *jack, const char * name, int mask)
469{
470 struct snd_jack_kctl *jack_kctl;
471
472 jack_kctl = snd_jack_kctl_new(jack->card, name, mask);
473 if (!jack_kctl)
474 return -ENOMEM;
475
476 snd_jack_kctl_add(jack, jack_kctl);
477 return 0;
478}
479EXPORT_SYMBOL(snd_jack_add_new_kctl);
480
481/**
482 * snd_jack_new - Create a new jack
483 * @card: the card instance
484 * @id: an identifying string for this jack
485 * @type: a bitmask of enum snd_jack_type values that can be detected by
486 * this jack
487 * @jjack: Used to provide the allocated jack object to the caller.
488 * @initial_kctl: if true, create a kcontrol and add it to the jack list.
489 * @phantom_jack: Don't create a input device for phantom jacks.
490 *
491 * Creates a new jack object.
492 *
493 * Return: Zero if successful, or a negative error code on failure.
494 * On success @jjack will be initialised.
495 */
496int snd_jack_new(struct snd_card *card, const char *id, int type,
497 struct snd_jack **jjack, bool initial_kctl, bool phantom_jack)
498{
499 struct snd_jack *jack;
500 struct snd_jack_kctl *jack_kctl = NULL;
501 int err;
502 static const struct snd_device_ops ops = {
503 .dev_free = snd_jack_dev_free,
504#ifdef CONFIG_SND_JACK_INPUT_DEV
505 .dev_register = snd_jack_dev_register,
506 .dev_disconnect = snd_jack_dev_disconnect,
507#endif /* CONFIG_SND_JACK_INPUT_DEV */
508 };
509
510 if (initial_kctl) {
511 jack_kctl = snd_jack_kctl_new(card, id, type);
512 if (!jack_kctl)
513 return -ENOMEM;
514 }
515
516 jack = kzalloc(sizeof(struct snd_jack), GFP_KERNEL);
517 if (jack == NULL)
518 return -ENOMEM;
519
520 jack->id = kstrdup(id, GFP_KERNEL);
521 if (jack->id == NULL) {
522 kfree(jack);
523 return -ENOMEM;
524 }
525
526#ifdef CONFIG_SND_JACK_INPUT_DEV
527 mutex_init(&jack->input_dev_lock);
528
529 /* don't create input device for phantom jack */
530 if (!phantom_jack) {
531 int i;
532
533 jack->input_dev = input_allocate_device();
534 if (jack->input_dev == NULL) {
535 err = -ENOMEM;
536 goto fail_input;
537 }
538
539 jack->input_dev->phys = "ALSA";
540
541 jack->type = type;
542
543 for (i = 0; i < SND_JACK_SWITCH_TYPES; i++)
544 if (type & (1 << i))
545 input_set_capability(jack->input_dev, EV_SW,
546 jack_switch_types[i]);
547
548 }
549#endif /* CONFIG_SND_JACK_INPUT_DEV */
550
551 err = snd_device_new(card, SNDRV_DEV_JACK, jack, &ops);
552 if (err < 0)
553 goto fail_input;
554
555 jack->card = card;
556 INIT_LIST_HEAD(&jack->kctl_list);
557
558 if (initial_kctl)
559 snd_jack_kctl_add(jack, jack_kctl);
560
561 *jjack = jack;
562
563 return 0;
564
565fail_input:
566#ifdef CONFIG_SND_JACK_INPUT_DEV
567 input_free_device(jack->input_dev);
568#endif
569 kfree(jack->id);
570 kfree(jack);
571 return err;
572}
573EXPORT_SYMBOL(snd_jack_new);
574
575#ifdef CONFIG_SND_JACK_INPUT_DEV
576/**
577 * snd_jack_set_parent - Set the parent device for a jack
578 *
579 * @jack: The jack to configure
580 * @parent: The device to set as parent for the jack.
581 *
582 * Set the parent for the jack devices in the device tree. This
583 * function is only valid prior to registration of the jack. If no
584 * parent is configured then the parent device will be the sound card.
585 */
586void snd_jack_set_parent(struct snd_jack *jack, struct device *parent)
587{
588 WARN_ON(jack->registered);
589 mutex_lock(&jack->input_dev_lock);
590 if (!jack->input_dev) {
591 mutex_unlock(&jack->input_dev_lock);
592 return;
593 }
594
595 jack->input_dev->dev.parent = parent;
596 mutex_unlock(&jack->input_dev_lock);
597}
598EXPORT_SYMBOL(snd_jack_set_parent);
599
600/**
601 * snd_jack_set_key - Set a key mapping on a jack
602 *
603 * @jack: The jack to configure
604 * @type: Jack report type for this key
605 * @keytype: Input layer key type to be reported
606 *
607 * Map a SND_JACK_BTN_* button type to an input layer key, allowing
608 * reporting of keys on accessories via the jack abstraction. If no
609 * mapping is provided but keys are enabled in the jack type then
610 * BTN_n numeric buttons will be reported.
611 *
612 * If jacks are not reporting via the input API this call will have no
613 * effect.
614 *
615 * Note that this is intended to be use by simple devices with small
616 * numbers of keys that can be reported. It is also possible to
617 * access the input device directly - devices with complex input
618 * capabilities on accessories should consider doing this rather than
619 * using this abstraction.
620 *
621 * This function may only be called prior to registration of the jack.
622 *
623 * Return: Zero if successful, or a negative error code on failure.
624 */
625int snd_jack_set_key(struct snd_jack *jack, enum snd_jack_types type,
626 int keytype)
627{
628 int key = fls(SND_JACK_BTN_0) - fls(type);
629
630 WARN_ON(jack->registered);
631
632 if (!keytype || key >= ARRAY_SIZE(jack->key))
633 return -EINVAL;
634
635 jack->type |= type;
636 jack->key[key] = keytype;
637 return 0;
638}
639EXPORT_SYMBOL(snd_jack_set_key);
640#endif /* CONFIG_SND_JACK_INPUT_DEV */
641
642/**
643 * snd_jack_report - Report the current status of a jack
644 * Note: This function uses mutexes and should be called from a
645 * context which can sleep (such as a workqueue).
646 *
647 * @jack: The jack to report status for
648 * @status: The current status of the jack
649 */
650void snd_jack_report(struct snd_jack *jack, int status)
651{
652 struct snd_jack_kctl *jack_kctl;
653 unsigned int mask_bits = 0;
654#ifdef CONFIG_SND_JACK_INPUT_DEV
655 struct input_dev *idev;
656 int i;
657#endif
658
659 if (!jack)
660 return;
661
662 jack->hw_status_cache = status;
663
664 list_for_each_entry(jack_kctl, &jack->kctl_list, list)
665 if (jack_kctl->sw_inject_enable)
666 mask_bits |= jack_kctl->mask_bits;
667 else
668 snd_kctl_jack_report(jack->card, jack_kctl->kctl,
669 status & jack_kctl->mask_bits);
670
671#ifdef CONFIG_SND_JACK_INPUT_DEV
672 idev = input_get_device(jack->input_dev);
673 if (!idev)
674 return;
675
676 for (i = 0; i < ARRAY_SIZE(jack->key); i++) {
677 int testbit = ((SND_JACK_BTN_0 >> i) & ~mask_bits);
678
679 if (jack->type & testbit)
680 input_report_key(idev, jack->key[i],
681 status & testbit);
682 }
683
684 for (i = 0; i < ARRAY_SIZE(jack_switch_types); i++) {
685 int testbit = ((1 << i) & ~mask_bits);
686
687 if (jack->type & testbit)
688 input_report_switch(idev,
689 jack_switch_types[i],
690 status & testbit);
691 }
692
693 input_sync(idev);
694 input_put_device(idev);
695#endif /* CONFIG_SND_JACK_INPUT_DEV */
696}
697EXPORT_SYMBOL(snd_jack_report);