GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / driver-api / basics.rst
1 Driver Basics
2 =============
3
4 Driver Entry and Exit points
5 ----------------------------
6
7 .. kernel-doc:: include/linux/module.h
8    :internal:
9
10 Driver device table
11 -------------------
12
13 .. kernel-doc:: include/linux/mod_devicetable.h
14    :internal:
15
16 Atomic and pointer manipulation
17 -------------------------------
18
19 .. kernel-doc:: arch/x86/include/asm/atomic.h
20    :internal:
21
22 Delaying, scheduling, and timer routines
23 ----------------------------------------
24
25 .. kernel-doc:: include/linux/sched.h
26    :internal:
27
28 .. kernel-doc:: kernel/sched/core.c
29    :export:
30
31 .. kernel-doc:: kernel/sched/cpupri.c
32    :internal:
33
34 .. kernel-doc:: kernel/sched/fair.c
35    :internal:
36
37 .. kernel-doc:: include/linux/completion.h
38    :internal:
39
40 .. kernel-doc:: kernel/time/timer.c
41    :export:
42
43 Wait queues and Wake events
44 ---------------------------
45
46 .. kernel-doc:: include/linux/wait.h
47    :internal:
48
49 .. kernel-doc:: kernel/sched/wait.c
50    :export:
51
52 High-resolution timers
53 ----------------------
54
55 .. kernel-doc:: include/linux/ktime.h
56    :internal:
57
58 .. kernel-doc:: include/linux/hrtimer.h
59    :internal:
60
61 .. kernel-doc:: kernel/time/hrtimer.c
62    :export:
63
64 Workqueues and Kevents
65 ----------------------
66
67 .. kernel-doc:: include/linux/workqueue.h
68    :internal:
69
70 .. kernel-doc:: kernel/workqueue.c
71    :export:
72
73 Internal Functions
74 ------------------
75
76 .. kernel-doc:: kernel/exit.c
77    :internal:
78
79 .. kernel-doc:: kernel/signal.c
80    :internal:
81
82 .. kernel-doc:: include/linux/kthread.h
83    :internal:
84
85 .. kernel-doc:: kernel/kthread.c
86    :export:
87
88 Kernel objects manipulation
89 ---------------------------
90
91 .. kernel-doc:: lib/kobject.c
92    :export:
93
94 Kernel utility functions
95 ------------------------
96
97 .. kernel-doc:: include/linux/kernel.h
98    :internal:
99
100 .. kernel-doc:: kernel/printk/printk.c
101    :export:
102
103 .. kernel-doc:: kernel/panic.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