xref: /freebsd/sys/amd64/conf/NOTES (revision 884a2a699669ec61e2366e3e358342dbc94be24a)
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# Enable the kernel DTrace hooks which are required to load the DTrace
16# kernel modules.
17#
18options 	KDTRACE_HOOKS
19
20
21#####################################################################
22# SMP OPTIONS:
23#
24# Notes:
25#
26# IPI_PREEMPTION instructs the kernel to preempt threads running on other
27#	  CPUS if needed.  Relies on the PREEMPTION option
28
29# Optional:
30options 	IPI_PREEMPTION
31device		atpic			# Optional legacy pic support
32device		mptable			# Optional MPSPEC mptable support
33
34#
35# Watchdog routines.
36#
37options 	MP_WATCHDOG
38
39# Debugging options.
40#
41options 	COUNT_XINVLTLB_HITS	# Counters for TLB events
42options 	COUNT_IPIS		# Per-CPU IPI interrupt counters
43
44
45
46#####################################################################
47# CPU OPTIONS
48
49#
50# You must specify at least one CPU (the one you intend to run on);
51# deleting the specification for CPUs you don't need to use may make
52# parts of the system run faster.
53#
54cpu		HAMMER			# aka K8, aka Opteron & Athlon64
55
56#
57# Options for CPU features.
58#
59
60#
61# PERFMON causes the driver for Pentium/Pentium Pro performance counters
62# to be compiled.  See perfmon(4) for more information.
63#
64#XXX#options 	PERFMON
65
66
67#####################################################################
68# NETWORKING OPTIONS
69
70#
71# DEVICE_POLLING adds support for mixed interrupt-polling handling
72# of network device drivers, which has significant benefits in terms
73# of robustness to overloads and responsivity, as well as permitting
74# accurate scheduling of the CPU time between kernel network processing
75# and other activities.  The drawback is a moderate (up to 1/HZ seconds)
76# potential increase in response times.
77# It is strongly recommended to use HZ=1000 or 2000 with DEVICE_POLLING
78# to achieve smoother behaviour.
79# Additionally, you can enable/disable polling at runtime with help of
80# the ifconfig(8) utility, and select the CPU fraction reserved to
81# userland with the sysctl variable kern.polling.user_frac
82# (default 50, range 0..100).
83#
84# Not all device drivers support this mode of operation at the time of
85# this writing.  See polling(4) for more details.
86
87options 	DEVICE_POLLING
88
89# BPF_JITTER adds support for BPF just-in-time compiler.
90
91options 	BPF_JITTER
92
93
94#####################################################################
95# CLOCK OPTIONS
96
97# Provide read/write access to the memory in the clock chip.
98device		nvram		# Access to rtc cmos via /dev/nvram
99
100
101#####################################################################
102# MISCELLANEOUS DEVICES AND OPTIONS
103
104device		speaker		#Play IBM BASIC-style noises out your speaker
105hint.speaker.0.at="isa"
106hint.speaker.0.port="0x61"
107device		gzip		#Exec gzipped a.out's.  REQUIRES COMPAT_AOUT!
108
109
110#####################################################################
111# HARDWARE BUS CONFIGURATION
112
113#
114# ISA bus
115#
116device		isa
117
118#
119# Options for `isa':
120#
121# AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A
122# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
123# This option breaks suspend/resume on some portables.
124#
125# AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A
126# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
127# Automatic EOI is documented not to work for for the slave with the
128# original i8259A, but it works for some clones and some integrated
129# versions.
130#
131# MAXMEM specifies the amount of RAM on the machine; if this is not
132# specified, FreeBSD will first read the amount of memory from the CMOS
133# RAM, so the amount of memory will initially be limited to 64MB or 16MB
134# depending on the BIOS.  If the BIOS reports 64MB, a memory probe will
135# then attempt to detect the installed amount of RAM.  If this probe
136# fails to detect >64MB RAM you will have to use the MAXMEM option.
137# The amount is in kilobytes, so for a machine with 128MB of RAM, it would
138# be 131072 (128 * 1024).
139#
140# BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
141# reset the CPU for reboot.  This is needed on some systems with broken
142# keyboard controllers.
143
144options 	AUTO_EOI_1
145#options 	AUTO_EOI_2
146
147options 	MAXMEM=(128*1024)
148#options 	BROKEN_KEYBOARD_RESET
149
150#
151# PCI bus & PCI options:
152#
153device		pci
154
155#
156# AGP GART support
157device		agp
158
159#
160# AGP debugging.
161#
162options 	AGP_DEBUG
163
164
165#####################################################################
166# HARDWARE DEVICE CONFIGURATION
167
168# To include support for VGA VESA video modes
169options 	VESA
170
171# Turn on extra debugging checks and output for VESA support.
172options 	VESA_DEBUG
173
174device		dpms		# DPMS suspend & resume via VESA BIOS
175
176# x86 real mode BIOS emulator, required by atkbdc/dpms/vesa
177options		X86BIOS
178
179#
180# Optional devices:
181#
182
183# PS/2 mouse
184device		psm
185hint.psm.0.at="atkbdc"
186hint.psm.0.irq="12"
187
188# Options for psm:
189options 	PSM_HOOKRESUME		#hook the system resume event, useful
190					#for some laptops
191options 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
192
193# The keyboard controller; it controls the keyboard and the PS/2 mouse.
194device		atkbdc
195hint.atkbdc.0.at="isa"
196hint.atkbdc.0.port="0x060"
197
198# The AT keyboard
199device		atkbd
200hint.atkbd.0.at="atkbdc"
201hint.atkbd.0.irq="1"
202
203# Options for atkbd:
204options 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
205makeoptions	ATKBD_DFLT_KEYMAP=jp.106
206
207# `flags' for atkbd:
208#       0x01    Force detection of keyboard, else we always assume a keyboard
209#       0x02    Don't reset keyboard, useful for some newer ThinkPads
210#	0x03	Force detection and avoid reset, might help with certain
211#		dockingstations
212#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
213
214# Video card driver for VGA adapters.
215device		vga
216hint.vga.0.at="isa"
217
218# Options for vga:
219# Try the following option if the mouse pointer is not drawn correctly
220# or font does not seem to be loaded properly.  May cause flicker on
221# some systems.
222options 	VGA_ALT_SEQACCESS
223
224# If you can dispense with some vga driver features, you may want to
225# use the following options to save some memory.
226#options 	VGA_NO_FONT_LOADING	# don't save/load font
227#options 	VGA_NO_MODE_CHANGE	# don't change video modes
228
229# Older video cards may require this option for proper operation.
230options 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
231
232# The following option probably won't work with the LCD displays.
233options 	VGA_WIDTH90		# support 90 column modes
234
235# Debugging.
236options 	VGA_DEBUG
237
238# Linear framebuffer driver for S3 VESA 1.2 cards. Works on top of VESA.
239device		s3pci
240
241# 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support.  This will create
242# the /dev/3dfx0 device to work with glide implementations.  This should get
243# linked to /dev/3dfx and /dev/voodoo.  Note that this is not the same as
244# the tdfx DRI module from XFree86 and is completely unrelated.
245#
246# To enable Linuxulator support, one must also include COMPAT_LINUX in the
247# config as well.  The other option is to load both as modules.
248
249device		tdfx			# Enable 3Dfx Voodoo support
250#XXX#device 	tdfx_linux		# Enable Linuxulator support
251
252#
253# ACPI support using the Intel ACPI Component Architecture reference
254# implementation.
255#
256# ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer
257# kernel environment variables to select initial debugging levels for the
258# Intel ACPICA code.  (Note that the Intel code must also have USE_DEBUGGER
259# defined when it is built).
260
261device		acpi
262options 	ACPI_DEBUG
263
264# The cpufreq(4) driver provides support for non-ACPI CPU frequency control
265device		cpufreq
266
267# Direct Rendering modules for 3D acceleration.
268device		drm		# DRM core module required by DRM drivers
269device		i915drm		# Intel i830 through i915
270device		mach64drm	# ATI Rage Pro, Rage Mobility P/M, Rage XL
271device		mgadrm		# AGP Matrox G200, G400, G450, G550
272device		r128drm		# ATI Rage 128
273device		radeondrm	# ATI Radeon
274device		savagedrm	# S3 Savage3D, Savage4
275device		sisdrm		# SiS 300/305, 540, 630
276device		tdfxdrm		# 3dfx Voodoo 3/4/5 and Banshee
277device		viadrm		# VIA
278options 	DRM_DEBUG	# Include debug printfs (slow)
279
280#
281# Network interfaces:
282#
283
284# ed:   Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
285#       HP PC Lan+, various PC Card devices
286#       (requires miibus)
287# ipw:	Intel PRO/Wireless 2100 IEEE 802.11 adapter
288#	Requires the ipw firmware module
289# iwi:	Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters
290#	Requires the iwi firmware module
291# iwn:	Intel Wireless WiFi Link 4965/1000/5000/6000 802.11 network adapters
292#	Requires the iwn firmware module
293# mwl:	Marvell 88W8363 IEEE 802.11 adapter
294#	Requires the mwl firmware module
295# nfe:	nVidia nForce MCP on-board Ethernet Networking (BSD open source)
296# nve:	nVidia nForce MCP on-board Ethernet Networking
297# wpi:	Intel 3945ABG Wireless LAN controller
298#	Requires the wpi firmware module
299
300device		ed
301options 	ED_3C503
302options 	ED_HPP
303options 	ED_SIC
304device		ipw
305device		iwi
306device		iwn
307device		mwl
308device		nfe
309device		nve
310device		wpi
311
312# IEEE 802.11 adapter firmware modules
313
314# Intel PRO/Wireless 2100 firmware:
315#   ipwfw:		BSS/IBSS/monitor mode firmware
316#   ipwbssfw:		BSS mode firmware
317#   ipwibssfw:		IBSS mode firmware
318#   ipwmonitorfw:	Monitor mode firmware
319# Intel PRO/Wireless 2200BG/2225BG/2915ABG firmware:
320#   iwifw:		BSS/IBSS/monitor mode firmware
321#   iwibssfw:		BSS mode firmware
322#   iwiibssfw:		IBSS mode firmware
323#   iwimonitorfw:	Monitor mode firmware
324# Intel Wireless WiFi Link 4965/1000/5000/6000 series firmware:
325#   iwnfw:		Single module to support the 4965/1000/5000/5150/6000
326#   iwn4965fw:		Specific module for the 4965 only
327#   iwn1000fw:		Specific module for the 1000 only
328#   iwn5000fw:		Specific module for the 5000 only
329#   iwn5150fw:		Specific module for the 5150 only
330#   iwn6000fw:		Specific module for the 6000 only
331#   iwn6050fw:		Specific module for the 6050 only
332# mwlfw:	Marvell 88W8363 firmware
333# wpifw:	Intel 3945ABG Wireless LAN Controller firmware
334
335device		iwifw
336device		iwibssfw
337device		iwiibssfw
338device		iwimonitorfw
339device		ipwfw
340device		ipwbssfw
341device		ipwibssfw
342device		ipwmonitorfw
343device		iwnfw
344device		iwn4965fw
345device		iwn1000fw
346device		iwn5000fw
347device		iwn5150fw
348device		iwn6000fw
349device		iwn6050fw
350device		mwlfw
351device		wpifw
352
353#
354#XXX this stores pointers in a 32bit field that is defined by the hardware
355#device	pst
356
357#
358# Areca 11xx and 12xx series of SATA II RAID controllers.
359# CAM is required.
360#
361device		arcmsr		# Areca SATA II RAID
362
363#
364# 3ware 9000 series PATA/SATA RAID controller driver and options.
365# The driver is implemented as a SIM, and so, needs the CAM infrastructure.
366#
367options 	TWA_DEBUG		# 0-10; 10 prints the most messages.
368options 	TWA_FLASH_FIRMWARE	# firmware image bundled when defined.
369device		twa			# 3ware 9000 series PATA/SATA RAID
370
371#
372# SCSI host adapters:
373#
374# ncv: NCR 53C500 based SCSI host adapters.
375# nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters.
376# stg: TMC 18C30, 18C50 based SCSI host adapters.
377
378device		ncv
379device		nsp
380device		stg
381
382#
383# Adaptec FSA RAID controllers, including integrated DELL controllers,
384# the Dell PERC 2/QC and the HP NetRAID-4M
385device		aac
386device		aacp	# SCSI Passthrough interface (optional, CAM required)
387
388#
389# Highpoint RocketRAID 182x.
390device		hptmv
391
392#
393# Highpoint RocketRAID.  Supports RR172x, RR222x, RR2240, RR232x, RR2340,
394# RR2210, RR174x, RR2522, RR231x, RR230x.
395device		hptrr
396
397#
398# Highpoint RocketRaid 3xxx series SATA RAID
399device		hptiop
400
401#
402# IBM (now Adaptec) ServeRAID controllers
403device		ips
404
405#
406# SafeNet crypto driver: can be moved to the MI NOTES as soon as
407# it's tested on a big-endian machine
408#
409device		safe		# SafeNet 1141
410options 	SAFE_DEBUG	# enable debugging support: hw.safe.debug
411options 	SAFE_RNDTEST	# enable rndtest support
412
413#####################################################################
414
415#
416# Miscellaneous hardware:
417#
418# ipmi: Intelligent Platform Management Interface
419# pbio: Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724)
420# smbios: DMI/SMBIOS entry point
421# vpd: Vital Product Data kernel interface
422# asmc: Apple System Management Controller
423# si: Specialix International SI/XIO or SX intelligent serial card
424# tpm: Trusted Platform Module
425
426# Notes on the Specialix SI/XIO driver:
427#  The host card is memory, not IO mapped.
428#  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
429#  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
430#  The cards can use an IRQ of 11, 12 or 15.
431
432device		ipmi
433device		pbio
434hint.pbio.0.at="isa"
435hint.pbio.0.port="0x360"
436device		smbios
437device		vpd
438device		asmc
439#device		si
440device		tpm
441
442#
443# Laptop/Notebook options:
444#
445
446
447#
448# I2C Bus
449#
450
451#
452# Hardware watchdog timers:
453#
454# ichwd: Intel ICH watchdog timer
455# amdsbwd: AMD SB7xx watchdog timer
456#
457device		ichwd
458device		amdsbwd
459
460#
461# Temperature sensors:
462#
463# coretemp: on-die sensor on Intel Core and newer CPUs
464# amdtemp: on-die sensor on AMD K8/K10/K11 CPUs
465#
466device		coretemp
467device		amdtemp
468
469#
470# CPU control pseudo-device. Provides access to MSRs, CPUID info and
471# microcode update feature.
472#
473device		cpuctl
474
475#
476# System Management Bus (SMB)
477#
478options 	ENABLE_ALART		# Control alarm on Intel intpm driver
479
480#
481# Set the number of PV entries per process.  Increasing this can
482# stop panics related to heavy use of shared memory.  However, that can
483# (combined with large amounts of physical memory) cause panics at
484# boot time due the kernel running out of VM space.
485#
486# If you're tweaking this, you might also want to increase the sysctls
487# "vm.v_free_min", "vm.v_free_reserved", and "vm.v_free_target".
488#
489# The value below is the one more than the default.
490#
491options 	PMAP_SHPGPERPROC=201
492
493
494#####################################################################
495# ABI Emulation
496
497#XXX keep these here for now and reactivate when support for emulating
498#XXX these 32 bit binaries is added.
499
500# Enable 32-bit runtime support for FreeBSD/i386 binaries.
501options 	COMPAT_FREEBSD32
502
503# Enable iBCS2 runtime support for SCO and ISC binaries
504#XXX#options 	IBCS2
505
506# Emulate spx device for client side of SVR3 local X interface
507#XXX#options 	SPX_HACK
508
509# Enable Linux ABI emulation
510#XXX#options 	COMPAT_LINUX
511
512# Enable 32-bit Linux ABI emulation (requires COMPAT_43 and COMPAT_FREEBSD32)
513options 	COMPAT_LINUX32
514
515# Enable the linux-like proc filesystem support (requires COMPAT_LINUX32
516# and PSEUDOFS)
517options 	LINPROCFS
518
519#Enable the linux-like sys filesystem support (requires COMPAT_LINUX32
520# and PSEUDOFS)
521options 	LINSYSFS
522
523#
524# SysVR4 ABI emulation
525#
526# The svr4 ABI emulator can be statically compiled into the kernel or loaded as
527# a KLD module.
528# The STREAMS network emulation code can also be compiled statically or as a
529# module.  If loaded as a module, it must be loaded before the svr4 module
530# (the /usr/sbin/svr4 script does this for you).  If compiling statically,
531# the `streams' device must be configured into any kernel which also
532# specifies COMPAT_SVR4.  It is possible to have a statically-configured
533# STREAMS device and a dynamically loadable svr4 emulator;  the /usr/sbin/svr4
534# script understands that it doesn't need to load the `streams' module under
535# those circumstances.
536# Caveat:  At this time, `options KTRACE' is required for the svr4 emulator
537# (whether static or dynamic).
538#
539#XXX#options 	COMPAT_SVR4	# build emulator statically
540#XXX#options 	DEBUG_SVR4	# enable verbose debugging
541#XXX#device	streams		# STREAMS network driver (required for svr4).
542
543
544#####################################################################
545# VM OPTIONS
546
547# KSTACK_PAGES is the number of memory pages to assign to the kernel
548# stack of each thread.
549
550options 	KSTACK_PAGES=5
551
552#####################################################################
553
554# More undocumented options for linting.
555# Note that documenting these are not considered an affront.
556
557options 	FB_INSTALL_CDEV		# install a CDEV entry in /dev
558
559options 	KBDIO_DEBUG=2
560options 	KBD_MAXRETRY=4
561options 	KBD_MAXWAIT=6
562options 	KBD_RESETDELAY=201
563
564options 	PSM_DEBUG=1
565
566options 	TIMER_FREQ=((14318182+6)/12)
567
568options 	VM_KMEM_SIZE
569options 	VM_KMEM_SIZE_MAX
570options 	VM_KMEM_SIZE_SCALE
571
572# Enable NDIS binary driver support
573options 	NDISAPI
574device		ndis
575
576# Linux-specific pseudo devices support
577device		lindev
578