[deliverable/linux.git] / drivers / ieee1394 / ieee1394_transactions.c

/*
 * IEEE 1394 for Linux
 *
 * Transaction support.
 *
 * Copyright (C) 1999 Andreas E. Bombe
 *
 * This code is licensed under the GPL.  See the file COPYING in the root
 * directory of the kernel sources for details.
 */

#include <linux/sched.h>
#include <linux/bitops.h>
#include <linux/smp_lock.h>
#include <linux/interrupt.h>

#include <asm/errno.h>

#include "ieee1394.h"
#include "ieee1394_types.h"
#include "hosts.h"
#include "ieee1394_core.h"
#include "highlevel.h"
#include "nodemgr.h"
#include "ieee1394_transactions.h"

#define PREP_ASYNC_HEAD_ADDRESS(tc) \
        packet->tcode = tc; \
        packet->header[0] = (packet->node_id << 16) | (packet->tlabel << 10) \
                | (1 << 8) | (tc << 4); \
        packet->header[1] = (packet->host->node_id << 16) | (addr >> 32); \
        packet->header[2] = addr & 0xffffffff

static void fill_async_readquad(struct hpsb_packet *packet, u64 addr)
{
	PREP_ASYNC_HEAD_ADDRESS(TCODE_READQ);
	packet->header_size = 12;
	packet->data_size = 0;
	packet->expect_response = 1;
}

static void fill_async_readblock(struct hpsb_packet *packet, u64 addr,
				 int length)
{
	PREP_ASYNC_HEAD_ADDRESS(TCODE_READB);
	packet->header[3] = length << 16;
	packet->header_size = 16;
	packet->data_size = 0;
	packet->expect_response = 1;
}

static void fill_async_writequad(struct hpsb_packet *packet, u64 addr,
				 quadlet_t data)
{
	PREP_ASYNC_HEAD_ADDRESS(TCODE_WRITEQ);
	packet->header[3] = data;
	packet->header_size = 16;
	packet->data_size = 0;
	packet->expect_response = 1;
}

static void fill_async_writeblock(struct hpsb_packet *packet, u64 addr,
				  int length)
{
	PREP_ASYNC_HEAD_ADDRESS(TCODE_WRITEB);
	packet->header[3] = length << 16;
	packet->header_size = 16;
	packet->expect_response = 1;
	packet->data_size = length + (length % 4 ? 4 - (length % 4) : 0);
}

static void fill_async_lock(struct hpsb_packet *packet, u64 addr, int extcode,
			    int length)
{
	PREP_ASYNC_HEAD_ADDRESS(TCODE_LOCK_REQUEST);
	packet->header[3] = (length << 16) | extcode;
	packet->header_size = 16;
	packet->data_size = length;
	packet->expect_response = 1;
}

static void fill_iso_packet(struct hpsb_packet *packet, int length, int channel,
			    int tag, int sync)
{
	packet->header[0] = (length << 16) | (tag << 14) | (channel << 8)
	    | (TCODE_ISO_DATA << 4) | sync;

	packet->header_size = 4;
	packet->data_size = length;
	packet->type = hpsb_iso;
	packet->tcode = TCODE_ISO_DATA;
}

static void fill_phy_packet(struct hpsb_packet *packet, quadlet_t data)
{
	packet->header[0] = data;
	packet->header[1] = ~data;
	packet->header_size = 8;
	packet->data_size = 0;
	packet->expect_response = 0;
	packet->type = hpsb_raw;	/* No CRC added */
	packet->speed_code = IEEE1394_SPEED_100;	/* Force speed to be 100Mbps */
}

static void fill_async_stream_packet(struct hpsb_packet *packet, int length,
				     int channel, int tag, int sync)
{
	packet->header[0] = (length << 16) | (tag << 14) | (channel << 8)
	    | (TCODE_STREAM_DATA << 4) | sync;

	packet->header_size = 4;
	packet->data_size = length;
	packet->type = hpsb_async;
	packet->tcode = TCODE_ISO_DATA;
}

/**
 * hpsb_get_tlabel - allocate a transaction label
 * @packet: the packet who's tlabel/tpool we set
 *
 * Every asynchronous transaction on the 1394 bus needs a transaction
 * label to match the response to the request.  This label has to be
 * different from any other transaction label in an outstanding request to
 * the same node to make matching possible without ambiguity.
 *
 * There are 64 different tlabels, so an allocated tlabel has to be freed
 * with hpsb_free_tlabel() after the transaction is complete (unless it's
 * reused again for the same target node).
 *
 * Return value: Zero on success, otherwise non-zero. A non-zero return
 * generally means there are no available tlabels. If this is called out
 * of interrupt or atomic context, then it will sleep until can return a
 * tlabel.
 */
int hpsb_get_tlabel(struct hpsb_packet *packet)
{
	unsigned long flags;
	struct hpsb_tlabel_pool *tp;
	int n = NODEID_TO_NODE(packet->node_id);

	if (unlikely(n == ALL_NODES))
		return 0;
	tp = &packet->host->tpool[n];

	if (irqs_disabled() || in_atomic()) {
		if (down_trylock(&tp->count))
			return 1;
	} else {
		down(&tp->count);
	}

	spin_lock_irqsave(&tp->lock, flags);

	packet->tlabel = find_next_zero_bit(tp->pool, 64, tp->next);
	if (packet->tlabel > 63)
		packet->tlabel = find_first_zero_bit(tp->pool, 64);
	tp->next = (packet->tlabel + 1) % 64;
	/* Should _never_ happen */
	BUG_ON(test_and_set_bit(packet->tlabel, tp->pool));
	tp->allocations++;
	spin_unlock_irqrestore(&tp->lock, flags);

	return 0;
}

/**
 * hpsb_free_tlabel - free an allocated transaction label
 * @packet: packet whos tlabel/tpool needs to be cleared
 *
 * Frees the transaction label allocated with hpsb_get_tlabel().  The
 * tlabel has to be freed after the transaction is complete (i.e. response
 * was received for a split transaction or packet was sent for a unified
 * transaction).
 *
 * A tlabel must not be freed twice.
 */
void hpsb_free_tlabel(struct hpsb_packet *packet)
{
	unsigned long flags;
	struct hpsb_tlabel_pool *tp;
	int n = NODEID_TO_NODE(packet->node_id);

	if (unlikely(n == ALL_NODES))
		return;
	tp = &packet->host->tpool[n];

	BUG_ON(packet->tlabel > 63 || packet->tlabel < 0);

	spin_lock_irqsave(&tp->lock, flags);
	BUG_ON(!test_and_clear_bit(packet->tlabel, tp->pool));
	spin_unlock_irqrestore(&tp->lock, flags);

	up(&tp->count);
}

int hpsb_packet_success(struct hpsb_packet *packet)
{
	switch (packet->ack_code) {
	case ACK_PENDING:
		switch ((packet->header[1] >> 12) & 0xf) {
		case RCODE_COMPLETE:
			return 0;
		case RCODE_CONFLICT_ERROR:
			return -EAGAIN;
		case RCODE_DATA_ERROR:
			return -EREMOTEIO;
		case RCODE_TYPE_ERROR:
			return -EACCES;
		case RCODE_ADDRESS_ERROR:
			return -EINVAL;
		default:
			HPSB_ERR("received reserved rcode %d from node %d",
				 (packet->header[1] >> 12) & 0xf,
				 packet->node_id);
			return -EAGAIN;
		}
		HPSB_PANIC("reached unreachable code 1 in %s", __FUNCTION__);

	case ACK_BUSY_X:
	case ACK_BUSY_A:
	case ACK_BUSY_B:
		return -EBUSY;

	case ACK_TYPE_ERROR:
		return -EACCES;

	case ACK_COMPLETE:
		if (packet->tcode == TCODE_WRITEQ
		    || packet->tcode == TCODE_WRITEB) {
			return 0;
		} else {
			HPSB_ERR("impossible ack_complete from node %d "
				 "(tcode %d)", packet->node_id, packet->tcode);
			return -EAGAIN;
		}

	case ACK_DATA_ERROR:
		if (packet->tcode == TCODE_WRITEB
		    || packet->tcode == TCODE_LOCK_REQUEST) {
			return -EAGAIN;
		} else {
			HPSB_ERR("impossible ack_data_error from node %d "
				 "(tcode %d)", packet->node_id, packet->tcode);
			return -EAGAIN;
		}

	case ACK_ADDRESS_ERROR:
		return -EINVAL;

	case ACK_TARDY:
	case ACK_CONFLICT_ERROR:
	case ACKX_NONE:
	case ACKX_SEND_ERROR:
	case ACKX_ABORTED:
	case ACKX_TIMEOUT:
		/* error while sending */
		return -EAGAIN;

	default:
		HPSB_ERR("got invalid ack %d from node %d (tcode %d)",
			 packet->ack_code, packet->node_id, packet->tcode);
		return -EAGAIN;
	}

	HPSB_PANIC("reached unreachable code 2 in %s", __FUNCTION__);
}

struct hpsb_packet *hpsb_make_readpacket(struct hpsb_host *host, nodeid_t node,
					 u64 addr, size_t length)
{
	struct hpsb_packet *packet;

	if (length == 0)
		return NULL;

	packet = hpsb_alloc_packet(length);
	if (!packet)
		return NULL;

	packet->host = host;
	packet->node_id = node;

	if (hpsb_get_tlabel(packet)) {
		hpsb_free_packet(packet);
		return NULL;
	}

	if (length == 4)
		fill_async_readquad(packet, addr);
	else
		fill_async_readblock(packet, addr, length);

	return packet;
}

struct hpsb_packet *hpsb_make_writepacket(struct hpsb_host *host, nodeid_t node,
					  u64 addr, quadlet_t * buffer,
					  size_t length)
{
	struct hpsb_packet *packet;

	if (length == 0)
		return NULL;

	packet = hpsb_alloc_packet(length);
	if (!packet)
		return NULL;

	if (length % 4) {	/* zero padding bytes */
		packet->data[length >> 2] = 0;
	}
	packet->host = host;
	packet->node_id = node;

	if (hpsb_get_tlabel(packet)) {
		hpsb_free_packet(packet);
		return NULL;
	}

	if (length == 4) {
		fill_async_writequad(packet, addr, buffer ? *buffer : 0);
	} else {
		fill_async_writeblock(packet, addr, length);
		if (buffer)
			memcpy(packet->data, buffer, length);
	}

	return packet;
}

struct hpsb_packet *hpsb_make_streampacket(struct hpsb_host *host, u8 * buffer,
					   int length, int channel, int tag,
					   int sync)
{
	struct hpsb_packet *packet;

	if (length == 0)
		return NULL;

	packet = hpsb_alloc_packet(length);
	if (!packet)
		return NULL;

	if (length % 4) {	/* zero padding bytes */
		packet->data[length >> 2] = 0;
	}
	packet->host = host;

	if (hpsb_get_tlabel(packet)) {
		hpsb_free_packet(packet);
		return NULL;
	}

	fill_async_stream_packet(packet, length, channel, tag, sync);
	if (buffer)
		memcpy(packet->data, buffer, length);

	return packet;
}

struct hpsb_packet *hpsb_make_lockpacket(struct hpsb_host *host, nodeid_t node,
					 u64 addr, int extcode,
					 quadlet_t * data, quadlet_t arg)
{
	struct hpsb_packet *p;
	u32 length;

	p = hpsb_alloc_packet(8);
	if (!p)
		return NULL;

	p->host = host;
	p->node_id = node;
	if (hpsb_get_tlabel(p)) {
		hpsb_free_packet(p);
		return NULL;
	}

	switch (extcode) {
	case EXTCODE_FETCH_ADD:
	case EXTCODE_LITTLE_ADD:
		length = 4;
		if (data)
			p->data[0] = *data;
		break;
	default:
		length = 8;
		if (data) {
			p->data[0] = arg;
			p->data[1] = *data;
		}
		break;
	}
	fill_async_lock(p, addr, extcode, length);

	return p;
}

struct hpsb_packet *hpsb_make_lock64packet(struct hpsb_host *host,
					   nodeid_t node, u64 addr, int extcode,
					   octlet_t * data, octlet_t arg)
{
	struct hpsb_packet *p;
	u32 length;

	p = hpsb_alloc_packet(16);
	if (!p)
		return NULL;

	p->host = host;
	p->node_id = node;
	if (hpsb_get_tlabel(p)) {
		hpsb_free_packet(p);
		return NULL;
	}

	switch (extcode) {
	case EXTCODE_FETCH_ADD:
	case EXTCODE_LITTLE_ADD:
		length = 8;
		if (data) {
			p->data[0] = *data >> 32;
			p->data[1] = *data & 0xffffffff;
		}
		break;
	default:
		length = 16;
		if (data) {
			p->data[0] = arg >> 32;
			p->data[1] = arg & 0xffffffff;
			p->data[2] = *data >> 32;
			p->data[3] = *data & 0xffffffff;
		}
		break;
	}
	fill_async_lock(p, addr, extcode, length);

	return p;
}

struct hpsb_packet *hpsb_make_phypacket(struct hpsb_host *host, quadlet_t data)
{
	struct hpsb_packet *p;

	p = hpsb_alloc_packet(0);
	if (!p)
		return NULL;

	p->host = host;
	fill_phy_packet(p, data);

	return p;
}

struct hpsb_packet *hpsb_make_isopacket(struct hpsb_host *host,
					int length, int channel,
					int tag, int sync)
{
	struct hpsb_packet *p;

	p = hpsb_alloc_packet(length);
	if (!p)
		return NULL;

	p->host = host;
	fill_iso_packet(p, length, channel, tag, sync);

	p->generation = get_hpsb_generation(host);

	return p;
}

/*
 * FIXME - these functions should probably read from / write to user space to
 * avoid in kernel buffers for user space callers
 */

int hpsb_read(struct hpsb_host *host, nodeid_t node, unsigned int generation,
	      u64 addr, quadlet_t * buffer, size_t length)
{
	struct hpsb_packet *packet;
	int retval = 0;

	if (length == 0)
		return -EINVAL;

	BUG_ON(in_interrupt());	// We can't be called in an interrupt, yet

	packet = hpsb_make_readpacket(host, node, addr, length);

	if (!packet) {
		return -ENOMEM;
	}

	packet->generation = generation;
	retval = hpsb_send_packet_and_wait(packet);
	if (retval < 0)
		goto hpsb_read_fail;

	retval = hpsb_packet_success(packet);

	if (retval == 0) {
		if (length == 4) {
			*buffer = packet->header[3];
		} else {
			memcpy(buffer, packet->data, length);
		}
	}

      hpsb_read_fail:
	hpsb_free_tlabel(packet);
	hpsb_free_packet(packet);

	return retval;
}

int hpsb_write(struct hpsb_host *host, nodeid_t node, unsigned int generation,
	       u64 addr, quadlet_t * buffer, size_t length)
{
	struct hpsb_packet *packet;
	int retval;

	if (length == 0)
		return -EINVAL;

	BUG_ON(in_interrupt());	// We can't be called in an interrupt, yet

	packet = hpsb_make_writepacket(host, node, addr, buffer, length);

	if (!packet)
		return -ENOMEM;

	packet->generation = generation;
	retval = hpsb_send_packet_and_wait(packet);
	if (retval < 0)
		goto hpsb_write_fail;

	retval = hpsb_packet_success(packet);

      hpsb_write_fail:
	hpsb_free_tlabel(packet);
	hpsb_free_packet(packet);

	return retval;
}

#if 0

int hpsb_lock(struct hpsb_host *host, nodeid_t node, unsigned int generation,
	      u64 addr, int extcode, quadlet_t * data, quadlet_t arg)
{
	struct hpsb_packet *packet;
	int retval = 0;

	BUG_ON(in_interrupt());	// We can't be called in an interrupt, yet

	packet = hpsb_make_lockpacket(host, node, addr, extcode, data, arg);
	if (!packet)
		return -ENOMEM;

	packet->generation = generation;
	retval = hpsb_send_packet_and_wait(packet);
	if (retval < 0)
		goto hpsb_lock_fail;

	retval = hpsb_packet_success(packet);

	if (retval == 0) {
		*data = packet->data[0];
	}

      hpsb_lock_fail:
	hpsb_free_tlabel(packet);
	hpsb_free_packet(packet);

	return retval;
}

int hpsb_send_gasp(struct hpsb_host *host, int channel, unsigned int generation,
		   quadlet_t * buffer, size_t length, u32 specifier_id,
		   unsigned int version)
{
	struct hpsb_packet *packet;
	int retval = 0;
	u16 specifier_id_hi = (specifier_id & 0x00ffff00) >> 8;
	u8 specifier_id_lo = specifier_id & 0xff;

	HPSB_VERBOSE("Send GASP: channel = %d, length = %Zd", channel, length);

	length += 8;

	packet = hpsb_make_streampacket(host, NULL, length, channel, 3, 0);
	if (!packet)
		return -ENOMEM;

	packet->data[0] = cpu_to_be32((host->node_id << 16) | specifier_id_hi);
	packet->data[1] =
	    cpu_to_be32((specifier_id_lo << 24) | (version & 0x00ffffff));

	memcpy(&(packet->data[2]), buffer, length - 8);

	packet->generation = generation;

	packet->no_waiter = 1;

	retval = hpsb_send_packet(packet);
	if (retval < 0)
		hpsb_free_packet(packet);

	return retval;
}

#endif				/*  0  */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* IEEE 1394 for Linux
	3	*
	4	* Transaction support.
	5	*
	6	* Copyright (C) 1999 Andreas E. Bombe
	7	*
	8	* This code is licensed under the GPL. See the file COPYING in the root
	9	* directory of the kernel sources for details.
	10	*/
	11
	12	#include <linux/sched.h>
	13	#include <linux/bitops.h>
	14	#include <linux/smp_lock.h>
	15	#include <linux/interrupt.h>
	16
	17	#include <asm/errno.h>
	18
	19	#include "ieee1394.h"
	20	#include "ieee1394_types.h"
	21	#include "hosts.h"
	22	#include "ieee1394_core.h"
	23	#include "highlevel.h"
	24	#include "nodemgr.h"
e27d3014	25	#include "ieee1394_transactions.h"
1da177e4	26
1da177e4 LT	27	#define PREP_ASYNC_HEAD_ADDRESS(tc) \
	28	packet->tcode = tc; \
	29	packet->header[0] = (packet->node_id << 16) \| (packet->tlabel << 10) \
	30	\| (1 << 8) \| (tc << 4); \
	31	packet->header[1] = (packet->host->node_id << 16) \| (addr >> 32); \
	32	packet->header[2] = addr & 0xffffffff
	33
1da177e4 LT	34	static void fill_async_readquad(struct hpsb_packet *packet, u64 addr)
1da177e4 LT	35	{
16c333a3 JMH	36	PREP_ASYNC_HEAD_ADDRESS(TCODE_READQ);
	37	packet->header_size = 12;
	38	packet->data_size = 0;
	39	packet->expect_response = 1;
1da177e4 LT	40	}
1da177e4 LT	41
16c333a3 JMH	42	static void fill_async_readblock(struct hpsb_packet *packet, u64 addr,
16c333a3 JMH	43	int length)
1da177e4	44	{
16c333a3 JMH	45	PREP_ASYNC_HEAD_ADDRESS(TCODE_READB);
	46	packet->header[3] = length << 16;
	47	packet->header_size = 16;
	48	packet->data_size = 0;
	49	packet->expect_response = 1;
1da177e4 LT	50	}
1da177e4 LT	51
16c333a3 JMH	52	static void fill_async_writequad(struct hpsb_packet *packet, u64 addr,
16c333a3 JMH	53	quadlet_t data)
1da177e4	54	{
16c333a3 JMH	55	PREP_ASYNC_HEAD_ADDRESS(TCODE_WRITEQ);
	56	packet->header[3] = data;
	57	packet->header_size = 16;
	58	packet->data_size = 0;
	59	packet->expect_response = 1;
1da177e4 LT	60	}
1da177e4 LT	61
16c333a3 JMH	62	static void fill_async_writeblock(struct hpsb_packet *packet, u64 addr,
16c333a3 JMH	63	int length)
1da177e4	64	{
16c333a3 JMH	65	PREP_ASYNC_HEAD_ADDRESS(TCODE_WRITEB);
	66	packet->header[3] = length << 16;
	67	packet->header_size = 16;
	68	packet->expect_response = 1;
	69	packet->data_size = length + (length % 4 ? 4 - (length % 4) : 0);
1da177e4 LT	70	}
	71
	72	static void fill_async_lock(struct hpsb_packet *packet, u64 addr, int extcode,
16c333a3	73	int length)
1da177e4	74	{
16c333a3 JMH	75	PREP_ASYNC_HEAD_ADDRESS(TCODE_LOCK_REQUEST);
	76	packet->header[3] = (length << 16) \| extcode;
	77	packet->header_size = 16;
	78	packet->data_size = length;
	79	packet->expect_response = 1;
1da177e4 LT	80	}
	81
	82	static void fill_iso_packet(struct hpsb_packet *packet, int length, int channel,
16c333a3	83	int tag, int sync)
1da177e4	84	{
16c333a3 JMH	85	packet->header[0] = (length << 16) \| (tag << 14) \| (channel << 8)
16c333a3 JMH	86	\| (TCODE_ISO_DATA << 4) \| sync;
1da177e4	87
16c333a3 JMH	88	packet->header_size = 4;
	89	packet->data_size = length;
	90	packet->type = hpsb_iso;
	91	packet->tcode = TCODE_ISO_DATA;
1da177e4 LT	92	}
	93
	94	static void fill_phy_packet(struct hpsb_packet *packet, quadlet_t data)
	95	{
16c333a3 JMH	96	packet->header[0] = data;
	97	packet->header[1] = ~data;
	98	packet->header_size = 8;
	99	packet->data_size = 0;
	100	packet->expect_response = 0;
	101	packet->type = hpsb_raw; /* No CRC added */
	102	packet->speed_code = IEEE1394_SPEED_100; /* Force speed to be 100Mbps */
1da177e4 LT	103	}
	104
	105	static void fill_async_stream_packet(struct hpsb_packet *packet, int length,
	106	int channel, int tag, int sync)
	107	{
	108	packet->header[0] = (length << 16) \| (tag << 14) \| (channel << 8)
16c333a3	109	\| (TCODE_STREAM_DATA << 4) \| sync;
1da177e4 LT	110
	111	packet->header_size = 4;
	112	packet->data_size = length;
	113	packet->type = hpsb_async;
	114	packet->tcode = TCODE_ISO_DATA;
	115	}
	116
	117	/**
	118	* hpsb_get_tlabel - allocate a transaction label
	119	* @packet: the packet who's tlabel/tpool we set
	120	*
	121	* Every asynchronous transaction on the 1394 bus needs a transaction
	122	* label to match the response to the request. This label has to be
	123	* different from any other transaction label in an outstanding request to
	124	* the same node to make matching possible without ambiguity.
	125	*
	126	* There are 64 different tlabels, so an allocated tlabel has to be freed
	127	* with hpsb_free_tlabel() after the transaction is complete (unless it's
	128	* reused again for the same target node).
	129	*
	130	* Return value: Zero on success, otherwise non-zero. A non-zero return
	131	* generally means there are no available tlabels. If this is called out
	132	* of interrupt or atomic context, then it will sleep until can return a
	133	* tlabel.
	134	*/
	135	int hpsb_get_tlabel(struct hpsb_packet *packet)
	136	{
	137	unsigned long flags;
	138	struct hpsb_tlabel_pool *tp;
eaf88450	139	int n = NODEID_TO_NODE(packet->node_id);
1da177e4	140
eaf88450 BC	141	if (unlikely(n == ALL_NODES))
	142	return 0;
	143	tp = &packet->host->tpool[n];
1da177e4 LT	144
	145	if (irqs_disabled() \|\| in_atomic()) {
	146	if (down_trylock(&tp->count))
	147	return 1;
	148	} else {
	149	down(&tp->count);
	150	}
	151
	152	spin_lock_irqsave(&tp->lock, flags);
	153
	154	packet->tlabel = find_next_zero_bit(tp->pool, 64, tp->next);
	155	if (packet->tlabel > 63)
	156	packet->tlabel = find_first_zero_bit(tp->pool, 64);
	157	tp->next = (packet->tlabel + 1) % 64;
	158	/* Should _never_ happen */
	159	BUG_ON(test_and_set_bit(packet->tlabel, tp->pool));
	160	tp->allocations++;
	161	spin_unlock_irqrestore(&tp->lock, flags);
	162
	163	return 0;
	164	}
	165
	166	/**
	167	* hpsb_free_tlabel - free an allocated transaction label
	168	* @packet: packet whos tlabel/tpool needs to be cleared
	169	*
	170	* Frees the transaction label allocated with hpsb_get_tlabel(). The
	171	* tlabel has to be freed after the transaction is complete (i.e. response
	172	* was received for a split transaction or packet was sent for a unified
	173	* transaction).
	174	*
	175	* A tlabel must not be freed twice.
	176	*/
	177	void hpsb_free_tlabel(struct hpsb_packet *packet)
	178	{
16c333a3	179	unsigned long flags;
1da177e4	180	struct hpsb_tlabel_pool *tp;
eaf88450	181	int n = NODEID_TO_NODE(packet->node_id);
1da177e4	182
eaf88450 BC	183	if (unlikely(n == ALL_NODES))
	184	return;
	185	tp = &packet->host->tpool[n];
1da177e4 LT	186
	187	BUG_ON(packet->tlabel > 63 \|\| packet->tlabel < 0);
	188
16c333a3	189	spin_lock_irqsave(&tp->lock, flags);
1da177e4	190	BUG_ON(!test_and_clear_bit(packet->tlabel, tp->pool));
16c333a3	191	spin_unlock_irqrestore(&tp->lock, flags);
1da177e4 LT	192
	193	up(&tp->count);
	194	}
	195
1da177e4 LT	196	int hpsb_packet_success(struct hpsb_packet *packet)
1da177e4 LT	197	{
16c333a3 JMH	198	switch (packet->ack_code) {
	199	case ACK_PENDING:
	200	switch ((packet->header[1] >> 12) & 0xf) {
	201	case RCODE_COMPLETE:
	202	return 0;
	203	case RCODE_CONFLICT_ERROR:
	204	return -EAGAIN;
	205	case RCODE_DATA_ERROR:
	206	return -EREMOTEIO;
	207	case RCODE_TYPE_ERROR:
	208	return -EACCES;
	209	case RCODE_ADDRESS_ERROR:
	210	return -EINVAL;
	211	default:
	212	HPSB_ERR("received reserved rcode %d from node %d",
	213	(packet->header[1] >> 12) & 0xf,
	214	packet->node_id);
	215	return -EAGAIN;
	216	}
	217	HPSB_PANIC("reached unreachable code 1 in %s", __FUNCTION__);
	218
	219	case ACK_BUSY_X:
	220	case ACK_BUSY_A:
	221	case ACK_BUSY_B:
	222	return -EBUSY;
	223
	224	case ACK_TYPE_ERROR:
	225	return -EACCES;
	226
	227	case ACK_COMPLETE:
	228	if (packet->tcode == TCODE_WRITEQ
	229	\|\| packet->tcode == TCODE_WRITEB) {
	230	return 0;
	231	} else {
	232	HPSB_ERR("impossible ack_complete from node %d "
	233	"(tcode %d)", packet->node_id, packet->tcode);
	234	return -EAGAIN;
	235	}
	236
	237	case ACK_DATA_ERROR:
	238	if (packet->tcode == TCODE_WRITEB
	239	\|\| packet->tcode == TCODE_LOCK_REQUEST) {
	240	return -EAGAIN;
	241	} else {
	242	HPSB_ERR("impossible ack_data_error from node %d "
	243	"(tcode %d)", packet->node_id, packet->tcode);
	244	return -EAGAIN;
	245	}
	246
	247	case ACK_ADDRESS_ERROR:
	248	return -EINVAL;
	249
	250	case ACK_TARDY:
	251	case ACK_CONFLICT_ERROR:
	252	case ACKX_NONE:
	253	case ACKX_SEND_ERROR:
	254	case ACKX_ABORTED:
	255	case ACKX_TIMEOUT:
	256	/* error while sending */
	257	return -EAGAIN;
	258
	259	default:
	260	HPSB_ERR("got invalid ack %d from node %d (tcode %d)",
	261	packet->ack_code, packet->node_id, packet->tcode);
262	return -EAGAIN;
263	}
264
265	HPSB_PANIC("reached unreachable code 2 in %s", __FUNCTION__);
1da177e4 LT	266	}
	267
	268	struct hpsb_packet hpsb_make_readpacket(struct hpsb_host host, nodeid_t node,
	269	u64 addr, size_t length)
	270	{
16c333a3	271	struct hpsb_packet *packet;
1da177e4 LT	272
	273	if (length == 0)
	274	return NULL;
	275
	276	packet = hpsb_alloc_packet(length);
	277	if (!packet)
	278	return NULL;
	279
	280	packet->host = host;
	281	packet->node_id = node;
	282
	283	if (hpsb_get_tlabel(packet)) {
	284	hpsb_free_packet(packet);
	285	return NULL;
	286	}
	287
	288	if (length == 4)
	289	fill_async_readquad(packet, addr);
	290	else
	291	fill_async_readblock(packet, addr, length);
	292
	293	return packet;
	294	}
	295
16c333a3 JMH	296	struct hpsb_packet hpsb_make_writepacket(struct hpsb_host host, nodeid_t node,
	297	u64 addr, quadlet_t * buffer,
	298	size_t length)
1da177e4 LT	299	{
	300	struct hpsb_packet *packet;
	301
	302	if (length == 0)
	303	return NULL;
	304
	305	packet = hpsb_alloc_packet(length);
	306	if (!packet)
	307	return NULL;
	308
16c333a3	309	if (length % 4) { /* zero padding bytes */
1da177e4 LT	310	packet->data[length >> 2] = 0;
	311	}
	312	packet->host = host;
	313	packet->node_id = node;
	314
	315	if (hpsb_get_tlabel(packet)) {
	316	hpsb_free_packet(packet);
	317	return NULL;
	318	}
	319
	320	if (length == 4) {
	321	fill_async_writequad(packet, addr, buffer ? *buffer : 0);
	322	} else {
	323	fill_async_writeblock(packet, addr, length);
	324	if (buffer)
	325	memcpy(packet->data, buffer, length);
	326	}
	327
	328	return packet;
	329	}
	330
16c333a3 JMH	331	struct hpsb_packet hpsb_make_streampacket(struct hpsb_host host, u8 * buffer,
	332	int length, int channel, int tag,
	333	int sync)
1da177e4 LT	334	{
	335	struct hpsb_packet *packet;
	336
	337	if (length == 0)
	338	return NULL;
	339
	340	packet = hpsb_alloc_packet(length);
	341	if (!packet)
	342	return NULL;
	343
16c333a3	344	if (length % 4) { /* zero padding bytes */
1da177e4 LT	345	packet->data[length >> 2] = 0;
	346	}
	347	packet->host = host;
	348
	349	if (hpsb_get_tlabel(packet)) {
	350	hpsb_free_packet(packet);
	351	return NULL;
	352	}
	353
	354	fill_async_stream_packet(packet, length, channel, tag, sync);
	355	if (buffer)
	356	memcpy(packet->data, buffer, length);
	357
	358	return packet;
	359	}
	360
	361	struct hpsb_packet hpsb_make_lockpacket(struct hpsb_host host, nodeid_t node,
16c333a3 JMH	362	u64 addr, int extcode,
16c333a3 JMH	363	quadlet_t * data, quadlet_t arg)
1da177e4 LT	364	{
	365	struct hpsb_packet *p;
	366	u32 length;
	367
	368	p = hpsb_alloc_packet(8);
16c333a3 JMH	369	if (!p)
16c333a3 JMH	370	return NULL;
1da177e4 LT	371
	372	p->host = host;
	373	p->node_id = node;
	374	if (hpsb_get_tlabel(p)) {
	375	hpsb_free_packet(p);
	376	return NULL;
	377	}
	378
	379	switch (extcode) {
	380	case EXTCODE_FETCH_ADD:
	381	case EXTCODE_LITTLE_ADD:
	382	length = 4;
	383	if (data)
	384	p->data[0] = *data;
	385	break;
	386	default:
	387	length = 8;
	388	if (data) {
	389	p->data[0] = arg;
	390	p->data[1] = *data;
	391	}
	392	break;
	393	}
	394	fill_async_lock(p, addr, extcode, length);
	395
	396	return p;
	397	}
	398
16c333a3 JMH	399	struct hpsb_packet hpsb_make_lock64packet(struct hpsb_host host,
	400	nodeid_t node, u64 addr, int extcode,
	401	octlet_t * data, octlet_t arg)
1da177e4 LT	402	{
	403	struct hpsb_packet *p;
	404	u32 length;
	405
	406	p = hpsb_alloc_packet(16);
16c333a3 JMH	407	if (!p)
16c333a3 JMH	408	return NULL;
1da177e4 LT	409
	410	p->host = host;
	411	p->node_id = node;
	412	if (hpsb_get_tlabel(p)) {
	413	hpsb_free_packet(p);
	414	return NULL;
	415	}
	416
	417	switch (extcode) {
	418	case EXTCODE_FETCH_ADD:
	419	case EXTCODE_LITTLE_ADD:
	420	length = 8;
	421	if (data) {
	422	p->data[0] = *data >> 32;
	423	p->data[1] = *data & 0xffffffff;
	424	}
	425	break;
	426	default:
	427	length = 16;
	428	if (data) {
	429	p->data[0] = arg >> 32;
	430	p->data[1] = arg & 0xffffffff;
	431	p->data[2] = *data >> 32;
	432	p->data[3] = *data & 0xffffffff;
	433	}
	434	break;
	435	}
	436	fill_async_lock(p, addr, extcode, length);
	437
	438	return p;
	439	}
	440
16c333a3	441	struct hpsb_packet hpsb_make_phypacket(struct hpsb_host host, quadlet_t data)
1da177e4	442	{
16c333a3	443	struct hpsb_packet *p;
1da177e4	444
16c333a3 JMH	445	p = hpsb_alloc_packet(0);
	446	if (!p)
	447	return NULL;
1da177e4	448
16c333a3 JMH	449	p->host = host;
16c333a3 JMH	450	fill_phy_packet(p, data);
1da177e4	451
16c333a3	452	return p;
1da177e4 LT	453	}
	454
	455	struct hpsb_packet hpsb_make_isopacket(struct hpsb_host host,
	456	int length, int channel,
	457	int tag, int sync)
	458	{
	459	struct hpsb_packet *p;
	460
	461	p = hpsb_alloc_packet(length);
16c333a3 JMH	462	if (!p)
16c333a3 JMH	463	return NULL;
1da177e4 LT	464
	465	p->host = host;
	466	fill_iso_packet(p, length, channel, tag, sync);
	467
	468	p->generation = get_hpsb_generation(host);
	469
	470	return p;
	471	}
	472
	473	/*
	474	* FIXME - these functions should probably read from / write to user space to
	475	* avoid in kernel buffers for user space callers
	476	*/
	477
	478	int hpsb_read(struct hpsb_host *host, nodeid_t node, unsigned int generation,
16c333a3	479	u64 addr, quadlet_t * buffer, size_t length)
1da177e4	480	{
16c333a3 JMH	481	struct hpsb_packet *packet;
16c333a3 JMH	482	int retval = 0;
1da177e4	483
16c333a3 JMH	484	if (length == 0)
16c333a3 JMH	485	return -EINVAL;
1da177e4	486
16c333a3	487	BUG_ON(in_interrupt()); // We can't be called in an interrupt, yet
1da177e4 LT	488
	489	packet = hpsb_make_readpacket(host, node, addr, length);
	490
16c333a3 JMH	491	if (!packet) {
	492	return -ENOMEM;
	493	}
1da177e4 LT	494
1da177e4 LT	495	packet->generation = generation;
16c333a3	496	retval = hpsb_send_packet_and_wait(packet);
1da177e4 LT	497	if (retval < 0)
	498	goto hpsb_read_fail;
	499
16c333a3	500	retval = hpsb_packet_success(packet);
1da177e4	501
16c333a3 JMH	502	if (retval == 0) {
	503	if (length == 4) {
	504	*buffer = packet->header[3];
	505	} else {
	506	memcpy(buffer, packet->data, length);
	507	}
	508	}
1da177e4	509
16c333a3 JMH	510	hpsb_read_fail:
	511	hpsb_free_tlabel(packet);
	512	hpsb_free_packet(packet);
1da177e4	513
16c333a3	514	return retval;
1da177e4 LT	515	}
1da177e4 LT	516
1da177e4	517	int hpsb_write(struct hpsb_host *host, nodeid_t node, unsigned int generation,
16c333a3	518	u64 addr, quadlet_t * buffer, size_t length)
1da177e4 LT	519	{
	520	struct hpsb_packet *packet;
	521	int retval;
	522
	523	if (length == 0)
	524	return -EINVAL;
	525
16c333a3	526	BUG_ON(in_interrupt()); // We can't be called in an interrupt, yet
1da177e4	527
16c333a3	528	packet = hpsb_make_writepacket(host, node, addr, buffer, length);
1da177e4 LT	529
	530	if (!packet)
	531	return -ENOMEM;
	532
	533	packet->generation = generation;
16c333a3	534	retval = hpsb_send_packet_and_wait(packet);
1da177e4 LT	535	if (retval < 0)
	536	goto hpsb_write_fail;
	537
16c333a3	538	retval = hpsb_packet_success(packet);
1da177e4	539
16c333a3 JMH	540	hpsb_write_fail:
	541	hpsb_free_tlabel(packet);
	542	hpsb_free_packet(packet);
1da177e4	543
16c333a3	544	return retval;
1da177e4 LT	545	}
1da177e4 LT	546
9ac485dc	547	#if 0
1da177e4 LT	548
1da177e4 LT	549	int hpsb_lock(struct hpsb_host *host, nodeid_t node, unsigned int generation,
16c333a3	550	u64 addr, int extcode, quadlet_t * data, quadlet_t arg)
1da177e4	551	{
16c333a3 JMH	552	struct hpsb_packet *packet;
16c333a3 JMH	553	int retval = 0;
1da177e4	554
16c333a3	555	BUG_ON(in_interrupt()); // We can't be called in an interrupt, yet
1da177e4 LT	556
1da177e4 LT	557	packet = hpsb_make_lockpacket(host, node, addr, extcode, data, arg);
16c333a3 JMH	558	if (!packet)
16c333a3 JMH	559	return -ENOMEM;
1da177e4 LT	560
1da177e4 LT	561	packet->generation = generation;
16c333a3	562	retval = hpsb_send_packet_and_wait(packet);
1da177e4 LT	563	if (retval < 0)
	564	goto hpsb_lock_fail;
	565
16c333a3	566	retval = hpsb_packet_success(packet);
1da177e4	567
16c333a3 JMH	568	if (retval == 0) {
	569	*data = packet->data[0];
	570	}
1da177e4	571
16c333a3 JMH	572	hpsb_lock_fail:
	573	hpsb_free_tlabel(packet);
	574	hpsb_free_packet(packet);
1da177e4	575
16c333a3	576	return retval;
1da177e4 LT	577	}
1da177e4 LT	578
1da177e4	579	int hpsb_send_gasp(struct hpsb_host *host, int channel, unsigned int generation,
16c333a3	580	quadlet_t * buffer, size_t length, u32 specifier_id,
1da177e4 LT	581	unsigned int version)
	582	{
	583	struct hpsb_packet *packet;
	584	int retval = 0;
	585	u16 specifier_id_hi = (specifier_id & 0x00ffff00) >> 8;
	586	u8 specifier_id_lo = specifier_id & 0xff;
	587
	588	HPSB_VERBOSE("Send GASP: channel = %d, length = %Zd", channel, length);
	589
	590	length += 8;
	591
	592	packet = hpsb_make_streampacket(host, NULL, length, channel, 3, 0);
	593	if (!packet)
	594	return -ENOMEM;
	595
	596	packet->data[0] = cpu_to_be32((host->node_id << 16) \| specifier_id_hi);
16c333a3 JMH	597	packet->data[1] =
16c333a3 JMH	598	cpu_to_be32((specifier_id_lo << 24) \| (version & 0x00ffffff));
1da177e4 LT	599
	600	memcpy(&(packet->data[2]), buffer, length - 8);
	601
	602	packet->generation = generation;
	603
	604	packet->no_waiter = 1;
	605
	606	retval = hpsb_send_packet(packet);
	607	if (retval < 0)
	608	hpsb_free_packet(packet);
	609
	610	return retval;
	611	}
9ac485dc	612
16c333a3	613	#endif /* 0 */