sbin/devmatch/devmatch.8

   1 .\"
   2 .\" Copyright (c) 2017 Netflix, Inc.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
  14 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  15 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  16 .\" IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  17 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  18 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  19 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  20 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  22 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23 .\"
  24 .\" $FreeBSD$
  25 .\"
  26 .Dd October 12, 2020
  27 .Dt DEVMATCH 8
  28 .Os
  29 .Sh NAME
  30 .Nm devmatch
  31 .Nd print information about unattached devices
  32 .Sh SYNOPSIS
  33 .Nm
  34 .Op Fl adhpuv
  35 .Op Fl -all
  36 .Op Fl -dump
  37 .Op Fl -hints Ar file
  38 .Op Fl -nomatch Ar event
  39 .Op Fl -unbound
  40 .Op Fl -verbose
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 utility, without any arguments, prints all the kernel modules it has
  45 found for all the unattached, enabled devices in the system.
  46 .Bl -tag -width 20m
  47 .It Fl a Fl -all
  48 Include all devices, not just the ones that are unattached.
  49 .It Fl d Fl -dump
  50 Produce a human readable dump of the
  51 .Pa linker.hints
  52 file.
  53 .It Fl h Fl -hints Ar file
  54 Use the named
  55 .Ar file
  56 instead of
  57 .Pa linker.hints
  58 guessed from the current module load path.
  59 .It Fl p Fl -nomatch Ar event
  60 Parse and use a standard NOMATCH event from
  61 .Xr devd 8
  62 for matching instead of searching the device tree.
  63 .It Fl u Fl -unbound
  64 Attempt to produce a list of those drivers with PNP info whose driver
  65 tables with that PNP info can not be found.
  66 .It Fl v Fl -verbose
  67 Produce more verbose output.
  68 .El
  69 .Sh SEE ALSO
  70 .Xr devinfo 8 ,
  71 .Xr MODULE_PNP_INFO 9
  72 .Sh HISTORY
  73 .Nm
  74 first appeared in
  75 .Fx 12.0 .
  76 .Sh AUTHORS
  77 .An Warner Losh Aq Mt imp@FreeBSD.org
  78 .Sh BUGS
  79 The kernel has hints in it, but we exclude it from the list of modules
  80 to suggest for unmatched devices.
  81 We exclude it when suggesting drivers, but include it when looking for
  82 unbound devices or producing a full dump of
  83 .Pa linker.hints .
  84 This can be confusing.
  85 .Pp
  86 Some modules are hard links in
  87 .Pa /boot/kernel
  88 and will be reported twice.
  89 .Pp
  90 The PNP string's attributes are evaluated once per PNP entry on that
  91 bus rather than once.
  92 .Pp
  93 The term PNP is overloaded in FreeBSD.
  94 It means, generically, the identifying data the bus provides about a
  95 device.
  96 While this include old ISA PNP identifiers, it also includes the
  97 logical equivalent in USB, PCI, and others.
  98 .Pp
  99 Many drivers currently lack proper PNP table decorations and need to
 100 be updated.