[net-next-2.6.git] / sound / core / jack.c

/*
 *  Jack abstraction layer
 *
 *  Copyright 2008 Wolfson Microelectronics
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 *
 */

#include <linux/input.h>
#include <linux/slab.h>
#include <sound/jack.h>
#include <sound/core.h>

static int jack_switch_types[] = {
	SW_HEADPHONE_INSERT,
	SW_MICROPHONE_INSERT,
	SW_LINEOUT_INSERT,
	SW_JACK_PHYSICAL_INSERT,
	SW_VIDEOOUT_INSERT,
};

static int snd_jack_dev_free(struct snd_device *device)
{
	struct snd_jack *jack = device->device_data;

	if (jack->private_free)
		jack->private_free(jack);

	/* If the input device is registered with the input subsystem
	 * then we need to use a different deallocator. */
	if (jack->registered)
		input_unregister_device(jack->input_dev);
	else
		input_free_device(jack->input_dev);

	kfree(jack->id);
	kfree(jack);

	return 0;
}

static int snd_jack_dev_register(struct snd_device *device)
{
	struct snd_jack *jack = device->device_data;
	struct snd_card *card = device->card;
	int err, i;

	snprintf(jack->name, sizeof(jack->name), "%s %s",
		 card->shortname, jack->id);
	jack->input_dev->name = jack->name;

	/* Default to the sound card device. */
	if (!jack->input_dev->dev.parent)
		jack->input_dev->dev.parent = snd_card_get_device_link(card);

	/* Add capabilities for any keys that are enabled */
	for (i = 0; i < ARRAY_SIZE(jack->key); i++) {
		int testbit = SND_JACK_BTN_0 >> i;

		if (!(jack->type & testbit))
			continue;

		if (!jack->key[i])
			jack->key[i] = BTN_0 + i;

		input_set_capability(jack->input_dev, EV_KEY, jack->key[i]);
	}

	err = input_register_device(jack->input_dev);
	if (err == 0)
		jack->registered = 1;

	return err;
}

/**
 * snd_jack_new - Create a new jack
 * @card:  the card instance
 * @id:    an identifying string for this jack
 * @type:  a bitmask of enum snd_jack_type values that can be detected by
 *         this jack
 * @jjack: Used to provide the allocated jack object to the caller.
 *
 * Creates a new jack object.
 *
 * Returns zero if successful, or a negative error code on failure.
 * On success jjack will be initialised.
 */
int snd_jack_new(struct snd_card *card, const char *id, int type,
		 struct snd_jack **jjack)
{
	struct snd_jack *jack;
	int err;
	int i;
	static struct snd_device_ops ops = {
		.dev_free = snd_jack_dev_free,
		.dev_register = snd_jack_dev_register,
	};

	jack = kzalloc(sizeof(struct snd_jack), GFP_KERNEL);
	if (jack == NULL)
		return -ENOMEM;

	jack->id = kstrdup(id, GFP_KERNEL);

	jack->input_dev = input_allocate_device();
	if (jack->input_dev == NULL) {
		err = -ENOMEM;
		goto fail_input;
	}

	jack->input_dev->phys = "ALSA";

	jack->type = type;

	for (i = 0; i < ARRAY_SIZE(jack_switch_types); i++)
		if (type & (1 << i))
			input_set_capability(jack->input_dev, EV_SW,
					     jack_switch_types[i]);

	err = snd_device_new(card, SNDRV_DEV_JACK, jack, &ops);
	if (err < 0)
		goto fail_input;

	*jjack = jack;

	return 0;

fail_input:
	input_free_device(jack->input_dev);
	kfree(jack);
	return err;
}
EXPORT_SYMBOL(snd_jack_new);

/**
 * snd_jack_set_parent - Set the parent device for a jack
 *
 * @jack:   The jack to configure
 * @parent: The device to set as parent for the jack.
 *
 * Set the parent for the jack input device in the device tree.  This
 * function is only valid prior to registration of the jack.  If no
 * parent is configured then the parent device will be the sound card.
 */
void snd_jack_set_parent(struct snd_jack *jack, struct device *parent)
{
	WARN_ON(jack->registered);

	jack->input_dev->dev.parent = parent;
}
EXPORT_SYMBOL(snd_jack_set_parent);

/**
 * snd_jack_set_key - Set a key mapping on a jack
 *
 * @jack:    The jack to configure
 * @type:    Jack report type for this key
 * @keytype: Input layer key type to be reported
 *
 * Map a SND_JACK_BTN_ button type to an input layer key, allowing
 * reporting of keys on accessories via the jack abstraction.  If no
 * mapping is provided but keys are enabled in the jack type then
 * BTN_n numeric buttons will be reported.
 *
 * Note that this is intended to be use by simple devices with small
 * numbers of keys that can be reported.  It is also possible to
 * access the input device directly - devices with complex input
 * capabilities on accessories should consider doing this rather than
 * using this abstraction.
 *
 * This function may only be called prior to registration of the jack.
 */
int snd_jack_set_key(struct snd_jack *jack, enum snd_jack_types type,
		     int keytype)
{
	int key = fls(SND_JACK_BTN_0) - fls(type);

	WARN_ON(jack->registered);

	if (!keytype || key >= ARRAY_SIZE(jack->key))
		return -EINVAL;

	jack->type |= type;
	jack->key[key] = keytype;

	return 0;
}
EXPORT_SYMBOL(snd_jack_set_key);

/**
 * snd_jack_report - Report the current status of a jack
 *
 * @jack:   The jack to report status for
 * @status: The current status of the jack
 */
void snd_jack_report(struct snd_jack *jack, int status)
{
	int i;

	if (!jack)
		return;

	for (i = 0; i < ARRAY_SIZE(jack->key); i++) {
		int testbit = SND_JACK_BTN_0 >> i;

		if (jack->type & testbit)
			input_report_key(jack->input_dev, jack->key[i],
					 status & testbit);
	}

	for (i = 0; i < ARRAY_SIZE(jack_switch_types); i++) {
		int testbit = 1 << i;
		if (jack->type & testbit)
			input_report_switch(jack->input_dev,
					    jack_switch_types[i],
					    status & testbit);
	}

	input_sync(jack->input_dev);
}
EXPORT_SYMBOL(snd_jack_report);

MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
MODULE_DESCRIPTION("Jack detection support for ALSA");
MODULE_LICENSE("GPL");
Commit	Line	Data
e76d8cea MB	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>
5a0e3ad6	23	#include <linux/slab.h>
e76d8cea MB	24	#include <sound/jack.h>
	25	#include <sound/core.h>
	26
1c6e555c	27	static int jack_switch_types[] = {
bd8a71a7 MB	28	SW_HEADPHONE_INSERT,
	29	SW_MICROPHONE_INSERT,
	30	SW_LINEOUT_INSERT,
	31	SW_JACK_PHYSICAL_INSERT,
d506fc32	32	SW_VIDEOOUT_INSERT,
bd8a71a7 MB	33	};
bd8a71a7 MB	34
e76d8cea MB	35	static int snd_jack_dev_free(struct snd_device *device)
	36	{
	37	struct snd_jack *jack = device->device_data;
	38
9d59065c TI	39	if (jack->private_free)
	40	jack->private_free(jack);
	41
e76d8cea MB	42	/* If the input device is registered with the input subsystem
	43	* then we need to use a different deallocator. */
	44	if (jack->registered)
	45	input_unregister_device(jack->input_dev);
	46	else
	47	input_free_device(jack->input_dev);
	48
282cd76f	49	kfree(jack->id);
e76d8cea MB	50	kfree(jack);
	51
	52	return 0;
	53	}
	54
	55	static int snd_jack_dev_register(struct snd_device *device)
	56	{
	57	struct snd_jack *jack = device->device_data;
	58	struct snd_card *card = device->card;
ebb812cb	59	int err, i;
e76d8cea MB	60
e76d8cea MB	61	snprintf(jack->name, sizeof(jack->name), "%s %s",
2678f60d	62	card->shortname, jack->id);
e76d8cea MB	63	jack->input_dev->name = jack->name;
	64
	65	/* Default to the sound card device. */
	66	if (!jack->input_dev->dev.parent)
1f3fff7b	67	jack->input_dev->dev.parent = snd_card_get_device_link(card);
e76d8cea	68
ebb812cb MB	69	/* Add capabilities for any keys that are enabled */
	70	for (i = 0; i < ARRAY_SIZE(jack->key); i++) {
	71	int testbit = SND_JACK_BTN_0 >> i;
	72
	73	if (!(jack->type & testbit))
	74	continue;
	75
	76	if (!jack->key[i])
	77	jack->key[i] = BTN_0 + i;
	78
	79	input_set_capability(jack->input_dev, EV_KEY, jack->key[i]);
	80	}
	81
e76d8cea MB	82	err = input_register_device(jack->input_dev);
	83	if (err == 0)
	84	jack->registered = 1;
	85
	86	return err;
	87	}
	88
	89	/**
	90	* snd_jack_new - Create a new jack
	91	* @card: the card instance
	92	* @id: an identifying string for this jack
	93	* @type: a bitmask of enum snd_jack_type values that can be detected by
	94	* this jack
	95	* @jjack: Used to provide the allocated jack object to the caller.
	96	*
	97	* Creates a new jack object.
	98	*
	99	* Returns zero if successful, or a negative error code on failure.
	100	* On success jjack will be initialised.
	101	*/
	102	int snd_jack_new(struct snd_card card, const char id, int type,
	103	struct snd_jack **jjack)
	104	{
	105	struct snd_jack *jack;
	106	int err;
bd8a71a7	107	int i;
e76d8cea MB	108	static struct snd_device_ops ops = {
	109	.dev_free = snd_jack_dev_free,
	110	.dev_register = snd_jack_dev_register,
	111	};
	112
	113	jack = kzalloc(sizeof(struct snd_jack), GFP_KERNEL);
	114	if (jack == NULL)
	115	return -ENOMEM;
	116
282cd76f	117	jack->id = kstrdup(id, GFP_KERNEL);
e76d8cea MB	118
	119	jack->input_dev = input_allocate_device();
	120	if (jack->input_dev == NULL) {
	121	err = -ENOMEM;
	122	goto fail_input;
	123	}
	124
	125	jack->input_dev->phys = "ALSA";
	126
	127	jack->type = type;
	128
1c6e555c	129	for (i = 0; i < ARRAY_SIZE(jack_switch_types); i++)
bd8a71a7 MB	130	if (type & (1 << i))
bd8a71a7 MB	131	input_set_capability(jack->input_dev, EV_SW,
1c6e555c	132	jack_switch_types[i]);
e76d8cea MB	133
	134	err = snd_device_new(card, SNDRV_DEV_JACK, jack, &ops);
	135	if (err < 0)
	136	goto fail_input;
	137
	138	*jjack = jack;
	139
	140	return 0;
	141
	142	fail_input:
	143	input_free_device(jack->input_dev);
	144	kfree(jack);
	145	return err;
	146	}
	147	EXPORT_SYMBOL(snd_jack_new);
	148
	149	/**
	150	* snd_jack_set_parent - Set the parent device for a jack
	151	*
	152	* @jack: The jack to configure
	153	* @parent: The device to set as parent for the jack.
	154	*
	155	* Set the parent for the jack input device in the device tree. This
	156	* function is only valid prior to registration of the jack. If no
	157	* parent is configured then the parent device will be the sound card.
	158	*/
	159	void snd_jack_set_parent(struct snd_jack jack, struct device parent)
	160	{
	161	WARN_ON(jack->registered);
	162
	163	jack->input_dev->dev.parent = parent;
	164	}
	165	EXPORT_SYMBOL(snd_jack_set_parent);
	166
ebb812cb MB	167	/**
	168	* snd_jack_set_key - Set a key mapping on a jack
	169	*
	170	* @jack: The jack to configure
	171	* @type: Jack report type for this key
	172	* @keytype: Input layer key type to be reported
	173	*
	174	* Map a SND_JACK_BTN_ button type to an input layer key, allowing
	175	* reporting of keys on accessories via the jack abstraction. If no
	176	* mapping is provided but keys are enabled in the jack type then
	177	* BTN_n numeric buttons will be reported.
	178	*
	179	* Note that this is intended to be use by simple devices with small
	180	* numbers of keys that can be reported. It is also possible to
	181	* access the input device directly - devices with complex input
	182	* capabilities on accessories should consider doing this rather than
	183	* using this abstraction.
	184	*
	185	* This function may only be called prior to registration of the jack.
	186	*/
	187	int snd_jack_set_key(struct snd_jack *jack, enum snd_jack_types type,
	188	int keytype)
	189	{
	190	int key = fls(SND_JACK_BTN_0) - fls(type);
	191
	192	WARN_ON(jack->registered);
	193
	194	if (!keytype \|\| key >= ARRAY_SIZE(jack->key))
	195	return -EINVAL;
	196
	197	jack->type \|= type;
	198	jack->key[key] = keytype;
	199
	200	return 0;
	201	}
	202	EXPORT_SYMBOL(snd_jack_set_key);
	203
e76d8cea MB	204	/**
	205	* snd_jack_report - Report the current status of a jack
	206	*
	207	* @jack: The jack to report status for
	208	* @status: The current status of the jack
	209	*/
	210	void snd_jack_report(struct snd_jack *jack, int status)
	211	{
bd8a71a7 MB	212	int i;
bd8a71a7 MB	213
9a3f371e MB	214	if (!jack)
	215	return;
	216
ebb812cb MB	217	for (i = 0; i < ARRAY_SIZE(jack->key); i++) {
	218	int testbit = SND_JACK_BTN_0 >> i;
	219
	220	if (jack->type & testbit)
	221	input_report_key(jack->input_dev, jack->key[i],
	222	status & testbit);
	223	}
	224
1c6e555c	225	for (i = 0; i < ARRAY_SIZE(jack_switch_types); i++) {
bd8a71a7 MB	226	int testbit = 1 << i;
bd8a71a7 MB	227	if (jack->type & testbit)
1c6e555c MB	228	input_report_switch(jack->input_dev,
1c6e555c MB	229	jack_switch_types[i],
bd8a71a7 MB	230	status & testbit);
bd8a71a7 MB	231	}
e76d8cea MB	232
	233	input_sync(jack->input_dev);
	234	}
	235	EXPORT_SYMBOL(snd_jack_report);
	236
	237	MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
	238	MODULE_DESCRIPTION("Jack detection support for ALSA");
	239	MODULE_LICENSE("GPL");