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