GD32 RISC-V系列 BSP框架制作与移植

熟悉RT-Thread的朋友都知道，RT-Thread提供了许多BSP，但不是所有的板子都能找到相应的BSP，这时就需要移植新的BSP。RT-Thread的所有BSP中，最完善的BSP就是STM32系列，但从2020年下半年开始，国内出现史无前例的芯片缺货潮，芯片的交期和价格不断拉升，STM32的价格也是水涨船高，很多朋友也在考虑使用国产替代，笔者使用的兆易创新的GD32系列，我看了下RT-Thread中GD系列BSP，都是玩家各自为政，每个人都是提交自己使用的板子的BSP，充斥着大量冗余的代码，对于有强迫症的我就非常不爽，就根据手头的板子，参看STM32的BSP架构，构建了GD32的BSP架构。

目前笔者已经完成了ARM架构和RISC-V架构的移植，关于ARM架构的移植可以看我以前的文章，本文将要讲解基于RISC-V架构的移植。

笔者使用的开发板是兆易创新设计的GD32VF103V-SEVAL开发板。其主控芯片为GD32VF103VB，主频 108MHz，128KB FLASH，32KB RAM，资源还算丰富。

1 BSP框架制作

在具体移植GD32VF103V-SEVAL的BSP之前，先做好GD32 RISC-V系列的BSP架构。BSP框架结构如下图所示：

BSP架构主要分为三个部分：libraries、tools和具体的Boards，其中libraries包含了GD32的通用库，包括每个系列的Firmware Library以及适配RT-Thread的drivers；tools是生成工程的Python脚本工具；另外就是Boards文件，当然这里的Boards有很多，我这里值列举了GD32VF103V-SEVAL。

这里先谈谈libraries和tools的构建，然后在后文单独讨论具体板级BSP的制作。

1.1 Libraries构建

Libraries文件夹包含兆易创新提供的固件库，这个直接在兆易创新的官网就可以下载。

下载地址：http://www.gd32mcu.com/cn/download/

然后将GD32VF103_Firmware_Library复制到libraries目录下，其他的系列类似。

GD32VF103_Firmware_Library就是官方的文件，基本是不用大改，这里先在在文件夹中需要添加构建工程的脚本文件SConscript，其实也就是Python脚本。后面具体讲解需要修改的地方。

SConscript文件的内容如下：

import rtconfig

from building import *

# get current directory

cwd = GetCurrentDir()

# The set of source files associated with this SConscript file.

cwd = GetCurrentDir()

src = Split('''

RISCV/env_Eclipse/handlers.c

RISCV/env_Eclipse/init.c

RISCV/env_Eclipse/your_printf.c

RISCV/drivers/n200_func.c

GD32VF103_standard_peripheral/system_gd32vf103.c

GD32VF103_standard_peripheral/Source/gd32vf103_gpio.c

GD32VF103_standard_peripheral/Source/gd32vf103_rcu.c

GD32VF103_standard_peripheral/Source/gd32vf103_exti.c

GD32VF103_standard_peripheral/Source/gd32vf103_eclic.c

''')

if GetDepend(['RT_USING_SERIAL']):

    src += ['GD32VF103_standard_peripheral/Source/gd32vf103_usart.c']

if GetDepend(['RT_USING_I2C']):

    src += ['GD32VF103_standard_peripheral/Source/gd32vf103_i2c.c']

if GetDepend(['RT_USING_SPI']):

    src += ['GD32VF103_standard_peripheral/Source/gd32vf103_spi.c']

if GetDepend(['RT_USING_CAN']):

    src += ['GD32VF103_standard_peripheral/Source/gd32vf103_can.c']

if GetDepend(['BSP_USING_ETH']):

    src += ['GD32VF103_standard_peripheral/Source/gd32vf103_enet.c']

if GetDepend(['RT_USING_ADC']):

    src += ['GD32VF103_standard_peripheral/Source/gd32vf103_adc.c']

if GetDepend(['RT_USING_DAC']):

    src += ['GD32VF103_standard_peripheral/Source/gd32vf103_dac.c']

if GetDepend(['RT_USING_HWTIMER']):

    src += ['GD32VF103_standard_peripheral/Source/gd32vf103_timer.c']

if GetDepend(['RT_USING_RTC']):

    src += ['GD32VF103_standard_peripheral/Source/gd32vf103_rtc.c']

    src += ['GD32VF103_standard_peripheral/Source/gd32vf103_pmu.c']

if GetDepend(['RT_USING_WDT']):

    src += ['GD32VF103_standard_peripheral/Source/gd32vf103_wwdgt.c']

    src += ['GD32VF103_standard_peripheral/Source/gd32vf103fwdgt.c']

path = [

    cwd + '/RISCV/drivers',

    cwd + '/GD32VF103_standard_peripheral',

    cwd + '/GD32VF103_standard_peripheral/Include',]

group = DefineGroup('Libraries', src, depend = [''], CPPPATH = path)

Return('group')

该文件主要的作用就是添加库文件和头文件路径，一部分文件是属于基础文件，因此直接调用Python库的Split包含，另外一部分文件是根据实际的应用需求添加的。

这里是以GD32VF1来举例的，其他系列的都是类似的。

接下来说说Kconfig文件，这里是对内核和组件的功能进行配置，对RT-Thread的组件进行自由裁剪。

如果使用ENV环境，则在使用 menuconfig配置和裁剪 RT-Thread时体现。

后面所有的Kconfig文件都是一样的逻辑。下表列举一些常用的Kconfig句法规则。

Kconfig的语法规则网上资料很多，自行去学习吧。

bsp/gd32/risc-v/libraries/Kconfig内容如下：

config SOC_FAMILY_GD32

    bool

config SOC_GD32VF103V

    bool

    select SOC_SERIES_GD32VF103V

    select SOC_FAMILY_GD32

最后谈谈gd32_drivers，这个文件夹就是GD32的外设驱动文件夹，为上层应用提供调用接口。

该文件夹是整个GD32共用的，因此在编写和修改都要慎重。关于drv_xxx文件在后句具体移植BSP的时候讲解，这里主要将整体架构，SConscript和Kconfig的作用和前面的一样，只是具体的内容不同罢了。

好了，先看bsp/gd32/risc-v/libraries/gd32_drivers/SConscript文件。

Import('RTT_ROOT')

Import('rtconfig')

from building import *

cwd = GetCurrentDir()

# add the general drivers.

src = Split('''

''')

# add pin drivers.

if GetDepend('RT_USING_PIN'):

    src += ['drv_gpio.c']

# add usart drivers.

if GetDepend(['RT_USING_SERIAL']):

    src += ['drv_usart.c']

# add i2c drivers.

if GetDepend(['RT_USING_I2C', 'RT_USING_I2C_BITOPS']):

    if GetDepend('BSP_USING_I2C0') or GetDepend('BSP_USING_I2C1') or GetDepend('BSP_USING_I2C2') or GetDepend('BSP_USING_I2C3'):

        src += ['drv_soft_i2c.c']

# add spi drivers.

if GetDepend('RT_USING_SPI'):

    src += ['drv_spi.c']

# add spi flash drivers.

if GetDepend('RT_USING_SFUD'):

    src += ['drv_spi_flash.c', 'drv_spi.c']

# add wdt drivers.

if GetDepend('RT_USING_WDT'):

    src += ['drv_wdt.c']

# add rtc drivers.

if GetDepend('RT_USING_RTC'):

    src += ['drv_rtc.c']

# add timer drivers.

if GetDepend('RT_USING_HWTIMER'):

    src += ['drv_hwtimer.c']

# add adc drivers.

if GetDepend('RT_USING_ADC'):

    src += ['drv_adc.c']

path = [cwd]

group = DefineGroup('Drivers', src, depend = [''], CPPPATH = path)

Return('group')

和GD32VF103_Firmware_Library文件夹中的SConscript是类似的。

bsp/gd32/risc-v/libraries/gd32_drivers/Kconfig文件结构如下：

if BSP_USING_USBD

    config BSP_USBD_TYPE_FS

        bool

        # 'USB Full Speed (FS) Core'

endif

1.2 Tools构建

该文件夹就是工程构建的脚本，

import os

import sys

import shutil

cwd_path = os.getcwd()

sys.path.append(os.path.join(os.path.dirname(cwd_path), 'rt-thread', 'tools'))

def bsp_update_board_kconfig(dist_dir):

    # change board/kconfig path

    if not os.path.isfile(os.path.join(dist_dir, 'board/Kconfig')):

        return

    with open(os.path.join(dist_dir, 'board/Kconfig'), 'r') as f:

        data = f.readlines()

    with open(os.path.join(dist_dir, 'board/Kconfig'), 'w') as f:

        for line in data:

            if line.find('../libraries/gd32_drivers/Kconfig') != -1:

                position = line.find('../libraries/gd32_drivers/Kconfig')

                line = line[0:position] + 'libraries/gd32_drivers/Kconfig'n'

            f.write(line)

# BSP dist function

def dist_do_building(BSP_ROOT, dist_dir):

    from mkdist import bsp_copy_files

    import rtconfig

    print('=> copy gd32 bsp library')

    library_dir = os.path.join(dist_dir, 'libraries')

    library_path = os.path.join(os.path.dirname(BSP_ROOT), 'libraries')

    bsp_copy_files(os.path.join(library_path, rtconfig.BSP_LIBRARY_TYPE),

                   os.path.join(library_dir, rtconfig.BSP_LIBRARY_TYPE))

    print('=> copy bsp drivers')

    bsp_copy_files(os.path.join(library_path, 'gd32_drivers'), os.path.join(library_dir, 'gd32_drivers'))

    shutil.copyfile(os.path.join(library_path, 'Kconfig'), os.path.join(library_dir, 'Kconfig'))

    bsp_update_board_kconfig(dist_dir)

以上代码很简单，主要使用了Python的OS模块的join函数，该函数的作用就是连接两个或更多的路径名。最后将BSP依赖的文件复制到指定目录下。

在使用scons --dist命令打包的时候，就是依赖的该脚本，生成的dist文件夹的工程到任何目录下使用，也就是将BSP相关的库以及内核文件提取出来，可以将该工程任意拷贝。

需要注意的是，使用scons --dist打包后需要修改board/Kconfig中的库路径，因此这里调用了bsp_update_board_kconfig方法修改。

1.3 gd32vf103v-eval构建

该文件夹就gd32vf103v-eval的具体BSP文件，文件结构如下：

在后面将具体讲解如何构建该部分内容。

2 BSP移植

2.1GCC环境准备

RISC-V系列MCU使用的工具链是xPack GNU RISC-V Embedded GCC。

在配置交叉编译工具链之前，需要下载得到GCC工具链的安装包，然后解压即可，也可配置环境变量。

GCC工具链下载地址：https://github.com/xpack-dev-tools/riscv-none-embed-gcc-xpack/releases/

根据自己的主机选择相应的版本，下载完成解压即可。

2.2 BSP工程制作

1.构建基础工程

首先看看RT-Thread代码仓库中已有很多BSP，而我要移植的是RISC-V内核。这里参考GD32 ARM工程。最终目录如下：

risc-v
docs #说明文档
gd32vf103v-eval #具体BSP
libraries #库文件
  gd32_drivers
  GD32VF103_Firmware_Library # GD官方固件库
tools
  OpenOCD # OpenOCD下载调试工具
README.md

2.修改BSP构建脚本

bsp/gd32/risc-v/gd32vf103v-eval/SConstruct修改后的内容如下：

import os

import sys

import rtconfig

if os.getenv('RTT_ROOT'):

    RTT_ROOT = os.getenv('RTT_ROOT')

else:

    RTT_ROOT = os.path.normpath(os.getcwd() + '/../../../..')

sys.path = sys.path + [os.path.join(RTT_ROOT, 'tools')]

try:

    from building import *

except:

    print('Cannot found RT-Thread root directory, please check RTT_ROOT')

    print(RTT_ROOT)

    exit(-1)

TARGET = 'rtthread.' + rtconfig.TARGET_EXT

DefaultEnvironment(tools=[])

env = Environment(tools = ['mingw'],

    AS = rtconfig.AS, ASFLAGS = rtconfig.AFLAGS,

    CC = rtconfig.CC, CCFLAGS = rtconfig.CFLAGS,

    AR = rtconfig.AR, ARFLAGS = '-rc',

    CXX = rtconfig.CXX, CXXFLAGS = rtconfig.CXXFLAGS,

    LINK = rtconfig.LINK, LINKFLAGS = rtconfig.LFLAGS)

env.PrependENVPath('PATH', rtconfig.EXEC_PATH)

env['ASCOM'] = env['ASPPCOM']

Export('RTT_ROOT')

Export('rtconfig')

SDK_ROOT = os.path.abspath('./')

if os.path.exists(SDK_ROOT + '/libraries'):

    libraries_path_prefix = SDK_ROOT + '/libraries'