xref: /freebsd/sys/amd64/conf/NOTES (revision 830940567b49bb0c08dfaed40418999e76616909)
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#
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
236device		acpi
237options 	ACPI_DEBUG
238
239# The cpufreq(4) driver provides support for non-ACPI CPU frequency control
240device		cpufreq
241
242# Direct Rendering modules for 3D acceleration.
243device		drm		# DRM core module required by DRM drivers
244device		i915drm		# Intel i830 through i915
245device		mach64drm	# ATI Rage Pro, Rage Mobility P/M, Rage XL
246device		mgadrm		# AGP Matrox G200, G400, G450, G550
247device		r128drm		# ATI Rage 128
248device		radeondrm	# ATI Radeon
249device		savagedrm	# S3 Savage3D, Savage4
250device		sisdrm		# SiS 300/305, 540, 630
251device		tdfxdrm		# 3dfx Voodoo 3/4/5 and Banshee
252options 	DRM_DEBUG	# Include debug printfs (slow)
253
254#
255# Network interfaces:
256#
257
258# ed:   Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
259#       HP PC Lan+, various PC Card devices
260#       (requires miibus)
261# ipw:	Intel PRO/Wireless 2100 IEEE 802.11 adapter
262# iwi:	Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters
263# iwn:	Intel Wireless WiFi Link 4965AGN 802.11 network adapters
264# nfe:	nVidia nForce MCP on-board Ethernet Networking (BSD open source)
265# nve:	nVidia nForce MCP on-board Ethernet Networking
266# ral:	Ralink Technology IEEE 802.11 wireless adapter
267# wpi:	Intel 3945ABG Wireless LAN controller
268
269device		ed
270options 	ED_3C503
271options 	ED_HPP
272options 	ED_SIC
273device		iwi
274device		iwn
275device		ipw
276device		nfe
277device		nve
278device		ral
279device		wpi
280
281device		ath			# Atheros pci/cardbus NIC's
282device		ath_hal			# pci/cardbus chip support
283options 	AH_SUPPORT_AR5416	# enable AR5416 tx/rx descriptors
284device		ath_rate_sample		# SampleRate tx rate control for ath
285#device		ath_rate_amrr		# AMRR rate control for ath driver
286#device		ath_rate_onoe		# Onoe rate control for ath driver
287
288#
289#XXX this stores pointers in a 32bit field that is defined by the hardware
290#device	pst
291
292#
293# Areca 11xx and 12xx series of SATA II RAID controllers.
294# CAM is required.
295#
296device		arcmsr		# Areca SATA II RAID
297
298#
299# 3ware 9000 series PATA/SATA RAID controller driver and options.
300# The driver is implemented as a SIM, and so, needs the CAM infrastructure.
301#
302options 	TWA_DEBUG		# 0-10; 10 prints the most messages.
303options 	TWA_FLASH_FIRMWARE	# firmware image bundled when defined.
304device		twa			# 3ware 9000 series PATA/SATA RAID
305
306#
307# SCSI host adapters:
308#
309# ncv: NCR 53C500 based SCSI host adapters.
310# nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters.
311# stg: TMC 18C30, 18C50 based SCSI host adapters.
312
313device		ncv
314device		nsp
315device		stg
316
317#
318# Adaptec FSA RAID controllers, including integrated DELL controllers,
319# the Dell PERC 2/QC and the HP NetRAID-4M
320device		aac
321device		aacp	# SCSI Passthrough interface (optional, CAM required)
322
323#
324# Highpoint RocketRAID 182x.
325device		hptmv
326
327#
328# Highpoint RocketRAID.  Supports RR172x, RR222x, RR2240, RR232x, RR2340,
329# RR2210, RR174x, RR2522, RR231x, RR230x.
330device		hptrr
331
332#
333# Highpoint RocketRaid 3xxx series SATA RAID
334device		hptiop
335
336#
337# IBM (now Adaptec) ServeRAID controllers
338device		ips
339
340#
341# SafeNet crypto driver: can be moved to the MI NOTES as soon as
342# it's tested on a big-endian machine
343#
344device		safe		# SafeNet 1141
345options 	SAFE_DEBUG	# enable debugging support: hw.safe.debug
346options 	SAFE_RNDTEST	# enable rndtest support
347
348#####################################################################
349
350#
351# Miscellaneous hardware:
352#
353# ipmi: Intelligent Platform Management Interface
354# pbio: Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724)
355# smbios: DMI/SMBIOS entry point
356# vpd: Vital Product Data kernel interface
357# asmc: Apple System Management Controller
358# si: Specialix International SI/XIO or SX intelligent serial card
359
360# Notes on the Specialix SI/XIO driver:
361#  The host card is memory, not IO mapped.
362#  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
363#  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
364#  The cards can use an IRQ of 11, 12 or 15.
365
366device		ipmi
367device		pbio
368hint.pbio.0.at="isa"
369hint.pbio.0.port="0x360"
370device		smbios
371device		vpd
372device		asmc
373#device		si
374
375#
376# Laptop/Notebook options:
377#
378
379
380#
381# I2C Bus
382#
383
384#
385# Hardware watchdog timers:
386#
387# ichwd: Intel ICH watchdog timer
388#
389device		ichwd
390
391#
392# Temperature sensors:
393#
394# coretemp: on-die sensor on Intel Core and newer CPUs
395# amdtemp: on-die sensor on AMD K8/K10/K11 CPUs
396#
397device		coretemp
398device		amdtemp
399
400#
401# CPU control pseudo-device. Provides access to MSRs, CPUID info and
402# microcode update feature.
403#
404device		cpuctl
405
406#
407# System Management Bus (SMB)
408#
409options 	ENABLE_ALART		# Control alarm on Intel intpm driver
410
411#
412# Set the number of PV entries per process.  Increasing this can
413# stop panics related to heavy use of shared memory.  However, that can
414# (combined with large amounts of physical memory) cause panics at
415# boot time due the kernel running out of VM space.
416#
417# If you're tweaking this, you might also want to increase the sysctls
418# "vm.v_free_min", "vm.v_free_reserved", and "vm.v_free_target".
419#
420# The value below is the one more than the default.
421#
422options 	PMAP_SHPGPERPROC=201
423
424
425#####################################################################
426# ABI Emulation
427
428#XXX keep these here for now and reactivate when support for emulating
429#XXX these 32 bit binaries is added.
430
431# Enable 32-bit runtime support for FreeBSD/i386 binaries.
432options 	COMPAT_IA32
433
434# Enable iBCS2 runtime support for SCO and ISC binaries
435#XXX#options 	IBCS2
436
437# Emulate spx device for client side of SVR3 local X interface
438#XXX#options 	SPX_HACK
439
440# Enable Linux ABI emulation
441#XXX#options 	COMPAT_LINUX
442
443# Enable 32-bit Linux ABI emulation (requires COMPAT_43 and COMPAT_IA32)
444options 	COMPAT_LINUX32
445
446# Enable the linux-like proc filesystem support (requires COMPAT_LINUX32
447# and PSEUDOFS)
448options 	LINPROCFS
449
450#Enable the linux-like sys filesystem support (requires COMPAT_LINUX32
451# and PSEUDOFS)
452options 	LINSYSFS
453
454#
455# SysVR4 ABI emulation
456#
457# The svr4 ABI emulator can be statically compiled into the kernel or loaded as
458# a KLD module.
459# The STREAMS network emulation code can also be compiled statically or as a
460# module.  If loaded as a module, it must be loaded before the svr4 module
461# (the /usr/sbin/svr4 script does this for you).  If compiling statically,
462# the `streams' device must be configured into any kernel which also
463# specifies COMPAT_SVR4.  It is possible to have a statically-configured
464# STREAMS device and a dynamically loadable svr4 emulator;  the /usr/sbin/svr4
465# script understands that it doesn't need to load the `streams' module under
466# those circumstances.
467# Caveat:  At this time, `options KTRACE' is required for the svr4 emulator
468# (whether static or dynamic).
469#
470#XXX#options 	COMPAT_SVR4	# build emulator statically
471#XXX#options 	DEBUG_SVR4	# enable verbose debugging
472#XXX#device	streams		# STREAMS network driver (required for svr4).
473
474
475#####################################################################
476# VM OPTIONS
477
478# KSTACK_PAGES is the number of memory pages to assign to the kernel
479# stack of each thread.
480
481options 	KSTACK_PAGES=3
482
483#####################################################################
484
485# More undocumented options for linting.
486# Note that documenting these are not considered an affront.
487
488options 	FB_INSTALL_CDEV		# install a CDEV entry in /dev
489
490options 	KBDIO_DEBUG=2
491options 	KBD_MAXRETRY=4
492options 	KBD_MAXWAIT=6
493options 	KBD_RESETDELAY=201
494
495options 	PSM_DEBUG=1
496
497options 	TIMER_FREQ=((14318182+6)/12)
498
499options 	VM_KMEM_SIZE
500options 	VM_KMEM_SIZE_MAX
501options 	VM_KMEM_SIZE_SCALE
502
503# Enable NDIS binary driver support
504options 	NDISAPI
505device		ndis
506