119174295STakashi Sakamoto /* 219174295STakashi Sakamoto * ff-transaction.c - a part of driver for RME Fireface series 319174295STakashi Sakamoto * 419174295STakashi Sakamoto * Copyright (c) 2015-2017 Takashi Sakamoto 519174295STakashi Sakamoto * 619174295STakashi Sakamoto * Licensed under the terms of the GNU General Public License, version 2. 719174295STakashi Sakamoto */ 819174295STakashi Sakamoto 919174295STakashi Sakamoto #include "ff.h" 1019174295STakashi Sakamoto 1119174295STakashi Sakamoto static void finish_transmit_midi_msg(struct snd_ff *ff, unsigned int port, 1219174295STakashi Sakamoto int rcode) 1319174295STakashi Sakamoto { 1419174295STakashi Sakamoto struct snd_rawmidi_substream *substream = 156aa7de05SMark Rutland READ_ONCE(ff->rx_midi_substreams[port]); 1619174295STakashi Sakamoto 1719174295STakashi Sakamoto if (rcode_is_permanent_error(rcode)) { 1819174295STakashi Sakamoto ff->rx_midi_error[port] = true; 1919174295STakashi Sakamoto return; 2019174295STakashi Sakamoto } 2119174295STakashi Sakamoto 2219174295STakashi Sakamoto if (rcode != RCODE_COMPLETE) { 2319174295STakashi Sakamoto /* Transfer the message again, immediately. */ 24e3a973c6STakashi Sakamoto ff->next_ktime[port] = 0; 2519174295STakashi Sakamoto schedule_work(&ff->rx_midi_work[port]); 2619174295STakashi Sakamoto return; 2719174295STakashi Sakamoto } 2819174295STakashi Sakamoto 2919174295STakashi Sakamoto snd_rawmidi_transmit_ack(substream, ff->rx_bytes[port]); 3019174295STakashi Sakamoto ff->rx_bytes[port] = 0; 3119174295STakashi Sakamoto 3219174295STakashi Sakamoto if (!snd_rawmidi_transmit_empty(substream)) 3319174295STakashi Sakamoto schedule_work(&ff->rx_midi_work[port]); 3419174295STakashi Sakamoto } 3519174295STakashi Sakamoto 3619174295STakashi Sakamoto static void finish_transmit_midi0_msg(struct fw_card *card, int rcode, 3719174295STakashi Sakamoto void *data, size_t length, 3819174295STakashi Sakamoto void *callback_data) 3919174295STakashi Sakamoto { 4019174295STakashi Sakamoto struct snd_ff *ff = 4119174295STakashi Sakamoto container_of(callback_data, struct snd_ff, transactions[0]); 4219174295STakashi Sakamoto finish_transmit_midi_msg(ff, 0, rcode); 4319174295STakashi Sakamoto } 4419174295STakashi Sakamoto 4519174295STakashi Sakamoto static void finish_transmit_midi1_msg(struct fw_card *card, int rcode, 4619174295STakashi Sakamoto void *data, size_t length, 4719174295STakashi Sakamoto void *callback_data) 4819174295STakashi Sakamoto { 4919174295STakashi Sakamoto struct snd_ff *ff = 5019174295STakashi Sakamoto container_of(callback_data, struct snd_ff, transactions[1]); 5119174295STakashi Sakamoto finish_transmit_midi_msg(ff, 1, rcode); 5219174295STakashi Sakamoto } 5319174295STakashi Sakamoto 5419174295STakashi Sakamoto static void transmit_midi_msg(struct snd_ff *ff, unsigned int port) 5519174295STakashi Sakamoto { 5619174295STakashi Sakamoto struct snd_rawmidi_substream *substream = 576aa7de05SMark Rutland READ_ONCE(ff->rx_midi_substreams[port]); 5882b6297bSTakashi Sakamoto int quad_count; 5919174295STakashi Sakamoto 6019174295STakashi Sakamoto struct fw_device *fw_dev = fw_parent_device(ff->unit); 6119174295STakashi Sakamoto unsigned long long addr; 6219174295STakashi Sakamoto int generation; 6319174295STakashi Sakamoto fw_transaction_callback_t callback; 6482b6297bSTakashi Sakamoto int tcode; 6519174295STakashi Sakamoto 6619174295STakashi Sakamoto if (substream == NULL || snd_rawmidi_transmit_empty(substream)) 6719174295STakashi Sakamoto return; 6819174295STakashi Sakamoto 6919174295STakashi Sakamoto if (ff->rx_bytes[port] > 0 || ff->rx_midi_error[port]) 7019174295STakashi Sakamoto return; 7119174295STakashi Sakamoto 7219174295STakashi Sakamoto /* Do it in next chance. */ 7319174295STakashi Sakamoto if (ktime_after(ff->next_ktime[port], ktime_get())) { 7419174295STakashi Sakamoto schedule_work(&ff->rx_midi_work[port]); 7519174295STakashi Sakamoto return; 7619174295STakashi Sakamoto } 7719174295STakashi Sakamoto 7882b6297bSTakashi Sakamoto quad_count = ff->spec->protocol->fill_midi_msg(ff, substream, port); 7982b6297bSTakashi Sakamoto if (quad_count <= 0) 8019174295STakashi Sakamoto return; 8119174295STakashi Sakamoto 8219174295STakashi Sakamoto if (port == 0) { 83481e09acSTakashi Sakamoto addr = ff->spec->midi_rx_addrs[0]; 8419174295STakashi Sakamoto callback = finish_transmit_midi0_msg; 8519174295STakashi Sakamoto } else { 86481e09acSTakashi Sakamoto addr = ff->spec->midi_rx_addrs[1]; 8719174295STakashi Sakamoto callback = finish_transmit_midi1_msg; 8819174295STakashi Sakamoto } 8919174295STakashi Sakamoto 9019174295STakashi Sakamoto /* Set interval to next transaction. */ 9119174295STakashi Sakamoto ff->next_ktime[port] = ktime_add_ns(ktime_get(), 9282b6297bSTakashi Sakamoto ff->rx_bytes[port] * 8 * NSEC_PER_SEC / 31250); 9382b6297bSTakashi Sakamoto 9482b6297bSTakashi Sakamoto if (quad_count == 1) 9582b6297bSTakashi Sakamoto tcode = TCODE_WRITE_QUADLET_REQUEST; 9682b6297bSTakashi Sakamoto else 9782b6297bSTakashi Sakamoto tcode = TCODE_WRITE_BLOCK_REQUEST; 9819174295STakashi Sakamoto 9919174295STakashi Sakamoto /* 10019174295STakashi Sakamoto * In Linux FireWire core, when generation is updated with memory 10119174295STakashi Sakamoto * barrier, node id has already been updated. In this module, After 10219174295STakashi Sakamoto * this smp_rmb(), load/store instructions to memory are completed. 10319174295STakashi Sakamoto * Thus, both of generation and node id are available with recent 10419174295STakashi Sakamoto * values. This is a light-serialization solution to handle bus reset 10519174295STakashi Sakamoto * events on IEEE 1394 bus. 10619174295STakashi Sakamoto */ 10719174295STakashi Sakamoto generation = fw_dev->generation; 10819174295STakashi Sakamoto smp_rmb(); 10982b6297bSTakashi Sakamoto fw_send_request(fw_dev->card, &ff->transactions[port], tcode, 11019174295STakashi Sakamoto fw_dev->node_id, generation, fw_dev->max_speed, 11182b6297bSTakashi Sakamoto addr, &ff->msg_buf[port], quad_count * 4, 11219174295STakashi Sakamoto callback, &ff->transactions[port]); 11319174295STakashi Sakamoto } 11419174295STakashi Sakamoto 11519174295STakashi Sakamoto static void transmit_midi0_msg(struct work_struct *work) 11619174295STakashi Sakamoto { 11719174295STakashi Sakamoto struct snd_ff *ff = container_of(work, struct snd_ff, rx_midi_work[0]); 11819174295STakashi Sakamoto 11919174295STakashi Sakamoto transmit_midi_msg(ff, 0); 12019174295STakashi Sakamoto } 12119174295STakashi Sakamoto 12219174295STakashi Sakamoto static void transmit_midi1_msg(struct work_struct *work) 12319174295STakashi Sakamoto { 12419174295STakashi Sakamoto struct snd_ff *ff = container_of(work, struct snd_ff, rx_midi_work[1]); 12519174295STakashi Sakamoto 12619174295STakashi Sakamoto transmit_midi_msg(ff, 1); 12719174295STakashi Sakamoto } 12819174295STakashi Sakamoto 12919174295STakashi Sakamoto static void handle_midi_msg(struct fw_card *card, struct fw_request *request, 13019174295STakashi Sakamoto int tcode, int destination, int source, 13119174295STakashi Sakamoto int generation, unsigned long long offset, 13219174295STakashi Sakamoto void *data, size_t length, void *callback_data) 13319174295STakashi Sakamoto { 13419174295STakashi Sakamoto struct snd_ff *ff = callback_data; 13519174295STakashi Sakamoto __le32 *buf = data; 13619174295STakashi Sakamoto 13719174295STakashi Sakamoto fw_send_response(card, request, RCODE_COMPLETE); 13819174295STakashi Sakamoto 1396c644e4eSTakashi Sakamoto offset -= ff->async_handler.offset; 1406c644e4eSTakashi Sakamoto ff->spec->protocol->handle_midi_msg(ff, (unsigned int)offset, buf, 1416c644e4eSTakashi Sakamoto length); 14219174295STakashi Sakamoto } 14319174295STakashi Sakamoto 14419174295STakashi Sakamoto static int allocate_own_address(struct snd_ff *ff, int i) 14519174295STakashi Sakamoto { 14619174295STakashi Sakamoto struct fw_address_region midi_msg_region; 14719174295STakashi Sakamoto int err; 14819174295STakashi Sakamoto 14990089677STakashi Sakamoto ff->async_handler.length = ff->spec->midi_addr_range; 15019174295STakashi Sakamoto ff->async_handler.address_callback = handle_midi_msg; 15119174295STakashi Sakamoto ff->async_handler.callback_data = ff; 15219174295STakashi Sakamoto 15319174295STakashi Sakamoto midi_msg_region.start = 0x000100000000ull * i; 15419174295STakashi Sakamoto midi_msg_region.end = midi_msg_region.start + ff->async_handler.length; 15519174295STakashi Sakamoto 15619174295STakashi Sakamoto err = fw_core_add_address_handler(&ff->async_handler, &midi_msg_region); 15719174295STakashi Sakamoto if (err >= 0) { 15819174295STakashi Sakamoto /* Controllers are allowed to register this region. */ 15919174295STakashi Sakamoto if (ff->async_handler.offset & 0x0000ffffffff) { 16019174295STakashi Sakamoto fw_core_remove_address_handler(&ff->async_handler); 16119174295STakashi Sakamoto err = -EAGAIN; 16219174295STakashi Sakamoto } 16319174295STakashi Sakamoto } 16419174295STakashi Sakamoto 16519174295STakashi Sakamoto return err; 16619174295STakashi Sakamoto } 16719174295STakashi Sakamoto 168d8002539STakashi Sakamoto // Controllers are allowed to register higher 4 bytes of destination address to 169d8002539STakashi Sakamoto // receive asynchronous transactions for MIDI messages, while the way to 170d8002539STakashi Sakamoto // register lower 4 bytes of address is different depending on protocols. For 171d8002539STakashi Sakamoto // details, please refer to comments in protocol implementations. 172d8002539STakashi Sakamoto // 173d8002539STakashi Sakamoto // This driver expects userspace applications to configure registers for the 174d8002539STakashi Sakamoto // lower address because in most cases such registers has the other settings. 17519174295STakashi Sakamoto int snd_ff_transaction_reregister(struct snd_ff *ff) 17619174295STakashi Sakamoto { 17719174295STakashi Sakamoto struct fw_card *fw_card = fw_parent_device(ff->unit)->card; 17819174295STakashi Sakamoto u32 addr; 17919174295STakashi Sakamoto __le32 reg; 18019174295STakashi Sakamoto 18119174295STakashi Sakamoto /* 18219174295STakashi Sakamoto * Controllers are allowed to register its node ID and upper 2 byte of 18319174295STakashi Sakamoto * local address to listen asynchronous transactions. 18419174295STakashi Sakamoto */ 18519174295STakashi Sakamoto addr = (fw_card->node_id << 16) | (ff->async_handler.offset >> 32); 18619174295STakashi Sakamoto reg = cpu_to_le32(addr); 18719174295STakashi Sakamoto return snd_fw_transaction(ff->unit, TCODE_WRITE_QUADLET_REQUEST, 1886d1ef1bbSTakashi Sakamoto ff->spec->midi_high_addr, 18919174295STakashi Sakamoto ®, sizeof(reg), 0); 19019174295STakashi Sakamoto } 19119174295STakashi Sakamoto 19219174295STakashi Sakamoto int snd_ff_transaction_register(struct snd_ff *ff) 19319174295STakashi Sakamoto { 19419174295STakashi Sakamoto int i, err; 19519174295STakashi Sakamoto 19619174295STakashi Sakamoto /* 19719174295STakashi Sakamoto * Allocate in Memory Space of IEC 13213, but lower 4 byte in LSB should 19819174295STakashi Sakamoto * be zero due to device specification. 19919174295STakashi Sakamoto */ 20019174295STakashi Sakamoto for (i = 0; i < 0xffff; i++) { 20119174295STakashi Sakamoto err = allocate_own_address(ff, i); 20219174295STakashi Sakamoto if (err != -EBUSY && err != -EAGAIN) 20319174295STakashi Sakamoto break; 20419174295STakashi Sakamoto } 20519174295STakashi Sakamoto if (err < 0) 20619174295STakashi Sakamoto return err; 20719174295STakashi Sakamoto 20819174295STakashi Sakamoto err = snd_ff_transaction_reregister(ff); 20919174295STakashi Sakamoto if (err < 0) 21019174295STakashi Sakamoto return err; 21119174295STakashi Sakamoto 21219174295STakashi Sakamoto INIT_WORK(&ff->rx_midi_work[0], transmit_midi0_msg); 21319174295STakashi Sakamoto INIT_WORK(&ff->rx_midi_work[1], transmit_midi1_msg); 21419174295STakashi Sakamoto 21519174295STakashi Sakamoto return 0; 21619174295STakashi Sakamoto } 21719174295STakashi Sakamoto 21819174295STakashi Sakamoto void snd_ff_transaction_unregister(struct snd_ff *ff) 21919174295STakashi Sakamoto { 22019174295STakashi Sakamoto __le32 reg; 22119174295STakashi Sakamoto 22219174295STakashi Sakamoto if (ff->async_handler.callback_data == NULL) 22319174295STakashi Sakamoto return; 22419174295STakashi Sakamoto ff->async_handler.callback_data = NULL; 22519174295STakashi Sakamoto 22619174295STakashi Sakamoto /* Release higher 4 bytes of address. */ 22719174295STakashi Sakamoto reg = cpu_to_le32(0x00000000); 22819174295STakashi Sakamoto snd_fw_transaction(ff->unit, TCODE_WRITE_QUADLET_REQUEST, 2296d1ef1bbSTakashi Sakamoto ff->spec->midi_high_addr, 23019174295STakashi Sakamoto ®, sizeof(reg), 0); 23119174295STakashi Sakamoto 23219174295STakashi Sakamoto fw_core_remove_address_handler(&ff->async_handler); 23319174295STakashi Sakamoto } 234