Documentation/core-api/kernel-api.rst

   1 ====================
   2 The Linux Kernel API
   3 ====================
   4
   5
   6 List Management Functions
   7 =========================
   8
   9 .. kernel-doc:: include/linux/list.h
  10    :internal:
  11
  12 Basic C Library Functions
  13 =========================
  14
  15 When writing drivers, you cannot in general use routines which are from
  16 the C Library. Some of the functions have been found generally useful
  17 and they are listed below. The behaviour of these functions may vary
  18 slightly from those defined by ANSI, and these deviations are noted in
  19 the text.
  20
  21 String Conversions
  22 ------------------
  23
  24 .. kernel-doc:: lib/vsprintf.c
  25    :export:
  26
  27 .. kernel-doc:: include/linux/kernel.h
  28    :functions: kstrtol
  29
  30 .. kernel-doc:: include/linux/kernel.h
  31    :functions: kstrtoul
  32
  33 .. kernel-doc:: lib/kstrtox.c
  34    :export:
  35
  36 String Manipulation
  37 -------------------
  38
  39 .. kernel-doc:: lib/string.c
  40    :export:
  41
  42 Bit Operations
  43 --------------
  44
  45 .. kernel-doc:: arch/x86/include/asm/bitops.h
  46    :internal:
  47
  48 Basic Kernel Library Functions
  49 ==============================
  50
  51 The Linux kernel provides more basic utility functions.
  52
  53 Bitmap Operations
  54 -----------------
  55
  56 .. kernel-doc:: lib/bitmap.c
  57    :doc: bitmap introduction
  58
  59 .. kernel-doc:: include/linux/bitmap.h
  60    :doc: declare bitmap
  61
  62 .. kernel-doc:: include/linux/bitmap.h
  63    :doc: bitmap overview
  64
  65 .. kernel-doc:: include/linux/bitmap.h
  66    :doc: bitmap bitops
  67
  68 .. kernel-doc:: lib/bitmap.c
  69    :export:
  70
  71 .. kernel-doc:: lib/bitmap.c
  72    :internal:
  73
  74 .. kernel-doc:: include/linux/bitmap.h
  75    :internal:
  76
  77 Command-line Parsing
  78 --------------------
  79
  80 .. kernel-doc:: lib/cmdline.c
  81    :export:
  82
  83 CRC Functions
  84 -------------
  85
  86 .. kernel-doc:: lib/crc4.c
  87    :export:
  88
  89 .. kernel-doc:: lib/crc7.c
  90    :export:
  91
  92 .. kernel-doc:: lib/crc8.c
  93    :export:
  94
  95 .. kernel-doc:: lib/crc16.c
  96    :export:
  97
  98 .. kernel-doc:: lib/crc32.c
  99
 100 .. kernel-doc:: lib/crc-ccitt.c
 101    :export:
 102
 103 .. kernel-doc:: lib/crc-itu-t.c
 104    :export:
 105
 106 idr/ida Functions
 107 -----------------
 108
 109 .. kernel-doc:: include/linux/idr.h
 110    :doc: idr sync
 111
 112 .. kernel-doc:: lib/idr.c
 113    :doc: IDA description
 114
 115 .. kernel-doc:: lib/idr.c
 116    :export:
 117
 118 Math Functions in Linux
 119 =======================
 120
 121 Base 2 log and power Functions
 122 ------------------------------
 123
 124 .. kernel-doc:: include/linux/log2.h
 125    :internal:
 126
 127 Division Functions
 128 ------------------
 129
 130 .. kernel-doc:: include/asm-generic/div64.h
 131    :functions: do_div
 132
 133 .. kernel-doc:: include/linux/math64.h
 134    :internal:
 135
 136 .. kernel-doc:: lib/div64.c
 137    :functions: div_s64_rem div64_u64_rem div64_u64 div64_s64
 138
 139 .. kernel-doc:: lib/gcd.c
 140    :export:
 141
 142 Sorting
 143 -------
 144
 145 .. kernel-doc:: lib/sort.c
 146    :export:
 147
 148 .. kernel-doc:: lib/list_sort.c
 149    :export:
 150
 151 UUID/GUID
 152 ---------
 153
 154 .. kernel-doc:: lib/uuid.c
 155    :export:
 156
 157 Memory Management in Linux
 158 ==========================
 159
 160 The Slab Cache
 161 --------------
 162
 163 .. kernel-doc:: include/linux/slab.h
 164    :internal:
 165
 166 .. kernel-doc:: mm/slab.c
 167    :export:
 168
 169 .. kernel-doc:: mm/util.c
 170    :export:
 171
 172 User Space Memory Access
 173 ------------------------
 174
 175 .. kernel-doc:: arch/x86/include/asm/uaccess.h
 176    :internal:
 177
 178 .. kernel-doc:: arch/x86/lib/usercopy_32.c
 179    :export:
 180
 181 More Memory Management Functions
 182 --------------------------------
 183
 184 .. kernel-doc:: mm/readahead.c
 185    :export:
 186
 187 .. kernel-doc:: mm/filemap.c
 188    :export:
 189
 190 .. kernel-doc:: mm/memory.c
 191    :export:
 192
 193 .. kernel-doc:: mm/vmalloc.c
 194    :export:
 195
 196 .. kernel-doc:: mm/page_alloc.c
 197    :internal:
 198
 199 .. kernel-doc:: mm/mempool.c
 200    :export:
 201
 202 .. kernel-doc:: mm/dmapool.c
 203    :export:
 204
 205 .. kernel-doc:: mm/page-writeback.c
 206    :export:
 207
 208 .. kernel-doc:: mm/truncate.c
 209    :export:
 210
 211 Kernel IPC facilities
 212 =====================
 213
 214 IPC utilities
 215 -------------
 216
 217 .. kernel-doc:: ipc/util.c
 218    :internal:
 219
 220 FIFO Buffer
 221 ===========
 222
 223 kfifo interface
 224 ---------------
 225
 226 .. kernel-doc:: include/linux/kfifo.h
 227    :internal:
 228
 229 relay interface support
 230 =======================
 231
 232 Relay interface support is designed to provide an efficient mechanism
 233 for tools and facilities to relay large amounts of data from kernel
 234 space to user space.
 235
 236 relay interface
 237 ---------------
 238
 239 .. kernel-doc:: kernel/relay.c
 240    :export:
 241
 242 .. kernel-doc:: kernel/relay.c
 243    :internal:
 244
 245 Module Support
 246 ==============
 247
 248 Module Loading
 249 --------------
 250
 251 .. kernel-doc:: kernel/kmod.c
 252    :export:
 253
 254 Inter Module support
 255 --------------------
 256
 257 Refer to the file kernel/module.c for more information.
 258
 259 Hardware Interfaces
 260 ===================
 261
 262 Interrupt Handling
 263 ------------------
 264
 265 .. kernel-doc:: kernel/irq/manage.c
 266    :export:
 267
 268 DMA Channels
 269 ------------
 270
 271 .. kernel-doc:: kernel/dma.c
 272    :export:
 273
 274 Resources Management
 275 --------------------
 276
 277 .. kernel-doc:: kernel/resource.c
 278    :internal:
 279
 280 .. kernel-doc:: kernel/resource.c
 281    :export:
 282
 283 MTRR Handling
 284 -------------
 285
 286 .. kernel-doc:: arch/x86/kernel/cpu/mtrr/main.c
 287    :export:
 288
 289 Security Framework
 290 ==================
 291
 292 .. kernel-doc:: security/security.c
 293    :internal:
 294
 295 .. kernel-doc:: security/inode.c
 296    :export:
 297
 298 Audit Interfaces
 299 ================
 300
 301 .. kernel-doc:: kernel/audit.c
 302    :export:
 303
 304 .. kernel-doc:: kernel/auditsc.c
 305    :internal:
 306
 307 .. kernel-doc:: kernel/auditfilter.c
 308    :internal:
 309
 310 Accounting Framework
 311 ====================
 312
 313 .. kernel-doc:: kernel/acct.c
 314    :internal:
 315
 316 Block Devices
 317 =============
 318
 319 .. kernel-doc:: block/blk-core.c
 320    :export:
 321
 322 .. kernel-doc:: block/blk-core.c
 323    :internal:
 324
 325 .. kernel-doc:: block/blk-map.c
 326    :export:
 327
 328 .. kernel-doc:: block/blk-sysfs.c
 329    :internal:
 330
 331 .. kernel-doc:: block/blk-settings.c
 332    :export:
 333
 334 .. kernel-doc:: block/blk-exec.c
 335    :export:
 336
 337 .. kernel-doc:: block/blk-flush.c
 338    :export:
 339
 340 .. kernel-doc:: block/blk-lib.c
 341    :export:
 342
 343 .. kernel-doc:: block/blk-tag.c
 344    :export:
 345
 346 .. kernel-doc:: block/blk-tag.c
 347    :internal:
 348
 349 .. kernel-doc:: block/blk-integrity.c
 350    :export:
 351
 352 .. kernel-doc:: kernel/trace/blktrace.c
 353    :internal:
 354
 355 .. kernel-doc:: block/genhd.c
 356    :internal:
 357
 358 .. kernel-doc:: block/genhd.c
 359    :export:
 360
 361 Char devices
 362 ============
 363
 364 .. kernel-doc:: fs/char_dev.c
 365    :export:
 366
 367 Clock Framework
 368 ===============
 369
 370 The clock framework defines programming interfaces to support software
 371 management of the system clock tree. This framework is widely used with
 372 System-On-Chip (SOC) platforms to support power management and various
 373 devices which may need custom clock rates. Note that these "clocks"
 374 don't relate to timekeeping or real time clocks (RTCs), each of which
 375 have separate frameworks. These :c:type:`struct clk <clk>`
 376 instances may be used to manage for example a 96 MHz signal that is used
 377 to shift bits into and out of peripherals or busses, or otherwise
 378 trigger synchronous state machine transitions in system hardware.
 379
 380 Power management is supported by explicit software clock gating: unused
 381 clocks are disabled, so the system doesn't waste power changing the
 382 state of transistors that aren't in active use. On some systems this may
 383 be backed by hardware clock gating, where clocks are gated without being
 384 disabled in software. Sections of chips that are powered but not clocked
 385 may be able to retain their last state. This low power state is often
 386 called a *retention mode*. This mode still incurs leakage currents,
 387 especially with finer circuit geometries, but for CMOS circuits power is
 388 mostly used by clocked state changes.
 389
 390 Power-aware drivers only enable their clocks when the device they manage
 391 is in active use. Also, system sleep states often differ according to
 392 which clock domains are active: while a "standby" state may allow wakeup
 393 from several active domains, a "mem" (suspend-to-RAM) state may require
 394 a more wholesale shutdown of clocks derived from higher speed PLLs and
 395 oscillators, limiting the number of possible wakeup event sources. A
 396 driver's suspend method may need to be aware of system-specific clock
 397 constraints on the target sleep state.
 398
 399 Some platforms support programmable clock generators. These can be used
 400 by external chips of various kinds, such as other CPUs, multimedia
 401 codecs, and devices with strict requirements for interface clocking.
 402
 403 .. kernel-doc:: include/linux/clk.h
 404    :internal:
 405
 406 Synchronization Primitives
 407 ==========================
 408
 409 Read-Copy Update (RCU)
 410 ----------------------
 411
 412 .. kernel-doc:: include/linux/rcupdate.h
 413
 414 .. kernel-doc:: include/linux/rcupdate_wait.h
 415
 416 .. kernel-doc:: include/linux/rcutree.h
 417
 418 .. kernel-doc:: kernel/rcu/tree.c
 419
 420 .. kernel-doc:: kernel/rcu/tree_plugin.h
 421
 422 .. kernel-doc:: kernel/rcu/tree_exp.h
 423
 424 .. kernel-doc:: kernel/rcu/update.c
 425
 426 .. kernel-doc:: include/linux/srcu.h
 427
 428 .. kernel-doc:: kernel/rcu/srcutree.c
 429
 430 .. kernel-doc:: include/linux/rculist_bl.h
 431
 432 .. kernel-doc:: include/linux/rculist.h
 433
 434 .. kernel-doc:: include/linux/rculist_nulls.h
 435
 436 .. kernel-doc:: include/linux/rcu_sync.h
 437
 438 .. kernel-doc:: kernel/rcu/sync.c
 439