xref: /freebsd/sys/amd64/conf/NOTES (revision ca88a766c2e630129d5032eac7b951cc4296b201)
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# (XXX from i386:NOTES,v 1.1106; merge in updates)
7# $FreeBSD$
8#
9
10# We don't have modules on amd64.
11makeoptions	NO_MODULES=not_yet
12
13#
14# This directive is mandatory; it defines the architecture to be
15# configured for; in this case, the 386 family based IBM-PC and
16# compatibles.
17#
18machine		amd64
19
20#
21# We want LINT to cover profiling as well
22#X#profile         2
23
24
25#####################################################################
26# SMP OPTIONS:
27#
28# The apic device enables the use of the I/O APIC for interrupt delivery.
29# The apic device can be used in both UP and SMP kernels, but is required
30# for SMP kernels.  Thus, the apic device is not strictly an SMP option,
31# but it is a prerequisite for SMP.
32#
33# Notes:
34#
35# Be sure to disable 'cpu I386_CPU' for SMP kernels.
36#
37# By default, mixed mode is used to route IRQ0 from the AT timer via
38# the 8259A master PIC through the ExtINT pin on the first I/O APIC.
39# This can be disabled via the NO_MIXED_MODE option.  In that case,
40# IRQ0 will be routed via an intpin on the first I/O APIC.  Not all
41# motherboards hook IRQ0 up to the first I/O APIC even though their
42# MP table or MADT may claim to do so.  That is why mixed mode is
43# enabled by default.
44#
45
46# Optional:
47device		atpic
48device		mptable
49options 	NO_MIXED_MODE		# Disable use of mixed mode
50
51
52#####################################################################
53# CPU OPTIONS
54
55#
56# You must specify at least one CPU (the one you intend to run on);
57# deleting the specification for CPUs you don't need to use may make
58# parts of the system run faster.
59#
60cpu		HAMMER
61
62#
63# Options for CPU features.
64#
65
66#
67# PERFMON causes the driver for Pentium/Pentium Pro performance counters
68# to be compiled.  See perfmon(4) for more information.
69#
70#X#options 	PERFMON
71
72
73#####################################################################
74# NETWORKING OPTIONS
75
76#
77# DEVICE_POLLING adds support for mixed interrupt-polling handling
78# of network device drivers, which has significant benefits in terms
79# of robustness to overloads and responsivity, as well as permitting
80# accurate scheduling of the CPU time between kernel network processing
81# and other activities. The drawback is a moderate (up to 1/HZ seconds)
82# potential increase in response times.
83# It is strongly recommended to use HZ=1000 or 2000 with DEVICE_POLLING
84# to achieve smoother behaviour.
85# Additionally, you can enable/disable polling at runtime with the
86# sysctl variable kern.polling.enable (defaults off), and select
87# the CPU fraction reserved to userland with the sysctl variable
88# kern.polling.user_frac (default 50, range 0..100).
89#
90# Only the "dc" "fxp" and "sis" devices support this mode of operation at
91# the time of this writing.
92
93options 	DEVICE_POLLING
94
95
96#####################################################################
97# CLOCK OPTIONS
98
99# The following options are used for debugging clock behavior only, and
100# should not be used for production systems.
101#
102# CLK_CALIBRATION_LOOP will run the clock calibration loop at startup
103# until the user presses a key.
104
105options 	CLK_CALIBRATION_LOOP
106
107# The following two options measure the frequency of the corresponding
108# clock relative to the RTC (onboard mc146818a).
109
110options 	CLK_USE_I8254_CALIBRATION
111options 	CLK_USE_TSC_CALIBRATION
112
113
114#####################################################################
115# MISCELLANEOUS DEVICES AND OPTIONS
116
117device		gzip		#Exec gzipped a.out's. REQUIRES COMPAT_AOUT!
118
119
120#####################################################################
121# HARDWARE BUS CONFIGURATION
122
123#
124# ISA bus
125#
126device		isa
127
128#
129# Options for `isa':
130#
131# AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A
132# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
133# This option breaks suspend/resume on some portables.
134#
135# AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A
136# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
137# Automatic EOI is documented not to work for for the slave with the
138# original i8259A, but it works for some clones and some integrated
139# versions.
140#
141# MAXMEM specifies the amount of RAM on the machine; if this is not
142# specified, FreeBSD will first read the amount of memory from the CMOS
143# RAM, so the amount of memory will initially be limited to 64MB or 16MB
144# depending on the BIOS.  If the BIOS reports 64MB, a memory probe will
145# then attempt to detect the installed amount of RAM.  If this probe
146# fails to detect >64MB RAM you will have to use the MAXMEM option.
147# The amount is in kilobytes, so for a machine with 128MB of RAM, it would
148# be 131072 (128 * 1024).
149#
150# BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
151# reset the CPU for reboot.  This is needed on some systems with broken
152# keyboard controllers.
153
154options 	AUTO_EOI_1
155#options 	AUTO_EOI_2
156
157options 	MAXMEM=(128*1024)
158#options 	BROKEN_KEYBOARD_RESET
159
160#
161# PCI bus & PCI options:
162#
163device		pci
164
165#
166# AGP GART support
167device		agp
168
169
170#####################################################################
171# HARDWARE DEVICE CONFIGURATION
172
173#
174# Mandatory devices:
175#
176
177#
178# Optional devices:
179#
180
181# 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support. This will create
182# the /dev/3dfx0 device to work with glide implementations. This should get
183# linked to /dev/3dfx and /dev/voodoo. Note that this is not the same as
184# the tdfx DRI module from XFree86 and is completely unrelated.
185#
186# To enable Linuxulator support, one must also include COMPAT_LINUX in the
187# config as well, or you will not have the dependencies. The other option
188# is to load both as modules.
189
190device 		tdfx			# Enable 3Dfx Voodoo support
191#X#options 	TDFX_LINUX		# Enable Linuxulator support
192
193#
194# ACPI support using the Intel ACPI Component Architecture reference
195# implementation.
196#
197# ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer
198# kernel environment variables to select initial debugging levels for the
199# Intel ACPICA code.  (Note that the Intel code must also have USE_DEBUGGER
200# defined when it is built).
201#
202# ACPI_MAX_THREADS sets the number of task threads started.
203#
204# ACPI_NO_SEMAPHORES makes the AcpiOs*Semaphore routines a no-op.
205#
206# ACPICA_PEDANTIC enables strict checking of AML.  Our default is to
207# relax these checks to allow code generated by the Microsoft compiler
208# to still execute.
209#
210# Note that building ACPI into the kernel is deprecated; the module is
211# normally loaded automatically by the loader.
212#
213device		acpi
214options 	ACPI_DEBUG
215options 	ACPI_MAX_THREADS=1
216#!options 	ACPI_NO_SEMAPHORES
217#!options 	ACPICA_PEDANTIC
218
219# DRM options:
220# mgadrm:    AGP Matrox G200, G400, G450, G550
221# r128drm:   ATI Rage 128
222# radeondrm: ATI Radeon up to 9000/9100
223# sisdrm:    SiS 300/305,540,630
224# tdfxdrm:   3dfx Voodoo 3/4/5 and Banshee
225# DRM_DEBUG: include debug printfs, very slow
226#
227# mga requires AGP in the kernel, and it is recommended
228# for AGP r128 and radeon cards.
229
230device		mgadrm
231device		"r128drm"
232device		radeondrm
233device		sisdrm
234device		tdfxdrm
235
236options 	DRM_DEBUG
237
238#
239# Network interfaces:
240#
241
242# ath:	Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
243
244#X#device	ath
245#X#device	ath_hal		# Atheros HAL (includes binary component)
246device		wlan		# 802.11 layer
247
248#
249# ATA raid adapters
250#
251#XXX this stores pointers in a 32bit field that is defined by the hardware
252#device	pst
253
254#
255# SCSI host adapters:
256#
257
258#
259# Adaptec FSA RAID controllers, including integrated DELL controllers,
260# the Dell PERC 2/QC and the HP NetRAID-4M
261device		aac
262device		aacp	# SCSI Passthrough interface (optional, CAM required)
263
264#
265# IBM (now Adaptec) ServeRAID controllers
266device		ips
267
268#
269# SafeNet crypto driver: can be moved to the MI NOTES as soon as
270# it's tested on a big-endian machine
271#
272device		safe		# SafeNet 1141
273options		SAFE_DEBUG	# enable debugging support: hw.safe.debug
274options		SAFE_RNDTEST	# enable rndtest support
275
276#####################################################################
277
278#
279# Miscellaneous hardware:
280#
281# digi: Digiboard driver
282
283# Notes on the Specialix SI/XIO driver:
284#  The host card is memory, not IO mapped.
285#  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
286#  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
287#  The cards can use an IRQ of 11, 12 or 15.
288
289device		digi
290hint.digi.0.at="isa"
291hint.digi.0.port="0x104"
292hint.digi.0.maddr="0xd0000"
293# BIOS & FEP/OS components of device digi.
294device		digi_CX
295device		digi_CX_PCI
296device		digi_EPCX
297device		digi_EPCX_PCI
298device		digi_Xe
299device		digi_Xem
300device		digi_Xr
301# HOT1 Xilinx 6200 card (http://www.vcc.com/)
302device		xrpu
303
304#
305# Laptop/Notebook options:
306#
307
308
309#
310# I2C Bus
311#
312
313#---------------------------------------------------------------------------
314
315#
316# Set the number of PV entries per process.  Increasing this can
317# stop panics related to heavy use of shared memory. However, that can
318# (combined with large amounts of physical memory) cause panics at
319# boot time due the kernel running out of VM space.
320#
321# If you're tweaking this, you might also want to increase the sysctls
322# "vm.v_free_min", "vm.v_free_reserved", and "vm.v_free_target".
323#
324# The value below is the one more than the default.
325#
326options 	PMAP_SHPGPERPROC=201
327
328
329#####################################################################
330# ABI Emulation
331
332#XXX keep these here for now and reactivate when support for emulating
333#XXX these 32 bit binaries is added.
334
335# Enable iBCS2 runtime support for SCO and ISC binaries
336#X#options 	IBCS2
337
338# Emulate spx device for client side of SVR3 local X interface
339#X#options 	SPX_HACK
340
341# Enable Linux ABI emulation
342#X#options 	COMPAT_LINUX
343
344# Enable the linux-like proc filesystem support (requires COMPAT_LINUX
345# and PSEUDOFS)
346#X#options 	LINPROCFS
347
348#
349# SysVR4 ABI emulation
350#
351# The svr4 ABI emulator can be statically compiled into the kernel or loaded as
352# a KLD module.
353# The STREAMS network emulation code can also be compiled statically or as a
354# module.  If loaded as a module, it must be loaded before the svr4 module
355# (the /usr/sbin/svr4 script does this for you).  If compiling statically,
356# the `streams' device must be configured into any kernel which also
357# specifies COMPAT_SVR4.  It is possible to have a statically-configured
358# STREAMS device and a dynamically loadable svr4 emulator;  the /usr/sbin/svr4
359# script understands that it doesn't need to load the `streams' module under
360# those circumstances.
361# Caveat:  At this time, `options KTRACE' is required for the svr4 emulator
362# (whether static or dynamic).
363#
364#X#options 	COMPAT_SVR4	# build emulator statically
365#X#options 	DEBUG_SVR4	# enable verbose debugging
366#X#device	streams		# STREAMS network driver (required for svr4).
367
368
369#####################################################################
370# VM OPTIONS
371
372# KSTACK_PAGES is the number of memory pages to assign to the kernel
373# stack of each thread.
374
375options 	KSTACK_PAGES=3
376
377#####################################################################
378
379# More undocumented options for linting.
380# Note that documenting these are not considered an affront.
381
382options 	FB_INSTALL_CDEV		# install a CDEV entry in /dev
383
384# PECOFF module (Win32 Execution Format)
385#X#options 	PECOFF_SUPPORT
386#X#options 	PECOFF_DEBUG
387
388options 	ENABLE_ALART
389options 	KBDIO_DEBUG=2
390options 	KBD_MAXRETRY=4
391options 	KBD_MAXWAIT=6
392options 	KBD_RESETDELAY=201
393
394options 	PSM_DEBUG=1
395
396options 	TIMER_FREQ=((14318182+6)/12)
397
398options 	VM_KMEM_SIZE
399options 	VM_KMEM_SIZE_MAX
400options 	VM_KMEM_SIZE_SCALE
401
402###############################################################
403# Broken stuff that shouldn't really be broken
404
405# machine/ioctl_meteor.h and machine/bt848.h
406nodevice	bktr
407
408# pointer/int stuff
409nodevice	mgadrm
410nodevice	"r128drm"
411nodevice	radeondrm
412nodevice	sisdrm
413nodevice	tdfxdrm
414
415# missing conf lines (must be fixed ASAP)
416nooption	SC_DFLT_FONT
417nooption	UKBD_DFLT_KEYMAP
418nooption	ATKBD_DFLT_KEYMAP
419nooption 	PMAP_SHPGPERPROC
420nooption 	CLK_USE_I8254_CALIBRATION
421# XXX dead option
422nooption 	CLK_USE_TSC_CALIBRATION
423