/*- * SPDX-License-Identifier: BSD-2-Clause * * Copyright (c) 2006 IronPort Systems * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. */ /*- * Copyright (c) 2007 LSI Corp. * Copyright (c) 2007 Rajesh Prabhakaran. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. */ #ifndef _MFIREG_H #define _MFIREG_H #include /* * MegaRAID SAS MFI firmware definitions * * Calling this driver 'MegaRAID SAS' is a bit misleading. It's a completely * new firmware interface from the old AMI MegaRAID one, and there is no * reason why this interface should be limited to just SAS. In any case, LSI * seems to also call this interface 'MFI', so that will be used here. */ #define MEGAMFI_FRAME_SIZE 64 /* * Start with the register set. All registers are 32 bits wide. * The usual Intel IOP style setup. */ #define MFI_IMSG0 0x10 /* Inbound message 0 */ #define MFI_IMSG1 0x14 /* Inbound message 1 */ #define MFI_OMSG0 0x18 /* Outbound message 0 */ #define MFI_OMSG1 0x1c /* Outbound message 1 */ #define MFI_IDB 0x20 /* Inbound doorbell */ #define MFI_ISTS 0x24 /* Inbound interrupt status */ #define MFI_IMSK 0x28 /* Inbound interrupt mask */ #define MFI_ODB 0x2c /* Outbound doorbell */ #define MFI_OSTS 0x30 /* Outbound interrupt status */ #define MFI_OMSK 0x34 /* Outbound interrupt mask */ #define MFI_IQP 0x40 /* Inbound queue port */ #define MFI_OQP 0x44 /* Outbound queue port */ /* * ThunderBolt specific Register */ #define MFI_RFPI 0x48 /* reply_free_post_host_index */ #define MFI_RPI 0x6c /* reply_post_host_index */ #define MFI_ILQP 0xc0 /* inbound_low_queue_port */ #define MFI_IHQP 0xc4 /* inbound_high_queue_port */ /* * 1078 specific related register */ #define MFI_ODR0 0x9c /* outbound doorbell register0 */ #define MFI_ODCR0 0xa0 /* outbound doorbell clear register0 */ #define MFI_OSP0 0xb0 /* outbound scratch pad0 */ #define MFI_1078_EIM 0x80000004 /* 1078 enable interrupt mask */ #define MFI_RMI 0x2 /* reply message interrupt */ #define MFI_1078_RM 0x80000000 /* reply 1078 message interrupt */ #define MFI_ODC 0x4 /* outbound doorbell change interrupt */ /* OCR registers */ #define MFI_WSR 0x004 /* write sequence register */ #define MFI_HDR 0x008 /* host diagnostic register */ #define MFI_RSR 0x3c3 /* Reset Status Register */ /* * GEN2 specific changes */ #define MFI_GEN2_EIM 0x00000005 /* GEN2 enable interrupt mask */ #define MFI_GEN2_RM 0x00000001 /* reply GEN2 message interrupt */ /* * skinny specific changes */ #define MFI_SKINNY_IDB 0x00 /* Inbound doorbell is at 0x00 for skinny */ #define MFI_IQPL 0x000000c0 #define MFI_IQPH 0x000000c4 #define MFI_SKINNY_RM 0x00000001 /* reply skinny message interrupt */ /* Bits for MFI_OSTS */ #define MFI_OSTS_INTR_VALID 0x00000002 /* OCR specific flags */ #define MFI_FIRMWARE_STATE_CHANGE 0x00000002 #define MFI_STATE_CHANGE_INTERRUPT 0x00000004 /* MFI state change interrrupt */ /* * Firmware state values. Found in OMSG0 during initialization. */ #define MFI_FWSTATE_MASK 0xf0000000 #define MFI_FWSTATE_UNDEFINED 0x00000000 #define MFI_FWSTATE_BB_INIT 0x10000000 #define MFI_FWSTATE_FW_INIT 0x40000000 #define MFI_FWSTATE_WAIT_HANDSHAKE 0x60000000 #define MFI_FWSTATE_FW_INIT_2 0x70000000 #define MFI_FWSTATE_DEVICE_SCAN 0x80000000 #define MFI_FWSTATE_BOOT_MESSAGE_PENDING 0x90000000 #define MFI_FWSTATE_FLUSH_CACHE 0xa0000000 #define MFI_FWSTATE_READY 0xb0000000 #define MFI_FWSTATE_OPERATIONAL 0xc0000000 #define MFI_FWSTATE_FAULT 0xf0000000 #define MFI_FWSTATE_MAXSGL_MASK 0x00ff0000 #define MFI_FWSTATE_MAXCMD_MASK 0x0000ffff #define MFI_FWSTATE_HOSTMEMREQD_MASK 0x08000000 #define MFI_FWSTATE_BOOT_MESSAGE_PENDING 0x90000000 #define MFI_RESET_REQUIRED 0x00000001 /* ThunderBolt Support */ #define MFI_FWSTATE_TB_MASK 0xf0000000 #define MFI_FWSTATE_TB_RESET 0x00000000 #define MFI_FWSTATE_TB_READY 0x10000000 #define MFI_FWSTATE_TB_OPERATIONAL 0x20000000 #define MFI_FWSTATE_TB_FAULT 0x40000000 /* * Control bits to drive the card to ready state. These go into the IDB * register. */ #define MFI_FWINIT_ABORT 0x00000000 /* Abort all pending commands */ #define MFI_FWINIT_READY 0x00000002 /* Move from operational to ready */ #define MFI_FWINIT_MFIMODE 0x00000004 /* unknown */ #define MFI_FWINIT_CLEAR_HANDSHAKE 0x00000008 /* Respond to WAIT_HANDSHAKE */ #define MFI_FWINIT_HOTPLUG 0x00000010 /* ADP reset flags */ #define MFI_STOP_ADP 0x00000020 #define MFI_ADP_RESET 0x00000040 #define DIAG_WRITE_ENABLE 0x00000080 #define DIAG_RESET_ADAPTER 0x00000004 /* MFI Commands */ typedef enum { MFI_CMD_INIT = 0x00, MFI_CMD_LD_READ, MFI_CMD_LD_WRITE, MFI_CMD_LD_SCSI_IO, MFI_CMD_PD_SCSI_IO, MFI_CMD_DCMD, MFI_CMD_ABORT, MFI_CMD_SMP, MFI_CMD_STP } mfi_cmd_t; /* Direct commands */ typedef enum { MFI_DCMD_CTRL_GETINFO = 0x01010000, MFI_DCMD_CTRL_MFI_HOST_MEM_ALLOC =0x0100e100, MFI_DCMD_CTRL_MFC_DEFAULTS_GET =0x010e0201, MFI_DCMD_CTRL_MFC_DEFAULTS_SET =0x010e0202, MFI_DCMD_CTRL_FLUSHCACHE = 0x01101000, MFI_DCMD_CTRL_GET_PROPS = 0x01020100, MFI_DCMD_CTRL_SET_PROPS = 0x01020200, MFI_DCMD_CTRL_SHUTDOWN = 0x01050000, MFI_DCMD_CTRL_EVENT_GETINFO = 0x01040100, MFI_DCMD_CTRL_EVENT_GET = 0x01040300, MFI_DCMD_CTRL_EVENT_WAIT = 0x01040500, MFI_DCMD_PR_GET_STATUS = 0x01070100, MFI_DCMD_PR_GET_PROPERTIES = 0x01070200, MFI_DCMD_PR_SET_PROPERTIES = 0x01070300, MFI_DCMD_PR_START = 0x01070400, MFI_DCMD_PR_STOP = 0x01070500, MFI_DCMD_TIME_SECS_GET = 0x01080201, MFI_DCMD_FLASH_FW_OPEN = 0x010f0100, MFI_DCMD_FLASH_FW_DOWNLOAD = 0x010f0200, MFI_DCMD_FLASH_FW_FLASH = 0x010f0300, MFI_DCMD_FLASH_FW_CLOSE = 0x010f0400, MFI_DCMD_PD_GET_LIST = 0x02010000, MFI_DCMD_PD_LIST_QUERY = 0x02010100, MFI_DCMD_PD_GET_INFO = 0x02020000, MFI_DCMD_PD_STATE_SET = 0x02030100, MFI_DCMD_PD_REBUILD_START = 0x02040100, MFI_DCMD_PD_REBUILD_ABORT = 0x02040200, MFI_DCMD_PD_CLEAR_START = 0x02050100, MFI_DCMD_PD_CLEAR_ABORT = 0x02050200, MFI_DCMD_PD_GET_PROGRESS = 0x02060000, MFI_DCMD_PD_LOCATE_START = 0x02070100, MFI_DCMD_PD_LOCATE_STOP = 0x02070200, MFI_DCMD_LD_MAP_GET_INFO = 0x0300e101, MFI_DCMD_LD_SYNC = 0x0300e102, MFI_DCMD_LD_GET_LIST = 0x03010000, MFI_DCMD_LD_GET_INFO = 0x03020000, MFI_DCMD_LD_GET_PROP = 0x03030000, MFI_DCMD_LD_SET_PROP = 0x03040000, MFI_DCMD_LD_INIT_START = 0x03060100, MFI_DCMD_LD_DELETE = 0x03090000, MFI_DCMD_CFG_READ = 0x04010000, MFI_DCMD_CFG_ADD = 0x04020000, MFI_DCMD_CFG_CLEAR = 0x04030000, MFI_DCMD_CFG_MAKE_SPARE = 0x04040000, MFI_DCMD_CFG_REMOVE_SPARE = 0x04050000, MFI_DCMD_CFG_FOREIGN_SCAN = 0x04060100, MFI_DCMD_CFG_FOREIGN_DISPLAY = 0x04060200, MFI_DCMD_CFG_FOREIGN_PREVIEW = 0x04060300, MFI_DCMD_CFG_FOREIGN_IMPORT = 0x04060400, MFI_DCMD_CFG_FOREIGN_CLEAR = 0x04060500, MFI_DCMD_BBU_GET_STATUS = 0x05010000, MFI_DCMD_BBU_GET_CAPACITY_INFO =0x05020000, MFI_DCMD_BBU_GET_DESIGN_INFO = 0x05030000, MFI_DCMD_BBU_START_LEARN = 0x05040000, MFI_DCMD_BBU_GET_PROP = 0x05050100, MFI_DCMD_BBU_SET_PROP = 0x05050200, MFI_DCMD_CLUSTER = 0x08000000, MFI_DCMD_CLUSTER_RESET_ALL = 0x08010100, MFI_DCMD_CLUSTER_RESET_LD = 0x08010200 } mfi_dcmd_t; /* Modifiers for MFI_DCMD_CTRL_FLUSHCACHE */ #define MFI_FLUSHCACHE_CTRL 0x01 #define MFI_FLUSHCACHE_DISK 0x02 /* Modifiers for MFI_DCMD_CTRL_SHUTDOWN */ #define MFI_SHUTDOWN_SPINDOWN 0x01 /* * MFI Frame flags */ #define MFI_FRAME_POST_IN_REPLY_QUEUE 0x0000 #define MFI_FRAME_DONT_POST_IN_REPLY_QUEUE 0x0001 #define MFI_FRAME_SGL32 0x0000 #define MFI_FRAME_SGL64 0x0002 #define MFI_FRAME_SENSE32 0x0000 #define MFI_FRAME_SENSE64 0x0004 #define MFI_FRAME_DIR_NONE 0x0000 #define MFI_FRAME_DIR_WRITE 0x0008 #define MFI_FRAME_DIR_READ 0x0010 #define MFI_FRAME_DIR_BOTH 0x0018 #define MFI_FRAME_IEEE_SGL 0x0020 #define MFI_FRAME_FMT "\20" \ "\1NOPOST" \ "\2SGL64" \ "\3SENSE64" \ "\4WRITE" \ "\5READ" \ "\6IEEESGL" /* ThunderBolt Specific */ /* * Pre-TB command size and TB command size. * We will be checking it at the load time for the time being */ #define MR_COMMAND_SIZE (MFI_FRAME_SIZE*20) /* 1280 bytes */ #define MEGASAS_THUNDERBOLT_MSG_ALLIGNMENT 256 /* * We are defining only 128 byte message to reduce memory move over head * and also it will reduce the SRB extension size by 128byte compared with * 256 message size */ #define MEGASAS_THUNDERBOLT_NEW_MSG_SIZE 256 #define MEGASAS_THUNDERBOLT_MAX_COMMANDS 1024 #define MEGASAS_THUNDERBOLT_MAX_REPLY_COUNT 1024 #define MEGASAS_THUNDERBOLT_REPLY_SIZE 8 #define MEGASAS_THUNDERBOLT_MAX_CHAIN_COUNT 1 #define MEGASAS_MAX_SZ_CHAIN_FRAME 1024 #define MPI2_FUNCTION_PASSTHRU_IO_REQUEST 0xF0 #define MPI2_FUNCTION_LD_IO_REQUEST 0xF1 #define MR_INTERNAL_MFI_FRAMES_SMID 1 #define MR_CTRL_EVENT_WAIT_SMID 2 #define MR_INTERNAL_DRIVER_RESET_SMID 3 /* MFI Status codes */ typedef enum { MFI_STAT_OK = 0x00, MFI_STAT_INVALID_CMD, MFI_STAT_INVALID_DCMD, MFI_STAT_INVALID_PARAMETER, MFI_STAT_INVALID_SEQUENCE_NUMBER, MFI_STAT_ABORT_NOT_POSSIBLE, MFI_STAT_APP_HOST_CODE_NOT_FOUND, MFI_STAT_APP_IN_USE, MFI_STAT_APP_NOT_INITIALIZED, MFI_STAT_ARRAY_INDEX_INVALID, MFI_STAT_ARRAY_ROW_NOT_EMPTY, MFI_STAT_CONFIG_RESOURCE_CONFLICT, MFI_STAT_DEVICE_NOT_FOUND, MFI_STAT_DRIVE_TOO_SMALL, MFI_STAT_FLASH_ALLOC_FAIL, MFI_STAT_FLASH_BUSY, MFI_STAT_FLASH_ERROR = 0x10, MFI_STAT_FLASH_IMAGE_BAD, MFI_STAT_FLASH_IMAGE_INCOMPLETE, MFI_STAT_FLASH_NOT_OPEN, MFI_STAT_FLASH_NOT_STARTED, MFI_STAT_FLUSH_FAILED, MFI_STAT_HOST_CODE_NOT_FOUNT, MFI_STAT_LD_CC_IN_PROGRESS, MFI_STAT_LD_INIT_IN_PROGRESS, MFI_STAT_LD_LBA_OUT_OF_RANGE, MFI_STAT_LD_MAX_CONFIGURED, MFI_STAT_LD_NOT_OPTIMAL, MFI_STAT_LD_RBLD_IN_PROGRESS, MFI_STAT_LD_RECON_IN_PROGRESS, MFI_STAT_LD_WRONG_RAID_LEVEL, MFI_STAT_MAX_SPARES_EXCEEDED, MFI_STAT_MEMORY_NOT_AVAILABLE = 0x20, MFI_STAT_MFC_HW_ERROR, MFI_STAT_NO_HW_PRESENT, MFI_STAT_NOT_FOUND, MFI_STAT_NOT_IN_ENCL, MFI_STAT_PD_CLEAR_IN_PROGRESS, MFI_STAT_PD_TYPE_WRONG, MFI_STAT_PR_DISABLED, MFI_STAT_ROW_INDEX_INVALID, MFI_STAT_SAS_CONFIG_INVALID_ACTION, MFI_STAT_SAS_CONFIG_INVALID_DATA, MFI_STAT_SAS_CONFIG_INVALID_PAGE, MFI_STAT_SAS_CONFIG_INVALID_TYPE, MFI_STAT_SCSI_DONE_WITH_ERROR, MFI_STAT_SCSI_IO_FAILED, MFI_STAT_SCSI_RESERVATION_CONFLICT, MFI_STAT_SHUTDOWN_FAILED = 0x30, MFI_STAT_TIME_NOT_SET, MFI_STAT_WRONG_STATE, MFI_STAT_LD_OFFLINE, MFI_STAT_PEER_NOTIFICATION_REJECTED, MFI_STAT_PEER_NOTIFICATION_FAILED, MFI_STAT_RESERVATION_IN_PROGRESS, MFI_STAT_I2C_ERRORS_DETECTED, MFI_STAT_PCI_ERRORS_DETECTED, MFI_STAT_DIAG_FAILED, MFI_STAT_BOOT_MSG_PENDING, MFI_STAT_FOREIGN_CONFIG_INCOMPLETE, MFI_STAT_INVALID_STATUS = 0xFF } mfi_status_t; typedef enum { MFI_EVT_CLASS_DEBUG = -2, MFI_EVT_CLASS_PROGRESS = -1, MFI_EVT_CLASS_INFO = 0, MFI_EVT_CLASS_WARNING = 1, MFI_EVT_CLASS_CRITICAL = 2, MFI_EVT_CLASS_FATAL = 3, MFI_EVT_CLASS_DEAD = 4 } mfi_evt_class_t; typedef enum { MFI_EVT_LOCALE_LD = 0x0001, MFI_EVT_LOCALE_PD = 0x0002, MFI_EVT_LOCALE_ENCL = 0x0004, MFI_EVT_LOCALE_BBU = 0x0008, MFI_EVT_LOCALE_SAS = 0x0010, MFI_EVT_LOCALE_CTRL = 0x0020, MFI_EVT_LOCALE_CONFIG = 0x0040, MFI_EVT_LOCALE_CLUSTER = 0x0080, MFI_EVT_LOCALE_ALL = 0xffff } mfi_evt_locale_t; typedef enum { MR_EVT_ARGS_NONE = 0x00, MR_EVT_ARGS_CDB_SENSE, MR_EVT_ARGS_LD, MR_EVT_ARGS_LD_COUNT, MR_EVT_ARGS_LD_LBA, MR_EVT_ARGS_LD_OWNER, MR_EVT_ARGS_LD_LBA_PD_LBA, MR_EVT_ARGS_LD_PROG, MR_EVT_ARGS_LD_STATE, MR_EVT_ARGS_LD_STRIP, MR_EVT_ARGS_PD, MR_EVT_ARGS_PD_ERR, MR_EVT_ARGS_PD_LBA, MR_EVT_ARGS_PD_LBA_LD, MR_EVT_ARGS_PD_PROG, MR_EVT_ARGS_PD_STATE, MR_EVT_ARGS_PCI, MR_EVT_ARGS_RATE, MR_EVT_ARGS_STR, MR_EVT_ARGS_TIME, MR_EVT_ARGS_ECC } mfi_evt_args; #define MR_EVT_CTRL_HOST_BUS_SCAN_REQUESTED 0x0152 #define MR_EVT_PD_REMOVED 0x0070 #define MR_EVT_PD_INSERTED 0x005b #define MR_EVT_LD_CHANGE 0x0051 typedef enum { MR_LD_CACHE_WRITE_BACK = 0x01, MR_LD_CACHE_WRITE_ADAPTIVE = 0x02, MR_LD_CACHE_READ_AHEAD = 0x04, MR_LD_CACHE_READ_ADAPTIVE = 0x08, MR_LD_CACHE_WRITE_CACHE_BAD_BBU=0x10, MR_LD_CACHE_ALLOW_WRITE_CACHE = 0x20, MR_LD_CACHE_ALLOW_READ_CACHE = 0x40 } mfi_ld_cache; #define MR_LD_CACHE_MASK 0x7f #define MR_LD_CACHE_POLICY_READ_AHEAD_NONE 0 #define MR_LD_CACHE_POLICY_READ_AHEAD_ALWAYS MR_LD_CACHE_READ_AHEAD #define MR_LD_CACHE_POLICY_READ_AHEAD_ADAPTIVE \ (MR_LD_CACHE_READ_AHEAD | MR_LD_CACHE_READ_ADAPTIVE) #define MR_LD_CACHE_POLICY_WRITE_THROUGH 0 #define MR_LD_CACHE_POLICY_WRITE_BACK MR_LD_CACHE_WRITE_BACK #define MR_LD_CACHE_POLICY_IO_CACHED \ (MR_LD_CACHE_ALLOW_WRITE_CACHE | MR_LD_CACHE_ALLOW_READ_CACHE) #define MR_LD_CACHE_POLICY_IO_DIRECT 0 typedef enum { MR_PD_CACHE_UNCHANGED = 0, MR_PD_CACHE_ENABLE = 1, MR_PD_CACHE_DISABLE = 2 } mfi_pd_cache; typedef enum { MR_PD_QUERY_TYPE_ALL = 0, MR_PD_QUERY_TYPE_STATE = 1, MR_PD_QUERY_TYPE_POWER_STATE = 2, MR_PD_QUERY_TYPE_MEDIA_TYPE = 3, MR_PD_QUERY_TYPE_SPEED = 4, MR_PD_QUERY_TYPE_EXPOSED_TO_HOST = 5 /*query for system drives */ } mfi_pd_query_type; /* * Other propertities and definitions */ #define MFI_MAX_PD_CHANNELS 2 #define MFI_MAX_LD_CHANNELS 2 #define MFI_MAX_CHANNELS (MFI_MAX_PD_CHANNELS + MFI_MAX_LD_CHANNELS) #define MFI_MAX_CHANNEL_DEVS 128 #define MFI_DEFAULT_ID -1 #define MFI_MAX_LUN 8 #define MFI_MAX_LD 64 #define MFI_MAX_PD 256 #define MFI_FRAME_SIZE 64 #define MFI_MBOX_SIZE 12 /* Firmware flashing can take 50+ seconds */ #define MFI_POLL_TIMEOUT_SECS 60 /* Allow for speedier math calculations */ #define MFI_SECTOR_LEN 512 /* Scatter Gather elements */ struct mfi_sg32 { uint32_t addr; uint32_t len; } __packed; struct mfi_sg64 { uint64_t addr; uint32_t len; } __packed; struct mfi_sg_skinny { uint64_t addr; uint32_t len; uint32_t flag; } __packed; union mfi_sgl { struct mfi_sg32 sg32[1]; struct mfi_sg64 sg64[1]; struct mfi_sg_skinny sg_skinny[1]; } __packed; /* Message frames. All messages have a common header */ struct mfi_frame_header { uint8_t cmd; uint8_t sense_len; uint8_t cmd_status; uint8_t scsi_status; uint8_t target_id; uint8_t lun_id; uint8_t cdb_len; uint8_t sg_count; uint32_t context; /* * pad0 is MSI Specific. Not used by Driver. Zero the value before * sending the command to f/w. */ uint32_t pad0; uint16_t flags; #define MFI_FRAME_DATAOUT 0x08 #define MFI_FRAME_DATAIN 0x10 uint16_t timeout; uint32_t data_len; } __packed; struct mfi_init_frame { struct mfi_frame_header header; uint32_t qinfo_new_addr_lo; uint32_t qinfo_new_addr_hi; uint32_t qinfo_old_addr_lo; uint32_t qinfo_old_addr_hi; // Start LSIP200113393 uint32_t driver_ver_lo; /*28h */ uint32_t driver_ver_hi; /*2Ch */ uint32_t reserved[4]; // End LSIP200113393 } __packed; /* * Define MFI Address Context union. */ #ifdef MFI_ADDRESS_IS_uint64_t typedef uint64_t MFI_ADDRESS; #else typedef union _MFI_ADDRESS { struct { uint32_t addressLow; uint32_t addressHigh; } u; uint64_t address; } MFI_ADDRESS, *PMFI_ADDRESS; #endif #define MFI_IO_FRAME_SIZE 40 struct mfi_io_frame { struct mfi_frame_header header; uint32_t sense_addr_lo; uint32_t sense_addr_hi; uint32_t lba_lo; uint32_t lba_hi; union mfi_sgl sgl; } __packed; #define MFI_PASS_FRAME_SIZE 48 struct mfi_pass_frame { struct mfi_frame_header header; uint32_t sense_addr_lo; uint32_t sense_addr_hi; uint8_t cdb[16]; union mfi_sgl sgl; } __packed; #define MFI_DCMD_FRAME_SIZE 40 struct mfi_dcmd_frame { struct mfi_frame_header header; uint32_t opcode; uint8_t mbox[MFI_MBOX_SIZE]; union mfi_sgl sgl; } __packed; struct mfi_abort_frame { struct mfi_frame_header header; uint32_t abort_context; /* pad is changed to reserved.*/ uint32_t reserved0; uint32_t abort_mfi_addr_lo; uint32_t abort_mfi_addr_hi; uint32_t reserved1[6]; } __packed; struct mfi_smp_frame { struct mfi_frame_header header; uint64_t sas_addr; union { struct mfi_sg32 sg32[2]; struct mfi_sg64 sg64[2]; } sgl; } __packed; struct mfi_stp_frame { struct mfi_frame_header header; uint16_t fis[10]; uint32_t stp_flags; union { struct mfi_sg32 sg32[2]; struct mfi_sg64 sg64[2]; } sgl; } __packed; union mfi_frame { struct mfi_frame_header header; struct mfi_init_frame init; /* ThunderBolt Initialization */ struct mfi_io_frame io; struct mfi_pass_frame pass; struct mfi_dcmd_frame dcmd; struct mfi_abort_frame abort; struct mfi_smp_frame smp; struct mfi_stp_frame stp; uint8_t bytes[MFI_FRAME_SIZE]; }; #define MFI_SENSE_LEN 128 struct mfi_sense { uint8_t data[MFI_SENSE_LEN]; }; /* The queue init structure that is passed with the init message */ struct mfi_init_qinfo { uint32_t flags; uint32_t rq_entries; uint32_t rq_addr_lo; uint32_t rq_addr_hi; uint32_t pi_addr_lo; uint32_t pi_addr_hi; uint32_t ci_addr_lo; uint32_t ci_addr_hi; } __packed; /* SAS (?) controller properties, part of mfi_ctrl_info */ struct mfi_ctrl_props { uint16_t seq_num; uint16_t pred_fail_poll_interval; uint16_t intr_throttle_cnt; uint16_t intr_throttle_timeout; uint8_t rebuild_rate; uint8_t patrol_read_rate; uint8_t bgi_rate; uint8_t cc_rate; uint8_t recon_rate; uint8_t cache_flush_interval; uint8_t spinup_drv_cnt; uint8_t spinup_delay; uint8_t cluster_enable; uint8_t coercion_mode; uint8_t alarm_enable; uint8_t disable_auto_rebuild; uint8_t disable_battery_warn; uint8_t ecc_bucket_size; uint16_t ecc_bucket_leak_rate; uint8_t restore_hotspare_on_insertion; uint8_t expose_encl_devices; uint8_t maintainPdFailHistory; uint8_t disallowHostRequestReordering; /* set TRUE to abort CC on detecting an inconsistency */ uint8_t abortCCOnError; /* load balance mode (MR_LOAD_BALANCE_MODE) */ uint8_t loadBalanceMode; /* * 0 - use auto detect logic of backplanes like SGPIO, i2c SEP using * h/w mechansim like GPIO pins * 1 - disable auto detect SGPIO, * 2 - disable i2c SEP auto detect * 3 - disable both auto detect */ uint8_t disableAutoDetectBackplane; /* * % of source LD to be reserved for a VDs snapshot in snapshot * repository, for metadata and user data: 1=5%, 2=10%, 3=15% and so on */ uint8_t snapVDSpace; /* * Add properties that can be controlled by a bit in the following * structure. */ struct { /* set TRUE to disable copyBack (0=copback enabled) */ uint32_t copyBackDisabled :1; uint32_t SMARTerEnabled :1; uint32_t prCorrectUnconfiguredAreas :1; uint32_t useFdeOnly :1; uint32_t disableNCQ :1; uint32_t SSDSMARTerEnabled :1; uint32_t SSDPatrolReadEnabled :1; uint32_t enableSpinDownUnconfigured :1; uint32_t autoEnhancedImport :1; uint32_t enableSecretKeyControl :1; uint32_t disableOnlineCtrlReset :1; uint32_t allowBootWithPinnedCache :1; uint32_t disableSpinDownHS :1; uint32_t enableJBOD :1; uint32_t reserved :18; } OnOffProperties; /* * % of source LD to be reserved for auto snapshot in snapshot * repository, for metadata and user data: 1=5%, 2=10%, 3=15% and so on. */ uint8_t autoSnapVDSpace; /* * Snapshot writeable VIEWs capacity as a % of source LD capacity: * 0=READ only, 1=5%, 2=10%, 3=15% and so on. */ uint8_t viewSpace; /* # of idle minutes before device is spun down (0=use FW defaults) */ uint16_t spinDownTime; uint8_t reserved[24]; } __packed; /* PCI information about the card. */ struct mfi_info_pci { uint16_t vendor; uint16_t device; uint16_t subvendor; uint16_t subdevice; uint8_t reserved[24]; } __packed; /* Host (front end) interface information */ struct mfi_info_host { uint8_t type; #define MFI_INFO_HOST_PCIX 0x01 #define MFI_INFO_HOST_PCIE 0x02 #define MFI_INFO_HOST_ISCSI 0x04 #define MFI_INFO_HOST_SAS3G 0x08 uint8_t reserved[6]; uint8_t port_count; uint64_t port_addr[8]; } __packed; /* Device (back end) interface information */ struct mfi_info_device { uint8_t type; #define MFI_INFO_DEV_SPI 0x01 #define MFI_INFO_DEV_SAS3G 0x02 #define MFI_INFO_DEV_SATA1 0x04 #define MFI_INFO_DEV_SATA3G 0x08 uint8_t reserved[6]; uint8_t port_count; uint64_t port_addr[8]; } __packed; /* Firmware component information */ struct mfi_info_component { char name[8]; char version[32]; char build_date[16]; char build_time[16]; } __packed; /* Controller default settings */ struct mfi_defaults { uint64_t sas_addr; uint8_t phy_polarity; uint8_t background_rate; uint8_t stripe_size; uint8_t flush_time; uint8_t write_back; uint8_t read_ahead; uint8_t cache_when_bbu_bad; uint8_t cached_io; uint8_t smart_mode; uint8_t alarm_disable; uint8_t coercion; uint8_t zrc_config; uint8_t dirty_led_shows_drive_activity; uint8_t bios_continue_on_error; uint8_t spindown_mode; uint8_t allowed_device_types; uint8_t allow_mix_in_enclosure; uint8_t allow_mix_in_ld; uint8_t allow_sata_in_cluster; uint8_t max_chained_enclosures; uint8_t disable_ctrl_r; uint8_t enabel_web_bios; uint8_t phy_polarity_split; uint8_t direct_pd_mapping; uint8_t bios_enumerate_lds; uint8_t restored_hot_spare_on_insertion; uint8_t expose_enclosure_devices; uint8_t maintain_pd_fail_history; uint8_t resv[28]; } __packed; /* Controller default settings */ struct mfi_bios_data { uint16_t boot_target_id; uint8_t do_not_int_13; uint8_t continue_on_error; uint8_t verbose; uint8_t geometry; uint8_t expose_all_drives; uint8_t reserved[56]; uint8_t check_sum; } __packed; /* SAS (?) controller info, returned from MFI_DCMD_CTRL_GETINFO. */ struct mfi_ctrl_info { struct mfi_info_pci pci; struct mfi_info_host host; struct mfi_info_device device; /* Firmware components that are present and active. */ uint32_t image_check_word; uint32_t image_component_count; struct mfi_info_component image_component[8]; /* Firmware components that have been flashed but are inactive */ uint32_t pending_image_component_count; struct mfi_info_component pending_image_component[8]; uint8_t max_arms; uint8_t max_spans; uint8_t max_arrays; uint8_t max_lds; char product_name[80]; char serial_number[32]; uint32_t hw_present; #define MFI_INFO_HW_BBU 0x01 #define MFI_INFO_HW_ALARM 0x02 #define MFI_INFO_HW_NVRAM 0x04 #define MFI_INFO_HW_UART 0x08 uint32_t current_fw_time; uint16_t max_cmds; uint16_t max_sg_elements; uint32_t max_request_size; uint16_t lds_present; uint16_t lds_degraded; uint16_t lds_offline; uint16_t pd_present; uint16_t pd_disks_present; uint16_t pd_disks_pred_failure; uint16_t pd_disks_failed; uint16_t nvram_size; uint16_t memory_size; uint16_t flash_size; uint16_t ram_correctable_errors; uint16_t ram_uncorrectable_errors; uint8_t cluster_allowed; uint8_t cluster_active; uint16_t max_strips_per_io; uint32_t raid_levels; #define MFI_INFO_RAID_0 0x01 #define MFI_INFO_RAID_1 0x02 #define MFI_INFO_RAID_5 0x04 #define MFI_INFO_RAID_1E 0x08 #define MFI_INFO_RAID_6 0x10 uint32_t adapter_ops; #define MFI_INFO_AOPS_RBLD_RATE 0x0001 #define MFI_INFO_AOPS_CC_RATE 0x0002 #define MFI_INFO_AOPS_BGI_RATE 0x0004 #define MFI_INFO_AOPS_RECON_RATE 0x0008 #define MFI_INFO_AOPS_PATROL_RATE 0x0010 #define MFI_INFO_AOPS_ALARM_CONTROL 0x0020 #define MFI_INFO_AOPS_CLUSTER_SUPPORTED 0x0040 #define MFI_INFO_AOPS_BBU 0x0080 #define MFI_INFO_AOPS_SPANNING_ALLOWED 0x0100 #define MFI_INFO_AOPS_DEDICATED_SPARES 0x0200 #define MFI_INFO_AOPS_REVERTIBLE_SPARES 0x0400 #define MFI_INFO_AOPS_FOREIGN_IMPORT 0x0800 #define MFI_INFO_AOPS_SELF_DIAGNOSTIC 0x1000 #define MFI_INFO_AOPS_MIXED_ARRAY 0x2000 #define MFI_INFO_AOPS_GLOBAL_SPARES 0x4000 uint32_t ld_ops; #define MFI_INFO_LDOPS_READ_POLICY 0x01 #define MFI_INFO_LDOPS_WRITE_POLICY 0x02 #define MFI_INFO_LDOPS_IO_POLICY 0x04 #define MFI_INFO_LDOPS_ACCESS_POLICY 0x08 #define MFI_INFO_LDOPS_DISK_CACHE_POLICY 0x10 struct { uint8_t min; uint8_t max; uint8_t reserved[2]; } __packed stripe_sz_ops; uint32_t pd_ops; #define MFI_INFO_PDOPS_FORCE_ONLINE 0x01 #define MFI_INFO_PDOPS_FORCE_OFFLINE 0x02 #define MFI_INFO_PDOPS_FORCE_REBUILD 0x04 uint32_t pd_mix_support; #define MFI_INFO_PDMIX_SAS 0x01 #define MFI_INFO_PDMIX_SATA 0x02 #define MFI_INFO_PDMIX_ENCL 0x04 #define MFI_INFO_PDMIX_LD 0x08 #define MFI_INFO_PDMIX_SATA_CLUSTER 0x10 uint8_t ecc_bucket_count; uint8_t reserved2[11]; struct mfi_ctrl_props properties; char package_version[0x60]; uint8_t pad[0x800 - 0x6a0]; } __packed; /* keep track of an event. */ union mfi_evt { struct { uint16_t locale; uint8_t reserved; int8_t evt_class; } members; uint32_t word; } __packed; /* event log state. */ struct mfi_evt_log_state { uint32_t newest_seq_num; uint32_t oldest_seq_num; uint32_t clear_seq_num; uint32_t shutdown_seq_num; uint32_t boot_seq_num; } __packed; struct mfi_progress { uint16_t progress; uint16_t elapsed_seconds; } __packed; struct mfi_evt_ld { uint16_t target_id; uint8_t ld_index; uint8_t reserved; } __packed; struct mfi_evt_pd { uint16_t device_id; uint8_t enclosure_index; uint8_t slot_number; } __packed; /* SAS (?) event detail, returned from MFI_DCMD_CTRL_EVENT_WAIT. */ struct mfi_evt_detail { uint32_t seq; uint32_t time; uint32_t code; union mfi_evt evt_class; uint8_t arg_type; uint8_t reserved1[15]; union { struct { struct mfi_evt_pd pd; uint8_t cdb_len; uint8_t sense_len; uint8_t reserved[2]; uint8_t cdb[16]; uint8_t sense[64]; } cdb_sense; struct mfi_evt_ld ld; struct { struct mfi_evt_ld ld; uint64_t count; } ld_count; struct { uint64_t lba; struct mfi_evt_ld ld; } ld_lba; struct { struct mfi_evt_ld ld; uint32_t pre_owner; uint32_t new_owner; } ld_owner; struct { uint64_t ld_lba; uint64_t pd_lba; struct mfi_evt_ld ld; struct mfi_evt_pd pd; } ld_lba_pd_lba; struct { struct mfi_evt_ld ld; struct mfi_progress prog; } ld_prog; struct { struct mfi_evt_ld ld; uint32_t prev_state; uint32_t new_state; } ld_state; struct { uint64_t strip; struct mfi_evt_ld ld; } ld_strip; struct mfi_evt_pd pd; struct { struct mfi_evt_pd pd; uint32_t err; } pd_err; struct { uint64_t lba; struct mfi_evt_pd pd; } pd_lba; struct { uint64_t lba; struct mfi_evt_pd pd; struct mfi_evt_ld ld; } pd_lba_ld; struct { struct mfi_evt_pd pd; struct mfi_progress prog; } pd_prog; struct { struct mfi_evt_pd ld; uint32_t prev_state; uint32_t new_state; } pd_state; struct { uint16_t venderId; uint16_t deviceId; uint16_t subVenderId; uint16_t subDeviceId; } pci; uint32_t rate; char str[96]; struct { uint32_t rtc; uint16_t elapsedSeconds; } time; struct { uint32_t ecar; uint32_t elog; char str[64]; } ecc; uint8_t b[96]; uint16_t s[48]; uint32_t w[24]; uint64_t d[12]; } args; char description[128]; } __packed; struct mfi_evt_list { uint32_t count; uint32_t reserved; struct mfi_evt_detail event[1]; } __packed; union mfi_pd_ref { struct { uint16_t device_id; uint16_t seq_num; } v; uint32_t ref; } __packed; union mfi_pd_ddf_type { struct { union { struct { uint16_t forced_pd_guid : 1; uint16_t in_vd : 1; uint16_t is_global_spare : 1; uint16_t is_spare : 1; uint16_t is_foreign : 1; uint16_t reserved : 7; uint16_t intf : 4; } pd_type; uint16_t type; } v; uint16_t reserved; } ddf; struct { uint32_t reserved; } non_disk; uint32_t type; } __packed; struct mfi_pd_progress { uint32_t active; #define MFI_PD_PROGRESS_REBUILD (1<<0) #define MFI_PD_PROGRESS_PATROL (1<<1) #define MFI_PD_PROGRESS_CLEAR (1<<2) struct mfi_progress rbld; struct mfi_progress patrol; struct mfi_progress clear; struct mfi_progress reserved[4]; } __packed; struct mfi_pd_info { union mfi_pd_ref ref; uint8_t inquiry_data[96]; uint8_t vpd_page83[64]; uint8_t not_supported; uint8_t scsi_dev_type; uint8_t connected_port_bitmap; uint8_t device_speed; uint32_t media_err_count; uint32_t other_err_count; uint32_t pred_fail_count; uint32_t last_pred_fail_event_seq_num; uint16_t fw_state; /* MFI_PD_STATE_* */ uint8_t disabled_for_removal; uint8_t link_speed; union mfi_pd_ddf_type state; struct { uint8_t count; uint8_t is_path_broken; uint8_t reserved[6]; uint64_t sas_addr[4]; } path_info; uint64_t raw_size; uint64_t non_coerced_size; uint64_t coerced_size; uint16_t encl_device_id; uint8_t encl_index; uint8_t slot_number; struct mfi_pd_progress prog_info; uint8_t bad_block_table_full; uint8_t unusable_in_current_config; uint8_t vpd_page83_ext[64]; uint8_t reserved[512-358]; } __packed; struct mfi_pd_address { uint16_t device_id; uint16_t encl_device_id; uint8_t encl_index; uint8_t slot_number; uint8_t scsi_dev_type; /* 0 = disk */ uint8_t connect_port_bitmap; uint64_t sas_addr[2]; } __packed; #define MAX_SYS_PDS 240 struct mfi_pd_list { uint32_t size; uint32_t count; struct mfi_pd_address addr[MAX_SYS_PDS]; } __packed; enum mfi_pd_state { MFI_PD_STATE_UNCONFIGURED_GOOD = 0x00, MFI_PD_STATE_UNCONFIGURED_BAD = 0x01, MFI_PD_STATE_HOT_SPARE = 0x02, MFI_PD_STATE_OFFLINE = 0x10, MFI_PD_STATE_FAILED = 0x11, MFI_PD_STATE_REBUILD = 0x14, MFI_PD_STATE_ONLINE = 0x18, MFI_PD_STATE_COPYBACK = 0x20, MFI_PD_STATE_SYSTEM = 0x40 }; /* * "SYSTEM" disk appears to be "JBOD" support from the RAID controller. * Adding a #define to denote this. */ #define MFI_PD_STATE_JBOD MFI_PD_STATE_SYSTEM union mfi_ld_ref { struct { uint8_t target_id; uint8_t reserved; uint16_t seq; } v; uint32_t ref; } __packed; struct mfi_ld_list { uint32_t ld_count; uint32_t reserved1; struct { union mfi_ld_ref ld; uint8_t state; uint8_t reserved2[3]; uint64_t size; } ld_list[MFI_MAX_LD]; } __packed; enum mfi_ld_access { MFI_LD_ACCESS_RW = 0, MFI_LD_ACCSSS_RO = 2, MFI_LD_ACCESS_BLOCKED = 3, }; #define MFI_LD_ACCESS_MASK 3 enum mfi_ld_state { MFI_LD_STATE_OFFLINE = 0, MFI_LD_STATE_PARTIALLY_DEGRADED = 1, MFI_LD_STATE_DEGRADED = 2, MFI_LD_STATE_OPTIMAL = 3 }; struct mfi_ld_props { union mfi_ld_ref ld; char name[16]; uint8_t default_cache_policy; uint8_t access_policy; uint8_t disk_cache_policy; uint8_t current_cache_policy; uint8_t no_bgi; uint8_t reserved[7]; } __packed; struct mfi_ld_params { uint8_t primary_raid_level; uint8_t raid_level_qualifier; uint8_t secondary_raid_level; uint8_t stripe_size; uint8_t num_drives; uint8_t span_depth; uint8_t state; uint8_t init_state; #define MFI_LD_PARAMS_INIT_NO 0 #define MFI_LD_PARAMS_INIT_QUICK 1 #define MFI_LD_PARAMS_INIT_FULL 2 uint8_t is_consistent; uint8_t reserved1[6]; uint8_t isSSCD; uint8_t reserved2[16]; } __packed; struct mfi_ld_progress { uint32_t active; #define MFI_LD_PROGRESS_CC (1<<0) #define MFI_LD_PROGRESS_BGI (1<<1) #define MFI_LD_PROGRESS_FGI (1<<2) #define MFI_LD_PROGRESS_RECON (1<<3) struct mfi_progress cc; struct mfi_progress bgi; struct mfi_progress fgi; struct mfi_progress recon; struct mfi_progress reserved[4]; } __packed; struct mfi_span { uint64_t start_block; uint64_t num_blocks; uint16_t array_ref; uint8_t reserved[6]; } __packed; #define MFI_MAX_SPAN_DEPTH 8 struct mfi_ld_config { struct mfi_ld_props properties; struct mfi_ld_params params; struct mfi_span span[MFI_MAX_SPAN_DEPTH]; } __packed; struct mfi_ld_info { struct mfi_ld_config ld_config; uint64_t size; struct mfi_ld_progress progress; uint16_t cluster_owner; uint8_t reconstruct_active; uint8_t reserved1[1]; uint8_t vpd_page83[64]; uint8_t reserved2[16]; } __packed; #define MFI_MAX_ARRAYS 16 struct mfi_spare { union mfi_pd_ref ref; uint8_t spare_type; #define MFI_SPARE_DEDICATED (1 << 0) #define MFI_SPARE_REVERTIBLE (1 << 1) #define MFI_SPARE_ENCL_AFFINITY (1 << 2) uint8_t reserved[2]; uint8_t array_count; uint16_t array_ref[MFI_MAX_ARRAYS]; } __packed; #define MFI_MAX_ROW_SIZE 32 struct mfi_array { uint64_t size; uint8_t num_drives; uint8_t reserved; uint16_t array_ref; uint8_t pad[20]; struct { union mfi_pd_ref ref; /* 0xffff == missing drive */ uint16_t fw_state; /* MFI_PD_STATE_* */ struct { uint8_t pd; uint8_t slot; } encl; } pd[MFI_MAX_ROW_SIZE]; } __packed; struct mfi_config_data { uint32_t size; uint16_t array_count; uint16_t array_size; uint16_t log_drv_count; uint16_t log_drv_size; uint16_t spares_count; uint16_t spares_size; uint8_t reserved[16]; struct mfi_array array[0]; struct mfi_ld_config ld[0]; struct mfi_spare spare[0]; } __packed; struct mfi_bbu_capacity_info { uint16_t relative_charge; uint16_t absolute_charge; uint16_t remaining_capacity; uint16_t full_charge_capacity; uint16_t run_time_to_empty; uint16_t average_time_to_empty; uint16_t average_time_to_full; uint16_t cycle_count; uint16_t max_error; uint16_t remaining_capacity_alarm; uint16_t remaining_time_alarm; uint8_t reserved[26]; } __packed; struct mfi_bbu_design_info { uint32_t mfg_date; uint16_t design_capacity; uint16_t design_voltage; uint16_t spec_info; uint16_t serial_number; uint16_t pack_stat_config; uint8_t mfg_name[12]; uint8_t device_name[8]; uint8_t device_chemistry[8]; uint8_t mfg_data[8]; uint8_t reserved[17]; } __packed; struct mfi_ibbu_state { uint16_t gas_guage_status; uint16_t relative_charge; uint16_t charger_system_state; uint16_t charger_system_ctrl; uint16_t charging_current; uint16_t absolute_charge; uint16_t max_error; uint8_t reserved[18]; } __packed; struct mfi_bbu_state { uint16_t gas_guage_status; uint16_t relative_charge; uint16_t charger_status; uint16_t remaining_capacity; uint16_t full_charge_capacity; uint8_t is_SOH_good; uint8_t reserved[21]; } __packed; struct mfi_bbu_properties { uint32_t auto_learn_period; uint32_t next_learn_time; uint8_t learn_delay_interval; uint8_t auto_learn_mode; uint8_t bbu_mode; uint8_t reserved[21]; } __packed; union mfi_bbu_status_detail { struct mfi_ibbu_state ibbu; struct mfi_bbu_state bbu; }; struct mfi_bbu_status { uint8_t battery_type; #define MFI_BBU_TYPE_NONE 0 #define MFI_BBU_TYPE_IBBU 1 #define MFI_BBU_TYPE_BBU 2 uint8_t reserved; uint16_t voltage; int16_t current; uint16_t temperature; uint32_t fw_status; #define MFI_BBU_STATE_PACK_MISSING (1 << 0) #define MFI_BBU_STATE_VOLTAGE_LOW (1 << 1) #define MFI_BBU_STATE_TEMPERATURE_HIGH (1 << 2) #define MFI_BBU_STATE_CHARGE_ACTIVE (1 << 3) #define MFI_BBU_STATE_DISCHARGE_ACTIVE (1 << 4) #define MFI_BBU_STATE_LEARN_CYC_REQ (1 << 5) #define MFI_BBU_STATE_LEARN_CYC_ACTIVE (1 << 6) #define MFI_BBU_STATE_LEARN_CYC_FAIL (1 << 7) #define MFI_BBU_STATE_LEARN_CYC_TIMEOUT (1 << 8) #define MFI_BBU_STATE_I2C_ERR_DETECT (1 << 9) uint8_t pad[20]; union mfi_bbu_status_detail detail; } __packed; enum mfi_pr_state { MFI_PR_STATE_STOPPED = 0, MFI_PR_STATE_READY = 1, MFI_PR_STATE_ACTIVE = 2, MFI_PR_STATE_ABORTED = 0xff }; struct mfi_pr_status { uint32_t num_iteration; uint8_t state; uint8_t num_pd_done; uint8_t reserved[10]; }; enum mfi_pr_opmode { MFI_PR_OPMODE_AUTO = 0, MFI_PR_OPMODE_MANUAL = 1, MFI_PR_OPMODE_DISABLED = 2 }; struct mfi_pr_properties { uint8_t op_mode; uint8_t max_pd; uint8_t reserved; uint8_t exclude_ld_count; uint16_t excluded_ld[MFI_MAX_LD]; uint8_t cur_pd_map[MFI_MAX_PD / 8]; uint8_t last_pd_map[MFI_MAX_PD / 8]; uint32_t next_exec; uint32_t exec_freq; uint32_t clear_freq; }; /* ThunderBolt support */ /* * Raid Context structure which describes MegaRAID specific IO Paramenters * This resides at offset 0x60 where the SGL normally starts in MPT IO Frames */ typedef struct _MPI2_SCSI_IO_VENDOR_UNIQUE { uint16_t resvd0; /* 0x00 - 0x01 */ uint16_t timeoutValue; /* 0x02 - 0x03 */ uint8_t regLockFlags; uint8_t armId; uint16_t TargetID; /* 0x06 - 0x07 */ uint64_t RegLockLBA; /* 0x08 - 0x0F */ uint32_t RegLockLength; /* 0x10 - 0x13 */ uint16_t SMID; /* 0x14 - 0x15 nextLMId */ uint8_t exStatus; /* 0x16 */ uint8_t Status; /* 0x17 status */ uint8_t RAIDFlags; /* 0x18 */ uint8_t numSGE; /* 0x19 numSge */ uint16_t configSeqNum; /* 0x1A - 0x1B */ uint8_t spanArm; /* 0x1C */ uint8_t resvd2[3]; /* 0x1D - 0x1F */ } MPI2_SCSI_IO_VENDOR_UNIQUE, MPI25_SCSI_IO_VENDOR_UNIQUE; /***************************************************************************** * * Message Functions * *****************************************************************************/ #define NA_MPI2_FUNCTION_SCSI_IO_REQUEST (0x00) /* SCSI IO */ #define MPI2_FUNCTION_SCSI_TASK_MGMT (0x01) /* SCSI Task Management */ #define MPI2_FUNCTION_IOC_INIT (0x02) /* IOC Init */ #define MPI2_FUNCTION_IOC_FACTS (0x03) /* IOC Facts */ #define MPI2_FUNCTION_CONFIG (0x04) /* Configuration */ #define MPI2_FUNCTION_PORT_FACTS (0x05) /* Port Facts */ #define MPI2_FUNCTION_PORT_ENABLE (0x06) /* Port Enable */ #define MPI2_FUNCTION_EVENT_NOTIFICATION (0x07) /* Event Notification */ #define MPI2_FUNCTION_EVENT_ACK (0x08) /* Event Acknowledge */ #define MPI2_FUNCTION_FW_DOWNLOAD (0x09) /* FW Download */ #define MPI2_FUNCTION_TARGET_ASSIST (0x0B) /* Target Assist */ #define MPI2_FUNCTION_TARGET_STATUS_SEND (0x0C) /* Target Status Send */ #define MPI2_FUNCTION_TARGET_MODE_ABORT (0x0D) /* Target Mode Abort */ #define MPI2_FUNCTION_FW_UPLOAD (0x12) /* FW Upload */ #define MPI2_FUNCTION_RAID_ACTION (0x15) /* RAID Action */ #define MPI2_FUNCTION_RAID_SCSI_IO_PASSTHROUGH (0x16) /* SCSI IO RAID Passthrough */ #define MPI2_FUNCTION_TOOLBOX (0x17) /* Toolbox */ #define MPI2_FUNCTION_SCSI_ENCLOSURE_PROCESSOR (0x18) /* SCSI Enclosure Processor */ #define MPI2_FUNCTION_SMP_PASSTHROUGH (0x1A) /* SMP Passthrough */ #define MPI2_FUNCTION_SAS_IO_UNIT_CONTROL (0x1B) /* SAS IO Unit Control */ #define MPI2_FUNCTION_SATA_PASSTHROUGH (0x1C) /* SATA Passthrough */ #define MPI2_FUNCTION_DIAG_BUFFER_POST (0x1D) /* Diagnostic Buffer Post */ #define MPI2_FUNCTION_DIAG_RELEASE (0x1E) /* Diagnostic Release */ #define MPI2_FUNCTION_TARGET_CMD_BUF_BASE_POST (0x24) /* Target Command Buffer Post Base */ #define MPI2_FUNCTION_TARGET_CMD_BUF_LIST_POST (0x25) /* Target Command Buffer Post List */ #define MPI2_FUNCTION_RAID_ACCELERATOR (0x2C) /* RAID Accelerator */ #define MPI2_FUNCTION_HOST_BASED_DISCOVERY_ACTION (0x2F) /* Host Based Discovery Action */ #define MPI2_FUNCTION_PWR_MGMT_CONTROL (0x30) /* Power Management Control */ #define MPI2_FUNCTION_MIN_PRODUCT_SPECIFIC (0xF0) /* beginning of product-specific range */ #define MPI2_FUNCTION_MAX_PRODUCT_SPECIFIC (0xFF) /* end of product-specific range */ /* Doorbell functions */ #define MPI2_FUNCTION_IOC_MESSAGE_UNIT_RESET (0x40) #define MPI2_FUNCTION_HANDSHAKE (0x42) /***************************************************************************** * * MPI Version Definitions * *****************************************************************************/ #define MPI2_VERSION_MAJOR (0x02) #define MPI2_VERSION_MINOR (0x00) #define MPI2_VERSION_MAJOR_MASK (0xFF00) #define MPI2_VERSION_MAJOR_SHIFT (8) #define MPI2_VERSION_MINOR_MASK (0x00FF) #define MPI2_VERSION_MINOR_SHIFT (0) #define MPI2_VERSION ((MPI2_VERSION_MAJOR << MPI2_VERSION_MAJOR_SHIFT) | \ MPI2_VERSION_MINOR) #define MPI2_VERSION_02_00 (0x0200) /* versioning for this MPI header set */ #define MPI2_HEADER_VERSION_UNIT (0x10) #define MPI2_HEADER_VERSION_DEV (0x00) #define MPI2_HEADER_VERSION_UNIT_MASK (0xFF00) #define MPI2_HEADER_VERSION_UNIT_SHIFT (8) #define MPI2_HEADER_VERSION_DEV_MASK (0x00FF) #define MPI2_HEADER_VERSION_DEV_SHIFT (0) #define MPI2_HEADER_VERSION ((MPI2_HEADER_VERSION_UNIT << 8) | \ MPI2_HEADER_VERSION_DEV) /* IOCInit Request message */ struct MPI2_IOC_INIT_REQUEST { uint8_t WhoInit; /* 0x00 */ uint8_t Reserved1; /* 0x01 */ uint8_t ChainOffset; /* 0x02 */ uint8_t Function; /* 0x03 */ uint16_t Reserved2; /* 0x04 */ uint8_t Reserved3; /* 0x06 */ uint8_t MsgFlags; /* 0x07 */ uint8_t VP_ID; /* 0x08 */ uint8_t VF_ID; /* 0x09 */ uint16_t Reserved4; /* 0x0A */ uint16_t MsgVersion; /* 0x0C */ uint16_t HeaderVersion; /* 0x0E */ uint32_t Reserved5; /* 0x10 */ uint16_t Reserved6; /* 0x14 */ uint8_t Reserved7; /* 0x16 */ uint8_t HostMSIxVectors; /* 0x17 */ uint16_t Reserved8; /* 0x18 */ uint16_t SystemRequestFrameSize; /* 0x1A */ uint16_t ReplyDescriptorPostQueueDepth; /* 0x1C */ uint16_t ReplyFreeQueueDepth; /* 0x1E */ uint32_t SenseBufferAddressHigh; /* 0x20 */ uint32_t SystemReplyAddressHigh; /* 0x24 */ uint64_t SystemRequestFrameBaseAddress; /* 0x28 */ uint64_t ReplyDescriptorPostQueueAddress;/* 0x30 */ uint64_t ReplyFreeQueueAddress; /* 0x38 */ uint64_t TimeStamp; /* 0x40 */ }; /* WhoInit values */ #define MPI2_WHOINIT_NOT_INITIALIZED (0x00) #define MPI2_WHOINIT_SYSTEM_BIOS (0x01) #define MPI2_WHOINIT_ROM_BIOS (0x02) #define MPI2_WHOINIT_PCI_PEER (0x03) #define MPI2_WHOINIT_HOST_DRIVER (0x04) #define MPI2_WHOINIT_MANUFACTURER (0x05) struct MPI2_SGE_CHAIN_UNION { uint16_t Length; uint8_t NextChainOffset; uint8_t Flags; union { uint32_t Address32; uint64_t Address64; } u; }; struct MPI2_IEEE_SGE_SIMPLE32 { uint32_t Address; uint32_t FlagsLength; }; struct MPI2_IEEE_SGE_SIMPLE64 { uint64_t Address; uint32_t Length; uint16_t Reserved1; uint8_t Reserved2; uint8_t Flags; }; typedef union _MPI2_IEEE_SGE_SIMPLE_UNION { struct MPI2_IEEE_SGE_SIMPLE32 Simple32; struct MPI2_IEEE_SGE_SIMPLE64 Simple64; } MPI2_IEEE_SGE_SIMPLE_UNION; typedef struct _MPI2_SGE_SIMPLE_UNION { uint32_t FlagsLength; union { uint32_t Address32; uint64_t Address64; } u; } MPI2_SGE_SIMPLE_UNION; /**************************************************************************** * IEEE SGE field definitions and masks ****************************************************************************/ /* Flags field bit definitions */ #define MPI2_IEEE_SGE_FLAGS_ELEMENT_TYPE_MASK (0x80) #define MPI2_IEEE32_SGE_FLAGS_SHIFT (24) #define MPI2_IEEE32_SGE_LENGTH_MASK (0x00FFFFFF) /* Element Type */ #define MPI2_IEEE_SGE_FLAGS_SIMPLE_ELEMENT (0x00) #define MPI2_IEEE_SGE_FLAGS_CHAIN_ELEMENT (0x80) /* Data Location Address Space */ #define MPI2_IEEE_SGE_FLAGS_ADDR_MASK (0x03) #define MPI2_IEEE_SGE_FLAGS_SYSTEM_ADDR (0x00) #define MPI2_IEEE_SGE_FLAGS_IOCDDR_ADDR (0x01) #define MPI2_IEEE_SGE_FLAGS_IOCPLB_ADDR (0x02) #define MPI2_IEEE_SGE_FLAGS_IOCPLBNTA_ADDR (0x03) /* Address Size */ #define MPI2_SGE_FLAGS_32_BIT_ADDRESSING (0x00) #define MPI2_SGE_FLAGS_64_BIT_ADDRESSING (0x02) /*******************/ /* SCSI IO Control bits */ #define MPI2_SCSIIO_CONTROL_ADDCDBLEN_MASK (0xFC000000) #define MPI2_SCSIIO_CONTROL_ADDCDBLEN_SHIFT (26) #define MPI2_SCSIIO_CONTROL_DATADIRECTION_MASK (0x03000000) #define MPI2_SCSIIO_CONTROL_NODATATRANSFER (0x00000000) #define MPI2_SCSIIO_CONTROL_WRITE (0x01000000) #define MPI2_SCSIIO_CONTROL_READ (0x02000000) #define MPI2_SCSIIO_CONTROL_BIDIRECTIONAL (0x03000000) #define MPI2_SCSIIO_CONTROL_TASKPRI_MASK (0x00007800) #define MPI2_SCSIIO_CONTROL_TASKPRI_SHIFT (11) #define MPI2_SCSIIO_CONTROL_TASKATTRIBUTE_MASK (0x00000700) #define MPI2_SCSIIO_CONTROL_SIMPLEQ (0x00000000) #define MPI2_SCSIIO_CONTROL_HEADOFQ (0x00000100) #define MPI2_SCSIIO_CONTROL_ORDEREDQ (0x00000200) #define MPI2_SCSIIO_CONTROL_ACAQ (0x00000400) #define MPI2_SCSIIO_CONTROL_TLR_MASK (0x000000C0) #define MPI2_SCSIIO_CONTROL_NO_TLR (0x00000000) #define MPI2_SCSIIO_CONTROL_TLR_ON (0x00000040) #define MPI2_SCSIIO_CONTROL_TLR_OFF (0x00000080) /*******************/ typedef struct { uint8_t CDB[20]; /* 0x00 */ uint32_t PrimaryReferenceTag; /* 0x14 */ uint16_t PrimaryApplicationTag; /* 0x18 */ uint16_t PrimaryApplicationTagMask; /* 0x1A */ uint32_t TransferLength; /* 0x1C */ } MPI2_SCSI_IO_CDB_EEDP32; typedef union _MPI2_IEEE_SGE_CHAIN_UNION { struct MPI2_IEEE_SGE_SIMPLE32 Chain32; struct MPI2_IEEE_SGE_SIMPLE64 Chain64; } MPI2_IEEE_SGE_CHAIN_UNION; typedef union _MPI2_SIMPLE_SGE_UNION { MPI2_SGE_SIMPLE_UNION MpiSimple; MPI2_IEEE_SGE_SIMPLE_UNION IeeeSimple; } MPI2_SIMPLE_SGE_UNION; typedef union _MPI2_SGE_IO_UNION { MPI2_SGE_SIMPLE_UNION MpiSimple; struct MPI2_SGE_CHAIN_UNION MpiChain; MPI2_IEEE_SGE_SIMPLE_UNION IeeeSimple; MPI2_IEEE_SGE_CHAIN_UNION IeeeChain; } MPI2_SGE_IO_UNION; typedef union { uint8_t CDB32[32]; MPI2_SCSI_IO_CDB_EEDP32 EEDP32; MPI2_SGE_SIMPLE_UNION SGE; } MPI2_SCSI_IO_CDB_UNION; /* MPI 2.5 SGLs */ #define MPI25_IEEE_SGE_FLAGS_END_OF_LIST (0x40) typedef struct _MPI25_IEEE_SGE_CHAIN64 { uint64_t Address; uint32_t Length; uint16_t Reserved1; uint8_t NextChainOffset; uint8_t Flags; } MPI25_IEEE_SGE_CHAIN64, *pMpi25IeeeSgeChain64_t; /* use MPI2_IEEE_SGE_FLAGS_ defines for the Flags field */ /********/ /* * RAID SCSI IO Request Message * Total SGE count will be one less than _MPI2_SCSI_IO_REQUEST */ struct mfi_mpi2_request_raid_scsi_io { uint16_t DevHandle; /* 0x00 */ uint8_t ChainOffset; /* 0x02 */ uint8_t Function; /* 0x03 */ uint16_t Reserved1; /* 0x04 */ uint8_t Reserved2; /* 0x06 */ uint8_t MsgFlags; /* 0x07 */ uint8_t VP_ID; /* 0x08 */ uint8_t VF_ID; /* 0x09 */ uint16_t Reserved3; /* 0x0A */ uint32_t SenseBufferLowAddress; /* 0x0C */ uint16_t SGLFlags; /* 0x10 */ uint8_t SenseBufferLength; /* 0x12 */ uint8_t Reserved4; /* 0x13 */ uint8_t SGLOffset0; /* 0x14 */ uint8_t SGLOffset1; /* 0x15 */ uint8_t SGLOffset2; /* 0x16 */ uint8_t SGLOffset3; /* 0x17 */ uint32_t SkipCount; /* 0x18 */ uint32_t DataLength; /* 0x1C */ uint32_t BidirectionalDataLength; /* 0x20 */ uint16_t IoFlags; /* 0x24 */ uint16_t EEDPFlags; /* 0x26 */ uint32_t EEDPBlockSize; /* 0x28 */ uint32_t SecondaryReferenceTag; /* 0x2C */ uint16_t SecondaryApplicationTag; /* 0x30 */ uint16_t ApplicationTagTranslationMask; /* 0x32 */ uint8_t LUN[8]; /* 0x34 */ uint32_t Control; /* 0x3C */ MPI2_SCSI_IO_CDB_UNION CDB; /* 0x40 */ MPI2_SCSI_IO_VENDOR_UNIQUE RaidContext; /* 0x60 */ MPI2_SGE_IO_UNION SGL; /* 0x80 */ } __packed; /* * MPT RAID MFA IO Descriptor. */ typedef struct _MFI_RAID_MFA_IO_DESCRIPTOR { uint32_t RequestFlags : 8; uint32_t MessageAddress1 : 24; /* bits 31:8*/ uint32_t MessageAddress2; /* bits 61:32 */ } MFI_RAID_MFA_IO_REQUEST_DESCRIPTOR,*PMFI_RAID_MFA_IO_REQUEST_DESCRIPTOR; struct mfi_mpi2_request_header { uint8_t RequestFlags; /* 0x00 */ uint8_t MSIxIndex; /* 0x01 */ uint16_t SMID; /* 0x02 */ uint16_t LMID; /* 0x04 */ }; /* defines for the RequestFlags field */ #define MPI2_REQ_DESCRIPT_FLAGS_TYPE_MASK (0x0E) #define MPI2_REQ_DESCRIPT_FLAGS_SCSI_IO (0x00) #define MPI2_REQ_DESCRIPT_FLAGS_SCSI_TARGET (0x02) #define MPI2_REQ_DESCRIPT_FLAGS_HIGH_PRIORITY (0x06) #define MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE (0x08) #define MPI2_REQ_DESCRIPT_FLAGS_RAID_ACCELERATOR (0x0A) #define MPI2_REQ_DESCRIPT_FLAGS_IOC_FIFO_MARKER (0x01) struct mfi_mpi2_request_high_priority { struct mfi_mpi2_request_header header; uint16_t reserved; }; struct mfi_mpi2_request_scsi_io { struct mfi_mpi2_request_header header; uint16_t scsi_io_dev_handle; }; struct mfi_mpi2_request_scsi_target { struct mfi_mpi2_request_header header; uint16_t scsi_target_io_index; }; /* Request Descriptors */ union mfi_mpi2_request_descriptor { struct mfi_mpi2_request_header header; struct mfi_mpi2_request_high_priority high_priority; struct mfi_mpi2_request_scsi_io scsi_io; struct mfi_mpi2_request_scsi_target scsi_target; uint64_t words; }; struct mfi_mpi2_reply_header { uint8_t ReplyFlags; /* 0x00 */ uint8_t MSIxIndex; /* 0x01 */ uint16_t SMID; /* 0x02 */ }; /* defines for the ReplyFlags field */ #define MPI2_RPY_DESCRIPT_FLAGS_TYPE_MASK (0x0F) #define MPI2_RPY_DESCRIPT_FLAGS_SCSI_IO_SUCCESS (0x00) #define MPI2_RPY_DESCRIPT_FLAGS_ADDRESS_REPLY (0x01) #define MPI2_RPY_DESCRIPT_FLAGS_TARGETASSIST_SUCCESS (0x02) #define MPI2_RPY_DESCRIPT_FLAGS_TARGET_COMMAND_BUFFER (0x03) #define MPI2_RPY_DESCRIPT_FLAGS_RAID_ACCELERATOR_SUCCESS (0x05) #define MPI2_RPY_DESCRIPT_FLAGS_UNUSED (0x0F) /* values for marking a reply descriptor as unused */ #define MPI2_RPY_DESCRIPT_UNUSED_WORD0_MARK (0xFFFFFFFF) #define MPI2_RPY_DESCRIPT_UNUSED_WORD1_MARK (0xFFFFFFFF) struct mfi_mpi2_reply_default { struct mfi_mpi2_reply_header header; uint32_t DescriptorTypeDependent2; }; struct mfi_mpi2_reply_address { struct mfi_mpi2_reply_header header; uint32_t ReplyFrameAddress; }; struct mfi_mpi2_reply_scsi_io { struct mfi_mpi2_reply_header header; uint16_t TaskTag; /* 0x04 */ uint16_t Reserved1; /* 0x06 */ }; struct mfi_mpi2_reply_target_assist { struct mfi_mpi2_reply_header header; uint8_t SequenceNumber; /* 0x04 */ uint8_t Reserved1; /* 0x04 */ uint16_t IoIndex; /* 0x06 */ }; struct mfi_mpi2_reply_target_cmd_buffer { struct mfi_mpi2_reply_header header; uint8_t SequenceNumber; /* 0x04 */ uint8_t Flags; /* 0x04 */ uint16_t InitiatorDevHandle; /* 0x06 */ uint16_t IoIndex; /* 0x06 */ }; struct mfi_mpi2_reply_raid_accel { struct mfi_mpi2_reply_header header; uint8_t SequenceNumber; /* 0x04 */ uint32_t Reserved; /* 0x04 */ }; /* union of Reply Descriptors */ union mfi_mpi2_reply_descriptor { struct mfi_mpi2_reply_header header; struct mfi_mpi2_reply_scsi_io scsi_io; struct mfi_mpi2_reply_target_assist target_assist; struct mfi_mpi2_reply_target_cmd_buffer target_cmd; struct mfi_mpi2_reply_raid_accel raid_accel; struct mfi_mpi2_reply_default reply_default; uint64_t words; }; struct IO_REQUEST_INFO { uint64_t ldStartBlock; uint32_t numBlocks; uint16_t ldTgtId; uint8_t isRead; uint16_t devHandle; uint64_t pdBlock; uint8_t fpOkForIo; }; #define MFI_SCSI_MAX_TARGETS 128 #define MFI_SCSI_MAX_LUNS 8 #define MFI_SCSI_INITIATOR_ID 255 #define MFI_SCSI_MAX_CMDS 8 #define MFI_SCSI_MAX_CDB_LEN 16 #endif /* _MFIREG_H */