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/sysent.h>
37 SND_DECLARE_FILE("$FreeBSD$");
39 static int dsp_mmap_allow_prot_exec = 0;
40 SYSCTL_INT(_hw_snd, OID_AUTO, compat_linux_mmap, CTLFLAG_RW,
41 &dsp_mmap_allow_prot_exec, 0,
42 "linux mmap compatibility (-1=force disable 0=auto 1=force enable)");
45 struct pcm_channel *rdch, *wrch;
46 struct pcm_channel *volch;
48 TAILQ_ENTRY(dsp_cdevinfo) link;
51 #define PCM_RDCH(x) (((struct dsp_cdevinfo *)(x)->si_drv1)->rdch)
52 #define PCM_WRCH(x) (((struct dsp_cdevinfo *)(x)->si_drv1)->wrch)
53 #define PCM_VOLCH(x) (((struct dsp_cdevinfo *)(x)->si_drv1)->volch)
54 #define PCM_SIMPLEX(x) (((struct dsp_cdevinfo *)(x)->si_drv1)->simplex)
56 #define DSP_CDEVINFO_CACHESIZE 8
58 #define DSP_REGISTERED(x, y) (PCM_REGISTERED(x) && \
59 (y) != NULL && (y)->si_drv1 != NULL)
63 static d_open_t dsp_open;
64 static d_close_t dsp_close;
65 static d_read_t dsp_read;
66 static d_write_t dsp_write;
67 static d_ioctl_t dsp_ioctl;
68 static d_poll_t dsp_poll;
69 static d_mmap_t dsp_mmap;
71 struct cdevsw dsp_cdevsw = {
72 .d_version = D_VERSION,
83 static eventhandler_tag dsp_ehtag = NULL;
84 static int dsp_umax = -1;
85 static int dsp_cmax = -1;
87 static int dsp_oss_syncgroup(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_syncgroup *group);
88 static int dsp_oss_syncstart(int sg_id);
89 static int dsp_oss_policy(struct pcm_channel *wrch, struct pcm_channel *rdch, int policy);
90 static int dsp_oss_cookedmode(struct pcm_channel *wrch, struct pcm_channel *rdch, int enabled);
91 static int dsp_oss_getchnorder(struct pcm_channel *wrch, struct pcm_channel *rdch, unsigned long long *map);
92 static int dsp_oss_setchnorder(struct pcm_channel *wrch, struct pcm_channel *rdch, unsigned long long *map);
93 static int dsp_oss_getchannelmask(struct pcm_channel *wrch, struct pcm_channel *rdch, int *mask);
94 #ifdef OSSV4_EXPERIMENT
95 static int dsp_oss_getlabel(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_label_t *label);
96 static int dsp_oss_setlabel(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_label_t *label);
97 static int dsp_oss_getsong(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_longname_t *song);
98 static int dsp_oss_setsong(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_longname_t *song);
99 static int dsp_oss_setname(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_longname_t *name);
102 static struct snddev_info *
103 dsp_get_info(struct cdev *dev)
105 return (devclass_get_softc(pcm_devclass, PCMUNIT(dev)));
109 dsp_get_flags(struct cdev *dev)
113 bdev = devclass_get_device(pcm_devclass, PCMUNIT(dev));
115 return ((bdev != NULL) ? pcm_getflags(bdev) : 0xffffffff);
119 dsp_set_flags(struct cdev *dev, uint32_t flags)
123 bdev = devclass_get_device(pcm_devclass, PCMUNIT(dev));
126 pcm_setflags(bdev, flags);
130 * return the channels associated with an open device instance.
131 * lock channels specified.
134 getchns(struct cdev *dev, struct pcm_channel **rdch, struct pcm_channel **wrch,
137 struct snddev_info *d;
138 struct pcm_channel *ch;
141 if (PCM_SIMPLEX(dev) != 0) {
142 d = dsp_get_info(dev);
143 if (!PCM_REGISTERED(d))
149 * Note: order is important -
150 * pcm flags -> prio query flags -> wild guess
153 flags = dsp_get_flags(dev);
154 if (flags & SD_F_PRIO_WR) {
156 PCM_RDCH(dev) = NULL;
157 } else if (flags & SD_F_PRIO_RD) {
159 PCM_WRCH(dev) = NULL;
160 } else if (prio & SD_F_PRIO_WR) {
162 PCM_RDCH(dev) = NULL;
163 flags |= SD_F_PRIO_WR;
164 } else if (prio & SD_F_PRIO_RD) {
166 PCM_WRCH(dev) = NULL;
167 flags |= SD_F_PRIO_RD;
168 } else if (PCM_WRCH(dev) != NULL) {
170 PCM_RDCH(dev) = NULL;
171 flags |= SD_F_PRIO_WR;
172 } else if (PCM_RDCH(dev) != NULL) {
174 PCM_WRCH(dev) = NULL;
175 flags |= SD_F_PRIO_RD;
177 PCM_SIMPLEX(dev) = 0;
178 dsp_set_flags(dev, flags);
188 *rdch = PCM_RDCH(dev);
189 *wrch = PCM_WRCH(dev);
191 if (*rdch != NULL && (prio & SD_F_PRIO_RD))
193 if (*wrch != NULL && (prio & SD_F_PRIO_WR))
199 /* unlock specified channels */
201 relchns(struct cdev *dev, struct pcm_channel *rdch, struct pcm_channel *wrch,
204 if (wrch != NULL && (prio & SD_F_PRIO_WR))
206 if (rdch != NULL && (prio & SD_F_PRIO_RD))
211 dsp_cdevinfo_alloc(struct cdev *dev,
212 struct pcm_channel *rdch, struct pcm_channel *wrch,
213 struct pcm_channel *volch)
215 struct snddev_info *d;
216 struct dsp_cdevinfo *cdi;
219 d = dsp_get_info(dev);
221 KASSERT(PCM_REGISTERED(d) && dev != NULL && dev->si_drv1 == NULL &&
222 ((rdch == NULL && wrch == NULL) || rdch != wrch),
223 ("bogus %s(), what are you trying to accomplish here?", __func__));
227 simplex = (dsp_get_flags(dev) & SD_F_SIMPLEX) ? 1 : 0;
230 * Scan for free instance entry and put it into the end of list.
231 * Create new one if necessary.
233 TAILQ_FOREACH(cdi, &d->dsp_cdevinfo_pool, link) {
239 cdi->simplex = simplex;
241 TAILQ_REMOVE(&d->dsp_cdevinfo_pool, cdi, link);
242 TAILQ_INSERT_TAIL(&d->dsp_cdevinfo_pool, cdi, link);
247 cdi = malloc(sizeof(*cdi), M_DEVBUF, M_WAITOK | M_ZERO);
252 cdi->simplex = simplex;
254 TAILQ_INSERT_TAIL(&d->dsp_cdevinfo_pool, cdi, link);
259 dsp_cdevinfo_free(struct cdev *dev)
261 struct snddev_info *d;
262 struct dsp_cdevinfo *cdi, *tmp;
266 d = dsp_get_info(dev);
268 KASSERT(PCM_REGISTERED(d) && dev != NULL && dev->si_drv1 != NULL &&
269 PCM_RDCH(dev) == NULL && PCM_WRCH(dev) == NULL &&
270 PCM_VOLCH(dev) == NULL,
271 ("bogus %s(), what are you trying to accomplish here?", __func__));
284 * Once it is free, move it back to the beginning of list for
285 * faster new entry allocation.
287 TAILQ_REMOVE(&d->dsp_cdevinfo_pool, cdi, link);
288 TAILQ_INSERT_HEAD(&d->dsp_cdevinfo_pool, cdi, link);
291 * Scan the list, cache free entries up to DSP_CDEVINFO_CACHESIZE.
292 * Reset simplex flags.
294 flags = dsp_get_flags(dev) & ~SD_F_PRIO_SET;
295 i = DSP_CDEVINFO_CACHESIZE;
296 TAILQ_FOREACH_SAFE(cdi, &d->dsp_cdevinfo_pool, link, tmp) {
297 if (cdi->busy != 0) {
298 if (cdi->simplex == 0) {
299 if (cdi->rdch != NULL)
300 flags |= SD_F_PRIO_RD;
301 if (cdi->wrch != NULL)
302 flags |= SD_F_PRIO_WR;
306 TAILQ_REMOVE(&d->dsp_cdevinfo_pool, cdi, link);
312 dsp_set_flags(dev, flags);
316 dsp_cdevinfo_init(struct snddev_info *d)
318 struct dsp_cdevinfo *cdi;
321 KASSERT(d != NULL, ("NULL snddev_info"));
325 TAILQ_INIT(&d->dsp_cdevinfo_pool);
326 for (i = 0; i < DSP_CDEVINFO_CACHESIZE; i++) {
327 cdi = malloc(sizeof(*cdi), M_DEVBUF, M_WAITOK | M_ZERO);
328 TAILQ_INSERT_HEAD(&d->dsp_cdevinfo_pool, cdi, link);
333 dsp_cdevinfo_flush(struct snddev_info *d)
335 struct dsp_cdevinfo *cdi, *tmp;
337 KASSERT(d != NULL, ("NULL snddev_info"));
341 cdi = TAILQ_FIRST(&d->dsp_cdevinfo_pool);
342 while (cdi != NULL) {
343 tmp = TAILQ_NEXT(cdi, link);
347 TAILQ_INIT(&d->dsp_cdevinfo_pool);
350 /* duplex / simplex cdev type */
352 DSP_CDEV_TYPE_RDONLY, /* simplex read-only (record) */
353 DSP_CDEV_TYPE_WRONLY, /* simplex write-only (play) */
354 DSP_CDEV_TYPE_RDWR /* duplex read, write, or both */
358 DSP_CDEV_VOLCTL_NONE,
359 DSP_CDEV_VOLCTL_READ,
360 DSP_CDEV_VOLCTL_WRITE
363 #define DSP_F_VALID(x) ((x) & (FREAD | FWRITE))
364 #define DSP_F_DUPLEX(x) (((x) & (FREAD | FWRITE)) == (FREAD | FWRITE))
365 #define DSP_F_SIMPLEX(x) (!DSP_F_DUPLEX(x))
366 #define DSP_F_READ(x) ((x) & FREAD)
367 #define DSP_F_WRITE(x) ((x) & FWRITE)
369 static const struct {
381 { SND_DEV_DSP, "dsp", ".", NULL, 0, 0, 0, 0,
382 SND_FORMAT(AFMT_U8, 1, 0), DSP_DEFAULT_SPEED,
383 DSP_CDEV_TYPE_RDWR },
384 { SND_DEV_AUDIO, "audio", ".", NULL, 0, 0, 0, 0,
385 SND_FORMAT(AFMT_MU_LAW, 1, 0), DSP_DEFAULT_SPEED,
386 DSP_CDEV_TYPE_RDWR },
387 { SND_DEV_DSP16, "dspW", ".", NULL, 0, 0, 0, 0,
388 SND_FORMAT(AFMT_S16_LE, 1, 0), DSP_DEFAULT_SPEED,
389 DSP_CDEV_TYPE_RDWR },
390 { SND_DEV_DSPHW_PLAY, "dsp", ".p", NULL, 1, 1, SND_MAXHWCHAN, 1,
391 SND_FORMAT(AFMT_S16_LE, 2, 0), 48000, DSP_CDEV_TYPE_WRONLY },
392 { SND_DEV_DSPHW_VPLAY, "dsp", ".vp", NULL, 1, 1, SND_MAXVCHANS, 1,
393 SND_FORMAT(AFMT_S16_LE, 2, 0), 48000, DSP_CDEV_TYPE_WRONLY },
394 { SND_DEV_DSPHW_REC, "dsp", ".r", NULL, 1, 1, SND_MAXHWCHAN, 1,
395 SND_FORMAT(AFMT_S16_LE, 2, 0), 48000, DSP_CDEV_TYPE_RDONLY },
396 { SND_DEV_DSPHW_VREC, "dsp", ".vr", NULL, 1, 1, SND_MAXVCHANS, 1,
397 SND_FORMAT(AFMT_S16_LE, 2, 0), 48000, DSP_CDEV_TYPE_RDONLY },
398 { SND_DEV_DSPHW_CD, "dspcd", ".", NULL, 0, 0, 0, 0,
399 SND_FORMAT(AFMT_S16_LE, 2, 0), 44100, DSP_CDEV_TYPE_RDWR },
400 /* Low priority, OSSv4 aliases. */
401 { SND_DEV_DSP, "dsp_ac3", ".", "dsp", 0, 0, 0, 0,
402 SND_FORMAT(AFMT_U8, 1, 0), DSP_DEFAULT_SPEED,
403 DSP_CDEV_TYPE_RDWR },
404 { SND_DEV_DSP, "dsp_mmap", ".", "dsp", 0, 0, 0, 0,
405 SND_FORMAT(AFMT_U8, 1, 0), DSP_DEFAULT_SPEED,
406 DSP_CDEV_TYPE_RDWR },
407 { SND_DEV_DSP, "dsp_multich", ".", "dsp", 0, 0, 0, 0,
408 SND_FORMAT(AFMT_U8, 1, 0), DSP_DEFAULT_SPEED,
409 DSP_CDEV_TYPE_RDWR },
410 { SND_DEV_DSP, "dsp_spdifout", ".", "dsp", 0, 0, 0, 0,
411 SND_FORMAT(AFMT_U8, 1, 0), DSP_DEFAULT_SPEED,
412 DSP_CDEV_TYPE_RDWR },
413 { SND_DEV_DSP, "dsp_spdifin", ".", "dsp", 0, 0, 0, 0,
414 SND_FORMAT(AFMT_U8, 1, 0), DSP_DEFAULT_SPEED,
415 DSP_CDEV_TYPE_RDWR },
418 #define DSP_FIXUP_ERROR() do { \
419 prio = dsp_get_flags(i_dev); \
420 if (!DSP_F_VALID(flags)) \
422 if (!DSP_F_DUPLEX(flags) && \
423 ((DSP_F_READ(flags) && d->reccount == 0) || \
424 (DSP_F_WRITE(flags) && d->playcount == 0))) \
426 else if (!DSP_F_DUPLEX(flags) && (prio & SD_F_SIMPLEX) && \
427 ((DSP_F_READ(flags) && (prio & SD_F_PRIO_WR)) || \
428 (DSP_F_WRITE(flags) && (prio & SD_F_PRIO_RD)))) \
430 else if (DSP_REGISTERED(d, i_dev)) \
435 dsp_open(struct cdev *i_dev, int flags, int mode, struct thread *td)
437 struct pcm_channel *rdch, *wrch;
438 struct snddev_info *d;
439 uint32_t fmt, spd, prio, volctl;
440 int i, error, rderror, wrerror, devtype, wdevunit, rdevunit;
442 /* Kind of impossible.. */
443 if (i_dev == NULL || td == NULL)
446 d = dsp_get_info(i_dev);
447 if (!PCM_REGISTERED(d))
452 /* Lock snddev so nobody else can monkey with it. */
457 * Try to acquire cloned device before someone else pick it.
458 * ENODEV means this is not a cloned droids.
460 error = snd_clone_acquire(i_dev);
461 if (!(error == 0 || error == ENODEV)) {
472 (void)snd_clone_release(i_dev);
479 * That is just enough. Acquire and unlock pcm lock so
480 * the other will just have to wait until we finish doing
486 devtype = PCMDEV(i_dev);
491 volctl = DSP_CDEV_VOLCTL_NONE;
493 for (i = 0; i < (sizeof(dsp_cdevs) / sizeof(dsp_cdevs[0])); i++) {
494 if (devtype != dsp_cdevs[i].type || dsp_cdevs[i].alias != NULL)
497 * Volume control only valid for DSPHW devices,
498 * and it must be opened in opposite direction be it
499 * simplex or duplex. Anything else will be handled
502 if (dsp_cdevs[i].query == DSP_CDEV_TYPE_WRONLY) {
503 if (dsp_cdevs[i].volctl != 0 &&
505 volctl = DSP_CDEV_VOLCTL_WRITE;
509 if (DSP_F_READ(flags)) {
510 (void)snd_clone_release(i_dev);
511 PCM_RELEASE_QUICK(d);
515 wdevunit = dev2unit(i_dev);
516 } else if (dsp_cdevs[i].query == DSP_CDEV_TYPE_RDONLY) {
517 if (dsp_cdevs[i].volctl != 0 &&
518 DSP_F_WRITE(flags)) {
519 volctl = DSP_CDEV_VOLCTL_READ;
523 if (DSP_F_WRITE(flags)) {
524 (void)snd_clone_release(i_dev);
525 PCM_RELEASE_QUICK(d);
529 rdevunit = dev2unit(i_dev);
531 fmt = dsp_cdevs[i].fmt;
532 spd = dsp_cdevs[i].spd;
536 /* No matching devtype? */
537 if (fmt == 0 || spd == 0)
538 panic("impossible devtype %d", devtype);
546 * if we get here, the open request is valid- either:
547 * * we were previously not open
548 * * we were open for play xor record and the opener wants
549 * the non-open direction
551 if (DSP_F_READ(flags)) {
553 rderror = pcm_chnalloc(d, &rdch, PCMDIR_REC,
554 td->td_proc->p_pid, td->td_proc->p_comm, rdevunit);
556 if (rderror == 0 && chn_reset(rdch, fmt, spd) != 0)
559 if (volctl == DSP_CDEV_VOLCTL_READ)
564 pcm_chnrelease(rdch);
565 if (!DSP_F_DUPLEX(flags)) {
566 (void)snd_clone_release(i_dev);
567 PCM_RELEASE_QUICK(d);
572 } else if (volctl == DSP_CDEV_VOLCTL_READ) {
575 pcm_chnrelease(rdch);
578 if (flags & O_NONBLOCK)
579 rdch->flags |= CHN_F_NBIO;
581 rdch->flags |= CHN_F_EXCLUSIVE;
583 if (volctl == DSP_CDEV_VOLCTL_NONE)
584 chn_vpc_reset(rdch, SND_VOL_C_PCM, 0);
589 if (DSP_F_WRITE(flags)) {
591 wrerror = pcm_chnalloc(d, &wrch, PCMDIR_PLAY,
592 td->td_proc->p_pid, td->td_proc->p_comm, wdevunit);
594 if (wrerror == 0 && chn_reset(wrch, fmt, spd) != 0)
597 if (volctl == DSP_CDEV_VOLCTL_WRITE)
602 pcm_chnrelease(wrch);
603 if (!DSP_F_DUPLEX(flags)) {
606 * Lock, deref and release previously
607 * created record channel
610 pcm_chnref(rdch, -1);
611 pcm_chnrelease(rdch);
613 (void)snd_clone_release(i_dev);
614 PCM_RELEASE_QUICK(d);
619 } else if (volctl == DSP_CDEV_VOLCTL_WRITE) {
622 pcm_chnrelease(wrch);
625 if (flags & O_NONBLOCK)
626 wrch->flags |= CHN_F_NBIO;
628 wrch->flags |= CHN_F_EXCLUSIVE;
630 if (volctl == DSP_CDEV_VOLCTL_NONE)
631 chn_vpc_reset(wrch, SND_VOL_C_PCM, 0);
640 * We're done. Allocate channels information for this cdev.
643 case DSP_CDEV_VOLCTL_READ:
644 KASSERT(wrch == NULL, ("wrch=%p not null!", wrch));
645 dsp_cdevinfo_alloc(i_dev, NULL, NULL, rdch);
647 case DSP_CDEV_VOLCTL_WRITE:
648 KASSERT(rdch == NULL, ("rdch=%p not null!", rdch));
649 dsp_cdevinfo_alloc(i_dev, NULL, NULL, wrch);
651 case DSP_CDEV_VOLCTL_NONE:
653 if (wrch == NULL && rdch == NULL) {
654 (void)snd_clone_release(i_dev);
664 dsp_cdevinfo_alloc(i_dev, rdch, wrch, NULL);
666 CHN_INSERT_HEAD(d, rdch, channels.pcm.opened);
668 CHN_INSERT_HEAD(d, wrch, channels.pcm.opened);
673 * Increase clone refcount for its automatic garbage collector.
675 (void)snd_clone_ref(i_dev);
686 dsp_close(struct cdev *i_dev, int flags, int mode, struct thread *td)
688 struct pcm_channel *rdch, *wrch, *volch;
689 struct snddev_info *d;
690 int sg_ids, rdref, wdref;
692 d = dsp_get_info(i_dev);
693 if (!DSP_REGISTERED(d, i_dev))
702 rdch = PCM_RDCH(i_dev);
703 wrch = PCM_WRCH(i_dev);
704 volch = PCM_VOLCH(i_dev);
706 PCM_RDCH(i_dev) = NULL;
707 PCM_WRCH(i_dev) = NULL;
708 PCM_VOLCH(i_dev) = NULL;
716 else if (volch == wrch)
720 pcm_chnref(volch, -1);
726 CHN_REMOVE(d, rdch, channels.pcm.opened);
728 CHN_REMOVE(d, wrch, channels.pcm.opened);
730 if (rdch != NULL || wrch != NULL) {
734 * The channel itself need not be locked because:
735 * a) Adding a channel to a syncgroup happens only
736 * in dsp_ioctl(), which cannot run concurrently
738 * b) The syncmember pointer (sm) is protected by
739 * the global syncgroup list lock.
740 * c) A channel can't just disappear, invalidating
741 * pointers, unless it's closed/dereferenced
745 sg_ids = chn_syncdestroy(rdch);
748 free_unr(pcmsg_unrhdr, sg_ids);
751 pcm_chnref(rdch, rdref);
752 chn_abort(rdch); /* won't sleep */
753 rdch->flags &= ~(CHN_F_RUNNING | CHN_F_MMAP |
754 CHN_F_DEAD | CHN_F_EXCLUSIVE);
755 chn_reset(rdch, 0, 0);
756 pcm_chnrelease(rdch);
760 * Please see block above.
763 sg_ids = chn_syncdestroy(wrch);
766 free_unr(pcmsg_unrhdr, sg_ids);
769 pcm_chnref(wrch, wdref);
770 chn_flush(wrch); /* may sleep */
771 wrch->flags &= ~(CHN_F_RUNNING | CHN_F_MMAP |
772 CHN_F_DEAD | CHN_F_EXCLUSIVE);
773 chn_reset(wrch, 0, 0);
774 pcm_chnrelease(wrch);
779 dsp_cdevinfo_free(i_dev);
781 * Release clone busy state and unref it so the automatic
782 * garbage collector will get the hint and do the remaining
785 (void)snd_clone_release(i_dev);
788 * destroy_dev() might sleep, so release pcm lock
789 * here and rely on pcm cv serialization.
792 (void)snd_clone_unref(i_dev);
804 dsp_io_ops(struct cdev *i_dev, struct uio *buf)
806 struct snddev_info *d;
807 struct pcm_channel **ch, *rdch, *wrch;
808 int (*chn_io)(struct pcm_channel *, struct uio *);
812 KASSERT(i_dev != NULL && buf != NULL &&
813 (buf->uio_rw == UIO_READ || buf->uio_rw == UIO_WRITE),
814 ("%s(): io train wreck!", __func__));
816 d = dsp_get_info(i_dev);
817 if (!DSP_REGISTERED(d, i_dev))
822 switch (buf->uio_rw) {
834 panic("invalid/corrupted uio direction: %d", buf->uio_rw);
840 runpid = buf->uio_td->td_proc->p_pid;
842 getchns(i_dev, &rdch, &wrch, prio);
844 if (*ch == NULL || !((*ch)->flags & CHN_F_BUSY)) {
849 if (((*ch)->flags & (CHN_F_MMAP | CHN_F_DEAD)) ||
850 (((*ch)->flags & CHN_F_RUNNING) && (*ch)->pid != runpid)) {
851 relchns(i_dev, rdch, wrch, prio);
854 } else if (!((*ch)->flags & CHN_F_RUNNING)) {
855 (*ch)->flags |= CHN_F_RUNNING;
860 * chn_read/write must give up channel lock in order to copy bytes
861 * from/to userland, so up the "in progress" counter to make sure
862 * someone else doesn't come along and muss up the buffer.
865 ret = chn_io(*ch, buf);
868 CHN_BROADCAST(&(*ch)->cv);
870 relchns(i_dev, rdch, wrch, prio);
878 dsp_read(struct cdev *i_dev, struct uio *buf, int flag)
880 return (dsp_io_ops(i_dev, buf));
884 dsp_write(struct cdev *i_dev, struct uio *buf, int flag)
886 return (dsp_io_ops(i_dev, buf));
890 dsp_get_volume_channel(struct cdev *dev, struct pcm_channel **volch)
892 struct snddev_info *d;
893 struct pcm_channel *c;
896 KASSERT(dev != NULL && volch != NULL,
897 ("%s(): NULL query dev=%p volch=%p", __func__, dev, volch));
899 d = dsp_get_info(dev);
900 if (!PCM_REGISTERED(d)) {
911 if (!(c->feederflags & (1 << FEEDER_VOLUME)))
921 unit = dev2unit(dev);
923 CHN_FOREACH(c, d, channels.pcm) {
925 if (c->unit != unit) {
935 return ((c->feederflags & (1 << FEEDER_VOLUME)) ? 0 : -1);
945 dsp_ioctl_channel(struct cdev *dev, struct pcm_channel *volch, u_long cmd,
948 struct snddev_info *d;
949 struct pcm_channel *rdch, *wrch;
952 d = dsp_get_info(dev);
953 if (!PCM_REGISTERED(d) || !(dsp_get_flags(dev) & SD_F_VPC))
960 rdch = PCM_RDCH(dev);
961 wrch = PCM_WRCH(dev);
963 /* No specific channel, look into cache */
965 volch = PCM_VOLCH(dev);
969 if (j == SOUND_MIXER_RECLEV && rdch != NULL)
971 else if (j == SOUND_MIXER_PCM && wrch != NULL)
975 devtype = PCMDEV(dev);
977 /* Look super harder */
979 (devtype == SND_DEV_DSPHW_PLAY || devtype == SND_DEV_DSPHW_VPLAY ||
980 devtype == SND_DEV_DSPHW_REC || devtype == SND_DEV_DSPHW_VREC)) {
981 ret = dsp_get_volume_channel(dev, &volch);
988 /* Final validation */
991 if (!(volch->feederflags & (1 << FEEDER_VOLUME))) {
995 if (volch->direction == PCMDIR_PLAY)
1003 if (volch != NULL &&
1004 ((j == SOUND_MIXER_PCM && volch->direction == PCMDIR_PLAY) ||
1005 (j == SOUND_MIXER_RECLEV && volch->direction == PCMDIR_REC))) {
1006 if ((cmd & ~0xff) == MIXER_WRITE(0)) {
1007 int left, right, center;
1009 left = *(int *)arg & 0x7f;
1010 right = ((*(int *)arg) >> 8) & 0x7f;
1011 center = (left + right) >> 1;
1012 chn_setvolume_multi(volch, SND_VOL_C_PCM, left, right,
1014 } else if ((cmd & ~0xff) == MIXER_READ(0)) {
1015 *(int *)arg = CHN_GETVOLUME(volch,
1016 SND_VOL_C_PCM, SND_CHN_T_FL);
1017 *(int *)arg |= CHN_GETVOLUME(volch,
1018 SND_VOL_C_PCM, SND_CHN_T_FR) << 8;
1021 } else if (rdch != NULL || wrch != NULL) {
1023 case SOUND_MIXER_DEVMASK:
1024 case SOUND_MIXER_CAPS:
1025 case SOUND_MIXER_STEREODEVS:
1026 if ((cmd & ~0xff) == MIXER_READ(0)) {
1029 *(int *)arg |= SOUND_MASK_RECLEV;
1031 *(int *)arg |= SOUND_MASK_PCM;
1035 case SOUND_MIXER_RECMASK:
1036 case SOUND_MIXER_RECSRC:
1037 if ((cmd & ~0xff) == MIXER_READ(0))
1053 dsp_ioctl(struct cdev *i_dev, u_long cmd, caddr_t arg, int mode,
1056 struct pcm_channel *chn, *rdch, *wrch;
1057 struct snddev_info *d;
1058 int *arg_i, ret, tmp, xcmd;
1060 d = dsp_get_info(i_dev);
1061 if (!DSP_REGISTERED(d, i_dev))
1071 if (IOCGROUP(cmd) == 'M') {
1072 if (cmd == OSS_GETVERSION) {
1073 *arg_i = SOUND_VERSION;
1077 ret = dsp_ioctl_channel(i_dev, PCM_VOLCH(i_dev), cmd, arg);
1083 if (d->mixer_dev != NULL) {
1084 PCM_ACQUIRE_QUICK(d);
1085 ret = mixer_ioctl_cmd(d->mixer_dev, cmd, arg, -1, td,
1087 PCM_RELEASE_QUICK(d);
1097 * Certain ioctls may be made on any type of device (audio, mixer,
1098 * and MIDI). Handle those special cases here.
1100 if (IOCGROUP(cmd) == 'X') {
1101 PCM_ACQUIRE_QUICK(d);
1103 case SNDCTL_SYSINFO:
1104 sound_oss_sysinfo((oss_sysinfo *)arg);
1106 case SNDCTL_CARDINFO:
1107 ret = sound_oss_card_info((oss_card_info *)arg);
1109 case SNDCTL_AUDIOINFO:
1110 case SNDCTL_AUDIOINFO_EX:
1111 case SNDCTL_ENGINEINFO:
1112 ret = dsp_oss_audioinfo(i_dev, (oss_audioinfo *)arg);
1114 case SNDCTL_MIXERINFO:
1115 ret = mixer_oss_mixerinfo(i_dev, (oss_mixerinfo *)arg);
1120 PCM_RELEASE_QUICK(d);
1125 getchns(i_dev, &rdch, &wrch, 0);
1127 if (wrch != NULL && (wrch->flags & CHN_F_DEAD))
1129 if (rdch != NULL && (rdch->flags & CHN_F_DEAD))
1132 if (wrch == NULL && rdch == NULL) {
1140 * we start with the new ioctl interface.
1142 case AIONWRITE: /* how many bytes can write ? */
1146 if (wrch && wrch->bufhard.dl)
1147 while (chn_wrfeed(wrch) == 0);
1149 *arg_i = sndbuf_getfree(wrch->bufsoft);
1157 case AIOSSIZE: /* set the current blocksize */
1159 struct snd_size *p = (struct snd_size *)arg;
1163 PCM_ACQUIRE_QUICK(d);
1166 chn_setblocksize(wrch, 2, p->play_size);
1167 p->play_size = sndbuf_getblksz(wrch->bufsoft);
1172 chn_setblocksize(rdch, 2, p->rec_size);
1173 p->rec_size = sndbuf_getblksz(rdch->bufsoft);
1176 PCM_RELEASE_QUICK(d);
1179 case AIOGSIZE: /* get the current blocksize */
1181 struct snd_size *p = (struct snd_size *)arg;
1185 p->play_size = sndbuf_getblksz(wrch->bufsoft);
1190 p->rec_size = sndbuf_getblksz(rdch->bufsoft);
1199 snd_chan_param *p = (snd_chan_param *)arg;
1201 if (cmd == AIOSFMT &&
1202 ((p->play_format != 0 && p->play_rate == 0) ||
1203 (p->rec_format != 0 && p->rec_rate == 0))) {
1207 PCM_ACQUIRE_QUICK(d);
1210 if (cmd == AIOSFMT && p->play_format != 0) {
1212 SND_FORMAT(p->play_format,
1213 AFMT_CHANNEL(wrch->format),
1214 AFMT_EXTCHANNEL(wrch->format)));
1215 chn_setspeed(wrch, p->play_rate);
1217 p->play_rate = wrch->speed;
1218 p->play_format = AFMT_ENCODING(wrch->format);
1226 if (cmd == AIOSFMT && p->rec_format != 0) {
1228 SND_FORMAT(p->rec_format,
1229 AFMT_CHANNEL(rdch->format),
1230 AFMT_EXTCHANNEL(rdch->format)));
1231 chn_setspeed(rdch, p->rec_rate);
1233 p->rec_rate = rdch->speed;
1234 p->rec_format = AFMT_ENCODING(rdch->format);
1240 PCM_RELEASE_QUICK(d);
1244 case AIOGCAP: /* get capabilities */
1246 snd_capabilities *p = (snd_capabilities *)arg;
1247 struct pcmchan_caps *pcaps = NULL, *rcaps = NULL;
1253 rcaps = chn_getcaps(rdch);
1257 pcaps = chn_getcaps(wrch);
1259 p->rate_min = max(rcaps? rcaps->minspeed : 0,
1260 pcaps? pcaps->minspeed : 0);
1261 p->rate_max = min(rcaps? rcaps->maxspeed : 1000000,
1262 pcaps? pcaps->maxspeed : 1000000);
1263 p->bufsize = min(rdch? sndbuf_getsize(rdch->bufsoft) : 1000000,
1264 wrch? sndbuf_getsize(wrch->bufsoft) : 1000000);
1265 /* XXX bad on sb16 */
1266 p->formats = (rdch? chn_getformats(rdch) : 0xffffffff) &
1267 (wrch? chn_getformats(wrch) : 0xffffffff);
1269 p->formats |= (dsp_get_flags(i_dev) & SD_F_SIMPLEX)? 0 : AFMT_FULLDUPLEX;
1270 pdev = d->mixer_dev;
1271 p->mixers = 1; /* default: one mixer */
1272 p->inputs = pdev->si_drv1? mix_getdevs(pdev->si_drv1) : 0;
1273 p->left = p->right = 100;
1283 if (*arg_i == AIOSYNC_PLAY && wrch) {
1285 *arg_i = chn_abort(wrch);
1287 } else if (*arg_i == AIOSYNC_CAPTURE && rdch) {
1289 *arg_i = chn_abort(rdch);
1292 printf("AIOSTOP: bad channel 0x%x\n", *arg_i);
1298 printf("AIOSYNC chan 0x%03lx pos %lu unimplemented\n",
1299 ((snd_sync_parm *)arg)->chan, ((snd_sync_parm *)arg)->pos);
1303 * here follow the standard ioctls (filio.h etc.)
1305 case FIONREAD: /* get # bytes to read */
1308 /* if (rdch && rdch->bufhard.dl)
1309 while (chn_rdfeed(rdch) == 0);
1311 *arg_i = sndbuf_getready(rdch->bufsoft);
1319 case FIOASYNC: /*set/clear async i/o */
1320 DEB( printf("FIOASYNC\n") ; )
1323 case SNDCTL_DSP_NONBLOCK: /* set non-blocking i/o */
1324 case FIONBIO: /* set/clear non-blocking i/o */
1327 if (cmd == SNDCTL_DSP_NONBLOCK || *arg_i)
1328 rdch->flags |= CHN_F_NBIO;
1330 rdch->flags &= ~CHN_F_NBIO;
1335 if (cmd == SNDCTL_DSP_NONBLOCK || *arg_i)
1336 wrch->flags |= CHN_F_NBIO;
1338 wrch->flags &= ~CHN_F_NBIO;
1344 * Finally, here is the linux-compatible ioctl interface
1346 #define THE_REAL_SNDCTL_DSP_GETBLKSIZE _IOWR('P', 4, int)
1347 case THE_REAL_SNDCTL_DSP_GETBLKSIZE:
1348 case SNDCTL_DSP_GETBLKSIZE:
1349 chn = wrch ? wrch : rdch;
1352 *arg_i = sndbuf_getblksz(chn->bufsoft);
1360 case SNDCTL_DSP_SETBLKSIZE:
1361 RANGE(*arg_i, 16, 65536);
1362 PCM_ACQUIRE_QUICK(d);
1365 chn_setblocksize(wrch, 2, *arg_i);
1370 chn_setblocksize(rdch, 2, *arg_i);
1373 PCM_RELEASE_QUICK(d);
1376 case SNDCTL_DSP_RESET:
1377 DEB(printf("dsp reset\n"));
1392 case SNDCTL_DSP_SYNC:
1393 DEB(printf("dsp sync\n"));
1394 /* chn_sync may sleep */
1402 case SNDCTL_DSP_SPEED:
1403 /* chn_setspeed may sleep */
1405 PCM_ACQUIRE_QUICK(d);
1408 ret = chn_setspeed(wrch, *arg_i);
1412 if (rdch && ret == 0) {
1414 ret = chn_setspeed(rdch, *arg_i);
1419 PCM_RELEASE_QUICK(d);
1423 case SOUND_PCM_READ_RATE:
1424 chn = wrch ? wrch : rdch;
1427 *arg_i = chn->speed;
1435 case SNDCTL_DSP_STEREO:
1437 *arg_i = (*arg_i)? 2 : 1;
1438 PCM_ACQUIRE_QUICK(d);
1441 ret = chn_setformat(wrch,
1442 SND_FORMAT(wrch->format, *arg_i, 0));
1443 tmp = (AFMT_CHANNEL(wrch->format) > 1)? 1 : 0;
1446 if (rdch && ret == 0) {
1448 ret = chn_setformat(rdch,
1449 SND_FORMAT(rdch->format, *arg_i, 0));
1451 tmp = (AFMT_CHANNEL(rdch->format) > 1)? 1 : 0;
1454 PCM_RELEASE_QUICK(d);
1458 case SOUND_PCM_WRITE_CHANNELS:
1459 /* case SNDCTL_DSP_CHANNELS: ( == SOUND_PCM_WRITE_CHANNELS) */
1466 struct pcmchan_matrix *m;
1470 if (*arg_i > SND_CHN_MAX)
1471 *arg_i = SND_CHN_MAX;
1473 m = feeder_matrix_default_channel_map(*arg_i);
1479 PCM_ACQUIRE_QUICK(d);
1482 ret = chn_setformat(wrch,
1483 SND_FORMAT(wrch->format, *arg_i, ext));
1484 tmp = AFMT_CHANNEL(wrch->format);
1487 if (rdch && ret == 0) {
1489 ret = chn_setformat(rdch,
1490 SND_FORMAT(rdch->format, *arg_i, ext));
1492 tmp = AFMT_CHANNEL(rdch->format);
1495 PCM_RELEASE_QUICK(d);
1498 chn = wrch ? wrch : rdch;
1500 *arg_i = AFMT_CHANNEL(chn->format);
1505 case SOUND_PCM_READ_CHANNELS:
1506 chn = wrch ? wrch : rdch;
1509 *arg_i = AFMT_CHANNEL(chn->format);
1517 case SNDCTL_DSP_GETFMTS: /* returns a mask of supported fmts */
1518 chn = wrch ? wrch : rdch;
1521 *arg_i = chn_getformats(chn);
1529 case SNDCTL_DSP_SETFMT: /* sets _one_ format */
1530 if (*arg_i != AFMT_QUERY) {
1532 PCM_ACQUIRE_QUICK(d);
1535 ret = chn_setformat(wrch, SND_FORMAT(*arg_i,
1536 AFMT_CHANNEL(wrch->format),
1537 AFMT_EXTCHANNEL(wrch->format)));
1541 if (rdch && ret == 0) {
1543 ret = chn_setformat(rdch, SND_FORMAT(*arg_i,
1544 AFMT_CHANNEL(rdch->format),
1545 AFMT_EXTCHANNEL(rdch->format)));
1550 PCM_RELEASE_QUICK(d);
1551 *arg_i = AFMT_ENCODING(tmp);
1553 chn = wrch ? wrch : rdch;
1555 *arg_i = AFMT_ENCODING(chn->format);
1560 case SNDCTL_DSP_SETFRAGMENT:
1561 DEB(printf("SNDCTL_DSP_SETFRAGMENT 0x%08x\n", *(int *)arg));
1563 uint32_t fragln = (*arg_i) & 0x0000ffff;
1564 uint32_t maxfrags = ((*arg_i) & 0xffff0000) >> 16;
1566 uint32_t r_maxfrags, r_fragsz;
1568 RANGE(fragln, 4, 16);
1569 fragsz = 1 << fragln;
1572 maxfrags = CHN_2NDBUFMAXSIZE / fragsz;
1575 if (maxfrags * fragsz > CHN_2NDBUFMAXSIZE)
1576 maxfrags = CHN_2NDBUFMAXSIZE / fragsz;
1578 DEB(printf("SNDCTL_DSP_SETFRAGMENT %d frags, %d sz\n", maxfrags, fragsz));
1579 PCM_ACQUIRE_QUICK(d);
1582 ret = chn_setblocksize(rdch, maxfrags, fragsz);
1583 r_maxfrags = sndbuf_getblkcnt(rdch->bufsoft);
1584 r_fragsz = sndbuf_getblksz(rdch->bufsoft);
1587 r_maxfrags = maxfrags;
1590 if (wrch && ret == 0) {
1592 ret = chn_setblocksize(wrch, maxfrags, fragsz);
1593 maxfrags = sndbuf_getblkcnt(wrch->bufsoft);
1594 fragsz = sndbuf_getblksz(wrch->bufsoft);
1596 } else { /* use whatever came from the read channel */
1597 maxfrags = r_maxfrags;
1600 PCM_RELEASE_QUICK(d);
1603 while (fragsz > 1) {
1607 *arg_i = (maxfrags << 16) | fragln;
1611 case SNDCTL_DSP_GETISPACE:
1612 /* return the size of data available in the input queue */
1614 audio_buf_info *a = (audio_buf_info *)arg;
1616 struct snd_dbuf *bs = rdch->bufsoft;
1619 a->bytes = sndbuf_getready(bs);
1620 a->fragments = a->bytes / sndbuf_getblksz(bs);
1621 a->fragstotal = sndbuf_getblkcnt(bs);
1622 a->fragsize = sndbuf_getblksz(bs);
1629 case SNDCTL_DSP_GETOSPACE:
1630 /* return space available in the output queue */
1632 audio_buf_info *a = (audio_buf_info *)arg;
1634 struct snd_dbuf *bs = wrch->bufsoft;
1637 /* XXX abusive DMA update: chn_wrupdate(wrch); */
1638 a->bytes = sndbuf_getfree(bs);
1639 a->fragments = a->bytes / sndbuf_getblksz(bs);
1640 a->fragstotal = sndbuf_getblkcnt(bs);
1641 a->fragsize = sndbuf_getblksz(bs);
1648 case SNDCTL_DSP_GETIPTR:
1650 count_info *a = (count_info *)arg;
1652 struct snd_dbuf *bs = rdch->bufsoft;
1655 /* XXX abusive DMA update: chn_rdupdate(rdch); */
1656 a->bytes = sndbuf_gettotal(bs);
1657 a->blocks = sndbuf_getblocks(bs) - rdch->blocks;
1658 a->ptr = sndbuf_getreadyptr(bs);
1659 rdch->blocks = sndbuf_getblocks(bs);
1666 case SNDCTL_DSP_GETOPTR:
1668 count_info *a = (count_info *)arg;
1670 struct snd_dbuf *bs = wrch->bufsoft;
1673 /* XXX abusive DMA update: chn_wrupdate(wrch); */
1674 a->bytes = sndbuf_gettotal(bs);
1675 a->blocks = sndbuf_getblocks(bs) - wrch->blocks;
1676 a->ptr = sndbuf_getreadyptr(bs);
1677 wrch->blocks = sndbuf_getblocks(bs);
1684 case SNDCTL_DSP_GETCAPS:
1686 *arg_i = PCM_CAP_REALTIME | PCM_CAP_MMAP | PCM_CAP_TRIGGER;
1687 if (rdch && wrch && !(dsp_get_flags(i_dev) & SD_F_SIMPLEX))
1688 *arg_i |= PCM_CAP_DUPLEX;
1692 case SOUND_PCM_READ_BITS:
1693 chn = wrch ? wrch : rdch;
1696 if (chn->format & AFMT_8BIT)
1698 else if (chn->format & AFMT_16BIT)
1700 else if (chn->format & AFMT_24BIT)
1702 else if (chn->format & AFMT_32BIT)
1713 case SNDCTL_DSP_SETTRIGGER:
1716 rdch->flags &= ~CHN_F_NOTRIGGER;
1717 if (*arg_i & PCM_ENABLE_INPUT)
1722 rdch->flags |= CHN_F_NOTRIGGER;
1728 wrch->flags &= ~CHN_F_NOTRIGGER;
1729 if (*arg_i & PCM_ENABLE_OUTPUT)
1734 wrch->flags |= CHN_F_NOTRIGGER;
1740 case SNDCTL_DSP_GETTRIGGER:
1744 if (wrch->flags & CHN_F_TRIGGERED)
1745 *arg_i |= PCM_ENABLE_OUTPUT;
1750 if (rdch->flags & CHN_F_TRIGGERED)
1751 *arg_i |= PCM_ENABLE_INPUT;
1756 case SNDCTL_DSP_GETODELAY:
1758 struct snd_dbuf *bs = wrch->bufsoft;
1761 /* XXX abusive DMA update: chn_wrupdate(wrch); */
1762 *arg_i = sndbuf_getready(bs);
1768 case SNDCTL_DSP_POST:
1771 wrch->flags &= ~CHN_F_NOTRIGGER;
1777 case SNDCTL_DSP_SETDUPLEX:
1779 * switch to full-duplex mode if card is in half-duplex
1780 * mode and is able to work in full-duplex mode
1783 if (rdch && wrch && (dsp_get_flags(i_dev) & SD_F_SIMPLEX))
1784 dsp_set_flags(i_dev, dsp_get_flags(i_dev)^SD_F_SIMPLEX);
1789 * The following four ioctls are simple wrappers around mixer_ioctl
1790 * with no further processing. xcmd is short for "translated
1793 case SNDCTL_DSP_GETRECVOL:
1795 xcmd = SOUND_MIXER_READ_RECLEV;
1799 case SNDCTL_DSP_SETRECVOL:
1801 xcmd = SOUND_MIXER_WRITE_RECLEV;
1805 case SNDCTL_DSP_GETPLAYVOL:
1807 xcmd = SOUND_MIXER_READ_PCM;
1811 case SNDCTL_DSP_SETPLAYVOL:
1813 xcmd = SOUND_MIXER_WRITE_PCM;
1817 ret = dsp_ioctl_channel(i_dev, chn, xcmd, arg);
1823 if (d->mixer_dev != NULL) {
1824 PCM_ACQUIRE_QUICK(d);
1825 ret = mixer_ioctl_cmd(d->mixer_dev, xcmd, arg, -1, td,
1827 PCM_RELEASE_QUICK(d);
1833 case SNDCTL_DSP_GET_RECSRC_NAMES:
1834 case SNDCTL_DSP_GET_RECSRC:
1835 case SNDCTL_DSP_SET_RECSRC:
1836 if (d->mixer_dev != NULL) {
1837 PCM_ACQUIRE_QUICK(d);
1838 ret = mixer_ioctl_cmd(d->mixer_dev, cmd, arg, -1, td,
1840 PCM_RELEASE_QUICK(d);
1846 * The following 3 ioctls aren't very useful at the moment. For
1847 * now, only a single channel is associated with a cdev (/dev/dspN
1848 * instance), so there's only a single output routing to use (i.e.,
1849 * the wrch bound to this cdev).
1851 case SNDCTL_DSP_GET_PLAYTGT_NAMES:
1853 oss_mixer_enuminfo *ei;
1854 ei = (oss_mixer_enuminfo *)arg;
1857 ei->version = 0; /* static for now */
1858 ei->strindex[0] = 0;
1862 strlcpy(ei->strings, wrch->name,
1863 sizeof(ei->strings));
1866 ei->strings[0] = '\0';
1870 case SNDCTL_DSP_GET_PLAYTGT:
1871 case SNDCTL_DSP_SET_PLAYTGT: /* yes, they are the same for now */
1874 * OSSv4: "The value that was accepted by the device will
1875 * be returned back in the variable pointed by the
1884 case SNDCTL_DSP_SILENCE:
1886 * Flush the software (pre-feed) buffer, but try to minimize playback
1887 * interruption. (I.e., record unplayed samples with intent to
1888 * restore by SNDCTL_DSP_SKIP.) Intended for application "pause"
1894 struct snd_dbuf *bs;
1896 while (wrch->inprog != 0)
1897 cv_wait(&wrch->cv, wrch->lock);
1899 if ((bs->shadbuf != NULL) && (sndbuf_getready(bs) > 0)) {
1900 bs->sl = sndbuf_getready(bs);
1901 sndbuf_dispose(bs, bs->shadbuf, sndbuf_getready(bs));
1902 sndbuf_fillsilence(bs);
1909 case SNDCTL_DSP_SKIP:
1911 * OSSv4 docs: "This ioctl call discards all unplayed samples in the
1912 * playback buffer by moving the current write position immediately
1913 * before the point where the device is currently reading the samples."
1918 struct snd_dbuf *bs;
1920 while (wrch->inprog != 0)
1921 cv_wait(&wrch->cv, wrch->lock);
1923 if ((bs->shadbuf != NULL) && (bs->sl > 0)) {
1924 sndbuf_softreset(bs);
1925 sndbuf_acquire(bs, bs->shadbuf, bs->sl);
1933 case SNDCTL_DSP_CURRENT_OPTR:
1934 case SNDCTL_DSP_CURRENT_IPTR:
1936 * @note Changing formats resets the buffer counters, which differs
1937 * from the 4Front drivers. However, I don't expect this to be
1938 * much of a problem.
1940 * @note In a test where @c CURRENT_OPTR is called immediately after write
1941 * returns, this driver is about 32K samples behind whereas
1942 * 4Front's is about 8K samples behind. Should determine source
1943 * of discrepancy, even if only out of curiosity.
1945 * @todo Actually test SNDCTL_DSP_CURRENT_IPTR.
1947 chn = (cmd == SNDCTL_DSP_CURRENT_OPTR) ? wrch : rdch;
1951 struct snd_dbuf *bs;
1954 oss_count_t *oc = (oss_count_t *)arg;
1959 tmp = (sndbuf_getsize(b) + chn_getptr(chn) - sndbuf_gethwptr(b)) % sndbuf_getsize(b);
1960 oc->samples = (sndbuf_gettotal(b) + tmp) / sndbuf_getalign(b);
1961 oc->fifo_samples = (sndbuf_getready(b) - tmp) / sndbuf_getalign(b);
1963 oc->samples = sndbuf_gettotal(bs) / sndbuf_getalign(bs);
1964 oc->fifo_samples = sndbuf_getready(bs) / sndbuf_getalign(bs);
1970 case SNDCTL_DSP_HALT_OUTPUT:
1971 case SNDCTL_DSP_HALT_INPUT:
1972 chn = (cmd == SNDCTL_DSP_HALT_OUTPUT) ? wrch : rdch;
1982 case SNDCTL_DSP_LOW_WATER:
1984 * Set the number of bytes required to attract attention by
1989 wrch->lw = (*arg_i > 1) ? *arg_i : 1;
1994 rdch->lw = (*arg_i > 1) ? *arg_i : 1;
1999 case SNDCTL_DSP_GETERROR:
2001 * OSSv4 docs: "All errors and counters will automatically be
2002 * cleared to zeroes after the call so each call will return only
2003 * the errors that occurred after the previous invocation. ... The
2004 * play_underruns and rec_overrun fields are the only usefull fields
2005 * returned by OSS 4.0."
2008 audio_errinfo *ei = (audio_errinfo *)arg;
2010 bzero((void *)ei, sizeof(*ei));
2014 ei->play_underruns = wrch->xruns;
2020 ei->rec_overruns = rdch->xruns;
2027 case SNDCTL_DSP_SYNCGROUP:
2028 PCM_ACQUIRE_QUICK(d);
2029 ret = dsp_oss_syncgroup(wrch, rdch, (oss_syncgroup *)arg);
2030 PCM_RELEASE_QUICK(d);
2033 case SNDCTL_DSP_SYNCSTART:
2034 PCM_ACQUIRE_QUICK(d);
2035 ret = dsp_oss_syncstart(*arg_i);
2036 PCM_RELEASE_QUICK(d);
2039 case SNDCTL_DSP_POLICY:
2040 PCM_ACQUIRE_QUICK(d);
2041 ret = dsp_oss_policy(wrch, rdch, *arg_i);
2042 PCM_RELEASE_QUICK(d);
2045 case SNDCTL_DSP_COOKEDMODE:
2046 PCM_ACQUIRE_QUICK(d);
2047 if (!(dsp_get_flags(i_dev) & SD_F_BITPERFECT))
2048 ret = dsp_oss_cookedmode(wrch, rdch, *arg_i);
2049 PCM_RELEASE_QUICK(d);
2051 case SNDCTL_DSP_GET_CHNORDER:
2052 PCM_ACQUIRE_QUICK(d);
2053 ret = dsp_oss_getchnorder(wrch, rdch, (unsigned long long *)arg);
2054 PCM_RELEASE_QUICK(d);
2056 case SNDCTL_DSP_SET_CHNORDER:
2057 PCM_ACQUIRE_QUICK(d);
2058 ret = dsp_oss_setchnorder(wrch, rdch, (unsigned long long *)arg);
2059 PCM_RELEASE_QUICK(d);
2061 case SNDCTL_DSP_GETCHANNELMASK: /* XXX vlc */
2062 PCM_ACQUIRE_QUICK(d);
2063 ret = dsp_oss_getchannelmask(wrch, rdch, (int *)arg);
2064 PCM_RELEASE_QUICK(d);
2066 case SNDCTL_DSP_BIND_CHANNEL: /* XXX what?!? */
2069 #ifdef OSSV4_EXPERIMENT
2071 * XXX The following ioctls are not yet supported and just return
2074 case SNDCTL_DSP_GETOPEAKS:
2075 case SNDCTL_DSP_GETIPEAKS:
2076 chn = (cmd == SNDCTL_DSP_GETOPEAKS) ? wrch : rdch;
2080 oss_peaks_t *op = (oss_peaks_t *)arg;
2084 ret = chn_getpeaks(chn, &lpeak, &rpeak);
2096 * XXX Once implemented, revisit this for proper cv protection
2099 case SNDCTL_GETLABEL:
2100 ret = dsp_oss_getlabel(wrch, rdch, (oss_label_t *)arg);
2102 case SNDCTL_SETLABEL:
2103 ret = dsp_oss_setlabel(wrch, rdch, (oss_label_t *)arg);
2105 case SNDCTL_GETSONG:
2106 ret = dsp_oss_getsong(wrch, rdch, (oss_longname_t *)arg);
2108 case SNDCTL_SETSONG:
2109 ret = dsp_oss_setsong(wrch, rdch, (oss_longname_t *)arg);
2111 case SNDCTL_SETNAME:
2112 ret = dsp_oss_setname(wrch, rdch, (oss_longname_t *)arg);
2116 * @note The S/PDIF interface ioctls, @c SNDCTL_DSP_READCTL and
2117 * @c SNDCTL_DSP_WRITECTL have been omitted at the suggestion of
2118 * 4Front Technologies.
2120 case SNDCTL_DSP_READCTL:
2121 case SNDCTL_DSP_WRITECTL:
2124 #endif /* !0 (explicitly omitted ioctls) */
2126 #endif /* !OSSV4_EXPERIMENT */
2127 case SNDCTL_DSP_MAPINBUF:
2128 case SNDCTL_DSP_MAPOUTBUF:
2129 case SNDCTL_DSP_SETSYNCRO:
2132 case SNDCTL_DSP_SUBDIVIDE:
2133 case SOUND_PCM_WRITE_FILTER:
2134 case SOUND_PCM_READ_FILTER:
2135 /* dunno what these do, don't sound important */
2138 DEB(printf("default ioctl fn 0x%08lx fail\n", cmd));
2149 dsp_poll(struct cdev *i_dev, int events, struct thread *td)
2151 struct snddev_info *d;
2152 struct pcm_channel *wrch, *rdch;
2155 d = dsp_get_info(i_dev);
2156 if (!DSP_REGISTERED(d, i_dev))
2165 getchns(i_dev, &rdch, &wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2167 if (wrch != NULL && !(wrch->flags & CHN_F_DEAD)) {
2168 e = (events & (POLLOUT | POLLWRNORM));
2170 ret |= chn_poll(wrch, e, td);
2173 if (rdch != NULL && !(rdch->flags & CHN_F_DEAD)) {
2174 e = (events & (POLLIN | POLLRDNORM));
2176 ret |= chn_poll(rdch, e, td);
2179 relchns(i_dev, rdch, wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2187 dsp_mmap(struct cdev *i_dev, vm_offset_t offset, vm_paddr_t *paddr, int nprot)
2189 struct snddev_info *d;
2190 struct pcm_channel *wrch, *rdch, *c;
2193 * Reject PROT_EXEC by default. It just doesn't makes sense.
2194 * Unfortunately, we have to give up this one due to linux_mmap
2197 * http://lists.freebsd.org/pipermail/freebsd-emulation/2007-June/003698.html
2201 if ((nprot & PROT_EXEC) && (dsp_mmap_allow_prot_exec < 0 ||
2202 (dsp_mmap_allow_prot_exec == 0 &&
2203 SV_CURPROC_ABI() != SV_ABI_LINUX)))
2205 if ((nprot & PROT_EXEC) && dsp_mmap_allow_prot_exec < 1)
2209 d = dsp_get_info(i_dev);
2210 if (!DSP_REGISTERED(d, i_dev))
2215 getchns(i_dev, &rdch, &wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2218 * XXX The linux api uses the nprot to select read/write buffer
2219 * our vm system doesn't allow this, so force write buffer.
2221 * This is just a quack to fool full-duplex mmap, so that at
2222 * least playback _or_ recording works. If you really got the
2223 * urge to make _both_ work at the same time, avoid O_RDWR.
2224 * Just open each direction separately and mmap() it.
2226 * Failure is not an option due to INVARIANTS check within
2227 * device_pager.c, which means, we have to give up one over
2230 c = (wrch != NULL) ? wrch : rdch;
2232 if (c == NULL || (c->flags & CHN_F_MMAP_INVALID) ||
2233 offset >= sndbuf_getsize(c->bufsoft) ||
2234 (wrch != NULL && (wrch->flags & CHN_F_MMAP_INVALID)) ||
2235 (rdch != NULL && (rdch->flags & CHN_F_MMAP_INVALID))) {
2236 relchns(i_dev, rdch, wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2241 /* XXX full-duplex quack. */
2243 wrch->flags |= CHN_F_MMAP;
2245 rdch->flags |= CHN_F_MMAP;
2247 *paddr = vtophys(sndbuf_getbufofs(c->bufsoft, offset));
2248 relchns(i_dev, rdch, wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2255 /* So much for dev_stdclone() */
2257 dsp_stdclone(char *name, char *namep, char *sep, int use_sep, int *u, int *c)
2261 len = strlen(namep);
2263 if (bcmp(name, namep, len) != 0)
2268 if (isdigit(*name) == 0)
2273 if (*name == '0' && !(name[1] == '\0' || bcmp(name + 1, sep, len) == 0))
2276 for (*u = 0; isdigit(*name) != 0; name++) {
2284 return ((use_sep == 0) ? 0 : ENODEV);
2286 if (bcmp(name, sep, len) != 0 || isdigit(name[len]) == 0)
2291 if (*name == '0' && name[1] != '\0')
2294 for (*c = 0; isdigit(*name) != 0; name++) {
2308 dsp_clone(void *arg,
2309 #if __FreeBSD_version >= 600034
2312 char *name, int namelen, struct cdev **dev)
2314 struct snddev_info *d;
2315 struct snd_clone_entry *ce;
2316 struct pcm_channel *c;
2317 int i, unit, udcmask, cunit, devtype, devhw, devcmax, tumax;
2318 char *devname, *devcmp, *devsep;
2320 KASSERT(dsp_umax >= 0 && dsp_cmax >= 0, ("Uninitialized unit!"));
2334 for (i = 0; unit == -1 &&
2335 i < (sizeof(dsp_cdevs) / sizeof(dsp_cdevs[0])); i++) {
2336 devtype = dsp_cdevs[i].type;
2337 devcmp = dsp_cdevs[i].name;
2338 devsep = dsp_cdevs[i].sep;
2339 devname = dsp_cdevs[i].alias;
2340 if (devname == NULL)
2342 devhw = dsp_cdevs[i].hw;
2343 devcmax = dsp_cdevs[i].max - 1;
2344 if (strcmp(name, devcmp) == 0)
2346 else if (dsp_stdclone(name, devcmp, devsep,
2347 dsp_cdevs[i].use_sep, &unit, &cunit) != 0) {
2353 d = devclass_get_softc(pcm_devclass, unit);
2354 if (!PCM_REGISTERED(d) || d->clones == NULL)
2357 /* XXX Need Giant magic entry ??? */
2360 if (snd_clone_disabled(d->clones)) {
2369 udcmask = snd_u2unit(unit) | snd_d2unit(devtype);
2372 KASSERT(devcmax <= dsp_cmax,
2373 ("overflow: devcmax=%d, dsp_cmax=%d", devcmax, dsp_cmax));
2374 if (cunit > devcmax) {
2375 PCM_RELEASE_QUICK(d);
2378 udcmask |= snd_c2unit(cunit);
2379 CHN_FOREACH(c, d, channels.pcm) {
2381 if (c->unit != udcmask) {
2386 udcmask &= ~snd_c2unit(cunit);
2388 * Temporarily increase clone maxunit to overcome
2389 * vchan flexibility.
2391 * # sysctl dev.pcm.0.play.vchans=256
2392 * dev.pcm.0.play.vchans: 1 -> 256
2393 * # cat /dev/zero > /dev/dsp0.vp255 &
2395 * # sysctl dev.pcm.0.play.vchans=0
2396 * dev.pcm.0.play.vchans: 256 -> 1
2398 * [1] + running cat /dev/zero > /dev/dsp0.vp255
2400 * # cat /dev/zero > /dev/dsp0.vp255
2401 * zsh: operation not supported: /dev/dsp0.vp255
2403 tumax = snd_clone_getmaxunit(d->clones);
2405 snd_clone_setmaxunit(d->clones, cunit);
2408 goto dsp_clone_alloc;
2411 * Ok, so we're requesting unallocated vchan, but still
2412 * within maximum vchan limit.
2414 if (((devtype == SND_DEV_DSPHW_VPLAY && d->pvchancount > 0) ||
2415 (devtype == SND_DEV_DSPHW_VREC && d->rvchancount > 0)) &&
2416 cunit < snd_maxautovchans) {
2417 udcmask &= ~snd_c2unit(cunit);
2418 tumax = snd_clone_getmaxunit(d->clones);
2420 snd_clone_setmaxunit(d->clones, cunit);
2423 goto dsp_clone_alloc;
2425 PCM_RELEASE_QUICK(d);
2430 ce = snd_clone_alloc(d->clones, dev, &cunit, udcmask);
2432 snd_clone_setmaxunit(d->clones, tumax);
2434 udcmask |= snd_c2unit(cunit);
2435 *dev = make_dev(&dsp_cdevsw, PCMMINOR(udcmask),
2436 UID_ROOT, GID_WHEEL, 0666, "%s%d%s%d",
2437 devname, unit, devsep, cunit);
2438 snd_clone_register(ce, *dev);
2441 PCM_RELEASE_QUICK(d);
2448 dsp_sysinit(void *p)
2450 if (dsp_ehtag != NULL)
2452 /* initialize unit numbering */
2454 dsp_umax = PCMMAXUNIT;
2455 dsp_cmax = PCMMAXCHAN;
2456 dsp_ehtag = EVENTHANDLER_REGISTER(dev_clone, dsp_clone, 0, 1000);
2460 dsp_sysuninit(void *p)
2462 if (dsp_ehtag == NULL)
2464 EVENTHANDLER_DEREGISTER(dev_clone, dsp_ehtag);
2468 SYSINIT(dsp_sysinit, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, dsp_sysinit, NULL);
2469 SYSUNINIT(dsp_sysuninit, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, dsp_sysuninit, NULL);
2472 dsp_unit2name(char *buf, size_t len, int unit)
2476 KASSERT(buf != NULL && len != 0,
2477 ("bogus buf=%p len=%ju", buf, (uintmax_t)len));
2479 dtype = snd_unit2d(unit);
2481 for (i = 0; i < (sizeof(dsp_cdevs) / sizeof(dsp_cdevs[0])); i++) {
2482 if (dtype != dsp_cdevs[i].type || dsp_cdevs[i].alias != NULL)
2484 snprintf(buf, len, "%s%d%s%d", dsp_cdevs[i].name,
2485 snd_unit2u(unit), dsp_cdevs[i].sep, snd_unit2c(unit));
2493 * @brief Handler for SNDCTL_AUDIOINFO.
2495 * Gathers information about the audio device specified in ai->dev. If
2496 * ai->dev == -1, then this function gathers information about the current
2497 * device. If the call comes in on a non-audio device and ai->dev == -1,
2500 * This routine is supposed to go practically straight to the hardware,
2501 * getting capabilities directly from the sound card driver, side-stepping
2502 * the intermediate channel interface.
2504 * Note, however, that the usefulness of this command is significantly
2505 * decreased when requesting info about any device other than the one serving
2506 * the request. While each snddev_channel refers to a specific device node,
2507 * the converse is *not* true. Currently, when a sound device node is opened,
2508 * the sound subsystem scans for an available audio channel (or channels, if
2509 * opened in read+write) and then assigns them to the si_drv[12] private
2510 * data fields. As a result, any information returned linking a channel to
2511 * a specific character device isn't necessarily accurate.
2514 * Calling threads must not hold any snddev_info or pcm_channel locks.
2516 * @param dev device on which the ioctl was issued
2517 * @param ai ioctl request data container
2520 * @retval EINVAL ai->dev specifies an invalid device
2522 * @todo Verify correctness of Doxygen tags. ;)
2525 dsp_oss_audioinfo(struct cdev *i_dev, oss_audioinfo *ai)
2527 struct pcmchan_caps *caps;
2528 struct pcm_channel *ch;
2529 struct snddev_info *d;
2531 int i, nchan, *rates, minch, maxch;
2532 char *devname, buf[CHN_NAMELEN];
2535 * If probing the device that received the ioctl, make sure it's a
2536 * DSP device. (Users may use this ioctl with /dev/mixer and
2539 if (ai->dev == -1 && i_dev->si_devsw != &dsp_cdevsw)
2545 bzero(buf, sizeof(buf));
2548 * Search for the requested audio device (channel). Start by
2549 * iterating over pcm devices.
2551 for (i = 0; pcm_devclass != NULL &&
2552 i < devclass_get_maxunit(pcm_devclass); i++) {
2553 d = devclass_get_softc(pcm_devclass, i);
2554 if (!PCM_REGISTERED(d))
2557 /* XXX Need Giant magic entry ??? */
2559 /* See the note in function docblock */
2560 PCM_UNLOCKASSERT(d);
2563 CHN_FOREACH(ch, d, channels.pcm) {
2564 CHN_UNLOCKASSERT(ch);
2566 if (ai->dev == -1) {
2567 if (DSP_REGISTERED(d, i_dev) &&
2568 (ch == PCM_RDCH(i_dev) || /* record ch */
2569 ch == PCM_WRCH(i_dev))) { /* playback ch */
2570 devname = dsp_unit2name(buf,
2571 sizeof(buf), ch->unit);
2573 } else if (ai->dev == nchan) {
2574 devname = dsp_unit2name(buf, sizeof(buf),
2577 if (devname != NULL)
2583 if (devname != NULL) {
2585 * At this point, the following synchronization stuff
2587 * - a specific PCM device is locked.
2588 * - a specific audio channel has been locked, so be
2589 * sure to unlock when exiting;
2592 caps = chn_getcaps(ch);
2595 * With all handles collected, zero out the user's
2596 * container and begin filling in its fields.
2598 bzero((void *)ai, sizeof(oss_audioinfo));
2601 strlcpy(ai->name, ch->name, sizeof(ai->name));
2603 if ((ch->flags & CHN_F_BUSY) == 0)
2606 ai->busy = (ch->direction == PCMDIR_PLAY) ? OPEN_WRITE : OPEN_READ;
2610 * @c cmd - OSSv4 docs: "Only supported under Linux at
2611 * this moment." Cop-out, I know, but I'll save
2612 * running around in the process table for later.
2613 * Is there a risk of leaking information?
2618 * These flags stolen from SNDCTL_DSP_GETCAPS handler.
2619 * Note, however, that a single channel operates in
2620 * only one direction, so PCM_CAP_DUPLEX is out.
2623 * @todo @c SNDCTL_AUDIOINFO::caps - Make drivers keep
2624 * these in pcmchan::caps?
2626 ai->caps = PCM_CAP_REALTIME | PCM_CAP_MMAP | PCM_CAP_TRIGGER |
2627 ((ch->direction == PCMDIR_PLAY) ? PCM_CAP_OUTPUT : PCM_CAP_INPUT);
2630 * Collect formats supported @b natively by the
2631 * device. Also determine min/max channels. (I.e.,
2632 * mono, stereo, or both?)
2634 * If any channel is stereo, maxch = 2;
2635 * if all channels are stereo, minch = 2, too;
2636 * if any channel is mono, minch = 1;
2637 * and if all channels are mono, maxch = 1.
2642 for (i = 0; caps->fmtlist[i]; i++) {
2643 fmts |= caps->fmtlist[i];
2644 if (AFMT_CHANNEL(caps->fmtlist[i]) > 1) {
2645 minch = (minch == 0) ? 2 : minch;
2649 maxch = (maxch == 0) ? 1 : maxch;
2653 if (ch->direction == PCMDIR_PLAY)
2654 ai->oformats = fmts;
2656 ai->iformats = fmts;
2660 * @c magic - OSSv4 docs: "Reserved for internal use
2664 * @c card_number - OSSv4 docs: "Number of the sound
2665 * card where this device belongs or -1 if this
2666 * information is not available. Applications
2667 * should normally not use this field for any
2670 ai->card_number = -1;
2672 * @todo @c song_name - depends first on
2673 * SNDCTL_[GS]ETSONG @todo @c label - depends
2674 * on SNDCTL_[GS]ETLABEL
2675 * @todo @c port_number - routing information?
2677 ai->port_number = -1;
2678 ai->mixer_dev = (d->mixer_dev != NULL) ? PCMUNIT(d->mixer_dev) : -1;
2681 * @c real_device - OSSv4 docs: "Obsolete."
2683 ai->real_device = -1;
2684 strlcpy(ai->devnode, "/dev/", sizeof(ai->devnode));
2685 strlcat(ai->devnode, devname, sizeof(ai->devnode));
2686 ai->enabled = device_is_attached(d->dev) ? 1 : 0;
2689 * @c flags - OSSv4 docs: "Reserved for future use."
2692 * @c binding - OSSv4 docs: "Reserved for future use."
2694 * @todo @c handle - haven't decided how to generate
2695 * this yet; bus, vendor, device IDs?
2697 ai->min_rate = caps->minspeed;
2698 ai->max_rate = caps->maxspeed;
2700 ai->min_channels = minch;
2701 ai->max_channels = maxch;
2703 ai->nrates = chn_getrates(ch, &rates);
2704 if (ai->nrates > OSS_MAX_SAMPLE_RATES)
2705 ai->nrates = OSS_MAX_SAMPLE_RATES;
2707 for (i = 0; i < ai->nrates; i++)
2708 ai->rates[i] = rates[i];
2710 ai->next_play_engine = 0;
2711 ai->next_rec_engine = 0;
2718 if (devname != NULL)
2722 /* Exhausted the search -- nothing is locked, so return. */
2727 * @brief Assigns a PCM channel to a sync group.
2729 * Sync groups are used to enable audio operations on multiple devices
2730 * simultaneously. They may be used with any number of devices and may
2731 * span across applications. Devices are added to groups with
2732 * the SNDCTL_DSP_SYNCGROUP ioctl, and operations are triggered with the
2733 * SNDCTL_DSP_SYNCSTART ioctl.
2735 * If the @c id field of the @c group parameter is set to zero, then a new
2736 * sync group is created. Otherwise, wrch and rdch (if set) are added to
2737 * the group specified.
2739 * @todo As far as memory allocation, should we assume that things are
2740 * okay and allocate with M_WAITOK before acquiring channel locks,
2741 * freeing later if not?
2743 * @param wrch output channel associated w/ device (if any)
2744 * @param rdch input channel associated w/ device (if any)
2745 * @param group Sync group parameters
2748 * @retval non-zero error to be propagated upstream
2751 dsp_oss_syncgroup(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_syncgroup *group)
2753 struct pcmchan_syncmember *smrd, *smwr;
2754 struct pcmchan_syncgroup *sg;
2763 * Free_unr() may sleep, so store released syncgroup IDs until after
2764 * all locks are released.
2766 sg_ids[0] = sg_ids[1] = sg_ids[2] = 0;
2771 * - Insert channel(s) into group's member list.
2772 * - Set CHN_F_NOTRIGGER on channel(s).
2773 * - Stop channel(s).
2777 * If device's channels are already mapped to a group, unmap them.
2781 sg_ids[0] = chn_syncdestroy(wrch);
2786 sg_ids[1] = chn_syncdestroy(rdch);
2790 * Verify that mode matches character device properites.
2791 * - Bail if PCM_ENABLE_OUTPUT && wrch == NULL.
2792 * - Bail if PCM_ENABLE_INPUT && rdch == NULL.
2794 if (((wrch == NULL) && (group->mode & PCM_ENABLE_OUTPUT)) ||
2795 ((rdch == NULL) && (group->mode & PCM_ENABLE_INPUT))) {
2801 * An id of zero indicates the user wants to create a new
2804 if (group->id == 0) {
2805 sg = (struct pcmchan_syncgroup *)malloc(sizeof(*sg), M_DEVBUF, M_NOWAIT);
2807 SLIST_INIT(&sg->members);
2808 sg->id = alloc_unr(pcmsg_unrhdr);
2811 SLIST_INSERT_HEAD(&snd_pcm_syncgroups, sg, link);
2815 SLIST_FOREACH(sg, &snd_pcm_syncgroups, link) {
2816 if (sg->id == group->id)
2823 /* Couldn't create or find a syncgroup. Fail. */
2828 * Allocate a syncmember, assign it and a channel together, and
2829 * insert into syncgroup.
2831 if (group->mode & PCM_ENABLE_INPUT) {
2832 smrd = (struct pcmchan_syncmember *)malloc(sizeof(*smrd), M_DEVBUF, M_NOWAIT);
2838 SLIST_INSERT_HEAD(&sg->members, smrd, link);
2843 rdch->flags |= CHN_F_NOTRIGGER;
2847 if (group->mode & PCM_ENABLE_OUTPUT) {
2848 smwr = (struct pcmchan_syncmember *)malloc(sizeof(*smwr), M_DEVBUF, M_NOWAIT);
2854 SLIST_INSERT_HEAD(&sg->members, smwr, link);
2859 wrch->flags |= CHN_F_NOTRIGGER;
2867 free(smrd, M_DEVBUF);
2868 if ((sg != NULL) && SLIST_EMPTY(&sg->members)) {
2870 SLIST_REMOVE(&snd_pcm_syncgroups, sg, pcmchan_syncgroup, link);
2888 free_unr(pcmsg_unrhdr, sg_ids[0]);
2890 free_unr(pcmsg_unrhdr, sg_ids[1]);
2892 free_unr(pcmsg_unrhdr, sg_ids[2]);
2898 * @brief Launch a sync group into action
2900 * Sync groups are established via SNDCTL_DSP_SYNCGROUP. This function
2901 * iterates over all members, triggering them along the way.
2903 * @note Caller must not hold any channel locks.
2905 * @param sg_id sync group identifier
2908 * @retval non-zero error worthy of propagating upstream to user
2911 dsp_oss_syncstart(int sg_id)
2913 struct pcmchan_syncmember *sm, *sm_tmp;
2914 struct pcmchan_syncgroup *sg;
2915 struct pcm_channel *c;
2918 /* Get the synclists lock */
2925 /* Search for syncgroup by ID */
2926 SLIST_FOREACH(sg, &snd_pcm_syncgroups, link) {
2927 if (sg->id == sg_id)
2931 /* Return EINVAL if not found */
2937 /* Any removals resulting in an empty group should've handled this */
2938 KASSERT(!SLIST_EMPTY(&sg->members), ("found empty syncgroup"));
2941 * Attempt to lock all member channels - if any are already
2942 * locked, unlock those acquired, sleep for a bit, and try
2945 SLIST_FOREACH(sm, &sg->members, link) {
2946 if (CHN_TRYLOCK(sm->ch) == 0) {
2947 int timo = hz * 5/1000;
2951 /* Release all locked channels so far, retry */
2952 SLIST_FOREACH(sm_tmp, &sg->members, link) {
2953 /* sm is the member already locked */
2956 CHN_UNLOCK(sm_tmp->ch);
2959 /** @todo Is PRIBIO correct/ */
2960 ret = msleep(sm, &snd_pcm_syncgroups_mtx,
2961 PRIBIO | PCATCH, "pcmsg", timo);
2962 if (ret == EINTR || ret == ERESTART)
2966 ret = 0; /* Assumes ret == EAGAIN... */
2969 } while (needlocks && ret == 0);
2971 /* Proceed only if no errors encountered. */
2973 /* Launch channels */
2974 while ((sm = SLIST_FIRST(&sg->members)) != NULL) {
2975 SLIST_REMOVE_HEAD(&sg->members, link);
2980 c->flags &= ~CHN_F_NOTRIGGER;
2986 SLIST_REMOVE(&snd_pcm_syncgroups, sg, pcmchan_syncgroup, link);
2993 * Free_unr() may sleep, so be sure to give up the syncgroup lock
2997 free_unr(pcmsg_unrhdr, sg_id);
3003 * @brief Handler for SNDCTL_DSP_POLICY
3005 * The SNDCTL_DSP_POLICY ioctl is a simpler interface to control fragment
3006 * size and count like with SNDCTL_DSP_SETFRAGMENT. Instead of the user
3007 * specifying those two parameters, s/he simply selects a number from 0..10
3008 * which corresponds to a buffer size. Smaller numbers request smaller
3009 * buffers with lower latencies (at greater overhead from more frequent
3010 * interrupts), while greater numbers behave in the opposite manner.
3012 * The 4Front spec states that a value of 5 should be the default. However,
3013 * this implementation deviates slightly by using a linear scale without
3014 * consulting drivers. I.e., even though drivers may have different default
3015 * buffer sizes, a policy argument of 5 will have the same result across
3018 * See http://manuals.opensound.com/developer/SNDCTL_DSP_POLICY.html for
3021 * @todo When SNDCTL_DSP_COOKEDMODE is supported, it'll be necessary to
3022 * work with hardware drivers directly.
3024 * @note PCM channel arguments must not be locked by caller.
3026 * @param wrch Pointer to opened playback channel (optional; may be NULL)
3027 * @param rdch " recording channel (optional; may be NULL)
3028 * @param policy Integer from [0:10]
3030 * @retval 0 constant (for now)
3033 dsp_oss_policy(struct pcm_channel *wrch, struct pcm_channel *rdch, int policy)
3037 if (policy < CHN_POLICY_MIN || policy > CHN_POLICY_MAX)
3040 /* Default: success */
3045 ret = chn_setlatency(rdch, policy);
3049 if (wrch && ret == 0) {
3051 ret = chn_setlatency(wrch, policy);
3062 * @brief Enable or disable "cooked" mode
3064 * This is a handler for @c SNDCTL_DSP_COOKEDMODE. When in cooked mode, which
3065 * is the default, the sound system handles rate and format conversions
3066 * automatically (ex: user writing 11025Hz/8 bit/unsigned but card only
3067 * operates with 44100Hz/16bit/signed samples).
3069 * Disabling cooked mode is intended for applications wanting to mmap()
3070 * a sound card's buffer space directly, bypassing the FreeBSD 2-stage
3071 * feeder architecture, presumably to gain as much control over audio
3072 * hardware as possible.
3074 * See @c http://manuals.opensound.com/developer/SNDCTL_DSP_COOKEDMODE.html
3077 * @param wrch playback channel (optional; may be NULL)
3078 * @param rdch recording channel (optional; may be NULL)
3079 * @param enabled 0 = raw mode, 1 = cooked mode
3081 * @retval EINVAL Operation not yet supported.
3084 dsp_oss_cookedmode(struct pcm_channel *wrch, struct pcm_channel *rdch, int enabled)
3088 * XXX I just don't get it. Why don't they call it
3089 * "BITPERFECT" ~ SNDCTL_DSP_BITPERFECT !?!?.
3090 * This is just plain so confusing, incoherent,
3091 * <insert any non-printable characters here>.
3093 if (!(enabled == 1 || enabled == 0))
3097 * I won't give in. I'm inverting its logic here and now.
3098 * Brag all you want, but "BITPERFECT" should be the better
3101 enabled ^= 0x00000001;
3105 wrch->flags &= ~CHN_F_BITPERFECT;
3106 wrch->flags |= (enabled != 0) ? CHN_F_BITPERFECT : 0x00000000;
3112 rdch->flags &= ~CHN_F_BITPERFECT;
3113 rdch->flags |= (enabled != 0) ? CHN_F_BITPERFECT : 0x00000000;
3121 * @brief Retrieve channel interleaving order
3123 * This is the handler for @c SNDCTL_DSP_GET_CHNORDER.
3125 * See @c http://manuals.opensound.com/developer/SNDCTL_DSP_GET_CHNORDER.html
3128 * @note As the ioctl definition is still under construction, FreeBSD
3129 * does not currently support SNDCTL_DSP_GET_CHNORDER.
3131 * @param wrch playback channel (optional; may be NULL)
3132 * @param rdch recording channel (optional; may be NULL)
3133 * @param map channel map (result will be stored there)
3135 * @retval EINVAL Operation not yet supported.
3138 dsp_oss_getchnorder(struct pcm_channel *wrch, struct pcm_channel *rdch, unsigned long long *map)
3140 struct pcm_channel *ch;
3143 ch = (wrch != NULL) ? wrch : rdch;
3146 ret = chn_oss_getorder(ch, map);
3155 * @brief Specify channel interleaving order
3157 * This is the handler for @c SNDCTL_DSP_SET_CHNORDER.
3159 * @note As the ioctl definition is still under construction, FreeBSD
3160 * does not currently support @c SNDCTL_DSP_SET_CHNORDER.
3162 * @param wrch playback channel (optional; may be NULL)
3163 * @param rdch recording channel (optional; may be NULL)
3164 * @param map channel map
3166 * @retval EINVAL Operation not yet supported.
3169 dsp_oss_setchnorder(struct pcm_channel *wrch, struct pcm_channel *rdch, unsigned long long *map)
3177 ret = chn_oss_setorder(wrch, map);
3181 if (ret == 0 && rdch != NULL) {
3183 ret = chn_oss_setorder(rdch, map);
3191 dsp_oss_getchannelmask(struct pcm_channel *wrch, struct pcm_channel *rdch,
3194 struct pcm_channel *ch;
3199 ch = (wrch != NULL) ? wrch : rdch;
3203 ret = chn_oss_getmask(ch, &chnmask);
3214 #ifdef OSSV4_EXPERIMENT
3216 * @brief Retrieve an audio device's label
3218 * This is a handler for the @c SNDCTL_GETLABEL ioctl.
3220 * See @c http://manuals.opensound.com/developer/SNDCTL_GETLABEL.html
3223 * From Hannu@4Front: "For example ossxmix (just like some HW mixer
3224 * consoles) can show variable "labels" for certain controls. By default
3225 * the application name (say quake) is shown as the label but
3226 * applications may change the labels themselves."
3228 * @note As the ioctl definition is still under construction, FreeBSD
3229 * does not currently support @c SNDCTL_GETLABEL.
3231 * @param wrch playback channel (optional; may be NULL)
3232 * @param rdch recording channel (optional; may be NULL)
3233 * @param label label gets copied here
3235 * @retval EINVAL Operation not yet supported.
3238 dsp_oss_getlabel(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_label_t *label)
3244 * @brief Specify an audio device's label
3246 * This is a handler for the @c SNDCTL_SETLABEL ioctl. Please see the
3247 * comments for @c dsp_oss_getlabel immediately above.
3249 * See @c http://manuals.opensound.com/developer/SNDCTL_GETLABEL.html
3252 * @note As the ioctl definition is still under construction, FreeBSD
3253 * does not currently support SNDCTL_SETLABEL.
3255 * @param wrch playback channel (optional; may be NULL)
3256 * @param rdch recording channel (optional; may be NULL)
3257 * @param label label gets copied from here
3259 * @retval EINVAL Operation not yet supported.
3262 dsp_oss_setlabel(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_label_t *label)
3268 * @brief Retrieve name of currently played song
3270 * This is a handler for the @c SNDCTL_GETSONG ioctl. Audio players could
3271 * tell the system the name of the currently playing song, which would be
3272 * visible in @c /dev/sndstat.
3274 * See @c http://manuals.opensound.com/developer/SNDCTL_GETSONG.html
3277 * @note As the ioctl definition is still under construction, FreeBSD
3278 * does not currently support SNDCTL_GETSONG.
3280 * @param wrch playback channel (optional; may be NULL)
3281 * @param rdch recording channel (optional; may be NULL)
3282 * @param song song name gets copied here
3284 * @retval EINVAL Operation not yet supported.
3287 dsp_oss_getsong(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_longname_t *song)
3293 * @brief Retrieve name of currently played song
3295 * This is a handler for the @c SNDCTL_SETSONG ioctl. Audio players could
3296 * tell the system the name of the currently playing song, which would be
3297 * visible in @c /dev/sndstat.
3299 * See @c http://manuals.opensound.com/developer/SNDCTL_SETSONG.html
3302 * @note As the ioctl definition is still under construction, FreeBSD
3303 * does not currently support SNDCTL_SETSONG.
3305 * @param wrch playback channel (optional; may be NULL)
3306 * @param rdch recording channel (optional; may be NULL)
3307 * @param song song name gets copied from here
3309 * @retval EINVAL Operation not yet supported.
3312 dsp_oss_setsong(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_longname_t *song)
3318 * @brief Rename a device
3320 * This is a handler for the @c SNDCTL_SETNAME ioctl.
3322 * See @c http://manuals.opensound.com/developer/SNDCTL_SETNAME.html for
3325 * From Hannu@4Front: "This call is used to change the device name
3326 * reported in /dev/sndstat and ossinfo. So instead of using some generic
3327 * 'OSS loopback audio (MIDI) driver' the device may be given a meaningfull
3328 * name depending on the current context (for example 'OSS virtual wave table
3329 * synth' or 'VoIP link to London')."
3331 * @note As the ioctl definition is still under construction, FreeBSD
3332 * does not currently support SNDCTL_SETNAME.
3334 * @param wrch playback channel (optional; may be NULL)
3335 * @param rdch recording channel (optional; may be NULL)
3336 * @param name new device name gets copied from here
3338 * @retval EINVAL Operation not yet supported.
3341 dsp_oss_setname(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_longname_t *name)
3345 #endif /* !OSSV4_EXPERIMENT */