blob: 41bec3075ae5b829c6f032520da7062c6214f662 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Device management routines
Jaroslav Kyselac1017a42007-10-15 09:50:19 +02003 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/slab.h>
23#include <linux/time.h>
Paul Gortmakerd81a6d72011-09-22 09:34:58 -040024#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#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
Henrik Kretzschmara3352f02005-06-29 19:30:42 +020031 * @type: the device type, SNDRV_DEV_XXX
Linus Torvalds1da177e2005-04-16 15:20:36 -070032 * @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 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +010042 * Return: Zero if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 */
Takashi Iwai9ce50542014-01-29 15:13:33 +010044int snd_device_new(struct snd_card *card, enum snd_device_type type,
Takashi Iwai512bbd62005-11-17 13:51:18 +010045 void *device_data, struct snd_device_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -070046{
Takashi Iwai512bbd62005-11-17 13:51:18 +010047 struct snd_device *dev;
Takashi Iwai289ca022014-01-29 15:53:35 +010048 struct list_head *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Takashi Iwai7eaa9432008-08-08 17:09:09 +020050 if (snd_BUG_ON(!card || !device_data || !ops))
51 return -ENXIO;
Takashi Iwaica2c0962005-09-09 14:20:23 +020052 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
Takashi Iwai73e77ba2005-11-17 17:44:01 +010053 if (dev == NULL) {
Takashi Iwaif2f93072014-02-04 18:21:03 +010054 dev_err(card->dev, "Cannot allocate device, type=%d\n", type);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 return -ENOMEM;
Takashi Iwai73e77ba2005-11-17 17:44:01 +010056 }
Takashi Iwai289ca022014-01-29 15:53:35 +010057 INIT_LIST_HEAD(&dev->list);
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 dev->card = card;
59 dev->type = type;
60 dev->state = SNDRV_DEV_BUILD;
61 dev->device_data = device_data;
62 dev->ops = ops;
Takashi Iwai289ca022014-01-29 15:53:35 +010063
64 /* insert the entry in an incrementally sorted list */
65 list_for_each_prev(p, &card->devices) {
66 struct snd_device *pdev = list_entry(p, struct snd_device, list);
67 if ((unsigned int)pdev->type <= (unsigned int)type)
68 break;
69 }
70
71 list_add(&dev->list, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 return 0;
73}
Takashi Iwaic0d3fb32006-04-28 15:13:39 +020074EXPORT_SYMBOL(snd_device_new);
75
Takashi Iwai72620d62014-02-04 11:36:11 +010076static int __snd_device_disconnect(struct snd_device *dev)
77{
78 if (dev->state == SNDRV_DEV_REGISTERED) {
79 if (dev->ops->dev_disconnect &&
80 dev->ops->dev_disconnect(dev))
81 dev_err(dev->card->dev, "device disconnect failure\n");
82 dev->state = SNDRV_DEV_DISCONNECTED;
83 }
84 return 0;
85}
86
87static void __snd_device_free(struct snd_device *dev)
88{
89 /* unlink */
90 list_del(&dev->list);
91
92 __snd_device_disconnect(dev);
93 if (dev->ops->dev_free) {
94 if (dev->ops->dev_free(dev))
95 dev_err(dev->card->dev, "device free failure\n");
96 }
97 kfree(dev);
98}
99
Takashi Iwai289ca022014-01-29 15:53:35 +0100100static struct snd_device *look_for_dev(struct snd_card *card, void *device_data)
101{
102 struct snd_device *dev;
103
104 list_for_each_entry(dev, &card->devices, list)
105 if (dev->device_data == device_data)
106 return dev;
107
108 return NULL;
109}
110
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111/**
112 * snd_device_free - release the device from the card
113 * @card: the card instance
114 * @device_data: the data pointer to release
115 *
116 * Removes the device from the list on the card and invokes the
Takashi Iwaic4614822006-06-23 14:38:23 +0200117 * callbacks, dev_disconnect and dev_free, corresponding to the state.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 * Then release the device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 */
Takashi Iwai72620d62014-02-04 11:36:11 +0100120void snd_device_free(struct snd_card *card, void *device_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121{
Takashi Iwai512bbd62005-11-17 13:51:18 +0100122 struct snd_device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200124 if (snd_BUG_ON(!card || !device_data))
Takashi Iwai72620d62014-02-04 11:36:11 +0100125 return;
Takashi Iwai289ca022014-01-29 15:53:35 +0100126 dev = look_for_dev(card, device_data);
Takashi Iwai72620d62014-02-04 11:36:11 +0100127 if (dev)
128 __snd_device_free(dev);
129 else
130 dev_dbg(card->dev, "device free %p (from %pF), not found\n",
131 device_data, __builtin_return_address(0));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132}
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200133EXPORT_SYMBOL(snd_device_free);
134
Takashi Iwai72620d62014-02-04 11:36:11 +0100135static int __snd_device_register(struct snd_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136{
Takashi Iwai72620d62014-02-04 11:36:11 +0100137 if (dev->state == SNDRV_DEV_BUILD) {
138 if (dev->ops->dev_register) {
139 int err = dev->ops->dev_register(dev);
140 if (err < 0)
141 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 }
Takashi Iwai72620d62014-02-04 11:36:11 +0100143 dev->state = SNDRV_DEV_REGISTERED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 }
Takashi Iwai72620d62014-02-04 11:36:11 +0100145 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146}
147
148/**
149 * snd_device_register - register the device
150 * @card: the card instance
151 * @device_data: the data pointer to register
152 *
153 * Registers the device which was already created via
154 * snd_device_new(). Usually this is called from snd_card_register(),
155 * but it can be called later if any new devices are created after
156 * invocation of snd_card_register().
157 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100158 * Return: Zero if successful, or a negative error code on failure or if the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 * device not found.
160 */
Takashi Iwai512bbd62005-11-17 13:51:18 +0100161int snd_device_register(struct snd_card *card, void *device_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162{
Takashi Iwai512bbd62005-11-17 13:51:18 +0100163 struct snd_device *dev;
Henrik Kretzschmara3352f02005-06-29 19:30:42 +0200164
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200165 if (snd_BUG_ON(!card || !device_data))
166 return -ENXIO;
Takashi Iwai289ca022014-01-29 15:53:35 +0100167 dev = look_for_dev(card, device_data);
Takashi Iwai72620d62014-02-04 11:36:11 +0100168 if (dev)
169 return __snd_device_register(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 snd_BUG();
171 return -ENXIO;
172}
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200173EXPORT_SYMBOL(snd_device_register);
174
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175/*
176 * register all the devices on the card.
177 * called from init.c
178 */
Takashi Iwai512bbd62005-11-17 13:51:18 +0100179int snd_device_register_all(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180{
Takashi Iwai512bbd62005-11-17 13:51:18 +0100181 struct snd_device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 int err;
183
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200184 if (snd_BUG_ON(!card))
185 return -ENXIO;
Johannes Berg9244b2c2006-10-05 16:02:22 +0200186 list_for_each_entry(dev, &card->devices, list) {
Takashi Iwai72620d62014-02-04 11:36:11 +0100187 err = __snd_device_register(dev);
188 if (err < 0)
189 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 }
191 return 0;
192}
193
194/*
195 * disconnect all the devices on the card.
196 * called from init.c
197 */
Takashi Iwai512bbd62005-11-17 13:51:18 +0100198int snd_device_disconnect_all(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199{
Takashi Iwai512bbd62005-11-17 13:51:18 +0100200 struct snd_device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 int err = 0;
202
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200203 if (snd_BUG_ON(!card))
204 return -ENXIO;
Takashi Iwai289ca022014-01-29 15:53:35 +0100205 list_for_each_entry_reverse(dev, &card->devices, list) {
Takashi Iwai72620d62014-02-04 11:36:11 +0100206 if (__snd_device_disconnect(dev) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 err = -ENXIO;
208 }
209 return err;
210}
211
212/*
213 * release all the devices on the card.
214 * called from init.c
215 */
Takashi Iwai72620d62014-02-04 11:36:11 +0100216void snd_device_free_all(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217{
Takashi Iwai289ca022014-01-29 15:53:35 +0100218 struct snd_device *dev, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200220 if (snd_BUG_ON(!card))
Takashi Iwai72620d62014-02-04 11:36:11 +0100221 return;
222 list_for_each_entry_safe_reverse(dev, next, &card->devices, list)
223 __snd_device_free(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224}