d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document a lot of sparc64 internals.

Browse Source 
Submitted by:	marius
Reviewed by:	ru
Approved by:	re (blanket)
X-MFC:		not before the code in RELENG_5 matches
		these man pages or vice versa
This commit is contained in:
ru 2005-06-22 15:35:14 +00:00
parent 6c5bcb1fd2
commit fb0b4e13b4
15 changed files with 1561 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
share/man/man4/man4.sparc64/Makefile
View File

@ -1,6 +1,21 @@
# $FreeBSD$
MAN= auxio.4 snd_audiocs.4
MAN= auxio.4 \
central.4 \
clkbrd.4 \
creator.4 \
ebus.4 \
eeprom.4 \
fhc.4 \
machfb.4 \
ofw_console.4 \
openfirm.4 \
openprom.4 \
rtc.4 \
sbus.4 \
snd_audiocs.4
MLINKS= openfirm.4 openfirmware.4
MANSUBDIR=/sparc64

40
share/man/man4/man4.sparc64/auxio.4
View File

@ -25,7 +25,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd October 8, 2004
.Dd June 18, 2005
.Dt AUXIO 4 sparc64
.Os
.Sh NAME
@ -33,15 +33,18 @@
.Nd "Sun Auxiliary I/O"
.Sh SYNOPSIS
.Cd "device auxio"
.Cd "device sbus"
.Cd "device ebus"
.Sh DESCRIPTION
The
.Nm
device provides auxiliary I/O functions required by Sun
.Tn UltraSPARC
workstation and server models.
The front panel LED is also controlled by the device.
driver provides support for the auxiliary I/O device found on the
.Tn EBus
and
.Tn SBus
busses of
.Tn Sun UltraSPARC
workstation and small server class systems.
This device contains miscellaneous system controls,
including the front panel LED.
This LED can be made to blink by writing
.Tn ASCII
strings to the
@ -53,20 +56,25 @@ device.
Auxiliary I/O device node
.El
.Sh SEE ALSO
.Xr led 4
.Xr ebus 4 ,
.Xr led 4 ,
.Xr sbus 4
.Sh HISTORY
The
.Nm
driver appeared in
driver first appeared in
.Nx 1.5 .
The first
.Fx
version to include it was
.Fx 5.3 .
.Sh AUTHORS
.An -nosplit
The
.Nm
driver was ported by
.An Pyun YongHyeon
.Aq yongari@FreeBSD.org
from the
.Nx
driver written by
.An Matthew R. Green .
driver was written by
.An Matthew R. Green
and ported to
.Fx
by
.An Pyun YongHyeon Aq yongari@FreeBSD.org .

60
share/man/man4/man4.sparc64/central.4 Normal file
View File

@ -0,0 +1,60 @@
.\"-
.\" Copyright (c) 2004 Jason L. Wright (jason@thought.net)
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
.\" DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.\" from: OpenBSD: central.4,v 1.3 2004/09/24 07:03:47 miod Exp
.\" $FreeBSD$
.\"
.Dd June 18, 2005
.Dt CENTRAL 4 sparc64
.Os
.Sh NAME
.Nm central
.Nd "Central host controller and bus"
.Sh SYNOPSIS
.Cd "device central"
.Sh DESCRIPTION
The
.Nm
driver provides support for the
.Tn Central
host controller and bus found in
.Tn Sun Enterprise xx00
systems.
It provides an attachment point for the main
.Xr fhc 4
.Tn FireHose
controller used to control board level functions on the host.
.Sh SEE ALSO
.Xr fhc 4
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 5.1 .
.Sh AUTHORS
The
.Nm
driver was written by
.An "Jake Burkholder" Aq jake@FreeBSD.org .

88
share/man/man4/man4.sparc64/clkbrd.4 Normal file
View File

@ -0,0 +1,88 @@
.\"-
.\" Copyright (c) 2004 Jason L. Wright (jason@thought.net)
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
.\" DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.\" from: OpenBSD: clkbrd.4,v 1.2 2005/02/21 11:29:36 jmc Exp
.\" $FreeBSD$
.\"
.Dd June 18, 2005
.Dt CLKBRD 4 sparc64
.Os
.Sh NAME
.Nm clkbrd
.Nd "clock board"
.Sh SYNOPSIS
.Cd "device clkbrd"
.Sh DESCRIPTION
The
.Nm
driver provides support for the clock board found in
.Tn Sun Enterprise xx00
systems.
The clock board has three status LEDs labeled
.Dq Li Power ,
.Dq Li Failure
and
.Dq Li Cycling .
These LEDs are also mirrored on the main front panel.
The
.Dq Li Cycling
LED can be made to blink by writing
.Tn ASCII
strings to the
.Pa /dev/led/clockboard
device.
.Pp
On attach the
.Nm
driver also prints out the number of board slots the chassis provides.
.Sh FILES
.Bl -tag -width ".Pa /dev/led/clockboard"
.It Pa /dev/led/clockboard
clock board LED device node
.El
.Sh CAVEATS
Hardware management functionality is not implemented.
.Sh SEE ALSO
.Xr fhc 4 ,
.Xr led 4
.Sh HISTORY
The
.Nm
driver first appeared in
.Ox 3.7 .
The first
.Fx
version to include it was
.Fx 6.0 .
.Sh AUTHORS
.An -nosplit
The
.Nm
driver was written by
.An "Jason L. Wright"
and ported to
.Fx
by
.An "Marius Strobl" Aq marius@FreeBSD.org .

88
share/man/man4/man4.sparc64/creator.4 Normal file
View File

@ -0,0 +1,88 @@
.\"-
.\" Copyright (c) 2002 Jason L. Wright (jason@thought.net)
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
.\" DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.\" from: OpenBSD: creator.4,v 1.20 2005/03/05 01:48:59 miod Exp
.\" $FreeBSD$
.\"
.Dd June 18, 2005
.Dt CREATOR 4 sparc64
.Os
.Sh NAME
.Nm creator
.Nd "accelerated color frame buffer"
.Sh SYNOPSIS
.Cd "device creator"
.Sh DESCRIPTION
The
.Tn Sun Creator ,
.Tn Sun Creator3D
and
.Tn Sun Elite3D
cards are color frame buffers with graphics acceleration available for
.Tn UltraSPARC
workstations with
.Tn UPA
slots.
The
.Nm
driver interfaces those frame buffers with the
.Xr syscons 4
console driver.
It also provides separate character devices
.Pa /dev/fb*
allowing to
.Xr mmap 2
these frame buffers
(used by X11).
.Sh FILES
.Bl -tag -width ".Pa /dev/fb*"
.It Pa /dev/fb*
.Nm
device nodes
.El
.Sh CAVEATS
Font loading and mode switching are not implemented.
.Sh SEE ALSO
.Xr machfb 4 ,
.Xr syscons 4
.Sh HISTORY
The
.Nm
driver first appeared in
.Ox 3.2 .
The first
.Fx
version to include it was
.Fx 5.2 .
.Sh AUTHORS
.An -nosplit
The
.Nm
driver was written by
.An "Jake Burkholder" Aq jake@FreeBSD.org
roughly based on the
.Ox
driver written by
.An "Jason L. Wright" .

121
share/man/man4/man4.sparc64/ebus.4 Normal file
View File

@ -0,0 +1,121 @@
.\"-
.\" Copyright (c) 1999 Matthew R. Green
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. The name of the author may not be used to endorse or promote products
.\" derived from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" from: OpenBSD: ebus.4,v 1.6 2004/09/23 18:28:51 jason Exp
.\" from: NetBSD: ebus.4,v 1.3 2002/03/13 21:42:20 wiz Exp
.\" $FreeBSD$
.\"
.Dd June 18, 2005
.Dt EBUS 4 sparc64
.Os
.Sh NAME
.Nm ebus
.Nd "EBus controller and bus"
.Sh SYNOPSIS
.Cd "device ebus"
.Sh DESCRIPTION
The
.Nm
driver provides support for the EBus controller and bus found in most
.Tn PCI
based
.Tn UltraSPARC
systems.
The
.Tn EBus
bus is designed to provide the ability to put
.Tn ISA
and traditional
.Tn Intel
style peripherals in a
.Tn SPARC
based system with a minimal amount of glue logic.
In
.Tn UltraSPARC
systems it is implemented with either a PCIO or a PCIO-2 chip from
.Tn Sun Microelectronics .
The PCIO chip also implements a
.Xr hme 4
compatible
.Tn PCI
network device.
The PCIO-2 chip also implements a
.Xr fwohci 4
compatible
.Tn IEEE
.Tn 1394
.Tn OHCI
interface, a
.Xr gem 4
compatible
.Tn PCI
network device and an
.Xr ohci 4
compatible
.Tn OHCI
.Tn USB
controller.
The
.Tn EBus
has four DMA channels,
similar to the DMA seen in the
.Xr esp 4
.Tn SCSI
DMA.
.Sh SEE ALSO
.Xr atkbdc 4 ,
.Xr auxio 4 ,
.Xr eeprom 4 ,
.Xr rtc 4 ,
.Xr snd_audiocs 4 ,
.Xr uart 4
.Rs
.%Q "Sun Microelectronics"
.%T "Peripheral Component Interconnect Input Output Controller"
.%V "Part No.: 802-7837-01"
.%D "March 1997"
.%O "http://www.sun.com/oem/products/manuals/802-7837.pdf"
.Re
.Sh HISTORY
The
.Nm
driver first appeared in
.Nx 1.5 .
The first
.Fx
version to include it was
.Fx 5.0 .
.Sh AUTHORS
.An -nosplit
The
.Nm
driver was written by
.An "Matthew R. Green"
and ported to
.Fx
by
.An "Thomas Moestl" Aq tmm@FreeBSD.org .

97
share/man/man4/man4.sparc64/eeprom.4 Normal file
View File

@ -0,0 +1,97 @@
.\"-
.\" Copyright (c) 2004 Jason L. Wright (jason@thought.net)
.\" Copyright (c) 2005 Marius Strobl <marius@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
.\" DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.\" from: OpenBSD: clock.4,v 1.3 2004/09/24 07:04:15 miod Exp
.\" $FreeBSD$
.\"
.Dd June 18, 2005
.Dt EEPROM 4 sparc64
.Os
.Sh NAME
.Nm eeprom
.Nd "non-volatile RAM / real time clock"
.Sh SYNOPSIS
.Cd "device genclock"
.Cd "device mk48txx"
.Cd "device eeprom"
.Sh DESCRIPTION
The
.Nm
driver is a front-end for the machine-independent
.Tn Mostek
MK48Txx driver.
The
.Tn Mostek
MK48Txx driver provides access to the real time clock part of the chips it
supports to
.Fx
by interfacing with the generic clock code.
.Pp
.Tn Mostek
MK48Txx chips are found on the
.Tn EBus ,
.Tn FireHose
and
.Tn SBus
busses of
.Tn UltraSPARC
systems.
On systems where the hostid is stored in the NVRAM part of the Mostek MK48Txx
chip the
.Nm
driver prints out the hostid on attach.
.Sh DIAGNOSTICS
The following driver specific error message may be reported:
.Bl -diag
.It "mk48txx_attach: battery low"
The device signals that its battery is low and should be replaced.
The
.Nm
driver refused to attach the device in this case as the time in the real time
clock is probably invalid.
This gives the generic clock code the chance to use another device as the
system real time clock that otherwise would not have been chosen.
.El
.Sh SEE ALSO
.Xr ebus 4 ,
.Xr fhc 4 ,
.Xr rtc 4 ,
.Xr sbus 4
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 5.0 .
.Sh AUTHORS
.An -nosplit
The
.Nm
driver was written by
.An "Thomas Moestl" Aq tmm@FreeBSD.org
based on the
.Nx
sparc64 clock code written by
.An "Paul Kranenburg" .

82
share/man/man4/man4.sparc64/fhc.4 Normal file
View File

@ -0,0 +1,82 @@
.\"-
.\" Copyright (c) 2004 Jason L. Wright (jason@thought.net)
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
.\" DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.\" from: OpenBSD: fhc.4,v 1.5 2004/09/28 21:42:59 jmc Exp
.\" $FreeBSD$
.\"
.Dd June 18, 2005
.Dt FHC 4 sparc64
.Os
.Sh NAME
.Nm fhc
.Nd "FireHose controller and bus"
.Sh SYNOPSIS
.Cd "device fhc"
.Sh DESCRIPTION
The
.Nm
driver provides support for the
.Tn FireHose
controllers and busses found in
.Tn Sun Enterprise xx00
systems.
These controllers are also used for board level functions on these systems.
Each board has three status LEDs labeled
.Dq Li Power ,
.Dq Li Failure
and
.Dq Li Cycling .
The
.Dq Li Cycling
LEDs can be made to blink by writing
.Tn ASCII
strings to the
.Pa /dev/led/board Ns Ar N
devices where
.Ar N
represents the physical slot number of the board.
.Sh FILES
.Bl -tag -width ".Pa /dev/led/board Ns Ar N"
.It Pa /dev/led/board Ns Ar N
board
.Ar N
LED device node
.El
.Sh SEE ALSO
.Xr central 4 ,
.Xr clkbrd 4 ,
.Xr eeprom 4 ,
.Xr led 4 ,
.Xr uart 4
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 5.1 .
.Sh AUTHORS
The
.Nm
driver was written by
.An "Jake Burkholder" Aq jake@FreeBSD.org .

144
share/man/man4/man4.sparc64/machfb.4 Normal file
View File

@ -0,0 +1,144 @@
.\"-
.\" Copyright (c) 2002 Jason L. Wright (jason@thought.net)
.\" Copyright (c) 2005 Marius Strobl <marius@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
.\" DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.\" from: OpenBSD: creator.4,v 1.20 2005/03/05 01:48:59 miod Exp
.\" $FreeBSD$
.\"
.Dd June 18, 2005
.Dt MACHFB 4 sparc64
.Os
.Sh NAME
.Nm machfb
.Nd "accelerated color frame buffer"
.Sh SYNOPSIS
.Cd "device machfb"
.Sh DESCRIPTION
The
.Tn ATI Mach64
family of chips are color frame buffers with graphics acceleration.
The
.Nm
driver interfaces those frame buffers with the
.Xr syscons 4
console driver.
.Pp
.Tn ATI Mach64
chips are very common as low-end graphics chips in
.Tn PCI
based
.Tn UltraSparc
systems.
They are found on-board in
.Tn Sun Blade 100 ,
.Tn Sun Blade 150 ,
.Tn Sun Ultra 5
and
.Tn Sun Ultra 10
as well as on
.Tn Sun
OEM mainboards like the
.Tn Sun AXe .
They are also used on add-on cards like the
.Tn Sun PGX8
and
.Tn Sun PGX64 .
.Sh HARDWARE
The
.Nm
driver provides support for the following chips:
.Pp
.Bl -bullet -compact
.It
.Tn ATI 3D Rage II+
.It
.Tn ATI 3D Rage IIC
.It
.Tn ATI 3D Rage I/II
.It
.Tn ATI 3D Rage LT
.It
.Tn ATI 3D Rage LT Pro
.It
.Tn ATI 3D Rage Pro
.It
.Tn ATI 3D Rage Pro Turbo
.It
.Tn ATI Mach64 CT
.It
.Tn ATI Mach64 VT
.It
.Tn ATI Mach64 VT4
.It
.Tn ATI Mach64 VTB
.It
.Tn ATI Rage L Mobility
.It
.Tn ATI Rage Mobility
.It
.Tn ATI Rage Mobility M1
.It
.Tn ATI Rage Mobility M3
.It
.Tn ATI Rage XC
.It
.Tn ATI Rage XL
.El
.Pp
The
following add-on cards are known to work with the
.Nm
driver at this time:
.Pp
.Bl -bullet -compact
.It
.Tn ATI 3D Charger PCI
.It
.Tn Sun PGX64
.El
.Sh CAVEATS
Font loading and mode switching are not implemented.
.Sh SEE ALSO
.Xr creator 4 ,
.Xr syscons 4
.Sh HISTORY
The
.Nm
driver first appeared in
.Nx 2.0 .
The first
.Fx
version to include it was
.Fx 6.0 .
.Sh AUTHORS
.An -nosplit
The
.Nm
driver was written by
.An "Marius Strobl" Aq marius@FreeBSD.org
based on the
.Nx
driver written by
.An "Bang Jun-Young" .

126
share/man/man4/man4.sparc64/ofw_console.4 Normal file
View File

@ -0,0 +1,126 @@
.\"-
.\" Copyright (c) 2001 Miodrag Vallat.
.\" Copyright (c) 2005 Marius Strobl <marius@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistribution of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" from: OpenBSD: pcons.4,v 1.4 2003/06/02 16:16:26 miod Exp
.\" $FreeBSD$
.\"
.Dd June 18, 2005
.Dt OFW_CONSOLE 4 sparc64
.Os
.Sh NAME
.Nm ofw_console
.Nd "Open Firmware console"
.Sh SYNOPSIS
.Cd "device ofw_console"
.Cd "options OFWCONS_POLL_HZ=N"
.Pp
.Cd "options KDB"
.Cd "options DDB"
.Cd "options ALT_BREAK_TO_DEBUGGER"
.Sh DESCRIPTION
The
.Nm
driver provides a simple text console,
using the Open Firmware services for input and output.
It will use the Open Firmware console devices set via the
.Va input-device
and
.Va output-device
variables.
.Pp
This driver is deprecated and only provided as a fallback console mechanism
if the real console hardware can not be driven by
.Fx .
.Pp
In case the
.Nm
console appears to work too slowly, its responsiveness probably can be improved
by including
.Cd "options OFWCONS_POLL_HZ=N" .
When ommitted,
.Dv OFWCONS_POLL_HZ
defaults to 4.
For example, on
.Tn Sun Ultra 2
a value of 20 or higher works best.
Too high values, on the other hand, can cause
.Nm
to unnecessarily consume CPU.
.Sh FILES
.Bl -tag -width ".Pa /dev/keyboard" -compact
.It Pa /dev/console
.It Pa /dev/keyboard
terminal input device in case the console input device is the keyboard
.It Pa /dev/screen
terminal output device in case the console output device is the screen
.It Pa /dev/tty[a-z]
terminal device in case both the console input and output device is tty[a-z]
.El
.Sh CAVEATS
Since the Open Firmware will handle BREAK
(or Stop-A)
sequences before
.Nm ,
the preferred way to enter
.Xr ddb 4
when using
.Nm
is to include
.Cd "options ALT_BREAK_TO_DEBUGGER"
in a ddb-enabled kernel, and enter the alternate BREAK sequence
(RETURN TILDE CTRL-b).
.Sh SEE ALSO
.Xr creator 4 ,
.Xr machfb 4 ,
.Xr syscons 4 ,
.Xr uart 4 ,
.Xr eeprom 8
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 5.0 .
.Sh AUTHORS
The
.Nm
driver was written by
.An "Benno Rice" Aq benno@FreeBSD.org .
.Sh BUGS
The
.Nm
driver
is not a real
.Xr tty 4
driver and is not MPSAFE.
The
.Nm
driver also does not attach to the hardware resources it actually talks to.
Therefore it cannot be included in the kernel together with real console
hardware drivers
like
.Xr creator 4 ,
.Xr machfb 4
and
.Xr uart 4 .

300
share/man/man4/man4.sparc64/openfirm.4 Normal file
View File

@ -0,0 +1,300 @@
.\"-
.\" Copyright (c) 1992, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
.\" This software was developed by the Computer Systems Engineering group
.\" at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
.\" contributed to Berkeley.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" from: @(#)openprom.4 8.1 (Berkeley) 6/5/93
.\" from: OpenBSD: openprom.4,v 1.9 2004/03/22 22:07:21 miod Exp
.\"
.\"-
.\" Copyright (c) 2005 Marius Strobl <marius@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd June 18, 2005
.Dt OPENFIRM 4 sparc64
.Os
.Sh NAME
.Nm openfirm
.Nd "Open Firmware interface"
.Sh SYNOPSIS
.In sys/types.h
.In sys/ioctl.h
.In dev/ofw/openfirmio.h
.Sh DESCRIPTION
The
.Pa /dev/openfirm
device is an interface to the
.Tn Open Firmware
device tree.
This interface is similar to the
.Tn SunOS /
.Tn Solaris
compatible
.Xr openprom 4
interface and highly stylized.
It uses
.Xr ioctl 2
calls for all operations.
These calls refer to the nodes in the
.Tn Open Firmware
device tree.
The nodes are represented by package handles,
which are simply integer values describing data areas.
Occasionally a package handle of 0 may be used or returned instead,
as described below.
.Pp
The calls that only take and/or return the package handle of a node
use a pointer to a
.Vt phandle_t
for this purpose.
The others use a pointer to a
.Vt "struct ofiocdesc"
descriptor,
which has the following definition:
.Bd -literal
struct ofiocdesc {
phandle_t of_nodeid;
int of_namelen;
const char *of_name;
int of_buflen;
char *of_buf;
};
.Ed
.Pp
The
.Va of_nodeid
member is the package handle of the node that is passed in or returned.
Strings are passed in via the
.Va of_name
member of
.Va of_namelen
length.
The maximum accepted length of
.Va of_name
is
.Dv OFIOCMAXNAME .
The
.Va of_buf
member is used to return strings except for the
.Dv OFIOCSET
call where it is also used to pass in a string.
In the latter case the maximum accepted length of
.Va of_buf
is
.Dv OFIOCMAXVALUE .
Generally,
.Va of_buf
works in a value-result fashion.
At entry to the
.Xr ioctl 2
call,
.Va of_buflen
is expected to reflect the buffer size.
On return,
.Va of_buflen
is updated to reflect the buffer contents.
.Pp
The following
.Xr ioctl 2
calls are supported:
.Bl -tag -width ".Dv OFIOCGETOPTNODE"
.It Dv OFIOCGETOPTNODE
Uses a
.Vt phandle_t .
Takes nothing and returns the package handle of the
.Pa /options
node.
.It Dv OFIOCGETNEXT
Uses a
.Vt phandle_t .
Takes the package handle of a node and returns the package handle of the next
node in the
.Tn Open Firmware
device tree.
The node following the last node has a package handle of 0.
The node following the node with the package handle of 0 is the first node.
.It Dv OFIOCGETCHILD
Uses a
.Vt phandle_t .
Takes the package handle of a node and returns the package handle of the first
child of that node.
This child may have siblings.
These can be determined by using
.Dv OFIOCGETNEXT .
If the node does not have a child,
a package handle of 0 is returned.
.It Dv OFIOCGET
Uses a
.Vt "struct ofiocdesc" .
Takes the package handle of a node and the name of a property.
Returns the property value and its length.
If no such property is associated with that node,
the length of the value is set to \-1.
If the named property exists but has no value,
the length of the value is set to 0.
.It Dv OFIOCGETPROPLEN
Uses a
.Vt "struct ofiocdesc" .
Takes the package handle of a node and the name of a property.
Returns the length of the property value.
This call is the same as
.Dv OFIOCGET
except that only the length of the property value is returned.
It can be used to determine whether a node has a particular property or whether
a property has a value without the need to provide memory for storing the value.
.It Dv OFIOCSET
Uses a
.Vt "struct ofiocdesc" .
Takes the package handle of a node,
the name of a property and a property value.
Returns the property value and the length that actually have been written.
The
.Tn Open Firmware
may choose to truncate the value if it is too long or write a valid value
instead if the given value is invalid for the particular property.
Therefore the returned value should be checked.
The
.Tn Open Firmware
may also completely refuse to write the given value to the property.
In this case
.Er EINVAL
is returned.
.It Dv OFIOCNEXTPROP
Uses a
.Vt "struct ofiocdesc" .
Takes the package handle of a node and the name of a property.
Returns the name and the length of the next property of the node.
If the property referenced by the given name is the last property of the node,
.Er ENOENT
is returned.
.It Dv OFIOCFINDDEVICE
Uses a
.Vt "struct ofiocdesc" .
Takes the name or alias name of a device node.
Returns package handle of the node.
If no matching node is found,
.Er ENOENT
is returned.
.El
.Sh FILES
.Bl -tag -width ".Pa /dev/openfirm"
.It Pa /dev/openfirm
Open Firmware interface node
.El
.Sh ERRORS
The following may result in rejection of an operation:
.Bl -tag -width Er
.It Bq Er EBADF
The requested operation requires permissions not specified at the call to
.Fn open .
.It Bq Er EINVAL
The given package handle is not 0 and does not correspond to any valid node,
or the given package handle is 0 where 0 is not allowed.
.It Bq Er ENAMETOOLONG
The given name or value exceeds the maximum allowed length of
.Dv OFIOCMAXNAME
and
.Dv OFIOCMAXVALUE
bytes respectively.
.It Bq Er ENOMEM
The kernel could not allocate memory to copy in data from user-space or to
retrieve data from the
.Tn Open Firmware .
.El
.Sh CAVEATS
Due to limitations within
.Tn Open Firmware
itself,
these functions run at elevated priority and may adversely affect system
performance.
.Pp
For at least the
.Pa /options
node the property value passed in to the
.Dv OFIOCSET
call has to be null-terminated and the value length passed in has to include
the terminating
.Ql \e0.
However, as with the
.Dv OFIOCGET
call,
the returned value length does not include the terminating
.Ql \e0.
.Sh SEE ALSO
.Xr ioctl 2 ,
.Xr openprom 4 ,
.Xr eeprom 8 ,
.Xr ofwdump 8
.Rs
.%Q "IEEE Standards Organization"
.%B "IEEE Std 1275-1994:"
.%B "IEEE Standard for Boot Firmware (Initialization Configuration) Firmware:"
.%B Core Requirements and Practices"
.%O ISBN 1-55937-426-8
.Re
.Sh HISTORY
The
.Nm
interface first appeared in
.Nx 1.6 .
The first
.Fx
version to include it was
.Fx 5.0 .
.Sh AUTHORS
The
.Nm
interface was ported to
.Fx
by
.An "Thomas Moestl" Aq tmm@FreeBSD.org .

240
share/man/man4/man4.sparc64/openprom.4 Normal file
View File

@ -0,0 +1,240 @@
.\"-
.\" Copyright (c) 1992, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
.\" This software was developed by the Computer Systems Engineering group
.\" at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
.\" contributed to Berkeley.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" from: @(#)openprom.4 8.1 (Berkeley) 6/5/93
.\" from: OpenBSD: openprom.4,v 1.9 2004/03/22 22:07:21 miod Exp
.\"
.\"-
.\" Copyright (c) 2005 Marius Strobl <marius@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd June 18, 2005
.Dt OPENPROM 4 sparc64
.Os
.Sh NAME
.Nm openprom
.Nd "OPENPROM interface"
.Sh SYNOPSIS
.In sys/types.h
.In sys/ioctl.h
.In dev/ofw/openpromio.h
.Sh DESCRIPTION
The
.Pa /dev/openfirm
device is a
.Tn SunOS /
.Tn Solaris
compatible interface to the
.Tn Open Firmware
device tree.
This interface is similar to the
.Xr openprom 4
interface.
It uses
.Xr ioctl 2
calls for all operations.
These calls refer to the nodes in the
.Tn Open Firmware
device tree.
However,
.Fx
only implements a subset of the
.Xr ioctl 2
calls
.Tn SunOS /
.Tn Solaris
does.
The nodes are represented by integer values,
which are simply describing data areas.
Occasionally the number 0 may be used or returned instead,
as described below.
.Pp
All calls use a pointer to a
.Vt "struct openpromio"
descriptor,
which has the following definition:
.Bd -literal
struct openpromio {
uint32_t oprom_size;
char oprom_array[];
};
.Ed
.Pp
The
.Va oprom_size
member refers to the size of
.Va oprom_array .
The
.Va oprom_array
member actually works like a union.
Depending on the
.Xr ioctl 2
call and whether the
.Vt "struct openpromio"
is used to pass in or return data,
.Va oprom_array
either contains an integer refereing to a node or a string refering to a
property name or property value.
The maximum size of
.Va oprom_array
is
.Dv OPROMMAXPARAM .
.Pp
The following
.Xr ioctl 2
calls are currently implemented:
.Bl -tag -width ".Dv OPROMGETPROP"
.It Dv OPROMNEXT
Takes the number of a node and returns the number of the next node in the
.Tn Open Firmware
device tree.
The node following the last node is number 0.
The node following number 0 is the first node.
.It Dv OPROMCHILD
Takes the number of a node and returns the number of the first child of that
node.
This child may have siblings.
These can be determined by using
.Dv OPROMNEXT .
If the node does not have a child,
0 is returned.
.It Dv OPROMGETPROP
Takes the name of a property.
Returns the property value.
The
.Dv OPROMGETPROP
call refers to the node previously returned by either the
.Dv OPROMNEXT
or the
.Dv OPROMCHILD
call,
depending on which one was invoked last.
If the property referenced by the given name is not associated with that node,
.Er EINVAL
is returned.
If the named property exists but has no value,
an empty string is returned.
.It Dv OPROMNXTPROP
Takes the name of a property.
Returns the name of the next property of the node.
As with the
.Dv OPROMGETPROP
call,
the
.Dv OPROMNXTPROP
call refers to the node previously returned by either the
.Dv OPROMNEXT
or the
.Dv OPROMCHILD
call.
If the property referenced by the given name is the last property of the node,
an empty string is returned.
.El
.Sh FILES
.Bl -tag -width ".Pa /dev/openprom"
.It Pa /dev/openprom
OPENPROM interface node
.El
.Sh ERRORS
The following may result in rejection of an operation:
.Bl -tag -width Er
.It Bq Er EBUSY
The
.Pa /dev/openprom
node is already opened.
.It Bq Er EINVAL
The given node number is not 0 and does not correspond to any valid node,
or the given node number is 0 where 0 is not allowed,
or the given size value is invalid,
or the given property name exceeds the maximum allowed length of
.Dv OPROMMAXPARAM
bytes.
.It Bq Er ENOMEM
The kernel could not allocate memory to copy in data from user-space or to
retrieve data from the
.Tn Open Firmware .
.El
.Sh CAVEATS
Due to limitations within
.Tn Open Firmware
itself,
these functions run at elevated priority and may adversely affect system
performance.
.Pp
The
.Nm
interface exists entirely for compatibility with software like X11,
and only the features that are actually needed for that are implemented.
The interface sucks too much to actually use,
new code should use the
.Xr openfirm 4
interface instead.
.Sh SEE ALSO
.Xr ioctl 2 ,
.Xr openfirm 4 ,
.Xr eeprom 8 ,
.Xr ofwdump 8
.Sh HISTORY
The first
.Fx
version to include the
.Nm
interface was
.Fx 5.0 .
.Sh AUTHORS
The
.Nm
interface was written by
.An "Jake Burkholder" Aq jake@FreeBSD.org .

88
share/man/man4/man4.sparc64/rtc.4 Normal file
View File

@ -0,0 +1,88 @@
.\"-
.\" Copyright (c) 2004 Jason L. Wright (jason@thought.net)
.\" Copyright (c) 2005 Marius Strobl <marius@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
.\" DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.\" from: OpenBSD: clock.4,v 1.3 2004/09/24 07:04:15 miod Exp
.\" $FreeBSD$
.\"
.Dd June 18, 2005
.Dt RTC 4 sparc64
.Os
.Sh NAME
.Nm rtc
.Nd "non-volatile RAM / real time clock"
.Sh SYNOPSIS
.Cd "device genclock"
.Cd "device mc146818"
.Cd "device rtc"
.Sh DESCRIPTION
The
.Nm
driver is a front-end for the machine-independent
.Tn Motorola
MC146818 and compatible clocks driver.
The
.Tn Motorola
MC146818 and compatible clocks driver provides access to the real time clock
part of the chips it supports to
.Fx
by interfacing with the generic clock code.
.Pp
.Tn Dallas /
.Tn Maxim Semiconductor
DS1287 chips
(those are compatible to the
.Tn Motorola
MC146818 clocks)
are found on the ISA bus of
.Tn UltraSPARC II
systems and the EBus bus of
.Tn UltraSPARC III
systems.
.Sh DIAGNOSTICS
The following driver specific error message may be reported:
.Bl -diag
.It "mc146818_attach_attach: battery low"
The device signals that its battery is low and should be replaced.
The
.Nm
driver refused to attach the device in this case as the time in the real time
clock is probably invalid.
This gives the generic clock code the chance to use another device as the
system real time clock that otherwise would not have been chosen.
.El
.Sh SEE ALSO
.Xr ebus 4 ,
.Xr eeprom 4
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 5.4 .
.Sh AUTHORS
The
.Nm
driver was written by
.An "Marius Strobl" Aq marius@FreeBSD.org .

84
share/man/man4/man4.sparc64/sbus.4 Normal file
View File

@ -0,0 +1,84 @@
.\"-
.\" Copyright (c) 2001 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Paul Kranenburg.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the NetBSD
.\" Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\" contributors may be used to endorse or promote products derived
.\" from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.\" from: OpenBSD: sbus.4,v 1.27 2005/03/05 01:44:48 miod Exp
.\" from: NetBSD: sbus.4,v 1.5 2002/01/21 17:54:10 wiz Exp
.\" $FreeBSD$
.\"
.Dd June 18, 2005
.Dt SBUS 4 sparc64
.Os
.Sh NAME
.Nm sbus
.Nd SBus controller and bus
.Sh SYNOPSIS
.Cd "device sbus"
.Sh DESCRIPTION
The
.Nm
driver provides support for the SBus controllers and busses found in older
.Tn UltraSPARC
workstations and small to medium server class systems.
The SBus is an I/O interconnect bus supporting both on-board peripherals and
extension boards.
The SBus specifications define the bus protocol as well as the electrical and
mechanical properties of the extension slots.
.Sh SEE ALSO
.Xr auxio 4 ,
.Xr eeprom 4 ,
.Xr esp 4 ,
.Xr hme 4 ,
.Xr isp 4 ,
.Xr snd_audiocs 4 ,
.Xr uart 4
.Sh HISTORY
The
.Nm
driver first appeared in
.Nx 1.3 .
The first
.Fx
version to include it was
.Fx 5.0 .
.Sh AUTHORS
.An -nosplit
The
.Nm
driver was written by
.An "Paul Kranenburg"
and ported to
.Fx
by
.An "Thomas Moestl" Aq tmm@FreeBSD.org .

4
share/man/man4/man4.sparc64/snd_audiocs.4
View File

@ -25,7 +25,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd December 14, 2004
.Dd June 18, 2005
.Dt SND_AUDIOCS 4 sparc64
.Os
.Sh NAME
@ -56,6 +56,8 @@ CS4231 on SBus based UltraSPARC
CS4231 on PCI/EBus based UltraSPARC
.El
.Sh SEE ALSO
.Xr ebus 4 ,
.Xr sbus 4 ,
.Xr sound 4
.Sh HISTORY
The