Source-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[src/trunk]: src Add a firmload(9) manual page.
details: https://anonhg.NetBSD.org/src/rev/0098c681e586
branches: trunk
changeset: 587269:0098c681e586
user: thorpej <thorpej%NetBSD.org@localhost>
date: Tue Jan 17 17:29:28 2006 +0000
description:
Add a firmload(9) manual page.
diffstat:
distrib/sets/lists/comp/mi | 16 +++++-
share/man/man9/Makefile | 10 ++-
share/man/man9/firmload.9 | 129 +++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 152 insertions(+), 3 deletions(-)
diffs (201 lines):
diff -r 3292989f8af0 -r 0098c681e586 distrib/sets/lists/comp/mi
--- a/distrib/sets/lists/comp/mi Tue Jan 17 16:41:29 2006 +0000
+++ b/distrib/sets/lists/comp/mi Tue Jan 17 17:29:28 2006 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: mi,v 1.843 2006/01/16 22:32:27 yamt Exp $
+# $NetBSD: mi,v 1.844 2006/01/17 17:29:28 thorpej Exp $
./etc/mtree/set.comp comp-sys-root
./usr/bin/addr2line comp-debug-bin bfd
./usr/bin/ar comp-util-bin bfd
@@ -5246,6 +5246,13 @@
./usr/share/man/cat9/fgetown.0 comp-sys-catman .cat
./usr/share/man/cat9/file.0 comp-sys-catman .cat
./usr/share/man/cat9/filedesc.0 comp-sys-catman .cat
+./usr/share/man/cat9/firmload.0 comp-sys-catman .cat
+./usr/share/man/cat9/firmware_open.0 comp-sys-catman .cat
+./usr/share/man/cat9/firmware_close.0 comp-sys-catman .cat
+./usr/share/man/cat9/firmware_get_size.0 comp-sys-catman .cat
+./usr/share/man/cat9/firmware_read.0 comp-sys-catman .cat
+./usr/share/man/cat9/firmware_malloc.0 comp-sys-catman .cat
+./usr/share/man/cat9/firmware_free.0 comp-sys-catman .cat
./usr/share/man/cat9/fork1.0 comp-sys-catman .cat
./usr/share/man/cat9/format_bytes.0 comp-sys-catman .cat
./usr/share/man/cat9/fownsignal.0 comp-sys-catman .cat
@@ -9183,6 +9190,13 @@
./usr/share/man/man9/fgetown.9 comp-sys-man .man
./usr/share/man/man9/file.9 comp-sys-man .man
./usr/share/man/man9/filedesc.9 comp-sys-man .man
+./usr/share/man/man9/firmload.9 comp-sys-man .man
+./usr/share/man/man9/firmware_open.9 comp-sys-man .man
+./usr/share/man/man9/firmware_close.9 comp-sys-man .man
+./usr/share/man/man9/firmware_get_size.9 comp-sys-man .man
+./usr/share/man/man9/firmware_read.9 comp-sys-man .man
+./usr/share/man/man9/firmware_malloc.9 comp-sys-man .man
+./usr/share/man/man9/firmware_free.9 comp-sys-man .man
./usr/share/man/man9/fork1.9 comp-sys-man .man
./usr/share/man/man9/format_bytes.9 comp-sys-man .man
./usr/share/man/man9/fownsignal.9 comp-sys-man .man
diff -r 3292989f8af0 -r 0098c681e586 share/man/man9/Makefile
--- a/share/man/man9/Makefile Tue Jan 17 16:41:29 2006 +0000
+++ b/share/man/man9/Makefile Tue Jan 17 17:29:28 2006 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile,v 1.188 2006/01/16 22:32:07 yamt Exp $
+# $NetBSD: Makefile,v 1.189 2006/01/17 17:29:28 thorpej Exp $
# Makefile for section 9 (kernel function and variable) manual pages.
@@ -15,7 +15,7 @@
delay.9 disk.9 disklabel.9 dofileread.9 \
dopowerhooks.9 do_setresuid.9 doshutdownhooks.9 driver.9 \
errno.9 ethersubr.9 evcnt.9 extattr.9 extent.9 \
- fetch.9 file.9 filedesc.9 fork1.9 fsetown.9 \
+ fetch.9 file.9 filedesc.9 firmload.9 fork1.9 fsetown.9 \
getiobuf.9 \
hash.9 hardclock.9 humanize_number.9 hz.9 \
ieee80211.9 ieee80211_crypto.9 ieee80211_input.9 ieee80211_ioctl.9 \
@@ -212,6 +212,12 @@
filedesc.9 fdremove.9 \
filedesc.9 fdshare.9 \
filedesc.9 fdunshare.9
+MLINKS+=firmload.9 firmware_open.9 \
+ firmload.9 firmware_close.9 \
+ firmload.9 firmware_get_size.9 \
+ firmload.9 firmware_read.9 \
+ firmload.9 firmware_malloc.9 \
+ firmload.9 firmware_free.9
MLINKS+=fsetown.9 fgetown.9 \
fsetown.9 fownsignal.9
MLINKS+=getiobuf.9 getiobuf_nowait.9 \
diff -r 3292989f8af0 -r 0098c681e586 share/man/man9/firmload.9
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man9/firmload.9 Tue Jan 17 17:29:28 2006 +0000
@@ -0,0 +1,129 @@
+.\" $NetBSD: firmload.9,v 1.1 2006/01/17 17:29:28 thorpej Exp $
+.\"
+.\" Copyright (c) 2006 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Jason R. Thorpe.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\" must display the following acknowledgement:
+.\" This product includes software developed by the NetBSD
+.\" Foundation, Inc. and its contributors.
+.\" 4. Neither the name of The NetBSD Foundation nor the names of its
+.\" contributors may be used to endorse or promote products derived
+.\" from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+.\" POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd January 16, 2006
+.Dt FIRMLOAD 9
+.Os
+.Sh NAME
+.Nm firmload
+.Nd Firmware loader API for device drivers
+.Sh SYNOPSIS
+.In dev/firmload.h
+.\"
+.Ft int
+.Fn "firmware_open" "const char *drvname" "const char *imgname" \
+"firmware_handle_t *fhp"
+.\"
+.Ft int
+.Fn "firmware_close" "firmware_handle_t fh"
+.\"
+.Ft off_t
+.Fn "firmware_get_size" "firmware_handle_t fh"
+.\"
+.Ft int
+.Fn "firmware_read" "firmware_handle_t fh" "off_t offset" "void *buf" \
+"size_t size"
+.\"
+.Ft void *
+.Fn "firmware_malloc" "size_t size"
+.\"
+.Ft void
+.Fn "firmware_free" "void *buf" "size_t size"
+.Sh DESCRIPTION
+.Nm
+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 the sysctl variable
+.Dv hw.firmware.path .
+.Pp
+The following functions are provided by the
+.Nm
+API:
+.Bl -tag -width indent
+.It int Fn "firmware_open" "const char *drvname" "const char *imgname" \
+"firmware_handle_t *fhp"
+.Pp
+Open then firmware image
+.Fa imgname
+for the driver
+.Fa drvname .
+The path to the firmware image file is constructed by appending the string
+.Dq "/drvname/imgname"
+to each configured path prefix until opening the firmware image file succeeds.
+Upon success,
+.Fn firmware_open
+returns 0 and stores a firmware image handle in the location pointed to by
+.Fa fhp .
+Otherwise, an error code is returned to indicate the reason for failure.
+.It int Fn "firmware_close" "firmware_handle_t fh"
+.Pp
+Close the firmware image file associated with the firmware handle
+.Fa fh .
+Returns 0 upon success or an error code to indicate the reason for failure.
+.It off_t Fn "firmware_get_size" "firmware_handle_t fh"
+.Pp
+Returns the size of the image file associated with the firmware handle
+.Fa fh .
+.It int Fn "firmware_read" "firmware_handle_t fh" "off_t offset" "void *buf" \
+"size_t size"
+.Pp
+Reads from the image file associated with the firmware handle
+.Fa fh
+beginning at offset
+.Fa offset
+for length
+.Fa size .
+The firmware image data is placed into the buffer specified by
+.Fa buf .
+Returns 0 upon success or an error code to indicate the reason for failure.
+.It void * Ns Fn "firmware_malloc" "size_t size"
+.Pp
+Allocates a region of wired kernel memory of size
+.Fa size .
+Note:
+.Fn firmware_malloc
+may block.
+.It void Fn "firmware_free" "void *buf" "size_t size"
+.Pp
+Frees a region of memory previously allocated by
+.Fn firmware_malloc .
+.El
+.Sh SEE ALSO
+.Xr autoconf 9 ,
+.Xr malloc 9 ,
+.Xr vnsubr 9
Home |
Main Index |
Thread Index |
Old Index