xref: /freebsd/sys/conf/NOTES (revision 4cf6236007840a70f623e365e1749b12d324e318)
12365e64fSRodney W. Grimes#
22365e64fSRodney W. Grimes# LINT -- config file for checking all the sources, tries to pull in
32365e64fSRodney W. Grimes#	as much of the source tree as it can.
42365e64fSRodney W. Grimes#
54cf62360SPaul Traina#	$Id: LINT,v 1.235 1996/01/30 22:53:44 mpp Exp $
62365e64fSRodney W. Grimes#
73aa06999SGarrett Wollman# NB: You probably don't want to try running a kernel built from this
83aa06999SGarrett Wollman# file.  Instead, you should start from GENERIC, and add options from
93aa06999SGarrett Wollman# this file as required.
102365e64fSRodney W. Grimes#
112365e64fSRodney W. Grimes
126a8d6623SGarrett Wollman#
136a8d6623SGarrett Wollman# This directive is mandatory; it defines the architecture to be
146a8d6623SGarrett Wollman# configured for; in this case, the 386 family.  You must also specify
156a8d6623SGarrett Wollman# at least one CPU (the one you intend to run on); deleting the
166a8d6623SGarrett Wollman# specification for CPUs you don't need to use may make parts of the
176a8d6623SGarrett Wollman# system run faster
186a8d6623SGarrett Wollman#
192365e64fSRodney W. Grimesmachine		"i386"
20f87a3269SRodney W. Grimescpu		"I386_CPU"
21f87a3269SRodney W. Grimescpu		"I486_CPU"
22ca83dc2dSJordan K. Hubbardcpu		"I586_CPU"		# aka Pentium(tm)
237059cdf2SDavid Greenmancpu		"I686_CPU"		# aka Pentium Pro(tm)
242365e64fSRodney W. Grimes
256a8d6623SGarrett Wollman#
266a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
276a8d6623SGarrett Wollman# be the same as the name of your kernel.
286a8d6623SGarrett Wollman#
296a8d6623SGarrett Wollmanident		LINT
306a8d6623SGarrett Wollman
316a8d6623SGarrett Wollman#
326a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
336a8d6623SGarrett Wollman# internal system tables by a complicated formula defined in param.c.
346a8d6623SGarrett Wollman#
356a8d6623SGarrett Wollmanmaxusers	10
366a8d6623SGarrett Wollman
376a8d6623SGarrett Wollman#
38663afbc3SScott Mace# Under some circumstances it is necessary to make the default max
39f73bbaf2SDavid Greenman# number of processes per user and open files per user more than the
40663afbc3SScott Mace# defaults on bootup.  (an example is a large news server in which
410f700bfdSJoerg Wunsch# the uid, news, can sometimes need > 100 simultaneous processes running,
420f700bfdSJoerg Wunsch# or perhaps a user using lots of windows under X).
43b1529bdaSPeter Wemmoptions		CHILD_MAX=128
44b1529bdaSPeter Wemmoptions		OPEN_MAX=128
45663afbc3SScott Mace
46663afbc3SScott Mace#
476a8d6623SGarrett Wollman# A math emulator is mandatory if you wish to run on hardware which
486a8d6623SGarrett Wollman# does not have a floating-point processor.  Pick either the original,
496a8d6623SGarrett Wollman# bogus (but freely-distributable) math emulator, or a much more
506a8d6623SGarrett Wollman# fully-featured but GPL-licensed emulator taken from Linux.
516a8d6623SGarrett Wollman#
526a8d6623SGarrett Wollmanoptions		MATH_EMULATE		#Support for x87 emulation
5394c94804SBruce Evans# Don't enable both of these in a real config.
546c5e9bbdSMike Pritchardoptions		GPL_MATH_EMULATE	#Support for x87 emulation via
55cfecaf32SGary Clark II					#new math emulator
56cfecaf32SGary Clark II
576a8d6623SGarrett Wollman#
586a8d6623SGarrett Wollman# This directive defines a number of things:
596a8d6623SGarrett Wollman#  - The compiled kernel is to be called `kernel'
606a8d6623SGarrett Wollman#  - The root filesystem might be on partition wd0a
61b8e91dabSDavid Greenman#  - Crash dumps will be written to wd0b, if possible.  Specifying the
62b8e91dabSDavid Greenman#    dump device here is not recommended.  Use dumpon(8).
636a8d6623SGarrett Wollman#
64b8e91dabSDavid Greenmanconfig		kernel	root on wd0 dumps on wd0
652365e64fSRodney W. Grimes
666a8d6623SGarrett Wollman
676a8d6623SGarrett Wollman#####################################################################
686a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
69690f540cSAndrey A. Chernov
706a8d6623SGarrett Wollman#
716a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
7256c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
7356c7a48cSJordan K. Hubbard# still relies on the 4.3 emulation.
746a8d6623SGarrett Wollman#
756a8d6623SGarrett Wollmanoptions		"COMPAT_43"
766a8d6623SGarrett Wollman
776a8d6623SGarrett Wollman#
786c5e9bbdSMike Pritchard# Allow user-mode programs to manipulate their local descriptor tables.
796a8d6623SGarrett Wollman# This option is required for the WINE Windows(tm) emulator, and is
806a8d6623SGarrett Wollman# not used by anything else (that we know of).
816a8d6623SGarrett Wollman#
826a8d6623SGarrett Wollmanoptions		USER_LDT		#allow user-level control of i386 ldt
836a8d6623SGarrett Wollman
846a8d6623SGarrett Wollman#
856a8d6623SGarrett Wollman# These three options provide support for System V Interface
866a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
876a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
886a8d6623SGarrett Wollman#
896a8d6623SGarrett Wollmanoptions		SYSVSHM
906a8d6623SGarrett Wollmanoptions		SYSVSEM
916a8d6623SGarrett Wollmanoptions		SYSVMSG
926a8d6623SGarrett Wollman
936a8d6623SGarrett Wollman
946a8d6623SGarrett Wollman#####################################################################
956a8d6623SGarrett Wollman# DEBUGGING OPTIONS
966a8d6623SGarrett Wollman
976a8d6623SGarrett Wollman#
98b5d89ca8SBruce Evans# Enable the kernel debugger.
996a8d6623SGarrett Wollman#
100b5d89ca8SBruce Evansoptions		DDB
101b5d89ca8SBruce Evans
102b5d89ca8SBruce Evans#
1036a8d6623SGarrett Wollman# KTRACE enables the system-call tracing facility ktrace(2).
1046a8d6623SGarrett Wollman#
1052365e64fSRodney W. Grimesoptions		KTRACE			#kernel tracing
10621c64a07SAndrey A. Chernov
1076a8d6623SGarrett Wollman#
1086a8d6623SGarrett Wollman# The DIAGNOSTIC option is used in a number of source files to enable
1096a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
1106a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
1116a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
1126a8d6623SGarrett Wollman# programming errors.
1136a8d6623SGarrett Wollman#
1140dc7d907SPoul-Henning Kampoptions		DIAGNOSTIC
115da59a31cSDavid Greenman
1160dd1eea1SJordan K. Hubbard#
1170dd1eea1SJordan K. Hubbard# Allow ordinary users to take the console - this is useful for X.
1180dd1eea1SJordan K. Hubbardoptions		UCONSOLE
1190dd1eea1SJordan K. Hubbard
1206a8d6623SGarrett Wollman
1216a8d6623SGarrett Wollman#####################################################################
1226a8d6623SGarrett Wollman# NETWORKING OPTIONS
12370c0b54cSAndrey A. Chernov
1246a8d6623SGarrett Wollman#
1256a8d6623SGarrett Wollman# Protocol families:
1266a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
1276a8d6623SGarrett Wollman#  Source code for the NS (Xerox Network Service), ISO (OSI), and
1286a8d6623SGarrett Wollman#  CCITT (X.25) families is provided for amusement value, although we
1296a8d6623SGarrett Wollman#  try to ensure that it actually compiles.
1306a8d6623SGarrett Wollman#
1316a8d6623SGarrett Wollmanoptions		INET			#Internet communications protocols
1326a8d6623SGarrett Wollmanoptions		CCITT			#X.25 network layer
1336a8d6623SGarrett Wollmanoptions		NS			#Xerox NS communications protocols
134f73bbaf2SDavid Greenman
135cc6a66f2SJulian Elischeroptions		IPX			#IPX/SPX communications protocols
136cc6a66f2SJulian Elischeroptions		IPXIP			#IPX in IP encapsulation (not available)
137cc6a66f2SJulian Elischeroptions		IPTUNNEL		#IP in IPX encapsulation (not available)
138b1529bdaSPeter Wemmoptions		IPXPRINTFS=0		#IPX/SPX Console Debugging Information
139b1529bdaSPeter Wemmoptions		IPX_ERRPRINTFS=0	#IPX/SPX Console Debugging Information
140cc6a66f2SJulian Elischer
141f73bbaf2SDavid Greenman# These are currently broken and don't compile
142f73bbaf2SDavid Greenman#options		ISO
143f73bbaf2SDavid Greenman#options		TPIP			#ISO TP class 4 over IP
144f73bbaf2SDavid Greenman#options		TPCONS			#ISO TP class 0 over X.25
14563a74862SSteven Wallace
1466a8d6623SGarrett Wollman#
1476a8d6623SGarrett Wollman# Network interfaces:
14856c7a48cSJordan K. Hubbard#  The `loop' pseudo-device is MANDATORY when networking is enabled.
1496a8d6623SGarrett Wollman#  The `ether' pseudo-device provides generic code to handle
15056c7a48cSJordan K. Hubbard#  Ethernets; it is MANDATORY when a Ethernet device driver is
1516a8d6623SGarrett Wollman#  configured.
152d41f24e7SDavid Greenman#  The 'fddi' pseudo-device provides generic code to support FDDI.
15383401efaSGarrett Wollman#  The `sppp' pseudo-device serves a similar role for certain types
154e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
1556a8d6623SGarrett Wollman#  The `sl' pseudo-device implements the Serial Line IP (SLIP) service.
1566a8d6623SGarrett Wollman#  The `ppp' pseudo-device implements the Point-to-Point Protocol.
157d29895dcSGarrett Wollman#  The `bpfilter' pseudo-device enables the Berkeley Packet Filter.  Be
158d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
159d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
160d29895dcSGarrett Wollman#  simultaneous BPF clients programs runnable.
16159d8d13fSGarrett Wollman#  The `disc' pseudo-device implements a minimal network interface,
16259d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
16359d8d13fSGarrett Wollman#  included for testing purposes.
164b60d4a5dSAtsushi Murai#  The `tun' pseudo-device implements the User Process PPP (iijppp)
1656a8d6623SGarrett Wollman#
1666a8d6623SGarrett Wollmanpseudo-device	ether			#Generic Ethernet
167d41f24e7SDavid Greenmanpseudo-device	fddi			#Generic FDDI
16883401efaSGarrett Wollmanpseudo-device	sppp			#Generic Synchronous PPP
1696a8d6623SGarrett Wollmanpseudo-device	loop			#Network loopback device
1706a8d6623SGarrett Wollmanpseudo-device	sl	2		#Serial Line IP
1716a8d6623SGarrett Wollmanpseudo-device	ppp	2		#Point-to-point protocol
172d29895dcSGarrett Wollmanpseudo-device	bpfilter	4	#Berkeley packet filter
17359d8d13fSGarrett Wollmanpseudo-device	disc			#Discard device
1742d3f9865SAtsushi Muraipseudo-device	tun	1		#Tunnel driver(user process ppp)
175d29895dcSGarrett Wollman
1766a8d6623SGarrett Wollmanoptions		NSIP			#XNS over IP
1776a8d6623SGarrett Wollmanoptions		LLC			#X.25 link layer for Ethernets
1786a8d6623SGarrett Wollmanoptions		HDLC			#X.25 link layer for serial lines
1796a8d6623SGarrett Wollman
180f73bbaf2SDavid Greenman# broken
181f73bbaf2SDavid Greenman#options		EON			#ISO CLNP over IP
182f73bbaf2SDavid Greenman
1836a8d6623SGarrett Wollman#
1846a8d6623SGarrett Wollman# Internet family options:
1856a8d6623SGarrett Wollman#
1866a8d6623SGarrett Wollman# TCP_COMPAT_42 causes the TCP code to emulate certain bugs present in
1876a8d6623SGarrett Wollman# 4.2BSD.  This option should not be used unless you have a 4.2BSD
1886a8d6623SGarrett Wollman# machine and TCP connections fail.
1896a8d6623SGarrett Wollman#
1906a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
1916a8d6623SGarrett Wollman# with mrouted(8).
1926a8d6623SGarrett Wollman#
193d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
194d29895dcSGarrett Wollman# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE does
195d29895dcSGarrett Wollman# the obvious thing.
1967332d95aSUgen J.S. Antsilevich# IPACCT enables IP accounting.
197d29895dcSGarrett Wollman#
19865e8111fSBruce Evans# TCPDEBUG is undocumented.
19965e8111fSBruce Evans#
2006a8d6623SGarrett Wollmanoptions		"TCP_COMPAT_42"		#emulate 4.2BSD TCP bugs
201e3178a06SJordan K. Hubbardoptions		MROUTING		# Multicast routing
202d29895dcSGarrett Wollmanoptions         IPFIREWALL              #firewall
203d29895dcSGarrett Wollmanoptions         IPFIREWALL_VERBOSE      #print information about
204d29895dcSGarrett Wollman					# dropped packets
205c01db44aSBruce Evansoptions		IPACCT			#ipaccounting
20665e8111fSBruce Evansoptions		TCPDEBUG
2076a8d6623SGarrett Wollman
2086a8d6623SGarrett Wollman
2096a8d6623SGarrett Wollman#####################################################################
2106a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
211e3178a06SJordan K. Hubbard
2122365e64fSRodney W. Grimes#
2136a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
2146a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
2156a8d6623SGarrett Wollman# time.  (Exception: the UFS family---FFS, MFS, and LFS---cannot
2166a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
2176a8d6623SGarrett Wollman# compile other filesystems as well.
2186a8d6623SGarrett Wollman#
2196a8d6623SGarrett Wollman# NB: The LFS, PORTAL, and UNION filesystems are known to be buggy,
2206a8d6623SGarrett Wollman# and WILL panic your system if you attempt to do anything with them.
2216a8d6623SGarrett Wollman# They are included here as an incentive for some enterprising soul to
2226a8d6623SGarrett Wollman# sit down and fix them.
2232365e64fSRodney W. Grimes#
224e5e60905SDavid Greenman# Note: 4.4BSD NQNFS lease checking has relatively high cost for
225e5e60905SDavid Greenman# _local_ I/O as well as remote I/O. Don't use it unless you will
226e5e60905SDavid Greenman# using NQNFS.
227e5e60905SDavid Greenman#
228f1a9c715SDavid Greenman
2296a8d6623SGarrett Wollman# One of these is mandatory:
2306a8d6623SGarrett Wollmanoptions		FFS			#Fast filesystem
2316a8d6623SGarrett Wollmanoptions		NFS			#Network File System
2326a8d6623SGarrett Wollman
2336a8d6623SGarrett Wollman# The rest are optional:
234e5e60905SDavid Greenmanoptions		NQNFS			#Enable NQNFS lease checking
2357c115697SPoul-Henning Kamp# options	NFS_NOSERVER		#Disable the NFS-server code.
236f1a9c715SDavid Greenmanoptions		"CD9660"		#ISO 9660 filesystem
237f1a9c715SDavid Greenmanoptions		FDESC			#File descriptor filesystem
238f1a9c715SDavid Greenmanoptions		KERNFS			#Kernel filesystem
239f1a9c715SDavid Greenmanoptions		LFS			#Log filesystem
240f1a9c715SDavid Greenmanoptions		MFS			#Memory File System
2413f9a6982SDoug Rabsonoptions		MSDOSFS			#MS DOS File System
242f1a9c715SDavid Greenmanoptions		NULLFS			#NULL filesystem
243f1a9c715SDavid Greenmanoptions		PORTAL			#Portal filesystem
244f1a9c715SDavid Greenmanoptions		PROCFS			#Process filesystem
245f1a9c715SDavid Greenmanoptions		UMAPFS			#UID map filesystem
246f1a9c715SDavid Greenmanoptions		UNION			#Union filesystem
24746746c3bSJulian Elischer# THis DEVFS is experimental but seems to work
24846746c3bSJulian Elischeroptions		DEVFS			#devices filesystem
249f1a9c715SDavid Greenman
250d52d7365SPoul-Henning Kamp# Make space in the kernel for a MFS root filesystem.  Define to the number
251d52d7365SPoul-Henning Kamp# of kilobytes to reserve for the filesystem.
252b1529bdaSPeter Wemmoptions		MFS_ROOT=10
253b1529bdaSPeter Wemm# Allow the MFS_ROOT code to load the MFS image from floppy if it is missing.
254b1529bdaSPeter Wemmoptions		MFS_AUTOLOAD
255d52d7365SPoul-Henning Kamp
256a401ebbeSDavid Greenman# Allow this many swap-devices.
257b1529bdaSPeter Wemmoptions		NSWAPDEV=20
258a401ebbeSDavid Greenman
2596a8d6623SGarrett Wollman# Disk quotas are supported when this option is enabled.  If you
2606a8d6623SGarrett Wollman# change the value of this option, you must do a `make clean' in your
2616a8d6623SGarrett Wollman# kernel compile directory in order to get a working kernel.
2626a8d6623SGarrett Wollman#
2632365e64fSRodney W. Grimesoptions		QUOTA			#enable disk quotas
2646a8d6623SGarrett Wollman
2656a8d6623SGarrett Wollman
2666a8d6623SGarrett Wollman#####################################################################
267de6a307eSPeter Dufault# SCSI DEVICES
268de6a307eSPeter Dufault
2696a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
2706a8d6623SGarrett Wollman
2716a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
272ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
2736a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
2746a8d6623SGarrett Wollman# device configuration sections below.
2756a8d6623SGarrett Wollman#
276265368d4SRodney W. Grimes# Beginning with FreeBSD 2.0.5 you can wire down your SCSI devices so
277ebc1a0e2SPeter Dufault# that a given bus, target, and LUN always come on line as the same
278ebc1a0e2SPeter Dufault# device unit.  In earlier versions the unit numbers were assigned
279ebc1a0e2SPeter Dufault# in the order that the devices were probed on the SCSI bus.  This
280ebc1a0e2SPeter Dufault# means that if you removed a disk drive, you may have had to rewrite
281ebc1a0e2SPeter Dufault# your /etc/fstab file, and also that you had to be careful when adding
282ebc1a0e2SPeter Dufault# a new disk as it may have been probed earlier and moved your device
283ebc1a0e2SPeter Dufault# configuration around.
284ebc1a0e2SPeter Dufault
285ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
286ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
287ebc1a0e2SPeter Dufault# type.  For example, if you wire a disk as "sd3" then the first
288ebc1a0e2SPeter Dufault# non-wired disk will be assigned sd4.
289ebc1a0e2SPeter Dufault
290ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
291ebc1a0e2SPeter Dufault
2924fbaf9a7SJustin T. Gibbs# controller	scbus0 at ahc0		# Single bus device
2934fbaf9a7SJustin T. Gibbs# controller	scbus1 at ahc1 bus 0	# Single bus device
2944fbaf9a7SJustin T. Gibbs# controller	scbus3 at ahc2 bus 0	# Twin bus device
2954fbaf9a7SJustin T. Gibbs# controller	scbus2 at ahc2 bus 1	# Twin bus device
296ebc1a0e2SPeter Dufault# disk 		sd0 at scbus0 target 0 unit 0
2974fbaf9a7SJustin T. Gibbs# disk		sd1 at scbus3 target 1
2984fbaf9a7SJustin T. Gibbs# disk		sd2 at scbus2 target 3
2994fbaf9a7SJustin T. Gibbs# tape		st1 at scbus1 target 6
300ebc1a0e2SPeter Dufault# device	cd0 at scbus?
301ebc1a0e2SPeter Dufault
302ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
303ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
304ebc1a0e2SPeter Dufault
305ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
306ebc1a0e2SPeter Dufault
307265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
308ebc1a0e2SPeter Dufault# configuration and doesn't have to be explicitly configured.
309ebc1a0e2SPeter Dufault
3106a8d6623SGarrett Wollmancontroller	scbus0	#base SCSI code
3116a8d6623SGarrett Wollmandevice		ch0	#SCSI media changers
3126a8d6623SGarrett Wollmandevice		sd0	#SCSI disks
3136a8d6623SGarrett Wollmandevice		st0	#SCSI tapes
3146a8d6623SGarrett Wollmandevice		cd0	#SCSI CD-ROMs
31549bdb5b8SJoerg Wunschdevice		od0	#SCSI optical disk
3166a8d6623SGarrett Wollman
317265368d4SRodney W. Grimes# The previous devices (ch, sd, st, cd) are recognized by config.
318265368d4SRodney W. Grimes# config doesn't (and shouldn't) know about these newer ones,
319265368d4SRodney W. Grimes# so we have to specify that they are on a SCSI bus with the "at scbus?"
320265368d4SRodney W. Grimes# clause.
321265368d4SRodney W. Grimes
3228909a72bSPeter Dufaultdevice worm0 at scbus?	# SCSI worm
3238909a72bSPeter Dufaultdevice pt0 at scbus?	# SCSI processor type
3248909a72bSPeter Dufaultdevice sctarg0 at scbus? # SCSI target
3258909a72bSPeter Dufault
3261a7c583cSGarrett Wollman# SCSI OPTIONS:
3271a7c583cSGarrett Wollman
3281a7c583cSGarrett Wollman# SCSIDEBUG: When defined enables debugging macros
3291a7c583cSGarrett Wollman# NO_SCSI_SENSE: When defined disables sense descriptions (about 4k)
3301a7c583cSGarrett Wollman# SCSI_REPORT_GEOMETRY: Always report disk geometry at boot up instead
331265368d4SRodney W. Grimes#                       of only when booting verbosely.
3321a7c583cSGarrett Wollmanoptions		SCSIDEBUG
3331a7c583cSGarrett Wollman#options	NO_SCSI_SENSE
3341a7c583cSGarrett Wollmanoptions		SCSI_REPORT_GEOMETRY
3351a7c583cSGarrett Wollman
3366a8d6623SGarrett Wollman
3376a8d6623SGarrett Wollman#####################################################################
3386a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
3396a8d6623SGarrett Wollman
3402365e64fSRodney W. Grimes#
3416a8d6623SGarrett Wollman# Of these, only the `log' device is truly mandatory.  The `pty'
3426a8d6623SGarrett Wollman# device usually turns out to be ``effectively mandatory'', as it is
3436a8d6623SGarrett Wollman# required for `telnetd', `rlogind', `screen', `emacs', and `xterm',
3441a7c583cSGarrett Wollman# among others.  The `isdn', `ii', `ity', `itel', and `ispy' devices
34556c7a48cSJordan K. Hubbard# are all required when ISDN support is used.  If you wish to run certain
34656c7a48cSJordan K. Hubbard# system utilities which are compressed by default (like /stand/sysinstall)
34756c7a48cSJordan K. Hubbard# then `gzip' becomes mandatory too.
3486a8d6623SGarrett Wollman#
3499da6a15aSJordan K. Hubbardpseudo-device	pty	16	#Pseudo ttys - can go as high as 64
3506a8d6623SGarrett Wollmanpseudo-device	speaker		#Play IBM BASIC-style noises out your speaker
3516a8d6623SGarrett Wollmanpseudo-device	log		#Kernel syslog interface (/dev/klog)
3526a8d6623SGarrett Wollmanpseudo-device	gzip		#Exec gzipped a.out's
353784cf072SPoul-Henning Kamppseudo-device	vn		#Vnode driver (turns a file into a device)
3544cba4555SUgen J.S. Antsilevichpseudo-device	snp	3	#Snoop device - to look at pty/vty/etc..
3559ba0e7c3SBruce Evans
3561a7c583cSGarrett Wollman# These are non-optional for ISDN
3571a7c583cSGarrett Wollmanpseudo-device   isdn
3581a7c583cSGarrett Wollmanpseudo-device   ii      4
3591a7c583cSGarrett Wollmanpseudo-device   ity     4
3601a7c583cSGarrett Wollmanpseudo-device   itel    2
3611a7c583cSGarrett Wollmanpseudo-device   ispy    1
3621a7c583cSGarrett Wollman
36365e8111fSBruce Evans# These are only for watching for bitrot in old tty code.
36465e8111fSBruce Evans# broken
36565e8111fSBruce Evans#pseudo-device	tb
36665e8111fSBruce Evans
36765e8111fSBruce Evans# These are only for watching for bitrot in old SCSI code.
36865e8111fSBruce Evanspseudo-device	su		#scsi user
36965e8111fSBruce Evanspseudo-device	ssc		#super scsi
37065e8111fSBruce Evans
3716a8d6623SGarrett Wollman
3726a8d6623SGarrett Wollman#####################################################################
3736a8d6623SGarrett Wollman# HARDWARE DEVICE CONFIGURATION
3746a8d6623SGarrett Wollman
3756a8d6623SGarrett Wollman# ISA and EISA devices:
3766a8d6623SGarrett Wollman# Currently there is no separate support for EISA.  There should be.
3776a8d6623SGarrett Wollman# Micro Channel is not supported at all.
3786a8d6623SGarrett Wollman
3796a8d6623SGarrett Wollman#
3801a7c583cSGarrett Wollman# Mandatory ISA devices: isa, sc or vt, npx
3816a8d6623SGarrett Wollman#
3822365e64fSRodney W. Grimescontroller	isa0
3832365e64fSRodney W. Grimes
3846a8d6623SGarrett Wollman#
3856a8d6623SGarrett Wollman# Options for `isa':
3866a8d6623SGarrett Wollman#
3879ba0e7c3SBruce Evans# AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A
3889ba0e7c3SBruce Evans# interrupt controller.  This saves about 1.25 usec for each interrupt.
3899ba0e7c3SBruce Evans# Automatic EOI is documented not to work for for the slave with the
3909ba0e7c3SBruce Evans# original i8259A, but it works for some clones and some integrated
3919ba0e7c3SBruce Evans# versions.
3929ba0e7c3SBruce Evans#
3936a8d6623SGarrett Wollman# BOUNCE_BUFFERS provides support for ISA DMA on machines with more
3946a8d6623SGarrett Wollman# than 16 megabytes of memory.  It doesn't hurt on other machines.
3956a8d6623SGarrett Wollman# Some broken EISA and VLB hardware may need this, too.
3963339606dSAndreas Schulz#
3979ba0e7c3SBruce Evans# DUMMY_NOPS disables extra delays for some bus operations.  The delays
3989ba0e7c3SBruce Evans# are mostly for older systems and aren't used consistently.  Probably
3999ba0e7c3SBruce Evans# works OK on most EISA bus machines.
4003339606dSAndreas Schulz#
4013339606dSAndreas Schulz# TUNE_1542 enables the automatic ISA bus speed selection for the
4023339606dSAndreas Schulz# Adaptec 1542 boards. Does not work for all boards, use it with caution.
4033339606dSAndreas Schulz#
4045eb46edfSDavid Greenman# BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
4055eb46edfSDavid Greenman# reset the CPU for reboot.  This is needed on some systems with broken
4065eb46edfSDavid Greenman# keyboard controllers.
4073eafdedeSBruce Evans#
4089ba0e7c3SBruce Evans#options	"AUTO_EOI_2"
4096a8d6623SGarrett Wollmanoptions		BOUNCE_BUFFERS
4103339606dSAndreas Schulz#options	DUMMY_NOPS
411b6b8f81eSAndrey A. Chernov#options        "TUNE_1542"
412b1529bdaSPeter Wemm#options	BROKEN_KEYBOARD_RESET
4133af6b652SDavid Greenman
4144530be52SJordan K. Hubbard# Enable this and PCVT_FREEBSD for pcvt vt220 compatible console driver
4157fbcd76bSBruce Evansdevice		vt0	at isa? port "IO_KBD" tty irq 1 vector pcrint
416b1529bdaSPeter Wemmoptions		PCVT_FREEBSD=210	# pcvt running on FreeBSD >= 2.0.5
4177fbcd76bSBruce Evansoptions		XSERVER			# include code for XFree86
4187fbcd76bSBruce Evansoptions		FAT_CURSOR		# start with block cursor
419e9aaac99SNate Williams# This PCVT option is for keyboards such as those used on IBM ThinkPad laptops
420b1529bdaSPeter Wemmoptions		PCVT_SCANSET=2 		# IBM keyboards are non-std
4214530be52SJordan K. Hubbard
4224530be52SJordan K. Hubbard# The syscons console driver (sco color console compatible) - default.
4236a8d6623SGarrett Wollmandevice		sc0	at isa? port "IO_KBD" tty irq 1 vector scintr
4242ac8be82SAndreas Schulz
4256a8d6623SGarrett Wollman#
4266a8d6623SGarrett Wollman# Options for `sc':
4276a8d6623SGarrett Wollman#
4286a8d6623SGarrett Wollman# HARDFONTS allows the driver to load an ISO-8859-1 font to replace
4296a8d6623SGarrett Wollman# the default font in your display adapter's memory.
4306a8d6623SGarrett Wollman#
4316a8d6623SGarrett Wollmanoptions		HARDFONTS
43289d8fc79SAndrey A. Chernov#
43389d8fc79SAndrey A. Chernov# MAXCONS is maximum number of virtual consoles, no more than 16
43498886235SAndrey A. Chernov# default value: 12
43589d8fc79SAndrey A. Chernov#
436b1529bdaSPeter Wemmoptions         MAXCONS=16
43732128f4cSDavid Greenman
43898e9e66cSNate Williams#
43998e9e66cSNate Williams# This device is mandatory.
44098e9e66cSNate Williams#
44198e9e66cSNate Williams# The Numeric Processing eXtension is used to either enable the
44298e9e66cSNate Williams# coprocessor or enable math emulation.  If your machine doesn't contain
44398e9e66cSNate Williams# a math co-processor, you must *also* add the option "MATH_EMULATE".
44446746c3bSJulian Elischer# THIS IS NOT AN OPTIONAL ENTRY, DO NOT REMOVE IT
44598e9e66cSNate Williams#
4462365e64fSRodney W. Grimesdevice		npx0	at isa? port "IO_NPX" irq 13 vector npxintr
4476a8d6623SGarrett Wollman
4486a8d6623SGarrett Wollman#
4496a8d6623SGarrett Wollman# Optional ISA and EISA devices:
4506a8d6623SGarrett Wollman#
4516a8d6623SGarrett Wollman
4526a8d6623SGarrett Wollman#
453e56e7036SJustin T. Gibbs# SCSI host adapters: `aha', `aic', `bt', `nca'
4546a8d6623SGarrett Wollman#
4556a8d6623SGarrett Wollman# aha: Adaptec 154x
4569829c3edSJordan K. Hubbard# ahc: Adaptec 274x/284x/294x
4576a8d6623SGarrett Wollman# aic: Adaptec 152x and sound cards using the Adaptec AIC-6360 (slow!)
4586a8d6623SGarrett Wollman# bt: Most Buslogic controllers
459e05407d8SPoul-Henning Kamp# nca: ProAudioSpectrum cards using the NCR 5380 or Trantor T130
4606a8d6623SGarrett Wollman# uha: UltraStore 14F and 34F
4613c43212aSSøren Schmidt# sea: Seagate ST01/02 8 bit controller (slow!)
4623691d2b9SJordan K. Hubbard# wds: Western Digital WD7000 controller (no scatter/gather!).
4636a8d6623SGarrett Wollman#
4646a8d6623SGarrett Wollman# Note that the order is important in order for Buslogic cards to be
4656a8d6623SGarrett Wollman# probed correctly.
4666a8d6623SGarrett Wollman#
4676a8d6623SGarrett Wollman
468a1d01dafSJustin T. Gibbscontroller	bt0	at isa? port "IO_BT0" bio irq ? vector bt_isa_intr
4696a8d6623SGarrett Wollmancontroller	aha0	at isa? port "IO_AHA0" bio irq ? drq 5 vector ahaintr
4706a8d6623SGarrett Wollmancontroller	uha0	at isa? port "IO_UHA0" bio irq ? drq 5 vector uhaintr
4716a8d6623SGarrett Wollman
4726a8d6623SGarrett Wollmancontroller      aic0    at isa? port 0x340 bio irq 11 vector aicintr
473e05407d8SPoul-Henning Kampcontroller	nca0	at isa? port 0x1f88 bio irq 10 vector ncaintr
474e05407d8SPoul-Henning Kampcontroller	nca1	at isa? port 0x1f84
475e05407d8SPoul-Henning Kampcontroller	nca2	at isa? port 0x1f8c
476e05407d8SPoul-Henning Kampcontroller	nca3	at isa? port 0x1e88
477e05407d8SPoul-Henning Kampcontroller	nca4	at isa? port 0x350 bio irq 5 vector ncaintr
47845b4c36fSJordan K. Hubbard
4793c43212aSSøren Schmidtcontroller	sea0	at isa? bio irq 5 iomem 0xdc000 iosiz 0x2000 vector seaintr
4803691d2b9SJordan K. Hubbardcontroller	wds0	at isa? port 0x350 bio irq 15 drq 6 vector wdsintr
4813c43212aSSøren Schmidt
4826a8d6623SGarrett Wollman#
4836a8d6623SGarrett Wollman# ST-506, ESDI, and IDE hard disks: `wdc' and `wd'
4846a8d6623SGarrett Wollman#
4856a8d6623SGarrett Wollman# NB: ``Enhanced IDE'' is NOT supported at this time.
4866a8d6623SGarrett Wollman#
487e3dd3158SJohn Dyson# The flags fields are used to enable the multi-sector I/O and
488e3dd3158SJohn Dyson# the 32BIT I/O modes.  The flags may be used in either the controller
489e3dd3158SJohn Dyson# definition or in the individual disk definitions.  The controller
490e3dd3158SJohn Dyson# definition is supported for the boot configuration stuff.
491e3dd3158SJohn Dyson#
492e3dd3158SJohn Dyson# Each drive has a 16 bit flags value defined:
493e3dd3158SJohn Dyson#	The low 8 bits are the maximum value for the multi-sector I/O,
494e3dd3158SJohn Dyson#	where 0xff defaults to the maximum that the drive can handle.
495e3dd3158SJohn Dyson#	The high bit of the 16 bit flags (0x8000) allows probing for
496e3dd3158SJohn Dyson#	32 bit transfers.
497e3dd3158SJohn Dyson#
498e3dd3158SJohn Dyson# The flags field for the drives can be specified in the controller
499e3dd3158SJohn Dyson# specification with the low 16 bits for drive 0, and the high 16 bits
500e3dd3158SJohn Dyson# for drive 1.
501e3dd3158SJohn Dyson# e.g.:
502e3dd3158SJohn Dyson#controller	wdc0	at isa? port "IO_WD1" bio irq 14 flags 0x00ff8004 vector wdintr
503e3dd3158SJohn Dyson#
504e3dd3158SJohn Dyson# specifies that drive 0 will be allowed to probe for 32 bit transfers and
505e3dd3158SJohn Dyson# a maximum multi-sector transfer of 4 sectors, and drive 1 will not be
506e3dd3158SJohn Dyson# allowed to probe for 32 bit transfers, but will allow multi-sector
507e3dd3158SJohn Dyson# transfers up to the maximum that the drive supports.
508e3dd3158SJohn Dyson#
509e3dd3158SJohn Dyson
510e3dd3158SJohn Dyson#
5112620c42eSNate Williamscontroller	wdc0	at isa? port "IO_WD1" bio irq 14 vector wdintr
5122620c42eSNate Williamsdisk		wd0	at wdc0 drive 0
5132620c42eSNate Williamsdisk		wd1	at wdc0 drive 1
5142620c42eSNate Williamscontroller	wdc1	at isa? port "IO_WD2" bio irq 15 vector wdintr
5152620c42eSNate Williamsdisk		wd2	at wdc1 drive 0
5162620c42eSNate Williamsdisk		wd3	at wdc1 drive 1
5172365e64fSRodney W. Grimes
5186a8d6623SGarrett Wollman#
5196788ce49SJordan K. Hubbard# Options for `wdc':
5206788ce49SJordan K. Hubbard#
5216788ce49SJordan K. Hubbard# ATAPI enables the support for ATAPI-compatible IDE devices
5226788ce49SJordan K. Hubbard#
5236788ce49SJordan K. Hubbardoptions         ATAPI   #Enable ATAPI support for IDE bus
5246788ce49SJordan K. Hubbard
5256788ce49SJordan K. Hubbard# IDE CD-ROM driver - requires wdc controller and ATAPI option
5266788ce49SJordan K. Hubbarddevice          wcd0
5276788ce49SJordan K. Hubbard
5286788ce49SJordan K. Hubbard#
5296a8d6623SGarrett Wollman# Standard floppy disk controllers and floppy tapes: `fdc', `fd', and `ft'
5306a8d6623SGarrett Wollman#
5316a8d6623SGarrett Wollmancontroller	fdc0	at isa? port "IO_FD1" bio irq 6 drq 2 vector fdintr
53285827d9cSJoerg Wunsch#
53385827d9cSJoerg Wunsch# Activate this line instead of the fdc0 line above if you happen to
53485827d9cSJoerg Wunsch# have an Insight floppy tape.  Probing them proved to be dangerous
53585827d9cSJoerg Wunsch# for people with floppy disks only, so it's "hidden" behind a flag:
53685827d9cSJoerg Wunsch#controller fdc0 at isa? port "IO_FD1" bio flags 1 irq 6 drq 2 vector fdintr
53785827d9cSJoerg Wunsch
5386a8d6623SGarrett Wollmandisk		fd0	at fdc0 drive 0
5396a8d6623SGarrett Wollmandisk		fd1	at fdc0 drive 1
5406a8d6623SGarrett Wollmantape		ft0	at fdc0 drive 2
5416a8d6623SGarrett Wollman
54285827d9cSJoerg Wunsch
5436a8d6623SGarrett Wollman#
544d29895dcSGarrett Wollman# Options for `fd':
54595b926abSJoerg Wunsch#
546d29895dcSGarrett Wollman# FDSEEKWAIT selects a non-default head-settle time (i.e., the time to
547d29895dcSGarrett Wollman# wait after a seek is performed).  The default value (1/32 s) is
548d29895dcSGarrett Wollman# usually sufficient.  The units are inverse seconds, so a value of 16
549d29895dcSGarrett Wollman# here means to wait 1/16th of a second; you should choose a power of
550d29895dcSGarrett Wollman# two.
551b1529bdaSPeter Wemm# XXX: this seems to be missing!
552b1529bdaSPeter Wemmoptions	FDSEEKWAIT=16
55395b926abSJoerg Wunsch
55495b926abSJoerg Wunsch#
5552f6df264SJordan K. Hubbard# Other standard PC hardware: `lpt', `mse', `psm', `sio', etc.
5566a8d6623SGarrett Wollman#
5576a8d6623SGarrett Wollman# lpt: printer port
5587fe369dcSJoerg Wunsch#	lpt specials:
5597fe369dcSJoerg Wunsch#		port can be specified as ?, this will cause the driver to scan
5607fe369dcSJoerg Wunsch#		the BIOS port list;
5617fe369dcSJoerg Wunsch#		the irq and vector clauses may be omitted, this
5627fe369dcSJoerg Wunsch#		will force the port into polling mode.
5636a8d6623SGarrett Wollman# mse: Logitech and ATI InPort bus mouse ports
5649cc34748SJordan K. Hubbard# psm: PS/2 mouse port [note: conflicts with sc0/vt0, thus "conflicts" keywd]
5656a8d6623SGarrett Wollman# sio: serial ports (see sio(4))
5666a8d6623SGarrett Wollman
5677fe369dcSJoerg Wunschdevice		lpt0	at isa? port? tty irq 7 vector lptintr
5687fe369dcSJoerg Wunschdevice		lpt1	at isa? port "IO_LPT3" tty irq 5 vector lptintr
5696a8d6623SGarrett Wollmandevice		mse0	at isa? port 0x23c tty irq 5 vector mseintr
5709cc34748SJordan K. Hubbarddevice		psm0	at isa? port "IO_KBD" conflicts tty irq 12 vector psmintr
571975c53c7SDoug Rabson# Options for psm:
572975c53c7SDoug Rabsonoptions		PSM_NO_RESET		#don't reset mouse hardware (some laptops)
573975c53c7SDoug Rabson
5746a8d6623SGarrett Wollmandevice		sio0	at isa? port "IO_COM1" tty irq 4 vector siointr
5756a8d6623SGarrett Wollman
5766a8d6623SGarrett Wollman# Options for sio:
5779ba0e7c3SBruce Evansoptions		COMCONSOLE		#prefer serial console to video console
578768fd661SBruce Evansoptions		COM_ESP			#code for Hayes ESP
5799ba0e7c3SBruce Evansoptions		COM_MULTIPORT		#code for some cards with shared IRQs
5806a8d6623SGarrett Wollmanoptions		DSI_SOFT_MODEM		#code for DSI Softmodems
581e5f2c8f6SPoul-Henning Kampoptions		BREAK_TO_DEBUGGER	#a BREAK on a comconsole goes to
582e5f2c8f6SPoul-Henning Kamp					#DDB, if available.
5836a8d6623SGarrett Wollman
5846a8d6623SGarrett Wollman#
58583401efaSGarrett Wollman# Network interfaces: `cx', `ed', `el', `ep', `ie', `is', `le', `lnc'
5866a8d6623SGarrett Wollman#
5876c5e9bbdSMike Pritchard# ar: Arnet SYNC/570i hdlc sync 2/4 port V.35/X.21 serial driver (requires sppp)
58883401efaSGarrett Wollman# cx: Cronyx/Sigma multiport sync/async (with Cisco or PPP framing)
5896a8d6623SGarrett Wollman# ed: Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
5906a8d6623SGarrett Wollman# el: 3Com 3C501 (slow!)
5916a8d6623SGarrett Wollman# ep: 3Com 3C509 (buggy)
5921a7c583cSGarrett Wollman# fe: Fujitsu MB86960A/MB86965A Ethernet
593d41f24e7SDavid Greenman# fea: DEC DEFEA EISA FDDI adapter
5946a8d6623SGarrett Wollman# ie: AT&T StarLAN 10 and EN100; 3Com 3C507; unknown NI5210
5956a8d6623SGarrett Wollman# le: Digital Equipment EtherWorks 2 and EtherWorks 3 (DEPCA, DE100,
5966a8d6623SGarrett Wollman#     DE101, DE200, DE201, DE202, DE203, DE204, DE205, DE422)
59794187a78SPaul Richards# lnc: Lance/PCnet cards (Isolan, Novell NE2100, NE32-VL)
598648c711bSPoul-Henning Kamp# ze: IBM/National Semiconductor PCMCIA ethernet controller.
599648c711bSPoul-Henning Kamp# zp: 3Com PCMCIA Etherlink III (It does not require shared memory for
600648c711bSPoul-Henning Kamp#     send/receive operation, but it needs 'iomem' to read/write the
601648c711bSPoul-Henning Kamp#     attribute memory)
6026a8d6623SGarrett Wollman#
6036a8d6623SGarrett Wollman
604e7c234a1SPeter Wemmdevice ar0 at isa? port 0x300 net irq 10 iomem 0xd0000 vector arintr
60583401efaSGarrett Wollmandevice cx0 at isa? port 0x240 net irq 15 drq 7 vector cxintr
6066a8d6623SGarrett Wollmandevice ed0 at isa? port 0x280 net irq 5 iomem 0xd8000 vector edintr
60712cfa436SPoul-Henning Kampdevice eg0 at isa? port 0x310 net irq 5 vector egintr
6086a8d6623SGarrett Wollmandevice el0 at isa? port 0x300 net irq 9 vector elintr
609d41f24e7SDavid Greenmandevice ep0 at isa? port 0x300 net irq 10 vector epintr
6101a7c583cSGarrett Wollmandevice fe0 at isa? port 0x240 net irq ? vector feintr
611d41f24e7SDavid Greenmandevice fea0 at isa? net irq ? vector feaintr
612d41f24e7SDavid Greenmandevice ie0 at isa? port 0x360 net irq 7 iomem 0xd0000 vector ieintr
613ad0c439aSRodney W. Grimesdevice ix0 at isa? port 0x300 net irq 10 iomem 0xd0000 iosiz 32768 vector ixintr
6146a8d6623SGarrett Wollmandevice le0 at isa? port 0x300 net irq 5 iomem 0xd0000 vector le_intr
61563373752SPoul-Henning Kampdevice lnc0 at isa? port 0x300 net irq 10 drq 0 vector lncintr
616ada9d061SJordan K. Hubbarddevice ze0 at isa? port 0x300 net irq 5 iomem 0xd8000 vector zeintr
617648c711bSPoul-Henning Kampdevice zp0 at isa? port 0x300 net irq 10 iomem 0xd8000 vector zpintr
618648c711bSPoul-Henning Kamp
619f4567b9cSJulian Elischer
6201a7c583cSGarrett Wollman#
6216f96f72bSJordan K. Hubbard# ISDN drivers - `isdn'.
6226f96f72bSJordan K. Hubbard#
6231a7c583cSGarrett Wollman# Uncomment one (and only one) of the following two drivers for the appropriate
6246f96f72bSJordan K. Hubbard# ISDN device you have.  For more information on what's considered appropriate
6256f96f72bSJordan K. Hubbard# for your given set of circumstances, please read
6263852c308SAndreas Schulz# /usr/src/gnu/usr.sbin/isdn/docs/INSTALL.  It's a bit sparse at present, but
6273852c308SAndreas Schulz# it's the best we have right now.  The snic driver is also disabled at present,
628a46a6df7SJordan K. Hubbard# waiting for someone to upgrade the driver to 2.0 (it's in /sys/gnu/scsi/).
629a46a6df7SJordan K. Hubbard#
6306f96f72bSJordan K. Hubbarddevice nic0 at isa? port "IO_COM3" iomem 0xe0000 tty irq 9 vector nicintr
6316f96f72bSJordan K. Hubbarddevice nnic0 at isa? port 0x150 iomem 0xe0000 tty irq 12 vector nnicintr
6326f96f72bSJordan K. Hubbard
6336a8d6623SGarrett Wollman#
6341a7c583cSGarrett Wollman# Audio drivers: `snd', `sb', `pas', `gus', `pca'
6356a8d6623SGarrett Wollman#
6361a7c583cSGarrett Wollman# snd: Voxware sound support code
6371a7c583cSGarrett Wollman# sb: SoundBlaster PCM - SoundBlaster, SB Pro, SB16, ProAudioSpectrum
6381a7c583cSGarrett Wollman# sbxvi: SoundBlaster 16
6391a7c583cSGarrett Wollman# sbmidi: SoundBlaster 16 MIDI interface
6401a7c583cSGarrett Wollman# pas: ProAudioSpectrum PCM and MIDI
6411a7c583cSGarrett Wollman# gus: Gravis Ultrasound - Ultrasound, Ultrasound 16, Ultrasound MAX
642a2048b9cSJordan K. Hubbard# gusxvi: Gravis Ultrasound 16-bit PCM	(do not use)
6431a7c583cSGarrett Wollman# mss: Microsoft Sound System
6441a7c583cSGarrett Wollman# opl: Yamaha OPL-2 and OPL-3 FM - SB, SB Pro, SB 16, ProAudioSpectrum
6451a7c583cSGarrett Wollman# uart: stand-alone 6850 UART for MIDI
6461a7c583cSGarrett Wollman# mpu: Roland MPU-401 stand-alone card
6471a7c583cSGarrett Wollman#
6481a7c583cSGarrett Wollman# Beware!  The addresses specified below are also hard-coded in
6491a7c583cSGarrett Wollman# i386/isa/sound/sound_config.h.  If you change the values here, you
6501a7c583cSGarrett Wollman# must also change the values in the include file.
6511a7c583cSGarrett Wollman#
6526a8d6623SGarrett Wollman# pca: PCM audio through your PC speaker
6536a8d6623SGarrett Wollman#
6549cc34748SJordan K. Hubbard# If you don't have a lpt0 device at IRQ 7, you can remove the
6559cc34748SJordan K. Hubbard# ``conflicts'' specification in the appropriate device entries below.
6569cc34748SJordan K. Hubbard#
657d1a599c2SJordan K. Hubbard# If you have a GUS-MAX card and want to use the CS4231 codec on the
658d1a599c2SJordan K. Hubbard# card the drqs for the gus max must be 8 bit (1, 2, or 3).
659d1a599c2SJordan K. Hubbard#
660d1a599c2SJordan K. Hubbard# If you would like to use the full duplex option on the gus, then define
661d1a599c2SJordan K. Hubbard# flags to be the ``read dma channel''.
662d1a599c2SJordan K. Hubbard#
663d1a599c2SJordan K. Hubbard# options BROKEN_BUS_CLOCK	#PAS-16 isn't working and OPTI chipset
664d1a599c2SJordan K. Hubbard# options SYMPHONY_PAS		#PAS-16 isn't working and SYMPHONY chipset
665d1a599c2SJordan K. Hubbard# options EXCLUDE_SBPRO		#PAS-16
666b1529bdaSPeter Wemm# options SBC_IRQ=5		#PAS-16. Must match irq on sb0 line.
667d1a599c2SJordan K. Hubbard# PAS16: The order of the pas0/sb0/opl0 is important since the
668d1a599c2SJordan K. Hubbard#	sb emulation is enabled in the pas-16 attach.
669d1a599c2SJordan K. Hubbard#
670d1a599c2SJordan K. Hubbard# The i386/isa/sound/sound.doc has more information.
671a2048b9cSJordan K. Hubbard
67212fd0853SSteven Wallace# Controls all sound devices
67312fd0853SSteven Wallacecontroller	snd0
674d1a599c2SJordan K. Hubbarddevice pas0     at isa? port 0x388 irq 10 drq 6 vector pasintr
6759cc34748SJordan K. Hubbarddevice sb0      at isa? port 0x220 irq 7 conflicts drq 1 vector sbintr
67612fd0853SSteven Wallacedevice sbxvi0   at isa? drq 5
6770264a8a9SJordan K. Hubbarddevice sbmidi0  at isa? port 0x330
6788e411548SJordan K. Hubbarddevice gus0 at isa? port 0x220 irq 12 drq 1 vector gusintr
6798e411548SJordan K. Hubbard#device gus0 at isa? port 0x220 irq 12 drq 1 flags 0x3 vector gusintr
68012fd0853SSteven Wallacedevice mss0 at isa? port 0x530 irq 10 drq 1 vector adintr
681d1a599c2SJordan K. Hubbarddevice opl0     at isa? port 0x388 conflicts
682a91ccb55SSteven Wallacedevice mpu0     at isa? port 0x330 irq 6 drq 0
68312fd0853SSteven Wallacedevice uart0 at isa? port 0x330 irq 5 vector "m6850intr"
6840897a95dSAndrey A. Chernov
68565e8111fSBruce Evans# More undocumented sound devices with bogus configurations for linting.
68665e8111fSBruce Evans# broken
68765e8111fSBruce Evans#device sscape0  at isa? port 0x330 irq 6 drq 0
68865e8111fSBruce Evans#device trix0    at isa? port 0x330 irq 6 drq 0 vector sscapeintr
68965e8111fSBruce Evans
6901a7c583cSGarrett Wollman# Not controlled by `snd'
691017e602cSAndrey A. Chernovdevice pca0 at isa? port IO_TIMER1 tty
6929ad380abSGarrett Wollman
6936a8d6623SGarrett Wollman#
694567e21c2SBruce Evans# Miscellaneous hardware:
6956a8d6623SGarrett Wollman#
6966a8d6623SGarrett Wollman# mcd: Mitsumi CD-ROM
6972d859864SAndreas Schulz# scd: Sony CD-ROM
69805e1d9d4SJordan K. Hubbard# matcd: Matsushita/Panasonic CD-ROM
6996a8d6623SGarrett Wollman# wt: Wangtek and Archive QIC-02/QIC-36 tape drives
7006a8d6623SGarrett Wollman# ctx: Cortex-I frame grabber
7016a8d6623SGarrett Wollman# apm: Laptop Advanced Power Management (experimental)
7026c5e9bbdSMike Pritchard# spigot: The Creative Labs Video Spigot video-acquisition board
7031d86961eSJordan K. Hubbard# meteor: Matrox Meteor video capture board
70465e8111fSBruce Evans# cy: Cyclades serial driver
705a50cd483SJordan K. Hubbard# dgb: Digiboard PC/Xi and PC/Xe series driver (ALPHA QUALITY!)
7061a7c583cSGarrett Wollman# gp:  National Instruments AT-GPIB and AT-GPIB/TNT board
707a800f455SJulian Elischer# asc: GI1904-based hand scanners, e.g. the Trust Amiscan Grey
7081a7c583cSGarrett Wollman# gsc: Genius GS-4500 hand scanner.
7091a7c583cSGarrett Wollman# joy: joystick
710657e73c4SPeter Dufault# labpc: National Instrument's Lab-PC and Lab-PC+
711d0930614SAndrey A. Chernov# rc: RISCom/8 multiport card
712567e21c2SBruce Evans# tw: TW-523 power line interface for use with X-10 home control products
7130d04cf6aSPeter Wemm# si: Specialix SI/XIO 4-32 port terminal multiplexor
714657e73c4SPeter Dufault
7156a8d6623SGarrett Wollman#
7162cd01159SJordan K. Hubbard# Notes on the spigot:
7172cd01159SJordan K. Hubbard#  The video spigot is at 0xad6.  This port address can not be changed.
7182cd01159SJordan K. Hubbard#  The irq values may only be 10, 11, or 15
7192cd01159SJordan K. Hubbard#  I/O memory is an 8kb region.  Possible values are:
7202cd01159SJordan K. Hubbard#    0a0000, 0a2000, ..., 0fffff, f00000, f02000, ..., ffffff
721d01b6680SJordan K. Hubbard#    The start address must be on an even boundary.
722d01b6680SJordan K. Hubbard#  Add the following option if you want to allow non-root users to be able
723d01b6680SJordan K. Hubbard#  to access the spigot.  This option is not secure because it allows users
724d01b6680SJordan K. Hubbard#  direct access to the I/O page.
725d01b6680SJordan K. Hubbard#  	options SPIGOT_UNSECURE
726d01b6680SJordan K. Hubbard#
7278819d6ecSPoul-Henning Kamp
728a50cd483SJordan K. Hubbard# Notes on the Digiboard driver:
729a50cd483SJordan K. Hubbard#
730a50cd483SJordan K. Hubbard# The following flag values have special meanings:
731a50cd483SJordan K. Hubbard#	0x01 - alternate layout of pins
732a50cd483SJordan K. Hubbard#	0x02 - use the windowed PC/Xe in 64K mode
7330d04cf6aSPeter Wemm
7340d04cf6aSPeter Wemm# Notes on the Specialix SI/XIO driver:
735c4823710SPeter Wemm#  **This is NOT a Specialix supported Driver!**
736c4823710SPeter Wemm#  The host card is memory, not IO mapped.
737c4823710SPeter Wemm#  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
738c4823710SPeter Wemm#  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
739c4823710SPeter Wemm#  The cards can use an IRQ of 11, 12 or 15.
740c4823710SPeter Wemm
7416a8d6623SGarrett Wollmandevice		mcd0	at isa? port 0x300 bio irq 10 vector mcdintr
74205e1d9d4SJordan K. Hubbard# for the Sony CDU31/33A CDROM
7432d859864SAndreas Schulzdevice		scd0	at isa? port 0x230 bio
7446c5e9bbdSMike Pritchard# for the SoundBlaster 16 multicd - up to 4 devices
7459720b084SJordan K. Hubbardcontroller      matcd0  at isa? port 0x230 bio
7466a8d6623SGarrett Wollmandevice		wt0	at isa? port 0x300 bio irq 5 drq 1 vector wtintr
7476a8d6623SGarrett Wollmandevice		ctx0	at isa? port 0x230 iomem 0xd0000
7482cd01159SJordan K. Hubbarddevice		spigot0 at isa? port 0xad6 irq 15 iomem 0xee000 vector spigintr
7494cf62360SPaul Trainadevice		qcam0	at isa? port "IO_LPT3" tty
7506a8d6623SGarrett Wollmandevice		apm0	at isa?
7511a7c583cSGarrett Wollmandevice		gp0	at isa? port 0x2c0 tty
7521a7c583cSGarrett Wollmandevice		gsc0	at isa? port "IO_GSC1" tty drq 3
7531a7c583cSGarrett Wollmandevice		joy0	at isa? port "IO_GAME"
75465e8111fSBruce Evansdevice		cy0	at isa? tty irq 10 iomem 0xd4000 iosiz 0x2000 vector cyintr
755a50cd483SJordan K. Hubbarddevice		dgb0	at isa? port 0x220 iomem 0xfc0000 iosiz ? tty
756657e73c4SPeter Dufaultdevice		labpc0	at isa? port 0x260 tty irq 5 vector labpcintr
757d0930614SAndrey A. Chernovdevice          rc0     at isa? port 0x220 tty irq 12 vector rcintr
758567e21c2SBruce Evans# the port and irq for tw0 are fictitious
759567e21c2SBruce Evansdevice          tw0     at isa? port 0x380 tty irq 11 vector twintr
760c4823710SPeter Wemmdevice		si0	at isa? iomem 0xd0000 tty irq 12 vector siintr
761a800f455SJulian Elischerdevice		asc0	at isa? port IO_ASC1 tty drq 3 irq 10 vector ascintr
76265e8111fSBruce Evansdevice		bqu0	at isa? port 0x150
763a800f455SJulian Elischer
764eeb706c0SJustin T. Gibbs#
765eeb706c0SJustin T. Gibbs# EISA devices:
766eeb706c0SJustin T. Gibbs#
767eeb706c0SJustin T. Gibbs# The EISA bus device is eisa0.  It provides auto-detection and
768eeb706c0SJustin T. Gibbs# configuration support for all devices on the EISA bus.
769eeb706c0SJustin T. Gibbs#
770e56e7036SJustin T. Gibbs# The `ahb' device provides support for the Adaptec 174X adapter.
771e56e7036SJustin T. Gibbs#
772eeb706c0SJustin T. Gibbs# The `ahc' device provides support for the Adaptec 274X and 284X
773eeb706c0SJustin T. Gibbs# adapters.  The 284X, although a VLB card responds to EISA probes.
774eeb706c0SJustin T. Gibbs#
775eeb706c0SJustin T. Gibbscontroller	eisa0
776e56e7036SJustin T. Gibbscontroller	ahb0
777eeb706c0SJustin T. Gibbscontroller	ahc0
7786a8d6623SGarrett Wollman
7796a8d6623SGarrett Wollman#
7806a8d6623SGarrett Wollman# PCI devices:
7816a8d6623SGarrett Wollman#
7826a8d6623SGarrett Wollman# The main PCI bus device is `pci'.  It provides auto-detection and
7836a8d6623SGarrett Wollman# configuration support for all devices on the PCI bus, using either
7846a8d6623SGarrett Wollman# configuration mode defined in the PCI specification.
7856a8d6623SGarrett Wollman#
786eeb706c0SJustin T. Gibbs# The `ahc' device provides support for the Adaptec 29/3940(U)(W)
787eeb706c0SJustin T. Gibbs# and motherboard based AIC7870/AIC7880 adapters.
788eeb706c0SJustin T. Gibbs#
7896a8d6623SGarrett Wollman# The `ncr' device provides support for the NCR 53C810 and 53C825
7906a8d6623SGarrett Wollman# self-contained SCSI host adapters.
7916a8d6623SGarrett Wollman#
7926a8d6623SGarrett Wollman# The `de' device provides support for the Digital Equipment DC21040
7936a8d6623SGarrett Wollman# self-contained Ethernet adapter.
7946a8d6623SGarrett Wollman#
7955ccfdea2SAndreas Schulz# The `vx' device provides support for the 3Com 3C590 and 3C595
796f4567b9cSJulian Elischer# early support
797f4567b9cSJulian Elischer#
798d41f24e7SDavid Greenman# The `fpa' device provides support for the Digital DEFPA PCI FDDI
799d41f24e7SDavid Greenman# adapter. pseudo-device fddi is also needed.
800d41f24e7SDavid Greenman#
8019ec2a4b3SStefan Eßer# The PROBE_VERBOSE option enables a long listing of chip set registers
8029ec2a4b3SStefan Eßer# for supported PCI chip sets (currently only intel Saturn and Mercury).
8039ec2a4b3SStefan Eßer#
8041d86961eSJordan K. Hubbard# The 'meteor' device is a PCI video capture board. It can also have the
8051d86961eSJordan K. Hubbard# following options:
806b1529bdaSPeter Wemm#   options METEOR_ALLOC_PAGES=xxx	preallocate kernel pages for data entry
8071d86961eSJordan K. Hubbard#	figure (ROWS*COLUMN*BYTES_PER_PIXEL*FRAME+PAGE_SIZE-1)/PAGE_SIZE
8081d86961eSJordan K. Hubbard#   options METEOR_DEALLOC_PAGES	remove all allocated pages on close(2)
809b1529bdaSPeter Wemm#   options METEOR_DEALLOC_ABOVE=xxx	remove all allocated pages above the
8101d86961eSJordan K. Hubbard#	specified amount. If this value is below the allocated amount no action
8111d86961eSJordan K. Hubbard#	taken
8121d86961eSJordan K. Hubbard#
8136a8d6623SGarrett Wollmancontroller	pci0
814eeb706c0SJustin T. Gibbscontroller	ahc1
8156a8d6623SGarrett Wollmandevice		ncr0
8166a8d6623SGarrett Wollmandevice		de0
81717acc2b2SDavid Greenmandevice		fxp0
8185ccfdea2SAndreas Schulzdevice		vx0
819d41f24e7SDavid Greenmandevice		fpa0
8201d86961eSJordan K. Hubbarddevice		meteor0
8219ec2a4b3SStefan Eßeroptions		PROBE_VERBOSE
822446cee6eSJoerg Wunsch
823dc9deb29SPoul-Henning Kamp
824dc9deb29SPoul-Henning Kamp#
825dc9deb29SPoul-Henning Kamp# PCCARD/PCMCIA
826dc9deb29SPoul-Henning Kamp#
827dc9deb29SPoul-Henning Kampcontroller	crd0
828dc9deb29SPoul-Henning Kampcontroller	pcic0 at crd?
829dc9deb29SPoul-Henning Kamp
830446cee6eSJoerg Wunsch#
831446cee6eSJoerg Wunsch# Laptop/Notebook options:
832446cee6eSJoerg Wunsch#
833446cee6eSJoerg Wunsch# See also:
8346c5e9bbdSMike Pritchard#  apm under `Miscellaneous hardware'
835446cee6eSJoerg Wunsch#  options		PSM_NO_RESET  for the `psm' driver
836446cee6eSJoerg Wunsch# above.
837446cee6eSJoerg Wunsch
838446cee6eSJoerg Wunsch# For older notebooks that signal a powerfail condition (external
839446cee6eSJoerg Wunsch# power supply dropped, or battery state low) by issuing an NMI:
840446cee6eSJoerg Wunsch
841446cee6eSJoerg Wunschoptions		POWERFAIL_NMI	# make it beep instead of panicing
84265e8111fSBruce Evans
84365e8111fSBruce Evans# More undocumented options for linting.
84494c94804SBruce Evans
845c6bbb6d1SBruce Evansoptions		APM_SLOWSTART=1
84665e8111fSBruce Evansoptions		COMPAT_LINUX
847439187deSBruce Evansoptions		DEBUG
84894c94804SBruce Evansoptions		"EXT2FS"
84965e8111fSBruce Evansoptions		"IBCS2"
850526eacf6SBruce Evansoptions		LINUX
851c01db44aSBruce Evansoptions		"SCSI_2_DEF"
852b1529bdaSPeter Wemmoptions		SHOW_BUSYBUFS	# List buffers that prevent root unmount
853