mirror/freebsd
1
0
Fork 0
mirror of https://git.FreeBSD.org/src.git synced 2024-12-14 10:09:48 +00:00
Code Issues Releases Activity

Add a new man page for bus_activate_resource and

Browse Source 
bus_deactivate_resource.  It could use some improvement, and others
are welcomed to do so :-)
This commit is contained in:
Warner Losh 2003-03-29 05:16:15 +00:00
parent 1aa895cd3f
commit ec33f2d50f
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=112774
2 changed files with 100 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
share/man/man9/Makefile
View File

@ -20,8 +20,8 @@ MAN= BUF_LOCK.9 BUF_LOCKFREE.9 BUF_LOCKINIT.9 BUF_REFCNT.9 \
VOP_READLINK.9 VOP_REALLOCBLKS.9 VOP_REMOVE.9 VOP_RENAME.9 \
VOP_REVOKE.9 VOP_SETACL.9 VOP_SETEXTATTR.9 VOP_STRATEGY.9 \
accept_filter.9 accf_data.9 accf_http.9 acl.9 atomic.9 \
bios.9 boot.9 buf.9 bus_alloc_resource.9 bus_child_present.9 \
bus_generic_attach.9 \
bios.9 boot.9 buf.9 bus_Activate_resource.9 \
bus_alloc_resource.9 bus_child_present.9 bus_generic_attach.9 \
bus_generic_detach.9 \
bus_generic_print_child.9 bus_generic_read_ivar.9 \
bus_generic_shutdown.9 bus_release_resource.9 \
@ -107,6 +107,7 @@ MLINKS+=atomic.9 atomic_readandclear.9
MLINKS+=atomic.9 atomic_set.9
MLINKS+=atomic.9 atomic_subtract.9
MLINKS+=atomic.9 atomic_store.9
MLINKS+=bus_activate_resource.9 bus_deactivate_resource.9
MLINKS+=byteorder.9 bswap16.9
MLINKS+=byteorder.9 bswap32.9
MLINKS+=byteorder.9 bswap64.9

97
share/man/man9/bus_activate_resource.9 Normal file
View File

@ -0,0 +1,97 @@
.\" -*- nroff -*-
.\"
.\" Copyright (c) 2003 M. Warner Losh
.\"
.\" All rights reserved.
.\"
.\" This program is free software.
.\"
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``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 DEVELOPERS 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.
.\"
.\" $FreeBSD$
.\"
.Dd March 28, 2003
.Dt BUS_ACTIVATE_RESOURCE 9
.Os
.Sh NAME
.Nm bus_activate_resource, bus_deactivate_resources
.Nd activates or deactivates a resources
.Sh SYNOPSIS
.In sys/param.h
.In sys/bus.h
.Pp
.In machine/bus.h
.In sys/rman.h
.In machine/resource.h
.Ft int
.Fn bus_activate_resource "device_t dev" "int type" "int *rid" "struct resource *r"
.Ft int
.Fn bus_deactivate_resource "device_t dev" "int type" "int *rid" "struct resource *r"
.Sh DESCRIPTION
Activates or deactivates 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.
Before allocation, the resource is owned by the parent bus.
.It
.Fa type
is the type of resource you want to allocate.
It is one of:
.Bl -tag -width SYS_RES_MEMORY
.It Dv SYS_RES_IRQ
for IRQs
.It Dv SYS_RES_DRQ
for ISA DMA lines
.It Dv SYS_RES_IOPORT
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
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
.Sh SEE ALSO
.Xr bus_alloc_resource 9 ,
.Xr device 9 ,
.Xr driver 9
.Sh AUTHORS
.An -nosplit
This man page was written by
.An Warner Losh Aq imp@FreeBSD.org .