sys/man/9/0intro

   1 .TH INTRO 9
   2 .SH NAME
   3 intro \- introduction to kernel functions
   4 .SH DESCRIPTION
   5 This section of the manual
   6 describes the functions publicly available to the authors of
   7 kernel code, particularly device drivers (real and virtual).
   8 This section will eventually be much expanded, but this makes a start.
   9 .PP
  10 The
  11 .SM SYNOPSIS
  12 subsections do not show the header files needed for
  13 the standard kernel declarations.
  14 The primary combinations summarised below:
  15 .IP
  16 .RS
  17 .ta \w'\fL#include 'u
  18 .nf
  19 .B
  20 #include        "u.h"
  21 .B
  22 #include        "../port/lib.h"
  23 .B
  24 #include        "mem.h"
  25 .B
  26 #include        "dat.h"
  27 .B
  28 #include        "fns.h"
  29 .B
  30 #include        "../port/error.h"
  31 .PP
  32 .I "furthermore, added in IP code:"
  33 .br
  34 .B
  35 #include "../ip/ip.h"
  36 .PP
  37 .I "furthermore, in hardware device drivers:"
  38 .br
  39 .B
  40 #include "io.h"
  41 .br
  42 .B
  43 #include "ureg.h"
  44 .PP
  45 .I "furthermore, in network interfaces or ether drivers:"
  46 .B
  47 #include "../port/netif.h"
  48 .fi
  49 .RE
  50 .PP
  51 There might also be specific include files needed by
  52 drivers on particular platforms or to use specialised kernel interfaces.
  53 The easiest method is to check the source of likely-looking drivers nearby.