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