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 475e720172SJonathan CorbetConcurrency primitives 485e720172SJonathan Corbet====================== 495e720172SJonathan Corbet 505e720172SJonathan CorbetHow Linux keeps everything from happening at the same time. See 51*a822b2eeSMauro Carvalho ChehabDocumentation/locking/index.rst for more related documentation. 525e720172SJonathan Corbet 535e720172SJonathan Corbet.. toctree:: 545e720172SJonathan Corbet :maxdepth: 1 555e720172SJonathan Corbet 565e720172SJonathan Corbet refcount-vs-atomic 57e00b0ab8SMauro Carvalho Chehab irq/index 585e720172SJonathan Corbet local_ops 595e720172SJonathan Corbet padata 605e720172SJonathan Corbet ../RCU/index 615e720172SJonathan Corbet 625e720172SJonathan CorbetLow-level hardware management 635e720172SJonathan Corbet============================= 645e720172SJonathan Corbet 655e720172SJonathan CorbetCache management, managing CPU hotplug, etc. 665e720172SJonathan Corbet 675e720172SJonathan Corbet.. toctree:: 685e720172SJonathan Corbet :maxdepth: 1 695e720172SJonathan Corbet 705e720172SJonathan Corbet cachetlb 715e720172SJonathan Corbet cpu_hotplug 725e720172SJonathan Corbet memory-hotplug 735e720172SJonathan Corbet genericirq 745e720172SJonathan Corbet protection-keys 755e720172SJonathan Corbet 765e720172SJonathan CorbetMemory management 775e720172SJonathan Corbet================= 785e720172SJonathan Corbet 795e720172SJonathan CorbetHow to allocate and use memory in the kernel. Note that there is a lot 80*a822b2eeSMauro Carvalho Chehabmore memory-management documentation in Documentation/vm/index.rst. 815e720172SJonathan Corbet 825e720172SJonathan Corbet.. toctree:: 835e720172SJonathan Corbet :maxdepth: 1 845e720172SJonathan Corbet 8552272c92SMike Rapoport memory-allocation 86c9b54d6fSMauro Carvalho Chehab unaligned-memory-access 87728c1471SMauro Carvalho Chehab dma-api 88728c1471SMauro Carvalho Chehab dma-api-howto 89728c1471SMauro Carvalho Chehab dma-attributes 90728c1471SMauro Carvalho Chehab dma-isa-lpc 9141f35b39SMike Rapoport mm-api 925e720172SJonathan Corbet genalloc 93eddb1c22SJohn Hubbard pin_user_pages 94ae9d8845SMike Rapoport boot-time-mm 955e720172SJonathan Corbet gfp_mask-from-fs-io 96e7f08ffbSSilvio Fricke 9793dc3a11SJonathan CorbetInterfaces for kernel debugging 9893dc3a11SJonathan Corbet=============================== 9993dc3a11SJonathan Corbet 10093dc3a11SJonathan Corbet.. toctree:: 10193dc3a11SJonathan Corbet :maxdepth: 1 10293dc3a11SJonathan Corbet 10393dc3a11SJonathan Corbet debug-objects 104d6ba7a9cSJonathan Corbet tracepoint 105a74e2a22SMauro Carvalho Chehab debugging-via-ohci1394 10693dc3a11SJonathan Corbet 1075e720172SJonathan CorbetEverything else 1085e720172SJonathan Corbet=============== 1095e720172SJonathan Corbet 1105e720172SJonathan CorbetDocuments that don't fit elsewhere or which have yet to be categorized. 1115e720172SJonathan Corbet 1125e720172SJonathan Corbet.. toctree:: 1135e720172SJonathan Corbet :maxdepth: 1 1145e720172SJonathan Corbet 1155e720172SJonathan Corbet librs 1165e720172SJonathan Corbet 1179c970ab5SMauro Carvalho Chehab.. only:: subproject and html 11824755a55SSilvio Fricke 11924755a55SSilvio Fricke Indices 12024755a55SSilvio Fricke ======= 12124755a55SSilvio Fricke 12224755a55SSilvio Fricke * :ref:`genindex` 123