1====================== 2Core API Documentation 3====================== 4 5This is the beginning of a manual for core kernel APIs. The conversion 6(and writing!) of documents for this manual is much appreciated! 7 8Core utilities 9============== 10 11This section has general and "core core" documentation. The first is a 12massive grab-bag of kerneldoc info left over from the docbook days; it 13should really be broken up someday when somebody finds the energy to do 14it. 15 16.. toctree:: 17 :maxdepth: 1 18 19 kernel-api 20 workqueue 21 printk-basics 22 printk-formats 23 symbol-namespaces 24 25Data structures and low-level utilities 26======================================= 27 28Library functionality that is used throughout the kernel. 29 30.. toctree:: 31 :maxdepth: 1 32 33 kobject 34 kref 35 assoc_array 36 xarray 37 idr 38 circular-buffers 39 rbtree 40 generic-radix-tree 41 packing 42 bus-virt-phys-mapping 43 this_cpu_ops 44 timekeeping 45 errseq 46 47Concurrency primitives 48====================== 49 50How Linux keeps everything from happening at the same time. See 51:doc:`/locking/index` for more related documentation. 52 53.. toctree:: 54 :maxdepth: 1 55 56 atomic_ops 57 refcount-vs-atomic 58 irq/index 59 local_ops 60 padata 61 ../RCU/index 62 63Low-level hardware management 64============================= 65 66Cache management, managing CPU hotplug, etc. 67 68.. toctree:: 69 :maxdepth: 1 70 71 cachetlb 72 cpu_hotplug 73 memory-hotplug 74 genericirq 75 protection-keys 76 77Memory management 78================= 79 80How to allocate and use memory in the kernel. Note that there is a lot 81more memory-management documentation in :doc:`/vm/index`. 82 83.. toctree:: 84 :maxdepth: 1 85 86 memory-allocation 87 unaligned-memory-access 88 dma-api 89 dma-api-howto 90 dma-attributes 91 dma-isa-lpc 92 mm-api 93 genalloc 94 pin_user_pages 95 boot-time-mm 96 gfp_mask-from-fs-io 97 98Interfaces for kernel debugging 99=============================== 100 101.. toctree:: 102 :maxdepth: 1 103 104 debug-objects 105 tracepoint 106 debugging-via-ohci1394 107 108Everything else 109=============== 110 111Documents that don't fit elsewhere or which have yet to be categorized. 112 113.. toctree:: 114 :maxdepth: 1 115 116 librs 117 118.. only:: subproject and html 119 120 Indices 121 ======= 122 123 * :ref:`genindex` 124