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