GD32上SFUD万能Flash驱动移植
GD32上SFUD万能Flash驱动移植
- 移植前提
- 下载源码
- 测试效果
- 移植过程
- 添加文件到工程目录
- keil项目中添加如下文件到工程，设置头文件包含路径
- 修改sfud_port.c文件
- 修改sfud_cfg.h文件
- 添加获取初始化状态，可加可不加
- 验证测试
SFUD (Serial Flash Universal Driver) 串行 Flash 通用驱动库
移植前提
下载源码
前往下载
测试效果
移植过程
添加文件到工程目录
主要关注sfud文件夹和sfud项目文件
keil项目中添加如下文件到工程，设置头文件包含路径
修改sfud_port.c文件
其主要实现spi的不同芯片平台底层驱动包括：
- SPI的初始化
- ms延时
- 保护锁（针对多线程，若非系统则使用开关总中断方式防止打断操作）
使用操作系统的情况下直接使用开关总中断方式上锁解锁，则延时函数接口应使用操作系统的延时如
osDelay不可使用HAL_Delay或其他利用中断计时的函数，避免systick无法进入中断导致线程无法运行或其他中断无法进入计时累积导致程序停留无法运行，如有使用出现问题注意此方向的排查
- 读写操作
/*
* This file is part of the Serial Flash Universal Driver Library.
*
* Copyright (c) 2016-2018, Armink,
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* 'Software'), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* Function: Portable interface for each platform.
* Created on: 2016-04-23
*/
#include 针对STM32则接口修改如下：
/*
* This file is part of the Serial Flash Universal Driver Library.
*
* Copyright (c) 2016-2018, Armink,
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* 'Software'), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* Function: Portable interface for each platform.
* Created on: 2016-04-23
*/
#include 修改sfud_cfg.h文件
将自己板子上flash信息添加上，我的是一个spi flash设备GD25Q16B
注意根据qspi启用状态：
//#define SFUD_USING_QSPI，我这里打开；当然选择不启用，简单点操作会减少很多异常问题
#ifndef _SFUD_CFG_H_
#define _SFUD_CFG_H_
#define SFUD_DEBUG_MODE
#define SFUD_USING_SFDP
#define SFUD_USING_FLASH_INFO_TABLE
enum {
SFUD_GD25Q16B_DEVICE_INDEX = 0,
};
#define SFUD_FLASH_DEVICE_TABLE \
{ \
[SFUD_GD25Q16B_DEVICE_INDEX] = {.name = "GD25Q16B", .spi.name = "SPI5"}, \
}
#define SFUD_USING_QSPI
#endif /* _SFUD_CFG_H_ */
添加获取初始化状态，可加可不加
声明一个局部变量，存储初始化的状态：
static sfud_err ALL_flash_result = SFUD_SUCCESS;
在sfud_init(void)中加入以下代码：
ALL_flash_result = all_flash_result;
/**
******************************************************************
* @brief 获取初始化完成状态
* @param None
* @retval SFUD_SUCCESS 成功
* @author aron566
* @version v1.0
* @date 2020/6/8
******************************************************************
*/
sfud_err sfud_GetInitState(void)
{
return ALL_flash_result;
}
验证测试
这里可以参考官方例程的测试代码
在main.c中加入以下代码
注意根据qspi启用状态：调用
sfud_qspi_fast_read_enable，我这里打开；当然选择不启用，简单点操作会减少很多异常问题
if (sfud_init() == SFUD_SUCCESS)
{
/* enable qspi fast read mode, set four data lines width */
sfud_qspi_fast_read_enable(sfud_get_device(SFUD_GD25Q16B_DEVICE_INDEX), 4);
sfud_demo(0, sizeof(sfud_demo_test_buf), sfud_demo_test_buf);
}
#include "sfud.h"
/**
* SFUD demo for the first flash device test.
*
* @param addr flash start address
* @param size test flash size
* @param size test flash data buffer
*/
void sfud_demo(uint32_t addr, size_t size, uint8_t *data)
{
sfud_err result = SFUD_SUCCESS;
extern sfud_flash *sfud_dev;
const sfud_flash *flash = sfud_get_device(SFUD_GD25Q16B_DEVICE_INDEX);
size_t i;
/* prepare write data */
for (i = 0; i < size; i++)
{
data[i] = i;
}
/* erase test */
result = sfud_erase(flash, addr, size);
if (result == SFUD_SUCCESS)
{
printf("Erase the %s flash data finish. Start from 0x%08X, size is %zu.\r\n", flash->name, addr, size);
}
else
{
printf("Erase the %s flash data failed.\r\n", flash->name);
return;
}
/* write test */
result = sfud_write(flash, addr, size, data);
if (result == SFUD_SUCCESS)
{
printf("Write the %s flash data finish. Start from 0x%08X, size is %zu.\r\n", flash->name, addr, size);
}
else
{
printf("Write the %s flash data failed.\r\n", flash->name);
return;
}
/* read test */
result = sfud_read(flash, addr, size, data);
if (result == SFUD_SUCCESS)
{
printf("Read the %s flash data success. Start from 0x%08X, size is %zu. The data is:\r\n", flash->name, addr, size);
printf("Offset (h) 00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F\r\n");
for (i = 0; i < size; i++)
{
if (i % 16 == 0)
{
printf("[%08X] ", addr + i);
}
printf("%02X ", data[i]);
if (((i + 1) % 16 == 0) || i == size - 1)
{
printf("\r\n");
}
}
printf("\r\n");
}
else
{
printf("Read the %s flash data failed.\r\n", flash->name);
}
/* data check */
for (i = 0; i < size; i++)
{
if (data[i] != i % 256)
{
printf("Read and check write data has an error. Write the %s flash data failed.\r\n", flash->name);
break;
}
}
if (i == size)
{
printf("The %s flash test is success.\r\n", flash->name);
}
}