objmgr.itu revision 7c478bd95313f5f23a4c958a745db2134aa03244
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# Copyright 2005 Sun Microsystems, Inc. All rights reserved.
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# Use is subject to license terms.
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# CDDL HEADER START
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# The contents of this file are subject to the terms of the
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# Common Development and Distribution License, Version 1.0 only
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# (the "License"). You may not use this file except in compliance
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# with the License.
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# See the License for the specific language governing permissions
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# and limitations under the License.
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# When distributing Covered Code, include this CDDL HEADER in each
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# If applicable, add the following below this CDDL HEADER, with the
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# fields enclosed by brackets "[]" replaced with your own identifying
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# information: Portions Copyright [yyyy] [name of copyright owner]
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# CDDL HEADER END
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab#pragma ident "%Z%%M% %I% %E% SMI"
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# Each entry in the description file is a line that establishes the
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# value of a keyword in the following form:
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# keyword = value
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# A line with a '#' character in the first column is considered to be a
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# comment. Spaces and tabs are allowed around the '=' operator. Left
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# and right braces can be used for grouping (see examples) but may not be
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# nested. There is no required order in which the keywords must be
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# specified within the file. The known list of keywords is included
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# below. The keyword is listed, followed by one or more usage examples,
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# followed by a description. Keywords are case-sensitive, so 'name' is
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# a valid keyword, but 'NAME' is not a valid keyword.
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# In general, only one value assignment should be made to a keyword, but
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# some keywords can be assigned values on more than one line of the
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# .itu. Keyword assignments in the description file are case sensitive.
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# ------------------------------------------
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# The name of the Solaris module being delivered. This keyword must be
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# assigned a value in every description file.
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# Example: name=geewhiz
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# itu_type=
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# Defines the scope of the module delivery. The only valid itu_type
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# values are 'complete' and 'partial'. The 'complete' itu_type implies
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# a full set of module, module.conf, module.bef and device database
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# entries is being delivered and that the driver being delivered did not
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# exist on the installation medium for the release being supplemented.
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# In all other cases the itu_type should be 'partial'. This keyword
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# must be assigned a value in every description file.
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# Example: itu_type=complete
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# interface_version=
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# Major.Minor number that versions the .itu keywords and file syntax.
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# If in the future changes are needed to the syntax of the .itu file
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# that would obsolete older .itu files, an appropriate version number
b9bd317cda1afb3a01f4812de73e8cec888cbbd7ab# change should occur. Currently this keyword should always be assigned
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# the value of 1.0. This keyword must be assigned a value in every
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# description file.
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# Example: interface_version=1.0
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# (NOTE: This keyword is to be ignored by development. It will be
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# assigned a value by the RE group.)
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# The patch id that should be assigned to the patch that make_ITU
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# creates. This keyword must be assigned a value in every
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# description file.
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# Example: patchid=102345-01
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# driverpkg=
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# (NOTE: This keyword is to be ignored by development. It will be
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# assigned a value by the RE group.)
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# The name of the package that the module resides in on the install
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# medium. If the module is new, the name of the package that should be
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# extended to include this module, or the name of a new package that
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# should be constructed. This is the abbreviated name that is assigned
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# to the PKG parameter in the package's pkginfo file. This keyword must
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# be assigned a value in any description file when the delivery includes
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# a solaris module.
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# Example: driverpkg=SUNWos86r
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# driverpkgvers=
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# (NOTE: This keyword is to be ignored by development. It will be
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# assigned a value by the RE group.)
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# The value to assign to the VERSION parameter in the driver package's
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# pkginfo. This should be identical to the VERSION value on the install
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# medium in the case where the package existed on the install
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# medium. This keyword must be assigned a value if the driverpkg keyword
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# has been assigned a value. The value assigned to this keyword is expected
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# to be a quoted string.
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# Example: driverpkgvers="1.1.0,REV=0.0.0"
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# driverpkgdesc=
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# (NOTE: This keyword is to be ignored by development. It will be
1dd08564e4a3aafe66b00aee6f222b0885346fe8ab# assigned a value by the RE group.)
# /etc/driver_classes file.
# Describes an entry to be appended to the /etc/system file (which is
# Describes an entry to be appended to the /etc/devlink.tab file (which
# /platform/`uname -i`/kernel/drv will be assumed.
# Example: driver_path=/kernel/drv
# /platform/i86pc/boot/solaris/drivers/isa.160. This keyword is
# Example: realmode_path=/platform/i86pc/boot/solaris/drivers/notisa.010
# Example: bef_name=whiz.bef
# driver for that device is ncrs.bef. The database also has a 'describe_dev'
# the kernel device tree (/devices/BUS/device_name...) when initialized.
# This is either the name of the module itself, (e.g., smc), or a name