Merge tag 'ceph-for-4.9-rc1' of git://github.com/ceph/ceph-client
[cascardo/linux.git] / Documentation / driver-api / basics.rst
1 Driver Basics
2 =============
3
4 Driver Entry and Exit points
5 ----------------------------
6
7 .. kernel-doc:: include/linux/init.h
8    :internal:
9
10 Atomic and pointer manipulation
11 -------------------------------
12
13 .. kernel-doc:: arch/x86/include/asm/atomic.h
14    :internal:
15
16 Delaying, scheduling, and timer routines
17 ----------------------------------------
18
19 .. kernel-doc:: include/linux/sched.h
20    :internal:
21
22 .. kernel-doc:: kernel/sched/core.c
23    :export:
24
25 .. kernel-doc:: kernel/sched/cpupri.c
26    :internal:
27
28 .. kernel-doc:: kernel/sched/fair.c
29    :internal:
30
31 .. kernel-doc:: include/linux/completion.h
32    :internal:
33
34 .. kernel-doc:: kernel/time/timer.c
35    :export:
36
37 Wait queues and Wake events
38 ---------------------------
39
40 .. kernel-doc:: include/linux/wait.h
41    :internal:
42
43 .. kernel-doc:: kernel/sched/wait.c
44    :export:
45
46 High-resolution timers
47 ----------------------
48
49 .. kernel-doc:: include/linux/ktime.h
50    :internal:
51
52 .. kernel-doc:: include/linux/hrtimer.h
53    :internal:
54
55 .. kernel-doc:: kernel/time/hrtimer.c
56    :export:
57
58 Workqueues and Kevents
59 ----------------------
60
61 .. kernel-doc:: include/linux/workqueue.h
62    :internal:
63
64 .. kernel-doc:: kernel/workqueue.c
65    :export:
66
67 Internal Functions
68 ------------------
69
70 .. kernel-doc:: kernel/exit.c
71    :internal:
72
73 .. kernel-doc:: kernel/signal.c
74    :internal:
75
76 .. kernel-doc:: include/linux/kthread.h
77    :internal:
78
79 .. kernel-doc:: kernel/kthread.c
80    :export:
81
82 Kernel objects manipulation
83 ---------------------------
84
85 .. kernel-doc:: lib/kobject.c
86    :export:
87
88 Kernel utility functions
89 ------------------------
90
91 .. kernel-doc:: include/linux/kernel.h
92    :internal:
93
94 .. kernel-doc:: kernel/printk/printk.c
95    :export:
96
97 .. kernel-doc:: kernel/panic.c
98    :export:
99
100 .. kernel-doc:: kernel/sys.c
101    :export:
102
103 .. kernel-doc:: kernel/rcu/srcu.c
104    :export:
105
106 .. kernel-doc:: kernel/rcu/tree.c
107    :export:
108
109 .. kernel-doc:: kernel/rcu/tree_plugin.h
110    :export:
111
112 .. kernel-doc:: kernel/rcu/update.c
113    :export:
114
115 Device Resource Management
116 --------------------------
117
118 .. kernel-doc:: drivers/base/devres.c
119    :export:
120