adk/config/kconfig-language.txt

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