xref: /freebsd/sys/dev/sound/pcm/sound.h (revision 63613e3ba1e188e9fece43e1613bd697f04b345e)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2005-2009 Ariff Abdullah <ariff@FreeBSD.org>
5  * Copyright (c) 1999 Cameron Grant <cg@FreeBSD.org>
6  * Copyright (c) 1995 Hannu Savolainen
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 /*
32  * first, include kernel header files.
33  */
34 
35 #ifndef _OS_H_
36 #define _OS_H_
37 
38 #ifdef _KERNEL
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/eventhandler.h>
42 #include <sys/ioccom.h>
43 #include <sys/filio.h>
44 #include <sys/sockio.h>
45 #include <sys/fcntl.h>
46 #include <sys/selinfo.h>
47 #include <sys/proc.h>
48 #include <sys/kernel.h> /* for DATA_SET */
49 #include <sys/module.h>
50 #include <sys/conf.h>
51 #include <sys/file.h>
52 #include <sys/uio.h>
53 #include <sys/syslog.h>
54 #include <sys/errno.h>
55 #include <sys/malloc.h>
56 #include <sys/bus.h>
57 #include <machine/resource.h>
58 #include <machine/bus.h>
59 #include <sys/rman.h>
60 #include <sys/limits.h>
61 #include <sys/mman.h>
62 #include <sys/poll.h>
63 #include <sys/sbuf.h>
64 #include <sys/soundcard.h>
65 #include <sys/sndstat.h>
66 #include <sys/sysctl.h>
67 #include <sys/kobj.h>
68 #include <vm/vm.h>
69 #include <vm/pmap.h>
70 
71 #include <sys/lock.h>
72 #include <sys/mutex.h>
73 #include <sys/condvar.h>
74 
75 #ifndef KOBJMETHOD_END
76 #define KOBJMETHOD_END	{ NULL, NULL }
77 #endif
78 
79 struct pcm_channel;
80 struct pcm_feeder;
81 struct snd_dbuf;
82 struct snd_mixer;
83 
84 #include <dev/sound/pcm/buffer.h>
85 #include <dev/sound/pcm/matrix.h>
86 #include <dev/sound/pcm/matrix_map.h>
87 #include <dev/sound/pcm/channel.h>
88 #include <dev/sound/pcm/feeder.h>
89 #include <dev/sound/pcm/mixer.h>
90 #include <dev/sound/pcm/dsp.h>
91 #include <dev/sound/unit.h>
92 
93 #define	PCM_SOFTC_SIZE	(sizeof(struct snddev_info))
94 
95 #define SND_STATUSLEN	64
96 
97 #define SOUND_MODVER	5
98 
99 #define SOUND_MINVER	SOUND_MODVER
100 #define SOUND_PREFVER	SOUND_MODVER
101 #define SOUND_MAXVER	SOUND_MODVER
102 
103 /*
104  * We're abusing the fact that MAXMINOR still have enough room
105  * for our bit twiddling and nobody ever need 512 unique soundcards,
106  * 32 unique device types and 1024 unique cloneable devices for the
107  * next 100 years...
108  */
109 
110 #define PCMMAXUNIT		(snd_max_u())
111 #define PCMMAXDEV		(snd_max_d())
112 #define PCMMAXCHAN		(snd_max_c())
113 
114 #define PCMUNIT(x)		(snd_unit2u(dev2unit(x)))
115 #define PCMDEV(x)		(snd_unit2d(dev2unit(x)))
116 #define PCMCHAN(x)		(snd_unit2c(dev2unit(x)))
117 
118 /* XXX unit2minor compat */
119 #define PCMMINOR(x)	(x)
120 
121 /*
122  * By design, limit possible channels for each direction.
123  */
124 #define SND_MAXHWCHAN		256
125 #define SND_MAXVCHANS		SND_MAXHWCHAN
126 
127 #define SD_F_SIMPLEX		0x00000001
128 #define SD_F_AUTOVCHAN		0x00000002
129 #define SD_F_SOFTPCMVOL		0x00000004
130 #define SD_F_DYING		0x00000008
131 #define SD_F_DETACHING		0x00000010
132 #define SD_F_BUSY		0x00000020
133 #define SD_F_MPSAFE		0x00000040
134 #define SD_F_REGISTERED		0x00000080
135 #define SD_F_BITPERFECT		0x00000100
136 #define SD_F_VPC		0x00000200	/* volume-per-channel */
137 #define SD_F_EQ			0x00000400	/* EQ */
138 #define SD_F_EQ_ENABLED		0x00000800	/* EQ enabled */
139 #define SD_F_EQ_BYPASSED	0x00001000	/* EQ bypassed */
140 #define SD_F_EQ_PC		0x00002000	/* EQ per-channel */
141 
142 #define SD_F_EQ_DEFAULT		(SD_F_EQ | SD_F_EQ_ENABLED)
143 #define SD_F_EQ_MASK		(SD_F_EQ | SD_F_EQ_ENABLED |		\
144 				 SD_F_EQ_BYPASSED | SD_F_EQ_PC)
145 
146 #define SD_F_PRIO_RD		0x10000000
147 #define SD_F_PRIO_WR		0x20000000
148 #define SD_F_PRIO_SET		(SD_F_PRIO_RD | SD_F_PRIO_WR)
149 #define SD_F_DIR_SET		0x40000000
150 #define SD_F_TRANSIENT		0xf0000000
151 
152 #define SD_F_BITS		"\020"					\
153 				"\001SIMPLEX"				\
154 				"\002AUTOVCHAN"				\
155 				"\003SOFTPCMVOL"			\
156 				"\004DYING"				\
157 				"\005DETACHING"				\
158 				"\006BUSY"				\
159 				"\007MPSAFE"				\
160 				"\010REGISTERED"			\
161 				"\011BITPERFECT"			\
162 				"\012VPC"				\
163 				"\013EQ"				\
164 				"\014EQ_ENABLED"			\
165 				"\015EQ_BYPASSED"			\
166 				"\016EQ_PC"				\
167 				"\035PRIO_RD"				\
168 				"\036PRIO_WR"				\
169 				"\037DIR_SET"
170 
171 #define PCM_ALIVE(x)		((x) != NULL && (x)->lock != NULL &&	\
172 				 !((x)->flags & SD_F_DYING))
173 #define PCM_REGISTERED(x)	(PCM_ALIVE(x) &&			\
174 				 ((x)->flags & SD_F_REGISTERED))
175 
176 #define	PCM_DETACHING(x)	((x)->flags & SD_F_DETACHING)
177 
178 /* many variables should be reduced to a range. Here define a macro */
179 #define RANGE(var, low, high) (var) = \
180 	(((var)<(low))? (low) : ((var)>(high))? (high) : (var))
181 #define DSP_BUFFSIZE (8192)
182 
183 /* make figuring out what a format is easier. got AFMT_STEREO already */
184 #define AFMT_32BIT (AFMT_S32_LE | AFMT_S32_BE | AFMT_U32_LE | AFMT_U32_BE)
185 #define AFMT_24BIT (AFMT_S24_LE | AFMT_S24_BE | AFMT_U24_LE | AFMT_U24_BE)
186 #define AFMT_16BIT (AFMT_S16_LE | AFMT_S16_BE | AFMT_U16_LE | AFMT_U16_BE)
187 #define AFMT_G711  (AFMT_MU_LAW | AFMT_A_LAW)
188 #define AFMT_8BIT (AFMT_G711 | AFMT_U8 | AFMT_S8)
189 #define AFMT_SIGNED (AFMT_S32_LE | AFMT_S32_BE | AFMT_S24_LE | AFMT_S24_BE | \
190 			AFMT_S16_LE | AFMT_S16_BE | AFMT_S8)
191 #define AFMT_BIGENDIAN (AFMT_S32_BE | AFMT_U32_BE | AFMT_S24_BE | AFMT_U24_BE | \
192 			AFMT_S16_BE | AFMT_U16_BE)
193 
194 #define AFMT_CONVERTIBLE	(AFMT_8BIT | AFMT_16BIT | AFMT_24BIT |	\
195 				 AFMT_32BIT)
196 
197 /* Supported vchan mixing formats */
198 #define AFMT_VCHAN		(AFMT_CONVERTIBLE & ~AFMT_G711)
199 
200 #define AFMT_PASSTHROUGH		AFMT_AC3
201 #define AFMT_PASSTHROUGH_RATE		48000
202 #define AFMT_PASSTHROUGH_CHANNEL	2
203 #define AFMT_PASSTHROUGH_EXTCHANNEL	0
204 
205 /*
206  * We're simply using unused, contiguous bits from various AFMT_ definitions.
207  * ~(0xb00ff7ff)
208  */
209 #define AFMT_ENCODING_MASK	0xf00fffff
210 #define AFMT_CHANNEL_MASK	0x07f00000
211 #define AFMT_CHANNEL_SHIFT	20
212 #define AFMT_CHANNEL_MAX	0x7f
213 #define AFMT_EXTCHANNEL_MASK	0x08000000
214 #define AFMT_EXTCHANNEL_SHIFT	27
215 #define AFMT_EXTCHANNEL_MAX	1
216 
217 #define AFMT_ENCODING(v)	((v) & AFMT_ENCODING_MASK)
218 
219 #define AFMT_EXTCHANNEL(v)	(((v) & AFMT_EXTCHANNEL_MASK) >>	\
220 				AFMT_EXTCHANNEL_SHIFT)
221 
222 #define AFMT_CHANNEL(v)		(((v) & AFMT_CHANNEL_MASK) >>		\
223 				AFMT_CHANNEL_SHIFT)
224 
225 #define AFMT_BIT(v)		(((v) & AFMT_32BIT) ? 32 :		\
226 				(((v) & AFMT_24BIT) ? 24 :		\
227 				((((v) & AFMT_16BIT) ||			\
228 				((v) & AFMT_PASSTHROUGH)) ? 16 : 8)))
229 
230 #define AFMT_BPS(v)		(AFMT_BIT(v) >> 3)
231 #define AFMT_ALIGN(v)		(AFMT_BPS(v) * AFMT_CHANNEL(v))
232 
233 #define SND_FORMAT(f, c, e)	(AFMT_ENCODING(f) |		\
234 				(((c) << AFMT_CHANNEL_SHIFT) &		\
235 				AFMT_CHANNEL_MASK) |			\
236 				(((e) << AFMT_EXTCHANNEL_SHIFT) &	\
237 				AFMT_EXTCHANNEL_MASK))
238 
239 #define AFMT_U8_NE	AFMT_U8
240 #define AFMT_S8_NE	AFMT_S8
241 
242 #define AFMT_SIGNED_NE	(AFMT_S8_NE | AFMT_S16_NE | AFMT_S24_NE | AFMT_S32_NE)
243 
244 #define AFMT_NE		(AFMT_SIGNED_NE | AFMT_U8_NE | AFMT_U16_NE |	\
245 			 AFMT_U24_NE | AFMT_U32_NE)
246 
247 /*
248  * Minor numbers for the sound driver.
249  *
250  * Unfortunately Creative called the codec chip of SB as a DSP. For this
251  * reason the /dev/dsp is reserved for digitized audio use. There is a
252  * device for true DSP processors but it will be called something else.
253  * In v3.0 it's /dev/sndproc but this could be a temporary solution.
254  */
255 
256 #define SND_DEV_CTL	0	/* Control port /dev/mixer */
257 #define SND_DEV_SEQ	1	/* Sequencer /dev/sequencer */
258 #define SND_DEV_MIDIN	2	/* Raw midi access */
259 #define SND_DEV_DSP	3	/* Digitized voice /dev/dsp */
260 #define SND_DEV_AUDIO	4	/* Sparc compatible /dev/audio */
261 #define SND_DEV_DSP16	5	/* Like /dev/dsp but 16 bits/sample */
262 #define SND_DEV_STATUS	6	/* /dev/sndstat */
263 				/* #7 not in use now. */
264 #define SND_DEV_SEQ2	8	/* /dev/sequencer, level 2 interface */
265 #define SND_DEV_SNDPROC 9	/* /dev/sndproc for programmable devices */
266 #define SND_DEV_PSS	SND_DEV_SNDPROC /* ? */
267 #define SND_DEV_NORESET	10
268 
269 #define SND_DEV_DSPHW_PLAY	11	/* specific playback channel */
270 #define SND_DEV_DSPHW_VPLAY	12	/* specific virtual playback channel */
271 #define SND_DEV_DSPHW_REC	13	/* specific record channel */
272 #define SND_DEV_DSPHW_VREC	14	/* specific virtual record channel */
273 
274 #define SND_DEV_DSPHW_CD	15	/* s16le/stereo 44100Hz CD */
275 
276 /*
277  * OSSv4 compatible device. For now, it serve no purpose and
278  * the cloning itself will forward the request to ordinary /dev/dsp
279  * instead.
280  */
281 #define SND_DEV_DSP_MMAP	16	/* /dev/dsp_mmap     */
282 #define SND_DEV_DSP_AC3		17	/* /dev/dsp_ac3      */
283 #define SND_DEV_DSP_MULTICH	18	/* /dev/dsp_multich  */
284 #define SND_DEV_DSP_SPDIFOUT	19	/* /dev/dsp_spdifout */
285 #define SND_DEV_DSP_SPDIFIN	20	/* /dev/dsp_spdifin  */
286 
287 #define DSP_DEFAULT_SPEED	8000
288 
289 #define ON		1
290 #define OFF		0
291 
292 extern int pcm_veto_load;
293 extern int snd_unit;
294 extern int snd_maxautovchans;
295 extern int snd_verbose;
296 extern devclass_t pcm_devclass;
297 extern struct unrhdr *pcmsg_unrhdr;
298 
299 /*
300  * some macros for debugging purposes
301  * DDB/DEB to enable/disable debugging stuff
302  * BVDDB   to enable debugging when bootverbose
303  */
304 #define BVDDB(x) if (bootverbose) x
305 
306 #ifndef DEB
307 #define DEB(x)
308 #endif
309 
310 SYSCTL_DECL(_hw_snd);
311 
312 int pcm_setvchans(struct snddev_info *d, int direction, int newcnt, int num);
313 int pcm_chnalloc(struct snddev_info *d, struct pcm_channel **ch, int direction,
314     pid_t pid, char *comm, int devunit);
315 int pcm_chnrelease(struct pcm_channel *c);
316 int pcm_chnref(struct pcm_channel *c, int ref);
317 
318 struct pcm_channel *pcm_chn_create(struct snddev_info *d, struct pcm_channel *parent, kobj_class_t cls, int dir, int num, void *devinfo);
319 int pcm_chn_destroy(struct pcm_channel *ch);
320 int pcm_chn_add(struct snddev_info *d, struct pcm_channel *ch);
321 int pcm_chn_remove(struct snddev_info *d, struct pcm_channel *ch);
322 
323 int pcm_addchan(device_t dev, int dir, kobj_class_t cls, void *devinfo);
324 unsigned int pcm_getbuffersize(device_t dev, unsigned int minbufsz, unsigned int deflt, unsigned int maxbufsz);
325 int pcm_register(device_t dev, void *devinfo, int numplay, int numrec);
326 int pcm_unregister(device_t dev);
327 int pcm_setstatus(device_t dev, char *str);
328 u_int32_t pcm_getflags(device_t dev);
329 void pcm_setflags(device_t dev, u_int32_t val);
330 void *pcm_getdevinfo(device_t dev);
331 
332 int snd_setup_intr(device_t dev, struct resource *res, int flags,
333 		   driver_intr_t hand, void *param, void **cookiep);
334 
335 void *snd_mtxcreate(const char *desc, const char *type);
336 void snd_mtxfree(void *m);
337 void snd_mtxassert(void *m);
338 #define	snd_mtxlock(m) mtx_lock(m)
339 #define	snd_mtxunlock(m) mtx_unlock(m)
340 
341 typedef int (*sndstat_handler)(struct sbuf *s, device_t dev, int verbose);
342 int sndstat_register(device_t dev, char *str, sndstat_handler handler);
343 int sndstat_unregister(device_t dev);
344 
345 /* usage of flags in device config entry (config file) */
346 #define DV_F_DRQ_MASK	0x00000007	/* mask for secondary drq */
347 #define	DV_F_DUAL_DMA	0x00000010	/* set to use secondary dma channel */
348 
349 /* ought to be made obsolete but still used by mss */
350 #define	DV_F_DEV_MASK	0x0000ff00	/* force device type/class */
351 #define	DV_F_DEV_SHIFT	8		/* force device type/class */
352 
353 /*
354  * this is rather kludgey- we need to duplicate these struct def'ns from sound.c
355  * so that the macro versions of pcm_{,un}lock can dereference them.
356  * we also have to do this now makedev() has gone away.
357  */
358 
359 struct snddev_info {
360 	struct {
361 		struct {
362 			SLIST_HEAD(, pcm_channel) head;
363 			struct {
364 				SLIST_HEAD(, pcm_channel) head;
365 			} busy;
366 			struct {
367 				SLIST_HEAD(, pcm_channel) head;
368 			} opened;
369 		} pcm;
370 	} channels;
371 	unsigned devcount, playcount, reccount, pvchancount, rvchancount ;
372 	unsigned flags;
373 	unsigned int bufsz;
374 	void *devinfo;
375 	device_t dev;
376 	char status[SND_STATUSLEN];
377 	struct mtx *lock;
378 	struct cdev *mixer_dev;
379 	struct cdev *dsp_dev;
380 	uint32_t pvchanrate, pvchanformat;
381 	uint32_t rvchanrate, rvchanformat;
382 	int32_t eqpreamp;
383 	struct sysctl_ctx_list play_sysctl_ctx, rec_sysctl_ctx;
384 	struct sysctl_oid *play_sysctl_tree, *rec_sysctl_tree;
385 	struct cv cv;
386 };
387 
388 void	sound_oss_sysinfo(oss_sysinfo *);
389 int	sound_oss_card_info(oss_card_info *);
390 
391 #define	PCM_MODE_MIXER		0x01
392 #define	PCM_MODE_PLAY		0x02
393 #define	PCM_MODE_REC		0x04
394 
395 #define PCM_LOCKOWNED(d)	mtx_owned((d)->lock)
396 #define	PCM_LOCK(d)		mtx_lock((d)->lock)
397 #define	PCM_UNLOCK(d)		mtx_unlock((d)->lock)
398 #define PCM_TRYLOCK(d)		mtx_trylock((d)->lock)
399 #define PCM_LOCKASSERT(d)	mtx_assert((d)->lock, MA_OWNED)
400 #define PCM_UNLOCKASSERT(d)	mtx_assert((d)->lock, MA_NOTOWNED)
401 
402 /*
403  * For PCM_[WAIT | ACQUIRE | RELEASE], be sure to surround these
404  * with PCM_LOCK/UNLOCK() sequence, or I'll come to gnaw upon you!
405  */
406 #ifdef SND_DIAGNOSTIC
407 #define PCM_WAIT(x)		do {					\
408 	if (!PCM_LOCKOWNED(x))						\
409 		panic("%s(%d): [PCM WAIT] Mutex not owned!",		\
410 		    __func__, __LINE__);				\
411 	while ((x)->flags & SD_F_BUSY) {				\
412 		if (snd_verbose > 3)					\
413 			device_printf((x)->dev,				\
414 			    "%s(%d): [PCM WAIT] calling cv_wait().\n",	\
415 			    __func__, __LINE__);			\
416 		cv_wait(&(x)->cv, (x)->lock);				\
417 	}								\
418 } while (0)
419 
420 #define PCM_ACQUIRE(x)		do {					\
421 	if (!PCM_LOCKOWNED(x))						\
422 		panic("%s(%d): [PCM ACQUIRE] Mutex not owned!",		\
423 		    __func__, __LINE__);				\
424 	if ((x)->flags & SD_F_BUSY)					\
425 		panic("%s(%d): [PCM ACQUIRE] "				\
426 		    "Trying to acquire BUSY cv!", __func__, __LINE__);	\
427 	(x)->flags |= SD_F_BUSY;					\
428 } while (0)
429 
430 #define PCM_RELEASE(x)		do {					\
431 	if (!PCM_LOCKOWNED(x))						\
432 		panic("%s(%d): [PCM RELEASE] Mutex not owned!",		\
433 		    __func__, __LINE__);				\
434 	if ((x)->flags & SD_F_BUSY) {					\
435 		(x)->flags &= ~SD_F_BUSY;				\
436 		if ((x)->cv.cv_waiters != 0) {				\
437 			if ((x)->cv.cv_waiters > 1 && snd_verbose > 3)	\
438 				device_printf((x)->dev,			\
439 				    "%s(%d): [PCM RELEASE] "		\
440 				    "cv_waiters=%d > 1!\n",		\
441 				    __func__, __LINE__,			\
442 				    (x)->cv.cv_waiters);		\
443 			cv_broadcast(&(x)->cv);				\
444 		}							\
445 	} else								\
446 		panic("%s(%d): [PCM RELEASE] Releasing non-BUSY cv!",	\
447 		    __func__, __LINE__);				\
448 } while (0)
449 
450 /* Quick version, for shorter path. */
451 #define PCM_ACQUIRE_QUICK(x)	do {					\
452 	if (PCM_LOCKOWNED(x))						\
453 		panic("%s(%d): [PCM ACQUIRE QUICK] Mutex owned!",	\
454 		    __func__, __LINE__);				\
455 	PCM_LOCK(x);							\
456 	PCM_WAIT(x);							\
457 	PCM_ACQUIRE(x);							\
458 	PCM_UNLOCK(x);							\
459 } while (0)
460 
461 #define PCM_RELEASE_QUICK(x)	do {					\
462 	if (PCM_LOCKOWNED(x))						\
463 		panic("%s(%d): [PCM RELEASE QUICK] Mutex owned!",	\
464 		    __func__, __LINE__);				\
465 	PCM_LOCK(x);							\
466 	PCM_RELEASE(x);							\
467 	PCM_UNLOCK(x);							\
468 } while (0)
469 
470 #define PCM_BUSYASSERT(x)	do {					\
471 	if (!((x) != NULL && ((x)->flags & SD_F_BUSY)))			\
472 		panic("%s(%d): [PCM BUSYASSERT] "			\
473 		    "Failed, snddev_info=%p", __func__, __LINE__, x);	\
474 } while (0)
475 
476 #define PCM_GIANT_ENTER(x)	do {					\
477 	int _pcm_giant = 0;						\
478 	if (PCM_LOCKOWNED(x))						\
479 		panic("%s(%d): [GIANT ENTER] PCM lock owned!",		\
480 		    __func__, __LINE__);				\
481 	if (mtx_owned(&Giant) != 0 && snd_verbose > 3)			\
482 		device_printf((x)->dev,					\
483 		    "%s(%d): [GIANT ENTER] Giant owned!\n",		\
484 		    __func__, __LINE__);				\
485 	if (!((x)->flags & SD_F_MPSAFE) && mtx_owned(&Giant) == 0)	\
486 		do {							\
487 			mtx_lock(&Giant);				\
488 			_pcm_giant = 1;					\
489 		} while (0)
490 
491 #define PCM_GIANT_EXIT(x)	do {					\
492 	if (PCM_LOCKOWNED(x))						\
493 		panic("%s(%d): [GIANT EXIT] PCM lock owned!",		\
494 		    __func__, __LINE__);				\
495 	if (!(_pcm_giant == 0 || _pcm_giant == 1))			\
496 		panic("%s(%d): [GIANT EXIT] _pcm_giant screwed!",	\
497 		    __func__, __LINE__);				\
498 	if ((x)->flags & SD_F_MPSAFE) {					\
499 		if (_pcm_giant == 1)					\
500 			panic("%s(%d): [GIANT EXIT] MPSAFE Giant?",	\
501 			    __func__, __LINE__);			\
502 		if (mtx_owned(&Giant) != 0 && snd_verbose > 3)		\
503 			device_printf((x)->dev,				\
504 			    "%s(%d): [GIANT EXIT] Giant owned!\n",	\
505 			    __func__, __LINE__);			\
506 	}								\
507 	if (_pcm_giant != 0) {						\
508 		if (mtx_owned(&Giant) == 0)				\
509 			panic("%s(%d): [GIANT EXIT] Giant not owned!",	\
510 			    __func__, __LINE__);			\
511 		_pcm_giant = 0;						\
512 		mtx_unlock(&Giant);					\
513 	}								\
514 } while (0)
515 #else /* !SND_DIAGNOSTIC */
516 #define PCM_WAIT(x)		do {					\
517 	PCM_LOCKASSERT(x);						\
518 	while ((x)->flags & SD_F_BUSY)					\
519 		cv_wait(&(x)->cv, (x)->lock);				\
520 } while (0)
521 
522 #define PCM_ACQUIRE(x)		do {					\
523 	PCM_LOCKASSERT(x);						\
524 	KASSERT(!((x)->flags & SD_F_BUSY),				\
525 	    ("%s(%d): [PCM ACQUIRE] Trying to acquire BUSY cv!",	\
526 	    __func__, __LINE__));					\
527 	(x)->flags |= SD_F_BUSY;					\
528 } while (0)
529 
530 #define PCM_RELEASE(x)		do {					\
531 	PCM_LOCKASSERT(x);						\
532 	KASSERT((x)->flags & SD_F_BUSY,					\
533 	    ("%s(%d): [PCM RELEASE] Releasing non-BUSY cv!",		\
534 	    __func__, __LINE__));					\
535 	(x)->flags &= ~SD_F_BUSY;					\
536 	if ((x)->cv.cv_waiters != 0)					\
537 		cv_broadcast(&(x)->cv);					\
538 } while (0)
539 
540 /* Quick version, for shorter path. */
541 #define PCM_ACQUIRE_QUICK(x)	do {					\
542 	PCM_UNLOCKASSERT(x);						\
543 	PCM_LOCK(x);							\
544 	PCM_WAIT(x);							\
545 	PCM_ACQUIRE(x);							\
546 	PCM_UNLOCK(x);							\
547 } while (0)
548 
549 #define PCM_RELEASE_QUICK(x)	do {					\
550 	PCM_UNLOCKASSERT(x);						\
551 	PCM_LOCK(x);							\
552 	PCM_RELEASE(x);							\
553 	PCM_UNLOCK(x);							\
554 } while (0)
555 
556 #define PCM_BUSYASSERT(x)	KASSERT(x != NULL &&			\
557 				    ((x)->flags & SD_F_BUSY),		\
558 				    ("%s(%d): [PCM BUSYASSERT] "	\
559 				    "Failed, snddev_info=%p",		\
560 				    __func__, __LINE__, x))
561 
562 #define PCM_GIANT_ENTER(x)	do {					\
563 	int _pcm_giant = 0;						\
564 	PCM_UNLOCKASSERT(x);						\
565 	if (!((x)->flags & SD_F_MPSAFE) && mtx_owned(&Giant) == 0)	\
566 		do {							\
567 			mtx_lock(&Giant);				\
568 			_pcm_giant = 1;					\
569 		} while (0)
570 
571 #define PCM_GIANT_EXIT(x)	do {					\
572 	PCM_UNLOCKASSERT(x);						\
573 	KASSERT(_pcm_giant == 0 || _pcm_giant == 1,			\
574 	    ("%s(%d): [GIANT EXIT] _pcm_giant screwed!",		\
575 	    __func__, __LINE__));					\
576 	KASSERT(!((x)->flags & SD_F_MPSAFE) ||				\
577 	    (((x)->flags & SD_F_MPSAFE) && _pcm_giant == 0),		\
578 	    ("%s(%d): [GIANT EXIT] MPSAFE Giant?",			\
579 	    __func__, __LINE__));					\
580 	if (_pcm_giant != 0) {						\
581 		mtx_assert(&Giant, MA_OWNED);				\
582 		_pcm_giant = 0;						\
583 		mtx_unlock(&Giant);					\
584 	}								\
585 } while (0)
586 #endif /* SND_DIAGNOSTIC */
587 
588 #define PCM_GIANT_LEAVE(x)						\
589 	PCM_GIANT_EXIT(x);						\
590 } while (0)
591 
592 #endif /* _KERNEL */
593 
594 #endif	/* _OS_H_ */
595