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