xref: /freebsd/sys/dev/sound/pcm/buffer.h (revision acd3428b7d3e94cef0e1881c868cb4b131d4ff41)
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$
27  */
28 
29 #define SND_DMA(b) (sndbuf_getflags((b)) & SNDBUF_F_DMA)
30 #define SNDBUF_LOCKASSERT(b)
31 
32 #define	SNDBUF_F_DMA		0x00000001
33 #define	SNDBUF_F_XRUN		0x00000002
34 #define	SNDBUF_F_RUNNING	0x00000004
35 
36 #define SNDBUF_NAMELEN	48
37 
38 struct snd_dbuf {
39 	device_t dev;
40 	u_int8_t *buf, *tmpbuf;
41 	u_int8_t *shadbuf; /**< shadow buffer used w/ S_D_SILENCE/SKIP */
42 	volatile int sl; /**< shadbuf ready length in # of bytes */
43 	unsigned int bufsize, maxsize;
44 	volatile int dl; /* transfer size */
45 	volatile int rp; /* pointers to the ready area */
46 	volatile int rl; /* length of ready area */
47 	volatile int hp;
48 	volatile u_int32_t total, prev_total;
49 	int dmachan, dir;       /* dma channel */
50 	u_int32_t fmt, spd, bps;
51 	unsigned int blksz, blkcnt;
52 	int xrun;
53 	u_int32_t flags;
54 	bus_dmamap_t dmamap;
55 	bus_dma_tag_t dmatag;
56 	u_int32_t buf_addr;
57 	struct selinfo sel;
58 	struct pcm_channel *channel;
59 	char name[SNDBUF_NAMELEN];
60 };
61 
62 struct snd_dbuf *sndbuf_create(device_t dev, char *drv, char *desc, struct pcm_channel *channel);
63 void sndbuf_destroy(struct snd_dbuf *b);
64 
65 void sndbuf_dump(struct snd_dbuf *b, char *s, u_int32_t what);
66 
67 int sndbuf_alloc(struct snd_dbuf *b, bus_dma_tag_t dmatag, unsigned int size);
68 int sndbuf_setup(struct snd_dbuf *b, void *buf, unsigned int size);
69 void sndbuf_free(struct snd_dbuf *b);
70 int sndbuf_resize(struct snd_dbuf *b, unsigned int blkcnt, unsigned int blksz);
71 int sndbuf_remalloc(struct snd_dbuf *b, unsigned int blkcnt, unsigned int blksz);
72 void sndbuf_reset(struct snd_dbuf *b);
73 void sndbuf_clear(struct snd_dbuf *b, unsigned int length);
74 void sndbuf_fillsilence(struct snd_dbuf *b);
75 void sndbuf_softreset(struct snd_dbuf *b);
76 void sndbuf_clearshadow(struct snd_dbuf *b);
77 
78 u_int32_t sndbuf_getfmt(struct snd_dbuf *b);
79 int sndbuf_setfmt(struct snd_dbuf *b, u_int32_t fmt);
80 unsigned int sndbuf_getspd(struct snd_dbuf *b);
81 void sndbuf_setspd(struct snd_dbuf *b, unsigned int spd);
82 unsigned int sndbuf_getbps(struct snd_dbuf *b);
83 
84 bus_addr_t sndbuf_getbufaddr(struct snd_dbuf *buf);
85 
86 void *sndbuf_getbuf(struct snd_dbuf *b);
87 void *sndbuf_getbufofs(struct snd_dbuf *b, unsigned int ofs);
88 unsigned int sndbuf_getsize(struct snd_dbuf *b);
89 unsigned int sndbuf_getmaxsize(struct snd_dbuf *b);
90 unsigned int sndbuf_getalign(struct snd_dbuf *b);
91 unsigned int sndbuf_getblkcnt(struct snd_dbuf *b);
92 void sndbuf_setblkcnt(struct snd_dbuf *b, unsigned int blkcnt);
93 unsigned int sndbuf_getblksz(struct snd_dbuf *b);
94 void sndbuf_setblksz(struct snd_dbuf *b, unsigned int blksz);
95 unsigned int sndbuf_runsz(struct snd_dbuf *b);
96 void sndbuf_setrun(struct snd_dbuf *b, int go);
97 struct selinfo *sndbuf_getsel(struct snd_dbuf *b);
98 
99 unsigned int sndbuf_getxrun(struct snd_dbuf *b);
100 void sndbuf_setxrun(struct snd_dbuf *b, unsigned int xrun);
101 unsigned int sndbuf_gethwptr(struct snd_dbuf *b);
102 void sndbuf_sethwptr(struct snd_dbuf *b, unsigned int ptr);
103 unsigned int sndbuf_getfree(struct snd_dbuf *b);
104 unsigned int sndbuf_getfreeptr(struct snd_dbuf *b);
105 unsigned int sndbuf_getready(struct snd_dbuf *b);
106 unsigned int sndbuf_getreadyptr(struct snd_dbuf *b);
107 unsigned int sndbuf_getblocks(struct snd_dbuf *b);
108 unsigned int sndbuf_getprevblocks(struct snd_dbuf *b);
109 unsigned int sndbuf_gettotal(struct snd_dbuf *b);
110 void sndbuf_updateprevtotal(struct snd_dbuf *b);
111 
112 int sndbuf_acquire(struct snd_dbuf *b, u_int8_t *from, unsigned int count);
113 int sndbuf_dispose(struct snd_dbuf *b, u_int8_t *to, unsigned int count);
114 int sndbuf_feed(struct snd_dbuf *from, struct snd_dbuf *to, struct pcm_channel *channel, struct pcm_feeder *feeder, unsigned int count);
115 
116 u_int32_t sndbuf_getflags(struct snd_dbuf *b);
117 void sndbuf_setflags(struct snd_dbuf *b, u_int32_t flags, int on);
118 
119 int sndbuf_dmasetup(struct snd_dbuf *b, struct resource *drq);
120 int sndbuf_dmasetdir(struct snd_dbuf *b, int dir);
121 void sndbuf_dma(struct snd_dbuf *b, int go);
122 int sndbuf_dmaptr(struct snd_dbuf *b);
123 void sndbuf_dmabounce(struct snd_dbuf *b);
124 
125 #ifdef OSSV4_EXPERIMENT
126 void sndbuf_getpeaks(struct snd_dbuf *b, int *lp, int *rp);
127 #endif
128