share/man/man9/bus_release_resource.9

   1 .\" Copyright (c) 2000 Alexander Langer
   2 .\"
   3 .\" All rights reserved.
   4 .\"
   5 .\" This program is free software.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/share/man/man9/bus_release_resource.9,v 1.2.2.5 2001/12/17 11:30:18 ru Exp $
  28 .\" $DragonFly: src/share/man/man9/bus_release_resource.9,v 1.3 2004/06/01 11:36:53 hmp Exp $
  29 .\"
  30 .Dd May 18, 2000
  31 .Dt BUS_RELEASE_RESOURCE 9
  32 .Os
  33 .Sh NAME
  34 .Nm bus_release_resource
  35 .Nd release resources on a bus
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .In sys/bus.h
  39 .Pp
  40 .In machine/bus.h
  41 .In sys/rman.h
  42 .In machine/resource.h
  43 .Ft int
  44 .Fn bus_release_resource "device_t dev" "int type" "int rid" "struct resource *r"
  45 .Sh DESCRIPTION
  46 Free a resource allocated by
  47 .Xr bus_alloc_resource 9 .
  48 The resource must not be in use on release, i.e. call an appropriate function
  49 before (e.g.\&
  50 .Xr bus_teardown_intr 9
  51 for IRQs).
  52 .Bl -item
  53 .It
  54 .Fa dev
  55 is the device that owns the resource.
  56 .It
  57 .Fa type
  58 is the type of resource that is released.
  59 It must be of the same type you allocated it as before.
  60 See
  61 .Xr bus_alloc_resource 9
  62 for valid types.
  63 .It
  64 .Fa rid
  65 is the resource ID of the resource.
  66 The
  67 .Fa rid
  68 value must be the same as the one returned by
  69 .Xr bus_alloc_resource 9 .
  70 .It
  71 .Fa r
  72 is the pointer to
  73 .Va struct res ,
  74 i.e. the resource itself,
  75 returned by
  76 .Xr bus_alloc_resource 9 .
  77 .El
  78 .Sh RETURN VALUES
  79 .Er EINVAL
  80 is returned, if the device
  81 .Fa dev
  82 has no parent,
  83 .Dv 0
  84 otherwise.
  85 The kernel will panic, if it can't release the resource.
  86 .Sh EXAMPLES
  87 .Bd -literal
  88         /* deactivate IRQ */
  89         bus_teardown_intr(dev, foosoftc->irqres, foosoftc->irqid);
  90
  91         /* release IRQ resource */
  92         bus_release_resource(dev, SYS_RES_IRQ, foosoftc->irqid,
  93                 foosoftc->irqres);
  94
  95         /* release I/O port resource */
  96         bus_release_resource(dev, SYS_RES_IOPORT, foosoftc->portid,
  97                 foosoftc->portres);
  98 .Ed
  99 .Sh SEE ALSO
 100 .Xr bus_alloc_resource 9 ,
 101 .Xr device 9 ,
 102 .Xr driver 9
 103 .Sh AUTHORS
 104 This man page was written by
 105 .An Alexander Langer Aq alex@big.endian.de .