]> Git Repo - linux.git/blob - drivers/scsi/mpi3mr/mpi3mr.h
x86/kaslr: Expose and use the end of the physical memory address space
[linux.git] / drivers / scsi / mpi3mr / mpi3mr.h
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * Driver for Broadcom MPI3 Storage Controllers
4  *
5  * Copyright (C) 2017-2023 Broadcom Inc.
6  *  (mailto: [email protected])
7  *
8  */
9
10 #ifndef MPI3MR_H_INCLUDED
11 #define MPI3MR_H_INCLUDED
12
13 #include <linux/blkdev.h>
14 #include <linux/blk-mq.h>
15 #include <linux/blk-mq-pci.h>
16 #include <linux/delay.h>
17 #include <linux/dmapool.h>
18 #include <linux/errno.h>
19 #include <linux/init.h>
20 #include <linux/io.h>
21 #include <linux/interrupt.h>
22 #include <linux/kernel.h>
23 #include <linux/miscdevice.h>
24 #include <linux/module.h>
25 #include <linux/pci.h>
26 #include <linux/aer.h>
27 #include <linux/poll.h>
28 #include <linux/sched.h>
29 #include <linux/slab.h>
30 #include <linux/types.h>
31 #include <linux/uaccess.h>
32 #include <linux/utsname.h>
33 #include <linux/workqueue.h>
34 #include <asm/unaligned.h>
35 #include <scsi/scsi.h>
36 #include <scsi/scsi_cmnd.h>
37 #include <scsi/scsi_dbg.h>
38 #include <scsi/scsi_device.h>
39 #include <scsi/scsi_host.h>
40 #include <scsi/scsi_tcq.h>
41 #include <uapi/scsi/scsi_bsg_mpi3mr.h>
42 #include <scsi/scsi_transport_sas.h>
43
44 #include "mpi/mpi30_transport.h"
45 #include "mpi/mpi30_cnfg.h"
46 #include "mpi/mpi30_image.h"
47 #include "mpi/mpi30_init.h"
48 #include "mpi/mpi30_ioc.h"
49 #include "mpi/mpi30_sas.h"
50 #include "mpi/mpi30_pci.h"
51 #include "mpi/mpi30_tool.h"
52 #include "mpi3mr_debug.h"
53
54 /* Global list and lock for storing multiple adapters managed by the driver */
55 extern spinlock_t mrioc_list_lock;
56 extern struct list_head mrioc_list;
57 extern int prot_mask;
58 extern atomic64_t event_counter;
59
60 #define MPI3MR_DRIVER_VERSION   "8.9.1.0.51"
61 #define MPI3MR_DRIVER_RELDATE   "29-May-2024"
62
63 #define MPI3MR_DRIVER_NAME      "mpi3mr"
64 #define MPI3MR_DRIVER_LICENSE   "GPL"
65 #define MPI3MR_DRIVER_AUTHOR    "Broadcom Inc. <[email protected]>"
66 #define MPI3MR_DRIVER_DESC      "MPI3 Storage Controller Device Driver"
67
68 #define MPI3MR_NAME_LENGTH      64
69 #define IOCNAME                 "%s: "
70
71 #define MPI3MR_DEFAULT_MAX_IO_SIZE      (1 * 1024 * 1024)
72
73 /* Definitions for internal SGL and Chain SGL buffers */
74 #define MPI3MR_PAGE_SIZE_4K             4096
75 #define MPI3MR_DEFAULT_SGL_ENTRIES      256
76 #define MPI3MR_MAX_SGL_ENTRIES          2048
77
78 /* Definitions for MAX values for shost */
79 #define MPI3MR_MAX_CMDS_LUN     128
80 #define MPI3MR_MAX_CDB_LENGTH   32
81
82 /* Admin queue management definitions */
83 #define MPI3MR_ADMIN_REQ_Q_SIZE         (2 * MPI3MR_PAGE_SIZE_4K)
84 #define MPI3MR_ADMIN_REPLY_Q_SIZE       (4 * MPI3MR_PAGE_SIZE_4K)
85 #define MPI3MR_ADMIN_REQ_FRAME_SZ       128
86 #define MPI3MR_ADMIN_REPLY_FRAME_SZ     16
87
88 /* Operational queue management definitions */
89 #define MPI3MR_OP_REQ_Q_QD              512
90 #define MPI3MR_OP_REP_Q_QD              1024
91 #define MPI3MR_OP_REP_Q_QD4K            4096
92 #define MPI3MR_OP_REQ_Q_SEG_SIZE        4096
93 #define MPI3MR_OP_REP_Q_SEG_SIZE        4096
94 #define MPI3MR_MAX_SEG_LIST_SIZE        4096
95
96 /* Reserved Host Tag definitions */
97 #define MPI3MR_HOSTTAG_INVALID          0xFFFF
98 #define MPI3MR_HOSTTAG_INITCMDS         1
99 #define MPI3MR_HOSTTAG_BSG_CMDS         2
100 #define MPI3MR_HOSTTAG_PEL_ABORT        3
101 #define MPI3MR_HOSTTAG_PEL_WAIT         4
102 #define MPI3MR_HOSTTAG_BLK_TMS          5
103 #define MPI3MR_HOSTTAG_CFG_CMDS         6
104 #define MPI3MR_HOSTTAG_TRANSPORT_CMDS   7
105
106 #define MPI3MR_NUM_DEVRMCMD             16
107 #define MPI3MR_HOSTTAG_DEVRMCMD_MIN     (MPI3MR_HOSTTAG_TRANSPORT_CMDS + 1)
108 #define MPI3MR_HOSTTAG_DEVRMCMD_MAX     (MPI3MR_HOSTTAG_DEVRMCMD_MIN + \
109                                                 MPI3MR_NUM_DEVRMCMD - 1)
110
111 #define MPI3MR_INTERNAL_CMDS_RESVD      MPI3MR_HOSTTAG_DEVRMCMD_MAX
112 #define MPI3MR_NUM_EVTACKCMD            4
113 #define MPI3MR_HOSTTAG_EVTACKCMD_MIN    (MPI3MR_HOSTTAG_DEVRMCMD_MAX + 1)
114 #define MPI3MR_HOSTTAG_EVTACKCMD_MAX    (MPI3MR_HOSTTAG_EVTACKCMD_MIN + \
115                                         MPI3MR_NUM_EVTACKCMD - 1)
116
117 /* Reduced resource count definition for crash kernel */
118 #define MPI3MR_HOST_IOS_KDUMP           128
119
120 /* command/controller interaction timeout definitions in seconds */
121 #define MPI3MR_INTADMCMD_TIMEOUT                60
122 #define MPI3MR_PORTENABLE_TIMEOUT               300
123 #define MPI3MR_PORTENABLE_POLL_INTERVAL         5
124 #define MPI3MR_ABORTTM_TIMEOUT                  60
125 #define MPI3MR_RESETTM_TIMEOUT                  60
126 #define MPI3MR_RESET_HOST_IOWAIT_TIMEOUT        5
127 #define MPI3MR_TSUPDATE_INTERVAL                900
128 #define MPI3MR_DEFAULT_SHUTDOWN_TIME            120
129 #define MPI3MR_RAID_ERRREC_RESET_TIMEOUT        180
130 #define MPI3MR_PREPARE_FOR_RESET_TIMEOUT        180
131 #define MPI3MR_RESET_ACK_TIMEOUT                30
132 #define MPI3MR_MUR_TIMEOUT                      120
133 #define MPI3MR_RESET_TIMEOUT                    510
134
135 #define MPI3MR_WATCHDOG_INTERVAL                1000 /* in milli seconds */
136
137 #define MPI3MR_DEFAULT_CFG_PAGE_SZ              1024 /* in bytes */
138
139 #define MPI3MR_RESET_TOPOLOGY_SETTLE_TIME       10
140
141 #define MPI3MR_SCMD_TIMEOUT    (60 * HZ)
142 #define MPI3MR_EH_SCMD_TIMEOUT (60 * HZ)
143
144 /* Internal admin command state definitions*/
145 #define MPI3MR_CMD_NOTUSED      0x8000
146 #define MPI3MR_CMD_COMPLETE     0x0001
147 #define MPI3MR_CMD_PENDING      0x0002
148 #define MPI3MR_CMD_REPLY_VALID  0x0004
149 #define MPI3MR_CMD_RESET        0x0008
150
151 /* Definitions for Event replies and sense buffer allocated per controller */
152 #define MPI3MR_NUM_EVT_REPLIES  64
153 #define MPI3MR_SENSE_BUF_SZ     256
154 #define MPI3MR_SENSEBUF_FACTOR  3
155 #define MPI3MR_CHAINBUF_FACTOR  3
156 #define MPI3MR_CHAINBUFDIX_FACTOR       2
157
158 /* Invalid target device handle */
159 #define MPI3MR_INVALID_DEV_HANDLE       0xFFFF
160
161 /* Controller Reset related definitions */
162 #define MPI3MR_HOSTDIAG_UNLOCK_RETRY_COUNT      5
163 #define MPI3MR_MAX_RESET_RETRY_COUNT            3
164
165 /* ResponseCode definitions */
166 #define MPI3MR_RI_MASK_RESPCODE         (0x000000FF)
167 #define MPI3MR_RSP_IO_QUEUED_ON_IOC \
168                         MPI3_SCSITASKMGMT_RSPCODE_IO_QUEUED_ON_IOC
169
170 #define MPI3MR_DEFAULT_MDTS     (128 * 1024)
171 #define MPI3MR_DEFAULT_PGSZEXP         (12)
172
173 /* Command retry count definitions */
174 #define MPI3MR_DEV_RMHS_RETRY_COUNT 3
175 #define MPI3MR_PEL_RETRY_COUNT 3
176
177 /* Default target device queue depth */
178 #define MPI3MR_DEFAULT_SDEV_QD  32
179
180 /* Definitions for Threaded IRQ poll*/
181 #define MPI3MR_IRQ_POLL_SLEEP                   2
182 #define MPI3MR_IRQ_POLL_TRIGGER_IOCOUNT         8
183
184 /* Definitions for the controller security status*/
185 #define MPI3MR_CTLR_SECURITY_STATUS_MASK        0x0C
186 #define MPI3MR_CTLR_SECURE_DBG_STATUS_MASK      0x02
187
188 #define MPI3MR_INVALID_DEVICE                   0x00
189 #define MPI3MR_CONFIG_SECURE_DEVICE             0x04
190 #define MPI3MR_HARD_SECURE_DEVICE               0x08
191 #define MPI3MR_TAMPERED_DEVICE                  0x0C
192
193 #define MPI3MR_DEFAULT_HDB_MAX_SZ       (4 * 1024 * 1024)
194 #define MPI3MR_DEFAULT_HDB_DEC_SZ       (1 * 1024 * 1024)
195 #define MPI3MR_DEFAULT_HDB_MIN_SZ       (2 * 1024 * 1024)
196 #define MPI3MR_MAX_NUM_HDB      2
197
198 #define MPI3MR_HDB_TRIGGER_TYPE_UNKNOWN         0
199 #define MPI3MR_HDB_TRIGGER_TYPE_FAULT           1
200 #define MPI3MR_HDB_TRIGGER_TYPE_ELEMENT         2
201 #define MPI3MR_HDB_TRIGGER_TYPE_GLOBAL          3
202 #define MPI3MR_HDB_TRIGGER_TYPE_SOFT_RESET      4
203 #define MPI3MR_HDB_TRIGGER_TYPE_FW_RELEASED     5
204
205 #define MPI3MR_HDB_REFRESH_TYPE_RESERVED       0
206 #define MPI3MR_HDB_REFRESH_TYPE_CURRENT                1
207 #define MPI3MR_HDB_REFRESH_TYPE_DEFAULT                2
208 #define MPI3MR_HDB_HDB_REFRESH_TYPE_PERSISTENT 3
209
210 #define MPI3MR_DEFAULT_HDB_SZ  (4 * 1024 * 1024)
211 #define MPI3MR_MAX_NUM_HDB     2
212
213 #define MPI3MR_HDB_QUERY_ELEMENT_TRIGGER_FORMAT_INDEX   0
214 #define MPI3MR_HDB_QUERY_ELEMENT_TRIGGER_FORMAT_DATA    1
215
216
217 /* SGE Flag definition */
218 #define MPI3MR_SGEFLAGS_SYSTEM_SIMPLE_END_OF_LIST \
219         (MPI3_SGE_FLAGS_ELEMENT_TYPE_SIMPLE | MPI3_SGE_FLAGS_DLAS_SYSTEM | \
220         MPI3_SGE_FLAGS_END_OF_LIST)
221
222 /* MSI Index from Reply Queue Index */
223 #define REPLY_QUEUE_IDX_TO_MSIX_IDX(qidx, offset)       (qidx + offset)
224
225 /*
226  * Maximum data transfer size definitions for management
227  * application commands
228  */
229 #define MPI3MR_MAX_APP_XFER_SIZE        (1 * 1024 * 1024)
230 #define MPI3MR_MAX_APP_XFER_SEGMENTS    512
231 /*
232  * 2048 sectors are for data buffers and additional 512 sectors for
233  * other buffers
234  */
235 #define MPI3MR_MAX_APP_XFER_SECTORS     (2048 + 512)
236
237 #define MPI3MR_WRITE_SAME_MAX_LEN_256_BLKS 256
238 #define MPI3MR_WRITE_SAME_MAX_LEN_2048_BLKS 2048
239
240 #define MPI3MR_DRIVER_EVENT_PROCESS_TRIGGER    (0xFFFD)
241
242 /**
243  * struct mpi3mr_nvme_pt_sge -  Structure to store SGEs for NVMe
244  * Encapsulated commands.
245  *
246  * @base_addr: Physical address
247  * @length: SGE length
248  * @rsvd: Reserved
249  * @rsvd1: Reserved
250  * @sub_type: sgl sub type
251  * @type: sgl type
252  */
253 struct mpi3mr_nvme_pt_sge {
254         __le64 base_addr;
255         __le32 length;
256         u16 rsvd;
257         u8 rsvd1;
258         u8 sub_type:4;
259         u8 type:4;
260 };
261
262 /**
263  * struct mpi3mr_buf_map -  local structure to
264  * track kernel and user buffers associated with an BSG
265  * structure.
266  *
267  * @bsg_buf: BSG buffer virtual address
268  * @bsg_buf_len:  BSG buffer length
269  * @kern_buf: Kernel buffer virtual address
270  * @kern_buf_len: Kernel buffer length
271  * @kern_buf_dma: Kernel buffer DMA address
272  * @data_dir: Data direction.
273  */
274 struct mpi3mr_buf_map {
275         void *bsg_buf;
276         u32 bsg_buf_len;
277         void *kern_buf;
278         u32 kern_buf_len;
279         dma_addr_t kern_buf_dma;
280         u8 data_dir;
281         u16 num_dma_desc;
282         struct dma_memory_desc *dma_desc;
283 };
284
285 /* IOC State definitions */
286 enum mpi3mr_iocstate {
287         MRIOC_STATE_READY = 1,
288         MRIOC_STATE_RESET,
289         MRIOC_STATE_FAULT,
290         MRIOC_STATE_BECOMING_READY,
291         MRIOC_STATE_RESET_REQUESTED,
292         MRIOC_STATE_UNRECOVERABLE,
293 };
294
295 /* Reset reason code definitions*/
296 enum mpi3mr_reset_reason {
297         MPI3MR_RESET_FROM_BRINGUP = 1,
298         MPI3MR_RESET_FROM_FAULT_WATCH = 2,
299         MPI3MR_RESET_FROM_APP = 3,
300         MPI3MR_RESET_FROM_EH_HOS = 4,
301         MPI3MR_RESET_FROM_TM_TIMEOUT = 5,
302         MPI3MR_RESET_FROM_APP_TIMEOUT = 6,
303         MPI3MR_RESET_FROM_MUR_FAILURE = 7,
304         MPI3MR_RESET_FROM_CTLR_CLEANUP = 8,
305         MPI3MR_RESET_FROM_CIACTIV_FAULT = 9,
306         MPI3MR_RESET_FROM_PE_TIMEOUT = 10,
307         MPI3MR_RESET_FROM_TSU_TIMEOUT = 11,
308         MPI3MR_RESET_FROM_DELREQQ_TIMEOUT = 12,
309         MPI3MR_RESET_FROM_DELREPQ_TIMEOUT = 13,
310         MPI3MR_RESET_FROM_CREATEREPQ_TIMEOUT = 14,
311         MPI3MR_RESET_FROM_CREATEREQQ_TIMEOUT = 15,
312         MPI3MR_RESET_FROM_IOCFACTS_TIMEOUT = 16,
313         MPI3MR_RESET_FROM_IOCINIT_TIMEOUT = 17,
314         MPI3MR_RESET_FROM_EVTNOTIFY_TIMEOUT = 18,
315         MPI3MR_RESET_FROM_EVTACK_TIMEOUT = 19,
316         MPI3MR_RESET_FROM_CIACTVRST_TIMER = 20,
317         MPI3MR_RESET_FROM_GETPKGVER_TIMEOUT = 21,
318         MPI3MR_RESET_FROM_PELABORT_TIMEOUT = 22,
319         MPI3MR_RESET_FROM_SYSFS = 23,
320         MPI3MR_RESET_FROM_SYSFS_TIMEOUT = 24,
321         MPI3MR_RESET_FROM_DIAG_BUFFER_POST_TIMEOUT = 25,
322         MPI3MR_RESET_FROM_DIAG_BUFFER_RELEASE_TIMEOUT = 26,
323         MPI3MR_RESET_FROM_FIRMWARE = 27,
324         MPI3MR_RESET_FROM_CFG_REQ_TIMEOUT = 29,
325         MPI3MR_RESET_FROM_SAS_TRANSPORT_TIMEOUT = 30,
326         MPI3MR_RESET_FROM_TRIGGER = 31,
327 };
328
329 #define MPI3MR_RESET_REASON_OSTYPE_LINUX        1
330 #define MPI3MR_RESET_REASON_OSTYPE_SHIFT        28
331 #define MPI3MR_RESET_REASON_IOCNUM_SHIFT        20
332
333 /* Queue type definitions */
334 enum queue_type {
335         MPI3MR_DEFAULT_QUEUE = 0,
336         MPI3MR_POLL_QUEUE,
337 };
338
339 /**
340  * struct mpi3mr_compimg_ver - replica of component image
341  * version defined in mpi30_image.h in host endianness
342  *
343  */
344 struct mpi3mr_compimg_ver {
345         u16 build_num;
346         u16 cust_id;
347         u8 ph_minor;
348         u8 ph_major;
349         u8 gen_minor;
350         u8 gen_major;
351 };
352
353 /**
354  * struct mpi3mr_ioc_facs - replica of component image version
355  * defined in mpi30_ioc.h in host endianness
356  *
357  */
358 struct mpi3mr_ioc_facts {
359         u32 ioc_capabilities;
360         struct mpi3mr_compimg_ver fw_ver;
361         u32 mpi_version;
362         u32 diag_trace_sz;
363         u32 diag_fw_sz;
364         u32 diag_drvr_sz;
365         u16 max_reqs;
366         u16 product_id;
367         u16 op_req_sz;
368         u16 reply_sz;
369         u16 exceptions;
370         u16 max_perids;
371         u16 max_pds;
372         u16 max_sasexpanders;
373         u32 max_data_length;
374         u16 max_sasinitiators;
375         u16 max_enclosures;
376         u16 max_pcie_switches;
377         u16 max_nvme;
378         u16 max_vds;
379         u16 max_hpds;
380         u16 max_advhpds;
381         u16 max_raid_pds;
382         u16 min_devhandle;
383         u16 max_devhandle;
384         u16 max_op_req_q;
385         u16 max_op_reply_q;
386         u16 shutdown_timeout;
387         u8 ioc_num;
388         u8 who_init;
389         u16 max_msix_vectors;
390         u8 personality;
391         u8 dma_mask;
392         u8 protocol_flags;
393         u8 sge_mod_mask;
394         u8 sge_mod_value;
395         u8 sge_mod_shift;
396         u8 max_dev_per_tg;
397         u16 max_io_throttle_group;
398         u16 io_throttle_data_length;
399         u16 io_throttle_low;
400         u16 io_throttle_high;
401
402 };
403
404 /**
405  * struct segments - memory descriptor structure to store
406  * virtual and dma addresses for operational queue segments.
407  *
408  * @segment: virtual address
409  * @segment_dma: dma address
410  */
411 struct segments {
412         void *segment;
413         dma_addr_t segment_dma;
414 };
415
416 /**
417  * struct op_req_qinfo -  Operational Request Queue Information
418  *
419  * @ci: consumer index
420  * @pi: producer index
421  * @num_request: Maximum number of entries in the queue
422  * @qid: Queue Id starting from 1
423  * @reply_qid: Associated reply queue Id
424  * @num_segments: Number of discontiguous memory segments
425  * @segment_qd: Depth of each segments
426  * @q_lock: Concurrent queue access lock
427  * @q_segments: Segment descriptor pointer
428  * @q_segment_list: Segment list base virtual address
429  * @q_segment_list_dma: Segment list base DMA address
430  */
431 struct op_req_qinfo {
432         u16 ci;
433         u16 pi;
434         u16 num_requests;
435         u16 qid;
436         u16 reply_qid;
437         u16 num_segments;
438         u16 segment_qd;
439         spinlock_t q_lock;
440         struct segments *q_segments;
441         void *q_segment_list;
442         dma_addr_t q_segment_list_dma;
443 };
444
445 /**
446  * struct op_reply_qinfo -  Operational Reply Queue Information
447  *
448  * @ci: consumer index
449  * @qid: Queue Id starting from 1
450  * @num_replies: Maximum number of entries in the queue
451  * @num_segments: Number of discontiguous memory segments
452  * @segment_qd: Depth of each segments
453  * @q_segments: Segment descriptor pointer
454  * @q_segment_list: Segment list base virtual address
455  * @q_segment_list_dma: Segment list base DMA address
456  * @ephase: Expected phased identifier for the reply queue
457  * @pend_ios: Number of IOs pending in HW for this queue
458  * @enable_irq_poll: Flag to indicate polling is enabled
459  * @in_use: Queue is handled by poll/ISR
460  * @qtype: Type of queue (types defined in enum queue_type)
461  */
462 struct op_reply_qinfo {
463         u16 ci;
464         u16 qid;
465         u16 num_replies;
466         u16 num_segments;
467         u16 segment_qd;
468         struct segments *q_segments;
469         void *q_segment_list;
470         dma_addr_t q_segment_list_dma;
471         u8 ephase;
472         atomic_t pend_ios;
473         bool enable_irq_poll;
474         atomic_t in_use;
475         enum queue_type qtype;
476 };
477
478 /**
479  * struct mpi3mr_intr_info -  Interrupt cookie information
480  *
481  * @mrioc: Adapter instance reference
482  * @os_irq: irq number
483  * @msix_index: MSIx index
484  * @op_reply_q: Associated operational reply queue
485  * @name: Dev name for the irq claiming device
486  */
487 struct mpi3mr_intr_info {
488         struct mpi3mr_ioc *mrioc;
489         int os_irq;
490         u16 msix_index;
491         struct op_reply_qinfo *op_reply_q;
492         char name[MPI3MR_NAME_LENGTH];
493 };
494
495 /**
496  * struct mpi3mr_throttle_group_info - Throttle group info
497  *
498  * @io_divert: Flag indicates io divert is on or off for the TG
499  * @need_qd_reduction: Flag to indicate QD reduction is needed
500  * @qd_reduction: Queue Depth reduction in units of 10%
501  * @fw_qd: QueueDepth value reported by the firmware
502  * @modified_qd: Modified QueueDepth value due to throttling
503  * @id: Throttle Group ID.
504  * @high: High limit to turn on throttling in 512 byte blocks
505  * @low: Low limit to turn off throttling in 512 byte blocks
506  * @pend_large_data_sz: Counter to track pending large data
507  */
508 struct mpi3mr_throttle_group_info {
509         u8 io_divert;
510         u8 need_qd_reduction;
511         u8 qd_reduction;
512         u16 fw_qd;
513         u16 modified_qd;
514         u16 id;
515         u32 high;
516         u32 low;
517         atomic_t pend_large_data_sz;
518 };
519
520 /* HBA port flags */
521 #define MPI3MR_HBA_PORT_FLAG_DIRTY      0x01
522 #define MPI3MR_HBA_PORT_FLAG_NEW       0x02
523
524 /* IOCTL data transfer sge*/
525 #define MPI3MR_NUM_IOCTL_SGE            256
526 #define MPI3MR_IOCTL_SGE_SIZE           (8 * 1024)
527
528 /**
529  * struct mpi3mr_hba_port - HBA's port information
530  * @port_id: Port number
531  * @flags: HBA port flags
532  */
533 struct mpi3mr_hba_port {
534         struct list_head list;
535         u8 port_id;
536         u8 flags;
537 };
538
539 /**
540  * struct mpi3mr_sas_port - Internal SAS port information
541  * @port_list: List of ports belonging to a SAS node
542  * @num_phys: Number of phys associated with port
543  * @marked_responding: used while refresing the sas ports
544  * @lowest_phy: lowest phy ID of current sas port
545  * @phy_mask: phy_mask of current sas port
546  * @hba_port: HBA port entry
547  * @remote_identify: Attached device identification
548  * @rphy: SAS transport layer rphy object
549  * @port: SAS transport layer port object
550  * @phy_list: mpi3mr_sas_phy objects belonging to this port
551  */
552 struct mpi3mr_sas_port {
553         struct list_head port_list;
554         u8 num_phys;
555         u8 marked_responding;
556         int lowest_phy;
557         u64 phy_mask;
558         struct mpi3mr_hba_port *hba_port;
559         struct sas_identify remote_identify;
560         struct sas_rphy *rphy;
561         struct sas_port *port;
562         struct list_head phy_list;
563 };
564
565 /**
566  * struct mpi3mr_sas_phy - Internal SAS Phy information
567  * @port_siblings: List of phys belonging to a port
568  * @identify: Phy identification
569  * @remote_identify: Attached device identification
570  * @phy: SAS transport layer Phy object
571  * @phy_id: Unique phy id within a port
572  * @handle: Firmware device handle for this phy
573  * @attached_handle: Firmware device handle for attached device
574  * @phy_belongs_to_port: Flag to indicate phy belongs to port
575    @hba_port: HBA port entry
576  */
577 struct mpi3mr_sas_phy {
578         struct list_head port_siblings;
579         struct sas_identify identify;
580         struct sas_identify remote_identify;
581         struct sas_phy *phy;
582         u8 phy_id;
583         u16 handle;
584         u16 attached_handle;
585         u8 phy_belongs_to_port;
586         struct mpi3mr_hba_port *hba_port;
587 };
588
589 /**
590  * struct mpi3mr_sas_node - SAS host/expander information
591  * @list: List of sas nodes in a controller
592  * @parent_dev: Parent device class
593  * @num_phys: Number phys belonging to sas_node
594  * @sas_address: SAS address of sas_node
595  * @handle: Firmware device handle for this sas_host/expander
596  * @sas_address_parent: SAS address of parent expander or host
597  * @enclosure_handle: Firmware handle of enclosure of this node
598  * @device_info: Capabilities of this sas_host/expander
599  * @non_responding: used to refresh the expander devices during reset
600  * @host_node: Flag to indicate this is a host_node
601  * @hba_port: HBA port entry
602  * @phy: A list of phys that make up this sas_host/expander
603  * @sas_port_list: List of internal ports of this node
604  * @rphy: sas_rphy object of this expander node
605  */
606 struct mpi3mr_sas_node {
607         struct list_head list;
608         struct device *parent_dev;
609         u8 num_phys;
610         u64 sas_address;
611         u16 handle;
612         u64 sas_address_parent;
613         u16 enclosure_handle;
614         u64 enclosure_logical_id;
615         u8 non_responding;
616         u8 host_node;
617         struct mpi3mr_hba_port *hba_port;
618         struct mpi3mr_sas_phy *phy;
619         struct list_head sas_port_list;
620         struct sas_rphy *rphy;
621 };
622
623 /**
624  * struct mpi3mr_enclosure_node - enclosure information
625  * @list: List of enclosures
626  * @pg0: Enclosure page 0;
627  */
628 struct mpi3mr_enclosure_node {
629         struct list_head list;
630         struct mpi3_enclosure_page0 pg0;
631 };
632
633 /**
634  * struct tgt_dev_sas_sata - SAS/SATA device specific
635  * information cached from firmware given data
636  *
637  * @sas_address: World wide unique SAS address
638  * @sas_address_parent: Sas address of parent expander or host
639  * @dev_info: Device information bits
640  * @phy_id: Phy identifier provided in device page 0
641  * @attached_phy_id: Attached phy identifier provided in device page 0
642  * @sas_transport_attached: Is this device exposed to transport
643  * @pend_sas_rphy_add: Flag to check device is in process of add
644  * @hba_port: HBA port entry
645  * @rphy: SAS transport layer rphy object
646  */
647 struct tgt_dev_sas_sata {
648         u64 sas_address;
649         u64 sas_address_parent;
650         u16 dev_info;
651         u8 phy_id;
652         u8 attached_phy_id;
653         u8 sas_transport_attached;
654         u8 pend_sas_rphy_add;
655         struct mpi3mr_hba_port *hba_port;
656         struct sas_rphy *rphy;
657 };
658
659 /**
660  * struct tgt_dev_pcie - PCIe device specific information cached
661  * from firmware given data
662  *
663  * @mdts: Maximum data transfer size
664  * @capb: Device capabilities
665  * @pgsz: Device page size
666  * @abort_to: Timeout for abort TM
667  * @reset_to: Timeout for Target/LUN reset TM
668  * @dev_info: Device information bits
669  */
670 struct tgt_dev_pcie {
671         u32 mdts;
672         u16 capb;
673         u8 pgsz;
674         u8 abort_to;
675         u8 reset_to;
676         u16 dev_info;
677 };
678
679 /**
680  * struct tgt_dev_vd - virtual device specific information
681  * cached from firmware given data
682  *
683  * @state: State of the VD
684  * @tg_qd_reduction: Queue Depth reduction in units of 10%
685  * @tg_id: VDs throttle group ID
686  * @high: High limit to turn on throttling in 512 byte blocks
687  * @low: Low limit to turn off throttling in 512 byte blocks
688  * @tg: Pointer to throttle group info
689  */
690 struct tgt_dev_vd {
691         u8 state;
692         u8 tg_qd_reduction;
693         u16 tg_id;
694         u32 tg_high;
695         u32 tg_low;
696         struct mpi3mr_throttle_group_info *tg;
697 };
698
699
700 /**
701  * union _form_spec_inf - union of device specific information
702  */
703 union _form_spec_inf {
704         struct tgt_dev_sas_sata sas_sata_inf;
705         struct tgt_dev_pcie pcie_inf;
706         struct tgt_dev_vd vd_inf;
707 };
708
709 enum mpi3mr_dev_state {
710         MPI3MR_DEV_CREATED = 1,
711         MPI3MR_DEV_REMOVE_HS_STARTED = 2,
712         MPI3MR_DEV_DELETED = 3,
713 };
714
715 /**
716  * struct mpi3mr_tgt_dev - target device data structure
717  *
718  * @list: List pointer
719  * @starget: Scsi_target pointer
720  * @dev_handle: FW device handle
721  * @parent_handle: FW parent device handle
722  * @slot: Slot number
723  * @encl_handle: FW enclosure handle
724  * @perst_id: FW assigned Persistent ID
725  * @devpg0_flag: Device Page0 flag
726  * @dev_type: SAS/SATA/PCIE device type
727  * @is_hidden: Should be exposed to upper layers or not
728  * @host_exposed: Already exposed to host or not
729  * @io_unit_port: IO Unit port ID
730  * @non_stl: Is this device not to be attached with SAS TL
731  * @io_throttle_enabled: I/O throttling needed or not
732  * @wslen: Write same max length
733  * @q_depth: Device specific Queue Depth
734  * @wwid: World wide ID
735  * @enclosure_logical_id: Enclosure logical identifier
736  * @dev_spec: Device type specific information
737  * @ref_count: Reference count
738  * @state: device state
739  */
740 struct mpi3mr_tgt_dev {
741         struct list_head list;
742         struct scsi_target *starget;
743         u16 dev_handle;
744         u16 parent_handle;
745         u16 slot;
746         u16 encl_handle;
747         u16 perst_id;
748         u16 devpg0_flag;
749         u8 dev_type;
750         u8 is_hidden;
751         u8 host_exposed;
752         u8 io_unit_port;
753         u8 non_stl;
754         u8 io_throttle_enabled;
755         u16 wslen;
756         u16 q_depth;
757         u64 wwid;
758         u64 enclosure_logical_id;
759         union _form_spec_inf dev_spec;
760         struct kref ref_count;
761         enum mpi3mr_dev_state state;
762 };
763
764 /**
765  * mpi3mr_tgtdev_get - k reference incrementor
766  * @s: Target device reference
767  *
768  * Increment target device reference count.
769  */
770 static inline void mpi3mr_tgtdev_get(struct mpi3mr_tgt_dev *s)
771 {
772         kref_get(&s->ref_count);
773 }
774
775 /**
776  * mpi3mr_free_tgtdev - target device memory dealloctor
777  * @r: k reference pointer of the target device
778  *
779  * Free target device memory when no reference.
780  */
781 static inline void mpi3mr_free_tgtdev(struct kref *r)
782 {
783         kfree(container_of(r, struct mpi3mr_tgt_dev, ref_count));
784 }
785
786 /**
787  * mpi3mr_tgtdev_put - k reference decrementor
788  * @s: Target device reference
789  *
790  * Decrement target device reference count.
791  */
792 static inline void mpi3mr_tgtdev_put(struct mpi3mr_tgt_dev *s)
793 {
794         kref_put(&s->ref_count, mpi3mr_free_tgtdev);
795 }
796
797
798 /**
799  * struct mpi3mr_stgt_priv_data - SCSI target private structure
800  *
801  * @starget: Scsi_target pointer
802  * @dev_handle: FW device handle
803  * @perst_id: FW assigned Persistent ID
804  * @num_luns: Number of Logical Units
805  * @block_io: I/O blocked to the device or not
806  * @dev_removed: Device removed in the Firmware
807  * @dev_removedelay: Device is waiting to be removed in FW
808  * @dev_type: Device type
809  * @dev_nvme_dif: Device is NVMe DIF enabled
810  * @wslen: Write same max length
811  * @io_throttle_enabled: I/O throttling needed or not
812  * @io_divert: Flag indicates io divert is on or off for the dev
813  * @throttle_group: Pointer to throttle group info
814  * @tgt_dev: Internal target device pointer
815  * @pend_count: Counter to track pending I/Os during error
816  *              handling
817  */
818 struct mpi3mr_stgt_priv_data {
819         struct scsi_target *starget;
820         u16 dev_handle;
821         u16 perst_id;
822         u32 num_luns;
823         atomic_t block_io;
824         u8 dev_removed;
825         u8 dev_removedelay;
826         u8 dev_type;
827         u8 dev_nvme_dif;
828         u16 wslen;
829         u8 io_throttle_enabled;
830         u8 io_divert;
831         struct mpi3mr_throttle_group_info *throttle_group;
832         struct mpi3mr_tgt_dev *tgt_dev;
833         u32 pend_count;
834 };
835
836 /**
837  * struct mpi3mr_stgt_priv_data - SCSI device private structure
838  *
839  * @tgt_priv_data: Scsi_target private data pointer
840  * @lun_id: LUN ID of the device
841  * @ncq_prio_enable: NCQ priority enable for SATA device
842  * @pend_count: Counter to track pending I/Os during error
843  *              handling
844  * @wslen: Write same max length
845  */
846 struct mpi3mr_sdev_priv_data {
847         struct mpi3mr_stgt_priv_data *tgt_priv_data;
848         u32 lun_id;
849         u8 ncq_prio_enable;
850         u32 pend_count;
851         u16 wslen;
852 };
853
854 /**
855  * struct mpi3mr_drv_cmd - Internal command tracker
856  *
857  * @mutex: Command mutex
858  * @done: Completeor for wakeup
859  * @reply: Firmware reply for internal commands
860  * @sensebuf: Sensebuf for SCSI IO commands
861  * @iou_rc: IO Unit control reason code
862  * @state: Command State
863  * @dev_handle: Firmware handle for device specific commands
864  * @ioc_status: IOC status from the firmware
865  * @ioc_loginfo:IOC log info from the firmware
866  * @is_waiting: Is the command issued in block mode
867  * @is_sense: Is Sense data present
868  * @retry_count: Retry count for retriable commands
869  * @host_tag: Host tag used by the command
870  * @callback: Callback for non blocking commands
871  */
872 struct mpi3mr_drv_cmd {
873         struct mutex mutex;
874         struct completion done;
875         void *reply;
876         u8 *sensebuf;
877         u8 iou_rc;
878         u16 state;
879         u16 dev_handle;
880         u16 ioc_status;
881         u32 ioc_loginfo;
882         u8 is_waiting;
883         u8 is_sense;
884         u8 retry_count;
885         u16 host_tag;
886
887         void (*callback)(struct mpi3mr_ioc *mrioc,
888             struct mpi3mr_drv_cmd *drv_cmd);
889 };
890
891 /**
892  * union mpi3mr_trigger_data - Trigger data information
893  * @fault: Fault code
894  * @global: Global trigger data
895  * @element: element trigger data
896  */
897 union mpi3mr_trigger_data {
898         u16 fault;
899         u64 global;
900         union mpi3_driver2_trigger_element element;
901 };
902
903 /**
904  * struct trigger_event_data - store trigger related
905  * information.
906  *
907  * @trace_hdb: Trace diag buffer descriptor reference
908  * @fw_hdb: FW diag buffer descriptor reference
909  * @trigger_type: Trigger type
910  * @trigger_specific_data: Trigger specific data
911  * @snapdump: Snapdump enable or disable flag
912  */
913 struct trigger_event_data {
914         struct diag_buffer_desc *trace_hdb;
915         struct diag_buffer_desc *fw_hdb;
916         u8 trigger_type;
917         union mpi3mr_trigger_data trigger_specific_data;
918         bool snapdump;
919 };
920
921 /**
922  * struct diag_buffer_desc - memory descriptor structure to
923  * store virtual, dma addresses, size, buffer status for host
924  * diagnostic buffers.
925  *
926  * @type: Buffer type
927  * @trigger_data: Trigger data
928  * @trigger_type: Trigger type
929  * @status: Buffer status
930  * @size: Buffer size
931  * @addr: Virtual address
932  * @dma_addr: Buffer DMA address
933  */
934 struct diag_buffer_desc {
935         u8 type;
936         union mpi3mr_trigger_data trigger_data;
937         u8 trigger_type;
938         u8 status;
939         u32 size;
940         void *addr;
941         dma_addr_t dma_addr;
942 };
943
944 /**
945  * struct dma_memory_desc - memory descriptor structure to store
946  * virtual address, dma address and size for any generic dma
947  * memory allocations in the driver.
948  *
949  * @size: buffer size
950  * @addr: virtual address
951  * @dma_addr: dma address
952  */
953 struct dma_memory_desc {
954         u32 size;
955         void *addr;
956         dma_addr_t dma_addr;
957 };
958
959
960 /**
961  * struct chain_element - memory descriptor structure to store
962  * virtual and dma addresses for chain elements.
963  *
964  * @addr: virtual address
965  * @dma_addr: dma address
966  */
967 struct chain_element {
968         void *addr;
969         dma_addr_t dma_addr;
970 };
971
972 /**
973  * struct scmd_priv - SCSI command private data
974  *
975  * @host_tag: Host tag specific to operational queue
976  * @in_lld_scope: Command in LLD scope or not
977  * @meta_sg_valid: DIX command with meta data SGL or not
978  * @scmd: SCSI Command pointer
979  * @req_q_idx: Operational request queue index
980  * @chain_idx: Chain frame index
981  * @meta_chain_idx: Chain frame index of meta data SGL
982  * @mpi3mr_scsiio_req: MPI SCSI IO request
983  */
984 struct scmd_priv {
985         u16 host_tag;
986         u8 in_lld_scope;
987         u8 meta_sg_valid;
988         struct scsi_cmnd *scmd;
989         u16 req_q_idx;
990         int chain_idx;
991         int meta_chain_idx;
992         u8 mpi3mr_scsiio_req[MPI3MR_ADMIN_REQ_FRAME_SZ];
993 };
994
995 /**
996  * struct mpi3mr_ioc - Adapter anchor structure stored in shost
997  * private data
998  *
999  * @list: List pointer
1000  * @pdev: PCI device pointer
1001  * @shost: Scsi_Host pointer
1002  * @id: Controller ID
1003  * @cpu_count: Number of online CPUs
1004  * @irqpoll_sleep: usleep unit used in threaded isr irqpoll
1005  * @name: Controller ASCII name
1006  * @driver_name: Driver ASCII name
1007  * @sysif_regs: System interface registers virtual address
1008  * @sysif_regs_phys: System interface registers physical address
1009  * @bars: PCI BARS
1010  * @dma_mask: DMA mask
1011  * @msix_count: Number of MSIX vectors used
1012  * @intr_enabled: Is interrupts enabled
1013  * @num_admin_req: Number of admin requests
1014  * @admin_req_q_sz: Admin request queue size
1015  * @admin_req_pi: Admin request queue producer index
1016  * @admin_req_ci: Admin request queue consumer index
1017  * @admin_req_base: Admin request queue base virtual address
1018  * @admin_req_dma: Admin request queue base dma address
1019  * @admin_req_lock: Admin queue access lock
1020  * @num_admin_replies: Number of admin replies
1021  * @admin_reply_q_sz: Admin reply queue size
1022  * @admin_reply_ci: Admin reply queue consumer index
1023  * @admin_reply_ephase:Admin reply queue expected phase
1024  * @admin_reply_base: Admin reply queue base virtual address
1025  * @admin_reply_dma: Admin reply queue base dma address
1026  * @admin_reply_q_in_use: Queue is handled by poll/ISR
1027  * @ready_timeout: Controller ready timeout
1028  * @intr_info: Interrupt cookie pointer
1029  * @intr_info_count: Number of interrupt cookies
1030  * @is_intr_info_set: Flag to indicate intr info is setup
1031  * @num_queues: Number of operational queues
1032  * @num_op_req_q: Number of operational request queues
1033  * @req_qinfo: Operational request queue info pointer
1034  * @num_op_reply_q: Number of operational reply queues
1035  * @op_reply_qinfo: Operational reply queue info pointer
1036  * @init_cmds: Command tracker for initialization commands
1037  * @cfg_cmds: Command tracker for configuration requests
1038  * @facts: Cached IOC facts data
1039  * @op_reply_desc_sz: Operational reply descriptor size
1040  * @num_reply_bufs: Number of reply buffers allocated
1041  * @reply_buf_pool: Reply buffer pool
1042  * @reply_buf: Reply buffer base virtual address
1043  * @reply_buf_dma: Reply buffer DMA address
1044  * @reply_buf_dma_max_address: Reply DMA address max limit
1045  * @reply_free_qsz: Reply free queue size
1046  * @reply_free_q_pool: Reply free queue pool
1047  * @reply_free_q: Reply free queue base virtual address
1048  * @reply_free_q_dma: Reply free queue base DMA address
1049  * @reply_free_queue_lock: Reply free queue lock
1050  * @reply_free_queue_host_index: Reply free queue host index
1051  * @num_sense_bufs: Number of sense buffers
1052  * @sense_buf_pool: Sense buffer pool
1053  * @sense_buf: Sense buffer base virtual address
1054  * @sense_buf_dma: Sense buffer base DMA address
1055  * @sense_buf_q_sz: Sense buffer queue size
1056  * @sense_buf_q_pool: Sense buffer queue pool
1057  * @sense_buf_q: Sense buffer queue virtual address
1058  * @sense_buf_q_dma: Sense buffer queue DMA address
1059  * @sbq_lock: Sense buffer queue lock
1060  * @sbq_host_index: Sense buffer queuehost index
1061  * @event_masks: Event mask bitmap
1062  * @fwevt_worker_name: Firmware event worker thread name
1063  * @fwevt_worker_thread: Firmware event worker thread
1064  * @fwevt_lock: Firmware event lock
1065  * @fwevt_list: Firmware event list
1066  * @watchdog_work_q_name: Fault watchdog worker thread name
1067  * @watchdog_work_q: Fault watchdog worker thread
1068  * @watchdog_work: Fault watchdog work
1069  * @watchdog_lock: Fault watchdog lock
1070  * @is_driver_loading: Is driver still loading
1071  * @scan_started: Async scan started
1072  * @scan_failed: Asycn scan failed
1073  * @stop_drv_processing: Stop all command processing
1074  * @device_refresh_on: Don't process the events until devices are refreshed
1075  * @max_host_ios: Maximum host I/O count
1076  * @max_sgl_entries: Max SGL entries per I/O
1077  * @chain_buf_count: Chain buffer count
1078  * @chain_buf_pool: Chain buffer pool
1079  * @chain_sgl_list: Chain SGL list
1080  * @chain_bitmap: Chain buffer allocator bitmap
1081  * @chain_buf_lock: Chain buffer list lock
1082  * @bsg_cmds: Command tracker for BSG command
1083  * @host_tm_cmds: Command tracker for task management commands
1084  * @dev_rmhs_cmds: Command tracker for device removal commands
1085  * @evtack_cmds: Command tracker for event ack commands
1086  * @devrem_bitmap: Device removal bitmap
1087  * @dev_handle_bitmap_bits: Number of bits in device handle bitmap
1088  * @removepend_bitmap: Remove pending bitmap
1089  * @delayed_rmhs_list: Delayed device removal list
1090  * @evtack_cmds_bitmap: Event Ack bitmap
1091  * @delayed_evtack_cmds_list: Delayed event acknowledgment list
1092  * @ts_update_counter: Timestamp update counter
1093  * @reset_in_progress: Reset in progress flag
1094  * @unrecoverable: Controller unrecoverable flag
1095  * @prev_reset_result: Result of previous reset
1096  * @reset_mutex: Controller reset mutex
1097  * @reset_waitq: Controller reset  wait queue
1098  * @prepare_for_reset: Prepare for reset event received
1099  * @prepare_for_reset_timeout_counter: Prepare for reset timeout
1100  * @prp_list_virt: NVMe encapsulated PRP list virtual base
1101  * @prp_list_dma: NVMe encapsulated PRP list DMA
1102  * @prp_sz: NVME encapsulated PRP list size
1103  * @diagsave_timeout: Diagnostic information save timeout
1104  * @logging_level: Controller debug logging level
1105  * @flush_io_count: I/O count to flush after reset
1106  * @current_event: Firmware event currently in process
1107  * @driver_info: Driver, Kernel, OS information to firmware
1108  * @change_count: Topology change count
1109  * @pel_enabled: Persistent Event Log(PEL) enabled or not
1110  * @pel_abort_requested: PEL abort is requested or not
1111  * @pel_class: PEL Class identifier
1112  * @pel_locale: PEL Locale identifier
1113  * @pel_cmds: Command tracker for PEL wait command
1114  * @pel_abort_cmd: Command tracker for PEL abort command
1115  * @pel_newest_seqnum: Newest PEL sequenece number
1116  * @pel_seqnum_virt: PEL sequence number virtual address
1117  * @pel_seqnum_dma: PEL sequence number DMA address
1118  * @pel_seqnum_sz: PEL sequenece number size
1119  * @op_reply_q_offset: Operational reply queue offset with MSIx
1120  * @default_qcount: Total Default queues
1121  * @active_poll_qcount: Currently active poll queue count
1122  * @requested_poll_qcount: User requested poll queue count
1123  * @bsg_dev: BSG device structure
1124  * @bsg_queue: Request queue for BSG device
1125  * @stop_bsgs: Stop BSG request flag
1126  * @logdata_buf: Circular buffer to store log data entries
1127  * @logdata_buf_idx: Index of entry in buffer to store
1128  * @logdata_entry_sz: log data entry size
1129  * @pend_large_data_sz: Counter to track pending large data
1130  * @io_throttle_data_length: I/O size to track in 512b blocks
1131  * @io_throttle_high: I/O size to start throttle in 512b blocks
1132  * @io_throttle_low: I/O size to stop throttle in 512b blocks
1133  * @num_io_throttle_group: Maximum number of throttle groups
1134  * @throttle_groups: Pointer to throttle group info structures
1135  * @cfg_page: Default memory for configuration pages
1136  * @cfg_page_dma: Configuration page DMA address
1137  * @cfg_page_sz: Default configuration page memory size
1138  * @sas_transport_enabled: SAS transport enabled or not
1139  * @scsi_device_channel: Channel ID for SCSI devices
1140  * @transport_cmds: Command tracker for SAS transport commands
1141  * @sas_hba: SAS node for the controller
1142  * @sas_expander_list: SAS node list of expanders
1143  * @sas_node_lock: Lock to protect SAS node list
1144  * @hba_port_table_list: List of HBA Ports
1145  * @enclosure_list: List of Enclosure objects
1146  * @diag_buffers: Host diagnostic buffers
1147  * @driver_pg2:  Driver page 2 pointer
1148  * @reply_trigger_present: Reply trigger present flag
1149  * @event_trigger_present: Event trigger present flag
1150  * @scsisense_trigger_present: Scsi sense trigger present flag
1151  * @ioctl_dma_pool: DMA pool for IOCTL data buffers
1152  * @ioctl_sge: DMA buffer descriptors for IOCTL data
1153  * @ioctl_chain_sge: DMA buffer descriptor for IOCTL chain
1154  * @ioctl_resp_sge: DMA buffer descriptor for Mgmt cmd response
1155  * @ioctl_sges_allocated: Flag for IOCTL SGEs allocated or not
1156  * @trace_release_trigger_active: Trace trigger active flag
1157  * @fw_release_trigger_active: Fw release trigger active flag
1158  * @snapdump_trigger_active: Snapdump trigger active flag
1159  * @pci_err_recovery: PCI error recovery in progress
1160  * @block_on_pci_err: Block IO during PCI error recovery
1161  */
1162 struct mpi3mr_ioc {
1163         struct list_head list;
1164         struct pci_dev *pdev;
1165         struct Scsi_Host *shost;
1166         u8 id;
1167         int cpu_count;
1168         bool enable_segqueue;
1169         u32 irqpoll_sleep;
1170
1171         char name[MPI3MR_NAME_LENGTH];
1172         char driver_name[MPI3MR_NAME_LENGTH];
1173
1174         volatile struct mpi3_sysif_registers __iomem *sysif_regs;
1175         resource_size_t sysif_regs_phys;
1176         int bars;
1177         u64 dma_mask;
1178
1179         u16 msix_count;
1180         u8 intr_enabled;
1181
1182         u16 num_admin_req;
1183         u32 admin_req_q_sz;
1184         u16 admin_req_pi;
1185         u16 admin_req_ci;
1186         void *admin_req_base;
1187         dma_addr_t admin_req_dma;
1188         spinlock_t admin_req_lock;
1189
1190         u16 num_admin_replies;
1191         u32 admin_reply_q_sz;
1192         u16 admin_reply_ci;
1193         u8 admin_reply_ephase;
1194         void *admin_reply_base;
1195         dma_addr_t admin_reply_dma;
1196         atomic_t admin_reply_q_in_use;
1197
1198         u32 ready_timeout;
1199
1200         struct mpi3mr_intr_info *intr_info;
1201         u16 intr_info_count;
1202         bool is_intr_info_set;
1203
1204         u16 num_queues;
1205         u16 num_op_req_q;
1206         struct op_req_qinfo *req_qinfo;
1207
1208         u16 num_op_reply_q;
1209         struct op_reply_qinfo *op_reply_qinfo;
1210
1211         struct mpi3mr_drv_cmd init_cmds;
1212         struct mpi3mr_drv_cmd cfg_cmds;
1213         struct mpi3mr_ioc_facts facts;
1214         u16 op_reply_desc_sz;
1215
1216         u32 num_reply_bufs;
1217         struct dma_pool *reply_buf_pool;
1218         u8 *reply_buf;
1219         dma_addr_t reply_buf_dma;
1220         dma_addr_t reply_buf_dma_max_address;
1221
1222         u16 reply_free_qsz;
1223         u16 reply_sz;
1224         struct dma_pool *reply_free_q_pool;
1225         __le64 *reply_free_q;
1226         dma_addr_t reply_free_q_dma;
1227         spinlock_t reply_free_queue_lock;
1228         u32 reply_free_queue_host_index;
1229
1230         u32 num_sense_bufs;
1231         struct dma_pool *sense_buf_pool;
1232         u8 *sense_buf;
1233         dma_addr_t sense_buf_dma;
1234
1235         u16 sense_buf_q_sz;
1236         struct dma_pool *sense_buf_q_pool;
1237         __le64 *sense_buf_q;
1238         dma_addr_t sense_buf_q_dma;
1239         spinlock_t sbq_lock;
1240         u32 sbq_host_index;
1241         u32 event_masks[MPI3_EVENT_NOTIFY_EVENTMASK_WORDS];
1242
1243         char fwevt_worker_name[MPI3MR_NAME_LENGTH];
1244         struct workqueue_struct *fwevt_worker_thread;
1245         spinlock_t fwevt_lock;
1246         struct list_head fwevt_list;
1247
1248         char watchdog_work_q_name[50];
1249         struct workqueue_struct *watchdog_work_q;
1250         struct delayed_work watchdog_work;
1251         spinlock_t watchdog_lock;
1252
1253         u8 is_driver_loading;
1254         u8 scan_started;
1255         u16 scan_failed;
1256         u8 stop_drv_processing;
1257         u8 device_refresh_on;
1258
1259         u16 max_host_ios;
1260         spinlock_t tgtdev_lock;
1261         struct list_head tgtdev_list;
1262         u16 max_sgl_entries;
1263
1264         u32 chain_buf_count;
1265         struct dma_pool *chain_buf_pool;
1266         struct chain_element *chain_sgl_list;
1267         unsigned long *chain_bitmap;
1268         spinlock_t chain_buf_lock;
1269
1270         struct mpi3mr_drv_cmd bsg_cmds;
1271         struct mpi3mr_drv_cmd host_tm_cmds;
1272         struct mpi3mr_drv_cmd dev_rmhs_cmds[MPI3MR_NUM_DEVRMCMD];
1273         struct mpi3mr_drv_cmd evtack_cmds[MPI3MR_NUM_EVTACKCMD];
1274         unsigned long *devrem_bitmap;
1275         u16 dev_handle_bitmap_bits;
1276         unsigned long *removepend_bitmap;
1277         struct list_head delayed_rmhs_list;
1278         unsigned long *evtack_cmds_bitmap;
1279         struct list_head delayed_evtack_cmds_list;
1280
1281         u32 ts_update_counter;
1282         u8 reset_in_progress;
1283         u8 unrecoverable;
1284         int prev_reset_result;
1285         struct mutex reset_mutex;
1286         wait_queue_head_t reset_waitq;
1287
1288         u8 prepare_for_reset;
1289         u16 prepare_for_reset_timeout_counter;
1290
1291         void *prp_list_virt;
1292         dma_addr_t prp_list_dma;
1293         u32 prp_sz;
1294
1295         u16 diagsave_timeout;
1296         int logging_level;
1297         u16 flush_io_count;
1298
1299         struct mpi3mr_fwevt *current_event;
1300         struct mpi3_driver_info_layout driver_info;
1301         u16 change_count;
1302
1303         u8 pel_enabled;
1304         u8 pel_abort_requested;
1305         u8 pel_class;
1306         u16 pel_locale;
1307         struct mpi3mr_drv_cmd pel_cmds;
1308         struct mpi3mr_drv_cmd pel_abort_cmd;
1309
1310         u32 pel_newest_seqnum;
1311         void *pel_seqnum_virt;
1312         dma_addr_t pel_seqnum_dma;
1313         u32 pel_seqnum_sz;
1314
1315         u16 op_reply_q_offset;
1316         u16 default_qcount;
1317         u16 active_poll_qcount;
1318         u16 requested_poll_qcount;
1319
1320         struct device bsg_dev;
1321         struct request_queue *bsg_queue;
1322         u8 stop_bsgs;
1323         u8 *logdata_buf;
1324         u16 logdata_buf_idx;
1325         u16 logdata_entry_sz;
1326
1327         atomic_t pend_large_data_sz;
1328         u32 io_throttle_data_length;
1329         u32 io_throttle_high;
1330         u32 io_throttle_low;
1331         u16 num_io_throttle_group;
1332         struct mpi3mr_throttle_group_info *throttle_groups;
1333
1334         void *cfg_page;
1335         dma_addr_t cfg_page_dma;
1336         u16 cfg_page_sz;
1337
1338         u8 sas_transport_enabled;
1339         u8 scsi_device_channel;
1340         struct mpi3mr_drv_cmd transport_cmds;
1341         struct mpi3mr_sas_node sas_hba;
1342         struct list_head sas_expander_list;
1343         spinlock_t sas_node_lock;
1344         struct list_head hba_port_table_list;
1345         struct list_head enclosure_list;
1346
1347         struct dma_pool *ioctl_dma_pool;
1348         struct dma_memory_desc ioctl_sge[MPI3MR_NUM_IOCTL_SGE];
1349         struct dma_memory_desc ioctl_chain_sge;
1350         struct dma_memory_desc ioctl_resp_sge;
1351         bool ioctl_sges_allocated;
1352         bool reply_trigger_present;
1353         bool event_trigger_present;
1354         bool scsisense_trigger_present;
1355         struct diag_buffer_desc diag_buffers[MPI3MR_MAX_NUM_HDB];
1356         struct mpi3_driver_page2 *driver_pg2;
1357         spinlock_t trigger_lock;
1358         bool snapdump_trigger_active;
1359         bool trace_release_trigger_active;
1360         bool fw_release_trigger_active;
1361         bool pci_err_recovery;
1362         bool block_on_pci_err;
1363 };
1364
1365 /**
1366  * struct mpi3mr_fwevt - Firmware event structure.
1367  *
1368  * @list: list head
1369  * @work: Work structure
1370  * @mrioc: Adapter instance reference
1371  * @event_id: MPI3 firmware event ID
1372  * @send_ack: Event acknowledgment required or not
1373  * @process_evt: Bottomhalf processing required or not
1374  * @evt_ctx: Event context to send in Ack
1375  * @event_data_size: size of the event data in bytes
1376  * @pending_at_sml: waiting for device add/remove API to complete
1377  * @discard: discard this event
1378  * @ref_count: kref count
1379  * @event_data: Actual MPI3 event data
1380  */
1381 struct mpi3mr_fwevt {
1382         struct list_head list;
1383         struct work_struct work;
1384         struct mpi3mr_ioc *mrioc;
1385         u16 event_id;
1386         bool send_ack;
1387         bool process_evt;
1388         u32 evt_ctx;
1389         u16 event_data_size;
1390         bool pending_at_sml;
1391         bool discard;
1392         struct kref ref_count;
1393         char event_data[] __aligned(4);
1394 };
1395
1396
1397 /**
1398  * struct delayed_dev_rmhs_node - Delayed device removal node
1399  *
1400  * @list: list head
1401  * @handle: Device handle
1402  * @iou_rc: IO Unit Control Reason Code
1403  */
1404 struct delayed_dev_rmhs_node {
1405         struct list_head list;
1406         u16 handle;
1407         u8 iou_rc;
1408 };
1409
1410 /**
1411  * struct delayed_evt_ack_node - Delayed event ack node
1412  * @list: list head
1413  * @event: MPI3 event ID
1414  * @event_ctx: event context
1415  */
1416 struct delayed_evt_ack_node {
1417         struct list_head list;
1418         u8 event;
1419         u32 event_ctx;
1420 };
1421
1422 int mpi3mr_setup_resources(struct mpi3mr_ioc *mrioc);
1423 void mpi3mr_cleanup_resources(struct mpi3mr_ioc *mrioc);
1424 int mpi3mr_init_ioc(struct mpi3mr_ioc *mrioc);
1425 int mpi3mr_reinit_ioc(struct mpi3mr_ioc *mrioc, u8 is_resume);
1426 void mpi3mr_cleanup_ioc(struct mpi3mr_ioc *mrioc);
1427 int mpi3mr_issue_port_enable(struct mpi3mr_ioc *mrioc, u8 async);
1428 int mpi3mr_admin_request_post(struct mpi3mr_ioc *mrioc, void *admin_req,
1429 u16 admin_req_sz, u8 ignore_reset);
1430 int mpi3mr_op_request_post(struct mpi3mr_ioc *mrioc,
1431                            struct op_req_qinfo *opreqq, u8 *req);
1432 void mpi3mr_add_sg_single(void *paddr, u8 flags, u32 length,
1433                           dma_addr_t dma_addr);
1434 void mpi3mr_build_zero_len_sge(void *paddr);
1435 void *mpi3mr_get_sensebuf_virt_addr(struct mpi3mr_ioc *mrioc,
1436                                      dma_addr_t phys_addr);
1437 void *mpi3mr_get_reply_virt_addr(struct mpi3mr_ioc *mrioc,
1438                                      dma_addr_t phys_addr);
1439 void mpi3mr_repost_sense_buf(struct mpi3mr_ioc *mrioc,
1440                                      u64 sense_buf_dma);
1441
1442 void mpi3mr_memset_buffers(struct mpi3mr_ioc *mrioc);
1443 void mpi3mr_free_mem(struct mpi3mr_ioc *mrioc);
1444 void mpi3mr_os_handle_events(struct mpi3mr_ioc *mrioc,
1445                              struct mpi3_event_notification_reply *event_reply);
1446 void mpi3mr_process_op_reply_desc(struct mpi3mr_ioc *mrioc,
1447                                   struct mpi3_default_reply_descriptor *reply_desc,
1448                                   u64 *reply_dma, u16 qidx);
1449 void mpi3mr_start_watchdog(struct mpi3mr_ioc *mrioc);
1450 void mpi3mr_stop_watchdog(struct mpi3mr_ioc *mrioc);
1451
1452 int mpi3mr_soft_reset_handler(struct mpi3mr_ioc *mrioc,
1453                               u16 reset_reason, u8 snapdump);
1454 void mpi3mr_ioc_disable_intr(struct mpi3mr_ioc *mrioc);
1455 void mpi3mr_ioc_enable_intr(struct mpi3mr_ioc *mrioc);
1456
1457 enum mpi3mr_iocstate mpi3mr_get_iocstate(struct mpi3mr_ioc *mrioc);
1458 int mpi3mr_process_event_ack(struct mpi3mr_ioc *mrioc, u8 event,
1459                           u32 event_ctx);
1460
1461 void mpi3mr_wait_for_host_io(struct mpi3mr_ioc *mrioc, u32 timeout);
1462 void mpi3mr_cleanup_fwevt_list(struct mpi3mr_ioc *mrioc);
1463 void mpi3mr_flush_host_io(struct mpi3mr_ioc *mrioc);
1464 void mpi3mr_invalidate_devhandles(struct mpi3mr_ioc *mrioc);
1465 void mpi3mr_flush_delayed_cmd_lists(struct mpi3mr_ioc *mrioc);
1466 void mpi3mr_check_rh_fault_ioc(struct mpi3mr_ioc *mrioc, u32 reason_code);
1467 void mpi3mr_print_fault_info(struct mpi3mr_ioc *mrioc);
1468 void mpi3mr_check_rh_fault_ioc(struct mpi3mr_ioc *mrioc, u32 reason_code);
1469 int mpi3mr_process_op_reply_q(struct mpi3mr_ioc *mrioc,
1470         struct op_reply_qinfo *op_reply_q);
1471 int mpi3mr_blk_mq_poll(struct Scsi_Host *shost, unsigned int queue_num);
1472 void mpi3mr_bsg_init(struct mpi3mr_ioc *mrioc);
1473 void mpi3mr_bsg_exit(struct mpi3mr_ioc *mrioc);
1474 int mpi3mr_issue_tm(struct mpi3mr_ioc *mrioc, u8 tm_type,
1475         u16 handle, uint lun, u16 htag, ulong timeout,
1476         struct mpi3mr_drv_cmd *drv_cmd,
1477         u8 *resp_code, struct scsi_cmnd *scmd);
1478 struct mpi3mr_tgt_dev *mpi3mr_get_tgtdev_by_handle(
1479         struct mpi3mr_ioc *mrioc, u16 handle);
1480 void mpi3mr_pel_get_seqnum_complete(struct mpi3mr_ioc *mrioc,
1481         struct mpi3mr_drv_cmd *drv_cmd);
1482 int mpi3mr_pel_get_seqnum_post(struct mpi3mr_ioc *mrioc,
1483         struct mpi3mr_drv_cmd *drv_cmd);
1484 void mpi3mr_app_save_logdata(struct mpi3mr_ioc *mrioc, char *event_data,
1485         u16 event_data_size);
1486 struct mpi3mr_enclosure_node *mpi3mr_enclosure_find_by_handle(
1487         struct mpi3mr_ioc *mrioc, u16 handle);
1488 extern const struct attribute_group *mpi3mr_host_groups[];
1489 extern const struct attribute_group *mpi3mr_dev_groups[];
1490
1491 extern struct sas_function_template mpi3mr_transport_functions;
1492 extern struct scsi_transport_template *mpi3mr_transport_template;
1493
1494 int mpi3mr_cfg_get_dev_pg0(struct mpi3mr_ioc *mrioc, u16 *ioc_status,
1495         struct mpi3_device_page0 *dev_pg0, u16 pg_sz, u32 form, u32 form_spec);
1496 int mpi3mr_cfg_get_sas_phy_pg0(struct mpi3mr_ioc *mrioc, u16 *ioc_status,
1497         struct mpi3_sas_phy_page0 *phy_pg0, u16 pg_sz, u32 form,
1498         u32 form_spec);
1499 int mpi3mr_cfg_get_sas_phy_pg1(struct mpi3mr_ioc *mrioc, u16 *ioc_status,
1500         struct mpi3_sas_phy_page1 *phy_pg1, u16 pg_sz, u32 form,
1501         u32 form_spec);
1502 int mpi3mr_cfg_get_sas_exp_pg0(struct mpi3mr_ioc *mrioc, u16 *ioc_status,
1503         struct mpi3_sas_expander_page0 *exp_pg0, u16 pg_sz, u32 form,
1504         u32 form_spec);
1505 int mpi3mr_cfg_get_sas_exp_pg1(struct mpi3mr_ioc *mrioc, u16 *ioc_status,
1506         struct mpi3_sas_expander_page1 *exp_pg1, u16 pg_sz, u32 form,
1507         u32 form_spec);
1508 int mpi3mr_cfg_get_enclosure_pg0(struct mpi3mr_ioc *mrioc, u16 *ioc_status,
1509         struct mpi3_enclosure_page0 *encl_pg0, u16 pg_sz, u32 form,
1510         u32 form_spec);
1511 int mpi3mr_cfg_get_sas_io_unit_pg0(struct mpi3mr_ioc *mrioc,
1512         struct mpi3_sas_io_unit_page0 *sas_io_unit_pg0, u16 pg_sz);
1513 int mpi3mr_cfg_get_sas_io_unit_pg1(struct mpi3mr_ioc *mrioc,
1514         struct mpi3_sas_io_unit_page1 *sas_io_unit_pg1, u16 pg_sz);
1515 int mpi3mr_cfg_set_sas_io_unit_pg1(struct mpi3mr_ioc *mrioc,
1516         struct mpi3_sas_io_unit_page1 *sas_io_unit_pg1, u16 pg_sz);
1517 int mpi3mr_cfg_get_driver_pg1(struct mpi3mr_ioc *mrioc,
1518         struct mpi3_driver_page1 *driver_pg1, u16 pg_sz);
1519 int mpi3mr_cfg_get_driver_pg2(struct mpi3mr_ioc *mrioc,
1520         struct mpi3_driver_page2 *driver_pg2, u16 pg_sz, u8 page_type);
1521
1522 u8 mpi3mr_is_expander_device(u16 device_info);
1523 int mpi3mr_expander_add(struct mpi3mr_ioc *mrioc, u16 handle);
1524 void mpi3mr_expander_remove(struct mpi3mr_ioc *mrioc, u64 sas_address,
1525         struct mpi3mr_hba_port *hba_port);
1526 struct mpi3mr_sas_node *__mpi3mr_expander_find_by_handle(struct mpi3mr_ioc
1527         *mrioc, u16 handle);
1528 struct mpi3mr_hba_port *mpi3mr_get_hba_port_by_id(struct mpi3mr_ioc *mrioc,
1529         u8 port_id);
1530 void mpi3mr_sas_host_refresh(struct mpi3mr_ioc *mrioc);
1531 void mpi3mr_sas_host_add(struct mpi3mr_ioc *mrioc);
1532 void mpi3mr_update_links(struct mpi3mr_ioc *mrioc,
1533         u64 sas_address_parent, u16 handle, u8 phy_number, u8 link_rate,
1534         struct mpi3mr_hba_port *hba_port);
1535 void mpi3mr_remove_tgtdev_from_host(struct mpi3mr_ioc *mrioc,
1536         struct mpi3mr_tgt_dev *tgtdev);
1537 int mpi3mr_report_tgtdev_to_sas_transport(struct mpi3mr_ioc *mrioc,
1538         struct mpi3mr_tgt_dev *tgtdev);
1539 void mpi3mr_remove_tgtdev_from_sas_transport(struct mpi3mr_ioc *mrioc,
1540         struct mpi3mr_tgt_dev *tgtdev);
1541 struct mpi3mr_tgt_dev *__mpi3mr_get_tgtdev_by_addr_and_rphy(
1542         struct mpi3mr_ioc *mrioc, u64 sas_address, struct sas_rphy *rphy);
1543 void mpi3mr_print_device_event_notice(struct mpi3mr_ioc *mrioc,
1544         bool device_add);
1545 void mpi3mr_refresh_sas_ports(struct mpi3mr_ioc *mrioc);
1546 void mpi3mr_refresh_expanders(struct mpi3mr_ioc *mrioc);
1547 void mpi3mr_add_event_wait_for_device_refresh(struct mpi3mr_ioc *mrioc);
1548 void mpi3mr_flush_drv_cmds(struct mpi3mr_ioc *mrioc);
1549 void mpi3mr_flush_cmds_for_unrecovered_controller(struct mpi3mr_ioc *mrioc);
1550 void mpi3mr_free_enclosure_list(struct mpi3mr_ioc *mrioc);
1551 int mpi3mr_process_admin_reply_q(struct mpi3mr_ioc *mrioc);
1552 void mpi3mr_expander_node_remove(struct mpi3mr_ioc *mrioc,
1553         struct mpi3mr_sas_node *sas_expander);
1554 void mpi3mr_alloc_diag_bufs(struct mpi3mr_ioc *mrioc);
1555 int mpi3mr_post_diag_bufs(struct mpi3mr_ioc *mrioc);
1556 int mpi3mr_issue_diag_buf_release(struct mpi3mr_ioc *mrioc,
1557         struct diag_buffer_desc *diag_buffer);
1558 void mpi3mr_release_diag_bufs(struct mpi3mr_ioc *mrioc, u8 skip_rel_action);
1559 void mpi3mr_set_trigger_data_in_hdb(struct diag_buffer_desc *hdb,
1560         u8 type, union mpi3mr_trigger_data *trigger_data, bool force);
1561 int mpi3mr_refresh_trigger(struct mpi3mr_ioc *mrioc, u8 page_type);
1562 struct diag_buffer_desc *mpi3mr_diag_buffer_for_type(struct mpi3mr_ioc *mrioc,
1563         u8 buf_type);
1564 int mpi3mr_issue_diag_buf_post(struct mpi3mr_ioc *mrioc,
1565         struct diag_buffer_desc *diag_buffer);
1566 void mpi3mr_set_trigger_data_in_all_hdb(struct mpi3mr_ioc *mrioc,
1567         u8 type, union mpi3mr_trigger_data *trigger_data, bool force);
1568 void mpi3mr_reply_trigger(struct mpi3mr_ioc *mrioc, u16 iocstatus,
1569         u32 iocloginfo);
1570 void mpi3mr_hdb_trigger_data_event(struct mpi3mr_ioc *mrioc,
1571         struct trigger_event_data *event_data);
1572 void mpi3mr_scsisense_trigger(struct mpi3mr_ioc *mrioc, u8 senseky, u8 asc,
1573         u8 ascq);
1574 void mpi3mr_event_trigger(struct mpi3mr_ioc *mrioc, u8 event);
1575 void mpi3mr_global_trigger(struct mpi3mr_ioc *mrioc, u64 trigger_data);
1576 void mpi3mr_hdbstatuschg_evt_th(struct mpi3mr_ioc *mrioc,
1577         struct mpi3_event_notification_reply *event_reply);
1578 #endif /*MPI3MR_H_INCLUDED*/
This page took 0.111656 seconds and 4 git commands to generate.