[mirror_ubuntu-bionic-kernel.git] / drivers / block / aoe / aoe.h

/* Copyright (c) 2006 Coraid, Inc.  See COPYING for GPL terms. */
#define VERSION "32"
#define AOE_MAJOR 152
#define DEVICE_NAME "aoe"

/* set AOE_PARTITIONS to 1 to use whole-disks only
 * default is 16, which is 15 partitions plus the whole disk
 */
#ifndef AOE_PARTITIONS
#define AOE_PARTITIONS (16)
#endif

#define SYSMINOR(aoemajor, aoeminor) ((aoemajor) * NPERSHELF + (aoeminor))
#define AOEMAJOR(sysminor) ((sysminor) / NPERSHELF)
#define AOEMINOR(sysminor) ((sysminor) % NPERSHELF)
#define WHITESPACE " \t\v\f\n"

enum {
	AOECMD_ATA,
	AOECMD_CFG,

	AOEFL_RSP = (1<<3),
	AOEFL_ERR = (1<<2),

	AOEAFL_EXT = (1<<6),
	AOEAFL_DEV = (1<<4),
	AOEAFL_ASYNC = (1<<1),
	AOEAFL_WRITE = (1<<0),

	AOECCMD_READ = 0,
	AOECCMD_TEST,
	AOECCMD_PTEST,
	AOECCMD_SET,
	AOECCMD_FSET,

	AOE_HVER = 0x10,
};

struct aoe_hdr {
	unsigned char dst[6];
	unsigned char src[6];
	__be16 type;
	unsigned char verfl;
	unsigned char err;
	__be16 major;
	unsigned char minor;
	unsigned char cmd;
	__be32 tag;
};

#ifdef __KERNEL__
#include <linux/skbuff.h>

static inline struct aoe_hdr *aoe_hdr(const struct sk_buff *skb)
{
	return (struct aoe_hdr *)skb_mac_header(skb);
}
#endif

struct aoe_atahdr {
	unsigned char aflags;
	unsigned char errfeat;
	unsigned char scnt;
	unsigned char cmdstat;
	unsigned char lba0;
	unsigned char lba1;
	unsigned char lba2;
	unsigned char lba3;
	unsigned char lba4;
	unsigned char lba5;
	unsigned char res[2];
};

struct aoe_cfghdr {
	__be16 bufcnt;
	__be16 fwver;
	unsigned char scnt;
	unsigned char aoeccmd;
	unsigned char cslen[2];
};

enum {
	DEVFL_UP = 1,	/* device is installed in system and ready for AoE->ATA commands */
	DEVFL_TKILL = (1<<1),	/* flag for timer to know when to kill self */
	DEVFL_EXT = (1<<2),	/* device accepts lba48 commands */
	DEVFL_CLOSEWAIT = (1<<3), /* device is waiting for all closes to revalidate */
	DEVFL_GDALLOC = (1<<4),	/* need to alloc gendisk */
	DEVFL_PAUSE = (1<<5),
	DEVFL_NEWSIZE = (1<<6),	/* need to update dev size in block layer */
	DEVFL_MAXBCNT = (1<<7), /* d->maxbcnt is not changeable */
	DEVFL_KICKME = (1<<8),

	BUFFL_FAIL = 1,
};

enum {
	DEFAULTBCNT = 2 * 512,	/* 2 sectors */
	NPERSHELF = 16,		/* number of slots per shelf address */
	FREETAG = -1,
	MIN_BUFS = 8,
};

struct buf {
	struct list_head bufs;
	ulong start_time;	/* for disk stats */
	ulong flags;
	ulong nframesout;
	char *bufaddr;
	ulong resid;
	ulong bv_resid;
	sector_t sector;
	struct bio *bio;
	struct bio_vec *bv;
};

struct frame {
	int tag;
	ulong waited;
	struct buf *buf;
	char *bufaddr;
	ulong bcnt;
	sector_t lba;
	struct sk_buff *skb;
};

struct aoedev {
	struct aoedev *next;
	unsigned char addr[6];	/* remote mac addr */
	ushort flags;
	ulong sysminor;
	ulong aoemajor;
	ulong aoeminor;
	u16 nopen;		/* (bd_openers isn't available without sleeping) */
	u16 lasttag;		/* last tag sent */
	u16 rttavg;		/* round trip average of requests/responses */
	u16 mintimer;
	u16 fw_ver;		/* version of blade's firmware */
	u16 maxbcnt;
	struct work_struct work;/* disk create work struct */
	struct gendisk *gd;
	struct request_queue blkq;
	struct hd_geometry geo; 
	sector_t ssize;
	struct timer_list timer;
	spinlock_t lock;
	struct net_device *ifp;	/* interface ed is attached to */
	struct sk_buff *sendq_hd; /* packets needing to be sent, list head */
	struct sk_buff *sendq_tl;
	mempool_t *bufpool;	/* for deadlock-free Buf allocation */
	struct list_head bufq;	/* queue of bios to work on */
	struct buf *inprocess;	/* the one we're currently working on */
	ushort lostjumbo;
	ushort nframes;		/* number of frames below */
	struct frame *frames;
};


int aoeblk_init(void);
void aoeblk_exit(void);
void aoeblk_gdalloc(void *);
void aoedisk_rm_sysfs(struct aoedev *d);

int aoechr_init(void);
void aoechr_exit(void);
void aoechr_error(char *);

void aoecmd_work(struct aoedev *d);
void aoecmd_cfg(ushort aoemajor, unsigned char aoeminor);
void aoecmd_ata_rsp(struct sk_buff *);
void aoecmd_cfg_rsp(struct sk_buff *);
void aoecmd_sleepwork(struct work_struct *);
struct sk_buff *new_skb(ulong);

int aoedev_init(void);
void aoedev_exit(void);
struct aoedev *aoedev_by_aoeaddr(int maj, int min);
struct aoedev *aoedev_by_sysminor_m(ulong sysminor, ulong bufcnt);
void aoedev_downdev(struct aoedev *d);
int aoedev_isbusy(struct aoedev *d);

int aoenet_init(void);
void aoenet_exit(void);
void aoenet_xmit(struct sk_buff *);
int is_aoe_netif(struct net_device *ifp);
int set_aoe_iflist(const char __user *str, size_t size);

u64 mac_addr(char addr[6]);
Commit	Line	Data
2611464d	1	/* Copyright (c) 2006 Coraid, Inc. See COPYING for GPL terms. */
086216db	2	#define VERSION "32"
1da177e4 LT	3	#define AOE_MAJOR 152
1da177e4 LT	4	#define DEVICE_NAME "aoe"
fc458dcd EC	5
	6	/* set AOE_PARTITIONS to 1 to use whole-disks only
	7	* default is 16, which is 15 partitions plus the whole disk
	8	*/
1da177e4	9	#ifndef AOE_PARTITIONS
e39526e6	10	#define AOE_PARTITIONS (16)
1da177e4	11	#endif
fc458dcd	12
e39526e6 EC	13	#define SYSMINOR(aoemajor, aoeminor) ((aoemajor) * NPERSHELF + (aoeminor))
	14	#define AOEMAJOR(sysminor) ((sysminor) / NPERSHELF)
	15	#define AOEMINOR(sysminor) ((sysminor) % NPERSHELF)
1da177e4 LT	16	#define WHITESPACE " \t\v\f\n"
	17
	18	enum {
	19	AOECMD_ATA,
	20	AOECMD_CFG,
	21
	22	AOEFL_RSP = (1<<3),
	23	AOEFL_ERR = (1<<2),
	24
	25	AOEAFL_EXT = (1<<6),
	26	AOEAFL_DEV = (1<<4),
	27	AOEAFL_ASYNC = (1<<1),
	28	AOEAFL_WRITE = (1<<0),
	29
	30	AOECCMD_READ = 0,
	31	AOECCMD_TEST,
	32	AOECCMD_PTEST,
	33	AOECCMD_SET,
	34	AOECCMD_FSET,
	35
	36	AOE_HVER = 0x10,
	37	};
	38
	39	struct aoe_hdr {
	40	unsigned char dst[6];
	41	unsigned char src[6];
63e9cc5d	42	__be16 type;
1da177e4 LT	43	unsigned char verfl;
1da177e4 LT	44	unsigned char err;
63e9cc5d	45	__be16 major;
1da177e4 LT	46	unsigned char minor;
1da177e4 LT	47	unsigned char cmd;
63e9cc5d	48	__be32 tag;
1da177e4 LT	49	};
1da177e4 LT	50
029720f1 ACM	51	#ifdef __KERNEL__
	52	#include <linux/skbuff.h>
	53
	54	static inline struct aoe_hdr aoe_hdr(const struct sk_buff skb)
	55	{
98e399f8	56	return (struct aoe_hdr *)skb_mac_header(skb);
029720f1 ACM	57	}
	58	#endif
	59
1da177e4 LT	60	struct aoe_atahdr {
	61	unsigned char aflags;
	62	unsigned char errfeat;
	63	unsigned char scnt;
	64	unsigned char cmdstat;
	65	unsigned char lba0;
	66	unsigned char lba1;
	67	unsigned char lba2;
	68	unsigned char lba3;
	69	unsigned char lba4;
	70	unsigned char lba5;
	71	unsigned char res[2];
	72	};
	73
	74	struct aoe_cfghdr {
63e9cc5d EC	75	__be16 bufcnt;
63e9cc5d EC	76	__be16 fwver;
19bf2635	77	unsigned char scnt;
1da177e4 LT	78	unsigned char aoeccmd;
	79	unsigned char cslen[2];
	80	};
	81
	82	enum {
	83	DEVFL_UP = 1, /* device is installed in system and ready for AoE->ATA commands */
	84	DEVFL_TKILL = (1<<1), /* flag for timer to know when to kill self */
	85	DEVFL_EXT = (1<<2), /* device accepts lba48 commands */
	86	DEVFL_CLOSEWAIT = (1<<3), /* device is waiting for all closes to revalidate */
3ae1c24e EC	87	DEVFL_GDALLOC = (1<<4), /* need to alloc gendisk */
	88	DEVFL_PAUSE = (1<<5),
	89	DEVFL_NEWSIZE = (1<<6), /* need to update dev size in block layer */
19bf2635	90	DEVFL_MAXBCNT = (1<<7), /* d->maxbcnt is not changeable */
4f51dc5e	91	DEVFL_KICKME = (1<<8),
1da177e4 LT	92
	93	BUFFL_FAIL = 1,
	94	};
	95
	96	enum {
19bf2635	97	DEFAULTBCNT = 2 * 512, /* 2 sectors */
e39526e6	98	NPERSHELF = 16, /* number of slots per shelf address */
1da177e4 LT	99	FREETAG = -1,
	100	MIN_BUFS = 8,
	101	};
	102
	103	struct buf {
	104	struct list_head bufs;
0c6f0e79	105	ulong start_time; /* for disk stats */
1da177e4 LT	106	ulong flags;
	107	ulong nframesout;
	108	char *bufaddr;
	109	ulong resid;
	110	ulong bv_resid;
	111	sector_t sector;
	112	struct bio *bio;
	113	struct bio_vec *bv;
	114	};
	115
	116	struct frame {
	117	int tag;
	118	ulong waited;
	119	struct buf *buf;
	120	char *bufaddr;
19bf2635 EC	121	ulong bcnt;
19bf2635 EC	122	sector_t lba;
e407a7f6	123	struct sk_buff *skb;
1da177e4 LT	124	};
	125
	126	struct aoedev {
	127	struct aoedev *next;
	128	unsigned char addr[6]; /* remote mac addr */
	129	ushort flags;
	130	ulong sysminor;
	131	ulong aoemajor;
	132	ulong aoeminor;
dced3a05 EC	133	u16 nopen; /* (bd_openers isn't available without sleeping) */
	134	u16 lasttag; /* last tag sent */
	135	u16 rttavg; /* round trip average of requests/responses */
	136	u16 mintimer;
1da177e4	137	u16 fw_ver; /* version of blade's firmware */
19bf2635	138	u16 maxbcnt;
1da177e4 LT	139	struct work_struct work;/* disk create work struct */
1da177e4 LT	140	struct gendisk *gd;
165125e1	141	struct request_queue blkq;
1da177e4 LT	142	struct hd_geometry geo;
	143	sector_t ssize;
	144	struct timer_list timer;
	145	spinlock_t lock;
	146	struct net_device ifp; / interface ed is attached to */
a4b38364 EC	147	struct sk_buff sendq_hd; / packets needing to be sent, list head */
a4b38364 EC	148	struct sk_buff *sendq_tl;
1da177e4 LT	149	mempool_t bufpool; / for deadlock-free Buf allocation */
	150	struct list_head bufq; /* queue of bios to work on */
	151	struct buf inprocess; / the one we're currently working on */
19bf2635 EC	152	ushort lostjumbo;
19bf2635 EC	153	ushort nframes; /* number of frames below */
1da177e4 LT	154	struct frame *frames;
	155	};
	156
	157
	158	int aoeblk_init(void);
	159	void aoeblk_exit(void);
	160	void aoeblk_gdalloc(void *);
	161	void aoedisk_rm_sysfs(struct aoedev *d);
	162
	163	int aoechr_init(void);
	164	void aoechr_exit(void);
	165	void aoechr_error(char *);
	166
	167	void aoecmd_work(struct aoedev *d);
3ae1c24e	168	void aoecmd_cfg(ushort aoemajor, unsigned char aoeminor);
1da177e4 LT	169	void aoecmd_ata_rsp(struct sk_buff *);
1da177e4 LT	170	void aoecmd_cfg_rsp(struct sk_buff *);
c4028958	171	void aoecmd_sleepwork(struct work_struct *);
e407a7f6	172	struct sk_buff *new_skb(ulong);
1da177e4 LT	173
	174	int aoedev_init(void);
	175	void aoedev_exit(void);
32465c65	176	struct aoedev *aoedev_by_aoeaddr(int maj, int min);
3ae1c24e	177	struct aoedev *aoedev_by_sysminor_m(ulong sysminor, ulong bufcnt);
1da177e4	178	void aoedev_downdev(struct aoedev *d);
3ae1c24e	179	int aoedev_isbusy(struct aoedev *d);
1da177e4 LT	180
	181	int aoenet_init(void);
	182	void aoenet_exit(void);
	183	void aoenet_xmit(struct sk_buff *);
	184	int is_aoe_netif(struct net_device *ifp);
	185	int set_aoe_iflist(const char __user *str, size_t size);
	186
	187	u64 mac_addr(char addr[6]);