/share/man/man9/resource_int_value.9

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 79 lines · 79 code · 0 blank · 0 comment · 0 complexity · 6952cffe4240fdbb39dc0e2a3a9fab10 MD5 · raw file 

    

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

  2. .\"
    3. 

  3. .\" Copyright (c) 2001 M. Warner Losh
    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 March 1, 2001
    32. 

  32. .Dt RESOURCE_INT_VALUE 9
    33. 

  33. .Os
    34. 

  34. .Sh NAME
    35. 

  35. .Nm resource_int_value , resource_long_value , resource_string_value
    36. 

  36. .Nd get a value from the hints mechanism
    37. 

  37. .Sh SYNOPSIS
    38. 

  38. .In sys/param.h
    39. 

  39. .In sys/bus.h
    40. 

  40. .Ft int
    41. 

  41. .Fn resource_int_value "const char *name" "int unit" "const char *resname" "int *result"
    42. 

  42. .Ft int
    43. 

  43. .Fn resource_long_value "const char *name" "int unit" "const char *resname" "long *result"
    44. 

  44. .Ft int
    45. 

  45. .Fn resource_string_value "const char *name" "int unit" "const char *resname" "const char **result"
    46. 

  46. .Sh DESCRIPTION
    47. 

  47. These functions fetch a value from the
    48. 

  48. .Dq hints
    49. 

  49. mechanism.
    50. 

  50. .Pp
    51. 

  51. The functions take the following arguments:
    52. 

  52. .Bl -tag -width "resname"
    53. 

  53. .It Fa name
    54. 

  54. The name of the device to get the resource value from.
    55. 

  55. .It Fa unit
    56. 

  56. The unit number of the device.
    57. 

  57. \-1 is special and is used for wildcard entries.
    58. 

  58. .It Fa resname
    59. 

  59. The resource name.
    60. 

  60. .It Fa result
    61. 

  61. A pointer to memory in which to store the resource value.
    62. 

  62. .El
    63. 

  63. .Sh RETURN VALUES
    64. 

  64. If successful, the functions return 0.
    65. 

  65. Otherwise, a non\-zero error code is returned.
    66. 

  66. .Sh ERRORS
    67. 

  67. The functions will fail if:
    68. 

  68. .Bl -tag -width Er
    69. 

  69. .It Bq Er ENOENT
    70. 

  70. The resource could not be found.
    71. 

  71. .It Bq Er EFTYPE
    72. 

  72. Inappropriate resource type.
    73. 

  73. .El
    74. 

  74. .Sh SEE ALSO
    75. 

  75. .Xr device 9 ,
    76. 

  76. .Xr driver 9
    77. 

  77. .Sh AUTHORS
    78. 

  78. This manual page was written by
    79. 

  79. .An Warner Losh Aq imp@FreeBSD.org .
    80.