1 /* 2 * Copyright (c) 2017-2018 Cavium, Inc. 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 * 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 19 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 25 * POSSIBILITY OF SUCH DAMAGE. 26 * 27 */ 28 29 #ifndef __STORAGE_COMMON__ 30 #define __STORAGE_COMMON__ 31 /*********************/ 32 /* SCSI CONSTANTS */ 33 /*********************/ 34 35 #define SCSI_MAX_NUM_OF_CMDQS (NUM_OF_GLOBAL_QUEUES / 2) 36 // Each Resource ID is one-one-valued mapped by the driver to a BDQ Resource ID (for instance per port) 37 #define BDQ_NUM_RESOURCES (4) 38 39 // ID 0 : RQ, ID 1 : IMMEDIATE_DATA, ID 2 : TQ 40 #define BDQ_ID_RQ (0) 41 #define BDQ_ID_IMM_DATA (1) 42 #define BDQ_ID_TQ (2) 43 #define BDQ_NUM_IDS (3) 44 45 #define SCSI_NUM_SGES_SLOW_SGL_THR 8 46 47 #define BDQ_MAX_EXTERNAL_RING_SIZE (1<<15) 48 49 /* SCSI op codes */ 50 #define SCSI_OPCODE_COMPARE_AND_WRITE (0x89) 51 #define SCSI_OPCODE_READ_10 (0x28) 52 #define SCSI_OPCODE_WRITE_6 (0x0A) 53 #define SCSI_OPCODE_WRITE_10 (0x2A) 54 #define SCSI_OPCODE_WRITE_12 (0xAA) 55 #define SCSI_OPCODE_WRITE_16 (0x8A) 56 #define SCSI_OPCODE_WRITE_AND_VERIFY_10 (0x2E) 57 #define SCSI_OPCODE_WRITE_AND_VERIFY_12 (0xAE) 58 #define SCSI_OPCODE_WRITE_AND_VERIFY_16 (0x8E) 59 60 /* 61 * iSCSI Drv opaque 62 */ 63 struct iscsi_drv_opaque 64 { 65 __le16 reserved_zero[3]; 66 __le16 opaque; 67 }; 68 69 /* 70 * Scsi 2B/8B opaque union 71 */ 72 union scsi_opaque 73 { 74 struct regpair fcoe_opaque /* 8 Bytes opaque */; 75 struct iscsi_drv_opaque iscsi_opaque /* 2 Bytes opaque */; 76 }; 77 78 /* 79 * SCSI buffer descriptor 80 */ 81 struct scsi_bd 82 { 83 struct regpair address /* Physical Address of buffer */; 84 union scsi_opaque opaque /* Driver Metadata (preferably Virtual Address of buffer) */; 85 }; 86 87 /* 88 * Scsi Drv BDQ struct 89 */ 90 struct scsi_bdq_ram_drv_data 91 { 92 __le16 external_producer /* BDQ External Producer; updated by driver when it loads BDs to External Ring */; 93 __le16 reserved0[3]; 94 }; 95 96 /* 97 * SCSI SGE entry 98 */ 99 struct scsi_sge 100 { 101 struct regpair sge_addr /* SGE address */; 102 __le32 sge_len /* SGE length */; 103 __le32 reserved; 104 }; 105 106 /* 107 * Cached SGEs section 108 */ 109 struct scsi_cached_sges 110 { 111 struct scsi_sge sge[4] /* Cached SGEs section */; 112 }; 113 114 /* 115 * Scsi Drv CMDQ struct 116 */ 117 struct scsi_drv_cmdq 118 { 119 __le16 cmdq_cons /* CMDQ consumer - updated by driver when CMDQ is consumed */; 120 __le16 reserved0; 121 __le32 reserved1; 122 }; 123 124 /* 125 * Common SCSI init params passed by driver to FW in function init ramrod 126 */ 127 struct scsi_init_func_params 128 { 129 __le16 num_tasks /* Number of tasks in global task list */; 130 u8 log_page_size /* log of page size value */; 131 u8 debug_mode /* Use iscsi_debug_mode enum */; 132 u8 reserved2[12]; 133 }; 134 135 /* 136 * SCSI RQ/CQ/CMDQ firmware function init parameters 137 */ 138 struct scsi_init_func_queues 139 { 140 struct regpair glbl_q_params_addr /* Global Qs (CQ/RQ/CMDQ) params host address */; 141 __le16 rq_buffer_size /* The buffer size of RQ BDQ */; 142 __le16 cq_num_entries /* CQ num entries */; 143 __le16 cmdq_num_entries /* CMDQ num entries */; 144 u8 bdq_resource_id /* Each function-init Ramrod maps its funciton ID to a BDQ function ID, each BDQ function ID contains per-BDQ-ID BDQs */; 145 u8 q_validity; 146 #define SCSI_INIT_FUNC_QUEUES_RQ_VALID_MASK 0x1 147 #define SCSI_INIT_FUNC_QUEUES_RQ_VALID_SHIFT 0 148 #define SCSI_INIT_FUNC_QUEUES_IMM_DATA_VALID_MASK 0x1 149 #define SCSI_INIT_FUNC_QUEUES_IMM_DATA_VALID_SHIFT 1 150 #define SCSI_INIT_FUNC_QUEUES_CMD_VALID_MASK 0x1 151 #define SCSI_INIT_FUNC_QUEUES_CMD_VALID_SHIFT 2 152 #define SCSI_INIT_FUNC_QUEUES_TQ_VALID_MASK 0x1 153 #define SCSI_INIT_FUNC_QUEUES_TQ_VALID_SHIFT 3 154 #define SCSI_INIT_FUNC_QUEUES_SOC_EN_MASK 0x1 /* This bit is valid if TQ is enabled for this function, SOC option enabled/disabled */ 155 #define SCSI_INIT_FUNC_QUEUES_SOC_EN_SHIFT 4 156 #define SCSI_INIT_FUNC_QUEUES_SOC_NUM_OF_BLOCKS_LOG_MASK 0x7 /* Relevant for TQe SOC option - num of blocks in SGE - log */ 157 #define SCSI_INIT_FUNC_QUEUES_SOC_NUM_OF_BLOCKS_LOG_SHIFT 5 158 __le16 cq_cmdq_sb_num_arr[SCSI_MAX_NUM_OF_CMDQS] /* CQ/CMDQ status block number array */; 159 u8 num_queues /* Number of continuous global queues used */; 160 u8 queue_relative_offset /* offset of continuous global queues used */; 161 u8 cq_sb_pi /* Protocol Index of CQ in status block (CQ consumer) */; 162 u8 cmdq_sb_pi /* Protocol Index of CMDQ in status block (CMDQ consumer) */; 163 u8 bdq_pbl_num_entries[BDQ_NUM_IDS] /* Per BDQ ID, the PBL page size (number of entries in PBL) */; 164 u8 reserved1 /* reserved */; 165 struct regpair bdq_pbl_base_address[BDQ_NUM_IDS] /* Per BDQ ID, the PBL page Base Address */; 166 __le16 bdq_xoff_threshold[BDQ_NUM_IDS] /* BDQ XOFF threshold - when number of entries will be below that TH, it will send XOFF */; 167 __le16 cmdq_xoff_threshold /* CMDQ XOFF threshold - when number of entries will be below that TH, it will send XOFF */; 168 __le16 bdq_xon_threshold[BDQ_NUM_IDS] /* BDQ XON threshold - when number of entries will be above that TH, it will send XON */; 169 __le16 cmdq_xon_threshold /* CMDQ XON threshold - when number of entries will be above that TH, it will send XON */; 170 }; 171 172 /* 173 * Scsi Drv BDQ Data struct (2 BDQ IDs: 0 - RQ, 1 - Immediate Data) 174 */ 175 struct scsi_ram_per_bdq_resource_drv_data 176 { 177 struct scsi_bdq_ram_drv_data drv_data_per_bdq_id[BDQ_NUM_IDS] /* External ring data */; 178 }; 179 180 /* 181 * SCSI SGL types 182 */ 183 enum scsi_sgl_mode 184 { 185 SCSI_TX_SLOW_SGL /* Slow-SGL: More than SCSI_NUM_SGES_SLOW_SGL_THR SGEs and there is at least 1 middle SGE than is smaller than a page size. May be only at TX */, 186 SCSI_FAST_SGL /* Fast SGL: Less than SCSI_NUM_SGES_SLOW_SGL_THR SGEs or all middle SGEs are at least a page size */, 187 MAX_SCSI_SGL_MODE 188 }; 189 190 /* 191 * SCSI SGL parameters 192 */ 193 struct scsi_sgl_params 194 { 195 struct regpair sgl_addr /* SGL base address */; 196 __le32 sgl_total_length /* SGL total legnth (bytes) */; 197 __le32 sge_offset /* Offset in SGE (bytes) */; 198 __le16 sgl_num_sges /* Number of SGLs sges */; 199 u8 sgl_index /* SGL index */; 200 u8 reserved; 201 }; 202 203 /* 204 * SCSI terminate connection params 205 */ 206 struct scsi_terminate_extra_params 207 { 208 __le16 unsolicited_cq_count /* Counts number of CQ placements done due to arrival of unsolicited packets on this connection */; 209 __le16 cmdq_count /* Counts number of CMDQ placements on this connection */; 210 u8 reserved[4]; 211 }; 212 213 /* 214 * SCSI Task Queue Element 215 */ 216 struct scsi_tqe 217 { 218 __le16 itid /* Physical Address of buffer */; 219 }; 220 221 #endif /* __STORAGE_COMMON__ */ 222