如何为项目引入Kconfig配置系统

English

如何为项目引入Kconfig配置系统
- 验证 python 环境
- C语言头文件生成脚本
应用
- 创建Kconfig

项目中经常会有通过宏配置或选择参数：

#ifdef CFG_ENABLE
#define CFG_ARGS    "test"
void printf_args(void)
{
    printf("args: %s\n", CFG_ARGS);
}
#endif

当项目规模较小，配置项和依赖关系相对简单时，我们可以通过手动修改源代码来实现配置功能。但是，随着项目规模的增长和配置复杂度的增加，这种方式也会出现一些问题。

随着代码体量和调用关系的增多，对配置者来说很难完全熟悉 代码结构及各模块之间的依赖关系。同时，如果配置项设置较为随意且缺乏约束，也很可能导致错误配置。这对项目质量和维护都带来一定难度。

对于规模较大的项目来说，需要一套专业的配置管理系统来解决这些问题。Kconfig正是为了应对这种需求而产生的。它通过配置脚本定义各配置选项及其依赖关系，并提供图形化界面 供配置者操作。同时还会检查配置合理性，帮助我们实现定制化构建的同时防止错误配置。

如果有接触过Linux或者RT-Thread等，相信对Kconfig系统都不陌生。Kconfig是Linux内核和许多其他系统广泛使用的一款配置管理工具。它可以让开发人员在编译时选择性地包含或排除某些功能模块。

Kconfig使用配置脚本定义各种配置选项及其依赖关系。通过图形或字符型用户界面，开发者可以查看并设置各种配置。然后Kconfig会生成 .config 文件保存选择结果。在编译的时候，会根据 .config 文件里设置的符号自动包含或排除对应的源代码。

验证 python 环境

Kconfig依赖于 python ，如果没有 python 环境请自行安装。

在命令行中使用所示命令验证：

python --version

显示（正确显示版本即可）：

Python 3.11.4

C语言头文件生成脚本

Kconfiglib 生成的是 .config 文件，并非C语言文件，需要使用脚本生成，将以下代码复制到文件中并命名为kconfig.py。

import re
import pip


def log_print(level, text):
    # Log level colors
    LEVEL_COLORS = {
        'error': '\033[31m',
        'success': '\033[32m',
        'warning': '\033[33m',
        'info': '\033[34m',
    }
    RESET_COLOR = '\033[0m'
    # Log level name
    LEVEL_NAME = {
        'error': 'ERROR',
        'success': 'SUCCESS',
        'warning': 'WARNING',
        'info': 'INFO',
    }
    print(LEVEL_COLORS[level] + LEVEL_NAME[level] + ': ' + text + RESET_COLOR)


def install_package(package):
    log_print('info', "%s package installing..." % package)
    pip.main(['install', package])


try:
    from kconfiglib import Kconfig
except ImportError:
    install_package('kconfiglib')
    from kconfiglib import Kconfig

try:
    import curses
except ImportError:
    install_package('windows-curses')
    import curses


def generate_config(kconfig_file, config_in, config_out, header_out):
    kconf = Kconfig(kconfig_file, warn=False, warn_to_stderr=False)

    # Load config
    kconf.load_config(config_in)
    kconf.write_config(config_out)
    kconf.write_autoconf(header_out)

    with open(header_out, 'r+') as header_file:
        content = header_file.read()
        header_file.truncate(0)
        header_file.seek(0)

        # Remove CONFIG_ and MR_USING_XXX following number
        content = content.replace("#define CONFIG_", "#define ")
        content = re.sub(r'#define MR_USING_(\w+) (\d+)', r'#define MR_USING_\1', content)

        # Add the micro
        header_file.write("#ifndef _MR_CONFIG_H_\n")
        header_file.write("#define _MR_CONFIG_H_\n\n")

        header_file.write("#ifdef __cplusplus\n")
        header_file.write("extern \"C\" {\n")
        header_file.write("#endif /* __cplusplus */\n\n")

        # Write back the original data
        header_file.write(content)

        # Add the micro
        header_file.write("\n#ifdef __cplusplus\n")
        header_file.write("}\n")
        header_file.write("#endif /* __cplusplus */\n\n")
        header_file.write("#endif /* _MR_CONFIG_H_ */\n")

        header_file.close()
        log_print('success', "menuconfig %s make success" % header_out)


def main():
    kconfig_file = ''
    config_in = '.config'
    config_out = '.config'
    header_out = 'config.h'
    generate_config(kconfig_file, config_in, config_out, header_out)


if __name__ == "__main__":
    main()

修改main函数中header_out 可修改生成的函数文件名。

此脚本去除了Kconfig默认添加的CONFIG_前缀，并为其加上了_CONFIG_H_ 和C声明。

应用

创建Kconfig

新建一个名字为 Kconfig 的文件（注意没有后缀名），和上一步中中创建的 kconfig.py 的文件放在一起。

mainmenu "Demo"

menu "Args configure"
config CFG_ARG1
    bool "Enable arg1"
    default n
    
config CFG_ARG2
	int "Arg2 number"
	default 8
	range 0 64

endmenu

在当前目录下调用命令行，输入：