xref: /freebsd/sys/conf/options (revision a79b71281cd63ad7a6cc43a6d5673a2510b51630)
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# TrustedBSD and POSIX.1e Kernel Options
98CAPABILITIES	opt_cap.h
99
100# Do we want the config file compiled into the kernel?
101INCLUDE_CONFIG_FILE	opt_config.h
102
103# Options for static file systems.  These should only be used at config
104# time, since the corresponding lkms cannot work if there are any static
105# dependencies.  Unusability is enforced by hiding the defines for the
106# options in a never-included header.
107EXT2FS		opt_dontuse.h
108FDESC		opt_dontuse.h
109KERNFS		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
126NFS
127NWFS
128
129# If you are following the conditions in the copyright,
130# you can enable soft-updates which will speed up a lot of thigs
131# and make the system safer from crashes at the same time.
132# otherwise a STUB module will be compiled in.
133SOFTUPDATES	opt_ffs.h
134
135# Enabling this option turns on support for extended attributes
136# in FFS, which can be used to support high security configurations
137# as well as new file system features.
138FFS_EXTATTR	opt_ffs.h
139
140# The above static dependencies are planned removed, with a
141# <filesystem>_ROOT option to control if it usable as root.  This list
142# allows these options to be present in config files already (though
143# they won't make any difference yet).
144CD9660_ROOT	opt_cd9660.h
145FFS_ROOT	opt_ffs.h
146NFS_ROOT	opt_nfsroot.h
147
148# The union static file system has bogus static dependencies, so it isn't
149# hidden yet.
150UNION
151
152# Options used only in param.c.
153HZ		opt_param.h
154MAXFILES	opt_param.h
155MAXUSERS	opt_param.h
156NBUF		opt_param.h
157NMBCLUSTERS	opt_param.h
158NSFBUFS		opt_param.h
159
160# Generic SCSI options.
161CAM_MAX_HIGHPOWER	opt_cam.h
162CAMDEBUG		opt_cam.h
163CAM_DEBUG_DELAY		opt_cam.h
164CAM_DEBUG_BUS		opt_cam.h
165CAM_DEBUG_TARGET	opt_cam.h
166CAM_DEBUG_LUN		opt_cam.h
167CAM_DEBUG_FLAGS		opt_cam.h
168SCSI_DELAY		opt_scsi.h
169SCSI_NO_SENSE_STRINGS	opt_scsi.h
170SCSI_NO_OP_STRINGS	opt_scsi.h
171
172# Options used only in cam/scsi/scsi_cd.c
173CHANGER_MIN_BUSY_SECONDS	opt_cd.h
174CHANGER_MAX_BUSY_SECONDS	opt_cd.h
175
176# Options used only in cam/scsi/scsi_sa.c.
177SA_SPACE_TIMEOUT	opt_sa.h
178SA_REWIND_TIMEOUT	opt_sa.h
179SA_ERASE_TIMEOUT	opt_sa.h
180SA_1FM_AT_EOD		opt_sa.h
181
182# Options used only in cam/scsi/scsi_pt.c
183SCSI_PT_DEFAULT_TIMEOUT	opt_pt.h
184
185# Options used only in cam/scsi/scsi_ses.c
186SES_ENABLE_PASSTHROUGH	opt_ses.h
187
188# Options used in dev/sym/ (Symbios SCSI driver).
189SYM_SETUP_LP_PROBE_MAP	opt_sym.h	#-Low Priority Probe Map (bits)
190					# Allows the ncr to take precedence
191					# 1 (1<<0) -> 810a, 860
192					# 2 (1<<1) -> 825a, 875, 885, 895
193					# 4 (1<<2) -> 895a, 896, 1510d
194SYM_SETUP_SCSI_DIFF	opt_sym.h	#-HVD support for 825a, 875, 885
195					# disabled:0 (default), enabled:1
196SYM_SETUP_PCI_PARITY	opt_sym.h	#-PCI parity checking
197					# disabled:0, enabled:1 (default)
198SYM_SETUP_MAX_LUN	opt_sym.h	#-Number of LUNs supported
199					# default:8, range:[1..64]
200
201# Options used only in pci/ncr.c
202SCSI_NCR_DEBUG		opt_ncr.h
203SCSI_NCR_MAX_SYNC	opt_ncr.h
204SCSI_NCR_MAX_WIDE	opt_ncr.h
205SCSI_NCR_MYADDR		opt_ncr.h
206
207# Options used only in pci/isp_pci.c
208ISP_TARGET_MODE		opt_isp.h
209
210# Options used in the 'ata' ATA/ATAPI driver
211ATA_STATIC_ID		opt_ata.h
212ATA_ENABLE_ATAPI_DMA	opt_ata.h
213
214# Resource limits.
215DFLDSIZ			opt_rlimit.h
216MAXDSIZ			opt_rlimit.h
217
218# Net stuff.
219ACCEPT_FILTER_DATA
220ACCEPT_FILTER_HTTP
221BOOTP			opt_bootp.h
222BOOTP_COMPAT		opt_bootp.h
223BOOTP_NFSROOT		opt_bootp.h
224BOOTP_NFSV3		opt_bootp.h
225BOOTP_WIRED_TO		opt_bootp.h
226BRIDGE			opt_bdg.h
227ETHER_II		opt_ef.h
228ETHER_8023		opt_ef.h
229ETHER_8022		opt_ef.h
230ETHER_SNAP		opt_ef.h
231MROUTING		opt_mrouting.h
232INET			opt_inet.h
233INET6			opt_inet6.h
234IPSEC			opt_ipsec.h
235IPSEC_ESP		opt_ipsec.h
236IPSEC_DEBUG		opt_ipsec.h
237IPSEC_IPV6FWD		opt_ipsec.h
238IPDIVERT
239DUMMYNET		opt_ipdn.h
240IPFILTER		opt_ipfilter.h
241IPFILTER_LOG		opt_ipfilter.h
242IPFILTER_DEFAULT_BLOCK	opt_ipfilter.h
243PFIL_HOOKS		opt_pfil_hooks.h
244IPFIREWALL		opt_ipfw.h
245IPFIREWALL_VERBOSE	opt_ipfw.h
246IPFIREWALL_VERBOSE_LIMIT	opt_ipfw.h
247IPFIREWALL_DEFAULT_TO_ACCEPT	opt_ipfw.h
248IPFIREWALL_FORWARD		opt_ipfw.h
249IPV6FIREWALL		opt_ip6fw.h
250IPV6FIREWALL_VERBOSE	opt_ip6fw.h
251IPV6FIREWALL_VERBOSE_LIMIT	opt_ip6fw.h
252IPV6FIREWALL_DEFAULT_TO_ACCEPT	opt_ip6fw.h
253IPSTEALTH
254IPX			opt_ipx.h
255IPXIP			opt_ipx.h
256IPTUNNEL		opt_ipx.h
257NCP			opt_ncp.h
258NETATALK		opt_atalk.h
259PPP_BSDCOMP		opt_ppp.h
260PPP_DEFLATE		opt_ppp.h
261PPP_FILTER		opt_ppp.h
262SLIP_IFF_OPTS		opt_slip.h
263TCP_COMPAT_42		opt_compat.h
264TCPDEBUG
265TCP_DROP_SYNFIN		opt_tcp_input.h
266TCP_RESTRICT_RST	opt_tcp_input.h
267
268# Netgraph(4). Use option NETGRAPH to enable the base netgraph code.
269# Each netgraph node type can be either be compiled into the kernel
270# or loaded dynamically. To get the former, include the corresponding
271# option below. Each type has its own man page, e.g. ng_async(8).
272NETGRAPH
273NETGRAPH_ASYNC		opt_netgraph.h
274NETGRAPH_BPF		opt_netgraph.h
275NETGRAPH_CISCO		opt_netgraph.h
276NETGRAPH_ECHO		opt_netgraph.h
277NETGRAPH_FRAME_RELAY	opt_netgraph.h
278NETGRAPH_HOLE		opt_netgraph.h
279NETGRAPH_IFACE		opt_netgraph.h
280NETGRAPH_KSOCKET	opt_netgraph.h
281NETGRAPH_LMI		opt_netgraph.h
282# MPPC compression requires proprietary files (not included)
283NETGRAPH_MPPC_COMPRESSION	opt_netgraph.h
284NETGRAPH_MPPC_ENCRYPTION	opt_netgraph.h
285NETGRAPH_PPP		opt_netgraph.h
286NETGRAPH_PPPOE		opt_netgraph.h
287NETGRAPH_PPTPGRE	opt_netgraph.h
288NETGRAPH_RFC1490	opt_netgraph.h
289NETGRAPH_SOCKET		opt_netgraph.h
290NETGRAPH_TEE		opt_netgraph.h
291NETGRAPH_TTY		opt_netgraph.h
292NETGRAPH_UI		opt_netgraph.h
293NETGRAPH_VJC		opt_netgraph.h
294
295# ATM (HARP version)
296ATM_CORE		opt_atm.h
297ATM_IP			opt_atm.h
298ATM_SIGPVC		opt_atm.h
299ATM_SPANS		opt_atm.h
300ATM_UNI			opt_atm.h
301
302# XXX Conflict: # of devices vs network protocol (Native ATM).
303# This makes "atm.h" unusable.
304NATM			opt_natm.h
305
306DPT_ALLOW_MEMIO		opt_dpt.h	# Allow PCI devices to use memory
307					# mapped I/O
308# DPT driver debug flags
309DPT_MEASURE_PERFORMANCE	opt_dpt.h
310DPT_HANDLE_TIMEOUTS	opt_dpt.h
311DPT_TIMEOUT_FACTOR	opt_dpt.h
312DPT_LOST_IRQ		opt_dpt.h
313DPT_RESET_HBA		opt_dpt.h
314
315# Misc debug flags.  Most of these should probably be replaced with
316# 'DEBUG', and then let people recompile just the interesting modules
317# with 'make CC="cc -DDEBUG"'.
318CLUSTERDEBUG		opt_debug_cluster.h
319DEBUG_1284		opt_ppb_1284.h
320VP0_DEBUG		opt_vpo.h
321LPT_DEBUG		opt_lpt.h
322PLIP_DEBUG		opt_plip.h
323LOCKF_DEBUG		opt_debug_lockf.h
324LOUTB			opt_debug_outb.h
325NPX_DEBUG		opt_debug_npx.h
326NETATALKDEBUG		opt_atalk.h
327SI_DEBUG		opt_debug_si.h
328
329# Fb options
330FB_DEBUG		opt_fb.h
331FB_INSTALL_CDEV		opt_fb.h
332
333# ppbus related options
334PERIPH_1284		opt_ppb_1284.h
335DONTPROBE_1284		opt_ppb_1284.h
336
337# smbus related options
338ENABLE_ALART		opt_intpm.h
339
340# These cause changes all over the kernel
341BLKDEV_IOSIZE		opt_global.h
342DEBUG			opt_global.h
343DEBUG_LOCKS		opt_global.h
344DEBUG_VFS_LOCKS		opt_global.h
345DIAGNOSTIC		opt_global.h
346ENABLE_VFS_IOOPT	opt_global.h
347INVARIANT_SUPPORT	opt_global.h
348INVARIANTS		opt_global.h
349SIMPLELOCK_DEBUG	opt_global.h
350VFS_BIO_DEBUG		opt_global.h
351
352# These are VM related options
353VM_KMEM_SIZE		opt_vm.h
354VM_KMEM_SIZE_SCALE	opt_vm.h
355VM_KMEM_SIZE_MAX	opt_vm.h
356NO_SWAPPING		opt_vm.h
357PQ_NOOPT		opt_vmpage.h
358PQ_NORMALCACHE		opt_vmpage.h
359PQ_MEDIUMCACHE		opt_vmpage.h
360PQ_LARGECACHE		opt_vmpage.h
361PQ_HUGECACHE		opt_vmpage.h
362
363# Standard SMP options
364SMP			opt_global.h
365NCPU			opt_smp.h
366NBUS			opt_smp.h
367
368# sys/netkey
369KEY
370
371# Size of the kernel message buffer
372MSGBUF_SIZE		opt_msgbuf.h
373
374# PCI related options
375PCI_QUIET		opt_pci.h
376COMPAT_OLDPCI
377
378# NFS options
379NFS_MINATTRTIMO		opt_nfs.h
380NFS_MAXATTRTIMO		opt_nfs.h
381NFS_MINDIRATTRTIMO	opt_nfs.h
382NFS_MAXDIRATTRTIMO	opt_nfs.h
383NFS_GATHERDELAY		opt_nfs.h
384NFS_UIDHASHSIZ		opt_nfs.h
385NFS_WDELAYHASHSIZ	opt_nfs.h
386NFS_MUIDHASHSIZ		opt_nfs.h
387NFS_NOSERVER		opt_nfs.h
388NFS_DEBUG		opt_nfs.h
389
390# For the Bt848/Bt848A/Bt849/Bt878/Bt879 driver
391OVERRIDE_CARD			opt_bktr.h
392OVERRIDE_TUNER			opt_bktr.h
393OVERRIDE_DBX			opt_bktr.h
394OVERRIDE_MSP			opt_bktr.h
395BROOKTREE_SYSTEM_DEFAULT	opt_bktr.h
396BKTR_USE_PLL			opt_bktr.h
397BKTR_GPIO_ACCESS		opt_bktr.h
398BKTR_NO_MSP_RESET		opt_bktr.h
399BKTR_430_FX_MODE		opt_bktr.h
400BKTR_SIS_VIA_MODE		opt_bktr.h
401
402
403# meteor opt_meteor.h
404METEOR_ALLOC_PAGES	opt_meteor.h
405METEOR_TEST_VIDEO	opt_meteor.h
406METEOR_SYSTEM_DEFAULT	opt_meteor.h
407METEOR_DEALLOC_PAGES	opt_meteor.h
408METEOR_DEALLOC_ABOVE	opt_meteor.h
409
410# Various mi ISA bus flags
411COM_ESP			opt_sio.h
412COM_MULTIPORT		opt_sio.h
413BREAK_TO_DEBUGGER	opt_comconsole.h
414ALT_BREAK_TO_DEBUGGER	opt_comconsole.h
415
416# Include tweaks for running under the SimOS machine simulator.
417SIMOS			opt_simos.h
418
419# options for bus/device framework
420BUS_DEBUG		opt_bus.h
421DEVICE_SYSCTLS		opt_bus.h
422
423# options for USB support
424UHCI_DEBUG		opt_usb.h
425OHCI_DEBUG		opt_usb.h
426USB_DEBUG		opt_usb.h
427UGEN_DEBUG		opt_usb.h
428UHID_DEBUG		opt_usb.h
429UHUB_DEBUG		opt_usb.h
430UKBD_DEBUG		opt_usb.h
431ULPT_DEBUG		opt_usb.h
432UMASS_DEBUG		opt_usb.h
433UMS_DEBUG		opt_usb.h
434URIO_DEBUG		opt_usb.h
435UKBD_DFLT_KEYMAP	opt_ukbd.h
436
437# Vinum options
438VINUMDEBUG		opt_vinum.h
439
440# Embedded system options
441INIT_PATH		opt_init_path.h
442
443ROOTDEVNAME		opt_rootdevname.h
444
445FDC_DEBUG		opt_fdc.h
446PCFCLOCK_VERBOSE	opt_pcfclock.h
447PCFCLOCK_MAX_RETRIES	opt_pcfclock.h
448