blob: 481056df9268db5cb51979c83a337715c7c6fb42 [file] [log] [blame]
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001/*
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +01002 * Isochronous I/O functionality:
3 * - Isochronous DMA context management
4 * - Isochronous bus resource management (channels, bandwidth), client side
Kristian Høgsberg3038e352006-12-19 19:58:27 -05005 *
Kristian Høgsberg3038e352006-12-19 19:58:27 -05006 * Copyright (C) 2006 Kristian Hoegsberg <krh@bitplanet.net>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software Foundation,
20 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 */
22
Kristian Høgsberg3038e352006-12-19 19:58:27 -050023#include <linux/dma-mapping.h>
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +010024#include <linux/errno.h>
Stefan Richter77c9a5d2009-06-05 16:26:18 +020025#include <linux/firewire.h>
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +010026#include <linux/firewire-constants.h>
27#include <linux/kernel.h>
Kristian Høgsberg3038e352006-12-19 19:58:27 -050028#include <linux/mm.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090029#include <linux/slab.h>
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +010030#include <linux/spinlock.h>
31#include <linux/vmalloc.h>
Kristian Høgsberg3038e352006-12-19 19:58:27 -050032
Stefan Richtere8ca9702009-06-04 21:09:38 +020033#include <asm/byteorder.h>
34
Stefan Richter77c9a5d2009-06-05 16:26:18 +020035#include "core.h"
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +010036
37/*
38 * Isochronous DMA context management
39 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -050040
Stefan Richter53dca512008-12-14 21:47:04 +010041int fw_iso_buffer_init(struct fw_iso_buffer *buffer, struct fw_card *card,
42 int page_count, enum dma_data_direction direction)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050043{
Stefan Richter2dbd7d72008-12-14 21:45:45 +010044 int i, j;
Kristian Høgsberg9aad8122007-02-16 17:34:38 -050045 dma_addr_t address;
Kristian Høgsberg3038e352006-12-19 19:58:27 -050046
Kristian Høgsberg9aad8122007-02-16 17:34:38 -050047 buffer->page_count = page_count;
48 buffer->direction = direction;
Kristian Høgsberg3038e352006-12-19 19:58:27 -050049
Kristian Høgsberg9aad8122007-02-16 17:34:38 -050050 buffer->pages = kmalloc(page_count * sizeof(buffer->pages[0]),
51 GFP_KERNEL);
52 if (buffer->pages == NULL)
53 goto out;
Kristian Høgsberg3038e352006-12-19 19:58:27 -050054
Kristian Høgsberg9aad8122007-02-16 17:34:38 -050055 for (i = 0; i < buffer->page_count; i++) {
Kristian Høgsberg68be3fa2007-02-16 17:34:48 -050056 buffer->pages[i] = alloc_page(GFP_KERNEL | GFP_DMA32 | __GFP_ZERO);
Kristian Høgsberg9aad8122007-02-16 17:34:38 -050057 if (buffer->pages[i] == NULL)
58 goto out_pages;
Stefan Richter373b2ed2007-03-04 14:45:18 +010059
Kristian Høgsberg9aad8122007-02-16 17:34:38 -050060 address = dma_map_page(card->device, buffer->pages[i],
61 0, PAGE_SIZE, direction);
FUJITA Tomonori8d8bb392008-07-25 19:44:49 -070062 if (dma_mapping_error(card->device, address)) {
Kristian Høgsberg9aad8122007-02-16 17:34:38 -050063 __free_page(buffer->pages[i]);
64 goto out_pages;
65 }
66 set_page_private(buffer->pages[i], address);
Kristian Høgsberg3038e352006-12-19 19:58:27 -050067 }
68
69 return 0;
Kristian Høgsberg82eff9d2007-02-06 14:49:40 -050070
Kristian Høgsberg9aad8122007-02-16 17:34:38 -050071 out_pages:
72 for (j = 0; j < i; j++) {
73 address = page_private(buffer->pages[j]);
74 dma_unmap_page(card->device, address,
Stefan Richter29ad14c2009-06-15 00:38:50 +020075 PAGE_SIZE, direction);
Kristian Høgsberg9aad8122007-02-16 17:34:38 -050076 __free_page(buffer->pages[j]);
77 }
78 kfree(buffer->pages);
79 out:
80 buffer->pages = NULL;
Stefan Richtere1eff7a2009-02-03 17:55:19 +010081
Stefan Richter2dbd7d72008-12-14 21:45:45 +010082 return -ENOMEM;
Kristian Høgsberg3038e352006-12-19 19:58:27 -050083}
Jay Fenlasonc76acec2009-05-18 13:08:06 -040084EXPORT_SYMBOL(fw_iso_buffer_init);
Kristian Høgsberg3038e352006-12-19 19:58:27 -050085
Kristian Høgsberg9aad8122007-02-16 17:34:38 -050086int fw_iso_buffer_map(struct fw_iso_buffer *buffer, struct vm_area_struct *vma)
87{
88 unsigned long uaddr;
Stefan Richtere1eff7a2009-02-03 17:55:19 +010089 int i, err;
Kristian Høgsberg9aad8122007-02-16 17:34:38 -050090
91 uaddr = vma->vm_start;
92 for (i = 0; i < buffer->page_count; i++) {
Stefan Richtere1eff7a2009-02-03 17:55:19 +010093 err = vm_insert_page(vma, uaddr, buffer->pages[i]);
94 if (err)
95 return err;
96
Kristian Høgsberg9aad8122007-02-16 17:34:38 -050097 uaddr += PAGE_SIZE;
98 }
99
100 return 0;
101}
102
103void fw_iso_buffer_destroy(struct fw_iso_buffer *buffer,
104 struct fw_card *card)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500105{
106 int i;
Kristian Høgsberg9aad8122007-02-16 17:34:38 -0500107 dma_addr_t address;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500108
Kristian Høgsberg9aad8122007-02-16 17:34:38 -0500109 for (i = 0; i < buffer->page_count; i++) {
110 address = page_private(buffer->pages[i]);
111 dma_unmap_page(card->device, address,
Stefan Richter29ad14c2009-06-15 00:38:50 +0200112 PAGE_SIZE, buffer->direction);
Kristian Høgsberg9aad8122007-02-16 17:34:38 -0500113 __free_page(buffer->pages[i]);
114 }
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500115
Kristian Høgsberg9aad8122007-02-16 17:34:38 -0500116 kfree(buffer->pages);
117 buffer->pages = NULL;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500118}
Jay Fenlasonc76acec2009-05-18 13:08:06 -0400119EXPORT_SYMBOL(fw_iso_buffer_destroy);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500120
Stefan Richter872e3302010-07-29 18:19:22 +0200121/* Convert DMA address to offset into virtually contiguous buffer. */
122size_t fw_iso_buffer_lookup(struct fw_iso_buffer *buffer, dma_addr_t completed)
123{
124 int i;
125 dma_addr_t address;
126 ssize_t offset;
127
128 for (i = 0; i < buffer->page_count; i++) {
129 address = page_private(buffer->pages[i]);
130 offset = (ssize_t)completed - (ssize_t)address;
131 if (offset > 0 && offset <= PAGE_SIZE)
132 return (i << PAGE_SHIFT) + offset;
133 }
134
135 return 0;
136}
137
Stefan Richter53dca512008-12-14 21:47:04 +0100138struct fw_iso_context *fw_iso_context_create(struct fw_card *card,
139 int type, int channel, int speed, size_t header_size,
140 fw_iso_callback_t callback, void *callback_data)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500141{
142 struct fw_iso_context *ctx;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500143
Stefan Richter4817ed22008-12-21 16:39:46 +0100144 ctx = card->driver->allocate_iso_context(card,
145 type, channel, header_size);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500146 if (IS_ERR(ctx))
147 return ctx;
148
149 ctx->card = card;
150 ctx->type = type;
Kristian Høgsberg21efb3c2007-02-16 17:34:50 -0500151 ctx->channel = channel;
152 ctx->speed = speed;
Kristian Høgsberg295e3fe2007-02-16 17:34:40 -0500153 ctx->header_size = header_size;
Stefan Richter872e3302010-07-29 18:19:22 +0200154 ctx->callback.sc = callback;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500155 ctx->callback_data = callback_data;
156
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500157 return ctx;
158}
Jay Fenlasonc76acec2009-05-18 13:08:06 -0400159EXPORT_SYMBOL(fw_iso_context_create);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500160
161void fw_iso_context_destroy(struct fw_iso_context *ctx)
162{
Stefan Richter872e3302010-07-29 18:19:22 +0200163 ctx->card->driver->free_iso_context(ctx);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500164}
Jay Fenlasonc76acec2009-05-18 13:08:06 -0400165EXPORT_SYMBOL(fw_iso_context_destroy);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500166
Stefan Richter53dca512008-12-14 21:47:04 +0100167int fw_iso_context_start(struct fw_iso_context *ctx,
168 int cycle, int sync, int tags)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500169{
Kristian Høgsbergeb0306e2007-03-14 17:34:54 -0400170 return ctx->card->driver->start_iso(ctx, cycle, sync, tags);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500171}
Jay Fenlasonc76acec2009-05-18 13:08:06 -0400172EXPORT_SYMBOL(fw_iso_context_start);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500173
Stefan Richter872e3302010-07-29 18:19:22 +0200174int fw_iso_context_set_channels(struct fw_iso_context *ctx, u64 *channels)
175{
176 return ctx->card->driver->set_iso_channels(ctx, channels);
177}
178
Stefan Richter53dca512008-12-14 21:47:04 +0100179int fw_iso_context_queue(struct fw_iso_context *ctx,
180 struct fw_iso_packet *packet,
181 struct fw_iso_buffer *buffer,
182 unsigned long payload)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500183{
Stefan Richter872e3302010-07-29 18:19:22 +0200184 return ctx->card->driver->queue_iso(ctx, packet, buffer, payload);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500185}
Jay Fenlasonc76acec2009-05-18 13:08:06 -0400186EXPORT_SYMBOL(fw_iso_context_queue);
Kristian Høgsbergb8295662007-02-16 17:34:42 -0500187
Stefan Richter53dca512008-12-14 21:47:04 +0100188int fw_iso_context_stop(struct fw_iso_context *ctx)
Kristian Høgsbergb8295662007-02-16 17:34:42 -0500189{
190 return ctx->card->driver->stop_iso(ctx);
191}
Jay Fenlasonc76acec2009-05-18 13:08:06 -0400192EXPORT_SYMBOL(fw_iso_context_stop);
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100193
194/*
195 * Isochronous bus resource management (channels, bandwidth), client side
196 */
197
198static int manage_bandwidth(struct fw_card *card, int irm_id, int generation,
Stefan Richter6fdc0372009-06-20 13:23:59 +0200199 int bandwidth, bool allocate, __be32 data[2])
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100200{
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100201 int try, new, old = allocate ? BANDWIDTH_AVAILABLE_INITIAL : 0;
202
203 /*
204 * On a 1394a IRM with low contention, try < 1 is enough.
205 * On a 1394-1995 IRM, we need at least try < 2.
206 * Let's just do try < 5.
207 */
208 for (try = 0; try < 5; try++) {
209 new = allocate ? old - bandwidth : old + bandwidth;
210 if (new < 0 || new > BANDWIDTH_AVAILABLE_INITIAL)
Clemens Ladischd6372b62010-04-12 10:35:18 +0200211 return -EBUSY;
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100212
213 data[0] = cpu_to_be32(old);
214 data[1] = cpu_to_be32(new);
215 switch (fw_run_transaction(card, TCODE_LOCK_COMPARE_SWAP,
216 irm_id, generation, SCODE_100,
217 CSR_REGISTER_BASE + CSR_BANDWIDTH_AVAILABLE,
Stefan Richter1821bc12009-09-05 13:23:49 +0200218 data, 8)) {
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100219 case RCODE_GENERATION:
220 /* A generation change frees all bandwidth. */
221 return allocate ? -EAGAIN : bandwidth;
222
223 case RCODE_COMPLETE:
224 if (be32_to_cpup(data) == old)
225 return bandwidth;
226
227 old = be32_to_cpup(data);
228 /* Fall through. */
229 }
230 }
231
232 return -EIO;
233}
234
235static int manage_channel(struct fw_card *card, int irm_id, int generation,
Stefan Richter6fdc0372009-06-20 13:23:59 +0200236 u32 channels_mask, u64 offset, bool allocate, __be32 data[2])
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100237{
Clemens Ladisch5aaffc62011-01-31 11:58:58 +0100238 __be32 bit, all, old;
239 int channel, ret = -EIO, retry = 5;
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100240
Stefan Richter5d9cb7d272009-01-08 23:07:40 +0100241 old = all = allocate ? cpu_to_be32(~0) : 0;
242
Clemens Ladisch5aaffc62011-01-31 11:58:58 +0100243 for (channel = 0; channel < 32; channel++) {
244 if (!(channels_mask & 1 << channel))
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100245 continue;
246
Clemens Ladischd6372b62010-04-12 10:35:18 +0200247 ret = -EBUSY;
248
Clemens Ladisch5aaffc62011-01-31 11:58:58 +0100249 bit = cpu_to_be32(1 << (31 - channel));
250 if ((old & bit) != (all & bit))
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100251 continue;
252
253 data[0] = old;
Clemens Ladisch5aaffc62011-01-31 11:58:58 +0100254 data[1] = old ^ bit;
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100255 switch (fw_run_transaction(card, TCODE_LOCK_COMPARE_SWAP,
256 irm_id, generation, SCODE_100,
Stefan Richter1821bc12009-09-05 13:23:49 +0200257 offset, data, 8)) {
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100258 case RCODE_GENERATION:
259 /* A generation change frees all channels. */
Clemens Ladisch5aaffc62011-01-31 11:58:58 +0100260 return allocate ? -EAGAIN : channel;
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100261
262 case RCODE_COMPLETE:
263 if (data[0] == old)
Clemens Ladisch5aaffc62011-01-31 11:58:58 +0100264 return channel;
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100265
266 old = data[0];
267
268 /* Is the IRM 1394a-2000 compliant? */
Clemens Ladisch5aaffc62011-01-31 11:58:58 +0100269 if ((data[0] & bit) == (data[1] & bit))
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100270 continue;
271
272 /* 1394-1995 IRM, fall through to retry. */
273 default:
Clemens Ladisch3a1f0a02010-04-12 10:35:05 +0200274 if (retry) {
275 retry--;
Clemens Ladisch5aaffc62011-01-31 11:58:58 +0100276 channel--;
Clemens Ladischd6372b62010-04-12 10:35:18 +0200277 } else {
278 ret = -EIO;
Clemens Ladisch3a1f0a02010-04-12 10:35:05 +0200279 }
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100280 }
281 }
282
Clemens Ladischd6372b62010-04-12 10:35:18 +0200283 return ret;
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100284}
285
286static void deallocate_channel(struct fw_card *card, int irm_id,
Stefan Richter6fdc0372009-06-20 13:23:59 +0200287 int generation, int channel, __be32 buffer[2])
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100288{
Stefan Richter5d9cb7d272009-01-08 23:07:40 +0100289 u32 mask;
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100290 u64 offset;
291
Stefan Richter5d9cb7d272009-01-08 23:07:40 +0100292 mask = channel < 32 ? 1 << channel : 1 << (channel - 32);
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100293 offset = channel < 32 ? CSR_REGISTER_BASE + CSR_CHANNELS_AVAILABLE_HI :
294 CSR_REGISTER_BASE + CSR_CHANNELS_AVAILABLE_LO;
295
Stefan Richter6fdc0372009-06-20 13:23:59 +0200296 manage_channel(card, irm_id, generation, mask, offset, false, buffer);
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100297}
298
299/**
Stefan Richter656b7af2010-07-07 13:26:18 +0200300 * fw_iso_resource_manage() - Allocate or deallocate a channel and/or bandwidth
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100301 *
302 * In parameters: card, generation, channels_mask, bandwidth, allocate
303 * Out parameters: channel, bandwidth
304 * This function blocks (sleeps) during communication with the IRM.
Stefan Richter5d9cb7d272009-01-08 23:07:40 +0100305 *
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100306 * Allocates or deallocates at most one channel out of channels_mask.
Stefan Richter5d9cb7d272009-01-08 23:07:40 +0100307 * channels_mask is a bitfield with MSB for channel 63 and LSB for channel 0.
308 * (Note, the IRM's CHANNELS_AVAILABLE is a big-endian bitfield with MSB for
309 * channel 0 and LSB for channel 63.)
310 * Allocates or deallocates as many bandwidth allocation units as specified.
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100311 *
312 * Returns channel < 0 if no channel was allocated or deallocated.
313 * Returns bandwidth = 0 if no bandwidth was allocated or deallocated.
314 *
315 * If generation is stale, deallocations succeed but allocations fail with
316 * channel = -EAGAIN.
317 *
Stefan Richter5d9cb7d272009-01-08 23:07:40 +0100318 * If channel allocation fails, no bandwidth will be allocated either.
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100319 * If bandwidth allocation fails, no channel will be allocated either.
Stefan Richter5d9cb7d272009-01-08 23:07:40 +0100320 * But deallocations of channel and bandwidth are tried independently
321 * of each other's success.
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100322 */
323void fw_iso_resource_manage(struct fw_card *card, int generation,
324 u64 channels_mask, int *channel, int *bandwidth,
Stefan Richter6fdc0372009-06-20 13:23:59 +0200325 bool allocate, __be32 buffer[2])
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100326{
Stefan Richter5d9cb7d272009-01-08 23:07:40 +0100327 u32 channels_hi = channels_mask; /* channels 31...0 */
328 u32 channels_lo = channels_mask >> 32; /* channels 63...32 */
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100329 int irm_id, ret, c = -EINVAL;
330
331 spin_lock_irq(&card->lock);
332 irm_id = card->irm_node->node_id;
333 spin_unlock_irq(&card->lock);
334
335 if (channels_hi)
336 c = manage_channel(card, irm_id, generation, channels_hi,
Stefan Richter6fdc0372009-06-20 13:23:59 +0200337 CSR_REGISTER_BASE + CSR_CHANNELS_AVAILABLE_HI,
338 allocate, buffer);
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100339 if (channels_lo && c < 0) {
340 c = manage_channel(card, irm_id, generation, channels_lo,
Stefan Richter6fdc0372009-06-20 13:23:59 +0200341 CSR_REGISTER_BASE + CSR_CHANNELS_AVAILABLE_LO,
342 allocate, buffer);
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100343 if (c >= 0)
344 c += 32;
345 }
346 *channel = c;
347
Stefan Richter5d9cb7d272009-01-08 23:07:40 +0100348 if (allocate && channels_mask != 0 && c < 0)
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100349 *bandwidth = 0;
350
351 if (*bandwidth == 0)
352 return;
353
Stefan Richter6fdc0372009-06-20 13:23:59 +0200354 ret = manage_bandwidth(card, irm_id, generation, *bandwidth,
355 allocate, buffer);
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100356 if (ret < 0)
357 *bandwidth = 0;
358
Clemens Ladischcf36df62010-03-15 13:20:32 +0100359 if (allocate && ret < 0) {
360 if (c >= 0)
361 deallocate_channel(card, irm_id, generation, c, buffer);
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100362 *channel = ret;
363 }
364}
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100365EXPORT_SYMBOL(fw_iso_resource_manage);