mirror of
https://gitee.com/dlmu-cone/bf_original_balance_chassis
synced 2026-07-24 11:37:45 +08:00
增加了大量注释
This commit is contained in:
@@ -10,9 +10,10 @@
|
||||
*/
|
||||
static void CANCommResetRx(CANCommInstance *ins)
|
||||
{
|
||||
// 当前已经收到的buffer清零
|
||||
memset(ins->raw_recvbuf, 0, ins->cur_recv_len);
|
||||
ins->recv_state = 0;
|
||||
ins->cur_recv_len = 0;
|
||||
ins->recv_state = 0; // 接收状态重置
|
||||
ins->cur_recv_len = 0; // 当前已经收到的长度重置
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -23,33 +24,36 @@ static void CANCommResetRx(CANCommInstance *ins)
|
||||
static void CANCommRxCallback(CANInstance *_instance)
|
||||
{
|
||||
static CANCommInstance *comm;
|
||||
comm = (CANCommInstance *)_instance->id;
|
||||
comm = (CANCommInstance *)_instance->id; // 注意写法,将can instance的id强制转换为CANCommInstance*类型
|
||||
|
||||
/* 接收状态判断 */
|
||||
if (_instance->rx_buff[0] == CAN_COMM_HEADER && comm->recv_state == 0) // 尚未开始接收且新的一包里有帧头
|
||||
if (_instance->rx_buff[0] == CAN_COMM_HEADER && comm->recv_state == 0) // 之前尚未开始接收且此次包里第一个位置是帧头
|
||||
{
|
||||
if (_instance->rx_buff[1] == comm->recv_data_len) // 接收长度等于设定接收长度
|
||||
if (_instance->rx_buff[1] == comm->recv_data_len) // 如果这一包里的datalen也等于我们设定接收长度(这是因为暂时不支持动态包长)
|
||||
{
|
||||
comm->recv_state = 1;
|
||||
comm->recv_state = 1; // 设置接收状态为1,说明已经开始接收
|
||||
}
|
||||
else
|
||||
return; // 直接跳过即可
|
||||
}
|
||||
|
||||
if (comm->recv_state) // 已经收到过帧头
|
||||
{ // 如果已经接收到的长度加上当前一包的长度大于总buf len,说明接收错误
|
||||
{
|
||||
// 如果已经接收到的长度加上当前一包的长度大于总buf len,说明接收错误
|
||||
if (comm->cur_recv_len + _instance->rx_len > comm->recv_buf_len)
|
||||
{
|
||||
CANCommResetRx(comm);
|
||||
return; // 重置状态然后返回
|
||||
}
|
||||
|
||||
// 直接拷贝到当前的接收buffer后面
|
||||
// 直接把当前接收到的数据接到buffer后面
|
||||
memcpy(comm->raw_recvbuf + comm->cur_recv_len, _instance->rx_buff, _instance->rx_len);
|
||||
comm->cur_recv_len += _instance->rx_len;
|
||||
|
||||
// 当前已经收满
|
||||
// 收完这一包以后刚好等于总buf len,说明已经收完了
|
||||
if (comm->cur_recv_len == comm->recv_buf_len)
|
||||
{ // buff里本该是tail的位置不等于CAN_COMM_TAIL
|
||||
{
|
||||
// 如果buff里本该是tail的位置不等于CAN_COMM_TAIL
|
||||
if (comm->raw_recvbuf[comm->recv_buf_len - 1] != CAN_COMM_TAIL)
|
||||
{
|
||||
CANCommResetRx(comm);
|
||||
@@ -59,8 +63,8 @@ static void CANCommRxCallback(CANInstance *_instance)
|
||||
{
|
||||
if (comm->raw_recvbuf[comm->recv_buf_len - 2] ==
|
||||
crc_8(comm->raw_recvbuf + 2, comm->recv_data_len))
|
||||
{ // 通过校验,复制数据到unpack_data中
|
||||
memcpy(comm->unpacked_recv_data, comm->raw_recvbuf + 2, comm->recv_data_len);
|
||||
{ // 通过校验,复制数据到unpack_data中
|
||||
memcpy(comm->unpacked_recv_data, comm->raw_recvbuf + 2, comm->recv_data_len); // 数据量大的话考虑使用DMA
|
||||
comm->update_flag = 1; // 数据更新flag置为1
|
||||
}
|
||||
CANCommResetRx(comm);
|
||||
@@ -73,17 +77,18 @@ static void CANCommRxCallback(CANInstance *_instance)
|
||||
|
||||
CANCommInstance *CANCommInit(CANComm_Init_Config_s *comm_config)
|
||||
{
|
||||
CANCommInstance* ins = (CANCommInstance *)malloc(sizeof(CANCommInstance));
|
||||
CANCommInstance *ins = (CANCommInstance *)malloc(sizeof(CANCommInstance));
|
||||
memset(ins, 0, sizeof(CANCommInstance));
|
||||
|
||||
ins->recv_data_len = comm_config->recv_data_len;
|
||||
ins->recv_buf_len = comm_config->recv_data_len + CAN_COMM_OFFSET_BYTES;
|
||||
ins->recv_buf_len = comm_config->recv_data_len + CAN_COMM_OFFSET_BYTES; // head + datalen + crc8 + tail
|
||||
ins->send_data_len = comm_config->send_data_len;
|
||||
ins->send_buf_len = comm_config->send_data_len + CAN_COMM_OFFSET_BYTES;
|
||||
ins->raw_sendbuf[0] = CAN_COMM_HEADER;
|
||||
ins->raw_sendbuf[1] = comm_config->send_data_len;
|
||||
ins->raw_sendbuf[0] = CAN_COMM_HEADER; // head,直接设置避免每次发送都要重新赋值,下面的tail同理
|
||||
ins->raw_sendbuf[1] = comm_config->send_data_len; // datalen
|
||||
ins->raw_sendbuf[comm_config->send_data_len + CAN_COMM_OFFSET_BYTES - 1] = CAN_COMM_TAIL;
|
||||
|
||||
comm_config->can_config.id = ins;
|
||||
// can instance的设置
|
||||
comm_config->can_config.id = ins; // CANComm的实例指针作为CANInstance的id,回调函数中会用到
|
||||
comm_config->can_config.can_module_callback = CANCommRxCallback;
|
||||
ins->can_ins = CANRegister(&comm_config->can_config);
|
||||
return ins;
|
||||
@@ -93,10 +98,12 @@ void CANCommSend(CANCommInstance *instance, uint8_t *data)
|
||||
{
|
||||
static uint8_t crc8;
|
||||
static uint8_t send_len;
|
||||
// 将data copy到raw_sendbuf中,计算crc8
|
||||
memcpy(instance->raw_sendbuf + 2, data, instance->send_data_len);
|
||||
crc8 = crc_8(data, instance->send_data_len);
|
||||
instance->raw_sendbuf[2 + instance->send_data_len] = crc8;
|
||||
|
||||
// CAN单次发送最大为8字节,如果超过8字节,需要分包发送
|
||||
for (size_t i = 0; i < instance->send_buf_len; i += 8)
|
||||
{ // 如果是最后一包,send len将会小于8,要修改CAN的txconf中的DLC位,调用bsp_can提供的接口即可
|
||||
send_len = instance->send_buf_len - i >= 8 ? 8 : instance->send_buf_len - i;
|
||||
@@ -108,6 +115,6 @@ void CANCommSend(CANCommInstance *instance, uint8_t *data)
|
||||
|
||||
void *CANCommGet(CANCommInstance *instance)
|
||||
{
|
||||
instance->update_flag = 0;
|
||||
instance->update_flag = 0; // 读取后将更新flag置为0
|
||||
return instance->unpacked_recv_data;
|
||||
}
|
||||
@@ -16,9 +16,9 @@
|
||||
#define MX_CAN_COMM_COUNT 4 // 注意均衡负载,一条总线上不要挂载过多的外设
|
||||
|
||||
#define CAN_COMM_MAX_BUFFSIZE 60 // 最大发送/接收字节数,如果不够可以增加此数值
|
||||
#define CAN_COMM_HEADER 's'
|
||||
#define CAN_COMM_TAIL 'e'
|
||||
#define CAN_COMM_OFFSET_BYTES 4 // 's'+datalen+'e'+crc8
|
||||
#define CAN_COMM_HEADER 's' // 帧头
|
||||
#define CAN_COMM_TAIL 'e' // 帧尾
|
||||
#define CAN_COMM_OFFSET_BYTES 4 // 's'+ datalen + 'e' + crc8
|
||||
|
||||
#pragma pack(1)
|
||||
/* CAN comm 结构体, 拥有CAN comm的app应该包含一个CAN comm指针 */
|
||||
@@ -35,42 +35,44 @@ typedef struct
|
||||
uint8_t raw_recvbuf[CAN_COMM_MAX_BUFFSIZE + CAN_COMM_OFFSET_BYTES]; // 额外4个bytes保存帧头帧尾和校验和
|
||||
uint8_t unpacked_recv_data[CAN_COMM_MAX_BUFFSIZE]; // 解包后的数据,调用CANCommGet()后cast成对应的类型通过指针读取即可
|
||||
/* 接收和更新标志位*/
|
||||
uint8_t recv_state; // 接收状态,
|
||||
uint8_t cur_recv_len;
|
||||
uint8_t update_flag;
|
||||
uint8_t recv_state; // 接收状态,
|
||||
uint8_t cur_recv_len; // 当前已经接收到的数据长度(包括帧头帧尾datalen和校验和)
|
||||
uint8_t update_flag; // 数据更新标志位,当接收到新数据时,会将此标志位置1,调用CANCommGet()后会将此标志位置0
|
||||
} CANCommInstance;
|
||||
#pragma pack()
|
||||
|
||||
/* CAN comm 初始化结构体 */
|
||||
typedef struct
|
||||
{
|
||||
CAN_Init_Config_s can_config;
|
||||
uint8_t send_data_len;
|
||||
uint8_t recv_data_len;
|
||||
CAN_Init_Config_s can_config; // CAN初始化结构体
|
||||
uint8_t send_data_len; // 发送数据长度
|
||||
uint8_t recv_data_len; // 接收数据长度
|
||||
} CANComm_Init_Config_s;
|
||||
|
||||
/**
|
||||
* @brief
|
||||
* @brief 初始化CANComm
|
||||
*
|
||||
* @param config
|
||||
* @param config CANComm初始化结构体
|
||||
* @return CANCommInstance*
|
||||
*/
|
||||
CANCommInstance *CANCommInit(CANComm_Init_Config_s *comm_config);
|
||||
|
||||
/**
|
||||
* @brief 发送数据
|
||||
* @brief 通过CANComm发送数据
|
||||
*
|
||||
* @param instance can comm实例
|
||||
* @param instance cancomm实例
|
||||
* @param data 注意此地址的有效数据长度需要和初始化时传入的datalen相同
|
||||
*/
|
||||
void CANCommSend(CANCommInstance *instance, uint8_t *data);
|
||||
|
||||
/**
|
||||
* @brief 获取CAN COMM接收的数据,需要自己使用强制类型转换将返回的void指针转换成指定类型
|
||||
* @brief 获取CANComm接收的数据,需要自己使用强制类型转换将返回的void指针转换成指定类型
|
||||
*
|
||||
* @return void* 返回的数据指针
|
||||
* @attention 注意如果希望直接通过转换指针访问数据,如果数据是union或struct,要检查是否使用了pack(n)
|
||||
* CAN COMM接收到的数据可以看作是pack(1)之后的,是连续存放的
|
||||
* CANComm接收到的数据可以看作是pack(1)之后的,是连续存放的.
|
||||
* 如果使用了pack(n)可能会导致数据错乱,并且无法使用强制类型转换直接访问,而需要手动解包.
|
||||
* 强烈建议通过CANComm传输的数据使用pack(1)
|
||||
*/
|
||||
void *CANCommGet(CANCommInstance *instance);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user