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,
90 #ifdef CONFIG_INFINIBAND_EXPERIMENTAL_UVERBS_FLOW_STEERING
91 IB_USER_VERBS_CMD_CREATE_FLOW = IB_USER_VERBS_CMD_THRESHOLD,
92 IB_USER_VERBS_CMD_DESTROY_FLOW
93 #endif /* CONFIG_INFINIBAND_EXPERIMENTAL_UVERBS_FLOW_STEERING */
97 * Make sure that all structs defined in this file remain laid out so
98 * that they pack the same way on 32-bit and 64-bit architectures (to
99 * avoid incompatibility between 32-bit userspace and 64-bit kernels).
101 * - Do not use pointer types -- pass pointers in __u64 instead.
102 * - Make sure that any structure larger than 4 bytes is padded to a
103 * multiple of 8 bytes. Otherwise the structure size will be
104 * different between 32-bit and 64-bit architectures.
107 struct ib_uverbs_async_event_desc {
109 __u32 event_type; /* enum ib_event_type */
113 struct ib_uverbs_comp_event_desc {
118 * All commands from userspace should start with a __u32 command field
119 * followed by __u16 in_words and out_words fields (which give the
120 * length of the command block and response buffer if any in 32-bit
121 * words). The kernel driver will read these fields first and read
122 * the rest of the command struct based on these value.
125 struct ib_uverbs_cmd_hdr {
131 #ifdef CONFIG_INFINIBAND_EXPERIMENTAL_UVERBS_FLOW_STEERING
132 struct ib_uverbs_cmd_hdr_ex {
136 __u16 provider_in_words;
137 __u16 provider_out_words;
138 __u32 cmd_hdr_reserved;
140 #endif /* CONFIG_INFINIBAND_EXPERIMENTAL_UVERBS_FLOW_STEERING */
142 struct ib_uverbs_get_context {
144 __u64 driver_data[0];
147 struct ib_uverbs_get_context_resp {
149 __u32 num_comp_vectors;
152 struct ib_uverbs_query_device {
154 __u64 driver_data[0];
157 struct ib_uverbs_query_device_resp {
160 __be64 sys_image_guid;
164 __u32 vendor_part_id;
168 __u32 device_cap_flags;
175 __u32 max_qp_rd_atom;
176 __u32 max_ee_rd_atom;
177 __u32 max_res_rd_atom;
178 __u32 max_qp_init_rd_atom;
179 __u32 max_ee_init_rd_atom;
184 __u32 max_raw_ipv6_qp;
185 __u32 max_raw_ethy_qp;
187 __u32 max_mcast_qp_attach;
188 __u32 max_total_mcast_qp_attach;
191 __u32 max_map_per_fmr;
196 __u8 local_ca_ack_delay;
201 struct ib_uverbs_query_port {
205 __u64 driver_data[0];
208 struct ib_uverbs_query_port_resp {
209 __u32 port_cap_flags;
212 __u32 qkey_viol_cntr;
224 __u8 init_type_reply;
232 struct ib_uverbs_alloc_pd {
234 __u64 driver_data[0];
237 struct ib_uverbs_alloc_pd_resp {
241 struct ib_uverbs_dealloc_pd {
245 struct ib_uverbs_open_xrcd {
249 __u64 driver_data[0];
252 struct ib_uverbs_open_xrcd_resp {
256 struct ib_uverbs_close_xrcd {
260 struct ib_uverbs_reg_mr {
267 __u64 driver_data[0];
270 struct ib_uverbs_reg_mr_resp {
276 struct ib_uverbs_dereg_mr {
280 struct ib_uverbs_alloc_mw {
287 struct ib_uverbs_alloc_mw_resp {
292 struct ib_uverbs_dealloc_mw {
296 struct ib_uverbs_create_comp_channel {
300 struct ib_uverbs_create_comp_channel_resp {
304 struct ib_uverbs_create_cq {
311 __u64 driver_data[0];
314 struct ib_uverbs_create_cq_resp {
319 struct ib_uverbs_resize_cq {
323 __u64 driver_data[0];
326 struct ib_uverbs_resize_cq_resp {
329 __u64 driver_data[0];
332 struct ib_uverbs_poll_cq {
338 struct ib_uverbs_wc {
346 __u32 invalidate_rkey;
359 struct ib_uverbs_poll_cq_resp {
362 struct ib_uverbs_wc wc[0];
365 struct ib_uverbs_req_notify_cq {
367 __u32 solicited_only;
370 struct ib_uverbs_destroy_cq {
376 struct ib_uverbs_destroy_cq_resp {
377 __u32 comp_events_reported;
378 __u32 async_events_reported;
381 struct ib_uverbs_global_route {
390 struct ib_uverbs_ah_attr {
391 struct ib_uverbs_global_route grh;
401 struct ib_uverbs_qp_attr {
406 __u32 path_mig_state;
411 __u32 qp_access_flags;
413 struct ib_uverbs_ah_attr ah_attr;
414 struct ib_uverbs_ah_attr alt_ah_attr;
421 __u32 max_inline_data;
424 __u16 alt_pkey_index;
425 __u8 en_sqd_async_notify;
428 __u8 max_dest_rd_atomic;
439 struct ib_uverbs_create_qp {
443 __u32 send_cq_handle;
444 __u32 recv_cq_handle;
450 __u32 max_inline_data;
455 __u64 driver_data[0];
458 struct ib_uverbs_open_qp {
465 __u64 driver_data[0];
468 /* also used for open response */
469 struct ib_uverbs_create_qp_resp {
476 __u32 max_inline_data;
481 * This struct needs to remain a multiple of 8 bytes to keep the
482 * alignment of the modify QP parameters.
484 struct ib_uverbs_qp_dest {
499 struct ib_uverbs_query_qp {
503 __u64 driver_data[0];
506 struct ib_uverbs_query_qp_resp {
507 struct ib_uverbs_qp_dest dest;
508 struct ib_uverbs_qp_dest alt_dest;
513 __u32 max_inline_data;
518 __u32 qp_access_flags;
520 __u16 alt_pkey_index;
527 __u8 max_dest_rd_atomic;
537 __u64 driver_data[0];
540 struct ib_uverbs_modify_qp {
541 struct ib_uverbs_qp_dest dest;
542 struct ib_uverbs_qp_dest alt_dest;
549 __u32 qp_access_flags;
551 __u16 alt_pkey_index;
556 __u8 en_sqd_async_notify;
558 __u8 max_dest_rd_atomic;
567 __u64 driver_data[0];
570 struct ib_uverbs_modify_qp_resp {
573 struct ib_uverbs_destroy_qp {
579 struct ib_uverbs_destroy_qp_resp {
580 __u32 events_reported;
584 * The ib_uverbs_sge structure isn't used anywhere, since we assume
585 * the ib_sge structure is packed the same way on 32-bit and 64-bit
586 * architectures in both kernel and user space. It's just here to
589 struct ib_uverbs_sge {
595 struct ib_uverbs_send_wr {
602 __u32 invalidate_rkey;
626 struct ib_uverbs_post_send {
632 struct ib_uverbs_send_wr send_wr[0];
635 struct ib_uverbs_post_send_resp {
639 struct ib_uverbs_recv_wr {
645 struct ib_uverbs_post_recv {
651 struct ib_uverbs_recv_wr recv_wr[0];
654 struct ib_uverbs_post_recv_resp {
658 struct ib_uverbs_post_srq_recv {
664 struct ib_uverbs_recv_wr recv[0];
667 struct ib_uverbs_post_srq_recv_resp {
671 struct ib_uverbs_create_ah {
676 struct ib_uverbs_ah_attr attr;
679 struct ib_uverbs_create_ah_resp {
683 struct ib_uverbs_destroy_ah {
687 struct ib_uverbs_attach_mcast {
692 __u64 driver_data[0];
695 struct ib_uverbs_detach_mcast {
700 __u64 driver_data[0];
703 #ifdef CONFIG_INFINIBAND_EXPERIMENTAL_UVERBS_FLOW_STEERING
704 struct ib_kern_eth_filter {
711 struct ib_kern_spec_eth {
715 struct ib_kern_eth_filter val;
716 struct ib_kern_eth_filter mask;
719 struct ib_kern_ipv4_filter {
724 struct ib_kern_spec_ipv4 {
728 struct ib_kern_ipv4_filter val;
729 struct ib_kern_ipv4_filter mask;
732 struct ib_kern_tcp_udp_filter {
737 struct ib_kern_spec_tcp_udp {
741 struct ib_kern_tcp_udp_filter val;
742 struct ib_kern_tcp_udp_filter mask;
745 struct ib_kern_spec {
752 struct ib_kern_spec_eth eth;
753 struct ib_kern_spec_ipv4 ipv4;
754 struct ib_kern_spec_tcp_udp tcp_udp;
758 struct ib_kern_flow_attr {
766 /* Following are the optional layers according to user request
767 * struct ib_flow_spec_xxx
768 * struct ib_flow_spec_yyy
772 struct ib_uverbs_create_flow {
776 struct ib_kern_flow_attr flow_attr;
779 struct ib_uverbs_create_flow_resp {
784 struct ib_uverbs_destroy_flow {
788 #endif /* CONFIG_INFINIBAND_EXPERIMENTAL_UVERBS_FLOW_STEERING */
790 struct ib_uverbs_create_srq {
797 __u64 driver_data[0];
800 struct ib_uverbs_create_xsrq {
811 __u64 driver_data[0];
814 struct ib_uverbs_create_srq_resp {
821 struct ib_uverbs_modify_srq {
826 __u64 driver_data[0];
829 struct ib_uverbs_query_srq {
833 __u64 driver_data[0];
836 struct ib_uverbs_query_srq_resp {
843 struct ib_uverbs_destroy_srq {
849 struct ib_uverbs_destroy_srq_resp {
850 __u32 events_reported;
853 #endif /* IB_USER_VERBS_H */