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

/*
 *  Device management routines
 *  Copyright (c) by Jaroslav Kysela <perex@perex.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 <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;

	if (snd_BUG_ON(!card || !device_data || !ops))
		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 snd_device *dev;
	
	if (snd_BUG_ON(!card || !device_data))
		return -ENXIO;
	list_for_each_entry(dev, &card->devices, 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 %pF), 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 snd_device *dev;

	if (snd_BUG_ON(!card || !device_data))
		return -ENXIO;
	list_for_each_entry(dev, &card->devices, 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 %pF), 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 snd_device *dev;
	int err;

	if (snd_BUG_ON(!card || !device_data))
		return -ENXIO;
	list_for_each_entry(dev, &card->devices, 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 snd_device *dev;
	int err;
	
	if (snd_BUG_ON(!card))
		return -ENXIO;
	list_for_each_entry(dev, &card->devices, 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;
	int err = 0;

	if (snd_BUG_ON(!card))
		return -ENXIO;
	list_for_each_entry(dev, &card->devices, 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;
	int err;
	unsigned int range_low, range_high;

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