xref: /openbmc/linux/Documentation/driver-api/infiniband.rst (revision 4b4193256c8d3bc3a5397b5cd9494c2ad386317d)
1*75e70addSrd.dunlab@gmail.com===========================================
2*75e70addSrd.dunlab@gmail.comInfiniBand and Remote DMA (RDMA) Interfaces
3*75e70addSrd.dunlab@gmail.com===========================================
4*75e70addSrd.dunlab@gmail.com
5*75e70addSrd.dunlab@gmail.comIntroduction and Overview
6*75e70addSrd.dunlab@gmail.com=========================
7*75e70addSrd.dunlab@gmail.com
8*75e70addSrd.dunlab@gmail.comTBD
9*75e70addSrd.dunlab@gmail.com
10*75e70addSrd.dunlab@gmail.comInfiniBand core interfaces
11*75e70addSrd.dunlab@gmail.com==========================
12*75e70addSrd.dunlab@gmail.com
13*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/core/iwpm_util.h
14*75e70addSrd.dunlab@gmail.com    :internal:
15*75e70addSrd.dunlab@gmail.com
16*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/core/cq.c
17*75e70addSrd.dunlab@gmail.com    :export:
18*75e70addSrd.dunlab@gmail.com
19*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/core/cm.c
20*75e70addSrd.dunlab@gmail.com    :export:
21*75e70addSrd.dunlab@gmail.com
22*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/core/rw.c
23*75e70addSrd.dunlab@gmail.com    :export:
24*75e70addSrd.dunlab@gmail.com
25*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/core/device.c
26*75e70addSrd.dunlab@gmail.com    :export:
27*75e70addSrd.dunlab@gmail.com
28*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/core/verbs.c
29*75e70addSrd.dunlab@gmail.com    :export:
30*75e70addSrd.dunlab@gmail.com
31*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/core/packer.c
32*75e70addSrd.dunlab@gmail.com    :export:
33*75e70addSrd.dunlab@gmail.com
34*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/core/sa_query.c
35*75e70addSrd.dunlab@gmail.com    :export:
36*75e70addSrd.dunlab@gmail.com
37*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/core/ud_header.c
38*75e70addSrd.dunlab@gmail.com    :export:
39*75e70addSrd.dunlab@gmail.com
40*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/core/umem.c
41*75e70addSrd.dunlab@gmail.com    :export:
42*75e70addSrd.dunlab@gmail.com
43*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/core/umem_odp.c
44*75e70addSrd.dunlab@gmail.com    :export:
45*75e70addSrd.dunlab@gmail.com
46*75e70addSrd.dunlab@gmail.comRDMA Verbs transport library
47*75e70addSrd.dunlab@gmail.com============================
48*75e70addSrd.dunlab@gmail.com
49*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/sw/rdmavt/mr.c
50*75e70addSrd.dunlab@gmail.com    :export:
51*75e70addSrd.dunlab@gmail.com
52*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/sw/rdmavt/rc.c
53*75e70addSrd.dunlab@gmail.com    :export:
54*75e70addSrd.dunlab@gmail.com
55*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/sw/rdmavt/ah.c
56*75e70addSrd.dunlab@gmail.com    :export:
57*75e70addSrd.dunlab@gmail.com
58*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/sw/rdmavt/vt.c
59*75e70addSrd.dunlab@gmail.com    :export:
60*75e70addSrd.dunlab@gmail.com
61*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/sw/rdmavt/cq.c
62*75e70addSrd.dunlab@gmail.com    :export:
63*75e70addSrd.dunlab@gmail.com
64*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/sw/rdmavt/qp.c
65*75e70addSrd.dunlab@gmail.com    :export:
66*75e70addSrd.dunlab@gmail.com
67*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/sw/rdmavt/mcast.c
68*75e70addSrd.dunlab@gmail.com    :export:
69*75e70addSrd.dunlab@gmail.com
70*75e70addSrd.dunlab@gmail.comUpper Layer Protocols
71*75e70addSrd.dunlab@gmail.com=====================
72*75e70addSrd.dunlab@gmail.com
73*75e70addSrd.dunlab@gmail.comiSCSI Extensions for RDMA (iSER)
74*75e70addSrd.dunlab@gmail.com--------------------------------
75*75e70addSrd.dunlab@gmail.com
76*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/ulp/iser/iscsi_iser.h
77*75e70addSrd.dunlab@gmail.com   :internal:
78*75e70addSrd.dunlab@gmail.com
79*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/ulp/iser/iscsi_iser.c
80*75e70addSrd.dunlab@gmail.com   :functions: iscsi_iser_pdu_alloc iser_initialize_task_headers \
81*75e70addSrd.dunlab@gmail.com	iscsi_iser_task_init iscsi_iser_mtask_xmit iscsi_iser_task_xmit \
82*75e70addSrd.dunlab@gmail.com	iscsi_iser_cleanup_task iscsi_iser_check_protection \
83*75e70addSrd.dunlab@gmail.com	iscsi_iser_conn_create iscsi_iser_conn_bind \
84*75e70addSrd.dunlab@gmail.com	iscsi_iser_conn_start iscsi_iser_conn_stop \
85*75e70addSrd.dunlab@gmail.com	iscsi_iser_session_destroy iscsi_iser_session_create \
86*75e70addSrd.dunlab@gmail.com	iscsi_iser_set_param iscsi_iser_ep_connect iscsi_iser_ep_poll \
87*75e70addSrd.dunlab@gmail.com	iscsi_iser_ep_disconnect
88*75e70addSrd.dunlab@gmail.com
89*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/ulp/iser/iser_initiator.c
90*75e70addSrd.dunlab@gmail.com   :internal:
91*75e70addSrd.dunlab@gmail.com
92*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/ulp/iser/iser_verbs.c
93*75e70addSrd.dunlab@gmail.com   :internal:
94*75e70addSrd.dunlab@gmail.com
95*75e70addSrd.dunlab@gmail.comOmni-Path (OPA) Virtual NIC support
96*75e70addSrd.dunlab@gmail.com-----------------------------------
97*75e70addSrd.dunlab@gmail.com
98*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/ulp/opa_vnic/opa_vnic_internal.h
99*75e70addSrd.dunlab@gmail.com   :internal:
100*75e70addSrd.dunlab@gmail.com
101*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h
102*75e70addSrd.dunlab@gmail.com   :internal:
103*75e70addSrd.dunlab@gmail.com
104*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/ulp/opa_vnic/opa_vnic_vema_iface.c
105*75e70addSrd.dunlab@gmail.com   :internal:
106*75e70addSrd.dunlab@gmail.com
107*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/ulp/opa_vnic/opa_vnic_vema.c
108*75e70addSrd.dunlab@gmail.com   :internal:
109*75e70addSrd.dunlab@gmail.com
110*75e70addSrd.dunlab@gmail.comInfiniBand SCSI RDMA protocol target support
111*75e70addSrd.dunlab@gmail.com--------------------------------------------
112*75e70addSrd.dunlab@gmail.com
113*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/ulp/srpt/ib_srpt.h
114*75e70addSrd.dunlab@gmail.com   :internal:
115*75e70addSrd.dunlab@gmail.com
116*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/ulp/srpt/ib_srpt.c
117*75e70addSrd.dunlab@gmail.com   :internal:
118*75e70addSrd.dunlab@gmail.com
119*75e70addSrd.dunlab@gmail.comiSCSI Extensions for RDMA (iSER) target support
120*75e70addSrd.dunlab@gmail.com-----------------------------------------------
121*75e70addSrd.dunlab@gmail.com
122*75e70addSrd.dunlab@gmail.com.. kernel-doc:: drivers/infiniband/ulp/isert/ib_isert.c
123*75e70addSrd.dunlab@gmail.com   :internal:
124*75e70addSrd.dunlab@gmail.com
125