Просмотр исходного кода

add:规范spi.deviceSetup命名,并更新注释

Dozingfiretruck 4 лет назад
Родитель
Сommit
96e56d805c

+ 10 - 10
components/sfud/luat_lib_sfud.c

@@ -57,10 +57,10 @@ static int luat_sfud_init(lua_State *L){
 
 /*
 获取flash设备信息表中的设备总数
-@api  sfud.get_device_num()
+@api  sfud.getDeviceNum()
 @return int  返回设备总数
 @usage
-log.info("sfud.get_device_num",sfud.get_device_num())
+log.info("sfud.getDeviceNum",sfud.getDeviceNum())
 */
 static int luat_sfud_get_device_num(lua_State *L){
     int re = sfud_get_device_num();
@@ -70,11 +70,11 @@ static int luat_sfud_get_device_num(lua_State *L){
 
 /*
 通过flash信息表中的索引获取flash设备
-@api  sfud.get_device(index)
+@api  sfud.getDevice(index)
 @int  index flash信息表中的索引
 @return userdata 成功返回一个数据结构,否则返回nil
 @usage
-local sfud_device = sfud.get_device(1)
+local sfud_device = sfud.getDevice(1)
 */
 static int luat_sfud_get_device(lua_State *L){
     sfud_flash *flash = sfud_get_device(luaL_checkinteger(L, 1));
@@ -84,10 +84,10 @@ static int luat_sfud_get_device(lua_State *L){
 
 /*
 获取flash设备信息表
-@api  sfud.get_device_table()
+@api  sfud.getDeviceTable()
 @return userdata 成功返回一个数据结构,否则返回nil
 @usage
-local sfud_device = sfud.get_device_table()
+local sfud_device = sfud.getDeviceTable()
 */
 static int luat_sfud_get_device_table(lua_State *L){
     sfud_flash *flash = sfud_get_device_table();
@@ -97,11 +97,11 @@ static int luat_sfud_get_device_table(lua_State *L){
 
 /*
 擦除 Flash 全部数据
-@api  sfud.chip_erase(flash)
+@api  sfud.chipErase(flash)
 @userdata flash Flash 设备对象 sfud.get_device_table()返回的数据结构
 @return int 成功返回0
 @usage
-sfud.chip_erase(flash)
+sfud.chipErase(flash)
 */
 static int luat_sfud_chip_erase(lua_State *L){
     const sfud_flash *flash = lua_touserdata(L, 1);
@@ -175,14 +175,14 @@ static int luat_sfud_write(lua_State *L){
 
 /*
 先擦除再往 Flash 写数据
-@api  sfud.erase_write(flash, addr, size,data)
+@api  sfud.eraseWrite(flash, addr, size,data)
 @userdata flash Flash 设备对象 sfud.get_device_table()返回的数据结构
 @int addr 起始地址
 @int size 从起始地址开始读取数据的总大小
 @string data 待写入的数据
 @return int 成功返回0
 @usage
-log.info("sfud.erase_write",sfud.erase_write(sfud_device,1024,"sfud"))
+log.info("sfud.eraseWrite",sfud.eraseWrite(sfud_device,1024,"sfud"))
 */
 static int luat_sfud_erase_write(lua_State *L){
     const sfud_flash *flash = lua_touserdata(L, 1);

+ 1 - 1
demo/lcd/Air101/main.lua

@@ -16,7 +16,7 @@ _G.sys = require("sys")
 wdt.init(15000)--初始化watchdog设置为15s
 sys.timerLoopStart(wdt.feed, 10000)--10s喂一次狗
 
-local spi_lcd = spi.device_setup(0,20,0,0,8,2000000,spi.MSB,1,1)
+local spi_lcd = spi.deviceSetup(0,20,0,0,8,2000000,spi.MSB,1,1)
 
 -- log.info("lcd.init",
 -- lcd.init("gc9a01",{port = "device",pin_dc = 17, pin_pwr = 16,pin_rst = 19,direction = 0,w = 240,h = 320,xoffset = 0,yoffset = 0},spi_lcd))

+ 1 - 1
demo/lvgl/Air101/main.lua

@@ -18,7 +18,7 @@ sys.timerLoopStart(wdt.feed, 10000)--10s喂一次狗
 
 log.info("hello luatos")
 
-local spi_lcd = spi.device_setup(0,20,0,0,8,2000000,spi.MSB,1,1)
+local spi_lcd = spi.deviceSetup(0,20,0,0,8,2000000,spi.MSB,1,1)
 log.info("lcd.init",
 lcd.init("st7735s",{port = "device",pin_dc = 17, pin_pwr = 7,pin_rst = 19,direction = 2,w = 160,h = 80,xoffset = 1,yoffset = 26},spi_lcd))
 

+ 1 - 1
demo/sfud/Air101/main.lua

@@ -13,7 +13,7 @@ sys.timerLoopStart(wdt.feed, 10000)--10s喂一次狗
 
 sys.taskInit(function()
     -- log.info("sfud.init",sfud.init(0,20,20 * 1000 * 1000))--此方法spi总线无法挂载多设备
-    local spi_flash = spi.device_setup(0,22,0,0,8,2000000,spi.MSB,1,1)--PB6
+    local spi_flash = spi.deviceSetup(0,22,0,0,8,2000000,spi.MSB,1,1)--PB6
     log.info("sfud.init",sfud.init(spi_flash))
     log.info("sfud.getDeviceNum",sfud.getDeviceNum())
     local sfud_device = sfud.getDeviceTable()

+ 1 - 1
demo/video_play/Air101/main.lua

@@ -20,7 +20,7 @@ sys.taskInit(function()
     sdio.init(0)
     sdio.sd_mount(0,"/sd",0)
 
-    local spi_lcd = spi.device_setup(0,20,0,0,8,2000000,spi.MSB,1,1)
+    local spi_lcd = spi.deviceSetup(0,20,0,0,8,2000000,spi.MSB,1,1)
     log.info("lcd.init",
     lcd.init("st7735s",{port = "device",pin_dc = 17, pin_pwr = 7,pin_rst = 19,direction = 2,w = 160,h = 80,xoffset = 1,yoffset = 26},spi_lcd))
     

+ 3 - 3
luat/modules/luat_lib_spi.c

@@ -186,7 +186,7 @@ static int l_spi_send(lua_State *L) {
 
 /**
 设置并启用SPI(对象方式)
-@api spi.device_setup(id, cs, CPHA, CPOL, dataw, bandrate, bitdict, ms, mode)
+@api spi.deviceSetup(id, cs, CPHA, CPOL, dataw, bandrate, bitdict, ms, mode)
 @int SPI号,例如0
 @int CS 片选脚,在w600不可用请填nil
 @int CPHA 默认0,可选0/1
@@ -199,7 +199,7 @@ static int l_spi_send(lua_State *L) {
 @return userdata spi_device
 @usage
 -- 初始化spi
-local spi_device = spi.device_setup(0,17,0,0,8,2000000,spi.MSB,1,1)
+local spi_device = spi.deviceSetup(0,17,0,0,8,2000000,spi.MSB,1,1)
 */
 static int l_spi_device_setup(lua_State *L) {
     luat_spi_device_t* spi_device = lua_newuserdata(L, sizeof(luat_spi_device_t));
@@ -390,7 +390,7 @@ static const rotable_Reg reg_spi[] =
     { "transfer",         l_spi_transfer,      0},
     { "recv",             l_spi_recv,          0},
     { "send",             l_spi_send,          0},
-    { "device_setup",     l_spi_device_setup,  0},
+    { "deviceSetup",      l_spi_device_setup,  0},
 
     { "MSB",               0,                  1},
     { "LSB",               0,                  2},