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_FLOW
= IB_USER_VERBS_CMD_THRESHOLD
,
96 IB_USER_VERBS_EX_CMD_DESTROY_FLOW
,
100 * Make sure that all structs defined in this file remain laid out so
101 * that they pack the same way on 32-bit and 64-bit architectures (to
102 * avoid incompatibility between 32-bit userspace and 64-bit kernels).
104 * - Do not use pointer types -- pass pointers in __u64 instead.
105 * - Make sure that any structure larger than 4 bytes is padded to a
106 * multiple of 8 bytes. Otherwise the structure size will be
107 * different between 32-bit and 64-bit architectures.
110 struct ib_uverbs_async_event_desc
{
112 __u32 event_type
; /* enum ib_event_type */
116 struct ib_uverbs_comp_event_desc
{
121 * All commands from userspace should start with a __u32 command field
122 * followed by __u16 in_words and out_words fields (which give the
123 * length of the command block and response buffer if any in 32-bit
124 * words). The kernel driver will read these fields first and read
125 * the rest of the command struct based on these value.
128 #define IB_USER_VERBS_CMD_COMMAND_MASK 0xff
129 #define IB_USER_VERBS_CMD_FLAGS_MASK 0xff000000u
130 #define IB_USER_VERBS_CMD_FLAGS_SHIFT 24
132 #define IB_USER_VERBS_CMD_FLAG_EXTENDED 0x80
134 struct ib_uverbs_cmd_hdr
{
140 struct ib_uverbs_ex_cmd_hdr
{
142 __u16 provider_in_words
;
143 __u16 provider_out_words
;
144 __u32 cmd_hdr_reserved
;
147 struct ib_uverbs_get_context
{
149 __u64 driver_data
[0];
152 struct ib_uverbs_get_context_resp
{
154 __u32 num_comp_vectors
;
157 struct ib_uverbs_query_device
{
159 __u64 driver_data
[0];
162 struct ib_uverbs_query_device_resp
{
165 __be64 sys_image_guid
;
169 __u32 vendor_part_id
;
173 __u32 device_cap_flags
;
180 __u32 max_qp_rd_atom
;
181 __u32 max_ee_rd_atom
;
182 __u32 max_res_rd_atom
;
183 __u32 max_qp_init_rd_atom
;
184 __u32 max_ee_init_rd_atom
;
189 __u32 max_raw_ipv6_qp
;
190 __u32 max_raw_ethy_qp
;
192 __u32 max_mcast_qp_attach
;
193 __u32 max_total_mcast_qp_attach
;
196 __u32 max_map_per_fmr
;
201 __u8 local_ca_ack_delay
;
206 struct ib_uverbs_ex_query_device
{
211 struct ib_uverbs_odp_caps
{
217 } per_transport_caps
;
221 struct ib_uverbs_ex_query_device_resp
{
222 struct ib_uverbs_query_device_resp base
;
224 __u32 response_length
;
225 struct ib_uverbs_odp_caps odp_caps
;
226 __u64 timestamp_mask
;
227 __u64 hca_core_clock
; /* in KHZ */
230 struct ib_uverbs_query_port
{
234 __u64 driver_data
[0];
237 struct ib_uverbs_query_port_resp
{
238 __u32 port_cap_flags
;
241 __u32 qkey_viol_cntr
;
253 __u8 init_type_reply
;
261 struct ib_uverbs_alloc_pd
{
263 __u64 driver_data
[0];
266 struct ib_uverbs_alloc_pd_resp
{
270 struct ib_uverbs_dealloc_pd
{
274 struct ib_uverbs_open_xrcd
{
278 __u64 driver_data
[0];
281 struct ib_uverbs_open_xrcd_resp
{
285 struct ib_uverbs_close_xrcd
{
289 struct ib_uverbs_reg_mr
{
296 __u64 driver_data
[0];
299 struct ib_uverbs_reg_mr_resp
{
305 struct ib_uverbs_rereg_mr
{
316 struct ib_uverbs_rereg_mr_resp
{
321 struct ib_uverbs_dereg_mr
{
325 struct ib_uverbs_alloc_mw
{
332 struct ib_uverbs_alloc_mw_resp
{
337 struct ib_uverbs_dealloc_mw
{
341 struct ib_uverbs_create_comp_channel
{
345 struct ib_uverbs_create_comp_channel_resp
{
349 struct ib_uverbs_create_cq
{
356 __u64 driver_data
[0];
359 struct ib_uverbs_ex_create_cq
{
369 struct ib_uverbs_create_cq_resp
{
374 struct ib_uverbs_ex_create_cq_resp
{
375 struct ib_uverbs_create_cq_resp base
;
377 __u32 response_length
;
380 struct ib_uverbs_resize_cq
{
384 __u64 driver_data
[0];
387 struct ib_uverbs_resize_cq_resp
{
390 __u64 driver_data
[0];
393 struct ib_uverbs_poll_cq
{
399 struct ib_uverbs_wc
{
407 __u32 invalidate_rkey
;
420 struct ib_uverbs_poll_cq_resp
{
423 struct ib_uverbs_wc wc
[0];
426 struct ib_uverbs_req_notify_cq
{
428 __u32 solicited_only
;
431 struct ib_uverbs_destroy_cq
{
437 struct ib_uverbs_destroy_cq_resp
{
438 __u32 comp_events_reported
;
439 __u32 async_events_reported
;
442 struct ib_uverbs_global_route
{
451 struct ib_uverbs_ah_attr
{
452 struct ib_uverbs_global_route grh
;
462 struct ib_uverbs_qp_attr
{
467 __u32 path_mig_state
;
472 __u32 qp_access_flags
;
474 struct ib_uverbs_ah_attr ah_attr
;
475 struct ib_uverbs_ah_attr alt_ah_attr
;
482 __u32 max_inline_data
;
485 __u16 alt_pkey_index
;
486 __u8 en_sqd_async_notify
;
489 __u8 max_dest_rd_atomic
;
500 struct ib_uverbs_create_qp
{
504 __u32 send_cq_handle
;
505 __u32 recv_cq_handle
;
511 __u32 max_inline_data
;
516 __u64 driver_data
[0];
519 struct ib_uverbs_open_qp
{
526 __u64 driver_data
[0];
529 /* also used for open response */
530 struct ib_uverbs_create_qp_resp
{
537 __u32 max_inline_data
;
542 * This struct needs to remain a multiple of 8 bytes to keep the
543 * alignment of the modify QP parameters.
545 struct ib_uverbs_qp_dest
{
560 struct ib_uverbs_query_qp
{
564 __u64 driver_data
[0];
567 struct ib_uverbs_query_qp_resp
{
568 struct ib_uverbs_qp_dest dest
;
569 struct ib_uverbs_qp_dest alt_dest
;
574 __u32 max_inline_data
;
579 __u32 qp_access_flags
;
581 __u16 alt_pkey_index
;
588 __u8 max_dest_rd_atomic
;
598 __u64 driver_data
[0];
601 struct ib_uverbs_modify_qp
{
602 struct ib_uverbs_qp_dest dest
;
603 struct ib_uverbs_qp_dest alt_dest
;
610 __u32 qp_access_flags
;
612 __u16 alt_pkey_index
;
617 __u8 en_sqd_async_notify
;
619 __u8 max_dest_rd_atomic
;
628 __u64 driver_data
[0];
631 struct ib_uverbs_modify_qp_resp
{
634 struct ib_uverbs_destroy_qp
{
640 struct ib_uverbs_destroy_qp_resp
{
641 __u32 events_reported
;
645 * The ib_uverbs_sge structure isn't used anywhere, since we assume
646 * the ib_sge structure is packed the same way on 32-bit and 64-bit
647 * architectures in both kernel and user space. It's just here to
650 struct ib_uverbs_sge
{
656 struct ib_uverbs_send_wr
{
663 __u32 invalidate_rkey
;
687 struct ib_uverbs_post_send
{
693 struct ib_uverbs_send_wr send_wr
[0];
696 struct ib_uverbs_post_send_resp
{
700 struct ib_uverbs_recv_wr
{
706 struct ib_uverbs_post_recv
{
712 struct ib_uverbs_recv_wr recv_wr
[0];
715 struct ib_uverbs_post_recv_resp
{
719 struct ib_uverbs_post_srq_recv
{
725 struct ib_uverbs_recv_wr recv
[0];
728 struct ib_uverbs_post_srq_recv_resp
{
732 struct ib_uverbs_create_ah
{
737 struct ib_uverbs_ah_attr attr
;
740 struct ib_uverbs_create_ah_resp
{
744 struct ib_uverbs_destroy_ah
{
748 struct ib_uverbs_attach_mcast
{
753 __u64 driver_data
[0];
756 struct ib_uverbs_detach_mcast
{
761 __u64 driver_data
[0];
764 struct ib_uverbs_flow_spec_hdr
{
768 /* followed by flow_spec */
769 __u64 flow_spec_data
[0];
772 struct ib_uverbs_flow_eth_filter
{
779 struct ib_uverbs_flow_spec_eth
{
781 struct ib_uverbs_flow_spec_hdr hdr
;
788 struct ib_uverbs_flow_eth_filter val
;
789 struct ib_uverbs_flow_eth_filter mask
;
792 struct ib_uverbs_flow_ipv4_filter
{
797 struct ib_uverbs_flow_spec_ipv4
{
799 struct ib_uverbs_flow_spec_hdr hdr
;
806 struct ib_uverbs_flow_ipv4_filter val
;
807 struct ib_uverbs_flow_ipv4_filter mask
;
810 struct ib_uverbs_flow_tcp_udp_filter
{
815 struct ib_uverbs_flow_spec_tcp_udp
{
817 struct ib_uverbs_flow_spec_hdr hdr
;
824 struct ib_uverbs_flow_tcp_udp_filter val
;
825 struct ib_uverbs_flow_tcp_udp_filter mask
;
828 struct ib_uverbs_flow_attr
{
836 /* Following are the optional layers according to user request
837 * struct ib_flow_spec_xxx
838 * struct ib_flow_spec_yyy
840 struct ib_uverbs_flow_spec_hdr flow_specs
[0];
843 struct ib_uverbs_create_flow
{
846 struct ib_uverbs_flow_attr flow_attr
;
849 struct ib_uverbs_create_flow_resp
{
854 struct ib_uverbs_destroy_flow
{
859 struct ib_uverbs_create_srq
{
866 __u64 driver_data
[0];
869 struct ib_uverbs_create_xsrq
{
880 __u64 driver_data
[0];
883 struct ib_uverbs_create_srq_resp
{
890 struct ib_uverbs_modify_srq
{
895 __u64 driver_data
[0];
898 struct ib_uverbs_query_srq
{
902 __u64 driver_data
[0];
905 struct ib_uverbs_query_srq_resp
{
912 struct ib_uverbs_destroy_srq
{
918 struct ib_uverbs_destroy_srq_resp
{
919 __u32 events_reported
;
922 #endif /* IB_USER_VERBS_H */