1 .\" Copyright (c) 1996 The NetBSD Foundation, Inc.
2 .\" Copyright (c) 2004 Marius Strobl
3 .\" All rights reserved.
5 .\" This code is derived from software contributed to The NetBSD Foundation
6 .\" by Jason R. Thorpe.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in the
15 .\" documentation and/or other materials provided with the distribution.
17 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
18 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
21 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 .\" POSSIBILITY OF SUCH DAMAGE.
29 .\" from: NetBSD: eeprom.8,v 1.11 2003/03/31 01:31:39 perry Exp
37 .Nd "display or modify contents of the EEPROM or NVRAM"
43 .Ar name Ns Op = Ns Ar value
48 utility provides an interface for displaying and changing the system's
49 configuration variables contained in EEPROM or NVRAM.
50 In the first synopsis form, all available configuration variables and their
51 current values are printed.
52 In the second form, only the variable selected by
54 and its value is printed or changed if
61 The following options are available:
62 .Bl -tag -width indent
64 Commands for displaying or changing variables are taken from stdin, allowing
72 The output is printed on stdout.
74 Print all available configuration variables and their current values.
76 .Sh VARIABLES AND VALUES
77 Below are variables and values that one is likely to find on a system equipped
78 with OpenBoot 3.x and Open Firmware respectively.
80 Note: the attempt to set a variable to an illegal value results in the
81 Open Firmware setting it to some legal value instead.
84 utility will detect this, try to recover the previous value of the variable
85 and issue a warning telling that the requested value could not be set.
86 .Bl -tag -width ".Va last-hardware-update"
90 the system will try to boot automatically from the devices listed in
94 respectively, using the command specified in
99 .It Va auto-boot-retry?
106 the system will try to boot from the specified boot devices forever.
109 .It Va ansi-terminal?
113 escape sequences are not interpreted by the terminal emulator.
117 Command executed when
124 Default device to boot from if
128 Takes one or more device aliases or device paths.
129 The boot devices are sequentially tried to boot from, beginning with the first
133 .It Va cpci-probe-list
136 specifying in which order to probe the devices on the CompactPCI bus at
138 Default: system-dependent.
140 Default arguments for boot when
144 When empty, the secondary boot loader will choose the file to boot.
145 Default: empty string.
162 Default: empty string.
164 Level of diagnostics to run when
174 (depending on the system model).
177 the Power-On Self Test (POST) is not run.
178 The other values are interpreted by the POST.
187 the system will boot and run in diagnostic mode.
194 Enables or disables the Advanced System Monitoring (ASM).
202 Used for debugging FCode programs.
205 names of additional FCodes are registered in the Forth dictionary.
208 .It Va hardware-revision
209 A string describing the system hardware version.
210 Default: system-dependent.
217 specifying the default console input device.
223 .It Va keyboard-click?
226 the keys click annoyingly.
230 Keymap for a custom keyboard.
231 Default: empty string.
232 .It Va last-hardware-update
234 .Va hardware-revision ,
235 describing when the hardware was last updated.
236 Default: system-dependent.
237 .It Va last-poweroff-cause
238 Cause of the last power-off.
239 Used internally by the OpenBoot PROM.
243 Default address where client programs are loaded to.
244 It is unlikely that this value should ever be changed.
247 .It Va local-mac-address?
250 all Ethernet devices with FCode will use the system default MAC address.
253 Ethernet devices with FCode that contains a unique MAC address will use it
254 rather than the system's default MAC address.
258 Ethernet devices with FCode include those supported by
263 Please see the respective manual page for further information.
265 Manufacture test mode interpreted by the POST.
275 manufacturing tests are repeated until stopped by pressing STOP-A.
281 the system will try to boot forever when the boot device used is a network
283 Any non-zero value is interpreted as minutes to try a network boot.
287 Contents of the NVRAMRC.
288 Default: empty string.
294 it is preferred to use
296 in the boot monitor instead.
298 A string displayed at power-up, rather than the default banner.
303 Default: system-dependent.
309 is displayed at power-up rather than the default banner.
310 Default: system-dependent.
312 A logo displayed at power-up when
316 rather than the default logo.
317 The logo has to be 512 bytes in size, containing a 64x64-bit monochrome image
318 in Sun Raster format without the leading 32-byte header.
319 Default: system-dependent.
323 give the pathname of the file containing the image as the
327 will remove the image.
333 is displayed at power-up rather than the default logo.
340 specifying the default console output device.
346 .It Va pcia-probe-list
349 specifying in which order to probe the devices on the PCI bus A.
350 Default: system-dependent.
351 .It Va pcib-probe-list
353 .Va pcia-probe-list ,
355 Default: system-dependent.
357 Number of power-cycles.
358 Automatically incremented on each power-cycle.
359 Default: system-dependent.
360 .It Va sbus-probe-list
363 specifying in which order to probe the SBus slots at power-up.
364 Default: system-dependent.
365 .It Va screen-#columns
366 An integer specifying the screen width in characters per line.
370 An integer specifying the screen height in lines.
373 .It Va scsi-initiator-id
374 The SCSI ID of SCSI controllers in the range of [0-7] or [0-f] (depending
376 A SCSI controller may or may not adhere to this setting, depending on its
377 FCode and device driver.
380 .It Va security-#badlogins
381 Number of incorrect password attempts when
390 Boot monitor security level.
391 One of the three possible values
398 all boot monitor commands except for
400 require the password.
403 all boot monitor commands except for
407 require the password.
410 no password is required.
422 you will be prompted for the password.
428 will clear the password.
429 .It Va security-password
430 The password used when
436 The maximum length for this password is 8 characters.
437 All characters exceeding this length will be ignored.
438 The value displayed for
439 .Va security-password
440 is always an empty string, even when a password is set.
441 Default: empty string.
450 can be used to enter a new password using any
453 .Va security-password
455 You will be prompted by
457 to type in the new password in this case.
459 .Va security-password
467 .It Va selftest-#megs
468 An integer specifying the number of megabytes of memory to test upon
475 .It Va shutdown-temperature
476 Temperature at which the ASM issues an over-temperature shutdown.
477 Default: system-dependent.
481 memory test messages will not be displayed at power-up.
484 .It Va sunmon-compat?
487 the old bootROM interface will be used while in the boot monitor,
488 rather than the OpenBoot PROM interface.
491 .It Va system-board-date
492 Manufacturing date of the system board.
493 Default: system-dependent.
494 .It Va system-board-serial#
495 Serial number of the system board.
496 Default: system-dependent.
497 .It Va tpe-link-test?
498 Enable link test on 10baseT and 100baseTX Ethernet devices.
502 A string of five comma separated fields in the format
503 .Dq Li 9600,8,n,1,- .
504 The first field is the baud rate.
505 The second field is the number of data bits.
506 The third field is the parity; acceptable values for parity are
517 The fourth field is the number of stop bits.
518 The fifth field is the
520 field; acceptable values are
528 .Dq Li 9600,8,n,1,- .
529 .It Va ttya-ignore-cd
532 the system will ignore carrier detect.
535 .It Va ttya-rts-dtr-off
538 the system will ignore RTS/DTR.
546 .Dq Li 9600,8,n,1,- .
547 .It Va ttyb-ignore-cd
553 .It Va ttyb-rts-dtr-off
555 .Va ttya-rts-dtr-off ,
559 .It Va use-boot-table?
560 Use boot table defined by the OEM.
561 Default: system-dependent.
567 will be executed during start-up.
570 .It Va warning-temperature
571 Temperature at which the ASM issues an over-temperature warning.
572 Default: system-dependent.
573 .It Va watchdog-enable?
574 Enables or disables the system watchdog timer.
577 .It Va watchdog-reboot?
580 the system will reboot upon terminal count of the system watchdog timer.
583 the system will fall into the boot monitor.
586 .It Va watchdog-timeout
587 Expiry limit for the system watchdog timer.
588 Range and unit depend on the system model.
589 Default: system-dependent.
592 Print all available configuration variables and their current values:
596 Print the current value of the
597 .Va local-mac-address?
600 .Dl "eeprom local-mac-address\e?"
603 .Va local-mac-address?
607 .Dl "eeprom local-mac-address\e?=true"
611 in the above examples is used to keep the shell from interpreting the
614 Write an image to the
618 .Dl "eeprom oem-logo=/path/to/image.raw"
620 Remove the image from the
624 .Dl "eeprom oem-logo="
630 and set the password:
631 .Bd -literal -offset indent
632 eeprom security-mode=full
637 Remember that the maximum length for the password is 8 characters.
638 All characters exceeding this length will be ignored.
640 Set a new password when the
646 .Bd -literal -offset indent
647 eeprom security-password=
659 utility first appeared in
661 It was adopted from there by
665 utility was removed from
669 because the utility was unused at that time.
670 The present implementation of the
672 utility first appeared in
674 It is inspired by the
684 utility uses base code from the
687 .An "Jason R. Thorpe" .
688 The handlers for the Open Firmware
691 .An "Marius Strobl" Aq marius@FreeBSD.org .
692 The code for accessing the Open Firmware device tree is shared with the
695 .An "Thomas Moestl" Aq tmm@FreeBSD.org .
699 only supports systems equipped with Open Firmware and is only tested on Sun
700 Microsystems sun4u machines.