xref: /openbsd/usr.sbin/eeprom/eeprom.8 (revision 5dea098c)
1.\"	$OpenBSD: eeprom.8,v 1.24 2022/11/09 07:20:12 miod Exp $
2.\"	$NetBSD: eeprom.8,v 1.2 1996/02/28 01:13:24 thorpej Exp $
3.\"
4.\" Copyright (c) 1996 The NetBSD Foundation, Inc.
5.\" All rights reserved.
6.\"
7.\" This code is derived from software contributed to The NetBSD Foundation
8.\" by Jason R. Thorpe.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
23.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29.\" POSSIBILITY OF SUCH DAMAGE.
30.\"
31.Dd $Mdocdate: November 9 2022 $
32.Dt EEPROM 8
33.Os
34.Sh NAME
35.Nm eeprom
36.Nd display or modify contents of the OpenPROM
37.Sh SYNOPSIS
38.Nm eeprom
39.Op Fl pv
40.Op Fl f Ar device
41.Oo
42.Ar field Ns Op = Ns Ar value
43.Ar ...
44.Oc
45.Sh DESCRIPTION
46.Nm eeprom
47provides an interface for displaying and changing the contents of the
48OpenPROM.
49Without any arguments,
50.Nm eeprom
51will list all of the known fields and their corresponding values.
52When given the name of a specific field,
53.Nm eeprom
54will display that value or set it if the field name is followed by
55.Sq =
56and a value.
57Only the superuser may modify the contents of the OpenPROM.
58.Pp
59The options are as follows:
60.Bl -tag -width Ds
61.It Fl
62Commands are taken from stdin and displayed on stdout.
63.It Fl f Ar device
64Use
65.Ar device
66instead of the default
67.Pa /dev/openprom .
68.It Fl p
69Display the tree derived from the OpenPROM and exit.
70.It Fl v
71Be verbose when setting a value.
72.El
73.Sh FIELDS AND VALUES
74Since the OpenPROM is designed such that the field names are arbitrary,
75explaining them here is dubious.
76Below are field names and values that one is likely to see.
77NOTE: this list
78may be incomplete or incorrect due to differences between revisions
79of the OpenPROM.
80.Bl -tag -width "network-boot-arguments  "
81.It Ar sunmon-compat?
82If true, the old EEPROM-style interface will be used while in the monitor,
83rather than the OpenPROM-style interface.
84.It Ar selftest-#megs
85A 32-bit integer specifying the number of megabytes of memory to
86test upon power-up.
87.It Ar oem-logo
88A 64bitx64bit bitmap in Sun Iconedit format.
89To set the bitmap, give the pathname of the file containing the image.
90NOTE: this property is not yet supported.
91.It Ar oem-logo?
92If true, enables the use of the bitmap stored in
93.Ar oem-logo
94rather than the default Sun logo.
95.It Ar oem-banner
96A string to use at power-up, rather than the default Sun banner.
97.It Ar oem-banner?
98If true, enables the use of the banner stored in
99.Ar oem-banner
100rather than the default Sun banner.
101.It Ar ttya-mode
102A string of five comma separated fields in the format
103.Dq 9600,8,n,1,- .
104The first field is the baud rate.
105The second field is the number of data bits.
106The third field is the parity; acceptable values for parity are
107.Dq n
108(none),
109.Dq e
110(even),
111.Dq o
112(odd),
113.Dq m
114(mark), and
115.Dq s
116(space).
117The fourth field is the number of stop bits.
118The fifth field is the
119.Dq handshake
120field; acceptable values are
121.Dq -
122(none),
123.Dq h
124(RTS/CTS), and
125.Dq s
126(XON/XOFF).
127.It Ar ttya-rts-dtr-off
128If true, the system will ignore RTS/DTR.
129.It Ar ttya-ignore-cd
130If true, the system will ignore carrier detect.
131.It Ar ttyb-mode
132Similar to
133.Ar ttya-mode ,
134but for ttyb.
135.It Ar ttyb-rts-dtr-off
136Similar to
137.Ar ttya-rts-dtr-off ,
138but for ttyb.
139.It Ar ttyb-ignore-cd
140Similar to
141.Ar ttya-ignore-cd ,
142but for ttyb.
143.It Ar sbus-probe-list
144Four digits in the format
145.Dq 0123
146specifying which order to probe the SBus at power-up.
147It is unlikely that this value should ever be changed.
148.It Ar screen-#columns
149An 8-bit integer specifying the number of columns on the console.
150.It Ar screen-#rows
151An 8-bit integer specifying the number of rows on the console.
152.It Ar boot-device
153Space separated list of device aliases or device paths to boot from,
154in the given order.
155.It Ar boot-file
156File to boot.
157The empty string lets the second-stage boot program
158.Sy ofwboot
159choose the default.
160.It Ar auto-boot?
161If true, the system will boot automatically at power-up.
162.It Ar watchdog-reboot?
163If true, the system will reboot upon reset.
164Otherwise, the system will fall into the monitor.
165.It Ar input-device
166One of the strings
167.Dq keyboard ,
168.Dq ttya ,
169or
170.Dq ttyb
171specifying the default console input device.
172.It Ar output-device
173One of the strings
174.Dq screen ,
175.Dq ttya ,
176or
177.Dq ttyb
178specifying the default console output device.
179.It Ar keyboard-click?
180If true, the keys click annoyingly.
181.It Ar network-boot-arguments
182Comma separated list of arguments for booting over RARP or BOOTP/DHCP and TFTP.
183.It Ar sd-targets
184A string in the format
185.Dq 31204567
186describing the translation of physical to logical target.
187.It Ar st-targets
188Similar to
189.Ar sd-targets ,
190but for tapes.
191The default translation is
192.Dq 45670123 .
193.It Ar scsi-initiator-id
194The SCSI ID of the on-board SCSI controller.
195.It Ar hardware-revision
196A 7-character string describing a date, such as
197.Dq 25May95 .
198.It Ar last-hardware-update
199Similar to
200.Ar hardware-revision ,
201describing when the CPU was last updated.
202.It Ar diag-switch?
203If true, the system will boot and run in diagnostic mode.
204.It Ar local-mac-address?
205When set to
206.Em false ,
207all Ethernet devices will use the same system default MAC address.
208When
209.Em true ,
210Ethernet devices which have a unique MAC address will use it
211rather than the system default MAC address.
212This option only really affects FCode-based Ethernet devices.
213On Sparc64, all on-board devices,
214as well as plug-in
215.Xr hme 4
216boards, will respect this setting;
217other hardware will not.
218.El
219.Sh FILES
220.Bl -tag -width "/dev/openprom" -compact
221.It /dev/openprom
222the OpenPROM device
223.El
224.Sh SEE ALSO
225.Xr openprom 4
226.Sh CAVEATS
227The fields and their values are not necessarily well defined on
228systems with an OpenPROM.
229Your mileage may vary.
230.Pp
231There are a few fields known to exist in some revisions of the
232OpenPROM that are not yet supported.
233Most notable are those
234relating to password protection of the OpenPROM.
235.Pp
236The date parser isn't very intelligent.
237