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