xref: /freebsd/share/man/man9/resource_int_value.9 (revision a2f733abcff64628b7771a47089628b7327a88bd)
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 2001 M. Warner Losh <imp@FreeBSD.org>
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
15.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
18.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24.\"
25.Dd March 1, 2001
26.Dt RESOURCE_INT_VALUE 9
27.Os
28.Sh NAME
29.Nm resource_int_value , resource_long_value , resource_string_value
30.Nd get a value from the hints mechanism
31.Sh SYNOPSIS
32.In sys/param.h
33.In sys/bus.h
34.Ft int
35.Fn resource_int_value "const char *name" "int unit" "const char *resname" "int *result"
36.Ft int
37.Fn resource_long_value "const char *name" "int unit" "const char *resname" "long *result"
38.Ft int
39.Fn resource_string_value "const char *name" "int unit" "const char *resname" "const char **result"
40.Sh DESCRIPTION
41These functions fetch a value from the
42.Dq hints
43mechanism.
44.Pp
45The functions take the following arguments:
46.Bl -tag -width "resname"
47.It Fa name
48The name of the device to get the resource value from.
49.It Fa unit
50The unit number of the device.
51\-1 is special and is used for wildcard entries.
52.It Fa resname
53The resource name.
54.It Fa result
55A pointer to memory in which to store the resource value.
56.El
57.Sh RETURN VALUES
58If successful, the functions return 0.
59Otherwise, a non\-zero error code is returned.
60.Sh ERRORS
61The functions will fail if:
62.Bl -tag -width Er
63.It Bq Er ENOENT
64The resource could not be found.
65.It Bq Er EFTYPE
66Inappropriate resource type.
67.El
68.Sh SEE ALSO
69.Xr device 9 ,
70.Xr driver 9
71.Sh AUTHORS
72This manual page was written by
73.An Warner Losh Aq Mt imp@FreeBSD.org .
74