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;
251 struct ib_protocol_stats {
255 struct iw_protocol_stats {
258 u64 ipInTooBigErrors;
261 u64 ipInUnknownProtos;
262 u64 ipInTruncatedPkts;
265 u64 ipOutForwDatagrams;
297 union rdma_protocol_stats {
298 struct ib_protocol_stats ib;
299 struct iw_protocol_stats iw;
302 struct ib_port_attr {
303 enum ib_port_state state;
305 enum ib_mtu active_mtu;
324 enum ib_device_modify_flags {
325 IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1 << 0,
326 IB_DEVICE_MODIFY_NODE_DESC = 1 << 1
329 struct ib_device_modify {
334 enum ib_port_modify_flags {
335 IB_PORT_SHUTDOWN = 1,
336 IB_PORT_INIT_TYPE = (1<<2),
337 IB_PORT_RESET_QKEY_CNTR = (1<<3)
340 struct ib_port_modify {
341 u32 set_port_cap_mask;
342 u32 clr_port_cap_mask;
350 IB_EVENT_QP_ACCESS_ERR,
354 IB_EVENT_PATH_MIG_ERR,
355 IB_EVENT_DEVICE_FATAL,
356 IB_EVENT_PORT_ACTIVE,
359 IB_EVENT_PKEY_CHANGE,
362 IB_EVENT_SRQ_LIMIT_REACHED,
363 IB_EVENT_QP_LAST_WQE_REACHED,
364 IB_EVENT_CLIENT_REREGISTER,
369 struct ib_device *device;
376 enum ib_event_type event;
379 struct ib_event_handler {
380 struct ib_device *device;
381 void (*handler)(struct ib_event_handler *, struct ib_event *);
382 struct list_head list;
385 #define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler) \
387 (_ptr)->device = _device; \
388 (_ptr)->handler = _handler; \
389 INIT_LIST_HEAD(&(_ptr)->list); \
392 struct ib_global_route {
401 __be32 version_tclass_flow;
410 IB_MULTICAST_QPN = 0xffffff
413 #define IB_LID_PERMISSIVE cpu_to_be16(0xFFFF)
420 IB_RATE_PORT_CURRENT = 0,
421 IB_RATE_2_5_GBPS = 2,
429 IB_RATE_120_GBPS = 10,
430 IB_RATE_14_GBPS = 11,
431 IB_RATE_56_GBPS = 12,
432 IB_RATE_112_GBPS = 13,
433 IB_RATE_168_GBPS = 14,
434 IB_RATE_25_GBPS = 15,
435 IB_RATE_100_GBPS = 16,
436 IB_RATE_200_GBPS = 17,
437 IB_RATE_300_GBPS = 18
441 * ib_rate_to_mult - Convert the IB rate enum to a multiple of the
442 * base rate of 2.5 Gbit/sec. For example, IB_RATE_5_GBPS will be
443 * converted to 2, since 5 Gbit/sec is 2 * 2.5 Gbit/sec.
444 * @rate: rate to convert.
446 int ib_rate_to_mult(enum ib_rate rate) __attribute_const__;
449 * ib_rate_to_mbps - Convert the IB rate enum to Mbps.
450 * For example, IB_RATE_2_5_GBPS will be converted to 2500.
451 * @rate: rate to convert.
453 int ib_rate_to_mbps(enum ib_rate rate) __attribute_const__;
456 * mult_to_ib_rate - Convert a multiple of 2.5 Gbit/sec to an IB rate
458 * @mult: multiple to convert.
460 enum ib_rate mult_to_ib_rate(int mult) __attribute_const__;
463 struct ib_global_route grh;
476 IB_WC_LOC_EEC_OP_ERR,
481 IB_WC_LOC_ACCESS_ERR,
482 IB_WC_REM_INV_REQ_ERR,
483 IB_WC_REM_ACCESS_ERR,
486 IB_WC_RNR_RETRY_EXC_ERR,
487 IB_WC_LOC_RDD_VIOL_ERR,
488 IB_WC_REM_INV_RD_REQ_ERR,
491 IB_WC_INV_EEC_STATE_ERR,
493 IB_WC_RESP_TIMEOUT_ERR,
507 IB_WC_MASKED_COMP_SWAP,
508 IB_WC_MASKED_FETCH_ADD,
510 * Set value of IB_WC_RECV so consumers can test if a completion is a
511 * receive by testing (opcode & IB_WC_RECV).
514 IB_WC_RECV_RDMA_WITH_IMM
519 IB_WC_WITH_IMM = (1<<1),
520 IB_WC_WITH_INVALIDATE = (1<<2),
521 IB_WC_IP_CSUM_OK = (1<<3),
526 enum ib_wc_status status;
527 enum ib_wc_opcode opcode;
541 u8 port_num; /* valid only for DR SMPs on switches */
544 enum ib_cq_notify_flags {
545 IB_CQ_SOLICITED = 1 << 0,
546 IB_CQ_NEXT_COMP = 1 << 1,
547 IB_CQ_SOLICITED_MASK = IB_CQ_SOLICITED | IB_CQ_NEXT_COMP,
548 IB_CQ_REPORT_MISSED_EVENTS = 1 << 2,
556 enum ib_srq_attr_mask {
557 IB_SRQ_MAX_WR = 1 << 0,
558 IB_SRQ_LIMIT = 1 << 1,
567 struct ib_srq_init_attr {
568 void (*event_handler)(struct ib_event *, void *);
570 struct ib_srq_attr attr;
571 enum ib_srq_type srq_type;
575 struct ib_xrcd *xrcd;
596 * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
597 * here (and in that order) since the MAD layer uses them as
598 * indices into a 2-entry table.
607 IB_QPT_RAW_ETHERTYPE,
608 IB_QPT_RAW_PACKET = 8,
614 enum ib_qp_create_flags {
615 IB_QP_CREATE_IPOIB_UD_LSO = 1 << 0,
616 IB_QP_CREATE_BLOCK_MULTICAST_LOOPBACK = 1 << 1,
617 /* reserve bits 26-31 for low level drivers' internal use */
618 IB_QP_CREATE_RESERVED_START = 1 << 26,
619 IB_QP_CREATE_RESERVED_END = 1 << 31,
622 struct ib_qp_init_attr {
623 void (*event_handler)(struct ib_event *, void *);
625 struct ib_cq *send_cq;
626 struct ib_cq *recv_cq;
628 struct ib_xrcd *xrcd; /* XRC TGT QPs only */
629 struct ib_qp_cap cap;
630 enum ib_sig_type sq_sig_type;
631 enum ib_qp_type qp_type;
632 enum ib_qp_create_flags create_flags;
633 u8 port_num; /* special QP types only */
636 struct ib_qp_open_attr {
637 void (*event_handler)(struct ib_event *, void *);
640 enum ib_qp_type qp_type;
643 enum ib_rnr_timeout {
644 IB_RNR_TIMER_655_36 = 0,
645 IB_RNR_TIMER_000_01 = 1,
646 IB_RNR_TIMER_000_02 = 2,
647 IB_RNR_TIMER_000_03 = 3,
648 IB_RNR_TIMER_000_04 = 4,
649 IB_RNR_TIMER_000_06 = 5,
650 IB_RNR_TIMER_000_08 = 6,
651 IB_RNR_TIMER_000_12 = 7,
652 IB_RNR_TIMER_000_16 = 8,
653 IB_RNR_TIMER_000_24 = 9,
654 IB_RNR_TIMER_000_32 = 10,
655 IB_RNR_TIMER_000_48 = 11,
656 IB_RNR_TIMER_000_64 = 12,
657 IB_RNR_TIMER_000_96 = 13,
658 IB_RNR_TIMER_001_28 = 14,
659 IB_RNR_TIMER_001_92 = 15,
660 IB_RNR_TIMER_002_56 = 16,
661 IB_RNR_TIMER_003_84 = 17,
662 IB_RNR_TIMER_005_12 = 18,
663 IB_RNR_TIMER_007_68 = 19,
664 IB_RNR_TIMER_010_24 = 20,
665 IB_RNR_TIMER_015_36 = 21,
666 IB_RNR_TIMER_020_48 = 22,
667 IB_RNR_TIMER_030_72 = 23,
668 IB_RNR_TIMER_040_96 = 24,
669 IB_RNR_TIMER_061_44 = 25,
670 IB_RNR_TIMER_081_92 = 26,
671 IB_RNR_TIMER_122_88 = 27,
672 IB_RNR_TIMER_163_84 = 28,
673 IB_RNR_TIMER_245_76 = 29,
674 IB_RNR_TIMER_327_68 = 30,
675 IB_RNR_TIMER_491_52 = 31
678 enum ib_qp_attr_mask {
680 IB_QP_CUR_STATE = (1<<1),
681 IB_QP_EN_SQD_ASYNC_NOTIFY = (1<<2),
682 IB_QP_ACCESS_FLAGS = (1<<3),
683 IB_QP_PKEY_INDEX = (1<<4),
687 IB_QP_PATH_MTU = (1<<8),
688 IB_QP_TIMEOUT = (1<<9),
689 IB_QP_RETRY_CNT = (1<<10),
690 IB_QP_RNR_RETRY = (1<<11),
691 IB_QP_RQ_PSN = (1<<12),
692 IB_QP_MAX_QP_RD_ATOMIC = (1<<13),
693 IB_QP_ALT_PATH = (1<<14),
694 IB_QP_MIN_RNR_TIMER = (1<<15),
695 IB_QP_SQ_PSN = (1<<16),
696 IB_QP_MAX_DEST_RD_ATOMIC = (1<<17),
697 IB_QP_PATH_MIG_STATE = (1<<18),
699 IB_QP_DEST_QPN = (1<<20)
719 enum ib_qp_state qp_state;
720 enum ib_qp_state cur_qp_state;
721 enum ib_mtu path_mtu;
722 enum ib_mig_state path_mig_state;
728 struct ib_qp_cap cap;
729 struct ib_ah_attr ah_attr;
730 struct ib_ah_attr alt_ah_attr;
733 u8 en_sqd_async_notify;
736 u8 max_dest_rd_atomic;
748 IB_WR_RDMA_WRITE_WITH_IMM,
752 IB_WR_ATOMIC_CMP_AND_SWP,
753 IB_WR_ATOMIC_FETCH_AND_ADD,
756 IB_WR_RDMA_READ_WITH_INV,
759 IB_WR_MASKED_ATOMIC_CMP_AND_SWP,
760 IB_WR_MASKED_ATOMIC_FETCH_AND_ADD,
765 IB_SEND_SIGNALED = (1<<1),
766 IB_SEND_SOLICITED = (1<<2),
767 IB_SEND_INLINE = (1<<3),
768 IB_SEND_IP_CSUM = (1<<4)
777 struct ib_fast_reg_page_list {
778 struct ib_device *device;
780 unsigned int max_page_list_len;
784 struct ib_send_wr *next;
786 struct ib_sge *sg_list;
788 enum ib_wr_opcode opcode;
803 u64 compare_add_mask;
814 u16 pkey_index; /* valid for GSI only */
815 u8 port_num; /* valid for DR SMPs on switch only */
819 struct ib_fast_reg_page_list *page_list;
820 unsigned int page_shift;
821 unsigned int page_list_len;
827 u32 xrc_remote_srq_num; /* XRC TGT QPs only */
831 struct ib_recv_wr *next;
833 struct ib_sge *sg_list;
837 enum ib_access_flags {
838 IB_ACCESS_LOCAL_WRITE = 1,
839 IB_ACCESS_REMOTE_WRITE = (1<<1),
840 IB_ACCESS_REMOTE_READ = (1<<2),
841 IB_ACCESS_REMOTE_ATOMIC = (1<<3),
842 IB_ACCESS_MW_BIND = (1<<4)
852 u64 device_virt_addr;
859 enum ib_mr_rereg_flags {
860 IB_MR_REREG_TRANS = 1,
861 IB_MR_REREG_PD = (1<<1),
862 IB_MR_REREG_ACCESS = (1<<2)
881 struct ib_device *device;
882 struct list_head pd_list;
883 struct list_head mr_list;
884 struct list_head mw_list;
885 struct list_head cq_list;
886 struct list_head qp_list;
887 struct list_head srq_list;
888 struct list_head ah_list;
889 struct list_head xrcd_list;
894 u64 user_handle; /* handle given to us by userspace */
895 struct ib_ucontext *context; /* associated user context */
896 void *object; /* containing object */
897 struct list_head list; /* link to context's list */
898 int id; /* index into kernel idr */
900 struct rw_semaphore mutex; /* protects .live */
912 struct ib_device *device;
913 struct ib_uobject *uobject;
914 atomic_t usecnt; /* count all resources */
918 struct ib_device *device;
919 atomic_t usecnt; /* count all exposed resources */
922 struct mutex tgt_qp_mutex;
923 struct list_head tgt_qp_list;
927 struct ib_device *device;
929 struct ib_uobject *uobject;
932 typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
935 struct ib_device *device;
936 struct ib_uobject *uobject;
937 ib_comp_handler comp_handler;
938 void (*event_handler)(struct ib_event *, void *);
941 atomic_t usecnt; /* count number of work queues */
945 struct ib_device *device;
947 struct ib_uobject *uobject;
948 void (*event_handler)(struct ib_event *, void *);
950 enum ib_srq_type srq_type;
955 struct ib_xrcd *xrcd;
963 struct ib_device *device;
965 struct ib_cq *send_cq;
966 struct ib_cq *recv_cq;
968 struct ib_xrcd *xrcd; /* XRC TGT QPs only */
969 struct list_head xrcd_list;
970 atomic_t usecnt; /* count times opened, mcast attaches */
971 struct list_head open_list;
972 struct ib_qp *real_qp;
973 struct ib_uobject *uobject;
974 void (*event_handler)(struct ib_event *, void *);
977 enum ib_qp_type qp_type;
981 struct ib_device *device;
983 struct ib_uobject *uobject;
986 atomic_t usecnt; /* count number of MWs */
990 struct ib_device *device;
992 struct ib_uobject *uobject;
997 struct ib_device *device;
999 struct list_head list;
1007 enum ib_process_mad_flags {
1008 IB_MAD_IGNORE_MKEY = 1,
1009 IB_MAD_IGNORE_BKEY = 2,
1010 IB_MAD_IGNORE_ALL = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
1013 enum ib_mad_result {
1014 IB_MAD_RESULT_FAILURE = 0, /* (!SUCCESS is the important flag) */
1015 IB_MAD_RESULT_SUCCESS = 1 << 0, /* MAD was successfully processed */
1016 IB_MAD_RESULT_REPLY = 1 << 1, /* Reply packet needs to be sent */
1017 IB_MAD_RESULT_CONSUMED = 1 << 2 /* Packet consumed: stop processing */
1020 #define IB_DEVICE_NAME_MAX 64
1024 struct ib_event_handler event_handler;
1025 struct ib_pkey_cache **pkey_cache;
1026 struct ib_gid_cache **gid_cache;
1030 struct ib_dma_mapping_ops {
1031 int (*mapping_error)(struct ib_device *dev,
1033 u64 (*map_single)(struct ib_device *dev,
1034 void *ptr, size_t size,
1035 enum dma_data_direction direction);
1036 void (*unmap_single)(struct ib_device *dev,
1037 u64 addr, size_t size,
1038 enum dma_data_direction direction);
1039 u64 (*map_page)(struct ib_device *dev,
1040 struct page *page, unsigned long offset,
1042 enum dma_data_direction direction);
1043 void (*unmap_page)(struct ib_device *dev,
1044 u64 addr, size_t size,
1045 enum dma_data_direction direction);
1046 int (*map_sg)(struct ib_device *dev,
1047 struct scatterlist *sg, int nents,
1048 enum dma_data_direction direction);
1049 void (*unmap_sg)(struct ib_device *dev,
1050 struct scatterlist *sg, int nents,
1051 enum dma_data_direction direction);
1052 u64 (*dma_address)(struct ib_device *dev,
1053 struct scatterlist *sg);
1054 unsigned int (*dma_len)(struct ib_device *dev,
1055 struct scatterlist *sg);
1056 void (*sync_single_for_cpu)(struct ib_device *dev,
1059 enum dma_data_direction dir);
1060 void (*sync_single_for_device)(struct ib_device *dev,
1063 enum dma_data_direction dir);
1064 void *(*alloc_coherent)(struct ib_device *dev,
1068 void (*free_coherent)(struct ib_device *dev,
1069 size_t size, void *cpu_addr,
1076 struct device *dma_device;
1078 char name[IB_DEVICE_NAME_MAX];
1080 struct list_head event_handler_list;
1081 spinlock_t event_handler_lock;
1083 spinlock_t client_data_lock;
1084 struct list_head core_list;
1085 struct list_head client_data_list;
1087 struct ib_cache cache;
1091 int num_comp_vectors;
1093 struct iw_cm_verbs *iwcm;
1095 int (*get_protocol_stats)(struct ib_device *device,
1096 union rdma_protocol_stats *stats);
1097 int (*query_device)(struct ib_device *device,
1098 struct ib_device_attr *device_attr);
1099 int (*query_port)(struct ib_device *device,
1101 struct ib_port_attr *port_attr);
1102 enum rdma_link_layer (*get_link_layer)(struct ib_device *device,
1104 int (*query_gid)(struct ib_device *device,
1105 u8 port_num, int index,
1107 int (*query_pkey)(struct ib_device *device,
1108 u8 port_num, u16 index, u16 *pkey);
1109 int (*modify_device)(struct ib_device *device,
1110 int device_modify_mask,
1111 struct ib_device_modify *device_modify);
1112 int (*modify_port)(struct ib_device *device,
1113 u8 port_num, int port_modify_mask,
1114 struct ib_port_modify *port_modify);
1115 struct ib_ucontext * (*alloc_ucontext)(struct ib_device *device,
1116 struct ib_udata *udata);
1117 int (*dealloc_ucontext)(struct ib_ucontext *context);
1118 int (*mmap)(struct ib_ucontext *context,
1119 struct vm_area_struct *vma);
1120 struct ib_pd * (*alloc_pd)(struct ib_device *device,
1121 struct ib_ucontext *context,
1122 struct ib_udata *udata);
1123 int (*dealloc_pd)(struct ib_pd *pd);
1124 struct ib_ah * (*create_ah)(struct ib_pd *pd,
1125 struct ib_ah_attr *ah_attr);
1126 int (*modify_ah)(struct ib_ah *ah,
1127 struct ib_ah_attr *ah_attr);
1128 int (*query_ah)(struct ib_ah *ah,
1129 struct ib_ah_attr *ah_attr);
1130 int (*destroy_ah)(struct ib_ah *ah);
1131 struct ib_srq * (*create_srq)(struct ib_pd *pd,
1132 struct ib_srq_init_attr *srq_init_attr,
1133 struct ib_udata *udata);
1134 int (*modify_srq)(struct ib_srq *srq,
1135 struct ib_srq_attr *srq_attr,
1136 enum ib_srq_attr_mask srq_attr_mask,
1137 struct ib_udata *udata);
1138 int (*query_srq)(struct ib_srq *srq,
1139 struct ib_srq_attr *srq_attr);
1140 int (*destroy_srq)(struct ib_srq *srq);
1141 int (*post_srq_recv)(struct ib_srq *srq,
1142 struct ib_recv_wr *recv_wr,
1143 struct ib_recv_wr **bad_recv_wr);
1144 struct ib_qp * (*create_qp)(struct ib_pd *pd,
1145 struct ib_qp_init_attr *qp_init_attr,
1146 struct ib_udata *udata);
1147 int (*modify_qp)(struct ib_qp *qp,
1148 struct ib_qp_attr *qp_attr,
1150 struct ib_udata *udata);
1151 int (*query_qp)(struct ib_qp *qp,
1152 struct ib_qp_attr *qp_attr,
1154 struct ib_qp_init_attr *qp_init_attr);
1155 int (*destroy_qp)(struct ib_qp *qp);
1156 int (*post_send)(struct ib_qp *qp,
1157 struct ib_send_wr *send_wr,
1158 struct ib_send_wr **bad_send_wr);
1159 int (*post_recv)(struct ib_qp *qp,
1160 struct ib_recv_wr *recv_wr,
1161 struct ib_recv_wr **bad_recv_wr);
1162 struct ib_cq * (*create_cq)(struct ib_device *device, int cqe,
1164 struct ib_ucontext *context,
1165 struct ib_udata *udata);
1166 int (*modify_cq)(struct ib_cq *cq, u16 cq_count,
1168 int (*destroy_cq)(struct ib_cq *cq);
1169 int (*resize_cq)(struct ib_cq *cq, int cqe,
1170 struct ib_udata *udata);
1171 int (*poll_cq)(struct ib_cq *cq, int num_entries,
1173 int (*peek_cq)(struct ib_cq *cq, int wc_cnt);
1174 int (*req_notify_cq)(struct ib_cq *cq,
1175 enum ib_cq_notify_flags flags);
1176 int (*req_ncomp_notif)(struct ib_cq *cq,
1178 struct ib_mr * (*get_dma_mr)(struct ib_pd *pd,
1179 int mr_access_flags);
1180 struct ib_mr * (*reg_phys_mr)(struct ib_pd *pd,
1181 struct ib_phys_buf *phys_buf_array,
1183 int mr_access_flags,
1185 struct ib_mr * (*reg_user_mr)(struct ib_pd *pd,
1186 u64 start, u64 length,
1188 int mr_access_flags,
1189 struct ib_udata *udata);
1190 int (*query_mr)(struct ib_mr *mr,
1191 struct ib_mr_attr *mr_attr);
1192 int (*dereg_mr)(struct ib_mr *mr);
1193 struct ib_mr * (*alloc_fast_reg_mr)(struct ib_pd *pd,
1194 int max_page_list_len);
1195 struct ib_fast_reg_page_list * (*alloc_fast_reg_page_list)(struct ib_device *device,
1197 void (*free_fast_reg_page_list)(struct ib_fast_reg_page_list *page_list);
1198 int (*rereg_phys_mr)(struct ib_mr *mr,
1201 struct ib_phys_buf *phys_buf_array,
1203 int mr_access_flags,
1205 struct ib_mw * (*alloc_mw)(struct ib_pd *pd);
1206 int (*bind_mw)(struct ib_qp *qp,
1208 struct ib_mw_bind *mw_bind);
1209 int (*dealloc_mw)(struct ib_mw *mw);
1210 struct ib_fmr * (*alloc_fmr)(struct ib_pd *pd,
1211 int mr_access_flags,
1212 struct ib_fmr_attr *fmr_attr);
1213 int (*map_phys_fmr)(struct ib_fmr *fmr,
1214 u64 *page_list, int list_len,
1216 int (*unmap_fmr)(struct list_head *fmr_list);
1217 int (*dealloc_fmr)(struct ib_fmr *fmr);
1218 int (*attach_mcast)(struct ib_qp *qp,
1221 int (*detach_mcast)(struct ib_qp *qp,
1224 int (*process_mad)(struct ib_device *device,
1225 int process_mad_flags,
1227 struct ib_wc *in_wc,
1228 struct ib_grh *in_grh,
1229 struct ib_mad *in_mad,
1230 struct ib_mad *out_mad);
1231 struct ib_xrcd * (*alloc_xrcd)(struct ib_device *device,
1232 struct ib_ucontext *ucontext,
1233 struct ib_udata *udata);
1234 int (*dealloc_xrcd)(struct ib_xrcd *xrcd);
1236 struct ib_dma_mapping_ops *dma_ops;
1238 struct module *owner;
1240 struct kobject *ports_parent;
1241 struct list_head port_list;
1244 IB_DEV_UNINITIALIZED,
1250 u64 uverbs_cmd_mask;
1261 void (*add) (struct ib_device *);
1262 void (*remove)(struct ib_device *);
1264 struct list_head list;
1267 struct ib_device *ib_alloc_device(size_t size);
1268 void ib_dealloc_device(struct ib_device *device);
1270 int ib_register_device(struct ib_device *device,
1271 int (*port_callback)(struct ib_device *,
1272 u8, struct kobject *));
1273 void ib_unregister_device(struct ib_device *device);
1275 int ib_register_client (struct ib_client *client);
1276 void ib_unregister_client(struct ib_client *client);
1278 void *ib_get_client_data(struct ib_device *device, struct ib_client *client);
1279 void ib_set_client_data(struct ib_device *device, struct ib_client *client,
1282 static inline int ib_copy_from_udata(void *dest, struct ib_udata *udata, size_t len)
1284 return copy_from_user(dest, udata->inbuf, len) ? -EFAULT : 0;
1287 static inline int ib_copy_to_udata(struct ib_udata *udata, void *src, size_t len)
1289 return copy_to_user(udata->outbuf, src, len) ? -EFAULT : 0;
1293 * ib_modify_qp_is_ok - Check that the supplied attribute mask
1294 * contains all required attributes and no attributes not allowed for
1295 * the given QP state transition.
1296 * @cur_state: Current QP state
1297 * @next_state: Next QP state
1299 * @mask: Mask of supplied QP attributes
1301 * This function is a helper function that a low-level driver's
1302 * modify_qp method can use to validate the consumer's input. It
1303 * checks that cur_state and next_state are valid QP states, that a
1304 * transition from cur_state to next_state is allowed by the IB spec,
1305 * and that the attribute mask supplied is allowed for the transition.
1307 int ib_modify_qp_is_ok(enum ib_qp_state cur_state, enum ib_qp_state next_state,
1308 enum ib_qp_type type, enum ib_qp_attr_mask mask);
1310 int ib_register_event_handler (struct ib_event_handler *event_handler);
1311 int ib_unregister_event_handler(struct ib_event_handler *event_handler);
1312 void ib_dispatch_event(struct ib_event *event);
1314 int ib_query_device(struct ib_device *device,
1315 struct ib_device_attr *device_attr);
1317 int ib_query_port(struct ib_device *device,
1318 u8 port_num, struct ib_port_attr *port_attr);
1320 enum rdma_link_layer rdma_port_get_link_layer(struct ib_device *device,
1323 int ib_query_gid(struct ib_device *device,
1324 u8 port_num, int index, union ib_gid *gid);
1326 int ib_query_pkey(struct ib_device *device,
1327 u8 port_num, u16 index, u16 *pkey);
1329 int ib_modify_device(struct ib_device *device,
1330 int device_modify_mask,
1331 struct ib_device_modify *device_modify);
1333 int ib_modify_port(struct ib_device *device,
1334 u8 port_num, int port_modify_mask,
1335 struct ib_port_modify *port_modify);
1337 int ib_find_gid(struct ib_device *device, union ib_gid *gid,
1338 u8 *port_num, u16 *index);
1340 int ib_find_pkey(struct ib_device *device,
1341 u8 port_num, u16 pkey, u16 *index);
1344 * ib_alloc_pd - Allocates an unused protection domain.
1345 * @device: The device on which to allocate the protection domain.
1347 * A protection domain object provides an association between QPs, shared
1348 * receive queues, address handles, memory regions, and memory windows.
1350 struct ib_pd *ib_alloc_pd(struct ib_device *device);
1353 * ib_dealloc_pd - Deallocates a protection domain.
1354 * @pd: The protection domain to deallocate.
1356 int ib_dealloc_pd(struct ib_pd *pd);
1359 * ib_create_ah - Creates an address handle for the given address vector.
1360 * @pd: The protection domain associated with the address handle.
1361 * @ah_attr: The attributes of the address vector.
1363 * The address handle is used to reference a local or global destination
1364 * in all UD QP post sends.
1366 struct ib_ah *ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
1369 * ib_init_ah_from_wc - Initializes address handle attributes from a
1371 * @device: Device on which the received message arrived.
1372 * @port_num: Port on which the received message arrived.
1373 * @wc: Work completion associated with the received message.
1374 * @grh: References the received global route header. This parameter is
1375 * ignored unless the work completion indicates that the GRH is valid.
1376 * @ah_attr: Returned attributes that can be used when creating an address
1377 * handle for replying to the message.
1379 int ib_init_ah_from_wc(struct ib_device *device, u8 port_num, struct ib_wc *wc,
1380 struct ib_grh *grh, struct ib_ah_attr *ah_attr);
1383 * ib_create_ah_from_wc - Creates an address handle associated with the
1384 * sender of the specified work completion.
1385 * @pd: The protection domain associated with the address handle.
1386 * @wc: Work completion information associated with a received message.
1387 * @grh: References the received global route header. This parameter is
1388 * ignored unless the work completion indicates that the GRH is valid.
1389 * @port_num: The outbound port number to associate with the address.
1391 * The address handle is used to reference a local or global destination
1392 * in all UD QP post sends.
1394 struct ib_ah *ib_create_ah_from_wc(struct ib_pd *pd, struct ib_wc *wc,
1395 struct ib_grh *grh, u8 port_num);
1398 * ib_modify_ah - Modifies the address vector associated with an address
1400 * @ah: The address handle to modify.
1401 * @ah_attr: The new address vector attributes to associate with the
1404 int ib_modify_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1407 * ib_query_ah - Queries the address vector associated with an address
1409 * @ah: The address handle to query.
1410 * @ah_attr: The address vector attributes associated with the address
1413 int ib_query_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1416 * ib_destroy_ah - Destroys an address handle.
1417 * @ah: The address handle to destroy.
1419 int ib_destroy_ah(struct ib_ah *ah);
1422 * ib_create_srq - Creates a SRQ associated with the specified protection
1424 * @pd: The protection domain associated with the SRQ.
1425 * @srq_init_attr: A list of initial attributes required to create the
1426 * SRQ. If SRQ creation succeeds, then the attributes are updated to
1427 * the actual capabilities of the created SRQ.
1429 * srq_attr->max_wr and srq_attr->max_sge are read the determine the
1430 * requested size of the SRQ, and set to the actual values allocated
1431 * on return. If ib_create_srq() succeeds, then max_wr and max_sge
1432 * will always be at least as large as the requested values.
1434 struct ib_srq *ib_create_srq(struct ib_pd *pd,
1435 struct ib_srq_init_attr *srq_init_attr);
1438 * ib_modify_srq - Modifies the attributes for the specified SRQ.
1439 * @srq: The SRQ to modify.
1440 * @srq_attr: On input, specifies the SRQ attributes to modify. On output,
1441 * the current values of selected SRQ attributes are returned.
1442 * @srq_attr_mask: A bit-mask used to specify which attributes of the SRQ
1443 * are being modified.
1445 * The mask may contain IB_SRQ_MAX_WR to resize the SRQ and/or
1446 * IB_SRQ_LIMIT to set the SRQ's limit and request notification when
1447 * the number of receives queued drops below the limit.
1449 int ib_modify_srq(struct ib_srq *srq,
1450 struct ib_srq_attr *srq_attr,
1451 enum ib_srq_attr_mask srq_attr_mask);
1454 * ib_query_srq - Returns the attribute list and current values for the
1456 * @srq: The SRQ to query.
1457 * @srq_attr: The attributes of the specified SRQ.
1459 int ib_query_srq(struct ib_srq *srq,
1460 struct ib_srq_attr *srq_attr);
1463 * ib_destroy_srq - Destroys the specified SRQ.
1464 * @srq: The SRQ to destroy.
1466 int ib_destroy_srq(struct ib_srq *srq);
1469 * ib_post_srq_recv - Posts a list of work requests to the specified SRQ.
1470 * @srq: The SRQ to post the work request on.
1471 * @recv_wr: A list of work requests to post on the receive queue.
1472 * @bad_recv_wr: On an immediate failure, this parameter will reference
1473 * the work request that failed to be posted on the QP.
1475 static inline int ib_post_srq_recv(struct ib_srq *srq,
1476 struct ib_recv_wr *recv_wr,
1477 struct ib_recv_wr **bad_recv_wr)
1479 return srq->device->post_srq_recv(srq, recv_wr, bad_recv_wr);
1483 * ib_create_qp - Creates a QP associated with the specified protection
1485 * @pd: The protection domain associated with the QP.
1486 * @qp_init_attr: A list of initial attributes required to create the
1487 * QP. If QP creation succeeds, then the attributes are updated to
1488 * the actual capabilities of the created QP.
1490 struct ib_qp *ib_create_qp(struct ib_pd *pd,
1491 struct ib_qp_init_attr *qp_init_attr);
1494 * ib_modify_qp - Modifies the attributes for the specified QP and then
1495 * transitions the QP to the given state.
1496 * @qp: The QP to modify.
1497 * @qp_attr: On input, specifies the QP attributes to modify. On output,
1498 * the current values of selected QP attributes are returned.
1499 * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
1500 * are being modified.
1502 int ib_modify_qp(struct ib_qp *qp,
1503 struct ib_qp_attr *qp_attr,
1507 * ib_query_qp - Returns the attribute list and current values for the
1509 * @qp: The QP to query.
1510 * @qp_attr: The attributes of the specified QP.
1511 * @qp_attr_mask: A bit-mask used to select specific attributes to query.
1512 * @qp_init_attr: Additional attributes of the selected QP.
1514 * The qp_attr_mask may be used to limit the query to gathering only the
1515 * selected attributes.
1517 int ib_query_qp(struct ib_qp *qp,
1518 struct ib_qp_attr *qp_attr,
1520 struct ib_qp_init_attr *qp_init_attr);
1523 * ib_destroy_qp - Destroys the specified QP.
1524 * @qp: The QP to destroy.
1526 int ib_destroy_qp(struct ib_qp *qp);
1529 * ib_open_qp - Obtain a reference to an existing sharable QP.
1530 * @xrcd - XRC domain
1531 * @qp_open_attr: Attributes identifying the QP to open.
1533 * Returns a reference to a sharable QP.
1535 struct ib_qp *ib_open_qp(struct ib_xrcd *xrcd,
1536 struct ib_qp_open_attr *qp_open_attr);
1539 * ib_close_qp - Release an external reference to a QP.
1540 * @qp: The QP handle to release
1542 * The opened QP handle is released by the caller. The underlying
1543 * shared QP is not destroyed until all internal references are released.
1545 int ib_close_qp(struct ib_qp *qp);
1548 * ib_post_send - Posts a list of work requests to the send queue of
1550 * @qp: The QP to post the work request on.
1551 * @send_wr: A list of work requests to post on the send queue.
1552 * @bad_send_wr: On an immediate failure, this parameter will reference
1553 * the work request that failed to be posted on the QP.
1555 * While IBA Vol. 1 section 11.4.1.1 specifies that if an immediate
1556 * error is returned, the QP state shall not be affected,
1557 * ib_post_send() will return an immediate error after queueing any
1558 * earlier work requests in the list.
1560 static inline int ib_post_send(struct ib_qp *qp,
1561 struct ib_send_wr *send_wr,
1562 struct ib_send_wr **bad_send_wr)
1564 return qp->device->post_send(qp, send_wr, bad_send_wr);
1568 * ib_post_recv - Posts a list of work requests to the receive queue of
1570 * @qp: The QP to post the work request on.
1571 * @recv_wr: A list of work requests to post on the receive queue.
1572 * @bad_recv_wr: On an immediate failure, this parameter will reference
1573 * the work request that failed to be posted on the QP.
1575 static inline int ib_post_recv(struct ib_qp *qp,
1576 struct ib_recv_wr *recv_wr,
1577 struct ib_recv_wr **bad_recv_wr)
1579 return qp->device->post_recv(qp, recv_wr, bad_recv_wr);
1583 * ib_create_cq - Creates a CQ on the specified device.
1584 * @device: The device on which to create the CQ.
1585 * @comp_handler: A user-specified callback that is invoked when a
1586 * completion event occurs on the CQ.
1587 * @event_handler: A user-specified callback that is invoked when an
1588 * asynchronous event not associated with a completion occurs on the CQ.
1589 * @cq_context: Context associated with the CQ returned to the user via
1590 * the associated completion and event handlers.
1591 * @cqe: The minimum size of the CQ.
1592 * @comp_vector - Completion vector used to signal completion events.
1593 * Must be >= 0 and < context->num_comp_vectors.
1595 * Users can examine the cq structure to determine the actual CQ size.
1597 struct ib_cq *ib_create_cq(struct ib_device *device,
1598 ib_comp_handler comp_handler,
1599 void (*event_handler)(struct ib_event *, void *),
1600 void *cq_context, int cqe, int comp_vector);
1603 * ib_resize_cq - Modifies the capacity of the CQ.
1604 * @cq: The CQ to resize.
1605 * @cqe: The minimum size of the CQ.
1607 * Users can examine the cq structure to determine the actual CQ size.
1609 int ib_resize_cq(struct ib_cq *cq, int cqe);
1612 * ib_modify_cq - Modifies moderation params of the CQ
1613 * @cq: The CQ to modify.
1614 * @cq_count: number of CQEs that will trigger an event
1615 * @cq_period: max period of time in usec before triggering an event
1618 int ib_modify_cq(struct ib_cq *cq, u16 cq_count, u16 cq_period);
1621 * ib_destroy_cq - Destroys the specified CQ.
1622 * @cq: The CQ to destroy.
1624 int ib_destroy_cq(struct ib_cq *cq);
1627 * ib_poll_cq - poll a CQ for completion(s)
1628 * @cq:the CQ being polled
1629 * @num_entries:maximum number of completions to return
1630 * @wc:array of at least @num_entries &struct ib_wc where completions
1633 * Poll a CQ for (possibly multiple) completions. If the return value
1634 * is < 0, an error occurred. If the return value is >= 0, it is the
1635 * number of completions returned. If the return value is
1636 * non-negative and < num_entries, then the CQ was emptied.
1638 static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
1641 return cq->device->poll_cq(cq, num_entries, wc);
1645 * ib_peek_cq - Returns the number of unreaped completions currently
1646 * on the specified CQ.
1647 * @cq: The CQ to peek.
1648 * @wc_cnt: A minimum number of unreaped completions to check for.
1650 * If the number of unreaped completions is greater than or equal to wc_cnt,
1651 * this function returns wc_cnt, otherwise, it returns the actual number of
1652 * unreaped completions.
1654 int ib_peek_cq(struct ib_cq *cq, int wc_cnt);
1657 * ib_req_notify_cq - Request completion notification on a CQ.
1658 * @cq: The CQ to generate an event for.
1660 * Must contain exactly one of %IB_CQ_SOLICITED or %IB_CQ_NEXT_COMP
1661 * to request an event on the next solicited event or next work
1662 * completion at any type, respectively. %IB_CQ_REPORT_MISSED_EVENTS
1663 * may also be |ed in to request a hint about missed events, as
1667 * < 0 means an error occurred while requesting notification
1668 * == 0 means notification was requested successfully, and if
1669 * IB_CQ_REPORT_MISSED_EVENTS was passed in, then no events
1670 * were missed and it is safe to wait for another event. In
1671 * this case is it guaranteed that any work completions added
1672 * to the CQ since the last CQ poll will trigger a completion
1673 * notification event.
1674 * > 0 is only returned if IB_CQ_REPORT_MISSED_EVENTS was passed
1675 * in. It means that the consumer must poll the CQ again to
1676 * make sure it is empty to avoid missing an event because of a
1677 * race between requesting notification and an entry being
1678 * added to the CQ. This return value means it is possible
1679 * (but not guaranteed) that a work completion has been added
1680 * to the CQ since the last poll without triggering a
1681 * completion notification event.
1683 static inline int ib_req_notify_cq(struct ib_cq *cq,
1684 enum ib_cq_notify_flags flags)
1686 return cq->device->req_notify_cq(cq, flags);
1690 * ib_req_ncomp_notif - Request completion notification when there are
1691 * at least the specified number of unreaped completions on the CQ.
1692 * @cq: The CQ to generate an event for.
1693 * @wc_cnt: The number of unreaped completions that should be on the
1694 * CQ before an event is generated.
1696 static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
1698 return cq->device->req_ncomp_notif ?
1699 cq->device->req_ncomp_notif(cq, wc_cnt) :
1704 * ib_get_dma_mr - Returns a memory region for system memory that is
1706 * @pd: The protection domain associated with the memory region.
1707 * @mr_access_flags: Specifies the memory access rights.
1709 * Note that the ib_dma_*() functions defined below must be used
1710 * to create/destroy addresses used with the Lkey or Rkey returned
1711 * by ib_get_dma_mr().
1713 struct ib_mr *ib_get_dma_mr(struct ib_pd *pd, int mr_access_flags);
1716 * ib_dma_mapping_error - check a DMA addr for error
1717 * @dev: The device for which the dma_addr was created
1718 * @dma_addr: The DMA address to check
1720 static inline int ib_dma_mapping_error(struct ib_device *dev, u64 dma_addr)
1723 return dev->dma_ops->mapping_error(dev, dma_addr);
1724 return dma_mapping_error(dev->dma_device, dma_addr);
1728 * ib_dma_map_single - Map a kernel virtual address to DMA address
1729 * @dev: The device for which the dma_addr is to be created
1730 * @cpu_addr: The kernel virtual address
1731 * @size: The size of the region in bytes
1732 * @direction: The direction of the DMA
1734 static inline u64 ib_dma_map_single(struct ib_device *dev,
1735 void *cpu_addr, size_t size,
1736 enum dma_data_direction direction)
1739 return dev->dma_ops->map_single(dev, cpu_addr, size, direction);
1740 return dma_map_single(dev->dma_device, cpu_addr, size, direction);
1744 * ib_dma_unmap_single - Destroy a mapping created by ib_dma_map_single()
1745 * @dev: The device for which the DMA address was created
1746 * @addr: The DMA address
1747 * @size: The size of the region in bytes
1748 * @direction: The direction of the DMA
1750 static inline void ib_dma_unmap_single(struct ib_device *dev,
1751 u64 addr, size_t size,
1752 enum dma_data_direction direction)
1755 dev->dma_ops->unmap_single(dev, addr, size, direction);
1757 dma_unmap_single(dev->dma_device, addr, size, direction);
1760 static inline u64 ib_dma_map_single_attrs(struct ib_device *dev,
1761 void *cpu_addr, size_t size,
1762 enum dma_data_direction direction,
1763 struct dma_attrs *attrs)
1765 return dma_map_single_attrs(dev->dma_device, cpu_addr, size,
1769 static inline void ib_dma_unmap_single_attrs(struct ib_device *dev,
1770 u64 addr, size_t size,
1771 enum dma_data_direction direction,
1772 struct dma_attrs *attrs)
1774 return dma_unmap_single_attrs(dev->dma_device, addr, size,
1779 * ib_dma_map_page - Map a physical page to DMA address
1780 * @dev: The device for which the dma_addr is to be created
1781 * @page: The page to be mapped
1782 * @offset: The offset within the page
1783 * @size: The size of the region in bytes
1784 * @direction: The direction of the DMA
1786 static inline u64 ib_dma_map_page(struct ib_device *dev,
1788 unsigned long offset,
1790 enum dma_data_direction direction)
1793 return dev->dma_ops->map_page(dev, page, offset, size, direction);
1794 return dma_map_page(dev->dma_device, page, offset, size, direction);
1798 * ib_dma_unmap_page - Destroy a mapping created by ib_dma_map_page()
1799 * @dev: The device for which the DMA address was created
1800 * @addr: The DMA address
1801 * @size: The size of the region in bytes
1802 * @direction: The direction of the DMA
1804 static inline void ib_dma_unmap_page(struct ib_device *dev,
1805 u64 addr, size_t size,
1806 enum dma_data_direction direction)
1809 dev->dma_ops->unmap_page(dev, addr, size, direction);
1811 dma_unmap_page(dev->dma_device, addr, size, direction);
1815 * ib_dma_map_sg - Map a scatter/gather list to DMA addresses
1816 * @dev: The device for which the DMA addresses are to be created
1817 * @sg: The array of scatter/gather entries
1818 * @nents: The number of scatter/gather entries
1819 * @direction: The direction of the DMA
1821 static inline int ib_dma_map_sg(struct ib_device *dev,
1822 struct scatterlist *sg, int nents,
1823 enum dma_data_direction direction)
1826 return dev->dma_ops->map_sg(dev, sg, nents, direction);
1827 return dma_map_sg(dev->dma_device, sg, nents, direction);
1831 * ib_dma_unmap_sg - Unmap a scatter/gather list of DMA addresses
1832 * @dev: The device for which the DMA addresses were created
1833 * @sg: The array of scatter/gather entries
1834 * @nents: The number of scatter/gather entries
1835 * @direction: The direction of the DMA
1837 static inline void ib_dma_unmap_sg(struct ib_device *dev,
1838 struct scatterlist *sg, int nents,
1839 enum dma_data_direction direction)
1842 dev->dma_ops->unmap_sg(dev, sg, nents, direction);
1844 dma_unmap_sg(dev->dma_device, sg, nents, direction);
1847 static inline int ib_dma_map_sg_attrs(struct ib_device *dev,
1848 struct scatterlist *sg, int nents,
1849 enum dma_data_direction direction,
1850 struct dma_attrs *attrs)
1852 return dma_map_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
1855 static inline void ib_dma_unmap_sg_attrs(struct ib_device *dev,
1856 struct scatterlist *sg, int nents,
1857 enum dma_data_direction direction,
1858 struct dma_attrs *attrs)
1860 dma_unmap_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
1863 * ib_sg_dma_address - Return the DMA address from a scatter/gather entry
1864 * @dev: The device for which the DMA addresses were created
1865 * @sg: The scatter/gather entry
1867 static inline u64 ib_sg_dma_address(struct ib_device *dev,
1868 struct scatterlist *sg)
1871 return dev->dma_ops->dma_address(dev, sg);
1872 return sg_dma_address(sg);
1876 * ib_sg_dma_len - Return the DMA length from a scatter/gather entry
1877 * @dev: The device for which the DMA addresses were created
1878 * @sg: The scatter/gather entry
1880 static inline unsigned int ib_sg_dma_len(struct ib_device *dev,
1881 struct scatterlist *sg)
1884 return dev->dma_ops->dma_len(dev, sg);
1885 return sg_dma_len(sg);
1889 * ib_dma_sync_single_for_cpu - Prepare DMA region to be accessed by CPU
1890 * @dev: The device for which the DMA address was created
1891 * @addr: The DMA address
1892 * @size: The size of the region in bytes
1893 * @dir: The direction of the DMA
1895 static inline void ib_dma_sync_single_for_cpu(struct ib_device *dev,
1898 enum dma_data_direction dir)
1901 dev->dma_ops->sync_single_for_cpu(dev, addr, size, dir);
1903 dma_sync_single_for_cpu(dev->dma_device, addr, size, dir);
1907 * ib_dma_sync_single_for_device - Prepare DMA region to be accessed by device
1908 * @dev: The device for which the DMA address was created
1909 * @addr: The DMA address
1910 * @size: The size of the region in bytes
1911 * @dir: The direction of the DMA
1913 static inline void ib_dma_sync_single_for_device(struct ib_device *dev,
1916 enum dma_data_direction dir)
1919 dev->dma_ops->sync_single_for_device(dev, addr, size, dir);
1921 dma_sync_single_for_device(dev->dma_device, addr, size, dir);
1925 * ib_dma_alloc_coherent - Allocate memory and map it for DMA
1926 * @dev: The device for which the DMA address is requested
1927 * @size: The size of the region to allocate in bytes
1928 * @dma_handle: A pointer for returning the DMA address of the region
1929 * @flag: memory allocator flags
1931 static inline void *ib_dma_alloc_coherent(struct ib_device *dev,
1937 return dev->dma_ops->alloc_coherent(dev, size, dma_handle, flag);
1942 ret = dma_alloc_coherent(dev->dma_device, size, &handle, flag);
1943 *dma_handle = handle;
1949 * ib_dma_free_coherent - Free memory allocated by ib_dma_alloc_coherent()
1950 * @dev: The device for which the DMA addresses were allocated
1951 * @size: The size of the region
1952 * @cpu_addr: the address returned by ib_dma_alloc_coherent()
1953 * @dma_handle: the DMA address returned by ib_dma_alloc_coherent()
1955 static inline void ib_dma_free_coherent(struct ib_device *dev,
1956 size_t size, void *cpu_addr,
1960 dev->dma_ops->free_coherent(dev, size, cpu_addr, dma_handle);
1962 dma_free_coherent(dev->dma_device, size, cpu_addr, dma_handle);
1966 * ib_reg_phys_mr - Prepares a virtually addressed memory region for use
1968 * @pd: The protection domain associated assigned to the registered region.
1969 * @phys_buf_array: Specifies a list of physical buffers to use in the
1971 * @num_phys_buf: Specifies the size of the phys_buf_array.
1972 * @mr_access_flags: Specifies the memory access rights.
1973 * @iova_start: The offset of the region's starting I/O virtual address.
1975 struct ib_mr *ib_reg_phys_mr(struct ib_pd *pd,
1976 struct ib_phys_buf *phys_buf_array,
1978 int mr_access_flags,
1982 * ib_rereg_phys_mr - Modifies the attributes of an existing memory region.
1983 * Conceptually, this call performs the functions deregister memory region
1984 * followed by register physical memory region. Where possible,
1985 * resources are reused instead of deallocated and reallocated.
1986 * @mr: The memory region to modify.
1987 * @mr_rereg_mask: A bit-mask used to indicate which of the following
1988 * properties of the memory region are being modified.
1989 * @pd: If %IB_MR_REREG_PD is set in mr_rereg_mask, this field specifies
1990 * the new protection domain to associated with the memory region,
1991 * otherwise, this parameter is ignored.
1992 * @phys_buf_array: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1993 * field specifies a list of physical buffers to use in the new
1994 * translation, otherwise, this parameter is ignored.
1995 * @num_phys_buf: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1996 * field specifies the size of the phys_buf_array, otherwise, this
1997 * parameter is ignored.
1998 * @mr_access_flags: If %IB_MR_REREG_ACCESS is set in mr_rereg_mask, this
1999 * field specifies the new memory access rights, otherwise, this
2000 * parameter is ignored.
2001 * @iova_start: The offset of the region's starting I/O virtual address.
2003 int ib_rereg_phys_mr(struct ib_mr *mr,
2006 struct ib_phys_buf *phys_buf_array,
2008 int mr_access_flags,
2012 * ib_query_mr - Retrieves information about a specific memory region.
2013 * @mr: The memory region to retrieve information about.
2014 * @mr_attr: The attributes of the specified memory region.
2016 int ib_query_mr(struct ib_mr *mr, struct ib_mr_attr *mr_attr);
2019 * ib_dereg_mr - Deregisters a memory region and removes it from the
2020 * HCA translation table.
2021 * @mr: The memory region to deregister.
2023 int ib_dereg_mr(struct ib_mr *mr);
2026 * ib_alloc_fast_reg_mr - Allocates memory region usable with the
2027 * IB_WR_FAST_REG_MR send work request.
2028 * @pd: The protection domain associated with the region.
2029 * @max_page_list_len: requested max physical buffer list length to be
2030 * used with fast register work requests for this MR.
2032 struct ib_mr *ib_alloc_fast_reg_mr(struct ib_pd *pd, int max_page_list_len);
2035 * ib_alloc_fast_reg_page_list - Allocates a page list array
2036 * @device - ib device pointer.
2037 * @page_list_len - size of the page list array to be allocated.
2039 * This allocates and returns a struct ib_fast_reg_page_list * and a
2040 * page_list array that is at least page_list_len in size. The actual
2041 * size is returned in max_page_list_len. The caller is responsible
2042 * for initializing the contents of the page_list array before posting
2043 * a send work request with the IB_WC_FAST_REG_MR opcode.
2045 * The page_list array entries must be translated using one of the
2046 * ib_dma_*() functions just like the addresses passed to
2047 * ib_map_phys_fmr(). Once the ib_post_send() is issued, the struct
2048 * ib_fast_reg_page_list must not be modified by the caller until the
2049 * IB_WC_FAST_REG_MR work request completes.
2051 struct ib_fast_reg_page_list *ib_alloc_fast_reg_page_list(
2052 struct ib_device *device, int page_list_len);
2055 * ib_free_fast_reg_page_list - Deallocates a previously allocated
2057 * @page_list - struct ib_fast_reg_page_list pointer to be deallocated.
2059 void ib_free_fast_reg_page_list(struct ib_fast_reg_page_list *page_list);
2062 * ib_update_fast_reg_key - updates the key portion of the fast_reg MR
2064 * @mr - struct ib_mr pointer to be updated.
2065 * @newkey - new key to be used.
2067 static inline void ib_update_fast_reg_key(struct ib_mr *mr, u8 newkey)
2069 mr->lkey = (mr->lkey & 0xffffff00) | newkey;
2070 mr->rkey = (mr->rkey & 0xffffff00) | newkey;
2074 * ib_alloc_mw - Allocates a memory window.
2075 * @pd: The protection domain associated with the memory window.
2077 struct ib_mw *ib_alloc_mw(struct ib_pd *pd);
2080 * ib_bind_mw - Posts a work request to the send queue of the specified
2081 * QP, which binds the memory window to the given address range and
2082 * remote access attributes.
2083 * @qp: QP to post the bind work request on.
2084 * @mw: The memory window to bind.
2085 * @mw_bind: Specifies information about the memory window, including
2086 * its address range, remote access rights, and associated memory region.
2088 static inline int ib_bind_mw(struct ib_qp *qp,
2090 struct ib_mw_bind *mw_bind)
2092 /* XXX reference counting in corresponding MR? */
2093 return mw->device->bind_mw ?
2094 mw->device->bind_mw(qp, mw, mw_bind) :
2099 * ib_dealloc_mw - Deallocates a memory window.
2100 * @mw: The memory window to deallocate.
2102 int ib_dealloc_mw(struct ib_mw *mw);
2105 * ib_alloc_fmr - Allocates a unmapped fast memory region.
2106 * @pd: The protection domain associated with the unmapped region.
2107 * @mr_access_flags: Specifies the memory access rights.
2108 * @fmr_attr: Attributes of the unmapped region.
2110 * A fast memory region must be mapped before it can be used as part of
2113 struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
2114 int mr_access_flags,
2115 struct ib_fmr_attr *fmr_attr);
2118 * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
2119 * @fmr: The fast memory region to associate with the pages.
2120 * @page_list: An array of physical pages to map to the fast memory region.
2121 * @list_len: The number of pages in page_list.
2122 * @iova: The I/O virtual address to use with the mapped region.
2124 static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
2125 u64 *page_list, int list_len,
2128 return fmr->device->map_phys_fmr(fmr, page_list, list_len, iova);
2132 * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
2133 * @fmr_list: A linked list of fast memory regions to unmap.
2135 int ib_unmap_fmr(struct list_head *fmr_list);
2138 * ib_dealloc_fmr - Deallocates a fast memory region.
2139 * @fmr: The fast memory region to deallocate.
2141 int ib_dealloc_fmr(struct ib_fmr *fmr);
2144 * ib_attach_mcast - Attaches the specified QP to a multicast group.
2145 * @qp: QP to attach to the multicast group. The QP must be type
2147 * @gid: Multicast group GID.
2148 * @lid: Multicast group LID in host byte order.
2150 * In order to send and receive multicast packets, subnet
2151 * administration must have created the multicast group and configured
2152 * the fabric appropriately. The port associated with the specified
2153 * QP must also be a member of the multicast group.
2155 int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
2158 * ib_detach_mcast - Detaches the specified QP from a multicast group.
2159 * @qp: QP to detach from the multicast group.
2160 * @gid: Multicast group GID.
2161 * @lid: Multicast group LID in host byte order.
2163 int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
2166 * ib_alloc_xrcd - Allocates an XRC domain.
2167 * @device: The device on which to allocate the XRC domain.
2169 struct ib_xrcd *ib_alloc_xrcd(struct ib_device *device);
2172 * ib_dealloc_xrcd - Deallocates an XRC domain.
2173 * @xrcd: The XRC domain to deallocate.
2175 int ib_dealloc_xrcd(struct ib_xrcd *xrcd);
2177 #endif /* IB_VERBS_H */