blob: b35fe7345c203c557d2baa5d0cbb778afac2dfb9 [file] [log] [blame]
Mark Browne76d8ce2008-07-28 19:05:35 +01001/*
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>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090023#include <linux/slab.h>
Paul Gortmakerda155d52011-07-15 12:38:28 -040024#include <linux/module.h>
Mark Browne76d8ce2008-07-28 19:05:35 +010025#include <sound/jack.h>
26#include <sound/core.h>
27
Mark Brown53803ae2012-02-07 19:48:47 +000028static int jack_switch_types[SND_JACK_SWITCH_TYPES] = {
Mark Brownbd8a71a2009-01-03 16:56:56 +000029 SW_HEADPHONE_INSERT,
30 SW_MICROPHONE_INSERT,
31 SW_LINEOUT_INSERT,
32 SW_JACK_PHYSICAL_INSERT,
Jani Nikulad506fc32009-01-07 11:54:25 +020033 SW_VIDEOOUT_INSERT,
David Henningsson7c2f8e42011-10-05 15:53:25 +020034 SW_LINEIN_INSERT,
Mark Brownbd8a71a2009-01-03 16:56:56 +000035};
36
Mark Browne76d8ce2008-07-28 19:05:35 +010037static int snd_jack_dev_free(struct snd_device *device)
38{
39 struct snd_jack *jack = device->device_data;
40
Takashi Iwai9d590652009-04-14 16:13:58 +020041 if (jack->private_free)
42 jack->private_free(jack);
43
Mark Browne76d8ce2008-07-28 19:05:35 +010044 /* If the input device is registered with the input subsystem
45 * then we need to use a different deallocator. */
46 if (jack->registered)
47 input_unregister_device(jack->input_dev);
48 else
49 input_free_device(jack->input_dev);
50
Matthew Ranostay282cd762008-10-25 01:05:29 -040051 kfree(jack->id);
Mark Browne76d8ce2008-07-28 19:05:35 +010052 kfree(jack);
53
54 return 0;
55}
56
57static int snd_jack_dev_register(struct snd_device *device)
58{
59 struct snd_jack *jack = device->device_data;
60 struct snd_card *card = device->card;
Mark Brownebb812c2010-03-17 18:07:12 +000061 int err, i;
Mark Browne76d8ce2008-07-28 19:05:35 +010062
63 snprintf(jack->name, sizeof(jack->name), "%s %s",
Takashi Iwai2678f602009-02-18 16:46:27 +010064 card->shortname, jack->id);
Mark Browne76d8ce2008-07-28 19:05:35 +010065 jack->input_dev->name = jack->name;
66
67 /* Default to the sound card device. */
68 if (!jack->input_dev->dev.parent)
Kay Sievers1f3fff72009-06-10 19:50:33 +020069 jack->input_dev->dev.parent = snd_card_get_device_link(card);
Mark Browne76d8ce2008-07-28 19:05:35 +010070
Mark Brownebb812c2010-03-17 18:07:12 +000071 /* Add capabilities for any keys that are enabled */
72 for (i = 0; i < ARRAY_SIZE(jack->key); i++) {
73 int testbit = SND_JACK_BTN_0 >> i;
74
75 if (!(jack->type & testbit))
76 continue;
77
78 if (!jack->key[i])
79 jack->key[i] = BTN_0 + i;
80
81 input_set_capability(jack->input_dev, EV_KEY, jack->key[i]);
82 }
83
Mark Browne76d8ce2008-07-28 19:05:35 +010084 err = input_register_device(jack->input_dev);
85 if (err == 0)
86 jack->registered = 1;
87
88 return err;
89}
90
91/**
92 * snd_jack_new - Create a new jack
93 * @card: the card instance
94 * @id: an identifying string for this jack
95 * @type: a bitmask of enum snd_jack_type values that can be detected by
96 * this jack
97 * @jjack: Used to provide the allocated jack object to the caller.
98 *
99 * Creates a new jack object.
100 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100101 * Return: Zero if successful, or a negative error code on failure.
102 * On success @jjack will be initialised.
Mark Browne76d8ce2008-07-28 19:05:35 +0100103 */
104int snd_jack_new(struct snd_card *card, const char *id, int type,
105 struct snd_jack **jjack)
106{
107 struct snd_jack *jack;
108 int err;
Mark Brownbd8a71a2009-01-03 16:56:56 +0000109 int i;
Mark Browne76d8ce2008-07-28 19:05:35 +0100110 static struct snd_device_ops ops = {
111 .dev_free = snd_jack_dev_free,
112 .dev_register = snd_jack_dev_register,
113 };
114
115 jack = kzalloc(sizeof(struct snd_jack), GFP_KERNEL);
116 if (jack == NULL)
117 return -ENOMEM;
118
Matthew Ranostay282cd762008-10-25 01:05:29 -0400119 jack->id = kstrdup(id, GFP_KERNEL);
Mark Browne76d8ce2008-07-28 19:05:35 +0100120
121 jack->input_dev = input_allocate_device();
122 if (jack->input_dev == NULL) {
123 err = -ENOMEM;
124 goto fail_input;
125 }
126
127 jack->input_dev->phys = "ALSA";
128
129 jack->type = type;
130
Mark Brown53803ae2012-02-07 19:48:47 +0000131 for (i = 0; i < SND_JACK_SWITCH_TYPES; i++)
Mark Brownbd8a71a2009-01-03 16:56:56 +0000132 if (type & (1 << i))
133 input_set_capability(jack->input_dev, EV_SW,
Mark Brown1c6e5552010-03-17 15:36:38 +0000134 jack_switch_types[i]);
Mark Browne76d8ce2008-07-28 19:05:35 +0100135
136 err = snd_device_new(card, SNDRV_DEV_JACK, jack, &ops);
137 if (err < 0)
138 goto fail_input;
139
140 *jjack = jack;
141
142 return 0;
143
144fail_input:
145 input_free_device(jack->input_dev);
Lu Guanquneeda276b2011-02-21 13:45:04 +0800146 kfree(jack->id);
Mark Browne76d8ce2008-07-28 19:05:35 +0100147 kfree(jack);
148 return err;
149}
150EXPORT_SYMBOL(snd_jack_new);
151
152/**
153 * snd_jack_set_parent - Set the parent device for a jack
154 *
155 * @jack: The jack to configure
156 * @parent: The device to set as parent for the jack.
157 *
Mark Browna2e888f2012-05-07 17:10:21 +0100158 * Set the parent for the jack devices in the device tree. This
Mark Browne76d8ce2008-07-28 19:05:35 +0100159 * function is only valid prior to registration of the jack. If no
160 * parent is configured then the parent device will be the sound card.
161 */
162void snd_jack_set_parent(struct snd_jack *jack, struct device *parent)
163{
164 WARN_ON(jack->registered);
165
166 jack->input_dev->dev.parent = parent;
167}
168EXPORT_SYMBOL(snd_jack_set_parent);
169
170/**
Mark Brownebb812c2010-03-17 18:07:12 +0000171 * snd_jack_set_key - Set a key mapping on a jack
172 *
173 * @jack: The jack to configure
174 * @type: Jack report type for this key
175 * @keytype: Input layer key type to be reported
176 *
177 * Map a SND_JACK_BTN_ button type to an input layer key, allowing
178 * reporting of keys on accessories via the jack abstraction. If no
179 * mapping is provided but keys are enabled in the jack type then
180 * BTN_n numeric buttons will be reported.
181 *
Mark Browna2e888f2012-05-07 17:10:21 +0100182 * If jacks are not reporting via the input API this call will have no
183 * effect.
184 *
Mark Brownebb812c2010-03-17 18:07:12 +0000185 * Note that this is intended to be use by simple devices with small
186 * numbers of keys that can be reported. It is also possible to
187 * access the input device directly - devices with complex input
188 * capabilities on accessories should consider doing this rather than
189 * using this abstraction.
190 *
191 * This function may only be called prior to registration of the jack.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100192 *
193 * Return: Zero if successful, or a negative error code on failure.
Mark Brownebb812c2010-03-17 18:07:12 +0000194 */
195int snd_jack_set_key(struct snd_jack *jack, enum snd_jack_types type,
196 int keytype)
197{
198 int key = fls(SND_JACK_BTN_0) - fls(type);
199
200 WARN_ON(jack->registered);
201
202 if (!keytype || key >= ARRAY_SIZE(jack->key))
203 return -EINVAL;
204
205 jack->type |= type;
206 jack->key[key] = keytype;
207
208 return 0;
209}
210EXPORT_SYMBOL(snd_jack_set_key);
211
212/**
Mark Browne76d8ce2008-07-28 19:05:35 +0100213 * snd_jack_report - Report the current status of a jack
214 *
215 * @jack: The jack to report status for
216 * @status: The current status of the jack
217 */
218void snd_jack_report(struct snd_jack *jack, int status)
219{
Mark Brownbd8a71a2009-01-03 16:56:56 +0000220 int i;
221
Mark Brown9a3f3712008-10-15 17:07:47 +0100222 if (!jack)
223 return;
224
Mark Brownebb812c2010-03-17 18:07:12 +0000225 for (i = 0; i < ARRAY_SIZE(jack->key); i++) {
226 int testbit = SND_JACK_BTN_0 >> i;
227
228 if (jack->type & testbit)
229 input_report_key(jack->input_dev, jack->key[i],
230 status & testbit);
231 }
232
Mark Brown1c6e5552010-03-17 15:36:38 +0000233 for (i = 0; i < ARRAY_SIZE(jack_switch_types); i++) {
Mark Brownbd8a71a2009-01-03 16:56:56 +0000234 int testbit = 1 << i;
235 if (jack->type & testbit)
Mark Brown1c6e5552010-03-17 15:36:38 +0000236 input_report_switch(jack->input_dev,
237 jack_switch_types[i],
Mark Brownbd8a71a2009-01-03 16:56:56 +0000238 status & testbit);
239 }
Mark Browne76d8ce2008-07-28 19:05:35 +0100240
241 input_sync(jack->input_dev);
242}
243EXPORT_SYMBOL(snd_jack_report);
244
245MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
246MODULE_DESCRIPTION("Jack detection support for ALSA");
247MODULE_LICENSE("GPL");