share/man/man9/DEVICE_PROBE.9

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 1998 Doug Rabson
   4 .\"
   5 .\" All rights reserved.
   6 .\"
   7 .\" This program is free software.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd February 8, 2012
  32 .Dt DEVICE_PROBE 9
  33 .Os
  34 .Sh NAME
  35 .Nm DEVICE_PROBE
  36 .Nd probe for device existence
  37 .Sh SYNOPSIS
  38 .In sys/param.h
  39 .In sys/bus.h
  40 .Ft int
  41 .Fn DEVICE_PROBE "device_t dev"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn DEVICE_PROBE
  45 method should probe to see if the device is present.
  46 It should return 0 if the device exists,
  47 .Er ENXIO
  48 if it cannot be found.
  49 If some other error happens during the probe (such as a memory
  50 allocation failure), an appropriate error code should be returned.
  51 For
  52 cases where more than one driver matches a device, a priority value can
  53 be returned.
  54 In this case, success codes are values less than or equal
  55 to zero with the highest value representing the best match.
  56 Failure
  57 codes are represented by positive values and the regular
  58 .Ux
  59 error
  60 codes should be used for the purpose.
  61 .Pp
  62 If a driver returns a success code which is less than zero, it must
  63 not assume that it will be the same driver which is attached to the
  64 device.
  65 In particular, it must not assume that any values stored in
  66 the softc structure will be available for its attach method and any
  67 resources allocated during probe must be released and re-allocated
  68 if the attach method is called.
  69 In addition it is an absolute requirement that the probe routine have
  70 no side effects whatsoever.
  71 The probe routine may be called more than once before the attach
  72 routine is called.
  73 .Pp
  74 If a success code of zero is
  75 returned, the driver can assume that it will be the one attached, but
  76 must not hold any resources when the probe routine returns.
  77 A driver may assume that the softc is preserved when it returns
  78 a success code of zero.
  79 .Sh RETURN VALUES
  80 A value equal to or less than zero indicates success, greater than
  81 zero indicates an error (errno).
  82 For values equal to or less than
  83 zero: zero indicates highest priority, no further probing is done;
  84 for a value less than zero, the lower the value the lower the
  85 priority, e.g.\& -100 indicates a lower priority than -50.
  86 .Pp
  87 The following values are used by convention to indicate different
  88 strengths of matching in a probe routine.
  89 Except as noted, these are just suggested values, and there's nothing
  90 magical about them.
  91 .Bl -tag -width BUS_PROBE_NOWILDCARD
  92 .It BUS_PROBE_SPECIFIC
  93 The device that cannot be reprobed, and that no
  94 possible other driver may exist (typically legacy drivers who don't follow
  95 all the rules, or special needs drivers).
  96 .It BUS_PROBE_VENDOR
  97 The device is supported by a vendor driver.
  98 This is for source or binary drivers that are not yet integrated into the
  99 .Fx
 100 tree.
 101 Its use in the base OS is prohibited.
 102 .It BUS_PROBE_DEFAULT
 103 The device is a normal device matching some plug and play ID.  This is
 104 the normal return value for drivers to use.
 105 It is intended that nearly all of the drivers in the tree should return
 106 this value.
 107 .It BUS_PROBE_LOW_PRIORITY
 108 The driver is a legacy driver, or an otherwise less desirable driver
 109 for a given plug and play ID.
 110 The driver has special requirements like when there are two drivers
 111 that support overlapping series of hardware devices.
 112 In this case the one that supports the older part of the line would
 113 return this value, while the one that supports the newer ones would
 114 return BUS_PROBE_DEFAULT.
 115 .It BUS_PROBE_GENERIC
 116 The driver matches the type of device generally.
 117 This allows drivers to match all serial ports generally, with specialized
 118 drivers matching particular types of serial ports that need special
 119 treatment for some reason.
 120 .It BUS_PROBE_HOOVER
 121 The driver matches all unclaimed devices on a bus.
 122 The
 123 .Xr ugen 4
 124 device is one example.
 125 .It BUS_PROBE_NOWILDCARD
 126 The driver expects its parent to tell it which children to manage
 127 and no probing is really done.
 128 The device only matches if its parent bus specifically said to use
 129 this driver.
 130 .El
 131 .Sh SEE ALSO
 132 .Xr device 9 ,
 133 .Xr DEVICE_ATTACH 9 ,
 134 .Xr DEVICE_DETACH 9 ,
 135 .Xr DEVICE_IDENTIFY 9 ,
 136 .Xr DEVICE_SHUTDOWN 9
 137 .Sh AUTHORS
 138 This manual page was written by
 139 .An Doug Rabson .