usr/src/man/man4/path_to_inst.4

   1 '\" te
   2 .\"  Copyright 1992 Sun Microsystems Inc.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH PATH_TO_INST 4 "May 18, 2007"
   7 .SH NAME
   8 path_to_inst \- device instance number file
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/etc/path_to_inst\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 \fB/etc/path_to_inst\fR records mappings of physical device names to instance
  19 numbers.
  20 .sp
  21 .LP
  22 The instance number of a device is encoded in its minor number, and is the way
  23 that a device driver determines which of the possible devices that it may drive
  24 is referred to by a given special file.
  25 .sp
  26 .LP
  27 In order to keep instance numbers persistent across reboots, the system records
  28 them in \fB/etc/path_to_inst\fR.
  29 .sp
  30 .LP
  31 This file is read only at boot time, and is updated by \fBadd_drv\fR(1M) and
  32 \fBdevfsadm\fR(1M).
  33 .sp
  34 .LP
  35 Note that it is generally not necessary for the system administrator to change
  36 this file, as the system will maintain it.
  37 .sp
  38 .LP
  39 The system administrator can change the assignment of instance numbers by
  40 editing this file and doing a reconfiguration reboot. However, any changes made
  41 in this file will be lost if \fBadd_drv\fR(1M) or \fBdevfsadm\fR(1M) is run
  42 before the system is rebooted.
  43 .sp
  44 .LP
  45 Each instance entry is a single line of the form:
  46 .sp
  47 .in +2
  48 .nf
  49 \fB"\fR\fIphysical name\fR\fB"\fR \fIinstance\fR \fInumber\fR \fB"\fR\fIdriver binding name\fR\fB"\fR
  50 .fi
  51 .in -2
  52
  53 .sp
  54 .LP
  55 where
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fIphysical\fR \fIname\fR\fR
  60 .ad
  61 .RS 23n
  62 is the absolute physical pathname of a device. This pathname must be enclosed
  63 in double quotes.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fIinstance number\fR\fR
  70 .ad
  71 .RS 23n
  72 is a decimal or hexadecimal number.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fIdriver binding name\fR\fR
  79 .ad
  80 .RS 23n
  81 is the name used to determine the driver for the device. This name may be a
  82 driver alias or a driver name. The driver binding name must be enclosed in
  83 double quotes.
  84 .RE
  85
  86 .SH EXAMPLES
  87 .LP
  88 \fBExample 1 \fRSample \fBpath_to_inst\fR Entries
  89 .sp
  90 .LP
  91 Here are some sample \fBpath_to_inst\fR entries:
  92
  93 .sp
  94 .in +2
  95 .nf
  96 "/iommu@f,e0000000" 0 "iommu"
  97 "/iommu@f,e0000000/sbus@f,e0001000" 0 "sbus"
  98 "/iommu@f,e0000000/sbus@f,e0001000/sbusmem@e,0" 14 "sbusmem"
  99 "/iommu@f,e0000000/sbus@f,e0001000/sbusmem@f,0" 15 "sbusmem"
 100 "/iommu@f,e0000000/sbus@f,e0001000/ledma@f,400010" 0 "ledma"
 101 "/obio/serial@0,100000" 0 "zs"
 102 "/SUNW,sx@f,80000000" 0 "SUNW,sx"
 103 .fi
 104 .in -2
 105 .sp
 106
 107 .SH FILES
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fB/etc/path_to_inst\fR\fR
 112 .ad
 113 .RS 21n
 114 Mapping of physical device names to instance numbers.
 115 .RE
 116
 117 .SH SEE ALSO
 118 .sp
 119 .LP
 120 \fBadd_drv\fR(1M), \fBboot\fR(1M), \fBdevfsadm\fR(1M), \fBmknod\fR(1M)
 121 .SH WARNINGS
 122 .sp
 123 .LP
 124 If the file is removed the system may not be bootable (as it may rely on
 125 information found in this file to find the root, usr or swap device). If it
 126 does successfully boot, it will regenerate the file, but after rebooting
 127 devices may end up having different minor numbers than they did before, and
 128 special files created via \fBmknod\fR(1M) may refer to different devices than
 129 expected.
 130 .sp
 131 .LP
 132 For the same reasons, changes should not be made to this file without careful
 133 consideration.
 134 .SH NOTES
 135 .sp
 136 .LP
 137 This document does not constitute an API. \fBpath_to_inst\fR may not exist or
 138 may have a different content or interpretation in a future release. The
 139 existence of this notice does not imply that any other documentation that lacks
 140 this notice constitutes an API.