xref: /netbsd/sys/dev/pad/pad.c (revision 6550d01e)
1 /* $NetBSD: pad.c,v 1.16 2010/09/03 19:19:48 jmcneill Exp $ */
2 
3 /*-
4  * Copyright (c) 2007 Jared D. McNeill <jmcneill@invisible.ca>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
17  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
18  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
20  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 __KERNEL_RCSID(0, "$NetBSD: pad.c,v 1.16 2010/09/03 19:19:48 jmcneill Exp $");
31 
32 #include <sys/types.h>
33 #include <sys/param.h>
34 #include <sys/conf.h>
35 #include <sys/buf.h>
36 #include <sys/kmem.h>
37 #include <sys/kernel.h>
38 #include <sys/device.h>
39 #include <sys/proc.h>
40 #include <sys/condvar.h>
41 #include <sys/select.h>
42 #include <sys/audioio.h>
43 #include <sys/vnode.h>
44 #include <sys/module.h>
45 
46 #include <dev/audio_if.h>
47 #include <dev/audiovar.h>
48 #include <dev/auconv.h>
49 
50 #include <dev/pad/padvar.h>
51 #include <dev/pad/padvol.h>
52 
53 #define PADUNIT(x)	minor(x)
54 
55 extern struct cfdriver pad_cd;
56 
57 typedef struct pad_block {
58 	uint8_t		*pb_ptr;
59 	int		pb_len;
60 } pad_block_t;
61 
62 enum {
63 	PAD_OUTPUT_CLASS,
64 	PAD_INPUT_CLASS,
65 	PAD_OUTPUT_MASTER_VOLUME,
66 	PAD_INPUT_DAC_VOLUME,
67 	PAD_ENUM_LAST,
68 };
69 
70 static int	pad_match(device_t, cfdata_t, void *);
71 static void	pad_attach(device_t, device_t, void *);
72 static int	pad_detach(device_t, int);
73 static void	pad_childdet(device_t, device_t);
74 
75 static int	pad_query_encoding(void *, struct audio_encoding *);
76 static int	pad_set_params(void *, int, int,
77 				audio_params_t *, audio_params_t *,
78 				stream_filter_list_t *, stream_filter_list_t *);
79 static int	pad_start_output(void *, void *, int,
80 				    void (*)(void *), void *);
81 static int	pad_start_input(void *, void *, int,
82 				   void (*)(void *), void *);
83 static int	pad_halt_output(void *);
84 static int	pad_halt_input(void *);
85 static int	pad_getdev(void *, struct audio_device *);
86 static int	pad_set_port(void *, mixer_ctrl_t *);
87 static int	pad_get_port(void *, mixer_ctrl_t *);
88 static int	pad_query_devinfo(void *, mixer_devinfo_t *);
89 static int	pad_get_props(void *);
90 static int	pad_round_blocksize(void *, int, int, const audio_params_t *);
91 
92 static const struct audio_hw_if pad_hw_if = {
93 	.query_encoding = pad_query_encoding,
94 	.set_params = pad_set_params,
95 	.start_output = pad_start_output,
96 	.start_input = pad_start_input,
97 	.halt_output = pad_halt_output,
98 	.halt_input = pad_halt_input,
99 	.getdev = pad_getdev,
100 	.set_port = pad_set_port,
101 	.get_port = pad_get_port,
102 	.query_devinfo = pad_query_devinfo,
103 	.get_props = pad_get_props,
104 	.round_blocksize = pad_round_blocksize,
105 };
106 
107 #define PAD_NFORMATS	1
108 static const struct audio_format pad_formats[PAD_NFORMATS] = {
109 	{ NULL, AUMODE_PLAY|AUMODE_RECORD, AUDIO_ENCODING_SLINEAR_LE, 16, 16,
110 	  2, AUFMT_STEREO, 1, { 44100 } },
111 };
112 
113 extern void	padattach(int);
114 
115 static int		pad_add_block(pad_softc_t *, uint8_t *, int);
116 static int		pad_get_block(pad_softc_t *, pad_block_t *, int);
117 
118 dev_type_open(pad_open);
119 dev_type_close(pad_close);
120 dev_type_read(pad_read);
121 
122 const struct cdevsw pad_cdevsw = {
123 	.d_open = pad_open,
124 	.d_close = pad_close,
125 	.d_read = pad_read,
126 	.d_write = nowrite,
127 	.d_ioctl = noioctl,
128 	.d_stop = nostop,
129 	.d_tty = notty,
130 	.d_poll = nopoll,
131 	.d_mmap = nommap,
132 	.d_kqfilter = nokqfilter,
133 	.d_flag = D_OTHER,
134 };
135 
136 CFATTACH_DECL2_NEW(pad, sizeof(pad_softc_t), pad_match, pad_attach, pad_detach,
137     NULL, NULL, pad_childdet);
138 
139 void
140 padattach(int n)
141 {
142 	int i, err;
143 	cfdata_t cf;
144 
145 	aprint_debug("pad: requested %d units\n", n);
146 
147 	err = config_cfattach_attach(pad_cd.cd_name, &pad_ca);
148 	if (err) {
149 		aprint_error("%s: couldn't register cfattach: %d\n",
150 		    pad_cd.cd_name, err);
151 		config_cfdriver_detach(&pad_cd);
152 		return;
153 	}
154 
155 	for (i = 0; i < n; i++) {
156 		cf = kmem_alloc(sizeof(struct cfdata), KM_NOSLEEP);
157 		if (cf == NULL) {
158 			aprint_error("%s: couldn't allocate cfdata\n",
159 			    pad_cd.cd_name);
160 			continue;
161 		}
162 		cf->cf_name = pad_cd.cd_name;
163 		cf->cf_atname = pad_cd.cd_name;
164 		cf->cf_unit = i;
165 		cf->cf_fstate = FSTATE_STAR;
166 
167 		(void)config_attach_pseudo(cf);
168 	}
169 
170 	return;
171 }
172 
173 static int
174 pad_add_block(pad_softc_t *sc, uint8_t *blk, int blksize)
175 {
176 	int l;
177 
178 	if (sc->sc_open == 0)
179 		return EIO;
180 
181 	if (sc->sc_buflen + blksize > PAD_BUFSIZE)
182 		return ENOBUFS;
183 
184 	if (sc->sc_wpos + blksize <= PAD_BUFSIZE)
185 		memcpy(sc->sc_audiobuf + sc->sc_wpos, blk, blksize);
186 	else {
187 		l = PAD_BUFSIZE - sc->sc_wpos;
188 		memcpy(sc->sc_audiobuf + sc->sc_wpos, blk, l);
189 		memcpy(sc->sc_audiobuf, blk + l, blksize - l);
190 	}
191 
192 	sc->sc_wpos += blksize;
193 	if (sc->sc_wpos > PAD_BUFSIZE)
194 		sc->sc_wpos -= PAD_BUFSIZE;
195 
196 	sc->sc_buflen += blksize;
197 
198 	return 0;
199 }
200 
201 static int
202 pad_get_block(pad_softc_t *sc, pad_block_t *pb, int blksize)
203 {
204 	int l;
205 
206 	KASSERT(pb != NULL);
207 
208 	if (sc->sc_buflen < blksize)
209 		return ERESTART;
210 
211 	pb->pb_ptr = (sc->sc_audiobuf + sc->sc_rpos);
212 	if (sc->sc_rpos + blksize < PAD_BUFSIZE) {
213 		pb->pb_len = blksize;
214 		sc->sc_rpos += blksize;
215 	} else {
216 		l = PAD_BUFSIZE - sc->sc_rpos;
217 		pb->pb_len = l;
218 		sc->sc_rpos = 0;
219 	}
220 	sc->sc_buflen -= pb->pb_len;
221 
222 	return 0;
223 }
224 
225 static int
226 pad_match(device_t parent, cfdata_t data, void *opaque)
227 {
228 	return 1;
229 }
230 
231 static void
232 pad_childdet(device_t self, device_t child)
233 {
234 	pad_softc_t *sc = device_private(self);
235 
236 	sc->sc_audiodev = NULL;
237 }
238 
239 static void
240 pad_attach(device_t parent, device_t self, void *opaque)
241 {
242 	pad_softc_t *sc = device_private(self);
243 
244 	aprint_normal_dev(self, "outputs: 44100Hz, 16-bit, stereo\n");
245 
246 	sc->sc_dev = self;
247 	sc->sc_open = 0;
248 	if (auconv_create_encodings(pad_formats, PAD_NFORMATS,
249 	    &sc->sc_encodings) != 0) {
250 		aprint_error_dev(self, "couldn't create encodings\n");
251 		return;
252 	}
253 
254 	cv_init(&sc->sc_condvar, device_xname(self));
255 	mutex_init(&sc->sc_mutex, MUTEX_DEFAULT, IPL_SCHED);
256 
257 	sc->sc_swvol = 255;
258 	sc->sc_buflen = 0;
259 	sc->sc_rpos = sc->sc_wpos = 0;
260 	sc->sc_audiodev = (void *)audio_attach_mi(&pad_hw_if, sc, sc->sc_dev);
261 
262 	if (!pmf_device_register(self, NULL, NULL))
263 		aprint_error_dev(self, "couldn't establish power handler\n");
264 
265 	return;
266 }
267 
268 static int
269 pad_detach(device_t self, int flags)
270 {
271 	pad_softc_t *sc = device_private(self);
272 	int cmaj, mn, rc;
273 
274 	cmaj = cdevsw_lookup_major(&pad_cdevsw);
275 	mn = device_unit(self);
276 	vdevgone(cmaj, mn, mn, VCHR);
277 
278 	if ((rc = config_detach_children(self, flags)) != 0)
279 		return rc;
280 
281 	pmf_device_deregister(self);
282 
283 	mutex_destroy(&sc->sc_mutex);
284 	cv_destroy(&sc->sc_condvar);
285 
286 	auconv_delete_encodings(sc->sc_encodings);
287 
288 	return 0;
289 }
290 
291 int
292 pad_open(dev_t dev, int flags, int fmt, struct lwp *l)
293 {
294 	pad_softc_t *sc;
295 
296 	sc = device_lookup_private(&pad_cd, PADUNIT(dev));
297 	if (sc == NULL)
298 		return ENXIO;
299 
300 	if (sc->sc_open++) {
301 		sc->sc_open--;
302 		return EBUSY;
303 	}
304 
305 	return 0;
306 }
307 
308 int
309 pad_close(dev_t dev, int flags, int fmt, struct lwp *l)
310 {
311 	pad_softc_t *sc;
312 
313 	sc = device_lookup_private(&pad_cd, PADUNIT(dev));
314 	if (sc == NULL)
315 		return ENXIO;
316 
317 	KASSERT(sc->sc_open > 0);
318 	sc->sc_open--;
319 
320 	return 0;
321 }
322 
323 int
324 pad_read(dev_t dev, struct uio *uio, int flags)
325 {
326 	pad_softc_t *sc;
327 	pad_block_t pb;
328 	void (*intr)(void *);
329 	void *intrarg;
330 	int err;
331 
332 	sc = device_lookup_private(&pad_cd, PADUNIT(dev));
333 	if (sc == NULL)
334 		return ENXIO;
335 
336 	err = 0;
337 
338 	intr = sc->sc_intr;
339 	intrarg = sc->sc_intrarg;
340 
341 	while (uio->uio_resid > 0 && !err) {
342 		err = pad_get_block(sc, &pb, min(uio->uio_resid, PAD_BLKSIZE));
343 		if (!err)
344 			err = uiomove(pb.pb_ptr, pb.pb_len, uio);
345 		else {
346 			if (intr) {
347 				(*intr)(intrarg);
348 				intr = sc->sc_intr;
349 				intrarg = sc->sc_intrarg;
350 				err = 0;
351 				continue;
352 			}
353 
354 			mutex_enter(&sc->sc_mutex);
355 			err = cv_timedwait_sig(&sc->sc_condvar, &sc->sc_mutex,
356 			    hz/100);
357 			if (err != 0 && err != EWOULDBLOCK) {
358 				mutex_exit(&sc->sc_mutex);
359 				if (err != ERESTART)
360 					aprint_error_dev(sc->sc_dev,
361 					    "cv_timedwait_sig returned %d\n",
362 					    err);
363 				return EINTR;
364 			}
365 			intr = sc->sc_intr;
366 			intrarg = sc->sc_intrarg;
367 			mutex_exit(&sc->sc_mutex);
368 			err = 0;
369 		}
370 	}
371 
372 	if (intr)
373 		(*intr)(intrarg);
374 
375 	return err;
376 }
377 
378 static int
379 pad_query_encoding(void *opaque, struct audio_encoding *ae)
380 {
381 	pad_softc_t *sc;
382 
383 	sc = (pad_softc_t *)opaque;
384 
385 	return auconv_query_encoding(sc->sc_encodings, ae);
386 }
387 
388 static int
389 pad_set_params(void *opaque, int setmode, int usemode,
390     audio_params_t *play, audio_params_t *rec,
391     stream_filter_list_t *pfil, stream_filter_list_t *rfil)
392 {
393 	pad_softc_t *sc;
394 
395 	sc = (pad_softc_t *)opaque;
396 
397 	if (auconv_set_converter(pad_formats, PAD_NFORMATS, AUMODE_PLAY,
398 	    play, true, pfil) < 0)
399 		return EINVAL;
400 	if (auconv_set_converter(pad_formats, PAD_NFORMATS, AUMODE_RECORD,
401 	    rec, true, rfil) < 0)
402 		return EINVAL;
403 
404 	if (pfil->req_size > 0)
405 		play = &pfil->filters[0].param;
406 	switch (play->encoding) {
407 	case AUDIO_ENCODING_SLINEAR_LE:
408 		if (play->precision == 16 && play->validbits == 16)
409 			pfil->prepend(pfil, pad_vol_slinear16_le, play);
410 		break;
411 	case AUDIO_ENCODING_SLINEAR_BE:
412 		if (play->precision == 16 && play->validbits == 16)
413 			pfil->prepend(pfil, pad_vol_slinear16_be, play);
414 		break;
415 	default:
416 		break;
417 	}
418 
419 	return 0;
420 }
421 
422 static int
423 pad_start_output(void *opaque, void *block, int blksize,
424     void (*intr)(void *), void *intrarg)
425 {
426 	pad_softc_t *sc;
427 	int err;
428 
429 	sc = (pad_softc_t *)opaque;
430 
431 	mutex_enter(&sc->sc_mutex);
432 
433 	sc->sc_intr = intr;
434 	sc->sc_intrarg = intrarg;
435 	sc->sc_blksize = blksize;
436 
437 	err = pad_add_block(sc, block, blksize);
438 
439 	cv_signal(&sc->sc_condvar);
440 
441 	mutex_exit(&sc->sc_mutex);
442 
443 	return err;
444 }
445 
446 static int
447 pad_start_input(void *opaque, void *block, int blksize,
448     void (*intr)(void *), void *intrarg)
449 {
450 	return EINVAL;
451 }
452 
453 static int
454 pad_halt_output(void *opaque)
455 {
456 	pad_softc_t *sc;
457 
458 	sc = (pad_softc_t *)opaque;
459 	sc->sc_intr = NULL;
460 	sc->sc_intrarg = NULL;
461 	sc->sc_buflen = 0;
462 	sc->sc_rpos = sc->sc_wpos = 0;
463 
464 	return 0;
465 }
466 
467 static int
468 pad_halt_input(void *opaque)
469 {
470 	return 0;
471 }
472 
473 static int
474 pad_getdev(void *opaque, struct audio_device *ret)
475 {
476 	strlcpy(ret->name, "Virtual Audio", sizeof(ret->name));
477 	strlcpy(ret->version, osrelease, sizeof(ret->version));
478 	strlcpy(ret->config, "pad", sizeof(ret->config));
479 
480 	return 0;
481 }
482 
483 static int
484 pad_set_port(void *opaque, mixer_ctrl_t *mc)
485 {
486 	pad_softc_t *sc;
487 
488 	sc = (pad_softc_t *)opaque;
489 
490 	switch (mc->dev) {
491 	case PAD_OUTPUT_MASTER_VOLUME:
492 	case PAD_INPUT_DAC_VOLUME:
493 		sc->sc_swvol = mc->un.value.level[AUDIO_MIXER_LEVEL_MONO];
494 		return 0;
495 	}
496 
497 	return ENXIO;
498 }
499 
500 static int
501 pad_get_port(void *opaque, mixer_ctrl_t *mc)
502 {
503 	pad_softc_t *sc;
504 
505 	sc = (pad_softc_t *)opaque;
506 
507 	switch (mc->dev) {
508 	case PAD_OUTPUT_MASTER_VOLUME:
509 	case PAD_INPUT_DAC_VOLUME:
510 		mc->un.value.level[AUDIO_MIXER_LEVEL_MONO] = sc->sc_swvol;
511 		return 0;
512 	}
513 
514 	return ENXIO;
515 }
516 
517 static int
518 pad_query_devinfo(void *opaque, mixer_devinfo_t *di)
519 {
520 	pad_softc_t *sc;
521 
522 	sc = (pad_softc_t *)opaque;
523 
524 	switch (di->index) {
525 	case PAD_OUTPUT_CLASS:
526 		di->mixer_class = PAD_OUTPUT_CLASS;
527 		strcpy(di->label.name, AudioCoutputs);
528 		di->type = AUDIO_MIXER_CLASS;
529 		di->next = di->prev = AUDIO_MIXER_LAST;
530 		return 0;
531 	case PAD_INPUT_CLASS:
532 		di->mixer_class = PAD_INPUT_CLASS;
533 		strcpy(di->label.name, AudioCinputs);
534 		di->type = AUDIO_MIXER_CLASS;
535 		di->next = di->prev = AUDIO_MIXER_LAST;
536 		return 0;
537 	case PAD_OUTPUT_MASTER_VOLUME:
538 		di->mixer_class = PAD_OUTPUT_CLASS;
539 		strcpy(di->label.name, AudioNmaster);
540 		di->type = AUDIO_MIXER_VALUE;
541 		di->next = di->prev = AUDIO_MIXER_LAST;
542 		di->un.v.num_channels = 1;
543 		strcpy(di->un.v.units.name, AudioNvolume);
544 		return 0;
545 	case PAD_INPUT_DAC_VOLUME:
546 		di->mixer_class = PAD_INPUT_CLASS;
547 		strcpy(di->label.name, AudioNdac);
548 		di->type = AUDIO_MIXER_VALUE;
549 		di->next = di->prev = AUDIO_MIXER_LAST;
550 		di->un.v.num_channels = 1;
551 		strcpy(di->un.v.units.name, AudioNvolume);
552 		return 0;
553 	}
554 
555 	return ENXIO;
556 }
557 
558 static int
559 pad_get_props(void *opaque)
560 {
561 	return 0;
562 }
563 
564 static int
565 pad_round_blocksize(void *opaque, int blksize, int mode,
566     const audio_params_t *p)
567 {
568 	return PAD_BLKSIZE;
569 }
570 
571 #ifdef _MODULE
572 
573 MODULE(MODULE_CLASS_DRIVER, pad, NULL);
574 
575 static const struct cfiattrdata audiobuscf_iattrdata = {
576 	"audiobus", 0, { { NULL, NULL, 0 }, }
577 };
578 static const struct cfiattrdata * const pad_attrs[] = {
579 	&audiobuscf_iattrdata, NULL
580 };
581 
582 CFDRIVER_DECL(pad, DV_DULL, pad_attrs);
583 extern struct cfattach pad_ca;
584 static int padloc[] = { -1, -1 };
585 
586 static struct cfdata pad_cfdata[] = {
587 	{
588 		.cf_name = "pad",
589 		.cf_atname = "pad",
590 		.cf_unit = 0,
591 		.cf_fstate = FSTATE_STAR,
592 		.cf_loc = padloc,
593 		.cf_flags = 0,
594 		.cf_pspec = NULL,
595 	},
596 	{ NULL, NULL, 0, 0, NULL, 0, NULL }
597 };
598 
599 static int
600 pad_modcmd(modcmd_t cmd, void *arg)
601 {
602 	devmajor_t cmajor = NODEVMAJOR, bmajor = NODEVMAJOR;
603 	int error, s;
604 
605 	switch (cmd) {
606 	case MODULE_CMD_INIT:
607 		error = config_cfdriver_attach(&pad_cd);
608 		if (error) {
609 			return error;
610 		}
611 
612 		error = config_cfattach_attach(pad_cd.cd_name, &pad_ca);
613 		if (error) {
614 			config_cfdriver_detach(&pad_cd);
615 			aprint_error("%s: unable to register cfattach\n",
616 				pad_cd.cd_name);
617 
618 			return error;
619 		}
620 
621 		s = splaudio();
622 		error = config_cfdata_attach(pad_cfdata, 1);
623 		splx(s);
624 		if (error) {
625 			config_cfattach_detach(pad_cd.cd_name, &pad_ca);
626 			config_cfdriver_detach(&pad_cd);
627 			aprint_error("%s: unable to register cfdata\n",
628 				pad_cd.cd_name);
629 
630 			return error;
631 		}
632 
633 		error = devsw_attach(pad_cd.cd_name, NULL, &bmajor, &pad_cdevsw, &cmajor);
634 		if (error) {
635 			error = config_cfdata_detach(pad_cfdata);
636 			if (error) {
637 				return error;
638 			}
639 			config_cfattach_detach(pad_cd.cd_name, &pad_ca);
640 			config_cfdriver_detach(&pad_cd);
641 			aprint_error("%s: unable to register devsw\n",
642 				pad_cd.cd_name);
643 
644 			return error;
645 		}
646 
647 		(void)config_attach_pseudo(pad_cfdata);
648 
649 		return 0;
650 	case MODULE_CMD_FINI:
651 		error = config_cfdata_detach(pad_cfdata);
652 		if (error) {
653 			return error;
654 		}
655 
656 		config_cfattach_detach(pad_cd.cd_name, &pad_ca);
657 		config_cfdriver_detach(&pad_cd);
658 		devsw_detach(NULL, &pad_cdevsw);
659 
660 		return 0;
661 	default:
662 		return ENOTTY;
663 	}
664 }
665 
666 #endif
667