Blame view

Documentation/driver-api/basics.rst 1.97 KB
dcec3c8c9   Jonathan Corbet   docs: split up th...
1
2
3
4
5
  Driver Basics
  =============
  
  Driver Entry and Exit points
  ----------------------------
127d4b376   Jonathan Corbet   docs: Get module_...
6
  .. kernel-doc:: include/linux/module.h
dcec3c8c9   Jonathan Corbet   docs: split up th...
7
     :internal:
d76a085bc   Mauro Carvalho Chehab   driver-api/basics...
8
9
10
11
12
  Driver device table
  -------------------
  
  .. kernel-doc:: include/linux/mod_devicetable.h
     :internal:
a57c3522e   Mauro Carvalho Chehab   docs: basics.rst:...
13
     :no-identifiers: pci_device_id
d76a085bc   Mauro Carvalho Chehab   driver-api/basics...
14

dcec3c8c9   Jonathan Corbet   docs: split up th...
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
  Delaying, scheduling, and timer routines
  ----------------------------------------
  
  .. kernel-doc:: include/linux/sched.h
     :internal:
  
  .. kernel-doc:: kernel/sched/core.c
     :export:
  
  .. kernel-doc:: kernel/sched/cpupri.c
     :internal:
  
  .. kernel-doc:: kernel/sched/fair.c
     :internal:
  
  .. kernel-doc:: include/linux/completion.h
     :internal:
  
  .. kernel-doc:: kernel/time/timer.c
     :export:
  
  Wait queues and Wake events
  ---------------------------
  
  .. kernel-doc:: include/linux/wait.h
     :internal:
  
  .. kernel-doc:: kernel/sched/wait.c
     :export:
  
  High-resolution timers
  ----------------------
  
  .. kernel-doc:: include/linux/ktime.h
     :internal:
  
  .. kernel-doc:: include/linux/hrtimer.h
     :internal:
  
  .. kernel-doc:: kernel/time/hrtimer.c
dcec3c8c9   Jonathan Corbet   docs: split up th...
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
     :export:
  
  Internal Functions
  ------------------
  
  .. kernel-doc:: kernel/exit.c
     :internal:
  
  .. kernel-doc:: kernel/signal.c
     :internal:
  
  .. kernel-doc:: include/linux/kthread.h
     :internal:
  
  .. kernel-doc:: kernel/kthread.c
     :export:
b6e859f6c   Elena Reshetova   docs: refcount_t ...
71
72
73
74
75
76
77
78
79
80
81
82
83
84
  Reference counting
  ------------------
  
  .. kernel-doc:: include/linux/refcount.h
     :internal:
  
  .. kernel-doc:: lib/refcount.c
     :export:
  
  Atomics
  -------
  
  .. kernel-doc:: arch/x86/include/asm/atomic.h
     :internal:
dcec3c8c9   Jonathan Corbet   docs: split up th...
85
86
87
88
89
90
91
92
93
94
95
  Kernel objects manipulation
  ---------------------------
  
  .. kernel-doc:: lib/kobject.c
     :export:
  
  Kernel utility functions
  ------------------------
  
  .. kernel-doc:: include/linux/kernel.h
     :internal:
a57c3522e   Mauro Carvalho Chehab   docs: basics.rst:...
96
     :no-identifiers: kstrtol kstrtoul
dcec3c8c9   Jonathan Corbet   docs: split up th...
97
98
99
  
  .. kernel-doc:: kernel/printk/printk.c
     :export:
a57c3522e   Mauro Carvalho Chehab   docs: basics.rst:...
100
     :no-identifiers: printk
dcec3c8c9   Jonathan Corbet   docs: split up th...
101
102
103
  
  .. kernel-doc:: kernel/panic.c
     :export:
84253c8be   Kees Cook   docs: Introduce d...
104
105
  .. kernel-doc:: include/linux/overflow.h
     :internal:
dcec3c8c9   Jonathan Corbet   docs: split up th...
106
107
108
109
110
  Device Resource Management
  --------------------------
  
  .. kernel-doc:: drivers/base/devres.c
     :export: