[GitHub/mt8127/android_kernel_alcatel_ttab.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>
#include <linux/dma-mapping.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

/* Bit fields _within_ the PHY registers. */
#define PHY_LINK_ACTIVE		0x80
#define PHY_CONTENDER		0x40
#define PHY_BUS_RESET		0x40
#define PHY_BUS_SHORT_RESET	0x40

#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 immediate;
	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;

	/* 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;
	void *driver_data;
};

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;
	struct kref kref;

	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 reset_jiffies;

	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 plus 3 words for the topology map header. */
	int self_id_count;
	u32 topology_map[252 + 3];

	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 list_head link;

	/* Work struct for BM duties. */
	struct delayed_work work;
	int bm_retries;
	int bm_generation;
};

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

#define FW_ISO_CONTEXT_MATCH_TAG0	 1
#define FW_ISO_CONTEXT_MATCH_TAG1	 2
#define FW_ISO_CONTEXT_MATCH_TAG2	 4
#define FW_ISO_CONTEXT_MATCH_TAG3	 8
#define FW_ISO_CONTEXT_MATCH_ALL_TAGS	15

struct fw_iso_context;

typedef void (*fw_iso_callback_t) (struct fw_iso_context *context,
				   u32 cycle,
				   size_t header_length,
				   void *header,
				   void *data);

/* An iso buffer is just a set of pages mapped for DMA in the
 * specified direction.  Since the pages are to be used for DMA, they
 * are not mapped into the kernel virtual address space.  We store the
 * DMA address in the page private. The helper function
 * fw_iso_buffer_map() will map the pages into a given vma. */

struct fw_iso_buffer {
	enum dma_data_direction direction;
	struct page **pages;
	int page_count;
};

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

int
fw_iso_buffer_init(struct fw_iso_buffer *buffer,
		   struct fw_card *card,
		   int page_count,
		   enum dma_data_direction direction);
int
fw_iso_buffer_map(struct fw_iso_buffer *buffer, struct vm_area_struct *vma);
void
fw_iso_buffer_destroy(struct fw_iso_buffer *buffer, struct fw_card *card);

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

void
fw_iso_context_destroy(struct fw_iso_context *ctx);

int
fw_iso_context_queue(struct fw_iso_context *ctx,
		     struct fw_iso_packet *packet,
		     struct fw_iso_buffer *buffer,
		     unsigned long payload);

int
fw_iso_context_start(struct fw_iso_context *ctx,
		     int cycle, int sync, int tags);

int
fw_iso_context_stop(struct fw_iso_context *ctx);

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);
	/* Calling cancel is valid once a packet has been submitted. */
	int (*cancel_packet) (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);

	u64 (*get_bus_time) (struct fw_card *card);

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

	int (*start_iso)(struct fw_iso_context *ctx,
			 s32 cycle, u32 sync, u32 tags);

	int (*queue_iso)(struct fw_iso_context *ctx,
			 struct fw_iso_packet *packet,
			 struct fw_iso_buffer *buffer,
			 unsigned long payload);

	int (*stop_iso)(struct fw_iso_context *ctx);
};

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);

int fw_cancel_transaction(struct fw_card *card,
			  struct fw_transaction *transaction);

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