Annotation of htdocs/docs/kernel/programming.html, revision 1.56

1.17      jym         1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
1.1       dsieger     2: <html>
                      3: <head>
                      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <meta name="generator" content="Website XSL Stylesheet V2.6.0">
                      6: <link rel="home" href="../../." title="Welcome to The NetBSD Project: Of course it runs NetBSD.">
                      7: <link rel="up" href="../../docs/kernel/." title="NetBSD Documentation: Kernel">
                      8: <link rel="previous" href="../../docs/kernel/pseudo/." title="NetBSD Documentation: Writing a pseudo device">
                      9: <link rel="next" href="../../docs/kernel/uvm.html" title="NetBSD Documentation: UVM, the new Virtual Memory system">
                     10: <link rel="first" href="../../docs/kernel/lazyfpu.html" title="NetBSD Documentation: How lazy FPU context switch works">
                     11: <link rel="last" href="../../docs/kernel/elf-notes.html" title="NetBSD Documentation: Vendor-specific ELF Note Elements">
1.10      dsieger    12: <link rel="stylesheet" href="../../global.css" type="text/css">
1.1       dsieger    13: 
                     14:     
                     15:     
                     16:     <title>NetBSD Documentation: Kernel Programming FAQ</title>
                     17:   </head>
                     18: <body class="website"><div class="webpage">
1.50      maya       19: <a name="docs-kernel-programming"></a><div id="top"><a href="#mainContent" id="skiplink" tabindex="1">Skip to main content.</a></div>
1.34      maya       20: <div id="centralHeader"><div id="logo">
1.21      jym        21: <a href="../../"><img alt="[NetBSD Logo]" src="../../images/NetBSD-smaller.png"></a><div id="name"><a href="../../">
1.19      jym        22:          The NetBSD Project
1.21      jym        23:        </a></div>
                     24: <div id="slogan"><a href="../../">
1.19      jym        25:          &#8220;Of course it runs NetBSD&#8221;
1.21      jym        26:        </a></div>
1.34      maya       27: </div></div>
1.35      maya       28: <input id="hamburger" type="checkbox"><label class="menuicon" for="hamburger"><span></span></label><div id="navBar" role="navigation">
1.6       dsieger    29: <span class="doNotDisplay">
                     30:          Navigation:
1.17      jym        31:        </span><ul>
                     32: <li><a href="../../">
                     33:          Home</a></li>
                     34: <li>
                     35: <a href="../../">
1.20      wiz        36:          News &amp; Media</a><ul>
1.17      jym        37: <li><a href="../../changes/">
                     38:            Recent changes</a></li>
1.37      maya       39: <li><a href="//blog.NetBSD.org/">
1.17      jym        40:            NetBSD blog</a></li>
1.56    ! maya       41: <li><a href="../../gallery/presentations/">
        !            42:            Presentations</a></li>
1.17      jym        43: </ul>
                     44: </li>
                     45: <li>
                     46: <a href="../../about/">
                     47:          About</a><ul>
                     48: <li><a href="../../about/">
                     49:            NetBSD</a></li>
1.45      maya       50: <li><a href="../../people/developers.html">
                     51:            NetBSD developers</a></li>
1.17      jym        52: <li><a href="../../gallery/">
1.53      leot       53:            Gallery</a></li>
1.17      jym        54: </ul>
                     55: </li>
                     56: <li>
                     57: <a href="../../docs/">
                     58:          Documentation</a><ul>
                     59: <li><a href="../../docs/misc/index.html">
                     60:            FAQ &amp; HOWTOs</a></li>
                     61: <li><a href="../../docs/guide/en/">
                     62:            The Guide</a></li>
1.54      reed       63: <li><a href="https://man.NetBSD.org/">
1.17      jym        64:            Manual pages</a></li>
1.37      maya       65: <li><a href="//wiki.NetBSD.org/">
1.17      jym        66:            Wiki</a></li>
                     67: </ul>
                     68: </li>
                     69: <li>
                     70: <a href="../../support/">
                     71:          Support</a><ul>
                     72: <li><a href="../../support/send-pr.html">
                     73:            Problem report guide</a></li>
                     74: <li><a href="../../cgi-bin/sendpr.cgi?gndb=netbsd">
                     75:            Report a bug</a></li>
                     76: <li><a href="../../support/query-pr.html">
                     77:            Query bug database</a></li>
                     78: <li><a href="../../support/security/">
                     79:            Security</a></li>
                     80: </ul>
                     81: </li>
                     82: <li>
                     83: <a href="../../community/">
                     84:          Community</a><ul>
                     85: <li><a href="../../mailinglists/">
                     86:            Mailing lists</a></li>
1.37      maya       87: <li><a href="//mail-index.NetBSD.org/">
1.17      jym        88:            List archives</a></li>
                     89: </ul>
                     90: </li>
                     91: <li>
                     92: <a href="../../developers/">
                     93:          Developers</a><ul>
1.40      maya       94: <li><a href="http://cvsweb.NetBSD.org/">
1.17      jym        95:            Browse source</a></li>
1.37      maya       96: <li><a href="//nxr.NetBSD.org/">
1.17      jym        97:            Cross-reference</a></li>
1.37      maya       98: <li><a href="//releng.NetBSD.org/">
1.17      jym        99:            Release engineering</a></li>
1.37      maya      100: <li><a href="//wiki.NetBSD.org/projects/">
1.17      jym       101:            Projects list</a></li>
                    102: </ul>
                    103: </li>
                    104: <li>
                    105: <a href="../../ports/">
                    106:          Ports</a><ul>
                    107: <li><a href="../../ports/history.html">
                    108:            History</a></li>
                    109: <li><a href="../../ports/emulators.html">
                    110:            Emulators</a></li>
                    111: </ul>
                    112: </li>
                    113: <li>
1.37      maya      114: <a href="//www.pkgsrc.org/">
1.17      jym       115:          Packages</a><ul>
1.38      maya      116: <li><a href="http://www.pkgsrc.se/">
1.17      jym       117:            Browse packages</a></li>
1.37      maya      118: <li><a href="//releng.NetBSD.org/index-pkgsrc.html">
1.17      jym       119:            Release engineering</a></li>
                    120: </ul>
                    121: </li>
                    122: </ul>
1.3       dsieger   123: </div>
1.49      maya      124: <div id="content"><div id="mainContent" class="fullWidth"><div class="rowOfBoxes">
1.3       dsieger   125: <h1>NetBSD Documentation: Kernel Programming FAQ</h1>
1.1       dsieger   126: <h3 class="title"><a name="misc">Misc</a></h3>
                    127: <ul>
                    128: <li><a href="#knf">What is KNF</a></li>
                    129: <li><a href="#packed-attribute">Using the `packed' attribute</a></li>
                    130: <li><a href="#printf">Using printf() for debugging</a></li>
                    131: <li><a href="#forcing-ddb">Forcing code to enter DDB</a></li>
                    132: <li><a href="#adding_a_new_driver">Adding a new driver to the kernel</a></li>
                    133: <li><a href="#autoconf">How does all this autoconf stuff work?</a></li>
                    134: <li><a href="#adding_a_system_call">Adding a system call</a></li>
                    135: <li><a href="#adding_a_sysctl">Adding a sysctl</a></li>
                    136: <li><a href="#mmap_in_pseudo-device">How to implement mmap(2) in a pseudo-device</a></li>
                    137: <li><a href="#accessing_a_kernel_structure_from_userland">Accessing a kernel structure from userland</a></li>
                    138: <li><a href="#sample_driver">Is there a simple PCI driver I can use as an example?</a></li>
                    139: <li><a href="#other-related-links">Other related links</a></li>
                    140: </ul>
                    141: <hr>
                    142: <h3 class="title">Misc</h3>
                    143:        <h4 class="title">
1.46      maya      144: <a name="knf"></a>What is KNF</h4>
1.1       dsieger   145: 
                    146:        <p>KNF stands for "Kernel Normal Form" - it's a C coding
                    147:          style documented in
                    148:          <code class="filename">/usr/share/misc/style</code>, which is
                    149:          included in the source tree as <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/src/share/misc/style?rev=HEAD&amp;content-type=text/x-cvsweb-markup" target="_top"><code class="filename">src/share/misc/style</code></a>.</p>
                    150:       
                    151:        <h4 class="title">
1.46      maya      152: <a name="packed-attribute"></a>Using the `packed' attribute</h4>
1.1       dsieger   153:        
                    154:        <p>Always use the <code class="code">`packed'</code> attribute in
                    155:          structures which describe wire protocol data formats.</p>
                    156:       
                    157:        <h4 class="title">
1.46      maya      158: <a name="printf"></a>Using <code class="code">printf()</code> for debugging</h4>
1.1       dsieger   159: 
                    160:        <p>Probably the simplest way of generating debugging
                    161:          information from a kernel driver is to use
                    162:          <code class="code">printf()</code>. The kernel printf will send output to
                    163:          the console, so beware of generating too much output and
                    164:          making the system unusable.</p>
                    165:       
                    166:        <h4 class="title">
1.46      maya      167: <a name="forcing-ddb"></a>Forcing code to enter DDB</h4>
1.1       dsieger   168: 
                    169:        <p>Ensure your kernel config file contains
                    170:          '<code class="code">options DDB</code>', the file has
                    171:          '<code class="code">#include "opt_ddb.h"</code>', then use
                    172:          '<code class="code">Debugger()</code>'.</p>
                    173:       
                    174:        <h4 class="title">
1.46      maya      175: <a name="adding_a_new_driver"></a>Adding a new driver to the kernel</h4>
1.1       dsieger   176: 
                    177:        <p>Every driver needs at least:
                    178:          </p>
1.23      tron      179: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.15      spz       180: <li class="listitem">
1.1       dsieger   181: <code class="code"><span class="emphasis"><em>xxx</em></span>probe()</code> (
                    182:              during which NetBSD will attempt to determine if the
                    183:              device is present)</li>
1.15      spz       184: <li class="listitem">
1.1       dsieger   185: <code class="code"><span class="emphasis"><em>xxx</em></span>attach()</code>
                    186:              routine which will configure and attach the
                    187:              device.</li>
                    188: </ul></div>
                    189: <p>
                    190:        </p>
                    191: 
                    192:        <p>Once probe and attach routines have been written, add
                    193:          an entry to 
                    194:          <code class="filename">/usr/src/sys/arch/&lt;your-arch&gt;/&lt;your-arch&gt;/conf.c</code>.</p>
                    195:        
                    196:        <p>There are two tables:
                    197:          </p>
1.23      tron      198: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.15      spz       199: <li class="listitem">
1.1       dsieger   200: <code class="code">cdevsw</code> for character devices.</li>
1.15      spz       201: <li class="listitem">
1.1       dsieger   202: <code class="code">bdevsw</code> for block devices (for those
                    203:              that also perform "block" I/O and use a strategy
                    204:              routine).</li>
                    205: </ul></div>
                    206: 
                    207:        <p>Most entries will be of the form
                    208:          <code class="code">cdev_<span class="emphasis"><em>xxx</em></span>_init()</code>, which
                    209:          is a macro handling prototyping of the standard Unix
                    210:          device switch routines.</p>
                    211: 
                    212:        <p>The probe/attach routines are called at boot time.  The
                    213:          <code class="code">open()</code>, <code class="code">close()</code>,
                    214:          <code class="code">read()</code>, and <code class="code">write()</code> routines are
                    215:          called when you open up the device special file who's major
                    216:          number corresponds to the index into that table.  For
                    217:          example, if you open up a device who's major number is 18,
                    218:          the "open" routine for device number 18 in
                    219:          <code class="code">cdevsw[]/bdevsw</code> will be called.</p>
                    220: 
                    221:        <p>Most drivers are split between bus specific attach code, and
                    222:          a machine independent core. As an example, the driver for
                    223:          the PCI lance ethernet chip has entries in the following files:
                    224: 
                    225:          </p>
1.23      tron      226: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.15      spz       227: <li class="listitem">
1.1       dsieger   228: <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/src/sys/dev/pci/files.pci?rev=HEAD&amp;content-type=text/x-cvsweb-markup" target="_top"><code class="filename">src/sys/dev/pci/files.pci</code></a>
                    229:              - attach information (look for 'le at pci').</li>
1.15      spz       230: <li class="listitem">
1.1       dsieger   231: <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/src/sys/dev/pci/if_le_pci.c?rev=HEAD&amp;content-type=text/x-cvsweb-markup" target="_top"><code class="filename">src/sys/dev/pci/if_le_pci.c</code></a> 
                    232:              - PCI bus attach code for the driver.</li>
                    233: </ul></div>
                    234: <p>
                    235:        </p>
                    236:        
                    237:        <p>
                    238:          </p>
1.23      tron      239: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.15      spz       240: <li class="listitem">
1.1       dsieger   241: <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/src/sys/conf/files?rev=HEAD&amp;content-type=text/x-cvsweb-markup" target="_top"><code class="filename">src/sys/conf/files</code></a>
                    242:              - MI core attach information (look for 'le:').</li>
1.15      spz       243: <li class="listitem">
1.1       dsieger   244: <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/src/sys/dev/ic/am7990.c?rev=HEAD&amp;content-type=text/x-cvsweb-markup" target="_top"><code class="filename">src/sys/dev/ic/am7990.c</code></a>
                    245:              - MI driver 24bit access code.</li>
1.15      spz       246: <li class="listitem">
1.1       dsieger   247: <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/src/sys/dev/ic/am79900.c?rev=HEAD&amp;content-type=text/x-cvsweb-markup" target="_top"><code class="filename">src/sys/dev/ic/am79900.c</code></a>
                    248:              - MI driver 32bit access code.</li>
1.15      spz       249: <li class="listitem">
1.1       dsieger   250: <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/src/sys/dev/ic/lance.c?rev=HEAD&amp;content-type=text/x-cvsweb-markup" target="_top"><code class="filename">src/sys/dev/ic/lance.c</code></a>
                    251:              - MI core driver code.</li>
                    252: </ul></div>
                    253: <p>
                    254:        </p>
                    255: 
1.12      hubertf   256:        <p>See also <a class="ulink" href="#autoconf" target="_top">the autoconf explanation</a>.</p>
1.1       dsieger   257:       
                    258:        <h4 class="title">
1.46      maya      259: <a name="autoconf"></a>How does all this autoconf stuff work?</h4>
1.1       dsieger   260:        
                    261:        <p>The autoconf machinery is quite simple once you figure
                    262:          out the way it works. If you want to ignore the exact
                    263:          details of how the device probe tree is built and walked
                    264:            on runtime, the bits needed for each individual
1.15      spz       265:          <span class="quote">&#8220;<span class="quote">leaf</span>&#8221;</span> driver are like this:
1.1       dsieger   266:          
                    267:          </p>
1.15      spz       268: <div class="orderedlist"><ol class="orderedlist" type="1">
                    269: <li class="listitem">each driver specifies a structure holding
1.1       dsieger   270:              three things - size of its private structure, probe
                    271:              function and attach function; this is compiled in and
                    272:              used in runtime - example:
                    273:              <pre class="programlisting">
                    274: struct cfattach foo_baz_ca = {
                    275:     sizeof(struct foo_baz_softc), foo_baz_match, foo_baz_attach
                    276: };</pre>
                    277: </li>
1.15      spz       278: <li class="listitem">on kernel startup, once the time comes to
1.1       dsieger   279:              attach the device, autoconf code calls device's
                    280:              probe routine and passes it pointer to parent
                    281:              (<code class="code">struct device *parent</code>), pointer
                    282:              to attach tag structure (<code class="code">void *aux</code>),
                    283:              and appropriate   autoconf node (<code class="code">struct cfdata
                    284:                *cf</code>). The driver is expected to find out if
                    285:              it's where it's supposed to be (commonly, the location
                    286:              and configuration information is passed by the attach
                    287:              tag). If yes, the probe routine should return 1. If
                    288:              device is not there, probe routine has to return 0.
                    289:              <span class="bold"><strong>NO STATE SHOULD BE KEPT</strong></span>
                    290:              in either case.</li>
1.15      spz       291: <li class="listitem">if probe returned success, autoconf allocates
1.1       dsieger   292:              chunk of memory sized as specified in device's *_ca
                    293:              and calls its attach routine, passing it pointer to
                    294:              parent (<code class="code">struct device *parent</code>), 
                    295:              pointer to the freshly allocated memory
                    296:              (<code class="code">struct device *self</code>) and the attach tag
                    297:              (<code class="code">void *aux</code>). Driver is expected to find
                    298:              out exact ports and memory, allocate resources and
                    299:              initialize its internal structure
                    300:              accordingly. Preferably, all driver instance specific
                    301:              information should be kept in the allocated
                    302:              memory.</li>
                    303: </ol></div>
                    304: <p>
                    305:        </p>
                    306:        
                    307:        <p>Example: Let's have a PCI ethernet device 'baz',
                    308:          kernel config chunk looks like this:
                    309:          </p>
                    310: <pre class="programlisting">
                    311: pci*    at mainbus?
                    312: baz*    at pci? dev ? function ?</pre>
                    313: <p>
                    314: 
                    315:          At runtime, autoconf iterates over all physical devices
                    316:          present on machine's PCI bus. For each physical device, it
                    317:          iterates over all devices registered in kernel to be on
                    318:          pci bus, and calls drivers' probe routine. If any probe
                    319:          routine claims the device by returning 1, autoconf stops
                    320:          iterating and does the job described under 3). Once the
                    321:          attach function returns, autoconf continues with next
                    322:          physical device.</p>
                    323:        
1.12      hubertf   324:        <p>See also <a class="ulink" href="#adding_a_new_driver" target="_top">Adding a new driver</a>.</p>
1.1       dsieger   325:       
                    326:        <h4 class="title">
1.46      maya      327: <a name="adding_a_system_call"></a>Adding a system call</h4>
1.1       dsieger   328:        
                    329:        <p>Add an entry in <code class="code">syscalls.master</code>, and add
                    330:          the syscall stub to the appropriate place in 
                    331:          <code class="code"><a href="http://cvsweb.NetBSD.org/bsdweb.cgi/src/lib/libc/sys/Makefile.inc?rev=HEAD&amp;content-type=text/x-cvsweb-markup" target="_top"><code class="filename">src/lib/libc/sys/Makefile.inc</code></a></code>.</p>
1.12      hubertf   332:        <p>See the <a class="ulink" href="../internals/en/chap-processes.html#syscall_howto" target="_top">
                    333:             HOWTO</a> and related documentation in the <a class="ulink" href="../internals/en/" target="_top">
1.1       dsieger   334:            NetBSD Internals Guide</a> for more information.
                    335:        </p>
                    336:       
                    337:        <h4 class="title">
1.46      maya      338: <a name="adding_a_sysctl"></a>Adding a sysctl</h4>
1.1       dsieger   339:        
1.12      hubertf   340:        <p>See a <a class="ulink" href="http://mail-index.NetBSD.org/tech-kern/2001/06/24/0000.html" target="_top">posting</a>
                    341:          answering this question on  <a class="ulink" href="http://mail-index.NetBSD.org/tech-kern/" target="_top">tech-kern</a>.</p>
1.1       dsieger   342:        
                    343:        <p>Note that NetBSD 1.6 and up has a special
1.15      spz       344:          <span class="quote">&#8220;<span class="quote">vendor</span>&#8221;</span> sysctl category that is reserved for vendor
1.54      reed      345:          specific entries. See <a href="https://netbsd.gw.com/cgi-bin/man-cgi?sysctl+8.i386+NetBSD-8.1">sysctl(8)</a> for more
1.1       dsieger   346:          information.</p>
                    347:       
                    348:        <h4 class="title">
1.54      reed      349: <a name="mmap_in_pseudo-device"></a>How to implement <a href="https://netbsd.gw.com/cgi-bin/man-cgi?mmap+2.i386+NetBSD-8.1">mmap(2)</a> in a pseudo-device</h4>
1.1       dsieger   350:        
                    351:        <p>Your device is most likely a character device, so
                    352:          you will be using the device pager (the VM system hides
                    353:          all of this from you, don't worry).</p>
                    354:        
                    355:        <p>The first thing you need to do is pick some
                    356:          arbitrary offsets for your mmap interface.  Something
                    357:          like "mmap offset 0-M gives object A, N-O gives object
                    358:          B", etc.</p>
                    359:        
                    360:        <p>After that, your mmap routine would look something
                    361:          like this:
                    362:          </p>
                    363: <pre class="programlisting">
                    364: int
                    365: foommap(dev_t dev, int off, int prot)
                    366: {
                    367: 
                    368:         if (off &amp; PAGE_MASK)
                    369:                 panic("foommap");
                    370: 
                    371:         if ((u_int)off &gt;= FOO_REGION1_MMAP_OFFSET &amp;&amp;
                    372:             (u_int)off &lt; (FOO_REGION1_MMAP_OFFSET + FOO_REGION1_SIZE))
                    373:                 return (atop(FOO_REGION1_ADDR + ((u_int)off -
                    374:                     FOO_REGION1_MMAP_OFFSET)));
                    375: 
                    376:         if ((u_int)off &gt;= FOO_REGION2_MMAP_OFFSET &amp;&amp;
                    377:             (u_int)off &lt; (FOO_REGION2_MMAP_OFFSET + FOO_REGION2_SIZE))
                    378:                 return (atop(FOO_REGION1_ADDR + ((u_int)off -
                    379:                     FOO_REGION2_MMAP_OFFSET)));
                    380: 
                    381:         /* Page not found. */
                    382:         return (-1);
                    383: }</pre>
                    384: 
                    385:          <p>Now, this is slightly more complicated by the fact
                    386:            that you are going to be mmap'ing what are simply
                    387:            kernel memory objects (it is a pseudo-device after
                    388:            all).</p>
                    389:          
                    390:          <p>In order to make this work, you're going to want
                    391:            to make sure you allocate the memory objects to be
                    392:            mmap'd on page-aligned boundaries.  If you are
                    393:            allocating something &gt;= <code class="code">PAGE_SIZE</code> in
                    394:            size, this is guaranteed. Otherwise, you are going to
                    395:            have to use <code class="code">uvm_km_alloc()</code>, and round
                    396:            your allocation size up to page size.</p>
                    397:          
                    398:          <p>Then it would look a bit more like this:
                    399:            </p>
                    400: <pre class="programlisting">
                    401: int
                    402: foommap(dev_t dev, int off, int prot)
                    403: {
                    404:         paddr_t pa;
                    405: 
                    406:         if (off &amp; PAGE_MASK)
                    407:                 panic("foommap: offset not page aligned");
                    408: 
                    409:         if ((u_int)off &gt;= FOO_REGION1_MMAP_OFFSET &amp;&amp;
                    410:             (u_int)off &lt; (FOO_REGION1_MMAP_OFFSET + FOO_REGION1_SIZE)) {
                    411:                 if ((vaddr_t)foo_object1 &amp; PAGE_MASK)
                    412:                         panic("foommap: foo_object1 not page aligned");
                    413:                 if (pmap_extract(pmap_kernel(), foo_object1 +
                    414:                     (u_int)off - FOO_REGION1_MMAP_OFFSET, &amp;pa) == FALSE)
                    415:                         panic("foommap: foo_object1 page not mapped");
                    416:                 return (atop(pa));
                    417:         }
                    418: 
                    419:         if ((u_int)off &gt;= FOO_REGION2_MMAP_OFFSET &amp;&amp;
                    420:             (u_int)off &lt; (FOO_REGION2_MMAP_OFFSET + FOO_REGION2_SIZE)) {
                    421:                 if ((vaddr_t)foo_object2 &amp; PAGE_MASK)
                    422:                         panic("foommap: foo_object2 not page aligned");
                    423:                 if (pmap_extract(pmap_kernel(), foo_object2 +
                    424:                     (u_int)off - FOO_REGION2_MMAP_OFFSET, &amp;pa) == FALSE)
                    425:                         panic("foommap: foo_object2 page not mapped");
                    426:                 return (atop(pa));
                    427:         }
                    428: 
                    429:         /* Page not found. */
                    430:         return (-1);
                    431: }</pre>
                    432:       
                    433:        <h4 class="title">
1.46      maya      434: <a name="accessing_a_kernel_structure_from_userland"></a>Accessing a kernel structure from userland</h4>
1.1       dsieger   435:        
                    436:        <p>The canonical example for this is:  <code class="code">
                    437:            <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/src/usr.bin/vmstat/dkstats.c?rev=HEAD&amp;content-type=text/x-cvsweb-markup" target="_top"><code class="filename">src/usr.bin/vmstat/dkstats.c</code></a></code>
                    438:          , which reads disk statistics.</p>
                    439:       
                    440:        <h4 class="title">
1.46      maya      441: <a name="sample_driver"></a>Is there a simple PCI driver I can use as an example?</h4>
1.1       dsieger   442:        <p>You can look at
                    443:          <code class="filename">sys/dev/pci/puc.c</code>, which is one of
                    444:          the simplest drivers. PUCs are devices with one or more
                    445:          serial or parallel ports on it, usually using standard
                    446:          chips (e.g. 16550 UART for serial). This driver just
                    447:          locates the I/O addresses of the registers of the serial or
                    448:          parallel controller and passes it to the serial or
                    449:          parallel driver.</p> 
                    450:       
                    451:        <h4 class="title">
1.46      maya      452: <a name="other-related-links"></a>Other related links</h4>
1.1       dsieger   453:        
1.23      tron      454: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.15      spz       455: <li class="listitem">
1.54      reed      456: <a href="https://netbsd.gw.com/cgi-bin/man-cgi?driver+9.i386+NetBSD-8.1">driver(9)</a> - NetBSD autoconfiguration
1.1       dsieger   457:            interface utilised by device drivers</li>
1.15      spz       458: <li class="listitem">
1.54      reed      459: <a href="https://netbsd.gw.com/cgi-bin/man-cgi?autoconf+9.i386+NetBSD-8.1">autoconf(9)</a> - General description on the
1.1       dsieger   460:            NetBSD autoconfiguration framework</li>
1.15      spz       461: <li class="listitem">
1.54      reed      462: <a href="https://netbsd.gw.com/cgi-bin/man-cgi?config+9.i386+NetBSD-8.1">config(9)</a> - The autoconfiguration
1.1       dsieger   463:            framework ``device definition'' language</li>
1.15      spz       464: <li class="listitem">
1.54      reed      465: <a href="https://netbsd.gw.com/cgi-bin/man-cgi?bus_dma+9.i386+NetBSD-8.1">bus_dma(9)</a> - NetBSD's bus and machine
1.12      hubertf   466:            independent DMA framework, described in its own <a class="ulink" href="bus_dma.pdf" target="_top">paper</a> (64k, PDF)</li>
1.15      spz       467: <li class="listitem">
1.54      reed      468: <a href="https://netbsd.gw.com/cgi-bin/man-cgi?bus_space+9.i386+NetBSD-8.1">bus_space(9)</a> - NetBSD's bus space
1.1       dsieger   469:            manipulation interface</li>
1.15      spz       470: <li class="listitem">
1.12      hubertf   471: <a class="ulink" href="scsidma.html" target="_top">How SCSI DMA
1.1       dsieger   472:              works</a> - by Tohru Nishimura</li>
1.15      spz       473: <li class="listitem">
1.12      hubertf   474: <a class="ulink" href="lazyfpu.html" target="_top">How lazy FPU context
1.1       dsieger   475:              switch works</a> - by Tohru Nishimura</li>
1.15      spz       476: <li class="listitem"><a class="ulink" href="converting-ethernet-drivers.html" target="_top">Converting ancient BSD Ethernet drivers to NetBSD-1.2D and later</a></li>
                    477: <li class="listitem"><a class="ulink" href="porting-freebsd-net.html" target="_top">Notes on porting FreeBSD network drivers to NetBSD</a></li>
1.1       dsieger   478: </ul></div>
1.3       dsieger   479:       <hr>Back to  <em><a href="./">NetBSD Documentation: Kernel</a></em>
                    480: </div></div></div>
                    481: <div class="navfoot"></div>
1.13      mishka    482: <div id="footer"><div id="footerContent"><center>
1.37      maya      483: <span class="footfeed"><a href="//www.NetBSD.org/cgi-bin/feedback.cgi">
1.3       dsieger   484:          Contact</a> |
1.9       kano      485:       </span><span class="footcopy"><a href="../../about/disclaimer.html">
1.3       dsieger   486:       Disclaimer</a> |
                    487: 
1.55      leot      488:       <span class="copyright">Copyright © 1994-2020 The NetBSD Foundation, Inc. </span>ALL RIGHTS RESERVED.<br>NetBSD<sup>®</sup> is a registered trademark of The NetBSD
1.3       dsieger   489:        Foundation, Inc.</span>
1.13      mishka    490: </center></div></div>
1.1       dsieger   491: </div></body>
                    492: </html>

CVSweb <webmaster@jp.NetBSD.org>