channel.h revision 126367
1/*
2 * Copyright (c) 1999 Cameron Grant <cg@freebsd.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
26 * $FreeBSD: head/sys/dev/sound/pcm/channel.h 126367 2004-02-28 19:47:02Z truckman $
27 */
28
29struct pcmchan_children {
30	SLIST_ENTRY(pcmchan_children) link;
31	struct pcm_channel *channel;
32};
33
34struct pcmchan_caps {
35	u_int32_t minspeed, maxspeed;
36	u_int32_t *fmtlist;
37	u_int32_t caps;
38};
39
40#define	CHN_NAMELEN	32
41struct pcm_channel {
42	kobj_t methods;
43
44	int num;
45	pid_t pid;
46	int refcount;
47	struct pcm_feeder *feeder;
48	u_int32_t align;
49
50	int volume;
51	u_int32_t speed;
52	u_int32_t format;
53	u_int32_t flags;
54	u_int32_t feederflags;
55	u_int32_t blocks;
56
57	int direction;
58	unsigned int interrupts, xruns;
59	struct snd_dbuf *bufhard, *bufsoft;
60	struct snddev_info *parentsnddev;
61	struct pcm_channel *parentchannel;
62	void *devinfo;
63	device_t dev;
64	char name[CHN_NAMELEN];
65	struct mtx *lock;
66	SLIST_HEAD(, pcmchan_children) children;
67};
68
69#include "channel_if.h"
70
71int chn_reinit(struct pcm_channel *c);
72int chn_write(struct pcm_channel *c, struct uio *buf);
73int chn_read(struct pcm_channel *c, struct uio *buf);
74u_int32_t chn_start(struct pcm_channel *c, int force);
75int chn_sync(struct pcm_channel *c, int threshold);
76int chn_flush(struct pcm_channel *c);
77int chn_poll(struct pcm_channel *c, int ev, struct thread *td);
78
79int chn_init(struct pcm_channel *c, void *devinfo, int dir, int direction);
80int chn_kill(struct pcm_channel *c);
81int chn_setdir(struct pcm_channel *c, int dir);
82int chn_reset(struct pcm_channel *c, u_int32_t fmt);
83int chn_setvolume(struct pcm_channel *c, int left, int right);
84int chn_setspeed(struct pcm_channel *c, int speed);
85int chn_setformat(struct pcm_channel *c, u_int32_t fmt);
86int chn_setblocksize(struct pcm_channel *c, int blkcnt, int blksz);
87int chn_trigger(struct pcm_channel *c, int go);
88int chn_getptr(struct pcm_channel *c);
89struct pcmchan_caps *chn_getcaps(struct pcm_channel *c);
90u_int32_t chn_getformats(struct pcm_channel *c);
91
92void chn_resetbuf(struct pcm_channel *c);
93void chn_intr(struct pcm_channel *c);
94int chn_wrfeed(struct pcm_channel *c);
95int chn_rdfeed(struct pcm_channel *c);
96int chn_abort(struct pcm_channel *c);
97
98void chn_wrupdate(struct pcm_channel *c);
99void chn_rdupdate(struct pcm_channel *c);
100
101int chn_notify(struct pcm_channel *c, u_int32_t flags);
102void chn_lock(struct pcm_channel *c);
103void chn_unlock(struct pcm_channel *c);
104
105#ifdef	USING_MUTEX
106#define CHN_LOCK(c) mtx_lock((struct mtx *)((c)->lock))
107#define CHN_UNLOCK(c) mtx_unlock((struct mtx *)((c)->lock))
108#define CHN_LOCKASSERT(c) mtx_assert((struct mtx *)((c)->lock), MA_OWNED)
109#else
110#define CHN_LOCK(c)
111#define CHN_UNLOCK(c)
112#define CHN_LOCKASSERT(c)
113#endif
114
115int fmtvalid(u_int32_t fmt, u_int32_t *fmtlist);
116
117#define PCMDIR_VIRTUAL 2
118#define PCMDIR_PLAY 1
119#define PCMDIR_REC -1
120
121#define PCMTRIG_START 1
122#define PCMTRIG_EMLDMAWR 2
123#define PCMTRIG_EMLDMARD 3
124#define PCMTRIG_STOP 0
125#define PCMTRIG_ABORT -1
126
127#define CHN_F_CLOSING           0x00000004  /* a pending close */
128#define CHN_F_ABORTING          0x00000008  /* a pending abort */
129#define CHN_F_RUNNING		0x00000010  /* dma is running */
130#define CHN_F_TRIGGERED		0x00000020
131#define CHN_F_NOTRIGGER		0x00000040
132
133#define CHN_F_BUSY              0x00001000  /* has been opened 	*/
134#define	CHN_F_HAS_SIZE		0x00002000  /* user set block size */
135#define CHN_F_NBIO              0x00004000  /* do non-blocking i/o */
136#define CHN_F_MAPPED		0x00010000  /* has been mmap()ed */
137#define CHN_F_DEAD		0x00020000
138#define CHN_F_BADSETTING	0x00040000
139#define CHN_F_SETBLOCKSIZE	0x00080000
140
141#define	CHN_F_VIRTUAL		0x10000000  /* not backed by hardware */
142
143#define CHN_F_RESET		(CHN_F_BUSY | CHN_F_DEAD | CHN_F_VIRTUAL)
144
145#define CHN_N_RATE		0x00000001
146#define CHN_N_FORMAT		0x00000002
147#define CHN_N_VOLUME		0x00000004
148#define CHN_N_BLOCKSIZE		0x00000008
149#define CHN_N_TRIGGER		0x00000010
150
151/*
152 * This should be large enough to hold all pcm data between
153 * tsleeps in chn_{read,write} at the highest sample rate.
154 * (which is usually 48kHz * 16bit * stereo = 192000 bytes/sec)
155 */
156#define CHN_2NDBUFBLKSIZE	(2 * 1024)
157/* The total number of blocks per secondary bufhard. */
158#define CHN_2NDBUFBLKNUM	(32)
159/* The size of a whole secondary bufhard. */
160#define CHN_2NDBUFMAXSIZE	(131072)
161
162#define CHANNEL_DECLARE(name) static DEFINE_CLASS(name, name ## _methods, sizeof(struct kobj))
163