1*bea36afaSTakashi Sakamoto // SPDX-License-Identifier: GPL-2.0-only 2*bea36afaSTakashi Sakamoto // 3*bea36afaSTakashi Sakamoto // motu-register-dsp-message-parser.c - a part of driver for MOTU FireWire series 4*bea36afaSTakashi Sakamoto // 5*bea36afaSTakashi Sakamoto // Copyright (c) 2021 Takashi Sakamoto <o-takashi@sakamocchi.jp> 6*bea36afaSTakashi Sakamoto 7*bea36afaSTakashi Sakamoto // Below models allow software to configure their DSP functions by asynchronous transaction 8*bea36afaSTakashi Sakamoto // to access their internal registers. 9*bea36afaSTakashi Sakamoto // * 828 mk2 10*bea36afaSTakashi Sakamoto // * 896hd 11*bea36afaSTakashi Sakamoto // * Traveler 12*bea36afaSTakashi Sakamoto // * 8 pre 13*bea36afaSTakashi Sakamoto // * Ultralite 14*bea36afaSTakashi Sakamoto // * 4 pre 15*bea36afaSTakashi Sakamoto // * Audio Express 16*bea36afaSTakashi Sakamoto // 17*bea36afaSTakashi Sakamoto // Additionally, isochronous packets from the above models include messages to notify state of 18*bea36afaSTakashi Sakamoto // DSP. The messages are two set of 3 byte data in 2nd and 3rd quadlet of data block. When user 19*bea36afaSTakashi Sakamoto // operates hardware components such as dial and switch, corresponding messages are transferred. 20*bea36afaSTakashi Sakamoto // The messages include Hardware metering and MIDI messages as well. 21*bea36afaSTakashi Sakamoto 22*bea36afaSTakashi Sakamoto #include "motu.h" 23*bea36afaSTakashi Sakamoto 24*bea36afaSTakashi Sakamoto #define MSG_FLAG_POS 4 25*bea36afaSTakashi Sakamoto #define MSG_FLAG_TYPE_MASK 0xf8 26*bea36afaSTakashi Sakamoto #define MSG_FLAG_MIDI_MASK 0x01 27*bea36afaSTakashi Sakamoto #define MSG_FLAG_MODEL_SPECIFIC_MASK 0x06 28*bea36afaSTakashi Sakamoto #define MSG_FLAG_8PRE 0x00 29*bea36afaSTakashi Sakamoto #define MSG_FLAG_ULTRALITE 0x04 30*bea36afaSTakashi Sakamoto #define MSG_FLAG_TRAVELER 0x04 31*bea36afaSTakashi Sakamoto #define MSG_FLAG_828MK2 0x04 32*bea36afaSTakashi Sakamoto #define MSG_FLAG_896HD 0x04 33*bea36afaSTakashi Sakamoto #define MSG_FLAG_4PRE 0x05 // MIDI mask is in 8th byte. 34*bea36afaSTakashi Sakamoto #define MSG_FLAG_AUDIOEXPRESS 0x05 // MIDI mask is in 8th byte. 35*bea36afaSTakashi Sakamoto #define MSG_FLAG_TYPE_SHIFT 3 36*bea36afaSTakashi Sakamoto #define MSG_VALUE_POS 5 37*bea36afaSTakashi Sakamoto #define MSG_MIDI_BYTE_POS 6 38*bea36afaSTakashi Sakamoto #define MSG_METER_IDX_POS 7 39*bea36afaSTakashi Sakamoto 40*bea36afaSTakashi Sakamoto // In 4 pre and Audio express, meter index is in 6th byte. MIDI flag is in 8th byte and MIDI byte 41*bea36afaSTakashi Sakamoto // is in 7th byte. 42*bea36afaSTakashi Sakamoto #define MSG_METER_IDX_POS_4PRE_AE 6 43*bea36afaSTakashi Sakamoto #define MSG_MIDI_BYTE_POS_4PRE_AE 7 44*bea36afaSTakashi Sakamoto #define MSG_FLAG_MIDI_POS_4PRE_AE 8 45*bea36afaSTakashi Sakamoto 46*bea36afaSTakashi Sakamoto enum register_dsp_msg_type { 47*bea36afaSTakashi Sakamoto // Used for messages with no information. 48*bea36afaSTakashi Sakamoto INVALID = 0x00, 49*bea36afaSTakashi Sakamoto MIXER_SELECT = 0x01, 50*bea36afaSTakashi Sakamoto MIXER_SRC_GAIN = 0x02, 51*bea36afaSTakashi Sakamoto MIXER_SRC_PAN = 0x03, 52*bea36afaSTakashi Sakamoto MIXER_SRC_FLAG = 0x04, 53*bea36afaSTakashi Sakamoto MIXER_OUTPUT_PAIRED_VOLUME = 0x05, 54*bea36afaSTakashi Sakamoto MIXER_OUTPUT_PAIRED_FLAG = 0x06, 55*bea36afaSTakashi Sakamoto MAIN_OUTPUT_PAIRED_VOLUME = 0x07, 56*bea36afaSTakashi Sakamoto HP_OUTPUT_PAIRED_VOLUME = 0x08, 57*bea36afaSTakashi Sakamoto HP_OUTPUT_ASSIGN = 0x09, 58*bea36afaSTakashi Sakamoto // Transferred by all models but the purpose is still unknown. 59*bea36afaSTakashi Sakamoto UNKNOWN_0 = 0x0a, 60*bea36afaSTakashi Sakamoto // Specific to 828mk2, 896hd, Traveler. 61*bea36afaSTakashi Sakamoto UNKNOWN_2 = 0x0c, 62*bea36afaSTakashi Sakamoto // Specific to 828mk2, Traveler, and 896hd (not functional). 63*bea36afaSTakashi Sakamoto LINE_INPUT_BOOST = 0x0d, 64*bea36afaSTakashi Sakamoto // Specific to 828mk2, Traveler, and 896hd (not functional). 65*bea36afaSTakashi Sakamoto LINE_INPUT_NOMINAL_LEVEL = 0x0e, 66*bea36afaSTakashi Sakamoto // Specific to Ultralite, 4 pre, Audio express, and 8 pre (not functional). 67*bea36afaSTakashi Sakamoto INPUT_GAIN_AND_INVERT = 0x15, 68*bea36afaSTakashi Sakamoto // Specific to 4 pre, and Audio express. 69*bea36afaSTakashi Sakamoto INPUT_FLAG = 0x16, 70*bea36afaSTakashi Sakamoto // Specific to 4 pre, and Audio express. 71*bea36afaSTakashi Sakamoto MIXER_SRC_PAIRED_BALANCE = 0x17, 72*bea36afaSTakashi Sakamoto // Specific to 4 pre, and Audio express. 73*bea36afaSTakashi Sakamoto MIXER_SRC_PAIRED_WIDTH = 0x18, 74*bea36afaSTakashi Sakamoto // Transferred by all models. This type of message interposes the series of the other 75*bea36afaSTakashi Sakamoto // messages. The message delivers signal level up to 96.0 kHz. In 828mk2, 896hd, and 76*bea36afaSTakashi Sakamoto // Traveler, one of physical outputs is selected for the message. The selection is done 77*bea36afaSTakashi Sakamoto // by LSB one byte in asynchronous write quadlet transaction to 0x'ffff'f000'0b2c. 78*bea36afaSTakashi Sakamoto METER = 0x1f, 79*bea36afaSTakashi Sakamoto }; 80*bea36afaSTakashi Sakamoto 81*bea36afaSTakashi Sakamoto struct msg_parser { 82*bea36afaSTakashi Sakamoto struct snd_firewire_motu_register_dsp_meter meter; 83*bea36afaSTakashi Sakamoto bool meter_pos_quirk; 84*bea36afaSTakashi Sakamoto }; 85*bea36afaSTakashi Sakamoto 86*bea36afaSTakashi Sakamoto int snd_motu_register_dsp_message_parser_new(struct snd_motu *motu) 87*bea36afaSTakashi Sakamoto { 88*bea36afaSTakashi Sakamoto struct msg_parser *parser; 89*bea36afaSTakashi Sakamoto parser = devm_kzalloc(&motu->card->card_dev, sizeof(*parser), GFP_KERNEL); 90*bea36afaSTakashi Sakamoto if (!parser) 91*bea36afaSTakashi Sakamoto return -ENOMEM; 92*bea36afaSTakashi Sakamoto if (motu->spec == &snd_motu_spec_4pre || motu->spec == &snd_motu_spec_audio_express) 93*bea36afaSTakashi Sakamoto parser->meter_pos_quirk = true; 94*bea36afaSTakashi Sakamoto motu->message_parser = parser; 95*bea36afaSTakashi Sakamoto return 0; 96*bea36afaSTakashi Sakamoto } 97*bea36afaSTakashi Sakamoto 98*bea36afaSTakashi Sakamoto int snd_motu_register_dsp_message_parser_init(struct snd_motu *motu) 99*bea36afaSTakashi Sakamoto { 100*bea36afaSTakashi Sakamoto return 0; 101*bea36afaSTakashi Sakamoto } 102*bea36afaSTakashi Sakamoto 103*bea36afaSTakashi Sakamoto void snd_motu_register_dsp_message_parser_parse(struct snd_motu *motu, const struct pkt_desc *descs, 104*bea36afaSTakashi Sakamoto unsigned int desc_count, unsigned int data_block_quadlets) 105*bea36afaSTakashi Sakamoto { 106*bea36afaSTakashi Sakamoto struct msg_parser *parser = motu->message_parser; 107*bea36afaSTakashi Sakamoto bool meter_pos_quirk = parser->meter_pos_quirk; 108*bea36afaSTakashi Sakamoto int i; 109*bea36afaSTakashi Sakamoto 110*bea36afaSTakashi Sakamoto for (i = 0; i < desc_count; ++i) { 111*bea36afaSTakashi Sakamoto const struct pkt_desc *desc = descs + i; 112*bea36afaSTakashi Sakamoto __be32 *buffer = desc->ctx_payload; 113*bea36afaSTakashi Sakamoto unsigned int data_blocks = desc->data_blocks; 114*bea36afaSTakashi Sakamoto int j; 115*bea36afaSTakashi Sakamoto 116*bea36afaSTakashi Sakamoto for (j = 0; j < data_blocks; ++j) { 117*bea36afaSTakashi Sakamoto u8 *b = (u8 *)buffer; 118*bea36afaSTakashi Sakamoto u8 msg_type = (b[MSG_FLAG_POS] & MSG_FLAG_TYPE_MASK) >> MSG_FLAG_TYPE_SHIFT; 119*bea36afaSTakashi Sakamoto u8 val = b[MSG_VALUE_POS]; 120*bea36afaSTakashi Sakamoto 121*bea36afaSTakashi Sakamoto buffer += data_block_quadlets; 122*bea36afaSTakashi Sakamoto 123*bea36afaSTakashi Sakamoto switch (msg_type) { 124*bea36afaSTakashi Sakamoto case METER: 125*bea36afaSTakashi Sakamoto { 126*bea36afaSTakashi Sakamoto u8 pos; 127*bea36afaSTakashi Sakamoto 128*bea36afaSTakashi Sakamoto if (!meter_pos_quirk) 129*bea36afaSTakashi Sakamoto pos = b[MSG_METER_IDX_POS]; 130*bea36afaSTakashi Sakamoto else 131*bea36afaSTakashi Sakamoto pos = b[MSG_METER_IDX_POS_4PRE_AE]; 132*bea36afaSTakashi Sakamoto 133*bea36afaSTakashi Sakamoto if (pos < 0x80) 134*bea36afaSTakashi Sakamoto pos &= 0x1f; 135*bea36afaSTakashi Sakamoto else 136*bea36afaSTakashi Sakamoto pos = (pos & 0x1f) + 20; 137*bea36afaSTakashi Sakamoto parser->meter.data[pos] = val; 138*bea36afaSTakashi Sakamoto break; 139*bea36afaSTakashi Sakamoto } 140*bea36afaSTakashi Sakamoto default: 141*bea36afaSTakashi Sakamoto break; 142*bea36afaSTakashi Sakamoto } 143*bea36afaSTakashi Sakamoto } 144*bea36afaSTakashi Sakamoto } 145*bea36afaSTakashi Sakamoto } 146