xref: /freebsd/sys/amd64/conf/NOTES (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
1#
2# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
3#
4# This file contains machine dependent kernel configuration notes.  For
5# machine independent notes, look in /sys/conf/NOTES.
6#
7# $FreeBSD$
8#
9
10#
11# We want LINT to cover profiling as well.
12profile         2
13
14
15#####################################################################
16# SMP OPTIONS:
17#
18# Notes:
19#
20# IPI_PREEMPTION instructs the kernel to preempt threads running on other
21#	  CPUS if needed.  Relies on the PREEMPTION option
22
23# Optional:
24options 	IPI_PREEMPTION
25device		atpic			# Optional legacy pic support
26device		mptable			# Optional MPSPEC mptable support
27
28#
29# Watchdog routines.
30#
31options 	MP_WATCHDOG
32
33#
34# Debugging options.
35#
36options		STOP_NMI		# Stop CPUS using NMI instead of IPI
37
38
39
40#####################################################################
41# CPU OPTIONS
42
43#
44# You must specify at least one CPU (the one you intend to run on);
45# deleting the specification for CPUs you don't need to use may make
46# parts of the system run faster.
47#
48cpu		HAMMER			# aka K8, aka Opteron & Athlon64
49
50#
51# Options for CPU features.
52#
53
54#
55# PERFMON causes the driver for Pentium/Pentium Pro performance counters
56# to be compiled.  See perfmon(4) for more information.
57#
58#XXX#options 	PERFMON
59
60
61#####################################################################
62# NETWORKING OPTIONS
63
64#
65# DEVICE_POLLING adds support for mixed interrupt-polling handling
66# of network device drivers, which has significant benefits in terms
67# of robustness to overloads and responsivity, as well as permitting
68# accurate scheduling of the CPU time between kernel network processing
69# and other activities.  The drawback is a moderate (up to 1/HZ seconds)
70# potential increase in response times.
71# It is strongly recommended to use HZ=1000 or 2000 with DEVICE_POLLING
72# to achieve smoother behaviour.
73# Additionally, you can enable/disable polling at runtime with help of
74# the ifconfig(8) utility, and select the CPU fraction reserved to
75# userland with the sysctl variable kern.polling.user_frac
76# (default 50, range 0..100).
77#
78# Not all device drivers support this mode of operation at the time of
79# this writing.  See polling(4) for more details.
80
81options 	DEVICE_POLLING
82
83
84#####################################################################
85# CLOCK OPTIONS
86
87# The following options are used for debugging clock behavior only, and
88# should not be used for production systems.
89
90# CLK_CALIBRATION_LOOP causes clock calibration to be run in a loop at
91# startup until the user presses a key.  (The i8254 clock is always
92# calibrated relative to the RTC (mc146818a) and this option causes the
93# calibration to be repeated.)
94options 	CLK_CALIBRATION_LOOP
95
96# CLK_USE_I8254_CALIBRATION causes the calibrated frequency of the i8254
97# clock to actually be used.
98options 	CLK_USE_I8254_CALIBRATION
99
100# Provide read/write access to the memory in the clock chip.
101device		nvram		# Access to rtc cmos via /dev/nvram
102
103
104#####################################################################
105# MISCELLANEOUS DEVICES AND OPTIONS
106
107#
108# sio: serial ports (see sio(4)), including support for various
109#      PC Card devices, such as Modem and NICs
110#
111device		sio
112hint.sio.0.at="isa"
113hint.sio.0.port="0x3F8"
114hint.sio.0.flags="0x10"
115hint.sio.0.irq="4"
116
117# `flags' specific to sio(4).
118#	0x10	enable console support for this unit.  Other console flags
119#		(if applicable) are ignored unless this is set.  Enabling
120#		console support does not make the unit the preferred console.
121#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
122#		specifically, the 0x20 flag can also be set (see above).
123#		Currently, at most one unit can have console support; the
124#		first one (in config file order) with this flag set is
125#		preferred.  Setting this flag for sio0 gives the old behaviour.
126#	0x20	force this unit to be the console (unless there is another
127#		higher priority console).  This replaces the COMCONSOLE option.
128#	0x40	reserve this unit for low level console operations.  Do not
129#		access the device in any normal way.
130#	0x80	use this port for serial line gdb support in ddb.  Also known
131#		as debug port.
132# PnP `flags'
133#	0x1	disable probing of this device.  Used to prevent your modem
134#		from being attached as a PnP modem.
135# Other flags for sio that aren't documented in the man page.
136#	0x20000	enable hardware RTS/CTS and larger FIFOs.  Only works for
137#		ST16650A-compatible UARTs.
138
139# Options for sio:
140options 	COM_ESP			# Code for Hayes ESP.
141options 	COM_MULTIPORT		# Code for some cards with shared IRQs.
142options 	CONSPEED=115200		# Speed for serial console
143					# (default 9600).
144
145device		speaker		#Play IBM BASIC-style noises out your speaker
146hint.speaker.0.at="isa"
147hint.speaker.0.port="0x61"
148device		gzip		#Exec gzipped a.out's.  REQUIRES COMPAT_AOUT!
149
150
151#####################################################################
152# HARDWARE BUS CONFIGURATION
153
154#
155# ISA bus
156#
157device		isa
158
159#
160# Options for `isa':
161#
162# AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A
163# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
164# This option breaks suspend/resume on some portables.
165#
166# AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A
167# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
168# Automatic EOI is documented not to work for for the slave with the
169# original i8259A, but it works for some clones and some integrated
170# versions.
171#
172# MAXMEM specifies the amount of RAM on the machine; if this is not
173# specified, FreeBSD will first read the amount of memory from the CMOS
174# RAM, so the amount of memory will initially be limited to 64MB or 16MB
175# depending on the BIOS.  If the BIOS reports 64MB, a memory probe will
176# then attempt to detect the installed amount of RAM.  If this probe
177# fails to detect >64MB RAM you will have to use the MAXMEM option.
178# The amount is in kilobytes, so for a machine with 128MB of RAM, it would
179# be 131072 (128 * 1024).
180#
181# BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
182# reset the CPU for reboot.  This is needed on some systems with broken
183# keyboard controllers.
184
185options 	AUTO_EOI_1
186#options 	AUTO_EOI_2
187
188options 	MAXMEM=(128*1024)
189#options 	BROKEN_KEYBOARD_RESET
190
191#
192# PCI bus & PCI options:
193#
194device		pci
195
196#
197# AGP GART support
198device		agp
199
200
201#####################################################################
202# HARDWARE DEVICE CONFIGURATION
203
204#
205# Optional devices:
206#
207
208# PS/2 mouse
209device		psm
210hint.psm.0.at="atkbdc"
211hint.psm.0.irq="12"
212
213# Options for psm:
214options 	PSM_HOOKRESUME		#hook the system resume event, useful
215					#for some laptops
216options 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
217
218# The keyboard controller; it controls the keyboard and the PS/2 mouse.
219device		atkbdc
220hint.atkbdc.0.at="isa"
221hint.atkbdc.0.port="0x060"
222
223# The AT keyboard
224device		atkbd
225hint.atkbd.0.at="atkbdc"
226hint.atkbd.0.irq="1"
227
228# Options for atkbd:
229options 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
230makeoptions	ATKBD_DFLT_KEYMAP=jp.106
231
232# `flags' for atkbd:
233#       0x01    Force detection of keyboard, else we always assume a keyboard
234#       0x02    Don't reset keyboard, useful for some newer ThinkPads
235#	0x03	Force detection and avoid reset, might help with certain
236#		dockingstations
237#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
238
239# Video card driver for VGA adapters.
240device		vga
241hint.vga.0.at="isa"
242
243# Options for vga:
244# Try the following option if the mouse pointer is not drawn correctly
245# or font does not seem to be loaded properly.  May cause flicker on
246# some systems.
247options 	VGA_ALT_SEQACCESS
248
249# If you can dispense with some vga driver features, you may want to
250# use the following options to save some memory.
251#options 	VGA_NO_FONT_LOADING	# don't save/load font
252#options 	VGA_NO_MODE_CHANGE	# don't change video modes
253
254# Older video cards may require this option for proper operation.
255options 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
256
257# The following option probably won't work with the LCD displays.
258options 	VGA_WIDTH90		# support 90 column modes
259
260# Debugging.
261options 	VGA_DEBUG
262
263# 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support.  This will create
264# the /dev/3dfx0 device to work with glide implementations.  This should get
265# linked to /dev/3dfx and /dev/voodoo.  Note that this is not the same as
266# the tdfx DRI module from XFree86 and is completely unrelated.
267#
268# To enable Linuxulator support, one must also include COMPAT_LINUX in the
269# config as well.  The other option is to load both as modules.
270
271device		tdfx			# Enable 3Dfx Voodoo support
272#XXX#device 	tdfx_linux		# Enable Linuxulator support
273
274#
275# ACPI support using the Intel ACPI Component Architecture reference
276# implementation.
277#
278# ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer
279# kernel environment variables to select initial debugging levels for the
280# Intel ACPICA code.  (Note that the Intel code must also have USE_DEBUGGER
281# defined when it is built).
282#
283# ACPI_NO_SEMAPHORES makes the AcpiOs*Semaphore routines a no-op.
284
285device		acpi
286options 	ACPI_DEBUG
287#!options 	ACPI_NO_SEMAPHORES
288
289# The cpufreq(4) driver provides support for non-ACPI CPU frequency control
290device		cpufreq
291
292# Direct Rendering modules for 3D acceleration.
293device		drm		# DRM core module required by DRM drivers
294device		i915drm		# Intel i830 through i915
295device		mach64drm	# ATI Rage Pro, Rage Mobility P/M, Rage XL
296device		mgadrm		# AGP Matrox G200, G400, G450, G550
297device		r128drm		# ATI Rage 128
298device		radeondrm	# ATI Radeon
299device		savagedrm	# S3 Savage3D, Savage4
300device		sisdrm		# SiS 300/305, 540, 630
301device		tdfxdrm		# 3dfx Voodoo 3/4/5 and Banshee
302options 	DRM_DEBUG	# Include debug printfs (slow)
303
304#
305# Network interfaces:
306#
307
308# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
309# ed:   Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
310#       HP PC Lan+, various PC Card devices
311#       (requires miibus)
312# ipw:	Intel PRO/Wireless 2100 IEEE 802.11 adapter
313# iwi:	Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters
314# nfe:	nVidia nForce MCP on-board Ethernet Networking (BSD open source)
315# nve:	nVidia nForce MCP on-board Ethernet Networking
316# ral:	Ralink Technology IEEE 802.11 wireless adapter
317# ural:	Ralink Technology RT2500USB IEEE 802.11 wireless adapter
318# wpi:	Intel 3945ABG Wireless LAN controller
319
320device		ed
321options 	ED_3C503
322options 	ED_HPP
323options 	ED_SIC
324device		iwi
325device		ipw
326device		nfe		# nVidia nForce MCP on-board Ethernet Networking
327device		nve		# nVidia nForce MCP on-board Ethernet Networking
328device		ral
329device		ural
330device		wpi
331
332device		ath
333device		ath_hal		# Atheros HAL (includes binary component)
334#device		ath_rate_amrr	# AMRR rate control for ath driver
335#device		ath_rate_onoe	# Onoe rate control for ath driver
336device		ath_rate_sample	# SampleRate rate control for the ath driver
337#device		wlan		# 802.11 layer
338
339#
340#XXX this stores pointers in a 32bit field that is defined by the hardware
341#device	pst
342
343#
344# Areca 11xx and 12xx series of SATA II RAID controllers.
345# CAM is required.
346#
347device		arcmsr		# Areca SATA II RAID
348
349#
350# 3ware 9000 series PATA/SATA RAID controller driver and options.
351# The driver is implemented as a SIM, and so, needs the CAM infrastructure.
352#
353options 	TWA_DEBUG		# 0-10; 10 prints the most messages.
354options 	TWA_FLASH_FIRMWARE	# firmware image bundled when defined.
355device		twa			# 3ware 9000 series PATA/SATA RAID
356
357#
358# SCSI host adapters:
359#
360# ncv: NCR 53C500 based SCSI host adapters.
361# nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters.
362# stg: TMC 18C30, 18C50 based SCSI host adapters.
363
364device		ncv
365device		nsp
366device		stg
367
368#
369# Adaptec FSA RAID controllers, including integrated DELL controllers,
370# the Dell PERC 2/QC and the HP NetRAID-4M
371device		aac
372device		aacp	# SCSI Passthrough interface (optional, CAM required)
373
374#
375# Highpoint RocketRAID 182x.
376device		hptmv
377
378#
379# Highpoint RocketRAID.  Supports RR172x, RR222x, RR2240, RR232x, RR2340,
380# RR2210, RR174x, RR2522, RR231x, RR230x.
381device		hptrr
382
383#
384# Highpoint RocketRAID 232x.  This is software RAID but with hardware
385# acceleration assistance for RAID_5.
386device		rr232x
387
388#
389# Highpoint RocketRaid 3xxx series SATA RAID
390device		hptiop
391
392#
393# IBM (now Adaptec) ServeRAID controllers
394device		ips
395
396#
397# SafeNet crypto driver: can be moved to the MI NOTES as soon as
398# it's tested on a big-endian machine
399#
400device		safe		# SafeNet 1141
401options 	SAFE_DEBUG	# enable debugging support: hw.safe.debug
402options 	SAFE_RNDTEST	# enable rndtest support
403
404#####################################################################
405
406#
407# Miscellaneous hardware:
408#
409# ipmi: Intelligent Platform Management Interface
410# smbios: DMI/SMBIOS entry point
411# vpd: Vital Product Data kernel interface
412# cy: Cyclades serial driver
413# digi: Digiboard driver
414# asmc: Apple System Management Controller
415
416# Notes on the Specialix SI/XIO driver:
417#  The host card is memory, not IO mapped.
418#  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
419#  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
420#  The cards can use an IRQ of 11, 12 or 15.
421
422device		cy
423options 	CY_PCI_FASTINTR		# Use with cy_pci unless irq is shared
424device		digi
425# BIOS & FEP/OS components of device digi.
426device		digi_CX
427device		digi_CX_PCI
428device		digi_EPCX
429device		digi_EPCX_PCI
430device		digi_Xe
431device		digi_Xem
432device		digi_Xr
433device		ipmi
434# Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724)
435device		pbio
436hint.pbio.0.at="isa"
437hint.pbio.0.port="0x360"
438device		smbios
439device		vpd
440device		asmc
441#
442# Laptop/Notebook options:
443#
444
445
446#
447# I2C Bus
448#
449
450#
451# Hardware watchdog timers:
452#
453# ichwd: Intel ICH watchdog timer
454#
455device		ichwd
456
457#
458# Temperature sensors:
459#
460# coretemp: on-die sensor on Intel Core and newer CPUs
461#
462device		coretemp
463
464#---------------------------------------------------------------------------
465# ISDN4BSD
466#
467# See /usr/share/examples/isdn/ROADMAP for an introduction to isdn4bsd.
468#
469# i4b passive ISDN cards support contains the following hardware drivers:
470#
471#	isic  - Siemens/Infineon ISDN ISAC/HSCX/IPAC chipset driver
472#	iwic  - Winbond W6692 PCI bus ISDN S/T interface controller
473#	ifpi  - AVM Fritz!Card PCI driver
474#	ifpi2  - AVM Fritz!Card PCI version 2 driver
475#	itjc  - Siemens ISAC / TJNet Tiger300/320 chipset
476#
477# i4b active ISDN cards support contains the following hardware drivers:
478#
479#	iavc  - AVM B1 PCI, AVM B1 ISA, AVM T1
480#
481# Note that the ``options'' (if given) and ``device'' lines must BOTH
482# be uncommented to enable support for a given card !
483#
484# In addition to a hardware driver (and probably an option) the mandatory
485# ISDN protocol stack devices and the mandatory support device must be
486# enabled as well as one or more devices from the optional devices section.
487#
488#---------------------------------------------------------------------------
489#	isic driver (Siemens/Infineon chipsets)
490#
491#XXX#device	isic
492#
493# PCI bus Cards:
494# --------------
495#
496# ELSA MicroLink ISDN/PCI (same as ELSA QuickStep 1000pro PCI)
497options 	ELSA_QS1PCI
498#
499#---------------------------------------------------------------------------
500#	ifpi2 driver for AVM Fritz!Card PCI version 2
501#
502# AVM Fritz!Card PCI version 2
503#XXX#device	ifpi2
504#
505#---------------------------------------------------------------------------
506#	iwic driver for Winbond W6692 chipset
507#
508# ASUSCOM P-IN100-ST-D (and other Winbond W6692 based cards)
509#XXX#device	iwic
510#
511#---------------------------------------------------------------------------
512#	itjc driver for Siemens ISAC / TJNet Tiger300/320 chipset
513#
514# Traverse Technologies NETjet-S
515# Teles PCI-TJ
516#XXX#device	itjc
517#
518#---------------------------------------------------------------------------
519#	iavc driver (AVM active cards, needs i4bcapi driver!)
520#
521#XXX#device	iavc
522#
523#---------------------------------------------------------------------------
524#	ISDN Protocol Stack - mandatory for all hardware drivers
525#
526# Q.921 / layer 2 - i4b passive cards D channel handling
527#XXX#device	i4bq921
528#
529# Q.931 / layer 3 - i4b passive cards D channel handling
530#XXX#device	i4bq931
531#
532# layer 4 - i4b common passive and active card handling
533#XXX#device	i4b
534#
535#---------------------------------------------------------------------------
536#	ISDN devices - mandatory for all hardware drivers
537#
538# userland driver to do ISDN tracing (for passive cards only)
539#XXX#device	i4btrc
540#XXX#options 	NI4BTRC=4
541#
542# userland driver to control the whole thing
543#XXX#device	i4bctl
544#
545#---------------------------------------------------------------------------
546#	ISDN devices - optional
547#
548# userland driver for access to raw B channel
549#XXX#device	i4brbch
550#XXX#options 	NI4BRBCH=4
551#
552# userland driver for telephony
553#XXX#device	i4btel
554#XXX#options 	NI4BTEL=2
555#
556# network driver for IP over raw HDLC ISDN
557#XXX#device	i4bipr
558#XXX#options 	NI4BIPR=4
559# enable VJ header compression detection for ipr i/f
560#XXX#options 	IPR_VJ
561# enable logging of the first n IP packets to isdnd (n=32 here)
562#XXX#options 	IPR_LOG=32
563#
564# network driver for sync PPP over ISDN; requires an equivalent
565# number of sppp device to be configured
566#XXX#device	i4bisppp
567#XXX#options 	NI4BISPPP=4
568#
569# B-channel interface to the netgraph subsystem
570#XXX#device	i4bing
571#XXX#options 	NI4BING=2
572#
573# CAPI driver needed for active ISDN cards (see iavc driver above)
574#XXX#device	i4bcapi
575#
576#---------------------------------------------------------------------------
577
578#
579# System Management Bus (SMB)
580#
581options 	ENABLE_ALART		# Control alarm on Intel intpm driver
582
583#
584# Set the number of PV entries per process.  Increasing this can
585# stop panics related to heavy use of shared memory.  However, that can
586# (combined with large amounts of physical memory) cause panics at
587# boot time due the kernel running out of VM space.
588#
589# If you're tweaking this, you might also want to increase the sysctls
590# "vm.v_free_min", "vm.v_free_reserved", and "vm.v_free_target".
591#
592# The value below is the one more than the default.
593#
594options 	PMAP_SHPGPERPROC=201
595
596
597#####################################################################
598# ABI Emulation
599
600#XXX keep these here for now and reactivate when support for emulating
601#XXX these 32 bit binaries is added.
602
603# Enable 32-bit runtime support for FreeBSD/i386 binaries.
604options 	COMPAT_IA32
605
606# Enable iBCS2 runtime support for SCO and ISC binaries
607#XXX#options 	IBCS2
608
609# Emulate spx device for client side of SVR3 local X interface
610#XXX#options 	SPX_HACK
611
612# Enable Linux ABI emulation
613#XXX#options 	COMPAT_LINUX
614
615# Enable 32-bit Linux ABI emulation (requires COMPAT_43 and COMPAT_IA32)
616options 	COMPAT_LINUX32
617
618# Enable the linux-like proc filesystem support (requires COMPAT_LINUX32
619# and PSEUDOFS)
620options 	LINPROCFS
621
622#Enable the linux-like sys filesystem support (requires COMPAT_LINUX32
623# and PSEUDOFS)
624options		LINSYSFS
625
626#
627# SysVR4 ABI emulation
628#
629# The svr4 ABI emulator can be statically compiled into the kernel or loaded as
630# a KLD module.
631# The STREAMS network emulation code can also be compiled statically or as a
632# module.  If loaded as a module, it must be loaded before the svr4 module
633# (the /usr/sbin/svr4 script does this for you).  If compiling statically,
634# the `streams' device must be configured into any kernel which also
635# specifies COMPAT_SVR4.  It is possible to have a statically-configured
636# STREAMS device and a dynamically loadable svr4 emulator;  the /usr/sbin/svr4
637# script understands that it doesn't need to load the `streams' module under
638# those circumstances.
639# Caveat:  At this time, `options KTRACE' is required for the svr4 emulator
640# (whether static or dynamic).
641#
642#XXX#options 	COMPAT_SVR4	# build emulator statically
643#XXX#options 	DEBUG_SVR4	# enable verbose debugging
644#XXX#device	streams		# STREAMS network driver (required for svr4).
645
646
647#####################################################################
648# VM OPTIONS
649
650# KSTACK_PAGES is the number of memory pages to assign to the kernel
651# stack of each thread.
652
653options 	KSTACK_PAGES=3
654
655#####################################################################
656
657# More undocumented options for linting.
658# Note that documenting these are not considered an affront.
659
660options 	FB_INSTALL_CDEV		# install a CDEV entry in /dev
661
662options 	KBDIO_DEBUG=2
663options 	KBD_MAXRETRY=4
664options 	KBD_MAXWAIT=6
665options 	KBD_RESETDELAY=201
666
667options 	PSM_DEBUG=1
668
669options 	TIMER_FREQ=((14318182+6)/12)
670
671options 	VM_KMEM_SIZE
672options 	VM_KMEM_SIZE_MAX
673options 	VM_KMEM_SIZE_SCALE
674
675# Enable NDIS binary driver support
676options 	NDISAPI
677device		ndis
678