xref: /freebsd/sys/amd64/conf/NOTES (revision 6af83ee0d2941d18880b6aaa2b4facd1d30c6106)
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# This directive is mandatory; it defines the architecture to be
12# configured for; in this case, the AMD64 family based machines.
13#
14machine		amd64
15
16#
17# We want LINT to cover profiling as well.
18#XXX#profile         2
19
20
21#####################################################################
22# SMP OPTIONS:
23#
24# The apic device enables the use of the I/O APIC for interrupt delivery.
25# The apic device can be used in both UP and SMP kernels, but is required
26# for SMP kernels.  Thus, the apic device is not strictly an SMP option,
27# but it is a prerequisite for SMP.
28#
29# Notes:
30#
31# By default, mixed mode is used to route IRQ0 from the AT timer via
32# the 8259A master PIC through the ExtINT pin on the first I/O APIC.
33# This can be disabled via the NO_MIXED_MODE option.  In that case,
34# IRQ0 will be routed via an intpin on the first I/O APIC.  Not all
35# motherboards hook IRQ0 up to the first I/O APIC even though their
36# MP table or MADT may claim to do so.  That is why mixed mode is
37# enabled by default.
38#
39
40# Optional:
41device		atpic			# Optional legacy pic support
42device		mptable			# Optional MPSPEC mptable support
43options 	NO_MIXED_MODE		# Disable use of mixed mode
44
45
46#####################################################################
47# CPU OPTIONS
48
49#
50# You must specify at least one CPU (the one you intend to run on);
51# deleting the specification for CPUs you don't need to use may make
52# parts of the system run faster.
53#
54cpu		HAMMER			# aka K8, aka Opteron & Athlon64
55
56#
57# Options for CPU features.
58#
59
60#
61# PERFMON causes the driver for Pentium/Pentium Pro performance counters
62# to be compiled.  See perfmon(4) for more information.
63#
64#XXX#options 	PERFMON
65
66
67#####################################################################
68# NETWORKING OPTIONS
69
70#
71# DEVICE_POLLING adds support for mixed interrupt-polling handling
72# of network device drivers, which has significant benefits in terms
73# of robustness to overloads and responsivity, as well as permitting
74# accurate scheduling of the CPU time between kernel network processing
75# and other activities.  The drawback is a moderate (up to 1/HZ seconds)
76# potential increase in response times.
77# It is strongly recommended to use HZ=1000 or 2000 with DEVICE_POLLING
78# to achieve smoother behaviour.
79# Additionally, you can enable/disable polling at runtime with the
80# sysctl variable kern.polling.enable (defaults off), and select
81# the CPU fraction reserved to userland with the sysctl variable
82# kern.polling.user_frac (default 50, range 0..100).
83#
84# Not all device drivers support this mode of operation at the time of
85# this writing.  See polling(4) for more details.
86
87options 	DEVICE_POLLING
88
89
90#####################################################################
91# CLOCK OPTIONS
92
93# The following options are used for debugging clock behavior only, and
94# should not be used for production systems.
95
96# CLK_CALIBRATION_LOOP causes clock calibration to be run in a loop at
97# startup until the user presses a key.  (The i8254 clock is always
98# calibrated relative to the RTC (mc146818a) and this option causes the
99# calibration to be repeated.)
100options 	CLK_CALIBRATION_LOOP
101
102# CLK_USE_I8254_CALIBRATION causes the calibrated frequency of the i8254
103# clock to actually be used.
104options 	CLK_USE_I8254_CALIBRATION
105
106
107#####################################################################
108# MISCELLANEOUS DEVICES AND OPTIONS
109
110device		gzip		#Exec gzipped a.out's.  REQUIRES COMPAT_AOUT!
111
112
113#####################################################################
114# HARDWARE BUS CONFIGURATION
115
116#
117# ISA bus
118#
119device		isa
120
121#
122# Options for `isa':
123#
124# AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A
125# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
126# This option breaks suspend/resume on some portables.
127#
128# AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A
129# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
130# Automatic EOI is documented not to work for for the slave with the
131# original i8259A, but it works for some clones and some integrated
132# versions.
133#
134# MAXMEM specifies the amount of RAM on the machine; if this is not
135# specified, FreeBSD will first read the amount of memory from the CMOS
136# RAM, so the amount of memory will initially be limited to 64MB or 16MB
137# depending on the BIOS.  If the BIOS reports 64MB, a memory probe will
138# then attempt to detect the installed amount of RAM.  If this probe
139# fails to detect >64MB RAM you will have to use the MAXMEM option.
140# The amount is in kilobytes, so for a machine with 128MB of RAM, it would
141# be 131072 (128 * 1024).
142#
143# BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
144# reset the CPU for reboot.  This is needed on some systems with broken
145# keyboard controllers.
146
147options 	AUTO_EOI_1
148#options 	AUTO_EOI_2
149
150options 	MAXMEM=(128*1024)
151#options 	BROKEN_KEYBOARD_RESET
152
153#
154# PCI bus & PCI options:
155#
156device		pci
157
158#
159# AGP GART support
160device		agp
161
162
163#####################################################################
164# HARDWARE DEVICE CONFIGURATION
165
166#
167# Optional devices:
168#
169
170# 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support.  This will create
171# the /dev/3dfx0 device to work with glide implementations.  This should get
172# linked to /dev/3dfx and /dev/voodoo.  Note that this is not the same as
173# the tdfx DRI module from XFree86 and is completely unrelated.
174#
175# To enable Linuxulator support, one must also include COMPAT_LINUX in the
176# config as well, or you will not have the dependencies.  The other option
177# is to load both as modules.
178
179device		tdfx			# Enable 3Dfx Voodoo support
180#XXX#options 	TDFX_LINUX		# Enable Linuxulator support
181
182#
183# ACPI support using the Intel ACPI Component Architecture reference
184# implementation.
185#
186# ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer
187# kernel environment variables to select initial debugging levels for the
188# Intel ACPICA code.  (Note that the Intel code must also have USE_DEBUGGER
189# defined when it is built).
190#
191# ACPI_MAX_THREADS sets the number of task threads started.
192#
193# ACPI_NO_SEMAPHORES makes the AcpiOs*Semaphore routines a no-op.
194#
195# ACPICA_PEDANTIC enables strict checking of AML.  Our default is to
196# relax these checks to allow code generated by the Microsoft compiler
197# to still execute.
198#
199# Note that building ACPI into the kernel is deprecated; the module is
200# normally loaded automatically by the loader.
201
202device		acpi
203options 	ACPI_DEBUG
204options 	ACPI_MAX_THREADS=1
205#!options 	ACPI_NO_SEMAPHORES
206#!options 	ACPICA_PEDANTIC
207
208# Support for ACPI CPU Performance states via cpufreq(4)
209device		acpi_perf
210
211# DRM options:
212# mgadrm:    AGP Matrox G200, G400, G450, G550
213# r128drm:   ATI Rage 128
214# radeondrm: ATI Radeon up to 9000/9100
215# sisdrm:    SiS 300/305,540,630
216# tdfxdrm:   3dfx Voodoo 3/4/5 and Banshee
217# DRM_DEBUG: include debug printfs, very slow
218#
219# mga requires AGP in the kernel, and it is recommended
220# for AGP r128 and radeon cards.
221
222device		mgadrm
223device		r128drm
224device		radeondrm
225device		sisdrm
226device		tdfxdrm
227
228options 	DRM_DEBUG
229
230#
231# Network interfaces:
232#
233
234# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
235# ed:   Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
236#       HP PC Lan+, various PC Card devices (refer to etc/defaults/pccard.conf)
237#       (requires miibus)
238# lnc:  Lance/PCnet cards (Isolan, Novell NE2100, NE32-VL, AMD Am7990 and
239#       Am79C960)
240
241#XXX#	still calls MD i386 kvtop function instead of vtophys etc
242#XXX#device		ed
243#XXX#device		lnc
244
245#XXX#device	ath
246#XXX#device	ath_hal		# Atheros HAL (includes binary component)
247device		wlan		# 802.11 layer
248
249#
250# ATA raid adapters
251#
252#XXX this stores pointers in a 32bit field that is defined by the hardware
253#device	pst
254
255#
256# 3ware 9000 series PATA/SATA RAID controller driver and options.
257# The driver is implemented as a SIM, and so, needs the CAM infrastructure.
258#
259options		TWA_DEBUG		# 0-10; 10 prints the most messages.
260options		TWA_FLASH_FIRMWARE	# firmware image bundled when defined.
261device		twa			# 3ware 9000 series PATA/SATA RAID
262
263#
264# SCSI host adapters:
265#
266# ncv: NCR 53C500 based SCSI host adapters.
267# nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters.
268# stg: TMC 18C30, 18C50 based SCSI host adapters.
269
270device		ncv
271device		nsp
272device		stg
273
274#
275# Adaptec FSA RAID controllers, including integrated DELL controllers,
276# the Dell PERC 2/QC and the HP NetRAID-4M
277device		aac
278device		aacp	# SCSI Passthrough interface (optional, CAM required)
279
280#
281# IBM (now Adaptec) ServeRAID controllers
282device		ips
283
284#
285# SafeNet crypto driver: can be moved to the MI NOTES as soon as
286# it's tested on a big-endian machine
287#
288device		safe		# SafeNet 1141
289options		SAFE_DEBUG	# enable debugging support: hw.safe.debug
290options		SAFE_RNDTEST	# enable rndtest support
291
292#####################################################################
293
294#
295# Miscellaneous hardware:
296#
297# cy: Cyclades serial driver
298# digi: Digiboard driver
299
300# Notes on the Specialix SI/XIO driver:
301#  The host card is memory, not IO mapped.
302#  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
303#  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
304#  The cards can use an IRQ of 11, 12 or 15.
305
306device		cy
307options 	CY_PCI_FASTINTR		# Use with cy_pci unless irq is shared
308device		digi
309# BIOS & FEP/OS components of device digi.
310device		digi_CX
311device		digi_CX_PCI
312device		digi_EPCX
313device		digi_EPCX_PCI
314device		digi_Xe
315device		digi_Xem
316device		digi_Xr
317# sx device is i386 and pc98 only at the moment.
318device		sx
319options 	SX_DEBUG
320# HOT1 Xilinx 6200 card (http://www.vcc.com/)
321device		xrpu
322
323#
324# Laptop/Notebook options:
325#
326
327
328#
329# I2C Bus
330#
331
332#---------------------------------------------------------------------------
333# ISDN4BSD
334#
335# See /usr/share/examples/isdn/ROADMAP for an introduction to isdn4bsd.
336#
337# i4b passive ISDN cards support contains the following hardware drivers:
338#
339#	isic  - Siemens/Infineon ISDN ISAC/HSCX/IPAC chipset driver
340#	iwic  - Winbond W6692 PCI bus ISDN S/T interface controller
341#	ifpi  - AVM Fritz!Card PCI driver
342#	ifpi2  - AVM Fritz!Card PCI version 2 driver
343#	itjc  - Siemens ISAC / TJNet Tiger300/320 chipset
344#
345# i4b active ISDN cards support contains the following hardware drivers:
346#
347#	iavc  - AVM B1 PCI, AVM B1 ISA, AVM T1
348#
349# Note that the ``options'' (if given) and ``device'' lines must BOTH
350# be uncommented to enable support for a given card !
351#
352# In addition to a hardware driver (and probably an option) the mandatory
353# ISDN protocol stack devices and the mandatory support device must be
354# enabled as well as one or more devices from the optional devices section.
355#
356#---------------------------------------------------------------------------
357#	isic driver (Siemens/Infineon chipsets)
358#
359#XXX#device	isic
360#
361# PCI bus Cards:
362# --------------
363#
364# ELSA MicroLink ISDN/PCI (same as ELSA QuickStep 1000pro PCI)
365options 	ELSA_QS1PCI
366#
367#---------------------------------------------------------------------------
368#	ifpi2 driver for AVM Fritz!Card PCI version 2
369#
370# AVM Fritz!Card PCI version 2
371#XXX#device	ifpi2
372#
373#---------------------------------------------------------------------------
374#	iwic driver for Winbond W6692 chipset
375#
376# ASUSCOM P-IN100-ST-D (and other Winbond W6692 based cards)
377#XXX#device	iwic
378#
379#---------------------------------------------------------------------------
380#	itjc driver for Siemens ISAC / TJNet Tiger300/320 chipset
381#
382# Traverse Technologies NETjet-S
383# Teles PCI-TJ
384#XXX#device	itjc
385#
386#---------------------------------------------------------------------------
387#	iavc driver (AVM active cards, needs i4bcapi driver!)
388#
389#XXX#device	iavc
390#
391#---------------------------------------------------------------------------
392#	ISDN Protocol Stack - mandatory for all hardware drivers
393#
394# Q.921 / layer 2 - i4b passive cards D channel handling
395#XXX#device	i4bq921
396#
397# Q.931 / layer 3 - i4b passive cards D channel handling
398#XXX#device	i4bq931
399#
400# layer 4 - i4b common passive and active card handling
401#XXX#device	i4b
402#
403#---------------------------------------------------------------------------
404#	ISDN devices - mandatory for all hardware drivers
405#
406# userland driver to do ISDN tracing (for passive cards only)
407#XXX#device	i4btrc
408#XXX#options	NI4BTRC=4
409#
410# userland driver to control the whole thing
411#XXX#device	i4bctl
412#
413#---------------------------------------------------------------------------
414#	ISDN devices - optional
415#
416# userland driver for access to raw B channel
417#XXX#device	i4brbch
418#XXX#options	NI4BRBCH=4
419#
420# userland driver for telephony
421#XXX#device	i4btel
422#XXX#options 	NI4BTEL=2
423#
424# network driver for IP over raw HDLC ISDN
425#XXX#device	i4bipr
426#XXX#options 	NI4BIPR=4
427# enable VJ header compression detection for ipr i/f
428options 	IPR_VJ
429# enable logging of the first n IP packets to isdnd (n=32 here)
430options 	IPR_LOG=32
431#
432# network driver for sync PPP over ISDN; requires an equivalent
433# number of sppp device to be configured
434#XXX#device	i4bisppp
435#XXX#options 	NI4BISPPP=4
436#
437# B-channel interface to the netgraph subsystem
438#XXX#device	i4bing
439#XXX#options	NI4BING=2
440#
441# CAPI driver needed for active ISDN cards (see iavc driver above)
442#XXX#device	i4bcapi
443#
444#---------------------------------------------------------------------------
445
446#
447# System Management Bus (SMB)
448#
449options 	ENABLE_ALART		# Control alarm on Intel intpm driver
450
451#
452# Set the number of PV entries per process.  Increasing this can
453# stop panics related to heavy use of shared memory.  However, that can
454# (combined with large amounts of physical memory) cause panics at
455# boot time due the kernel running out of VM space.
456#
457# If you're tweaking this, you might also want to increase the sysctls
458# "vm.v_free_min", "vm.v_free_reserved", and "vm.v_free_target".
459#
460# The value below is the one more than the default.
461#
462options 	PMAP_SHPGPERPROC=201
463
464
465#####################################################################
466# ABI Emulation
467
468#XXX keep these here for now and reactivate when support for emulating
469#XXX these 32 bit binaries is added.
470
471# Enable 32-bit runtime support for FreeBSD/i386 binaries.
472options 	COMPAT_IA32
473
474# Enable iBCS2 runtime support for SCO and ISC binaries
475#XXX#options 	IBCS2
476
477# Emulate spx device for client side of SVR3 local X interface
478#XXX#options 	SPX_HACK
479
480# Enable Linux ABI emulation
481#XXX#options 	COMPAT_LINUX
482
483# Enable 32-bit Linux ABI emulation (requires COMPAT_43 and COMPAT_IA32)
484options 	COMPAT_LINUX32
485
486# Enable the linux-like proc filesystem support (requires COMPAT_LINUX32
487# and PSEUDOFS)
488options 	LINPROCFS
489
490#
491# SysVR4 ABI emulation
492#
493# The svr4 ABI emulator can be statically compiled into the kernel or loaded as
494# a KLD module.
495# The STREAMS network emulation code can also be compiled statically or as a
496# module.  If loaded as a module, it must be loaded before the svr4 module
497# (the /usr/sbin/svr4 script does this for you).  If compiling statically,
498# the `streams' device must be configured into any kernel which also
499# specifies COMPAT_SVR4.  It is possible to have a statically-configured
500# STREAMS device and a dynamically loadable svr4 emulator;  the /usr/sbin/svr4
501# script understands that it doesn't need to load the `streams' module under
502# those circumstances.
503# Caveat:  At this time, `options KTRACE' is required for the svr4 emulator
504# (whether static or dynamic).
505#
506#XXX#options 	COMPAT_SVR4	# build emulator statically
507#XXX#options 	DEBUG_SVR4	# enable verbose debugging
508#XXX#device	streams		# STREAMS network driver (required for svr4).
509
510
511#####################################################################
512# VM OPTIONS
513
514# KSTACK_PAGES is the number of memory pages to assign to the kernel
515# stack of each thread.
516
517options 	KSTACK_PAGES=3
518
519#####################################################################
520
521# More undocumented options for linting.
522# Note that documenting these are not considered an affront.
523
524options 	FB_INSTALL_CDEV		# install a CDEV entry in /dev
525
526options 	KBDIO_DEBUG=2
527options 	KBD_MAXRETRY=4
528options 	KBD_MAXWAIT=6
529options 	KBD_RESETDELAY=201
530
531options 	PSM_DEBUG=1
532
533options 	TIMER_FREQ=((14318182+6)/12)
534
535options 	VM_KMEM_SIZE
536options 	VM_KMEM_SIZE_MAX
537options 	VM_KMEM_SIZE_SCALE
538
539
540# The I/O device
541device		io
542