d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
9bbd1a8fcb
freebsd-skq/sbin/devmatch/devmatch.8

101 lines
3.2 KiB
Groff
Raw Normal View History

Match unattached devices on the system to potential kernel modules. devmatch(8) matchs up devices in the system device tree with drivers that may match them. For each unattached device in the system, it tries to find matching PNP info in the linker hints and prints modules to load to claim the devices. In --unbound mode, devmatch can look for drivers that have attached to devices in the device tree and have plug and play information, but for which no PNP info exists. This helps find drivers that haven't been converted yet that are in use on this system. In addition, the ability to dump out linker.hints is provided. Future commits will add hooks to devd.conf and rc.d to fully automate using this information.
2017-12-25 18:56:08 +00:00
.\"
Regularize the Netflix copyright Use recent best practices for Copyright form at the top of the license: 1. Remove all the All Rights Reserved clauses on our stuff. Where we piggybacked others, use a separate line to make things clear. 2. Use "Netflix, Inc." everywhere. 3. Use a single line for the copyright for grep friendliness. 4. Use date ranges in all places for our stuff. Approved by: Netflix Legal (who gave me the form), adrian@ (pmc files)
2019-02-04 21:28:25 +00:00
.\" Copyright (c) 2017 Netflix, Inc.
Match unattached devices on the system to potential kernel modules. devmatch(8) matchs up devices in the system device tree with drivers that may match them. For each unattached device in the system, it tries to find matching PNP info in the linker hints and prints modules to load to claim the devices. In --unbound mode, devmatch can look for drivers that have attached to devices in the device tree and have plug and play information, but for which no PNP info exists. This helps find drivers that haven't been converted yet that are in use on this system. In addition, the ability to dump out linker.hints is provided. Future commits will add hooks to devd.conf and rc.d to fully automate using this information.
2017-12-25 18:56:08 +00:00
.\"
.\" 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 AUTHORS ``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 AUTHORS 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$
.\"
devmatch: First appeared in 12.0 Document that devmatch first appeared in FreeBSD 12.0. Also can't -> can not. But it doesn't help the sentence much. MFC After: 3 days
2020-10-13 05:32:00 +00:00
.Dd October 12, 2020
Match unattached devices on the system to potential kernel modules. devmatch(8) matchs up devices in the system device tree with drivers that may match them. For each unattached device in the system, it tries to find matching PNP info in the linker hints and prints modules to load to claim the devices. In --unbound mode, devmatch can look for drivers that have attached to devices in the device tree and have plug and play information, but for which no PNP info exists. This helps find drivers that haven't been converted yet that are in use on this system. In addition, the ability to dump out linker.hints is provided. Future commits will add hooks to devd.conf and rc.d to fully automate using this information.
2017-12-25 18:56:08 +00:00
.Dt DEVMATCH 8
.Os
.Sh NAME
Fix cut and paste error from devinfo.8 origin of this file Noticed by: kevans@
2018-01-05 05:02:09 +00:00
.Nm devmatch
Match unattached devices on the system to potential kernel modules. devmatch(8) matchs up devices in the system device tree with drivers that may match them. For each unattached device in the system, it tries to find matching PNP info in the linker hints and prints modules to load to claim the devices. In --unbound mode, devmatch can look for drivers that have attached to devices in the device tree and have plug and play information, but for which no PNP info exists. This helps find drivers that haven't been converted yet that are in use on this system. In addition, the ability to dump out linker.hints is provided. Future commits will add hooks to devd.conf and rc.d to fully automate using this information.
2017-12-25 18:56:08 +00:00
.Nd print information about unattached devices
.Sh SYNOPSIS
.Nm
Implement --hints to read hints file directly In testing, it's often useful to copy a few files into a directory and kldxref them to ensure that particular cases are handled correctly. Add --hints (-h) to facilitate this testing and enable future automated testing. Sponsored by: Netflix
2018-02-17 06:57:43 +00:00
.Op Fl adhpuv
Match unattached devices on the system to potential kernel modules. devmatch(8) matchs up devices in the system device tree with drivers that may match them. For each unattached device in the system, it tries to find matching PNP info in the linker hints and prints modules to load to claim the devices. In --unbound mode, devmatch can look for drivers that have attached to devices in the device tree and have plug and play information, but for which no PNP info exists. This helps find drivers that haven't been converted yet that are in use on this system. In addition, the ability to dump out linker.hints is provided. Future commits will add hooks to devd.conf and rc.d to fully automate using this information.
2017-12-25 18:56:08 +00:00
.Op Fl -all
.Op Fl -dump
Implement --hints to read hints file directly In testing, it's often useful to copy a few files into a directory and kldxref them to ensure that particular cases are handled correctly. Add --hints (-h) to facilitate this testing and enable future automated testing. Sponsored by: Netflix
2018-02-17 06:57:43 +00:00
.Op Fl -hints Ar file
.Op Fl -nomatch Ar event
Match unattached devices on the system to potential kernel modules. devmatch(8) matchs up devices in the system device tree with drivers that may match them. For each unattached device in the system, it tries to find matching PNP info in the linker hints and prints modules to load to claim the devices. In --unbound mode, devmatch can look for drivers that have attached to devices in the device tree and have plug and play information, but for which no PNP info exists. This helps find drivers that haven't been converted yet that are in use on this system. In addition, the ability to dump out linker.hints is provided. Future commits will add hooks to devd.conf and rc.d to fully automate using this information.
2017-12-25 18:56:08 +00:00
.Op Fl -unbound
.Op Fl -verbose
.Sh DESCRIPTION
The
.Nm
utility, without any arguments, prints all the kernel modules it has
found for all the unattached, enabled devices in the system.
.Bl -tag -width 20m
.It Fl a Fl -all
Include all devices, not just the ones that are unattached.
.It Fl d Fl -dump
Produce a human readable dump of the
.Pa linker.hints
file.
Implement --hints to read hints file directly In testing, it's often useful to copy a few files into a directory and kldxref them to ensure that particular cases are handled correctly. Add --hints (-h) to facilitate this testing and enable future automated testing. Sponsored by: Netflix
2018-02-17 06:57:43 +00:00
.It Fl h Fl -hints Ar file
Use the named
.Ar file
instead of
.Pa linker.hints
guessed from the current module load path.
.It Fl p Fl -nomatch Ar event
Add option to parse NOMATCH event and suggest modules to load Add --nomatch/-p to search for individual drivers based on a NOMATCH event from devd. Submitted by: hps (earlier version) Sponsored by: Netflix
2018-02-17 06:57:34 +00:00
Parse and use a standard NOMATCH event from
.Xr devd 8
for matching instead of searching the device tree.
Match unattached devices on the system to potential kernel modules. devmatch(8) matchs up devices in the system device tree with drivers that may match them. For each unattached device in the system, it tries to find matching PNP info in the linker hints and prints modules to load to claim the devices. In --unbound mode, devmatch can look for drivers that have attached to devices in the device tree and have plug and play information, but for which no PNP info exists. This helps find drivers that haven't been converted yet that are in use on this system. In addition, the ability to dump out linker.hints is provided. Future commits will add hooks to devd.conf and rc.d to fully automate using this information.
2017-12-25 18:56:08 +00:00
.It Fl u Fl -unbound
Attempt to produce a list of those drivers with PNP info whose driver
devmatch: First appeared in 12.0 Document that devmatch first appeared in FreeBSD 12.0. Also can't -> can not. But it doesn't help the sentence much. MFC After: 3 days
2020-10-13 05:32:00 +00:00
tables with that PNP info can not be found.
Match unattached devices on the system to potential kernel modules. devmatch(8) matchs up devices in the system device tree with drivers that may match them. For each unattached device in the system, it tries to find matching PNP info in the linker hints and prints modules to load to claim the devices. In --unbound mode, devmatch can look for drivers that have attached to devices in the device tree and have plug and play information, but for which no PNP info exists. This helps find drivers that haven't been converted yet that are in use on this system. In addition, the ability to dump out linker.hints is provided. Future commits will add hooks to devd.conf and rc.d to fully automate using this information.
2017-12-25 18:56:08 +00:00
.It Fl v Fl -verbose
Produce more verbose output.
.El
.Sh SEE ALSO
devmatch.8: Link to MODULE_PNP_INFO(9) Sponsored by: Dell EMC Isilon
2018-02-12 22:43:47 +00:00
.Xr devinfo 8 ,
.Xr MODULE_PNP_INFO 9
devmatch(8): Fix section ordering - sections out of conventional order: Sh HISTORY
2020-11-20 16:34:01 +00:00
.Sh HISTORY
.Nm
first appeared in
.Fx 12.0 .
Fix a few mandoc issues - no blank before trailing delimiter - whitespace at end of input line - sections out of conventional order - normalizing date format - AUTHORS section without An macro
2020-10-09 14:03:45 +00:00
.Sh AUTHORS
.An Warner Losh Aq Mt imp@FreeBSD.org
Match unattached devices on the system to potential kernel modules. devmatch(8) matchs up devices in the system device tree with drivers that may match them. For each unattached device in the system, it tries to find matching PNP info in the linker hints and prints modules to load to claim the devices. In --unbound mode, devmatch can look for drivers that have attached to devices in the device tree and have plug and play information, but for which no PNP info exists. This helps find drivers that haven't been converted yet that are in use on this system. In addition, the ability to dump out linker.hints is provided. Future commits will add hooks to devd.conf and rc.d to fully automate using this information.
2017-12-25 18:56:08 +00:00
.Sh BUGS
The kernel has hints in it, but we exclude it from the list of modules
to suggest for unmatched devices.
We exclude it when suggesting drivers, but include it when looking for
unbound devices or producing a full dump of
.Pa linker.hints .
This can be confusing.
.Pp
Some modules are hard links in
.Pa /boot/kernel
and will be reported twice.
.Pp
The PNP string's attributes are evaluated once per PNP entry on that
bus rather than once.
.Pp
The term PNP is overloaded in FreeBSD.
It means, generically, the identifying data the bus provides about a
device.
While this include old ISA PNP identifiers, it also includes the
logical equivalent in USB, PCI, and others.
.Pp
Many drivers currently lack proper PNP table decorations and need to
be updated.
Reference in New Issue Copy Permalink