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 .\"
  29 .Dd May 18, 2000
  30 .Dt BUS_RELEASE_RESOURCE 9
  31 .Os
  32 .Sh NAME
  33 .Nm bus_release_resource
  34 .Nd release resources on a bus
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In sys/bus.h
  38 .Pp
  39 .In sys/rman.h
  40 .In sys/resource.h
  41 .Ft int
  42 .Fn bus_release_resource "device_t dev" "int type" "int rid" "struct resource *r"
  43 .Sh DESCRIPTION
  44 Free a resource allocated by
  45 .Xr bus_alloc_resource 9 .
  46 The resource must not be in use on release, i.e. call an appropriate function
  47 before (e.g.\&
  48 .Xr bus_teardown_intr 9
  49 for IRQs).
  50 .Bl -item
  51 .It
  52 .Fa dev
  53 is the device that owns the resource.
  54 .It
  55 .Fa type
  56 is the type of resource that is released.
  57 It must be of the same type you allocated it as before.
  58 See
  59 .Xr bus_alloc_resource 9
  60 for valid types.
  61 .It
  62 .Fa rid
  63 is the resource ID of the resource.
  64 The
  65 .Fa rid
  66 value must be the same as the one returned by
  67 .Xr bus_alloc_resource 9 .
  68 .It
  69 .Fa r
  70 is the pointer to
  71 .Va struct res ,
  72 i.e. the resource itself,
  73 returned by
  74 .Xr bus_alloc_resource 9 .
  75 .El
  76 .Sh RETURN VALUES
  77 .Er EINVAL
  78 is returned, if the device
  79 .Fa dev
  80 has no parent,
  81 .Dv 0
  82 otherwise.
  83 The kernel will panic, if it can't release the resource.
  84 .Sh EXAMPLES
  85 .Bd -literal
  86         /* deactivate IRQ */
  87         bus_teardown_intr(dev, foosoftc->irqres, foosoftc->irqid);
  88
  89         /* release IRQ resource */
  90         bus_release_resource(dev, SYS_RES_IRQ, foosoftc->irqid,
  91                 foosoftc->irqres);
  92
  93         /* release I/O port resource */
  94         bus_release_resource(dev, SYS_RES_IOPORT, foosoftc->portid,
  95                 foosoftc->portres);
  96 .Ed
  97 .Sh SEE ALSO
  98 .Xr bus_alloc_resource 9 ,
  99 .Xr device 9 ,
 100 .Xr driver 9
 101 .Sh AUTHORS
 102 This man page was written by
 103 .An Alexander Langer Aq Mt alex@big.endian.de .