2 * Copyright (c) 2005 Topspin Communications. All rights reserved.
3 * Copyright (c) 2005, 2006 Cisco Systems. All rights reserved.
4 * Copyright (c) 2005 PathScale, Inc. All rights reserved.
5 * Copyright (c) 2006 Mellanox Technologies. All rights reserved.
7 * This software is available to you under a choice of one of two
8 * licenses. You may choose to be licensed under the terms of the GNU
9 * General Public License (GPL) Version 2, available from the file
10 * COPYING in the main directory of this source tree, or the
11 * OpenIB.org BSD license below:
13 * Redistribution and use in source and binary forms, with or
14 * without modification, are permitted provided that the following
17 * - Redistributions of source code must retain the above
18 * copyright notice, this list of conditions and the following
21 * - Redistributions in binary form must reproduce the above
22 * copyright notice, this list of conditions and the following
23 * disclaimer in the documentation and/or other materials
24 * provided with the distribution.
26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
27 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
29 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
30 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
31 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
32 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
36 #ifndef IB_USER_VERBS_H
37 #define IB_USER_VERBS_H
39 #include <linux/types.h>
42 * Increment this value if any changes that break userspace ABI
43 * compatibility are made.
45 #define IB_USER_VERBS_ABI_VERSION 6
46 #define IB_USER_VERBS_CMD_THRESHOLD 50
49 IB_USER_VERBS_CMD_GET_CONTEXT,
50 IB_USER_VERBS_CMD_QUERY_DEVICE,
51 IB_USER_VERBS_CMD_QUERY_PORT,
52 IB_USER_VERBS_CMD_ALLOC_PD,
53 IB_USER_VERBS_CMD_DEALLOC_PD,
54 IB_USER_VERBS_CMD_CREATE_AH,
55 IB_USER_VERBS_CMD_MODIFY_AH,
56 IB_USER_VERBS_CMD_QUERY_AH,
57 IB_USER_VERBS_CMD_DESTROY_AH,
58 IB_USER_VERBS_CMD_REG_MR,
59 IB_USER_VERBS_CMD_REG_SMR,
60 IB_USER_VERBS_CMD_REREG_MR,
61 IB_USER_VERBS_CMD_QUERY_MR,
62 IB_USER_VERBS_CMD_DEREG_MR,
63 IB_USER_VERBS_CMD_ALLOC_MW,
64 IB_USER_VERBS_CMD_BIND_MW,
65 IB_USER_VERBS_CMD_DEALLOC_MW,
66 IB_USER_VERBS_CMD_CREATE_COMP_CHANNEL,
67 IB_USER_VERBS_CMD_CREATE_CQ,
68 IB_USER_VERBS_CMD_RESIZE_CQ,
69 IB_USER_VERBS_CMD_DESTROY_CQ,
70 IB_USER_VERBS_CMD_POLL_CQ,
71 IB_USER_VERBS_CMD_PEEK_CQ,
72 IB_USER_VERBS_CMD_REQ_NOTIFY_CQ,
73 IB_USER_VERBS_CMD_CREATE_QP,
74 IB_USER_VERBS_CMD_QUERY_QP,
75 IB_USER_VERBS_CMD_MODIFY_QP,
76 IB_USER_VERBS_CMD_DESTROY_QP,
77 IB_USER_VERBS_CMD_POST_SEND,
78 IB_USER_VERBS_CMD_POST_RECV,
79 IB_USER_VERBS_CMD_ATTACH_MCAST,
80 IB_USER_VERBS_CMD_DETACH_MCAST,
81 IB_USER_VERBS_CMD_CREATE_SRQ,
82 IB_USER_VERBS_CMD_MODIFY_SRQ,
83 IB_USER_VERBS_CMD_QUERY_SRQ,
84 IB_USER_VERBS_CMD_DESTROY_SRQ,
85 IB_USER_VERBS_CMD_POST_SRQ_RECV,
86 IB_USER_VERBS_CMD_OPEN_XRCD,
87 IB_USER_VERBS_CMD_CLOSE_XRCD,
88 IB_USER_VERBS_CMD_CREATE_XSRQ,
89 IB_USER_VERBS_CMD_OPEN_QP,
93 IB_USER_VERBS_EX_CMD_QUERY_DEVICE = IB_USER_VERBS_CMD_QUERY_DEVICE,
94 IB_USER_VERBS_EX_CMD_CREATE_FLOW = IB_USER_VERBS_CMD_THRESHOLD,
95 IB_USER_VERBS_EX_CMD_DESTROY_FLOW,
99 * Make sure that all structs defined in this file remain laid out so
100 * that they pack the same way on 32-bit and 64-bit architectures (to
101 * avoid incompatibility between 32-bit userspace and 64-bit kernels).
103 * - Do not use pointer types -- pass pointers in __u64 instead.
104 * - Make sure that any structure larger than 4 bytes is padded to a
105 * multiple of 8 bytes. Otherwise the structure size will be
106 * different between 32-bit and 64-bit architectures.
109 struct ib_uverbs_async_event_desc {
111 __u32 event_type; /* enum ib_event_type */
115 struct ib_uverbs_comp_event_desc {
120 * All commands from userspace should start with a __u32 command field
121 * followed by __u16 in_words and out_words fields (which give the
122 * length of the command block and response buffer if any in 32-bit
123 * words). The kernel driver will read these fields first and read
124 * the rest of the command struct based on these value.
127 #define IB_USER_VERBS_CMD_COMMAND_MASK 0xff
128 #define IB_USER_VERBS_CMD_FLAGS_MASK 0xff000000u
129 #define IB_USER_VERBS_CMD_FLAGS_SHIFT 24
131 #define IB_USER_VERBS_CMD_FLAG_EXTENDED 0x80
133 struct ib_uverbs_cmd_hdr {
139 struct ib_uverbs_ex_cmd_hdr {
141 __u16 provider_in_words;
142 __u16 provider_out_words;
143 __u32 cmd_hdr_reserved;
146 struct ib_uverbs_get_context {
148 __u64 driver_data[0];
151 struct ib_uverbs_get_context_resp {
153 __u32 num_comp_vectors;
156 struct ib_uverbs_query_device {
158 __u64 driver_data[0];
161 struct ib_uverbs_query_device_resp {
164 __be64 sys_image_guid;
168 __u32 vendor_part_id;
172 __u32 device_cap_flags;
179 __u32 max_qp_rd_atom;
180 __u32 max_ee_rd_atom;
181 __u32 max_res_rd_atom;
182 __u32 max_qp_init_rd_atom;
183 __u32 max_ee_init_rd_atom;
188 __u32 max_raw_ipv6_qp;
189 __u32 max_raw_ethy_qp;
191 __u32 max_mcast_qp_attach;
192 __u32 max_total_mcast_qp_attach;
195 __u32 max_map_per_fmr;
200 __u8 local_ca_ack_delay;
205 struct ib_uverbs_ex_query_device {
210 struct ib_uverbs_odp_caps {
216 } per_transport_caps;
220 struct ib_uverbs_ex_query_device_resp {
221 struct ib_uverbs_query_device_resp base;
223 __u32 response_length;
224 struct ib_uverbs_odp_caps odp_caps;
227 struct ib_uverbs_query_port {
231 __u64 driver_data[0];
234 struct ib_uverbs_query_port_resp {
235 __u32 port_cap_flags;
238 __u32 qkey_viol_cntr;
250 __u8 init_type_reply;
258 struct ib_uverbs_alloc_pd {
260 __u64 driver_data[0];
263 struct ib_uverbs_alloc_pd_resp {
267 struct ib_uverbs_dealloc_pd {
271 struct ib_uverbs_open_xrcd {
275 __u64 driver_data[0];
278 struct ib_uverbs_open_xrcd_resp {
282 struct ib_uverbs_close_xrcd {
286 struct ib_uverbs_reg_mr {
293 __u64 driver_data[0];
296 struct ib_uverbs_reg_mr_resp {
302 struct ib_uverbs_rereg_mr {
313 struct ib_uverbs_rereg_mr_resp {
318 struct ib_uverbs_dereg_mr {
322 struct ib_uverbs_alloc_mw {
329 struct ib_uverbs_alloc_mw_resp {
334 struct ib_uverbs_dealloc_mw {
338 struct ib_uverbs_create_comp_channel {
342 struct ib_uverbs_create_comp_channel_resp {
346 struct ib_uverbs_create_cq {
353 __u64 driver_data[0];
356 struct ib_uverbs_create_cq_resp {
361 struct ib_uverbs_resize_cq {
365 __u64 driver_data[0];
368 struct ib_uverbs_resize_cq_resp {
371 __u64 driver_data[0];
374 struct ib_uverbs_poll_cq {
380 struct ib_uverbs_wc {
388 __u32 invalidate_rkey;
401 struct ib_uverbs_poll_cq_resp {
404 struct ib_uverbs_wc wc[0];
407 struct ib_uverbs_req_notify_cq {
409 __u32 solicited_only;
412 struct ib_uverbs_destroy_cq {
418 struct ib_uverbs_destroy_cq_resp {
419 __u32 comp_events_reported;
420 __u32 async_events_reported;
423 struct ib_uverbs_global_route {
432 struct ib_uverbs_ah_attr {
433 struct ib_uverbs_global_route grh;
443 struct ib_uverbs_qp_attr {
448 __u32 path_mig_state;
453 __u32 qp_access_flags;
455 struct ib_uverbs_ah_attr ah_attr;
456 struct ib_uverbs_ah_attr alt_ah_attr;
463 __u32 max_inline_data;
466 __u16 alt_pkey_index;
467 __u8 en_sqd_async_notify;
470 __u8 max_dest_rd_atomic;
481 struct ib_uverbs_create_qp {
485 __u32 send_cq_handle;
486 __u32 recv_cq_handle;
492 __u32 max_inline_data;
497 __u64 driver_data[0];
500 struct ib_uverbs_open_qp {
507 __u64 driver_data[0];
510 /* also used for open response */
511 struct ib_uverbs_create_qp_resp {
518 __u32 max_inline_data;
523 * This struct needs to remain a multiple of 8 bytes to keep the
524 * alignment of the modify QP parameters.
526 struct ib_uverbs_qp_dest {
541 struct ib_uverbs_query_qp {
545 __u64 driver_data[0];
548 struct ib_uverbs_query_qp_resp {
549 struct ib_uverbs_qp_dest dest;
550 struct ib_uverbs_qp_dest alt_dest;
555 __u32 max_inline_data;
560 __u32 qp_access_flags;
562 __u16 alt_pkey_index;
569 __u8 max_dest_rd_atomic;
579 __u64 driver_data[0];
582 struct ib_uverbs_modify_qp {
583 struct ib_uverbs_qp_dest dest;
584 struct ib_uverbs_qp_dest alt_dest;
591 __u32 qp_access_flags;
593 __u16 alt_pkey_index;
598 __u8 en_sqd_async_notify;
600 __u8 max_dest_rd_atomic;
609 __u64 driver_data[0];
612 struct ib_uverbs_modify_qp_resp {
615 struct ib_uverbs_destroy_qp {
621 struct ib_uverbs_destroy_qp_resp {
622 __u32 events_reported;
626 * The ib_uverbs_sge structure isn't used anywhere, since we assume
627 * the ib_sge structure is packed the same way on 32-bit and 64-bit
628 * architectures in both kernel and user space. It's just here to
631 struct ib_uverbs_sge {
637 struct ib_uverbs_send_wr {
644 __u32 invalidate_rkey;
668 struct ib_uverbs_post_send {
674 struct ib_uverbs_send_wr send_wr[0];
677 struct ib_uverbs_post_send_resp {
681 struct ib_uverbs_recv_wr {
687 struct ib_uverbs_post_recv {
693 struct ib_uverbs_recv_wr recv_wr[0];
696 struct ib_uverbs_post_recv_resp {
700 struct ib_uverbs_post_srq_recv {
706 struct ib_uverbs_recv_wr recv[0];
709 struct ib_uverbs_post_srq_recv_resp {
713 struct ib_uverbs_create_ah {
718 struct ib_uverbs_ah_attr attr;
721 struct ib_uverbs_create_ah_resp {
725 struct ib_uverbs_destroy_ah {
729 struct ib_uverbs_attach_mcast {
734 __u64 driver_data[0];
737 struct ib_uverbs_detach_mcast {
742 __u64 driver_data[0];
745 struct ib_uverbs_flow_spec_hdr {
749 /* followed by flow_spec */
750 __u64 flow_spec_data[0];
753 struct ib_uverbs_flow_eth_filter {
760 struct ib_uverbs_flow_spec_eth {
762 struct ib_uverbs_flow_spec_hdr hdr;
769 struct ib_uverbs_flow_eth_filter val;
770 struct ib_uverbs_flow_eth_filter mask;
773 struct ib_uverbs_flow_ipv4_filter {
778 struct ib_uverbs_flow_spec_ipv4 {
780 struct ib_uverbs_flow_spec_hdr hdr;
787 struct ib_uverbs_flow_ipv4_filter val;
788 struct ib_uverbs_flow_ipv4_filter mask;
791 struct ib_uverbs_flow_tcp_udp_filter {
796 struct ib_uverbs_flow_spec_tcp_udp {
798 struct ib_uverbs_flow_spec_hdr hdr;
805 struct ib_uverbs_flow_tcp_udp_filter val;
806 struct ib_uverbs_flow_tcp_udp_filter mask;
809 struct ib_uverbs_flow_attr {
817 /* Following are the optional layers according to user request
818 * struct ib_flow_spec_xxx
819 * struct ib_flow_spec_yyy
821 struct ib_uverbs_flow_spec_hdr flow_specs[0];
824 struct ib_uverbs_create_flow {
827 struct ib_uverbs_flow_attr flow_attr;
830 struct ib_uverbs_create_flow_resp {
835 struct ib_uverbs_destroy_flow {
840 struct ib_uverbs_create_srq {
847 __u64 driver_data[0];
850 struct ib_uverbs_create_xsrq {
861 __u64 driver_data[0];
864 struct ib_uverbs_create_srq_resp {
871 struct ib_uverbs_modify_srq {
876 __u64 driver_data[0];
879 struct ib_uverbs_query_srq {
883 __u64 driver_data[0];
886 struct ib_uverbs_query_srq_resp {
893 struct ib_uverbs_destroy_srq {
899 struct ib_uverbs_destroy_srq_resp {
900 __u32 events_reported;
903 #endif /* IB_USER_VERBS_H */