xref: /freebsd/sys/amd64/conf/NOTES (revision 3157ba21)
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#	Requires the ipw firmware module
278# iwi:	Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters
279#	Requires the iwi firmware module
280# iwn:	Intel Wireless WiFi Link 4965/1000/5000/6000 802.11 network adapters
281#	Requires the iwn firmware module
282# mwl:	Marvell 88W8363 IEEE 802.11 adapter
283#	Requires the mwl firmware module
284# nfe:	nVidia nForce MCP on-board Ethernet Networking (BSD open source)
285# nve:	nVidia nForce MCP on-board Ethernet Networking
286# wpi:	Intel 3945ABG Wireless LAN controller
287#	Requires the wpi firmware module
288
289device		ed
290options 	ED_3C503
291options 	ED_HPP
292options 	ED_SIC
293device		ipw
294device		iwi
295device		iwn
296device		mwl
297device		nfe
298device		nve
299device		wpi
300
301# IEEE 802.11 adapter firmware modules
302
303# Intel PRO/Wireless 2100 firmware:
304#   ipwfw:		BSS/IBSS/monitor mode firmware
305#   ipwbssfw:		BSS mode firmware
306#   ipwibssfw:		IBSS mode firmware
307#   ipwmonitorfw:	Monitor mode firmware
308# Intel PRO/Wireless 2200BG/2225BG/2915ABG firmware:
309#   iwifw:		BSS/IBSS/monitor mode firmware
310#   iwibssfw:		BSS mode firmware
311#   iwiibssfw:		IBSS mode firmware
312#   iwimonitorfw:	Monitor mode firmware
313# Intel Wireless WiFi Link 4965/1000/5000/6000 series firmware:
314#   iwnfw:		Single module to support the 4965/1000/5000/5150/6000
315#   iwn4965fw:		Specific module for the 4965 only
316#   iwn1000fw:		Specific module for the 1000 only
317#   iwn5000fw:		Specific module for the 5000 only
318#   iwn5150fw:		Specific module for the 5150 only
319#   iwn6000fw:		Specific module for the 6000 only
320# mwlfw:	Marvell 88W8363 firmware
321# wpifw:	Intel 3945ABG Wireless LAN Controller firmware
322
323device		iwifw
324device		iwibssfw
325device		iwiibssfw
326device		iwimonitorfw
327device		ipwfw
328device		ipwbssfw
329device		ipwibssfw
330device		ipwmonitorfw
331device		iwnfw
332device		iwn4965fw
333device		iwn1000fw
334device		iwn5000fw
335device		iwn5150fw
336device		iwn6000fw
337device		mwlfw
338device		wpifw
339
340#
341#XXX this stores pointers in a 32bit field that is defined by the hardware
342#device	pst
343
344#
345# Areca 11xx and 12xx series of SATA II RAID controllers.
346# CAM is required.
347#
348device		arcmsr		# Areca SATA II RAID
349
350#
351# 3ware 9000 series PATA/SATA RAID controller driver and options.
352# The driver is implemented as a SIM, and so, needs the CAM infrastructure.
353#
354options 	TWA_DEBUG		# 0-10; 10 prints the most messages.
355options 	TWA_FLASH_FIRMWARE	# firmware image bundled when defined.
356device		twa			# 3ware 9000 series PATA/SATA RAID
357
358#
359# SCSI host adapters:
360#
361# ncv: NCR 53C500 based SCSI host adapters.
362# nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters.
363# stg: TMC 18C30, 18C50 based SCSI host adapters.
364
365device		ncv
366device		nsp
367device		stg
368
369#
370# Adaptec FSA RAID controllers, including integrated DELL controllers,
371# the Dell PERC 2/QC and the HP NetRAID-4M
372device		aac
373device		aacp	# SCSI Passthrough interface (optional, CAM required)
374
375#
376# Highpoint RocketRAID 182x.
377device		hptmv
378
379#
380# Highpoint RocketRAID.  Supports RR172x, RR222x, RR2240, RR232x, RR2340,
381# RR2210, RR174x, RR2522, RR231x, RR230x.
382device		hptrr
383
384#
385# Highpoint RocketRaid 3xxx series SATA RAID
386device		hptiop
387
388#
389# IBM (now Adaptec) ServeRAID controllers
390device		ips
391
392#
393# SafeNet crypto driver: can be moved to the MI NOTES as soon as
394# it's tested on a big-endian machine
395#
396device		safe		# SafeNet 1141
397options 	SAFE_DEBUG	# enable debugging support: hw.safe.debug
398options 	SAFE_RNDTEST	# enable rndtest support
399
400#####################################################################
401
402#
403# Miscellaneous hardware:
404#
405# ipmi: Intelligent Platform Management Interface
406# pbio: Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724)
407# smbios: DMI/SMBIOS entry point
408# vpd: Vital Product Data kernel interface
409# asmc: Apple System Management Controller
410# si: Specialix International SI/XIO or SX intelligent serial card
411
412# Notes on the Specialix SI/XIO driver:
413#  The host card is memory, not IO mapped.
414#  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
415#  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
416#  The cards can use an IRQ of 11, 12 or 15.
417
418device		ipmi
419device		pbio
420hint.pbio.0.at="isa"
421hint.pbio.0.port="0x360"
422device		smbios
423device		vpd
424device		asmc
425#device		si
426
427#
428# Laptop/Notebook options:
429#
430
431
432#
433# I2C Bus
434#
435
436#
437# Hardware watchdog timers:
438#
439# ichwd: Intel ICH watchdog timer
440# amdsbwd: AMD SB7xx watchdog timer
441#
442device		ichwd
443device		amdsbwd
444
445#
446# Temperature sensors:
447#
448# coretemp: on-die sensor on Intel Core and newer CPUs
449# amdtemp: on-die sensor on AMD K8/K10/K11 CPUs
450#
451device		coretemp
452device		amdtemp
453
454#
455# CPU control pseudo-device. Provides access to MSRs, CPUID info and
456# microcode update feature.
457#
458device		cpuctl
459
460#
461# System Management Bus (SMB)
462#
463options 	ENABLE_ALART		# Control alarm on Intel intpm driver
464
465#
466# Set the number of PV entries per process.  Increasing this can
467# stop panics related to heavy use of shared memory.  However, that can
468# (combined with large amounts of physical memory) cause panics at
469# boot time due the kernel running out of VM space.
470#
471# If you're tweaking this, you might also want to increase the sysctls
472# "vm.v_free_min", "vm.v_free_reserved", and "vm.v_free_target".
473#
474# The value below is the one more than the default.
475#
476options 	PMAP_SHPGPERPROC=201
477
478
479#####################################################################
480# ABI Emulation
481
482#XXX keep these here for now and reactivate when support for emulating
483#XXX these 32 bit binaries is added.
484
485# Enable 32-bit runtime support for FreeBSD/i386 binaries.
486options 	COMPAT_FREEBSD32
487
488# Enable iBCS2 runtime support for SCO and ISC binaries
489#XXX#options 	IBCS2
490
491# Emulate spx device for client side of SVR3 local X interface
492#XXX#options 	SPX_HACK
493
494# Enable Linux ABI emulation
495#XXX#options 	COMPAT_LINUX
496
497# Enable 32-bit Linux ABI emulation (requires COMPAT_43 and COMPAT_FREEBSD32)
498options 	COMPAT_LINUX32
499
500# Enable the linux-like proc filesystem support (requires COMPAT_LINUX32
501# and PSEUDOFS)
502options 	LINPROCFS
503
504#Enable the linux-like sys filesystem support (requires COMPAT_LINUX32
505# and PSEUDOFS)
506options 	LINSYSFS
507
508#
509# SysVR4 ABI emulation
510#
511# The svr4 ABI emulator can be statically compiled into the kernel or loaded as
512# a KLD module.
513# The STREAMS network emulation code can also be compiled statically or as a
514# module.  If loaded as a module, it must be loaded before the svr4 module
515# (the /usr/sbin/svr4 script does this for you).  If compiling statically,
516# the `streams' device must be configured into any kernel which also
517# specifies COMPAT_SVR4.  It is possible to have a statically-configured
518# STREAMS device and a dynamically loadable svr4 emulator;  the /usr/sbin/svr4
519# script understands that it doesn't need to load the `streams' module under
520# those circumstances.
521# Caveat:  At this time, `options KTRACE' is required for the svr4 emulator
522# (whether static or dynamic).
523#
524#XXX#options 	COMPAT_SVR4	# build emulator statically
525#XXX#options 	DEBUG_SVR4	# enable verbose debugging
526#XXX#device	streams		# STREAMS network driver (required for svr4).
527
528
529#####################################################################
530# VM OPTIONS
531
532# KSTACK_PAGES is the number of memory pages to assign to the kernel
533# stack of each thread.
534
535options 	KSTACK_PAGES=3
536
537#####################################################################
538
539# More undocumented options for linting.
540# Note that documenting these are not considered an affront.
541
542options 	FB_INSTALL_CDEV		# install a CDEV entry in /dev
543
544options 	KBDIO_DEBUG=2
545options 	KBD_MAXRETRY=4
546options 	KBD_MAXWAIT=6
547options 	KBD_RESETDELAY=201
548
549options 	PSM_DEBUG=1
550
551options 	TIMER_FREQ=((14318182+6)/12)
552
553options 	VM_KMEM_SIZE
554options 	VM_KMEM_SIZE_MAX
555options 	VM_KMEM_SIZE_SCALE
556
557# Enable NDIS binary driver support
558options 	NDISAPI
559device		ndis
560
561# Linux-specific pseudo devices support
562device		lindev
563