Linux 4.11-rc6
[linux/fpc-iii.git] / Documentation / driver-api / basics.rst
blob935b9b8d456c8af606324f57c81a5ef4750ac6c6
1 Driver Basics
2 =============
4 Driver Entry and Exit points
5 ----------------------------
7 .. kernel-doc:: include/linux/init.h
8    :internal:
10 Atomic and pointer manipulation
11 -------------------------------
13 .. kernel-doc:: arch/x86/include/asm/atomic.h
14    :internal:
16 Delaying, scheduling, and timer routines
17 ----------------------------------------
19 .. kernel-doc:: include/linux/sched.h
20    :internal:
22 .. kernel-doc:: kernel/sched/core.c
23    :export:
25 .. kernel-doc:: kernel/sched/cpupri.c
26    :internal:
28 .. kernel-doc:: kernel/sched/fair.c
29    :internal:
31 .. kernel-doc:: include/linux/completion.h
32    :internal:
34 .. kernel-doc:: kernel/time/timer.c
35    :export:
37 Wait queues and Wake events
38 ---------------------------
40 .. kernel-doc:: include/linux/wait.h
41    :internal:
43 .. kernel-doc:: kernel/sched/wait.c
44    :export:
46 High-resolution timers
47 ----------------------
49 .. kernel-doc:: include/linux/ktime.h
50    :internal:
52 .. kernel-doc:: include/linux/hrtimer.h
53    :internal:
55 .. kernel-doc:: kernel/time/hrtimer.c
56    :export:
58 Workqueues and Kevents
59 ----------------------
61 .. kernel-doc:: include/linux/workqueue.h
62    :internal:
64 .. kernel-doc:: kernel/workqueue.c
65    :export:
67 Internal Functions
68 ------------------
70 .. kernel-doc:: kernel/exit.c
71    :internal:
73 .. kernel-doc:: kernel/signal.c
74    :internal:
76 .. kernel-doc:: include/linux/kthread.h
77    :internal:
79 .. kernel-doc:: kernel/kthread.c
80    :export:
82 Kernel objects manipulation
83 ---------------------------
85 .. kernel-doc:: lib/kobject.c
86    :export:
88 Kernel utility functions
89 ------------------------
91 .. kernel-doc:: include/linux/kernel.h
92    :internal:
94 .. kernel-doc:: kernel/printk/printk.c
95    :export:
97 .. kernel-doc:: kernel/panic.c
98    :export:
100 .. kernel-doc:: kernel/sys.c
101    :export:
103 .. kernel-doc:: kernel/rcu/srcu.c
104    :export:
106 .. kernel-doc:: kernel/rcu/tree.c
107    :export:
109 .. kernel-doc:: kernel/rcu/tree_plugin.h
110    :export:
112 .. kernel-doc:: kernel/rcu/update.c
113    :export:
115 Device Resource Management
116 --------------------------
118 .. kernel-doc:: drivers/base/devres.c
119    :export: