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: src/share/man/man9/DEVICE_PROBE.9,v 1.4.2.6 2001/12/17 11:30:18 ru Exp $
  30 .\" $DragonFly: src/share/man/man9/DEVICE_PROBE.9,v 1.2 2003/06/17 04:37:01 dillon Exp $
  31 .\"
  32 .Dd June 16, 1998
  33 .Dt DEVICE_PROBE 9
  34 .Os
  35 .Sh NAME
  36 .Nm DEVICE_PROBE
  37 .Nd probe for device existence
  38 .Sh SYNOPSIS
  39 .In sys/param.h
  40 .In sys/bus.h
  41 .Ft int
  42 .Fn DEVICE_PROBE "device_t dev"
  43 .Sh DESCRIPTION
  44 This device method should probe to see if the device is present.
  45 It should return 0 if the device exists,
  46 .Er ENXIO
  47 if it cannot be found.
  48 If some other error happens during the probe (such as a memory
  49 allocation failure), an appropriate error code should be returned.
  50 For
  51 cases where more than one driver matches a device, a priority value can
  52 be returned.  In this case, success codes are values less than or equal
  53 to zero with the highest value representing the best match.  Failure
  54 codes are represented by positive values and the regular unix error
  55 codes should be used for the purpose.
  56 .Pp
  57 If a driver returns a success code which is less than zero, it must
  58 not assume that it will be the same driver which is attached to the
  59 device.
  60 In particular, it must not assume that any values stored in
  61 the softc structure will be available for its attach method and any
  62 resources allocated during probe must be released and re-allocated
  63 if the attach method is called.
  64 If a success code of zero is
  65 returned, the driver can assume that it will be the one attached.
  66 .Pp
  67 Devices which implement busses should use this method to probe for
  68 the existence of devices attached to the bus and add them as
  69 children.
  70 If this is combined with the use of
  71 .Xr bus_generic_attach 9
  72 the child devices will be automatically probed and attached.
  73 .Sh RETURN VALUES
  74 A value equal to or less than zero indicates success, greater than
  75 zero indicates an error (errno). For values equal to or less than
  76 zero: zero indicates highest priority, no further probing is done;
  77 for a value less then zero, the lower the value the lower the
  78 priority, e.g. -100 indicates a lower priority than -50.
  79 .Sh SEE ALSO
  80 .Xr device 9 ,
  81 .Xr DEVICE_ATTACH 9
  82 .Sh AUTHORS
  83 This man page was written by
  84 .An Doug Rabson .