2 * Copyright (c) 2005-2009 Ariff Abdullah <ariff@FreeBSD.org>
3 * Portions Copyright (c) Ryan Beasley <ryan.beasley@gmail.com> - GSoC 2006
4 * Copyright (c) 1999 Cameron Grant <cg@FreeBSD.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #ifdef HAVE_KERNEL_OPTION_HEADERS
33 #include <dev/sound/pcm/sound.h>
34 #include <sys/ctype.h>
35 #include <sys/devfs.h>
36 #include <sys/device.h>
37 #include <sys/eventhandler.h>
39 #include <sys/sysent.h>
42 #include <vm/vm_object.h>
43 #include <vm/vm_page.h>
44 #include <vm/vm_pager.h>
46 SND_DECLARE_FILE("$FreeBSD: head/sys/dev/sound/pcm/dsp.c 274035 2014-11-03 11:11:45Z bapt $");
48 static int dsp_mmap_allow_prot_exec = 0;
49 SYSCTL_INT(_hw_snd, OID_AUTO, compat_linux_mmap, CTLFLAG_RW,
50 &dsp_mmap_allow_prot_exec, 0,
51 "linux mmap compatibility (-1=force disable 0=auto 1=force enable)");
54 struct pcm_channel *rdch, *wrch;
55 struct pcm_channel *volch;
57 TAILQ_ENTRY(dsp_cdevinfo) link;
60 #define PCM_RDCH(x) (((struct dsp_cdevinfo *)(x)->si_drv1)->rdch)
61 #define PCM_WRCH(x) (((struct dsp_cdevinfo *)(x)->si_drv1)->wrch)
62 #define PCM_VOLCH(x) (((struct dsp_cdevinfo *)(x)->si_drv1)->volch)
63 #define PCM_SIMPLEX(x) (((struct dsp_cdevinfo *)(x)->si_drv1)->simplex)
65 #define DSP_CDEVINFO_CACHESIZE 8
67 #define DSP_REGISTERED(x, y) (PCM_REGISTERED(x) && \
68 (y) != NULL && (y)->si_drv1 != NULL)
72 static d_open_t dsp_open;
73 static d_close_t dsp_close;
74 static d_read_t dsp_read;
75 static d_write_t dsp_write;
76 static d_ioctl_t dsp_ioctl;
77 static d_kqfilter_t dsp_kqfilter;
78 static d_mmap_t dsp_mmap;
79 static d_mmap_single_t dsp_mmap_single;
81 static void dsp_filter_detach(struct knote *);
82 static int dsp_filter_read(struct knote *, long);
83 static int dsp_filter_write(struct knote *, long);
85 DEVFS_DEFINE_CLONE_BITMAP(dsp);
87 struct dev_ops dsp_ops = {
88 { "sound", 0, D_MPSAFE },
94 .d_kqfilter = dsp_kqfilter,
96 .d_mmap_single = dsp_mmap_single,
99 static eventhandler_tag dsp_ehtag = NULL;
100 static int dsp_umax = -1;
101 static int dsp_cmax = -1;
103 static int dsp_oss_syncgroup(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_syncgroup *group);
104 static int dsp_oss_syncstart(int sg_id);
105 static int dsp_oss_policy(struct pcm_channel *wrch, struct pcm_channel *rdch, int policy);
106 static int dsp_oss_cookedmode(struct pcm_channel *wrch, struct pcm_channel *rdch, int enabled);
107 static int dsp_oss_getchnorder(struct pcm_channel *wrch, struct pcm_channel *rdch, unsigned long long *map);
108 static int dsp_oss_setchnorder(struct pcm_channel *wrch, struct pcm_channel *rdch, unsigned long long *map);
109 static int dsp_oss_getchannelmask(struct pcm_channel *wrch, struct pcm_channel *rdch, int *mask);
110 #ifdef OSSV4_EXPERIMENT
111 static int dsp_oss_getlabel(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_label_t *label);
112 static int dsp_oss_setlabel(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_label_t *label);
113 static int dsp_oss_getsong(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_longname_t *song);
114 static int dsp_oss_setsong(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_longname_t *song);
115 static int dsp_oss_setname(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_longname_t *name);
118 static struct snddev_info *
119 dsp_get_info(struct cdev *dev)
121 return (devclass_get_softc(pcm_devclass, PCMUNIT(dev)));
125 dsp_get_flags(struct cdev *dev)
129 bdev = devclass_get_device(pcm_devclass, PCMUNIT(dev));
131 return ((bdev != NULL) ? pcm_getflags(bdev) : 0xffffffff);
135 dsp_set_flags(struct cdev *dev, uint32_t flags)
139 bdev = devclass_get_device(pcm_devclass, PCMUNIT(dev));
142 pcm_setflags(bdev, flags);
146 * return the channels associated with an open device instance.
147 * lock channels specified.
150 getchns(struct cdev *dev, struct pcm_channel **rdch, struct pcm_channel **wrch,
153 struct snddev_info *d;
154 struct pcm_channel *ch;
157 if (PCM_SIMPLEX(dev) != 0) {
158 d = dsp_get_info(dev);
159 if (!PCM_REGISTERED(d))
165 * Note: order is important -
166 * pcm flags -> prio query flags -> wild guess
169 flags = dsp_get_flags(dev);
170 if (flags & SD_F_PRIO_WR) {
172 PCM_RDCH(dev) = NULL;
173 } else if (flags & SD_F_PRIO_RD) {
175 PCM_WRCH(dev) = NULL;
176 } else if (prio & SD_F_PRIO_WR) {
178 PCM_RDCH(dev) = NULL;
179 flags |= SD_F_PRIO_WR;
180 } else if (prio & SD_F_PRIO_RD) {
182 PCM_WRCH(dev) = NULL;
183 flags |= SD_F_PRIO_RD;
184 } else if (PCM_WRCH(dev) != NULL) {
186 PCM_RDCH(dev) = NULL;
187 flags |= SD_F_PRIO_WR;
188 } else if (PCM_RDCH(dev) != NULL) {
190 PCM_WRCH(dev) = NULL;
191 flags |= SD_F_PRIO_RD;
193 PCM_SIMPLEX(dev) = 0;
194 dsp_set_flags(dev, flags);
204 *rdch = PCM_RDCH(dev);
205 *wrch = PCM_WRCH(dev);
207 if (*rdch != NULL && (prio & SD_F_PRIO_RD))
209 if (*wrch != NULL && (prio & SD_F_PRIO_WR))
215 /* unlock specified channels */
217 relchns(struct cdev *dev, struct pcm_channel *rdch, struct pcm_channel *wrch,
220 if (wrch != NULL && (prio & SD_F_PRIO_WR))
222 if (rdch != NULL && (prio & SD_F_PRIO_RD))
227 dsp_cdevinfo_alloc(struct cdev *dev,
228 struct pcm_channel *rdch, struct pcm_channel *wrch,
229 struct pcm_channel *volch)
231 struct snddev_info *d;
232 struct dsp_cdevinfo *cdi;
235 d = dsp_get_info(dev);
237 KASSERT(PCM_REGISTERED(d) && dev != NULL && dev->si_drv1 == NULL &&
238 ((rdch == NULL && wrch == NULL) || rdch != wrch),
239 ("bogus %s(), what are you trying to accomplish here?", __func__));
243 simplex = (dsp_get_flags(dev) & SD_F_SIMPLEX) ? 1 : 0;
246 * Scan for free instance entry and put it into the end of list.
247 * Create new one if necessary.
249 TAILQ_FOREACH(cdi, &d->dsp_cdevinfo_pool, link) {
255 cdi->simplex = simplex;
257 TAILQ_REMOVE(&d->dsp_cdevinfo_pool, cdi, link);
258 TAILQ_INSERT_TAIL(&d->dsp_cdevinfo_pool, cdi, link);
263 cdi = kmalloc(sizeof(*cdi), M_DEVBUF, M_WAITOK | M_ZERO);
268 cdi->simplex = simplex;
270 TAILQ_INSERT_TAIL(&d->dsp_cdevinfo_pool, cdi, link);
275 dsp_cdevinfo_free(struct cdev *dev)
277 struct snddev_info *d;
278 struct dsp_cdevinfo *cdi, *tmp;
282 d = dsp_get_info(dev);
284 KASSERT(PCM_REGISTERED(d) && dev != NULL && dev->si_drv1 != NULL &&
285 PCM_RDCH(dev) == NULL && PCM_WRCH(dev) == NULL &&
286 PCM_VOLCH(dev) == NULL,
287 ("bogus %s(), what are you trying to accomplish here?", __func__));
300 * Once it is free, move it back to the beginning of list for
301 * faster new entry allocation.
303 TAILQ_REMOVE(&d->dsp_cdevinfo_pool, cdi, link);
304 TAILQ_INSERT_HEAD(&d->dsp_cdevinfo_pool, cdi, link);
307 * Scan the list, cache free entries up to DSP_CDEVINFO_CACHESIZE.
308 * Reset simplex flags.
310 flags = dsp_get_flags(dev) & ~SD_F_PRIO_SET;
311 i = DSP_CDEVINFO_CACHESIZE;
312 TAILQ_FOREACH_MUTABLE(cdi, &d->dsp_cdevinfo_pool, link, tmp) {
313 if (cdi->busy != 0) {
314 if (cdi->simplex == 0) {
315 if (cdi->rdch != NULL)
316 flags |= SD_F_PRIO_RD;
317 if (cdi->wrch != NULL)
318 flags |= SD_F_PRIO_WR;
322 TAILQ_REMOVE(&d->dsp_cdevinfo_pool, cdi, link);
323 kfree(cdi, M_DEVBUF);
328 dsp_set_flags(dev, flags);
332 dsp_cdevinfo_init(struct snddev_info *d)
334 struct dsp_cdevinfo *cdi;
337 KASSERT(d != NULL, ("NULL snddev_info"));
341 TAILQ_INIT(&d->dsp_cdevinfo_pool);
342 for (i = 0; i < DSP_CDEVINFO_CACHESIZE; i++) {
343 cdi = kmalloc(sizeof(*cdi), M_DEVBUF, M_WAITOK | M_ZERO);
344 TAILQ_INSERT_HEAD(&d->dsp_cdevinfo_pool, cdi, link);
349 dsp_cdevinfo_flush(struct snddev_info *d)
351 struct dsp_cdevinfo *cdi, *tmp;
353 KASSERT(d != NULL, ("NULL snddev_info"));
357 cdi = TAILQ_FIRST(&d->dsp_cdevinfo_pool);
358 while (cdi != NULL) {
359 tmp = TAILQ_NEXT(cdi, link);
360 kfree(cdi, M_DEVBUF);
363 TAILQ_INIT(&d->dsp_cdevinfo_pool);
366 /* duplex / simplex cdev type */
368 DSP_CDEV_TYPE_RDONLY, /* simplex read-only (record) */
369 DSP_CDEV_TYPE_WRONLY, /* simplex write-only (play) */
370 DSP_CDEV_TYPE_RDWR /* duplex read, write, or both */
374 DSP_CDEV_VOLCTL_NONE,
375 DSP_CDEV_VOLCTL_READ,
376 DSP_CDEV_VOLCTL_WRITE
379 #define DSP_F_VALID(x) ((x) & (FREAD | FWRITE))
380 #define DSP_F_DUPLEX(x) (((x) & (FREAD | FWRITE)) == (FREAD | FWRITE))
381 #define DSP_F_SIMPLEX(x) (!DSP_F_DUPLEX(x))
382 #define DSP_F_READ(x) ((x) & FREAD)
383 #define DSP_F_WRITE(x) ((x) & FWRITE)
385 static const struct {
397 { SND_DEV_DSP, "dsp", ".", NULL, 0, 0, 0, 0,
398 SND_FORMAT(AFMT_U8, 1, 0), DSP_DEFAULT_SPEED,
399 DSP_CDEV_TYPE_RDWR },
400 { SND_DEV_AUDIO, "audio", ".", NULL, 0, 0, 0, 0,
401 SND_FORMAT(AFMT_MU_LAW, 1, 0), DSP_DEFAULT_SPEED,
402 DSP_CDEV_TYPE_RDWR },
403 { SND_DEV_DSP16, "dspW", ".", NULL, 0, 0, 0, 0,
404 SND_FORMAT(AFMT_S16_LE, 1, 0), DSP_DEFAULT_SPEED,
405 DSP_CDEV_TYPE_RDWR },
406 { SND_DEV_DSPHW_PLAY, "dsp", ".p", NULL, 1, 1, SND_MAXHWCHAN, 1,
407 SND_FORMAT(AFMT_S16_LE, 2, 0), 48000, DSP_CDEV_TYPE_WRONLY },
408 { SND_DEV_DSPHW_VPLAY, "dsp", ".vp", NULL, 1, 1, SND_MAXVCHANS, 1,
409 SND_FORMAT(AFMT_S16_LE, 2, 0), 48000, DSP_CDEV_TYPE_WRONLY },
410 { SND_DEV_DSPHW_REC, "dsp", ".r", NULL, 1, 1, SND_MAXHWCHAN, 1,
411 SND_FORMAT(AFMT_S16_LE, 2, 0), 48000, DSP_CDEV_TYPE_RDONLY },
412 { SND_DEV_DSPHW_VREC, "dsp", ".vr", NULL, 1, 1, SND_MAXVCHANS, 1,
413 SND_FORMAT(AFMT_S16_LE, 2, 0), 48000, DSP_CDEV_TYPE_RDONLY },
414 { SND_DEV_DSPHW_CD, "dspcd", ".", NULL, 0, 0, 0, 0,
415 SND_FORMAT(AFMT_S16_LE, 2, 0), 44100, DSP_CDEV_TYPE_RDWR },
416 /* Low priority, OSSv4 aliases. */
417 { SND_DEV_DSP, "dsp_ac3", ".", "dsp", 0, 0, 0, 0,
418 SND_FORMAT(AFMT_U8, 1, 0), DSP_DEFAULT_SPEED,
419 DSP_CDEV_TYPE_RDWR },
420 { SND_DEV_DSP, "dsp_mmap", ".", "dsp", 0, 0, 0, 0,
421 SND_FORMAT(AFMT_U8, 1, 0), DSP_DEFAULT_SPEED,
422 DSP_CDEV_TYPE_RDWR },
423 { SND_DEV_DSP, "dsp_multich", ".", "dsp", 0, 0, 0, 0,
424 SND_FORMAT(AFMT_U8, 1, 0), DSP_DEFAULT_SPEED,
425 DSP_CDEV_TYPE_RDWR },
426 { SND_DEV_DSP, "dsp_spdifout", ".", "dsp", 0, 0, 0, 0,
427 SND_FORMAT(AFMT_U8, 1, 0), DSP_DEFAULT_SPEED,
428 DSP_CDEV_TYPE_RDWR },
429 { SND_DEV_DSP, "dsp_spdifin", ".", "dsp", 0, 0, 0, 0,
430 SND_FORMAT(AFMT_U8, 1, 0), DSP_DEFAULT_SPEED,
431 DSP_CDEV_TYPE_RDWR },
434 #define DSP_FIXUP_ERROR() do { \
435 prio = dsp_get_flags(i_dev); \
436 if (!DSP_F_VALID(flags)) \
438 if (!DSP_F_DUPLEX(flags) && \
439 ((DSP_F_READ(flags) && d->reccount == 0) || \
440 (DSP_F_WRITE(flags) && d->playcount == 0))) \
442 else if (!DSP_F_DUPLEX(flags) && (prio & SD_F_SIMPLEX) && \
443 ((DSP_F_READ(flags) && (prio & SD_F_PRIO_WR)) || \
444 (DSP_F_WRITE(flags) && (prio & SD_F_PRIO_RD)))) \
446 else if (DSP_REGISTERED(d, i_dev)) \
451 dsp_open(struct dev_open_args *ap)
453 struct cdev *i_dev = ap->a_head.a_dev;
454 int flags = ap->a_oflags;
455 struct pcm_channel *rdch, *wrch;
456 struct snddev_info *d;
457 uint32_t fmt, spd, prio, volctl;
458 int i, error, rderror, wrerror, devtype, wdevunit, rdevunit;
460 /* Kind of impossible.. */
464 d = dsp_get_info(i_dev);
465 if (!PCM_REGISTERED(d))
470 /* Lock snddev so nobody else can monkey with it. */
475 * Try to acquire cloned device before someone else pick it.
476 * ENODEV means this is not a cloned droids.
478 error = snd_clone_acquire(i_dev);
479 if (!(error == 0 || error == ENODEV)) {
490 (void)snd_clone_release(i_dev);
497 * That is just enough. Acquire and unlock pcm lock so
498 * the other will just have to wait until we finish doing
504 devtype = PCMDEV(i_dev);
509 volctl = DSP_CDEV_VOLCTL_NONE;
511 for (i = 0; i < (sizeof(dsp_cdevs) / sizeof(dsp_cdevs[0])); i++) {
512 if (devtype != dsp_cdevs[i].type || dsp_cdevs[i].alias != NULL)
515 * Volume control only valid for DSPHW devices,
516 * and it must be opened in opposite direction be it
517 * simplex or duplex. Anything else will be handled
520 if (dsp_cdevs[i].query == DSP_CDEV_TYPE_WRONLY) {
521 if (dsp_cdevs[i].volctl != 0 &&
523 volctl = DSP_CDEV_VOLCTL_WRITE;
527 if (DSP_F_READ(flags)) {
528 (void)snd_clone_release(i_dev);
529 PCM_RELEASE_QUICK(d);
533 wdevunit = dev2unit(i_dev);
534 } else if (dsp_cdevs[i].query == DSP_CDEV_TYPE_RDONLY) {
535 if (dsp_cdevs[i].volctl != 0 &&
536 DSP_F_WRITE(flags)) {
537 volctl = DSP_CDEV_VOLCTL_READ;
541 if (DSP_F_WRITE(flags)) {
542 (void)snd_clone_release(i_dev);
543 PCM_RELEASE_QUICK(d);
547 rdevunit = dev2unit(i_dev);
549 fmt = dsp_cdevs[i].fmt;
550 spd = dsp_cdevs[i].spd;
560 * if we get here, the open request is valid- either:
561 * * we were previously not open
562 * * we were open for play xor record and the opener wants
563 * the non-open direction
565 if (DSP_F_READ(flags)) {
567 rderror = pcm_chnalloc(d, &rdch, PCMDIR_REC,
568 curproc->p_pid, curproc->p_comm, rdevunit);
570 if (rderror == 0 && chn_reset(rdch, fmt, spd) != 0)
573 if (volctl == DSP_CDEV_VOLCTL_READ)
578 pcm_chnrelease(rdch);
579 if (!DSP_F_DUPLEX(flags)) {
580 (void)snd_clone_release(i_dev);
581 PCM_RELEASE_QUICK(d);
586 } else if (volctl == DSP_CDEV_VOLCTL_READ) {
589 pcm_chnrelease(rdch);
593 rdch->flags |= CHN_F_EXCLUSIVE;
595 if (volctl == DSP_CDEV_VOLCTL_NONE)
596 chn_vpc_reset(rdch, SND_VOL_C_PCM, 0);
601 if (DSP_F_WRITE(flags)) {
603 wrerror = pcm_chnalloc(d, &wrch, PCMDIR_PLAY,
604 curproc->p_pid, curproc->p_comm, wdevunit);
606 if (wrerror == 0 && chn_reset(wrch, fmt, spd) != 0)
609 if (volctl == DSP_CDEV_VOLCTL_WRITE)
614 pcm_chnrelease(wrch);
615 if (!DSP_F_DUPLEX(flags)) {
618 * Lock, deref and release previously
619 * created record channel
622 pcm_chnref(rdch, -1);
623 pcm_chnrelease(rdch);
625 (void)snd_clone_release(i_dev);
626 PCM_RELEASE_QUICK(d);
631 } else if (volctl == DSP_CDEV_VOLCTL_WRITE) {
634 pcm_chnrelease(wrch);
638 wrch->flags |= CHN_F_EXCLUSIVE;
640 if (volctl == DSP_CDEV_VOLCTL_NONE)
641 chn_vpc_reset(wrch, SND_VOL_C_PCM, 0);
650 * We're done. Allocate channels information for this cdev.
653 case DSP_CDEV_VOLCTL_READ:
654 KASSERT(wrch == NULL, ("wrch=%p not null!", wrch));
655 dsp_cdevinfo_alloc(i_dev, NULL, NULL, rdch);
657 case DSP_CDEV_VOLCTL_WRITE:
658 KASSERT(rdch == NULL, ("rdch=%p not null!", rdch));
659 dsp_cdevinfo_alloc(i_dev, NULL, NULL, wrch);
661 case DSP_CDEV_VOLCTL_NONE:
663 if (wrch == NULL && rdch == NULL) {
664 (void)snd_clone_release(i_dev);
674 dsp_cdevinfo_alloc(i_dev, rdch, wrch, NULL);
676 CHN_INSERT_HEAD(d, rdch, channels.pcm.opened);
678 CHN_INSERT_HEAD(d, wrch, channels.pcm.opened);
683 * Increase clone refcount for its automatic garbage collector.
685 (void)snd_clone_ref(i_dev);
696 dsp_close(struct dev_close_args *ap)
698 struct cdev *i_dev = ap->a_head.a_dev;
699 struct pcm_channel *rdch, *wrch, *volch;
700 struct snddev_info *d;
701 int sg_ids, rdref, wdref;
705 * subunit is a unique number for the cloned device, it
706 * does NOT represent the virtual device channel.
708 subunit = PCMSUBUNIT(i_dev);
710 d = dsp_get_info(i_dev);
711 if (!DSP_REGISTERED(d, i_dev))
720 rdch = PCM_RDCH(i_dev);
721 wrch = PCM_WRCH(i_dev);
722 volch = PCM_VOLCH(i_dev);
724 PCM_RDCH(i_dev) = NULL;
725 PCM_WRCH(i_dev) = NULL;
726 PCM_VOLCH(i_dev) = NULL;
734 else if (volch == wrch)
738 pcm_chnref(volch, -1);
744 CHN_REMOVE(d, rdch, channels.pcm.opened);
746 CHN_REMOVE(d, wrch, channels.pcm.opened);
748 if (rdch != NULL || wrch != NULL) {
752 * The channel itself need not be locked because:
753 * a) Adding a channel to a syncgroup happens only
754 * in dsp_ioctl(), which cannot run concurrently
756 * b) The syncmember pointer (sm) is protected by
757 * the global syncgroup list lock.
758 * c) A channel can't just disappear, invalidating
759 * pointers, unless it's closed/dereferenced
763 sg_ids = chn_syncdestroy(rdch);
766 free_unr(pcmsg_unrhdr, sg_ids);
769 pcm_chnref(rdch, rdref);
770 chn_abort(rdch); /* won't sleep */
771 rdch->flags &= ~(CHN_F_RUNNING | CHN_F_MMAP |
772 CHN_F_DEAD | CHN_F_EXCLUSIVE);
773 chn_reset(rdch, 0, 0);
774 pcm_chnrelease(rdch);
778 * Please see block above.
781 sg_ids = chn_syncdestroy(wrch);
784 free_unr(pcmsg_unrhdr, sg_ids);
787 pcm_chnref(wrch, wdref);
788 chn_flush(wrch); /* may sleep */
789 wrch->flags &= ~(CHN_F_RUNNING | CHN_F_MMAP |
790 CHN_F_DEAD | CHN_F_EXCLUSIVE);
791 chn_reset(wrch, 0, 0);
792 pcm_chnrelease(wrch);
797 dsp_cdevinfo_free(i_dev);
799 * Release clone busy state and unref it so the automatic
800 * garbage collector will get the hint and do the remaining
803 (void)snd_clone_release(i_dev);
806 * destroy_dev() might sleep, so release pcm lock
807 * here and rely on pcm cv serialization.
810 (void)snd_clone_unref(i_dev);
819 * PCMCHAN(i_dev) is not the actual channel but instead is
820 * simply the unique subunit we assigned to the clone device.
822 * We do not do this here but instead do it when the clone is
826 devfs_clone_bitmap_put(&DEVFS_CLONE_BITMAP(dsp), subunit);
833 dsp_io_ops(struct cdev *i_dev, struct uio *buf, int ioflags)
835 struct snddev_info *d;
836 struct pcm_channel **ch, *rdch, *wrch;
837 int (*chn_io)(struct pcm_channel *, struct uio *, int);
841 KASSERT(i_dev != NULL && buf != NULL &&
842 (buf->uio_rw == UIO_READ || buf->uio_rw == UIO_WRITE),
843 ("%s(): io train wreck!", __func__));
845 d = dsp_get_info(i_dev);
846 if (!DSP_REGISTERED(d, i_dev))
851 switch (buf->uio_rw) {
863 panic("invalid/corrupted uio direction: %d", buf->uio_rw);
869 runpid = buf->uio_td->td_proc->p_pid;
871 getchns(i_dev, &rdch, &wrch, prio);
873 if (*ch == NULL || !((*ch)->flags & CHN_F_BUSY)) {
878 if (((*ch)->flags & (CHN_F_MMAP | CHN_F_DEAD)) ||
879 (((*ch)->flags & CHN_F_RUNNING) && (*ch)->pid != runpid)) {
880 relchns(i_dev, rdch, wrch, prio);
883 } else if (!((*ch)->flags & CHN_F_RUNNING)) {
884 (*ch)->flags |= CHN_F_RUNNING;
889 * chn_read/write must give up channel lock in order to copy bytes
890 * from/to userland, so up the "in progress" counter to make sure
891 * someone else doesn't come along and muss up the buffer.
894 ret = chn_io(*ch, buf, ioflags);
897 CHN_BROADCAST(&(*ch)->cv);
899 relchns(i_dev, rdch, wrch, prio);
907 dsp_read(struct dev_read_args *ap)
909 struct cdev *i_dev = ap->a_head.a_dev;
910 struct uio *buf = ap->a_uio;
912 return (dsp_io_ops(i_dev, buf, ap->a_ioflag));
916 dsp_write(struct dev_write_args *ap)
918 struct cdev *i_dev = ap->a_head.a_dev;
919 struct uio *buf = ap->a_uio;
921 return (dsp_io_ops(i_dev, buf, ap->a_ioflag));
925 dsp_get_volume_channel(struct cdev *dev, struct pcm_channel **volch)
927 struct snddev_info *d;
928 struct pcm_channel *c;
931 KASSERT(dev != NULL && volch != NULL,
932 ("%s(): NULL query dev=%p volch=%p", __func__, dev, volch));
934 d = dsp_get_info(dev);
935 if (!PCM_REGISTERED(d)) {
946 if (!(c->feederflags & (1 << FEEDER_VOLUME)))
956 unit = dev2unit(dev);
958 CHN_FOREACH(c, d, channels.pcm) {
960 if (c->unit != unit) {
970 return ((c->feederflags & (1 << FEEDER_VOLUME)) ? 0 : -1);
980 dsp_ioctl_channel(struct cdev *dev, struct pcm_channel *volch, u_long cmd,
983 struct snddev_info *d;
984 struct pcm_channel *rdch, *wrch;
987 d = dsp_get_info(dev);
988 if (!PCM_REGISTERED(d) || !(dsp_get_flags(dev) & SD_F_VPC))
995 rdch = PCM_RDCH(dev);
996 wrch = PCM_WRCH(dev);
998 /* No specific channel, look into cache */
1000 volch = PCM_VOLCH(dev);
1003 if (volch == NULL) {
1004 if (j == SOUND_MIXER_RECLEV && rdch != NULL)
1006 else if (j == SOUND_MIXER_PCM && wrch != NULL)
1010 devtype = PCMDEV(dev);
1012 /* Look super harder */
1013 if (volch == NULL &&
1014 (devtype == SND_DEV_DSPHW_PLAY || devtype == SND_DEV_DSPHW_VPLAY ||
1015 devtype == SND_DEV_DSPHW_REC || devtype == SND_DEV_DSPHW_VREC)) {
1016 ret = dsp_get_volume_channel(dev, &volch);
1023 /* Final validation */
1024 if (volch != NULL) {
1026 if (!(volch->feederflags & (1 << FEEDER_VOLUME))) {
1030 if (volch->direction == PCMDIR_PLAY)
1038 if (volch != NULL &&
1039 ((j == SOUND_MIXER_PCM && volch->direction == PCMDIR_PLAY) ||
1040 (j == SOUND_MIXER_RECLEV && volch->direction == PCMDIR_REC))) {
1041 if ((cmd & ~0xff) == MIXER_WRITE(0)) {
1042 int left, right, center;
1044 left = *(int *)arg & 0x7f;
1045 right = ((*(int *)arg) >> 8) & 0x7f;
1046 center = (left + right) >> 1;
1047 chn_setvolume_multi(volch, SND_VOL_C_PCM, left, right,
1049 } else if ((cmd & ~0xff) == MIXER_READ(0)) {
1050 *(int *)arg = CHN_GETVOLUME(volch,
1051 SND_VOL_C_PCM, SND_CHN_T_FL);
1052 *(int *)arg |= CHN_GETVOLUME(volch,
1053 SND_VOL_C_PCM, SND_CHN_T_FR) << 8;
1056 } else if (rdch != NULL || wrch != NULL) {
1058 case SOUND_MIXER_DEVMASK:
1059 case SOUND_MIXER_CAPS:
1060 case SOUND_MIXER_STEREODEVS:
1061 if ((cmd & ~0xff) == MIXER_READ(0)) {
1064 *(int *)arg |= SOUND_MASK_RECLEV;
1066 *(int *)arg |= SOUND_MASK_PCM;
1070 case SOUND_MIXER_RECMASK:
1071 case SOUND_MIXER_RECSRC:
1072 if ((cmd & ~0xff) == MIXER_READ(0))
1088 dsp_ioctl(struct dev_ioctl_args *ap)
1090 struct cdev *i_dev = ap->a_head.a_dev;
1091 u_long cmd = ap->a_cmd;
1092 caddr_t arg = ap->a_data;
1093 struct pcm_channel *chn, *rdch, *wrch;
1094 struct snddev_info *d;
1096 int *arg_i, ret, tmp;
1098 d = dsp_get_info(i_dev);
1099 if (!DSP_REGISTERED(d, i_dev))
1109 if (IOCGROUP(cmd) == 'M') {
1110 if (cmd == OSS_GETVERSION) {
1111 *arg_i = SOUND_VERSION;
1115 ret = dsp_ioctl_channel(i_dev, PCM_VOLCH(i_dev), cmd, arg);
1121 if (d->mixer_dev != NULL) {
1122 PCM_ACQUIRE_QUICK(d);
1123 ret = mixer_ioctl_cmd(d->mixer_dev, cmd, arg, -1,
1125 PCM_RELEASE_QUICK(d);
1135 * Certain ioctls may be made on any type of device (audio, mixer,
1136 * and MIDI). Handle those special cases here.
1138 if (IOCGROUP(cmd) == 'X') {
1139 PCM_ACQUIRE_QUICK(d);
1141 case SNDCTL_SYSINFO:
1142 sound_oss_sysinfo((oss_sysinfo *)arg);
1144 case SNDCTL_CARDINFO:
1145 ret = sound_oss_card_info((oss_card_info *)arg);
1147 case SNDCTL_AUDIOINFO:
1148 case SNDCTL_AUDIOINFO_EX:
1149 case SNDCTL_ENGINEINFO:
1150 ret = dsp_oss_audioinfo(i_dev, (oss_audioinfo *)arg);
1152 case SNDCTL_MIXERINFO:
1153 ret = mixer_oss_mixerinfo(i_dev, (oss_mixerinfo *)arg);
1158 PCM_RELEASE_QUICK(d);
1163 getchns(i_dev, &rdch, &wrch, 0);
1165 if (wrch != NULL && (wrch->flags & CHN_F_DEAD))
1167 if (rdch != NULL && (rdch->flags & CHN_F_DEAD))
1170 if (wrch == NULL && rdch == NULL) {
1178 * we start with the new ioctl interface.
1180 case AIONWRITE: /* how many bytes can write ? */
1184 if (wrch && wrch->bufhard.dl)
1185 while (chn_wrfeed(wrch) == 0);
1187 *arg_i = sndbuf_getfree(wrch->bufsoft);
1195 case AIOSSIZE: /* set the current blocksize */
1197 struct snd_size *p = (struct snd_size *)arg;
1201 PCM_ACQUIRE_QUICK(d);
1204 chn_setblocksize(wrch, 2, p->play_size);
1205 p->play_size = sndbuf_getblksz(wrch->bufsoft);
1210 chn_setblocksize(rdch, 2, p->rec_size);
1211 p->rec_size = sndbuf_getblksz(rdch->bufsoft);
1214 PCM_RELEASE_QUICK(d);
1217 case AIOGSIZE: /* get the current blocksize */
1219 struct snd_size *p = (struct snd_size *)arg;
1223 p->play_size = sndbuf_getblksz(wrch->bufsoft);
1228 p->rec_size = sndbuf_getblksz(rdch->bufsoft);
1237 snd_chan_param *p = (snd_chan_param *)arg;
1239 if (cmd == AIOSFMT &&
1240 ((p->play_format != 0 && p->play_rate == 0) ||
1241 (p->rec_format != 0 && p->rec_rate == 0))) {
1245 PCM_ACQUIRE_QUICK(d);
1248 if (cmd == AIOSFMT && p->play_format != 0) {
1250 SND_FORMAT(p->play_format,
1251 AFMT_CHANNEL(wrch->format),
1252 AFMT_EXTCHANNEL(wrch->format)));
1253 chn_setspeed(wrch, p->play_rate);
1255 p->play_rate = wrch->speed;
1256 p->play_format = AFMT_ENCODING(wrch->format);
1264 if (cmd == AIOSFMT && p->rec_format != 0) {
1266 SND_FORMAT(p->rec_format,
1267 AFMT_CHANNEL(rdch->format),
1268 AFMT_EXTCHANNEL(rdch->format)));
1269 chn_setspeed(rdch, p->rec_rate);
1271 p->rec_rate = rdch->speed;
1272 p->rec_format = AFMT_ENCODING(rdch->format);
1278 PCM_RELEASE_QUICK(d);
1282 case AIOGCAP: /* get capabilities */
1284 snd_capabilities *p = (snd_capabilities *)arg;
1285 struct pcmchan_caps *pcaps = NULL, *rcaps = NULL;
1291 rcaps = chn_getcaps(rdch);
1295 pcaps = chn_getcaps(wrch);
1297 p->rate_min = max(rcaps? rcaps->minspeed : 0,
1298 pcaps? pcaps->minspeed : 0);
1299 p->rate_max = min(rcaps? rcaps->maxspeed : 1000000,
1300 pcaps? pcaps->maxspeed : 1000000);
1301 p->bufsize = min(rdch? sndbuf_getsize(rdch->bufsoft) : 1000000,
1302 wrch? sndbuf_getsize(wrch->bufsoft) : 1000000);
1303 /* XXX bad on sb16 */
1304 p->formats = (rdch? chn_getformats(rdch) : 0xffffffff) &
1305 (wrch? chn_getformats(wrch) : 0xffffffff);
1307 p->formats |= (dsp_get_flags(i_dev) & SD_F_SIMPLEX)? 0 : AFMT_FULLDUPLEX;
1308 pdev = d->mixer_dev;
1309 p->mixers = 1; /* default: one mixer */
1310 p->inputs = pdev->si_drv1? mix_getdevs(pdev->si_drv1) : 0;
1311 p->left = p->right = 100;
1321 if (*arg_i == AIOSYNC_PLAY && wrch) {
1323 *arg_i = chn_abort(wrch);
1325 } else if (*arg_i == AIOSYNC_CAPTURE && rdch) {
1327 *arg_i = chn_abort(rdch);
1330 kprintf("AIOSTOP: bad channel 0x%x\n", *arg_i);
1336 kprintf("AIOSYNC chan 0x%03lx pos %lu unimplemented\n",
1337 ((snd_sync_parm *)arg)->chan, ((snd_sync_parm *)arg)->pos);
1341 * here follow the standard ioctls (filio.h etc.)
1343 case FIONREAD: /* get # bytes to read */
1346 /* if (rdch && rdch->bufhard.dl)
1347 while (chn_rdfeed(rdch) == 0);
1349 *arg_i = sndbuf_getready(rdch->bufsoft);
1357 case FIOASYNC: /*set/clear async i/o */
1358 DEB( kprintf("FIOASYNC\n") ; )
1361 case FIONBIO: /* set/clear non-blocking i/o */
1362 DEB( kprintf("FIONBIO\n") ; )
1365 case SNDCTL_DSP_NONBLOCK: /* set non-blocking i/o */
1366 atomic_set_int(&ap->a_fp->f_flag, FNONBLOCK);
1370 * Finally, here is the linux-compatible ioctl interface
1372 #define THE_REAL_SNDCTL_DSP_GETBLKSIZE _IOWR('P', 4, int)
1373 case THE_REAL_SNDCTL_DSP_GETBLKSIZE:
1374 case SNDCTL_DSP_GETBLKSIZE:
1375 chn = wrch ? wrch : rdch;
1378 *arg_i = sndbuf_getblksz(chn->bufsoft);
1386 case SNDCTL_DSP_SETBLKSIZE:
1387 RANGE(*arg_i, 16, 65536);
1388 PCM_ACQUIRE_QUICK(d);
1391 chn_setblocksize(wrch, 2, *arg_i);
1396 chn_setblocksize(rdch, 2, *arg_i);
1399 PCM_RELEASE_QUICK(d);
1402 case SNDCTL_DSP_RESET:
1403 DEB(kprintf("dsp reset\n"));
1418 case SNDCTL_DSP_SYNC:
1419 DEB(kprintf("dsp sync\n"));
1420 /* chn_sync may sleep */
1428 case SNDCTL_DSP_SPEED:
1429 /* chn_setspeed may sleep */
1431 PCM_ACQUIRE_QUICK(d);
1434 ret = chn_setspeed(wrch, *arg_i);
1438 if (rdch && ret == 0) {
1440 ret = chn_setspeed(rdch, *arg_i);
1445 PCM_RELEASE_QUICK(d);
1449 case SOUND_PCM_READ_RATE:
1450 chn = wrch ? wrch : rdch;
1453 *arg_i = chn->speed;
1461 case SNDCTL_DSP_STEREO:
1463 *arg_i = (*arg_i)? 2 : 1;
1464 PCM_ACQUIRE_QUICK(d);
1467 ret = chn_setformat(wrch,
1468 SND_FORMAT(wrch->format, *arg_i, 0));
1469 tmp = (AFMT_CHANNEL(wrch->format) > 1)? 1 : 0;
1472 if (rdch && ret == 0) {
1474 ret = chn_setformat(rdch,
1475 SND_FORMAT(rdch->format, *arg_i, 0));
1477 tmp = (AFMT_CHANNEL(rdch->format) > 1)? 1 : 0;
1480 PCM_RELEASE_QUICK(d);
1484 case SOUND_PCM_WRITE_CHANNELS:
1485 /* case SNDCTL_DSP_CHANNELS: ( == SOUND_PCM_WRITE_CHANNELS) */
1492 struct pcmchan_matrix *m;
1496 if (*arg_i > SND_CHN_MAX)
1497 *arg_i = SND_CHN_MAX;
1499 m = feeder_matrix_default_channel_map(*arg_i);
1505 PCM_ACQUIRE_QUICK(d);
1508 ret = chn_setformat(wrch,
1509 SND_FORMAT(wrch->format, *arg_i, ext));
1510 tmp = AFMT_CHANNEL(wrch->format);
1513 if (rdch && ret == 0) {
1515 ret = chn_setformat(rdch,
1516 SND_FORMAT(rdch->format, *arg_i, ext));
1518 tmp = AFMT_CHANNEL(rdch->format);
1521 PCM_RELEASE_QUICK(d);
1524 chn = wrch ? wrch : rdch;
1526 *arg_i = AFMT_CHANNEL(chn->format);
1531 case SOUND_PCM_READ_CHANNELS:
1532 chn = wrch ? wrch : rdch;
1535 *arg_i = AFMT_CHANNEL(chn->format);
1543 case SNDCTL_DSP_GETFMTS: /* returns a mask of supported fmts */
1544 chn = wrch ? wrch : rdch;
1547 *arg_i = chn_getformats(chn);
1555 case SNDCTL_DSP_SETFMT: /* sets _one_ format */
1556 if (*arg_i != AFMT_QUERY) {
1558 PCM_ACQUIRE_QUICK(d);
1561 ret = chn_setformat(wrch, SND_FORMAT(*arg_i,
1562 AFMT_CHANNEL(wrch->format),
1563 AFMT_EXTCHANNEL(wrch->format)));
1567 if (rdch && ret == 0) {
1569 ret = chn_setformat(rdch, SND_FORMAT(*arg_i,
1570 AFMT_CHANNEL(rdch->format),
1571 AFMT_EXTCHANNEL(rdch->format)));
1576 PCM_RELEASE_QUICK(d);
1577 *arg_i = AFMT_ENCODING(tmp);
1579 chn = wrch ? wrch : rdch;
1581 *arg_i = AFMT_ENCODING(chn->format);
1586 case SNDCTL_DSP_SETFRAGMENT:
1587 DEB(kprintf("SNDCTL_DSP_SETFRAGMENT 0x%08x\n", *(int *)arg));
1589 uint32_t fragln = (*arg_i) & 0x0000ffff;
1590 uint32_t maxfrags = ((*arg_i) & 0xffff0000) >> 16;
1592 uint32_t r_maxfrags, r_fragsz;
1594 RANGE(fragln, 4, 16);
1595 fragsz = 1 << fragln;
1598 maxfrags = CHN_2NDBUFMAXSIZE / fragsz;
1601 if (maxfrags * fragsz > CHN_2NDBUFMAXSIZE)
1602 maxfrags = CHN_2NDBUFMAXSIZE / fragsz;
1604 DEB(kprintf("SNDCTL_DSP_SETFRAGMENT %d frags, %d sz\n", maxfrags, fragsz));
1605 PCM_ACQUIRE_QUICK(d);
1608 ret = chn_setblocksize(rdch, maxfrags, fragsz);
1609 r_maxfrags = sndbuf_getblkcnt(rdch->bufsoft);
1610 r_fragsz = sndbuf_getblksz(rdch->bufsoft);
1613 r_maxfrags = maxfrags;
1616 if (wrch && ret == 0) {
1618 ret = chn_setblocksize(wrch, maxfrags, fragsz);
1619 maxfrags = sndbuf_getblkcnt(wrch->bufsoft);
1620 fragsz = sndbuf_getblksz(wrch->bufsoft);
1622 } else { /* use whatever came from the read channel */
1623 maxfrags = r_maxfrags;
1626 PCM_RELEASE_QUICK(d);
1629 while (fragsz > 1) {
1633 *arg_i = (maxfrags << 16) | fragln;
1637 case SNDCTL_DSP_GETISPACE:
1638 /* return the size of data available in the input queue */
1640 audio_buf_info *a = (audio_buf_info *)arg;
1642 struct snd_dbuf *bs = rdch->bufsoft;
1645 a->bytes = sndbuf_getready(bs);
1646 a->fragments = a->bytes / sndbuf_getblksz(bs);
1647 a->fragstotal = sndbuf_getblkcnt(bs);
1648 a->fragsize = sndbuf_getblksz(bs);
1655 case SNDCTL_DSP_GETOSPACE:
1656 /* return space available in the output queue */
1658 audio_buf_info *a = (audio_buf_info *)arg;
1660 struct snd_dbuf *bs = wrch->bufsoft;
1663 /* XXX abusive DMA update: chn_wrupdate(wrch); */
1664 a->bytes = sndbuf_getfree(bs);
1665 a->fragments = a->bytes / sndbuf_getblksz(bs);
1666 a->fragstotal = sndbuf_getblkcnt(bs);
1667 a->fragsize = sndbuf_getblksz(bs);
1674 case SNDCTL_DSP_GETIPTR:
1676 count_info *a = (count_info *)arg;
1678 struct snd_dbuf *bs = rdch->bufsoft;
1681 /* XXX abusive DMA update: chn_rdupdate(rdch); */
1682 a->bytes = sndbuf_gettotal(bs);
1683 a->blocks = sndbuf_getblocks(bs) - rdch->blocks;
1684 a->ptr = sndbuf_getfreeptr(bs);
1685 rdch->blocks = sndbuf_getblocks(bs);
1692 case SNDCTL_DSP_GETOPTR:
1694 count_info *a = (count_info *)arg;
1696 struct snd_dbuf *bs = wrch->bufsoft;
1699 /* XXX abusive DMA update: chn_wrupdate(wrch); */
1700 a->bytes = sndbuf_gettotal(bs);
1701 a->blocks = sndbuf_getblocks(bs) - wrch->blocks;
1702 a->ptr = sndbuf_getreadyptr(bs);
1703 wrch->blocks = sndbuf_getblocks(bs);
1710 case SNDCTL_DSP_GETCAPS:
1712 *arg_i = PCM_CAP_REALTIME | PCM_CAP_MMAP | PCM_CAP_TRIGGER;
1713 if (rdch && wrch && !(dsp_get_flags(i_dev) & SD_F_SIMPLEX))
1714 *arg_i |= PCM_CAP_DUPLEX;
1718 case SOUND_PCM_READ_BITS:
1719 chn = wrch ? wrch : rdch;
1722 if (chn->format & AFMT_8BIT)
1724 else if (chn->format & AFMT_16BIT)
1726 else if (chn->format & AFMT_24BIT)
1728 else if (chn->format & AFMT_32BIT)
1739 case SNDCTL_DSP_SETTRIGGER:
1742 rdch->flags &= ~CHN_F_NOTRIGGER;
1743 if (*arg_i & PCM_ENABLE_INPUT)
1748 rdch->flags |= CHN_F_NOTRIGGER;
1754 wrch->flags &= ~CHN_F_NOTRIGGER;
1755 if (*arg_i & PCM_ENABLE_OUTPUT)
1760 wrch->flags |= CHN_F_NOTRIGGER;
1766 case SNDCTL_DSP_GETTRIGGER:
1770 if (wrch->flags & CHN_F_TRIGGERED)
1771 *arg_i |= PCM_ENABLE_OUTPUT;
1776 if (rdch->flags & CHN_F_TRIGGERED)
1777 *arg_i |= PCM_ENABLE_INPUT;
1782 case SNDCTL_DSP_GETODELAY:
1784 struct snd_dbuf *bs = wrch->bufsoft;
1787 /* XXX abusive DMA update: chn_wrupdate(wrch); */
1788 *arg_i = sndbuf_getready(bs);
1794 case SNDCTL_DSP_POST:
1797 wrch->flags &= ~CHN_F_NOTRIGGER;
1803 case SNDCTL_DSP_SETDUPLEX:
1805 * switch to full-duplex mode if card is in half-duplex
1806 * mode and is able to work in full-duplex mode
1809 if (rdch && wrch && (dsp_get_flags(i_dev) & SD_F_SIMPLEX))
1810 dsp_set_flags(i_dev, dsp_get_flags(i_dev)^SD_F_SIMPLEX);
1815 * The following four ioctls are simple wrappers around mixer_ioctl
1816 * with no further processing. xcmd is short for "translated
1819 case SNDCTL_DSP_GETRECVOL:
1821 xcmd = SOUND_MIXER_READ_RECLEV;
1825 case SNDCTL_DSP_SETRECVOL:
1827 xcmd = SOUND_MIXER_WRITE_RECLEV;
1831 case SNDCTL_DSP_GETPLAYVOL:
1833 xcmd = SOUND_MIXER_READ_PCM;
1837 case SNDCTL_DSP_SETPLAYVOL:
1839 xcmd = SOUND_MIXER_WRITE_PCM;
1843 ret = dsp_ioctl_channel(i_dev, chn, xcmd, arg);
1849 if (d->mixer_dev != NULL) {
1850 PCM_ACQUIRE_QUICK(d);
1851 ret = mixer_ioctl_cmd(d->mixer_dev, xcmd, arg, -1,
1853 PCM_RELEASE_QUICK(d);
1859 case SNDCTL_DSP_GET_RECSRC_NAMES:
1860 case SNDCTL_DSP_GET_RECSRC:
1861 case SNDCTL_DSP_SET_RECSRC:
1862 if (d->mixer_dev != NULL) {
1863 PCM_ACQUIRE_QUICK(d);
1864 ret = mixer_ioctl_cmd(d->mixer_dev, cmd, arg, -1,
1866 PCM_RELEASE_QUICK(d);
1872 * The following 3 ioctls aren't very useful at the moment. For
1873 * now, only a single channel is associated with a cdev (/dev/dspN
1874 * instance), so there's only a single output routing to use (i.e.,
1875 * the wrch bound to this cdev).
1877 case SNDCTL_DSP_GET_PLAYTGT_NAMES:
1879 oss_mixer_enuminfo *ei;
1880 ei = (oss_mixer_enuminfo *)arg;
1883 ei->version = 0; /* static for now */
1884 ei->strindex[0] = 0;
1888 strlcpy(ei->strings, wrch->name,
1889 sizeof(ei->strings));
1892 ei->strings[0] = '\0';
1896 case SNDCTL_DSP_GET_PLAYTGT:
1897 case SNDCTL_DSP_SET_PLAYTGT: /* yes, they are the same for now */
1900 * OSSv4: "The value that was accepted by the device will
1901 * be returned back in the variable pointed by the
1910 case SNDCTL_DSP_SILENCE:
1912 * Flush the software (pre-feed) buffer, but try to minimize playback
1913 * interruption. (I.e., record unplayed samples with intent to
1914 * restore by SNDCTL_DSP_SKIP.) Intended for application "pause"
1920 struct snd_dbuf *bs;
1922 while (wrch->inprog != 0)
1923 cv_wait(&wrch->cv, wrch->lock);
1925 if ((bs->shadbuf != NULL) && (sndbuf_getready(bs) > 0)) {
1926 bs->sl = sndbuf_getready(bs);
1927 sndbuf_dispose(bs, bs->shadbuf, sndbuf_getready(bs));
1928 sndbuf_fillsilence(bs);
1935 case SNDCTL_DSP_SKIP:
1937 * OSSv4 docs: "This ioctl call discards all unplayed samples in the
1938 * playback buffer by moving the current write position immediately
1939 * before the point where the device is currently reading the samples."
1944 struct snd_dbuf *bs;
1946 while (wrch->inprog != 0)
1947 cv_wait(&wrch->cv, wrch->lock);
1949 if ((bs->shadbuf != NULL) && (bs->sl > 0)) {
1950 sndbuf_softreset(bs);
1951 sndbuf_acquire(bs, bs->shadbuf, bs->sl);
1959 case SNDCTL_DSP_CURRENT_OPTR:
1960 case SNDCTL_DSP_CURRENT_IPTR:
1962 * @note Changing formats resets the buffer counters, which differs
1963 * from the 4Front drivers. However, I don't expect this to be
1964 * much of a problem.
1966 * @note In a test where @c CURRENT_OPTR is called immediately after write
1967 * returns, this driver is about 32K samples behind whereas
1968 * 4Front's is about 8K samples behind. Should determine source
1969 * of discrepancy, even if only out of curiosity.
1971 * @todo Actually test SNDCTL_DSP_CURRENT_IPTR.
1973 chn = (cmd == SNDCTL_DSP_CURRENT_OPTR) ? wrch : rdch;
1977 struct snd_dbuf *bs;
1980 oss_count_t *oc = (oss_count_t *)arg;
1985 tmp = (sndbuf_getsize(b) + chn_getptr(chn) - sndbuf_gethwptr(b)) % sndbuf_getsize(b);
1986 oc->samples = (sndbuf_gettotal(b) + tmp) / sndbuf_getalign(b);
1987 oc->fifo_samples = (sndbuf_getready(b) - tmp) / sndbuf_getalign(b);
1989 oc->samples = sndbuf_gettotal(bs) / sndbuf_getalign(bs);
1990 oc->fifo_samples = sndbuf_getready(bs) / sndbuf_getalign(bs);
1996 case SNDCTL_DSP_HALT_OUTPUT:
1997 case SNDCTL_DSP_HALT_INPUT:
1998 chn = (cmd == SNDCTL_DSP_HALT_OUTPUT) ? wrch : rdch;
2008 case SNDCTL_DSP_LOW_WATER:
2010 * Set the number of bytes required to attract attention by
2015 wrch->lw = (*arg_i > 1) ? *arg_i : 1;
2020 rdch->lw = (*arg_i > 1) ? *arg_i : 1;
2025 case SNDCTL_DSP_GETERROR:
2027 * OSSv4 docs: "All errors and counters will automatically be
2028 * cleared to zeroes after the call so each call will return only
2029 * the errors that occurred after the previous invocation. ... The
2030 * play_underruns and rec_overrun fields are the only useful fields
2031 * returned by OSS 4.0."
2034 audio_errinfo *ei = (audio_errinfo *)arg;
2036 bzero((void *)ei, sizeof(*ei));
2040 ei->play_underruns = wrch->xruns;
2046 ei->rec_overruns = rdch->xruns;
2053 case SNDCTL_DSP_SYNCGROUP:
2054 PCM_ACQUIRE_QUICK(d);
2055 ret = dsp_oss_syncgroup(wrch, rdch, (oss_syncgroup *)arg);
2056 PCM_RELEASE_QUICK(d);
2059 case SNDCTL_DSP_SYNCSTART:
2060 PCM_ACQUIRE_QUICK(d);
2061 ret = dsp_oss_syncstart(*arg_i);
2062 PCM_RELEASE_QUICK(d);
2065 case SNDCTL_DSP_POLICY:
2066 PCM_ACQUIRE_QUICK(d);
2067 ret = dsp_oss_policy(wrch, rdch, *arg_i);
2068 PCM_RELEASE_QUICK(d);
2071 case SNDCTL_DSP_COOKEDMODE:
2072 PCM_ACQUIRE_QUICK(d);
2073 if (!(dsp_get_flags(i_dev) & SD_F_BITPERFECT))
2074 ret = dsp_oss_cookedmode(wrch, rdch, *arg_i);
2075 PCM_RELEASE_QUICK(d);
2077 case SNDCTL_DSP_GET_CHNORDER:
2078 PCM_ACQUIRE_QUICK(d);
2079 ret = dsp_oss_getchnorder(wrch, rdch, (unsigned long long *)arg);
2080 PCM_RELEASE_QUICK(d);
2082 case SNDCTL_DSP_SET_CHNORDER:
2083 PCM_ACQUIRE_QUICK(d);
2084 ret = dsp_oss_setchnorder(wrch, rdch, (unsigned long long *)arg);
2085 PCM_RELEASE_QUICK(d);
2087 case SNDCTL_DSP_GETCHANNELMASK: /* XXX vlc */
2088 PCM_ACQUIRE_QUICK(d);
2089 ret = dsp_oss_getchannelmask(wrch, rdch, (int *)arg);
2090 PCM_RELEASE_QUICK(d);
2092 case SNDCTL_DSP_BIND_CHANNEL: /* XXX what?!? */
2095 #ifdef OSSV4_EXPERIMENT
2097 * XXX The following ioctls are not yet supported and just return
2100 case SNDCTL_DSP_GETOPEAKS:
2101 case SNDCTL_DSP_GETIPEAKS:
2102 chn = (cmd == SNDCTL_DSP_GETOPEAKS) ? wrch : rdch;
2106 oss_peaks_t *op = (oss_peaks_t *)arg;
2110 ret = chn_getpeaks(chn, &lpeak, &rpeak);
2122 * XXX Once implemented, revisit this for proper cv protection
2125 case SNDCTL_GETLABEL:
2126 ret = dsp_oss_getlabel(wrch, rdch, (oss_label_t *)arg);
2128 case SNDCTL_SETLABEL:
2129 ret = dsp_oss_setlabel(wrch, rdch, (oss_label_t *)arg);
2131 case SNDCTL_GETSONG:
2132 ret = dsp_oss_getsong(wrch, rdch, (oss_longname_t *)arg);
2134 case SNDCTL_SETSONG:
2135 ret = dsp_oss_setsong(wrch, rdch, (oss_longname_t *)arg);
2137 case SNDCTL_SETNAME:
2138 ret = dsp_oss_setname(wrch, rdch, (oss_longname_t *)arg);
2142 * @note The S/PDIF interface ioctls, @c SNDCTL_DSP_READCTL and
2143 * @c SNDCTL_DSP_WRITECTL have been omitted at the suggestion of
2144 * 4Front Technologies.
2146 case SNDCTL_DSP_READCTL:
2147 case SNDCTL_DSP_WRITECTL:
2150 #endif /* !0 (explicitly omitted ioctls) */
2152 #endif /* !OSSV4_EXPERIMENT */
2153 case SNDCTL_DSP_MAPINBUF:
2154 case SNDCTL_DSP_MAPOUTBUF:
2155 case SNDCTL_DSP_SETSYNCRO:
2158 case SNDCTL_DSP_SUBDIVIDE:
2159 case SOUND_PCM_WRITE_FILTER:
2160 case SOUND_PCM_READ_FILTER:
2161 /* dunno what these do, don't sound important */
2164 DEB(kprintf("default ioctl fn 0x%08lx fail\n", cmd));
2174 static struct filterops dsp_read_filtops =
2175 { FILTEROP_ISFD, NULL, dsp_filter_detach, dsp_filter_read };
2176 static struct filterops dsp_write_filtops =
2177 { FILTEROP_ISFD, NULL, dsp_filter_detach, dsp_filter_write };
2180 /*dsp_poll(struct cdev *i_dev, int events, struct thread *td)*/
2181 dsp_kqfilter(struct dev_kqfilter_args *ap)
2183 struct knote *kn = ap->a_kn;
2184 struct klist *klist;
2185 struct cdev *i_dev = ap->a_head.a_dev;
2186 struct snddev_info *d;
2187 struct pcm_channel *wrch, *rdch;
2188 struct snd_dbuf *bs = NULL;
2191 d = dsp_get_info(i_dev);
2192 if (!DSP_REGISTERED(d, i_dev))
2201 getchns(i_dev, &rdch, &wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2203 switch (kn->kn_filter) {
2206 kn->kn_fop = &dsp_read_filtops;
2207 kn->kn_hook = (caddr_t)rdch;
2214 kn->kn_fop = &dsp_write_filtops;
2215 kn->kn_hook = (caddr_t)wrch;
2221 ap->a_result = EOPNOTSUPP;
2225 if (ap->a_result == 0) {
2226 klist = &sndbuf_getkq(bs)->ki_note;
2227 knote_insert(klist, kn);
2230 relchns(i_dev, rdch, wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2238 dsp_filter_detach(struct knote *kn)
2240 struct pcm_channel *ch = (struct pcm_channel *)kn->kn_hook;
2241 struct snd_dbuf *bs = ch->bufsoft;
2242 struct klist *klist;
2245 klist = &sndbuf_getkq(bs)->ki_note;
2246 knote_remove(klist, kn);
2251 dsp_filter_read(struct knote *kn, long hint)
2253 struct pcm_channel *rdch = (struct pcm_channel *)kn->kn_hook;
2254 struct thread *td = curthread;
2258 ready = chn_poll(rdch, 1, td);
2265 dsp_filter_write(struct knote *kn, long hint)
2267 struct pcm_channel *wrch = (struct pcm_channel *)kn->kn_hook;
2268 struct thread *td = curthread;
2272 ready = chn_poll(wrch, 1, td);
2279 dsp_mmap(struct dev_mmap_args *ap)
2281 vm_offset_t offset = ap->a_offset;
2283 /* XXX memattr is not honored */
2284 ap->a_result = vtophys(offset);
2289 dsp_mmap_single(struct dev_mmap_single_args *ap)
2291 struct cdev *i_dev = ap->a_head.a_dev;
2292 vm_ooffset_t *offset = ap->a_offset;
2293 vm_size_t size = ap->a_size;
2294 struct vm_object **object = ap->a_object;
2295 int nprot = ap->a_nprot;
2296 struct snddev_info *d;
2297 struct pcm_channel *wrch, *rdch, *c;
2300 * Reject PROT_EXEC by default. It just doesn't makes sense.
2301 * Unfortunately, we have to give up this one due to linux_mmap
2304 * http://lists.freebsd.org/pipermail/freebsd-emulation/2007-June/003698.html
2308 if ((nprot & PROT_EXEC) && (dsp_mmap_allow_prot_exec < 0 ||
2309 (dsp_mmap_allow_prot_exec == 0 &&
2310 SV_CURPROC_ABI() != SV_ABI_LINUX)))
2312 if ((nprot & PROT_EXEC) && dsp_mmap_allow_prot_exec < 1)
2317 * PROT_READ (alone) selects the input buffer.
2318 * PROT_WRITE (alone) selects the output buffer.
2319 * PROT_WRITE|PROT_READ together select the output buffer.
2321 if ((nprot & (PROT_READ | PROT_WRITE)) == 0)
2324 d = dsp_get_info(i_dev);
2325 if (!DSP_REGISTERED(d, i_dev))
2330 getchns(i_dev, &rdch, &wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2332 c = ((nprot & PROT_WRITE) != 0) ? wrch : rdch;
2333 if (c == NULL || (c->flags & CHN_F_MMAP_INVALID) ||
2334 (*offset + size) > sndbuf_getsize(c->bufsoft) ||
2335 (wrch != NULL && (wrch->flags & CHN_F_MMAP_INVALID)) ||
2336 (rdch != NULL && (rdch->flags & CHN_F_MMAP_INVALID))) {
2337 relchns(i_dev, rdch, wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2343 wrch->flags |= CHN_F_MMAP;
2345 rdch->flags |= CHN_F_MMAP;
2347 *offset = (uintptr_t)sndbuf_getbufofs(c->bufsoft, *offset);
2348 relchns(i_dev, rdch, wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2349 *object = dev_pager_alloc(i_dev, size, nprot, *offset);
2353 if (*object == NULL)
2359 * for i = 0 to channels of device N
2360 * if dspN.i isn't busy and in the right dir, create a dev_t and return it
2363 dsp_clone(struct dev_clone_args *ap)
2365 struct cdev *i_dev = ap->a_head.a_dev;
2366 struct snddev_info *d;
2367 struct snd_clone_entry *ce;
2368 struct pcm_channel *c;
2369 int i, unit, udcmask, cunit, devtype, devhw, devcmax, tumax;
2373 static struct cdev *dev = NULL;
2375 KASSERT(dsp_umax >= 0 && dsp_cmax >= 0, ("Uninitialized unit!"));
2378 * The default dsp device has a special unit which must be adjusted,
2379 * otherwise the unit number is already correct.
2381 unit = PCMUNIT(i_dev);
2382 if (unit == PCMUNIT_DEFAULT)
2385 ksnprintf(sname, sizeof(sname), "%s", ap->a_name);
2386 len = strlen(sname);
2387 while (len && sname[len-1] >= '0' && sname[len-1] <= '9')
2397 for (i = 0; i < sizeof(dsp_cdevs) / sizeof(dsp_cdevs[0]); ++i) {
2398 if (strcmp(dsp_cdevs[i].name, sname) != 0)
2400 devtype = dsp_cdevs[i].type;
2401 devhw = dsp_cdevs[i].hw;
2402 devcmax = dsp_cdevs[i].max - 1;
2406 d = devclass_get_softc(pcm_devclass, unit);
2407 if (!PCM_REGISTERED(d) || d->clones == NULL) {
2411 /* XXX Need Giant magic entry ??? */
2414 if (snd_clone_disabled(d->clones)) {
2423 udcmask = snd_u2unit(unit) | snd_d2unit(devtype);
2426 KASSERT(devcmax <= dsp_cmax,
2427 ("overflow: devcmax=%d, dsp_cmax=%d", devcmax, dsp_cmax));
2428 if (cunit > devcmax) {
2429 PCM_RELEASE_QUICK(d);
2432 udcmask |= snd_c2unit(cunit);
2433 CHN_FOREACH(c, d, channels.pcm) {
2435 if (c->unit != udcmask) {
2440 udcmask &= ~snd_c2unit(cunit);
2442 * Temporarily increase clone maxunit to overcome
2443 * vchan flexibility.
2445 * # sysctl dev.pcm.0.play.vchans=256
2446 * dev.pcm.0.play.vchans: 1 -> 256
2447 * # cat /dev/zero > /dev/dsp0.vp255 &
2449 * # sysctl dev.pcm.0.play.vchans=0
2450 * dev.pcm.0.play.vchans: 256 -> 1
2452 * [1] + running cat /dev/zero > /dev/dsp0.vp255
2454 * # cat /dev/zero > /dev/dsp0.vp255
2455 * zsh: operation not supported: /dev/dsp0.vp255
2457 tumax = snd_clone_getmaxunit(d->clones);
2459 snd_clone_setmaxunit(d->clones, cunit);
2462 goto dsp_clone_alloc;
2465 * Ok, so we're requesting unallocated vchan, but still
2466 * within maximum vchan limit.
2468 if (((devtype == SND_DEV_DSPHW_VPLAY && d->pvchancount > 0) ||
2469 (devtype == SND_DEV_DSPHW_VREC && d->rvchancount > 0)) &&
2470 cunit < snd_maxautovchans) {
2471 udcmask &= ~snd_c2unit(cunit);
2472 tumax = snd_clone_getmaxunit(d->clones);
2474 snd_clone_setmaxunit(d->clones, cunit);
2477 goto dsp_clone_alloc;
2479 PCM_RELEASE_QUICK(d);
2484 * Allocate channel, create device if necessary.
2487 ce = snd_clone_alloc(d->clones, &dev, &cunit, udcmask);
2489 snd_clone_setmaxunit(d->clones, tumax);
2492 * NOTE: Subunit is a unique number unrelated to the
2495 udcmask |= snd_c2unit(cunit);
2496 int subunit = devfs_clone_bitmap_get(&DEVFS_CLONE_BITMAP(dsp), 0);
2498 dev = make_only_dev(&dsp_ops,
2499 PCMMKMINOR(unit, devtype, subunit),
2500 UID_ROOT, GID_WHEEL, 0666, "%s%d.%d",
2501 sname, unit, subunit);
2502 snd_clone_register(ce, dev);
2506 * Use device already registered, we must add a ref to the
2514 PCM_RELEASE_QUICK(d);
2520 dsp_sysinit(void *p)
2522 if (dsp_ehtag != NULL)
2524 /* initialize unit numbering */
2526 dsp_umax = PCMMAXUNIT;
2527 dsp_cmax = PCMMAXCHAN;
2528 dsp_ehtag = EVENTHANDLER_REGISTER(dev_clone, dsp_clone, 0, 1000);
2530 devfs_clone_bitmap_init(&DEVFS_CLONE_BITMAP(dsp));
2534 dsp_sysuninit(void *p)
2536 if (dsp_ehtag == NULL)
2538 EVENTHANDLER_DEREGISTER(dev_clone, dsp_ehtag);
2542 SYSINIT(dsp_sysinit, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, dsp_sysinit, NULL);
2543 SYSUNINIT(dsp_sysuninit, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, dsp_sysuninit, NULL);
2546 dsp_unit2name(char *buf, size_t len, int unit)
2550 KASSERT(buf != NULL && len != 0,
2551 ("bogus buf=%p len=%ju", buf, (uintmax_t)len));
2553 dtype = snd_unit2d(unit);
2555 for (i = 0; i < (sizeof(dsp_cdevs) / sizeof(dsp_cdevs[0])); i++) {
2556 if (dtype != dsp_cdevs[i].type || dsp_cdevs[i].alias != NULL)
2558 ksnprintf(buf, len, "%s%d%s%d", dsp_cdevs[i].name,
2559 snd_unit2u(unit), dsp_cdevs[i].sep, snd_unit2c(unit));
2567 * @brief Handler for SNDCTL_AUDIOINFO.
2569 * Gathers information about the audio device specified in ai->dev. If
2570 * ai->dev == -1, then this function gathers information about the current
2571 * device. If the call comes in on a non-audio device and ai->dev == -1,
2574 * This routine is supposed to go practically straight to the hardware,
2575 * getting capabilities directly from the sound card driver, side-stepping
2576 * the intermediate channel interface.
2578 * Note, however, that the usefulness of this command is significantly
2579 * decreased when requesting info about any device other than the one serving
2580 * the request. While each snddev_channel refers to a specific device node,
2581 * the converse is *not* true. Currently, when a sound device node is opened,
2582 * the sound subsystem scans for an available audio channel (or channels, if
2583 * opened in read+write) and then assigns them to the si_drv[12] private
2584 * data fields. As a result, any information returned linking a channel to
2585 * a specific character device isn't necessarily accurate.
2588 * Calling threads must not hold any snddev_info or pcm_channel locks.
2590 * @param dev device on which the ioctl was issued
2591 * @param ai ioctl request data container
2594 * @retval EINVAL ai->dev specifies an invalid device
2596 * @todo Verify correctness of Doxygen tags. ;)
2599 dsp_oss_audioinfo(struct cdev *i_dev, oss_audioinfo *ai)
2601 struct pcmchan_caps *caps;
2602 struct pcm_channel *ch;
2603 struct snddev_info *d;
2605 int i, nchan, *rates, minch, maxch;
2606 char *devname, buf[CHN_NAMELEN];
2609 * If probing the device that received the ioctl, make sure it's a
2610 * DSP device. (Users may use this ioctl with /dev/mixer and
2613 if (ai->dev == -1 && i_dev->si_ops != &dsp_ops)
2619 bzero(buf, sizeof(buf));
2622 * Search for the requested audio device (channel). Start by
2623 * iterating over pcm devices.
2625 for (i = 0; pcm_devclass != NULL &&
2626 i < devclass_get_maxunit(pcm_devclass); i++) {
2627 d = devclass_get_softc(pcm_devclass, i);
2628 if (!PCM_REGISTERED(d))
2631 /* XXX Need Giant magic entry ??? */
2633 /* See the note in function docblock */
2634 PCM_UNLOCKASSERT(d);
2637 CHN_FOREACH(ch, d, channels.pcm) {
2638 CHN_UNLOCKASSERT(ch);
2640 if (ai->dev == -1) {
2641 if (DSP_REGISTERED(d, i_dev) &&
2642 (ch == PCM_RDCH(i_dev) || /* record ch */
2643 ch == PCM_WRCH(i_dev))) { /* playback ch */
2644 devname = dsp_unit2name(buf,
2645 sizeof(buf), ch->unit);
2647 } else if (ai->dev == nchan) {
2648 devname = dsp_unit2name(buf, sizeof(buf),
2651 if (devname != NULL)
2657 if (devname != NULL) {
2659 * At this point, the following synchronization stuff
2661 * - a specific PCM device is locked.
2662 * - a specific audio channel has been locked, so be
2663 * sure to unlock when exiting;
2666 caps = chn_getcaps(ch);
2669 * With all handles collected, zero out the user's
2670 * container and begin filling in its fields.
2672 bzero((void *)ai, sizeof(oss_audioinfo));
2675 strlcpy(ai->name, ch->name, sizeof(ai->name));
2677 if ((ch->flags & CHN_F_BUSY) == 0)
2680 ai->busy = (ch->direction == PCMDIR_PLAY) ? OPEN_WRITE : OPEN_READ;
2684 * @c cmd - OSSv4 docs: "Only supported under Linux at
2685 * this moment." Cop-out, I know, but I'll save
2686 * running around in the process table for later.
2687 * Is there a risk of leaking information?
2692 * These flags stolen from SNDCTL_DSP_GETCAPS handler.
2693 * Note, however, that a single channel operates in
2694 * only one direction, so PCM_CAP_DUPLEX is out.
2697 * @todo @c SNDCTL_AUDIOINFO::caps - Make drivers keep
2698 * these in pcmchan::caps?
2700 ai->caps = PCM_CAP_REALTIME | PCM_CAP_MMAP | PCM_CAP_TRIGGER |
2701 ((ch->direction == PCMDIR_PLAY) ? PCM_CAP_OUTPUT : PCM_CAP_INPUT);
2704 * Collect formats supported @b natively by the
2705 * device. Also determine min/max channels. (I.e.,
2706 * mono, stereo, or both?)
2708 * If any channel is stereo, maxch = 2;
2709 * if all channels are stereo, minch = 2, too;
2710 * if any channel is mono, minch = 1;
2711 * and if all channels are mono, maxch = 1.
2716 for (i = 0; caps->fmtlist[i]; i++) {
2717 fmts |= caps->fmtlist[i];
2718 if (AFMT_CHANNEL(caps->fmtlist[i]) > 1) {
2719 minch = (minch == 0) ? 2 : minch;
2723 maxch = (maxch == 0) ? 1 : maxch;
2727 if (ch->direction == PCMDIR_PLAY)
2728 ai->oformats = fmts;
2730 ai->iformats = fmts;
2734 * @c magic - OSSv4 docs: "Reserved for internal use
2738 * @c card_number - OSSv4 docs: "Number of the sound
2739 * card where this device belongs or -1 if this
2740 * information is not available. Applications
2741 * should normally not use this field for any
2744 ai->card_number = -1;
2746 * @todo @c song_name - depends first on
2747 * SNDCTL_[GS]ETSONG @todo @c label - depends
2748 * on SNDCTL_[GS]ETLABEL
2749 * @todo @c port_number - routing information?
2751 ai->port_number = -1;
2752 ai->mixer_dev = (d->mixer_dev != NULL) ? PCMUNIT(d->mixer_dev) : -1;
2755 * @c real_device - OSSv4 docs: "Obsolete."
2757 ai->real_device = -1;
2758 strlcpy(ai->devnode, "/dev/", sizeof(ai->devnode));
2759 strlcat(ai->devnode, devname, sizeof(ai->devnode));
2760 ai->enabled = device_is_attached(d->dev) ? 1 : 0;
2763 * @c flags - OSSv4 docs: "Reserved for future use."
2766 * @c binding - OSSv4 docs: "Reserved for future use."
2768 * @todo @c handle - haven't decided how to generate
2769 * this yet; bus, vendor, device IDs?
2771 ai->min_rate = caps->minspeed;
2772 ai->max_rate = caps->maxspeed;
2774 ai->min_channels = minch;
2775 ai->max_channels = maxch;
2777 ai->nrates = chn_getrates(ch, &rates);
2778 if (ai->nrates > OSS_MAX_SAMPLE_RATES)
2779 ai->nrates = OSS_MAX_SAMPLE_RATES;
2781 for (i = 0; i < ai->nrates; i++)
2782 ai->rates[i] = rates[i];
2784 ai->next_play_engine = 0;
2785 ai->next_rec_engine = 0;
2792 if (devname != NULL)
2796 /* Exhausted the search -- nothing is locked, so return. */
2801 * @brief Assigns a PCM channel to a sync group.
2803 * Sync groups are used to enable audio operations on multiple devices
2804 * simultaneously. They may be used with any number of devices and may
2805 * span across applications. Devices are added to groups with
2806 * the SNDCTL_DSP_SYNCGROUP ioctl, and operations are triggered with the
2807 * SNDCTL_DSP_SYNCSTART ioctl.
2809 * If the @c id field of the @c group parameter is set to zero, then a new
2810 * sync group is created. Otherwise, wrch and rdch (if set) are added to
2811 * the group specified.
2813 * @todo As far as memory allocation, should we assume that things are
2814 * okay and allocate with M_WAITOK before acquiring channel locks,
2815 * freeing later if not?
2817 * @param wrch output channel associated w/ device (if any)
2818 * @param rdch input channel associated w/ device (if any)
2819 * @param group Sync group parameters
2822 * @retval non-zero error to be propagated upstream
2825 dsp_oss_syncgroup(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_syncgroup *group)
2827 struct pcmchan_syncmember *smrd, *smwr;
2828 struct pcmchan_syncgroup *sg;
2837 * Free_unr() may sleep, so store released syncgroup IDs until after
2838 * all locks are released.
2840 sg_ids[0] = sg_ids[1] = sg_ids[2] = 0;
2845 * - Insert channel(s) into group's member list.
2846 * - Set CHN_F_NOTRIGGER on channel(s).
2847 * - Stop channel(s).
2851 * If device's channels are already mapped to a group, unmap them.
2855 sg_ids[0] = chn_syncdestroy(wrch);
2860 sg_ids[1] = chn_syncdestroy(rdch);
2864 * Verify that mode matches character device properites.
2865 * - Bail if PCM_ENABLE_OUTPUT && wrch == NULL.
2866 * - Bail if PCM_ENABLE_INPUT && rdch == NULL.
2868 if (((wrch == NULL) && (group->mode & PCM_ENABLE_OUTPUT)) ||
2869 ((rdch == NULL) && (group->mode & PCM_ENABLE_INPUT))) {
2875 * An id of zero indicates the user wants to create a new
2878 if (group->id == 0) {
2879 sg = (struct pcmchan_syncgroup *)kmalloc(sizeof(*sg), M_DEVBUF, M_WAITOK | M_ZERO);
2881 SLIST_INIT(&sg->members);
2882 sg->id = alloc_unr(pcmsg_unrhdr);
2885 SLIST_INSERT_HEAD(&snd_pcm_syncgroups, sg, link);
2889 SLIST_FOREACH(sg, &snd_pcm_syncgroups, link) {
2890 if (sg->id == group->id)
2897 /* Couldn't create or find a syncgroup. Fail. */
2902 * Allocate a syncmember, assign it and a channel together, and
2903 * insert into syncgroup.
2905 if (group->mode & PCM_ENABLE_INPUT) {
2906 smrd = (struct pcmchan_syncmember *)kmalloc(sizeof(*smrd), M_DEVBUF, M_WAITOK | M_ZERO);
2912 SLIST_INSERT_HEAD(&sg->members, smrd, link);
2917 rdch->flags |= CHN_F_NOTRIGGER;
2921 if (group->mode & PCM_ENABLE_OUTPUT) {
2922 smwr = (struct pcmchan_syncmember *)kmalloc(sizeof(*smwr), M_DEVBUF, M_WAITOK | M_ZERO);
2928 SLIST_INSERT_HEAD(&sg->members, smwr, link);
2933 wrch->flags |= CHN_F_NOTRIGGER;
2941 kfree(smrd, M_DEVBUF);
2942 if ((sg != NULL) && SLIST_EMPTY(&sg->members)) {
2944 SLIST_REMOVE(&snd_pcm_syncgroups, sg, pcmchan_syncgroup, link);
2945 kfree(sg, M_DEVBUF);
2962 free_unr(pcmsg_unrhdr, sg_ids[0]);
2964 free_unr(pcmsg_unrhdr, sg_ids[1]);
2966 free_unr(pcmsg_unrhdr, sg_ids[2]);
2972 * @brief Launch a sync group into action
2974 * Sync groups are established via SNDCTL_DSP_SYNCGROUP. This function
2975 * iterates over all members, triggering them along the way.
2977 * @note Caller must not hold any channel locks.
2979 * @param sg_id sync group identifier
2982 * @retval non-zero error worthy of propagating upstream to user
2985 dsp_oss_syncstart(int sg_id)
2987 struct pcmchan_syncmember *sm, *sm_tmp;
2988 struct pcmchan_syncgroup *sg;
2989 struct pcm_channel *c;
2992 /* Get the synclists lock */
2999 /* Search for syncgroup by ID */
3000 SLIST_FOREACH(sg, &snd_pcm_syncgroups, link) {
3001 if (sg->id == sg_id)
3005 /* Return EINVAL if not found */
3011 /* Any removals resulting in an empty group should've handled this */
3012 KASSERT(!SLIST_EMPTY(&sg->members), ("found empty syncgroup"));
3015 * Attempt to lock all member channels - if any are already
3016 * locked, unlock those acquired, sleep for a bit, and try
3019 SLIST_FOREACH(sm, &sg->members, link) {
3020 if (CHN_TRYLOCK(sm->ch) == 0) {
3021 int timo = hz * 5/1000;
3025 /* Release all locked channels so far, retry */
3026 SLIST_FOREACH(sm_tmp, &sg->members, link) {
3027 /* sm is the member already locked */
3030 CHN_UNLOCK(sm_tmp->ch);
3033 /** @todo Is PRIBIO correct/ */
3034 ret = lksleep(sm, &snd_pcm_syncgroups_mtx,
3035 PCATCH, "pcmsg", timo);
3036 if (ret == EINTR || ret == ERESTART)
3040 ret = 0; /* Assumes ret == EAGAIN... */
3043 } while (needlocks && ret == 0);
3045 /* Proceed only if no errors encountered. */
3047 /* Launch channels */
3048 while ((sm = SLIST_FIRST(&sg->members)) != NULL) {
3049 SLIST_REMOVE_HEAD(&sg->members, link);
3054 c->flags &= ~CHN_F_NOTRIGGER;
3057 kfree(sm, M_DEVBUF);
3060 SLIST_REMOVE(&snd_pcm_syncgroups, sg, pcmchan_syncgroup, link);
3061 kfree(sg, M_DEVBUF);
3067 * Free_unr() may sleep, so be sure to give up the syncgroup lock
3071 free_unr(pcmsg_unrhdr, sg_id);
3077 * @brief Handler for SNDCTL_DSP_POLICY
3079 * The SNDCTL_DSP_POLICY ioctl is a simpler interface to control fragment
3080 * size and count like with SNDCTL_DSP_SETFRAGMENT. Instead of the user
3081 * specifying those two parameters, s/he simply selects a number from 0..10
3082 * which corresponds to a buffer size. Smaller numbers request smaller
3083 * buffers with lower latencies (at greater overhead from more frequent
3084 * interrupts), while greater numbers behave in the opposite manner.
3086 * The 4Front spec states that a value of 5 should be the default. However,
3087 * this implementation deviates slightly by using a linear scale without
3088 * consulting drivers. I.e., even though drivers may have different default
3089 * buffer sizes, a policy argument of 5 will have the same result across
3092 * See http://manuals.opensound.com/developer/SNDCTL_DSP_POLICY.html for
3095 * @todo When SNDCTL_DSP_COOKEDMODE is supported, it'll be necessary to
3096 * work with hardware drivers directly.
3098 * @note PCM channel arguments must not be locked by caller.
3100 * @param wrch Pointer to opened playback channel (optional; may be NULL)
3101 * @param rdch " recording channel (optional; may be NULL)
3102 * @param policy Integer from [0:10]
3104 * @retval 0 constant (for now)
3107 dsp_oss_policy(struct pcm_channel *wrch, struct pcm_channel *rdch, int policy)
3111 if (policy < CHN_POLICY_MIN || policy > CHN_POLICY_MAX)
3114 /* Default: success */
3119 ret = chn_setlatency(rdch, policy);
3123 if (wrch && ret == 0) {
3125 ret = chn_setlatency(wrch, policy);
3136 * @brief Enable or disable "cooked" mode
3138 * This is a handler for @c SNDCTL_DSP_COOKEDMODE. When in cooked mode, which
3139 * is the default, the sound system handles rate and format conversions
3140 * automatically (ex: user writing 11025Hz/8 bit/unsigned but card only
3141 * operates with 44100Hz/16bit/signed samples).
3143 * Disabling cooked mode is intended for applications wanting to mmap()
3144 * a sound card's buffer space directly, bypassing the FreeBSD 2-stage
3145 * feeder architecture, presumably to gain as much control over audio
3146 * hardware as possible.
3148 * See @c http://manuals.opensound.com/developer/SNDCTL_DSP_COOKEDMODE.html
3151 * @param wrch playback channel (optional; may be NULL)
3152 * @param rdch recording channel (optional; may be NULL)
3153 * @param enabled 0 = raw mode, 1 = cooked mode
3155 * @retval EINVAL Operation not yet supported.
3158 dsp_oss_cookedmode(struct pcm_channel *wrch, struct pcm_channel *rdch, int enabled)
3162 * XXX I just don't get it. Why don't they call it
3163 * "BITPERFECT" ~ SNDCTL_DSP_BITPERFECT !?!?.
3164 * This is just plain so confusing, incoherent,
3165 * <insert any non-printable characters here>.
3167 if (!(enabled == 1 || enabled == 0))
3171 * I won't give in. I'm inverting its logic here and now.
3172 * Brag all you want, but "BITPERFECT" should be the better
3175 enabled ^= 0x00000001;
3179 wrch->flags &= ~CHN_F_BITPERFECT;
3180 wrch->flags |= (enabled != 0) ? CHN_F_BITPERFECT : 0x00000000;
3186 rdch->flags &= ~CHN_F_BITPERFECT;
3187 rdch->flags |= (enabled != 0) ? CHN_F_BITPERFECT : 0x00000000;
3195 * @brief Retrieve channel interleaving order
3197 * This is the handler for @c SNDCTL_DSP_GET_CHNORDER.
3199 * See @c http://manuals.opensound.com/developer/SNDCTL_DSP_GET_CHNORDER.html
3202 * @note As the ioctl definition is still under construction, FreeBSD
3203 * does not currently support SNDCTL_DSP_GET_CHNORDER.
3205 * @param wrch playback channel (optional; may be NULL)
3206 * @param rdch recording channel (optional; may be NULL)
3207 * @param map channel map (result will be stored there)
3209 * @retval EINVAL Operation not yet supported.
3212 dsp_oss_getchnorder(struct pcm_channel *wrch, struct pcm_channel *rdch, unsigned long long *map)
3214 struct pcm_channel *ch;
3217 ch = (wrch != NULL) ? wrch : rdch;
3220 ret = chn_oss_getorder(ch, map);
3229 * @brief Specify channel interleaving order
3231 * This is the handler for @c SNDCTL_DSP_SET_CHNORDER.
3233 * @note As the ioctl definition is still under construction, FreeBSD
3234 * does not currently support @c SNDCTL_DSP_SET_CHNORDER.
3236 * @param wrch playback channel (optional; may be NULL)
3237 * @param rdch recording channel (optional; may be NULL)
3238 * @param map channel map
3240 * @retval EINVAL Operation not yet supported.
3243 dsp_oss_setchnorder(struct pcm_channel *wrch, struct pcm_channel *rdch, unsigned long long *map)
3251 ret = chn_oss_setorder(wrch, map);
3255 if (ret == 0 && rdch != NULL) {
3257 ret = chn_oss_setorder(rdch, map);
3265 dsp_oss_getchannelmask(struct pcm_channel *wrch, struct pcm_channel *rdch,
3268 struct pcm_channel *ch;
3273 ch = (wrch != NULL) ? wrch : rdch;
3277 ret = chn_oss_getmask(ch, &chnmask);
3288 #ifdef OSSV4_EXPERIMENT
3290 * @brief Retrieve an audio device's label
3292 * This is a handler for the @c SNDCTL_GETLABEL ioctl.
3294 * See @c http://manuals.opensound.com/developer/SNDCTL_GETLABEL.html
3297 * From Hannu@4Front: "For example ossxmix (just like some HW mixer
3298 * consoles) can show variable "labels" for certain controls. By default
3299 * the application name (say quake) is shown as the label but
3300 * applications may change the labels themselves."
3302 * @note As the ioctl definition is still under construction, FreeBSD
3303 * does not currently support @c SNDCTL_GETLABEL.
3305 * @param wrch playback channel (optional; may be NULL)
3306 * @param rdch recording channel (optional; may be NULL)
3307 * @param label label gets copied here
3309 * @retval EINVAL Operation not yet supported.
3312 dsp_oss_getlabel(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_label_t *label)
3318 * @brief Specify an audio device's label
3320 * This is a handler for the @c SNDCTL_SETLABEL ioctl. Please see the
3321 * comments for @c dsp_oss_getlabel immediately above.
3323 * See @c http://manuals.opensound.com/developer/SNDCTL_GETLABEL.html
3326 * @note As the ioctl definition is still under construction, FreeBSD
3327 * does not currently support SNDCTL_SETLABEL.
3329 * @param wrch playback channel (optional; may be NULL)
3330 * @param rdch recording channel (optional; may be NULL)
3331 * @param label label gets copied from here
3333 * @retval EINVAL Operation not yet supported.
3336 dsp_oss_setlabel(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_label_t *label)
3342 * @brief Retrieve name of currently played song
3344 * This is a handler for the @c SNDCTL_GETSONG ioctl. Audio players could
3345 * tell the system the name of the currently playing song, which would be
3346 * visible in @c /dev/sndstat.
3348 * See @c http://manuals.opensound.com/developer/SNDCTL_GETSONG.html
3351 * @note As the ioctl definition is still under construction, FreeBSD
3352 * does not currently support SNDCTL_GETSONG.
3354 * @param wrch playback channel (optional; may be NULL)
3355 * @param rdch recording channel (optional; may be NULL)
3356 * @param song song name gets copied here
3358 * @retval EINVAL Operation not yet supported.
3361 dsp_oss_getsong(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_longname_t *song)
3367 * @brief Retrieve name of currently played song
3369 * This is a handler for the @c SNDCTL_SETSONG ioctl. Audio players could
3370 * tell the system the name of the currently playing song, which would be
3371 * visible in @c /dev/sndstat.
3373 * See @c http://manuals.opensound.com/developer/SNDCTL_SETSONG.html
3376 * @note As the ioctl definition is still under construction, FreeBSD
3377 * does not currently support SNDCTL_SETSONG.
3379 * @param wrch playback channel (optional; may be NULL)
3380 * @param rdch recording channel (optional; may be NULL)
3381 * @param song song name gets copied from here
3383 * @retval EINVAL Operation not yet supported.
3386 dsp_oss_setsong(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_longname_t *song)
3392 * @brief Rename a device
3394 * This is a handler for the @c SNDCTL_SETNAME ioctl.
3396 * See @c http://manuals.opensound.com/developer/SNDCTL_SETNAME.html for
3399 * From Hannu@4Front: "This call is used to change the device name
3400 * reported in /dev/sndstat and ossinfo. So instead of using some generic
3401 * 'OSS loopback audio (MIDI) driver' the device may be given a meaningfull
3402 * name depending on the current context (for example 'OSS virtual wave table
3403 * synth' or 'VoIP link to London')."
3405 * @note As the ioctl definition is still under construction, FreeBSD
3406 * does not currently support SNDCTL_SETNAME.
3408 * @param wrch playback channel (optional; may be NULL)
3409 * @param rdch recording channel (optional; may be NULL)
3410 * @param name new device name gets copied from here
3412 * @retval EINVAL Operation not yet supported.
3415 dsp_oss_setname(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_longname_t *name)
3419 #endif /* !OSSV4_EXPERIMENT */