xref: /freebsd/share/man/man9/BUS_GET_PROPERTY.9 (revision 105fd928b0b5b35ab529e5f6914788dc49582901)
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 BUS_GET_PROPERTY 9
30.Os
31.Sh NAME
32.Nm BUS_GET_PROPERTY
33.Nd get child's specific property
34.Sh SYNOPSIS
35.In sys/param.h
36.In sys/bus.h
37.Ft ssize_t
38.Fn BUS_GET_PROPERTY "device_t dev" "device_t child" "const char *propname" \
39    "void *propvalue" "size_t size"
40.Sh DESCRIPTION
41The
42.Fn BUS_GET_PROPERTY
43method
44is called from driver code which wants to access child's specific data stored
45on the bus.
46Property consits of its name and value.
47Implementation shall copy to
48.Fa propvalue
49at most
50.Fa size
51bytes.
52.Sh NOTES
53If
54.Fa propvalue
55is NULL or
56.Fa size
57is zero, then implementation shall only return size of the property.
58.Sh RETURN VALUES
59Property's size if successful, otherwise -1.
60.Sh SEE ALSO
61.Xr device 9 ,
62.Xr device_get_property 9
63.Sh AUTHORS
64This manual page was written by
65.An Bartlomiej Grzesik .
66