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