2016-10-28 08:14:10 +00:00
|
|
|
======================
|
2016-11-19 00:06:13 +00:00
|
|
|
Core API Documentation
|
2016-10-28 08:14:10 +00:00
|
|
|
======================
|
|
|
|
|
|
2016-11-19 00:06:13 +00:00
|
|
|
This is the beginning of a manual for core kernel APIs. The conversion
|
|
|
|
|
(and writing!) of documents for this manual is much appreciated!
|
|
|
|
|
|
|
|
|
|
Core utilities
|
|
|
|
|
==============
|
2016-10-28 08:14:10 +00:00
|
|
|
|
2020-03-02 22:17:17 +00:00
|
|
|
This section has general and "core core" documentation. The first is a
|
|
|
|
|
massive grab-bag of kerneldoc info left over from the docbook days; it
|
|
|
|
|
should really be broken up someday when somebody finds the energy to do
|
|
|
|
|
it.
|
|
|
|
|
|
2016-10-28 08:14:10 +00:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
2017-03-30 20:11:32 +00:00
|
|
|
kernel-api
|
2020-03-02 22:17:17 +00:00
|
|
|
workqueue
|
2020-04-03 09:36:17 +00:00
|
|
|
printk-basics
|
2020-03-02 22:17:17 +00:00
|
|
|
printk-formats
|
|
|
|
|
symbol-namespaces
|
|
|
|
|
|
|
|
|
|
Data structures and low-level utilities
|
|
|
|
|
=======================================
|
|
|
|
|
|
|
|
|
|
Library functionality that is used throughout the kernel.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
2020-02-25 22:21:25 +00:00
|
|
|
kobject
|
2016-11-28 17:30:53 +00:00
|
|
|
assoc_array
|
2020-03-02 22:17:17 +00:00
|
|
|
xarray
|
|
|
|
|
idr
|
|
|
|
|
circular-buffers
|
2020-04-01 17:33:43 +00:00
|
|
|
rbtree
|
2020-03-02 22:17:17 +00:00
|
|
|
generic-radix-tree
|
|
|
|
|
packing
|
|
|
|
|
timekeeping
|
|
|
|
|
errseq
|
|
|
|
|
|
|
|
|
|
Concurrency primitives
|
|
|
|
|
======================
|
|
|
|
|
|
|
|
|
|
How Linux keeps everything from happening at the same time. See
|
|
|
|
|
:doc:`/locking/index` for more related documentation.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
2016-11-28 17:30:55 +00:00
|
|
|
atomic_ops
|
2017-12-05 10:46:35 +00:00
|
|
|
refcount-vs-atomic
|
2020-05-01 15:37:51 +00:00
|
|
|
irq/index
|
2016-11-28 17:30:54 +00:00
|
|
|
local_ops
|
2020-03-02 22:17:17 +00:00
|
|
|
padata
|
|
|
|
|
../RCU/index
|
|
|
|
|
|
|
|
|
|
Low-level hardware management
|
|
|
|
|
=============================
|
|
|
|
|
|
|
|
|
|
Cache management, managing CPU hotplug, etc.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
|
|
cachetlb
|
|
|
|
|
cpu_hotplug
|
|
|
|
|
memory-hotplug
|
2017-03-30 20:11:30 +00:00
|
|
|
genericirq
|
2020-03-02 22:17:17 +00:00
|
|
|
protection-keys
|
|
|
|
|
|
|
|
|
|
Memory management
|
|
|
|
|
=================
|
|
|
|
|
|
|
|
|
|
How to allocate and use memory in the kernel. Note that there is a lot
|
|
|
|
|
more memory-management documentation in :doc:`/vm/index`.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
2018-09-14 09:27:58 +00:00
|
|
|
memory-allocation
|
2020-05-01 15:37:45 +00:00
|
|
|
dma-api
|
|
|
|
|
dma-api-howto
|
|
|
|
|
dma-attributes
|
|
|
|
|
dma-isa-lpc
|
2018-08-24 00:01:12 +00:00
|
|
|
mm-api
|
2020-03-02 22:17:17 +00:00
|
|
|
genalloc
|
2020-01-31 06:12:54 +00:00
|
|
|
pin_user_pages
|
2018-06-30 14:55:06 +00:00
|
|
|
boot-time-mm
|
2020-03-02 22:17:17 +00:00
|
|
|
gfp_mask-from-fs-io
|
2016-10-28 08:14:11 +00:00
|
|
|
|
2016-11-19 00:06:13 +00:00
|
|
|
Interfaces for kernel debugging
|
|
|
|
|
===============================
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
2016-11-19 00:21:32 +00:00
|
|
|
debug-objects
|
|
|
|
|
tracepoint
|
2020-05-01 15:37:50 +00:00
|
|
|
debugging-via-ohci1394
|
2016-11-19 00:06:13 +00:00
|
|
|
|
2020-03-02 22:17:17 +00:00
|
|
|
Everything else
|
|
|
|
|
===============
|
|
|
|
|
|
|
|
|
|
Documents that don't fit elsewhere or which have yet to be categorized.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
|
|
librs
|
|
|
|
|
|
2019-07-26 12:51:29 +00:00
|
|
|
.. only:: subproject and html
|
2016-10-28 08:14:10 +00:00
|
|
|
|
|
|
|
|
Indices
|
|
|
|
|
=======
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
