ddfc9c4c59
Now that the upper layers all go through a layer to tie into these
information functions that translates an sbuf into char * and len. The
current interface suffers issues of what to do in cases of truncation,
etc. Instead, migrate all these functions to using struct sbuf and these
issues go away. The caller is also in charge of any memory allocation
and/or expansion that's needed during this process.
Create a bus_generic_child_{pnpinfo,location} and make it default. It
just returns success. This is for those busses that have no information
for these items. Migrate the now-empty routines to using this as
appropriate.
Document these new interfaces with man pages, and oversight from before.
Reviewed by: jhb, bcr
Sponsored by: Netflix
Differential Revision: https://reviews.freebsd.org/D29937
66 lines
2.8 KiB
Groff
66 lines
2.8 KiB
Groff
.\"
|
|
.\" Copyright (c) 2021 Netflix, Inc.
|
|
.\"
|
|
.\" 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 April 22, 2021
|
|
.Dt BUS_CHILD_PNPINFO 9
|
|
.Os
|
|
.Sh NAME
|
|
.Nm BUS_CHILD_PNPINFO
|
|
.Nd "obtain the plug and play information from a device"
|
|
.Sh SYNOPSIS
|
|
.In sys/param.h
|
|
.In sys/bus.h
|
|
.In sys/sbuf.h
|
|
.Ft void
|
|
.Fn BUS_CHILD_PNPINFO "device_t dev" "device_t child" "struct sbuf *sb"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn BUS_CHILD_LOCATION
|
|
method returns the identifying information about the
|
|
.Dv child
|
|
device.
|
|
This information is called the plug and play (pnp) details by some buses.
|
|
This information is a series of key=value pairs.
|
|
The string must be formatted as a space-separated list of key=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 ('\').
|
|
.Pp
|
|
The pnpinfo is defined as a series of characteristics of the
|
|
.Dv child
|
|
device that are independent of which drivers are attached, but
|
|
are used to allow drivers to claim a device.
|
|
Typically, plug and play information encodes who made the device, what the model
|
|
number is, and some generic details about the device.
|
|
By convention, only the generic information about the device that's used by
|
|
drivers on that bus to decide on accepting the device is reported.
|
|
Other configuration information (such as the cache burst size) needed for the
|
|
operation of the device, but that doesn't distinguish it broadly from other
|
|
devices is not reported.
|
|
.Sh SEE ALSO
|
|
.Xr bus 9 ,
|
|
.Xr device 9
|