xref: /freebsd/share/man/man9/device_get_property.9 (revision 43a5ec4eb41567cc92586503212743d89686d78f)
1.\" -
2.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3.\"
4.\" Copyright (c) 2021 Semihalf
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd August 19, 2021
29.Dt DEVICE_GET_PROPERTY 9
30.Os
31.Sh NAME
32.Nm device_get_property ,
33.Nm device_has_property
34.Nd access device specific data
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/bus.h
38.Ft ssize_t
39.Fn device_get_property "device_t dev" "const char *prop" "void *val" "size_t sz"
40.Ft bool
41.Fn device_has_property "device_t dev" "const char *prop"
42.Sh DESCRIPTION
43Access device specific data provided by the parent bus.
44Drivers can use these properties to obtain device capabilities and set
45necessary quirks.
46.Sh NOTES
47You can pass NULL as pointer to property's value when calling
48.Fn device_get_property
49to obtain its size.
50.Pp
51Currently this interface is implemented by
52.Xr simplebus 4
53and
54.Xr acpi 4 .
55.Sh RETURN VALUES
56.Fn device_get_property
57if successful returns property's size, otherwise returns -1.
58.Pp
59.Fn device_has_property
60returns true if given property was found.
61.Sh SEE ALSO
62.Xr acpi 4 ,
63.Xr simplebus 4 ,
64.Xr device 9
65.Sh AUTHORS
66This manual page was written by
67.An Bartlomiej Grzesik .
68