162a24de0SChris Horne /*
262a24de0SChris Horne * CDDL HEADER START
362a24de0SChris Horne *
462a24de0SChris Horne * The contents of this file are subject to the terms of the
562a24de0SChris Horne * Common Development and Distribution License (the "License").
662a24de0SChris Horne * You may not use this file except in compliance with the License.
762a24de0SChris Horne *
862a24de0SChris Horne * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
962a24de0SChris Horne * or http://www.opensolaris.org/os/licensing.
1062a24de0SChris Horne * See the License for the specific language governing permissions
1162a24de0SChris Horne * and limitations under the License.
1262a24de0SChris Horne *
1362a24de0SChris Horne * When distributing Covered Code, include this CDDL HEADER in each
1462a24de0SChris Horne * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
1562a24de0SChris Horne * If applicable, add the following below this CDDL HEADER, with the
1662a24de0SChris Horne * fields enclosed by brackets "[]" replaced with your own identifying
1762a24de0SChris Horne * information: Portions Copyright [yyyy] [name of copyright owner]
1862a24de0SChris Horne *
1962a24de0SChris Horne * CDDL HEADER END
2062a24de0SChris Horne */
2162a24de0SChris Horne /*
2262a24de0SChris Horne * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
2362a24de0SChris Horne * Use is subject to license terms.
2462a24de0SChris Horne */
2562a24de0SChris Horne
2662a24de0SChris Horne /*
2762a24de0SChris Horne * nulldriver - null device driver
2862a24de0SChris Horne *
2962a24de0SChris Horne * The nulldriver is used to associate a solaris driver with a specific
3062a24de0SChris Horne * device without enabling external device access.
3162a24de0SChris Horne *
3262a24de0SChris Horne * The driver can be used to:
3362a24de0SChris Horne *
3462a24de0SChris Horne * o Prevent external access to specific devices/hardware by associating a
3562a24de0SChris Horne * high-precedence 'compatible' binding, including a path-oriented alias,
3662a24de0SChris Horne * with nulldriver.
3762a24de0SChris Horne *
3862a24de0SChris Horne * o Enable a nexus bus_config implementation to perform dynamic child
3962a24de0SChris Horne * discovery by creating a child 'probe' devinfo node, bound to
4062a24de0SChris Horne * nulldriver, at the specific child @unit-addresses associated with
4162a24de0SChris Horne * discovery. With a nulldriver bound 'probe' node, nexus driver
4262a24de0SChris Horne * bus_config discovery code can use the same devinfo node oriented
4362a24de0SChris Horne * transport services for both discovery and normal-operation: which
4462a24de0SChris Horne * is a significant simplification. While nulldriver prevents external
4562a24de0SChris Horne * device access, a nexus driver can still internally use the transport
4662a24de0SChris Horne * services.
4762a24de0SChris Horne *
48*bbf21555SRichard Lowe * A scsi(5) example of this type of use is SCSA enumeration services
4962a24de0SChris Horne * issuing a scsi REPORT_LUN command to a lun-0 'probe' node bound to
5062a24de0SChris Horne * nulldriver in order to discover all luns supported by a target.
5162a24de0SChris Horne */
5262a24de0SChris Horne
5362a24de0SChris Horne #include <sys/modctl.h>
5462a24de0SChris Horne #include <sys/conf.h>
5562a24de0SChris Horne #include <sys/ddi.h>
5662a24de0SChris Horne #include <sys/sunddi.h>
5762a24de0SChris Horne #include <sys/cmn_err.h>
5862a24de0SChris Horne
5962a24de0SChris Horne static int nulldriver_getinfo(dev_info_t *, ddi_info_cmd_t, void *, void **);
6062a24de0SChris Horne static int nulldriver_probe(dev_info_t *);
6162a24de0SChris Horne static int nulldriver_attach(dev_info_t *, ddi_attach_cmd_t);
6262a24de0SChris Horne static int nulldriver_detach(dev_info_t *, ddi_detach_cmd_t);
6362a24de0SChris Horne
6462a24de0SChris Horne static struct cb_ops nulldriver_cb_ops = {
6562a24de0SChris Horne nodev, /* open */
6662a24de0SChris Horne nodev, /* close */
6762a24de0SChris Horne nodev, /* strategy */
6862a24de0SChris Horne nodev, /* print */
6962a24de0SChris Horne nodev, /* dump */
7062a24de0SChris Horne nodev, /* read */
7162a24de0SChris Horne nodev, /* write */
7262a24de0SChris Horne nodev, /* ioctl */
7362a24de0SChris Horne nodev, /* devmap */
7462a24de0SChris Horne nodev, /* mmap */
7562a24de0SChris Horne nodev, /* segmap */
7662a24de0SChris Horne nochpoll, /* poll */
7762a24de0SChris Horne ddi_prop_op, /* cb_prop_op */
7862a24de0SChris Horne 0, /* streamtab */
7962a24de0SChris Horne D_MP | D_NEW | D_HOTPLUG /* Driver compatibility flag */
8062a24de0SChris Horne };
8162a24de0SChris Horne
8262a24de0SChris Horne static struct dev_ops nulldriver_dev_ops = {
8362a24de0SChris Horne DEVO_REV, /* devo_rev, */
8462a24de0SChris Horne 0, /* refcnt */
8562a24de0SChris Horne nulldriver_getinfo, /* info */
8662a24de0SChris Horne nodev, /* identify */
8762a24de0SChris Horne nulldriver_probe, /* probe */
8862a24de0SChris Horne nulldriver_attach, /* attach */
8962a24de0SChris Horne nulldriver_detach, /* detach */
9062a24de0SChris Horne nodev, /* reset */
9162a24de0SChris Horne &nulldriver_cb_ops, /* driver operations */
9262a24de0SChris Horne (struct bus_ops *)0, /* bus operations */
9362a24de0SChris Horne NULL, /* power */
9462a24de0SChris Horne ddi_quiesce_not_needed, /* quiesce */
9562a24de0SChris Horne };
9662a24de0SChris Horne
9762a24de0SChris Horne static struct modldrv modldrv = {
9862a24de0SChris Horne &mod_driverops, "nulldriver 1.1", &nulldriver_dev_ops
9962a24de0SChris Horne };
10062a24de0SChris Horne
10162a24de0SChris Horne static struct modlinkage modlinkage = {
10262a24de0SChris Horne MODREV_1, &modldrv, NULL
10362a24de0SChris Horne };
10462a24de0SChris Horne
10562a24de0SChris Horne int
_init(void)10662a24de0SChris Horne _init(void)
10762a24de0SChris Horne {
10862a24de0SChris Horne return (mod_install(&modlinkage));
10962a24de0SChris Horne }
11062a24de0SChris Horne
11162a24de0SChris Horne int
_fini(void)11262a24de0SChris Horne _fini(void)
11362a24de0SChris Horne {
11462a24de0SChris Horne return (mod_remove(&modlinkage));
11562a24de0SChris Horne }
11662a24de0SChris Horne
11762a24de0SChris Horne int
_info(struct modinfo * modinfop)11862a24de0SChris Horne _info(struct modinfo *modinfop)
11962a24de0SChris Horne {
12062a24de0SChris Horne return (mod_info(&modlinkage, modinfop));
12162a24de0SChris Horne }
12262a24de0SChris Horne
12362a24de0SChris Horne /*ARGSUSED*/
12462a24de0SChris Horne static int
nulldriver_getinfo(dev_info_t * dip,ddi_info_cmd_t infocmd,void * arg,void ** result)12562a24de0SChris Horne nulldriver_getinfo(dev_info_t *dip, ddi_info_cmd_t infocmd,
12662a24de0SChris Horne void *arg, void **result)
12762a24de0SChris Horne {
12862a24de0SChris Horne return (DDI_FAILURE);
12962a24de0SChris Horne }
13062a24de0SChris Horne
13162a24de0SChris Horne /*ARGSUSED*/
13262a24de0SChris Horne static int
nulldriver_probe(dev_info_t * dip)13362a24de0SChris Horne nulldriver_probe(dev_info_t *dip)
13462a24de0SChris Horne {
13562a24de0SChris Horne /*
13662a24de0SChris Horne * We want to succeed probe so that the node gets assigned a unit
13762a24de0SChris Horne * address "@addr".
13862a24de0SChris Horne */
13962a24de0SChris Horne if (ddi_dev_is_sid(dip) == DDI_SUCCESS)
14062a24de0SChris Horne return (DDI_PROBE_DONTCARE);
14162a24de0SChris Horne return (DDI_PROBE_DONTCARE);
14262a24de0SChris Horne }
14362a24de0SChris Horne
14462a24de0SChris Horne /*
14562a24de0SChris Horne * nulldriver_attach()
14662a24de0SChris Horne * attach(9e) entrypoint.
14762a24de0SChris Horne */
14862a24de0SChris Horne /* ARGSUSED */
14962a24de0SChris Horne static int
nulldriver_attach(dev_info_t * dip,ddi_attach_cmd_t cmd)15062a24de0SChris Horne nulldriver_attach(dev_info_t *dip, ddi_attach_cmd_t cmd)
15162a24de0SChris Horne {
15262a24de0SChris Horne switch (cmd) {
15362a24de0SChris Horne case DDI_ATTACH:
15462a24de0SChris Horne case DDI_RESUME:
15562a24de0SChris Horne return (DDI_SUCCESS);
15662a24de0SChris Horne
15762a24de0SChris Horne case DDI_PM_RESUME:
15862a24de0SChris Horne default:
15962a24de0SChris Horne return (DDI_FAILURE);
16062a24de0SChris Horne }
16162a24de0SChris Horne }
16262a24de0SChris Horne
16362a24de0SChris Horne /*
16462a24de0SChris Horne * nulldriver_detach()
16562a24de0SChris Horne * detach(9E) entrypoint
16662a24de0SChris Horne */
16762a24de0SChris Horne /* ARGSUSED */
16862a24de0SChris Horne static int
nulldriver_detach(dev_info_t * dip,ddi_detach_cmd_t cmd)16962a24de0SChris Horne nulldriver_detach(dev_info_t *dip, ddi_detach_cmd_t cmd)
17062a24de0SChris Horne {
17162a24de0SChris Horne switch (cmd) {
17262a24de0SChris Horne case DDI_DETACH:
17362a24de0SChris Horne case DDI_SUSPEND:
17462a24de0SChris Horne return (DDI_SUCCESS);
17562a24de0SChris Horne
17662a24de0SChris Horne case DDI_PM_SUSPEND:
17762a24de0SChris Horne default:
17862a24de0SChris Horne return (DDI_FAILURE);
17962a24de0SChris Horne }
18062a24de0SChris Horne }
181