Index: head/share/man/man9/devctl_notify.9 =================================================================== --- head/share/man/man9/devctl_notify.9 (revision 366095) +++ head/share/man/man9/devctl_notify.9 (revision 366096) @@ -1,78 +1,76 @@ .\" .\" 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 22, 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 .Va system , .Va subsystem , and .Va type pointers cannot be NULL. .Pp The .Va 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 userland. Senders should balance between only passing data that userland can not 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: head/share/man/man9/devctl_process_running.9 =================================================================== --- head/share/man/man9/devctl_process_running.9 (revision 366095) +++ head/share/man/man9/devctl_process_running.9 (revision 366096) @@ -1,60 +1,58 @@ .\" .\" 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 22, 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: head/share/man/man9/devctl_safe_quote_sb.9 =================================================================== --- head/share/man/man9/devctl_safe_quote_sb.9 (revision 366095) +++ head/share/man/man9/devctl_safe_quote_sb.9 (revision 366096) @@ -1,57 +1,55 @@ .\" .\" 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 22, 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 +.Va src into -.Vn sb . +.Va sb . All backslash characters are doubled. All double quote characters -.Sq " +.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