From 85c5fc05c0f2c07930a0fe9475bbf58a1a95db3e Mon Sep 17 00:00:00 2001 From: Sascha Wildner Date: Sun, 27 May 2007 16:07:41 +0000 Subject: [PATCH] Add a bus_set_resource(9) manual page. Obtained-from: FreeBSD --- share/man/man9/Makefile | 3 +- share/man/man9/bus_set_resource.9 | 95 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 97 insertions(+), 1 deletion(-) create mode 100644 share/man/man9/bus_set_resource.9 diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile index 8b916cf60c..b96fcd0b21 100644 --- a/share/man/man9/Makefile +++ b/share/man/man9/Makefile @@ -1,5 +1,5 @@ # $FreeBSD: src/share/man/man9/Makefile,v 1.60.2.26 2003/06/13 01:04:17 hmp Exp $ -# $DragonFly: src/share/man/man9/Makefile,v 1.53 2007/04/08 07:05:25 swildner Exp $ +# $DragonFly: src/share/man/man9/Makefile,v 1.54 2007/05/27 16:07:41 swildner Exp $ MAN= accept_filter.9 \ accf_data.9 \ @@ -21,6 +21,7 @@ MAN= accept_filter.9 \ BUS_PRINT_CHILD.9 \ BUS_READ_IVAR.9 \ bus_release_resource.9 \ + bus_set_resource.9 \ BUS_SETUP_INTR.9 \ cd.9 \ copy.9 \ diff --git a/share/man/man9/bus_set_resource.9 b/share/man/man9/bus_set_resource.9 new file mode 100644 index 0000000000..1a8d3a664b --- /dev/null +++ b/share/man/man9/bus_set_resource.9 @@ -0,0 +1,95 @@ +.\" +.\" 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: src/share/man/man9/bus_set_resource.9,v 1.5 2005/06/28 20:15:18 hmp Exp $ +.\" $DragonFly: src/share/man/man9/bus_set_resource.9,v 1.1 2007/05/27 16:07:41 swildner Exp $ +.\" +.Dd May 27, 2007 +.Dt BUS_SET_RESOURCE 9 +.Os +.Sh NAME +.Nm bus_set_resource +.Nd "associate a definite resource with a given resource ID" +.Sh SYNOPSIS +.In sys/param.h +.In sys/bus.h +.In sys/rman.h +.Ft int +.Fo bus_set_resource +.Fa "device_t dev" "int type" "int rid" "u_long start" "u_long count" +.Fc +.Sh DESCRIPTION +The +.Fn bus_set_resource +function +sets the +.Fa start +address of the resource +.Fa type , rid +pair to be +.Fa count +long. +Typically, client drivers do not use this interface. +Bus drivers, however, often use it to set up the resources a client driver +uses. +.Pp +The arguments are as follows: +.Bl -tag -width ".Fa start" +.It Fa dev +The device to set the resource on. +.It Fa type +The type of resource you want to allocate. +It is one of: +.Pp +.Bl -tag -width ".Dv SYS_RES_MEMORY" -compact +.It Dv SYS_RES_IRQ +for IRQs +.It Dv SYS_RES_DRQ +for ISA DMA lines +.It Dv SYS_RES_MEMORY +for I/O memory +.It Dv SYS_RES_IOPORT +for I/O ports +.El +.It Fa rid +A bus-specific handle that identifies the resource being allocated. +.It Fa start +The start address of this resource. +.It Fa count +The length of the resource. +For example, the size of the memory in bytes. +.El +.Sh RETURN VALUES +Zero is returned on success, otherwise an error is returned. +.Sh SEE ALSO +.Xr bus_alloc_resource 9 , +.\".Xr bus_get_resource 9 , +.Xr device 9 , +.Xr driver 9 +.Sh AUTHORS +This manual page was written by +.An Warner Losh Aq imp@FreeBSD.org . -- 2.11.4.GIT