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
  80         port->idling = true;
  81
  82         if (!snd_rawmidi_transmit_empty(substream))
  83                 schedule_work(&port->work);
  84 }
  85
  86 static void midi_port_work(struct work_struct *work)
  87 {
  88         struct snd_fw_async_midi_port *port =
  89                         container_of(work, struct snd_fw_async_midi_port, work);
  90         struct snd_rawmidi_substream *substream = ACCESS_ONCE(port->substream);
  91         int generation;
  92         int type;
  93
  94         /* Under transacting. */
  95         if (!port->idling)
  96                 return;
  97
  98         /* Nothing to do. */
  99         if (substream == NULL || snd_rawmidi_transmit_empty(substream))
 100                 return;
 101
 102         /*
 103          * Fill the buffer. The callee must use snd_rawmidi_transmit_peek().
 104          * Later, snd_rawmidi_transmit_ack() is called.
 105          */
 106         memset(port->buf, 0, port->len);
 107         port->consume_bytes = port->fill(substream, port->buf);
 108         if (port->consume_bytes <= 0) {
 109                 /* Do it in next chance, immediately. */
 110                 if (port->consume_bytes == 0)
 111                         schedule_work(&port->work);
 112                 return;
 113         }
 114
 115         /* Calculate type of transaction. */
 116         if (port->len == 4)
 117                 type = TCODE_WRITE_QUADLET_REQUEST;
 118         else
 119                 type = TCODE_WRITE_BLOCK_REQUEST;
 120
 121         /* Start this transaction. */
 122         port->idling = false;
 123
 124         /*
 125          * In Linux FireWire core, when generation is updated with memory
 126          * barrier, node id has already been updated. In this module, After
 127          * this smp_rmb(), load/store instructions to memory are completed.
 128          * Thus, both of generation and node id are available with recent
 129          * values. This is a light-serialization solution to handle bus reset
 130          * events on IEEE 1394 bus.
 131          */
 132         generation = port->parent->generation;
 133         smp_rmb();
 134
 135         fw_send_request(port->parent->card, &port->transaction, type,
 136                         port->parent->node_id, generation,
 137                         port->parent->max_speed, port->addr,
 138                         port->buf, port->len, async_midi_port_callback,
 139                         port);
 140 }
 141
 142 /**
 143  * snd_fw_async_midi_port_init - initialize asynchronous MIDI port structure
 144  * @port: the asynchronous MIDI port to initialize
 145  * @unit: the target of the asynchronous transaction
 146  * @addr: the address to which transactions are transferred
 147  * @len: the length of transaction
 148  * @fill: the callback function to fill given buffer, and returns the
 149  *             number of consumed bytes for MIDI message.
 150  *
 151  */
 152 int snd_fw_async_midi_port_init(struct snd_fw_async_midi_port *port,
 153                 struct fw_unit *unit, u64 addr, unsigned int len,
 154                 snd_fw_async_midi_port_fill fill)
 155 {
 156         port->len = DIV_ROUND_UP(len, 4) * 4;
 157         port->buf = kzalloc(port->len, GFP_KERNEL);
 158         if (port->buf == NULL)
 159                 return -ENOMEM;
 160
 161         port->parent = fw_parent_device(unit);
 162         port->addr = addr;
 163         port->fill = fill;
 164         port->idling = true;
 165
 166         INIT_WORK(&port->work, midi_port_work);
 167
 168         return 0;
 169 }
 170 EXPORT_SYMBOL(snd_fw_async_midi_port_init);
 171
 172 /**
 173  * snd_fw_async_midi_port_destroy - free asynchronous MIDI port structure
 174  * @port: the asynchronous MIDI port structure
 175  */
 176 void snd_fw_async_midi_port_destroy(struct snd_fw_async_midi_port *port)
 177 {
 178         snd_fw_async_midi_port_finish(port);
 179         cancel_work_sync(&port->work);
 180         kfree(port->buf);
 181 }
 182 EXPORT_SYMBOL(snd_fw_async_midi_port_destroy);
 183
 184 MODULE_DESCRIPTION("FireWire audio helper functions");
 185 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
 186 MODULE_LICENSE("GPL v2");