[mirror_ubuntu-jammy-kernel.git] / drivers / firewire / core.h

#ifndef _FIREWIRE_CORE_H
#define _FIREWIRE_CORE_H

#include <linux/fs.h>
#include <linux/list.h>
#include <linux/idr.h>
#include <linux/mm_types.h>
#include <linux/rwsem.h>
#include <linux/slab.h>
#include <linux/types.h>

#include <asm/atomic.h>

struct device;
struct fw_card;
struct fw_device;
struct fw_iso_buffer;
struct fw_iso_context;
struct fw_iso_packet;
struct fw_node;
struct fw_packet;


/* -card */

/* bitfields within the PHY registers */
#define PHY_LINK_ACTIVE		0x80
#define PHY_CONTENDER		0x40
#define PHY_BUS_RESET		0x40
#define PHY_EXTENDED_REGISTERS	0xe0
#define PHY_BUS_SHORT_RESET	0x40
#define PHY_INT_STATUS_BITS	0x3c
#define PHY_ENABLE_ACCEL	0x02
#define PHY_ENABLE_MULTI	0x01
#define PHY_PAGE_SELECT		0xe0

#define BANDWIDTH_AVAILABLE_INITIAL	4915
#define BROADCAST_CHANNEL_INITIAL	(1 << 31 | 31)
#define BROADCAST_CHANNEL_VALID		(1 << 30)

#define CSR_STATE_BIT_CMSTR	(1 << 8)
#define CSR_STATE_BIT_ABDICATE	(1 << 10)

struct fw_card_driver {
	/*
	 * 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,
		      const __be32 *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
	 * and initiate a bus reset.
	 */
	int (*set_config_rom)(struct fw_card *card,
			      const __be32 *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);

	u32 (*read_csr)(struct fw_card *card, int csr_offset);
	void (*write_csr)(struct fw_card *card, int csr_offset, u32 value);

	struct fw_iso_context *
	(*allocate_iso_context)(struct fw_card *card,
				int type, int channel, 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);
};

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);
int fw_core_initiate_bus_reset(struct fw_card *card, int short_reset);
int fw_compute_block_crc(__be32 *block);
void fw_schedule_bm_work(struct fw_card *card, unsigned long delay);

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


/* -cdev */

extern const struct file_operations fw_device_ops;

void fw_device_cdev_update(struct fw_device *device);
void fw_device_cdev_remove(struct fw_device *device);


/* -device */

extern struct rw_semaphore fw_device_rwsem;
extern struct idr fw_device_idr;
extern int fw_cdev_major;

struct fw_device *fw_device_get_by_devt(dev_t devt);
int fw_device_set_broadcast_channel(struct device *dev, void *gen);
void fw_node_event(struct fw_card *card, struct fw_node *node, int event);


/* -iso */

int fw_iso_buffer_map(struct fw_iso_buffer *buffer, struct vm_area_struct *vma);
void fw_iso_resource_manage(struct fw_card *card, int generation,
			    u64 channels_mask, int *channel, int *bandwidth,
			    bool allocate, __be32 buffer[2]);


/* -topology */

enum {
	FW_NODE_CREATED,
	FW_NODE_UPDATED,
	FW_NODE_DESTROYED,
	FW_NODE_LINK_ON,
	FW_NODE_LINK_OFF,
	FW_NODE_INITIATED_RESET,
};

struct fw_node {
	u16 node_id;
	u8 color;
	u8 port_count;
	u8 link_on:1;
	u8 initiated_reset:1;
	u8 b_path:1;
	u8 phy_speed:2;	/* As in the self ID packet. */
	u8 max_speed:2;	/* Minimum of all phy-speeds on the path from the
			 * local node to this node. */
	u8 max_depth:4;	/* Maximum depth to any leaf node */
	u8 max_hops:4;	/* Max hops in this sub tree */
	atomic_t ref_count;

	/* For serializing node topology into a list. */
	struct list_head link;

	/* Upper layer specific data. */
	void *data;

	struct fw_node *ports[0];
};

static inline struct fw_node *fw_node_get(struct fw_node *node)
{
	atomic_inc(&node->ref_count);

	return node;
}

static inline void fw_node_put(struct fw_node *node)
{
	if (atomic_dec_and_test(&node->ref_count))
		kfree(node);
}

void fw_core_handle_bus_reset(struct fw_card *card, int node_id,
	int generation, int self_id_count, u32 *self_ids, bool bm_abdicate);
void fw_destroy_nodes(struct fw_card *card);

/*
 * Check whether new_generation is the immediate successor of old_generation.
 * Take counter roll-over at 255 (as per OHCI) into account.
 */
static inline bool is_next_generation(int new_generation, int old_generation)
{
	return (new_generation & 0xff) == ((old_generation + 1) & 0xff);
}


/* -transaction */

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

#define LOCAL_BUS 0xffc0

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);
int fw_get_response_length(struct fw_request *request);
void fw_fill_response(struct fw_packet *response, u32 *request_header,
		      int rcode, void *payload, size_t length);
void fw_send_phy_config(struct fw_card *card,
			int node_id, int generation, int gap_count);

#endif /* _FIREWIRE_CORE_H */
Commit	Line	Data
77c9a5da SR	1	#ifndef _FIREWIRE_CORE_H
	2	#define _FIREWIRE_CORE_H
	3
77c9a5da SR	4	#include <linux/fs.h>
	5	#include <linux/list.h>
	6	#include <linux/idr.h>
	7	#include <linux/mm_types.h>
	8	#include <linux/rwsem.h>
	9	#include <linux/slab.h>
	10	#include <linux/types.h>
	11
	12	#include <asm/atomic.h>
	13
	14	struct device;
	15	struct fw_card;
	16	struct fw_device;
	17	struct fw_iso_buffer;
	18	struct fw_iso_context;
	19	struct fw_iso_packet;
	20	struct fw_node;
	21	struct fw_packet;
	22
	23
	24	/* -card */
	25
	26	/* bitfields within the PHY registers */
	27	#define PHY_LINK_ACTIVE 0x80
	28	#define PHY_CONTENDER 0x40
	29	#define PHY_BUS_RESET 0x40
925e7a65	30	#define PHY_EXTENDED_REGISTERS 0xe0
77c9a5da	31	#define PHY_BUS_SHORT_RESET 0x40
e7014dad	32	#define PHY_INT_STATUS_BITS 0x3c
925e7a65 CL	33	#define PHY_ENABLE_ACCEL 0x02
	34	#define PHY_ENABLE_MULTI 0x01
	35	#define PHY_PAGE_SELECT 0xe0
77c9a5da SR	36
	37	#define BANDWIDTH_AVAILABLE_INITIAL 4915
	38	#define BROADCAST_CHANNEL_INITIAL (1 << 31 \| 31)
	39	#define BROADCAST_CHANNEL_VALID (1 << 30)
	40
4ffb7a6a	41	#define CSR_STATE_BIT_CMSTR (1 << 8)
7e0e314f	42	#define CSR_STATE_BIT_ABDICATE (1 << 10)
4ffb7a6a	43
77c9a5da SR	44	struct fw_card_driver {
	45	/*
	46	* Enable the given card with the given initial config rom.
	47	* This function is expected to activate the card, and either
	48	* enable the PHY or set the link_on bit and initiate a bus
	49	* reset.
	50	*/
8e85973e SR	51	int (enable)(struct fw_card card,
8e85973e SR	52	const __be32 *config_rom, size_t length);
77c9a5da SR	53
	54	int (update_phy_reg)(struct fw_card card, int address,
	55	int clear_bits, int set_bits);
	56
	57	/*
	58	* Update the config rom for an enabled card. This function
	59	* should change the config rom that is presented on the bus
8e85973e	60	* and initiate a bus reset.
77c9a5da SR	61	*/
77c9a5da SR	62	int (set_config_rom)(struct fw_card card,
8e85973e	63	const __be32 *config_rom, size_t length);
77c9a5da SR	64
	65	void (send_request)(struct fw_card card, struct fw_packet *packet);
	66	void (send_response)(struct fw_card card, struct fw_packet *packet);
	67	/* Calling cancel is valid once a packet has been submitted. */
	68	int (cancel_packet)(struct fw_card card, struct fw_packet *packet);
	69
	70	/*
	71	* Allow the specified node ID to do direct DMA out and in of
	72	* host memory. The card will disable this for all node when
	73	* a bus reset happens, so driver need to reenable this after
	74	* bus reset. Returns 0 on success, -ENODEV if the card
	75	* doesn't support this, -ESTALE if the generation doesn't
	76	* match.
	77	*/
	78	int (enable_phys_dma)(struct fw_card card,
	79	int node_id, int generation);
	80
0fcff4e3 SR	81	u32 (read_csr)(struct fw_card card, int csr_offset);
0fcff4e3 SR	82	void (write_csr)(struct fw_card card, int csr_offset, u32 value);
77c9a5da SR	83
	84	struct fw_iso_context *
	85	(allocate_iso_context)(struct fw_card card,
	86	int type, int channel, size_t header_size);
	87	void (free_iso_context)(struct fw_iso_context ctx);
	88
	89	int (start_iso)(struct fw_iso_context ctx,
	90	s32 cycle, u32 sync, u32 tags);
	91
	92	int (queue_iso)(struct fw_iso_context ctx,
	93	struct fw_iso_packet *packet,
	94	struct fw_iso_buffer *buffer,
	95	unsigned long payload);
	96
	97	int (stop_iso)(struct fw_iso_context ctx);
	98	};
	99
	100	void fw_card_initialize(struct fw_card *card,
	101	const struct fw_card_driver driver, struct device device);
	102	int fw_card_add(struct fw_card *card,
	103	u32 max_receive, u32 link_speed, u64 guid);
	104	void fw_core_remove_card(struct fw_card *card);
	105	int fw_core_initiate_bus_reset(struct fw_card *card, int short_reset);
cb7c96da	106	int fw_compute_block_crc(__be32 *block);
77c9a5da SR	107	void fw_schedule_bm_work(struct fw_card *card, unsigned long delay);
77c9a5da SR	108
18668ff9 SR	109	static inline struct fw_card fw_card_get(struct fw_card card)
	110	{
	111	kref_get(&card->kref);
	112
	113	return card;
	114	}
	115
	116	void fw_card_release(struct kref *kref);
	117
	118	static inline void fw_card_put(struct fw_card *card)
	119	{
	120	kref_put(&card->kref, fw_card_release);
	121	}
	122
77c9a5da SR	123
	124	/* -cdev */
	125
	126	extern const struct file_operations fw_device_ops;
	127
	128	void fw_device_cdev_update(struct fw_device *device);
	129	void fw_device_cdev_remove(struct fw_device *device);
	130
	131
	132	/* -device */
	133
	134	extern struct rw_semaphore fw_device_rwsem;
	135	extern struct idr fw_device_idr;
	136	extern int fw_cdev_major;
	137
	138	struct fw_device *fw_device_get_by_devt(dev_t devt);
099d5414	139	int fw_device_set_broadcast_channel(struct device dev, void gen);
77c9a5da SR	140	void fw_node_event(struct fw_card card, struct fw_node node, int event);
	141
	142
	143	/* -iso */
	144
77c9a5da	145	int fw_iso_buffer_map(struct fw_iso_buffer buffer, struct vm_area_struct vma);
77c9a5da	146	void fw_iso_resource_manage(struct fw_card *card, int generation,
6fdc0370 SR	147	u64 channels_mask, int channel, int bandwidth,
6fdc0370 SR	148	bool allocate, __be32 buffer[2]);
77c9a5da SR	149
	150
	151	/* -topology */
	152
	153	enum {
	154	FW_NODE_CREATED,
	155	FW_NODE_UPDATED,
	156	FW_NODE_DESTROYED,
	157	FW_NODE_LINK_ON,
	158	FW_NODE_LINK_OFF,
	159	FW_NODE_INITIATED_RESET,
	160	};
	161
	162	struct fw_node {
	163	u16 node_id;
	164	u8 color;
	165	u8 port_count;
	166	u8 link_on:1;
	167	u8 initiated_reset:1;
	168	u8 b_path:1;
	169	u8 phy_speed:2; /* As in the self ID packet. */
	170	u8 max_speed:2; /* Minimum of all phy-speeds on the path from the
	171	* local node to this node. */
	172	u8 max_depth:4; /* Maximum depth to any leaf node */
	173	u8 max_hops:4; /* Max hops in this sub tree */
	174	atomic_t ref_count;
	175
	176	/* For serializing node topology into a list. */
	177	struct list_head link;
	178
	179	/* Upper layer specific data. */
	180	void *data;
	181
	182	struct fw_node *ports[0];
	183	};
	184
	185	static inline struct fw_node fw_node_get(struct fw_node node)
	186	{
	187	atomic_inc(&node->ref_count);
	188
	189	return node;
	190	}
	191
	192	static inline void fw_node_put(struct fw_node *node)
	193	{
	194	if (atomic_dec_and_test(&node->ref_count))
	195	kfree(node);
	196	}
	197
	198	void fw_core_handle_bus_reset(struct fw_card *card, int node_id,
c8a94ded	199	int generation, int self_id_count, u32 *self_ids, bool bm_abdicate);
77c9a5da SR	200	void fw_destroy_nodes(struct fw_card *card);
	201
	202	/*
	203	* Check whether new_generation is the immediate successor of old_generation.
	204	* Take counter roll-over at 255 (as per OHCI) into account.
	205	*/
	206	static inline bool is_next_generation(int new_generation, int old_generation)
	207	{
	208	return (new_generation & 0xff) == ((old_generation + 1) & 0xff);
	209	}
	210
	211
	212	/* -transaction */
	213
	214	#define TCODE_IS_READ_REQUEST(tcode) (((tcode) & ~1) == 4)
	215	#define TCODE_IS_BLOCK_PACKET(tcode) (((tcode) & 1) != 0)
	216	#define TCODE_IS_REQUEST(tcode) (((tcode) & 2) == 0)
	217	#define TCODE_IS_RESPONSE(tcode) (((tcode) & 2) != 0)
	218	#define TCODE_HAS_REQUEST_DATA(tcode) (((tcode) & 12) != 4)
	219	#define TCODE_HAS_RESPONSE_DATA(tcode) (((tcode) & 12) != 0)
	220
	221	#define LOCAL_BUS 0xffc0
	222
	223	void fw_core_handle_request(struct fw_card card, struct fw_packet request);
	224	void fw_core_handle_response(struct fw_card card, struct fw_packet packet);
a10c0ce7	225	int fw_get_response_length(struct fw_request *request);
77c9a5da SR	226	void fw_fill_response(struct fw_packet response, u32 request_header,
77c9a5da SR	227	int rcode, void *payload, size_t length);
77c9a5da SR	228	void fw_send_phy_config(struct fw_card *card,
	229	int node_id, int generation, int gap_count);
	230
77c9a5da	231	#endif /* _FIREWIRE_CORE_H */