1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */ 2 3 /* Authors: Cheng Xu <chengyou@linux.alibaba.com> */ 4 /* Kai Shen <kaishen@linux.alibaba.com> */ 5 /* Copyright (c) 2020-2022, Alibaba Group. */ 6 7 #ifndef __ERDMA_VERBS_H__ 8 #define __ERDMA_VERBS_H__ 9 10 #include "erdma.h" 11 12 /* RDMA Capability. */ 13 #define ERDMA_MAX_PD (128 * 1024) 14 #define ERDMA_MAX_SEND_WR 8192 15 #define ERDMA_MAX_ORD 128 16 #define ERDMA_MAX_IRD 128 17 #define ERDMA_MAX_SGE_RD 1 18 #define ERDMA_MAX_CONTEXT (128 * 1024) 19 #define ERDMA_MAX_SEND_SGE 6 20 #define ERDMA_MAX_RECV_SGE 1 21 #define ERDMA_MAX_INLINE (sizeof(struct erdma_sge) * (ERDMA_MAX_SEND_SGE)) 22 #define ERDMA_MAX_FRMR_PA 512 23 24 enum { 25 ERDMA_MMAP_IO_NC = 0, /* no cache */ 26 }; 27 28 struct erdma_user_mmap_entry { 29 struct rdma_user_mmap_entry rdma_entry; 30 u64 address; 31 u8 mmap_flag; 32 }; 33 34 struct erdma_ext_db_info { 35 bool enable; 36 u16 sdb_off; 37 u16 rdb_off; 38 u16 cdb_off; 39 }; 40 41 struct erdma_ucontext { 42 struct ib_ucontext ibucontext; 43 44 struct erdma_ext_db_info ext_db; 45 46 u32 sdb_type; 47 u32 sdb_idx; 48 u32 sdb_page_idx; 49 u32 sdb_page_off; 50 u64 sdb; 51 u64 rdb; 52 u64 cdb; 53 54 struct rdma_user_mmap_entry *sq_db_mmap_entry; 55 struct rdma_user_mmap_entry *rq_db_mmap_entry; 56 struct rdma_user_mmap_entry *cq_db_mmap_entry; 57 58 /* doorbell records */ 59 struct list_head dbrecords_page_list; 60 struct mutex dbrecords_page_mutex; 61 }; 62 63 struct erdma_pd { 64 struct ib_pd ibpd; 65 u32 pdn; 66 }; 67 68 /* 69 * MemoryRegion definition. 70 */ 71 #define ERDMA_MAX_INLINE_MTT_ENTRIES 4 72 #define MTT_SIZE(mtt_cnt) (mtt_cnt << 3) /* per mtt takes 8 Bytes. */ 73 #define ERDMA_MR_MAX_MTT_CNT 524288 74 #define ERDMA_MTT_ENTRY_SIZE 8 75 76 #define ERDMA_MR_TYPE_NORMAL 0 77 #define ERDMA_MR_TYPE_FRMR 1 78 #define ERDMA_MR_TYPE_DMA 2 79 80 #define ERDMA_MR_INLINE_MTT 0 81 #define ERDMA_MR_INDIRECT_MTT 1 82 83 #define ERDMA_MR_ACC_RA BIT(0) 84 #define ERDMA_MR_ACC_LR BIT(1) 85 #define ERDMA_MR_ACC_LW BIT(2) 86 #define ERDMA_MR_ACC_RR BIT(3) 87 #define ERDMA_MR_ACC_RW BIT(4) 88 89 static inline u8 to_erdma_access_flags(int access) 90 { 91 return (access & IB_ACCESS_REMOTE_READ ? ERDMA_MR_ACC_RR : 0) | 92 (access & IB_ACCESS_LOCAL_WRITE ? ERDMA_MR_ACC_LW : 0) | 93 (access & IB_ACCESS_REMOTE_WRITE ? ERDMA_MR_ACC_RW : 0) | 94 (access & IB_ACCESS_REMOTE_ATOMIC ? ERDMA_MR_ACC_RA : 0); 95 } 96 97 struct erdma_mem { 98 struct ib_umem *umem; 99 void *mtt_buf; 100 u32 mtt_type; 101 u32 page_size; 102 u32 page_offset; 103 u32 page_cnt; 104 u32 mtt_nents; 105 106 u64 va; 107 u64 len; 108 109 u64 mtt_entry[ERDMA_MAX_INLINE_MTT_ENTRIES]; 110 }; 111 112 struct erdma_mr { 113 struct ib_mr ibmr; 114 struct erdma_mem mem; 115 u8 type; 116 u8 access; 117 u8 valid; 118 }; 119 120 struct erdma_user_dbrecords_page { 121 struct list_head list; 122 struct ib_umem *umem; 123 u64 va; 124 int refcnt; 125 }; 126 127 struct erdma_uqp { 128 struct erdma_mem sq_mtt; 129 struct erdma_mem rq_mtt; 130 131 dma_addr_t sq_db_info_dma_addr; 132 dma_addr_t rq_db_info_dma_addr; 133 134 struct erdma_user_dbrecords_page *user_dbr_page; 135 136 u32 rq_offset; 137 }; 138 139 struct erdma_kqp { 140 u16 sq_pi; 141 u16 sq_ci; 142 143 u16 rq_pi; 144 u16 rq_ci; 145 146 u64 *swr_tbl; 147 u64 *rwr_tbl; 148 149 void __iomem *hw_sq_db; 150 void __iomem *hw_rq_db; 151 152 void *sq_buf; 153 dma_addr_t sq_buf_dma_addr; 154 155 void *rq_buf; 156 dma_addr_t rq_buf_dma_addr; 157 158 void *sq_db_info; 159 void *rq_db_info; 160 161 u8 sig_all; 162 }; 163 164 enum erdma_qp_state { 165 ERDMA_QP_STATE_IDLE = 0, 166 ERDMA_QP_STATE_RTR = 1, 167 ERDMA_QP_STATE_RTS = 2, 168 ERDMA_QP_STATE_CLOSING = 3, 169 ERDMA_QP_STATE_TERMINATE = 4, 170 ERDMA_QP_STATE_ERROR = 5, 171 ERDMA_QP_STATE_UNDEF = 7, 172 ERDMA_QP_STATE_COUNT = 8 173 }; 174 175 enum erdma_qp_attr_mask { 176 ERDMA_QP_ATTR_STATE = (1 << 0), 177 ERDMA_QP_ATTR_LLP_HANDLE = (1 << 2), 178 ERDMA_QP_ATTR_ORD = (1 << 3), 179 ERDMA_QP_ATTR_IRD = (1 << 4), 180 ERDMA_QP_ATTR_SQ_SIZE = (1 << 5), 181 ERDMA_QP_ATTR_RQ_SIZE = (1 << 6), 182 ERDMA_QP_ATTR_MPA = (1 << 7) 183 }; 184 185 enum erdma_qp_flags { 186 ERDMA_QP_IN_FLUSHING = (1 << 0), 187 }; 188 189 struct erdma_qp_attrs { 190 enum erdma_qp_state state; 191 enum erdma_cc_alg cc; /* Congestion control algorithm */ 192 u32 sq_size; 193 u32 rq_size; 194 u32 orq_size; 195 u32 irq_size; 196 u32 max_send_sge; 197 u32 max_recv_sge; 198 u32 cookie; 199 #define ERDMA_QP_ACTIVE 0 200 #define ERDMA_QP_PASSIVE 1 201 u8 qp_type; 202 u8 pd_len; 203 }; 204 205 struct erdma_qp { 206 struct ib_qp ibqp; 207 struct kref ref; 208 struct completion safe_free; 209 struct erdma_dev *dev; 210 struct erdma_cep *cep; 211 struct rw_semaphore state_lock; 212 213 unsigned long flags; 214 struct delayed_work reflush_dwork; 215 216 union { 217 struct erdma_kqp kern_qp; 218 struct erdma_uqp user_qp; 219 }; 220 221 struct erdma_cq *scq; 222 struct erdma_cq *rcq; 223 224 struct erdma_qp_attrs attrs; 225 spinlock_t lock; 226 }; 227 228 struct erdma_kcq_info { 229 void *qbuf; 230 dma_addr_t qbuf_dma_addr; 231 u32 ci; 232 u32 cmdsn; 233 u32 notify_cnt; 234 235 spinlock_t lock; 236 u8 __iomem *db; 237 u64 *db_record; 238 }; 239 240 struct erdma_ucq_info { 241 struct erdma_mem qbuf_mtt; 242 struct erdma_user_dbrecords_page *user_dbr_page; 243 dma_addr_t db_info_dma_addr; 244 }; 245 246 struct erdma_cq { 247 struct ib_cq ibcq; 248 u32 cqn; 249 250 u32 depth; 251 u32 assoc_eqn; 252 253 union { 254 struct erdma_kcq_info kern_cq; 255 struct erdma_ucq_info user_cq; 256 }; 257 }; 258 259 #define QP_ID(qp) ((qp)->ibqp.qp_num) 260 261 static inline struct erdma_qp *find_qp_by_qpn(struct erdma_dev *dev, int id) 262 { 263 return (struct erdma_qp *)xa_load(&dev->qp_xa, id); 264 } 265 266 static inline struct erdma_cq *find_cq_by_cqn(struct erdma_dev *dev, int id) 267 { 268 return (struct erdma_cq *)xa_load(&dev->cq_xa, id); 269 } 270 271 void erdma_qp_get(struct erdma_qp *qp); 272 void erdma_qp_put(struct erdma_qp *qp); 273 int erdma_modify_qp_internal(struct erdma_qp *qp, struct erdma_qp_attrs *attrs, 274 enum erdma_qp_attr_mask mask); 275 void erdma_qp_llp_close(struct erdma_qp *qp); 276 void erdma_qp_cm_drop(struct erdma_qp *qp); 277 278 static inline struct erdma_ucontext *to_ectx(struct ib_ucontext *ibctx) 279 { 280 return container_of(ibctx, struct erdma_ucontext, ibucontext); 281 } 282 283 static inline struct erdma_pd *to_epd(struct ib_pd *pd) 284 { 285 return container_of(pd, struct erdma_pd, ibpd); 286 } 287 288 static inline struct erdma_mr *to_emr(struct ib_mr *ibmr) 289 { 290 return container_of(ibmr, struct erdma_mr, ibmr); 291 } 292 293 static inline struct erdma_qp *to_eqp(struct ib_qp *qp) 294 { 295 return container_of(qp, struct erdma_qp, ibqp); 296 } 297 298 static inline struct erdma_cq *to_ecq(struct ib_cq *ibcq) 299 { 300 return container_of(ibcq, struct erdma_cq, ibcq); 301 } 302 303 static inline struct erdma_user_mmap_entry * 304 to_emmap(struct rdma_user_mmap_entry *ibmmap) 305 { 306 return container_of(ibmmap, struct erdma_user_mmap_entry, rdma_entry); 307 } 308 309 int erdma_alloc_ucontext(struct ib_ucontext *ibctx, struct ib_udata *data); 310 void erdma_dealloc_ucontext(struct ib_ucontext *ibctx); 311 int erdma_query_device(struct ib_device *dev, struct ib_device_attr *attr, 312 struct ib_udata *data); 313 int erdma_get_port_immutable(struct ib_device *dev, u32 port, 314 struct ib_port_immutable *ib_port_immutable); 315 int erdma_create_cq(struct ib_cq *ibcq, const struct ib_cq_init_attr *attr, 316 struct ib_udata *data); 317 int erdma_query_port(struct ib_device *dev, u32 port, 318 struct ib_port_attr *attr); 319 int erdma_query_gid(struct ib_device *dev, u32 port, int idx, 320 union ib_gid *gid); 321 int erdma_alloc_pd(struct ib_pd *ibpd, struct ib_udata *data); 322 int erdma_dealloc_pd(struct ib_pd *ibpd, struct ib_udata *udata); 323 int erdma_create_qp(struct ib_qp *ibqp, struct ib_qp_init_attr *attr, 324 struct ib_udata *data); 325 int erdma_query_qp(struct ib_qp *ibqp, struct ib_qp_attr *attr, int mask, 326 struct ib_qp_init_attr *init_attr); 327 int erdma_modify_qp(struct ib_qp *ibqp, struct ib_qp_attr *attr, int mask, 328 struct ib_udata *data); 329 int erdma_destroy_qp(struct ib_qp *ibqp, struct ib_udata *udata); 330 int erdma_destroy_cq(struct ib_cq *ibcq, struct ib_udata *udata); 331 int erdma_req_notify_cq(struct ib_cq *ibcq, enum ib_cq_notify_flags flags); 332 struct ib_mr *erdma_reg_user_mr(struct ib_pd *ibpd, u64 start, u64 len, 333 u64 virt, int access, struct ib_udata *udata); 334 struct ib_mr *erdma_get_dma_mr(struct ib_pd *ibpd, int rights); 335 int erdma_dereg_mr(struct ib_mr *ibmr, struct ib_udata *data); 336 int erdma_mmap(struct ib_ucontext *ctx, struct vm_area_struct *vma); 337 void erdma_mmap_free(struct rdma_user_mmap_entry *rdma_entry); 338 void erdma_qp_get_ref(struct ib_qp *ibqp); 339 void erdma_qp_put_ref(struct ib_qp *ibqp); 340 struct ib_qp *erdma_get_ibqp(struct ib_device *dev, int id); 341 int erdma_post_send(struct ib_qp *ibqp, const struct ib_send_wr *send_wr, 342 const struct ib_send_wr **bad_send_wr); 343 int erdma_post_recv(struct ib_qp *ibqp, const struct ib_recv_wr *recv_wr, 344 const struct ib_recv_wr **bad_recv_wr); 345 int erdma_poll_cq(struct ib_cq *ibcq, int num_entries, struct ib_wc *wc); 346 struct ib_mr *erdma_ib_alloc_mr(struct ib_pd *ibpd, enum ib_mr_type mr_type, 347 u32 max_num_sg); 348 int erdma_map_mr_sg(struct ib_mr *ibmr, struct scatterlist *sg, int sg_nents, 349 unsigned int *sg_offset); 350 void erdma_port_event(struct erdma_dev *dev, enum ib_event_type reason); 351 void erdma_set_mtu(struct erdma_dev *dev, u32 mtu); 352 353 #endif 354