1 /*- 2 * Copyright (c) 2018 Microsemi Corporation. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 */ 26 27 /* $FreeBSD$ */ 28 29 #ifndef _PQI_DEFINES_H 30 #define _PQI_DEFINES_H 31 32 #define PQI_STATUS_FAILURE -1 33 #define PQI_STATUS_TIMEOUT -2 34 #define PQI_STATUS_QFULL -3 35 #define PQI_STATUS_SUCCESS 0 36 37 #define PQISRC_CMD_TIMEOUT_CNT 1200000 /* 500usec * 1200000 = 5 min */ 38 #define PQI_CMND_COMPLETE_TMO 1000 /* in millisecond */ 39 40 #define INVALID_ELEM 0xffff 41 #ifndef MIN 42 #define MIN(a,b) ((a) < (b) ? (a) : (b)) 43 #endif 44 45 #ifndef MAX 46 #define MAX(a,b) ((a) > (b) ? (a) : (b)) 47 #endif 48 49 #define PQISRC_ROUNDUP(x, y) (((x) + (y) - 1) / (y) * (y)) 50 #define PQISRC_DIV_ROUND_UP(x, y) (((x) + (y) - 1) / (y)) 51 52 #define ALIGN_BOUNDARY(a, n) { \ 53 if (a % n) \ 54 a = a + (n - a % n); \ 55 } 56 57 /* Busy wait timeout on a condition */ 58 #define COND_BUSYWAIT(cond, timeout /* in millisecond */) { \ 59 if (!(cond)) { \ 60 while (timeout) { \ 61 OS_BUSYWAIT(1000); \ 62 if (cond) \ 63 break; \ 64 timeout--; \ 65 } \ 66 } \ 67 } 68 69 /* Wait timeout on a condition*/ 70 #define COND_WAIT(cond, timeout /* in millisecond */) { \ 71 if (!(cond)) { \ 72 while (timeout) { \ 73 OS_SLEEP(1000); \ 74 if (cond) \ 75 break; \ 76 timeout--; \ 77 } \ 78 } \ 79 } 80 81 #define FILL_QUEUE_ARRAY_ADDR(q,virt,dma) { \ 82 q->array_virt_addr = virt; \ 83 q->array_dma_addr = dma; \ 84 } 85 86 #define true 1 87 #define false 0 88 89 enum INTR_TYPE { 90 LOCK_INTR, 91 LOCK_SLEEP 92 }; 93 94 #define LOCKNAME_SIZE 32 95 96 #define INTR_TYPE_NONE 0x0 97 #define INTR_TYPE_FIXED 0x1 98 #define INTR_TYPE_MSI 0x2 99 #define INTR_TYPE_MSIX 0x4 100 #define SIS_ENABLE_MSIX 0x40 101 #define SIS_ENABLE_INTX 0x80 102 #define PQISRC_LEGACY_INTX_MASK 0x1 103 104 #define DMA_TO_VIRT(mem) ((mem)->virt_addr) 105 #define DMA_PHYS_LOW(mem) (((mem)->dma_addr) & 0x00000000ffffffff) 106 #define DMA_PHYS_HIGH(mem) ((((mem)->dma_addr) & 0xffffffff00000000) >> 32) 107 108 typedef enum REQUEST_STATUS { 109 REQUEST_SUCCESS = 0, 110 REQUEST_PENDING = -1, 111 REQUEST_FAILED = -2, 112 }REQUEST_STATUS_T; 113 114 typedef enum IO_PATH { 115 AIO_PATH, 116 RAID_PATH 117 }IO_PATH_T; 118 119 typedef enum device_type 120 { 121 DISK_DEVICE, 122 TAPE_DEVICE, 123 ROM_DEVICE = 5, 124 SES_DEVICE, 125 CONTROLLER_DEVICE, 126 MEDIUM_CHANGER_DEVICE, 127 RAID_DEVICE = 0x0c, 128 ENCLOSURE_DEVICE, 129 ZBC_DEVICE = 0x14 130 } device_type_t; 131 132 typedef enum controller_state { 133 PQI_UP_RUNNING, 134 PQI_BUS_RESET, 135 }controller_state_t; 136 137 #define PQISRC_MAX_MSIX_SUPPORTED 64 138 139 /* SIS Specific */ 140 #define PQISRC_INIT_STRUCT_REVISION 9 141 #define PQISRC_SECTOR_SIZE 512 142 #define PQISRC_BLK_SIZE PQISRC_SECTOR_SIZE 143 #define PQISRC_DEFAULT_DMA_ALIGN 4 144 #define PQISRC_DMA_ALIGN_MASK (PQISRC_DEFAULT_DMA_ALIGN - 1) 145 #define PQISRC_ERR_BUF_DMA_ALIGN 32 146 #define PQISRC_ERR_BUF_ELEM_SIZE MAX(sizeof(raid_path_error_info_elem_t),sizeof(aio_path_error_info_elem_t)) 147 #define PQISRC_INIT_STRUCT_DMA_ALIGN 16 148 149 #define SIS_CMD_GET_ADAPTER_PROPERTIES 0x19 150 #define SIS_CMD_GET_COMM_PREFERRED_SETTINGS 0x26 151 #define SIS_CMD_GET_PQI_CAPABILITIES 0x3000 152 #define SIS_CMD_INIT_BASE_STRUCT_ADDRESS 0x1b 153 154 #define SIS_SUPPORT_EXT_OPT 0x00800000 155 #define SIS_SUPPORT_PQI 0x00000004 156 #define SIS_SUPPORT_PQI_RESET_QUIESCE 0x00000008 157 158 #define SIS_PQI_RESET_QUIESCE 0x1000000 159 160 #define SIS_STATUS_OK_TIMEOUT 120000 /* in milli sec, 5 sec */ 161 162 #define SIS_CMD_COMPLETE_TIMEOUT 30000 /* in milli sec, 30 secs */ 163 #define SIS_POLL_START_WAIT_TIME 20000 /* in micro sec, 20 milli sec */ 164 #define SIS_DB_BIT_CLEAR_TIMEOUT_CNT 120000 /* 500usec * 120000 = 60 sec */ 165 166 #define SIS_ENABLE_TIMEOUT 3000 167 #define REENABLE_SIS 0x1 168 #define TRIGGER_NMI_SIS 0x800000 169 /*SIS Register status defines */ 170 171 #define PQI_CTRL_KERNEL_UP_AND_RUNNING 0x80 172 #define PQI_CTRL_KERNEL_PANIC 0x100 173 174 #define SIS_CTL_TO_HOST_DB_DISABLE_ALL 0xFFFFFFFF 175 #define SIS_CTL_TO_HOST_DB_CLEAR 0x00001000 176 #define SIS_CMD_SUBMIT 0x00000200 /* Bit 9 */ 177 #define SIS_CMD_COMPLETE 0x00001000 /* Bit 12 */ 178 #define SIS_CMD_STATUS_SUCCESS 0x1 179 180 /* PQI specific */ 181 182 /* defines */ 183 #define PQISRC_PQI_REG_OFFSET 0x4000 184 #define PQISRC_MAX_OUTSTANDING_REQ 4096 185 #define PQISRC_MAX_ADMIN_IB_QUEUE_ELEM_NUM 16 186 #define PQISRC_MAX_ADMIN_OB_QUEUE_ELEM_NUM 16 187 188 #define PQI_MIN_OP_IB_QUEUE_ID 1 189 #define PQI_OP_EVENT_QUEUE_ID 1 190 #define PQI_MIN_OP_OB_QUEUE_ID 2 191 192 #define PQISRC_MAX_SUPPORTED_OP_IB_Q 128 193 #define PQISRC_MAX_SUPPORTED_OP_RAID_IB_Q (PQISRC_MAX_SUPPORTED_OP_IB_Q / 2) 194 #define PQISRC_MAX_SUPPORTED_OP_AIO_IB_Q (PQISRC_MAX_SUPPORTED_OP_RAID_IB_Q) 195 #define PQISRC_MAX_OP_IB_QUEUE_ELEM_NUM (PQISRC_MAX_OUTSTANDING_REQ / PQISRC_MAX_SUPPORTED_OP_IB_Q) 196 #define PQISRC_MAX_OP_OB_QUEUE_ELEM_NUM PQISRC_MAX_OUTSTANDING_REQ 197 #define PQISRC_MIN_OP_OB_QUEUE_ELEM_NUM 2 198 #define PQISRC_MAX_SUPPORTED_OP_OB_Q 64 199 #define PQISRC_OP_MAX_IBQ_ELEM_SIZE 8 /* 8 * 16 = 128 bytes */ 200 #define PQISRC_OP_MIN_IBQ_ELEM_SIZE 2 /* 2 * 16 = 32 bytes */ 201 #define PQISRC_OP_OBQ_ELEM_SIZE 1 /* 16 bytes */ 202 #define PQISRC_ADMIN_IBQ_ELEM_SIZE 2 /* 2 * 16 = 32 bytes */ 203 #define PQISRC_INTR_COALSC_GRAN 0 204 #define PQISRC_PROTO_BIT_MASK 0 205 #define PQISRC_SGL_SUPPORTED_BIT_MASK 0 206 207 #define PQISRC_NUM_EVENT_Q_ELEM 32 208 #define PQISRC_EVENT_Q_ELEM_SIZE 32 209 210 /* PQI Registers state status */ 211 212 #define PQI_RESET_ACTION_RESET 0x1 213 #define PQI_RESET_ACTION_COMPLETED 0x2 214 #define PQI_RESET_TYPE_NO_RESET 0x0 215 #define PQI_RESET_TYPE_SOFT_RESET 0x1 216 #define PQI_RESET_TYPE_FIRM_RESET 0x2 217 #define PQI_RESET_TYPE_HARD_RESET 0x3 218 219 #define PQI_RESET_POLL_INTERVAL 100000 /*100 msec*/ 220 221 enum pqisrc_ctrl_mode{ 222 CTRL_SIS_MODE = 0, 223 CTRL_PQI_MODE 224 }; 225 226 /* PQI device performing internal initialization (e.g., POST). */ 227 #define PQI_DEV_STATE_POWER_ON_AND_RESET 0x0 228 /* Upon entry to this state PQI device initialization begins. */ 229 #define PQI_DEV_STATE_PQI_STATUS_AVAILABLE 0x1 230 /* PQI device Standard registers are available to the driver. */ 231 #define PQI_DEV_STATE_ALL_REGISTERS_READY 0x2 232 /* PQI device is initialized and ready to process any PCI transactions. */ 233 #define PQI_DEV_STATE_ADMIN_QUEUE_PAIR_READY 0x3 234 /* The PQI Device Error register indicates the error. */ 235 #define PQI_DEV_STATE_ERROR 0x4 236 237 #define PQI_DEV_STATE_AT_INIT ( PQI_DEV_STATE_PQI_STATUS_AVAILABLE | \ 238 PQI_DEV_STATE_ALL_REGISTERS_READY | \ 239 PQI_DEV_STATE_ADMIN_QUEUE_PAIR_READY ) 240 241 #define PQISRC_PQI_DEVICE_SIGNATURE "PQI DREG" 242 #define PQI_ADMINQ_ELEM_ARRAY_ALIGN 64 243 #define PQI_ADMINQ_CI_PI_ALIGN 64 244 #define PQI_OPQ_ELEM_ARRAY_ALIGN 64 245 #define PQI_OPQ_CI_PI_ALIGN 4 246 #define PQI_ADDR_ALIGN_MASK_64 0x3F /* lsb 6 bits */ 247 #define PQI_ADDR_ALIGN_MASK_4 0x3 /* lsb 2 bits */ 248 249 #define PQISRC_PQIMODE_READY_TIMEOUT (30 * 1000 ) /* 30 secs */ 250 #define PQISRC_MODE_READY_POLL_INTERVAL 1000 /* 1 msec */ 251 252 #define PRINT_PQI_SIGNATURE(sign) { int i = 0; \ 253 char si[9]; \ 254 for(i=0;i<8;i++) \ 255 si[i] = *((char *)&(sign)+i); \ 256 si[i] = '\0'; \ 257 DBG_INFO("Signature is %s",si); \ 258 } 259 #define PQI_CONF_TABLE_MAX_LEN ((uint16_t)~0) 260 #define PQI_CONF_TABLE_SIGNATURE "CFGTABLE" 261 262 /* PQI configuration table section IDs */ 263 #define PQI_CONF_TABLE_SECTION_GENERAL_INFO 0 264 #define PQI_CONF_TABLE_SECTION_FIRMWARE_FEATURES 1 265 #define PQI_CONF_TABLE_SECTION_FIRMWARE_ERRATA 2 266 #define PQI_CONF_TABLE_SECTION_DEBUG 3 267 #define PQI_CONF_TABLE_SECTION_HEARTBEAT 4 268 269 #define CTRLR_HEARTBEAT_CNT(softs) LE_64(PCI_MEM_GET64(softs, softs->heartbeat_counter_abs_addr, softs->heartbeat_counter_off)) 270 #define PQI_NEW_HEARTBEAT_MECHANISM(softs) 1 271 272 /* pqi-2r00a table 36 */ 273 #define PQI_ADMIN_QUEUE_MSIX_DISABLE (0x80000000) 274 #define PQI_ADMIN_QUEUE_MSIX_ENABLE (0 << 31) 275 276 #define PQI_ADMIN_QUEUE_CONF_FUNC_CREATE_Q_PAIR 0x01 277 #define PQI_ADMIN_QUEUE_CONF_FUNC_DEL_Q_PAIR 0x02 278 #define PQI_ADMIN_QUEUE_CONF_FUNC_STATUS_IDLE 0x00 279 #define PQISRC_ADMIN_QUEUE_CREATE_TIMEOUT 1000 /* in miLLI sec, 1 sec, 100 ms is standard */ 280 #define PQISRC_ADMIN_QUEUE_DELETE_TIMEOUT 100 /* 100 ms is standard */ 281 #define PQISRC_ADMIN_CMD_RESP_TIMEOUT 3000 /* 3 sec */ 282 #define PQISRC_RAIDPATH_CMD_TIMEOUT 30000 /* 30 sec */ 283 284 #define REPORT_PQI_DEV_CAP_DATA_BUF_SIZE sizeof(pqi_dev_cap_t) 285 #define REPORT_MANUFACTURER_INFO_DATA_BUF_SIZE 0x80 /* Data buffer size specified in bytes 0-1 of data buffer. 128 bytes. */ 286 /* PQI IUs */ 287 /* Admin IU request length not including header. */ 288 #define PQI_STANDARD_IU_LENGTH 0x003C /* 60 bytes. */ 289 #define PQI_IU_TYPE_GENERAL_ADMIN_REQUEST 0x60 290 #define PQI_IU_TYPE_GENERAL_ADMIN_RESPONSE 0xe0 291 292 /* PQI / Vendor specific IU */ 293 #define PQI_FUNCTION_REPORT_DEV_CAP 0x00 294 #define PQI_REQUEST_IU_TASK_MANAGEMENT 0x13 295 #define PQI_IU_TYPE_RAID_PATH_IO_REQUEST 0x14 296 #define PQI_IU_TYPE_AIO_PATH_IO_REQUEST 0x15 297 #define PQI_REQUEST_IU_GENERAL_ADMIN 0x60 298 #define PQI_REQUEST_IU_REPORT_VENDOR_EVENT_CONFIG 0x72 299 #define PQI_REQUEST_IU_SET_VENDOR_EVENT_CONFIG 0x73 300 #define PQI_RESPONSE_IU_GENERAL_MANAGEMENT 0x81 301 #define PQI_RESPONSE_IU_TASK_MANAGEMENT 0x93 302 #define PQI_RESPONSE_IU_GENERAL_ADMIN 0xe0 303 304 #define PQI_RESPONSE_IU_RAID_PATH_IO_SUCCESS 0xf0 305 #define PQI_RESPONSE_IU_AIO_PATH_IO_SUCCESS 0xf1 306 #define PQI_RESPONSE_IU_RAID_PATH_IO_ERROR 0xf2 307 #define PQI_RESPONSE_IU_AIO_PATH_IO_ERROR 0xf3 308 #define PQI_RESPONSE_IU_AIO_PATH_IS_OFF 0xf4 309 #define PQI_REQUEST_IU_ACKNOWLEDGE_VENDOR_EVENT 0xf6 310 #define PQI_REQUEST_HEADER_LENGTH 4 311 #define PQI_FUNCTION_CREATE_OPERATIONAL_IQ 0x10 312 #define PQI_FUNCTION_CREATE_OPERATIONAL_OQ 0x11 313 #define PQI_FUNCTION_DELETE_OPERATIONAL_IQ 0x12 314 #define PQI_FUNCTION_DELETE_OPERATIONAL_OQ 0x13 315 #define PQI_FUNCTION_CHANGE_OPERATIONAL_IQ_PROP 0x14 316 #define PQI_CHANGE_OP_IQ_PROP_ASSIGN_AIO 1 317 318 #define PQI_DEFAULT_IB_QUEUE 0 319 /* Interface macros */ 320 321 #define GET_FW_STATUS(softs) \ 322 (PCI_MEM_GET32(softs, &softs->ioa_reg->scratchpad3_fw_status, LEGACY_SIS_OMR)) 323 324 #define SIS_IS_KERNEL_PANIC(softs) \ 325 (GET_FW_STATUS(softs) & PQI_CTRL_KERNEL_PANIC) 326 327 #define SIS_IS_KERNEL_UP(softs) \ 328 (GET_FW_STATUS(softs) & PQI_CTRL_KERNEL_UP_AND_RUNNING) 329 330 #define PQI_GET_CTRL_MODE(softs) \ 331 (PCI_MEM_GET32(softs, &softs->ioa_reg->scratchpad0, LEGACY_SIS_SCR0)) 332 333 #define PQI_SAVE_CTRL_MODE(softs, mode) \ 334 PCI_MEM_PUT32(softs, &softs->ioa_reg->scratchpad0, LEGACY_SIS_SCR0, mode) 335 336 #define PQISRC_MAX_TARGETID 1024 337 #define PQISRC_MAX_TARGETLUN 64 338 339 /* Vendor specific IU Type for Event config Cmds */ 340 #define PQI_REQUEST_IU_REPORT_EVENT_CONFIG 0x72 341 #define PQI_REQUEST_IU_SET_EVENT_CONFIG 0x73 342 #define PQI_REQUEST_IU_ACKNOWLEDGE_VENDOR_EVENT 0xf6 343 #define PQI_RESPONSE_IU_GENERAL_MANAGEMENT 0x81 344 #define PQI_MANAGEMENT_CMD_RESP_TIMEOUT 3000 345 #define PQISRC_EVENT_ACK_RESP_TIMEOUT 1000 346 347 /* Supported Event types by controller */ 348 #define PQI_NUM_SUPPORTED_EVENTS 7 349 350 #define PQI_EVENT_TYPE_HOTPLUG 0x1 351 #define PQI_EVENT_TYPE_HARDWARE 0x2 352 #define PQI_EVENT_TYPE_PHYSICAL_DEVICE 0x4 353 #define PQI_EVENT_TYPE_LOGICAL_DEVICE 0x5 354 #define PQI_EVENT_TYPE_AIO_STATE_CHANGE 0xfd 355 #define PQI_EVENT_TYPE_AIO_CONFIG_CHANGE 0xfe 356 #define PQI_EVENT_TYPE_HEARTBEAT 0xff 357 358 /* for indexing into the pending_events[] field of struct pqisrc_softstate */ 359 #define PQI_EVENT_HEARTBEAT 0 360 #define PQI_EVENT_HOTPLUG 1 361 #define PQI_EVENT_HARDWARE 2 362 #define PQI_EVENT_PHYSICAL_DEVICE 3 363 #define PQI_EVENT_LOGICAL_DEVICE 4 364 #define PQI_EVENT_AIO_STATE_CHANGE 5 365 #define PQI_EVENT_AIO_CONFIG_CHANGE 6 366 367 #define PQI_MAX_HEARTBEAT_REQUESTS 5 368 369 /* Device flags */ 370 #define PQISRC_DFLAG_VALID (1 << 0) 371 #define PQISRC_DFLAG_CONFIGURING (1 << 1) 372 373 #define MAX_EMBEDDED_SG_IN_FIRST_IU 4 374 #define MAX_EMBEDDED_SG_IN_IU 8 375 #define SG_FLAG_LAST 0x40000000 376 #define SG_FLAG_CHAIN 0x80000000 377 378 #define IN_PQI_RESET(softs) (softs->ctlr_state & PQI_BUS_RESET) 379 #define DEV_GONE(dev) (!dev || (dev->invalid == true)) 380 #define IS_AIO_PATH(dev) (dev->aio_enabled) 381 #define IS_RAID_PATH(dev) (!dev->aio_enabled) 382 383 /* SOP data direction flags */ 384 #define SOP_DATA_DIR_NONE 0x00 385 #define SOP_DATA_DIR_FROM_DEVICE 0x01 386 #define SOP_DATA_DIR_TO_DEVICE 0x02 387 #define SOP_DATA_DIR_BIDIRECTIONAL 0x03 388 #define SOP_PARTIAL_DATA_BUFFER 0x04 389 390 #define PQISRC_DMA_VALID (1 << 0) 391 #define PQISRC_CMD_NO_INTR (1 << 1) 392 393 #define SOP_TASK_ATTRIBUTE_SIMPLE 0 394 #define SOP_TASK_ATTRIBUTE_HEAD_OF_QUEUE 1 395 #define SOP_TASK_ATTRIBUTE_ORDERED 2 396 #define SOP_TASK_ATTRIBUTE_ACA 4 397 398 #define SOP_TASK_MANAGEMENT_FUNCTION_COMPLETE 0x0 399 #define SOP_TASK_MANAGEMENT_FUNCTION_REJECTED 0x4 400 #define SOP_TASK_MANAGEMENT_FUNCTION_FAILED 0x5 401 #define SOP_TASK_MANAGEMENT_FUNCTION_SUCCEEDED 0x8 402 #define SOP_TASK_MANAGEMENT_FUNCTION_ABORT_TASK 0x01 403 #define SOP_TASK_MANAGEMENT_FUNCTION_ABORT_TASK_SET 0x02 404 #define SOP_TASK_MANAGEMENT_LUN_RESET 0x8 405 406 /* Additional CDB bytes */ 407 #define PQI_ADDITIONAL_CDB_BYTES_0 0 /* 16 byte CDB */ 408 #define PQI_ADDITIONAL_CDB_BYTES_4 1 /* 20 byte CDB */ 409 #define PQI_ADDITIONAL_CDB_BYTES_8 2 /* 24 byte CDB */ 410 #define PQI_ADDITIONAL_CDB_BYTES_12 3 /* 28 byte CDB */ 411 #define PQI_ADDITIONAL_CDB_BYTES_16 4 /* 32 byte CDB */ 412 413 #define PQI_PROTOCOL_SOP 0x0 414 415 #define PQI_AIO_STATUS_GOOD 0x0 416 #define PQI_AIO_STATUS_CHECK_CONDITION 0x2 417 #define PQI_AIO_STATUS_CONDITION_MET 0x4 418 #define PQI_AIO_STATUS_DEVICE_BUSY 0x8 419 #define PQI_AIO_STATUS_INT_GOOD 0x10 420 #define PQI_AIO_STATUS_INT_COND_MET 0x14 421 #define PQI_AIO_STATUS_RESERV_CONFLICT 0x18 422 #define PQI_AIO_STATUS_CMD_TERMINATED 0x22 423 #define PQI_AIO_STATUS_QUEUE_FULL 0x28 424 #define PQI_AIO_STATUS_TASK_ABORTED 0x40 425 #define PQI_AIO_STATUS_UNDERRUN 0x51 426 #define PQI_AIO_STATUS_OVERRUN 0x75 427 /* Status when Target Failure */ 428 #define PQI_AIO_STATUS_IO_ERROR 0x1 429 #define PQI_AIO_STATUS_IO_ABORTED 0x2 430 #define PQI_AIO_STATUS_IO_NO_DEVICE 0x3 431 #define PQI_AIO_STATUS_INVALID_DEVICE 0x4 432 #define PQI_AIO_STATUS_AIO_PATH_DISABLED 0xe 433 434 /* Service Response */ 435 #define PQI_AIO_SERV_RESPONSE_COMPLETE 0 436 #define PQI_AIO_SERV_RESPONSE_FAILURE 1 437 #define PQI_AIO_SERV_RESPONSE_TMF_COMPLETE 2 438 #define PQI_AIO_SERV_RESPONSE_TMF_SUCCEEDED 3 439 #define PQI_AIO_SERV_RESPONSE_TMF_REJECTED 4 440 #define PQI_AIO_SERV_RESPONSE_TMF_INCORRECT_LUN 5 441 442 #define PQI_TMF_WAIT_DELAY 10000000 /* 10 seconds */ 443 444 #define PQI_RAID_STATUS_GOOD PQI_AIO_STATUS_GOOD 445 #define PQI_RAID_STATUS_CHECK_CONDITION PQI_AIO_STATUS_CHECK_CONDITION 446 #define PQI_RAID_STATUS_CONDITION_MET PQI_AIO_STATUS_CONDITION_MET 447 #define PQI_RAID_STATUS_DEVICE_BUSY PQI_AIO_STATUS_DEVICE_BUSY 448 #define PQI_RAID_STATUS_INT_GOOD PQI_AIO_STATUS_INT_GOOD 449 #define PQI_RAID_STATUS_INT_COND_MET PQI_AIO_STATUS_INT_COND_MET 450 #define PQI_RAID_STATUS_RESERV_CONFLICT PQI_AIO_STATUS_RESERV_CONFLICT 451 #define PQI_RAID_STATUS_CMD_TERMINATED PQI_AIO_STATUS_CMD_TERMINATED 452 #define PQI_RAID_STATUS_QUEUE_FULL PQI_AIO_STATUS_QUEUE_FULL 453 #define PQI_RAID_STATUS_TASK_ABORTED PQI_AIO_STATUS_TASK_ABORTED 454 #define PQI_RAID_STATUS_UNDERRUN PQI_AIO_STATUS_UNDERRUN 455 #define PQI_RAID_STATUS_OVERRUN PQI_AIO_STATUS_OVERRUN 456 457 /* VPD inquiry pages */ 458 #define SCSI_VPD_SUPPORTED_PAGES 0x0 /* standard page */ 459 #define SCSI_VPD_DEVICE_ID 0x83 /* standard page */ 460 #define SA_VPD_PHYS_DEVICE_ID 0xc0 /* vendor-specific page */ 461 #define SA_VPD_LV_DEVICE_GEOMETRY 0xc1 /* vendor-specific page */ 462 #define SA_VPD_LV_IOACCEL_STATUS 0xc2 /* vendor-specific page */ 463 #define SA_VPD_LV_STATUS 0xc3 /* vendor-specific page */ 464 465 #define VPD_PAGE (1 << 8) 466 467 /* logical volume states */ 468 #define SA_LV_OK 0x0 469 #define SA_LV_NOT_AVAILABLE 0xb 470 #define SA_LV_UNDERGOING_ERASE 0xf 471 #define SA_LV_UNDERGOING_RPI 0x12 472 #define SA_LV_PENDING_RPI 0x13 473 #define SA_LV_ENCRYPTED_NO_KEY 0x14 474 #define SA_LV_PLAINTEXT_IN_ENCRYPT_ONLY_CONTROLLER 0x15 475 #define SA_LV_UNDERGOING_ENCRYPTION 0x16 476 #define SA_LV_UNDERGOING_ENCRYPTION_REKEYING 0x17 477 #define SA_LV_ENCRYPTED_IN_NON_ENCRYPTED_CONTROLLER 0x18 478 #define SA_LV_PENDING_ENCRYPTION 0x19 479 #define SA_LV_PENDING_ENCRYPTION_REKEYING 0x1a 480 #define SA_LV_STATUS_VPD_UNSUPPORTED 0xff 481 482 /* 483 * assume worst case: SATA queue depth of 31 minus 4 internal firmware commands 484 */ 485 #define PQI_PHYSICAL_DISK_DEFAULT_MAX_QUEUE_DEPTH 27 486 487 /* 0 = no limit */ 488 #define PQI_LOGICAL_DISK_DEFAULT_MAX_QUEUE_DEPTH 0 489 490 #define RAID_CTLR_LUNID "\0\0\0\0\0\0\0\0" 491 492 #define SA_CACHE_FLUSH 0x1 493 #define SA_INQUIRY 0x12 494 #define SA_REPORT_LOG 0xc2 /* Report Logical LUNs */ 495 #define SA_REPORT_PHYS 0xc3 /* Report Physical LUNs */ 496 #define SA_CISS_READ 0xc0 497 #define SA_GET_RAID_MAP 0xc8 498 499 #define SA_REPORT_LOG_EXTENDED 0x1 500 #define SA_REPORT_PHYS_EXTENDED 0x2 501 502 #define SA_CACHE_FLUSH_BUF_LEN 4 503 504 #define REPORT_LUN_DEV_FLAG_AIO_ENABLED 0x8 505 #define PQI_MAX_TRANSFER_SIZE (4 * 1024U * 1024U) 506 #define RAID_MAP_MAX_ENTRIES 1024 507 #define RAID_MAP_ENCRYPTION_ENABLED 0x1 508 #define PQI_PHYSICAL_DISK_DEFAULT_MAX_QUEUE_DEPTH 27 509 510 #define ASC_LUN_NOT_READY 0x4 511 #define ASCQ_LUN_NOT_READY_FORMAT_IN_PROGRESS 0x4 512 #define ASCQ_LUN_NOT_READY_INITIALIZING_CMD_REQ 0x2 513 514 #define OBDR_SIG_OFFSET 43 515 #define OBDR_TAPE_SIG "$DR-10" 516 #define OBDR_SIG_LEN (sizeof(OBDR_TAPE_SIG) - 1) 517 #define OBDR_TAPE_INQ_SIZE (OBDR_SIG_OFFSET + OBDR_SIG_LEN) 518 519 #define IOACCEL_STATUS_BYTE 4 520 #define OFFLOAD_CONFIGURED_BIT 0x1 521 #define OFFLOAD_ENABLED_BIT 0x2 522 523 #define PQI_RAID_DATA_IN_OUT_GOOD 0x0 524 #define PQI_RAID_DATA_IN_OUT_UNDERFLOW 0x1 525 #define PQI_RAID_DATA_IN_OUT_UNSOLICITED_ABORT 0xf3 526 #define PQI_RAID_DATA_IN_OUT_ABORTED 0xf4 527 528 #define PQI_PHYSICAL_DEVICE_BUS 0 529 #define PQI_RAID_VOLUME_BUS 1 530 #define PQI_HBA_BUS 2 531 #define PQI_EXTERNAL_RAID_VOLUME_BUS 3 532 #define PQI_MAX_BUS PQI_EXTERNAL_RAID_VOLUME_BUS 533 534 #define TEST_UNIT_READY 0x00 535 #define SCSI_VPD_HEADER_LENGTH 64 536 537 #define PQI_MAX_MULTILUN 256 538 #define PQI_MAX_LOGICALS 64 539 #define PQI_MAX_PHYSICALS 1024 540 #define PQI_MAX_DEVICES (PQI_MAX_LOGICALS + PQI_MAX_PHYSICALS + 1) /* 1 for controller device entry */ 541 #define PQI_MAX_EXT_TARGETS 32 542 543 #define PQI_CTLR_INDEX (PQI_MAX_DEVICES - 1) 544 #define PQI_PD_INDEX(t) (t + PQI_MAX_LOGICALS) 545 546 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) 547 #define MAX_TARGET_DEVICES 1024 548 549 #define PQI_NO_MEM 2 550 551 typedef enum pqisrc_device_status { 552 DEVICE_NOT_FOUND, 553 DEVICE_CHANGED, 554 DEVICE_UNCHANGED, 555 } device_status_t; 556 557 #define SA_RAID_0 0 558 #define SA_RAID_4 1 559 #define SA_RAID_1 2 /* also used for RAID 10 */ 560 #define SA_RAID_5 3 /* also used for RAID 50 */ 561 #define SA_RAID_51 4 562 #define SA_RAID_6 5 /* also used for RAID 60 */ 563 #define SA_RAID_ADM 6 /* also used for RAID 1+0 ADM */ 564 #define SA_RAID_MAX SA_RAID_ADM 565 #define SA_RAID_UNKNOWN 0xff 566 567 /* BMIC commands */ 568 #define BMIC_IDENTIFY_CONTROLLER 0x11 569 #define BMIC_IDENTIFY_PHYSICAL_DEVICE 0x15 570 #define BMIC_READ 0x26 571 #define BMIC_WRITE 0x27 572 #define BMIC_SENSE_CONTROLLER_PARAMETERS 0x64 573 #define BMIC_SENSE_SUBSYSTEM_INFORMATION 0x66 574 #define BMIC_CACHE_FLUSH 0xc2 575 #define BMIC_FLASH_FIRMWARE 0xf7 576 #define BMIC_WRITE_HOST_WELLNESS 0xa5 577 578 #define MASKED_DEVICE(lunid) ((lunid)[3] & 0xC0) 579 #define BMIC_GET_LEVEL_2_BUS(lunid) ((lunid)[7] & 0x3F) 580 #define BMIC_GET_LEVEL_TWO_TARGET(lunid) ((lunid)[6]) 581 #define BMIC_GET_DRIVE_NUMBER(lunid) \ 582 (((BMIC_GET_LEVEL_2_BUS((lunid)) - 1) << 8) + \ 583 BMIC_GET_LEVEL_TWO_TARGET((lunid))) 584 #define NON_DISK_PHYS_DEV(rle) \ 585 (((reportlun_ext_entry_t *)(rle))->device_flags & 0x1) 586 587 #define NO_TIMEOUT ((unsigned long) -1) 588 589 #define BMIC_DEVICE_TYPE_SATA 0x1 590 591 /* No of IO slots required for internal requests */ 592 #define PQI_RESERVED_IO_SLOTS_SYNC_REQUESTS 3 593 #define PQI_RESERVED_IO_SLOTS_TMF 1 594 #define PQI_RESERVED_IO_SLOTS_CNT (PQI_NUM_SUPPORTED_EVENTS + \ 595 PQI_RESERVED_IO_SLOTS_TMF + \ 596 PQI_RESERVED_IO_SLOTS_SYNC_REQUESTS) 597 598 static inline uint16_t GET_LE16(const uint8_t *p) 599 { 600 return p[0] | p[1] << 8; 601 } 602 603 static inline uint32_t GET_LE32(const uint8_t *p) 604 { 605 return p[0] | p[1] << 8 | p[2] << 16 | p[3] << 24; 606 } 607 608 static inline uint64_t GET_LE64(const uint8_t *p) 609 { 610 return (((uint64_t)GET_LE32(p + 4) << 32) | 611 GET_LE32(p)); 612 } 613 614 static inline uint16_t GET_BE16(const uint8_t *p) 615 { 616 return p[0] << 8 | p[1]; 617 } 618 619 static inline uint32_t GET_BE32(const uint8_t *p) 620 { 621 return p[0] << 24 | p[1] << 16 | p[2] << 8 | p[3]; 622 } 623 624 static inline uint64_t GET_BE64(const uint8_t *p) 625 { 626 return (((uint64_t)GET_BE32(p) << 32) | 627 GET_BE32(p + 4)); 628 } 629 630 static inline void PUT_BE16(uint16_t val, uint8_t *p) 631 { 632 *p++ = val >> 8; 633 *p++ = val; 634 } 635 636 static inline void PUT_BE32(uint32_t val, uint8_t *p) 637 { 638 PUT_BE16(val >> 16, p); 639 PUT_BE16(val, p + 2); 640 } 641 642 static inline void PUT_BE64(uint64_t val, uint8_t *p) 643 { 644 PUT_BE32(val >> 32, p); 645 PUT_BE32(val, p + 4); 646 } 647 648 #define OS_FREEBSD 649 #define SIS_POLL_WAIT 650 651 #define OS_ATTRIBUTE_PACKED __attribute__((__packed__)) 652 #define OS_ATTRIBUTE_ALIGNED(n) __attribute__((aligned(n))) 653 654 /* Management Interface */ 655 #define CCISS_IOC_MAGIC 'C' 656 #define SMARTPQI_IOCTL_BASE 'M' 657 #define CCISS_GETDRIVVER _IOWR(SMARTPQI_IOCTL_BASE, 0, driver_info) 658 #define CCISS_GETPCIINFO _IOWR(SMARTPQI_IOCTL_BASE, 1, pqi_pci_info_t) 659 #define SMARTPQI_PASS_THRU _IOWR(SMARTPQI_IOCTL_BASE, 2, IOCTL_Command_struct) 660 #define CCISS_PASSTHRU _IOWR('C', 210, IOCTL_Command_struct) 661 #define CCISS_REGNEWD _IO(CCISS_IOC_MAGIC, 14) 662 663 /*IOCTL pci_info structure */ 664 typedef struct pqi_pci_info 665 { 666 unsigned char bus; 667 unsigned char dev_fn; 668 unsigned short domain; 669 uint32_t board_id; 670 uint32_t chip_id; 671 }pqi_pci_info_t; 672 673 typedef struct _driver_info 674 { 675 unsigned char major_version; 676 unsigned char minor_version; 677 unsigned char release_version; 678 unsigned long build_revision; 679 unsigned long max_targets; 680 unsigned long max_io; 681 unsigned long max_transfer_length; 682 }driver_info, *pdriver_info; 683 684 typedef uint8_t *passthru_buf_type_t; 685 686 #define PQISRC_DRIVER_MAJOR 1 687 #define PQISRC_DRIVER_MINOR 0 688 #define PQISRC_DRIVER_RELEASE 3 689 #define PQISRC_DRIVER_REVISION 239 690 691 #define STR(s) # s 692 #define PQISRC_VERSION(a, b, c, d) STR(a.b.c-d) 693 #define PQISRC_DRIVER_VERSION PQISRC_VERSION(PQISRC_DRIVER_MAJOR, \ 694 PQISRC_DRIVER_MINOR, \ 695 PQISRC_DRIVER_RELEASE, \ 696 PQISRC_DRIVER_REVISION) 697 698 /* End Management interface */ 699 700 #ifdef ASSERT 701 #undef ASSERT 702 #endif 703 704 #define ASSERT(cond) {\ 705 if (!(cond)) { \ 706 printf("Assertion failed at file %s line %d\n",__FILE__,__LINE__); \ 707 } \ 708 } 709 710 #define PQI_MAX_MSIX 64 /* vectors */ 711 #define PQI_MSI_CTX_SIZE sizeof(pqi_intr_ctx)+1 712 #define IS_POLLING_REQUIRED(softs) if (cold) {\ 713 pqisrc_process_event_intr_src(softs, 0);\ 714 pqisrc_process_response_queue(softs, 1);\ 715 } 716 717 #define OS_GET_TASK_ATTR(rcb) os_get_task_attr(rcb) 718 #define OS_FW_HEARTBEAT_TIMER_INTERVAL (5) 719 720 typedef struct PCI_ACC_HANDLE { 721 bus_space_tag_t pqi_btag; 722 bus_space_handle_t pqi_bhandle; 723 } PCI_ACC_HANDLE_T; 724 725 /* 726 * Legacy SIS Register definitions for the Adaptec PMC SRC/SRCv/smartraid adapters. 727 */ 728 /* accessible via BAR0 */ 729 #define LEGACY_SIS_IOAR 0x18 /* IOA->host interrupt register */ 730 #define LEGACY_SIS_IDBR 0x20 /* inbound doorbell register */ 731 #define LEGACY_SIS_IISR 0x24 /* inbound interrupt status register */ 732 #define LEGACY_SIS_OIMR 0x34 /* outbound interrupt mask register */ 733 #define LEGACY_SIS_ODBR_R 0x9c /* outbound doorbell register read */ 734 #define LEGACY_SIS_ODBR_C 0xa0 /* outbound doorbell register clear */ 735 736 #define LEGACY_SIS_SCR0 0xb0 /* scratchpad 0 */ 737 #define LEGACY_SIS_OMR 0xbc /* outbound message register */ 738 #define LEGACY_SIS_IQUE64_L 0xc0 /* inbound queue address 64-bit (low) */ 739 #define LEGACY_SIS_IQUE64_H 0xc4 /* inbound queue address 64-bit (high)*/ 740 #define LEGACY_SIS_ODBR_MSI 0xc8 /* MSI register for sync./AIF */ 741 #define LEGACY_SIS_IQN_L 0xd0 /* inbound queue native mode (low) */ 742 #define LEGACY_SIS_IQN_H 0xd4 /* inbound queue native mode (high)*/ 743 #define LEGACY_SIS_MAILBOX 0x7fc60 /* mailbox (20 bytes) */ 744 #define LEGACY_SIS_SRCV_MAILBOX 0x1000 /* mailbox (20 bytes) */ 745 746 #define LEGACY_SIS_ODR_SHIFT 12 /* outbound doorbell shift */ 747 #define LEGACY_SIS_IDR_SHIFT 9 /* inbound doorbell shift */ 748 749 /* 750 * PQI Register definitions for the smartraid adapters 751 */ 752 /* accessible via BAR0 */ 753 #define PQI_SIGNATURE 0x4000 754 #define PQI_ADMINQ_CONFIG 0x4008 755 #define PQI_ADMINQ_CAP 0x4010 756 #define PQI_LEGACY_INTR_STATUS 0x4018 757 #define PQI_LEGACY_INTR_MASK_SET 0x401C 758 #define PQI_LEGACY_INTR_MASK_CLR 0x4020 759 #define PQI_DEV_STATUS 0x4040 760 #define PQI_ADMIN_IBQ_PI_OFFSET 0x4048 761 #define PQI_ADMIN_OBQ_CI_OFFSET 0x4050 762 #define PQI_ADMIN_IBQ_ELEM_ARRAY_ADDR 0x4058 763 #define PQI_ADMIN_OBQ_ELEM_ARRAY_ADDR 0x4060 764 #define PQI_ADMIN_IBQ_CI_ADDR 0x4068 765 #define PQI_ADMIN_OBQ_PI_ADDR 0x4070 766 #define PQI_ADMINQ_PARAM 0x4078 767 #define PQI_DEV_ERR 0x4080 768 #define PQI_DEV_ERR_DETAILS 0x4088 769 #define PQI_DEV_RESET 0x4090 770 #define PQI_POWER_ACTION 0x4094 771 772 /* Busy wait micro seconds */ 773 #define OS_BUSYWAIT(x) DELAY(x) 774 #define OS_SLEEP(timeout) \ 775 DELAY(timeout); 776 777 #define OS_HOST_WELLNESS_TIMEOUT (24 * 3600) 778 779 #define LE_16(x) htole16(x) 780 #define LE_32(x) htole32(x) 781 #define LE_64(x) htole64(x) 782 #define BE_16(x) htobe16(x) 783 #define BE_32(x) htobe32(x) 784 #define BE_64(x) htobe64(x) 785 786 #define PQI_HWIF_SRCV 0 787 #define PQI_HWIF_UNKNOWN -1 788 789 #define SMART_STATE_SUSPEND (1<<0) 790 #define SMART_STATE_UNUSED0 (1<<1) 791 #define SMART_STATE_INTERRUPTS_ON (1<<2) 792 #define SMART_STATE_AIF_SLEEPER (1<<3) 793 #define SMART_STATE_RESET (1<<4) 794 795 #define PQI_FLAG_BUSY (1<<0) 796 #define PQI_MSI_ENABLED (1<<1) 797 #define PQI_SIM_REGISTERED (1<<2) 798 #define PQI_MTX_INIT (1<<3) 799 800 #define PQI_CMD_MAPPED (1<<2) 801 802 /* Interrupt context to get oq_id */ 803 typedef struct pqi_intr_ctx { 804 int oq_id; 805 device_t pqi_dev; 806 }pqi_intr_ctx_t; 807 808 typedef uint8_t os_dev_info_t; 809 810 typedef struct OS_SPECIFIC { 811 device_t pqi_dev; 812 struct resource *pqi_regs_res0; /* reg. if. window */ 813 int pqi_regs_rid0; /* resource ID */ 814 bus_dma_tag_t pqi_parent_dmat; /* parent DMA tag */ 815 bus_dma_tag_t pqi_buffer_dmat; 816 817 /* controller hardware interface */ 818 int pqi_hwif; 819 struct resource *pqi_irq[PQI_MAX_MSIX]; /* interrupt */ 820 int pqi_irq_rid[PQI_MAX_MSIX]; 821 void *intrcookie[PQI_MAX_MSIX]; 822 bool intr_registered[PQI_MAX_MSIX]; 823 bool msi_enabled; /* MSI/MSI-X enabled */ 824 pqi_intr_ctx_t *msi_ctx; 825 int oq_id; 826 int pqi_state; 827 uint32_t pqi_flags; 828 struct mtx cam_lock; 829 struct mtx map_lock; 830 int mtx_init; 831 int sim_registered; 832 struct cam_devq *devq; 833 struct cam_sim *sim; 834 struct cam_path *path; 835 struct task event_task; 836 struct cdev *cdev; 837 struct callout wellness_periodic; /* periodic event handling */ 838 struct callout heartbeat_timeout_id; /* heart beat event handling */ 839 eventhandler_tag eh; 840 } OS_SPECIFIC_T; 841 842 typedef bus_addr_t dma_addr_t; 843 844 /* Atomic */ 845 typedef volatile uint64_t OS_ATOMIC64_T; 846 #define OS_ATOMIC64_SET(_softs, target, val) atomic_set_long(&(_softs)->target, val) 847 #define OS_ATOMIC64_READ(_softs, target) atomic_load_acq_64(&(_softs)->target) 848 #define OS_ATOMIC64_INC(_softs, target) atomic_add_64(&(_softs)->target, 1) 849 850 /* Register access macros */ 851 #define PCI_MEM_GET32( _softs, _absaddr, _offset ) \ 852 bus_space_read_4(_softs->pci_mem_handle.pqi_btag, \ 853 _softs->pci_mem_handle.pqi_bhandle, _offset) 854 855 #define PCI_MEM_GET64( _softs, _absaddr, _offset ) \ 856 bus_space_read_8(_softs->pci_mem_handle.pqi_btag, \ 857 _softs->pci_mem_handle.pqi_bhandle, _offset) 858 859 #define PCI_MEM_PUT32( _softs, _absaddr, _offset, _val ) \ 860 bus_space_write_4(_softs->pci_mem_handle.pqi_btag, \ 861 _softs->pci_mem_handle.pqi_bhandle, _offset, _val) 862 863 #define PCI_MEM_PUT64( _softs, _absaddr, _offset, _val ) \ 864 bus_space_write_8(_softs->pci_mem_handle.pqi_btag, \ 865 _softs->pci_mem_handle.pqi_bhandle, _offset, _val) 866 867 #define PCI_MEM_GET_BUF(_softs, _absaddr, _offset, buf, size) \ 868 bus_space_read_region_1(_softs->pci_mem_handle.pqi_btag,\ 869 _softs->pci_mem_handle.pqi_bhandle, _offset, buf, size) 870 871 /* Lock */ 872 typedef struct mtx OS_LOCK_T; 873 typedef struct sema OS_SEMA_LOCK_T; 874 875 #define OS_PQILOCK_T OS_LOCK_T 876 877 #define OS_ACQUIRE_SPINLOCK(_lock) mtx_lock_spin(_lock) 878 #define OS_RELEASE_SPINLOCK(_lock) mtx_unlock_spin(_lock) 879 880 #define OS_INIT_PQILOCK(_softs,_lock,_lockname) os_init_spinlock(_softs,_lock,_lockname) 881 #define OS_UNINIT_PQILOCK(_lock) os_uninit_spinlock(_lock) 882 883 #define PQI_LOCK(_lock) OS_ACQUIRE_SPINLOCK(_lock) 884 #define PQI_UNLOCK(_lock) OS_RELEASE_SPINLOCK(_lock) 885 886 #define OS_GET_CDBP(rcb) ((rcb->cm_ccb->ccb_h.flags & CAM_CDB_POINTER) ? rcb->cm_ccb->csio.cdb_io.cdb_ptr : rcb->cm_ccb->csio.cdb_io.cdb_bytes) 887 #define GET_SCSI_BUFFLEN(rcb) (rcb->cm_ccb->csio.dxfer_len) 888 889 #define OS_GET_IO_QINDEX(softs,rcb) curcpu % softs->num_op_obq 890 #define OS_GET_IO_RESP_QID(softs,rcb) (softs->op_ob_q[(OS_GET_IO_QINDEX(softs,rcb))].q_id) 891 #define OS_GET_IO_REQ_QINDEX(softs,rcb) OS_GET_IO_QINDEX(softs,rcb) 892 #define OS_GET_TMF_RESP_QID OS_GET_IO_RESP_QID 893 #define OS_GET_TMF_REQ_QINDEX OS_GET_IO_REQ_QINDEX 894 895 /* check request type */ 896 #define is_internal_req(rcb) (!(rcb)->cm_ccb) 897 898 /* sg elements addr, len, flags */ 899 #define OS_GET_IO_SG_COUNT(rcb) rcb->nseg 900 #define OS_GET_IO_SG_ADDR(rcb,i) rcb->sgt[i].addr 901 #define OS_GET_IO_SG_LEN(rcb,i) rcb->sgt[i].len 902 903 /* scsi commands used in pqilib for RAID bypass*/ 904 #define SCMD_READ_6 READ_6 905 #define SCMD_WRITE_6 WRITE_6 906 #define SCMD_READ_10 READ_10 907 #define SCMD_WRITE_10 WRITE_10 908 #define SCMD_READ_12 READ_12 909 #define SCMD_WRITE_12 WRITE_12 910 #define SCMD_READ_16 READ_16 911 #define SCMD_WRITE_16 WRITE_16 912 913 /* Debug facility */ 914 915 #define PQISRC_LOG_LEVEL 0x60 916 917 static int logging_level = PQISRC_LOG_LEVEL; 918 919 #define PQISRC_FLAGS_MASK 0x0000ffff 920 #define PQISRC_FLAGS_INIT 0x00000001 921 #define PQISRC_FLAGS_INFO 0x00000002 922 #define PQISRC_FLAGS_FUNC 0x00000004 923 #define PQISRC_FLAGS_TRACEIO 0x00000008 924 #define PQISRC_FLAGS_DISC 0x00000010 925 #define PQISRC_FLAGS_WARN 0x00000020 926 #define PQISRC_FLAGS_ERROR 0x00000040 927 928 #define DBG_INIT(fmt,args...) \ 929 do { \ 930 if (logging_level & PQISRC_FLAGS_INIT) { \ 931 printf("[INIT]:[ %s ] [ %d ]"fmt,__func__,__LINE__,##args); \ 932 } \ 933 }while(0); 934 935 #define DBG_INFO(fmt,args...) \ 936 do { \ 937 if (logging_level & PQISRC_FLAGS_INFO) { \ 938 printf("[INFO]:[ %s ] [ %d ]"fmt,__func__,__LINE__,##args); \ 939 } \ 940 }while(0); 941 942 #define DBG_FUNC(fmt,args...) \ 943 do { \ 944 if (logging_level & PQISRC_FLAGS_FUNC) { \ 945 printf("[FUNC]:[ %s ] [ %d ]"fmt,__func__,__LINE__,##args); \ 946 } \ 947 }while(0); 948 949 #define DBG_TRACEIO(fmt,args...) \ 950 do { \ 951 if (logging_level & PQISRC_FLAGS_TRACEIO) { \ 952 printf("[TRACEIO]:[ %s ] [ %d ]"fmt,__func__,__LINE__,##args); \ 953 } \ 954 }while(0); 955 956 #define DBG_DISC(fmt,args...) \ 957 do { \ 958 if (logging_level & PQISRC_FLAGS_DISC) { \ 959 printf("[DISC]:[ %s ] [ %d ]"fmt,__func__,__LINE__,##args); \ 960 } \ 961 }while(0); 962 963 #define DBG_WARN(fmt,args...) \ 964 do { \ 965 if (logging_level & PQISRC_FLAGS_WARN) { \ 966 printf("[WARN]:[%u:%u.%u][CPU %d][%s][%d]:"fmt,softs->bus_id,softs->device_id,softs->func_id,curcpu,__func__,__LINE__,##args);\ 967 } \ 968 }while(0); 969 970 #define DBG_ERR(fmt,args...) \ 971 do { \ 972 if (logging_level & PQISRC_FLAGS_ERROR) { \ 973 printf("[ERROR]::[%u:%u.%u][CPU %d][%s][%d]:"fmt,softs->bus_id,softs->device_id,softs->func_id,curcpu,__func__,__LINE__,##args); \ 974 } \ 975 }while(0); 976 #define DBG_IO(fmt,args...) \ 977 do { \ 978 if (logging_level & PQISRC_FLAGS_TRACEIO) { \ 979 printf("[IO]:[ %s ] [ %d ]"fmt,__func__,__LINE__,##args); \ 980 } \ 981 }while(0); 982 983 #define DBG_ERR_BTL(device,fmt,args...) \ 984 do { \ 985 if (logging_level & PQISRC_FLAGS_ERROR) { \ 986 printf("[ERROR]::[%u:%u.%u][%u,%u,%u][CPU %d][%s][%d]:"fmt, softs->bus_id, softs->device_id, softs->func_id, device->bus, device->target, device->lun,curcpu,__func__,__LINE__,##args); \ 987 } \ 988 }while(0); 989 990 #define DBG_WARN_BTL(device,fmt,args...) \ 991 do { \ 992 if (logging_level & PQISRC_FLAGS_WARN) { \ 993 printf("[WARN]:[%u:%u.%u][%u,%u,%u][CPU %d][%s][%d]:"fmt, softs->bus_id, softs->device_id, softs->func_id, device->bus, device->target, device->lun,curcpu,__func__,__LINE__,##args);\ 994 } \ 995 }while(0); 996 997 #endif // _PQI_DEFINES_H 998