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 struct msg_parser { 82 spinlock_t lock; 83 struct snd_firewire_motu_register_dsp_meter meter; 84 bool meter_pos_quirk; 85 86 struct snd_firewire_motu_register_dsp_parameter param; 87 u8 prev_mixer_src_type; 88 u8 mixer_ch; 89 u8 mixer_src_ch; 90 91 u8 input_ch; 92 u8 prev_msg_type; 93 }; 94 95 int snd_motu_register_dsp_message_parser_new(struct snd_motu *motu) 96 { 97 struct msg_parser *parser; 98 parser = devm_kzalloc(&motu->card->card_dev, sizeof(*parser), GFP_KERNEL); 99 if (!parser) 100 return -ENOMEM; 101 spin_lock_init(&parser->lock); 102 if (motu->spec == &snd_motu_spec_4pre || motu->spec == &snd_motu_spec_audio_express) 103 parser->meter_pos_quirk = true; 104 motu->message_parser = parser; 105 return 0; 106 } 107 108 int snd_motu_register_dsp_message_parser_init(struct snd_motu *motu) 109 { 110 struct msg_parser *parser = motu->message_parser; 111 112 parser->prev_mixer_src_type = INVALID; 113 parser->mixer_ch = 0xff; 114 parser->mixer_src_ch = 0xff; 115 parser->prev_msg_type = INVALID; 116 117 return 0; 118 } 119 120 void snd_motu_register_dsp_message_parser_parse(struct snd_motu *motu, const struct pkt_desc *descs, 121 unsigned int desc_count, unsigned int data_block_quadlets) 122 { 123 struct msg_parser *parser = motu->message_parser; 124 bool meter_pos_quirk = parser->meter_pos_quirk; 125 unsigned long flags; 126 int i; 127 128 spin_lock_irqsave(&parser->lock, flags); 129 130 for (i = 0; i < desc_count; ++i) { 131 const struct pkt_desc *desc = descs + i; 132 __be32 *buffer = desc->ctx_payload; 133 unsigned int data_blocks = desc->data_blocks; 134 int j; 135 136 for (j = 0; j < data_blocks; ++j) { 137 u8 *b = (u8 *)buffer; 138 u8 msg_type = (b[MSG_FLAG_POS] & MSG_FLAG_TYPE_MASK) >> MSG_FLAG_TYPE_SHIFT; 139 u8 val = b[MSG_VALUE_POS]; 140 141 buffer += data_block_quadlets; 142 143 switch (msg_type) { 144 case MIXER_SELECT: 145 { 146 u8 mixer_ch = val / 0x20; 147 if (mixer_ch < SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_COUNT) { 148 parser->mixer_src_ch = 0; 149 parser->mixer_ch = mixer_ch; 150 } 151 break; 152 } 153 case MIXER_SRC_GAIN: 154 case MIXER_SRC_PAN: 155 case MIXER_SRC_FLAG: 156 case MIXER_SRC_PAIRED_BALANCE: 157 case MIXER_SRC_PAIRED_WIDTH: 158 { 159 struct snd_firewire_motu_register_dsp_parameter *param = &parser->param; 160 u8 mixer_ch = parser->mixer_ch; 161 u8 mixer_src_ch = parser->mixer_src_ch; 162 163 if (msg_type != parser->prev_mixer_src_type) 164 mixer_src_ch = 0; 165 else 166 ++mixer_src_ch; 167 parser->prev_mixer_src_type = msg_type; 168 169 if (mixer_ch < SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_COUNT && 170 mixer_src_ch < SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_SRC_COUNT) { 171 u8 mixer_ch = parser->mixer_ch; 172 173 switch (msg_type) { 174 case MIXER_SRC_GAIN: 175 param->mixer.source[mixer_ch].gain[mixer_src_ch] = val; 176 break; 177 case MIXER_SRC_PAN: 178 param->mixer.source[mixer_ch].pan[mixer_src_ch] = val; 179 break; 180 case MIXER_SRC_FLAG: 181 param->mixer.source[mixer_ch].flag[mixer_src_ch] = val; 182 break; 183 case MIXER_SRC_PAIRED_BALANCE: 184 param->mixer.source[mixer_ch].paired_balance[mixer_src_ch] = val; 185 break; 186 case MIXER_SRC_PAIRED_WIDTH: 187 param->mixer.source[mixer_ch].paired_width[mixer_src_ch] = val; 188 break; 189 default: 190 break; 191 } 192 193 parser->mixer_src_ch = mixer_src_ch; 194 } 195 break; 196 } 197 case MIXER_OUTPUT_PAIRED_VOLUME: 198 case MIXER_OUTPUT_PAIRED_FLAG: 199 { 200 struct snd_firewire_motu_register_dsp_parameter *param = &parser->param; 201 u8 mixer_ch = parser->mixer_ch; 202 203 if (mixer_ch < SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_COUNT) { 204 switch (msg_type) { 205 case MIXER_OUTPUT_PAIRED_VOLUME: 206 param->mixer.output.paired_volume[mixer_ch] = val; 207 break; 208 case MIXER_OUTPUT_PAIRED_FLAG: 209 param->mixer.output.paired_flag[mixer_ch] = val; 210 break; 211 default: 212 break; 213 } 214 } 215 break; 216 } 217 case MAIN_OUTPUT_PAIRED_VOLUME: 218 parser->param.output.main_paired_volume = val; 219 break; 220 case HP_OUTPUT_PAIRED_VOLUME: 221 parser->param.output.hp_paired_volume = val; 222 break; 223 case HP_OUTPUT_PAIRED_ASSIGNMENT: 224 parser->param.output.hp_paired_assignment = val; 225 break; 226 case LINE_INPUT_BOOST: 227 parser->param.line_input.boost_flag = val; 228 break; 229 case LINE_INPUT_NOMINAL_LEVEL: 230 parser->param.line_input.nominal_level_flag = val; 231 break; 232 case INPUT_GAIN_AND_INVERT: 233 case INPUT_FLAG: 234 { 235 struct snd_firewire_motu_register_dsp_parameter *param = &parser->param; 236 u8 input_ch = parser->input_ch; 237 238 if (parser->prev_msg_type != msg_type) 239 input_ch = 0; 240 else 241 ++input_ch; 242 243 if (input_ch < SNDRV_FIREWIRE_MOTU_REGISTER_DSP_INPUT_COUNT) { 244 switch (msg_type) { 245 case INPUT_GAIN_AND_INVERT: 246 param->input.gain_and_invert[input_ch] = val; 247 break; 248 case INPUT_FLAG: 249 param->input.flag[input_ch] = val; 250 break; 251 default: 252 break; 253 } 254 parser->input_ch = input_ch; 255 } 256 break; 257 } 258 case UNKNOWN_0: 259 case UNKNOWN_2: 260 break; 261 case METER: 262 { 263 u8 pos; 264 265 if (!meter_pos_quirk) 266 pos = b[MSG_METER_IDX_POS]; 267 else 268 pos = b[MSG_METER_IDX_POS_4PRE_AE]; 269 270 if (pos < 0x80) 271 pos &= 0x1f; 272 else 273 pos = (pos & 0x1f) + 20; 274 parser->meter.data[pos] = val; 275 // The message for meter is interruptible to the series of other 276 // types of messages. Don't cache it. 277 fallthrough; 278 } 279 case INVALID: 280 default: 281 // Don't cache it. 282 continue; 283 } 284 285 parser->prev_msg_type = msg_type; 286 } 287 } 288 289 spin_unlock_irqrestore(&parser->lock, flags); 290 } 291 292 void snd_motu_register_dsp_message_parser_copy_meter(struct snd_motu *motu, 293 struct snd_firewire_motu_register_dsp_meter *meter) 294 { 295 struct msg_parser *parser = motu->message_parser; 296 unsigned long flags; 297 298 spin_lock_irqsave(&parser->lock, flags); 299 memcpy(meter, &parser->meter, sizeof(*meter)); 300 spin_unlock_irqrestore(&parser->lock, flags); 301 } 302