Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
megaraid_sas_fusion.h
Go to the documentation of this file.
1 /*
2  * Linux MegaRAID driver for SAS based RAID controllers
3  *
4  * Copyright (c) 2009-2012 LSI Corporation.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19  *
20  * FILE: megaraid_sas_fusion.h
21  *
22  * Authors: LSI Corporation
23  * Manoj Jose
24  * Sumant Patro
25  *
26  * Send feedback to: <[email protected]>
27  *
28  * Mail to: LSI Corporation, 1621 Barber Lane, Milpitas, CA 95035
29  * ATTN: Linuxraid
30  */
31 
32 #ifndef _MEGARAID_SAS_FUSION_H_
33 #define _MEGARAID_SAS_FUSION_H_
34 
35 /* Fusion defines */
36 #define MEGASAS_MAX_SZ_CHAIN_FRAME 1024
37 #define MFI_FUSION_ENABLE_INTERRUPT_MASK (0x00000009)
38 #define MEGA_MPI2_RAID_DEFAULT_IO_FRAME_SIZE 256
39 #define MEGASAS_MPI2_FUNCTION_PASSTHRU_IO_REQUEST 0xF0
40 #define MEGASAS_MPI2_FUNCTION_LD_IO_REQUEST 0xF1
41 #define MEGASAS_LOAD_BALANCE_FLAG 0x1
42 #define MEGASAS_DCMD_MBOX_PEND_FLAG 0x1
43 #define HOST_DIAG_WRITE_ENABLE 0x80
44 #define HOST_DIAG_RESET_ADAPTER 0x4
45 #define MEGASAS_FUSION_MAX_RESET_TRIES 3
46 #define MAX_MSIX_QUEUES_FUSION 16
47 
48 /* Invader defines */
49 #define MPI2_TYPE_CUDA 0x2
50 #define MPI25_SAS_DEVICE0_FLAGS_ENABLED_FAST_PATH 0x4000
51 #define MR_RL_FLAGS_GRANT_DESTINATION_CPU0 0x00
52 #define MR_RL_FLAGS_GRANT_DESTINATION_CPU1 0x10
53 #define MR_RL_FLAGS_GRANT_DESTINATION_CUDA 0x80
54 #define MR_RL_FLAGS_SEQ_NUM_ENABLE 0x8
55 
56 /* T10 PI defines */
57 #define MR_PROT_INFO_TYPE_CONTROLLER 0x8
58 #define MEGASAS_SCSI_VARIABLE_LENGTH_CMD 0x7f
59 #define MEGASAS_SCSI_SERVICE_ACTION_READ32 0x9
60 #define MEGASAS_SCSI_SERVICE_ACTION_WRITE32 0xB
61 #define MEGASAS_SCSI_ADDL_CDB_LEN 0x18
62 #define MEGASAS_RD_WR_PROTECT_CHECK_ALL 0x20
63 #define MEGASAS_RD_WR_PROTECT_CHECK_NONE 0x60
64 #define MEGASAS_EEDPBLOCKSIZE 512
65 
66 /*
67  * Raid context flags
68  */
69 
70 #define MR_RAID_CTX_RAID_FLAGS_IO_SUB_TYPE_SHIFT 0x4
71 #define MR_RAID_CTX_RAID_FLAGS_IO_SUB_TYPE_MASK 0x30
75 };
76 
77 /*
78  * Request descriptor types
79  */
80 #define MEGASAS_REQ_DESCRIPT_FLAGS_LD_IO 0x7
81 #define MEGASAS_REQ_DESCRIPT_FLAGS_MFA 0x1
82 #define MEGASAS_REQ_DESCRIPT_FLAGS_NO_LOCK 0x2
83 #define MEGASAS_REQ_DESCRIPT_FLAGS_TYPE_SHIFT 1
84 
85 #define MEGASAS_FP_CMD_LEN 16
86 #define MEGASAS_FUSION_IN_RESET 0
87 
88 /*
89  * Raid Context structure which describes MegaRAID specific IO Paramenters
90  * This resides at offset 0x60 where the SGL normally starts in MPT IO Frames
91  */
92 
93 struct RAID_CONTEXT {
94  u8 Type:4;
95  u8 nseg:4;
110  u8 resvd2[3];
111 };
112 
113 #define RAID_CTX_SPANARM_ARM_SHIFT (0)
114 #define RAID_CTX_SPANARM_ARM_MASK (0x1f)
115 
116 #define RAID_CTX_SPANARM_SPAN_SHIFT (5)
117 #define RAID_CTX_SPANARM_SPAN_MASK (0xE0)
118 
119 /*
120  * define region lock types
121  */
127 };
128 
129 /* MPI2 defines */
130 #define MPI2_FUNCTION_IOC_INIT (0x02) /* IOC Init */
131 #define MPI2_WHOINIT_HOST_DRIVER (0x04)
132 #define MPI2_VERSION_MAJOR (0x02)
133 #define MPI2_VERSION_MINOR (0x00)
134 #define MPI2_VERSION_MAJOR_MASK (0xFF00)
135 #define MPI2_VERSION_MAJOR_SHIFT (8)
136 #define MPI2_VERSION_MINOR_MASK (0x00FF)
137 #define MPI2_VERSION_MINOR_SHIFT (0)
138 #define MPI2_VERSION ((MPI2_VERSION_MAJOR << MPI2_VERSION_MAJOR_SHIFT) | \
139  MPI2_VERSION_MINOR)
140 #define MPI2_HEADER_VERSION_UNIT (0x10)
141 #define MPI2_HEADER_VERSION_DEV (0x00)
142 #define MPI2_HEADER_VERSION_UNIT_MASK (0xFF00)
143 #define MPI2_HEADER_VERSION_UNIT_SHIFT (8)
144 #define MPI2_HEADER_VERSION_DEV_MASK (0x00FF)
145 #define MPI2_HEADER_VERSION_DEV_SHIFT (0)
146 #define MPI2_HEADER_VERSION ((MPI2_HEADER_VERSION_UNIT << 8) | \
147  MPI2_HEADER_VERSION_DEV)
148 #define MPI2_IEEE_SGE_FLAGS_IOCPLBNTA_ADDR (0x03)
149 #define MPI2_SCSIIO_EEDPFLAGS_INC_PRI_REFTAG (0x8000)
150 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_REFTAG (0x0400)
151 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_REMOVE_OP (0x0003)
152 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_APPTAG (0x0200)
153 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_GUARD (0x0100)
154 #define MPI2_SCSIIO_EEDPFLAGS_INSERT_OP (0x0004)
155 #define MPI2_FUNCTION_SCSI_IO_REQUEST (0x00) /* SCSI IO */
156 #define MPI2_REQ_DESCRIPT_FLAGS_HIGH_PRIORITY (0x06)
157 #define MPI2_REQ_DESCRIPT_FLAGS_SCSI_IO (0x00)
158 #define MPI2_SGE_FLAGS_64_BIT_ADDRESSING (0x02)
159 #define MPI2_SCSIIO_CONTROL_WRITE (0x01000000)
160 #define MPI2_SCSIIO_CONTROL_READ (0x02000000)
161 #define MPI2_REQ_DESCRIPT_FLAGS_TYPE_MASK (0x0E)
162 #define MPI2_RPY_DESCRIPT_FLAGS_UNUSED (0x0F)
163 #define MPI2_RPY_DESCRIPT_FLAGS_SCSI_IO_SUCCESS (0x00)
164 #define MPI2_RPY_DESCRIPT_FLAGS_TYPE_MASK (0x0F)
165 #define MPI2_WRSEQ_FLUSH_KEY_VALUE (0x0)
166 #define MPI2_WRITE_SEQUENCE_OFFSET (0x00000004)
167 #define MPI2_WRSEQ_1ST_KEY_VALUE (0xF)
168 #define MPI2_WRSEQ_2ND_KEY_VALUE (0x4)
169 #define MPI2_WRSEQ_3RD_KEY_VALUE (0xB)
170 #define MPI2_WRSEQ_4TH_KEY_VALUE (0x2)
171 #define MPI2_WRSEQ_5TH_KEY_VALUE (0x7)
172 #define MPI2_WRSEQ_6TH_KEY_VALUE (0xD)
173 
180 };
181 
184  union {
187  } u;
188 };
189 
191  u8 CDB[20]; /* 0x00 */
195  u32 TransferLength; /* 0x1C */
196 };
197 
202  union {
205  } u;
206 };
207 
211 };
212 
216 };
217 
224 };
225 
232 };
233 
237 };
238 
242 };
243 
249 };
250 
252  u8 CDB32[32];
255 };
256 
257 /*
258  * RAID SCSI IO Request Message
259  * Total SGE count will be one less than _MPI2_SCSI_IO_REQUEST
260  */
262  u16 DevHandle; /* 0x00 */
263  u8 ChainOffset; /* 0x02 */
264  u8 Function; /* 0x03 */
265  u16 Reserved1; /* 0x04 */
266  u8 Reserved2; /* 0x06 */
267  u8 MsgFlags; /* 0x07 */
268  u8 VP_ID; /* 0x08 */
269  u8 VF_ID; /* 0x09 */
270  u16 Reserved3; /* 0x0A */
272  u16 SGLFlags; /* 0x10 */
273  u8 SenseBufferLength; /* 0x12 */
274  u8 Reserved4; /* 0x13 */
275  u8 SGLOffset0; /* 0x14 */
276  u8 SGLOffset1; /* 0x15 */
277  u8 SGLOffset2; /* 0x16 */
278  u8 SGLOffset3; /* 0x17 */
279  u32 SkipCount; /* 0x18 */
280  u32 DataLength; /* 0x1C */
282  u16 IoFlags; /* 0x24 */
283  u16 EEDPFlags; /* 0x26 */
284  u32 EEDPBlockSize; /* 0x28 */
288  u8 LUN[8]; /* 0x34 */
289  u32 Control; /* 0x3C */
290  union MPI2_SCSI_IO_CDB_UNION CDB; /* 0x40 */
291  struct RAID_CONTEXT RaidContext; /* 0x60 */
292  union MPI2_SGE_IO_UNION SGL; /* 0x80 */
293 };
294 
295 /*
296  * MPT RAID MFA IO Descriptor.
297  */
300  u32 MessageAddress1:24; /* bits 31:8*/
301  u32 MessageAddress2; /* bits 61:32 */
302 };
303 
304 /* Default Request Descriptor */
306  u8 RequestFlags; /* 0x00 */
307  u8 MSIxIndex; /* 0x01 */
308  u16 SMID; /* 0x02 */
309  u16 LMID; /* 0x04 */
311 };
312 
313 /* High Priority Request Descriptor */
315  u8 RequestFlags; /* 0x00 */
316  u8 MSIxIndex; /* 0x01 */
317  u16 SMID; /* 0x02 */
318  u16 LMID; /* 0x04 */
319  u16 Reserved1; /* 0x06 */
320 };
321 
322 /* SCSI IO Request Descriptor */
324  u8 RequestFlags; /* 0x00 */
325  u8 MSIxIndex; /* 0x01 */
326  u16 SMID; /* 0x02 */
327  u16 LMID; /* 0x04 */
328  u16 DevHandle; /* 0x06 */
329 };
330 
331 /* SCSI Target Request Descriptor */
333  u8 RequestFlags; /* 0x00 */
334  u8 MSIxIndex; /* 0x01 */
335  u16 SMID; /* 0x02 */
336  u16 LMID; /* 0x04 */
337  u16 IoIndex; /* 0x06 */
338 };
339 
340 /* RAID Accelerator Request Descriptor */
342  u8 RequestFlags; /* 0x00 */
343  u8 MSIxIndex; /* 0x01 */
344  u16 SMID; /* 0x02 */
345  u16 LMID; /* 0x04 */
346  u16 Reserved; /* 0x06 */
347 };
348 
349 /* union of Request Descriptors */
357  union {
358  struct {
361  } u;
363  };
364 };
365 
366 /* Default Reply Descriptor */
368  u8 ReplyFlags; /* 0x00 */
369  u8 MSIxIndex; /* 0x01 */
372 };
373 
374 /* Address Reply Descriptor */
376  u8 ReplyFlags; /* 0x00 */
377  u8 MSIxIndex; /* 0x01 */
378  u16 SMID; /* 0x02 */
379  u32 ReplyFrameAddress; /* 0x04 */
380 };
381 
382 /* SCSI IO Success Reply Descriptor */
384  u8 ReplyFlags; /* 0x00 */
385  u8 MSIxIndex; /* 0x01 */
386  u16 SMID; /* 0x02 */
387  u16 TaskTag; /* 0x04 */
388  u16 Reserved1; /* 0x06 */
389 };
390 
391 /* TargetAssist Success Reply Descriptor */
393  u8 ReplyFlags; /* 0x00 */
394  u8 MSIxIndex; /* 0x01 */
395  u16 SMID; /* 0x02 */
396  u8 SequenceNumber; /* 0x04 */
397  u8 Reserved1; /* 0x05 */
398  u16 IoIndex; /* 0x06 */
399 };
400 
401 /* Target Command Buffer Reply Descriptor */
403  u8 ReplyFlags; /* 0x00 */
404  u8 MSIxIndex; /* 0x01 */
405  u8 VP_ID; /* 0x02 */
406  u8 Flags; /* 0x03 */
408  u16 IoIndex; /* 0x06 */
409 };
410 
411 /* RAID Accelerator Success Reply Descriptor */
413  u8 ReplyFlags; /* 0x00 */
414  u8 MSIxIndex; /* 0x01 */
415  u16 SMID; /* 0x02 */
416  u32 Reserved; /* 0x04 */
417 };
418 
419 /* union of Reply Descriptors */
429 };
430 
431 /* IOCInit Request message */
433  u8 WhoInit; /* 0x00 */
434  u8 Reserved1; /* 0x01 */
435  u8 ChainOffset; /* 0x02 */
436  u8 Function; /* 0x03 */
437  u16 Reserved2; /* 0x04 */
438  u8 Reserved3; /* 0x06 */
439  u8 MsgFlags; /* 0x07 */
440  u8 VP_ID; /* 0x08 */
441  u8 VF_ID; /* 0x09 */
442  u16 Reserved4; /* 0x0A */
443  u16 MsgVersion; /* 0x0C */
444  u16 HeaderVersion; /* 0x0E */
445  u32 Reserved5; /* 0x10 */
446  u16 Reserved6; /* 0x14 */
447  u8 Reserved7; /* 0x16 */
448  u8 HostMSIxVectors; /* 0x17 */
449  u16 Reserved8; /* 0x18 */
458  u64 TimeStamp; /* 0x40 */
459 };
460 
461 /* mrpriv defines */
462 #define MR_PD_INVALID 0xFFFF
463 #define MAX_SPAN_DEPTH 8
464 #define MAX_RAIDMAP_SPAN_DEPTH (MAX_SPAN_DEPTH)
465 #define MAX_ROW_SIZE 32
466 #define MAX_RAIDMAP_ROW_SIZE (MAX_ROW_SIZE)
467 #define MAX_LOGICAL_DRIVES 64
468 #define MAX_RAIDMAP_LOGICAL_DRIVES (MAX_LOGICAL_DRIVES)
469 #define MAX_RAIDMAP_VIEWS (MAX_LOGICAL_DRIVES)
470 #define MAX_ARRAYS 128
471 #define MAX_RAIDMAP_ARRAYS (MAX_ARRAYS)
472 #define MAX_PHYSICAL_DEVICES 256
473 #define MAX_RAIDMAP_PHYSICAL_DEVICES (MAX_PHYSICAL_DEVICES)
474 #define MR_DCMD_LD_MAP_GET_INFO 0x0300e101
475 
481 };
482 
485 };
486 
493 };
494 
495 struct MR_SPAN_INFO {
499 };
500 
501 struct MR_LD_SPAN {
506 };
507 
510  struct MR_LD_SPAN span;
512 };
513 
514 struct MR_LD_RAID {
515  struct {
526  } capability;
543 
544  struct {
547  } flags;
548 
549  u8 reserved3[0x5C];
550 };
551 
556 };
557 
560  union {
561  struct {
567  } validationInfo;
570  };
571 
581 };
582 
591 };
592 
597 };
598 
599 #define IEEE_SGE_FLAGS_ADDR_MASK (0x03)
600 #define IEEE_SGE_FLAGS_SYSTEM_ADDR (0x00)
601 #define IEEE_SGE_FLAGS_IOCDDR_ADDR (0x01)
602 #define IEEE_SGE_FLAGS_IOCPLB_ADDR (0x02)
603 #define IEEE_SGE_FLAGS_IOCPLBNTA_ADDR (0x03)
604 #define IEEE_SGE_FLAGS_CHAIN_ELEMENT (0x80)
605 #define IEEE_SGE_FLAGS_END_OF_LIST (0x40)
606 
607 struct megasas_register_set;
608 struct megasas_instance;
609 
610 union desc_word {
612  struct {
615  } u;
616 };
617 
621 
624 
627 
628  struct list_head list;
629  struct scsi_cmnd *scmd;
631 
634 
635  /*
636  * Context for a MFI frame.
637  * Used to get the mfi cmd from list when a MFI cmd is completed
638  */
642 };
643 
650 };
651 
655 } __attribute__ ((packed));
660 
662 
665 
669 
672 
676 
678 
683 
686 
689 
692 
696 };
697 
698 union desc_value {
700  struct {
703  } u;
704 };
705 
706 #endif /* _MEGARAID_SAS_FUSION_H_ */