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