[linux-block.git] / include / linux / firewire.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _LINUX_FIREWIRE_H
#define _LINUX_FIREWIRE_H

#include <linux/completion.h>
#include <linux/device.h>
#include <linux/dma-mapping.h>
#include <linux/kernel.h>
#include <linux/kref.h>
#include <linux/list.h>
#include <linux/mutex.h>
#include <linux/spinlock.h>
#include <linux/sysfs.h>
#include <linux/timer.h>
#include <linux/types.h>
#include <linux/workqueue.h>

#include <linux/atomic.h>
#include <asm/byteorder.h>

#define CSR_REGISTER_BASE		0xfffff0000000ULL

/* register offsets are 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_PRIORITY_BUDGET		0x218
#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_MAINT_UTILITY		0x230
#define CSR_BROADCAST_CHANNEL		0x234
#define CSR_CONFIG_ROM			0x400
#define CSR_CONFIG_ROM_END		0x800
#define CSR_OMPR			0x900
#define CSR_OPCR(i)			(0x904 + (i) * 4)
#define CSR_IMPR			0x980
#define CSR_IPCR(i)			(0x984 + (i) * 4)
#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 CSR_OFFSET		0x40
#define CSR_LEAF		0x80
#define CSR_DIRECTORY		0xc0

#define CSR_DESCRIPTOR		0x01
#define CSR_VENDOR		0x03
#define CSR_HARDWARE_VERSION	0x04
#define CSR_UNIT		0x11
#define CSR_SPECIFIER_ID	0x12
#define CSR_VERSION		0x13
#define CSR_DEPENDENT_INFO	0x14
#define CSR_MODEL		0x17
#define CSR_DIRECTORY_ID	0x20

struct fw_csr_iterator {
	const u32 *p;
	const u32 *end;
};

void fw_csr_iterator_init(struct fw_csr_iterator *ci, const u32 *p);
int fw_csr_iterator_next(struct fw_csr_iterator *ci, int *key, int *value);
int fw_csr_string(const u32 *directory, int key, char *buf, size_t size);

extern struct bus_type fw_bus_type;

struct fw_card_driver;
struct fw_node;

struct fw_card {
	const struct fw_card_driver *driver;
	struct device *device;
	struct kref kref;
	struct completion done;

	int node_id;
	int generation;
	int current_tlabel;
	u64 tlabel_mask;
	struct list_head transaction_list;
	u64 reset_jiffies;

	u32 split_timeout_hi;
	u32 split_timeout_lo;
	unsigned int split_timeout_cycles;
	unsigned int split_timeout_jiffies;

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

	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;
	u8 color; /* must be u8 to match the definition in struct fw_node */
	int gap_count;
	bool beta_repeaters_present;

	int index;
	struct list_head link;

	struct list_head phy_receiver_list;

	struct delayed_work br_work; /* bus reset job */
	bool br_short;

	struct delayed_work bm_work; /* bus manager job */
	int bm_retries;
	int bm_generation;
	int bm_node_id;
	bool bm_abdicate;

	bool priority_budget_implemented;	/* controller feature */
	bool broadcast_channel_auto_allocated;	/* controller feature */

	bool broadcast_channel_allocated;
	u32 broadcast_channel;
	__be32 topology_map[(CSR_TOPOLOGY_MAP_END - CSR_TOPOLOGY_MAP) / 4];

	__be32 maint_utility_register;
};

static inline struct fw_card *fw_card_get(struct fw_card *card)
{
	kref_get(&card->kref);

	return card;
}

void fw_card_release(struct kref *kref);

static inline void fw_card_put(struct fw_card *card)
{
	kref_put(&card->kref, fw_card_release);
}

int fw_card_read_cycle_time(struct fw_card *card, u32 *cycle_time);

struct fw_attribute_group {
	struct attribute_group *groups[2];
	struct attribute_group group;
	struct attribute *attrs[13];
};

enum fw_device_state {
	FW_DEVICE_INITIALIZING,
	FW_DEVICE_RUNNING,
	FW_DEVICE_GONE,
	FW_DEVICE_SHUTDOWN,
};

/*
 * Note, fw_device.generation always has to be read before fw_device.node_id.
 * Use SMP memory barriers to ensure this.  Otherwise requests will be sent
 * to an outdated node_id if the generation was updated in the meantime due
 * to a bus reset.
 *
 * Likewise, fw-core will take care to update .node_id before .generation so
 * that whenever fw_device.generation is current WRT the actual bus generation,
 * fw_device.node_id is guaranteed to be current too.
 *
 * The same applies to fw_device.card->node_id vs. fw_device.generation.
 *
 * fw_device.config_rom and fw_device.config_rom_length may be accessed during
 * the lifetime of any fw_unit belonging to the fw_device, before device_del()
 * was called on the last fw_unit.  Alternatively, they may be accessed while
 * holding fw_device_rwsem.
 */
struct fw_device {
	atomic_t state;
	struct fw_node *node;
	int node_id;
	int generation;
	unsigned max_speed;
	struct fw_card *card;
	struct device device;

	struct mutex client_list_mutex;
	struct list_head client_list;

	const u32 *config_rom;
	size_t config_rom_length;
	int config_rom_retries;
	unsigned is_local:1;
	unsigned max_rec:4;
	unsigned cmc:1;
	unsigned irmc:1;
	unsigned bc_implemented:2;

	work_func_t workfn;
	struct delayed_work work;
	struct fw_attribute_group attribute_group;
};

#define fw_device(dev)	container_of_const(dev, struct fw_device, device)

static inline int fw_device_is_shutdown(struct fw_device *device)
{
	return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN;
}

int fw_device_enable_phys_dma(struct fw_device *device);

/*
 * fw_unit.directory must not be accessed after device_del(&fw_unit.device).
 */
struct fw_unit {
	struct device device;
	const u32 *directory;
	struct fw_attribute_group attribute_group;
};

#define fw_unit(dev)	container_of_const(dev, struct fw_unit, device)

static inline struct fw_unit *fw_unit_get(struct fw_unit *unit)
{
	get_device(&unit->device);

	return unit;
}

static inline void fw_unit_put(struct fw_unit *unit)
{
	put_device(&unit->device);
}

#define fw_parent_device(unit)	fw_device(unit->device.parent)

struct ieee1394_device_id;

struct fw_driver {
	struct device_driver driver;
	int (*probe)(struct fw_unit *unit, const struct ieee1394_device_id *id);
	/* Called when the parent device sits through a bus reset. */
	void (*update)(struct fw_unit *unit);
	void (*remove)(struct fw_unit *unit);
	const struct ieee1394_device_id *id_table;
};

struct fw_packet;
struct fw_request;

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);
/*
 * This callback handles an inbound request subaction.  It is called in
 * RCU read-side context, therefore must not sleep.
 *
 * The callback should not initiate outbound request subactions directly.
 * Otherwise there is a danger of recursion of inbound and outbound
 * transactions from and to the local node.
 *
 * The callback is responsible that fw_send_response() is called on the @request, except for FCP
 * registers for which the core takes care of that.
 */
typedef void (*fw_address_callback_t)(struct fw_card *card,
				      struct fw_request *request,
				      int tcode, int destination, int source,
				      int generation,
				      unsigned long long offset,
				      void *data, size_t length,
				      void *callback_data);

struct fw_packet {
	int speed;
	int generation;
	u32 header[4];
	size_t header_length;
	void *payload;
	size_t payload_length;
	dma_addr_t payload_bus;
	bool payload_mapped;
	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 is one of the juju-specific
	 * rcodes:  RCODE_SEND_ERROR, _CANCELLED, _BUSY, _GENERATION, _NO_ACK.
	 * 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;
	struct list_head link;
	struct fw_card *card;
	bool is_split_transaction;
	struct timer_list split_timeout_timer;

	struct fw_packet packet;

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

struct fw_address_handler {
	u64 offset;
	u64 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_high_memory_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_send_response(struct fw_card *card,
		      struct fw_request *request, int rcode);
int fw_get_request_speed(struct fw_request *request);
u32 fw_request_get_timestamp(const struct fw_request *request);
void fw_send_request(struct fw_card *card, struct fw_transaction *t,
		     int tcode, int destination_id, int generation, int speed,
		     unsigned long long offset, void *payload, size_t length,
		     fw_transaction_callback_t callback, void *callback_data);
int fw_cancel_transaction(struct fw_card *card,
			  struct fw_transaction *transaction);
int fw_run_transaction(struct fw_card *card, int tcode, int destination_id,
		       int generation, int speed, unsigned long long offset,
		       void *payload, size_t length);
const char *fw_rcode_string(int rcode);

static inline int fw_stream_packet_destination_id(int tag, int channel, int sy)
{
	return tag << 14 | channel << 8 | sy;
}

void fw_schedule_bus_reset(struct fw_card *card, bool delayed,
			   bool short_reset);

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

/*
 * 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;		/* tx: Set to not send packet at all	*/
				/* rx: Sync bit, wait for matching sy	*/
	u32 tag:2;		/* tx: Tag in packet header		*/
	u32 sy:4;		/* tx: Sy in packet header		*/
	u32 header_length:8;	/* Length of immediate header		*/
	u32 header[0];		/* tx: Top of 1394 isoch. data_block	*/
};

#define FW_ISO_CONTEXT_TRANSMIT			0
#define FW_ISO_CONTEXT_RECEIVE			1
#define FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL	2

#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

/*
 * 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;
	int page_count_mapped;
};

int fw_iso_buffer_init(struct fw_iso_buffer *buffer, struct fw_card *card,
		       int page_count, enum dma_data_direction direction);
void fw_iso_buffer_destroy(struct fw_iso_buffer *buffer, struct fw_card *card);
size_t fw_iso_buffer_lookup(struct fw_iso_buffer *buffer, dma_addr_t completed);

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);
typedef void (*fw_iso_mc_callback_t)(struct fw_iso_context *context,
				     dma_addr_t completed, void *data);

union fw_iso_callback {
	fw_iso_callback_t sc;
	fw_iso_mc_callback_t mc;
};

struct fw_iso_context {
	struct fw_card *card;
	int type;
	int channel;
	int speed;
	bool drop_overflow_headers;
	size_t header_size;
	union fw_iso_callback callback;
	void *callback_data;
};

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);
int fw_iso_context_set_channels(struct fw_iso_context *ctx, u64 *channels);
int fw_iso_context_queue(struct fw_iso_context *ctx,
			 struct fw_iso_packet *packet,
			 struct fw_iso_buffer *buffer,
			 unsigned long payload);
void fw_iso_context_queue_flush(struct fw_iso_context *ctx);
int fw_iso_context_flush_completions(struct fw_iso_context *ctx);
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);
void fw_iso_context_destroy(struct fw_iso_context *ctx);
void fw_iso_resource_manage(struct fw_card *card, int generation,
			    u64 channels_mask, int *channel, int *bandwidth,
			    bool allocate);

extern struct workqueue_struct *fw_workqueue;

#endif /* _LINUX_FIREWIRE_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
77c9a5da SR	2	#ifndef _LINUX_FIREWIRE_H
	3	#define _LINUX_FIREWIRE_H
	4
	5	#include <linux/completion.h>
f68c56b7	6	#include <linux/device.h>
c76acec6	7	#include <linux/dma-mapping.h>
77c9a5da SR	8	#include <linux/kernel.h>
	9	#include <linux/kref.h>
	10	#include <linux/list.h>
	11	#include <linux/mutex.h>
	12	#include <linux/spinlock.h>
	13	#include <linux/sysfs.h>
	14	#include <linux/timer.h>
	15	#include <linux/types.h>
	16	#include <linux/workqueue.h>
	17
60063497	18	#include <linux/atomic.h>
77c9a5da SR	19	#include <asm/byteorder.h>
77c9a5da SR	20
77c9a5da SR	21	#define CSR_REGISTER_BASE 0xfffff0000000ULL
	22
	23	/* register offsets are relative to CSR_REGISTER_BASE */
	24	#define CSR_STATE_CLEAR 0x0
	25	#define CSR_STATE_SET 0x4
	26	#define CSR_NODE_IDS 0x8
	27	#define CSR_RESET_START 0xc
	28	#define CSR_SPLIT_TIMEOUT_HI 0x18
	29	#define CSR_SPLIT_TIMEOUT_LO 0x1c
	30	#define CSR_CYCLE_TIME 0x200
	31	#define CSR_BUS_TIME 0x204
	32	#define CSR_BUSY_TIMEOUT 0x210
a1a1132b	33	#define CSR_PRIORITY_BUDGET 0x218
77c9a5da SR	34	#define CSR_BUS_MANAGER_ID 0x21c
	35	#define CSR_BANDWIDTH_AVAILABLE 0x220
	36	#define CSR_CHANNELS_AVAILABLE 0x224
	37	#define CSR_CHANNELS_AVAILABLE_HI 0x224
	38	#define CSR_CHANNELS_AVAILABLE_LO 0x228
3d1f46eb	39	#define CSR_MAINT_UTILITY 0x230
77c9a5da SR	40	#define CSR_BROADCAST_CHANNEL 0x234
	41	#define CSR_CONFIG_ROM 0x400
	42	#define CSR_CONFIG_ROM_END 0x800
31ef9134 CL	43	#define CSR_OMPR 0x900
	44	#define CSR_OPCR(i) (0x904 + (i) * 4)
	45	#define CSR_IMPR 0x980
	46	#define CSR_IPCR(i) (0x984 + (i) * 4)
77c9a5da SR	47	#define CSR_FCP_COMMAND 0xB00
	48	#define CSR_FCP_RESPONSE 0xD00
	49	#define CSR_FCP_END 0xF00
	50	#define CSR_TOPOLOGY_MAP 0x1000
	51	#define CSR_TOPOLOGY_MAP_END 0x1400
	52	#define CSR_SPEED_MAP 0x2000
	53	#define CSR_SPEED_MAP_END 0x3000
	54
	55	#define CSR_OFFSET 0x40
	56	#define CSR_LEAF 0x80
	57	#define CSR_DIRECTORY 0xc0
	58
	59	#define CSR_DESCRIPTOR 0x01
	60	#define CSR_VENDOR 0x03
	61	#define CSR_HARDWARE_VERSION 0x04
77c9a5da SR	62	#define CSR_UNIT 0x11
	63	#define CSR_SPECIFIER_ID 0x12
	64	#define CSR_VERSION 0x13
	65	#define CSR_DEPENDENT_INFO 0x14
	66	#define CSR_MODEL 0x17
77c9a5da SR	67	#define CSR_DIRECTORY_ID 0x20
	68
	69	struct fw_csr_iterator {
13b302d0 SR	70	const u32 *p;
13b302d0 SR	71	const u32 *end;
77c9a5da SR	72	};
77c9a5da SR	73
13b302d0	74	void fw_csr_iterator_init(struct fw_csr_iterator ci, const u32 p);
77c9a5da	75	int fw_csr_iterator_next(struct fw_csr_iterator ci, int key, int *value);
13b302d0	76	int fw_csr_string(const u32 directory, int key, char buf, size_t size);
1f8fef7b	77
77c9a5da SR	78	extern struct bus_type fw_bus_type;
	79
	80	struct fw_card_driver;
	81	struct fw_node;
	82
	83	struct fw_card {
	84	const struct fw_card_driver *driver;
	85	struct device *device;
	86	struct kref kref;
	87	struct completion done;
	88
	89	int node_id;
	90	int generation;
1e626fdc SR	91	int current_tlabel;
1e626fdc SR	92	u64 tlabel_mask;
77c9a5da	93	struct list_head transaction_list;
e71084af	94	u64 reset_jiffies;
77c9a5da	95
8e4b50f9 CL	96	u32 split_timeout_hi;
	97	u32 split_timeout_lo;
	98	unsigned int split_timeout_cycles;
	99	unsigned int split_timeout_jiffies;
	100
77c9a5da SR	101	unsigned long long guid;
	102	unsigned max_receive;
	103	int link_speed;
	104	int config_rom_generation;
	105
	106	spinlock_t lock; /* Take this lock when handling the lists in
	107	* this struct. */
	108	struct fw_node *local_node;
	109	struct fw_node *root_node;
	110	struct fw_node *irm_node;
	111	u8 color; /* must be u8 to match the definition in struct fw_node */
	112	int gap_count;
	113	bool beta_repeaters_present;
	114
	115	int index;
77c9a5da SR	116	struct list_head link;
77c9a5da SR	117
bf54e146 SR	118	struct list_head phy_receiver_list;
bf54e146 SR	119
02d37bed SR	120	struct delayed_work br_work; /* bus reset job */
	121	bool br_short;
	122
	123	struct delayed_work bm_work; /* bus manager job */
77c9a5da SR	124	int bm_retries;
77c9a5da SR	125	int bm_generation;
250b2b6d	126	int bm_node_id;
c8a94ded	127	bool bm_abdicate;
77c9a5da	128
db3c9cc1 SR	129	bool priority_budget_implemented; /* controller feature */
	130	bool broadcast_channel_auto_allocated; /* controller feature */
	131
77c9a5da SR	132	bool broadcast_channel_allocated;
77c9a5da SR	133	u32 broadcast_channel;
cb7c96da	134	__be32 topology_map[(CSR_TOPOLOGY_MAP_END - CSR_TOPOLOGY_MAP) / 4];
3d1f46eb CL	135
3d1f46eb CL	136	__be32 maint_utility_register;
77c9a5da SR	137	};
77c9a5da SR	138
fc5f80b1 CB	139	static inline struct fw_card fw_card_get(struct fw_card card)
	140	{
	141	kref_get(&card->kref);
	142
	143	return card;
	144	}
	145
	146	void fw_card_release(struct kref *kref);
	147
	148	static inline void fw_card_put(struct fw_card *card)
	149	{
	150	kref_put(&card->kref, fw_card_release);
	151	}
	152
baa914cd TS	153	int fw_card_read_cycle_time(struct fw_card card, u32 cycle_time);
baa914cd TS	154
77c9a5da SR	155	struct fw_attribute_group {
	156	struct attribute_group *groups[2];
	157	struct attribute_group group;
baedee17	158	struct attribute *attrs[13];
77c9a5da SR	159	};
	160
	161	enum fw_device_state {
	162	FW_DEVICE_INITIALIZING,
	163	FW_DEVICE_RUNNING,
	164	FW_DEVICE_GONE,
	165	FW_DEVICE_SHUTDOWN,
	166	};
	167
	168	/*
	169	* Note, fw_device.generation always has to be read before fw_device.node_id.
	170	* Use SMP memory barriers to ensure this. Otherwise requests will be sent
	171	* to an outdated node_id if the generation was updated in the meantime due
	172	* to a bus reset.
	173	*
	174	* Likewise, fw-core will take care to update .node_id before .generation so
	175	* that whenever fw_device.generation is current WRT the actual bus generation,
	176	* fw_device.node_id is guaranteed to be current too.
	177	*
	178	* The same applies to fw_device.card->node_id vs. fw_device.generation.
	179	*
	180	* fw_device.config_rom and fw_device.config_rom_length may be accessed during
	181	* the lifetime of any fw_unit belonging to the fw_device, before device_del()
	182	* was called on the last fw_unit. Alternatively, they may be accessed while
	183	* holding fw_device_rwsem.
	184	*/
	185	struct fw_device {
	186	atomic_t state;
	187	struct fw_node *node;
	188	int node_id;
	189	int generation;
	190	unsigned max_speed;
	191	struct fw_card *card;
	192	struct device device;
	193
	194	struct mutex client_list_mutex;
	195	struct list_head client_list;
	196
13b302d0	197	const u32 *config_rom;
77c9a5da SR	198	size_t config_rom_length;
	199	int config_rom_retries;
	200	unsigned is_local:1;
837ec787	201	unsigned max_rec:4;
77c9a5da	202	unsigned cmc:1;
837ec787	203	unsigned irmc:1;
77c9a5da SR	204	unsigned bc_implemented:2;
77c9a5da SR	205
70044d71	206	work_func_t workfn;
77c9a5da SR	207	struct delayed_work work;
	208	struct fw_attribute_group attribute_group;
	209	};
	210
49b7fc1c	211	#define fw_device(dev) container_of_const(dev, struct fw_device, device)
77c9a5da SR	212
	213	static inline int fw_device_is_shutdown(struct fw_device *device)
	214	{
	215	return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN;
	216	}
	217
77c9a5da SR	218	int fw_device_enable_phys_dma(struct fw_device *device);
	219
	220	/*
	221	* fw_unit.directory must not be accessed after device_del(&fw_unit.device).
	222	*/
	223	struct fw_unit {
	224	struct device device;
13b302d0	225	const u32 *directory;
77c9a5da SR	226	struct fw_attribute_group attribute_group;
	227	};
	228
49b7fc1c	229	#define fw_unit(dev) container_of_const(dev, struct fw_unit, device)
77c9a5da SR	230
	231	static inline struct fw_unit fw_unit_get(struct fw_unit unit)
	232	{
	233	get_device(&unit->device);
	234
	235	return unit;
	236	}
	237
	238	static inline void fw_unit_put(struct fw_unit *unit)
	239	{
	240	put_device(&unit->device);
	241	}
	242
49b7fc1c	243	#define fw_parent_device(unit) fw_device(unit->device.parent)
e5110d01	244
77c9a5da SR	245	struct ieee1394_device_id;
	246
	247	struct fw_driver {
	248	struct device_driver driver;
94a87157	249	int (probe)(struct fw_unit unit, const struct ieee1394_device_id *id);
77c9a5da SR	250	/* Called when the parent device sits through a bus reset. */
77c9a5da SR	251	void (update)(struct fw_unit unit);
94a87157	252	void (remove)(struct fw_unit unit);
77c9a5da SR	253	const struct ieee1394_device_id *id_table;
	254	};
	255
	256	struct fw_packet;
	257	struct fw_request;
	258
	259	typedef void (fw_packet_callback_t)(struct fw_packet packet,
	260	struct fw_card *card, int status);
	261	typedef void (fw_transaction_callback_t)(struct fw_card card, int rcode,
	262	void *data, size_t length,
	263	void *callback_data);
	264	/*
4d50c443 SR	265	* This callback handles an inbound request subaction. It is called in
	266	* RCU read-side context, therefore must not sleep.
	267	*
	268	* The callback should not initiate outbound request subactions directly.
	269	* Otherwise there is a danger of recursion of inbound and outbound
	270	* transactions from and to the local node.
	271	*
e6996002 TS	272	* The callback is responsible that fw_send_response() is called on the @request, except for FCP
e6996002 TS	273	* registers for which the core takes care of that.
77c9a5da SR	274	*/
	275	typedef void (fw_address_callback_t)(struct fw_card card,
	276	struct fw_request *request,
	277	int tcode, int destination, int source,
33e553fe	278	int generation,
77c9a5da SR	279	unsigned long long offset,
	280	void *data, size_t length,
	281	void *callback_data);
	282
	283	struct fw_packet {
	284	int speed;
	285	int generation;
	286	u32 header[4];
	287	size_t header_length;
	288	void *payload;
	289	size_t payload_length;
	290	dma_addr_t payload_bus;
19593ffd	291	bool payload_mapped;
77c9a5da SR	292	u32 timestamp;
	293
	294	/*
18d0cdfd SR	295	* This callback is called when the packet transmission has completed.
	296	* For successful transmission, the status code is the ack received
	297	* from the destination. Otherwise it is one of the juju-specific
	298	* rcodes: RCODE_SEND_ERROR, _CANCELLED, _BUSY, _GENERATION, _NO_ACK.
77c9a5da SR	299	* The callback can be called from tasklet context and thus
	300	* must never block.
	301	*/
	302	fw_packet_callback_t callback;
	303	int ack;
	304	struct list_head link;
	305	void *driver_data;
	306	};
	307
	308	struct fw_transaction {
	309	int node_id; /* The generation is implied; it is always the current. */
	310	int tlabel;
77c9a5da	311	struct list_head link;
5c40cbfe	312	struct fw_card *card;
410cf2bd	313	bool is_split_transaction;
5c40cbfe	314	struct timer_list split_timeout_timer;
77c9a5da SR	315
	316	struct fw_packet packet;
	317
	318	/*
	319	* The data passed to the callback is valid only during the
	320	* callback.
	321	*/
	322	fw_transaction_callback_t callback;
	323	void *callback_data;
	324	};
	325
	326	struct fw_address_handler {
	327	u64 offset;
188726ec	328	u64 length;
77c9a5da SR	329	fw_address_callback_t address_callback;
	330	void *callback_data;
	331	struct list_head link;
	332	};
	333
	334	struct fw_address_region {
	335	u64 start;
	336	u64 end;
	337	};
	338
	339	extern const struct fw_address_region fw_high_memory_region;
	340
	341	int fw_core_add_address_handler(struct fw_address_handler *handler,
	342	const struct fw_address_region *region);
	343	void fw_core_remove_address_handler(struct fw_address_handler *handler);
	344	void fw_send_response(struct fw_card *card,
	345	struct fw_request *request, int rcode);
253d9237	346	int fw_get_request_speed(struct fw_request *request);
b2405aa9	347	u32 fw_request_get_timestamp(const struct fw_request *request);
77c9a5da SR	348	void fw_send_request(struct fw_card card, struct fw_transaction t,
	349	int tcode, int destination_id, int generation, int speed,
	350	unsigned long long offset, void *payload, size_t length,
	351	fw_transaction_callback_t callback, void *callback_data);
	352	int fw_cancel_transaction(struct fw_card *card,
	353	struct fw_transaction *transaction);
	354	int fw_run_transaction(struct fw_card *card, int tcode, int destination_id,
	355	int generation, int speed, unsigned long long offset,
	356	void *payload, size_t length);
7bdbff67	357	const char *fw_rcode_string(int rcode);
77c9a5da	358
c76acec6 JF	359	static inline int fw_stream_packet_destination_id(int tag, int channel, int sy)
	360	{
	361	return tag << 14 \| channel << 8 \| sy;
	362	}
	363
9b1ee0b2 TS	364	void fw_schedule_bus_reset(struct fw_card *card, bool delayed,
	365	bool short_reset);
	366
c76acec6 JF	367	struct fw_descriptor {
	368	struct list_head link;
	369	size_t length;
	370	u32 immediate;
	371	u32 key;
	372	const u32 *data;
	373	};
	374
	375	int fw_core_add_descriptor(struct fw_descriptor *desc);
	376	void fw_core_remove_descriptor(struct fw_descriptor *desc);
	377
	378	/*
	379	* The iso packet format allows for an immediate header/payload part
	380	* stored in 'header' immediately after the packet info plus an
	381	* indirect payload part that is pointer to by the 'payload' field.
	382	* Applications can use one or the other or both to implement simple
	383	* low-bandwidth streaming (e.g. audio) or more advanced
	384	* scatter-gather streaming (e.g. assembling video frame automatically).
	385	*/
	386	struct fw_iso_packet {
872e330e SR	387	u16 payload_length; /* Length of indirect payload */
	388	u32 interrupt:1; /* Generate interrupt on this packet */
	389	u32 skip:1; /* tx: Set to not send packet at all */
	390	/* rx: Sync bit, wait for matching sy */
	391	u32 tag:2; /* tx: Tag in packet header */
	392	u32 sy:4; /* tx: Sy in packet header */
	393	u32 header_length:8; /* Length of immediate header */
	394	u32 header[0]; /* tx: Top of 1394 isoch. data_block */
c76acec6 JF	395	};
c76acec6 JF	396
872e330e SR	397	#define FW_ISO_CONTEXT_TRANSMIT 0
	398	#define FW_ISO_CONTEXT_RECEIVE 1
	399	#define FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL 2
c76acec6 JF	400
	401	#define FW_ISO_CONTEXT_MATCH_TAG0 1
	402	#define FW_ISO_CONTEXT_MATCH_TAG1 2
	403	#define FW_ISO_CONTEXT_MATCH_TAG2 4
	404	#define FW_ISO_CONTEXT_MATCH_TAG3 8
	405	#define FW_ISO_CONTEXT_MATCH_ALL_TAGS 15
	406
	407	/*
	408	* An iso buffer is just a set of pages mapped for DMA in the
	409	* specified direction. Since the pages are to be used for DMA, they
	410	* are not mapped into the kernel virtual address space. We store the
	411	* DMA address in the page private. The helper function
	412	* fw_iso_buffer_map() will map the pages into a given vma.
	413	*/
	414	struct fw_iso_buffer {
	415	enum dma_data_direction direction;
	416	struct page **pages;
	417	int page_count;
0b6c4857	418	int page_count_mapped;
c76acec6 JF	419	};
	420
	421	int fw_iso_buffer_init(struct fw_iso_buffer buffer, struct fw_card card,
	422	int page_count, enum dma_data_direction direction);
	423	void fw_iso_buffer_destroy(struct fw_iso_buffer buffer, struct fw_card card);
872e330e	424	size_t fw_iso_buffer_lookup(struct fw_iso_buffer *buffer, dma_addr_t completed);
c76acec6 JF	425
	426	struct fw_iso_context;
	427	typedef void (fw_iso_callback_t)(struct fw_iso_context context,
	428	u32 cycle, size_t header_length,
	429	void header, void data);
872e330e SR	430	typedef void (fw_iso_mc_callback_t)(struct fw_iso_context context,
872e330e SR	431	dma_addr_t completed, void *data);
ebe4560e OC	432
	433	union fw_iso_callback {
	434	fw_iso_callback_t sc;
	435	fw_iso_mc_callback_t mc;
	436	};
	437
c76acec6 JF	438	struct fw_iso_context {
	439	struct fw_card *card;
	440	int type;
	441	int channel;
	442	int speed;
0699a73a	443	bool drop_overflow_headers;
c76acec6	444	size_t header_size;
ebe4560e	445	union fw_iso_callback callback;
c76acec6 JF	446	void *callback_data;
	447	};
	448
	449	struct fw_iso_context fw_iso_context_create(struct fw_card card,
	450	int type, int channel, int speed, size_t header_size,
	451	fw_iso_callback_t callback, void *callback_data);
872e330e	452	int fw_iso_context_set_channels(struct fw_iso_context ctx, u64 channels);
c76acec6 JF	453	int fw_iso_context_queue(struct fw_iso_context *ctx,
	454	struct fw_iso_packet *packet,
	455	struct fw_iso_buffer *buffer,
	456	unsigned long payload);
13882a82	457	void fw_iso_context_queue_flush(struct fw_iso_context *ctx);
d1bbd209	458	int fw_iso_context_flush_completions(struct fw_iso_context *ctx);
c76acec6 JF	459	int fw_iso_context_start(struct fw_iso_context *ctx,
	460	int cycle, int sync, int tags);
	461	int fw_iso_context_stop(struct fw_iso_context *ctx);
	462	void fw_iso_context_destroy(struct fw_iso_context *ctx);
31ef9134 CL	463	void fw_iso_resource_manage(struct fw_card *card, int generation,
31ef9134 CL	464	u64 channels_mask, int channel, int bandwidth,
f30e6d3e	465	bool allocate);
c76acec6	466
105e53f8 SR	467	extern struct workqueue_struct *fw_workqueue;
105e53f8 SR	468
77c9a5da	469	#endif /* _LINUX_FIREWIRE_H */