xref: /freebsd/share/man/man9/bus_activate_resource.9 (revision 8a7314fcb5347f8296a072e0c4f67a9f64303186)
1ec33f2d5SWarner Losh.\" -*- nroff -*-
2ec33f2d5SWarner Losh.\"
3ec33f2d5SWarner Losh.\" Copyright (c) 2003 M. Warner Losh
4ec33f2d5SWarner Losh.\"
5ec33f2d5SWarner Losh.\" All rights reserved.
6ec33f2d5SWarner Losh.\"
7ec33f2d5SWarner Losh.\" This program is free software.
8ec33f2d5SWarner Losh.\"
9ec33f2d5SWarner Losh.\" Redistribution and use in source and binary forms, with or without
10ec33f2d5SWarner Losh.\" modification, are permitted provided that the following conditions
11ec33f2d5SWarner Losh.\" are met:
12ec33f2d5SWarner Losh.\" 1. Redistributions of source code must retain the above copyright
13ec33f2d5SWarner Losh.\"    notice, this list of conditions and the following disclaimer.
14ec33f2d5SWarner Losh.\" 2. Redistributions in binary form must reproduce the above copyright
15ec33f2d5SWarner Losh.\"    notice, this list of conditions and the following disclaimer in the
16ec33f2d5SWarner Losh.\"    documentation and/or other materials provided with the distribution.
17ec33f2d5SWarner Losh.\"
18ec33f2d5SWarner Losh.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19ec33f2d5SWarner Losh.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20ec33f2d5SWarner Losh.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21ec33f2d5SWarner Losh.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22ec33f2d5SWarner Losh.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23ec33f2d5SWarner Losh.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24ec33f2d5SWarner Losh.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25ec33f2d5SWarner Losh.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26ec33f2d5SWarner Losh.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27ec33f2d5SWarner Losh.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28ec33f2d5SWarner Losh.\"
29ec33f2d5SWarner Losh.\" $FreeBSD$
30ec33f2d5SWarner Losh.\"
31ec33f2d5SWarner Losh.Dd March 28, 2003
32ec33f2d5SWarner Losh.Dt BUS_ACTIVATE_RESOURCE 9
33ec33f2d5SWarner Losh.Os
34ec33f2d5SWarner Losh.Sh NAME
353e1cee04SRuslan Ermilov.Nm bus_activate_resource , bus_deactivate_resource
363e1cee04SRuslan Ermilov.Nd activate or deactivate a resource
37ec33f2d5SWarner Losh.Sh SYNOPSIS
38ec33f2d5SWarner Losh.In sys/param.h
39ec33f2d5SWarner Losh.In sys/bus.h
40ec33f2d5SWarner Losh.Pp
41ec33f2d5SWarner Losh.In machine/bus.h
42ec33f2d5SWarner Losh.In sys/rman.h
43ec33f2d5SWarner Losh.In machine/resource.h
44ec33f2d5SWarner Losh.Ft int
453e1cee04SRuslan Ermilov.Fo bus_activate_resource
463e1cee04SRuslan Ermilov.Fa "device_t dev" "int type" "int rid" "struct resource *r"
473e1cee04SRuslan Ermilov.Fc
48ec33f2d5SWarner Losh.Ft int
493e1cee04SRuslan Ermilov.Fo bus_deactivate_resource
503e1cee04SRuslan Ermilov.Fa "device_t dev" "int type" "int rid" "struct resource *r"
513e1cee04SRuslan Ermilov.Fc
52ec33f2d5SWarner Losh.Sh DESCRIPTION
533e1cee04SRuslan ErmilovThese functions activate or deactivate a previously allocated resource.
54ec33f2d5SWarner LoshIn general, resources must be activated before they can be accessed by
55ec33f2d5SWarner Loshthe driver so that the bus driver can map the resource into the
56ec33f2d5SWarner Loshdevices space.
57ec33f2d5SWarner Losh.Pp
583e1cee04SRuslan ErmilovThe arguments are as follows:
593e1cee04SRuslan Ermilov.Bl -tag -width indent
603e1cee04SRuslan Ermilov.It Fa dev
613e1cee04SRuslan ErmilovThe device that requests ownership of the resource.
62ec33f2d5SWarner LoshBefore allocation, the resource is owned by the parent bus.
633e1cee04SRuslan Ermilov.It Fa type
643e1cee04SRuslan ErmilovThe type of resource you want to allocate.
65ec33f2d5SWarner LoshIt is one of:
663e1cee04SRuslan Ermilov.Pp
673e1cee04SRuslan Ermilov.Bl -tag -width ".Dv SYS_RES_MEMORY" -compact
68ec33f2d5SWarner Losh.It Dv SYS_RES_IRQ
69ec33f2d5SWarner Loshfor IRQs
70ec33f2d5SWarner Losh.It Dv SYS_RES_DRQ
71ec33f2d5SWarner Loshfor ISA DMA lines
72ec33f2d5SWarner Losh.It Dv SYS_RES_IOPORT
73ec33f2d5SWarner Loshfor I/O ports
74ec33f2d5SWarner Losh.It Dv SYS_RES_MEMORY
75ec33f2d5SWarner Loshfor I/O memory
76ec33f2d5SWarner Losh.El
773e1cee04SRuslan Ermilov.It Fa rid
783e1cee04SRuslan ErmilovA pointer to a bus specific handle that identifies the resource being allocated.
793e1cee04SRuslan Ermilov.It Fa r
803e1cee04SRuslan ErmilovA pointer to the
813e1cee04SRuslan Ermilov.Vt "struct resource"
82ec33f2d5SWarner Loshreturned by
83ec33f2d5SWarner Losh.Xr bus_alloc_resource 9 .
84ec33f2d5SWarner Losh.El
85ec33f2d5SWarner Losh.Sh RETURN VALUES
863e1cee04SRuslan ErmilovZero is returned on success, otherwise an error is returned.
87ec33f2d5SWarner Losh.Sh SEE ALSO
88ec33f2d5SWarner Losh.Xr bus_alloc_resource 9 ,
89ec33f2d5SWarner Losh.Xr device 9 ,
90ec33f2d5SWarner Losh.Xr driver 9
91ec33f2d5SWarner Losh.Sh AUTHORS
923e1cee04SRuslan ErmilovThis manual page was written by
93*8a7314fcSBaptiste Daroussin.An Warner Losh Aq Mt imp@FreeBSD.org .
94