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 * $FreeBSD$ 28 * 29 */ 30 31 #ifndef __STORAGE_COMMON__ 32 #define __STORAGE_COMMON__ 33 /*********************/ 34 /* SCSI CONSTANTS */ 35 /*********************/ 36 37 #define SCSI_MAX_NUM_OF_CMDQS (NUM_OF_GLOBAL_QUEUES / 2) 38 // Each Resource ID is one-one-valued mapped by the driver to a BDQ Resource ID (for instance per port) 39 #define BDQ_NUM_RESOURCES (4) 40 41 // ID 0 : RQ, ID 1 : IMMEDIATE_DATA, ID 2 : TQ 42 #define BDQ_ID_RQ (0) 43 #define BDQ_ID_IMM_DATA (1) 44 #define BDQ_ID_TQ (2) 45 #define BDQ_NUM_IDS (3) 46 47 #define SCSI_NUM_SGES_SLOW_SGL_THR 8 48 49 #define BDQ_MAX_EXTERNAL_RING_SIZE (1<<15) 50 51 /* SCSI op codes */ 52 #define SCSI_OPCODE_COMPARE_AND_WRITE (0x89) 53 #define SCSI_OPCODE_READ_10 (0x28) 54 #define SCSI_OPCODE_WRITE_6 (0x0A) 55 #define SCSI_OPCODE_WRITE_10 (0x2A) 56 #define SCSI_OPCODE_WRITE_12 (0xAA) 57 #define SCSI_OPCODE_WRITE_16 (0x8A) 58 #define SCSI_OPCODE_WRITE_AND_VERIFY_10 (0x2E) 59 #define SCSI_OPCODE_WRITE_AND_VERIFY_12 (0xAE) 60 #define SCSI_OPCODE_WRITE_AND_VERIFY_16 (0x8E) 61 62 /* 63 * iSCSI Drv opaque 64 */ 65 struct iscsi_drv_opaque 66 { 67 __le16 reserved_zero[3]; 68 __le16 opaque; 69 }; 70 71 /* 72 * Scsi 2B/8B opaque union 73 */ 74 union scsi_opaque 75 { 76 struct regpair fcoe_opaque /* 8 Bytes opaque */; 77 struct iscsi_drv_opaque iscsi_opaque /* 2 Bytes opaque */; 78 }; 79 80 /* 81 * SCSI buffer descriptor 82 */ 83 struct scsi_bd 84 { 85 struct regpair address /* Physical Address of buffer */; 86 union scsi_opaque opaque /* Driver Metadata (preferably Virtual Address of buffer) */; 87 }; 88 89 /* 90 * Scsi Drv BDQ struct 91 */ 92 struct scsi_bdq_ram_drv_data 93 { 94 __le16 external_producer /* BDQ External Producer; updated by driver when it loads BDs to External Ring */; 95 __le16 reserved0[3]; 96 }; 97 98 /* 99 * SCSI SGE entry 100 */ 101 struct scsi_sge 102 { 103 struct regpair sge_addr /* SGE address */; 104 __le32 sge_len /* SGE length */; 105 __le32 reserved; 106 }; 107 108 /* 109 * Cached SGEs section 110 */ 111 struct scsi_cached_sges 112 { 113 struct scsi_sge sge[4] /* Cached SGEs section */; 114 }; 115 116 /* 117 * Scsi Drv CMDQ struct 118 */ 119 struct scsi_drv_cmdq 120 { 121 __le16 cmdq_cons /* CMDQ consumer - updated by driver when CMDQ is consumed */; 122 __le16 reserved0; 123 __le32 reserved1; 124 }; 125 126 /* 127 * Common SCSI init params passed by driver to FW in function init ramrod 128 */ 129 struct scsi_init_func_params 130 { 131 __le16 num_tasks /* Number of tasks in global task list */; 132 u8 log_page_size /* log of page size value */; 133 u8 debug_mode /* Use iscsi_debug_mode enum */; 134 u8 reserved2[12]; 135 }; 136 137 /* 138 * SCSI RQ/CQ/CMDQ firmware function init parameters 139 */ 140 struct scsi_init_func_queues 141 { 142 struct regpair glbl_q_params_addr /* Global Qs (CQ/RQ/CMDQ) params host address */; 143 __le16 rq_buffer_size /* The buffer size of RQ BDQ */; 144 __le16 cq_num_entries /* CQ num entries */; 145 __le16 cmdq_num_entries /* CMDQ num entries */; 146 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 */; 147 u8 q_validity; 148 #define SCSI_INIT_FUNC_QUEUES_RQ_VALID_MASK 0x1 149 #define SCSI_INIT_FUNC_QUEUES_RQ_VALID_SHIFT 0 150 #define SCSI_INIT_FUNC_QUEUES_IMM_DATA_VALID_MASK 0x1 151 #define SCSI_INIT_FUNC_QUEUES_IMM_DATA_VALID_SHIFT 1 152 #define SCSI_INIT_FUNC_QUEUES_CMD_VALID_MASK 0x1 153 #define SCSI_INIT_FUNC_QUEUES_CMD_VALID_SHIFT 2 154 #define SCSI_INIT_FUNC_QUEUES_TQ_VALID_MASK 0x1 155 #define SCSI_INIT_FUNC_QUEUES_TQ_VALID_SHIFT 3 156 #define SCSI_INIT_FUNC_QUEUES_SOC_EN_MASK 0x1 /* This bit is valid if TQ is enabled for this function, SOC option enabled/disabled */ 157 #define SCSI_INIT_FUNC_QUEUES_SOC_EN_SHIFT 4 158 #define SCSI_INIT_FUNC_QUEUES_SOC_NUM_OF_BLOCKS_LOG_MASK 0x7 /* Relevant for TQe SOC option - num of blocks in SGE - log */ 159 #define SCSI_INIT_FUNC_QUEUES_SOC_NUM_OF_BLOCKS_LOG_SHIFT 5 160 __le16 cq_cmdq_sb_num_arr[SCSI_MAX_NUM_OF_CMDQS] /* CQ/CMDQ status block number array */; 161 u8 num_queues /* Number of continuous global queues used */; 162 u8 queue_relative_offset /* offset of continuous global queues used */; 163 u8 cq_sb_pi /* Protocol Index of CQ in status block (CQ consumer) */; 164 u8 cmdq_sb_pi /* Protocol Index of CMDQ in status block (CMDQ consumer) */; 165 u8 bdq_pbl_num_entries[BDQ_NUM_IDS] /* Per BDQ ID, the PBL page size (number of entries in PBL) */; 166 u8 reserved1 /* reserved */; 167 struct regpair bdq_pbl_base_address[BDQ_NUM_IDS] /* Per BDQ ID, the PBL page Base Address */; 168 __le16 bdq_xoff_threshold[BDQ_NUM_IDS] /* BDQ XOFF threshold - when number of entries will be below that TH, it will send XOFF */; 169 __le16 cmdq_xoff_threshold /* CMDQ XOFF threshold - when number of entries will be below that TH, it will send XOFF */; 170 __le16 bdq_xon_threshold[BDQ_NUM_IDS] /* BDQ XON threshold - when number of entries will be above that TH, it will send XON */; 171 __le16 cmdq_xon_threshold /* CMDQ XON threshold - when number of entries will be above that TH, it will send XON */; 172 }; 173 174 /* 175 * Scsi Drv BDQ Data struct (2 BDQ IDs: 0 - RQ, 1 - Immediate Data) 176 */ 177 struct scsi_ram_per_bdq_resource_drv_data 178 { 179 struct scsi_bdq_ram_drv_data drv_data_per_bdq_id[BDQ_NUM_IDS] /* External ring data */; 180 }; 181 182 /* 183 * SCSI SGL types 184 */ 185 enum scsi_sgl_mode 186 { 187 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 */, 188 SCSI_FAST_SGL /* Fast SGL: Less than SCSI_NUM_SGES_SLOW_SGL_THR SGEs or all middle SGEs are at least a page size */, 189 MAX_SCSI_SGL_MODE 190 }; 191 192 /* 193 * SCSI SGL parameters 194 */ 195 struct scsi_sgl_params 196 { 197 struct regpair sgl_addr /* SGL base address */; 198 __le32 sgl_total_length /* SGL total legnth (bytes) */; 199 __le32 sge_offset /* Offset in SGE (bytes) */; 200 __le16 sgl_num_sges /* Number of SGLs sges */; 201 u8 sgl_index /* SGL index */; 202 u8 reserved; 203 }; 204 205 /* 206 * SCSI terminate connection params 207 */ 208 struct scsi_terminate_extra_params 209 { 210 __le16 unsolicited_cq_count /* Counts number of CQ placements done due to arrival of unsolicited packets on this connection */; 211 __le16 cmdq_count /* Counts number of CMDQ placements on this connection */; 212 u8 reserved[4]; 213 }; 214 215 /* 216 * SCSI Task Queue Element 217 */ 218 struct scsi_tqe 219 { 220 __le16 itid /* Physical Address of buffer */; 221 }; 222 223 #endif /* __STORAGE_COMMON__ */ 224