2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2005-2009 Ariff Abdullah <ariff@FreeBSD.org>
5 * Portions Copyright (c) Ryan Beasley <ryan.beasley@gmail.com> - GSoC 2006
6 * Copyright (c) 1999 Cameron Grant <cg@FreeBSD.org>
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #ifdef HAVE_KERNEL_OPTION_HEADERS
35 #include <dev/sound/pcm/sound.h>
36 #include <sys/ctype.h>
38 #include <sys/rwlock.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$");
48 static int dsp_mmap_allow_prot_exec = 0;
49 SYSCTL_INT(_hw_snd, OID_AUTO, compat_linux_mmap, CTLFLAG_RWTUN,
50 &dsp_mmap_allow_prot_exec, 0,
51 "linux mmap compatibility (-1=force disable 0=auto 1=force enable)");
53 static int dsp_basename_clone = 1;
54 SYSCTL_INT(_hw_snd, OID_AUTO, basename_clone, CTLFLAG_RWTUN,
55 &dsp_basename_clone, 0,
56 "DSP basename cloning (0: Disable; 1: Enabled)");
59 struct pcm_channel *rdch, *wrch;
60 struct pcm_channel *volch;
62 TAILQ_ENTRY(dsp_cdevinfo) link;
65 #define PCM_RDCH(x) (((struct dsp_cdevinfo *)(x)->si_drv1)->rdch)
66 #define PCM_WRCH(x) (((struct dsp_cdevinfo *)(x)->si_drv1)->wrch)
67 #define PCM_VOLCH(x) (((struct dsp_cdevinfo *)(x)->si_drv1)->volch)
68 #define PCM_SIMPLEX(x) (((struct dsp_cdevinfo *)(x)->si_drv1)->simplex)
70 #define DSP_CDEVINFO_CACHESIZE 8
72 #define DSP_REGISTERED(x, y) (PCM_REGISTERED(x) && \
73 (y) != NULL && (y)->si_drv1 != NULL)
77 static d_open_t dsp_open;
78 static d_close_t dsp_close;
79 static d_read_t dsp_read;
80 static d_write_t dsp_write;
81 static d_ioctl_t dsp_ioctl;
82 static d_poll_t dsp_poll;
83 static d_mmap_t dsp_mmap;
84 static d_mmap_single_t dsp_mmap_single;
86 struct cdevsw dsp_cdevsw = {
87 .d_version = D_VERSION,
95 .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 = malloc(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_SAFE(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);
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 = malloc(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);
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 cdev *i_dev, int flags, int mode, struct thread *td)
453 struct pcm_channel *rdch, *wrch;
454 struct snddev_info *d;
455 uint32_t fmt, spd, prio, volctl;
456 int i, error, rderror, wrerror, devtype, wdevunit, rdevunit;
458 /* Kind of impossible.. */
459 if (i_dev == NULL || td == NULL)
462 d = dsp_get_info(i_dev);
463 if (!PCM_REGISTERED(d))
468 /* Lock snddev so nobody else can monkey with it. */
473 * Try to acquire cloned device before someone else pick it.
474 * ENODEV means this is not a cloned droids.
476 error = snd_clone_acquire(i_dev);
477 if (!(error == 0 || error == ENODEV)) {
488 (void)snd_clone_release(i_dev);
495 * That is just enough. Acquire and unlock pcm lock so
496 * the other will just have to wait until we finish doing
502 devtype = PCMDEV(i_dev);
507 volctl = DSP_CDEV_VOLCTL_NONE;
509 for (i = 0; i < (sizeof(dsp_cdevs) / sizeof(dsp_cdevs[0])); i++) {
510 if (devtype != dsp_cdevs[i].type || dsp_cdevs[i].alias != NULL)
513 * Volume control only valid for DSPHW devices,
514 * and it must be opened in opposite direction be it
515 * simplex or duplex. Anything else will be handled
518 if (dsp_cdevs[i].query == DSP_CDEV_TYPE_WRONLY) {
519 if (dsp_cdevs[i].volctl != 0 &&
521 volctl = DSP_CDEV_VOLCTL_WRITE;
525 if (DSP_F_READ(flags)) {
526 (void)snd_clone_release(i_dev);
527 PCM_RELEASE_QUICK(d);
531 wdevunit = dev2unit(i_dev);
532 } else if (dsp_cdevs[i].query == DSP_CDEV_TYPE_RDONLY) {
533 if (dsp_cdevs[i].volctl != 0 &&
534 DSP_F_WRITE(flags)) {
535 volctl = DSP_CDEV_VOLCTL_READ;
539 if (DSP_F_WRITE(flags)) {
540 (void)snd_clone_release(i_dev);
541 PCM_RELEASE_QUICK(d);
545 rdevunit = dev2unit(i_dev);
547 fmt = dsp_cdevs[i].fmt;
548 spd = dsp_cdevs[i].spd;
552 /* No matching devtype? */
553 if (fmt == 0 || spd == 0)
554 panic("impossible devtype %d", devtype);
562 * if we get here, the open request is valid- either:
563 * * we were previously not open
564 * * we were open for play xor record and the opener wants
565 * the non-open direction
567 if (DSP_F_READ(flags)) {
569 rderror = pcm_chnalloc(d, &rdch, PCMDIR_REC,
570 td->td_proc->p_pid, td->td_proc->p_comm, rdevunit);
572 if (rderror == 0 && chn_reset(rdch, fmt, spd) != 0)
575 if (volctl == DSP_CDEV_VOLCTL_READ)
580 pcm_chnrelease(rdch);
581 if (!DSP_F_DUPLEX(flags)) {
582 (void)snd_clone_release(i_dev);
583 PCM_RELEASE_QUICK(d);
588 } else if (volctl == DSP_CDEV_VOLCTL_READ) {
591 pcm_chnrelease(rdch);
594 if (flags & O_NONBLOCK)
595 rdch->flags |= CHN_F_NBIO;
597 rdch->flags |= CHN_F_EXCLUSIVE;
599 if (volctl == DSP_CDEV_VOLCTL_NONE)
600 chn_vpc_reset(rdch, SND_VOL_C_PCM, 0);
605 if (DSP_F_WRITE(flags)) {
607 wrerror = pcm_chnalloc(d, &wrch, PCMDIR_PLAY,
608 td->td_proc->p_pid, td->td_proc->p_comm, wdevunit);
610 if (wrerror == 0 && chn_reset(wrch, fmt, spd) != 0)
613 if (volctl == DSP_CDEV_VOLCTL_WRITE)
618 pcm_chnrelease(wrch);
619 if (!DSP_F_DUPLEX(flags)) {
622 * Lock, deref and release previously
623 * created record channel
626 pcm_chnref(rdch, -1);
627 pcm_chnrelease(rdch);
629 (void)snd_clone_release(i_dev);
630 PCM_RELEASE_QUICK(d);
635 } else if (volctl == DSP_CDEV_VOLCTL_WRITE) {
638 pcm_chnrelease(wrch);
641 if (flags & O_NONBLOCK)
642 wrch->flags |= CHN_F_NBIO;
644 wrch->flags |= CHN_F_EXCLUSIVE;
646 if (volctl == DSP_CDEV_VOLCTL_NONE)
647 chn_vpc_reset(wrch, SND_VOL_C_PCM, 0);
656 * We're done. Allocate channels information for this cdev.
659 case DSP_CDEV_VOLCTL_READ:
660 KASSERT(wrch == NULL, ("wrch=%p not null!", wrch));
661 dsp_cdevinfo_alloc(i_dev, NULL, NULL, rdch);
663 case DSP_CDEV_VOLCTL_WRITE:
664 KASSERT(rdch == NULL, ("rdch=%p not null!", rdch));
665 dsp_cdevinfo_alloc(i_dev, NULL, NULL, wrch);
667 case DSP_CDEV_VOLCTL_NONE:
669 if (wrch == NULL && rdch == NULL) {
670 (void)snd_clone_release(i_dev);
680 dsp_cdevinfo_alloc(i_dev, rdch, wrch, NULL);
682 CHN_INSERT_HEAD(d, rdch, channels.pcm.opened);
684 CHN_INSERT_HEAD(d, wrch, channels.pcm.opened);
689 * Increase clone refcount for its automatic garbage collector.
691 (void)snd_clone_ref(i_dev);
702 dsp_close(struct cdev *i_dev, int flags, int mode, struct thread *td)
704 struct pcm_channel *rdch, *wrch, *volch;
705 struct snddev_info *d;
706 int sg_ids, rdref, wdref;
708 d = dsp_get_info(i_dev);
709 if (!DSP_REGISTERED(d, i_dev))
718 rdch = PCM_RDCH(i_dev);
719 wrch = PCM_WRCH(i_dev);
720 volch = PCM_VOLCH(i_dev);
722 PCM_RDCH(i_dev) = NULL;
723 PCM_WRCH(i_dev) = NULL;
724 PCM_VOLCH(i_dev) = NULL;
732 else if (volch == wrch)
736 pcm_chnref(volch, -1);
742 CHN_REMOVE(d, rdch, channels.pcm.opened);
744 CHN_REMOVE(d, wrch, channels.pcm.opened);
746 if (rdch != NULL || wrch != NULL) {
750 * The channel itself need not be locked because:
751 * a) Adding a channel to a syncgroup happens only
752 * in dsp_ioctl(), which cannot run concurrently
754 * b) The syncmember pointer (sm) is protected by
755 * the global syncgroup list lock.
756 * c) A channel can't just disappear, invalidating
757 * pointers, unless it's closed/dereferenced
761 sg_ids = chn_syncdestroy(rdch);
764 free_unr(pcmsg_unrhdr, sg_ids);
767 pcm_chnref(rdch, rdref);
768 chn_abort(rdch); /* won't sleep */
769 rdch->flags &= ~(CHN_F_RUNNING | CHN_F_MMAP |
770 CHN_F_DEAD | CHN_F_EXCLUSIVE);
771 chn_reset(rdch, 0, 0);
772 pcm_chnrelease(rdch);
776 * Please see block above.
779 sg_ids = chn_syncdestroy(wrch);
782 free_unr(pcmsg_unrhdr, sg_ids);
785 pcm_chnref(wrch, wdref);
786 chn_flush(wrch); /* may sleep */
787 wrch->flags &= ~(CHN_F_RUNNING | CHN_F_MMAP |
788 CHN_F_DEAD | CHN_F_EXCLUSIVE);
789 chn_reset(wrch, 0, 0);
790 pcm_chnrelease(wrch);
795 dsp_cdevinfo_free(i_dev);
797 * Release clone busy state and unref it so the automatic
798 * garbage collector will get the hint and do the remaining
801 (void)snd_clone_release(i_dev);
804 * destroy_dev() might sleep, so release pcm lock
805 * here and rely on pcm cv serialization.
808 (void)snd_clone_unref(i_dev);
820 dsp_io_ops(struct cdev *i_dev, struct uio *buf)
822 struct snddev_info *d;
823 struct pcm_channel **ch, *rdch, *wrch;
824 int (*chn_io)(struct pcm_channel *, struct uio *);
828 KASSERT(i_dev != NULL && buf != NULL &&
829 (buf->uio_rw == UIO_READ || buf->uio_rw == UIO_WRITE),
830 ("%s(): io train wreck!", __func__));
832 d = dsp_get_info(i_dev);
833 if (!DSP_REGISTERED(d, i_dev))
838 switch (buf->uio_rw) {
850 panic("invalid/corrupted uio direction: %d", buf->uio_rw);
856 runpid = buf->uio_td->td_proc->p_pid;
858 getchns(i_dev, &rdch, &wrch, prio);
860 if (*ch == NULL || !((*ch)->flags & CHN_F_BUSY)) {
865 if (((*ch)->flags & (CHN_F_MMAP | CHN_F_DEAD)) ||
866 (((*ch)->flags & CHN_F_RUNNING) && (*ch)->pid != runpid)) {
867 relchns(i_dev, rdch, wrch, prio);
870 } else if (!((*ch)->flags & CHN_F_RUNNING)) {
871 (*ch)->flags |= CHN_F_RUNNING;
876 * chn_read/write must give up channel lock in order to copy bytes
877 * from/to userland, so up the "in progress" counter to make sure
878 * someone else doesn't come along and muss up the buffer.
881 ret = chn_io(*ch, buf);
884 CHN_BROADCAST(&(*ch)->cv);
886 relchns(i_dev, rdch, wrch, prio);
894 dsp_read(struct cdev *i_dev, struct uio *buf, int flag)
896 return (dsp_io_ops(i_dev, buf));
900 dsp_write(struct cdev *i_dev, struct uio *buf, int flag)
902 return (dsp_io_ops(i_dev, buf));
906 dsp_get_volume_channel(struct cdev *dev, struct pcm_channel **volch)
908 struct snddev_info *d;
909 struct pcm_channel *c;
912 KASSERT(dev != NULL && volch != NULL,
913 ("%s(): NULL query dev=%p volch=%p", __func__, dev, volch));
915 d = dsp_get_info(dev);
916 if (!PCM_REGISTERED(d)) {
927 if (!(c->feederflags & (1 << FEEDER_VOLUME)))
937 unit = dev2unit(dev);
939 CHN_FOREACH(c, d, channels.pcm) {
941 if (c->unit != unit) {
951 return ((c->feederflags & (1 << FEEDER_VOLUME)) ? 0 : -1);
961 dsp_ioctl_channel(struct cdev *dev, struct pcm_channel *volch, u_long cmd,
964 struct snddev_info *d;
965 struct pcm_channel *rdch, *wrch;
968 d = dsp_get_info(dev);
969 if (!PCM_REGISTERED(d) || !(dsp_get_flags(dev) & SD_F_VPC))
976 rdch = PCM_RDCH(dev);
977 wrch = PCM_WRCH(dev);
979 /* No specific channel, look into cache */
981 volch = PCM_VOLCH(dev);
985 if (j == SOUND_MIXER_RECLEV && rdch != NULL)
987 else if (j == SOUND_MIXER_PCM && wrch != NULL)
991 devtype = PCMDEV(dev);
993 /* Look super harder */
995 (devtype == SND_DEV_DSPHW_PLAY || devtype == SND_DEV_DSPHW_VPLAY ||
996 devtype == SND_DEV_DSPHW_REC || devtype == SND_DEV_DSPHW_VREC)) {
997 ret = dsp_get_volume_channel(dev, &volch);
1004 /* Final validation */
1005 if (volch != NULL) {
1007 if (!(volch->feederflags & (1 << FEEDER_VOLUME))) {
1011 if (volch->direction == PCMDIR_PLAY)
1019 if (volch != NULL &&
1020 ((j == SOUND_MIXER_PCM && volch->direction == PCMDIR_PLAY) ||
1021 (j == SOUND_MIXER_RECLEV && volch->direction == PCMDIR_REC))) {
1022 if ((cmd & ~0xff) == MIXER_WRITE(0)) {
1023 int left, right, center;
1025 left = *(int *)arg & 0x7f;
1026 right = ((*(int *)arg) >> 8) & 0x7f;
1027 center = (left + right) >> 1;
1028 chn_setvolume_multi(volch, SND_VOL_C_PCM, left, right,
1030 } else if ((cmd & ~0xff) == MIXER_READ(0)) {
1031 *(int *)arg = CHN_GETVOLUME(volch,
1032 SND_VOL_C_PCM, SND_CHN_T_FL);
1033 *(int *)arg |= CHN_GETVOLUME(volch,
1034 SND_VOL_C_PCM, SND_CHN_T_FR) << 8;
1037 } else if (rdch != NULL || wrch != NULL) {
1039 case SOUND_MIXER_DEVMASK:
1040 case SOUND_MIXER_CAPS:
1041 case SOUND_MIXER_STEREODEVS:
1042 if ((cmd & ~0xff) == MIXER_READ(0)) {
1045 *(int *)arg |= SOUND_MASK_RECLEV;
1047 *(int *)arg |= SOUND_MASK_PCM;
1051 case SOUND_MIXER_RECMASK:
1052 case SOUND_MIXER_RECSRC:
1053 if ((cmd & ~0xff) == MIXER_READ(0))
1069 dsp_ioctl(struct cdev *i_dev, u_long cmd, caddr_t arg, int mode,
1072 struct pcm_channel *chn, *rdch, *wrch;
1073 struct snddev_info *d;
1075 int *arg_i, ret, tmp;
1077 d = dsp_get_info(i_dev);
1078 if (!DSP_REGISTERED(d, i_dev))
1088 if (IOCGROUP(cmd) == 'M') {
1089 if (cmd == OSS_GETVERSION) {
1090 *arg_i = SOUND_VERSION;
1094 ret = dsp_ioctl_channel(i_dev, PCM_VOLCH(i_dev), cmd, arg);
1100 if (d->mixer_dev != NULL) {
1101 PCM_ACQUIRE_QUICK(d);
1102 ret = mixer_ioctl_cmd(d->mixer_dev, cmd, arg, -1, td,
1104 PCM_RELEASE_QUICK(d);
1114 * Certain ioctls may be made on any type of device (audio, mixer,
1115 * and MIDI). Handle those special cases here.
1117 if (IOCGROUP(cmd) == 'X') {
1118 PCM_ACQUIRE_QUICK(d);
1120 case SNDCTL_SYSINFO:
1121 sound_oss_sysinfo((oss_sysinfo *)arg);
1123 case SNDCTL_CARDINFO:
1124 ret = sound_oss_card_info((oss_card_info *)arg);
1126 case SNDCTL_AUDIOINFO:
1127 case SNDCTL_AUDIOINFO_EX:
1128 case SNDCTL_ENGINEINFO:
1129 ret = dsp_oss_audioinfo(i_dev, (oss_audioinfo *)arg);
1131 case SNDCTL_MIXERINFO:
1132 ret = mixer_oss_mixerinfo(i_dev, (oss_mixerinfo *)arg);
1137 PCM_RELEASE_QUICK(d);
1142 getchns(i_dev, &rdch, &wrch, 0);
1144 if (wrch != NULL && (wrch->flags & CHN_F_DEAD))
1146 if (rdch != NULL && (rdch->flags & CHN_F_DEAD))
1149 if (wrch == NULL && rdch == NULL) {
1157 * we start with the new ioctl interface.
1159 case AIONWRITE: /* how many bytes can write ? */
1163 if (wrch && wrch->bufhard.dl)
1164 while (chn_wrfeed(wrch) == 0);
1166 *arg_i = sndbuf_getfree(wrch->bufsoft);
1174 case AIOSSIZE: /* set the current blocksize */
1176 struct snd_size *p = (struct snd_size *)arg;
1180 PCM_ACQUIRE_QUICK(d);
1183 chn_setblocksize(wrch, 2, p->play_size);
1184 p->play_size = sndbuf_getblksz(wrch->bufsoft);
1189 chn_setblocksize(rdch, 2, p->rec_size);
1190 p->rec_size = sndbuf_getblksz(rdch->bufsoft);
1193 PCM_RELEASE_QUICK(d);
1196 case AIOGSIZE: /* get the current blocksize */
1198 struct snd_size *p = (struct snd_size *)arg;
1202 p->play_size = sndbuf_getblksz(wrch->bufsoft);
1207 p->rec_size = sndbuf_getblksz(rdch->bufsoft);
1216 snd_chan_param *p = (snd_chan_param *)arg;
1218 if (cmd == AIOSFMT &&
1219 ((p->play_format != 0 && p->play_rate == 0) ||
1220 (p->rec_format != 0 && p->rec_rate == 0))) {
1224 PCM_ACQUIRE_QUICK(d);
1227 if (cmd == AIOSFMT && p->play_format != 0) {
1229 SND_FORMAT(p->play_format,
1230 AFMT_CHANNEL(wrch->format),
1231 AFMT_EXTCHANNEL(wrch->format)));
1232 chn_setspeed(wrch, p->play_rate);
1234 p->play_rate = wrch->speed;
1235 p->play_format = AFMT_ENCODING(wrch->format);
1243 if (cmd == AIOSFMT && p->rec_format != 0) {
1245 SND_FORMAT(p->rec_format,
1246 AFMT_CHANNEL(rdch->format),
1247 AFMT_EXTCHANNEL(rdch->format)));
1248 chn_setspeed(rdch, p->rec_rate);
1250 p->rec_rate = rdch->speed;
1251 p->rec_format = AFMT_ENCODING(rdch->format);
1257 PCM_RELEASE_QUICK(d);
1261 case AIOGCAP: /* get capabilities */
1263 snd_capabilities *p = (snd_capabilities *)arg;
1264 struct pcmchan_caps *pcaps = NULL, *rcaps = NULL;
1270 rcaps = chn_getcaps(rdch);
1274 pcaps = chn_getcaps(wrch);
1276 p->rate_min = max(rcaps? rcaps->minspeed : 0,
1277 pcaps? pcaps->minspeed : 0);
1278 p->rate_max = min(rcaps? rcaps->maxspeed : 1000000,
1279 pcaps? pcaps->maxspeed : 1000000);
1280 p->bufsize = min(rdch? sndbuf_getsize(rdch->bufsoft) : 1000000,
1281 wrch? sndbuf_getsize(wrch->bufsoft) : 1000000);
1282 /* XXX bad on sb16 */
1283 p->formats = (rdch? chn_getformats(rdch) : 0xffffffff) &
1284 (wrch? chn_getformats(wrch) : 0xffffffff);
1286 p->formats |= (dsp_get_flags(i_dev) & SD_F_SIMPLEX)? 0 : AFMT_FULLDUPLEX;
1287 pdev = d->mixer_dev;
1288 p->mixers = 1; /* default: one mixer */
1289 p->inputs = pdev->si_drv1? mix_getdevs(pdev->si_drv1) : 0;
1290 p->left = p->right = 100;
1300 if (*arg_i == AIOSYNC_PLAY && wrch) {
1302 *arg_i = chn_abort(wrch);
1304 } else if (*arg_i == AIOSYNC_CAPTURE && rdch) {
1306 *arg_i = chn_abort(rdch);
1309 printf("AIOSTOP: bad channel 0x%x\n", *arg_i);
1315 printf("AIOSYNC chan 0x%03lx pos %lu unimplemented\n",
1316 ((snd_sync_parm *)arg)->chan, ((snd_sync_parm *)arg)->pos);
1320 * here follow the standard ioctls (filio.h etc.)
1322 case FIONREAD: /* get # bytes to read */
1325 /* if (rdch && rdch->bufhard.dl)
1326 while (chn_rdfeed(rdch) == 0);
1328 *arg_i = sndbuf_getready(rdch->bufsoft);
1336 case FIOASYNC: /*set/clear async i/o */
1337 DEB( printf("FIOASYNC\n") ; )
1340 case SNDCTL_DSP_NONBLOCK: /* set non-blocking i/o */
1341 case FIONBIO: /* set/clear non-blocking i/o */
1344 if (cmd == SNDCTL_DSP_NONBLOCK || *arg_i)
1345 rdch->flags |= CHN_F_NBIO;
1347 rdch->flags &= ~CHN_F_NBIO;
1352 if (cmd == SNDCTL_DSP_NONBLOCK || *arg_i)
1353 wrch->flags |= CHN_F_NBIO;
1355 wrch->flags &= ~CHN_F_NBIO;
1361 * Finally, here is the linux-compatible ioctl interface
1363 #define THE_REAL_SNDCTL_DSP_GETBLKSIZE _IOWR('P', 4, int)
1364 case THE_REAL_SNDCTL_DSP_GETBLKSIZE:
1365 case SNDCTL_DSP_GETBLKSIZE:
1366 chn = wrch ? wrch : rdch;
1369 *arg_i = sndbuf_getblksz(chn->bufsoft);
1377 case SNDCTL_DSP_SETBLKSIZE:
1378 RANGE(*arg_i, 16, 65536);
1379 PCM_ACQUIRE_QUICK(d);
1382 chn_setblocksize(wrch, 2, *arg_i);
1387 chn_setblocksize(rdch, 2, *arg_i);
1390 PCM_RELEASE_QUICK(d);
1393 case SNDCTL_DSP_RESET:
1394 DEB(printf("dsp reset\n"));
1409 case SNDCTL_DSP_SYNC:
1410 DEB(printf("dsp sync\n"));
1411 /* chn_sync may sleep */
1419 case SNDCTL_DSP_SPEED:
1420 /* chn_setspeed may sleep */
1422 PCM_ACQUIRE_QUICK(d);
1425 ret = chn_setspeed(wrch, *arg_i);
1429 if (rdch && ret == 0) {
1431 ret = chn_setspeed(rdch, *arg_i);
1436 PCM_RELEASE_QUICK(d);
1440 case SOUND_PCM_READ_RATE:
1441 chn = wrch ? wrch : rdch;
1444 *arg_i = chn->speed;
1452 case SNDCTL_DSP_STEREO:
1454 *arg_i = (*arg_i)? 2 : 1;
1455 PCM_ACQUIRE_QUICK(d);
1458 ret = chn_setformat(wrch,
1459 SND_FORMAT(wrch->format, *arg_i, 0));
1460 tmp = (AFMT_CHANNEL(wrch->format) > 1)? 1 : 0;
1463 if (rdch && ret == 0) {
1465 ret = chn_setformat(rdch,
1466 SND_FORMAT(rdch->format, *arg_i, 0));
1468 tmp = (AFMT_CHANNEL(rdch->format) > 1)? 1 : 0;
1471 PCM_RELEASE_QUICK(d);
1475 case SOUND_PCM_WRITE_CHANNELS:
1476 /* case SNDCTL_DSP_CHANNELS: ( == SOUND_PCM_WRITE_CHANNELS) */
1483 struct pcmchan_matrix *m;
1487 if (*arg_i > SND_CHN_MAX)
1488 *arg_i = SND_CHN_MAX;
1490 m = feeder_matrix_default_channel_map(*arg_i);
1496 PCM_ACQUIRE_QUICK(d);
1499 ret = chn_setformat(wrch,
1500 SND_FORMAT(wrch->format, *arg_i, ext));
1501 tmp = AFMT_CHANNEL(wrch->format);
1504 if (rdch && ret == 0) {
1506 ret = chn_setformat(rdch,
1507 SND_FORMAT(rdch->format, *arg_i, ext));
1509 tmp = AFMT_CHANNEL(rdch->format);
1512 PCM_RELEASE_QUICK(d);
1515 chn = wrch ? wrch : rdch;
1517 *arg_i = AFMT_CHANNEL(chn->format);
1522 case SOUND_PCM_READ_CHANNELS:
1523 chn = wrch ? wrch : rdch;
1526 *arg_i = AFMT_CHANNEL(chn->format);
1534 case SNDCTL_DSP_GETFMTS: /* returns a mask of supported fmts */
1535 chn = wrch ? wrch : rdch;
1538 *arg_i = chn_getformats(chn);
1546 case SNDCTL_DSP_SETFMT: /* sets _one_ format */
1547 if (*arg_i != AFMT_QUERY) {
1549 PCM_ACQUIRE_QUICK(d);
1552 ret = chn_setformat(wrch, SND_FORMAT(*arg_i,
1553 AFMT_CHANNEL(wrch->format),
1554 AFMT_EXTCHANNEL(wrch->format)));
1558 if (rdch && ret == 0) {
1560 ret = chn_setformat(rdch, SND_FORMAT(*arg_i,
1561 AFMT_CHANNEL(rdch->format),
1562 AFMT_EXTCHANNEL(rdch->format)));
1567 PCM_RELEASE_QUICK(d);
1568 *arg_i = AFMT_ENCODING(tmp);
1570 chn = wrch ? wrch : rdch;
1572 *arg_i = AFMT_ENCODING(chn->format);
1577 case SNDCTL_DSP_SETFRAGMENT:
1578 DEB(printf("SNDCTL_DSP_SETFRAGMENT 0x%08x\n", *(int *)arg));
1580 uint32_t fragln = (*arg_i) & 0x0000ffff;
1581 uint32_t maxfrags = ((*arg_i) & 0xffff0000) >> 16;
1583 uint32_t r_maxfrags, r_fragsz;
1585 RANGE(fragln, 4, 16);
1586 fragsz = 1 << fragln;
1589 maxfrags = CHN_2NDBUFMAXSIZE / fragsz;
1592 if (maxfrags * fragsz > CHN_2NDBUFMAXSIZE)
1593 maxfrags = CHN_2NDBUFMAXSIZE / fragsz;
1595 DEB(printf("SNDCTL_DSP_SETFRAGMENT %d frags, %d sz\n", maxfrags, fragsz));
1596 PCM_ACQUIRE_QUICK(d);
1599 ret = chn_setblocksize(rdch, maxfrags, fragsz);
1600 r_maxfrags = sndbuf_getblkcnt(rdch->bufsoft);
1601 r_fragsz = sndbuf_getblksz(rdch->bufsoft);
1604 r_maxfrags = maxfrags;
1607 if (wrch && ret == 0) {
1609 ret = chn_setblocksize(wrch, maxfrags, fragsz);
1610 maxfrags = sndbuf_getblkcnt(wrch->bufsoft);
1611 fragsz = sndbuf_getblksz(wrch->bufsoft);
1613 } else { /* use whatever came from the read channel */
1614 maxfrags = r_maxfrags;
1617 PCM_RELEASE_QUICK(d);
1620 while (fragsz > 1) {
1624 *arg_i = (maxfrags << 16) | fragln;
1628 case SNDCTL_DSP_GETISPACE:
1629 /* return the size of data available in the input queue */
1631 audio_buf_info *a = (audio_buf_info *)arg;
1633 struct snd_dbuf *bs = rdch->bufsoft;
1636 a->bytes = sndbuf_getready(bs);
1637 a->fragments = a->bytes / sndbuf_getblksz(bs);
1638 a->fragstotal = sndbuf_getblkcnt(bs);
1639 a->fragsize = sndbuf_getblksz(bs);
1646 case SNDCTL_DSP_GETOSPACE:
1647 /* return space available in the output queue */
1649 audio_buf_info *a = (audio_buf_info *)arg;
1651 struct snd_dbuf *bs = wrch->bufsoft;
1654 /* XXX abusive DMA update: chn_wrupdate(wrch); */
1655 a->bytes = sndbuf_getfree(bs);
1656 a->fragments = a->bytes / sndbuf_getblksz(bs);
1657 a->fragstotal = sndbuf_getblkcnt(bs);
1658 a->fragsize = sndbuf_getblksz(bs);
1665 case SNDCTL_DSP_GETIPTR:
1667 count_info *a = (count_info *)arg;
1669 struct snd_dbuf *bs = rdch->bufsoft;
1672 /* XXX abusive DMA update: chn_rdupdate(rdch); */
1673 a->bytes = sndbuf_gettotal(bs);
1674 a->blocks = sndbuf_getblocks(bs) - rdch->blocks;
1675 a->ptr = sndbuf_getfreeptr(bs);
1676 rdch->blocks = sndbuf_getblocks(bs);
1683 case SNDCTL_DSP_GETOPTR:
1685 count_info *a = (count_info *)arg;
1687 struct snd_dbuf *bs = wrch->bufsoft;
1690 /* XXX abusive DMA update: chn_wrupdate(wrch); */
1691 a->bytes = sndbuf_gettotal(bs);
1692 a->blocks = sndbuf_getblocks(bs) - wrch->blocks;
1693 a->ptr = sndbuf_getreadyptr(bs);
1694 wrch->blocks = sndbuf_getblocks(bs);
1701 case SNDCTL_DSP_GETCAPS:
1703 *arg_i = PCM_CAP_REALTIME | PCM_CAP_MMAP | PCM_CAP_TRIGGER;
1704 if (rdch && wrch && !(dsp_get_flags(i_dev) & SD_F_SIMPLEX))
1705 *arg_i |= PCM_CAP_DUPLEX;
1709 case SOUND_PCM_READ_BITS:
1710 chn = wrch ? wrch : rdch;
1713 if (chn->format & AFMT_8BIT)
1715 else if (chn->format & AFMT_16BIT)
1717 else if (chn->format & AFMT_24BIT)
1719 else if (chn->format & AFMT_32BIT)
1730 case SNDCTL_DSP_SETTRIGGER:
1733 rdch->flags &= ~CHN_F_NOTRIGGER;
1734 if (*arg_i & PCM_ENABLE_INPUT)
1739 rdch->flags |= CHN_F_NOTRIGGER;
1745 wrch->flags &= ~CHN_F_NOTRIGGER;
1746 if (*arg_i & PCM_ENABLE_OUTPUT)
1751 wrch->flags |= CHN_F_NOTRIGGER;
1757 case SNDCTL_DSP_GETTRIGGER:
1761 if (wrch->flags & CHN_F_TRIGGERED)
1762 *arg_i |= PCM_ENABLE_OUTPUT;
1767 if (rdch->flags & CHN_F_TRIGGERED)
1768 *arg_i |= PCM_ENABLE_INPUT;
1773 case SNDCTL_DSP_GETODELAY:
1775 struct snd_dbuf *bs = wrch->bufsoft;
1778 /* XXX abusive DMA update: chn_wrupdate(wrch); */
1779 *arg_i = sndbuf_getready(bs);
1785 case SNDCTL_DSP_POST:
1788 wrch->flags &= ~CHN_F_NOTRIGGER;
1794 case SNDCTL_DSP_SETDUPLEX:
1796 * switch to full-duplex mode if card is in half-duplex
1797 * mode and is able to work in full-duplex mode
1800 if (rdch && wrch && (dsp_get_flags(i_dev) & SD_F_SIMPLEX))
1801 dsp_set_flags(i_dev, dsp_get_flags(i_dev)^SD_F_SIMPLEX);
1806 * The following four ioctls are simple wrappers around mixer_ioctl
1807 * with no further processing. xcmd is short for "translated
1810 case SNDCTL_DSP_GETRECVOL:
1812 xcmd = SOUND_MIXER_READ_RECLEV;
1816 case SNDCTL_DSP_SETRECVOL:
1818 xcmd = SOUND_MIXER_WRITE_RECLEV;
1822 case SNDCTL_DSP_GETPLAYVOL:
1824 xcmd = SOUND_MIXER_READ_PCM;
1828 case SNDCTL_DSP_SETPLAYVOL:
1830 xcmd = SOUND_MIXER_WRITE_PCM;
1834 ret = dsp_ioctl_channel(i_dev, chn, xcmd, arg);
1840 if (d->mixer_dev != NULL) {
1841 PCM_ACQUIRE_QUICK(d);
1842 ret = mixer_ioctl_cmd(d->mixer_dev, xcmd, arg, -1, td,
1844 PCM_RELEASE_QUICK(d);
1850 case SNDCTL_DSP_GET_RECSRC_NAMES:
1851 case SNDCTL_DSP_GET_RECSRC:
1852 case SNDCTL_DSP_SET_RECSRC:
1853 if (d->mixer_dev != NULL) {
1854 PCM_ACQUIRE_QUICK(d);
1855 ret = mixer_ioctl_cmd(d->mixer_dev, cmd, arg, -1, td,
1857 PCM_RELEASE_QUICK(d);
1863 * The following 3 ioctls aren't very useful at the moment. For
1864 * now, only a single channel is associated with a cdev (/dev/dspN
1865 * instance), so there's only a single output routing to use (i.e.,
1866 * the wrch bound to this cdev).
1868 case SNDCTL_DSP_GET_PLAYTGT_NAMES:
1870 oss_mixer_enuminfo *ei;
1871 ei = (oss_mixer_enuminfo *)arg;
1874 ei->version = 0; /* static for now */
1875 ei->strindex[0] = 0;
1879 strlcpy(ei->strings, wrch->name,
1880 sizeof(ei->strings));
1883 ei->strings[0] = '\0';
1887 case SNDCTL_DSP_GET_PLAYTGT:
1888 case SNDCTL_DSP_SET_PLAYTGT: /* yes, they are the same for now */
1891 * OSSv4: "The value that was accepted by the device will
1892 * be returned back in the variable pointed by the
1901 case SNDCTL_DSP_SILENCE:
1903 * Flush the software (pre-feed) buffer, but try to minimize playback
1904 * interruption. (I.e., record unplayed samples with intent to
1905 * restore by SNDCTL_DSP_SKIP.) Intended for application "pause"
1911 struct snd_dbuf *bs;
1913 while (wrch->inprog != 0)
1914 cv_wait(&wrch->cv, wrch->lock);
1916 if ((bs->shadbuf != NULL) && (sndbuf_getready(bs) > 0)) {
1917 bs->sl = sndbuf_getready(bs);
1918 sndbuf_dispose(bs, bs->shadbuf, sndbuf_getready(bs));
1919 sndbuf_fillsilence(bs);
1926 case SNDCTL_DSP_SKIP:
1928 * OSSv4 docs: "This ioctl call discards all unplayed samples in the
1929 * playback buffer by moving the current write position immediately
1930 * before the point where the device is currently reading the samples."
1935 struct snd_dbuf *bs;
1937 while (wrch->inprog != 0)
1938 cv_wait(&wrch->cv, wrch->lock);
1940 if ((bs->shadbuf != NULL) && (bs->sl > 0)) {
1941 sndbuf_softreset(bs);
1942 sndbuf_acquire(bs, bs->shadbuf, bs->sl);
1950 case SNDCTL_DSP_CURRENT_OPTR:
1951 case SNDCTL_DSP_CURRENT_IPTR:
1953 * @note Changing formats resets the buffer counters, which differs
1954 * from the 4Front drivers. However, I don't expect this to be
1955 * much of a problem.
1957 * @note In a test where @c CURRENT_OPTR is called immediately after write
1958 * returns, this driver is about 32K samples behind whereas
1959 * 4Front's is about 8K samples behind. Should determine source
1960 * of discrepancy, even if only out of curiosity.
1962 * @todo Actually test SNDCTL_DSP_CURRENT_IPTR.
1964 chn = (cmd == SNDCTL_DSP_CURRENT_OPTR) ? wrch : rdch;
1968 struct snd_dbuf *bs;
1971 oss_count_t *oc = (oss_count_t *)arg;
1976 tmp = (sndbuf_getsize(b) + chn_getptr(chn) - sndbuf_gethwptr(b)) % sndbuf_getsize(b);
1977 oc->samples = (sndbuf_gettotal(b) + tmp) / sndbuf_getalign(b);
1978 oc->fifo_samples = (sndbuf_getready(b) - tmp) / sndbuf_getalign(b);
1980 oc->samples = sndbuf_gettotal(bs) / sndbuf_getalign(bs);
1981 oc->fifo_samples = sndbuf_getready(bs) / sndbuf_getalign(bs);
1987 case SNDCTL_DSP_HALT_OUTPUT:
1988 case SNDCTL_DSP_HALT_INPUT:
1989 chn = (cmd == SNDCTL_DSP_HALT_OUTPUT) ? wrch : rdch;
1999 case SNDCTL_DSP_LOW_WATER:
2001 * Set the number of bytes required to attract attention by
2006 wrch->lw = (*arg_i > 1) ? *arg_i : 1;
2011 rdch->lw = (*arg_i > 1) ? *arg_i : 1;
2016 case SNDCTL_DSP_GETERROR:
2018 * OSSv4 docs: "All errors and counters will automatically be
2019 * cleared to zeroes after the call so each call will return only
2020 * the errors that occurred after the previous invocation. ... The
2021 * play_underruns and rec_overrun fields are the only useful fields
2022 * returned by OSS 4.0."
2025 audio_errinfo *ei = (audio_errinfo *)arg;
2027 bzero((void *)ei, sizeof(*ei));
2031 ei->play_underruns = wrch->xruns;
2037 ei->rec_overruns = rdch->xruns;
2044 case SNDCTL_DSP_SYNCGROUP:
2045 PCM_ACQUIRE_QUICK(d);
2046 ret = dsp_oss_syncgroup(wrch, rdch, (oss_syncgroup *)arg);
2047 PCM_RELEASE_QUICK(d);
2050 case SNDCTL_DSP_SYNCSTART:
2051 PCM_ACQUIRE_QUICK(d);
2052 ret = dsp_oss_syncstart(*arg_i);
2053 PCM_RELEASE_QUICK(d);
2056 case SNDCTL_DSP_POLICY:
2057 PCM_ACQUIRE_QUICK(d);
2058 ret = dsp_oss_policy(wrch, rdch, *arg_i);
2059 PCM_RELEASE_QUICK(d);
2062 case SNDCTL_DSP_COOKEDMODE:
2063 PCM_ACQUIRE_QUICK(d);
2064 if (!(dsp_get_flags(i_dev) & SD_F_BITPERFECT))
2065 ret = dsp_oss_cookedmode(wrch, rdch, *arg_i);
2066 PCM_RELEASE_QUICK(d);
2068 case SNDCTL_DSP_GET_CHNORDER:
2069 PCM_ACQUIRE_QUICK(d);
2070 ret = dsp_oss_getchnorder(wrch, rdch, (unsigned long long *)arg);
2071 PCM_RELEASE_QUICK(d);
2073 case SNDCTL_DSP_SET_CHNORDER:
2074 PCM_ACQUIRE_QUICK(d);
2075 ret = dsp_oss_setchnorder(wrch, rdch, (unsigned long long *)arg);
2076 PCM_RELEASE_QUICK(d);
2078 case SNDCTL_DSP_GETCHANNELMASK: /* XXX vlc */
2079 PCM_ACQUIRE_QUICK(d);
2080 ret = dsp_oss_getchannelmask(wrch, rdch, (int *)arg);
2081 PCM_RELEASE_QUICK(d);
2083 case SNDCTL_DSP_BIND_CHANNEL: /* XXX what?!? */
2086 #ifdef OSSV4_EXPERIMENT
2088 * XXX The following ioctls are not yet supported and just return
2091 case SNDCTL_DSP_GETOPEAKS:
2092 case SNDCTL_DSP_GETIPEAKS:
2093 chn = (cmd == SNDCTL_DSP_GETOPEAKS) ? wrch : rdch;
2097 oss_peaks_t *op = (oss_peaks_t *)arg;
2101 ret = chn_getpeaks(chn, &lpeak, &rpeak);
2113 * XXX Once implemented, revisit this for proper cv protection
2116 case SNDCTL_GETLABEL:
2117 ret = dsp_oss_getlabel(wrch, rdch, (oss_label_t *)arg);
2119 case SNDCTL_SETLABEL:
2120 ret = dsp_oss_setlabel(wrch, rdch, (oss_label_t *)arg);
2122 case SNDCTL_GETSONG:
2123 ret = dsp_oss_getsong(wrch, rdch, (oss_longname_t *)arg);
2125 case SNDCTL_SETSONG:
2126 ret = dsp_oss_setsong(wrch, rdch, (oss_longname_t *)arg);
2128 case SNDCTL_SETNAME:
2129 ret = dsp_oss_setname(wrch, rdch, (oss_longname_t *)arg);
2133 * @note The S/PDIF interface ioctls, @c SNDCTL_DSP_READCTL and
2134 * @c SNDCTL_DSP_WRITECTL have been omitted at the suggestion of
2135 * 4Front Technologies.
2137 case SNDCTL_DSP_READCTL:
2138 case SNDCTL_DSP_WRITECTL:
2141 #endif /* !0 (explicitly omitted ioctls) */
2143 #endif /* !OSSV4_EXPERIMENT */
2144 case SNDCTL_DSP_MAPINBUF:
2145 case SNDCTL_DSP_MAPOUTBUF:
2146 case SNDCTL_DSP_SETSYNCRO:
2149 case SNDCTL_DSP_SUBDIVIDE:
2150 case SOUND_PCM_WRITE_FILTER:
2151 case SOUND_PCM_READ_FILTER:
2152 /* dunno what these do, don't sound important */
2155 DEB(printf("default ioctl fn 0x%08lx fail\n", cmd));
2166 dsp_poll(struct cdev *i_dev, int events, struct thread *td)
2168 struct snddev_info *d;
2169 struct pcm_channel *wrch, *rdch;
2172 d = dsp_get_info(i_dev);
2173 if (!DSP_REGISTERED(d, i_dev))
2182 getchns(i_dev, &rdch, &wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2184 if (wrch != NULL && !(wrch->flags & CHN_F_DEAD)) {
2185 e = (events & (POLLOUT | POLLWRNORM));
2187 ret |= chn_poll(wrch, e, td);
2190 if (rdch != NULL && !(rdch->flags & CHN_F_DEAD)) {
2191 e = (events & (POLLIN | POLLRDNORM));
2193 ret |= chn_poll(rdch, e, td);
2196 relchns(i_dev, rdch, wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2204 dsp_mmap(struct cdev *i_dev, vm_ooffset_t offset, vm_paddr_t *paddr,
2205 int nprot, vm_memattr_t *memattr)
2209 * offset is in range due to checks in dsp_mmap_single().
2210 * XXX memattr is not honored.
2212 *paddr = vtophys(offset);
2217 dsp_mmap_single(struct cdev *i_dev, vm_ooffset_t *offset,
2218 vm_size_t size, struct vm_object **object, int nprot)
2220 struct snddev_info *d;
2221 struct pcm_channel *wrch, *rdch, *c;
2224 * Reject PROT_EXEC by default. It just doesn't makes sense.
2225 * Unfortunately, we have to give up this one due to linux_mmap
2228 * https://lists.freebsd.org/pipermail/freebsd-emulation/2007-June/003698.html
2232 if ((nprot & PROT_EXEC) && (dsp_mmap_allow_prot_exec < 0 ||
2233 (dsp_mmap_allow_prot_exec == 0 &&
2234 SV_CURPROC_ABI() != SV_ABI_LINUX)))
2236 if ((nprot & PROT_EXEC) && dsp_mmap_allow_prot_exec < 1)
2241 * PROT_READ (alone) selects the input buffer.
2242 * PROT_WRITE (alone) selects the output buffer.
2243 * PROT_WRITE|PROT_READ together select the output buffer.
2245 if ((nprot & (PROT_READ | PROT_WRITE)) == 0)
2248 d = dsp_get_info(i_dev);
2249 if (!DSP_REGISTERED(d, i_dev))
2254 getchns(i_dev, &rdch, &wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2256 c = ((nprot & PROT_WRITE) != 0) ? wrch : rdch;
2257 if (c == NULL || (c->flags & CHN_F_MMAP_INVALID) ||
2258 (*offset + size) > sndbuf_getsize(c->bufsoft) ||
2259 (wrch != NULL && (wrch->flags & CHN_F_MMAP_INVALID)) ||
2260 (rdch != NULL && (rdch->flags & CHN_F_MMAP_INVALID))) {
2261 relchns(i_dev, rdch, wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2267 wrch->flags |= CHN_F_MMAP;
2269 rdch->flags |= CHN_F_MMAP;
2271 *offset = (uintptr_t)sndbuf_getbufofs(c->bufsoft, *offset);
2272 relchns(i_dev, rdch, wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2273 *object = vm_pager_allocate(OBJT_DEVICE, i_dev,
2274 size, nprot, *offset, curthread->td_ucred);
2278 if (*object == NULL)
2283 /* So much for dev_stdclone() */
2285 dsp_stdclone(char *name, char *namep, char *sep, int use_sep, int *u, int *c)
2289 len = strlen(namep);
2291 if (bcmp(name, namep, len) != 0)
2296 if (isdigit(*name) == 0)
2301 if (*name == '0' && !(name[1] == '\0' || bcmp(name + 1, sep, len) == 0))
2304 for (*u = 0; isdigit(*name) != 0; name++) {
2312 return ((use_sep == 0) ? 0 : ENODEV);
2314 if (bcmp(name, sep, len) != 0 || isdigit(name[len]) == 0)
2319 if (*name == '0' && name[1] != '\0')
2322 for (*c = 0; isdigit(*name) != 0; name++) {
2336 dsp_clone(void *arg,
2338 char *name, int namelen, struct cdev **dev)
2340 struct snddev_info *d;
2341 struct snd_clone_entry *ce;
2342 struct pcm_channel *c;
2343 int i, unit, udcmask, cunit, devtype, devhw, devcmax, tumax;
2344 char *devname, *devcmp, *devsep;
2346 KASSERT(dsp_umax >= 0 && dsp_cmax >= 0, ("Uninitialized unit!"));
2360 for (i = 0; unit == -1 &&
2361 i < (sizeof(dsp_cdevs) / sizeof(dsp_cdevs[0])); i++) {
2362 devtype = dsp_cdevs[i].type;
2363 devcmp = dsp_cdevs[i].name;
2364 devsep = dsp_cdevs[i].sep;
2365 devname = dsp_cdevs[i].alias;
2366 if (devname == NULL)
2368 devhw = dsp_cdevs[i].hw;
2369 devcmax = dsp_cdevs[i].max - 1;
2370 if (strcmp(name, devcmp) == 0) {
2371 if (dsp_basename_clone != 0)
2373 } else if (dsp_stdclone(name, devcmp, devsep,
2374 dsp_cdevs[i].use_sep, &unit, &cunit) != 0) {
2380 d = devclass_get_softc(pcm_devclass, unit);
2381 if (!PCM_REGISTERED(d) || d->clones == NULL)
2384 /* XXX Need Giant magic entry ??? */
2387 if (snd_clone_disabled(d->clones)) {
2396 udcmask = snd_u2unit(unit) | snd_d2unit(devtype);
2399 KASSERT(devcmax <= dsp_cmax,
2400 ("overflow: devcmax=%d, dsp_cmax=%d", devcmax, dsp_cmax));
2401 if (cunit > devcmax) {
2402 PCM_RELEASE_QUICK(d);
2405 udcmask |= snd_c2unit(cunit);
2406 CHN_FOREACH(c, d, channels.pcm) {
2408 if (c->unit != udcmask) {
2413 udcmask &= ~snd_c2unit(cunit);
2415 * Temporarily increase clone maxunit to overcome
2416 * vchan flexibility.
2418 * # sysctl dev.pcm.0.play.vchans=256
2419 * dev.pcm.0.play.vchans: 1 -> 256
2420 * # cat /dev/zero > /dev/dsp0.vp255 &
2422 * # sysctl dev.pcm.0.play.vchans=0
2423 * dev.pcm.0.play.vchans: 256 -> 1
2425 * [1] + running cat /dev/zero > /dev/dsp0.vp255
2427 * # cat /dev/zero > /dev/dsp0.vp255
2428 * zsh: operation not supported: /dev/dsp0.vp255
2430 tumax = snd_clone_getmaxunit(d->clones);
2432 snd_clone_setmaxunit(d->clones, cunit);
2435 goto dsp_clone_alloc;
2438 * Ok, so we're requesting unallocated vchan, but still
2439 * within maximum vchan limit.
2441 if (((devtype == SND_DEV_DSPHW_VPLAY && d->pvchancount > 0) ||
2442 (devtype == SND_DEV_DSPHW_VREC && d->rvchancount > 0)) &&
2443 cunit < snd_maxautovchans) {
2444 udcmask &= ~snd_c2unit(cunit);
2445 tumax = snd_clone_getmaxunit(d->clones);
2447 snd_clone_setmaxunit(d->clones, cunit);
2450 goto dsp_clone_alloc;
2452 PCM_RELEASE_QUICK(d);
2457 ce = snd_clone_alloc(d->clones, dev, &cunit, udcmask);
2459 snd_clone_setmaxunit(d->clones, tumax);
2461 udcmask |= snd_c2unit(cunit);
2462 *dev = make_dev(&dsp_cdevsw, PCMMINOR(udcmask),
2463 UID_ROOT, GID_WHEEL, 0666, "%s%d%s%d",
2464 devname, unit, devsep, cunit);
2465 snd_clone_register(ce, *dev);
2468 PCM_RELEASE_QUICK(d);
2475 dsp_sysinit(void *p)
2477 if (dsp_ehtag != NULL)
2479 /* initialize unit numbering */
2481 dsp_umax = PCMMAXUNIT;
2482 dsp_cmax = PCMMAXCHAN;
2483 dsp_ehtag = EVENTHANDLER_REGISTER(dev_clone, dsp_clone, 0, 1000);
2487 dsp_sysuninit(void *p)
2489 if (dsp_ehtag == NULL)
2491 EVENTHANDLER_DEREGISTER(dev_clone, dsp_ehtag);
2495 SYSINIT(dsp_sysinit, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, dsp_sysinit, NULL);
2496 SYSUNINIT(dsp_sysuninit, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, dsp_sysuninit, NULL);
2499 dsp_unit2name(char *buf, size_t len, int unit)
2503 KASSERT(buf != NULL && len != 0,
2504 ("bogus buf=%p len=%ju", buf, (uintmax_t)len));
2506 dtype = snd_unit2d(unit);
2508 for (i = 0; i < (sizeof(dsp_cdevs) / sizeof(dsp_cdevs[0])); i++) {
2509 if (dtype != dsp_cdevs[i].type || dsp_cdevs[i].alias != NULL)
2511 snprintf(buf, len, "%s%d%s%d", dsp_cdevs[i].name,
2512 snd_unit2u(unit), dsp_cdevs[i].sep, snd_unit2c(unit));
2520 * @brief Handler for SNDCTL_AUDIOINFO.
2522 * Gathers information about the audio device specified in ai->dev. If
2523 * ai->dev == -1, then this function gathers information about the current
2524 * device. If the call comes in on a non-audio device and ai->dev == -1,
2527 * This routine is supposed to go practically straight to the hardware,
2528 * getting capabilities directly from the sound card driver, side-stepping
2529 * the intermediate channel interface.
2531 * Note, however, that the usefulness of this command is significantly
2532 * decreased when requesting info about any device other than the one serving
2533 * the request. While each snddev_channel refers to a specific device node,
2534 * the converse is *not* true. Currently, when a sound device node is opened,
2535 * the sound subsystem scans for an available audio channel (or channels, if
2536 * opened in read+write) and then assigns them to the si_drv[12] private
2537 * data fields. As a result, any information returned linking a channel to
2538 * a specific character device isn't necessarily accurate.
2541 * Calling threads must not hold any snddev_info or pcm_channel locks.
2543 * @param dev device on which the ioctl was issued
2544 * @param ai ioctl request data container
2547 * @retval EINVAL ai->dev specifies an invalid device
2549 * @todo Verify correctness of Doxygen tags. ;)
2552 dsp_oss_audioinfo(struct cdev *i_dev, oss_audioinfo *ai)
2554 struct pcmchan_caps *caps;
2555 struct pcm_channel *ch;
2556 struct snddev_info *d;
2558 int i, nchan, *rates, minch, maxch;
2559 char *devname, buf[CHN_NAMELEN];
2562 * If probing the device that received the ioctl, make sure it's a
2563 * DSP device. (Users may use this ioctl with /dev/mixer and
2566 if (ai->dev == -1 && i_dev->si_devsw != &dsp_cdevsw)
2572 bzero(buf, sizeof(buf));
2575 * Search for the requested audio device (channel). Start by
2576 * iterating over pcm devices.
2578 for (i = 0; pcm_devclass != NULL &&
2579 i < devclass_get_maxunit(pcm_devclass); i++) {
2580 d = devclass_get_softc(pcm_devclass, i);
2581 if (!PCM_REGISTERED(d))
2584 /* XXX Need Giant magic entry ??? */
2586 /* See the note in function docblock */
2587 PCM_UNLOCKASSERT(d);
2590 CHN_FOREACH(ch, d, channels.pcm) {
2591 CHN_UNLOCKASSERT(ch);
2593 if (ai->dev == -1) {
2594 if (DSP_REGISTERED(d, i_dev) &&
2595 (ch == PCM_RDCH(i_dev) || /* record ch */
2596 ch == PCM_WRCH(i_dev))) { /* playback ch */
2597 devname = dsp_unit2name(buf,
2598 sizeof(buf), ch->unit);
2600 } else if (ai->dev == nchan) {
2601 devname = dsp_unit2name(buf, sizeof(buf),
2604 if (devname != NULL)
2610 if (devname != NULL) {
2612 * At this point, the following synchronization stuff
2614 * - a specific PCM device is locked.
2615 * - a specific audio channel has been locked, so be
2616 * sure to unlock when exiting;
2619 caps = chn_getcaps(ch);
2622 * With all handles collected, zero out the user's
2623 * container and begin filling in its fields.
2625 bzero((void *)ai, sizeof(oss_audioinfo));
2628 strlcpy(ai->name, ch->name, sizeof(ai->name));
2630 if ((ch->flags & CHN_F_BUSY) == 0)
2633 ai->busy = (ch->direction == PCMDIR_PLAY) ? OPEN_WRITE : OPEN_READ;
2637 * @c cmd - OSSv4 docs: "Only supported under Linux at
2638 * this moment." Cop-out, I know, but I'll save
2639 * running around in the process table for later.
2640 * Is there a risk of leaking information?
2645 * These flags stolen from SNDCTL_DSP_GETCAPS handler.
2646 * Note, however, that a single channel operates in
2647 * only one direction, so PCM_CAP_DUPLEX is out.
2650 * @todo @c SNDCTL_AUDIOINFO::caps - Make drivers keep
2651 * these in pcmchan::caps?
2653 ai->caps = PCM_CAP_REALTIME | PCM_CAP_MMAP | PCM_CAP_TRIGGER |
2654 ((ch->direction == PCMDIR_PLAY) ? PCM_CAP_OUTPUT : PCM_CAP_INPUT);
2657 * Collect formats supported @b natively by the
2658 * device. Also determine min/max channels. (I.e.,
2659 * mono, stereo, or both?)
2661 * If any channel is stereo, maxch = 2;
2662 * if all channels are stereo, minch = 2, too;
2663 * if any channel is mono, minch = 1;
2664 * and if all channels are mono, maxch = 1.
2669 for (i = 0; caps->fmtlist[i]; i++) {
2670 fmts |= caps->fmtlist[i];
2671 if (AFMT_CHANNEL(caps->fmtlist[i]) > 1) {
2672 minch = (minch == 0) ? 2 : minch;
2676 maxch = (maxch == 0) ? 1 : maxch;
2680 if (ch->direction == PCMDIR_PLAY)
2681 ai->oformats = fmts;
2683 ai->iformats = fmts;
2687 * @c magic - OSSv4 docs: "Reserved for internal use
2691 * @c card_number - OSSv4 docs: "Number of the sound
2692 * card where this device belongs or -1 if this
2693 * information is not available. Applications
2694 * should normally not use this field for any
2697 ai->card_number = -1;
2699 * @todo @c song_name - depends first on
2700 * SNDCTL_[GS]ETSONG @todo @c label - depends
2701 * on SNDCTL_[GS]ETLABEL
2702 * @todo @c port_number - routing information?
2704 ai->port_number = -1;
2705 ai->mixer_dev = (d->mixer_dev != NULL) ? PCMUNIT(d->mixer_dev) : -1;
2708 * @c real_device - OSSv4 docs: "Obsolete."
2710 ai->real_device = -1;
2711 strlcpy(ai->devnode, "/dev/", sizeof(ai->devnode));
2712 strlcat(ai->devnode, devname, sizeof(ai->devnode));
2713 ai->enabled = device_is_attached(d->dev) ? 1 : 0;
2716 * @c flags - OSSv4 docs: "Reserved for future use."
2719 * @c binding - OSSv4 docs: "Reserved for future use."
2721 * @todo @c handle - haven't decided how to generate
2722 * this yet; bus, vendor, device IDs?
2724 ai->min_rate = caps->minspeed;
2725 ai->max_rate = caps->maxspeed;
2727 ai->min_channels = minch;
2728 ai->max_channels = maxch;
2730 ai->nrates = chn_getrates(ch, &rates);
2731 if (ai->nrates > OSS_MAX_SAMPLE_RATES)
2732 ai->nrates = OSS_MAX_SAMPLE_RATES;
2734 for (i = 0; i < ai->nrates; i++)
2735 ai->rates[i] = rates[i];
2737 ai->next_play_engine = 0;
2738 ai->next_rec_engine = 0;
2745 if (devname != NULL)
2749 /* Exhausted the search -- nothing is locked, so return. */
2754 * @brief Assigns a PCM channel to a sync group.
2756 * Sync groups are used to enable audio operations on multiple devices
2757 * simultaneously. They may be used with any number of devices and may
2758 * span across applications. Devices are added to groups with
2759 * the SNDCTL_DSP_SYNCGROUP ioctl, and operations are triggered with the
2760 * SNDCTL_DSP_SYNCSTART ioctl.
2762 * If the @c id field of the @c group parameter is set to zero, then a new
2763 * sync group is created. Otherwise, wrch and rdch (if set) are added to
2764 * the group specified.
2766 * @todo As far as memory allocation, should we assume that things are
2767 * okay and allocate with M_WAITOK before acquiring channel locks,
2768 * freeing later if not?
2770 * @param wrch output channel associated w/ device (if any)
2771 * @param rdch input channel associated w/ device (if any)
2772 * @param group Sync group parameters
2775 * @retval non-zero error to be propagated upstream
2778 dsp_oss_syncgroup(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_syncgroup *group)
2780 struct pcmchan_syncmember *smrd, *smwr;
2781 struct pcmchan_syncgroup *sg;
2790 * Free_unr() may sleep, so store released syncgroup IDs until after
2791 * all locks are released.
2793 sg_ids[0] = sg_ids[1] = sg_ids[2] = 0;
2798 * - Insert channel(s) into group's member list.
2799 * - Set CHN_F_NOTRIGGER on channel(s).
2800 * - Stop channel(s).
2804 * If device's channels are already mapped to a group, unmap them.
2808 sg_ids[0] = chn_syncdestroy(wrch);
2813 sg_ids[1] = chn_syncdestroy(rdch);
2817 * Verify that mode matches character device properites.
2818 * - Bail if PCM_ENABLE_OUTPUT && wrch == NULL.
2819 * - Bail if PCM_ENABLE_INPUT && rdch == NULL.
2821 if (((wrch == NULL) && (group->mode & PCM_ENABLE_OUTPUT)) ||
2822 ((rdch == NULL) && (group->mode & PCM_ENABLE_INPUT))) {
2828 * An id of zero indicates the user wants to create a new
2831 if (group->id == 0) {
2832 sg = (struct pcmchan_syncgroup *)malloc(sizeof(*sg), M_DEVBUF, M_NOWAIT);
2834 SLIST_INIT(&sg->members);
2835 sg->id = alloc_unr(pcmsg_unrhdr);
2838 SLIST_INSERT_HEAD(&snd_pcm_syncgroups, sg, link);
2842 SLIST_FOREACH(sg, &snd_pcm_syncgroups, link) {
2843 if (sg->id == group->id)
2850 /* Couldn't create or find a syncgroup. Fail. */
2855 * Allocate a syncmember, assign it and a channel together, and
2856 * insert into syncgroup.
2858 if (group->mode & PCM_ENABLE_INPUT) {
2859 smrd = (struct pcmchan_syncmember *)malloc(sizeof(*smrd), M_DEVBUF, M_NOWAIT);
2865 SLIST_INSERT_HEAD(&sg->members, smrd, link);
2870 rdch->flags |= CHN_F_NOTRIGGER;
2874 if (group->mode & PCM_ENABLE_OUTPUT) {
2875 smwr = (struct pcmchan_syncmember *)malloc(sizeof(*smwr), M_DEVBUF, M_NOWAIT);
2881 SLIST_INSERT_HEAD(&sg->members, smwr, link);
2886 wrch->flags |= CHN_F_NOTRIGGER;
2894 free(smrd, M_DEVBUF);
2895 if ((sg != NULL) && SLIST_EMPTY(&sg->members)) {
2897 SLIST_REMOVE(&snd_pcm_syncgroups, sg, pcmchan_syncgroup, link);
2915 free_unr(pcmsg_unrhdr, sg_ids[0]);
2917 free_unr(pcmsg_unrhdr, sg_ids[1]);
2919 free_unr(pcmsg_unrhdr, sg_ids[2]);
2925 * @brief Launch a sync group into action
2927 * Sync groups are established via SNDCTL_DSP_SYNCGROUP. This function
2928 * iterates over all members, triggering them along the way.
2930 * @note Caller must not hold any channel locks.
2932 * @param sg_id sync group identifier
2935 * @retval non-zero error worthy of propagating upstream to user
2938 dsp_oss_syncstart(int sg_id)
2940 struct pcmchan_syncmember *sm, *sm_tmp;
2941 struct pcmchan_syncgroup *sg;
2942 struct pcm_channel *c;
2945 /* Get the synclists lock */
2952 /* Search for syncgroup by ID */
2953 SLIST_FOREACH(sg, &snd_pcm_syncgroups, link) {
2954 if (sg->id == sg_id)
2958 /* Return EINVAL if not found */
2964 /* Any removals resulting in an empty group should've handled this */
2965 KASSERT(!SLIST_EMPTY(&sg->members), ("found empty syncgroup"));
2968 * Attempt to lock all member channels - if any are already
2969 * locked, unlock those acquired, sleep for a bit, and try
2972 SLIST_FOREACH(sm, &sg->members, link) {
2973 if (CHN_TRYLOCK(sm->ch) == 0) {
2974 int timo = hz * 5/1000;
2978 /* Release all locked channels so far, retry */
2979 SLIST_FOREACH(sm_tmp, &sg->members, link) {
2980 /* sm is the member already locked */
2983 CHN_UNLOCK(sm_tmp->ch);
2986 /** @todo Is PRIBIO correct/ */
2987 ret = msleep(sm, &snd_pcm_syncgroups_mtx,
2988 PRIBIO | PCATCH, "pcmsg", timo);
2989 if (ret == EINTR || ret == ERESTART)
2993 ret = 0; /* Assumes ret == EAGAIN... */
2996 } while (needlocks && ret == 0);
2998 /* Proceed only if no errors encountered. */
3000 /* Launch channels */
3001 while ((sm = SLIST_FIRST(&sg->members)) != NULL) {
3002 SLIST_REMOVE_HEAD(&sg->members, link);
3007 c->flags &= ~CHN_F_NOTRIGGER;
3013 SLIST_REMOVE(&snd_pcm_syncgroups, sg, pcmchan_syncgroup, link);
3020 * Free_unr() may sleep, so be sure to give up the syncgroup lock
3024 free_unr(pcmsg_unrhdr, sg_id);
3030 * @brief Handler for SNDCTL_DSP_POLICY
3032 * The SNDCTL_DSP_POLICY ioctl is a simpler interface to control fragment
3033 * size and count like with SNDCTL_DSP_SETFRAGMENT. Instead of the user
3034 * specifying those two parameters, s/he simply selects a number from 0..10
3035 * which corresponds to a buffer size. Smaller numbers request smaller
3036 * buffers with lower latencies (at greater overhead from more frequent
3037 * interrupts), while greater numbers behave in the opposite manner.
3039 * The 4Front spec states that a value of 5 should be the default. However,
3040 * this implementation deviates slightly by using a linear scale without
3041 * consulting drivers. I.e., even though drivers may have different default
3042 * buffer sizes, a policy argument of 5 will have the same result across
3045 * See http://manuals.opensound.com/developer/SNDCTL_DSP_POLICY.html for
3048 * @todo When SNDCTL_DSP_COOKEDMODE is supported, it'll be necessary to
3049 * work with hardware drivers directly.
3051 * @note PCM channel arguments must not be locked by caller.
3053 * @param wrch Pointer to opened playback channel (optional; may be NULL)
3054 * @param rdch " recording channel (optional; may be NULL)
3055 * @param policy Integer from [0:10]
3057 * @retval 0 constant (for now)
3060 dsp_oss_policy(struct pcm_channel *wrch, struct pcm_channel *rdch, int policy)
3064 if (policy < CHN_POLICY_MIN || policy > CHN_POLICY_MAX)
3067 /* Default: success */
3072 ret = chn_setlatency(rdch, policy);
3076 if (wrch && ret == 0) {
3078 ret = chn_setlatency(wrch, policy);
3089 * @brief Enable or disable "cooked" mode
3091 * This is a handler for @c SNDCTL_DSP_COOKEDMODE. When in cooked mode, which
3092 * is the default, the sound system handles rate and format conversions
3093 * automatically (ex: user writing 11025Hz/8 bit/unsigned but card only
3094 * operates with 44100Hz/16bit/signed samples).
3096 * Disabling cooked mode is intended for applications wanting to mmap()
3097 * a sound card's buffer space directly, bypassing the FreeBSD 2-stage
3098 * feeder architecture, presumably to gain as much control over audio
3099 * hardware as possible.
3101 * See @c http://manuals.opensound.com/developer/SNDCTL_DSP_COOKEDMODE.html
3104 * @param wrch playback channel (optional; may be NULL)
3105 * @param rdch recording channel (optional; may be NULL)
3106 * @param enabled 0 = raw mode, 1 = cooked mode
3108 * @retval EINVAL Operation not yet supported.
3111 dsp_oss_cookedmode(struct pcm_channel *wrch, struct pcm_channel *rdch, int enabled)
3115 * XXX I just don't get it. Why don't they call it
3116 * "BITPERFECT" ~ SNDCTL_DSP_BITPERFECT !?!?.
3117 * This is just plain so confusing, incoherent,
3118 * <insert any non-printable characters here>.
3120 if (!(enabled == 1 || enabled == 0))
3124 * I won't give in. I'm inverting its logic here and now.
3125 * Brag all you want, but "BITPERFECT" should be the better
3128 enabled ^= 0x00000001;
3132 wrch->flags &= ~CHN_F_BITPERFECT;
3133 wrch->flags |= (enabled != 0) ? CHN_F_BITPERFECT : 0x00000000;
3139 rdch->flags &= ~CHN_F_BITPERFECT;
3140 rdch->flags |= (enabled != 0) ? CHN_F_BITPERFECT : 0x00000000;
3148 * @brief Retrieve channel interleaving order
3150 * This is the handler for @c SNDCTL_DSP_GET_CHNORDER.
3152 * See @c http://manuals.opensound.com/developer/SNDCTL_DSP_GET_CHNORDER.html
3155 * @note As the ioctl definition is still under construction, FreeBSD
3156 * does not currently support SNDCTL_DSP_GET_CHNORDER.
3158 * @param wrch playback channel (optional; may be NULL)
3159 * @param rdch recording channel (optional; may be NULL)
3160 * @param map channel map (result will be stored there)
3162 * @retval EINVAL Operation not yet supported.
3165 dsp_oss_getchnorder(struct pcm_channel *wrch, struct pcm_channel *rdch, unsigned long long *map)
3167 struct pcm_channel *ch;
3170 ch = (wrch != NULL) ? wrch : rdch;
3173 ret = chn_oss_getorder(ch, map);
3182 * @brief Specify channel interleaving order
3184 * This is the handler for @c SNDCTL_DSP_SET_CHNORDER.
3186 * @note As the ioctl definition is still under construction, FreeBSD
3187 * does not currently support @c SNDCTL_DSP_SET_CHNORDER.
3189 * @param wrch playback channel (optional; may be NULL)
3190 * @param rdch recording channel (optional; may be NULL)
3191 * @param map channel map
3193 * @retval EINVAL Operation not yet supported.
3196 dsp_oss_setchnorder(struct pcm_channel *wrch, struct pcm_channel *rdch, unsigned long long *map)
3204 ret = chn_oss_setorder(wrch, map);
3208 if (ret == 0 && rdch != NULL) {
3210 ret = chn_oss_setorder(rdch, map);
3218 dsp_oss_getchannelmask(struct pcm_channel *wrch, struct pcm_channel *rdch,
3221 struct pcm_channel *ch;
3226 ch = (wrch != NULL) ? wrch : rdch;
3230 ret = chn_oss_getmask(ch, &chnmask);
3241 #ifdef OSSV4_EXPERIMENT
3243 * @brief Retrieve an audio device's label
3245 * This is a handler for the @c SNDCTL_GETLABEL ioctl.
3247 * See @c http://manuals.opensound.com/developer/SNDCTL_GETLABEL.html
3250 * From Hannu@4Front: "For example ossxmix (just like some HW mixer
3251 * consoles) can show variable "labels" for certain controls. By default
3252 * the application name (say quake) is shown as the label but
3253 * applications may change the labels themselves."
3255 * @note As the ioctl definition is still under construction, FreeBSD
3256 * does not currently support @c SNDCTL_GETLABEL.
3258 * @param wrch playback channel (optional; may be NULL)
3259 * @param rdch recording channel (optional; may be NULL)
3260 * @param label label gets copied here
3262 * @retval EINVAL Operation not yet supported.
3265 dsp_oss_getlabel(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_label_t *label)
3271 * @brief Specify an audio device's label
3273 * This is a handler for the @c SNDCTL_SETLABEL ioctl. Please see the
3274 * comments for @c dsp_oss_getlabel immediately above.
3276 * See @c http://manuals.opensound.com/developer/SNDCTL_GETLABEL.html
3279 * @note As the ioctl definition is still under construction, FreeBSD
3280 * does not currently support SNDCTL_SETLABEL.
3282 * @param wrch playback channel (optional; may be NULL)
3283 * @param rdch recording channel (optional; may be NULL)
3284 * @param label label gets copied from here
3286 * @retval EINVAL Operation not yet supported.
3289 dsp_oss_setlabel(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_label_t *label)
3295 * @brief Retrieve name of currently played song
3297 * This is a handler for the @c SNDCTL_GETSONG ioctl. Audio players could
3298 * tell the system the name of the currently playing song, which would be
3299 * visible in @c /dev/sndstat.
3301 * See @c http://manuals.opensound.com/developer/SNDCTL_GETSONG.html
3304 * @note As the ioctl definition is still under construction, FreeBSD
3305 * does not currently support SNDCTL_GETSONG.
3307 * @param wrch playback channel (optional; may be NULL)
3308 * @param rdch recording channel (optional; may be NULL)
3309 * @param song song name gets copied here
3311 * @retval EINVAL Operation not yet supported.
3314 dsp_oss_getsong(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_longname_t *song)
3320 * @brief Retrieve name of currently played song
3322 * This is a handler for the @c SNDCTL_SETSONG ioctl. Audio players could
3323 * tell the system the name of the currently playing song, which would be
3324 * visible in @c /dev/sndstat.
3326 * See @c http://manuals.opensound.com/developer/SNDCTL_SETSONG.html
3329 * @note As the ioctl definition is still under construction, FreeBSD
3330 * does not currently support SNDCTL_SETSONG.
3332 * @param wrch playback channel (optional; may be NULL)
3333 * @param rdch recording channel (optional; may be NULL)
3334 * @param song song name gets copied from here
3336 * @retval EINVAL Operation not yet supported.
3339 dsp_oss_setsong(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_longname_t *song)
3345 * @brief Rename a device
3347 * This is a handler for the @c SNDCTL_SETNAME ioctl.
3349 * See @c http://manuals.opensound.com/developer/SNDCTL_SETNAME.html for
3352 * From Hannu@4Front: "This call is used to change the device name
3353 * reported in /dev/sndstat and ossinfo. So instead of using some generic
3354 * 'OSS loopback audio (MIDI) driver' the device may be given a meaningfull
3355 * name depending on the current context (for example 'OSS virtual wave table
3356 * synth' or 'VoIP link to London')."
3358 * @note As the ioctl definition is still under construction, FreeBSD
3359 * does not currently support SNDCTL_SETNAME.
3361 * @param wrch playback channel (optional; may be NULL)
3362 * @param rdch recording channel (optional; may be NULL)
3363 * @param name new device name gets copied from here
3365 * @retval EINVAL Operation not yet supported.
3368 dsp_oss_setname(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_longname_t *name)
3372 #endif /* !OSSV4_EXPERIMENT */