xref: /openbmc/linux/sound/pci/mixart/mixart.h (revision a2818ee4)
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 
36 struct mixart_uid {
37 	u32 object_id;
38 	u32 desc;
39 };
40 
41 struct mem_area {
42 	unsigned long phys;
43 	void __iomem *virt;
44 	struct resource *res;
45 };
46 
47 
48 struct 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 
66 struct 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 	/* one and only blocking message or notification may be pending  */
78 	u32 pending_event;
79 	wait_queue_head_t msg_sleep;
80 
81 	/* messages fifo */
82 	u32 msg_fifo[MSG_FIFO_SIZE];
83 	int msg_fifo_readptr;
84 	int msg_fifo_writeptr;
85 	atomic_t msg_processed;       /* number of messages to be processed in tasklet */
86 
87 	struct mutex lock;              /* interrupt lock */
88 	struct mutex msg_lock;		/* mailbox lock */
89 
90 	struct mutex setup_mutex; /* mutex used in hw_params, open and close */
91 
92 	/* hardware interface */
93 	unsigned int dsp_loaded;      /* bit flags of loaded dsp indices */
94 	unsigned int board_type;      /* read from embedded once elf file is loaded, 250 = miXart8, 251 = with AES, 252 = with Cobranet */
95 
96 	struct snd_dma_buffer flowinfo;
97 	struct snd_dma_buffer bufferinfo;
98 
99 	struct mixart_uid         uid_console_manager;
100 	int sample_rate;
101 	int ref_count_rate;
102 
103 	struct mutex mixer_mutex; /* mutex for mixer */
104 
105 };
106 
107 
108 #define MIXART_STREAM_STATUS_FREE	0
109 #define MIXART_STREAM_STATUS_OPEN	1
110 #define MIXART_STREAM_STATUS_RUNNING	2
111 #define MIXART_STREAM_STATUS_DRAINING	3
112 #define MIXART_STREAM_STATUS_PAUSE	4
113 
114 #define MIXART_PLAYBACK_STREAMS		4
115 #define MIXART_CAPTURE_STREAMS		1
116 
117 #define MIXART_PCM_ANALOG		0
118 #define MIXART_PCM_DIGITAL		1
119 #define MIXART_PCM_TOTAL		2
120 
121 #define MIXART_MAX_STREAM_PER_CARD  (MIXART_PCM_TOTAL * (MIXART_PLAYBACK_STREAMS + MIXART_CAPTURE_STREAMS) )
122 
123 
124 #define MIXART_NOTIFY_CARD_MASK		0xF000
125 #define MIXART_NOTIFY_CARD_OFFSET	12
126 #define MIXART_NOTIFY_PCM_MASK		0x0F00
127 #define MIXART_NOTIFY_PCM_OFFSET	8
128 #define MIXART_NOTIFY_CAPT_MASK		0x0080
129 #define MIXART_NOTIFY_SUBS_MASK		0x007F
130 
131 
132 struct mixart_stream {
133 	struct snd_pcm_substream *substream;
134 	struct mixart_pipe *pipe;
135 	int pcm_number;
136 
137 	int status;      /* nothing, running, draining */
138 
139 	u64  abs_period_elapsed;  /* last absolute stream position where period_elapsed was called (multiple of runtime->period_size) */
140 	u32  buf_periods;         /* periods counter in the buffer (< runtime->periods) */
141 	u32  buf_period_frag;     /* defines with buf_period_pos the exact position in the buffer (< runtime->period_size) */
142 
143 	int channels;
144 };
145 
146 
147 enum mixart_pipe_status {
148 	PIPE_UNDEFINED,
149 	PIPE_STOPPED,
150 	PIPE_RUNNING,
151 	PIPE_CLOCK_SET
152 };
153 
154 struct mixart_pipe {
155 	struct mixart_uid group_uid;			/* id of the pipe, as returned by embedded */
156 	int          stream_count;
157 	struct mixart_uid uid_left_connector;	/* UID's for the audio connectors */
158 	struct mixart_uid uid_right_connector;
159 	enum mixart_pipe_status status;
160 	int references;             /* number of subs openned */
161 	int monitoring;             /* pipe used for monitoring issue */
162 };
163 
164 
165 struct snd_mixart {
166 	struct snd_card *card;
167 	struct mixart_mgr *mgr;
168 	int chip_idx;               /* zero based */
169 	struct snd_hwdep *hwdep;	    /* DSP loader, only for the first card */
170 
171 	struct snd_pcm *pcm;             /* PCM analog i/o */
172 	struct snd_pcm *pcm_dig;         /* PCM digital i/o */
173 
174 	/* allocate stereo pipe for instance */
175 	struct mixart_pipe pipe_in_ana;
176 	struct mixart_pipe pipe_out_ana;
177 
178 	/* if AES/EBU daughter board is available, additional pipes possible on pcm_dig */
179 	struct mixart_pipe pipe_in_dig;
180 	struct mixart_pipe pipe_out_dig;
181 
182 	struct mixart_stream playback_stream[MIXART_PCM_TOTAL][MIXART_PLAYBACK_STREAMS]; /* 0 = pcm, 1 = pcm_dig */
183 	struct mixart_stream capture_stream[MIXART_PCM_TOTAL];                           /* 0 = pcm, 1 = pcm_dig */
184 
185 	/* UID's for the physical io's */
186 	struct mixart_uid uid_out_analog_physio;
187 	struct mixart_uid uid_in_analog_physio;
188 
189 	int analog_playback_active[2];		/* Mixer : Master Playback active (!mute) */
190 	int analog_playback_volume[2];		/* Mixer : Master Playback Volume */
191 	int analog_capture_volume[2];		/* Mixer : Master Capture Volume */
192 	int digital_playback_active[2*MIXART_PLAYBACK_STREAMS][2];	/* Mixer : Digital Playback Active [(analog+AES output)*streams][stereo]*/
193 	int digital_playback_volume[2*MIXART_PLAYBACK_STREAMS][2];	/* Mixer : Digital Playback Volume [(analog+AES output)*streams][stereo]*/
194 	int digital_capture_volume[2][2];	/* Mixer : Digital Capture Volume [analog+AES output][stereo] */
195 	int monitoring_active[2];		/* Mixer : Monitoring Active */
196 	int monitoring_volume[2];		/* Mixer : Monitoring Volume */
197 };
198 
199 struct mixart_bufferinfo
200 {
201 	u32 buffer_address;
202 	u32 reserved[5];
203 	u32 available_length;
204 	u32 buffer_id;
205 };
206 
207 struct mixart_flowinfo
208 {
209 	u32 bufferinfo_array_phy_address;
210 	u32 reserved[11];
211 	u32 bufferinfo_count;
212 	u32 capture;
213 };
214 
215 /* exported */
216 int snd_mixart_create_pcm(struct snd_mixart * chip);
217 struct mixart_pipe *snd_mixart_add_ref_pipe(struct snd_mixart *chip, int pcm_number, int capture, int monitoring);
218 int snd_mixart_kill_ref_pipe(struct mixart_mgr *mgr, struct mixart_pipe *pipe, int monitoring);
219 
220 #endif /* __SOUND_MIXART_H */
221