1 | /* SPDX-License-Identifier: GPL-2.0-or-later */ |
2 | /* |
3 | * Driver for Digigram miXart soundcards |
4 | * |
5 | * main header file |
6 | * |
7 | * Copyright (c) 2003 by Digigram <alsa@digigram.com> |
8 | */ |
9 | |
10 | #ifndef __SOUND_MIXART_H |
11 | #define __SOUND_MIXART_H |
12 | |
13 | #include <linux/interrupt.h> |
14 | #include <linux/mutex.h> |
15 | #include <sound/pcm.h> |
16 | |
17 | #define MIXART_DRIVER_VERSION 0x000100 /* 0.1.0 */ |
18 | |
19 | |
20 | /* |
21 | */ |
22 | |
23 | struct mixart_uid { |
24 | u32 object_id; |
25 | u32 desc; |
26 | }; |
27 | |
28 | struct mem_area { |
29 | unsigned long phys; |
30 | void __iomem *virt; |
31 | struct resource *res; |
32 | }; |
33 | |
34 | |
35 | struct mixart_route { |
36 | unsigned char connected; |
37 | unsigned char phase_inv; |
38 | int volume; |
39 | }; |
40 | |
41 | |
42 | /* firmware status codes */ |
43 | #define MIXART_MOTHERBOARD_XLX_INDEX 0 |
44 | #define MIXART_MOTHERBOARD_ELF_INDEX 1 |
45 | #define MIXART_AESEBUBOARD_XLX_INDEX 2 |
46 | #define MIXART_HARDW_FILES_MAX_INDEX 3 /* xilinx, elf, AESEBU xilinx */ |
47 | |
48 | #define MIXART_MAX_CARDS 4 |
49 | #define MSG_FIFO_SIZE 16 |
50 | |
51 | #define MIXART_MAX_PHYS_CONNECTORS (MIXART_MAX_CARDS * 2 * 2) /* 4 * stereo * (analog+digital) */ |
52 | |
53 | struct mixart_mgr { |
54 | unsigned int num_cards; |
55 | struct snd_mixart *chip[MIXART_MAX_CARDS]; |
56 | |
57 | struct pci_dev *pci; |
58 | |
59 | int irq; |
60 | |
61 | /* memory-maps */ |
62 | struct mem_area mem[2]; |
63 | |
64 | /* one and only blocking message or notification may be pending */ |
65 | u32 pending_event; |
66 | wait_queue_head_t msg_sleep; |
67 | |
68 | /* messages fifo */ |
69 | u32 msg_fifo[MSG_FIFO_SIZE]; |
70 | int msg_fifo_readptr; |
71 | int msg_fifo_writeptr; |
72 | atomic_t msg_processed; /* number of messages to be processed in irq thread */ |
73 | |
74 | struct mutex lock; /* interrupt lock */ |
75 | struct mutex msg_lock; /* mailbox lock */ |
76 | |
77 | struct mutex setup_mutex; /* mutex used in hw_params, open and close */ |
78 | |
79 | /* hardware interface */ |
80 | unsigned int dsp_loaded; /* bit flags of loaded dsp indices */ |
81 | unsigned int board_type; /* read from embedded once elf file is loaded, 250 = miXart8, 251 = with AES, 252 = with Cobranet */ |
82 | |
83 | struct snd_dma_buffer flowinfo; |
84 | struct snd_dma_buffer bufferinfo; |
85 | |
86 | struct mixart_uid uid_console_manager; |
87 | int sample_rate; |
88 | int ref_count_rate; |
89 | |
90 | struct mutex mixer_mutex; /* mutex for mixer */ |
91 | |
92 | }; |
93 | |
94 | |
95 | #define MIXART_STREAM_STATUS_FREE 0 |
96 | #define MIXART_STREAM_STATUS_OPEN 1 |
97 | #define MIXART_STREAM_STATUS_RUNNING 2 |
98 | #define MIXART_STREAM_STATUS_DRAINING 3 |
99 | #define MIXART_STREAM_STATUS_PAUSE 4 |
100 | |
101 | #define MIXART_PLAYBACK_STREAMS 4 |
102 | #define MIXART_CAPTURE_STREAMS 1 |
103 | |
104 | #define MIXART_PCM_ANALOG 0 |
105 | #define MIXART_PCM_DIGITAL 1 |
106 | #define MIXART_PCM_TOTAL 2 |
107 | |
108 | #define MIXART_MAX_STREAM_PER_CARD (MIXART_PCM_TOTAL * (MIXART_PLAYBACK_STREAMS + MIXART_CAPTURE_STREAMS) ) |
109 | |
110 | |
111 | #define MIXART_NOTIFY_CARD_MASK 0xF000 |
112 | #define MIXART_NOTIFY_CARD_OFFSET 12 |
113 | #define MIXART_NOTIFY_PCM_MASK 0x0F00 |
114 | #define MIXART_NOTIFY_PCM_OFFSET 8 |
115 | #define MIXART_NOTIFY_CAPT_MASK 0x0080 |
116 | #define MIXART_NOTIFY_SUBS_MASK 0x007F |
117 | |
118 | |
119 | struct mixart_stream { |
120 | struct snd_pcm_substream *substream; |
121 | struct mixart_pipe *pipe; |
122 | int pcm_number; |
123 | |
124 | int status; /* nothing, running, draining */ |
125 | |
126 | u64 abs_period_elapsed; /* last absolute stream position where period_elapsed was called (multiple of runtime->period_size) */ |
127 | u32 buf_periods; /* periods counter in the buffer (< runtime->periods) */ |
128 | u32 buf_period_frag; /* defines with buf_period_pos the exact position in the buffer (< runtime->period_size) */ |
129 | |
130 | int channels; |
131 | }; |
132 | |
133 | |
134 | enum mixart_pipe_status { |
135 | PIPE_UNDEFINED, |
136 | PIPE_STOPPED, |
137 | PIPE_RUNNING, |
138 | PIPE_CLOCK_SET |
139 | }; |
140 | |
141 | struct mixart_pipe { |
142 | struct mixart_uid group_uid; /* id of the pipe, as returned by embedded */ |
143 | int stream_count; |
144 | struct mixart_uid uid_left_connector; /* UID's for the audio connectors */ |
145 | struct mixart_uid uid_right_connector; |
146 | enum mixart_pipe_status status; |
147 | int references; /* number of subs openned */ |
148 | int monitoring; /* pipe used for monitoring issue */ |
149 | }; |
150 | |
151 | |
152 | struct snd_mixart { |
153 | struct snd_card *card; |
154 | struct mixart_mgr *mgr; |
155 | int chip_idx; /* zero based */ |
156 | struct snd_hwdep *hwdep; /* DSP loader, only for the first card */ |
157 | |
158 | struct snd_pcm *pcm; /* PCM analog i/o */ |
159 | struct snd_pcm *pcm_dig; /* PCM digital i/o */ |
160 | |
161 | /* allocate stereo pipe for instance */ |
162 | struct mixart_pipe pipe_in_ana; |
163 | struct mixart_pipe pipe_out_ana; |
164 | |
165 | /* if AES/EBU daughter board is available, additional pipes possible on pcm_dig */ |
166 | struct mixart_pipe pipe_in_dig; |
167 | struct mixart_pipe pipe_out_dig; |
168 | |
169 | struct mixart_stream playback_stream[MIXART_PCM_TOTAL][MIXART_PLAYBACK_STREAMS]; /* 0 = pcm, 1 = pcm_dig */ |
170 | struct mixart_stream capture_stream[MIXART_PCM_TOTAL]; /* 0 = pcm, 1 = pcm_dig */ |
171 | |
172 | /* UID's for the physical io's */ |
173 | struct mixart_uid uid_out_analog_physio; |
174 | struct mixart_uid uid_in_analog_physio; |
175 | |
176 | int analog_playback_active[2]; /* Mixer : Master Playback active (!mute) */ |
177 | int analog_playback_volume[2]; /* Mixer : Master Playback Volume */ |
178 | int analog_capture_volume[2]; /* Mixer : Master Capture Volume */ |
179 | int digital_playback_active[2*MIXART_PLAYBACK_STREAMS][2]; /* Mixer : Digital Playback Active [(analog+AES output)*streams][stereo]*/ |
180 | int digital_playback_volume[2*MIXART_PLAYBACK_STREAMS][2]; /* Mixer : Digital Playback Volume [(analog+AES output)*streams][stereo]*/ |
181 | int digital_capture_volume[2][2]; /* Mixer : Digital Capture Volume [analog+AES output][stereo] */ |
182 | int monitoring_active[2]; /* Mixer : Monitoring Active */ |
183 | int monitoring_volume[2]; /* Mixer : Monitoring Volume */ |
184 | }; |
185 | |
186 | struct mixart_bufferinfo |
187 | { |
188 | u32 buffer_address; |
189 | u32 reserved[5]; |
190 | u32 available_length; |
191 | u32 buffer_id; |
192 | }; |
193 | |
194 | struct mixart_flowinfo |
195 | { |
196 | u32 bufferinfo_array_phy_address; |
197 | u32 reserved[11]; |
198 | u32 bufferinfo_count; |
199 | u32 capture; |
200 | }; |
201 | |
202 | /* exported */ |
203 | int snd_mixart_create_pcm(struct snd_mixart * chip); |
204 | struct mixart_pipe *snd_mixart_add_ref_pipe(struct snd_mixart *chip, int pcm_number, int capture, int monitoring); |
205 | int snd_mixart_kill_ref_pipe(struct mixart_mgr *mgr, struct mixart_pipe *pipe, int monitoring); |
206 | |
207 | #endif /* __SOUND_MIXART_H */ |
208 | |