[rtthread设备]系列文章
【rtthread设备】第零篇：IO设备
【rtthread设备】第一篇：pin设备
【rtthread设备】第二篇：rtc设备
【rtthread设备】第三篇：adc设备
【rtthread设备】第五篇：hwtimer设备
【rtthread设备】第六篇：i2c设备
【rtthread设备】第七篇：spi设备
【rtthread设备】第八篇：看门狗设备
文章目录
一、spi设备概念
rtthread将spi设备抽象成rt_spi_device。
1.1 spi配置结构体
struct rt_spi_configuration
{
rt_uint8_t mode; /* 模 式 */
rt_uint8_t data_width; /* 数 据 宽 度， 可 取8位、 16位、 32位 */
rt_uint16_t reserved; /* 保 留 */
rt_uint32_t max_hz; /* 最 大 频 率 */
};
mode可取
#define RT_SPI_LSB (0<<2) /* bit[2]: 0-LSB */
#define RT_SPI_MSB (1<<2) /* bit[2]: 1-MSB */
/* 设 置SPI的 主 从 模 式 */
#define RT_SPI_MASTER (0<<3) /* SPI master device */
#define RT_SPI_SLAVE (1<<3) /* SPI slave device */
/* 设 置 时 钟 极 性 和 时 钟 相 位 */
#define RT_SPI_MODE_0 (0 | 0) /* CPOL = 0, CPHA = 0 */
#define RT_SPI_MODE_1 (0 | RT_SPI_CPHA) /* CPOL = 0, CPHA = 1 */
#define RT_SPI_MODE_2 (RT_SPI_CPOL | 0) /* CPOL = 1, CPHA = 0 */
#define RT_SPI_MODE_3 (RT_SPI_CPOL | RT_SPI_CPHA) /* CPOL = 1, CPHA = 1 */
#define RT_SPI_CS_HIGH (1<<4) /* Chipselect active high */
#define RT_SPI_NO_CS (1<<5) /* No chipselect */
#define RT_SPI_3WIRE (1<<6) /* SI/SO pin shared */
#define RT_SPI_READY (1<<7) /* Slave pulls low to pause */
1.2 spi消息结构体
struct rt_spi_message
{
const void *send_buf; /* 发 送 缓 冲 区 指 针 */
void *recv_buf; /* 接 收 缓 冲 区 指 针 */
rt_size_t length; /* 发 送 / 接 收 数 据 字 节 数 */
struct rt_spi_message *next; /* 指 向 继 续 发 送 的 下 一 条 消 息 的 指 针 */
unsigned cs_take : 1; /* 片 选 选 中 */
unsigned cs_release : 1; /* 释 放 片 选 */
}
1.3 qpsi配置结构体
struct rt_qspi_configuration
{
struct rt_spi_configuration parent; /* 继 承 自 SPI 设 备 配 置 参 数 */
rt_uint32_t medium_size; /* 介 质 大 小 */
rt_uint8_t ddr_mode; /* 双 倍 速 率 模 式 */
rt_uint8_t qspi_dl_width ; /* QSPI 总 线 位 宽， 单 线 模 式 1 位、 双 线 模 式
2 位， 4 线 模 式 4 位 */
};
1.4 qspi消息结构体
struct rt_qspi_message
{
struct rt_spi_message parent; /* 继 承 自struct rt_spi_message */
struct
{
rt_uint8_t content; /* 指 令 内 容 */
rt_uint8_t qspi_lines; /* 指 令 模 式， 单 线 模 式 1 位、 双 线 模 式 2 位， 4 线
模 式 4 位 */
} instruction; /* 指 令 阶 段 */
struct
{
rt_uint32_t content; /* 地 址/交 替 字 节 内 容 */
rt_uint8_t size; /* 地 址/交 替 字 节 长 度 */
rt_uint8_t qspi_lines; /* 地 址/交 替 字 节 模 式， 单 线 模 式 1 位、 双 线 模 式 2
位， 4 线 模 式 4 位 */
} address, alternate_bytes; /* 地 址/交 替 字 节 阶 段 */
rt_uint32_t dummy_cycles; /* 空 指 令 周 期 阶 段 */
rt_uint8_t qspi_data_lines; /* QSPI 总 线 位 宽 */
};
二、spi设备api
2.1 spi设备api
//spi总线挂载设备
/*
device：spi设备句柄
name：spi设备名称
bus_name：spi总线名称
user_data：用户数据指针，一般为cs引脚指针
*/
rt_err_t rt_spi_bus_attach_device(struct rt_spi_device *device,
const char *name,
const char *bus_name,
void *user_data)
//硬件spi设备挂载
/*
bus_name：spi总线名称
device_name：spi设备名称
cs_gpiox：cs引脚端口
cs_gpio_pin：cs引脚
*/
rt_err_t rt_hw_spi_device_attach(const char *bus_name,
const char *device_name,
GPIO_TypeDef* cs_gpiox,
uint16_t cs_gpio_pin);
//配置spi
/*
device：spi设备句柄
cfg：spi配置结构体指针
*/
rt_err_t rt_spi_configure(struct rt_spi_device *device,
struct rt_spi_configuration *cfg)
//配置qspi设备
/*
qspi设备句柄
cfg：qspi配置
*/
rt_err_t rt_qspi_configure(struct rt_qspi_device *device, struct rt_qspi_configuration *cfg);
//查找设备
/*
spi设备名称
*/
rt_device_t rt_device_find(const char* name);
//传输自定义数据
/*
device：spi设备句柄
message：spi消息结构体指针
*/
struct rt_spi_message *rt_spi_transfer_message(
struct rt_spi_device *device,
struct rt_spi_message *message)；
//传输一次数据
/*
device：spi设备句柄
send_buf：发送缓冲区
recv_buf：接收缓冲区
lenth：传输的数据大小
*/
rt_size_t rt_spi_transfer(struct rt_spi_device *device,
const void *send_buf,
void *recv_buf,
rt_size_t length);
//发送一次数据
/*
device：spi设备句柄
send_buf：发送数据缓冲区指针
length：发送数据大小
*/
rt_size_t rt_spi_send(struct rt_spi_device *device,
const void *send_buf,
rt_size_t length)
//接收一次数据
/*
device：spi设备句柄
recv_buf：接收数据缓冲区指针
length：接收数据大小
*/
rt_size_t rt_spi_recv(struct rt_spi_device *device,
void *recv_buf,
rt_size_t length);
//连续发送两次数据
/*
device：spi设备句柄
send_buf1：第一个数据发送缓冲区指针
send_length1：第一个数据大小
send_buf2：第二个数据发送缓冲区指针
send_length2：第二个数据大小
*/
rt_err_t rt_spi_send_then_send(struct rt_spi_device *device,
const void *send_buf1,
rt_size_t send_length1,
const void *send_buf2,
rt_size_t send_length2);
//先发送后接收
/*
device：spi设备句柄
send_buf：发送数据缓冲区指针
send_length：发送数据大小
recv_buf：接收数据缓冲区指针
recv_length：接收数据大小
*/
rt_err_t rt_spi_send_then_recv(struct rt_spi_device *device,
const void *send_buf,
rt_size_t send_length,
void *recv_buf,
rt_size_t recv_length);
2.2 qspi设备api
//qpsi传输消息
/*
device：qpsi设备句柄
message：传输的消息结构体指针
*/
t_size_t rt_qspi_transfer_message(struct rt_qspi_device *device, struct rt_qspi_message *message);
//发送再接收
/*
device：qspi设备句柄
send_buf：发送数据缓冲区指针
send_length：发送数据大小
recv_buf：接收数据缓冲区指针
recv_length：接收数据大小
*/
rt_err_t rt_qspi_send_then_recv(struct rt_qspi_device *device,
const void *send_buf,
rt_size_t send_length,
void *recv_buf,
rt_size_t recv_length);
//发送数据
/*
device：qspi设备句柄
send_buf：发送数据缓冲区指针
length：发送数据大小
*/
rt_err_t rt_qspi_send(struct rt_qspi_device *device,
const void *send_buf,
rt_size_t length)
三、spi设备示例
/*
* Copyright (c) 2006-2018, RT-Thread Development Team
*
* SPDX-License-Identifier: Apache-2.0
*
* Change Logs:
* Date Author Notes
* 2018-08-15 misonyo first implementation.
*/
/*
* 程序清单：这是一个 SPI 设备使用例程
* 例程导出了 spi_w25q_sample 命令到控制终端
* 命令调用格式：spi_w25q_sample spi10
* 命令解释：命令第二个参数是要使用的SPI设备名称，为空则使用默认的SPI设备
* 程序功能：通过SPI设备读取 w25q 的 ID 数据
*/
#include <rtthread.h>
#include <rtdevice.h>
#define W25Q_SPI_DEVICE_NAME "qspi10"
static void spi_w25q_sample(int argc, char *argv[])
{
struct rt_spi_device *spi_dev_w25q;
char name[RT_NAME_MAX];
rt_uint8_t w25x_read_id = 0x90;
rt_uint8_t id[5] = {
0};
if (argc == 2)
{
rt_strncpy(name, argv[1], RT_NAME_MAX);
}
else
{
rt_strncpy(name, W25Q_SPI_DEVICE_NAME, RT_NAME_MAX);
}
/* 查找 spi 设备获取设备句柄 */
spi_dev_w25q = (struct rt_spi_device *)rt_device_find(name);
if (!spi_dev_w25q)
{
rt_kprintf("spi sample run failed! can't find %s device!\n", name);
}
else
{
/* 方式1：使用 rt_spi_send_then_recv()发送命令读取ID */
rt_spi_send_then_recv(spi_dev_w25q, &w25x_read_id, 1, id, 5);
rt_kprintf("use rt_spi_send_then_recv() read w25q ID is:%x%x\n", id[3], id[4]);
/* 方式2：使用 rt_spi_transfer_message()发送命令读取ID */
struct rt_spi_message msg1, msg2;
msg1.send_buf = &w25x_read_id;
msg1.recv_buf = RT_NULL;
msg1.length = 1;
msg1.cs_take = 1;
msg1.cs_release = 0;
msg1.next = &msg2;
msg2.send_buf = RT_NULL;
msg2.recv_buf = id;
msg2.length = 5;
msg2.cs_take = 0;
msg2.cs_release = 1;
msg2.next = RT_NULL;
rt_spi_transfer_message(spi_dev_w25q, &msg1);
rt_kprintf("use rt_spi_transfer_message() read w25q ID is:%x%x\n", id[3], id[4]);
}
}
/* 导出到 msh 命令列表中 */
MSH_CMD_EXPORT(spi_w25q_sample, spi w25q sample);