1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * Driver for Digigram miXart soundcards
5 * low level interface with interrupt handling and mail box implementation
7 * Copyright (c) 2003 by Digigram <alsa@digigram.com>
10 #ifndef __SOUND_MIXART_CORE_H
11 #define __SOUND_MIXART_CORE_H
14 enum mixart_message_id {
15 MSG_CONNECTOR_GET_AUDIO_INFO = 0x050008,
16 MSG_CONNECTOR_GET_OUT_AUDIO_LEVEL = 0x050009,
17 MSG_CONNECTOR_SET_OUT_AUDIO_LEVEL = 0x05000A,
19 MSG_CONSOLE_MANAGER = 0x070000,
20 MSG_CONSOLE_GET_CLOCK_UID = 0x070003,
22 MSG_PHYSICALIO_SET_LEVEL = 0x0F0008,
24 MSG_STREAM_ADD_INPUT_GROUP = 0x130000,
25 MSG_STREAM_ADD_OUTPUT_GROUP = 0x130001,
26 MSG_STREAM_DELETE_GROUP = 0x130004,
27 MSG_STREAM_START_STREAM_GRP_PACKET = 0x130006,
28 MSG_STREAM_START_INPUT_STAGE_PACKET = 0x130007,
29 MSG_STREAM_START_OUTPUT_STAGE_PACKET = 0x130008,
30 MSG_STREAM_STOP_STREAM_GRP_PACKET = 0x130009,
31 MSG_STREAM_STOP_INPUT_STAGE_PACKET = 0x13000A,
32 MSG_STREAM_STOP_OUTPUT_STAGE_PACKET = 0x13000B,
33 MSG_STREAM_SET_INPUT_STAGE_PARAM = 0x13000F,
34 MSG_STREAM_SET_OUTPUT_STAGE_PARAM = 0x130010,
35 MSG_STREAM_SET_IN_AUDIO_LEVEL = 0x130015,
36 MSG_STREAM_SET_OUT_STREAM_LEVEL = 0x130017,
38 MSG_SYSTEM_FIRST_ID = 0x160000,
39 MSG_SYSTEM_ENUM_PHYSICAL_IO = 0x16000E,
40 MSG_SYSTEM_ENUM_PLAY_CONNECTOR = 0x160017,
41 MSG_SYSTEM_ENUM_RECORD_CONNECTOR = 0x160018,
42 MSG_SYSTEM_WAIT_SYNCHRO_CMD = 0x16002C,
43 MSG_SYSTEM_SEND_SYNCHRO_CMD = 0x16002D,
45 MSG_SERVICES_TIMER_NOTIFY = 0x1D0404,
46 MSG_SERVICES_REPORT_TRACES = 0x1D0700,
48 MSG_CLOCK_CHECK_PROPERTIES = 0x200001,
49 MSG_CLOCK_SET_PROPERTIES = 0x200002,
52 #define MSG_DEFAULT_SIZE 512
57 struct mixart_uid uid;
62 /* structs used to communicate with miXart */
64 struct mixart_enum_connector_resp
69 u32 current_uid_index;
70 struct mixart_uid uid[MIXART_MAX_PHYS_CONNECTORS];
71 } __attribute__((packed));
74 /* used for following struct */
75 #define MIXART_FLOAT_P_22_0_TO_HEX 0x41b00000 /* 22.0f */
76 #define MIXART_FLOAT_M_20_0_TO_HEX 0xc1a00000 /* -20.0f */
77 #define MIXART_FLOAT____0_0_TO_HEX 0x00000000 /* 0.0f */
79 struct mixart_audio_info_req
81 u32 line_max_level; /* float */
82 u32 micro_max_level; /* float */
83 u32 cd_max_level; /* float */
84 } __attribute__((packed));
86 struct mixart_analog_hw_info
89 u32 hw_connection_type;
90 u32 max_level; /* float */
91 u32 min_var_level; /* float */
92 u32 max_var_level; /* float */
93 u32 step_var_level; /* float */
94 u32 fix_gain; /* float */
95 u32 zero_var; /* float */
96 } __attribute__((packed));
98 struct mixart_digital_hw_info
100 u32 hw_connection_type;
104 } __attribute__((packed));
106 struct mixart_analog_info
109 struct mixart_analog_hw_info micro_info;
110 struct mixart_analog_hw_info line_info;
111 struct mixart_analog_hw_info cd_info;
112 u32 analog_level_present;
113 } __attribute__((packed));
115 struct mixart_digital_info
118 struct mixart_digital_hw_info aes_info;
119 struct mixart_digital_hw_info adat_info;
120 } __attribute__((packed));
122 struct mixart_audio_info
125 struct mixart_analog_info analog_info;
126 struct mixart_digital_info digital_info;
127 } __attribute__((packed));
129 struct mixart_audio_info_resp
132 struct mixart_audio_info info;
133 } __attribute__((packed));
136 /* used for nb_bytes_max_per_sample */
137 #define MIXART_FLOAT_P__4_0_TO_HEX 0x40800000 /* +4.0f */
138 #define MIXART_FLOAT_P__8_0_TO_HEX 0x41000000 /* +8.0f */
140 struct mixart_stream_info
142 u32 size_max_byte_frame;
143 u32 size_max_sample_frame;
144 u32 nb_bytes_max_per_sample; /* float */
145 } __attribute__((packed));
147 /* MSG_STREAM_ADD_INPUT_GROUP */
148 /* MSG_STREAM_ADD_OUTPUT_GROUP */
150 struct mixart_streaming_group_req
155 u32 first_phys_audio;
157 struct mixart_stream_info stream_info[32];
158 struct mixart_uid connector;
160 } __attribute__((packed));
162 struct mixart_stream_desc
164 struct mixart_uid stream_uid;
166 } __attribute__((packed));
168 struct mixart_streaming_group
171 struct mixart_uid group;
174 struct mixart_stream_desc stream[32];
175 } __attribute__((packed));
177 /* MSG_STREAM_DELETE_GROUP */
179 /* request : mixart_uid_t group */
181 struct mixart_delete_group_resp
185 } __attribute__((packed));
188 /* MSG_STREAM_START_INPUT_STAGE_PACKET = 0x130000 + 7,
189 MSG_STREAM_START_OUTPUT_STAGE_PACKET = 0x130000 + 8,
190 MSG_STREAM_STOP_INPUT_STAGE_PACKET = 0x130000 + 10,
191 MSG_STREAM_STOP_OUTPUT_STAGE_PACKET = 0x130000 + 11,
194 struct mixart_fx_couple_uid
196 struct mixart_uid uid_fx_code;
197 struct mixart_uid uid_fx_data;
198 } __attribute__((packed));
200 struct mixart_txx_stream_desc
202 struct mixart_uid uid_pipe;
205 struct mixart_fx_couple_uid uid_fx[4];
206 } __attribute__((packed));
208 struct mixart_flow_info
210 struct mixart_txx_stream_desc stream_desc;
213 } __attribute__((packed));
215 struct mixart_stream_state_req
220 u32 stream_count; /* set to 1 for instance */
221 struct mixart_flow_info stream_info; /* could be an array[stream_count] */
222 } __attribute__((packed));
224 /* MSG_STREAM_START_STREAM_GRP_PACKET = 0x130000 + 6
225 MSG_STREAM_STOP_STREAM_GRP_PACKET = 0x130000 + 9
228 struct mixart_group_state_req
233 u32 pipe_count; /* set to 1 for instance */
234 struct mixart_uid pipe_uid[1]; /* could be an array[pipe_count] */
235 } __attribute__((packed));
237 struct mixart_group_state_resp
241 } __attribute__((packed));
245 /* Structures used by the MSG_SERVICES_TIMER_NOTIFY command */
247 struct mixart_sample_pos
251 u32 sample_pos_high_part;
252 u32 sample_pos_low_part;
253 } __attribute__((packed));
256 * This structure is limited by the size of MSG_DEFAULT_SIZE. Instead of
257 * having MIXART_MAX_STREAM_PER_CARD * MIXART_MAX_CARDS many streams,
258 * this is capped to have a total size below MSG_DEFAULT_SIZE.
260 #define MIXART_MAX_TIMER_NOTIFY_STREAMS \
261 ((MSG_DEFAULT_SIZE - sizeof(u32)) / sizeof(struct mixart_sample_pos))
262 struct mixart_timer_notify
265 struct mixart_sample_pos streams[MIXART_MAX_TIMER_NOTIFY_STREAMS];
266 } __attribute__((packed));
269 /* MSG_CONSOLE_GET_CLOCK_UID = 0x070003,
272 /* request is a uid with desc = MSG_CONSOLE_MANAGER | cardindex */
274 struct mixart_return_uid
277 struct mixart_uid uid;
278 } __attribute__((packed));
280 /* MSG_CLOCK_CHECK_PROPERTIES = 0x200001,
281 MSG_CLOCK_SET_PROPERTIES = 0x200002,
284 enum mixart_clock_generic_type {
287 CGT_PROGRAMMABLE_CLOCK,
288 CGT_INTERNAL_ENSLAVED_CLOCK,
293 enum mixart_clock_mode {
302 struct mixart_clock_properties
307 u32 reference_frequency;
308 u32 clock_generic_type;
310 struct mixart_uid uid_clock_source;
311 struct mixart_uid uid_event_source;
313 u32 synchro_signal_presence;
316 u32 nb_callers; /* set to 1 (see below) */
317 struct mixart_uid uid_caller[1];
318 } __attribute__((packed));
320 struct mixart_clock_properties_resp
324 } __attribute__((packed));
327 /* MSG_STREAM_SET_INPUT_STAGE_PARAM = 0x13000F */
328 /* MSG_STREAM_SET_OUTPUT_STAGE_PARAM = 0x130010 */
330 enum mixart_coding_type {
339 enum mixart_sample_type {
341 ST_FLOATING_POINT_32BE,
342 ST_FLOATING_POINT_32LE,
343 ST_FLOATING_POINT_64BE,
344 ST_FLOATING_POINT_64LE,
361 struct mixart_stream_param_desc
363 u32 coding_type; /* use enum mixart_coding_type */
364 u32 sample_type; /* use enum mixart_sample_type */
368 u32 linear_endian_ness;
372 } linear_format_info;
377 u32 mpeg_mode_extension;
378 u32 mpeg_pre_emphasis;
379 u32 mpeg_has_padding_bit;
381 u32 mpeg_has_extension;
382 u32 mpeg_is_original;
383 u32 mpeg_has_copyright;
393 u32 samples_per_frame;
395 u32 bytes_per_sample;
397 u32 number_of_channel;
402 u32 pipe_count; /* set to 1 (array size !) */
403 u32 stream_count; /* set to 1 (array size !) */
404 struct mixart_txx_stream_desc stream_desc[1]; /* only one stream per command, but this could be an array */
406 } __attribute__((packed));
409 /* MSG_CONNECTOR_GET_OUT_AUDIO_LEVEL = 0x050009,
413 struct mixart_get_out_audio_level
416 u32 digital_level; /* float */
417 u32 analog_level; /* float */
418 u32 monitor_level; /* float */
422 } __attribute__((packed));
425 /* MSG_CONNECTOR_SET_OUT_AUDIO_LEVEL = 0x05000A,
428 /* used for valid_mask below */
429 #define MIXART_AUDIO_LEVEL_ANALOG_MASK 0x01
430 #define MIXART_AUDIO_LEVEL_DIGITAL_MASK 0x02
431 #define MIXART_AUDIO_LEVEL_MONITOR_MASK 0x04
432 #define MIXART_AUDIO_LEVEL_MUTE_MASK 0x08
433 #define MIXART_AUDIO_LEVEL_MUTE_M1_MASK 0x10
434 #define MIXART_AUDIO_LEVEL_MUTE_M2_MASK 0x20
436 struct mixart_set_out_audio_level
442 u32 digital_level; /* float */
443 u32 analog_level; /* float */
444 u32 monitor_level; /* float */
449 } __attribute__((packed));
452 /* MSG_SYSTEM_ENUM_PHYSICAL_IO = 0x16000E,
455 #define MIXART_MAX_PHYS_IO (MIXART_MAX_CARDS * 2 * 2) /* 4 * (analog+digital) * (playback+capture) */
457 struct mixart_uid_enumeration
460 u32 first_uid_offset;
462 u32 current_uid_index;
463 struct mixart_uid uid[MIXART_MAX_PHYS_IO];
464 } __attribute__((packed));
467 /* MSG_PHYSICALIO_SET_LEVEL = 0x0F0008,
468 MSG_PHYSICALIO_GET_LEVEL = 0x0F000C,
471 struct mixart_io_channel_level
473 u32 analog_level; /* float */
475 } __attribute__((packed));
477 struct mixart_io_level
479 s32 channel; /* 0=left, 1=right, -1=both, -2=both same */
480 struct mixart_io_channel_level level[2];
481 } __attribute__((packed));
484 /* MSG_STREAM_SET_IN_AUDIO_LEVEL = 0x130015,
487 struct mixart_in_audio_level_info
489 struct mixart_uid connector;
494 } __attribute__((packed));
496 struct mixart_set_in_audio_level_req
500 u32 audio_count; /* set to <= 2 */
502 struct mixart_in_audio_level_info level[2];
503 } __attribute__((packed));
505 /* response is a 32 bit status */
508 /* MSG_STREAM_SET_OUT_STREAM_LEVEL = 0x130017,
511 /* defines used for valid_mask1 */
512 #define MIXART_OUT_STREAM_SET_LEVEL_LEFT_AUDIO1 0x01
513 #define MIXART_OUT_STREAM_SET_LEVEL_LEFT_AUDIO2 0x02
514 #define MIXART_OUT_STREAM_SET_LEVEL_RIGHT_AUDIO1 0x04
515 #define MIXART_OUT_STREAM_SET_LEVEL_RIGHT_AUDIO2 0x08
516 #define MIXART_OUT_STREAM_SET_LEVEL_STREAM_1 0x10
517 #define MIXART_OUT_STREAM_SET_LEVEL_STREAM_2 0x20
518 #define MIXART_OUT_STREAM_SET_LEVEL_MUTE_1 0x40
519 #define MIXART_OUT_STREAM_SET_LEVEL_MUTE_2 0x80
521 struct mixart_out_stream_level_info
525 u32 left_to_out1_level;
526 u32 left_to_out2_level;
527 u32 right_to_out1_level;
528 u32 right_to_out2_level;
533 } __attribute__((packed));
535 struct mixart_set_out_stream_level
537 struct mixart_txx_stream_desc desc;
538 struct mixart_out_stream_level_info out_level;
539 } __attribute__((packed));
541 struct mixart_set_out_stream_level_req
546 u32 nb_of_stream; /* set to 1 */
547 struct mixart_set_out_stream_level stream_level; /* could be an array */
548 } __attribute__((packed));
550 /* response to this request is a u32 status value */
554 void snd_mixart_init_mailbox(struct mixart_mgr *mgr);
555 void snd_mixart_exit_mailbox(struct mixart_mgr *mgr);
557 int snd_mixart_send_msg(struct mixart_mgr *mgr, struct mixart_msg *request, int max_resp_size, void *resp_data);
558 int snd_mixart_send_msg_wait_notif(struct mixart_mgr *mgr, struct mixart_msg *request, u32 notif_event);
559 int snd_mixart_send_msg_nonblock(struct mixart_mgr *mgr, struct mixart_msg *request);
561 irqreturn_t snd_mixart_interrupt(int irq, void *dev_id);
562 irqreturn_t snd_mixart_threaded_irq(int irq, void *dev_id);
564 void snd_mixart_reset_board(struct mixart_mgr *mgr);
566 #endif /* __SOUND_MIXART_CORE_H */