d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document the formatting requirements of location and pnpinfo strings.

Browse Source 
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
This commit is contained in:
John Baldwin 2016-05-17 19:34:07 +00:00
parent 0f85a96bbf
commit ed7ed7f0ca
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
sys/kern/bus_if.m
View File

@ -532,6 +532,13 @@ METHOD int child_present {
* *
* Return it as a string. If the string is insufficient for the * Return it as a string. If the string is insufficient for the
* storage, then return EOVERFLOW. * 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 _dev the parent device of @p _child
* @param _child the device which is being examined * @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 * Return it as a string. If the string is insufficient for the
* storage, then return EOVERFLOW. * 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 _dev the parent device of @p _child
* @param _child the device which is being examined * @param _child the device which is being examined
* @param _buf the address of a buffer to receive the location * @param _buf the address of a buffer to receive the location