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_CQ = IB_USER_VERBS_CMD_CREATE_CQ,
95 IB_USER_VERBS_EX_CMD_CREATE_QP = IB_USER_VERBS_CMD_CREATE_QP,
96 IB_USER_VERBS_EX_CMD_CREATE_FLOW = IB_USER_VERBS_CMD_THRESHOLD,
97 IB_USER_VERBS_EX_CMD_DESTROY_FLOW,
101 * Make sure that all structs defined in this file remain laid out so
102 * that they pack the same way on 32-bit and 64-bit architectures (to
103 * avoid incompatibility between 32-bit userspace and 64-bit kernels).
105 * - Do not use pointer types -- pass pointers in __u64 instead.
106 * - Make sure that any structure larger than 4 bytes is padded to a
107 * multiple of 8 bytes. Otherwise the structure size will be
108 * different between 32-bit and 64-bit architectures.
111 struct ib_uverbs_async_event_desc {
113 __u32 event_type; /* enum ib_event_type */
117 struct ib_uverbs_comp_event_desc {
122 * All commands from userspace should start with a __u32 command field
123 * followed by __u16 in_words and out_words fields (which give the
124 * length of the command block and response buffer if any in 32-bit
125 * words). The kernel driver will read these fields first and read
126 * the rest of the command struct based on these value.
129 #define IB_USER_VERBS_CMD_COMMAND_MASK 0xff
130 #define IB_USER_VERBS_CMD_FLAGS_MASK 0xff000000u
131 #define IB_USER_VERBS_CMD_FLAGS_SHIFT 24
133 #define IB_USER_VERBS_CMD_FLAG_EXTENDED 0x80
135 struct ib_uverbs_cmd_hdr {
141 struct ib_uverbs_ex_cmd_hdr {
143 __u16 provider_in_words;
144 __u16 provider_out_words;
145 __u32 cmd_hdr_reserved;
148 struct ib_uverbs_get_context {
150 __u64 driver_data[0];
153 struct ib_uverbs_get_context_resp {
155 __u32 num_comp_vectors;
158 struct ib_uverbs_query_device {
160 __u64 driver_data[0];
163 struct ib_uverbs_query_device_resp {
166 __be64 sys_image_guid;
170 __u32 vendor_part_id;
174 __u32 device_cap_flags;
181 __u32 max_qp_rd_atom;
182 __u32 max_ee_rd_atom;
183 __u32 max_res_rd_atom;
184 __u32 max_qp_init_rd_atom;
185 __u32 max_ee_init_rd_atom;
190 __u32 max_raw_ipv6_qp;
191 __u32 max_raw_ethy_qp;
193 __u32 max_mcast_qp_attach;
194 __u32 max_total_mcast_qp_attach;
197 __u32 max_map_per_fmr;
202 __u8 local_ca_ack_delay;
207 struct ib_uverbs_ex_query_device {
212 struct ib_uverbs_odp_caps {
218 } per_transport_caps;
222 struct ib_uverbs_ex_query_device_resp {
223 struct ib_uverbs_query_device_resp base;
225 __u32 response_length;
226 struct ib_uverbs_odp_caps odp_caps;
227 __u64 timestamp_mask;
228 __u64 hca_core_clock; /* in KHZ */
229 __u64 device_cap_flags_ex;
232 struct ib_uverbs_query_port {
236 __u64 driver_data[0];
239 struct ib_uverbs_query_port_resp {
240 __u32 port_cap_flags;
243 __u32 qkey_viol_cntr;
255 __u8 init_type_reply;
263 struct ib_uverbs_alloc_pd {
265 __u64 driver_data[0];
268 struct ib_uverbs_alloc_pd_resp {
272 struct ib_uverbs_dealloc_pd {
276 struct ib_uverbs_open_xrcd {
280 __u64 driver_data[0];
283 struct ib_uverbs_open_xrcd_resp {
287 struct ib_uverbs_close_xrcd {
291 struct ib_uverbs_reg_mr {
298 __u64 driver_data[0];
301 struct ib_uverbs_reg_mr_resp {
307 struct ib_uverbs_rereg_mr {
318 struct ib_uverbs_rereg_mr_resp {
323 struct ib_uverbs_dereg_mr {
327 struct ib_uverbs_alloc_mw {
334 struct ib_uverbs_alloc_mw_resp {
339 struct ib_uverbs_dealloc_mw {
343 struct ib_uverbs_create_comp_channel {
347 struct ib_uverbs_create_comp_channel_resp {
351 struct ib_uverbs_create_cq {
358 __u64 driver_data[0];
361 struct ib_uverbs_ex_create_cq {
371 struct ib_uverbs_create_cq_resp {
376 struct ib_uverbs_ex_create_cq_resp {
377 struct ib_uverbs_create_cq_resp base;
379 __u32 response_length;
382 struct ib_uverbs_resize_cq {
386 __u64 driver_data[0];
389 struct ib_uverbs_resize_cq_resp {
392 __u64 driver_data[0];
395 struct ib_uverbs_poll_cq {
401 struct ib_uverbs_wc {
409 __u32 invalidate_rkey;
422 struct ib_uverbs_poll_cq_resp {
425 struct ib_uverbs_wc wc[0];
428 struct ib_uverbs_req_notify_cq {
430 __u32 solicited_only;
433 struct ib_uverbs_destroy_cq {
439 struct ib_uverbs_destroy_cq_resp {
440 __u32 comp_events_reported;
441 __u32 async_events_reported;
444 struct ib_uverbs_global_route {
453 struct ib_uverbs_ah_attr {
454 struct ib_uverbs_global_route grh;
464 struct ib_uverbs_qp_attr {
469 __u32 path_mig_state;
474 __u32 qp_access_flags;
476 struct ib_uverbs_ah_attr ah_attr;
477 struct ib_uverbs_ah_attr alt_ah_attr;
484 __u32 max_inline_data;
487 __u16 alt_pkey_index;
488 __u8 en_sqd_async_notify;
491 __u8 max_dest_rd_atomic;
502 struct ib_uverbs_create_qp {
506 __u32 send_cq_handle;
507 __u32 recv_cq_handle;
513 __u32 max_inline_data;
518 __u64 driver_data[0];
521 struct ib_uverbs_ex_create_qp {
524 __u32 send_cq_handle;
525 __u32 recv_cq_handle;
531 __u32 max_inline_data;
540 struct ib_uverbs_open_qp {
547 __u64 driver_data[0];
550 /* also used for open response */
551 struct ib_uverbs_create_qp_resp {
558 __u32 max_inline_data;
562 struct ib_uverbs_ex_create_qp_resp {
563 struct ib_uverbs_create_qp_resp base;
565 __u32 response_length;
569 * This struct needs to remain a multiple of 8 bytes to keep the
570 * alignment of the modify QP parameters.
572 struct ib_uverbs_qp_dest {
587 struct ib_uverbs_query_qp {
591 __u64 driver_data[0];
594 struct ib_uverbs_query_qp_resp {
595 struct ib_uverbs_qp_dest dest;
596 struct ib_uverbs_qp_dest alt_dest;
601 __u32 max_inline_data;
606 __u32 qp_access_flags;
608 __u16 alt_pkey_index;
615 __u8 max_dest_rd_atomic;
625 __u64 driver_data[0];
628 struct ib_uverbs_modify_qp {
629 struct ib_uverbs_qp_dest dest;
630 struct ib_uverbs_qp_dest alt_dest;
637 __u32 qp_access_flags;
639 __u16 alt_pkey_index;
644 __u8 en_sqd_async_notify;
646 __u8 max_dest_rd_atomic;
655 __u64 driver_data[0];
658 struct ib_uverbs_modify_qp_resp {
661 struct ib_uverbs_destroy_qp {
667 struct ib_uverbs_destroy_qp_resp {
668 __u32 events_reported;
672 * The ib_uverbs_sge structure isn't used anywhere, since we assume
673 * the ib_sge structure is packed the same way on 32-bit and 64-bit
674 * architectures in both kernel and user space. It's just here to
677 struct ib_uverbs_sge {
683 struct ib_uverbs_send_wr {
690 __u32 invalidate_rkey;
714 struct ib_uverbs_post_send {
720 struct ib_uverbs_send_wr send_wr[0];
723 struct ib_uverbs_post_send_resp {
727 struct ib_uverbs_recv_wr {
733 struct ib_uverbs_post_recv {
739 struct ib_uverbs_recv_wr recv_wr[0];
742 struct ib_uverbs_post_recv_resp {
746 struct ib_uverbs_post_srq_recv {
752 struct ib_uverbs_recv_wr recv[0];
755 struct ib_uverbs_post_srq_recv_resp {
759 struct ib_uverbs_create_ah {
764 struct ib_uverbs_ah_attr attr;
767 struct ib_uverbs_create_ah_resp {
771 struct ib_uverbs_destroy_ah {
775 struct ib_uverbs_attach_mcast {
780 __u64 driver_data[0];
783 struct ib_uverbs_detach_mcast {
788 __u64 driver_data[0];
791 struct ib_uverbs_flow_spec_hdr {
795 /* followed by flow_spec */
796 __u64 flow_spec_data[0];
799 struct ib_uverbs_flow_eth_filter {
806 struct ib_uverbs_flow_spec_eth {
808 struct ib_uverbs_flow_spec_hdr hdr;
815 struct ib_uverbs_flow_eth_filter val;
816 struct ib_uverbs_flow_eth_filter mask;
819 struct ib_uverbs_flow_ipv4_filter {
824 struct ib_uverbs_flow_spec_ipv4 {
826 struct ib_uverbs_flow_spec_hdr hdr;
833 struct ib_uverbs_flow_ipv4_filter val;
834 struct ib_uverbs_flow_ipv4_filter mask;
837 struct ib_uverbs_flow_tcp_udp_filter {
842 struct ib_uverbs_flow_spec_tcp_udp {
844 struct ib_uverbs_flow_spec_hdr hdr;
851 struct ib_uverbs_flow_tcp_udp_filter val;
852 struct ib_uverbs_flow_tcp_udp_filter mask;
855 struct ib_uverbs_flow_attr {
863 /* Following are the optional layers according to user request
864 * struct ib_flow_spec_xxx
865 * struct ib_flow_spec_yyy
867 struct ib_uverbs_flow_spec_hdr flow_specs[0];
870 struct ib_uverbs_create_flow {
873 struct ib_uverbs_flow_attr flow_attr;
876 struct ib_uverbs_create_flow_resp {
881 struct ib_uverbs_destroy_flow {
886 struct ib_uverbs_create_srq {
893 __u64 driver_data[0];
896 struct ib_uverbs_create_xsrq {
907 __u64 driver_data[0];
910 struct ib_uverbs_create_srq_resp {
917 struct ib_uverbs_modify_srq {
922 __u64 driver_data[0];
925 struct ib_uverbs_query_srq {
929 __u64 driver_data[0];
932 struct ib_uverbs_query_srq_resp {
939 struct ib_uverbs_destroy_srq {
945 struct ib_uverbs_destroy_srq_resp {
946 __u32 events_reported;
949 #endif /* IB_USER_VERBS_H */