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