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.
8 * This software is available to you under a choice of one of two
9 * licenses. You may choose to be licensed under the terms of the GNU
10 * General Public License (GPL) Version 2, available from the file
11 * COPYING in the main directory of this source tree, or the
12 * OpenIB.org BSD license below:
14 * Redistribution and use in source and binary forms, with or
15 * without modification, are permitted provided that the following
18 * - Redistributions of source code must retain the above
19 * copyright notice, this list of conditions and the following
22 * - Redistributions in binary form must reproduce the above
23 * copyright notice, this list of conditions and the following
24 * disclaimer in the documentation and/or other materials
25 * provided with the distribution.
27 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
28 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
29 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
30 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
31 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
32 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
33 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
36 * $Id: ib_verbs.h 1349 2004-12-16 21:09:43Z roland $
39 #if !defined(IB_VERBS_H)
42 #include <linux/types.h>
43 #include <linux/device.h>
44 #include <asm/atomic.h>
60 enum ib_device_cap_flags {
61 IB_DEVICE_RESIZE_MAX_WR = 1,
62 IB_DEVICE_BAD_PKEY_CNTR = (1<<1),
63 IB_DEVICE_BAD_QKEY_CNTR = (1<<2),
64 IB_DEVICE_RAW_MULTI = (1<<3),
65 IB_DEVICE_AUTO_PATH_MIG = (1<<4),
66 IB_DEVICE_CHANGE_PHY_PORT = (1<<5),
67 IB_DEVICE_UD_AV_PORT_ENFORCE = (1<<6),
68 IB_DEVICE_CURR_QP_STATE_MOD = (1<<7),
69 IB_DEVICE_SHUTDOWN_PORT = (1<<8),
70 IB_DEVICE_INIT_TYPE = (1<<9),
71 IB_DEVICE_PORT_ACTIVE_EVENT = (1<<10),
72 IB_DEVICE_SYS_IMAGE_GUID = (1<<11),
73 IB_DEVICE_RC_RNR_NAK_GEN = (1<<12),
74 IB_DEVICE_SRQ_RESIZE = (1<<13),
75 IB_DEVICE_N_NOTIFY_CQ = (1<<14),
76 IB_DEVICE_RQ_SIG_TYPE = (1<<15)
85 struct ib_device_attr {
106 int max_qp_init_rd_atom;
107 int max_ee_init_rd_atom;
108 enum ib_atomic_cap atomic_cap;
115 int max_mcast_qp_attach;
116 int max_total_mcast_qp_attach;
124 u8 local_ca_ack_delay;
135 static inline int ib_mtu_enum_to_int(enum ib_mtu mtu)
138 case IB_MTU_256: return 256;
139 case IB_MTU_512: return 512;
140 case IB_MTU_1024: return 1024;
141 case IB_MTU_2048: return 2048;
142 case IB_MTU_4096: return 4096;
153 IB_PORT_ACTIVE_DEFER = 5
156 enum ib_port_cap_flags {
158 IB_PORT_NOTICE_SUP = 1 << 2,
159 IB_PORT_TRAP_SUP = 1 << 3,
160 IB_PORT_OPT_IPD_SUP = 1 << 4,
161 IB_PORT_AUTO_MIGR_SUP = 1 << 5,
162 IB_PORT_SL_MAP_SUP = 1 << 6,
163 IB_PORT_MKEY_NVRAM = 1 << 7,
164 IB_PORT_PKEY_NVRAM = 1 << 8,
165 IB_PORT_LED_INFO_SUP = 1 << 9,
166 IB_PORT_SM_DISABLED = 1 << 10,
167 IB_PORT_SYS_IMAGE_GUID_SUP = 1 << 11,
168 IB_PORT_PKEY_SW_EXT_PORT_TRAP_SUP = 1 << 12,
169 IB_PORT_CM_SUP = 1 << 16,
170 IB_PORT_SNMP_TUNNEL_SUP = 1 << 17,
171 IB_PORT_REINIT_SUP = 1 << 18,
172 IB_PORT_DEVICE_MGMT_SUP = 1 << 19,
173 IB_PORT_VENDOR_CLASS_SUP = 1 << 20,
174 IB_PORT_DR_NOTICE_SUP = 1 << 21,
175 IB_PORT_CAP_MASK_NOTICE_SUP = 1 << 22,
176 IB_PORT_BOOT_MGMT_SUP = 1 << 23,
177 IB_PORT_LINK_LATENCY_SUP = 1 << 24,
178 IB_PORT_CLIENT_REG_SUP = 1 << 25
188 static inline int ib_width_enum_to_int(enum ib_port_width width)
191 case IB_WIDTH_1X: return 1;
192 case IB_WIDTH_4X: return 4;
193 case IB_WIDTH_8X: return 8;
194 case IB_WIDTH_12X: return 12;
199 struct ib_port_attr {
200 enum ib_port_state state;
202 enum ib_mtu active_mtu;
221 enum ib_device_modify_flags {
222 IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1
225 struct ib_device_modify {
229 enum ib_port_modify_flags {
230 IB_PORT_SHUTDOWN = 1,
231 IB_PORT_INIT_TYPE = (1<<2),
232 IB_PORT_RESET_QKEY_CNTR = (1<<3)
235 struct ib_port_modify {
236 u32 set_port_cap_mask;
237 u32 clr_port_cap_mask;
245 IB_EVENT_QP_ACCESS_ERR,
249 IB_EVENT_PATH_MIG_ERR,
250 IB_EVENT_DEVICE_FATAL,
251 IB_EVENT_PORT_ACTIVE,
254 IB_EVENT_PKEY_CHANGE,
259 struct ib_device *device;
265 enum ib_event_type event;
268 struct ib_event_handler {
269 struct ib_device *device;
270 void (*handler)(struct ib_event_handler *, struct ib_event *);
271 struct list_head list;
274 #define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler) \
276 (_ptr)->device = _device; \
277 (_ptr)->handler = _handler; \
278 INIT_LIST_HEAD(&(_ptr)->list); \
281 struct ib_global_route {
290 IB_MULTICAST_QPN = 0xffffff
298 struct ib_global_route grh;
311 IB_WC_LOC_EEC_OP_ERR,
316 IB_WC_LOC_ACCESS_ERR,
317 IB_WC_REM_INV_REQ_ERR,
318 IB_WC_REM_ACCESS_ERR,
321 IB_WC_RNR_RETRY_EXC_ERR,
322 IB_WC_LOC_RDD_VIOL_ERR,
323 IB_WC_REM_INV_RD_REQ_ERR,
326 IB_WC_INV_EEC_STATE_ERR,
328 IB_WC_RESP_TIMEOUT_ERR,
340 * Set value of IB_WC_RECV so consumers can test if a completion is a
341 * receive by testing (opcode & IB_WC_RECV).
344 IB_WC_RECV_RDMA_WITH_IMM
349 IB_WC_WITH_IMM = (1<<1)
354 enum ib_wc_status status;
355 enum ib_wc_opcode opcode;
366 u8 port_num; /* valid only for DR SMPs on switches */
389 * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
390 * here (and in that order) since the MAD layer uses them as
391 * indices into a 2-entry table.
403 struct ib_qp_init_attr {
404 void (*event_handler)(struct ib_event *, void *);
406 struct ib_cq *send_cq;
407 struct ib_cq *recv_cq;
409 struct ib_qp_cap cap;
410 enum ib_sig_type sq_sig_type;
411 enum ib_sig_type rq_sig_type;
412 enum ib_qp_type qp_type;
413 u8 port_num; /* special QP types only */
416 enum ib_rnr_timeout {
417 IB_RNR_TIMER_655_36 = 0,
418 IB_RNR_TIMER_000_01 = 1,
419 IB_RNR_TIMER_000_02 = 2,
420 IB_RNR_TIMER_000_03 = 3,
421 IB_RNR_TIMER_000_04 = 4,
422 IB_RNR_TIMER_000_06 = 5,
423 IB_RNR_TIMER_000_08 = 6,
424 IB_RNR_TIMER_000_12 = 7,
425 IB_RNR_TIMER_000_16 = 8,
426 IB_RNR_TIMER_000_24 = 9,
427 IB_RNR_TIMER_000_32 = 10,
428 IB_RNR_TIMER_000_48 = 11,
429 IB_RNR_TIMER_000_64 = 12,
430 IB_RNR_TIMER_000_96 = 13,
431 IB_RNR_TIMER_001_28 = 14,
432 IB_RNR_TIMER_001_92 = 15,
433 IB_RNR_TIMER_002_56 = 16,
434 IB_RNR_TIMER_003_84 = 17,
435 IB_RNR_TIMER_005_12 = 18,
436 IB_RNR_TIMER_007_68 = 19,
437 IB_RNR_TIMER_010_24 = 20,
438 IB_RNR_TIMER_015_36 = 21,
439 IB_RNR_TIMER_020_48 = 22,
440 IB_RNR_TIMER_030_72 = 23,
441 IB_RNR_TIMER_040_96 = 24,
442 IB_RNR_TIMER_061_44 = 25,
443 IB_RNR_TIMER_081_92 = 26,
444 IB_RNR_TIMER_122_88 = 27,
445 IB_RNR_TIMER_163_84 = 28,
446 IB_RNR_TIMER_245_76 = 29,
447 IB_RNR_TIMER_327_68 = 30,
448 IB_RNR_TIMER_491_52 = 31
451 enum ib_qp_attr_mask {
453 IB_QP_CUR_STATE = (1<<1),
454 IB_QP_EN_SQD_ASYNC_NOTIFY = (1<<2),
455 IB_QP_ACCESS_FLAGS = (1<<3),
456 IB_QP_PKEY_INDEX = (1<<4),
460 IB_QP_PATH_MTU = (1<<8),
461 IB_QP_TIMEOUT = (1<<9),
462 IB_QP_RETRY_CNT = (1<<10),
463 IB_QP_RNR_RETRY = (1<<11),
464 IB_QP_RQ_PSN = (1<<12),
465 IB_QP_MAX_QP_RD_ATOMIC = (1<<13),
466 IB_QP_ALT_PATH = (1<<14),
467 IB_QP_MIN_RNR_TIMER = (1<<15),
468 IB_QP_SQ_PSN = (1<<16),
469 IB_QP_MAX_DEST_RD_ATOMIC = (1<<17),
470 IB_QP_PATH_MIG_STATE = (1<<18),
472 IB_QP_DEST_QPN = (1<<20)
492 enum ib_qp_state qp_state;
493 enum ib_qp_state cur_qp_state;
494 enum ib_mtu path_mtu;
495 enum ib_mig_state path_mig_state;
501 struct ib_qp_cap cap;
502 struct ib_ah_attr ah_attr;
503 struct ib_ah_attr alt_ah_attr;
506 u8 en_sqd_async_notify;
509 u8 max_dest_rd_atomic;
521 IB_WR_RDMA_WRITE_WITH_IMM,
525 IB_WR_ATOMIC_CMP_AND_SWP,
526 IB_WR_ATOMIC_FETCH_AND_ADD
531 IB_SEND_SIGNALED = (1<<1),
532 IB_SEND_SOLICITED = (1<<2),
533 IB_SEND_INLINE = (1<<3)
547 struct ib_send_wr *next;
549 struct ib_sge *sg_list;
551 enum ib_wr_opcode opcode;
567 struct ib_mad_hdr *mad_hdr;
570 int timeout_ms; /* valid for MADs only */
571 u16 pkey_index; /* valid for GSI only */
572 u8 port_num; /* valid for DR SMPs on switch only */
578 struct ib_recv_wr *next;
580 struct ib_sge *sg_list;
585 enum ib_access_flags {
586 IB_ACCESS_LOCAL_WRITE = 1,
587 IB_ACCESS_REMOTE_WRITE = (1<<1),
588 IB_ACCESS_REMOTE_READ = (1<<2),
589 IB_ACCESS_REMOTE_ATOMIC = (1<<3),
590 IB_ACCESS_MW_BIND = (1<<4)
600 u64 device_virt_addr;
607 enum ib_mr_rereg_flags {
608 IB_MR_REREG_TRANS = 1,
609 IB_MR_REREG_PD = (1<<1),
610 IB_MR_REREG_ACCESS = (1<<2)
629 struct ib_device *device;
630 atomic_t usecnt; /* count all resources */
634 struct ib_device *device;
638 typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
641 struct ib_device *device;
642 ib_comp_handler comp_handler;
643 void (*event_handler)(struct ib_event *, void *);
646 atomic_t usecnt; /* count number of work queues */
650 struct ib_device *device;
657 struct ib_device *device;
659 struct ib_cq *send_cq;
660 struct ib_cq *recv_cq;
662 void (*event_handler)(struct ib_event *, void *);
665 enum ib_qp_type qp_type;
669 struct ib_device *device;
673 atomic_t usecnt; /* count number of MWs */
677 struct ib_device *device;
683 struct ib_device *device;
685 struct list_head list;
693 enum ib_process_mad_flags {
694 IB_MAD_IGNORE_MKEY = 1,
695 IB_MAD_IGNORE_BKEY = 2,
696 IB_MAD_IGNORE_ALL = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
700 IB_MAD_RESULT_FAILURE = 0, /* (!SUCCESS is the important flag) */
701 IB_MAD_RESULT_SUCCESS = 1 << 0, /* MAD was successfully processed */
702 IB_MAD_RESULT_REPLY = 1 << 1, /* Reply packet needs to be sent */
703 IB_MAD_RESULT_CONSUMED = 1 << 2 /* Packet consumed: stop processing */
706 #define IB_DEVICE_NAME_MAX 64
710 struct ib_event_handler event_handler;
711 struct ib_pkey_cache **pkey_cache;
712 struct ib_gid_cache **gid_cache;
716 struct device *dma_device;
718 char name[IB_DEVICE_NAME_MAX];
720 struct list_head event_handler_list;
721 spinlock_t event_handler_lock;
723 struct list_head core_list;
724 struct list_head client_data_list;
725 spinlock_t client_data_lock;
727 struct ib_cache cache;
731 int (*query_device)(struct ib_device *device,
732 struct ib_device_attr *device_attr);
733 int (*query_port)(struct ib_device *device,
735 struct ib_port_attr *port_attr);
736 int (*query_gid)(struct ib_device *device,
737 u8 port_num, int index,
739 int (*query_pkey)(struct ib_device *device,
740 u8 port_num, u16 index, u16 *pkey);
741 int (*modify_device)(struct ib_device *device,
742 int device_modify_mask,
743 struct ib_device_modify *device_modify);
744 int (*modify_port)(struct ib_device *device,
745 u8 port_num, int port_modify_mask,
746 struct ib_port_modify *port_modify);
747 struct ib_pd * (*alloc_pd)(struct ib_device *device);
748 int (*dealloc_pd)(struct ib_pd *pd);
749 struct ib_ah * (*create_ah)(struct ib_pd *pd,
750 struct ib_ah_attr *ah_attr);
751 int (*modify_ah)(struct ib_ah *ah,
752 struct ib_ah_attr *ah_attr);
753 int (*query_ah)(struct ib_ah *ah,
754 struct ib_ah_attr *ah_attr);
755 int (*destroy_ah)(struct ib_ah *ah);
756 struct ib_qp * (*create_qp)(struct ib_pd *pd,
757 struct ib_qp_init_attr *qp_init_attr);
758 int (*modify_qp)(struct ib_qp *qp,
759 struct ib_qp_attr *qp_attr,
761 int (*query_qp)(struct ib_qp *qp,
762 struct ib_qp_attr *qp_attr,
764 struct ib_qp_init_attr *qp_init_attr);
765 int (*destroy_qp)(struct ib_qp *qp);
766 int (*post_send)(struct ib_qp *qp,
767 struct ib_send_wr *send_wr,
768 struct ib_send_wr **bad_send_wr);
769 int (*post_recv)(struct ib_qp *qp,
770 struct ib_recv_wr *recv_wr,
771 struct ib_recv_wr **bad_recv_wr);
772 struct ib_cq * (*create_cq)(struct ib_device *device,
774 int (*destroy_cq)(struct ib_cq *cq);
775 int (*resize_cq)(struct ib_cq *cq, int *cqe);
776 int (*poll_cq)(struct ib_cq *cq, int num_entries,
778 int (*peek_cq)(struct ib_cq *cq, int wc_cnt);
779 int (*req_notify_cq)(struct ib_cq *cq,
780 enum ib_cq_notify cq_notify);
781 int (*req_ncomp_notif)(struct ib_cq *cq,
783 struct ib_mr * (*get_dma_mr)(struct ib_pd *pd,
784 int mr_access_flags);
785 struct ib_mr * (*reg_phys_mr)(struct ib_pd *pd,
786 struct ib_phys_buf *phys_buf_array,
790 int (*query_mr)(struct ib_mr *mr,
791 struct ib_mr_attr *mr_attr);
792 int (*dereg_mr)(struct ib_mr *mr);
793 int (*rereg_phys_mr)(struct ib_mr *mr,
796 struct ib_phys_buf *phys_buf_array,
800 struct ib_mw * (*alloc_mw)(struct ib_pd *pd);
801 int (*bind_mw)(struct ib_qp *qp,
803 struct ib_mw_bind *mw_bind);
804 int (*dealloc_mw)(struct ib_mw *mw);
805 struct ib_fmr * (*alloc_fmr)(struct ib_pd *pd,
807 struct ib_fmr_attr *fmr_attr);
808 int (*map_phys_fmr)(struct ib_fmr *fmr,
809 u64 *page_list, int list_len,
811 int (*unmap_fmr)(struct list_head *fmr_list);
812 int (*dealloc_fmr)(struct ib_fmr *fmr);
813 int (*attach_mcast)(struct ib_qp *qp,
816 int (*detach_mcast)(struct ib_qp *qp,
819 int (*process_mad)(struct ib_device *device,
820 int process_mad_flags,
823 struct ib_grh *in_grh,
824 struct ib_mad *in_mad,
825 struct ib_mad *out_mad);
827 struct class_device class_dev;
828 struct kobject ports_parent;
829 struct list_head port_list;
832 IB_DEV_UNINITIALIZED,
843 void (*add) (struct ib_device *);
844 void (*remove)(struct ib_device *);
846 struct list_head list;
849 struct ib_device *ib_alloc_device(size_t size);
850 void ib_dealloc_device(struct ib_device *device);
852 int ib_register_device (struct ib_device *device);
853 void ib_unregister_device(struct ib_device *device);
855 int ib_register_client (struct ib_client *client);
856 void ib_unregister_client(struct ib_client *client);
858 void *ib_get_client_data(struct ib_device *device, struct ib_client *client);
859 void ib_set_client_data(struct ib_device *device, struct ib_client *client,
862 int ib_register_event_handler (struct ib_event_handler *event_handler);
863 int ib_unregister_event_handler(struct ib_event_handler *event_handler);
864 void ib_dispatch_event(struct ib_event *event);
866 int ib_query_device(struct ib_device *device,
867 struct ib_device_attr *device_attr);
869 int ib_query_port(struct ib_device *device,
870 u8 port_num, struct ib_port_attr *port_attr);
872 int ib_query_gid(struct ib_device *device,
873 u8 port_num, int index, union ib_gid *gid);
875 int ib_query_pkey(struct ib_device *device,
876 u8 port_num, u16 index, u16 *pkey);
878 int ib_modify_device(struct ib_device *device,
879 int device_modify_mask,
880 struct ib_device_modify *device_modify);
882 int ib_modify_port(struct ib_device *device,
883 u8 port_num, int port_modify_mask,
884 struct ib_port_modify *port_modify);
887 * ib_alloc_pd - Allocates an unused protection domain.
888 * @device: The device on which to allocate the protection domain.
890 * A protection domain object provides an association between QPs, shared
891 * receive queues, address handles, memory regions, and memory windows.
893 struct ib_pd *ib_alloc_pd(struct ib_device *device);
896 * ib_dealloc_pd - Deallocates a protection domain.
897 * @pd: The protection domain to deallocate.
899 int ib_dealloc_pd(struct ib_pd *pd);
902 * ib_create_ah - Creates an address handle for the given address vector.
903 * @pd: The protection domain associated with the address handle.
904 * @ah_attr: The attributes of the address vector.
906 * The address handle is used to reference a local or global destination
907 * in all UD QP post sends.
909 struct ib_ah *ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
912 * ib_modify_ah - Modifies the address vector associated with an address
914 * @ah: The address handle to modify.
915 * @ah_attr: The new address vector attributes to associate with the
918 int ib_modify_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
921 * ib_query_ah - Queries the address vector associated with an address
923 * @ah: The address handle to query.
924 * @ah_attr: The address vector attributes associated with the address
927 int ib_query_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
930 * ib_destroy_ah - Destroys an address handle.
931 * @ah: The address handle to destroy.
933 int ib_destroy_ah(struct ib_ah *ah);
936 * ib_create_qp - Creates a QP associated with the specified protection
938 * @pd: The protection domain associated with the QP.
939 * @qp_init_attr: A list of initial attributes required to create the QP.
941 struct ib_qp *ib_create_qp(struct ib_pd *pd,
942 struct ib_qp_init_attr *qp_init_attr);
945 * ib_modify_qp - Modifies the attributes for the specified QP and then
946 * transitions the QP to the given state.
947 * @qp: The QP to modify.
948 * @qp_attr: On input, specifies the QP attributes to modify. On output,
949 * the current values of selected QP attributes are returned.
950 * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
951 * are being modified.
953 int ib_modify_qp(struct ib_qp *qp,
954 struct ib_qp_attr *qp_attr,
958 * ib_query_qp - Returns the attribute list and current values for the
960 * @qp: The QP to query.
961 * @qp_attr: The attributes of the specified QP.
962 * @qp_attr_mask: A bit-mask used to select specific attributes to query.
963 * @qp_init_attr: Additional attributes of the selected QP.
965 * The qp_attr_mask may be used to limit the query to gathering only the
966 * selected attributes.
968 int ib_query_qp(struct ib_qp *qp,
969 struct ib_qp_attr *qp_attr,
971 struct ib_qp_init_attr *qp_init_attr);
974 * ib_destroy_qp - Destroys the specified QP.
975 * @qp: The QP to destroy.
977 int ib_destroy_qp(struct ib_qp *qp);
980 * ib_post_send - Posts a list of work requests to the send queue of
982 * @qp: The QP to post the work request on.
983 * @send_wr: A list of work requests to post on the send queue.
984 * @bad_send_wr: On an immediate failure, this parameter will reference
985 * the work request that failed to be posted on the QP.
987 static inline int ib_post_send(struct ib_qp *qp,
988 struct ib_send_wr *send_wr,
989 struct ib_send_wr **bad_send_wr)
991 return qp->device->post_send(qp, send_wr, bad_send_wr);
995 * ib_post_recv - Posts a list of work requests to the receive queue of
997 * @qp: The QP to post the work request on.
998 * @recv_wr: A list of work requests to post on the receive queue.
999 * @bad_recv_wr: On an immediate failure, this parameter will reference
1000 * the work request that failed to be posted on the QP.
1002 static inline int ib_post_recv(struct ib_qp *qp,
1003 struct ib_recv_wr *recv_wr,
1004 struct ib_recv_wr **bad_recv_wr)
1006 return qp->device->post_recv(qp, recv_wr, bad_recv_wr);
1010 * ib_create_cq - Creates a CQ on the specified device.
1011 * @device: The device on which to create the CQ.
1012 * @comp_handler: A user-specified callback that is invoked when a
1013 * completion event occurs on the CQ.
1014 * @event_handler: A user-specified callback that is invoked when an
1015 * asynchronous event not associated with a completion occurs on the CQ.
1016 * @cq_context: Context associated with the CQ returned to the user via
1017 * the associated completion and event handlers.
1018 * @cqe: The minimum size of the CQ.
1020 * Users can examine the cq structure to determine the actual CQ size.
1022 struct ib_cq *ib_create_cq(struct ib_device *device,
1023 ib_comp_handler comp_handler,
1024 void (*event_handler)(struct ib_event *, void *),
1025 void *cq_context, int cqe);
1028 * ib_resize_cq - Modifies the capacity of the CQ.
1029 * @cq: The CQ to resize.
1030 * @cqe: The minimum size of the CQ.
1032 * Users can examine the cq structure to determine the actual CQ size.
1034 int ib_resize_cq(struct ib_cq *cq, int cqe);
1037 * ib_destroy_cq - Destroys the specified CQ.
1038 * @cq: The CQ to destroy.
1040 int ib_destroy_cq(struct ib_cq *cq);
1043 * ib_poll_cq - poll a CQ for completion(s)
1044 * @cq:the CQ being polled
1045 * @num_entries:maximum number of completions to return
1046 * @wc:array of at least @num_entries &struct ib_wc where completions
1049 * Poll a CQ for (possibly multiple) completions. If the return value
1050 * is < 0, an error occurred. If the return value is >= 0, it is the
1051 * number of completions returned. If the return value is
1052 * non-negative and < num_entries, then the CQ was emptied.
1054 static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
1057 return cq->device->poll_cq(cq, num_entries, wc);
1061 * ib_peek_cq - Returns the number of unreaped completions currently
1062 * on the specified CQ.
1063 * @cq: The CQ to peek.
1064 * @wc_cnt: A minimum number of unreaped completions to check for.
1066 * If the number of unreaped completions is greater than or equal to wc_cnt,
1067 * this function returns wc_cnt, otherwise, it returns the actual number of
1068 * unreaped completions.
1070 int ib_peek_cq(struct ib_cq *cq, int wc_cnt);
1073 * ib_req_notify_cq - Request completion notification on a CQ.
1074 * @cq: The CQ to generate an event for.
1075 * @cq_notify: If set to %IB_CQ_SOLICITED, completion notification will
1076 * occur on the next solicited event. If set to %IB_CQ_NEXT_COMP,
1077 * notification will occur on the next completion.
1079 static inline int ib_req_notify_cq(struct ib_cq *cq,
1080 enum ib_cq_notify cq_notify)
1082 return cq->device->req_notify_cq(cq, cq_notify);
1086 * ib_req_ncomp_notif - Request completion notification when there are
1087 * at least the specified number of unreaped completions on the CQ.
1088 * @cq: The CQ to generate an event for.
1089 * @wc_cnt: The number of unreaped completions that should be on the
1090 * CQ before an event is generated.
1092 static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
1094 return cq->device->req_ncomp_notif ?
1095 cq->device->req_ncomp_notif(cq, wc_cnt) :
1100 * ib_get_dma_mr - Returns a memory region for system memory that is
1102 * @pd: The protection domain associated with the memory region.
1103 * @mr_access_flags: Specifies the memory access rights.
1105 struct ib_mr *ib_get_dma_mr(struct ib_pd *pd, int mr_access_flags);
1108 * ib_reg_phys_mr - Prepares a virtually addressed memory region for use
1110 * @pd: The protection domain associated assigned to the registered region.
1111 * @phys_buf_array: Specifies a list of physical buffers to use in the
1113 * @num_phys_buf: Specifies the size of the phys_buf_array.
1114 * @mr_access_flags: Specifies the memory access rights.
1115 * @iova_start: The offset of the region's starting I/O virtual address.
1117 struct ib_mr *ib_reg_phys_mr(struct ib_pd *pd,
1118 struct ib_phys_buf *phys_buf_array,
1120 int mr_access_flags,
1124 * ib_rereg_phys_mr - Modifies the attributes of an existing memory region.
1125 * Conceptually, this call performs the functions deregister memory region
1126 * followed by register physical memory region. Where possible,
1127 * resources are reused instead of deallocated and reallocated.
1128 * @mr: The memory region to modify.
1129 * @mr_rereg_mask: A bit-mask used to indicate which of the following
1130 * properties of the memory region are being modified.
1131 * @pd: If %IB_MR_REREG_PD is set in mr_rereg_mask, this field specifies
1132 * the new protection domain to associated with the memory region,
1133 * otherwise, this parameter is ignored.
1134 * @phys_buf_array: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1135 * field specifies a list of physical buffers to use in the new
1136 * translation, otherwise, this parameter is ignored.
1137 * @num_phys_buf: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1138 * field specifies the size of the phys_buf_array, otherwise, this
1139 * parameter is ignored.
1140 * @mr_access_flags: If %IB_MR_REREG_ACCESS is set in mr_rereg_mask, this
1141 * field specifies the new memory access rights, otherwise, this
1142 * parameter is ignored.
1143 * @iova_start: The offset of the region's starting I/O virtual address.
1145 int ib_rereg_phys_mr(struct ib_mr *mr,
1148 struct ib_phys_buf *phys_buf_array,
1150 int mr_access_flags,
1154 * ib_query_mr - Retrieves information about a specific memory region.
1155 * @mr: The memory region to retrieve information about.
1156 * @mr_attr: The attributes of the specified memory region.
1158 int ib_query_mr(struct ib_mr *mr, struct ib_mr_attr *mr_attr);
1161 * ib_dereg_mr - Deregisters a memory region and removes it from the
1162 * HCA translation table.
1163 * @mr: The memory region to deregister.
1165 int ib_dereg_mr(struct ib_mr *mr);
1168 * ib_alloc_mw - Allocates a memory window.
1169 * @pd: The protection domain associated with the memory window.
1171 struct ib_mw *ib_alloc_mw(struct ib_pd *pd);
1174 * ib_bind_mw - Posts a work request to the send queue of the specified
1175 * QP, which binds the memory window to the given address range and
1176 * remote access attributes.
1177 * @qp: QP to post the bind work request on.
1178 * @mw: The memory window to bind.
1179 * @mw_bind: Specifies information about the memory window, including
1180 * its address range, remote access rights, and associated memory region.
1182 static inline int ib_bind_mw(struct ib_qp *qp,
1184 struct ib_mw_bind *mw_bind)
1186 /* XXX reference counting in corresponding MR? */
1187 return mw->device->bind_mw ?
1188 mw->device->bind_mw(qp, mw, mw_bind) :
1193 * ib_dealloc_mw - Deallocates a memory window.
1194 * @mw: The memory window to deallocate.
1196 int ib_dealloc_mw(struct ib_mw *mw);
1199 * ib_alloc_fmr - Allocates a unmapped fast memory region.
1200 * @pd: The protection domain associated with the unmapped region.
1201 * @mr_access_flags: Specifies the memory access rights.
1202 * @fmr_attr: Attributes of the unmapped region.
1204 * A fast memory region must be mapped before it can be used as part of
1207 struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
1208 int mr_access_flags,
1209 struct ib_fmr_attr *fmr_attr);
1212 * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
1213 * @fmr: The fast memory region to associate with the pages.
1214 * @page_list: An array of physical pages to map to the fast memory region.
1215 * @list_len: The number of pages in page_list.
1216 * @iova: The I/O virtual address to use with the mapped region.
1218 static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
1219 u64 *page_list, int list_len,
1222 return fmr->device->map_phys_fmr(fmr, page_list, list_len, iova);
1226 * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
1227 * @fmr_list: A linked list of fast memory regions to unmap.
1229 int ib_unmap_fmr(struct list_head *fmr_list);
1232 * ib_dealloc_fmr - Deallocates a fast memory region.
1233 * @fmr: The fast memory region to deallocate.
1235 int ib_dealloc_fmr(struct ib_fmr *fmr);
1238 * ib_attach_mcast - Attaches the specified QP to a multicast group.
1239 * @qp: QP to attach to the multicast group. The QP must be type
1241 * @gid: Multicast group GID.
1242 * @lid: Multicast group LID in host byte order.
1244 * In order to send and receive multicast packets, subnet
1245 * administration must have created the multicast group and configured
1246 * the fabric appropriately. The port associated with the specified
1247 * QP must also be a member of the multicast group.
1249 int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
1252 * ib_detach_mcast - Detaches the specified QP from a multicast group.
1253 * @qp: QP to detach from the multicast group.
1254 * @gid: Multicast group GID.
1255 * @lid: Multicast group LID in host byte order.
1257 int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
1259 #endif /* IB_VERBS_H */