| 1 | /* |
| 2 | * Copyright (c) 2005 Cisco Systems. All rights reserved. |
| 3 | * |
| 4 | * This software is available to you under a choice of one of two |
| 5 | * licenses. You may choose to be licensed under the terms of the GNU |
| 6 | * General Public License (GPL) Version 2, available from the file |
| 7 | * COPYING in the main directory of this source tree, or the |
| 8 | * OpenIB.org BSD license below: |
| 9 | * |
| 10 | * Redistribution and use in source and binary forms, with or |
| 11 | * without modification, are permitted provided that the following |
| 12 | * conditions are met: |
| 13 | * |
| 14 | * - Redistributions of source code must retain the above |
| 15 | * copyright notice, this list of conditions and the following |
| 16 | * disclaimer. |
| 17 | * |
| 18 | * - Redistributions in binary form must reproduce the above |
| 19 | * copyright notice, this list of conditions and the following |
| 20 | * disclaimer in the documentation and/or other materials |
| 21 | * provided with the distribution. |
| 22 | * |
| 23 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
| 24 | * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
| 25 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
| 26 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS |
| 27 | * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN |
| 28 | * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN |
| 29 | * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 30 | * SOFTWARE. |
| 31 | */ |
| 32 | |
| 33 | #ifndef IB_SRP_H |
| 34 | #define IB_SRP_H |
| 35 | |
| 36 | #include <linux/types.h> |
| 37 | #include <linux/list.h> |
| 38 | #include <linux/mutex.h> |
| 39 | #include <linux/scatterlist.h> |
| 40 | |
| 41 | #include <scsi/scsi_host.h> |
| 42 | #include <scsi/scsi_cmnd.h> |
| 43 | |
| 44 | #include <rdma/ib_verbs.h> |
| 45 | #include <rdma/ib_sa.h> |
| 46 | #include <rdma/ib_cm.h> |
| 47 | #include <rdma/ib_fmr_pool.h> |
| 48 | |
| 49 | enum { |
| 50 | SRP_PATH_REC_TIMEOUT_MS = 1000, |
| 51 | SRP_ABORT_TIMEOUT_MS = 5000, |
| 52 | |
| 53 | SRP_PORT_REDIRECT = 1, |
| 54 | SRP_DLID_REDIRECT = 2, |
| 55 | SRP_STALE_CONN = 3, |
| 56 | |
| 57 | SRP_MAX_LUN = 512, |
| 58 | SRP_DEF_SG_TABLESIZE = 12, |
| 59 | |
| 60 | SRP_RQ_SHIFT = 6, |
| 61 | SRP_RQ_SIZE = 1 << SRP_RQ_SHIFT, |
| 62 | |
| 63 | SRP_SQ_SIZE = SRP_RQ_SIZE, |
| 64 | SRP_RSP_SQ_SIZE = 1, |
| 65 | SRP_REQ_SQ_SIZE = SRP_SQ_SIZE - SRP_RSP_SQ_SIZE, |
| 66 | SRP_TSK_MGMT_SQ_SIZE = 1, |
| 67 | SRP_CMD_SQ_SIZE = SRP_REQ_SQ_SIZE - SRP_TSK_MGMT_SQ_SIZE, |
| 68 | |
| 69 | SRP_TAG_NO_REQ = ~0U, |
| 70 | SRP_TAG_TSK_MGMT = 1U << 31, |
| 71 | |
| 72 | SRP_FMR_SIZE = 512, |
| 73 | SRP_FMR_MIN_SIZE = 128, |
| 74 | SRP_FMR_POOL_SIZE = 1024, |
| 75 | SRP_FMR_DIRTY_SIZE = SRP_FMR_POOL_SIZE / 4, |
| 76 | |
| 77 | SRP_MAP_ALLOW_FMR = 0, |
| 78 | SRP_MAP_NO_FMR = 1, |
| 79 | }; |
| 80 | |
| 81 | enum srp_target_state { |
| 82 | SRP_TARGET_LIVE, |
| 83 | SRP_TARGET_REMOVED, |
| 84 | }; |
| 85 | |
| 86 | enum srp_iu_type { |
| 87 | SRP_IU_CMD, |
| 88 | SRP_IU_TSK_MGMT, |
| 89 | SRP_IU_RSP, |
| 90 | }; |
| 91 | |
| 92 | struct srp_device { |
| 93 | struct list_head dev_list; |
| 94 | struct ib_device *dev; |
| 95 | struct ib_pd *pd; |
| 96 | struct ib_mr *mr; |
| 97 | struct ib_fmr_pool *fmr_pool; |
| 98 | u64 fmr_page_mask; |
| 99 | int fmr_page_size; |
| 100 | int fmr_max_size; |
| 101 | }; |
| 102 | |
| 103 | struct srp_host { |
| 104 | struct srp_device *srp_dev; |
| 105 | u8 port; |
| 106 | struct device dev; |
| 107 | struct list_head target_list; |
| 108 | spinlock_t target_lock; |
| 109 | struct completion released; |
| 110 | struct list_head list; |
| 111 | }; |
| 112 | |
| 113 | struct srp_request { |
| 114 | struct list_head list; |
| 115 | struct scsi_cmnd *scmnd; |
| 116 | struct srp_iu *cmd; |
| 117 | struct ib_pool_fmr **fmr_list; |
| 118 | u64 *map_page; |
| 119 | struct srp_direct_buf *indirect_desc; |
| 120 | dma_addr_t indirect_dma_addr; |
| 121 | short nfmr; |
| 122 | short index; |
| 123 | }; |
| 124 | |
| 125 | struct srp_target_port { |
| 126 | /* These are RW in the hot path, and commonly used together */ |
| 127 | struct list_head free_tx; |
| 128 | struct list_head free_reqs; |
| 129 | spinlock_t lock; |
| 130 | s32 req_lim; |
| 131 | |
| 132 | /* These are read-only in the hot path */ |
| 133 | struct ib_cq *send_cq ____cacheline_aligned_in_smp; |
| 134 | struct ib_cq *recv_cq; |
| 135 | struct ib_qp *qp; |
| 136 | u32 lkey; |
| 137 | u32 rkey; |
| 138 | enum srp_target_state state; |
| 139 | unsigned int max_iu_len; |
| 140 | unsigned int cmd_sg_cnt; |
| 141 | unsigned int indirect_size; |
| 142 | bool allow_ext_sg; |
| 143 | bool transport_offline; |
| 144 | |
| 145 | /* Everything above this point is used in the hot path of |
| 146 | * command processing. Try to keep them packed into cachelines. |
| 147 | */ |
| 148 | |
| 149 | __be64 id_ext; |
| 150 | __be64 ioc_guid; |
| 151 | __be64 service_id; |
| 152 | __be64 initiator_ext; |
| 153 | u16 io_class; |
| 154 | struct srp_host *srp_host; |
| 155 | struct Scsi_Host *scsi_host; |
| 156 | char target_name[32]; |
| 157 | unsigned int scsi_id; |
| 158 | unsigned int sg_tablesize; |
| 159 | |
| 160 | struct ib_sa_path_rec path; |
| 161 | __be16 orig_dgid[8]; |
| 162 | struct ib_sa_query *path_query; |
| 163 | int path_query_id; |
| 164 | |
| 165 | u32 rq_tmo_jiffies; |
| 166 | bool connected; |
| 167 | |
| 168 | struct ib_cm_id *cm_id; |
| 169 | |
| 170 | int max_ti_iu_len; |
| 171 | |
| 172 | int zero_req_lim; |
| 173 | |
| 174 | struct srp_iu *tx_ring[SRP_SQ_SIZE]; |
| 175 | struct srp_iu *rx_ring[SRP_RQ_SIZE]; |
| 176 | struct srp_request req_ring[SRP_CMD_SQ_SIZE]; |
| 177 | |
| 178 | struct work_struct remove_work; |
| 179 | |
| 180 | struct list_head list; |
| 181 | struct completion done; |
| 182 | int status; |
| 183 | bool qp_in_error; |
| 184 | |
| 185 | struct completion tsk_mgmt_done; |
| 186 | u8 tsk_mgmt_status; |
| 187 | }; |
| 188 | |
| 189 | struct srp_iu { |
| 190 | struct list_head list; |
| 191 | u64 dma; |
| 192 | void *buf; |
| 193 | size_t size; |
| 194 | enum dma_data_direction direction; |
| 195 | }; |
| 196 | |
| 197 | struct srp_map_state { |
| 198 | struct ib_pool_fmr **next_fmr; |
| 199 | struct srp_direct_buf *desc; |
| 200 | u64 *pages; |
| 201 | dma_addr_t base_dma_addr; |
| 202 | u32 fmr_len; |
| 203 | u32 total_len; |
| 204 | unsigned int npages; |
| 205 | unsigned int nfmr; |
| 206 | unsigned int ndesc; |
| 207 | struct scatterlist *unmapped_sg; |
| 208 | int unmapped_index; |
| 209 | dma_addr_t unmapped_addr; |
| 210 | }; |
| 211 | |
| 212 | #endif /* IB_SRP_H */ |