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