sound/firewire/fireface/ff-transaction.c

   1 /*
   2  * ff-transaction.c - a part of driver for RME Fireface series
   3  *
   4  * Copyright (c) 2015-2017 Takashi Sakamoto
   5  *
   6  * Licensed under the terms of the GNU General Public License, version 2.
   7  */
   8
   9 #include "ff.h"
  10
  11 static void finish_transmit_midi_msg(struct snd_ff *ff, unsigned int port,
  12                                      int rcode)
  13 {
  14         struct snd_rawmidi_substream *substream =
  15                                 READ_ONCE(ff->rx_midi_substreams[port]);
  16
  17         if (rcode_is_permanent_error(rcode)) {
  18                 ff->rx_midi_error[port] = true;
  19                 return;
  20         }
  21
  22         if (rcode != RCODE_COMPLETE) {
  23                 /* Transfer the message again, immediately. */
  24                 ff->next_ktime[port] = 0;
  25                 schedule_work(&ff->rx_midi_work[port]);
  26                 return;
  27         }
  28
  29         snd_rawmidi_transmit_ack(substream, ff->rx_bytes[port]);
  30         ff->rx_bytes[port] = 0;
  31
  32         if (!snd_rawmidi_transmit_empty(substream))
  33                 schedule_work(&ff->rx_midi_work[port]);
  34 }
  35
  36 static void finish_transmit_midi0_msg(struct fw_card *card, int rcode,
  37                                       void *data, size_t length,
  38                                       void *callback_data)
  39 {
  40         struct snd_ff *ff =
  41                 container_of(callback_data, struct snd_ff, transactions[0]);
  42         finish_transmit_midi_msg(ff, 0, rcode);
  43 }
  44
  45 static void finish_transmit_midi1_msg(struct fw_card *card, int rcode,
  46                                       void *data, size_t length,
  47                                       void *callback_data)
  48 {
  49         struct snd_ff *ff =
  50                 container_of(callback_data, struct snd_ff, transactions[1]);
  51         finish_transmit_midi_msg(ff, 1, rcode);
  52 }
  53
  54 static inline void fill_midi_buf(struct snd_ff *ff, unsigned int port,
  55                                  unsigned int index, u8 byte)
  56 {
  57         ff->msg_buf[port][index] = cpu_to_le32(byte);
  58 }
  59
  60 static void transmit_midi_msg(struct snd_ff *ff, unsigned int port)
  61 {
  62         struct snd_rawmidi_substream *substream =
  63                         READ_ONCE(ff->rx_midi_substreams[port]);
  64         u8 *buf = (u8 *)ff->msg_buf[port];
  65         int i, len;
  66
  67         struct fw_device *fw_dev = fw_parent_device(ff->unit);
  68         unsigned long long addr;
  69         int generation;
  70         fw_transaction_callback_t callback;
  71
  72         if (substream == NULL || snd_rawmidi_transmit_empty(substream))
  73                 return;
  74
  75         if (ff->rx_bytes[port] > 0 || ff->rx_midi_error[port])
  76                 return;
  77
  78         /* Do it in next chance. */
  79         if (ktime_after(ff->next_ktime[port], ktime_get())) {
  80                 schedule_work(&ff->rx_midi_work[port]);
  81                 return;
  82         }
  83
  84         len = snd_rawmidi_transmit_peek(substream, buf,
  85                                         SND_FF_MAXIMIM_MIDI_QUADS);
  86         if (len <= 0)
  87                 return;
  88
  89         for (i = len - 1; i >= 0; i--)
  90                 fill_midi_buf(ff, port, i, buf[i]);
  91
  92         if (port == 0) {
  93                 addr = ff->spec->midi_rx_addrs[0];
  94                 callback = finish_transmit_midi0_msg;
  95         } else {
  96                 addr = ff->spec->midi_rx_addrs[1];
  97                 callback = finish_transmit_midi1_msg;
  98         }
  99
 100         /* Set interval to next transaction. */
 101         ff->next_ktime[port] = ktime_add_ns(ktime_get(),
 102                                             len * 8 * NSEC_PER_SEC / 31250);
 103         ff->rx_bytes[port] = len;
 104
 105         /*
 106          * In Linux FireWire core, when generation is updated with memory
 107          * barrier, node id has already been updated. In this module, After
 108          * this smp_rmb(), load/store instructions to memory are completed.
 109          * Thus, both of generation and node id are available with recent
 110          * values. This is a light-serialization solution to handle bus reset
 111          * events on IEEE 1394 bus.
 112          */
 113         generation = fw_dev->generation;
 114         smp_rmb();
 115         fw_send_request(fw_dev->card, &ff->transactions[port],
 116                         TCODE_WRITE_BLOCK_REQUEST,
 117                         fw_dev->node_id, generation, fw_dev->max_speed,
 118                         addr, &ff->msg_buf[port], len * 4,
 119                         callback, &ff->transactions[port]);
 120 }
 121
 122 static void transmit_midi0_msg(struct work_struct *work)
 123 {
 124         struct snd_ff *ff = container_of(work, struct snd_ff, rx_midi_work[0]);
 125
 126         transmit_midi_msg(ff, 0);
 127 }
 128
 129 static void transmit_midi1_msg(struct work_struct *work)
 130 {
 131         struct snd_ff *ff = container_of(work, struct snd_ff, rx_midi_work[1]);
 132
 133         transmit_midi_msg(ff, 1);
 134 }
 135
 136 static void handle_midi_msg(struct fw_card *card, struct fw_request *request,
 137                             int tcode, int destination, int source,
 138                             int generation, unsigned long long offset,
 139                             void *data, size_t length, void *callback_data)
 140 {
 141         struct snd_ff *ff = callback_data;
 142         __le32 *buf = data;
 143
 144         fw_send_response(card, request, RCODE_COMPLETE);
 145
 146         offset -= ff->async_handler.offset;
 147         ff->spec->protocol->handle_midi_msg(ff, (unsigned int)offset, buf,
 148                                             length);
 149 }
 150
 151 static int allocate_own_address(struct snd_ff *ff, int i)
 152 {
 153         struct fw_address_region midi_msg_region;
 154         int err;
 155
 156         ff->async_handler.length = ff->spec->midi_addr_range;
 157         ff->async_handler.address_callback = handle_midi_msg;
 158         ff->async_handler.callback_data = ff;
 159
 160         midi_msg_region.start = 0x000100000000ull * i;
 161         midi_msg_region.end = midi_msg_region.start + ff->async_handler.length;
 162
 163         err = fw_core_add_address_handler(&ff->async_handler, &midi_msg_region);
 164         if (err >= 0) {
 165                 /* Controllers are allowed to register this region. */
 166                 if (ff->async_handler.offset & 0x0000ffffffff) {
 167                         fw_core_remove_address_handler(&ff->async_handler);
 168                         err = -EAGAIN;
 169                 }
 170         }
 171
 172         return err;
 173 }
 174
 175 /*
 176  * Controllers are allowed to register higher 4 bytes of address to receive
 177  * the transactions. Different models have different registers for this purpose;
 178  * e.g. 0x'0000'8010'03f4 for Fireface 400.
 179  * The controllers are not allowed to register lower 4 bytes of the address.
 180  * They are forced to select one of 4 options for the part of address by writing
 181  * corresponding bits to 0x'0000'8010'051f.
 182  *
 183  * The 3rd-6th bits of this register are flags to indicate lower 4 bytes of
 184  * address to which the device transferrs the transactions. In short:
 185  *  - 0x20: 0x'....'....'0000'0180
 186  *  - 0x10: 0x'....'....'0000'0100
 187  *  - 0x08: 0x'....'....'0000'0080
 188  *  - 0x04: 0x'....'....'0000'0000
 189  *
 190  * This driver configure 0x'....'....'0000'0000 to receive MIDI messages from
 191  * units. The 3rd bit of the register should be configured, however this driver
 192  * deligates this task to userspace applications due to a restriction that this
 193  * register is write-only and the other bits have own effects.
 194  *
 195  * Unlike Fireface 800, Fireface 400 cancels transferring asynchronous
 196  * transactions when the 1st and 2nd of the register stand. These two bits have
 197  * the same effect.
 198  *  - 0x02, 0x01: cancel transferring
 199  *
 200  * On the other hand, the bits have no effect on Fireface 800. This model
 201  * cancels asynchronous transactions when the higher 4 bytes of address is
 202  * overwritten with zero.
 203  */
 204 int snd_ff_transaction_reregister(struct snd_ff *ff)
 205 {
 206         struct fw_card *fw_card = fw_parent_device(ff->unit)->card;
 207         u32 addr;
 208         __le32 reg;
 209
 210         /*
 211          * Controllers are allowed to register its node ID and upper 2 byte of
 212          * local address to listen asynchronous transactions.
 213          */
 214         addr = (fw_card->node_id << 16) | (ff->async_handler.offset >> 32);
 215         reg = cpu_to_le32(addr);
 216         return snd_fw_transaction(ff->unit, TCODE_WRITE_QUADLET_REQUEST,
 217                                   ff->spec->midi_high_addr,
 218                                   &reg, sizeof(reg), 0);
 219 }
 220
 221 int snd_ff_transaction_register(struct snd_ff *ff)
 222 {
 223         int i, err;
 224
 225         /*
 226          * Allocate in Memory Space of IEC 13213, but lower 4 byte in LSB should
 227          * be zero due to device specification.
 228          */
 229         for (i = 0; i < 0xffff; i++) {
 230                 err = allocate_own_address(ff, i);
 231                 if (err != -EBUSY && err != -EAGAIN)
 232                         break;
 233         }
 234         if (err < 0)
 235                 return err;
 236
 237         err = snd_ff_transaction_reregister(ff);
 238         if (err < 0)
 239                 return err;
 240
 241         INIT_WORK(&ff->rx_midi_work[0], transmit_midi0_msg);
 242         INIT_WORK(&ff->rx_midi_work[1], transmit_midi1_msg);
 243
 244         return 0;
 245 }
 246
 247 void snd_ff_transaction_unregister(struct snd_ff *ff)
 248 {
 249         __le32 reg;
 250
 251         if (ff->async_handler.callback_data == NULL)
 252                 return;
 253         ff->async_handler.callback_data = NULL;
 254
 255         /* Release higher 4 bytes of address. */
 256         reg = cpu_to_le32(0x00000000);
 257         snd_fw_transaction(ff->unit, TCODE_WRITE_QUADLET_REQUEST,
 258                            ff->spec->midi_high_addr,
 259                            &reg, sizeof(reg), 0);
 260
 261         fw_core_remove_address_handler(&ff->async_handler);
 262 }