概述
本組件為SPI VFS驅動子系統。給應用或組件提供通過VFS形式(open/close/ioctl)訪問硬件SPI驅動對上層提供服務的接口。該組件初始化過程中,會根據hardware/chip/<chip_name>/package.yaml中定義的CONFIG_SPI_NUM來依此創建如下名稱的設備節點:
/dev/spi0
/dev/spi1
...
/dev/spi[CONFIG_SPI_NUM - 1]
組件支持以下功能:
設置主從模式
設置時序模式(CPOL/CPHA)
是否使能DMA
設置數據BIT寬度
CS片選
數據發送
數據接收
同時發送和接收
版權信息
Apache license v2.0
目錄結構
├── example
│ └── spi_example.c #SPI示例代碼
├── include
│ ├── aos
│ │ └── hal
│ │ └── spi.h #SPI HAL API申明
│ └── vfsdev
│ └── spi_dev.h #SPI設備API申明
├── package.yaml #編譯和配置文件
├── README.md #使用文檔
└── src
└── spi_dev.c #SPI設備實現代碼
依賴組件
base # 最底層核心驅動模型、驅動自動加載機制以及Device VFS core
vfs # VFS API抽象庫
常用配置
本組件可以通過CONFIG_SPI_NUM配置對上層提供設備節點的數量,CONFIG_SPI_NUM代表芯片內部的SPI控制器的數量。 CONFIG_SPI_NUM默認是在hardware/chip/<chip_name>/package.yaml中的def_config節點進行配置。 如果沒有定義CONFIG_SPI_NUM,則代碼中會定義默認對外輸出的設備節點數量。
設備節點數量:默認4個, 如需修改,在hardware/chip/<chip_name>/package.yaml中修改CONFIG_SPI_NUM配置
def_config:
CONFIG_SPI_NUM: 1
API說明
spi_device_api
使用示例
組件使用示例相關的代碼下載、編譯和固件燒錄均依賴AliOS Things配套的開發工具,所以首先需要參考《AliOS Things集成開發環境使用說明之搭建開發環境》,下載安裝。 待開發環境搭建完成后,可以按照以下步驟進行示例的測試。
步驟1 創建或打開工程
打開已有工程
如果用于測試的案例工程已存在,可參考《AliOS Things集成開發環境使用說明之打開工程》打開已有工程。
創建新的工程
組件的示例代碼可以通過編譯鏈接到AliOS Things的任意案例(solution)來運行,這里選擇helloworld_demo案例。helloworld_demo案例相關的源代碼下載可參考《AliOS Things集成開發環境使用說明之創建工程》。
步驟2 添加組件
案例下載完成后,需要在helloworld_demo組件的package.yaml中添加對組件的依賴:
depends:
- spi: master # helloworld_demo中引入spi組件
步驟3 下載組件
在已安裝了的開發環境工具欄中,選擇Terminal -> New Terminal啟動終端,并且默認工作路徑為當前工程的workspace,此時在終端命令行中輸入:
aos install spi
上述命令執行成功后,組件源碼則被下載到了./components/drivers/peripheral/spi路徑中。
步驟4 添加示例
spi組件的package.yaml中添加example
source_file:
原有其他文件
- example/spi_example.c # add spi_example.c
步驟5 編譯固件
在示例代碼已經添加至組件的配置文件,并且helloworld_demo已添加了對該組件的依賴后,就可以編譯helloworld_demo案例來生成固件了,具體編譯方法可參考《AliOS Things集成開發環境使用說明之編譯固件》。
步驟6 燒錄固件
helloworld_demo案例的固件生成后,可參考《AliOS Things集成開發環境使用說明之燒錄固件》來燒錄固件。
步驟7 打開串口
固件燒錄完成后,可以通過串口查看示例的運行結果,打開串口的具體方法可參考《AliOS Things集成開發環境使用說明之查看日志》。
當串口終端打開成功后,可在串口中輸入help來查看已添加的測試命令。
步驟8 測試示例
CLI命令行輸入:
spi_example id
其中ID為0-CONFIG_TIMER_NUM之間的數值。
可使用示波器確認通過SPI總線發送的數據是否是spi_example中發送的數據一致來最終確認SPI是否工作正常。
關鍵日志
CLI日志:
vfs spi test success, ret:0
注意事項
無
FAQ
無