5/25/2018 Sun OpenBoot PROM Quick Reference Card

1/2

SSuunnOOppeennBBoooottPPRROOMM

QQuuiicckkRReeffeerreenncceeCCaarrdd(Last Revised 03/01/2002)

OBP Primary tasks :1) Test and initialize the system hardware2) Determine the hardware configuration3) Boot the operating system from either a mass storage device or the network

4) Provide interactiv e debugging facilities for testing hardware and software

Prompts> Restricted Monitor Prompt. Limited options.ok OpenBoot PROM command prompt. All OBP command access is

available in this mode.

DevicesDevices are represented in device tree format similar to the following:

/sbus@1f,0 /SUNW,fas@e,8800000/sd@3,0:a

driver-name Case sensitive string consisting of 1-31 letters, digiet andpunctuation characters from the set ,._+-

@ Must precede the address parameter

unit-address Text string representing the physical address of the device.: Must precede the arguments parameterdevice-arguments Text string to pass additional information to the devices

software

The devaliascommand can be used to display the default device aliases on yoursystem, the nvaliascommand will show the aliases defined in the NVRAM andthe show-devscommand will show all devices in the OpenBoot device tree.devalias Display all current device aliases.devalias alias Display the device path name corresponding to the alias.devalias alias device-path Define an alias representing the device path.

If an alias with the same name already exists, the new valuesupersedes the old. This alias is not persistent across reboots,so if you reset or reboot, this alias is lost. Use nvaliasto

preserv your alias.

nvalias alias device-path Store the command devalias alias device-path inNVRAMRC. The alias persists until the nvunalias orset-defaults commands are executed. Turns on

use-nvramrc?.nvunalias alias Delete the correspon ding alias from NVRAMRC.show-disks Command particularly useful to get a list of known disk

pathsfrom the system in a format ready to be pasted intodevalias or nvalias command string.Running show- disksproduces output similar to the following:

a) /pci@1f,4000/scsi@3/diskb) /pci@1f,4000/ebus@1/fdthree@14,3023f0c) /pci@1f,6000/scsi@3/diskq) NO SELECTIONEnter Selection, q to quit:

(Here you would enter the letter of the disk you want to use. The system willput this into a paste buffer and output the following:)

Type ^Y (Control-Y) to insert it in the command line.(Now you dont have to retype all of the device path when setting an alias. Youcan use Control-y for most of the device path.)

Example using the path defined by letter cin the previous sample:

nvalias newdisk (Control-y)@2,0Would setup an nvalias for newdisk which would use the device path

/pci@1f,6000/scsi@3/disk@2,0. The trailing @2,0 adds the unit address 2,0 so thesystem knows which unit address to boot from on that device path. The device

paths and unit address will vary, so this shortcut saves some typing, but it will notdo everything for you.

Help

Help is available from the okprompt. The format is as follows:help List main help categorieshelp category Show help for all commands in the categoryhelp command Show help for individual command (when available)

Testing and DiagnosticsSeveral diagnostic routines and tests are available in the OpenBoot PROM. The

system can be put into diagnostic mode by setting the diag-switch? configurationvariable to true, setting the machines diagnostic switch (if available) or by a systemdependant request. The level of diagnostic output is controlled by the configuration

settingdiag-level(max is the default). The defaultdiag-device is netand this willlook for a network boot server to boot from. Booting withdiag-switch?set to truewill pretty much reinstall the OS if the diag-deviceis set to netand there is a

jumpstart server available and configured for the machine. (There may be anotherpurpose, but information is hard to come by on the true benefits of this process.)

There are tests available for the system from the OpenBoot PROM, but not all testsare available from all machines, Following are some of the more common tests.probe-scsi Identify devices attached to a SCSI bus (will not work for

PCI devices use show-devs instead)probe-scsi-all Identify devices attached to all SCSI buses (will not workfor

PCI devices use show-devs instead)test device-specifier Test the device specified in device-specifiertest floppy Test the floppy drive (requires a formatted floppy be in the

drive for this to work)test net Test the primary network controllertest scsi Test the primary SCSI controllertest-all Test all devices available with the self test capabilitytest /memory Test memory (Not all OpenBoot systems have this test)watch-clock Shows ticks of the real time clock, one per secondwatch-net Monitors network broadcast packets for default interface

(. for a good packet, X for a bad packet)

watch-net-all Monitors network broadcast packets for all interfacesobdiag Invokes an optional interactive menu tool which lists all

self-test methods available on a system; provides commandsto run self tests. (More for serversand very machinespecific. Reference the specific hardware manual for yourmachine to get additional information on running obdiag.)

BootingThere are numerous methods for booting your system. The boot process relies ondevice aliases, input parameters and configuration options to determine where to

boot from and what options are to be used. Examples:

boot [device-specifier] [arguments]

boot Boots the system from the default boot device as specifiedby

the boot-device configuration setting (seen with the printenv command).

boot cdrom CDROM boot. Boots off the CDROM device as specified bythe cdrom device alias (seen with the devalias command).

boot disk Boots the system from the device as specified by thediskdevice alias (seen with the devalias command).

boot disk2 Boots the system from the device as specified by the disk2device alias if it exists.

boot device-path Boots from the device specified by its full device path.boot floppy Floppy boot. Boot off a floppy disk if applicable.

boot net Network boot. Boots from a TFTP boot server or jumpstartserver.

boot net install Jumpstart boot. Boot off the network jumpstart server and install/upgrade the operating system. (NOTE: There is a

space both before and after the - . The serves as aplaceholder argument for the command.)

boot tape Tape boot. Boots off a SCSI tape if available.boot a Ask me. Interactive mode prompts for the names of the

boot files. (Helpful if you need to boot off an alternate/etc/system file after kernel t unable modifications.)

boot D default-file Boot from default-file.boot f When booting an Autoclient system, forces boot program

to bypass clients local cache and read all files over the

network from the file server.boot h Boot halted. Boot into a halted state (ok prompt). Interesting,

for troubleshooting boot at the lowest level.boot r Reconfigure boot. Boot and search for all attached devices,

then build device entries for anything which does not alreadyexist. Useful when new devices are added to the system.

boot s Single user. Boots the system to run level 1.boot v Verbose boot. Show good debugging information.boot V Verbose boot. Show a little debugging information.boot kernel/unix 32-bit boot. Boots off the 32-bit kernel explicitly.boot kernel/sparcv9/unix 64-bit boot. Boots off the 64-bit kernel explicitly.boot disk2 kernel/sparcv9/unix asv Boot single-us er, interactive, 64-bit

off the device defined as disk2.

Displaying System InformationCommands to display additional system related information. Not all commandswork on all platforms..enet-addr Display current Ethernet address.idprom Display ID PROM contents.traps Display a list of processor-dependent trap types.version Display version and date of the boot PROM

(You can use prtconf V in a shell when booted.).speed Display processor and bus speedsbanner Display power-on banner

firmware-version Displays major/minor CPU firmware version.show-sbus Display list of installed and probed Sbus devicesshow-devs Display list of installed and probed devicesshow-pci-devs Display all PCI devices.show-disks Display a list of known disks in format for use in creating device alias.

Miscellaneous Commands and ResetsNot all commands work on all platforms.eject floppy Eject the floppy. (May also be eject-floppy)eject cdrom Eject the CDROM.sync Call the operating system to write information to

hard disk.reset Reset entire system (similar to performin g a power cycle)reset-all Reset entire system (similar to performing a power cycle)set-defaults Reset all the PROM settings to the factory defaults

Emergency Keyboard CommandsThese are key sequences recognized by the system to perform predeterminedactions at boot time or during normal operation.

Stop Bypass POST. This command does not depend onsecurity-mode.

Stop-A Abort. (This will also stop a running system. You canresume normal operations if you entergo at the prompt.Enter anything else and you will stay halted.)

Stop-D Enter diagnostic mode (set diag-switch? to true)Stop-F Enter Forth on TTYA instead of probing. Usefxedit

to continue with the initialization sequence.Stop-N Reset NVRAM contents to default values.

NVRAMRC CommandsThe NVRAMRC can be accessed with some simple editing commands. Following

are a basic set of these commands for entering and manipulating information in theNVRAMRC.nvalias alias device-path Store the command devalias alias device-path in

NVRAMRC. The alias persists until thenvunaliasorset-defaults commands are executed. Turns onuse-nvramrc?.

nvedit Enter the NVRAMRC editor. If data remains in thetemporary buffer from a previous nvedit session, resumeediting those previous contents. If not, read the contents of

NVRAMRC into the temporary buffer and begin editing it.nvquit Discard the contents of the temporary buffer without writing

it to NVRAMRC.nvrecover Recover the contents of NVRAMRC if they have been lost

as a result of the execution of set-defaults, then enter the

editor with nvedit.nvrun Execute the contents of the temporary buffer.nvstore Copy the contents of the temporary buffer to NVRAMRC

then discard the contents of the temporary buffer.nvunalias alias Delete the correspondin g alias from NVRAMRC.setenv use-nvramrc? true Enable the NVRAMRC.

NVRAMRC Editor CommandsControl-b Moves backward one character.Escape b Moves backward one word.Control-f Moves forward one character.Escape f Moves forward one word.Control-a Moves backward to beginning of line.Control-e Moves forward to the end of the line.Control-n Moves to the next line of the script edit buffer.Control-p Moves to the previous line of the script edit buffer.Return (Enter) Inserts a new line at the cursor position and advances to the

next line.Control-o Inserts a newline at the cursor position and stays on the

current line.

Control-k Erases from the cursor position to the end of the line, storing the erased characters in a save buffer. If at the end of the linejoins the next line to the current.

Delete Erases the previous character.Backspace Erases the previous character.Control-h Erases the previous character.Escape h Erases from beginning of word to just before the cursor,

storing erased characters in the save buffer.Control-w Erases from beginning of word to just before the cursor,

storing erased characters in a save buffer.

Control-d Erases the next character.Escape d Erases from the cursor to the end of the word, storing the

erased characters in a save buffer.Control-u Erases the entire line, storing the erased characters in a save

buffer.Control-y Inserts the contents of the save buffer Control-q Quotes the next character (allows you Control-r Retypes the line.Control-l Displays the entire contents of the editControl-c Exits the script editor, returning to the interpreter. The temporary buffer is pr

written back to the script. (Use nvstor

Setting Security VariablesThe NVRAM security variables control the set of operations u

perform from the OpenBoot PROM user interface and can befollowing:

setenv security-passwordpassword Sets the PROM secwhat is specified in thepas

password must be between

characters (any characters aignored) and the password timmediately no reset is reyou enter an incorrect pass

of around 10 seconds befor

again and the security-#baincremented. The passwordyou type it or with printenv

printenv security-mode Display the current mode fosetenv security-mode modeWhere modecan be none, com

none No password re

command All commands require the pass

full All commands ethe password.

?? CAUTION: You must set your security passwordsecurity mode. (The password is blank by default, someone, you wont know what it is and will not b

If you forget the security password, you may not bsystem and must call the vendor for a replacement

printenv security-#badlogins Display the number of faile attempts (since any reset of

setenv security-#badloginsnumber Reset the security-#counter. This counter keeps

of failed security password

Changing the Power-on BannerThe banner information seen from power-on can be modified

and oem-banner? configuration settings. By default the bannlike processor type and speed, PROM revision, memory, hosaddress.banner Display the power-on bannsetenv oem-banner string Set the power-on banner tosetenv oem-banner? true Activate the custom bannersetenv oem-banner? false Restore the original system

Setting and Checking NVRAM Configuration VariablesThese variables determine startup and communication characand checked with the Cshell-style setenv and printenv comma

list of commands which are available from the OpenBoot PRprompt (as opposed to the OpenBoot PROM Restricted modprintenv Display current variables and current dprintenv variable Shows the current value of the named setenv variable value Setvariableto the given decimal orset-defaultvariable Reset the value ofvariableto the factset-defaults Reset variable values to the factory defpassword Set security-passwordSome variables can be checked or set while the system is up

the eeprom command (/usr/sbin/eepromin Solaris 8). Not modified from the eepromcommand and EEPROM contentby super user.

eeprom Display current variables and values freeprom variable=valueSet variableto the given decimal o

Note: If the variable has special chara should enclose the variable in double q

(Example: eeprom auto-boot?=true You will notice more variables and information is available fthan the eeprom command displays. Also, not all device infodisplayed from the eeprom command. You may see data nosettings which can not be viewed from the booted/running stamay need to shut down to be able to change or view this info

5/25/2018 Sun OpenBoot PROM Quick Reference Card

2/2

OBP Variables(Following is a partial list of OBP configuration variables. These vary based onmachine types and PROM versions.)

Variable TypicalDefault

Description

asr-disable (no default) Auto System Recovery hard disable

subsystem component. Options areavailable from the list generated byrunning asr-disablewith no arguments.

asr-disable-list (no default) Auto System Recovery list of devicetree paths separated by spaces which

will be ignored at boot due to a failedor disabled status. (Soft deconfigure)

asr-enable (no default) Auto System Recovery hard enable

subsystem component. Options areavailable from the list generated byrunning asr-enable with no arguments.

auto-boot? true If true, boot automatically after poweron or reset.

auto-boot-on-error? true Controls whether the system will

attempt a degraded boot when asubsystem failure is detected. Both theauto-boot?and auto-boot-on-error?switches must be set to true to enable a

degraded boot.

ansi-terminal? true Configuration variable used to controlthe behavior of the terminal emulator.The valuefalsemakes the terminalemulator stop interpreting ANSI

escape sequences, inste ad justechoing them to the output device.

boot-command boot Command executed ifauto-boot?Istrue.

boot-device disk net Device from which to boot.

boot-file (emptystring)

Arguments passed to booted program.

comX-noprobe (no default) Where X is the number of the serialport, prevents device probe on serial

port X.

diag-continue? false If true, run all subtests even if an error

occurs. If false, stop diagnostics at thefirst error.

diag-device net Diagnostic boot source device.

diag-file (emptystring)

Arguments passwd to booted programin diagnostic mode.

diag-level max Level of diagnostic information.(options: off, min, med or max)

diag-passes 1 Repeats each test the number of times

specified by n. Works with the test,except, and test -all commands.

diag-switch? false If true, run in diagnostic mode.

diag-targets none none-Runs internal tests only, no I/Otesting.iopath -Extends testing to external

device interfaces (connectors/cables).media-Extends testing to externaldevices and media, if present.device-Invokes built-in self-test (BIST)

on PCI cards and external devices.loopback-Runs external loopback tests

on the parallel, serial, keyboard, mouseand TPE ports.

loopback2 -Runs an external loopback

test on MII port.loopbacks-Runs external loopback testson the parallel, serial, keyboard, mouse,

TPE, and MII ports.nomem-Performs tests without testingsystem memory.

diag-trigger power-reset power-reset-Runs diagnostics only onpower-on resets.

error-reset-Runs diagnostics only onpower-on resets, fatal hardware errors,and watchdog reset events.

soft-reset-Runs diagnostics on all resets(except XIR).

diag-verbosity 0 0-Prints one line that indicates thedevice being tested and its pass/failstatus.

1-Prints more detailed test status, whichvaries in content from test to test.2-Prints subtest names.

4-Prints debug messages.8-Prints back trace of callers on error.

disk-led-assoc 0 Disk slot association setting which canbe used to set up the properassociations between disk slot numbers

and the physical and logical devicenames used to identify the disk drivesinstalled in each slot.Ex: setenv disk-led-assoc 0 x y

where: x is an integer identifying therear panel PCI slot number where thelower UltraSCSI controller is installedandyis an integer identifying the rear

panel PCI slot number where the upper

UltraSCSI controller is installed.env-monitor enabled enabled-In response to an over

temperature condition or a fan failure ineither the CPU or disk fan tray, OBP

issues a warning and automaticallyshuts down the system after 30 seconds.advise- OBP issues a warning only,without shutting down the system.

disable- OBP takes no action at all;environmental monitoring at the OBPlevel is disabled.

error-reset-recovery boot Recovery action after an error resetCPU trap (options: none, sync, or boot)

fcode-debug? false If true, include name fields for plug-in

Fcodes.

hardware-revision (no default) Variable to store hardware revisioninfo.

input-device keyboard Console input device (usuallykeyboard, ttya , or ttyb).

keyboard-click? false If true, enable keyboard click.

keymap (no default) Keymap for custom keyboard.

last-hardware-update (no default) System update information.

load-base 16384 Default load address for clientprograms.

local-mac-address? false If true, network devices use their ownMAC addresses.

memory-interleave auto auto -Determines best memoryinterleaving based on number of slots

and memory types in those slots.max-size-max-interleave-Enables the maximumlevel of interleaving possible for a

given memory configuration, but somememory capacity remains unused ifDIMMs of different capacities are

installed.1-Disables interleaving; uses all of theavailable memory capacity.2-Forces two-way interleaving.

4-Forces four-way interleaving.

mfg-mode off Manufacturing mode argument forPOST. Possible values include off orchamber. The value is passed as anargument to POST.

mfg-switch? false If true, repeat system self-test until

interrupted with STOP -A.

nvramrc (empty) Contents of NVRAMRC.oem-banner (empty

string)

Custom OEM banner (enabled by oem-

banner? true).

oem-banner? false If true, use custom OEM banner.

oem-logo (no default) Byte array custom OEM logo (else useSun logo).

oem-logo? false If true, use custom OEM logo (enabledby oem-logo? true).

output-device screen Console output device (usuallyscreen,ttya, or ttyb).

pci0-probe-list 1,3,2,4 0-UPA-PCI bus bridge (not probed)1-EBus/Ethernet interface (always

probed, never included in probe list)2- On-board SCSI controller for

removable media devices and externalSCSI port3- On-board SCSI controller for 4-slotUltraSCSI backplane

4- Back panel PCI slot 10

pci-slot-skip-list none Used to exclude back panel slots fromthe PCI probe list. Values are slotnumbers separated by commas or none.

pcia-probe-list 1, 2, 3, 4 Controls probe order of plug-in devicesunder pcia.

pcib-probe-list 1, 2, 3 Controls probe order of plug-in devicesunder pcib.

#power-cycles (no default) Counter for number of system power

cycles performed.

redmode-reboot? true Specify true to reboot after a redmodereset trap. (Enterprise 10000 only)

redmode-sync? false Specify true to invoke OpenBootPROM's sync word after a redmodereset trap. (Enterprise 10000 only)

sbus-probe-list 0123 Which Sbus slots to probe and in what

order.screen-#columns 80 Number of on-screen columns

(characters/line).

screen-#rows 34 Number of on-screen rows (lines).

scsi-initiator-id 7 SCSI bus address of host adapter, range0-f.

sd-targets 31204567 Map SCSI disk units which means thatunit 0 maps to target 3, unit 1 maps totarget 1, and so on. (OBP 1.x only).

security-#badlogins (no default) Number of incorrect security passwordattempts.

security-mode none Firmware security level (options are

none, command, orfull)

security-password (no default) Firmware security password (neverdisplayed)

selftest-#megs 1 Megabytes of RAM to test. Ignored ifdiag-switch? is true.

sir-sync? false Specify true to invoke OpenBootPROM's sync word after a software-

initiated reset (SIR) trap. Defaults tofalse. (Sun Enterprise 10000 only.)

skip-vme-loopback? false If true, POST does not do VMEbusloopback tests.

sunmon-compat? false If true, display Restricted Monitorprompt (>).

system-board-date (no default) Variable for system board dateinformation.

system-board-serial# (no default) Variable for system board serial

number information.

testarea 0 One-byte scratch field, available forread/write test.

tpe-link-test? true Enable10baseT link test for built-intwisted pair Ethernet.

ttya-mode 9600,8,n,1,- TTYA(baud,#bits,parity,#stop,handshake).Options are:

baud 110,300,1200,2400,4800,9600,38400#bits 5,6,7,8

parity n (none), e (even), o (odd)#stop 1 (1), . (1.5), 2 (2)handshake -> - (none),h(hardware:rts/cts),

s(software:xon/xoff)

ttyb-mode 9600,8,n,1,- TTYB(baud,#bits,parity,#stop,handshake).Options are:

baud

110,300,1200,2400,4800,9600,38400#bits 5,6,7,8

parity n (none), e (even), o (odd)#stop 1 (1), . (1.5), 2 (2)

handshake -> - (none),h(hardware:rts/cts),s(software:xon/xoff)

ttya-ignore-cd true If true, OS ignores TTYA carrier-detect.

ttyb-ignore-cd true If true, OS ignoredetect.

ttya-rts-dtr-off false If true, OS does nRTS on TTYA.

ttyb-rts-dtr-off false If true, OS does n

RTS on TTYB.

upa-port-skip-list (no default) CPU=0-3=Four pUPA-PCI bridge=motherboardUPA graphics fra

1e=Two plug-in Ex: setenv upa-p

use-nvramrc? false If true, execute cNVRAMRC duri

watchdog-reboot? false If true, reboot aft

watchdog-sync? false Specify true to inPROM's sync wo

reset trap. ( Sun E

Troubleshooting

Symptom Possible Cause RecommendeHardware failure Check for pow

monitor. If yelTry a new mon

cable if possib

Keyboard notattached

If the keyboaroutput goes to down, plug in

power back on

output- device is

set to TTYA orTTYB

NVRAM para

set to ttya or ttConnect termithe system. Af

prompt on the

screen outpuframe buffer. Uthe default dis

Blank screen

System hasmultiple frame

buffers

Wrong frame bthe console de

other frame buand see if signDefined by ou

diag-switch?NVRAM param

is set to true

Interrupt the bStop-Aand rusetenv diag-s

boot.

System boots fromnet instead of disk

boot-deviceNVRAM paramset to netnot disk

Interrupt the bStop-Aand rusetenv boot-dEnsure disk al

Fails with themessage: The file

just loaded does

not appear to beexecutable

The boot blockcorrupted. Instor Older SPAR

root partition osystem with roor smaller size

System will notboot from disk

Fails with themessage: Can't

open boot device

Disk may be punavailable/fa

disk is spinninconnection, reanother diskosystems dont

over 2 gig. Repartition of 1.8

SCSI problems orerrors

Duplicate SCSItarget number

settings or devicehardware

problems

Unplug all butscsi and note number. Repeadisks looking conflicts. On Itarget number

to be one of thnumbers or rehardware prob

Helpful Web Linkshttp://docs.sun.com- Sun Microsystems Online Documentathttp://sunsolve.sun.com - Sun Microsystems Online Help Re

http://searchsolaris.com- Sun Oriented Websiteand of course theres always http://google.com- Great Web S