1 /* 2 * QLogic iSCSI Offload Driver 3 * Copyright (c) 2016 Cavium Inc. 4 * 5 * This software is available under the terms of the GNU General Public License 6 * (GPL) Version 2, available from the file COPYING in the main directory of 7 * this source tree. 8 */ 9 10 #ifndef _QEDI_H_ 11 #define _QEDI_H_ 12 13 #define __PREVENT_QED_HSI__ 14 15 #include <scsi/scsi_transport_iscsi.h> 16 #include <scsi/libiscsi.h> 17 #include <scsi/scsi_host.h> 18 #include <linux/uio_driver.h> 19 20 #include "qedi_hsi.h" 21 #include <linux/qed/qed_if.h> 22 #include "qedi_dbg.h" 23 #include <linux/qed/qed_iscsi_if.h> 24 #include <linux/qed/qed_ll2_if.h> 25 #include "qedi_version.h" 26 #include "qedi_nvm_iscsi_cfg.h" 27 28 #define QEDI_MODULE_NAME "qedi" 29 30 struct qedi_endpoint; 31 32 #ifndef GET_FIELD2 33 #define GET_FIELD2(value, name) \ 34 (((value) & (name ## _MASK)) >> (name ## _OFFSET)) 35 #endif 36 37 /* 38 * PCI function probe defines 39 */ 40 #define QEDI_MODE_NORMAL 0 41 #define QEDI_MODE_RECOVERY 1 42 43 #define ISCSI_WQE_SET_PTU_INVALIDATE 1 44 #define QEDI_MAX_ISCSI_TASK 4096 45 #define QEDI_MAX_TASK_NUM 0x0FFF 46 #define QEDI_MAX_ISCSI_CONNS_PER_HBA 1024 47 #define QEDI_ISCSI_MAX_BDS_PER_CMD 255 /* Firmware max BDs is 255 */ 48 #define MAX_OUTSTANDING_TASKS_PER_CON 1024 49 50 #define QEDI_MAX_BD_LEN 0xffff 51 #define QEDI_BD_SPLIT_SZ 0x1000 52 #define QEDI_PAGE_SIZE 4096 53 #define QEDI_FAST_SGE_COUNT 4 54 /* MAX Length for cached SGL */ 55 #define MAX_SGLEN_FOR_CACHESGL ((1U << 16) - 1) 56 57 #define MIN_NUM_CPUS_MSIX(x) min_t(u32, x->dev_info.num_cqs, \ 58 num_online_cpus()) 59 60 #define QEDI_LOCAL_PORT_MIN 60000 61 #define QEDI_LOCAL_PORT_MAX 61024 62 #define QEDI_LOCAL_PORT_RANGE (QEDI_LOCAL_PORT_MAX - QEDI_LOCAL_PORT_MIN) 63 #define QEDI_LOCAL_PORT_INVALID 0xffff 64 #define TX_RX_RING 16 65 #define RX_RING (TX_RX_RING - 1) 66 #define QEDI_PAGE_ALIGN(addr) ALIGN(addr, QEDI_PAGE_SIZE) 67 #define QEDI_PAGE_MASK (~((QEDI_PAGE_SIZE) - 1)) 68 69 #define QEDI_HW_DMA_BOUNDARY 0xfff 70 #define QEDI_PATH_HANDLE 0xFE0000000UL 71 72 enum qedi_nvm_tgts { 73 QEDI_NVM_TGT_PRI, 74 QEDI_NVM_TGT_SEC, 75 }; 76 77 struct qedi_nvm_iscsi_image { 78 struct nvm_iscsi_cfg iscsi_cfg; 79 u32 crc; 80 }; 81 82 struct qedi_uio_ctrl { 83 /* meta data */ 84 u32 uio_hsi_version; 85 86 /* user writes */ 87 u32 host_tx_prod; 88 u32 host_rx_cons; 89 u32 host_rx_bd_cons; 90 u32 host_tx_pkt_len; 91 u32 host_rx_cons_cnt; 92 93 /* driver writes */ 94 u32 hw_tx_cons; 95 u32 hw_rx_prod; 96 u32 hw_rx_bd_prod; 97 u32 hw_rx_prod_cnt; 98 99 /* other */ 100 u8 mac_addr[6]; 101 u8 reserve[2]; 102 }; 103 104 struct qedi_rx_bd { 105 u32 rx_pkt_index; 106 u32 rx_pkt_len; 107 u16 vlan_id; 108 }; 109 110 #define QEDI_RX_DESC_CNT (QEDI_PAGE_SIZE / sizeof(struct qedi_rx_bd)) 111 #define QEDI_MAX_RX_DESC_CNT (QEDI_RX_DESC_CNT - 1) 112 #define QEDI_NUM_RX_BD (QEDI_RX_DESC_CNT * 1) 113 #define QEDI_MAX_RX_BD (QEDI_NUM_RX_BD - 1) 114 115 #define QEDI_NEXT_RX_IDX(x) ((((x) & (QEDI_MAX_RX_DESC_CNT)) == \ 116 (QEDI_MAX_RX_DESC_CNT - 1)) ? \ 117 (x) + 2 : (x) + 1) 118 119 struct qedi_uio_dev { 120 struct uio_info qedi_uinfo; 121 u32 uio_dev; 122 struct list_head list; 123 124 u32 ll2_ring_size; 125 void *ll2_ring; 126 127 u32 ll2_buf_size; 128 void *ll2_buf; 129 130 void *rx_pkt; 131 void *tx_pkt; 132 133 struct qedi_ctx *qedi; 134 struct pci_dev *pdev; 135 void *uctrl; 136 }; 137 138 /* List to maintain the skb pointers */ 139 struct skb_work_list { 140 struct list_head list; 141 struct sk_buff *skb; 142 u16 vlan_id; 143 }; 144 145 /* Queue sizes in number of elements */ 146 #define QEDI_SQ_SIZE MAX_OUTSTANDING_TASKS_PER_CON 147 #define QEDI_CQ_SIZE 2048 148 #define QEDI_CMDQ_SIZE QEDI_MAX_ISCSI_TASK 149 #define QEDI_PROTO_CQ_PROD_IDX 0 150 151 struct qedi_glbl_q_params { 152 u64 hw_p_cq; /* Completion queue PBL */ 153 u64 hw_p_rq; /* Request queue PBL */ 154 u64 hw_p_cmdq; /* Command queue PBL */ 155 }; 156 157 struct global_queue { 158 union iscsi_cqe *cq; 159 dma_addr_t cq_dma; 160 u32 cq_mem_size; 161 u32 cq_cons_idx; /* Completion queue consumer index */ 162 163 void *cq_pbl; 164 dma_addr_t cq_pbl_dma; 165 u32 cq_pbl_size; 166 167 }; 168 169 struct qedi_fastpath { 170 struct qed_sb_info *sb_info; 171 u16 sb_id; 172 #define QEDI_NAME_SIZE 16 173 char name[QEDI_NAME_SIZE]; 174 struct qedi_ctx *qedi; 175 }; 176 177 /* Used to pass fastpath information needed to process CQEs */ 178 struct qedi_io_work { 179 struct list_head list; 180 struct iscsi_cqe_solicited cqe; 181 u16 que_idx; 182 }; 183 184 /** 185 * struct iscsi_cid_queue - Per adapter iscsi cid queue 186 * 187 * @cid_que_base: queue base memory 188 * @cid_que: queue memory pointer 189 * @cid_q_prod_idx: produce index 190 * @cid_q_cons_idx: consumer index 191 * @cid_q_max_idx: max index. used to detect wrap around condition 192 * @cid_free_cnt: queue size 193 * @conn_cid_tbl: iscsi cid to conn structure mapping table 194 * 195 * Per adapter iSCSI CID Queue 196 */ 197 struct iscsi_cid_queue { 198 void *cid_que_base; 199 u32 *cid_que; 200 u32 cid_q_prod_idx; 201 u32 cid_q_cons_idx; 202 u32 cid_q_max_idx; 203 u32 cid_free_cnt; 204 struct qedi_conn **conn_cid_tbl; 205 }; 206 207 struct qedi_portid_tbl { 208 spinlock_t lock; /* Port id lock */ 209 u16 start; 210 u16 max; 211 u16 next; 212 unsigned long *table; 213 }; 214 215 struct qedi_itt_map { 216 __le32 itt; 217 struct qedi_cmd *p_cmd; 218 }; 219 220 /* I/O tracing entry */ 221 #define QEDI_IO_TRACE_SIZE 2048 222 struct qedi_io_log { 223 #define QEDI_IO_TRACE_REQ 0 224 #define QEDI_IO_TRACE_RSP 1 225 u8 direction; 226 u16 task_id; 227 u32 cid; 228 u32 port_id; /* Remote port fabric ID */ 229 int lun; 230 u8 op; /* SCSI CDB */ 231 u8 lba[4]; 232 unsigned int bufflen; /* SCSI buffer length */ 233 unsigned int sg_count; /* Number of SG elements */ 234 u8 fast_sgs; /* number of fast sgls */ 235 u8 slow_sgs; /* number of slow sgls */ 236 u8 cached_sgs; /* number of cached sgls */ 237 int result; /* Result passed back to mid-layer */ 238 unsigned long jiffies; /* Time stamp when I/O logged */ 239 int refcount; /* Reference count for task id */ 240 unsigned int blk_req_cpu; /* CPU that the task is queued on by 241 * blk layer 242 */ 243 unsigned int req_cpu; /* CPU that the task is queued on */ 244 unsigned int intr_cpu; /* Interrupt CPU that the task is received on */ 245 unsigned int blk_rsp_cpu;/* CPU that task is actually processed and 246 * returned to blk layer 247 */ 248 bool cached_sge; 249 bool slow_sge; 250 bool fast_sge; 251 }; 252 253 /* Number of entries in BDQ */ 254 #define QEDI_BDQ_NUM 256 255 #define QEDI_BDQ_BUF_SIZE 256 256 257 /* DMA coherent buffers for BDQ */ 258 struct qedi_bdq_buf { 259 void *buf_addr; 260 dma_addr_t buf_dma; 261 }; 262 263 /* Main port level struct */ 264 struct qedi_ctx { 265 struct qedi_dbg_ctx dbg_ctx; 266 struct Scsi_Host *shost; 267 struct pci_dev *pdev; 268 struct qed_dev *cdev; 269 struct qed_dev_iscsi_info dev_info; 270 struct qed_int_info int_info; 271 struct qedi_glbl_q_params *p_cpuq; 272 struct global_queue **global_queues; 273 /* uio declaration */ 274 struct qedi_uio_dev *udev; 275 struct list_head ll2_skb_list; 276 spinlock_t ll2_lock; /* Light L2 lock */ 277 spinlock_t hba_lock; /* per port lock */ 278 struct task_struct *ll2_recv_thread; 279 unsigned long flags; 280 #define UIO_DEV_OPENED 1 281 #define QEDI_IOTHREAD_WAKE 2 282 #define QEDI_IN_RECOVERY 5 283 #define QEDI_IN_OFFLINE 6 284 285 u8 mac[ETH_ALEN]; 286 u32 src_ip[4]; 287 u8 ip_type; 288 289 /* Physical address of above array */ 290 dma_addr_t hw_p_cpuq; 291 292 struct qedi_bdq_buf bdq[QEDI_BDQ_NUM]; 293 void *bdq_pbl; 294 dma_addr_t bdq_pbl_dma; 295 size_t bdq_pbl_mem_size; 296 void *bdq_pbl_list; 297 dma_addr_t bdq_pbl_list_dma; 298 u8 bdq_pbl_list_num_entries; 299 struct qedi_nvm_iscsi_image *iscsi_image; 300 dma_addr_t nvm_buf_dma; 301 void __iomem *bdq_primary_prod; 302 void __iomem *bdq_secondary_prod; 303 u16 bdq_prod_idx; 304 u16 rq_num_entries; 305 306 u32 max_sqes; 307 u8 num_queues; 308 u32 max_active_conns; 309 310 struct iscsi_cid_queue cid_que; 311 struct qedi_endpoint **ep_tbl; 312 struct qedi_portid_tbl lcl_port_tbl; 313 314 /* Rx fast path intr context */ 315 struct qed_sb_info *sb_array; 316 struct qedi_fastpath *fp_array; 317 struct qed_iscsi_tid tasks; 318 319 #define QEDI_LINK_DOWN 0 320 #define QEDI_LINK_UP 1 321 atomic_t link_state; 322 323 #define QEDI_RESERVE_TASK_ID 0 324 #define MAX_ISCSI_TASK_ENTRIES 4096 325 #define QEDI_INVALID_TASK_ID (MAX_ISCSI_TASK_ENTRIES + 1) 326 unsigned long task_idx_map[MAX_ISCSI_TASK_ENTRIES / BITS_PER_LONG]; 327 struct qedi_itt_map *itt_map; 328 u16 tid_reuse_count[QEDI_MAX_ISCSI_TASK]; 329 struct qed_pf_params pf_params; 330 331 struct workqueue_struct *tmf_thread; 332 struct workqueue_struct *offload_thread; 333 334 u16 ll2_mtu; 335 336 struct workqueue_struct *dpc_wq; 337 338 spinlock_t task_idx_lock; /* To protect gbl context */ 339 s32 last_tidx_alloc; 340 s32 last_tidx_clear; 341 342 struct qedi_io_log io_trace_buf[QEDI_IO_TRACE_SIZE]; 343 spinlock_t io_trace_lock; /* prtect trace Log buf */ 344 u16 io_trace_idx; 345 unsigned int intr_cpu; 346 u32 cached_sgls; 347 bool use_cached_sge; 348 u32 slow_sgls; 349 bool use_slow_sge; 350 u32 fast_sgls; 351 bool use_fast_sge; 352 353 atomic_t num_offloads; 354 #define SYSFS_FLAG_FW_SEL_BOOT 2 355 #define IPV6_LEN 41 356 #define IPV4_LEN 17 357 struct iscsi_boot_kset *boot_kset; 358 359 /* Used for iscsi statistics */ 360 struct mutex stats_lock; 361 }; 362 363 struct qedi_work { 364 struct list_head list; 365 struct qedi_ctx *qedi; 366 union iscsi_cqe cqe; 367 u16 que_idx; 368 bool is_solicited; 369 }; 370 371 struct qedi_percpu_s { 372 struct task_struct *iothread; 373 struct list_head work_list; 374 spinlock_t p_work_lock; /* Per cpu worker lock */ 375 }; 376 377 static inline void *qedi_get_task_mem(struct qed_iscsi_tid *info, u32 tid) 378 { 379 return (info->blocks[tid / info->num_tids_per_block] + 380 (tid % info->num_tids_per_block) * info->size); 381 } 382 383 #define QEDI_U64_HI(val) ((u32)(((u64)(val)) >> 32)) 384 #define QEDI_U64_LO(val) ((u32)(((u64)(val)) & 0xffffffff)) 385 386 #endif /* _QEDI_H_ */ 387