Linux Audio

Check our new training course

Loading...
Note: File does not exist in v3.1.
  1/* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) */
  2/*
  3 * Copyright (c) 2012-2016 VMware, Inc.  All rights reserved.
  4 *
  5 * This program is free software; you can redistribute it and/or
  6 * modify it under the terms of EITHER the GNU General Public License
  7 * version 2 as published by the Free Software Foundation or the BSD
  8 * 2-Clause License. This program is distributed in the hope that it
  9 * will be useful, but WITHOUT ANY WARRANTY; WITHOUT EVEN THE IMPLIED
 10 * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
 11 * See the GNU General Public License version 2 for more details at
 12 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html.
 13 *
 14 * You should have received a copy of the GNU General Public License
 15 * along with this program available in the file COPYING in the main
 16 * directory of this source tree.
 17 *
 18 * The BSD 2-Clause License
 19 *
 20 *     Redistribution and use in source and binary forms, with or
 21 *     without modification, are permitted provided that the following
 22 *     conditions are met:
 23 *
 24 *      - Redistributions of source code must retain the above
 25 *        copyright notice, this list of conditions and the following
 26 *        disclaimer.
 27 *
 28 *      - Redistributions in binary form must reproduce the above
 29 *        copyright notice, this list of conditions and the following
 30 *        disclaimer in the documentation and/or other materials
 31 *        provided with the distribution.
 32 *
 33 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 34 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 35 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 36 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 37 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 38 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 39 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 40 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 41 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 42 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 43 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 44 * OF THE POSSIBILITY OF SUCH DAMAGE.
 45 */
 46
 47#ifndef __VMW_PVRDMA_ABI_H__
 48#define __VMW_PVRDMA_ABI_H__
 49
 50#include <linux/types.h>
 51
 52#define PVRDMA_UVERBS_ABI_VERSION	3		/* ABI Version. */
 53#define PVRDMA_UAR_HANDLE_MASK		0x00FFFFFF	/* Bottom 24 bits. */
 54#define PVRDMA_UAR_QP_OFFSET		0		/* QP doorbell. */
 55#define PVRDMA_UAR_QP_SEND		(1 << 30)	/* Send bit. */
 56#define PVRDMA_UAR_QP_RECV		(1 << 31)	/* Recv bit. */
 57#define PVRDMA_UAR_CQ_OFFSET		4		/* CQ doorbell. */
 58#define PVRDMA_UAR_CQ_ARM_SOL		(1 << 29)	/* Arm solicited bit. */
 59#define PVRDMA_UAR_CQ_ARM		(1 << 30)	/* Arm bit. */
 60#define PVRDMA_UAR_CQ_POLL		(1 << 31)	/* Poll bit. */
 61#define PVRDMA_UAR_SRQ_OFFSET		8		/* SRQ doorbell. */
 62#define PVRDMA_UAR_SRQ_RECV		(1 << 30)	/* Recv bit. */
 63
 64enum pvrdma_wr_opcode {
 65	PVRDMA_WR_RDMA_WRITE,
 66	PVRDMA_WR_RDMA_WRITE_WITH_IMM,
 67	PVRDMA_WR_SEND,
 68	PVRDMA_WR_SEND_WITH_IMM,
 69	PVRDMA_WR_RDMA_READ,
 70	PVRDMA_WR_ATOMIC_CMP_AND_SWP,
 71	PVRDMA_WR_ATOMIC_FETCH_AND_ADD,
 72	PVRDMA_WR_LSO,
 73	PVRDMA_WR_SEND_WITH_INV,
 74	PVRDMA_WR_RDMA_READ_WITH_INV,
 75	PVRDMA_WR_LOCAL_INV,
 76	PVRDMA_WR_FAST_REG_MR,
 77	PVRDMA_WR_MASKED_ATOMIC_CMP_AND_SWP,
 78	PVRDMA_WR_MASKED_ATOMIC_FETCH_AND_ADD,
 79	PVRDMA_WR_BIND_MW,
 80	PVRDMA_WR_REG_SIG_MR,
 81};
 82
 83enum pvrdma_wc_status {
 84	PVRDMA_WC_SUCCESS,
 85	PVRDMA_WC_LOC_LEN_ERR,
 86	PVRDMA_WC_LOC_QP_OP_ERR,
 87	PVRDMA_WC_LOC_EEC_OP_ERR,
 88	PVRDMA_WC_LOC_PROT_ERR,
 89	PVRDMA_WC_WR_FLUSH_ERR,
 90	PVRDMA_WC_MW_BIND_ERR,
 91	PVRDMA_WC_BAD_RESP_ERR,
 92	PVRDMA_WC_LOC_ACCESS_ERR,
 93	PVRDMA_WC_REM_INV_REQ_ERR,
 94	PVRDMA_WC_REM_ACCESS_ERR,
 95	PVRDMA_WC_REM_OP_ERR,
 96	PVRDMA_WC_RETRY_EXC_ERR,
 97	PVRDMA_WC_RNR_RETRY_EXC_ERR,
 98	PVRDMA_WC_LOC_RDD_VIOL_ERR,
 99	PVRDMA_WC_REM_INV_RD_REQ_ERR,
100	PVRDMA_WC_REM_ABORT_ERR,
101	PVRDMA_WC_INV_EECN_ERR,
102	PVRDMA_WC_INV_EEC_STATE_ERR,
103	PVRDMA_WC_FATAL_ERR,
104	PVRDMA_WC_RESP_TIMEOUT_ERR,
105	PVRDMA_WC_GENERAL_ERR,
106};
107
108enum pvrdma_wc_opcode {
109	PVRDMA_WC_SEND,
110	PVRDMA_WC_RDMA_WRITE,
111	PVRDMA_WC_RDMA_READ,
112	PVRDMA_WC_COMP_SWAP,
113	PVRDMA_WC_FETCH_ADD,
114	PVRDMA_WC_BIND_MW,
115	PVRDMA_WC_LSO,
116	PVRDMA_WC_LOCAL_INV,
117	PVRDMA_WC_FAST_REG_MR,
118	PVRDMA_WC_MASKED_COMP_SWAP,
119	PVRDMA_WC_MASKED_FETCH_ADD,
120	PVRDMA_WC_RECV = 1 << 7,
121	PVRDMA_WC_RECV_RDMA_WITH_IMM,
122};
123
124enum pvrdma_wc_flags {
125	PVRDMA_WC_GRH			= 1 << 0,
126	PVRDMA_WC_WITH_IMM		= 1 << 1,
127	PVRDMA_WC_WITH_INVALIDATE	= 1 << 2,
128	PVRDMA_WC_IP_CSUM_OK		= 1 << 3,
129	PVRDMA_WC_WITH_SMAC		= 1 << 4,
130	PVRDMA_WC_WITH_VLAN		= 1 << 5,
131	PVRDMA_WC_WITH_NETWORK_HDR_TYPE	= 1 << 6,
132	PVRDMA_WC_FLAGS_MAX		= PVRDMA_WC_WITH_NETWORK_HDR_TYPE,
133};
134
135struct pvrdma_alloc_ucontext_resp {
136	__u32 qp_tab_size;
137	__u32 reserved;
138};
139
140struct pvrdma_alloc_pd_resp {
141	__u32 pdn;
142	__u32 reserved;
143};
144
145struct pvrdma_create_cq {
146	__aligned_u64 buf_addr;
147	__u32 buf_size;
148	__u32 reserved;
149};
150
151struct pvrdma_create_cq_resp {
152	__u32 cqn;
153	__u32 reserved;
154};
155
156struct pvrdma_resize_cq {
157	__aligned_u64 buf_addr;
158	__u32 buf_size;
159	__u32 reserved;
160};
161
162struct pvrdma_create_srq {
163	__aligned_u64 buf_addr;
164	__u32 buf_size;
165	__u32 reserved;
166};
167
168struct pvrdma_create_srq_resp {
169	__u32 srqn;
170	__u32 reserved;
171};
172
173struct pvrdma_create_qp {
174	__aligned_u64 rbuf_addr;
175	__aligned_u64 sbuf_addr;
176	__u32 rbuf_size;
177	__u32 sbuf_size;
178	__aligned_u64 qp_addr;
179};
180
181/* PVRDMA masked atomic compare and swap */
182struct pvrdma_ex_cmp_swap {
183	__aligned_u64 swap_val;
184	__aligned_u64 compare_val;
185	__aligned_u64 swap_mask;
186	__aligned_u64 compare_mask;
187};
188
189/* PVRDMA masked atomic fetch and add */
190struct pvrdma_ex_fetch_add {
191	__aligned_u64 add_val;
192	__aligned_u64 field_boundary;
193};
194
195/* PVRDMA address vector. */
196struct pvrdma_av {
197	__u32 port_pd;
198	__u32 sl_tclass_flowlabel;
199	__u8 dgid[16];
200	__u8 src_path_bits;
201	__u8 gid_index;
202	__u8 stat_rate;
203	__u8 hop_limit;
204	__u8 dmac[6];
205	__u8 reserved[6];
206};
207
208/* PVRDMA scatter/gather entry */
209struct pvrdma_sge {
210	__aligned_u64 addr;
211	__u32   length;
212	__u32   lkey;
213};
214
215/* PVRDMA receive queue work request */
216struct pvrdma_rq_wqe_hdr {
217	__aligned_u64 wr_id;		/* wr id */
218	__u32 num_sge;		/* size of s/g array */
219	__u32 total_len;	/* reserved */
220};
221/* Use pvrdma_sge (ib_sge) for receive queue s/g array elements. */
222
223/* PVRDMA send queue work request */
224struct pvrdma_sq_wqe_hdr {
225	__aligned_u64 wr_id;		/* wr id */
226	__u32 num_sge;		/* size of s/g array */
227	__u32 total_len;	/* reserved */
228	__u32 opcode;		/* operation type */
229	__u32 send_flags;	/* wr flags */
230	union {
231		__be32 imm_data;
232		__u32 invalidate_rkey;
233	} ex;
234	__u32 reserved;
235	union {
236		struct {
237			__aligned_u64 remote_addr;
238			__u32 rkey;
239			__u8 reserved[4];
240		} rdma;
241		struct {
242			__aligned_u64 remote_addr;
243			__aligned_u64 compare_add;
244			__aligned_u64 swap;
245			__u32 rkey;
246			__u32 reserved;
247		} atomic;
248		struct {
249			__aligned_u64 remote_addr;
250			__u32 log_arg_sz;
251			__u32 rkey;
252			union {
253				struct pvrdma_ex_cmp_swap  cmp_swap;
254				struct pvrdma_ex_fetch_add fetch_add;
255			} wr_data;
256		} masked_atomics;
257		struct {
258			__aligned_u64 iova_start;
259			__aligned_u64 pl_pdir_dma;
260			__u32 page_shift;
261			__u32 page_list_len;
262			__u32 length;
263			__u32 access_flags;
264			__u32 rkey;
265			__u32 reserved;
266		} fast_reg;
267		struct {
268			__u32 remote_qpn;
269			__u32 remote_qkey;
270			struct pvrdma_av av;
271		} ud;
272	} wr;
273};
274/* Use pvrdma_sge (ib_sge) for send queue s/g array elements. */
275
276/* Completion queue element. */
277struct pvrdma_cqe {
278	__aligned_u64 wr_id;
279	__aligned_u64 qp;
280	__u32 opcode;
281	__u32 status;
282	__u32 byte_len;
283	__be32 imm_data;
284	__u32 src_qp;
285	__u32 wc_flags;
286	__u32 vendor_err;
287	__u16 pkey_index;
288	__u16 slid;
289	__u8 sl;
290	__u8 dlid_path_bits;
291	__u8 port_num;
292	__u8 smac[6];
293	__u8 network_hdr_type;
294	__u8 reserved2[6]; /* Pad to next power of 2 (64). */
295};
296
297#endif /* __VMW_PVRDMA_ABI_H__ */