Index: share/man/man4/devctl.4 =================================================================== --- share/man/man4/devctl.4 +++ share/man/man4/devctl.4 @@ -23,12 +23,16 @@ .\" .\" $FreeBSD$ .\" -.Dd March 26, 2014 +.Dd September 21, 2020 .Dt DEVCTL 4 .Os .Sh NAME .Nm devctl .Nd "device event reporting and device control interface" +.Sh SYNOPSIS +The +.Nm +driver is automatically included in the kernel. .Sh DESCRIPTION The .Nm @@ -124,5 +128,17 @@ The attach message driver has already claimed this device. One cannot use the detach messages to flush data to the device. The device is already gone. +.Pp +All values passed back are of the form +.Sq key=value +or +.Sq key="value" . +When the latter, the string +.Dq value +must have any internal backslashes doubled. +It must also have any internal double quote characters +.Sq " +preceded by a backslash. +All other characters should be passed through. .Sh SEE ALSO .Xr devd 8 Index: share/man/man9/Makefile =================================================================== --- share/man/man9/Makefile +++ share/man/man9/Makefile @@ -121,6 +121,10 @@ DEVICE_SHUTDOWN.9 \ DEV_MODULE.9 \ dev_refthread.9 \ + devctl_notify.9 \ + devctl_process_running.9 \ + devctl_safe_quote_sb.9 \ + devctl_ devstat.9 \ devtoname.9 \ disk.9 \ Index: share/man/man9/devctl_notify.9 =================================================================== --- /dev/null +++ share/man/man9/devctl_notify.9 @@ -0,0 +1,78 @@ +.\" +.\" Copyright (c) 2020 M Warner Losh +.\" +.\" 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 September 21, 2020 +.Dt DEVCTL_NOTIFY 9 +.Os +.Sh NAME +.Nm devctl_notify +.Nd Send a message, via devctl, to userland +.Sh SYNOPSIS +.In sys/devctl.h +.Ft void +.Fn devctl_notify "const char *system" "const char *subsystem" "const char *type" "const char *data" +.Sh DESCRIPTION +Send a notification to user land via +.Xr devctl 4 . +See +.Xr devctl 4 +for the format of these messages. +.Pp +The +.Nm +function creates a string using the following template: +.Bd -literal +snprintf(buffer, sizeof(buffer), "!system=%s subsystem=%s type=%s", + system, subsystem, type); +.Ed +.Pp +The +.Vn system , +.Vn subsystem , +and +.Vn type +pointers cannot be NULL. +.Pp +The +.Vn data +argument may be NULL (for no additions) or a message formatted +properly for +.Xr devctl 4 . +A space will be added to the above template and this argument copied +verbatim to form the message passed to useland. +Senders should balance between only passing data that userland can't +discover itself and sending all the data userland will want to use to +decide what to do with the message. +.Pp +The current total message length limit is just under 1kb. +Senders should try to remain well below this limit. +.Sh SEE ALSO +.Xr devctl 4 +.Xr devd 8 +.Sh AUTHORS +This manual page was written by +.An M. Warner Losh Index: share/man/man9/devctl_process_running.9 =================================================================== --- /dev/null +++ share/man/man9/devctl_process_running.9 @@ -0,0 +1,60 @@ +.\" +.\" Copyright (c) 2020 M Warner Losh +.\" +.\" 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 September 21, 2020 +.Dt DEVCTL_PROCESS_RUNNING 9 +.Os +.Sh NAME +.Nm devctl_process_running +.Nd Returns true when devctl has a consumer process running +.Sh SYNOPSIS +.In sys/devctl.h +.Ft bool +.Fn devctl_process_running "void" +.Sh DESCRIPTION +The +.Nm +call returns +.Vt true +when a process has the devctl device open for +reading, and +.Vt false +otherwise. +One can assume from this that the default +.Xr devd 8 +or similar is running when +.Vt true +is returned. +Some subsystems will send a message and allow userland to do something +before proceeding with a default action if there's a timeout. +This call allows those subsystems to do the default action right away +when no process is running. +.Sh SEE ALSO +.Xr devd 8 +.Sh AUTHORS +This manual page was written by +.An M. Warner Losh Index: share/man/man9/devctl_safe_quote_sb.9 =================================================================== --- /dev/null +++ share/man/man9/devctl_safe_quote_sb.9 @@ -0,0 +1,57 @@ +.\" +.\" Copyright (c) 2020 M Warner Losh +.\" +.\" 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 September 21, 2020 +.Dt DEVCTL_SAFE_QUOTE_SB 9 +.Os +.Sh NAME +.Nm devctl_safe_quote_sb +.Nd Insert a string, properly quoted, into a sbuf +.Sh SYNOPSIS +.In sys/devctl.h +.In sys/sbuf.h +.Ft void +.Fn devctl_safe_quote_sb "struct sbuf *sb" "const char *src" +.Sh DESCRIPTION +Copy the string from +.Vn src +into +.Vn sb . +All backslash characters are doubled. +All double quote characters +.Sq " +are also preceded by a backslash. +All other characters are copied without modification. +The +.Xr devctl 4 +protocol requires quoted string to be quoted thus. +This routine centralizes this knowledge. +.Sh SEE ALSO +.Xr devd 8 +.Sh AUTHORS +This manual page was written by +.An M. Warner Losh