aboutsummaryrefslogtreecommitdiff
path: root/sys/dev/sound/pci/hdspe.h
blob: bced78758068feff1bd53983b7eb2b2787e1bf45 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
/*-
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Copyright (c) 2012-2016 Ruslan Bukin <br@bsdpad.com>
 * Copyright (c) 2023-2024 Florian Walpen <dev@submerge.ch>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#define	PCI_VENDOR_XILINX		0x10ee
#define	PCI_VENDOR_RME			0x1d18 /* Newer firmware versions. */
#define	PCI_DEVICE_XILINX_HDSPE		0x3fc6 /* AIO, MADI, AES, RayDAT */
#define	PCI_CLASS_REVISION		0x08
#define	PCI_REVISION_AIO		212
#define	PCI_REVISION_RAYDAT		211

#define	HDSPE_AIO			0
#define	HDSPE_RAYDAT			1

/* Hardware mixer */
#define	HDSPE_OUT_ENABLE_BASE		512
#define	HDSPE_IN_ENABLE_BASE		768
#define	HDSPE_MIXER_BASE		32768
#define	HDSPE_MAX_GAIN			32768

/* Buffer */
#define	HDSPE_PAGE_ADDR_BUF_OUT		8192
#define	HDSPE_PAGE_ADDR_BUF_IN		(HDSPE_PAGE_ADDR_BUF_OUT + 64 * 16 * 4)
#define	HDSPE_BUF_POSITION_MASK		0x000FFC0

/* Frequency */
#define	HDSPE_FREQ_0			(1 << 6)
#define	HDSPE_FREQ_1			(1 << 7)
#define	HDSPE_FREQ_DOUBLE		(1 << 8)
#define	HDSPE_FREQ_QUAD			(1 << 31)

#define	HDSPE_FREQ_32000		HDSPE_FREQ_0
#define	HDSPE_FREQ_44100		HDSPE_FREQ_1
#define	HDSPE_FREQ_48000		(HDSPE_FREQ_0 | HDSPE_FREQ_1)
#define	HDSPE_FREQ_MASK			(HDSPE_FREQ_0 | HDSPE_FREQ_1 |	\
					HDSPE_FREQ_DOUBLE | HDSPE_FREQ_QUAD)
#define	HDSPE_FREQ_MASK_DEFAULT		HDSPE_FREQ_48000
#define	HDSPE_FREQ_REG			256
#define	HDSPE_FREQ_AIO			104857600000000ULL

#define	HDSPE_SPEED_DEFAULT		48000

/* Latency */
#define	HDSPE_LAT_0			(1 << 1)
#define	HDSPE_LAT_1			(1 << 2)
#define	HDSPE_LAT_2			(1 << 3)
#define	HDSPE_LAT_MASK			(HDSPE_LAT_0 | HDSPE_LAT_1 | HDSPE_LAT_2)
#define	HDSPE_LAT_BYTES_MAX		(4096 * 4)
#define	HDSPE_LAT_BYTES_MIN		(32 * 4)
#define	hdspe_encode_latency(x)		(((x)<<1) & HDSPE_LAT_MASK)

/* Register addresses */
#define	HDSPE_SETTINGS_REG		0
#define	HDSPE_CONTROL_REG		64
#define	HDSPE_STATUS_REG		0
#define	HDSPE_STATUS1_REG		64
#define	HDSPE_STATUS2_REG		192

/* Settings register flags */
#define	HDSPE_SETTINGS_INPUT_GAIN0	(1 << 20)
#define	HDSPE_SETTINGS_INPUT_GAIN1	(1 << 21)
#define	HDSPE_SETTINGS_OUTPUT_GAIN0	(1 << 22)
#define	HDSPE_SETTINGS_OUTPUT_GAIN1	(1 << 23)
#define	HDSPE_SETTINGS_PHONES_GAIN0	(1 << 24)
#define	HDSPE_SETTINGS_PHONES_GAIN1	(1 << 25)

/* Analog input gain level */
#define	HDSPE_INPUT_LEVEL_MASK		(HDSPE_SETTINGS_INPUT_GAIN0 | \
					HDSPE_SETTINGS_INPUT_GAIN1)
#define	HDSPE_INPUT_LEVEL_LOWGAIN	0
#define	HDSPE_INPUT_LEVEL_PLUS4DBU	(HDSPE_SETTINGS_INPUT_GAIN0)
#define	HDSPE_INPUT_LEVEL_MINUS10DBV	(HDSPE_SETTINGS_INPUT_GAIN1)

/* Analog output gain level */
#define	HDSPE_OUTPUT_LEVEL_MASK		(HDSPE_SETTINGS_OUTPUT_GAIN0 | \
					HDSPE_SETTINGS_OUTPUT_GAIN1)
#define	HDSPE_OUTPUT_LEVEL_HIGHGAIN	0
#define	HDSPE_OUTPUT_LEVEL_PLUS4DBU	(HDSPE_SETTINGS_OUTPUT_GAIN0)
#define	HDSPE_OUTPUT_LEVEL_MINUS10DBV	(HDSPE_SETTINGS_OUTPUT_GAIN1)

/* Phones output gain level */
#define	HDSPE_PHONES_LEVEL_MASK		(HDSPE_SETTINGS_PHONES_GAIN0 | \
					HDSPE_SETTINGS_PHONES_GAIN1)
#define	HDSPE_PHONES_LEVEL_HIGHGAIN	0
#define	HDSPE_PHONES_LEVEL_PLUS4DBU	(HDSPE_SETTINGS_PHONES_GAIN0)
#define	HDSPE_PHONES_LEVEL_MINUS10DBV	(HDSPE_SETTINGS_PHONES_GAIN1)

/* Control register flags */
#define	HDSPE_ENABLE			(1 << 0)

/* Interrupts */
#define	HDSPE_AUDIO_IRQ_PENDING		(1 << 0)
#define	HDSPE_AUDIO_INT_ENABLE		(1 << 5)
#define	HDSPE_INTERRUPT_ACK		96

/* Channels */
#define	HDSPE_MAX_SLOTS			64 /* Mono channels */
#define	HDSPE_MAX_CHANS			(HDSPE_MAX_SLOTS / 2) /* Stereo pairs */

#define	HDSPE_CHANBUF_SAMPLES		(16 * 1024)
#define	HDSPE_CHANBUF_SIZE		(4 * HDSPE_CHANBUF_SAMPLES)
#define	HDSPE_DMASEGSIZE		(HDSPE_CHANBUF_SIZE * HDSPE_MAX_SLOTS)

#define	HDSPE_CHAN_AIO_LINE		(1 << 0)
#define	HDSPE_CHAN_AIO_EXT		(1 << 1)
#define	HDSPE_CHAN_AIO_PHONE		(1 << 2)
#define	HDSPE_CHAN_AIO_AES		(1 << 3)
#define	HDSPE_CHAN_AIO_SPDIF		(1 << 4)
#define	HDSPE_CHAN_AIO_ADAT		(1 << 5)
#define	HDSPE_CHAN_AIO_ALL_REC		(HDSPE_CHAN_AIO_LINE | \
					HDSPE_CHAN_AIO_EXT | \
					HDSPE_CHAN_AIO_AES | \
					HDSPE_CHAN_AIO_SPDIF | \
					HDSPE_CHAN_AIO_ADAT)
#define	HDSPE_CHAN_AIO_ALL		(HDSPE_CHAN_AIO_ALL_REC | \
					HDSPE_CHAN_AIO_PHONE) \

#define	HDSPE_CHAN_RAY_AES		(1 << 6)
#define	HDSPE_CHAN_RAY_SPDIF		(1 << 7)
#define	HDSPE_CHAN_RAY_ADAT1		(1 << 8)
#define	HDSPE_CHAN_RAY_ADAT2		(1 << 9)
#define	HDSPE_CHAN_RAY_ADAT3		(1 << 10)
#define	HDSPE_CHAN_RAY_ADAT4		(1 << 11)
#define	HDSPE_CHAN_RAY_ALL		(HDSPE_CHAN_RAY_AES | \
					HDSPE_CHAN_RAY_SPDIF | \
					HDSPE_CHAN_RAY_ADAT1 | \
					HDSPE_CHAN_RAY_ADAT2 | \
					HDSPE_CHAN_RAY_ADAT3 | \
					HDSPE_CHAN_RAY_ADAT4)

struct hdspe_channel {
	uint32_t	ports;
	char		*descr;
};

/* Clock sources */
#define	HDSPE_SETTING_MASTER		(1 << 0)
#define	HDSPE_SETTING_CLOCK_MASK	0x1f

#define	HDSPE_STATUS1_CLOCK_SHIFT	28
#define	HDSPE_STATUS1_CLOCK_MASK	(0x0f << HDSPE_STATUS1_CLOCK_SHIFT)
#define	HDSPE_STATUS1_CLOCK(n)		(((n) << HDSPE_STATUS1_CLOCK_SHIFT) & \
					HDSPE_STATUS1_CLOCK_MASK)

struct hdspe_clock_source {
	char		*name;
	uint32_t	setting;
	uint32_t	status;
	uint32_t	lock_bit;
	uint32_t	sync_bit;
};

static MALLOC_DEFINE(M_HDSPE, "hdspe", "hdspe audio");

/* Channel registers */
struct sc_chinfo {
	struct snd_dbuf		*buffer;
	struct pcm_channel	*channel;
	struct sc_pcminfo	*parent;

	/* Channel information */
	struct pcmchan_caps	*caps;
	uint32_t	cap_fmts[4];
	uint32_t	dir;
	uint32_t	format;
	uint32_t	ports;
	uint32_t	lvol;
	uint32_t	rvol;

	/* Buffer */
	uint32_t	*data;
	uint32_t	size;
	uint32_t	position;

	/* Flags */
	uint32_t	run;
};

/* PCM device private data */
struct sc_pcminfo {
	device_t		dev;
	uint32_t		(*ih) (struct sc_pcminfo *scp);
	uint32_t		chnum;
	struct sc_chinfo	chan[HDSPE_MAX_CHANS];
	struct sc_info		*sc;
	struct hdspe_channel	*hc;
};

/* HDSPe device private data */
struct sc_info {
	device_t		dev;
	struct mtx		*lock;

	uint32_t		ctrl_register;
	uint32_t		settings_register;
	uint32_t		type;

	/* Control/Status register */
	struct resource		*cs;
	int			csid;
	bus_space_tag_t		cst;
	bus_space_handle_t	csh;

	struct resource		*irq;
	int			irqid;
	void			*ih;
	bus_dma_tag_t		dmat;

	/* Play/Record DMA buffers */
	uint32_t		*pbuf;
	uint32_t		*rbuf;
	uint32_t		bufsize;
	bus_dmamap_t		pmap;
	bus_dmamap_t		rmap;
	uint32_t		period;
	uint32_t		speed;
	uint32_t		force_period;
	uint32_t		force_speed;
};

#define	hdspe_read_1(sc, regno)						\
	bus_space_read_1((sc)->cst, (sc)->csh, (regno))
#define	hdspe_read_2(sc, regno)						\
	bus_space_read_2((sc)->cst, (sc)->csh, (regno))
#define	hdspe_read_4(sc, regno)						\
	bus_space_read_4((sc)->cst, (sc)->csh, (regno))

#define	hdspe_write_1(sc, regno, data)					\
	bus_space_write_1((sc)->cst, (sc)->csh, (regno), (data))
#define	hdspe_write_2(sc, regno, data)					\
	bus_space_write_2((sc)->cst, (sc)->csh, (regno), (data))
#define	hdspe_write_4(sc, regno, data)					\
	bus_space_write_4((sc)->cst, (sc)->csh, (regno), (data))