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>
51 #include <asm/atomic.h>
52 #include <asm/uaccess.h>
63 /* IB values map to NodeInfo:NodeType. */
70 enum rdma_transport_type {
75 enum rdma_transport_type
76 rdma_node_get_transport(enum rdma_node_type node_type) __attribute_const__;
78 enum ib_device_cap_flags {
79 IB_DEVICE_RESIZE_MAX_WR = 1,
80 IB_DEVICE_BAD_PKEY_CNTR = (1<<1),
81 IB_DEVICE_BAD_QKEY_CNTR = (1<<2),
82 IB_DEVICE_RAW_MULTI = (1<<3),
83 IB_DEVICE_AUTO_PATH_MIG = (1<<4),
84 IB_DEVICE_CHANGE_PHY_PORT = (1<<5),
85 IB_DEVICE_UD_AV_PORT_ENFORCE = (1<<6),
86 IB_DEVICE_CURR_QP_STATE_MOD = (1<<7),
87 IB_DEVICE_SHUTDOWN_PORT = (1<<8),
88 IB_DEVICE_INIT_TYPE = (1<<9),
89 IB_DEVICE_PORT_ACTIVE_EVENT = (1<<10),
90 IB_DEVICE_SYS_IMAGE_GUID = (1<<11),
91 IB_DEVICE_RC_RNR_NAK_GEN = (1<<12),
92 IB_DEVICE_SRQ_RESIZE = (1<<13),
93 IB_DEVICE_N_NOTIFY_CQ = (1<<14),
94 IB_DEVICE_ZERO_STAG = (1<<15),
95 IB_DEVICE_RESERVED = (1<<16), /* old SEND_W_INV */
96 IB_DEVICE_MEM_WINDOW = (1<<17),
98 * Devices should set IB_DEVICE_UD_IP_SUM if they support
99 * insertion of UDP and TCP checksum on outgoing UD IPoIB
100 * messages and can verify the validity of checksum for
101 * incoming messages. Setting this flag implies that the
102 * IPoIB driver may set NETIF_F_IP_CSUM for datagram mode.
104 IB_DEVICE_UD_IP_CSUM = (1<<18),
105 IB_DEVICE_UD_TSO = (1<<19),
106 IB_DEVICE_MEM_MGT_EXTENSIONS = (1<<21),
115 struct ib_device_attr {
117 __be64 sys_image_guid;
125 int device_cap_flags;
135 int max_qp_init_rd_atom;
136 int max_ee_init_rd_atom;
137 enum ib_atomic_cap atomic_cap;
144 int max_mcast_qp_attach;
145 int max_total_mcast_qp_attach;
152 unsigned int max_fast_reg_page_list_len;
154 u8 local_ca_ack_delay;
165 static inline int ib_mtu_enum_to_int(enum ib_mtu mtu)
168 case IB_MTU_256: return 256;
169 case IB_MTU_512: return 512;
170 case IB_MTU_1024: return 1024;
171 case IB_MTU_2048: return 2048;
172 case IB_MTU_4096: return 4096;
183 IB_PORT_ACTIVE_DEFER = 5
186 enum ib_port_cap_flags {
188 IB_PORT_NOTICE_SUP = 1 << 2,
189 IB_PORT_TRAP_SUP = 1 << 3,
190 IB_PORT_OPT_IPD_SUP = 1 << 4,
191 IB_PORT_AUTO_MIGR_SUP = 1 << 5,
192 IB_PORT_SL_MAP_SUP = 1 << 6,
193 IB_PORT_MKEY_NVRAM = 1 << 7,
194 IB_PORT_PKEY_NVRAM = 1 << 8,
195 IB_PORT_LED_INFO_SUP = 1 << 9,
196 IB_PORT_SM_DISABLED = 1 << 10,
197 IB_PORT_SYS_IMAGE_GUID_SUP = 1 << 11,
198 IB_PORT_PKEY_SW_EXT_PORT_TRAP_SUP = 1 << 12,
199 IB_PORT_CM_SUP = 1 << 16,
200 IB_PORT_SNMP_TUNNEL_SUP = 1 << 17,
201 IB_PORT_REINIT_SUP = 1 << 18,
202 IB_PORT_DEVICE_MGMT_SUP = 1 << 19,
203 IB_PORT_VENDOR_CLASS_SUP = 1 << 20,
204 IB_PORT_DR_NOTICE_SUP = 1 << 21,
205 IB_PORT_CAP_MASK_NOTICE_SUP = 1 << 22,
206 IB_PORT_BOOT_MGMT_SUP = 1 << 23,
207 IB_PORT_LINK_LATENCY_SUP = 1 << 24,
208 IB_PORT_CLIENT_REG_SUP = 1 << 25
218 static inline int ib_width_enum_to_int(enum ib_port_width width)
221 case IB_WIDTH_1X: return 1;
222 case IB_WIDTH_4X: return 4;
223 case IB_WIDTH_8X: return 8;
224 case IB_WIDTH_12X: return 12;
229 struct ib_port_attr {
230 enum ib_port_state state;
232 enum ib_mtu active_mtu;
251 enum ib_device_modify_flags {
252 IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1 << 0,
253 IB_DEVICE_MODIFY_NODE_DESC = 1 << 1
256 struct ib_device_modify {
261 enum ib_port_modify_flags {
262 IB_PORT_SHUTDOWN = 1,
263 IB_PORT_INIT_TYPE = (1<<2),
264 IB_PORT_RESET_QKEY_CNTR = (1<<3)
267 struct ib_port_modify {
268 u32 set_port_cap_mask;
269 u32 clr_port_cap_mask;
277 IB_EVENT_QP_ACCESS_ERR,
281 IB_EVENT_PATH_MIG_ERR,
282 IB_EVENT_DEVICE_FATAL,
283 IB_EVENT_PORT_ACTIVE,
286 IB_EVENT_PKEY_CHANGE,
289 IB_EVENT_SRQ_LIMIT_REACHED,
290 IB_EVENT_QP_LAST_WQE_REACHED,
291 IB_EVENT_CLIENT_REREGISTER
295 struct ib_device *device;
302 enum ib_event_type event;
305 struct ib_event_handler {
306 struct ib_device *device;
307 void (*handler)(struct ib_event_handler *, struct ib_event *);
308 struct list_head list;
311 #define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler) \
313 (_ptr)->device = _device; \
314 (_ptr)->handler = _handler; \
315 INIT_LIST_HEAD(&(_ptr)->list); \
318 struct ib_global_route {
327 __be32 version_tclass_flow;
336 IB_MULTICAST_QPN = 0xffffff
339 #define IB_LID_PERMISSIVE __constant_htons(0xFFFF)
346 IB_RATE_PORT_CURRENT = 0,
347 IB_RATE_2_5_GBPS = 2,
355 IB_RATE_120_GBPS = 10
359 * ib_rate_to_mult - Convert the IB rate enum to a multiple of the
360 * base rate of 2.5 Gbit/sec. For example, IB_RATE_5_GBPS will be
361 * converted to 2, since 5 Gbit/sec is 2 * 2.5 Gbit/sec.
362 * @rate: rate to convert.
364 int ib_rate_to_mult(enum ib_rate rate) __attribute_const__;
367 * mult_to_ib_rate - Convert a multiple of 2.5 Gbit/sec to an IB rate
369 * @mult: multiple to convert.
371 enum ib_rate mult_to_ib_rate(int mult) __attribute_const__;
374 struct ib_global_route grh;
387 IB_WC_LOC_EEC_OP_ERR,
392 IB_WC_LOC_ACCESS_ERR,
393 IB_WC_REM_INV_REQ_ERR,
394 IB_WC_REM_ACCESS_ERR,
397 IB_WC_RNR_RETRY_EXC_ERR,
398 IB_WC_LOC_RDD_VIOL_ERR,
399 IB_WC_REM_INV_RD_REQ_ERR,
402 IB_WC_INV_EEC_STATE_ERR,
404 IB_WC_RESP_TIMEOUT_ERR,
419 * Set value of IB_WC_RECV so consumers can test if a completion is a
420 * receive by testing (opcode & IB_WC_RECV).
423 IB_WC_RECV_RDMA_WITH_IMM
428 IB_WC_WITH_IMM = (1<<1),
429 IB_WC_WITH_INVALIDATE = (1<<2),
434 enum ib_wc_status status;
435 enum ib_wc_opcode opcode;
449 u8 port_num; /* valid only for DR SMPs on switches */
453 enum ib_cq_notify_flags {
454 IB_CQ_SOLICITED = 1 << 0,
455 IB_CQ_NEXT_COMP = 1 << 1,
456 IB_CQ_SOLICITED_MASK = IB_CQ_SOLICITED | IB_CQ_NEXT_COMP,
457 IB_CQ_REPORT_MISSED_EVENTS = 1 << 2,
460 enum ib_srq_attr_mask {
461 IB_SRQ_MAX_WR = 1 << 0,
462 IB_SRQ_LIMIT = 1 << 1,
471 struct ib_srq_init_attr {
472 void (*event_handler)(struct ib_event *, void *);
474 struct ib_srq_attr attr;
492 * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
493 * here (and in that order) since the MAD layer uses them as
494 * indices into a 2-entry table.
506 enum ib_qp_create_flags {
507 IB_QP_CREATE_IPOIB_UD_LSO = 1 << 0,
510 struct ib_qp_init_attr {
511 void (*event_handler)(struct ib_event *, void *);
513 struct ib_cq *send_cq;
514 struct ib_cq *recv_cq;
516 struct ib_qp_cap cap;
517 enum ib_sig_type sq_sig_type;
518 enum ib_qp_type qp_type;
519 enum ib_qp_create_flags create_flags;
520 u8 port_num; /* special QP types only */
523 enum ib_rnr_timeout {
524 IB_RNR_TIMER_655_36 = 0,
525 IB_RNR_TIMER_000_01 = 1,
526 IB_RNR_TIMER_000_02 = 2,
527 IB_RNR_TIMER_000_03 = 3,
528 IB_RNR_TIMER_000_04 = 4,
529 IB_RNR_TIMER_000_06 = 5,
530 IB_RNR_TIMER_000_08 = 6,
531 IB_RNR_TIMER_000_12 = 7,
532 IB_RNR_TIMER_000_16 = 8,
533 IB_RNR_TIMER_000_24 = 9,
534 IB_RNR_TIMER_000_32 = 10,
535 IB_RNR_TIMER_000_48 = 11,
536 IB_RNR_TIMER_000_64 = 12,
537 IB_RNR_TIMER_000_96 = 13,
538 IB_RNR_TIMER_001_28 = 14,
539 IB_RNR_TIMER_001_92 = 15,
540 IB_RNR_TIMER_002_56 = 16,
541 IB_RNR_TIMER_003_84 = 17,
542 IB_RNR_TIMER_005_12 = 18,
543 IB_RNR_TIMER_007_68 = 19,
544 IB_RNR_TIMER_010_24 = 20,
545 IB_RNR_TIMER_015_36 = 21,
546 IB_RNR_TIMER_020_48 = 22,
547 IB_RNR_TIMER_030_72 = 23,
548 IB_RNR_TIMER_040_96 = 24,
549 IB_RNR_TIMER_061_44 = 25,
550 IB_RNR_TIMER_081_92 = 26,
551 IB_RNR_TIMER_122_88 = 27,
552 IB_RNR_TIMER_163_84 = 28,
553 IB_RNR_TIMER_245_76 = 29,
554 IB_RNR_TIMER_327_68 = 30,
555 IB_RNR_TIMER_491_52 = 31
558 enum ib_qp_attr_mask {
560 IB_QP_CUR_STATE = (1<<1),
561 IB_QP_EN_SQD_ASYNC_NOTIFY = (1<<2),
562 IB_QP_ACCESS_FLAGS = (1<<3),
563 IB_QP_PKEY_INDEX = (1<<4),
567 IB_QP_PATH_MTU = (1<<8),
568 IB_QP_TIMEOUT = (1<<9),
569 IB_QP_RETRY_CNT = (1<<10),
570 IB_QP_RNR_RETRY = (1<<11),
571 IB_QP_RQ_PSN = (1<<12),
572 IB_QP_MAX_QP_RD_ATOMIC = (1<<13),
573 IB_QP_ALT_PATH = (1<<14),
574 IB_QP_MIN_RNR_TIMER = (1<<15),
575 IB_QP_SQ_PSN = (1<<16),
576 IB_QP_MAX_DEST_RD_ATOMIC = (1<<17),
577 IB_QP_PATH_MIG_STATE = (1<<18),
579 IB_QP_DEST_QPN = (1<<20)
599 enum ib_qp_state qp_state;
600 enum ib_qp_state cur_qp_state;
601 enum ib_mtu path_mtu;
602 enum ib_mig_state path_mig_state;
608 struct ib_qp_cap cap;
609 struct ib_ah_attr ah_attr;
610 struct ib_ah_attr alt_ah_attr;
613 u8 en_sqd_async_notify;
616 u8 max_dest_rd_atomic;
628 IB_WR_RDMA_WRITE_WITH_IMM,
632 IB_WR_ATOMIC_CMP_AND_SWP,
633 IB_WR_ATOMIC_FETCH_AND_ADD,
636 IB_WR_RDMA_READ_WITH_INV,
643 IB_SEND_SIGNALED = (1<<1),
644 IB_SEND_SOLICITED = (1<<2),
645 IB_SEND_INLINE = (1<<3),
646 IB_SEND_IP_CSUM = (1<<4)
655 struct ib_fast_reg_page_list {
656 struct ib_device *device;
658 unsigned int max_page_list_len;
662 struct ib_send_wr *next;
664 struct ib_sge *sg_list;
666 enum ib_wr_opcode opcode;
690 u16 pkey_index; /* valid for GSI only */
691 u8 port_num; /* valid for DR SMPs on switch only */
695 struct ib_fast_reg_page_list *page_list;
696 unsigned int page_shift;
697 unsigned int page_list_len;
706 struct ib_recv_wr *next;
708 struct ib_sge *sg_list;
712 enum ib_access_flags {
713 IB_ACCESS_LOCAL_WRITE = 1,
714 IB_ACCESS_REMOTE_WRITE = (1<<1),
715 IB_ACCESS_REMOTE_READ = (1<<2),
716 IB_ACCESS_REMOTE_ATOMIC = (1<<3),
717 IB_ACCESS_MW_BIND = (1<<4)
727 u64 device_virt_addr;
734 enum ib_mr_rereg_flags {
735 IB_MR_REREG_TRANS = 1,
736 IB_MR_REREG_PD = (1<<1),
737 IB_MR_REREG_ACCESS = (1<<2)
756 struct ib_device *device;
757 struct list_head pd_list;
758 struct list_head mr_list;
759 struct list_head mw_list;
760 struct list_head cq_list;
761 struct list_head qp_list;
762 struct list_head srq_list;
763 struct list_head ah_list;
768 u64 user_handle; /* handle given to us by userspace */
769 struct ib_ucontext *context; /* associated user context */
770 void *object; /* containing object */
771 struct list_head list; /* link to context's list */
772 int id; /* index into kernel idr */
774 struct rw_semaphore mutex; /* protects .live */
786 struct ib_device *device;
787 struct ib_uobject *uobject;
788 atomic_t usecnt; /* count all resources */
792 struct ib_device *device;
794 struct ib_uobject *uobject;
797 typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
800 struct ib_device *device;
801 struct ib_uobject *uobject;
802 ib_comp_handler comp_handler;
803 void (*event_handler)(struct ib_event *, void *);
806 atomic_t usecnt; /* count number of work queues */
810 struct ib_device *device;
812 struct ib_uobject *uobject;
813 void (*event_handler)(struct ib_event *, void *);
819 struct ib_device *device;
821 struct ib_cq *send_cq;
822 struct ib_cq *recv_cq;
824 struct ib_uobject *uobject;
825 void (*event_handler)(struct ib_event *, void *);
828 enum ib_qp_type qp_type;
832 struct ib_device *device;
834 struct ib_uobject *uobject;
837 atomic_t usecnt; /* count number of MWs */
841 struct ib_device *device;
843 struct ib_uobject *uobject;
848 struct ib_device *device;
850 struct list_head list;
858 enum ib_process_mad_flags {
859 IB_MAD_IGNORE_MKEY = 1,
860 IB_MAD_IGNORE_BKEY = 2,
861 IB_MAD_IGNORE_ALL = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
865 IB_MAD_RESULT_FAILURE = 0, /* (!SUCCESS is the important flag) */
866 IB_MAD_RESULT_SUCCESS = 1 << 0, /* MAD was successfully processed */
867 IB_MAD_RESULT_REPLY = 1 << 1, /* Reply packet needs to be sent */
868 IB_MAD_RESULT_CONSUMED = 1 << 2 /* Packet consumed: stop processing */
871 #define IB_DEVICE_NAME_MAX 64
875 struct ib_event_handler event_handler;
876 struct ib_pkey_cache **pkey_cache;
877 struct ib_gid_cache **gid_cache;
881 struct ib_dma_mapping_ops {
882 int (*mapping_error)(struct ib_device *dev,
884 u64 (*map_single)(struct ib_device *dev,
885 void *ptr, size_t size,
886 enum dma_data_direction direction);
887 void (*unmap_single)(struct ib_device *dev,
888 u64 addr, size_t size,
889 enum dma_data_direction direction);
890 u64 (*map_page)(struct ib_device *dev,
891 struct page *page, unsigned long offset,
893 enum dma_data_direction direction);
894 void (*unmap_page)(struct ib_device *dev,
895 u64 addr, size_t size,
896 enum dma_data_direction direction);
897 int (*map_sg)(struct ib_device *dev,
898 struct scatterlist *sg, int nents,
899 enum dma_data_direction direction);
900 void (*unmap_sg)(struct ib_device *dev,
901 struct scatterlist *sg, int nents,
902 enum dma_data_direction direction);
903 u64 (*dma_address)(struct ib_device *dev,
904 struct scatterlist *sg);
905 unsigned int (*dma_len)(struct ib_device *dev,
906 struct scatterlist *sg);
907 void (*sync_single_for_cpu)(struct ib_device *dev,
910 enum dma_data_direction dir);
911 void (*sync_single_for_device)(struct ib_device *dev,
914 enum dma_data_direction dir);
915 void *(*alloc_coherent)(struct ib_device *dev,
919 void (*free_coherent)(struct ib_device *dev,
920 size_t size, void *cpu_addr,
927 struct device *dma_device;
929 char name[IB_DEVICE_NAME_MAX];
931 struct list_head event_handler_list;
932 spinlock_t event_handler_lock;
934 struct list_head core_list;
935 struct list_head client_data_list;
936 spinlock_t client_data_lock;
938 struct ib_cache cache;
942 int num_comp_vectors;
944 struct iw_cm_verbs *iwcm;
946 int (*query_device)(struct ib_device *device,
947 struct ib_device_attr *device_attr);
948 int (*query_port)(struct ib_device *device,
950 struct ib_port_attr *port_attr);
951 int (*query_gid)(struct ib_device *device,
952 u8 port_num, int index,
954 int (*query_pkey)(struct ib_device *device,
955 u8 port_num, u16 index, u16 *pkey);
956 int (*modify_device)(struct ib_device *device,
957 int device_modify_mask,
958 struct ib_device_modify *device_modify);
959 int (*modify_port)(struct ib_device *device,
960 u8 port_num, int port_modify_mask,
961 struct ib_port_modify *port_modify);
962 struct ib_ucontext * (*alloc_ucontext)(struct ib_device *device,
963 struct ib_udata *udata);
964 int (*dealloc_ucontext)(struct ib_ucontext *context);
965 int (*mmap)(struct ib_ucontext *context,
966 struct vm_area_struct *vma);
967 struct ib_pd * (*alloc_pd)(struct ib_device *device,
968 struct ib_ucontext *context,
969 struct ib_udata *udata);
970 int (*dealloc_pd)(struct ib_pd *pd);
971 struct ib_ah * (*create_ah)(struct ib_pd *pd,
972 struct ib_ah_attr *ah_attr);
973 int (*modify_ah)(struct ib_ah *ah,
974 struct ib_ah_attr *ah_attr);
975 int (*query_ah)(struct ib_ah *ah,
976 struct ib_ah_attr *ah_attr);
977 int (*destroy_ah)(struct ib_ah *ah);
978 struct ib_srq * (*create_srq)(struct ib_pd *pd,
979 struct ib_srq_init_attr *srq_init_attr,
980 struct ib_udata *udata);
981 int (*modify_srq)(struct ib_srq *srq,
982 struct ib_srq_attr *srq_attr,
983 enum ib_srq_attr_mask srq_attr_mask,
984 struct ib_udata *udata);
985 int (*query_srq)(struct ib_srq *srq,
986 struct ib_srq_attr *srq_attr);
987 int (*destroy_srq)(struct ib_srq *srq);
988 int (*post_srq_recv)(struct ib_srq *srq,
989 struct ib_recv_wr *recv_wr,
990 struct ib_recv_wr **bad_recv_wr);
991 struct ib_qp * (*create_qp)(struct ib_pd *pd,
992 struct ib_qp_init_attr *qp_init_attr,
993 struct ib_udata *udata);
994 int (*modify_qp)(struct ib_qp *qp,
995 struct ib_qp_attr *qp_attr,
997 struct ib_udata *udata);
998 int (*query_qp)(struct ib_qp *qp,
999 struct ib_qp_attr *qp_attr,
1001 struct ib_qp_init_attr *qp_init_attr);
1002 int (*destroy_qp)(struct ib_qp *qp);
1003 int (*post_send)(struct ib_qp *qp,
1004 struct ib_send_wr *send_wr,
1005 struct ib_send_wr **bad_send_wr);
1006 int (*post_recv)(struct ib_qp *qp,
1007 struct ib_recv_wr *recv_wr,
1008 struct ib_recv_wr **bad_recv_wr);
1009 struct ib_cq * (*create_cq)(struct ib_device *device, int cqe,
1011 struct ib_ucontext *context,
1012 struct ib_udata *udata);
1013 int (*modify_cq)(struct ib_cq *cq, u16 cq_count,
1015 int (*destroy_cq)(struct ib_cq *cq);
1016 int (*resize_cq)(struct ib_cq *cq, int cqe,
1017 struct ib_udata *udata);
1018 int (*poll_cq)(struct ib_cq *cq, int num_entries,
1020 int (*peek_cq)(struct ib_cq *cq, int wc_cnt);
1021 int (*req_notify_cq)(struct ib_cq *cq,
1022 enum ib_cq_notify_flags flags);
1023 int (*req_ncomp_notif)(struct ib_cq *cq,
1025 struct ib_mr * (*get_dma_mr)(struct ib_pd *pd,
1026 int mr_access_flags);
1027 struct ib_mr * (*reg_phys_mr)(struct ib_pd *pd,
1028 struct ib_phys_buf *phys_buf_array,
1030 int mr_access_flags,
1032 struct ib_mr * (*reg_user_mr)(struct ib_pd *pd,
1033 u64 start, u64 length,
1035 int mr_access_flags,
1036 struct ib_udata *udata);
1037 int (*query_mr)(struct ib_mr *mr,
1038 struct ib_mr_attr *mr_attr);
1039 int (*dereg_mr)(struct ib_mr *mr);
1040 struct ib_mr * (*alloc_fast_reg_mr)(struct ib_pd *pd,
1041 int max_page_list_len);
1042 struct ib_fast_reg_page_list * (*alloc_fast_reg_page_list)(struct ib_device *device,
1044 void (*free_fast_reg_page_list)(struct ib_fast_reg_page_list *page_list);
1045 int (*rereg_phys_mr)(struct ib_mr *mr,
1048 struct ib_phys_buf *phys_buf_array,
1050 int mr_access_flags,
1052 struct ib_mw * (*alloc_mw)(struct ib_pd *pd);
1053 int (*bind_mw)(struct ib_qp *qp,
1055 struct ib_mw_bind *mw_bind);
1056 int (*dealloc_mw)(struct ib_mw *mw);
1057 struct ib_fmr * (*alloc_fmr)(struct ib_pd *pd,
1058 int mr_access_flags,
1059 struct ib_fmr_attr *fmr_attr);
1060 int (*map_phys_fmr)(struct ib_fmr *fmr,
1061 u64 *page_list, int list_len,
1063 int (*unmap_fmr)(struct list_head *fmr_list);
1064 int (*dealloc_fmr)(struct ib_fmr *fmr);
1065 int (*attach_mcast)(struct ib_qp *qp,
1068 int (*detach_mcast)(struct ib_qp *qp,
1071 int (*process_mad)(struct ib_device *device,
1072 int process_mad_flags,
1074 struct ib_wc *in_wc,
1075 struct ib_grh *in_grh,
1076 struct ib_mad *in_mad,
1077 struct ib_mad *out_mad);
1079 struct ib_dma_mapping_ops *dma_ops;
1081 struct module *owner;
1083 struct kobject *ports_parent;
1084 struct list_head port_list;
1087 IB_DEV_UNINITIALIZED,
1092 u64 uverbs_cmd_mask;
1103 void (*add) (struct ib_device *);
1104 void (*remove)(struct ib_device *);
1106 struct list_head list;
1109 struct ib_device *ib_alloc_device(size_t size);
1110 void ib_dealloc_device(struct ib_device *device);
1112 int ib_register_device (struct ib_device *device);
1113 void ib_unregister_device(struct ib_device *device);
1115 int ib_register_client (struct ib_client *client);
1116 void ib_unregister_client(struct ib_client *client);
1118 void *ib_get_client_data(struct ib_device *device, struct ib_client *client);
1119 void ib_set_client_data(struct ib_device *device, struct ib_client *client,
1122 static inline int ib_copy_from_udata(void *dest, struct ib_udata *udata, size_t len)
1124 return copy_from_user(dest, udata->inbuf, len) ? -EFAULT : 0;
1127 static inline int ib_copy_to_udata(struct ib_udata *udata, void *src, size_t len)
1129 return copy_to_user(udata->outbuf, src, len) ? -EFAULT : 0;
1133 * ib_modify_qp_is_ok - Check that the supplied attribute mask
1134 * contains all required attributes and no attributes not allowed for
1135 * the given QP state transition.
1136 * @cur_state: Current QP state
1137 * @next_state: Next QP state
1139 * @mask: Mask of supplied QP attributes
1141 * This function is a helper function that a low-level driver's
1142 * modify_qp method can use to validate the consumer's input. It
1143 * checks that cur_state and next_state are valid QP states, that a
1144 * transition from cur_state to next_state is allowed by the IB spec,
1145 * and that the attribute mask supplied is allowed for the transition.
1147 int ib_modify_qp_is_ok(enum ib_qp_state cur_state, enum ib_qp_state next_state,
1148 enum ib_qp_type type, enum ib_qp_attr_mask mask);
1150 int ib_register_event_handler (struct ib_event_handler *event_handler);
1151 int ib_unregister_event_handler(struct ib_event_handler *event_handler);
1152 void ib_dispatch_event(struct ib_event *event);
1154 int ib_query_device(struct ib_device *device,
1155 struct ib_device_attr *device_attr);
1157 int ib_query_port(struct ib_device *device,
1158 u8 port_num, struct ib_port_attr *port_attr);
1160 int ib_query_gid(struct ib_device *device,
1161 u8 port_num, int index, union ib_gid *gid);
1163 int ib_query_pkey(struct ib_device *device,
1164 u8 port_num, u16 index, u16 *pkey);
1166 int ib_modify_device(struct ib_device *device,
1167 int device_modify_mask,
1168 struct ib_device_modify *device_modify);
1170 int ib_modify_port(struct ib_device *device,
1171 u8 port_num, int port_modify_mask,
1172 struct ib_port_modify *port_modify);
1174 int ib_find_gid(struct ib_device *device, union ib_gid *gid,
1175 u8 *port_num, u16 *index);
1177 int ib_find_pkey(struct ib_device *device,
1178 u8 port_num, u16 pkey, u16 *index);
1181 * ib_alloc_pd - Allocates an unused protection domain.
1182 * @device: The device on which to allocate the protection domain.
1184 * A protection domain object provides an association between QPs, shared
1185 * receive queues, address handles, memory regions, and memory windows.
1187 struct ib_pd *ib_alloc_pd(struct ib_device *device);
1190 * ib_dealloc_pd - Deallocates a protection domain.
1191 * @pd: The protection domain to deallocate.
1193 int ib_dealloc_pd(struct ib_pd *pd);
1196 * ib_create_ah - Creates an address handle for the given address vector.
1197 * @pd: The protection domain associated with the address handle.
1198 * @ah_attr: The attributes of the address vector.
1200 * The address handle is used to reference a local or global destination
1201 * in all UD QP post sends.
1203 struct ib_ah *ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
1206 * ib_init_ah_from_wc - Initializes address handle attributes from a
1208 * @device: Device on which the received message arrived.
1209 * @port_num: Port on which the received message arrived.
1210 * @wc: Work completion associated with the received message.
1211 * @grh: References the received global route header. This parameter is
1212 * ignored unless the work completion indicates that the GRH is valid.
1213 * @ah_attr: Returned attributes that can be used when creating an address
1214 * handle for replying to the message.
1216 int ib_init_ah_from_wc(struct ib_device *device, u8 port_num, struct ib_wc *wc,
1217 struct ib_grh *grh, struct ib_ah_attr *ah_attr);
1220 * ib_create_ah_from_wc - Creates an address handle associated with the
1221 * sender of the specified work completion.
1222 * @pd: The protection domain associated with the address handle.
1223 * @wc: Work completion information associated with a received message.
1224 * @grh: References the received global route header. This parameter is
1225 * ignored unless the work completion indicates that the GRH is valid.
1226 * @port_num: The outbound port number to associate with the address.
1228 * The address handle is used to reference a local or global destination
1229 * in all UD QP post sends.
1231 struct ib_ah *ib_create_ah_from_wc(struct ib_pd *pd, struct ib_wc *wc,
1232 struct ib_grh *grh, u8 port_num);
1235 * ib_modify_ah - Modifies the address vector associated with an address
1237 * @ah: The address handle to modify.
1238 * @ah_attr: The new address vector attributes to associate with the
1241 int ib_modify_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1244 * ib_query_ah - Queries the address vector associated with an address
1246 * @ah: The address handle to query.
1247 * @ah_attr: The address vector attributes associated with the address
1250 int ib_query_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1253 * ib_destroy_ah - Destroys an address handle.
1254 * @ah: The address handle to destroy.
1256 int ib_destroy_ah(struct ib_ah *ah);
1259 * ib_create_srq - Creates a SRQ associated with the specified protection
1261 * @pd: The protection domain associated with the SRQ.
1262 * @srq_init_attr: A list of initial attributes required to create the
1263 * SRQ. If SRQ creation succeeds, then the attributes are updated to
1264 * the actual capabilities of the created SRQ.
1266 * srq_attr->max_wr and srq_attr->max_sge are read the determine the
1267 * requested size of the SRQ, and set to the actual values allocated
1268 * on return. If ib_create_srq() succeeds, then max_wr and max_sge
1269 * will always be at least as large as the requested values.
1271 struct ib_srq *ib_create_srq(struct ib_pd *pd,
1272 struct ib_srq_init_attr *srq_init_attr);
1275 * ib_modify_srq - Modifies the attributes for the specified SRQ.
1276 * @srq: The SRQ to modify.
1277 * @srq_attr: On input, specifies the SRQ attributes to modify. On output,
1278 * the current values of selected SRQ attributes are returned.
1279 * @srq_attr_mask: A bit-mask used to specify which attributes of the SRQ
1280 * are being modified.
1282 * The mask may contain IB_SRQ_MAX_WR to resize the SRQ and/or
1283 * IB_SRQ_LIMIT to set the SRQ's limit and request notification when
1284 * the number of receives queued drops below the limit.
1286 int ib_modify_srq(struct ib_srq *srq,
1287 struct ib_srq_attr *srq_attr,
1288 enum ib_srq_attr_mask srq_attr_mask);
1291 * ib_query_srq - Returns the attribute list and current values for the
1293 * @srq: The SRQ to query.
1294 * @srq_attr: The attributes of the specified SRQ.
1296 int ib_query_srq(struct ib_srq *srq,
1297 struct ib_srq_attr *srq_attr);
1300 * ib_destroy_srq - Destroys the specified SRQ.
1301 * @srq: The SRQ to destroy.
1303 int ib_destroy_srq(struct ib_srq *srq);
1306 * ib_post_srq_recv - Posts a list of work requests to the specified SRQ.
1307 * @srq: The SRQ to post the work request on.
1308 * @recv_wr: A list of work requests to post on the receive queue.
1309 * @bad_recv_wr: On an immediate failure, this parameter will reference
1310 * the work request that failed to be posted on the QP.
1312 static inline int ib_post_srq_recv(struct ib_srq *srq,
1313 struct ib_recv_wr *recv_wr,
1314 struct ib_recv_wr **bad_recv_wr)
1316 return srq->device->post_srq_recv(srq, recv_wr, bad_recv_wr);
1320 * ib_create_qp - Creates a QP associated with the specified protection
1322 * @pd: The protection domain associated with the QP.
1323 * @qp_init_attr: A list of initial attributes required to create the
1324 * QP. If QP creation succeeds, then the attributes are updated to
1325 * the actual capabilities of the created QP.
1327 struct ib_qp *ib_create_qp(struct ib_pd *pd,
1328 struct ib_qp_init_attr *qp_init_attr);
1331 * ib_modify_qp - Modifies the attributes for the specified QP and then
1332 * transitions the QP to the given state.
1333 * @qp: The QP to modify.
1334 * @qp_attr: On input, specifies the QP attributes to modify. On output,
1335 * the current values of selected QP attributes are returned.
1336 * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
1337 * are being modified.
1339 int ib_modify_qp(struct ib_qp *qp,
1340 struct ib_qp_attr *qp_attr,
1344 * ib_query_qp - Returns the attribute list and current values for the
1346 * @qp: The QP to query.
1347 * @qp_attr: The attributes of the specified QP.
1348 * @qp_attr_mask: A bit-mask used to select specific attributes to query.
1349 * @qp_init_attr: Additional attributes of the selected QP.
1351 * The qp_attr_mask may be used to limit the query to gathering only the
1352 * selected attributes.
1354 int ib_query_qp(struct ib_qp *qp,
1355 struct ib_qp_attr *qp_attr,
1357 struct ib_qp_init_attr *qp_init_attr);
1360 * ib_destroy_qp - Destroys the specified QP.
1361 * @qp: The QP to destroy.
1363 int ib_destroy_qp(struct ib_qp *qp);
1366 * ib_post_send - Posts a list of work requests to the send queue of
1368 * @qp: The QP to post the work request on.
1369 * @send_wr: A list of work requests to post on the send queue.
1370 * @bad_send_wr: On an immediate failure, this parameter will reference
1371 * the work request that failed to be posted on the QP.
1373 static inline int ib_post_send(struct ib_qp *qp,
1374 struct ib_send_wr *send_wr,
1375 struct ib_send_wr **bad_send_wr)
1377 return qp->device->post_send(qp, send_wr, bad_send_wr);
1381 * ib_post_recv - Posts a list of work requests to the receive queue of
1383 * @qp: The QP to post the work request on.
1384 * @recv_wr: A list of work requests to post on the receive queue.
1385 * @bad_recv_wr: On an immediate failure, this parameter will reference
1386 * the work request that failed to be posted on the QP.
1388 static inline int ib_post_recv(struct ib_qp *qp,
1389 struct ib_recv_wr *recv_wr,
1390 struct ib_recv_wr **bad_recv_wr)
1392 return qp->device->post_recv(qp, recv_wr, bad_recv_wr);
1396 * ib_create_cq - Creates a CQ on the specified device.
1397 * @device: The device on which to create the CQ.
1398 * @comp_handler: A user-specified callback that is invoked when a
1399 * completion event occurs on the CQ.
1400 * @event_handler: A user-specified callback that is invoked when an
1401 * asynchronous event not associated with a completion occurs on the CQ.
1402 * @cq_context: Context associated with the CQ returned to the user via
1403 * the associated completion and event handlers.
1404 * @cqe: The minimum size of the CQ.
1405 * @comp_vector - Completion vector used to signal completion events.
1406 * Must be >= 0 and < context->num_comp_vectors.
1408 * Users can examine the cq structure to determine the actual CQ size.
1410 struct ib_cq *ib_create_cq(struct ib_device *device,
1411 ib_comp_handler comp_handler,
1412 void (*event_handler)(struct ib_event *, void *),
1413 void *cq_context, int cqe, int comp_vector);
1416 * ib_resize_cq - Modifies the capacity of the CQ.
1417 * @cq: The CQ to resize.
1418 * @cqe: The minimum size of the CQ.
1420 * Users can examine the cq structure to determine the actual CQ size.
1422 int ib_resize_cq(struct ib_cq *cq, int cqe);
1425 * ib_modify_cq - Modifies moderation params of the CQ
1426 * @cq: The CQ to modify.
1427 * @cq_count: number of CQEs that will trigger an event
1428 * @cq_period: max period of time in usec before triggering an event
1431 int ib_modify_cq(struct ib_cq *cq, u16 cq_count, u16 cq_period);
1434 * ib_destroy_cq - Destroys the specified CQ.
1435 * @cq: The CQ to destroy.
1437 int ib_destroy_cq(struct ib_cq *cq);
1440 * ib_poll_cq - poll a CQ for completion(s)
1441 * @cq:the CQ being polled
1442 * @num_entries:maximum number of completions to return
1443 * @wc:array of at least @num_entries &struct ib_wc where completions
1446 * Poll a CQ for (possibly multiple) completions. If the return value
1447 * is < 0, an error occurred. If the return value is >= 0, it is the
1448 * number of completions returned. If the return value is
1449 * non-negative and < num_entries, then the CQ was emptied.
1451 static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
1454 return cq->device->poll_cq(cq, num_entries, wc);
1458 * ib_peek_cq - Returns the number of unreaped completions currently
1459 * on the specified CQ.
1460 * @cq: The CQ to peek.
1461 * @wc_cnt: A minimum number of unreaped completions to check for.
1463 * If the number of unreaped completions is greater than or equal to wc_cnt,
1464 * this function returns wc_cnt, otherwise, it returns the actual number of
1465 * unreaped completions.
1467 int ib_peek_cq(struct ib_cq *cq, int wc_cnt);
1470 * ib_req_notify_cq - Request completion notification on a CQ.
1471 * @cq: The CQ to generate an event for.
1473 * Must contain exactly one of %IB_CQ_SOLICITED or %IB_CQ_NEXT_COMP
1474 * to request an event on the next solicited event or next work
1475 * completion at any type, respectively. %IB_CQ_REPORT_MISSED_EVENTS
1476 * may also be |ed in to request a hint about missed events, as
1480 * < 0 means an error occurred while requesting notification
1481 * == 0 means notification was requested successfully, and if
1482 * IB_CQ_REPORT_MISSED_EVENTS was passed in, then no events
1483 * were missed and it is safe to wait for another event. In
1484 * this case is it guaranteed that any work completions added
1485 * to the CQ since the last CQ poll will trigger a completion
1486 * notification event.
1487 * > 0 is only returned if IB_CQ_REPORT_MISSED_EVENTS was passed
1488 * in. It means that the consumer must poll the CQ again to
1489 * make sure it is empty to avoid missing an event because of a
1490 * race between requesting notification and an entry being
1491 * added to the CQ. This return value means it is possible
1492 * (but not guaranteed) that a work completion has been added
1493 * to the CQ since the last poll without triggering a
1494 * completion notification event.
1496 static inline int ib_req_notify_cq(struct ib_cq *cq,
1497 enum ib_cq_notify_flags flags)
1499 return cq->device->req_notify_cq(cq, flags);
1503 * ib_req_ncomp_notif - Request completion notification when there are
1504 * at least the specified number of unreaped completions on the CQ.
1505 * @cq: The CQ to generate an event for.
1506 * @wc_cnt: The number of unreaped completions that should be on the
1507 * CQ before an event is generated.
1509 static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
1511 return cq->device->req_ncomp_notif ?
1512 cq->device->req_ncomp_notif(cq, wc_cnt) :
1517 * ib_get_dma_mr - Returns a memory region for system memory that is
1519 * @pd: The protection domain associated with the memory region.
1520 * @mr_access_flags: Specifies the memory access rights.
1522 * Note that the ib_dma_*() functions defined below must be used
1523 * to create/destroy addresses used with the Lkey or Rkey returned
1524 * by ib_get_dma_mr().
1526 struct ib_mr *ib_get_dma_mr(struct ib_pd *pd, int mr_access_flags);
1529 * ib_dma_mapping_error - check a DMA addr for error
1530 * @dev: The device for which the dma_addr was created
1531 * @dma_addr: The DMA address to check
1533 static inline int ib_dma_mapping_error(struct ib_device *dev, u64 dma_addr)
1536 return dev->dma_ops->mapping_error(dev, dma_addr);
1537 return dma_mapping_error(dma_addr);
1541 * ib_dma_map_single - Map a kernel virtual address to DMA address
1542 * @dev: The device for which the dma_addr is to be created
1543 * @cpu_addr: The kernel virtual address
1544 * @size: The size of the region in bytes
1545 * @direction: The direction of the DMA
1547 static inline u64 ib_dma_map_single(struct ib_device *dev,
1548 void *cpu_addr, size_t size,
1549 enum dma_data_direction direction)
1552 return dev->dma_ops->map_single(dev, cpu_addr, size, direction);
1553 return dma_map_single(dev->dma_device, cpu_addr, size, direction);
1557 * ib_dma_unmap_single - Destroy a mapping created by ib_dma_map_single()
1558 * @dev: The device for which the DMA address was created
1559 * @addr: The DMA address
1560 * @size: The size of the region in bytes
1561 * @direction: The direction of the DMA
1563 static inline void ib_dma_unmap_single(struct ib_device *dev,
1564 u64 addr, size_t size,
1565 enum dma_data_direction direction)
1568 dev->dma_ops->unmap_single(dev, addr, size, direction);
1570 dma_unmap_single(dev->dma_device, addr, size, direction);
1573 static inline u64 ib_dma_map_single_attrs(struct ib_device *dev,
1574 void *cpu_addr, size_t size,
1575 enum dma_data_direction direction,
1576 struct dma_attrs *attrs)
1578 return dma_map_single_attrs(dev->dma_device, cpu_addr, size,
1582 static inline void ib_dma_unmap_single_attrs(struct ib_device *dev,
1583 u64 addr, size_t size,
1584 enum dma_data_direction direction,
1585 struct dma_attrs *attrs)
1587 return dma_unmap_single_attrs(dev->dma_device, addr, size,
1592 * ib_dma_map_page - Map a physical page to DMA address
1593 * @dev: The device for which the dma_addr is to be created
1594 * @page: The page to be mapped
1595 * @offset: The offset within the page
1596 * @size: The size of the region in bytes
1597 * @direction: The direction of the DMA
1599 static inline u64 ib_dma_map_page(struct ib_device *dev,
1601 unsigned long offset,
1603 enum dma_data_direction direction)
1606 return dev->dma_ops->map_page(dev, page, offset, size, direction);
1607 return dma_map_page(dev->dma_device, page, offset, size, direction);
1611 * ib_dma_unmap_page - Destroy a mapping created by ib_dma_map_page()
1612 * @dev: The device for which the DMA address was created
1613 * @addr: The DMA address
1614 * @size: The size of the region in bytes
1615 * @direction: The direction of the DMA
1617 static inline void ib_dma_unmap_page(struct ib_device *dev,
1618 u64 addr, size_t size,
1619 enum dma_data_direction direction)
1622 dev->dma_ops->unmap_page(dev, addr, size, direction);
1624 dma_unmap_page(dev->dma_device, addr, size, direction);
1628 * ib_dma_map_sg - Map a scatter/gather list to DMA addresses
1629 * @dev: The device for which the DMA addresses are to be created
1630 * @sg: The array of scatter/gather entries
1631 * @nents: The number of scatter/gather entries
1632 * @direction: The direction of the DMA
1634 static inline int ib_dma_map_sg(struct ib_device *dev,
1635 struct scatterlist *sg, int nents,
1636 enum dma_data_direction direction)
1639 return dev->dma_ops->map_sg(dev, sg, nents, direction);
1640 return dma_map_sg(dev->dma_device, sg, nents, direction);
1644 * ib_dma_unmap_sg - Unmap a scatter/gather list of DMA addresses
1645 * @dev: The device for which the DMA addresses were created
1646 * @sg: The array of scatter/gather entries
1647 * @nents: The number of scatter/gather entries
1648 * @direction: The direction of the DMA
1650 static inline void ib_dma_unmap_sg(struct ib_device *dev,
1651 struct scatterlist *sg, int nents,
1652 enum dma_data_direction direction)
1655 dev->dma_ops->unmap_sg(dev, sg, nents, direction);
1657 dma_unmap_sg(dev->dma_device, sg, nents, direction);
1660 static inline int ib_dma_map_sg_attrs(struct ib_device *dev,
1661 struct scatterlist *sg, int nents,
1662 enum dma_data_direction direction,
1663 struct dma_attrs *attrs)
1665 return dma_map_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
1668 static inline void ib_dma_unmap_sg_attrs(struct ib_device *dev,
1669 struct scatterlist *sg, int nents,
1670 enum dma_data_direction direction,
1671 struct dma_attrs *attrs)
1673 dma_unmap_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
1676 * ib_sg_dma_address - Return the DMA address from a scatter/gather entry
1677 * @dev: The device for which the DMA addresses were created
1678 * @sg: The scatter/gather entry
1680 static inline u64 ib_sg_dma_address(struct ib_device *dev,
1681 struct scatterlist *sg)
1684 return dev->dma_ops->dma_address(dev, sg);
1685 return sg_dma_address(sg);
1689 * ib_sg_dma_len - Return the DMA length from a scatter/gather entry
1690 * @dev: The device for which the DMA addresses were created
1691 * @sg: The scatter/gather entry
1693 static inline unsigned int ib_sg_dma_len(struct ib_device *dev,
1694 struct scatterlist *sg)
1697 return dev->dma_ops->dma_len(dev, sg);
1698 return sg_dma_len(sg);
1702 * ib_dma_sync_single_for_cpu - Prepare DMA region to be accessed by CPU
1703 * @dev: The device for which the DMA address was created
1704 * @addr: The DMA address
1705 * @size: The size of the region in bytes
1706 * @dir: The direction of the DMA
1708 static inline void ib_dma_sync_single_for_cpu(struct ib_device *dev,
1711 enum dma_data_direction dir)
1714 dev->dma_ops->sync_single_for_cpu(dev, addr, size, dir);
1716 dma_sync_single_for_cpu(dev->dma_device, addr, size, dir);
1720 * ib_dma_sync_single_for_device - Prepare DMA region to be accessed by device
1721 * @dev: The device for which the DMA address was created
1722 * @addr: The DMA address
1723 * @size: The size of the region in bytes
1724 * @dir: The direction of the DMA
1726 static inline void ib_dma_sync_single_for_device(struct ib_device *dev,
1729 enum dma_data_direction dir)
1732 dev->dma_ops->sync_single_for_device(dev, addr, size, dir);
1734 dma_sync_single_for_device(dev->dma_device, addr, size, dir);
1738 * ib_dma_alloc_coherent - Allocate memory and map it for DMA
1739 * @dev: The device for which the DMA address is requested
1740 * @size: The size of the region to allocate in bytes
1741 * @dma_handle: A pointer for returning the DMA address of the region
1742 * @flag: memory allocator flags
1744 static inline void *ib_dma_alloc_coherent(struct ib_device *dev,
1750 return dev->dma_ops->alloc_coherent(dev, size, dma_handle, flag);
1755 ret = dma_alloc_coherent(dev->dma_device, size, &handle, flag);
1756 *dma_handle = handle;
1762 * ib_dma_free_coherent - Free memory allocated by ib_dma_alloc_coherent()
1763 * @dev: The device for which the DMA addresses were allocated
1764 * @size: The size of the region
1765 * @cpu_addr: the address returned by ib_dma_alloc_coherent()
1766 * @dma_handle: the DMA address returned by ib_dma_alloc_coherent()
1768 static inline void ib_dma_free_coherent(struct ib_device *dev,
1769 size_t size, void *cpu_addr,
1773 dev->dma_ops->free_coherent(dev, size, cpu_addr, dma_handle);
1775 dma_free_coherent(dev->dma_device, size, cpu_addr, dma_handle);
1779 * ib_reg_phys_mr - Prepares a virtually addressed memory region for use
1781 * @pd: The protection domain associated assigned to the registered region.
1782 * @phys_buf_array: Specifies a list of physical buffers to use in the
1784 * @num_phys_buf: Specifies the size of the phys_buf_array.
1785 * @mr_access_flags: Specifies the memory access rights.
1786 * @iova_start: The offset of the region's starting I/O virtual address.
1788 struct ib_mr *ib_reg_phys_mr(struct ib_pd *pd,
1789 struct ib_phys_buf *phys_buf_array,
1791 int mr_access_flags,
1795 * ib_rereg_phys_mr - Modifies the attributes of an existing memory region.
1796 * Conceptually, this call performs the functions deregister memory region
1797 * followed by register physical memory region. Where possible,
1798 * resources are reused instead of deallocated and reallocated.
1799 * @mr: The memory region to modify.
1800 * @mr_rereg_mask: A bit-mask used to indicate which of the following
1801 * properties of the memory region are being modified.
1802 * @pd: If %IB_MR_REREG_PD is set in mr_rereg_mask, this field specifies
1803 * the new protection domain to associated with the memory region,
1804 * otherwise, this parameter is ignored.
1805 * @phys_buf_array: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1806 * field specifies a list of physical buffers to use in the new
1807 * translation, otherwise, this parameter is ignored.
1808 * @num_phys_buf: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1809 * field specifies the size of the phys_buf_array, otherwise, this
1810 * parameter is ignored.
1811 * @mr_access_flags: If %IB_MR_REREG_ACCESS is set in mr_rereg_mask, this
1812 * field specifies the new memory access rights, otherwise, this
1813 * parameter is ignored.
1814 * @iova_start: The offset of the region's starting I/O virtual address.
1816 int ib_rereg_phys_mr(struct ib_mr *mr,
1819 struct ib_phys_buf *phys_buf_array,
1821 int mr_access_flags,
1825 * ib_query_mr - Retrieves information about a specific memory region.
1826 * @mr: The memory region to retrieve information about.
1827 * @mr_attr: The attributes of the specified memory region.
1829 int ib_query_mr(struct ib_mr *mr, struct ib_mr_attr *mr_attr);
1832 * ib_dereg_mr - Deregisters a memory region and removes it from the
1833 * HCA translation table.
1834 * @mr: The memory region to deregister.
1836 int ib_dereg_mr(struct ib_mr *mr);
1839 * ib_alloc_fast_reg_mr - Allocates memory region usable with the
1840 * IB_WR_FAST_REG_MR send work request.
1841 * @pd: The protection domain associated with the region.
1842 * @max_page_list_len: requested max physical buffer list length to be
1843 * used with fast register work requests for this MR.
1845 struct ib_mr *ib_alloc_fast_reg_mr(struct ib_pd *pd, int max_page_list_len);
1848 * ib_alloc_fast_reg_page_list - Allocates a page list array
1849 * @device - ib device pointer.
1850 * @page_list_len - size of the page list array to be allocated.
1852 * This allocates and returns a struct ib_fast_reg_page_list * and a
1853 * page_list array that is at least page_list_len in size. The actual
1854 * size is returned in max_page_list_len. The caller is responsible
1855 * for initializing the contents of the page_list array before posting
1856 * a send work request with the IB_WC_FAST_REG_MR opcode.
1858 * The page_list array entries must be translated using one of the
1859 * ib_dma_*() functions just like the addresses passed to
1860 * ib_map_phys_fmr(). Once the ib_post_send() is issued, the struct
1861 * ib_fast_reg_page_list must not be modified by the caller until the
1862 * IB_WC_FAST_REG_MR work request completes.
1864 struct ib_fast_reg_page_list *ib_alloc_fast_reg_page_list(
1865 struct ib_device *device, int page_list_len);
1868 * ib_free_fast_reg_page_list - Deallocates a previously allocated
1870 * @page_list - struct ib_fast_reg_page_list pointer to be deallocated.
1872 void ib_free_fast_reg_page_list(struct ib_fast_reg_page_list *page_list);
1875 * ib_update_fast_reg_key - updates the key portion of the fast_reg MR
1877 * @mr - struct ib_mr pointer to be updated.
1878 * @newkey - new key to be used.
1880 static inline void ib_update_fast_reg_key(struct ib_mr *mr, u8 newkey)
1882 mr->lkey = (mr->lkey & 0xffffff00) | newkey;
1883 mr->rkey = (mr->rkey & 0xffffff00) | newkey;
1887 * ib_alloc_mw - Allocates a memory window.
1888 * @pd: The protection domain associated with the memory window.
1890 struct ib_mw *ib_alloc_mw(struct ib_pd *pd);
1893 * ib_bind_mw - Posts a work request to the send queue of the specified
1894 * QP, which binds the memory window to the given address range and
1895 * remote access attributes.
1896 * @qp: QP to post the bind work request on.
1897 * @mw: The memory window to bind.
1898 * @mw_bind: Specifies information about the memory window, including
1899 * its address range, remote access rights, and associated memory region.
1901 static inline int ib_bind_mw(struct ib_qp *qp,
1903 struct ib_mw_bind *mw_bind)
1905 /* XXX reference counting in corresponding MR? */
1906 return mw->device->bind_mw ?
1907 mw->device->bind_mw(qp, mw, mw_bind) :
1912 * ib_dealloc_mw - Deallocates a memory window.
1913 * @mw: The memory window to deallocate.
1915 int ib_dealloc_mw(struct ib_mw *mw);
1918 * ib_alloc_fmr - Allocates a unmapped fast memory region.
1919 * @pd: The protection domain associated with the unmapped region.
1920 * @mr_access_flags: Specifies the memory access rights.
1921 * @fmr_attr: Attributes of the unmapped region.
1923 * A fast memory region must be mapped before it can be used as part of
1926 struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
1927 int mr_access_flags,
1928 struct ib_fmr_attr *fmr_attr);
1931 * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
1932 * @fmr: The fast memory region to associate with the pages.
1933 * @page_list: An array of physical pages to map to the fast memory region.
1934 * @list_len: The number of pages in page_list.
1935 * @iova: The I/O virtual address to use with the mapped region.
1937 static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
1938 u64 *page_list, int list_len,
1941 return fmr->device->map_phys_fmr(fmr, page_list, list_len, iova);
1945 * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
1946 * @fmr_list: A linked list of fast memory regions to unmap.
1948 int ib_unmap_fmr(struct list_head *fmr_list);
1951 * ib_dealloc_fmr - Deallocates a fast memory region.
1952 * @fmr: The fast memory region to deallocate.
1954 int ib_dealloc_fmr(struct ib_fmr *fmr);
1957 * ib_attach_mcast - Attaches the specified QP to a multicast group.
1958 * @qp: QP to attach to the multicast group. The QP must be type
1960 * @gid: Multicast group GID.
1961 * @lid: Multicast group LID in host byte order.
1963 * In order to send and receive multicast packets, subnet
1964 * administration must have created the multicast group and configured
1965 * the fabric appropriately. The port associated with the specified
1966 * QP must also be a member of the multicast group.
1968 int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
1971 * ib_detach_mcast - Detaches the specified QP from a multicast group.
1972 * @qp: QP to detach from the multicast group.
1973 * @gid: Multicast group GID.
1974 * @lid: Multicast group LID in host byte order.
1976 int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
1978 #endif /* IB_VERBS_H */