/share/man/man9/bus_release_resource.9

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 106 lines · 104 code · 2 blank · 0 comment · 0 complexity · 931fd2e81abda180d8af89fad6ccbb6f MD5 · raw file 

    

  1. .\" -*- nroff -*-
    2. 

  2. .\"
    3. 

  3. .\" Copyright (c) 2000 Alexander Langer
    4. 

  4. .\"
    5. 

  5. .\" All rights reserved.
    6. 

  6. .\"
    7. 

  7. .\" This program is free software.
    8. 

  8. .\"
    9. 

  9. .\" Redistribution and use in source and binary forms, with or without
    10. 

  10. .\" modification, are permitted provided that the following conditions
    11. 

  11. .\" are met:
    12. 

  12. .\" 1. Redistributions of source code must retain the above copyright
    13. 

  13. .\"    notice, this list of conditions and the following disclaimer.
    14. 

  14. .\" 2. Redistributions in binary form must reproduce the above copyright
    15. 

  15. .\"    notice, this list of conditions and the following disclaimer in the
    16. 

  16. .\"    documentation and/or other materials provided with the distribution.
    17. 

  17. .\"
    18. 

  18. .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
    19. 

  19. .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    20. 

  20. .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
    21. 

  21. .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
    22. 

  22. .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    23. 

  23. .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    24. 

  24. .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    25. 

  25. .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    26. 

  26. .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    27. 

  27. .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    28. 

  28. .\"
    29. 

  29. .\" $FreeBSD$
    30. 

  30. .\"
    31. 

  31. .Dd May 18, 2000
    32. 

  32. .Dt BUS_RELEASE_RESOURCE 9
    33. 

  33. .Os
    34. 

  34. .Sh NAME
    35. 

  35. .Nm bus_release_resource
    36. 

  36. .Nd release resources on a bus
    37. 

  37. .Sh SYNOPSIS
    38. 

  38. .In sys/param.h
    39. 

  39. .In sys/bus.h
    40. 

  40. .Pp
    41. 

  41. .In machine/bus.h
    42. 

  42. .In sys/rman.h
    43. 

  43. .In machine/resource.h
    44. 

  44. .Ft int
    45. 

  45. .Fn bus_release_resource "device_t dev" "int type" "int rid" "struct resource *r"
    46. 

  46. .Sh DESCRIPTION
    47. 

  47. Free a resource allocated by
    48. 

  48. .Xr bus_alloc_resource 9 .
    49. 

  49. The resource must not be in use on release, i.e., call an appropriate function
    50. 

  50. before (e.g.\&
    51. 

  51. .Xr bus_teardown_intr 9
    52. 

  52. for IRQs).
    53. 

  53. .Bl -item
    54. 

  54. .It
    55. 

  55. .Fa dev
    56. 

  56. is the device that owns the resource.
    57. 

  57. .It
    58. 

  58. .Fa type
    59. 

  59. is the type of resource that is released.
    60. 

  60. It must be of the same type you allocated it as before.
    61. 

  61. See
    62. 

  62. .Xr bus_alloc_resource 9
    63. 

  63. for valid types.
    64. 

  64. .It
    65. 

  65. .Fa rid
    66. 

  66. is the resource ID of the resource.
    67. 

  67. The
    68. 

  68. .Fa rid
    69. 

  69. value must be the same as the one returned by
    70. 

  70. .Xr bus_alloc_resource 9 .
    71. 

  71. .It
    72. 

  72. .Fa r
    73. 

  73. is the pointer to
    74. 

  74. .Va struct resource ,
    75. 

  75. i.e., the resource itself,
    76. 

  76. returned by
    77. 

  77. .Xr bus_alloc_resource 9 .
    78. 

  78. .El
    79. 

  79. .Sh RETURN VALUES
    80. 

  80. .Er EINVAL
    81. 

  81. is returned, if the device
    82. 

  82. .Fa dev
    83. 

  83. has no parent,
    84. 

  84. .Dv 0
    85. 

  85. otherwise.
    86. 

  86. The kernel will panic, if it cannot release the resource.
    87. 

  87. .Sh EXAMPLES
    88. 

  88. .Bd -literal
    89. 

  89. 	/* deactivate IRQ */
    90. 

  90. 	bus_teardown_intr(dev, foosoftc->irqres, foosoftc->irqid);
    91. 

  91. 

  92. 	/* release IRQ resource */
    93. 

  93. 	bus_release_resource(dev, SYS_RES_IRQ, foosoftc->irqid,
    94. 

  94. 		foosoftc->irqres);
    95. 

  95. 

  96. 	/* release I/O port resource */
    97. 

  97. 	bus_release_resource(dev, SYS_RES_IOPORT, foosoftc->portid,
    98. 

  98. 		foosoftc->portres);
    99. 

  99. .Ed
    100. 

  100. .Sh SEE ALSO
    101. 

  101. .Xr bus_alloc_resource 9 ,
    102. 

  102. .Xr device 9 ,
    103. 

  103. .Xr driver 9
    104. 

  104. .Sh AUTHORS
    105. 

  105. This manual page was written by
    106. 

  106. .An Alexander Langer Aq alex@big.endian.de .
    107.