1 /* SPDX-License-Identifier: GPL-2.0-or-later * <<
2 /* 1 /*
3 * Driver for Digigram pcxhr soundcards 2 * Driver for Digigram pcxhr soundcards
4 * 3 *
5 * main header file 4 * main header file
6 * 5 *
7 * Copyright (c) 2004 by Digigram <alsa@digigr 6 * Copyright (c) 2004 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
8 */ 21 */
9 22
10 #ifndef __SOUND_PCXHR_H 23 #ifndef __SOUND_PCXHR_H
11 #define __SOUND_PCXHR_H 24 #define __SOUND_PCXHR_H
12 25
13 #include <linux/interrupt.h> 26 #include <linux/interrupt.h>
14 #include <linux/mutex.h> 27 #include <linux/mutex.h>
15 #include <sound/pcm.h> 28 #include <sound/pcm.h>
16 29
17 #define PCXHR_DRIVER_VERSION 0x0009 30 #define PCXHR_DRIVER_VERSION 0x000906 /* 0.9.6 */
18 #define PCXHR_DRIVER_VERSION_STRING "0.9.6 31 #define PCXHR_DRIVER_VERSION_STRING "0.9.6" /* 0.9.6 */
19 32
20 33
21 #define PCXHR_MAX_CARDS 6 34 #define PCXHR_MAX_CARDS 6
22 #define PCXHR_PLAYBACK_STREAMS 4 35 #define PCXHR_PLAYBACK_STREAMS 4
23 36
24 #define PCXHR_GRANULARITY 96 /* min 37 #define PCXHR_GRANULARITY 96 /* min 96 and multiple of 48 */
25 /* transfer granularity of pipes and the dsp t 38 /* transfer granularity of pipes and the dsp time (MBOX4) */
26 #define PCXHR_GRANULARITY_MIN 96 39 #define PCXHR_GRANULARITY_MIN 96
27 /* TODO : granularity could be 64 or 128 */ 40 /* TODO : granularity could be 64 or 128 */
28 #define PCXHR_GRANULARITY_HR22 192 /* gra 41 #define PCXHR_GRANULARITY_HR22 192 /* granularity for stereo cards */
29 42
30 struct snd_pcxhr; 43 struct snd_pcxhr;
31 struct pcxhr_mgr; 44 struct pcxhr_mgr;
32 45
33 struct pcxhr_stream; 46 struct pcxhr_stream;
34 struct pcxhr_pipe; 47 struct pcxhr_pipe;
35 48
36 enum pcxhr_clock_type { 49 enum pcxhr_clock_type {
37 PCXHR_CLOCK_TYPE_INTERNAL = 0, 50 PCXHR_CLOCK_TYPE_INTERNAL = 0,
38 PCXHR_CLOCK_TYPE_WORD_CLOCK, 51 PCXHR_CLOCK_TYPE_WORD_CLOCK,
39 PCXHR_CLOCK_TYPE_AES_SYNC, 52 PCXHR_CLOCK_TYPE_AES_SYNC,
40 PCXHR_CLOCK_TYPE_AES_1, 53 PCXHR_CLOCK_TYPE_AES_1,
41 PCXHR_CLOCK_TYPE_AES_2, 54 PCXHR_CLOCK_TYPE_AES_2,
42 PCXHR_CLOCK_TYPE_AES_3, 55 PCXHR_CLOCK_TYPE_AES_3,
43 PCXHR_CLOCK_TYPE_AES_4, 56 PCXHR_CLOCK_TYPE_AES_4,
44 PCXHR_CLOCK_TYPE_MAX = PCXHR_CLOCK_TYP 57 PCXHR_CLOCK_TYPE_MAX = PCXHR_CLOCK_TYPE_AES_4,
45 HR22_CLOCK_TYPE_INTERNAL = PCXHR_CLOCK 58 HR22_CLOCK_TYPE_INTERNAL = PCXHR_CLOCK_TYPE_INTERNAL,
46 HR22_CLOCK_TYPE_AES_SYNC, 59 HR22_CLOCK_TYPE_AES_SYNC,
47 HR22_CLOCK_TYPE_AES_1, 60 HR22_CLOCK_TYPE_AES_1,
48 HR22_CLOCK_TYPE_MAX = HR22_CLOCK_TYPE_ 61 HR22_CLOCK_TYPE_MAX = HR22_CLOCK_TYPE_AES_1,
49 }; 62 };
50 63
51 struct pcxhr_mgr { 64 struct pcxhr_mgr {
52 unsigned int num_cards; 65 unsigned int num_cards;
53 struct snd_pcxhr *chip[PCXHR_MAX_CARDS 66 struct snd_pcxhr *chip[PCXHR_MAX_CARDS];
54 67
55 struct pci_dev *pci; 68 struct pci_dev *pci;
56 69
57 int irq; 70 int irq;
58 71
59 int granularity; 72 int granularity;
60 73
61 /* card access with 1 mem bar and 2 io 74 /* card access with 1 mem bar and 2 io bar's */
62 unsigned long port[3]; 75 unsigned long port[3];
63 76
64 /* share the name */ 77 /* share the name */
65 char name[40]; /* nam !! 78 char shortname[32]; /* short name of this soundcard */
>> 79 char longname[96]; /* name of this soundcard */
66 80
67 struct pcxhr_rmh *prmh; 81 struct pcxhr_rmh *prmh;
68 82
69 struct mutex lock; /* int 83 struct mutex lock; /* interrupt lock */
70 struct mutex msg_lock; /* mes 84 struct mutex msg_lock; /* message lock */
71 85
72 struct mutex setup_mutex; /* mut 86 struct mutex setup_mutex; /* mutex used in hw_params, open and close */
73 struct mutex mixer_mutex; /* mut 87 struct mutex mixer_mutex; /* mutex for mixer */
74 88
75 /* hardware interface */ 89 /* hardware interface */
76 unsigned int dsp_loaded; /* bit 90 unsigned int dsp_loaded; /* bit flags of loaded dsp indices */
77 unsigned int dsp_version; /* rea 91 unsigned int dsp_version; /* read from embedded once firmware is loaded */
78 int playback_chips; 92 int playback_chips;
79 int capture_chips; 93 int capture_chips;
80 int fw_file_set; 94 int fw_file_set;
81 int firmware_num; 95 int firmware_num;
82 unsigned int is_hr_stereo:1; 96 unsigned int is_hr_stereo:1;
83 unsigned int board_has_aes1:1; /* if 97 unsigned int board_has_aes1:1; /* if 1 board has AES1 plug and SRC */
84 unsigned int board_has_analog:1; /* if 98 unsigned int board_has_analog:1; /* if 0 the board is digital only */
85 unsigned int board_has_mic:1; /* if 1 99 unsigned int board_has_mic:1; /* if 1 the board has microphone input */
86 unsigned int board_aes_in_192k:1;/* if 100 unsigned int board_aes_in_192k:1;/* if 1 the aes input plugs do support 192kHz */
87 unsigned int mono_capture:1; /* if 1 t 101 unsigned int mono_capture:1; /* if 1 the board does mono capture */
88 unsigned int capture_ltc:1; /* if 1 th 102 unsigned int capture_ltc:1; /* if 1 the board captures LTC input */
89 103
90 struct snd_dma_buffer hostport; 104 struct snd_dma_buffer hostport;
91 105
92 enum pcxhr_clock_type use_clock_type; 106 enum pcxhr_clock_type use_clock_type; /* clock type selected by mixer */
93 enum pcxhr_clock_type cur_clock_type; 107 enum pcxhr_clock_type cur_clock_type; /* current clock type synced */
94 int sample_rate; 108 int sample_rate;
95 int ref_count_rate; 109 int ref_count_rate;
96 int timer_toggle; /* tim 110 int timer_toggle; /* timer interrupt toggles between the two values 0x200 and 0x300 */
97 int dsp_time_last; /* the 111 int dsp_time_last; /* the last dsp time (read by interrupt) */
98 int dsp_time_err; /* dsp 112 int dsp_time_err; /* dsp time errors */
99 unsigned int src_it_dsp; /* dsp 113 unsigned int src_it_dsp; /* dsp interrupt source */
100 unsigned int io_num_reg_cont; /* bac 114 unsigned int io_num_reg_cont; /* backup of IO_NUM_REG_CONT */
101 unsigned int codec_speed; /* spe 115 unsigned int codec_speed; /* speed mode of the codecs */
102 unsigned int sample_rate_real; /* cur 116 unsigned int sample_rate_real; /* current real sample rate */
103 int last_reg_stat; 117 int last_reg_stat;
104 int async_err_stream_xrun; 118 int async_err_stream_xrun;
105 int async_err_pipe_xrun; 119 int async_err_pipe_xrun;
106 int async_err_other_last; 120 int async_err_other_last;
107 121
108 unsigned char xlx_cfg; /* cop 122 unsigned char xlx_cfg; /* copy of PCXHR_XLX_CFG register */
109 unsigned char xlx_selmic; /* cop 123 unsigned char xlx_selmic; /* copy of PCXHR_XLX_SELMIC register */
110 unsigned char dsp_reset; /* cop 124 unsigned char dsp_reset; /* copy of PCXHR_DSP_RESET register */
111 }; 125 };
112 126
113 127
114 enum pcxhr_stream_status { 128 enum pcxhr_stream_status {
115 PCXHR_STREAM_STATUS_FREE, 129 PCXHR_STREAM_STATUS_FREE,
116 PCXHR_STREAM_STATUS_OPEN, 130 PCXHR_STREAM_STATUS_OPEN,
117 PCXHR_STREAM_STATUS_SCHEDULE_RUN, 131 PCXHR_STREAM_STATUS_SCHEDULE_RUN,
118 PCXHR_STREAM_STATUS_STARTED, 132 PCXHR_STREAM_STATUS_STARTED,
119 PCXHR_STREAM_STATUS_RUNNING, 133 PCXHR_STREAM_STATUS_RUNNING,
120 PCXHR_STREAM_STATUS_SCHEDULE_STOP, 134 PCXHR_STREAM_STATUS_SCHEDULE_STOP,
121 PCXHR_STREAM_STATUS_STOPPED, 135 PCXHR_STREAM_STATUS_STOPPED,
122 PCXHR_STREAM_STATUS_PAUSED 136 PCXHR_STREAM_STATUS_PAUSED
123 }; 137 };
124 138
125 struct pcxhr_stream { 139 struct pcxhr_stream {
126 struct snd_pcm_substream *substream; 140 struct snd_pcm_substream *substream;
127 snd_pcm_format_t format; 141 snd_pcm_format_t format;
128 struct pcxhr_pipe *pipe; 142 struct pcxhr_pipe *pipe;
129 143
130 enum pcxhr_stream_status status; 144 enum pcxhr_stream_status status; /* free, open, running, draining, pause */
131 145
132 u_int64_t timer_abs_periods; /* tim 146 u_int64_t timer_abs_periods; /* timer: samples elapsed since TRIGGER_START (multiple of period_size) */
133 u_int32_t timer_period_frag; /* tim 147 u_int32_t timer_period_frag; /* timer: samples elapsed since last call to snd_pcm_period_elapsed (0..period_size) */
134 u_int32_t timer_buf_periods; /* nb 148 u_int32_t timer_buf_periods; /* nb of periods in the buffer that have already elapsed */
135 int timer_is_synced; /* if( 149 int timer_is_synced; /* if(0) : timer needs to be resynced with real hardware pointer */
136 150
137 int channels; 151 int channels;
138 }; 152 };
139 153
140 154
141 enum pcxhr_pipe_status { 155 enum pcxhr_pipe_status {
142 PCXHR_PIPE_UNDEFINED, 156 PCXHR_PIPE_UNDEFINED,
143 PCXHR_PIPE_DEFINED 157 PCXHR_PIPE_DEFINED
144 }; 158 };
145 159
146 struct pcxhr_pipe { 160 struct pcxhr_pipe {
147 enum pcxhr_pipe_status status; 161 enum pcxhr_pipe_status status;
148 int is_capture; /* this is a c 162 int is_capture; /* this is a capture pipe */
149 int first_audio; /* first audio 163 int first_audio; /* first audio num */
150 }; 164 };
151 165
152 166
153 struct snd_pcxhr { 167 struct snd_pcxhr {
154 struct snd_card *card; 168 struct snd_card *card;
155 struct pcxhr_mgr *mgr; 169 struct pcxhr_mgr *mgr;
156 int chip_idx; /* zero based 170 int chip_idx; /* zero based */
157 171
158 struct snd_pcm *pcm; /* PCM 172 struct snd_pcm *pcm; /* PCM */
159 173
160 struct pcxhr_pipe playback_pipe; 174 struct pcxhr_pipe playback_pipe; /* 1 stereo pipe only */
161 struct pcxhr_pipe capture_pipe[2]; 175 struct pcxhr_pipe capture_pipe[2]; /* 1 stereo or 2 mono pipes */
162 176
163 struct pcxhr_stream playback_stream[PC 177 struct pcxhr_stream playback_stream[PCXHR_PLAYBACK_STREAMS];
164 struct pcxhr_stream capture_stream[2]; 178 struct pcxhr_stream capture_stream[2]; /* 1 stereo or 2 mono streams */
165 int nb_streams_play; 179 int nb_streams_play;
166 int nb_streams_capt; 180 int nb_streams_capt;
167 181
168 int analog_playback_active[2]; /* Mix 182 int analog_playback_active[2]; /* Mixer : Master Playback !mute */
169 int analog_playback_volume[2]; /* Mix 183 int analog_playback_volume[2]; /* Mixer : Master Playback Volume */
170 int analog_capture_volume[2]; /* Mix 184 int analog_capture_volume[2]; /* Mixer : Master Capture Volume */
171 int digital_playback_active[PCXHR_PLAY 185 int digital_playback_active[PCXHR_PLAYBACK_STREAMS][2];
172 int digital_playback_volume[PCXHR_PLAY 186 int digital_playback_volume[PCXHR_PLAYBACK_STREAMS][2];
173 int digital_capture_volume[2]; /* Mix 187 int digital_capture_volume[2]; /* Mixer : Digital Capture Volume */
174 int monitoring_active[2]; /* Mix 188 int monitoring_active[2]; /* Mixer : Monitoring Active */
175 int monitoring_volume[2]; /* Mix 189 int monitoring_volume[2]; /* Mixer : Monitoring Volume */
176 int audio_capture_source; /* Mix 190 int audio_capture_source; /* Mixer : Audio Capture Source */
177 int mic_volume; /* use 191 int mic_volume; /* used by cards with MIC only */
178 int mic_boost; /* use 192 int mic_boost; /* used by cards with MIC only */
179 int mic_active; /* use 193 int mic_active; /* used by cards with MIC only */
180 int analog_capture_active; /* use 194 int analog_capture_active; /* used by cards with MIC only */
181 int phantom_power; /* use 195 int phantom_power; /* used by cards with MIC only */
182 196
183 unsigned char aes_bits[5]; /* Mix 197 unsigned char aes_bits[5]; /* Mixer : IEC958_AES bits */
184 }; 198 };
185 199
186 struct pcxhr_hostport 200 struct pcxhr_hostport
187 { 201 {
188 char purgebuffer[6]; 202 char purgebuffer[6];
189 char reserved[2]; 203 char reserved[2];
190 }; 204 };
191 205
192 /* exported */ 206 /* exported */
193 int pcxhr_create_pcm(struct snd_pcxhr *chip); 207 int pcxhr_create_pcm(struct snd_pcxhr *chip);
194 int pcxhr_set_clock(struct pcxhr_mgr *mgr, uns 208 int pcxhr_set_clock(struct pcxhr_mgr *mgr, unsigned int rate);
195 int pcxhr_get_external_clock(struct pcxhr_mgr 209 int pcxhr_get_external_clock(struct pcxhr_mgr *mgr,
196 enum pcxhr_clock_ 210 enum pcxhr_clock_type clock_type,
197 int *sample_rate) 211 int *sample_rate);
198 212
199 #endif /* __SOUND_PCXHR_H */ 213 #endif /* __SOUND_PCXHR_H */
200 214
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.