xref: /freebsd/sys/amd64/conf/NOTES (revision b1ba33ffbe9c1628630362b350a1db407110a846)
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
163device		dpms		# DPMS suspend & resume via VESA BIOS
164
165# x86 real mode BIOS emulator, required by atkbdc/dpms/vesa
166options		X86BIOS
167
168#
169# Optional devices:
170#
171
172# PS/2 mouse
173device		psm
174hint.psm.0.at="atkbdc"
175hint.psm.0.irq="12"
176
177# Options for psm:
178options 	PSM_HOOKRESUME		#hook the system resume event, useful
179					#for some laptops
180options 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
181
182# The keyboard controller; it controls the keyboard and the PS/2 mouse.
183device		atkbdc
184hint.atkbdc.0.at="isa"
185hint.atkbdc.0.port="0x060"
186
187# The AT keyboard
188device		atkbd
189hint.atkbd.0.at="atkbdc"
190hint.atkbd.0.irq="1"
191
192# Options for atkbd:
193options 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
194makeoptions	ATKBD_DFLT_KEYMAP=jp.106
195
196# `flags' for atkbd:
197#       0x01    Force detection of keyboard, else we always assume a keyboard
198#       0x02    Don't reset keyboard, useful for some newer ThinkPads
199#	0x03	Force detection and avoid reset, might help with certain
200#		dockingstations
201#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
202
203# Video card driver for VGA adapters.
204device		vga
205hint.vga.0.at="isa"
206
207# Options for vga:
208# Try the following option if the mouse pointer is not drawn correctly
209# or font does not seem to be loaded properly.  May cause flicker on
210# some systems.
211options 	VGA_ALT_SEQACCESS
212
213# If you can dispense with some vga driver features, you may want to
214# use the following options to save some memory.
215#options 	VGA_NO_FONT_LOADING	# don't save/load font
216#options 	VGA_NO_MODE_CHANGE	# don't change video modes
217
218# Older video cards may require this option for proper operation.
219options 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
220
221# The following option probably won't work with the LCD displays.
222options 	VGA_WIDTH90		# support 90 column modes
223
224# Debugging.
225options 	VGA_DEBUG
226
227# Linear framebuffer driver for S3 VESA 1.2 cards. Works on top of VESA.
228device		s3pci
229
230# 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support.  This will create
231# the /dev/3dfx0 device to work with glide implementations.  This should get
232# linked to /dev/3dfx and /dev/voodoo.  Note that this is not the same as
233# the tdfx DRI module from XFree86 and is completely unrelated.
234#
235# To enable Linuxulator support, one must also include COMPAT_LINUX in the
236# config as well.  The other option is to load both as modules.
237
238device		tdfx			# Enable 3Dfx Voodoo support
239#XXX#device 	tdfx_linux		# Enable Linuxulator support
240
241#
242# ACPI support using the Intel ACPI Component Architecture reference
243# implementation.
244#
245# ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer
246# kernel environment variables to select initial debugging levels for the
247# Intel ACPICA code.  (Note that the Intel code must also have USE_DEBUGGER
248# defined when it is built).
249
250device		acpi
251options 	ACPI_DEBUG
252
253# The cpufreq(4) driver provides support for non-ACPI CPU frequency control
254device		cpufreq
255
256# Direct Rendering modules for 3D acceleration.
257device		drm		# DRM core module required by DRM drivers
258device		i915drm		# Intel i830 through i915
259device		mach64drm	# ATI Rage Pro, Rage Mobility P/M, Rage XL
260device		mgadrm		# AGP Matrox G200, G400, G450, G550
261device		r128drm		# ATI Rage 128
262device		radeondrm	# ATI Radeon
263device		savagedrm	# S3 Savage3D, Savage4
264device		sisdrm		# SiS 300/305, 540, 630
265device		tdfxdrm		# 3dfx Voodoo 3/4/5 and Banshee
266device		viadrm		# VIA
267options 	DRM_DEBUG	# Include debug printfs (slow)
268
269#
270# Network interfaces:
271#
272
273# ed:   Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
274#       HP PC Lan+, various PC Card devices
275#       (requires miibus)
276# ipw:	Intel PRO/Wireless 2100 IEEE 802.11 adapter
277# iwi:	Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters
278# iwn:	Intel Wireless WiFi Link 4965AGN 802.11 network adapters
279# nfe:	nVidia nForce MCP on-board Ethernet Networking (BSD open source)
280# nve:	nVidia nForce MCP on-board Ethernet Networking
281# wpi:	Intel 3945ABG Wireless LAN controller
282
283device		ed
284options 	ED_3C503
285options 	ED_HPP
286options 	ED_SIC
287device		iwi
288device		iwn
289device		ipw
290device		nfe
291device		nve
292device		wpi
293
294#
295#XXX this stores pointers in a 32bit field that is defined by the hardware
296#device	pst
297
298#
299# Areca 11xx and 12xx series of SATA II RAID controllers.
300# CAM is required.
301#
302device		arcmsr		# Areca SATA II RAID
303
304#
305# 3ware 9000 series PATA/SATA RAID controller driver and options.
306# The driver is implemented as a SIM, and so, needs the CAM infrastructure.
307#
308options 	TWA_DEBUG		# 0-10; 10 prints the most messages.
309options 	TWA_FLASH_FIRMWARE	# firmware image bundled when defined.
310device		twa			# 3ware 9000 series PATA/SATA RAID
311
312#
313# SCSI host adapters:
314#
315# ncv: NCR 53C500 based SCSI host adapters.
316# nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters.
317# stg: TMC 18C30, 18C50 based SCSI host adapters.
318
319device		ncv
320device		nsp
321device		stg
322
323#
324# Adaptec FSA RAID controllers, including integrated DELL controllers,
325# the Dell PERC 2/QC and the HP NetRAID-4M
326device		aac
327device		aacp	# SCSI Passthrough interface (optional, CAM required)
328
329#
330# Highpoint RocketRAID 182x.
331device		hptmv
332
333#
334# Highpoint RocketRAID.  Supports RR172x, RR222x, RR2240, RR232x, RR2340,
335# RR2210, RR174x, RR2522, RR231x, RR230x.
336device		hptrr
337
338#
339# Highpoint RocketRaid 3xxx series SATA RAID
340device		hptiop
341
342#
343# IBM (now Adaptec) ServeRAID controllers
344device		ips
345
346#
347# SafeNet crypto driver: can be moved to the MI NOTES as soon as
348# it's tested on a big-endian machine
349#
350device		safe		# SafeNet 1141
351options 	SAFE_DEBUG	# enable debugging support: hw.safe.debug
352options 	SAFE_RNDTEST	# enable rndtest support
353
354#####################################################################
355
356#
357# Miscellaneous hardware:
358#
359# ipmi: Intelligent Platform Management Interface
360# pbio: Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724)
361# smbios: DMI/SMBIOS entry point
362# vpd: Vital Product Data kernel interface
363# asmc: Apple System Management Controller
364# si: Specialix International SI/XIO or SX intelligent serial card
365
366# Notes on the Specialix SI/XIO driver:
367#  The host card is memory, not IO mapped.
368#  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
369#  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
370#  The cards can use an IRQ of 11, 12 or 15.
371
372device		ipmi
373device		pbio
374hint.pbio.0.at="isa"
375hint.pbio.0.port="0x360"
376device		smbios
377device		vpd
378device		asmc
379#device		si
380
381#
382# Laptop/Notebook options:
383#
384
385
386#
387# I2C Bus
388#
389
390#
391# Hardware watchdog timers:
392#
393# ichwd: Intel ICH watchdog timer
394# amdsbwd: AMD SB7xx watchdog timer
395#
396device		ichwd
397device		amdsbwd
398
399#
400# Temperature sensors:
401#
402# coretemp: on-die sensor on Intel Core and newer CPUs
403# amdtemp: on-die sensor on AMD K8/K10/K11 CPUs
404#
405device		coretemp
406device		amdtemp
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
512options 	NDISAPI
513device		ndis
514
515# Linux-specific pseudo devices support
516device		lindev
517