aboutsummaryrefslogtreecommitdiff
path: root/sys/amd64/conf/NOTES
blob: 1262af3b87f43da613ffe10ec8bcf0d15b71005c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
#
# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
#
# This file contains machine dependent kernel configuration notes.  For
# machine independent notes, look in /sys/conf/NOTES.
#
# $FreeBSD$
#

#
# We want LINT to cover profiling as well.
profile         2

#
# Enable the kernel DTrace hooks which are required to load the DTrace
# kernel modules.
#
options 	KDTRACE_HOOKS


#####################################################################
# SMP OPTIONS:
#
# Notes:
#
# IPI_PREEMPTION instructs the kernel to preempt threads running on other
#	  CPUS if needed.  Relies on the PREEMPTION option

# Optional:
options 	IPI_PREEMPTION
device		atpic			# Optional legacy pic support
device		mptable			# Optional MPSPEC mptable support

#
# Watchdog routines.
#
options 	MP_WATCHDOG

# Debugging options.
#
options 	COUNT_XINVLTLB_HITS	# Counters for TLB events
options 	COUNT_IPIS		# Per-CPU IPI interrupt counters



#####################################################################
# CPU OPTIONS

#
# You must specify at least one CPU (the one you intend to run on);
# deleting the specification for CPUs you don't need to use may make
# parts of the system run faster.
#
cpu		HAMMER			# aka K8, aka Opteron & Athlon64

#
# Options for CPU features.
#

#
# PERFMON causes the driver for Pentium/Pentium Pro performance counters
# to be compiled.  See perfmon(4) for more information.
#
#XXX#options 	PERFMON


#####################################################################
# NETWORKING OPTIONS

#
# DEVICE_POLLING adds support for mixed interrupt-polling handling
# of network device drivers, which has significant benefits in terms
# of robustness to overloads and responsivity, as well as permitting
# accurate scheduling of the CPU time between kernel network processing
# and other activities.  The drawback is a moderate (up to 1/HZ seconds)
# potential increase in response times.
# It is strongly recommended to use HZ=1000 or 2000 with DEVICE_POLLING
# to achieve smoother behaviour.
# Additionally, you can enable/disable polling at runtime with help of
# the ifconfig(8) utility, and select the CPU fraction reserved to
# userland with the sysctl variable kern.polling.user_frac
# (default 50, range 0..100).
#
# Not all device drivers support this mode of operation at the time of
# this writing.  See polling(4) for more details.

options 	DEVICE_POLLING

# BPF_JITTER adds support for BPF just-in-time compiler.

options 	BPF_JITTER

# OpenFabrics Enterprise Distribution (Infiniband).
options 	OFED
options 	OFED_DEBUG_INIT

# Sockets Direct Protocol
options 	SDP
options 	SDP_DEBUG

# IP over Infiniband
options 	IPOIB
options 	IPOIB_DEBUG
options 	IPOIB_CM


#####################################################################
# CLOCK OPTIONS

# Provide read/write access to the memory in the clock chip.
device		nvram		# Access to rtc cmos via /dev/nvram


#####################################################################
# MISCELLANEOUS DEVICES AND OPTIONS

device		speaker		#Play IBM BASIC-style noises out your speaker
hint.speaker.0.at="isa"
hint.speaker.0.port="0x61"
device		gzip		#Exec gzipped a.out's.  REQUIRES COMPAT_AOUT!


#####################################################################
# HARDWARE BUS CONFIGURATION

#
# ISA bus
#
device		isa

#
# Options for `isa':
#
# AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A
# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
# This option breaks suspend/resume on some portables.
#
# AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A
# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
# Automatic EOI is documented not to work for for the slave with the
# original i8259A, but it works for some clones and some integrated
# versions.
#
# MAXMEM specifies the amount of RAM on the machine; if this is not
# specified, FreeBSD will first read the amount of memory from the CMOS
# RAM, so the amount of memory will initially be limited to 64MB or 16MB
# depending on the BIOS.  If the BIOS reports 64MB, a memory probe will
# then attempt to detect the installed amount of RAM.  If this probe
# fails to detect >64MB RAM you will have to use the MAXMEM option.
# The amount is in kilobytes, so for a machine with 128MB of RAM, it would
# be 131072 (128 * 1024).
#
# BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
# reset the CPU for reboot.  This is needed on some systems with broken
# keyboard controllers.

options 	AUTO_EOI_1
#options 	AUTO_EOI_2

options 	MAXMEM=(128*1024)
#options 	BROKEN_KEYBOARD_RESET

#
# PCI bus & PCI options:
#
device		pci

#
# AGP GART support
device		agp

#
# AGP debugging.
#
options 	AGP_DEBUG


#####################################################################
# HARDWARE DEVICE CONFIGURATION

# To include support for VGA VESA video modes
options 	VESA

# Turn on extra debugging checks and output for VESA support.
options 	VESA_DEBUG

device		dpms		# DPMS suspend & resume via VESA BIOS

# x86 real mode BIOS emulator, required by atkbdc/dpms/vesa
options 	X86BIOS

#
# Optional devices:
#

# PS/2 mouse
device		psm
hint.psm.0.at="atkbdc"
hint.psm.0.irq="12"

# Options for psm:
options 	PSM_HOOKRESUME		#hook the system resume event, useful
					#for some laptops
options 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event

# The keyboard controller; it controls the keyboard and the PS/2 mouse.
device		atkbdc
hint.atkbdc.0.at="isa"
hint.atkbdc.0.port="0x060"

# The AT keyboard
device		atkbd
hint.atkbd.0.at="atkbdc"
hint.atkbd.0.irq="1"

# Options for atkbd:
options 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
makeoptions	ATKBD_DFLT_KEYMAP=jp.106

# `flags' for atkbd:
#       0x01    Force detection of keyboard, else we always assume a keyboard
#       0x02    Don't reset keyboard, useful for some newer ThinkPads
#	0x03	Force detection and avoid reset, might help with certain
#		dockingstations
#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads

# Video card driver for VGA adapters.
device		vga
hint.vga.0.at="isa"

# Options for vga:
# Try the following option if the mouse pointer is not drawn correctly
# or font does not seem to be loaded properly.  May cause flicker on
# some systems.
options 	VGA_ALT_SEQACCESS

# If you can dispense with some vga driver features, you may want to
# use the following options to save some memory.
#options 	VGA_NO_FONT_LOADING	# don't save/load font
#options 	VGA_NO_MODE_CHANGE	# don't change video modes

# Older video cards may require this option for proper operation.
options 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs

# The following option probably won't work with the LCD displays.
options 	VGA_WIDTH90		# support 90 column modes

# Debugging.
options 	VGA_DEBUG

# vt(4) drivers.
device		vt_vga		# VGA
device		vt_efifb	# EFI framebuffer

# Linear framebuffer driver for S3 VESA 1.2 cards. Works on top of VESA.
device		s3pci

# 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support.  This will create
# the /dev/3dfx0 device to work with glide implementations.  This should get
# linked to /dev/3dfx and /dev/voodoo.  Note that this is not the same as
# the tdfx DRI module from XFree86 and is completely unrelated.
#
# To enable Linuxulator support, one must also include COMPAT_LINUX in the
# config as well.  The other option is to load both as modules.

device		tdfx			# Enable 3Dfx Voodoo support
#XXX#device 	tdfx_linux		# Enable Linuxulator support

#
# ACPI support using the Intel ACPI Component Architecture reference
# implementation.
#
# ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer
# kernel environment variables to select initial debugging levels for the
# Intel ACPICA code.  (Note that the Intel code must also have USE_DEBUGGER
# defined when it is built).

device		acpi
options 	ACPI_DEBUG

# The cpufreq(4) driver provides support for non-ACPI CPU frequency control
device		cpufreq

# Direct Rendering modules for 3D acceleration.
device		drm		# DRM core module required by DRM drivers
device		i915drm		# Intel i830 through i915
device		mach64drm	# ATI Rage Pro, Rage Mobility P/M, Rage XL
device		mgadrm		# AGP Matrox G200, G400, G450, G550
device		r128drm		# ATI Rage 128
device		radeondrm	# ATI Radeon
device		savagedrm	# S3 Savage3D, Savage4
device		sisdrm		# SiS 300/305, 540, 630
device		tdfxdrm		# 3dfx Voodoo 3/4/5 and Banshee
device		viadrm		# VIA
options 	DRM_DEBUG	# Include debug printfs (slow)

#
# Network interfaces:
#

# bxe:  Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
#       adapters.
# ed:   Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
#       HP PC Lan+, various PC Card devices
#       (requires miibus)
# ipw:	Intel PRO/Wireless 2100 IEEE 802.11 adapter
#	Requires the ipw firmware module
# iwi:	Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters
#	Requires the iwi firmware module
# iwn:	Intel Wireless WiFi Link 1000/105/135/2000/4965/5000/6000/6050 abgn
#	802.11 network adapters
#	Requires the iwn firmware module
# mlx4ib: Mellanox ConnectX HCA InfiniBand
# mlxen: Mellanox ConnectX HCA Ethernet
# mthca: Mellanox HCA InfiniBand
# nfe:	nVidia nForce MCP on-board Ethernet Networking (BSD open source)
# sfxge: Solarflare SFC9000 family 10Gb Ethernet adapters
# vmx:	VMware VMXNET3 Ethernet (BSD open source)
# wpi:	Intel 3945ABG Wireless LAN controller
#	Requires the wpi firmware module

device		bxe		# Broadcom NetXtreme II BCM5771X/BCM578XX 10GbE
device		ed		# NE[12]000, SMC Ultra, 3c503, DS8390 cards
options 	ED_3C503
options 	ED_HPP
options 	ED_SIC
device		ipw		# Intel 2100 wireless NICs.
device		iwi		# Intel 2200BG/2225BG/2915ABG wireless NICs.
device		iwn		# Intel 4965/1000/5000/6000 wireless NICs.
device  	mlx4ib		# Mellanox ConnectX HCA InfiniBand
device  	mlxen		# Mellanox ConnectX HCA Ethernet
device  	mthca		# Mellanox HCA InfiniBand
device		nfe		# nVidia nForce MCP on-board Ethernet
device		sfxge		# Solarflare SFC9000 10Gb Ethernet
device		vmx		# VMware VMXNET3 Ethernet
device		wpi		# Intel 3945ABG wireless NICs.

# IEEE 802.11 adapter firmware modules

# Intel PRO/Wireless 2100 firmware:
#   ipwfw:		BSS/IBSS/monitor mode firmware
#   ipwbssfw:		BSS mode firmware
#   ipwibssfw:		IBSS mode firmware
#   ipwmonitorfw:	Monitor mode firmware
# Intel PRO/Wireless 2200BG/2225BG/2915ABG firmware:
#   iwifw:		BSS/IBSS/monitor mode firmware
#   iwibssfw:		BSS mode firmware
#   iwiibssfw:		IBSS mode firmware
#   iwimonitorfw:	Monitor mode firmware
# Intel Wireless WiFi Link 4965/1000/5000/6000 series firmware:
#   iwnfw:		Single module to support all devices
#   iwn1000fw:		Specific module for the 1000 only
#   iwn105fw:		Specific module for the 105 only
#   iwn135fw:		Specific module for the 135 only
#   iwn2000fw:		Specific module for the 2000 only
#   iwn2030fw:		Specific module for the 2030 only
#   iwn4965fw:		Specific module for the 4965 only
#   iwn5000fw:		Specific module for the 5000 only
#   iwn5150fw:		Specific module for the 5150 only
#   iwn6000fw:		Specific module for the 6000 only
#   iwn6000g2afw:	Specific module for the 6000g2a only
#   iwn6000g2bfw:	Specific module for the 6000g2b only
#   iwn6050fw:		Specific module for the 6050 only
# wpifw:	Intel 3945ABG Wireless LAN Controller firmware

device		iwifw
device		iwibssfw
device		iwiibssfw
device		iwimonitorfw
device		ipwfw
device		ipwbssfw
device		ipwibssfw
device		ipwmonitorfw
device		iwnfw
device		iwn1000fw
device		iwn105fw
device		iwn135fw
device		iwn2000fw
device		iwn2030fw
device		iwn4965fw
device		iwn5000fw
device		iwn5150fw
device		iwn6000fw
device		iwn6000g2afw
device		iwn6000g2bfw
device		iwn6050fw
device		wpifw

# Intel Non-Transparent Bridge (NTB) hardware
device		ntb_hw	# Hardware Abstraction Layer for the NTB
device		if_ntb	# Simulated ethernet device using the NTB

#
#XXX this stores pointers in a 32bit field that is defined by the hardware
#device	pst

#
# Areca 11xx and 12xx series of SATA II RAID controllers.
# CAM is required.
#
device		arcmsr		# Areca SATA II RAID

#
# 3ware 9000 series PATA/SATA RAID controller driver and options.
# The driver is implemented as a SIM, and so, needs the CAM infrastructure.
#
options 	TWA_DEBUG		# 0-10; 10 prints the most messages.
options 	TWA_FLASH_FIRMWARE	# firmware image bundled when defined.
device		twa			# 3ware 9000 series PATA/SATA RAID

#
# SCSI host adapters:
#
# ncv: NCR 53C500 based SCSI host adapters.
# nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters.
# stg: TMC 18C30, 18C50 based SCSI host adapters.

device		ncv
device		nsp
device		stg

#
# Adaptec FSA RAID controllers, including integrated DELL controllers,
# the Dell PERC 2/QC and the HP NetRAID-4M
device		aac
device		aacp	# SCSI Passthrough interface (optional, CAM required)

#
# Adaptec by PMC RAID controllers, Series 6/7/8 and upcoming families
device		aacraid		# Container interface, CAM required

#
# Highpoint RocketRAID 27xx.
device		hpt27xx

#
# Highpoint RocketRAID 182x.
device		hptmv

#
# Highpoint DC7280 and R750.
device		hptnr

#
# Highpoint RocketRAID.  Supports RR172x, RR222x, RR2240, RR232x, RR2340,
# RR2210, RR174x, RR2522, RR231x, RR230x.
device		hptrr

#
# Highpoint RocketRaid 3xxx series SATA RAID
device		hptiop

#
# IBM (now Adaptec) ServeRAID controllers
device		ips

#
# Intel C600 (Patsburg) integrated SAS controller
device		isci
options 	ISCI_LOGGING	# enable debugging in isci HAL

#
# NVM Express (NVMe) support
device         nvme    # base NVMe driver
device         nvd     # expose NVMe namespaces as disks, depends on nvme

#
# SafeNet crypto driver: can be moved to the MI NOTES as soon as
# it's tested on a big-endian machine
#
device		safe		# SafeNet 1141
options 	SAFE_DEBUG	# enable debugging support: hw.safe.debug
options 	SAFE_RNDTEST	# enable rndtest support

#
# VirtIO support
#
# The virtio entry provides a generic bus for use by the device drivers.
# It must be combined with an interface that communicates with the host.
# Multiple such interfaces are defined by the VirtIO specification. FreeBSD
# only has support for PCI. Therefore, virtio_pci must be statically
# compiled in or loaded as a module for the device drivers to function.
#
device		virtio		# Generic VirtIO bus (required)
device		virtio_pci	# VirtIO PCI Interface
device		vtnet		# VirtIO Ethernet device
device		virtio_blk	# VirtIO Block device
device		virtio_scsi	# VirtIO SCSI device
device		virtio_balloon	# VirtIO Memory Balloon device
device		virtio_random	# VirtIO Entropy device

device 		hyperv		# HyperV drivers

# Xen HVM Guest Optimizations
options 	XENHVM		# Xen HVM kernel infrastructure
device 		xenpci		# Xen HVM Hypervisor services driver

#####################################################################

#
# Miscellaneous hardware:
#
# ipmi: Intelligent Platform Management Interface
# pbio: Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724)
# smbios: DMI/SMBIOS entry point
# vpd: Vital Product Data kernel interface
# asmc: Apple System Management Controller
# si: Specialix International SI/XIO or SX intelligent serial card
# tpm: Trusted Platform Module

# Notes on the Specialix SI/XIO driver:
#  The host card is memory, not IO mapped.
#  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
#  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
#  The cards can use an IRQ of 11, 12 or 15.

device		ipmi
device		pbio
hint.pbio.0.at="isa"
hint.pbio.0.port="0x360"
device		smbios
device		vpd
device		asmc
device		si
device		tpm
device		padlock_rng	# VIA Padlock RNG
device		rdrand_rng	# Intel Bull Mountain RNG
device		aesni		# AES-NI OpenCrypto module

#
# Laptop/Notebook options:
#


#
# I2C Bus
#

#
# Hardware watchdog timers:
#
# ichwd: Intel ICH watchdog timer
# amdsbwd: AMD SB7xx watchdog timer
# viawd: VIA south bridge watchdog timer
# wbwd: Winbond watchdog timer
#
device		ichwd
device		amdsbwd
device		viawd
device		wbwd

#
# Temperature sensors:
#
# coretemp: on-die sensor on Intel Core and newer CPUs
# amdtemp: on-die sensor on AMD K8/K10/K11 CPUs
#
device		coretemp
device		amdtemp

#
# CPU control pseudo-device. Provides access to MSRs, CPUID info and
# microcode update feature.
#
device		cpuctl

#
# System Management Bus (SMB)
#
options 	ENABLE_ALART		# Control alarm on Intel intpm driver

#
# Number of initial kernel page table pages used for early bootstrap.
# This number should include enough pages to map the kernel and any
# modules or other data loaded with the kernel by the loader.  Each
# page table page maps 2MB.
#
options 	NKPT=31


#####################################################################
# ABI Emulation

#XXX keep these here for now and reactivate when support for emulating
#XXX these 32 bit binaries is added.

# Enable 32-bit runtime support for FreeBSD/i386 binaries.
options 	COMPAT_FREEBSD32

# Enable iBCS2 runtime support for SCO and ISC binaries
#XXX#options 	IBCS2

# Emulate spx device for client side of SVR3 local X interface
#XXX#options 	SPX_HACK

# Enable Linux ABI emulation
#XXX#options 	COMPAT_LINUX

# Enable 32-bit Linux ABI emulation (requires COMPAT_43 and COMPAT_FREEBSD32)
options 	COMPAT_LINUX32

# Enable the linux-like proc filesystem support (requires COMPAT_LINUX32
# and PSEUDOFS)
options 	LINPROCFS

#Enable the linux-like sys filesystem support (requires COMPAT_LINUX32
# and PSEUDOFS)
options 	LINSYSFS

#
# SysVR4 ABI emulation
#
# The svr4 ABI emulator can be statically compiled into the kernel or loaded as
# a KLD module.
# The STREAMS network emulation code can also be compiled statically or as a
# module.  If loaded as a module, it must be loaded before the svr4 module
# (the /usr/sbin/svr4 script does this for you).  If compiling statically,
# the `streams' device must be configured into any kernel which also
# specifies COMPAT_SVR4.  It is possible to have a statically-configured
# STREAMS device and a dynamically loadable svr4 emulator;  the /usr/sbin/svr4
# script understands that it doesn't need to load the `streams' module under
# those circumstances.
# Caveat:  At this time, `options KTRACE' is required for the svr4 emulator
# (whether static or dynamic).
#
#XXX#options 	COMPAT_SVR4	# build emulator statically
#XXX#options 	DEBUG_SVR4	# enable verbose debugging
#XXX#device	streams		# STREAMS network driver (required for svr4).


#####################################################################
# VM OPTIONS

# KSTACK_PAGES is the number of memory pages to assign to the kernel
# stack of each thread.

options 	KSTACK_PAGES=5

# Enable detailed accounting by the PV entry allocator.

options 	PV_STATS

#####################################################################

# More undocumented options for linting.
# Note that documenting these are not considered an affront.

options 	FB_INSTALL_CDEV		# install a CDEV entry in /dev

options 	KBDIO_DEBUG=2
options 	KBD_MAXRETRY=4
options 	KBD_MAXWAIT=6
options 	KBD_RESETDELAY=201

options 	PSM_DEBUG=1

options 	TIMER_FREQ=((14318182+6)/12)

options 	VM_KMEM_SIZE
options 	VM_KMEM_SIZE_MAX
options 	VM_KMEM_SIZE_SCALE

# Enable NDIS binary driver support
options 	NDISAPI
device		ndis