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