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_CREATE_FLOW = IB_USER_VERBS_CMD_THRESHOLD,
94 IB_USER_VERBS_EX_CMD_DESTROY_FLOW
98 * Make sure that all structs defined in this file remain laid out so
99 * that they pack the same way on 32-bit and 64-bit architectures (to
100 * avoid incompatibility between 32-bit userspace and 64-bit kernels).
102 * - Do not use pointer types -- pass pointers in __u64 instead.
103 * - Make sure that any structure larger than 4 bytes is padded to a
104 * multiple of 8 bytes. Otherwise the structure size will be
105 * different between 32-bit and 64-bit architectures.
108 struct ib_uverbs_async_event_desc {
110 __u32 event_type; /* enum ib_event_type */
114 struct ib_uverbs_comp_event_desc {
119 * All commands from userspace should start with a __u32 command field
120 * followed by __u16 in_words and out_words fields (which give the
121 * length of the command block and response buffer if any in 32-bit
122 * words). The kernel driver will read these fields first and read
123 * the rest of the command struct based on these value.
126 #define IB_USER_VERBS_CMD_COMMAND_MASK 0xff
127 #define IB_USER_VERBS_CMD_FLAGS_MASK 0xff000000u
128 #define IB_USER_VERBS_CMD_FLAGS_SHIFT 24
130 #define IB_USER_VERBS_CMD_FLAG_EXTENDED 0x80
132 struct ib_uverbs_cmd_hdr {
138 struct ib_uverbs_ex_cmd_hdr {
140 __u16 provider_in_words;
141 __u16 provider_out_words;
142 __u32 cmd_hdr_reserved;
145 struct ib_uverbs_get_context {
147 __u64 driver_data[0];
150 struct ib_uverbs_get_context_resp {
152 __u32 num_comp_vectors;
155 struct ib_uverbs_query_device {
157 __u64 driver_data[0];
160 struct ib_uverbs_query_device_resp {
163 __be64 sys_image_guid;
167 __u32 vendor_part_id;
171 __u32 device_cap_flags;
178 __u32 max_qp_rd_atom;
179 __u32 max_ee_rd_atom;
180 __u32 max_res_rd_atom;
181 __u32 max_qp_init_rd_atom;
182 __u32 max_ee_init_rd_atom;
187 __u32 max_raw_ipv6_qp;
188 __u32 max_raw_ethy_qp;
190 __u32 max_mcast_qp_attach;
191 __u32 max_total_mcast_qp_attach;
194 __u32 max_map_per_fmr;
199 __u8 local_ca_ack_delay;
204 struct ib_uverbs_query_port {
208 __u64 driver_data[0];
211 struct ib_uverbs_query_port_resp {
212 __u32 port_cap_flags;
215 __u32 qkey_viol_cntr;
227 __u8 init_type_reply;
235 struct ib_uverbs_alloc_pd {
237 __u64 driver_data[0];
240 struct ib_uverbs_alloc_pd_resp {
244 struct ib_uverbs_dealloc_pd {
248 struct ib_uverbs_open_xrcd {
252 __u64 driver_data[0];
255 struct ib_uverbs_open_xrcd_resp {
259 struct ib_uverbs_close_xrcd {
263 struct ib_uverbs_reg_mr {
270 __u64 driver_data[0];
273 struct ib_uverbs_reg_mr_resp {
279 struct ib_uverbs_dereg_mr {
283 struct ib_uverbs_alloc_mw {
290 struct ib_uverbs_alloc_mw_resp {
295 struct ib_uverbs_dealloc_mw {
299 struct ib_uverbs_create_comp_channel {
303 struct ib_uverbs_create_comp_channel_resp {
307 struct ib_uverbs_create_cq {
314 __u64 driver_data[0];
317 struct ib_uverbs_create_cq_resp {
322 struct ib_uverbs_resize_cq {
326 __u64 driver_data[0];
329 struct ib_uverbs_resize_cq_resp {
332 __u64 driver_data[0];
335 struct ib_uverbs_poll_cq {
341 struct ib_uverbs_wc {
349 __u32 invalidate_rkey;
362 struct ib_uverbs_poll_cq_resp {
365 struct ib_uverbs_wc wc[0];
368 struct ib_uverbs_req_notify_cq {
370 __u32 solicited_only;
373 struct ib_uverbs_destroy_cq {
379 struct ib_uverbs_destroy_cq_resp {
380 __u32 comp_events_reported;
381 __u32 async_events_reported;
384 struct ib_uverbs_global_route {
393 struct ib_uverbs_ah_attr {
394 struct ib_uverbs_global_route grh;
404 struct ib_uverbs_qp_attr {
409 __u32 path_mig_state;
414 __u32 qp_access_flags;
416 struct ib_uverbs_ah_attr ah_attr;
417 struct ib_uverbs_ah_attr alt_ah_attr;
424 __u32 max_inline_data;
427 __u16 alt_pkey_index;
428 __u8 en_sqd_async_notify;
431 __u8 max_dest_rd_atomic;
442 struct ib_uverbs_create_qp {
446 __u32 send_cq_handle;
447 __u32 recv_cq_handle;
453 __u32 max_inline_data;
458 __u64 driver_data[0];
461 struct ib_uverbs_open_qp {
468 __u64 driver_data[0];
471 /* also used for open response */
472 struct ib_uverbs_create_qp_resp {
479 __u32 max_inline_data;
484 * This struct needs to remain a multiple of 8 bytes to keep the
485 * alignment of the modify QP parameters.
487 struct ib_uverbs_qp_dest {
502 struct ib_uverbs_query_qp {
506 __u64 driver_data[0];
509 struct ib_uverbs_query_qp_resp {
510 struct ib_uverbs_qp_dest dest;
511 struct ib_uverbs_qp_dest alt_dest;
516 __u32 max_inline_data;
521 __u32 qp_access_flags;
523 __u16 alt_pkey_index;
530 __u8 max_dest_rd_atomic;
540 __u64 driver_data[0];
543 struct ib_uverbs_modify_qp {
544 struct ib_uverbs_qp_dest dest;
545 struct ib_uverbs_qp_dest alt_dest;
552 __u32 qp_access_flags;
554 __u16 alt_pkey_index;
559 __u8 en_sqd_async_notify;
561 __u8 max_dest_rd_atomic;
570 __u64 driver_data[0];
573 struct ib_uverbs_modify_qp_resp {
576 struct ib_uverbs_destroy_qp {
582 struct ib_uverbs_destroy_qp_resp {
583 __u32 events_reported;
587 * The ib_uverbs_sge structure isn't used anywhere, since we assume
588 * the ib_sge structure is packed the same way on 32-bit and 64-bit
589 * architectures in both kernel and user space. It's just here to
592 struct ib_uverbs_sge {
598 struct ib_uverbs_send_wr {
605 __u32 invalidate_rkey;
629 struct ib_uverbs_post_send {
635 struct ib_uverbs_send_wr send_wr[0];
638 struct ib_uverbs_post_send_resp {
642 struct ib_uverbs_recv_wr {
648 struct ib_uverbs_post_recv {
654 struct ib_uverbs_recv_wr recv_wr[0];
657 struct ib_uverbs_post_recv_resp {
661 struct ib_uverbs_post_srq_recv {
667 struct ib_uverbs_recv_wr recv[0];
670 struct ib_uverbs_post_srq_recv_resp {
674 struct ib_uverbs_create_ah {
679 struct ib_uverbs_ah_attr attr;
682 struct ib_uverbs_create_ah_resp {
686 struct ib_uverbs_destroy_ah {
690 struct ib_uverbs_attach_mcast {
695 __u64 driver_data[0];
698 struct ib_uverbs_detach_mcast {
703 __u64 driver_data[0];
706 struct ib_uverbs_flow_spec_hdr {
710 /* followed by flow_spec */
711 __u64 flow_spec_data[0];
714 struct ib_uverbs_flow_eth_filter {
721 struct ib_uverbs_flow_spec_eth {
723 struct ib_uverbs_flow_spec_hdr hdr;
730 struct ib_uverbs_flow_eth_filter val;
731 struct ib_uverbs_flow_eth_filter mask;
734 struct ib_uverbs_flow_ipv4_filter {
739 struct ib_uverbs_flow_spec_ipv4 {
741 struct ib_uverbs_flow_spec_hdr hdr;
748 struct ib_uverbs_flow_ipv4_filter val;
749 struct ib_uverbs_flow_ipv4_filter mask;
752 struct ib_uverbs_flow_tcp_udp_filter {
757 struct ib_uverbs_flow_spec_tcp_udp {
759 struct ib_uverbs_flow_spec_hdr hdr;
766 struct ib_uverbs_flow_tcp_udp_filter val;
767 struct ib_uverbs_flow_tcp_udp_filter mask;
770 struct ib_uverbs_flow_attr {
778 /* Following are the optional layers according to user request
779 * struct ib_flow_spec_xxx
780 * struct ib_flow_spec_yyy
782 struct ib_uverbs_flow_spec_hdr flow_specs[0];
785 struct ib_uverbs_create_flow {
788 struct ib_uverbs_flow_attr flow_attr;
791 struct ib_uverbs_create_flow_resp {
796 struct ib_uverbs_destroy_flow {
801 struct ib_uverbs_create_srq {
808 __u64 driver_data[0];
811 struct ib_uverbs_create_xsrq {
822 __u64 driver_data[0];
825 struct ib_uverbs_create_srq_resp {
832 struct ib_uverbs_modify_srq {
837 __u64 driver_data[0];
840 struct ib_uverbs_query_srq {
844 __u64 driver_data[0];
847 struct ib_uverbs_query_srq_resp {
854 struct ib_uverbs_destroy_srq {
860 struct ib_uverbs_destroy_srq_resp {
861 __u32 events_reported;
864 #endif /* IB_USER_VERBS_H */