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_ex_query_device_resp
{
228 struct ib_uverbs_query_device_resp base
;
230 __u32 response_length
;
231 struct ib_uverbs_odp_caps odp_caps
;
232 __u64 timestamp_mask
;
233 __u64 hca_core_clock
; /* in KHZ */
234 __u64 device_cap_flags_ex
;
237 struct ib_uverbs_query_port
{
241 __u64 driver_data
[0];
244 struct ib_uverbs_query_port_resp
{
245 __u32 port_cap_flags
;
248 __u32 qkey_viol_cntr
;
260 __u8 init_type_reply
;
268 struct ib_uverbs_alloc_pd
{
270 __u64 driver_data
[0];
273 struct ib_uverbs_alloc_pd_resp
{
277 struct ib_uverbs_dealloc_pd
{
281 struct ib_uverbs_open_xrcd
{
285 __u64 driver_data
[0];
288 struct ib_uverbs_open_xrcd_resp
{
292 struct ib_uverbs_close_xrcd
{
296 struct ib_uverbs_reg_mr
{
303 __u64 driver_data
[0];
306 struct ib_uverbs_reg_mr_resp
{
312 struct ib_uverbs_rereg_mr
{
323 struct ib_uverbs_rereg_mr_resp
{
328 struct ib_uverbs_dereg_mr
{
332 struct ib_uverbs_alloc_mw
{
339 struct ib_uverbs_alloc_mw_resp
{
344 struct ib_uverbs_dealloc_mw
{
348 struct ib_uverbs_create_comp_channel
{
352 struct ib_uverbs_create_comp_channel_resp
{
356 struct ib_uverbs_create_cq
{
363 __u64 driver_data
[0];
366 struct ib_uverbs_ex_create_cq
{
376 struct ib_uverbs_create_cq_resp
{
381 struct ib_uverbs_ex_create_cq_resp
{
382 struct ib_uverbs_create_cq_resp base
;
384 __u32 response_length
;
387 struct ib_uverbs_resize_cq
{
391 __u64 driver_data
[0];
394 struct ib_uverbs_resize_cq_resp
{
397 __u64 driver_data
[0];
400 struct ib_uverbs_poll_cq
{
406 struct ib_uverbs_wc
{
414 __u32 invalidate_rkey
;
427 struct ib_uverbs_poll_cq_resp
{
430 struct ib_uverbs_wc wc
[0];
433 struct ib_uverbs_req_notify_cq
{
435 __u32 solicited_only
;
438 struct ib_uverbs_destroy_cq
{
444 struct ib_uverbs_destroy_cq_resp
{
445 __u32 comp_events_reported
;
446 __u32 async_events_reported
;
449 struct ib_uverbs_global_route
{
458 struct ib_uverbs_ah_attr
{
459 struct ib_uverbs_global_route grh
;
469 struct ib_uverbs_qp_attr
{
474 __u32 path_mig_state
;
479 __u32 qp_access_flags
;
481 struct ib_uverbs_ah_attr ah_attr
;
482 struct ib_uverbs_ah_attr alt_ah_attr
;
489 __u32 max_inline_data
;
492 __u16 alt_pkey_index
;
493 __u8 en_sqd_async_notify
;
496 __u8 max_dest_rd_atomic
;
507 struct ib_uverbs_create_qp
{
511 __u32 send_cq_handle
;
512 __u32 recv_cq_handle
;
518 __u32 max_inline_data
;
523 __u64 driver_data
[0];
526 enum ib_uverbs_create_qp_mask
{
527 IB_UVERBS_CREATE_QP_MASK_IND_TABLE
= 1UL << 0,
531 IB_UVERBS_CREATE_QP_SUP_COMP_MASK
= IB_UVERBS_CREATE_QP_MASK_IND_TABLE
,
534 struct ib_uverbs_ex_create_qp
{
537 __u32 send_cq_handle
;
538 __u32 recv_cq_handle
;
544 __u32 max_inline_data
;
551 __u32 rwq_ind_tbl_handle
;
555 struct ib_uverbs_open_qp
{
562 __u64 driver_data
[0];
565 /* also used for open response */
566 struct ib_uverbs_create_qp_resp
{
573 __u32 max_inline_data
;
577 struct ib_uverbs_ex_create_qp_resp
{
578 struct ib_uverbs_create_qp_resp base
;
580 __u32 response_length
;
584 * This struct needs to remain a multiple of 8 bytes to keep the
585 * alignment of the modify QP parameters.
587 struct ib_uverbs_qp_dest
{
602 struct ib_uverbs_query_qp
{
606 __u64 driver_data
[0];
609 struct ib_uverbs_query_qp_resp
{
610 struct ib_uverbs_qp_dest dest
;
611 struct ib_uverbs_qp_dest alt_dest
;
616 __u32 max_inline_data
;
621 __u32 qp_access_flags
;
623 __u16 alt_pkey_index
;
630 __u8 max_dest_rd_atomic
;
640 __u64 driver_data
[0];
643 struct ib_uverbs_modify_qp
{
644 struct ib_uverbs_qp_dest dest
;
645 struct ib_uverbs_qp_dest alt_dest
;
652 __u32 qp_access_flags
;
654 __u16 alt_pkey_index
;
659 __u8 en_sqd_async_notify
;
661 __u8 max_dest_rd_atomic
;
670 __u64 driver_data
[0];
673 struct ib_uverbs_modify_qp_resp
{
676 struct ib_uverbs_destroy_qp
{
682 struct ib_uverbs_destroy_qp_resp
{
683 __u32 events_reported
;
687 * The ib_uverbs_sge structure isn't used anywhere, since we assume
688 * the ib_sge structure is packed the same way on 32-bit and 64-bit
689 * architectures in both kernel and user space. It's just here to
692 struct ib_uverbs_sge
{
698 struct ib_uverbs_send_wr
{
705 __u32 invalidate_rkey
;
729 struct ib_uverbs_post_send
{
735 struct ib_uverbs_send_wr send_wr
[0];
738 struct ib_uverbs_post_send_resp
{
742 struct ib_uverbs_recv_wr
{
748 struct ib_uverbs_post_recv
{
754 struct ib_uverbs_recv_wr recv_wr
[0];
757 struct ib_uverbs_post_recv_resp
{
761 struct ib_uverbs_post_srq_recv
{
767 struct ib_uverbs_recv_wr recv
[0];
770 struct ib_uverbs_post_srq_recv_resp
{
774 struct ib_uverbs_create_ah
{
779 struct ib_uverbs_ah_attr attr
;
782 struct ib_uverbs_create_ah_resp
{
786 struct ib_uverbs_destroy_ah
{
790 struct ib_uverbs_attach_mcast
{
795 __u64 driver_data
[0];
798 struct ib_uverbs_detach_mcast
{
803 __u64 driver_data
[0];
806 struct ib_uverbs_flow_spec_hdr
{
810 /* followed by flow_spec */
811 __u64 flow_spec_data
[0];
814 struct ib_uverbs_flow_eth_filter
{
821 struct ib_uverbs_flow_spec_eth
{
823 struct ib_uverbs_flow_spec_hdr hdr
;
830 struct ib_uverbs_flow_eth_filter val
;
831 struct ib_uverbs_flow_eth_filter mask
;
834 struct ib_uverbs_flow_ipv4_filter
{
839 struct ib_uverbs_flow_spec_ipv4
{
841 struct ib_uverbs_flow_spec_hdr hdr
;
848 struct ib_uverbs_flow_ipv4_filter val
;
849 struct ib_uverbs_flow_ipv4_filter mask
;
852 struct ib_uverbs_flow_tcp_udp_filter
{
857 struct ib_uverbs_flow_spec_tcp_udp
{
859 struct ib_uverbs_flow_spec_hdr hdr
;
866 struct ib_uverbs_flow_tcp_udp_filter val
;
867 struct ib_uverbs_flow_tcp_udp_filter mask
;
870 struct ib_uverbs_flow_ipv6_filter
{
875 struct ib_uverbs_flow_spec_ipv6
{
877 struct ib_uverbs_flow_spec_hdr hdr
;
884 struct ib_uverbs_flow_ipv6_filter val
;
885 struct ib_uverbs_flow_ipv6_filter mask
;
888 struct ib_uverbs_flow_attr
{
896 /* Following are the optional layers according to user request
897 * struct ib_flow_spec_xxx
898 * struct ib_flow_spec_yyy
900 struct ib_uverbs_flow_spec_hdr flow_specs
[0];
903 struct ib_uverbs_create_flow
{
906 struct ib_uverbs_flow_attr flow_attr
;
909 struct ib_uverbs_create_flow_resp
{
914 struct ib_uverbs_destroy_flow
{
919 struct ib_uverbs_create_srq
{
926 __u64 driver_data
[0];
929 struct ib_uverbs_create_xsrq
{
940 __u64 driver_data
[0];
943 struct ib_uverbs_create_srq_resp
{
950 struct ib_uverbs_modify_srq
{
955 __u64 driver_data
[0];
958 struct ib_uverbs_query_srq
{
962 __u64 driver_data
[0];
965 struct ib_uverbs_query_srq_resp
{
972 struct ib_uverbs_destroy_srq
{
978 struct ib_uverbs_destroy_srq_resp
{
979 __u32 events_reported
;
982 struct ib_uverbs_ex_create_wq
{
992 struct ib_uverbs_ex_create_wq_resp
{
994 __u32 response_length
;
1001 struct ib_uverbs_ex_destroy_wq
{
1006 struct ib_uverbs_ex_destroy_wq_resp
{
1008 __u32 response_length
;
1009 __u32 events_reported
;
1013 struct ib_uverbs_ex_modify_wq
{
1017 __u32 curr_wq_state
;
1020 /* Prevent memory allocation rather than max expected size */
1021 #define IB_USER_VERBS_MAX_LOG_IND_TBL_SIZE 0x0d
1022 struct ib_uverbs_ex_create_rwq_ind_table
{
1024 __u32 log_ind_tbl_size
;
1025 /* Following are the wq handles according to log_ind_tbl_size
1029 __u32 wq_handles
[0];
1032 struct ib_uverbs_ex_create_rwq_ind_table_resp
{
1034 __u32 response_length
;
1035 __u32 ind_tbl_handle
;
1039 struct ib_uverbs_ex_destroy_rwq_ind_table
{
1041 __u32 ind_tbl_handle
;
1044 #endif /* IB_USER_VERBS_H */