Linux-libre 3.10.54-gnu
[librecmc/linux-libre.git] / drivers / block / aoe / aoe.h
1 /* Copyright (c) 2012 Coraid, Inc.  See COPYING for GPL terms. */
2 #define VERSION "81"
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         ulong resid;
104         ulong bv_resid;
105         sector_t sector;
106         struct bio *bio;
107         struct bio_vec *bv;
108         struct request *rq;
109 };
110
111 enum frame_flags {
112         FFL_PROBE = 1,
113 };
114
115 struct frame {
116         struct list_head head;
117         u32 tag;
118         struct timeval sent;    /* high-res time packet was sent */
119         u32 sent_jiffs;         /* low-res jiffies-based sent time */
120         ulong waited;
121         ulong waited_total;
122         struct aoetgt *t;               /* parent target I belong to */
123         sector_t lba;
124         struct sk_buff *skb;            /* command skb freed on module exit */
125         struct sk_buff *r_skb;          /* response skb for async processing */
126         struct buf *buf;
127         struct bio_vec *bv;
128         ulong bcnt;
129         ulong bv_off;
130         char flags;
131 };
132
133 struct aoeif {
134         struct net_device *nd;
135         ulong lost;
136         int bcnt;
137 };
138
139 struct aoetgt {
140         unsigned char addr[6];
141         ushort nframes;         /* cap on frames to use */
142         struct aoedev *d;                       /* parent device I belong to */
143         struct list_head ffree;                 /* list of free frames */
144         struct aoeif ifs[NAOEIFS];
145         struct aoeif *ifp;      /* current aoeif in use */
146         ushort nout;            /* number of AoE commands outstanding */
147         ushort maxout;          /* current value for max outstanding */
148         ushort next_cwnd;       /* incr maxout after decrementing to zero */
149         ushort ssthresh;        /* slow start threshold */
150         ulong falloc;           /* number of allocated frames */
151         int taint;              /* how much we want to avoid this aoetgt */
152         int minbcnt;
153         int wpkts, rpkts;
154         char nout_probes;
155 };
156
157 struct aoedev {
158         struct aoedev *next;
159         ulong sysminor;
160         ulong aoemajor;
161         u32 rttavg;             /* scaled AoE round trip time average */
162         u32 rttdev;             /* scaled round trip time mean deviation */
163         u16 aoeminor;
164         u16 flags;
165         u16 nopen;              /* (bd_openers isn't available without sleeping) */
166         u16 fw_ver;             /* version of blade's firmware */
167         u16 lasttag;            /* last tag sent */
168         u16 useme;
169         ulong ref;
170         struct work_struct work;/* disk create work struct */
171         struct gendisk *gd;
172         struct request_queue *blkq;
173         struct hd_geometry geo;
174         sector_t ssize;
175         struct timer_list timer;
176         spinlock_t lock;
177         struct sk_buff_head skbpool;
178         mempool_t *bufpool;     /* for deadlock-free Buf allocation */
179         struct {                /* pointers to work in progress */
180                 struct buf *buf;
181                 struct bio *nxbio;
182                 struct request *rq;
183         } ip;
184         ulong maxbcnt;
185         struct list_head factive[NFACTIVE];     /* hash of active frames */
186         struct list_head rexmitq; /* deferred retransmissions */
187         struct aoetgt **targets;
188         ulong ntargets;         /* number of allocated aoetgt pointers */
189         struct aoetgt **tgt;    /* target in use when working */
190         ulong kicked;
191         char ident[512];
192 };
193
194 /* kthread tracking */
195 struct ktstate {
196         struct completion rendez;
197         struct task_struct *task;
198         wait_queue_head_t *waitq;
199         int (*fn) (void);
200         char *name;
201         spinlock_t *lock;
202 };
203
204 int aoeblk_init(void);
205 void aoeblk_exit(void);
206 void aoeblk_gdalloc(void *);
207 void aoedisk_rm_sysfs(struct aoedev *d);
208
209 int aoechr_init(void);
210 void aoechr_exit(void);
211 void aoechr_error(char *);
212
213 void aoecmd_work(struct aoedev *d);
214 void aoecmd_cfg(ushort aoemajor, unsigned char aoeminor);
215 struct sk_buff *aoecmd_ata_rsp(struct sk_buff *);
216 void aoecmd_cfg_rsp(struct sk_buff *);
217 void aoecmd_sleepwork(struct work_struct *);
218 void aoecmd_wreset(struct aoetgt *t);
219 void aoecmd_cleanslate(struct aoedev *);
220 void aoecmd_exit(void);
221 int aoecmd_init(void);
222 struct sk_buff *aoecmd_ata_id(struct aoedev *);
223 void aoe_freetframe(struct frame *);
224 void aoe_flush_iocq(void);
225 void aoe_end_request(struct aoedev *, struct request *, int);
226 int aoe_ktstart(struct ktstate *k);
227 void aoe_ktstop(struct ktstate *k);
228
229 int aoedev_init(void);
230 void aoedev_exit(void);
231 struct aoedev *aoedev_by_aoeaddr(ulong maj, int min, int do_alloc);
232 void aoedev_downdev(struct aoedev *d);
233 int aoedev_flush(const char __user *str, size_t size);
234 void aoe_failbuf(struct aoedev *, struct buf *);
235 void aoedev_put(struct aoedev *);
236
237 int aoenet_init(void);
238 void aoenet_exit(void);
239 void aoenet_xmit(struct sk_buff_head *);
240 int is_aoe_netif(struct net_device *ifp);
241 int set_aoe_iflist(const char __user *str, size_t size);