summaryrefslogtreecommitdiffstats
path: root/share/man/man9/bus_activate_resource.9
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2003-05-30 21:13:32 +0000
committerru <ru@FreeBSD.org>2003-05-30 21:13:32 +0000
commit9480eb3914e60fff778fb3e41c9f5f41ced983a6 (patch)
tree8d41dbf814083034fe68b357fd0e043a54498dd0 /share/man/man9/bus_activate_resource.9
parenteb82b142f6d42d9f687e455b8122c5bbb26233d9 (diff)
downloadFreeBSD-src-9480eb3914e60fff778fb3e41c9f5f41ced983a6.zip
FreeBSD-src-9480eb3914e60fff778fb3e41c9f5f41ced983a6.tar.gz
Assorted mdoc(7) fixes.
Diffstat (limited to 'share/man/man9/bus_activate_resource.9')
-rw-r--r--share/man/man9/bus_activate_resource.952
1 files changed, 24 insertions, 28 deletions
diff --git a/share/man/man9/bus_activate_resource.9 b/share/man/man9/bus_activate_resource.9
index ce5f143..eb5b3e8 100644
--- a/share/man/man9/bus_activate_resource.9
+++ b/share/man/man9/bus_activate_resource.9
@@ -32,8 +32,8 @@
.Dt BUS_ACTIVATE_RESOURCE 9
.Os
.Sh NAME
-.Nm bus_activate_resource, bus_deactivate_resources
-.Nd activates or deactivates a resources
+.Nm bus_activate_resource , bus_deactivate_resource
+.Nd activate or deactivate a resource
.Sh SYNOPSIS
.In sys/param.h
.In sys/bus.h
@@ -42,26 +42,29 @@
.In sys/rman.h
.In machine/resource.h
.Ft int
-.Fn bus_activate_resource "device_t dev" "int type" "int rid" "struct resource *r"
+.Fo bus_activate_resource
+.Fa "device_t dev" "int type" "int rid" "struct resource *r"
+.Fc
.Ft int
-.Fn bus_deactivate_resource "device_t dev" "int type" "int rid" "struct resource *r"
+.Fo bus_deactivate_resource
+.Fa "device_t dev" "int type" "int rid" "struct resource *r"
+.Fc
.Sh DESCRIPTION
-Activates or deactivates a previously allocated resource.
+These functions activate or deactivate a previously allocated resource.
In general, resources must be activated before they can be accessed by
the driver so that the bus driver can map the resource into the
devices space.
.Pp
-Its arguments are as follows:
-.Bl -item
-.It
-.Fa dev
-is the device that requests ownership of the resource.
+The arguments are as follows:
+.Bl -tag -width indent
+.It Fa dev
+The device that requests ownership of the resource.
Before allocation, the resource is owned by the parent bus.
-.It
-.Fa type
-is the type of resource you want to allocate.
+.It Fa type
+The type of resource you want to allocate.
It is one of:
-.Bl -tag -width SYS_RES_MEMORY
+.Pp
+.Bl -tag -width ".Dv SYS_RES_MEMORY" -compact
.It Dv SYS_RES_IRQ
for IRQs
.It Dv SYS_RES_DRQ
@@ -71,27 +74,20 @@ for I/O ports
.It Dv SYS_RES_MEMORY
for I/O memory
.El
-.It
-.Fa rid
-points to a bus specific handle that identifies the resource being allocated.
-.It
-.Fa r
-points to the
-.Ft struct resource
+.It Fa rid
+A pointer to a bus specific handle that identifies the resource being allocated.
+.It Fa r
+A pointer to the
+.Vt "struct resource"
returned by
.Xr bus_alloc_resource 9 .
.El
.Sh RETURN VALUES
-Zero indicates success.
-Non-zero is an error from errno.h.
-.\".Sh EXAMPLES
-.\".Bd -literal
-.\".Ed
+Zero is returned on success, otherwise an error is returned.
.Sh SEE ALSO
.Xr bus_alloc_resource 9 ,
.Xr device 9 ,
.Xr driver 9
.Sh AUTHORS
-.An -nosplit
-This man page was written by
+This manual page was written by
.An Warner Losh Aq imp@FreeBSD.org .
OpenPOWER on IntegriCloud