2 * Linux MegaRAID driver for SAS based RAID controllers
4 * Copyright (c) 2003-2013 LSI Corporation
5 * Copyright (c) 2013-2014 Avago Technologies
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.
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.
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/>.
20 * FILE: megaraid_sas.h
22 * Authors: Avago Technologies
23 * Kashyap Desai <kashyap.desai@avagotech.com>
24 * Sumit Saxena <sumit.saxena@avagotech.com>
26 * Send feedback to: megaraidlinux.pdl@avagotech.com
28 * Mail to: Avago Technologies, 350 West Trimble Road, Building 90,
29 * San Jose, California 95131
32 #ifndef LSI_MEGARAID_SAS_H
33 #define LSI_MEGARAID_SAS_H
36 * MegaRAID SAS Driver meta data
38 #define MEGASAS_VERSION "06.810.09.00-rc1"
39 #define MEGASAS_RELDATE "Jan. 28, 2016"
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
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
74 #define MEGARAID_INTRUDER_SSDID1 0x9371
75 #define MEGARAID_INTRUDER_SSDID2 0x9390
76 #define MEGARAID_INTRUDER_SSDID3 0x9370
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"
97 * =====================================
98 * MegaRAID SAS MFI firmware definitions
99 * =====================================
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
109 * FW posts its state in upper 4 bits of outbound_msg_0 register
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
131 * During FW init, clear pending cmds & reset state using inbound_msg_0
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
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)
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| \
155 #define MPI2_IOCINIT_MSGFLAG_RDPQ_ARRAY_MODE (0x01)
160 #define MFI_FRAME_POST_IN_REPLY_QUEUE 0x0000
161 #define MFI_FRAME_DONT_POST_IN_REPLY_QUEUE 0x0001
162 #define MFI_FRAME_SGL32 0x0000
163 #define MFI_FRAME_SGL64 0x0002
164 #define MFI_FRAME_SENSE32 0x0000
165 #define MFI_FRAME_SENSE64 0x0004
166 #define MFI_FRAME_DIR_NONE 0x0000
167 #define MFI_FRAME_DIR_WRITE 0x0008
168 #define MFI_FRAME_DIR_READ 0x0010
169 #define MFI_FRAME_DIR_BOTH 0x0018
170 #define MFI_FRAME_IEEE 0x0020
172 /* Driver internal */
173 #define DRV_DCMD_POLLED_MODE 0x1
174 #define DRV_DCMD_SKIP_REFIRE 0x2
177 * Definition for cmd_status
179 #define MFI_CMD_STATUS_POLL_MODE 0xFF
182 * MFI command opcodes
184 #define MFI_CMD_INIT 0x00
185 #define MFI_CMD_LD_READ 0x01
186 #define MFI_CMD_LD_WRITE 0x02
187 #define MFI_CMD_LD_SCSI_IO 0x03
188 #define MFI_CMD_PD_SCSI_IO 0x04
189 #define MFI_CMD_DCMD 0x05
190 #define MFI_CMD_ABORT 0x06
191 #define MFI_CMD_SMP 0x07
192 #define MFI_CMD_STP 0x08
193 #define MFI_CMD_INVALID 0xff
195 #define MR_DCMD_CTRL_GET_INFO 0x01010000
196 #define MR_DCMD_LD_GET_LIST 0x03010000
197 #define MR_DCMD_LD_LIST_QUERY 0x03010100
199 #define MR_DCMD_CTRL_CACHE_FLUSH 0x01101000
200 #define MR_FLUSH_CTRL_CACHE 0x01
201 #define MR_FLUSH_DISK_CACHE 0x02
203 #define MR_DCMD_CTRL_SHUTDOWN 0x01050000
204 #define MR_DCMD_HIBERNATE_SHUTDOWN 0x01060000
205 #define MR_ENABLE_DRIVE_SPINDOWN 0x01
207 #define MR_DCMD_CTRL_EVENT_GET_INFO 0x01040100
208 #define MR_DCMD_CTRL_EVENT_GET 0x01040300
209 #define MR_DCMD_CTRL_EVENT_WAIT 0x01040500
210 #define MR_DCMD_LD_GET_PROPERTIES 0x03030000
212 #define MR_DCMD_CLUSTER 0x08000000
213 #define MR_DCMD_CLUSTER_RESET_ALL 0x08010100
214 #define MR_DCMD_CLUSTER_RESET_LD 0x08010200
215 #define MR_DCMD_PD_LIST_QUERY 0x02010100
217 #define MR_DCMD_CTRL_SET_CRASH_DUMP_PARAMS 0x01190100
218 #define MR_DRIVER_SET_APP_CRASHDUMP_MODE (0xF0010000 | 0x0600)
219 #define MR_DCMD_PD_GET_INFO 0x02020000
224 extern u8 MR_ValidateMapInfo(struct megasas_instance *instance);
228 * MFI command completion codes
232 MFI_STAT_INVALID_CMD = 0x01,
233 MFI_STAT_INVALID_DCMD = 0x02,
234 MFI_STAT_INVALID_PARAMETER = 0x03,
235 MFI_STAT_INVALID_SEQUENCE_NUMBER = 0x04,
236 MFI_STAT_ABORT_NOT_POSSIBLE = 0x05,
237 MFI_STAT_APP_HOST_CODE_NOT_FOUND = 0x06,
238 MFI_STAT_APP_IN_USE = 0x07,
239 MFI_STAT_APP_NOT_INITIALIZED = 0x08,
240 MFI_STAT_ARRAY_INDEX_INVALID = 0x09,
241 MFI_STAT_ARRAY_ROW_NOT_EMPTY = 0x0a,
242 MFI_STAT_CONFIG_RESOURCE_CONFLICT = 0x0b,
243 MFI_STAT_DEVICE_NOT_FOUND = 0x0c,
244 MFI_STAT_DRIVE_TOO_SMALL = 0x0d,
245 MFI_STAT_FLASH_ALLOC_FAIL = 0x0e,
246 MFI_STAT_FLASH_BUSY = 0x0f,
247 MFI_STAT_FLASH_ERROR = 0x10,
248 MFI_STAT_FLASH_IMAGE_BAD = 0x11,
249 MFI_STAT_FLASH_IMAGE_INCOMPLETE = 0x12,
250 MFI_STAT_FLASH_NOT_OPEN = 0x13,
251 MFI_STAT_FLASH_NOT_STARTED = 0x14,
252 MFI_STAT_FLUSH_FAILED = 0x15,
253 MFI_STAT_HOST_CODE_NOT_FOUNT = 0x16,
254 MFI_STAT_LD_CC_IN_PROGRESS = 0x17,
255 MFI_STAT_LD_INIT_IN_PROGRESS = 0x18,
256 MFI_STAT_LD_LBA_OUT_OF_RANGE = 0x19,
257 MFI_STAT_LD_MAX_CONFIGURED = 0x1a,
258 MFI_STAT_LD_NOT_OPTIMAL = 0x1b,
259 MFI_STAT_LD_RBLD_IN_PROGRESS = 0x1c,
260 MFI_STAT_LD_RECON_IN_PROGRESS = 0x1d,
261 MFI_STAT_LD_WRONG_RAID_LEVEL = 0x1e,
262 MFI_STAT_MAX_SPARES_EXCEEDED = 0x1f,
263 MFI_STAT_MEMORY_NOT_AVAILABLE = 0x20,
264 MFI_STAT_MFC_HW_ERROR = 0x21,
265 MFI_STAT_NO_HW_PRESENT = 0x22,
266 MFI_STAT_NOT_FOUND = 0x23,
267 MFI_STAT_NOT_IN_ENCL = 0x24,
268 MFI_STAT_PD_CLEAR_IN_PROGRESS = 0x25,
269 MFI_STAT_PD_TYPE_WRONG = 0x26,
270 MFI_STAT_PR_DISABLED = 0x27,
271 MFI_STAT_ROW_INDEX_INVALID = 0x28,
272 MFI_STAT_SAS_CONFIG_INVALID_ACTION = 0x29,
273 MFI_STAT_SAS_CONFIG_INVALID_DATA = 0x2a,
274 MFI_STAT_SAS_CONFIG_INVALID_PAGE = 0x2b,
275 MFI_STAT_SAS_CONFIG_INVALID_TYPE = 0x2c,
276 MFI_STAT_SCSI_DONE_WITH_ERROR = 0x2d,
277 MFI_STAT_SCSI_IO_FAILED = 0x2e,
278 MFI_STAT_SCSI_RESERVATION_CONFLICT = 0x2f,
279 MFI_STAT_SHUTDOWN_FAILED = 0x30,
280 MFI_STAT_TIME_NOT_SET = 0x31,
281 MFI_STAT_WRONG_STATE = 0x32,
282 MFI_STAT_LD_OFFLINE = 0x33,
283 MFI_STAT_PEER_NOTIFICATION_REJECTED = 0x34,
284 MFI_STAT_PEER_NOTIFICATION_FAILED = 0x35,
285 MFI_STAT_RESERVATION_IN_PROGRESS = 0x36,
286 MFI_STAT_I2C_ERRORS_DETECTED = 0x37,
287 MFI_STAT_PCI_ERRORS_DETECTED = 0x38,
288 MFI_STAT_CONFIG_SEQ_MISMATCH = 0x67,
290 MFI_STAT_INVALID_STATUS = 0xFF
294 MFI_EVT_CLASS_DEBUG = -2,
295 MFI_EVT_CLASS_PROGRESS = -1,
296 MFI_EVT_CLASS_INFO = 0,
297 MFI_EVT_CLASS_WARNING = 1,
298 MFI_EVT_CLASS_CRITICAL = 2,
299 MFI_EVT_CLASS_FATAL = 3,
300 MFI_EVT_CLASS_DEAD = 4
304 * Crash dump related defines
306 #define MAX_CRASH_DUMP_SIZE 512
307 #define CRASH_DMA_BUF_SIZE (1024 * 1024)
309 enum MR_FW_CRASH_DUMP_STATE {
317 enum _MR_CRASH_BUF_STATUS {
318 MR_CRASH_BUF_TURN_OFF = 0,
319 MR_CRASH_BUF_TURN_ON = 1,
323 * Number of mailbox bytes in DCMD message frame
325 #define MFI_MBOX_SIZE 12
329 MR_EVT_CLASS_DEBUG = -2,
330 MR_EVT_CLASS_PROGRESS = -1,
331 MR_EVT_CLASS_INFO = 0,
332 MR_EVT_CLASS_WARNING = 1,
333 MR_EVT_CLASS_CRITICAL = 2,
334 MR_EVT_CLASS_FATAL = 3,
335 MR_EVT_CLASS_DEAD = 4,
341 MR_EVT_LOCALE_LD = 0x0001,
342 MR_EVT_LOCALE_PD = 0x0002,
343 MR_EVT_LOCALE_ENCL = 0x0004,
344 MR_EVT_LOCALE_BBU = 0x0008,
345 MR_EVT_LOCALE_SAS = 0x0010,
346 MR_EVT_LOCALE_CTRL = 0x0020,
347 MR_EVT_LOCALE_CONFIG = 0x0040,
348 MR_EVT_LOCALE_CLUSTER = 0x0080,
349 MR_EVT_LOCALE_ALL = 0xffff,
356 MR_EVT_ARGS_CDB_SENSE,
358 MR_EVT_ARGS_LD_COUNT,
360 MR_EVT_ARGS_LD_OWNER,
361 MR_EVT_ARGS_LD_LBA_PD_LBA,
363 MR_EVT_ARGS_LD_STATE,
364 MR_EVT_ARGS_LD_STRIP,
368 MR_EVT_ARGS_PD_LBA_LD,
370 MR_EVT_ARGS_PD_STATE,
377 MR_EVT_ARGS_PD_SPARE,
378 MR_EVT_ARGS_PD_INDEX,
379 MR_EVT_ARGS_DIAG_PASS,
380 MR_EVT_ARGS_DIAG_FAIL,
381 MR_EVT_ARGS_PD_LBA_LBA,
382 MR_EVT_ARGS_PORT_PHY,
383 MR_EVT_ARGS_PD_MISSING,
384 MR_EVT_ARGS_PD_ADDRESS,
386 MR_EVT_ARGS_CONNECTOR,
389 MR_EVT_ARGS_PD_PATHINFO,
390 MR_EVT_ARGS_PD_POWER_STATE,
395 #define SGE_BUFFER_SIZE 4096
396 #define MEGASAS_CLUSTER_ID_SIZE 16
398 * define constants for device list query options
400 enum MR_PD_QUERY_TYPE {
401 MR_PD_QUERY_TYPE_ALL = 0,
402 MR_PD_QUERY_TYPE_STATE = 1,
403 MR_PD_QUERY_TYPE_POWER_STATE = 2,
404 MR_PD_QUERY_TYPE_MEDIA_TYPE = 3,
405 MR_PD_QUERY_TYPE_SPEED = 4,
406 MR_PD_QUERY_TYPE_EXPOSED_TO_HOST = 5,
409 enum MR_LD_QUERY_TYPE {
410 MR_LD_QUERY_TYPE_ALL = 0,
411 MR_LD_QUERY_TYPE_EXPOSED_TO_HOST = 1,
412 MR_LD_QUERY_TYPE_USED_TGT_IDS = 2,
413 MR_LD_QUERY_TYPE_CLUSTER_ACCESS = 3,
414 MR_LD_QUERY_TYPE_CLUSTER_LOCALE = 4,
418 #define MR_EVT_CFG_CLEARED 0x0004
419 #define MR_EVT_LD_STATE_CHANGE 0x0051
420 #define MR_EVT_PD_INSERTED 0x005b
421 #define MR_EVT_PD_REMOVED 0x0070
422 #define MR_EVT_LD_CREATED 0x008a
423 #define MR_EVT_LD_DELETED 0x008b
424 #define MR_EVT_FOREIGN_CFG_IMPORTED 0x00db
425 #define MR_EVT_LD_OFFLINE 0x00fc
426 #define MR_EVT_CTRL_HOST_BUS_SCAN_REQUESTED 0x0152
427 #define MR_EVT_CTRL_PROP_CHANGED 0x012f
430 MR_PD_STATE_UNCONFIGURED_GOOD = 0x00,
431 MR_PD_STATE_UNCONFIGURED_BAD = 0x01,
432 MR_PD_STATE_HOT_SPARE = 0x02,
433 MR_PD_STATE_OFFLINE = 0x10,
434 MR_PD_STATE_FAILED = 0x11,
435 MR_PD_STATE_REBUILD = 0x14,
436 MR_PD_STATE_ONLINE = 0x18,
437 MR_PD_STATE_COPYBACK = 0x20,
438 MR_PD_STATE_SYSTEM = 0x40,
450 * define the DDF Type bit structure
452 union MR_PD_DDF_TYPE {
456 #ifndef __BIG_ENDIAN_BITFIELD
485 * defines the progress structure
492 u16 elapsedSecsForLastPercent;
499 * defines the physical drive progress structure
501 struct MR_PD_PROGRESS {
503 #ifndef MFI_BIG_ENDIAN
521 union MR_PROGRESS rbld;
522 union MR_PROGRESS patrol;
524 union MR_PROGRESS clear;
525 union MR_PROGRESS erase;
529 #ifndef MFI_BIG_ENDIAN
546 union MR_PROGRESS reserved[3];
557 u8 connectedPortBitmap;
558 u8 connectedPortNumbers;
565 u32 lastPredFailEventSeqNum;
568 u8 disabledForRemoval;
570 union MR_PD_DDF_TYPE state;
574 #ifndef __BIG_ENDIAN_BITFIELD
577 u8 widePortCapable:1;
579 u8 widePortCapable:1;
584 u8 connectorIndex[2];
598 u8 enclConnectorIndex;
601 struct MR_PD_PROGRESS progInfo;
602 u8 badBlockTableFull;
603 u8 unusableInCurrentConfig;
608 u16 copyBackPartnerId;
609 u16 enclPartnerDeviceId;
611 #ifndef __BIG_ENDIAN_BITFIELD
632 u8 bridgeProductIdentification[16];
633 u8 bridgeProductRevisionLevel[4];
638 u8 emulatedBlockSize;
639 u16 userDataBlockSize;
643 #ifndef __BIG_ENDIAN_BITFIELD
649 u32 commissionedSpare:1;
650 u32 emergencySpare:1;
651 u32 ineligibleForSSCD:1;
652 u32 ineligibleForLd:1;
653 u32 useSSEraseType:1;
655 u32 supportScsiUnmap:1;
659 u32 supportScsiUnmap:1;
661 u32 useSSEraseType:1;
662 u32 ineligibleForLd:1;
663 u32 ineligibleForSSCD:1;
664 u32 emergencySpare:1;
665 u32 commissionedSpare:1;
674 u64 shieldDiagCompletionTime;
681 #ifndef __BIG_ENDIAN_BITFIELD
682 u32 bbmErrCountSupported:1;
686 u32 bbmErrCountSupported:1;
690 u8 reserved1[512-428];
694 * defines the physical drive address structure
696 struct MR_PD_ADDRESS {
707 u8 enclConnectorIndex;
712 u8 connectedPortBitmap;
713 u8 connectedPortNumbers;
719 * defines the physical drive list structure
724 struct MR_PD_ADDRESS addr[1];
727 struct megasas_pd_list {
735 * defines the logical drive reference structure
747 * defines the logical drive list structure
757 } ldList[MAX_LOGICAL_DRIVES_EXT];
760 struct MR_LD_TARGETID_LIST {
764 u8 targetId[MAX_LOGICAL_DRIVES_EXT];
769 * SAS controller properties
771 struct megasas_ctrl_prop {
774 u16 pred_fail_poll_interval;
775 u16 intr_throttle_count;
776 u16 intr_throttle_timeouts;
782 u8 cache_flush_interval;
788 u8 disable_auto_rebuild;
789 u8 disable_battery_warn;
791 u16 ecc_bucket_leak_rate;
792 u8 restore_hotspare_on_insertion;
793 u8 expose_encl_devices;
794 u8 maintainPdFailHistory;
795 u8 disallowHostRequestReordering;
798 u8 disableAutoDetectBackplane;
803 * Add properties that can be controlled by
804 * a bit in the following structure.
807 #if defined(__BIG_ENDIAN_BITFIELD)
810 u32 disableSpinDownHS:1;
811 u32 allowBootWithPinnedCache:1;
812 u32 disableOnlineCtrlReset:1;
813 u32 enableSecretKeyControl:1;
814 u32 autoEnhancedImport:1;
815 u32 enableSpinDownUnconfigured:1;
816 u32 SSDPatrolReadEnabled:1;
817 u32 SSDSMARTerEnabled:1;
820 u32 prCorrectUnconfiguredAreas:1;
821 u32 SMARTerEnabled:1;
822 u32 copyBackDisabled:1;
824 u32 copyBackDisabled:1;
825 u32 SMARTerEnabled:1;
826 u32 prCorrectUnconfiguredAreas:1;
829 u32 SSDSMARTerEnabled:1;
830 u32 SSDPatrolReadEnabled:1;
831 u32 enableSpinDownUnconfigured:1;
832 u32 autoEnhancedImport:1;
833 u32 enableSecretKeyControl:1;
834 u32 disableOnlineCtrlReset:1;
835 u32 allowBootWithPinnedCache:1;
836 u32 disableSpinDownHS:1;
848 * SAS controller information
850 struct megasas_ctrl_info {
853 * PCI device information
859 __le16 sub_vendor_id;
860 __le16 sub_device_id;
863 } __attribute__ ((packed)) pci;
866 * Host interface information
880 } __attribute__ ((packed)) host_interface;
883 * Device (backend) interface information
896 } __attribute__ ((packed)) device_interface;
899 * List of components residing in flash. All str are null terminated
901 __le32 image_check_word;
902 __le32 image_component_count;
911 } __attribute__ ((packed)) image_component[8];
914 * List of flash components that have been flashed on the card, but
915 * are not in use, pending reset of the adapter. This list will be
916 * empty if a flash operation has not occurred. All stings are null
919 __le32 pending_image_component_count;
928 } __attribute__ ((packed)) pending_image_component[8];
935 char product_name[80];
939 * Other physical/controller/operation information. Indicates the
940 * presence of the hardware
950 } __attribute__ ((packed)) hw_present;
952 __le32 current_fw_time;
955 * Maximum data transfer sizes
957 __le16 max_concurrent_cmds;
958 __le16 max_sge_count;
959 __le32 max_request_size;
962 * Logical and physical device counts
964 __le16 ld_present_count;
965 __le16 ld_degraded_count;
966 __le16 ld_offline_count;
968 __le16 pd_present_count;
969 __le16 pd_disk_present_count;
970 __le16 pd_disk_pred_failure_count;
971 __le16 pd_disk_failed_count;
974 * Memory size information
983 __le16 mem_correctable_error_count;
984 __le16 mem_uncorrectable_error_count;
987 * Cluster information
989 u8 cluster_permitted;
993 * Additional max data transfer sizes
995 __le16 max_strips_per_io;
998 * Controller capabilities structures
1005 u32 raid_level_1E:1;
1009 } __attribute__ ((packed)) raid_levels;
1018 u32 alarm_control:1;
1019 u32 cluster_supported:1;
1021 u32 spanning_allowed:1;
1022 u32 dedicated_hotspares:1;
1023 u32 revertible_hotspares:1;
1024 u32 foreign_config_import:1;
1025 u32 self_diagnostic:1;
1026 u32 mixed_redundancy_arr:1;
1027 u32 global_hot_spares:1;
1030 } __attribute__ ((packed)) adapter_operations;
1037 u32 access_policy:1;
1038 u32 disk_cache_policy:1;
1041 } __attribute__ ((packed)) ld_operations;
1049 } __attribute__ ((packed)) stripe_sz_ops;
1054 u32 force_offline:1;
1055 u32 force_rebuild:1;
1058 } __attribute__ ((packed)) pd_operations;
1062 u32 ctrl_supports_sas:1;
1063 u32 ctrl_supports_sata:1;
1064 u32 allow_mix_in_encl:1;
1065 u32 allow_mix_in_ld:1;
1066 u32 allow_sata_in_cluster:1;
1069 } __attribute__ ((packed)) pd_mix_support;
1072 * Define ECC single-bit-error bucket information
1074 u8 ecc_bucket_count;
1078 * Include the controller properties (changeable items)
1080 struct megasas_ctrl_prop properties;
1083 * Define FW pkg version (set in envt v'bles on OEM basis)
1085 char package_version[0x60];
1089 * If adapterOperations.supportMoreThan8Phys is set,
1090 * and deviceInterface.portCount is greater than 8,
1091 * SAS Addrs for first 8 ports shall be populated in
1092 * deviceInterface.portAddr, and the rest shall be
1093 * populated in deviceInterfacePortAddr2.
1095 __le64 deviceInterfacePortAddr2[8]; /*6a0h */
1096 u8 reserved3[128]; /*6e0h */
1099 u16 minPdRaidLevel_0:4;
1100 u16 maxPdRaidLevel_0:12;
1102 u16 minPdRaidLevel_1:4;
1103 u16 maxPdRaidLevel_1:12;
1105 u16 minPdRaidLevel_5:4;
1106 u16 maxPdRaidLevel_5:12;
1108 u16 minPdRaidLevel_1E:4;
1109 u16 maxPdRaidLevel_1E:12;
1111 u16 minPdRaidLevel_6:4;
1112 u16 maxPdRaidLevel_6:12;
1114 u16 minPdRaidLevel_10:4;
1115 u16 maxPdRaidLevel_10:12;
1117 u16 minPdRaidLevel_50:4;
1118 u16 maxPdRaidLevel_50:12;
1120 u16 minPdRaidLevel_60:4;
1121 u16 maxPdRaidLevel_60:12;
1123 u16 minPdRaidLevel_1E_RLQ0:4;
1124 u16 maxPdRaidLevel_1E_RLQ0:12;
1126 u16 minPdRaidLevel_1E0_RLQ0:4;
1127 u16 maxPdRaidLevel_1E0_RLQ0:12;
1132 __le16 maxPds; /*780h */
1133 __le16 maxDedHSPs; /*782h */
1134 __le16 maxGlobalHSP; /*784h */
1135 __le16 ddfSize; /*786h */
1136 u8 maxLdsPerArray; /*788h */
1137 u8 partitionsInDDF; /*789h */
1138 u8 lockKeyBinding; /*78ah */
1139 u8 maxPITsPerLd; /*78bh */
1140 u8 maxViewsPerLd; /*78ch */
1141 u8 maxTargetId; /*78dh */
1142 __le16 maxBvlVdSize; /*78eh */
1144 __le16 maxConfigurableSSCSize; /*790h */
1145 __le16 currentSSCsize; /*792h */
1147 char expanderFwVersion[12]; /*794h */
1149 __le16 PFKTrialTimeRemaining; /*7A0h */
1151 __le16 cacheMemorySize; /*7A2h */
1154 #if defined(__BIG_ENDIAN_BITFIELD)
1156 u32 activePassive:2;
1157 u32 supportConfigAutoBalance:1;
1159 u32 supportDataLDonSSCArray:1;
1160 u32 supportPointInTimeProgress:1;
1161 u32 supportUnevenSpans:1;
1162 u32 dedicatedHotSparesLimited:1;
1164 u32 supportEmulatedDrives:1;
1165 u32 supportResetNow:1;
1166 u32 realTimeScheduler:1;
1167 u32 supportSSDPatrolRead:1;
1168 u32 supportPerfTuning:1;
1169 u32 disableOnlinePFKChange:1;
1171 u32 supportBootTimePFKChange:1;
1172 u32 supportSetLinkSpeed:1;
1173 u32 supportEmergencySpares:1;
1174 u32 supportSuspendResumeBGops:1;
1175 u32 blockSSDWriteCacheChange:1;
1176 u32 supportShieldState:1;
1177 u32 supportLdBBMInfo:1;
1178 u32 supportLdPIType3:1;
1179 u32 supportLdPIType2:1;
1180 u32 supportLdPIType1:1;
1181 u32 supportPIcontroller:1;
1183 u32 supportPIcontroller:1;
1184 u32 supportLdPIType1:1;
1185 u32 supportLdPIType2:1;
1186 u32 supportLdPIType3:1;
1187 u32 supportLdBBMInfo:1;
1188 u32 supportShieldState:1;
1189 u32 blockSSDWriteCacheChange:1;
1190 u32 supportSuspendResumeBGops:1;
1191 u32 supportEmergencySpares:1;
1192 u32 supportSetLinkSpeed:1;
1193 u32 supportBootTimePFKChange:1;
1195 u32 disableOnlinePFKChange:1;
1196 u32 supportPerfTuning:1;
1197 u32 supportSSDPatrolRead:1;
1198 u32 realTimeScheduler:1;
1200 u32 supportResetNow:1;
1201 u32 supportEmulatedDrives:1;
1203 u32 dedicatedHotSparesLimited:1;
1206 u32 supportUnevenSpans:1;
1207 u32 supportPointInTimeProgress:1;
1208 u32 supportDataLDonSSCArray:1;
1210 u32 supportConfigAutoBalance:1;
1211 u32 activePassive:2;
1214 } adapterOperations2;
1216 u8 driverVersion[32]; /*7A8h */
1217 u8 maxDAPdCountSpinup60; /*7C8h */
1218 u8 temperatureROC; /*7C9h */
1219 u8 temperatureCtrl; /*7CAh */
1220 u8 reserved4; /*7CBh */
1221 __le16 maxConfigurablePds; /*7CCh */
1224 u8 reserved5[2]; /*0x7CDh */
1227 * HA cluster information
1230 #if defined(__BIG_ENDIAN_BITFIELD)
1233 u32 premiumFeatureMismatch:1;
1234 u32 ctrlPropIncompatible:1;
1235 u32 fwVersionMismatch:1;
1236 u32 hwIncompatible:1;
1237 u32 peerIsIncompatible:1;
1238 u32 peerIsPresent:1;
1240 u32 peerIsPresent:1;
1241 u32 peerIsIncompatible:1;
1242 u32 hwIncompatible:1;
1243 u32 fwVersionMismatch:1;
1244 u32 ctrlPropIncompatible:1;
1245 u32 premiumFeatureMismatch:1;
1251 char clusterId[MEGASAS_CLUSTER_ID_SIZE]; /*0x7D4 */
1253 u8 maxVFsSupported; /*0x7E4*/
1254 u8 numVFsEnabled; /*0x7E5*/
1255 u8 requestorId; /*0x7E6 0:PF, 1:VF1, 2:VF2*/
1256 u8 reserved; /*0x7E7*/
1260 #if defined(__BIG_ENDIAN_BITFIELD)
1262 u32 useSeqNumJbodFP:1;
1263 u32 supportExtendedSSCSize:1;
1264 u32 supportDiskCacheSettingForSysPDs:1;
1265 u32 supportCPLDUpdate:1;
1266 u32 supportTTYLogCompression:1;
1267 u32 discardCacheDuringLDDelete:1;
1268 u32 supportSecurityonJBOD:1;
1269 u32 supportCacheBypassModes:1;
1270 u32 supportDisableSESMonitoring:1;
1271 u32 supportForceFlash:1;
1272 u32 supportNVDRAM:1;
1273 u32 supportDrvActivityLEDSetting:1;
1274 u32 supportAllowedOpsforDrvRemoval:1;
1275 u32 supportHOQRebuild:1;
1276 u32 supportForceTo512e:1;
1277 u32 supportNVCacheErase:1;
1278 u32 supportDebugQueue:1;
1279 u32 supportSwZone:1;
1280 u32 supportCrashDump:1;
1281 u32 supportMaxExtLDs:1;
1282 u32 supportT10RebuildAssist:1;
1283 u32 supportDisableImmediateIO:1;
1284 u32 supportThermalPollInterval:1;
1285 u32 supportPersonalityChange:2;
1287 u32 supportPersonalityChange:2;
1288 u32 supportThermalPollInterval:1;
1289 u32 supportDisableImmediateIO:1;
1290 u32 supportT10RebuildAssist:1;
1291 u32 supportMaxExtLDs:1;
1292 u32 supportCrashDump:1;
1293 u32 supportSwZone:1;
1294 u32 supportDebugQueue:1;
1295 u32 supportNVCacheErase:1;
1296 u32 supportForceTo512e:1;
1297 u32 supportHOQRebuild:1;
1298 u32 supportAllowedOpsforDrvRemoval:1;
1299 u32 supportDrvActivityLEDSetting:1;
1300 u32 supportNVDRAM:1;
1301 u32 supportForceFlash:1;
1302 u32 supportDisableSESMonitoring:1;
1303 u32 supportCacheBypassModes:1;
1304 u32 supportSecurityonJBOD:1;
1305 u32 discardCacheDuringLDDelete:1;
1306 u32 supportTTYLogCompression:1;
1307 u32 supportCPLDUpdate:1;
1308 u32 supportDiskCacheSettingForSysPDs:1;
1309 u32 supportExtendedSSCSize:1;
1310 u32 useSeqNumJbodFP:1;
1313 } adapterOperations3;
1315 u8 pad[0x800-0x7EC];
1319 * ===============================
1320 * MegaRAID SAS driver definitions
1321 * ===============================
1323 #define MEGASAS_MAX_PD_CHANNELS 2
1324 #define MEGASAS_MAX_LD_CHANNELS 2
1325 #define MEGASAS_MAX_CHANNELS (MEGASAS_MAX_PD_CHANNELS + \
1326 MEGASAS_MAX_LD_CHANNELS)
1327 #define MEGASAS_MAX_DEV_PER_CHANNEL 128
1328 #define MEGASAS_DEFAULT_INIT_ID -1
1329 #define MEGASAS_MAX_LUN 8
1330 #define MEGASAS_DEFAULT_CMD_PER_LUN 256
1331 #define MEGASAS_MAX_PD (MEGASAS_MAX_PD_CHANNELS * \
1332 MEGASAS_MAX_DEV_PER_CHANNEL)
1333 #define MEGASAS_MAX_LD_IDS (MEGASAS_MAX_LD_CHANNELS * \
1334 MEGASAS_MAX_DEV_PER_CHANNEL)
1336 #define MEGASAS_MAX_SECTORS (2*1024)
1337 #define MEGASAS_MAX_SECTORS_IEEE (2*128)
1338 #define MEGASAS_DBG_LVL 1
1340 #define MEGASAS_FW_BUSY 1
1342 #define VD_EXT_DEBUG 0
1344 #define SCAN_PD_CHANNEL 0x1
1345 #define SCAN_VD_CHANNEL 0x2
1347 enum MR_SCSI_CMD_TYPE {
1348 READ_WRITE_LDIO = 0,
1349 NON_READ_WRITE_LDIO = 1,
1350 READ_WRITE_SYSPDIO = 2,
1351 NON_READ_WRITE_SYSPDIO = 3,
1354 enum DCMD_TIMEOUT_ACTION {
1360 enum FW_BOOT_CONTEXT {
1367 #define PTHRU_FRAME 1
1370 * When SCSI mid-layer calls driver's reset routine, driver waits for
1371 * MEGASAS_RESET_WAIT_TIME seconds for all outstanding IO to complete. Note
1372 * that the driver cannot _actually_ abort or reset pending commands. While
1373 * it is waiting for the commands to complete, it prints a diagnostic message
1374 * every MEGASAS_RESET_NOTICE_INTERVAL seconds
1376 #define MEGASAS_RESET_WAIT_TIME 180
1377 #define MEGASAS_INTERNAL_CMD_WAIT_TIME 180
1378 #define MEGASAS_RESET_NOTICE_INTERVAL 5
1379 #define MEGASAS_IOCTL_CMD 0
1380 #define MEGASAS_DEFAULT_CMD_TIMEOUT 90
1381 #define MEGASAS_THROTTLE_QUEUE_DEPTH 16
1382 #define MEGASAS_BLOCKED_CMD_TIMEOUT 60
1384 * FW reports the maximum of number of commands that it can accept (maximum
1385 * commands that can be outstanding) at any time. The driver must report a
1386 * lower number to the mid layer because it can issue a few internal commands
1387 * itself (E.g, AEN, abort cmd, IOCTLs etc). The number of commands it needs
1390 #define MEGASAS_INT_CMDS 32
1391 #define MEGASAS_SKINNY_INT_CMDS 5
1392 #define MEGASAS_FUSION_INTERNAL_CMDS 5
1393 #define MEGASAS_FUSION_IOCTL_CMDS 3
1394 #define MEGASAS_MFI_IOCTL_CMDS 27
1396 #define MEGASAS_MAX_MSIX_QUEUES 128
1398 * FW can accept both 32 and 64 bit SGLs. We want to allocate 32/64 bit
1399 * SGLs based on the size of dma_addr_t
1401 #define IS_DMA64 (sizeof(dma_addr_t) == 8)
1403 #define MFI_XSCALE_OMR0_CHANGE_INTERRUPT 0x00000001
1405 #define MFI_INTR_FLAG_REPLY_MESSAGE 0x00000001
1406 #define MFI_INTR_FLAG_FIRMWARE_STATE_CHANGE 0x00000002
1407 #define MFI_G2_OUTBOUND_DOORBELL_CHANGE_INTERRUPT 0x00000004
1409 #define MFI_OB_INTR_STATUS_MASK 0x00000002
1410 #define MFI_POLL_TIMEOUT_SECS 60
1411 #define MFI_IO_TIMEOUT_SECS 180
1412 #define MEGASAS_SRIOV_HEARTBEAT_INTERVAL_VF (5 * HZ)
1413 #define MEGASAS_OCR_SETTLE_TIME_VF (1000 * 30)
1414 #define MEGASAS_ROUTINE_WAIT_TIME_VF 300
1415 #define MFI_REPLY_1078_MESSAGE_INTERRUPT 0x80000000
1416 #define MFI_REPLY_GEN2_MESSAGE_INTERRUPT 0x00000001
1417 #define MFI_GEN2_ENABLE_INTERRUPT_MASK (0x00000001 | 0x00000004)
1418 #define MFI_REPLY_SKINNY_MESSAGE_INTERRUPT 0x40000000
1419 #define MFI_SKINNY_ENABLE_INTERRUPT_MASK (0x00000001)
1421 #define MFI_1068_PCSR_OFFSET 0x84
1422 #define MFI_1068_FW_HANDSHAKE_OFFSET 0x64
1423 #define MFI_1068_FW_READY 0xDDDD0000
1425 #define MR_MAX_REPLY_QUEUES_OFFSET 0X0000001F
1426 #define MR_MAX_REPLY_QUEUES_EXT_OFFSET 0X003FC000
1427 #define MR_MAX_REPLY_QUEUES_EXT_OFFSET_SHIFT 14
1428 #define MR_MAX_MSIX_REG_ARRAY 16
1429 #define MR_RDPQ_MODE_OFFSET 0X00800000
1431 * register set for both 1068 and 1078 controllers
1432 * structure extended for 1078 registers
1435 struct megasas_register_set {
1436 u32 doorbell; /*0000h*/
1437 u32 fusion_seq_offset; /*0004h*/
1438 u32 fusion_host_diag; /*0008h*/
1439 u32 reserved_01; /*000Ch*/
1441 u32 inbound_msg_0; /*0010h*/
1442 u32 inbound_msg_1; /*0014h*/
1443 u32 outbound_msg_0; /*0018h*/
1444 u32 outbound_msg_1; /*001Ch*/
1446 u32 inbound_doorbell; /*0020h*/
1447 u32 inbound_intr_status; /*0024h*/
1448 u32 inbound_intr_mask; /*0028h*/
1450 u32 outbound_doorbell; /*002Ch*/
1451 u32 outbound_intr_status; /*0030h*/
1452 u32 outbound_intr_mask; /*0034h*/
1454 u32 reserved_1[2]; /*0038h*/
1456 u32 inbound_queue_port; /*0040h*/
1457 u32 outbound_queue_port; /*0044h*/
1459 u32 reserved_2[9]; /*0048h*/
1460 u32 reply_post_host_index; /*006Ch*/
1461 u32 reserved_2_2[12]; /*0070h*/
1463 u32 outbound_doorbell_clear; /*00A0h*/
1465 u32 reserved_3[3]; /*00A4h*/
1467 u32 outbound_scratch_pad ; /*00B0h*/
1468 u32 outbound_scratch_pad_2; /*00B4h*/
1469 u32 outbound_scratch_pad_3; /*00B8h*/
1471 u32 reserved_4; /*00BCh*/
1473 u32 inbound_low_queue_port ; /*00C0h*/
1475 u32 inbound_high_queue_port ; /*00C4h*/
1477 u32 reserved_5; /*00C8h*/
1478 u32 res_6[11]; /*CCh*/
1481 u32 index_registers[807]; /*00CCh*/
1482 } __attribute__ ((packed));
1484 struct megasas_sge32 {
1489 } __attribute__ ((packed));
1491 struct megasas_sge64 {
1496 } __attribute__ ((packed));
1498 struct megasas_sge_skinny {
1506 struct megasas_sge32 sge32[1];
1507 struct megasas_sge64 sge64[1];
1508 struct megasas_sge_skinny sge_skinny[1];
1510 } __attribute__ ((packed));
1512 struct megasas_header {
1515 u8 sense_len; /*01h */
1516 u8 cmd_status; /*02h */
1517 u8 scsi_status; /*03h */
1519 u8 target_id; /*04h */
1521 u8 cdb_len; /*06h */
1522 u8 sge_count; /*07h */
1524 __le32 context; /*08h */
1525 __le32 pad_0; /*0Ch */
1527 __le16 flags; /*10h */
1528 __le16 timeout; /*12h */
1529 __le32 data_xferlen; /*14h */
1531 } __attribute__ ((packed));
1533 union megasas_sgl_frame {
1535 struct megasas_sge32 sge32[8];
1536 struct megasas_sge64 sge64[5];
1538 } __attribute__ ((packed));
1540 typedef union _MFI_CAPABILITIES {
1542 #if defined(__BIG_ENDIAN_BITFIELD)
1544 u32 support_qd_throttling:1;
1545 u32 support_fp_rlbypass:1;
1546 u32 support_vfid_in_ioframe:1;
1547 u32 support_ext_io_size:1;
1548 u32 support_ext_queue_depth:1;
1549 u32 security_protocol_cmds_fw:1;
1550 u32 support_core_affinity:1;
1551 u32 support_ndrive_r1_lb:1;
1552 u32 support_max_255lds:1;
1553 u32 support_fastpath_wb:1;
1554 u32 support_additional_msix:1;
1555 u32 support_fp_remote_lun:1;
1557 u32 support_fp_remote_lun:1;
1558 u32 support_additional_msix:1;
1559 u32 support_fastpath_wb:1;
1560 u32 support_max_255lds:1;
1561 u32 support_ndrive_r1_lb:1;
1562 u32 support_core_affinity:1;
1563 u32 security_protocol_cmds_fw:1;
1564 u32 support_ext_queue_depth:1;
1565 u32 support_ext_io_size:1;
1566 u32 support_vfid_in_ioframe:1;
1567 u32 support_fp_rlbypass:1;
1568 u32 support_qd_throttling:1;
1575 struct megasas_init_frame {
1578 u8 reserved_0; /*01h */
1579 u8 cmd_status; /*02h */
1581 u8 reserved_1; /*03h */
1582 MFI_CAPABILITIES driver_operations; /*04h*/
1584 __le32 context; /*08h */
1585 __le32 pad_0; /*0Ch */
1587 __le16 flags; /*10h */
1588 __le16 reserved_3; /*12h */
1589 __le32 data_xfer_len; /*14h */
1591 __le32 queue_info_new_phys_addr_lo; /*18h */
1592 __le32 queue_info_new_phys_addr_hi; /*1Ch */
1593 __le32 queue_info_old_phys_addr_lo; /*20h */
1594 __le32 queue_info_old_phys_addr_hi; /*24h */
1595 __le32 reserved_4[2]; /*28h */
1596 __le32 system_info_lo; /*30h */
1597 __le32 system_info_hi; /*34h */
1598 __le32 reserved_5[2]; /*38h */
1600 } __attribute__ ((packed));
1602 struct megasas_init_queue_info {
1604 __le32 init_flags; /*00h */
1605 __le32 reply_queue_entries; /*04h */
1607 __le32 reply_queue_start_phys_addr_lo; /*08h */
1608 __le32 reply_queue_start_phys_addr_hi; /*0Ch */
1609 __le32 producer_index_phys_addr_lo; /*10h */
1610 __le32 producer_index_phys_addr_hi; /*14h */
1611 __le32 consumer_index_phys_addr_lo; /*18h */
1612 __le32 consumer_index_phys_addr_hi; /*1Ch */
1614 } __attribute__ ((packed));
1616 struct megasas_io_frame {
1619 u8 sense_len; /*01h */
1620 u8 cmd_status; /*02h */
1621 u8 scsi_status; /*03h */
1623 u8 target_id; /*04h */
1624 u8 access_byte; /*05h */
1625 u8 reserved_0; /*06h */
1626 u8 sge_count; /*07h */
1628 __le32 context; /*08h */
1629 __le32 pad_0; /*0Ch */
1631 __le16 flags; /*10h */
1632 __le16 timeout; /*12h */
1633 __le32 lba_count; /*14h */
1635 __le32 sense_buf_phys_addr_lo; /*18h */
1636 __le32 sense_buf_phys_addr_hi; /*1Ch */
1638 __le32 start_lba_lo; /*20h */
1639 __le32 start_lba_hi; /*24h */
1641 union megasas_sgl sgl; /*28h */
1643 } __attribute__ ((packed));
1645 struct megasas_pthru_frame {
1648 u8 sense_len; /*01h */
1649 u8 cmd_status; /*02h */
1650 u8 scsi_status; /*03h */
1652 u8 target_id; /*04h */
1654 u8 cdb_len; /*06h */
1655 u8 sge_count; /*07h */
1657 __le32 context; /*08h */
1658 __le32 pad_0; /*0Ch */
1660 __le16 flags; /*10h */
1661 __le16 timeout; /*12h */
1662 __le32 data_xfer_len; /*14h */
1664 __le32 sense_buf_phys_addr_lo; /*18h */
1665 __le32 sense_buf_phys_addr_hi; /*1Ch */
1667 u8 cdb[16]; /*20h */
1668 union megasas_sgl sgl; /*30h */
1670 } __attribute__ ((packed));
1672 struct megasas_dcmd_frame {
1675 u8 reserved_0; /*01h */
1676 u8 cmd_status; /*02h */
1677 u8 reserved_1[4]; /*03h */
1678 u8 sge_count; /*07h */
1680 __le32 context; /*08h */
1681 __le32 pad_0; /*0Ch */
1683 __le16 flags; /*10h */
1684 __le16 timeout; /*12h */
1686 __le32 data_xfer_len; /*14h */
1687 __le32 opcode; /*18h */
1695 union megasas_sgl sgl; /*28h */
1697 } __attribute__ ((packed));
1699 struct megasas_abort_frame {
1702 u8 reserved_0; /*01h */
1703 u8 cmd_status; /*02h */
1705 u8 reserved_1; /*03h */
1706 __le32 reserved_2; /*04h */
1708 __le32 context; /*08h */
1709 __le32 pad_0; /*0Ch */
1711 __le16 flags; /*10h */
1712 __le16 reserved_3; /*12h */
1713 __le32 reserved_4; /*14h */
1715 __le32 abort_context; /*18h */
1716 __le32 pad_1; /*1Ch */
1718 __le32 abort_mfi_phys_addr_lo; /*20h */
1719 __le32 abort_mfi_phys_addr_hi; /*24h */
1721 __le32 reserved_5[6]; /*28h */
1723 } __attribute__ ((packed));
1725 struct megasas_smp_frame {
1728 u8 reserved_1; /*01h */
1729 u8 cmd_status; /*02h */
1730 u8 connection_status; /*03h */
1732 u8 reserved_2[3]; /*04h */
1733 u8 sge_count; /*07h */
1735 __le32 context; /*08h */
1736 __le32 pad_0; /*0Ch */
1738 __le16 flags; /*10h */
1739 __le16 timeout; /*12h */
1741 __le32 data_xfer_len; /*14h */
1742 __le64 sas_addr; /*18h */
1745 struct megasas_sge32 sge32[2]; /* [0]: resp [1]: req */
1746 struct megasas_sge64 sge64[2]; /* [0]: resp [1]: req */
1749 } __attribute__ ((packed));
1751 struct megasas_stp_frame {
1754 u8 reserved_1; /*01h */
1755 u8 cmd_status; /*02h */
1756 u8 reserved_2; /*03h */
1758 u8 target_id; /*04h */
1759 u8 reserved_3[2]; /*05h */
1760 u8 sge_count; /*07h */
1762 __le32 context; /*08h */
1763 __le32 pad_0; /*0Ch */
1765 __le16 flags; /*10h */
1766 __le16 timeout; /*12h */
1768 __le32 data_xfer_len; /*14h */
1770 __le16 fis[10]; /*18h */
1774 struct megasas_sge32 sge32[2]; /* [0]: resp [1]: data */
1775 struct megasas_sge64 sge64[2]; /* [0]: resp [1]: data */
1778 } __attribute__ ((packed));
1780 union megasas_frame {
1782 struct megasas_header hdr;
1783 struct megasas_init_frame init;
1784 struct megasas_io_frame io;
1785 struct megasas_pthru_frame pthru;
1786 struct megasas_dcmd_frame dcmd;
1787 struct megasas_abort_frame abort;
1788 struct megasas_smp_frame smp;
1789 struct megasas_stp_frame stp;
1795 * struct MR_PRIV_DEVICE - sdev private hostdata
1796 * @is_tm_capable: firmware managed tm_capable flag
1797 * @tm_busy: TM request is in progress
1799 struct MR_PRIV_DEVICE {
1805 union megasas_evt_class_locale {
1808 #ifndef __BIG_ENDIAN_BITFIELD
1817 } __attribute__ ((packed)) members;
1821 } __attribute__ ((packed));
1823 struct megasas_evt_log_info {
1824 __le32 newest_seq_num;
1825 __le32 oldest_seq_num;
1826 __le32 clear_seq_num;
1827 __le32 shutdown_seq_num;
1828 __le32 boot_seq_num;
1830 } __attribute__ ((packed));
1832 struct megasas_progress {
1835 __le16 elapsed_seconds;
1837 } __attribute__ ((packed));
1839 struct megasas_evtarg_ld {
1845 } __attribute__ ((packed));
1847 struct megasas_evtarg_pd {
1852 } __attribute__ ((packed));
1854 struct megasas_evt_detail {
1859 union megasas_evt_class_locale cl;
1865 struct megasas_evtarg_pd pd;
1871 } __attribute__ ((packed)) cdbSense;
1873 struct megasas_evtarg_ld ld;
1876 struct megasas_evtarg_ld ld;
1878 } __attribute__ ((packed)) ld_count;
1882 struct megasas_evtarg_ld ld;
1883 } __attribute__ ((packed)) ld_lba;
1886 struct megasas_evtarg_ld ld;
1889 } __attribute__ ((packed)) ld_owner;
1894 struct megasas_evtarg_ld ld;
1895 struct megasas_evtarg_pd pd;
1896 } __attribute__ ((packed)) ld_lba_pd_lba;
1899 struct megasas_evtarg_ld ld;
1900 struct megasas_progress prog;
1901 } __attribute__ ((packed)) ld_prog;
1904 struct megasas_evtarg_ld ld;
1907 } __attribute__ ((packed)) ld_state;
1911 struct megasas_evtarg_ld ld;
1912 } __attribute__ ((packed)) ld_strip;
1914 struct megasas_evtarg_pd pd;
1917 struct megasas_evtarg_pd pd;
1919 } __attribute__ ((packed)) pd_err;
1923 struct megasas_evtarg_pd pd;
1924 } __attribute__ ((packed)) pd_lba;
1928 struct megasas_evtarg_pd pd;
1929 struct megasas_evtarg_ld ld;
1930 } __attribute__ ((packed)) pd_lba_ld;
1933 struct megasas_evtarg_pd pd;
1934 struct megasas_progress prog;
1935 } __attribute__ ((packed)) pd_prog;
1938 struct megasas_evtarg_pd pd;
1941 } __attribute__ ((packed)) pd_state;
1948 } __attribute__ ((packed)) pci;
1956 } __attribute__ ((packed)) time;
1962 } __attribute__ ((packed)) ecc;
1970 char description[128];
1972 } __attribute__ ((packed));
1974 struct megasas_aen_event {
1975 struct delayed_work hotplug_work;
1976 struct megasas_instance *instance;
1979 struct megasas_irq_context {
1980 struct megasas_instance *instance;
1984 struct MR_DRV_SYSTEM_INFO {
2000 /* JBOD Queue depth definitions */
2001 #define MEGASAS_SATA_QD 32
2002 #define MEGASAS_SAS_QD 64
2003 #define MEGASAS_DEFAULT_PD_QD 64
2005 struct megasas_instance {
2008 dma_addr_t producer_h;
2010 dma_addr_t consumer_h;
2011 struct MR_DRV_SYSTEM_INFO *system_info_buf;
2012 dma_addr_t system_info_h;
2013 struct MR_LD_VF_AFFILIATION *vf_affiliation;
2014 dma_addr_t vf_affiliation_h;
2015 struct MR_LD_VF_AFFILIATION_111 *vf_affiliation_111;
2016 dma_addr_t vf_affiliation_111_h;
2017 struct MR_CTRL_HB_HOST_MEM *hb_host_mem;
2018 dma_addr_t hb_host_mem_h;
2019 struct MR_PD_INFO *pd_info;
2020 dma_addr_t pd_info_h;
2022 __le32 *reply_queue;
2023 dma_addr_t reply_queue_h;
2025 u32 *crash_dump_buf;
2026 dma_addr_t crash_dump_h;
2027 void *crash_buf[MAX_CRASH_DUMP_SIZE];
2028 u32 crash_buf_pages;
2029 unsigned int fw_crash_buffer_size;
2030 unsigned int fw_crash_state;
2031 unsigned int fw_crash_buffer_offset;
2034 u32 crash_dump_fw_support;
2035 u32 crash_dump_drv_support;
2036 u32 crash_dump_app_support;
2037 u32 secure_jbod_support;
2038 bool use_seqnum_jbod_fp; /* Added for PD sequence */
2039 spinlock_t crashdump_lock;
2041 struct megasas_register_set __iomem *reg_set;
2042 u32 __iomem *reply_post_host_index_addr[MR_MAX_MSIX_REG_ARRAY];
2043 struct megasas_pd_list pd_list[MEGASAS_MAX_PD];
2044 struct megasas_pd_list local_pd_list[MEGASAS_MAX_PD];
2045 u8 ld_ids[MEGASAS_MAX_LD_IDS];
2054 u32 max_sectors_per_req;
2055 struct megasas_aen_event *ev;
2057 struct megasas_cmd **cmd_list;
2058 struct list_head cmd_pool;
2059 /* used to sync fire the cmd to fw */
2060 spinlock_t mfi_pool_lock;
2061 /* used to sync fire the cmd to fw */
2062 spinlock_t hba_lock;
2063 /* used to synch producer, consumer ptrs in dpc */
2064 spinlock_t completion_lock;
2065 struct dma_pool *frame_dma_pool;
2066 struct dma_pool *sense_dma_pool;
2068 struct megasas_evt_detail *evt_detail;
2069 dma_addr_t evt_detail_h;
2070 struct megasas_cmd *aen_cmd;
2071 struct mutex hba_mutex;
2072 struct semaphore ioctl_sem;
2074 struct Scsi_Host *host;
2076 wait_queue_head_t int_cmd_wait_q;
2077 wait_queue_head_t abort_cmd_wait_q;
2079 struct pci_dev *pdev;
2081 u32 fw_support_ieee;
2083 atomic_t fw_outstanding;
2084 atomic_t ldio_outstanding;
2085 atomic_t fw_reset_no_pci_access;
2087 struct megasas_instance_template *instancet;
2088 struct tasklet_struct isr_tasklet;
2089 struct work_struct work_init;
2090 struct work_struct crash_init;
2096 u8 disableOnlineCtrlReset;
2097 u8 UnevenSpanSupport;
2101 u16 fw_supported_vd_count;
2102 u16 fw_supported_pd_count;
2104 u16 drv_supported_vd_count;
2105 u16 drv_supported_pd_count;
2107 atomic_t adprecovery;
2108 unsigned long last_time;
2112 struct list_head internal_reset_pending_q;
2114 /* Ptr to hba specific information */
2116 u32 ctrl_context_pages;
2117 struct megasas_ctrl_info *ctrl_info;
2118 unsigned int msix_vectors;
2119 struct msix_entry msixentry[MEGASAS_MAX_MSIX_QUEUES];
2120 struct megasas_irq_context irq_context[MEGASAS_MAX_MSIX_QUEUES];
2123 struct megasas_cmd *map_update_cmd;
2124 struct megasas_cmd *jbod_seq_cmd;
2127 struct mutex reset_mutex;
2128 struct timer_list sriov_heartbeat_timer;
2129 char skip_heartbeat_timer_del;
2132 char clusterId[MEGASAS_CLUSTER_ID_SIZE];
2135 u16 throttlequeuedepth;
2137 u16 max_chain_frame_sz;
2142 struct MR_LD_VF_MAP {
2144 union MR_LD_REF ref;
2150 struct MR_LD_VF_AFFILIATION {
2156 struct MR_LD_VF_MAP map[1];
2159 /* Plasma 1.11 FW backward compatibility structures */
2160 #define IOV_111_OFFSET 0x7CE
2161 #define MAX_VIRTUAL_FUNCTIONS 8
2162 #define MR_LD_ACCESS_HIDDEN 15
2171 struct MR_LD_VF_MAP_111 {
2174 u8 policy[MAX_VIRTUAL_FUNCTIONS];
2177 struct MR_LD_VF_AFFILIATION_111 {
2182 struct MR_LD_VF_MAP_111 map[MAX_LOGICAL_DRIVES];
2185 struct MR_CTRL_HB_HOST_MEM {
2187 u32 fwCounter; /* Firmware heart beat counter */
2189 u32 debugmode:1; /* 1=Firmware is in debug mode.
2190 Heart beat will not be updated. */
2194 u32 driverCounter; /* Driver heart beat counter. 0x20 */
2195 u32 reserved_driver[7];
2201 MEGASAS_HBA_OPERATIONAL = 0,
2202 MEGASAS_ADPRESET_SM_INFAULT = 1,
2203 MEGASAS_ADPRESET_SM_FW_RESET_SUCCESS = 2,
2204 MEGASAS_ADPRESET_SM_OPERATIONAL = 3,
2205 MEGASAS_HW_CRITICAL_ERROR = 4,
2206 MEGASAS_ADPRESET_SM_POLLING = 5,
2207 MEGASAS_ADPRESET_INPROG_SIGN = 0xDEADDEAD,
2210 struct megasas_instance_template {
2211 void (*fire_cmd)(struct megasas_instance *, dma_addr_t, \
2212 u32, struct megasas_register_set __iomem *);
2214 void (*enable_intr)(struct megasas_instance *);
2215 void (*disable_intr)(struct megasas_instance *);
2217 int (*clear_intr)(struct megasas_register_set __iomem *);
2219 u32 (*read_fw_status_reg)(struct megasas_register_set __iomem *);
2220 int (*adp_reset)(struct megasas_instance *, \
2221 struct megasas_register_set __iomem *);
2222 int (*check_reset)(struct megasas_instance *, \
2223 struct megasas_register_set __iomem *);
2224 irqreturn_t (*service_isr)(int irq, void *devp);
2225 void (*tasklet)(unsigned long);
2226 u32 (*init_adapter)(struct megasas_instance *);
2227 u32 (*build_and_issue_cmd) (struct megasas_instance *,
2228 struct scsi_cmnd *);
2229 int (*issue_dcmd)(struct megasas_instance *instance,
2230 struct megasas_cmd *cmd);
2233 #define MEGASAS_IS_LOGICAL(scp) \
2234 (scp->device->channel < MEGASAS_MAX_PD_CHANNELS) ? 0 : 1
2236 #define MEGASAS_DEV_INDEX(scp) \
2237 (((scp->device->channel % 2) * MEGASAS_MAX_DEV_PER_CHANNEL) + \
2240 #define MEGASAS_PD_INDEX(scp) \
2241 ((scp->device->channel * MEGASAS_MAX_DEV_PER_CHANNEL) + \
2244 struct megasas_cmd {
2246 union megasas_frame *frame;
2247 dma_addr_t frame_phys_addr;
2249 dma_addr_t sense_phys_addr;
2255 u8 retry_for_fw_reset;
2258 struct list_head list;
2259 struct scsi_cmnd *scmd;
2262 struct megasas_instance *instance;
2272 #define MAX_MGMT_ADAPTERS 1024
2273 #define MAX_IOCTL_SGE 16
2275 struct megasas_iocpacket {
2285 struct megasas_header hdr;
2288 struct iovec sgl[MAX_IOCTL_SGE];
2290 } __attribute__ ((packed));
2292 struct megasas_aen {
2296 u32 class_locale_word;
2297 } __attribute__ ((packed));
2299 #ifdef CONFIG_COMPAT
2300 struct compat_megasas_iocpacket {
2309 struct megasas_header hdr;
2311 struct compat_iovec sgl[MAX_IOCTL_SGE];
2312 } __attribute__ ((packed));
2314 #define MEGASAS_IOC_FIRMWARE32 _IOWR('M', 1, struct compat_megasas_iocpacket)
2317 #define MEGASAS_IOC_FIRMWARE _IOWR('M', 1, struct megasas_iocpacket)
2318 #define MEGASAS_IOC_GET_AEN _IOW('M', 3, struct megasas_aen)
2320 struct megasas_mgmt_info {
2323 struct megasas_instance *instance[MAX_MGMT_ADAPTERS];
2327 enum MEGASAS_OCR_CAUSE {
2329 SCSIIO_TIMEOUT_OCR = 1,
2330 MFI_IO_TIMEOUT_OCR = 2,
2333 enum DCMD_RETURN_STATUS {
2341 MR_BuildRaidContext(struct megasas_instance *instance,
2342 struct IO_REQUEST_INFO *io_info,
2343 struct RAID_CONTEXT *pRAID_Context,
2344 struct MR_DRV_RAID_MAP_ALL *map, u8 **raidLUN);
2345 u8 MR_TargetIdToLdGet(u32 ldTgtId, struct MR_DRV_RAID_MAP_ALL *map);
2346 struct MR_LD_RAID *MR_LdRaidGet(u32 ld, struct MR_DRV_RAID_MAP_ALL *map);
2347 u16 MR_ArPdGet(u32 ar, u32 arm, struct MR_DRV_RAID_MAP_ALL *map);
2348 u16 MR_LdSpanArrayGet(u32 ld, u32 span, struct MR_DRV_RAID_MAP_ALL *map);
2349 __le16 MR_PdDevHandleGet(u32 pd, struct MR_DRV_RAID_MAP_ALL *map);
2350 u16 MR_GetLDTgtId(u32 ld, struct MR_DRV_RAID_MAP_ALL *map);
2352 __le16 get_updated_dev_handle(struct megasas_instance *instance,
2353 struct LD_LOAD_BALANCE_INFO *lbInfo, struct IO_REQUEST_INFO *in_info);
2354 void mr_update_load_balance_params(struct MR_DRV_RAID_MAP_ALL *map,
2355 struct LD_LOAD_BALANCE_INFO *lbInfo);
2356 int megasas_get_ctrl_info(struct megasas_instance *instance);
2359 megasas_sync_pd_seq_num(struct megasas_instance *instance, bool pend);
2360 int megasas_set_crash_dump_params(struct megasas_instance *instance,
2361 u8 crash_buf_state);
2362 void megasas_free_host_crash_buffer(struct megasas_instance *instance);
2363 void megasas_fusion_crash_dump_wq(struct work_struct *work);
2365 void megasas_return_cmd_fusion(struct megasas_instance *instance,
2366 struct megasas_cmd_fusion *cmd);
2367 int megasas_issue_blocked_cmd(struct megasas_instance *instance,
2368 struct megasas_cmd *cmd, int timeout);
2369 void __megasas_return_cmd(struct megasas_instance *instance,
2370 struct megasas_cmd *cmd);
2372 void megasas_return_mfi_mpt_pthr(struct megasas_instance *instance,
2373 struct megasas_cmd *cmd_mfi, struct megasas_cmd_fusion *cmd_fusion);
2374 int megasas_cmd_type(struct scsi_cmnd *cmd);
2375 void megasas_setup_jbod_map(struct megasas_instance *instance);
2377 void megasas_update_sdev_properties(struct scsi_device *sdev);
2378 int megasas_reset_fusion(struct Scsi_Host *shost, int reason);
2379 int megasas_task_abort_fusion(struct scsi_cmnd *scmd);
2380 int megasas_reset_target_fusion(struct scsi_cmnd *scmd);
2381 #endif /*LSI_MEGARAID_SAS_H */