[deliverable/linux.git] / drivers / firewire / core-iso.c

/*
 * Isochronous I/O functionality:
 *   - Isochronous DMA context management
 *   - Isochronous bus resource management (channels, bandwidth), client side
 *
 * Copyright (C) 2006 Kristian Hoegsberg <krh@bitplanet.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#include <linux/dma-mapping.h>
#include <linux/errno.h>
#include <linux/firewire.h>
#include <linux/firewire-constants.h>
#include <linux/kernel.h>
#include <linux/mm.h>
#include <linux/spinlock.h>
#include <linux/vmalloc.h>

#include <asm/byteorder.h>

#include "core.h"

/*
 * Isochronous DMA context management
 */

int fw_iso_buffer_init(struct fw_iso_buffer *buffer, struct fw_card *card,
		       int page_count, enum dma_data_direction direction)
{
	int i, j;
	dma_addr_t address;

	buffer->page_count = page_count;
	buffer->direction = direction;

	buffer->pages = kmalloc(page_count * sizeof(buffer->pages[0]),
				GFP_KERNEL);
	if (buffer->pages == NULL)
		goto out;

	for (i = 0; i < buffer->page_count; i++) {
		buffer->pages[i] = alloc_page(GFP_KERNEL | GFP_DMA32 | __GFP_ZERO);
		if (buffer->pages[i] == NULL)
			goto out_pages;

		address = dma_map_page(card->device, buffer->pages[i],
				       0, PAGE_SIZE, direction);
		if (dma_mapping_error(card->device, address)) {
			__free_page(buffer->pages[i]);
			goto out_pages;
		}
		set_page_private(buffer->pages[i], address);
	}

	return 0;

 out_pages:
	for (j = 0; j < i; j++) {
		address = page_private(buffer->pages[j]);
		dma_unmap_page(card->device, address,
			       PAGE_SIZE, DMA_TO_DEVICE);
		__free_page(buffer->pages[j]);
	}
	kfree(buffer->pages);
 out:
	buffer->pages = NULL;

	return -ENOMEM;
}

int fw_iso_buffer_map(struct fw_iso_buffer *buffer, struct vm_area_struct *vma)
{
	unsigned long uaddr;
	int i, err;

	uaddr = vma->vm_start;
	for (i = 0; i < buffer->page_count; i++) {
		err = vm_insert_page(vma, uaddr, buffer->pages[i]);
		if (err)
			return err;

		uaddr += PAGE_SIZE;
	}

	return 0;
}

void fw_iso_buffer_destroy(struct fw_iso_buffer *buffer,
			   struct fw_card *card)
{
	int i;
	dma_addr_t address;

	for (i = 0; i < buffer->page_count; i++) {
		address = page_private(buffer->pages[i]);
		dma_unmap_page(card->device, address,
			       PAGE_SIZE, DMA_TO_DEVICE);
		__free_page(buffer->pages[i]);
	}

	kfree(buffer->pages);
	buffer->pages = NULL;
}

struct fw_iso_context *fw_iso_context_create(struct fw_card *card,
		int type, int channel, int speed, size_t header_size,
		fw_iso_callback_t callback, void *callback_data)
{
	struct fw_iso_context *ctx;

	ctx = card->driver->allocate_iso_context(card,
						 type, channel, header_size);
	if (IS_ERR(ctx))
		return ctx;

	ctx->card = card;
	ctx->type = type;
	ctx->channel = channel;
	ctx->speed = speed;
	ctx->header_size = header_size;
	ctx->callback = callback;
	ctx->callback_data = callback_data;

	return ctx;
}

void fw_iso_context_destroy(struct fw_iso_context *ctx)
{
	struct fw_card *card = ctx->card;

	card->driver->free_iso_context(ctx);
}

int fw_iso_context_start(struct fw_iso_context *ctx,
			 int cycle, int sync, int tags)
{
	return ctx->card->driver->start_iso(ctx, cycle, sync, tags);
}

int fw_iso_context_queue(struct fw_iso_context *ctx,
			 struct fw_iso_packet *packet,
			 struct fw_iso_buffer *buffer,
			 unsigned long payload)
{
	struct fw_card *card = ctx->card;

	return card->driver->queue_iso(ctx, packet, buffer, payload);
}

int fw_iso_context_stop(struct fw_iso_context *ctx)
{
	return ctx->card->driver->stop_iso(ctx);
}

/*
 * Isochronous bus resource management (channels, bandwidth), client side
 */

static int manage_bandwidth(struct fw_card *card, int irm_id, int generation,
			    int bandwidth, bool allocate)
{
	__be32 data[2];
	int try, new, old = allocate ? BANDWIDTH_AVAILABLE_INITIAL : 0;

	/*
	 * On a 1394a IRM with low contention, try < 1 is enough.
	 * On a 1394-1995 IRM, we need at least try < 2.
	 * Let's just do try < 5.
	 */
	for (try = 0; try < 5; try++) {
		new = allocate ? old - bandwidth : old + bandwidth;
		if (new < 0 || new > BANDWIDTH_AVAILABLE_INITIAL)
			break;

		data[0] = cpu_to_be32(old);
		data[1] = cpu_to_be32(new);
		switch (fw_run_transaction(card, TCODE_LOCK_COMPARE_SWAP,
				irm_id, generation, SCODE_100,
				CSR_REGISTER_BASE + CSR_BANDWIDTH_AVAILABLE,
				data, sizeof(data))) {
		case RCODE_GENERATION:
			/* A generation change frees all bandwidth. */
			return allocate ? -EAGAIN : bandwidth;

		case RCODE_COMPLETE:
			if (be32_to_cpup(data) == old)
				return bandwidth;

			old = be32_to_cpup(data);
			/* Fall through. */
		}
	}

	return -EIO;
}

static int manage_channel(struct fw_card *card, int irm_id, int generation,
			  u32 channels_mask, u64 offset, bool allocate)
{
	__be32 data[2], c, all, old;
	int i, retry = 5;

	old = all = allocate ? cpu_to_be32(~0) : 0;

	for (i = 0; i < 32; i++) {
		if (!(channels_mask & 1 << i))
			continue;

		c = cpu_to_be32(1 << (31 - i));
		if ((old & c) != (all & c))
			continue;

		data[0] = old;
		data[1] = old ^ c;
		switch (fw_run_transaction(card, TCODE_LOCK_COMPARE_SWAP,
					   irm_id, generation, SCODE_100,
					   offset, data, sizeof(data))) {
		case RCODE_GENERATION:
			/* A generation change frees all channels. */
			return allocate ? -EAGAIN : i;

		case RCODE_COMPLETE:
			if (data[0] == old)
				return i;

			old = data[0];

			/* Is the IRM 1394a-2000 compliant? */
			if ((data[0] & c) == (data[1] & c))
				continue;

			/* 1394-1995 IRM, fall through to retry. */
		default:
			if (retry--)
				i--;
		}
	}

	return -EIO;
}

static void deallocate_channel(struct fw_card *card, int irm_id,
			       int generation, int channel)
{
	u32 mask;
	u64 offset;

	mask = channel < 32 ? 1 << channel : 1 << (channel - 32);
	offset = channel < 32 ? CSR_REGISTER_BASE + CSR_CHANNELS_AVAILABLE_HI :
				CSR_REGISTER_BASE + CSR_CHANNELS_AVAILABLE_LO;

	manage_channel(card, irm_id, generation, mask, offset, false);
}

/**
 * fw_iso_resource_manage - Allocate or deallocate a channel and/or bandwidth
 *
 * In parameters: card, generation, channels_mask, bandwidth, allocate
 * Out parameters: channel, bandwidth
 * This function blocks (sleeps) during communication with the IRM.
 *
 * Allocates or deallocates at most one channel out of channels_mask.
 * channels_mask is a bitfield with MSB for channel 63 and LSB for channel 0.
 * (Note, the IRM's CHANNELS_AVAILABLE is a big-endian bitfield with MSB for
 * channel 0 and LSB for channel 63.)
 * Allocates or deallocates as many bandwidth allocation units as specified.
 *
 * Returns channel < 0 if no channel was allocated or deallocated.
 * Returns bandwidth = 0 if no bandwidth was allocated or deallocated.
 *
 * If generation is stale, deallocations succeed but allocations fail with
 * channel = -EAGAIN.
 *
 * If channel allocation fails, no bandwidth will be allocated either.
 * If bandwidth allocation fails, no channel will be allocated either.
 * But deallocations of channel and bandwidth are tried independently
 * of each other's success.
 */
void fw_iso_resource_manage(struct fw_card *card, int generation,
			    u64 channels_mask, int *channel, int *bandwidth,
			    bool allocate)
{
	u32 channels_hi = channels_mask;	/* channels 31...0 */
	u32 channels_lo = channels_mask >> 32;	/* channels 63...32 */
	int irm_id, ret, c = -EINVAL;

	spin_lock_irq(&card->lock);
	irm_id = card->irm_node->node_id;
	spin_unlock_irq(&card->lock);

	if (channels_hi)
		c = manage_channel(card, irm_id, generation, channels_hi,
		    CSR_REGISTER_BASE + CSR_CHANNELS_AVAILABLE_HI, allocate);
	if (channels_lo && c < 0) {
		c = manage_channel(card, irm_id, generation, channels_lo,
		    CSR_REGISTER_BASE + CSR_CHANNELS_AVAILABLE_LO, allocate);
		if (c >= 0)
			c += 32;
	}
	*channel = c;

	if (allocate && channels_mask != 0 && c < 0)
		*bandwidth = 0;

	if (*bandwidth == 0)
		return;

	ret = manage_bandwidth(card, irm_id, generation, *bandwidth, allocate);
	if (ret < 0)
		*bandwidth = 0;

	if (allocate && ret < 0 && c >= 0) {
		deallocate_channel(card, irm_id, generation, c);
		*channel = ret;
	}
}
Commit	Line	Data
c781c06d	1	/*
b1bda4cd JFSR	2	* Isochronous I/O functionality:
	3	* - Isochronous DMA context management
	4	* - Isochronous bus resource management (channels, bandwidth), client side
3038e353	5	*
3038e353 KH	6	* 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
3038e353	23	#include <linux/dma-mapping.h>
b1bda4cd	24	#include <linux/errno.h>
77c9a5da	25	#include <linux/firewire.h>
b1bda4cd JFSR	26	#include <linux/firewire-constants.h>
b1bda4cd JFSR	27	#include <linux/kernel.h>
3038e353	28	#include <linux/mm.h>
b1bda4cd JFSR	29	#include <linux/spinlock.h>
b1bda4cd JFSR	30	#include <linux/vmalloc.h>
3038e353	31
e8ca9702 SR	32	#include <asm/byteorder.h>
e8ca9702 SR	33
77c9a5da	34	#include "core.h"
b1bda4cd JFSR	35
	36	/*
	37	* Isochronous DMA context management
	38	*/
3038e353	39
53dca511 SR	40	int fw_iso_buffer_init(struct fw_iso_buffer buffer, struct fw_card card,
53dca511 SR	41	int page_count, enum dma_data_direction direction)
3038e353	42	{
2dbd7d7e	43	int i, j;
9aad8125 KH	44	dma_addr_t address;
	45
	46	buffer->page_count = page_count;
	47	buffer->direction = direction;
	48
	49	buffer->pages = kmalloc(page_count * sizeof(buffer->pages[0]),
	50	GFP_KERNEL);
	51	if (buffer->pages == NULL)
	52	goto out;
	53
	54	for (i = 0; i < buffer->page_count; i++) {
68be3fa1	55	buffer->pages[i] = alloc_page(GFP_KERNEL \| GFP_DMA32 \| __GFP_ZERO);
9aad8125 KH	56	if (buffer->pages[i] == NULL)
9aad8125 KH	57	goto out_pages;
373b2edd	58
9aad8125 KH	59	address = dma_map_page(card->device, buffer->pages[i],
9aad8125 KH	60	0, PAGE_SIZE, direction);
8d8bb39b	61	if (dma_mapping_error(card->device, address)) {
9aad8125 KH	62	__free_page(buffer->pages[i]);
	63	goto out_pages;
	64	}
	65	set_page_private(buffer->pages[i], address);
3038e353 KH	66	}
	67
	68	return 0;
82eff9db	69
9aad8125 KH	70	out_pages:
	71	for (j = 0; j < i; j++) {
	72	address = page_private(buffer->pages[j]);
	73	dma_unmap_page(card->device, address,
82eff9db	74	PAGE_SIZE, DMA_TO_DEVICE);
9aad8125 KH	75	__free_page(buffer->pages[j]);
	76	}
	77	kfree(buffer->pages);
	78	out:
	79	buffer->pages = NULL;
e1eff7a3	80
2dbd7d7e	81	return -ENOMEM;
9aad8125 KH	82	}
	83
	84	int fw_iso_buffer_map(struct fw_iso_buffer buffer, struct vm_area_struct vma)
	85	{
	86	unsigned long uaddr;
e1eff7a3	87	int i, err;
9aad8125 KH	88
	89	uaddr = vma->vm_start;
	90	for (i = 0; i < buffer->page_count; i++) {
e1eff7a3 SR	91	err = vm_insert_page(vma, uaddr, buffer->pages[i]);
	92	if (err)
	93	return err;
	94
9aad8125 KH	95	uaddr += PAGE_SIZE;
	96	}
	97
	98	return 0;
3038e353 KH	99	}
3038e353 KH	100
9aad8125 KH	101	void fw_iso_buffer_destroy(struct fw_iso_buffer *buffer,
9aad8125 KH	102	struct fw_card *card)
3038e353 KH	103	{
3038e353 KH	104	int i;
9aad8125	105	dma_addr_t address;
3038e353	106
9aad8125 KH	107	for (i = 0; i < buffer->page_count; i++) {
	108	address = page_private(buffer->pages[i]);
	109	dma_unmap_page(card->device, address,
3038e353	110	PAGE_SIZE, DMA_TO_DEVICE);
9aad8125 KH	111	__free_page(buffer->pages[i]);
9aad8125 KH	112	}
3038e353	113
9aad8125 KH	114	kfree(buffer->pages);
9aad8125 KH	115	buffer->pages = NULL;
3038e353 KH	116	}
3038e353 KH	117
53dca511 SR	118	struct fw_iso_context fw_iso_context_create(struct fw_card card,
	119	int type, int channel, int speed, size_t header_size,
	120	fw_iso_callback_t callback, void *callback_data)
3038e353 KH	121	{
3038e353 KH	122	struct fw_iso_context *ctx;
3038e353	123
4817ed24 SR	124	ctx = card->driver->allocate_iso_context(card,
4817ed24 SR	125	type, channel, header_size);
3038e353 KH	126	if (IS_ERR(ctx))
	127	return ctx;
	128
	129	ctx->card = card;
	130	ctx->type = type;
21efb3cf KH	131	ctx->channel = channel;
21efb3cf KH	132	ctx->speed = speed;
295e3feb	133	ctx->header_size = header_size;
3038e353 KH	134	ctx->callback = callback;
	135	ctx->callback_data = callback_data;
	136
3038e353 KH	137	return ctx;
3038e353 KH	138	}
3038e353 KH	139
	140	void fw_iso_context_destroy(struct fw_iso_context *ctx)
	141	{
	142	struct fw_card *card = ctx->card;
	143
3038e353 KH	144	card->driver->free_iso_context(ctx);
3038e353 KH	145	}
3038e353	146
53dca511 SR	147	int fw_iso_context_start(struct fw_iso_context *ctx,
53dca511 SR	148	int cycle, int sync, int tags)
3038e353	149	{
eb0306ea	150	return ctx->card->driver->start_iso(ctx, cycle, sync, tags);
3038e353	151	}
3038e353	152
53dca511 SR	153	int fw_iso_context_queue(struct fw_iso_context *ctx,
	154	struct fw_iso_packet *packet,
	155	struct fw_iso_buffer *buffer,
	156	unsigned long payload)
3038e353 KH	157	{
	158	struct fw_card *card = ctx->card;
	159
9aad8125	160	return card->driver->queue_iso(ctx, packet, buffer, payload);
3038e353	161	}
b8295668	162
53dca511	163	int fw_iso_context_stop(struct fw_iso_context *ctx)
b8295668 KH	164	{
	165	return ctx->card->driver->stop_iso(ctx);
	166	}
b1bda4cd JFSR	167
	168	/*
	169	* Isochronous bus resource management (channels, bandwidth), client side
	170	*/
	171
	172	static int manage_bandwidth(struct fw_card *card, int irm_id, int generation,
	173	int bandwidth, bool allocate)
	174	{
	175	__be32 data[2];
	176	int try, new, old = allocate ? BANDWIDTH_AVAILABLE_INITIAL : 0;
	177
	178	/*
	179	* On a 1394a IRM with low contention, try < 1 is enough.
	180	* On a 1394-1995 IRM, we need at least try < 2.
	181	* Let's just do try < 5.
	182	*/
	183	for (try = 0; try < 5; try++) {
	184	new = allocate ? old - bandwidth : old + bandwidth;
	185	if (new < 0 \|\| new > BANDWIDTH_AVAILABLE_INITIAL)
	186	break;
	187
	188	data[0] = cpu_to_be32(old);
	189	data[1] = cpu_to_be32(new);
	190	switch (fw_run_transaction(card, TCODE_LOCK_COMPARE_SWAP,
	191	irm_id, generation, SCODE_100,
	192	CSR_REGISTER_BASE + CSR_BANDWIDTH_AVAILABLE,
	193	data, sizeof(data))) {
	194	case RCODE_GENERATION:
	195	/* A generation change frees all bandwidth. */
	196	return allocate ? -EAGAIN : bandwidth;
	197
	198	case RCODE_COMPLETE:
	199	if (be32_to_cpup(data) == old)
	200	return bandwidth;
	201
	202	old = be32_to_cpup(data);
	203	/* Fall through. */
	204	}
	205	}
	206
	207	return -EIO;
	208	}
	209
	210	static int manage_channel(struct fw_card *card, int irm_id, int generation,
5d9cb7d2	211	u32 channels_mask, u64 offset, bool allocate)
b1bda4cd	212	{
5d9cb7d2	213	__be32 data[2], c, all, old;
b1bda4cd JFSR	214	int i, retry = 5;
b1bda4cd JFSR	215
5d9cb7d2 SR	216	old = all = allocate ? cpu_to_be32(~0) : 0;
5d9cb7d2 SR	217
b1bda4cd	218	for (i = 0; i < 32; i++) {
5d9cb7d2	219	if (!(channels_mask & 1 << i))
b1bda4cd JFSR	220	continue;
b1bda4cd JFSR	221
5d9cb7d2 SR	222	c = cpu_to_be32(1 << (31 - i));
5d9cb7d2 SR	223	if ((old & c) != (all & c))
b1bda4cd JFSR	224	continue;
	225
	226	data[0] = old;
	227	data[1] = old ^ c;
	228	switch (fw_run_transaction(card, TCODE_LOCK_COMPARE_SWAP,
	229	irm_id, generation, SCODE_100,
	230	offset, data, sizeof(data))) {
	231	case RCODE_GENERATION:
	232	/* A generation change frees all channels. */
	233	return allocate ? -EAGAIN : i;
	234
	235	case RCODE_COMPLETE:
	236	if (data[0] == old)
	237	return i;
	238
	239	old = data[0];
	240
	241	/* Is the IRM 1394a-2000 compliant? */
5d9cb7d2	242	if ((data[0] & c) == (data[1] & c))
b1bda4cd JFSR	243	continue;
	244
	245	/* 1394-1995 IRM, fall through to retry. */
	246	default:
	247	if (retry--)
	248	i--;
	249	}
	250	}
	251
	252	return -EIO;
	253	}
	254
	255	static void deallocate_channel(struct fw_card *card, int irm_id,
	256	int generation, int channel)
	257	{
5d9cb7d2	258	u32 mask;
b1bda4cd JFSR	259	u64 offset;
b1bda4cd JFSR	260
5d9cb7d2	261	mask = channel < 32 ? 1 << channel : 1 << (channel - 32);
b1bda4cd JFSR	262	offset = channel < 32 ? CSR_REGISTER_BASE + CSR_CHANNELS_AVAILABLE_HI :
	263	CSR_REGISTER_BASE + CSR_CHANNELS_AVAILABLE_LO;
	264
	265	manage_channel(card, irm_id, generation, mask, offset, false);
	266	}
	267
	268	/**
	269	* fw_iso_resource_manage - Allocate or deallocate a channel and/or bandwidth
	270	*
	271	* In parameters: card, generation, channels_mask, bandwidth, allocate
	272	* Out parameters: channel, bandwidth
	273	* This function blocks (sleeps) during communication with the IRM.
5d9cb7d2	274	*
b1bda4cd	275	* Allocates or deallocates at most one channel out of channels_mask.
5d9cb7d2 SR	276	* channels_mask is a bitfield with MSB for channel 63 and LSB for channel 0.
	277	* (Note, the IRM's CHANNELS_AVAILABLE is a big-endian bitfield with MSB for
	278	* channel 0 and LSB for channel 63.)
	279	* Allocates or deallocates as many bandwidth allocation units as specified.
b1bda4cd JFSR	280	*
	281	* Returns channel < 0 if no channel was allocated or deallocated.
	282	* Returns bandwidth = 0 if no bandwidth was allocated or deallocated.
	283	*
	284	* If generation is stale, deallocations succeed but allocations fail with
	285	* channel = -EAGAIN.
	286	*
5d9cb7d2	287	* If channel allocation fails, no bandwidth will be allocated either.
b1bda4cd	288	* If bandwidth allocation fails, no channel will be allocated either.
5d9cb7d2 SR	289	* But deallocations of channel and bandwidth are tried independently
5d9cb7d2 SR	290	* of each other's success.
b1bda4cd JFSR	291	*/
	292	void fw_iso_resource_manage(struct fw_card *card, int generation,
	293	u64 channels_mask, int channel, int bandwidth,
	294	bool allocate)
	295	{
5d9cb7d2 SR	296	u32 channels_hi = channels_mask; /* channels 31...0 */
5d9cb7d2 SR	297	u32 channels_lo = channels_mask >> 32; /* channels 63...32 */
b1bda4cd JFSR	298	int irm_id, ret, c = -EINVAL;
	299
	300	spin_lock_irq(&card->lock);
	301	irm_id = card->irm_node->node_id;
	302	spin_unlock_irq(&card->lock);
	303
	304	if (channels_hi)
	305	c = manage_channel(card, irm_id, generation, channels_hi,
	306	CSR_REGISTER_BASE + CSR_CHANNELS_AVAILABLE_HI, allocate);
	307	if (channels_lo && c < 0) {
	308	c = manage_channel(card, irm_id, generation, channels_lo,
	309	CSR_REGISTER_BASE + CSR_CHANNELS_AVAILABLE_LO, allocate);
	310	if (c >= 0)
	311	c += 32;
	312	}
	313	*channel = c;
	314
5d9cb7d2	315	if (allocate && channels_mask != 0 && c < 0)
b1bda4cd JFSR	316	*bandwidth = 0;
	317
	318	if (*bandwidth == 0)
	319	return;
	320
	321	ret = manage_bandwidth(card, irm_id, generation, *bandwidth, allocate);
	322	if (ret < 0)
	323	*bandwidth = 0;
	324
5d9cb7d2	325	if (allocate && ret < 0 && c >= 0) {
b1bda4cd JFSR	326	deallocate_channel(card, irm_id, generation, c);
	327	*channel = ret;
	328	}
	329	}