blob: 97c98c0d89b11f011032aae58599eaa8938e14b7 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Copyright (c) 2004 Mellanox Technologies Ltd. All rights reserved.
3 * Copyright (c) 2004 Infinicon Corporation. All rights reserved.
4 * Copyright (c) 2004 Intel Corporation. All rights reserved.
5 * Copyright (c) 2004 Topspin Corporation. All rights reserved.
6 * Copyright (c) 2004 Voltaire Corporation. All rights reserved.
Roland Dreier2a1d9b72005-08-10 23:03:10 -07007 * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
Roland Dreierf7c6a7b2007-03-04 16:15:11 -08008 * Copyright (c) 2005, 2006, 2007 Cisco Systems. All rights reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 *
10 * This software is available to you under a choice of one of two
11 * licenses. You may choose to be licensed under the terms of the GNU
12 * General Public License (GPL) Version 2, available from the file
13 * COPYING in the main directory of this source tree, or the
14 * OpenIB.org BSD license below:
15 *
16 * Redistribution and use in source and binary forms, with or
17 * without modification, are permitted provided that the following
18 * conditions are met:
19 *
20 * - Redistributions of source code must retain the above
21 * copyright notice, this list of conditions and the following
22 * disclaimer.
23 *
24 * - Redistributions in binary form must reproduce the above
25 * copyright notice, this list of conditions and the following
26 * disclaimer in the documentation and/or other materials
27 * provided with the distribution.
28 *
29 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
30 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
31 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
32 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
33 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
34 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
35 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
36 * SOFTWARE.
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 */
38
39#if !defined(IB_VERBS_H)
40#define IB_VERBS_H
41
42#include <linux/types.h>
43#include <linux/device.h>
Ralph Campbell9b513092006-12-12 14:27:41 -080044#include <linux/mm.h>
45#include <linux/dma-mapping.h>
Michael S. Tsirkin459d6e22007-02-04 14:11:55 -080046#include <linux/kref.h>
Dotan Barakbfb3ea12007-07-31 16:49:15 +030047#include <linux/list.h>
48#include <linux/rwsem.h>
Adrian Bunk87ae9af2007-10-30 10:35:04 +010049#include <linux/scatterlist.h>
Tejun Heof0626712010-10-19 15:24:36 +000050#include <linux/workqueue.h>
Roland Dreiere2773c02005-07-07 17:57:10 -070051
Arun Sharma600634972011-07-26 16:09:06 -070052#include <linux/atomic.h>
Roland Dreiere2773c02005-07-07 17:57:10 -070053#include <asm/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Tejun Heof0626712010-10-19 15:24:36 +000055extern struct workqueue_struct *ib_wq;
56
Linus Torvalds1da177e2005-04-16 15:20:36 -070057union ib_gid {
58 u8 raw[16];
59 struct {
Sean Hefty97f52eb2005-08-13 21:05:57 -070060 __be64 subnet_prefix;
61 __be64 interface_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 } global;
63};
64
Tom Tucker07ebafb2006-08-03 16:02:42 -050065enum rdma_node_type {
66 /* IB values map to NodeInfo:NodeType. */
67 RDMA_NODE_IB_CA = 1,
68 RDMA_NODE_IB_SWITCH,
69 RDMA_NODE_IB_ROUTER,
70 RDMA_NODE_RNIC
Linus Torvalds1da177e2005-04-16 15:20:36 -070071};
72
Tom Tucker07ebafb2006-08-03 16:02:42 -050073enum rdma_transport_type {
74 RDMA_TRANSPORT_IB,
75 RDMA_TRANSPORT_IWARP
76};
77
78enum rdma_transport_type
79rdma_node_get_transport(enum rdma_node_type node_type) __attribute_const__;
80
Eli Cohena3f5ada2010-09-27 17:51:10 -070081enum rdma_link_layer {
82 IB_LINK_LAYER_UNSPECIFIED,
83 IB_LINK_LAYER_INFINIBAND,
84 IB_LINK_LAYER_ETHERNET,
85};
86
Linus Torvalds1da177e2005-04-16 15:20:36 -070087enum ib_device_cap_flags {
88 IB_DEVICE_RESIZE_MAX_WR = 1,
89 IB_DEVICE_BAD_PKEY_CNTR = (1<<1),
90 IB_DEVICE_BAD_QKEY_CNTR = (1<<2),
91 IB_DEVICE_RAW_MULTI = (1<<3),
92 IB_DEVICE_AUTO_PATH_MIG = (1<<4),
93 IB_DEVICE_CHANGE_PHY_PORT = (1<<5),
94 IB_DEVICE_UD_AV_PORT_ENFORCE = (1<<6),
95 IB_DEVICE_CURR_QP_STATE_MOD = (1<<7),
96 IB_DEVICE_SHUTDOWN_PORT = (1<<8),
97 IB_DEVICE_INIT_TYPE = (1<<9),
98 IB_DEVICE_PORT_ACTIVE_EVENT = (1<<10),
99 IB_DEVICE_SYS_IMAGE_GUID = (1<<11),
100 IB_DEVICE_RC_RNR_NAK_GEN = (1<<12),
101 IB_DEVICE_SRQ_RESIZE = (1<<13),
102 IB_DEVICE_N_NOTIFY_CQ = (1<<14),
Steve Wise96f15c02008-07-14 23:48:53 -0700103 IB_DEVICE_LOCAL_DMA_LKEY = (1<<15),
Roland Dreier0f39cf32008-04-16 21:09:32 -0700104 IB_DEVICE_RESERVED = (1<<16), /* old SEND_W_INV */
Eli Cohene0605d92008-01-30 18:30:57 +0200105 IB_DEVICE_MEM_WINDOW = (1<<17),
106 /*
107 * Devices should set IB_DEVICE_UD_IP_SUM if they support
108 * insertion of UDP and TCP checksum on outgoing UD IPoIB
109 * messages and can verify the validity of checksum for
110 * incoming messages. Setting this flag implies that the
111 * IPoIB driver may set NETIF_F_IP_CSUM for datagram mode.
112 */
113 IB_DEVICE_UD_IP_CSUM = (1<<18),
Eli Cohenc93570f2008-04-16 21:09:27 -0700114 IB_DEVICE_UD_TSO = (1<<19),
Steve Wise00f7ec32008-07-14 23:48:45 -0700115 IB_DEVICE_MEM_MGT_EXTENSIONS = (1<<21),
Ron Livne47ee1b92008-07-14 23:48:48 -0700116 IB_DEVICE_BLOCK_MULTICAST_LOOPBACK = (1<<22),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117};
118
119enum ib_atomic_cap {
120 IB_ATOMIC_NONE,
121 IB_ATOMIC_HCA,
122 IB_ATOMIC_GLOB
123};
124
125struct ib_device_attr {
126 u64 fw_ver;
Sean Hefty97f52eb2005-08-13 21:05:57 -0700127 __be64 sys_image_guid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 u64 max_mr_size;
129 u64 page_size_cap;
130 u32 vendor_id;
131 u32 vendor_part_id;
132 u32 hw_ver;
133 int max_qp;
134 int max_qp_wr;
135 int device_cap_flags;
136 int max_sge;
137 int max_sge_rd;
138 int max_cq;
139 int max_cqe;
140 int max_mr;
141 int max_pd;
142 int max_qp_rd_atom;
143 int max_ee_rd_atom;
144 int max_res_rd_atom;
145 int max_qp_init_rd_atom;
146 int max_ee_init_rd_atom;
147 enum ib_atomic_cap atomic_cap;
Vladimir Sokolovsky5e80ba82010-04-14 17:23:01 +0300148 enum ib_atomic_cap masked_atomic_cap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 int max_ee;
150 int max_rdd;
151 int max_mw;
152 int max_raw_ipv6_qp;
153 int max_raw_ethy_qp;
154 int max_mcast_grp;
155 int max_mcast_qp_attach;
156 int max_total_mcast_qp_attach;
157 int max_ah;
158 int max_fmr;
159 int max_map_per_fmr;
160 int max_srq;
161 int max_srq_wr;
162 int max_srq_sge;
Steve Wise00f7ec32008-07-14 23:48:45 -0700163 unsigned int max_fast_reg_page_list_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 u16 max_pkeys;
165 u8 local_ca_ack_delay;
166};
167
168enum ib_mtu {
169 IB_MTU_256 = 1,
170 IB_MTU_512 = 2,
171 IB_MTU_1024 = 3,
172 IB_MTU_2048 = 4,
173 IB_MTU_4096 = 5
174};
175
176static inline int ib_mtu_enum_to_int(enum ib_mtu mtu)
177{
178 switch (mtu) {
179 case IB_MTU_256: return 256;
180 case IB_MTU_512: return 512;
181 case IB_MTU_1024: return 1024;
182 case IB_MTU_2048: return 2048;
183 case IB_MTU_4096: return 4096;
184 default: return -1;
185 }
186}
187
188enum ib_port_state {
189 IB_PORT_NOP = 0,
190 IB_PORT_DOWN = 1,
191 IB_PORT_INIT = 2,
192 IB_PORT_ARMED = 3,
193 IB_PORT_ACTIVE = 4,
194 IB_PORT_ACTIVE_DEFER = 5
195};
196
197enum ib_port_cap_flags {
198 IB_PORT_SM = 1 << 1,
199 IB_PORT_NOTICE_SUP = 1 << 2,
200 IB_PORT_TRAP_SUP = 1 << 3,
201 IB_PORT_OPT_IPD_SUP = 1 << 4,
202 IB_PORT_AUTO_MIGR_SUP = 1 << 5,
203 IB_PORT_SL_MAP_SUP = 1 << 6,
204 IB_PORT_MKEY_NVRAM = 1 << 7,
205 IB_PORT_PKEY_NVRAM = 1 << 8,
206 IB_PORT_LED_INFO_SUP = 1 << 9,
207 IB_PORT_SM_DISABLED = 1 << 10,
208 IB_PORT_SYS_IMAGE_GUID_SUP = 1 << 11,
209 IB_PORT_PKEY_SW_EXT_PORT_TRAP_SUP = 1 << 12,
Marcel Apfelbaum71eeba12011-10-05 14:21:47 +0300210 IB_PORT_EXTENDED_SPEEDS_SUP = 1 << 14,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 IB_PORT_CM_SUP = 1 << 16,
212 IB_PORT_SNMP_TUNNEL_SUP = 1 << 17,
213 IB_PORT_REINIT_SUP = 1 << 18,
214 IB_PORT_DEVICE_MGMT_SUP = 1 << 19,
215 IB_PORT_VENDOR_CLASS_SUP = 1 << 20,
216 IB_PORT_DR_NOTICE_SUP = 1 << 21,
217 IB_PORT_CAP_MASK_NOTICE_SUP = 1 << 22,
218 IB_PORT_BOOT_MGMT_SUP = 1 << 23,
219 IB_PORT_LINK_LATENCY_SUP = 1 << 24,
220 IB_PORT_CLIENT_REG_SUP = 1 << 25
221};
222
223enum ib_port_width {
224 IB_WIDTH_1X = 1,
225 IB_WIDTH_4X = 2,
226 IB_WIDTH_8X = 4,
227 IB_WIDTH_12X = 8
228};
229
230static inline int ib_width_enum_to_int(enum ib_port_width width)
231{
232 switch (width) {
233 case IB_WIDTH_1X: return 1;
234 case IB_WIDTH_4X: return 4;
235 case IB_WIDTH_8X: return 8;
236 case IB_WIDTH_12X: return 12;
237 default: return -1;
238 }
239}
240
Steve Wise7f624d02008-07-14 23:48:48 -0700241struct ib_protocol_stats {
242 /* TBD... */
243};
244
245struct iw_protocol_stats {
246 u64 ipInReceives;
247 u64 ipInHdrErrors;
248 u64 ipInTooBigErrors;
249 u64 ipInNoRoutes;
250 u64 ipInAddrErrors;
251 u64 ipInUnknownProtos;
252 u64 ipInTruncatedPkts;
253 u64 ipInDiscards;
254 u64 ipInDelivers;
255 u64 ipOutForwDatagrams;
256 u64 ipOutRequests;
257 u64 ipOutDiscards;
258 u64 ipOutNoRoutes;
259 u64 ipReasmTimeout;
260 u64 ipReasmReqds;
261 u64 ipReasmOKs;
262 u64 ipReasmFails;
263 u64 ipFragOKs;
264 u64 ipFragFails;
265 u64 ipFragCreates;
266 u64 ipInMcastPkts;
267 u64 ipOutMcastPkts;
268 u64 ipInBcastPkts;
269 u64 ipOutBcastPkts;
270
271 u64 tcpRtoAlgorithm;
272 u64 tcpRtoMin;
273 u64 tcpRtoMax;
274 u64 tcpMaxConn;
275 u64 tcpActiveOpens;
276 u64 tcpPassiveOpens;
277 u64 tcpAttemptFails;
278 u64 tcpEstabResets;
279 u64 tcpCurrEstab;
280 u64 tcpInSegs;
281 u64 tcpOutSegs;
282 u64 tcpRetransSegs;
283 u64 tcpInErrs;
284 u64 tcpOutRsts;
285};
286
287union rdma_protocol_stats {
288 struct ib_protocol_stats ib;
289 struct iw_protocol_stats iw;
290};
291
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292struct ib_port_attr {
293 enum ib_port_state state;
294 enum ib_mtu max_mtu;
295 enum ib_mtu active_mtu;
296 int gid_tbl_len;
297 u32 port_cap_flags;
298 u32 max_msg_sz;
299 u32 bad_pkey_cntr;
300 u32 qkey_viol_cntr;
301 u16 pkey_tbl_len;
302 u16 lid;
303 u16 sm_lid;
304 u8 lmc;
305 u8 max_vl_num;
306 u8 sm_sl;
307 u8 subnet_timeout;
308 u8 init_type_reply;
309 u8 active_width;
310 u8 active_speed;
311 u8 phys_state;
312};
313
314enum ib_device_modify_flags {
Roland Dreierc5bcbbb2006-02-02 09:47:14 -0800315 IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1 << 0,
316 IB_DEVICE_MODIFY_NODE_DESC = 1 << 1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317};
318
319struct ib_device_modify {
320 u64 sys_image_guid;
Roland Dreierc5bcbbb2006-02-02 09:47:14 -0800321 char node_desc[64];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322};
323
324enum ib_port_modify_flags {
325 IB_PORT_SHUTDOWN = 1,
326 IB_PORT_INIT_TYPE = (1<<2),
327 IB_PORT_RESET_QKEY_CNTR = (1<<3)
328};
329
330struct ib_port_modify {
331 u32 set_port_cap_mask;
332 u32 clr_port_cap_mask;
333 u8 init_type;
334};
335
336enum ib_event_type {
337 IB_EVENT_CQ_ERR,
338 IB_EVENT_QP_FATAL,
339 IB_EVENT_QP_REQ_ERR,
340 IB_EVENT_QP_ACCESS_ERR,
341 IB_EVENT_COMM_EST,
342 IB_EVENT_SQ_DRAINED,
343 IB_EVENT_PATH_MIG,
344 IB_EVENT_PATH_MIG_ERR,
345 IB_EVENT_DEVICE_FATAL,
346 IB_EVENT_PORT_ACTIVE,
347 IB_EVENT_PORT_ERR,
348 IB_EVENT_LID_CHANGE,
349 IB_EVENT_PKEY_CHANGE,
Roland Dreierd41fcc62005-08-18 12:23:08 -0700350 IB_EVENT_SM_CHANGE,
351 IB_EVENT_SRQ_ERR,
352 IB_EVENT_SRQ_LIMIT_REACHED,
Leonid Arsh63942c92006-06-17 20:37:35 -0700353 IB_EVENT_QP_LAST_WQE_REACHED,
Or Gerlitz761d90e2011-06-15 14:39:29 +0000354 IB_EVENT_CLIENT_REREGISTER,
355 IB_EVENT_GID_CHANGE,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356};
357
358struct ib_event {
359 struct ib_device *device;
360 union {
361 struct ib_cq *cq;
362 struct ib_qp *qp;
Roland Dreierd41fcc62005-08-18 12:23:08 -0700363 struct ib_srq *srq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 u8 port_num;
365 } element;
366 enum ib_event_type event;
367};
368
369struct ib_event_handler {
370 struct ib_device *device;
371 void (*handler)(struct ib_event_handler *, struct ib_event *);
372 struct list_head list;
373};
374
375#define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler) \
376 do { \
377 (_ptr)->device = _device; \
378 (_ptr)->handler = _handler; \
379 INIT_LIST_HEAD(&(_ptr)->list); \
380 } while (0)
381
382struct ib_global_route {
383 union ib_gid dgid;
384 u32 flow_label;
385 u8 sgid_index;
386 u8 hop_limit;
387 u8 traffic_class;
388};
389
Hal Rosenstock513789e2005-07-27 11:45:34 -0700390struct ib_grh {
Sean Hefty97f52eb2005-08-13 21:05:57 -0700391 __be32 version_tclass_flow;
392 __be16 paylen;
Hal Rosenstock513789e2005-07-27 11:45:34 -0700393 u8 next_hdr;
394 u8 hop_limit;
395 union ib_gid sgid;
396 union ib_gid dgid;
397};
398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399enum {
400 IB_MULTICAST_QPN = 0xffffff
401};
402
Harvey Harrisonf3a7c662009-02-14 22:58:35 -0800403#define IB_LID_PERMISSIVE cpu_to_be16(0xFFFF)
Sean Hefty97f52eb2005-08-13 21:05:57 -0700404
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405enum ib_ah_flags {
406 IB_AH_GRH = 1
407};
408
Jack Morgensteinbf6a9e32006-04-10 09:43:47 -0700409enum ib_rate {
410 IB_RATE_PORT_CURRENT = 0,
411 IB_RATE_2_5_GBPS = 2,
412 IB_RATE_5_GBPS = 5,
413 IB_RATE_10_GBPS = 3,
414 IB_RATE_20_GBPS = 6,
415 IB_RATE_30_GBPS = 4,
416 IB_RATE_40_GBPS = 7,
417 IB_RATE_60_GBPS = 8,
418 IB_RATE_80_GBPS = 9,
Marcel Apfelbaum71eeba12011-10-05 14:21:47 +0300419 IB_RATE_120_GBPS = 10,
420 IB_RATE_14_GBPS = 11,
421 IB_RATE_56_GBPS = 12,
422 IB_RATE_112_GBPS = 13,
423 IB_RATE_168_GBPS = 14,
424 IB_RATE_25_GBPS = 15,
425 IB_RATE_100_GBPS = 16,
426 IB_RATE_200_GBPS = 17,
427 IB_RATE_300_GBPS = 18
Jack Morgensteinbf6a9e32006-04-10 09:43:47 -0700428};
429
430/**
431 * ib_rate_to_mult - Convert the IB rate enum to a multiple of the
432 * base rate of 2.5 Gbit/sec. For example, IB_RATE_5_GBPS will be
433 * converted to 2, since 5 Gbit/sec is 2 * 2.5 Gbit/sec.
434 * @rate: rate to convert.
435 */
436int ib_rate_to_mult(enum ib_rate rate) __attribute_const__;
437
438/**
Marcel Apfelbaum71eeba12011-10-05 14:21:47 +0300439 * ib_rate_to_mbps - Convert the IB rate enum to Mbps.
440 * For example, IB_RATE_2_5_GBPS will be converted to 2500.
441 * @rate: rate to convert.
442 */
443int ib_rate_to_mbps(enum ib_rate rate) __attribute_const__;
444
445/**
Jack Morgensteinbf6a9e32006-04-10 09:43:47 -0700446 * mult_to_ib_rate - Convert a multiple of 2.5 Gbit/sec to an IB rate
447 * enum.
448 * @mult: multiple to convert.
449 */
450enum ib_rate mult_to_ib_rate(int mult) __attribute_const__;
451
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452struct ib_ah_attr {
453 struct ib_global_route grh;
454 u16 dlid;
455 u8 sl;
456 u8 src_path_bits;
457 u8 static_rate;
458 u8 ah_flags;
459 u8 port_num;
460};
461
462enum ib_wc_status {
463 IB_WC_SUCCESS,
464 IB_WC_LOC_LEN_ERR,
465 IB_WC_LOC_QP_OP_ERR,
466 IB_WC_LOC_EEC_OP_ERR,
467 IB_WC_LOC_PROT_ERR,
468 IB_WC_WR_FLUSH_ERR,
469 IB_WC_MW_BIND_ERR,
470 IB_WC_BAD_RESP_ERR,
471 IB_WC_LOC_ACCESS_ERR,
472 IB_WC_REM_INV_REQ_ERR,
473 IB_WC_REM_ACCESS_ERR,
474 IB_WC_REM_OP_ERR,
475 IB_WC_RETRY_EXC_ERR,
476 IB_WC_RNR_RETRY_EXC_ERR,
477 IB_WC_LOC_RDD_VIOL_ERR,
478 IB_WC_REM_INV_RD_REQ_ERR,
479 IB_WC_REM_ABORT_ERR,
480 IB_WC_INV_EECN_ERR,
481 IB_WC_INV_EEC_STATE_ERR,
482 IB_WC_FATAL_ERR,
483 IB_WC_RESP_TIMEOUT_ERR,
484 IB_WC_GENERAL_ERR
485};
486
487enum ib_wc_opcode {
488 IB_WC_SEND,
489 IB_WC_RDMA_WRITE,
490 IB_WC_RDMA_READ,
491 IB_WC_COMP_SWAP,
492 IB_WC_FETCH_ADD,
493 IB_WC_BIND_MW,
Eli Cohenc93570f2008-04-16 21:09:27 -0700494 IB_WC_LSO,
Steve Wise00f7ec32008-07-14 23:48:45 -0700495 IB_WC_LOCAL_INV,
496 IB_WC_FAST_REG_MR,
Vladimir Sokolovsky5e80ba82010-04-14 17:23:01 +0300497 IB_WC_MASKED_COMP_SWAP,
498 IB_WC_MASKED_FETCH_ADD,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499/*
500 * Set value of IB_WC_RECV so consumers can test if a completion is a
501 * receive by testing (opcode & IB_WC_RECV).
502 */
503 IB_WC_RECV = 1 << 7,
504 IB_WC_RECV_RDMA_WITH_IMM
505};
506
507enum ib_wc_flags {
508 IB_WC_GRH = 1,
Steve Wise00f7ec32008-07-14 23:48:45 -0700509 IB_WC_WITH_IMM = (1<<1),
510 IB_WC_WITH_INVALIDATE = (1<<2),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511};
512
513struct ib_wc {
514 u64 wr_id;
515 enum ib_wc_status status;
516 enum ib_wc_opcode opcode;
517 u32 vendor_err;
518 u32 byte_len;
Michael S. Tsirkin062dbb62006-12-31 21:09:42 +0200519 struct ib_qp *qp;
Steve Wise00f7ec32008-07-14 23:48:45 -0700520 union {
521 __be32 imm_data;
522 u32 invalidate_rkey;
523 } ex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 u32 src_qp;
525 int wc_flags;
526 u16 pkey_index;
527 u16 slid;
528 u8 sl;
529 u8 dlid_path_bits;
530 u8 port_num; /* valid only for DR SMPs on switches */
Eli Cohene0605d92008-01-30 18:30:57 +0200531 int csum_ok;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532};
533
Roland Dreiered23a722007-05-06 21:02:48 -0700534enum ib_cq_notify_flags {
535 IB_CQ_SOLICITED = 1 << 0,
536 IB_CQ_NEXT_COMP = 1 << 1,
537 IB_CQ_SOLICITED_MASK = IB_CQ_SOLICITED | IB_CQ_NEXT_COMP,
538 IB_CQ_REPORT_MISSED_EVENTS = 1 << 2,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539};
540
Roland Dreierd41fcc62005-08-18 12:23:08 -0700541enum ib_srq_attr_mask {
542 IB_SRQ_MAX_WR = 1 << 0,
543 IB_SRQ_LIMIT = 1 << 1,
544};
545
546struct ib_srq_attr {
547 u32 max_wr;
548 u32 max_sge;
549 u32 srq_limit;
550};
551
552struct ib_srq_init_attr {
553 void (*event_handler)(struct ib_event *, void *);
554 void *srq_context;
555 struct ib_srq_attr attr;
556};
557
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558struct ib_qp_cap {
559 u32 max_send_wr;
560 u32 max_recv_wr;
561 u32 max_send_sge;
562 u32 max_recv_sge;
563 u32 max_inline_data;
564};
565
566enum ib_sig_type {
567 IB_SIGNAL_ALL_WR,
568 IB_SIGNAL_REQ_WR
569};
570
571enum ib_qp_type {
572 /*
573 * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
574 * here (and in that order) since the MAD layer uses them as
575 * indices into a 2-entry table.
576 */
577 IB_QPT_SMI,
578 IB_QPT_GSI,
579
580 IB_QPT_RC,
581 IB_QPT_UC,
582 IB_QPT_UD,
583 IB_QPT_RAW_IPV6,
Aleksey Senina2ebf072010-07-04 13:55:57 +0000584 IB_QPT_RAW_ETHERTYPE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585};
586
Eli Cohenb846f252008-04-16 21:09:27 -0700587enum ib_qp_create_flags {
Ron Livne47ee1b92008-07-14 23:48:48 -0700588 IB_QP_CREATE_IPOIB_UD_LSO = 1 << 0,
589 IB_QP_CREATE_BLOCK_MULTICAST_LOOPBACK = 1 << 1,
Eli Cohenb846f252008-04-16 21:09:27 -0700590};
591
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592struct ib_qp_init_attr {
593 void (*event_handler)(struct ib_event *, void *);
594 void *qp_context;
595 struct ib_cq *send_cq;
596 struct ib_cq *recv_cq;
597 struct ib_srq *srq;
598 struct ib_qp_cap cap;
599 enum ib_sig_type sq_sig_type;
600 enum ib_qp_type qp_type;
Eli Cohenb846f252008-04-16 21:09:27 -0700601 enum ib_qp_create_flags create_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 u8 port_num; /* special QP types only */
603};
604
605enum ib_rnr_timeout {
606 IB_RNR_TIMER_655_36 = 0,
607 IB_RNR_TIMER_000_01 = 1,
608 IB_RNR_TIMER_000_02 = 2,
609 IB_RNR_TIMER_000_03 = 3,
610 IB_RNR_TIMER_000_04 = 4,
611 IB_RNR_TIMER_000_06 = 5,
612 IB_RNR_TIMER_000_08 = 6,
613 IB_RNR_TIMER_000_12 = 7,
614 IB_RNR_TIMER_000_16 = 8,
615 IB_RNR_TIMER_000_24 = 9,
616 IB_RNR_TIMER_000_32 = 10,
617 IB_RNR_TIMER_000_48 = 11,
618 IB_RNR_TIMER_000_64 = 12,
619 IB_RNR_TIMER_000_96 = 13,
620 IB_RNR_TIMER_001_28 = 14,
621 IB_RNR_TIMER_001_92 = 15,
622 IB_RNR_TIMER_002_56 = 16,
623 IB_RNR_TIMER_003_84 = 17,
624 IB_RNR_TIMER_005_12 = 18,
625 IB_RNR_TIMER_007_68 = 19,
626 IB_RNR_TIMER_010_24 = 20,
627 IB_RNR_TIMER_015_36 = 21,
628 IB_RNR_TIMER_020_48 = 22,
629 IB_RNR_TIMER_030_72 = 23,
630 IB_RNR_TIMER_040_96 = 24,
631 IB_RNR_TIMER_061_44 = 25,
632 IB_RNR_TIMER_081_92 = 26,
633 IB_RNR_TIMER_122_88 = 27,
634 IB_RNR_TIMER_163_84 = 28,
635 IB_RNR_TIMER_245_76 = 29,
636 IB_RNR_TIMER_327_68 = 30,
637 IB_RNR_TIMER_491_52 = 31
638};
639
640enum ib_qp_attr_mask {
641 IB_QP_STATE = 1,
642 IB_QP_CUR_STATE = (1<<1),
643 IB_QP_EN_SQD_ASYNC_NOTIFY = (1<<2),
644 IB_QP_ACCESS_FLAGS = (1<<3),
645 IB_QP_PKEY_INDEX = (1<<4),
646 IB_QP_PORT = (1<<5),
647 IB_QP_QKEY = (1<<6),
648 IB_QP_AV = (1<<7),
649 IB_QP_PATH_MTU = (1<<8),
650 IB_QP_TIMEOUT = (1<<9),
651 IB_QP_RETRY_CNT = (1<<10),
652 IB_QP_RNR_RETRY = (1<<11),
653 IB_QP_RQ_PSN = (1<<12),
654 IB_QP_MAX_QP_RD_ATOMIC = (1<<13),
655 IB_QP_ALT_PATH = (1<<14),
656 IB_QP_MIN_RNR_TIMER = (1<<15),
657 IB_QP_SQ_PSN = (1<<16),
658 IB_QP_MAX_DEST_RD_ATOMIC = (1<<17),
659 IB_QP_PATH_MIG_STATE = (1<<18),
660 IB_QP_CAP = (1<<19),
661 IB_QP_DEST_QPN = (1<<20)
662};
663
664enum ib_qp_state {
665 IB_QPS_RESET,
666 IB_QPS_INIT,
667 IB_QPS_RTR,
668 IB_QPS_RTS,
669 IB_QPS_SQD,
670 IB_QPS_SQE,
671 IB_QPS_ERR
672};
673
674enum ib_mig_state {
675 IB_MIG_MIGRATED,
676 IB_MIG_REARM,
677 IB_MIG_ARMED
678};
679
680struct ib_qp_attr {
681 enum ib_qp_state qp_state;
682 enum ib_qp_state cur_qp_state;
683 enum ib_mtu path_mtu;
684 enum ib_mig_state path_mig_state;
685 u32 qkey;
686 u32 rq_psn;
687 u32 sq_psn;
688 u32 dest_qp_num;
689 int qp_access_flags;
690 struct ib_qp_cap cap;
691 struct ib_ah_attr ah_attr;
692 struct ib_ah_attr alt_ah_attr;
693 u16 pkey_index;
694 u16 alt_pkey_index;
695 u8 en_sqd_async_notify;
696 u8 sq_draining;
697 u8 max_rd_atomic;
698 u8 max_dest_rd_atomic;
699 u8 min_rnr_timer;
700 u8 port_num;
701 u8 timeout;
702 u8 retry_cnt;
703 u8 rnr_retry;
704 u8 alt_port_num;
705 u8 alt_timeout;
706};
707
708enum ib_wr_opcode {
709 IB_WR_RDMA_WRITE,
710 IB_WR_RDMA_WRITE_WITH_IMM,
711 IB_WR_SEND,
712 IB_WR_SEND_WITH_IMM,
713 IB_WR_RDMA_READ,
714 IB_WR_ATOMIC_CMP_AND_SWP,
Eli Cohenc93570f2008-04-16 21:09:27 -0700715 IB_WR_ATOMIC_FETCH_AND_ADD,
Roland Dreier0f39cf32008-04-16 21:09:32 -0700716 IB_WR_LSO,
717 IB_WR_SEND_WITH_INV,
Steve Wise00f7ec32008-07-14 23:48:45 -0700718 IB_WR_RDMA_READ_WITH_INV,
719 IB_WR_LOCAL_INV,
720 IB_WR_FAST_REG_MR,
Vladimir Sokolovsky5e80ba82010-04-14 17:23:01 +0300721 IB_WR_MASKED_ATOMIC_CMP_AND_SWP,
722 IB_WR_MASKED_ATOMIC_FETCH_AND_ADD,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723};
724
725enum ib_send_flags {
726 IB_SEND_FENCE = 1,
727 IB_SEND_SIGNALED = (1<<1),
728 IB_SEND_SOLICITED = (1<<2),
Eli Cohene0605d92008-01-30 18:30:57 +0200729 IB_SEND_INLINE = (1<<3),
730 IB_SEND_IP_CSUM = (1<<4)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731};
732
733struct ib_sge {
734 u64 addr;
735 u32 length;
736 u32 lkey;
737};
738
Steve Wise00f7ec32008-07-14 23:48:45 -0700739struct ib_fast_reg_page_list {
740 struct ib_device *device;
741 u64 *page_list;
742 unsigned int max_page_list_len;
743};
744
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745struct ib_send_wr {
746 struct ib_send_wr *next;
747 u64 wr_id;
748 struct ib_sge *sg_list;
749 int num_sge;
750 enum ib_wr_opcode opcode;
751 int send_flags;
Roland Dreier0f39cf32008-04-16 21:09:32 -0700752 union {
753 __be32 imm_data;
754 u32 invalidate_rkey;
755 } ex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 union {
757 struct {
758 u64 remote_addr;
759 u32 rkey;
760 } rdma;
761 struct {
762 u64 remote_addr;
763 u64 compare_add;
764 u64 swap;
Vladimir Sokolovsky5e80ba82010-04-14 17:23:01 +0300765 u64 compare_add_mask;
766 u64 swap_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 u32 rkey;
768 } atomic;
769 struct {
770 struct ib_ah *ah;
Eli Cohenc93570f2008-04-16 21:09:27 -0700771 void *header;
772 int hlen;
773 int mss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 u32 remote_qpn;
775 u32 remote_qkey;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 u16 pkey_index; /* valid for GSI only */
777 u8 port_num; /* valid for DR SMPs on switch only */
778 } ud;
Steve Wise00f7ec32008-07-14 23:48:45 -0700779 struct {
780 u64 iova_start;
781 struct ib_fast_reg_page_list *page_list;
782 unsigned int page_shift;
783 unsigned int page_list_len;
784 u32 length;
785 int access_flags;
786 u32 rkey;
787 } fast_reg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 } wr;
789};
790
791struct ib_recv_wr {
792 struct ib_recv_wr *next;
793 u64 wr_id;
794 struct ib_sge *sg_list;
795 int num_sge;
796};
797
798enum ib_access_flags {
799 IB_ACCESS_LOCAL_WRITE = 1,
800 IB_ACCESS_REMOTE_WRITE = (1<<1),
801 IB_ACCESS_REMOTE_READ = (1<<2),
802 IB_ACCESS_REMOTE_ATOMIC = (1<<3),
803 IB_ACCESS_MW_BIND = (1<<4)
804};
805
806struct ib_phys_buf {
807 u64 addr;
808 u64 size;
809};
810
811struct ib_mr_attr {
812 struct ib_pd *pd;
813 u64 device_virt_addr;
814 u64 size;
815 int mr_access_flags;
816 u32 lkey;
817 u32 rkey;
818};
819
820enum ib_mr_rereg_flags {
821 IB_MR_REREG_TRANS = 1,
822 IB_MR_REREG_PD = (1<<1),
823 IB_MR_REREG_ACCESS = (1<<2)
824};
825
826struct ib_mw_bind {
827 struct ib_mr *mr;
828 u64 wr_id;
829 u64 addr;
830 u32 length;
831 int send_flags;
832 int mw_access_flags;
833};
834
835struct ib_fmr_attr {
836 int max_pages;
837 int max_maps;
Or Gerlitzd36f34a2006-02-02 10:43:45 -0800838 u8 page_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839};
840
Roland Dreiere2773c02005-07-07 17:57:10 -0700841struct ib_ucontext {
842 struct ib_device *device;
843 struct list_head pd_list;
844 struct list_head mr_list;
845 struct list_head mw_list;
846 struct list_head cq_list;
847 struct list_head qp_list;
848 struct list_head srq_list;
849 struct list_head ah_list;
Roland Dreierf7c6a7b2007-03-04 16:15:11 -0800850 int closing;
Roland Dreiere2773c02005-07-07 17:57:10 -0700851};
852
853struct ib_uobject {
854 u64 user_handle; /* handle given to us by userspace */
855 struct ib_ucontext *context; /* associated user context */
Roland Dreier9ead1902006-06-17 20:44:49 -0700856 void *object; /* containing object */
Roland Dreiere2773c02005-07-07 17:57:10 -0700857 struct list_head list; /* link to context's list */
Roland Dreierb3d636b2008-04-16 21:01:06 -0700858 int id; /* index into kernel idr */
Roland Dreier9ead1902006-06-17 20:44:49 -0700859 struct kref ref;
860 struct rw_semaphore mutex; /* protects .live */
861 int live;
Roland Dreiere2773c02005-07-07 17:57:10 -0700862};
863
Roland Dreiere2773c02005-07-07 17:57:10 -0700864struct ib_udata {
865 void __user *inbuf;
866 void __user *outbuf;
867 size_t inlen;
868 size_t outlen;
869};
870
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871struct ib_pd {
Roland Dreiere2773c02005-07-07 17:57:10 -0700872 struct ib_device *device;
873 struct ib_uobject *uobject;
874 atomic_t usecnt; /* count all resources */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875};
876
877struct ib_ah {
878 struct ib_device *device;
879 struct ib_pd *pd;
Roland Dreiere2773c02005-07-07 17:57:10 -0700880 struct ib_uobject *uobject;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881};
882
883typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
884
885struct ib_cq {
Roland Dreiere2773c02005-07-07 17:57:10 -0700886 struct ib_device *device;
887 struct ib_uobject *uobject;
888 ib_comp_handler comp_handler;
889 void (*event_handler)(struct ib_event *, void *);
Dotan Barak4deccd62008-07-14 23:48:44 -0700890 void *cq_context;
Roland Dreiere2773c02005-07-07 17:57:10 -0700891 int cqe;
892 atomic_t usecnt; /* count number of work queues */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893};
894
895struct ib_srq {
Roland Dreierd41fcc62005-08-18 12:23:08 -0700896 struct ib_device *device;
897 struct ib_pd *pd;
898 struct ib_uobject *uobject;
899 void (*event_handler)(struct ib_event *, void *);
900 void *srq_context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 atomic_t usecnt;
902};
903
904struct ib_qp {
905 struct ib_device *device;
906 struct ib_pd *pd;
907 struct ib_cq *send_cq;
908 struct ib_cq *recv_cq;
909 struct ib_srq *srq;
Roland Dreiere2773c02005-07-07 17:57:10 -0700910 struct ib_uobject *uobject;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 void (*event_handler)(struct ib_event *, void *);
912 void *qp_context;
913 u32 qp_num;
914 enum ib_qp_type qp_type;
915};
916
917struct ib_mr {
Roland Dreiere2773c02005-07-07 17:57:10 -0700918 struct ib_device *device;
919 struct ib_pd *pd;
920 struct ib_uobject *uobject;
921 u32 lkey;
922 u32 rkey;
923 atomic_t usecnt; /* count number of MWs */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924};
925
926struct ib_mw {
927 struct ib_device *device;
928 struct ib_pd *pd;
Roland Dreiere2773c02005-07-07 17:57:10 -0700929 struct ib_uobject *uobject;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 u32 rkey;
931};
932
933struct ib_fmr {
934 struct ib_device *device;
935 struct ib_pd *pd;
936 struct list_head list;
937 u32 lkey;
938 u32 rkey;
939};
940
941struct ib_mad;
942struct ib_grh;
943
944enum ib_process_mad_flags {
945 IB_MAD_IGNORE_MKEY = 1,
946 IB_MAD_IGNORE_BKEY = 2,
947 IB_MAD_IGNORE_ALL = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
948};
949
950enum ib_mad_result {
951 IB_MAD_RESULT_FAILURE = 0, /* (!SUCCESS is the important flag) */
952 IB_MAD_RESULT_SUCCESS = 1 << 0, /* MAD was successfully processed */
953 IB_MAD_RESULT_REPLY = 1 << 1, /* Reply packet needs to be sent */
954 IB_MAD_RESULT_CONSUMED = 1 << 2 /* Packet consumed: stop processing */
955};
956
957#define IB_DEVICE_NAME_MAX 64
958
959struct ib_cache {
960 rwlock_t lock;
961 struct ib_event_handler event_handler;
962 struct ib_pkey_cache **pkey_cache;
963 struct ib_gid_cache **gid_cache;
Jack Morgenstein6fb9cdb2006-06-17 20:37:34 -0700964 u8 *lmc_cache;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965};
966
Ralph Campbell9b513092006-12-12 14:27:41 -0800967struct ib_dma_mapping_ops {
968 int (*mapping_error)(struct ib_device *dev,
969 u64 dma_addr);
970 u64 (*map_single)(struct ib_device *dev,
971 void *ptr, size_t size,
972 enum dma_data_direction direction);
973 void (*unmap_single)(struct ib_device *dev,
974 u64 addr, size_t size,
975 enum dma_data_direction direction);
976 u64 (*map_page)(struct ib_device *dev,
977 struct page *page, unsigned long offset,
978 size_t size,
979 enum dma_data_direction direction);
980 void (*unmap_page)(struct ib_device *dev,
981 u64 addr, size_t size,
982 enum dma_data_direction direction);
983 int (*map_sg)(struct ib_device *dev,
984 struct scatterlist *sg, int nents,
985 enum dma_data_direction direction);
986 void (*unmap_sg)(struct ib_device *dev,
987 struct scatterlist *sg, int nents,
988 enum dma_data_direction direction);
989 u64 (*dma_address)(struct ib_device *dev,
990 struct scatterlist *sg);
991 unsigned int (*dma_len)(struct ib_device *dev,
992 struct scatterlist *sg);
993 void (*sync_single_for_cpu)(struct ib_device *dev,
994 u64 dma_handle,
995 size_t size,
Dotan Barak4deccd62008-07-14 23:48:44 -0700996 enum dma_data_direction dir);
Ralph Campbell9b513092006-12-12 14:27:41 -0800997 void (*sync_single_for_device)(struct ib_device *dev,
998 u64 dma_handle,
999 size_t size,
1000 enum dma_data_direction dir);
1001 void *(*alloc_coherent)(struct ib_device *dev,
1002 size_t size,
1003 u64 *dma_handle,
1004 gfp_t flag);
1005 void (*free_coherent)(struct ib_device *dev,
1006 size_t size, void *cpu_addr,
1007 u64 dma_handle);
1008};
1009
Tom Tucker07ebafb2006-08-03 16:02:42 -05001010struct iw_cm_verbs;
1011
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012struct ib_device {
1013 struct device *dma_device;
1014
1015 char name[IB_DEVICE_NAME_MAX];
1016
1017 struct list_head event_handler_list;
1018 spinlock_t event_handler_lock;
1019
Alexander Chiang17a55f72010-02-02 19:09:16 +00001020 spinlock_t client_data_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 struct list_head core_list;
1022 struct list_head client_data_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023
1024 struct ib_cache cache;
Yosef Etigin5eb620c2007-05-14 07:26:51 +03001025 int *pkey_tbl_len;
1026 int *gid_tbl_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027
Michael S. Tsirkinf4fd0b22007-05-03 13:48:47 +03001028 int num_comp_vectors;
1029
Tom Tucker07ebafb2006-08-03 16:02:42 -05001030 struct iw_cm_verbs *iwcm;
1031
Steve Wise7f624d02008-07-14 23:48:48 -07001032 int (*get_protocol_stats)(struct ib_device *device,
1033 union rdma_protocol_stats *stats);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 int (*query_device)(struct ib_device *device,
1035 struct ib_device_attr *device_attr);
1036 int (*query_port)(struct ib_device *device,
1037 u8 port_num,
1038 struct ib_port_attr *port_attr);
Eli Cohena3f5ada2010-09-27 17:51:10 -07001039 enum rdma_link_layer (*get_link_layer)(struct ib_device *device,
1040 u8 port_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041 int (*query_gid)(struct ib_device *device,
1042 u8 port_num, int index,
1043 union ib_gid *gid);
1044 int (*query_pkey)(struct ib_device *device,
1045 u8 port_num, u16 index, u16 *pkey);
1046 int (*modify_device)(struct ib_device *device,
1047 int device_modify_mask,
1048 struct ib_device_modify *device_modify);
1049 int (*modify_port)(struct ib_device *device,
1050 u8 port_num, int port_modify_mask,
1051 struct ib_port_modify *port_modify);
Roland Dreiere2773c02005-07-07 17:57:10 -07001052 struct ib_ucontext * (*alloc_ucontext)(struct ib_device *device,
1053 struct ib_udata *udata);
1054 int (*dealloc_ucontext)(struct ib_ucontext *context);
1055 int (*mmap)(struct ib_ucontext *context,
1056 struct vm_area_struct *vma);
1057 struct ib_pd * (*alloc_pd)(struct ib_device *device,
1058 struct ib_ucontext *context,
1059 struct ib_udata *udata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 int (*dealloc_pd)(struct ib_pd *pd);
1061 struct ib_ah * (*create_ah)(struct ib_pd *pd,
1062 struct ib_ah_attr *ah_attr);
1063 int (*modify_ah)(struct ib_ah *ah,
1064 struct ib_ah_attr *ah_attr);
1065 int (*query_ah)(struct ib_ah *ah,
1066 struct ib_ah_attr *ah_attr);
1067 int (*destroy_ah)(struct ib_ah *ah);
Roland Dreierd41fcc62005-08-18 12:23:08 -07001068 struct ib_srq * (*create_srq)(struct ib_pd *pd,
1069 struct ib_srq_init_attr *srq_init_attr,
1070 struct ib_udata *udata);
1071 int (*modify_srq)(struct ib_srq *srq,
1072 struct ib_srq_attr *srq_attr,
Ralph Campbell9bc57e22006-08-11 14:58:09 -07001073 enum ib_srq_attr_mask srq_attr_mask,
1074 struct ib_udata *udata);
Roland Dreierd41fcc62005-08-18 12:23:08 -07001075 int (*query_srq)(struct ib_srq *srq,
1076 struct ib_srq_attr *srq_attr);
1077 int (*destroy_srq)(struct ib_srq *srq);
1078 int (*post_srq_recv)(struct ib_srq *srq,
1079 struct ib_recv_wr *recv_wr,
1080 struct ib_recv_wr **bad_recv_wr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 struct ib_qp * (*create_qp)(struct ib_pd *pd,
Roland Dreiere2773c02005-07-07 17:57:10 -07001082 struct ib_qp_init_attr *qp_init_attr,
1083 struct ib_udata *udata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084 int (*modify_qp)(struct ib_qp *qp,
1085 struct ib_qp_attr *qp_attr,
Ralph Campbell9bc57e22006-08-11 14:58:09 -07001086 int qp_attr_mask,
1087 struct ib_udata *udata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 int (*query_qp)(struct ib_qp *qp,
1089 struct ib_qp_attr *qp_attr,
1090 int qp_attr_mask,
1091 struct ib_qp_init_attr *qp_init_attr);
1092 int (*destroy_qp)(struct ib_qp *qp);
1093 int (*post_send)(struct ib_qp *qp,
1094 struct ib_send_wr *send_wr,
1095 struct ib_send_wr **bad_send_wr);
1096 int (*post_recv)(struct ib_qp *qp,
1097 struct ib_recv_wr *recv_wr,
1098 struct ib_recv_wr **bad_recv_wr);
Roland Dreiere2773c02005-07-07 17:57:10 -07001099 struct ib_cq * (*create_cq)(struct ib_device *device, int cqe,
Michael S. Tsirkinf4fd0b22007-05-03 13:48:47 +03001100 int comp_vector,
Roland Dreiere2773c02005-07-07 17:57:10 -07001101 struct ib_ucontext *context,
1102 struct ib_udata *udata);
Eli Cohen2dd57162008-04-16 21:09:33 -07001103 int (*modify_cq)(struct ib_cq *cq, u16 cq_count,
1104 u16 cq_period);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105 int (*destroy_cq)(struct ib_cq *cq);
Roland Dreier33b9b3e2006-01-30 14:29:21 -08001106 int (*resize_cq)(struct ib_cq *cq, int cqe,
1107 struct ib_udata *udata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 int (*poll_cq)(struct ib_cq *cq, int num_entries,
1109 struct ib_wc *wc);
1110 int (*peek_cq)(struct ib_cq *cq, int wc_cnt);
1111 int (*req_notify_cq)(struct ib_cq *cq,
Roland Dreiered23a722007-05-06 21:02:48 -07001112 enum ib_cq_notify_flags flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 int (*req_ncomp_notif)(struct ib_cq *cq,
1114 int wc_cnt);
1115 struct ib_mr * (*get_dma_mr)(struct ib_pd *pd,
1116 int mr_access_flags);
1117 struct ib_mr * (*reg_phys_mr)(struct ib_pd *pd,
1118 struct ib_phys_buf *phys_buf_array,
1119 int num_phys_buf,
1120 int mr_access_flags,
1121 u64 *iova_start);
Roland Dreiere2773c02005-07-07 17:57:10 -07001122 struct ib_mr * (*reg_user_mr)(struct ib_pd *pd,
Roland Dreierf7c6a7b2007-03-04 16:15:11 -08001123 u64 start, u64 length,
1124 u64 virt_addr,
Roland Dreiere2773c02005-07-07 17:57:10 -07001125 int mr_access_flags,
1126 struct ib_udata *udata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 int (*query_mr)(struct ib_mr *mr,
1128 struct ib_mr_attr *mr_attr);
1129 int (*dereg_mr)(struct ib_mr *mr);
Steve Wise00f7ec32008-07-14 23:48:45 -07001130 struct ib_mr * (*alloc_fast_reg_mr)(struct ib_pd *pd,
1131 int max_page_list_len);
1132 struct ib_fast_reg_page_list * (*alloc_fast_reg_page_list)(struct ib_device *device,
1133 int page_list_len);
1134 void (*free_fast_reg_page_list)(struct ib_fast_reg_page_list *page_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135 int (*rereg_phys_mr)(struct ib_mr *mr,
1136 int mr_rereg_mask,
1137 struct ib_pd *pd,
1138 struct ib_phys_buf *phys_buf_array,
1139 int num_phys_buf,
1140 int mr_access_flags,
1141 u64 *iova_start);
1142 struct ib_mw * (*alloc_mw)(struct ib_pd *pd);
1143 int (*bind_mw)(struct ib_qp *qp,
1144 struct ib_mw *mw,
1145 struct ib_mw_bind *mw_bind);
1146 int (*dealloc_mw)(struct ib_mw *mw);
1147 struct ib_fmr * (*alloc_fmr)(struct ib_pd *pd,
1148 int mr_access_flags,
1149 struct ib_fmr_attr *fmr_attr);
1150 int (*map_phys_fmr)(struct ib_fmr *fmr,
1151 u64 *page_list, int list_len,
1152 u64 iova);
1153 int (*unmap_fmr)(struct list_head *fmr_list);
1154 int (*dealloc_fmr)(struct ib_fmr *fmr);
1155 int (*attach_mcast)(struct ib_qp *qp,
1156 union ib_gid *gid,
1157 u16 lid);
1158 int (*detach_mcast)(struct ib_qp *qp,
1159 union ib_gid *gid,
1160 u16 lid);
1161 int (*process_mad)(struct ib_device *device,
1162 int process_mad_flags,
1163 u8 port_num,
1164 struct ib_wc *in_wc,
1165 struct ib_grh *in_grh,
1166 struct ib_mad *in_mad,
1167 struct ib_mad *out_mad);
1168
Ralph Campbell9b513092006-12-12 14:27:41 -08001169 struct ib_dma_mapping_ops *dma_ops;
1170
Roland Dreiere2773c02005-07-07 17:57:10 -07001171 struct module *owner;
Tony Jonesf4e91eb2008-02-22 00:13:36 +01001172 struct device dev;
Greg Kroah-Hartman35be0682007-12-17 15:54:39 -04001173 struct kobject *ports_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 struct list_head port_list;
1175
1176 enum {
1177 IB_DEV_UNINITIALIZED,
1178 IB_DEV_REGISTERED,
1179 IB_DEV_UNREGISTERED
1180 } reg_state;
1181
Roland Dreier274c0892005-09-29 14:17:48 -07001182 int uverbs_abi_ver;
Alexander Chiang17a55f72010-02-02 19:09:16 +00001183 u64 uverbs_cmd_mask;
Roland Dreier274c0892005-09-29 14:17:48 -07001184
Roland Dreierc5bcbbb2006-02-02 09:47:14 -08001185 char node_desc[64];
Sean Heftycf311cd2006-01-10 07:39:34 -08001186 __be64 node_guid;
Steve Wise96f15c02008-07-14 23:48:53 -07001187 u32 local_dma_lkey;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 u8 node_type;
1189 u8 phys_port_cnt;
1190};
1191
1192struct ib_client {
1193 char *name;
1194 void (*add) (struct ib_device *);
1195 void (*remove)(struct ib_device *);
1196
1197 struct list_head list;
1198};
1199
1200struct ib_device *ib_alloc_device(size_t size);
1201void ib_dealloc_device(struct ib_device *device);
1202
Ralph Campbell9a6edb62010-05-06 17:03:25 -07001203int ib_register_device(struct ib_device *device,
1204 int (*port_callback)(struct ib_device *,
1205 u8, struct kobject *));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206void ib_unregister_device(struct ib_device *device);
1207
1208int ib_register_client (struct ib_client *client);
1209void ib_unregister_client(struct ib_client *client);
1210
1211void *ib_get_client_data(struct ib_device *device, struct ib_client *client);
1212void ib_set_client_data(struct ib_device *device, struct ib_client *client,
1213 void *data);
1214
Roland Dreiere2773c02005-07-07 17:57:10 -07001215static inline int ib_copy_from_udata(void *dest, struct ib_udata *udata, size_t len)
1216{
1217 return copy_from_user(dest, udata->inbuf, len) ? -EFAULT : 0;
1218}
1219
1220static inline int ib_copy_to_udata(struct ib_udata *udata, void *src, size_t len)
1221{
1222 return copy_to_user(udata->outbuf, src, len) ? -EFAULT : 0;
1223}
1224
Roland Dreier8a518662006-02-13 12:48:12 -08001225/**
1226 * ib_modify_qp_is_ok - Check that the supplied attribute mask
1227 * contains all required attributes and no attributes not allowed for
1228 * the given QP state transition.
1229 * @cur_state: Current QP state
1230 * @next_state: Next QP state
1231 * @type: QP type
1232 * @mask: Mask of supplied QP attributes
1233 *
1234 * This function is a helper function that a low-level driver's
1235 * modify_qp method can use to validate the consumer's input. It
1236 * checks that cur_state and next_state are valid QP states, that a
1237 * transition from cur_state to next_state is allowed by the IB spec,
1238 * and that the attribute mask supplied is allowed for the transition.
1239 */
1240int ib_modify_qp_is_ok(enum ib_qp_state cur_state, enum ib_qp_state next_state,
1241 enum ib_qp_type type, enum ib_qp_attr_mask mask);
1242
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243int ib_register_event_handler (struct ib_event_handler *event_handler);
1244int ib_unregister_event_handler(struct ib_event_handler *event_handler);
1245void ib_dispatch_event(struct ib_event *event);
1246
1247int ib_query_device(struct ib_device *device,
1248 struct ib_device_attr *device_attr);
1249
1250int ib_query_port(struct ib_device *device,
1251 u8 port_num, struct ib_port_attr *port_attr);
1252
Eli Cohena3f5ada2010-09-27 17:51:10 -07001253enum rdma_link_layer rdma_port_get_link_layer(struct ib_device *device,
1254 u8 port_num);
1255
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256int ib_query_gid(struct ib_device *device,
1257 u8 port_num, int index, union ib_gid *gid);
1258
1259int ib_query_pkey(struct ib_device *device,
1260 u8 port_num, u16 index, u16 *pkey);
1261
1262int ib_modify_device(struct ib_device *device,
1263 int device_modify_mask,
1264 struct ib_device_modify *device_modify);
1265
1266int ib_modify_port(struct ib_device *device,
1267 u8 port_num, int port_modify_mask,
1268 struct ib_port_modify *port_modify);
1269
Yosef Etigin5eb620c2007-05-14 07:26:51 +03001270int ib_find_gid(struct ib_device *device, union ib_gid *gid,
1271 u8 *port_num, u16 *index);
1272
1273int ib_find_pkey(struct ib_device *device,
1274 u8 port_num, u16 pkey, u16 *index);
1275
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276/**
1277 * ib_alloc_pd - Allocates an unused protection domain.
1278 * @device: The device on which to allocate the protection domain.
1279 *
1280 * A protection domain object provides an association between QPs, shared
1281 * receive queues, address handles, memory regions, and memory windows.
1282 */
1283struct ib_pd *ib_alloc_pd(struct ib_device *device);
1284
1285/**
1286 * ib_dealloc_pd - Deallocates a protection domain.
1287 * @pd: The protection domain to deallocate.
1288 */
1289int ib_dealloc_pd(struct ib_pd *pd);
1290
1291/**
1292 * ib_create_ah - Creates an address handle for the given address vector.
1293 * @pd: The protection domain associated with the address handle.
1294 * @ah_attr: The attributes of the address vector.
1295 *
1296 * The address handle is used to reference a local or global destination
1297 * in all UD QP post sends.
1298 */
1299struct ib_ah *ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
1300
1301/**
Sean Hefty4e00d692006-06-17 20:37:39 -07001302 * ib_init_ah_from_wc - Initializes address handle attributes from a
1303 * work completion.
1304 * @device: Device on which the received message arrived.
1305 * @port_num: Port on which the received message arrived.
1306 * @wc: Work completion associated with the received message.
1307 * @grh: References the received global route header. This parameter is
1308 * ignored unless the work completion indicates that the GRH is valid.
1309 * @ah_attr: Returned attributes that can be used when creating an address
1310 * handle for replying to the message.
1311 */
1312int ib_init_ah_from_wc(struct ib_device *device, u8 port_num, struct ib_wc *wc,
1313 struct ib_grh *grh, struct ib_ah_attr *ah_attr);
1314
1315/**
Hal Rosenstock513789e2005-07-27 11:45:34 -07001316 * ib_create_ah_from_wc - Creates an address handle associated with the
1317 * sender of the specified work completion.
1318 * @pd: The protection domain associated with the address handle.
1319 * @wc: Work completion information associated with a received message.
1320 * @grh: References the received global route header. This parameter is
1321 * ignored unless the work completion indicates that the GRH is valid.
1322 * @port_num: The outbound port number to associate with the address.
1323 *
1324 * The address handle is used to reference a local or global destination
1325 * in all UD QP post sends.
1326 */
1327struct ib_ah *ib_create_ah_from_wc(struct ib_pd *pd, struct ib_wc *wc,
1328 struct ib_grh *grh, u8 port_num);
1329
1330/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 * ib_modify_ah - Modifies the address vector associated with an address
1332 * handle.
1333 * @ah: The address handle to modify.
1334 * @ah_attr: The new address vector attributes to associate with the
1335 * address handle.
1336 */
1337int ib_modify_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1338
1339/**
1340 * ib_query_ah - Queries the address vector associated with an address
1341 * handle.
1342 * @ah: The address handle to query.
1343 * @ah_attr: The address vector attributes associated with the address
1344 * handle.
1345 */
1346int ib_query_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1347
1348/**
1349 * ib_destroy_ah - Destroys an address handle.
1350 * @ah: The address handle to destroy.
1351 */
1352int ib_destroy_ah(struct ib_ah *ah);
1353
1354/**
Roland Dreierd41fcc62005-08-18 12:23:08 -07001355 * ib_create_srq - Creates a SRQ associated with the specified protection
1356 * domain.
1357 * @pd: The protection domain associated with the SRQ.
Dotan Barakabb6e9b2006-02-23 12:13:51 -08001358 * @srq_init_attr: A list of initial attributes required to create the
1359 * SRQ. If SRQ creation succeeds, then the attributes are updated to
1360 * the actual capabilities of the created SRQ.
Roland Dreierd41fcc62005-08-18 12:23:08 -07001361 *
1362 * srq_attr->max_wr and srq_attr->max_sge are read the determine the
1363 * requested size of the SRQ, and set to the actual values allocated
1364 * on return. If ib_create_srq() succeeds, then max_wr and max_sge
1365 * will always be at least as large as the requested values.
1366 */
1367struct ib_srq *ib_create_srq(struct ib_pd *pd,
1368 struct ib_srq_init_attr *srq_init_attr);
1369
1370/**
1371 * ib_modify_srq - Modifies the attributes for the specified SRQ.
1372 * @srq: The SRQ to modify.
1373 * @srq_attr: On input, specifies the SRQ attributes to modify. On output,
1374 * the current values of selected SRQ attributes are returned.
1375 * @srq_attr_mask: A bit-mask used to specify which attributes of the SRQ
1376 * are being modified.
1377 *
1378 * The mask may contain IB_SRQ_MAX_WR to resize the SRQ and/or
1379 * IB_SRQ_LIMIT to set the SRQ's limit and request notification when
1380 * the number of receives queued drops below the limit.
1381 */
1382int ib_modify_srq(struct ib_srq *srq,
1383 struct ib_srq_attr *srq_attr,
1384 enum ib_srq_attr_mask srq_attr_mask);
1385
1386/**
1387 * ib_query_srq - Returns the attribute list and current values for the
1388 * specified SRQ.
1389 * @srq: The SRQ to query.
1390 * @srq_attr: The attributes of the specified SRQ.
1391 */
1392int ib_query_srq(struct ib_srq *srq,
1393 struct ib_srq_attr *srq_attr);
1394
1395/**
1396 * ib_destroy_srq - Destroys the specified SRQ.
1397 * @srq: The SRQ to destroy.
1398 */
1399int ib_destroy_srq(struct ib_srq *srq);
1400
1401/**
1402 * ib_post_srq_recv - Posts a list of work requests to the specified SRQ.
1403 * @srq: The SRQ to post the work request on.
1404 * @recv_wr: A list of work requests to post on the receive queue.
1405 * @bad_recv_wr: On an immediate failure, this parameter will reference
1406 * the work request that failed to be posted on the QP.
1407 */
1408static inline int ib_post_srq_recv(struct ib_srq *srq,
1409 struct ib_recv_wr *recv_wr,
1410 struct ib_recv_wr **bad_recv_wr)
1411{
1412 return srq->device->post_srq_recv(srq, recv_wr, bad_recv_wr);
1413}
1414
1415/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 * ib_create_qp - Creates a QP associated with the specified protection
1417 * domain.
1418 * @pd: The protection domain associated with the QP.
Dotan Barakabb6e9b2006-02-23 12:13:51 -08001419 * @qp_init_attr: A list of initial attributes required to create the
1420 * QP. If QP creation succeeds, then the attributes are updated to
1421 * the actual capabilities of the created QP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 */
1423struct ib_qp *ib_create_qp(struct ib_pd *pd,
1424 struct ib_qp_init_attr *qp_init_attr);
1425
1426/**
1427 * ib_modify_qp - Modifies the attributes for the specified QP and then
1428 * transitions the QP to the given state.
1429 * @qp: The QP to modify.
1430 * @qp_attr: On input, specifies the QP attributes to modify. On output,
1431 * the current values of selected QP attributes are returned.
1432 * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
1433 * are being modified.
1434 */
1435int ib_modify_qp(struct ib_qp *qp,
1436 struct ib_qp_attr *qp_attr,
1437 int qp_attr_mask);
1438
1439/**
1440 * ib_query_qp - Returns the attribute list and current values for the
1441 * specified QP.
1442 * @qp: The QP to query.
1443 * @qp_attr: The attributes of the specified QP.
1444 * @qp_attr_mask: A bit-mask used to select specific attributes to query.
1445 * @qp_init_attr: Additional attributes of the selected QP.
1446 *
1447 * The qp_attr_mask may be used to limit the query to gathering only the
1448 * selected attributes.
1449 */
1450int ib_query_qp(struct ib_qp *qp,
1451 struct ib_qp_attr *qp_attr,
1452 int qp_attr_mask,
1453 struct ib_qp_init_attr *qp_init_attr);
1454
1455/**
1456 * ib_destroy_qp - Destroys the specified QP.
1457 * @qp: The QP to destroy.
1458 */
1459int ib_destroy_qp(struct ib_qp *qp);
1460
1461/**
1462 * ib_post_send - Posts a list of work requests to the send queue of
1463 * the specified QP.
1464 * @qp: The QP to post the work request on.
1465 * @send_wr: A list of work requests to post on the send queue.
1466 * @bad_send_wr: On an immediate failure, this parameter will reference
1467 * the work request that failed to be posted on the QP.
Bart Van Assche55464d42009-12-09 14:20:04 -08001468 *
1469 * While IBA Vol. 1 section 11.4.1.1 specifies that if an immediate
1470 * error is returned, the QP state shall not be affected,
1471 * ib_post_send() will return an immediate error after queueing any
1472 * earlier work requests in the list.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473 */
1474static inline int ib_post_send(struct ib_qp *qp,
1475 struct ib_send_wr *send_wr,
1476 struct ib_send_wr **bad_send_wr)
1477{
1478 return qp->device->post_send(qp, send_wr, bad_send_wr);
1479}
1480
1481/**
1482 * ib_post_recv - Posts a list of work requests to the receive queue of
1483 * the specified QP.
1484 * @qp: The QP to post the work request on.
1485 * @recv_wr: A list of work requests to post on the receive queue.
1486 * @bad_recv_wr: On an immediate failure, this parameter will reference
1487 * the work request that failed to be posted on the QP.
1488 */
1489static inline int ib_post_recv(struct ib_qp *qp,
1490 struct ib_recv_wr *recv_wr,
1491 struct ib_recv_wr **bad_recv_wr)
1492{
1493 return qp->device->post_recv(qp, recv_wr, bad_recv_wr);
1494}
1495
1496/**
1497 * ib_create_cq - Creates a CQ on the specified device.
1498 * @device: The device on which to create the CQ.
1499 * @comp_handler: A user-specified callback that is invoked when a
1500 * completion event occurs on the CQ.
1501 * @event_handler: A user-specified callback that is invoked when an
1502 * asynchronous event not associated with a completion occurs on the CQ.
1503 * @cq_context: Context associated with the CQ returned to the user via
1504 * the associated completion and event handlers.
1505 * @cqe: The minimum size of the CQ.
Michael S. Tsirkinf4fd0b22007-05-03 13:48:47 +03001506 * @comp_vector - Completion vector used to signal completion events.
1507 * Must be >= 0 and < context->num_comp_vectors.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508 *
1509 * Users can examine the cq structure to determine the actual CQ size.
1510 */
1511struct ib_cq *ib_create_cq(struct ib_device *device,
1512 ib_comp_handler comp_handler,
1513 void (*event_handler)(struct ib_event *, void *),
Michael S. Tsirkinf4fd0b22007-05-03 13:48:47 +03001514 void *cq_context, int cqe, int comp_vector);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515
1516/**
1517 * ib_resize_cq - Modifies the capacity of the CQ.
1518 * @cq: The CQ to resize.
1519 * @cqe: The minimum size of the CQ.
1520 *
1521 * Users can examine the cq structure to determine the actual CQ size.
1522 */
1523int ib_resize_cq(struct ib_cq *cq, int cqe);
1524
1525/**
Eli Cohen2dd57162008-04-16 21:09:33 -07001526 * ib_modify_cq - Modifies moderation params of the CQ
1527 * @cq: The CQ to modify.
1528 * @cq_count: number of CQEs that will trigger an event
1529 * @cq_period: max period of time in usec before triggering an event
1530 *
1531 */
1532int ib_modify_cq(struct ib_cq *cq, u16 cq_count, u16 cq_period);
1533
1534/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 * ib_destroy_cq - Destroys the specified CQ.
1536 * @cq: The CQ to destroy.
1537 */
1538int ib_destroy_cq(struct ib_cq *cq);
1539
1540/**
1541 * ib_poll_cq - poll a CQ for completion(s)
1542 * @cq:the CQ being polled
1543 * @num_entries:maximum number of completions to return
1544 * @wc:array of at least @num_entries &struct ib_wc where completions
1545 * will be returned
1546 *
1547 * Poll a CQ for (possibly multiple) completions. If the return value
1548 * is < 0, an error occurred. If the return value is >= 0, it is the
1549 * number of completions returned. If the return value is
1550 * non-negative and < num_entries, then the CQ was emptied.
1551 */
1552static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
1553 struct ib_wc *wc)
1554{
1555 return cq->device->poll_cq(cq, num_entries, wc);
1556}
1557
1558/**
1559 * ib_peek_cq - Returns the number of unreaped completions currently
1560 * on the specified CQ.
1561 * @cq: The CQ to peek.
1562 * @wc_cnt: A minimum number of unreaped completions to check for.
1563 *
1564 * If the number of unreaped completions is greater than or equal to wc_cnt,
1565 * this function returns wc_cnt, otherwise, it returns the actual number of
1566 * unreaped completions.
1567 */
1568int ib_peek_cq(struct ib_cq *cq, int wc_cnt);
1569
1570/**
1571 * ib_req_notify_cq - Request completion notification on a CQ.
1572 * @cq: The CQ to generate an event for.
Roland Dreiered23a722007-05-06 21:02:48 -07001573 * @flags:
1574 * Must contain exactly one of %IB_CQ_SOLICITED or %IB_CQ_NEXT_COMP
1575 * to request an event on the next solicited event or next work
1576 * completion at any type, respectively. %IB_CQ_REPORT_MISSED_EVENTS
1577 * may also be |ed in to request a hint about missed events, as
1578 * described below.
1579 *
1580 * Return Value:
1581 * < 0 means an error occurred while requesting notification
1582 * == 0 means notification was requested successfully, and if
1583 * IB_CQ_REPORT_MISSED_EVENTS was passed in, then no events
1584 * were missed and it is safe to wait for another event. In
1585 * this case is it guaranteed that any work completions added
1586 * to the CQ since the last CQ poll will trigger a completion
1587 * notification event.
1588 * > 0 is only returned if IB_CQ_REPORT_MISSED_EVENTS was passed
1589 * in. It means that the consumer must poll the CQ again to
1590 * make sure it is empty to avoid missing an event because of a
1591 * race between requesting notification and an entry being
1592 * added to the CQ. This return value means it is possible
1593 * (but not guaranteed) that a work completion has been added
1594 * to the CQ since the last poll without triggering a
1595 * completion notification event.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596 */
1597static inline int ib_req_notify_cq(struct ib_cq *cq,
Roland Dreiered23a722007-05-06 21:02:48 -07001598 enum ib_cq_notify_flags flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599{
Roland Dreiered23a722007-05-06 21:02:48 -07001600 return cq->device->req_notify_cq(cq, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601}
1602
1603/**
1604 * ib_req_ncomp_notif - Request completion notification when there are
1605 * at least the specified number of unreaped completions on the CQ.
1606 * @cq: The CQ to generate an event for.
1607 * @wc_cnt: The number of unreaped completions that should be on the
1608 * CQ before an event is generated.
1609 */
1610static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
1611{
1612 return cq->device->req_ncomp_notif ?
1613 cq->device->req_ncomp_notif(cq, wc_cnt) :
1614 -ENOSYS;
1615}
1616
1617/**
1618 * ib_get_dma_mr - Returns a memory region for system memory that is
1619 * usable for DMA.
1620 * @pd: The protection domain associated with the memory region.
1621 * @mr_access_flags: Specifies the memory access rights.
Ralph Campbell9b513092006-12-12 14:27:41 -08001622 *
1623 * Note that the ib_dma_*() functions defined below must be used
1624 * to create/destroy addresses used with the Lkey or Rkey returned
1625 * by ib_get_dma_mr().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 */
1627struct ib_mr *ib_get_dma_mr(struct ib_pd *pd, int mr_access_flags);
1628
1629/**
Ralph Campbell9b513092006-12-12 14:27:41 -08001630 * ib_dma_mapping_error - check a DMA addr for error
1631 * @dev: The device for which the dma_addr was created
1632 * @dma_addr: The DMA address to check
1633 */
1634static inline int ib_dma_mapping_error(struct ib_device *dev, u64 dma_addr)
1635{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001636 if (dev->dma_ops)
1637 return dev->dma_ops->mapping_error(dev, dma_addr);
FUJITA Tomonori8d8bb392008-07-25 19:44:49 -07001638 return dma_mapping_error(dev->dma_device, dma_addr);
Ralph Campbell9b513092006-12-12 14:27:41 -08001639}
1640
1641/**
1642 * ib_dma_map_single - Map a kernel virtual address to DMA address
1643 * @dev: The device for which the dma_addr is to be created
1644 * @cpu_addr: The kernel virtual address
1645 * @size: The size of the region in bytes
1646 * @direction: The direction of the DMA
1647 */
1648static inline u64 ib_dma_map_single(struct ib_device *dev,
1649 void *cpu_addr, size_t size,
1650 enum dma_data_direction direction)
1651{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001652 if (dev->dma_ops)
1653 return dev->dma_ops->map_single(dev, cpu_addr, size, direction);
1654 return dma_map_single(dev->dma_device, cpu_addr, size, direction);
Ralph Campbell9b513092006-12-12 14:27:41 -08001655}
1656
1657/**
1658 * ib_dma_unmap_single - Destroy a mapping created by ib_dma_map_single()
1659 * @dev: The device for which the DMA address was created
1660 * @addr: The DMA address
1661 * @size: The size of the region in bytes
1662 * @direction: The direction of the DMA
1663 */
1664static inline void ib_dma_unmap_single(struct ib_device *dev,
1665 u64 addr, size_t size,
1666 enum dma_data_direction direction)
1667{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001668 if (dev->dma_ops)
1669 dev->dma_ops->unmap_single(dev, addr, size, direction);
1670 else
Ralph Campbell9b513092006-12-12 14:27:41 -08001671 dma_unmap_single(dev->dma_device, addr, size, direction);
1672}
1673
Arthur Kepnercb9fbc52008-04-29 01:00:34 -07001674static inline u64 ib_dma_map_single_attrs(struct ib_device *dev,
1675 void *cpu_addr, size_t size,
1676 enum dma_data_direction direction,
1677 struct dma_attrs *attrs)
1678{
1679 return dma_map_single_attrs(dev->dma_device, cpu_addr, size,
1680 direction, attrs);
1681}
1682
1683static inline void ib_dma_unmap_single_attrs(struct ib_device *dev,
1684 u64 addr, size_t size,
1685 enum dma_data_direction direction,
1686 struct dma_attrs *attrs)
1687{
1688 return dma_unmap_single_attrs(dev->dma_device, addr, size,
1689 direction, attrs);
1690}
1691
Ralph Campbell9b513092006-12-12 14:27:41 -08001692/**
1693 * ib_dma_map_page - Map a physical page to DMA address
1694 * @dev: The device for which the dma_addr is to be created
1695 * @page: The page to be mapped
1696 * @offset: The offset within the page
1697 * @size: The size of the region in bytes
1698 * @direction: The direction of the DMA
1699 */
1700static inline u64 ib_dma_map_page(struct ib_device *dev,
1701 struct page *page,
1702 unsigned long offset,
1703 size_t size,
1704 enum dma_data_direction direction)
1705{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001706 if (dev->dma_ops)
1707 return dev->dma_ops->map_page(dev, page, offset, size, direction);
1708 return dma_map_page(dev->dma_device, page, offset, size, direction);
Ralph Campbell9b513092006-12-12 14:27:41 -08001709}
1710
1711/**
1712 * ib_dma_unmap_page - Destroy a mapping created by ib_dma_map_page()
1713 * @dev: The device for which the DMA address was created
1714 * @addr: The DMA address
1715 * @size: The size of the region in bytes
1716 * @direction: The direction of the DMA
1717 */
1718static inline void ib_dma_unmap_page(struct ib_device *dev,
1719 u64 addr, size_t size,
1720 enum dma_data_direction direction)
1721{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001722 if (dev->dma_ops)
1723 dev->dma_ops->unmap_page(dev, addr, size, direction);
1724 else
Ralph Campbell9b513092006-12-12 14:27:41 -08001725 dma_unmap_page(dev->dma_device, addr, size, direction);
1726}
1727
1728/**
1729 * ib_dma_map_sg - Map a scatter/gather list to DMA addresses
1730 * @dev: The device for which the DMA addresses are to be created
1731 * @sg: The array of scatter/gather entries
1732 * @nents: The number of scatter/gather entries
1733 * @direction: The direction of the DMA
1734 */
1735static inline int ib_dma_map_sg(struct ib_device *dev,
1736 struct scatterlist *sg, int nents,
1737 enum dma_data_direction direction)
1738{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001739 if (dev->dma_ops)
1740 return dev->dma_ops->map_sg(dev, sg, nents, direction);
1741 return dma_map_sg(dev->dma_device, sg, nents, direction);
Ralph Campbell9b513092006-12-12 14:27:41 -08001742}
1743
1744/**
1745 * ib_dma_unmap_sg - Unmap a scatter/gather list of DMA addresses
1746 * @dev: The device for which the DMA addresses were created
1747 * @sg: The array of scatter/gather entries
1748 * @nents: The number of scatter/gather entries
1749 * @direction: The direction of the DMA
1750 */
1751static inline void ib_dma_unmap_sg(struct ib_device *dev,
1752 struct scatterlist *sg, int nents,
1753 enum dma_data_direction direction)
1754{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001755 if (dev->dma_ops)
1756 dev->dma_ops->unmap_sg(dev, sg, nents, direction);
1757 else
Ralph Campbell9b513092006-12-12 14:27:41 -08001758 dma_unmap_sg(dev->dma_device, sg, nents, direction);
1759}
1760
Arthur Kepnercb9fbc52008-04-29 01:00:34 -07001761static inline int ib_dma_map_sg_attrs(struct ib_device *dev,
1762 struct scatterlist *sg, int nents,
1763 enum dma_data_direction direction,
1764 struct dma_attrs *attrs)
1765{
1766 return dma_map_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
1767}
1768
1769static inline void ib_dma_unmap_sg_attrs(struct ib_device *dev,
1770 struct scatterlist *sg, int nents,
1771 enum dma_data_direction direction,
1772 struct dma_attrs *attrs)
1773{
1774 dma_unmap_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
1775}
Ralph Campbell9b513092006-12-12 14:27:41 -08001776/**
1777 * ib_sg_dma_address - Return the DMA address from a scatter/gather entry
1778 * @dev: The device for which the DMA addresses were created
1779 * @sg: The scatter/gather entry
1780 */
1781static inline u64 ib_sg_dma_address(struct ib_device *dev,
1782 struct scatterlist *sg)
1783{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001784 if (dev->dma_ops)
1785 return dev->dma_ops->dma_address(dev, sg);
1786 return sg_dma_address(sg);
Ralph Campbell9b513092006-12-12 14:27:41 -08001787}
1788
1789/**
1790 * ib_sg_dma_len - Return the DMA length from a scatter/gather entry
1791 * @dev: The device for which the DMA addresses were created
1792 * @sg: The scatter/gather entry
1793 */
1794static inline unsigned int ib_sg_dma_len(struct ib_device *dev,
1795 struct scatterlist *sg)
1796{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001797 if (dev->dma_ops)
1798 return dev->dma_ops->dma_len(dev, sg);
1799 return sg_dma_len(sg);
Ralph Campbell9b513092006-12-12 14:27:41 -08001800}
1801
1802/**
1803 * ib_dma_sync_single_for_cpu - Prepare DMA region to be accessed by CPU
1804 * @dev: The device for which the DMA address was created
1805 * @addr: The DMA address
1806 * @size: The size of the region in bytes
1807 * @dir: The direction of the DMA
1808 */
1809static inline void ib_dma_sync_single_for_cpu(struct ib_device *dev,
1810 u64 addr,
1811 size_t size,
1812 enum dma_data_direction dir)
1813{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001814 if (dev->dma_ops)
1815 dev->dma_ops->sync_single_for_cpu(dev, addr, size, dir);
1816 else
Ralph Campbell9b513092006-12-12 14:27:41 -08001817 dma_sync_single_for_cpu(dev->dma_device, addr, size, dir);
1818}
1819
1820/**
1821 * ib_dma_sync_single_for_device - Prepare DMA region to be accessed by device
1822 * @dev: The device for which the DMA address was created
1823 * @addr: The DMA address
1824 * @size: The size of the region in bytes
1825 * @dir: The direction of the DMA
1826 */
1827static inline void ib_dma_sync_single_for_device(struct ib_device *dev,
1828 u64 addr,
1829 size_t size,
1830 enum dma_data_direction dir)
1831{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001832 if (dev->dma_ops)
1833 dev->dma_ops->sync_single_for_device(dev, addr, size, dir);
1834 else
Ralph Campbell9b513092006-12-12 14:27:41 -08001835 dma_sync_single_for_device(dev->dma_device, addr, size, dir);
1836}
1837
1838/**
1839 * ib_dma_alloc_coherent - Allocate memory and map it for DMA
1840 * @dev: The device for which the DMA address is requested
1841 * @size: The size of the region to allocate in bytes
1842 * @dma_handle: A pointer for returning the DMA address of the region
1843 * @flag: memory allocator flags
1844 */
1845static inline void *ib_dma_alloc_coherent(struct ib_device *dev,
1846 size_t size,
1847 u64 *dma_handle,
1848 gfp_t flag)
1849{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001850 if (dev->dma_ops)
1851 return dev->dma_ops->alloc_coherent(dev, size, dma_handle, flag);
Roland Dreierc59a3da2006-12-15 13:57:26 -08001852 else {
1853 dma_addr_t handle;
1854 void *ret;
1855
1856 ret = dma_alloc_coherent(dev->dma_device, size, &handle, flag);
1857 *dma_handle = handle;
1858 return ret;
1859 }
Ralph Campbell9b513092006-12-12 14:27:41 -08001860}
1861
1862/**
1863 * ib_dma_free_coherent - Free memory allocated by ib_dma_alloc_coherent()
1864 * @dev: The device for which the DMA addresses were allocated
1865 * @size: The size of the region
1866 * @cpu_addr: the address returned by ib_dma_alloc_coherent()
1867 * @dma_handle: the DMA address returned by ib_dma_alloc_coherent()
1868 */
1869static inline void ib_dma_free_coherent(struct ib_device *dev,
1870 size_t size, void *cpu_addr,
1871 u64 dma_handle)
1872{
Ben Collinsd1998ef2006-12-13 22:10:05 -05001873 if (dev->dma_ops)
1874 dev->dma_ops->free_coherent(dev, size, cpu_addr, dma_handle);
1875 else
Ralph Campbell9b513092006-12-12 14:27:41 -08001876 dma_free_coherent(dev->dma_device, size, cpu_addr, dma_handle);
1877}
1878
1879/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880 * ib_reg_phys_mr - Prepares a virtually addressed memory region for use
1881 * by an HCA.
1882 * @pd: The protection domain associated assigned to the registered region.
1883 * @phys_buf_array: Specifies a list of physical buffers to use in the
1884 * memory region.
1885 * @num_phys_buf: Specifies the size of the phys_buf_array.
1886 * @mr_access_flags: Specifies the memory access rights.
1887 * @iova_start: The offset of the region's starting I/O virtual address.
1888 */
1889struct ib_mr *ib_reg_phys_mr(struct ib_pd *pd,
1890 struct ib_phys_buf *phys_buf_array,
1891 int num_phys_buf,
1892 int mr_access_flags,
1893 u64 *iova_start);
1894
1895/**
1896 * ib_rereg_phys_mr - Modifies the attributes of an existing memory region.
1897 * Conceptually, this call performs the functions deregister memory region
1898 * followed by register physical memory region. Where possible,
1899 * resources are reused instead of deallocated and reallocated.
1900 * @mr: The memory region to modify.
1901 * @mr_rereg_mask: A bit-mask used to indicate which of the following
1902 * properties of the memory region are being modified.
1903 * @pd: If %IB_MR_REREG_PD is set in mr_rereg_mask, this field specifies
1904 * the new protection domain to associated with the memory region,
1905 * otherwise, this parameter is ignored.
1906 * @phys_buf_array: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1907 * field specifies a list of physical buffers to use in the new
1908 * translation, otherwise, this parameter is ignored.
1909 * @num_phys_buf: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1910 * field specifies the size of the phys_buf_array, otherwise, this
1911 * parameter is ignored.
1912 * @mr_access_flags: If %IB_MR_REREG_ACCESS is set in mr_rereg_mask, this
1913 * field specifies the new memory access rights, otherwise, this
1914 * parameter is ignored.
1915 * @iova_start: The offset of the region's starting I/O virtual address.
1916 */
1917int ib_rereg_phys_mr(struct ib_mr *mr,
1918 int mr_rereg_mask,
1919 struct ib_pd *pd,
1920 struct ib_phys_buf *phys_buf_array,
1921 int num_phys_buf,
1922 int mr_access_flags,
1923 u64 *iova_start);
1924
1925/**
1926 * ib_query_mr - Retrieves information about a specific memory region.
1927 * @mr: The memory region to retrieve information about.
1928 * @mr_attr: The attributes of the specified memory region.
1929 */
1930int ib_query_mr(struct ib_mr *mr, struct ib_mr_attr *mr_attr);
1931
1932/**
1933 * ib_dereg_mr - Deregisters a memory region and removes it from the
1934 * HCA translation table.
1935 * @mr: The memory region to deregister.
1936 */
1937int ib_dereg_mr(struct ib_mr *mr);
1938
1939/**
Steve Wise00f7ec32008-07-14 23:48:45 -07001940 * ib_alloc_fast_reg_mr - Allocates memory region usable with the
1941 * IB_WR_FAST_REG_MR send work request.
1942 * @pd: The protection domain associated with the region.
1943 * @max_page_list_len: requested max physical buffer list length to be
1944 * used with fast register work requests for this MR.
1945 */
1946struct ib_mr *ib_alloc_fast_reg_mr(struct ib_pd *pd, int max_page_list_len);
1947
1948/**
1949 * ib_alloc_fast_reg_page_list - Allocates a page list array
1950 * @device - ib device pointer.
1951 * @page_list_len - size of the page list array to be allocated.
1952 *
1953 * This allocates and returns a struct ib_fast_reg_page_list * and a
1954 * page_list array that is at least page_list_len in size. The actual
1955 * size is returned in max_page_list_len. The caller is responsible
1956 * for initializing the contents of the page_list array before posting
1957 * a send work request with the IB_WC_FAST_REG_MR opcode.
1958 *
1959 * The page_list array entries must be translated using one of the
1960 * ib_dma_*() functions just like the addresses passed to
1961 * ib_map_phys_fmr(). Once the ib_post_send() is issued, the struct
1962 * ib_fast_reg_page_list must not be modified by the caller until the
1963 * IB_WC_FAST_REG_MR work request completes.
1964 */
1965struct ib_fast_reg_page_list *ib_alloc_fast_reg_page_list(
1966 struct ib_device *device, int page_list_len);
1967
1968/**
1969 * ib_free_fast_reg_page_list - Deallocates a previously allocated
1970 * page list array.
1971 * @page_list - struct ib_fast_reg_page_list pointer to be deallocated.
1972 */
1973void ib_free_fast_reg_page_list(struct ib_fast_reg_page_list *page_list);
1974
1975/**
1976 * ib_update_fast_reg_key - updates the key portion of the fast_reg MR
1977 * R_Key and L_Key.
1978 * @mr - struct ib_mr pointer to be updated.
1979 * @newkey - new key to be used.
1980 */
1981static inline void ib_update_fast_reg_key(struct ib_mr *mr, u8 newkey)
1982{
1983 mr->lkey = (mr->lkey & 0xffffff00) | newkey;
1984 mr->rkey = (mr->rkey & 0xffffff00) | newkey;
1985}
1986
1987/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988 * ib_alloc_mw - Allocates a memory window.
1989 * @pd: The protection domain associated with the memory window.
1990 */
1991struct ib_mw *ib_alloc_mw(struct ib_pd *pd);
1992
1993/**
1994 * ib_bind_mw - Posts a work request to the send queue of the specified
1995 * QP, which binds the memory window to the given address range and
1996 * remote access attributes.
1997 * @qp: QP to post the bind work request on.
1998 * @mw: The memory window to bind.
1999 * @mw_bind: Specifies information about the memory window, including
2000 * its address range, remote access rights, and associated memory region.
2001 */
2002static inline int ib_bind_mw(struct ib_qp *qp,
2003 struct ib_mw *mw,
2004 struct ib_mw_bind *mw_bind)
2005{
2006 /* XXX reference counting in corresponding MR? */
2007 return mw->device->bind_mw ?
2008 mw->device->bind_mw(qp, mw, mw_bind) :
2009 -ENOSYS;
2010}
2011
2012/**
2013 * ib_dealloc_mw - Deallocates a memory window.
2014 * @mw: The memory window to deallocate.
2015 */
2016int ib_dealloc_mw(struct ib_mw *mw);
2017
2018/**
2019 * ib_alloc_fmr - Allocates a unmapped fast memory region.
2020 * @pd: The protection domain associated with the unmapped region.
2021 * @mr_access_flags: Specifies the memory access rights.
2022 * @fmr_attr: Attributes of the unmapped region.
2023 *
2024 * A fast memory region must be mapped before it can be used as part of
2025 * a work request.
2026 */
2027struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
2028 int mr_access_flags,
2029 struct ib_fmr_attr *fmr_attr);
2030
2031/**
2032 * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
2033 * @fmr: The fast memory region to associate with the pages.
2034 * @page_list: An array of physical pages to map to the fast memory region.
2035 * @list_len: The number of pages in page_list.
2036 * @iova: The I/O virtual address to use with the mapped region.
2037 */
2038static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
2039 u64 *page_list, int list_len,
2040 u64 iova)
2041{
2042 return fmr->device->map_phys_fmr(fmr, page_list, list_len, iova);
2043}
2044
2045/**
2046 * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
2047 * @fmr_list: A linked list of fast memory regions to unmap.
2048 */
2049int ib_unmap_fmr(struct list_head *fmr_list);
2050
2051/**
2052 * ib_dealloc_fmr - Deallocates a fast memory region.
2053 * @fmr: The fast memory region to deallocate.
2054 */
2055int ib_dealloc_fmr(struct ib_fmr *fmr);
2056
2057/**
2058 * ib_attach_mcast - Attaches the specified QP to a multicast group.
2059 * @qp: QP to attach to the multicast group. The QP must be type
2060 * IB_QPT_UD.
2061 * @gid: Multicast group GID.
2062 * @lid: Multicast group LID in host byte order.
2063 *
2064 * In order to send and receive multicast packets, subnet
2065 * administration must have created the multicast group and configured
2066 * the fabric appropriately. The port associated with the specified
2067 * QP must also be a member of the multicast group.
2068 */
2069int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
2070
2071/**
2072 * ib_detach_mcast - Detaches the specified QP from a multicast group.
2073 * @qp: QP to detach from the multicast group.
2074 * @gid: Multicast group GID.
2075 * @lid: Multicast group LID in host byte order.
2076 */
2077int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
2078
2079#endif /* IB_VERBS_H */