xref: /titanic_41/usr/src/uts/common/io/pshot.conf (revision 70025d765b044c6d8594bb965a2247a61e991a99)
1#
2# CDDL HEADER START
3#
4# The contents of this file are subject to the terms of the
5# Common Development and Distribution License, Version 1.0 only
6# (the "License").  You may not use this file except in compliance
7# with the License.
8#
9# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10# or http://www.opensolaris.org/os/licensing.
11# See the License for the specific language governing permissions
12# and limitations under the License.
13#
14# When distributing Covered Code, include this CDDL HEADER in each
15# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16# If applicable, add the following below this CDDL HEADER, with the
17# fields enclosed by brackets "[]" replaced with your own identifying
18# information: Portions Copyright [yyyy] [name of copyright owner]
19#
20# CDDL HEADER END
21#
22#
23# Copyright 2003 Sun Microsystems, Inc.  All rights reserved.
24# Use is subject to license terms.
25#
26#pragma ident	"%Z%%M%	%I%	%E% SMI"
27#
28
29#
30# pshot is a pseudo driver for use in tests, together with another
31# pseudo driver, gen_drv.  These drivers' binaries are contained
32# within bfu archives and also packaged in the SUNWiotu and SUNWiotux.
33# These packages are not bundled as part of Solaris however.
34#
35# Once installed, these drivers may be enabled by running add_drv:
36#
37#	add_drv -i 'SUNW,pshot' pshot
38#	add_drv -i 'SUNW,gen_drv' gen_drv
39#
40
41name="pshot" class="root";
42
43
44#
45# How to add support for devices not included with the stock package, by
46# certain array properties:
47# (see pshot.h for the values of the <PSHOT_PROP_DEV.*> property names)
48#
49#
50# corresponding         |   pshot_device_t array elements
51# pshot_device_t        |
52# member by prop name   |   [0]            [1]           [2]
53# ----------------------|--------------|-------------|-----------------------
54# <PSHOT_PROP_DEVNAME>  ="disk",        "tape",       "testdev";
55# <PSHOT_PROP_DEVNT>    ="DDI_NT_BLOCK","DDI_NT_TAPE","ddi_testdev_nodetype";
56# <PSHOT_PROP_DEVCOMPAT>="testdrv",     "testdrv",    "testdrv";
57#
58#
59# this example adds 3 devices that may be parented by pshot:
60#			dev1		dev2		dev3
61#			----		----		----
62# node name:		disk		tape		testdev
63# node type:		DDI_NT_BLOCK	DDI_NT_TAPE	"ddi_testdev_nodetype"
64# compatible driver:	testdrv		testdrv		testdrv
65#
66# if any of these properties are specified, then:
67# - all the members must be specified
68# - the number of elements for each string array property must be the same
69# - no empty strings allowed
70# - nodetypes (PSHOT_PROP_DEVNT) must be the nodetype name as specified in
71#   sys/sunddi.h -- caveat: see below
72#
73# Current implementation allows for overriding of stock devices
74#	e.g. if the "disk" device is bound to the "gen_drv" driver, you may
75#	override that with your own driver,
76# as well as custom nodetypes
77#	i.e. if a value for <PSHOT_PROP_DEVNT> does not not match a known
78#	nodetype name, such as "DDI_NT_BLOCK" etc., then the supplied value
79#	will be used verbatim
80#
81# In addition, the current implementation only require that these properties
82# be specified for a single pshot instance in order to apply globably, so it's
83# possible to unclutter a device tree snapshot by applying these properties
84# just to the root pshot instance with a physically single long line of
85# property assignments:
86#    name="pshot" parent="/" <PSHOT_PROP_DEVNAME>="..",".." <PSHOT_PROP*>= ..;
87#
88