system/freebsd-src
system/freebsd-src
1
0
Fork 0
mirror of https://github.com/freebsd/freebsd-src synced 2024-07-21 18:27:22 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

cdevpriv(9): document devfs_foreach_cdevpriv()

Browse source 
Sponsored by:	The FreeBSD Foundation
MFC after:	1 week
This commit is contained in:
Konstantin Belousov 2024-03-23 08:48:57 +02:00
parent d3efbe0132
commit 88f2c58d1a
2 changed files with 40 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
share/man/man9/Makefile
View file

@ -998,6 +998,7 @@ MLINKS+=dev_refthread.9 devvn_refthread.9 \
dev_refthread.9 dev_relthread.9
MLINKS+=devfs_set_cdevpriv.9 devfs_clear_cdevpriv.9 \
devfs_set_cdevpriv.9 devfs_get_cdevpriv.9
devfs_set_cdevpriv.9 devfs_foreach_cdevpriv.9
MLINKS+=device_add_child.9 device_add_child_ordered.9
MLINKS+=device_enable.9 device_disable.9 \
device_enable.9 device_is_enabled.9

41
share/man/man9/devfs_set_cdevpriv.9
View file

@ -22,13 +22,14 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd December 2, 2015
.Dd March 23, 2024
.Dt DEVFS_CDEVPRIV 9
.Os
.Sh NAME
.Nm devfs_set_cdevpriv ,
.Nm devfs_get_cdevpriv ,
.Nm devfs_clear_cdevpriv
.Nm devfs_clear_cdevpriv ,
.Nm devfs_foreach_cdevpriv
.Nd manage per-open filedescriptor data for devices
.Sh SYNOPSIS
.In sys/param.h
@ -42,6 +43,12 @@ typedef void d_priv_dtor_t(void *data);
.Fn devfs_set_cdevpriv "void *priv" "d_priv_dtor_t *dtr"
.Ft void
.Fn devfs_clear_cdevpriv "void"
.Ft int
.Fo devfs_foreach_cdevpriv
.Fa "struct cdev *dev"
.Fa "int (*cb)(void *data, void *arg)"
.Fa "void *arg"
.Fc
.Sh DESCRIPTION
The
.Fn devfs_xxx_cdevpriv
@ -111,6 +118,36 @@ filedescriptor, or
.Fn devfs_clear_cdevpriv
was called.
.El
.Pp
The function
.Fn devfs_foreach_cdevpriv
sequentially calls the function
.Fa cb
for each
.Nm cdevpriv
structure, currently associated with the
.Fa cdev
device.
The iterated
.Nm cdevpriv
data pointer and the user-supplied context
.Fa arg
are passed to the function
.Fa cb .
If
.Fa cb
returns non-zero value, the iteration stops on that element.
The
.Fn devfs_foreach_cdevpriv
returns the return value from the last call to
.Fa cb ,
or zero if no
.Nm cdevpriv
data is currently associated with the device.
.Pp
Current implementation of the iterator makes it impossible to use
any blockable locking inside the callback
.Fa cb .
.Sh SEE ALSO
.Xr close 2 ,
.Xr open 2 ,