Files
linux/Documentation/driver-api/basics.rst
Matthew Wilcox (Oracle) b55cc244d0 percpu_ref: fix documentation of maximum value
Tejun changd percpu_ref to use long instead of int back in 2014 but missed
updating this bit of the documentation.  Also add the documentation to the
htmldocs.

Link: https://lore.kernel.org/20241211204017.184512-1-willy@infradead.org
Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
Acked-by: Tejun Heo <tj@kernel.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
2026-07-28 21:11:55 -07:00

152 lines
2.6 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 and scheduling 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:
Time and timer routines
-----------------------
.. kernel-doc:: include/linux/jiffies.h
:internal:
.. kernel-doc:: kernel/time/time.c
:export:
.. kernel-doc:: kernel/time/timer.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:
Wait queues and Wake events
---------------------------
.. kernel-doc:: include/linux/wait.h
:internal:
.. kernel-doc:: kernel/sched/wait.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:
.. kernel-doc:: include/linux/percpu-refcount.h
.. kernel-doc:: lib/percpu-refcount.c
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-doc:: lib/kobject_uevent.c
:export:
Kernel utility functions
------------------------
.. kernel-doc:: include/linux/array_size.h
:internal:
.. kernel-doc:: include/linux/container_of.h
:internal:
.. kernel-doc:: include/linux/kstrtox.h
:internal:
:no-identifiers: kstrtol kstrtoul
.. kernel-doc:: include/linux/stddef.h
:internal:
.. kernel-doc:: include/linux/util_macros.h
:internal:
.. kernel-doc:: include/linux/wordpart.h
:internal:
.. 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: