xref: /freebsd/sys/arm/broadcom/bcm2835/bcm2835_audio.c (revision 8b43286fc3badc646ff5a828bae226c8fca90268)
1 /*-
2  * Copyright (c) 2015 Oleksandr Tymoshenko <gonzo@freebsd.org>
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23  * SUCH DAMAGE.
24  */
25 
26 #ifdef HAVE_KERNEL_OPTION_HEADERS
27 #include "opt_snd.h"
28 #endif
29 
30 #include <dev/sound/pcm/sound.h>
31 
32 #include "mixer_if.h"
33 
34 #include "interface/compat/vchi_bsd.h"
35 #include "interface/vchi/vchi.h"
36 #include "interface/vchiq_arm/vchiq.h"
37 
38 #include "vc_vchi_audioserv_defs.h"
39 
40 /* Audio destination */
41 #define	DEST_AUTO		0
42 #define	DEST_HEADPHONES		1
43 #define	DEST_HDMI		2
44 
45 /* Playback state */
46 #define	PLAYBACK_IDLE		0
47 #define	PLAYBACK_PLAYING	1
48 #define	PLAYBACK_STOPPING	2
49 
50 /* Worker thread state */
51 #define	WORKER_RUNNING		0
52 #define	WORKER_STOPPING		1
53 #define	WORKER_STOPPED		2
54 
55 /*
56  * Worker thread flags, set to 1 in flags_pending
57  * when driver requests one or another operation
58  * from worker. Cleared to 0 once worker performs
59  * the operations.
60  */
61 #define	AUDIO_PARAMS		(1 << 0)
62 #define	AUDIO_PLAY		(1 << 1)
63 #define	AUDIO_STOP		(1 << 2)
64 
65 #define	VCHIQ_AUDIO_PACKET_SIZE	4000
66 #define	VCHIQ_AUDIO_BUFFER_SIZE	10*VCHIQ_AUDIO_PACKET_SIZE
67 
68 #define	VCHIQ_AUDIO_MAX_VOLUME
69 /* volume in terms of 0.01dB */
70 #define VCHIQ_AUDIO_VOLUME_MIN -10239
71 #define VCHIQ_AUDIO_VOLUME(db100) (uint32_t)(-((db100) << 8)/100)
72 
73 /* dB levels with 5% volume step */
74 static int db_levels[] = {
75 	VCHIQ_AUDIO_VOLUME_MIN, -4605, -3794, -3218, -2772,
76 	-2407, -2099, -1832, -1597, -1386,
77 	-1195, -1021, -861, -713, -575,
78 	-446, -325, -210, -102, 0,
79 };
80 
81 static uint32_t bcm2835_audio_playfmt[] = {
82 	SND_FORMAT(AFMT_U8, 1, 0),
83 	SND_FORMAT(AFMT_U8, 2, 0),
84 	SND_FORMAT(AFMT_S8, 1, 0),
85 	SND_FORMAT(AFMT_S8, 2, 0),
86 	SND_FORMAT(AFMT_S16_LE, 1, 0),
87 	SND_FORMAT(AFMT_S16_LE, 2, 0),
88 	SND_FORMAT(AFMT_U16_LE, 1, 0),
89 	SND_FORMAT(AFMT_U16_LE, 2, 0),
90 	0
91 };
92 
93 static struct pcmchan_caps bcm2835_audio_playcaps = {8000, 48000, bcm2835_audio_playfmt, 0};
94 
95 struct bcm2835_audio_info;
96 
97 struct bcm2835_audio_chinfo {
98 	struct bcm2835_audio_info *parent;
99 	struct pcm_channel *channel;
100 	struct snd_dbuf *buffer;
101 	uint32_t fmt, spd, blksz;
102 
103 	/* Pointer to first unsubmitted sample */
104 	uint32_t unsubmittedptr;
105 	/*
106 	 * Number of bytes in "submitted but not played"
107 	 * pseudo-buffer
108 	 */
109 	int available_space;
110 	int playback_state;
111 	uint64_t callbacks;
112 	uint64_t submitted_samples;
113 	uint64_t retrieved_samples;
114 	uint64_t underruns;
115 	int starved;
116 };
117 
118 struct bcm2835_audio_info {
119 	device_t dev;
120 	unsigned int bufsz;
121     	struct bcm2835_audio_chinfo pch;
122 	uint32_t dest, volume;
123 	struct intr_config_hook intr_hook;
124 
125 	/* VCHI data */
126 	VCHI_INSTANCE_T vchi_instance;
127 	VCHI_CONNECTION_T *vchi_connection;
128 	VCHI_SERVICE_HANDLE_T vchi_handle;
129 
130 	struct mtx lock;
131 	struct cv worker_cv;
132 
133 	uint32_t flags_pending;
134 
135 	int verbose_trace;
136 	/* Worker thread state */
137 	int worker_state;
138 };
139 
140 #define BCM2835_AUDIO_LOCK(sc)		mtx_lock(&(sc)->lock)
141 #define BCM2835_AUDIO_LOCKED(sc)	mtx_assert(&(sc)->lock, MA_OWNED)
142 #define BCM2835_AUDIO_UNLOCK(sc)	mtx_unlock(&(sc)->lock)
143 
144 #define BCM2835_LOG_ERROR(sc,...)				\
145 	do {							\
146 		device_printf((sc)->dev, __VA_ARGS__);		\
147 	} while(0)
148 
149 #define BCM2835_LOG_INFO(sc,...)				\
150 	do {							\
151 		if (sc->verbose_trace > 0)			\
152 			device_printf((sc)->dev, __VA_ARGS__);	\
153 	} while(0)
154 
155 #define BCM2835_LOG_WARN(sc,...) \
156 	do {							\
157 		if (sc->verbose_trace > 1)			\
158 			device_printf((sc)->dev, __VA_ARGS__);	\
159 	} while(0)
160 
161 #define BCM2835_LOG_TRACE(sc,...)				\
162 	do {							\
163 		if(sc->verbose_trace > 2)			\
164 			device_printf((sc)->dev, __VA_ARGS__);	\
165 	} while(0)
166 
167 static const char *
dest_description(uint32_t dest)168 dest_description(uint32_t dest)
169 {
170 	switch (dest) {
171 		case DEST_AUTO:
172 			return "AUTO";
173 			break;
174 
175 		case DEST_HEADPHONES:
176 			return "HEADPHONES";
177 			break;
178 
179 		case DEST_HDMI:
180 			return "HDMI";
181 			break;
182 		default:
183 			return "UNKNOWN";
184 			break;
185 	}
186 }
187 
188 static void
bcm2835_worker_update_params(struct bcm2835_audio_info * sc)189 bcm2835_worker_update_params(struct bcm2835_audio_info *sc)
190 {
191 
192 	BCM2835_AUDIO_LOCKED(sc);
193 
194 	sc->flags_pending |= AUDIO_PARAMS;
195 	cv_signal(&sc->worker_cv);
196 }
197 
198 static void
bcm2835_worker_play_start(struct bcm2835_audio_info * sc)199 bcm2835_worker_play_start(struct bcm2835_audio_info *sc)
200 {
201 	BCM2835_AUDIO_LOCK(sc);
202 	sc->flags_pending &= ~(AUDIO_STOP);
203 	sc->flags_pending |= AUDIO_PLAY;
204 	cv_signal(&sc->worker_cv);
205 	BCM2835_AUDIO_UNLOCK(sc);
206 }
207 
208 static void
bcm2835_worker_play_stop(struct bcm2835_audio_info * sc)209 bcm2835_worker_play_stop(struct bcm2835_audio_info *sc)
210 {
211 	BCM2835_AUDIO_LOCK(sc);
212 	sc->flags_pending &= ~(AUDIO_PLAY);
213 	sc->flags_pending |= AUDIO_STOP;
214 	cv_signal(&sc->worker_cv);
215 	BCM2835_AUDIO_UNLOCK(sc);
216 }
217 
218 static void
bcm2835_audio_callback(void * param,const VCHI_CALLBACK_REASON_T reason,void * msg_handle)219 bcm2835_audio_callback(void *param, const VCHI_CALLBACK_REASON_T reason, void *msg_handle)
220 {
221 	struct bcm2835_audio_info *sc = (struct bcm2835_audio_info *)param;
222 	int32_t status;
223 	uint32_t msg_len;
224 	VC_AUDIO_MSG_T m;
225 
226 	if (reason != VCHI_CALLBACK_MSG_AVAILABLE)
227 		return;
228 
229 	status = vchi_msg_dequeue(sc->vchi_handle,
230 	    &m, sizeof m, &msg_len, VCHI_FLAGS_NONE);
231 	if (status != 0)
232 		return;
233 	if (m.type == VC_AUDIO_MSG_TYPE_RESULT) {
234 		if (m.u.result.success) {
235 			device_printf(sc->dev,
236 			    "msg type %08x failed\n",
237 			    m.type);
238 		}
239 	} else if (m.type == VC_AUDIO_MSG_TYPE_COMPLETE) {
240 		struct bcm2835_audio_chinfo *ch = m.u.complete.cookie;
241 
242 		int count = m.u.complete.count & 0xffff;
243 		int perr = (m.u.complete.count & (1U << 30)) != 0;
244 		ch->callbacks++;
245 		if (perr)
246 			ch->underruns++;
247 
248 		BCM2835_AUDIO_LOCK(sc);
249 		if (ch->playback_state != PLAYBACK_IDLE) {
250 			/* Prevent LOR */
251 			BCM2835_AUDIO_UNLOCK(sc);
252 			chn_intr(sc->pch.channel);
253 			BCM2835_AUDIO_LOCK(sc);
254 		}
255 		/* We should check again, state might have changed */
256 		if (ch->playback_state != PLAYBACK_IDLE) {
257 			if (!perr) {
258 				if ((ch->available_space + count)> VCHIQ_AUDIO_BUFFER_SIZE) {
259 					device_printf(sc->dev, "inconsistent data in callback:\n");
260 					device_printf(sc->dev, "available_space == %d, count = %d, perr=%d\n",
261 					    ch->available_space, count, perr);
262 					device_printf(sc->dev,
263 					    "retrieved_samples = %ju, submitted_samples = %ju\n",
264 					    (uintmax_t)ch->retrieved_samples,
265 					    (uintmax_t)ch->submitted_samples);
266 				}
267 				ch->available_space += count;
268 				ch->retrieved_samples += count;
269 			}
270 			if (perr || (ch->available_space >= VCHIQ_AUDIO_PACKET_SIZE))
271 				cv_signal(&sc->worker_cv);
272 		}
273 		BCM2835_AUDIO_UNLOCK(sc);
274 	} else
275 		BCM2835_LOG_WARN(sc, "%s: unknown m.type: %d\n", __func__,
276 		    m.type);
277 }
278 
279 /* VCHIQ stuff */
280 static void
bcm2835_audio_init(struct bcm2835_audio_info * sc)281 bcm2835_audio_init(struct bcm2835_audio_info *sc)
282 {
283 	int status;
284 
285 	/* Initialize and create a VCHI connection */
286 	status = vchi_initialise(&sc->vchi_instance);
287 	if (status != 0) {
288 		BCM2835_LOG_ERROR(sc, "vchi_initialise failed: %d\n", status);
289 		return;
290 	}
291 
292 	status = vchi_connect(NULL, 0, sc->vchi_instance);
293 	if (status != 0) {
294 		BCM2835_LOG_ERROR(sc, "vchi_connect failed: %d\n", status);
295 		return;
296 	}
297 
298 	SERVICE_CREATION_T params = {
299 	    VCHI_VERSION_EX(VC_AUDIOSERV_VER, VC_AUDIOSERV_MIN_VER),
300 	    VC_AUDIO_SERVER_NAME,   /* 4cc service code */
301 	    sc->vchi_connection,    /* passed in fn pointers */
302 	    0,  /* rx fifo size */
303 	    0,  /* tx fifo size */
304 	    bcm2835_audio_callback,    /* service callback */
305 	    sc,   /* service callback parameter */
306 	    1,
307 	    1,
308 	    0   /* want crc check on bulk transfers */
309 	};
310 
311 	status = vchi_service_open(sc->vchi_instance, &params,
312 	    &sc->vchi_handle);
313 
314 	if (status != 0)
315 		sc->vchi_handle = VCHIQ_SERVICE_HANDLE_INVALID;
316 }
317 
318 static void
bcm2835_audio_release(struct bcm2835_audio_info * sc)319 bcm2835_audio_release(struct bcm2835_audio_info *sc)
320 {
321 	int success;
322 
323 	if (sc->vchi_handle != VCHIQ_SERVICE_HANDLE_INVALID) {
324 		success = vchi_service_close(sc->vchi_handle);
325 		if (success != 0)
326 			BCM2835_LOG_ERROR(sc, "vchi_service_close failed: %d\n",
327 			    success);
328 		vchi_service_release(sc->vchi_handle);
329 		sc->vchi_handle = VCHIQ_SERVICE_HANDLE_INVALID;
330 	}
331 
332 	vchi_disconnect(sc->vchi_instance);
333 }
334 
335 static void
bcm2835_audio_reset_channel(struct bcm2835_audio_chinfo * ch)336 bcm2835_audio_reset_channel(struct bcm2835_audio_chinfo *ch)
337 {
338 
339 	ch->available_space = VCHIQ_AUDIO_BUFFER_SIZE;
340 	ch->unsubmittedptr = 0;
341 	sndbuf_reset(ch->buffer);
342 }
343 
344 static void
bcm2835_audio_start(struct bcm2835_audio_chinfo * ch)345 bcm2835_audio_start(struct bcm2835_audio_chinfo *ch)
346 {
347 	VC_AUDIO_MSG_T m;
348 	int ret;
349 	struct bcm2835_audio_info *sc = ch->parent;
350 
351 	if (sc->vchi_handle != VCHIQ_SERVICE_HANDLE_INVALID) {
352 		m.type = VC_AUDIO_MSG_TYPE_START;
353 		ret = vchi_msg_queue(sc->vchi_handle,
354 		    &m, sizeof m, VCHI_FLAGS_BLOCK_UNTIL_QUEUED, NULL);
355 
356 		if (ret != 0)
357 			BCM2835_LOG_ERROR(sc,
358 			    "%s: vchi_msg_queue failed (err %d)\n", __func__,
359 			    ret);
360 	}
361 }
362 
363 static void
bcm2835_audio_stop(struct bcm2835_audio_chinfo * ch)364 bcm2835_audio_stop(struct bcm2835_audio_chinfo *ch)
365 {
366 	VC_AUDIO_MSG_T m;
367 	int ret;
368 	struct bcm2835_audio_info *sc = ch->parent;
369 
370 	if (sc->vchi_handle != VCHIQ_SERVICE_HANDLE_INVALID) {
371 		m.type = VC_AUDIO_MSG_TYPE_STOP;
372 		m.u.stop.draining = 0;
373 
374 		ret = vchi_msg_queue(sc->vchi_handle,
375 		    &m, sizeof m, VCHI_FLAGS_BLOCK_UNTIL_QUEUED, NULL);
376 
377 		if (ret != 0)
378 			BCM2835_LOG_ERROR(sc,
379 			    "%s: vchi_msg_queue failed (err %d)\n", __func__,
380 			    ret);
381 	}
382 }
383 
384 static void
bcm2835_audio_open(struct bcm2835_audio_info * sc)385 bcm2835_audio_open(struct bcm2835_audio_info *sc)
386 {
387 	VC_AUDIO_MSG_T m;
388 	int ret;
389 
390 	if (sc->vchi_handle != VCHIQ_SERVICE_HANDLE_INVALID) {
391 		m.type = VC_AUDIO_MSG_TYPE_OPEN;
392 		ret = vchi_msg_queue(sc->vchi_handle,
393 		    &m, sizeof m, VCHI_FLAGS_BLOCK_UNTIL_QUEUED, NULL);
394 
395 		if (ret != 0)
396 			BCM2835_LOG_ERROR(sc,
397 			    "%s: vchi_msg_queue failed (err %d)\n", __func__,
398 			    ret);
399 	}
400 }
401 
402 static void
bcm2835_audio_update_controls(struct bcm2835_audio_info * sc,uint32_t volume,uint32_t dest)403 bcm2835_audio_update_controls(struct bcm2835_audio_info *sc, uint32_t volume, uint32_t dest)
404 {
405 	VC_AUDIO_MSG_T m;
406 	int ret, db;
407 
408 	if (sc->vchi_handle != VCHIQ_SERVICE_HANDLE_INVALID) {
409 		m.type = VC_AUDIO_MSG_TYPE_CONTROL;
410 		m.u.control.dest = dest;
411 		if (volume > 99)
412 			volume = 99;
413 		db = db_levels[volume/5];
414 		m.u.control.volume = VCHIQ_AUDIO_VOLUME(db);
415 
416 		ret = vchi_msg_queue(sc->vchi_handle,
417 		    &m, sizeof m, VCHI_FLAGS_BLOCK_UNTIL_QUEUED, NULL);
418 
419 		if (ret != 0)
420 			BCM2835_LOG_ERROR(sc,
421 			    "%s: vchi_msg_queue failed (err %d)\n", __func__,
422 			    ret);
423 	}
424 }
425 
426 static void
bcm2835_audio_update_params(struct bcm2835_audio_info * sc,uint32_t fmt,uint32_t speed)427 bcm2835_audio_update_params(struct bcm2835_audio_info *sc, uint32_t fmt, uint32_t speed)
428 {
429 	VC_AUDIO_MSG_T m;
430 	int ret;
431 
432 	if (sc->vchi_handle != VCHIQ_SERVICE_HANDLE_INVALID) {
433 		m.type = VC_AUDIO_MSG_TYPE_CONFIG;
434 		m.u.config.channels = AFMT_CHANNEL(fmt);
435 		m.u.config.samplerate = speed;
436 		m.u.config.bps = AFMT_BIT(fmt);
437 
438 		ret = vchi_msg_queue(sc->vchi_handle,
439 		    &m, sizeof m, VCHI_FLAGS_BLOCK_UNTIL_QUEUED, NULL);
440 
441 		if (ret != 0)
442 			BCM2835_LOG_ERROR(sc,
443 			    "%s: vchi_msg_queue failed (err %d)\n", __func__,
444 			    ret);
445 	}
446 }
447 
448 static bool
bcm2835_audio_buffer_should_sleep(struct bcm2835_audio_chinfo * ch)449 bcm2835_audio_buffer_should_sleep(struct bcm2835_audio_chinfo *ch)
450 {
451 
452 	if (ch->playback_state != PLAYBACK_PLAYING)
453 		return (true);
454 
455 	/* Not enough data */
456 	if (sndbuf_getready(ch->buffer) < VCHIQ_AUDIO_PACKET_SIZE) {
457 		printf("starve\n");
458 		ch->starved++;
459 		return (true);
460 	}
461 
462 	/* Not enough free space */
463 	if (ch->available_space < VCHIQ_AUDIO_PACKET_SIZE) {
464 		return (true);
465 	}
466 
467 	return (false);
468 }
469 
470 static void
bcm2835_audio_write_samples(struct bcm2835_audio_chinfo * ch,void * buf,uint32_t count)471 bcm2835_audio_write_samples(struct bcm2835_audio_chinfo *ch, void *buf, uint32_t count)
472 {
473 	struct bcm2835_audio_info *sc = ch->parent;
474 	VC_AUDIO_MSG_T m;
475 	int ret;
476 
477 	if (sc->vchi_handle == VCHIQ_SERVICE_HANDLE_INVALID) {
478 		return;
479 	}
480 
481 	m.type = VC_AUDIO_MSG_TYPE_WRITE;
482 	m.u.write.count = count;
483 	m.u.write.max_packet = VCHIQ_AUDIO_PACKET_SIZE;
484 	m.u.write.callback = NULL;
485 	m.u.write.cookie = ch;
486 	m.u.write.silence = 0;
487 
488 	ret = vchi_msg_queue(sc->vchi_handle,
489 	    &m, sizeof m, VCHI_FLAGS_BLOCK_UNTIL_QUEUED, NULL);
490 
491 	if (ret != 0)
492 		BCM2835_LOG_ERROR(sc, "%s: vchi_msg_queue failed (err %d)\n",
493 		    __func__, ret);
494 
495 	while (count > 0) {
496 		int bytes = MIN((int)m.u.write.max_packet, (int)count);
497 		ret = vchi_msg_queue(sc->vchi_handle,
498 		    buf, bytes, VCHI_FLAGS_BLOCK_UNTIL_QUEUED, NULL);
499 		if (ret != 0)
500 			BCM2835_LOG_ERROR(sc, "%s: vchi_msg_queue failed: %d\n",
501 			    __func__, ret);
502 		buf = (char *)buf + bytes;
503 		count -= bytes;
504 	}
505 }
506 
507 static void
bcm2835_audio_worker(void * data)508 bcm2835_audio_worker(void *data)
509 {
510 	struct bcm2835_audio_info *sc = (struct bcm2835_audio_info *)data;
511 	struct bcm2835_audio_chinfo *ch = &sc->pch;
512 	uint32_t speed, format;
513 	uint32_t volume, dest;
514 	uint32_t flags;
515 	uint32_t count, size, readyptr;
516 	uint8_t *buf;
517 
518 	ch->playback_state = PLAYBACK_IDLE;
519 
520 	while (1) {
521 		if (sc->worker_state != WORKER_RUNNING)
522 			break;
523 
524 		BCM2835_AUDIO_LOCK(sc);
525 		/*
526 		 * wait until there are flags set or buffer is ready
527 		 * to consume more samples
528 		 */
529 		while ((sc->flags_pending == 0) &&
530 		    bcm2835_audio_buffer_should_sleep(ch)) {
531 			cv_wait_sig(&sc->worker_cv, &sc->lock);
532 		}
533 		flags = sc->flags_pending;
534 		/* Clear pending flags */
535 		sc->flags_pending = 0;
536 		BCM2835_AUDIO_UNLOCK(sc);
537 
538 		/* Requested to change parameters */
539 		if (flags & AUDIO_PARAMS) {
540 			BCM2835_AUDIO_LOCK(sc);
541 			speed = ch->spd;
542 			format = ch->fmt;
543 			volume = sc->volume;
544 			dest = sc->dest;
545 			BCM2835_AUDIO_UNLOCK(sc);
546 			if (ch->playback_state == PLAYBACK_IDLE)
547 				bcm2835_audio_update_params(sc, format, speed);
548 			bcm2835_audio_update_controls(sc, volume, dest);
549 		}
550 
551 		/* Requested to stop playback */
552 		if ((flags & AUDIO_STOP) &&
553 		    (ch->playback_state == PLAYBACK_PLAYING)) {
554 			bcm2835_audio_stop(ch);
555 			BCM2835_AUDIO_LOCK(sc);
556 			bcm2835_audio_reset_channel(&sc->pch);
557 			ch->playback_state = PLAYBACK_IDLE;
558 			BCM2835_AUDIO_UNLOCK(sc);
559 			continue;
560 		}
561 
562 		/* Requested to start playback */
563 		if ((flags & AUDIO_PLAY) &&
564 		    (ch->playback_state == PLAYBACK_IDLE)) {
565 			BCM2835_AUDIO_LOCK(sc);
566 			ch->playback_state = PLAYBACK_PLAYING;
567 			BCM2835_AUDIO_UNLOCK(sc);
568 			bcm2835_audio_start(ch);
569 		}
570 
571 		if (ch->playback_state == PLAYBACK_IDLE)
572 			continue;
573 
574 		if (sndbuf_getready(ch->buffer) == 0)
575 			continue;
576 
577 		count = sndbuf_getready(ch->buffer);
578 		size = sndbuf_getsize(ch->buffer);
579 		readyptr = sndbuf_getreadyptr(ch->buffer);
580 
581 		BCM2835_AUDIO_LOCK(sc);
582 		if (readyptr + count > size)
583 			count = size - readyptr;
584 		count = min(count, ch->available_space);
585 		count -= (count % VCHIQ_AUDIO_PACKET_SIZE);
586 		BCM2835_AUDIO_UNLOCK(sc);
587 
588 		if (count < VCHIQ_AUDIO_PACKET_SIZE)
589 			continue;
590 
591 		buf = (uint8_t*)sndbuf_getbuf(ch->buffer) + readyptr;
592 
593 		bcm2835_audio_write_samples(ch, buf, count);
594 		BCM2835_AUDIO_LOCK(sc);
595 		ch->unsubmittedptr = (ch->unsubmittedptr + count) % sndbuf_getsize(ch->buffer);
596 		ch->available_space -= count;
597 		ch->submitted_samples += count;
598 		KASSERT(ch->available_space >= 0, ("ch->available_space == %d\n", ch->available_space));
599 		BCM2835_AUDIO_UNLOCK(sc);
600 	}
601 
602 	BCM2835_AUDIO_LOCK(sc);
603 	sc->worker_state = WORKER_STOPPED;
604 	cv_signal(&sc->worker_cv);
605 	BCM2835_AUDIO_UNLOCK(sc);
606 
607 	kproc_exit(0);
608 }
609 
610 static void
bcm2835_audio_create_worker(struct bcm2835_audio_info * sc)611 bcm2835_audio_create_worker(struct bcm2835_audio_info *sc)
612 {
613 	struct proc *newp;
614 
615 	sc->worker_state = WORKER_RUNNING;
616 	if (kproc_create(bcm2835_audio_worker, (void*)sc, &newp, 0, 0,
617 	    "bcm2835_audio_worker") != 0) {
618 		BCM2835_LOG_ERROR(sc,
619 		    "failed to create bcm2835_audio_worker\n");
620 	}
621 }
622 
623 /* -------------------------------------------------------------------- */
624 /* channel interface for VCHI audio */
625 static void *
bcmchan_init(kobj_t obj,void * devinfo,struct snd_dbuf * b,struct pcm_channel * c,int dir)626 bcmchan_init(kobj_t obj, void *devinfo, struct snd_dbuf *b, struct pcm_channel *c, int dir)
627 {
628 	struct bcm2835_audio_info *sc = devinfo;
629 	struct bcm2835_audio_chinfo *ch = &sc->pch;
630 	void *buffer;
631 
632 	if (dir == PCMDIR_REC)
633 		return NULL;
634 
635 	ch->parent = sc;
636 	ch->channel = c;
637 	ch->buffer = b;
638 
639 	/* default values */
640 	ch->spd = 44100;
641 	ch->fmt = SND_FORMAT(AFMT_S16_LE, 2, 0);
642 	ch->blksz = VCHIQ_AUDIO_PACKET_SIZE;
643 
644 	buffer = malloc(sc->bufsz, M_DEVBUF, M_WAITOK | M_ZERO);
645 
646 	if (sndbuf_setup(ch->buffer, buffer, sc->bufsz) != 0) {
647 		device_printf(sc->dev, "sndbuf_setup failed\n");
648 		free(buffer, M_DEVBUF);
649 		return NULL;
650 	}
651 
652 	BCM2835_AUDIO_LOCK(sc);
653 	bcm2835_worker_update_params(sc);
654 	BCM2835_AUDIO_UNLOCK(sc);
655 
656 	return ch;
657 }
658 
659 static int
bcmchan_free(kobj_t obj,void * data)660 bcmchan_free(kobj_t obj, void *data)
661 {
662 	struct bcm2835_audio_chinfo *ch = data;
663 	void *buffer;
664 
665 	buffer = sndbuf_getbuf(ch->buffer);
666 	if (buffer)
667 		free(buffer, M_DEVBUF);
668 
669 	return (0);
670 }
671 
672 static int
bcmchan_setformat(kobj_t obj,void * data,uint32_t format)673 bcmchan_setformat(kobj_t obj, void *data, uint32_t format)
674 {
675 	struct bcm2835_audio_chinfo *ch = data;
676 	struct bcm2835_audio_info *sc = ch->parent;
677 
678 	BCM2835_AUDIO_LOCK(sc);
679 	ch->fmt = format;
680 	bcm2835_worker_update_params(sc);
681 	BCM2835_AUDIO_UNLOCK(sc);
682 
683 	return 0;
684 }
685 
686 static uint32_t
bcmchan_setspeed(kobj_t obj,void * data,uint32_t speed)687 bcmchan_setspeed(kobj_t obj, void *data, uint32_t speed)
688 {
689 	struct bcm2835_audio_chinfo *ch = data;
690 	struct bcm2835_audio_info *sc = ch->parent;
691 
692 	BCM2835_AUDIO_LOCK(sc);
693 	ch->spd = speed;
694 	bcm2835_worker_update_params(sc);
695 	BCM2835_AUDIO_UNLOCK(sc);
696 
697 	return ch->spd;
698 }
699 
700 static uint32_t
bcmchan_setblocksize(kobj_t obj,void * data,uint32_t blocksize)701 bcmchan_setblocksize(kobj_t obj, void *data, uint32_t blocksize)
702 {
703 	struct bcm2835_audio_chinfo *ch = data;
704 
705 	return ch->blksz;
706 }
707 
708 static int
bcmchan_trigger(kobj_t obj,void * data,int go)709 bcmchan_trigger(kobj_t obj, void *data, int go)
710 {
711 	struct bcm2835_audio_chinfo *ch = data;
712 	struct bcm2835_audio_info *sc = ch->parent;
713 
714 	if (!PCMTRIG_COMMON(go))
715 		return (0);
716 
717 	switch (go) {
718 	case PCMTRIG_START:
719 		/* kickstart data flow */
720 		chn_intr(sc->pch.channel);
721 		ch->submitted_samples = 0;
722 		ch->retrieved_samples = 0;
723 		bcm2835_worker_play_start(sc);
724 		break;
725 
726 	case PCMTRIG_STOP:
727 	case PCMTRIG_ABORT:
728 		bcm2835_worker_play_stop(sc);
729 		break;
730 
731 	default:
732 		break;
733 	}
734 	return 0;
735 }
736 
737 static uint32_t
bcmchan_getptr(kobj_t obj,void * data)738 bcmchan_getptr(kobj_t obj, void *data)
739 {
740 	struct bcm2835_audio_chinfo *ch = data;
741 	struct bcm2835_audio_info *sc = ch->parent;
742 	uint32_t ret;
743 
744 	BCM2835_AUDIO_LOCK(sc);
745 	ret = ch->unsubmittedptr;
746 	BCM2835_AUDIO_UNLOCK(sc);
747 
748 	return ret;
749 }
750 
751 static struct pcmchan_caps *
bcmchan_getcaps(kobj_t obj,void * data)752 bcmchan_getcaps(kobj_t obj, void *data)
753 {
754 
755 	return &bcm2835_audio_playcaps;
756 }
757 
758 static kobj_method_t bcmchan_methods[] = {
759     	KOBJMETHOD(channel_init,		bcmchan_init),
760     	KOBJMETHOD(channel_free,		bcmchan_free),
761     	KOBJMETHOD(channel_setformat,		bcmchan_setformat),
762     	KOBJMETHOD(channel_setspeed,		bcmchan_setspeed),
763     	KOBJMETHOD(channel_setblocksize,	bcmchan_setblocksize),
764     	KOBJMETHOD(channel_trigger,		bcmchan_trigger),
765     	KOBJMETHOD(channel_getptr,		bcmchan_getptr),
766     	KOBJMETHOD(channel_getcaps,		bcmchan_getcaps),
767 	KOBJMETHOD_END
768 };
769 CHANNEL_DECLARE(bcmchan);
770 
771 /************************************************************/
772 
773 static int
bcmmix_init(struct snd_mixer * m)774 bcmmix_init(struct snd_mixer *m)
775 {
776 
777 	mix_setdevs(m, SOUND_MASK_VOLUME);
778 
779 	return (0);
780 }
781 
782 static int
bcmmix_set(struct snd_mixer * m,unsigned dev,unsigned left,unsigned right)783 bcmmix_set(struct snd_mixer *m, unsigned dev, unsigned left, unsigned right)
784 {
785     	struct bcm2835_audio_info *sc = mix_getdevinfo(m);
786 
787 	switch (dev) {
788 	case SOUND_MIXER_VOLUME:
789 		BCM2835_AUDIO_LOCK(sc);
790 		sc->volume = left;
791 		bcm2835_worker_update_params(sc);
792 		BCM2835_AUDIO_UNLOCK(sc);
793 
794 		break;
795 
796 	default:
797 		break;
798 	}
799 
800     	return left | (left << 8);
801 }
802 
803 static kobj_method_t bcmmixer_methods[] = {
804     	KOBJMETHOD(mixer_init,		bcmmix_init),
805     	KOBJMETHOD(mixer_set,		bcmmix_set),
806 	KOBJMETHOD_END
807 };
808 
809 MIXER_DECLARE(bcmmixer);
810 
811 static int
sysctl_bcm2835_audio_dest(SYSCTL_HANDLER_ARGS)812 sysctl_bcm2835_audio_dest(SYSCTL_HANDLER_ARGS)
813 {
814 	struct bcm2835_audio_info *sc = arg1;
815 	int val;
816 	int err;
817 
818 	val = sc->dest;
819 	err = sysctl_handle_int(oidp, &val, 0, req);
820 	if (err || !req->newptr) /* error || read request */
821 		return (err);
822 
823 	if ((val < 0) || (val > 2))
824 		return (EINVAL);
825 
826 	BCM2835_AUDIO_LOCK(sc);
827 	sc->dest = val;
828 	bcm2835_worker_update_params(sc);
829 	BCM2835_AUDIO_UNLOCK(sc);
830 
831 	if (bootverbose)
832 		device_printf(sc->dev, "destination set to %s\n", dest_description(val));
833 
834 	return (0);
835 }
836 
837 static void
vchi_audio_sysctl_init(struct bcm2835_audio_info * sc)838 vchi_audio_sysctl_init(struct bcm2835_audio_info *sc)
839 {
840 	struct sysctl_ctx_list *ctx;
841 	struct sysctl_oid *tree_node;
842 	struct sysctl_oid_list *tree;
843 
844 	/*
845 	 * Add system sysctl tree/handlers.
846 	 */
847 	ctx = device_get_sysctl_ctx(sc->dev);
848 	tree_node = device_get_sysctl_tree(sc->dev);
849 	tree = SYSCTL_CHILDREN(tree_node);
850 	SYSCTL_ADD_PROC(ctx, tree, OID_AUTO, "dest",
851 	    CTLFLAG_RW | CTLTYPE_UINT | CTLFLAG_NEEDGIANT, sc, sizeof(*sc),
852 	    sysctl_bcm2835_audio_dest, "IU", "audio destination, "
853 	    "0 - auto, 1 - headphones, 2 - HDMI");
854 	SYSCTL_ADD_UQUAD(ctx, tree, OID_AUTO, "callbacks",
855 			CTLFLAG_RD, &sc->pch.callbacks,
856 			"callbacks total");
857 	SYSCTL_ADD_UQUAD(ctx, tree, OID_AUTO, "submitted",
858 			CTLFLAG_RD, &sc->pch.submitted_samples,
859 			"last play submitted samples");
860 	SYSCTL_ADD_UQUAD(ctx, tree, OID_AUTO, "retrieved",
861 			CTLFLAG_RD, &sc->pch.retrieved_samples,
862 			"last play retrieved samples");
863 	SYSCTL_ADD_UQUAD(ctx, tree, OID_AUTO, "underruns",
864 			CTLFLAG_RD, &sc->pch.underruns,
865 			"callback underruns");
866 	SYSCTL_ADD_INT(ctx, tree, OID_AUTO, "freebuffer",
867 			CTLFLAG_RD, &sc->pch.available_space,
868 			sc->pch.available_space, "callbacks total");
869 	SYSCTL_ADD_INT(ctx, tree, OID_AUTO, "starved",
870 			CTLFLAG_RD, &sc->pch.starved,
871 			sc->pch.starved, "number of starved conditions");
872 	SYSCTL_ADD_INT(ctx, tree, OID_AUTO, "trace",
873 			CTLFLAG_RW, &sc->verbose_trace,
874 			sc->verbose_trace, "enable tracing of transfers");
875 }
876 
877 static void
bcm2835_audio_identify(driver_t * driver,device_t parent)878 bcm2835_audio_identify(driver_t *driver, device_t parent)
879 {
880 
881 	BUS_ADD_CHILD(parent, 0, "pcm", 0);
882 }
883 
884 static int
bcm2835_audio_probe(device_t dev)885 bcm2835_audio_probe(device_t dev)
886 {
887 
888 	device_set_desc(dev, "VCHIQ audio");
889 	return (BUS_PROBE_DEFAULT);
890 }
891 
892 static void
bcm2835_audio_delayed_init(void * xsc)893 bcm2835_audio_delayed_init(void *xsc)
894 {
895     	struct bcm2835_audio_info *sc;
896     	char status[SND_STATUSLEN];
897 
898 	sc = xsc;
899 
900 	config_intrhook_disestablish(&sc->intr_hook);
901 
902 	bcm2835_audio_init(sc);
903 	bcm2835_audio_open(sc);
904 	sc->volume = 75;
905 	sc->dest = DEST_AUTO;
906 	sc->verbose_trace = 0;
907 
908     	if (mixer_init(sc->dev, &bcmmixer_class, sc)) {
909 		device_printf(sc->dev, "mixer_init failed\n");
910 		goto no;
911 	}
912 
913 	pcm_init(sc->dev, sc);
914 
915 	pcm_addchan(sc->dev, PCMDIR_PLAY, &bcmchan_class, sc);
916     	snprintf(status, SND_STATUSLEN, "at VCHIQ");
917 	if (pcm_register(sc->dev, status)) {
918 		device_printf(sc->dev, "pcm_register failed\n");
919 		goto no;
920 	}
921 
922 	bcm2835_audio_reset_channel(&sc->pch);
923 	bcm2835_audio_create_worker(sc);
924 
925 	vchi_audio_sysctl_init(sc);
926 
927 no:
928 	;
929 }
930 
931 static int
bcm2835_audio_attach(device_t dev)932 bcm2835_audio_attach(device_t dev)
933 {
934     	struct bcm2835_audio_info *sc;
935 
936 	sc = malloc(sizeof(*sc), M_DEVBUF, M_WAITOK | M_ZERO);
937 
938 	sc->dev = dev;
939 	sc->bufsz = VCHIQ_AUDIO_BUFFER_SIZE;
940 
941 	mtx_init(&sc->lock, device_get_nameunit(dev),
942 	    "bcm_audio_lock", MTX_DEF);
943 	cv_init(&sc->worker_cv, "worker_cv");
944 	sc->vchi_handle = VCHIQ_SERVICE_HANDLE_INVALID;
945 
946 	/*
947 	 * We need interrupts enabled for VCHI to work properly,
948 	 * so delay initialization until it happens.
949 	 */
950 	sc->intr_hook.ich_func = bcm2835_audio_delayed_init;
951 	sc->intr_hook.ich_arg = sc;
952 
953 	if (config_intrhook_establish(&sc->intr_hook) != 0)
954 		goto no;
955 
956     	return 0;
957 
958 no:
959     	return ENXIO;
960 }
961 
962 static int
bcm2835_audio_detach(device_t dev)963 bcm2835_audio_detach(device_t dev)
964 {
965 	int r;
966 	struct bcm2835_audio_info *sc;
967 	sc = pcm_getdevinfo(dev);
968 
969 	/* Stop worker thread */
970 	BCM2835_AUDIO_LOCK(sc);
971 	sc->worker_state = WORKER_STOPPING;
972 	cv_signal(&sc->worker_cv);
973 	/* Wait for thread to exit */
974 	while (sc->worker_state != WORKER_STOPPED)
975 		cv_wait_sig(&sc->worker_cv, &sc->lock);
976 	BCM2835_AUDIO_UNLOCK(sc);
977 
978 	r = pcm_unregister(dev);
979 	if (r)
980 		return r;
981 
982 	mtx_destroy(&sc->lock);
983 	cv_destroy(&sc->worker_cv);
984 
985 	bcm2835_audio_release(sc);
986 
987     	free(sc, M_DEVBUF);
988 
989 	return 0;
990 }
991 
992 static device_method_t bcm2835_audio_methods[] = {
993 	/* Device interface */
994 	DEVMETHOD(device_identify,	bcm2835_audio_identify),
995 	DEVMETHOD(device_probe,		bcm2835_audio_probe),
996 	DEVMETHOD(device_attach,	bcm2835_audio_attach),
997 	DEVMETHOD(device_detach,	bcm2835_audio_detach),
998 	{ 0, 0 }
999 };
1000 
1001 static driver_t bcm2835_audio_driver = {
1002 	"pcm",
1003 	bcm2835_audio_methods,
1004 	PCM_SOFTC_SIZE,
1005 };
1006 
1007 DRIVER_MODULE(bcm2835_audio, vchiq, bcm2835_audio_driver, 0, 0);
1008 MODULE_DEPEND(bcm2835_audio, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
1009 MODULE_DEPEND(bcm2835_audio, vchiq, 1, 1, 1);
1010 MODULE_VERSION(bcm2835_audio, 1);
1011