mirror of
https://mirrors.bfsu.edu.cn/git/linux.git
synced 2024-12-29 05:55:02 +08:00
e74f4059d1
Add the generated atomic headers to driver-api/basics.rst in order to
provide documentation for the Linux kernel's atomic operations.
At the same time, dtop the x86 atomic header, which provides kerneldoc
comments for some arch_atomic*_*() operations. The arch_atomic*_*()
operations are now purely an implenentation detail of the
raw_atomic*_*() ops, and outside of implementing the atomics, code
should use the raw_atomic*_*() forms.
[Mark: add atomic-{instrumented,long}.h, update commit message]
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Signed-off-by: Mark Rutland <mark.rutland@arm.com>
Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org>
Reviewed-by: Kees Cook <keescook@chromium.org>
Link: https://lore.kernel.org/r/20230605070124.3741859-27-mark.rutland@arm.com
122 lines
2.1 KiB
ReStructuredText
122 lines
2.1 KiB
ReStructuredText
Driver Basics
|
|
=============
|
|
|
|
Driver Entry and Exit points
|
|
----------------------------
|
|
|
|
.. kernel-doc:: include/linux/module.h
|
|
:internal:
|
|
|
|
Driver device table
|
|
-------------------
|
|
|
|
.. kernel-doc:: include/linux/mod_devicetable.h
|
|
:internal:
|
|
:no-identifiers: pci_device_id
|
|
|
|
|
|
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
|
|
: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:
|
|
|
|
Reference counting
|
|
------------------
|
|
|
|
.. kernel-doc:: include/linux/refcount.h
|
|
:internal:
|
|
|
|
.. kernel-doc:: lib/refcount.c
|
|
:export:
|
|
|
|
Atomics
|
|
-------
|
|
|
|
.. kernel-doc:: include/linux/atomic/atomic-instrumented.h
|
|
:internal:
|
|
|
|
.. kernel-doc:: include/linux/atomic/atomic-arch-fallback.h
|
|
:internal:
|
|
|
|
.. kernel-doc:: include/linux/atomic/atomic-long.h
|
|
:internal:
|
|
|
|
Kernel objects manipulation
|
|
---------------------------
|
|
|
|
.. kernel-doc:: lib/kobject.c
|
|
:export:
|
|
|
|
Kernel utility functions
|
|
------------------------
|
|
|
|
.. kernel-doc:: include/linux/kernel.h
|
|
:internal:
|
|
:no-identifiers: kstrtol kstrtoul
|
|
|
|
.. kernel-doc:: kernel/printk/printk.c
|
|
:export:
|
|
:no-identifiers: printk
|
|
|
|
.. kernel-doc:: kernel/panic.c
|
|
:export:
|
|
|
|
Device Resource Management
|
|
--------------------------
|
|
|
|
.. kernel-doc:: drivers/base/devres.c
|
|
:export:
|
|
|