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.
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:
16 * Redistribution and use in source and binary forms, with or
17 * without modification, are permitted provided that the following
20 * - Redistributions of source code must retain the above
21 * copyright notice, this list of conditions and the following
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.
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
39 #if !defined(IB_VERBS_H)
42 #include <linux/types.h>
43 #include <linux/device.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>
52 #include <linux/atomic.h>
53 #include <asm/uaccess.h>
55 extern struct workqueue_struct *ib_wq;
66 /* IB values map to NodeInfo:NodeType. */
73 enum rdma_transport_type {
78 enum rdma_transport_type
79 rdma_node_get_transport(enum rdma_node_type node_type) __attribute_const__;
81 enum rdma_link_layer {
82 IB_LINK_LAYER_UNSPECIFIED,
83 IB_LINK_LAYER_INFINIBAND,
84 IB_LINK_LAYER_ETHERNET,
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),
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.
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),
126 struct ib_device_attr {
128 __be64 sys_image_guid;
136 int device_cap_flags;
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;
156 int max_mcast_qp_attach;
157 int max_total_mcast_qp_attach;
164 unsigned int max_fast_reg_page_list_len;
166 u8 local_ca_ack_delay;
177 static inline int ib_mtu_enum_to_int(enum ib_mtu 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;
195 IB_PORT_ACTIVE_DEFER = 5
198 enum ib_port_cap_flags {
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_EXTENDED_SPEEDS_SUP = 1 << 14,
212 IB_PORT_CM_SUP = 1 << 16,
213 IB_PORT_SNMP_TUNNEL_SUP = 1 << 17,
214 IB_PORT_REINIT_SUP = 1 << 18,
215 IB_PORT_DEVICE_MGMT_SUP = 1 << 19,
216 IB_PORT_VENDOR_CLASS_SUP = 1 << 20,
217 IB_PORT_DR_NOTICE_SUP = 1 << 21,
218 IB_PORT_CAP_MASK_NOTICE_SUP = 1 << 22,
219 IB_PORT_BOOT_MGMT_SUP = 1 << 23,
220 IB_PORT_LINK_LATENCY_SUP = 1 << 24,
221 IB_PORT_CLIENT_REG_SUP = 1 << 25
231 static inline int ib_width_enum_to_int(enum ib_port_width width)
234 case IB_WIDTH_1X: return 1;
235 case IB_WIDTH_4X: return 4;
236 case IB_WIDTH_8X: return 8;
237 case IB_WIDTH_12X: return 12;
242 struct ib_protocol_stats {
246 struct iw_protocol_stats {
249 u64 ipInTooBigErrors;
252 u64 ipInUnknownProtos;
253 u64 ipInTruncatedPkts;
256 u64 ipOutForwDatagrams;
288 union rdma_protocol_stats {
289 struct ib_protocol_stats ib;
290 struct iw_protocol_stats iw;
293 struct ib_port_attr {
294 enum ib_port_state state;
296 enum ib_mtu active_mtu;
315 enum ib_device_modify_flags {
316 IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1 << 0,
317 IB_DEVICE_MODIFY_NODE_DESC = 1 << 1
320 struct ib_device_modify {
325 enum ib_port_modify_flags {
326 IB_PORT_SHUTDOWN = 1,
327 IB_PORT_INIT_TYPE = (1<<2),
328 IB_PORT_RESET_QKEY_CNTR = (1<<3)
331 struct ib_port_modify {
332 u32 set_port_cap_mask;
333 u32 clr_port_cap_mask;
341 IB_EVENT_QP_ACCESS_ERR,
345 IB_EVENT_PATH_MIG_ERR,
346 IB_EVENT_DEVICE_FATAL,
347 IB_EVENT_PORT_ACTIVE,
350 IB_EVENT_PKEY_CHANGE,
353 IB_EVENT_SRQ_LIMIT_REACHED,
354 IB_EVENT_QP_LAST_WQE_REACHED,
355 IB_EVENT_CLIENT_REREGISTER,
360 struct ib_device *device;
367 enum ib_event_type event;
370 struct ib_event_handler {
371 struct ib_device *device;
372 void (*handler)(struct ib_event_handler *, struct ib_event *);
373 struct list_head list;
376 #define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler) \
378 (_ptr)->device = _device; \
379 (_ptr)->handler = _handler; \
380 INIT_LIST_HEAD(&(_ptr)->list); \
383 struct ib_global_route {
392 __be32 version_tclass_flow;
401 IB_MULTICAST_QPN = 0xffffff
404 #define IB_LID_PERMISSIVE cpu_to_be16(0xFFFF)
411 IB_RATE_PORT_CURRENT = 0,
412 IB_RATE_2_5_GBPS = 2,
420 IB_RATE_120_GBPS = 10,
421 IB_RATE_14_GBPS = 11,
422 IB_RATE_56_GBPS = 12,
423 IB_RATE_112_GBPS = 13,
424 IB_RATE_168_GBPS = 14,
425 IB_RATE_25_GBPS = 15,
426 IB_RATE_100_GBPS = 16,
427 IB_RATE_200_GBPS = 17,
428 IB_RATE_300_GBPS = 18
432 * ib_rate_to_mult - Convert the IB rate enum to a multiple of the
433 * base rate of 2.5 Gbit/sec. For example, IB_RATE_5_GBPS will be
434 * converted to 2, since 5 Gbit/sec is 2 * 2.5 Gbit/sec.
435 * @rate: rate to convert.
437 int ib_rate_to_mult(enum ib_rate rate) __attribute_const__;
440 * ib_rate_to_mbps - Convert the IB rate enum to Mbps.
441 * For example, IB_RATE_2_5_GBPS will be converted to 2500.
442 * @rate: rate to convert.
444 int ib_rate_to_mbps(enum ib_rate rate) __attribute_const__;
447 * mult_to_ib_rate - Convert a multiple of 2.5 Gbit/sec to an IB rate
449 * @mult: multiple to convert.
451 enum ib_rate mult_to_ib_rate(int mult) __attribute_const__;
454 struct ib_global_route grh;
467 IB_WC_LOC_EEC_OP_ERR,
472 IB_WC_LOC_ACCESS_ERR,
473 IB_WC_REM_INV_REQ_ERR,
474 IB_WC_REM_ACCESS_ERR,
477 IB_WC_RNR_RETRY_EXC_ERR,
478 IB_WC_LOC_RDD_VIOL_ERR,
479 IB_WC_REM_INV_RD_REQ_ERR,
482 IB_WC_INV_EEC_STATE_ERR,
484 IB_WC_RESP_TIMEOUT_ERR,
498 IB_WC_MASKED_COMP_SWAP,
499 IB_WC_MASKED_FETCH_ADD,
501 * Set value of IB_WC_RECV so consumers can test if a completion is a
502 * receive by testing (opcode & IB_WC_RECV).
505 IB_WC_RECV_RDMA_WITH_IMM
510 IB_WC_WITH_IMM = (1<<1),
511 IB_WC_WITH_INVALIDATE = (1<<2),
516 enum ib_wc_status status;
517 enum ib_wc_opcode opcode;
531 u8 port_num; /* valid only for DR SMPs on switches */
535 enum ib_cq_notify_flags {
536 IB_CQ_SOLICITED = 1 << 0,
537 IB_CQ_NEXT_COMP = 1 << 1,
538 IB_CQ_SOLICITED_MASK = IB_CQ_SOLICITED | IB_CQ_NEXT_COMP,
539 IB_CQ_REPORT_MISSED_EVENTS = 1 << 2,
547 enum ib_srq_attr_mask {
548 IB_SRQ_MAX_WR = 1 << 0,
549 IB_SRQ_LIMIT = 1 << 1,
558 struct ib_srq_init_attr {
559 void (*event_handler)(struct ib_event *, void *);
561 struct ib_srq_attr attr;
562 enum ib_srq_type srq_type;
566 struct ib_xrcd *xrcd;
587 * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
588 * here (and in that order) since the MAD layer uses them as
589 * indices into a 2-entry table.
598 IB_QPT_RAW_ETHERTYPE,
599 /* Save 8 for RAW_PACKET */
605 enum ib_qp_create_flags {
606 IB_QP_CREATE_IPOIB_UD_LSO = 1 << 0,
607 IB_QP_CREATE_BLOCK_MULTICAST_LOOPBACK = 1 << 1,
610 struct ib_qp_init_attr {
611 void (*event_handler)(struct ib_event *, void *);
613 struct ib_cq *send_cq;
614 struct ib_cq *recv_cq;
616 struct ib_xrcd *xrcd; /* XRC TGT QPs only */
617 struct ib_qp_cap cap;
618 enum ib_sig_type sq_sig_type;
619 enum ib_qp_type qp_type;
620 enum ib_qp_create_flags create_flags;
621 u8 port_num; /* special QP types only */
624 struct ib_qp_open_attr {
625 void (*event_handler)(struct ib_event *, void *);
628 enum ib_qp_type qp_type;
631 enum ib_rnr_timeout {
632 IB_RNR_TIMER_655_36 = 0,
633 IB_RNR_TIMER_000_01 = 1,
634 IB_RNR_TIMER_000_02 = 2,
635 IB_RNR_TIMER_000_03 = 3,
636 IB_RNR_TIMER_000_04 = 4,
637 IB_RNR_TIMER_000_06 = 5,
638 IB_RNR_TIMER_000_08 = 6,
639 IB_RNR_TIMER_000_12 = 7,
640 IB_RNR_TIMER_000_16 = 8,
641 IB_RNR_TIMER_000_24 = 9,
642 IB_RNR_TIMER_000_32 = 10,
643 IB_RNR_TIMER_000_48 = 11,
644 IB_RNR_TIMER_000_64 = 12,
645 IB_RNR_TIMER_000_96 = 13,
646 IB_RNR_TIMER_001_28 = 14,
647 IB_RNR_TIMER_001_92 = 15,
648 IB_RNR_TIMER_002_56 = 16,
649 IB_RNR_TIMER_003_84 = 17,
650 IB_RNR_TIMER_005_12 = 18,
651 IB_RNR_TIMER_007_68 = 19,
652 IB_RNR_TIMER_010_24 = 20,
653 IB_RNR_TIMER_015_36 = 21,
654 IB_RNR_TIMER_020_48 = 22,
655 IB_RNR_TIMER_030_72 = 23,
656 IB_RNR_TIMER_040_96 = 24,
657 IB_RNR_TIMER_061_44 = 25,
658 IB_RNR_TIMER_081_92 = 26,
659 IB_RNR_TIMER_122_88 = 27,
660 IB_RNR_TIMER_163_84 = 28,
661 IB_RNR_TIMER_245_76 = 29,
662 IB_RNR_TIMER_327_68 = 30,
663 IB_RNR_TIMER_491_52 = 31
666 enum ib_qp_attr_mask {
668 IB_QP_CUR_STATE = (1<<1),
669 IB_QP_EN_SQD_ASYNC_NOTIFY = (1<<2),
670 IB_QP_ACCESS_FLAGS = (1<<3),
671 IB_QP_PKEY_INDEX = (1<<4),
675 IB_QP_PATH_MTU = (1<<8),
676 IB_QP_TIMEOUT = (1<<9),
677 IB_QP_RETRY_CNT = (1<<10),
678 IB_QP_RNR_RETRY = (1<<11),
679 IB_QP_RQ_PSN = (1<<12),
680 IB_QP_MAX_QP_RD_ATOMIC = (1<<13),
681 IB_QP_ALT_PATH = (1<<14),
682 IB_QP_MIN_RNR_TIMER = (1<<15),
683 IB_QP_SQ_PSN = (1<<16),
684 IB_QP_MAX_DEST_RD_ATOMIC = (1<<17),
685 IB_QP_PATH_MIG_STATE = (1<<18),
687 IB_QP_DEST_QPN = (1<<20)
707 enum ib_qp_state qp_state;
708 enum ib_qp_state cur_qp_state;
709 enum ib_mtu path_mtu;
710 enum ib_mig_state path_mig_state;
716 struct ib_qp_cap cap;
717 struct ib_ah_attr ah_attr;
718 struct ib_ah_attr alt_ah_attr;
721 u8 en_sqd_async_notify;
724 u8 max_dest_rd_atomic;
736 IB_WR_RDMA_WRITE_WITH_IMM,
740 IB_WR_ATOMIC_CMP_AND_SWP,
741 IB_WR_ATOMIC_FETCH_AND_ADD,
744 IB_WR_RDMA_READ_WITH_INV,
747 IB_WR_MASKED_ATOMIC_CMP_AND_SWP,
748 IB_WR_MASKED_ATOMIC_FETCH_AND_ADD,
753 IB_SEND_SIGNALED = (1<<1),
754 IB_SEND_SOLICITED = (1<<2),
755 IB_SEND_INLINE = (1<<3),
756 IB_SEND_IP_CSUM = (1<<4)
765 struct ib_fast_reg_page_list {
766 struct ib_device *device;
768 unsigned int max_page_list_len;
772 struct ib_send_wr *next;
774 struct ib_sge *sg_list;
776 enum ib_wr_opcode opcode;
791 u64 compare_add_mask;
802 u16 pkey_index; /* valid for GSI only */
803 u8 port_num; /* valid for DR SMPs on switch only */
807 struct ib_fast_reg_page_list *page_list;
808 unsigned int page_shift;
809 unsigned int page_list_len;
815 u32 xrc_remote_srq_num; /* XRC TGT QPs only */
819 struct ib_recv_wr *next;
821 struct ib_sge *sg_list;
825 enum ib_access_flags {
826 IB_ACCESS_LOCAL_WRITE = 1,
827 IB_ACCESS_REMOTE_WRITE = (1<<1),
828 IB_ACCESS_REMOTE_READ = (1<<2),
829 IB_ACCESS_REMOTE_ATOMIC = (1<<3),
830 IB_ACCESS_MW_BIND = (1<<4)
840 u64 device_virt_addr;
847 enum ib_mr_rereg_flags {
848 IB_MR_REREG_TRANS = 1,
849 IB_MR_REREG_PD = (1<<1),
850 IB_MR_REREG_ACCESS = (1<<2)
869 struct ib_device *device;
870 struct list_head pd_list;
871 struct list_head mr_list;
872 struct list_head mw_list;
873 struct list_head cq_list;
874 struct list_head qp_list;
875 struct list_head srq_list;
876 struct list_head ah_list;
877 struct list_head xrcd_list;
882 u64 user_handle; /* handle given to us by userspace */
883 struct ib_ucontext *context; /* associated user context */
884 void *object; /* containing object */
885 struct list_head list; /* link to context's list */
886 int id; /* index into kernel idr */
888 struct rw_semaphore mutex; /* protects .live */
900 struct ib_device *device;
901 struct ib_uobject *uobject;
902 atomic_t usecnt; /* count all resources */
906 struct ib_device *device;
907 atomic_t usecnt; /* count all exposed resources */
910 struct mutex tgt_qp_mutex;
911 struct list_head tgt_qp_list;
915 struct ib_device *device;
917 struct ib_uobject *uobject;
920 typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
923 struct ib_device *device;
924 struct ib_uobject *uobject;
925 ib_comp_handler comp_handler;
926 void (*event_handler)(struct ib_event *, void *);
929 atomic_t usecnt; /* count number of work queues */
933 struct ib_device *device;
935 struct ib_uobject *uobject;
936 void (*event_handler)(struct ib_event *, void *);
938 enum ib_srq_type srq_type;
943 struct ib_xrcd *xrcd;
951 struct ib_device *device;
953 struct ib_cq *send_cq;
954 struct ib_cq *recv_cq;
956 struct ib_xrcd *xrcd; /* XRC TGT QPs only */
957 struct list_head xrcd_list;
958 atomic_t usecnt; /* count times opened */
959 struct list_head open_list;
960 struct ib_qp *real_qp;
961 struct ib_uobject *uobject;
962 void (*event_handler)(struct ib_event *, void *);
965 enum ib_qp_type qp_type;
969 struct ib_device *device;
971 struct ib_uobject *uobject;
974 atomic_t usecnt; /* count number of MWs */
978 struct ib_device *device;
980 struct ib_uobject *uobject;
985 struct ib_device *device;
987 struct list_head list;
995 enum ib_process_mad_flags {
996 IB_MAD_IGNORE_MKEY = 1,
997 IB_MAD_IGNORE_BKEY = 2,
998 IB_MAD_IGNORE_ALL = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
1001 enum ib_mad_result {
1002 IB_MAD_RESULT_FAILURE = 0, /* (!SUCCESS is the important flag) */
1003 IB_MAD_RESULT_SUCCESS = 1 << 0, /* MAD was successfully processed */
1004 IB_MAD_RESULT_REPLY = 1 << 1, /* Reply packet needs to be sent */
1005 IB_MAD_RESULT_CONSUMED = 1 << 2 /* Packet consumed: stop processing */
1008 #define IB_DEVICE_NAME_MAX 64
1012 struct ib_event_handler event_handler;
1013 struct ib_pkey_cache **pkey_cache;
1014 struct ib_gid_cache **gid_cache;
1018 struct ib_dma_mapping_ops {
1019 int (*mapping_error)(struct ib_device *dev,
1021 u64 (*map_single)(struct ib_device *dev,
1022 void *ptr, size_t size,
1023 enum dma_data_direction direction);
1024 void (*unmap_single)(struct ib_device *dev,
1025 u64 addr, size_t size,
1026 enum dma_data_direction direction);
1027 u64 (*map_page)(struct ib_device *dev,
1028 struct page *page, unsigned long offset,
1030 enum dma_data_direction direction);
1031 void (*unmap_page)(struct ib_device *dev,
1032 u64 addr, size_t size,
1033 enum dma_data_direction direction);
1034 int (*map_sg)(struct ib_device *dev,
1035 struct scatterlist *sg, int nents,
1036 enum dma_data_direction direction);
1037 void (*unmap_sg)(struct ib_device *dev,
1038 struct scatterlist *sg, int nents,
1039 enum dma_data_direction direction);
1040 u64 (*dma_address)(struct ib_device *dev,
1041 struct scatterlist *sg);
1042 unsigned int (*dma_len)(struct ib_device *dev,
1043 struct scatterlist *sg);
1044 void (*sync_single_for_cpu)(struct ib_device *dev,
1047 enum dma_data_direction dir);
1048 void (*sync_single_for_device)(struct ib_device *dev,
1051 enum dma_data_direction dir);
1052 void *(*alloc_coherent)(struct ib_device *dev,
1056 void (*free_coherent)(struct ib_device *dev,
1057 size_t size, void *cpu_addr,
1064 struct device *dma_device;
1066 char name[IB_DEVICE_NAME_MAX];
1068 struct list_head event_handler_list;
1069 spinlock_t event_handler_lock;
1071 spinlock_t client_data_lock;
1072 struct list_head core_list;
1073 struct list_head client_data_list;
1075 struct ib_cache cache;
1079 int num_comp_vectors;
1081 struct iw_cm_verbs *iwcm;
1083 int (*get_protocol_stats)(struct ib_device *device,
1084 union rdma_protocol_stats *stats);
1085 int (*query_device)(struct ib_device *device,
1086 struct ib_device_attr *device_attr);
1087 int (*query_port)(struct ib_device *device,
1089 struct ib_port_attr *port_attr);
1090 enum rdma_link_layer (*get_link_layer)(struct ib_device *device,
1092 int (*query_gid)(struct ib_device *device,
1093 u8 port_num, int index,
1095 int (*query_pkey)(struct ib_device *device,
1096 u8 port_num, u16 index, u16 *pkey);
1097 int (*modify_device)(struct ib_device *device,
1098 int device_modify_mask,
1099 struct ib_device_modify *device_modify);
1100 int (*modify_port)(struct ib_device *device,
1101 u8 port_num, int port_modify_mask,
1102 struct ib_port_modify *port_modify);
1103 struct ib_ucontext * (*alloc_ucontext)(struct ib_device *device,
1104 struct ib_udata *udata);
1105 int (*dealloc_ucontext)(struct ib_ucontext *context);
1106 int (*mmap)(struct ib_ucontext *context,
1107 struct vm_area_struct *vma);
1108 struct ib_pd * (*alloc_pd)(struct ib_device *device,
1109 struct ib_ucontext *context,
1110 struct ib_udata *udata);
1111 int (*dealloc_pd)(struct ib_pd *pd);
1112 struct ib_ah * (*create_ah)(struct ib_pd *pd,
1113 struct ib_ah_attr *ah_attr);
1114 int (*modify_ah)(struct ib_ah *ah,
1115 struct ib_ah_attr *ah_attr);
1116 int (*query_ah)(struct ib_ah *ah,
1117 struct ib_ah_attr *ah_attr);
1118 int (*destroy_ah)(struct ib_ah *ah);
1119 struct ib_srq * (*create_srq)(struct ib_pd *pd,
1120 struct ib_srq_init_attr *srq_init_attr,
1121 struct ib_udata *udata);
1122 int (*modify_srq)(struct ib_srq *srq,
1123 struct ib_srq_attr *srq_attr,
1124 enum ib_srq_attr_mask srq_attr_mask,
1125 struct ib_udata *udata);
1126 int (*query_srq)(struct ib_srq *srq,
1127 struct ib_srq_attr *srq_attr);
1128 int (*destroy_srq)(struct ib_srq *srq);
1129 int (*post_srq_recv)(struct ib_srq *srq,
1130 struct ib_recv_wr *recv_wr,
1131 struct ib_recv_wr **bad_recv_wr);
1132 struct ib_qp * (*create_qp)(struct ib_pd *pd,
1133 struct ib_qp_init_attr *qp_init_attr,
1134 struct ib_udata *udata);
1135 int (*modify_qp)(struct ib_qp *qp,
1136 struct ib_qp_attr *qp_attr,
1138 struct ib_udata *udata);
1139 int (*query_qp)(struct ib_qp *qp,
1140 struct ib_qp_attr *qp_attr,
1142 struct ib_qp_init_attr *qp_init_attr);
1143 int (*destroy_qp)(struct ib_qp *qp);
1144 int (*post_send)(struct ib_qp *qp,
1145 struct ib_send_wr *send_wr,
1146 struct ib_send_wr **bad_send_wr);
1147 int (*post_recv)(struct ib_qp *qp,
1148 struct ib_recv_wr *recv_wr,
1149 struct ib_recv_wr **bad_recv_wr);
1150 struct ib_cq * (*create_cq)(struct ib_device *device, int cqe,
1152 struct ib_ucontext *context,
1153 struct ib_udata *udata);
1154 int (*modify_cq)(struct ib_cq *cq, u16 cq_count,
1156 int (*destroy_cq)(struct ib_cq *cq);
1157 int (*resize_cq)(struct ib_cq *cq, int cqe,
1158 struct ib_udata *udata);
1159 int (*poll_cq)(struct ib_cq *cq, int num_entries,
1161 int (*peek_cq)(struct ib_cq *cq, int wc_cnt);
1162 int (*req_notify_cq)(struct ib_cq *cq,
1163 enum ib_cq_notify_flags flags);
1164 int (*req_ncomp_notif)(struct ib_cq *cq,
1166 struct ib_mr * (*get_dma_mr)(struct ib_pd *pd,
1167 int mr_access_flags);
1168 struct ib_mr * (*reg_phys_mr)(struct ib_pd *pd,
1169 struct ib_phys_buf *phys_buf_array,
1171 int mr_access_flags,
1173 struct ib_mr * (*reg_user_mr)(struct ib_pd *pd,
1174 u64 start, u64 length,
1176 int mr_access_flags,
1177 struct ib_udata *udata);
1178 int (*query_mr)(struct ib_mr *mr,
1179 struct ib_mr_attr *mr_attr);
1180 int (*dereg_mr)(struct ib_mr *mr);
1181 struct ib_mr * (*alloc_fast_reg_mr)(struct ib_pd *pd,
1182 int max_page_list_len);
1183 struct ib_fast_reg_page_list * (*alloc_fast_reg_page_list)(struct ib_device *device,
1185 void (*free_fast_reg_page_list)(struct ib_fast_reg_page_list *page_list);
1186 int (*rereg_phys_mr)(struct ib_mr *mr,
1189 struct ib_phys_buf *phys_buf_array,
1191 int mr_access_flags,
1193 struct ib_mw * (*alloc_mw)(struct ib_pd *pd);
1194 int (*bind_mw)(struct ib_qp *qp,
1196 struct ib_mw_bind *mw_bind);
1197 int (*dealloc_mw)(struct ib_mw *mw);
1198 struct ib_fmr * (*alloc_fmr)(struct ib_pd *pd,
1199 int mr_access_flags,
1200 struct ib_fmr_attr *fmr_attr);
1201 int (*map_phys_fmr)(struct ib_fmr *fmr,
1202 u64 *page_list, int list_len,
1204 int (*unmap_fmr)(struct list_head *fmr_list);
1205 int (*dealloc_fmr)(struct ib_fmr *fmr);
1206 int (*attach_mcast)(struct ib_qp *qp,
1209 int (*detach_mcast)(struct ib_qp *qp,
1212 int (*process_mad)(struct ib_device *device,
1213 int process_mad_flags,
1215 struct ib_wc *in_wc,
1216 struct ib_grh *in_grh,
1217 struct ib_mad *in_mad,
1218 struct ib_mad *out_mad);
1219 struct ib_xrcd * (*alloc_xrcd)(struct ib_device *device,
1220 struct ib_ucontext *ucontext,
1221 struct ib_udata *udata);
1222 int (*dealloc_xrcd)(struct ib_xrcd *xrcd);
1224 struct ib_dma_mapping_ops *dma_ops;
1226 struct module *owner;
1228 struct kobject *ports_parent;
1229 struct list_head port_list;
1232 IB_DEV_UNINITIALIZED,
1238 u64 uverbs_cmd_mask;
1249 void (*add) (struct ib_device *);
1250 void (*remove)(struct ib_device *);
1252 struct list_head list;
1255 struct ib_device *ib_alloc_device(size_t size);
1256 void ib_dealloc_device(struct ib_device *device);
1258 int ib_register_device(struct ib_device *device,
1259 int (*port_callback)(struct ib_device *,
1260 u8, struct kobject *));
1261 void ib_unregister_device(struct ib_device *device);
1263 int ib_register_client (struct ib_client *client);
1264 void ib_unregister_client(struct ib_client *client);
1266 void *ib_get_client_data(struct ib_device *device, struct ib_client *client);
1267 void ib_set_client_data(struct ib_device *device, struct ib_client *client,
1270 static inline int ib_copy_from_udata(void *dest, struct ib_udata *udata, size_t len)
1272 return copy_from_user(dest, udata->inbuf, len) ? -EFAULT : 0;
1275 static inline int ib_copy_to_udata(struct ib_udata *udata, void *src, size_t len)
1277 return copy_to_user(udata->outbuf, src, len) ? -EFAULT : 0;
1281 * ib_modify_qp_is_ok - Check that the supplied attribute mask
1282 * contains all required attributes and no attributes not allowed for
1283 * the given QP state transition.
1284 * @cur_state: Current QP state
1285 * @next_state: Next QP state
1287 * @mask: Mask of supplied QP attributes
1289 * This function is a helper function that a low-level driver's
1290 * modify_qp method can use to validate the consumer's input. It
1291 * checks that cur_state and next_state are valid QP states, that a
1292 * transition from cur_state to next_state is allowed by the IB spec,
1293 * and that the attribute mask supplied is allowed for the transition.
1295 int ib_modify_qp_is_ok(enum ib_qp_state cur_state, enum ib_qp_state next_state,
1296 enum ib_qp_type type, enum ib_qp_attr_mask mask);
1298 int ib_register_event_handler (struct ib_event_handler *event_handler);
1299 int ib_unregister_event_handler(struct ib_event_handler *event_handler);
1300 void ib_dispatch_event(struct ib_event *event);
1302 int ib_query_device(struct ib_device *device,
1303 struct ib_device_attr *device_attr);
1305 int ib_query_port(struct ib_device *device,
1306 u8 port_num, struct ib_port_attr *port_attr);
1308 enum rdma_link_layer rdma_port_get_link_layer(struct ib_device *device,
1312 * rdma_start_port - Return the first valid port number for the device
1315 * @device: Device to be checked
1317 * Return start port number
1319 static inline u8 rdma_start_port(const struct ib_device *device)
1321 return (device->node_type == RDMA_NODE_IB_SWITCH) ? 0 : 1;
1325 * rdma_end_port - Return the last valid port number for the device
1328 * @device: Device to be checked
1330 * Return last port number
1332 static inline u8 rdma_end_port(const struct ib_device *device)
1334 return (device->node_type == RDMA_NODE_IB_SWITCH) ?
1335 0 : device->phys_port_cnt;
1338 static inline int rdma_is_port_valid(const struct ib_device *device,
1341 return (port >= rdma_start_port(device) &&
1342 port <= rdma_end_port(device));
1345 int ib_query_gid(struct ib_device *device,
1346 u8 port_num, int index, union ib_gid *gid);
1348 int ib_query_pkey(struct ib_device *device,
1349 u8 port_num, u16 index, u16 *pkey);
1351 int ib_modify_device(struct ib_device *device,
1352 int device_modify_mask,
1353 struct ib_device_modify *device_modify);
1355 int ib_modify_port(struct ib_device *device,
1356 u8 port_num, int port_modify_mask,
1357 struct ib_port_modify *port_modify);
1359 int ib_find_gid(struct ib_device *device, union ib_gid *gid,
1360 u8 *port_num, u16 *index);
1362 int ib_find_pkey(struct ib_device *device,
1363 u8 port_num, u16 pkey, u16 *index);
1366 * ib_alloc_pd - Allocates an unused protection domain.
1367 * @device: The device on which to allocate the protection domain.
1369 * A protection domain object provides an association between QPs, shared
1370 * receive queues, address handles, memory regions, and memory windows.
1372 struct ib_pd *ib_alloc_pd(struct ib_device *device);
1375 * ib_dealloc_pd - Deallocates a protection domain.
1376 * @pd: The protection domain to deallocate.
1378 int ib_dealloc_pd(struct ib_pd *pd);
1381 * ib_create_ah - Creates an address handle for the given address vector.
1382 * @pd: The protection domain associated with the address handle.
1383 * @ah_attr: The attributes of the address vector.
1385 * The address handle is used to reference a local or global destination
1386 * in all UD QP post sends.
1388 struct ib_ah *ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
1391 * ib_init_ah_from_wc - Initializes address handle attributes from a
1393 * @device: Device on which the received message arrived.
1394 * @port_num: Port on which the received message arrived.
1395 * @wc: Work completion associated with the received message.
1396 * @grh: References the received global route header. This parameter is
1397 * ignored unless the work completion indicates that the GRH is valid.
1398 * @ah_attr: Returned attributes that can be used when creating an address
1399 * handle for replying to the message.
1401 int ib_init_ah_from_wc(struct ib_device *device, u8 port_num, struct ib_wc *wc,
1402 struct ib_grh *grh, struct ib_ah_attr *ah_attr);
1405 * ib_create_ah_from_wc - Creates an address handle associated with the
1406 * sender of the specified work completion.
1407 * @pd: The protection domain associated with the address handle.
1408 * @wc: Work completion information associated with a received message.
1409 * @grh: References the received global route header. This parameter is
1410 * ignored unless the work completion indicates that the GRH is valid.
1411 * @port_num: The outbound port number to associate with the address.
1413 * The address handle is used to reference a local or global destination
1414 * in all UD QP post sends.
1416 struct ib_ah *ib_create_ah_from_wc(struct ib_pd *pd, struct ib_wc *wc,
1417 struct ib_grh *grh, u8 port_num);
1420 * ib_modify_ah - Modifies the address vector associated with an address
1422 * @ah: The address handle to modify.
1423 * @ah_attr: The new address vector attributes to associate with the
1426 int ib_modify_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1429 * ib_query_ah - Queries the address vector associated with an address
1431 * @ah: The address handle to query.
1432 * @ah_attr: The address vector attributes associated with the address
1435 int ib_query_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1438 * ib_destroy_ah - Destroys an address handle.
1439 * @ah: The address handle to destroy.
1441 int ib_destroy_ah(struct ib_ah *ah);
1444 * ib_create_srq - Creates a SRQ associated with the specified protection
1446 * @pd: The protection domain associated with the SRQ.
1447 * @srq_init_attr: A list of initial attributes required to create the
1448 * SRQ. If SRQ creation succeeds, then the attributes are updated to
1449 * the actual capabilities of the created SRQ.
1451 * srq_attr->max_wr and srq_attr->max_sge are read the determine the
1452 * requested size of the SRQ, and set to the actual values allocated
1453 * on return. If ib_create_srq() succeeds, then max_wr and max_sge
1454 * will always be at least as large as the requested values.
1456 struct ib_srq *ib_create_srq(struct ib_pd *pd,
1457 struct ib_srq_init_attr *srq_init_attr);
1460 * ib_modify_srq - Modifies the attributes for the specified SRQ.
1461 * @srq: The SRQ to modify.
1462 * @srq_attr: On input, specifies the SRQ attributes to modify. On output,
1463 * the current values of selected SRQ attributes are returned.
1464 * @srq_attr_mask: A bit-mask used to specify which attributes of the SRQ
1465 * are being modified.
1467 * The mask may contain IB_SRQ_MAX_WR to resize the SRQ and/or
1468 * IB_SRQ_LIMIT to set the SRQ's limit and request notification when
1469 * the number of receives queued drops below the limit.
1471 int ib_modify_srq(struct ib_srq *srq,
1472 struct ib_srq_attr *srq_attr,
1473 enum ib_srq_attr_mask srq_attr_mask);
1476 * ib_query_srq - Returns the attribute list and current values for the
1478 * @srq: The SRQ to query.
1479 * @srq_attr: The attributes of the specified SRQ.
1481 int ib_query_srq(struct ib_srq *srq,
1482 struct ib_srq_attr *srq_attr);
1485 * ib_destroy_srq - Destroys the specified SRQ.
1486 * @srq: The SRQ to destroy.
1488 int ib_destroy_srq(struct ib_srq *srq);
1491 * ib_post_srq_recv - Posts a list of work requests to the specified SRQ.
1492 * @srq: The SRQ to post the work request on.
1493 * @recv_wr: A list of work requests to post on the receive queue.
1494 * @bad_recv_wr: On an immediate failure, this parameter will reference
1495 * the work request that failed to be posted on the QP.
1497 static inline int ib_post_srq_recv(struct ib_srq *srq,
1498 struct ib_recv_wr *recv_wr,
1499 struct ib_recv_wr **bad_recv_wr)
1501 return srq->device->post_srq_recv(srq, recv_wr, bad_recv_wr);
1505 * ib_create_qp - Creates a QP associated with the specified protection
1507 * @pd: The protection domain associated with the QP.
1508 * @qp_init_attr: A list of initial attributes required to create the
1509 * QP. If QP creation succeeds, then the attributes are updated to
1510 * the actual capabilities of the created QP.
1512 struct ib_qp *ib_create_qp(struct ib_pd *pd,
1513 struct ib_qp_init_attr *qp_init_attr);
1516 * ib_modify_qp - Modifies the attributes for the specified QP and then
1517 * transitions the QP to the given state.
1518 * @qp: The QP to modify.
1519 * @qp_attr: On input, specifies the QP attributes to modify. On output,
1520 * the current values of selected QP attributes are returned.
1521 * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
1522 * are being modified.
1524 int ib_modify_qp(struct ib_qp *qp,
1525 struct ib_qp_attr *qp_attr,
1529 * ib_query_qp - Returns the attribute list and current values for the
1531 * @qp: The QP to query.
1532 * @qp_attr: The attributes of the specified QP.
1533 * @qp_attr_mask: A bit-mask used to select specific attributes to query.
1534 * @qp_init_attr: Additional attributes of the selected QP.
1536 * The qp_attr_mask may be used to limit the query to gathering only the
1537 * selected attributes.
1539 int ib_query_qp(struct ib_qp *qp,
1540 struct ib_qp_attr *qp_attr,
1542 struct ib_qp_init_attr *qp_init_attr);
1545 * ib_destroy_qp - Destroys the specified QP.
1546 * @qp: The QP to destroy.
1548 int ib_destroy_qp(struct ib_qp *qp);
1551 * ib_open_qp - Obtain a reference to an existing sharable QP.
1552 * @xrcd - XRC domain
1553 * @qp_open_attr: Attributes identifying the QP to open.
1555 * Returns a reference to a sharable QP.
1557 struct ib_qp *ib_open_qp(struct ib_xrcd *xrcd,
1558 struct ib_qp_open_attr *qp_open_attr);
1561 * ib_close_qp - Release an external reference to a QP.
1562 * @qp: The QP handle to release
1564 * The opened QP handle is released by the caller. The underlying
1565 * shared QP is not destroyed until all internal references are released.
1567 int ib_close_qp(struct ib_qp *qp);
1570 * ib_post_send - Posts a list of work requests to the send queue of
1572 * @qp: The QP to post the work request on.
1573 * @send_wr: A list of work requests to post on the send queue.
1574 * @bad_send_wr: On an immediate failure, this parameter will reference
1575 * the work request that failed to be posted on the QP.
1577 * While IBA Vol. 1 section 11.4.1.1 specifies that if an immediate
1578 * error is returned, the QP state shall not be affected,
1579 * ib_post_send() will return an immediate error after queueing any
1580 * earlier work requests in the list.
1582 static inline int ib_post_send(struct ib_qp *qp,
1583 struct ib_send_wr *send_wr,
1584 struct ib_send_wr **bad_send_wr)
1586 return qp->device->post_send(qp, send_wr, bad_send_wr);
1590 * ib_post_recv - Posts a list of work requests to the receive queue of
1592 * @qp: The QP to post the work request on.
1593 * @recv_wr: A list of work requests to post on the receive queue.
1594 * @bad_recv_wr: On an immediate failure, this parameter will reference
1595 * the work request that failed to be posted on the QP.
1597 static inline int ib_post_recv(struct ib_qp *qp,
1598 struct ib_recv_wr *recv_wr,
1599 struct ib_recv_wr **bad_recv_wr)
1601 return qp->device->post_recv(qp, recv_wr, bad_recv_wr);
1605 * ib_create_cq - Creates a CQ on the specified device.
1606 * @device: The device on which to create the CQ.
1607 * @comp_handler: A user-specified callback that is invoked when a
1608 * completion event occurs on the CQ.
1609 * @event_handler: A user-specified callback that is invoked when an
1610 * asynchronous event not associated with a completion occurs on the CQ.
1611 * @cq_context: Context associated with the CQ returned to the user via
1612 * the associated completion and event handlers.
1613 * @cqe: The minimum size of the CQ.
1614 * @comp_vector - Completion vector used to signal completion events.
1615 * Must be >= 0 and < context->num_comp_vectors.
1617 * Users can examine the cq structure to determine the actual CQ size.
1619 struct ib_cq *ib_create_cq(struct ib_device *device,
1620 ib_comp_handler comp_handler,
1621 void (*event_handler)(struct ib_event *, void *),
1622 void *cq_context, int cqe, int comp_vector);
1625 * ib_resize_cq - Modifies the capacity of the CQ.
1626 * @cq: The CQ to resize.
1627 * @cqe: The minimum size of the CQ.
1629 * Users can examine the cq structure to determine the actual CQ size.
1631 int ib_resize_cq(struct ib_cq *cq, int cqe);
1634 * ib_modify_cq - Modifies moderation params of the CQ
1635 * @cq: The CQ to modify.
1636 * @cq_count: number of CQEs that will trigger an event
1637 * @cq_period: max period of time in usec before triggering an event
1640 int ib_modify_cq(struct ib_cq *cq, u16 cq_count, u16 cq_period);
1643 * ib_destroy_cq - Destroys the specified CQ.
1644 * @cq: The CQ to destroy.
1646 int ib_destroy_cq(struct ib_cq *cq);
1649 * ib_poll_cq - poll a CQ for completion(s)
1650 * @cq:the CQ being polled
1651 * @num_entries:maximum number of completions to return
1652 * @wc:array of at least @num_entries &struct ib_wc where completions
1655 * Poll a CQ for (possibly multiple) completions. If the return value
1656 * is < 0, an error occurred. If the return value is >= 0, it is the
1657 * number of completions returned. If the return value is
1658 * non-negative and < num_entries, then the CQ was emptied.
1660 static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
1663 return cq->device->poll_cq(cq, num_entries, wc);
1667 * ib_peek_cq - Returns the number of unreaped completions currently
1668 * on the specified CQ.
1669 * @cq: The CQ to peek.
1670 * @wc_cnt: A minimum number of unreaped completions to check for.
1672 * If the number of unreaped completions is greater than or equal to wc_cnt,
1673 * this function returns wc_cnt, otherwise, it returns the actual number of
1674 * unreaped completions.
1676 int ib_peek_cq(struct ib_cq *cq, int wc_cnt);
1679 * ib_req_notify_cq - Request completion notification on a CQ.
1680 * @cq: The CQ to generate an event for.
1682 * Must contain exactly one of %IB_CQ_SOLICITED or %IB_CQ_NEXT_COMP
1683 * to request an event on the next solicited event or next work
1684 * completion at any type, respectively. %IB_CQ_REPORT_MISSED_EVENTS
1685 * may also be |ed in to request a hint about missed events, as
1689 * < 0 means an error occurred while requesting notification
1690 * == 0 means notification was requested successfully, and if
1691 * IB_CQ_REPORT_MISSED_EVENTS was passed in, then no events
1692 * were missed and it is safe to wait for another event. In
1693 * this case is it guaranteed that any work completions added
1694 * to the CQ since the last CQ poll will trigger a completion
1695 * notification event.
1696 * > 0 is only returned if IB_CQ_REPORT_MISSED_EVENTS was passed
1697 * in. It means that the consumer must poll the CQ again to
1698 * make sure it is empty to avoid missing an event because of a
1699 * race between requesting notification and an entry being
1700 * added to the CQ. This return value means it is possible
1701 * (but not guaranteed) that a work completion has been added
1702 * to the CQ since the last poll without triggering a
1703 * completion notification event.
1705 static inline int ib_req_notify_cq(struct ib_cq *cq,
1706 enum ib_cq_notify_flags flags)
1708 return cq->device->req_notify_cq(cq, flags);
1712 * ib_req_ncomp_notif - Request completion notification when there are
1713 * at least the specified number of unreaped completions on the CQ.
1714 * @cq: The CQ to generate an event for.
1715 * @wc_cnt: The number of unreaped completions that should be on the
1716 * CQ before an event is generated.
1718 static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
1720 return cq->device->req_ncomp_notif ?
1721 cq->device->req_ncomp_notif(cq, wc_cnt) :
1726 * ib_get_dma_mr - Returns a memory region for system memory that is
1728 * @pd: The protection domain associated with the memory region.
1729 * @mr_access_flags: Specifies the memory access rights.
1731 * Note that the ib_dma_*() functions defined below must be used
1732 * to create/destroy addresses used with the Lkey or Rkey returned
1733 * by ib_get_dma_mr().
1735 struct ib_mr *ib_get_dma_mr(struct ib_pd *pd, int mr_access_flags);
1738 * ib_dma_mapping_error - check a DMA addr for error
1739 * @dev: The device for which the dma_addr was created
1740 * @dma_addr: The DMA address to check
1742 static inline int ib_dma_mapping_error(struct ib_device *dev, u64 dma_addr)
1745 return dev->dma_ops->mapping_error(dev, dma_addr);
1746 return dma_mapping_error(dev->dma_device, dma_addr);
1750 * ib_dma_map_single - Map a kernel virtual address to DMA address
1751 * @dev: The device for which the dma_addr is to be created
1752 * @cpu_addr: The kernel virtual address
1753 * @size: The size of the region in bytes
1754 * @direction: The direction of the DMA
1756 static inline u64 ib_dma_map_single(struct ib_device *dev,
1757 void *cpu_addr, size_t size,
1758 enum dma_data_direction direction)
1761 return dev->dma_ops->map_single(dev, cpu_addr, size, direction);
1762 return dma_map_single(dev->dma_device, cpu_addr, size, direction);
1766 * ib_dma_unmap_single - Destroy a mapping created by ib_dma_map_single()
1767 * @dev: The device for which the DMA address was created
1768 * @addr: The DMA address
1769 * @size: The size of the region in bytes
1770 * @direction: The direction of the DMA
1772 static inline void ib_dma_unmap_single(struct ib_device *dev,
1773 u64 addr, size_t size,
1774 enum dma_data_direction direction)
1777 dev->dma_ops->unmap_single(dev, addr, size, direction);
1779 dma_unmap_single(dev->dma_device, addr, size, direction);
1782 static inline u64 ib_dma_map_single_attrs(struct ib_device *dev,
1783 void *cpu_addr, size_t size,
1784 enum dma_data_direction direction,
1785 struct dma_attrs *attrs)
1787 return dma_map_single_attrs(dev->dma_device, cpu_addr, size,
1791 static inline void ib_dma_unmap_single_attrs(struct ib_device *dev,
1792 u64 addr, size_t size,
1793 enum dma_data_direction direction,
1794 struct dma_attrs *attrs)
1796 return dma_unmap_single_attrs(dev->dma_device, addr, size,
1801 * ib_dma_map_page - Map a physical page to DMA address
1802 * @dev: The device for which the dma_addr is to be created
1803 * @page: The page to be mapped
1804 * @offset: The offset within the page
1805 * @size: The size of the region in bytes
1806 * @direction: The direction of the DMA
1808 static inline u64 ib_dma_map_page(struct ib_device *dev,
1810 unsigned long offset,
1812 enum dma_data_direction direction)
1815 return dev->dma_ops->map_page(dev, page, offset, size, direction);
1816 return dma_map_page(dev->dma_device, page, offset, size, direction);
1820 * ib_dma_unmap_page - Destroy a mapping created by ib_dma_map_page()
1821 * @dev: The device for which the DMA address was created
1822 * @addr: The DMA address
1823 * @size: The size of the region in bytes
1824 * @direction: The direction of the DMA
1826 static inline void ib_dma_unmap_page(struct ib_device *dev,
1827 u64 addr, size_t size,
1828 enum dma_data_direction direction)
1831 dev->dma_ops->unmap_page(dev, addr, size, direction);
1833 dma_unmap_page(dev->dma_device, addr, size, direction);
1837 * ib_dma_map_sg - Map a scatter/gather list to DMA addresses
1838 * @dev: The device for which the DMA addresses are to be created
1839 * @sg: The array of scatter/gather entries
1840 * @nents: The number of scatter/gather entries
1841 * @direction: The direction of the DMA
1843 static inline int ib_dma_map_sg(struct ib_device *dev,
1844 struct scatterlist *sg, int nents,
1845 enum dma_data_direction direction)
1848 return dev->dma_ops->map_sg(dev, sg, nents, direction);
1849 return dma_map_sg(dev->dma_device, sg, nents, direction);
1853 * ib_dma_unmap_sg - Unmap a scatter/gather list of DMA addresses
1854 * @dev: The device for which the DMA addresses were created
1855 * @sg: The array of scatter/gather entries
1856 * @nents: The number of scatter/gather entries
1857 * @direction: The direction of the DMA
1859 static inline void ib_dma_unmap_sg(struct ib_device *dev,
1860 struct scatterlist *sg, int nents,
1861 enum dma_data_direction direction)
1864 dev->dma_ops->unmap_sg(dev, sg, nents, direction);
1866 dma_unmap_sg(dev->dma_device, sg, nents, direction);
1869 static inline int ib_dma_map_sg_attrs(struct ib_device *dev,
1870 struct scatterlist *sg, int nents,
1871 enum dma_data_direction direction,
1872 struct dma_attrs *attrs)
1874 return dma_map_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
1877 static inline void ib_dma_unmap_sg_attrs(struct ib_device *dev,
1878 struct scatterlist *sg, int nents,
1879 enum dma_data_direction direction,
1880 struct dma_attrs *attrs)
1882 dma_unmap_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
1885 * ib_sg_dma_address - Return the DMA address from a scatter/gather entry
1886 * @dev: The device for which the DMA addresses were created
1887 * @sg: The scatter/gather entry
1889 static inline u64 ib_sg_dma_address(struct ib_device *dev,
1890 struct scatterlist *sg)
1893 return dev->dma_ops->dma_address(dev, sg);
1894 return sg_dma_address(sg);
1898 * ib_sg_dma_len - Return the DMA length from a scatter/gather entry
1899 * @dev: The device for which the DMA addresses were created
1900 * @sg: The scatter/gather entry
1902 static inline unsigned int ib_sg_dma_len(struct ib_device *dev,
1903 struct scatterlist *sg)
1906 return dev->dma_ops->dma_len(dev, sg);
1907 return sg_dma_len(sg);
1911 * ib_dma_sync_single_for_cpu - Prepare DMA region to be accessed by CPU
1912 * @dev: The device for which the DMA address was created
1913 * @addr: The DMA address
1914 * @size: The size of the region in bytes
1915 * @dir: The direction of the DMA
1917 static inline void ib_dma_sync_single_for_cpu(struct ib_device *dev,
1920 enum dma_data_direction dir)
1923 dev->dma_ops->sync_single_for_cpu(dev, addr, size, dir);
1925 dma_sync_single_for_cpu(dev->dma_device, addr, size, dir);
1929 * ib_dma_sync_single_for_device - Prepare DMA region to be accessed by device
1930 * @dev: The device for which the DMA address was created
1931 * @addr: The DMA address
1932 * @size: The size of the region in bytes
1933 * @dir: The direction of the DMA
1935 static inline void ib_dma_sync_single_for_device(struct ib_device *dev,
1938 enum dma_data_direction dir)
1941 dev->dma_ops->sync_single_for_device(dev, addr, size, dir);
1943 dma_sync_single_for_device(dev->dma_device, addr, size, dir);
1947 * ib_dma_alloc_coherent - Allocate memory and map it for DMA
1948 * @dev: The device for which the DMA address is requested
1949 * @size: The size of the region to allocate in bytes
1950 * @dma_handle: A pointer for returning the DMA address of the region
1951 * @flag: memory allocator flags
1953 static inline void *ib_dma_alloc_coherent(struct ib_device *dev,
1959 return dev->dma_ops->alloc_coherent(dev, size, dma_handle, flag);
1964 ret = dma_alloc_coherent(dev->dma_device, size, &handle, flag);
1965 *dma_handle = handle;
1971 * ib_dma_free_coherent - Free memory allocated by ib_dma_alloc_coherent()
1972 * @dev: The device for which the DMA addresses were allocated
1973 * @size: The size of the region
1974 * @cpu_addr: the address returned by ib_dma_alloc_coherent()
1975 * @dma_handle: the DMA address returned by ib_dma_alloc_coherent()
1977 static inline void ib_dma_free_coherent(struct ib_device *dev,
1978 size_t size, void *cpu_addr,
1982 dev->dma_ops->free_coherent(dev, size, cpu_addr, dma_handle);
1984 dma_free_coherent(dev->dma_device, size, cpu_addr, dma_handle);
1988 * ib_reg_phys_mr - Prepares a virtually addressed memory region for use
1990 * @pd: The protection domain associated assigned to the registered region.
1991 * @phys_buf_array: Specifies a list of physical buffers to use in the
1993 * @num_phys_buf: Specifies the size of the phys_buf_array.
1994 * @mr_access_flags: Specifies the memory access rights.
1995 * @iova_start: The offset of the region's starting I/O virtual address.
1997 struct ib_mr *ib_reg_phys_mr(struct ib_pd *pd,
1998 struct ib_phys_buf *phys_buf_array,
2000 int mr_access_flags,
2004 * ib_rereg_phys_mr - Modifies the attributes of an existing memory region.
2005 * Conceptually, this call performs the functions deregister memory region
2006 * followed by register physical memory region. Where possible,
2007 * resources are reused instead of deallocated and reallocated.
2008 * @mr: The memory region to modify.
2009 * @mr_rereg_mask: A bit-mask used to indicate which of the following
2010 * properties of the memory region are being modified.
2011 * @pd: If %IB_MR_REREG_PD is set in mr_rereg_mask, this field specifies
2012 * the new protection domain to associated with the memory region,
2013 * otherwise, this parameter is ignored.
2014 * @phys_buf_array: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
2015 * field specifies a list of physical buffers to use in the new
2016 * translation, otherwise, this parameter is ignored.
2017 * @num_phys_buf: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
2018 * field specifies the size of the phys_buf_array, otherwise, this
2019 * parameter is ignored.
2020 * @mr_access_flags: If %IB_MR_REREG_ACCESS is set in mr_rereg_mask, this
2021 * field specifies the new memory access rights, otherwise, this
2022 * parameter is ignored.
2023 * @iova_start: The offset of the region's starting I/O virtual address.
2025 int ib_rereg_phys_mr(struct ib_mr *mr,
2028 struct ib_phys_buf *phys_buf_array,
2030 int mr_access_flags,
2034 * ib_query_mr - Retrieves information about a specific memory region.
2035 * @mr: The memory region to retrieve information about.
2036 * @mr_attr: The attributes of the specified memory region.
2038 int ib_query_mr(struct ib_mr *mr, struct ib_mr_attr *mr_attr);
2041 * ib_dereg_mr - Deregisters a memory region and removes it from the
2042 * HCA translation table.
2043 * @mr: The memory region to deregister.
2045 int ib_dereg_mr(struct ib_mr *mr);
2048 * ib_alloc_fast_reg_mr - Allocates memory region usable with the
2049 * IB_WR_FAST_REG_MR send work request.
2050 * @pd: The protection domain associated with the region.
2051 * @max_page_list_len: requested max physical buffer list length to be
2052 * used with fast register work requests for this MR.
2054 struct ib_mr *ib_alloc_fast_reg_mr(struct ib_pd *pd, int max_page_list_len);
2057 * ib_alloc_fast_reg_page_list - Allocates a page list array
2058 * @device - ib device pointer.
2059 * @page_list_len - size of the page list array to be allocated.
2061 * This allocates and returns a struct ib_fast_reg_page_list * and a
2062 * page_list array that is at least page_list_len in size. The actual
2063 * size is returned in max_page_list_len. The caller is responsible
2064 * for initializing the contents of the page_list array before posting
2065 * a send work request with the IB_WC_FAST_REG_MR opcode.
2067 * The page_list array entries must be translated using one of the
2068 * ib_dma_*() functions just like the addresses passed to
2069 * ib_map_phys_fmr(). Once the ib_post_send() is issued, the struct
2070 * ib_fast_reg_page_list must not be modified by the caller until the
2071 * IB_WC_FAST_REG_MR work request completes.
2073 struct ib_fast_reg_page_list *ib_alloc_fast_reg_page_list(
2074 struct ib_device *device, int page_list_len);
2077 * ib_free_fast_reg_page_list - Deallocates a previously allocated
2079 * @page_list - struct ib_fast_reg_page_list pointer to be deallocated.
2081 void ib_free_fast_reg_page_list(struct ib_fast_reg_page_list *page_list);
2084 * ib_update_fast_reg_key - updates the key portion of the fast_reg MR
2086 * @mr - struct ib_mr pointer to be updated.
2087 * @newkey - new key to be used.
2089 static inline void ib_update_fast_reg_key(struct ib_mr *mr, u8 newkey)
2091 mr->lkey = (mr->lkey & 0xffffff00) | newkey;
2092 mr->rkey = (mr->rkey & 0xffffff00) | newkey;
2096 * ib_alloc_mw - Allocates a memory window.
2097 * @pd: The protection domain associated with the memory window.
2099 struct ib_mw *ib_alloc_mw(struct ib_pd *pd);
2102 * ib_bind_mw - Posts a work request to the send queue of the specified
2103 * QP, which binds the memory window to the given address range and
2104 * remote access attributes.
2105 * @qp: QP to post the bind work request on.
2106 * @mw: The memory window to bind.
2107 * @mw_bind: Specifies information about the memory window, including
2108 * its address range, remote access rights, and associated memory region.
2110 static inline int ib_bind_mw(struct ib_qp *qp,
2112 struct ib_mw_bind *mw_bind)
2114 /* XXX reference counting in corresponding MR? */
2115 return mw->device->bind_mw ?
2116 mw->device->bind_mw(qp, mw, mw_bind) :
2121 * ib_dealloc_mw - Deallocates a memory window.
2122 * @mw: The memory window to deallocate.
2124 int ib_dealloc_mw(struct ib_mw *mw);
2127 * ib_alloc_fmr - Allocates a unmapped fast memory region.
2128 * @pd: The protection domain associated with the unmapped region.
2129 * @mr_access_flags: Specifies the memory access rights.
2130 * @fmr_attr: Attributes of the unmapped region.
2132 * A fast memory region must be mapped before it can be used as part of
2135 struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
2136 int mr_access_flags,
2137 struct ib_fmr_attr *fmr_attr);
2140 * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
2141 * @fmr: The fast memory region to associate with the pages.
2142 * @page_list: An array of physical pages to map to the fast memory region.
2143 * @list_len: The number of pages in page_list.
2144 * @iova: The I/O virtual address to use with the mapped region.
2146 static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
2147 u64 *page_list, int list_len,
2150 return fmr->device->map_phys_fmr(fmr, page_list, list_len, iova);
2154 * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
2155 * @fmr_list: A linked list of fast memory regions to unmap.
2157 int ib_unmap_fmr(struct list_head *fmr_list);
2160 * ib_dealloc_fmr - Deallocates a fast memory region.
2161 * @fmr: The fast memory region to deallocate.
2163 int ib_dealloc_fmr(struct ib_fmr *fmr);
2166 * ib_attach_mcast - Attaches the specified QP to a multicast group.
2167 * @qp: QP to attach to the multicast group. The QP must be type
2169 * @gid: Multicast group GID.
2170 * @lid: Multicast group LID in host byte order.
2172 * In order to send and receive multicast packets, subnet
2173 * administration must have created the multicast group and configured
2174 * the fabric appropriately. The port associated with the specified
2175 * QP must also be a member of the multicast group.
2177 int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
2180 * ib_detach_mcast - Detaches the specified QP from a multicast group.
2181 * @qp: QP to detach from the multicast group.
2182 * @gid: Multicast group GID.
2183 * @lid: Multicast group LID in host byte order.
2185 int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
2188 * ib_alloc_xrcd - Allocates an XRC domain.
2189 * @device: The device on which to allocate the XRC domain.
2191 struct ib_xrcd *ib_alloc_xrcd(struct ib_device *device);
2194 * ib_dealloc_xrcd - Deallocates an XRC domain.
2195 * @xrcd: The XRC domain to deallocate.
2197 int ib_dealloc_xrcd(struct ib_xrcd *xrcd);
2199 #endif /* IB_VERBS_H */