xref: /freebsd/sys/conf/options (revision a1a4f1a0d87b594d3f17a97dc0127eec1417e6f6)
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
57MD5
58MFS_ROOT	opt_mfs.h
59MFS_ROOT_SIZE	opt_mfs.h
60NTIMECOUNTER	opt_ntp.h
61EXPORTMFS	opt_mfs.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
70UCONSOLE
71ICMP_BANDLIM
72
73# POSIX kernel options
74P1003_1B	opt_posix.h
75_KPOSIX_PRIORITY_SCHEDULING opt_posix.h
76_KPOSIX_VERSION opt_posix.h
77
78# Do we want the config file compiled into the kernel?
79INCLUDE_CONFIG_FILE	opt_config.h
80
81# Options for static file systems.  These should only be used at config
82# time, since the corresponding lkms cannot work if there are any static
83# dependencies.  Unusability is enforced by hiding the defines for the
84# options in a never-included header.
85EXT2FS		opt_dontuse.h
86FDESC		opt_dontuse.h
87KERNFS		opt_dontuse.h
88MFS		opt_dontuse.h
89MSDOSFS		opt_dontuse.h
90NULLFS		opt_dontuse.h
91PORTAL		opt_dontuse.h
92PROCFS		opt_dontuse.h
93UMAPFS		opt_dontuse.h
94NTFS		opt_dontuse.h
95
96# These static filesystems has one slightly bogus static dependency in
97# sys/i386/i386/autoconf.c.  If any of these filesystems are
98# statically compiled into the kernel, code for mounting them as root
99# filesystems will be enabled - but look below.  Boot-code is purposely
100# unavailable for the LKM-based versions.
101CODA
102CD9660
103FFS
104NFS
105
106# If you are following the conditions in the copyright,
107# you can enable soft-updates which will speed up a lot of thigs
108# and make the system safer from crashes at the same time.
109# otherwise a STUB module will be compiled in.
110SOFTUPDATES	opt_ffs.h
111
112# The above static dependencies are planned removed, with a
113# <filesystem>_ROOT option to control if it usable as root.  This list
114# allows these options to be present in config files already (though
115# they won't make any difference yet).
116CD9660_ROOT	opt_cd9660.h
117FFS_ROOT	opt_ffs.h
118NFS_ROOT	opt_nfsroot.h
119
120# Multi-session CD-Rs might require a huge amount of time in order to
121# "settle".  If we are about mounting them as the root f/s, we gotta
122# wait a little.
123CD9660_ROOTDELAY	opt_cd9660.h
124
125# The union static file system has bogus static dependencies, so it isn't
126# hidden yet.
127UNION
128
129# Options used only in param.c.
130HZ		opt_param.h
131MAXFILES	opt_param.h
132MAXUSERS	opt_param.h
133MSGMNB		opt_param.h
134MSGMNI		opt_param.h
135MSGSEG		opt_param.h
136MSGSSZ		opt_param.h
137MSGTQL		opt_param.h
138NBUF		opt_param.h
139NMBCLUSTERS	opt_param.h
140NSFBUFS		opt_param.h
141SEMMAP		opt_param.h
142SEMMNI		opt_param.h
143SEMMNS		opt_param.h
144SEMMNU		opt_param.h
145SEMMSL		opt_param.h
146SEMOPM		opt_param.h
147SEMUME		opt_param.h
148SHMALL		opt_param.h
149SHMMAX		opt_param.h
150SHMMAXPGS	opt_param.h
151SHMMIN		opt_param.h
152SHMMNI		opt_param.h
153SHMSEG		opt_param.h
154
155# Generic SCSI options.
156CAM_MAX_HIGHPOWER	opt_cam.h
157CAMDEBUG		opt_cam.h
158CAM_DEBUG_DELAY		opt_cam.h
159CAM_DEBUG_BUS		opt_cam.h
160CAM_DEBUG_TARGET	opt_cam.h
161CAM_DEBUG_LUN		opt_cam.h
162CAM_DEBUG_FLAGS		opt_cam.h
163SCSI_DELAY		opt_scsi.h
164SCSI_REPORT_GEOMETRY	opt_scsi.h
165SCSI_NO_SENSE_STRINGS	opt_scsi.h
166SCSI_NO_OP_STRINGS	opt_scsi.h
167
168# Options used only in cam/scsi/scsi_cd.c
169CHANGER_MIN_BUSY_SECONDS	opt_cd.h
170CHANGER_MAX_BUSY_SECONDS	opt_cd.h
171
172# Options used only in cam/scsi/scsi_sa.c.
173SA_SPACE_TIMEOUT	opt_sa.h
174SA_REWIND_TIMEOUT	opt_sa.h
175SA_ERASE_TIMEOUT	opt_sa.h
176
177# Options used only in cam/scsi/scsi_pt.c
178SCSI_PT_DEFAULT_TIMEOUT	opt_pt.h
179
180# Options used only in pci/ncr.c
181SCSI_NCR_DEBUG		opt_ncr.h
182SCSI_NCR_DFLT_TAGS	opt_ncr.h
183SCSI_NCR_MAX_SYNC	opt_ncr.h
184SCSI_NCR_MAX_WIDE	opt_ncr.h
185SCSI_NCR_MYADDR		opt_ncr.h
186
187# Options used only in pci/isp_pci.c
188SCSI_ISP_NO_FWLOAD_MASK	opt_isp.h
189SCSI_ISP_NO_NVRAM_MASK	opt_isp.h
190SCSI_ISP_PREFER_MEM_MAP	opt_isp.h
191SCSI_ISP_FABRIC		opt_isp.h
192SCSI_ISP_SCCLUN		opt_isp.h
193SCSI_ISP_FCDUPLEX	opt_isp.h
194ISP_DISABLE_1020_SUPPORT	opt_isp.h
195ISP_DISABLE_1080_SUPPORT	opt_isp.h
196ISP_DISABLE_2100_SUPPORT	opt_isp.h
197ISP_DISABLE_2200_SUPPORT	opt_isp.h
198
199# Resource limits.
200DFLDSIZ			opt_rlimit.h
201MAXDSIZ			opt_rlimit.h
202
203# Net stuff.
204BOOTP			opt_bootp.h
205BOOTP_COMPAT		opt_bootp.h
206BOOTP_NFSROOT		opt_bootp.h
207BOOTP_NFSV3		opt_bootp.h
208BOOTP_WIRED_TO		opt_bootp.h
209BRIDGE			opt_bdg.h
210MROUTING		opt_mrouting.h
211INET			opt_inet.h
212IPDIVERT
213DUMMYNET		opt_ipdn.h
214IPFILTER		opt_ipfilter.h
215IPFILTER_LOG		opt_ipfilter.h
216IPFIREWALL		opt_ipfw.h
217IPFIREWALL_VERBOSE	opt_ipfw.h
218IPFIREWALL_VERBOSE_LIMIT	opt_ipfw.h
219IPFIREWALL_DEFAULT_TO_ACCEPT	opt_ipfw.h
220IPFIREWALL_FORWARD		opt_ipfw.h
221IPSTEALTH
222IPX			opt_ipx.h
223IPXIP			opt_ipx.h
224IPTUNNEL		opt_ipx.h
225NETATALK		opt_atalk.h
226PPP_BSDCOMP		opt_ppp.h
227PPP_DEFLATE		opt_ppp.h
228PPP_FILTER		opt_ppp.h
229SLIP_IFF_OPTS		opt_slip.h
230TCP_COMPAT_42		opt_compat.h
231TCPDEBUG
232
233# ATM (HARP version)
234ATM_CORE		opt_atm.h
235ATM_IP			opt_atm.h
236ATM_SIGPVC		opt_atm.h
237ATM_SPANS		opt_atm.h
238ATM_UNI			opt_atm.h
239
240# XXX Conflict: # of devices vs network protocol (Native ATM).
241# This makes "atm.h" unusable.
242NATM			opt_natm.h
243
244DPT_ALLOW_MEMIO		opt_dpt.h	# Allow PCI devices to use memory
245					# mapped I/O
246# DPT driver debug flags
247DPT_VERIFY_HINTR	opt_dpt.h
248DPT_USE_SINTR		opt_dpt.h
249DPT_RESTRICTED_FREELIST	opt_dpt.h
250DPT_MEASURE_PERFORMANCE	opt_dpt.h
251DPT_FREELIST_IS_STACK	opt_dpt.h
252DPT_HANDLE_TIMEOUTS	opt_dpt.h
253DPT_TIMEOUT_FACTOR	opt_dpt.h
254DPT_INTR_DELAY		opt_dpt.h
255DPT_LOST_IRQ		opt_dpt.h
256DPT_SHUTDOWN_SLEEP	opt_dpt.h
257DPT_RESET_HBA		opt_dpt.h
258
259# Misc debug flags.  Most of these should probably be replaced with
260# 'DEBUG', and then let people recompile just the interesting modules
261# with 'make CC="cc -DDEBUG"'.
262CLUSTERDEBUG		opt_debug_cluster.h
263DEBUG_1284		opt_ppb_1284.h
264VP0_DEBUG		opt_vpo.h
265LPT_DEBUG		opt_lpt.h
266PLIP_DEBUG		opt_plip.h
267LOCKF_DEBUG		opt_debug_lockf.h
268LOUTB			opt_debug_outb.h
269NPX_DEBUG		opt_debug_npx.h
270NETATALKDEBUG		opt_atalk.h
271NULLFS_DIAGNOSTIC	opt_debug_nullfs.h
272SI_DEBUG		opt_debug_si.h
273
274# ppbus related options
275PERIPH_1284		opt_ppb_1284.h
276DONTPROBE_1284		opt_ppb_1284.h
277
278# smbus related options
279ENABLE_ALART		opt_intpm.h
280
281# These cause changes all over the kernel
282DEBUG			opt_global.h
283DEBUG_LOCKS		opt_global.h
284DEBUG_VFS_LOCKS		opt_global.h
285DIAGNOSTIC		opt_global.h
286ENABLE_VFS_IOOPT	opt_global.h
287INVARIANT_SUPPORT	opt_global.h
288INVARIANTS		opt_global.h
289SIMPLELOCK_DEBUG	opt_global.h
290VFS_BIO_DEBUG		opt_global.h
291
292# These are VM related options
293VM_KMEM_SIZE	opt_vm.h
294VM_KMEM_SIZE_SCALE opt_vm.h
295VM_KMEM_SIZE_MAX	opt_vm.h
296NO_SWAPPING	opt_vm.h
297PQ_NOOPT	opt_vmpage.h
298PQ_NORMALCACHE	opt_vmpage.h
299PQ_MEDIUMCACHE	opt_vmpage.h
300PQ_LARGECACHE	opt_vmpage.h
301PQ_HUGECACHE	opt_vmpage.h
302
303# Standard SMP options
304SMP			opt_global.h
305NCPU			opt_smp.h
306NBUS			opt_smp.h
307
308# sys/netkey
309KEY
310KEY_DEBUG		opt_key.h
311
312# Size of the kernel message buffer
313MSGBUF_SIZE		opt_msgbuf.h
314
315# PCI related options
316PCI_QUIET		opt_pci.h
317
318# NFS options
319NFS_MINATTRTIMO		opt_nfs.h
320NFS_MAXATTRTIMO		opt_nfs.h
321NFS_MINDIRATTRTIMO	opt_nfs.h
322NFS_MAXDIRATTRTIMO	opt_nfs.h
323NFS_GATHERDELAY		opt_nfs.h
324NFS_UIDHASHSIZ		opt_nfs.h
325NFS_WDELAYHASHSIZ	opt_nfs.h
326NFS_MUIDHASHSIZ		opt_nfs.h
327NFS_NOSERVER		opt_nfs.h
328NFS_DEBUG		opt_nfs.h
329
330# For the Bt848/Bt848A/Bt849/Bt878/Bt879 driver
331OVERRIDE_CARD		opt_bktr.h
332OVERRIDE_TUNER		opt_bktr.h
333OVERRIDE_DBX		opt_bktr.h
334OVERRIDE_MSP		opt_bktr.h
335BROOKTREE_SYSTEM_DEFAULT opt_bktr.h
336BKTR_USE_PLL		opt_bktr.h
337BKTR_GPIO_ACCESS	opt_bktr.h
338BKTR_NO_MSP_RESET	opt_bktr.h
339BKTR_430_FX_MODE	opt_bktr.h
340BKTR_SIS_VIA_MODE	opt_bktr.h
341
342
343# meteor opt_meteor.h
344METEOR_ALLOC_PAGES	opt_meteor.h
345METEOR_TEST_VIDEO	opt_meteor.h
346METEOR_SYSTEM_DEFAULT	opt_meteor.h
347METEOR_DEALLOC_PAGES	opt_meteor.h
348METEOR_DEALLOC_ABOVE	opt_meteor.h
349
350# Various mi ISA bus flags
351COM_ESP                 opt_sio.h
352COM_MULTIPORT           opt_sio.h
353EXTRA_SIO               opt_sio.h
354
355# Include tweaks for running under the SimOS machine simulator.
356SIMOS			opt_simos.h
357
358# options for bus/device framework
359BUS_DEBUG		opt_bus.h
360
361# options for USB support
362UHCI_DEBUG		opt_usb.h
363OHCI_DEBUG		opt_usb.h
364USB_DEBUG		opt_usb.h
365UGEN_DEBUG		opt_usb.h
366UHID_DEBUG		opt_usb.h
367UHUB_DEBUG		opt_usb.h
368UKBD_DEBUG		opt_usb.h
369ULPT_DEBUG		opt_usb.h
370UMASS_DEBUG		opt_usb.h
371UMS_DEBUG		opt_usb.h
372
373# Vinum options
374VINUMDEBUG		opt_vinum.h
375
376# Embedded system options
377INIT_PATH		opt_init_path.h
378
379ROOTDEVNAME		opt_rootdevname.h
380
381FDC_DEBUG		opt_fdc.h
382FDC_YE			opt_fdc.h
383