1 '\" te 2 .\" Copyright (c) 1999 Sun Microsystems, Inc. All Rights Reserved. 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 CFGADM_AC 1M "Sep 29, 1999" 7 .SH NAME 8 cfgadm_ac \- EXX00 memory system administration 9 .SH SYNOPSIS 10 .LP 11 .nf 12 \fB/usr/sbin/cfgadm\fR [\fB-c\fR configure] [\fB-f\fR] 13 [\fB-o\fR disable-at-boot | enable-at-boot ] ac\fI#\fR:bank\fI#\fR ... 14 .fi 15 16 .LP 17 .nf 18 \fB/usr/sbin/cfgadm\fR [\fB-c\fR unconfigure] 19 [\fB-o\fR disable-at-bootp | enable-at-boot ] ac\fI#\fR:bank\fI#\fR ... 20 .fi 21 22 .LP 23 .nf 24 \fB/usr/sbin/cfgadm\fR [\fB-v\fR] 25 [\fB-o\fR quick | normal | extended, [max_errors=\fI#\fR] ] \fB-t\fR ac\fI#\fR:bank\fI#\fR... 26 .fi 27 28 .LP 29 .nf 30 \fB/usr/sbin/cfgadm\fR \fB-x\fR relocate-test ac\fI#\fR:bank\fI#\fR ... 31 .fi 32 33 .LP 34 .nf 35 \fB/usr/sbin/cfgadm\fR [\fB-l\fR] \fB-o\fR disable-at-boot | enable-at-boot ac\fI#\fR:bank\fI#\fR ... 36 .fi 37 38 .SH DESCRIPTION 39 .sp 40 .LP 41 The \fBac\fR hardware specific library 42 \fB/usr/platform/sun4u/lib/cfgadm/cfgadm_ac.so.1\fR provides the functionality 43 for configuring and unconfiguring memory banks on \fBE6X00\fR, \fBE5X00\fR, 44 \fBE4X00\fR and \fBE3X00\fR systems as part of the Dynamic Reconfiguration of 45 \fBCPU\fR/Memory boards using \fBcfgadm_sysctrl\fR(1M). 46 .sp 47 .LP 48 Memory banks appear as attachment points in the device tree. For each 49 \fBCPU\fR/Memory board, two attachment points are published, one for each bank 50 on the board: \fBbank0\fR and \fBbank1\fR. If the bank is unpopulated, the 51 receptacle state is empty. If the bank is populated, the receptacle state is 52 connected. The receptacle state of a memory bank can never be disconnected. The 53 occupant state of a connected memory bank can be configured or unconfigured. If 54 the occupant state is configured, the memory is in use by Solaris, if 55 unconfigured it is not. 56 .SH OPTIONS 57 .sp 58 .LP 59 Refer to \fBcfgadm\fR(1M) for complete descriptions of the command options. 60 .sp 61 .LP 62 The following options are supported: 63 .sp 64 .ne 2 65 .na 66 \fB\fB-c\fR configure | unconfigure\fR 67 .ad 68 .sp .6 69 .RS 4n 70 Change the occupant state. The \fBconfigure\fR argument ensures that the memory 71 is initialized and adds the memory to the Solaris memory pool. The 72 \fBunconfigure\fR argument removes the memory from use by Solaris. When a 73 \fBCPU\fR/Memory board is to be removed from a system, both banks of memory 74 must be unconfigured. 75 .sp 76 \fBcfgadm\fR refuses the \fBconfigure\fR operation if the memory on the board 77 is marked \fBdisabled-at-boot\fR (see \fBinfo\fR field), unless either the 78 \fB-f\fR (force) option or the enable at boot flag, (\fB-o\fR 79 \fBenable-at-boot\fR), is given. The configure operation takes a short time 80 proportional to the size of memory that must be initialized. 81 .sp 82 \fBcfgadm\fR refuses the \fBunconfigure\fR operation if there is not enough 83 uncommitted memory in the system (\fBVM viability\fR error) or if the bank to 84 be unconfigured has memory that can't be removed (\fBnon-relocatable pages\fR 85 error). The presence of non-relocatable pages is indicated by the word 86 \fBpermanent\fR in the \fBinfo\fR listing field. Removing memory from use by 87 Solaris may take a significant time due to factors such as system load and how 88 much paging to secondary storage is required. The \fBunconfigure\fR operation 89 can be cancelled at any time and the memory returned to the fully configured 90 state by interrupting the command invocation with a signal. The 91 \fBunconfigure\fR operation self-cancels if no memory can be removed within a 92 timeout period. The default timeout period of \fB60\fR seconds can be changed 93 using the \fB-o\fR \fBtimeout=\fR\fI#\fR option, with a value of \fB0\fR 94 disabling the timeout. 95 .RE 96 97 .sp 98 .ne 2 99 .na 100 \fB\fB-f\fR\fR 101 .ad 102 .sp .6 103 .RS 4n 104 Force option. Use this option to override the block on configuring a memory 105 bank marked as disabled at boot in the non-volatile \fBdisabled-memory-list\fR 106 variable. See \fBPlatform Notes:Sun Enterprise 6x00/5x00/4x00/3x00 Systems\fR 107 .RE 108 109 .sp 110 .ne 2 111 .na 112 \fB\fB-l\fR\fR 113 .ad 114 .sp .6 115 .RS 4n 116 List option. This option is supported as described in \fBcfgadm\fR(1M). 117 .sp 118 The type field is always \fImemory\fR. 119 .sp 120 The \fIinfo\fR field has the following information for empty banks: 121 .sp 122 .in +2 123 .nf 124 slot# empty 125 .fi 126 .in -2 127 .sp 128 129 The slot# indicates the system slot into which the CPU/Memory board is 130 inserted. For example, if this were slot11 the attachment point for use with 131 cfgadm to manipulate the associated board would be sysctrl0:slot11. The info 132 field has the following information for connected banks: 133 .sp 134 .in +2 135 .nf 136 slot# sizeMb|sizeGb [(sizeMb|sizeGb used)] base 0x### 137 [interleaved #-way] [disabled at boot] [permanent] 138 .fi 139 .in -2 140 .sp 141 142 The size of the bank is given in Mb or Gb as appropriate. If the memory is less 143 than completely used, the used size is reported. The physical base address is 144 given in hexadecimal. If the memory bank is interleaved with some other bank, 145 the interleave factor is reported. If the memory on the board is disabled at 146 boot using the non-volatile \fBdisabled-memory-list\fR variable, this is 147 reported. If the bank has memory that cannot be removed this is reported as 148 permanent. 149 .RE 150 151 .sp 152 .ne 2 153 .na 154 \fB\fB-o\fR disable-at-boot | enable-at-boot\fR 155 .ad 156 .sp .6 157 .RS 4n 158 These options allow the state of the non-volatile disabled-memory-list variable 159 to be modified. These options can be used in conjunction with the issuing of a 160 \fB-c\fR option or with the explicit or implied listing command, -l, if no 161 command is required. Use of \fB-o\fR \fBenable-at-boot\fR with the 162 \fBconfigure\fR command to override the block on configuring memory on a board 163 in the disabled memory list. 164 .RE 165 166 .sp 167 .ne 2 168 .na 169 \fB\fB-o\fR extended | normal | quick\fR 170 .ad 171 .sp .6 172 .RS 4n 173 Use with the \fB-t\fR option to specify test level. 174 .sp 175 The \fBnormal\fR test level ensures that each memory cell stores both a \fB0\fR 176 and a \fB1\fR, and checks that all cells are separately addressable. The 177 \fBquick\fR test level only does the \fB0\fRs and \fB1\fRs test, and typically 178 misses address line problems. The \fBextended\fR test uses patterns to test for 179 adjacent cell interference problems. The default test level is \fBnormal\fR. 180 See \fB-t\fR option. 181 .RE 182 183 .sp 184 .ne 2 185 .na 186 \fB\fB-o\fR max_errors=\fI#\fR\fR 187 .ad 188 .sp .6 189 .RS 4n 190 Use with the \fB-t\fR option to specify the maximum number of allowed errors. 191 If not specified, a default of \fB32\fR is assumed. 192 .RE 193 194 .sp 195 .ne 2 196 .na 197 \fB\fB-o\fR timeout=\fI#\fR\fR 198 .ad 199 .sp .6 200 .RS 4n 201 Use with the \fBunconfigure\fR command to set the self-cancelling timeout. The 202 default value is \fB60\fR and the unit is seconds. A value of \fB0\fR means no 203 timeout. 204 .RE 205 206 .sp 207 .ne 2 208 .na 209 \fB\fB-t\fR\fR 210 .ad 211 .sp .6 212 .RS 4n 213 Test an unconfigured bank of memory. Specify the test level using the \fB-o\fR 214 \fBquick\fR | \fBnormal\fR | \fBextended\fR option. 215 .sp 216 \fBcfgadm\fR exits with a \fB0\fR (success) if the \fBtest\fR was able to run 217 on the memory bank. The result of the test is available in the condition for 218 the attachment point. 219 .RE 220 221 .sp 222 .ne 2 223 .na 224 \fB\fB-v\fR\fR 225 .ad 226 .sp .6 227 .RS 4n 228 Verbose option. Use this option in combination with the \fB-t\fR option 229 to display detailed progress and results of tests. 230 .RE 231 232 .sp 233 .ne 2 234 .na 235 \fB\fB-x\fR relocate-test\fR 236 .ad 237 .sp .6 238 .RS 4n 239 For all pages of memory in use on the specified memory bank, a relocation 240 operation as used in the unconfigure command is attempted. The success of this 241 operation does not guarantee that the bank can be unconfigured. Failure 242 indicates that it probably cannot be unconfigured. This option is for test 243 purposes only. 244 .RE 245 246 .SH OPERANDS 247 .sp 248 .LP 249 The following operand is supported: 250 .sp 251 .ne 2 252 .na 253 \fB\fIac#\fR:\fIbank#\fR\fR 254 .ad 255 .RS 13n 256 The attachment points for memory banks are published by instances of the 257 address controller (\fBac\fR) driver (\fIac#\fR). One instance of the \fBac\fR 258 driver is created for each system board, but only those instances associated 259 with \fBCPU\fR/Memory boards publish the two bank attachment points, bank0 and 260 bank1. 261 .sp 262 This form conforms to the logical \fBap_id\fR specification given in 263 \fBcfgadm\fR(1M). The corresponding physical \fBap_id\fRs are listed in the 264 \fBFILES\fR section. 265 .sp 266 The \fBac\fR driver instance numbering has no relation to the slot number for 267 the corresponding board. The full physical attachment point identifier has the 268 slot number incorporated into it as twice the slot number in hexadecimal 269 directly following the \fBfhc@\fR part. 270 .RE 271 272 .SH FILES 273 .sp 274 .ne 2 275 .na 276 \fB/devices/fhc@*,f8800000/ac@0,1000000:bank?\fR 277 .ad 278 .sp .6 279 .RS 4n 280 attachment points 281 .RE 282 283 .sp 284 .ne 2 285 .na 286 \fB/usr/platform/sun4u/lib/cfgadm/cfgadm_ac.so.1\fR 287 .ad 288 .sp .6 289 .RS 4n 290 hardware specific library file 291 .RE 292 293 .SH SEE ALSO 294 .sp 295 .LP 296 \fBcfgadm\fR(1M), \fBcfgadm_sysctrl\fR(1M), \fBconfig_admin\fR(3CFGADM), 297 \fBattributes\fR(5) 298 .sp 299 .LP 300 \fBSun Enterprise 6x00, 5x00, 4x00 and 3x00 Systems Dynamic Reconfiguration 301 User's Guide\fR 302 .sp 303 .LP 304 \fBPlatform Notes:Sun Enterprise 6x00/5x00/4x00/3x00 Systems\fR 305 .SH NOTES 306 .sp 307 .LP 308 Refer to the \fBSun Enterprise 6x00, 5x00, 4x00 and 3x00 Systems Dynamic 309 Reconfiguration User's Guide\fR for additional details regarding dynamic 310 reconfiguration of EXX00 system CPU/Memory boards.