xref: /freebsd/sys/dev/sound/pcm/buffer.h (revision 6524d2a5affd02623e6909fff0ca03ba21882a0c)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 1999 Cameron Grant <cg@freebsd.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #define	SNDBUF_F_MANAGED	0x00000008
30 
31 #define SNDBUF_NAMELEN	48
32 
33 struct snd_dbuf {
34 	device_t dev;
35 	u_int8_t *buf, *tmpbuf;
36 	u_int8_t *shadbuf; /**< shadow buffer used w/ S_D_SILENCE/SKIP */
37 	volatile int sl; /**< shadbuf ready length in # of bytes */
38 	unsigned int bufsize, maxsize, allocsize;
39 	volatile int dl; /* transfer size */
40 	volatile int rp; /* pointers to the ready area */
41 	volatile int rl; /* length of ready area */
42 	volatile int hp;
43 	volatile u_int64_t total, prev_total;
44 	int dmachan, dir;       /* dma channel */
45 	u_int32_t fmt, spd, bps, align;
46 	unsigned int blksz, blkcnt;
47 	int xrun;
48 	u_int32_t flags;
49 	bus_dmamap_t dmamap;
50 	bus_dma_tag_t dmatag;
51 	bus_addr_t buf_addr;
52 	int dmaflags;
53 	struct selinfo sel;
54 	struct pcm_channel *channel;
55 	char name[SNDBUF_NAMELEN];
56 };
57 
58 struct snd_dbuf *sndbuf_create(device_t dev, char *drv, char *desc, struct pcm_channel *channel);
59 void sndbuf_destroy(struct snd_dbuf *b);
60 
61 void sndbuf_dump(struct snd_dbuf *b, char *s, u_int32_t what);
62 
63 int sndbuf_alloc(struct snd_dbuf *b, bus_dma_tag_t dmatag, int dmaflags, unsigned int size);
64 int sndbuf_setup(struct snd_dbuf *b, void *buf, unsigned int size);
65 void sndbuf_free(struct snd_dbuf *b);
66 int sndbuf_resize(struct snd_dbuf *b, unsigned int blkcnt, unsigned int blksz);
67 int sndbuf_remalloc(struct snd_dbuf *b, unsigned int blkcnt, unsigned int blksz);
68 void sndbuf_reset(struct snd_dbuf *b);
69 void sndbuf_clear(struct snd_dbuf *b, unsigned int length);
70 void sndbuf_fillsilence(struct snd_dbuf *b);
71 void sndbuf_fillsilence_rl(struct snd_dbuf *b, u_int rl);
72 void sndbuf_softreset(struct snd_dbuf *b);
73 void sndbuf_clearshadow(struct snd_dbuf *b);
74 
75 u_int32_t sndbuf_getfmt(struct snd_dbuf *b);
76 int sndbuf_setfmt(struct snd_dbuf *b, u_int32_t fmt);
77 unsigned int sndbuf_getspd(struct snd_dbuf *b);
78 void sndbuf_setspd(struct snd_dbuf *b, unsigned int spd);
79 unsigned int sndbuf_getbps(struct snd_dbuf *b);
80 
81 bus_addr_t sndbuf_getbufaddr(struct snd_dbuf *buf);
82 
83 void *sndbuf_getbuf(struct snd_dbuf *b);
84 void *sndbuf_getbufofs(struct snd_dbuf *b, unsigned int ofs);
85 unsigned int sndbuf_getsize(struct snd_dbuf *b);
86 unsigned int sndbuf_getmaxsize(struct snd_dbuf *b);
87 unsigned int sndbuf_getallocsize(struct snd_dbuf *b);
88 unsigned int sndbuf_getalign(struct snd_dbuf *b);
89 unsigned int sndbuf_getblkcnt(struct snd_dbuf *b);
90 void sndbuf_setblkcnt(struct snd_dbuf *b, unsigned int blkcnt);
91 unsigned int sndbuf_getblksz(struct snd_dbuf *b);
92 void sndbuf_setblksz(struct snd_dbuf *b, unsigned int blksz);
93 unsigned int sndbuf_runsz(struct snd_dbuf *b);
94 void sndbuf_setrun(struct snd_dbuf *b, int go);
95 struct selinfo *sndbuf_getsel(struct snd_dbuf *b);
96 
97 unsigned int sndbuf_getxrun(struct snd_dbuf *b);
98 void sndbuf_setxrun(struct snd_dbuf *b, unsigned int xrun);
99 unsigned int sndbuf_gethwptr(struct snd_dbuf *b);
100 void sndbuf_sethwptr(struct snd_dbuf *b, unsigned int ptr);
101 unsigned int sndbuf_getfree(struct snd_dbuf *b);
102 unsigned int sndbuf_getfreeptr(struct snd_dbuf *b);
103 unsigned int sndbuf_getready(struct snd_dbuf *b);
104 unsigned int sndbuf_getreadyptr(struct snd_dbuf *b);
105 u_int64_t sndbuf_getblocks(struct snd_dbuf *b);
106 u_int64_t sndbuf_getprevblocks(struct snd_dbuf *b);
107 u_int64_t sndbuf_gettotal(struct snd_dbuf *b);
108 u_int64_t sndbuf_getprevtotal(struct snd_dbuf *b);
109 unsigned int sndbuf_xbytes(unsigned int v, struct snd_dbuf *from, struct snd_dbuf *to);
110 u_int8_t sndbuf_zerodata(u_int32_t fmt);
111 void sndbuf_updateprevtotal(struct snd_dbuf *b);
112 
113 int sndbuf_acquire(struct snd_dbuf *b, u_int8_t *from, unsigned int count);
114 int sndbuf_dispose(struct snd_dbuf *b, u_int8_t *to, unsigned int count);
115 int sndbuf_feed(struct snd_dbuf *from, struct snd_dbuf *to, struct pcm_channel *channel, struct pcm_feeder *feeder, unsigned int count);
116 
117 u_int32_t sndbuf_getflags(struct snd_dbuf *b);
118 void sndbuf_setflags(struct snd_dbuf *b, u_int32_t flags, int on);
119 
120 #ifdef OSSV4_EXPERIMENT
121 void sndbuf_getpeaks(struct snd_dbuf *b, int *lp, int *rp);
122 #endif
123 
124 static inline u_int32_t
snd_xbytes(u_int32_t v,u_int32_t from,u_int32_t to)125 snd_xbytes(u_int32_t v, u_int32_t from, u_int32_t to)
126 {
127 
128 	if (from == to)
129 		return (v);
130 	if (from == 0)
131 		return (0);
132 	return ((u_int64_t)v * to / from);
133 }
134