[deliverable/linux.git] / sound / core / device.c

/*
 *  Device management routines
 *  Copyright (c) by Jaroslav Kysela <perex@suse.cz>
 *
 *
 *   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 <sound/driver.h>
#include <linux/slab.h>
#include <linux/time.h>
#include <linux/errno.h>
#include <sound/core.h>

/**
 * snd_device_new - create an ALSA device component
 * @card: the card instance
 * @type: the device type, SNDRV_DEV_XXX
 * @device_data: the data pointer of this device
 * @ops: the operator table
 *
 * Creates a new device component for the given data pointer.
 * The device will be assigned to the card and managed together
 * by the card.
 *
 * The data pointer plays a role as the identifier, too, so the
 * pointer address must be unique and unchanged.
 *
 * Returns zero if successful, or a negative error code on failure.
 */
int snd_device_new(struct snd_card *card, snd_device_type_t type,
		   void *device_data, struct snd_device_ops *ops)
{
	struct snd_device *dev;

	snd_assert(card != NULL, return -ENXIO);
	snd_assert(device_data != NULL, return -ENXIO);
	snd_assert(ops != NULL, return -ENXIO);
	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
	if (dev == NULL) {
		snd_printk(KERN_ERR "Cannot allocate device\n");
		return -ENOMEM;
	}
	dev->card = card;
	dev->type = type;
	dev->state = SNDRV_DEV_BUILD;
	dev->device_data = device_data;
	dev->ops = ops;
	list_add(&dev->list, &card->devices);	/* add to the head of list */
	return 0;
}

EXPORT_SYMBOL(snd_device_new);

/**
 * snd_device_free - release the device from the card
 * @card: the card instance
 * @device_data: the data pointer to release
 *
 * Removes the device from the list on the card and invokes the
 * callbacks, dev_disconnect and dev_free, corresponding to the state.
 * Then release the device.
 *
 * Returns zero if successful, or a negative error code on failure or if the
 * device not found.
 */
int snd_device_free(struct snd_card *card, void *device_data)
{
	struct list_head *list;
	struct snd_device *dev;
	
	snd_assert(card != NULL, return -ENXIO);
	snd_assert(device_data != NULL, return -ENXIO);
	list_for_each(list, &card->devices) {
		dev = snd_device(list);
		if (dev->device_data != device_data)
			continue;
		/* unlink */
		list_del(&dev->list);
		if (dev->state == SNDRV_DEV_REGISTERED &&
		    dev->ops->dev_disconnect)
			if (dev->ops->dev_disconnect(dev))
				snd_printk(KERN_ERR
					   "device disconnect failure\n");
		if (dev->ops->dev_free) {
			if (dev->ops->dev_free(dev))
				snd_printk(KERN_ERR "device free failure\n");
		}
		kfree(dev);
		return 0;
	}
	snd_printd("device free %p (from %p), not found\n", device_data,
		   __builtin_return_address(0));
	return -ENXIO;
}

EXPORT_SYMBOL(snd_device_free);

/**
 * snd_device_disconnect - disconnect the device
 * @card: the card instance
 * @device_data: the data pointer to disconnect
 *
 * Turns the device into the disconnection state, invoking
 * dev_disconnect callback, if the device was already registered.
 *
 * Usually called from snd_card_disconnect().
 *
 * Returns zero if successful, or a negative error code on failure or if the
 * device not found.
 */
int snd_device_disconnect(struct snd_card *card, void *device_data)
{
	struct list_head *list;
	struct snd_device *dev;

	snd_assert(card != NULL, return -ENXIO);
	snd_assert(device_data != NULL, return -ENXIO);
	list_for_each(list, &card->devices) {
		dev = snd_device(list);
		if (dev->device_data != device_data)
			continue;
		if (dev->state == SNDRV_DEV_REGISTERED &&
		    dev->ops->dev_disconnect) {
			if (dev->ops->dev_disconnect(dev))
				snd_printk(KERN_ERR "device disconnect failure\n");
			dev->state = SNDRV_DEV_DISCONNECTED;
		}
		return 0;
	}
	snd_printd("device disconnect %p (from %p), not found\n", device_data,
		   __builtin_return_address(0));
	return -ENXIO;
}

/**
 * snd_device_register - register the device
 * @card: the card instance
 * @device_data: the data pointer to register
 *
 * Registers the device which was already created via
 * snd_device_new().  Usually this is called from snd_card_register(),
 * but it can be called later if any new devices are created after
 * invocation of snd_card_register().
 *
 * Returns zero if successful, or a negative error code on failure or if the
 * device not found.
 */
int snd_device_register(struct snd_card *card, void *device_data)
{
	struct list_head *list;
	struct snd_device *dev;
	int err;

	snd_assert(card != NULL, return -ENXIO);
	snd_assert(device_data != NULL, return -ENXIO);
	list_for_each(list, &card->devices) {
		dev = snd_device(list);
		if (dev->device_data != device_data)
			continue;
		if (dev->state == SNDRV_DEV_BUILD && dev->ops->dev_register) {
			if ((err = dev->ops->dev_register(dev)) < 0)
				return err;
			dev->state = SNDRV_DEV_REGISTERED;
			return 0;
		}
		snd_printd("snd_device_register busy\n");
		return -EBUSY;
	}
	snd_BUG();
	return -ENXIO;
}

EXPORT_SYMBOL(snd_device_register);

/*
 * register all the devices on the card.
 * called from init.c
 */
int snd_device_register_all(struct snd_card *card)
{
	struct list_head *list;
	struct snd_device *dev;
	int err;
	
	snd_assert(card != NULL, return -ENXIO);
	list_for_each(list, &card->devices) {
		dev = snd_device(list);
		if (dev->state == SNDRV_DEV_BUILD && dev->ops->dev_register) {
			if ((err = dev->ops->dev_register(dev)) < 0)
				return err;
			dev->state = SNDRV_DEV_REGISTERED;
		}
	}
	return 0;
}

/*
 * disconnect all the devices on the card.
 * called from init.c
 */
int snd_device_disconnect_all(struct snd_card *card)
{
	struct snd_device *dev;
	struct list_head *list;
	int err = 0;

	snd_assert(card != NULL, return -ENXIO);
	list_for_each(list, &card->devices) {
		dev = snd_device(list);
		if (snd_device_disconnect(card, dev->device_data) < 0)
			err = -ENXIO;
	}
	return err;
}

/*
 * release all the devices on the card.
 * called from init.c
 */
int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd)
{
	struct snd_device *dev;
	struct list_head *list;
	int err;
	unsigned int range_low, range_high;

	snd_assert(card != NULL, return -ENXIO);
	range_low = cmd * SNDRV_DEV_TYPE_RANGE_SIZE;
	range_high = range_low + SNDRV_DEV_TYPE_RANGE_SIZE - 1;
      __again:
	list_for_each(list, &card->devices) {
		dev = snd_device(list);		
		if (dev->type >= range_low && dev->type <= range_high) {
			if ((err = snd_device_free(card, dev->device_data)) < 0)
				return err;
			goto __again;
		}
	}
	return 0;
}
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Device management routines
	3	* Copyright (c) by Jaroslav Kysela <perex@suse.cz>
	4	*
	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 <sound/driver.h>
	23	#include <linux/slab.h>
	24	#include <linux/time.h>
	25	#include <linux/errno.h>
	26	#include <sound/core.h>
	27
	28	/**
	29	* snd_device_new - create an ALSA device component
	30	* @card: the card instance
a3352f01	31	* @type: the device type, SNDRV_DEV_XXX
1da177e4 LT	32	* @device_data: the data pointer of this device
	33	* @ops: the operator table
	34	*
	35	* Creates a new device component for the given data pointer.
	36	* The device will be assigned to the card and managed together
	37	* by the card.
	38	*
	39	* The data pointer plays a role as the identifier, too, so the
	40	* pointer address must be unique and unchanged.
	41	*
	42	* Returns zero if successful, or a negative error code on failure.
	43	*/
512bbd6a TI	44	int snd_device_new(struct snd_card *card, snd_device_type_t type,
512bbd6a TI	45	void device_data, struct snd_device_ops ops)
1da177e4	46	{
512bbd6a	47	struct snd_device *dev;
1da177e4	48
a3352f01 HK	49	snd_assert(card != NULL, return -ENXIO);
	50	snd_assert(device_data != NULL, return -ENXIO);
	51	snd_assert(ops != NULL, return -ENXIO);
ca2c0966	52	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
73e77ba0 TI	53	if (dev == NULL) {
73e77ba0 TI	54	snd_printk(KERN_ERR "Cannot allocate device\n");
1da177e4	55	return -ENOMEM;
73e77ba0	56	}
1da177e4 LT	57	dev->card = card;
	58	dev->type = type;
	59	dev->state = SNDRV_DEV_BUILD;
	60	dev->device_data = device_data;
	61	dev->ops = ops;
	62	list_add(&dev->list, &card->devices); /* add to the head of list */
	63	return 0;
	64	}
	65
c0d3fb39 TI	66	EXPORT_SYMBOL(snd_device_new);
c0d3fb39 TI	67
1da177e4 LT	68	/**
	69	* snd_device_free - release the device from the card
	70	* @card: the card instance
	71	* @device_data: the data pointer to release
	72	*
	73	* Removes the device from the list on the card and invokes the
c461482c	74	* callbacks, dev_disconnect and dev_free, corresponding to the state.
1da177e4 LT	75	* Then release the device.
	76	*
	77	* Returns zero if successful, or a negative error code on failure or if the
	78	* device not found.
	79	*/
512bbd6a	80	int snd_device_free(struct snd_card card, void device_data)
1da177e4 LT	81	{
1da177e4 LT	82	struct list_head *list;
512bbd6a	83	struct snd_device *dev;
1da177e4 LT	84
	85	snd_assert(card != NULL, return -ENXIO);
	86	snd_assert(device_data != NULL, return -ENXIO);
	87	list_for_each(list, &card->devices) {
	88	dev = snd_device(list);
	89	if (dev->device_data != device_data)
	90	continue;
	91	/* unlink */
	92	list_del(&dev->list);
c461482c TI	93	if (dev->state == SNDRV_DEV_REGISTERED &&
	94	dev->ops->dev_disconnect)
	95	if (dev->ops->dev_disconnect(dev))
	96	snd_printk(KERN_ERR
	97	"device disconnect failure\n");
	98	if (dev->ops->dev_free) {
	99	if (dev->ops->dev_free(dev))
	100	snd_printk(KERN_ERR "device free failure\n");
1da177e4 LT	101	}
	102	kfree(dev);
	103	return 0;
	104	}
512bbd6a TI	105	snd_printd("device free %p (from %p), not found\n", device_data,
512bbd6a TI	106	__builtin_return_address(0));
1da177e4 LT	107	return -ENXIO;
	108	}
	109
c0d3fb39 TI	110	EXPORT_SYMBOL(snd_device_free);
c0d3fb39 TI	111
1da177e4	112	/**
a3352f01	113	* snd_device_disconnect - disconnect the device
1da177e4 LT	114	* @card: the card instance
	115	* @device_data: the data pointer to disconnect
	116	*
	117	* Turns the device into the disconnection state, invoking
	118	* dev_disconnect callback, if the device was already registered.
	119	*
	120	* Usually called from snd_card_disconnect().
	121	*
	122	* Returns zero if successful, or a negative error code on failure or if the
	123	* device not found.
	124	*/
512bbd6a	125	int snd_device_disconnect(struct snd_card card, void device_data)
1da177e4 LT	126	{
1da177e4 LT	127	struct list_head *list;
512bbd6a	128	struct snd_device *dev;
a3352f01	129
1da177e4 LT	130	snd_assert(card != NULL, return -ENXIO);
	131	snd_assert(device_data != NULL, return -ENXIO);
	132	list_for_each(list, &card->devices) {
	133	dev = snd_device(list);
	134	if (dev->device_data != device_data)
	135	continue;
512bbd6a TI	136	if (dev->state == SNDRV_DEV_REGISTERED &&
512bbd6a TI	137	dev->ops->dev_disconnect) {
1da177e4 LT	138	if (dev->ops->dev_disconnect(dev))
	139	snd_printk(KERN_ERR "device disconnect failure\n");
	140	dev->state = SNDRV_DEV_DISCONNECTED;
	141	}
	142	return 0;
	143	}
512bbd6a TI	144	snd_printd("device disconnect %p (from %p), not found\n", device_data,
512bbd6a TI	145	__builtin_return_address(0));
1da177e4 LT	146	return -ENXIO;
	147	}
	148
	149	/**
	150	* snd_device_register - register the device
	151	* @card: the card instance
	152	* @device_data: the data pointer to register
	153	*
	154	* Registers the device which was already created via
	155	* snd_device_new(). Usually this is called from snd_card_register(),
	156	* but it can be called later if any new devices are created after
	157	* invocation of snd_card_register().
	158	*
	159	* Returns zero if successful, or a negative error code on failure or if the
	160	* device not found.
	161	*/
512bbd6a	162	int snd_device_register(struct snd_card card, void device_data)
1da177e4 LT	163	{
1da177e4 LT	164	struct list_head *list;
512bbd6a	165	struct snd_device *dev;
1da177e4	166	int err;
a3352f01 HK	167
	168	snd_assert(card != NULL, return -ENXIO);
	169	snd_assert(device_data != NULL, return -ENXIO);
1da177e4 LT	170	list_for_each(list, &card->devices) {
	171	dev = snd_device(list);
	172	if (dev->device_data != device_data)
	173	continue;
	174	if (dev->state == SNDRV_DEV_BUILD && dev->ops->dev_register) {
	175	if ((err = dev->ops->dev_register(dev)) < 0)
	176	return err;
	177	dev->state = SNDRV_DEV_REGISTERED;
	178	return 0;
	179	}
73e77ba0	180	snd_printd("snd_device_register busy\n");
1da177e4 LT	181	return -EBUSY;
	182	}
	183	snd_BUG();
	184	return -ENXIO;
	185	}
	186
c0d3fb39 TI	187	EXPORT_SYMBOL(snd_device_register);
c0d3fb39 TI	188
1da177e4 LT	189	/*
	190	* register all the devices on the card.
	191	* called from init.c
	192	*/
512bbd6a	193	int snd_device_register_all(struct snd_card *card)
1da177e4 LT	194	{
1da177e4 LT	195	struct list_head *list;
512bbd6a	196	struct snd_device *dev;
1da177e4 LT	197	int err;
	198
	199	snd_assert(card != NULL, return -ENXIO);
3e23c658	200	list_for_each(list, &card->devices) {
1da177e4 LT	201	dev = snd_device(list);
	202	if (dev->state == SNDRV_DEV_BUILD && dev->ops->dev_register) {
	203	if ((err = dev->ops->dev_register(dev)) < 0)
	204	return err;
	205	dev->state = SNDRV_DEV_REGISTERED;
	206	}
	207	}
	208	return 0;
	209	}
	210
	211	/*
	212	* disconnect all the devices on the card.
	213	* called from init.c
	214	*/
512bbd6a	215	int snd_device_disconnect_all(struct snd_card *card)
1da177e4	216	{
512bbd6a	217	struct snd_device *dev;
1da177e4 LT	218	struct list_head *list;
	219	int err = 0;
	220
	221	snd_assert(card != NULL, return -ENXIO);
	222	list_for_each(list, &card->devices) {
	223	dev = snd_device(list);
	224	if (snd_device_disconnect(card, dev->device_data) < 0)
	225	err = -ENXIO;
	226	}
	227	return err;
	228	}
	229
	230	/*
	231	* release all the devices on the card.
	232	* called from init.c
	233	*/
512bbd6a	234	int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd)
1da177e4	235	{
512bbd6a	236	struct snd_device *dev;
1da177e4 LT	237	struct list_head *list;
	238	int err;
	239	unsigned int range_low, range_high;
	240
	241	snd_assert(card != NULL, return -ENXIO);
	242	range_low = cmd * SNDRV_DEV_TYPE_RANGE_SIZE;
	243	range_high = range_low + SNDRV_DEV_TYPE_RANGE_SIZE - 1;
	244	__again:
	245	list_for_each(list, &card->devices) {
	246	dev = snd_device(list);
	247	if (dev->type >= range_low && dev->type <= range_high) {
	248	if ((err = snd_device_free(card, dev->device_data)) < 0)
	249	return err;
	250	goto __again;
	251	}
	252	}
	253	return 0;
	254	}