xref: /freebsd/sys/conf/options (revision c68159a6d8eede11766cf13896d0f7670dbd51aa)
1# $FreeBSD$
2#
3#        On the handling of kernel options
4#
5# All kernel options should be listed in LINT, with suitable
6# descriptions.  Negative options (options that make some code not
7# compile) should be commented out; LINT should compile as much code
8# as possible.  Try to structure option-using code so that a single
9# option only switch code on, or only switch code off, to make it
10# possible to have a full compile-test.  If necessary, you can check
11# for COMPILING_LINT to get maximum code coverage.
12#
13# All new options shall also be listed in either "conf/options" or
14# "<machine>/conf/options.<machine>".  Options that affect a single
15# source-file <xxx>.[c|s] should be directed into "opt_<xxx>.h", while
16# options that affect multiple files should either go in
17# "opt_global.h" if this is a kernel-wide option (used just about
18# everywhere), or in "opt_<option-name-in-lower-case>.h" if it affect
19# only some files.  Note that the effect of listing only an option
20# without a header-file-name in conf/options (and cousins) is that the
21# last convention is followed.
22#
23# This handling scheme is not yet fully implemented.
24#
25#
26# Format of this file:
27# Option name	filename
28#
29# If filename is missing, the default is
30# opt_<name-of-option-in-lower-case>.h
31
32# Adaptec aic7xxx SCSI controller options
33AHC_ALLOW_MEMIO		opt_aic7xxx.h	# Allow PCI devices to use memory
34					# mapped I/O
35
36AHC_TMODE_ENABLE	opt_aic7xxx.h	# Bitmap of units to enable
37					# targetmode operations.
38
39AHC_DUMP_EEPROM		opt_aic7xxx.h	# Dump the contents of our
40					# configuration prom.
41
42AHC_DEBUG_SEQUENCER	opt_aic7xxx.h	# Enable diagnostic sequencer code
43
44ADW_ALLOW_MEMIO		opt_adw.h	# Allow PCI devices to use memory
45					# mapped I/O
46
47# Miscellaneous options.
48COMPAT_43	opt_compat.h
49COMPAT_SUNOS	opt_compat.h
50COMPILING_LINT	opt_global.h
51CY_PCI_FASTINTR
52DDB
53DDB_UNATTENDED	opt_ddb.h
54GDB_REMOTE_CHAT	opt_ddb.h
55DEVFS
56HW_WDOG
57KTRACE
58MD_NSECT	opt_md.h
59MD_ROOT		opt_md.h
60MD_ROOT_SIZE	opt_md.h
61MFS_ROOT	opt_mfs.h
62MFS_ROOT_SIZE	opt_mfs.h
63NTIMECOUNTER	opt_ntp.h
64NSWAPDEV	opt_swap.h
65PPS_SYNC	opt_ntp.h
66QUOTA
67SPX_HACK
68SUIDDIR		opt_suiddir.h
69SYSVMSG		opt_sysvipc.h
70SYSVSEM		opt_sysvipc.h
71SYSVSHM		opt_sysvipc.h
72SHMALL		opt_sysvipc.h
73SHMMAX		opt_sysvipc.h
74SHMMAXPGS	opt_sysvipc.h
75SHMMIN		opt_sysvipc.h
76SHMMNI		opt_sysvipc.h
77SHMSEG		opt_sysvipc.h
78SEMMAP		opt_sysvipc.h
79SEMMNI		opt_sysvipc.h
80SEMMNS		opt_sysvipc.h
81SEMMNU		opt_sysvipc.h
82SEMMSL		opt_sysvipc.h
83SEMOPM		opt_sysvipc.h
84SEMUME		opt_sysvipc.h
85MSGMNB		opt_sysvipc.h
86MSGMNI		opt_sysvipc.h
87MSGSEG		opt_sysvipc.h
88MSGSSZ		opt_sysvipc.h
89MSGTQL		opt_sysvipc.h
90UCONSOLE
91VFS_AIO
92
93# POSIX kernel options
94P1003_1B			opt_posix.h
95_KPOSIX_PRIORITY_SCHEDULING	opt_posix.h
96_KPOSIX_VERSION			opt_posix.h
97
98# TrustedBSD and POSIX.1e Kernel Options
99CAPABILITIES	opt_cap.h
100
101# Do we want the config file compiled into the kernel?
102INCLUDE_CONFIG_FILE	opt_config.h
103
104# Options for static file systems.  These should only be used at config
105# time, since the corresponding lkms cannot work if there are any static
106# dependencies.  Unusability is enforced by hiding the defines for the
107# options in a never-included header.
108EXT2FS		opt_dontuse.h
109FDESC		opt_dontuse.h
110MFS		opt_dontuse.h
111MSDOSFS		opt_dontuse.h
112NULLFS		opt_dontuse.h
113PORTAL		opt_dontuse.h
114PROCFS		opt_dontuse.h
115UMAPFS		opt_dontuse.h
116NTFS		opt_dontuse.h
117
118# These static filesystems has one slightly bogus static dependency in
119# sys/i386/i386/autoconf.c.  If any of these filesystems are
120# statically compiled into the kernel, code for mounting them as root
121# filesystems will be enabled - but look below.  Boot-code is purposely
122# unavailable for the LKM-based versions.
123CODA
124CD9660
125FFS
126IFS
127NFS
128NWFS
129
130# If you are following the conditions in the copyright,
131# you can enable soft-updates which will speed up a lot of thigs
132# and make the system safer from crashes at the same time.
133# otherwise a STUB module will be compiled in.
134SOFTUPDATES	opt_ffs.h
135
136# Enabling this option turns on support for extended attributes
137# in FFS, which can be used to support high security configurations
138# as well as new file system features.
139FFS_EXTATTR	opt_ffs.h
140
141# The above static dependencies are planned removed, with a
142# <filesystem>_ROOT option to control if it usable as root.  This list
143# allows these options to be present in config files already (though
144# they won't make any difference yet).
145CD9660_ROOT	opt_cd9660.h
146FFS_ROOT	opt_ffs.h
147NFS_ROOT	opt_nfsroot.h
148
149# The union static file system has bogus static dependencies, so it isn't
150# hidden yet.
151UNION
152
153# Options used only in param.c.
154HZ		opt_param.h
155MAXFILES	opt_param.h
156MAXUSERS	opt_param.h
157NBUF		opt_param.h
158NMBCLUSTERS	opt_param.h
159NSFBUFS		opt_param.h
160
161# Generic SCSI options.
162CAM_MAX_HIGHPOWER	opt_cam.h
163CAMDEBUG		opt_cam.h
164CAM_DEBUG_DELAY		opt_cam.h
165CAM_DEBUG_BUS		opt_cam.h
166CAM_DEBUG_TARGET	opt_cam.h
167CAM_DEBUG_LUN		opt_cam.h
168CAM_DEBUG_FLAGS		opt_cam.h
169SCSI_DELAY		opt_scsi.h
170SCSI_NO_SENSE_STRINGS	opt_scsi.h
171SCSI_NO_OP_STRINGS	opt_scsi.h
172
173# Options used only in cam/scsi/scsi_cd.c
174CHANGER_MIN_BUSY_SECONDS	opt_cd.h
175CHANGER_MAX_BUSY_SECONDS	opt_cd.h
176
177# Options used only in cam/scsi/scsi_sa.c.
178SA_SPACE_TIMEOUT	opt_sa.h
179SA_REWIND_TIMEOUT	opt_sa.h
180SA_ERASE_TIMEOUT	opt_sa.h
181SA_1FM_AT_EOD		opt_sa.h
182
183# Options used only in cam/scsi/scsi_pt.c
184SCSI_PT_DEFAULT_TIMEOUT	opt_pt.h
185
186# Options used only in cam/scsi/scsi_ses.c
187SES_ENABLE_PASSTHROUGH	opt_ses.h
188
189# Options used in dev/sym/ (Symbios SCSI driver).
190SYM_SETUP_LP_PROBE_MAP	opt_sym.h	#-Low Priority Probe Map (bits)
191					# Allows the ncr to take precedence
192					# 1 (1<<0) -> 810a, 860
193					# 2 (1<<1) -> 825a, 875, 885, 895
194					# 4 (1<<2) -> 895a, 896, 1510d
195SYM_SETUP_SCSI_DIFF	opt_sym.h	#-HVD support for 825a, 875, 885
196					# disabled:0 (default), enabled:1
197SYM_SETUP_PCI_PARITY	opt_sym.h	#-PCI parity checking
198					# disabled:0, enabled:1 (default)
199SYM_SETUP_MAX_LUN	opt_sym.h	#-Number of LUNs supported
200					# default:8, range:[1..64]
201
202# Options used only in pci/ncr.c
203SCSI_NCR_DEBUG		opt_ncr.h
204SCSI_NCR_MAX_SYNC	opt_ncr.h
205SCSI_NCR_MAX_WIDE	opt_ncr.h
206SCSI_NCR_MYADDR		opt_ncr.h
207
208# Options used only in pci/isp_pci.c
209ISP_TARGET_MODE		opt_isp.h
210
211# Options used in the 'ata' ATA/ATAPI driver
212ATA_STATIC_ID		opt_ata.h
213ATA_ENABLE_ATAPI_DMA	opt_ata.h
214ATA_ENABLE_TAGS		opt_ata.h
215
216# Resource limits.
217DFLDSIZ			opt_rlimit.h
218MAXDSIZ			opt_rlimit.h
219
220# Net stuff.
221ACCEPT_FILTER_DATA
222ACCEPT_FILTER_HTTP
223BOOTP			opt_bootp.h
224BOOTP_COMPAT		opt_bootp.h
225BOOTP_NFSROOT		opt_bootp.h
226BOOTP_NFSV3		opt_bootp.h
227BOOTP_WIRED_TO		opt_bootp.h
228BRIDGE			opt_bdg.h
229ETHER_II		opt_ef.h
230ETHER_8023		opt_ef.h
231ETHER_8022		opt_ef.h
232ETHER_SNAP		opt_ef.h
233MROUTING		opt_mrouting.h
234INET			opt_inet.h
235INET6			opt_inet6.h
236IPSEC			opt_ipsec.h
237IPSEC_ESP		opt_ipsec.h
238IPSEC_DEBUG		opt_ipsec.h
239IPDIVERT
240DUMMYNET		opt_ipdn.h
241IPFILTER		opt_ipfilter.h
242IPFILTER_LOG		opt_ipfilter.h
243IPFILTER_DEFAULT_BLOCK	opt_ipfilter.h
244PFIL_HOOKS		opt_pfil_hooks.h
245IPFIREWALL		opt_ipfw.h
246IPFIREWALL_VERBOSE	opt_ipfw.h
247IPFIREWALL_VERBOSE_LIMIT	opt_ipfw.h
248IPFIREWALL_DEFAULT_TO_ACCEPT	opt_ipfw.h
249IPFIREWALL_FORWARD		opt_ipfw.h
250IPV6FIREWALL		opt_ip6fw.h
251IPV6FIREWALL_VERBOSE	opt_ip6fw.h
252IPV6FIREWALL_VERBOSE_LIMIT	opt_ip6fw.h
253IPV6FIREWALL_DEFAULT_TO_ACCEPT	opt_ip6fw.h
254IPSTEALTH
255IPX			opt_ipx.h
256IPXIP			opt_ipx.h
257IPTUNNEL		opt_ipx.h
258NCP			opt_ncp.h
259NETATALK		opt_atalk.h
260PPP_BSDCOMP		opt_ppp.h
261PPP_DEFLATE		opt_ppp.h
262PPP_FILTER		opt_ppp.h
263SLIP_IFF_OPTS		opt_slip.h
264TCP_COMPAT_42		opt_compat.h
265TCPDEBUG
266TCP_DROP_SYNFIN		opt_tcp_input.h
267TCP_RESTRICT_RST	opt_tcp_input.h
268XBONEHACK
269
270# Netgraph(4). Use option NETGRAPH to enable the base netgraph code.
271# Each netgraph node type can be either be compiled into the kernel
272# or loaded dynamically. To get the former, include the corresponding
273# option below. Each type has its own man page, e.g. ng_async(4).
274NETGRAPH
275NETGRAPH_ASYNC		opt_netgraph.h
276NETGRAPH_BPF		opt_netgraph.h
277NETGRAPH_BRIDGE		opt_netgraph.h
278NETGRAPH_CISCO		opt_netgraph.h
279NETGRAPH_ECHO		opt_netgraph.h
280NETGRAPH_ETHER		opt_netgraph.h
281NETGRAPH_FRAME_RELAY	opt_netgraph.h
282NETGRAPH_HOLE		opt_netgraph.h
283NETGRAPH_IFACE		opt_netgraph.h
284NETGRAPH_KSOCKET	opt_netgraph.h
285NETGRAPH_LMI		opt_netgraph.h
286# MPPC compression requires proprietary files (not included)
287NETGRAPH_MPPC_COMPRESSION	opt_netgraph.h
288NETGRAPH_MPPC_ENCRYPTION	opt_netgraph.h
289NETGRAPH_ONE2MANY	opt_netgraph.h
290NETGRAPH_PPP		opt_netgraph.h
291NETGRAPH_PPPOE		opt_netgraph.h
292NETGRAPH_PPTPGRE	opt_netgraph.h
293NETGRAPH_RFC1490	opt_netgraph.h
294NETGRAPH_SOCKET		opt_netgraph.h
295NETGRAPH_TEE		opt_netgraph.h
296NETGRAPH_TTY		opt_netgraph.h
297NETGRAPH_UI		opt_netgraph.h
298NETGRAPH_VJC		opt_netgraph.h
299
300# ATM (HARP version)
301ATM_CORE		opt_atm.h
302ATM_IP			opt_atm.h
303ATM_SIGPVC		opt_atm.h
304ATM_SPANS		opt_atm.h
305ATM_UNI			opt_atm.h
306
307# XXX Conflict: # of devices vs network protocol (Native ATM).
308# This makes "atm.h" unusable.
309NATM			opt_natm.h
310
311DPT_ALLOW_MEMIO		opt_dpt.h	# Allow PCI devices to use memory
312					# mapped I/O
313# DPT driver debug flags
314DPT_MEASURE_PERFORMANCE	opt_dpt.h
315DPT_HANDLE_TIMEOUTS	opt_dpt.h
316DPT_TIMEOUT_FACTOR	opt_dpt.h
317DPT_LOST_IRQ		opt_dpt.h
318DPT_RESET_HBA		opt_dpt.h
319
320# Adaptec ASR and DPT V/VI controller options
321ASR_MEASURE_PERFORMANCE	opt_asr.h
322
323# Misc debug flags.  Most of these should probably be replaced with
324# 'DEBUG', and then let people recompile just the interesting modules
325# with 'make CC="cc -DDEBUG"'.
326CLUSTERDEBUG		opt_debug_cluster.h
327DEBUG_1284		opt_ppb_1284.h
328VP0_DEBUG		opt_vpo.h
329LPT_DEBUG		opt_lpt.h
330PLIP_DEBUG		opt_plip.h
331LOCKF_DEBUG		opt_debug_lockf.h
332LOUTB			opt_debug_outb.h
333NPX_DEBUG		opt_debug_npx.h
334NETATALKDEBUG		opt_atalk.h
335SI_DEBUG		opt_debug_si.h
336
337# Fb options
338FB_DEBUG		opt_fb.h
339FB_INSTALL_CDEV		opt_fb.h
340
341# ppbus related options
342PERIPH_1284		opt_ppb_1284.h
343DONTPROBE_1284		opt_ppb_1284.h
344
345# smbus related options
346ENABLE_ALART		opt_intpm.h
347
348# These cause changes all over the kernel
349BLKDEV_IOSIZE		opt_global.h
350DEBUG			opt_global.h
351DEBUG_LOCKS		opt_global.h
352DEBUG_VFS_LOCKS		opt_global.h
353DIAGNOSTIC		opt_global.h
354ENABLE_VFS_IOOPT	opt_global.h
355INVARIANT_SUPPORT	opt_global.h
356INVARIANTS		opt_global.h
357SIMPLELOCK_DEBUG	opt_global.h
358VFS_BIO_DEBUG		opt_global.h
359
360# These are VM related options
361VM_KMEM_SIZE		opt_vm.h
362VM_KMEM_SIZE_SCALE	opt_vm.h
363VM_KMEM_SIZE_MAX	opt_vm.h
364NO_SWAPPING		opt_vm.h
365PQ_NOOPT		opt_vmpage.h
366PQ_NORMALCACHE		opt_vmpage.h
367PQ_MEDIUMCACHE		opt_vmpage.h
368PQ_LARGECACHE		opt_vmpage.h
369PQ_HUGECACHE		opt_vmpage.h
370PQ_CACHESIZE		opt_vmpage.h
371
372# Standard SMP options
373SMP			opt_global.h
374
375# sys/netkey
376KEY
377
378# Size of the kernel message buffer
379MSGBUF_SIZE		opt_msgbuf.h
380
381# PCI related options
382PCI_QUIET		opt_pci.h
383
384# NFS options
385NFS_MINATTRTIMO		opt_nfs.h
386NFS_MAXATTRTIMO		opt_nfs.h
387NFS_MINDIRATTRTIMO	opt_nfs.h
388NFS_MAXDIRATTRTIMO	opt_nfs.h
389NFS_GATHERDELAY		opt_nfs.h
390NFS_UIDHASHSIZ		opt_nfs.h
391NFS_WDELAYHASHSIZ	opt_nfs.h
392NFS_MUIDHASHSIZ		opt_nfs.h
393NFS_NOSERVER		opt_nfs.h
394NFS_DEBUG		opt_nfs.h
395
396# For the Bt848/Bt848A/Bt849/Bt878/Bt879 driver
397OVERRIDE_CARD			opt_bktr.h
398OVERRIDE_TUNER			opt_bktr.h
399OVERRIDE_DBX			opt_bktr.h
400OVERRIDE_MSP			opt_bktr.h
401BROOKTREE_SYSTEM_DEFAULT	opt_bktr.h
402BROOKTREE_ALLOC_PAGES		opt_bktr.h
403BKTR_OVERRIDE_CARD		opt_bktr.h
404BKTR_OVERRIDE_TUNER		opt_bktr.h
405BKTR_OVERRIDE_DBX		opt_bktr.h
406BKTR_OVERRIDE_MSP		opt_bktr.h
407BKTR_SYSTEM_DEFAULT		opt_bktr.h
408BKTR_ALLOC_PAGES		opt_bktr.h
409BKTR_USE_PLL			opt_bktr.h
410BKTR_GPIO_ACCESS		opt_bktr.h
411BKTR_NO_MSP_RESET		opt_bktr.h
412BKTR_430_FX_MODE		opt_bktr.h
413BKTR_SIS_VIA_MODE		opt_bktr.h
414
415# meteor opt_meteor.h
416METEOR_ALLOC_PAGES	opt_meteor.h
417METEOR_TEST_VIDEO	opt_meteor.h
418METEOR_SYSTEM_DEFAULT	opt_meteor.h
419METEOR_DEALLOC_PAGES	opt_meteor.h
420METEOR_DEALLOC_ABOVE	opt_meteor.h
421
422# Various mi ISA bus flags
423COM_ESP			opt_sio.h
424COM_MULTIPORT		opt_sio.h
425BREAK_TO_DEBUGGER	opt_comconsole.h
426ALT_BREAK_TO_DEBUGGER	opt_comconsole.h
427
428# Include tweaks for running under the SimOS machine simulator.
429SIMOS			opt_simos.h
430
431# options for bus/device framework
432BUS_DEBUG		opt_bus.h
433DEVICE_SYSCTLS		opt_bus.h
434
435# options for USB support
436UHCI_DEBUG		opt_usb.h
437OHCI_DEBUG		opt_usb.h
438USB_DEBUG		opt_usb.h
439UGEN_DEBUG		opt_usb.h
440UHID_DEBUG		opt_usb.h
441UHUB_DEBUG		opt_usb.h
442UKBD_DEBUG		opt_usb.h
443ULPT_DEBUG		opt_usb.h
444UMASS_DEBUG		opt_usb.h
445UMS_DEBUG		opt_usb.h
446URIO_DEBUG		opt_usb.h
447UKBD_DFLT_KEYMAP	opt_ukbd.h
448
449# Vinum options
450VINUMDEBUG		opt_vinum.h
451
452# Embedded system options
453INIT_PATH		opt_init_path.h
454
455ROOTDEVNAME		opt_rootdevname.h
456
457FDC_DEBUG		opt_fdc.h
458PCFCLOCK_VERBOSE	opt_pcfclock.h
459PCFCLOCK_MAX_RETRIES	opt_pcfclock.h
460TDFX_LINUX opt_tdfx.h
461
462KTR			opt_global.h
463KTR_MASK		opt_ktr.h
464KTR_CPUMASK		opt_ktr.h
465KTR_COMPILE		opt_global.h
466KTR_ENTRIES		opt_global.h
467KTR_EXTEND		opt_global.h
468KTR_VERBOSE		opt_ktr.h
469MUTEX_DEBUG		opt_global.h
470WITNESS			opt_global.h
471WITNESS_DDB		opt_witness.h
472WITNESS_SKIPSPIN	opt_witness.h
473
474# options for ACPI support
475ACPI_DEBUG		opt_acpi.h
476AML_DEBUG		opt_acpi.h
477ACPI_NO_ENABLE_ON_BOOT	opt_acpi.h
478
479# options for DEVFS, see sys/fs/devfs/devfs.h
480NDEVFSINO		opt_devfs.h
481NDEVFSOVERFLOW		opt_devfs.h
482
483# options for device random
484NOBLOCKRANDOM
485