cissreg.h revision 1.4 1 /* $NetBSD: cissreg.h,v 1.4 2013/10/12 16:52:21 christos Exp $ */
2 /* $OpenBSD: cissreg.h,v 1.11 2010/06/03 01:02:13 dlg Exp $ */
3
4 /*
5 * Copyright (c) 2005,2006 Michael Shalayeff
6 * All rights reserved.
7 *
8 * Permission to use, copy, modify, and distribute this software for any
9 * purpose with or without fee is hereby granted, provided that the above
10 * copyright notice and this permission notice appear in all copies.
11 *
12 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER IN
17 * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
18 * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 */
20
21 #define CISS_BIGBIT 0x80 /* texas radio and the big beat! */
22
23 #define CISS_IDB 0x20
24 #define CISS_IDB_CFG 0x01
25 #define CISS_ISR 0x30
26 #define CISS_IMR 0x34
27 #define CISS_READYENAB 4
28 #define CISS_READYENA 8
29 #define CISS_INQ 0x40
30 #define CISS_OUTQ 0x44
31 #define CISS_CFG_BAR 0xb4
32 #define CISS_CFG_OFF 0xb8
33
34 /* 64bit FIFO mode input/output post queues */
35 #define CISS_INQ64_LO 0xc0
36 #define CISS_INQ64_HI 0xc4
37 #define CISS_OUTQ64_LO 0xc8
38 #define CISS_OUTQ64_HI 0xcc
39
40 #define CISS_DRVMAP_SIZE (128 / 8)
41
42 #define CISS_CMD_CTRL_GET 0x26
43 #define CISS_CMD_CTRL_SET 0x27
44 /* sub-commands for GET/SET */
45 #define CISS_CMS_CTRL_LDID 0x10
46 #define CISS_CMS_CTRL_CTRL 0x11
47 #define CISS_CMS_CTRL_LDSTAT 0x12
48 #define CISS_CMS_CTRL_PDID 0x15
49 #define CISS_CMS_CTRL_PDBLINK 0x16
50 #define CISS_CMS_CTRL_PDBLSENS 0x17
51 #define CISS_CMS_CTRL_LDIDEXT 0x18
52 #define CISS_CMS_CTRL_REDSTAT 0x82
53 #define CISS_CMS_CTRL_FLUSH 0xc2
54 #define CISS_CMS_CTRL_ACCEPT 0xe0
55
56 #define CISS_CMD_READ 0xc0
57 #define CISS_CMD_READ_EVENT 0xd0
58 #define CISS_EVENT_RECENT 0x08 /* ignore previous events */
59 #define CISS_EVENT_RSTOLD 0x04 /* start w/ the oldest one */
60 #define CISS_EVENT_ORDER 0x02 /* keep the order */
61 #define CISS_EVENT_SYNC 0x01 /* sync mode: wait till new come */
62 #define CISS_CMD_LDMAP 0xc2
63 #define CISS_CMD_PDMAP 0xc3
64
65 #define ciss_bitset(d, v) ((v)[(d) >> 3] & (1 << ((d) & 7)))
66
67 struct ciss_softc;
68
69 struct ciss_config {
70 u_int32_t signature;
71 #define CISS_SIGNATURE (*(const u_int32_t *)"CISS")
72 u_int32_t version;
73 u_int32_t methods;
74 #define CISS_METH_READY 0x00000001 /* indicate to accept commands */
75 #define CISS_METH_SIMPL 0x00000002 /* simple mode */
76 #define CISS_METH_PERF 0x00000004 /* performant mode */
77 #define CISS_METH_EMQ 0x00000008 /* MEMQ method */
78 #define CISS_METH_BIT63 0x08000000 /* address bit 63 is valid */
79 #define CISS_METH_FIFO64_RRO 0x10000000 /* 64bit FIFO reverse read order */
80 #define CISS_METH_SHORT_TAG 0x20000000 /* short 4 byte tag support */
81 #define CISS_METH_MSIX 0x40000000 /* directed MSI-X support */
82 #define CISS_METH_FIFO64 0x80000000 /* 64bit FIFO support */
83 u_int32_t amethod;
84 u_int32_t rmethod;
85 u_int32_t paddr_lim;
86 u_int32_t int_delay;
87 u_int32_t int_count;
88 u_int32_t maxcmd;
89 u_int32_t scsibus;
90 #define CISS_BUS_U2 0x0001
91 #define CISS_BUS_U3 0x0002
92 #define CISS_BUS_FC1 0x0100
93 #define CISS_BUS_FC2 0x0200
94 u_int32_t troff;
95 u_int8_t hostname[16];
96 u_int32_t heartbeat;
97 u_int32_t driverf;
98 #define CISS_DRV_UATT 0x0001
99 #define CISS_DRV_QINI 0x0002
100 #define CISS_DRV_LCKINT 0x0004
101 #define CISS_DRV_QTAGS 0x0008
102 #define CISS_DRV_ALPHA 0x0010
103 #define CISS_DRV_LUNS 0x0020
104 #define CISS_DRV_MSGRQ 0x0080
105 #define CISS_DRV_DBRD 0x0100
106 #define CISS_DRV_PRF 0x0200
107 u_int32_t maxsg;
108 } __packed;
109
110 struct ciss_inquiry {
111 u_int8_t numld;
112 u_int8_t sign[4];
113 u_int8_t fw_running[4];
114 u_int8_t fw_stored[4];
115 u_int8_t hw_rev;
116 u_int8_t resv0[12];
117 u_int16_t pci_vendor;
118 u_int16_t pci_product;
119 u_int8_t resv1[10];
120 u_int8_t market_rev;
121 u_int8_t flags;
122 #define CISS_INQ_WIDE 0x08
123 #define CISS_INQ_BIGMAP 0x80
124 #define CISS_INQ_BITS "\020\04WIDE\010BIGMAP"
125 u_int8_t resv2[2];
126 u_int8_t nscsi_bus;
127 u_int8_t resv3[4];
128 u_int8_t clk[4]; /* unaligned dumbness */
129 u_int8_t buswidth;
130 u_int8_t disks[CISS_DRVMAP_SIZE];
131 u_int8_t extdisks[CISS_DRVMAP_SIZE];
132 u_int8_t nondisks[CISS_DRVMAP_SIZE];
133 } __packed;
134
135 struct ciss_ldmap {
136 u_int32_t size;
137 u_int32_t resv;
138 struct {
139 u_int32_t tgt;
140 u_int32_t tgt2;
141 } map[1];
142 } __packed;
143
144 struct ciss_flush {
145 u_int16_t flush;
146 #define CISS_FLUSH_ENABLE 0
147 #define CISS_FLUSH_DISABLE 1
148 u_int16_t resv[255];
149 } __packed;
150
151 struct ciss_blink {
152 u_int32_t duration; /* x100ms */
153 u_int32_t elapsed; /* only for sense */
154 u_int8_t pdtab[256];
155 #define CISS_BLINK_ALL 1
156 #define CISS_BLINK_TIMED 2
157 u_int8_t res[248];
158 } __packed;
159
160 struct ciss_ldid {
161 u_int16_t blksize;
162 u_int16_t nblocks[2]; /* UNALIGNED! */
163 u_int8_t params[16];
164 u_int8_t type;
165 #define CISS_LD_RAID0 0
166 #define CISS_LD_RAID4 1
167 #define CISS_LD_RAID1 2
168 #define CISS_LD_RAID5 3
169 #define CISS_LD_RAID51 4
170 #define CISS_LD_RAIDADG 5
171 u_int8_t res0;
172 u_int8_t bios_dis;
173 u_int8_t res1;
174 u_int32_t id;
175 u_int8_t label[64];
176 u_int64_t nbigblocks;
177 u_int8_t res2[410];
178 } __packed;
179
180 struct ciss_ldstat {
181 u_int8_t stat;
182 #define CISS_LD_OK 0
183 #define CISS_LD_FAILED 1
184 #define CISS_LD_UNCONF 2
185 #define CISS_LD_DEGRAD 3
186 #define CISS_LD_RBLDRD 4 /* ready for rebuild */
187 #define CISS_LD_REBLD 5
188 #define CISS_LD_PDINV 6 /* wrong phys drive replaced */
189 #define CISS_LD_PDUNC 7 /* phys drive is not connected proper */
190 #define CISS_LD_EXPND 10 /* expanding */
191 #define CISS_LD_NORDY 11 /* volume is not ready */
192 #define CISS_LD_QEXPND 12 /* queued for expansion */
193 u_int8_t failed[4]; /* failed map */
194 u_int8_t res0[416];
195 u_int8_t prog[4]; /* blocks left to rebuild/expand */
196 u_int8_t rebuild; /* drive that is rebuilding */
197 u_int16_t remapcnt[32]; /* count of remapped blocks for pds */
198 u_int8_t replaced[4]; /* replaced drives map */
199 u_int8_t spare[4]; /* used spares map */
200 u_int8_t sparestat; /* spare status */
201 #define CISS_LD_CONF 0x01 /* spare configured */
202 #define CISS_LD_RBLD 0x02 /* spare is used and rebuilding */
203 #define CISS_LD_DONE 0x04 /* spare rebuild done */
204 #define CISS_LD_FAIL 0x08 /* at least one spare drive has failed */
205 #define CISS_LD_USED 0x10 /* at least one spare drive is used */
206 #define CISS_LD_AVAIL 0x20 /* at least one spare is available */
207 u_int8_t sparemap[32]; /* spare->pd replacement map */
208 u_int8_t replok[4]; /* replaced failed map */
209 u_int8_t readyok; /* ready to become ok */
210 u_int8_t memfail; /* cache mem failure */
211 u_int8_t expfail; /* expansion failure */
212 u_int8_t rebldfail; /* rebuild failure */
213 #define CISS_LD_RBLD_READ 0x01 /* read faild */
214 #define CISS_LD_RBLD_WRITE 0x02 /* write fail */
215 u_int8_t bigfailed[16]; /* bigmap vers of same of the above */
216 u_int8_t bigremapcnt[256];
217 u_int8_t bigreplaced[16];
218 u_int8_t bigspare[16];
219 u_int8_t bigsparemap[128];
220 u_int8_t bigreplok[16];
221 u_int8_t bigrebuild; /* big-number rebuilding driveno */
222 } __packed;
223
224 struct ciss_pdid {
225 u_int8_t bus;
226 u_int8_t target;
227 u_int16_t blksz;
228 u_int32_t nblocks;
229 u_int32_t resblks;
230 u_int8_t model[40];
231 u_int8_t serial[40];
232 u_int8_t revision[8];
233 u_int8_t bits;
234 u_int8_t res0[2];
235 u_int8_t present;
236 #define CISS_PD_PRESENT 0x01
237 #define CISS_PD_NONDSK 0x02
238 #define CISS_PD_WIDE 0x04
239 #define CISS_PD_SYNC 0x08
240 #define CISS_PD_NARROW 0x10
241 #define CISS_PD_W2NARR 0x20 /* wide downgrade to narrow */
242 #define CISS_PD_ULTRA 0x40
243 #define CISS_PD_ULTRA2 0x80
244 u_int8_t config;
245 #define CISS_PD_SMART 0x01
246 #define CISS_PD_SMERRR 0x02
247 #define CISS_PD_SMERRE 0x04
248 #define CISS_PD_SMERRD 0x08
249 #define CISS_PD_EXT 0x10
250 #define CISS_PD_CONF 0x20
251 #define CISS_PD_SPARE 0x40
252 #define CISS_PD_CASAVE 0x80
253 u_int8_t res1;
254 u_int8_t cache;
255 #define CISS_PD_CACHE 0x01
256 #define CISS_PD_CASAFE 0x01
257 u_int8_t res2[5];
258 u_int8_t connector[2];
259 u_int8_t res3;
260 u_int8_t bay;
261 u_int16_t rpm;
262 u_int8_t type;
263 u_int8_t res4[393];
264 } __packed;
265
266 struct ciss_event {
267 u_int32_t reltime; /* time since controller boot */
268 u_int16_t event;
269 #define CISS_EVCLS_PROTO 0
270 #define CISS_EVCLS_PLUG 1
271 #define CISS_EVCLS_HW 2
272 #define CISS_EVCLS_ENV 3
273 #define CISS_EVCLS_PD 4 /* ciss_evpdchg in details */
274 #define CISS_EVCLS_LD 5
275 #define CISS_EVCLS_CTRL 6
276 #define CISS_EVCLS_CISS 8 /* funky errors */
277 #define CISS_EVCLS_RESV 9
278 u_int16_t subevent;
279 #define CISS_EVPROTO_STAT 0
280 #define CISS_EVPROTO_ERR 1
281 #define CISS_EVPLUG_PDCHG 0 /* ciss_evpdchg */
282 #define CISS_EVPLUG_POWER 1 /* ciss_evpschg */
283 #define CISS_EVPLUG_FAN 2 /* ciss_evfanchg */
284 #define CISS_EVPLUG_UPS 3 /* ciss_evupschg */
285 #define CISS_EVPLUG_CTRL 4 /* ciss_evctrlchg: ctrl removed? (; */
286 #define CISS_EVHW_CABLES 0
287 #define CISS_EVHW_MEMORY 1
288 #define CISS_EVHW_FAN 2 /* detail as in CISS_EVPLUG_FAN */
289 #define CISS_EVHW_VRM 3
290 #define CISS_EVENV_TEMP 0 /* ciss_evtempchg */
291 #define CISS_EVENV_PS 1
292 #define CISS_EVENV_CHASSIS 2
293 #define CISS_EVENV_AC 3
294 #define CISS_EVPD_STAT 0
295 #define CISS_EVLD_STAT 0
296 #define CISS_EVLD_ERR 1
297 #define CISS_EVLD_CHECK 2 /* surface check */
298 #define CISS_EVCTRL_STAT 0
299 u_int16_t detail;
300 #define CISS_EVSTAT_NONE 0
301 #define CISS_EVSTAT_DISABLE 1
302 #define CISS_EVSTAT_TMO 2 /* async event poll timeout */
303 #define CISS_EVERR_OVERFLOW 0 /* event queue overflow */
304 #define CISS_EVPLUG_REMOVE 0
305 #define CISS_EVPLUG_INSERT 1
306 #define CISS_EVFAN_FAULT 0
307 #define CISS_EVFAN_DEGRADED 1
308 #define CISS_EVFAN_OK 2
309 #define CISS_EVVRM_REMOVE 0
310 #define CISS_EVVRM_INSERT 1
311 #define CISS_EVVRM_FAILED 2
312 #define CISS_EVVRM_OK 3
313 #define CISS_EVTEMP_LIMEX 0 /* limit exceeded */
314 #define CISS_EVTEMP_WARN 1
315 #define CISS_EVTEMP_OK 2
316 #define CISS_EVPS_FAIL 0
317 #define CISS_EVPS_OK 2
318 #define CISS_EVCHAS_OPEN 0
319 #define CISS_EVCHAS_CLOSE 2
320 #define CISS_EVAC_FAIL 0
321 #define CISS_EVAC_BATTLOW 1
322 #define CISS_EVPDSTAT_FAIL 0
323 #define CISS_EVLDSTAT_CHG 0 /* ciss_evldchg */
324 #define CISS_EVLDSTAT_EXMEDIA 1 /* untolerant cfg got drive replaced */
325 #define CISS_EVLDSTAT_RERDERR 2 /* ciss_evldrblderr */
326 #define CISS_EVLDSTAT_REWRERR 3 /* ciss_evldrblderr */
327 #define CISS_EVLDERR_FATAL 0 /* ciss_evlderr */
328 #define CISS_EVCHECK_DONE 0 /* details have onle 16bit ld num */
329 #define CISS_EVCTRLSTAT_CHG 0 /* ciss_evctrlstat */
330 u_int8_t data[64];
331 u_int8_t msg[80];
332 u_int32_t tag;
333 u_int16_t monday;
334 u_int16_t year;
335 u_int32_t time;
336 u_int16_t presec; /* time for events before boot */
337 u_int8_t device[8];
338 u_int8_t resv[336];
339 } __packed;
340
341 struct ciss_evpdchg { /* details pointer */
342 u_int16_t pd;
343 u_int8_t flag; /* 1 for configured */
344 u_int8_t spare;
345 u_int8_t bigpd; /* big number of the pd */
346 u_int8_t baynum;
347 } __packed;
348
349 struct ciss_evpschg { /* details pointer */
350 u_int16_t port;
351 u_int16_t psid;
352 u_int16_t box;
353 } __packed;
354
355 struct ciss_evfanchg { /* details pointer */
356 u_int16_t port;
357 u_int16_t fanid;
358 u_int16_t box;
359 } __packed;
360
361 struct ciss_evupschg { /* details pointer */
362 u_int16_t port;
363 u_int16_t upsid;
364 } __packed;
365
366 struct ciss_evctrlchg { /* details pointer */
367 u_int16_t slot;
368 } __packed;
369
370 struct ciss_evtempchg { /* details pointer */
371 u_int16_t port;
372 u_int16_t sensid;
373 u_int16_t box;
374 } __packed;
375
376 struct ciss_evldchg { /* details pointer */
377 u_int16_t ld;
378 u_int8_t prevstat; /* same as ldstat->state */
379 u_int8_t newstat; /* same as ldstat->state */
380 u_int8_t sparestat;
381 } __packed;
382
383 struct ciss_evldrblderr { /* details pointer */
384 u_int16_t ld;
385 u_int8_t replace;
386 u_int8_t errpd;
387 u_int8_t bigreplace;
388 u_int8_t bigerrpd;
389 } __packed;
390
391 struct ciss_evlderr { /* details pointer */
392 u_int16_t ld;
393 u_int16_t blkno[2]; /* unaligned; if >2tb see big later */
394 u_int16_t count;
395 u_int8_t ldcmd;
396 u_int8_t bus;
397 u_int8_t target;
398 u_int8_t bigblkno[8]; /* unaligned */
399 } __packed;
400
401 struct ciss_evctrlstat { /* details pointer */
402 u_int8_t prefctrl;
403 u_int8_t currmode;
404 u_int8_t redctrl;
405 u_int8_t redfail;
406 u_int8_t prevctrl;
407 u_int8_t prevmode;
408 u_int8_t prevred;
409 u_int8_t prevfail;
410 } __packed;
411
412 struct ciss_cmd {
413 u_int8_t resv0; /* 00 */
414 u_int8_t sgin; /* 01: #sg in the cmd */
415 u_int16_t sglen; /* 02: #sg total */
416 u_int32_t id; /* 04: cmd id << 2 and status bits */
417 #define CISS_CMD_ERR 0x02
418 u_int32_t id_hi; /* 08: not used */
419 u_int32_t tgt; /* 0c: tgt:bus:mode or lun:mode */
420 #define CISS_CMD_MODE_PERIPH 0x00000000
421 #define CISS_CMD_MODE_LD 0x40000000
422 #define CISS_CMD_TGT_MASK 0x40ffffff
423 #define CISS_CMD_BUS_MASK 0x3f000000
424 #define CISS_CMD_BUS_SHIFT 24
425 u_int32_t tgt2; /* 10: scsi-3 address bytes */
426
427 u_int8_t cdblen; /* 14: valid length of cdb */
428 u_int8_t flags; /* 15 */
429 #define CISS_CDB_CMD 0x00
430 #define CISS_CDB_MSG 0x01
431 #define CISS_CDB_NOTAG 0x00
432 #define CISS_CDB_SIMPL 0x20
433 #define CISS_CDB_QHEAD 0x28
434 #define CISS_CDB_ORDR 0x30
435 #define CISS_CDB_AUTO 0x38
436 #define CISS_CDB_IN 0x80
437 #define CISS_CDB_OUT 0x40
438 u_int16_t tmo; /* 16: timeout in seconds */
439 #define CISS_MAX_CDB 16
440 u_int8_t cdb[16];/* 18 */
441
442 u_int64_t err_pa; /* 28: pa(struct ciss_error *) */
443 u_int32_t err_len;/* 30 */
444
445 struct { /* 34 */
446 u_int32_t addr_lo;
447 u_int32_t addr_hi;
448 u_int32_t len;
449 u_int32_t flags;
450 #define CISS_SG_EXT 0x0001
451 } sgl[1];
452 } __packed;
453
454 struct ciss_error {
455 u_int8_t scsi_stat; /* SCSI_OK etc */
456 u_int8_t senselen;
457 u_int16_t cmd_stat;
458 #define CISS_ERR_OK 0
459 #define CISS_ERR_TGTST 1 /* target status */
460 #define CISS_ERR_UNRUN 2
461 #define CISS_ERR_OVRUN 3
462 #define CISS_ERR_INVCMD 4
463 #define CISS_ERR_PROTE 5
464 #define CISS_ERR_HWERR 6
465 #define CISS_ERR_CLOSS 7
466 #define CISS_ERR_ABRT 8
467 #define CISS_ERR_FABRT 9
468 #define CISS_ERR_UABRT 10
469 #define CISS_ERR_TMO 11
470 #define CISS_ERR_NABRT 12
471 u_int32_t resid;
472 u_int8_t err_type[4];
473 u_int32_t err_info;
474 u_int8_t sense[32];
475 } __packed;
476
477 struct ciss_ccb {
478 TAILQ_ENTRY(ciss_ccb) ccb_link;
479 struct ciss_softc *ccb_sc;
480 paddr_t ccb_cmdpa;
481 enum {
482 CISS_CCB_FREE = 0x01,
483 CISS_CCB_READY = 0x02,
484 CISS_CCB_ONQ = 0x04,
485 CISS_CCB_PREQ = 0x08,
486 CISS_CCB_POLL = 0x10,
487 CISS_CCB_FAIL = 0x80
488 #define CISS_CCB_BITS "\020\01FREE\02READY\03ONQ\04PREQ\05POLL\010FAIL"
489 } ccb_state;
490
491 struct scsipi_xfer *ccb_xs;
492 size_t ccb_len;
493 void *ccb_data;
494 bus_dmamap_t ccb_dmamap;
495
496 struct ciss_error ccb_err;
497 struct ciss_cmd ccb_cmd; /* followed by sgl */
498 };
499
500 typedef TAILQ_HEAD(ciss_queue_head, ciss_ccb) ciss_queue_head;
501
502