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