freebsd-dev/share/man/man9/resource_int_value.9

.\" -*- nroff -*-
.\"
.\" Copyright (c) 2001 M. Warner Losh
.\"
.\" All rights reserved.
.\"
.\" This program is free software.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd March 1, 2001
.Dt RESOURCE_INT_VALUE 9
.Os
.Sh NAME
.Nm resource_int_value , resource_long_value , resource_string_value
.Nd get a value from the hints mechanism
.Sh SYNOPSIS
.In sys/param.h
.In sys/bus.h
.Ft int
.Fn resource_int_value "const char *name" "int unit" "const char *resname" "int *result"
.Ft int
.Fn resource_long_value "const char *name" "int unit" "const char *resname" "long *result"
.Ft int
.Fn resource_string_value "const char *name" "int unit" "const char *resname" "const char **result"
.Sh DESCRIPTION
These functions fetch a value from the
.Dq hints
mechanism.
.Pp
The functions take the following arguments:
.Bl -tag -width "resname"
.It Fa name
The name of the device to get the resource value from.
.It Fa unit
The unit number of the device.
\-1 is special and is used for wildcard entries.
.It Fa resname
The resource name.
.It Fa result
A pointer to memory in which to store the resource value.
.El
.Sh RETURN VALUES
If successful, the functions return 0.
Otherwise, a non\-zero error code is returned.
.Sh ERRORS
The functions will fail if:
.Bl -tag -width Er
.It Bq Er ENOENT
The resource could not be found.
.It Bq Er EFTYPE
Inappropriate resource type.
.El
.Sh SEE ALSO
.Xr device 9 ,
.Xr driver 9
.Sh AUTHORS
This manual page was written by
.An Warner Losh Aq imp@FreeBSD.org .
Document the resource_*_value and resource_query_string families of functions. These man pages likely need some markup work, so I've specifically not added them to the Makefile yet. 2001-03-01 04:28:40 +00:00			`.\" -- nroff --`
			`.\"`
			`.\" Copyright (c) 2001 M. Warner Losh`
			`.\"`
			`.\" All rights reserved.`
			`.\"`
			`.\" This program is free software.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
			`.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES`
			`.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.`
			`.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,`
			`.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT`
			`.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,`
			`.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY`
			`.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT`
			`.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF`
			`.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.`
			`.\"`
			`.\" $FreeBSD$`
			`.\"`
			`.Dd March 1, 2001`
			`.Dt RESOURCE_INT_VALUE 9`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:31:11 +00:00			`.Os`
Document the resource_*_value and resource_query_string families of functions. These man pages likely need some markup work, so I've specifically not added them to the Makefile yet. 2001-03-01 04:28:40 +00:00			`.Sh NAME`
Numerous formatting/content fixes. 2001-03-01 09:11:16 +00:00			`.Nm resource_int_value , resource_long_value , resource_string_value`
Remove leading . from .Nd description. 2001-03-01 09:02:01 +00:00			`.Nd get a value from the hints mechanism`
Document the resource_*_value and resource_query_string families of functions. These man pages likely need some markup work, so I've specifically not added them to the Makefile yet. 2001-03-01 04:28:40 +00:00			`.Sh SYNOPSIS`
Update function definitions and required include files to reflect the current state of the system. Approved by: alfred 2001-12-26 23:14:04 +00:00			`.In sys/param.h`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In sys/bus.h`
Document the resource_*_value and resource_query_string families of functions. These man pages likely need some markup work, so I've specifically not added them to the Makefile yet. 2001-03-01 04:28:40 +00:00			`.Ft int`
			`.Fn resource_int_value "const char name" "int unit" "const char resname" "int *result"`
			`.Ft int`
			`.Fn resource_long_value "const char name" "int unit" "const char resname" "long *result"`
			`.Ft int`
Update function definitions and required include files to reflect the current state of the system. Approved by: alfred 2001-12-26 23:14:04 +00:00			`.Fn resource_string_value "const char name" "int unit" "const char resname" "const char **result"`
Document the resource_*_value and resource_query_string families of functions. These man pages likely need some markup work, so I've specifically not added them to the Makefile yet. 2001-03-01 04:28:40 +00:00			`.Sh DESCRIPTION`
Numerous formatting/content fixes. 2001-03-01 09:11:16 +00:00			`These functions fetch a value from the`
			`.Dq hints`
			`mechanism.`
Document the resource_*_value and resource_query_string families of functions. These man pages likely need some markup work, so I've specifically not added them to the Makefile yet. 2001-03-01 04:28:40 +00:00			`.Pp`
Correct English used. 2001-03-01 09:37:38 +00:00			`The functions take the following arguments:`
Numerous formatting/content fixes. 2001-03-01 09:11:16 +00:00			`.Bl -tag -width "resname"`
			`.It Fa name`
Correct English used. 2001-03-01 09:37:38 +00:00			`The name of the device to get the resource value from.`
Numerous formatting/content fixes. 2001-03-01 09:11:16 +00:00			`.It Fa unit`
Correct English used. 2001-03-01 09:37:38 +00:00			`The unit number of the device.`
Numerous formatting/content fixes. 2001-03-01 09:11:16 +00:00			`\-1 is special and is used for wildcard entries.`
			`.It Fa resname`
Correct English used. 2001-03-01 09:37:38 +00:00			`The resource name.`
Numerous formatting/content fixes. 2001-03-01 09:11:16 +00:00			`.It Fa result`
Correct English used. 2001-03-01 09:37:38 +00:00			`A pointer to memory in which to store the resource value.`
Numerous formatting/content fixes. 2001-03-01 09:11:16 +00:00			`.El`
Document the resource_*_value and resource_query_string families of functions. These man pages likely need some markup work, so I've specifically not added them to the Makefile yet. 2001-03-01 04:28:40 +00:00			`.Sh RETURN VALUES`
Correct English used. 2001-03-01 09:37:38 +00:00			`If successful, the functions return 0.`
Numerous formatting/content fixes. 2001-03-01 09:11:16 +00:00			`Otherwise, a non\-zero error code is returned.`
			`.Sh ERRORS`
Correct English used. 2001-03-01 09:37:38 +00:00			`The functions will fail if:`
Numerous formatting/content fixes. 2001-03-01 09:11:16 +00:00			`.Bl -tag -width Er`
			`.It Bq Er ENOENT`
			`The resource could not be found.`
			`.It Bq Er EFTYPE`
			`Inappropriate resource type.`
			`.El`
Document the resource_*_value and resource_query_string families of functions. These man pages likely need some markup work, so I've specifically not added them to the Makefile yet. 2001-03-01 04:28:40 +00:00			`.Sh SEE ALSO`
			`.Xr device 9 ,`
Numerous formatting/content fixes. 2001-03-01 09:11:16 +00:00			`.Xr driver 9`
Document the resource_*_value and resource_query_string families of functions. These man pages likely need some markup work, so I've specifically not added them to the Makefile yet. 2001-03-01 04:28:40 +00:00			`.Sh AUTHORS`
Numerous formatting/content fixes. 2001-03-01 09:11:16 +00:00			`This manual page was written by`
Document the resource_*_value and resource_query_string families of functions. These man pages likely need some markup work, so I've specifically not added them to the Makefile yet. 2001-03-01 04:28:40 +00:00			`.An Warner Losh Aq imp@FreeBSD.org .`