[deliverable/linux.git] / drivers / firewire / fw-transaction.h

/*						-*- c-basic-offset: 8 -*-
 *
 * fw-transaction.h - Header for IEEE1394 transaction logic
 *
 * Copyright (C) 2003-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.
 */

#ifndef __fw_transaction_h
#define __fw_transaction_h

#include <linux/device.h>
#include <linux/timer.h>
#include <linux/interrupt.h>
#include <linux/list.h>
#include <linux/fs.h>

#define TCODE_WRITE_QUADLET_REQUEST	0
#define TCODE_WRITE_BLOCK_REQUEST	1
#define TCODE_WRITE_RESPONSE		2
#define TCODE_READ_QUADLET_REQUEST	4
#define TCODE_READ_BLOCK_REQUEST	5
#define TCODE_READ_QUADLET_RESPONSE	6
#define TCODE_READ_BLOCK_RESPONSE	7
#define TCODE_CYCLE_START		8
#define TCODE_LOCK_REQUEST		9
#define TCODE_STREAM_DATA		10
#define TCODE_LOCK_RESPONSE		11

#define TCODE_IS_READ_REQUEST(tcode)	(((tcode) & ~1) == 4)
#define TCODE_IS_BLOCK_PACKET(tcode)	(((tcode) &  1) != 0)
#define TCODE_IS_REQUEST(tcode)		(((tcode) &  2) == 0)
#define TCODE_IS_RESPONSE(tcode)	(((tcode) &  2) != 0)
#define TCODE_HAS_REQUEST_DATA(tcode)	(((tcode) & 12) != 4)
#define TCODE_HAS_RESPONSE_DATA(tcode)	(((tcode) & 12) != 0)

/* Juju specific tcodes */
#define TCODE_DEALLOCATE		0x10
#define TCODE_LOCK_MASK_SWAP		0x11
#define TCODE_LOCK_COMPARE_SWAP		0x12
#define TCODE_LOCK_FETCH_ADD		0x13
#define TCODE_LOCK_LITTLE_ADD		0x14
#define TCODE_LOCK_BOUNDED_ADD		0x15
#define TCODE_LOCK_WRAP_ADD		0x16
#define TCODE_LOCK_VENDOR_SPECIFIC	0x17

#define SCODE_100			0x0
#define SCODE_200			0x1
#define SCODE_400			0x2
#define SCODE_BETA			0x3

#define EXTCODE_MASK_SWAP	0x1
#define EXTCODE_COMPARE_SWAP	0x2
#define EXTCODE_FETCH_ADD	0x3
#define EXTCODE_LITTLE_ADD	0x4
#define EXTCODE_BOUNDED_ADD	0x5
#define EXTCODE_WRAP_ADD	0x6

#define ACK_COMPLETE		0x1
#define ACK_PENDING		0x2
#define ACK_BUSY_X		0x4
#define ACK_BUSY_A		0x5
#define ACK_BUSY_B		0x6
#define ACK_DATA_ERROR		0xd
#define ACK_TYPE_ERROR		0xe

#define RCODE_COMPLETE		0x0
#define RCODE_CONFLICT_ERROR	0x4
#define RCODE_DATA_ERROR	0x5
#define RCODE_TYPE_ERROR	0x6
#define RCODE_ADDRESS_ERROR	0x7

/* Juju specific rcodes */
#define RCODE_SEND_ERROR	0x10
#define RCODE_CANCELLED		0x11
#define RCODE_BUSY		0x12
#define RCODE_GENERATION	0x13
#define RCODE_NO_ACK		0x14

#define RETRY_1	0x00
#define RETRY_X	0x01
#define RETRY_A	0x02
#define RETRY_B	0x03

#define LOCAL_BUS 0xffc0

#define SELFID_PORT_CHILD	0x3
#define SELFID_PORT_PARENT	0x2
#define SELFID_PORT_NCONN	0x1
#define SELFID_PORT_NONE	0x0

#define PHY_PACKET_CONFIG	0x0
#define PHY_PACKET_LINK_ON	0x1
#define PHY_PACKET_SELF_ID	0x2

#define CSR_REGISTER_BASE		0xfffff0000000ULL

/* register offsets relative to CSR_REGISTER_BASE */
#define CSR_STATE_CLEAR			0x0
#define CSR_STATE_SET			0x4
#define CSR_NODE_IDS			0x8
#define CSR_RESET_START			0xc
#define CSR_SPLIT_TIMEOUT_HI		0x18
#define CSR_SPLIT_TIMEOUT_LO		0x1c
#define CSR_CYCLE_TIME			0x200
#define CSR_BUS_TIME			0x204
#define CSR_BUSY_TIMEOUT		0x210
#define CSR_BUS_MANAGER_ID		0x21c
#define CSR_BANDWIDTH_AVAILABLE		0x220
#define CSR_CHANNELS_AVAILABLE		0x224
#define CSR_CHANNELS_AVAILABLE_HI	0x224
#define CSR_CHANNELS_AVAILABLE_LO	0x228
#define CSR_BROADCAST_CHANNEL		0x234
#define CSR_CONFIG_ROM			0x400
#define CSR_CONFIG_ROM_END		0x800
#define CSR_FCP_COMMAND			0xB00
#define CSR_FCP_RESPONSE		0xD00
#define CSR_FCP_END			0xF00
#define CSR_TOPOLOGY_MAP		0x1000
#define CSR_TOPOLOGY_MAP_END		0x1400
#define CSR_SPEED_MAP			0x2000
#define CSR_SPEED_MAP_END		0x3000

#define fw_notify(s, args...) printk(KERN_NOTICE KBUILD_MODNAME ": " s, ## args)
#define fw_error(s, args...) printk(KERN_ERR KBUILD_MODNAME ": " s, ## args)
#define fw_debug(s, args...) printk(KERN_DEBUG KBUILD_MODNAME ": " s, ## args)

static inline void
fw_memcpy_from_be32(void *_dst, void *_src, size_t size)
{
	u32 *dst = _dst;
	u32 *src = _src;
	int i;

	for (i = 0; i < size / 4; i++)
		dst[i] = cpu_to_be32(src[i]);
}

static inline void
fw_memcpy_to_be32(void *_dst, void *_src, size_t size)
{
	fw_memcpy_from_be32(_dst, _src, size);
}

struct fw_card;
struct fw_packet;
struct fw_node;
struct fw_request;

struct fw_descriptor {
	struct list_head link;
	size_t length;
	u32 key;
	const u32 *data;
};

int fw_core_add_descriptor (struct fw_descriptor *desc);
void fw_core_remove_descriptor (struct fw_descriptor *desc);

typedef void (*fw_packet_callback_t) (struct fw_packet *packet,
				      struct fw_card *card, int status);

typedef void (*fw_transaction_callback_t)(struct fw_card *card, int rcode,
					  void *data,
					  size_t length,
					  void *callback_data);

typedef void (*fw_address_callback_t)(struct fw_card *card,
				      struct fw_request *request,
				      int tcode, int destination, int source,
				      int generation, int speed,
				      unsigned long long offset,
				      void *data, size_t length,
				      void *callback_data);

typedef void (*fw_bus_reset_callback_t)(struct fw_card *handle,
					int node_id, int generation,
					u32 *self_ids,
					int self_id_count,
					void *callback_data);

struct fw_packet {
	int speed;
	int generation;
	u32 header[4];
	size_t header_length;
	void *payload;
	size_t payload_length;
	u32 timestamp;

	dma_addr_t payload_bus;

	/* This callback is called when the packet transmission has
	 * completed; for successful transmission, the status code is
	 * the ack received from the destination, otherwise it's a
	 * negative errno: ENOMEM, ESTALE, ETIMEDOUT, ENODEV, EIO.
	 * The callback can be called from tasklet context and thus
	 * must never block.
	 */
	fw_packet_callback_t callback;
	int ack;
	struct list_head link;
};

struct fw_transaction {
	int node_id; /* The generation is implied; it is always the current. */
	int tlabel;
	int timestamp;
	struct list_head link;

	struct fw_packet packet;

	/* The data passed to the callback is valid only during the
	 * callback.  */
	fw_transaction_callback_t callback;
	void *callback_data;
};

static inline struct fw_packet *
fw_packet(struct list_head *l)
{
	return list_entry (l, struct fw_packet, link);
}

struct fw_address_handler {
	u64 offset;
	size_t length;
	fw_address_callback_t address_callback;
	void *callback_data;
	struct list_head link;
};


struct fw_address_region {
	u64 start;
	u64 end;
};

extern const struct fw_address_region fw_low_memory_region;
extern const struct fw_address_region fw_high_memory_region;
extern const struct fw_address_region fw_private_region;
extern const struct fw_address_region fw_csr_region;
extern const struct fw_address_region fw_unit_space_region;

int fw_core_add_address_handler(struct fw_address_handler *handler,
				const struct fw_address_region *region);
void fw_core_remove_address_handler(struct fw_address_handler *handler);
void fw_fill_response(struct fw_packet *response, u32 *request_header,
		      int rcode, void *payload, size_t length);
void fw_send_response(struct fw_card *card,
		      struct fw_request *request, int rcode);

extern struct bus_type fw_bus_type;

struct fw_card {
	const struct fw_card_driver *driver;
	struct device *device;

	int node_id;
	int generation;
	/* This is the generation used for timestamping incoming requests. */
	int request_generation;
	int current_tlabel, tlabel_mask;
	struct list_head transaction_list;
	struct timer_list flush_timer;

	unsigned long long guid;
	int max_receive;
	int link_speed;
	int config_rom_generation;

	/* We need to store up to 4 self ID for a maximum of 63 devices. */
	int self_id_count;
	u32 self_ids[252];

	spinlock_t lock; /* Take this lock when handling the lists in
			  * this struct. */
	struct fw_node *local_node;
	struct fw_node *root_node;
	struct fw_node *irm_node;
	int color;
	int gap_count;
	int topology_type;

	int index;

	struct device card_device;

	struct list_head link;

	/* Work struct for IRM duties. */
	struct delayed_work work;
	int irm_retries;
};

struct fw_card *fw_card_get(struct fw_card *card);
void fw_card_put(struct fw_card *card);

/* The iso packet format allows for an immediate header/payload part
 * stored in 'header' immediately after the packet info plus an
 * indirect payload part that is pointer to by the 'payload' field.
 * Applications can use one or the other or both to implement simple
 * low-bandwidth streaming (e.g. audio) or more advanced
 * scatter-gather streaming (e.g. assembling video frame automatically). */

struct fw_iso_packet {
	u16 payload_length;	/* Length of indirect payload. */
	u32 interrupt : 1;	/* Generate interrupt on this packet */
	u32 skip : 1;		/* Set to not send packet at all. */
	u32 tag : 2;
	u32 sy : 4;
	u32 header_length : 8;	/* Length of immediate header. */
	u32 header[0];
};

#define FW_ISO_CONTEXT_TRANSMIT	0
#define FW_ISO_CONTEXT_RECEIVE	1

struct fw_iso_context;

typedef void (*fw_iso_callback_t) (struct fw_iso_context *context,
				   int status, u32 cycle, void *data);

struct fw_iso_context {
	struct fw_card *card;
	int type;
	int channel;
	int speed;
	fw_iso_callback_t callback;
	void *callback_data;

	void *buffer;
	size_t buffer_size;
	dma_addr_t *pages;
	int page_count;
};

struct fw_iso_context *
fw_iso_context_create(struct fw_card *card, int type,
		      size_t buffer_size,
		      fw_iso_callback_t callback,
		      void *callback_data);

void
fw_iso_context_destroy(struct fw_iso_context *ctx);

void
fw_iso_context_start(struct fw_iso_context *ctx,
		     int channel, int speed, int cycle);

int
fw_iso_context_queue(struct fw_iso_context *ctx,
		     struct fw_iso_packet *packet, void *payload);

int
fw_iso_context_send(struct fw_iso_context *ctx,
		    int channel, int speed, int cycle);

struct fw_card_driver {
	const char *name;

	/* Enable the given card with the given initial config rom.
	 * This function is expected to activate the card, and either
	 * enable the PHY or set the link_on bit and initiate a bus
	 * reset. */
	int (*enable) (struct fw_card *card, u32 *config_rom, size_t length);

	int (*update_phy_reg) (struct fw_card *card, int address,
			       int clear_bits, int set_bits);

	/* Update the config rom for an enabled card.  This function
	 * should change the config rom that is presented on the bus
	 * an initiate a bus reset. */
	int (*set_config_rom) (struct fw_card *card,
			       u32 *config_rom, size_t length);

	void (*send_request) (struct fw_card *card, struct fw_packet *packet);
	void (*send_response) (struct fw_card *card, struct fw_packet *packet);

	/* Allow the specified node ID to do direct DMA out and in of
	 * host memory.  The card will disable this for all node when
	 * a bus reset happens, so driver need to reenable this after
	 * bus reset.  Returns 0 on success, -ENODEV if the card
	 * doesn't support this, -ESTALE if the generation doesn't
	 * match. */
	int (*enable_phys_dma) (struct fw_card *card,
				int node_id, int generation);

	struct fw_iso_context *
	(*allocate_iso_context)(struct fw_card *card, int type);
	void (*free_iso_context)(struct fw_iso_context *ctx);

	int (*send_iso)(struct fw_iso_context *ctx, s32 cycle);

	int (*queue_iso)(struct fw_iso_context *ctx,
			 struct fw_iso_packet *packet, void *payload);
};

int
fw_core_initiate_bus_reset(struct fw_card *card, int short_reset);

void
fw_send_request(struct fw_card *card, struct fw_transaction *t,
		int tcode, int node_id, int generation, int speed,
		unsigned long long offset,
		void *data, size_t length,
		fw_transaction_callback_t callback, void *callback_data);

void fw_flush_transactions(struct fw_card *card);

void fw_send_phy_config(struct fw_card *card,
			int node_id, int generation, int gap_count);

/* Called by the topology code to inform the device code of node
 * activity; found, lost, or updated nodes */
void
fw_node_event(struct fw_card *card, struct fw_node *node, int event);

/* API used by card level drivers */

/* Do we need phy speed here also?  If we add more args, maybe we
   should go back to struct fw_card_info. */
void
fw_card_initialize(struct fw_card *card, const struct fw_card_driver *driver,
		   struct device *device);
int
fw_card_add(struct fw_card *card,
	    u32 max_receive, u32 link_speed, u64 guid);

void
fw_core_remove_card(struct fw_card *card);

void
fw_core_handle_bus_reset(struct fw_card *card,
			 int node_id, int generation,
			 int self_id_count, u32 *self_ids);
void
fw_core_handle_request(struct fw_card *card, struct fw_packet *request);

void
fw_core_handle_response(struct fw_card *card, struct fw_packet *packet);

#endif /* __fw_transaction_h */
Commit	Line	Data
3038e353 KH	1	/* -- c-basic-offset: 8 --
	2	*
	3	* fw-transaction.h - Header for IEEE1394 transaction logic
	4	*
	5	* Copyright (C) 2003-2006 Kristian Hoegsberg <krh@bitplanet.net>
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; either version 2 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software Foundation,
	19	* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	20	*/
	21
687198bb SR	22	#ifndef __fw_transaction_h
687198bb SR	23	#define __fw_transaction_h
3038e353 KH	24
	25	#include <linux/device.h>
	26	#include <linux/timer.h>
	27	#include <linux/interrupt.h>
	28	#include <linux/list.h>
	29	#include <linux/fs.h>
	30
	31	#define TCODE_WRITE_QUADLET_REQUEST 0
	32	#define TCODE_WRITE_BLOCK_REQUEST 1
	33	#define TCODE_WRITE_RESPONSE 2
	34	#define TCODE_READ_QUADLET_REQUEST 4
	35	#define TCODE_READ_BLOCK_REQUEST 5
	36	#define TCODE_READ_QUADLET_RESPONSE 6
	37	#define TCODE_READ_BLOCK_RESPONSE 7
	38	#define TCODE_CYCLE_START 8
5e20c282 SR	39	#define TCODE_LOCK_REQUEST 9
	40	#define TCODE_STREAM_DATA 10
	41	#define TCODE_LOCK_RESPONSE 11
3038e353	42
93c4cceb	43	#define TCODE_IS_READ_REQUEST(tcode) (((tcode) & ~1) == 4)
3038e353 KH	44	#define TCODE_IS_BLOCK_PACKET(tcode) (((tcode) & 1) != 0)
	45	#define TCODE_IS_REQUEST(tcode) (((tcode) & 2) == 0)
	46	#define TCODE_IS_RESPONSE(tcode) (((tcode) & 2) != 0)
	47	#define TCODE_HAS_REQUEST_DATA(tcode) (((tcode) & 12) != 4)
	48	#define TCODE_HAS_RESPONSE_DATA(tcode) (((tcode) & 12) != 0)
	49
	50	/* Juju specific tcodes */
	51	#define TCODE_DEALLOCATE 0x10
	52	#define TCODE_LOCK_MASK_SWAP 0x11
	53	#define TCODE_LOCK_COMPARE_SWAP 0x12
	54	#define TCODE_LOCK_FETCH_ADD 0x13
	55	#define TCODE_LOCK_LITTLE_ADD 0x14
	56	#define TCODE_LOCK_BOUNDED_ADD 0x15
	57	#define TCODE_LOCK_WRAP_ADD 0x16
	58	#define TCODE_LOCK_VENDOR_SPECIFIC 0x17
	59
	60	#define SCODE_100 0x0
	61	#define SCODE_200 0x1
	62	#define SCODE_400 0x2
	63	#define SCODE_BETA 0x3
	64
5e20c282 SR	65	#define EXTCODE_MASK_SWAP 0x1
	66	#define EXTCODE_COMPARE_SWAP 0x2
	67	#define EXTCODE_FETCH_ADD 0x3
	68	#define EXTCODE_LITTLE_ADD 0x4
	69	#define EXTCODE_BOUNDED_ADD 0x5
	70	#define EXTCODE_WRAP_ADD 0x6
	71
	72	#define ACK_COMPLETE 0x1
	73	#define ACK_PENDING 0x2
	74	#define ACK_BUSY_X 0x4
	75	#define ACK_BUSY_A 0x5
	76	#define ACK_BUSY_B 0x6
	77	#define ACK_DATA_ERROR 0xd
	78	#define ACK_TYPE_ERROR 0xe
	79
	80	#define RCODE_COMPLETE 0x0
	81	#define RCODE_CONFLICT_ERROR 0x4
	82	#define RCODE_DATA_ERROR 0x5
	83	#define RCODE_TYPE_ERROR 0x6
	84	#define RCODE_ADDRESS_ERROR 0x7
3038e353 KH	85
	86	/* Juju specific rcodes */
	87	#define RCODE_SEND_ERROR 0x10
	88	#define RCODE_CANCELLED 0x11
	89	#define RCODE_BUSY 0x12
e5f49c3b KH	90	#define RCODE_GENERATION 0x13
e5f49c3b KH	91	#define RCODE_NO_ACK 0x14
3038e353 KH	92
	93	#define RETRY_1 0x00
	94	#define RETRY_X 0x01
	95	#define RETRY_A 0x02
	96	#define RETRY_B 0x03
	97
	98	#define LOCAL_BUS 0xffc0
	99
5e20c282 SR	100	#define SELFID_PORT_CHILD 0x3
	101	#define SELFID_PORT_PARENT 0x2
	102	#define SELFID_PORT_NCONN 0x1
	103	#define SELFID_PORT_NONE 0x0
3038e353 KH	104
	105	#define PHY_PACKET_CONFIG 0x0
	106	#define PHY_PACKET_LINK_ON 0x1
	107	#define PHY_PACKET_SELF_ID 0x2
	108
93c4cceb KH	109	#define CSR_REGISTER_BASE 0xfffff0000000ULL
	110
	111	/* register offsets relative to CSR_REGISTER_BASE */
	112	#define CSR_STATE_CLEAR 0x0
	113	#define CSR_STATE_SET 0x4
	114	#define CSR_NODE_IDS 0x8
	115	#define CSR_RESET_START 0xc
	116	#define CSR_SPLIT_TIMEOUT_HI 0x18
	117	#define CSR_SPLIT_TIMEOUT_LO 0x1c
	118	#define CSR_CYCLE_TIME 0x200
	119	#define CSR_BUS_TIME 0x204
	120	#define CSR_BUSY_TIMEOUT 0x210
	121	#define CSR_BUS_MANAGER_ID 0x21c
	122	#define CSR_BANDWIDTH_AVAILABLE 0x220
	123	#define CSR_CHANNELS_AVAILABLE 0x224
	124	#define CSR_CHANNELS_AVAILABLE_HI 0x224
	125	#define CSR_CHANNELS_AVAILABLE_LO 0x228
	126	#define CSR_BROADCAST_CHANNEL 0x234
	127	#define CSR_CONFIG_ROM 0x400
	128	#define CSR_CONFIG_ROM_END 0x800
	129	#define CSR_FCP_COMMAND 0xB00
	130	#define CSR_FCP_RESPONSE 0xD00
	131	#define CSR_FCP_END 0xF00
	132	#define CSR_TOPOLOGY_MAP 0x1000
	133	#define CSR_TOPOLOGY_MAP_END 0x1400
	134	#define CSR_SPEED_MAP 0x2000
	135	#define CSR_SPEED_MAP_END 0x3000
	136
3038e353 KH	137	#define fw_notify(s, args...) printk(KERN_NOTICE KBUILD_MODNAME ": " s, ## args)
	138	#define fw_error(s, args...) printk(KERN_ERR KBUILD_MODNAME ": " s, ## args)
	139	#define fw_debug(s, args...) printk(KERN_DEBUG KBUILD_MODNAME ": " s, ## args)
	140
	141	static inline void
	142	fw_memcpy_from_be32(void _dst, void _src, size_t size)
	143	{
	144	u32 *dst = _dst;
	145	u32 *src = _src;
	146	int i;
	147
	148	for (i = 0; i < size / 4; i++)
	149	dst[i] = cpu_to_be32(src[i]);
	150	}
	151
	152	static inline void
	153	fw_memcpy_to_be32(void _dst, void _src, size_t size)
	154	{
	155	fw_memcpy_from_be32(_dst, _src, size);
	156	}
	157
	158	struct fw_card;
	159	struct fw_packet;
	160	struct fw_node;
	161	struct fw_request;
	162
	163	struct fw_descriptor {
	164	struct list_head link;
	165	size_t length;
	166	u32 key;
21ebcd12	167	const u32 *data;
3038e353 KH	168	};
	169
	170	int fw_core_add_descriptor (struct fw_descriptor *desc);
	171	void fw_core_remove_descriptor (struct fw_descriptor *desc);
	172
	173	typedef void (fw_packet_callback_t) (struct fw_packet packet,
	174	struct fw_card *card, int status);
	175
	176	typedef void (fw_transaction_callback_t)(struct fw_card card, int rcode,
	177	void *data,
	178	size_t length,
	179	void *callback_data);
	180
	181	typedef void (fw_address_callback_t)(struct fw_card card,
	182	struct fw_request *request,
	183	int tcode, int destination, int source,
	184	int generation, int speed,
	185	unsigned long long offset,
	186	void *data, size_t length,
	187	void *callback_data);
	188
	189	typedef void (fw_bus_reset_callback_t)(struct fw_card handle,
	190	int node_id, int generation,
	191	u32 *self_ids,
	192	int self_id_count,
	193	void *callback_data);
	194
	195	struct fw_packet {
5e20c282 SR	196	int speed;
	197	int generation;
	198	u32 header[4];
	199	size_t header_length;
	200	void *payload;
	201	size_t payload_length;
	202	u32 timestamp;
	203
	204	dma_addr_t payload_bus;
	205
	206	/* This callback is called when the packet transmission has
	207	* completed; for successful transmission, the status code is
	208	* the ack received from the destination, otherwise it's a
	209	* negative errno: ENOMEM, ESTALE, ETIMEDOUT, ENODEV, EIO.
	210	* The callback can be called from tasklet context and thus
	211	* must never block.
	212	*/
	213	fw_packet_callback_t callback;
2639a6fb	214	int ack;
5e20c282	215	struct list_head link;
3038e353 KH	216	};
	217
	218	struct fw_transaction {
5e20c282 SR	219	int node_id; /* The generation is implied; it is always the current. */
	220	int tlabel;
	221	int timestamp;
	222	struct list_head link;
3038e353	223
5e20c282	224	struct fw_packet packet;
3038e353 KH	225
	226	/* The data passed to the callback is valid only during the
	227	* callback. */
5e20c282 SR	228	fw_transaction_callback_t callback;
5e20c282 SR	229	void *callback_data;
3038e353 KH	230	};
3038e353 KH	231
95688e97	232	static inline struct fw_packet *
3038e353 KH	233	fw_packet(struct list_head *l)
3038e353 KH	234	{
5e20c282	235	return list_entry (l, struct fw_packet, link);
3038e353 KH	236	}
	237
	238	struct fw_address_handler {
5e20c282 SR	239	u64 offset;
	240	size_t length;
	241	fw_address_callback_t address_callback;
	242	void *callback_data;
	243	struct list_head link;
3038e353 KH	244	};
	245
	246
	247	struct fw_address_region {
	248	u64 start;
	249	u64 end;
	250	};
	251
21ebcd12 SR	252	extern const struct fw_address_region fw_low_memory_region;
	253	extern const struct fw_address_region fw_high_memory_region;
	254	extern const struct fw_address_region fw_private_region;
	255	extern const struct fw_address_region fw_csr_region;
	256	extern const struct fw_address_region fw_unit_space_region;
3038e353 KH	257
3038e353 KH	258	int fw_core_add_address_handler(struct fw_address_handler *handler,
21ebcd12	259	const struct fw_address_region *region);
3038e353	260	void fw_core_remove_address_handler(struct fw_address_handler *handler);
93c4cceb KH	261	void fw_fill_response(struct fw_packet response, u32 request_header,
93c4cceb KH	262	int rcode, void *payload, size_t length);
3038e353 KH	263	void fw_send_response(struct fw_card *card,
	264	struct fw_request *request, int rcode);
	265
	266	extern struct bus_type fw_bus_type;
	267
	268	struct fw_card {
21ebcd12	269	const struct fw_card_driver *driver;
3038e353 KH	270	struct device *device;
3038e353 KH	271
5e20c282 SR	272	int node_id;
	273	int generation;
	274	/* This is the generation used for timestamping incoming requests. */
	275	int request_generation;
	276	int current_tlabel, tlabel_mask;
	277	struct list_head transaction_list;
3038e353 KH	278	struct timer_list flush_timer;
3038e353 KH	279
5e20c282	280	unsigned long long guid;
3038e353 KH	281	int max_receive;
	282	int link_speed;
	283	int config_rom_generation;
	284
5e20c282 SR	285	/* We need to store up to 4 self ID for a maximum of 63 devices. */
	286	int self_id_count;
	287	u32 self_ids[252];
3038e353 KH	288
	289	spinlock_t lock; /* Take this lock when handling the lists in
	290	* this struct. */
	291	struct fw_node *local_node;
	292	struct fw_node *root_node;
	293	struct fw_node *irm_node;
	294	int color;
83db801c KH	295	int gap_count;
83db801c KH	296	int topology_type;
3038e353 KH	297
	298	int index;
	299
	300	struct device card_device;
	301
	302	struct list_head link;
19a15b93 KH	303
	304	/* Work struct for IRM duties. */
	305	struct delayed_work work;
	306	int irm_retries;
3038e353 KH	307	};
	308
	309	struct fw_card fw_card_get(struct fw_card card);
	310	void fw_card_put(struct fw_card *card);
	311
	312	/* The iso packet format allows for an immediate header/payload part
	313	* stored in 'header' immediately after the packet info plus an
	314	* indirect payload part that is pointer to by the 'payload' field.
	315	* Applications can use one or the other or both to implement simple
	316	* low-bandwidth streaming (e.g. audio) or more advanced
	317	* scatter-gather streaming (e.g. assembling video frame automatically). */
	318
	319	struct fw_iso_packet {
5e20c282	320	u16 payload_length; /* Length of indirect payload. */
3038e353 KH	321	u32 interrupt : 1; /* Generate interrupt on this packet */
	322	u32 skip : 1; /* Set to not send packet at all. */
	323	u32 tag : 2;
	324	u32 sy : 4;
	325	u32 header_length : 8; /* Length of immediate header. */
5e20c282	326	u32 header[0];
3038e353 KH	327	};
	328
	329	#define FW_ISO_CONTEXT_TRANSMIT 0
	330	#define FW_ISO_CONTEXT_RECEIVE 1
	331
	332	struct fw_iso_context;
	333
	334	typedef void (fw_iso_callback_t) (struct fw_iso_context context,
	335	int status, u32 cycle, void *data);
	336
	337	struct fw_iso_context {
	338	struct fw_card *card;
	339	int type;
	340	int channel;
	341	int speed;
	342	fw_iso_callback_t callback;
	343	void *callback_data;
	344
	345	void *buffer;
	346	size_t buffer_size;
	347	dma_addr_t *pages;
	348	int page_count;
	349	};
	350
	351	struct fw_iso_context *
	352	fw_iso_context_create(struct fw_card *card, int type,
	353	size_t buffer_size,
	354	fw_iso_callback_t callback,
	355	void *callback_data);
	356
	357	void
	358	fw_iso_context_destroy(struct fw_iso_context *ctx);
	359
	360	void
	361	fw_iso_context_start(struct fw_iso_context *ctx,
	362	int channel, int speed, int cycle);
	363
	364	int
	365	fw_iso_context_queue(struct fw_iso_context *ctx,
	366	struct fw_iso_packet packet, void payload);
	367
	368	int
	369	fw_iso_context_send(struct fw_iso_context *ctx,
	370	int channel, int speed, int cycle);
	371
	372	struct fw_card_driver {
5e20c282	373	const char *name;
3038e353	374
5e20c282 SR	375	/* Enable the given card with the given initial config rom.
	376	* This function is expected to activate the card, and either
	377	* enable the PHY or set the link_on bit and initiate a bus
	378	* reset. */
	379	int (enable) (struct fw_card card, u32 *config_rom, size_t length);
3038e353	380
5e20c282 SR	381	int (update_phy_reg) (struct fw_card card, int address,
5e20c282 SR	382	int clear_bits, int set_bits);
3038e353	383
5e20c282 SR	384	/* Update the config rom for an enabled card. This function
	385	* should change the config rom that is presented on the bus
	386	* an initiate a bus reset. */
	387	int (set_config_rom) (struct fw_card card,
3038e353 KH	388	u32 *config_rom, size_t length);
3038e353 KH	389
5e20c282 SR	390	void (send_request) (struct fw_card card, struct fw_packet *packet);
5e20c282 SR	391	void (send_response) (struct fw_card card, struct fw_packet *packet);
3038e353 KH	392
	393	/* Allow the specified node ID to do direct DMA out and in of
	394	* host memory. The card will disable this for all node when
	395	* a bus reset happens, so driver need to reenable this after
	396	* bus reset. Returns 0 on success, -ENODEV if the card
	397	* doesn't support this, -ESTALE if the generation doesn't
	398	* match. */
	399	int (enable_phys_dma) (struct fw_card card,
	400	int node_id, int generation);
	401
	402	struct fw_iso_context *
	403	(allocate_iso_context)(struct fw_card card, int type);
	404	void (free_iso_context)(struct fw_iso_context ctx);
	405
	406	int (send_iso)(struct fw_iso_context ctx, s32 cycle);
	407
	408	int (queue_iso)(struct fw_iso_context ctx,
	409	struct fw_iso_packet packet, void payload);
	410	};
	411
	412	int
	413	fw_core_initiate_bus_reset(struct fw_card *card, int short_reset);
	414
	415	void
	416	fw_send_request(struct fw_card card, struct fw_transaction t,
	417	int tcode, int node_id, int generation, int speed,
	418	unsigned long long offset,
	419	void *data, size_t length,
	420	fw_transaction_callback_t callback, void *callback_data);
	421
	422	void fw_flush_transactions(struct fw_card *card);
	423
83db801c KH	424	void fw_send_phy_config(struct fw_card *card,
83db801c KH	425	int node_id, int generation, int gap_count);
3038e353 KH	426
	427	/* Called by the topology code to inform the device code of node
	428	* activity; found, lost, or updated nodes */
	429	void
	430	fw_node_event(struct fw_card card, struct fw_node node, int event);
	431
	432	/* API used by card level drivers */
	433
	434	/* Do we need phy speed here also? If we add more args, maybe we
	435	should go back to struct fw_card_info. */
	436	void
21ebcd12	437	fw_card_initialize(struct fw_card card, const struct fw_card_driver driver,
3038e353 KH	438	struct device *device);
	439	int
	440	fw_card_add(struct fw_card *card,
	441	u32 max_receive, u32 link_speed, u64 guid);
	442
	443	void
	444	fw_core_remove_card(struct fw_card *card);
	445
	446	void
	447	fw_core_handle_bus_reset(struct fw_card *card,
	448	int node_id, int generation,
	449	int self_id_count, u32 *self_ids);
	450	void
2639a6fb	451	fw_core_handle_request(struct fw_card card, struct fw_packet request);
3038e353	452
2639a6fb KH	453	void
2639a6fb KH	454	fw_core_handle_response(struct fw_card card, struct fw_packet packet);
3038e353	455
687198bb	456	#endif /* __fw_transaction_h */