GNU Linux-libre 4.9.337-gnu1
[releases.git] / sound / core / misc.c
1 /*
2  *  Misc and compatibility things
3  *  Copyright (c) by Jaroslav Kysela <perex@perex.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 <linux/init.h>
23 #include <linux/export.h>
24 #include <linux/moduleparam.h>
25 #include <linux/time.h>
26 #include <linux/slab.h>
27 #include <linux/ioport.h>
28 #include <linux/fs.h>
29 #include <sound/core.h>
30
31 #ifdef CONFIG_SND_DEBUG
32
33 #ifdef CONFIG_SND_DEBUG_VERBOSE
34 #define DEFAULT_DEBUG_LEVEL     2
35 #else
36 #define DEFAULT_DEBUG_LEVEL     1
37 #endif
38
39 static int debug = DEFAULT_DEBUG_LEVEL;
40 module_param(debug, int, 0644);
41 MODULE_PARM_DESC(debug, "Debug level (0 = disable)");
42
43 #endif /* CONFIG_SND_DEBUG */
44
45 void release_and_free_resource(struct resource *res)
46 {
47         if (res) {
48                 release_resource(res);
49                 kfree(res);
50         }
51 }
52
53 EXPORT_SYMBOL(release_and_free_resource);
54
55 #ifdef CONFIG_SND_VERBOSE_PRINTK
56 /* strip the leading path if the given path is absolute */
57 static const char *sanity_file_name(const char *path)
58 {
59         if (*path == '/')
60                 return strrchr(path, '/') + 1;
61         else
62                 return path;
63 }
64 #endif
65
66 #if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
67 void __snd_printk(unsigned int level, const char *path, int line,
68                   const char *format, ...)
69 {
70         va_list args;
71 #ifdef CONFIG_SND_VERBOSE_PRINTK
72         int kern_level;
73         struct va_format vaf;
74         char verbose_fmt[] = KERN_DEFAULT "ALSA %s:%d %pV";
75 #endif
76
77 #ifdef CONFIG_SND_DEBUG
78         if (debug < level)
79                 return;
80 #endif
81
82         va_start(args, format);
83 #ifdef CONFIG_SND_VERBOSE_PRINTK
84         vaf.fmt = format;
85         vaf.va = &args;
86
87         kern_level = printk_get_level(format);
88         if (kern_level) {
89                 const char *end_of_header = printk_skip_level(format);
90                 memcpy(verbose_fmt, format, end_of_header - format);
91                 vaf.fmt = end_of_header;
92         } else if (level)
93                 memcpy(verbose_fmt, KERN_DEBUG, sizeof(KERN_DEBUG) - 1);
94         printk(verbose_fmt, sanity_file_name(path), line, &vaf);
95
96 #else
97         vprintk(format, args);
98 #endif
99         va_end(args);
100 }
101 EXPORT_SYMBOL_GPL(__snd_printk);
102 #endif
103
104 #ifdef CONFIG_PCI
105 #include <linux/pci.h>
106 /**
107  * snd_pci_quirk_lookup_id - look up a PCI SSID quirk list
108  * @vendor: PCI SSV id
109  * @device: PCI SSD id
110  * @list: quirk list, terminated by a null entry
111  *
112  * Look through the given quirk list and finds a matching entry
113  * with the same PCI SSID.  When subdevice is 0, all subdevice
114  * values may match.
115  *
116  * Returns the matched entry pointer, or NULL if nothing matched.
117  */
118 const struct snd_pci_quirk *
119 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
120                         const struct snd_pci_quirk *list)
121 {
122         const struct snd_pci_quirk *q;
123
124         for (q = list; q->subvendor; q++) {
125                 if (q->subvendor != vendor)
126                         continue;
127                 if (!q->subdevice ||
128                     (device & q->subdevice_mask) == q->subdevice)
129                         return q;
130         }
131         return NULL;
132 }
133 EXPORT_SYMBOL(snd_pci_quirk_lookup_id);
134
135 /**
136  * snd_pci_quirk_lookup - look up a PCI SSID quirk list
137  * @pci: pci_dev handle
138  * @list: quirk list, terminated by a null entry
139  *
140  * Look through the given quirk list and finds a matching entry
141  * with the same PCI SSID.  When subdevice is 0, all subdevice
142  * values may match.
143  *
144  * Returns the matched entry pointer, or NULL if nothing matched.
145  */
146 const struct snd_pci_quirk *
147 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
148 {
149         if (!pci)
150                 return NULL;
151         return snd_pci_quirk_lookup_id(pci->subsystem_vendor,
152                                        pci->subsystem_device,
153                                        list);
154 }
155 EXPORT_SYMBOL(snd_pci_quirk_lookup);
156 #endif
157
158 /*
159  * Deferred async signal helpers
160  *
161  * Below are a few helper functions to wrap the async signal handling
162  * in the deferred work.  The main purpose is to avoid the messy deadlock
163  * around tasklist_lock and co at the kill_fasync() invocation.
164  * fasync_helper() and kill_fasync() are replaced with snd_fasync_helper()
165  * and snd_kill_fasync(), respectively.  In addition, snd_fasync_free() has
166  * to be called at releasing the relevant file object.
167  */
168 struct snd_fasync {
169         struct fasync_struct *fasync;
170         int signal;
171         int poll;
172         int on;
173         struct list_head list;
174 };
175
176 static DEFINE_SPINLOCK(snd_fasync_lock);
177 static LIST_HEAD(snd_fasync_list);
178
179 static void snd_fasync_work_fn(struct work_struct *work)
180 {
181         struct snd_fasync *fasync;
182
183         spin_lock_irq(&snd_fasync_lock);
184         while (!list_empty(&snd_fasync_list)) {
185                 fasync = list_first_entry(&snd_fasync_list, struct snd_fasync, list);
186                 list_del_init(&fasync->list);
187                 spin_unlock_irq(&snd_fasync_lock);
188                 if (fasync->on)
189                         kill_fasync(&fasync->fasync, fasync->signal, fasync->poll);
190                 spin_lock_irq(&snd_fasync_lock);
191         }
192         spin_unlock_irq(&snd_fasync_lock);
193 }
194
195 static DECLARE_WORK(snd_fasync_work, snd_fasync_work_fn);
196
197 int snd_fasync_helper(int fd, struct file *file, int on,
198                       struct snd_fasync **fasyncp)
199 {
200         struct snd_fasync *fasync = NULL;
201
202         if (on) {
203                 fasync = kzalloc(sizeof(*fasync), GFP_KERNEL);
204                 if (!fasync)
205                         return -ENOMEM;
206                 INIT_LIST_HEAD(&fasync->list);
207         }
208
209         spin_lock_irq(&snd_fasync_lock);
210         if (*fasyncp) {
211                 kfree(fasync);
212                 fasync = *fasyncp;
213         } else {
214                 if (!fasync) {
215                         spin_unlock_irq(&snd_fasync_lock);
216                         return 0;
217                 }
218                 *fasyncp = fasync;
219         }
220         fasync->on = on;
221         spin_unlock_irq(&snd_fasync_lock);
222         return fasync_helper(fd, file, on, &fasync->fasync);
223 }
224 EXPORT_SYMBOL_GPL(snd_fasync_helper);
225
226 void snd_kill_fasync(struct snd_fasync *fasync, int signal, int poll)
227 {
228         unsigned long flags;
229
230         if (!fasync || !fasync->on)
231                 return;
232         spin_lock_irqsave(&snd_fasync_lock, flags);
233         fasync->signal = signal;
234         fasync->poll = poll;
235         list_move(&fasync->list, &snd_fasync_list);
236         schedule_work(&snd_fasync_work);
237         spin_unlock_irqrestore(&snd_fasync_lock, flags);
238 }
239 EXPORT_SYMBOL_GPL(snd_kill_fasync);
240
241 void snd_fasync_free(struct snd_fasync *fasync)
242 {
243         if (!fasync)
244                 return;
245         fasync->on = 0;
246         flush_work(&snd_fasync_work);
247         kfree(fasync);
248 }
249 EXPORT_SYMBOL_GPL(snd_fasync_free);