diff options
Diffstat (limited to 'static/netbsd/man9/firmload.9 3.html')
| -rw-r--r-- | static/netbsd/man9/firmload.9 3.html | 151 |
1 files changed, 0 insertions, 151 deletions
diff --git a/static/netbsd/man9/firmload.9 3.html b/static/netbsd/man9/firmload.9 3.html deleted file mode 100644 index b402b742..00000000 --- a/static/netbsd/man9/firmload.9 3.html +++ /dev/null @@ -1,151 +0,0 @@ -<table class="head"> - <tr> - <td class="head-ltitle">FIRMLOAD(9)</td> - <td class="head-vol">Kernel Developer's Manual</td> - <td class="head-rtitle">FIRMLOAD(9)</td> - </tr> -</table> -<div class="manual-text"> -<section class="Sh"> -<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> -<p class="Pp"><code class="Nm">firmload</code> — - <span class="Nd">Firmware loader API for device drivers</span></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> -<p class="Pp"><code class="In">#include - <<a class="In">dev/firmload.h</a>></code></p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">firmware_open</code>(<var class="Fa" style="white-space: nowrap;">const - char *drvname</var>, <var class="Fa" style="white-space: nowrap;">const char - *imgname</var>, - <var class="Fa" style="white-space: nowrap;">firmware_handle_t - *fhp</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">firmware_close</code>(<var class="Fa" style="white-space: nowrap;">firmware_handle_t - fh</var>);</p> -<p class="Pp"><var class="Ft">off_t</var> - <br/> - <code class="Fn">firmware_get_size</code>(<var class="Fa" style="white-space: nowrap;">firmware_handle_t - fh</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">firmware_read</code>(<var class="Fa" style="white-space: nowrap;">firmware_handle_t - fh</var>, <var class="Fa" style="white-space: nowrap;">off_t offset</var>, - <var class="Fa" style="white-space: nowrap;">void *buf</var>, - <var class="Fa" style="white-space: nowrap;">size_t size</var>);</p> -<p class="Pp"><var class="Ft">void *</var> - <br/> - <code class="Fn">firmware_malloc</code>(<var class="Fa" style="white-space: nowrap;">size_t - size</var>);</p> -<p class="Pp"><var class="Ft">void</var> - <br/> - <code class="Fn">firmware_free</code>(<var class="Fa" style="white-space: nowrap;">void - *buf</var>, <var class="Fa" style="white-space: nowrap;">size_t - size</var>);</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> -<p class="Pp"><code class="Nm">firmload</code> provides a simple and convenient - API for device drivers to load firmware images from files residing in the - file system that are necessary for the devices that they control. Firmware - images reside in sub-directories, one for each driver, of a series of - colon-separated path prefixes specified by the sysctl variable - <code class="Dv">hw.firmware.path</code>.</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="FUNCTIONS"><a class="permalink" href="#FUNCTIONS">FUNCTIONS</a></h1> -<p class="Pp">The following functions are provided by the - <code class="Nm">firmload</code> API:</p> -<dl class="Bl-tag"> - <dt id="firmware_open"><a class="permalink" href="#firmware_open"><code class="Fn">firmware_open</code></a>(<var class="Fa">drvname</var>, - <var class="Fa">imgname</var>, <var class="Fa">fhp</var>)</dt> - <dd> - <p class="Pp" id="firmware_open~2">Open the firmware image - <var class="Fa">imgname</var> for the driver - <var class="Fa">drvname</var>. The path to the firmware image file is - constructed by appending the string “/drvname/imgname” to - each configured path prefix until opening the firmware image file - succeeds. Upon success, - <a class="permalink" href="#firmware_open~2"><code class="Fn">firmware_open</code></a>() - returns 0 and stores a firmware image handle in the location pointed to - by <var class="Fa">fhp</var>. Otherwise, an error code is returned to - indicate the reason for failure.</p> - </dd> - <dt id="firmware_close"><a class="permalink" href="#firmware_close"><code class="Fn">firmware_close</code></a>(<var class="Fa">fh</var>)</dt> - <dd> - <p class="Pp">Close the firmware image file associated with the firmware - handle <var class="Fa">fh</var>. Returns 0 upon success or an error code - to indicate the reason for failure.</p> - </dd> - <dt id="firmware_get_size"><a class="permalink" href="#firmware_get_size"><code class="Fn">firmware_get_size</code></a>(<var class="Fa">fh</var>)</dt> - <dd> - <p class="Pp">Returns the size of the image file associated with the - firmware handle <var class="Fa">fh</var>.</p> - </dd> - <dt id="firmware_read"><a class="permalink" href="#firmware_read"><code class="Fn">firmware_read</code></a>(<var class="Fa">fh</var>, - <var class="Fa">offset</var>, <var class="Fa">buf</var>, - <var class="Fa">size</var>)</dt> - <dd> - <p class="Pp">Reads from the image file associated with the firmware handle - <var class="Fa">fh</var> beginning at offset - <var class="Fa">offset</var> for length <var class="Fa">size</var>. The - firmware image data is placed into the buffer specified by - <var class="Fa">buf</var>. Returns 0 upon success or an error code to - indicate the reason for failure.</p> - </dd> - <dt id="firmware_malloc"><a class="permalink" href="#firmware_malloc"><code class="Fn">firmware_malloc</code></a>(<var class="Fa">size</var>)</dt> - <dd> - <p class="Pp" id="firmware_malloc~2">Allocates a region of wired kernel - memory of size <var class="Fa">size</var>. Note: - <a class="permalink" href="#firmware_malloc~2"><code class="Fn">firmware_malloc</code></a>() - may block.</p> - </dd> - <dt id="firmware_free"><a class="permalink" href="#firmware_free"><code class="Fn">firmware_free</code></a>(<var class="Fa">buf</var>, - <var class="Fa">size</var>)</dt> - <dd> - <p class="Pp" id="firmware_malloc~3">Frees a region of memory previously - allocated by - <a class="permalink" href="#firmware_malloc~3"><code class="Fn">firmware_malloc</code></a>().</p> - </dd> -</dl> -</section> -<section class="Sh"> -<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1> -<p class="Pp">Default search path for firmware</p> -<dl class="Bl-tag Bl-compact"> - <dt><span class="Pa">/libdata/firmware</span></dt> - <dd style="width: auto;"> </dd> - <dt><span class="Pa">/usr/libdata/firmware</span></dt> - <dd style="width: auto;"> </dd> - <dt><span class="Pa">/usr/pkg/libdata/firmware</span></dt> - <dd style="width: auto;"> </dd> - <dt><span class="Pa">/usr/pkg/libdata</span></dt> - <dd style="width: auto;"> </dd> -</dl> -</section> -<section class="Sh"> -<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE - ALSO</a></h1> -<p class="Pp"><a class="Xr">autoconf(9)</a>, <a class="Xr">malloc(9)</a>, - <a class="Xr">vnsubr(9)</a></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> -<p class="Pp">The <code class="Nm">firmload</code> framework first appeared in - <span class="Ux">NetBSD 4.0</span>.</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> -<p class="Pp"><span class="An">Jason Thorpe</span> - <<a class="Mt" href="mailto:thorpej@NetBSD.org">thorpej@NetBSD.org</a>></p> -</section> -</div> -<table class="foot"> - <tr> - <td class="foot-date">March 16, 2018</td> - <td class="foot-os">NetBSD 10.1</td> - </tr> -</table> |