RDMA/verbs: Cleanup XRC TGT QPs when destroying XRCD
[linux-3.10.git] / include / rdma / ib_verbs.h
1 /*
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.
7  * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
8  * Copyright (c) 2005, 2006, 2007 Cisco Systems.  All rights reserved.
9  *
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.
37  */
38
39 #if !defined(IB_VERBS_H)
40 #define IB_VERBS_H
41
42 #include <linux/types.h>
43 #include <linux/device.h>
44 #include <linux/mm.h>
45 #include <linux/dma-mapping.h>
46 #include <linux/kref.h>
47 #include <linux/list.h>
48 #include <linux/rwsem.h>
49 #include <linux/scatterlist.h>
50 #include <linux/workqueue.h>
51
52 #include <linux/atomic.h>
53 #include <asm/uaccess.h>
54
55 extern struct workqueue_struct *ib_wq;
56
57 union ib_gid {
58         u8      raw[16];
59         struct {
60                 __be64  subnet_prefix;
61                 __be64  interface_id;
62         } global;
63 };
64
65 enum 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
71 };
72
73 enum rdma_transport_type {
74         RDMA_TRANSPORT_IB,
75         RDMA_TRANSPORT_IWARP
76 };
77
78 enum rdma_transport_type
79 rdma_node_get_transport(enum rdma_node_type node_type) __attribute_const__;
80
81 enum rdma_link_layer {
82         IB_LINK_LAYER_UNSPECIFIED,
83         IB_LINK_LAYER_INFINIBAND,
84         IB_LINK_LAYER_ETHERNET,
85 };
86
87 enum 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),
103         IB_DEVICE_LOCAL_DMA_LKEY        = (1<<15),
104         IB_DEVICE_RESERVED              = (1<<16), /* old SEND_W_INV */
105         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),
114         IB_DEVICE_UD_TSO                = (1<<19),
115         IB_DEVICE_XRC                   = (1<<20),
116         IB_DEVICE_MEM_MGT_EXTENSIONS    = (1<<21),
117         IB_DEVICE_BLOCK_MULTICAST_LOOPBACK = (1<<22),
118 };
119
120 enum ib_atomic_cap {
121         IB_ATOMIC_NONE,
122         IB_ATOMIC_HCA,
123         IB_ATOMIC_GLOB
124 };
125
126 struct ib_device_attr {
127         u64                     fw_ver;
128         __be64                  sys_image_guid;
129         u64                     max_mr_size;
130         u64                     page_size_cap;
131         u32                     vendor_id;
132         u32                     vendor_part_id;
133         u32                     hw_ver;
134         int                     max_qp;
135         int                     max_qp_wr;
136         int                     device_cap_flags;
137         int                     max_sge;
138         int                     max_sge_rd;
139         int                     max_cq;
140         int                     max_cqe;
141         int                     max_mr;
142         int                     max_pd;
143         int                     max_qp_rd_atom;
144         int                     max_ee_rd_atom;
145         int                     max_res_rd_atom;
146         int                     max_qp_init_rd_atom;
147         int                     max_ee_init_rd_atom;
148         enum ib_atomic_cap      atomic_cap;
149         enum ib_atomic_cap      masked_atomic_cap;
150         int                     max_ee;
151         int                     max_rdd;
152         int                     max_mw;
153         int                     max_raw_ipv6_qp;
154         int                     max_raw_ethy_qp;
155         int                     max_mcast_grp;
156         int                     max_mcast_qp_attach;
157         int                     max_total_mcast_qp_attach;
158         int                     max_ah;
159         int                     max_fmr;
160         int                     max_map_per_fmr;
161         int                     max_srq;
162         int                     max_srq_wr;
163         int                     max_srq_sge;
164         unsigned int            max_fast_reg_page_list_len;
165         u16                     max_pkeys;
166         u8                      local_ca_ack_delay;
167 };
168
169 enum ib_mtu {
170         IB_MTU_256  = 1,
171         IB_MTU_512  = 2,
172         IB_MTU_1024 = 3,
173         IB_MTU_2048 = 4,
174         IB_MTU_4096 = 5
175 };
176
177 static inline int ib_mtu_enum_to_int(enum ib_mtu mtu)
178 {
179         switch (mtu) {
180         case IB_MTU_256:  return  256;
181         case IB_MTU_512:  return  512;
182         case IB_MTU_1024: return 1024;
183         case IB_MTU_2048: return 2048;
184         case IB_MTU_4096: return 4096;
185         default:          return -1;
186         }
187 }
188
189 enum ib_port_state {
190         IB_PORT_NOP             = 0,
191         IB_PORT_DOWN            = 1,
192         IB_PORT_INIT            = 2,
193         IB_PORT_ARMED           = 3,
194         IB_PORT_ACTIVE          = 4,
195         IB_PORT_ACTIVE_DEFER    = 5
196 };
197
198 enum ib_port_cap_flags {
199         IB_PORT_SM                              = 1 <<  1,
200         IB_PORT_NOTICE_SUP                      = 1 <<  2,
201         IB_PORT_TRAP_SUP                        = 1 <<  3,
202         IB_PORT_OPT_IPD_SUP                     = 1 <<  4,
203         IB_PORT_AUTO_MIGR_SUP                   = 1 <<  5,
204         IB_PORT_SL_MAP_SUP                      = 1 <<  6,
205         IB_PORT_MKEY_NVRAM                      = 1 <<  7,
206         IB_PORT_PKEY_NVRAM                      = 1 <<  8,
207         IB_PORT_LED_INFO_SUP                    = 1 <<  9,
208         IB_PORT_SM_DISABLED                     = 1 << 10,
209         IB_PORT_SYS_IMAGE_GUID_SUP              = 1 << 11,
210         IB_PORT_PKEY_SW_EXT_PORT_TRAP_SUP       = 1 << 12,
211         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
223 enum 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
230 static 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
241 struct ib_protocol_stats {
242         /* TBD... */
243 };
244
245 struct 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
287 union rdma_protocol_stats {
288         struct ib_protocol_stats        ib;
289         struct iw_protocol_stats        iw;
290 };
291
292 struct 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
314 enum ib_device_modify_flags {
315         IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1 << 0,
316         IB_DEVICE_MODIFY_NODE_DESC      = 1 << 1
317 };
318
319 struct ib_device_modify {
320         u64     sys_image_guid;
321         char    node_desc[64];
322 };
323
324 enum 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
330 struct ib_port_modify {
331         u32     set_port_cap_mask;
332         u32     clr_port_cap_mask;
333         u8      init_type;
334 };
335
336 enum 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,
350         IB_EVENT_SM_CHANGE,
351         IB_EVENT_SRQ_ERR,
352         IB_EVENT_SRQ_LIMIT_REACHED,
353         IB_EVENT_QP_LAST_WQE_REACHED,
354         IB_EVENT_CLIENT_REREGISTER,
355         IB_EVENT_GID_CHANGE,
356 };
357
358 struct ib_event {
359         struct ib_device        *device;
360         union {
361                 struct ib_cq    *cq;
362                 struct ib_qp    *qp;
363                 struct ib_srq   *srq;
364                 u8              port_num;
365         } element;
366         enum ib_event_type      event;
367 };
368
369 struct 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
382 struct 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
390 struct ib_grh {
391         __be32          version_tclass_flow;
392         __be16          paylen;
393         u8              next_hdr;
394         u8              hop_limit;
395         union ib_gid    sgid;
396         union ib_gid    dgid;
397 };
398
399 enum {
400         IB_MULTICAST_QPN = 0xffffff
401 };
402
403 #define IB_LID_PERMISSIVE       cpu_to_be16(0xFFFF)
404
405 enum ib_ah_flags {
406         IB_AH_GRH       = 1
407 };
408
409 enum 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,
419         IB_RATE_120_GBPS = 10
420 };
421
422 /**
423  * ib_rate_to_mult - Convert the IB rate enum to a multiple of the
424  * base rate of 2.5 Gbit/sec.  For example, IB_RATE_5_GBPS will be
425  * converted to 2, since 5 Gbit/sec is 2 * 2.5 Gbit/sec.
426  * @rate: rate to convert.
427  */
428 int ib_rate_to_mult(enum ib_rate rate) __attribute_const__;
429
430 /**
431  * mult_to_ib_rate - Convert a multiple of 2.5 Gbit/sec to an IB rate
432  * enum.
433  * @mult: multiple to convert.
434  */
435 enum ib_rate mult_to_ib_rate(int mult) __attribute_const__;
436
437 struct ib_ah_attr {
438         struct ib_global_route  grh;
439         u16                     dlid;
440         u8                      sl;
441         u8                      src_path_bits;
442         u8                      static_rate;
443         u8                      ah_flags;
444         u8                      port_num;
445 };
446
447 enum ib_wc_status {
448         IB_WC_SUCCESS,
449         IB_WC_LOC_LEN_ERR,
450         IB_WC_LOC_QP_OP_ERR,
451         IB_WC_LOC_EEC_OP_ERR,
452         IB_WC_LOC_PROT_ERR,
453         IB_WC_WR_FLUSH_ERR,
454         IB_WC_MW_BIND_ERR,
455         IB_WC_BAD_RESP_ERR,
456         IB_WC_LOC_ACCESS_ERR,
457         IB_WC_REM_INV_REQ_ERR,
458         IB_WC_REM_ACCESS_ERR,
459         IB_WC_REM_OP_ERR,
460         IB_WC_RETRY_EXC_ERR,
461         IB_WC_RNR_RETRY_EXC_ERR,
462         IB_WC_LOC_RDD_VIOL_ERR,
463         IB_WC_REM_INV_RD_REQ_ERR,
464         IB_WC_REM_ABORT_ERR,
465         IB_WC_INV_EECN_ERR,
466         IB_WC_INV_EEC_STATE_ERR,
467         IB_WC_FATAL_ERR,
468         IB_WC_RESP_TIMEOUT_ERR,
469         IB_WC_GENERAL_ERR
470 };
471
472 enum ib_wc_opcode {
473         IB_WC_SEND,
474         IB_WC_RDMA_WRITE,
475         IB_WC_RDMA_READ,
476         IB_WC_COMP_SWAP,
477         IB_WC_FETCH_ADD,
478         IB_WC_BIND_MW,
479         IB_WC_LSO,
480         IB_WC_LOCAL_INV,
481         IB_WC_FAST_REG_MR,
482         IB_WC_MASKED_COMP_SWAP,
483         IB_WC_MASKED_FETCH_ADD,
484 /*
485  * Set value of IB_WC_RECV so consumers can test if a completion is a
486  * receive by testing (opcode & IB_WC_RECV).
487  */
488         IB_WC_RECV                      = 1 << 7,
489         IB_WC_RECV_RDMA_WITH_IMM
490 };
491
492 enum ib_wc_flags {
493         IB_WC_GRH               = 1,
494         IB_WC_WITH_IMM          = (1<<1),
495         IB_WC_WITH_INVALIDATE   = (1<<2),
496 };
497
498 struct ib_wc {
499         u64                     wr_id;
500         enum ib_wc_status       status;
501         enum ib_wc_opcode       opcode;
502         u32                     vendor_err;
503         u32                     byte_len;
504         struct ib_qp           *qp;
505         union {
506                 __be32          imm_data;
507                 u32             invalidate_rkey;
508         } ex;
509         u32                     src_qp;
510         int                     wc_flags;
511         u16                     pkey_index;
512         u16                     slid;
513         u8                      sl;
514         u8                      dlid_path_bits;
515         u8                      port_num;       /* valid only for DR SMPs on switches */
516         int                     csum_ok;
517 };
518
519 enum ib_cq_notify_flags {
520         IB_CQ_SOLICITED                 = 1 << 0,
521         IB_CQ_NEXT_COMP                 = 1 << 1,
522         IB_CQ_SOLICITED_MASK            = IB_CQ_SOLICITED | IB_CQ_NEXT_COMP,
523         IB_CQ_REPORT_MISSED_EVENTS      = 1 << 2,
524 };
525
526 enum ib_srq_type {
527         IB_SRQT_BASIC,
528         IB_SRQT_XRC
529 };
530
531 enum ib_srq_attr_mask {
532         IB_SRQ_MAX_WR   = 1 << 0,
533         IB_SRQ_LIMIT    = 1 << 1,
534 };
535
536 struct ib_srq_attr {
537         u32     max_wr;
538         u32     max_sge;
539         u32     srq_limit;
540 };
541
542 struct ib_srq_init_attr {
543         void                  (*event_handler)(struct ib_event *, void *);
544         void                   *srq_context;
545         struct ib_srq_attr      attr;
546         enum ib_srq_type        srq_type;
547
548         union {
549                 struct {
550                         struct ib_xrcd *xrcd;
551                         struct ib_cq   *cq;
552                 } xrc;
553         } ext;
554 };
555
556 struct ib_qp_cap {
557         u32     max_send_wr;
558         u32     max_recv_wr;
559         u32     max_send_sge;
560         u32     max_recv_sge;
561         u32     max_inline_data;
562 };
563
564 enum ib_sig_type {
565         IB_SIGNAL_ALL_WR,
566         IB_SIGNAL_REQ_WR
567 };
568
569 enum ib_qp_type {
570         /*
571          * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
572          * here (and in that order) since the MAD layer uses them as
573          * indices into a 2-entry table.
574          */
575         IB_QPT_SMI,
576         IB_QPT_GSI,
577
578         IB_QPT_RC,
579         IB_QPT_UC,
580         IB_QPT_UD,
581         IB_QPT_RAW_IPV6,
582         IB_QPT_RAW_ETHERTYPE,
583         /* Save 8 for RAW_PACKET */
584         IB_QPT_XRC_INI = 9,
585         IB_QPT_XRC_TGT,
586         IB_QPT_MAX
587 };
588
589 enum ib_qp_create_flags {
590         IB_QP_CREATE_IPOIB_UD_LSO               = 1 << 0,
591         IB_QP_CREATE_BLOCK_MULTICAST_LOOPBACK   = 1 << 1,
592 };
593
594 struct ib_qp_init_attr {
595         void                  (*event_handler)(struct ib_event *, void *);
596         void                   *qp_context;
597         struct ib_cq           *send_cq;
598         struct ib_cq           *recv_cq;
599         struct ib_srq          *srq;
600         struct ib_xrcd         *xrcd;     /* XRC TGT QPs only */
601         struct ib_qp_cap        cap;
602         enum ib_sig_type        sq_sig_type;
603         enum ib_qp_type         qp_type;
604         enum ib_qp_create_flags create_flags;
605         u8                      port_num; /* special QP types only */
606 };
607
608 enum ib_rnr_timeout {
609         IB_RNR_TIMER_655_36 =  0,
610         IB_RNR_TIMER_000_01 =  1,
611         IB_RNR_TIMER_000_02 =  2,
612         IB_RNR_TIMER_000_03 =  3,
613         IB_RNR_TIMER_000_04 =  4,
614         IB_RNR_TIMER_000_06 =  5,
615         IB_RNR_TIMER_000_08 =  6,
616         IB_RNR_TIMER_000_12 =  7,
617         IB_RNR_TIMER_000_16 =  8,
618         IB_RNR_TIMER_000_24 =  9,
619         IB_RNR_TIMER_000_32 = 10,
620         IB_RNR_TIMER_000_48 = 11,
621         IB_RNR_TIMER_000_64 = 12,
622         IB_RNR_TIMER_000_96 = 13,
623         IB_RNR_TIMER_001_28 = 14,
624         IB_RNR_TIMER_001_92 = 15,
625         IB_RNR_TIMER_002_56 = 16,
626         IB_RNR_TIMER_003_84 = 17,
627         IB_RNR_TIMER_005_12 = 18,
628         IB_RNR_TIMER_007_68 = 19,
629         IB_RNR_TIMER_010_24 = 20,
630         IB_RNR_TIMER_015_36 = 21,
631         IB_RNR_TIMER_020_48 = 22,
632         IB_RNR_TIMER_030_72 = 23,
633         IB_RNR_TIMER_040_96 = 24,
634         IB_RNR_TIMER_061_44 = 25,
635         IB_RNR_TIMER_081_92 = 26,
636         IB_RNR_TIMER_122_88 = 27,
637         IB_RNR_TIMER_163_84 = 28,
638         IB_RNR_TIMER_245_76 = 29,
639         IB_RNR_TIMER_327_68 = 30,
640         IB_RNR_TIMER_491_52 = 31
641 };
642
643 enum ib_qp_attr_mask {
644         IB_QP_STATE                     = 1,
645         IB_QP_CUR_STATE                 = (1<<1),
646         IB_QP_EN_SQD_ASYNC_NOTIFY       = (1<<2),
647         IB_QP_ACCESS_FLAGS              = (1<<3),
648         IB_QP_PKEY_INDEX                = (1<<4),
649         IB_QP_PORT                      = (1<<5),
650         IB_QP_QKEY                      = (1<<6),
651         IB_QP_AV                        = (1<<7),
652         IB_QP_PATH_MTU                  = (1<<8),
653         IB_QP_TIMEOUT                   = (1<<9),
654         IB_QP_RETRY_CNT                 = (1<<10),
655         IB_QP_RNR_RETRY                 = (1<<11),
656         IB_QP_RQ_PSN                    = (1<<12),
657         IB_QP_MAX_QP_RD_ATOMIC          = (1<<13),
658         IB_QP_ALT_PATH                  = (1<<14),
659         IB_QP_MIN_RNR_TIMER             = (1<<15),
660         IB_QP_SQ_PSN                    = (1<<16),
661         IB_QP_MAX_DEST_RD_ATOMIC        = (1<<17),
662         IB_QP_PATH_MIG_STATE            = (1<<18),
663         IB_QP_CAP                       = (1<<19),
664         IB_QP_DEST_QPN                  = (1<<20)
665 };
666
667 enum ib_qp_state {
668         IB_QPS_RESET,
669         IB_QPS_INIT,
670         IB_QPS_RTR,
671         IB_QPS_RTS,
672         IB_QPS_SQD,
673         IB_QPS_SQE,
674         IB_QPS_ERR
675 };
676
677 enum ib_mig_state {
678         IB_MIG_MIGRATED,
679         IB_MIG_REARM,
680         IB_MIG_ARMED
681 };
682
683 struct ib_qp_attr {
684         enum ib_qp_state        qp_state;
685         enum ib_qp_state        cur_qp_state;
686         enum ib_mtu             path_mtu;
687         enum ib_mig_state       path_mig_state;
688         u32                     qkey;
689         u32                     rq_psn;
690         u32                     sq_psn;
691         u32                     dest_qp_num;
692         int                     qp_access_flags;
693         struct ib_qp_cap        cap;
694         struct ib_ah_attr       ah_attr;
695         struct ib_ah_attr       alt_ah_attr;
696         u16                     pkey_index;
697         u16                     alt_pkey_index;
698         u8                      en_sqd_async_notify;
699         u8                      sq_draining;
700         u8                      max_rd_atomic;
701         u8                      max_dest_rd_atomic;
702         u8                      min_rnr_timer;
703         u8                      port_num;
704         u8                      timeout;
705         u8                      retry_cnt;
706         u8                      rnr_retry;
707         u8                      alt_port_num;
708         u8                      alt_timeout;
709 };
710
711 enum ib_wr_opcode {
712         IB_WR_RDMA_WRITE,
713         IB_WR_RDMA_WRITE_WITH_IMM,
714         IB_WR_SEND,
715         IB_WR_SEND_WITH_IMM,
716         IB_WR_RDMA_READ,
717         IB_WR_ATOMIC_CMP_AND_SWP,
718         IB_WR_ATOMIC_FETCH_AND_ADD,
719         IB_WR_LSO,
720         IB_WR_SEND_WITH_INV,
721         IB_WR_RDMA_READ_WITH_INV,
722         IB_WR_LOCAL_INV,
723         IB_WR_FAST_REG_MR,
724         IB_WR_MASKED_ATOMIC_CMP_AND_SWP,
725         IB_WR_MASKED_ATOMIC_FETCH_AND_ADD,
726 };
727
728 enum ib_send_flags {
729         IB_SEND_FENCE           = 1,
730         IB_SEND_SIGNALED        = (1<<1),
731         IB_SEND_SOLICITED       = (1<<2),
732         IB_SEND_INLINE          = (1<<3),
733         IB_SEND_IP_CSUM         = (1<<4)
734 };
735
736 struct ib_sge {
737         u64     addr;
738         u32     length;
739         u32     lkey;
740 };
741
742 struct ib_fast_reg_page_list {
743         struct ib_device       *device;
744         u64                    *page_list;
745         unsigned int            max_page_list_len;
746 };
747
748 struct ib_send_wr {
749         struct ib_send_wr      *next;
750         u64                     wr_id;
751         struct ib_sge          *sg_list;
752         int                     num_sge;
753         enum ib_wr_opcode       opcode;
754         int                     send_flags;
755         union {
756                 __be32          imm_data;
757                 u32             invalidate_rkey;
758         } ex;
759         union {
760                 struct {
761                         u64     remote_addr;
762                         u32     rkey;
763                 } rdma;
764                 struct {
765                         u64     remote_addr;
766                         u64     compare_add;
767                         u64     swap;
768                         u64     compare_add_mask;
769                         u64     swap_mask;
770                         u32     rkey;
771                 } atomic;
772                 struct {
773                         struct ib_ah *ah;
774                         void   *header;
775                         int     hlen;
776                         int     mss;
777                         u32     remote_qpn;
778                         u32     remote_qkey;
779                         u16     pkey_index; /* valid for GSI only */
780                         u8      port_num;   /* valid for DR SMPs on switch only */
781                 } ud;
782                 struct {
783                         u64                             iova_start;
784                         struct ib_fast_reg_page_list   *page_list;
785                         unsigned int                    page_shift;
786                         unsigned int                    page_list_len;
787                         u32                             length;
788                         int                             access_flags;
789                         u32                             rkey;
790                 } fast_reg;
791         } wr;
792         u32                     xrc_remote_srq_num;     /* XRC TGT QPs only */
793 };
794
795 struct ib_recv_wr {
796         struct ib_recv_wr      *next;
797         u64                     wr_id;
798         struct ib_sge          *sg_list;
799         int                     num_sge;
800 };
801
802 enum ib_access_flags {
803         IB_ACCESS_LOCAL_WRITE   = 1,
804         IB_ACCESS_REMOTE_WRITE  = (1<<1),
805         IB_ACCESS_REMOTE_READ   = (1<<2),
806         IB_ACCESS_REMOTE_ATOMIC = (1<<3),
807         IB_ACCESS_MW_BIND       = (1<<4)
808 };
809
810 struct ib_phys_buf {
811         u64      addr;
812         u64      size;
813 };
814
815 struct ib_mr_attr {
816         struct ib_pd    *pd;
817         u64             device_virt_addr;
818         u64             size;
819         int             mr_access_flags;
820         u32             lkey;
821         u32             rkey;
822 };
823
824 enum ib_mr_rereg_flags {
825         IB_MR_REREG_TRANS       = 1,
826         IB_MR_REREG_PD          = (1<<1),
827         IB_MR_REREG_ACCESS      = (1<<2)
828 };
829
830 struct ib_mw_bind {
831         struct ib_mr   *mr;
832         u64             wr_id;
833         u64             addr;
834         u32             length;
835         int             send_flags;
836         int             mw_access_flags;
837 };
838
839 struct ib_fmr_attr {
840         int     max_pages;
841         int     max_maps;
842         u8      page_shift;
843 };
844
845 struct ib_ucontext {
846         struct ib_device       *device;
847         struct list_head        pd_list;
848         struct list_head        mr_list;
849         struct list_head        mw_list;
850         struct list_head        cq_list;
851         struct list_head        qp_list;
852         struct list_head        srq_list;
853         struct list_head        ah_list;
854         int                     closing;
855 };
856
857 struct ib_uobject {
858         u64                     user_handle;    /* handle given to us by userspace */
859         struct ib_ucontext     *context;        /* associated user context */
860         void                   *object;         /* containing object */
861         struct list_head        list;           /* link to context's list */
862         int                     id;             /* index into kernel idr */
863         struct kref             ref;
864         struct rw_semaphore     mutex;          /* protects .live */
865         int                     live;
866 };
867
868 struct ib_udata {
869         void __user *inbuf;
870         void __user *outbuf;
871         size_t       inlen;
872         size_t       outlen;
873 };
874
875 struct ib_pd {
876         struct ib_device       *device;
877         struct ib_uobject      *uobject;
878         atomic_t                usecnt; /* count all resources */
879 };
880
881 struct ib_xrcd {
882         struct ib_device       *device;
883         atomic_t                usecnt; /* count all exposed resources */
884
885         struct mutex            tgt_qp_mutex;
886         struct list_head        tgt_qp_list;
887 };
888
889 struct ib_ah {
890         struct ib_device        *device;
891         struct ib_pd            *pd;
892         struct ib_uobject       *uobject;
893 };
894
895 typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
896
897 struct ib_cq {
898         struct ib_device       *device;
899         struct ib_uobject      *uobject;
900         ib_comp_handler         comp_handler;
901         void                  (*event_handler)(struct ib_event *, void *);
902         void                   *cq_context;
903         int                     cqe;
904         atomic_t                usecnt; /* count number of work queues */
905 };
906
907 struct ib_srq {
908         struct ib_device       *device;
909         struct ib_pd           *pd;
910         struct ib_uobject      *uobject;
911         void                  (*event_handler)(struct ib_event *, void *);
912         void                   *srq_context;
913         enum ib_srq_type        srq_type;
914         atomic_t                usecnt;
915
916         union {
917                 struct {
918                         struct ib_xrcd *xrcd;
919                         struct ib_cq   *cq;
920                         u32             srq_num;
921                 } xrc;
922         } ext;
923 };
924
925 struct ib_qp {
926         struct ib_device       *device;
927         struct ib_pd           *pd;
928         struct ib_cq           *send_cq;
929         struct ib_cq           *recv_cq;
930         struct ib_srq          *srq;
931         struct ib_xrcd         *xrcd; /* XRC TGT QPs only */
932         struct list_head        xrcd_list;
933         struct ib_uobject      *uobject;
934         void                  (*event_handler)(struct ib_event *, void *);
935         void                   *qp_context;
936         u32                     qp_num;
937         enum ib_qp_type         qp_type;
938 };
939
940 struct ib_mr {
941         struct ib_device  *device;
942         struct ib_pd      *pd;
943         struct ib_uobject *uobject;
944         u32                lkey;
945         u32                rkey;
946         atomic_t           usecnt; /* count number of MWs */
947 };
948
949 struct ib_mw {
950         struct ib_device        *device;
951         struct ib_pd            *pd;
952         struct ib_uobject       *uobject;
953         u32                     rkey;
954 };
955
956 struct ib_fmr {
957         struct ib_device        *device;
958         struct ib_pd            *pd;
959         struct list_head        list;
960         u32                     lkey;
961         u32                     rkey;
962 };
963
964 struct ib_mad;
965 struct ib_grh;
966
967 enum ib_process_mad_flags {
968         IB_MAD_IGNORE_MKEY      = 1,
969         IB_MAD_IGNORE_BKEY      = 2,
970         IB_MAD_IGNORE_ALL       = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
971 };
972
973 enum ib_mad_result {
974         IB_MAD_RESULT_FAILURE  = 0,      /* (!SUCCESS is the important flag) */
975         IB_MAD_RESULT_SUCCESS  = 1 << 0, /* MAD was successfully processed   */
976         IB_MAD_RESULT_REPLY    = 1 << 1, /* Reply packet needs to be sent    */
977         IB_MAD_RESULT_CONSUMED = 1 << 2  /* Packet consumed: stop processing */
978 };
979
980 #define IB_DEVICE_NAME_MAX 64
981
982 struct ib_cache {
983         rwlock_t                lock;
984         struct ib_event_handler event_handler;
985         struct ib_pkey_cache  **pkey_cache;
986         struct ib_gid_cache   **gid_cache;
987         u8                     *lmc_cache;
988 };
989
990 struct ib_dma_mapping_ops {
991         int             (*mapping_error)(struct ib_device *dev,
992                                          u64 dma_addr);
993         u64             (*map_single)(struct ib_device *dev,
994                                       void *ptr, size_t size,
995                                       enum dma_data_direction direction);
996         void            (*unmap_single)(struct ib_device *dev,
997                                         u64 addr, size_t size,
998                                         enum dma_data_direction direction);
999         u64             (*map_page)(struct ib_device *dev,
1000                                     struct page *page, unsigned long offset,
1001                                     size_t size,
1002                                     enum dma_data_direction direction);
1003         void            (*unmap_page)(struct ib_device *dev,
1004                                       u64 addr, size_t size,
1005                                       enum dma_data_direction direction);
1006         int             (*map_sg)(struct ib_device *dev,
1007                                   struct scatterlist *sg, int nents,
1008                                   enum dma_data_direction direction);
1009         void            (*unmap_sg)(struct ib_device *dev,
1010                                     struct scatterlist *sg, int nents,
1011                                     enum dma_data_direction direction);
1012         u64             (*dma_address)(struct ib_device *dev,
1013                                        struct scatterlist *sg);
1014         unsigned int    (*dma_len)(struct ib_device *dev,
1015                                    struct scatterlist *sg);
1016         void            (*sync_single_for_cpu)(struct ib_device *dev,
1017                                                u64 dma_handle,
1018                                                size_t size,
1019                                                enum dma_data_direction dir);
1020         void            (*sync_single_for_device)(struct ib_device *dev,
1021                                                   u64 dma_handle,
1022                                                   size_t size,
1023                                                   enum dma_data_direction dir);
1024         void            *(*alloc_coherent)(struct ib_device *dev,
1025                                            size_t size,
1026                                            u64 *dma_handle,
1027                                            gfp_t flag);
1028         void            (*free_coherent)(struct ib_device *dev,
1029                                          size_t size, void *cpu_addr,
1030                                          u64 dma_handle);
1031 };
1032
1033 struct iw_cm_verbs;
1034
1035 struct ib_device {
1036         struct device                *dma_device;
1037
1038         char                          name[IB_DEVICE_NAME_MAX];
1039
1040         struct list_head              event_handler_list;
1041         spinlock_t                    event_handler_lock;
1042
1043         spinlock_t                    client_data_lock;
1044         struct list_head              core_list;
1045         struct list_head              client_data_list;
1046
1047         struct ib_cache               cache;
1048         int                          *pkey_tbl_len;
1049         int                          *gid_tbl_len;
1050
1051         int                           num_comp_vectors;
1052
1053         struct iw_cm_verbs           *iwcm;
1054
1055         int                        (*get_protocol_stats)(struct ib_device *device,
1056                                                          union rdma_protocol_stats *stats);
1057         int                        (*query_device)(struct ib_device *device,
1058                                                    struct ib_device_attr *device_attr);
1059         int                        (*query_port)(struct ib_device *device,
1060                                                  u8 port_num,
1061                                                  struct ib_port_attr *port_attr);
1062         enum rdma_link_layer       (*get_link_layer)(struct ib_device *device,
1063                                                      u8 port_num);
1064         int                        (*query_gid)(struct ib_device *device,
1065                                                 u8 port_num, int index,
1066                                                 union ib_gid *gid);
1067         int                        (*query_pkey)(struct ib_device *device,
1068                                                  u8 port_num, u16 index, u16 *pkey);
1069         int                        (*modify_device)(struct ib_device *device,
1070                                                     int device_modify_mask,
1071                                                     struct ib_device_modify *device_modify);
1072         int                        (*modify_port)(struct ib_device *device,
1073                                                   u8 port_num, int port_modify_mask,
1074                                                   struct ib_port_modify *port_modify);
1075         struct ib_ucontext *       (*alloc_ucontext)(struct ib_device *device,
1076                                                      struct ib_udata *udata);
1077         int                        (*dealloc_ucontext)(struct ib_ucontext *context);
1078         int                        (*mmap)(struct ib_ucontext *context,
1079                                            struct vm_area_struct *vma);
1080         struct ib_pd *             (*alloc_pd)(struct ib_device *device,
1081                                                struct ib_ucontext *context,
1082                                                struct ib_udata *udata);
1083         int                        (*dealloc_pd)(struct ib_pd *pd);
1084         struct ib_ah *             (*create_ah)(struct ib_pd *pd,
1085                                                 struct ib_ah_attr *ah_attr);
1086         int                        (*modify_ah)(struct ib_ah *ah,
1087                                                 struct ib_ah_attr *ah_attr);
1088         int                        (*query_ah)(struct ib_ah *ah,
1089                                                struct ib_ah_attr *ah_attr);
1090         int                        (*destroy_ah)(struct ib_ah *ah);
1091         struct ib_srq *            (*create_srq)(struct ib_pd *pd,
1092                                                  struct ib_srq_init_attr *srq_init_attr,
1093                                                  struct ib_udata *udata);
1094         int                        (*modify_srq)(struct ib_srq *srq,
1095                                                  struct ib_srq_attr *srq_attr,
1096                                                  enum ib_srq_attr_mask srq_attr_mask,
1097                                                  struct ib_udata *udata);
1098         int                        (*query_srq)(struct ib_srq *srq,
1099                                                 struct ib_srq_attr *srq_attr);
1100         int                        (*destroy_srq)(struct ib_srq *srq);
1101         int                        (*post_srq_recv)(struct ib_srq *srq,
1102                                                     struct ib_recv_wr *recv_wr,
1103                                                     struct ib_recv_wr **bad_recv_wr);
1104         struct ib_qp *             (*create_qp)(struct ib_pd *pd,
1105                                                 struct ib_qp_init_attr *qp_init_attr,
1106                                                 struct ib_udata *udata);
1107         int                        (*modify_qp)(struct ib_qp *qp,
1108                                                 struct ib_qp_attr *qp_attr,
1109                                                 int qp_attr_mask,
1110                                                 struct ib_udata *udata);
1111         int                        (*query_qp)(struct ib_qp *qp,
1112                                                struct ib_qp_attr *qp_attr,
1113                                                int qp_attr_mask,
1114                                                struct ib_qp_init_attr *qp_init_attr);
1115         int                        (*destroy_qp)(struct ib_qp *qp);
1116         int                        (*post_send)(struct ib_qp *qp,
1117                                                 struct ib_send_wr *send_wr,
1118                                                 struct ib_send_wr **bad_send_wr);
1119         int                        (*post_recv)(struct ib_qp *qp,
1120                                                 struct ib_recv_wr *recv_wr,
1121                                                 struct ib_recv_wr **bad_recv_wr);
1122         struct ib_cq *             (*create_cq)(struct ib_device *device, int cqe,
1123                                                 int comp_vector,
1124                                                 struct ib_ucontext *context,
1125                                                 struct ib_udata *udata);
1126         int                        (*modify_cq)(struct ib_cq *cq, u16 cq_count,
1127                                                 u16 cq_period);
1128         int                        (*destroy_cq)(struct ib_cq *cq);
1129         int                        (*resize_cq)(struct ib_cq *cq, int cqe,
1130                                                 struct ib_udata *udata);
1131         int                        (*poll_cq)(struct ib_cq *cq, int num_entries,
1132                                               struct ib_wc *wc);
1133         int                        (*peek_cq)(struct ib_cq *cq, int wc_cnt);
1134         int                        (*req_notify_cq)(struct ib_cq *cq,
1135                                                     enum ib_cq_notify_flags flags);
1136         int                        (*req_ncomp_notif)(struct ib_cq *cq,
1137                                                       int wc_cnt);
1138         struct ib_mr *             (*get_dma_mr)(struct ib_pd *pd,
1139                                                  int mr_access_flags);
1140         struct ib_mr *             (*reg_phys_mr)(struct ib_pd *pd,
1141                                                   struct ib_phys_buf *phys_buf_array,
1142                                                   int num_phys_buf,
1143                                                   int mr_access_flags,
1144                                                   u64 *iova_start);
1145         struct ib_mr *             (*reg_user_mr)(struct ib_pd *pd,
1146                                                   u64 start, u64 length,
1147                                                   u64 virt_addr,
1148                                                   int mr_access_flags,
1149                                                   struct ib_udata *udata);
1150         int                        (*query_mr)(struct ib_mr *mr,
1151                                                struct ib_mr_attr *mr_attr);
1152         int                        (*dereg_mr)(struct ib_mr *mr);
1153         struct ib_mr *             (*alloc_fast_reg_mr)(struct ib_pd *pd,
1154                                                int max_page_list_len);
1155         struct ib_fast_reg_page_list * (*alloc_fast_reg_page_list)(struct ib_device *device,
1156                                                                    int page_list_len);
1157         void                       (*free_fast_reg_page_list)(struct ib_fast_reg_page_list *page_list);
1158         int                        (*rereg_phys_mr)(struct ib_mr *mr,
1159                                                     int mr_rereg_mask,
1160                                                     struct ib_pd *pd,
1161                                                     struct ib_phys_buf *phys_buf_array,
1162                                                     int num_phys_buf,
1163                                                     int mr_access_flags,
1164                                                     u64 *iova_start);
1165         struct ib_mw *             (*alloc_mw)(struct ib_pd *pd);
1166         int                        (*bind_mw)(struct ib_qp *qp,
1167                                               struct ib_mw *mw,
1168                                               struct ib_mw_bind *mw_bind);
1169         int                        (*dealloc_mw)(struct ib_mw *mw);
1170         struct ib_fmr *            (*alloc_fmr)(struct ib_pd *pd,
1171                                                 int mr_access_flags,
1172                                                 struct ib_fmr_attr *fmr_attr);
1173         int                        (*map_phys_fmr)(struct ib_fmr *fmr,
1174                                                    u64 *page_list, int list_len,
1175                                                    u64 iova);
1176         int                        (*unmap_fmr)(struct list_head *fmr_list);
1177         int                        (*dealloc_fmr)(struct ib_fmr *fmr);
1178         int                        (*attach_mcast)(struct ib_qp *qp,
1179                                                    union ib_gid *gid,
1180                                                    u16 lid);
1181         int                        (*detach_mcast)(struct ib_qp *qp,
1182                                                    union ib_gid *gid,
1183                                                    u16 lid);
1184         int                        (*process_mad)(struct ib_device *device,
1185                                                   int process_mad_flags,
1186                                                   u8 port_num,
1187                                                   struct ib_wc *in_wc,
1188                                                   struct ib_grh *in_grh,
1189                                                   struct ib_mad *in_mad,
1190                                                   struct ib_mad *out_mad);
1191         struct ib_xrcd *           (*alloc_xrcd)(struct ib_device *device,
1192                                                  struct ib_ucontext *ucontext,
1193                                                  struct ib_udata *udata);
1194         int                        (*dealloc_xrcd)(struct ib_xrcd *xrcd);
1195
1196         struct ib_dma_mapping_ops   *dma_ops;
1197
1198         struct module               *owner;
1199         struct device                dev;
1200         struct kobject               *ports_parent;
1201         struct list_head             port_list;
1202
1203         enum {
1204                 IB_DEV_UNINITIALIZED,
1205                 IB_DEV_REGISTERED,
1206                 IB_DEV_UNREGISTERED
1207         }                            reg_state;
1208
1209         int                          uverbs_abi_ver;
1210         u64                          uverbs_cmd_mask;
1211
1212         char                         node_desc[64];
1213         __be64                       node_guid;
1214         u32                          local_dma_lkey;
1215         u8                           node_type;
1216         u8                           phys_port_cnt;
1217 };
1218
1219 struct ib_client {
1220         char  *name;
1221         void (*add)   (struct ib_device *);
1222         void (*remove)(struct ib_device *);
1223
1224         struct list_head list;
1225 };
1226
1227 struct ib_device *ib_alloc_device(size_t size);
1228 void ib_dealloc_device(struct ib_device *device);
1229
1230 int ib_register_device(struct ib_device *device,
1231                        int (*port_callback)(struct ib_device *,
1232                                             u8, struct kobject *));
1233 void ib_unregister_device(struct ib_device *device);
1234
1235 int ib_register_client   (struct ib_client *client);
1236 void ib_unregister_client(struct ib_client *client);
1237
1238 void *ib_get_client_data(struct ib_device *device, struct ib_client *client);
1239 void  ib_set_client_data(struct ib_device *device, struct ib_client *client,
1240                          void *data);
1241
1242 static inline int ib_copy_from_udata(void *dest, struct ib_udata *udata, size_t len)
1243 {
1244         return copy_from_user(dest, udata->inbuf, len) ? -EFAULT : 0;
1245 }
1246
1247 static inline int ib_copy_to_udata(struct ib_udata *udata, void *src, size_t len)
1248 {
1249         return copy_to_user(udata->outbuf, src, len) ? -EFAULT : 0;
1250 }
1251
1252 /**
1253  * ib_modify_qp_is_ok - Check that the supplied attribute mask
1254  * contains all required attributes and no attributes not allowed for
1255  * the given QP state transition.
1256  * @cur_state: Current QP state
1257  * @next_state: Next QP state
1258  * @type: QP type
1259  * @mask: Mask of supplied QP attributes
1260  *
1261  * This function is a helper function that a low-level driver's
1262  * modify_qp method can use to validate the consumer's input.  It
1263  * checks that cur_state and next_state are valid QP states, that a
1264  * transition from cur_state to next_state is allowed by the IB spec,
1265  * and that the attribute mask supplied is allowed for the transition.
1266  */
1267 int ib_modify_qp_is_ok(enum ib_qp_state cur_state, enum ib_qp_state next_state,
1268                        enum ib_qp_type type, enum ib_qp_attr_mask mask);
1269
1270 int ib_register_event_handler  (struct ib_event_handler *event_handler);
1271 int ib_unregister_event_handler(struct ib_event_handler *event_handler);
1272 void ib_dispatch_event(struct ib_event *event);
1273
1274 int ib_query_device(struct ib_device *device,
1275                     struct ib_device_attr *device_attr);
1276
1277 int ib_query_port(struct ib_device *device,
1278                   u8 port_num, struct ib_port_attr *port_attr);
1279
1280 enum rdma_link_layer rdma_port_get_link_layer(struct ib_device *device,
1281                                                u8 port_num);
1282
1283 int ib_query_gid(struct ib_device *device,
1284                  u8 port_num, int index, union ib_gid *gid);
1285
1286 int ib_query_pkey(struct ib_device *device,
1287                   u8 port_num, u16 index, u16 *pkey);
1288
1289 int ib_modify_device(struct ib_device *device,
1290                      int device_modify_mask,
1291                      struct ib_device_modify *device_modify);
1292
1293 int ib_modify_port(struct ib_device *device,
1294                    u8 port_num, int port_modify_mask,
1295                    struct ib_port_modify *port_modify);
1296
1297 int ib_find_gid(struct ib_device *device, union ib_gid *gid,
1298                 u8 *port_num, u16 *index);
1299
1300 int ib_find_pkey(struct ib_device *device,
1301                  u8 port_num, u16 pkey, u16 *index);
1302
1303 /**
1304  * ib_alloc_pd - Allocates an unused protection domain.
1305  * @device: The device on which to allocate the protection domain.
1306  *
1307  * A protection domain object provides an association between QPs, shared
1308  * receive queues, address handles, memory regions, and memory windows.
1309  */
1310 struct ib_pd *ib_alloc_pd(struct ib_device *device);
1311
1312 /**
1313  * ib_dealloc_pd - Deallocates a protection domain.
1314  * @pd: The protection domain to deallocate.
1315  */
1316 int ib_dealloc_pd(struct ib_pd *pd);
1317
1318 /**
1319  * ib_create_ah - Creates an address handle for the given address vector.
1320  * @pd: The protection domain associated with the address handle.
1321  * @ah_attr: The attributes of the address vector.
1322  *
1323  * The address handle is used to reference a local or global destination
1324  * in all UD QP post sends.
1325  */
1326 struct ib_ah *ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
1327
1328 /**
1329  * ib_init_ah_from_wc - Initializes address handle attributes from a
1330  *   work completion.
1331  * @device: Device on which the received message arrived.
1332  * @port_num: Port on which the received message arrived.
1333  * @wc: Work completion associated with the received message.
1334  * @grh: References the received global route header.  This parameter is
1335  *   ignored unless the work completion indicates that the GRH is valid.
1336  * @ah_attr: Returned attributes that can be used when creating an address
1337  *   handle for replying to the message.
1338  */
1339 int ib_init_ah_from_wc(struct ib_device *device, u8 port_num, struct ib_wc *wc,
1340                        struct ib_grh *grh, struct ib_ah_attr *ah_attr);
1341
1342 /**
1343  * ib_create_ah_from_wc - Creates an address handle associated with the
1344  *   sender of the specified work completion.
1345  * @pd: The protection domain associated with the address handle.
1346  * @wc: Work completion information associated with a received message.
1347  * @grh: References the received global route header.  This parameter is
1348  *   ignored unless the work completion indicates that the GRH is valid.
1349  * @port_num: The outbound port number to associate with the address.
1350  *
1351  * The address handle is used to reference a local or global destination
1352  * in all UD QP post sends.
1353  */
1354 struct ib_ah *ib_create_ah_from_wc(struct ib_pd *pd, struct ib_wc *wc,
1355                                    struct ib_grh *grh, u8 port_num);
1356
1357 /**
1358  * ib_modify_ah - Modifies the address vector associated with an address
1359  *   handle.
1360  * @ah: The address handle to modify.
1361  * @ah_attr: The new address vector attributes to associate with the
1362  *   address handle.
1363  */
1364 int ib_modify_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1365
1366 /**
1367  * ib_query_ah - Queries the address vector associated with an address
1368  *   handle.
1369  * @ah: The address handle to query.
1370  * @ah_attr: The address vector attributes associated with the address
1371  *   handle.
1372  */
1373 int ib_query_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1374
1375 /**
1376  * ib_destroy_ah - Destroys an address handle.
1377  * @ah: The address handle to destroy.
1378  */
1379 int ib_destroy_ah(struct ib_ah *ah);
1380
1381 /**
1382  * ib_create_srq - Creates a SRQ associated with the specified protection
1383  *   domain.
1384  * @pd: The protection domain associated with the SRQ.
1385  * @srq_init_attr: A list of initial attributes required to create the
1386  *   SRQ.  If SRQ creation succeeds, then the attributes are updated to
1387  *   the actual capabilities of the created SRQ.
1388  *
1389  * srq_attr->max_wr and srq_attr->max_sge are read the determine the
1390  * requested size of the SRQ, and set to the actual values allocated
1391  * on return.  If ib_create_srq() succeeds, then max_wr and max_sge
1392  * will always be at least as large as the requested values.
1393  */
1394 struct ib_srq *ib_create_srq(struct ib_pd *pd,
1395                              struct ib_srq_init_attr *srq_init_attr);
1396
1397 /**
1398  * ib_modify_srq - Modifies the attributes for the specified SRQ.
1399  * @srq: The SRQ to modify.
1400  * @srq_attr: On input, specifies the SRQ attributes to modify.  On output,
1401  *   the current values of selected SRQ attributes are returned.
1402  * @srq_attr_mask: A bit-mask used to specify which attributes of the SRQ
1403  *   are being modified.
1404  *
1405  * The mask may contain IB_SRQ_MAX_WR to resize the SRQ and/or
1406  * IB_SRQ_LIMIT to set the SRQ's limit and request notification when
1407  * the number of receives queued drops below the limit.
1408  */
1409 int ib_modify_srq(struct ib_srq *srq,
1410                   struct ib_srq_attr *srq_attr,
1411                   enum ib_srq_attr_mask srq_attr_mask);
1412
1413 /**
1414  * ib_query_srq - Returns the attribute list and current values for the
1415  *   specified SRQ.
1416  * @srq: The SRQ to query.
1417  * @srq_attr: The attributes of the specified SRQ.
1418  */
1419 int ib_query_srq(struct ib_srq *srq,
1420                  struct ib_srq_attr *srq_attr);
1421
1422 /**
1423  * ib_destroy_srq - Destroys the specified SRQ.
1424  * @srq: The SRQ to destroy.
1425  */
1426 int ib_destroy_srq(struct ib_srq *srq);
1427
1428 /**
1429  * ib_post_srq_recv - Posts a list of work requests to the specified SRQ.
1430  * @srq: The SRQ to post the work request on.
1431  * @recv_wr: A list of work requests to post on the receive queue.
1432  * @bad_recv_wr: On an immediate failure, this parameter will reference
1433  *   the work request that failed to be posted on the QP.
1434  */
1435 static inline int ib_post_srq_recv(struct ib_srq *srq,
1436                                    struct ib_recv_wr *recv_wr,
1437                                    struct ib_recv_wr **bad_recv_wr)
1438 {
1439         return srq->device->post_srq_recv(srq, recv_wr, bad_recv_wr);
1440 }
1441
1442 /**
1443  * ib_create_qp - Creates a QP associated with the specified protection
1444  *   domain.
1445  * @pd: The protection domain associated with the QP.
1446  * @qp_init_attr: A list of initial attributes required to create the
1447  *   QP.  If QP creation succeeds, then the attributes are updated to
1448  *   the actual capabilities of the created QP.
1449  */
1450 struct ib_qp *ib_create_qp(struct ib_pd *pd,
1451                            struct ib_qp_init_attr *qp_init_attr);
1452
1453 /**
1454  * ib_modify_qp - Modifies the attributes for the specified QP and then
1455  *   transitions the QP to the given state.
1456  * @qp: The QP to modify.
1457  * @qp_attr: On input, specifies the QP attributes to modify.  On output,
1458  *   the current values of selected QP attributes are returned.
1459  * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
1460  *   are being modified.
1461  */
1462 int ib_modify_qp(struct ib_qp *qp,
1463                  struct ib_qp_attr *qp_attr,
1464                  int qp_attr_mask);
1465
1466 /**
1467  * ib_query_qp - Returns the attribute list and current values for the
1468  *   specified QP.
1469  * @qp: The QP to query.
1470  * @qp_attr: The attributes of the specified QP.
1471  * @qp_attr_mask: A bit-mask used to select specific attributes to query.
1472  * @qp_init_attr: Additional attributes of the selected QP.
1473  *
1474  * The qp_attr_mask may be used to limit the query to gathering only the
1475  * selected attributes.
1476  */
1477 int ib_query_qp(struct ib_qp *qp,
1478                 struct ib_qp_attr *qp_attr,
1479                 int qp_attr_mask,
1480                 struct ib_qp_init_attr *qp_init_attr);
1481
1482 /**
1483  * ib_destroy_qp - Destroys the specified QP.
1484  * @qp: The QP to destroy.
1485  */
1486 int ib_destroy_qp(struct ib_qp *qp);
1487
1488 /**
1489  * ib_release_qp - Release an external reference to a QP.
1490  * @qp: The QP handle to release
1491  *
1492  * The specified QP handle is released by the caller.  If the QP is
1493  * referenced internally, it is not destroyed until all internal
1494  * references are released.  After releasing the qp, the caller
1495  * can no longer access it and all events on the QP are discarded.
1496  */
1497 int ib_release_qp(struct ib_qp *qp);
1498
1499 /**
1500  * ib_post_send - Posts a list of work requests to the send queue of
1501  *   the specified QP.
1502  * @qp: The QP to post the work request on.
1503  * @send_wr: A list of work requests to post on the send queue.
1504  * @bad_send_wr: On an immediate failure, this parameter will reference
1505  *   the work request that failed to be posted on the QP.
1506  *
1507  * While IBA Vol. 1 section 11.4.1.1 specifies that if an immediate
1508  * error is returned, the QP state shall not be affected,
1509  * ib_post_send() will return an immediate error after queueing any
1510  * earlier work requests in the list.
1511  */
1512 static inline int ib_post_send(struct ib_qp *qp,
1513                                struct ib_send_wr *send_wr,
1514                                struct ib_send_wr **bad_send_wr)
1515 {
1516         return qp->device->post_send(qp, send_wr, bad_send_wr);
1517 }
1518
1519 /**
1520  * ib_post_recv - Posts a list of work requests to the receive queue of
1521  *   the specified QP.
1522  * @qp: The QP to post the work request on.
1523  * @recv_wr: A list of work requests to post on the receive queue.
1524  * @bad_recv_wr: On an immediate failure, this parameter will reference
1525  *   the work request that failed to be posted on the QP.
1526  */
1527 static inline int ib_post_recv(struct ib_qp *qp,
1528                                struct ib_recv_wr *recv_wr,
1529                                struct ib_recv_wr **bad_recv_wr)
1530 {
1531         return qp->device->post_recv(qp, recv_wr, bad_recv_wr);
1532 }
1533
1534 /**
1535  * ib_create_cq - Creates a CQ on the specified device.
1536  * @device: The device on which to create the CQ.
1537  * @comp_handler: A user-specified callback that is invoked when a
1538  *   completion event occurs on the CQ.
1539  * @event_handler: A user-specified callback that is invoked when an
1540  *   asynchronous event not associated with a completion occurs on the CQ.
1541  * @cq_context: Context associated with the CQ returned to the user via
1542  *   the associated completion and event handlers.
1543  * @cqe: The minimum size of the CQ.
1544  * @comp_vector - Completion vector used to signal completion events.
1545  *     Must be >= 0 and < context->num_comp_vectors.
1546  *
1547  * Users can examine the cq structure to determine the actual CQ size.
1548  */
1549 struct ib_cq *ib_create_cq(struct ib_device *device,
1550                            ib_comp_handler comp_handler,
1551                            void (*event_handler)(struct ib_event *, void *),
1552                            void *cq_context, int cqe, int comp_vector);
1553
1554 /**
1555  * ib_resize_cq - Modifies the capacity of the CQ.
1556  * @cq: The CQ to resize.
1557  * @cqe: The minimum size of the CQ.
1558  *
1559  * Users can examine the cq structure to determine the actual CQ size.
1560  */
1561 int ib_resize_cq(struct ib_cq *cq, int cqe);
1562
1563 /**
1564  * ib_modify_cq - Modifies moderation params of the CQ
1565  * @cq: The CQ to modify.
1566  * @cq_count: number of CQEs that will trigger an event
1567  * @cq_period: max period of time in usec before triggering an event
1568  *
1569  */
1570 int ib_modify_cq(struct ib_cq *cq, u16 cq_count, u16 cq_period);
1571
1572 /**
1573  * ib_destroy_cq - Destroys the specified CQ.
1574  * @cq: The CQ to destroy.
1575  */
1576 int ib_destroy_cq(struct ib_cq *cq);
1577
1578 /**
1579  * ib_poll_cq - poll a CQ for completion(s)
1580  * @cq:the CQ being polled
1581  * @num_entries:maximum number of completions to return
1582  * @wc:array of at least @num_entries &struct ib_wc where completions
1583  *   will be returned
1584  *
1585  * Poll a CQ for (possibly multiple) completions.  If the return value
1586  * is < 0, an error occurred.  If the return value is >= 0, it is the
1587  * number of completions returned.  If the return value is
1588  * non-negative and < num_entries, then the CQ was emptied.
1589  */
1590 static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
1591                              struct ib_wc *wc)
1592 {
1593         return cq->device->poll_cq(cq, num_entries, wc);
1594 }
1595
1596 /**
1597  * ib_peek_cq - Returns the number of unreaped completions currently
1598  *   on the specified CQ.
1599  * @cq: The CQ to peek.
1600  * @wc_cnt: A minimum number of unreaped completions to check for.
1601  *
1602  * If the number of unreaped completions is greater than or equal to wc_cnt,
1603  * this function returns wc_cnt, otherwise, it returns the actual number of
1604  * unreaped completions.
1605  */
1606 int ib_peek_cq(struct ib_cq *cq, int wc_cnt);
1607
1608 /**
1609  * ib_req_notify_cq - Request completion notification on a CQ.
1610  * @cq: The CQ to generate an event for.
1611  * @flags:
1612  *   Must contain exactly one of %IB_CQ_SOLICITED or %IB_CQ_NEXT_COMP
1613  *   to request an event on the next solicited event or next work
1614  *   completion at any type, respectively. %IB_CQ_REPORT_MISSED_EVENTS
1615  *   may also be |ed in to request a hint about missed events, as
1616  *   described below.
1617  *
1618  * Return Value:
1619  *    < 0 means an error occurred while requesting notification
1620  *   == 0 means notification was requested successfully, and if
1621  *        IB_CQ_REPORT_MISSED_EVENTS was passed in, then no events
1622  *        were missed and it is safe to wait for another event.  In
1623  *        this case is it guaranteed that any work completions added
1624  *        to the CQ since the last CQ poll will trigger a completion
1625  *        notification event.
1626  *    > 0 is only returned if IB_CQ_REPORT_MISSED_EVENTS was passed
1627  *        in.  It means that the consumer must poll the CQ again to
1628  *        make sure it is empty to avoid missing an event because of a
1629  *        race between requesting notification and an entry being
1630  *        added to the CQ.  This return value means it is possible
1631  *        (but not guaranteed) that a work completion has been added
1632  *        to the CQ since the last poll without triggering a
1633  *        completion notification event.
1634  */
1635 static inline int ib_req_notify_cq(struct ib_cq *cq,
1636                                    enum ib_cq_notify_flags flags)
1637 {
1638         return cq->device->req_notify_cq(cq, flags);
1639 }
1640
1641 /**
1642  * ib_req_ncomp_notif - Request completion notification when there are
1643  *   at least the specified number of unreaped completions on the CQ.
1644  * @cq: The CQ to generate an event for.
1645  * @wc_cnt: The number of unreaped completions that should be on the
1646  *   CQ before an event is generated.
1647  */
1648 static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
1649 {
1650         return cq->device->req_ncomp_notif ?
1651                 cq->device->req_ncomp_notif(cq, wc_cnt) :
1652                 -ENOSYS;
1653 }
1654
1655 /**
1656  * ib_get_dma_mr - Returns a memory region for system memory that is
1657  *   usable for DMA.
1658  * @pd: The protection domain associated with the memory region.
1659  * @mr_access_flags: Specifies the memory access rights.
1660  *
1661  * Note that the ib_dma_*() functions defined below must be used
1662  * to create/destroy addresses used with the Lkey or Rkey returned
1663  * by ib_get_dma_mr().
1664  */
1665 struct ib_mr *ib_get_dma_mr(struct ib_pd *pd, int mr_access_flags);
1666
1667 /**
1668  * ib_dma_mapping_error - check a DMA addr for error
1669  * @dev: The device for which the dma_addr was created
1670  * @dma_addr: The DMA address to check
1671  */
1672 static inline int ib_dma_mapping_error(struct ib_device *dev, u64 dma_addr)
1673 {
1674         if (dev->dma_ops)
1675                 return dev->dma_ops->mapping_error(dev, dma_addr);
1676         return dma_mapping_error(dev->dma_device, dma_addr);
1677 }
1678
1679 /**
1680  * ib_dma_map_single - Map a kernel virtual address to DMA address
1681  * @dev: The device for which the dma_addr is to be created
1682  * @cpu_addr: The kernel virtual address
1683  * @size: The size of the region in bytes
1684  * @direction: The direction of the DMA
1685  */
1686 static inline u64 ib_dma_map_single(struct ib_device *dev,
1687                                     void *cpu_addr, size_t size,
1688                                     enum dma_data_direction direction)
1689 {
1690         if (dev->dma_ops)
1691                 return dev->dma_ops->map_single(dev, cpu_addr, size, direction);
1692         return dma_map_single(dev->dma_device, cpu_addr, size, direction);
1693 }
1694
1695 /**
1696  * ib_dma_unmap_single - Destroy a mapping created by ib_dma_map_single()
1697  * @dev: The device for which the DMA address was created
1698  * @addr: The DMA address
1699  * @size: The size of the region in bytes
1700  * @direction: The direction of the DMA
1701  */
1702 static inline void ib_dma_unmap_single(struct ib_device *dev,
1703                                        u64 addr, size_t size,
1704                                        enum dma_data_direction direction)
1705 {
1706         if (dev->dma_ops)
1707                 dev->dma_ops->unmap_single(dev, addr, size, direction);
1708         else
1709                 dma_unmap_single(dev->dma_device, addr, size, direction);
1710 }
1711
1712 static inline u64 ib_dma_map_single_attrs(struct ib_device *dev,
1713                                           void *cpu_addr, size_t size,
1714                                           enum dma_data_direction direction,
1715                                           struct dma_attrs *attrs)
1716 {
1717         return dma_map_single_attrs(dev->dma_device, cpu_addr, size,
1718                                     direction, attrs);
1719 }
1720
1721 static inline void ib_dma_unmap_single_attrs(struct ib_device *dev,
1722                                              u64 addr, size_t size,
1723                                              enum dma_data_direction direction,
1724                                              struct dma_attrs *attrs)
1725 {
1726         return dma_unmap_single_attrs(dev->dma_device, addr, size,
1727                                       direction, attrs);
1728 }
1729
1730 /**
1731  * ib_dma_map_page - Map a physical page to DMA address
1732  * @dev: The device for which the dma_addr is to be created
1733  * @page: The page to be mapped
1734  * @offset: The offset within the page
1735  * @size: The size of the region in bytes
1736  * @direction: The direction of the DMA
1737  */
1738 static inline u64 ib_dma_map_page(struct ib_device *dev,
1739                                   struct page *page,
1740                                   unsigned long offset,
1741                                   size_t size,
1742                                          enum dma_data_direction direction)
1743 {
1744         if (dev->dma_ops)
1745                 return dev->dma_ops->map_page(dev, page, offset, size, direction);
1746         return dma_map_page(dev->dma_device, page, offset, size, direction);
1747 }
1748
1749 /**
1750  * ib_dma_unmap_page - Destroy a mapping created by ib_dma_map_page()
1751  * @dev: The device for which the DMA address was created
1752  * @addr: The DMA address
1753  * @size: The size of the region in bytes
1754  * @direction: The direction of the DMA
1755  */
1756 static inline void ib_dma_unmap_page(struct ib_device *dev,
1757                                      u64 addr, size_t size,
1758                                      enum dma_data_direction direction)
1759 {
1760         if (dev->dma_ops)
1761                 dev->dma_ops->unmap_page(dev, addr, size, direction);
1762         else
1763                 dma_unmap_page(dev->dma_device, addr, size, direction);
1764 }
1765
1766 /**
1767  * ib_dma_map_sg - Map a scatter/gather list to DMA addresses
1768  * @dev: The device for which the DMA addresses are to be created
1769  * @sg: The array of scatter/gather entries
1770  * @nents: The number of scatter/gather entries
1771  * @direction: The direction of the DMA
1772  */
1773 static inline int ib_dma_map_sg(struct ib_device *dev,
1774                                 struct scatterlist *sg, int nents,
1775                                 enum dma_data_direction direction)
1776 {
1777         if (dev->dma_ops)
1778                 return dev->dma_ops->map_sg(dev, sg, nents, direction);
1779         return dma_map_sg(dev->dma_device, sg, nents, direction);
1780 }
1781
1782 /**
1783  * ib_dma_unmap_sg - Unmap a scatter/gather list of DMA addresses
1784  * @dev: The device for which the DMA addresses were created
1785  * @sg: The array of scatter/gather entries
1786  * @nents: The number of scatter/gather entries
1787  * @direction: The direction of the DMA
1788  */
1789 static inline void ib_dma_unmap_sg(struct ib_device *dev,
1790                                    struct scatterlist *sg, int nents,
1791                                    enum dma_data_direction direction)
1792 {
1793         if (dev->dma_ops)
1794                 dev->dma_ops->unmap_sg(dev, sg, nents, direction);
1795         else
1796                 dma_unmap_sg(dev->dma_device, sg, nents, direction);
1797 }
1798
1799 static inline int ib_dma_map_sg_attrs(struct ib_device *dev,
1800                                       struct scatterlist *sg, int nents,
1801                                       enum dma_data_direction direction,
1802                                       struct dma_attrs *attrs)
1803 {
1804         return dma_map_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
1805 }
1806
1807 static inline void ib_dma_unmap_sg_attrs(struct ib_device *dev,
1808                                          struct scatterlist *sg, int nents,
1809                                          enum dma_data_direction direction,
1810                                          struct dma_attrs *attrs)
1811 {
1812         dma_unmap_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
1813 }
1814 /**
1815  * ib_sg_dma_address - Return the DMA address from a scatter/gather entry
1816  * @dev: The device for which the DMA addresses were created
1817  * @sg: The scatter/gather entry
1818  */
1819 static inline u64 ib_sg_dma_address(struct ib_device *dev,
1820                                     struct scatterlist *sg)
1821 {
1822         if (dev->dma_ops)
1823                 return dev->dma_ops->dma_address(dev, sg);
1824         return sg_dma_address(sg);
1825 }
1826
1827 /**
1828  * ib_sg_dma_len - Return the DMA length from a scatter/gather entry
1829  * @dev: The device for which the DMA addresses were created
1830  * @sg: The scatter/gather entry
1831  */
1832 static inline unsigned int ib_sg_dma_len(struct ib_device *dev,
1833                                          struct scatterlist *sg)
1834 {
1835         if (dev->dma_ops)
1836                 return dev->dma_ops->dma_len(dev, sg);
1837         return sg_dma_len(sg);
1838 }
1839
1840 /**
1841  * ib_dma_sync_single_for_cpu - Prepare DMA region to be accessed by CPU
1842  * @dev: The device for which the DMA address was created
1843  * @addr: The DMA address
1844  * @size: The size of the region in bytes
1845  * @dir: The direction of the DMA
1846  */
1847 static inline void ib_dma_sync_single_for_cpu(struct ib_device *dev,
1848                                               u64 addr,
1849                                               size_t size,
1850                                               enum dma_data_direction dir)
1851 {
1852         if (dev->dma_ops)
1853                 dev->dma_ops->sync_single_for_cpu(dev, addr, size, dir);
1854         else
1855                 dma_sync_single_for_cpu(dev->dma_device, addr, size, dir);
1856 }
1857
1858 /**
1859  * ib_dma_sync_single_for_device - Prepare DMA region to be accessed by device
1860  * @dev: The device for which the DMA address was created
1861  * @addr: The DMA address
1862  * @size: The size of the region in bytes
1863  * @dir: The direction of the DMA
1864  */
1865 static inline void ib_dma_sync_single_for_device(struct ib_device *dev,
1866                                                  u64 addr,
1867                                                  size_t size,
1868                                                  enum dma_data_direction dir)
1869 {
1870         if (dev->dma_ops)
1871                 dev->dma_ops->sync_single_for_device(dev, addr, size, dir);
1872         else
1873                 dma_sync_single_for_device(dev->dma_device, addr, size, dir);
1874 }
1875
1876 /**
1877  * ib_dma_alloc_coherent - Allocate memory and map it for DMA
1878  * @dev: The device for which the DMA address is requested
1879  * @size: The size of the region to allocate in bytes
1880  * @dma_handle: A pointer for returning the DMA address of the region
1881  * @flag: memory allocator flags
1882  */
1883 static inline void *ib_dma_alloc_coherent(struct ib_device *dev,
1884                                            size_t size,
1885                                            u64 *dma_handle,
1886                                            gfp_t flag)
1887 {
1888         if (dev->dma_ops)
1889                 return dev->dma_ops->alloc_coherent(dev, size, dma_handle, flag);
1890         else {
1891                 dma_addr_t handle;
1892                 void *ret;
1893
1894                 ret = dma_alloc_coherent(dev->dma_device, size, &handle, flag);
1895                 *dma_handle = handle;
1896                 return ret;
1897         }
1898 }
1899
1900 /**
1901  * ib_dma_free_coherent - Free memory allocated by ib_dma_alloc_coherent()
1902  * @dev: The device for which the DMA addresses were allocated
1903  * @size: The size of the region
1904  * @cpu_addr: the address returned by ib_dma_alloc_coherent()
1905  * @dma_handle: the DMA address returned by ib_dma_alloc_coherent()
1906  */
1907 static inline void ib_dma_free_coherent(struct ib_device *dev,
1908                                         size_t size, void *cpu_addr,
1909                                         u64 dma_handle)
1910 {
1911         if (dev->dma_ops)
1912                 dev->dma_ops->free_coherent(dev, size, cpu_addr, dma_handle);
1913         else
1914                 dma_free_coherent(dev->dma_device, size, cpu_addr, dma_handle);
1915 }
1916
1917 /**
1918  * ib_reg_phys_mr - Prepares a virtually addressed memory region for use
1919  *   by an HCA.
1920  * @pd: The protection domain associated assigned to the registered region.
1921  * @phys_buf_array: Specifies a list of physical buffers to use in the
1922  *   memory region.
1923  * @num_phys_buf: Specifies the size of the phys_buf_array.
1924  * @mr_access_flags: Specifies the memory access rights.
1925  * @iova_start: The offset of the region's starting I/O virtual address.
1926  */
1927 struct ib_mr *ib_reg_phys_mr(struct ib_pd *pd,
1928                              struct ib_phys_buf *phys_buf_array,
1929                              int num_phys_buf,
1930                              int mr_access_flags,
1931                              u64 *iova_start);
1932
1933 /**
1934  * ib_rereg_phys_mr - Modifies the attributes of an existing memory region.
1935  *   Conceptually, this call performs the functions deregister memory region
1936  *   followed by register physical memory region.  Where possible,
1937  *   resources are reused instead of deallocated and reallocated.
1938  * @mr: The memory region to modify.
1939  * @mr_rereg_mask: A bit-mask used to indicate which of the following
1940  *   properties of the memory region are being modified.
1941  * @pd: If %IB_MR_REREG_PD is set in mr_rereg_mask, this field specifies
1942  *   the new protection domain to associated with the memory region,
1943  *   otherwise, this parameter is ignored.
1944  * @phys_buf_array: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1945  *   field specifies a list of physical buffers to use in the new
1946  *   translation, otherwise, this parameter is ignored.
1947  * @num_phys_buf: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1948  *   field specifies the size of the phys_buf_array, otherwise, this
1949  *   parameter is ignored.
1950  * @mr_access_flags: If %IB_MR_REREG_ACCESS is set in mr_rereg_mask, this
1951  *   field specifies the new memory access rights, otherwise, this
1952  *   parameter is ignored.
1953  * @iova_start: The offset of the region's starting I/O virtual address.
1954  */
1955 int ib_rereg_phys_mr(struct ib_mr *mr,
1956                      int mr_rereg_mask,
1957                      struct ib_pd *pd,
1958                      struct ib_phys_buf *phys_buf_array,
1959                      int num_phys_buf,
1960                      int mr_access_flags,
1961                      u64 *iova_start);
1962
1963 /**
1964  * ib_query_mr - Retrieves information about a specific memory region.
1965  * @mr: The memory region to retrieve information about.
1966  * @mr_attr: The attributes of the specified memory region.
1967  */
1968 int ib_query_mr(struct ib_mr *mr, struct ib_mr_attr *mr_attr);
1969
1970 /**
1971  * ib_dereg_mr - Deregisters a memory region and removes it from the
1972  *   HCA translation table.
1973  * @mr: The memory region to deregister.
1974  */
1975 int ib_dereg_mr(struct ib_mr *mr);
1976
1977 /**
1978  * ib_alloc_fast_reg_mr - Allocates memory region usable with the
1979  *   IB_WR_FAST_REG_MR send work request.
1980  * @pd: The protection domain associated with the region.
1981  * @max_page_list_len: requested max physical buffer list length to be
1982  *   used with fast register work requests for this MR.
1983  */
1984 struct ib_mr *ib_alloc_fast_reg_mr(struct ib_pd *pd, int max_page_list_len);
1985
1986 /**
1987  * ib_alloc_fast_reg_page_list - Allocates a page list array
1988  * @device - ib device pointer.
1989  * @page_list_len - size of the page list array to be allocated.
1990  *
1991  * This allocates and returns a struct ib_fast_reg_page_list * and a
1992  * page_list array that is at least page_list_len in size.  The actual
1993  * size is returned in max_page_list_len.  The caller is responsible
1994  * for initializing the contents of the page_list array before posting
1995  * a send work request with the IB_WC_FAST_REG_MR opcode.
1996  *
1997  * The page_list array entries must be translated using one of the
1998  * ib_dma_*() functions just like the addresses passed to
1999  * ib_map_phys_fmr().  Once the ib_post_send() is issued, the struct
2000  * ib_fast_reg_page_list must not be modified by the caller until the
2001  * IB_WC_FAST_REG_MR work request completes.
2002  */
2003 struct ib_fast_reg_page_list *ib_alloc_fast_reg_page_list(
2004                                 struct ib_device *device, int page_list_len);
2005
2006 /**
2007  * ib_free_fast_reg_page_list - Deallocates a previously allocated
2008  *   page list array.
2009  * @page_list - struct ib_fast_reg_page_list pointer to be deallocated.
2010  */
2011 void ib_free_fast_reg_page_list(struct ib_fast_reg_page_list *page_list);
2012
2013 /**
2014  * ib_update_fast_reg_key - updates the key portion of the fast_reg MR
2015  *   R_Key and L_Key.
2016  * @mr - struct ib_mr pointer to be updated.
2017  * @newkey - new key to be used.
2018  */
2019 static inline void ib_update_fast_reg_key(struct ib_mr *mr, u8 newkey)
2020 {
2021         mr->lkey = (mr->lkey & 0xffffff00) | newkey;
2022         mr->rkey = (mr->rkey & 0xffffff00) | newkey;
2023 }
2024
2025 /**
2026  * ib_alloc_mw - Allocates a memory window.
2027  * @pd: The protection domain associated with the memory window.
2028  */
2029 struct ib_mw *ib_alloc_mw(struct ib_pd *pd);
2030
2031 /**
2032  * ib_bind_mw - Posts a work request to the send queue of the specified
2033  *   QP, which binds the memory window to the given address range and
2034  *   remote access attributes.
2035  * @qp: QP to post the bind work request on.
2036  * @mw: The memory window to bind.
2037  * @mw_bind: Specifies information about the memory window, including
2038  *   its address range, remote access rights, and associated memory region.
2039  */
2040 static inline int ib_bind_mw(struct ib_qp *qp,
2041                              struct ib_mw *mw,
2042                              struct ib_mw_bind *mw_bind)
2043 {
2044         /* XXX reference counting in corresponding MR? */
2045         return mw->device->bind_mw ?
2046                 mw->device->bind_mw(qp, mw, mw_bind) :
2047                 -ENOSYS;
2048 }
2049
2050 /**
2051  * ib_dealloc_mw - Deallocates a memory window.
2052  * @mw: The memory window to deallocate.
2053  */
2054 int ib_dealloc_mw(struct ib_mw *mw);
2055
2056 /**
2057  * ib_alloc_fmr - Allocates a unmapped fast memory region.
2058  * @pd: The protection domain associated with the unmapped region.
2059  * @mr_access_flags: Specifies the memory access rights.
2060  * @fmr_attr: Attributes of the unmapped region.
2061  *
2062  * A fast memory region must be mapped before it can be used as part of
2063  * a work request.
2064  */
2065 struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
2066                             int mr_access_flags,
2067                             struct ib_fmr_attr *fmr_attr);
2068
2069 /**
2070  * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
2071  * @fmr: The fast memory region to associate with the pages.
2072  * @page_list: An array of physical pages to map to the fast memory region.
2073  * @list_len: The number of pages in page_list.
2074  * @iova: The I/O virtual address to use with the mapped region.
2075  */
2076 static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
2077                                   u64 *page_list, int list_len,
2078                                   u64 iova)
2079 {
2080         return fmr->device->map_phys_fmr(fmr, page_list, list_len, iova);
2081 }
2082
2083 /**
2084  * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
2085  * @fmr_list: A linked list of fast memory regions to unmap.
2086  */
2087 int ib_unmap_fmr(struct list_head *fmr_list);
2088
2089 /**
2090  * ib_dealloc_fmr - Deallocates a fast memory region.
2091  * @fmr: The fast memory region to deallocate.
2092  */
2093 int ib_dealloc_fmr(struct ib_fmr *fmr);
2094
2095 /**
2096  * ib_attach_mcast - Attaches the specified QP to a multicast group.
2097  * @qp: QP to attach to the multicast group.  The QP must be type
2098  *   IB_QPT_UD.
2099  * @gid: Multicast group GID.
2100  * @lid: Multicast group LID in host byte order.
2101  *
2102  * In order to send and receive multicast packets, subnet
2103  * administration must have created the multicast group and configured
2104  * the fabric appropriately.  The port associated with the specified
2105  * QP must also be a member of the multicast group.
2106  */
2107 int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
2108
2109 /**
2110  * ib_detach_mcast - Detaches the specified QP from a multicast group.
2111  * @qp: QP to detach from the multicast group.
2112  * @gid: Multicast group GID.
2113  * @lid: Multicast group LID in host byte order.
2114  */
2115 int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
2116
2117 /**
2118  * ib_alloc_xrcd - Allocates an XRC domain.
2119  * @device: The device on which to allocate the XRC domain.
2120  */
2121 struct ib_xrcd *ib_alloc_xrcd(struct ib_device *device);
2122
2123 /**
2124  * ib_dealloc_xrcd - Deallocates an XRC domain.
2125  * @xrcd: The XRC domain to deallocate.
2126  */
2127 int ib_dealloc_xrcd(struct ib_xrcd *xrcd);
2128
2129 #endif /* IB_VERBS_H */