2 * Jack abstraction layer
4 * Copyright 2008 Wolfson Microelectronics
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.
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.
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
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>
29 struct 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 */
35 static int jack_switch_types
[SND_JACK_SWITCH_TYPES
] = {
39 SW_JACK_PHYSICAL_INSERT
,
44 static int snd_jack_dev_disconnect(struct snd_device
*device
)
46 struct snd_jack
*jack
= device
->device_data
;
51 /* If the input device is registered with the input subsystem
52 * then we need to use a different deallocator. */
54 input_unregister_device(jack
->input_dev
);
56 input_free_device(jack
->input_dev
);
57 jack
->input_dev
= NULL
;
61 static int snd_jack_dev_free(struct snd_device
*device
)
63 struct snd_jack
*jack
= device
->device_data
;
64 struct snd_card
*card
= device
->card
;
65 struct snd_jack_kctl
*jack_kctl
, *tmp_jack_kctl
;
67 list_for_each_entry_safe(jack_kctl
, tmp_jack_kctl
, &jack
->kctl_list
, list
) {
68 list_del_init(&jack_kctl
->list
);
69 snd_ctl_remove(card
, jack_kctl
->kctl
);
71 if (jack
->private_free
)
72 jack
->private_free(jack
);
74 snd_jack_dev_disconnect(device
);
82 static int snd_jack_dev_register(struct snd_device
*device
)
84 struct snd_jack
*jack
= device
->device_data
;
85 struct snd_card
*card
= device
->card
;
88 snprintf(jack
->name
, sizeof(jack
->name
), "%s %s",
89 card
->shortname
, jack
->id
);
90 jack
->input_dev
->name
= jack
->name
;
92 /* Default to the sound card device. */
93 if (!jack
->input_dev
->dev
.parent
)
94 jack
->input_dev
->dev
.parent
= snd_card_get_device_link(card
);
96 /* Add capabilities for any keys that are enabled */
97 for (i
= 0; i
< ARRAY_SIZE(jack
->key
); i
++) {
98 int testbit
= SND_JACK_BTN_0
>> i
;
100 if (!(jack
->type
& testbit
))
104 jack
->key
[i
] = BTN_0
+ i
;
106 input_set_capability(jack
->input_dev
, EV_KEY
, jack
->key
[i
]);
109 err
= input_register_device(jack
->input_dev
);
111 jack
->registered
= 1;
116 static void snd_jack_kctl_private_free(struct snd_kcontrol
*kctl
)
118 struct snd_jack_kctl
*jack_kctl
;
120 jack_kctl
= kctl
->private_data
;
122 list_del(&jack_kctl
->list
);
127 static void snd_jack_kctl_add(struct snd_jack
*jack
, struct snd_jack_kctl
*jack_kctl
)
129 list_add_tail(&jack_kctl
->list
, &jack
->kctl_list
);
132 static struct snd_jack_kctl
* snd_jack_kctl_new(struct snd_card
*card
, const char *name
, unsigned int mask
)
134 struct snd_kcontrol
*kctl
;
135 struct snd_jack_kctl
*jack_kctl
;
138 kctl
= snd_kctl_jack_new(name
, card
);
142 err
= snd_ctl_add(card
, kctl
);
146 jack_kctl
= kzalloc(sizeof(*jack_kctl
), GFP_KERNEL
);
151 jack_kctl
->kctl
= kctl
;
152 jack_kctl
->mask_bits
= mask
;
154 kctl
->private_data
= jack_kctl
;
155 kctl
->private_free
= snd_jack_kctl_private_free
;
159 snd_ctl_free_one(kctl
);
164 * snd_jack_add_new_kctl - Create a new snd_jack_kctl and add it to jack
165 * @jack: the jack instance which the kctl will attaching to
166 * @name: the name for the snd_kcontrol object
167 * @mask: a bitmask of enum snd_jack_type values that can be detected
168 * by this snd_jack_kctl object.
170 * Creates a new snd_kcontrol object and adds it to the jack kctl_list.
172 * Return: Zero if successful, or a negative error code on failure.
174 int snd_jack_add_new_kctl(struct snd_jack
*jack
, const char * name
, int mask
)
176 struct snd_jack_kctl
*jack_kctl
;
178 jack_kctl
= snd_jack_kctl_new(jack
->card
, name
, mask
);
182 snd_jack_kctl_add(jack
, jack_kctl
);
185 EXPORT_SYMBOL(snd_jack_add_new_kctl
);
188 * snd_jack_new - Create a new jack
189 * @card: the card instance
190 * @id: an identifying string for this jack
191 * @type: a bitmask of enum snd_jack_type values that can be detected by
193 * @jjack: Used to provide the allocated jack object to the caller.
194 * @initial_kctl: if true, create a kcontrol and add it to the jack list.
195 * @phantom_jack: Don't create a input device for phantom jacks.
197 * Creates a new jack object.
199 * Return: Zero if successful, or a negative error code on failure.
200 * On success @jjack will be initialised.
202 int snd_jack_new(struct snd_card
*card
, const char *id
, int type
,
203 struct snd_jack
**jjack
, bool initial_kctl
, bool phantom_jack
)
205 struct snd_jack
*jack
;
206 struct snd_jack_kctl
*jack_kctl
= NULL
;
209 static struct snd_device_ops ops
= {
210 .dev_free
= snd_jack_dev_free
,
211 .dev_register
= snd_jack_dev_register
,
212 .dev_disconnect
= snd_jack_dev_disconnect
,
216 jack_kctl
= snd_jack_kctl_new(card
, id
, type
);
221 jack
= kzalloc(sizeof(struct snd_jack
), GFP_KERNEL
);
225 jack
->id
= kstrdup(id
, GFP_KERNEL
);
227 /* don't creat input device for phantom jack */
229 jack
->input_dev
= input_allocate_device();
230 if (jack
->input_dev
== NULL
) {
235 jack
->input_dev
->phys
= "ALSA";
239 for (i
= 0; i
< SND_JACK_SWITCH_TYPES
; i
++)
241 input_set_capability(jack
->input_dev
, EV_SW
,
242 jack_switch_types
[i
]);
246 err
= snd_device_new(card
, SNDRV_DEV_JACK
, jack
, &ops
);
251 INIT_LIST_HEAD(&jack
->kctl_list
);
254 snd_jack_kctl_add(jack
, jack_kctl
);
261 input_free_device(jack
->input_dev
);
266 EXPORT_SYMBOL(snd_jack_new
);
269 * snd_jack_set_parent - Set the parent device for a jack
271 * @jack: The jack to configure
272 * @parent: The device to set as parent for the jack.
274 * Set the parent for the jack devices in the device tree. This
275 * function is only valid prior to registration of the jack. If no
276 * parent is configured then the parent device will be the sound card.
278 void snd_jack_set_parent(struct snd_jack
*jack
, struct device
*parent
)
280 WARN_ON(jack
->registered
);
282 jack
->input_dev
->dev
.parent
= parent
;
284 EXPORT_SYMBOL(snd_jack_set_parent
);
287 * snd_jack_set_key - Set a key mapping on a jack
289 * @jack: The jack to configure
290 * @type: Jack report type for this key
291 * @keytype: Input layer key type to be reported
293 * Map a SND_JACK_BTN_ button type to an input layer key, allowing
294 * reporting of keys on accessories via the jack abstraction. If no
295 * mapping is provided but keys are enabled in the jack type then
296 * BTN_n numeric buttons will be reported.
298 * If jacks are not reporting via the input API this call will have no
301 * Note that this is intended to be use by simple devices with small
302 * numbers of keys that can be reported. It is also possible to
303 * access the input device directly - devices with complex input
304 * capabilities on accessories should consider doing this rather than
305 * using this abstraction.
307 * This function may only be called prior to registration of the jack.
309 * Return: Zero if successful, or a negative error code on failure.
311 int snd_jack_set_key(struct snd_jack
*jack
, enum snd_jack_types type
,
314 int key
= fls(SND_JACK_BTN_0
) - fls(type
);
316 WARN_ON(jack
->registered
);
318 if (!keytype
|| key
>= ARRAY_SIZE(jack
->key
))
322 jack
->key
[key
] = keytype
;
326 EXPORT_SYMBOL(snd_jack_set_key
);
329 * snd_jack_report - Report the current status of a jack
331 * @jack: The jack to report status for
332 * @status: The current status of the jack
334 void snd_jack_report(struct snd_jack
*jack
, int status
)
336 struct snd_jack_kctl
*jack_kctl
;
342 for (i
= 0; i
< ARRAY_SIZE(jack
->key
); i
++) {
343 int testbit
= SND_JACK_BTN_0
>> i
;
345 if (jack
->type
& testbit
)
346 input_report_key(jack
->input_dev
, jack
->key
[i
],
350 for (i
= 0; i
< ARRAY_SIZE(jack_switch_types
); i
++) {
351 int testbit
= 1 << i
;
352 if (jack
->type
& testbit
)
353 input_report_switch(jack
->input_dev
,
354 jack_switch_types
[i
],
358 input_sync(jack
->input_dev
);
360 list_for_each_entry(jack_kctl
, &jack
->kctl_list
, list
)
361 snd_kctl_jack_report(jack
->card
, jack_kctl
->kctl
,
362 status
& jack_kctl
->mask_bits
);
365 EXPORT_SYMBOL(snd_jack_report
);
367 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
368 MODULE_DESCRIPTION("Jack detection support for ALSA");
369 MODULE_LICENSE("GPL");