xref: /freebsd/sys/amd64/conf/NOTES (revision d429ea332342fcb98d27a350d0c4944bf9aec3f9)
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# Notes:
25#
26# IPI_PREEMPTION instructs the kernel to preempt threads running on other
27#	  CPUS if needed.  Relies on the PREEMPTION option
28
29# Optional:
30options 	IPI_PREEMPTION
31device		atpic			# Optional legacy pic support
32device		mptable			# Optional MPSPEC mptable support
33
34#
35# Watchdog routines.
36#
37options 	MP_WATCHDOG
38
39#
40# Debugging options.
41#
42options		KDB_STOP_NMI		# Stop CPUS using NMI instead of IPI
43
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_NO_SEMAPHORES makes the AcpiOs*Semaphore routines a no-op.
192#
193# ACPICA_PEDANTIC enables strict checking of AML.  Our default is to
194# relax these checks to allow code generated by the Microsoft compiler
195# to still execute.
196#
197# Note that building ACPI into the kernel is deprecated; the module is
198# normally loaded automatically by the loader.
199
200device		acpi
201options 	ACPI_DEBUG
202#!options 	ACPI_NO_SEMAPHORES
203#!options 	ACPICA_PEDANTIC
204
205# Direct Rendering modules for 3D acceleration.
206device		drm		# DRM core module required by DRM drivers
207device		mach64drm	# ATI Rage Pro, Rage Mobility P/M, Rage XL
208device		mgadrm		# AGP Matrox G200, G400, G450, G550
209device		r128drm		# ATI Rage 128
210device		radeondrm	# ATI Radeon up to 9200
211device		sisdrm		# SiS 300/305, 540, 630
212device		tdfxdrm		# 3dfx Voodoo 3/4/5 and Banshee
213options 	DRM_DEBUG	# Include debug printfs (slow)
214
215#
216# Network interfaces:
217#
218
219# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
220# ed:   Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
221#       HP PC Lan+, various PC Card devices (refer to etc/defaults/pccard.conf)
222#       (requires miibus)
223# lnc:  Lance/PCnet cards (Isolan, Novell NE2100, NE32-VL, AMD Am7990 and
224#       Am79C960)
225
226#XXX#	still calls MD i386 kvtop function instead of vtophys etc
227#XXX#device		ed
228#XXX#device		lnc
229
230#XXX#device	ath
231#XXX#device	ath_hal		# Atheros HAL (includes binary component)
232device		wlan		# 802.11 layer
233
234#
235# ATA raid adapters
236#
237#XXX this stores pointers in a 32bit field that is defined by the hardware
238#device	pst
239
240#
241# Areca 11xx and 12xx series of SATA II RAID controllers.
242# CAM is required.
243#
244device		arcmsr		# Areca SATA II RAID
245
246#
247# 3ware 9000 series PATA/SATA RAID controller driver and options.
248# The driver is implemented as a SIM, and so, needs the CAM infrastructure.
249#
250options 	TWA_DEBUG		# 0-10; 10 prints the most messages.
251options 	TWA_FLASH_FIRMWARE	# firmware image bundled when defined.
252device		twa			# 3ware 9000 series PATA/SATA RAID
253
254#
255# SCSI host adapters:
256#
257# ncv: NCR 53C500 based SCSI host adapters.
258# nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters.
259# stg: TMC 18C30, 18C50 based SCSI host adapters.
260
261device		ncv
262device		nsp
263device		stg
264
265#
266# Adaptec FSA RAID controllers, including integrated DELL controllers,
267# the Dell PERC 2/QC and the HP NetRAID-4M
268device		aac
269device		aacp	# SCSI Passthrough interface (optional, CAM required)
270
271#
272# IBM (now Adaptec) ServeRAID controllers
273device		ips
274
275#
276# SafeNet crypto driver: can be moved to the MI NOTES as soon as
277# it's tested on a big-endian machine
278#
279device		safe		# SafeNet 1141
280options 	SAFE_DEBUG	# enable debugging support: hw.safe.debug
281options 	SAFE_RNDTEST	# enable rndtest support
282
283#####################################################################
284
285#
286# Miscellaneous hardware:
287#
288# cy: Cyclades serial driver
289# digi: Digiboard driver
290
291# Notes on the Specialix SI/XIO driver:
292#  The host card is memory, not IO mapped.
293#  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
294#  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
295#  The cards can use an IRQ of 11, 12 or 15.
296
297device		cy
298options 	CY_PCI_FASTINTR		# Use with cy_pci unless irq is shared
299device		digi
300# BIOS & FEP/OS components of device digi.
301device		digi_CX
302device		digi_CX_PCI
303device		digi_EPCX
304device		digi_EPCX_PCI
305device		digi_Xe
306device		digi_Xem
307device		digi_Xr
308# sx device is i386 and pc98 only at the moment.
309device		sx
310options 	SX_DEBUG
311# HOT1 Xilinx 6200 card (http://www.vcc.com/)
312device		xrpu
313
314#
315# Laptop/Notebook options:
316#
317
318
319#
320# I2C Bus
321#
322
323#---------------------------------------------------------------------------
324# ISDN4BSD
325#
326# See /usr/share/examples/isdn/ROADMAP for an introduction to isdn4bsd.
327#
328# i4b passive ISDN cards support contains the following hardware drivers:
329#
330#	isic  - Siemens/Infineon ISDN ISAC/HSCX/IPAC chipset driver
331#	iwic  - Winbond W6692 PCI bus ISDN S/T interface controller
332#	ifpi  - AVM Fritz!Card PCI driver
333#	ifpi2  - AVM Fritz!Card PCI version 2 driver
334#	itjc  - Siemens ISAC / TJNet Tiger300/320 chipset
335#
336# i4b active ISDN cards support contains the following hardware drivers:
337#
338#	iavc  - AVM B1 PCI, AVM B1 ISA, AVM T1
339#
340# Note that the ``options'' (if given) and ``device'' lines must BOTH
341# be uncommented to enable support for a given card !
342#
343# In addition to a hardware driver (and probably an option) the mandatory
344# ISDN protocol stack devices and the mandatory support device must be
345# enabled as well as one or more devices from the optional devices section.
346#
347#---------------------------------------------------------------------------
348#	isic driver (Siemens/Infineon chipsets)
349#
350#XXX#device	isic
351#
352# PCI bus Cards:
353# --------------
354#
355# ELSA MicroLink ISDN/PCI (same as ELSA QuickStep 1000pro PCI)
356options 	ELSA_QS1PCI
357#
358#---------------------------------------------------------------------------
359#	ifpi2 driver for AVM Fritz!Card PCI version 2
360#
361# AVM Fritz!Card PCI version 2
362#XXX#device	ifpi2
363#
364#---------------------------------------------------------------------------
365#	iwic driver for Winbond W6692 chipset
366#
367# ASUSCOM P-IN100-ST-D (and other Winbond W6692 based cards)
368#XXX#device	iwic
369#
370#---------------------------------------------------------------------------
371#	itjc driver for Siemens ISAC / TJNet Tiger300/320 chipset
372#
373# Traverse Technologies NETjet-S
374# Teles PCI-TJ
375#XXX#device	itjc
376#
377#---------------------------------------------------------------------------
378#	iavc driver (AVM active cards, needs i4bcapi driver!)
379#
380#XXX#device	iavc
381#
382#---------------------------------------------------------------------------
383#	ISDN Protocol Stack - mandatory for all hardware drivers
384#
385# Q.921 / layer 2 - i4b passive cards D channel handling
386#XXX#device	i4bq921
387#
388# Q.931 / layer 3 - i4b passive cards D channel handling
389#XXX#device	i4bq931
390#
391# layer 4 - i4b common passive and active card handling
392#XXX#device	i4b
393#
394#---------------------------------------------------------------------------
395#	ISDN devices - mandatory for all hardware drivers
396#
397# userland driver to do ISDN tracing (for passive cards only)
398#XXX#device	i4btrc
399#XXX#options 	NI4BTRC=4
400#
401# userland driver to control the whole thing
402#XXX#device	i4bctl
403#
404#---------------------------------------------------------------------------
405#	ISDN devices - optional
406#
407# userland driver for access to raw B channel
408#XXX#device	i4brbch
409#XXX#options 	NI4BRBCH=4
410#
411# userland driver for telephony
412#XXX#device	i4btel
413#XXX#options 	NI4BTEL=2
414#
415# network driver for IP over raw HDLC ISDN
416#XXX#device	i4bipr
417#XXX#options 	NI4BIPR=4
418# enable VJ header compression detection for ipr i/f
419options 	IPR_VJ
420# enable logging of the first n IP packets to isdnd (n=32 here)
421options 	IPR_LOG=32
422#
423# network driver for sync PPP over ISDN; requires an equivalent
424# number of sppp device to be configured
425#XXX#device	i4bisppp
426#XXX#options 	NI4BISPPP=4
427#
428# B-channel interface to the netgraph subsystem
429#XXX#device	i4bing
430#XXX#options 	NI4BING=2
431#
432# CAPI driver needed for active ISDN cards (see iavc driver above)
433#XXX#device	i4bcapi
434#
435#---------------------------------------------------------------------------
436
437#
438# System Management Bus (SMB)
439#
440options 	ENABLE_ALART		# Control alarm on Intel intpm driver
441
442#
443# Set the number of PV entries per process.  Increasing this can
444# stop panics related to heavy use of shared memory.  However, that can
445# (combined with large amounts of physical memory) cause panics at
446# boot time due the kernel running out of VM space.
447#
448# If you're tweaking this, you might also want to increase the sysctls
449# "vm.v_free_min", "vm.v_free_reserved", and "vm.v_free_target".
450#
451# The value below is the one more than the default.
452#
453options 	PMAP_SHPGPERPROC=201
454
455
456#####################################################################
457# ABI Emulation
458
459#XXX keep these here for now and reactivate when support for emulating
460#XXX these 32 bit binaries is added.
461
462# Enable 32-bit runtime support for FreeBSD/i386 binaries.
463options 	COMPAT_IA32
464
465# Enable iBCS2 runtime support for SCO and ISC binaries
466#XXX#options 	IBCS2
467
468# Emulate spx device for client side of SVR3 local X interface
469#XXX#options 	SPX_HACK
470
471# Enable Linux ABI emulation
472#XXX#options 	COMPAT_LINUX
473
474# Enable 32-bit Linux ABI emulation (requires COMPAT_43 and COMPAT_IA32)
475options 	COMPAT_LINUX32
476
477# Enable the linux-like proc filesystem support (requires COMPAT_LINUX32
478# and PSEUDOFS)
479options 	LINPROCFS
480
481#
482# SysVR4 ABI emulation
483#
484# The svr4 ABI emulator can be statically compiled into the kernel or loaded as
485# a KLD module.
486# The STREAMS network emulation code can also be compiled statically or as a
487# module.  If loaded as a module, it must be loaded before the svr4 module
488# (the /usr/sbin/svr4 script does this for you).  If compiling statically,
489# the `streams' device must be configured into any kernel which also
490# specifies COMPAT_SVR4.  It is possible to have a statically-configured
491# STREAMS device and a dynamically loadable svr4 emulator;  the /usr/sbin/svr4
492# script understands that it doesn't need to load the `streams' module under
493# those circumstances.
494# Caveat:  At this time, `options KTRACE' is required for the svr4 emulator
495# (whether static or dynamic).
496#
497#XXX#options 	COMPAT_SVR4	# build emulator statically
498#XXX#options 	DEBUG_SVR4	# enable verbose debugging
499#XXX#device	streams		# STREAMS network driver (required for svr4).
500
501
502#####################################################################
503# VM OPTIONS
504
505# KSTACK_PAGES is the number of memory pages to assign to the kernel
506# stack of each thread.
507
508options 	KSTACK_PAGES=3
509
510#####################################################################
511
512# More undocumented options for linting.
513# Note that documenting these are not considered an affront.
514
515options 	FB_INSTALL_CDEV		# install a CDEV entry in /dev
516
517options 	KBDIO_DEBUG=2
518options 	KBD_MAXRETRY=4
519options 	KBD_MAXWAIT=6
520options 	KBD_RESETDELAY=201
521
522options 	PSM_DEBUG=1
523
524options 	TIMER_FREQ=((14318182+6)/12)
525
526options 	VM_KMEM_SIZE
527options 	VM_KMEM_SIZE_MAX
528options 	VM_KMEM_SIZE_SCALE
529
530
531# The I/O device
532device		io
533