drivers/firewire/fw-transaction.h - kernel/msm - Gitiles

 /*						-*- 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_core_h
 #define __fw_core_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_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 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 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;
 	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 status;
         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;
 };

 extern 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 struct fw_address_region fw_low_memory_region;
 extern struct fw_address_region fw_high_memory_region;
 extern struct fw_address_region fw_private_region;
 extern struct fw_address_region fw_csr_region;
 extern struct fw_address_region fw_unit_space_region;

 int fw_core_add_address_handler(struct fw_address_handler *handler,
 				struct fw_address_region *region);
 void fw_core_remove_address_handler(struct fw_address_handler *handler);
 void fw_send_response(struct fw_card *card,
 		      struct fw_request *request, int rcode);

 extern struct bus_type fw_bus_type;

 struct fw_card {
         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 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_force_root(struct fw_card *card, int node_id, int generation);

 /* 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, 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,
 		       int speed, int ack, int timestamp,
 		       int generation,
 		       u32 length, u32 *payload);
 void
 fw_core_handle_response(struct fw_card *card,
                         int speed, int ack, int timestamp,
                         u32 length, u32 *payload);


 #endif /* __fw_core_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_core_h
	#define __fw_core_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_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 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 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;
	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 status;
	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;
	};

	extern 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 struct fw_address_region fw_low_memory_region;
	extern struct fw_address_region fw_high_memory_region;
	extern struct fw_address_region fw_private_region;
	extern struct fw_address_region fw_csr_region;
	extern struct fw_address_region fw_unit_space_region;

	int fw_core_add_address_handler(struct fw_address_handler *handler,
	struct fw_address_region *region);
	void fw_core_remove_address_handler(struct fw_address_handler *handler);
	void fw_send_response(struct fw_card *card,
	struct fw_request *request, int rcode);

	extern struct bus_type fw_bus_type;

	struct fw_card {
	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 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_force_root(struct fw_card *card, int node_id, int generation);

	/* 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, 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,
	int speed, int ack, int timestamp,
	int generation,
	u32 length, u32 *payload);
	void
	fw_core_handle_response(struct fw_card *card,
	int speed, int ack, int timestamp,
	u32 length, u32 *payload);


	#endif /* __fw_core_h */