xref: /freebsd/sys/dev/sound/pcm/buffer.h (revision af23369a6deaaeb612ab266eb88b8bb8d560c322)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
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  * $FreeBSD$
29  */
30 
31 #define SNDBUF_LOCKASSERT(b)
32 
33 #define	SNDBUF_F_MANAGED	0x00000008
34 
35 #define SNDBUF_NAMELEN	48
36 
37 struct snd_dbuf {
38 	device_t dev;
39 	u_int8_t *buf, *tmpbuf;
40 	u_int8_t *shadbuf; /**< shadow buffer used w/ S_D_SILENCE/SKIP */
41 	volatile int sl; /**< shadbuf ready length in # of bytes */
42 	unsigned int bufsize, maxsize, allocsize;
43 	volatile int dl; /* transfer size */
44 	volatile int rp; /* pointers to the ready area */
45 	volatile int rl; /* length of ready area */
46 	volatile int hp;
47 	volatile u_int64_t total, prev_total;
48 	int dmachan, dir;       /* dma channel */
49 	u_int32_t fmt, spd, bps, align;
50 	unsigned int blksz, blkcnt;
51 	int xrun;
52 	u_int32_t flags;
53 	bus_dmamap_t dmamap;
54 	bus_dma_tag_t dmatag;
55 	bus_addr_t buf_addr;
56 	int dmaflags;
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, int dmaflags, 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_fillsilence_rl(struct snd_dbuf *b, u_int rl);
76 void sndbuf_softreset(struct snd_dbuf *b);
77 void sndbuf_clearshadow(struct snd_dbuf *b);
78 
79 u_int32_t sndbuf_getfmt(struct snd_dbuf *b);
80 int sndbuf_setfmt(struct snd_dbuf *b, u_int32_t fmt);
81 unsigned int sndbuf_getspd(struct snd_dbuf *b);
82 void sndbuf_setspd(struct snd_dbuf *b, unsigned int spd);
83 unsigned int sndbuf_getbps(struct snd_dbuf *b);
84 
85 bus_addr_t sndbuf_getbufaddr(struct snd_dbuf *buf);
86 
87 void *sndbuf_getbuf(struct snd_dbuf *b);
88 void *sndbuf_getbufofs(struct snd_dbuf *b, unsigned int ofs);
89 unsigned int sndbuf_getsize(struct snd_dbuf *b);
90 unsigned int sndbuf_getmaxsize(struct snd_dbuf *b);
91 unsigned int sndbuf_getallocsize(struct snd_dbuf *b);
92 unsigned int sndbuf_getalign(struct snd_dbuf *b);
93 unsigned int sndbuf_getblkcnt(struct snd_dbuf *b);
94 void sndbuf_setblkcnt(struct snd_dbuf *b, unsigned int blkcnt);
95 unsigned int sndbuf_getblksz(struct snd_dbuf *b);
96 void sndbuf_setblksz(struct snd_dbuf *b, unsigned int blksz);
97 unsigned int sndbuf_runsz(struct snd_dbuf *b);
98 void sndbuf_setrun(struct snd_dbuf *b, int go);
99 struct selinfo *sndbuf_getsel(struct snd_dbuf *b);
100 
101 unsigned int sndbuf_getxrun(struct snd_dbuf *b);
102 void sndbuf_setxrun(struct snd_dbuf *b, unsigned int xrun);
103 unsigned int sndbuf_gethwptr(struct snd_dbuf *b);
104 void sndbuf_sethwptr(struct snd_dbuf *b, unsigned int ptr);
105 unsigned int sndbuf_getfree(struct snd_dbuf *b);
106 unsigned int sndbuf_getfreeptr(struct snd_dbuf *b);
107 unsigned int sndbuf_getready(struct snd_dbuf *b);
108 unsigned int sndbuf_getreadyptr(struct snd_dbuf *b);
109 u_int64_t sndbuf_getblocks(struct snd_dbuf *b);
110 u_int64_t sndbuf_getprevblocks(struct snd_dbuf *b);
111 u_int64_t sndbuf_gettotal(struct snd_dbuf *b);
112 u_int64_t sndbuf_getprevtotal(struct snd_dbuf *b);
113 unsigned int sndbuf_xbytes(unsigned int v, struct snd_dbuf *from, struct snd_dbuf *to);
114 u_int8_t sndbuf_zerodata(u_int32_t fmt);
115 void sndbuf_updateprevtotal(struct snd_dbuf *b);
116 
117 int sndbuf_acquire(struct snd_dbuf *b, u_int8_t *from, unsigned int count);
118 int sndbuf_dispose(struct snd_dbuf *b, u_int8_t *to, unsigned int count);
119 int sndbuf_feed(struct snd_dbuf *from, struct snd_dbuf *to, struct pcm_channel *channel, struct pcm_feeder *feeder, unsigned int count);
120 
121 u_int32_t sndbuf_getflags(struct snd_dbuf *b);
122 void sndbuf_setflags(struct snd_dbuf *b, u_int32_t flags, int on);
123 
124 #ifdef OSSV4_EXPERIMENT
125 void sndbuf_getpeaks(struct snd_dbuf *b, int *lp, int *rp);
126 #endif
127 
128 static inline u_int32_t
129 snd_xbytes(u_int32_t v, u_int32_t from, u_int32_t to)
130 {
131 
132 	if (from == to)
133 		return (v);
134 	if (from == 0)
135 		return (0);
136 	return ((u_int64_t)v * to / from);
137 }
138