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_MODIFY_QP = IB_USER_VERBS_CMD_MODIFY_QP,
97 IB_USER_VERBS_EX_CMD_CREATE_FLOW = IB_USER_VERBS_CMD_THRESHOLD,
98 IB_USER_VERBS_EX_CMD_DESTROY_FLOW,
99 IB_USER_VERBS_EX_CMD_CREATE_WQ,
100 IB_USER_VERBS_EX_CMD_MODIFY_WQ,
101 IB_USER_VERBS_EX_CMD_DESTROY_WQ,
102 IB_USER_VERBS_EX_CMD_CREATE_RWQ_IND_TBL,
103 IB_USER_VERBS_EX_CMD_DESTROY_RWQ_IND_TBL
107 * Make sure that all structs defined in this file remain laid out so
108 * that they pack the same way on 32-bit and 64-bit architectures (to
109 * avoid incompatibility between 32-bit userspace and 64-bit kernels).
111 * - Do not use pointer types -- pass pointers in __u64 instead.
112 * - Make sure that any structure larger than 4 bytes is padded to a
113 * multiple of 8 bytes. Otherwise the structure size will be
114 * different between 32-bit and 64-bit architectures.
117 struct ib_uverbs_async_event_desc {
119 __u32 event_type; /* enum ib_event_type */
123 struct ib_uverbs_comp_event_desc {
128 * All commands from userspace should start with a __u32 command field
129 * followed by __u16 in_words and out_words fields (which give the
130 * length of the command block and response buffer if any in 32-bit
131 * words). The kernel driver will read these fields first and read
132 * the rest of the command struct based on these value.
135 #define IB_USER_VERBS_CMD_COMMAND_MASK 0xff
136 #define IB_USER_VERBS_CMD_FLAGS_MASK 0xff000000u
137 #define IB_USER_VERBS_CMD_FLAGS_SHIFT 24
139 #define IB_USER_VERBS_CMD_FLAG_EXTENDED 0x80
141 struct ib_uverbs_cmd_hdr {
147 struct ib_uverbs_ex_cmd_hdr {
149 __u16 provider_in_words;
150 __u16 provider_out_words;
151 __u32 cmd_hdr_reserved;
154 struct ib_uverbs_get_context {
156 __u64 driver_data[0];
159 struct ib_uverbs_get_context_resp {
161 __u32 num_comp_vectors;
164 struct ib_uverbs_query_device {
166 __u64 driver_data[0];
169 struct ib_uverbs_query_device_resp {
172 __be64 sys_image_guid;
176 __u32 vendor_part_id;
180 __u32 device_cap_flags;
187 __u32 max_qp_rd_atom;
188 __u32 max_ee_rd_atom;
189 __u32 max_res_rd_atom;
190 __u32 max_qp_init_rd_atom;
191 __u32 max_ee_init_rd_atom;
196 __u32 max_raw_ipv6_qp;
197 __u32 max_raw_ethy_qp;
199 __u32 max_mcast_qp_attach;
200 __u32 max_total_mcast_qp_attach;
203 __u32 max_map_per_fmr;
208 __u8 local_ca_ack_delay;
213 struct ib_uverbs_ex_query_device {
218 struct ib_uverbs_odp_caps {
224 } per_transport_caps;
228 struct ib_uverbs_rss_caps {
229 /* Corresponding bit will be set if qp type from
230 * 'enum ib_qp_type' is supported, e.g.
231 * supported_qpts |= 1 << IB_QPT_UD
233 __u32 supported_qpts;
234 __u32 max_rwq_indirection_tables;
235 __u32 max_rwq_indirection_table_size;
239 struct ib_uverbs_tm_caps {
240 /* Max size of rendezvous request message */
241 __u32 max_rndv_hdr_size;
242 /* Max number of entries in tag matching list */
246 /* Max number of outstanding list operations */
248 /* Max number of SGE in tag matching entry */
253 struct ib_uverbs_ex_query_device_resp {
254 struct ib_uverbs_query_device_resp base;
256 __u32 response_length;
257 struct ib_uverbs_odp_caps odp_caps;
258 __u64 timestamp_mask;
259 __u64 hca_core_clock; /* in KHZ */
260 __u64 device_cap_flags_ex;
261 struct ib_uverbs_rss_caps rss_caps;
262 __u32 max_wq_type_rq;
263 __u32 raw_packet_caps;
264 struct ib_uverbs_tm_caps tm_caps;
267 struct ib_uverbs_query_port {
271 __u64 driver_data[0];
274 struct ib_uverbs_query_port_resp {
275 __u32 port_cap_flags;
278 __u32 qkey_viol_cntr;
290 __u8 init_type_reply;
298 struct ib_uverbs_alloc_pd {
300 __u64 driver_data[0];
303 struct ib_uverbs_alloc_pd_resp {
307 struct ib_uverbs_dealloc_pd {
311 struct ib_uverbs_open_xrcd {
315 __u64 driver_data[0];
318 struct ib_uverbs_open_xrcd_resp {
322 struct ib_uverbs_close_xrcd {
326 struct ib_uverbs_reg_mr {
333 __u64 driver_data[0];
336 struct ib_uverbs_reg_mr_resp {
342 struct ib_uverbs_rereg_mr {
353 struct ib_uverbs_rereg_mr_resp {
358 struct ib_uverbs_dereg_mr {
362 struct ib_uverbs_alloc_mw {
369 struct ib_uverbs_alloc_mw_resp {
374 struct ib_uverbs_dealloc_mw {
378 struct ib_uverbs_create_comp_channel {
382 struct ib_uverbs_create_comp_channel_resp {
386 struct ib_uverbs_create_cq {
393 __u64 driver_data[0];
396 struct ib_uverbs_ex_create_cq {
406 struct ib_uverbs_create_cq_resp {
411 struct ib_uverbs_ex_create_cq_resp {
412 struct ib_uverbs_create_cq_resp base;
414 __u32 response_length;
417 struct ib_uverbs_resize_cq {
421 __u64 driver_data[0];
424 struct ib_uverbs_resize_cq_resp {
427 __u64 driver_data[0];
430 struct ib_uverbs_poll_cq {
436 struct ib_uverbs_wc {
444 __u32 invalidate_rkey;
457 struct ib_uverbs_poll_cq_resp {
460 struct ib_uverbs_wc wc[0];
463 struct ib_uverbs_req_notify_cq {
465 __u32 solicited_only;
468 struct ib_uverbs_destroy_cq {
474 struct ib_uverbs_destroy_cq_resp {
475 __u32 comp_events_reported;
476 __u32 async_events_reported;
479 struct ib_uverbs_global_route {
488 struct ib_uverbs_ah_attr {
489 struct ib_uverbs_global_route grh;
499 struct ib_uverbs_qp_attr {
504 __u32 path_mig_state;
509 __u32 qp_access_flags;
511 struct ib_uverbs_ah_attr ah_attr;
512 struct ib_uverbs_ah_attr alt_ah_attr;
519 __u32 max_inline_data;
522 __u16 alt_pkey_index;
523 __u8 en_sqd_async_notify;
526 __u8 max_dest_rd_atomic;
537 struct ib_uverbs_create_qp {
541 __u32 send_cq_handle;
542 __u32 recv_cq_handle;
548 __u32 max_inline_data;
553 __u64 driver_data[0];
556 enum ib_uverbs_create_qp_mask {
557 IB_UVERBS_CREATE_QP_MASK_IND_TABLE = 1UL << 0,
561 IB_UVERBS_CREATE_QP_SUP_COMP_MASK = IB_UVERBS_CREATE_QP_MASK_IND_TABLE,
566 * This value is equal to IB_QP_DEST_QPN.
568 IB_USER_LEGACY_LAST_QP_ATTR_MASK = 1ULL << 20,
573 * This value is equal to IB_QP_RATE_LIMIT.
575 IB_USER_LAST_QP_ATTR_MASK = 1ULL << 25,
578 struct ib_uverbs_ex_create_qp {
581 __u32 send_cq_handle;
582 __u32 recv_cq_handle;
588 __u32 max_inline_data;
595 __u32 rwq_ind_tbl_handle;
599 struct ib_uverbs_open_qp {
606 __u64 driver_data[0];
609 /* also used for open response */
610 struct ib_uverbs_create_qp_resp {
617 __u32 max_inline_data;
621 struct ib_uverbs_ex_create_qp_resp {
622 struct ib_uverbs_create_qp_resp base;
624 __u32 response_length;
628 * This struct needs to remain a multiple of 8 bytes to keep the
629 * alignment of the modify QP parameters.
631 struct ib_uverbs_qp_dest {
646 struct ib_uverbs_query_qp {
650 __u64 driver_data[0];
653 struct ib_uverbs_query_qp_resp {
654 struct ib_uverbs_qp_dest dest;
655 struct ib_uverbs_qp_dest alt_dest;
660 __u32 max_inline_data;
665 __u32 qp_access_flags;
667 __u16 alt_pkey_index;
674 __u8 max_dest_rd_atomic;
684 __u64 driver_data[0];
687 struct ib_uverbs_modify_qp {
688 struct ib_uverbs_qp_dest dest;
689 struct ib_uverbs_qp_dest alt_dest;
696 __u32 qp_access_flags;
698 __u16 alt_pkey_index;
703 __u8 en_sqd_async_notify;
705 __u8 max_dest_rd_atomic;
714 __u64 driver_data[0];
717 struct ib_uverbs_ex_modify_qp {
718 struct ib_uverbs_modify_qp base;
723 struct ib_uverbs_modify_qp_resp {
726 struct ib_uverbs_ex_modify_qp_resp {
728 __u32 response_length;
731 struct ib_uverbs_destroy_qp {
737 struct ib_uverbs_destroy_qp_resp {
738 __u32 events_reported;
742 * The ib_uverbs_sge structure isn't used anywhere, since we assume
743 * the ib_sge structure is packed the same way on 32-bit and 64-bit
744 * architectures in both kernel and user space. It's just here to
747 struct ib_uverbs_sge {
753 struct ib_uverbs_send_wr {
760 __u32 invalidate_rkey;
784 struct ib_uverbs_post_send {
790 struct ib_uverbs_send_wr send_wr[0];
793 struct ib_uverbs_post_send_resp {
797 struct ib_uverbs_recv_wr {
803 struct ib_uverbs_post_recv {
809 struct ib_uverbs_recv_wr recv_wr[0];
812 struct ib_uverbs_post_recv_resp {
816 struct ib_uverbs_post_srq_recv {
822 struct ib_uverbs_recv_wr recv[0];
825 struct ib_uverbs_post_srq_recv_resp {
829 struct ib_uverbs_create_ah {
834 struct ib_uverbs_ah_attr attr;
837 struct ib_uverbs_create_ah_resp {
841 struct ib_uverbs_destroy_ah {
845 struct ib_uverbs_attach_mcast {
850 __u64 driver_data[0];
853 struct ib_uverbs_detach_mcast {
858 __u64 driver_data[0];
861 struct ib_uverbs_flow_spec_hdr {
865 /* followed by flow_spec */
866 __u64 flow_spec_data[0];
869 struct ib_uverbs_flow_eth_filter {
876 struct ib_uverbs_flow_spec_eth {
878 struct ib_uverbs_flow_spec_hdr hdr;
885 struct ib_uverbs_flow_eth_filter val;
886 struct ib_uverbs_flow_eth_filter mask;
889 struct ib_uverbs_flow_ipv4_filter {
898 struct ib_uverbs_flow_spec_ipv4 {
900 struct ib_uverbs_flow_spec_hdr hdr;
907 struct ib_uverbs_flow_ipv4_filter val;
908 struct ib_uverbs_flow_ipv4_filter mask;
911 struct ib_uverbs_flow_tcp_udp_filter {
916 struct ib_uverbs_flow_spec_tcp_udp {
918 struct ib_uverbs_flow_spec_hdr hdr;
925 struct ib_uverbs_flow_tcp_udp_filter val;
926 struct ib_uverbs_flow_tcp_udp_filter mask;
929 struct ib_uverbs_flow_ipv6_filter {
939 struct ib_uverbs_flow_spec_ipv6 {
941 struct ib_uverbs_flow_spec_hdr hdr;
948 struct ib_uverbs_flow_ipv6_filter val;
949 struct ib_uverbs_flow_ipv6_filter mask;
952 struct ib_uverbs_flow_spec_action_tag {
954 struct ib_uverbs_flow_spec_hdr hdr;
965 struct ib_uverbs_flow_spec_action_drop {
967 struct ib_uverbs_flow_spec_hdr hdr;
976 struct ib_uverbs_flow_tunnel_filter {
980 struct ib_uverbs_flow_spec_tunnel {
982 struct ib_uverbs_flow_spec_hdr hdr;
989 struct ib_uverbs_flow_tunnel_filter val;
990 struct ib_uverbs_flow_tunnel_filter mask;
993 struct ib_uverbs_flow_attr {
1001 /* Following are the optional layers according to user request
1002 * struct ib_flow_spec_xxx
1003 * struct ib_flow_spec_yyy
1005 struct ib_uverbs_flow_spec_hdr flow_specs[0];
1008 struct ib_uverbs_create_flow {
1011 struct ib_uverbs_flow_attr flow_attr;
1014 struct ib_uverbs_create_flow_resp {
1019 struct ib_uverbs_destroy_flow {
1024 struct ib_uverbs_create_srq {
1031 __u64 driver_data[0];
1034 struct ib_uverbs_create_xsrq {
1045 __u64 driver_data[0];
1048 struct ib_uverbs_create_srq_resp {
1055 struct ib_uverbs_modify_srq {
1060 __u64 driver_data[0];
1063 struct ib_uverbs_query_srq {
1067 __u64 driver_data[0];
1070 struct ib_uverbs_query_srq_resp {
1077 struct ib_uverbs_destroy_srq {
1083 struct ib_uverbs_destroy_srq_resp {
1084 __u32 events_reported;
1087 struct ib_uverbs_ex_create_wq {
1095 __u32 create_flags; /* Use enum ib_wq_flags */
1099 struct ib_uverbs_ex_create_wq_resp {
1101 __u32 response_length;
1108 struct ib_uverbs_ex_destroy_wq {
1113 struct ib_uverbs_ex_destroy_wq_resp {
1115 __u32 response_length;
1116 __u32 events_reported;
1120 struct ib_uverbs_ex_modify_wq {
1124 __u32 curr_wq_state;
1125 __u32 flags; /* Use enum ib_wq_flags */
1126 __u32 flags_mask; /* Use enum ib_wq_flags */
1129 /* Prevent memory allocation rather than max expected size */
1130 #define IB_USER_VERBS_MAX_LOG_IND_TBL_SIZE 0x0d
1131 struct ib_uverbs_ex_create_rwq_ind_table {
1133 __u32 log_ind_tbl_size;
1134 /* Following are the wq handles according to log_ind_tbl_size
1138 __u32 wq_handles[0];
1141 struct ib_uverbs_ex_create_rwq_ind_table_resp {
1143 __u32 response_length;
1144 __u32 ind_tbl_handle;
1148 struct ib_uverbs_ex_destroy_rwq_ind_table {
1150 __u32 ind_tbl_handle;
1153 #define IB_DEVICE_NAME_MAX 64
1155 #endif /* IB_USER_VERBS_H */