xref: /netbsd-src/share/man/man4/man4.amiga/zz9k.4 (revision a2ba4e4c85bd5d58109731295b61330beb8ae26c)
1.\" $NetBSD: zz9k.4,v 1.2 2023/05/04 09:20:00 rillig Exp $
2.\"
3.\" Copyright (c) 2016 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Alain Runa.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd April 2, 2023
31.Dt ZZ9K 4 amiga
32.Os
33.Sh NAME
34.Nm zz9k
35.Nd MNT ZZ9000 graphics card driver
36.Sh SYNOPSIS
37.Cd "zz9k*	at zbus?"
38.Cd "zzfb*	at zz9k?"
39.Cd "options	ZZFB_CONSOLE"
40.Cd "zz*		at zz9k?"
41.Cd "zzax*	at zz9k?"
42.Cd "zzusb*	at zz9k?"
43.Sh DESCRIPTION
44The
45.Nm
46driver provides support for the MNT ZZ9000 graphics card and ethernet interface.
47Each driver can be individually enabled or disabled.
48However, all ZZ9000 drivers depend on the
49zz9k*
50as the root to work.
51.Pp
52The
53zzfb*
54.Xr wscons 4
55driver implements blitter-accelerated support for the boot console.
56Support for an unaccelerated X11 framebuffer is also available via the
57.Xr wsfb 4
58driver.
59.Pp
60The
61zz*
62driver implements the ZZ9000 ethernet interface.
63.Pp
64There is also provision for adding ZZ9000AX audio card support as
65zzax*
66and the USB port support as
67zzusb*
68at a later time.
69None of these are functional yet.
70.Sh SEE ALSO
71.Xr wscons 4 ,
72.Xr wsdisplay 4
73.Sh HISTORY
74The
75.Nm
76device first appeared in
77.Nx 10.0 .
78.Sh AUTHORS
79.An -nosplit
80The
81.Nm
82driver was written by
83.An Alain Runa Aq Mt alain74@gmx.net
84and was inspired by the original ZZ9000 drivers for AmigaOS.
85.Sh CAVEATS
86For the ZZ9000 to assume the boot console, the user has to explicitly set the
87.Dv FBZZ_CONSOLE
88option in the kernel config file.
89.Pp
90Currently, the video mode is hard-coded to 1280x720 at 8 bpp for the console
91emulation and 16 bpp for the framebuffer used by X11.
92Resolutions and color depths can be individually changed in the
93.Pa zz9k_fb.c
94source code.
95Please follow the source code comments.
96.Pp
97The
98zz*
99ethernet driver is considered experimental.
100As the MAC address is not stored permanently in the card,
101it will use its default address.
102This should not impose any problem unless two ZZ9000 will be used
103in the same LAN.
104Please configure the desired link address for the
105zz0
106interface in
107.Pa rc.conf
108or in the
109.Pa /etc/ifconfig.zz0
110file, to avoid a MAC address collision.
111.Pp
112The
113zzax*
114audio card driver is not functional yet.
115Only a basic skeleton source code is available for a possible later
116implementation.
117.Pp
118The
119zzusb*
120USB driver is not functional yet.
121Only a basic skeleton source code is available for a possible later
122implementation.
123.Sh BUGS
124None known.
125