1eeprom(1M) System Administration Commands eeprom(1M)
2
6 eeprom - EEPROM display and load utility
7
9 /usr/sbin/eeprom [-] [-f device] [parameter[=value]]
10
13 eeprom displays or changes the values of parameters in the EEPROM. It
14 processes parameters in the order given. When processing a parameter
15 accompanied by a value, eeprom makes the indicated alteration to the
16 EEPROM; otherwise, it displays the parameter's value. When given no
17 parameter specifiers, eeprom displays the values of all EEPROM parame‐
18 ters. A `−' (hyphen) flag specifies that parameters and values are to
19 be read from the standard input (one parameter or parameter=value per
20 line).
21 Only the super-user may alter the EEPROM contents.
24 eeprom verifies the EEPROM checksums and complains if they are incor‐
27 rect.
28 platform-name is the name of the platform implementation and can be
31 found using the -i option of uname(1).
32 SPARC
34 SPARC based systems implement firmware password protection with eeprom,
35 using the security-mode, security-password and security-#badlogins
36 properties.
37 x86
39 EEPROM storage is simulated using a file residing in the platform-spe‐
40 cific boot area. The /boot/solaris/bootenv.rc file simulates EEPROM
41 storage.
42 Because x86 based systems typically implement password protection in
45 the system BIOS, there is no support for password protection in the
46 eeprom program. While it is possible to set the security-mode, secu‐
47 rity-password and security-#badlogins properties on x86 based systems,
48 these properties have no special meaning or behavior on x86 based sys‐
49 tems.
50
52 -f device
53 Use device as the EEPROM device.
55
58 x86 Only
59 acpi-user-options
60 A configuration variable that controls the use of Advanced Configu‐
62 ration and Power Interface (ACPI), a power management specifica‐
63 tion. The acceptable values for this variable depend on the release
64 of the Solaris operating system you are using.
65 For all releases of Solaris 10 and Solaris 11, a value of of 0x0
67 means that there will be an attempt to use ACPI if it is available
68 on the system. A value of 0x2 disables the use of ACPI.
69 For the Solaris 10 1/06 release, a value of 0x8 means that there
71 will be an attempt to use ACPI in a mode compatible with previous
72 releases of Solaris 10 if it is available on the system. The
73 default for Solaris 10 1/06 is 0x8.
74 For releases of Solaris 10 after the 1/06 release and for Solaris
76 11, the default is 0x0.
77 Most users can safely accept the default value, which enables ACPI
79 if available. If issues related to the use of ACPI are suspected on
80 releases of Solaris after Solaris 1/06, it is suggested to first
81 try a value of 0x8 and then, if you do not obtain satisfactory
82 results, 0x02.
83 console
86 Specifies the console device. Possible values are ttya, ttyb, and
88 text. In text mode, console output goes to the frame buffer and
89 input comes from the keyboard. When this property is not present,
90 the console device falls back to the device specified by input-
91 device and output-device. When neither the console property or the
92 input-device and output-device property pair are present, the con‐
93 sole defaults to the frame buffer and keyboard.
94
97 Not all OpenBoot systems support all parameters. Defaults vary depend‐
98 ing on the system and the PROM revision. See the output in the "Default
99 Value" column of the printenv command, as entered at the ok (OpenBoot)
100 prompt, to determine the default for your system.
101 auto-boot?
103 If true, boots automatically after power-on or reset. Defaults to
105 true. On x86, this parameter is controlled by the grub menu file.
106 See installgrub(1M).
107 ansi-terminal?
110 Configuration variable used to control the behavior of the terminal
112 emulator. The value false makes the terminal emulator stop inter‐
113 preting ANSI escape sequences; instead, echoes them to the output
114 device. Defaults to true.
115 boot-args
118 Holds a string of arguments that are passed to the boot subsystem.
120 For example, you can use boot-args=' - install dhcp' to request a
121 customer jumpstart installation. See boot(1M), kadb(1M) and ker‐
122 nel(1M).
123 boot-command
126 Command executed if auto-boot? is true. Defaults to boot.
128 boot-device
131 Device from which to boot. boot-device may contain 0 or more device
133 specifiers separated by spaces. Each device specifier may be either
134 a prom device alias or a prom device path. The boot prom will
135 attempt to open each successive device specifier in the list begin‐
136 ning with the first device specifier. The first device specifier
137 that opens successfully will be used as the device to boot from.
138 Defaults to disk net.
139 boot-file
142 File to boot (an empty string lets the secondary booter choose
144 default). Defaults to empty string.
145 boot-from
148 Boot device and file (OpenBoot PROM version 1.x only). Defaults to
150 vmunix.
151 boot-from-diag
154 Diagnostic boot device and file (OpenBoot PROM version 1.x only).
156 Defaults to le()unix.
157 boot-ncpus
160 Configuration variable that controls the number of processors with
162 which the system should boot. By default, the system boots with
163 maximum supported number of processors.
164 comX-noprobe
167 Where X is the number of the serial port, prevents device probe on
169 serial port X.
170 diag-device
173 Diagnostic boot source device. Defaults to net.
175 diag-file
178 File from which to boot in diagnostic mode. Defaults to empty
180 string.
181 diag-level
184 Diagnostics level. Values include off, min, max and menus. There
186 may be additional platform-specific values. When set to off, POST
187 is not called. If POST is called, the value is made available as an
188 argument to, and is interpreted by POST. Defaults to platform-
189 dependent.
190 diag-switch?
193 If true, run in diagnostic mode. Defaults to false on most desktop
195 systems, true on most servers.
196 error-reset-recovery
199 Recover after an error reset trap. Defaults to platform-specific
201 setting.
202 On platforms supporting this variable, it replaces the watchdog-
204 reboot?, watchdog-sync?, redmode-reboot?, redmode-sync?, sir-sync?,
205 and xir-sync? parameters.
206 The options are:
208 none
210 Print a message describing the reset trap and go to OpenBoot
212 PROM's user interface, aka OK prompt.
213 sync
216 Invoke OpenBoot PROM's sync word after the reset trap. Some
218 platforms may treat this as none after an externally initiated
219 reset (XIR) trap.
220 boot
223 Reboot after the reset trap. Some platforms may treat this as
225 none after an XIR trap.
226 fcode-debug?
230 If true, include name parameter for plug-in device FCodes. Defaults
232 to false.
233 hardware-revision
236 System version information.
238 input-device
241 Input device used at power-on (usually keyboard, ttya, or ttyb).
243 Defaults to keyboard.
244 keyboard-click?
247 If true, enable keyboard click. Defaults to false.
249 keyboard-layout
252 A string that specifies the layout name for non-self-identifying
254 keyboards (type 7c). Invoke kbd -s to obtain a list of acceptable
255 layout names. See kbd(1).
256 keymap
259 Keymap for custom keyboard.
261 last-hardware-update
264 System update information.
266 load-base
269 Default load address for client programs. Default value is 16384.
271 local-mac-address?
274 If true, network drivers use their own MAC address, not the sys‐
276 tem's. Defaults to false.
277 mfg-mode
280 Manufacturing mode argument for POST. Possible values include off
282 or chamber. The value is passed as an argument to POST. Defaults to
283 off.
284 mfg-switch?
287 If true, repeat system self-tests until interrupted with STOP-A.
289 Defaults to false.
290 nvramrc
293 Contents of NVRAMRC. Defaults to empty.
295 network-boot-arguments
298 Arguments to be used by the PROM for network booting. Defaults to
300 an empty string. network-boot-arguments can be used to specify the
301 boot protocol (RARP/DHCP) to be used and a range of system knowl‐
302 edge to be used in the process.
303 The syntax for arguments supported for network booting is:
305 [protocol,] [key=value,]*
307 All arguments are optional and can appear in any order. Commas are
310 required unless the argument is at the end of the list. If speci‐
311 fied, an argument takes precedence over any default values, or, if
312 booting using DHCP, over configuration information provided by a
313 DHCP server for those parameters.
314 protocol, above, specifies the address discovery protocol to be
316 used.
317 Configuration parameters, listed below, are specified as key=value
319 attribute pairs.
320 tftp-server
322 IP address of the TFTP server
324 file
327 file to download using TFTP or URL for WAN boot
329 host-ip
332 IP address of the client (in dotted-decimal notation)
334 router-ip
337 IP address of the default router (in dotted-decimal notation)
339 subnet-mask
342 subnet mask (in dotted-decimal notation)
344 client-id
347 DHCP client identifier
349 hostname
352 hostname to use in DHCP transactions
354 http-proxy
357 HTTP proxy server specification (IPADDR[:PORT])
359 tftp-retries
362 maximum number of TFTP retries
364 dhcp-retries
367 maximum number of DHCP retries
369 If no parameters are specified (that is, network-boot-arguments is
371 an empty string), the PROM will use the platform-specific default
372 address discovery protocol.
373 Absence of the protocol parameter when other configuration parame‐
375 ters are specified implies manual configuration.
376 Manual configuration requires that the client be provided with all
378 the information necessary for boot. If using manual configuration,
379 information required by the PROM to load the second-stage boot pro‐
380 gram must be provided in network-boot-arguments while information
381 required for the second-stage boot program can be specified either
382 as arguments to the boot program or by means of the boot program's
383 interactive command interpreter.
384 Information required by the PROM when using manual configuration
386 includes the booting client's IP address, name of the boot file,
387 and the address of the server providing the boot file image.
388 Depending on network configuration, it might be required that the
389 subnet mask and address of the default router to use also be speci‐
390 fied.
391 oem-banner
394 Custom OEM banner (enabled by setting oem-banner? to true).
396 Defaults to empty string.
397 oem-banner?
400 If true, use custom OEM banner. Defaults to false.
402 oem-logo
405 Byte array custom OEM logo (enabled by setting oem-logo? to true).
407 Displayed in hexadecimal.
408 oem-logo?
411 If true, use custom OEM logo (else, use Sun logo). Defaults to
413 false.
414 pci-mem64?
417 If true, the OpenBoot PROM allocates 64-bit PCI memory addresses to
419 a PCI device that can support 64-bit addresses.
420 This variable is available on SPARC platforms only and is optional.
422 Some versions of SunOS do not support PCI MEM64 addresses and will
423 fail in unexpected ways if the OpenBoot PROM allocates PCI MEM64
424 addresses.
425 The default value is system-dependent. If the variable exists, the
427 default value is appropriate to the lowest version of the SunOS
428 that shipped with a specific platform.
429 output-device
432 Output device used at power-on (usually screen, ttya, or ttyb).
434 Defaults to screen.
435 redmode-reboot?
438 Specify true to reboot after a redmode reset trap. Defaults to
440 true. (Sun Enterprise 10000 only.)
441 redmode-sync?
444 Specify true to invoke OpenBoot PROM's sync word after a redmode
446 reset trap. Defaults to false. (Sun Enterprise 10000 only.)
447 rootpath
450 Specifies the root device of the operating system.
452 sbus-probe-list
455 Designate which SBus slots are probed and in what order. Defaults
457 to 0123.
458 screen-#columns
461 Number of on-screen columns (characters/line). Defaults to 80.
463 screen-#rows
466 Number of on-screen rows (lines). Defaults to 34.
468 scsi-initiator-id
471 SCSI bus address of host adapter, range 0-7. Defaults to 7.
473 sd-targets
476 Map SCSI disk units (OpenBoot PROM version 1.x only). Defaults to
478 31204567, which means that unit 0 maps to target 3, unit 1 maps to
479 target 1, and so on.
480 security-#badlogins
483 Number of incorrect security password attempts.This property has no
485 special meaning or behavior on x86 based systems.
486 security-mode
489 Firmware security level (options: none, command, or full). If set
491 to command or full, system will prompt for PROM security password.
492 Defaults to none.This property has no special meaning or behavior
493 on x86 based systems.
494 security-password
497 Firmware security password (never displayed). Can be set only when
499 security-mode is set to command or full.This property has no spe‐
500 cial meaning or behavior on x86 based systems.
501 example# eeprom security-password=
503 Changing PROM password:
504 New password:
505 Retype new password:
506 selftest-#megs
511 Megabytes of RAM to test. Ignored if diag-switch? is true. Defaults
513 to 1.
514 sir-sync?
517 Specify true to invoke OpenBoot PROM's sync word after a software-
519 initiated reset (SIR) trap. Defaults to false. (Sun Enterprise
520 10000 only.)
521 skip-vme-loopback?
524 If true, POST does not do VMEbus loopback tests. Defaults to false.
526 st-targets
529 Map SCSI tape units (OpenBoot PROM version 1.x only). Defaults to
531 45670123, which means that unit 0 maps to target 4, unit 1 maps to
532 target 5, and so on.
533 sunmon-compat?
536 If true, display Restricted Monitor prompt (>). Defaults to false.
538 testarea
541 One-byte scratch field, available for read/write test. Defaults to
543 0.
544 tpe-link-test?
547 Enable 10baseT link test for built-in twisted pair Ethernet.
549 Defaults to true.
550 ttya-mode
553 TTYA (baud rate, #bits, parity, #stop, handshake). Defaults to
555 9600,8,n,1,−.
556 Fields, in left-to-right order, are:
558 Baud rate:
560 110, 300, 1200, 4800, 9600...
562 Data bits:
565 5, 6, 7, 8
567 Parity:
570 n(none), e(even), o(odd), m(mark), s(space)
572 Stop bits:
575 1, 1.5, 2
577 Handshake:
580 −(none), h(hardware:rts/cts), s(software:xon/xoff)
582 ttyb-mode
586 TTYB (baud rate, #bits, parity, #stop, handshake). Defaults to
588 9600,8,n,1,−.
589 Fields, in left-to-right order, are:
591 Baud rate:
593 110, 300, 1200, 4800, 9600...
595 Data bits:
598 5, 6, 7, 8
600 Stop bits:
603 1, 1.5, 2
605 Parity:
608 n(none), e(even), o(odd), m(mark), s(space)
610 Handshake:
613 −(none), h(hardware:rts/cts), s(software:xon/xoff)
615 ttya-ignore-cd
619 If true, operating system ignores carrier-detect on TTYA. Defaults
621 to true.
622 ttyb-ignore-cd
625 If true, operating system ignores carrier-detect on TTYB. Defaults
627 to true.
628 ttya-rts-dtr-off
631 If true, operating system does not assert DTR and RTS on TTYA.
633 Defaults to false.
634 ttyb-rts-dtr-off
637 If true, operating system does not assert DTR and RTS on TTYB.
639 Defaults to false.
640 use-nvramrc?
643 If true, execute commands in NVRAMRC during system start-up.
645 Defaults to false.
646 verbosity
649 Controls the level of verbosity of PROM messages. Can be one of
651 debug, max, normal, min, or none. Defaults to normal.
652 version2?
655 If true, hybrid (1.x/2.x) PROM comes up in version 2.x. Defaults to
657 true.
658 watchdog-reboot?
661 If true, reboot after watchdog reset. Defaults to false.
663 watchdog-sync?
666 Specify true to invoke OpenBoot PROM's sync word after a watchdog
668 reset trap. Defaults to false. ( Sun Enterprise 10000 only.)
669 xir-sync?
672 Specify true to invoke OpenBoot PROM's sync word after an XIR trap.
674 Defaults to false. (Sun Enterprise 10000 only.)
675
678 Example 1 Changing the Number of Megabytes of RAM.
679 The following example demonstrates the method for changing from one to
682 two the number of megabytes of RAM that the system will test.
683 example# eeprom selftest-#megs
686 selftest-#megs=1
687 example# eeprom selftest-#megs=2
689 example# eeprom selftest-#megs
691 selftest-#megs=2
692 Example 2 Setting the auto-boot? Parameter to true.
696 The following example demonstrates the method for setting the auto-
699 boot? parameter to true.
700 example# eeprom auto-boot?=true
703 When the eeprom command is executed in user mode, the parameters with a
708 trailing question mark (?) need to be enclosed in double quotation
709 marks (" ") to prevent the shell from interpreting the question mark.
710 Preceding the question mark with an escape character (\) will also pre‐
711 vent the shell from interpreting the question mark.
712 example% eeprom "auto-boot?"=true
715 Example 3 Using network-boot-arguments
719 To use DHCP as the boot protocol and a hostname of abcd.example.com for
722 network booting, set these values in network-boot-arguments as:
723 example# eeprom network-boot-arguments="dhcp,hostname=abcd.example.com"
726 ...then boot using the command:
731 ok boot net
734 Note that network boot arguments specified from the PROM command line
739 cause the contents of network-boot-arguments to be ignored. For exam‐
740 ple, with network-boot-arguments set as shown above, the boot command:
741 ok boot net:dhcp
744 ...causes DHCP to be used, but the hostname specified in network-boot-
749 arguments will not be used during network boot.
750 Example 4 Setting System Console to Auxiliary Device
753 The command below assigns the device /dev/term/a as the system console
756 device. You would make such an assignment prior to using tip(1) to
757 establish a tip connection to a host.
758 On a SPARC machine:
762 # eeprom output-device=/dev/term/a
765 On an x86 machine:
770 # eeprom console=ttya
773 On a SPARC machine, the preceding command would be sufficient for
778 assigning the console to an auxiliary device. For an x86 machine, you
779 might, in addition, need to set the characteristics of the serial line,
780 for which you would have to consult the BIOS documentation for that
781 machine. Also, on some x86 machines, you might use a device other than
782 device a, as shown above. For example, you could set console to ttyb if
783 the second serial port is present.
784
787 /boot/solaris/bootenv.rc
788 File storing eeprom values on x86 machines.
790 /dev/openprom
793 Device file
795 /usr/platform/platform-name/sbin/eeprom
798 Platform-specific version of eeprom. Use uname -i to obtain plat‐
800 form-name.
801
804 See attributes(5) for descriptions of the following attributes:
805 ┌─────────────────────────────┬─────────────────────────────┐
810 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
811 ├─────────────────────────────┼─────────────────────────────┤
812 │Availability │SUNWcsu │
813 └─────────────────────────────┴─────────────────────────────┘
814
816 passwd(1), sh(1), svcs(1), tip(1), uname(1), boot(1M), kadb(1M), ker‐
817 nel(1M), init(1M), svcadm(1M), attributes(5), smf(5)
818 OpenBoot 3.x Command Reference Manual
821SunOS 5.11 28 Mar 2007 eeprom(1M)