phylink: add documentation for kernel APIs
[linux-2.6/btrfs-unstable.git] / Documentation / networking / kapi.rst
blobdf4141b72f24fe80f71172a0706120ce44295d30
1 =========================================
2 Linux Networking and Network Devices APIs
3 =========================================
5 Linux Networking
6 ================
8 Networking Base Types
9 ---------------------
11 .. kernel-doc:: include/linux/net.h
12    :internal:
14 Socket Buffer Functions
15 -----------------------
17 .. kernel-doc:: include/linux/skbuff.h
18    :internal:
20 .. kernel-doc:: include/net/sock.h
21    :internal:
23 .. kernel-doc:: net/socket.c
24    :export:
26 .. kernel-doc:: net/core/skbuff.c
27    :export:
29 .. kernel-doc:: net/core/sock.c
30    :export:
32 .. kernel-doc:: net/core/datagram.c
33    :export:
35 .. kernel-doc:: net/core/stream.c
36    :export:
38 Socket Filter
39 -------------
41 .. kernel-doc:: net/core/filter.c
42    :export:
44 Generic Network Statistics
45 --------------------------
47 .. kernel-doc:: include/uapi/linux/gen_stats.h
48    :internal:
50 .. kernel-doc:: net/core/gen_stats.c
51    :export:
53 .. kernel-doc:: net/core/gen_estimator.c
54    :export:
56 SUN RPC subsystem
57 -----------------
59 .. kernel-doc:: net/sunrpc/xdr.c
60    :export:
62 .. kernel-doc:: net/sunrpc/svc_xprt.c
63    :export:
65 .. kernel-doc:: net/sunrpc/xprt.c
66    :export:
68 .. kernel-doc:: net/sunrpc/sched.c
69    :export:
71 .. kernel-doc:: net/sunrpc/socklib.c
72    :export:
74 .. kernel-doc:: net/sunrpc/stats.c
75    :export:
77 .. kernel-doc:: net/sunrpc/rpc_pipe.c
78    :export:
80 .. kernel-doc:: net/sunrpc/rpcb_clnt.c
81    :export:
83 .. kernel-doc:: net/sunrpc/clnt.c
84    :export:
86 WiMAX
87 -----
89 .. kernel-doc:: net/wimax/op-msg.c
90    :export:
92 .. kernel-doc:: net/wimax/op-reset.c
93    :export:
95 .. kernel-doc:: net/wimax/op-rfkill.c
96    :export:
98 .. kernel-doc:: net/wimax/stack.c
99    :export:
101 .. kernel-doc:: include/net/wimax.h
102    :internal:
104 .. kernel-doc:: include/uapi/linux/wimax.h
105    :internal:
107 Network device support
108 ======================
110 Driver Support
111 --------------
113 .. kernel-doc:: net/core/dev.c
114    :export:
116 .. kernel-doc:: net/ethernet/eth.c
117    :export:
119 .. kernel-doc:: net/sched/sch_generic.c
120    :export:
122 .. kernel-doc:: include/linux/etherdevice.h
123    :internal:
125 .. kernel-doc:: include/linux/netdevice.h
126    :internal:
128 PHY Support
129 -----------
131 .. kernel-doc:: drivers/net/phy/phy.c
132    :export:
134 .. kernel-doc:: drivers/net/phy/phy.c
135    :internal:
137 .. kernel-doc:: drivers/net/phy/phy_device.c
138    :export:
140 .. kernel-doc:: drivers/net/phy/phy_device.c
141    :internal:
143 .. kernel-doc:: drivers/net/phy/mdio_bus.c
144    :export:
146 .. kernel-doc:: drivers/net/phy/mdio_bus.c
147    :internal:
149 PHYLINK
150 -------
152   PHYLINK interfaces traditional network drivers with PHYLIB, fixed-links,
153   and SFF modules (eg, hot-pluggable SFP) that may contain PHYs.  PHYLINK
154   provides management of the link state and link modes.
156 .. kernel-doc:: include/linux/phylink.h
157    :internal:
159 .. kernel-doc:: drivers/net/phy/phylink.c