本文介绍了使用ringbuffer接收数据的相关方法。
概述
ring buffer称作环形缓冲区,也称作环形队列(circular queue),是一种用于表示一个固定尺寸、头尾相连的缓冲区的数据结构,适合缓存数据流。
环形缓冲区的一些使用特点如下:
- 当一个数据元素被读取出后,其余数据元素不需要移动其存储位置;
- 适合于事先明确了缓冲区的最大容量的情形。缓冲区的容量(长度)一般固定,可以用一个静态数组来充当缓冲区,无需重复申请内存;
- 如果缓冲区的大小需要经常调整,就不适合用环形缓冲区,因为在扩展缓冲区大小时,需要搬移其中的数据,这种场合使用链表更加合适;
- 因为缓冲区成头尾相连的环形,写操作可能会覆盖未及时读取的数据,有的场景允许这种情况发生,有的场景又严格限制这种情况发生。选择何种策略和具体应用场景相关。
函数
1.ringbuffer函数
c代码如下:
#include "ringbuffer_u8.h"
void ringbuffer_u8_init(ringbuffer_u8_type *rb)
{
rb->write_index = 0;
rb->read_index = 0;
}
bool ringbuffer_u8_is_empty(ringbuffer_u8_type *rb)
{
if (rb->write_index == rb->read_index)
return true;
else
return false;
}
bool ringbuffer_u8_is_full(ringbuffer_u8_type *rb)
{
if ((rb->write_index - rb->read_index + ringbuffer_u8_length) % ringbuffer_u8_length == (ringbuffer_u8_length - 1)){
return true;
}else {
return false;
}
}
void ringbuffer_u8_push_back_byte(ringbuffer_u8_type *rb, uint8_t data)
{
if(ringbuffer_u8_is_full(rb))
{
rb->read_index++;
rb->read_index %= ringbuffer_u8_length;
}
rb->buffer[rb->write_index] = data;
rb->write_index++;
rb->write_index %= ringbuffer_u8_length;
}
uint8_t ringbuffer_u8_pop_front_byte(ringbuffer_u8_type *rb)
{
uint8_t res;
if(ringbuffer_u8_is_empty(rb))
{
return 0;
}
res = rb->buffer[rb->read_index];
rb->read_index++;
rb->read_index %= ringbuffer_u8_length;
return res;
}
uint8_t ringbuffer_u8_read_front_byte(ringbuffer_u8_type *rb, uint8_t counter) //预取地址不变化
{
uint8_t res;
if(ringbuffer_u8_is_empty(rb)){
return 0;
}
res = rb->buffer[rb->read_index+counter];
return res;
}
void ringbuffer_u8_clear_byte(ringbuffer_u8_type *rb, uint16_t data) //写地址回到读地址
{
rb->write_index = data;
}
uint16_t ringbuffer_u8_read_byte(ringbuffer_u8_type *rb) //写地址回到读地址
{
uint16_t index;
index = rb->write_index;
return index;
}
uint32_t ringbuffer_length(ringbuffer_u8_type *rb)
{
uint32_t res;
if(ringbuffer_u8_is_empty(rb)){
return 0;
}
res = (rb->write_index - rb->read_index + ringbuffer_u8_length) % ringbuffer_u8_length;
return res;
}
h头文件代码如下:
#ifndef SRC_BUFFER_RINGBUFFER_U8_H_
#define SRC_BUFFER_RINGBUFFER_U8_H_
#include <stdint.h>
#include <stdbool.h>
#include <string.h>
#define ringbuffer_u8_length (512)
typedef struct
{
uint8_t buffer[ringbuffer_u8_length];
uint16_t write_index;
uint16_t read_index;
}ringbuffer_u8_type;
typedef struct
{
uint32_t buffer[ringbuffer_u8_length];
uint16_t write_index;
uint16_t read_index;
}ringbuffer_u32_type;
extern void ringbuffer_u8_init(ringbuffer_u8_type *rb);
extern bool ringbuffer_u8_is_empty(ringbuffer_u8_type *rb);
extern bool ringbuffer_u8_is_full(ringbuffer_u8_type *rb);
extern void ringbuffer_u8_push_back_byte(ringbuffer_u8_type *rb, uint8_t data);
extern uint8_t ringbuffer_u8_pop_front_byte(ringbuffer_u8_type *rb);
extern uint32_t ringbuffer_length(ringbuffer_u8_type *rb);
extern void ringbuffer_u8_clear_byte(ringbuffer_u8_type *rb, uint16_t data);
extern uint16_t ringbuffer_u8_read_byte(ringbuffer_u8_type *rb);
extern uint8_t ringbuffer_u8_read_front_byte(ringbuffer_u8_type *rb, uint8_t counter);
#endif /* SRC_BUFFER_RINGBUFFER_U8_H_ */
最后须有一行空行。
2.main函数
使用cube生成原始代码,此时需要配置DMA,NVIC,USART1。
除了cube生成的函数外,需要额外添加的函数如下:
/* USER CODE BEGIN PFP */
void Command_Processing(uint8_t *frame_Array);
uint8_t rcv_tmp;
ringbuffer_u8_type uartRingBuffer;
void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart)
{
if(huart == &huart1)
ringbuffer_u8_push_back_byte(&uartRingBuffer, rcv_tmp);
}
/* USER CODE END PFP */
/* Private user code ---------------------------------------------------------*/
/* USER CODE BEGIN 0 */
void SystemClock_Config(void);
uint8_t uart_1_data[64];
uint8_t uart_1_tmp = -1;
uint8_t uart_1_pos = 0;
void UART_1_Process(void)
{
//从RxRingQ缓存区提取一个字符
while(ringbuffer_length(&uartRingBuffer) > 0 )
{
uart_1_tmp = ringbuffer_u8_pop_front_byte(&uartRingBuffer);
uart_1_data[uart_1_pos] = uart_1_tmp;
switch(uart_1_pos){
case 0x00 :
if(uart_1_tmp != 0x5A)
continue;
break;
case 0x01 :
if(uart_1_tmp != 0xA5)
{
uart_1_pos = 0;
continue;
}
break;
}
uart_1_pos++;
if(uart_1_pos > 3 && uart_1_pos == uart_1_data[2]+3) //2位帧头+1位帧长度
{
Command_Processing(uart_1_data);
uart_1_pos = 0;
return;
}
}
}
uint64_t data[1] = {0};
void Command_Processing(uint8_t *frame_Array)
{
if (frame_Array[2] == 0x08 && frame_Array[3] == 0x83 && frame_Array[4] == 0x20 && frame_Array[5] == 0x00 && frame_Array[6] == 0x02 )
{
data[0] = (((uint64_t)(frame_Array[7]) << 24)|((uint64_t)(frame_Array[8]) << 16)|((uint64_t)(frame_Array[9]) << 8)|((uint64_t)(frame_Array[10])));
}
}
/* USER CODE END 0 */
该处对一个帧头确定的数据进行处理。
整个main.c函数如下所示:
/* USER CODE BEGIN Header */
/**
******************************************************************************
* @file : main.c
* @brief : Main program body
******************************************************************************
* @attention
*
* Copyright (c) 2023 STMicroelectronics.
* All rights reserved.
*
* This software is licensed under terms that can be found in the LICENSE file
* in the root directory of this software component.
* If no LICENSE file comes with this software, it is provided AS-IS.
*
******************************************************************************
*/
/* USER CODE END Header */
/* Includes ------------------------------------------------------------------*/
#include "main.h"
#include "dma.h"
#include "usart.h"
#include "gpio.h"
/* Private includes ----------------------------------------------------------*/
/* USER CODE BEGIN Includes */
#include "core_printf.h"
#include "ringbuffer_u8.h"
/* USER CODE END Includes */
/* Private typedef -----------------------------------------------------------*/
/* USER CODE BEGIN PTD */
/* USER CODE END PTD */
/* Private define ------------------------------------------------------------*/
/* USER CODE BEGIN PD */
/* USER CODE END PD */
/* Private macro -------------------------------------------------------------*/
/* USER CODE BEGIN PM */
/* USER CODE END PM */
/* Private variables ---------------------------------------------------------*/
/* USER CODE BEGIN PV */
/* USER CODE END PV */
/* Private function prototypes -----------------------------------------------*/
void SystemClock_Config(void);
/* USER CODE BEGIN PFP */
void Command_Processing(uint8_t *frame_Array);
uint8_t rcv_tmp;
ringbuffer_u8_type uartRingBuffer;
void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart)
{
if(huart == &huart1)
ringbuffer_u8_push_back_byte(&uartRingBuffer, rcv_tmp);
}
/* USER CODE END PFP */
/* Private user code ---------------------------------------------------------*/
/* USER CODE BEGIN 0 */
void SystemClock_Config(void);
uint8_t uart_1_data[64];
uint8_t uart_1_tmp = -1;
uint8_t uart_1_pos = 0;
void UART_1_Process(void)
{
//从RxRingQ缓存区提取一个字符
while(ringbuffer_length(&uartRingBuffer) > 0 )
{
uart_1_tmp = ringbuffer_u8_pop_front_byte(&uartRingBuffer);
uart_1_data[uart_1_pos] = uart_1_tmp;
switch(uart_1_pos){
case 0x00 :
if(uart_1_tmp != 0x5A)
continue;
break;
case 0x01 :
if(uart_1_tmp != 0xA5)
{
uart_1_pos = 0;
continue;
}
break;
}
uart_1_pos++;
if(uart_1_pos > 3 && uart_1_pos == uart_1_data[2]+3) //2位帧头+1位帧长度
{
Command_Processing(uart_1_data);
uart_1_pos = 0;
return;
}
}
}
uint64_t data[1] = {0};
void Command_Processing(uint8_t *frame_Array)
{
if (frame_Array[2] == 0x08 && frame_Array[3] == 0x83 && frame_Array[4] == 0x20 && frame_Array[5] == 0x00 && frame_Array[6] == 0x02 )
{
data[0] = (((uint64_t)(frame_Array[7]) << 24)|((uint64_t)(frame_Array[8]) << 16)|((uint64_t)(frame_Array[9]) << 8)|((uint64_t)(frame_Array[10])));
}
}
/* USER CODE END 0 */
/**
* @brief The application entry point.
* @retval int
*/
int main(void)
{
/* USER CODE BEGIN 1 */
uint8_t dataoutput[11] = {0x5A, 0xA5, 0x08, 0x83, 0x20, 0x00, 0x02};
/* USER CODE END 1 */
/* MCU Configuration--------------------------------------------------------*/
/* Reset of all peripherals, Initializes the Flash interface and the Systick. */
HAL_Init();
/* USER CODE BEGIN Init */
/* USER CODE END Init */
/* Configure the system clock */
SystemClock_Config();
/* USER CODE BEGIN SysInit */
/* USER CODE END SysInit */
/* Initialize all configured peripherals */
MX_GPIO_Init();
MX_DMA_Init();
MX_USART1_UART_Init();
/* USER CODE BEGIN 2 */
HAL_Delay(100);
HAL_UART_Receive_DMA(&huart1, &rcv_tmp, 1);
// HAL_Delay(200);
// printf("HELLO\r\n");
// HAL_Delay(200);
/* USER CODE END 2 */
/* Infinite loop */
/* USER CODE BEGIN WHILE */
while (1)
{
/* USER CODE END WHILE */
/* USER CODE BEGIN 3 */
UART_1_Process();
dataoutput[7] = data[0] >> 24;
dataoutput[8] = data[0] >> 16;
dataoutput[9] = data[0] >> 8;
dataoutput[10] = data[0];
HAL_UART_Transmit(&huart1, dataoutput, 11, 1000);
HAL_Delay(1000);
}
/* USER CODE END 3 */
}
/**
* @brief System Clock Configuration
* @retval None
*/
void SystemClock_Config(void)
{
RCC_OscInitTypeDef RCC_OscInitStruct = {0};
RCC_ClkInitTypeDef RCC_ClkInitStruct = {0};
/** Initializes the RCC Oscillators according to the specified parameters
* in the RCC_OscInitTypeDef structure.
*/
RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_HSE;
RCC_OscInitStruct.HSEState = RCC_HSE_ON;
RCC_OscInitStruct.HSEPredivValue = RCC_HSE_PREDIV_DIV1;
RCC_OscInitStruct.HSIState = RCC_HSI_ON;
RCC_OscInitStruct.PLL.PLLState = RCC_PLL_ON;
RCC_OscInitStruct.PLL.PLLSource = RCC_PLLSOURCE_HSE;
RCC_OscInitStruct.PLL.PLLMUL = RCC_PLL_MUL9;
if (HAL_RCC_OscConfig(&RCC_OscInitStruct) != HAL_OK)
{
Error_Handler();
}
/** Initializes the CPU, AHB and APB buses clocks
*/
RCC_ClkInitStruct.ClockType = RCC_CLOCKTYPE_HCLK|RCC_CLOCKTYPE_SYSCLK
|RCC_CLOCKTYPE_PCLK1|RCC_CLOCKTYPE_PCLK2;
RCC_ClkInitStruct.SYSCLKSource = RCC_SYSCLKSOURCE_PLLCLK;
RCC_ClkInitStruct.AHBCLKDivider = RCC_SYSCLK_DIV1;
RCC_ClkInitStruct.APB1CLKDivider = RCC_HCLK_DIV2;
RCC_ClkInitStruct.APB2CLKDivider = RCC_HCLK_DIV1;
if (HAL_RCC_ClockConfig(&RCC_ClkInitStruct, FLASH_LATENCY_2) != HAL_OK)
{
Error_Handler();
}
}
/* USER CODE BEGIN 4 */
/* USER CODE END 4 */
/**
* @brief This function is executed in case of error occurrence.
* @retval None
*/
void Error_Handler(void)
{
/* USER CODE BEGIN Error_Handler_Debug */
/* User can add his own implementation to report the HAL error return state */
__disable_irq();
while (1)
{
}
/* USER CODE END Error_Handler_Debug */
}
#ifdef USE_FULL_ASSERT
/**
* @brief Reports the name of the source file and the source line number
* where the assert_param error has occurred.
* @param file: pointer to the source file name
* @param line: assert_param error line source number
* @retval None
*/
void assert_failed(uint8_t *file, uint32_t line)
{
/* USER CODE BEGIN 6 */
/* User can add his own implementation to report the file name and line number,
ex: printf("Wrong parameters value: file %s on line %d\r\n", file, line) */
/* USER CODE END 6 */
}
#endif /* USE_FULL_ASSERT */
该处实现了将发送的数据保存并回显的功能。