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_LOCAL_DMA_LKEY
= (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),
107 IB_DEVICE_BLOCK_MULTICAST_LOOPBACK
= (1<<22),
116 struct ib_device_attr
{
118 __be64 sys_image_guid
;
126 int device_cap_flags
;
136 int max_qp_init_rd_atom
;
137 int max_ee_init_rd_atom
;
138 enum ib_atomic_cap atomic_cap
;
139 enum ib_atomic_cap masked_atomic_cap
;
146 int max_mcast_qp_attach
;
147 int max_total_mcast_qp_attach
;
154 unsigned int max_fast_reg_page_list_len
;
156 u8 local_ca_ack_delay
;
167 static inline int ib_mtu_enum_to_int(enum ib_mtu mtu
)
170 case IB_MTU_256
: return 256;
171 case IB_MTU_512
: return 512;
172 case IB_MTU_1024
: return 1024;
173 case IB_MTU_2048
: return 2048;
174 case IB_MTU_4096
: return 4096;
185 IB_PORT_ACTIVE_DEFER
= 5
188 enum ib_port_cap_flags
{
190 IB_PORT_NOTICE_SUP
= 1 << 2,
191 IB_PORT_TRAP_SUP
= 1 << 3,
192 IB_PORT_OPT_IPD_SUP
= 1 << 4,
193 IB_PORT_AUTO_MIGR_SUP
= 1 << 5,
194 IB_PORT_SL_MAP_SUP
= 1 << 6,
195 IB_PORT_MKEY_NVRAM
= 1 << 7,
196 IB_PORT_PKEY_NVRAM
= 1 << 8,
197 IB_PORT_LED_INFO_SUP
= 1 << 9,
198 IB_PORT_SM_DISABLED
= 1 << 10,
199 IB_PORT_SYS_IMAGE_GUID_SUP
= 1 << 11,
200 IB_PORT_PKEY_SW_EXT_PORT_TRAP_SUP
= 1 << 12,
201 IB_PORT_CM_SUP
= 1 << 16,
202 IB_PORT_SNMP_TUNNEL_SUP
= 1 << 17,
203 IB_PORT_REINIT_SUP
= 1 << 18,
204 IB_PORT_DEVICE_MGMT_SUP
= 1 << 19,
205 IB_PORT_VENDOR_CLASS_SUP
= 1 << 20,
206 IB_PORT_DR_NOTICE_SUP
= 1 << 21,
207 IB_PORT_CAP_MASK_NOTICE_SUP
= 1 << 22,
208 IB_PORT_BOOT_MGMT_SUP
= 1 << 23,
209 IB_PORT_LINK_LATENCY_SUP
= 1 << 24,
210 IB_PORT_CLIENT_REG_SUP
= 1 << 25
220 static inline int ib_width_enum_to_int(enum ib_port_width width
)
223 case IB_WIDTH_1X
: return 1;
224 case IB_WIDTH_4X
: return 4;
225 case IB_WIDTH_8X
: return 8;
226 case IB_WIDTH_12X
: return 12;
231 struct ib_protocol_stats
{
235 struct iw_protocol_stats
{
238 u64 ipInTooBigErrors
;
241 u64 ipInUnknownProtos
;
242 u64 ipInTruncatedPkts
;
245 u64 ipOutForwDatagrams
;
277 union rdma_protocol_stats
{
278 struct ib_protocol_stats ib
;
279 struct iw_protocol_stats iw
;
282 struct ib_port_attr
{
283 enum ib_port_state state
;
285 enum ib_mtu active_mtu
;
304 enum ib_device_modify_flags
{
305 IB_DEVICE_MODIFY_SYS_IMAGE_GUID
= 1 << 0,
306 IB_DEVICE_MODIFY_NODE_DESC
= 1 << 1
309 struct ib_device_modify
{
314 enum ib_port_modify_flags
{
315 IB_PORT_SHUTDOWN
= 1,
316 IB_PORT_INIT_TYPE
= (1<<2),
317 IB_PORT_RESET_QKEY_CNTR
= (1<<3)
320 struct ib_port_modify
{
321 u32 set_port_cap_mask
;
322 u32 clr_port_cap_mask
;
330 IB_EVENT_QP_ACCESS_ERR
,
334 IB_EVENT_PATH_MIG_ERR
,
335 IB_EVENT_DEVICE_FATAL
,
336 IB_EVENT_PORT_ACTIVE
,
339 IB_EVENT_PKEY_CHANGE
,
342 IB_EVENT_SRQ_LIMIT_REACHED
,
343 IB_EVENT_QP_LAST_WQE_REACHED
,
344 IB_EVENT_CLIENT_REREGISTER
348 struct ib_device
*device
;
355 enum ib_event_type event
;
358 struct ib_event_handler
{
359 struct ib_device
*device
;
360 void (*handler
)(struct ib_event_handler
*, struct ib_event
*);
361 struct list_head list
;
364 #define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler) \
366 (_ptr)->device = _device; \
367 (_ptr)->handler = _handler; \
368 INIT_LIST_HEAD(&(_ptr)->list); \
371 struct ib_global_route
{
380 __be32 version_tclass_flow
;
389 IB_MULTICAST_QPN
= 0xffffff
392 #define IB_LID_PERMISSIVE cpu_to_be16(0xFFFF)
399 IB_RATE_PORT_CURRENT
= 0,
400 IB_RATE_2_5_GBPS
= 2,
408 IB_RATE_120_GBPS
= 10
412 * ib_rate_to_mult - Convert the IB rate enum to a multiple of the
413 * base rate of 2.5 Gbit/sec. For example, IB_RATE_5_GBPS will be
414 * converted to 2, since 5 Gbit/sec is 2 * 2.5 Gbit/sec.
415 * @rate: rate to convert.
417 int ib_rate_to_mult(enum ib_rate rate
) __attribute_const__
;
420 * mult_to_ib_rate - Convert a multiple of 2.5 Gbit/sec to an IB rate
422 * @mult: multiple to convert.
424 enum ib_rate
mult_to_ib_rate(int mult
) __attribute_const__
;
427 struct ib_global_route grh
;
440 IB_WC_LOC_EEC_OP_ERR
,
445 IB_WC_LOC_ACCESS_ERR
,
446 IB_WC_REM_INV_REQ_ERR
,
447 IB_WC_REM_ACCESS_ERR
,
450 IB_WC_RNR_RETRY_EXC_ERR
,
451 IB_WC_LOC_RDD_VIOL_ERR
,
452 IB_WC_REM_INV_RD_REQ_ERR
,
455 IB_WC_INV_EEC_STATE_ERR
,
457 IB_WC_RESP_TIMEOUT_ERR
,
471 IB_WC_MASKED_COMP_SWAP
,
472 IB_WC_MASKED_FETCH_ADD
,
474 * Set value of IB_WC_RECV so consumers can test if a completion is a
475 * receive by testing (opcode & IB_WC_RECV).
478 IB_WC_RECV_RDMA_WITH_IMM
483 IB_WC_WITH_IMM
= (1<<1),
484 IB_WC_WITH_INVALIDATE
= (1<<2),
489 enum ib_wc_status status
;
490 enum ib_wc_opcode opcode
;
504 u8 port_num
; /* valid only for DR SMPs on switches */
508 enum ib_cq_notify_flags
{
509 IB_CQ_SOLICITED
= 1 << 0,
510 IB_CQ_NEXT_COMP
= 1 << 1,
511 IB_CQ_SOLICITED_MASK
= IB_CQ_SOLICITED
| IB_CQ_NEXT_COMP
,
512 IB_CQ_REPORT_MISSED_EVENTS
= 1 << 2,
515 enum ib_srq_attr_mask
{
516 IB_SRQ_MAX_WR
= 1 << 0,
517 IB_SRQ_LIMIT
= 1 << 1,
526 struct ib_srq_init_attr
{
527 void (*event_handler
)(struct ib_event
*, void *);
529 struct ib_srq_attr attr
;
547 * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
548 * here (and in that order) since the MAD layer uses them as
549 * indices into a 2-entry table.
561 enum ib_qp_create_flags
{
562 IB_QP_CREATE_IPOIB_UD_LSO
= 1 << 0,
563 IB_QP_CREATE_BLOCK_MULTICAST_LOOPBACK
= 1 << 1,
566 struct ib_qp_init_attr
{
567 void (*event_handler
)(struct ib_event
*, void *);
569 struct ib_cq
*send_cq
;
570 struct ib_cq
*recv_cq
;
572 struct ib_qp_cap cap
;
573 enum ib_sig_type sq_sig_type
;
574 enum ib_qp_type qp_type
;
575 enum ib_qp_create_flags create_flags
;
576 u8 port_num
; /* special QP types only */
579 enum ib_rnr_timeout
{
580 IB_RNR_TIMER_655_36
= 0,
581 IB_RNR_TIMER_000_01
= 1,
582 IB_RNR_TIMER_000_02
= 2,
583 IB_RNR_TIMER_000_03
= 3,
584 IB_RNR_TIMER_000_04
= 4,
585 IB_RNR_TIMER_000_06
= 5,
586 IB_RNR_TIMER_000_08
= 6,
587 IB_RNR_TIMER_000_12
= 7,
588 IB_RNR_TIMER_000_16
= 8,
589 IB_RNR_TIMER_000_24
= 9,
590 IB_RNR_TIMER_000_32
= 10,
591 IB_RNR_TIMER_000_48
= 11,
592 IB_RNR_TIMER_000_64
= 12,
593 IB_RNR_TIMER_000_96
= 13,
594 IB_RNR_TIMER_001_28
= 14,
595 IB_RNR_TIMER_001_92
= 15,
596 IB_RNR_TIMER_002_56
= 16,
597 IB_RNR_TIMER_003_84
= 17,
598 IB_RNR_TIMER_005_12
= 18,
599 IB_RNR_TIMER_007_68
= 19,
600 IB_RNR_TIMER_010_24
= 20,
601 IB_RNR_TIMER_015_36
= 21,
602 IB_RNR_TIMER_020_48
= 22,
603 IB_RNR_TIMER_030_72
= 23,
604 IB_RNR_TIMER_040_96
= 24,
605 IB_RNR_TIMER_061_44
= 25,
606 IB_RNR_TIMER_081_92
= 26,
607 IB_RNR_TIMER_122_88
= 27,
608 IB_RNR_TIMER_163_84
= 28,
609 IB_RNR_TIMER_245_76
= 29,
610 IB_RNR_TIMER_327_68
= 30,
611 IB_RNR_TIMER_491_52
= 31
614 enum ib_qp_attr_mask
{
616 IB_QP_CUR_STATE
= (1<<1),
617 IB_QP_EN_SQD_ASYNC_NOTIFY
= (1<<2),
618 IB_QP_ACCESS_FLAGS
= (1<<3),
619 IB_QP_PKEY_INDEX
= (1<<4),
623 IB_QP_PATH_MTU
= (1<<8),
624 IB_QP_TIMEOUT
= (1<<9),
625 IB_QP_RETRY_CNT
= (1<<10),
626 IB_QP_RNR_RETRY
= (1<<11),
627 IB_QP_RQ_PSN
= (1<<12),
628 IB_QP_MAX_QP_RD_ATOMIC
= (1<<13),
629 IB_QP_ALT_PATH
= (1<<14),
630 IB_QP_MIN_RNR_TIMER
= (1<<15),
631 IB_QP_SQ_PSN
= (1<<16),
632 IB_QP_MAX_DEST_RD_ATOMIC
= (1<<17),
633 IB_QP_PATH_MIG_STATE
= (1<<18),
635 IB_QP_DEST_QPN
= (1<<20)
655 enum ib_qp_state qp_state
;
656 enum ib_qp_state cur_qp_state
;
657 enum ib_mtu path_mtu
;
658 enum ib_mig_state path_mig_state
;
664 struct ib_qp_cap cap
;
665 struct ib_ah_attr ah_attr
;
666 struct ib_ah_attr alt_ah_attr
;
669 u8 en_sqd_async_notify
;
672 u8 max_dest_rd_atomic
;
684 IB_WR_RDMA_WRITE_WITH_IMM
,
688 IB_WR_ATOMIC_CMP_AND_SWP
,
689 IB_WR_ATOMIC_FETCH_AND_ADD
,
692 IB_WR_RDMA_READ_WITH_INV
,
695 IB_WR_MASKED_ATOMIC_CMP_AND_SWP
,
696 IB_WR_MASKED_ATOMIC_FETCH_AND_ADD
,
701 IB_SEND_SIGNALED
= (1<<1),
702 IB_SEND_SOLICITED
= (1<<2),
703 IB_SEND_INLINE
= (1<<3),
704 IB_SEND_IP_CSUM
= (1<<4)
713 struct ib_fast_reg_page_list
{
714 struct ib_device
*device
;
716 unsigned int max_page_list_len
;
720 struct ib_send_wr
*next
;
722 struct ib_sge
*sg_list
;
724 enum ib_wr_opcode opcode
;
739 u64 compare_add_mask
;
750 u16 pkey_index
; /* valid for GSI only */
751 u8 port_num
; /* valid for DR SMPs on switch only */
755 struct ib_fast_reg_page_list
*page_list
;
756 unsigned int page_shift
;
757 unsigned int page_list_len
;
766 struct ib_recv_wr
*next
;
768 struct ib_sge
*sg_list
;
772 enum ib_access_flags
{
773 IB_ACCESS_LOCAL_WRITE
= 1,
774 IB_ACCESS_REMOTE_WRITE
= (1<<1),
775 IB_ACCESS_REMOTE_READ
= (1<<2),
776 IB_ACCESS_REMOTE_ATOMIC
= (1<<3),
777 IB_ACCESS_MW_BIND
= (1<<4)
787 u64 device_virt_addr
;
794 enum ib_mr_rereg_flags
{
795 IB_MR_REREG_TRANS
= 1,
796 IB_MR_REREG_PD
= (1<<1),
797 IB_MR_REREG_ACCESS
= (1<<2)
816 struct ib_device
*device
;
817 struct list_head pd_list
;
818 struct list_head mr_list
;
819 struct list_head mw_list
;
820 struct list_head cq_list
;
821 struct list_head qp_list
;
822 struct list_head srq_list
;
823 struct list_head ah_list
;
828 u64 user_handle
; /* handle given to us by userspace */
829 struct ib_ucontext
*context
; /* associated user context */
830 void *object
; /* containing object */
831 struct list_head list
; /* link to context's list */
832 int id
; /* index into kernel idr */
834 struct rw_semaphore mutex
; /* protects .live */
846 struct ib_device
*device
;
847 struct ib_uobject
*uobject
;
848 atomic_t usecnt
; /* count all resources */
852 struct ib_device
*device
;
854 struct ib_uobject
*uobject
;
857 typedef void (*ib_comp_handler
)(struct ib_cq
*cq
, void *cq_context
);
860 struct ib_device
*device
;
861 struct ib_uobject
*uobject
;
862 ib_comp_handler comp_handler
;
863 void (*event_handler
)(struct ib_event
*, void *);
866 atomic_t usecnt
; /* count number of work queues */
870 struct ib_device
*device
;
872 struct ib_uobject
*uobject
;
873 void (*event_handler
)(struct ib_event
*, void *);
879 struct ib_device
*device
;
881 struct ib_cq
*send_cq
;
882 struct ib_cq
*recv_cq
;
884 struct ib_uobject
*uobject
;
885 void (*event_handler
)(struct ib_event
*, void *);
888 enum ib_qp_type qp_type
;
892 struct ib_device
*device
;
894 struct ib_uobject
*uobject
;
897 atomic_t usecnt
; /* count number of MWs */
901 struct ib_device
*device
;
903 struct ib_uobject
*uobject
;
908 struct ib_device
*device
;
910 struct list_head list
;
918 enum ib_process_mad_flags
{
919 IB_MAD_IGNORE_MKEY
= 1,
920 IB_MAD_IGNORE_BKEY
= 2,
921 IB_MAD_IGNORE_ALL
= IB_MAD_IGNORE_MKEY
| IB_MAD_IGNORE_BKEY
925 IB_MAD_RESULT_FAILURE
= 0, /* (!SUCCESS is the important flag) */
926 IB_MAD_RESULT_SUCCESS
= 1 << 0, /* MAD was successfully processed */
927 IB_MAD_RESULT_REPLY
= 1 << 1, /* Reply packet needs to be sent */
928 IB_MAD_RESULT_CONSUMED
= 1 << 2 /* Packet consumed: stop processing */
931 #define IB_DEVICE_NAME_MAX 64
935 struct ib_event_handler event_handler
;
936 struct ib_pkey_cache
**pkey_cache
;
937 struct ib_gid_cache
**gid_cache
;
941 struct ib_dma_mapping_ops
{
942 int (*mapping_error
)(struct ib_device
*dev
,
944 u64 (*map_single
)(struct ib_device
*dev
,
945 void *ptr
, size_t size
,
946 enum dma_data_direction direction
);
947 void (*unmap_single
)(struct ib_device
*dev
,
948 u64 addr
, size_t size
,
949 enum dma_data_direction direction
);
950 u64 (*map_page
)(struct ib_device
*dev
,
951 struct page
*page
, unsigned long offset
,
953 enum dma_data_direction direction
);
954 void (*unmap_page
)(struct ib_device
*dev
,
955 u64 addr
, size_t size
,
956 enum dma_data_direction direction
);
957 int (*map_sg
)(struct ib_device
*dev
,
958 struct scatterlist
*sg
, int nents
,
959 enum dma_data_direction direction
);
960 void (*unmap_sg
)(struct ib_device
*dev
,
961 struct scatterlist
*sg
, int nents
,
962 enum dma_data_direction direction
);
963 u64 (*dma_address
)(struct ib_device
*dev
,
964 struct scatterlist
*sg
);
965 unsigned int (*dma_len
)(struct ib_device
*dev
,
966 struct scatterlist
*sg
);
967 void (*sync_single_for_cpu
)(struct ib_device
*dev
,
970 enum dma_data_direction dir
);
971 void (*sync_single_for_device
)(struct ib_device
*dev
,
974 enum dma_data_direction dir
);
975 void *(*alloc_coherent
)(struct ib_device
*dev
,
979 void (*free_coherent
)(struct ib_device
*dev
,
980 size_t size
, void *cpu_addr
,
987 struct device
*dma_device
;
989 char name
[IB_DEVICE_NAME_MAX
];
991 struct list_head event_handler_list
;
992 spinlock_t event_handler_lock
;
994 spinlock_t client_data_lock
;
995 struct list_head core_list
;
996 struct list_head client_data_list
;
998 struct ib_cache cache
;
1002 int num_comp_vectors
;
1004 struct iw_cm_verbs
*iwcm
;
1006 int (*get_protocol_stats
)(struct ib_device
*device
,
1007 union rdma_protocol_stats
*stats
);
1008 int (*query_device
)(struct ib_device
*device
,
1009 struct ib_device_attr
*device_attr
);
1010 int (*query_port
)(struct ib_device
*device
,
1012 struct ib_port_attr
*port_attr
);
1013 int (*query_gid
)(struct ib_device
*device
,
1014 u8 port_num
, int index
,
1016 int (*query_pkey
)(struct ib_device
*device
,
1017 u8 port_num
, u16 index
, u16
*pkey
);
1018 int (*modify_device
)(struct ib_device
*device
,
1019 int device_modify_mask
,
1020 struct ib_device_modify
*device_modify
);
1021 int (*modify_port
)(struct ib_device
*device
,
1022 u8 port_num
, int port_modify_mask
,
1023 struct ib_port_modify
*port_modify
);
1024 struct ib_ucontext
* (*alloc_ucontext
)(struct ib_device
*device
,
1025 struct ib_udata
*udata
);
1026 int (*dealloc_ucontext
)(struct ib_ucontext
*context
);
1027 int (*mmap
)(struct ib_ucontext
*context
,
1028 struct vm_area_struct
*vma
);
1029 struct ib_pd
* (*alloc_pd
)(struct ib_device
*device
,
1030 struct ib_ucontext
*context
,
1031 struct ib_udata
*udata
);
1032 int (*dealloc_pd
)(struct ib_pd
*pd
);
1033 struct ib_ah
* (*create_ah
)(struct ib_pd
*pd
,
1034 struct ib_ah_attr
*ah_attr
);
1035 int (*modify_ah
)(struct ib_ah
*ah
,
1036 struct ib_ah_attr
*ah_attr
);
1037 int (*query_ah
)(struct ib_ah
*ah
,
1038 struct ib_ah_attr
*ah_attr
);
1039 int (*destroy_ah
)(struct ib_ah
*ah
);
1040 struct ib_srq
* (*create_srq
)(struct ib_pd
*pd
,
1041 struct ib_srq_init_attr
*srq_init_attr
,
1042 struct ib_udata
*udata
);
1043 int (*modify_srq
)(struct ib_srq
*srq
,
1044 struct ib_srq_attr
*srq_attr
,
1045 enum ib_srq_attr_mask srq_attr_mask
,
1046 struct ib_udata
*udata
);
1047 int (*query_srq
)(struct ib_srq
*srq
,
1048 struct ib_srq_attr
*srq_attr
);
1049 int (*destroy_srq
)(struct ib_srq
*srq
);
1050 int (*post_srq_recv
)(struct ib_srq
*srq
,
1051 struct ib_recv_wr
*recv_wr
,
1052 struct ib_recv_wr
**bad_recv_wr
);
1053 struct ib_qp
* (*create_qp
)(struct ib_pd
*pd
,
1054 struct ib_qp_init_attr
*qp_init_attr
,
1055 struct ib_udata
*udata
);
1056 int (*modify_qp
)(struct ib_qp
*qp
,
1057 struct ib_qp_attr
*qp_attr
,
1059 struct ib_udata
*udata
);
1060 int (*query_qp
)(struct ib_qp
*qp
,
1061 struct ib_qp_attr
*qp_attr
,
1063 struct ib_qp_init_attr
*qp_init_attr
);
1064 int (*destroy_qp
)(struct ib_qp
*qp
);
1065 int (*post_send
)(struct ib_qp
*qp
,
1066 struct ib_send_wr
*send_wr
,
1067 struct ib_send_wr
**bad_send_wr
);
1068 int (*post_recv
)(struct ib_qp
*qp
,
1069 struct ib_recv_wr
*recv_wr
,
1070 struct ib_recv_wr
**bad_recv_wr
);
1071 struct ib_cq
* (*create_cq
)(struct ib_device
*device
, int cqe
,
1073 struct ib_ucontext
*context
,
1074 struct ib_udata
*udata
);
1075 int (*modify_cq
)(struct ib_cq
*cq
, u16 cq_count
,
1077 int (*destroy_cq
)(struct ib_cq
*cq
);
1078 int (*resize_cq
)(struct ib_cq
*cq
, int cqe
,
1079 struct ib_udata
*udata
);
1080 int (*poll_cq
)(struct ib_cq
*cq
, int num_entries
,
1082 int (*peek_cq
)(struct ib_cq
*cq
, int wc_cnt
);
1083 int (*req_notify_cq
)(struct ib_cq
*cq
,
1084 enum ib_cq_notify_flags flags
);
1085 int (*req_ncomp_notif
)(struct ib_cq
*cq
,
1087 struct ib_mr
* (*get_dma_mr
)(struct ib_pd
*pd
,
1088 int mr_access_flags
);
1089 struct ib_mr
* (*reg_phys_mr
)(struct ib_pd
*pd
,
1090 struct ib_phys_buf
*phys_buf_array
,
1092 int mr_access_flags
,
1094 struct ib_mr
* (*reg_user_mr
)(struct ib_pd
*pd
,
1095 u64 start
, u64 length
,
1097 int mr_access_flags
,
1098 struct ib_udata
*udata
);
1099 int (*query_mr
)(struct ib_mr
*mr
,
1100 struct ib_mr_attr
*mr_attr
);
1101 int (*dereg_mr
)(struct ib_mr
*mr
);
1102 struct ib_mr
* (*alloc_fast_reg_mr
)(struct ib_pd
*pd
,
1103 int max_page_list_len
);
1104 struct ib_fast_reg_page_list
* (*alloc_fast_reg_page_list
)(struct ib_device
*device
,
1106 void (*free_fast_reg_page_list
)(struct ib_fast_reg_page_list
*page_list
);
1107 int (*rereg_phys_mr
)(struct ib_mr
*mr
,
1110 struct ib_phys_buf
*phys_buf_array
,
1112 int mr_access_flags
,
1114 struct ib_mw
* (*alloc_mw
)(struct ib_pd
*pd
);
1115 int (*bind_mw
)(struct ib_qp
*qp
,
1117 struct ib_mw_bind
*mw_bind
);
1118 int (*dealloc_mw
)(struct ib_mw
*mw
);
1119 struct ib_fmr
* (*alloc_fmr
)(struct ib_pd
*pd
,
1120 int mr_access_flags
,
1121 struct ib_fmr_attr
*fmr_attr
);
1122 int (*map_phys_fmr
)(struct ib_fmr
*fmr
,
1123 u64
*page_list
, int list_len
,
1125 int (*unmap_fmr
)(struct list_head
*fmr_list
);
1126 int (*dealloc_fmr
)(struct ib_fmr
*fmr
);
1127 int (*attach_mcast
)(struct ib_qp
*qp
,
1130 int (*detach_mcast
)(struct ib_qp
*qp
,
1133 int (*process_mad
)(struct ib_device
*device
,
1134 int process_mad_flags
,
1136 struct ib_wc
*in_wc
,
1137 struct ib_grh
*in_grh
,
1138 struct ib_mad
*in_mad
,
1139 struct ib_mad
*out_mad
);
1141 struct ib_dma_mapping_ops
*dma_ops
;
1143 struct module
*owner
;
1145 struct kobject
*ports_parent
;
1146 struct list_head port_list
;
1149 IB_DEV_UNINITIALIZED
,
1155 u64 uverbs_cmd_mask
;
1166 void (*add
) (struct ib_device
*);
1167 void (*remove
)(struct ib_device
*);
1169 struct list_head list
;
1172 struct ib_device
*ib_alloc_device(size_t size
);
1173 void ib_dealloc_device(struct ib_device
*device
);
1175 int ib_register_device (struct ib_device
*device
);
1176 void ib_unregister_device(struct ib_device
*device
);
1178 int ib_register_client (struct ib_client
*client
);
1179 void ib_unregister_client(struct ib_client
*client
);
1181 void *ib_get_client_data(struct ib_device
*device
, struct ib_client
*client
);
1182 void ib_set_client_data(struct ib_device
*device
, struct ib_client
*client
,
1185 static inline int ib_copy_from_udata(void *dest
, struct ib_udata
*udata
, size_t len
)
1187 return copy_from_user(dest
, udata
->inbuf
, len
) ? -EFAULT
: 0;
1190 static inline int ib_copy_to_udata(struct ib_udata
*udata
, void *src
, size_t len
)
1192 return copy_to_user(udata
->outbuf
, src
, len
) ? -EFAULT
: 0;
1196 * ib_modify_qp_is_ok - Check that the supplied attribute mask
1197 * contains all required attributes and no attributes not allowed for
1198 * the given QP state transition.
1199 * @cur_state: Current QP state
1200 * @next_state: Next QP state
1202 * @mask: Mask of supplied QP attributes
1204 * This function is a helper function that a low-level driver's
1205 * modify_qp method can use to validate the consumer's input. It
1206 * checks that cur_state and next_state are valid QP states, that a
1207 * transition from cur_state to next_state is allowed by the IB spec,
1208 * and that the attribute mask supplied is allowed for the transition.
1210 int ib_modify_qp_is_ok(enum ib_qp_state cur_state
, enum ib_qp_state next_state
,
1211 enum ib_qp_type type
, enum ib_qp_attr_mask mask
);
1213 int ib_register_event_handler (struct ib_event_handler
*event_handler
);
1214 int ib_unregister_event_handler(struct ib_event_handler
*event_handler
);
1215 void ib_dispatch_event(struct ib_event
*event
);
1217 int ib_query_device(struct ib_device
*device
,
1218 struct ib_device_attr
*device_attr
);
1220 int ib_query_port(struct ib_device
*device
,
1221 u8 port_num
, struct ib_port_attr
*port_attr
);
1223 int ib_query_gid(struct ib_device
*device
,
1224 u8 port_num
, int index
, union ib_gid
*gid
);
1226 int ib_query_pkey(struct ib_device
*device
,
1227 u8 port_num
, u16 index
, u16
*pkey
);
1229 int ib_modify_device(struct ib_device
*device
,
1230 int device_modify_mask
,
1231 struct ib_device_modify
*device_modify
);
1233 int ib_modify_port(struct ib_device
*device
,
1234 u8 port_num
, int port_modify_mask
,
1235 struct ib_port_modify
*port_modify
);
1237 int ib_find_gid(struct ib_device
*device
, union ib_gid
*gid
,
1238 u8
*port_num
, u16
*index
);
1240 int ib_find_pkey(struct ib_device
*device
,
1241 u8 port_num
, u16 pkey
, u16
*index
);
1244 * ib_alloc_pd - Allocates an unused protection domain.
1245 * @device: The device on which to allocate the protection domain.
1247 * A protection domain object provides an association between QPs, shared
1248 * receive queues, address handles, memory regions, and memory windows.
1250 struct ib_pd
*ib_alloc_pd(struct ib_device
*device
);
1253 * ib_dealloc_pd - Deallocates a protection domain.
1254 * @pd: The protection domain to deallocate.
1256 int ib_dealloc_pd(struct ib_pd
*pd
);
1259 * ib_create_ah - Creates an address handle for the given address vector.
1260 * @pd: The protection domain associated with the address handle.
1261 * @ah_attr: The attributes of the address vector.
1263 * The address handle is used to reference a local or global destination
1264 * in all UD QP post sends.
1266 struct ib_ah
*ib_create_ah(struct ib_pd
*pd
, struct ib_ah_attr
*ah_attr
);
1269 * ib_init_ah_from_wc - Initializes address handle attributes from a
1271 * @device: Device on which the received message arrived.
1272 * @port_num: Port on which the received message arrived.
1273 * @wc: Work completion associated with the received message.
1274 * @grh: References the received global route header. This parameter is
1275 * ignored unless the work completion indicates that the GRH is valid.
1276 * @ah_attr: Returned attributes that can be used when creating an address
1277 * handle for replying to the message.
1279 int ib_init_ah_from_wc(struct ib_device
*device
, u8 port_num
, struct ib_wc
*wc
,
1280 struct ib_grh
*grh
, struct ib_ah_attr
*ah_attr
);
1283 * ib_create_ah_from_wc - Creates an address handle associated with the
1284 * sender of the specified work completion.
1285 * @pd: The protection domain associated with the address handle.
1286 * @wc: Work completion information associated with a received message.
1287 * @grh: References the received global route header. This parameter is
1288 * ignored unless the work completion indicates that the GRH is valid.
1289 * @port_num: The outbound port number to associate with the address.
1291 * The address handle is used to reference a local or global destination
1292 * in all UD QP post sends.
1294 struct ib_ah
*ib_create_ah_from_wc(struct ib_pd
*pd
, struct ib_wc
*wc
,
1295 struct ib_grh
*grh
, u8 port_num
);
1298 * ib_modify_ah - Modifies the address vector associated with an address
1300 * @ah: The address handle to modify.
1301 * @ah_attr: The new address vector attributes to associate with the
1304 int ib_modify_ah(struct ib_ah
*ah
, struct ib_ah_attr
*ah_attr
);
1307 * ib_query_ah - Queries the address vector associated with an address
1309 * @ah: The address handle to query.
1310 * @ah_attr: The address vector attributes associated with the address
1313 int ib_query_ah(struct ib_ah
*ah
, struct ib_ah_attr
*ah_attr
);
1316 * ib_destroy_ah - Destroys an address handle.
1317 * @ah: The address handle to destroy.
1319 int ib_destroy_ah(struct ib_ah
*ah
);
1322 * ib_create_srq - Creates a SRQ associated with the specified protection
1324 * @pd: The protection domain associated with the SRQ.
1325 * @srq_init_attr: A list of initial attributes required to create the
1326 * SRQ. If SRQ creation succeeds, then the attributes are updated to
1327 * the actual capabilities of the created SRQ.
1329 * srq_attr->max_wr and srq_attr->max_sge are read the determine the
1330 * requested size of the SRQ, and set to the actual values allocated
1331 * on return. If ib_create_srq() succeeds, then max_wr and max_sge
1332 * will always be at least as large as the requested values.
1334 struct ib_srq
*ib_create_srq(struct ib_pd
*pd
,
1335 struct ib_srq_init_attr
*srq_init_attr
);
1338 * ib_modify_srq - Modifies the attributes for the specified SRQ.
1339 * @srq: The SRQ to modify.
1340 * @srq_attr: On input, specifies the SRQ attributes to modify. On output,
1341 * the current values of selected SRQ attributes are returned.
1342 * @srq_attr_mask: A bit-mask used to specify which attributes of the SRQ
1343 * are being modified.
1345 * The mask may contain IB_SRQ_MAX_WR to resize the SRQ and/or
1346 * IB_SRQ_LIMIT to set the SRQ's limit and request notification when
1347 * the number of receives queued drops below the limit.
1349 int ib_modify_srq(struct ib_srq
*srq
,
1350 struct ib_srq_attr
*srq_attr
,
1351 enum ib_srq_attr_mask srq_attr_mask
);
1354 * ib_query_srq - Returns the attribute list and current values for the
1356 * @srq: The SRQ to query.
1357 * @srq_attr: The attributes of the specified SRQ.
1359 int ib_query_srq(struct ib_srq
*srq
,
1360 struct ib_srq_attr
*srq_attr
);
1363 * ib_destroy_srq - Destroys the specified SRQ.
1364 * @srq: The SRQ to destroy.
1366 int ib_destroy_srq(struct ib_srq
*srq
);
1369 * ib_post_srq_recv - Posts a list of work requests to the specified SRQ.
1370 * @srq: The SRQ to post the work request on.
1371 * @recv_wr: A list of work requests to post on the receive queue.
1372 * @bad_recv_wr: On an immediate failure, this parameter will reference
1373 * the work request that failed to be posted on the QP.
1375 static inline int ib_post_srq_recv(struct ib_srq
*srq
,
1376 struct ib_recv_wr
*recv_wr
,
1377 struct ib_recv_wr
**bad_recv_wr
)
1379 return srq
->device
->post_srq_recv(srq
, recv_wr
, bad_recv_wr
);
1383 * ib_create_qp - Creates a QP associated with the specified protection
1385 * @pd: The protection domain associated with the QP.
1386 * @qp_init_attr: A list of initial attributes required to create the
1387 * QP. If QP creation succeeds, then the attributes are updated to
1388 * the actual capabilities of the created QP.
1390 struct ib_qp
*ib_create_qp(struct ib_pd
*pd
,
1391 struct ib_qp_init_attr
*qp_init_attr
);
1394 * ib_modify_qp - Modifies the attributes for the specified QP and then
1395 * transitions the QP to the given state.
1396 * @qp: The QP to modify.
1397 * @qp_attr: On input, specifies the QP attributes to modify. On output,
1398 * the current values of selected QP attributes are returned.
1399 * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
1400 * are being modified.
1402 int ib_modify_qp(struct ib_qp
*qp
,
1403 struct ib_qp_attr
*qp_attr
,
1407 * ib_query_qp - Returns the attribute list and current values for the
1409 * @qp: The QP to query.
1410 * @qp_attr: The attributes of the specified QP.
1411 * @qp_attr_mask: A bit-mask used to select specific attributes to query.
1412 * @qp_init_attr: Additional attributes of the selected QP.
1414 * The qp_attr_mask may be used to limit the query to gathering only the
1415 * selected attributes.
1417 int ib_query_qp(struct ib_qp
*qp
,
1418 struct ib_qp_attr
*qp_attr
,
1420 struct ib_qp_init_attr
*qp_init_attr
);
1423 * ib_destroy_qp - Destroys the specified QP.
1424 * @qp: The QP to destroy.
1426 int ib_destroy_qp(struct ib_qp
*qp
);
1429 * ib_post_send - Posts a list of work requests to the send queue of
1431 * @qp: The QP to post the work request on.
1432 * @send_wr: A list of work requests to post on the send queue.
1433 * @bad_send_wr: On an immediate failure, this parameter will reference
1434 * the work request that failed to be posted on the QP.
1436 * While IBA Vol. 1 section 11.4.1.1 specifies that if an immediate
1437 * error is returned, the QP state shall not be affected,
1438 * ib_post_send() will return an immediate error after queueing any
1439 * earlier work requests in the list.
1441 static inline int ib_post_send(struct ib_qp
*qp
,
1442 struct ib_send_wr
*send_wr
,
1443 struct ib_send_wr
**bad_send_wr
)
1445 return qp
->device
->post_send(qp
, send_wr
, bad_send_wr
);
1449 * ib_post_recv - Posts a list of work requests to the receive queue of
1451 * @qp: The QP to post the work request on.
1452 * @recv_wr: A list of work requests to post on the receive queue.
1453 * @bad_recv_wr: On an immediate failure, this parameter will reference
1454 * the work request that failed to be posted on the QP.
1456 static inline int ib_post_recv(struct ib_qp
*qp
,
1457 struct ib_recv_wr
*recv_wr
,
1458 struct ib_recv_wr
**bad_recv_wr
)
1460 return qp
->device
->post_recv(qp
, recv_wr
, bad_recv_wr
);
1464 * ib_create_cq - Creates a CQ on the specified device.
1465 * @device: The device on which to create the CQ.
1466 * @comp_handler: A user-specified callback that is invoked when a
1467 * completion event occurs on the CQ.
1468 * @event_handler: A user-specified callback that is invoked when an
1469 * asynchronous event not associated with a completion occurs on the CQ.
1470 * @cq_context: Context associated with the CQ returned to the user via
1471 * the associated completion and event handlers.
1472 * @cqe: The minimum size of the CQ.
1473 * @comp_vector - Completion vector used to signal completion events.
1474 * Must be >= 0 and < context->num_comp_vectors.
1476 * Users can examine the cq structure to determine the actual CQ size.
1478 struct ib_cq
*ib_create_cq(struct ib_device
*device
,
1479 ib_comp_handler comp_handler
,
1480 void (*event_handler
)(struct ib_event
*, void *),
1481 void *cq_context
, int cqe
, int comp_vector
);
1484 * ib_resize_cq - Modifies the capacity of the CQ.
1485 * @cq: The CQ to resize.
1486 * @cqe: The minimum size of the CQ.
1488 * Users can examine the cq structure to determine the actual CQ size.
1490 int ib_resize_cq(struct ib_cq
*cq
, int cqe
);
1493 * ib_modify_cq - Modifies moderation params of the CQ
1494 * @cq: The CQ to modify.
1495 * @cq_count: number of CQEs that will trigger an event
1496 * @cq_period: max period of time in usec before triggering an event
1499 int ib_modify_cq(struct ib_cq
*cq
, u16 cq_count
, u16 cq_period
);
1502 * ib_destroy_cq - Destroys the specified CQ.
1503 * @cq: The CQ to destroy.
1505 int ib_destroy_cq(struct ib_cq
*cq
);
1508 * ib_poll_cq - poll a CQ for completion(s)
1509 * @cq:the CQ being polled
1510 * @num_entries:maximum number of completions to return
1511 * @wc:array of at least @num_entries &struct ib_wc where completions
1514 * Poll a CQ for (possibly multiple) completions. If the return value
1515 * is < 0, an error occurred. If the return value is >= 0, it is the
1516 * number of completions returned. If the return value is
1517 * non-negative and < num_entries, then the CQ was emptied.
1519 static inline int ib_poll_cq(struct ib_cq
*cq
, int num_entries
,
1522 return cq
->device
->poll_cq(cq
, num_entries
, wc
);
1526 * ib_peek_cq - Returns the number of unreaped completions currently
1527 * on the specified CQ.
1528 * @cq: The CQ to peek.
1529 * @wc_cnt: A minimum number of unreaped completions to check for.
1531 * If the number of unreaped completions is greater than or equal to wc_cnt,
1532 * this function returns wc_cnt, otherwise, it returns the actual number of
1533 * unreaped completions.
1535 int ib_peek_cq(struct ib_cq
*cq
, int wc_cnt
);
1538 * ib_req_notify_cq - Request completion notification on a CQ.
1539 * @cq: The CQ to generate an event for.
1541 * Must contain exactly one of %IB_CQ_SOLICITED or %IB_CQ_NEXT_COMP
1542 * to request an event on the next solicited event or next work
1543 * completion at any type, respectively. %IB_CQ_REPORT_MISSED_EVENTS
1544 * may also be |ed in to request a hint about missed events, as
1548 * < 0 means an error occurred while requesting notification
1549 * == 0 means notification was requested successfully, and if
1550 * IB_CQ_REPORT_MISSED_EVENTS was passed in, then no events
1551 * were missed and it is safe to wait for another event. In
1552 * this case is it guaranteed that any work completions added
1553 * to the CQ since the last CQ poll will trigger a completion
1554 * notification event.
1555 * > 0 is only returned if IB_CQ_REPORT_MISSED_EVENTS was passed
1556 * in. It means that the consumer must poll the CQ again to
1557 * make sure it is empty to avoid missing an event because of a
1558 * race between requesting notification and an entry being
1559 * added to the CQ. This return value means it is possible
1560 * (but not guaranteed) that a work completion has been added
1561 * to the CQ since the last poll without triggering a
1562 * completion notification event.
1564 static inline int ib_req_notify_cq(struct ib_cq
*cq
,
1565 enum ib_cq_notify_flags flags
)
1567 return cq
->device
->req_notify_cq(cq
, flags
);
1571 * ib_req_ncomp_notif - Request completion notification when there are
1572 * at least the specified number of unreaped completions on the CQ.
1573 * @cq: The CQ to generate an event for.
1574 * @wc_cnt: The number of unreaped completions that should be on the
1575 * CQ before an event is generated.
1577 static inline int ib_req_ncomp_notif(struct ib_cq
*cq
, int wc_cnt
)
1579 return cq
->device
->req_ncomp_notif
?
1580 cq
->device
->req_ncomp_notif(cq
, wc_cnt
) :
1585 * ib_get_dma_mr - Returns a memory region for system memory that is
1587 * @pd: The protection domain associated with the memory region.
1588 * @mr_access_flags: Specifies the memory access rights.
1590 * Note that the ib_dma_*() functions defined below must be used
1591 * to create/destroy addresses used with the Lkey or Rkey returned
1592 * by ib_get_dma_mr().
1594 struct ib_mr
*ib_get_dma_mr(struct ib_pd
*pd
, int mr_access_flags
);
1597 * ib_dma_mapping_error - check a DMA addr for error
1598 * @dev: The device for which the dma_addr was created
1599 * @dma_addr: The DMA address to check
1601 static inline int ib_dma_mapping_error(struct ib_device
*dev
, u64 dma_addr
)
1604 return dev
->dma_ops
->mapping_error(dev
, dma_addr
);
1605 return dma_mapping_error(dev
->dma_device
, dma_addr
);
1609 * ib_dma_map_single - Map a kernel virtual address to DMA address
1610 * @dev: The device for which the dma_addr is to be created
1611 * @cpu_addr: The kernel virtual address
1612 * @size: The size of the region in bytes
1613 * @direction: The direction of the DMA
1615 static inline u64
ib_dma_map_single(struct ib_device
*dev
,
1616 void *cpu_addr
, size_t size
,
1617 enum dma_data_direction direction
)
1620 return dev
->dma_ops
->map_single(dev
, cpu_addr
, size
, direction
);
1621 return dma_map_single(dev
->dma_device
, cpu_addr
, size
, direction
);
1625 * ib_dma_unmap_single - Destroy a mapping created by ib_dma_map_single()
1626 * @dev: The device for which the DMA address was created
1627 * @addr: The DMA address
1628 * @size: The size of the region in bytes
1629 * @direction: The direction of the DMA
1631 static inline void ib_dma_unmap_single(struct ib_device
*dev
,
1632 u64 addr
, size_t size
,
1633 enum dma_data_direction direction
)
1636 dev
->dma_ops
->unmap_single(dev
, addr
, size
, direction
);
1638 dma_unmap_single(dev
->dma_device
, addr
, size
, direction
);
1641 static inline u64
ib_dma_map_single_attrs(struct ib_device
*dev
,
1642 void *cpu_addr
, size_t size
,
1643 enum dma_data_direction direction
,
1644 struct dma_attrs
*attrs
)
1646 return dma_map_single_attrs(dev
->dma_device
, cpu_addr
, size
,
1650 static inline void ib_dma_unmap_single_attrs(struct ib_device
*dev
,
1651 u64 addr
, size_t size
,
1652 enum dma_data_direction direction
,
1653 struct dma_attrs
*attrs
)
1655 return dma_unmap_single_attrs(dev
->dma_device
, addr
, size
,
1660 * ib_dma_map_page - Map a physical page to DMA address
1661 * @dev: The device for which the dma_addr is to be created
1662 * @page: The page to be mapped
1663 * @offset: The offset within the page
1664 * @size: The size of the region in bytes
1665 * @direction: The direction of the DMA
1667 static inline u64
ib_dma_map_page(struct ib_device
*dev
,
1669 unsigned long offset
,
1671 enum dma_data_direction direction
)
1674 return dev
->dma_ops
->map_page(dev
, page
, offset
, size
, direction
);
1675 return dma_map_page(dev
->dma_device
, page
, offset
, size
, direction
);
1679 * ib_dma_unmap_page - Destroy a mapping created by ib_dma_map_page()
1680 * @dev: The device for which the DMA address was created
1681 * @addr: The DMA address
1682 * @size: The size of the region in bytes
1683 * @direction: The direction of the DMA
1685 static inline void ib_dma_unmap_page(struct ib_device
*dev
,
1686 u64 addr
, size_t size
,
1687 enum dma_data_direction direction
)
1690 dev
->dma_ops
->unmap_page(dev
, addr
, size
, direction
);
1692 dma_unmap_page(dev
->dma_device
, addr
, size
, direction
);
1696 * ib_dma_map_sg - Map a scatter/gather list to DMA addresses
1697 * @dev: The device for which the DMA addresses are to be created
1698 * @sg: The array of scatter/gather entries
1699 * @nents: The number of scatter/gather entries
1700 * @direction: The direction of the DMA
1702 static inline int ib_dma_map_sg(struct ib_device
*dev
,
1703 struct scatterlist
*sg
, int nents
,
1704 enum dma_data_direction direction
)
1707 return dev
->dma_ops
->map_sg(dev
, sg
, nents
, direction
);
1708 return dma_map_sg(dev
->dma_device
, sg
, nents
, direction
);
1712 * ib_dma_unmap_sg - Unmap a scatter/gather list of DMA addresses
1713 * @dev: The device for which the DMA addresses were created
1714 * @sg: The array of scatter/gather entries
1715 * @nents: The number of scatter/gather entries
1716 * @direction: The direction of the DMA
1718 static inline void ib_dma_unmap_sg(struct ib_device
*dev
,
1719 struct scatterlist
*sg
, int nents
,
1720 enum dma_data_direction direction
)
1723 dev
->dma_ops
->unmap_sg(dev
, sg
, nents
, direction
);
1725 dma_unmap_sg(dev
->dma_device
, sg
, nents
, direction
);
1728 static inline int ib_dma_map_sg_attrs(struct ib_device
*dev
,
1729 struct scatterlist
*sg
, int nents
,
1730 enum dma_data_direction direction
,
1731 struct dma_attrs
*attrs
)
1733 return dma_map_sg_attrs(dev
->dma_device
, sg
, nents
, direction
, attrs
);
1736 static inline void ib_dma_unmap_sg_attrs(struct ib_device
*dev
,
1737 struct scatterlist
*sg
, int nents
,
1738 enum dma_data_direction direction
,
1739 struct dma_attrs
*attrs
)
1741 dma_unmap_sg_attrs(dev
->dma_device
, sg
, nents
, direction
, attrs
);
1744 * ib_sg_dma_address - Return the DMA address from a scatter/gather entry
1745 * @dev: The device for which the DMA addresses were created
1746 * @sg: The scatter/gather entry
1748 static inline u64
ib_sg_dma_address(struct ib_device
*dev
,
1749 struct scatterlist
*sg
)
1752 return dev
->dma_ops
->dma_address(dev
, sg
);
1753 return sg_dma_address(sg
);
1757 * ib_sg_dma_len - Return the DMA length from a scatter/gather entry
1758 * @dev: The device for which the DMA addresses were created
1759 * @sg: The scatter/gather entry
1761 static inline unsigned int ib_sg_dma_len(struct ib_device
*dev
,
1762 struct scatterlist
*sg
)
1765 return dev
->dma_ops
->dma_len(dev
, sg
);
1766 return sg_dma_len(sg
);
1770 * ib_dma_sync_single_for_cpu - Prepare DMA region to be accessed by CPU
1771 * @dev: The device for which the DMA address was created
1772 * @addr: The DMA address
1773 * @size: The size of the region in bytes
1774 * @dir: The direction of the DMA
1776 static inline void ib_dma_sync_single_for_cpu(struct ib_device
*dev
,
1779 enum dma_data_direction dir
)
1782 dev
->dma_ops
->sync_single_for_cpu(dev
, addr
, size
, dir
);
1784 dma_sync_single_for_cpu(dev
->dma_device
, addr
, size
, dir
);
1788 * ib_dma_sync_single_for_device - Prepare DMA region to be accessed by device
1789 * @dev: The device for which the DMA address was created
1790 * @addr: The DMA address
1791 * @size: The size of the region in bytes
1792 * @dir: The direction of the DMA
1794 static inline void ib_dma_sync_single_for_device(struct ib_device
*dev
,
1797 enum dma_data_direction dir
)
1800 dev
->dma_ops
->sync_single_for_device(dev
, addr
, size
, dir
);
1802 dma_sync_single_for_device(dev
->dma_device
, addr
, size
, dir
);
1806 * ib_dma_alloc_coherent - Allocate memory and map it for DMA
1807 * @dev: The device for which the DMA address is requested
1808 * @size: The size of the region to allocate in bytes
1809 * @dma_handle: A pointer for returning the DMA address of the region
1810 * @flag: memory allocator flags
1812 static inline void *ib_dma_alloc_coherent(struct ib_device
*dev
,
1818 return dev
->dma_ops
->alloc_coherent(dev
, size
, dma_handle
, flag
);
1823 ret
= dma_alloc_coherent(dev
->dma_device
, size
, &handle
, flag
);
1824 *dma_handle
= handle
;
1830 * ib_dma_free_coherent - Free memory allocated by ib_dma_alloc_coherent()
1831 * @dev: The device for which the DMA addresses were allocated
1832 * @size: The size of the region
1833 * @cpu_addr: the address returned by ib_dma_alloc_coherent()
1834 * @dma_handle: the DMA address returned by ib_dma_alloc_coherent()
1836 static inline void ib_dma_free_coherent(struct ib_device
*dev
,
1837 size_t size
, void *cpu_addr
,
1841 dev
->dma_ops
->free_coherent(dev
, size
, cpu_addr
, dma_handle
);
1843 dma_free_coherent(dev
->dma_device
, size
, cpu_addr
, dma_handle
);
1847 * ib_reg_phys_mr - Prepares a virtually addressed memory region for use
1849 * @pd: The protection domain associated assigned to the registered region.
1850 * @phys_buf_array: Specifies a list of physical buffers to use in the
1852 * @num_phys_buf: Specifies the size of the phys_buf_array.
1853 * @mr_access_flags: Specifies the memory access rights.
1854 * @iova_start: The offset of the region's starting I/O virtual address.
1856 struct ib_mr
*ib_reg_phys_mr(struct ib_pd
*pd
,
1857 struct ib_phys_buf
*phys_buf_array
,
1859 int mr_access_flags
,
1863 * ib_rereg_phys_mr - Modifies the attributes of an existing memory region.
1864 * Conceptually, this call performs the functions deregister memory region
1865 * followed by register physical memory region. Where possible,
1866 * resources are reused instead of deallocated and reallocated.
1867 * @mr: The memory region to modify.
1868 * @mr_rereg_mask: A bit-mask used to indicate which of the following
1869 * properties of the memory region are being modified.
1870 * @pd: If %IB_MR_REREG_PD is set in mr_rereg_mask, this field specifies
1871 * the new protection domain to associated with the memory region,
1872 * otherwise, this parameter is ignored.
1873 * @phys_buf_array: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1874 * field specifies a list of physical buffers to use in the new
1875 * translation, otherwise, this parameter is ignored.
1876 * @num_phys_buf: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1877 * field specifies the size of the phys_buf_array, otherwise, this
1878 * parameter is ignored.
1879 * @mr_access_flags: If %IB_MR_REREG_ACCESS is set in mr_rereg_mask, this
1880 * field specifies the new memory access rights, otherwise, this
1881 * parameter is ignored.
1882 * @iova_start: The offset of the region's starting I/O virtual address.
1884 int ib_rereg_phys_mr(struct ib_mr
*mr
,
1887 struct ib_phys_buf
*phys_buf_array
,
1889 int mr_access_flags
,
1893 * ib_query_mr - Retrieves information about a specific memory region.
1894 * @mr: The memory region to retrieve information about.
1895 * @mr_attr: The attributes of the specified memory region.
1897 int ib_query_mr(struct ib_mr
*mr
, struct ib_mr_attr
*mr_attr
);
1900 * ib_dereg_mr - Deregisters a memory region and removes it from the
1901 * HCA translation table.
1902 * @mr: The memory region to deregister.
1904 int ib_dereg_mr(struct ib_mr
*mr
);
1907 * ib_alloc_fast_reg_mr - Allocates memory region usable with the
1908 * IB_WR_FAST_REG_MR send work request.
1909 * @pd: The protection domain associated with the region.
1910 * @max_page_list_len: requested max physical buffer list length to be
1911 * used with fast register work requests for this MR.
1913 struct ib_mr
*ib_alloc_fast_reg_mr(struct ib_pd
*pd
, int max_page_list_len
);
1916 * ib_alloc_fast_reg_page_list - Allocates a page list array
1917 * @device - ib device pointer.
1918 * @page_list_len - size of the page list array to be allocated.
1920 * This allocates and returns a struct ib_fast_reg_page_list * and a
1921 * page_list array that is at least page_list_len in size. The actual
1922 * size is returned in max_page_list_len. The caller is responsible
1923 * for initializing the contents of the page_list array before posting
1924 * a send work request with the IB_WC_FAST_REG_MR opcode.
1926 * The page_list array entries must be translated using one of the
1927 * ib_dma_*() functions just like the addresses passed to
1928 * ib_map_phys_fmr(). Once the ib_post_send() is issued, the struct
1929 * ib_fast_reg_page_list must not be modified by the caller until the
1930 * IB_WC_FAST_REG_MR work request completes.
1932 struct ib_fast_reg_page_list
*ib_alloc_fast_reg_page_list(
1933 struct ib_device
*device
, int page_list_len
);
1936 * ib_free_fast_reg_page_list - Deallocates a previously allocated
1938 * @page_list - struct ib_fast_reg_page_list pointer to be deallocated.
1940 void ib_free_fast_reg_page_list(struct ib_fast_reg_page_list
*page_list
);
1943 * ib_update_fast_reg_key - updates the key portion of the fast_reg MR
1945 * @mr - struct ib_mr pointer to be updated.
1946 * @newkey - new key to be used.
1948 static inline void ib_update_fast_reg_key(struct ib_mr
*mr
, u8 newkey
)
1950 mr
->lkey
= (mr
->lkey
& 0xffffff00) | newkey
;
1951 mr
->rkey
= (mr
->rkey
& 0xffffff00) | newkey
;
1955 * ib_alloc_mw - Allocates a memory window.
1956 * @pd: The protection domain associated with the memory window.
1958 struct ib_mw
*ib_alloc_mw(struct ib_pd
*pd
);
1961 * ib_bind_mw - Posts a work request to the send queue of the specified
1962 * QP, which binds the memory window to the given address range and
1963 * remote access attributes.
1964 * @qp: QP to post the bind work request on.
1965 * @mw: The memory window to bind.
1966 * @mw_bind: Specifies information about the memory window, including
1967 * its address range, remote access rights, and associated memory region.
1969 static inline int ib_bind_mw(struct ib_qp
*qp
,
1971 struct ib_mw_bind
*mw_bind
)
1973 /* XXX reference counting in corresponding MR? */
1974 return mw
->device
->bind_mw
?
1975 mw
->device
->bind_mw(qp
, mw
, mw_bind
) :
1980 * ib_dealloc_mw - Deallocates a memory window.
1981 * @mw: The memory window to deallocate.
1983 int ib_dealloc_mw(struct ib_mw
*mw
);
1986 * ib_alloc_fmr - Allocates a unmapped fast memory region.
1987 * @pd: The protection domain associated with the unmapped region.
1988 * @mr_access_flags: Specifies the memory access rights.
1989 * @fmr_attr: Attributes of the unmapped region.
1991 * A fast memory region must be mapped before it can be used as part of
1994 struct ib_fmr
*ib_alloc_fmr(struct ib_pd
*pd
,
1995 int mr_access_flags
,
1996 struct ib_fmr_attr
*fmr_attr
);
1999 * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
2000 * @fmr: The fast memory region to associate with the pages.
2001 * @page_list: An array of physical pages to map to the fast memory region.
2002 * @list_len: The number of pages in page_list.
2003 * @iova: The I/O virtual address to use with the mapped region.
2005 static inline int ib_map_phys_fmr(struct ib_fmr
*fmr
,
2006 u64
*page_list
, int list_len
,
2009 return fmr
->device
->map_phys_fmr(fmr
, page_list
, list_len
, iova
);
2013 * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
2014 * @fmr_list: A linked list of fast memory regions to unmap.
2016 int ib_unmap_fmr(struct list_head
*fmr_list
);
2019 * ib_dealloc_fmr - Deallocates a fast memory region.
2020 * @fmr: The fast memory region to deallocate.
2022 int ib_dealloc_fmr(struct ib_fmr
*fmr
);
2025 * ib_attach_mcast - Attaches the specified QP to a multicast group.
2026 * @qp: QP to attach to the multicast group. The QP must be type
2028 * @gid: Multicast group GID.
2029 * @lid: Multicast group LID in host byte order.
2031 * In order to send and receive multicast packets, subnet
2032 * administration must have created the multicast group and configured
2033 * the fabric appropriately. The port associated with the specified
2034 * QP must also be a member of the multicast group.
2036 int ib_attach_mcast(struct ib_qp
*qp
, union ib_gid
*gid
, u16 lid
);
2039 * ib_detach_mcast - Detaches the specified QP from a multicast group.
2040 * @qp: QP to detach from the multicast group.
2041 * @gid: Multicast group GID.
2042 * @lid: Multicast group LID in host byte order.
2044 int ib_detach_mcast(struct ib_qp
*qp
, union ib_gid
*gid
, u16 lid
);
2046 #endif /* IB_VERBS_H */