1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 *  Linux MegaRAID driver for SAS based RAID controllers
4 *
5 *  Copyright (c) 2003-2013  LSI Corporation
6 *  Copyright (c) 2013-2016  Avago Technologies
7 *  Copyright (c) 2016-2018  Broadcom Inc.
8 *
9 *  FILE: megaraid_sas.h
10 *
11 *  Authors: Broadcom Inc.
12 *           Kashyap Desai <kashyap.desai@broadcom.com>
13 *           Sumit Saxena <sumit.saxena@broadcom.com>
14 *
15 *  Send feedback to: megaraidlinux.pdl@broadcom.com
16 */
17
18#ifndef LSI_MEGARAID_SAS_H
19#define LSI_MEGARAID_SAS_H
20
21/*
22 * MegaRAID SAS Driver meta data
23 */
24#define MEGASAS_VERSION				"07.714.04.00-rc1"
25#define MEGASAS_RELDATE				"Apr 14, 2020"
26
27#define MEGASAS_MSIX_NAME_LEN			32
28
29/*
30 * Device IDs
31 */
32#define	PCI_DEVICE_ID_LSI_SAS1078R		0x0060
33#define	PCI_DEVICE_ID_LSI_SAS1078DE		0x007C
34#define	PCI_DEVICE_ID_LSI_VERDE_ZCR		0x0413
35#define	PCI_DEVICE_ID_LSI_SAS1078GEN2		0x0078
36#define	PCI_DEVICE_ID_LSI_SAS0079GEN2		0x0079
37#define	PCI_DEVICE_ID_LSI_SAS0073SKINNY		0x0073
38#define	PCI_DEVICE_ID_LSI_SAS0071SKINNY		0x0071
39#define	PCI_DEVICE_ID_LSI_FUSION		0x005b
40#define PCI_DEVICE_ID_LSI_PLASMA		0x002f
41#define PCI_DEVICE_ID_LSI_INVADER		0x005d
42#define PCI_DEVICE_ID_LSI_FURY			0x005f
43#define PCI_DEVICE_ID_LSI_INTRUDER		0x00ce
44#define PCI_DEVICE_ID_LSI_INTRUDER_24		0x00cf
45#define PCI_DEVICE_ID_LSI_CUTLASS_52		0x0052
46#define PCI_DEVICE_ID_LSI_CUTLASS_53		0x0053
47#define PCI_DEVICE_ID_LSI_VENTURA		    0x0014
48#define PCI_DEVICE_ID_LSI_CRUSADER		    0x0015
49#define PCI_DEVICE_ID_LSI_HARPOON		    0x0016
50#define PCI_DEVICE_ID_LSI_TOMCAT		    0x0017
51#define PCI_DEVICE_ID_LSI_VENTURA_4PORT		0x001B
52#define PCI_DEVICE_ID_LSI_CRUSADER_4PORT	0x001C
53#define PCI_DEVICE_ID_LSI_AERO_10E1		0x10e1
54#define PCI_DEVICE_ID_LSI_AERO_10E2		0x10e2
55#define PCI_DEVICE_ID_LSI_AERO_10E5		0x10e5
56#define PCI_DEVICE_ID_LSI_AERO_10E6		0x10e6
57#define PCI_DEVICE_ID_LSI_AERO_10E0		0x10e0
58#define PCI_DEVICE_ID_LSI_AERO_10E3		0x10e3
59#define PCI_DEVICE_ID_LSI_AERO_10E4		0x10e4
60#define PCI_DEVICE_ID_LSI_AERO_10E7		0x10e7
61
62/*
63 * Intel HBA SSDIDs
64 */
65#define MEGARAID_INTEL_RS3DC080_SSDID		0x9360
66#define MEGARAID_INTEL_RS3DC040_SSDID		0x9362
67#define MEGARAID_INTEL_RS3SC008_SSDID		0x9380
68#define MEGARAID_INTEL_RS3MC044_SSDID		0x9381
69#define MEGARAID_INTEL_RS3WC080_SSDID		0x9341
70#define MEGARAID_INTEL_RS3WC040_SSDID		0x9343
71#define MEGARAID_INTEL_RMS3BC160_SSDID		0x352B
72
73/*
74 * Intruder HBA SSDIDs
75 */
76#define MEGARAID_INTRUDER_SSDID1		0x9371
77#define MEGARAID_INTRUDER_SSDID2		0x9390
78#define MEGARAID_INTRUDER_SSDID3		0x9370
79
80/*
81 * Intel HBA branding
82 */
83#define MEGARAID_INTEL_RS3DC080_BRANDING	\
84	"Intel(R) RAID Controller RS3DC080"
85#define MEGARAID_INTEL_RS3DC040_BRANDING	\
86	"Intel(R) RAID Controller RS3DC040"
87#define MEGARAID_INTEL_RS3SC008_BRANDING	\
88	"Intel(R) RAID Controller RS3SC008"
89#define MEGARAID_INTEL_RS3MC044_BRANDING	\
90	"Intel(R) RAID Controller RS3MC044"
91#define MEGARAID_INTEL_RS3WC080_BRANDING	\
92	"Intel(R) RAID Controller RS3WC080"
93#define MEGARAID_INTEL_RS3WC040_BRANDING	\
94	"Intel(R) RAID Controller RS3WC040"
95#define MEGARAID_INTEL_RMS3BC160_BRANDING	\
96	"Intel(R) Integrated RAID Module RMS3BC160"
97
98/*
99 * =====================================
100 * MegaRAID SAS MFI firmware definitions
101 * =====================================
102 */
103
104/*
105 * MFI stands for  MegaRAID SAS FW Interface. This is just a moniker for
106 * protocol between the software and firmware. Commands are issued using
107 * "message frames"
108 */
109
110/*
111 * FW posts its state in upper 4 bits of outbound_msg_0 register
112 */
113#define MFI_STATE_MASK				0xF0000000
114#define MFI_STATE_UNDEFINED			0x00000000
115#define MFI_STATE_BB_INIT			0x10000000
116#define MFI_STATE_FW_INIT			0x40000000
117#define MFI_STATE_WAIT_HANDSHAKE		0x60000000
118#define MFI_STATE_FW_INIT_2			0x70000000
119#define MFI_STATE_DEVICE_SCAN			0x80000000
120#define MFI_STATE_BOOT_MESSAGE_PENDING		0x90000000
121#define MFI_STATE_FLUSH_CACHE			0xA0000000
122#define MFI_STATE_READY				0xB0000000
123#define MFI_STATE_OPERATIONAL			0xC0000000
124#define MFI_STATE_FAULT				0xF0000000
125#define MFI_STATE_FORCE_OCR			0x00000080
126#define MFI_STATE_DMADONE			0x00000008
127#define MFI_STATE_CRASH_DUMP_DONE		0x00000004
128#define MFI_RESET_REQUIRED			0x00000001
129#define MFI_RESET_ADAPTER			0x00000002
130#define MEGAMFI_FRAME_SIZE			64
131
132#define MFI_STATE_FAULT_CODE			0x0FFF0000
133#define MFI_STATE_FAULT_SUBCODE			0x0000FF00
134/*
135 * During FW init, clear pending cmds & reset state using inbound_msg_0
136 *
137 * ABORT	: Abort all pending cmds
138 * READY	: Move from OPERATIONAL to READY state; discard queue info
139 * MFIMODE	: Discard (possible) low MFA posted in 64-bit mode (??)
140 * CLR_HANDSHAKE: FW is waiting for HANDSHAKE from BIOS or Driver
141 * HOTPLUG	: Resume from Hotplug
142 * MFI_STOP_ADP	: Send signal to FW to stop processing
143 * MFI_ADP_TRIGGER_SNAP_DUMP: Inform firmware to initiate snap dump
144 */
145#define WRITE_SEQUENCE_OFFSET		(0x0000000FC) /* I20 */
146#define HOST_DIAGNOSTIC_OFFSET		(0x000000F8)  /* I20 */
147#define DIAG_WRITE_ENABLE			(0x00000080)
148#define DIAG_RESET_ADAPTER			(0x00000004)
149
150#define MFI_ADP_RESET				0x00000040
151#define MFI_INIT_ABORT				0x00000001
152#define MFI_INIT_READY				0x00000002
153#define MFI_INIT_MFIMODE			0x00000004
154#define MFI_INIT_CLEAR_HANDSHAKE		0x00000008
155#define MFI_INIT_HOTPLUG			0x00000010
156#define MFI_STOP_ADP				0x00000020
157#define MFI_RESET_FLAGS				MFI_INIT_READY| \
158						MFI_INIT_MFIMODE| \
159						MFI_INIT_ABORT
160#define MFI_ADP_TRIGGER_SNAP_DUMP		0x00000100
161#define MPI2_IOCINIT_MSGFLAG_RDPQ_ARRAY_MODE    (0x01)
162
163/*
164 * MFI frame flags
165 */
166#define MFI_FRAME_POST_IN_REPLY_QUEUE		0x0000
167#define MFI_FRAME_DONT_POST_IN_REPLY_QUEUE	0x0001
168#define MFI_FRAME_SGL32				0x0000
169#define MFI_FRAME_SGL64				0x0002
170#define MFI_FRAME_SENSE32			0x0000
171#define MFI_FRAME_SENSE64			0x0004
172#define MFI_FRAME_DIR_NONE			0x0000
173#define MFI_FRAME_DIR_WRITE			0x0008
174#define MFI_FRAME_DIR_READ			0x0010
175#define MFI_FRAME_DIR_BOTH			0x0018
176#define MFI_FRAME_IEEE                          0x0020
177
178/* Driver internal */
179#define DRV_DCMD_POLLED_MODE		0x1
180#define DRV_DCMD_SKIP_REFIRE		0x2
181
182/*
183 * Definition for cmd_status
184 */
185#define MFI_CMD_STATUS_POLL_MODE		0xFF
186
187/*
188 * MFI command opcodes
189 */
190enum MFI_CMD_OP {
191	MFI_CMD_INIT		= 0x0,
192	MFI_CMD_LD_READ		= 0x1,
193	MFI_CMD_LD_WRITE	= 0x2,
194	MFI_CMD_LD_SCSI_IO	= 0x3,
195	MFI_CMD_PD_SCSI_IO	= 0x4,
196	MFI_CMD_DCMD		= 0x5,
197	MFI_CMD_ABORT		= 0x6,
198	MFI_CMD_SMP		= 0x7,
199	MFI_CMD_STP		= 0x8,
200	MFI_CMD_NVME		= 0x9,
201	MFI_CMD_TOOLBOX		= 0xa,
202	MFI_CMD_OP_COUNT,
203	MFI_CMD_INVALID		= 0xff
204};
205
206#define MR_DCMD_CTRL_GET_INFO			0x01010000
207#define MR_DCMD_LD_GET_LIST			0x03010000
208#define MR_DCMD_LD_LIST_QUERY			0x03010100
209
210#define MR_DCMD_CTRL_CACHE_FLUSH		0x01101000
211#define MR_FLUSH_CTRL_CACHE			0x01
212#define MR_FLUSH_DISK_CACHE			0x02
213
214#define MR_DCMD_CTRL_SHUTDOWN			0x01050000
215#define MR_DCMD_HIBERNATE_SHUTDOWN		0x01060000
216#define MR_ENABLE_DRIVE_SPINDOWN		0x01
217
218#define MR_DCMD_CTRL_EVENT_GET_INFO		0x01040100
219#define MR_DCMD_CTRL_EVENT_GET			0x01040300
220#define MR_DCMD_CTRL_EVENT_WAIT			0x01040500
221#define MR_DCMD_LD_GET_PROPERTIES		0x03030000
222
223#define MR_DCMD_CLUSTER				0x08000000
224#define MR_DCMD_CLUSTER_RESET_ALL		0x08010100
225#define MR_DCMD_CLUSTER_RESET_LD		0x08010200
226#define MR_DCMD_PD_LIST_QUERY                   0x02010100
227
228#define MR_DCMD_CTRL_SET_CRASH_DUMP_PARAMS	0x01190100
229#define MR_DRIVER_SET_APP_CRASHDUMP_MODE	(0xF0010000 | 0x0600)
230#define MR_DCMD_PD_GET_INFO			0x02020000
231
232/*
233 * Global functions
234 */
235extern u8 MR_ValidateMapInfo(struct megasas_instance *instance, u64 map_id);
236
237
238/*
239 * MFI command completion codes
240 */
241enum MFI_STAT {
242	MFI_STAT_OK = 0x00,
243	MFI_STAT_INVALID_CMD = 0x01,
244	MFI_STAT_INVALID_DCMD = 0x02,
245	MFI_STAT_INVALID_PARAMETER = 0x03,
246	MFI_STAT_INVALID_SEQUENCE_NUMBER = 0x04,
247	MFI_STAT_ABORT_NOT_POSSIBLE = 0x05,
248	MFI_STAT_APP_HOST_CODE_NOT_FOUND = 0x06,
249	MFI_STAT_APP_IN_USE = 0x07,
250	MFI_STAT_APP_NOT_INITIALIZED = 0x08,
251	MFI_STAT_ARRAY_INDEX_INVALID = 0x09,
252	MFI_STAT_ARRAY_ROW_NOT_EMPTY = 0x0a,
253	MFI_STAT_CONFIG_RESOURCE_CONFLICT = 0x0b,
254	MFI_STAT_DEVICE_NOT_FOUND = 0x0c,
255	MFI_STAT_DRIVE_TOO_SMALL = 0x0d,
256	MFI_STAT_FLASH_ALLOC_FAIL = 0x0e,
257	MFI_STAT_FLASH_BUSY = 0x0f,
258	MFI_STAT_FLASH_ERROR = 0x10,
259	MFI_STAT_FLASH_IMAGE_BAD = 0x11,
260	MFI_STAT_FLASH_IMAGE_INCOMPLETE = 0x12,
261	MFI_STAT_FLASH_NOT_OPEN = 0x13,
262	MFI_STAT_FLASH_NOT_STARTED = 0x14,
263	MFI_STAT_FLUSH_FAILED = 0x15,
264	MFI_STAT_HOST_CODE_NOT_FOUNT = 0x16,
265	MFI_STAT_LD_CC_IN_PROGRESS = 0x17,
266	MFI_STAT_LD_INIT_IN_PROGRESS = 0x18,
267	MFI_STAT_LD_LBA_OUT_OF_RANGE = 0x19,
268	MFI_STAT_LD_MAX_CONFIGURED = 0x1a,
269	MFI_STAT_LD_NOT_OPTIMAL = 0x1b,
270	MFI_STAT_LD_RBLD_IN_PROGRESS = 0x1c,
271	MFI_STAT_LD_RECON_IN_PROGRESS = 0x1d,
272	MFI_STAT_LD_WRONG_RAID_LEVEL = 0x1e,
273	MFI_STAT_MAX_SPARES_EXCEEDED = 0x1f,
274	MFI_STAT_MEMORY_NOT_AVAILABLE = 0x20,
275	MFI_STAT_MFC_HW_ERROR = 0x21,
276	MFI_STAT_NO_HW_PRESENT = 0x22,
277	MFI_STAT_NOT_FOUND = 0x23,
278	MFI_STAT_NOT_IN_ENCL = 0x24,
279	MFI_STAT_PD_CLEAR_IN_PROGRESS = 0x25,
280	MFI_STAT_PD_TYPE_WRONG = 0x26,
281	MFI_STAT_PR_DISABLED = 0x27,
282	MFI_STAT_ROW_INDEX_INVALID = 0x28,
283	MFI_STAT_SAS_CONFIG_INVALID_ACTION = 0x29,
284	MFI_STAT_SAS_CONFIG_INVALID_DATA = 0x2a,
285	MFI_STAT_SAS_CONFIG_INVALID_PAGE = 0x2b,
286	MFI_STAT_SAS_CONFIG_INVALID_TYPE = 0x2c,
287	MFI_STAT_SCSI_DONE_WITH_ERROR = 0x2d,
288	MFI_STAT_SCSI_IO_FAILED = 0x2e,
289	MFI_STAT_SCSI_RESERVATION_CONFLICT = 0x2f,
290	MFI_STAT_SHUTDOWN_FAILED = 0x30,
291	MFI_STAT_TIME_NOT_SET = 0x31,
292	MFI_STAT_WRONG_STATE = 0x32,
293	MFI_STAT_LD_OFFLINE = 0x33,
294	MFI_STAT_PEER_NOTIFICATION_REJECTED = 0x34,
295	MFI_STAT_PEER_NOTIFICATION_FAILED = 0x35,
296	MFI_STAT_RESERVATION_IN_PROGRESS = 0x36,
297	MFI_STAT_I2C_ERRORS_DETECTED = 0x37,
298	MFI_STAT_PCI_ERRORS_DETECTED = 0x38,
299	MFI_STAT_CONFIG_SEQ_MISMATCH = 0x67,
300
301	MFI_STAT_INVALID_STATUS = 0xFF
302};
303
304enum mfi_evt_class {
305	MFI_EVT_CLASS_DEBUG =		-2,
306	MFI_EVT_CLASS_PROGRESS =	-1,
307	MFI_EVT_CLASS_INFO =		0,
308	MFI_EVT_CLASS_WARNING =		1,
309	MFI_EVT_CLASS_CRITICAL =	2,
310	MFI_EVT_CLASS_FATAL =		3,
311	MFI_EVT_CLASS_DEAD =		4
312};
313
314/*
315 * Crash dump related defines
316 */
317#define MAX_CRASH_DUMP_SIZE 512
318#define CRASH_DMA_BUF_SIZE  (1024 * 1024)
319
320enum MR_FW_CRASH_DUMP_STATE {
321	UNAVAILABLE = 0,
322	AVAILABLE = 1,
323	COPYING = 2,
324	COPIED = 3,
325	COPY_ERROR = 4,
326};
327
328enum _MR_CRASH_BUF_STATUS {
329	MR_CRASH_BUF_TURN_OFF = 0,
330	MR_CRASH_BUF_TURN_ON = 1,
331};
332
333/*
334 * Number of mailbox bytes in DCMD message frame
335 */
336#define MFI_MBOX_SIZE				12
337
338enum MR_EVT_CLASS {
339
340	MR_EVT_CLASS_DEBUG = -2,
341	MR_EVT_CLASS_PROGRESS = -1,
342	MR_EVT_CLASS_INFO = 0,
343	MR_EVT_CLASS_WARNING = 1,
344	MR_EVT_CLASS_CRITICAL = 2,
345	MR_EVT_CLASS_FATAL = 3,
346	MR_EVT_CLASS_DEAD = 4,
347
348};
349
350enum MR_EVT_LOCALE {
351
352	MR_EVT_LOCALE_LD = 0x0001,
353	MR_EVT_LOCALE_PD = 0x0002,
354	MR_EVT_LOCALE_ENCL = 0x0004,
355	MR_EVT_LOCALE_BBU = 0x0008,
356	MR_EVT_LOCALE_SAS = 0x0010,
357	MR_EVT_LOCALE_CTRL = 0x0020,
358	MR_EVT_LOCALE_CONFIG = 0x0040,
359	MR_EVT_LOCALE_CLUSTER = 0x0080,
360	MR_EVT_LOCALE_ALL = 0xffff,
361
362};
363
364enum MR_EVT_ARGS {
365
366	MR_EVT_ARGS_NONE,
367	MR_EVT_ARGS_CDB_SENSE,
368	MR_EVT_ARGS_LD,
369	MR_EVT_ARGS_LD_COUNT,
370	MR_EVT_ARGS_LD_LBA,
371	MR_EVT_ARGS_LD_OWNER,
372	MR_EVT_ARGS_LD_LBA_PD_LBA,
373	MR_EVT_ARGS_LD_PROG,
374	MR_EVT_ARGS_LD_STATE,
375	MR_EVT_ARGS_LD_STRIP,
376	MR_EVT_ARGS_PD,
377	MR_EVT_ARGS_PD_ERR,
378	MR_EVT_ARGS_PD_LBA,
379	MR_EVT_ARGS_PD_LBA_LD,
380	MR_EVT_ARGS_PD_PROG,
381	MR_EVT_ARGS_PD_STATE,
382	MR_EVT_ARGS_PCI,
383	MR_EVT_ARGS_RATE,
384	MR_EVT_ARGS_STR,
385	MR_EVT_ARGS_TIME,
386	MR_EVT_ARGS_ECC,
387	MR_EVT_ARGS_LD_PROP,
388	MR_EVT_ARGS_PD_SPARE,
389	MR_EVT_ARGS_PD_INDEX,
390	MR_EVT_ARGS_DIAG_PASS,
391	MR_EVT_ARGS_DIAG_FAIL,
392	MR_EVT_ARGS_PD_LBA_LBA,
393	MR_EVT_ARGS_PORT_PHY,
394	MR_EVT_ARGS_PD_MISSING,
395	MR_EVT_ARGS_PD_ADDRESS,
396	MR_EVT_ARGS_BITMAP,
397	MR_EVT_ARGS_CONNECTOR,
398	MR_EVT_ARGS_PD_PD,
399	MR_EVT_ARGS_PD_FRU,
400	MR_EVT_ARGS_PD_PATHINFO,
401	MR_EVT_ARGS_PD_POWER_STATE,
402	MR_EVT_ARGS_GENERIC,
403};
404
405
406#define SGE_BUFFER_SIZE	4096
407#define MEGASAS_CLUSTER_ID_SIZE	16
408/*
409 * define constants for device list query options
410 */
411enum MR_PD_QUERY_TYPE {
412	MR_PD_QUERY_TYPE_ALL                = 0,
413	MR_PD_QUERY_TYPE_STATE              = 1,
414	MR_PD_QUERY_TYPE_POWER_STATE        = 2,
415	MR_PD_QUERY_TYPE_MEDIA_TYPE         = 3,
416	MR_PD_QUERY_TYPE_SPEED              = 4,
417	MR_PD_QUERY_TYPE_EXPOSED_TO_HOST    = 5,
418};
419
420enum MR_LD_QUERY_TYPE {
421	MR_LD_QUERY_TYPE_ALL	         = 0,
422	MR_LD_QUERY_TYPE_EXPOSED_TO_HOST = 1,
423	MR_LD_QUERY_TYPE_USED_TGT_IDS    = 2,
424	MR_LD_QUERY_TYPE_CLUSTER_ACCESS  = 3,
425	MR_LD_QUERY_TYPE_CLUSTER_LOCALE  = 4,
426};
427
428
429#define MR_EVT_CFG_CLEARED                              0x0004
430#define MR_EVT_LD_STATE_CHANGE                          0x0051
431#define MR_EVT_PD_INSERTED                              0x005b
432#define MR_EVT_PD_REMOVED                               0x0070
433#define MR_EVT_LD_CREATED                               0x008a
434#define MR_EVT_LD_DELETED                               0x008b
435#define MR_EVT_FOREIGN_CFG_IMPORTED                     0x00db
436#define MR_EVT_LD_OFFLINE                               0x00fc
437#define MR_EVT_CTRL_HOST_BUS_SCAN_REQUESTED             0x0152
438#define MR_EVT_CTRL_PROP_CHANGED			0x012f
439
440enum MR_PD_STATE {
441	MR_PD_STATE_UNCONFIGURED_GOOD   = 0x00,
442	MR_PD_STATE_UNCONFIGURED_BAD    = 0x01,
443	MR_PD_STATE_HOT_SPARE           = 0x02,
444	MR_PD_STATE_OFFLINE             = 0x10,
445	MR_PD_STATE_FAILED              = 0x11,
446	MR_PD_STATE_REBUILD             = 0x14,
447	MR_PD_STATE_ONLINE              = 0x18,
448	MR_PD_STATE_COPYBACK            = 0x20,
449	MR_PD_STATE_SYSTEM              = 0x40,
450 };
451
452union MR_PD_REF {
453	struct {
454		u16	 deviceId;
455		u16	 seqNum;
456	} mrPdRef;
457	u32	 ref;
458};
459
460/*
461 * define the DDF Type bit structure
462 */
463union MR_PD_DDF_TYPE {
464	 struct {
465		union {
466			struct {
467#ifndef __BIG_ENDIAN_BITFIELD
468				 u16	 forcedPDGUID:1;
469				 u16	 inVD:1;
470				 u16	 isGlobalSpare:1;
471				 u16	 isSpare:1;
472				 u16	 isForeign:1;
473				 u16	 reserved:7;
474				 u16	 intf:4;
475#else
476				 u16	 intf:4;
477				 u16	 reserved:7;
478				 u16	 isForeign:1;
479				 u16	 isSpare:1;
480				 u16	 isGlobalSpare:1;
481				 u16	 inVD:1;
482				 u16	 forcedPDGUID:1;
483#endif
484			 } pdType;
485			 u16	 type;
486		 };
487		 u16	 reserved;
488	 } ddf;
489	 struct {
490		 u32	reserved;
491	 } nonDisk;
492	 u32	 type;
493} __packed;
494
495/*
496 * defines the progress structure
497 */
498union MR_PROGRESS {
499	struct  {
500		u16 progress;
501		union {
502			u16 elapsedSecs;
503			u16 elapsedSecsForLastPercent;
504		};
505	} mrProgress;
506	u32 w;
507} __packed;
508
509/*
510 * defines the physical drive progress structure
511 */
512struct MR_PD_PROGRESS {
513	struct {
514#ifndef __BIG_ENDIAN_BITFIELD
515		u32     rbld:1;
516		u32     patrol:1;
517		u32     clear:1;
518		u32     copyBack:1;
519		u32     erase:1;
520		u32     locate:1;
521		u32     reserved:26;
522#else
523		u32     reserved:26;
524		u32     locate:1;
525		u32     erase:1;
526		u32     copyBack:1;
527		u32     clear:1;
528		u32     patrol:1;
529		u32     rbld:1;
530#endif
531	} active;
532	union MR_PROGRESS     rbld;
533	union MR_PROGRESS     patrol;
534	union {
535		union MR_PROGRESS     clear;
536		union MR_PROGRESS     erase;
537	};
538
539	struct {
540#ifndef __BIG_ENDIAN_BITFIELD
541		u32     rbld:1;
542		u32     patrol:1;
543		u32     clear:1;
544		u32     copyBack:1;
545		u32     erase:1;
546		u32     reserved:27;
547#else
548		u32     reserved:27;
549		u32     erase:1;
550		u32     copyBack:1;
551		u32     clear:1;
552		u32     patrol:1;
553		u32     rbld:1;
554#endif
555	} pause;
556
557	union MR_PROGRESS     reserved[3];
558} __packed;
559
560struct  MR_PD_INFO {
561	union MR_PD_REF	ref;
562	u8 inquiryData[96];
563	u8 vpdPage83[64];
564	u8 notSupported;
565	u8 scsiDevType;
566
567	union {
568		u8 connectedPortBitmap;
569		u8 connectedPortNumbers;
570	};
571
572	u8 deviceSpeed;
573	u32 mediaErrCount;
574	u32 otherErrCount;
575	u32 predFailCount;
576	u32 lastPredFailEventSeqNum;
577
578	u16 fwState;
579	u8 disabledForRemoval;
580	u8 linkSpeed;
581	union MR_PD_DDF_TYPE state;
582
583	struct {
584		u8 count;
585#ifndef __BIG_ENDIAN_BITFIELD
586		u8 isPathBroken:4;
587		u8 reserved3:3;
588		u8 widePortCapable:1;
589#else
590		u8 widePortCapable:1;
591		u8 reserved3:3;
592		u8 isPathBroken:4;
593#endif
594
595		u8 connectorIndex[2];
596		u8 reserved[4];
597		u64 sasAddr[2];
598		u8 reserved2[16];
599	} pathInfo;
600
601	u64 rawSize;
602	u64 nonCoercedSize;
603	u64 coercedSize;
604	u16 enclDeviceId;
605	u8 enclIndex;
606
607	union {
608		u8 slotNumber;
609		u8 enclConnectorIndex;
610	};
611
612	struct MR_PD_PROGRESS progInfo;
613	u8 badBlockTableFull;
614	u8 unusableInCurrentConfig;
615	u8 vpdPage83Ext[64];
616	u8 powerState;
617	u8 enclPosition;
618	u32 allowedOps;
619	u16 copyBackPartnerId;
620	u16 enclPartnerDeviceId;
621	struct {
622#ifndef __BIG_ENDIAN_BITFIELD
623		u16 fdeCapable:1;
624		u16 fdeEnabled:1;
625		u16 secured:1;
626		u16 locked:1;
627		u16 foreign:1;
628		u16 needsEKM:1;
629		u16 reserved:10;
630#else
631		u16 reserved:10;
632		u16 needsEKM:1;
633		u16 foreign:1;
634		u16 locked:1;
635		u16 secured:1;
636		u16 fdeEnabled:1;
637		u16 fdeCapable:1;
638#endif
639	} security;
640	u8 mediaType;
641	u8 notCertified;
642	u8 bridgeVendor[8];
643	u8 bridgeProductIdentification[16];
644	u8 bridgeProductRevisionLevel[4];
645	u8 satBridgeExists;
646
647	u8 interfaceType;
648	u8 temperature;
649	u8 emulatedBlockSize;
650	u16 userDataBlockSize;
651	u16 reserved2;
652
653	struct {
654#ifndef __BIG_ENDIAN_BITFIELD
655		u32 piType:3;
656		u32 piFormatted:1;
657		u32 piEligible:1;
658		u32 NCQ:1;
659		u32 WCE:1;
660		u32 commissionedSpare:1;
661		u32 emergencySpare:1;
662		u32 ineligibleForSSCD:1;
663		u32 ineligibleForLd:1;
664		u32 useSSEraseType:1;
665		u32 wceUnchanged:1;
666		u32 supportScsiUnmap:1;
667		u32 reserved:18;
668#else
669		u32 reserved:18;
670		u32 supportScsiUnmap:1;
671		u32 wceUnchanged:1;
672		u32 useSSEraseType:1;
673		u32 ineligibleForLd:1;
674		u32 ineligibleForSSCD:1;
675		u32 emergencySpare:1;
676		u32 commissionedSpare:1;
677		u32 WCE:1;
678		u32 NCQ:1;
679		u32 piEligible:1;
680		u32 piFormatted:1;
681		u32 piType:3;
682#endif
683	} properties;
684
685	u64 shieldDiagCompletionTime;
686	u8 shieldCounter;
687
688	u8 linkSpeedOther;
689	u8 reserved4[2];
690
691	struct {
692#ifndef __BIG_ENDIAN_BITFIELD
693		u32 bbmErrCountSupported:1;
694		u32 bbmErrCount:31;
695#else
696		u32 bbmErrCount:31;
697		u32 bbmErrCountSupported:1;
698#endif
699	} bbmErr;
700
701	u8 reserved1[512-428];
702} __packed;
703
704/*
705 * Definition of structure used to expose attributes of VD or JBOD
706 * (this structure is to be filled by firmware when MR_DCMD_DRV_GET_TARGET_PROP
707 * is fired by driver)
708 */
709struct MR_TARGET_PROPERTIES {
710	u32    max_io_size_kb;
711	u32    device_qdepth;
712	u32    sector_size;
713	u8     reset_tmo;
714	u8     reserved[499];
715} __packed;
716
717 /*
718 * defines the physical drive address structure
719 */
720struct MR_PD_ADDRESS {
721	__le16	deviceId;
722	u16     enclDeviceId;
723
724	union {
725		struct {
726			u8  enclIndex;
727			u8  slotNumber;
728		} mrPdAddress;
729		struct {
730			u8  enclPosition;
731			u8  enclConnectorIndex;
732		} mrEnclAddress;
733	};
734	u8      scsiDevType;
735	union {
736		u8      connectedPortBitmap;
737		u8      connectedPortNumbers;
738	};
739	u64     sasAddr[2];
740} __packed;
741
742/*
743 * defines the physical drive list structure
744 */
745struct MR_PD_LIST {
746	__le32		size;
747	__le32		count;
748	struct MR_PD_ADDRESS   addr[1];
749} __packed;
750
751struct megasas_pd_list {
752	u16             tid;
753	u8             driveType;
754	u8             driveState;
755} __packed;
756
757 /*
758 * defines the logical drive reference structure
759 */
760union  MR_LD_REF {
761	struct {
762		u8      targetId;
763		u8      reserved;
764		__le16     seqNum;
765	};
766	__le32     ref;
767} __packed;
768
769/*
770 * defines the logical drive list structure
771 */
772struct MR_LD_LIST {
773	__le32     ldCount;
774	__le32     reserved;
775	struct {
776		union MR_LD_REF   ref;
777		u8          state;
778		u8          reserved[3];
779		__le64		size;
780	} ldList[MAX_LOGICAL_DRIVES_EXT];
781} __packed;
782
783struct MR_LD_TARGETID_LIST {
784	__le32	size;
785	__le32	count;
786	u8	pad[3];
787	u8	targetId[MAX_LOGICAL_DRIVES_EXT];
788};
789
790struct MR_HOST_DEVICE_LIST_ENTRY {
791	struct {
792		union {
793			struct {
794#if defined(__BIG_ENDIAN_BITFIELD)
795				u8 reserved:7;
796				u8 is_sys_pd:1;
797#else
798				u8 is_sys_pd:1;
799				u8 reserved:7;
800#endif
801			} bits;
802			u8 byte;
803		} u;
804	} flags;
805	u8 scsi_type;
806	__le16 target_id;
807	u8 reserved[4];
808	__le64 sas_addr[2];
809} __packed;
810
811struct MR_HOST_DEVICE_LIST {
812	__le32			size;
813	__le32			count;
814	__le32			reserved[2];
815	struct MR_HOST_DEVICE_LIST_ENTRY	host_device_list[1];
816} __packed;
817
818#define HOST_DEVICE_LIST_SZ (sizeof(struct MR_HOST_DEVICE_LIST) +	       \
819			      (sizeof(struct MR_HOST_DEVICE_LIST_ENTRY) *      \
820			      (MEGASAS_MAX_PD + MAX_LOGICAL_DRIVES_EXT - 1)))
821
822
823/*
824 * SAS controller properties
825 */
826struct megasas_ctrl_prop {
827
828	u16 seq_num;
829	u16 pred_fail_poll_interval;
830	u16 intr_throttle_count;
831	u16 intr_throttle_timeouts;
832	u8 rebuild_rate;
833	u8 patrol_read_rate;
834	u8 bgi_rate;
835	u8 cc_rate;
836	u8 recon_rate;
837	u8 cache_flush_interval;
838	u8 spinup_drv_count;
839	u8 spinup_delay;
840	u8 cluster_enable;
841	u8 coercion_mode;
842	u8 alarm_enable;
843	u8 disable_auto_rebuild;
844	u8 disable_battery_warn;
845	u8 ecc_bucket_size;
846	u16 ecc_bucket_leak_rate;
847	u8 restore_hotspare_on_insertion;
848	u8 expose_encl_devices;
849	u8 maintainPdFailHistory;
850	u8 disallowHostRequestReordering;
851	u8 abortCCOnError;
852	u8 loadBalanceMode;
853	u8 disableAutoDetectBackplane;
854
855	u8 snapVDSpace;
856
857	/*
858	* Add properties that can be controlled by
859	* a bit in the following structure.
860	*/
861	struct {
862#if   defined(__BIG_ENDIAN_BITFIELD)
863		u32     reserved:18;
864		u32     enableJBOD:1;
865		u32     disableSpinDownHS:1;
866		u32     allowBootWithPinnedCache:1;
867		u32     disableOnlineCtrlReset:1;
868		u32     enableSecretKeyControl:1;
869		u32     autoEnhancedImport:1;
870		u32     enableSpinDownUnconfigured:1;
871		u32     SSDPatrolReadEnabled:1;
872		u32     SSDSMARTerEnabled:1;
873		u32     disableNCQ:1;
874		u32     useFdeOnly:1;
875		u32     prCorrectUnconfiguredAreas:1;
876		u32     SMARTerEnabled:1;
877		u32     copyBackDisabled:1;
878#else
879		u32     copyBackDisabled:1;
880		u32     SMARTerEnabled:1;
881		u32     prCorrectUnconfiguredAreas:1;
882		u32     useFdeOnly:1;
883		u32     disableNCQ:1;
884		u32     SSDSMARTerEnabled:1;
885		u32     SSDPatrolReadEnabled:1;
886		u32     enableSpinDownUnconfigured:1;
887		u32     autoEnhancedImport:1;
888		u32     enableSecretKeyControl:1;
889		u32     disableOnlineCtrlReset:1;
890		u32     allowBootWithPinnedCache:1;
891		u32     disableSpinDownHS:1;
892		u32     enableJBOD:1;
893		u32     reserved:18;
894#endif
895	} OnOffProperties;
896
897	union {
898		u8 autoSnapVDSpace;
899		u8 viewSpace;
900		struct {
901#if   defined(__BIG_ENDIAN_BITFIELD)
902			u16 reserved3:9;
903			u16 enable_fw_dev_list:1;
904			u16 reserved2:1;
905			u16 enable_snap_dump:1;
906			u16 reserved1:4;
907#else
908			u16 reserved1:4;
909			u16 enable_snap_dump:1;
910			u16 reserved2:1;
911			u16 enable_fw_dev_list:1;
912			u16 reserved3:9;
913#endif
914		} on_off_properties2;
915	};
916	__le16 spinDownTime;
917	u8  reserved[24];
918} __packed;
919
920/*
921 * SAS controller information
922 */
923struct megasas_ctrl_info {
924
925	/*
926	 * PCI device information
927	 */
928	struct {
929
930		__le16 vendor_id;
931		__le16 device_id;
932		__le16 sub_vendor_id;
933		__le16 sub_device_id;
934		u8 reserved[24];
935
936	} __attribute__ ((packed)) pci;
937
938	/*
939	 * Host interface information
940	 */
941	struct {
942
943		u8 PCIX:1;
944		u8 PCIE:1;
945		u8 iSCSI:1;
946		u8 SAS_3G:1;
947		u8 SRIOV:1;
948		u8 reserved_0:3;
949		u8 reserved_1[6];
950		u8 port_count;
951		u64 port_addr[8];
952
953	} __attribute__ ((packed)) host_interface;
954
955	/*
956	 * Device (backend) interface information
957	 */
958	struct {
959
960		u8 SPI:1;
961		u8 SAS_3G:1;
962		u8 SATA_1_5G:1;
963		u8 SATA_3G:1;
964		u8 reserved_0:4;
965		u8 reserved_1[6];
966		u8 port_count;
967		u64 port_addr[8];
968
969	} __attribute__ ((packed)) device_interface;
970
971	/*
972	 * List of components residing in flash. All str are null terminated
973	 */
974	__le32 image_check_word;
975	__le32 image_component_count;
976
977	struct {
978
979		char name[8];
980		char version[32];
981		char build_date[16];
982		char built_time[16];
983
984	} __attribute__ ((packed)) image_component[8];
985
986	/*
987	 * List of flash components that have been flashed on the card, but
988	 * are not in use, pending reset of the adapter. This list will be
989	 * empty if a flash operation has not occurred. All stings are null
990	 * terminated
991	 */
992	__le32 pending_image_component_count;
993
994	struct {
995
996		char name[8];
997		char version[32];
998		char build_date[16];
999		char build_time[16];
1000
1001	} __attribute__ ((packed)) pending_image_component[8];
1002
1003	u8 max_arms;
1004	u8 max_spans;
1005	u8 max_arrays;
1006	u8 max_lds;
1007
1008	char product_name[80];
1009	char serial_no[32];
1010
1011	/*
1012	 * Other physical/controller/operation information. Indicates the
1013	 * presence of the hardware
1014	 */
1015	struct {
1016
1017		u32 bbu:1;
1018		u32 alarm:1;
1019		u32 nvram:1;
1020		u32 uart:1;
1021		u32 reserved:28;
1022
1023	} __attribute__ ((packed)) hw_present;
1024
1025	__le32 current_fw_time;
1026
1027	/*
1028	 * Maximum data transfer sizes
1029	 */
1030	__le16 max_concurrent_cmds;
1031	__le16 max_sge_count;
1032	__le32 max_request_size;
1033
1034	/*
1035	 * Logical and physical device counts
1036	 */
1037	__le16 ld_present_count;
1038	__le16 ld_degraded_count;
1039	__le16 ld_offline_count;
1040
1041	__le16 pd_present_count;
1042	__le16 pd_disk_present_count;
1043	__le16 pd_disk_pred_failure_count;
1044	__le16 pd_disk_failed_count;
1045
1046	/*
1047	 * Memory size information
1048	 */
1049	__le16 nvram_size;
1050	__le16 memory_size;
1051	__le16 flash_size;
1052
1053	/*
1054	 * Error counters
1055	 */
1056	__le16 mem_correctable_error_count;
1057	__le16 mem_uncorrectable_error_count;
1058
1059	/*
1060	 * Cluster information
1061	 */
1062	u8 cluster_permitted;
1063	u8 cluster_active;
1064
1065	/*
1066	 * Additional max data transfer sizes
1067	 */
1068	__le16 max_strips_per_io;
1069
1070	/*
1071	 * Controller capabilities structures
1072	 */
1073	struct {
1074
1075		u32 raid_level_0:1;
1076		u32 raid_level_1:1;
1077		u32 raid_level_5:1;
1078		u32 raid_level_1E:1;
1079		u32 raid_level_6:1;
1080		u32 reserved:27;
1081
1082	} __attribute__ ((packed)) raid_levels;
1083
1084	struct {
1085
1086		u32 rbld_rate:1;
1087		u32 cc_rate:1;
1088		u32 bgi_rate:1;
1089		u32 recon_rate:1;
1090		u32 patrol_rate:1;
1091		u32 alarm_control:1;
1092		u32 cluster_supported:1;
1093		u32 bbu:1;
1094		u32 spanning_allowed:1;
1095		u32 dedicated_hotspares:1;
1096		u32 revertible_hotspares:1;
1097		u32 foreign_config_import:1;
1098		u32 self_diagnostic:1;
1099		u32 mixed_redundancy_arr:1;
1100		u32 global_hot_spares:1;
1101		u32 reserved:17;
1102
1103	} __attribute__ ((packed)) adapter_operations;
1104
1105	struct {
1106
1107		u32 read_policy:1;
1108		u32 write_policy:1;
1109		u32 io_policy:1;
1110		u32 access_policy:1;
1111		u32 disk_cache_policy:1;
1112		u32 reserved:27;
1113
1114	} __attribute__ ((packed)) ld_operations;
1115
1116	struct {
1117
1118		u8 min;
1119		u8 max;
1120		u8 reserved[2];
1121
1122	} __attribute__ ((packed)) stripe_sz_ops;
1123
1124	struct {
1125
1126		u32 force_online:1;
1127		u32 force_offline:1;
1128		u32 force_rebuild:1;
1129		u32 reserved:29;
1130
1131	} __attribute__ ((packed)) pd_operations;
1132
1133	struct {
1134
1135		u32 ctrl_supports_sas:1;
1136		u32 ctrl_supports_sata:1;
1137		u32 allow_mix_in_encl:1;
1138		u32 allow_mix_in_ld:1;
1139		u32 allow_sata_in_cluster:1;
1140		u32 reserved:27;
1141
1142	} __attribute__ ((packed)) pd_mix_support;
1143
1144	/*
1145	 * Define ECC single-bit-error bucket information
1146	 */
1147	u8 ecc_bucket_count;
1148	u8 reserved_2[11];
1149
1150	/*
1151	 * Include the controller properties (changeable items)
1152	 */
1153	struct megasas_ctrl_prop properties;
1154
1155	/*
1156	 * Define FW pkg version (set in envt v'bles on OEM basis)
1157	 */
1158	char package_version[0x60];
1159
1160
1161	/*
1162	* If adapterOperations.supportMoreThan8Phys is set,
1163	* and deviceInterface.portCount is greater than 8,
1164	* SAS Addrs for first 8 ports shall be populated in
1165	* deviceInterface.portAddr, and the rest shall be
1166	* populated in deviceInterfacePortAddr2.
1167	*/
1168	__le64	    deviceInterfacePortAddr2[8]; /*6a0h */
1169	u8          reserved3[128];              /*6e0h */
1170
1171	struct {                                /*760h */
1172		u16 minPdRaidLevel_0:4;
1173		u16 maxPdRaidLevel_0:12;
1174
1175		u16 minPdRaidLevel_1:4;
1176		u16 maxPdRaidLevel_1:12;
1177
1178		u16 minPdRaidLevel_5:4;
1179		u16 maxPdRaidLevel_5:12;
1180
1181		u16 minPdRaidLevel_1E:4;
1182		u16 maxPdRaidLevel_1E:12;
1183
1184		u16 minPdRaidLevel_6:4;
1185		u16 maxPdRaidLevel_6:12;
1186
1187		u16 minPdRaidLevel_10:4;
1188		u16 maxPdRaidLevel_10:12;
1189
1190		u16 minPdRaidLevel_50:4;
1191		u16 maxPdRaidLevel_50:12;
1192
1193		u16 minPdRaidLevel_60:4;
1194		u16 maxPdRaidLevel_60:12;
1195
1196		u16 minPdRaidLevel_1E_RLQ0:4;
1197		u16 maxPdRaidLevel_1E_RLQ0:12;
1198
1199		u16 minPdRaidLevel_1E0_RLQ0:4;
1200		u16 maxPdRaidLevel_1E0_RLQ0:12;
1201
1202		u16 reserved[6];
1203	} pdsForRaidLevels;
1204
1205	__le16 maxPds;                          /*780h */
1206	__le16 maxDedHSPs;                      /*782h */
1207	__le16 maxGlobalHSP;                    /*784h */
1208	__le16 ddfSize;                         /*786h */
1209	u8  maxLdsPerArray;                     /*788h */
1210	u8  partitionsInDDF;                    /*789h */
1211	u8  lockKeyBinding;                     /*78ah */
1212	u8  maxPITsPerLd;                       /*78bh */
1213	u8  maxViewsPerLd;                      /*78ch */
1214	u8  maxTargetId;                        /*78dh */
1215	__le16 maxBvlVdSize;                    /*78eh */
1216
1217	__le16 maxConfigurableSSCSize;          /*790h */
1218	__le16 currentSSCsize;                  /*792h */
1219
1220	char    expanderFwVersion[12];          /*794h */
1221
1222	__le16 PFKTrialTimeRemaining;           /*7A0h */
1223
1224	__le16 cacheMemorySize;                 /*7A2h */
1225
1226	struct {                                /*7A4h */
1227#if   defined(__BIG_ENDIAN_BITFIELD)
1228		u32     reserved:5;
1229		u32	activePassive:2;
1230		u32	supportConfigAutoBalance:1;
1231		u32	mpio:1;
1232		u32	supportDataLDonSSCArray:1;
1233		u32	supportPointInTimeProgress:1;
1234		u32     supportUnevenSpans:1;
1235		u32     dedicatedHotSparesLimited:1;
1236		u32     headlessMode:1;
1237		u32     supportEmulatedDrives:1;
1238		u32     supportResetNow:1;
1239		u32     realTimeScheduler:1;
1240		u32     supportSSDPatrolRead:1;
1241		u32     supportPerfTuning:1;
1242		u32     disableOnlinePFKChange:1;
1243		u32     supportJBOD:1;
1244		u32     supportBootTimePFKChange:1;
1245		u32     supportSetLinkSpeed:1;
1246		u32     supportEmergencySpares:1;
1247		u32     supportSuspendResumeBGops:1;
1248		u32     blockSSDWriteCacheChange:1;
1249		u32     supportShieldState:1;
1250		u32     supportLdBBMInfo:1;
1251		u32     supportLdPIType3:1;
1252		u32     supportLdPIType2:1;
1253		u32     supportLdPIType1:1;
1254		u32     supportPIcontroller:1;
1255#else
1256		u32     supportPIcontroller:1;
1257		u32     supportLdPIType1:1;
1258		u32     supportLdPIType2:1;
1259		u32     supportLdPIType3:1;
1260		u32     supportLdBBMInfo:1;
1261		u32     supportShieldState:1;
1262		u32     blockSSDWriteCacheChange:1;
1263		u32     supportSuspendResumeBGops:1;
1264		u32     supportEmergencySpares:1;
1265		u32     supportSetLinkSpeed:1;
1266		u32     supportBootTimePFKChange:1;
1267		u32     supportJBOD:1;
1268		u32     disableOnlinePFKChange:1;
1269		u32     supportPerfTuning:1;
1270		u32     supportSSDPatrolRead:1;
1271		u32     realTimeScheduler:1;
1272
1273		u32     supportResetNow:1;
1274		u32     supportEmulatedDrives:1;
1275		u32     headlessMode:1;
1276		u32     dedicatedHotSparesLimited:1;
1277
1278
1279		u32     supportUnevenSpans:1;
1280		u32	supportPointInTimeProgress:1;
1281		u32	supportDataLDonSSCArray:1;
1282		u32	mpio:1;
1283		u32	supportConfigAutoBalance:1;
1284		u32	activePassive:2;
1285		u32     reserved:5;
1286#endif
1287	} adapterOperations2;
1288
1289	u8  driverVersion[32];                  /*7A8h */
1290	u8  maxDAPdCountSpinup60;               /*7C8h */
1291	u8  temperatureROC;                     /*7C9h */
1292	u8  temperatureCtrl;                    /*7CAh */
1293	u8  reserved4;                          /*7CBh */
1294	__le16 maxConfigurablePds;              /*7CCh */
1295
1296
1297	u8  reserved5[2];                       /*0x7CDh */
1298
1299	/*
1300	* HA cluster information
1301	*/
1302	struct {
1303#if defined(__BIG_ENDIAN_BITFIELD)
1304		u32     reserved:25;
1305		u32     passive:1;
1306		u32     premiumFeatureMismatch:1;
1307		u32     ctrlPropIncompatible:1;
1308		u32     fwVersionMismatch:1;
1309		u32     hwIncompatible:1;
1310		u32     peerIsIncompatible:1;
1311		u32     peerIsPresent:1;
1312#else
1313		u32     peerIsPresent:1;
1314		u32     peerIsIncompatible:1;
1315		u32     hwIncompatible:1;
1316		u32     fwVersionMismatch:1;
1317		u32     ctrlPropIncompatible:1;
1318		u32     premiumFeatureMismatch:1;
1319		u32     passive:1;
1320		u32     reserved:25;
1321#endif
1322	} cluster;
1323
1324	char clusterId[MEGASAS_CLUSTER_ID_SIZE]; /*0x7D4 */
1325	struct {
1326		u8  maxVFsSupported;            /*0x7E4*/
1327		u8  numVFsEnabled;              /*0x7E5*/
1328		u8  requestorId;                /*0x7E6 0:PF, 1:VF1, 2:VF2*/
1329		u8  reserved;                   /*0x7E7*/
1330	} iov;
1331
1332	struct {
1333#if defined(__BIG_ENDIAN_BITFIELD)
1334		u32     reserved:7;
1335		u32     useSeqNumJbodFP:1;
1336		u32     supportExtendedSSCSize:1;
1337		u32     supportDiskCacheSettingForSysPDs:1;
1338		u32     supportCPLDUpdate:1;
1339		u32     supportTTYLogCompression:1;
1340		u32     discardCacheDuringLDDelete:1;
1341		u32     supportSecurityonJBOD:1;
1342		u32     supportCacheBypassModes:1;
1343		u32     supportDisableSESMonitoring:1;
1344		u32     supportForceFlash:1;
1345		u32     supportNVDRAM:1;
1346		u32     supportDrvActivityLEDSetting:1;
1347		u32     supportAllowedOpsforDrvRemoval:1;
1348		u32     supportHOQRebuild:1;
1349		u32     supportForceTo512e:1;
1350		u32     supportNVCacheErase:1;
1351		u32     supportDebugQueue:1;
1352		u32     supportSwZone:1;
1353		u32     supportCrashDump:1;
1354		u32     supportMaxExtLDs:1;
1355		u32     supportT10RebuildAssist:1;
1356		u32     supportDisableImmediateIO:1;
1357		u32     supportThermalPollInterval:1;
1358		u32     supportPersonalityChange:2;
1359#else
1360		u32     supportPersonalityChange:2;
1361		u32     supportThermalPollInterval:1;
1362		u32     supportDisableImmediateIO:1;
1363		u32     supportT10RebuildAssist:1;
1364		u32	supportMaxExtLDs:1;
1365		u32	supportCrashDump:1;
1366		u32     supportSwZone:1;
1367		u32     supportDebugQueue:1;
1368		u32     supportNVCacheErase:1;
1369		u32     supportForceTo512e:1;
1370		u32     supportHOQRebuild:1;
1371		u32     supportAllowedOpsforDrvRemoval:1;
1372		u32     supportDrvActivityLEDSetting:1;
1373		u32     supportNVDRAM:1;
1374		u32     supportForceFlash:1;
1375		u32     supportDisableSESMonitoring:1;
1376		u32     supportCacheBypassModes:1;
1377		u32     supportSecurityonJBOD:1;
1378		u32     discardCacheDuringLDDelete:1;
1379		u32     supportTTYLogCompression:1;
1380		u32     supportCPLDUpdate:1;
1381		u32     supportDiskCacheSettingForSysPDs:1;
1382		u32     supportExtendedSSCSize:1;
1383		u32     useSeqNumJbodFP:1;
1384		u32     reserved:7;
1385#endif
1386	} adapterOperations3;
1387
1388	struct {
1389#if defined(__BIG_ENDIAN_BITFIELD)
1390	u8 reserved:7;
1391	/* Indicates whether the CPLD image is part of
1392	 *  the package and stored in flash
1393	 */
1394	u8 cpld_in_flash:1;
1395#else
1396	u8 cpld_in_flash:1;
1397	u8 reserved:7;
1398#endif
1399	u8 reserved1[3];
1400	/* Null terminated string. Has the version
1401	 *  information if cpld_in_flash = FALSE
1402	 */
1403	u8 userCodeDefinition[12];
1404	} cpld;  /* Valid only if upgradableCPLD is TRUE */
1405
1406	struct {
1407	#if defined(__BIG_ENDIAN_BITFIELD)
1408		u16 reserved:2;
1409		u16 support_nvme_passthru:1;
1410		u16 support_pl_debug_info:1;
1411		u16 support_flash_comp_info:1;
1412		u16 support_host_info:1;
1413		u16 support_dual_fw_update:1;
1414		u16 support_ssc_rev3:1;
1415		u16 fw_swaps_bbu_vpd_info:1;
1416		u16 support_pd_map_target_id:1;
1417		u16 support_ses_ctrl_in_multipathcfg:1;
1418		u16 image_upload_supported:1;
1419		u16 support_encrypted_mfc:1;
1420		u16 supported_enc_algo:1;
1421		u16 support_ibutton_less:1;
1422		u16 ctrl_info_ext_supported:1;
1423	#else
1424
1425		u16 ctrl_info_ext_supported:1;
1426		u16 support_ibutton_less:1;
1427		u16 supported_enc_algo:1;
1428		u16 support_encrypted_mfc:1;
1429		u16 image_upload_supported:1;
1430		/* FW supports LUN based association and target port based */
1431		u16 support_ses_ctrl_in_multipathcfg:1;
1432		/* association for the SES device connected in multipath mode */
1433		/* FW defines Jbod target Id within MR_PD_CFG_SEQ */
1434		u16 support_pd_map_target_id:1;
1435		/* FW swaps relevant fields in MR_BBU_VPD_INFO_FIXED to
1436		 *  provide the data in little endian order
1437		 */
1438		u16 fw_swaps_bbu_vpd_info:1;
1439		u16 support_ssc_rev3:1;
1440		/* FW supports CacheCade 3.0, only one SSCD creation allowed */
1441		u16 support_dual_fw_update:1;
1442		/* FW supports dual firmware update feature */
1443		u16 support_host_info:1;
1444		/* FW supports MR_DCMD_CTRL_HOST_INFO_SET/GET */
1445		u16 support_flash_comp_info:1;
1446		/* FW supports MR_DCMD_CTRL_FLASH_COMP_INFO_GET */
1447		u16 support_pl_debug_info:1;
1448		/* FW supports retrieval of PL debug information through apps */
1449		u16 support_nvme_passthru:1;
1450		/* FW supports NVMe passthru commands */
1451		u16 reserved:2;
1452	#endif
1453		} adapter_operations4;
1454	u8 pad[0x800 - 0x7FE]; /* 0x7FE pad to 2K for expansion */
1455
1456	u32 size;
1457	u32 pad1;
1458
1459	u8 reserved6[64];
1460
1461	struct {
1462	#if defined(__BIG_ENDIAN_BITFIELD)
1463		u32 reserved:19;
1464		u32 support_pci_lane_margining: 1;
1465		u32 support_psoc_update:1;
1466		u32 support_force_personality_change:1;
1467		u32 support_fde_type_mix:1;
1468		u32 support_snap_dump:1;
1469		u32 support_nvme_tm:1;
1470		u32 support_oce_only:1;
1471		u32 support_ext_mfg_vpd:1;
1472		u32 support_pcie:1;
1473		u32 support_cvhealth_info:1;
1474		u32 support_profile_change:2;
1475		u32 mr_config_ext2_supported:1;
1476	#else
1477		u32 mr_config_ext2_supported:1;
1478		u32 support_profile_change:2;
1479		u32 support_cvhealth_info:1;
1480		u32 support_pcie:1;
1481		u32 support_ext_mfg_vpd:1;
1482		u32 support_oce_only:1;
1483		u32 support_nvme_tm:1;
1484		u32 support_snap_dump:1;
1485		u32 support_fde_type_mix:1;
1486		u32 support_force_personality_change:1;
1487		u32 support_psoc_update:1;
1488		u32 support_pci_lane_margining: 1;
1489		u32 reserved:19;
1490	#endif
1491	} adapter_operations5;
1492
1493	u32 rsvdForAdptOp[63];
1494
1495	u8 reserved7[3];
1496
1497	u8 TaskAbortTO;	/* Timeout value in seconds used by Abort Task TM */
1498	u8 MaxResetTO;	/* Max Supported Reset timeout in seconds. */
1499	u8 reserved8[3];
1500} __packed;
1501
1502/*
1503 * ===============================
1504 * MegaRAID SAS driver definitions
1505 * ===============================
1506 */
1507#define MEGASAS_MAX_PD_CHANNELS			2
1508#define MEGASAS_MAX_LD_CHANNELS			2
1509#define MEGASAS_MAX_CHANNELS			(MEGASAS_MAX_PD_CHANNELS + \
1510						MEGASAS_MAX_LD_CHANNELS)
1511#define MEGASAS_MAX_DEV_PER_CHANNEL		128
1512#define MEGASAS_DEFAULT_INIT_ID			-1
1513#define MEGASAS_MAX_LUN				8
1514#define MEGASAS_DEFAULT_CMD_PER_LUN		256
1515#define MEGASAS_MAX_PD                          (MEGASAS_MAX_PD_CHANNELS * \
1516						MEGASAS_MAX_DEV_PER_CHANNEL)
1517#define MEGASAS_MAX_LD_IDS			(MEGASAS_MAX_LD_CHANNELS * \
1518						MEGASAS_MAX_DEV_PER_CHANNEL)
1519
1520#define MEGASAS_MAX_SUPPORTED_LD_IDS		240
1521
1522#define MEGASAS_MAX_SECTORS                    (2*1024)
1523#define MEGASAS_MAX_SECTORS_IEEE		(2*128)
1524#define MEGASAS_DBG_LVL				1
1525
1526#define MEGASAS_FW_BUSY				1
1527
1528/* Driver's internal Logging levels*/
1529#define OCR_DEBUG    (1 << 0)
1530#define TM_DEBUG     (1 << 1)
1531#define LD_PD_DEBUG    (1 << 2)
1532
1533#define SCAN_PD_CHANNEL	0x1
1534#define SCAN_VD_CHANNEL	0x2
1535
1536#define MEGASAS_KDUMP_QUEUE_DEPTH               100
1537#define MR_LARGE_IO_MIN_SIZE			(32 * 1024)
1538#define MR_R1_LDIO_PIGGYBACK_DEFAULT		4
1539
1540enum MR_SCSI_CMD_TYPE {
1541	READ_WRITE_LDIO = 0,
1542	NON_READ_WRITE_LDIO = 1,
1543	READ_WRITE_SYSPDIO = 2,
1544	NON_READ_WRITE_SYSPDIO = 3,
1545};
1546
1547enum DCMD_TIMEOUT_ACTION {
1548	INITIATE_OCR = 0,
1549	KILL_ADAPTER = 1,
1550	IGNORE_TIMEOUT = 2,
1551};
1552
1553enum FW_BOOT_CONTEXT {
1554	PROBE_CONTEXT = 0,
1555	OCR_CONTEXT = 1,
1556};
1557
1558/* Frame Type */
1559#define IO_FRAME				0
1560#define PTHRU_FRAME				1
1561
1562/*
1563 * When SCSI mid-layer calls driver's reset routine, driver waits for
1564 * MEGASAS_RESET_WAIT_TIME seconds for all outstanding IO to complete. Note
1565 * that the driver cannot _actually_ abort or reset pending commands. While
1566 * it is waiting for the commands to complete, it prints a diagnostic message
1567 * every MEGASAS_RESET_NOTICE_INTERVAL seconds
1568 */
1569#define MEGASAS_RESET_WAIT_TIME			180
1570#define MEGASAS_INTERNAL_CMD_WAIT_TIME		180
1571#define	MEGASAS_RESET_NOTICE_INTERVAL		5
1572#define MEGASAS_IOCTL_CMD			0
1573#define MEGASAS_DEFAULT_CMD_TIMEOUT		90
1574#define MEGASAS_THROTTLE_QUEUE_DEPTH		16
1575#define MEGASAS_DEFAULT_TM_TIMEOUT		50
1576/*
1577 * FW reports the maximum of number of commands that it can accept (maximum
1578 * commands that can be outstanding) at any time. The driver must report a
1579 * lower number to the mid layer because it can issue a few internal commands
1580 * itself (E.g, AEN, abort cmd, IOCTLs etc). The number of commands it needs
1581 * is shown below
1582 */
1583#define MEGASAS_INT_CMDS			32
1584#define MEGASAS_SKINNY_INT_CMDS			5
1585#define MEGASAS_FUSION_INTERNAL_CMDS		8
1586#define MEGASAS_FUSION_IOCTL_CMDS		3
1587#define MEGASAS_MFI_IOCTL_CMDS			27
1588
1589#define MEGASAS_MAX_MSIX_QUEUES			128
1590/*
1591 * FW can accept both 32 and 64 bit SGLs. We want to allocate 32/64 bit
1592 * SGLs based on the size of dma_addr_t
1593 */
1594#define IS_DMA64				(sizeof(dma_addr_t) == 8)
1595
1596#define MFI_XSCALE_OMR0_CHANGE_INTERRUPT		0x00000001
1597
1598#define MFI_INTR_FLAG_REPLY_MESSAGE			0x00000001
1599#define MFI_INTR_FLAG_FIRMWARE_STATE_CHANGE		0x00000002
1600#define MFI_G2_OUTBOUND_DOORBELL_CHANGE_INTERRUPT	0x00000004
1601
1602#define MFI_OB_INTR_STATUS_MASK			0x00000002
1603#define MFI_POLL_TIMEOUT_SECS			60
1604#define MFI_IO_TIMEOUT_SECS			180
1605#define MEGASAS_SRIOV_HEARTBEAT_INTERVAL_VF	(5 * HZ)
1606#define MEGASAS_OCR_SETTLE_TIME_VF		(1000 * 30)
1607#define MEGASAS_SRIOV_MAX_RESET_TRIES_VF	1
1608#define MEGASAS_ROUTINE_WAIT_TIME_VF		300
1609#define MFI_REPLY_1078_MESSAGE_INTERRUPT	0x80000000
1610#define MFI_REPLY_GEN2_MESSAGE_INTERRUPT	0x00000001
1611#define MFI_GEN2_ENABLE_INTERRUPT_MASK		(0x00000001 | 0x00000004)
1612#define MFI_REPLY_SKINNY_MESSAGE_INTERRUPT	0x40000000
1613#define MFI_SKINNY_ENABLE_INTERRUPT_MASK	(0x00000001)
1614
1615#define MFI_1068_PCSR_OFFSET			0x84
1616#define MFI_1068_FW_HANDSHAKE_OFFSET		0x64
1617#define MFI_1068_FW_READY			0xDDDD0000
1618
1619#define MR_MAX_REPLY_QUEUES_OFFSET              0X0000001F
1620#define MR_MAX_REPLY_QUEUES_EXT_OFFSET          0X003FC000
1621#define MR_MAX_REPLY_QUEUES_EXT_OFFSET_SHIFT    14
1622#define MR_MAX_MSIX_REG_ARRAY                   16
1623#define MR_RDPQ_MODE_OFFSET			0X00800000
1624
1625#define MR_MAX_RAID_MAP_SIZE_OFFSET_SHIFT	16
1626#define MR_MAX_RAID_MAP_SIZE_MASK		0x1FF
1627#define MR_MIN_MAP_SIZE				0x10000
1628/* 64k */
1629
1630#define MR_CAN_HANDLE_SYNC_CACHE_OFFSET		0X01000000
1631
1632#define MR_ATOMIC_DESCRIPTOR_SUPPORT_OFFSET	(1 << 24)
1633
1634#define MR_CAN_HANDLE_64_BIT_DMA_OFFSET		(1 << 25)
1635#define MR_INTR_COALESCING_SUPPORT_OFFSET	(1 << 26)
1636
1637#define MEGASAS_WATCHDOG_THREAD_INTERVAL	1000
1638#define MEGASAS_WAIT_FOR_NEXT_DMA_MSECS		20
1639#define MEGASAS_WATCHDOG_WAIT_COUNT		50
1640
1641enum MR_ADAPTER_TYPE {
1642	MFI_SERIES = 1,
1643	THUNDERBOLT_SERIES = 2,
1644	INVADER_SERIES = 3,
1645	VENTURA_SERIES = 4,
1646	AERO_SERIES = 5,
1647};
1648
1649/*
1650* register set for both 1068 and 1078 controllers
1651* structure extended for 1078 registers
1652*/
1653
1654struct megasas_register_set {
1655	u32	doorbell;                       /*0000h*/
1656	u32	fusion_seq_offset;		/*0004h*/
1657	u32	fusion_host_diag;		/*0008h*/
1658	u32	reserved_01;			/*000Ch*/
1659
1660	u32 	inbound_msg_0;			/*0010h*/
1661	u32 	inbound_msg_1;			/*0014h*/
1662	u32 	outbound_msg_0;			/*0018h*/
1663	u32 	outbound_msg_1;			/*001Ch*/
1664
1665	u32 	inbound_doorbell;		/*0020h*/
1666	u32 	inbound_intr_status;		/*0024h*/
1667	u32 	inbound_intr_mask;		/*0028h*/
1668
1669	u32 	outbound_doorbell;		/*002Ch*/
1670	u32 	outbound_intr_status;		/*0030h*/
1671	u32 	outbound_intr_mask;		/*0034h*/
1672
1673	u32 	reserved_1[2];			/*0038h*/
1674
1675	u32 	inbound_queue_port;		/*0040h*/
1676	u32 	outbound_queue_port;		/*0044h*/
1677
1678	u32	reserved_2[9];			/*0048h*/
1679	u32	reply_post_host_index;		/*006Ch*/
1680	u32	reserved_2_2[12];		/*0070h*/
1681
1682	u32 	outbound_doorbell_clear;	/*00A0h*/
1683
1684	u32 	reserved_3[3];			/*00A4h*/
1685
1686	u32	outbound_scratch_pad_0;		/*00B0h*/
1687	u32	outbound_scratch_pad_1;         /*00B4h*/
1688	u32	outbound_scratch_pad_2;         /*00B8h*/
1689	u32	outbound_scratch_pad_3;         /*00BCh*/
1690
1691	u32 	inbound_low_queue_port ;	/*00C0h*/
1692
1693	u32 	inbound_high_queue_port ;	/*00C4h*/
1694
1695	u32 inbound_single_queue_port;	/*00C8h*/
1696	u32	res_6[11];			/*CCh*/
1697	u32	host_diag;
1698	u32	seq_offset;
1699	u32 	index_registers[807];		/*00CCh*/
1700} __attribute__ ((packed));
1701
1702struct megasas_sge32 {
1703
1704	__le32 phys_addr;
1705	__le32 length;
1706
1707} __attribute__ ((packed));
1708
1709struct megasas_sge64 {
1710
1711	__le64 phys_addr;
1712	__le32 length;
1713
1714} __attribute__ ((packed));
1715
1716struct megasas_sge_skinny {
1717	__le64 phys_addr;
1718	__le32 length;
1719	__le32 flag;
1720} __packed;
1721
1722union megasas_sgl {
1723
1724	struct megasas_sge32 sge32[1];
1725	struct megasas_sge64 sge64[1];
1726	struct megasas_sge_skinny sge_skinny[1];
1727
1728} __attribute__ ((packed));
1729
1730struct megasas_header {
1731
1732	u8 cmd;			/*00h */
1733	u8 sense_len;		/*01h */
1734	u8 cmd_status;		/*02h */
1735	u8 scsi_status;		/*03h */
1736
1737	u8 target_id;		/*04h */
1738	u8 lun;			/*05h */
1739	u8 cdb_len;		/*06h */
1740	u8 sge_count;		/*07h */
1741
1742	__le32 context;		/*08h */
1743	__le32 pad_0;		/*0Ch */
1744
1745	__le16 flags;		/*10h */
1746	__le16 timeout;		/*12h */
1747	__le32 data_xferlen;	/*14h */
1748
1749} __attribute__ ((packed));
1750
1751union megasas_sgl_frame {
1752
1753	struct megasas_sge32 sge32[8];
1754	struct megasas_sge64 sge64[5];
1755
1756} __attribute__ ((packed));
1757
1758typedef union _MFI_CAPABILITIES {
1759	struct {
1760#if   defined(__BIG_ENDIAN_BITFIELD)
1761	u32     reserved:16;
1762	u32	support_fw_exposed_dev_list:1;
1763	u32	support_nvme_passthru:1;
1764	u32     support_64bit_mode:1;
1765	u32 support_pd_map_target_id:1;
1766	u32     support_qd_throttling:1;
1767	u32     support_fp_rlbypass:1;
1768	u32     support_vfid_in_ioframe:1;
1769	u32     support_ext_io_size:1;
1770	u32		support_ext_queue_depth:1;
1771	u32     security_protocol_cmds_fw:1;
1772	u32     support_core_affinity:1;
1773	u32     support_ndrive_r1_lb:1;
1774	u32		support_max_255lds:1;
1775	u32		support_fastpath_wb:1;
1776	u32     support_additional_msix:1;
1777	u32     support_fp_remote_lun:1;
1778#else
1779	u32     support_fp_remote_lun:1;
1780	u32     support_additional_msix:1;
1781	u32		support_fastpath_wb:1;
1782	u32		support_max_255lds:1;
1783	u32     support_ndrive_r1_lb:1;
1784	u32     support_core_affinity:1;
1785	u32     security_protocol_cmds_fw:1;
1786	u32		support_ext_queue_depth:1;
1787	u32     support_ext_io_size:1;
1788	u32     support_vfid_in_ioframe:1;
1789	u32     support_fp_rlbypass:1;
1790	u32     support_qd_throttling:1;
1791	u32	support_pd_map_target_id:1;
1792	u32     support_64bit_mode:1;
1793	u32	support_nvme_passthru:1;
1794	u32	support_fw_exposed_dev_list:1;
1795	u32     reserved:16;
1796#endif
1797	} mfi_capabilities;
1798	__le32		reg;
1799} MFI_CAPABILITIES;
1800
1801struct megasas_init_frame {
1802
1803	u8 cmd;			/*00h */
1804	u8 reserved_0;		/*01h */
1805	u8 cmd_status;		/*02h */
1806
1807	u8 reserved_1;		/*03h */
1808	MFI_CAPABILITIES driver_operations; /*04h*/
1809
1810	__le32 context;		/*08h */
1811	__le32 pad_0;		/*0Ch */
1812
1813	__le16 flags;		/*10h */
1814	__le16 replyqueue_mask;		/*12h */
1815	__le32 data_xfer_len;	/*14h */
1816
1817	__le32 queue_info_new_phys_addr_lo;	/*18h */
1818	__le32 queue_info_new_phys_addr_hi;	/*1Ch */
1819	__le32 queue_info_old_phys_addr_lo;	/*20h */
1820	__le32 queue_info_old_phys_addr_hi;	/*24h */
1821	__le32 reserved_4[2];	/*28h */
1822	__le32 system_info_lo;      /*30h */
1823	__le32 system_info_hi;      /*34h */
1824	__le32 reserved_5[2];	/*38h */
1825
1826} __attribute__ ((packed));
1827
1828struct megasas_init_queue_info {
1829
1830	__le32 init_flags;		/*00h */
1831	__le32 reply_queue_entries;	/*04h */
1832
1833	__le32 reply_queue_start_phys_addr_lo;	/*08h */
1834	__le32 reply_queue_start_phys_addr_hi;	/*0Ch */
1835	__le32 producer_index_phys_addr_lo;	/*10h */
1836	__le32 producer_index_phys_addr_hi;	/*14h */
1837	__le32 consumer_index_phys_addr_lo;	/*18h */
1838	__le32 consumer_index_phys_addr_hi;	/*1Ch */
1839
1840} __attribute__ ((packed));
1841
1842struct megasas_io_frame {
1843
1844	u8 cmd;			/*00h */
1845	u8 sense_len;		/*01h */
1846	u8 cmd_status;		/*02h */
1847	u8 scsi_status;		/*03h */
1848
1849	u8 target_id;		/*04h */
1850	u8 access_byte;		/*05h */
1851	u8 reserved_0;		/*06h */
1852	u8 sge_count;		/*07h */
1853
1854	__le32 context;		/*08h */
1855	__le32 pad_0;		/*0Ch */
1856
1857	__le16 flags;		/*10h */
1858	__le16 timeout;		/*12h */
1859	__le32 lba_count;	/*14h */
1860
1861	__le32 sense_buf_phys_addr_lo;	/*18h */
1862	__le32 sense_buf_phys_addr_hi;	/*1Ch */
1863
1864	__le32 start_lba_lo;	/*20h */
1865	__le32 start_lba_hi;	/*24h */
1866
1867	union megasas_sgl sgl;	/*28h */
1868
1869} __attribute__ ((packed));
1870
1871struct megasas_pthru_frame {
1872
1873	u8 cmd;			/*00h */
1874	u8 sense_len;		/*01h */
1875	u8 cmd_status;		/*02h */
1876	u8 scsi_status;		/*03h */
1877
1878	u8 target_id;		/*04h */
1879	u8 lun;			/*05h */
1880	u8 cdb_len;		/*06h */
1881	u8 sge_count;		/*07h */
1882
1883	__le32 context;		/*08h */
1884	__le32 pad_0;		/*0Ch */
1885
1886	__le16 flags;		/*10h */
1887	__le16 timeout;		/*12h */
1888	__le32 data_xfer_len;	/*14h */
1889
1890	__le32 sense_buf_phys_addr_lo;	/*18h */
1891	__le32 sense_buf_phys_addr_hi;	/*1Ch */
1892
1893	u8 cdb[16];		/*20h */
1894	union megasas_sgl sgl;	/*30h */
1895
1896} __attribute__ ((packed));
1897
1898struct megasas_dcmd_frame {
1899
1900	u8 cmd;			/*00h */
1901	u8 reserved_0;		/*01h */
1902	u8 cmd_status;		/*02h */
1903	u8 reserved_1[4];	/*03h */
1904	u8 sge_count;		/*07h */
1905
1906	__le32 context;		/*08h */
1907	__le32 pad_0;		/*0Ch */
1908
1909	__le16 flags;		/*10h */
1910	__le16 timeout;		/*12h */
1911
1912	__le32 data_xfer_len;	/*14h */
1913	__le32 opcode;		/*18h */
1914
1915	union {			/*1Ch */
1916		u8 b[12];
1917		__le16 s[6];
1918		__le32 w[3];
1919	} mbox;
1920
1921	union megasas_sgl sgl;	/*28h */
1922
1923} __attribute__ ((packed));
1924
1925struct megasas_abort_frame {
1926
1927	u8 cmd;			/*00h */
1928	u8 reserved_0;		/*01h */
1929	u8 cmd_status;		/*02h */
1930
1931	u8 reserved_1;		/*03h */
1932	__le32 reserved_2;	/*04h */
1933
1934	__le32 context;		/*08h */
1935	__le32 pad_0;		/*0Ch */
1936
1937	__le16 flags;		/*10h */
1938	__le16 reserved_3;	/*12h */
1939	__le32 reserved_4;	/*14h */
1940
1941	__le32 abort_context;	/*18h */
1942	__le32 pad_1;		/*1Ch */
1943
1944	__le32 abort_mfi_phys_addr_lo;	/*20h */
1945	__le32 abort_mfi_phys_addr_hi;	/*24h */
1946
1947	__le32 reserved_5[6];	/*28h */
1948
1949} __attribute__ ((packed));
1950
1951struct megasas_smp_frame {
1952
1953	u8 cmd;			/*00h */
1954	u8 reserved_1;		/*01h */
1955	u8 cmd_status;		/*02h */
1956	u8 connection_status;	/*03h */
1957
1958	u8 reserved_2[3];	/*04h */
1959	u8 sge_count;		/*07h */
1960
1961	__le32 context;		/*08h */
1962	__le32 pad_0;		/*0Ch */
1963
1964	__le16 flags;		/*10h */
1965	__le16 timeout;		/*12h */
1966
1967	__le32 data_xfer_len;	/*14h */
1968	__le64 sas_addr;	/*18h */
1969
1970	union {
1971		struct megasas_sge32 sge32[2];	/* [0]: resp [1]: req */
1972		struct megasas_sge64 sge64[2];	/* [0]: resp [1]: req */
1973	} sgl;
1974
1975} __attribute__ ((packed));
1976
1977struct megasas_stp_frame {
1978
1979	u8 cmd;			/*00h */
1980	u8 reserved_1;		/*01h */
1981	u8 cmd_status;		/*02h */
1982	u8 reserved_2;		/*03h */
1983
1984	u8 target_id;		/*04h */
1985	u8 reserved_3[2];	/*05h */
1986	u8 sge_count;		/*07h */
1987
1988	__le32 context;		/*08h */
1989	__le32 pad_0;		/*0Ch */
1990
1991	__le16 flags;		/*10h */
1992	__le16 timeout;		/*12h */
1993
1994	__le32 data_xfer_len;	/*14h */
1995
1996	__le16 fis[10];		/*18h */
1997	__le32 stp_flags;
1998
1999	union {
2000		struct megasas_sge32 sge32[2];	/* [0]: resp [1]: data */
2001		struct megasas_sge64 sge64[2];	/* [0]: resp [1]: data */
2002	} sgl;
2003
2004} __attribute__ ((packed));
2005
2006union megasas_frame {
2007
2008	struct megasas_header hdr;
2009	struct megasas_init_frame init;
2010	struct megasas_io_frame io;
2011	struct megasas_pthru_frame pthru;
2012	struct megasas_dcmd_frame dcmd;
2013	struct megasas_abort_frame abort;
2014	struct megasas_smp_frame smp;
2015	struct megasas_stp_frame stp;
2016
2017	u8 raw_bytes[64];
2018};
2019
2020/**
2021 * struct MR_PRIV_DEVICE - sdev private hostdata
2022 * @is_tm_capable: firmware managed tm_capable flag
2023 * @tm_busy: TM request is in progress
2024 */
2025struct MR_PRIV_DEVICE {
2026	bool is_tm_capable;
2027	bool tm_busy;
2028	atomic_t r1_ldio_hint;
2029	u8 interface_type;
2030	u8 task_abort_tmo;
2031	u8 target_reset_tmo;
2032};
2033struct megasas_cmd;
2034
2035union megasas_evt_class_locale {
2036
2037	struct {
2038#ifndef __BIG_ENDIAN_BITFIELD
2039		u16 locale;
2040		u8 reserved;
2041		s8 class;
2042#else
2043		s8 class;
2044		u8 reserved;
2045		u16 locale;
2046#endif
2047	} __attribute__ ((packed)) members;
2048
2049	u32 word;
2050
2051} __attribute__ ((packed));
2052
2053struct megasas_evt_log_info {
2054	__le32 newest_seq_num;
2055	__le32 oldest_seq_num;
2056	__le32 clear_seq_num;
2057	__le32 shutdown_seq_num;
2058	__le32 boot_seq_num;
2059
2060} __attribute__ ((packed));
2061
2062struct megasas_progress {
2063
2064	__le16 progress;
2065	__le16 elapsed_seconds;
2066
2067} __attribute__ ((packed));
2068
2069struct megasas_evtarg_ld {
2070
2071	u16 target_id;
2072	u8 ld_index;
2073	u8 reserved;
2074
2075} __attribute__ ((packed));
2076
2077struct megasas_evtarg_pd {
2078	u16 device_id;
2079	u8 encl_index;
2080	u8 slot_number;
2081
2082} __attribute__ ((packed));
2083
2084struct megasas_evt_detail {
2085
2086	__le32 seq_num;
2087	__le32 time_stamp;
2088	__le32 code;
2089	union megasas_evt_class_locale cl;
2090	u8 arg_type;
2091	u8 reserved1[15];
2092
2093	union {
2094		struct {
2095			struct megasas_evtarg_pd pd;
2096			u8 cdb_length;
2097			u8 sense_length;
2098			u8 reserved[2];
2099			u8 cdb[16];
2100			u8 sense[64];
2101		} __attribute__ ((packed)) cdbSense;
2102
2103		struct megasas_evtarg_ld ld;
2104
2105		struct {
2106			struct megasas_evtarg_ld ld;
2107			__le64 count;
2108		} __attribute__ ((packed)) ld_count;
2109
2110		struct {
2111			__le64 lba;
2112			struct megasas_evtarg_ld ld;
2113		} __attribute__ ((packed)) ld_lba;
2114
2115		struct {
2116			struct megasas_evtarg_ld ld;
2117			__le32 prevOwner;
2118			__le32 newOwner;
2119		} __attribute__ ((packed)) ld_owner;
2120
2121		struct {
2122			u64 ld_lba;
2123			u64 pd_lba;
2124			struct megasas_evtarg_ld ld;
2125			struct megasas_evtarg_pd pd;
2126		} __attribute__ ((packed)) ld_lba_pd_lba;
2127
2128		struct {
2129			struct megasas_evtarg_ld ld;
2130			struct megasas_progress prog;
2131		} __attribute__ ((packed)) ld_prog;
2132
2133		struct {
2134			struct megasas_evtarg_ld ld;
2135			u32 prev_state;
2136			u32 new_state;
2137		} __attribute__ ((packed)) ld_state;
2138
2139		struct {
2140			u64 strip;
2141			struct megasas_evtarg_ld ld;
2142		} __attribute__ ((packed)) ld_strip;
2143
2144		struct megasas_evtarg_pd pd;
2145
2146		struct {
2147			struct megasas_evtarg_pd pd;
2148			u32 err;
2149		} __attribute__ ((packed)) pd_err;
2150
2151		struct {
2152			u64 lba;
2153			struct megasas_evtarg_pd pd;
2154		} __attribute__ ((packed)) pd_lba;
2155
2156		struct {
2157			u64 lba;
2158			struct megasas_evtarg_pd pd;
2159			struct megasas_evtarg_ld ld;
2160		} __attribute__ ((packed)) pd_lba_ld;
2161
2162		struct {
2163			struct megasas_evtarg_pd pd;
2164			struct megasas_progress prog;
2165		} __attribute__ ((packed)) pd_prog;
2166
2167		struct {
2168			struct megasas_evtarg_pd pd;
2169			u32 prevState;
2170			u32 newState;
2171		} __attribute__ ((packed)) pd_state;
2172
2173		struct {
2174			u16 vendorId;
2175			__le16 deviceId;
2176			u16 subVendorId;
2177			u16 subDeviceId;
2178		} __attribute__ ((packed)) pci;
2179
2180		u32 rate;
2181		char str[96];
2182
2183		struct {
2184			u32 rtc;
2185			u32 elapsedSeconds;
2186		} __attribute__ ((packed)) time;
2187
2188		struct {
2189			u32 ecar;
2190			u32 elog;
2191			char str[64];
2192		} __attribute__ ((packed)) ecc;
2193
2194		u8 b[96];
2195		__le16 s[48];
2196		__le32 w[24];
2197		__le64 d[12];
2198	} args;
2199
2200	char description[128];
2201
2202} __attribute__ ((packed));
2203
2204struct megasas_aen_event {
2205	struct delayed_work hotplug_work;
2206	struct megasas_instance *instance;
2207};
2208
2209struct megasas_irq_context {
2210	char name[MEGASAS_MSIX_NAME_LEN];
2211	struct megasas_instance *instance;
2212	u32 MSIxIndex;
2213	u32 os_irq;
2214	struct irq_poll irqpoll;
2215	bool irq_poll_scheduled;
2216	bool irq_line_enable;
2217};
2218
2219struct MR_DRV_SYSTEM_INFO {
2220	u8	infoVersion;
2221	u8	systemIdLength;
2222	u16	reserved0;
2223	u8	systemId[64];
2224	u8	reserved[1980];
2225};
2226
2227enum MR_PD_TYPE {
2228	UNKNOWN_DRIVE = 0,
2229	PARALLEL_SCSI = 1,
2230	SAS_PD = 2,
2231	SATA_PD = 3,
2232	FC_PD = 4,
2233	NVME_PD = 5,
2234};
2235
2236/* JBOD Queue depth definitions */
2237#define MEGASAS_SATA_QD	32
2238#define MEGASAS_SAS_QD 256
2239#define MEGASAS_DEFAULT_PD_QD	64
2240#define MEGASAS_NVME_QD        64
2241
2242#define MR_DEFAULT_NVME_PAGE_SIZE	4096
2243#define MR_DEFAULT_NVME_PAGE_SHIFT	12
2244#define MR_DEFAULT_NVME_MDTS_KB		128
2245#define MR_NVME_PAGE_SIZE_MASK		0x000000FF
2246
2247/*Aero performance parameters*/
2248#define MR_HIGH_IOPS_QUEUE_COUNT	8
2249#define MR_DEVICE_HIGH_IOPS_DEPTH	8
2250#define MR_HIGH_IOPS_BATCH_COUNT	16
2251
2252enum MR_PERF_MODE {
2253	MR_BALANCED_PERF_MODE		= 0,
2254	MR_IOPS_PERF_MODE		= 1,
2255	MR_LATENCY_PERF_MODE		= 2,
2256};
2257
2258#define MEGASAS_PERF_MODE_2STR(mode) \
2259		((mode) == MR_BALANCED_PERF_MODE ? "Balanced" : \
2260		 (mode) == MR_IOPS_PERF_MODE ? "IOPS" : \
2261		 (mode) == MR_LATENCY_PERF_MODE ? "Latency" : \
2262		 "Unknown")
2263
2264enum MEGASAS_LD_TARGET_ID_STATUS {
2265	LD_TARGET_ID_INITIAL,
2266	LD_TARGET_ID_ACTIVE,
2267	LD_TARGET_ID_DELETED,
2268};
2269
2270#define MEGASAS_TARGET_ID(sdev)						\
2271	(((sdev->channel % 2) * MEGASAS_MAX_DEV_PER_CHANNEL) + sdev->id)
2272
2273struct megasas_instance {
2274
2275	unsigned int *reply_map;
2276	__le32 *producer;
2277	dma_addr_t producer_h;
2278	__le32 *consumer;
2279	dma_addr_t consumer_h;
2280	struct MR_DRV_SYSTEM_INFO *system_info_buf;
2281	dma_addr_t system_info_h;
2282	struct MR_LD_VF_AFFILIATION *vf_affiliation;
2283	dma_addr_t vf_affiliation_h;
2284	struct MR_LD_VF_AFFILIATION_111 *vf_affiliation_111;
2285	dma_addr_t vf_affiliation_111_h;
2286	struct MR_CTRL_HB_HOST_MEM *hb_host_mem;
2287	dma_addr_t hb_host_mem_h;
2288	struct MR_PD_INFO *pd_info;
2289	dma_addr_t pd_info_h;
2290	struct MR_TARGET_PROPERTIES *tgt_prop;
2291	dma_addr_t tgt_prop_h;
2292
2293	__le32 *reply_queue;
2294	dma_addr_t reply_queue_h;
2295
2296	u32 *crash_dump_buf;
2297	dma_addr_t crash_dump_h;
2298
2299	struct MR_PD_LIST *pd_list_buf;
2300	dma_addr_t pd_list_buf_h;
2301
2302	struct megasas_ctrl_info *ctrl_info_buf;
2303	dma_addr_t ctrl_info_buf_h;
2304
2305	struct MR_LD_LIST *ld_list_buf;
2306	dma_addr_t ld_list_buf_h;
2307
2308	struct MR_LD_TARGETID_LIST *ld_targetid_list_buf;
2309	dma_addr_t ld_targetid_list_buf_h;
2310
2311	struct MR_HOST_DEVICE_LIST *host_device_list_buf;
2312	dma_addr_t host_device_list_buf_h;
2313
2314	struct MR_SNAPDUMP_PROPERTIES *snapdump_prop;
2315	dma_addr_t snapdump_prop_h;
2316
2317	void *crash_buf[MAX_CRASH_DUMP_SIZE];
2318	unsigned int    fw_crash_buffer_size;
2319	unsigned int    fw_crash_state;
2320	unsigned int    fw_crash_buffer_offset;
2321	u32 drv_buf_index;
2322	u32 drv_buf_alloc;
2323	u32 crash_dump_fw_support;
2324	u32 crash_dump_drv_support;
2325	u32 crash_dump_app_support;
2326	u32 secure_jbod_support;
2327	u32 support_morethan256jbod; /* FW support for more than 256 PD/JBOD */
2328	bool use_seqnum_jbod_fp;   /* Added for PD sequence */
2329	bool smp_affinity_enable;
2330	struct mutex crashdump_lock;
2331
2332	struct megasas_register_set __iomem *reg_set;
2333	u32 __iomem *reply_post_host_index_addr[MR_MAX_MSIX_REG_ARRAY];
2334	struct megasas_pd_list          pd_list[MEGASAS_MAX_PD];
2335	struct megasas_pd_list          local_pd_list[MEGASAS_MAX_PD];
2336	u8 ld_ids[MEGASAS_MAX_LD_IDS];
2337	u8 ld_tgtid_status[MEGASAS_MAX_LD_IDS];
2338	u8 ld_ids_prev[MEGASAS_MAX_LD_IDS];
2339	u8 ld_ids_from_raidmap[MEGASAS_MAX_LD_IDS];
2340	s8 init_id;
2341
2342	u16 max_num_sge;
2343	u16 max_fw_cmds;
2344	u16 max_mpt_cmds;
2345	u16 max_mfi_cmds;
2346	u16 max_scsi_cmds;
2347	u16 ldio_threshold;
2348	u16 cur_can_queue;
2349	u32 max_sectors_per_req;
2350	bool msix_load_balance;
2351	struct megasas_aen_event *ev;
2352
2353	struct megasas_cmd **cmd_list;
2354	struct list_head cmd_pool;
2355	/* used to sync fire the cmd to fw */
2356	spinlock_t mfi_pool_lock;
2357	/* used to sync fire the cmd to fw */
2358	spinlock_t hba_lock;
2359	/* used to synch producer, consumer ptrs in dpc */
2360	spinlock_t stream_lock;
2361	spinlock_t completion_lock;
2362	struct dma_pool *frame_dma_pool;
2363	struct dma_pool *sense_dma_pool;
2364
2365	struct megasas_evt_detail *evt_detail;
2366	dma_addr_t evt_detail_h;
2367	struct megasas_cmd *aen_cmd;
2368	struct semaphore ioctl_sem;
2369
2370	struct Scsi_Host *host;
2371
2372	wait_queue_head_t int_cmd_wait_q;
2373	wait_queue_head_t abort_cmd_wait_q;
2374
2375	struct pci_dev *pdev;
2376	u32 unique_id;
2377	u32 fw_support_ieee;
2378	u32 threshold_reply_count;
2379
2380	atomic_t fw_outstanding;
2381	atomic_t ldio_outstanding;
2382	atomic_t fw_reset_no_pci_access;
2383	atomic64_t total_io_count;
2384	atomic64_t high_iops_outstanding;
2385
2386	struct megasas_instance_template *instancet;
2387	struct tasklet_struct isr_tasklet;
2388	struct work_struct work_init;
2389	struct delayed_work fw_fault_work;
2390	struct workqueue_struct *fw_fault_work_q;
2391	char fault_handler_work_q_name[48];
2392
2393	u8 flag;
2394	u8 unload;
2395	u8 flag_ieee;
2396	u8 issuepend_done;
2397	u8 disableOnlineCtrlReset;
2398	u8 UnevenSpanSupport;
2399
2400	u8 supportmax256vd;
2401	u8 pd_list_not_supported;
2402	u16 fw_supported_vd_count;
2403	u16 fw_supported_pd_count;
2404
2405	u16 drv_supported_vd_count;
2406	u16 drv_supported_pd_count;
2407
2408	atomic_t adprecovery;
2409	unsigned long last_time;
2410	u32 mfiStatus;
2411	u32 last_seq_num;
2412
2413	struct list_head internal_reset_pending_q;
2414
2415	/* Ptr to hba specific information */
2416	void *ctrl_context;
2417	unsigned int msix_vectors;
2418	struct megasas_irq_context irq_context[MEGASAS_MAX_MSIX_QUEUES];
2419	u64 map_id;
2420	u64 pd_seq_map_id;
2421	struct megasas_cmd *map_update_cmd;
2422	struct megasas_cmd *jbod_seq_cmd;
2423	unsigned long bar;
2424	long reset_flags;
2425	struct mutex reset_mutex;
2426	struct timer_list sriov_heartbeat_timer;
2427	char skip_heartbeat_timer_del;
2428	u8 requestorId;
2429	char PlasmaFW111;
2430	char clusterId[MEGASAS_CLUSTER_ID_SIZE];
2431	u8 peerIsPresent;
2432	u8 passive;
2433	u16 throttlequeuedepth;
2434	u8 mask_interrupts;
2435	u16 max_chain_frame_sz;
2436	u8 is_imr;
2437	u8 is_rdpq;
2438	bool dev_handle;
2439	bool fw_sync_cache_support;
2440	u32 mfi_frame_size;
2441	bool msix_combined;
2442	u16 max_raid_mapsize;
2443	/* preffered count to send as LDIO irrspective of FP capable.*/
2444	u8  r1_ldio_hint_default;
2445	u32 nvme_page_size;
2446	u8 adapter_type;
2447	bool consistent_mask_64bit;
2448	bool support_nvme_passthru;
2449	bool enable_sdev_max_qd;
2450	u8 task_abort_tmo;
2451	u8 max_reset_tmo;
2452	u8 snapdump_wait_time;
2453#ifdef CONFIG_DEBUG_FS
2454	struct dentry *debugfs_root;
2455	struct dentry *raidmap_dump;
2456#endif
2457	u8 enable_fw_dev_list;
2458	bool atomic_desc_support;
2459	bool support_seqnum_jbod_fp;
2460	bool support_pci_lane_margining;
2461	u8  low_latency_index_start;
2462	int perf_mode;
2463};
2464
2465struct MR_LD_VF_MAP {
2466	u32 size;
2467	union MR_LD_REF ref;
2468	u8 ldVfCount;
2469	u8 reserved[6];
2470	u8 policy[1];
2471};
2472
2473struct MR_LD_VF_AFFILIATION {
2474	u32 size;
2475	u8 ldCount;
2476	u8 vfCount;
2477	u8 thisVf;
2478	u8 reserved[9];
2479	struct MR_LD_VF_MAP map[1];
2480};
2481
2482/* Plasma 1.11 FW backward compatibility structures */
2483#define IOV_111_OFFSET 0x7CE
2484#define MAX_VIRTUAL_FUNCTIONS 8
2485#define MR_LD_ACCESS_HIDDEN 15
2486
2487struct IOV_111 {
2488	u8 maxVFsSupported;
2489	u8 numVFsEnabled;
2490	u8 requestorId;
2491	u8 reserved[5];
2492};
2493
2494struct MR_LD_VF_MAP_111 {
2495	u8 targetId;
2496	u8 reserved[3];
2497	u8 policy[MAX_VIRTUAL_FUNCTIONS];
2498};
2499
2500struct MR_LD_VF_AFFILIATION_111 {
2501	u8 vdCount;
2502	u8 vfCount;
2503	u8 thisVf;
2504	u8 reserved[5];
2505	struct MR_LD_VF_MAP_111 map[MAX_LOGICAL_DRIVES];
2506};
2507
2508struct MR_CTRL_HB_HOST_MEM {
2509	struct {
2510		u32 fwCounter;	/* Firmware heart beat counter */
2511		struct {
2512			u32 debugmode:1; /* 1=Firmware is in debug mode.
2513					    Heart beat will not be updated. */
2514			u32 reserved:31;
2515		} debug;
2516		u32 reserved_fw[6];
2517		u32 driverCounter; /* Driver heart beat counter.  0x20 */
2518		u32 reserved_driver[7];
2519	} HB;
2520	u8 pad[0x400-0x40];
2521};
2522
2523enum {
2524	MEGASAS_HBA_OPERATIONAL			= 0,
2525	MEGASAS_ADPRESET_SM_INFAULT		= 1,
2526	MEGASAS_ADPRESET_SM_FW_RESET_SUCCESS	= 2,
2527	MEGASAS_ADPRESET_SM_OPERATIONAL		= 3,
2528	MEGASAS_HW_CRITICAL_ERROR		= 4,
2529	MEGASAS_ADPRESET_SM_POLLING		= 5,
2530	MEGASAS_ADPRESET_INPROG_SIGN		= 0xDEADDEAD,
2531};
2532
2533struct megasas_instance_template {
2534	void (*fire_cmd)(struct megasas_instance *, dma_addr_t, \
2535		u32, struct megasas_register_set __iomem *);
2536
2537	void (*enable_intr)(struct megasas_instance *);
2538	void (*disable_intr)(struct megasas_instance *);
2539
2540	int (*clear_intr)(struct megasas_instance *);
2541
2542	u32 (*read_fw_status_reg)(struct megasas_instance *);
2543	int (*adp_reset)(struct megasas_instance *, \
2544		struct megasas_register_set __iomem *);
2545	int (*check_reset)(struct megasas_instance *, \
2546		struct megasas_register_set __iomem *);
2547	irqreturn_t (*service_isr)(int irq, void *devp);
2548	void (*tasklet)(unsigned long);
2549	u32 (*init_adapter)(struct megasas_instance *);
2550	u32 (*build_and_issue_cmd) (struct megasas_instance *,
2551				    struct scsi_cmnd *);
2552	void (*issue_dcmd)(struct megasas_instance *instance,
2553			    struct megasas_cmd *cmd);
2554};
2555
2556#define MEGASAS_IS_LOGICAL(sdev)					\
2557	((sdev->channel < MEGASAS_MAX_PD_CHANNELS) ? 0 : 1)
2558
2559#define MEGASAS_IS_LUN_VALID(sdev)					\
2560	(((sdev)->lun == 0) ? 1 : 0)
2561
2562#define MEGASAS_DEV_INDEX(scp)						\
2563	(((scp->device->channel % 2) * MEGASAS_MAX_DEV_PER_CHANNEL) +	\
2564	scp->device->id)
2565
2566#define MEGASAS_PD_INDEX(scp)						\
2567	((scp->device->channel * MEGASAS_MAX_DEV_PER_CHANNEL) +		\
2568	scp->device->id)
2569
2570struct megasas_cmd {
2571
2572	union megasas_frame *frame;
2573	dma_addr_t frame_phys_addr;
2574	u8 *sense;
2575	dma_addr_t sense_phys_addr;
2576
2577	u32 index;
2578	u8 sync_cmd;
2579	u8 cmd_status_drv;
2580	u8 abort_aen;
2581	u8 retry_for_fw_reset;
2582
2583
2584	struct list_head list;
2585	struct scsi_cmnd *scmd;
2586	u8 flags;
2587
2588	struct megasas_instance *instance;
2589	union {
2590		struct {
2591			u16 smid;
2592			u16 resvd;
2593		} context;
2594		u32 frame_count;
2595	};
2596};
2597
2598#define MAX_MGMT_ADAPTERS		1024
2599#define MAX_IOCTL_SGE			16
2600
2601struct megasas_iocpacket {
2602
2603	u16 host_no;
2604	u16 __pad1;
2605	u32 sgl_off;
2606	u32 sge_count;
2607	u32 sense_off;
2608	u32 sense_len;
2609	union {
2610		u8 raw[128];
2611		struct megasas_header hdr;
2612	} frame;
2613
2614	struct iovec sgl[MAX_IOCTL_SGE];
2615
2616} __attribute__ ((packed));
2617
2618struct megasas_aen {
2619	u16 host_no;
2620	u16 __pad1;
2621	u32 seq_num;
2622	u32 class_locale_word;
2623} __attribute__ ((packed));
2624
2625#ifdef CONFIG_COMPAT
2626struct compat_megasas_iocpacket {
2627	u16 host_no;
2628	u16 __pad1;
2629	u32 sgl_off;
2630	u32 sge_count;
2631	u32 sense_off;
2632	u32 sense_len;
2633	union {
2634		u8 raw[128];
2635		struct megasas_header hdr;
2636	} frame;
2637	struct compat_iovec sgl[MAX_IOCTL_SGE];
2638} __attribute__ ((packed));
2639
2640#define MEGASAS_IOC_FIRMWARE32	_IOWR('M', 1, struct compat_megasas_iocpacket)
2641#endif
2642
2643#define MEGASAS_IOC_FIRMWARE	_IOWR('M', 1, struct megasas_iocpacket)
2644#define MEGASAS_IOC_GET_AEN	_IOW('M', 3, struct megasas_aen)
2645
2646struct megasas_mgmt_info {
2647
2648	u16 count;
2649	struct megasas_instance *instance[MAX_MGMT_ADAPTERS];
2650	int max_index;
2651};
2652
2653enum MEGASAS_OCR_CAUSE {
2654	FW_FAULT_OCR			= 0,
2655	SCSIIO_TIMEOUT_OCR		= 1,
2656	MFI_IO_TIMEOUT_OCR		= 2,
2657};
2658
2659enum DCMD_RETURN_STATUS {
2660	DCMD_SUCCESS    = 0x00,
2661	DCMD_TIMEOUT    = 0x01,
2662	DCMD_FAILED     = 0x02,
2663	DCMD_BUSY       = 0x03,
2664	DCMD_INIT       = 0xff,
2665};
2666
2667u8
2668MR_BuildRaidContext(struct megasas_instance *instance,
2669		    struct IO_REQUEST_INFO *io_info,
2670		    struct RAID_CONTEXT *pRAID_Context,
2671		    struct MR_DRV_RAID_MAP_ALL *map, u8 **raidLUN);
2672u16 MR_TargetIdToLdGet(u32 ldTgtId, struct MR_DRV_RAID_MAP_ALL *map);
2673struct MR_LD_RAID *MR_LdRaidGet(u32 ld, struct MR_DRV_RAID_MAP_ALL *map);
2674u16 MR_ArPdGet(u32 ar, u32 arm, struct MR_DRV_RAID_MAP_ALL *map);
2675u16 MR_LdSpanArrayGet(u32 ld, u32 span, struct MR_DRV_RAID_MAP_ALL *map);
2676__le16 MR_PdDevHandleGet(u32 pd, struct MR_DRV_RAID_MAP_ALL *map);
2677u16 MR_GetLDTgtId(u32 ld, struct MR_DRV_RAID_MAP_ALL *map);
2678
2679__le16 get_updated_dev_handle(struct megasas_instance *instance,
2680			      struct LD_LOAD_BALANCE_INFO *lbInfo,
2681			      struct IO_REQUEST_INFO *in_info,
2682			      struct MR_DRV_RAID_MAP_ALL *drv_map);
2683void mr_update_load_balance_params(struct MR_DRV_RAID_MAP_ALL *map,
2684	struct LD_LOAD_BALANCE_INFO *lbInfo);
2685int megasas_get_ctrl_info(struct megasas_instance *instance);
2686/* PD sequence */
2687int
2688megasas_sync_pd_seq_num(struct megasas_instance *instance, bool pend);
2689void megasas_set_dynamic_target_properties(struct scsi_device *sdev,
2690					   bool is_target_prop);
2691int megasas_get_target_prop(struct megasas_instance *instance,
2692			    struct scsi_device *sdev);
2693void megasas_get_snapdump_properties(struct megasas_instance *instance);
2694
2695int megasas_set_crash_dump_params(struct megasas_instance *instance,
2696	u8 crash_buf_state);
2697void megasas_free_host_crash_buffer(struct megasas_instance *instance);
2698
2699void megasas_return_cmd_fusion(struct megasas_instance *instance,
2700	struct megasas_cmd_fusion *cmd);
2701int megasas_issue_blocked_cmd(struct megasas_instance *instance,
2702	struct megasas_cmd *cmd, int timeout);
2703void __megasas_return_cmd(struct megasas_instance *instance,
2704	struct megasas_cmd *cmd);
2705
2706void megasas_return_mfi_mpt_pthr(struct megasas_instance *instance,
2707	struct megasas_cmd *cmd_mfi, struct megasas_cmd_fusion *cmd_fusion);
2708int megasas_cmd_type(struct scsi_cmnd *cmd);
2709void megasas_setup_jbod_map(struct megasas_instance *instance);
2710
2711void megasas_update_sdev_properties(struct scsi_device *sdev);
2712int megasas_reset_fusion(struct Scsi_Host *shost, int reason);
2713int megasas_task_abort_fusion(struct scsi_cmnd *scmd);
2714int megasas_reset_target_fusion(struct scsi_cmnd *scmd);
2715u32 mega_mod64(u64 dividend, u32 divisor);
2716int megasas_alloc_fusion_context(struct megasas_instance *instance);
2717void megasas_free_fusion_context(struct megasas_instance *instance);
2718int megasas_fusion_start_watchdog(struct megasas_instance *instance);
2719void megasas_fusion_stop_watchdog(struct megasas_instance *instance);
2720
2721void megasas_set_dma_settings(struct megasas_instance *instance,
2722			      struct megasas_dcmd_frame *dcmd,
2723			      dma_addr_t dma_addr, u32 dma_len);
2724int megasas_adp_reset_wait_for_ready(struct megasas_instance *instance,
2725				     bool do_adp_reset,
2726				     int ocr_context);
2727int megasas_irqpoll(struct irq_poll *irqpoll, int budget);
2728void megasas_dump_fusion_io(struct scsi_cmnd *scmd);
2729u32 megasas_readl(struct megasas_instance *instance,
2730		  const volatile void __iomem *addr);
2731struct megasas_cmd *megasas_get_cmd(struct megasas_instance *instance);
2732void megasas_return_cmd(struct megasas_instance *instance,
2733			struct megasas_cmd *cmd);
2734int megasas_issue_polled(struct megasas_instance *instance,
2735			 struct megasas_cmd *cmd);
2736void megaraid_sas_kill_hba(struct megasas_instance *instance);
2737void megasas_check_and_restore_queue_depth(struct megasas_instance *instance);
2738void megasas_start_timer(struct megasas_instance *instance);
2739int megasas_sriov_start_heartbeat(struct megasas_instance *instance,
2740				  int initial);
2741int megasas_alloc_cmds(struct megasas_instance *instance);
2742void megasas_free_cmds(struct megasas_instance *instance);
2743
2744void megasas_init_debugfs(void);
2745void megasas_exit_debugfs(void);
2746void megasas_setup_debugfs(struct megasas_instance *instance);
2747void megasas_destroy_debugfs(struct megasas_instance *instance);
2748
2749#endif				/*LSI_MEGARAID_SAS_H */
2750