RT-Thread GD32 RISC-V系列BSP外设驱动使用教程

GD32 RISC-V 系列BSP 说明

GD32 RISC-V系列 BSP 目前支持情况如下表所示：

可以通过阅读相应 BSP 下的 README 来快速上手，如果想要使用 BSP 更多功能可参考 docs 文件夹下提供的说明文档，如下表所示：

RT-Thread GD32 RISC-V系列BSP外设驱动使用教程

简介

本文档是为需要在 RT-Thread 操作系统上使用更多开发板资源的开发者准备的。通过使用 ENV 工具对 BSP 进行配置，可以开启更多板载资源，实现更多高级功能。

主要包括以下内容：

1. 如何使用开发板上更多的板载资源
2. 如何使用更多的片上资源
3. 如何添加更多片上资源选项

前提要求

• 学会如何使用 ENV 工具，参考：[RT-Thread env 工具用户手册]

如何使用更多的板载资源

开发板上一般有很多板载资源，如 Flash、SD卡等，但是 BSP 工程默认没有开启这些外设驱动。RT-Thread 提供了 ENV 工具来开启或关闭 BSP 的外设驱动。下面以在GD32VFf103V-EVAL开发板上开启 UART1驱动为例，一步步的展示如何使用 ENV 工具对 BSP 进行配置。

1）打开配置工具

在目录 rt-thread\bsp\gd32\risc-v\gd32vf103v-eval 下打开 menuconfig 配置界面。

打开的配置工具界面如下所示：

通过键盘上的上下键移动光标，选中 Hardware Drivers Config然后按回车键进入硬件驱动配置菜单。

2）进入硬件驱动配置菜单

在硬件配置菜单里有三个选项，分别是 板载外设配置菜单、片上外设配置菜单和扩展模块配置菜单，按回车键进入板载外设配置菜单。

3）在板载外设配置菜单里开启 UART1 选项

4）保存退出

然后右移光标选中 Save 按回车键保存，然后按 Esc 键退出配置工具。

5）更新软件包

输入命令 pkgs --update 使软件包配置生效。

6）编译

直接使用gcc编译程序。

值得注意的是，使用gcc编译程序，需要先配置好RISC-V系列MCU的交叉编译工具链。

7）下载

下载工具可以使用J-Link/GD-Link，可使用GD官方的DFU，也可使用OpenOCD下载。

8）查看运行结果

程序运行后，输入命令 list_device 可以看到名为 uart1的设备，此时 UART1 设备已经可以使用了。

总结

当开发者需要使用未开启的外设时，只要在 ENV 工具中使能相关的外设即可，重新生成的工程中就会添加对应的驱动文件。开发者就可以利用 RT-Thread 提供的驱动开快速开发应用了。

联系人信息

维护人:

• 华为奋斗者精神, 邮箱：1992152446@qq.com

示例代码

• …\bsp\gd32\arm\libraries\gd32_drivers\drv_soft_i2c.c

/*
 * Copyright (c) 2006-2022, RT-Thread Development Team
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Change Logs:
 * Date           Author            Notes
 * 2021-12-20     BruceOu           the first version
 */
#include "drv_soft_i2c.h"

#ifdef RT_USING_I2C

#define LOG_TAG              "drv.i2c"
#include <rtdbg.h>

#if !defined(BSP_USING_I2C0) && !defined(BSP_USING_I2C1) && !defined(BSP_USING_I2C2) && !defined(BSP_USING_I2C3)
#error "Please define at least one BSP_USING_I2Cx"
/* this driver can be disabled at menuconfig → RT-Thread Components → Device Drivers */
#endif

static const struct gd32_soft_i2c_config soft_i2c_config[] =
{
#ifdef BSP_USING_I2C0
    I2C0_BUS_CONFIG,
#endif
#ifdef BSP_USING_I2C1
    I2C1_BUS_CONFIG,
#endif
#ifdef BSP_USING_I2C2
    I2C2_BUS_CONFIG,
#endif
#ifdef BSP_USING_I2C3
    I2C3_BUS_CONFIG,
#endif
};

static struct gd32_i2c i2c_obj[sizeof(soft_i2c_config) / sizeof(soft_i2c_config[0])];

/**
  * @brief  This function initializes the i2c pin.
  * @param  i2c
  * @retval None
  */
static void gd32_i2c_gpio_init(struct gd32_i2c *i2c)
{
    struct gd32_soft_i2c_config* cfg = (struct gd32_soft_i2c_config*)i2c->ops.data;

    rt_pin_mode(cfg->scl, PIN_MODE_OUTPUT_OD);
    rt_pin_mode(cfg->sda, PIN_MODE_OUTPUT_OD);

    rt_pin_write(cfg->scl, PIN_HIGH);
    rt_pin_write(cfg->sda, PIN_HIGH);
}

/**
  * @brief  This function sets the sda pin.
  * @param  data, state
  * @retval None
  */
static void gd32_set_sda(void *data, rt_int32_t state)
{
    struct gd32_soft_i2c_config* cfg = (struct gd32_soft_i2c_config*)data;
    if (state)
    {
        rt_pin_write(cfg->sda, PIN_HIGH);
    }
    else
    {
        rt_pin_write(cfg->sda, PIN_LOW);
    }
}

/**
  * @brief  This function sets the scl pin.
  * @param  data, state
  * @retval None
  */
static void gd32_set_scl(void *data, rt_int32_t state)
{
    struct gd32_soft_i2c_config* cfg = (struct gd32_soft_i2c_config*)data;
    if (state)
    {
        rt_pin_write(cfg->scl, PIN_HIGH);
    }
    else
    {
        rt_pin_write(cfg->scl, PIN_LOW);
    }
}

/**
  * @brief  This function gets the sda pin state.
  * @param  data
  * @retval None
  */
static rt_int32_t gd32_get_sda(void *data)
{
    struct gd32_soft_i2c_config* cfg = (struct gd32_soft_i2c_config*)data;
    return rt_pin_read(cfg->sda);
}


/**
  * @brief  This function gets the scl pin state.
  * @param  data
  * @retval None
  */
static rt_int32_t gd32_get_scl(void *data)
{
    struct gd32_soft_i2c_config* cfg = (struct gd32_soft_i2c_config*)data;
    return rt_pin_read(cfg->scl);
}

/**
  * @brief  The time delay function.
  * @param  us
  * @retval None
  */
static void gd32_udelay(rt_uint32_t us)
{
    int i = ( rcu_clock_freq_get(CK_SYS) / 4000000 * us);
    while(i)
    {
        i--;
    }
}

static const struct rt_i2c_bit_ops gd32_bit_ops_default =
{
    .data     = RT_NULL,
    .set_sda  = gd32_set_sda,
    .set_scl  = gd32_set_scl,
    .get_sda  = gd32_get_sda,
    .get_scl  = gd32_get_scl,
    .udelay   = gd32_udelay,
    .delay_us = 1,
    .timeout  = 100
};

/**
  * @brief  if i2c is locked, this function will unlock it
  * @param  cfg
  * @retval RT_EOK indicates successful unlock.
  */
static rt_err_t gd32_i2c_bus_unlock(const struct gd32_soft_i2c_config *cfg)
{
    rt_int32_t i = 0;

    if (PIN_LOW == rt_pin_read(cfg->sda))
    {
        while (i++ < 9)
        {
            rt_pin_write(cfg->scl, PIN_HIGH);
            gd32_udelay(100);
            rt_pin_write(cfg->scl, PIN_LOW);
            gd32_udelay(100);
        }
    }
    if (PIN_LOW == rt_pin_read(cfg->sda))
    {
        return -RT_ERROR;
    }

    return RT_EOK;
}

/**
  * @brief  I2C initialization function
  * @param  None
  * @retval RT_EOK indicates successful initialization.
  */
int rt_hw_i2c_init(void)
{
    rt_size_t obj_num = sizeof(i2c_obj) / sizeof(struct gd32_i2c);
    rt_err_t result;

    for (int i = 0; i < obj_num; i++)
    {
        i2c_obj[i].ops = gd32_bit_ops_default;
        i2c_obj[i].ops.data = (void*)&soft_i2c_config[i];
        i2c_obj[i].i2c2_bus.priv = &i2c_obj[i].ops;
        gd32_i2c_gpio_init(&i2c_obj[i]);

        result = rt_i2c_bit_add_bus(&i2c_obj[i].i2c2_bus, soft_i2c_config[i].bus_name);

        RT_ASSERT(result == RT_EOK);

        gd32_i2c_bus_unlock(&soft_i2c_config[i]);

        LOG_D("software simulation %s init done, pin scl: %d, pin sda %d",
        soft_i2c_config[i].bus_name,
        soft_i2c_config[i].scl,
        soft_i2c_config[i].sda);
    }

    return RT_EOK;
}
INIT_BOARD_EXPORT(rt_hw_i2c_init);

#endif /* RT_USING_I2C */