xref: /freebsd/sys/conf/NOTES (revision 94c948049a244f1c3aa876c19d1eb48cc5ee3cf3)
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#
594c94804SBruce Evans#	$Id: LINT,v 1.219 1995/12/10 10:50:32 julian 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)
232365e64fSRodney W. Grimes
246a8d6623SGarrett Wollman#
256a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
266a8d6623SGarrett Wollman# be the same as the name of your kernel.
276a8d6623SGarrett Wollman#
286a8d6623SGarrett Wollmanident		LINT
296a8d6623SGarrett Wollman
306a8d6623SGarrett Wollman#
316a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
326a8d6623SGarrett Wollman# internal system tables by a complicated formula defined in param.c.
336a8d6623SGarrett Wollman#
346a8d6623SGarrett Wollmanmaxusers	10
356a8d6623SGarrett Wollman
366a8d6623SGarrett Wollman#
37663afbc3SScott Mace# Under some circumstances it is necessary to make the default max
38f73bbaf2SDavid Greenman# number of processes per user and open files per user more than the
39663afbc3SScott Mace# defaults on bootup.  (an example is a large news server in which
400f700bfdSJoerg Wunsch# the uid, news, can sometimes need > 100 simultaneous processes running,
410f700bfdSJoerg Wunsch# or perhaps a user using lots of windows under X).
42663afbc3SScott Maceoptions		"CHILD_MAX=128"
43663afbc3SScott Maceoptions		"OPEN_MAX=128"
44663afbc3SScott Mace
45663afbc3SScott Mace#
466a8d6623SGarrett Wollman# A math emulator is mandatory if you wish to run on hardware which
476a8d6623SGarrett Wollman# does not have a floating-point processor.  Pick either the original,
486a8d6623SGarrett Wollman# bogus (but freely-distributable) math emulator, or a much more
496a8d6623SGarrett Wollman# fully-featured but GPL-licensed emulator taken from Linux.
506a8d6623SGarrett Wollman#
516a8d6623SGarrett Wollmanoptions		MATH_EMULATE		#Support for x87 emulation
5294c94804SBruce Evans# Don't enable both of these in a real config.
5394c94804SBruce Evansoptions		GPL_MATH_EMULATE	#Support for x87 emualtion via
54cfecaf32SGary Clark II					#new math emulator
55cfecaf32SGary Clark II
566a8d6623SGarrett Wollman#
576a8d6623SGarrett Wollman# This directive defines a number of things:
586a8d6623SGarrett Wollman#  - The compiled kernel is to be called `kernel'
596a8d6623SGarrett Wollman#  - The root filesystem might be on partition wd0a
60b8e91dabSDavid Greenman#  - Crash dumps will be written to wd0b, if possible.  Specifying the
61b8e91dabSDavid Greenman#    dump device here is not recommended.  Use dumpon(8).
626a8d6623SGarrett Wollman#
63b8e91dabSDavid Greenmanconfig		kernel	root on wd0 dumps on wd0
642365e64fSRodney W. Grimes
656a8d6623SGarrett Wollman
666a8d6623SGarrett Wollman#####################################################################
676a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
68690f540cSAndrey A. Chernov
696a8d6623SGarrett Wollman#
706a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
716a8d6623SGarrett Wollman# FreeBSD.
726a8d6623SGarrett Wollman#
736a8d6623SGarrett Wollmanoptions		"COMPAT_43"
746a8d6623SGarrett Wollman
756a8d6623SGarrett Wollman#
766a8d6623SGarrett Wollman# Allow user-mode programs to manipulat their local descriptor tables.
776a8d6623SGarrett Wollman# This option is required for the WINE Windows(tm) emulator, and is
786a8d6623SGarrett Wollman# not used by anything else (that we know of).
796a8d6623SGarrett Wollman#
806a8d6623SGarrett Wollmanoptions		USER_LDT		#allow user-level control of i386 ldt
816a8d6623SGarrett Wollman
826a8d6623SGarrett Wollman#
836a8d6623SGarrett Wollman# These three options provide support for System V Interface
846a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
856a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
866a8d6623SGarrett Wollman#
876a8d6623SGarrett Wollmanoptions		SYSVSHM
886a8d6623SGarrett Wollmanoptions		SYSVSEM
896a8d6623SGarrett Wollmanoptions		SYSVMSG
906a8d6623SGarrett Wollman
916a8d6623SGarrett Wollman
926a8d6623SGarrett Wollman#####################################################################
936a8d6623SGarrett Wollman# DEBUGGING OPTIONS
946a8d6623SGarrett Wollman
956a8d6623SGarrett Wollman#
96b5d89ca8SBruce Evans# Enable the kernel debugger.
976a8d6623SGarrett Wollman#
98b5d89ca8SBruce Evansoptions		DDB
99b5d89ca8SBruce Evans
100b5d89ca8SBruce Evans#
1016a8d6623SGarrett Wollman# KTRACE enables the system-call tracing facility ktrace(2).
1026a8d6623SGarrett Wollman#
1032365e64fSRodney W. Grimesoptions		KTRACE			#kernel tracing
10421c64a07SAndrey A. Chernov
1056a8d6623SGarrett Wollman#
1066a8d6623SGarrett Wollman# The DIAGNOSTIC option is used in a number of source files to enable
1076a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
1086a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
1096a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
1106a8d6623SGarrett Wollman# programming errors.
1116a8d6623SGarrett Wollman#
1120dc7d907SPoul-Henning Kampoptions		DIAGNOSTIC
113da59a31cSDavid Greenman
1140dd1eea1SJordan K. Hubbard#
1150dd1eea1SJordan K. Hubbard# Allow ordinary users to take the console - this is useful for X.
1160dd1eea1SJordan K. Hubbardoptions		UCONSOLE
1170dd1eea1SJordan K. Hubbard
1186a8d6623SGarrett Wollman
1196a8d6623SGarrett Wollman#####################################################################
1206a8d6623SGarrett Wollman# NETWORKING OPTIONS
12170c0b54cSAndrey A. Chernov
1226a8d6623SGarrett Wollman#
1236a8d6623SGarrett Wollman# Protocol families:
1246a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
1256a8d6623SGarrett Wollman#  Source code for the NS (Xerox Network Service), ISO (OSI), and
1266a8d6623SGarrett Wollman#  CCITT (X.25) families is provided for amusement value, although we
1276a8d6623SGarrett Wollman#  try to ensure that it actually compiles.
1286a8d6623SGarrett Wollman#
1296a8d6623SGarrett Wollmanoptions		INET			#Internet communications protocols
1306a8d6623SGarrett Wollmanoptions		CCITT			#X.25 network layer
1316a8d6623SGarrett Wollmanoptions		NS			#Xerox NS communications protocols
132f73bbaf2SDavid Greenman
133cc6a66f2SJulian Elischeroptions		IPX			#IPX/SPX communications protocols
134cc6a66f2SJulian Elischeroptions		IPXIP			#IPX in IP encapsulation (not available)
135cc6a66f2SJulian Elischeroptions		IPTUNNEL		#IP in IPX encapsulation (not available)
1361b3f472eSJulian Elischeroptions		"IPXPRINTFS=0"		#IPX/SPX Console Debugging Information
1371b3f472eSJulian Elischeroptions		"IPX_ERRPRINTFS=0"	#IPX/SPX Console Debugging Information
138cc6a66f2SJulian Elischer
139f73bbaf2SDavid Greenman# These are currently broken and don't compile
140f73bbaf2SDavid Greenman#options		ISO
141f73bbaf2SDavid Greenman#options		TPIP			#ISO TP class 4 over IP
142f73bbaf2SDavid Greenman#options		TPCONS			#ISO TP class 0 over X.25
14363a74862SSteven Wallace
1446a8d6623SGarrett Wollman#
1456a8d6623SGarrett Wollman# Network interfaces:
1466a8d6623SGarrett Wollman#  The `loop' pseudo-device is mandatory when networking is enabled.
1476a8d6623SGarrett Wollman#  The `ether' pseudo-device provides generic code to handle
1486a8d6623SGarrett Wollman#  Ethernets; it is mandatory when a Ethernet device driver is
1496a8d6623SGarrett Wollman#  configured.
150d41f24e7SDavid Greenman#  The 'fddi' pseudo-device provides generic code to support FDDI.
15183401efaSGarrett Wollman#  The `sppp' pseudo-device serves a similar role for certain types
152e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
1536a8d6623SGarrett Wollman#  The `sl' pseudo-device implements the Serial Line IP (SLIP) service.
1546a8d6623SGarrett Wollman#  The `ppp' pseudo-device implements the Point-to-Point Protocol.
155d29895dcSGarrett Wollman#  The `bpfilter' pseudo-device enables the Berkeley Packet Filter.  Be
156d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
157d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
158d29895dcSGarrett Wollman#  simultaneous BPF clients programs runnable.
15959d8d13fSGarrett Wollman#  The `disc' pseudo-device implements a minimal network interface,
16059d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
16159d8d13fSGarrett Wollman#  included for testing purposes.
162b60d4a5dSAtsushi Murai#  The `tun' pseudo-device implements the User Process PPP (iijppp)
1636a8d6623SGarrett Wollman#
1646a8d6623SGarrett Wollmanpseudo-device	ether			#Generic Ethernet
165d41f24e7SDavid Greenmanpseudo-device	fddi			#Generic FDDI
16683401efaSGarrett Wollmanpseudo-device	sppp			#Generic Synchronous PPP
1676a8d6623SGarrett Wollmanpseudo-device	loop			#Network loopback device
1686a8d6623SGarrett Wollmanpseudo-device	sl	2		#Serial Line IP
1696a8d6623SGarrett Wollmanpseudo-device	ppp	2		#Point-to-point protocol
170d29895dcSGarrett Wollmanpseudo-device	bpfilter	4	#Berkeley packet filter
17159d8d13fSGarrett Wollmanpseudo-device	disc			#Discard device
1722d3f9865SAtsushi Muraipseudo-device	tun	1		#Tunnel driver(user process ppp)
173d29895dcSGarrett Wollman
1746a8d6623SGarrett Wollmanoptions		NSIP			#XNS over IP
1756a8d6623SGarrett Wollmanoptions		LLC			#X.25 link layer for Ethernets
1766a8d6623SGarrett Wollmanoptions		HDLC			#X.25 link layer for serial lines
1776a8d6623SGarrett Wollman
178f73bbaf2SDavid Greenman# broken
179f73bbaf2SDavid Greenman#options		EON			#ISO CLNP over IP
180f73bbaf2SDavid Greenman
1816a8d6623SGarrett Wollman#
1826a8d6623SGarrett Wollman# Internet family options:
1836a8d6623SGarrett Wollman#
1846a8d6623SGarrett Wollman# TCP_COMPAT_42 causes the TCP code to emulate certain bugs present in
1856a8d6623SGarrett Wollman# 4.2BSD.  This option should not be used unless you have a 4.2BSD
1866a8d6623SGarrett Wollman# machine and TCP connections fail.
1876a8d6623SGarrett Wollman#
1886a8d6623SGarrett Wollman# GATEWAY allows the machine to forward packets, and also configures
1896a8d6623SGarrett Wollman# larger static sizes of a number of system tables.
1906a8d6623SGarrett Wollman#
1916a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
1926a8d6623SGarrett Wollman# with mrouted(8).
1936a8d6623SGarrett Wollman#
194d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
195d29895dcSGarrett Wollman# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE does
196d29895dcSGarrett Wollman# the obvious thing.
1977332d95aSUgen J.S. Antsilevich# IPACCT enables IP accounting.
198d29895dcSGarrett Wollman#
19965e8111fSBruce Evans# TCPDEBUG is undocumented.
20065e8111fSBruce Evans#
2016a8d6623SGarrett Wollmanoptions		"TCP_COMPAT_42"		#emulate 4.2BSD TCP bugs
2026a8d6623SGarrett Wollmanoptions		GATEWAY			#internetwork gateway
203e3178a06SJordan K. Hubbardoptions		MROUTING		# Multicast routing
204d29895dcSGarrett Wollmanoptions         IPFIREWALL              #firewall
205d29895dcSGarrett Wollmanoptions         IPFIREWALL_VERBOSE      #print information about
2067332d95aSUgen J.S. Antsilevichoptions		IPACCT			#ipaccounting
207d29895dcSGarrett Wollman					# dropped packets
20865e8111fSBruce Evansoptions		TCPDEBUG
2096a8d6623SGarrett Wollman
2106a8d6623SGarrett Wollman
2116a8d6623SGarrett Wollman#####################################################################
2126a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
213e3178a06SJordan K. Hubbard
2142365e64fSRodney W. Grimes#
2156a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
2166a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
2176a8d6623SGarrett Wollman# time.  (Exception: the UFS family---FFS, MFS, and LFS---cannot
2186a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
2196a8d6623SGarrett Wollman# compile other filesystems as well.
2206a8d6623SGarrett Wollman#
2216a8d6623SGarrett Wollman# NB: The LFS, PORTAL, and UNION filesystems are known to be buggy,
2226a8d6623SGarrett Wollman# and WILL panic your system if you attempt to do anything with them.
2236a8d6623SGarrett Wollman# They are included here as an incentive for some enterprising soul to
2246a8d6623SGarrett Wollman# sit down and fix them.
2252365e64fSRodney W. Grimes#
226e5e60905SDavid Greenman# Note: 4.4BSD NQNFS lease checking has relatively high cost for
227e5e60905SDavid Greenman# _local_ I/O as well as remote I/O. Don't use it unless you will
228e5e60905SDavid Greenman# using NQNFS.
229e5e60905SDavid Greenman#
230f1a9c715SDavid Greenman
2316a8d6623SGarrett Wollman# One of these is mandatory:
2326a8d6623SGarrett Wollmanoptions		FFS			#Fast filesystem
2336a8d6623SGarrett Wollmanoptions		NFS			#Network File System
2346a8d6623SGarrett Wollman
2356a8d6623SGarrett Wollman# The rest are optional:
236e5e60905SDavid Greenmanoptions		NQNFS			#Enable NQNFS lease checking
237f1a9c715SDavid Greenmanoptions		"CD9660"		#ISO 9660 filesystem
238f1a9c715SDavid Greenmanoptions		FDESC			#File descriptor filesystem
239f1a9c715SDavid Greenmanoptions		KERNFS			#Kernel filesystem
240f1a9c715SDavid Greenmanoptions		LFS			#Log filesystem
241f1a9c715SDavid Greenmanoptions		MFS			#Memory File System
2423f9a6982SDoug Rabsonoptions		MSDOSFS			#MS DOS File System
243f1a9c715SDavid Greenmanoptions		NULLFS			#NULL filesystem
244f1a9c715SDavid Greenmanoptions		PORTAL			#Portal filesystem
245f1a9c715SDavid Greenmanoptions		PROCFS			#Process filesystem
246f1a9c715SDavid Greenmanoptions		UMAPFS			#UID map filesystem
247f1a9c715SDavid Greenmanoptions		UNION			#Union filesystem
24846746c3bSJulian Elischer# THis DEVFS is experimental but seems to work
24946746c3bSJulian Elischeroptions		DEVFS			#devices filesystem
250f1a9c715SDavid Greenman
251d52d7365SPoul-Henning Kamp# Make space in the kernel for a MFS rootfilesystem.  Define to the number
252d52d7365SPoul-Henning Kamp# of kilobytes to reserve for the filesystem.
253d52d7365SPoul-Henning Kampoptions		"MFS_ROOT=10"
254d52d7365SPoul-Henning Kamp
255a401ebbeSDavid Greenman# Allow this many swap-devices.
256a401ebbeSDavid Greenmanoptions		"NSWAPDEV=20"
257a401ebbeSDavid Greenman
2586a8d6623SGarrett Wollman# Disk quotas are supported when this option is enabled.  If you
2596a8d6623SGarrett Wollman# change the value of this option, you must do a `make clean' in your
2606a8d6623SGarrett Wollman# kernel compile directory in order to get a working kernel.
2616a8d6623SGarrett Wollman#
2622365e64fSRodney W. Grimesoptions		QUOTA			#enable disk quotas
2636a8d6623SGarrett Wollman
2646a8d6623SGarrett Wollman
2656a8d6623SGarrett Wollman#####################################################################
266de6a307eSPeter Dufault# SCSI DEVICES
267de6a307eSPeter Dufault
2686a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
2696a8d6623SGarrett Wollman
2706a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
271ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
2726a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
2736a8d6623SGarrett Wollman# device configuration sections below.
2746a8d6623SGarrett Wollman#
275265368d4SRodney W. Grimes# Beginning with FreeBSD 2.0.5 you can wire down your SCSI devices so
276ebc1a0e2SPeter Dufault# that a given bus, target, and LUN always come on line as the same
277ebc1a0e2SPeter Dufault# device unit.  In earlier versions the unit numbers were assigned
278ebc1a0e2SPeter Dufault# in the order that the devices were probed on the SCSI bus.  This
279ebc1a0e2SPeter Dufault# means that if you removed a disk drive, you may have had to rewrite
280ebc1a0e2SPeter Dufault# your /etc/fstab file, and also that you had to be careful when adding
281ebc1a0e2SPeter Dufault# a new disk as it may have been probed earlier and moved your device
282ebc1a0e2SPeter Dufault# configuration around.
283ebc1a0e2SPeter Dufault
284ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
285ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
286ebc1a0e2SPeter Dufault# type.  For example, if you wire a disk as "sd3" then the first
287ebc1a0e2SPeter Dufault# non-wired disk will be assigned sd4.
288ebc1a0e2SPeter Dufault
289ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
290ebc1a0e2SPeter Dufault
2914fbaf9a7SJustin T. Gibbs# controller	scbus0 at ahc0		# Single bus device
2924fbaf9a7SJustin T. Gibbs# controller	scbus1 at ahc1 bus 0	# Single bus device
2934fbaf9a7SJustin T. Gibbs# controller	scbus3 at ahc2 bus 0	# Twin bus device
2944fbaf9a7SJustin T. Gibbs# controller	scbus2 at ahc2 bus 1	# Twin bus device
295ebc1a0e2SPeter Dufault# disk 		sd0 at scbus0 target 0 unit 0
2964fbaf9a7SJustin T. Gibbs# disk		sd1 at scbus3 target 1
2974fbaf9a7SJustin T. Gibbs# disk		sd2 at scbus2 target 3
2984fbaf9a7SJustin T. Gibbs# tape		st1 at scbus1 target 6
299ebc1a0e2SPeter Dufault# device	cd0 at scbus?
300ebc1a0e2SPeter Dufault
301ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
302ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
303ebc1a0e2SPeter Dufault
304ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
305ebc1a0e2SPeter Dufault
306265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
307ebc1a0e2SPeter Dufault# configuration and doesn't have to be explicitly configured.
308ebc1a0e2SPeter Dufault
3096a8d6623SGarrett Wollmancontroller	scbus0	#base SCSI code
3106a8d6623SGarrett Wollmandevice		ch0	#SCSI media changers
3116a8d6623SGarrett Wollmandevice		sd0	#SCSI disks
3126a8d6623SGarrett Wollmandevice		st0	#SCSI tapes
3136a8d6623SGarrett Wollmandevice		cd0	#SCSI CD-ROMs
31449bdb5b8SJoerg Wunschdevice		od0	#SCSI optical disk
3156a8d6623SGarrett Wollman
316265368d4SRodney W. Grimes# The previous devices (ch, sd, st, cd) are recognized by config.
317265368d4SRodney W. Grimes# config doesn't (and shouldn't) know about these newer ones,
318265368d4SRodney W. Grimes# so we have to specify that they are on a SCSI bus with the "at scbus?"
319265368d4SRodney W. Grimes# clause.
320265368d4SRodney W. Grimes
3218909a72bSPeter Dufaultdevice worm0 at scbus?	# SCSI worm
3228909a72bSPeter Dufaultdevice pt0 at scbus?	# SCSI processor type
3238909a72bSPeter Dufaultdevice sctarg0 at scbus? # SCSI target
3248909a72bSPeter Dufault
3251a7c583cSGarrett Wollman# SCSI OPTIONS:
3261a7c583cSGarrett Wollman
3271a7c583cSGarrett Wollman# SCSIDEBUG: When defined enables debugging macros
3281a7c583cSGarrett Wollman# NO_SCSI_SENSE: When defined disables sense descriptions (about 4k)
3291a7c583cSGarrett Wollman# SCSI_REPORT_GEOMETRY: Always report disk geometry at boot up instead
330265368d4SRodney W. Grimes#                       of only when booting verbosely.
3311a7c583cSGarrett Wollmanoptions		SCSIDEBUG
3321a7c583cSGarrett Wollman#options	NO_SCSI_SENSE
3331a7c583cSGarrett Wollmanoptions		SCSI_REPORT_GEOMETRY
3341a7c583cSGarrett Wollman
3356a8d6623SGarrett Wollman
3366a8d6623SGarrett Wollman#####################################################################
3376a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
3386a8d6623SGarrett Wollman
3392365e64fSRodney W. Grimes#
3406a8d6623SGarrett Wollman# Of these, only the `log' device is truly mandatory.  The `pty'
3416a8d6623SGarrett Wollman# device usually turns out to be ``effectively mandatory'', as it is
3426a8d6623SGarrett Wollman# required for `telnetd', `rlogind', `screen', `emacs', and `xterm',
3431a7c583cSGarrett Wollman# among others.  The `isdn', `ii', `ity', `itel', and `ispy' devices
3441a7c583cSGarrett Wollman# are all required when ISDN support is used.
3456a8d6623SGarrett Wollman#
3469da6a15aSJordan K. Hubbardpseudo-device	pty	16	#Pseudo ttys - can go as high as 64
3476a8d6623SGarrett Wollmanpseudo-device	speaker		#Play IBM BASIC-style noises out your speaker
3486a8d6623SGarrett Wollmanpseudo-device	log		#Kernel syslog interface (/dev/klog)
3496a8d6623SGarrett Wollmanpseudo-device	gzip		#Exec gzipped a.out's
350784cf072SPoul-Henning Kamppseudo-device	vn		#Vnode driver (turns a file into a device)
3514cba4555SUgen J.S. Antsilevichpseudo-device	snp	3	#Snoop device - to look at pty/vty/etc..
3529ba0e7c3SBruce Evans
3531a7c583cSGarrett Wollman# These are non-optional for ISDN
3541a7c583cSGarrett Wollmanpseudo-device   isdn
3551a7c583cSGarrett Wollmanpseudo-device   ii      4
3561a7c583cSGarrett Wollmanpseudo-device   ity     4
3571a7c583cSGarrett Wollmanpseudo-device   itel    2
3581a7c583cSGarrett Wollmanpseudo-device   ispy    1
3591a7c583cSGarrett Wollman
36065e8111fSBruce Evans# These are only for watching for bitrot in old tty code.
36165e8111fSBruce Evans# broken
36265e8111fSBruce Evans#pseudo-device	tb
36365e8111fSBruce Evans
36465e8111fSBruce Evans# These are only for watching for bitrot in old SCSI code.
36565e8111fSBruce Evanspseudo-device	su		#scsi user
36665e8111fSBruce Evanspseudo-device	ssc		#super scsi
36765e8111fSBruce Evans
3686a8d6623SGarrett Wollman
3696a8d6623SGarrett Wollman#####################################################################
3706a8d6623SGarrett Wollman# HARDWARE DEVICE CONFIGURATION
3716a8d6623SGarrett Wollman
3726a8d6623SGarrett Wollman# ISA and EISA devices:
3736a8d6623SGarrett Wollman# Currently there is no separate support for EISA.  There should be.
3746a8d6623SGarrett Wollman# Micro Channel is not supported at all.
3756a8d6623SGarrett Wollman
3766a8d6623SGarrett Wollman#
3771a7c583cSGarrett Wollman# Mandatory ISA devices: isa, sc or vt, npx
3786a8d6623SGarrett Wollman#
3792365e64fSRodney W. Grimescontroller	isa0
3802365e64fSRodney W. Grimes
3816a8d6623SGarrett Wollman#
3826a8d6623SGarrett Wollman# Options for `isa':
3836a8d6623SGarrett Wollman#
3849ba0e7c3SBruce Evans# AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A
3859ba0e7c3SBruce Evans# interrupt controller.  This saves about 1.25 usec for each interrupt.
3869ba0e7c3SBruce Evans# No problems are known to be caused by this option.
3879ba0e7c3SBruce Evans#
3889ba0e7c3SBruce Evans# AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A
3899ba0e7c3SBruce Evans# interrupt controller.  This saves about 1.25 usec for each interrupt.
3909ba0e7c3SBruce Evans# Automatic EOI is documented not to work for for the slave with the
3919ba0e7c3SBruce Evans# original i8259A, but it works for some clones and some integrated
3929ba0e7c3SBruce Evans# versions.
3939ba0e7c3SBruce Evans#
3946a8d6623SGarrett Wollman# BOUNCE_BUFFERS provides support for ISA DMA on machines with more
3956a8d6623SGarrett Wollman# than 16 megabytes of memory.  It doesn't hurt on other machines.
3966a8d6623SGarrett Wollman# Some broken EISA and VLB hardware may need this, too.
3973339606dSAndreas Schulz#
3989ba0e7c3SBruce Evans# DUMMY_NOPS disables extra delays for some bus operations.  The delays
3999ba0e7c3SBruce Evans# are mostly for older systems and aren't used consistently.  Probably
4009ba0e7c3SBruce Evans# works OK on most EISA bus machines.
4013339606dSAndreas Schulz#
4023339606dSAndreas Schulz# TUNE_1542 enables the automatic ISA bus speed selection for the
4033339606dSAndreas Schulz# Adaptec 1542 boards. Does not work for all boards, use it with caution.
4043339606dSAndreas Schulz#
4055eb46edfSDavid Greenman# BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
4065eb46edfSDavid Greenman# reset the CPU for reboot.  This is needed on some systems with broken
4075eb46edfSDavid Greenman# keyboard controllers.
4089ba0e7c3SBruce Evansoptions		"AUTO_EOI_1"
4099ba0e7c3SBruce Evans#options	"AUTO_EOI_2"
4106a8d6623SGarrett Wollmanoptions		BOUNCE_BUFFERS
4113339606dSAndreas Schulz#options	DUMMY_NOPS
412b6b8f81eSAndrey A. Chernov#options        "TUNE_1542"
4135eb46edfSDavid Greenman#options	"BROKEN_KEYBOARD_RESET"
4143af6b652SDavid Greenman
4154530be52SJordan K. Hubbard# Enable this and PCVT_FREEBSD for pcvt vt220 compatible console driver
4167fbcd76bSBruce Evansdevice		vt0	at isa? port "IO_KBD" tty irq 1 vector pcrint
41794c94804SBruce Evansoptions		"PCVT_FREEBSD=210"	# pcvt running on FreeBSD >= 2.0.5
4187fbcd76bSBruce Evansoptions		XSERVER			# include code for XFree86
4197fbcd76bSBruce Evansoptions		FAT_CURSOR		# start with block cursor
420e9aaac99SNate Williams# This PCVT option is for keyboards such as those used on IBM ThinkPad laptops
421e9aaac99SNate Williamsoptions		"PCVT_SCANSET=2" 	# IBM keyboards are non-std
4224530be52SJordan K. Hubbard
4234530be52SJordan K. Hubbard# The syscons console driver (sco color console compatible) - default.
4246a8d6623SGarrett Wollmandevice		sc0	at isa? port "IO_KBD" tty irq 1 vector scintr
4252ac8be82SAndreas Schulz
4266a8d6623SGarrett Wollman#
4276a8d6623SGarrett Wollman# Options for `sc':
4286a8d6623SGarrett Wollman#
4296a8d6623SGarrett Wollman# HARDFONTS allows the driver to load an ISO-8859-1 font to replace
4306a8d6623SGarrett Wollman# the default font in your display adapter's memory.
4316a8d6623SGarrett Wollman#
4326a8d6623SGarrett Wollmanoptions		HARDFONTS
43389d8fc79SAndrey A. Chernov#
43489d8fc79SAndrey A. Chernov# MAXCONS is maximum number of virtual consoles, no more than 16
43598886235SAndrey A. Chernov# default value: 12
43689d8fc79SAndrey A. Chernov#
43789d8fc79SAndrey A. Chernovoptions         "MAXCONS=16"
43832128f4cSDavid Greenman
43998e9e66cSNate Williams#
44098e9e66cSNate Williams# This device is mandatory.
44198e9e66cSNate Williams#
44298e9e66cSNate Williams# The Numeric Processing eXtension is used to either enable the
44398e9e66cSNate Williams# coprocessor or enable math emulation.  If your machine doesn't contain
44498e9e66cSNate Williams# a math co-processor, you must *also* add the option "MATH_EMULATE".
44546746c3bSJulian Elischer# THIS IS NOT AN OPTIONAL ENTRY, DO NOT REMOVE IT
44698e9e66cSNate Williams#
4472365e64fSRodney W. Grimesdevice		npx0	at isa? port "IO_NPX" irq 13 vector npxintr
4486a8d6623SGarrett Wollman
4496a8d6623SGarrett Wollman#
4506a8d6623SGarrett Wollman# Optional ISA and EISA devices:
4516a8d6623SGarrett Wollman#
4526a8d6623SGarrett Wollman
4536a8d6623SGarrett Wollman#
454e56e7036SJustin T. Gibbs# SCSI host adapters: `aha', `aic', `bt', `nca'
4556a8d6623SGarrett Wollman#
4566a8d6623SGarrett Wollman# aha: Adaptec 154x
4579829c3edSJordan K. Hubbard# ahc: Adaptec 274x/284x/294x
4586a8d6623SGarrett Wollman# aic: Adaptec 152x and sound cards using the Adaptec AIC-6360 (slow!)
4596a8d6623SGarrett Wollman# bt: Most Buslogic controllers
460e05407d8SPoul-Henning Kamp# nca: ProAudioSpectrum cards using the NCR 5380 or Trantor T130
4616a8d6623SGarrett Wollman# uha: UltraStore 14F and 34F
4623c43212aSSøren Schmidt# sea: Seagate ST01/02 8 bit controller (slow!)
4633691d2b9SJordan K. Hubbard# wds: Western Digital WD7000 controller (no scatter/gather!).
4646a8d6623SGarrett Wollman#
4656a8d6623SGarrett Wollman# Note that the order is important in order for Buslogic cards to be
4666a8d6623SGarrett Wollman# probed correctly.
4676a8d6623SGarrett Wollman#
4686a8d6623SGarrett Wollman
4696a8d6623SGarrett Wollmancontroller	bt0	at isa? port "IO_BT0" bio irq ? vector btintr
4706a8d6623SGarrett Wollmancontroller	aha0	at isa? port "IO_AHA0" bio irq ? drq 5 vector ahaintr
4716a8d6623SGarrett Wollmancontroller	uha0	at isa? port "IO_UHA0" bio irq ? drq 5 vector uhaintr
4726a8d6623SGarrett Wollman
4736a8d6623SGarrett Wollmancontroller      aic0    at isa? port 0x340 bio irq 11 vector aicintr
474e05407d8SPoul-Henning Kampcontroller	nca0	at isa? port 0x1f88 bio irq 10 vector ncaintr
475e05407d8SPoul-Henning Kampcontroller	nca1	at isa? port 0x1f84
476e05407d8SPoul-Henning Kampcontroller	nca2	at isa? port 0x1f8c
477e05407d8SPoul-Henning Kampcontroller	nca3	at isa? port 0x1e88
478e05407d8SPoul-Henning Kampcontroller	nca4	at isa? port 0x350 bio irq 5 vector ncaintr
47945b4c36fSJordan K. Hubbard
4803c43212aSSøren Schmidtcontroller	sea0	at isa? bio irq 5 iomem 0xdc000 iosiz 0x2000 vector seaintr
4813691d2b9SJordan K. Hubbardcontroller	wds0	at isa? port 0x350 bio irq 15 drq 6 vector wdsintr
4823c43212aSSøren Schmidt
4836a8d6623SGarrett Wollman#
4846a8d6623SGarrett Wollman# ST-506, ESDI, and IDE hard disks: `wdc' and `wd'
4856a8d6623SGarrett Wollman#
4866a8d6623SGarrett Wollman# NB: ``Enhanced IDE'' is NOT supported at this time.
4876a8d6623SGarrett Wollman#
488e3dd3158SJohn Dyson# The flags fields are used to enable the multi-sector I/O and
489e3dd3158SJohn Dyson# the 32BIT I/O modes.  The flags may be used in either the controller
490e3dd3158SJohn Dyson# definition or in the individual disk definitions.  The controller
491e3dd3158SJohn Dyson# definition is supported for the boot configuration stuff.
492e3dd3158SJohn Dyson#
493e3dd3158SJohn Dyson# Each drive has a 16 bit flags value defined:
494e3dd3158SJohn Dyson#	The low 8 bits are the maximum value for the multi-sector I/O,
495e3dd3158SJohn Dyson#	where 0xff defaults to the maximum that the drive can handle.
496e3dd3158SJohn Dyson#	The high bit of the 16 bit flags (0x8000) allows probing for
497e3dd3158SJohn Dyson#	32 bit transfers.
498e3dd3158SJohn Dyson#
499e3dd3158SJohn Dyson# The flags field for the drives can be specified in the controller
500e3dd3158SJohn Dyson# specification with the low 16 bits for drive 0, and the high 16 bits
501e3dd3158SJohn Dyson# for drive 1.
502e3dd3158SJohn Dyson# e.g.:
503e3dd3158SJohn Dyson#controller	wdc0	at isa? port "IO_WD1" bio irq 14 flags 0x00ff8004 vector wdintr
504e3dd3158SJohn Dyson#
505e3dd3158SJohn Dyson# specifies that drive 0 will be allowed to probe for 32 bit transfers and
506e3dd3158SJohn Dyson# a maximum multi-sector transfer of 4 sectors, and drive 1 will not be
507e3dd3158SJohn Dyson# allowed to probe for 32 bit transfers, but will allow multi-sector
508e3dd3158SJohn Dyson# transfers up to the maximum that the drive supports.
509e3dd3158SJohn Dyson#
510e3dd3158SJohn Dyson
511e3dd3158SJohn Dyson#
5122620c42eSNate Williamscontroller	wdc0	at isa? port "IO_WD1" bio irq 14 vector wdintr
5132620c42eSNate Williamsdisk		wd0	at wdc0 drive 0
5142620c42eSNate Williamsdisk		wd1	at wdc0 drive 1
5152620c42eSNate Williamscontroller	wdc1	at isa? port "IO_WD2" bio irq 15 vector wdintr
5162620c42eSNate Williamsdisk		wd2	at wdc1 drive 0
5172620c42eSNate Williamsdisk		wd3	at wdc1 drive 1
5182365e64fSRodney W. Grimes
5196a8d6623SGarrett Wollman#
5206788ce49SJordan K. Hubbard# Options for `wdc':
5216788ce49SJordan K. Hubbard#
5226788ce49SJordan K. Hubbard# ATAPI enables the support for ATAPI-compatible IDE devices
5236788ce49SJordan K. Hubbard#
5246788ce49SJordan K. Hubbardoptions         ATAPI   #Enable ATAPI support for IDE bus
5256788ce49SJordan K. Hubbard
5266788ce49SJordan K. Hubbard# IDE CD-ROM driver - requires wdc controller and ATAPI option
5276788ce49SJordan K. Hubbarddevice          wcd0
5286788ce49SJordan K. Hubbard
5296788ce49SJordan K. Hubbard#
5306a8d6623SGarrett Wollman# Standard floppy disk controllers and floppy tapes: `fdc', `fd', and `ft'
5316a8d6623SGarrett Wollman#
5326a8d6623SGarrett Wollmancontroller	fdc0	at isa? port "IO_FD1" bio irq 6 drq 2 vector fdintr
53385827d9cSJoerg Wunsch#
53485827d9cSJoerg Wunsch# Activate this line instead of the fdc0 line above if you happen to
53585827d9cSJoerg Wunsch# have an Insight floppy tape.  Probing them proved to be dangerous
53685827d9cSJoerg Wunsch# for people with floppy disks only, so it's "hidden" behind a flag:
53785827d9cSJoerg Wunsch#controller fdc0 at isa? port "IO_FD1" bio flags 1 irq 6 drq 2 vector fdintr
53885827d9cSJoerg Wunsch
5396a8d6623SGarrett Wollmandisk		fd0	at fdc0 drive 0
5406a8d6623SGarrett Wollmandisk		fd1	at fdc0 drive 1
5416a8d6623SGarrett Wollmantape		ft0	at fdc0 drive 2
5426a8d6623SGarrett Wollman
54385827d9cSJoerg Wunsch
5446a8d6623SGarrett Wollman#
545d29895dcSGarrett Wollman# Options for `fd':
54695b926abSJoerg Wunsch#
547d29895dcSGarrett Wollman# FDSEEKWAIT selects a non-default head-settle time (i.e., the time to
548d29895dcSGarrett Wollman# wait after a seek is performed).  The default value (1/32 s) is
549d29895dcSGarrett Wollman# usually sufficient.  The units are inverse seconds, so a value of 16
550d29895dcSGarrett Wollman# here means to wait 1/16th of a second; you should choose a power of
551d29895dcSGarrett Wollman# two.
55295b926abSJoerg Wunsch#
553d29895dcSGarrett Wollmanoptions	FDSEEKWAIT="16"
55495b926abSJoerg Wunsch
55595b926abSJoerg Wunsch#
5562f6df264SJordan K. Hubbard# Other standard PC hardware: `lpt', `mse', `psm', `sio', etc.
5576a8d6623SGarrett Wollman#
5586a8d6623SGarrett Wollman# lpt: printer port
5597fe369dcSJoerg Wunsch#	lpt specials:
5607fe369dcSJoerg Wunsch#		port can be specified as ?, this will cause the driver to scan
5617fe369dcSJoerg Wunsch#		the BIOS port list;
5627fe369dcSJoerg Wunsch#		the irq and vector clauses may be omitted, this
5637fe369dcSJoerg Wunsch#		will force the port into polling mode.
5646a8d6623SGarrett Wollman# mse: Logitech and ATI InPort bus mouse ports
5659cc34748SJordan K. Hubbard# psm: PS/2 mouse port [note: conflicts with sc0/vt0, thus "conflicts" keywd]
5666a8d6623SGarrett Wollman# sio: serial ports (see sio(4))
5676a8d6623SGarrett Wollman
5687fe369dcSJoerg Wunschdevice		lpt0	at isa? port? tty irq 7 vector lptintr
5697fe369dcSJoerg Wunschdevice		lpt1	at isa? port "IO_LPT3" tty irq 5 vector lptintr
5706a8d6623SGarrett Wollmandevice		mse0	at isa? port 0x23c tty irq 5 vector mseintr
5719cc34748SJordan K. Hubbarddevice		psm0	at isa? port "IO_KBD" conflicts tty irq 12 vector psmintr
572975c53c7SDoug Rabson# Options for psm:
573975c53c7SDoug Rabsonoptions		PSM_NO_RESET		#don't reset mouse hardware (some laptops)
574975c53c7SDoug Rabson
5756a8d6623SGarrett Wollmandevice		sio0	at isa? port "IO_COM1" tty irq 4 vector siointr
5766a8d6623SGarrett Wollman
5776a8d6623SGarrett Wollman# Options for sio:
5789ba0e7c3SBruce Evansoptions		COMCONSOLE		#prefer serial console to video console
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#
587e7c234a1SPeter Wemm# ar: Arnet SYNC/570i hdlc sync 2/4 port V.35/X.21 serial driver (reqires 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
666d1a599c2SJordan K. Hubbard# 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)
7022cd01159SJordan K. Hubbard# spigot: The Creative Labs Video Spigot video-aquisition 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
74405e1d9d4SJordan K. Hubbard# 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
7496a8d6623SGarrett Wollmandevice		apm0	at isa?
7501a7c583cSGarrett Wollmandevice		gp0	at isa? port 0x2c0 tty
7511a7c583cSGarrett Wollmandevice		gsc0	at isa? port "IO_GSC1" tty drq 3
7521a7c583cSGarrett Wollmandevice		joy0	at isa? port "IO_GAME"
75365e8111fSBruce Evansdevice		cy0	at isa? tty irq 10 iomem 0xd4000 iosiz 0x2000 vector cyintr
754a50cd483SJordan K. Hubbarddevice		dgb0	at isa? port 0x220 iomem 0xfc0000 iosiz ? tty
755657e73c4SPeter Dufaultdevice		labpc0	at isa? port 0x260 tty irq 5 vector labpcintr
756d0930614SAndrey A. Chernovdevice          rc0     at isa? port 0x220 tty irq 12 vector rcintr
757567e21c2SBruce Evans# the port and irq for tw0 are fictitious
758567e21c2SBruce Evansdevice          tw0     at isa? port 0x380 tty irq 11 vector twintr
759c4823710SPeter Wemmdevice		si0	at isa? iomem 0xd0000 tty irq 12 vector siintr
760a800f455SJulian Elischerdevice		asc0	at isa? port IO_ASC1 tty drq 3 irq 10 vector ascintr
76165e8111fSBruce Evansdevice		bqu0	at isa? port 0x150
762a800f455SJulian Elischer
763eeb706c0SJustin T. Gibbs#
764eeb706c0SJustin T. Gibbs# EISA devices:
765eeb706c0SJustin T. Gibbs#
766eeb706c0SJustin T. Gibbs# The EISA bus device is eisa0.  It provides auto-detection and
767eeb706c0SJustin T. Gibbs# configuration support for all devices on the EISA bus.
768eeb706c0SJustin T. Gibbs#
769e56e7036SJustin T. Gibbs# The `ahb' device provides support for the Adaptec 174X adapter.
770e56e7036SJustin T. Gibbs#
771eeb706c0SJustin T. Gibbs# The `ahc' device provides support for the Adaptec 274X and 284X
772eeb706c0SJustin T. Gibbs# adapters.  The 284X, although a VLB card responds to EISA probes.
773eeb706c0SJustin T. Gibbs#
774eeb706c0SJustin T. Gibbscontroller	eisa0
775e56e7036SJustin T. Gibbscontroller	ahb0
776eeb706c0SJustin T. Gibbscontroller	ahc0
7776a8d6623SGarrett Wollman
7786a8d6623SGarrett Wollman#
7796a8d6623SGarrett Wollman# PCI devices:
7806a8d6623SGarrett Wollman#
7816a8d6623SGarrett Wollman# The main PCI bus device is `pci'.  It provides auto-detection and
7826a8d6623SGarrett Wollman# configuration support for all devices on the PCI bus, using either
7836a8d6623SGarrett Wollman# configuration mode defined in the PCI specification.
7846a8d6623SGarrett Wollman#
785eeb706c0SJustin T. Gibbs# The `ahc' device provides support for the Adaptec 29/3940(U)(W)
786eeb706c0SJustin T. Gibbs# and motherboard based AIC7870/AIC7880 adapters.
787eeb706c0SJustin T. Gibbs#
7886a8d6623SGarrett Wollman# The `ncr' device provides support for the NCR 53C810 and 53C825
7896a8d6623SGarrett Wollman# self-contained SCSI host adapters.
7906a8d6623SGarrett Wollman#
7916a8d6623SGarrett Wollman# The `de' device provides support for the Digital Equipment DC21040
7926a8d6623SGarrett Wollman# self-contained Ethernet adapter.
7936a8d6623SGarrett Wollman#
794f4567b9cSJulian Elischer# The `vx' device provides support for the 3Com 3C590
795f4567b9cSJulian Elischer# early support
796f4567b9cSJulian Elischer#
797d41f24e7SDavid Greenman# The `fpa' device provides support for the Digital DEFPA PCI FDDI
798d41f24e7SDavid Greenman# adapter. pseudo-device fddi is also needed.
799d41f24e7SDavid Greenman#
8009ec2a4b3SStefan Eßer# The PROBE_VERBOSE option enables a long listing of chip set registers
8019ec2a4b3SStefan Eßer# for supported PCI chip sets (currently only intel Saturn and Mercury).
8029ec2a4b3SStefan Eßer#
8031d86961eSJordan K. Hubbard# The 'meteor' device is a PCI video capture board. It can also have the
8041d86961eSJordan K. Hubbard# following options:
8051d86961eSJordan K. Hubbard#   options "METEOR_ALLOC_PAGES=xxx"	preallocate kernel pages for data entry
8061d86961eSJordan K. Hubbard#	figure (ROWS*COLUMN*BYTES_PER_PIXEL*FRAME+PAGE_SIZE-1)/PAGE_SIZE
8071d86961eSJordan K. Hubbard#   options METEOR_DEALLOC_PAGES	remove all allocated pages on close(2)
8081d86961eSJordan K. Hubbard#   options "METEOR_DEALLOC_ABOVE=xxx"	remove all allocated pages above the
8091d86961eSJordan K. Hubbard#	specified amount. If this value is below the allocated amount no action
8101d86961eSJordan K. Hubbard#	taken
8111d86961eSJordan K. Hubbard#
8126a8d6623SGarrett Wollmancontroller	pci0
813eeb706c0SJustin T. Gibbscontroller	ahc1
8146a8d6623SGarrett Wollmandevice		ncr0
8156a8d6623SGarrett Wollmandevice		de0
816f4567b9cSJulian Elischerdevice		vx0 at pci0 port? irq? vector vxintr
817d41f24e7SDavid Greenmandevice		fpa0
8181d86961eSJordan K. Hubbarddevice		meteor0
8199ec2a4b3SStefan Eßeroptions		PROBE_VERBOSE
820446cee6eSJoerg Wunsch
821dc9deb29SPoul-Henning Kamp
822dc9deb29SPoul-Henning Kamp#
823dc9deb29SPoul-Henning Kamp# PCCARD/PCMCIA
824dc9deb29SPoul-Henning Kamp#
825dc9deb29SPoul-Henning Kampcontroller	crd0
826dc9deb29SPoul-Henning Kampcontroller	pcic0 at crd?
827dc9deb29SPoul-Henning Kamp
828446cee6eSJoerg Wunsch#
829446cee6eSJoerg Wunsch# Laptop/Notebook options:
830446cee6eSJoerg Wunsch#
831446cee6eSJoerg Wunsch# See also:
832446cee6eSJoerg Wunsch#  apm under `Miscellaneous hardare'
833446cee6eSJoerg Wunsch#  options		PSM_NO_RESET  for the `psm' driver
834446cee6eSJoerg Wunsch# above.
835446cee6eSJoerg Wunsch
836446cee6eSJoerg Wunsch# For older notebooks that signal a powerfail condition (external
837446cee6eSJoerg Wunsch# power supply dropped, or battery state low) by issuing an NMI:
838446cee6eSJoerg Wunsch
839446cee6eSJoerg Wunschoptions		POWERFAIL_NMI	# make it beep instead of panicing
84065e8111fSBruce Evans
84165e8111fSBruce Evans# More undocumented options for linting.
84294c94804SBruce Evans
84365e8111fSBruce Evansoptions		COMPAT_LINUX
84494c94804SBruce Evansoptions		"EXT2FS"
84565e8111fSBruce Evansoptions		"IBCS2"
846