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