core-transaction.c 28.8 KB
Newer Older
1 2
/*
 * Core IEEE1394 transaction logic
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
 *
 * Copyright (C) 2004-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.
 */

S
Stefan Richter 已提交
21
#include <linux/bug.h>
22
#include <linux/completion.h>
S
Stefan Richter 已提交
23 24
#include <linux/device.h>
#include <linux/errno.h>
25
#include <linux/firewire.h>
S
Stefan Richter 已提交
26 27 28
#include <linux/firewire-constants.h>
#include <linux/fs.h>
#include <linux/init.h>
29
#include <linux/idr.h>
S
Stefan Richter 已提交
30
#include <linux/jiffies.h>
31 32
#include <linux/kernel.h>
#include <linux/list.h>
S
Stefan Richter 已提交
33 34 35 36 37 38 39 40
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/spinlock.h>
#include <linux/string.h>
#include <linux/timer.h>
#include <linux/types.h>

#include <asm/byteorder.h>
41

42
#include "core.h"
43

44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
#define HEADER_PRI(pri)			((pri) << 0)
#define HEADER_TCODE(tcode)		((tcode) << 4)
#define HEADER_RETRY(retry)		((retry) << 8)
#define HEADER_TLABEL(tlabel)		((tlabel) << 10)
#define HEADER_DESTINATION(destination)	((destination) << 16)
#define HEADER_SOURCE(source)		((source) << 16)
#define HEADER_RCODE(rcode)		((rcode) << 12)
#define HEADER_OFFSET_HIGH(offset_high)	((offset_high) << 0)
#define HEADER_DATA_LENGTH(length)	((length) << 16)
#define HEADER_EXTENDED_TCODE(tcode)	((tcode) << 0)

#define HEADER_GET_TCODE(q)		(((q) >> 4) & 0x0f)
#define HEADER_GET_TLABEL(q)		(((q) >> 10) & 0x3f)
#define HEADER_GET_RCODE(q)		(((q) >> 12) & 0x0f)
#define HEADER_GET_DESTINATION(q)	(((q) >> 16) & 0xffff)
#define HEADER_GET_SOURCE(q)		(((q) >> 16) & 0xffff)
#define HEADER_GET_OFFSET_HIGH(q)	(((q) >> 0) & 0xffff)
#define HEADER_GET_DATA_LENGTH(q)	(((q) >> 16) & 0xffff)
#define HEADER_GET_EXTENDED_TCODE(q)	(((q) >> 0) & 0xffff)

64 65 66
#define HEADER_DESTINATION_IS_BROADCAST(q) \
	(((q) & HEADER_DESTINATION(0x3f)) == HEADER_DESTINATION(0x3f))

67 68 69 70
#define PHY_PACKET_CONFIG	0x0
#define PHY_PACKET_LINK_ON	0x1
#define PHY_PACKET_SELF_ID	0x2

71 72 73
#define PHY_CONFIG_GAP_COUNT(gap_count)	(((gap_count) << 16) | (1 << 22))
#define PHY_CONFIG_ROOT_ID(node_id)	((((node_id) & 0x3f) << 24) | (1 << 23))
#define PHY_IDENTIFIER(id)		((id) << 30)
74

75
static int close_transaction(struct fw_transaction *transaction,
76
			     struct fw_card *card, int rcode)
77
{
78
	struct fw_transaction *t;
79 80 81
	unsigned long flags;

	spin_lock_irqsave(&card->lock, flags);
82 83 84
	list_for_each_entry(t, &card->transaction_list, link) {
		if (t == transaction) {
			list_del(&t->link);
85
			card->tlabel_mask &= ~(1ULL << t->tlabel);
86 87 88
			break;
		}
	}
89 90
	spin_unlock_irqrestore(&card->lock, flags);

91
	if (&t->link != &card->transaction_list) {
92
		t->callback(card, rcode, NULL, 0, t->callback_data);
93 94 95 96
		return 0;
	}

	return -ENOENT;
97 98
}

99 100 101 102
/*
 * Only valid for transactions that are potentially pending (ie have
 * been sent).
 */
103 104
int fw_cancel_transaction(struct fw_card *card,
			  struct fw_transaction *transaction)
105
{
106 107
	/*
	 * Cancel the packet transmission if it's still queued.  That
108
	 * will call the packet transmission callback which cancels
109 110
	 * the transaction.
	 */
111 112 113 114

	if (card->driver->cancel_packet(card, &transaction->packet) == 0)
		return 0;

115 116 117 118
	/*
	 * If the request packet has already been sent, we need to see
	 * if the transaction is still pending and remove it in that case.
	 */
119

120
	return close_transaction(transaction, card, RCODE_CANCELLED);
121 122 123
}
EXPORT_SYMBOL(fw_cancel_transaction);

124 125
static void transmit_complete_callback(struct fw_packet *packet,
				       struct fw_card *card, int status)
126 127 128 129 130 131
{
	struct fw_transaction *t =
	    container_of(packet, struct fw_transaction, packet);

	switch (status) {
	case ACK_COMPLETE:
132
		close_transaction(t, card, RCODE_COMPLETE);
133 134 135 136 137 138 139
		break;
	case ACK_PENDING:
		t->timestamp = packet->timestamp;
		break;
	case ACK_BUSY_X:
	case ACK_BUSY_A:
	case ACK_BUSY_B:
140
		close_transaction(t, card, RCODE_BUSY);
141 142
		break;
	case ACK_DATA_ERROR:
143
		close_transaction(t, card, RCODE_DATA_ERROR);
144
		break;
145
	case ACK_TYPE_ERROR:
146
		close_transaction(t, card, RCODE_TYPE_ERROR);
147 148
		break;
	default:
149 150 151 152
		/*
		 * In this case the ack is really a juju specific
		 * rcode, so just forward that to the callback.
		 */
153
		close_transaction(t, card, status);
154 155 156 157
		break;
	}
}

158
static void fw_fill_request(struct fw_packet *packet, int tcode, int tlabel,
159
		int destination_id, int source_id, int generation, int speed,
160
		unsigned long long offset, void *payload, size_t length)
161 162 163
{
	int ext_tcode;

164 165 166 167 168 169 170 171 172 173 174 175
	if (tcode == TCODE_STREAM_DATA) {
		packet->header[0] =
			HEADER_DATA_LENGTH(length) |
			destination_id |
			HEADER_TCODE(TCODE_STREAM_DATA);
		packet->header_length = 4;
		packet->payload = payload;
		packet->payload_length = length;

		goto common;
	}

176
	if (tcode > 0x10) {
177
		ext_tcode = tcode & ~0x10;
178 179 180 181 182
		tcode = TCODE_LOCK_REQUEST;
	} else
		ext_tcode = 0;

	packet->header[0] =
183 184 185
		HEADER_RETRY(RETRY_X) |
		HEADER_TLABEL(tlabel) |
		HEADER_TCODE(tcode) |
186
		HEADER_DESTINATION(destination_id);
187
	packet->header[1] =
188
		HEADER_OFFSET_HIGH(offset >> 32) | HEADER_SOURCE(source_id);
189 190 191 192 193 194 195 196 197 198 199 200 201
	packet->header[2] =
		offset;

	switch (tcode) {
	case TCODE_WRITE_QUADLET_REQUEST:
		packet->header[3] = *(u32 *)payload;
		packet->header_length = 16;
		packet->payload_length = 0;
		break;

	case TCODE_LOCK_REQUEST:
	case TCODE_WRITE_BLOCK_REQUEST:
		packet->header[3] =
202 203
			HEADER_DATA_LENGTH(length) |
			HEADER_EXTENDED_TCODE(ext_tcode);
204 205 206 207 208 209 210 211 212 213 214 215
		packet->header_length = 16;
		packet->payload = payload;
		packet->payload_length = length;
		break;

	case TCODE_READ_QUADLET_REQUEST:
		packet->header_length = 12;
		packet->payload_length = 0;
		break;

	case TCODE_READ_BLOCK_REQUEST:
		packet->header[3] =
216 217
			HEADER_DATA_LENGTH(length) |
			HEADER_EXTENDED_TCODE(ext_tcode);
218 219 220
		packet->header_length = 16;
		packet->payload_length = 0;
		break;
221 222 223

	default:
		WARN(1, KERN_ERR "wrong tcode %d", tcode);
224
	}
225
 common:
226 227
	packet->speed = speed;
	packet->generation = generation;
228
	packet->ack = 0;
229
	packet->payload_mapped = false;
230 231
}

232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
static int allocate_tlabel(struct fw_card *card)
{
	int tlabel;

	tlabel = card->current_tlabel;
	while (card->tlabel_mask & (1ULL << tlabel)) {
		tlabel = (tlabel + 1) & 0x3f;
		if (tlabel == card->current_tlabel)
			return -EBUSY;
	}

	card->current_tlabel = (tlabel + 1) & 0x3f;
	card->tlabel_mask |= 1ULL << tlabel;

	return tlabel;
}

249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
/**
 * This function provides low-level access to the IEEE1394 transaction
 * logic.  Most C programs would use either fw_read(), fw_write() or
 * fw_lock() instead - those function are convenience wrappers for
 * this function.  The fw_send_request() function is primarily
 * provided as a flexible, one-stop entry point for languages bindings
 * and protocol bindings.
 *
 * FIXME: Document this function further, in particular the possible
 * values for rcode in the callback.  In short, we map ACK_COMPLETE to
 * RCODE_COMPLETE, internal errors set errno and set rcode to
 * RCODE_SEND_ERROR (which is out of range for standard ieee1394
 * rcodes).  All other rcodes are forwarded unchanged.  For all
 * errors, payload is NULL, length is 0.
 *
 * Can not expect the callback to be called before the function
 * returns, though this does happen in some cases (ACK_COMPLETE and
 * errors).
 *
 * The payload is only used for write requests and must not be freed
 * until the callback has been called.
 *
 * @param card the card from which to send the request
 * @param tcode the tcode for this transaction.  Do not use
U
Uwe Kleine-König 已提交
273
 *   TCODE_LOCK_REQUEST directly, instead use TCODE_LOCK_MASK_SWAP
274
 *   etc. to specify tcode and ext_tcode.
275
 * @param node_id the destination node ID (bus ID and PHY ID concatenated)
276 277 278 279 280 281 282 283
 * @param generation the generation for which node_id is valid
 * @param speed the speed to use for sending the request
 * @param offset the 48 bit offset on the destination node
 * @param payload the data payload for the request subaction
 * @param length the length in bytes of the data to read
 * @param callback function to be called when the transaction is completed
 * @param callback_data pointer to arbitrary data, which will be
 *   passed to the callback
284 285 286
 *
 * In case of asynchronous stream packets i.e. TCODE_STREAM_DATA, the caller
 * needs to synthesize @destination_id with fw_stream_packet_destination_id().
287
 */
288 289 290 291
void fw_send_request(struct fw_card *card, struct fw_transaction *t, int tcode,
		     int destination_id, int generation, int speed,
		     unsigned long long offset, void *payload, size_t length,
		     fw_transaction_callback_t callback, void *callback_data)
292 293
{
	unsigned long flags;
294
	int tlabel;
295

296 297 298 299
	/*
	 * Bump the flush timer up 100ms first of all so we
	 * don't race with a flush timer callback.
	 */
300 301 302

	mod_timer(&card->flush_timer, jiffies + DIV_ROUND_UP(HZ, 10));

303 304 305 306
	/*
	 * Allocate tlabel from the bitmap and put the transaction on
	 * the list while holding the card spinlock.
	 */
307 308 309

	spin_lock_irqsave(&card->lock, flags);

310 311
	tlabel = allocate_tlabel(card);
	if (tlabel < 0) {
312 313 314 315 316
		spin_unlock_irqrestore(&card->lock, flags);
		callback(card, RCODE_SEND_ERROR, NULL, 0, callback_data);
		return;
	}

J
Jay Fenlason 已提交
317
	t->node_id = destination_id;
318 319 320 321
	t->tlabel = tlabel;
	t->callback = callback;
	t->callback_data = callback_data;

J
Jay Fenlason 已提交
322 323 324
	fw_fill_request(&t->packet, tcode, t->tlabel,
			destination_id, card->node_id, generation,
			speed, offset, payload, length);
325 326
	t->packet.callback = transmit_complete_callback;

327 328 329 330
	list_add_tail(&t->link, &card->transaction_list);

	spin_unlock_irqrestore(&card->lock, flags);

331 332 333 334
	card->driver->send_request(card, &t->packet);
}
EXPORT_SYMBOL(fw_send_request);

J
Jay Fenlason 已提交
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
struct transaction_callback_data {
	struct completion done;
	void *payload;
	int rcode;
};

static void transaction_callback(struct fw_card *card, int rcode,
				 void *payload, size_t length, void *data)
{
	struct transaction_callback_data *d = data;

	if (rcode == RCODE_COMPLETE)
		memcpy(d->payload, payload, length);
	d->rcode = rcode;
	complete(&d->done);
}

/**
 * fw_run_transaction - send request and sleep until transaction is completed
 *
 * Returns the RCODE.
 */
int fw_run_transaction(struct fw_card *card, int tcode, int destination_id,
358
		       int generation, int speed, unsigned long long offset,
359
		       void *payload, size_t length)
J
Jay Fenlason 已提交
360 361 362 363 364
{
	struct transaction_callback_data d;
	struct fw_transaction t;

	init_completion(&d.done);
365
	d.payload = payload;
J
Jay Fenlason 已提交
366
	fw_send_request(card, &t, tcode, destination_id, generation, speed,
367
			offset, payload, length, transaction_callback, &d);
J
Jay Fenlason 已提交
368 369 370 371 372 373
	wait_for_completion(&d.done);

	return d.rcode;
}
EXPORT_SYMBOL(fw_run_transaction);

374 375
static DEFINE_MUTEX(phy_config_mutex);
static DECLARE_COMPLETION(phy_config_done);
376 377 378

static void transmit_phy_packet_callback(struct fw_packet *packet,
					 struct fw_card *card, int status)
379
{
380
	complete(&phy_config_done);
381 382
}

383 384 385 386 387 388 389
static struct fw_packet phy_config_packet = {
	.header_length	= 8,
	.payload_length	= 0,
	.speed		= SCODE_100,
	.callback	= transmit_phy_packet_callback,
};

390 391
void fw_send_phy_config(struct fw_card *card,
			int node_id, int generation, int gap_count)
392
{
393
	long timeout = DIV_ROUND_UP(HZ, 10);
394 395 396 397
	u32 data = PHY_IDENTIFIER(PHY_PACKET_CONFIG) |
		   PHY_CONFIG_ROOT_ID(node_id) |
		   PHY_CONFIG_GAP_COUNT(gap_count);

398 399 400 401 402 403 404 405 406
	mutex_lock(&phy_config_mutex);

	phy_config_packet.header[0] = data;
	phy_config_packet.header[1] = ~data;
	phy_config_packet.generation = generation;
	INIT_COMPLETION(phy_config_done);

	card->driver->send_request(card, &phy_config_packet);
	wait_for_completion_timeout(&phy_config_done, timeout);
407

408
	mutex_unlock(&phy_config_mutex);
409 410 411 412 413 414 415 416 417 418 419 420 421 422
}

void fw_flush_transactions(struct fw_card *card)
{
	struct fw_transaction *t, *next;
	struct list_head list;
	unsigned long flags;

	INIT_LIST_HEAD(&list);
	spin_lock_irqsave(&card->lock, flags);
	list_splice_init(&card->transaction_list, &list);
	card->tlabel_mask = 0;
	spin_unlock_irqrestore(&card->lock, flags);

423 424 425
	list_for_each_entry_safe(t, next, &list, link) {
		card->driver->cancel_packet(card, &t->packet);

426 427
		/*
		 * At this point cancel_packet will never call the
428
		 * transaction callback, since we just took all the
429 430
		 * transactions out of the list.  So do it here.
		 */
431
		t->callback(card, RCODE_CANCELLED, NULL, 0, t->callback_data);
432
	}
433 434
}

435 436
static struct fw_address_handler *lookup_overlapping_address_handler(
	struct list_head *list, unsigned long long offset, size_t length)
437 438 439 440 441 442 443 444 445 446 447 448
{
	struct fw_address_handler *handler;

	list_for_each_entry(handler, list, link) {
		if (handler->offset < offset + length &&
		    offset < handler->offset + handler->length)
			return handler;
	}

	return NULL;
}

449 450 451 452 453 454 455
static bool is_enclosing_handler(struct fw_address_handler *handler,
				 unsigned long long offset, size_t length)
{
	return handler->offset <= offset &&
		offset + length <= handler->offset + handler->length;
}

456 457
static struct fw_address_handler *lookup_enclosing_address_handler(
	struct list_head *list, unsigned long long offset, size_t length)
458 459 460 461
{
	struct fw_address_handler *handler;

	list_for_each_entry(handler, list, link) {
462
		if (is_enclosing_handler(handler, offset, length))
463 464 465 466 467 468 469 470 471
			return handler;
	}

	return NULL;
}

static DEFINE_SPINLOCK(address_handler_lock);
static LIST_HEAD(address_handler_list);

472
const struct fw_address_region fw_high_memory_region =
473
	{ .start = 0x000100000000ULL, .end = 0xffffe0000000ULL,  };
A
Adrian Bunk 已提交
474 475 476 477 478
EXPORT_SYMBOL(fw_high_memory_region);

#if 0
const struct fw_address_region fw_low_memory_region =
	{ .start = 0x000000000000ULL, .end = 0x000100000000ULL,  };
479
const struct fw_address_region fw_private_region =
480
	{ .start = 0xffffe0000000ULL, .end = 0xfffff0000000ULL,  };
481
const struct fw_address_region fw_csr_region =
482 483
	{ .start = CSR_REGISTER_BASE,
	  .end   = CSR_REGISTER_BASE | CSR_CONFIG_ROM_END,  };
484
const struct fw_address_region fw_unit_space_region =
485
	{ .start = 0xfffff0000900ULL, .end = 0x1000000000000ULL, };
A
Adrian Bunk 已提交
486
#endif  /*  0  */
487

488 489 490 491 492 493
static bool is_in_fcp_region(u64 offset, size_t length)
{
	return offset >= (CSR_REGISTER_BASE | CSR_FCP_COMMAND) &&
		offset + length <= (CSR_REGISTER_BASE | CSR_FCP_END);
}

494
/**
495 496 497 498 499 500 501 502 503
 * fw_core_add_address_handler - register for incoming requests
 * @handler: callback
 * @region: region in the IEEE 1212 node space address range
 *
 * region->start, ->end, and handler->length have to be quadlet-aligned.
 *
 * When a request is received that falls within the specified address range,
 * the specified callback is invoked.  The parameters passed to the callback
 * give the details of the particular request.
504 505
 *
 * Return value:  0 on success, non-zero otherwise.
506
 *
507 508
 * The start offset of the handler's address region is determined by
 * fw_core_add_address_handler() and is returned in handler->offset.
509 510
 *
 * Address allocations are exclusive, except for the FCP registers.
511
 */
512 513
int fw_core_add_address_handler(struct fw_address_handler *handler,
				const struct fw_address_region *region)
514 515 516 517 518
{
	struct fw_address_handler *other;
	unsigned long flags;
	int ret = -EBUSY;

519 520 521 522 523 524 525
	if (region->start & 0xffff000000000003ULL ||
	    region->end   & 0xffff000000000003ULL ||
	    region->start >= region->end ||
	    handler->length & 3 ||
	    handler->length == 0)
		return -EINVAL;

526 527
	spin_lock_irqsave(&address_handler_lock, flags);

528
	handler->offset = region->start;
529
	while (handler->offset + handler->length <= region->end) {
530 531 532 533 534 535
		if (is_in_fcp_region(handler->offset, handler->length))
			other = NULL;
		else
			other = lookup_overlapping_address_handler
					(&address_handler_list,
					 handler->offset, handler->length);
536
		if (other != NULL) {
537
			handler->offset += other->length;
538 539 540 541 542 543 544 545 546 547 548 549 550 551
		} else {
			list_add_tail(&handler->link, &address_handler_list);
			ret = 0;
			break;
		}
	}

	spin_unlock_irqrestore(&address_handler_lock, flags);

	return ret;
}
EXPORT_SYMBOL(fw_core_add_address_handler);

/**
552
 * fw_core_remove_address_handler - unregister an address handler
553 554 555 556 557 558 559 560 561 562 563 564 565
 */
void fw_core_remove_address_handler(struct fw_address_handler *handler)
{
	unsigned long flags;

	spin_lock_irqsave(&address_handler_lock, flags);
	list_del(&handler->link);
	spin_unlock_irqrestore(&address_handler_lock, flags);
}
EXPORT_SYMBOL(fw_core_remove_address_handler);

struct fw_request {
	struct fw_packet response;
566
	u32 request_header[4];
567 568 569 570 571
	int ack;
	u32 length;
	u32 data[0];
};

572 573
static void free_response_callback(struct fw_packet *packet,
				   struct fw_card *card, int status)
574 575 576 577 578 579 580
{
	struct fw_request *request;

	request = container_of(packet, struct fw_request, response);
	kfree(request);
}

581 582
void fw_fill_response(struct fw_packet *response, u32 *request_header,
		      int rcode, void *payload, size_t length)
583 584 585
{
	int tcode, tlabel, extended_tcode, source, destination;

586 587 588 589 590
	tcode          = HEADER_GET_TCODE(request_header[0]);
	tlabel         = HEADER_GET_TLABEL(request_header[0]);
	source         = HEADER_GET_DESTINATION(request_header[0]);
	destination    = HEADER_GET_SOURCE(request_header[1]);
	extended_tcode = HEADER_GET_EXTENDED_TCODE(request_header[3]);
591 592

	response->header[0] =
593 594 595
		HEADER_RETRY(RETRY_1) |
		HEADER_TLABEL(tlabel) |
		HEADER_DESTINATION(destination);
596
	response->header[1] =
597 598
		HEADER_SOURCE(source) |
		HEADER_RCODE(rcode);
599 600 601 602 603
	response->header[2] = 0;

	switch (tcode) {
	case TCODE_WRITE_QUADLET_REQUEST:
	case TCODE_WRITE_BLOCK_REQUEST:
604
		response->header[0] |= HEADER_TCODE(TCODE_WRITE_RESPONSE);
605 606 607 608 609 610
		response->header_length = 12;
		response->payload_length = 0;
		break;

	case TCODE_READ_QUADLET_REQUEST:
		response->header[0] |=
611
			HEADER_TCODE(TCODE_READ_QUADLET_RESPONSE);
612 613 614 615
		if (payload != NULL)
			response->header[3] = *(u32 *)payload;
		else
			response->header[3] = 0;
616 617 618 619 620 621
		response->header_length = 16;
		response->payload_length = 0;
		break;

	case TCODE_READ_BLOCK_REQUEST:
	case TCODE_LOCK_REQUEST:
622
		response->header[0] |= HEADER_TCODE(tcode + 2);
623
		response->header[3] =
624 625
			HEADER_DATA_LENGTH(length) |
			HEADER_EXTENDED_TCODE(extended_tcode);
626
		response->header_length = 16;
627 628
		response->payload = payload;
		response->payload_length = length;
629 630 631
		break;

	default:
632
		WARN(1, KERN_ERR "wrong tcode %d", tcode);
633
	}
634

635
	response->payload_mapped = false;
636
}
637
EXPORT_SYMBOL(fw_fill_response);
638

639
static struct fw_request *allocate_request(struct fw_packet *p)
640 641 642
{
	struct fw_request *request;
	u32 *data, length;
643
	int request_tcode, t;
644

645
	request_tcode = HEADER_GET_TCODE(p->header[0]);
646 647
	switch (request_tcode) {
	case TCODE_WRITE_QUADLET_REQUEST:
648
		data = &p->header[3];
649 650 651 652 653
		length = 4;
		break;

	case TCODE_WRITE_BLOCK_REQUEST:
	case TCODE_LOCK_REQUEST:
654
		data = p->payload;
655
		length = HEADER_GET_DATA_LENGTH(p->header[3]);
656 657 658 659 660 661 662 663 664
		break;

	case TCODE_READ_QUADLET_REQUEST:
		data = NULL;
		length = 4;
		break;

	case TCODE_READ_BLOCK_REQUEST:
		data = NULL;
665
		length = HEADER_GET_DATA_LENGTH(p->header[3]);
666 667 668
		break;

	default:
669 670
		fw_error("ERROR - corrupt request received - %08x %08x %08x\n",
			 p->header[0], p->header[1], p->header[2]);
671 672 673
		return NULL;
	}

674
	request = kmalloc(sizeof(*request) + length, GFP_ATOMIC);
675 676 677
	if (request == NULL)
		return NULL;

678 679 680 681 682 683 684 685 686
	t = (p->timestamp & 0x1fff) + 4000;
	if (t >= 8000)
		t = (p->timestamp & ~0x1fff) + 0x2000 + t - 8000;
	else
		t = (p->timestamp & ~0x1fff) + t;

	request->response.speed = p->speed;
	request->response.timestamp = t;
	request->response.generation = p->generation;
687
	request->response.ack = 0;
688
	request->response.callback = free_response_callback;
689
	request->ack = p->ack;
690
	request->length = length;
691
	if (data)
692
		memcpy(request->data, data, length);
693

694
	memcpy(request->request_header, p->header, sizeof(p->header));
695 696 697 698

	return request;
}

699 700
void fw_send_response(struct fw_card *card,
		      struct fw_request *request, int rcode)
701
{
702 703 704
	if (WARN_ONCE(!request, "invalid for FCP address handlers"))
		return;

705 706 707
	/* unified transaction or broadcast transaction: don't respond */
	if (request->ack != ACK_PENDING ||
	    HEADER_DESTINATION_IS_BROADCAST(request->request_header[0])) {
708
		kfree(request);
709
		return;
710
	}
711

712 713 714 715 716 717
	if (rcode == RCODE_COMPLETE)
		fw_fill_response(&request->response, request->request_header,
				 rcode, request->data, request->length);
	else
		fw_fill_response(&request->response, request->request_header,
				 rcode, NULL, 0);
718 719 720 721 722

	card->driver->send_response(card, &request->response);
}
EXPORT_SYMBOL(fw_send_response);

723 724 725 726
static void handle_exclusive_region_request(struct fw_card *card,
					    struct fw_packet *p,
					    struct fw_request *request,
					    unsigned long long offset)
727 728 729
{
	struct fw_address_handler *handler;
	unsigned long flags;
730
	int tcode, destination, source;
731

732 733
	tcode       = HEADER_GET_TCODE(p->header[0]);
	destination = HEADER_GET_DESTINATION(p->header[0]);
734
	source      = HEADER_GET_SOURCE(p->header[1]);
735 736 737 738 739 740

	spin_lock_irqsave(&address_handler_lock, flags);
	handler = lookup_enclosing_address_handler(&address_handler_list,
						   offset, request->length);
	spin_unlock_irqrestore(&address_handler_lock, flags);

741 742
	/*
	 * FIXME: lookup the fw_node corresponding to the sender of
743 744 745
	 * this request and pass that to the address handler instead
	 * of the node ID.  We may also want to move the address
	 * allocations to fw_node so we only do this callback if the
746 747
	 * upper layers registered it for this node.
	 */
748 749 750 751 752 753

	if (handler == NULL)
		fw_send_response(card, request, RCODE_ADDRESS_ERROR);
	else
		handler->address_callback(card, request,
					  tcode, destination, source,
754
					  p->generation, p->speed, offset,
755 756 757
					  request->data, request->length,
					  handler->callback_data);
}
758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824

static void handle_fcp_region_request(struct fw_card *card,
				      struct fw_packet *p,
				      struct fw_request *request,
				      unsigned long long offset)
{
	struct fw_address_handler *handler;
	unsigned long flags;
	int tcode, destination, source;

	if ((offset != (CSR_REGISTER_BASE | CSR_FCP_COMMAND) &&
	     offset != (CSR_REGISTER_BASE | CSR_FCP_RESPONSE)) ||
	    request->length > 0x200) {
		fw_send_response(card, request, RCODE_ADDRESS_ERROR);

		return;
	}

	tcode       = HEADER_GET_TCODE(p->header[0]);
	destination = HEADER_GET_DESTINATION(p->header[0]);
	source      = HEADER_GET_SOURCE(p->header[1]);

	if (tcode != TCODE_WRITE_QUADLET_REQUEST &&
	    tcode != TCODE_WRITE_BLOCK_REQUEST) {
		fw_send_response(card, request, RCODE_TYPE_ERROR);

		return;
	}

	spin_lock_irqsave(&address_handler_lock, flags);
	list_for_each_entry(handler, &address_handler_list, link) {
		if (is_enclosing_handler(handler, offset, request->length))
			handler->address_callback(card, NULL, tcode,
						  destination, source,
						  p->generation, p->speed,
						  offset, request->data,
						  request->length,
						  handler->callback_data);
	}
	spin_unlock_irqrestore(&address_handler_lock, flags);

	fw_send_response(card, request, RCODE_COMPLETE);
}

void fw_core_handle_request(struct fw_card *card, struct fw_packet *p)
{
	struct fw_request *request;
	unsigned long long offset;

	if (p->ack != ACK_PENDING && p->ack != ACK_COMPLETE)
		return;

	request = allocate_request(p);
	if (request == NULL) {
		/* FIXME: send statically allocated busy packet. */
		return;
	}

	offset = ((u64)HEADER_GET_OFFSET_HIGH(p->header[1]) << 32) |
		p->header[2];

	if (!is_in_fcp_region(offset, request->length))
		handle_exclusive_region_request(card, p, request, offset);
	else
		handle_fcp_region_request(card, p, request, offset);

}
825 826
EXPORT_SYMBOL(fw_core_handle_request);

827
void fw_core_handle_response(struct fw_card *card, struct fw_packet *p)
828 829 830 831 832 833 834
{
	struct fw_transaction *t;
	unsigned long flags;
	u32 *data;
	size_t data_length;
	int tcode, tlabel, destination, source, rcode;

835 836 837 838 839
	tcode       = HEADER_GET_TCODE(p->header[0]);
	tlabel      = HEADER_GET_TLABEL(p->header[0]);
	destination = HEADER_GET_DESTINATION(p->header[0]);
	source      = HEADER_GET_SOURCE(p->header[1]);
	rcode       = HEADER_GET_RCODE(p->header[1]);
840 841 842 843 844

	spin_lock_irqsave(&card->lock, flags);
	list_for_each_entry(t, &card->transaction_list, link) {
		if (t->node_id == source && t->tlabel == tlabel) {
			list_del(&t->link);
845
			card->tlabel_mask &= ~(1ULL << t->tlabel);
846 847 848 849 850 851
			break;
		}
	}
	spin_unlock_irqrestore(&card->lock, flags);

	if (&t->link == &card->transaction_list) {
852 853
		fw_notify("Unsolicited response (source %x, tlabel %x)\n",
			  source, tlabel);
854 855 856
		return;
	}

857 858 859 860
	/*
	 * FIXME: sanity check packet, is length correct, does tcodes
	 * and addresses match.
	 */
861 862 863

	switch (tcode) {
	case TCODE_READ_QUADLET_RESPONSE:
864
		data = (u32 *) &p->header[3];
865 866 867 868 869 870 871 872 873 874
		data_length = 4;
		break;

	case TCODE_WRITE_RESPONSE:
		data = NULL;
		data_length = 0;
		break;

	case TCODE_READ_BLOCK_RESPONSE:
	case TCODE_LOCK_RESPONSE:
875
		data = p->payload;
876
		data_length = HEADER_GET_DATA_LENGTH(p->header[3]);
877 878 879 880 881 882 883 884 885
		break;

	default:
		/* Should never happen, this is just to shut up gcc. */
		data = NULL;
		data_length = 0;
		break;
	}

886 887 888 889 890 891
	/*
	 * The response handler may be executed while the request handler
	 * is still pending.  Cancel the request handler.
	 */
	card->driver->cancel_packet(card, &t->packet);

892 893 894 895
	t->callback(card, rcode, data, data_length, t->callback_data);
}
EXPORT_SYMBOL(fw_core_handle_response);

896
static const struct fw_address_region topology_map_region =
897 898
	{ .start = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP,
	  .end   = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP_END, };
899

900 901 902 903
static void handle_topology_map(struct fw_card *card, struct fw_request *request,
		int tcode, int destination, int source, int generation,
		int speed, unsigned long long offset,
		void *payload, size_t length, void *callback_data)
904
{
905
	int start;
906 907 908 909 910 911 912 913 914 915 916 917

	if (!TCODE_IS_READ_REQUEST(tcode)) {
		fw_send_response(card, request, RCODE_TYPE_ERROR);
		return;
	}

	if ((offset & 3) > 0 || (length & 3) > 0) {
		fw_send_response(card, request, RCODE_ADDRESS_ERROR);
		return;
	}

	start = (offset - topology_map_region.start) / 4;
918
	memcpy(payload, &card->topology_map[start], length);
919 920 921 922 923

	fw_send_response(card, request, RCODE_COMPLETE);
}

static struct fw_address_handler topology_map = {
924
	.length			= 0x400,
925 926 927
	.address_callback	= handle_topology_map,
};

928
static const struct fw_address_region registers_region =
929 930
	{ .start = CSR_REGISTER_BASE,
	  .end   = CSR_REGISTER_BASE | CSR_CONFIG_ROM, };
931

932 933 934 935
static void handle_registers(struct fw_card *card, struct fw_request *request,
		int tcode, int destination, int source, int generation,
		int speed, unsigned long long offset,
		void *payload, size_t length, void *callback_data)
936
{
937
	int reg = offset & ~CSR_REGISTER_BASE;
938
	__be32 *data = payload;
939
	int rcode = RCODE_COMPLETE;
940 941 942

	switch (reg) {
	case CSR_CYCLE_TIME:
943 944
		if (TCODE_IS_READ_REQUEST(tcode) && length == 4)
			*data = cpu_to_be32(card->driver->get_cycle_time(card));
945
		else
946
			rcode = RCODE_TYPE_ERROR;
947 948 949 950 951 952 953 954 955 956 957
		break;

	case CSR_BROADCAST_CHANNEL:
		if (tcode == TCODE_READ_QUADLET_REQUEST)
			*data = cpu_to_be32(card->broadcast_channel);
		else if (tcode == TCODE_WRITE_QUADLET_REQUEST)
			card->broadcast_channel =
			    (be32_to_cpu(*data) & BROADCAST_CHANNEL_VALID) |
			    BROADCAST_CHANNEL_INITIAL;
		else
			rcode = RCODE_TYPE_ERROR;
958 959 960 961 962 963
		break;

	case CSR_BUS_MANAGER_ID:
	case CSR_BANDWIDTH_AVAILABLE:
	case CSR_CHANNELS_AVAILABLE_HI:
	case CSR_CHANNELS_AVAILABLE_LO:
964 965
		/*
		 * FIXME: these are handled by the OHCI hardware and
966 967 968
		 * the stack never sees these request. If we add
		 * support for a new type of controller that doesn't
		 * handle this in hardware we need to deal with these
969 970
		 * transactions.
		 */
971 972 973 974 975
		BUG();
		break;

	case CSR_BUSY_TIMEOUT:
		/* FIXME: Implement this. */
976

977 978 979
	case CSR_BUS_TIME:
		/* Useless without initialization by the bus manager. */

980
	default:
981
		rcode = RCODE_ADDRESS_ERROR;
982 983
		break;
	}
984 985

	fw_send_response(card, request, rcode);
986 987 988 989 990 991 992
}

static struct fw_address_handler registers = {
	.length			= 0x400,
	.address_callback	= handle_registers,
};

993 994 995 996
MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
MODULE_DESCRIPTION("Core IEEE1394 transaction logic");
MODULE_LICENSE("GPL");

997
static const u32 vendor_textual_descriptor[] = {
998
	/* textual descriptor leaf () */
999
	0x00060000,
1000 1001 1002 1003 1004
	0x00000000,
	0x00000000,
	0x4c696e75,		/* L i n u */
	0x78204669,		/* x   F i */
	0x72657769,		/* r e w i */
1005
	0x72650000,		/* r e     */
1006 1007
};

1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
static const u32 model_textual_descriptor[] = {
	/* model descriptor leaf () */
	0x00030000,
	0x00000000,
	0x00000000,
	0x4a756a75,		/* J u j u */
};

static struct fw_descriptor vendor_id_descriptor = {
	.length = ARRAY_SIZE(vendor_textual_descriptor),
	.immediate = 0x03d00d1e,
1019
	.key = 0x81000000,
1020 1021 1022 1023 1024 1025 1026 1027
	.data = vendor_textual_descriptor,
};

static struct fw_descriptor model_id_descriptor = {
	.length = ARRAY_SIZE(model_textual_descriptor),
	.immediate = 0x17000001,
	.key = 0x81000000,
	.data = model_textual_descriptor,
1028 1029 1030 1031
};

static int __init fw_core_init(void)
{
1032
	int ret;
1033

1034 1035 1036
	ret = bus_register(&fw_bus_type);
	if (ret < 0)
		return ret;
1037

1038 1039 1040 1041 1042 1043
	fw_cdev_major = register_chrdev(0, "firewire", &fw_device_ops);
	if (fw_cdev_major < 0) {
		bus_unregister(&fw_bus_type);
		return fw_cdev_major;
	}

1044 1045 1046 1047
	fw_core_add_address_handler(&topology_map, &topology_map_region);
	fw_core_add_address_handler(&registers, &registers_region);
	fw_core_add_descriptor(&vendor_id_descriptor);
	fw_core_add_descriptor(&model_id_descriptor);
1048 1049 1050 1051 1052 1053

	return 0;
}

static void __exit fw_core_cleanup(void)
{
1054
	unregister_chrdev(fw_cdev_major, "firewire");
1055
	bus_unregister(&fw_bus_type);
1056
	idr_destroy(&fw_device_idr);
1057 1058 1059 1060
}

module_init(fw_core_init);
module_exit(fw_core_cleanup);