Documentation/driver-api/basics.rst

   1 Driver Basics
   2 =============
   3
   4 Driver Entry and Exit points
   5 ----------------------------
   6
   7 .. kernel-doc:: include/linux/module.h
   8    :internal:
   9
  10 Driver device table
  11 -------------------
  12
  13 .. kernel-doc:: include/linux/mod_devicetable.h
  14    :internal:
  15    :no-identifiers: pci_device_id
  16
  17
  18 Delaying, scheduling, and timer routines
  19 ----------------------------------------
  20
  21 .. kernel-doc:: include/linux/sched.h
  22    :internal:
  23
  24 .. kernel-doc:: kernel/sched/core.c
  25    :export:
  26
  27 .. kernel-doc:: kernel/sched/cpupri.c
  28    :internal:
  29
  30 .. kernel-doc:: kernel/sched/fair.c
  31    :internal:
  32
  33 .. kernel-doc:: include/linux/completion.h
  34    :internal:
  35
  36 .. kernel-doc:: kernel/time/timer.c
  37    :export:
  38
  39 Wait queues and Wake events
  40 ---------------------------
  41
  42 .. kernel-doc:: include/linux/wait.h
  43    :internal:
  44
  45 .. kernel-doc:: kernel/sched/wait.c
  46    :export:
  47
  48 High-resolution timers
  49 ----------------------
  50
  51 .. kernel-doc:: include/linux/ktime.h
  52    :internal:
  53
  54 .. kernel-doc:: include/linux/hrtimer.h
  55    :internal:
  56
  57 .. kernel-doc:: kernel/time/hrtimer.c
  58    :export:
  59
  60 Internal Functions
  61 ------------------
  62
  63 .. kernel-doc:: kernel/exit.c
  64    :internal:
  65
  66 .. kernel-doc:: kernel/signal.c
  67    :internal:
  68
  69 .. kernel-doc:: include/linux/kthread.h
  70    :internal:
  71
  72 .. kernel-doc:: kernel/kthread.c
  73    :export:
  74
  75 Reference counting
  76 ------------------
  77
  78 .. kernel-doc:: include/linux/refcount.h
  79    :internal:
  80
  81 .. kernel-doc:: lib/refcount.c
  82    :export:
  83
  84 Atomics
  85 -------
  86
  87 .. kernel-doc:: arch/x86/include/asm/atomic.h
  88    :internal:
  89
  90 Kernel objects manipulation
  91 ---------------------------
  92
  93 .. kernel-doc:: lib/kobject.c
  94    :export:
  95
  96 Kernel utility functions
  97 ------------------------
  98
  99 .. kernel-doc:: include/linux/kernel.h
 100    :internal:
 101    :no-identifiers: kstrtol kstrtoul
 102
 103 .. kernel-doc:: kernel/printk/printk.c
 104    :export:
 105    :no-identifiers: printk
 106
 107 .. kernel-doc:: kernel/panic.c
 108    :export:
 109
 110 .. kernel-doc:: include/linux/overflow.h
 111    :internal:
 112
 113 Device Resource Management
 114 --------------------------
 115
 116 .. kernel-doc:: drivers/base/devres.c
 117    :export:
 118