rt-thread 如何添加配置自定义文件

文章目录

        一、SConstruct、SConscript、kconfig 文件

        二、如何添加源文件并配置

        三、结语

一、SCconstruct、SConscript、kconfig 文件

        继上次学会移植和裁剪之后，又折腾了一下怎么添加自己写的应用文件，并且可以在menuconfig界面中进行配置。

        首先来了解一下rt-thread的构建与配置系统，下图是从rt-thread官方文档中心截下来的图，包含kconfig，scons 和 env 工具三部分。

        在前面一篇移植的过程中，当时直接介绍了env的使用，但是已经用到了 scons 命令（env工具中已经带有scons 和 python, 因此在windows平台使用scons并不需要安装）。scons：software construction tool，称之为构建工具，是一种软件。它可以根据一定的规则或命令，将源代码编译成可执行的二进制程序。

        SCons 使用 SConscript 和 SConstruct 文件来组织源码结构，通常来说一个项目只有一 SConstruct，但是会有多个 SConscript。一般情况下，每个存放有源代码的子目录下都会放置一个 SConscript。

        为了使 RT-Thread 更好的支持多种编译器，以及方便的调整编译参数，RT-Thread 为每个 BSP 单独创建了一个名为 rtconfig.py 的文件。因此每一个 RT-Thread BSP 目录下都会存在下面三个文件：rtconfig.py、SConstruct 和 SConscript，它们控制 BSP 的编译，如下图所示，为一个完整工程根目录下的三个文件：

        

        前面介绍的SCons中的两个文件，用来编译，具体如何使用在下一节介绍，现在介绍一下kconfig文件。

        C语言项目的裁剪和配置本质上是通过条件编译和宏的展开来实现的，rt-thread 使用kconfig这套机制更方便的实现了这一功能。Kconfig机制包括了kconfig文件和配置UI界面，具有如下特点：

        kconfig文件中的配置项会映射到rtconfig.h中

        kconfig文件可以随源码分散至各级子目录，便于灵活修改

        

        具体来说就是，Kconfig文件在源码中呈现树形结构，需要在工程的根目录下存在一份顶层Kconfig文件，顶层Kconfig文件在文件中通过source语句显示地调用各子目录下的Kconfig文件。Env在根目录下执行menuconfig命令后会递归解析各级Kconfig文件，然后提供配置界面，完成相应的配置后并保存，根目录下会存在一份.config文件保存当前选择的配置项，并将.config文件转为RT-Thread的系统配置文件rtconfig.h

        

二、如何添加源文件并配置

        在了解了一些理论的知识之后，根据官方提供的文档，进行实际的操作，这样可以更好的理解。

        以hello.c 和 hello.h 为例，在工程目录下新建一个文件夹 hello, 并放置下图两个文件

/* file: hello.h */

#ifndef _HELLO_H_
#define _HELLO_H_

int hello_world(void);

#endif /* _HELLO_H_ */

/* file: hello.c */
#include <stdio.h>
#include <finsh.h>
#include <rtthread.h>

int hello_world(void)
{
    rt_kprintf("Hello, world!\n");

    return 0;
}

MSH_CMD_EXPORT(hello_world, Hello world!)

          添加了上述两个文件之后，再添加一个SConscript 文件，并进行编写，至于编写规则目前我也不是很清楚，只是按照教程操作

 

# -*- coding: UTF-8 -*-             # 指定文件的编码格式是 UTF-8，文件可以用中文
Import('RTT_ROOT')
Import('rtconfig')
from building import *

cwd          = GetCurrentDir()      # 将当前路径赋值给字符串 cwd
include_path = [cwd]                # 将当前头文件路径保存到 list 变量 include_path 中
src          = []                   # 定义一个 list 变量 src

if GetDepend(['RT_USING_HELLO']):   # hello.c 依赖宏 RT_USING_HELLO
    src += ['hello.c']              # 保存 hello.c 字符串到 list 变量 src 中

# 将 src 包含的源文件创建为 hello 组。depend 为空表示该组不依赖 rtconfig.h 的任何宏。
# CPPPATH = include_path 表示将当前目录添加到系统的头文件路径中
group = DefineGroup('hello', src, depend = [''], CPPPATH = include_path)

Return('group')

我们已经完成了第一步，现在进行第二步，将其增加到menuconfig菜单中，在工程中会有kconfig文件，如下图所示，并添加相应的代码

完成之后，此时使用env工具，进入menuconfig配置界面，就会出现相应的配置选项

配置完成之后，执行 scons --target=mdk5命令，就会更新工程，并且在rtconfig.h 会出现相应的宏定义。如下图所示：

        至此，添加源文件和进行配置就实现了。

三、结语

        对于这个过程已经了解了，但是真正编写sconscript文件和kconfig文件还未掌握，只能依样画瓢，有时间再去多了解学习。下一次打算学习一下rt-thread源码的结构和相应的组件使用。目前我所了解到的是finsh 和 posix组件会用到。