1*4882a593Smuzhiyun /* SPDX-License-Identifier: (GPL-2.0 WITH Linux-syscall-note) or BSD-3-Clause */ 2*4882a593Smuzhiyun 3*4882a593Smuzhiyun /* Authors: Bernard Metzler <bmt@zurich.ibm.com> */ 4*4882a593Smuzhiyun /* Copyright (c) 2008-2019, IBM Corporation */ 5*4882a593Smuzhiyun 6*4882a593Smuzhiyun #ifndef _SIW_USER_H 7*4882a593Smuzhiyun #define _SIW_USER_H 8*4882a593Smuzhiyun 9*4882a593Smuzhiyun #include <linux/types.h> 10*4882a593Smuzhiyun 11*4882a593Smuzhiyun #define SIW_NODE_DESC_COMMON "Software iWARP stack" 12*4882a593Smuzhiyun #define SIW_ABI_VERSION 1 13*4882a593Smuzhiyun #define SIW_MAX_SGE 6 14*4882a593Smuzhiyun #define SIW_UOBJ_MAX_KEY 0x08FFFF 15*4882a593Smuzhiyun #define SIW_INVAL_UOBJ_KEY (SIW_UOBJ_MAX_KEY + 1) 16*4882a593Smuzhiyun 17*4882a593Smuzhiyun struct siw_uresp_create_cq { 18*4882a593Smuzhiyun __u32 cq_id; 19*4882a593Smuzhiyun __u32 num_cqe; 20*4882a593Smuzhiyun __aligned_u64 cq_key; 21*4882a593Smuzhiyun }; 22*4882a593Smuzhiyun 23*4882a593Smuzhiyun struct siw_uresp_create_qp { 24*4882a593Smuzhiyun __u32 qp_id; 25*4882a593Smuzhiyun __u32 num_sqe; 26*4882a593Smuzhiyun __u32 num_rqe; 27*4882a593Smuzhiyun __u32 pad; 28*4882a593Smuzhiyun __aligned_u64 sq_key; 29*4882a593Smuzhiyun __aligned_u64 rq_key; 30*4882a593Smuzhiyun }; 31*4882a593Smuzhiyun 32*4882a593Smuzhiyun struct siw_ureq_reg_mr { 33*4882a593Smuzhiyun __u8 stag_key; 34*4882a593Smuzhiyun __u8 reserved[3]; 35*4882a593Smuzhiyun __u32 pad; 36*4882a593Smuzhiyun }; 37*4882a593Smuzhiyun 38*4882a593Smuzhiyun struct siw_uresp_reg_mr { 39*4882a593Smuzhiyun __u32 stag; 40*4882a593Smuzhiyun __u32 pad; 41*4882a593Smuzhiyun }; 42*4882a593Smuzhiyun 43*4882a593Smuzhiyun struct siw_uresp_create_srq { 44*4882a593Smuzhiyun __u32 num_rqe; 45*4882a593Smuzhiyun __u32 pad; 46*4882a593Smuzhiyun __aligned_u64 srq_key; 47*4882a593Smuzhiyun }; 48*4882a593Smuzhiyun 49*4882a593Smuzhiyun struct siw_uresp_alloc_ctx { 50*4882a593Smuzhiyun __u32 dev_id; 51*4882a593Smuzhiyun __u32 pad; 52*4882a593Smuzhiyun }; 53*4882a593Smuzhiyun 54*4882a593Smuzhiyun enum siw_opcode { 55*4882a593Smuzhiyun SIW_OP_WRITE, 56*4882a593Smuzhiyun SIW_OP_READ, 57*4882a593Smuzhiyun SIW_OP_READ_LOCAL_INV, 58*4882a593Smuzhiyun SIW_OP_SEND, 59*4882a593Smuzhiyun SIW_OP_SEND_WITH_IMM, 60*4882a593Smuzhiyun SIW_OP_SEND_REMOTE_INV, 61*4882a593Smuzhiyun 62*4882a593Smuzhiyun /* Unsupported */ 63*4882a593Smuzhiyun SIW_OP_FETCH_AND_ADD, 64*4882a593Smuzhiyun SIW_OP_COMP_AND_SWAP, 65*4882a593Smuzhiyun 66*4882a593Smuzhiyun SIW_OP_RECEIVE, 67*4882a593Smuzhiyun /* provider internal SQE */ 68*4882a593Smuzhiyun SIW_OP_READ_RESPONSE, 69*4882a593Smuzhiyun /* 70*4882a593Smuzhiyun * below opcodes valid for 71*4882a593Smuzhiyun * in-kernel clients only 72*4882a593Smuzhiyun */ 73*4882a593Smuzhiyun SIW_OP_INVAL_STAG, 74*4882a593Smuzhiyun SIW_OP_REG_MR, 75*4882a593Smuzhiyun SIW_NUM_OPCODES 76*4882a593Smuzhiyun }; 77*4882a593Smuzhiyun 78*4882a593Smuzhiyun /* Keep it same as ibv_sge to allow for memcpy */ 79*4882a593Smuzhiyun struct siw_sge { 80*4882a593Smuzhiyun __aligned_u64 laddr; 81*4882a593Smuzhiyun __u32 length; 82*4882a593Smuzhiyun __u32 lkey; 83*4882a593Smuzhiyun }; 84*4882a593Smuzhiyun 85*4882a593Smuzhiyun /* 86*4882a593Smuzhiyun * Inline data are kept within the work request itself occupying 87*4882a593Smuzhiyun * the space of sge[1] .. sge[n]. Therefore, inline data cannot be 88*4882a593Smuzhiyun * supported if SIW_MAX_SGE is below 2 elements. 89*4882a593Smuzhiyun */ 90*4882a593Smuzhiyun #define SIW_MAX_INLINE (sizeof(struct siw_sge) * (SIW_MAX_SGE - 1)) 91*4882a593Smuzhiyun 92*4882a593Smuzhiyun #if SIW_MAX_SGE < 2 93*4882a593Smuzhiyun #error "SIW_MAX_SGE must be at least 2" 94*4882a593Smuzhiyun #endif 95*4882a593Smuzhiyun 96*4882a593Smuzhiyun enum siw_wqe_flags { 97*4882a593Smuzhiyun SIW_WQE_VALID = 1, 98*4882a593Smuzhiyun SIW_WQE_INLINE = (1 << 1), 99*4882a593Smuzhiyun SIW_WQE_SIGNALLED = (1 << 2), 100*4882a593Smuzhiyun SIW_WQE_SOLICITED = (1 << 3), 101*4882a593Smuzhiyun SIW_WQE_READ_FENCE = (1 << 4), 102*4882a593Smuzhiyun SIW_WQE_REM_INVAL = (1 << 5), 103*4882a593Smuzhiyun SIW_WQE_COMPLETED = (1 << 6) 104*4882a593Smuzhiyun }; 105*4882a593Smuzhiyun 106*4882a593Smuzhiyun /* Send Queue Element */ 107*4882a593Smuzhiyun struct siw_sqe { 108*4882a593Smuzhiyun __aligned_u64 id; 109*4882a593Smuzhiyun __u16 flags; 110*4882a593Smuzhiyun __u8 num_sge; 111*4882a593Smuzhiyun /* Contains enum siw_opcode values */ 112*4882a593Smuzhiyun __u8 opcode; 113*4882a593Smuzhiyun __u32 rkey; 114*4882a593Smuzhiyun union { 115*4882a593Smuzhiyun __aligned_u64 raddr; 116*4882a593Smuzhiyun __aligned_u64 base_mr; 117*4882a593Smuzhiyun }; 118*4882a593Smuzhiyun union { 119*4882a593Smuzhiyun struct siw_sge sge[SIW_MAX_SGE]; 120*4882a593Smuzhiyun __aligned_u64 access; 121*4882a593Smuzhiyun }; 122*4882a593Smuzhiyun }; 123*4882a593Smuzhiyun 124*4882a593Smuzhiyun /* Receive Queue Element */ 125*4882a593Smuzhiyun struct siw_rqe { 126*4882a593Smuzhiyun __aligned_u64 id; 127*4882a593Smuzhiyun __u16 flags; 128*4882a593Smuzhiyun __u8 num_sge; 129*4882a593Smuzhiyun /* 130*4882a593Smuzhiyun * only used by kernel driver, 131*4882a593Smuzhiyun * ignored if set by user 132*4882a593Smuzhiyun */ 133*4882a593Smuzhiyun __u8 opcode; 134*4882a593Smuzhiyun __u32 unused; 135*4882a593Smuzhiyun struct siw_sge sge[SIW_MAX_SGE]; 136*4882a593Smuzhiyun }; 137*4882a593Smuzhiyun 138*4882a593Smuzhiyun enum siw_notify_flags { 139*4882a593Smuzhiyun SIW_NOTIFY_NOT = (0), 140*4882a593Smuzhiyun SIW_NOTIFY_SOLICITED = (1 << 0), 141*4882a593Smuzhiyun SIW_NOTIFY_NEXT_COMPLETION = (1 << 1), 142*4882a593Smuzhiyun SIW_NOTIFY_MISSED_EVENTS = (1 << 2), 143*4882a593Smuzhiyun SIW_NOTIFY_ALL = SIW_NOTIFY_SOLICITED | SIW_NOTIFY_NEXT_COMPLETION | 144*4882a593Smuzhiyun SIW_NOTIFY_MISSED_EVENTS 145*4882a593Smuzhiyun }; 146*4882a593Smuzhiyun 147*4882a593Smuzhiyun enum siw_wc_status { 148*4882a593Smuzhiyun SIW_WC_SUCCESS, 149*4882a593Smuzhiyun SIW_WC_LOC_LEN_ERR, 150*4882a593Smuzhiyun SIW_WC_LOC_PROT_ERR, 151*4882a593Smuzhiyun SIW_WC_LOC_QP_OP_ERR, 152*4882a593Smuzhiyun SIW_WC_WR_FLUSH_ERR, 153*4882a593Smuzhiyun SIW_WC_BAD_RESP_ERR, 154*4882a593Smuzhiyun SIW_WC_LOC_ACCESS_ERR, 155*4882a593Smuzhiyun SIW_WC_REM_ACCESS_ERR, 156*4882a593Smuzhiyun SIW_WC_REM_INV_REQ_ERR, 157*4882a593Smuzhiyun SIW_WC_GENERAL_ERR, 158*4882a593Smuzhiyun SIW_NUM_WC_STATUS 159*4882a593Smuzhiyun }; 160*4882a593Smuzhiyun 161*4882a593Smuzhiyun struct siw_cqe { 162*4882a593Smuzhiyun __aligned_u64 id; 163*4882a593Smuzhiyun __u8 flags; 164*4882a593Smuzhiyun __u8 opcode; 165*4882a593Smuzhiyun __u16 status; 166*4882a593Smuzhiyun __u32 bytes; 167*4882a593Smuzhiyun union { 168*4882a593Smuzhiyun __aligned_u64 imm_data; 169*4882a593Smuzhiyun __u32 inval_stag; 170*4882a593Smuzhiyun }; 171*4882a593Smuzhiyun /* QP number or QP pointer */ 172*4882a593Smuzhiyun union { 173*4882a593Smuzhiyun struct ib_qp *base_qp; 174*4882a593Smuzhiyun __aligned_u64 qp_id; 175*4882a593Smuzhiyun }; 176*4882a593Smuzhiyun }; 177*4882a593Smuzhiyun 178*4882a593Smuzhiyun /* 179*4882a593Smuzhiyun * Shared structure between user and kernel 180*4882a593Smuzhiyun * to control CQ arming. 181*4882a593Smuzhiyun */ 182*4882a593Smuzhiyun struct siw_cq_ctrl { 183*4882a593Smuzhiyun __u32 flags; 184*4882a593Smuzhiyun __u32 pad; 185*4882a593Smuzhiyun }; 186*4882a593Smuzhiyun #endif 187