xref: /freebsd/sys/amd64/conf/NOTES (revision 52c2bb75163559a6e2866ad374a7de67a4ea1273)
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# DTrace core
21# NOTE: introduces CDDL-licensed components into the kernel
22#device		dtrace
23
24# DTrace modules
25#device		dtrace_profile
26#device		dtrace_sdt
27#device		dtrace_fbt
28#device		dtrace_systrace
29#device		dtrace_prototype
30#device		dtnfscl
31#device		dtmalloc
32
33# Alternatively include all the DTrace modules
34#device		dtraceall
35
36
37#####################################################################
38# SMP OPTIONS:
39#
40# Notes:
41#
42# IPI_PREEMPTION instructs the kernel to preempt threads running on other
43#	  CPUS if needed.  Relies on the PREEMPTION option
44
45# Optional:
46options 	IPI_PREEMPTION
47device		atpic			# Optional legacy pic support
48device		mptable			# Optional MPSPEC mptable support
49
50#
51# Watchdog routines.
52#
53options 	MP_WATCHDOG
54
55# Debugging options.
56#
57options 	COUNT_XINVLTLB_HITS	# Counters for TLB events
58options 	COUNT_IPIS		# Per-CPU IPI interrupt counters
59
60
61
62#####################################################################
63# CPU OPTIONS
64
65#
66# You must specify at least one CPU (the one you intend to run on);
67# deleting the specification for CPUs you don't need to use may make
68# parts of the system run faster.
69#
70cpu		HAMMER			# aka K8, aka Opteron & Athlon64
71
72#
73# Options for CPU features.
74#
75
76
77#####################################################################
78# NETWORKING OPTIONS
79
80#
81# DEVICE_POLLING adds support for mixed interrupt-polling handling
82# of network device drivers, which has significant benefits in terms
83# of robustness to overloads and responsivity, as well as permitting
84# accurate scheduling of the CPU time between kernel network processing
85# and other activities.  The drawback is a moderate (up to 1/HZ seconds)
86# potential increase in response times.
87# It is strongly recommended to use HZ=1000 or 2000 with DEVICE_POLLING
88# to achieve smoother behaviour.
89# Additionally, you can enable/disable polling at runtime with help of
90# the ifconfig(8) utility, and select the CPU fraction reserved to
91# userland with the sysctl variable kern.polling.user_frac
92# (default 50, range 0..100).
93#
94# Not all device drivers support this mode of operation at the time of
95# this writing.  See polling(4) for more details.
96
97options 	DEVICE_POLLING
98
99# BPF_JITTER adds support for BPF just-in-time compiler.
100
101options 	BPF_JITTER
102
103# OpenFabrics Enterprise Distribution (Infiniband).
104options 	OFED
105options 	OFED_DEBUG_INIT
106
107# Sockets Direct Protocol
108options 	SDP
109options 	SDP_DEBUG
110
111# IP over Infiniband
112options 	IPOIB
113options 	IPOIB_DEBUG
114options 	IPOIB_CM
115
116
117#####################################################################
118# CLOCK OPTIONS
119
120# Provide read/write access to the memory in the clock chip.
121device		nvram		# Access to rtc cmos via /dev/nvram
122
123
124#####################################################################
125# MISCELLANEOUS DEVICES AND OPTIONS
126
127device		speaker		#Play IBM BASIC-style noises out your speaker
128hint.speaker.0.at="isa"
129hint.speaker.0.port="0x61"
130device		gzip		#Exec gzipped a.out's.  REQUIRES COMPAT_AOUT!
131
132
133#####################################################################
134# HARDWARE BUS CONFIGURATION
135
136#
137# ISA bus
138#
139device		isa
140
141#
142# Options for `isa':
143#
144# AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A
145# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
146# This option breaks suspend/resume on some portables.
147#
148# AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A
149# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
150# Automatic EOI is documented not to work for for the slave with the
151# original i8259A, but it works for some clones and some integrated
152# versions.
153#
154# MAXMEM specifies the amount of RAM on the machine; if this is not
155# specified, FreeBSD will first read the amount of memory from the CMOS
156# RAM, so the amount of memory will initially be limited to 64MB or 16MB
157# depending on the BIOS.  If the BIOS reports 64MB, a memory probe will
158# then attempt to detect the installed amount of RAM.  If this probe
159# fails to detect >64MB RAM you will have to use the MAXMEM option.
160# The amount is in kilobytes, so for a machine with 128MB of RAM, it would
161# be 131072 (128 * 1024).
162#
163# BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
164# reset the CPU for reboot.  This is needed on some systems with broken
165# keyboard controllers.
166
167options 	AUTO_EOI_1
168#options 	AUTO_EOI_2
169
170options 	MAXMEM=(128*1024)
171#options 	BROKEN_KEYBOARD_RESET
172
173#
174# AGP GART support
175device		agp
176
177#
178# AGP debugging.
179#
180options 	AGP_DEBUG
181
182
183#####################################################################
184# HARDWARE DEVICE CONFIGURATION
185
186# To include support for VGA VESA video modes
187options 	VESA
188
189# Turn on extra debugging checks and output for VESA support.
190options 	VESA_DEBUG
191
192device		dpms		# DPMS suspend & resume via VESA BIOS
193
194# x86 real mode BIOS emulator, required by atkbdc/dpms/vesa
195options 	X86BIOS
196
197#
198# Optional devices:
199#
200
201# PS/2 mouse
202device		psm
203hint.psm.0.at="atkbdc"
204hint.psm.0.irq="12"
205
206# Options for psm:
207options 	PSM_HOOKRESUME		#hook the system resume event, useful
208					#for some laptops
209options 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
210
211# The keyboard controller; it controls the keyboard and the PS/2 mouse.
212device		atkbdc
213hint.atkbdc.0.at="isa"
214hint.atkbdc.0.port="0x060"
215
216# The AT keyboard
217device		atkbd
218hint.atkbd.0.at="atkbdc"
219hint.atkbd.0.irq="1"
220
221# Options for atkbd:
222options 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
223makeoptions	ATKBD_DFLT_KEYMAP=fr.dvorak
224
225# `flags' for atkbd:
226#       0x01    Force detection of keyboard, else we always assume a keyboard
227#       0x02    Don't reset keyboard, useful for some newer ThinkPads
228#	0x03	Force detection and avoid reset, might help with certain
229#		dockingstations
230#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
231
232# Video card driver for VGA adapters.
233device		vga
234hint.vga.0.at="isa"
235
236# Options for vga:
237# Try the following option if the mouse pointer is not drawn correctly
238# or font does not seem to be loaded properly.  May cause flicker on
239# some systems.
240options 	VGA_ALT_SEQACCESS
241
242# If you can dispense with some vga driver features, you may want to
243# use the following options to save some memory.
244#options 	VGA_NO_FONT_LOADING	# don't save/load font
245#options 	VGA_NO_MODE_CHANGE	# don't change video modes
246
247# Older video cards may require this option for proper operation.
248options 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
249
250# The following option probably won't work with the LCD displays.
251options 	VGA_WIDTH90		# support 90 column modes
252
253# Debugging.
254options 	VGA_DEBUG
255
256# vt(4) drivers.
257device		vt_vga		# VGA
258device		vt_efifb	# EFI framebuffer
259
260# Linear framebuffer driver for S3 VESA 1.2 cards. Works on top of VESA.
261device		s3pci
262
263# 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support.  This will create
264# the /dev/3dfx0 device to work with glide implementations.  This should get
265# linked to /dev/3dfx and /dev/voodoo.  Note that this is not the same as
266# the tdfx DRI module from XFree86 and is completely unrelated.
267#
268# To enable Linuxulator support, one must also include COMPAT_LINUX in the
269# config as well.  The other option is to load both as modules.
270
271device		tdfx			# Enable 3Dfx Voodoo support
272#XXX#device 	tdfx_linux		# Enable Linuxulator support
273
274#
275# ACPI support using the Intel ACPI Component Architecture reference
276# implementation.
277#
278# ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer
279# kernel environment variables to select initial debugging levels for the
280# Intel ACPICA code.  (Note that the Intel code must also have USE_DEBUGGER
281# defined when it is built).
282
283device		acpi
284options 	ACPI_DEBUG
285
286# The cpufreq(4) driver provides support for non-ACPI CPU frequency control
287device		cpufreq
288
289#
290# Network interfaces:
291#
292
293# bxe:  Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
294#       adapters.
295# ipw:	Intel PRO/Wireless 2100 IEEE 802.11 adapter
296#	Requires the ipw firmware module
297# iwi:	Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters
298#	Requires the iwi firmware module
299# iwn:	Intel Wireless WiFi Link 1000/105/135/2000/4965/5000/6000/6050 abgn
300#	802.11 network adapters
301#	Requires the iwn firmware module
302# mthca: Mellanox HCA InfiniBand
303# mlx4ib: Mellanox ConnectX HCA InfiniBand
304# mlx4en: Mellanox ConnectX HCA Ethernet
305# nfe:	nVidia nForce MCP on-board Ethernet Networking (BSD open source)
306# sfxge: Solarflare SFC9000 family 10Gb Ethernet adapters
307# vmx:	VMware VMXNET3 Ethernet (BSD open source)
308# wpi:	Intel 3945ABG Wireless LAN controller
309#	Requires the wpi firmware module
310
311device		bxe		# Broadcom NetXtreme II BCM5771X/BCM578XX 10GbE
312options 	ED_3C503
313options 	ED_HPP
314options 	ED_SIC
315device		ipw		# Intel 2100 wireless NICs.
316device		iwi		# Intel 2200BG/2225BG/2915ABG wireless NICs.
317device		iwn		# Intel 4965/1000/5000/6000 wireless NICs.
318device		ixl		# Intel 700 Series Physical Function
319device		iavf		# Intel Adaptive Virtual Function
320device  	mthca		# Mellanox HCA InfiniBand
321device  	mlx4		# Shared code module between IB and Ethernet
322device  	mlx4ib		# Mellanox ConnectX HCA InfiniBand
323device  	mlx4en		# Mellanox ConnectX HCA Ethernet
324device		nfe		# nVidia nForce MCP on-board Ethernet
325device		sfxge		# Solarflare SFC9000 10Gb Ethernet
326device		vmx		# VMware VMXNET3 Ethernet
327device		wpi		# Intel 3945ABG wireless NICs.
328
329# IEEE 802.11 adapter firmware modules
330
331# Intel PRO/Wireless 2100 firmware:
332#   ipwfw:		BSS/IBSS/monitor mode firmware
333#   ipwbssfw:		BSS mode firmware
334#   ipwibssfw:		IBSS mode firmware
335#   ipwmonitorfw:	Monitor mode firmware
336# Intel PRO/Wireless 2200BG/2225BG/2915ABG firmware:
337#   iwifw:		BSS/IBSS/monitor mode firmware
338#   iwibssfw:		BSS mode firmware
339#   iwiibssfw:		IBSS mode firmware
340#   iwimonitorfw:	Monitor mode firmware
341# Intel Wireless WiFi Link 4965/1000/5000/6000 series firmware:
342#   iwnfw:		Single module to support all devices
343#   iwn1000fw:		Specific module for the 1000 only
344#   iwn105fw:		Specific module for the 105 only
345#   iwn135fw:		Specific module for the 135 only
346#   iwn2000fw:		Specific module for the 2000 only
347#   iwn2030fw:		Specific module for the 2030 only
348#   iwn4965fw:		Specific module for the 4965 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#   iwn6000g2afw:	Specific module for the 6000g2a only
353#   iwn6000g2bfw:	Specific module for the 6000g2b only
354#   iwn6050fw:		Specific module for the 6050 only
355# wpifw:	Intel 3945ABG Wireless LAN Controller firmware
356
357device		iwifw
358device		iwibssfw
359device		iwiibssfw
360device		iwimonitorfw
361device		ipwfw
362device		ipwbssfw
363device		ipwibssfw
364device		ipwmonitorfw
365device		iwnfw
366device		iwn1000fw
367device		iwn105fw
368device		iwn135fw
369device		iwn2000fw
370device		iwn2030fw
371device		iwn4965fw
372device		iwn5000fw
373device		iwn5150fw
374device		iwn6000fw
375device		iwn6000g2afw
376device		iwn6000g2bfw
377device		iwn6050fw
378device		wpifw
379
380#
381# Non-Transparent Bridge (NTB) drivers
382#
383device		if_ntb		# Virtual NTB network interface
384device		ntb_transport	# NTB packet transport driver
385device		ntb		# NTB hardware interface
386device		ntb_hw_intel	# Intel NTB hardware driver
387device		ntb_hw_plx	# PLX NTB hardware driver
388
389#
390#XXX this stores pointers in a 32bit field that is defined by the hardware
391#device	pst
392
393#
394# Areca 11xx and 12xx series of SATA II RAID controllers.
395# CAM is required.
396#
397device		arcmsr		# Areca SATA II RAID
398
399#
400# Microsemi smartpqi controllers.
401# These controllers have a SCSI-like interface, and require the
402# CAM infrastructure.
403#
404device		smartpqi
405
406#
407# 3ware 9000 series PATA/SATA RAID controller driver and options.
408# The driver is implemented as a SIM, and so, needs the CAM infrastructure.
409#
410options 	TWA_DEBUG		# 0-10; 10 prints the most messages.
411device		twa			# 3ware 9000 series PATA/SATA RAID
412
413#
414# Adaptec FSA RAID controllers, including integrated DELL controllers,
415# the Dell PERC 2/QC and the HP NetRAID-4M
416device		aac
417device		aacp	# SCSI Passthrough interface (optional, CAM required)
418
419#
420# Adaptec by PMC RAID controllers, Series 6/7/8 and upcoming families
421device		aacraid		# Container interface, CAM required
422
423#
424# Highpoint RocketRAID 27xx.
425device		hpt27xx
426
427#
428# Highpoint RocketRAID 182x.
429device		hptmv
430
431#
432# Highpoint DC7280 and R750.
433device		hptnr
434
435#
436# Highpoint RocketRAID.  Supports RR172x, RR222x, RR2240, RR232x, RR2340,
437# RR2210, RR174x, RR2522, RR231x, RR230x.
438device		hptrr
439
440#
441# Highpoint RocketRaid 3xxx series SATA RAID
442device		hptiop
443
444#
445# IBM (now Adaptec) ServeRAID controllers
446device		ips
447
448#
449# Intel integrated Memory Controller (iMC) SMBus controller
450#	Sandybridge-Xeon, Ivybridge-Xeon, Haswell-Xeon, Broadwell-Xeon
451device		imcsmb
452
453#
454# Intel C600 (Patsburg) integrated SAS controller
455device		isci
456options 	ISCI_LOGGING	# enable debugging in isci HAL
457
458#
459# NVM Express (NVMe) support
460device         nvme    # base NVMe driver
461device         nvd     # expose NVMe namespaces as disks, depends on nvme
462
463#
464# PMC-Sierra SAS/SATA controller
465device		pmspcv
466
467#
468# SafeNet crypto driver: can be moved to the MI NOTES as soon as
469# it's tested on a big-endian machine
470#
471device		safe		# SafeNet 1141
472options 	SAFE_DEBUG	# enable debugging support: hw.safe.debug
473options 	SAFE_RNDTEST	# enable rndtest support
474
475#
476# VirtIO support
477#
478# The virtio entry provides a generic bus for use by the device drivers.
479# It must be combined with an interface that communicates with the host.
480# Multiple such interfaces are defined by the VirtIO specification. FreeBSD
481# only has support for PCI. Therefore, virtio_pci must be statically
482# compiled in or loaded as a module for the device drivers to function.
483#
484device		virtio		# Generic VirtIO bus (required)
485device		virtio_pci	# VirtIO PCI Interface
486device		vtnet		# VirtIO Ethernet device
487device		virtio_blk	# VirtIO Block device
488device		virtio_scsi	# VirtIO SCSI device
489device		virtio_balloon	# VirtIO Memory Balloon device
490device		virtio_random	# VirtIO Entropy device
491device		virtio_console	# VirtIO Console device
492
493# Microsoft Hyper-V enhancement support
494device 		hyperv		# HyperV drivers
495
496# Xen HVM Guest Optimizations
497options 	XENHVM		# Xen HVM kernel infrastructure
498device 		xenpci		# Xen HVM Hypervisor services driver
499
500#####################################################################
501
502#
503# Miscellaneous hardware:
504#
505# ipmi: Intelligent Platform Management Interface
506# pbio: Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724)
507# smbios: DMI/SMBIOS entry point
508# vpd: Vital Product Data kernel interface
509# asmc: Apple System Management Controller
510# si: Specialix International SI/XIO or SX intelligent serial card
511# tpm: Trusted Platform Module
512
513# Notes on the Specialix SI/XIO driver:
514#  The host card is memory, not IO mapped.
515#  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
516#  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
517#  The cards can use an IRQ of 11, 12 or 15.
518
519device		ipmi
520device		pbio
521hint.pbio.0.at="isa"
522hint.pbio.0.port="0x360"
523device		smbios
524device		vpd
525device		asmc
526device		tpm
527device		padlock_rng	# VIA Padlock RNG
528device		rdrand_rng	# Intel Bull Mountain RNG
529device		aesni		# AES-NI OpenCrypto module
530device		ioat		# Intel I/OAT DMA engine
531
532#
533# Laptop/Notebook options:
534#
535
536
537#
538# I2C Bus
539#
540
541#
542# Hardware watchdog timers:
543#
544# ichwd: Intel ICH watchdog timer
545# amdsbwd: AMD SB7xx watchdog timer
546# viawd: VIA south bridge watchdog timer
547# wbwd: Winbond watchdog timer
548#
549device		ichwd
550device		amdsbwd
551device		viawd
552device		wbwd
553
554#
555# Temperature sensors:
556#
557# coretemp: on-die sensor on Intel Core and newer CPUs
558# amdtemp: on-die sensor on AMD K8/K10/K11 CPUs
559#
560device		coretemp
561device		amdtemp
562
563#
564# CPU control pseudo-device. Provides access to MSRs, CPUID info and
565# microcode update feature.
566#
567device		cpuctl
568
569#
570# System Management Bus (SMB)
571#
572options 	ENABLE_ALART		# Control alarm on Intel intpm driver
573
574#
575# AMD System Management Network (SMN)
576#
577device		amdsmn
578
579#
580# Number of initial kernel page table pages used for early bootstrap.
581# This number should include enough pages to map the kernel and any
582# modules or other data loaded with the kernel by the loader.  Each
583# page table page maps 2MB.
584#
585options 	NKPT=31
586
587# EFI Runtime Services support
588options 	EFIRT
589
590
591#####################################################################
592# ABI Emulation
593
594#XXX keep these here for now and reactivate when support for emulating
595#XXX these 32 bit binaries is added.
596
597# Enable 32-bit runtime support for FreeBSD/i386 binaries.
598options 	COMPAT_FREEBSD32
599
600# Enable (32-bit) a.out binary support
601options 	COMPAT_AOUT
602
603# Enable 32-bit runtime support for CloudABI binaries.
604options 	COMPAT_CLOUDABI32
605
606# Enable 64-bit runtime support for CloudABI binaries.
607options 	COMPAT_CLOUDABI64
608
609# Enable Linux ABI emulation
610#XXX#options 	COMPAT_LINUX
611
612# Enable 32-bit Linux ABI emulation (requires COMPAT_FREEBSD32).
613options 	COMPAT_LINUX32
614
615# Enable the linux-like proc filesystem support (requires COMPAT_LINUX32
616# and PSEUDOFS)
617options 	LINPROCFS
618
619#Enable the linux-like sys filesystem support (requires COMPAT_LINUX32
620# and PSEUDOFS)
621options 	LINSYSFS
622
623#####################################################################
624# ZFS support
625
626options		ZFS
627
628#####################################################################
629# VM OPTIONS
630
631# KSTACK_PAGES is the number of memory pages to assign to the kernel
632# stack of each thread.
633
634options 	KSTACK_PAGES=5
635
636# Enable detailed accounting by the PV entry allocator.
637
638options 	PV_STATS
639
640#####################################################################
641
642# More undocumented options for linting.
643# Note that documenting these are not considered an affront.
644
645options 	FB_INSTALL_CDEV		# install a CDEV entry in /dev
646
647options 	KBDIO_DEBUG=2
648options 	KBD_MAXRETRY=4
649options 	KBD_MAXWAIT=6
650options 	KBD_RESETDELAY=201
651
652options 	PSM_DEBUG=1
653
654options 	TIMER_FREQ=((14318182+6)/12)
655
656options 	VM_KMEM_SIZE
657options 	VM_KMEM_SIZE_MAX
658options 	VM_KMEM_SIZE_SCALE
659
660# Enable NDIS binary driver support
661options 	NDISAPI
662device		ndis
663
664
665# GCOV (code coverage) support
666
667options		LINDEBUGFS
668options		GCOV
669