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