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 21*f5461124SRandy Dunlap watch_queue 2290c165f0SRicardo Cañuelo printk-basics 235e720172SJonathan Corbet printk-formats 245e720172SJonathan Corbet symbol-namespaces 255e720172SJonathan Corbet 265e720172SJonathan CorbetData structures and low-level utilities 275e720172SJonathan Corbet======================================= 285e720172SJonathan Corbet 295e720172SJonathan CorbetLibrary functionality that is used throughout the kernel. 305e720172SJonathan Corbet 315e720172SJonathan Corbet.. toctree:: 325e720172SJonathan Corbet :maxdepth: 1 335e720172SJonathan Corbet 345fed00dcSSameer Rahmani kobject 351ac00669SMauro Carvalho Chehab kref 36c3cbf1a7SSilvio Fricke assoc_array 37992a8e60SMatthew Wilcox xarray 385e720172SJonathan Corbet idr 39d8a121e3SMauro Carvalho Chehab circular-buffers 4014bbe3e3SMatthew Wilcox (Oracle) rbtree 41ba20ba2eSKent Overstreet generic-radix-tree 425e720172SJonathan Corbet packing 43c9b54d6fSMauro Carvalho Chehab bus-virt-phys-mapping 44c9b54d6fSMauro Carvalho Chehab this_cpu_ops 455e720172SJonathan Corbet timekeeping 465e720172SJonathan Corbet errseq 475e720172SJonathan Corbet 48bf026e2eSThomas GleixnerLow level entry and exit 49bf026e2eSThomas Gleixner======================== 50bf026e2eSThomas Gleixner 51bf026e2eSThomas Gleixner.. toctree:: 52bf026e2eSThomas Gleixner :maxdepth: 1 53bf026e2eSThomas Gleixner 54bf026e2eSThomas Gleixner entry 55bf026e2eSThomas Gleixner 565e720172SJonathan CorbetConcurrency primitives 575e720172SJonathan Corbet====================== 585e720172SJonathan Corbet 595e720172SJonathan CorbetHow Linux keeps everything from happening at the same time. See 60a822b2eeSMauro Carvalho ChehabDocumentation/locking/index.rst for more related documentation. 615e720172SJonathan Corbet 625e720172SJonathan Corbet.. toctree:: 635e720172SJonathan Corbet :maxdepth: 1 645e720172SJonathan Corbet 655e720172SJonathan Corbet refcount-vs-atomic 66e00b0ab8SMauro Carvalho Chehab irq/index 675e720172SJonathan Corbet local_ops 685e720172SJonathan Corbet padata 695e720172SJonathan Corbet ../RCU/index 705e720172SJonathan Corbet 715e720172SJonathan CorbetLow-level hardware management 725e720172SJonathan Corbet============================= 735e720172SJonathan Corbet 745e720172SJonathan CorbetCache management, managing CPU hotplug, etc. 755e720172SJonathan Corbet 765e720172SJonathan Corbet.. toctree:: 775e720172SJonathan Corbet :maxdepth: 1 785e720172SJonathan Corbet 795e720172SJonathan Corbet cachetlb 805e720172SJonathan Corbet cpu_hotplug 815e720172SJonathan Corbet memory-hotplug 825e720172SJonathan Corbet genericirq 835e720172SJonathan Corbet protection-keys 845e720172SJonathan Corbet 855e720172SJonathan CorbetMemory management 865e720172SJonathan Corbet================= 875e720172SJonathan Corbet 885e720172SJonathan CorbetHow to allocate and use memory in the kernel. Note that there is a lot 89a822b2eeSMauro Carvalho Chehabmore memory-management documentation in Documentation/vm/index.rst. 905e720172SJonathan Corbet 915e720172SJonathan Corbet.. toctree:: 925e720172SJonathan Corbet :maxdepth: 1 935e720172SJonathan Corbet 9452272c92SMike Rapoport memory-allocation 95c9b54d6fSMauro Carvalho Chehab unaligned-memory-access 96728c1471SMauro Carvalho Chehab dma-api 97728c1471SMauro Carvalho Chehab dma-api-howto 98728c1471SMauro Carvalho Chehab dma-attributes 99728c1471SMauro Carvalho Chehab dma-isa-lpc 10041f35b39SMike Rapoport mm-api 1015e720172SJonathan Corbet genalloc 102eddb1c22SJohn Hubbard pin_user_pages 103ae9d8845SMike Rapoport boot-time-mm 1045e720172SJonathan Corbet gfp_mask-from-fs-io 105e7f08ffbSSilvio Fricke 10693dc3a11SJonathan CorbetInterfaces for kernel debugging 10793dc3a11SJonathan Corbet=============================== 10893dc3a11SJonathan Corbet 10993dc3a11SJonathan Corbet.. toctree:: 11093dc3a11SJonathan Corbet :maxdepth: 1 11193dc3a11SJonathan Corbet 11293dc3a11SJonathan Corbet debug-objects 113d6ba7a9cSJonathan Corbet tracepoint 114a74e2a22SMauro Carvalho Chehab debugging-via-ohci1394 11593dc3a11SJonathan Corbet 1165e720172SJonathan CorbetEverything else 1175e720172SJonathan Corbet=============== 1185e720172SJonathan Corbet 1195e720172SJonathan CorbetDocuments that don't fit elsewhere or which have yet to be categorized. 1205e720172SJonathan Corbet 1215e720172SJonathan Corbet.. toctree:: 1225e720172SJonathan Corbet :maxdepth: 1 1235e720172SJonathan Corbet 1245e720172SJonathan Corbet librs 1255e720172SJonathan Corbet 1269c970ab5SMauro Carvalho Chehab.. only:: subproject and html 12724755a55SSilvio Fricke 12824755a55SSilvio Fricke Indices 12924755a55SSilvio Fricke ======= 13024755a55SSilvio Fricke 13124755a55SSilvio Fricke * :ref:`genindex` 132