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 2190c165f0SRicardo Cañuelo printk-basics 225e720172SJonathan Corbet printk-formats 235e720172SJonathan Corbet symbol-namespaces 245e720172SJonathan Corbet 255e720172SJonathan CorbetData structures and low-level utilities 265e720172SJonathan Corbet======================================= 275e720172SJonathan Corbet 285e720172SJonathan CorbetLibrary functionality that is used throughout the kernel. 295e720172SJonathan Corbet 305e720172SJonathan Corbet.. toctree:: 315e720172SJonathan Corbet :maxdepth: 1 325e720172SJonathan Corbet 335fed00dcSSameer Rahmani kobject 341ac00669SMauro Carvalho Chehab kref 35c3cbf1a7SSilvio Fricke assoc_array 36992a8e60SMatthew Wilcox xarray 375e720172SJonathan Corbet idr 38d8a121e3SMauro Carvalho Chehab circular-buffers 3914bbe3e3SMatthew Wilcox (Oracle) rbtree 40ba20ba2eSKent Overstreet generic-radix-tree 415e720172SJonathan Corbet packing 42c9b54d6fSMauro Carvalho Chehab bus-virt-phys-mapping 43c9b54d6fSMauro Carvalho Chehab this_cpu_ops 445e720172SJonathan Corbet timekeeping 455e720172SJonathan Corbet errseq 465e720172SJonathan Corbet 47*bf026e2eSThomas GleixnerLow level entry and exit 48*bf026e2eSThomas Gleixner======================== 49*bf026e2eSThomas Gleixner 50*bf026e2eSThomas Gleixner.. toctree:: 51*bf026e2eSThomas Gleixner :maxdepth: 1 52*bf026e2eSThomas Gleixner 53*bf026e2eSThomas Gleixner entry 54*bf026e2eSThomas Gleixner 555e720172SJonathan CorbetConcurrency primitives 565e720172SJonathan Corbet====================== 575e720172SJonathan Corbet 585e720172SJonathan CorbetHow Linux keeps everything from happening at the same time. See 59a822b2eeSMauro Carvalho ChehabDocumentation/locking/index.rst for more related documentation. 605e720172SJonathan Corbet 615e720172SJonathan Corbet.. toctree:: 625e720172SJonathan Corbet :maxdepth: 1 635e720172SJonathan Corbet 645e720172SJonathan Corbet refcount-vs-atomic 65e00b0ab8SMauro Carvalho Chehab irq/index 665e720172SJonathan Corbet local_ops 675e720172SJonathan Corbet padata 685e720172SJonathan Corbet ../RCU/index 695e720172SJonathan Corbet 705e720172SJonathan CorbetLow-level hardware management 715e720172SJonathan Corbet============================= 725e720172SJonathan Corbet 735e720172SJonathan CorbetCache management, managing CPU hotplug, etc. 745e720172SJonathan Corbet 755e720172SJonathan Corbet.. toctree:: 765e720172SJonathan Corbet :maxdepth: 1 775e720172SJonathan Corbet 785e720172SJonathan Corbet cachetlb 795e720172SJonathan Corbet cpu_hotplug 805e720172SJonathan Corbet memory-hotplug 815e720172SJonathan Corbet genericirq 825e720172SJonathan Corbet protection-keys 835e720172SJonathan Corbet 845e720172SJonathan CorbetMemory management 855e720172SJonathan Corbet================= 865e720172SJonathan Corbet 875e720172SJonathan CorbetHow to allocate and use memory in the kernel. Note that there is a lot 88a822b2eeSMauro Carvalho Chehabmore memory-management documentation in Documentation/vm/index.rst. 895e720172SJonathan Corbet 905e720172SJonathan Corbet.. toctree:: 915e720172SJonathan Corbet :maxdepth: 1 925e720172SJonathan Corbet 9352272c92SMike Rapoport memory-allocation 94c9b54d6fSMauro Carvalho Chehab unaligned-memory-access 95728c1471SMauro Carvalho Chehab dma-api 96728c1471SMauro Carvalho Chehab dma-api-howto 97728c1471SMauro Carvalho Chehab dma-attributes 98728c1471SMauro Carvalho Chehab dma-isa-lpc 9941f35b39SMike Rapoport mm-api 1005e720172SJonathan Corbet genalloc 101eddb1c22SJohn Hubbard pin_user_pages 102ae9d8845SMike Rapoport boot-time-mm 1035e720172SJonathan Corbet gfp_mask-from-fs-io 104e7f08ffbSSilvio Fricke 10593dc3a11SJonathan CorbetInterfaces for kernel debugging 10693dc3a11SJonathan Corbet=============================== 10793dc3a11SJonathan Corbet 10893dc3a11SJonathan Corbet.. toctree:: 10993dc3a11SJonathan Corbet :maxdepth: 1 11093dc3a11SJonathan Corbet 11193dc3a11SJonathan Corbet debug-objects 112d6ba7a9cSJonathan Corbet tracepoint 113a74e2a22SMauro Carvalho Chehab debugging-via-ohci1394 11493dc3a11SJonathan Corbet 1155e720172SJonathan CorbetEverything else 1165e720172SJonathan Corbet=============== 1175e720172SJonathan Corbet 1185e720172SJonathan CorbetDocuments that don't fit elsewhere or which have yet to be categorized. 1195e720172SJonathan Corbet 1205e720172SJonathan Corbet.. toctree:: 1215e720172SJonathan Corbet :maxdepth: 1 1225e720172SJonathan Corbet 1235e720172SJonathan Corbet librs 1245e720172SJonathan Corbet 1259c970ab5SMauro Carvalho Chehab.. only:: subproject and html 12624755a55SSilvio Fricke 12724755a55SSilvio Fricke Indices 12824755a55SSilvio Fricke ======= 12924755a55SSilvio Fricke 13024755a55SSilvio Fricke * :ref:`genindex` 131