1 // SPDX-License-Identifier: GPL-2.0-only 2 // 3 // motu-register-dsp-message-parser.c - a part of driver for MOTU FireWire series 4 // 5 // Copyright (c) 2021 Takashi Sakamoto <o-takashi@sakamocchi.jp> 6 7 // Below models allow software to configure their DSP functions by asynchronous transaction 8 // to access their internal registers. 9 // * 828 mk2 10 // * 896hd 11 // * Traveler 12 // * 8 pre 13 // * Ultralite 14 // * 4 pre 15 // * Audio Express 16 // 17 // Additionally, isochronous packets from the above models include messages to notify state of 18 // DSP. The messages are two set of 3 byte data in 2nd and 3rd quadlet of data block. When user 19 // operates hardware components such as dial and switch, corresponding messages are transferred. 20 // The messages include Hardware metering and MIDI messages as well. 21 22 #include "motu.h" 23 24 #define MSG_FLAG_POS 4 25 #define MSG_FLAG_TYPE_MASK 0xf8 26 #define MSG_FLAG_MIDI_MASK 0x01 27 #define MSG_FLAG_MODEL_SPECIFIC_MASK 0x06 28 #define MSG_FLAG_8PRE 0x00 29 #define MSG_FLAG_ULTRALITE 0x04 30 #define MSG_FLAG_TRAVELER 0x04 31 #define MSG_FLAG_828MK2 0x04 32 #define MSG_FLAG_896HD 0x04 33 #define MSG_FLAG_4PRE 0x05 // MIDI mask is in 8th byte. 34 #define MSG_FLAG_AUDIOEXPRESS 0x05 // MIDI mask is in 8th byte. 35 #define MSG_FLAG_TYPE_SHIFT 3 36 #define MSG_VALUE_POS 5 37 #define MSG_MIDI_BYTE_POS 6 38 #define MSG_METER_IDX_POS 7 39 40 // In 4 pre and Audio express, meter index is in 6th byte. MIDI flag is in 8th byte and MIDI byte 41 // is in 7th byte. 42 #define MSG_METER_IDX_POS_4PRE_AE 6 43 #define MSG_MIDI_BYTE_POS_4PRE_AE 7 44 #define MSG_FLAG_MIDI_POS_4PRE_AE 8 45 46 enum register_dsp_msg_type { 47 // Used for messages with no information. 48 INVALID = 0x00, 49 MIXER_SELECT = 0x01, 50 MIXER_SRC_GAIN = 0x02, 51 MIXER_SRC_PAN = 0x03, 52 MIXER_SRC_FLAG = 0x04, 53 MIXER_OUTPUT_PAIRED_VOLUME = 0x05, 54 MIXER_OUTPUT_PAIRED_FLAG = 0x06, 55 MAIN_OUTPUT_PAIRED_VOLUME = 0x07, 56 HP_OUTPUT_PAIRED_VOLUME = 0x08, 57 HP_OUTPUT_PAIRED_ASSIGNMENT = 0x09, 58 // Transferred by all models but the purpose is still unknown. 59 UNKNOWN_0 = 0x0a, 60 // Specific to 828mk2, 896hd, Traveler. 61 UNKNOWN_2 = 0x0c, 62 // Specific to 828mk2, Traveler, and 896hd (not functional). 63 LINE_INPUT_BOOST = 0x0d, 64 // Specific to 828mk2, Traveler, and 896hd (not functional). 65 LINE_INPUT_NOMINAL_LEVEL = 0x0e, 66 // Specific to Ultralite, 4 pre, Audio express, and 8 pre (not functional). 67 INPUT_GAIN_AND_INVERT = 0x15, 68 // Specific to 4 pre, and Audio express. 69 INPUT_FLAG = 0x16, 70 // Specific to 4 pre, and Audio express. 71 MIXER_SRC_PAIRED_BALANCE = 0x17, 72 // Specific to 4 pre, and Audio express. 73 MIXER_SRC_PAIRED_WIDTH = 0x18, 74 // Transferred by all models. This type of message interposes the series of the other 75 // messages. The message delivers signal level up to 96.0 kHz. In 828mk2, 896hd, and 76 // Traveler, one of physical outputs is selected for the message. The selection is done 77 // by LSB one byte in asynchronous write quadlet transaction to 0x'ffff'f000'0b2c. 78 METER = 0x1f, 79 }; 80 81 #define EVENT_QUEUE_SIZE 16 82 83 struct msg_parser { 84 spinlock_t lock; 85 struct snd_firewire_motu_register_dsp_meter meter; 86 bool meter_pos_quirk; 87 88 struct snd_firewire_motu_register_dsp_parameter param; 89 u8 prev_mixer_src_type; 90 u8 mixer_ch; 91 u8 mixer_src_ch; 92 93 u8 input_ch; 94 u8 prev_msg_type; 95 96 u32 event_queue[EVENT_QUEUE_SIZE]; 97 unsigned int push_pos; 98 }; 99 100 int snd_motu_register_dsp_message_parser_new(struct snd_motu *motu) 101 { 102 struct msg_parser *parser; 103 parser = devm_kzalloc(&motu->card->card_dev, sizeof(*parser), GFP_KERNEL); 104 if (!parser) 105 return -ENOMEM; 106 spin_lock_init(&parser->lock); 107 if (motu->spec == &snd_motu_spec_4pre || motu->spec == &snd_motu_spec_audio_express) 108 parser->meter_pos_quirk = true; 109 motu->message_parser = parser; 110 return 0; 111 } 112 113 int snd_motu_register_dsp_message_parser_init(struct snd_motu *motu) 114 { 115 struct msg_parser *parser = motu->message_parser; 116 117 parser->prev_mixer_src_type = INVALID; 118 parser->mixer_ch = 0xff; 119 parser->mixer_src_ch = 0xff; 120 parser->prev_msg_type = INVALID; 121 122 return 0; 123 } 124 125 static void queue_event(struct snd_motu *motu, u8 msg_type, u8 identifier0, u8 identifier1, u8 val) 126 { 127 struct msg_parser *parser = motu->message_parser; 128 unsigned int pos = parser->push_pos; 129 u32 entry; 130 131 if (!motu->hwdep || motu->hwdep->used == 0) 132 return; 133 134 entry = (msg_type << 24) | (identifier0 << 16) | (identifier1 << 8) | val; 135 parser->event_queue[pos] = entry; 136 137 ++pos; 138 if (pos >= EVENT_QUEUE_SIZE) 139 pos = 0; 140 parser->push_pos = pos; 141 } 142 143 void snd_motu_register_dsp_message_parser_parse(struct snd_motu *motu, const struct pkt_desc *descs, 144 unsigned int desc_count, unsigned int data_block_quadlets) 145 { 146 struct msg_parser *parser = motu->message_parser; 147 bool meter_pos_quirk = parser->meter_pos_quirk; 148 unsigned long flags; 149 int i; 150 151 spin_lock_irqsave(&parser->lock, flags); 152 153 for (i = 0; i < desc_count; ++i) { 154 const struct pkt_desc *desc = descs + i; 155 __be32 *buffer = desc->ctx_payload; 156 unsigned int data_blocks = desc->data_blocks; 157 int j; 158 159 for (j = 0; j < data_blocks; ++j) { 160 u8 *b = (u8 *)buffer; 161 u8 msg_type = (b[MSG_FLAG_POS] & MSG_FLAG_TYPE_MASK) >> MSG_FLAG_TYPE_SHIFT; 162 u8 val = b[MSG_VALUE_POS]; 163 164 buffer += data_block_quadlets; 165 166 switch (msg_type) { 167 case MIXER_SELECT: 168 { 169 u8 mixer_ch = val / 0x20; 170 if (mixer_ch < SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_COUNT) { 171 parser->mixer_src_ch = 0; 172 parser->mixer_ch = mixer_ch; 173 } 174 break; 175 } 176 case MIXER_SRC_GAIN: 177 case MIXER_SRC_PAN: 178 case MIXER_SRC_FLAG: 179 case MIXER_SRC_PAIRED_BALANCE: 180 case MIXER_SRC_PAIRED_WIDTH: 181 { 182 struct snd_firewire_motu_register_dsp_parameter *param = &parser->param; 183 u8 mixer_ch = parser->mixer_ch; 184 u8 mixer_src_ch = parser->mixer_src_ch; 185 186 if (msg_type != parser->prev_mixer_src_type) 187 mixer_src_ch = 0; 188 else 189 ++mixer_src_ch; 190 parser->prev_mixer_src_type = msg_type; 191 192 if (mixer_ch < SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_COUNT && 193 mixer_src_ch < SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_SRC_COUNT) { 194 u8 mixer_ch = parser->mixer_ch; 195 196 switch (msg_type) { 197 case MIXER_SRC_GAIN: 198 if (param->mixer.source[mixer_ch].gain[mixer_src_ch] != val) { 199 queue_event(motu, msg_type, mixer_ch, mixer_src_ch, val); 200 param->mixer.source[mixer_ch].gain[mixer_src_ch] = val; 201 } 202 break; 203 case MIXER_SRC_PAN: 204 if (param->mixer.source[mixer_ch].pan[mixer_src_ch] != val) { 205 queue_event(motu, msg_type, mixer_ch, mixer_src_ch, val); 206 param->mixer.source[mixer_ch].pan[mixer_src_ch] = val; 207 } 208 break; 209 case MIXER_SRC_FLAG: 210 if (param->mixer.source[mixer_ch].flag[mixer_src_ch] != val) { 211 queue_event(motu, msg_type, mixer_ch, mixer_src_ch, val); 212 param->mixer.source[mixer_ch].flag[mixer_src_ch] = val; 213 } 214 break; 215 case MIXER_SRC_PAIRED_BALANCE: 216 if (param->mixer.source[mixer_ch].paired_balance[mixer_src_ch] != val) { 217 queue_event(motu, msg_type, mixer_ch, mixer_src_ch, val); 218 param->mixer.source[mixer_ch].paired_balance[mixer_src_ch] = val; 219 } 220 break; 221 case MIXER_SRC_PAIRED_WIDTH: 222 if (param->mixer.source[mixer_ch].paired_width[mixer_src_ch] != val) { 223 queue_event(motu, msg_type, mixer_ch, mixer_src_ch, val); 224 param->mixer.source[mixer_ch].paired_width[mixer_src_ch] = val; 225 } 226 break; 227 default: 228 break; 229 } 230 231 parser->mixer_src_ch = mixer_src_ch; 232 } 233 break; 234 } 235 case MIXER_OUTPUT_PAIRED_VOLUME: 236 case MIXER_OUTPUT_PAIRED_FLAG: 237 { 238 struct snd_firewire_motu_register_dsp_parameter *param = &parser->param; 239 u8 mixer_ch = parser->mixer_ch; 240 241 if (mixer_ch < SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_COUNT) { 242 switch (msg_type) { 243 case MIXER_OUTPUT_PAIRED_VOLUME: 244 if (param->mixer.output.paired_volume[mixer_ch] != val) { 245 queue_event(motu, msg_type, mixer_ch, 0, val); 246 param->mixer.output.paired_volume[mixer_ch] = val; 247 } 248 break; 249 case MIXER_OUTPUT_PAIRED_FLAG: 250 if (param->mixer.output.paired_flag[mixer_ch] != val) { 251 queue_event(motu, msg_type, mixer_ch, 0, val); 252 param->mixer.output.paired_flag[mixer_ch] = val; 253 } 254 break; 255 default: 256 break; 257 } 258 } 259 break; 260 } 261 case MAIN_OUTPUT_PAIRED_VOLUME: 262 if (parser->param.output.main_paired_volume != val) { 263 queue_event(motu, msg_type, 0, 0, val); 264 parser->param.output.main_paired_volume = val; 265 } 266 break; 267 case HP_OUTPUT_PAIRED_VOLUME: 268 if (parser->param.output.hp_paired_volume != val) { 269 queue_event(motu, msg_type, 0, 0, val); 270 parser->param.output.hp_paired_volume = val; 271 } 272 break; 273 case HP_OUTPUT_PAIRED_ASSIGNMENT: 274 if (parser->param.output.hp_paired_assignment != val) { 275 queue_event(motu, msg_type, 0, 0, val); 276 parser->param.output.hp_paired_assignment = val; 277 } 278 break; 279 case LINE_INPUT_BOOST: 280 if (parser->param.line_input.boost_flag != val) { 281 queue_event(motu, msg_type, 0, 0, val); 282 parser->param.line_input.boost_flag = val; 283 } 284 break; 285 case LINE_INPUT_NOMINAL_LEVEL: 286 if (parser->param.line_input.nominal_level_flag != val) { 287 queue_event(motu, msg_type, 0, 0, val); 288 parser->param.line_input.nominal_level_flag = val; 289 } 290 break; 291 case INPUT_GAIN_AND_INVERT: 292 case INPUT_FLAG: 293 { 294 struct snd_firewire_motu_register_dsp_parameter *param = &parser->param; 295 u8 input_ch = parser->input_ch; 296 297 if (parser->prev_msg_type != msg_type) 298 input_ch = 0; 299 else 300 ++input_ch; 301 302 if (input_ch < SNDRV_FIREWIRE_MOTU_REGISTER_DSP_INPUT_COUNT) { 303 switch (msg_type) { 304 case INPUT_GAIN_AND_INVERT: 305 if (param->input.gain_and_invert[input_ch] != val) { 306 queue_event(motu, msg_type, input_ch, 0, val); 307 param->input.gain_and_invert[input_ch] = val; 308 } 309 break; 310 case INPUT_FLAG: 311 if (param->input.flag[input_ch] != val) { 312 queue_event(motu, msg_type, input_ch, 0, val); 313 param->input.flag[input_ch] = val; 314 } 315 break; 316 default: 317 break; 318 } 319 parser->input_ch = input_ch; 320 } 321 break; 322 } 323 case UNKNOWN_0: 324 case UNKNOWN_2: 325 break; 326 case METER: 327 { 328 u8 pos; 329 330 if (!meter_pos_quirk) 331 pos = b[MSG_METER_IDX_POS]; 332 else 333 pos = b[MSG_METER_IDX_POS_4PRE_AE]; 334 335 if (pos < 0x80) 336 pos &= 0x1f; 337 else 338 pos = (pos & 0x1f) + 20; 339 parser->meter.data[pos] = val; 340 // The message for meter is interruptible to the series of other 341 // types of messages. Don't cache it. 342 fallthrough; 343 } 344 case INVALID: 345 default: 346 // Don't cache it. 347 continue; 348 } 349 350 parser->prev_msg_type = msg_type; 351 } 352 } 353 354 spin_unlock_irqrestore(&parser->lock, flags); 355 } 356 357 void snd_motu_register_dsp_message_parser_copy_meter(struct snd_motu *motu, 358 struct snd_firewire_motu_register_dsp_meter *meter) 359 { 360 struct msg_parser *parser = motu->message_parser; 361 unsigned long flags; 362 363 spin_lock_irqsave(&parser->lock, flags); 364 memcpy(meter, &parser->meter, sizeof(*meter)); 365 spin_unlock_irqrestore(&parser->lock, flags); 366 } 367 368 void snd_motu_register_dsp_message_parser_copy_parameter(struct snd_motu *motu, 369 struct snd_firewire_motu_register_dsp_parameter *param) 370 { 371 struct msg_parser *parser = motu->message_parser; 372 unsigned long flags; 373 374 spin_lock_irqsave(&parser->lock, flags); 375 memcpy(param, &parser->param, sizeof(*param)); 376 spin_unlock_irqrestore(&parser->lock, flags); 377 } 378