1.\" - 2.\" SPDX-License-Identifier: BSD-2-Clause 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 February 18, 2022 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" "device_property_type_t type" 40.Sh DESCRIPTION 41The 42.Fn BUS_GET_PROPERTY 43method 44is called from driver code which wants to access a child's specific data stored 45on the bus. 46A property has a name and an associated value. 47Implementation shall copy to 48.Fa propvalue 49at most 50.Fa size 51bytes. 52.Pp 53.Fn BUS_GET_PROPERTY 54supports different property types specified via the 55.Fa type 56argument. 57The 58.Fa size 59is guaranteed to be a multiple of the underlying property type. 60If a type is not supported, 61.Fn BUS_GET_PROPERTY 62shall return -1. 63.Sh NOTES 64If 65.Fa propvalue 66is NULL or 67.Fa size 68is zero, the implementation shall return only the size of the property. 69.Sh RETURN VALUES 70The property size if successful, otherwise -1. 71.Sh SEE ALSO 72.Xr device 9 , 73.Xr device_get_property 9 74.Sh AUTHORS 75This manual page was written by 76.An Bartlomiej Grzesik . 77