kconfig-language.txt 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390
  1. Introduction
  2. ------------
  3. The configuration database is a collection of configuration options
  4. organized in a tree structure:
  5. +- Code maturity level options
  6. | +- Prompt for development and/or incomplete code/drivers
  7. +- General setup
  8. | +- Networking support
  9. | +- System V IPC
  10. | +- BSD Process Accounting
  11. | +- Sysctl support
  12. +- Loadable module support
  13. | +- Enable loadable module support
  14. | +- Set version information on all module symbols
  15. | +- Kernel module loader
  16. +- ...
  17. Every entry has its own dependencies. These dependencies are used
  18. to determine the visibility of an entry. Any child entry is only
  19. visible if its parent entry is also visible.
  20. Menu entries
  21. ------------
  22. Most entries define a config option; all other entries help to organize
  23. them. A single configuration option is defined like this:
  24. config MODVERSIONS
  25. bool "Set version information on all module symbols"
  26. depends on MODULES
  27. help
  28. Usually, modules have to be recompiled whenever you switch to a new
  29. kernel. ...
  30. Every line starts with a key word and can be followed by multiple
  31. arguments. "config" starts a new config entry. The following lines
  32. define attributes for this config option. Attributes can be the type of
  33. the config option, input prompt, dependencies, help text and default
  34. values. A config option can be defined multiple times with the same
  35. name, but every definition can have only a single input prompt and the
  36. type must not conflict.
  37. Menu attributes
  38. ---------------
  39. A menu entry can have a number of attributes. Not all of them are
  40. applicable everywhere (see syntax).
  41. - type definition: "bool"/"tristate"/"string"/"hex"/"int"
  42. Every config option must have a type. There are only two basic types:
  43. tristate and string; the other types are based on these two. The type
  44. definition optionally accepts an input prompt, so these two examples
  45. are equivalent:
  46. bool "Networking support"
  47. and
  48. bool
  49. prompt "Networking support"
  50. - input prompt: "prompt" <prompt> ["if" <expr>]
  51. Every menu entry can have at most one prompt, which is used to display
  52. to the user. Optionally dependencies only for this prompt can be added
  53. with "if".
  54. - default value: "default" <expr> ["if" <expr>]
  55. A config option can have any number of default values. If multiple
  56. default values are visible, only the first defined one is active.
  57. Default values are not limited to the menu entry where they are
  58. defined. This means the default can be defined somewhere else or be
  59. overridden by an earlier definition.
  60. The default value is only assigned to the config symbol if no other
  61. value was set by the user (via the input prompt above). If an input
  62. prompt is visible the default value is presented to the user and can
  63. be overridden by him.
  64. Optionally, dependencies only for this default value can be added with
  65. "if".
  66. - type definition + default value:
  67. "def_bool"/"def_tristate" <expr> ["if" <expr>]
  68. This is a shorthand notation for a type definition plus a value.
  69. Optionally dependencies for this default value can be added with "if".
  70. - dependencies: "depends on" <expr>
  71. This defines a dependency for this menu entry. If multiple
  72. dependencies are defined, they are connected with '&&'. Dependencies
  73. are applied to all other options within this menu entry (which also
  74. accept an "if" expression), so these two examples are equivalent:
  75. bool "foo" if BAR
  76. default y if BAR
  77. and
  78. depends on BAR
  79. bool "foo"
  80. default y
  81. - reverse dependencies: "select" <symbol> ["if" <expr>]
  82. While normal dependencies reduce the upper limit of a symbol (see
  83. below), reverse dependencies can be used to force a lower limit of
  84. another symbol. The value of the current menu symbol is used as the
  85. minimal value <symbol> can be set to. If <symbol> is selected multiple
  86. times, the limit is set to the largest selection.
  87. Reverse dependencies can only be used with boolean or tristate
  88. symbols.
  89. Note:
  90. select should be used with care. select will force
  91. a symbol to a value without visiting the dependencies.
  92. By abusing select you are able to select a symbol FOO even
  93. if FOO depends on BAR that is not set.
  94. In general use select only for non-visible symbols
  95. (no prompts anywhere) and for symbols with no dependencies.
  96. That will limit the usefulness but on the other hand avoid
  97. the illegal configurations all over.
  98. - limiting menu display: "visible if" <expr>
  99. This attribute is only applicable to menu blocks, if the condition is
  100. false, the menu block is not displayed to the user (the symbols
  101. contained there can still be selected by other symbols, though). It is
  102. similar to a conditional "prompt" attribute for individual menu
  103. entries. Default value of "visible" is true.
  104. - numerical ranges: "range" <symbol> <symbol> ["if" <expr>]
  105. This allows to limit the range of possible input values for int
  106. and hex symbols. The user can only input a value which is larger than
  107. or equal to the first symbol and smaller than or equal to the second
  108. symbol.
  109. - help text: "help" or "---help---"
  110. This defines a help text. The end of the help text is determined by
  111. the indentation level, this means it ends at the first line which has
  112. a smaller indentation than the first line of the help text.
  113. "---help---" and "help" do not differ in behaviour, "---help---" is
  114. used to help visually separate configuration logic from help within
  115. the file as an aid to developers.
  116. - misc options: "option" <symbol>[=<value>]
  117. Various less common options can be defined via this option syntax,
  118. which can modify the behaviour of the menu entry and its config
  119. symbol. These options are currently possible:
  120. - "defconfig_list"
  121. This declares a list of default entries which can be used when
  122. looking for the default configuration (which is used when the main
  123. .config doesn't exists yet.)
  124. - "modules"
  125. This declares the symbol to be used as the MODULES symbol, which
  126. enables the third modular state for all config symbols.
  127. - "env"=<value>
  128. This imports the environment variable into Kconfig. It behaves like
  129. a default, except that the value comes from the environment, this
  130. also means that the behaviour when mixing it with normal defaults is
  131. undefined at this point. The symbol is currently not exported back
  132. to the build environment (if this is desired, it can be done via
  133. another symbol).
  134. Menu dependencies
  135. -----------------
  136. Dependencies define the visibility of a menu entry and can also reduce
  137. the input range of tristate symbols. The tristate logic used in the
  138. expressions uses one more state than normal boolean logic to express the
  139. module state. Dependency expressions have the following syntax:
  140. <expr> ::= <symbol> (1)
  141. <symbol> '=' <symbol> (2)
  142. <symbol> '!=' <symbol> (3)
  143. '(' <expr> ')' (4)
  144. '!' <expr> (5)
  145. <expr> '&&' <expr> (6)
  146. <expr> '||' <expr> (7)
  147. Expressions are listed in decreasing order of precedence.
  148. (1) Convert the symbol into an expression. Boolean and tristate symbols
  149. are simply converted into the respective expression values. All
  150. other symbol types result in 'n'.
  151. (2) If the values of both symbols are equal, it returns 'y',
  152. otherwise 'n'.
  153. (3) If the values of both symbols are equal, it returns 'n',
  154. otherwise 'y'.
  155. (4) Returns the value of the expression. Used to override precedence.
  156. (5) Returns the result of (2-/expr/).
  157. (6) Returns the result of min(/expr/, /expr/).
  158. (7) Returns the result of max(/expr/, /expr/).
  159. An expression can have a value of 'n', 'm' or 'y' (or 0, 1, 2
  160. respectively for calculations). A menu entry becomes visible when its
  161. expression evaluates to 'm' or 'y'.
  162. There are two types of symbols: constant and non-constant symbols.
  163. Non-constant symbols are the most common ones and are defined with the
  164. 'config' statement. Non-constant symbols consist entirely of alphanumeric
  165. characters or underscores.
  166. Constant symbols are only part of expressions. Constant symbols are
  167. always surrounded by single or double quotes. Within the quote, any
  168. other character is allowed and the quotes can be escaped using '\'.
  169. Menu structure
  170. --------------
  171. The position of a menu entry in the tree is determined in two ways. First
  172. it can be specified explicitly:
  173. menu "Network device support"
  174. depends on NET
  175. config NETDEVICES
  176. ...
  177. endmenu
  178. All entries within the "menu" ... "endmenu" block become a submenu of
  179. "Network device support". All subentries inherit the dependencies from
  180. the menu entry, e.g. this means the dependency "NET" is added to the
  181. dependency list of the config option NETDEVICES.
  182. The other way to generate the menu structure is done by analyzing the
  183. dependencies. If a menu entry somehow depends on the previous entry, it
  184. can be made a submenu of it. First, the previous (parent) symbol must
  185. be part of the dependency list and then one of these two conditions
  186. must be true:
  187. - the child entry must become invisible, if the parent is set to 'n'
  188. - the child entry must only be visible, if the parent is visible
  189. config MODULES
  190. bool "Enable loadable module support"
  191. config MODVERSIONS
  192. bool "Set version information on all module symbols"
  193. depends on MODULES
  194. comment "module support disabled"
  195. depends on !MODULES
  196. MODVERSIONS directly depends on MODULES, this means it's only visible if
  197. MODULES is different from 'n'. The comment on the other hand is always
  198. visible when MODULES is visible (the (empty) dependency of MODULES is
  199. also part of the comment dependencies).
  200. Kconfig syntax
  201. --------------
  202. The configuration file describes a series of menu entries, where every
  203. line starts with a keyword (except help texts). The following keywords
  204. end a menu entry:
  205. - config
  206. - menuconfig
  207. - choice/endchoice
  208. - comment
  209. - menu/endmenu
  210. - if/endif
  211. - source
  212. The first five also start the definition of a menu entry.
  213. config:
  214. "config" <symbol>
  215. <config options>
  216. This defines a config symbol <symbol> and accepts any of above
  217. attributes as options.
  218. menuconfig:
  219. "menuconfig" <symbol>
  220. <config options>
  221. This is similar to the simple config entry above, but it also gives a
  222. hint to front ends, that all suboptions should be displayed as a
  223. separate list of options.
  224. choices:
  225. "choice" [symbol]
  226. <choice options>
  227. <choice block>
  228. "endchoice"
  229. This defines a choice group and accepts any of the above attributes as
  230. options. A choice can only be of type bool or tristate, while a boolean
  231. choice only allows a single config entry to be selected, a tristate
  232. choice also allows any number of config entries to be set to 'm'. This
  233. can be used if multiple drivers for a single hardware exists and only a
  234. single driver can be compiled/loaded into the kernel, but all drivers
  235. can be compiled as modules.
  236. A choice accepts another option "optional", which allows to set the
  237. choice to 'n' and no entry needs to be selected.
  238. If no [symbol] is associated with a choice, then you can not have multiple
  239. definitions of that choice. If a [symbol] is associated to the choice,
  240. then you may define the same choice (ie. with the same entries) in another
  241. place.
  242. comment:
  243. "comment" <prompt>
  244. <comment options>
  245. This defines a comment which is displayed to the user during the
  246. configuration process and is also echoed to the output files. The only
  247. possible options are dependencies.
  248. menu:
  249. "menu" <prompt>
  250. <menu options>
  251. <menu block>
  252. "endmenu"
  253. This defines a menu block, see "Menu structure" above for more
  254. information. The only possible options are dependencies and "visible"
  255. attributes.
  256. if:
  257. "if" <expr>
  258. <if block>
  259. "endif"
  260. This defines an if block. The dependency expression <expr> is appended
  261. to all enclosed menu entries.
  262. source:
  263. "source" <prompt>
  264. This reads the specified configuration file. This file is always parsed.
  265. mainmenu:
  266. "mainmenu" <prompt>
  267. This sets the config program's title bar if the config program chooses
  268. to use it. It should be placed at the top of the configuration, before any
  269. other statement.
  270. Kconfig hints
  271. -------------
  272. This is a collection of Kconfig tips, most of which aren't obvious at
  273. first glance and most of which have become idioms in several Kconfig
  274. files.
  275. Adding common features and make the usage configurable
  276. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  277. It is a common idiom to implement a feature/functionality that are
  278. relevant for some architectures but not all.
  279. The recommended way to do so is to use a config variable named HAVE_*
  280. that is defined in a common Kconfig file and selected by the relevant
  281. architectures.
  282. An example is the generic IOMAP functionality.
  283. We would in lib/Kconfig see:
  284. # Generic IOMAP is used to ...
  285. config HAVE_GENERIC_IOMAP
  286. config GENERIC_IOMAP
  287. depends on HAVE_GENERIC_IOMAP && FOO
  288. And in lib/Makefile we would see:
  289. obj-$(CONFIG_GENERIC_IOMAP) += iomap.o
  290. For each architecture using the generic IOMAP functionality we would see:
  291. config X86
  292. select ...
  293. select HAVE_GENERIC_IOMAP
  294. select ...
  295. Note: we use the existing config option and avoid creating a new
  296. config variable to select HAVE_GENERIC_IOMAP.
  297. Note: the use of the internal config variable HAVE_GENERIC_IOMAP, it is
  298. introduced to overcome the limitation of select which will force a
  299. config option to 'y' no matter the dependencies.
  300. The dependencies are moved to the symbol GENERIC_IOMAP and we avoid the
  301. situation where select forces a symbol equals to 'y'.
  302. Build as module only
  303. ~~~~~~~~~~~~~~~~~~~~
  304. To restrict a component build to module-only, qualify its config symbol
  305. with "depends on m". E.g.:
  306. config FOO
  307. depends on BAR && m
  308. limits FOO to module (=m) or disabled (=n).