diff options
author | John Baldwin <jhb@FreeBSD.org> | 2016-05-17 19:34:07 +0000 |
---|---|---|
committer | John Baldwin <jhb@FreeBSD.org> | 2016-05-17 19:34:07 +0000 |
commit | ed7ed7f0ca3d5d0c1638697b0b065f6b308cafcf (patch) | |
tree | defe2cfcf0526d43118968555e747f5df6cf9384 /sys/kern/bus_if.m | |
parent | 0f85a96bbfd2f28efe89c5aad609ed0cde4a5023 (diff) | |
download | src-ed7ed7f0ca3d5d0c1638697b0b065f6b308cafcf.tar.gz src-ed7ed7f0ca3d5d0c1638697b0b065f6b308cafcf.zip |
Document the formatting requirements of location and pnpinfo strings.
devd requires location and pnpinfo strings generated by bus drivers
to be formatted as a list of name=value keypairs. Non-conforming
bus drivers cause devd to mis-parse device events for these buses.
Note that this documents the desired requirements. devctl_safe_quote()
doesn't yet escape backslash characters, and devd doesn't handle escaped
characters in quoted values.
Differential Revision: https://reviews.freebsd.org/D6252
Notes
Notes:
svn path=/head/; revision=300073
Diffstat (limited to 'sys/kern/bus_if.m')
-rw-r--r-- | sys/kern/bus_if.m | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/sys/kern/bus_if.m b/sys/kern/bus_if.m index f0115e8670a2..aeaa5ce60467 100644 --- a/sys/kern/bus_if.m +++ b/sys/kern/bus_if.m @@ -532,6 +532,13 @@ METHOD int child_present { * * Return it as a string. If the string is insufficient for the * storage, then return EOVERFLOW. + * + * The string must be formatted as a space-separated list of + * name=value pairs. Names may only contain alphanumeric characters, + * underscores ('_') and hyphens ('-'). Values can contain any + * non-whitespace characters. Values containing whitespace can be + * quoted with double quotes ('"'). Double quotes and backslashes in + * quoted values can be escaped with backslashes ('\'). * * @param _dev the parent device of @p _child * @param _child the device which is being examined @@ -551,7 +558,14 @@ METHOD int child_pnpinfo_str { * * Return it as a string. If the string is insufficient for the * storage, then return EOVERFLOW. - * + * + * The string must be formatted as a space-separated list of + * name=value pairs. Names may only contain alphanumeric characters, + * underscores ('_') and hyphens ('-'). Values can contain any + * non-whitespace characters. Values containing whitespace can be + * quoted with double quotes ('"'). Double quotes and backslashes in + * quoted values can be escaped with backslashes ('\'). + * * @param _dev the parent device of @p _child * @param _child the device which is being examined * @param _buf the address of a buffer to receive the location |