channel.h revision 330897 
1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
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>
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
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.
17 *
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
28 * SUCH DAMAGE.
29 *
30 * $FreeBSD: stable/11/sys/dev/sound/pcm/channel.h 330897 2018-03-14 03:19:51Z eadler $
31 */
32
33struct pcmchan_caps {
34	u_int32_t minspeed, maxspeed;
35	u_int32_t *fmtlist;
36	u_int32_t caps;
37};
38
39struct pcmchan_matrix {
40	int id;
41	uint8_t channels, ext;
42	struct {
43		int type;
44		uint32_t members;
45	} map[SND_CHN_T_MAX + 1];
46	uint32_t mask;
47	int8_t offset[SND_CHN_T_MAX];
48};
49
50/* Forward declarations */
51struct pcm_channel;
52struct pcmchan_syncgroup;
53struct pcmchan_syncmember;
54
55extern struct mtx snd_pcm_syncgroups_mtx;
56extern SLIST_HEAD(pcm_synclist, pcmchan_syncgroup) snd_pcm_syncgroups;
57
58#define PCM_SG_LOCK()	    mtx_lock(&snd_pcm_syncgroups_mtx)
59#define PCM_SG_TRYLOCK()    mtx_trylock(&snd_pcm_syncgroups_mtx)
60#define PCM_SG_UNLOCK()	    mtx_unlock(&snd_pcm_syncgroups_mtx)
61#define PCM_SG_LOCKASSERT(arg)	mtx_assert(&snd_pcm_syncgroups_mtx, arg)
62
63/**
64 * @brief Specifies an audio device sync group
65 */
66struct pcmchan_syncgroup {
67	SLIST_ENTRY(pcmchan_syncgroup) link;
68	SLIST_HEAD(, pcmchan_syncmember) members;
69	int id; /**< Group identifier; set to address of group. */
70};
71
72/**
73 * @brief Specifies a container for members of a sync group
74 */
75struct pcmchan_syncmember {
76	SLIST_ENTRY(pcmchan_syncmember) link;
77	struct pcmchan_syncgroup *parent; /**< group head */
78	struct pcm_channel *ch;
79};
80
81#define	CHN_NAMELEN		32
82#define	CHN_COMM_UNUSED		"<UNUSED>"
83#define	CHN_COMM_UNKNOWN	"<UNKNOWN>"
84
85struct pcm_channel {
86	kobj_t methods;
87
88	pid_t pid;
89	int refcount;
90	struct pcm_feeder *feeder;
91	u_int32_t align;
92
93	int latency;
94	u_int32_t speed;
95	u_int32_t format;
96	u_int32_t flags;
97	u_int32_t feederflags;
98	u_int64_t blocks;
99
100	int direction;
101	unsigned int interrupts, xruns, feedcount;
102	unsigned int timeout;
103	struct snd_dbuf *bufhard, *bufsoft;
104	struct snddev_info *parentsnddev;
105	struct pcm_channel *parentchannel;
106	void *devinfo;
107	device_t dev;
108	int unit;
109	char name[CHN_NAMELEN];
110	char comm[MAXCOMLEN + 1];
111	struct mtx *lock;
112	int trigger;
113	/**
114	 * For interrupt manipulations.
115	 */
116	struct cv intr_cv;
117	/**
118	 * Increment,decrement this around operations that temporarily yield
119	 * lock.
120	 */
121	unsigned int inprog;
122	/**
123	 * Special channel operations should examine @c inprog after acquiring
124	 * lock.  If zero, operations may continue.  Else, thread should
125	 * wait on this cv for previous operation to finish.
126	 */
127	struct cv cv;
128	/**
129	 * Low water mark for select()/poll().
130	 *
131	 * This is initialized to the channel's fragment size, and will be
132	 * overwritten if a new fragment size is set.  Users may alter this
133	 * value directly with the @c SNDCTL_DSP_LOW_WATER ioctl.
134	 */
135	unsigned int lw;
136	/**
137	 * If part of a sync group, this will point to the syncmember
138	 * container.
139	 */
140	struct pcmchan_syncmember *sm;
141#ifdef OSSV4_EXPERIMENT
142	u_int16_t lpeak, rpeak;	/**< Peak value from 0-32767. */
143#endif
144
145	struct {
146		SLIST_HEAD(, pcm_channel) head;
147		SLIST_ENTRY(pcm_channel) link;
148		struct {
149			SLIST_HEAD(, pcm_channel) head;
150			SLIST_ENTRY(pcm_channel) link;
151		} busy;
152	} children;
153
154	struct {
155		struct {
156			SLIST_ENTRY(pcm_channel) link;
157			struct {
158				SLIST_ENTRY(pcm_channel) link;
159			} busy;
160			struct {
161				SLIST_ENTRY(pcm_channel) link;
162			} opened;
163		} pcm;
164	} channels;
165
166	struct pcmchan_matrix matrix;
167  	struct pcmchan_matrix matrix_scratch;
168
169	int volume[SND_VOL_C_MAX][SND_CHN_T_VOL_MAX];
170
171	void *data1, *data2;
172};
173
174#define CHN_HEAD(x, y)			&(x)->y.head
175#define CHN_INIT(x, y)			SLIST_INIT(CHN_HEAD(x, y))
176#define CHN_LINK(y)			y.link
177#define CHN_EMPTY(x, y)			SLIST_EMPTY(CHN_HEAD(x, y))
178#define CHN_FIRST(x, y)			SLIST_FIRST(CHN_HEAD(x, y))
179
180#define CHN_FOREACH(x, y, z)						\
181	SLIST_FOREACH(x, CHN_HEAD(y, z), CHN_LINK(z))
182
183#define CHN_FOREACH_SAFE(w, x, y, z)					\
184	SLIST_FOREACH_SAFE(w, CHN_HEAD(x, z), CHN_LINK(z), y)
185
186#define CHN_INSERT_HEAD(x, y, z)					\
187	SLIST_INSERT_HEAD(CHN_HEAD(x, z), y, CHN_LINK(z))
188
189#define CHN_INSERT_AFTER(x, y, z)					\
190	SLIST_INSERT_AFTER(x, y, CHN_LINK(z))
191
192#define CHN_REMOVE(x, y, z)						\
193	SLIST_REMOVE(CHN_HEAD(x, z), y, pcm_channel, CHN_LINK(z))
194
195#define CHN_INSERT_HEAD_SAFE(x, y, z)		do {			\
196	struct pcm_channel *t = NULL;					\
197	CHN_FOREACH(t, x, z) {						\
198		if (t == y)						\
199			break;						\
200	} 								\
201	if (t != y)							\
202		CHN_INSERT_HEAD(x, y, z);				\
203} while (0)
204
205#define CHN_INSERT_AFTER_SAFE(w, x, y, z)	do {			\
206	struct pcm_channel *t = NULL;					\
207	CHN_FOREACH(t, w, z) {						\
208		if (t == y)						\
209			break;						\
210	} 								\
211	if (t != y)							\
212		CHN_INSERT_AFTER(x, y, z);				\
213} while (0)
214
215#define CHN_REMOVE_SAFE(x, y, z)		do {			\
216	struct pcm_channel *t = NULL;					\
217	CHN_FOREACH(t, x, z) {						\
218		if (t == y)						\
219			break;						\
220	} 								\
221	if (t == y)							\
222		CHN_REMOVE(x, y, z);					\
223} while (0)
224
225#define CHN_INSERT_SORT(w, x, y, z)		do {			\
226	struct pcm_channel *t, *a = NULL;				\
227	CHN_FOREACH(t, x, z) {						\
228		if ((y)->unit w t->unit)				\
229			a = t;						\
230		else							\
231			break;						\
232	}								\
233	if (a != NULL)							\
234		CHN_INSERT_AFTER(a, y, z);				\
235	else								\
236		CHN_INSERT_HEAD(x, y, z);				\
237} while (0)
238
239#define CHN_INSERT_SORT_ASCEND(x, y, z)		CHN_INSERT_SORT(>, x, y, z)
240#define CHN_INSERT_SORT_DESCEND(x, y, z)	CHN_INSERT_SORT(<, x, y, z)
241
242#define CHN_UNIT(x)	(snd_unit2u((x)->unit))
243#define CHN_DEV(x)	(snd_unit2d((x)->unit))
244#define CHN_CHAN(x)	(snd_unit2c((x)->unit))
245
246#define CHN_BUF_PARENT(x, y)						\
247	(((x) != NULL && (x)->parentchannel != NULL &&			\
248	(x)->parentchannel->bufhard != NULL) ?				\
249	(x)->parentchannel->bufhard : (y))
250
251#define CHN_BROADCAST(x)	do {					\
252	if ((x)->cv_waiters != 0)					\
253		cv_broadcastpri(x, PRIBIO);				\
254} while (0)
255
256#include "channel_if.h"
257
258int chn_reinit(struct pcm_channel *c);
259int chn_write(struct pcm_channel *c, struct uio *buf);
260int chn_read(struct pcm_channel *c, struct uio *buf);
261u_int32_t chn_start(struct pcm_channel *c, int force);
262int chn_sync(struct pcm_channel *c, int threshold);
263int chn_flush(struct pcm_channel *c);
264int chn_poll(struct pcm_channel *c, int ev, struct thread *td);
265
266int chn_init(struct pcm_channel *c, void *devinfo, int dir, int direction);
267int chn_kill(struct pcm_channel *c);
268int chn_reset(struct pcm_channel *c, u_int32_t fmt, u_int32_t spd);
269int chn_setvolume(struct pcm_channel *c, int left, int right);
270int chn_setvolume_multi(struct pcm_channel *c, int vc, int left, int right,
271    int center);
272int chn_setvolume_matrix(struct pcm_channel *c, int vc, int vt, int val);
273int chn_getvolume_matrix(struct pcm_channel *c, int vc, int vt);
274void chn_vpc_reset(struct pcm_channel *c, int vc, int force);
275int chn_setparam(struct pcm_channel *c, uint32_t format, uint32_t speed);
276int chn_setspeed(struct pcm_channel *c, uint32_t speed);
277int chn_setformat(struct pcm_channel *c, uint32_t format);
278int chn_setblocksize(struct pcm_channel *c, int blkcnt, int blksz);
279int chn_setlatency(struct pcm_channel *c, int latency);
280void chn_syncstate(struct pcm_channel *c);
281int chn_trigger(struct pcm_channel *c, int go);
282int chn_getptr(struct pcm_channel *c);
283struct pcmchan_caps *chn_getcaps(struct pcm_channel *c);
284u_int32_t chn_getformats(struct pcm_channel *c);
285
286struct pcmchan_matrix *chn_getmatrix(struct pcm_channel *);
287int chn_setmatrix(struct pcm_channel *, struct pcmchan_matrix *);
288
289int chn_oss_getorder(struct pcm_channel *, unsigned long long *);
290int chn_oss_setorder(struct pcm_channel *, unsigned long long *);
291int chn_oss_getmask(struct pcm_channel *, uint32_t *);
292
293void chn_resetbuf(struct pcm_channel *c);
294void chn_intr_locked(struct pcm_channel *c);
295void chn_intr(struct pcm_channel *c);
296int chn_abort(struct pcm_channel *c);
297
298int chn_notify(struct pcm_channel *c, u_int32_t flags);
299
300int chn_getrates(struct pcm_channel *c, int **rates);
301int chn_syncdestroy(struct pcm_channel *c);
302
303#define CHN_SETVOLUME(...)		chn_setvolume_matrix(__VA_ARGS__)
304#if defined(SND_DIAGNOSTIC) || defined(INVARIANTS)
305#define CHN_GETVOLUME(...)		chn_getvolume_matrix(__VA_ARGS__)
306#else
307#define CHN_GETVOLUME(x, y, z)		((x)->volume[y][z])
308#endif
309
310#ifdef OSSV4_EXPERIMENT
311int chn_getpeaks(struct pcm_channel *c, int *lpeak, int *rpeak);
312#endif
313
314#define CHN_LOCKOWNED(c)	mtx_owned((c)->lock)
315#define CHN_LOCK(c)		mtx_lock((c)->lock)
316#define CHN_UNLOCK(c)		mtx_unlock((c)->lock)
317#define CHN_TRYLOCK(c)		mtx_trylock((c)->lock)
318#define CHN_LOCKASSERT(c)	mtx_assert((c)->lock, MA_OWNED)
319#define CHN_UNLOCKASSERT(c)	mtx_assert((c)->lock, MA_NOTOWNED)
320
321int snd_fmtvalid(uint32_t fmt, uint32_t *fmtlist);
322
323uint32_t snd_str2afmt(const char *);
324uint32_t snd_afmt2str(uint32_t, char *, size_t);
325
326#define AFMTSTR_LEN	16
327
328
329extern int chn_latency;
330extern int chn_latency_profile;
331extern int report_soft_formats;
332extern int report_soft_matrix;
333
334#define PCMDIR_PLAY		1
335#define PCMDIR_PLAY_VIRTUAL	2
336#define PCMDIR_REC		-1
337#define PCMDIR_REC_VIRTUAL	-2
338
339#define PCMTRIG_START 1
340#define PCMTRIG_EMLDMAWR 2
341#define PCMTRIG_EMLDMARD 3
342#define PCMTRIG_STOP 0
343#define PCMTRIG_ABORT -1
344
345#define PCMTRIG_COMMON(x)	((x) == PCMTRIG_START ||		\
346				 (x) == PCMTRIG_STOP ||			\
347				 (x) == PCMTRIG_ABORT)
348
349#define CHN_F_CLOSING           0x00000001  /* a pending close */
350#define CHN_F_ABORTING          0x00000002  /* a pending abort */
351#define CHN_F_RUNNING		0x00000004  /* dma is running */
352#define CHN_F_TRIGGERED		0x00000008
353#define CHN_F_NOTRIGGER		0x00000010
354#define CHN_F_SLEEPING		0x00000020
355
356#define CHN_F_NBIO              0x00000040  /* do non-blocking i/o */
357#define CHN_F_MMAP		0x00000080  /* has been mmap()ed */
358
359#define CHN_F_BUSY              0x00000100  /* has been opened 	*/
360#define CHN_F_DIRTY		0x00000200  /* need re-config */
361#define CHN_F_DEAD		0x00000400  /* too many errors, dead, mdk */
362#define CHN_F_SILENCE		0x00000800  /* silence, nil, null, yada */
363
364#define	CHN_F_HAS_SIZE		0x00001000  /* user set block size */
365#define CHN_F_HAS_VCHAN		0x00002000  /* vchan master */
366
367#define CHN_F_VCHAN_PASSTHROUGH	0x00004000  /* digital ac3/dts passthrough */
368#define CHN_F_VCHAN_ADAPTIVE	0x00008000  /* adaptive format/rate selection */
369#define CHN_F_VCHAN_DYNAMIC	(CHN_F_VCHAN_PASSTHROUGH | CHN_F_VCHAN_ADAPTIVE)
370
371#define	CHN_F_VIRTUAL		0x10000000  /* not backed by hardware */
372#define CHN_F_BITPERFECT	0x20000000  /* un-cooked, Heh.. */
373#define CHN_F_PASSTHROUGH	0x40000000  /* passthrough re-config */
374#define CHN_F_EXCLUSIVE		0x80000000  /* exclusive access */
375
376#define CHN_F_BITS		"\020"					\
377				"\001CLOSING"				\
378				"\002ABORTING"				\
379				"\003RUNNING"				\
380				"\004TRIGGERED"				\
381				"\005NOTRIGGER"				\
382				"\006SLEEPING"				\
383				"\007NBIO"				\
384				"\010MMAP"				\
385				"\011BUSY"				\
386				"\012DIRTY"				\
387				"\013DEAD"				\
388				"\014SILENCE"				\
389				"\015HAS_SIZE"				\
390				"\016HAS_VCHAN"				\
391				"\017VCHAN_PASSTHROUGH"			\
392				"\020VCHAN_ADAPTIVE"			\
393				"\035VIRTUAL"				\
394				"\036BITPERFECT"			\
395				"\037PASSTHROUGH"			\
396				"\040EXCLUSIVE"
397
398
399#define CHN_F_RESET		(CHN_F_BUSY | CHN_F_DEAD |		\
400				 CHN_F_VIRTUAL | CHN_F_HAS_VCHAN |	\
401				 CHN_F_VCHAN_DYNAMIC |			\
402				 CHN_F_PASSTHROUGH | CHN_F_EXCLUSIVE)
403
404#define CHN_F_MMAP_INVALID	(CHN_F_DEAD | CHN_F_RUNNING)
405
406
407
408#define CHN_N_RATE		0x00000001
409#define CHN_N_FORMAT		0x00000002
410#define CHN_N_VOLUME		0x00000004
411#define CHN_N_BLOCKSIZE		0x00000008
412#define CHN_N_TRIGGER		0x00000010
413
414#define CHN_LATENCY_MIN		0
415#define CHN_LATENCY_MAX		10
416#define CHN_LATENCY_DEFAULT	5
417#define CHN_POLICY_MIN		CHN_LATENCY_MIN
418#define CHN_POLICY_MAX		CHN_LATENCY_MAX
419#define CHN_POLICY_DEFAULT	CHN_LATENCY_DEFAULT
420
421#define CHN_LATENCY_PROFILE_MIN		0
422#define CHN_LATENCY_PROFILE_MAX		1
423#define CHN_LATENCY_PROFILE_DEFAULT	CHN_LATENCY_PROFILE_MAX
424
425#define CHN_STARTED(c)		((c)->flags & CHN_F_TRIGGERED)
426#define CHN_STOPPED(c)		(!CHN_STARTED(c))
427#define CHN_DIRSTR(c)		(((c)->direction == PCMDIR_PLAY) ? \
428				"PCMDIR_PLAY" : "PCMDIR_REC")
429#define CHN_BITPERFECT(c)	((c)->flags & CHN_F_BITPERFECT)
430#define CHN_PASSTHROUGH(c)	((c)->flags & CHN_F_PASSTHROUGH)
431
432#define CHN_TIMEOUT		5
433#define CHN_TIMEOUT_MIN		1
434#define CHN_TIMEOUT_MAX		10
435
436/*
437 * This should be large enough to hold all pcm data between
438 * tsleeps in chn_{read,write} at the highest sample rate.
439 * (which is usually 48kHz * 16bit * stereo = 192000 bytes/sec)
440 */
441#define CHN_2NDBUFBLKSIZE	(2 * 1024)
442/* The total number of blocks per secondary bufhard. */
443#define CHN_2NDBUFBLKNUM	(32)
444/* The size of a whole secondary bufhard. */
445#define CHN_2NDBUFMAXSIZE	(131072)
446
447#define CHANNEL_DECLARE(name) static DEFINE_CLASS(name, name ## _methods, sizeof(struct kobj))
448