单片机移植Lua（STM32H743移植Lua-5.4.6）

文章目录

目的
移植演示
示例链接
更多说明
- 合理设置内存大小
- 按需加载标准库
- 实现系统和IO接口
- 设置引用路径
总结

目的

通常单片机都是使用C/C++来开发的，任何修改都需要重新编译固件然后下载运行。在一些需要灵活性更强的场合中可以内嵌Lua解释器实现动态更新应用程序的功能。这篇文章将对相关内容做个简单说明。

移植演示

Lua本身就是纯C实现的，不管是移植到上位机程序还是单片机程序中本质上没有多大区别，单就移植以及Lua脚本和C代码交互等参考我之前的文章即可：
《Lua和C语言交互入门》https://blog.csdn.net/Naisu_kun/article/details/134000058

这里进行简单演示，使用NUCLEO-H743ZI2开发板，启用默认使能的串口，用来打印输出信息：
在这里插入图片描述

修改最小堆栈大小，生成初始化项目代码。

然后参考上面文章，直接引入Lua源码（排除 lua.c 和 luac.c），接着改写 main.c 代码如下：

#include "main.h"

#include <stdio.h> // 引入该库为了可以使用 printf 函数

#include "src/lua.h"     // Lua数据类型与函数接口
#include "src/lauxlib.h" // Lua与C交互辅助函数接口
#include "src/lualib.h"  // Lua标准库打开接口

UART_HandleTypeDef huart3;
void SystemClock_Config(void);
static void MX_GPIO_Init(void);
static void MX_USART3_UART_Init(void);

/* 以下代码用来实现putchar操作，以此可实现printf功能 */
/* With GCC, small printf (option LD Linker->Libraries->Small printf set to 'Yes') calls __io_putchar() */
#ifdef __GNUC__
#define PUTCHAR_PROTOTYPE int __io_putchar(int ch) // 实现__io_putchar函数
#else
#define PUTCHAR_PROTOTYPE int fputc(int ch, FILE *f)
#endif /* __GNUC__ */

PUTCHAR_PROTOTYPE
{
	// 实际发送操作，这里可以改成自己真实需要操作的端口
    HAL_UART_Transmit(&huart3, (uint8_t *)&ch, 1, 0xFFFF);
    return ch;
}
/* 以上代码用来实现putchar操作，以此可实现printf功能 */

int main(void)
{
  HAL_Init();
  SystemClock_Config();
  MX_GPIO_Init();
  MX_USART3_UART_Init();

  lua_State* L = luaL_newstate(); // 创建Lua线程
  luaL_openlibs(L); // 打开标准库

  while (1)
  {
	 HAL_Delay(1000);
	luaL_dostring(L, "print('Naisu, Lua!')"); // 解析并执行Lua脚本字符串
  }

  lua_close(L); // 关闭Lua线程（虽然代码并不会运行到这里）
}

void SystemClock_Config(void)
{
  // some code ...
}

static void MX_USART3_UART_Init(void)
{
  // some code ...
}

static void MX_GPIO_Init(void)
{
  // some code ...
}

void Error_Handler(void)
{
  // some code ...
}

上面代码主要就两方面内容：

实现了 putchar 操作，这样在 Lua 中就可以使用 print 函数了；
创建Lua虚拟机初始化标准库，然后循环执行Lua脚本；

将上述代码编译后下载到开发板可以看到相关输出：
在这里插入图片描述

示例链接

仓库地址： https://github.com/NaisuXu/STM32_MCU_Examples

本文中的示例位于仓库中 Lua_H743 。

更多说明

从上面演示可以看到，移植本身很简单，不过相比在上位机上移植，在单片机中移植还有些需要注意的地方。

合理设置内存大小

单片机相比上位机一个比较大的问题是内存比较小，所以需要合理设计内存使用。

单片机本身设置合适的堆栈空间：
在这里插入图片描述

Lua源码 luaconf.h 文件中 #define LUAI_MAXSTACK 宏定义用于设置Lua使用的最大栈大小：

/*
@@ LUAI_MAXSTACK limits the size of the Lua stack.
** CHANGE it if you need a different limit. This limit is arbitrary;
** its only purpose is to stop Lua from consuming unlimited stack
** space (and to reserve some numbers for pseudo-indices).
** (It must fit into max(size_t)/32 and max(int)/2.)
*/
#if LUAI_IS32INT
#define LUAI_MAXSTACK		1000000
#else
#define LUAI_MAXSTACK		15000
#endif

按需加载标准库

上面演示中使用 luaL_openlibs(L); 方式加载了所有的Lua标准库，实际使用中完全可以按需加载。

在Lua源码 linit.c 中注释掉不需要的库即可：

/*
** these libs are loaded by lua.c and are readily available to any Lua
** program
*/
static const luaL_Reg loadedlibs[] = {
  {LUA_GNAME, luaopen_base},
  {LUA_LOADLIBNAME, luaopen_package},
  {LUA_COLIBNAME, luaopen_coroutine},
  {LUA_TABLIBNAME, luaopen_table},
  {LUA_IOLIBNAME, luaopen_io},
  {LUA_OSLIBNAME, luaopen_os},
  {LUA_STRLIBNAME, luaopen_string},
  {LUA_MATHLIBNAME, luaopen_math},
  {LUA_UTF8LIBNAME, luaopen_utf8},
  {LUA_DBLIBNAME, luaopen_debug},
  {NULL, NULL}
};