Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / mainline / linux / 6e8793674bb0d1135ca0e5c9f7e16fecbf815926 / . / Documentation / driver-api / basics.rst
blob: 3e2dae95489847a2b3d04828fa60e5daee831eaf [file] [log] [blame]
Jonathan Corbetdcec3c82016-08-20 13:17:32 -0600[diff] [blame]1Driver Basics
2=============
3
4Driver Entry and Exit points
5----------------------------
6
Jonathan Corbet127d4b32017-07-17 13:55:58 -0600[diff] [blame]7.. kernel-doc:: include/linux/module.h
Jonathan Corbetdcec3c82016-08-20 13:17:32 -0600[diff] [blame]8 :internal:
9
Mauro Carvalho Chehabd76a0852017-04-05 10:22:56 -0300[diff] [blame]10Driver device table
11-------------------
12
13.. kernel-doc:: include/linux/mod_devicetable.h
14 :internal:
Mauro Carvalho Chehaba57c3522020-09-29 12:51:00 +0200[diff] [blame]15 :no-identifiers: pci_device_id
16
Mauro Carvalho Chehabd76a0852017-04-05 10:22:56 -0300[diff] [blame]17
Jonathan Corbetdcec3c82016-08-20 13:17:32 -0600[diff] [blame]18Delaying, scheduling, and timer routines
19----------------------------------------
20
21.. kernel-doc:: include/linux/sched.h
22 :internal:
23
24.. kernel-doc:: kernel/sched/core.c
25 :export:
26
27.. kernel-doc:: kernel/sched/cpupri.c
28 :internal:
29
30.. kernel-doc:: kernel/sched/fair.c
31 :internal:
32
33.. kernel-doc:: include/linux/completion.h
34 :internal:
35
36.. kernel-doc:: kernel/time/timer.c
37 :export:
38
39Wait queues and Wake events
40---------------------------
41
42.. kernel-doc:: include/linux/wait.h
43 :internal:
44
45.. kernel-doc:: kernel/sched/wait.c
46 :export:
47
48High-resolution timers
49----------------------
50
51.. kernel-doc:: include/linux/ktime.h
52 :internal:
53
54.. kernel-doc:: include/linux/hrtimer.h
55 :internal:
56
57.. kernel-doc:: kernel/time/hrtimer.c
58 :export:
59
Jonathan Corbetdcec3c82016-08-20 13:17:32 -0600[diff] [blame]60Internal Functions
61------------------
62
63.. kernel-doc:: kernel/exit.c
64 :internal:
65
66.. kernel-doc:: kernel/signal.c
67 :internal:
68
69.. kernel-doc:: include/linux/kthread.h
70 :internal:
71
72.. kernel-doc:: kernel/kthread.c
73 :export:
74
Elena Reshetovab6e859f2017-12-05 12:46:35 +0200[diff] [blame]75Reference counting
76------------------
77
78.. kernel-doc:: include/linux/refcount.h
79 :internal:
80
81.. kernel-doc:: lib/refcount.c
82 :export:
83
84Atomics
85-------
86
87.. kernel-doc:: arch/x86/include/asm/atomic.h
88 :internal:
89
Jonathan Corbetdcec3c82016-08-20 13:17:32 -0600[diff] [blame]90Kernel objects manipulation
91---------------------------
92
93.. kernel-doc:: lib/kobject.c
94 :export:
95
96Kernel utility functions
97------------------------
98
99.. kernel-doc:: include/linux/kernel.h
100 :internal:
Mauro Carvalho Chehaba57c3522020-09-29 12:51:00 +0200[diff] [blame]101 :no-identifiers: kstrtol kstrtoul
Jonathan Corbetdcec3c82016-08-20 13:17:32 -0600[diff] [blame]102
103.. kernel-doc:: kernel/printk/printk.c
104 :export:
Mauro Carvalho Chehaba57c3522020-09-29 12:51:00 +0200[diff] [blame]105 :no-identifiers: printk
Jonathan Corbetdcec3c82016-08-20 13:17:32 -0600[diff] [blame]106
107.. kernel-doc:: kernel/panic.c
108 :export:
109
Kees Cook84253c82018-10-17 16:45:32 -0700[diff] [blame]110.. kernel-doc:: include/linux/overflow.h
111 :internal:
112
Jonathan Corbetdcec3c82016-08-20 13:17:32 -0600[diff] [blame]113Device Resource Management
114--------------------------
115
116.. kernel-doc:: drivers/base/devres.c
117 :export:
118