124755a55SSilvio Fricke====================== 293dc3a11SJonathan CorbetCore API Documentation 324755a55SSilvio Fricke====================== 424755a55SSilvio Fricke 593dc3a11SJonathan CorbetThis is the beginning of a manual for core kernel APIs. The conversion 693dc3a11SJonathan Corbet(and writing!) of documents for this manual is much appreciated! 793dc3a11SJonathan Corbet 893dc3a11SJonathan CorbetCore utilities 993dc3a11SJonathan Corbet============== 1024755a55SSilvio Fricke 115e720172SJonathan CorbetThis section has general and "core core" documentation. The first is a 125e720172SJonathan Corbetmassive grab-bag of kerneldoc info left over from the docbook days; it 135e720172SJonathan Corbetshould really be broken up someday when somebody finds the energy to do 145e720172SJonathan Corbetit. 155e720172SJonathan Corbet 1624755a55SSilvio Fricke.. toctree:: 1724755a55SSilvio Fricke :maxdepth: 1 1824755a55SSilvio Fricke 19baca8a0cSMauro Carvalho Chehab kernel-api 205e720172SJonathan Corbet workqueue 21f5461124SRandy Dunlap watch_queue 2290c165f0SRicardo Cañuelo printk-basics 235e720172SJonathan Corbet printk-formats 24a5c7a39fSPetr Mladek printk-index 255e720172SJonathan Corbet symbol-namespaces 265e720172SJonathan Corbet 275e720172SJonathan CorbetData structures and low-level utilities 285e720172SJonathan Corbet======================================= 295e720172SJonathan Corbet 305e720172SJonathan CorbetLibrary functionality that is used throughout the kernel. 315e720172SJonathan Corbet 325e720172SJonathan Corbet.. toctree:: 335e720172SJonathan Corbet :maxdepth: 1 345e720172SJonathan Corbet 355fed00dcSSameer Rahmani kobject 361ac00669SMauro Carvalho Chehab kref 37c3cbf1a7SSilvio Fricke assoc_array 38992a8e60SMatthew Wilcox xarray 39*54a611b6SLiam R. Howlett maple_tree 405e720172SJonathan Corbet idr 41d8a121e3SMauro Carvalho Chehab circular-buffers 4214bbe3e3SMatthew Wilcox (Oracle) rbtree 43ba20ba2eSKent Overstreet generic-radix-tree 445e720172SJonathan Corbet packing 45c9b54d6fSMauro Carvalho Chehab this_cpu_ops 465e720172SJonathan Corbet timekeeping 475e720172SJonathan Corbet errseq 485e720172SJonathan Corbet 49bf026e2eSThomas GleixnerLow level entry and exit 50bf026e2eSThomas Gleixner======================== 51bf026e2eSThomas Gleixner 52bf026e2eSThomas Gleixner.. toctree:: 53bf026e2eSThomas Gleixner :maxdepth: 1 54bf026e2eSThomas Gleixner 55bf026e2eSThomas Gleixner entry 56bf026e2eSThomas Gleixner 575e720172SJonathan CorbetConcurrency primitives 585e720172SJonathan Corbet====================== 595e720172SJonathan Corbet 605e720172SJonathan CorbetHow Linux keeps everything from happening at the same time. See 61a822b2eeSMauro Carvalho ChehabDocumentation/locking/index.rst for more related documentation. 625e720172SJonathan Corbet 635e720172SJonathan Corbet.. toctree:: 645e720172SJonathan Corbet :maxdepth: 1 655e720172SJonathan Corbet 665e720172SJonathan Corbet refcount-vs-atomic 67e00b0ab8SMauro Carvalho Chehab irq/index 685e720172SJonathan Corbet local_ops 695e720172SJonathan Corbet padata 705e720172SJonathan Corbet ../RCU/index 715e720172SJonathan Corbet 725e720172SJonathan CorbetLow-level hardware management 735e720172SJonathan Corbet============================= 745e720172SJonathan Corbet 755e720172SJonathan CorbetCache management, managing CPU hotplug, etc. 765e720172SJonathan Corbet 775e720172SJonathan Corbet.. toctree:: 785e720172SJonathan Corbet :maxdepth: 1 795e720172SJonathan Corbet 805e720172SJonathan Corbet cachetlb 815e720172SJonathan Corbet cpu_hotplug 825e720172SJonathan Corbet memory-hotplug 835e720172SJonathan Corbet genericirq 845e720172SJonathan Corbet protection-keys 855e720172SJonathan Corbet 865e720172SJonathan CorbetMemory management 875e720172SJonathan Corbet================= 885e720172SJonathan Corbet 895e720172SJonathan CorbetHow to allocate and use memory in the kernel. Note that there is a lot 90ee65728eSMike Rapoportmore memory-management documentation in Documentation/mm/index.rst. 915e720172SJonathan Corbet 925e720172SJonathan Corbet.. toctree:: 935e720172SJonathan Corbet :maxdepth: 1 945e720172SJonathan Corbet 9552272c92SMike Rapoport memory-allocation 96c9b54d6fSMauro Carvalho Chehab unaligned-memory-access 97728c1471SMauro Carvalho Chehab dma-api 98728c1471SMauro Carvalho Chehab dma-api-howto 99728c1471SMauro Carvalho Chehab dma-attributes 100728c1471SMauro Carvalho Chehab dma-isa-lpc 10141f35b39SMike Rapoport mm-api 1025e720172SJonathan Corbet genalloc 103eddb1c22SJohn Hubbard pin_user_pages 104ae9d8845SMike Rapoport boot-time-mm 1055e720172SJonathan Corbet gfp_mask-from-fs-io 106e7f08ffbSSilvio Fricke 10793dc3a11SJonathan CorbetInterfaces for kernel debugging 10893dc3a11SJonathan Corbet=============================== 10993dc3a11SJonathan Corbet 11093dc3a11SJonathan Corbet.. toctree:: 11193dc3a11SJonathan Corbet :maxdepth: 1 11293dc3a11SJonathan Corbet 11393dc3a11SJonathan Corbet debug-objects 114d6ba7a9cSJonathan Corbet tracepoint 115a74e2a22SMauro Carvalho Chehab debugging-via-ohci1394 11693dc3a11SJonathan Corbet 1175e720172SJonathan CorbetEverything else 1185e720172SJonathan Corbet=============== 1195e720172SJonathan Corbet 1205e720172SJonathan CorbetDocuments that don't fit elsewhere or which have yet to be categorized. 1215e720172SJonathan Corbet 1225e720172SJonathan Corbet.. toctree:: 1235e720172SJonathan Corbet :maxdepth: 1 1245e720172SJonathan Corbet 1255e720172SJonathan Corbet librs 1265e720172SJonathan Corbet 1279c970ab5SMauro Carvalho Chehab.. only:: subproject and html 12824755a55SSilvio Fricke 12924755a55SSilvio Fricke Indices 13024755a55SSilvio Fricke ======= 13124755a55SSilvio Fricke 13224755a55SSilvio Fricke * :ref:`genindex` 133