xref: /openbmc/linux/drivers/block/aoe/aoe.h (revision f3539c12)
1 /* Copyright (c) 2013 Coraid, Inc.  See COPYING for GPL terms. */
2 #define VERSION "85"
3 #define AOE_MAJOR 152
4 #define DEVICE_NAME "aoe"
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  */
9 #ifndef AOE_PARTITIONS
10 #define AOE_PARTITIONS (16)
11 #endif
12 
13 #define WHITESPACE " \t\v\f\n,"
14 
15 enum {
16 	AOECMD_ATA,
17 	AOECMD_CFG,
18 	AOECMD_VEND_MIN = 0xf0,
19 
20 	AOEFL_RSP = (1<<3),
21 	AOEFL_ERR = (1<<2),
22 
23 	AOEAFL_EXT = (1<<6),
24 	AOEAFL_DEV = (1<<4),
25 	AOEAFL_ASYNC = (1<<1),
26 	AOEAFL_WRITE = (1<<0),
27 
28 	AOECCMD_READ = 0,
29 	AOECCMD_TEST,
30 	AOECCMD_PTEST,
31 	AOECCMD_SET,
32 	AOECCMD_FSET,
33 
34 	AOE_HVER = 0x10,
35 };
36 
37 struct aoe_hdr {
38 	unsigned char dst[6];
39 	unsigned char src[6];
40 	__be16 type;
41 	unsigned char verfl;
42 	unsigned char err;
43 	__be16 major;
44 	unsigned char minor;
45 	unsigned char cmd;
46 	__be32 tag;
47 };
48 
49 struct aoe_atahdr {
50 	unsigned char aflags;
51 	unsigned char errfeat;
52 	unsigned char scnt;
53 	unsigned char cmdstat;
54 	unsigned char lba0;
55 	unsigned char lba1;
56 	unsigned char lba2;
57 	unsigned char lba3;
58 	unsigned char lba4;
59 	unsigned char lba5;
60 	unsigned char res[2];
61 };
62 
63 struct aoe_cfghdr {
64 	__be16 bufcnt;
65 	__be16 fwver;
66 	unsigned char scnt;
67 	unsigned char aoeccmd;
68 	unsigned char cslen[2];
69 };
70 
71 enum {
72 	DEVFL_UP = 1,	/* device is installed in system and ready for AoE->ATA commands */
73 	DEVFL_TKILL = (1<<1),	/* flag for timer to know when to kill self */
74 	DEVFL_EXT = (1<<2),	/* device accepts lba48 commands */
75 	DEVFL_GDALLOC = (1<<3),	/* need to alloc gendisk */
76 	DEVFL_GD_NOW = (1<<4),	/* allocating gendisk */
77 	DEVFL_KICKME = (1<<5),	/* slow polling network card catch */
78 	DEVFL_NEWSIZE = (1<<6),	/* need to update dev size in block layer */
79 	DEVFL_FREEING = (1<<7),	/* set when device is being cleaned up */
80 	DEVFL_FREED = (1<<8),	/* device has been cleaned up */
81 };
82 
83 enum {
84 	DEFAULTBCNT = 2 * 512,	/* 2 sectors */
85 	MIN_BUFS = 16,
86 	NTARGETS = 4,
87 	NAOEIFS = 8,
88 	NSKBPOOLMAX = 256,
89 	NFACTIVE = 61,
90 
91 	TIMERTICK = HZ / 10,
92 	RTTSCALE = 8,
93 	RTTDSCALE = 3,
94 	RTTAVG_INIT = USEC_PER_SEC / 4 << RTTSCALE,
95 	RTTDEV_INIT = RTTAVG_INIT / 4,
96 
97 	HARD_SCORN_SECS = 10,	/* try another remote port after this */
98 	MAX_TAINT = 1000,	/* cap on aoetgt taint */
99 };
100 
101 struct buf {
102 	ulong nframesout;
103 	struct bio *bio;
104 	struct bvec_iter iter;
105 	struct request *rq;
106 };
107 
108 enum frame_flags {
109 	FFL_PROBE = 1,
110 };
111 
112 struct frame {
113 	struct list_head head;
114 	u32 tag;
115 	struct timeval sent;	/* high-res time packet was sent */
116 	u32 sent_jiffs;		/* low-res jiffies-based sent time */
117 	ulong waited;
118 	ulong waited_total;
119 	struct aoetgt *t;		/* parent target I belong to */
120 	struct sk_buff *skb;		/* command skb freed on module exit */
121 	struct sk_buff *r_skb;		/* response skb for async processing */
122 	struct buf *buf;
123 	struct bvec_iter iter;
124 	char flags;
125 };
126 
127 struct aoeif {
128 	struct net_device *nd;
129 	ulong lost;
130 	int bcnt;
131 };
132 
133 struct aoetgt {
134 	unsigned char addr[6];
135 	ushort nframes;		/* cap on frames to use */
136 	struct aoedev *d;			/* parent device I belong to */
137 	struct list_head ffree;			/* list of free frames */
138 	struct aoeif ifs[NAOEIFS];
139 	struct aoeif *ifp;	/* current aoeif in use */
140 	ushort nout;		/* number of AoE commands outstanding */
141 	ushort maxout;		/* current value for max outstanding */
142 	ushort next_cwnd;	/* incr maxout after decrementing to zero */
143 	ushort ssthresh;	/* slow start threshold */
144 	ulong falloc;		/* number of allocated frames */
145 	int taint;		/* how much we want to avoid this aoetgt */
146 	int minbcnt;
147 	int wpkts, rpkts;
148 	char nout_probes;
149 };
150 
151 struct aoedev {
152 	struct aoedev *next;
153 	ulong sysminor;
154 	ulong aoemajor;
155 	u32 rttavg;		/* scaled AoE round trip time average */
156 	u32 rttdev;		/* scaled round trip time mean deviation */
157 	u16 aoeminor;
158 	u16 flags;
159 	u16 nopen;		/* (bd_openers isn't available without sleeping) */
160 	u16 fw_ver;		/* version of blade's firmware */
161 	u16 lasttag;		/* last tag sent */
162 	u16 useme;
163 	ulong ref;
164 	struct work_struct work;/* disk create work struct */
165 	struct gendisk *gd;
166 	struct dentry *debugfs;
167 	struct request_queue *blkq;
168 	struct hd_geometry geo;
169 	sector_t ssize;
170 	struct timer_list timer;
171 	spinlock_t lock;
172 	struct sk_buff_head skbpool;
173 	mempool_t *bufpool;	/* for deadlock-free Buf allocation */
174 	struct {		/* pointers to work in progress */
175 		struct buf *buf;
176 		struct bio *nxbio;
177 		struct request *rq;
178 	} ip;
179 	ulong maxbcnt;
180 	struct list_head factive[NFACTIVE];	/* hash of active frames */
181 	struct list_head rexmitq; /* deferred retransmissions */
182 	struct aoetgt **targets;
183 	ulong ntargets;		/* number of allocated aoetgt pointers */
184 	struct aoetgt **tgt;	/* target in use when working */
185 	ulong kicked;
186 	char ident[512];
187 };
188 
189 /* kthread tracking */
190 struct ktstate {
191 	struct completion rendez;
192 	struct task_struct *task;
193 	wait_queue_head_t *waitq;
194 	int (*fn) (int);
195 	char name[12];
196 	spinlock_t *lock;
197 	int id;
198 	int active;
199 };
200 
201 int aoeblk_init(void);
202 void aoeblk_exit(void);
203 void aoeblk_gdalloc(void *);
204 void aoedisk_rm_debugfs(struct aoedev *d);
205 void aoedisk_rm_sysfs(struct aoedev *d);
206 
207 int aoechr_init(void);
208 void aoechr_exit(void);
209 void aoechr_error(char *);
210 
211 void aoecmd_work(struct aoedev *d);
212 void aoecmd_cfg(ushort aoemajor, unsigned char aoeminor);
213 struct sk_buff *aoecmd_ata_rsp(struct sk_buff *);
214 void aoecmd_cfg_rsp(struct sk_buff *);
215 void aoecmd_sleepwork(struct work_struct *);
216 void aoecmd_wreset(struct aoetgt *t);
217 void aoecmd_cleanslate(struct aoedev *);
218 void aoecmd_exit(void);
219 int aoecmd_init(void);
220 struct sk_buff *aoecmd_ata_id(struct aoedev *);
221 void aoe_freetframe(struct frame *);
222 void aoe_flush_iocq(void);
223 void aoe_flush_iocq_by_index(int);
224 void aoe_end_request(struct aoedev *, struct request *, int);
225 int aoe_ktstart(struct ktstate *k);
226 void aoe_ktstop(struct ktstate *k);
227 
228 int aoedev_init(void);
229 void aoedev_exit(void);
230 struct aoedev *aoedev_by_aoeaddr(ulong maj, int min, int do_alloc);
231 void aoedev_downdev(struct aoedev *d);
232 int aoedev_flush(const char __user *str, size_t size);
233 void aoe_failbuf(struct aoedev *, struct buf *);
234 void aoedev_put(struct aoedev *);
235 
236 int aoenet_init(void);
237 void aoenet_exit(void);
238 void aoenet_xmit(struct sk_buff_head *);
239 int is_aoe_netif(struct net_device *ifp);
240 int set_aoe_iflist(const char __user *str, size_t size);
241