sound/firewire/lib.c

   1 /*
   2  * miscellaneous helper functions
   3  *
   4  * Copyright (c) Clemens Ladisch <clemens@ladisch.de>
   5  * Licensed under the terms of the GNU General Public License, version 2.
   6  */
   7
   8 #include <linux/delay.h>
   9 #include <linux/device.h>
  10 #include <linux/firewire.h>
  11 #include <linux/module.h>
  12 #include <linux/slab.h>
  13 #include "lib.h"
  14
  15 #define ERROR_RETRY_DELAY_MS    20
  16
  17 /**
  18  * snd_fw_transaction - send a request and wait for its completion
  19  * @unit: the driver's unit on the target device
  20  * @tcode: the transaction code
  21  * @offset: the address in the target's address space
  22  * @buffer: input/output data
  23  * @length: length of @buffer
  24  * @flags: use %FW_FIXED_GENERATION and add the generation value to attempt the
  25  *         request only in that generation; use %FW_QUIET to suppress error
  26  *         messages
  27  *
  28  * Submits an asynchronous request to the target device, and waits for the
  29  * response.  The node ID and the current generation are derived from @unit.
  30  * On a bus reset or an error, the transaction is retried a few times.
  31  * Returns zero on success, or a negative error code.
  32  */
  33 int snd_fw_transaction(struct fw_unit *unit, int tcode,
  34                        u64 offset, void *buffer, size_t length,
  35                        unsigned int flags)
  36 {
  37         struct fw_device *device = fw_parent_device(unit);
  38         int generation, rcode, tries = 0;
  39
  40         generation = flags & FW_GENERATION_MASK;
  41         for (;;) {
  42                 if (!(flags & FW_FIXED_GENERATION)) {
  43                         generation = device->generation;
  44                         smp_rmb(); /* node_id vs. generation */
  45                 }
  46                 rcode = fw_run_transaction(device->card, tcode,
  47                                            device->node_id, generation,
  48                                            device->max_speed, offset,
  49                                            buffer, length);
  50
  51                 if (rcode == RCODE_COMPLETE)
  52                         return 0;
  53
  54                 if (rcode == RCODE_GENERATION && (flags & FW_FIXED_GENERATION))
  55                         return -EAGAIN;
  56
  57                 if (rcode_is_permanent_error(rcode) || ++tries >= 3) {
  58                         if (!(flags & FW_QUIET))
  59                                 dev_err(&unit->device,
  60                                         "transaction failed: %s\n",
  61                                         fw_rcode_string(rcode));
  62                         return -EIO;
  63                 }
  64
  65                 msleep(ERROR_RETRY_DELAY_MS);
  66         }
  67 }
  68 EXPORT_SYMBOL(snd_fw_transaction);
  69
  70 static void async_midi_port_callback(struct fw_card *card, int rcode,
  71                                      void *data, size_t length,
  72                                      void *callback_data)
  73 {
  74         struct snd_fw_async_midi_port *port = callback_data;
  75         struct snd_rawmidi_substream *substream = ACCESS_ONCE(port->substream);
  76
  77         if (rcode == RCODE_COMPLETE && substream != NULL)
  78                 snd_rawmidi_transmit_ack(substream, port->consume_bytes);
  79         else if (!rcode_is_permanent_error(rcode))
  80                 /* To start next transaction immediately for recovery. */
  81                 port->next_ktime = ktime_set(0, 0);
  82
  83         port->idling = true;
  84
  85         if (!snd_rawmidi_transmit_empty(substream))
  86                 schedule_work(&port->work);
  87 }
  88
  89 static void midi_port_work(struct work_struct *work)
  90 {
  91         struct snd_fw_async_midi_port *port =
  92                         container_of(work, struct snd_fw_async_midi_port, work);
  93         struct snd_rawmidi_substream *substream = ACCESS_ONCE(port->substream);
  94         int generation;
  95         int type;
  96
  97         /* Under transacting. */
  98         if (!port->idling)
  99                 return;
 100
 101         /* Nothing to do. */
 102         if (substream == NULL || snd_rawmidi_transmit_empty(substream))
 103                 return;
 104
 105         /* Do it in next chance. */
 106         if (ktime_after(port->next_ktime, ktime_get())) {
 107                 schedule_work(&port->work);
 108                 return;
 109         }
 110
 111         /*
 112          * Fill the buffer. The callee must use snd_rawmidi_transmit_peek().
 113          * Later, snd_rawmidi_transmit_ack() is called.
 114          */
 115         memset(port->buf, 0, port->len);
 116         port->consume_bytes = port->fill(substream, port->buf);
 117         if (port->consume_bytes <= 0) {
 118                 /* Do it in next chance, immediately. */
 119                 if (port->consume_bytes == 0) {
 120                         port->next_ktime = ktime_set(0, 0);
 121                         schedule_work(&port->work);
 122                 }
 123                 return;
 124         }
 125
 126         /* Calculate type of transaction. */
 127         if (port->len == 4)
 128                 type = TCODE_WRITE_QUADLET_REQUEST;
 129         else
 130                 type = TCODE_WRITE_BLOCK_REQUEST;
 131
 132         /* Set interval to next transaction. */
 133         port->next_ktime = ktime_add_ns(ktime_get(),
 134                                 port->consume_bytes * 8 * NSEC_PER_SEC / 31250);
 135
 136         /* Start this transaction. */
 137         port->idling = false;
 138
 139         /*
 140          * In Linux FireWire core, when generation is updated with memory
 141          * barrier, node id has already been updated. In this module, After
 142          * this smp_rmb(), load/store instructions to memory are completed.
 143          * Thus, both of generation and node id are available with recent
 144          * values. This is a light-serialization solution to handle bus reset
 145          * events on IEEE 1394 bus.
 146          */
 147         generation = port->parent->generation;
 148         smp_rmb();
 149
 150         fw_send_request(port->parent->card, &port->transaction, type,
 151                         port->parent->node_id, generation,
 152                         port->parent->max_speed, port->addr,
 153                         port->buf, port->len, async_midi_port_callback,
 154                         port);
 155 }
 156
 157 /**
 158  * snd_fw_async_midi_port_init - initialize asynchronous MIDI port structure
 159  * @port: the asynchronous MIDI port to initialize
 160  * @unit: the target of the asynchronous transaction
 161  * @addr: the address to which transactions are transferred
 162  * @len: the length of transaction
 163  * @fill: the callback function to fill given buffer, and returns the
 164  *             number of consumed bytes for MIDI message.
 165  *
 166  */
 167 int snd_fw_async_midi_port_init(struct snd_fw_async_midi_port *port,
 168                 struct fw_unit *unit, u64 addr, unsigned int len,
 169                 snd_fw_async_midi_port_fill fill)
 170 {
 171         port->len = DIV_ROUND_UP(len, 4) * 4;
 172         port->buf = kzalloc(port->len, GFP_KERNEL);
 173         if (port->buf == NULL)
 174                 return -ENOMEM;
 175
 176         port->parent = fw_parent_device(unit);
 177         port->addr = addr;
 178         port->fill = fill;
 179         port->idling = true;
 180         port->next_ktime = ktime_set(0, 0);
 181
 182         INIT_WORK(&port->work, midi_port_work);
 183
 184         return 0;
 185 }
 186 EXPORT_SYMBOL(snd_fw_async_midi_port_init);
 187
 188 /**
 189  * snd_fw_async_midi_port_destroy - free asynchronous MIDI port structure
 190  * @port: the asynchronous MIDI port structure
 191  */
 192 void snd_fw_async_midi_port_destroy(struct snd_fw_async_midi_port *port)
 193 {
 194         snd_fw_async_midi_port_finish(port);
 195         cancel_work_sync(&port->work);
 196         kfree(port->buf);
 197 }
 198 EXPORT_SYMBOL(snd_fw_async_midi_port_destroy);
 199
 200 MODULE_DESCRIPTION("FireWire audio helper functions");
 201 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
 202 MODULE_LICENSE("GPL v2");