Round 2 of munging the MI/MD split in NOTES. Put almost all the device

drivers with MI portions into the MI notes.  Device drivers such as busses
like the isa, eisa, and pci devices are now in the MD NOTES section even
though they have some MI code.  This will ensure that only the proper bits
of device drivers will be included due to the optional bits dependent on
the busses in sys/conf/files.  This commit also takes the stance that since
hints are ignored in NOTES anyways, it is ok to include hints for a bus
that may not be present.

Advice from:    bde

1 files changed, 359 insertions, 8 deletions

diff --git a/sys/conf/NOTES b/sys/conf/NOTES
index df8fe4b..2d7d220 100644
--- a/sys/conf/NOTES
+++ b/sys/conf/NOTES
@@ -886,7 +886,8 @@ options 	MSGBUF_SIZE=40960
 #
 # ISA bus
 #
-device		isa
+
+options 	COMPAT_OLDISA	#Use ISA shims and glue for old drivers
 
 # Enable support for the kernel PLL to use an external PPS signal,
 # under supervision of [x]ntpd(8)
@@ -902,14 +903,21 @@ options 	PPS_SYNC
 
 options 	NTIMECOUNTER=20
 
+# 
+# EISA bus
+#
+
+# By default, only 10 EISA slots are probed, since the slot numbers
+# above clash with the configuration address space of the PCI subsystem,
+# and the EISA probe is not very smart about this.  This is sufficient
+# for most machines, but in particular the HP NetServer LC series comes
+# with an onboard AIC7770 dual-channel SCSI controller on EISA slot #11,
+# thus you need to bump this figure to 12 for them.
+options 	EISA_SLOTS=12
+
 #
 # PCI bus & PCI options:
 #
-# The main PCI bus device is `pci'.  It provides auto-detection and
-# configuration support for all devices on the PCI bus, using either
-# configuration mode defined in the PCI specification.
-
-device		pci
 
 
 #####################################################################
@@ -923,6 +931,80 @@ device		pci
 # Mandatory devices:
 #
 
+# The keyboard controller; it controls the keyboard and the PS/2 mouse.
+device		atkbdc	1
+hint.atkbdc.0.at="isa"
+hint.atkbdc.0.port="0x060"
+
+# The AT keyboard
+device		atkbd
+hint.atkbd.0.at="atkbdc"
+hint.atkbd.0.irq="1"
+
+# Options for atkbd:
+options 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
+makeoptions	ATKBD_DFLT_KEYMAP="jp.106"
+
+# These options are valid for other keyboard drivers as well.
+options 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
+options 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
+
+# `flags' for atkbd:
+#       0x01    Force detection of keyboard, else we always assume a keyboard
+#       0x02    Don't reset keyboard, useful for some newer ThinkPads
+#	0x03	Force detection and avoid reset, might help with certain
+#		dockingstations
+#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
+
+# PS/2 mouse
+device		psm
+hint.psm.0.at="atkbdc"
+hint.psm.0.irq="12"
+
+# Options for psm:
+options 	PSM_HOOKRESUME		#hook the system resume event, useful
+					#for some laptops
+options 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
+
+# The video card driver.
+device		vga
+hint.vga.0.at="isa"
+
+# Options for vga:
+# Try the following option if the mouse pointer is not drawn correctly
+# or font does not seem to be loaded properly.  May cause flicker on
+# some systems.
+options 	VGA_ALT_SEQACCESS
+
+# If you can dispense with some vga driver features, you may want to
+# use the following options to save some memory.
+#options 	VGA_NO_FONT_LOADING	# don't save/load font
+#options 	VGA_NO_MODE_CHANGE	# don't change video modes
+
+# Older video cards may require this option for proper operation.
+options 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
+
+# The following option probably won't work with the LCD displays.
+options 	VGA_WIDTH90		# support 90 column modes
+
+options 	FB_DEBUG		# Frame buffer debugging
+options 	FB_INSTALL_CDEV		# install a CDEV entry in /dev
+
+# Splash screen at start up!  Screen savers require this too.
+device		splash
+
+# Various screen savers.
+device		apm_saver		# Requires APM
+device		blank_saver
+device		daemon_saver
+device		fade_saver
+device		fire_saver
+device		green_saver
+device		logo_saver
+device		rain_saver
+device		star_saver
+device		warp_saver
+
 # The syscons console driver (sco color console compatible).
 device		sc	1
 hint.sc.0.at="isa"
@@ -963,17 +1045,50 @@ options 	SC_NO_SYSMOUSE
 #	0x100	Probe for a keyboard device periodically if one is not present
 
 #
+# ACPI support using the Intel ACPI Component Architecture reference
+# implementation.
+#
+# ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer
+# kernel environment variables to select initial debugging levels for the
+# Intel ACPICA code.  (Note that the Intel code must also have USE_DEBUGGER
+# defined when it is built).
+#
+# Note that building ACPI into the kernel is deprecated; the module is
+# normally loaded automatically by the loader.
+#
+device		acpica
+options 	ACPI_DEBUG
+
+#
 # Optional devices:
 #
 
+# 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support. This will create
+# the /dev/3dfx0 device to work with glide implementations. This should get
+# linked to /dev/3dfx and /dev/voodoo. Note that this is not the same as
+# the tdfx DRI module from XFree86 and is completely unrelated.
+#
+# To enable Linuxulator support, one must also include COMPAT_LINUX in the
+# config as well, or you will not have the dependencies. The other option
+# is to load both as modules.
+
+device 		tdfx			# Enable 3Dfx Voodoo support
+options 	TDFX_LINUX		# Enable Linuxulator support
+
 #
 # SCSI host adapters:
 #
+# adv: All Narrow SCSI bus AdvanSys controllers.
 # adw: Second Generation AdvanSys controllers including the ADV940UW.
+# aha: Adaptec 154x/1535/1640
+# ahb: Adaptec 174x EISA controllers
 # ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
 #      19160x/29160x, aic7770/aic78xx
+# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
 # amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
 #      such as the Tekram DC-390(T).
+# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
+#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
 # isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
 #      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
 #      ISP 12160 Ultra3 SCSI,
@@ -983,12 +1098,28 @@ options 	SC_NO_SYSMOUSE
 # ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
 # ncv: NCR 53C500 based SCSI host adapters.
 # nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters.
+# stg: TMC 18C30, 18C50 based SCSI host adapters.
 # sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
 #      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875, 
 #      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D, 
 #      53C1010-33, 53C1010-66.
+# wds: WD7000
 
+#
+# Note that the order is important in order for Buslogic ISA/EISA cards to be
+# probed correctly.
+#
+device		bt
+hint.bt.0.at="isa"
+hint.bt.0.port="0x330"
+device		adv
+hint.adv.0.at="isa"
 device		adw
+device		aha
+hint.aha.0.at="isa"
+device		aic
+hint.aic.0.at="isa"
+device		ahb
 device		ahc
 device		amd
 device		isp
@@ -1012,6 +1143,15 @@ device		ncr
 device		ncv
 device		nsp
 device		sym
+device		stg
+hint.stg.0.at="isa"
+hint.stg.0.port="0x140"
+hint.stg.0.port="11"
+device		wds
+hint.wds.0.at="isa"
+hint.wds.0.port="0x350"
+hint.wds.0.irq="11"
+hint.wds.0.drq="6"
 
 # The aic7xxx driver will attempt to use memory mapped I/O for all PCI
 # controllers that have it configured only if this option is set. Unfortunately,
@@ -1264,10 +1404,20 @@ options 	PUC_FASTINTR
 # individual driver.
 device		miibus
 
+# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
+#       PCI and ISA varieties.
+# ar:   Arnet SYNC/570i hdlc sync 2/4 port V.35/X.21 serial driver
+#       (requires sppp)
+# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
+#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
 # bge:	Support for gigabit ethernet adapters based on the Broadcom
 #	BCM570x family of controllers, including the 3Com 3c996-T,
 #	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
 #	the embedded gigE NICs on Dell PowerEdge 2550 servers.
+# cm:	Arcnet SMC COM90c26 / SMC COM90c56
+#	(and SMC COM90c66 in '56 compatibility mode) adapters.
+# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
+# cs:   IBM Etherjet and other Crystal Semi CS89x0-based adapters
 # dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
 #       and various workalikes including:
 #       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
@@ -1280,7 +1430,16 @@ device		miibus
 #       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
 #       KNE110TX.
 # de:   Digital Equipment DC21040
+# ed:   Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
+#       HP PC Lan+, various PC Card devices (refer to etc/defauls/pccard.conf)
+#       (requires miibus)
 # em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
+# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
+#       and PC Card devices using these chipsets.
+# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
+#       Olicom Ethernet PC Card devices.
+# fe:   Fujitsu MB86960A/MB86965A Ethernet
+# fea:  DEC DEFEA EISA FDDI adapter
 # fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
 # fxp:  Intel EtherExpress Pro/100B
 #	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
@@ -1288,6 +1447,8 @@ device		miibus
 # lge:	Support for PCI gigabit ethernet adapters based on the Level 1
 #	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
 #	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
+# lnc:  Lance/PCnet cards (Isolan, Novell NE2100, NE32-VL, AMD Am7990 and
+#       Am79C960)
 # nge:	Support for PCI gigabit ethernet adapters based on the National
 #	Semiconductor DP83820 and DP83821 chipset. This includes the
 #	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
@@ -1318,6 +1479,9 @@ device		miibus
 #       (also single mode and multimode).
 #       The driver will autodetect the number of ports on the card and
 #       attach each one as a separate network interface.
+# sn:   Support for ISA and PC Card Ethernet devices using the
+#       SMC91C90/92/94/95 chips.
+# sr:   RISCom/N2 hdlc sync 1/2 port V.35/X.21 serial driver (requires sppp)
 # ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
 #       the D-Link DFE-550TX.
 # ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
@@ -1339,6 +1503,13 @@ device		miibus
 # wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
 #       Note: this is not the same as the Winbond W89C940F, which is a
 #       NE2000 clone.
+# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
+#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
+#       bridge with a PCMCIA adapter plugged into it.
+# wl:   Lucent Wavelan (ISA card only).
+# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
+#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
+#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
 # xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
 #       Etherlink XL cards and integrated controllers.  This includes the
 #       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
@@ -1346,6 +1517,58 @@ device		miibus
 #       in Dell Latitude laptop docking stations.
 #       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
 
+# Order for ISA/EISA devices is important here
+
+device		ar	1
+hint.ar.0.at="isa"
+hint.ar.0.port="0x300"
+hint.ar.0.irq="10"
+hint.ar.0.maddr="0xd0000"
+device		cm
+hint.cm.0.at="isa"
+hint.cm.0.port="0x2e0"
+hint.cm.0.irq="9"
+hint.cm.0.maddr="0xdc000"
+device		cs
+hint.cs.0.at="isa"
+hint.cs.0.port="0x300"
+device		ed
+#options 	ED_NO_MIIBUS		# Disable ed miibus support
+hint.ed.0.at="isa"
+hint.ed.0.port="0x280"
+hint.ed.0.irq="5"
+hint.ed.0.maddr="0xd8000"
+device		ep
+device		ex
+device		fe	1
+hint.fe.0.at="isa"
+hint.fe.0.port="0x300"
+device		fea
+device		lnc	1
+hint.lnc.0.at="isa"
+hint.lnc.0.port="0x280"
+hint.lnc.0.irq="10"
+hint.lnc.0.drq="0"
+device		sr	1
+hint.sr.0.at="isa"
+hint.sr.0.port="0x300"
+hint.sr.0.irq="5"
+hint.sr.0.maddr="0xd0000"
+device		sn
+hint.sn.0.at="isa"
+hint.sn.0.port="0x300"
+hint.sn.0.irq="10"
+device		an
+device		awi
+device		cnw
+device		wi
+options 	WLCACHE		# enables the signal-strength cache
+options 	WLDEBUG		# enables verbose debugging output
+device		wl	1
+hint.wl.0.at="isa"
+hint.wl.0.port="0x300"
+device		xe
+
 # PCI Ethernet NICs that use the common MII bus controller code.
 device		dc		# DEC/Intel 21143 and various workalikes
 device		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
@@ -1396,7 +1619,7 @@ device		en
 options 	NATM			#native ATM
 
 #
-# Audio drivers: `pcm'
+# Audio drivers: `pcm', `sbc', `gusc'
 #
 # pcm: PCM audio through various sound cards.
 #
@@ -1405,33 +1628,96 @@ options 	NATM			#native ATM
 # For more information about this driver and supported cards,
 # see the pcm.4 man page.
 #
+# The flags of the device tells the device a bit more info about the
+# device that normally is obtained through the PnP interface.
+#	bit  2..0   secondary DMA channel;
+#	bit  4      set if the board uses two dma channels;
+#	bit 15..8   board type, overrides autodetection; leave it
+#		    zero if don't know what to put in (and you don't,
+#		    since this is unsupported at the moment...).
+#
 # Supported cards include:
+# Creative SoundBlaster ISA PnP/non-PnP
+# Supports ESS and Avance ISA chips as well.
+# Gravis UltraSound ISA PnP/non-PnP
 # Crystal Semiconductor CS461x/428x PCI
 # Neomagic 256AV (ac97)
+# Most of the more common ISA/PnP sb/mss/ess compatable cards.
 
 device		pcm
 
+# For non-pnp sound cards with no bridge drivers only:
+hint.pcm.0.at="isa"
+hint.pcm.0.irq="10"
+hint.pcm.0.drq="1"
+hint.pcm.0.flags="0x0"
+
 #
 # midi: MIDI interfaces and synthesizers
 #
 
 device		midi
 
+# For non-pnp sound cards with no bridge drivers:
+hint.midi.0.at="isa"
+hint.midi.0.irq="5"
+hint.midi.0.flags="0x0"
+
+# For serial ports (this example configures port 2):
+# TODO: implement generic tty-midi interface so that we can use
+#	other uarts.
+hint.midi.0.at="isa"
+hint.midi.0.port="0x2F8"
+hint.midi.0.irq="3"
+
 #
 # seq: MIDI sequencer
 #
 
 device		seq
 
+# The bridge drivers for sound cards.  These can be separately configured
+# for providing services to the likes of new-midi.
+# When used with 'device pcm' they also provide pcm sound services.
+#
+# sbc:  Creative SoundBlaster ISA PnP/non-PnP
+#	Supports ESS and Avance ISA chips as well.
+# gusc: Gravis UltraSound ISA PnP/non-PnP
+# csa:  Crystal Semiconductor CS461x/428x PCI
+
+# For non-PnP cards:
+device		sbc
+hint.sbc.0.at="isa"
+hint.sbc.0.port="0x220"
+hint.sbc.0.irq="5"
+hint.sbc.0.drq="1"
+hint.sbc.0.flags="0x15"
+device		gusc
+hint.gusc.0.at="isa"
+hint.gusc.0.port="0x220"
+hint.gusc.0.irq="5"
+hint.gusc.0.drq="1"
+hint.gusc.0.flags="0x13"
+
 #
 # Miscellaneous hardware:
 #
 # meteor: Matrox Meteor video capture board
 # bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
 # cy: Cyclades serial driver
+# dgb: Digiboard PC/Xi and PC/Xe series driver (ALPHA QUALITY!)
+# digi: Digiboard driver
+# joy: joystick (including IO DATA PCJOY PC Card joystick)
 # rp: Comtrol Rocketport(ISA/PCI) - single card
+# si: Specialix SI/XIO 4-32 port terminal multiplexor
 # nmdm: nullmodem terminal driver (see nmdm(4))
 
+# Notes on the Digiboard driver:
+#
+# The following flag values have special meanings in dgb:
+#	0x01 - alternate layout of pins
+#	0x02 - use the windowed PC/Xe in 64K mode
+
 # Notes on the Comtrol Rocketport driver:
 #
 # The exact values used for rp0 depend on how many boards you have
@@ -1463,15 +1749,43 @@ device		seq
 #
 #   For PCI cards, you need no hints.
 
+device		joy			# PnP aware, hints for nonpnp only
+hint.joy.0.at="isa"
+hint.joy.0.port="0x201"
 device		cy	1
 options 	CY_PCI_FASTINTR		# Use with cy_pci unless irq is shared
 hint.cy.0.at="isa"
 hint.cy.0.irq="10"
 hint.cy.0.maddr="0xd4000"
 hint.cy.0.msize="0x2000"
+device		dgb	1
+options 	NDGBPORTS=16		# Defaults to 16*NDGB
+hint.dgb.0.at="isa"
+hint.dgb.0.port="0x220"
+hint.dgb.0.maddr="0xfc000"
+device		digi
+hint.digi.0.at="isa"
+hint.digi.0.port="0x104"
+hint.digi.0.maddr="0xd0000"
+# BIOS & FEP/OS components of device digi.  Normally left as modules
+device		digi_CX
+device		digi_CX_PCI
+device		digi_EPCX
+device		digi_EPCX_PCI
+device		digi_Xe
+device		digi_Xem
+device		digi_Xr
 device		rp
-# nullmodem terminal driver
+hint.rp.0.at="isa"
+hint.rp.0.port="0x280"
+device		si
+options 	SI_DEBUG
+hint.si.0.at="isa"
+hint.si.0.maddr="0xd0000"
+hint.si.0.irq="12"
 device		nmdm
+# HOT1 Xilinx 6200 card (http://www.vcc.com/)
+device		xrpu
 
 #
 # The `meteor' device is a PCI video capture board. It can also have the
@@ -1544,6 +1858,31 @@ device		meteor	1
 device		bktr	1
 
 #
+# PC Card/PCMCIA
+# (OLDCARD)
+#
+# card: pccard slots
+# pcic: isa/pccard bridge
+device		pcic
+hint.pcic.0.at="isa"
+hint.pcic.1.at="isa"
+device		card
+
+#
+# PC Card/PCMCIA and Cardbus
+# (NEWCARD)
+#
+# Note that NEWCARD and OLDCARD are incompatible.  Do not use both at the same
+# time.
+#
+# pccbb: isa/pccard and pci/cardbus bridge
+# pccard: pccard slots
+# cardbus: cardbus slots
+#device		pccbb
+#device		pccard
+#device		cardbus
+
+#
 # SMB bus
 #
 # System Management Bus support is provided by the 'smbus' device.
@@ -1556,9 +1895,18 @@ device		bktr	1
 # Supported SMB interfaces:
 # iicsmb	I2C to SMB bridge with any iicbus interface
 # bktr		brooktree848 I2C hardware interface
+# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
+# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
+# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
+# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit 
 #
 device		smbus		# Bus support, required for smb below.
 
+device		intpm
+device		alpm
+device		ichsmb
+device		viapm
+
 device		smb
 
 #
@@ -1874,3 +2222,6 @@ options 	NDEVFSOVERFLOW=32769
 options 	NETGRAPH_BRIDGE
 # SIMOS is broken since it is alpha-only but not ifdefed.
 ##options 	SIMOS
+
+# Yet more undocumented options for linting.
+options 	VGA_DEBUG