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 <sound/jack.h>
25 #include <sound/core.h>
27 static int jack_switch_types[] = {
31 SW_JACK_PHYSICAL_INSERT,
36 static int snd_jack_dev_free(struct snd_device *device)
38 struct snd_jack *jack = device->device_data;
40 if (jack->private_free)
41 jack->private_free(jack);
43 /* If the input device is registered with the input subsystem
44 * then we need to use a different deallocator. */
46 input_unregister_device(jack->input_dev);
48 input_free_device(jack->input_dev);
56 static int snd_jack_dev_register(struct snd_device *device)
58 struct snd_jack *jack = device->device_data;
59 struct snd_card *card = device->card;
62 snprintf(jack->name, sizeof(jack->name), "%s %s",
63 card->shortname, jack->id);
64 jack->input_dev->name = jack->name;
66 /* Default to the sound card device. */
67 if (!jack->input_dev->dev.parent)
68 jack->input_dev->dev.parent = snd_card_get_device_link(card);
70 /* Add capabilities for any keys that are enabled */
71 for (i = 0; i < ARRAY_SIZE(jack->key); i++) {
72 int testbit = SND_JACK_BTN_0 >> i;
74 if (!(jack->type & testbit))
78 jack->key[i] = BTN_0 + i;
80 input_set_capability(jack->input_dev, EV_KEY, jack->key[i]);
83 err = input_register_device(jack->input_dev);
91 * snd_jack_new - Create a new jack
92 * @card: the card instance
93 * @id: an identifying string for this jack
94 * @type: a bitmask of enum snd_jack_type values that can be detected by
96 * @jjack: Used to provide the allocated jack object to the caller.
98 * Creates a new jack object.
100 * Returns zero if successful, or a negative error code on failure.
101 * On success jjack will be initialised.
103 int snd_jack_new(struct snd_card *card, const char *id, int type,
104 struct snd_jack **jjack)
106 struct snd_jack *jack;
109 static struct snd_device_ops ops = {
110 .dev_free = snd_jack_dev_free,
111 .dev_register = snd_jack_dev_register,
114 jack = kzalloc(sizeof(struct snd_jack), GFP_KERNEL);
118 jack->id = kstrdup(id, GFP_KERNEL);
120 jack->input_dev = input_allocate_device();
121 if (jack->input_dev == NULL) {
126 jack->input_dev->phys = "ALSA";
130 for (i = 0; i < ARRAY_SIZE(jack_switch_types); i++)
132 input_set_capability(jack->input_dev, EV_SW,
133 jack_switch_types[i]);
135 err = snd_device_new(card, SNDRV_DEV_JACK, jack, &ops);
144 input_free_device(jack->input_dev);
149 EXPORT_SYMBOL(snd_jack_new);
152 * snd_jack_set_parent - Set the parent device for a jack
154 * @jack: The jack to configure
155 * @parent: The device to set as parent for the jack.
157 * Set the parent for the jack input device in the device tree. This
158 * function is only valid prior to registration of the jack. If no
159 * parent is configured then the parent device will be the sound card.
161 void snd_jack_set_parent(struct snd_jack *jack, struct device *parent)
163 WARN_ON(jack->registered);
165 jack->input_dev->dev.parent = parent;
167 EXPORT_SYMBOL(snd_jack_set_parent);
170 * snd_jack_set_key - Set a key mapping on a jack
172 * @jack: The jack to configure
173 * @type: Jack report type for this key
174 * @keytype: Input layer key type to be reported
176 * Map a SND_JACK_BTN_ button type to an input layer key, allowing
177 * reporting of keys on accessories via the jack abstraction. If no
178 * mapping is provided but keys are enabled in the jack type then
179 * BTN_n numeric buttons will be reported.
181 * Note that this is intended to be use by simple devices with small
182 * numbers of keys that can be reported. It is also possible to
183 * access the input device directly - devices with complex input
184 * capabilities on accessories should consider doing this rather than
185 * using this abstraction.
187 * This function may only be called prior to registration of the jack.
189 int snd_jack_set_key(struct snd_jack *jack, enum snd_jack_types type,
192 int key = fls(SND_JACK_BTN_0) - fls(type);
194 WARN_ON(jack->registered);
196 if (!keytype || key >= ARRAY_SIZE(jack->key))
200 jack->key[key] = keytype;
204 EXPORT_SYMBOL(snd_jack_set_key);
207 * snd_jack_report - Report the current status of a jack
209 * @jack: The jack to report status for
210 * @status: The current status of the jack
212 void snd_jack_report(struct snd_jack *jack, int status)
219 for (i = 0; i < ARRAY_SIZE(jack->key); i++) {
220 int testbit = SND_JACK_BTN_0 >> i;
222 if (jack->type & testbit)
223 input_report_key(jack->input_dev, jack->key[i],
227 for (i = 0; i < ARRAY_SIZE(jack_switch_types); i++) {
228 int testbit = 1 << i;
229 if (jack->type & testbit)
230 input_report_switch(jack->input_dev,
231 jack_switch_types[i],
235 input_sync(jack->input_dev);
237 EXPORT_SYMBOL(snd_jack_report);
239 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
240 MODULE_DESCRIPTION("Jack detection support for ALSA");
241 MODULE_LICENSE("GPL");