linux/Documentation/driver-api/basics.rst
Randy Dunlap 1884847909 Docs: driver-api/basics: add kobject_event interfaces
Add the kernel-doc comments from lib/kobject_uevent.c to the
"Kernel objects manipulation" section of driver API Basics.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Rafael J. Wysocki <rafael@kernel.org>
Cc: Danilo Krummrich <dakr@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20250509005538.685678-1-rdunlap@infradead.org>
2025-05-19 08:02:14 -06:00

133 lines
2.2 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:
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/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: