Copy head to stable/8 as part of 8.0 Release cycle.

[FreeBSD/stable/8.git] / sys / pc98 / conf / NOTES

#
# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
#
# This file contains machine dependent kernel configuration notes.  For
# machine independent notes, look in /sys/conf/NOTES.
#
# $FreeBSD$
#

#
# We want LINT to cover profiling as well.
profile         2

\f
#####################################################################
# SMP OPTIONS:
#
# The apic device enables the use of the I/O APIC for interrupt delivery.
# The apic device can be used in both UP and SMP kernels, but is required
# for SMP kernels.  Thus, the apic device is not strictly an SMP option,
# but it is a prerequisite for SMP.
#

# Mandatory:
device          apic                    # I/O apic

#
# Watchdog routines.
#
options         MP_WATCHDOG

# Debugging options.
#
options         STOP_NMI                # Stop CPUS using NMI instead of IPI


\f
#####################################################################
# CPU OPTIONS

#
# You must specify at least one CPU (the one you intend to run on);
# deleting the specification for CPUs you don't need to use may make
# parts of the system run faster.
#
cpu             I486_CPU
cpu             I586_CPU                # aka Pentium(tm)
cpu             I686_CPU                # aka Pentium Pro(tm)

#
# Options for CPU features.
#
# CPU_BLUELIGHTNING_3X enables triple-clock mode on IBM Blue Lightning
# CPU if CPU supports it.  The default is double-clock mode on
# BlueLightning CPU box.
#
# CPU_BLUELIGHTNING_FPU_OP_CACHE enables FPU operand cache on IBM
# BlueLightning CPU.  It works only with Cyrix FPU, and this option
# should not be used with Intel FPU.
#
# CPU_BTB_EN enables branch target buffer on Cyrix 5x86 (NOTE 1).
#
# CPU_CYRIX_NO_LOCK enables weak locking for the entire address space
# of Cyrix 6x86 and 6x86MX CPUs by setting the NO_LOCK bit of CCR1.
# Otherwise, the NO_LOCK bit of CCR1 is cleared.  (NOTE 3)
#
# CPU_DIRECT_MAPPED_CACHE sets L1 cache of Cyrix 486DLC CPU in direct
# mapped mode.  Default is 2-way set associative mode.
#
# CPU_DISABLE_5X86_LSSER disables load store serialize (i.e., enables
# reorder).  This option should not be used if you use memory mapped
# I/O device(s).
#
# CPU_DISABLE_CMPXCHG disables the CMPXCHG instruction on > i386 IA32
# machines.  VmWare 3.x seems to emulate this instruction poorly, causing
# the guest OS to run very slowly.  This problem appears to be fixed in
# VmWare 4.x, at least in version 4.5.2, so that enabling this option with
# VmWare 4.x will result in locking operations to be 20-30 times slower.
# Enabling this with an SMP kernel will cause the kernel to be unusable.
#
# CPU_DISABLE_SSE explicitly prevents I686_CPU from turning on SSE.
#
# CPU_FASTER_5X86_FPU enables faster FPU exception handler.
#
# CPU_I486_ON_386 enables CPU cache on i486 based CPU upgrade products
# for i386 machines.
#
# CPU_IORT defines I/O clock delay time (NOTE 1).  Default values of
# I/O clock delay time on Cyrix 5x86 and 6x86 are 0 and 7,respectively
# (no clock delay).
#
# CPU_L2_LATENCY specifies the L2 cache latency value.  This option is used
# only when CPU_PPRO2CELERON is defined and Mendocino Celeron is detected.
# The default value is 5.
#
# CPU_LOOP_EN prevents flushing the prefetch buffer if the destination
# of a jump is already present in the prefetch buffer on Cyrix 5x86(NOTE
# 1).
#
# CPU_PPRO2CELERON enables L2 cache of Mendocino Celeron CPUs.  This option
# is useful when you use Socket 8 to Socket 370 converter, because most Pentium
# Pro BIOSs do not enable L2 cache of Mendocino Celeron CPUs.
#
# CPU_RSTK_EN enables return stack on Cyrix 5x86 (NOTE 1).
#
# CPU_SUSP_HLT enables suspend on HALT.  If this option is set, CPU
# enters suspend mode following execution of HALT instruction.
#
# CPU_UPGRADE_HW_CACHE eliminates unneeded cache flush instruction(s).
#
# CPU_WT_ALLOC enables write allocation on Cyrix 6x86/6x86MX and AMD
# K5/K6/K6-2 CPUs.
#
# CYRIX_CACHE_WORKS enables CPU cache on Cyrix 486 CPUs with cache
# flush at hold state.
#
# CYRIX_CACHE_REALLY_WORKS enables (1) CPU cache on Cyrix 486 CPUs
# without cache flush at hold state, and (2) write-back CPU cache on
# Cyrix 6x86 whose revision < 2.7 (NOTE 2).
#
# NO_F00F_HACK disables the hack that prevents Pentiums (and ONLY
# Pentiums) from locking up when a LOCK CMPXCHG8B instruction is
# executed.  This option is only needed if I586_CPU is also defined,
# and should be included for any non-Pentium CPU that defines it.
#
# NO_MEMORY_HOLE is an optimisation for systems with AMD K6 processors
# which indicates that the 15-16MB range is *definitely* not being
# occupied by an ISA memory hole.
#
# NOTE 1: The options, CPU_BTB_EN, CPU_LOOP_EN, CPU_IORT,
# CPU_LOOP_EN and CPU_RSTK_EN should not be used because of CPU bugs.
# These options may crash your system.
#
# NOTE 2: If CYRIX_CACHE_REALLY_WORKS is not set, CPU cache is enabled
# in write-through mode when revision < 2.7.  If revision of Cyrix
# 6x86 >= 2.7, CPU cache is always enabled in write-back mode.
#
# NOTE 3: This option may cause failures for software that requires
# locked cycles in order to operate correctly.
#
options         CPU_BLUELIGHTNING_3X
options         CPU_BLUELIGHTNING_FPU_OP_CACHE
options         CPU_BTB_EN
options         CPU_DIRECT_MAPPED_CACHE
options         CPU_DISABLE_5X86_LSSER
options         CPU_DISABLE_CMPXCHG
#options        CPU_DISABLE_SSE
options         CPU_FASTER_5X86_FPU
options         CPU_I486_ON_386
options         CPU_IORT
options         CPU_L2_LATENCY=5
options         CPU_LOOP_EN
options         CPU_PPRO2CELERON
options         CPU_RSTK_EN
options         CPU_SUSP_HLT
options         CPU_UPGRADE_HW_CACHE
options         CPU_WT_ALLOC
options         CYRIX_CACHE_WORKS
options         CYRIX_CACHE_REALLY_WORKS
#options        NO_F00F_HACK

# Debug options
options         NPX_DEBUG       # enable npx debugging

#
# PERFMON causes the driver for Pentium/Pentium Pro performance counters
# to be compiled.  See perfmon(4) for more information.
#
options         PERFMON

\f
#####################################################################
# NETWORKING OPTIONS

#
# DEVICE_POLLING adds support for mixed interrupt-polling handling
# of network device drivers, which has significant benefits in terms
# of robustness to overloads and responsivity, as well as permitting
# accurate scheduling of the CPU time between kernel network processing
# and other activities.  The drawback is a moderate (up to 1/HZ seconds)
# potential increase in response times.
# It is strongly recommended to use HZ=1000 or 2000 with DEVICE_POLLING
# to achieve smoother behaviour.
# Additionally, you can enable/disable polling at runtime with help of
# the ifconfig(8) utility, and select the CPU fraction reserved to
# userland with the sysctl variable kern.polling.user_frac
# (default 50, range 0..100).
#
# Not all device drivers support this mode of operation at the time of
# this writing.  See polling(4) for more details.

options         DEVICE_POLLING

# BPF_JITTER adds support for BPF just-in-time compiler.

options         BPF_JITTER

\f
#####################################################################
# MISCELLANEOUS DEVICES AND OPTIONS

# 
# sio: serial ports (see sio(4)), including support for various
#      PC Card devices, such as Modem and NICs
#
#device         sio
hint.sio.0.at="isa"
hint.sio.0.port="0x3F8"
hint.sio.0.flags="0x10"
hint.sio.0.irq="4"

# `flags' specific to sio(4).
#       0x10    enable console support for this unit.  Other console flags
#               (if applicable) are ignored unless this is set.  Enabling
#               console support does not make the unit the preferred console.
#               Boot with -h or set boot_serial=YES in the loader.  For sio(4)
#               specifically, the 0x20 flag can also be set (see above).
#               Currently, at most one unit can have console support; the
#               first one (in config file order) with this flag set is
#               preferred.  Setting this flag for sio0 gives the old behaviour.
#       0x20    force this unit to be the console (unless there is another
#               higher priority console).  This replaces the COMCONSOLE option.
#       0x40    reserve this unit for low level console operations.  Do not
#               access the device in any normal way.
#       0x80    use this port for serial line gdb support in ddb.  Also known
#               as debug port.
# PnP `flags'
#       0x1     disable probing of this device.  Used to prevent your modem
#               from being attached as a PnP modem.
# Other flags for sio that aren't documented in the man page.
#       0x20000 enable hardware RTS/CTS and larger FIFOs.  Only works for
#               ST16650A-compatible UARTs.

# Options for sio:
options         COM_ESP                 # Code for Hayes ESP.
options         COM_MULTIPORT           # Code for some cards with shared IRQs.
options         CONSPEED=115200         # Speed for serial console
                                        # (default 9600).

device          speaker         #Play IBM BASIC-style noises out your speaker
hint.speaker.0.at="isa"
hint.speaker.0.port="0x35"
device          gzip            #Exec gzipped a.out's.  REQUIRES COMPAT_AOUT!
device          apm_saver       # Requires APM

\f
#####################################################################
# HARDWARE BUS CONFIGURATION

#
# ISA bus
#
device          isa

#
# Options for `isa':
#
# AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A
# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
# This option breaks suspend/resume on some portables.
#
# MAXMEM specifies the amount of RAM on the machine; if this is not
# specified, FreeBSD will first read the amount of memory from the CMOS
# RAM, so the amount of memory will initially be limited to 64MB or 16MB
# depending on the BIOS.  If the BIOS reports 64MB, a memory probe will
# then attempt to detect the installed amount of RAM.  If this probe
# fails to detect >64MB RAM you will have to use the MAXMEM option.
# The amount is in kilobytes, so for a machine with 128MB of RAM, it would
# be 131072 (128 * 1024).
#
# BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
# reset the CPU for reboot.  This is needed on some systems with broken
# keyboard controllers.
#
# EPSON_BOUNCEDMA was to use a bounce buffer to upper 15MB, but it's
# broken now.
#
# EPSON_MEMWIN disables 15-16MB chunk, and enables EPSON memory window.
#

options         AUTO_EOI_1

options         MAXMEM=(128*1024)
#options        BROKEN_KEYBOARD_RESET
options         EPSON_BOUNCEDMA
options         EPSON_MEMWIN

#
# PCI bus & PCI options:
#
device          pci

#
# AGP GART support
device          agp

# AGP debugging.
options         AGP_DEBUG

\f
#####################################################################
# HARDWARE DEVICE CONFIGURATION

# PC98 keyboard
device          pckbd
hint.pckbd.0.at="isa"
hint.pckbd.0.port="0x041"
hint.pckbd.0.irq="1"

# GDC screen
device          gdc
hint.gdc.0.at="isa"
options         LINE30

#
# The Numeric Processing eXtension driver.  This is non-optional.
device          npx

#
# `flags' for npx0:
#       0x01    don't use the npx registers to optimize bcopy.
#       0x02    don't use the npx registers to optimize bzero.
#       0x04    don't use the npx registers to optimize copyin or copyout.
# The npx registers are normally used to optimize copying and zeroing when
# all of the following conditions are satisfied:
#       I586_CPU is an option
#       the cpu is an i586 (perhaps not a Pentium)
#       the probe for npx0 succeeds
#       INT 16 exception handling works.
# Then copying and zeroing using the npx registers is normally 30-100% faster.
# The flags can be used to control cases where it doesn't work or is slower.
# Setting them at boot time using hints works right (the optimizations
# are not used until later in the bootstrap when npx0 is attached).
# Flag 0x08 automatically disables the i586 optimized routines.
#

#
# 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.  The other option is to load both as modules.

device          tdfx                    # Enable 3Dfx Voodoo support
device          tdfx_linux              # Enable Linuxulator support

# Direct Rendering modules for 3D acceleration.
device          drm             # DRM core module required by DRM drivers
device          mach64drm       # ATI Rage Pro, Rage Mobility P/M, Rage XL
device          mgadrm          # AGP Matrox G200, G400, G450, G550
device          r128drm         # ATI Rage 128
device          radeondrm       # ATI Radeon
device          savagedrm       # S3 Savage3D, Savage4
device          sisdrm          # SiS 300/305, 540, 630
device          tdfxdrm         # 3dfx Voodoo 3/4/5 and Banshee
options         DRM_DEBUG       # Include debug printfs (slow)

#
# Bus mouse
#
device          mse
hint.mse.0.at="isa"
hint.mse.0.port="0x7fd9"
hint.mse.0.irq="13"

#
# Network interfaces:
#

# ce:   Cronyx Tau-PCI/32 sync single/dual port G.703/E1 serial adaptor
#       with 32 HDLC subchannels (requires sppp (default), or NETGRAPH if
#       NETGRAPH_CRONYX is configured)
# cp:   Cronyx Tau-PCI sync single/dual/four port
#       V.35/RS-232/RS-530/RS-449/X.21/G.703/E1/E3/T3/STS-1
#       serial adaptor (requires sppp (default), or NETGRAPH if
#       NETGRAPH_CRONYX is configured)
# cs:   IBM Etherjet and other Crystal Semi CS89x0-based adapters and pccard
# ed:   Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
#       HP PC Lan+, various PC Card devices
#       (requires miibus)
# ie:   AT&T StarLAN 10 and EN100; 3Com 3C507; unknown NI5210;
#       Intel EtherExpress
# le:   AMD Am7900 LANCE and Am79C9xx ILACC/PCnet Ethernet interface driver
# ral:  Ralink Technology IEEE 802.11 wireless adapter
# sbni: Granch SBNI12-xx ISA and PCI adapters
# snc:  National Semiconductor DP8393X SONIC Ethernet adapter driver
# ural: Ralink Technology RT2500USB IEEE 802.11 wireless adapter
# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)

# Order for ISA/EISA devices is important here

device          ce
device          cp
device          cs
device          ed
hint.ed.0.at="isa"
hint.ed.0.port="0x280"
hint.ed.0.irq="5"
hint.ed.0.maddr="0xd8000"
device          ie                      # Hints only required for Starlan
hint.ie.2.at="isa"
hint.ie.2.port="0x300"
hint.ie.2.irq="5"
hint.ie.2.maddr="0xd0000"
#device         le
# Hint for the PC98-only C-NET(98)S C-bus front-end of le(4).
hint.le.0.at="isa"
hint.le.0.port="0x03d0"
hint.le.0.irq="6"
device          ral
device          sbni
hint.sbni.0.at="isa"
hint.sbni.0.port="0x210"
hint.sbni.0.irq="0xefdead"
hint.sbni.0.flags="0"
device          snc
hint.snc.0.at="isa"
hint.snc.0.port="0x888"
hint.snc.0.irq="6"
hint.snc.0.maddr="0xc0000"
device          ural

device          ath             # Atheros pci/cardbus NIC's
device          ath_hal         # pci/cardbus chip support
#device         ath_ar5210      # AR5210 chips
#device         ath_ar5211      # AR5211 chips
#device         ath_ar5212      # AR5212 chips
#device         ath_rf2413
#device         ath_rf2417
#device         ath_rf2425
#device         ath_rf5111
#device         ath_rf5112
#device         ath_rf5413
#device         ath_ar5416      # AR5416 chips
options         AH_SUPPORT_AR5416       # enable AR5416 tx/rx descriptors
device          ath_rate_sample # SampleRate tx rate control for ath

#
# SCSI host adapters:
#
# ct: WD33C93[ABC] based 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.

device          ct
hint.ct.0.at="isa"
device          ncv
device          nsp
device          stg

#
# SafeNet crypto driver: can be moved to the MI NOTES as soon as
# it's tested on a big-endian machine
#
device          safe            # SafeNet 1141
options         SAFE_DEBUG      # enable debugging support: hw.safe.debug
options         SAFE_RNDTEST    # enable rndtest support

#####################################################################

#
# Miscellaneous hardware:
#
# apm: Laptop Advanced Power Management (experimental)
# canbus: CanBe I/O Bus
# canbepm: CanBe Power Management Controller
# olpt: XXX
# pmc: Power Management Controller of NEC PC-98Note
# pmtimer: Timer device driver for power management events (APM or ACPI)
#          Adjusts system timer at wakeup time
#
# Notes on APM
#  The flags takes the following meaning for apm0:
#    0x0020  Statclock is broken.

device          apm
hint.apm.0.flags="0x20"
device          canbus
device          canbepm
device          olpt
hint.olpt.0.at="isa"
hint.olpt.0.port="0x040"
device          pmc
hint.pmc.0.at="isa"
hint.pmc.0.port="0x8f0"
device          pmtimer

#
# Laptop/Notebook options:
#
# See also:
#  apm under `Miscellaneous hardware'
# above.

# For older notebooks that signal a powerfail condition (external
# power supply dropped, or battery state low) by issuing an NMI:

options         POWERFAIL_NMI   # make it beep instead of panicing

#
# Set the number of PV entries per process.  Increasing this can
# stop panics related to heavy use of shared memory.  However, that can
# (combined with large amounts of physical memory) cause panics at
# boot time due the kernel running out of VM space.
#
# If you're tweaking this, you might also want to increase the sysctls
# "vm.v_free_min", "vm.v_free_reserved", and "vm.v_free_target".
#
# The value below is the one more than the default.
#
options         PMAP_SHPGPERPROC=201

#
# Change the size of the kernel virtual address space.  Due to
# constraints in loader(8) on i386, this must be a multiple of 4.
# 256 = 1 GB of kernel address space.  Increasing this also causes
# a reduction of the address space in user processes.  512 splits
# the 4GB cpu address space in half (2GB user, 2GB kernel).
#
options         KVA_PAGES=260

\f
#####################################################################
# ABI Emulation

# Enable iBCS2 runtime support for SCO and ISC binaries
options         IBCS2

# Emulate spx device for client side of SVR3 local X interface
options         SPX_HACK

# Enable Linux ABI emulation
options         COMPAT_LINUX

# Enable i386 a.out binary support
options         COMPAT_AOUT

# Enable the linux-like proc filesystem support (requires COMPAT_LINUX
# and PSEUDOFS)
options         LINPROCFS

# Enable the linux-like sys filesystem support (requires COMPAT_LINUX
# and PSEUDOFS)
options         LINSYSFS

#
# SysVR4 ABI emulation
#
# The svr4 ABI emulator can be statically compiled into the kernel or loaded as
# a KLD module.
# The STREAMS network emulation code can also be compiled statically or as a
# module.  If loaded as a module, it must be loaded before the svr4 module
# (the /usr/sbin/svr4 script does this for you).  If compiling statically,
# the `streams' device must be configured into any kernel which also
# specifies COMPAT_SVR4.  It is possible to have a statically-configured
# STREAMS device and a dynamically loadable svr4 emulator;  the /usr/sbin/svr4
# script understands that it doesn't need to load the `streams' module under
# those circumstances.
# Caveat:  At this time, `options KTRACE' is required for the svr4 emulator
# (whether static or dynamic).
#
options         COMPAT_SVR4     # build emulator statically
options         DEBUG_SVR4      # enable verbose debugging
device          streams         # STREAMS network driver (required for svr4).

\f
#####################################################################
# VM OPTIONS

# Disable the 4 MByte page PSE CPU feature.  The PSE feature allows the
# kernel to use 4 MByte pages to map the kernel instead of 4k pages.
# This saves on the amount of memory needed for page tables needed to
# map the kernel.  You should only disable this feature as a temporary
# workaround if you are having problems with it enabled.
#
#options        DISABLE_PSE

# Disable the global pages PGE CPU feature.  The PGE feature allows pages
# to be marked with the PG_G bit.  TLB entries for these pages are not
# flushed from the cache when %cr3 is reloaded.  This can make context
# switches less expensive.  You should only disable this feature as a
# temporary workaround if you are having problems with it enabled.
#
#options        DISABLE_PG_G

# KSTACK_PAGES is the number of memory pages to assign to the kernel
# stack of each thread.

options         KSTACK_PAGES=3

#####################################################################

# More undocumented options for linting.
# Note that documenting these are not considered an affront.

options         FB_INSTALL_CDEV         # install a CDEV entry in /dev

options         I586_PMC_GUPROF=0x70000
options         KBDIO_DEBUG=2
options         KBD_MAXRETRY=4
options         KBD_MAXWAIT=6
options         KBD_RESETDELAY=201

options         TIMER_FREQ=((14318182+6)/12)

options         VM_KMEM_SIZE
options         VM_KMEM_SIZE_MAX
options         VM_KMEM_SIZE_SCALE

\f
#####################################################################
# Devices we don't want to deal with

nodevice        bt
nodevice        adw
nodevice        aha
nodevice        ahb
nodevice        ahd
nodevice        mpt
nodevice        trm
nodevice        wds
nodevice        dpt
nodevice        ciss
nodevice        iir
nodevice        mly
nodevice        ida             # Compaq Smart RAID
nodevice        mlx             # Mylex DAC960
nodevice        amr             # AMI MegaRAID
nodevice        twe             # 3ware ATA RAID
nodevice        ataraid
nodevice        cm
nodevice        ex
nodevice        fea
nodevice        intpm
nodevice        alpm
nodevice        ichsmb
nodevice        viapm
nodevice        amdpm
nodevice        amdsmb
nodevice        nfpm
nodevice        nfsmb

\f
#####################################################################
# Options we don't want to deal with

nooption        AHD_DEBUG
nooption        AHD_DEBUG_OPTS
nooption        AHD_REG_PRETTY_PRINT
nooption        ADW_ALLOW_MEMIO
nooption        DPT_LOST_IRQ
nooption        DPT_RESET_HBA
nooption        DPT_TIMEOUT_FACTOR
nooption        AAC_DEBUG

\f
#####################################################################
# Make options we don't want to deal with