usr/src/man/man1m/prtconf.1m

   1 '\" te
   2 .\"  Copyright 1989 AT&T Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
   3 .\"  Copyright 2012, Joyent, Inc. All Rights Reserved
   4 .\" 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.
   5 .\" 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
   6 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH PRTCONF 1M "Jan 11, 2013"
   8 .SH NAME
   9 prtconf \- print system configuration
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fB/usr/sbin/prtconf\fR [\fB-V\fR] | [\fB-F\fR] | [\fB-x\fR] | [\fB-bpv\fR] | [\fB-acdDPv\fR]
  14      [\fIdev_path\fR]
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 The \fBprtconf\fR command prints the system configuration information. The
  21 output includes the total amount of memory, and the configuration of system
  22 peripherals formatted as a device tree.
  23 .sp
  24 .LP
  25 If a device path is specified on the command line for those command options
  26 that can take a device path, \fBprtconf\fR will only display information for
  27 that device node.
  28 .SH OPTIONS
  29 .sp
  30 .LP
  31 The following options are supported:
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fB-a\fR\fR
  36 .ad
  37 .RS 6n
  38 Display all the ancestors device nodes, up to the root node of the device tree,
  39 for the device specified on the command line.
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fB-b\fR\fR
  46 .ad
  47 .RS 6n
  48 Display the firmware device tree root properties for the purpose of platform
  49 identification. These properties are "name", "compatible", "banner-name" and
  50 "model".
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fB-c\fR\fR
  57 .ad
  58 .RS 6n
  59 Display the device subtree rooted at the device node specified on the command
  60 line, that is, display all the children of the device node specified on the
  61 command line.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fB-d\fR\fR
  68 .ad
  69 .RS 6n
  70 Display vendor ID and device ID for PCI and PCI Express devices, in addition to
  71 the nodename. If the information is known, the vendor name and device name will
  72 also be shown.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fB-D\fR\fR
  79 .ad
  80 .RS 6n
  81 For each system peripheral in the device tree, displays the name of the device
  82 driver used to manage the peripheral.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fB-F\fR\fR
  89 .ad
  90 .RS 6n
  91 A SPARC-only option. Returns the device path name of the console frame buffer,
  92 if one exists. If there is no frame buffer, \fBprtconf\fR returns a non-zero
  93 exit code. This flag must be used by itself. It returns only the name of the
  94 console, frame buffer device or a non-zero exit code. For example, if the
  95 console frame buffer on a SUNW,Ultra-30 is \fBffb\fR, the command returns:
  96 \fB/SUNW,ffb@1e,0:ffb0\fR. This option could be used to create a symlink for
  97 \fB/dev/fb\fR to the actual console device.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fB-p\fR\fR
 104 .ad
 105 .RS 6n
 106 Displays information derived from the device tree provided by the firmware
 107 (PROM) on SPARC platforms or the booting system on x86 platforms.The device
 108 tree information displayed using this option is a snapshot of the initial
 109 configuration and may not accurately reflect reconfiguration events that occur
 110 later.
 111 .RE
 112
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fB-P\fR\fR
 117 .ad
 118 .RS 6n
 119 Includes information about pseudo devices. By default, information regarding
 120 pseudo devices is omitted.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fB-v\fR\fR
 127 .ad
 128 .RS 6n
 129 Specifies verbose mode.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fB-V\fR\fR
 136 .ad
 137 .RS 6n
 138 Displays platform-dependent \fBPROM\fR (on SPARC platforms) or booting system
 139 (on x86 platforms) version information. This flag must be used by itself. The
 140 output is a string. The format of the string is arbitrary and
 141 platform-dependent.
 142 .RE
 143
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fB-x\fR\fR
 148 .ad
 149 .RS 6n
 150 Reports if the firmware on this system is 64-bit ready. Some existing platforms
 151 may need a firmware upgrade in order to run the 64-bit kernel. If the operation
 152 is not applicable to this platform or the firmware is already 64-bit ready, it
 153 exits silently with a return code of zero. If the operation is applicable to
 154 this platform and the firmware is not 64-bit ready, it displays a descriptive
 155 message on the standard output and exits with a non-zero return code. The
 156 hardware platform documentation contains more information about the platforms
 157 that may need a firmware upgrade in order to run the 64-bit kernel.
 158 .sp
 159 This flag overrides all other flags and must be used by itself.
 160 .RE
 161
 162 .SH OPERANDS
 163 .sp
 164 .LP
 165 The following operands are supported:
 166 .sp
 167 .ne 2
 168 .na
 169 \fB\fIdev_path\fR\fR
 170 .ad
 171 .RS 12n
 172 The path to a target device minor node, device nexus node, or device link for
 173 which device node configuration information is displayed
 174 .RE
 175
 176 .SH EXIT STATUS
 177 .sp
 178 .LP
 179 The following exit values are returned:
 180 .sp
 181 .ne 2
 182 .na
 183 \fB\fB0\fR\fR
 184 .ad
 185 .RS 12n
 186 No error occurred.
 187 .RE
 188
 189 .sp
 190 .ne 2
 191 .na
 192 \fB\fBnon-zero\fR\fR
 193 .ad
 194 .RS 12n
 195 With the \fB-F\fR option (SPARC only), a non-zero return value means that the
 196 output device is not a frame buffer. With the \fB-x\fR option, a non-zero
 197 return value means that the firmware is not 64-bit ready. In all other cases, a
 198 non-zero return value means that an error occurred.
 199 .RE
 200
 201 .SH ATTRIBUTES
 202 .sp
 203 .LP
 204 See \fBattributes\fR(5) for descriptions of the following attributes:
 205 .sp
 206
 207 .sp
 208 .TS
 209 box;
 210 c | c
 211 l | l .
 212 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 213 Interface Stability     Unstable
 214 .TE
 215
 216 .SH SEE ALSO
 217 .sp
 218 .LP
 219 \fBfuser\fR(1M), \fBmodinfo\fR(1M), \fBsysdef\fR(1M), \fBattributes\fR(5)
 220 .sp
 221 .LP
 222 \fISun Hardware Platform Guide\fR
 223 .SS "SPARC Only"
 224 .sp
 225 .LP
 226 \fBopenprom\fR(7D)
 227 .SH NOTES
 228 .sp
 229 .LP
 230 The output of the \fBprtconf\fR command is highly dependent on the version of
 231 the \fBPROM\fR installed in the system. The output will be affected in
 232 potentially all circumstances.
 233 .sp
 234 .LP
 235 The \fBdriver not attached\fR message means that no driver is currently
 236 attached to that instance of the device. In general, drivers are loaded and
 237 installed (and attached to hardware instances) on demand, and when needed, and
 238 may be uninstalled and unloaded when the device is not in use.
 239 .sp
 240 .LP
 241 On x86 platforms, the use of \fBprtconf\fR \fB-vp\fR provides a subset of
 242 information from \fBprtconf\fR \fB-v\fR. The value of integer properties from
 243 \fBprtconf\fR \fB-vp\fR might require byte swapping for correct interpretation.