和光教程网

和光教程网

单片机的队列功能模块QueueForMcu

ladenna 0 35 次浏览 技术教程
基于单片机实现的队列功能模块，主要用于8位、16位、32位非运行RTOS的单片机应用，兼容大多数单片机平台。
开源代码：https://github.com/xiaoxinpro/QueueForMcu

一、特性

二、快速使用 

#include "queue.h"
#define Q_UART_BUFFER_SIZE  1024
QUEUE_HandleTypeDef qUartTx;QUEUE_DATA_T BufferUartTx[Q_UART_BUFFER_SIZE];
int main(void){  QUEUE_DATA_T temp;    //初始化队列  Queue_Init(&qUartTx, BufferUartTx, Q_UART_BUFFER_SIZE);    while(1)  {    //入队    Queue_Push(&qUartTx, 'Q');    Queue_Push(&qUartTx, 'u');    Queue_Push(&qUartTx, 'e');    Queue_Push(&qUartTx, 'u');    Queue_Push(&qUartTx, 'e');        //出队    Queue_Pop(&qUartTx, &temp);    Queue_Pop(&qUartTx, &temp);    Queue_Pop(&qUartTx, &temp);    Queue_Pop(&qUartTx, &temp);    Queue_Pop(&qUartTx, &temp);  }}

三、配置说明

目前QueueForMcu只有一个静态配置项，具体如下：
在文件 queue.h 中有一个宏定义 QUEUE_DATA_T 用于指定队列元素的数据长度，默认是 unsigned char ，可以根据需要更改为其他数据类型。

四、数据结构

队列的数据结构为 QUEUE_HandleTypeDef 用于保存队列的状态，源码如下： 

typedef struct QUEUE_HandleTypeDef{    unsigned int head;                      //队列头指针    unsigned int tail;                      //队列尾指针    unsigned int buffer_length;             //队列缓存长度（初始化时赋值）    QUEUE_DATA_T * buffer;                  //队列缓存数组（初始化时赋值）}QUEUE_HandleTypeDef;

其中 QUEUE_DATA_T 为配置项中自定义的数据类型。

五、创建队列

1、创建队列缓存

由于我们采用值传递的方式保存队列数据，因此我们在创建队列前要手动创建一个队列缓存区，用于存放队列数据。 

QUEUE_DATA_T BufferUartTx[1024];

以上代码即创建一个大小为 1024 的队列缓存区。

2、创建队列结构

接下来使用 QUEUE_HandleTypeDef 创建队列结构，用于保存队列的状态： 

QUEUE_HandleTypeDef qUartTx;

3、初始化队列

准备好队列缓存和队列结构后调用 Queue_Init 函数来创建队列，该函数原型如下： 

void Queue_Init(QUEUE_HandleTypeDef * hqueue, QUEUE_DATA_T * buffer, unsigned int len)
参数说明：

参考代码： 

Queue_Init(&qUartTx, BufferUartTx, Q_UART_BUFFER_SIZE);

六、压入队列

1、单数据压入

将数据压入队列尾部使用 Queue_Push 函数，该函数原型如下： 

QUEUE_StatusTypeDef Queue_Push(QUEUE_HandleTypeDef * hqueue, QUEUE_DATA_T data)
参数说明：
返回值说明：
该函数会返回一个 QUEUE_StatusTypeDef 枚举数据类型，返回值会根据队列状态返回以下几个值：

参考代码： 

Queue_Push(&qUartTx, 'Q');Queue_Push(&qUartTx, 0x51);Queue_Push(&qUartTx, 81);

2、多数据压入

若需要将多个数据（数组）压入队列可以使用 Queue_Push_Array 函数，原理上循环调用 Queue_Push 函数来实现的，函数原型如下： 

unsigned int Queue_Push_Array(QUEUE_HandleTypeDef * hqueue, QUEUE_DATA_T * pdatas, unsigned int len)

参数说明：

当数组长度大于队列剩余长度时，数组多余的数据将被忽略。
返回值说明：

七、弹出队列

1、单数据弹出

将队列头部数据弹出队列使用 Queue_Pop 函数，需要注意的是，弹出的数据将从队列中删除，该函数原型如下： 

QUEUE_StatusTypeDef Queue_Pop(QUEUE_HandleTypeDef * hqueue, QUEUE_DATA_T * pdata)
参数说明：
返回值说明：
该函数会返回一个 QUEUE_StatusTypeDef 枚举数据类型，返回值会根据队列状态返回以下几个值：

参考代码： 

QUEUE_DATA_T temp;if(QUEUE_OK = Queue_Pop(&qUartTx, &temp)){    // temp 为队列弹出的数据}else{    // 弹出数据失败}

2、多数据弹出

若需要将多个数据弹出队列可以使用 Queue_Pop_Array 函数，原理上循环调用 Queue_Pop 函数来实现的，需要注意的是，成功弹出的数据将从队列中删除，函数原型如下： 

unsigned int Queue_Pop_Array(QUEUE_HandleTypeDef * hqueue, QUEUE_DATA_T * pdatas, unsigned int len)
参数说明：
当需要弹出数据的长度大于队列中的数据长度时，弹出数组多余的空间将不会被赋值。
返回值说明：

3、单数据复制

当需要从队列头部获取数据，但又不希望数据从队列中删除时，可以使用 Queue_Peek 函数来实现，该函数的参数与返回值与 Queue_Pop 完全相同。
使用 Queue_Peek 和 Queue_Pop 函数的区别在于：

4、多数据复制

当需要从队列头部获取多个数据，但又不希望数据从队列中删除时，可以使用 Queue_Peek_Array 函数来实现，该函数的参数与返回值与 Queue_Pop_Array 完全相同。
使用 Queue_Peek_Array 和 Queue_Pop_Array 函数的区别在于：

八、其他功能

1、清空队列

当需要清空队列数据时，无需弹出所有数据，只需要调用 Queue_Clear 即可快速清空指定队列，在创建队列时会调用此函数来初始化队列，因此对于刚创建完成的队列无需调用清空队列函数。

函数原型： 

void Queue_Clear(QUEUE_HandleTypeDef * hqueue)
参数说明：

2、获取队列数据数量

当需要获取队列中的数据长度时，调用 Queue_Count 函数，函数原型如下： 

unsigned int Queue_Count(QUEUE_HandleTypeDef * hqueue)
参数说明：
返回值说明：

License

Copyright (c) 2020 QueueForMcu Released under the GPL-3.0 License.

原文链接：，转发请注明来源！
和光教程网 › 技术教程 › 单片机的队列功能模块QueueForMcu