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

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

CVSweb <webmaster@jp.NetBSD.org>