summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorimp <imp@FreeBSD.org>2003-04-22 03:25:14 +0000
committerimp <imp@FreeBSD.org>2003-04-22 03:25:14 +0000
commit8515f23dc5cb93624f6138f25b1ae0074b706d5a (patch)
tree481709052a5f5aad5d96d8a8f12983f3c247ecff
parent4f1ed41d01188ce8a72c60fbaa4634428e79e096 (diff)
downloadFreeBSD-src-8515f23dc5cb93624f6138f25b1ae0074b706d5a.zip
FreeBSD-src-8515f23dc5cb93624f6138f25b1ae0074b706d5a.tar.gz
Document device_set_ivars(9) as well.
-rw-r--r--share/man/man9/Makefile1
-rw-r--r--share/man/man9/device_get_ivars.921
2 files changed, 20 insertions, 2 deletions
diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile
index 3d4b899..b5bdb3c 100644
--- a/share/man/man9/Makefile
+++ b/share/man/man9/Makefile
@@ -259,6 +259,7 @@ MLINKS+=zero_copy.9 zero_copy_sockets.9
MLINKS+=device_add_child.9 device_add_child_ordered.9
MLINKS+=device_enable.9 device_disable.9
MLINKS+=device_enable.9 device_is_enabled.9
+MLINKS+=device_get_ivars.9 device_set_ivars.9
MLINKS+=device_get_name.9 device_get_nameunit.9
MLINKS+=device_get_state.9 device_busy.9
MLINKS+=device_get_state.9 device_unbusy.9
diff --git a/share/man/man9/device_get_ivars.9 b/share/man/man9/device_get_ivars.9
index b934283..c5a0044 100644
--- a/share/man/man9/device_get_ivars.9
+++ b/share/man/man9/device_get_ivars.9
@@ -32,15 +32,32 @@
.Dt DEVICE_GET_IVARS 9
.Os
.Sh NAME
-.Nm device_get_ivars
+.Nm device_get_ivars ,
+.Nm device_set_ivars
.Nd access bus private variables
.Sh SYNOPSIS
.In sys/param.h
.In sys/bus.h
.Ft void *
.Fn device_get_ivars "device_t dev"
+.Ft void
+.Fn device_get_ivars "device_t dev" "void *ivar"
.Sh DESCRIPTION
-Return the bus-specific instance variables of a device.
+.Pp
+The
+.Nm device_get_ivar
+function returns the bus-specific instance variables of a device.
+.Pp
+The
+.Nm device_set_ivar
+function sets the bus-specific instance variables of a device.
+.Pp
+Typically, only bus drivers will use these functions.
+The kernel assumes that the bus driver will manage this memory, and no
+automatic memory allocation or deallocation happens.
+Client drivers should access ivars through the
+.Xr BUS_READ_IVAR 9
+interface instead.
.Sh SEE ALSO
.Xr device 9
.Sh AUTHORS
OpenPOWER on IntegriCloud