1 /* 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2020-2023, Broadcom Inc. All rights reserved. 5 * Support: <fbsd-storage-driver.pdl@broadcom.com> 6 * 7 * Authors: Sumit Saxena <sumit.saxena@broadcom.com> 8 * Chandrakanth Patil <chandrakanth.patil@broadcom.com> 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions are 12 * met: 13 * 14 * 1. Redistributions of source code must retain the above copyright notice, 15 * this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright notice, 17 * this list of conditions and the following disclaimer in the documentation and/or other 18 * materials provided with the distribution. 19 * 3. Neither the name of the Broadcom Inc. nor the names of its contributors 20 * may be used to endorse or promote products derived from this software without 21 * specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 24 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 27 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 33 * POSSIBILITY OF SUCH DAMAGE. 34 * 35 * The views and conclusions contained in the software and documentation are 36 * those of the authors and should not be interpreted as representing 37 * official policies,either expressed or implied, of the FreeBSD Project. 38 * 39 * Mail to: Broadcom Inc 1320 Ridder Park Dr, San Jose, CA 95131 40 * 41 * Broadcom Inc. (Broadcom) MPI3MR Adapter FreeBSD 42 */ 43 44 #ifndef _MPI3MRVAR_H 45 #define _MPI3MRVAR_H 46 47 #include <sys/cdefs.h> 48 __FBSDID("$FreeBSD$"); 49 #include <sys/types.h> 50 #include <sys/param.h> 51 #include <sys/systm.h> 52 #include <sys/kernel.h> 53 #include <sys/module.h> 54 #include <sys/bus.h> 55 #include <sys/conf.h> 56 #include <sys/malloc.h> 57 #include <sys/sysctl.h> 58 #include <sys/uio.h> 59 #include <sys/selinfo.h> 60 #include <sys/poll.h> 61 62 #include <sys/lock.h> 63 #include <sys/mutex.h> 64 #include <sys/endian.h> 65 #include <sys/sysent.h> 66 #include <sys/taskqueue.h> 67 #include <sys/smp.h> 68 69 #include <machine/bus.h> 70 #include <machine/resource.h> 71 #include <sys/rman.h> 72 73 #include <dev/pci/pcireg.h> 74 #include <dev/pci/pcivar.h> 75 #include <dev/pci/pci_private.h> 76 77 #include <cam/cam.h> 78 #include <cam/cam_ccb.h> 79 #include <cam/cam_debug.h> 80 #include <cam/cam_sim.h> 81 #include <cam/cam_xpt_sim.h> 82 #include <cam/cam_xpt_periph.h> 83 #include <cam/cam_periph.h> 84 #include <cam/scsi/scsi_all.h> 85 #include <cam/scsi/scsi_message.h> 86 87 #include <cam/scsi/smp_all.h> 88 #include <sys/queue.h> 89 #include <sys/kthread.h> 90 #include "mpi/mpi30_api.h" 91 92 #define MPI3MR_DRIVER_VERSION "8.6.0.2.0" 93 #define MPI3MR_DRIVER_RELDATE "17th May 2023" 94 95 #define MPI3MR_DRIVER_NAME "mpi3mr" 96 97 #define MPI3MR_NAME_LENGTH 32 98 #define IOCNAME "%s: " 99 100 #define SAS4116_CHIP_REV_A0 0 101 #define SAS4116_CHIP_REV_B0 1 102 103 #define MPI3MR_SG_DEPTH (MPI3MR_4K_PGSZ/sizeof(Mpi3SGESimple_t)) 104 #define MPI3MR_MAX_SECTORS 2048 105 #define MPI3MR_MAX_CMDS_LUN 7 106 #define MPI3MR_MAX_CDB_LENGTH 16 107 #define MPI3MR_MAX_LUN 16895 108 109 #define MPI3MR_SATA_QDEPTH 32 110 #define MPI3MR_SAS_QDEPTH 64 111 #define MPI3MR_RAID_QDEPTH 128 112 #define MPI3MR_NVME_QDEPTH 128 113 114 #define MPI3MR_4K_PGSZ 4096 115 #define MPI3MR_AREQQ_SIZE (2 * MPI3MR_4K_PGSZ) 116 #define MPI3MR_AREPQ_SIZE (4 * MPI3MR_4K_PGSZ) 117 #define MPI3MR_AREQ_FRAME_SZ 128 118 #define MPI3MR_AREP_FRAME_SZ 16 119 120 #define MPI3MR_OPREQQ_SIZE (8 * MPI3MR_4K_PGSZ) 121 #define MPI3MR_OPREPQ_SIZE (4 * MPI3MR_4K_PGSZ) 122 123 /* Operational queue management definitions */ 124 #define MPI3MR_OP_REQ_Q_QD 512 125 #define MPI3MR_OP_REP_Q_QD 1024 126 #define MPI3MR_OP_REP_Q_QD_A0 4096 127 128 #define MPI3MR_CHAINSGE_SIZE MPI3MR_4K_PGSZ 129 130 #define MPI3MR_SGEFLAGS_SYSTEM_SIMPLE_END_OF_LIST \ 131 (MPI3_SGE_FLAGS_ELEMENT_TYPE_SIMPLE | MPI3_SGE_FLAGS_DLAS_SYSTEM | \ 132 MPI3_SGE_FLAGS_END_OF_LIST) 133 134 #define MPI3MR_HOSTTAG_INVALID 0xFFFF 135 #define MPI3MR_HOSTTAG_INITCMDS 1 136 #define MPI3MR_HOSTTAG_IOCTLCMDS 2 137 #define MPI3MR_HOSTTAG_PELABORT 3 138 #define MPI3MR_HOSTTAG_PELWAIT 4 139 #define MPI3MR_HOSTTAG_TMS 5 140 141 #define MAX_MGMT_ADAPTERS 8 142 #define MPI3MR_WAIT_BEFORE_CTRL_RESET 5 143 144 145 struct mpi3mr_mgmt_info { 146 uint16_t count; 147 struct mpi3mr_softc *sc_ptr[MAX_MGMT_ADAPTERS]; 148 int max_index; 149 }; 150 151 extern char fmt_os_ver[16]; 152 153 #define MPI3MR_OS_VERSION(raw_os_ver, fmt_os_ver) sprintf(raw_os_ver, "%d", __FreeBSD_version); \ 154 sprintf(fmt_os_ver, "%c%c.%c%c.%c%c%c",\ 155 raw_os_ver[0], raw_os_ver[1], raw_os_ver[2],\ 156 raw_os_ver[3], raw_os_ver[4], raw_os_ver[5],\ 157 raw_os_ver[6]); 158 #define MPI3MR_NUM_DEVRMCMD 1 159 #define MPI3MR_HOSTTAG_DEVRMCMD_MIN (MPI3MR_HOSTTAG_TMS + 1) 160 #define MPI3MR_HOSTTAG_DEVRMCMD_MAX (MPI3MR_HOSTTAG_DEVRMCMD_MIN + \ 161 MPI3MR_NUM_DEVRMCMD - 1) 162 #define MPI3MR_INTERNALCMDS_RESVD MPI3MR_HOSTTAG_DEVRMCMD_MAX 163 164 #define MPI3MR_NUM_EVTACKCMD 4 165 #define MPI3MR_HOSTTAG_EVTACKCMD_MIN (MPI3MR_HOSTTAG_DEVRMCMD_MAX + 1) 166 #define MPI3MR_HOSTTAG_EVTACKCMD_MAX (MPI3MR_HOSTTAG_EVTACKCMD_MIN + \ 167 MPI3MR_NUM_EVTACKCMD - 1) 168 169 /* command/controller interaction timeout definitions in seconds */ 170 #define MPI3MR_INTADMCMD_TIMEOUT 60 171 #define MPI3MR_PORTENABLE_TIMEOUT 300 172 #define MPI3MR_ABORTTM_TIMEOUT 60 173 #define MPI3MR_RESETTM_TIMEOUT 60 174 #define MPI3MR_TSUPDATE_INTERVAL 900 175 #define MPI3MR_DEFAULT_SHUTDOWN_TIME 120 176 #define MPI3MR_RAID_ERRREC_RESET_TIMEOUT 180 177 #define MPI3MR_RESET_HOST_IOWAIT_TIMEOUT 5 178 #define MPI3MR_PREPARE_FOR_RESET_TIMEOUT 180 179 #define MPI3MR_RESET_ACK_TIMEOUT 30 180 #define MPI3MR_MUR_TIMEOUT 120 181 182 #define MPI3MR_CMD_NOTUSED 0x8000 183 #define MPI3MR_CMD_COMPLETE 0x0001 184 #define MPI3MR_CMD_PENDING 0x0002 185 #define MPI3MR_CMD_REPLYVALID 0x0004 186 #define MPI3MR_CMD_RESET 0x0008 187 188 #define MPI3MR_NUM_EVTREPLIES 64 189 #define MPI3MR_SENSEBUF_SZ 256 190 #define MPI3MR_SENSEBUF_FACTOR 3 191 #define MPI3MR_CHAINBUF_FACTOR 3 192 193 #define MPT3SAS_HOSTPGSZ_4KEXP 12 194 195 #define MPI3MR_INVALID_DEV_HANDLE 0xFFFF 196 197 /* Controller Reset related definitions */ 198 #define MPI3MR_HOSTDIAG_UNLOCK_RETRY_COUNT 5 199 #define MPI3MR_MAX_SHUTDOWN_RETRY_COUNT 2 200 201 /* ResponseCode values */ 202 #define MPI3MR_RI_MASK_RESPCODE (0x000000FF) 203 #define MPI3MR_RSP_TM_COMPLETE 0x00 204 #define MPI3MR_RSP_INVALID_FRAME 0x02 205 #define MPI3MR_RSP_TM_NOT_SUPPORTED 0x04 206 #define MPI3MR_RSP_TM_FAILED 0x05 207 #define MPI3MR_RSP_TM_SUCCEEDED 0x08 208 #define MPI3MR_RSP_TM_INVALID_LUN 0x09 209 #define MPI3MR_RSP_TM_OVERLAPPED_TAG 0x0A 210 #define MPI3MR_RSP_IO_QUEUED_ON_IOC \ 211 MPI3_SCSITASKMGMT_RSPCODE_IO_QUEUED_ON_IOC 212 213 /* Definitions for the controller security status*/ 214 #define MPI3MR_CTLR_SECURITY_STATUS_MASK 0x0C 215 #define MPI3MR_CTLR_SECURE_DBG_STATUS_MASK 0x02 216 217 #define MPI3MR_INVALID_DEVICE 0x00 218 #define MPI3MR_CONFIG_SECURE_DEVICE 0x04 219 #define MPI3MR_HARD_SECURE_DEVICE 0x08 220 #define MPI3MR_TAMPERED_DEVICE 0x0C 221 222 #define MPI3MR_DEFAULT_MDTS (128 * 1024) 223 #define MPI3MR_DEFAULT_PGSZEXP (12) 224 #define MPI3MR_MAX_IOCTL_TRANSFER_SIZE (1024 * 1024) 225 226 #define MPI3MR_DEVRMHS_RETRYCOUNT 3 227 #define MPI3MR_PELCMDS_RETRYCOUNT 3 228 229 #define MPI3MR_PERIODIC_DELAY 1 /* 1 second heartbeat/watchdog check */ 230 231 struct completion { 232 unsigned int done; 233 struct mtx lock; 234 }; 235 236 typedef union { 237 volatile unsigned int val; 238 unsigned int val_rdonly; 239 } mpi3mr_atomic_t; 240 241 #define mpi3mr_atomic_read(v) atomic_load_acq_int(&(v)->val) 242 #define mpi3mr_atomic_set(v,i) atomic_store_rel_int(&(v)->val, i) 243 #define mpi3mr_atomic_dec(v) atomic_subtract_int(&(v)->val, 1) 244 #define mpi3mr_atomic_inc(v) atomic_add_int(&(v)->val, 1) 245 #define mpi3mr_atomic_add(v, u) atomic_add_int(&(v)->val, u) 246 #define mpi3mr_atomic_sub(v, u) atomic_subtract_int(&(v)->val, u) 247 248 /* IOCTL data transfer sge*/ 249 #define MPI3MR_NUM_IOCTL_SGE 256 250 #define MPI3MR_IOCTL_SGE_SIZE (8 * 1024) 251 252 struct dma_memory_desc { 253 U32 size; 254 void *addr; 255 bus_dma_tag_t tag; 256 bus_dmamap_t dmamap; 257 bus_addr_t dma_addr; 258 }; 259 260 enum mpi3mr_iocstate { 261 MRIOC_STATE_READY = 1, 262 MRIOC_STATE_RESET, 263 MRIOC_STATE_FAULT, 264 MRIOC_STATE_BECOMING_READY, 265 MRIOC_STATE_RESET_REQUESTED, 266 MRIOC_STATE_UNRECOVERABLE, 267 MRIOC_STATE_COUNT, 268 }; 269 270 /* Init type definitions */ 271 enum mpi3mr_init_type { 272 MPI3MR_INIT_TYPE_INIT = 0, 273 MPI3MR_INIT_TYPE_RESET, 274 MPI3MR_INIT_TYPE_RESUME, 275 }; 276 277 /* Reset reason code definitions*/ 278 enum mpi3mr_reset_reason { 279 MPI3MR_RESET_FROM_BRINGUP = 1, 280 MPI3MR_RESET_FROM_FAULT_WATCH = 2, 281 MPI3MR_RESET_FROM_IOCTL = 3, 282 MPI3MR_RESET_FROM_EH_HOS = 4, 283 MPI3MR_RESET_FROM_TM_TIMEOUT = 5, 284 MPI3MR_RESET_FROM_IOCTL_TIMEOUT = 6, 285 MPI3MR_RESET_FROM_MUR_FAILURE = 7, 286 MPI3MR_RESET_FROM_CTLR_CLEANUP = 8, 287 MPI3MR_RESET_FROM_CIACTIV_FAULT = 9, 288 MPI3MR_RESET_FROM_PE_TIMEOUT = 10, 289 MPI3MR_RESET_FROM_TSU_TIMEOUT = 11, 290 MPI3MR_RESET_FROM_DELREQQ_TIMEOUT = 12, 291 MPI3MR_RESET_FROM_DELREPQ_TIMEOUT = 13, 292 MPI3MR_RESET_FROM_CREATEREPQ_TIMEOUT = 14, 293 MPI3MR_RESET_FROM_CREATEREQQ_TIMEOUT = 15, 294 MPI3MR_RESET_FROM_IOCFACTS_TIMEOUT = 16, 295 MPI3MR_RESET_FROM_IOCINIT_TIMEOUT = 17, 296 MPI3MR_RESET_FROM_EVTNOTIFY_TIMEOUT = 18, 297 MPI3MR_RESET_FROM_EVTACK_TIMEOUT = 19, 298 MPI3MR_RESET_FROM_CIACTVRST_TIMER = 20, 299 MPI3MR_RESET_FROM_GETPKGVER_TIMEOUT = 21, 300 MPI3MR_RESET_FROM_PELABORT_TIMEOUT = 22, 301 MPI3MR_RESET_FROM_SYSFS = 23, 302 MPI3MR_RESET_FROM_SYSFS_TIMEOUT = 24, 303 MPI3MR_RESET_FROM_DIAG_BUFFER_POST_TIMEOUT = 25, 304 MPI3MR_RESET_FROM_SCSIIO_TIMEOUT = 26, 305 MPI3MR_RESET_FROM_FIRMWARE = 27, 306 MPI3MR_DEFAULT_RESET_REASON = 28, 307 MPI3MR_RESET_REASON_COUNT, 308 }; 309 310 struct mpi3mr_compimg_ver 311 { 312 U16 build_num; 313 U16 cust_id; 314 U8 ph_minor; 315 U8 ph_major; 316 U8 gen_minor; 317 U8 gen_major; 318 }; 319 320 struct mpi3mr_ioc_facts 321 { 322 U32 ioc_capabilities; 323 struct mpi3mr_compimg_ver fw_ver; 324 U32 mpi_version; 325 U16 max_reqs; 326 U16 product_id; 327 U16 op_req_sz; 328 U16 reply_sz; 329 U16 exceptions; 330 U16 max_perids; 331 U16 max_pds; 332 U16 max_sasexpanders; 333 U16 max_sasinitiators; 334 U16 max_enclosures; 335 U16 max_pcieswitches; 336 U16 max_nvme; 337 U16 max_vds; 338 U16 max_hpds; 339 U16 max_advhpds; 340 U16 max_raidpds; 341 U16 min_devhandle; 342 U16 max_devhandle; 343 U16 max_op_req_q; 344 U16 max_op_reply_q; 345 U16 shutdown_timeout; 346 U8 ioc_num; 347 U8 who_init; 348 U16 max_msix_vectors; 349 U8 personality; 350 U8 dma_mask; 351 U8 protocol_flags; 352 U8 sge_mod_mask; 353 U8 sge_mod_value; 354 U8 sge_mod_shift; 355 U8 max_dev_per_tg; 356 U16 max_io_throttle_group; 357 U16 io_throttle_data_length; 358 U16 io_throttle_low; 359 U16 io_throttle_high; 360 }; 361 362 struct mpi3mr_op_req_queue { 363 U16 ci; 364 U16 pi; 365 U16 num_reqs; 366 U8 qid; 367 U8 reply_qid; 368 U32 qsz; 369 void *q_base; 370 bus_dma_tag_t q_base_tag; 371 bus_dmamap_t q_base_dmamap; 372 bus_addr_t q_base_phys; 373 struct mtx q_lock; 374 }; 375 376 struct mpi3mr_op_reply_queue { 377 U16 ci; 378 U8 ephase; 379 U8 qid; 380 U16 num_replies; 381 U32 qsz; 382 bus_dma_tag_t q_base_tag; 383 bus_dmamap_t q_base_dmamap; 384 void *q_base; 385 bus_addr_t q_base_phys; 386 mpi3mr_atomic_t pend_ios; 387 bool in_use; 388 struct mtx q_lock; 389 }; 390 391 struct irq_info { 392 MPI3_REPLY_DESCRIPTORS_UNION *post_queue; 393 bus_dma_tag_t buffer_dmat; 394 struct resource *irq; 395 void *intrhand; 396 int irq_rid; 397 }; 398 399 struct mpi3mr_irq_context { 400 struct mpi3mr_softc *sc; 401 U16 msix_index; 402 struct mpi3mr_op_reply_queue *op_reply_q; 403 char name[MPI3MR_NAME_LENGTH]; 404 struct irq_info irq_info; 405 }; 406 407 MALLOC_DECLARE(M_MPI3MR); 408 SYSCTL_DECL(_hw_mpi3mr); 409 410 typedef struct mpi3mr_drvr_cmd DRVR_CMD; 411 typedef void (*DRVR_CMD_CALLBACK)(struct mpi3mr_softc *mrioc, DRVR_CMD *drvrcmd); 412 struct mpi3mr_drvr_cmd { 413 struct mtx lock; 414 struct completion completion; 415 void *reply; 416 U8 *sensebuf; 417 U8 iou_rc; 418 U16 state; 419 U16 dev_handle; 420 U16 ioc_status; 421 U32 ioc_loginfo; 422 U8 is_waiting; 423 U8 is_senseprst; 424 U8 retry_count; 425 U16 host_tag; 426 DRVR_CMD_CALLBACK callback; 427 }; 428 429 struct mpi3mr_cmd; 430 typedef void mpi3mr_evt_callback_t(struct mpi3mr_softc *, uintptr_t, 431 Mpi3EventNotificationReply_t *reply); 432 typedef void mpi3mr_cmd_callback_t(struct mpi3mr_softc *, 433 struct mpi3mr_cmd *cmd); 434 435 #define MPI3MR_IOVEC_COUNT 2 436 437 enum mpi3mr_data_xfer_direction { 438 MPI3MR_READ = 1, 439 MPI3MR_WRITE, 440 }; 441 442 enum mpi3mr_cmd_state { 443 MPI3MR_CMD_STATE_FREE = 1, 444 MPI3MR_CMD_STATE_BUSY, 445 MPI3MR_CMD_STATE_IN_QUEUE, 446 MPI3MR_CMD_STATE_IN_TM, 447 }; 448 449 enum mpi3mr_target_state { 450 MPI3MR_DEV_CREATED = 1, 451 MPI3MR_DEV_REMOVE_HS_STARTED = 2, 452 MPI3MR_DEV_DELETED = 3, 453 }; 454 455 struct mpi3mr_cmd { 456 TAILQ_ENTRY(mpi3mr_cmd) next; 457 struct mpi3mr_softc *sc; 458 union ccb *ccb; 459 void *data; 460 u_int length; 461 u_int out_len; 462 struct uio uio; 463 struct iovec iovec[MPI3MR_IOVEC_COUNT]; 464 u_int max_segs; 465 struct mpi3mr_target *targ; 466 u_int lun; 467 u_int data_dir; 468 u_int state; 469 bus_dmamap_t dmamap; 470 struct scsi_sense_data *sense; 471 struct callout callout; 472 bool callout_owner; 473 mpi3mr_cmd_callback_t *timeout_handler; 474 U16 hosttag; 475 U8 req_qidx; 476 Mpi3SCSIIORequest_t io_request; 477 int error_code; 478 }; 479 480 struct mpi3mr_chain { 481 bus_dmamap_t buf_dmamap; 482 void *buf; 483 bus_addr_t buf_phys; 484 }; 485 486 struct mpi3mr_event_handle { 487 TAILQ_ENTRY(mpi3mr_event_handle) eh_list; 488 mpi3mr_evt_callback_t *callback; 489 void *data; 490 uint8_t mask[16]; 491 }; 492 493 struct mpi3mr_fw_event_work { 494 U16 event; 495 void *event_data; 496 TAILQ_ENTRY(mpi3mr_fw_event_work) ev_link; 497 U8 send_ack; 498 U8 process_event; 499 U32 event_context; 500 U16 event_data_size; 501 }; 502 503 /** 504 * struct delayed_dev_rmhs_node - Delayed device removal node 505 * 506 * @list: list head 507 * @handle: Device handle 508 * @iou_rc: IO Unit Control Reason Code 509 */ 510 struct delayed_dev_rmhs_node { 511 TAILQ_ENTRY(delayed_dev_rmhs_node) list; 512 U16 handle; 513 U8 iou_rc; 514 }; 515 516 /** 517 * struct delayed_evtack_node - Delayed event ack node 518 * 519 * @list: list head 520 * @event: MPI3 event ID 521 * @event_ctx: Event context 522 */ 523 struct delayed_evtack_node { 524 TAILQ_ENTRY(delayed_evtack_node) list; 525 U8 event; 526 U32 event_ctx; 527 }; 528 529 /* Reset types */ 530 enum reset_type { 531 MPI3MR_NO_RESET, 532 MPI3MR_TRIGGER_SOFT_RESET, 533 }; 534 535 struct mpi3mr_reset { 536 u_int type; 537 U32 reason; 538 int status; 539 bool ioctl_reset_snapdump; 540 }; 541 542 struct mpi3mr_softc { 543 device_t mpi3mr_dev; 544 struct cdev *mpi3mr_cdev; 545 u_int mpi3mr_flags; 546 #define MPI3MR_FLAGS_SHUTDOWN (1 << 0) 547 #define MPI3MR_FLAGS_DIAGRESET (1 << 1) 548 #define MPI3MR_FLAGS_ATTACH_DONE (1 << 2) 549 #define MPI3MR_FLAGS_PORT_ENABLE_DONE (1 << 3) 550 U8 id; 551 int cpu_count; 552 char name[MPI3MR_NAME_LENGTH]; 553 char driver_name[MPI3MR_NAME_LENGTH]; 554 int bars; 555 int dma_mask; 556 u_int mpi3mr_debug; 557 struct mpi3mr_reset reset; 558 int max_msix_vectors; 559 int msix_count; 560 bool msix_enable; 561 int io_cmds_highwater; 562 int max_chains; 563 uint32_t chain_frame_size; 564 struct sysctl_ctx_list sysctl_ctx; 565 struct sysctl_oid *sysctl_tree; 566 char fw_version[16]; 567 char msg_version[8]; 568 struct mpi3mr_chain *chains; 569 struct callout periodic; 570 struct callout device_check_callout; 571 572 struct mpi3mr_cam_softc *cam_sc; 573 struct mpi3mr_cmd **cmd_list; 574 TAILQ_HEAD(, mpi3mr_cmd) cmd_list_head; 575 struct mtx cmd_pool_lock; 576 577 struct resource *mpi3mr_regs_resource; 578 bus_space_handle_t mpi3mr_bhandle; 579 bus_space_tag_t mpi3mr_btag; 580 int mpi3mr_regs_rid; 581 582 bus_dma_tag_t mpi3mr_parent_dmat; 583 bus_dma_tag_t buffer_dmat; 584 585 int num_reqs; 586 int num_replies; 587 int num_chains; 588 589 TAILQ_HEAD(, mpi3mr_event_handle) event_list; 590 struct mpi3mr_event_handle *mpi3mr_log_eh; 591 struct intr_config_hook mpi3mr_ich; 592 593 struct mtx mpi3mr_mtx; 594 struct mtx io_lock; 595 U8 intr_enabled; 596 TAILQ_HEAD(, delayed_dev_rmhs_node) delayed_rmhs_list; 597 TAILQ_HEAD(, delayed_evtack_node) delayed_evtack_cmds_list; 598 599 U16 num_admin_reqs; 600 U32 admin_req_q_sz; 601 U16 admin_req_pi; 602 U16 admin_req_ci; 603 bus_dma_tag_t admin_req_tag; 604 bus_dmamap_t admin_req_dmamap; 605 bus_addr_t admin_req_phys; 606 U8 *admin_req; 607 struct mtx admin_req_lock; 608 609 U16 num_admin_replies; 610 U32 admin_reply_q_sz; 611 U16 admin_reply_ci; 612 U8 admin_reply_ephase; 613 bus_dma_tag_t admin_reply_tag; 614 bus_dmamap_t admin_reply_dmamap; 615 bus_addr_t admin_reply_phys; 616 U8 *admin_reply; 617 struct mtx admin_reply_lock; 618 bool admin_in_use; 619 620 U32 num_reply_bufs; 621 bus_dma_tag_t reply_buf_tag; 622 bus_dmamap_t reply_buf_dmamap; 623 bus_addr_t reply_buf_phys; 624 U8 *reply_buf; 625 bus_addr_t reply_buf_dma_max_address; 626 bus_addr_t reply_buf_dma_min_address; 627 628 U16 reply_free_q_sz; 629 bus_dma_tag_t reply_free_q_tag; 630 bus_dmamap_t reply_free_q_dmamap; 631 bus_addr_t reply_free_q_phys; 632 U64 *reply_free_q; 633 struct mtx reply_free_q_lock; 634 U32 reply_free_q_host_index; 635 636 U32 num_sense_bufs; 637 bus_dma_tag_t sense_buf_tag; 638 bus_dmamap_t sense_buf_dmamap; 639 bus_addr_t sense_buf_phys; 640 U8 *sense_buf; 641 642 U16 sense_buf_q_sz; 643 bus_dma_tag_t sense_buf_q_tag; 644 bus_dmamap_t sense_buf_q_dmamap; 645 bus_addr_t sense_buf_q_phys; 646 U64 *sense_buf_q; 647 struct mtx sense_buf_q_lock; 648 U32 sense_buf_q_host_index; 649 650 void *nvme_encap_prp_list; 651 bus_addr_t nvme_encap_prp_list_dma; 652 bus_dma_tag_t nvme_encap_prp_list_dmatag; 653 bus_dmamap_t nvme_encap_prp_list_dma_dmamap; 654 U32 nvme_encap_prp_sz; 655 656 U32 ready_timeout; 657 658 struct mpi3mr_irq_context *irq_ctx; 659 660 U16 num_queues; /* Number of request/reply queues */ 661 struct mpi3mr_op_req_queue *op_req_q; 662 struct mpi3mr_op_reply_queue *op_reply_q; 663 U16 num_hosttag_op_req_q; 664 665 struct mpi3mr_drvr_cmd init_cmds; 666 struct mpi3mr_ioc_facts facts; 667 U16 reply_sz; 668 U16 op_reply_sz; 669 670 U32 event_masks[MPI3_EVENT_NOTIFY_EVENTMASK_WORDS]; 671 672 char fwevt_worker_name[MPI3MR_NAME_LENGTH]; 673 struct workqueue_struct *fwevt_worker_thread; 674 struct mtx fwevt_lock; 675 struct mtx target_lock; 676 677 U16 max_host_ios; 678 bus_dma_tag_t chain_sgl_list_tag; 679 struct mpi3mr_chain *chain_sgl_list; 680 U16 chain_bitmap_sz; 681 void *chain_bitmap; 682 struct mtx chain_buf_lock; 683 U16 chain_buf_count; 684 685 struct mpi3mr_drvr_cmd ioctl_cmds; 686 struct mpi3mr_drvr_cmd host_tm_cmds; 687 struct mpi3mr_drvr_cmd dev_rmhs_cmds[MPI3MR_NUM_DEVRMCMD]; 688 struct mpi3mr_drvr_cmd evtack_cmds[MPI3MR_NUM_EVTACKCMD]; 689 690 U16 devrem_bitmap_sz; 691 void *devrem_bitmap; 692 693 U16 dev_handle_bitmap_sz; 694 void *removepend_bitmap; 695 696 U16 evtack_cmds_bitmap_sz; 697 void *evtack_cmds_bitmap; 698 699 U32 ts_update_counter; 700 U8 reset_in_progress; 701 U8 unrecoverable; 702 U8 block_ioctls; 703 U8 in_prep_ciactv_rst; 704 U16 prep_ciactv_rst_counter; 705 struct mtx reset_mutex; 706 707 U8 prepare_for_reset; 708 U16 prepare_for_reset_timeout_counter; 709 710 U16 diagsave_timeout; 711 int logging_level; 712 U16 flush_io_count; 713 714 Mpi3DriverInfoLayout_t driver_info; 715 716 U16 change_count; 717 718 U8 *log_data_buffer; 719 U16 log_data_buffer_index; 720 U16 log_data_entry_size; 721 722 U8 pel_wait_pend; 723 U8 pel_abort_requested; 724 U8 pel_class; 725 U16 pel_locale; 726 727 struct mpi3mr_drvr_cmd pel_cmds; 728 struct mpi3mr_drvr_cmd pel_abort_cmd; 729 U32 newest_seqnum; 730 void *pel_seq_number; 731 bus_addr_t pel_seq_number_dma; 732 bus_dma_tag_t pel_seq_num_dmatag; 733 bus_dmamap_t pel_seq_num_dmamap; 734 U32 pel_seq_number_sz; 735 736 struct selinfo mpi3mr_select; 737 U32 mpi3mr_poll_waiting; 738 U32 mpi3mr_aen_triggered; 739 740 U16 wait_for_port_enable; 741 U16 track_mapping_events; 742 U16 pending_map_events; 743 mpi3mr_atomic_t fw_outstanding; 744 mpi3mr_atomic_t pend_ioctls; 745 struct proc *watchdog_thread; 746 void *watchdog_chan; 747 void *tm_chan; 748 u_int8_t remove_in_progress; 749 u_int8_t watchdog_thread_active; 750 u_int8_t do_timedout_reset; 751 bool allow_ios; 752 bool secure_ctrl; 753 mpi3mr_atomic_t pend_large_data_sz; 754 755 u_int32_t io_throttle_data_length; 756 u_int32_t io_throttle_high; 757 u_int32_t io_throttle_low; 758 u_int16_t num_io_throttle_group; 759 u_int iot_enable; 760 struct mpi3mr_throttle_group_info *throttle_groups; 761 762 struct dma_memory_desc ioctl_sge[MPI3MR_NUM_IOCTL_SGE]; 763 struct dma_memory_desc ioctl_chain_sge; 764 struct dma_memory_desc ioctl_resp_sge; 765 bool ioctl_sges_allocated; 766 }; 767 768 static __inline uint64_t 769 mpi3mr_regread64(struct mpi3mr_softc *sc, uint32_t offset) 770 { 771 return bus_space_read_8(sc->mpi3mr_btag, sc->mpi3mr_bhandle, offset); 772 } 773 774 static __inline void 775 mpi3mr_regwrite64(struct mpi3mr_softc *sc, uint32_t offset, uint64_t val) 776 { 777 bus_space_write_8(sc->mpi3mr_btag, sc->mpi3mr_bhandle, offset, val); 778 } 779 780 static __inline uint32_t 781 mpi3mr_regread(struct mpi3mr_softc *sc, uint32_t offset) 782 { 783 return bus_space_read_4(sc->mpi3mr_btag, sc->mpi3mr_bhandle, offset); 784 } 785 786 static __inline void 787 mpi3mr_regwrite(struct mpi3mr_softc *sc, uint32_t offset, uint32_t val) 788 { 789 bus_space_write_4(sc->mpi3mr_btag, sc->mpi3mr_bhandle, offset, val); 790 } 791 792 #define MPI3MR_INFO (1 << 0) /* Basic info */ 793 #define MPI3MR_FAULT (1 << 1) /* Hardware faults */ 794 #define MPI3MR_EVENT (1 << 2) /* Event data from the controller */ 795 #define MPI3MR_LOG (1 << 3) /* Log data from the controller */ 796 #define MPI3MR_RECOVERY (1 << 4) /* Command error recovery tracing */ 797 #define MPI3MR_ERROR (1 << 5) /* Fatal driver/OS APIs failure */ 798 #define MPI3MR_XINFO (1 << 6) /* Additional info logs*/ 799 #define MPI3MR_TRACE (1 << 7) /* Trace functions */ 800 #define MPI3MR_IOT (1 << 8) /* IO throttling related debugs */ 801 #define MPI3MR_DEBUG_TM (1 << 9) /* Task management related debugs */ 802 #define MPI3MR_DEBUG_IOCTL (1 << 10) /* IOCTL related debugs */ 803 804 #define mpi3mr_printf(sc, args...) \ 805 device_printf((sc)->mpi3mr_dev, ##args) 806 807 #define mpi3mr_print_field(sc, msg, args...) \ 808 printf("\t" msg, ##args) 809 810 #define mpi3mr_vprintf(sc, args...) \ 811 do { \ 812 if (bootverbose) \ 813 mpi3mr_printf(sc, ##args); \ 814 } while (0) 815 816 #define mpi3mr_dprint(sc, level, msg, args...) \ 817 do { \ 818 if ((sc)->mpi3mr_debug & (level)) \ 819 device_printf((sc)->mpi3mr_dev, msg, ##args); \ 820 } while (0) 821 822 #define MPI3MR_PRINTFIELD_START(sc, tag...) \ 823 mpi3mr_printf((sc), ##tag); \ 824 mpi3mr_print_field((sc), ":\n") 825 #define MPI3MR_PRINTFIELD_END(sc, tag) \ 826 mpi3mr_printf((sc), tag "\n") 827 #define MPI3MR_PRINTFIELD(sc, facts, attr, fmt) \ 828 mpi3mr_print_field((sc), #attr ": " #fmt "\n", (facts)->attr) 829 830 #define mpi3mr_kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \ 831 kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) 832 #define mpi3mr_kproc_exit(arg) kproc_exit(arg) 833 834 #if defined(CAM_PRIORITY_XPT) 835 #define MPI3MR_PRIORITY_XPT CAM_PRIORITY_XPT 836 #else 837 #define MPI3MR_PRIORITY_XPT 5 838 #endif 839 840 static __inline void 841 mpi3mr_clear_bit(int b, volatile void *p) 842 { 843 atomic_clear_int(((volatile int *)p) + (b >> 5), 1 << (b & 0x1f)); 844 } 845 846 static __inline void 847 mpi3mr_set_bit(int b, volatile void *p) 848 { 849 atomic_set_int(((volatile int *)p) + (b >> 5), 1 << (b & 0x1f)); 850 } 851 852 static __inline int 853 mpi3mr_test_bit(int b, volatile void *p) 854 { 855 return ((volatile int *)p)[b >> 5] & (1 << (b & 0x1f)); 856 } 857 858 static __inline int 859 mpi3mr_test_and_set_bit(int b, volatile void *p) 860 { 861 int ret = ((volatile int *)p)[b >> 5] & (1 << (b & 0x1f)); 862 863 atomic_set_int(((volatile int *)p) + (b >> 5), 1 << (b & 0x1f)); 864 return ret; 865 } 866 867 static __inline int 868 mpi3mr_find_first_zero_bit(void *p, int bit_count) 869 { 870 int i, sz, j=0; 871 U8 *loc; 872 873 sz = bit_count % 8 ? (bit_count / 8 + 1) : (bit_count / 8); 874 loc = malloc(sz, M_MPI3MR, M_NOWAIT | M_ZERO); 875 876 memcpy(loc, p, sz); 877 878 for (i = 0; i < sz; i++) { 879 j = 0; 880 while (j < 8) { 881 if (!((loc[i] >> j) & 0x1)) 882 goto out; 883 j++; 884 } 885 } 886 out: 887 free(loc, M_MPI3MR); 888 return (i + j); 889 } 890 891 #define MPI3MR_DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d)) 892 893 void 894 init_completion(struct completion *completion); 895 896 void 897 complete(struct completion *completion); 898 899 void wait_for_completion_timeout(struct completion *completion, 900 U32 timeout); 901 void wait_for_completion_timeout_tm(struct completion *completion, 902 U32 timeout, struct mpi3mr_softc *sc); 903 void mpi3mr_add_sg_single(void *paddr, U8 flags, U32 length, 904 bus_addr_t dma_addr); 905 void mpi3mr_enable_interrupts(struct mpi3mr_softc *sc); 906 void mpi3mr_disable_interrupts(struct mpi3mr_softc *sc); 907 void mpi3mr_memaddr_cb(void *arg, bus_dma_segment_t *segs, int nsegs, int error); 908 int mpi3mr_submit_admin_cmd(struct mpi3mr_softc *mrioc, void *admin_req, 909 U16 admin_req_sz); 910 int mpi3mr_submit_io(struct mpi3mr_softc *mrioc, 911 struct mpi3mr_op_req_queue *op_req_q, U8 *req); 912 int 913 mpi3mr_alloc_interrupts(struct mpi3mr_softc *sc, U16 setup_one); 914 915 void mpi3mr_cleanup_ioc(struct mpi3mr_softc *sc); 916 int mpi3mr_initialize_ioc(struct mpi3mr_softc *sc, U8 reason); 917 void mpi3mr_build_zero_len_sge(void *paddr); 918 int mpi3mr_issue_event_notification(struct mpi3mr_softc *sc); 919 int 920 mpi3mr_register_events(struct mpi3mr_softc *sc); 921 void mpi3mr_process_op_reply_desc(struct mpi3mr_softc *sc, 922 Mpi3DefaultReplyDescriptor_t *reply_desc, U64 *reply_dma); 923 struct mpi3mr_cmd * 924 mpi3mr_get_command(struct mpi3mr_softc *sc); 925 void 926 mpi3mr_release_command(struct mpi3mr_cmd *cmd); 927 int 928 mpi3mr_complete_io_cmd(struct mpi3mr_softc *sc, 929 struct mpi3mr_irq_context *irq_context); 930 int 931 mpi3mr_cam_detach(struct mpi3mr_softc *sc); 932 int 933 mpi3mr_cam_attach(struct mpi3mr_softc *sc); 934 struct mpi3mr_target * 935 mpi3mr_find_target_by_per_id(struct mpi3mr_cam_softc *cam_sc, 936 uint16_t per_id); 937 struct mpi3mr_target * 938 mpi3mr_find_target_by_dev_handle(struct mpi3mr_cam_softc *cam_sc, 939 uint16_t dev_handle); 940 int mpi3mr_create_device(struct mpi3mr_softc *sc, 941 Mpi3DevicePage0_t *dev_pg0); 942 void 943 mpi3mr_unmap_request(struct mpi3mr_softc *sc, struct mpi3mr_cmd *cmd); 944 void 945 init_completion(struct completion *completion); 946 void 947 complete(struct completion *completion); 948 void wait_for_completion_timeout(struct completion *completion, 949 U32 timeout); 950 void 951 poll_for_command_completion(struct mpi3mr_softc *sc, 952 struct mpi3mr_drvr_cmd *cmd, U16 wait); 953 int 954 mpi3mr_alloc_requests(struct mpi3mr_softc *sc); 955 void 956 mpi3mr_watchdog(void *arg); 957 int mpi3mr_issue_port_enable(struct mpi3mr_softc *mrioc, U8 async); 958 void 959 mpi3mr_isr(void *privdata); 960 int 961 mpi3mr_alloc_msix_queues(struct mpi3mr_softc *sc); 962 void 963 mpi3mr_destory_mtx(struct mpi3mr_softc *sc); 964 void 965 mpi3mr_free_mem(struct mpi3mr_softc *sc); 966 void 967 mpi3mr_cleanup_interrupts(struct mpi3mr_softc *sc); 968 int mpi3mr_setup_irqs(struct mpi3mr_softc *sc); 969 void mpi3mr_cleanup_event_taskq(struct mpi3mr_softc *sc); 970 void 971 mpi3mr_hexdump(void *buf, int sz, int format); 972 int mpi3mr_soft_reset_handler(struct mpi3mr_softc *sc, 973 U32 reset_reason, bool snapdump); 974 void 975 mpi3mrsas_release_simq_reinit(struct mpi3mr_cam_softc *cam_sc); 976 void 977 mpi3mr_watchdog_thread(void *arg); 978 void mpi3mr_add_device(struct mpi3mr_softc *sc, U16 per_id); 979 int mpi3mr_remove_device(struct mpi3mr_softc *sc, U16 handle); 980 int 981 mpi3mrsas_register_events(struct mpi3mr_softc *sc); 982 int mpi3mr_process_event_ack(struct mpi3mr_softc *sc, U8 event, 983 U32 event_ctx); 984 int mpi3mr_remove_device_from_os(struct mpi3mr_softc *sc, U16 handle); 985 void mpi3mr_remove_device_from_list(struct mpi3mr_softc *sc, struct mpi3mr_target *target, 986 bool must_delete); 987 void mpi3mr_update_device(struct mpi3mr_softc *mrioc, 988 struct mpi3mr_target *tgtdev, Mpi3DevicePage0_t *dev_pg0, bool is_added); 989 void mpi3mr_app_save_logdata(struct mpi3mr_softc *sc, char *event_data, U16 event_data_size); 990 void mpi3mr_set_io_divert_for_all_vd_in_tg(struct mpi3mr_softc *sc, 991 struct mpi3mr_throttle_group_info *tg, U8 divert_value); 992 enum mpi3mr_iocstate mpi3mr_get_iocstate(struct mpi3mr_softc *sc); 993 void mpi3mr_poll_pend_io_completions(struct mpi3mr_softc *sc); 994 void int_to_lun(unsigned int lun, U8 *req_lun); 995 void trigger_reset_from_watchdog(struct mpi3mr_softc *sc, U8 reset_type, U32 reset_reason); 996 void mpi3mr_alloc_ioctl_dma_memory(struct mpi3mr_softc *sc); 997 #endif /*MPI3MR_H_INCLUDED*/ 998