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_DETACHING(d) || !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);
655 * We're done. Allocate channels information for this cdev.
658 case DSP_CDEV_VOLCTL_READ:
659 KASSERT(wrch == NULL, ("wrch=%p not null!", wrch));
660 dsp_cdevinfo_alloc(i_dev, NULL, NULL, rdch);
662 case DSP_CDEV_VOLCTL_WRITE:
663 KASSERT(rdch == NULL, ("rdch=%p not null!", rdch));
664 dsp_cdevinfo_alloc(i_dev, NULL, NULL, wrch);
666 case DSP_CDEV_VOLCTL_NONE:
668 if (wrch == NULL && rdch == NULL) {
669 (void)snd_clone_release(i_dev);
679 dsp_cdevinfo_alloc(i_dev, rdch, wrch, NULL);
681 CHN_INSERT_HEAD(d, rdch, channels.pcm.opened);
683 CHN_INSERT_HEAD(d, wrch, channels.pcm.opened);
688 * Increase clone refcount for its automatic garbage collector.
690 (void)snd_clone_ref(i_dev);
701 dsp_close(struct cdev *i_dev, int flags, int mode, struct thread *td)
703 struct pcm_channel *rdch, *wrch, *volch;
704 struct snddev_info *d;
705 int sg_ids, rdref, wdref;
707 d = dsp_get_info(i_dev);
708 if (!DSP_REGISTERED(d, i_dev))
717 rdch = PCM_RDCH(i_dev);
718 wrch = PCM_WRCH(i_dev);
719 volch = PCM_VOLCH(i_dev);
721 PCM_RDCH(i_dev) = NULL;
722 PCM_WRCH(i_dev) = NULL;
723 PCM_VOLCH(i_dev) = NULL;
731 else if (volch == wrch)
735 pcm_chnref(volch, -1);
741 CHN_REMOVE(d, rdch, channels.pcm.opened);
743 CHN_REMOVE(d, wrch, channels.pcm.opened);
745 if (rdch != NULL || wrch != NULL) {
749 * The channel itself need not be locked because:
750 * a) Adding a channel to a syncgroup happens only
751 * in dsp_ioctl(), which cannot run concurrently
753 * b) The syncmember pointer (sm) is protected by
754 * the global syncgroup list lock.
755 * c) A channel can't just disappear, invalidating
756 * pointers, unless it's closed/dereferenced
760 sg_ids = chn_syncdestroy(rdch);
763 free_unr(pcmsg_unrhdr, sg_ids);
766 pcm_chnref(rdch, rdref);
767 chn_abort(rdch); /* won't sleep */
768 rdch->flags &= ~(CHN_F_RUNNING | CHN_F_MMAP |
769 CHN_F_DEAD | CHN_F_EXCLUSIVE);
770 chn_reset(rdch, 0, 0);
771 pcm_chnrelease(rdch);
775 * Please see block above.
778 sg_ids = chn_syncdestroy(wrch);
781 free_unr(pcmsg_unrhdr, sg_ids);
784 pcm_chnref(wrch, wdref);
785 chn_flush(wrch); /* may sleep */
786 wrch->flags &= ~(CHN_F_RUNNING | CHN_F_MMAP |
787 CHN_F_DEAD | CHN_F_EXCLUSIVE);
788 chn_reset(wrch, 0, 0);
789 pcm_chnrelease(wrch);
794 dsp_cdevinfo_free(i_dev);
796 * Release clone busy state and unref it so the automatic
797 * garbage collector will get the hint and do the remaining
800 (void)snd_clone_release(i_dev);
803 * destroy_dev() might sleep, so release pcm lock
804 * here and rely on pcm cv serialization.
807 (void)snd_clone_unref(i_dev);
819 dsp_io_ops(struct cdev *i_dev, struct uio *buf)
821 struct snddev_info *d;
822 struct pcm_channel **ch, *rdch, *wrch;
823 int (*chn_io)(struct pcm_channel *, struct uio *);
827 KASSERT(i_dev != NULL && buf != NULL &&
828 (buf->uio_rw == UIO_READ || buf->uio_rw == UIO_WRITE),
829 ("%s(): io train wreck!", __func__));
831 d = dsp_get_info(i_dev);
832 if (PCM_DETACHING(d) || !DSP_REGISTERED(d, i_dev))
837 switch (buf->uio_rw) {
849 panic("invalid/corrupted uio direction: %d", buf->uio_rw);
855 runpid = buf->uio_td->td_proc->p_pid;
857 getchns(i_dev, &rdch, &wrch, prio);
859 if (*ch == NULL || !((*ch)->flags & CHN_F_BUSY)) {
864 if (((*ch)->flags & (CHN_F_MMAP | CHN_F_DEAD)) ||
865 (((*ch)->flags & CHN_F_RUNNING) && (*ch)->pid != runpid)) {
866 relchns(i_dev, rdch, wrch, prio);
869 } else if (!((*ch)->flags & CHN_F_RUNNING)) {
870 (*ch)->flags |= CHN_F_RUNNING;
875 * chn_read/write must give up channel lock in order to copy bytes
876 * from/to userland, so up the "in progress" counter to make sure
877 * someone else doesn't come along and muss up the buffer.
880 ret = chn_io(*ch, buf);
883 CHN_BROADCAST(&(*ch)->cv);
885 relchns(i_dev, rdch, wrch, prio);
893 dsp_read(struct cdev *i_dev, struct uio *buf, int flag)
895 return (dsp_io_ops(i_dev, buf));
899 dsp_write(struct cdev *i_dev, struct uio *buf, int flag)
901 return (dsp_io_ops(i_dev, buf));
905 dsp_get_volume_channel(struct cdev *dev, struct pcm_channel **volch)
907 struct snddev_info *d;
908 struct pcm_channel *c;
911 KASSERT(dev != NULL && volch != NULL,
912 ("%s(): NULL query dev=%p volch=%p", __func__, dev, volch));
914 d = dsp_get_info(dev);
915 if (!PCM_REGISTERED(d)) {
926 if (!(c->feederflags & (1 << FEEDER_VOLUME)))
936 unit = dev2unit(dev);
938 CHN_FOREACH(c, d, channels.pcm) {
940 if (c->unit != unit) {
950 return ((c->feederflags & (1 << FEEDER_VOLUME)) ? 0 : -1);
960 dsp_ioctl_channel(struct cdev *dev, struct pcm_channel *volch, u_long cmd,
963 struct snddev_info *d;
964 struct pcm_channel *rdch, *wrch;
967 d = dsp_get_info(dev);
968 if (!PCM_REGISTERED(d) || !(dsp_get_flags(dev) & SD_F_VPC))
975 rdch = PCM_RDCH(dev);
976 wrch = PCM_WRCH(dev);
978 /* No specific channel, look into cache */
980 volch = PCM_VOLCH(dev);
984 if (j == SOUND_MIXER_RECLEV && rdch != NULL)
986 else if (j == SOUND_MIXER_PCM && wrch != NULL)
990 devtype = PCMDEV(dev);
992 /* Look super harder */
994 (devtype == SND_DEV_DSPHW_PLAY || devtype == SND_DEV_DSPHW_VPLAY ||
995 devtype == SND_DEV_DSPHW_REC || devtype == SND_DEV_DSPHW_VREC)) {
996 ret = dsp_get_volume_channel(dev, &volch);
1003 /* Final validation */
1004 if (volch != NULL) {
1006 if (!(volch->feederflags & (1 << FEEDER_VOLUME))) {
1010 if (volch->direction == PCMDIR_PLAY)
1018 if (volch != NULL &&
1019 ((j == SOUND_MIXER_PCM && volch->direction == PCMDIR_PLAY) ||
1020 (j == SOUND_MIXER_RECLEV && volch->direction == PCMDIR_REC))) {
1021 if ((cmd & ~0xff) == MIXER_WRITE(0)) {
1022 int left, right, center;
1024 left = *(int *)arg & 0x7f;
1025 right = ((*(int *)arg) >> 8) & 0x7f;
1026 center = (left + right) >> 1;
1027 chn_setvolume_multi(volch, SND_VOL_C_PCM, left, right,
1029 } else if ((cmd & ~0xff) == MIXER_READ(0)) {
1030 *(int *)arg = CHN_GETVOLUME(volch,
1031 SND_VOL_C_PCM, SND_CHN_T_FL);
1032 *(int *)arg |= CHN_GETVOLUME(volch,
1033 SND_VOL_C_PCM, SND_CHN_T_FR) << 8;
1036 } else if (rdch != NULL || wrch != NULL) {
1038 case SOUND_MIXER_DEVMASK:
1039 case SOUND_MIXER_CAPS:
1040 case SOUND_MIXER_STEREODEVS:
1041 if ((cmd & ~0xff) == MIXER_READ(0)) {
1044 *(int *)arg |= SOUND_MASK_RECLEV;
1046 *(int *)arg |= SOUND_MASK_PCM;
1050 case SOUND_MIXER_RECMASK:
1051 case SOUND_MIXER_RECSRC:
1052 if ((cmd & ~0xff) == MIXER_READ(0))
1068 dsp_ioctl(struct cdev *i_dev, u_long cmd, caddr_t arg, int mode,
1071 struct pcm_channel *chn, *rdch, *wrch;
1072 struct snddev_info *d;
1074 int *arg_i, ret, tmp;
1076 d = dsp_get_info(i_dev);
1077 if (PCM_DETACHING(d) || !DSP_REGISTERED(d, i_dev))
1087 if (IOCGROUP(cmd) == 'M') {
1088 if (cmd == OSS_GETVERSION) {
1089 *arg_i = SOUND_VERSION;
1093 ret = dsp_ioctl_channel(i_dev, PCM_VOLCH(i_dev), cmd, arg);
1099 if (d->mixer_dev != NULL) {
1100 PCM_ACQUIRE_QUICK(d);
1101 ret = mixer_ioctl_cmd(d->mixer_dev, cmd, arg, -1, td,
1103 PCM_RELEASE_QUICK(d);
1113 * Certain ioctls may be made on any type of device (audio, mixer,
1114 * and MIDI). Handle those special cases here.
1116 if (IOCGROUP(cmd) == 'X') {
1117 PCM_ACQUIRE_QUICK(d);
1119 case SNDCTL_SYSINFO:
1120 sound_oss_sysinfo((oss_sysinfo *)arg);
1122 case SNDCTL_CARDINFO:
1123 ret = sound_oss_card_info((oss_card_info *)arg);
1125 case SNDCTL_AUDIOINFO:
1126 case SNDCTL_AUDIOINFO_EX:
1127 case SNDCTL_ENGINEINFO:
1128 ret = dsp_oss_audioinfo(i_dev, (oss_audioinfo *)arg);
1130 case SNDCTL_MIXERINFO:
1131 ret = mixer_oss_mixerinfo(i_dev, (oss_mixerinfo *)arg);
1136 PCM_RELEASE_QUICK(d);
1141 getchns(i_dev, &rdch, &wrch, 0);
1143 if (wrch != NULL && (wrch->flags & CHN_F_DEAD))
1145 if (rdch != NULL && (rdch->flags & CHN_F_DEAD))
1148 if (wrch == NULL && rdch == NULL) {
1156 * we start with the new ioctl interface.
1158 case AIONWRITE: /* how many bytes can write ? */
1162 if (wrch && wrch->bufhard.dl)
1163 while (chn_wrfeed(wrch) == 0);
1165 *arg_i = sndbuf_getfree(wrch->bufsoft);
1173 case AIOSSIZE: /* set the current blocksize */
1175 struct snd_size *p = (struct snd_size *)arg;
1179 PCM_ACQUIRE_QUICK(d);
1182 chn_setblocksize(wrch, 2, p->play_size);
1183 p->play_size = sndbuf_getblksz(wrch->bufsoft);
1188 chn_setblocksize(rdch, 2, p->rec_size);
1189 p->rec_size = sndbuf_getblksz(rdch->bufsoft);
1192 PCM_RELEASE_QUICK(d);
1195 case AIOGSIZE: /* get the current blocksize */
1197 struct snd_size *p = (struct snd_size *)arg;
1201 p->play_size = sndbuf_getblksz(wrch->bufsoft);
1206 p->rec_size = sndbuf_getblksz(rdch->bufsoft);
1215 snd_chan_param *p = (snd_chan_param *)arg;
1217 if (cmd == AIOSFMT &&
1218 ((p->play_format != 0 && p->play_rate == 0) ||
1219 (p->rec_format != 0 && p->rec_rate == 0))) {
1223 PCM_ACQUIRE_QUICK(d);
1226 if (cmd == AIOSFMT && p->play_format != 0) {
1228 SND_FORMAT(p->play_format,
1229 AFMT_CHANNEL(wrch->format),
1230 AFMT_EXTCHANNEL(wrch->format)));
1231 chn_setspeed(wrch, p->play_rate);
1233 p->play_rate = wrch->speed;
1234 p->play_format = AFMT_ENCODING(wrch->format);
1242 if (cmd == AIOSFMT && p->rec_format != 0) {
1244 SND_FORMAT(p->rec_format,
1245 AFMT_CHANNEL(rdch->format),
1246 AFMT_EXTCHANNEL(rdch->format)));
1247 chn_setspeed(rdch, p->rec_rate);
1249 p->rec_rate = rdch->speed;
1250 p->rec_format = AFMT_ENCODING(rdch->format);
1256 PCM_RELEASE_QUICK(d);
1260 case AIOGCAP: /* get capabilities */
1262 snd_capabilities *p = (snd_capabilities *)arg;
1263 struct pcmchan_caps *pcaps = NULL, *rcaps = NULL;
1269 rcaps = chn_getcaps(rdch);
1273 pcaps = chn_getcaps(wrch);
1275 p->rate_min = max(rcaps? rcaps->minspeed : 0,
1276 pcaps? pcaps->minspeed : 0);
1277 p->rate_max = min(rcaps? rcaps->maxspeed : 1000000,
1278 pcaps? pcaps->maxspeed : 1000000);
1279 p->bufsize = min(rdch? sndbuf_getsize(rdch->bufsoft) : 1000000,
1280 wrch? sndbuf_getsize(wrch->bufsoft) : 1000000);
1281 /* XXX bad on sb16 */
1282 p->formats = (rdch? chn_getformats(rdch) : 0xffffffff) &
1283 (wrch? chn_getformats(wrch) : 0xffffffff);
1285 p->formats |= (dsp_get_flags(i_dev) & SD_F_SIMPLEX)? 0 : AFMT_FULLDUPLEX;
1286 pdev = d->mixer_dev;
1287 p->mixers = 1; /* default: one mixer */
1288 p->inputs = pdev->si_drv1? mix_getdevs(pdev->si_drv1) : 0;
1289 p->left = p->right = 100;
1299 if (*arg_i == AIOSYNC_PLAY && wrch) {
1301 *arg_i = chn_abort(wrch);
1303 } else if (*arg_i == AIOSYNC_CAPTURE && rdch) {
1305 *arg_i = chn_abort(rdch);
1308 printf("AIOSTOP: bad channel 0x%x\n", *arg_i);
1314 printf("AIOSYNC chan 0x%03lx pos %lu unimplemented\n",
1315 ((snd_sync_parm *)arg)->chan, ((snd_sync_parm *)arg)->pos);
1319 * here follow the standard ioctls (filio.h etc.)
1321 case FIONREAD: /* get # bytes to read */
1324 /* if (rdch && rdch->bufhard.dl)
1325 while (chn_rdfeed(rdch) == 0);
1327 *arg_i = sndbuf_getready(rdch->bufsoft);
1335 case FIOASYNC: /*set/clear async i/o */
1336 DEB( printf("FIOASYNC\n") ; )
1339 case SNDCTL_DSP_NONBLOCK: /* set non-blocking i/o */
1340 case FIONBIO: /* set/clear non-blocking i/o */
1343 if (cmd == SNDCTL_DSP_NONBLOCK || *arg_i)
1344 rdch->flags |= CHN_F_NBIO;
1346 rdch->flags &= ~CHN_F_NBIO;
1351 if (cmd == SNDCTL_DSP_NONBLOCK || *arg_i)
1352 wrch->flags |= CHN_F_NBIO;
1354 wrch->flags &= ~CHN_F_NBIO;
1360 * Finally, here is the linux-compatible ioctl interface
1362 #define THE_REAL_SNDCTL_DSP_GETBLKSIZE _IOWR('P', 4, int)
1363 case THE_REAL_SNDCTL_DSP_GETBLKSIZE:
1364 case SNDCTL_DSP_GETBLKSIZE:
1365 chn = wrch ? wrch : rdch;
1368 *arg_i = sndbuf_getblksz(chn->bufsoft);
1376 case SNDCTL_DSP_SETBLKSIZE:
1377 RANGE(*arg_i, 16, 65536);
1378 PCM_ACQUIRE_QUICK(d);
1381 chn_setblocksize(wrch, 2, *arg_i);
1386 chn_setblocksize(rdch, 2, *arg_i);
1389 PCM_RELEASE_QUICK(d);
1392 case SNDCTL_DSP_RESET:
1393 DEB(printf("dsp reset\n"));
1408 case SNDCTL_DSP_SYNC:
1409 DEB(printf("dsp sync\n"));
1410 /* chn_sync may sleep */
1418 case SNDCTL_DSP_SPEED:
1419 /* chn_setspeed may sleep */
1421 PCM_ACQUIRE_QUICK(d);
1424 ret = chn_setspeed(wrch, *arg_i);
1428 if (rdch && ret == 0) {
1430 ret = chn_setspeed(rdch, *arg_i);
1435 PCM_RELEASE_QUICK(d);
1439 case SOUND_PCM_READ_RATE:
1440 chn = wrch ? wrch : rdch;
1443 *arg_i = chn->speed;
1451 case SNDCTL_DSP_STEREO:
1453 *arg_i = (*arg_i)? 2 : 1;
1454 PCM_ACQUIRE_QUICK(d);
1457 ret = chn_setformat(wrch,
1458 SND_FORMAT(wrch->format, *arg_i, 0));
1459 tmp = (AFMT_CHANNEL(wrch->format) > 1)? 1 : 0;
1462 if (rdch && ret == 0) {
1464 ret = chn_setformat(rdch,
1465 SND_FORMAT(rdch->format, *arg_i, 0));
1467 tmp = (AFMT_CHANNEL(rdch->format) > 1)? 1 : 0;
1470 PCM_RELEASE_QUICK(d);
1474 case SOUND_PCM_WRITE_CHANNELS:
1475 /* case SNDCTL_DSP_CHANNELS: ( == SOUND_PCM_WRITE_CHANNELS) */
1482 struct pcmchan_matrix *m;
1486 if (*arg_i > SND_CHN_MAX)
1487 *arg_i = SND_CHN_MAX;
1489 m = feeder_matrix_default_channel_map(*arg_i);
1495 PCM_ACQUIRE_QUICK(d);
1498 ret = chn_setformat(wrch,
1499 SND_FORMAT(wrch->format, *arg_i, ext));
1500 tmp = AFMT_CHANNEL(wrch->format);
1503 if (rdch && ret == 0) {
1505 ret = chn_setformat(rdch,
1506 SND_FORMAT(rdch->format, *arg_i, ext));
1508 tmp = AFMT_CHANNEL(rdch->format);
1511 PCM_RELEASE_QUICK(d);
1514 chn = wrch ? wrch : rdch;
1516 *arg_i = AFMT_CHANNEL(chn->format);
1521 case SOUND_PCM_READ_CHANNELS:
1522 chn = wrch ? wrch : rdch;
1525 *arg_i = AFMT_CHANNEL(chn->format);
1533 case SNDCTL_DSP_GETFMTS: /* returns a mask of supported fmts */
1534 chn = wrch ? wrch : rdch;
1537 *arg_i = chn_getformats(chn);
1545 case SNDCTL_DSP_SETFMT: /* sets _one_ format */
1546 if (*arg_i != AFMT_QUERY) {
1548 PCM_ACQUIRE_QUICK(d);
1551 ret = chn_setformat(wrch, SND_FORMAT(*arg_i,
1552 AFMT_CHANNEL(wrch->format),
1553 AFMT_EXTCHANNEL(wrch->format)));
1557 if (rdch && ret == 0) {
1559 ret = chn_setformat(rdch, SND_FORMAT(*arg_i,
1560 AFMT_CHANNEL(rdch->format),
1561 AFMT_EXTCHANNEL(rdch->format)));
1566 PCM_RELEASE_QUICK(d);
1567 *arg_i = AFMT_ENCODING(tmp);
1569 chn = wrch ? wrch : rdch;
1571 *arg_i = AFMT_ENCODING(chn->format);
1576 case SNDCTL_DSP_SETFRAGMENT:
1577 DEB(printf("SNDCTL_DSP_SETFRAGMENT 0x%08x\n", *(int *)arg));
1579 uint32_t fragln = (*arg_i) & 0x0000ffff;
1580 uint32_t maxfrags = ((*arg_i) & 0xffff0000) >> 16;
1582 uint32_t r_maxfrags, r_fragsz;
1584 RANGE(fragln, 4, 16);
1585 fragsz = 1 << fragln;
1588 maxfrags = CHN_2NDBUFMAXSIZE / fragsz;
1591 if (maxfrags * fragsz > CHN_2NDBUFMAXSIZE)
1592 maxfrags = CHN_2NDBUFMAXSIZE / fragsz;
1594 DEB(printf("SNDCTL_DSP_SETFRAGMENT %d frags, %d sz\n", maxfrags, fragsz));
1595 PCM_ACQUIRE_QUICK(d);
1598 ret = chn_setblocksize(rdch, maxfrags, fragsz);
1599 r_maxfrags = sndbuf_getblkcnt(rdch->bufsoft);
1600 r_fragsz = sndbuf_getblksz(rdch->bufsoft);
1603 r_maxfrags = maxfrags;
1606 if (wrch && ret == 0) {
1608 ret = chn_setblocksize(wrch, maxfrags, fragsz);
1609 maxfrags = sndbuf_getblkcnt(wrch->bufsoft);
1610 fragsz = sndbuf_getblksz(wrch->bufsoft);
1612 } else { /* use whatever came from the read channel */
1613 maxfrags = r_maxfrags;
1616 PCM_RELEASE_QUICK(d);
1619 while (fragsz > 1) {
1623 *arg_i = (maxfrags << 16) | fragln;
1627 case SNDCTL_DSP_GETISPACE:
1628 /* return the size of data available in the input queue */
1630 audio_buf_info *a = (audio_buf_info *)arg;
1632 struct snd_dbuf *bs = rdch->bufsoft;
1635 a->bytes = sndbuf_getready(bs);
1636 a->fragments = a->bytes / sndbuf_getblksz(bs);
1637 a->fragstotal = sndbuf_getblkcnt(bs);
1638 a->fragsize = sndbuf_getblksz(bs);
1645 case SNDCTL_DSP_GETOSPACE:
1646 /* return space available in the output queue */
1648 audio_buf_info *a = (audio_buf_info *)arg;
1650 struct snd_dbuf *bs = wrch->bufsoft;
1653 /* XXX abusive DMA update: chn_wrupdate(wrch); */
1654 a->bytes = sndbuf_getfree(bs);
1655 a->fragments = a->bytes / sndbuf_getblksz(bs);
1656 a->fragstotal = sndbuf_getblkcnt(bs);
1657 a->fragsize = sndbuf_getblksz(bs);
1664 case SNDCTL_DSP_GETIPTR:
1666 count_info *a = (count_info *)arg;
1668 struct snd_dbuf *bs = rdch->bufsoft;
1671 /* XXX abusive DMA update: chn_rdupdate(rdch); */
1672 a->bytes = sndbuf_gettotal(bs);
1673 a->blocks = sndbuf_getblocks(bs) - rdch->blocks;
1674 a->ptr = sndbuf_getfreeptr(bs);
1675 rdch->blocks = sndbuf_getblocks(bs);
1682 case SNDCTL_DSP_GETOPTR:
1684 count_info *a = (count_info *)arg;
1686 struct snd_dbuf *bs = wrch->bufsoft;
1689 /* XXX abusive DMA update: chn_wrupdate(wrch); */
1690 a->bytes = sndbuf_gettotal(bs);
1691 a->blocks = sndbuf_getblocks(bs) - wrch->blocks;
1692 a->ptr = sndbuf_getreadyptr(bs);
1693 wrch->blocks = sndbuf_getblocks(bs);
1700 case SNDCTL_DSP_GETCAPS:
1702 *arg_i = PCM_CAP_REALTIME | PCM_CAP_MMAP | PCM_CAP_TRIGGER;
1703 if (rdch && wrch && !(dsp_get_flags(i_dev) & SD_F_SIMPLEX))
1704 *arg_i |= PCM_CAP_DUPLEX;
1705 if (rdch && (rdch->flags & CHN_F_VIRTUAL) != 0)
1706 *arg_i |= PCM_CAP_VIRTUAL;
1707 if (wrch && (wrch->flags & CHN_F_VIRTUAL) != 0)
1708 *arg_i |= PCM_CAP_VIRTUAL;
1712 case SOUND_PCM_READ_BITS:
1713 chn = wrch ? wrch : rdch;
1716 if (chn->format & AFMT_8BIT)
1718 else if (chn->format & AFMT_16BIT)
1720 else if (chn->format & AFMT_24BIT)
1722 else if (chn->format & AFMT_32BIT)
1733 case SNDCTL_DSP_SETTRIGGER:
1736 rdch->flags &= ~CHN_F_NOTRIGGER;
1737 if (*arg_i & PCM_ENABLE_INPUT)
1742 rdch->flags |= CHN_F_NOTRIGGER;
1748 wrch->flags &= ~CHN_F_NOTRIGGER;
1749 if (*arg_i & PCM_ENABLE_OUTPUT)
1754 wrch->flags |= CHN_F_NOTRIGGER;
1760 case SNDCTL_DSP_GETTRIGGER:
1764 if (wrch->flags & CHN_F_TRIGGERED)
1765 *arg_i |= PCM_ENABLE_OUTPUT;
1770 if (rdch->flags & CHN_F_TRIGGERED)
1771 *arg_i |= PCM_ENABLE_INPUT;
1776 case SNDCTL_DSP_GETODELAY:
1778 struct snd_dbuf *bs = wrch->bufsoft;
1781 /* XXX abusive DMA update: chn_wrupdate(wrch); */
1782 *arg_i = sndbuf_getready(bs);
1788 case SNDCTL_DSP_POST:
1791 wrch->flags &= ~CHN_F_NOTRIGGER;
1797 case SNDCTL_DSP_SETDUPLEX:
1799 * switch to full-duplex mode if card is in half-duplex
1800 * mode and is able to work in full-duplex mode
1803 if (rdch && wrch && (dsp_get_flags(i_dev) & SD_F_SIMPLEX))
1804 dsp_set_flags(i_dev, dsp_get_flags(i_dev)^SD_F_SIMPLEX);
1809 * The following four ioctls are simple wrappers around mixer_ioctl
1810 * with no further processing. xcmd is short for "translated
1813 case SNDCTL_DSP_GETRECVOL:
1815 xcmd = SOUND_MIXER_READ_RECLEV;
1819 case SNDCTL_DSP_SETRECVOL:
1821 xcmd = SOUND_MIXER_WRITE_RECLEV;
1825 case SNDCTL_DSP_GETPLAYVOL:
1827 xcmd = SOUND_MIXER_READ_PCM;
1831 case SNDCTL_DSP_SETPLAYVOL:
1833 xcmd = SOUND_MIXER_WRITE_PCM;
1837 ret = dsp_ioctl_channel(i_dev, chn, xcmd, arg);
1843 if (d->mixer_dev != NULL) {
1844 PCM_ACQUIRE_QUICK(d);
1845 ret = mixer_ioctl_cmd(d->mixer_dev, xcmd, arg, -1, td,
1847 PCM_RELEASE_QUICK(d);
1853 case SNDCTL_DSP_GET_RECSRC_NAMES:
1854 case SNDCTL_DSP_GET_RECSRC:
1855 case SNDCTL_DSP_SET_RECSRC:
1856 if (d->mixer_dev != NULL) {
1857 PCM_ACQUIRE_QUICK(d);
1858 ret = mixer_ioctl_cmd(d->mixer_dev, cmd, arg, -1, td,
1860 PCM_RELEASE_QUICK(d);
1866 * The following 3 ioctls aren't very useful at the moment. For
1867 * now, only a single channel is associated with a cdev (/dev/dspN
1868 * instance), so there's only a single output routing to use (i.e.,
1869 * the wrch bound to this cdev).
1871 case SNDCTL_DSP_GET_PLAYTGT_NAMES:
1873 oss_mixer_enuminfo *ei;
1874 ei = (oss_mixer_enuminfo *)arg;
1877 ei->version = 0; /* static for now */
1878 ei->strindex[0] = 0;
1882 strlcpy(ei->strings, wrch->name,
1883 sizeof(ei->strings));
1886 ei->strings[0] = '\0';
1890 case SNDCTL_DSP_GET_PLAYTGT:
1891 case SNDCTL_DSP_SET_PLAYTGT: /* yes, they are the same for now */
1894 * OSSv4: "The value that was accepted by the device will
1895 * be returned back in the variable pointed by the
1904 case SNDCTL_DSP_SILENCE:
1906 * Flush the software (pre-feed) buffer, but try to minimize playback
1907 * interruption. (I.e., record unplayed samples with intent to
1908 * restore by SNDCTL_DSP_SKIP.) Intended for application "pause"
1914 struct snd_dbuf *bs;
1916 while (wrch->inprog != 0)
1917 cv_wait(&wrch->cv, wrch->lock);
1919 if ((bs->shadbuf != NULL) && (sndbuf_getready(bs) > 0)) {
1920 bs->sl = sndbuf_getready(bs);
1921 sndbuf_dispose(bs, bs->shadbuf, sndbuf_getready(bs));
1922 sndbuf_fillsilence(bs);
1929 case SNDCTL_DSP_SKIP:
1931 * OSSv4 docs: "This ioctl call discards all unplayed samples in the
1932 * playback buffer by moving the current write position immediately
1933 * before the point where the device is currently reading the samples."
1938 struct snd_dbuf *bs;
1940 while (wrch->inprog != 0)
1941 cv_wait(&wrch->cv, wrch->lock);
1943 if ((bs->shadbuf != NULL) && (bs->sl > 0)) {
1944 sndbuf_softreset(bs);
1945 sndbuf_acquire(bs, bs->shadbuf, bs->sl);
1953 case SNDCTL_DSP_CURRENT_OPTR:
1954 case SNDCTL_DSP_CURRENT_IPTR:
1956 * @note Changing formats resets the buffer counters, which differs
1957 * from the 4Front drivers. However, I don't expect this to be
1958 * much of a problem.
1960 * @note In a test where @c CURRENT_OPTR is called immediately after write
1961 * returns, this driver is about 32K samples behind whereas
1962 * 4Front's is about 8K samples behind. Should determine source
1963 * of discrepancy, even if only out of curiosity.
1965 * @todo Actually test SNDCTL_DSP_CURRENT_IPTR.
1967 chn = (cmd == SNDCTL_DSP_CURRENT_OPTR) ? wrch : rdch;
1971 struct snd_dbuf *bs;
1974 oss_count_t *oc = (oss_count_t *)arg;
1979 tmp = (sndbuf_getsize(b) + chn_getptr(chn) - sndbuf_gethwptr(b)) % sndbuf_getsize(b);
1980 oc->samples = (sndbuf_gettotal(b) + tmp) / sndbuf_getalign(b);
1981 oc->fifo_samples = (sndbuf_getready(b) - tmp) / sndbuf_getalign(b);
1983 oc->samples = sndbuf_gettotal(bs) / sndbuf_getalign(bs);
1984 oc->fifo_samples = sndbuf_getready(bs) / sndbuf_getalign(bs);
1990 case SNDCTL_DSP_HALT_OUTPUT:
1991 case SNDCTL_DSP_HALT_INPUT:
1992 chn = (cmd == SNDCTL_DSP_HALT_OUTPUT) ? wrch : rdch;
2002 case SNDCTL_DSP_LOW_WATER:
2004 * Set the number of bytes required to attract attention by
2009 wrch->lw = (*arg_i > 1) ? *arg_i : 1;
2014 rdch->lw = (*arg_i > 1) ? *arg_i : 1;
2019 case SNDCTL_DSP_GETERROR:
2021 * OSSv4 docs: "All errors and counters will automatically be
2022 * cleared to zeroes after the call so each call will return only
2023 * the errors that occurred after the previous invocation. ... The
2024 * play_underruns and rec_overrun fields are the only useful fields
2025 * returned by OSS 4.0."
2028 audio_errinfo *ei = (audio_errinfo *)arg;
2030 bzero((void *)ei, sizeof(*ei));
2034 ei->play_underruns = wrch->xruns;
2040 ei->rec_overruns = rdch->xruns;
2047 case SNDCTL_DSP_SYNCGROUP:
2048 PCM_ACQUIRE_QUICK(d);
2049 ret = dsp_oss_syncgroup(wrch, rdch, (oss_syncgroup *)arg);
2050 PCM_RELEASE_QUICK(d);
2053 case SNDCTL_DSP_SYNCSTART:
2054 PCM_ACQUIRE_QUICK(d);
2055 ret = dsp_oss_syncstart(*arg_i);
2056 PCM_RELEASE_QUICK(d);
2059 case SNDCTL_DSP_POLICY:
2060 PCM_ACQUIRE_QUICK(d);
2061 ret = dsp_oss_policy(wrch, rdch, *arg_i);
2062 PCM_RELEASE_QUICK(d);
2065 case SNDCTL_DSP_COOKEDMODE:
2066 PCM_ACQUIRE_QUICK(d);
2067 if (!(dsp_get_flags(i_dev) & SD_F_BITPERFECT))
2068 ret = dsp_oss_cookedmode(wrch, rdch, *arg_i);
2069 PCM_RELEASE_QUICK(d);
2071 case SNDCTL_DSP_GET_CHNORDER:
2072 PCM_ACQUIRE_QUICK(d);
2073 ret = dsp_oss_getchnorder(wrch, rdch, (unsigned long long *)arg);
2074 PCM_RELEASE_QUICK(d);
2076 case SNDCTL_DSP_SET_CHNORDER:
2077 PCM_ACQUIRE_QUICK(d);
2078 ret = dsp_oss_setchnorder(wrch, rdch, (unsigned long long *)arg);
2079 PCM_RELEASE_QUICK(d);
2081 case SNDCTL_DSP_GETCHANNELMASK: /* XXX vlc */
2082 PCM_ACQUIRE_QUICK(d);
2083 ret = dsp_oss_getchannelmask(wrch, rdch, (int *)arg);
2084 PCM_RELEASE_QUICK(d);
2086 case SNDCTL_DSP_BIND_CHANNEL: /* XXX what?!? */
2089 #ifdef OSSV4_EXPERIMENT
2091 * XXX The following ioctls are not yet supported and just return
2094 case SNDCTL_DSP_GETOPEAKS:
2095 case SNDCTL_DSP_GETIPEAKS:
2096 chn = (cmd == SNDCTL_DSP_GETOPEAKS) ? wrch : rdch;
2100 oss_peaks_t *op = (oss_peaks_t *)arg;
2104 ret = chn_getpeaks(chn, &lpeak, &rpeak);
2116 * XXX Once implemented, revisit this for proper cv protection
2119 case SNDCTL_GETLABEL:
2120 ret = dsp_oss_getlabel(wrch, rdch, (oss_label_t *)arg);
2122 case SNDCTL_SETLABEL:
2123 ret = dsp_oss_setlabel(wrch, rdch, (oss_label_t *)arg);
2125 case SNDCTL_GETSONG:
2126 ret = dsp_oss_getsong(wrch, rdch, (oss_longname_t *)arg);
2128 case SNDCTL_SETSONG:
2129 ret = dsp_oss_setsong(wrch, rdch, (oss_longname_t *)arg);
2131 case SNDCTL_SETNAME:
2132 ret = dsp_oss_setname(wrch, rdch, (oss_longname_t *)arg);
2136 * @note The S/PDIF interface ioctls, @c SNDCTL_DSP_READCTL and
2137 * @c SNDCTL_DSP_WRITECTL have been omitted at the suggestion of
2138 * 4Front Technologies.
2140 case SNDCTL_DSP_READCTL:
2141 case SNDCTL_DSP_WRITECTL:
2144 #endif /* !0 (explicitly omitted ioctls) */
2146 #endif /* !OSSV4_EXPERIMENT */
2147 case SNDCTL_DSP_MAPINBUF:
2148 case SNDCTL_DSP_MAPOUTBUF:
2149 case SNDCTL_DSP_SETSYNCRO:
2152 case SNDCTL_DSP_SUBDIVIDE:
2153 case SOUND_PCM_WRITE_FILTER:
2154 case SOUND_PCM_READ_FILTER:
2155 /* dunno what these do, don't sound important */
2158 DEB(printf("default ioctl fn 0x%08lx fail\n", cmd));
2169 dsp_poll(struct cdev *i_dev, int events, struct thread *td)
2171 struct snddev_info *d;
2172 struct pcm_channel *wrch, *rdch;
2175 d = dsp_get_info(i_dev);
2176 if (PCM_DETACHING(d) || !DSP_REGISTERED(d, i_dev)) {
2177 /* XXX many clients don't understand POLLNVAL */
2178 return (events & (POLLHUP | POLLPRI | POLLIN |
2179 POLLRDNORM | POLLOUT | POLLWRNORM));
2187 getchns(i_dev, &rdch, &wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2189 if (wrch != NULL && !(wrch->flags & CHN_F_DEAD)) {
2190 e = (events & (POLLOUT | POLLWRNORM));
2192 ret |= chn_poll(wrch, e, td);
2195 if (rdch != NULL && !(rdch->flags & CHN_F_DEAD)) {
2196 e = (events & (POLLIN | POLLRDNORM));
2198 ret |= chn_poll(rdch, e, td);
2201 relchns(i_dev, rdch, wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2209 dsp_mmap(struct cdev *i_dev, vm_ooffset_t offset, vm_paddr_t *paddr,
2210 int nprot, vm_memattr_t *memattr)
2214 * offset is in range due to checks in dsp_mmap_single().
2215 * XXX memattr is not honored.
2217 *paddr = vtophys(offset);
2222 dsp_mmap_single(struct cdev *i_dev, vm_ooffset_t *offset,
2223 vm_size_t size, struct vm_object **object, int nprot)
2225 struct snddev_info *d;
2226 struct pcm_channel *wrch, *rdch, *c;
2229 * Reject PROT_EXEC by default. It just doesn't makes sense.
2230 * Unfortunately, we have to give up this one due to linux_mmap
2233 * https://lists.freebsd.org/pipermail/freebsd-emulation/2007-June/003698.html
2237 if ((nprot & PROT_EXEC) && (dsp_mmap_allow_prot_exec < 0 ||
2238 (dsp_mmap_allow_prot_exec == 0 &&
2239 SV_CURPROC_ABI() != SV_ABI_LINUX)))
2241 if ((nprot & PROT_EXEC) && dsp_mmap_allow_prot_exec < 1)
2246 * PROT_READ (alone) selects the input buffer.
2247 * PROT_WRITE (alone) selects the output buffer.
2248 * PROT_WRITE|PROT_READ together select the output buffer.
2250 if ((nprot & (PROT_READ | PROT_WRITE)) == 0)
2253 d = dsp_get_info(i_dev);
2254 if (PCM_DETACHING(d) || !DSP_REGISTERED(d, i_dev))
2259 getchns(i_dev, &rdch, &wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2261 c = ((nprot & PROT_WRITE) != 0) ? wrch : rdch;
2262 if (c == NULL || (c->flags & CHN_F_MMAP_INVALID) ||
2263 (*offset + size) > sndbuf_getsize(c->bufsoft) ||
2264 (wrch != NULL && (wrch->flags & CHN_F_MMAP_INVALID)) ||
2265 (rdch != NULL && (rdch->flags & CHN_F_MMAP_INVALID))) {
2266 relchns(i_dev, rdch, wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2272 wrch->flags |= CHN_F_MMAP;
2274 rdch->flags |= CHN_F_MMAP;
2276 *offset = (uintptr_t)sndbuf_getbufofs(c->bufsoft, *offset);
2277 relchns(i_dev, rdch, wrch, SD_F_PRIO_RD | SD_F_PRIO_WR);
2278 *object = vm_pager_allocate(OBJT_DEVICE, i_dev,
2279 size, nprot, *offset, curthread->td_ucred);
2283 if (*object == NULL)
2288 /* So much for dev_stdclone() */
2290 dsp_stdclone(char *name, char *namep, char *sep, int use_sep, int *u, int *c)
2294 len = strlen(namep);
2296 if (bcmp(name, namep, len) != 0)
2301 if (isdigit(*name) == 0)
2306 if (*name == '0' && !(name[1] == '\0' || bcmp(name + 1, sep, len) == 0))
2309 for (*u = 0; isdigit(*name) != 0; name++) {
2317 return ((use_sep == 0) ? 0 : ENODEV);
2319 if (bcmp(name, sep, len) != 0 || isdigit(name[len]) == 0)
2324 if (*name == '0' && name[1] != '\0')
2327 for (*c = 0; isdigit(*name) != 0; name++) {
2341 dsp_clone(void *arg,
2343 char *name, int namelen, struct cdev **dev)
2345 struct snddev_info *d;
2346 struct snd_clone_entry *ce;
2347 struct pcm_channel *c;
2348 int i, unit, udcmask, cunit, devtype, devhw, devcmax, tumax;
2349 char *devname, *devcmp, *devsep;
2351 KASSERT(dsp_umax >= 0 && dsp_cmax >= 0, ("Uninitialized unit!"));
2365 for (i = 0; unit == -1 &&
2366 i < (sizeof(dsp_cdevs) / sizeof(dsp_cdevs[0])); i++) {
2367 devtype = dsp_cdevs[i].type;
2368 devcmp = dsp_cdevs[i].name;
2369 devsep = dsp_cdevs[i].sep;
2370 devname = dsp_cdevs[i].alias;
2371 if (devname == NULL)
2373 devhw = dsp_cdevs[i].hw;
2374 devcmax = dsp_cdevs[i].max - 1;
2375 if (strcmp(name, devcmp) == 0) {
2376 if (dsp_basename_clone != 0)
2378 } else if (dsp_stdclone(name, devcmp, devsep,
2379 dsp_cdevs[i].use_sep, &unit, &cunit) != 0) {
2385 d = devclass_get_softc(pcm_devclass, unit);
2386 if (!PCM_REGISTERED(d) || d->clones == NULL)
2389 /* XXX Need Giant magic entry ??? */
2392 if (snd_clone_disabled(d->clones)) {
2401 udcmask = snd_u2unit(unit) | snd_d2unit(devtype);
2404 KASSERT(devcmax <= dsp_cmax,
2405 ("overflow: devcmax=%d, dsp_cmax=%d", devcmax, dsp_cmax));
2406 if (cunit > devcmax) {
2407 PCM_RELEASE_QUICK(d);
2410 udcmask |= snd_c2unit(cunit);
2411 CHN_FOREACH(c, d, channels.pcm) {
2413 if (c->unit != udcmask) {
2418 udcmask &= ~snd_c2unit(cunit);
2420 * Temporarily increase clone maxunit to overcome
2421 * vchan flexibility.
2423 * # sysctl dev.pcm.0.play.vchans=256
2424 * dev.pcm.0.play.vchans: 1 -> 256
2425 * # cat /dev/zero > /dev/dsp0.vp255 &
2427 * # sysctl dev.pcm.0.play.vchans=0
2428 * dev.pcm.0.play.vchans: 256 -> 1
2430 * [1] + running cat /dev/zero > /dev/dsp0.vp255
2432 * # cat /dev/zero > /dev/dsp0.vp255
2433 * zsh: operation not supported: /dev/dsp0.vp255
2435 tumax = snd_clone_getmaxunit(d->clones);
2437 snd_clone_setmaxunit(d->clones, cunit);
2440 goto dsp_clone_alloc;
2443 * Ok, so we're requesting unallocated vchan, but still
2444 * within maximum vchan limit.
2446 if (((devtype == SND_DEV_DSPHW_VPLAY && d->pvchancount > 0) ||
2447 (devtype == SND_DEV_DSPHW_VREC && d->rvchancount > 0)) &&
2448 cunit < snd_maxautovchans) {
2449 udcmask &= ~snd_c2unit(cunit);
2450 tumax = snd_clone_getmaxunit(d->clones);
2452 snd_clone_setmaxunit(d->clones, cunit);
2455 goto dsp_clone_alloc;
2457 PCM_RELEASE_QUICK(d);
2462 ce = snd_clone_alloc(d->clones, dev, &cunit, udcmask);
2464 snd_clone_setmaxunit(d->clones, tumax);
2466 udcmask |= snd_c2unit(cunit);
2467 *dev = make_dev(&dsp_cdevsw, PCMMINOR(udcmask),
2468 UID_ROOT, GID_WHEEL, 0666, "%s%d%s%d",
2469 devname, unit, devsep, cunit);
2470 snd_clone_register(ce, *dev);
2473 PCM_RELEASE_QUICK(d);
2480 dsp_sysinit(void *p)
2482 if (dsp_ehtag != NULL)
2484 /* initialize unit numbering */
2486 dsp_umax = PCMMAXUNIT;
2487 dsp_cmax = PCMMAXCHAN;
2488 dsp_ehtag = EVENTHANDLER_REGISTER(dev_clone, dsp_clone, 0, 1000);
2492 dsp_sysuninit(void *p)
2494 if (dsp_ehtag == NULL)
2496 EVENTHANDLER_DEREGISTER(dev_clone, dsp_ehtag);
2500 SYSINIT(dsp_sysinit, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, dsp_sysinit, NULL);
2501 SYSUNINIT(dsp_sysuninit, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, dsp_sysuninit, NULL);
2504 dsp_unit2name(char *buf, size_t len, int unit)
2508 KASSERT(buf != NULL && len != 0,
2509 ("bogus buf=%p len=%ju", buf, (uintmax_t)len));
2511 dtype = snd_unit2d(unit);
2513 for (i = 0; i < (sizeof(dsp_cdevs) / sizeof(dsp_cdevs[0])); i++) {
2514 if (dtype != dsp_cdevs[i].type || dsp_cdevs[i].alias != NULL)
2516 snprintf(buf, len, "%s%d%s%d", dsp_cdevs[i].name,
2517 snd_unit2u(unit), dsp_cdevs[i].sep, snd_unit2c(unit));
2525 * @brief Handler for SNDCTL_AUDIOINFO.
2527 * Gathers information about the audio device specified in ai->dev. If
2528 * ai->dev == -1, then this function gathers information about the current
2529 * device. If the call comes in on a non-audio device and ai->dev == -1,
2532 * This routine is supposed to go practically straight to the hardware,
2533 * getting capabilities directly from the sound card driver, side-stepping
2534 * the intermediate channel interface.
2536 * Note, however, that the usefulness of this command is significantly
2537 * decreased when requesting info about any device other than the one serving
2538 * the request. While each snddev_channel refers to a specific device node,
2539 * the converse is *not* true. Currently, when a sound device node is opened,
2540 * the sound subsystem scans for an available audio channel (or channels, if
2541 * opened in read+write) and then assigns them to the si_drv[12] private
2542 * data fields. As a result, any information returned linking a channel to
2543 * a specific character device isn't necessarily accurate.
2546 * Calling threads must not hold any snddev_info or pcm_channel locks.
2548 * @param dev device on which the ioctl was issued
2549 * @param ai ioctl request data container
2552 * @retval EINVAL ai->dev specifies an invalid device
2554 * @todo Verify correctness of Doxygen tags. ;)
2557 dsp_oss_audioinfo(struct cdev *i_dev, oss_audioinfo *ai)
2559 struct pcmchan_caps *caps;
2560 struct pcm_channel *ch;
2561 struct snddev_info *d;
2563 int i, nchan, *rates, minch, maxch;
2564 char *devname, buf[CHN_NAMELEN];
2567 * If probing the device that received the ioctl, make sure it's a
2568 * DSP device. (Users may use this ioctl with /dev/mixer and
2571 if (ai->dev == -1 && i_dev->si_devsw != &dsp_cdevsw)
2577 bzero(buf, sizeof(buf));
2580 * Search for the requested audio device (channel). Start by
2581 * iterating over pcm devices.
2583 for (i = 0; pcm_devclass != NULL &&
2584 i < devclass_get_maxunit(pcm_devclass); i++) {
2585 d = devclass_get_softc(pcm_devclass, i);
2586 if (!PCM_REGISTERED(d))
2589 /* XXX Need Giant magic entry ??? */
2591 /* See the note in function docblock */
2592 PCM_UNLOCKASSERT(d);
2595 CHN_FOREACH(ch, d, channels.pcm) {
2596 CHN_UNLOCKASSERT(ch);
2598 if (ai->dev == -1) {
2599 if (DSP_REGISTERED(d, i_dev) &&
2600 (ch == PCM_RDCH(i_dev) || /* record ch */
2601 ch == PCM_WRCH(i_dev))) { /* playback ch */
2602 devname = dsp_unit2name(buf,
2603 sizeof(buf), ch->unit);
2605 } else if (ai->dev == nchan) {
2606 devname = dsp_unit2name(buf, sizeof(buf),
2609 if (devname != NULL)
2615 if (devname != NULL) {
2617 * At this point, the following synchronization stuff
2619 * - a specific PCM device is locked.
2620 * - a specific audio channel has been locked, so be
2621 * sure to unlock when exiting;
2624 caps = chn_getcaps(ch);
2627 * With all handles collected, zero out the user's
2628 * container and begin filling in its fields.
2630 bzero((void *)ai, sizeof(oss_audioinfo));
2633 strlcpy(ai->name, ch->name, sizeof(ai->name));
2635 if ((ch->flags & CHN_F_BUSY) == 0)
2638 ai->busy = (ch->direction == PCMDIR_PLAY) ? OPEN_WRITE : OPEN_READ;
2642 * @c cmd - OSSv4 docs: "Only supported under Linux at
2643 * this moment." Cop-out, I know, but I'll save
2644 * running around in the process table for later.
2645 * Is there a risk of leaking information?
2650 * These flags stolen from SNDCTL_DSP_GETCAPS handler.
2651 * Note, however, that a single channel operates in
2652 * only one direction, so PCM_CAP_DUPLEX is out.
2655 * @todo @c SNDCTL_AUDIOINFO::caps - Make drivers keep
2656 * these in pcmchan::caps?
2658 ai->caps = PCM_CAP_REALTIME | PCM_CAP_MMAP | PCM_CAP_TRIGGER |
2659 ((ch->flags & CHN_F_VIRTUAL) ? PCM_CAP_VIRTUAL : 0) |
2660 ((ch->direction == PCMDIR_PLAY) ? PCM_CAP_OUTPUT : PCM_CAP_INPUT);
2663 * Collect formats supported @b natively by the
2664 * device. Also determine min/max channels. (I.e.,
2665 * mono, stereo, or both?)
2667 * If any channel is stereo, maxch = 2;
2668 * if all channels are stereo, minch = 2, too;
2669 * if any channel is mono, minch = 1;
2670 * and if all channels are mono, maxch = 1.
2675 for (i = 0; caps->fmtlist[i]; i++) {
2676 fmts |= caps->fmtlist[i];
2677 if (AFMT_CHANNEL(caps->fmtlist[i]) > 1) {
2678 minch = (minch == 0) ? 2 : minch;
2682 maxch = (maxch == 0) ? 1 : maxch;
2686 if (ch->direction == PCMDIR_PLAY)
2687 ai->oformats = fmts;
2689 ai->iformats = fmts;
2693 * @c magic - OSSv4 docs: "Reserved for internal use
2697 * @c card_number - OSSv4 docs: "Number of the sound
2698 * card where this device belongs or -1 if this
2699 * information is not available. Applications
2700 * should normally not use this field for any
2703 ai->card_number = -1;
2705 * @todo @c song_name - depends first on
2706 * SNDCTL_[GS]ETSONG @todo @c label - depends
2707 * on SNDCTL_[GS]ETLABEL
2708 * @todo @c port_number - routing information?
2710 ai->port_number = -1;
2711 ai->mixer_dev = (d->mixer_dev != NULL) ? PCMUNIT(d->mixer_dev) : -1;
2714 * @c real_device - OSSv4 docs: "Obsolete."
2716 ai->real_device = -1;
2717 strlcpy(ai->devnode, "/dev/", sizeof(ai->devnode));
2718 strlcat(ai->devnode, devname, sizeof(ai->devnode));
2719 ai->enabled = device_is_attached(d->dev) ? 1 : 0;
2722 * @c flags - OSSv4 docs: "Reserved for future use."
2725 * @c binding - OSSv4 docs: "Reserved for future use."
2727 * @todo @c handle - haven't decided how to generate
2728 * this yet; bus, vendor, device IDs?
2730 ai->min_rate = caps->minspeed;
2731 ai->max_rate = caps->maxspeed;
2733 ai->min_channels = minch;
2734 ai->max_channels = maxch;
2736 ai->nrates = chn_getrates(ch, &rates);
2737 if (ai->nrates > OSS_MAX_SAMPLE_RATES)
2738 ai->nrates = OSS_MAX_SAMPLE_RATES;
2740 for (i = 0; i < ai->nrates; i++)
2741 ai->rates[i] = rates[i];
2743 ai->next_play_engine = 0;
2744 ai->next_rec_engine = 0;
2751 if (devname != NULL)
2755 /* Exhausted the search -- nothing is locked, so return. */
2760 * @brief Assigns a PCM channel to a sync group.
2762 * Sync groups are used to enable audio operations on multiple devices
2763 * simultaneously. They may be used with any number of devices and may
2764 * span across applications. Devices are added to groups with
2765 * the SNDCTL_DSP_SYNCGROUP ioctl, and operations are triggered with the
2766 * SNDCTL_DSP_SYNCSTART ioctl.
2768 * If the @c id field of the @c group parameter is set to zero, then a new
2769 * sync group is created. Otherwise, wrch and rdch (if set) are added to
2770 * the group specified.
2772 * @todo As far as memory allocation, should we assume that things are
2773 * okay and allocate with M_WAITOK before acquiring channel locks,
2774 * freeing later if not?
2776 * @param wrch output channel associated w/ device (if any)
2777 * @param rdch input channel associated w/ device (if any)
2778 * @param group Sync group parameters
2781 * @retval non-zero error to be propagated upstream
2784 dsp_oss_syncgroup(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_syncgroup *group)
2786 struct pcmchan_syncmember *smrd, *smwr;
2787 struct pcmchan_syncgroup *sg;
2796 * Free_unr() may sleep, so store released syncgroup IDs until after
2797 * all locks are released.
2799 sg_ids[0] = sg_ids[1] = sg_ids[2] = 0;
2804 * - Insert channel(s) into group's member list.
2805 * - Set CHN_F_NOTRIGGER on channel(s).
2806 * - Stop channel(s).
2810 * If device's channels are already mapped to a group, unmap them.
2814 sg_ids[0] = chn_syncdestroy(wrch);
2819 sg_ids[1] = chn_syncdestroy(rdch);
2823 * Verify that mode matches character device properites.
2824 * - Bail if PCM_ENABLE_OUTPUT && wrch == NULL.
2825 * - Bail if PCM_ENABLE_INPUT && rdch == NULL.
2827 if (((wrch == NULL) && (group->mode & PCM_ENABLE_OUTPUT)) ||
2828 ((rdch == NULL) && (group->mode & PCM_ENABLE_INPUT))) {
2834 * An id of zero indicates the user wants to create a new
2837 if (group->id == 0) {
2838 sg = (struct pcmchan_syncgroup *)malloc(sizeof(*sg), M_DEVBUF, M_NOWAIT);
2840 SLIST_INIT(&sg->members);
2841 sg->id = alloc_unr(pcmsg_unrhdr);
2844 SLIST_INSERT_HEAD(&snd_pcm_syncgroups, sg, link);
2848 SLIST_FOREACH(sg, &snd_pcm_syncgroups, link) {
2849 if (sg->id == group->id)
2856 /* Couldn't create or find a syncgroup. Fail. */
2861 * Allocate a syncmember, assign it and a channel together, and
2862 * insert into syncgroup.
2864 if (group->mode & PCM_ENABLE_INPUT) {
2865 smrd = (struct pcmchan_syncmember *)malloc(sizeof(*smrd), M_DEVBUF, M_NOWAIT);
2871 SLIST_INSERT_HEAD(&sg->members, smrd, link);
2876 rdch->flags |= CHN_F_NOTRIGGER;
2880 if (group->mode & PCM_ENABLE_OUTPUT) {
2881 smwr = (struct pcmchan_syncmember *)malloc(sizeof(*smwr), M_DEVBUF, M_NOWAIT);
2887 SLIST_INSERT_HEAD(&sg->members, smwr, link);
2892 wrch->flags |= CHN_F_NOTRIGGER;
2899 free(smrd, M_DEVBUF);
2900 if ((sg != NULL) && SLIST_EMPTY(&sg->members)) {
2902 SLIST_REMOVE(&snd_pcm_syncgroups, sg, pcmchan_syncgroup, link);
2920 free_unr(pcmsg_unrhdr, sg_ids[0]);
2922 free_unr(pcmsg_unrhdr, sg_ids[1]);
2924 free_unr(pcmsg_unrhdr, sg_ids[2]);
2930 * @brief Launch a sync group into action
2932 * Sync groups are established via SNDCTL_DSP_SYNCGROUP. This function
2933 * iterates over all members, triggering them along the way.
2935 * @note Caller must not hold any channel locks.
2937 * @param sg_id sync group identifier
2940 * @retval non-zero error worthy of propagating upstream to user
2943 dsp_oss_syncstart(int sg_id)
2945 struct pcmchan_syncmember *sm, *sm_tmp;
2946 struct pcmchan_syncgroup *sg;
2947 struct pcm_channel *c;
2950 /* Get the synclists lock */
2957 /* Search for syncgroup by ID */
2958 SLIST_FOREACH(sg, &snd_pcm_syncgroups, link) {
2959 if (sg->id == sg_id)
2963 /* Return EINVAL if not found */
2969 /* Any removals resulting in an empty group should've handled this */
2970 KASSERT(!SLIST_EMPTY(&sg->members), ("found empty syncgroup"));
2973 * Attempt to lock all member channels - if any are already
2974 * locked, unlock those acquired, sleep for a bit, and try
2977 SLIST_FOREACH(sm, &sg->members, link) {
2978 if (CHN_TRYLOCK(sm->ch) == 0) {
2979 int timo = hz * 5/1000;
2983 /* Release all locked channels so far, retry */
2984 SLIST_FOREACH(sm_tmp, &sg->members, link) {
2985 /* sm is the member already locked */
2988 CHN_UNLOCK(sm_tmp->ch);
2991 /** @todo Is PRIBIO correct/ */
2992 ret = msleep(sm, &snd_pcm_syncgroups_mtx,
2993 PRIBIO | PCATCH, "pcmsg", timo);
2994 if (ret == EINTR || ret == ERESTART)
2998 ret = 0; /* Assumes ret == EAGAIN... */
3001 } while (needlocks && ret == 0);
3003 /* Proceed only if no errors encountered. */
3005 /* Launch channels */
3006 while ((sm = SLIST_FIRST(&sg->members)) != NULL) {
3007 SLIST_REMOVE_HEAD(&sg->members, link);
3012 c->flags &= ~CHN_F_NOTRIGGER;
3018 SLIST_REMOVE(&snd_pcm_syncgroups, sg, pcmchan_syncgroup, link);
3025 * Free_unr() may sleep, so be sure to give up the syncgroup lock
3029 free_unr(pcmsg_unrhdr, sg_id);
3035 * @brief Handler for SNDCTL_DSP_POLICY
3037 * The SNDCTL_DSP_POLICY ioctl is a simpler interface to control fragment
3038 * size and count like with SNDCTL_DSP_SETFRAGMENT. Instead of the user
3039 * specifying those two parameters, s/he simply selects a number from 0..10
3040 * which corresponds to a buffer size. Smaller numbers request smaller
3041 * buffers with lower latencies (at greater overhead from more frequent
3042 * interrupts), while greater numbers behave in the opposite manner.
3044 * The 4Front spec states that a value of 5 should be the default. However,
3045 * this implementation deviates slightly by using a linear scale without
3046 * consulting drivers. I.e., even though drivers may have different default
3047 * buffer sizes, a policy argument of 5 will have the same result across
3050 * See http://manuals.opensound.com/developer/SNDCTL_DSP_POLICY.html for
3053 * @todo When SNDCTL_DSP_COOKEDMODE is supported, it'll be necessary to
3054 * work with hardware drivers directly.
3056 * @note PCM channel arguments must not be locked by caller.
3058 * @param wrch Pointer to opened playback channel (optional; may be NULL)
3059 * @param rdch " recording channel (optional; may be NULL)
3060 * @param policy Integer from [0:10]
3062 * @retval 0 constant (for now)
3065 dsp_oss_policy(struct pcm_channel *wrch, struct pcm_channel *rdch, int policy)
3069 if (policy < CHN_POLICY_MIN || policy > CHN_POLICY_MAX)
3072 /* Default: success */
3077 ret = chn_setlatency(rdch, policy);
3081 if (wrch && ret == 0) {
3083 ret = chn_setlatency(wrch, policy);
3094 * @brief Enable or disable "cooked" mode
3096 * This is a handler for @c SNDCTL_DSP_COOKEDMODE. When in cooked mode, which
3097 * is the default, the sound system handles rate and format conversions
3098 * automatically (ex: user writing 11025Hz/8 bit/unsigned but card only
3099 * operates with 44100Hz/16bit/signed samples).
3101 * Disabling cooked mode is intended for applications wanting to mmap()
3102 * a sound card's buffer space directly, bypassing the FreeBSD 2-stage
3103 * feeder architecture, presumably to gain as much control over audio
3104 * hardware as possible.
3106 * See @c http://manuals.opensound.com/developer/SNDCTL_DSP_COOKEDMODE.html
3109 * @param wrch playback channel (optional; may be NULL)
3110 * @param rdch recording channel (optional; may be NULL)
3111 * @param enabled 0 = raw mode, 1 = cooked mode
3113 * @retval EINVAL Operation not yet supported.
3116 dsp_oss_cookedmode(struct pcm_channel *wrch, struct pcm_channel *rdch, int enabled)
3120 * XXX I just don't get it. Why don't they call it
3121 * "BITPERFECT" ~ SNDCTL_DSP_BITPERFECT !?!?.
3122 * This is just plain so confusing, incoherent,
3123 * <insert any non-printable characters here>.
3125 if (!(enabled == 1 || enabled == 0))
3129 * I won't give in. I'm inverting its logic here and now.
3130 * Brag all you want, but "BITPERFECT" should be the better
3133 enabled ^= 0x00000001;
3137 wrch->flags &= ~CHN_F_BITPERFECT;
3138 wrch->flags |= (enabled != 0) ? CHN_F_BITPERFECT : 0x00000000;
3144 rdch->flags &= ~CHN_F_BITPERFECT;
3145 rdch->flags |= (enabled != 0) ? CHN_F_BITPERFECT : 0x00000000;
3153 * @brief Retrieve channel interleaving order
3155 * This is the handler for @c SNDCTL_DSP_GET_CHNORDER.
3157 * See @c http://manuals.opensound.com/developer/SNDCTL_DSP_GET_CHNORDER.html
3160 * @note As the ioctl definition is still under construction, FreeBSD
3161 * does not currently support SNDCTL_DSP_GET_CHNORDER.
3163 * @param wrch playback channel (optional; may be NULL)
3164 * @param rdch recording channel (optional; may be NULL)
3165 * @param map channel map (result will be stored there)
3167 * @retval EINVAL Operation not yet supported.
3170 dsp_oss_getchnorder(struct pcm_channel *wrch, struct pcm_channel *rdch, unsigned long long *map)
3172 struct pcm_channel *ch;
3175 ch = (wrch != NULL) ? wrch : rdch;
3178 ret = chn_oss_getorder(ch, map);
3187 * @brief Specify channel interleaving order
3189 * This is the handler for @c SNDCTL_DSP_SET_CHNORDER.
3191 * @note As the ioctl definition is still under construction, FreeBSD
3192 * does not currently support @c SNDCTL_DSP_SET_CHNORDER.
3194 * @param wrch playback channel (optional; may be NULL)
3195 * @param rdch recording channel (optional; may be NULL)
3196 * @param map channel map
3198 * @retval EINVAL Operation not yet supported.
3201 dsp_oss_setchnorder(struct pcm_channel *wrch, struct pcm_channel *rdch, unsigned long long *map)
3209 ret = chn_oss_setorder(wrch, map);
3213 if (ret == 0 && rdch != NULL) {
3215 ret = chn_oss_setorder(rdch, map);
3223 dsp_oss_getchannelmask(struct pcm_channel *wrch, struct pcm_channel *rdch,
3226 struct pcm_channel *ch;
3231 ch = (wrch != NULL) ? wrch : rdch;
3235 ret = chn_oss_getmask(ch, &chnmask);
3246 #ifdef OSSV4_EXPERIMENT
3248 * @brief Retrieve an audio device's label
3250 * This is a handler for the @c SNDCTL_GETLABEL ioctl.
3252 * See @c http://manuals.opensound.com/developer/SNDCTL_GETLABEL.html
3255 * From Hannu@4Front: "For example ossxmix (just like some HW mixer
3256 * consoles) can show variable "labels" for certain controls. By default
3257 * the application name (say quake) is shown as the label but
3258 * applications may change the labels themselves."
3260 * @note As the ioctl definition is still under construction, FreeBSD
3261 * does not currently support @c SNDCTL_GETLABEL.
3263 * @param wrch playback channel (optional; may be NULL)
3264 * @param rdch recording channel (optional; may be NULL)
3265 * @param label label gets copied here
3267 * @retval EINVAL Operation not yet supported.
3270 dsp_oss_getlabel(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_label_t *label)
3276 * @brief Specify an audio device's label
3278 * This is a handler for the @c SNDCTL_SETLABEL ioctl. Please see the
3279 * comments for @c dsp_oss_getlabel immediately above.
3281 * See @c http://manuals.opensound.com/developer/SNDCTL_GETLABEL.html
3284 * @note As the ioctl definition is still under construction, FreeBSD
3285 * does not currently support SNDCTL_SETLABEL.
3287 * @param wrch playback channel (optional; may be NULL)
3288 * @param rdch recording channel (optional; may be NULL)
3289 * @param label label gets copied from here
3291 * @retval EINVAL Operation not yet supported.
3294 dsp_oss_setlabel(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_label_t *label)
3300 * @brief Retrieve name of currently played song
3302 * This is a handler for the @c SNDCTL_GETSONG ioctl. Audio players could
3303 * tell the system the name of the currently playing song, which would be
3304 * visible in @c /dev/sndstat.
3306 * See @c http://manuals.opensound.com/developer/SNDCTL_GETSONG.html
3309 * @note As the ioctl definition is still under construction, FreeBSD
3310 * does not currently support SNDCTL_GETSONG.
3312 * @param wrch playback channel (optional; may be NULL)
3313 * @param rdch recording channel (optional; may be NULL)
3314 * @param song song name gets copied here
3316 * @retval EINVAL Operation not yet supported.
3319 dsp_oss_getsong(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_longname_t *song)
3325 * @brief Retrieve name of currently played song
3327 * This is a handler for the @c SNDCTL_SETSONG ioctl. Audio players could
3328 * tell the system the name of the currently playing song, which would be
3329 * visible in @c /dev/sndstat.
3331 * See @c http://manuals.opensound.com/developer/SNDCTL_SETSONG.html
3334 * @note As the ioctl definition is still under construction, FreeBSD
3335 * does not currently support SNDCTL_SETSONG.
3337 * @param wrch playback channel (optional; may be NULL)
3338 * @param rdch recording channel (optional; may be NULL)
3339 * @param song song name gets copied from here
3341 * @retval EINVAL Operation not yet supported.
3344 dsp_oss_setsong(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_longname_t *song)
3350 * @brief Rename a device
3352 * This is a handler for the @c SNDCTL_SETNAME ioctl.
3354 * See @c http://manuals.opensound.com/developer/SNDCTL_SETNAME.html for
3357 * From Hannu@4Front: "This call is used to change the device name
3358 * reported in /dev/sndstat and ossinfo. So instead of using some generic
3359 * 'OSS loopback audio (MIDI) driver' the device may be given a meaningfull
3360 * name depending on the current context (for example 'OSS virtual wave table
3361 * synth' or 'VoIP link to London')."
3363 * @note As the ioctl definition is still under construction, FreeBSD
3364 * does not currently support SNDCTL_SETNAME.
3366 * @param wrch playback channel (optional; may be NULL)
3367 * @param rdch recording channel (optional; may be NULL)
3368 * @param name new device name gets copied from here
3370 * @retval EINVAL Operation not yet supported.
3373 dsp_oss_setname(struct pcm_channel *wrch, struct pcm_channel *rdch, oss_longname_t *name)
3377 #endif /* !OSSV4_EXPERIMENT */