1bea36afaSTakashi Sakamoto // SPDX-License-Identifier: GPL-2.0-only 2bea36afaSTakashi Sakamoto // 3bea36afaSTakashi Sakamoto // motu-register-dsp-message-parser.c - a part of driver for MOTU FireWire series 4bea36afaSTakashi Sakamoto // 5bea36afaSTakashi Sakamoto // Copyright (c) 2021 Takashi Sakamoto <o-takashi@sakamocchi.jp> 6bea36afaSTakashi Sakamoto 7bea36afaSTakashi Sakamoto // Below models allow software to configure their DSP functions by asynchronous transaction 8bea36afaSTakashi Sakamoto // to access their internal registers. 9bea36afaSTakashi Sakamoto // * 828 mk2 10bea36afaSTakashi Sakamoto // * 896hd 11bea36afaSTakashi Sakamoto // * Traveler 12bea36afaSTakashi Sakamoto // * 8 pre 13bea36afaSTakashi Sakamoto // * Ultralite 14bea36afaSTakashi Sakamoto // * 4 pre 15bea36afaSTakashi Sakamoto // * Audio Express 16bea36afaSTakashi Sakamoto // 17bea36afaSTakashi Sakamoto // Additionally, isochronous packets from the above models include messages to notify state of 18bea36afaSTakashi Sakamoto // DSP. The messages are two set of 3 byte data in 2nd and 3rd quadlet of data block. When user 19bea36afaSTakashi Sakamoto // operates hardware components such as dial and switch, corresponding messages are transferred. 20bea36afaSTakashi Sakamoto // The messages include Hardware metering and MIDI messages as well. 21bea36afaSTakashi Sakamoto 22bea36afaSTakashi Sakamoto #include "motu.h" 23bea36afaSTakashi Sakamoto 24bea36afaSTakashi Sakamoto #define MSG_FLAG_POS 4 25bea36afaSTakashi Sakamoto #define MSG_FLAG_TYPE_MASK 0xf8 26bea36afaSTakashi Sakamoto #define MSG_FLAG_MIDI_MASK 0x01 27bea36afaSTakashi Sakamoto #define MSG_FLAG_MODEL_SPECIFIC_MASK 0x06 28bea36afaSTakashi Sakamoto #define MSG_FLAG_8PRE 0x00 29bea36afaSTakashi Sakamoto #define MSG_FLAG_ULTRALITE 0x04 30bea36afaSTakashi Sakamoto #define MSG_FLAG_TRAVELER 0x04 31bea36afaSTakashi Sakamoto #define MSG_FLAG_828MK2 0x04 32bea36afaSTakashi Sakamoto #define MSG_FLAG_896HD 0x04 33bea36afaSTakashi Sakamoto #define MSG_FLAG_4PRE 0x05 // MIDI mask is in 8th byte. 34bea36afaSTakashi Sakamoto #define MSG_FLAG_AUDIOEXPRESS 0x05 // MIDI mask is in 8th byte. 35bea36afaSTakashi Sakamoto #define MSG_FLAG_TYPE_SHIFT 3 36bea36afaSTakashi Sakamoto #define MSG_VALUE_POS 5 37bea36afaSTakashi Sakamoto #define MSG_MIDI_BYTE_POS 6 38bea36afaSTakashi Sakamoto #define MSG_METER_IDX_POS 7 39bea36afaSTakashi Sakamoto 40bea36afaSTakashi Sakamoto // In 4 pre and Audio express, meter index is in 6th byte. MIDI flag is in 8th byte and MIDI byte 41bea36afaSTakashi Sakamoto // is in 7th byte. 42bea36afaSTakashi Sakamoto #define MSG_METER_IDX_POS_4PRE_AE 6 43bea36afaSTakashi Sakamoto #define MSG_MIDI_BYTE_POS_4PRE_AE 7 44bea36afaSTakashi Sakamoto #define MSG_FLAG_MIDI_POS_4PRE_AE 8 45bea36afaSTakashi Sakamoto 46bea36afaSTakashi Sakamoto enum register_dsp_msg_type { 47bea36afaSTakashi Sakamoto // Used for messages with no information. 48bea36afaSTakashi Sakamoto INVALID = 0x00, 49bea36afaSTakashi Sakamoto MIXER_SELECT = 0x01, 50bea36afaSTakashi Sakamoto MIXER_SRC_GAIN = 0x02, 51bea36afaSTakashi Sakamoto MIXER_SRC_PAN = 0x03, 52bea36afaSTakashi Sakamoto MIXER_SRC_FLAG = 0x04, 53bea36afaSTakashi Sakamoto MIXER_OUTPUT_PAIRED_VOLUME = 0x05, 54bea36afaSTakashi Sakamoto MIXER_OUTPUT_PAIRED_FLAG = 0x06, 55bea36afaSTakashi Sakamoto MAIN_OUTPUT_PAIRED_VOLUME = 0x07, 56bea36afaSTakashi Sakamoto HP_OUTPUT_PAIRED_VOLUME = 0x08, 576ca81d2bSTakashi Sakamoto HP_OUTPUT_PAIRED_ASSIGNMENT = 0x09, 58bea36afaSTakashi Sakamoto // Transferred by all models but the purpose is still unknown. 59bea36afaSTakashi Sakamoto UNKNOWN_0 = 0x0a, 60bea36afaSTakashi Sakamoto // Specific to 828mk2, 896hd, Traveler. 61bea36afaSTakashi Sakamoto UNKNOWN_2 = 0x0c, 62bea36afaSTakashi Sakamoto // Specific to 828mk2, Traveler, and 896hd (not functional). 63bea36afaSTakashi Sakamoto LINE_INPUT_BOOST = 0x0d, 64bea36afaSTakashi Sakamoto // Specific to 828mk2, Traveler, and 896hd (not functional). 65bea36afaSTakashi Sakamoto LINE_INPUT_NOMINAL_LEVEL = 0x0e, 66bea36afaSTakashi Sakamoto // Specific to Ultralite, 4 pre, Audio express, and 8 pre (not functional). 67bea36afaSTakashi Sakamoto INPUT_GAIN_AND_INVERT = 0x15, 68bea36afaSTakashi Sakamoto // Specific to 4 pre, and Audio express. 69bea36afaSTakashi Sakamoto INPUT_FLAG = 0x16, 70bea36afaSTakashi Sakamoto // Specific to 4 pre, and Audio express. 71bea36afaSTakashi Sakamoto MIXER_SRC_PAIRED_BALANCE = 0x17, 72bea36afaSTakashi Sakamoto // Specific to 4 pre, and Audio express. 73bea36afaSTakashi Sakamoto MIXER_SRC_PAIRED_WIDTH = 0x18, 74bea36afaSTakashi Sakamoto // Transferred by all models. This type of message interposes the series of the other 75bea36afaSTakashi Sakamoto // messages. The message delivers signal level up to 96.0 kHz. In 828mk2, 896hd, and 76bea36afaSTakashi Sakamoto // Traveler, one of physical outputs is selected for the message. The selection is done 77bea36afaSTakashi Sakamoto // by LSB one byte in asynchronous write quadlet transaction to 0x'ffff'f000'0b2c. 78bea36afaSTakashi Sakamoto METER = 0x1f, 79bea36afaSTakashi Sakamoto }; 80bea36afaSTakashi Sakamoto 81bea36afaSTakashi Sakamoto struct msg_parser { 8258b62ab7STakashi Sakamoto spinlock_t lock; 83bea36afaSTakashi Sakamoto struct snd_firewire_motu_register_dsp_meter meter; 84bea36afaSTakashi Sakamoto bool meter_pos_quirk; 85dc36a975STakashi Sakamoto 86dc36a975STakashi Sakamoto struct snd_firewire_motu_register_dsp_parameter param; 87dc36a975STakashi Sakamoto u8 prev_mixer_src_type; 88dc36a975STakashi Sakamoto u8 mixer_ch; 89dc36a975STakashi Sakamoto u8 mixer_src_ch; 90*7d843c49STakashi Sakamoto 91*7d843c49STakashi Sakamoto u8 input_ch; 92*7d843c49STakashi Sakamoto u8 prev_msg_type; 93bea36afaSTakashi Sakamoto }; 94bea36afaSTakashi Sakamoto 95bea36afaSTakashi Sakamoto int snd_motu_register_dsp_message_parser_new(struct snd_motu *motu) 96bea36afaSTakashi Sakamoto { 97bea36afaSTakashi Sakamoto struct msg_parser *parser; 98bea36afaSTakashi Sakamoto parser = devm_kzalloc(&motu->card->card_dev, sizeof(*parser), GFP_KERNEL); 99bea36afaSTakashi Sakamoto if (!parser) 100bea36afaSTakashi Sakamoto return -ENOMEM; 10158b62ab7STakashi Sakamoto spin_lock_init(&parser->lock); 102bea36afaSTakashi Sakamoto if (motu->spec == &snd_motu_spec_4pre || motu->spec == &snd_motu_spec_audio_express) 103bea36afaSTakashi Sakamoto parser->meter_pos_quirk = true; 104bea36afaSTakashi Sakamoto motu->message_parser = parser; 105bea36afaSTakashi Sakamoto return 0; 106bea36afaSTakashi Sakamoto } 107bea36afaSTakashi Sakamoto 108bea36afaSTakashi Sakamoto int snd_motu_register_dsp_message_parser_init(struct snd_motu *motu) 109bea36afaSTakashi Sakamoto { 110dc36a975STakashi Sakamoto struct msg_parser *parser = motu->message_parser; 111dc36a975STakashi Sakamoto 112dc36a975STakashi Sakamoto parser->prev_mixer_src_type = INVALID; 113dc36a975STakashi Sakamoto parser->mixer_ch = 0xff; 114dc36a975STakashi Sakamoto parser->mixer_src_ch = 0xff; 115*7d843c49STakashi Sakamoto parser->prev_msg_type = INVALID; 116dc36a975STakashi Sakamoto 117bea36afaSTakashi Sakamoto return 0; 118bea36afaSTakashi Sakamoto } 119bea36afaSTakashi Sakamoto 120bea36afaSTakashi Sakamoto void snd_motu_register_dsp_message_parser_parse(struct snd_motu *motu, const struct pkt_desc *descs, 121bea36afaSTakashi Sakamoto unsigned int desc_count, unsigned int data_block_quadlets) 122bea36afaSTakashi Sakamoto { 123bea36afaSTakashi Sakamoto struct msg_parser *parser = motu->message_parser; 124bea36afaSTakashi Sakamoto bool meter_pos_quirk = parser->meter_pos_quirk; 12558b62ab7STakashi Sakamoto unsigned long flags; 126bea36afaSTakashi Sakamoto int i; 127bea36afaSTakashi Sakamoto 12858b62ab7STakashi Sakamoto spin_lock_irqsave(&parser->lock, flags); 12958b62ab7STakashi Sakamoto 130bea36afaSTakashi Sakamoto for (i = 0; i < desc_count; ++i) { 131bea36afaSTakashi Sakamoto const struct pkt_desc *desc = descs + i; 132bea36afaSTakashi Sakamoto __be32 *buffer = desc->ctx_payload; 133bea36afaSTakashi Sakamoto unsigned int data_blocks = desc->data_blocks; 134bea36afaSTakashi Sakamoto int j; 135bea36afaSTakashi Sakamoto 136bea36afaSTakashi Sakamoto for (j = 0; j < data_blocks; ++j) { 137bea36afaSTakashi Sakamoto u8 *b = (u8 *)buffer; 138bea36afaSTakashi Sakamoto u8 msg_type = (b[MSG_FLAG_POS] & MSG_FLAG_TYPE_MASK) >> MSG_FLAG_TYPE_SHIFT; 139bea36afaSTakashi Sakamoto u8 val = b[MSG_VALUE_POS]; 140bea36afaSTakashi Sakamoto 141bea36afaSTakashi Sakamoto buffer += data_block_quadlets; 142bea36afaSTakashi Sakamoto 143bea36afaSTakashi Sakamoto switch (msg_type) { 144dc36a975STakashi Sakamoto case MIXER_SELECT: 145dc36a975STakashi Sakamoto { 146dc36a975STakashi Sakamoto u8 mixer_ch = val / 0x20; 147dc36a975STakashi Sakamoto if (mixer_ch < SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_COUNT) { 148dc36a975STakashi Sakamoto parser->mixer_src_ch = 0; 149dc36a975STakashi Sakamoto parser->mixer_ch = mixer_ch; 150dc36a975STakashi Sakamoto } 151dc36a975STakashi Sakamoto break; 152dc36a975STakashi Sakamoto } 153dc36a975STakashi Sakamoto case MIXER_SRC_GAIN: 154dc36a975STakashi Sakamoto case MIXER_SRC_PAN: 155dc36a975STakashi Sakamoto case MIXER_SRC_FLAG: 156dc36a975STakashi Sakamoto case MIXER_SRC_PAIRED_BALANCE: 157dc36a975STakashi Sakamoto case MIXER_SRC_PAIRED_WIDTH: 158dc36a975STakashi Sakamoto { 159dc36a975STakashi Sakamoto struct snd_firewire_motu_register_dsp_parameter *param = &parser->param; 160dc36a975STakashi Sakamoto u8 mixer_ch = parser->mixer_ch; 161dc36a975STakashi Sakamoto u8 mixer_src_ch = parser->mixer_src_ch; 162dc36a975STakashi Sakamoto 163dc36a975STakashi Sakamoto if (msg_type != parser->prev_mixer_src_type) 164dc36a975STakashi Sakamoto mixer_src_ch = 0; 165dc36a975STakashi Sakamoto else 166dc36a975STakashi Sakamoto ++mixer_src_ch; 167dc36a975STakashi Sakamoto parser->prev_mixer_src_type = msg_type; 168dc36a975STakashi Sakamoto 169dc36a975STakashi Sakamoto if (mixer_ch < SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_COUNT && 170dc36a975STakashi Sakamoto mixer_src_ch < SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_SRC_COUNT) { 171dc36a975STakashi Sakamoto u8 mixer_ch = parser->mixer_ch; 172dc36a975STakashi Sakamoto 173dc36a975STakashi Sakamoto switch (msg_type) { 174dc36a975STakashi Sakamoto case MIXER_SRC_GAIN: 175dc36a975STakashi Sakamoto param->mixer.source[mixer_ch].gain[mixer_src_ch] = val; 176dc36a975STakashi Sakamoto break; 177dc36a975STakashi Sakamoto case MIXER_SRC_PAN: 178dc36a975STakashi Sakamoto param->mixer.source[mixer_ch].pan[mixer_src_ch] = val; 179dc36a975STakashi Sakamoto break; 180dc36a975STakashi Sakamoto case MIXER_SRC_FLAG: 181dc36a975STakashi Sakamoto param->mixer.source[mixer_ch].flag[mixer_src_ch] = val; 182dc36a975STakashi Sakamoto break; 183dc36a975STakashi Sakamoto case MIXER_SRC_PAIRED_BALANCE: 184dc36a975STakashi Sakamoto param->mixer.source[mixer_ch].paired_balance[mixer_src_ch] = val; 185dc36a975STakashi Sakamoto break; 186dc36a975STakashi Sakamoto case MIXER_SRC_PAIRED_WIDTH: 187dc36a975STakashi Sakamoto param->mixer.source[mixer_ch].paired_width[mixer_src_ch] = val; 188dc36a975STakashi Sakamoto break; 189dc36a975STakashi Sakamoto default: 190dc36a975STakashi Sakamoto break; 191dc36a975STakashi Sakamoto } 192dc36a975STakashi Sakamoto 193dc36a975STakashi Sakamoto parser->mixer_src_ch = mixer_src_ch; 194dc36a975STakashi Sakamoto } 195dc36a975STakashi Sakamoto break; 196dc36a975STakashi Sakamoto } 197ce69bed5STakashi Sakamoto case MIXER_OUTPUT_PAIRED_VOLUME: 198ce69bed5STakashi Sakamoto case MIXER_OUTPUT_PAIRED_FLAG: 199ce69bed5STakashi Sakamoto { 200ce69bed5STakashi Sakamoto struct snd_firewire_motu_register_dsp_parameter *param = &parser->param; 201ce69bed5STakashi Sakamoto u8 mixer_ch = parser->mixer_ch; 202ce69bed5STakashi Sakamoto 203ce69bed5STakashi Sakamoto if (mixer_ch < SNDRV_FIREWIRE_MOTU_REGISTER_DSP_MIXER_COUNT) { 204ce69bed5STakashi Sakamoto switch (msg_type) { 205ce69bed5STakashi Sakamoto case MIXER_OUTPUT_PAIRED_VOLUME: 206ce69bed5STakashi Sakamoto param->mixer.output.paired_volume[mixer_ch] = val; 207ce69bed5STakashi Sakamoto break; 208ce69bed5STakashi Sakamoto case MIXER_OUTPUT_PAIRED_FLAG: 209ce69bed5STakashi Sakamoto param->mixer.output.paired_flag[mixer_ch] = val; 210ce69bed5STakashi Sakamoto break; 211ce69bed5STakashi Sakamoto default: 212ce69bed5STakashi Sakamoto break; 213ce69bed5STakashi Sakamoto } 214ce69bed5STakashi Sakamoto } 215ce69bed5STakashi Sakamoto break; 216ce69bed5STakashi Sakamoto } 2176ca81d2bSTakashi Sakamoto case MAIN_OUTPUT_PAIRED_VOLUME: 2186ca81d2bSTakashi Sakamoto parser->param.output.main_paired_volume = val; 2196ca81d2bSTakashi Sakamoto break; 2206ca81d2bSTakashi Sakamoto case HP_OUTPUT_PAIRED_VOLUME: 2216ca81d2bSTakashi Sakamoto parser->param.output.hp_paired_volume = val; 2226ca81d2bSTakashi Sakamoto break; 2236ca81d2bSTakashi Sakamoto case HP_OUTPUT_PAIRED_ASSIGNMENT: 2246ca81d2bSTakashi Sakamoto parser->param.output.hp_paired_assignment = val; 2256ca81d2bSTakashi Sakamoto break; 22641cc2338STakashi Sakamoto case LINE_INPUT_BOOST: 22741cc2338STakashi Sakamoto parser->param.line_input.boost_flag = val; 22841cc2338STakashi Sakamoto break; 22941cc2338STakashi Sakamoto case LINE_INPUT_NOMINAL_LEVEL: 23041cc2338STakashi Sakamoto parser->param.line_input.nominal_level_flag = val; 23141cc2338STakashi Sakamoto break; 232*7d843c49STakashi Sakamoto case INPUT_GAIN_AND_INVERT: 233*7d843c49STakashi Sakamoto case INPUT_FLAG: 234*7d843c49STakashi Sakamoto { 235*7d843c49STakashi Sakamoto struct snd_firewire_motu_register_dsp_parameter *param = &parser->param; 236*7d843c49STakashi Sakamoto u8 input_ch = parser->input_ch; 237*7d843c49STakashi Sakamoto 238*7d843c49STakashi Sakamoto if (parser->prev_msg_type != msg_type) 239*7d843c49STakashi Sakamoto input_ch = 0; 240*7d843c49STakashi Sakamoto else 241*7d843c49STakashi Sakamoto ++input_ch; 242*7d843c49STakashi Sakamoto 243*7d843c49STakashi Sakamoto if (input_ch < SNDRV_FIREWIRE_MOTU_REGISTER_DSP_INPUT_COUNT) { 244*7d843c49STakashi Sakamoto switch (msg_type) { 245*7d843c49STakashi Sakamoto case INPUT_GAIN_AND_INVERT: 246*7d843c49STakashi Sakamoto param->input.gain_and_invert[input_ch] = val; 247*7d843c49STakashi Sakamoto break; 248*7d843c49STakashi Sakamoto case INPUT_FLAG: 249*7d843c49STakashi Sakamoto param->input.flag[input_ch] = val; 250*7d843c49STakashi Sakamoto break; 251*7d843c49STakashi Sakamoto default: 252*7d843c49STakashi Sakamoto break; 253*7d843c49STakashi Sakamoto } 254*7d843c49STakashi Sakamoto parser->input_ch = input_ch; 255*7d843c49STakashi Sakamoto } 256*7d843c49STakashi Sakamoto break; 257*7d843c49STakashi Sakamoto } 258*7d843c49STakashi Sakamoto case UNKNOWN_0: 259*7d843c49STakashi Sakamoto case UNKNOWN_2: 260*7d843c49STakashi Sakamoto break; 261bea36afaSTakashi Sakamoto case METER: 262bea36afaSTakashi Sakamoto { 263bea36afaSTakashi Sakamoto u8 pos; 264bea36afaSTakashi Sakamoto 265bea36afaSTakashi Sakamoto if (!meter_pos_quirk) 266bea36afaSTakashi Sakamoto pos = b[MSG_METER_IDX_POS]; 267bea36afaSTakashi Sakamoto else 268bea36afaSTakashi Sakamoto pos = b[MSG_METER_IDX_POS_4PRE_AE]; 269bea36afaSTakashi Sakamoto 270bea36afaSTakashi Sakamoto if (pos < 0x80) 271bea36afaSTakashi Sakamoto pos &= 0x1f; 272bea36afaSTakashi Sakamoto else 273bea36afaSTakashi Sakamoto pos = (pos & 0x1f) + 20; 274bea36afaSTakashi Sakamoto parser->meter.data[pos] = val; 275*7d843c49STakashi Sakamoto // The message for meter is interruptible to the series of other 276*7d843c49STakashi Sakamoto // types of messages. Don't cache it. 277*7d843c49STakashi Sakamoto fallthrough; 278bea36afaSTakashi Sakamoto } 279*7d843c49STakashi Sakamoto case INVALID: 280bea36afaSTakashi Sakamoto default: 281*7d843c49STakashi Sakamoto // Don't cache it. 282*7d843c49STakashi Sakamoto continue; 283bea36afaSTakashi Sakamoto } 284*7d843c49STakashi Sakamoto 285*7d843c49STakashi Sakamoto parser->prev_msg_type = msg_type; 286bea36afaSTakashi Sakamoto } 287bea36afaSTakashi Sakamoto } 28858b62ab7STakashi Sakamoto 28958b62ab7STakashi Sakamoto spin_unlock_irqrestore(&parser->lock, flags); 29058b62ab7STakashi Sakamoto } 29158b62ab7STakashi Sakamoto 29258b62ab7STakashi Sakamoto void snd_motu_register_dsp_message_parser_copy_meter(struct snd_motu *motu, 29358b62ab7STakashi Sakamoto struct snd_firewire_motu_register_dsp_meter *meter) 29458b62ab7STakashi Sakamoto { 29558b62ab7STakashi Sakamoto struct msg_parser *parser = motu->message_parser; 29658b62ab7STakashi Sakamoto unsigned long flags; 29758b62ab7STakashi Sakamoto 29858b62ab7STakashi Sakamoto spin_lock_irqsave(&parser->lock, flags); 29958b62ab7STakashi Sakamoto memcpy(meter, &parser->meter, sizeof(*meter)); 30058b62ab7STakashi Sakamoto spin_unlock_irqrestore(&parser->lock, flags); 301bea36afaSTakashi Sakamoto } 302