Aren/NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added section 4 manual pages for the mac68k:

Browse Source 
o main processor bus
  o onboard I/O bus
  o ADB event device
  o autoconfiguration process
This commit is contained in:
ender 1997-07-18 02:13:39 +00:00
parent 84d2fe3f1c
commit 48fe6d80a1
5 changed files with 510 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
share/man/man4/man4.mac68k/Makefile
View File

@ -1,7 +1,7 @@
# from: @(#)Makefile 5.1 (Berkeley) 6/29/90
# $NetBSD: Makefile,v 1.3 1997/06/11 04:19:30 jeremy Exp $
# $NetBSD: Makefile,v 1.4 1997/07/18 02:13:39 ender Exp $
MAN= ae.4 intro.4 mem.4 sn.4
MAN= adb.4 ae.4 autoconf.4 intro.4 mainbus.4 mem.4 obio.4 sn.4
MLINKS= mem.4 kmem.4
MANSUBDIR=/mac68k

278
share/man/man4/man4.mac68k/adb.4 Normal file
View File

@ -0,0 +1,278 @@
.\"
.\" Copyright (c) 1997 Colin Wood
.\" 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. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by Colin Wood
.\" for the NetBSD Project.
.\" 4. 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.
.\"
.\" $NetBSD: adb.4,v 1.1 1997/07/18 02:13:42 ender Exp $
.\"
.Dd July 17, 1997
.Os NetBSD
.Dt ADB 4 mac68k
.Sh NAME
.Nm adb
.Nd Apple Desktop Bus event interface
.Sh SYNOPSIS
.Cd "adb0 at obio?"
.Cd "options MRG_ADB"
.Cd "#include <machine/adbsys.h>"
.Sh DESCRIPTION
The Apple Desktop Bus
.Pq Tn ADB
is the single-master, multiple-slave, low-speed serial bus
interface used by Macintosh computers to connect input devices
such as keyboards, mice, trackballs, and graphics tablets
to the machine.
.Pp
The
.Nm
device is the sole interface to user input.
It combines both keyboard and mouse drivers into one event driver.
All user input is obtained by doing a
.Xr read 2
on the
.Nm
device.
Since most Macintosh mice have only one button, the
.Nm
driver will emulate a second and third mouse button with
the keyboard.
The
.Nm
device only supports being opened by one process at a time.
.Pp
There are two interfaces to the
.Tn ADB
hardware supported by the
.Nm
driver.
The older of the two relies on information in the Macintosh
.Tn ROM
to interface with the hardware.
This method is only available if the
.Dv MRG_ADB
option is defined in the kernel configuration file.
The newer method interfaces directly with the
.Tn VIA
hardware and with the Power Manager hardware if it is
present
.Pq i.e. on the PowerBooks .
The default configuration currently uses the
Macintosh
.Tn ROM
Glue
.Pq Tn MRG
method.
.Pp
The
.Xr ioctl 2
call is used to control the
.Tn ADB
event device.
The following is a list of available
.Xr ioctl
commands:
.Bl -tag -width ADBIOC_GETREPEAT
.It Dv ADBIOC_DEVSINFO
Get
.Tn ADB
Device Info
.Pp
The
.Nm
event device will return an array of information containing an entry
for each device connected to the bus. Each entry contains the
current address, default address, and handler ID for the corresponding
.Tn ADB
device.
.It Dv ADBIOC_GETREPEAT
Get Keyboard Repeat Info
.Pp
Returns a structure containing the current keyboard repeat delay
and keyboard repeat interval.
.It Dv ADBIOC_SETREPEAT
Set Keyboard Repeat Rate
.Pp
Sets the keyboard repeat delay and interval to the values specified
by
.Ar argp .
.It Dv ADBIOC_RESET
.Tn ADB
Reset
.Pp
Perform a reset of the
.Tn ADB
which will reinitialize all of the devices attached to the bus.
.It Dv ADBIOC_LISTENCMD
ADB Listen Command
.Pp
Send data to the register of the
.Tn ADB
device specified by
.Ar argp .
This command is not fully implemented at this time.
.El
.Sh HARDWARE
The
.Nm
device supports the ADB hardware of most m68k-based
Macintosh models,
including the II-series, Centris- and Quadra-series, PowerBook-
and Duo-series, LC-series, and Performa-series models.
.Pp
Most standard
.Tn ADB
devices are supported by the
.Nm
driver, including mice which follow Apple's
Extended Mouse Protocol.
Many multi-button mice which follow a proprietary protocol are
not currently supported in multi-button mode.
The following is a partial list of supported
.Tn ADB
devices:
.Bd -filled -offset indent
.Bl -item -compact
.It
Apple Standard Keyboard
.It
Apple Extended Keyboard
.It
Apple Adjustable Keyboard
.It
Apple Desktop Bus Mouse
.It
Logitech TrackMan
.It
Logitech MouseMan
.It
Microspeed Mouse Deluxe
.It
Mouse Systems A3 Mouse
.El
.Ed
.Sh DIAGNOSTICS
.Bl -diag -compact
.It adb0 at obio0 (ADB event device).
This is a normal autoconfiguration message noting the presence of the
.Nm
event device.
.It adb: bus subsystem.
A standard autoconfiguration message indicating the initialization
of the
.Tn ADB
subsystem.
.It adb: no devices found.
No
.Tn ADB
devices were found to be connected to the bus during autoconfiguration.
.It adb: using %s series hardware support.
Indicates the class of
.Tn ADB
hardware support the machine uses.
.It adb: hardware type unknown for this machine.
The
.Tn ADB
hardware in this machine is currently unsupported.
.It "adb: no ROM ADB driver in this kernel for this machine."
The kernel lacks the necessary Macintosh ROM Glue
.Pq Tn MRG
support for accessing the
.Tn ADB
hardware on this machine.
.It adb: using serial console.
A serial console will be used for user input rather than the
.Tn ADB
event device.
.It adb: %s at %d.
An
.Tn ADB
device of the type specified by
.Em %s
has been found at location
.Em %d .
.El
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er ENXIO
No such
.Tn ADB
event device.
.It Bq Er EBUSY
Another process has the device open.
.It Bq Er EINVAL
Invalid
.Xr ioctl
specification.
.It Bq Er EMSGSIZE
The size of the
.Tn ADB
event being read is too large to fit into the buffer
allocated to it.
.El
.Sh FILES
.Bl -tag -width /dev/adb -compact
.It Pa /dev/adb
The
.Tn ADB
event device.
.El
.Sh HISTORY
The
.Nm
interface first appeared in
.Nx 0.9 .
It has been under development ever since.
.Sh AUTHORS
Bradley A. Grantham wrote the original
.Nm
driver, including the
.Tn MRG
support.
The hardware direct interface was written by
John P. Wittkowski.
The PowerManager interface was written by Takashi Hamada.
.Sh BUGS
.Bl -bullet
.It
Not every class of
.Tn ADB
hardware is supported yet.
.It
The talk command is currently unimplemented.
.It
The listen command is not implemented yet.
.It
Not all multi-button mice are currently supported.
.It
Only mapped and relative-position
.Tn ADB
devices
.Pq i.e. keyboards and mice
are supported.
Thus absolute-position and other exotic devices will not work.
.El

101
share/man/man4/man4.mac68k/autoconf.4 Normal file
View File

@ -0,0 +1,101 @@
.\"
.\" Copyright (c) 1997 Colin Wood
.\" Copyright (c) 1995 Mark Brinicombe
.\" Copyright (c) 1994 Christopher G. Demetriou
.\" 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. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by Christopher G. Demetriou.
.\" 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.
.\"
.\" $Id: autoconf.4,v 1.1 1997/07/18 02:13:41 ender Exp $
.\"
.Dd July 17, 1997
.Dt AUTOCONF 4 mac68k
.Os NetBSD
.Sh NAME
.Nm autoconf
.Nd diagnostics from the autoconfiguration code
.Sh DESCRIPTION
When
.Tn NetBSD
bootstraps it probes the innards of the machine
on which it is running
and locates controllers, drives, and other devices, printing out
what it finds on the console. This procedure is driven by a system
configuration table which is processed by
.Xr config 8
and compiled into each kernel.
Devices which exist in the machine but are not configured into the
kernel are usually not detected.
The exception to this is the case of
.Tn NuBus
expansion boards.
All
.Tn NuBus
slots are probed,
and information about any cards found is reported even if the card
is not currently configured.
.Sh DIAGNOSTICS
.Bl -diag
.\"
.\" The following doesn't seem to happen on the mac68k port, but
.\" keep here waiting until I know for sure --Colin
.\"
.\".It CPU class not configured.
.\"You tried to boot
.\".Tn NetBSD
.\"on a class of
.\".Tn CPU
.\"type which it doesn't
.\"(or at least this compiled version of
.\".Tn NetBSD
.\"doesn't) understand.a
.It %s%d at obio0: %s.
The system is configuring an onboard I/O controller.
.It addr %x not configured.
An onboard I/O controller was encountered that is not configured into the
kernel.
.It %s at nubus%d slot %x.
The system is configuring a NuBus expansion card in slot %x.
.It %s at nubus%d slot %x: %s (Vendor: %s, Part: %s Type: %x %x %x %x) not configured.
A NuBus expansion card was encountered that is not configured into the
kernel.
.Sq Vendor
is the manufacturer of the board,
.Sq Part
is the name of the board, and
.Sq Type
is the Apple-defined type.
.It %s: channel %d not configured.
A serial device channel was encountered that is not configured into the
kernel.
.It %s at %s not configured.
A device which was configured into the kernel was unable to properly
initialize itself.
.El
.Sh SEE ALSO
.Xr intro 4 ,
.Xr boot 8 ,
.Xr config 8

65
share/man/man4/man4.mac68k/mainbus.4 Normal file
View File

@ -0,0 +1,65 @@
.\"
.\" Copyright (c) 1997 Colin Wood
.\" 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. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by Colin Wood
.\" for the NetBSD Project.
.\" 4. 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.
.\"
.\" $NetBSD: mainbus.4,v 1.1 1997/07/18 02:13:40 ender Exp $
.\"
.Dd July 2, 1997
.Dt MAINBUS 4 mac68k
.Os NetBSD
.Sh NAME
.Nm mainbus
.Nd Mac68k main processor bus device.
.Sh SYNOPSIS
.Cd "mainbus0 at root"
.Sh DESCRIPTION
The
.Nm
interface serves as an abstraction used by the autoconfiguration
system to help find and attach busses
.Pq e.g. the Tn NuBus expansion bus
or devices
.Pq e.g. the math coprocessor
connected to the
.Tn Macintosh
main processor bus.
.Sh DIAGNOSTICS
.Bl -diag -compact
.It mainbus0 (root).
This is the normal autoconfiguration message indicating that the
main processor bus has been found.
.El
.Sh SEE ALSO
.Xr autoconf 4
.Xr obio 4
.Sh HISTORY
The
.Nm
first appeared in
.Nx 1.2 .

64
share/man/man4/man4.mac68k/obio.4 Normal file
View File

@ -0,0 +1,64 @@
.\"
.\" Copyright (c) 1997 Colin Wood
.\" 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. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by Colin Wood
.\" for the NetBSD Project.
.\" 4. 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.
.\"
.\" $NetBSD: obio.4,v 1.1 1997/07/18 02:13:40 ender Exp $
.\"
.Dd July 2, 1997
.Dt OBIO 4 mac68k
.Os NetBSD
.Sh NAME
.Nm obio
.Nd Mac68k onboard I/O bus device.
.Sh SYNOPSIS
.Cd "obio0 at mainbus?"
.Sh DESCRIPTION
The
.Nm
interface serves as an abstraction used by the autoconfiguration
system to help find and attach devices
.Pq e.g. the ethernet or Tn SCSI controllers
connected to the
.Tn Macintosh
onboard I/O bus.
.Sh DIAGNOSTICS
.Bl -diag -compact
.It obio0 at mainbus0.
This is the normal autoconfiguration message indicating that the
onboard I/O bus has been found and attached to the main processor
bus.
.El
.Sh SEE ALSO
.Xr autoconf 4
.Xr mainbus 4
.Sh HISTORY
The
.Nm
first appeared in
.Nx 1.2 .