2 * Driver for Digigram miXart soundcards
4 * low level interface with interrupt handling and mail box implementation
6 * Copyright (c) 2003 by Digigram <alsa@digigram.com>
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.
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.
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
23 #ifndef __SOUND_MIXART_CORE_H
24 #define __SOUND_MIXART_CORE_H
27 enum mixart_message_id
{
28 MSG_CONNECTOR_GET_AUDIO_INFO
= 0x050008,
29 MSG_CONNECTOR_GET_OUT_AUDIO_LEVEL
= 0x050009,
30 MSG_CONNECTOR_SET_OUT_AUDIO_LEVEL
= 0x05000A,
32 MSG_CONSOLE_MANAGER
= 0x070000,
33 MSG_CONSOLE_GET_CLOCK_UID
= 0x070003,
35 MSG_PHYSICALIO_SET_LEVEL
= 0x0F0008,
37 MSG_STREAM_ADD_INPUT_GROUP
= 0x130000,
38 MSG_STREAM_ADD_OUTPUT_GROUP
= 0x130001,
39 MSG_STREAM_DELETE_GROUP
= 0x130004,
40 MSG_STREAM_START_STREAM_GRP_PACKET
= 0x130006,
41 MSG_STREAM_START_INPUT_STAGE_PACKET
= 0x130007,
42 MSG_STREAM_START_OUTPUT_STAGE_PACKET
= 0x130008,
43 MSG_STREAM_STOP_STREAM_GRP_PACKET
= 0x130009,
44 MSG_STREAM_STOP_INPUT_STAGE_PACKET
= 0x13000A,
45 MSG_STREAM_STOP_OUTPUT_STAGE_PACKET
= 0x13000B,
46 MSG_STREAM_SET_INPUT_STAGE_PARAM
= 0x13000F,
47 MSG_STREAM_SET_OUTPUT_STAGE_PARAM
= 0x130010,
48 MSG_STREAM_SET_IN_AUDIO_LEVEL
= 0x130015,
49 MSG_STREAM_SET_OUT_STREAM_LEVEL
= 0x130017,
51 MSG_SYSTEM_FIRST_ID
= 0x160000,
52 MSG_SYSTEM_ENUM_PHYSICAL_IO
= 0x16000E,
53 MSG_SYSTEM_ENUM_PLAY_CONNECTOR
= 0x160017,
54 MSG_SYSTEM_ENUM_RECORD_CONNECTOR
= 0x160018,
55 MSG_SYSTEM_WAIT_SYNCHRO_CMD
= 0x16002C,
56 MSG_SYSTEM_SEND_SYNCHRO_CMD
= 0x16002D,
58 MSG_SERVICES_TIMER_NOTIFY
= 0x1D0404,
59 MSG_SERVICES_REPORT_TRACES
= 0x1D0700,
61 MSG_CLOCK_CHECK_PROPERTIES
= 0x200001,
62 MSG_CLOCK_SET_PROPERTIES
= 0x200002,
66 typedef struct mixart_msg mixart_msg_t
;
75 /* structs used to communicate with miXart */
77 typedef struct mixart_enum_connector_resp mixart_enum_connector_resp_t
;
78 struct mixart_enum_connector_resp
83 u32 current_uid_index
;
84 mixart_uid_t uid
[MIXART_MAX_PHYS_CONNECTORS
];
85 } __attribute__((packed
));
88 /* used for following struct */
89 #define MIXART_FLOAT_P_22_0_TO_HEX 0x41b00000 /* 22.0f */
90 #define MIXART_FLOAT_M_20_0_TO_HEX 0xc1a00000 /* -20.0f */
91 #define MIXART_FLOAT____0_0_TO_HEX 0x00000000 /* 0.0f */
93 typedef struct mixart_audio_info_req mixart_audio_info_req_t
;
94 struct mixart_audio_info_req
96 u32 line_max_level
; /* float */
97 u32 micro_max_level
; /* float */
98 u32 cd_max_level
; /* float */
99 } __attribute__((packed
));
101 typedef struct mixart_analog_hw_info mixart_analog_hw_info_t
;
102 struct mixart_analog_hw_info
105 u32 hw_connection_type
;
106 u32 max_level
; /* float */
107 u32 min_var_level
; /* float */
108 u32 max_var_level
; /* float */
109 u32 step_var_level
; /* float */
110 u32 fix_gain
; /* float */
111 u32 zero_var
; /* float */
112 } __attribute__((packed
));
114 typedef struct mixart_digital_hw_info mixart_digital_hw_info_t
;
115 struct mixart_digital_hw_info
117 u32 hw_connection_type
;
121 } __attribute__((packed
));
123 typedef struct mixart_analog_info mixart_analog_info_t
;
124 struct mixart_analog_info
127 mixart_analog_hw_info_t micro_info
;
128 mixart_analog_hw_info_t line_info
;
129 mixart_analog_hw_info_t cd_info
;
130 u32 analog_level_present
;
131 } __attribute__((packed
));
133 typedef struct mixart_digital_info mixart_digital_info_t
;
134 struct mixart_digital_info
137 mixart_digital_hw_info_t aes_info
;
138 mixart_digital_hw_info_t adat_info
;
139 } __attribute__((packed
));
141 typedef struct mixart_audio_info mixart_audio_info_t
;
142 struct mixart_audio_info
145 mixart_analog_info_t analog_info
;
146 mixart_digital_info_t digital_info
;
147 } __attribute__((packed
));
149 typedef struct mixart_audio_info_resp mixart_audio_info_resp_t
;
150 struct mixart_audio_info_resp
153 mixart_audio_info_t info
;
154 } __attribute__((packed
));
157 /* used for nb_bytes_max_per_sample */
158 #define MIXART_FLOAT_P__4_0_TO_HEX 0x40800000 /* +4.0f */
159 #define MIXART_FLOAT_P__8_0_TO_HEX 0x41000000 /* +8.0f */
161 typedef struct mixart_stream_info mixart_stream_info_t
;
162 struct mixart_stream_info
164 u32 size_max_byte_frame
;
165 u32 size_max_sample_frame
;
166 u32 nb_bytes_max_per_sample
; /* float */
167 } __attribute__((packed
));
169 /* MSG_STREAM_ADD_INPUT_GROUP */
170 /* MSG_STREAM_ADD_OUTPUT_GROUP */
172 typedef struct mixart_streaming_group_req mixart_streaming_group_req_t
;
173 struct mixart_streaming_group_req
178 u32 first_phys_audio
;
180 mixart_stream_info_t stream_info
[32];
181 mixart_uid_t connector
;
183 } __attribute__((packed
));
185 typedef struct mixart_stream_desc mixart_stream_desc_t
;
186 struct mixart_stream_desc
188 mixart_uid_t stream_uid
;
190 } __attribute__((packed
));
192 typedef struct mixart_streaming_group mixart_streaming_group_t
;
193 struct mixart_streaming_group
199 mixart_stream_desc_t stream
[32];
200 } __attribute__((packed
));
202 /* MSG_STREAM_DELETE_GROUP */
204 /* request : mixart_uid_t group */
206 typedef struct mixart_delete_group_resp mixart_delete_group_resp_t
;
207 struct mixart_delete_group_resp
211 } __attribute__((packed
));
214 /* MSG_STREAM_START_INPUT_STAGE_PACKET = 0x130000 + 7,
215 MSG_STREAM_START_OUTPUT_STAGE_PACKET = 0x130000 + 8,
216 MSG_STREAM_STOP_INPUT_STAGE_PACKET = 0x130000 + 10,
217 MSG_STREAM_STOP_OUTPUT_STAGE_PACKET = 0x130000 + 11,
220 typedef struct mixart_fx_couple_uid mixart_fx_couple_uid_t
;
221 struct mixart_fx_couple_uid
223 mixart_uid_t uid_fx_code
;
224 mixart_uid_t uid_fx_data
;
225 } __attribute__((packed
));
227 typedef struct mixart_txx_stream_desc mixart_txx_stream_desc_t
;
228 struct mixart_txx_stream_desc
230 mixart_uid_t uid_pipe
;
233 mixart_fx_couple_uid_t uid_fx
[4];
234 } __attribute__((packed
));
236 typedef struct mixart_flow_info mixart_flow_info_t
;
237 struct mixart_flow_info
239 mixart_txx_stream_desc_t stream_desc
;
242 } __attribute__((packed
));
244 typedef struct mixart_stream_state_req mixart_stream_state_req_t
;
245 struct mixart_stream_state_req
250 u32 stream_count
; /* set to 1 for instance */
251 mixart_flow_info_t stream_info
; /* could be an array[stream_count] */
252 } __attribute__((packed
));
254 /* MSG_STREAM_START_STREAM_GRP_PACKET = 0x130000 + 6
255 MSG_STREAM_STOP_STREAM_GRP_PACKET = 0x130000 + 9
258 typedef struct mixart_group_state_req mixart_group_state_req_t
;
259 struct mixart_group_state_req
264 u32 pipe_count
; /* set to 1 for instance */
265 mixart_uid_t pipe_uid
[1]; /* could be an array[pipe_count] */
266 } __attribute__((packed
));
268 typedef struct mixart_group_state_resp mixart_group_state_resp_t
;
269 struct mixart_group_state_resp
273 } __attribute__((packed
));
277 /* Structures used by the MSG_SERVICES_TIMER_NOTIFY command */
279 typedef struct mixart_sample_pos mixart_sample_pos_t
;
280 struct mixart_sample_pos
284 u32 sample_pos_high_part
;
285 u32 sample_pos_low_part
;
286 } __attribute__((packed
));
288 typedef struct mixart_timer_notify mixart_timer_notify_t
;
289 struct mixart_timer_notify
292 mixart_sample_pos_t streams
[MIXART_MAX_STREAM_PER_CARD
* MIXART_MAX_CARDS
];
293 } __attribute__((packed
));
296 /* MSG_CONSOLE_GET_CLOCK_UID = 0x070003,
299 /* request is a uid with desc = MSG_CONSOLE_MANAGER | cardindex */
301 typedef struct mixart_return_uid mixart_return_uid_t
;
302 struct mixart_return_uid
306 } __attribute__((packed
));
308 /* MSG_CLOCK_CHECK_PROPERTIES = 0x200001,
309 MSG_CLOCK_SET_PROPERTIES = 0x200002,
312 enum mixart_clock_generic_type
{
315 CGT_PROGRAMMABLE_CLOCK
,
316 CGT_INTERNAL_ENSLAVED_CLOCK
,
321 enum mixart_clock_mode
{
330 typedef struct mixart_clock_properties mixart_clock_properties_t
;
331 struct mixart_clock_properties
336 u32 reference_frequency
;
337 u32 clock_generic_type
;
339 mixart_uid_t uid_clock_source
;
340 mixart_uid_t uid_event_source
;
342 u32 synchro_signal_presence
;
345 u32 nb_callers
; /* set to 1 (see below) */
346 mixart_uid_t uid_caller
[1];
347 } __attribute__((packed
));
349 typedef struct mixart_clock_properties_resp mixart_clock_properties_resp_t
;
350 struct mixart_clock_properties_resp
354 } __attribute__((packed
));
357 /* MSG_STREAM_SET_INPUT_STAGE_PARAM = 0x13000F */
358 /* MSG_STREAM_SET_OUTPUT_STAGE_PARAM = 0x130010 */
360 enum mixart_coding_type
{
369 enum mixart_sample_type
{
371 ST_FLOATING_POINT_32BE
,
372 ST_FLOATING_POINT_32LE
,
373 ST_FLOATING_POINT_64BE
,
374 ST_FLOATING_POINT_64LE
,
391 typedef struct mixart_stream_param_desc mixart_stream_param_desc_t
;
392 struct mixart_stream_param_desc
394 u32 coding_type
; /* use enum mixart_coding_type */
395 u32 sample_type
; /* use enum mixart_sample_type */
399 u32 linear_endian_ness
;
403 } linear_format_info
;
408 u32 mpeg_mode_extension
;
409 u32 mpeg_pre_emphasis
;
410 u32 mpeg_has_padding_bit
;
412 u32 mpeg_has_extension
;
413 u32 mpeg_is_original
;
414 u32 mpeg_has_copyright
;
424 u32 samples_per_frame
;
426 u32 bytes_per_sample
;
428 u32 number_of_channel
;
433 u32 pipe_count
; /* set to 1 (array size !) */
434 u32 stream_count
; /* set to 1 (array size !) */
435 mixart_txx_stream_desc_t stream_desc
[1]; /* only one stream per command, but this could be an array */
437 } __attribute__((packed
));
440 /* MSG_CONNECTOR_GET_OUT_AUDIO_LEVEL = 0x050009,
444 typedef struct mixart_get_out_audio_level mixart_get_out_audio_level_t
;
445 struct mixart_get_out_audio_level
448 u32 digital_level
; /* float */
449 u32 analog_level
; /* float */
450 u32 monitor_level
; /* float */
454 } __attribute__((packed
));
457 /* MSG_CONNECTOR_SET_OUT_AUDIO_LEVEL = 0x05000A,
460 /* used for valid_mask below */
461 #define MIXART_AUDIO_LEVEL_ANALOG_MASK 0x01
462 #define MIXART_AUDIO_LEVEL_DIGITAL_MASK 0x02
463 #define MIXART_AUDIO_LEVEL_MONITOR_MASK 0x04
464 #define MIXART_AUDIO_LEVEL_MUTE_MASK 0x08
465 #define MIXART_AUDIO_LEVEL_MUTE_M1_MASK 0x10
466 #define MIXART_AUDIO_LEVEL_MUTE_M2_MASK 0x20
468 typedef struct mixart_set_out_audio_level mixart_set_out_audio_level_t
;
469 struct mixart_set_out_audio_level
475 u32 digital_level
; /* float */
476 u32 analog_level
; /* float */
477 u32 monitor_level
; /* float */
482 } __attribute__((packed
));
485 /* MSG_SYSTEM_ENUM_PHYSICAL_IO = 0x16000E,
488 #define MIXART_MAX_PHYS_IO (MIXART_MAX_CARDS * 2 * 2) /* 4 * (analog+digital) * (playback+capture) */
490 typedef struct mixart_uid_enumeration mixart_uid_enumeration_t
;
491 struct mixart_uid_enumeration
494 u32 first_uid_offset
;
496 u32 current_uid_index
;
497 mixart_uid_t uid
[MIXART_MAX_PHYS_IO
];
498 } __attribute__((packed
));
501 /* MSG_PHYSICALIO_SET_LEVEL = 0x0F0008,
502 MSG_PHYSICALIO_GET_LEVEL = 0x0F000C,
505 typedef struct mixart_io_channel_level mixart_io_channel_level_t
;
506 struct mixart_io_channel_level
508 u32 analog_level
; /* float */
510 } __attribute__((packed
));
512 typedef struct mixart_io_level mixart_io_level_t
;
513 struct mixart_io_level
515 s32 channel
; /* 0=left, 1=right, -1=both, -2=both same */
516 mixart_io_channel_level_t level
[2];
517 } __attribute__((packed
));
520 /* MSG_STREAM_SET_IN_AUDIO_LEVEL = 0x130015,
523 typedef struct mixart_in_audio_level_info mixart_in_audio_level_info_t
;
524 struct mixart_in_audio_level_info
526 mixart_uid_t connector
;
531 } __attribute__((packed
));
533 typedef struct mixart_set_in_audio_level_req mixart_set_in_audio_level_req_t
;
534 struct mixart_set_in_audio_level_req
538 u32 audio_count
; /* set to <= 2 */
540 mixart_in_audio_level_info_t level
[2];
541 } __attribute__((packed
));
543 /* response is a 32 bit status */
546 /* MSG_STREAM_SET_OUT_STREAM_LEVEL = 0x130017,
549 /* defines used for valid_mask1 */
550 #define MIXART_OUT_STREAM_SET_LEVEL_LEFT_AUDIO1 0x01
551 #define MIXART_OUT_STREAM_SET_LEVEL_LEFT_AUDIO2 0x02
552 #define MIXART_OUT_STREAM_SET_LEVEL_RIGHT_AUDIO1 0x04
553 #define MIXART_OUT_STREAM_SET_LEVEL_RIGHT_AUDIO2 0x08
554 #define MIXART_OUT_STREAM_SET_LEVEL_STREAM_1 0x10
555 #define MIXART_OUT_STREAM_SET_LEVEL_STREAM_2 0x20
556 #define MIXART_OUT_STREAM_SET_LEVEL_MUTE_1 0x40
557 #define MIXART_OUT_STREAM_SET_LEVEL_MUTE_2 0x80
559 typedef struct mixart_out_stream_level_info mixart_out_stream_level_info_t
;
560 struct mixart_out_stream_level_info
564 u32 left_to_out1_level
;
565 u32 left_to_out2_level
;
566 u32 right_to_out1_level
;
567 u32 right_to_out2_level
;
572 } __attribute__((packed
));
574 typedef struct mixart_set_out_stream_level mixart_set_out_stream_level_t
;
575 struct mixart_set_out_stream_level
577 mixart_txx_stream_desc_t desc
;
578 mixart_out_stream_level_info_t out_level
;
579 } __attribute__((packed
));
581 typedef struct mixart_set_out_stream_level_req mixart_set_out_stream_level_req_t
;
582 struct mixart_set_out_stream_level_req
587 u32 nb_of_stream
; /* set to 1 */
588 mixart_set_out_stream_level_t stream_level
; /* could be an array */
589 } __attribute__((packed
));
591 /* response to this request is a u32 status value */
595 void snd_mixart_init_mailbox(mixart_mgr_t
*mgr
);
596 void snd_mixart_exit_mailbox(mixart_mgr_t
*mgr
);
598 int snd_mixart_send_msg(mixart_mgr_t
*mgr
, mixart_msg_t
*request
, int max_resp_size
, void *resp_data
);
599 int snd_mixart_send_msg_wait_notif(mixart_mgr_t
*mgr
, mixart_msg_t
*request
, u32 notif_event
);
600 int snd_mixart_send_msg_nonblock(mixart_mgr_t
*mgr
, mixart_msg_t
*request
);
602 irqreturn_t
snd_mixart_interrupt(int irq
, void *dev_id
, struct pt_regs
*regs
);
603 void snd_mixart_msg_tasklet( unsigned long arg
);
605 void snd_mixart_reset_board(mixart_mgr_t
*mgr
);
607 #endif /* __SOUND_MIXART_CORE_H */