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