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
,
98 IB_USER_VERBS_EX_CMD_CREATE_WQ
,
99 IB_USER_VERBS_EX_CMD_MODIFY_WQ
,
100 IB_USER_VERBS_EX_CMD_DESTROY_WQ
,
101 IB_USER_VERBS_EX_CMD_CREATE_RWQ_IND_TBL
,
102 IB_USER_VERBS_EX_CMD_DESTROY_RWQ_IND_TBL
106 * Make sure that all structs defined in this file remain laid out so
107 * that they pack the same way on 32-bit and 64-bit architectures (to
108 * avoid incompatibility between 32-bit userspace and 64-bit kernels).
110 * - Do not use pointer types -- pass pointers in __u64 instead.
111 * - Make sure that any structure larger than 4 bytes is padded to a
112 * multiple of 8 bytes. Otherwise the structure size will be
113 * different between 32-bit and 64-bit architectures.
116 struct ib_uverbs_async_event_desc
{
118 __u32 event_type
; /* enum ib_event_type */
122 struct ib_uverbs_comp_event_desc
{
127 * All commands from userspace should start with a __u32 command field
128 * followed by __u16 in_words and out_words fields (which give the
129 * length of the command block and response buffer if any in 32-bit
130 * words). The kernel driver will read these fields first and read
131 * the rest of the command struct based on these value.
134 #define IB_USER_VERBS_CMD_COMMAND_MASK 0xff
135 #define IB_USER_VERBS_CMD_FLAGS_MASK 0xff000000u
136 #define IB_USER_VERBS_CMD_FLAGS_SHIFT 24
138 #define IB_USER_VERBS_CMD_FLAG_EXTENDED 0x80
140 struct ib_uverbs_cmd_hdr
{
146 struct ib_uverbs_ex_cmd_hdr
{
148 __u16 provider_in_words
;
149 __u16 provider_out_words
;
150 __u32 cmd_hdr_reserved
;
153 struct ib_uverbs_get_context
{
155 __u64 driver_data
[0];
158 struct ib_uverbs_get_context_resp
{
160 __u32 num_comp_vectors
;
163 struct ib_uverbs_query_device
{
165 __u64 driver_data
[0];
168 struct ib_uverbs_query_device_resp
{
171 __be64 sys_image_guid
;
175 __u32 vendor_part_id
;
179 __u32 device_cap_flags
;
186 __u32 max_qp_rd_atom
;
187 __u32 max_ee_rd_atom
;
188 __u32 max_res_rd_atom
;
189 __u32 max_qp_init_rd_atom
;
190 __u32 max_ee_init_rd_atom
;
195 __u32 max_raw_ipv6_qp
;
196 __u32 max_raw_ethy_qp
;
198 __u32 max_mcast_qp_attach
;
199 __u32 max_total_mcast_qp_attach
;
202 __u32 max_map_per_fmr
;
207 __u8 local_ca_ack_delay
;
212 struct ib_uverbs_ex_query_device
{
217 struct ib_uverbs_odp_caps
{
223 } per_transport_caps
;
227 struct ib_uverbs_rss_caps
{
228 /* Corresponding bit will be set if qp type from
229 * 'enum ib_qp_type' is supported, e.g.
230 * supported_qpts |= 1 << IB_QPT_UD
232 __u32 supported_qpts
;
233 __u32 max_rwq_indirection_tables
;
234 __u32 max_rwq_indirection_table_size
;
238 struct ib_uverbs_ex_query_device_resp
{
239 struct ib_uverbs_query_device_resp base
;
241 __u32 response_length
;
242 struct ib_uverbs_odp_caps odp_caps
;
243 __u64 timestamp_mask
;
244 __u64 hca_core_clock
; /* in KHZ */
245 __u64 device_cap_flags_ex
;
246 struct ib_uverbs_rss_caps rss_caps
;
247 __u32 max_wq_type_rq
;
251 struct ib_uverbs_query_port
{
255 __u64 driver_data
[0];
258 struct ib_uverbs_query_port_resp
{
259 __u32 port_cap_flags
;
262 __u32 qkey_viol_cntr
;
274 __u8 init_type_reply
;
282 struct ib_uverbs_alloc_pd
{
284 __u64 driver_data
[0];
287 struct ib_uverbs_alloc_pd_resp
{
291 struct ib_uverbs_dealloc_pd
{
295 struct ib_uverbs_open_xrcd
{
299 __u64 driver_data
[0];
302 struct ib_uverbs_open_xrcd_resp
{
306 struct ib_uverbs_close_xrcd
{
310 struct ib_uverbs_reg_mr
{
317 __u64 driver_data
[0];
320 struct ib_uverbs_reg_mr_resp
{
326 struct ib_uverbs_rereg_mr
{
337 struct ib_uverbs_rereg_mr_resp
{
342 struct ib_uverbs_dereg_mr
{
346 struct ib_uverbs_alloc_mw
{
353 struct ib_uverbs_alloc_mw_resp
{
358 struct ib_uverbs_dealloc_mw
{
362 struct ib_uverbs_create_comp_channel
{
366 struct ib_uverbs_create_comp_channel_resp
{
370 struct ib_uverbs_create_cq
{
377 __u64 driver_data
[0];
380 struct ib_uverbs_ex_create_cq
{
390 struct ib_uverbs_create_cq_resp
{
395 struct ib_uverbs_ex_create_cq_resp
{
396 struct ib_uverbs_create_cq_resp base
;
398 __u32 response_length
;
401 struct ib_uverbs_resize_cq
{
405 __u64 driver_data
[0];
408 struct ib_uverbs_resize_cq_resp
{
411 __u64 driver_data
[0];
414 struct ib_uverbs_poll_cq
{
420 struct ib_uverbs_wc
{
428 __u32 invalidate_rkey
;
441 struct ib_uverbs_poll_cq_resp
{
444 struct ib_uverbs_wc wc
[0];
447 struct ib_uverbs_req_notify_cq
{
449 __u32 solicited_only
;
452 struct ib_uverbs_destroy_cq
{
458 struct ib_uverbs_destroy_cq_resp
{
459 __u32 comp_events_reported
;
460 __u32 async_events_reported
;
463 struct ib_uverbs_global_route
{
472 struct ib_uverbs_ah_attr
{
473 struct ib_uverbs_global_route grh
;
483 struct ib_uverbs_qp_attr
{
488 __u32 path_mig_state
;
493 __u32 qp_access_flags
;
495 struct ib_uverbs_ah_attr ah_attr
;
496 struct ib_uverbs_ah_attr alt_ah_attr
;
503 __u32 max_inline_data
;
506 __u16 alt_pkey_index
;
507 __u8 en_sqd_async_notify
;
510 __u8 max_dest_rd_atomic
;
521 struct ib_uverbs_create_qp
{
525 __u32 send_cq_handle
;
526 __u32 recv_cq_handle
;
532 __u32 max_inline_data
;
537 __u64 driver_data
[0];
540 enum ib_uverbs_create_qp_mask
{
541 IB_UVERBS_CREATE_QP_MASK_IND_TABLE
= 1UL << 0,
545 IB_UVERBS_CREATE_QP_SUP_COMP_MASK
= IB_UVERBS_CREATE_QP_MASK_IND_TABLE
,
548 struct ib_uverbs_ex_create_qp
{
551 __u32 send_cq_handle
;
552 __u32 recv_cq_handle
;
558 __u32 max_inline_data
;
565 __u32 rwq_ind_tbl_handle
;
569 struct ib_uverbs_open_qp
{
576 __u64 driver_data
[0];
579 /* also used for open response */
580 struct ib_uverbs_create_qp_resp
{
587 __u32 max_inline_data
;
591 struct ib_uverbs_ex_create_qp_resp
{
592 struct ib_uverbs_create_qp_resp base
;
594 __u32 response_length
;
598 * This struct needs to remain a multiple of 8 bytes to keep the
599 * alignment of the modify QP parameters.
601 struct ib_uverbs_qp_dest
{
616 struct ib_uverbs_query_qp
{
620 __u64 driver_data
[0];
623 struct ib_uverbs_query_qp_resp
{
624 struct ib_uverbs_qp_dest dest
;
625 struct ib_uverbs_qp_dest alt_dest
;
630 __u32 max_inline_data
;
635 __u32 qp_access_flags
;
637 __u16 alt_pkey_index
;
644 __u8 max_dest_rd_atomic
;
654 __u64 driver_data
[0];
657 struct ib_uverbs_modify_qp
{
658 struct ib_uverbs_qp_dest dest
;
659 struct ib_uverbs_qp_dest alt_dest
;
666 __u32 qp_access_flags
;
668 __u16 alt_pkey_index
;
673 __u8 en_sqd_async_notify
;
675 __u8 max_dest_rd_atomic
;
684 __u64 driver_data
[0];
687 struct ib_uverbs_modify_qp_resp
{
690 struct ib_uverbs_destroy_qp
{
696 struct ib_uverbs_destroy_qp_resp
{
697 __u32 events_reported
;
701 * The ib_uverbs_sge structure isn't used anywhere, since we assume
702 * the ib_sge structure is packed the same way on 32-bit and 64-bit
703 * architectures in both kernel and user space. It's just here to
706 struct ib_uverbs_sge
{
712 struct ib_uverbs_send_wr
{
719 __u32 invalidate_rkey
;
743 struct ib_uverbs_post_send
{
749 struct ib_uverbs_send_wr send_wr
[0];
752 struct ib_uverbs_post_send_resp
{
756 struct ib_uverbs_recv_wr
{
762 struct ib_uverbs_post_recv
{
768 struct ib_uverbs_recv_wr recv_wr
[0];
771 struct ib_uverbs_post_recv_resp
{
775 struct ib_uverbs_post_srq_recv
{
781 struct ib_uverbs_recv_wr recv
[0];
784 struct ib_uverbs_post_srq_recv_resp
{
788 struct ib_uverbs_create_ah
{
793 struct ib_uverbs_ah_attr attr
;
796 struct ib_uverbs_create_ah_resp
{
800 struct ib_uverbs_destroy_ah
{
804 struct ib_uverbs_attach_mcast
{
809 __u64 driver_data
[0];
812 struct ib_uverbs_detach_mcast
{
817 __u64 driver_data
[0];
820 struct ib_uverbs_flow_spec_hdr
{
824 /* followed by flow_spec */
825 __u64 flow_spec_data
[0];
828 struct ib_uverbs_flow_eth_filter
{
835 struct ib_uverbs_flow_spec_eth
{
837 struct ib_uverbs_flow_spec_hdr hdr
;
844 struct ib_uverbs_flow_eth_filter val
;
845 struct ib_uverbs_flow_eth_filter mask
;
848 struct ib_uverbs_flow_ipv4_filter
{
857 struct ib_uverbs_flow_spec_ipv4
{
859 struct ib_uverbs_flow_spec_hdr hdr
;
866 struct ib_uverbs_flow_ipv4_filter val
;
867 struct ib_uverbs_flow_ipv4_filter mask
;
870 struct ib_uverbs_flow_tcp_udp_filter
{
875 struct ib_uverbs_flow_spec_tcp_udp
{
877 struct ib_uverbs_flow_spec_hdr hdr
;
884 struct ib_uverbs_flow_tcp_udp_filter val
;
885 struct ib_uverbs_flow_tcp_udp_filter mask
;
888 struct ib_uverbs_flow_ipv6_filter
{
898 struct ib_uverbs_flow_spec_ipv6
{
900 struct ib_uverbs_flow_spec_hdr hdr
;
907 struct ib_uverbs_flow_ipv6_filter val
;
908 struct ib_uverbs_flow_ipv6_filter mask
;
911 struct ib_uverbs_flow_attr
{
919 /* Following are the optional layers according to user request
920 * struct ib_flow_spec_xxx
921 * struct ib_flow_spec_yyy
923 struct ib_uverbs_flow_spec_hdr flow_specs
[0];
926 struct ib_uverbs_create_flow
{
929 struct ib_uverbs_flow_attr flow_attr
;
932 struct ib_uverbs_create_flow_resp
{
937 struct ib_uverbs_destroy_flow
{
942 struct ib_uverbs_create_srq
{
949 __u64 driver_data
[0];
952 struct ib_uverbs_create_xsrq
{
963 __u64 driver_data
[0];
966 struct ib_uverbs_create_srq_resp
{
973 struct ib_uverbs_modify_srq
{
978 __u64 driver_data
[0];
981 struct ib_uverbs_query_srq
{
985 __u64 driver_data
[0];
988 struct ib_uverbs_query_srq_resp
{
995 struct ib_uverbs_destroy_srq
{
1001 struct ib_uverbs_destroy_srq_resp
{
1002 __u32 events_reported
;
1005 struct ib_uverbs_ex_create_wq
{
1015 struct ib_uverbs_ex_create_wq_resp
{
1017 __u32 response_length
;
1024 struct ib_uverbs_ex_destroy_wq
{
1029 struct ib_uverbs_ex_destroy_wq_resp
{
1031 __u32 response_length
;
1032 __u32 events_reported
;
1036 struct ib_uverbs_ex_modify_wq
{
1040 __u32 curr_wq_state
;
1043 /* Prevent memory allocation rather than max expected size */
1044 #define IB_USER_VERBS_MAX_LOG_IND_TBL_SIZE 0x0d
1045 struct ib_uverbs_ex_create_rwq_ind_table
{
1047 __u32 log_ind_tbl_size
;
1048 /* Following are the wq handles according to log_ind_tbl_size
1052 __u32 wq_handles
[0];
1055 struct ib_uverbs_ex_create_rwq_ind_table_resp
{
1057 __u32 response_length
;
1058 __u32 ind_tbl_handle
;
1062 struct ib_uverbs_ex_destroy_rwq_ind_table
{
1064 __u32 ind_tbl_handle
;
1067 #endif /* IB_USER_VERBS_H */