xref: /freebsd/sys/amd64/conf/NOTES (revision 6abad12dfea75d99e30475e48fd5e38f9c8b2de2)
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# We want LINT to cover profiling as well.
12profile         2
13
14
15#####################################################################
16# SMP OPTIONS:
17#
18# Notes:
19#
20# IPI_PREEMPTION instructs the kernel to preempt threads running on other
21#	  CPUS if needed.  Relies on the PREEMPTION option
22
23# Optional:
24options 	IPI_PREEMPTION
25device		atpic			# Optional legacy pic support
26device		mptable			# Optional MPSPEC mptable support
27
28#
29# Watchdog routines.
30#
31options 	MP_WATCHDOG
32
33
34
35#####################################################################
36# CPU OPTIONS
37
38#
39# You must specify at least one CPU (the one you intend to run on);
40# deleting the specification for CPUs you don't need to use may make
41# parts of the system run faster.
42#
43cpu		HAMMER			# aka K8, aka Opteron & Athlon64
44
45#
46# Options for CPU features.
47#
48
49#
50# PERFMON causes the driver for Pentium/Pentium Pro performance counters
51# to be compiled.  See perfmon(4) for more information.
52#
53#XXX#options 	PERFMON
54
55
56#####################################################################
57# NETWORKING OPTIONS
58
59#
60# DEVICE_POLLING adds support for mixed interrupt-polling handling
61# of network device drivers, which has significant benefits in terms
62# of robustness to overloads and responsivity, as well as permitting
63# accurate scheduling of the CPU time between kernel network processing
64# and other activities.  The drawback is a moderate (up to 1/HZ seconds)
65# potential increase in response times.
66# It is strongly recommended to use HZ=1000 or 2000 with DEVICE_POLLING
67# to achieve smoother behaviour.
68# Additionally, you can enable/disable polling at runtime with help of
69# the ifconfig(8) utility, and select the CPU fraction reserved to
70# userland with the sysctl variable kern.polling.user_frac
71# (default 50, range 0..100).
72#
73# Not all device drivers support this mode of operation at the time of
74# this writing.  See polling(4) for more details.
75
76options 	DEVICE_POLLING
77
78# BPF_JITTER adds support for BPF just-in-time compiler.
79
80options 	BPF_JITTER
81
82
83#####################################################################
84# CLOCK OPTIONS
85
86# Provide read/write access to the memory in the clock chip.
87device		nvram		# Access to rtc cmos via /dev/nvram
88
89
90#####################################################################
91# MISCELLANEOUS DEVICES AND OPTIONS
92
93device		speaker		#Play IBM BASIC-style noises out your speaker
94hint.speaker.0.at="isa"
95hint.speaker.0.port="0x61"
96device		gzip		#Exec gzipped a.out's.  REQUIRES COMPAT_AOUT!
97
98
99#####################################################################
100# HARDWARE BUS CONFIGURATION
101
102#
103# ISA bus
104#
105device		isa
106
107#
108# Options for `isa':
109#
110# AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A
111# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
112# This option breaks suspend/resume on some portables.
113#
114# AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A
115# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
116# Automatic EOI is documented not to work for for the slave with the
117# original i8259A, but it works for some clones and some integrated
118# versions.
119#
120# MAXMEM specifies the amount of RAM on the machine; if this is not
121# specified, FreeBSD will first read the amount of memory from the CMOS
122# RAM, so the amount of memory will initially be limited to 64MB or 16MB
123# depending on the BIOS.  If the BIOS reports 64MB, a memory probe will
124# then attempt to detect the installed amount of RAM.  If this probe
125# fails to detect >64MB RAM you will have to use the MAXMEM option.
126# The amount is in kilobytes, so for a machine with 128MB of RAM, it would
127# be 131072 (128 * 1024).
128#
129# BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
130# reset the CPU for reboot.  This is needed on some systems with broken
131# keyboard controllers.
132
133options 	AUTO_EOI_1
134#options 	AUTO_EOI_2
135
136options 	MAXMEM=(128*1024)
137#options 	BROKEN_KEYBOARD_RESET
138
139#
140# PCI bus & PCI options:
141#
142device		pci
143
144#
145# AGP GART support
146device		agp
147
148#
149# AGP debugging.
150#
151options 	AGP_DEBUG
152
153
154#####################################################################
155# HARDWARE DEVICE CONFIGURATION
156
157# To include support for VGA VESA video modes
158options 	VESA
159
160# Turn on extra debugging checks and output for VESA support.
161options 	VESA_DEBUG
162
163#
164# Optional devices:
165#
166
167# PS/2 mouse
168device		psm
169hint.psm.0.at="atkbdc"
170hint.psm.0.irq="12"
171
172# Options for psm:
173options 	PSM_HOOKRESUME		#hook the system resume event, useful
174					#for some laptops
175options 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
176
177# The keyboard controller; it controls the keyboard and the PS/2 mouse.
178device		atkbdc
179hint.atkbdc.0.at="isa"
180hint.atkbdc.0.port="0x060"
181
182# The AT keyboard
183device		atkbd
184hint.atkbd.0.at="atkbdc"
185hint.atkbd.0.irq="1"
186
187# Options for atkbd:
188options 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
189makeoptions	ATKBD_DFLT_KEYMAP=jp.106
190
191# `flags' for atkbd:
192#       0x01    Force detection of keyboard, else we always assume a keyboard
193#       0x02    Don't reset keyboard, useful for some newer ThinkPads
194#	0x03	Force detection and avoid reset, might help with certain
195#		dockingstations
196#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
197
198# Video card driver for VGA adapters.
199device		vga
200hint.vga.0.at="isa"
201
202# Options for vga:
203# Try the following option if the mouse pointer is not drawn correctly
204# or font does not seem to be loaded properly.  May cause flicker on
205# some systems.
206options 	VGA_ALT_SEQACCESS
207
208# If you can dispense with some vga driver features, you may want to
209# use the following options to save some memory.
210#options 	VGA_NO_FONT_LOADING	# don't save/load font
211#options 	VGA_NO_MODE_CHANGE	# don't change video modes
212
213# Older video cards may require this option for proper operation.
214options 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
215
216# The following option probably won't work with the LCD displays.
217options 	VGA_WIDTH90		# support 90 column modes
218
219# Debugging.
220options 	VGA_DEBUG
221
222# Linear framebuffer driver for S3 VESA 1.2 cards. Works on top of VESA.
223device		s3pci
224
225# 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support.  This will create
226# the /dev/3dfx0 device to work with glide implementations.  This should get
227# linked to /dev/3dfx and /dev/voodoo.  Note that this is not the same as
228# the tdfx DRI module from XFree86 and is completely unrelated.
229#
230# To enable Linuxulator support, one must also include COMPAT_LINUX in the
231# config as well.  The other option is to load both as modules.
232
233device		tdfx			# Enable 3Dfx Voodoo support
234#XXX#device 	tdfx_linux		# Enable Linuxulator support
235
236#
237# ACPI support using the Intel ACPI Component Architecture reference
238# implementation.
239#
240# ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer
241# kernel environment variables to select initial debugging levels for the
242# Intel ACPICA code.  (Note that the Intel code must also have USE_DEBUGGER
243# defined when it is built).
244
245device		acpi
246options 	ACPI_DEBUG
247
248# The cpufreq(4) driver provides support for non-ACPI CPU frequency control
249device		cpufreq
250
251# Direct Rendering modules for 3D acceleration.
252device		drm		# DRM core module required by DRM drivers
253device		i915drm		# Intel i830 through i915
254device		mach64drm	# ATI Rage Pro, Rage Mobility P/M, Rage XL
255device		mgadrm		# AGP Matrox G200, G400, G450, G550
256device		r128drm		# ATI Rage 128
257device		radeondrm	# ATI Radeon
258device		savagedrm	# S3 Savage3D, Savage4
259device		sisdrm		# SiS 300/305, 540, 630
260device		tdfxdrm		# 3dfx Voodoo 3/4/5 and Banshee
261options 	DRM_DEBUG	# Include debug printfs (slow)
262
263#
264# Network interfaces:
265#
266
267# ed:   Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
268#       HP PC Lan+, various PC Card devices
269#       (requires miibus)
270# ipw:	Intel PRO/Wireless 2100 IEEE 802.11 adapter
271# iwi:	Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters
272# iwn:	Intel Wireless WiFi Link 4965AGN 802.11 network adapters
273# nfe:	nVidia nForce MCP on-board Ethernet Networking (BSD open source)
274# nve:	nVidia nForce MCP on-board Ethernet Networking
275# ral:	Ralink Technology IEEE 802.11 wireless adapter
276# wpi:	Intel 3945ABG Wireless LAN controller
277
278device		ed
279options 	ED_3C503
280options 	ED_HPP
281options 	ED_SIC
282device		iwi
283device		iwn
284device		ipw
285device		nfe
286device		nve
287device		ral
288device		wpi
289
290device		ath			# Atheros pci/cardbus NIC's
291device		ath_hal			# pci/cardbus chip support
292options 	AH_SUPPORT_AR5416	# enable AR5416 tx/rx descriptors
293device		ath_rate_sample		# SampleRate tx rate control for ath
294#device		ath_rate_amrr		# AMRR rate control for ath driver
295#device		ath_rate_onoe		# Onoe rate control for ath driver
296
297#
298#XXX this stores pointers in a 32bit field that is defined by the hardware
299#device	pst
300
301#
302# Areca 11xx and 12xx series of SATA II RAID controllers.
303# CAM is required.
304#
305device		arcmsr		# Areca SATA II RAID
306
307#
308# 3ware 9000 series PATA/SATA RAID controller driver and options.
309# The driver is implemented as a SIM, and so, needs the CAM infrastructure.
310#
311options 	TWA_DEBUG		# 0-10; 10 prints the most messages.
312options 	TWA_FLASH_FIRMWARE	# firmware image bundled when defined.
313device		twa			# 3ware 9000 series PATA/SATA RAID
314
315#
316# SCSI host adapters:
317#
318# ncv: NCR 53C500 based SCSI host adapters.
319# nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters.
320# stg: TMC 18C30, 18C50 based SCSI host adapters.
321
322device		ncv
323device		nsp
324device		stg
325
326#
327# Adaptec FSA RAID controllers, including integrated DELL controllers,
328# the Dell PERC 2/QC and the HP NetRAID-4M
329device		aac
330device		aacp	# SCSI Passthrough interface (optional, CAM required)
331
332#
333# Highpoint RocketRAID 182x.
334device		hptmv
335
336#
337# Highpoint RocketRAID.  Supports RR172x, RR222x, RR2240, RR232x, RR2340,
338# RR2210, RR174x, RR2522, RR231x, RR230x.
339device		hptrr
340
341#
342# Highpoint RocketRaid 3xxx series SATA RAID
343device		hptiop
344
345#
346# IBM (now Adaptec) ServeRAID controllers
347device		ips
348
349#
350# SafeNet crypto driver: can be moved to the MI NOTES as soon as
351# it's tested on a big-endian machine
352#
353device		safe		# SafeNet 1141
354options 	SAFE_DEBUG	# enable debugging support: hw.safe.debug
355options 	SAFE_RNDTEST	# enable rndtest support
356
357#####################################################################
358
359#
360# Miscellaneous hardware:
361#
362# ipmi: Intelligent Platform Management Interface
363# pbio: Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724)
364# smbios: DMI/SMBIOS entry point
365# vpd: Vital Product Data kernel interface
366# asmc: Apple System Management Controller
367# si: Specialix International SI/XIO or SX intelligent serial card
368
369# Notes on the Specialix SI/XIO driver:
370#  The host card is memory, not IO mapped.
371#  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
372#  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
373#  The cards can use an IRQ of 11, 12 or 15.
374
375device		ipmi
376device		pbio
377hint.pbio.0.at="isa"
378hint.pbio.0.port="0x360"
379device		smbios
380device		vpd
381device		asmc
382#device		si
383
384#
385# Laptop/Notebook options:
386#
387
388
389#
390# I2C Bus
391#
392
393#
394# Hardware watchdog timers:
395#
396# ichwd: Intel ICH watchdog timer
397#
398device		ichwd
399
400#
401# Temperature sensors:
402#
403# coretemp: on-die sensor on Intel Core and newer CPUs
404# amdtemp: on-die sensor on AMD K8/K10/K11 CPUs
405#
406device		coretemp
407device		amdtemp
408
409#
410# CPU control pseudo-device. Provides access to MSRs, CPUID info and
411# microcode update feature.
412#
413device		cpuctl
414
415#
416# System Management Bus (SMB)
417#
418options 	ENABLE_ALART		# Control alarm on Intel intpm driver
419
420#
421# Set the number of PV entries per process.  Increasing this can
422# stop panics related to heavy use of shared memory.  However, that can
423# (combined with large amounts of physical memory) cause panics at
424# boot time due the kernel running out of VM space.
425#
426# If you're tweaking this, you might also want to increase the sysctls
427# "vm.v_free_min", "vm.v_free_reserved", and "vm.v_free_target".
428#
429# The value below is the one more than the default.
430#
431options 	PMAP_SHPGPERPROC=201
432
433
434#####################################################################
435# ABI Emulation
436
437#XXX keep these here for now and reactivate when support for emulating
438#XXX these 32 bit binaries is added.
439
440# Enable 32-bit runtime support for FreeBSD/i386 binaries.
441options 	COMPAT_IA32
442
443# Enable iBCS2 runtime support for SCO and ISC binaries
444#XXX#options 	IBCS2
445
446# Emulate spx device for client side of SVR3 local X interface
447#XXX#options 	SPX_HACK
448
449# Enable Linux ABI emulation
450#XXX#options 	COMPAT_LINUX
451
452# Enable 32-bit Linux ABI emulation (requires COMPAT_43 and COMPAT_IA32)
453options 	COMPAT_LINUX32
454
455# Enable the linux-like proc filesystem support (requires COMPAT_LINUX32
456# and PSEUDOFS)
457options 	LINPROCFS
458
459#Enable the linux-like sys filesystem support (requires COMPAT_LINUX32
460# and PSEUDOFS)
461options 	LINSYSFS
462
463#
464# SysVR4 ABI emulation
465#
466# The svr4 ABI emulator can be statically compiled into the kernel or loaded as
467# a KLD module.
468# The STREAMS network emulation code can also be compiled statically or as a
469# module.  If loaded as a module, it must be loaded before the svr4 module
470# (the /usr/sbin/svr4 script does this for you).  If compiling statically,
471# the `streams' device must be configured into any kernel which also
472# specifies COMPAT_SVR4.  It is possible to have a statically-configured
473# STREAMS device and a dynamically loadable svr4 emulator;  the /usr/sbin/svr4
474# script understands that it doesn't need to load the `streams' module under
475# those circumstances.
476# Caveat:  At this time, `options KTRACE' is required for the svr4 emulator
477# (whether static or dynamic).
478#
479#XXX#options 	COMPAT_SVR4	# build emulator statically
480#XXX#options 	DEBUG_SVR4	# enable verbose debugging
481#XXX#device	streams		# STREAMS network driver (required for svr4).
482
483
484#####################################################################
485# VM OPTIONS
486
487# KSTACK_PAGES is the number of memory pages to assign to the kernel
488# stack of each thread.
489
490options 	KSTACK_PAGES=3
491
492#####################################################################
493
494# More undocumented options for linting.
495# Note that documenting these are not considered an affront.
496
497options 	FB_INSTALL_CDEV		# install a CDEV entry in /dev
498
499options 	KBDIO_DEBUG=2
500options 	KBD_MAXRETRY=4
501options 	KBD_MAXWAIT=6
502options 	KBD_RESETDELAY=201
503
504options 	PSM_DEBUG=1
505
506options 	TIMER_FREQ=((14318182+6)/12)
507
508options 	VM_KMEM_SIZE
509options 	VM_KMEM_SIZE_MAX
510options 	VM_KMEM_SIZE_SCALE
511
512# Enable NDIS binary driver support
513options 	NDISAPI
514device		ndis
515