xref: /illumos-gate/usr/src/man/man9f/ddi_dev_is_sid.9f (revision 74e12c43fe52f2c30f36e65a4d0fb0e8dfd7068a)
te
Copyright (c) 2006, Sun Microsystems, Inc.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
DDI_DEV_IS_SID 9F "Jan 16, 2006"
NAME
ddi_dev_is_sid - tell whether a device is self-identifying
SYNOPSIS
#include <sys/conf.h>
#include <sys/ddi.h>
#include <sys/sunddi.h>



int ddi_dev_is_sid(dev_info_t *dip);
INTERFACE LEVEL
illumos DDI specific (illumos DDI).
PARAMETERS
dip

A pointer to the device's dev_info structure.

DESCRIPTION
The ddi_dev_is_sid() function tells the caller whether the device described by dip is self-identifying, that is, a device that can unequivocally tell the system that it exists. This is useful for drivers that support both a self-identifying as well as a non-self-identifying variants of a device (and therefore must be probed).
RETURN VALUES
DDI_SUCCESS

Device is self-identifying.

DDI_FAILURE

Device is not self-identifying.

CONTEXT
The ddi_dev_is_sid() function can be called from user, interrupt, or kernel context.
EXAMPLES
1 ...
2 int
3 bz_probe(dev_info_t *dip)
4 {
5 ...
6 if (ddi_dev_is_sid(dip) == DDI_SUCCESS) {
7 /*
8 * This is the self-identifying version (OpenBoot).
9 * No need to probe for it because we know it is there.
10 * The existence of dip && ddi_dev_is_sid() proves this.
11 */
12 return (DDI_PROBE_DONTCARE);
13 }
14 /*
15 * Not a self-identifying variant of the device. Now we have to
16 * do some work to see whether it is really attached to the
17 * system.
18 */
19 ...
SEE ALSO
probe(9E) Writing Device Drivers