xref: /freebsd/sys/dev/sound/pci/hda/hdac_private.h (revision 0efd6615cd5f39b67cec82a7034e655f3b5801e3)
1 /*-
2  * Copyright (c) 2006 Stephane E. Potvin <sepotvin@videotron.ca>
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 #ifndef _HDAC_PRIVATE_H_
30 #define _HDAC_PRIVATE_H_
31 
32 
33 /****************************************************************************
34  * Miscellanious defines
35  ****************************************************************************/
36 #define HDAC_DMA_ALIGNMENT	128
37 #define HDAC_CODEC_MAX		16
38 
39 #define HDAC_MTX_NAME		"hdac driver mutex"
40 
41 /****************************************************************************
42  * Helper Macros
43  ****************************************************************************/
44 #define HDAC_READ_1(mem, offset)					\
45 	bus_space_read_1((mem)->mem_tag, (mem)->mem_handle, (offset))
46 #define HDAC_READ_2(mem, offset)					\
47 	bus_space_read_2((mem)->mem_tag, (mem)->mem_handle, (offset))
48 #define HDAC_READ_4(mem, offset)					\
49 	bus_space_read_4((mem)->mem_tag, (mem)->mem_handle, (offset))
50 #define HDAC_WRITE_1(mem, offset, value)				\
51 	bus_space_write_1((mem)->mem_tag, (mem)->mem_handle, (offset), (value))
52 #define HDAC_WRITE_2(mem, offset, value)				\
53 	bus_space_write_2((mem)->mem_tag, (mem)->mem_handle, (offset), (value))
54 #define HDAC_WRITE_4(mem, offset, value)				\
55 	bus_space_write_4((mem)->mem_tag, (mem)->mem_handle, (offset), (value))
56 
57 #define HDAC_ISDCTL(sc, n)	(_HDAC_ISDCTL((n), (sc)->num_iss, (sc)->num_oss))
58 #define HDAC_ISDSTS(sc, n)	(_HDAC_ISDSTS((n), (sc)->num_iss, (sc)->num_oss))
59 #define HDAC_ISDPICB(sc, n)	(_HDAC_ISDPICB((n), (sc)->num_iss, (sc)->num_oss))
60 #define HDAC_ISDCBL(sc, n)	(_HDAC_ISDCBL((n), (sc)->num_iss, (sc)->num_oss))
61 #define HDAC_ISDLVI(sc, n)	(_HDAC_ISDLVI((n), (sc)->num_iss, (sc)->num_oss))
62 #define HDAC_ISDFIFOD(sc, n)	(_HDAC_ISDFIFOD((n), (sc)->num_iss, (sc)->num_oss))
63 #define HDAC_ISDFMT(sc, n)	(_HDAC_ISDFMT((n), (sc)->num_iss, (sc)->num_oss))
64 #define HDAC_ISDBDPL(sc, n)	(_HDAC_ISDBDPL((n), (sc)->num_iss, (sc)->num_oss))
65 #define HDAC_ISDBDPU(sc, n)	(_HDAC_ISDBDPU((n), (sc)->num_iss, (sc)->num_oss))
66 
67 #define HDAC_OSDCTL(sc, n)	(_HDAC_OSDCTL((n), (sc)->num_iss, (sc)->num_oss))
68 #define HDAC_OSDSTS(sc, n)	(_HDAC_OSDSTS((n), (sc)->num_iss, (sc)->num_oss))
69 #define HDAC_OSDPICB(sc, n)	(_HDAC_OSDPICB((n), (sc)->num_iss, (sc)->num_oss))
70 #define HDAC_OSDCBL(sc, n)	(_HDAC_OSDCBL((n), (sc)->num_iss, (sc)->num_oss))
71 #define HDAC_OSDLVI(sc, n)	(_HDAC_OSDLVI((n), (sc)->num_iss, (sc)->num_oss))
72 #define HDAC_OSDFIFOD(sc, n)	(_HDAC_OSDFIFOD((n), (sc)->num_iss, (sc)->num_oss))
73 #define HDAC_OSDBDPL(sc, n)	(_HDAC_OSDBDPL((n), (sc)->num_iss, (sc)->num_oss))
74 #define HDAC_OSDBDPU(sc, n)	(_HDAC_OSDBDPU((n), (sc)->num_iss, (sc)->num_oss))
75 
76 #define HDAC_BSDCTL(sc, n)	(_HDAC_BSDCTL((n), (sc)->num_iss, (sc)->num_oss))
77 #define HDAC_BSDSTS(sc, n)	(_HDAC_BSDSTS((n), (sc)->num_iss, (sc)->num_oss))
78 #define HDAC_BSDPICB(sc, n)	(_HDAC_BSDPICB((n), (sc)->num_iss, (sc)->num_oss))
79 #define HDAC_BSDCBL(sc, n)	(_HDAC_BSDCBL((n), (sc)->num_iss, (sc)->num_oss))
80 #define HDAC_BSDLVI(sc, n)	(_HDAC_BSDLVI((n), (sc)->num_iss, (sc)->num_oss))
81 #define HDAC_BSDFIFOD(sc, n)	(_HDAC_BSDFIFOD((n), (sc)->num_iss, (sc)->num_oss))
82 #define HDAC_BSDBDPL(sc, n)	(_HDAC_BSDBDPL((n), (sc)->num_iss, (sc)->num_oss))
83 #define HDAC_BSDBDPU(sc, n)	(_HDAC_BSDBDPU((n), (sc)->num_iss, (sc)->num_oss))
84 
85 
86 /****************************************************************************
87  * Custom hdac malloc type
88  ****************************************************************************/
89 MALLOC_DECLARE(M_HDAC);
90 
91 /****************************************************************************
92  * struct hdac_mem
93  *
94  * Holds the resources necessary to describe the physical memory associated
95  * with the device.
96  ****************************************************************************/
97 struct hdac_mem {
98 	struct resource		*mem_res;
99 	int			mem_rid;
100 	bus_space_tag_t		mem_tag;
101 	bus_space_handle_t	mem_handle;
102 };
103 
104 /****************************************************************************
105  * struct hdac_irq
106  *
107  * Holds the resources necessary to describe the irq associated with the
108  * device.
109  ****************************************************************************/
110 struct hdac_irq {
111 	struct resource		*irq_res;
112 	int			irq_rid;
113 	void			*irq_handle;
114 };
115 
116 /****************************************************************************
117  * struct hdac_dma
118  *
119  * This structure is used to hold all the information to manage the dma
120  * states.
121  ****************************************************************************/
122 struct hdac_dma {
123 	bus_dma_tag_t	dma_tag;
124 	bus_dmamap_t	dma_map;
125 	bus_addr_t	dma_paddr;
126 	caddr_t		dma_vaddr;
127 };
128 
129 /****************************************************************************
130  * struct hdac_rirb
131  *
132  * Hold a response from a verb sent to a codec received via the rirb.
133  ****************************************************************************/
134 struct hdac_rirb {
135 	uint32_t	response;
136 	uint32_t	response_ex;
137 };
138 
139 #define HDAC_RIRB_RESPONSE_EX_SDATA_IN_MASK	0x0000000f
140 #define HDAC_RIRB_RESPONSE_EX_SDATA_IN_OFFSET	0
141 #define HDAC_RIRB_RESPONSE_EX_UNSOLICITED	0x00000010
142 
143 #define HDAC_RIRB_RESPONSE_EX_SDATA_IN(response_ex)			\
144     (((response_ex) & HDAC_RIRB_RESPONSE_EX_SDATA_IN_MASK) >>		\
145     HDAC_RIRB_RESPONSE_EX_SDATA_IN_OFFSET)
146 
147 /****************************************************************************
148  * struct hdac_command_list
149  *
150  * This structure holds the list of verbs that are to be sent to the codec
151  * via the corb and the responses received via the rirb. It's allocated by
152  * the codec driver and is owned by it.
153  ****************************************************************************/
154 struct hdac_command_list {
155 	int		num_commands;
156 	uint32_t	*verbs;
157 	uint32_t	*responses;
158 };
159 
160 typedef int nid_t;
161 
162 struct hdac_softc;
163 /****************************************************************************
164  * struct hdac_codec
165  *
166  ****************************************************************************/
167 struct hdac_codec {
168 	int	verbs_sent;
169 	int	responses_received;
170 	nid_t	cad;
171 	struct hdac_command_list *commands;
172 	struct hdac_softc *sc;
173 };
174 
175 struct hdac_bdle {
176 	volatile uint32_t addrl;
177 	volatile uint32_t addrh;
178 	volatile uint32_t len;
179 	volatile uint32_t ioc;
180 } __packed;
181 
182 #define HDA_MAX_CONNS	32
183 #define HDA_MAX_NAMELEN	32
184 
185 struct hdac_devinfo;
186 
187 struct hdac_widget {
188 	nid_t nid;
189 	int type;
190 	int enable;
191 	int nconns, selconn;
192 	uint32_t pflags, ctlflags;
193 	nid_t conns[HDA_MAX_CONNS];
194 	char name[HDA_MAX_NAMELEN];
195 	struct hdac_devinfo *devinfo;
196 	struct {
197 		uint32_t widget_cap;
198 		uint32_t outamp_cap;
199 		uint32_t inamp_cap;
200 		uint32_t supp_stream_formats;
201 		uint32_t supp_pcm_size_rate;
202 		uint32_t eapdbtl;
203 		int outpath;
204 	} param;
205 	union {
206 		struct {
207 			uint32_t config;
208 			uint32_t cap;
209 			uint32_t ctrl;
210 		} pin;
211 	} wclass;
212 };
213 
214 struct hdac_audio_ctl {
215 	struct hdac_widget *widget, *childwidget;
216 	int enable;
217 	int index;
218 	int mute, step, size, offset;
219 	int left, right;
220 	uint32_t muted;
221 	int ossdev;
222 	uint32_t dir, ossmask, ossval;
223 };
224 
225 /****************************************************************************
226  * struct hdac_devinfo
227  *
228  * Holds all the parameters of a given codec function group. This is stored
229  * in the ivar of each child of the hdac bus
230  ****************************************************************************/
231 struct hdac_devinfo {
232 	device_t dev;
233 	uint16_t vendor_id;
234 	uint16_t device_id;
235 	uint8_t revision_id;
236 	uint8_t stepping_id;
237 	uint8_t node_type;
238 	nid_t nid;
239 	nid_t startnode, endnode;
240 	int nodecnt;
241 	struct hdac_codec *codec;
242 	struct hdac_widget *widget;
243 	union {
244 		struct {
245 			uint32_t outamp_cap;
246 			uint32_t inamp_cap;
247 			uint32_t supp_stream_formats;
248 			uint32_t supp_pcm_size_rate;
249 			int ctlcnt, pcnt, rcnt;
250 			struct hdac_audio_ctl *ctl;
251 			uint32_t mvol;
252 			uint32_t quirks;
253 			int ossidx;
254 			int playcnt, reccnt;
255 			int parsing_strategy;
256 		} audio;
257 		/* XXX undefined: modem, hdmi. */
258 	} function;
259 };
260 
261 struct hdac_chan {
262 	struct snd_dbuf *b;
263 	struct pcm_channel *c;
264 	struct pcmchan_caps caps;
265 	struct hdac_devinfo *devinfo;
266 	struct hdac_dma	bdl_dma;
267 	uint32_t spd, fmt, fmtlist[8], pcmrates[16];
268 	uint32_t supp_stream_formats, supp_pcm_size_rate;
269 	uint32_t ptr, prevptr, blkcnt, blksz;
270 	int active;
271 	int dir;
272 	int off;
273 	int sid;
274 	int bit16, bit32;
275 	nid_t io[16];
276 };
277 
278 /****************************************************************************
279  * struct hdac_softc
280  *
281  * This structure holds the current state of the hdac driver.
282  ****************************************************************************/
283 struct hdac_softc {
284 	device_t	dev;
285 	device_t	hdabus;
286 	struct mtx	*lock;
287 
288 	struct intr_config_hook intrhook;
289 
290 	struct hdac_mem	mem;
291 	struct hdac_irq	irq;
292 	uint32_t pci_subvendor;
293 
294 
295 	int		num_iss;
296 	int		num_oss;
297 	int		num_bss;
298 	int		support_64bit;
299 	int		streamcnt;
300 
301 	int		corb_size;
302 	struct hdac_dma corb_dma;
303 	int		corb_wp;
304 
305 	int		rirb_size;
306 	struct hdac_dma	rirb_dma;
307 	int		rirb_rp;
308 
309 	struct hdac_chan	play, rec;
310 	bus_dma_tag_t		chan_dmat;
311 	int			chan_size;
312 	int			chan_blkcnt;
313 
314 	/*
315 	 * Polling
316 	 */
317 	int			polling;
318 	int			poll_ticks;
319 	struct callout		poll_hda;
320 	struct callout		poll_hdac;
321 
322 #define HDAC_UNSOLQ_MAX		64
323 #define HDAC_UNSOLQ_READY	0
324 #define HDAC_UNSOLQ_BUSY	1
325 	int		unsolq_rp;
326 	int		unsolq_wp;
327 	int		unsolq_st;
328 	uint32_t	unsolq[HDAC_UNSOLQ_MAX];
329 
330 	struct hdac_codec *codecs[HDAC_CODEC_MAX];
331 
332 	int		registered;
333 };
334 
335 /****************************************************************************
336  * struct hdac_command flags
337  ****************************************************************************/
338 #define HDAC_COMMAND_FLAG_WAITOK	0x0000
339 #define HDAC_COMMAND_FLAG_NOWAIT	0x0001
340 
341 #endif
342