1cd238effSMauro Carvalho Chehab================ 2cd238effSMauro Carvalho ChehabKconfig Language 3cd238effSMauro Carvalho Chehab================ 4cd238effSMauro Carvalho Chehab 5cd238effSMauro Carvalho ChehabIntroduction 6cd238effSMauro Carvalho Chehab------------ 7cd238effSMauro Carvalho Chehab 8cd238effSMauro Carvalho ChehabThe configuration database is a collection of configuration options 9cd238effSMauro Carvalho Chehaborganized in a tree structure:: 10cd238effSMauro Carvalho Chehab 11cd238effSMauro Carvalho Chehab +- Code maturity level options 12cd238effSMauro Carvalho Chehab | +- Prompt for development and/or incomplete code/drivers 13cd238effSMauro Carvalho Chehab +- General setup 14cd238effSMauro Carvalho Chehab | +- Networking support 15cd238effSMauro Carvalho Chehab | +- System V IPC 16cd238effSMauro Carvalho Chehab | +- BSD Process Accounting 17cd238effSMauro Carvalho Chehab | +- Sysctl support 18cd238effSMauro Carvalho Chehab +- Loadable module support 19cd238effSMauro Carvalho Chehab | +- Enable loadable module support 20cd238effSMauro Carvalho Chehab | +- Set version information on all module symbols 21cd238effSMauro Carvalho Chehab | +- Kernel module loader 22cd238effSMauro Carvalho Chehab +- ... 23cd238effSMauro Carvalho Chehab 24cd238effSMauro Carvalho ChehabEvery entry has its own dependencies. These dependencies are used 25cd238effSMauro Carvalho Chehabto determine the visibility of an entry. Any child entry is only 26cd238effSMauro Carvalho Chehabvisible if its parent entry is also visible. 27cd238effSMauro Carvalho Chehab 28cd238effSMauro Carvalho ChehabMenu entries 29cd238effSMauro Carvalho Chehab------------ 30cd238effSMauro Carvalho Chehab 31cd238effSMauro Carvalho ChehabMost entries define a config option; all other entries help to organize 32cd238effSMauro Carvalho Chehabthem. A single configuration option is defined like this:: 33cd238effSMauro Carvalho Chehab 34cd238effSMauro Carvalho Chehab config MODVERSIONS 35cd238effSMauro Carvalho Chehab bool "Set version information on all module symbols" 36cd238effSMauro Carvalho Chehab depends on MODULES 37cd238effSMauro Carvalho Chehab help 38cd238effSMauro Carvalho Chehab Usually, modules have to be recompiled whenever you switch to a new 39cd238effSMauro Carvalho Chehab kernel. ... 40cd238effSMauro Carvalho Chehab 41cd238effSMauro Carvalho ChehabEvery line starts with a key word and can be followed by multiple 42cd238effSMauro Carvalho Chehabarguments. "config" starts a new config entry. The following lines 43cd238effSMauro Carvalho Chehabdefine attributes for this config option. Attributes can be the type of 44cd238effSMauro Carvalho Chehabthe config option, input prompt, dependencies, help text and default 45cd238effSMauro Carvalho Chehabvalues. A config option can be defined multiple times with the same 46cd238effSMauro Carvalho Chehabname, but every definition can have only a single input prompt and the 47cd238effSMauro Carvalho Chehabtype must not conflict. 48cd238effSMauro Carvalho Chehab 49cd238effSMauro Carvalho ChehabMenu attributes 50cd238effSMauro Carvalho Chehab--------------- 51cd238effSMauro Carvalho Chehab 52cd238effSMauro Carvalho ChehabA menu entry can have a number of attributes. Not all of them are 53cd238effSMauro Carvalho Chehabapplicable everywhere (see syntax). 54cd238effSMauro Carvalho Chehab 55cd238effSMauro Carvalho Chehab- type definition: "bool"/"tristate"/"string"/"hex"/"int" 5616886949SMauro Carvalho Chehab 57cd238effSMauro Carvalho Chehab Every config option must have a type. There are only two basic types: 58cd238effSMauro Carvalho Chehab tristate and string; the other types are based on these two. The type 59cd238effSMauro Carvalho Chehab definition optionally accepts an input prompt, so these two examples 60cd238effSMauro Carvalho Chehab are equivalent:: 61cd238effSMauro Carvalho Chehab 62cd238effSMauro Carvalho Chehab bool "Networking support" 63cd238effSMauro Carvalho Chehab 64cd238effSMauro Carvalho Chehab and:: 65cd238effSMauro Carvalho Chehab 66cd238effSMauro Carvalho Chehab bool 67cd238effSMauro Carvalho Chehab prompt "Networking support" 68cd238effSMauro Carvalho Chehab 69cd238effSMauro Carvalho Chehab- input prompt: "prompt" <prompt> ["if" <expr>] 7016886949SMauro Carvalho Chehab 71cd238effSMauro Carvalho Chehab Every menu entry can have at most one prompt, which is used to display 72cd238effSMauro Carvalho Chehab to the user. Optionally dependencies only for this prompt can be added 73*d97eae80SStephen Brennan with "if". If a prompt is not present, the config option is a non-visible 74*d97eae80SStephen Brennan symbol, meaning its value cannot be directly changed by the user (such as 75*d97eae80SStephen Brennan altering the value in ``.config``) and the option will not appear in any 76*d97eae80SStephen Brennan config menus. Its value can only be set via "default" and "select" (see 77*d97eae80SStephen Brennan below). 78cd238effSMauro Carvalho Chehab 79cd238effSMauro Carvalho Chehab- default value: "default" <expr> ["if" <expr>] 8016886949SMauro Carvalho Chehab 81cd238effSMauro Carvalho Chehab A config option can have any number of default values. If multiple 82cd238effSMauro Carvalho Chehab default values are visible, only the first defined one is active. 83cd238effSMauro Carvalho Chehab Default values are not limited to the menu entry where they are 84cd238effSMauro Carvalho Chehab defined. This means the default can be defined somewhere else or be 85cd238effSMauro Carvalho Chehab overridden by an earlier definition. 86cd238effSMauro Carvalho Chehab The default value is only assigned to the config symbol if no other 87cd238effSMauro Carvalho Chehab value was set by the user (via the input prompt above). If an input 88cd238effSMauro Carvalho Chehab prompt is visible the default value is presented to the user and can 89cd238effSMauro Carvalho Chehab be overridden by him. 90cd238effSMauro Carvalho Chehab Optionally, dependencies only for this default value can be added with 91cd238effSMauro Carvalho Chehab "if". 92cd238effSMauro Carvalho Chehab 93cd238effSMauro Carvalho Chehab The default value deliberately defaults to 'n' in order to avoid bloating the 94cd238effSMauro Carvalho Chehab build. With few exceptions, new config options should not change this. The 95cd238effSMauro Carvalho Chehab intent is for "make oldconfig" to add as little as possible to the config from 96cd238effSMauro Carvalho Chehab release to release. 97cd238effSMauro Carvalho Chehab 98cd238effSMauro Carvalho Chehab Note: 99cd238effSMauro Carvalho Chehab Things that merit "default y/m" include: 100cd238effSMauro Carvalho Chehab 101cd238effSMauro Carvalho Chehab a) A new Kconfig option for something that used to always be built 102cd238effSMauro Carvalho Chehab should be "default y". 103cd238effSMauro Carvalho Chehab 104cd238effSMauro Carvalho Chehab b) A new gatekeeping Kconfig option that hides/shows other Kconfig 105cd238effSMauro Carvalho Chehab options (but does not generate any code of its own), should be 106cd238effSMauro Carvalho Chehab "default y" so people will see those other options. 107cd238effSMauro Carvalho Chehab 108cd238effSMauro Carvalho Chehab c) Sub-driver behavior or similar options for a driver that is 109cd238effSMauro Carvalho Chehab "default n". This allows you to provide sane defaults. 110cd238effSMauro Carvalho Chehab 111cd238effSMauro Carvalho Chehab d) Hardware or infrastructure that everybody expects, such as CONFIG_NET 112cd238effSMauro Carvalho Chehab or CONFIG_BLOCK. These are rare exceptions. 113cd238effSMauro Carvalho Chehab 114cd238effSMauro Carvalho Chehab- type definition + default value:: 115cd238effSMauro Carvalho Chehab 116cd238effSMauro Carvalho Chehab "def_bool"/"def_tristate" <expr> ["if" <expr>] 117cd238effSMauro Carvalho Chehab 118cd238effSMauro Carvalho Chehab This is a shorthand notation for a type definition plus a value. 119cd238effSMauro Carvalho Chehab Optionally dependencies for this default value can be added with "if". 120cd238effSMauro Carvalho Chehab 121cd238effSMauro Carvalho Chehab- dependencies: "depends on" <expr> 12216886949SMauro Carvalho Chehab 123cd238effSMauro Carvalho Chehab This defines a dependency for this menu entry. If multiple 124cd238effSMauro Carvalho Chehab dependencies are defined, they are connected with '&&'. Dependencies 125cd238effSMauro Carvalho Chehab are applied to all other options within this menu entry (which also 126cd238effSMauro Carvalho Chehab accept an "if" expression), so these two examples are equivalent:: 127cd238effSMauro Carvalho Chehab 128cd238effSMauro Carvalho Chehab bool "foo" if BAR 129cd238effSMauro Carvalho Chehab default y if BAR 130cd238effSMauro Carvalho Chehab 131cd238effSMauro Carvalho Chehab and:: 132cd238effSMauro Carvalho Chehab 133cd238effSMauro Carvalho Chehab depends on BAR 134cd238effSMauro Carvalho Chehab bool "foo" 135cd238effSMauro Carvalho Chehab default y 136cd238effSMauro Carvalho Chehab 137cd238effSMauro Carvalho Chehab- reverse dependencies: "select" <symbol> ["if" <expr>] 13816886949SMauro Carvalho Chehab 139cd238effSMauro Carvalho Chehab While normal dependencies reduce the upper limit of a symbol (see 140cd238effSMauro Carvalho Chehab below), reverse dependencies can be used to force a lower limit of 141cd238effSMauro Carvalho Chehab another symbol. The value of the current menu symbol is used as the 142cd238effSMauro Carvalho Chehab minimal value <symbol> can be set to. If <symbol> is selected multiple 143cd238effSMauro Carvalho Chehab times, the limit is set to the largest selection. 144cd238effSMauro Carvalho Chehab Reverse dependencies can only be used with boolean or tristate 145cd238effSMauro Carvalho Chehab symbols. 146cd238effSMauro Carvalho Chehab 147cd238effSMauro Carvalho Chehab Note: 148cd238effSMauro Carvalho Chehab select should be used with care. select will force 149cd238effSMauro Carvalho Chehab a symbol to a value without visiting the dependencies. 150cd238effSMauro Carvalho Chehab By abusing select you are able to select a symbol FOO even 151cd238effSMauro Carvalho Chehab if FOO depends on BAR that is not set. 152cd238effSMauro Carvalho Chehab In general use select only for non-visible symbols 153cd238effSMauro Carvalho Chehab (no prompts anywhere) and for symbols with no dependencies. 154cd238effSMauro Carvalho Chehab That will limit the usefulness but on the other hand avoid 155cd238effSMauro Carvalho Chehab the illegal configurations all over. 156cd238effSMauro Carvalho Chehab 15745c7f555SMasahiro Yamada If "select" <symbol> is followed by "if" <expr>, <symbol> will be 15845c7f555SMasahiro Yamada selected by the logical AND of the value of the current menu symbol 15945c7f555SMasahiro Yamada and <expr>. This means, the lower limit can be downgraded due to the 16045c7f555SMasahiro Yamada presence of "if" <expr>. This behavior may seem weird, but we rely on 16145c7f555SMasahiro Yamada it. (The future of this behavior is undecided.) 16245c7f555SMasahiro Yamada 163cd238effSMauro Carvalho Chehab- weak reverse dependencies: "imply" <symbol> ["if" <expr>] 16416886949SMauro Carvalho Chehab 165cd238effSMauro Carvalho Chehab This is similar to "select" as it enforces a lower limit on another 166cd238effSMauro Carvalho Chehab symbol except that the "implied" symbol's value may still be set to n 167cd238effSMauro Carvalho Chehab from a direct dependency or with a visible prompt. 168cd238effSMauro Carvalho Chehab 169cd238effSMauro Carvalho Chehab Given the following example:: 170cd238effSMauro Carvalho Chehab 171cd238effSMauro Carvalho Chehab config FOO 1723a9dd3ecSMasahiro Yamada tristate "foo" 173cd238effSMauro Carvalho Chehab imply BAZ 174cd238effSMauro Carvalho Chehab 175cd238effSMauro Carvalho Chehab config BAZ 1763a9dd3ecSMasahiro Yamada tristate "baz" 177cd238effSMauro Carvalho Chehab depends on BAR 178cd238effSMauro Carvalho Chehab 179cd238effSMauro Carvalho Chehab The following values are possible: 180cd238effSMauro Carvalho Chehab 181cd238effSMauro Carvalho Chehab === === ============= ============== 182cd238effSMauro Carvalho Chehab FOO BAR BAZ's default choice for BAZ 183cd238effSMauro Carvalho Chehab === === ============= ============== 184cd238effSMauro Carvalho Chehab n y n N/m/y 185cd238effSMauro Carvalho Chehab m y m M/y/n 186def2fbffSMasahiro Yamada y y y Y/m/n 1873a9dd3ecSMasahiro Yamada n m n N/m 1883a9dd3ecSMasahiro Yamada m m m M/n 189c199d5d0SMiguel Ojeda y m m M/n 190cd238effSMauro Carvalho Chehab y n * N 191cd238effSMauro Carvalho Chehab === === ============= ============== 192cd238effSMauro Carvalho Chehab 193cd238effSMauro Carvalho Chehab This is useful e.g. with multiple drivers that want to indicate their 194cd238effSMauro Carvalho Chehab ability to hook into a secondary subsystem while allowing the user to 195cd238effSMauro Carvalho Chehab configure that subsystem out without also having to unset these drivers. 196cd238effSMauro Carvalho Chehab 197bf83266aSMasahiro Yamada Note: If the combination of FOO=y and BAZ=m causes a link error, 198def2fbffSMasahiro Yamada you can guard the function call with IS_REACHABLE():: 199def2fbffSMasahiro Yamada 200def2fbffSMasahiro Yamada foo_init() 201def2fbffSMasahiro Yamada { 202def2fbffSMasahiro Yamada if (IS_REACHABLE(CONFIG_BAZ)) 203def2fbffSMasahiro Yamada baz_register(&foo); 204def2fbffSMasahiro Yamada ... 205def2fbffSMasahiro Yamada } 206def2fbffSMasahiro Yamada 2073a9dd3ecSMasahiro Yamada Note: If the feature provided by BAZ is highly desirable for FOO, 2083a9dd3ecSMasahiro Yamada FOO should imply not only BAZ, but also its dependency BAR:: 2093a9dd3ecSMasahiro Yamada 2103a9dd3ecSMasahiro Yamada config FOO 2113a9dd3ecSMasahiro Yamada tristate "foo" 2123a9dd3ecSMasahiro Yamada imply BAR 2133a9dd3ecSMasahiro Yamada imply BAZ 2143a9dd3ecSMasahiro Yamada 21545c7f555SMasahiro Yamada Note: If "imply" <symbol> is followed by "if" <expr>, the default of <symbol> 21645c7f555SMasahiro Yamada will be the logical AND of the value of the current menu symbol and <expr>. 21745c7f555SMasahiro Yamada (The future of this behavior is undecided.) 21845c7f555SMasahiro Yamada 219cd238effSMauro Carvalho Chehab- limiting menu display: "visible if" <expr> 22016886949SMauro Carvalho Chehab 221cd238effSMauro Carvalho Chehab This attribute is only applicable to menu blocks, if the condition is 222cd238effSMauro Carvalho Chehab false, the menu block is not displayed to the user (the symbols 223cd238effSMauro Carvalho Chehab contained there can still be selected by other symbols, though). It is 224cd238effSMauro Carvalho Chehab similar to a conditional "prompt" attribute for individual menu 225cd238effSMauro Carvalho Chehab entries. Default value of "visible" is true. 226cd238effSMauro Carvalho Chehab 227cd238effSMauro Carvalho Chehab- numerical ranges: "range" <symbol> <symbol> ["if" <expr>] 22816886949SMauro Carvalho Chehab 229cd238effSMauro Carvalho Chehab This allows to limit the range of possible input values for int 230cd238effSMauro Carvalho Chehab and hex symbols. The user can only input a value which is larger than 231cd238effSMauro Carvalho Chehab or equal to the first symbol and smaller than or equal to the second 232cd238effSMauro Carvalho Chehab symbol. 233cd238effSMauro Carvalho Chehab 2348f268881SMasahiro Yamada- help text: "help" 23516886949SMauro Carvalho Chehab 236cd238effSMauro Carvalho Chehab This defines a help text. The end of the help text is determined by 237cd238effSMauro Carvalho Chehab the indentation level, this means it ends at the first line which has 238cd238effSMauro Carvalho Chehab a smaller indentation than the first line of the help text. 239cd238effSMauro Carvalho Chehab 2406dd85ff1SMasahiro Yamada- module attribute: "modules" 241cd238effSMauro Carvalho Chehab This declares the symbol to be used as the MODULES symbol, which 242cd238effSMauro Carvalho Chehab enables the third modular state for all config symbols. 243cd238effSMauro Carvalho Chehab At most one symbol may have the "modules" option set. 244cd238effSMauro Carvalho Chehab 245cd238effSMauro Carvalho ChehabMenu dependencies 246cd238effSMauro Carvalho Chehab----------------- 247cd238effSMauro Carvalho Chehab 248cd238effSMauro Carvalho ChehabDependencies define the visibility of a menu entry and can also reduce 249cd238effSMauro Carvalho Chehabthe input range of tristate symbols. The tristate logic used in the 250cd238effSMauro Carvalho Chehabexpressions uses one more state than normal boolean logic to express the 251cd238effSMauro Carvalho Chehabmodule state. Dependency expressions have the following syntax:: 252cd238effSMauro Carvalho Chehab 253cd238effSMauro Carvalho Chehab <expr> ::= <symbol> (1) 254cd238effSMauro Carvalho Chehab <symbol> '=' <symbol> (2) 255cd238effSMauro Carvalho Chehab <symbol> '!=' <symbol> (3) 256cd238effSMauro Carvalho Chehab <symbol1> '<' <symbol2> (4) 257cd238effSMauro Carvalho Chehab <symbol1> '>' <symbol2> (4) 258cd238effSMauro Carvalho Chehab <symbol1> '<=' <symbol2> (4) 259cd238effSMauro Carvalho Chehab <symbol1> '>=' <symbol2> (4) 260cd238effSMauro Carvalho Chehab '(' <expr> ')' (5) 261cd238effSMauro Carvalho Chehab '!' <expr> (6) 262cd238effSMauro Carvalho Chehab <expr> '&&' <expr> (7) 263cd238effSMauro Carvalho Chehab <expr> '||' <expr> (8) 264cd238effSMauro Carvalho Chehab 265cd238effSMauro Carvalho ChehabExpressions are listed in decreasing order of precedence. 266cd238effSMauro Carvalho Chehab 267cd238effSMauro Carvalho Chehab(1) Convert the symbol into an expression. Boolean and tristate symbols 268cd238effSMauro Carvalho Chehab are simply converted into the respective expression values. All 269cd238effSMauro Carvalho Chehab other symbol types result in 'n'. 270cd238effSMauro Carvalho Chehab(2) If the values of both symbols are equal, it returns 'y', 271cd238effSMauro Carvalho Chehab otherwise 'n'. 272cd238effSMauro Carvalho Chehab(3) If the values of both symbols are equal, it returns 'n', 273cd238effSMauro Carvalho Chehab otherwise 'y'. 274cd238effSMauro Carvalho Chehab(4) If value of <symbol1> is respectively lower, greater, lower-or-equal, 275cd238effSMauro Carvalho Chehab or greater-or-equal than value of <symbol2>, it returns 'y', 276cd238effSMauro Carvalho Chehab otherwise 'n'. 277cd238effSMauro Carvalho Chehab(5) Returns the value of the expression. Used to override precedence. 278cd238effSMauro Carvalho Chehab(6) Returns the result of (2-/expr/). 279cd238effSMauro Carvalho Chehab(7) Returns the result of min(/expr/, /expr/). 280cd238effSMauro Carvalho Chehab(8) Returns the result of max(/expr/, /expr/). 281cd238effSMauro Carvalho Chehab 282cd238effSMauro Carvalho ChehabAn expression can have a value of 'n', 'm' or 'y' (or 0, 1, 2 283cd238effSMauro Carvalho Chehabrespectively for calculations). A menu entry becomes visible when its 284cd238effSMauro Carvalho Chehabexpression evaluates to 'm' or 'y'. 285cd238effSMauro Carvalho Chehab 286cd238effSMauro Carvalho ChehabThere are two types of symbols: constant and non-constant symbols. 287cd238effSMauro Carvalho ChehabNon-constant symbols are the most common ones and are defined with the 288cd238effSMauro Carvalho Chehab'config' statement. Non-constant symbols consist entirely of alphanumeric 289cd238effSMauro Carvalho Chehabcharacters or underscores. 290cd238effSMauro Carvalho ChehabConstant symbols are only part of expressions. Constant symbols are 291cd238effSMauro Carvalho Chehabalways surrounded by single or double quotes. Within the quote, any 292cd238effSMauro Carvalho Chehabother character is allowed and the quotes can be escaped using '\'. 293cd238effSMauro Carvalho Chehab 294cd238effSMauro Carvalho ChehabMenu structure 295cd238effSMauro Carvalho Chehab-------------- 296cd238effSMauro Carvalho Chehab 297cd238effSMauro Carvalho ChehabThe position of a menu entry in the tree is determined in two ways. First 298cd238effSMauro Carvalho Chehabit can be specified explicitly:: 299cd238effSMauro Carvalho Chehab 300cd238effSMauro Carvalho Chehab menu "Network device support" 301cd238effSMauro Carvalho Chehab depends on NET 302cd238effSMauro Carvalho Chehab 303cd238effSMauro Carvalho Chehab config NETDEVICES 304cd238effSMauro Carvalho Chehab ... 305cd238effSMauro Carvalho Chehab 306cd238effSMauro Carvalho Chehab endmenu 307cd238effSMauro Carvalho Chehab 308cd238effSMauro Carvalho ChehabAll entries within the "menu" ... "endmenu" block become a submenu of 309cd238effSMauro Carvalho Chehab"Network device support". All subentries inherit the dependencies from 310cd238effSMauro Carvalho Chehabthe menu entry, e.g. this means the dependency "NET" is added to the 311cd238effSMauro Carvalho Chehabdependency list of the config option NETDEVICES. 312cd238effSMauro Carvalho Chehab 313cd238effSMauro Carvalho ChehabThe other way to generate the menu structure is done by analyzing the 314cd238effSMauro Carvalho Chehabdependencies. If a menu entry somehow depends on the previous entry, it 315cd238effSMauro Carvalho Chehabcan be made a submenu of it. First, the previous (parent) symbol must 316cd238effSMauro Carvalho Chehabbe part of the dependency list and then one of these two conditions 317cd238effSMauro Carvalho Chehabmust be true: 318cd238effSMauro Carvalho Chehab 319cd238effSMauro Carvalho Chehab- the child entry must become invisible, if the parent is set to 'n' 320cd238effSMauro Carvalho Chehab- the child entry must only be visible, if the parent is visible:: 321cd238effSMauro Carvalho Chehab 322cd238effSMauro Carvalho Chehab config MODULES 323cd238effSMauro Carvalho Chehab bool "Enable loadable module support" 324cd238effSMauro Carvalho Chehab 325cd238effSMauro Carvalho Chehab config MODVERSIONS 326cd238effSMauro Carvalho Chehab bool "Set version information on all module symbols" 327cd238effSMauro Carvalho Chehab depends on MODULES 328cd238effSMauro Carvalho Chehab 329cd238effSMauro Carvalho Chehab comment "module support disabled" 330cd238effSMauro Carvalho Chehab depends on !MODULES 331cd238effSMauro Carvalho Chehab 332cd238effSMauro Carvalho ChehabMODVERSIONS directly depends on MODULES, this means it's only visible if 333cd238effSMauro Carvalho ChehabMODULES is different from 'n'. The comment on the other hand is only 334cd238effSMauro Carvalho Chehabvisible when MODULES is set to 'n'. 335cd238effSMauro Carvalho Chehab 336cd238effSMauro Carvalho Chehab 337cd238effSMauro Carvalho ChehabKconfig syntax 338cd238effSMauro Carvalho Chehab-------------- 339cd238effSMauro Carvalho Chehab 340cd238effSMauro Carvalho ChehabThe configuration file describes a series of menu entries, where every 341cd238effSMauro Carvalho Chehabline starts with a keyword (except help texts). The following keywords 342cd238effSMauro Carvalho Chehabend a menu entry: 343cd238effSMauro Carvalho Chehab 344cd238effSMauro Carvalho Chehab- config 345cd238effSMauro Carvalho Chehab- menuconfig 346cd238effSMauro Carvalho Chehab- choice/endchoice 347cd238effSMauro Carvalho Chehab- comment 348cd238effSMauro Carvalho Chehab- menu/endmenu 349cd238effSMauro Carvalho Chehab- if/endif 350cd238effSMauro Carvalho Chehab- source 351cd238effSMauro Carvalho Chehab 352cd238effSMauro Carvalho ChehabThe first five also start the definition of a menu entry. 353cd238effSMauro Carvalho Chehab 354cd238effSMauro Carvalho Chehabconfig:: 35516886949SMauro Carvalho Chehab 356cd238effSMauro Carvalho Chehab "config" <symbol> 357cd238effSMauro Carvalho Chehab <config options> 358cd238effSMauro Carvalho Chehab 359cd238effSMauro Carvalho ChehabThis defines a config symbol <symbol> and accepts any of above 360cd238effSMauro Carvalho Chehabattributes as options. 361cd238effSMauro Carvalho Chehab 362cd238effSMauro Carvalho Chehabmenuconfig:: 36316886949SMauro Carvalho Chehab 364cd238effSMauro Carvalho Chehab "menuconfig" <symbol> 365cd238effSMauro Carvalho Chehab <config options> 366cd238effSMauro Carvalho Chehab 367cd238effSMauro Carvalho ChehabThis is similar to the simple config entry above, but it also gives a 368cd238effSMauro Carvalho Chehabhint to front ends, that all suboptions should be displayed as a 369cd238effSMauro Carvalho Chehabseparate list of options. To make sure all the suboptions will really 370cd238effSMauro Carvalho Chehabshow up under the menuconfig entry and not outside of it, every item 371cd238effSMauro Carvalho Chehabfrom the <config options> list must depend on the menuconfig symbol. 372cd238effSMauro Carvalho ChehabIn practice, this is achieved by using one of the next two constructs:: 373cd238effSMauro Carvalho Chehab 374cd238effSMauro Carvalho Chehab (1): 375cd238effSMauro Carvalho Chehab menuconfig M 376cd238effSMauro Carvalho Chehab if M 377cd238effSMauro Carvalho Chehab config C1 378cd238effSMauro Carvalho Chehab config C2 379cd238effSMauro Carvalho Chehab endif 380cd238effSMauro Carvalho Chehab 381cd238effSMauro Carvalho Chehab (2): 382cd238effSMauro Carvalho Chehab menuconfig M 383cd238effSMauro Carvalho Chehab config C1 384cd238effSMauro Carvalho Chehab depends on M 385cd238effSMauro Carvalho Chehab config C2 386cd238effSMauro Carvalho Chehab depends on M 387cd238effSMauro Carvalho Chehab 388cd238effSMauro Carvalho ChehabIn the following examples (3) and (4), C1 and C2 still have the M 389cd238effSMauro Carvalho Chehabdependency, but will not appear under menuconfig M anymore, because 390cd238effSMauro Carvalho Chehabof C0, which doesn't depend on M:: 391cd238effSMauro Carvalho Chehab 392cd238effSMauro Carvalho Chehab (3): 393cd238effSMauro Carvalho Chehab menuconfig M 394cd238effSMauro Carvalho Chehab config C0 395cd238effSMauro Carvalho Chehab if M 396cd238effSMauro Carvalho Chehab config C1 397cd238effSMauro Carvalho Chehab config C2 398cd238effSMauro Carvalho Chehab endif 399cd238effSMauro Carvalho Chehab 400cd238effSMauro Carvalho Chehab (4): 401cd238effSMauro Carvalho Chehab menuconfig M 402cd238effSMauro Carvalho Chehab config C0 403cd238effSMauro Carvalho Chehab config C1 404cd238effSMauro Carvalho Chehab depends on M 405cd238effSMauro Carvalho Chehab config C2 406cd238effSMauro Carvalho Chehab depends on M 407cd238effSMauro Carvalho Chehab 408cd238effSMauro Carvalho Chehabchoices:: 409cd238effSMauro Carvalho Chehab 410c83f0209SMasahiro Yamada "choice" 411cd238effSMauro Carvalho Chehab <choice options> 412cd238effSMauro Carvalho Chehab <choice block> 413cd238effSMauro Carvalho Chehab "endchoice" 414cd238effSMauro Carvalho Chehab 415cd238effSMauro Carvalho ChehabThis defines a choice group and accepts any of the above attributes as 416fde19251SMasahiro Yamadaoptions. 417cd238effSMauro Carvalho Chehab 418fde19251SMasahiro YamadaA choice only allows a single config entry to be selected. 419cd238effSMauro Carvalho Chehab 420cd238effSMauro Carvalho Chehabcomment:: 421cd238effSMauro Carvalho Chehab 422cd238effSMauro Carvalho Chehab "comment" <prompt> 423cd238effSMauro Carvalho Chehab <comment options> 424cd238effSMauro Carvalho Chehab 425cd238effSMauro Carvalho ChehabThis defines a comment which is displayed to the user during the 426cd238effSMauro Carvalho Chehabconfiguration process and is also echoed to the output files. The only 427cd238effSMauro Carvalho Chehabpossible options are dependencies. 428cd238effSMauro Carvalho Chehab 429cd238effSMauro Carvalho Chehabmenu:: 430cd238effSMauro Carvalho Chehab 431cd238effSMauro Carvalho Chehab "menu" <prompt> 432cd238effSMauro Carvalho Chehab <menu options> 433cd238effSMauro Carvalho Chehab <menu block> 434cd238effSMauro Carvalho Chehab "endmenu" 435cd238effSMauro Carvalho Chehab 436cd238effSMauro Carvalho ChehabThis defines a menu block, see "Menu structure" above for more 437cd238effSMauro Carvalho Chehabinformation. The only possible options are dependencies and "visible" 438cd238effSMauro Carvalho Chehabattributes. 439cd238effSMauro Carvalho Chehab 440cd238effSMauro Carvalho Chehabif:: 441cd238effSMauro Carvalho Chehab 442cd238effSMauro Carvalho Chehab "if" <expr> 443cd238effSMauro Carvalho Chehab <if block> 444cd238effSMauro Carvalho Chehab "endif" 445cd238effSMauro Carvalho Chehab 446cd238effSMauro Carvalho ChehabThis defines an if block. The dependency expression <expr> is appended 447cd238effSMauro Carvalho Chehabto all enclosed menu entries. 448cd238effSMauro Carvalho Chehab 449cd238effSMauro Carvalho Chehabsource:: 450cd238effSMauro Carvalho Chehab 451cd238effSMauro Carvalho Chehab "source" <prompt> 452cd238effSMauro Carvalho Chehab 453cd238effSMauro Carvalho ChehabThis reads the specified configuration file. This file is always parsed. 454cd238effSMauro Carvalho Chehab 455cd238effSMauro Carvalho Chehabmainmenu:: 456cd238effSMauro Carvalho Chehab 457cd238effSMauro Carvalho Chehab "mainmenu" <prompt> 458cd238effSMauro Carvalho Chehab 459cd238effSMauro Carvalho ChehabThis sets the config program's title bar if the config program chooses 460cd238effSMauro Carvalho Chehabto use it. It should be placed at the top of the configuration, before any 461cd238effSMauro Carvalho Chehabother statement. 462cd238effSMauro Carvalho Chehab 463cd238effSMauro Carvalho Chehab'#' Kconfig source file comment: 464cd238effSMauro Carvalho Chehab 465cd238effSMauro Carvalho ChehabAn unquoted '#' character anywhere in a source file line indicates 466cd238effSMauro Carvalho Chehabthe beginning of a source file comment. The remainder of that line 467cd238effSMauro Carvalho Chehabis a comment. 468cd238effSMauro Carvalho Chehab 469cd238effSMauro Carvalho Chehab 470cd238effSMauro Carvalho ChehabKconfig hints 471cd238effSMauro Carvalho Chehab------------- 472cd238effSMauro Carvalho ChehabThis is a collection of Kconfig tips, most of which aren't obvious at 473cd238effSMauro Carvalho Chehabfirst glance and most of which have become idioms in several Kconfig 474cd238effSMauro Carvalho Chehabfiles. 475cd238effSMauro Carvalho Chehab 476cd238effSMauro Carvalho ChehabAdding common features and make the usage configurable 477cd238effSMauro Carvalho Chehab~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 478cd238effSMauro Carvalho ChehabIt is a common idiom to implement a feature/functionality that are 479cd238effSMauro Carvalho Chehabrelevant for some architectures but not all. 480cd238effSMauro Carvalho ChehabThe recommended way to do so is to use a config variable named HAVE_* 481cd238effSMauro Carvalho Chehabthat is defined in a common Kconfig file and selected by the relevant 482cd238effSMauro Carvalho Chehabarchitectures. 483cd238effSMauro Carvalho ChehabAn example is the generic IOMAP functionality. 484cd238effSMauro Carvalho Chehab 485cd238effSMauro Carvalho ChehabWe would in lib/Kconfig see:: 486cd238effSMauro Carvalho Chehab 487cd238effSMauro Carvalho Chehab # Generic IOMAP is used to ... 488cd238effSMauro Carvalho Chehab config HAVE_GENERIC_IOMAP 489cd238effSMauro Carvalho Chehab 490cd238effSMauro Carvalho Chehab config GENERIC_IOMAP 491cd238effSMauro Carvalho Chehab depends on HAVE_GENERIC_IOMAP && FOO 492cd238effSMauro Carvalho Chehab 493cd238effSMauro Carvalho ChehabAnd in lib/Makefile we would see:: 494cd238effSMauro Carvalho Chehab 495cd238effSMauro Carvalho Chehab obj-$(CONFIG_GENERIC_IOMAP) += iomap.o 496cd238effSMauro Carvalho Chehab 497cd238effSMauro Carvalho ChehabFor each architecture using the generic IOMAP functionality we would see:: 498cd238effSMauro Carvalho Chehab 499cd238effSMauro Carvalho Chehab config X86 500cd238effSMauro Carvalho Chehab select ... 501cd238effSMauro Carvalho Chehab select HAVE_GENERIC_IOMAP 502cd238effSMauro Carvalho Chehab select ... 503cd238effSMauro Carvalho Chehab 504cd238effSMauro Carvalho ChehabNote: we use the existing config option and avoid creating a new 505cd238effSMauro Carvalho Chehabconfig variable to select HAVE_GENERIC_IOMAP. 506cd238effSMauro Carvalho Chehab 507cd238effSMauro Carvalho ChehabNote: the use of the internal config variable HAVE_GENERIC_IOMAP, it is 508cd238effSMauro Carvalho Chehabintroduced to overcome the limitation of select which will force a 509cd238effSMauro Carvalho Chehabconfig option to 'y' no matter the dependencies. 510cd238effSMauro Carvalho ChehabThe dependencies are moved to the symbol GENERIC_IOMAP and we avoid the 511cd238effSMauro Carvalho Chehabsituation where select forces a symbol equals to 'y'. 512cd238effSMauro Carvalho Chehab 513cd238effSMauro Carvalho ChehabAdding features that need compiler support 514cd238effSMauro Carvalho Chehab~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 515cd238effSMauro Carvalho Chehab 516cd238effSMauro Carvalho ChehabThere are several features that need compiler support. The recommended way 517cd238effSMauro Carvalho Chehabto describe the dependency on the compiler feature is to use "depends on" 518cd238effSMauro Carvalho Chehabfollowed by a test macro:: 519cd238effSMauro Carvalho Chehab 520cd238effSMauro Carvalho Chehab config STACKPROTECTOR 521cd238effSMauro Carvalho Chehab bool "Stack Protector buffer overflow detection" 522cd238effSMauro Carvalho Chehab depends on $(cc-option,-fstack-protector) 523cd238effSMauro Carvalho Chehab ... 524cd238effSMauro Carvalho Chehab 525cd238effSMauro Carvalho ChehabIf you need to expose a compiler capability to makefiles and/or C source files, 526cd238effSMauro Carvalho Chehab`CC_HAS_` is the recommended prefix for the config option:: 527cd238effSMauro Carvalho Chehab 528a0a12c3eSNick Desaulniers config CC_HAS_FOO 529a0a12c3eSNick Desaulniers def_bool $(success,$(srctree)/scripts/cc-check-foo.sh $(CC)) 530cd238effSMauro Carvalho Chehab 531cd238effSMauro Carvalho ChehabBuild as module only 532cd238effSMauro Carvalho Chehab~~~~~~~~~~~~~~~~~~~~ 533cd238effSMauro Carvalho ChehabTo restrict a component build to module-only, qualify its config symbol 534cd238effSMauro Carvalho Chehabwith "depends on m". E.g.:: 535cd238effSMauro Carvalho Chehab 536cd238effSMauro Carvalho Chehab config FOO 537cd238effSMauro Carvalho Chehab depends on BAR && m 538cd238effSMauro Carvalho Chehab 539cd238effSMauro Carvalho Chehablimits FOO to module (=m) or disabled (=n). 540cd238effSMauro Carvalho Chehab 541c613583bSGeert UytterhoevenCompile-testing 542c613583bSGeert Uytterhoeven~~~~~~~~~~~~~~~ 543c613583bSGeert UytterhoevenIf a config symbol has a dependency, but the code controlled by the config 544c613583bSGeert Uytterhoevensymbol can still be compiled if the dependency is not met, it is encouraged to 545c613583bSGeert Uytterhoevenincrease build coverage by adding an "|| COMPILE_TEST" clause to the 546c613583bSGeert Uytterhoevendependency. This is especially useful for drivers for more exotic hardware, as 547c613583bSGeert Uytterhoevenit allows continuous-integration systems to compile-test the code on a more 548c613583bSGeert Uytterhoevencommon system, and detect bugs that way. 549c613583bSGeert UytterhoevenNote that compile-tested code should avoid crashing when run on a system where 550c613583bSGeert Uytterhoeventhe dependency is not met. 551c613583bSGeert Uytterhoeven 55218084e43SGeert UytterhoevenArchitecture and platform dependencies 55318084e43SGeert Uytterhoeven~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 55418084e43SGeert UytterhoevenDue to the presence of stubs, most drivers can now be compiled on most 55518084e43SGeert Uytterhoevenarchitectures. However, this does not mean it makes sense to have all drivers 55618084e43SGeert Uytterhoevenavailable everywhere, as the actual hardware may only exist on specific 55718084e43SGeert Uytterhoevenarchitectures and platforms. This is especially true for on-SoC IP cores, 55818084e43SGeert Uytterhoevenwhich may be limited to a specific vendor or SoC family. 55918084e43SGeert Uytterhoeven 56018084e43SGeert UytterhoevenTo prevent asking the user about drivers that cannot be used on the system(s) 56118084e43SGeert Uytterhoeventhe user is compiling a kernel for, and if it makes sense, config symbols 56218084e43SGeert Uytterhoevencontrolling the compilation of a driver should contain proper dependencies, 56318084e43SGeert Uytterhoevenlimiting the visibility of the symbol to (a superset of) the platform(s) the 56418084e43SGeert Uytterhoevendriver can be used on. The dependency can be an architecture (e.g. ARM) or 56518084e43SGeert Uytterhoevenplatform (e.g. ARCH_OMAP4) dependency. This makes life simpler not only for 56618084e43SGeert Uytterhoevendistro config owners, but also for every single developer or user who 56718084e43SGeert Uytterhoevenconfigures a kernel. 56818084e43SGeert Uytterhoeven 56918084e43SGeert UytterhoevenSuch a dependency can be relaxed by combining it with the compile-testing rule 57018084e43SGeert Uytterhoevenabove, leading to: 57118084e43SGeert Uytterhoeven 57218084e43SGeert Uytterhoeven config FOO 57318084e43SGeert Uytterhoeven bool "Support for foo hardware" 57418084e43SGeert Uytterhoeven depends on ARCH_FOO_VENDOR || COMPILE_TEST 57518084e43SGeert Uytterhoeven 57628d49e17SArnd BergmannOptional dependencies 57728d49e17SArnd Bergmann~~~~~~~~~~~~~~~~~~~~~ 57828d49e17SArnd Bergmann 57928d49e17SArnd BergmannSome drivers are able to optionally use a feature from another module 58028d49e17SArnd Bergmannor build cleanly with that module disabled, but cause a link failure 58128d49e17SArnd Bergmannwhen trying to use that loadable module from a built-in driver. 58228d49e17SArnd Bergmann 58328d49e17SArnd BergmannThe most common way to express this optional dependency in Kconfig logic 58428d49e17SArnd Bergmannuses the slightly counterintuitive:: 58528d49e17SArnd Bergmann 58628d49e17SArnd Bergmann config FOO 58728d49e17SArnd Bergmann tristate "Support for foo hardware" 58828d49e17SArnd Bergmann depends on BAR || !BAR 58928d49e17SArnd Bergmann 59028d49e17SArnd BergmannThis means that there is either a dependency on BAR that disallows 59128d49e17SArnd Bergmannthe combination of FOO=y with BAR=m, or BAR is completely disabled. 59228d49e17SArnd BergmannFor a more formalized approach if there are multiple drivers that have 59328d49e17SArnd Bergmannthe same dependency, a helper symbol can be used, like:: 59428d49e17SArnd Bergmann 59528d49e17SArnd Bergmann config FOO 59628d49e17SArnd Bergmann tristate "Support for foo hardware" 59728d49e17SArnd Bergmann depends on BAR_OPTIONAL 59828d49e17SArnd Bergmann 59928d49e17SArnd Bergmann config BAR_OPTIONAL 60028d49e17SArnd Bergmann def_tristate BAR || !BAR 60128d49e17SArnd Bergmann 602cd238effSMauro Carvalho ChehabKconfig recursive dependency limitations 603cd238effSMauro Carvalho Chehab~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 604cd238effSMauro Carvalho Chehab 605cd238effSMauro Carvalho ChehabIf you've hit the Kconfig error: "recursive dependency detected" you've run 606cd238effSMauro Carvalho Chehabinto a recursive dependency issue with Kconfig, a recursive dependency can be 607cd238effSMauro Carvalho Chehabsummarized as a circular dependency. The kconfig tools need to ensure that 608cd238effSMauro Carvalho ChehabKconfig files comply with specified configuration requirements. In order to do 609cd238effSMauro Carvalho Chehabthat kconfig must determine the values that are possible for all Kconfig 610cd238effSMauro Carvalho Chehabsymbols, this is currently not possible if there is a circular relation 611cd238effSMauro Carvalho Chehabbetween two or more Kconfig symbols. For more details refer to the "Simple 612cd238effSMauro Carvalho ChehabKconfig recursive issue" subsection below. Kconfig does not do recursive 613cd238effSMauro Carvalho Chehabdependency resolution; this has a few implications for Kconfig file writers. 614cd238effSMauro Carvalho ChehabWe'll first explain why this issues exists and then provide an example 615cd238effSMauro Carvalho Chehabtechnical limitation which this brings upon Kconfig developers. Eager 616cd238effSMauro Carvalho Chehabdevelopers wishing to try to address this limitation should read the next 617cd238effSMauro Carvalho Chehabsubsections. 618cd238effSMauro Carvalho Chehab 619cd238effSMauro Carvalho ChehabSimple Kconfig recursive issue 620cd238effSMauro Carvalho Chehab~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 621cd238effSMauro Carvalho Chehab 622cd238effSMauro Carvalho ChehabRead: Documentation/kbuild/Kconfig.recursion-issue-01 623cd238effSMauro Carvalho Chehab 624cd238effSMauro Carvalho ChehabTest with:: 625cd238effSMauro Carvalho Chehab 626cd238effSMauro Carvalho Chehab make KBUILD_KCONFIG=Documentation/kbuild/Kconfig.recursion-issue-01 allnoconfig 627cd238effSMauro Carvalho Chehab 628cd238effSMauro Carvalho ChehabCumulative Kconfig recursive issue 629cd238effSMauro Carvalho Chehab~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 630cd238effSMauro Carvalho Chehab 631cd238effSMauro Carvalho ChehabRead: Documentation/kbuild/Kconfig.recursion-issue-02 632cd238effSMauro Carvalho Chehab 633cd238effSMauro Carvalho ChehabTest with:: 634cd238effSMauro Carvalho Chehab 635cd238effSMauro Carvalho Chehab make KBUILD_KCONFIG=Documentation/kbuild/Kconfig.recursion-issue-02 allnoconfig 636cd238effSMauro Carvalho Chehab 637cd238effSMauro Carvalho ChehabPractical solutions to kconfig recursive issue 638cd238effSMauro Carvalho Chehab~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 639cd238effSMauro Carvalho Chehab 640cd238effSMauro Carvalho ChehabDevelopers who run into the recursive Kconfig issue have two options 641cd238effSMauro Carvalho Chehabat their disposal. We document them below and also provide a list of 642cd238effSMauro Carvalho Chehabhistorical issues resolved through these different solutions. 643cd238effSMauro Carvalho Chehab 644cd238effSMauro Carvalho Chehab a) Remove any superfluous "select FOO" or "depends on FOO" 645cd238effSMauro Carvalho Chehab b) Match dependency semantics: 646cd238effSMauro Carvalho Chehab 647cd238effSMauro Carvalho Chehab b1) Swap all "select FOO" to "depends on FOO" or, 648cd238effSMauro Carvalho Chehab 649cd238effSMauro Carvalho Chehab b2) Swap all "depends on FOO" to "select FOO" 650cd238effSMauro Carvalho Chehab 651cd238effSMauro Carvalho ChehabThe resolution to a) can be tested with the sample Kconfig file 652cd238effSMauro Carvalho ChehabDocumentation/kbuild/Kconfig.recursion-issue-01 through the removal 653cd238effSMauro Carvalho Chehabof the "select CORE" from CORE_BELL_A_ADVANCED as that is implicit already 654cd238effSMauro Carvalho Chehabsince CORE_BELL_A depends on CORE. At times it may not be possible to remove 655cd238effSMauro Carvalho Chehabsome dependency criteria, for such cases you can work with solution b). 656cd238effSMauro Carvalho Chehab 657cd238effSMauro Carvalho ChehabThe two different resolutions for b) can be tested in the sample Kconfig file 658cd238effSMauro Carvalho ChehabDocumentation/kbuild/Kconfig.recursion-issue-02. 659cd238effSMauro Carvalho Chehab 660cd238effSMauro Carvalho ChehabBelow is a list of examples of prior fixes for these types of recursive issues; 6612b5072b9SBjorn Helgaasall errors appear to involve one or more "select" statements and one or more 6622b5072b9SBjorn Helgaas"depends on". 663cd238effSMauro Carvalho Chehab 664cd238effSMauro Carvalho Chehab============ =================================== 665cd238effSMauro Carvalho Chehabcommit fix 666cd238effSMauro Carvalho Chehab============ =================================== 667cd238effSMauro Carvalho Chehab06b718c01208 select A -> depends on A 668cd238effSMauro Carvalho Chehabc22eacfe82f9 depends on A -> depends on B 669cd238effSMauro Carvalho Chehab6a91e854442c select A -> depends on A 670cd238effSMauro Carvalho Chehab118c565a8f2e select A -> select B 671cd238effSMauro Carvalho Chehabf004e5594705 select A -> depends on A 672cd238effSMauro Carvalho Chehabc7861f37b4c6 depends on A -> (null) 673cd238effSMauro Carvalho Chehab80c69915e5fb select A -> (null) (1) 674cd238effSMauro Carvalho Chehabc2218e26c0d0 select A -> depends on A (1) 675cd238effSMauro Carvalho Chehabd6ae99d04e1c select A -> depends on A 676cd238effSMauro Carvalho Chehab95ca19cf8cbf select A -> depends on A 677cd238effSMauro Carvalho Chehab8f057d7bca54 depends on A -> (null) 678cd238effSMauro Carvalho Chehab8f057d7bca54 depends on A -> select A 679cd238effSMauro Carvalho Chehaba0701f04846e select A -> depends on A 680cd238effSMauro Carvalho Chehab0c8b92f7f259 depends on A -> (null) 681cd238effSMauro Carvalho Chehabe4e9e0540928 select A -> depends on A (2) 682cd238effSMauro Carvalho Chehab7453ea886e87 depends on A > (null) (1) 683cd238effSMauro Carvalho Chehab7b1fff7e4fdf select A -> depends on A 684cd238effSMauro Carvalho Chehab86c747d2a4f0 select A -> depends on A 685cd238effSMauro Carvalho Chehabd9f9ab51e55e select A -> depends on A 686cd238effSMauro Carvalho Chehab0c51a4d8abd6 depends on A -> select A (3) 687cd238effSMauro Carvalho Chehabe98062ed6dc4 select A -> depends on A (3) 688cd238effSMauro Carvalho Chehab91e5d284a7f1 select A -> (null) 689cd238effSMauro Carvalho Chehab============ =================================== 690cd238effSMauro Carvalho Chehab 691cd238effSMauro Carvalho Chehab(1) Partial (or no) quote of error. 692cd238effSMauro Carvalho Chehab(2) That seems to be the gist of that fix. 693cd238effSMauro Carvalho Chehab(3) Same error. 694cd238effSMauro Carvalho Chehab 695cd238effSMauro Carvalho ChehabFuture kconfig work 696cd238effSMauro Carvalho Chehab~~~~~~~~~~~~~~~~~~~ 697cd238effSMauro Carvalho Chehab 698cd238effSMauro Carvalho ChehabWork on kconfig is welcomed on both areas of clarifying semantics and on 699cd238effSMauro Carvalho Chehabevaluating the use of a full SAT solver for it. A full SAT solver can be 700cd238effSMauro Carvalho Chehabdesirable to enable more complex dependency mappings and / or queries, 70159316eacSBaruch Siachfor instance one possible use case for a SAT solver could be that of handling 702cd238effSMauro Carvalho Chehabthe current known recursive dependency issues. It is not known if this would 703cd238effSMauro Carvalho Chehabaddress such issues but such evaluation is desirable. If support for a full SAT 704cd238effSMauro Carvalho Chehabsolver proves too complex or that it cannot address recursive dependency issues 705cd238effSMauro Carvalho ChehabKconfig should have at least clear and well defined semantics which also 706cd238effSMauro Carvalho Chehabaddresses and documents limitations or requirements such as the ones dealing 707cd238effSMauro Carvalho Chehabwith recursive dependencies. 708cd238effSMauro Carvalho Chehab 709cd238effSMauro Carvalho ChehabFurther work on both of these areas is welcomed on Kconfig. We elaborate 710cd238effSMauro Carvalho Chehabon both of these in the next two subsections. 711cd238effSMauro Carvalho Chehab 712cd238effSMauro Carvalho ChehabSemantics of Kconfig 713cd238effSMauro Carvalho Chehab~~~~~~~~~~~~~~~~~~~~ 714cd238effSMauro Carvalho Chehab 715cd238effSMauro Carvalho ChehabThe use of Kconfig is broad, Linux is now only one of Kconfig's users: 716cd238effSMauro Carvalho Chehabone study has completed a broad analysis of Kconfig use in 12 projects [0]_. 717cd238effSMauro Carvalho ChehabDespite its widespread use, and although this document does a reasonable job 718cd238effSMauro Carvalho Chehabin documenting basic Kconfig syntax a more precise definition of Kconfig 719cd238effSMauro Carvalho Chehabsemantics is welcomed. One project deduced Kconfig semantics through 720cd238effSMauro Carvalho Chehabthe use of the xconfig configurator [1]_. Work should be done to confirm if 721cd238effSMauro Carvalho Chehabthe deduced semantics matches our intended Kconfig design goals. 722cab802b7SNecip Fazil YildiranAnother project formalized a denotational semantics of a core subset of 723cab802b7SNecip Fazil Yildiranthe Kconfig language [10]_. 724cd238effSMauro Carvalho Chehab 725cd238effSMauro Carvalho ChehabHaving well defined semantics can be useful for tools for practical 7262b5072b9SBjorn Helgaasevaluation of dependencies, for instance one such case was work to 727cd238effSMauro Carvalho Chehabexpress in boolean abstraction of the inferred semantics of Kconfig to 728cd238effSMauro Carvalho Chehabtranslate Kconfig logic into boolean formulas and run a SAT solver on this to 729cd238effSMauro Carvalho Chehabfind dead code / features (always inactive), 114 dead features were found in 730cd238effSMauro Carvalho ChehabLinux using this methodology [1]_ (Section 8: Threats to validity). 731cab802b7SNecip Fazil YildiranThe kismet tool, based on the semantics in [10]_, finds abuses of reverse 732cab802b7SNecip Fazil Yildirandependencies and has led to dozens of committed fixes to Linux Kconfig files [11]_. 733cd238effSMauro Carvalho Chehab 73414bee167SRandy DunlapConfirming this could prove useful as Kconfig stands as one of the leading 735cd238effSMauro Carvalho Chehabindustrial variability modeling languages [1]_ [2]_. Its study would help 736cd238effSMauro Carvalho Chehabevaluate practical uses of such languages, their use was only theoretical 737cd238effSMauro Carvalho Chehaband real world requirements were not well understood. As it stands though 738cd238effSMauro Carvalho Chehabonly reverse engineering techniques have been used to deduce semantics from 739cd238effSMauro Carvalho Chehabvariability modeling languages such as Kconfig [3]_. 740cd238effSMauro Carvalho Chehab 74116a122c7SAlexander A. Klimov.. [0] https://www.eng.uwaterloo.ca/~shshe/kconfig_semantics.pdf 74216a122c7SAlexander A. Klimov.. [1] https://gsd.uwaterloo.ca/sites/default/files/vm-2013-berger.pdf 74316a122c7SAlexander A. Klimov.. [2] https://gsd.uwaterloo.ca/sites/default/files/ase241-berger_0.pdf 74416a122c7SAlexander A. Klimov.. [3] https://gsd.uwaterloo.ca/sites/default/files/icse2011.pdf 745cd238effSMauro Carvalho Chehab 746cd238effSMauro Carvalho ChehabFull SAT solver for Kconfig 747cd238effSMauro Carvalho Chehab~~~~~~~~~~~~~~~~~~~~~~~~~~~ 748cd238effSMauro Carvalho Chehab 749cd238effSMauro Carvalho ChehabAlthough SAT solvers [4]_ haven't yet been used by Kconfig directly, as noted 750cd238effSMauro Carvalho Chehabin the previous subsection, work has been done however to express in boolean 751cd238effSMauro Carvalho Chehababstraction the inferred semantics of Kconfig to translate Kconfig logic into 752cd238effSMauro Carvalho Chehabboolean formulas and run a SAT solver on it [5]_. Another known related project 753cd238effSMauro Carvalho Chehabis CADOS [6]_ (former VAMOS [7]_) and the tools, mainly undertaker [8]_, which 754cd238effSMauro Carvalho Chehabhas been introduced first with [9]_. The basic concept of undertaker is to 7552b5072b9SBjorn Helgaasextract variability models from Kconfig and put them together with a 756cd238effSMauro Carvalho Chehabpropositional formula extracted from CPP #ifdefs and build-rules into a SAT 757cd238effSMauro Carvalho Chehabsolver in order to find dead code, dead files, and dead symbols. If using a SAT 758cd238effSMauro Carvalho Chehabsolver is desirable on Kconfig one approach would be to evaluate repurposing 759cd238effSMauro Carvalho Chehabsuch efforts somehow on Kconfig. There is enough interest from mentors of 760cd238effSMauro Carvalho Chehabexisting projects to not only help advise how to integrate this work upstream 761cd238effSMauro Carvalho Chehabbut also help maintain it long term. Interested developers should visit: 762cd238effSMauro Carvalho Chehab 76316a122c7SAlexander A. Klimovhttps://kernelnewbies.org/KernelProjects/kconfig-sat 764cd238effSMauro Carvalho Chehab 76516a122c7SAlexander A. Klimov.. [4] https://www.cs.cornell.edu/~sabhar/chapters/SATSolvers-KR-Handbook.pdf 76616a122c7SAlexander A. Klimov.. [5] https://gsd.uwaterloo.ca/sites/default/files/vm-2013-berger.pdf 767cd238effSMauro Carvalho Chehab.. [6] https://cados.cs.fau.de 768cd238effSMauro Carvalho Chehab.. [7] https://vamos.cs.fau.de 769cd238effSMauro Carvalho Chehab.. [8] https://undertaker.cs.fau.de 770cd238effSMauro Carvalho Chehab.. [9] https://www4.cs.fau.de/Publications/2011/tartler_11_eurosys.pdf 771cab802b7SNecip Fazil Yildiran.. [10] https://paulgazzillo.com/papers/esecfse21.pdf 772cab802b7SNecip Fazil Yildiran.. [11] https://github.com/paulgazz/kmax 773