megaraid_sas: Support for Cutlass (12 Gbps) controller
[firefly-linux-kernel-4.4.55.git] / drivers / scsi / megaraid / megaraid_sas.h
1 /*
2  *  Linux MegaRAID driver for SAS based RAID controllers
3  *
4  *  Copyright (c) 2003-2013  LSI Corporation
5  *  Copyright (c) 2013-2014  Avago Technologies
6  *
7  *  This program is free software; you can redistribute it and/or
8  *  modify it under the terms of the GNU General Public License
9  *  as published by the Free Software Foundation; either version 2
10  *  of the License, or (at your option) any later version.
11  *
12  *  This program is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *  GNU General Public License for more details.
16  *
17  *  You should have received a copy of the GNU General Public License
18  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
19  *
20  *  FILE: megaraid_sas.h
21  *
22  *  Authors: Avago Technologies
23  *           Kashyap Desai <kashyap.desai@avagotech.com>
24  *           Sumit Saxena <sumit.saxena@avagotech.com>
25  *
26  *  Send feedback to: megaraidlinux.pdl@avagotech.com
27  *
28  *  Mail to: Avago Technologies, 350 West Trimble Road, Building 90,
29  *  San Jose, California 95131
30  */
31
32 #ifndef LSI_MEGARAID_SAS_H
33 #define LSI_MEGARAID_SAS_H
34
35 /*
36  * MegaRAID SAS Driver meta data
37  */
38 #define MEGASAS_VERSION                         "06.808.14.00-rc1"
39 #define MEGASAS_RELDATE                         "Jul 31, 2015"
40
41 /*
42  * Device IDs
43  */
44 #define PCI_DEVICE_ID_LSI_SAS1078R              0x0060
45 #define PCI_DEVICE_ID_LSI_SAS1078DE             0x007C
46 #define PCI_DEVICE_ID_LSI_VERDE_ZCR             0x0413
47 #define PCI_DEVICE_ID_LSI_SAS1078GEN2           0x0078
48 #define PCI_DEVICE_ID_LSI_SAS0079GEN2           0x0079
49 #define PCI_DEVICE_ID_LSI_SAS0073SKINNY         0x0073
50 #define PCI_DEVICE_ID_LSI_SAS0071SKINNY         0x0071
51 #define PCI_DEVICE_ID_LSI_FUSION                0x005b
52 #define PCI_DEVICE_ID_LSI_PLASMA                0x002f
53 #define PCI_DEVICE_ID_LSI_INVADER               0x005d
54 #define PCI_DEVICE_ID_LSI_FURY                  0x005f
55 #define PCI_DEVICE_ID_LSI_INTRUDER              0x00ce
56 #define PCI_DEVICE_ID_LSI_INTRUDER_24           0x00cf
57 #define PCI_DEVICE_ID_LSI_CUTLASS_52            0x0052
58 #define PCI_DEVICE_ID_LSI_CUTLASS_53            0x0053
59
60 /*
61  * Intel HBA SSDIDs
62  */
63 #define MEGARAID_INTEL_RS3DC080_SSDID           0x9360
64 #define MEGARAID_INTEL_RS3DC040_SSDID           0x9362
65 #define MEGARAID_INTEL_RS3SC008_SSDID           0x9380
66 #define MEGARAID_INTEL_RS3MC044_SSDID           0x9381
67 #define MEGARAID_INTEL_RS3WC080_SSDID           0x9341
68 #define MEGARAID_INTEL_RS3WC040_SSDID           0x9343
69 #define MEGARAID_INTEL_RMS3BC160_SSDID          0x352B
70
71 /*
72  * Intruder HBA SSDIDs
73  */
74 #define MEGARAID_INTRUDER_SSDID1                0x9371
75 #define MEGARAID_INTRUDER_SSDID2                0x9390
76 #define MEGARAID_INTRUDER_SSDID3                0x9370
77
78 /*
79  * Intel HBA branding
80  */
81 #define MEGARAID_INTEL_RS3DC080_BRANDING        \
82         "Intel(R) RAID Controller RS3DC080"
83 #define MEGARAID_INTEL_RS3DC040_BRANDING        \
84         "Intel(R) RAID Controller RS3DC040"
85 #define MEGARAID_INTEL_RS3SC008_BRANDING        \
86         "Intel(R) RAID Controller RS3SC008"
87 #define MEGARAID_INTEL_RS3MC044_BRANDING        \
88         "Intel(R) RAID Controller RS3MC044"
89 #define MEGARAID_INTEL_RS3WC080_BRANDING        \
90         "Intel(R) RAID Controller RS3WC080"
91 #define MEGARAID_INTEL_RS3WC040_BRANDING        \
92         "Intel(R) RAID Controller RS3WC040"
93 #define MEGARAID_INTEL_RMS3BC160_BRANDING       \
94         "Intel(R) Integrated RAID Module RMS3BC160"
95
96 /*
97  * =====================================
98  * MegaRAID SAS MFI firmware definitions
99  * =====================================
100  */
101
102 /*
103  * MFI stands for  MegaRAID SAS FW Interface. This is just a moniker for 
104  * protocol between the software and firmware. Commands are issued using
105  * "message frames"
106  */
107
108 /*
109  * FW posts its state in upper 4 bits of outbound_msg_0 register
110  */
111 #define MFI_STATE_MASK                          0xF0000000
112 #define MFI_STATE_UNDEFINED                     0x00000000
113 #define MFI_STATE_BB_INIT                       0x10000000
114 #define MFI_STATE_FW_INIT                       0x40000000
115 #define MFI_STATE_WAIT_HANDSHAKE                0x60000000
116 #define MFI_STATE_FW_INIT_2                     0x70000000
117 #define MFI_STATE_DEVICE_SCAN                   0x80000000
118 #define MFI_STATE_BOOT_MESSAGE_PENDING          0x90000000
119 #define MFI_STATE_FLUSH_CACHE                   0xA0000000
120 #define MFI_STATE_READY                         0xB0000000
121 #define MFI_STATE_OPERATIONAL                   0xC0000000
122 #define MFI_STATE_FAULT                         0xF0000000
123 #define MFI_STATE_FORCE_OCR                     0x00000080
124 #define MFI_STATE_DMADONE                       0x00000008
125 #define MFI_STATE_CRASH_DUMP_DONE               0x00000004
126 #define MFI_RESET_REQUIRED                      0x00000001
127 #define MFI_RESET_ADAPTER                       0x00000002
128 #define MEGAMFI_FRAME_SIZE                      64
129
130 /*
131  * During FW init, clear pending cmds & reset state using inbound_msg_0
132  *
133  * ABORT        : Abort all pending cmds
134  * READY        : Move from OPERATIONAL to READY state; discard queue info
135  * MFIMODE      : Discard (possible) low MFA posted in 64-bit mode (??)
136  * CLR_HANDSHAKE: FW is waiting for HANDSHAKE from BIOS or Driver
137  * HOTPLUG      : Resume from Hotplug
138  * MFI_STOP_ADP : Send signal to FW to stop processing
139  */
140 #define WRITE_SEQUENCE_OFFSET           (0x0000000FC) /* I20 */
141 #define HOST_DIAGNOSTIC_OFFSET          (0x000000F8)  /* I20 */
142 #define DIAG_WRITE_ENABLE                       (0x00000080)
143 #define DIAG_RESET_ADAPTER                      (0x00000004)
144
145 #define MFI_ADP_RESET                           0x00000040
146 #define MFI_INIT_ABORT                          0x00000001
147 #define MFI_INIT_READY                          0x00000002
148 #define MFI_INIT_MFIMODE                        0x00000004
149 #define MFI_INIT_CLEAR_HANDSHAKE                0x00000008
150 #define MFI_INIT_HOTPLUG                        0x00000010
151 #define MFI_STOP_ADP                            0x00000020
152 #define MFI_RESET_FLAGS                         MFI_INIT_READY| \
153                                                 MFI_INIT_MFIMODE| \
154                                                 MFI_INIT_ABORT
155
156 /*
157  * MFI frame flags
158  */
159 #define MFI_FRAME_POST_IN_REPLY_QUEUE           0x0000
160 #define MFI_FRAME_DONT_POST_IN_REPLY_QUEUE      0x0001
161 #define MFI_FRAME_SGL32                         0x0000
162 #define MFI_FRAME_SGL64                         0x0002
163 #define MFI_FRAME_SENSE32                       0x0000
164 #define MFI_FRAME_SENSE64                       0x0004
165 #define MFI_FRAME_DIR_NONE                      0x0000
166 #define MFI_FRAME_DIR_WRITE                     0x0008
167 #define MFI_FRAME_DIR_READ                      0x0010
168 #define MFI_FRAME_DIR_BOTH                      0x0018
169 #define MFI_FRAME_IEEE                          0x0020
170
171 /* Driver internal */
172 #define DRV_DCMD_POLLED_MODE            0x1
173
174 /*
175  * Definition for cmd_status
176  */
177 #define MFI_CMD_STATUS_POLL_MODE                0xFF
178
179 /*
180  * MFI command opcodes
181  */
182 #define MFI_CMD_INIT                            0x00
183 #define MFI_CMD_LD_READ                         0x01
184 #define MFI_CMD_LD_WRITE                        0x02
185 #define MFI_CMD_LD_SCSI_IO                      0x03
186 #define MFI_CMD_PD_SCSI_IO                      0x04
187 #define MFI_CMD_DCMD                            0x05
188 #define MFI_CMD_ABORT                           0x06
189 #define MFI_CMD_SMP                             0x07
190 #define MFI_CMD_STP                             0x08
191 #define MFI_CMD_INVALID                         0xff
192
193 #define MR_DCMD_CTRL_GET_INFO                   0x01010000
194 #define MR_DCMD_LD_GET_LIST                     0x03010000
195 #define MR_DCMD_LD_LIST_QUERY                   0x03010100
196
197 #define MR_DCMD_CTRL_CACHE_FLUSH                0x01101000
198 #define MR_FLUSH_CTRL_CACHE                     0x01
199 #define MR_FLUSH_DISK_CACHE                     0x02
200
201 #define MR_DCMD_CTRL_SHUTDOWN                   0x01050000
202 #define MR_DCMD_HIBERNATE_SHUTDOWN              0x01060000
203 #define MR_ENABLE_DRIVE_SPINDOWN                0x01
204
205 #define MR_DCMD_CTRL_EVENT_GET_INFO             0x01040100
206 #define MR_DCMD_CTRL_EVENT_GET                  0x01040300
207 #define MR_DCMD_CTRL_EVENT_WAIT                 0x01040500
208 #define MR_DCMD_LD_GET_PROPERTIES               0x03030000
209
210 #define MR_DCMD_CLUSTER                         0x08000000
211 #define MR_DCMD_CLUSTER_RESET_ALL               0x08010100
212 #define MR_DCMD_CLUSTER_RESET_LD                0x08010200
213 #define MR_DCMD_PD_LIST_QUERY                   0x02010100
214
215 #define MR_DCMD_CTRL_SET_CRASH_DUMP_PARAMS      0x01190100
216 #define MR_DRIVER_SET_APP_CRASHDUMP_MODE        (0xF0010000 | 0x0600)
217
218 /*
219  * Global functions
220  */
221 extern u8 MR_ValidateMapInfo(struct megasas_instance *instance);
222
223
224 /*
225  * MFI command completion codes
226  */
227 enum MFI_STAT {
228         MFI_STAT_OK = 0x00,
229         MFI_STAT_INVALID_CMD = 0x01,
230         MFI_STAT_INVALID_DCMD = 0x02,
231         MFI_STAT_INVALID_PARAMETER = 0x03,
232         MFI_STAT_INVALID_SEQUENCE_NUMBER = 0x04,
233         MFI_STAT_ABORT_NOT_POSSIBLE = 0x05,
234         MFI_STAT_APP_HOST_CODE_NOT_FOUND = 0x06,
235         MFI_STAT_APP_IN_USE = 0x07,
236         MFI_STAT_APP_NOT_INITIALIZED = 0x08,
237         MFI_STAT_ARRAY_INDEX_INVALID = 0x09,
238         MFI_STAT_ARRAY_ROW_NOT_EMPTY = 0x0a,
239         MFI_STAT_CONFIG_RESOURCE_CONFLICT = 0x0b,
240         MFI_STAT_DEVICE_NOT_FOUND = 0x0c,
241         MFI_STAT_DRIVE_TOO_SMALL = 0x0d,
242         MFI_STAT_FLASH_ALLOC_FAIL = 0x0e,
243         MFI_STAT_FLASH_BUSY = 0x0f,
244         MFI_STAT_FLASH_ERROR = 0x10,
245         MFI_STAT_FLASH_IMAGE_BAD = 0x11,
246         MFI_STAT_FLASH_IMAGE_INCOMPLETE = 0x12,
247         MFI_STAT_FLASH_NOT_OPEN = 0x13,
248         MFI_STAT_FLASH_NOT_STARTED = 0x14,
249         MFI_STAT_FLUSH_FAILED = 0x15,
250         MFI_STAT_HOST_CODE_NOT_FOUNT = 0x16,
251         MFI_STAT_LD_CC_IN_PROGRESS = 0x17,
252         MFI_STAT_LD_INIT_IN_PROGRESS = 0x18,
253         MFI_STAT_LD_LBA_OUT_OF_RANGE = 0x19,
254         MFI_STAT_LD_MAX_CONFIGURED = 0x1a,
255         MFI_STAT_LD_NOT_OPTIMAL = 0x1b,
256         MFI_STAT_LD_RBLD_IN_PROGRESS = 0x1c,
257         MFI_STAT_LD_RECON_IN_PROGRESS = 0x1d,
258         MFI_STAT_LD_WRONG_RAID_LEVEL = 0x1e,
259         MFI_STAT_MAX_SPARES_EXCEEDED = 0x1f,
260         MFI_STAT_MEMORY_NOT_AVAILABLE = 0x20,
261         MFI_STAT_MFC_HW_ERROR = 0x21,
262         MFI_STAT_NO_HW_PRESENT = 0x22,
263         MFI_STAT_NOT_FOUND = 0x23,
264         MFI_STAT_NOT_IN_ENCL = 0x24,
265         MFI_STAT_PD_CLEAR_IN_PROGRESS = 0x25,
266         MFI_STAT_PD_TYPE_WRONG = 0x26,
267         MFI_STAT_PR_DISABLED = 0x27,
268         MFI_STAT_ROW_INDEX_INVALID = 0x28,
269         MFI_STAT_SAS_CONFIG_INVALID_ACTION = 0x29,
270         MFI_STAT_SAS_CONFIG_INVALID_DATA = 0x2a,
271         MFI_STAT_SAS_CONFIG_INVALID_PAGE = 0x2b,
272         MFI_STAT_SAS_CONFIG_INVALID_TYPE = 0x2c,
273         MFI_STAT_SCSI_DONE_WITH_ERROR = 0x2d,
274         MFI_STAT_SCSI_IO_FAILED = 0x2e,
275         MFI_STAT_SCSI_RESERVATION_CONFLICT = 0x2f,
276         MFI_STAT_SHUTDOWN_FAILED = 0x30,
277         MFI_STAT_TIME_NOT_SET = 0x31,
278         MFI_STAT_WRONG_STATE = 0x32,
279         MFI_STAT_LD_OFFLINE = 0x33,
280         MFI_STAT_PEER_NOTIFICATION_REJECTED = 0x34,
281         MFI_STAT_PEER_NOTIFICATION_FAILED = 0x35,
282         MFI_STAT_RESERVATION_IN_PROGRESS = 0x36,
283         MFI_STAT_I2C_ERRORS_DETECTED = 0x37,
284         MFI_STAT_PCI_ERRORS_DETECTED = 0x38,
285         MFI_STAT_CONFIG_SEQ_MISMATCH = 0x67,
286
287         MFI_STAT_INVALID_STATUS = 0xFF
288 };
289
290 enum mfi_evt_class {
291         MFI_EVT_CLASS_DEBUG =           -2,
292         MFI_EVT_CLASS_PROGRESS =        -1,
293         MFI_EVT_CLASS_INFO =            0,
294         MFI_EVT_CLASS_WARNING =         1,
295         MFI_EVT_CLASS_CRITICAL =        2,
296         MFI_EVT_CLASS_FATAL =           3,
297         MFI_EVT_CLASS_DEAD =            4
298 };
299
300 /*
301  * Crash dump related defines
302  */
303 #define MAX_CRASH_DUMP_SIZE 512
304 #define CRASH_DMA_BUF_SIZE  (1024 * 1024)
305
306 enum MR_FW_CRASH_DUMP_STATE {
307         UNAVAILABLE = 0,
308         AVAILABLE = 1,
309         COPYING = 2,
310         COPIED = 3,
311         COPY_ERROR = 4,
312 };
313
314 enum _MR_CRASH_BUF_STATUS {
315         MR_CRASH_BUF_TURN_OFF = 0,
316         MR_CRASH_BUF_TURN_ON = 1,
317 };
318
319 /*
320  * Number of mailbox bytes in DCMD message frame
321  */
322 #define MFI_MBOX_SIZE                           12
323
324 enum MR_EVT_CLASS {
325
326         MR_EVT_CLASS_DEBUG = -2,
327         MR_EVT_CLASS_PROGRESS = -1,
328         MR_EVT_CLASS_INFO = 0,
329         MR_EVT_CLASS_WARNING = 1,
330         MR_EVT_CLASS_CRITICAL = 2,
331         MR_EVT_CLASS_FATAL = 3,
332         MR_EVT_CLASS_DEAD = 4,
333
334 };
335
336 enum MR_EVT_LOCALE {
337
338         MR_EVT_LOCALE_LD = 0x0001,
339         MR_EVT_LOCALE_PD = 0x0002,
340         MR_EVT_LOCALE_ENCL = 0x0004,
341         MR_EVT_LOCALE_BBU = 0x0008,
342         MR_EVT_LOCALE_SAS = 0x0010,
343         MR_EVT_LOCALE_CTRL = 0x0020,
344         MR_EVT_LOCALE_CONFIG = 0x0040,
345         MR_EVT_LOCALE_CLUSTER = 0x0080,
346         MR_EVT_LOCALE_ALL = 0xffff,
347
348 };
349
350 enum MR_EVT_ARGS {
351
352         MR_EVT_ARGS_NONE,
353         MR_EVT_ARGS_CDB_SENSE,
354         MR_EVT_ARGS_LD,
355         MR_EVT_ARGS_LD_COUNT,
356         MR_EVT_ARGS_LD_LBA,
357         MR_EVT_ARGS_LD_OWNER,
358         MR_EVT_ARGS_LD_LBA_PD_LBA,
359         MR_EVT_ARGS_LD_PROG,
360         MR_EVT_ARGS_LD_STATE,
361         MR_EVT_ARGS_LD_STRIP,
362         MR_EVT_ARGS_PD,
363         MR_EVT_ARGS_PD_ERR,
364         MR_EVT_ARGS_PD_LBA,
365         MR_EVT_ARGS_PD_LBA_LD,
366         MR_EVT_ARGS_PD_PROG,
367         MR_EVT_ARGS_PD_STATE,
368         MR_EVT_ARGS_PCI,
369         MR_EVT_ARGS_RATE,
370         MR_EVT_ARGS_STR,
371         MR_EVT_ARGS_TIME,
372         MR_EVT_ARGS_ECC,
373         MR_EVT_ARGS_LD_PROP,
374         MR_EVT_ARGS_PD_SPARE,
375         MR_EVT_ARGS_PD_INDEX,
376         MR_EVT_ARGS_DIAG_PASS,
377         MR_EVT_ARGS_DIAG_FAIL,
378         MR_EVT_ARGS_PD_LBA_LBA,
379         MR_EVT_ARGS_PORT_PHY,
380         MR_EVT_ARGS_PD_MISSING,
381         MR_EVT_ARGS_PD_ADDRESS,
382         MR_EVT_ARGS_BITMAP,
383         MR_EVT_ARGS_CONNECTOR,
384         MR_EVT_ARGS_PD_PD,
385         MR_EVT_ARGS_PD_FRU,
386         MR_EVT_ARGS_PD_PATHINFO,
387         MR_EVT_ARGS_PD_POWER_STATE,
388         MR_EVT_ARGS_GENERIC,
389 };
390
391 /*
392  * define constants for device list query options
393  */
394 enum MR_PD_QUERY_TYPE {
395         MR_PD_QUERY_TYPE_ALL                = 0,
396         MR_PD_QUERY_TYPE_STATE              = 1,
397         MR_PD_QUERY_TYPE_POWER_STATE        = 2,
398         MR_PD_QUERY_TYPE_MEDIA_TYPE         = 3,
399         MR_PD_QUERY_TYPE_SPEED              = 4,
400         MR_PD_QUERY_TYPE_EXPOSED_TO_HOST    = 5,
401 };
402
403 enum MR_LD_QUERY_TYPE {
404         MR_LD_QUERY_TYPE_ALL             = 0,
405         MR_LD_QUERY_TYPE_EXPOSED_TO_HOST = 1,
406         MR_LD_QUERY_TYPE_USED_TGT_IDS    = 2,
407         MR_LD_QUERY_TYPE_CLUSTER_ACCESS  = 3,
408         MR_LD_QUERY_TYPE_CLUSTER_LOCALE  = 4,
409 };
410
411
412 #define MR_EVT_CFG_CLEARED                              0x0004
413 #define MR_EVT_LD_STATE_CHANGE                          0x0051
414 #define MR_EVT_PD_INSERTED                              0x005b
415 #define MR_EVT_PD_REMOVED                               0x0070
416 #define MR_EVT_LD_CREATED                               0x008a
417 #define MR_EVT_LD_DELETED                               0x008b
418 #define MR_EVT_FOREIGN_CFG_IMPORTED                     0x00db
419 #define MR_EVT_LD_OFFLINE                               0x00fc
420 #define MR_EVT_CTRL_HOST_BUS_SCAN_REQUESTED             0x0152
421
422 enum MR_PD_STATE {
423         MR_PD_STATE_UNCONFIGURED_GOOD   = 0x00,
424         MR_PD_STATE_UNCONFIGURED_BAD    = 0x01,
425         MR_PD_STATE_HOT_SPARE           = 0x02,
426         MR_PD_STATE_OFFLINE             = 0x10,
427         MR_PD_STATE_FAILED              = 0x11,
428         MR_PD_STATE_REBUILD             = 0x14,
429         MR_PD_STATE_ONLINE              = 0x18,
430         MR_PD_STATE_COPYBACK            = 0x20,
431         MR_PD_STATE_SYSTEM              = 0x40,
432  };
433
434
435  /*
436  * defines the physical drive address structure
437  */
438 struct MR_PD_ADDRESS {
439         __le16  deviceId;
440         u16     enclDeviceId;
441
442         union {
443                 struct {
444                         u8  enclIndex;
445                         u8  slotNumber;
446                 } mrPdAddress;
447                 struct {
448                         u8  enclPosition;
449                         u8  enclConnectorIndex;
450                 } mrEnclAddress;
451         };
452         u8      scsiDevType;
453         union {
454                 u8      connectedPortBitmap;
455                 u8      connectedPortNumbers;
456         };
457         u64     sasAddr[2];
458 } __packed;
459
460 /*
461  * defines the physical drive list structure
462  */
463 struct MR_PD_LIST {
464         __le32          size;
465         __le32          count;
466         struct MR_PD_ADDRESS   addr[1];
467 } __packed;
468
469 struct megasas_pd_list {
470         u16             tid;
471         u8             driveType;
472         u8             driveState;
473 } __packed;
474
475  /*
476  * defines the logical drive reference structure
477  */
478 union  MR_LD_REF {
479         struct {
480                 u8      targetId;
481                 u8      reserved;
482                 __le16     seqNum;
483         };
484         __le32     ref;
485 } __packed;
486
487 /*
488  * defines the logical drive list structure
489  */
490 struct MR_LD_LIST {
491         __le32     ldCount;
492         __le32     reserved;
493         struct {
494                 union MR_LD_REF   ref;
495                 u8          state;
496                 u8          reserved[3];
497                 __le64          size;
498         } ldList[MAX_LOGICAL_DRIVES_EXT];
499 } __packed;
500
501 struct MR_LD_TARGETID_LIST {
502         __le32  size;
503         __le32  count;
504         u8      pad[3];
505         u8      targetId[MAX_LOGICAL_DRIVES_EXT];
506 };
507
508
509 /*
510  * SAS controller properties
511  */
512 struct megasas_ctrl_prop {
513
514         u16 seq_num;
515         u16 pred_fail_poll_interval;
516         u16 intr_throttle_count;
517         u16 intr_throttle_timeouts;
518         u8 rebuild_rate;
519         u8 patrol_read_rate;
520         u8 bgi_rate;
521         u8 cc_rate;
522         u8 recon_rate;
523         u8 cache_flush_interval;
524         u8 spinup_drv_count;
525         u8 spinup_delay;
526         u8 cluster_enable;
527         u8 coercion_mode;
528         u8 alarm_enable;
529         u8 disable_auto_rebuild;
530         u8 disable_battery_warn;
531         u8 ecc_bucket_size;
532         u16 ecc_bucket_leak_rate;
533         u8 restore_hotspare_on_insertion;
534         u8 expose_encl_devices;
535         u8 maintainPdFailHistory;
536         u8 disallowHostRequestReordering;
537         u8 abortCCOnError;
538         u8 loadBalanceMode;
539         u8 disableAutoDetectBackplane;
540
541         u8 snapVDSpace;
542
543         /*
544         * Add properties that can be controlled by
545         * a bit in the following structure.
546         */
547         struct {
548 #if   defined(__BIG_ENDIAN_BITFIELD)
549                 u32     reserved:18;
550                 u32     enableJBOD:1;
551                 u32     disableSpinDownHS:1;
552                 u32     allowBootWithPinnedCache:1;
553                 u32     disableOnlineCtrlReset:1;
554                 u32     enableSecretKeyControl:1;
555                 u32     autoEnhancedImport:1;
556                 u32     enableSpinDownUnconfigured:1;
557                 u32     SSDPatrolReadEnabled:1;
558                 u32     SSDSMARTerEnabled:1;
559                 u32     disableNCQ:1;
560                 u32     useFdeOnly:1;
561                 u32     prCorrectUnconfiguredAreas:1;
562                 u32     SMARTerEnabled:1;
563                 u32     copyBackDisabled:1;
564 #else
565                 u32     copyBackDisabled:1;
566                 u32     SMARTerEnabled:1;
567                 u32     prCorrectUnconfiguredAreas:1;
568                 u32     useFdeOnly:1;
569                 u32     disableNCQ:1;
570                 u32     SSDSMARTerEnabled:1;
571                 u32     SSDPatrolReadEnabled:1;
572                 u32     enableSpinDownUnconfigured:1;
573                 u32     autoEnhancedImport:1;
574                 u32     enableSecretKeyControl:1;
575                 u32     disableOnlineCtrlReset:1;
576                 u32     allowBootWithPinnedCache:1;
577                 u32     disableSpinDownHS:1;
578                 u32     enableJBOD:1;
579                 u32     reserved:18;
580 #endif
581         } OnOffProperties;
582         u8 autoSnapVDSpace;
583         u8 viewSpace;
584         __le16 spinDownTime;
585         u8  reserved[24];
586 } __packed;
587
588 /*
589  * SAS controller information
590  */
591 struct megasas_ctrl_info {
592
593         /*
594          * PCI device information
595          */
596         struct {
597
598                 __le16 vendor_id;
599                 __le16 device_id;
600                 __le16 sub_vendor_id;
601                 __le16 sub_device_id;
602                 u8 reserved[24];
603
604         } __attribute__ ((packed)) pci;
605
606         /*
607          * Host interface information
608          */
609         struct {
610
611                 u8 PCIX:1;
612                 u8 PCIE:1;
613                 u8 iSCSI:1;
614                 u8 SAS_3G:1;
615                 u8 SRIOV:1;
616                 u8 reserved_0:3;
617                 u8 reserved_1[6];
618                 u8 port_count;
619                 u64 port_addr[8];
620
621         } __attribute__ ((packed)) host_interface;
622
623         /*
624          * Device (backend) interface information
625          */
626         struct {
627
628                 u8 SPI:1;
629                 u8 SAS_3G:1;
630                 u8 SATA_1_5G:1;
631                 u8 SATA_3G:1;
632                 u8 reserved_0:4;
633                 u8 reserved_1[6];
634                 u8 port_count;
635                 u64 port_addr[8];
636
637         } __attribute__ ((packed)) device_interface;
638
639         /*
640          * List of components residing in flash. All str are null terminated
641          */
642         __le32 image_check_word;
643         __le32 image_component_count;
644
645         struct {
646
647                 char name[8];
648                 char version[32];
649                 char build_date[16];
650                 char built_time[16];
651
652         } __attribute__ ((packed)) image_component[8];
653
654         /*
655          * List of flash components that have been flashed on the card, but
656          * are not in use, pending reset of the adapter. This list will be
657          * empty if a flash operation has not occurred. All stings are null
658          * terminated
659          */
660         __le32 pending_image_component_count;
661
662         struct {
663
664                 char name[8];
665                 char version[32];
666                 char build_date[16];
667                 char build_time[16];
668
669         } __attribute__ ((packed)) pending_image_component[8];
670
671         u8 max_arms;
672         u8 max_spans;
673         u8 max_arrays;
674         u8 max_lds;
675
676         char product_name[80];
677         char serial_no[32];
678
679         /*
680          * Other physical/controller/operation information. Indicates the
681          * presence of the hardware
682          */
683         struct {
684
685                 u32 bbu:1;
686                 u32 alarm:1;
687                 u32 nvram:1;
688                 u32 uart:1;
689                 u32 reserved:28;
690
691         } __attribute__ ((packed)) hw_present;
692
693         __le32 current_fw_time;
694
695         /*
696          * Maximum data transfer sizes
697          */
698         __le16 max_concurrent_cmds;
699         __le16 max_sge_count;
700         __le32 max_request_size;
701
702         /*
703          * Logical and physical device counts
704          */
705         __le16 ld_present_count;
706         __le16 ld_degraded_count;
707         __le16 ld_offline_count;
708
709         __le16 pd_present_count;
710         __le16 pd_disk_present_count;
711         __le16 pd_disk_pred_failure_count;
712         __le16 pd_disk_failed_count;
713
714         /*
715          * Memory size information
716          */
717         __le16 nvram_size;
718         __le16 memory_size;
719         __le16 flash_size;
720
721         /*
722          * Error counters
723          */
724         __le16 mem_correctable_error_count;
725         __le16 mem_uncorrectable_error_count;
726
727         /*
728          * Cluster information
729          */
730         u8 cluster_permitted;
731         u8 cluster_active;
732
733         /*
734          * Additional max data transfer sizes
735          */
736         __le16 max_strips_per_io;
737
738         /*
739          * Controller capabilities structures
740          */
741         struct {
742
743                 u32 raid_level_0:1;
744                 u32 raid_level_1:1;
745                 u32 raid_level_5:1;
746                 u32 raid_level_1E:1;
747                 u32 raid_level_6:1;
748                 u32 reserved:27;
749
750         } __attribute__ ((packed)) raid_levels;
751
752         struct {
753
754                 u32 rbld_rate:1;
755                 u32 cc_rate:1;
756                 u32 bgi_rate:1;
757                 u32 recon_rate:1;
758                 u32 patrol_rate:1;
759                 u32 alarm_control:1;
760                 u32 cluster_supported:1;
761                 u32 bbu:1;
762                 u32 spanning_allowed:1;
763                 u32 dedicated_hotspares:1;
764                 u32 revertible_hotspares:1;
765                 u32 foreign_config_import:1;
766                 u32 self_diagnostic:1;
767                 u32 mixed_redundancy_arr:1;
768                 u32 global_hot_spares:1;
769                 u32 reserved:17;
770
771         } __attribute__ ((packed)) adapter_operations;
772
773         struct {
774
775                 u32 read_policy:1;
776                 u32 write_policy:1;
777                 u32 io_policy:1;
778                 u32 access_policy:1;
779                 u32 disk_cache_policy:1;
780                 u32 reserved:27;
781
782         } __attribute__ ((packed)) ld_operations;
783
784         struct {
785
786                 u8 min;
787                 u8 max;
788                 u8 reserved[2];
789
790         } __attribute__ ((packed)) stripe_sz_ops;
791
792         struct {
793
794                 u32 force_online:1;
795                 u32 force_offline:1;
796                 u32 force_rebuild:1;
797                 u32 reserved:29;
798
799         } __attribute__ ((packed)) pd_operations;
800
801         struct {
802
803                 u32 ctrl_supports_sas:1;
804                 u32 ctrl_supports_sata:1;
805                 u32 allow_mix_in_encl:1;
806                 u32 allow_mix_in_ld:1;
807                 u32 allow_sata_in_cluster:1;
808                 u32 reserved:27;
809
810         } __attribute__ ((packed)) pd_mix_support;
811
812         /*
813          * Define ECC single-bit-error bucket information
814          */
815         u8 ecc_bucket_count;
816         u8 reserved_2[11];
817
818         /*
819          * Include the controller properties (changeable items)
820          */
821         struct megasas_ctrl_prop properties;
822
823         /*
824          * Define FW pkg version (set in envt v'bles on OEM basis)
825          */
826         char package_version[0x60];
827
828
829         /*
830         * If adapterOperations.supportMoreThan8Phys is set,
831         * and deviceInterface.portCount is greater than 8,
832         * SAS Addrs for first 8 ports shall be populated in
833         * deviceInterface.portAddr, and the rest shall be
834         * populated in deviceInterfacePortAddr2.
835         */
836         __le64      deviceInterfacePortAddr2[8]; /*6a0h */
837         u8          reserved3[128];              /*6e0h */
838
839         struct {                                /*760h */
840                 u16 minPdRaidLevel_0:4;
841                 u16 maxPdRaidLevel_0:12;
842
843                 u16 minPdRaidLevel_1:4;
844                 u16 maxPdRaidLevel_1:12;
845
846                 u16 minPdRaidLevel_5:4;
847                 u16 maxPdRaidLevel_5:12;
848
849                 u16 minPdRaidLevel_1E:4;
850                 u16 maxPdRaidLevel_1E:12;
851
852                 u16 minPdRaidLevel_6:4;
853                 u16 maxPdRaidLevel_6:12;
854
855                 u16 minPdRaidLevel_10:4;
856                 u16 maxPdRaidLevel_10:12;
857
858                 u16 minPdRaidLevel_50:4;
859                 u16 maxPdRaidLevel_50:12;
860
861                 u16 minPdRaidLevel_60:4;
862                 u16 maxPdRaidLevel_60:12;
863
864                 u16 minPdRaidLevel_1E_RLQ0:4;
865                 u16 maxPdRaidLevel_1E_RLQ0:12;
866
867                 u16 minPdRaidLevel_1E0_RLQ0:4;
868                 u16 maxPdRaidLevel_1E0_RLQ0:12;
869
870                 u16 reserved[6];
871         } pdsForRaidLevels;
872
873         __le16 maxPds;                          /*780h */
874         __le16 maxDedHSPs;                      /*782h */
875         __le16 maxGlobalHSP;                    /*784h */
876         __le16 ddfSize;                         /*786h */
877         u8  maxLdsPerArray;                     /*788h */
878         u8  partitionsInDDF;                    /*789h */
879         u8  lockKeyBinding;                     /*78ah */
880         u8  maxPITsPerLd;                       /*78bh */
881         u8  maxViewsPerLd;                      /*78ch */
882         u8  maxTargetId;                        /*78dh */
883         __le16 maxBvlVdSize;                    /*78eh */
884
885         __le16 maxConfigurableSSCSize;          /*790h */
886         __le16 currentSSCsize;                  /*792h */
887
888         char    expanderFwVersion[12];          /*794h */
889
890         __le16 PFKTrialTimeRemaining;           /*7A0h */
891
892         __le16 cacheMemorySize;                 /*7A2h */
893
894         struct {                                /*7A4h */
895 #if   defined(__BIG_ENDIAN_BITFIELD)
896                 u32     reserved:5;
897                 u32     activePassive:2;
898                 u32     supportConfigAutoBalance:1;
899                 u32     mpio:1;
900                 u32     supportDataLDonSSCArray:1;
901                 u32     supportPointInTimeProgress:1;
902                 u32     supportUnevenSpans:1;
903                 u32     dedicatedHotSparesLimited:1;
904                 u32     headlessMode:1;
905                 u32     supportEmulatedDrives:1;
906                 u32     supportResetNow:1;
907                 u32     realTimeScheduler:1;
908                 u32     supportSSDPatrolRead:1;
909                 u32     supportPerfTuning:1;
910                 u32     disableOnlinePFKChange:1;
911                 u32     supportJBOD:1;
912                 u32     supportBootTimePFKChange:1;
913                 u32     supportSetLinkSpeed:1;
914                 u32     supportEmergencySpares:1;
915                 u32     supportSuspendResumeBGops:1;
916                 u32     blockSSDWriteCacheChange:1;
917                 u32     supportShieldState:1;
918                 u32     supportLdBBMInfo:1;
919                 u32     supportLdPIType3:1;
920                 u32     supportLdPIType2:1;
921                 u32     supportLdPIType1:1;
922                 u32     supportPIcontroller:1;
923 #else
924                 u32     supportPIcontroller:1;
925                 u32     supportLdPIType1:1;
926                 u32     supportLdPIType2:1;
927                 u32     supportLdPIType3:1;
928                 u32     supportLdBBMInfo:1;
929                 u32     supportShieldState:1;
930                 u32     blockSSDWriteCacheChange:1;
931                 u32     supportSuspendResumeBGops:1;
932                 u32     supportEmergencySpares:1;
933                 u32     supportSetLinkSpeed:1;
934                 u32     supportBootTimePFKChange:1;
935                 u32     supportJBOD:1;
936                 u32     disableOnlinePFKChange:1;
937                 u32     supportPerfTuning:1;
938                 u32     supportSSDPatrolRead:1;
939                 u32     realTimeScheduler:1;
940
941                 u32     supportResetNow:1;
942                 u32     supportEmulatedDrives:1;
943                 u32     headlessMode:1;
944                 u32     dedicatedHotSparesLimited:1;
945
946
947                 u32     supportUnevenSpans:1;
948                 u32     supportPointInTimeProgress:1;
949                 u32     supportDataLDonSSCArray:1;
950                 u32     mpio:1;
951                 u32     supportConfigAutoBalance:1;
952                 u32     activePassive:2;
953                 u32     reserved:5;
954 #endif
955         } adapterOperations2;
956
957         u8  driverVersion[32];                  /*7A8h */
958         u8  maxDAPdCountSpinup60;               /*7C8h */
959         u8  temperatureROC;                     /*7C9h */
960         u8  temperatureCtrl;                    /*7CAh */
961         u8  reserved4;                          /*7CBh */
962         __le16 maxConfigurablePds;              /*7CCh */
963
964
965         u8  reserved5[2];                       /*0x7CDh */
966
967         /*
968         * HA cluster information
969         */
970         struct {
971 #if defined(__BIG_ENDIAN_BITFIELD)
972                 u32     reserved:26;
973                 u32     premiumFeatureMismatch:1;
974                 u32     ctrlPropIncompatible:1;
975                 u32     fwVersionMismatch:1;
976                 u32     hwIncompatible:1;
977                 u32     peerIsIncompatible:1;
978                 u32     peerIsPresent:1;
979 #else
980                 u32     peerIsPresent:1;
981                 u32     peerIsIncompatible:1;
982                 u32     hwIncompatible:1;
983                 u32     fwVersionMismatch:1;
984                 u32     ctrlPropIncompatible:1;
985                 u32     premiumFeatureMismatch:1;
986                 u32     reserved:26;
987 #endif
988         } cluster;
989
990         char clusterId[16];                     /*7D4h */
991         struct {
992                 u8  maxVFsSupported;            /*0x7E4*/
993                 u8  numVFsEnabled;              /*0x7E5*/
994                 u8  requestorId;                /*0x7E6 0:PF, 1:VF1, 2:VF2*/
995                 u8  reserved;                   /*0x7E7*/
996         } iov;
997
998         struct {
999 #if defined(__BIG_ENDIAN_BITFIELD)
1000                 u32     reserved:7;
1001                 u32     useSeqNumJbodFP:1;
1002                 u32     supportExtendedSSCSize:1;
1003                 u32     supportDiskCacheSettingForSysPDs:1;
1004                 u32     supportCPLDUpdate:1;
1005                 u32     supportTTYLogCompression:1;
1006                 u32     discardCacheDuringLDDelete:1;
1007                 u32     supportSecurityonJBOD:1;
1008                 u32     supportCacheBypassModes:1;
1009                 u32     supportDisableSESMonitoring:1;
1010                 u32     supportForceFlash:1;
1011                 u32     supportNVDRAM:1;
1012                 u32     supportDrvActivityLEDSetting:1;
1013                 u32     supportAllowedOpsforDrvRemoval:1;
1014                 u32     supportHOQRebuild:1;
1015                 u32     supportForceTo512e:1;
1016                 u32     supportNVCacheErase:1;
1017                 u32     supportDebugQueue:1;
1018                 u32     supportSwZone:1;
1019                 u32     supportCrashDump:1;
1020                 u32     supportMaxExtLDs:1;
1021                 u32     supportT10RebuildAssist:1;
1022                 u32     supportDisableImmediateIO:1;
1023                 u32     supportThermalPollInterval:1;
1024                 u32     supportPersonalityChange:2;
1025 #else
1026                 u32     supportPersonalityChange:2;
1027                 u32     supportThermalPollInterval:1;
1028                 u32     supportDisableImmediateIO:1;
1029                 u32     supportT10RebuildAssist:1;
1030                 u32     supportMaxExtLDs:1;
1031                 u32     supportCrashDump:1;
1032                 u32     supportSwZone:1;
1033                 u32     supportDebugQueue:1;
1034                 u32     supportNVCacheErase:1;
1035                 u32     supportForceTo512e:1;
1036                 u32     supportHOQRebuild:1;
1037                 u32     supportAllowedOpsforDrvRemoval:1;
1038                 u32     supportDrvActivityLEDSetting:1;
1039                 u32     supportNVDRAM:1;
1040                 u32     supportForceFlash:1;
1041                 u32     supportDisableSESMonitoring:1;
1042                 u32     supportCacheBypassModes:1;
1043                 u32     supportSecurityonJBOD:1;
1044                 u32     discardCacheDuringLDDelete:1;
1045                 u32     supportTTYLogCompression:1;
1046                 u32     supportCPLDUpdate:1;
1047                 u32     supportDiskCacheSettingForSysPDs:1;
1048                 u32     supportExtendedSSCSize:1;
1049                 u32     useSeqNumJbodFP:1;
1050                 u32     reserved:7;
1051 #endif
1052         } adapterOperations3;
1053
1054         u8          pad[0x800-0x7EC];
1055 } __packed;
1056
1057 /*
1058  * ===============================
1059  * MegaRAID SAS driver definitions
1060  * ===============================
1061  */
1062 #define MEGASAS_MAX_PD_CHANNELS                 2
1063 #define MEGASAS_MAX_LD_CHANNELS                 2
1064 #define MEGASAS_MAX_CHANNELS                    (MEGASAS_MAX_PD_CHANNELS + \
1065                                                 MEGASAS_MAX_LD_CHANNELS)
1066 #define MEGASAS_MAX_DEV_PER_CHANNEL             128
1067 #define MEGASAS_DEFAULT_INIT_ID                 -1
1068 #define MEGASAS_MAX_LUN                         8
1069 #define MEGASAS_DEFAULT_CMD_PER_LUN             256
1070 #define MEGASAS_MAX_PD                          (MEGASAS_MAX_PD_CHANNELS * \
1071                                                 MEGASAS_MAX_DEV_PER_CHANNEL)
1072 #define MEGASAS_MAX_LD_IDS                      (MEGASAS_MAX_LD_CHANNELS * \
1073                                                 MEGASAS_MAX_DEV_PER_CHANNEL)
1074
1075 #define MEGASAS_MAX_SECTORS                    (2*1024)
1076 #define MEGASAS_MAX_SECTORS_IEEE                (2*128)
1077 #define MEGASAS_DBG_LVL                         1
1078
1079 #define MEGASAS_FW_BUSY                         1
1080
1081 #define VD_EXT_DEBUG 0
1082
1083
1084 enum MR_SCSI_CMD_TYPE {
1085         READ_WRITE_LDIO = 0,
1086         NON_READ_WRITE_LDIO = 1,
1087         READ_WRITE_SYSPDIO = 2,
1088         NON_READ_WRITE_SYSPDIO = 3,
1089 };
1090
1091 /* Frame Type */
1092 #define IO_FRAME                                0
1093 #define PTHRU_FRAME                             1
1094
1095 /*
1096  * When SCSI mid-layer calls driver's reset routine, driver waits for
1097  * MEGASAS_RESET_WAIT_TIME seconds for all outstanding IO to complete. Note
1098  * that the driver cannot _actually_ abort or reset pending commands. While
1099  * it is waiting for the commands to complete, it prints a diagnostic message
1100  * every MEGASAS_RESET_NOTICE_INTERVAL seconds
1101  */
1102 #define MEGASAS_RESET_WAIT_TIME                 180
1103 #define MEGASAS_INTERNAL_CMD_WAIT_TIME          180
1104 #define MEGASAS_RESET_NOTICE_INTERVAL           5
1105 #define MEGASAS_IOCTL_CMD                       0
1106 #define MEGASAS_DEFAULT_CMD_TIMEOUT             90
1107 #define MEGASAS_THROTTLE_QUEUE_DEPTH            16
1108 #define MEGASAS_BLOCKED_CMD_TIMEOUT             60
1109 /*
1110  * FW reports the maximum of number of commands that it can accept (maximum
1111  * commands that can be outstanding) at any time. The driver must report a
1112  * lower number to the mid layer because it can issue a few internal commands
1113  * itself (E.g, AEN, abort cmd, IOCTLs etc). The number of commands it needs
1114  * is shown below
1115  */
1116 #define MEGASAS_INT_CMDS                        32
1117 #define MEGASAS_SKINNY_INT_CMDS                 5
1118 #define MEGASAS_FUSION_INTERNAL_CMDS            5
1119 #define MEGASAS_FUSION_IOCTL_CMDS               3
1120 #define MEGASAS_MFI_IOCTL_CMDS                  27
1121
1122 #define MEGASAS_MAX_MSIX_QUEUES                 128
1123 /*
1124  * FW can accept both 32 and 64 bit SGLs. We want to allocate 32/64 bit
1125  * SGLs based on the size of dma_addr_t
1126  */
1127 #define IS_DMA64                                (sizeof(dma_addr_t) == 8)
1128
1129 #define MFI_XSCALE_OMR0_CHANGE_INTERRUPT                0x00000001
1130
1131 #define MFI_INTR_FLAG_REPLY_MESSAGE                     0x00000001
1132 #define MFI_INTR_FLAG_FIRMWARE_STATE_CHANGE             0x00000002
1133 #define MFI_G2_OUTBOUND_DOORBELL_CHANGE_INTERRUPT       0x00000004
1134
1135 #define MFI_OB_INTR_STATUS_MASK                 0x00000002
1136 #define MFI_POLL_TIMEOUT_SECS                   60
1137 #define MEGASAS_SRIOV_HEARTBEAT_INTERVAL_VF     (5 * HZ)
1138 #define MEGASAS_OCR_SETTLE_TIME_VF              (1000 * 30)
1139 #define MEGASAS_ROUTINE_WAIT_TIME_VF            300
1140 #define MFI_REPLY_1078_MESSAGE_INTERRUPT        0x80000000
1141 #define MFI_REPLY_GEN2_MESSAGE_INTERRUPT        0x00000001
1142 #define MFI_GEN2_ENABLE_INTERRUPT_MASK          (0x00000001 | 0x00000004)
1143 #define MFI_REPLY_SKINNY_MESSAGE_INTERRUPT      0x40000000
1144 #define MFI_SKINNY_ENABLE_INTERRUPT_MASK        (0x00000001)
1145
1146 #define MFI_1068_PCSR_OFFSET                    0x84
1147 #define MFI_1068_FW_HANDSHAKE_OFFSET            0x64
1148 #define MFI_1068_FW_READY                       0xDDDD0000
1149
1150 #define MR_MAX_REPLY_QUEUES_OFFSET              0X0000001F
1151 #define MR_MAX_REPLY_QUEUES_EXT_OFFSET          0X003FC000
1152 #define MR_MAX_REPLY_QUEUES_EXT_OFFSET_SHIFT    14
1153 #define MR_MAX_MSIX_REG_ARRAY                   16
1154 /*
1155 * register set for both 1068 and 1078 controllers
1156 * structure extended for 1078 registers
1157 */
1158  
1159 struct megasas_register_set {
1160         u32     doorbell;                       /*0000h*/
1161         u32     fusion_seq_offset;              /*0004h*/
1162         u32     fusion_host_diag;               /*0008h*/
1163         u32     reserved_01;                    /*000Ch*/
1164
1165         u32     inbound_msg_0;                  /*0010h*/
1166         u32     inbound_msg_1;                  /*0014h*/
1167         u32     outbound_msg_0;                 /*0018h*/
1168         u32     outbound_msg_1;                 /*001Ch*/
1169
1170         u32     inbound_doorbell;               /*0020h*/
1171         u32     inbound_intr_status;            /*0024h*/
1172         u32     inbound_intr_mask;              /*0028h*/
1173
1174         u32     outbound_doorbell;              /*002Ch*/
1175         u32     outbound_intr_status;           /*0030h*/
1176         u32     outbound_intr_mask;             /*0034h*/
1177
1178         u32     reserved_1[2];                  /*0038h*/
1179
1180         u32     inbound_queue_port;             /*0040h*/
1181         u32     outbound_queue_port;            /*0044h*/
1182
1183         u32     reserved_2[9];                  /*0048h*/
1184         u32     reply_post_host_index;          /*006Ch*/
1185         u32     reserved_2_2[12];               /*0070h*/
1186
1187         u32     outbound_doorbell_clear;        /*00A0h*/
1188
1189         u32     reserved_3[3];                  /*00A4h*/
1190
1191         u32     outbound_scratch_pad ;          /*00B0h*/
1192         u32     outbound_scratch_pad_2;         /*00B4h*/
1193
1194         u32     reserved_4[2];                  /*00B8h*/
1195
1196         u32     inbound_low_queue_port ;        /*00C0h*/
1197
1198         u32     inbound_high_queue_port ;       /*00C4h*/
1199
1200         u32     reserved_5;                     /*00C8h*/
1201         u32     res_6[11];                      /*CCh*/
1202         u32     host_diag;
1203         u32     seq_offset;
1204         u32     index_registers[807];           /*00CCh*/
1205 } __attribute__ ((packed));
1206
1207 struct megasas_sge32 {
1208
1209         __le32 phys_addr;
1210         __le32 length;
1211
1212 } __attribute__ ((packed));
1213
1214 struct megasas_sge64 {
1215
1216         __le64 phys_addr;
1217         __le32 length;
1218
1219 } __attribute__ ((packed));
1220
1221 struct megasas_sge_skinny {
1222         __le64 phys_addr;
1223         __le32 length;
1224         __le32 flag;
1225 } __packed;
1226
1227 union megasas_sgl {
1228
1229         struct megasas_sge32 sge32[1];
1230         struct megasas_sge64 sge64[1];
1231         struct megasas_sge_skinny sge_skinny[1];
1232
1233 } __attribute__ ((packed));
1234
1235 struct megasas_header {
1236
1237         u8 cmd;                 /*00h */
1238         u8 sense_len;           /*01h */
1239         u8 cmd_status;          /*02h */
1240         u8 scsi_status;         /*03h */
1241
1242         u8 target_id;           /*04h */
1243         u8 lun;                 /*05h */
1244         u8 cdb_len;             /*06h */
1245         u8 sge_count;           /*07h */
1246
1247         __le32 context;         /*08h */
1248         __le32 pad_0;           /*0Ch */
1249
1250         __le16 flags;           /*10h */
1251         __le16 timeout;         /*12h */
1252         __le32 data_xferlen;    /*14h */
1253
1254 } __attribute__ ((packed));
1255
1256 union megasas_sgl_frame {
1257
1258         struct megasas_sge32 sge32[8];
1259         struct megasas_sge64 sge64[5];
1260
1261 } __attribute__ ((packed));
1262
1263 typedef union _MFI_CAPABILITIES {
1264         struct {
1265 #if   defined(__BIG_ENDIAN_BITFIELD)
1266                 u32     reserved:23;
1267                 u32     support_ext_io_size:1;
1268                 u32     support_ext_queue_depth:1;
1269                 u32     security_protocol_cmds_fw:1;
1270                 u32     support_core_affinity:1;
1271                 u32     support_ndrive_r1_lb:1;
1272                 u32     support_max_255lds:1;
1273                 u32     support_fastpath_wb:1;
1274                 u32     support_additional_msix:1;
1275                 u32     support_fp_remote_lun:1;
1276 #else
1277                 u32     support_fp_remote_lun:1;
1278                 u32     support_additional_msix:1;
1279                 u32     support_fastpath_wb:1;
1280                 u32     support_max_255lds:1;
1281                 u32     support_ndrive_r1_lb:1;
1282                 u32     support_core_affinity:1;
1283                 u32     security_protocol_cmds_fw:1;
1284                 u32     support_ext_queue_depth:1;
1285                 u32     support_ext_io_size:1;
1286                 u32     reserved:23;
1287 #endif
1288         } mfi_capabilities;
1289         __le32          reg;
1290 } MFI_CAPABILITIES;
1291
1292 struct megasas_init_frame {
1293
1294         u8 cmd;                 /*00h */
1295         u8 reserved_0;          /*01h */
1296         u8 cmd_status;          /*02h */
1297
1298         u8 reserved_1;          /*03h */
1299         MFI_CAPABILITIES driver_operations; /*04h*/
1300
1301         __le32 context;         /*08h */
1302         __le32 pad_0;           /*0Ch */
1303
1304         __le16 flags;           /*10h */
1305         __le16 reserved_3;              /*12h */
1306         __le32 data_xfer_len;   /*14h */
1307
1308         __le32 queue_info_new_phys_addr_lo;     /*18h */
1309         __le32 queue_info_new_phys_addr_hi;     /*1Ch */
1310         __le32 queue_info_old_phys_addr_lo;     /*20h */
1311         __le32 queue_info_old_phys_addr_hi;     /*24h */
1312         __le32 reserved_4[2];   /*28h */
1313         __le32 system_info_lo;      /*30h */
1314         __le32 system_info_hi;      /*34h */
1315         __le32 reserved_5[2];   /*38h */
1316
1317 } __attribute__ ((packed));
1318
1319 struct megasas_init_queue_info {
1320
1321         __le32 init_flags;              /*00h */
1322         __le32 reply_queue_entries;     /*04h */
1323
1324         __le32 reply_queue_start_phys_addr_lo;  /*08h */
1325         __le32 reply_queue_start_phys_addr_hi;  /*0Ch */
1326         __le32 producer_index_phys_addr_lo;     /*10h */
1327         __le32 producer_index_phys_addr_hi;     /*14h */
1328         __le32 consumer_index_phys_addr_lo;     /*18h */
1329         __le32 consumer_index_phys_addr_hi;     /*1Ch */
1330
1331 } __attribute__ ((packed));
1332
1333 struct megasas_io_frame {
1334
1335         u8 cmd;                 /*00h */
1336         u8 sense_len;           /*01h */
1337         u8 cmd_status;          /*02h */
1338         u8 scsi_status;         /*03h */
1339
1340         u8 target_id;           /*04h */
1341         u8 access_byte;         /*05h */
1342         u8 reserved_0;          /*06h */
1343         u8 sge_count;           /*07h */
1344
1345         __le32 context;         /*08h */
1346         __le32 pad_0;           /*0Ch */
1347
1348         __le16 flags;           /*10h */
1349         __le16 timeout;         /*12h */
1350         __le32 lba_count;       /*14h */
1351
1352         __le32 sense_buf_phys_addr_lo;  /*18h */
1353         __le32 sense_buf_phys_addr_hi;  /*1Ch */
1354
1355         __le32 start_lba_lo;    /*20h */
1356         __le32 start_lba_hi;    /*24h */
1357
1358         union megasas_sgl sgl;  /*28h */
1359
1360 } __attribute__ ((packed));
1361
1362 struct megasas_pthru_frame {
1363
1364         u8 cmd;                 /*00h */
1365         u8 sense_len;           /*01h */
1366         u8 cmd_status;          /*02h */
1367         u8 scsi_status;         /*03h */
1368
1369         u8 target_id;           /*04h */
1370         u8 lun;                 /*05h */
1371         u8 cdb_len;             /*06h */
1372         u8 sge_count;           /*07h */
1373
1374         __le32 context;         /*08h */
1375         __le32 pad_0;           /*0Ch */
1376
1377         __le16 flags;           /*10h */
1378         __le16 timeout;         /*12h */
1379         __le32 data_xfer_len;   /*14h */
1380
1381         __le32 sense_buf_phys_addr_lo;  /*18h */
1382         __le32 sense_buf_phys_addr_hi;  /*1Ch */
1383
1384         u8 cdb[16];             /*20h */
1385         union megasas_sgl sgl;  /*30h */
1386
1387 } __attribute__ ((packed));
1388
1389 struct megasas_dcmd_frame {
1390
1391         u8 cmd;                 /*00h */
1392         u8 reserved_0;          /*01h */
1393         u8 cmd_status;          /*02h */
1394         u8 reserved_1[4];       /*03h */
1395         u8 sge_count;           /*07h */
1396
1397         __le32 context;         /*08h */
1398         __le32 pad_0;           /*0Ch */
1399
1400         __le16 flags;           /*10h */
1401         __le16 timeout;         /*12h */
1402
1403         __le32 data_xfer_len;   /*14h */
1404         __le32 opcode;          /*18h */
1405
1406         union {                 /*1Ch */
1407                 u8 b[12];
1408                 __le16 s[6];
1409                 __le32 w[3];
1410         } mbox;
1411
1412         union megasas_sgl sgl;  /*28h */
1413
1414 } __attribute__ ((packed));
1415
1416 struct megasas_abort_frame {
1417
1418         u8 cmd;                 /*00h */
1419         u8 reserved_0;          /*01h */
1420         u8 cmd_status;          /*02h */
1421
1422         u8 reserved_1;          /*03h */
1423         __le32 reserved_2;      /*04h */
1424
1425         __le32 context;         /*08h */
1426         __le32 pad_0;           /*0Ch */
1427
1428         __le16 flags;           /*10h */
1429         __le16 reserved_3;      /*12h */
1430         __le32 reserved_4;      /*14h */
1431
1432         __le32 abort_context;   /*18h */
1433         __le32 pad_1;           /*1Ch */
1434
1435         __le32 abort_mfi_phys_addr_lo;  /*20h */
1436         __le32 abort_mfi_phys_addr_hi;  /*24h */
1437
1438         __le32 reserved_5[6];   /*28h */
1439
1440 } __attribute__ ((packed));
1441
1442 struct megasas_smp_frame {
1443
1444         u8 cmd;                 /*00h */
1445         u8 reserved_1;          /*01h */
1446         u8 cmd_status;          /*02h */
1447         u8 connection_status;   /*03h */
1448
1449         u8 reserved_2[3];       /*04h */
1450         u8 sge_count;           /*07h */
1451
1452         __le32 context;         /*08h */
1453         __le32 pad_0;           /*0Ch */
1454
1455         __le16 flags;           /*10h */
1456         __le16 timeout;         /*12h */
1457
1458         __le32 data_xfer_len;   /*14h */
1459         __le64 sas_addr;        /*18h */
1460
1461         union {
1462                 struct megasas_sge32 sge32[2];  /* [0]: resp [1]: req */
1463                 struct megasas_sge64 sge64[2];  /* [0]: resp [1]: req */
1464         } sgl;
1465
1466 } __attribute__ ((packed));
1467
1468 struct megasas_stp_frame {
1469
1470         u8 cmd;                 /*00h */
1471         u8 reserved_1;          /*01h */
1472         u8 cmd_status;          /*02h */
1473         u8 reserved_2;          /*03h */
1474
1475         u8 target_id;           /*04h */
1476         u8 reserved_3[2];       /*05h */
1477         u8 sge_count;           /*07h */
1478
1479         __le32 context;         /*08h */
1480         __le32 pad_0;           /*0Ch */
1481
1482         __le16 flags;           /*10h */
1483         __le16 timeout;         /*12h */
1484
1485         __le32 data_xfer_len;   /*14h */
1486
1487         __le16 fis[10];         /*18h */
1488         __le32 stp_flags;
1489
1490         union {
1491                 struct megasas_sge32 sge32[2];  /* [0]: resp [1]: data */
1492                 struct megasas_sge64 sge64[2];  /* [0]: resp [1]: data */
1493         } sgl;
1494
1495 } __attribute__ ((packed));
1496
1497 union megasas_frame {
1498
1499         struct megasas_header hdr;
1500         struct megasas_init_frame init;
1501         struct megasas_io_frame io;
1502         struct megasas_pthru_frame pthru;
1503         struct megasas_dcmd_frame dcmd;
1504         struct megasas_abort_frame abort;
1505         struct megasas_smp_frame smp;
1506         struct megasas_stp_frame stp;
1507
1508         u8 raw_bytes[64];
1509 };
1510
1511 struct megasas_cmd;
1512
1513 union megasas_evt_class_locale {
1514
1515         struct {
1516 #ifndef __BIG_ENDIAN_BITFIELD
1517                 u16 locale;
1518                 u8 reserved;
1519                 s8 class;
1520 #else
1521                 s8 class;
1522                 u8 reserved;
1523                 u16 locale;
1524 #endif
1525         } __attribute__ ((packed)) members;
1526
1527         u32 word;
1528
1529 } __attribute__ ((packed));
1530
1531 struct megasas_evt_log_info {
1532         __le32 newest_seq_num;
1533         __le32 oldest_seq_num;
1534         __le32 clear_seq_num;
1535         __le32 shutdown_seq_num;
1536         __le32 boot_seq_num;
1537
1538 } __attribute__ ((packed));
1539
1540 struct megasas_progress {
1541
1542         __le16 progress;
1543         __le16 elapsed_seconds;
1544
1545 } __attribute__ ((packed));
1546
1547 struct megasas_evtarg_ld {
1548
1549         u16 target_id;
1550         u8 ld_index;
1551         u8 reserved;
1552
1553 } __attribute__ ((packed));
1554
1555 struct megasas_evtarg_pd {
1556         u16 device_id;
1557         u8 encl_index;
1558         u8 slot_number;
1559
1560 } __attribute__ ((packed));
1561
1562 struct megasas_evt_detail {
1563
1564         __le32 seq_num;
1565         __le32 time_stamp;
1566         __le32 code;
1567         union megasas_evt_class_locale cl;
1568         u8 arg_type;
1569         u8 reserved1[15];
1570
1571         union {
1572                 struct {
1573                         struct megasas_evtarg_pd pd;
1574                         u8 cdb_length;
1575                         u8 sense_length;
1576                         u8 reserved[2];
1577                         u8 cdb[16];
1578                         u8 sense[64];
1579                 } __attribute__ ((packed)) cdbSense;
1580
1581                 struct megasas_evtarg_ld ld;
1582
1583                 struct {
1584                         struct megasas_evtarg_ld ld;
1585                         __le64 count;
1586                 } __attribute__ ((packed)) ld_count;
1587
1588                 struct {
1589                         __le64 lba;
1590                         struct megasas_evtarg_ld ld;
1591                 } __attribute__ ((packed)) ld_lba;
1592
1593                 struct {
1594                         struct megasas_evtarg_ld ld;
1595                         __le32 prevOwner;
1596                         __le32 newOwner;
1597                 } __attribute__ ((packed)) ld_owner;
1598
1599                 struct {
1600                         u64 ld_lba;
1601                         u64 pd_lba;
1602                         struct megasas_evtarg_ld ld;
1603                         struct megasas_evtarg_pd pd;
1604                 } __attribute__ ((packed)) ld_lba_pd_lba;
1605
1606                 struct {
1607                         struct megasas_evtarg_ld ld;
1608                         struct megasas_progress prog;
1609                 } __attribute__ ((packed)) ld_prog;
1610
1611                 struct {
1612                         struct megasas_evtarg_ld ld;
1613                         u32 prev_state;
1614                         u32 new_state;
1615                 } __attribute__ ((packed)) ld_state;
1616
1617                 struct {
1618                         u64 strip;
1619                         struct megasas_evtarg_ld ld;
1620                 } __attribute__ ((packed)) ld_strip;
1621
1622                 struct megasas_evtarg_pd pd;
1623
1624                 struct {
1625                         struct megasas_evtarg_pd pd;
1626                         u32 err;
1627                 } __attribute__ ((packed)) pd_err;
1628
1629                 struct {
1630                         u64 lba;
1631                         struct megasas_evtarg_pd pd;
1632                 } __attribute__ ((packed)) pd_lba;
1633
1634                 struct {
1635                         u64 lba;
1636                         struct megasas_evtarg_pd pd;
1637                         struct megasas_evtarg_ld ld;
1638                 } __attribute__ ((packed)) pd_lba_ld;
1639
1640                 struct {
1641                         struct megasas_evtarg_pd pd;
1642                         struct megasas_progress prog;
1643                 } __attribute__ ((packed)) pd_prog;
1644
1645                 struct {
1646                         struct megasas_evtarg_pd pd;
1647                         u32 prevState;
1648                         u32 newState;
1649                 } __attribute__ ((packed)) pd_state;
1650
1651                 struct {
1652                         u16 vendorId;
1653                         __le16 deviceId;
1654                         u16 subVendorId;
1655                         u16 subDeviceId;
1656                 } __attribute__ ((packed)) pci;
1657
1658                 u32 rate;
1659                 char str[96];
1660
1661                 struct {
1662                         u32 rtc;
1663                         u32 elapsedSeconds;
1664                 } __attribute__ ((packed)) time;
1665
1666                 struct {
1667                         u32 ecar;
1668                         u32 elog;
1669                         char str[64];
1670                 } __attribute__ ((packed)) ecc;
1671
1672                 u8 b[96];
1673                 __le16 s[48];
1674                 __le32 w[24];
1675                 __le64 d[12];
1676         } args;
1677
1678         char description[128];
1679
1680 } __attribute__ ((packed));
1681
1682 struct megasas_aen_event {
1683         struct delayed_work hotplug_work;
1684         struct megasas_instance *instance;
1685 };
1686
1687 struct megasas_irq_context {
1688         struct megasas_instance *instance;
1689         u32 MSIxIndex;
1690 };
1691
1692 struct MR_DRV_SYSTEM_INFO {
1693         u8      infoVersion;
1694         u8      systemIdLength;
1695         u16     reserved0;
1696         u8      systemId[64];
1697         u8      reserved[1980];
1698 };
1699
1700 struct megasas_instance {
1701
1702         __le32 *producer;
1703         dma_addr_t producer_h;
1704         __le32 *consumer;
1705         dma_addr_t consumer_h;
1706         struct MR_DRV_SYSTEM_INFO *system_info_buf;
1707         dma_addr_t system_info_h;
1708         struct MR_LD_VF_AFFILIATION *vf_affiliation;
1709         dma_addr_t vf_affiliation_h;
1710         struct MR_LD_VF_AFFILIATION_111 *vf_affiliation_111;
1711         dma_addr_t vf_affiliation_111_h;
1712         struct MR_CTRL_HB_HOST_MEM *hb_host_mem;
1713         dma_addr_t hb_host_mem_h;
1714
1715         __le32 *reply_queue;
1716         dma_addr_t reply_queue_h;
1717
1718         u32 *crash_dump_buf;
1719         dma_addr_t crash_dump_h;
1720         void *crash_buf[MAX_CRASH_DUMP_SIZE];
1721         u32 crash_buf_pages;
1722         unsigned int    fw_crash_buffer_size;
1723         unsigned int    fw_crash_state;
1724         unsigned int    fw_crash_buffer_offset;
1725         u32 drv_buf_index;
1726         u32 drv_buf_alloc;
1727         u32 crash_dump_fw_support;
1728         u32 crash_dump_drv_support;
1729         u32 crash_dump_app_support;
1730         u32 secure_jbod_support;
1731         bool use_seqnum_jbod_fp;   /* Added for PD sequence */
1732         spinlock_t crashdump_lock;
1733
1734         struct megasas_register_set __iomem *reg_set;
1735         u32 __iomem *reply_post_host_index_addr[MR_MAX_MSIX_REG_ARRAY];
1736         struct megasas_pd_list          pd_list[MEGASAS_MAX_PD];
1737         struct megasas_pd_list          local_pd_list[MEGASAS_MAX_PD];
1738         u8 ld_ids[MEGASAS_MAX_LD_IDS];
1739         s8 init_id;
1740
1741         u16 max_num_sge;
1742         u16 max_fw_cmds;
1743         u16 max_mfi_cmds;
1744         u16 max_scsi_cmds;
1745         u32 max_sectors_per_req;
1746         struct megasas_aen_event *ev;
1747
1748         struct megasas_cmd **cmd_list;
1749         struct list_head cmd_pool;
1750         /* used to sync fire the cmd to fw */
1751         spinlock_t mfi_pool_lock;
1752         /* used to sync fire the cmd to fw */
1753         spinlock_t hba_lock;
1754         /* used to synch producer, consumer ptrs in dpc */
1755         spinlock_t completion_lock;
1756         struct dma_pool *frame_dma_pool;
1757         struct dma_pool *sense_dma_pool;
1758
1759         struct megasas_evt_detail *evt_detail;
1760         dma_addr_t evt_detail_h;
1761         struct megasas_cmd *aen_cmd;
1762         struct mutex aen_mutex;
1763         struct semaphore ioctl_sem;
1764
1765         struct Scsi_Host *host;
1766
1767         wait_queue_head_t int_cmd_wait_q;
1768         wait_queue_head_t abort_cmd_wait_q;
1769
1770         struct pci_dev *pdev;
1771         u32 unique_id;
1772         u32 fw_support_ieee;
1773
1774         atomic_t fw_outstanding;
1775         atomic_t fw_reset_no_pci_access;
1776
1777         struct megasas_instance_template *instancet;
1778         struct tasklet_struct isr_tasklet;
1779         struct work_struct work_init;
1780         struct work_struct crash_init;
1781
1782         u8 flag;
1783         u8 unload;
1784         u8 flag_ieee;
1785         u8 issuepend_done;
1786         u8 disableOnlineCtrlReset;
1787         u8 UnevenSpanSupport;
1788
1789         u8 supportmax256vd;
1790         u16 fw_supported_vd_count;
1791         u16 fw_supported_pd_count;
1792
1793         u16 drv_supported_vd_count;
1794         u16 drv_supported_pd_count;
1795
1796         u8 adprecovery;
1797         unsigned long last_time;
1798         u32 mfiStatus;
1799         u32 last_seq_num;
1800
1801         struct list_head internal_reset_pending_q;
1802
1803         /* Ptr to hba specific information */
1804         void *ctrl_context;
1805         u32 ctrl_context_pages;
1806         struct megasas_ctrl_info *ctrl_info;
1807         unsigned int msix_vectors;
1808         struct msix_entry msixentry[MEGASAS_MAX_MSIX_QUEUES];
1809         struct megasas_irq_context irq_context[MEGASAS_MAX_MSIX_QUEUES];
1810         u64 map_id;
1811         u64 pd_seq_map_id;
1812         struct megasas_cmd *map_update_cmd;
1813         struct megasas_cmd *jbod_seq_cmd;
1814         unsigned long bar;
1815         long reset_flags;
1816         struct mutex reset_mutex;
1817         struct timer_list sriov_heartbeat_timer;
1818         char skip_heartbeat_timer_del;
1819         u8 requestorId;
1820         char PlasmaFW111;
1821         char mpio;
1822         u16 throttlequeuedepth;
1823         u8 mask_interrupts;
1824         u16 max_chain_frame_sz;
1825         u8 is_imr;
1826         bool dev_handle;
1827 };
1828 struct MR_LD_VF_MAP {
1829         u32 size;
1830         union MR_LD_REF ref;
1831         u8 ldVfCount;
1832         u8 reserved[6];
1833         u8 policy[1];
1834 };
1835
1836 struct MR_LD_VF_AFFILIATION {
1837         u32 size;
1838         u8 ldCount;
1839         u8 vfCount;
1840         u8 thisVf;
1841         u8 reserved[9];
1842         struct MR_LD_VF_MAP map[1];
1843 };
1844
1845 /* Plasma 1.11 FW backward compatibility structures */
1846 #define IOV_111_OFFSET 0x7CE
1847 #define MAX_VIRTUAL_FUNCTIONS 8
1848 #define MR_LD_ACCESS_HIDDEN 15
1849
1850 struct IOV_111 {
1851         u8 maxVFsSupported;
1852         u8 numVFsEnabled;
1853         u8 requestorId;
1854         u8 reserved[5];
1855 };
1856
1857 struct MR_LD_VF_MAP_111 {
1858         u8 targetId;
1859         u8 reserved[3];
1860         u8 policy[MAX_VIRTUAL_FUNCTIONS];
1861 };
1862
1863 struct MR_LD_VF_AFFILIATION_111 {
1864         u8 vdCount;
1865         u8 vfCount;
1866         u8 thisVf;
1867         u8 reserved[5];
1868         struct MR_LD_VF_MAP_111 map[MAX_LOGICAL_DRIVES];
1869 };
1870
1871 struct MR_CTRL_HB_HOST_MEM {
1872         struct {
1873                 u32 fwCounter;  /* Firmware heart beat counter */
1874                 struct {
1875                         u32 debugmode:1; /* 1=Firmware is in debug mode.
1876                                             Heart beat will not be updated. */
1877                         u32 reserved:31;
1878                 } debug;
1879                 u32 reserved_fw[6];
1880                 u32 driverCounter; /* Driver heart beat counter.  0x20 */
1881                 u32 reserved_driver[7];
1882         } HB;
1883         u8 pad[0x400-0x40];
1884 };
1885
1886 enum {
1887         MEGASAS_HBA_OPERATIONAL                 = 0,
1888         MEGASAS_ADPRESET_SM_INFAULT             = 1,
1889         MEGASAS_ADPRESET_SM_FW_RESET_SUCCESS    = 2,
1890         MEGASAS_ADPRESET_SM_OPERATIONAL         = 3,
1891         MEGASAS_HW_CRITICAL_ERROR               = 4,
1892         MEGASAS_ADPRESET_SM_POLLING             = 5,
1893         MEGASAS_ADPRESET_INPROG_SIGN            = 0xDEADDEAD,
1894 };
1895
1896 struct megasas_instance_template {
1897         void (*fire_cmd)(struct megasas_instance *, dma_addr_t, \
1898                 u32, struct megasas_register_set __iomem *);
1899
1900         void (*enable_intr)(struct megasas_instance *);
1901         void (*disable_intr)(struct megasas_instance *);
1902
1903         int (*clear_intr)(struct megasas_register_set __iomem *);
1904
1905         u32 (*read_fw_status_reg)(struct megasas_register_set __iomem *);
1906         int (*adp_reset)(struct megasas_instance *, \
1907                 struct megasas_register_set __iomem *);
1908         int (*check_reset)(struct megasas_instance *, \
1909                 struct megasas_register_set __iomem *);
1910         irqreturn_t (*service_isr)(int irq, void *devp);
1911         void (*tasklet)(unsigned long);
1912         u32 (*init_adapter)(struct megasas_instance *);
1913         u32 (*build_and_issue_cmd) (struct megasas_instance *,
1914                                     struct scsi_cmnd *);
1915         void (*issue_dcmd) (struct megasas_instance *instance,
1916                             struct megasas_cmd *cmd);
1917 };
1918
1919 #define MEGASAS_IS_LOGICAL(scp)                                         \
1920         (scp->device->channel < MEGASAS_MAX_PD_CHANNELS) ? 0 : 1
1921
1922 #define MEGASAS_DEV_INDEX(scp)                                          \
1923         (((scp->device->channel % 2) * MEGASAS_MAX_DEV_PER_CHANNEL) +   \
1924         scp->device->id)
1925
1926 #define MEGASAS_PD_INDEX(scp)                                           \
1927         ((scp->device->channel * MEGASAS_MAX_DEV_PER_CHANNEL) +         \
1928         scp->device->id)
1929
1930 struct megasas_cmd {
1931
1932         union megasas_frame *frame;
1933         dma_addr_t frame_phys_addr;
1934         u8 *sense;
1935         dma_addr_t sense_phys_addr;
1936
1937         u32 index;
1938         u8 sync_cmd;
1939         u8 cmd_status_drv;
1940         u8 abort_aen;
1941         u8 retry_for_fw_reset;
1942
1943
1944         struct list_head list;
1945         struct scsi_cmnd *scmd;
1946         u8 flags;
1947
1948         struct megasas_instance *instance;
1949         union {
1950                 struct {
1951                         u16 smid;
1952                         u16 resvd;
1953                 } context;
1954                 u32 frame_count;
1955         };
1956 };
1957
1958 #define MAX_MGMT_ADAPTERS               1024
1959 #define MAX_IOCTL_SGE                   16
1960
1961 struct megasas_iocpacket {
1962
1963         u16 host_no;
1964         u16 __pad1;
1965         u32 sgl_off;
1966         u32 sge_count;
1967         u32 sense_off;
1968         u32 sense_len;
1969         union {
1970                 u8 raw[128];
1971                 struct megasas_header hdr;
1972         } frame;
1973
1974         struct iovec sgl[MAX_IOCTL_SGE];
1975
1976 } __attribute__ ((packed));
1977
1978 struct megasas_aen {
1979         u16 host_no;
1980         u16 __pad1;
1981         u32 seq_num;
1982         u32 class_locale_word;
1983 } __attribute__ ((packed));
1984
1985 #ifdef CONFIG_COMPAT
1986 struct compat_megasas_iocpacket {
1987         u16 host_no;
1988         u16 __pad1;
1989         u32 sgl_off;
1990         u32 sge_count;
1991         u32 sense_off;
1992         u32 sense_len;
1993         union {
1994                 u8 raw[128];
1995                 struct megasas_header hdr;
1996         } frame;
1997         struct compat_iovec sgl[MAX_IOCTL_SGE];
1998 } __attribute__ ((packed));
1999
2000 #define MEGASAS_IOC_FIRMWARE32  _IOWR('M', 1, struct compat_megasas_iocpacket)
2001 #endif
2002
2003 #define MEGASAS_IOC_FIRMWARE    _IOWR('M', 1, struct megasas_iocpacket)
2004 #define MEGASAS_IOC_GET_AEN     _IOW('M', 3, struct megasas_aen)
2005
2006 struct megasas_mgmt_info {
2007
2008         u16 count;
2009         struct megasas_instance *instance[MAX_MGMT_ADAPTERS];
2010         int max_index;
2011 };
2012
2013 u8
2014 MR_BuildRaidContext(struct megasas_instance *instance,
2015                     struct IO_REQUEST_INFO *io_info,
2016                     struct RAID_CONTEXT *pRAID_Context,
2017                     struct MR_DRV_RAID_MAP_ALL *map, u8 **raidLUN);
2018 u8 MR_TargetIdToLdGet(u32 ldTgtId, struct MR_DRV_RAID_MAP_ALL *map);
2019 struct MR_LD_RAID *MR_LdRaidGet(u32 ld, struct MR_DRV_RAID_MAP_ALL *map);
2020 u16 MR_ArPdGet(u32 ar, u32 arm, struct MR_DRV_RAID_MAP_ALL *map);
2021 u16 MR_LdSpanArrayGet(u32 ld, u32 span, struct MR_DRV_RAID_MAP_ALL *map);
2022 __le16 MR_PdDevHandleGet(u32 pd, struct MR_DRV_RAID_MAP_ALL *map);
2023 u16 MR_GetLDTgtId(u32 ld, struct MR_DRV_RAID_MAP_ALL *map);
2024
2025 __le16 get_updated_dev_handle(struct megasas_instance *instance,
2026         struct LD_LOAD_BALANCE_INFO *lbInfo, struct IO_REQUEST_INFO *in_info);
2027 void mr_update_load_balance_params(struct MR_DRV_RAID_MAP_ALL *map,
2028         struct LD_LOAD_BALANCE_INFO *lbInfo);
2029 int megasas_get_ctrl_info(struct megasas_instance *instance);
2030 /* PD sequence */
2031 int
2032 megasas_sync_pd_seq_num(struct megasas_instance *instance, bool pend);
2033 int megasas_set_crash_dump_params(struct megasas_instance *instance,
2034         u8 crash_buf_state);
2035 void megasas_free_host_crash_buffer(struct megasas_instance *instance);
2036 void megasas_fusion_crash_dump_wq(struct work_struct *work);
2037
2038 void megasas_return_cmd_fusion(struct megasas_instance *instance,
2039         struct megasas_cmd_fusion *cmd);
2040 int megasas_issue_blocked_cmd(struct megasas_instance *instance,
2041         struct megasas_cmd *cmd, int timeout);
2042 void __megasas_return_cmd(struct megasas_instance *instance,
2043         struct megasas_cmd *cmd);
2044
2045 void megasas_return_mfi_mpt_pthr(struct megasas_instance *instance,
2046         struct megasas_cmd *cmd_mfi, struct megasas_cmd_fusion *cmd_fusion);
2047 int megasas_cmd_type(struct scsi_cmnd *cmd);
2048 void megasas_setup_jbod_map(struct megasas_instance *instance);
2049
2050 #endif                          /*LSI_MEGARAID_SAS_H */