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