C 实现任意长度的简单FIFO (先入先出队列)

一 , 什么是FIFO

First in First out ， 先进入的数据先出去，是一种数据管理队列，一般用于异步消息传递，进程间通信，信息传输缓冲等场合。
对于一个FIFO，其重要的信息包含深度与宽度两个信息。深度为其最多可容纳的信息数量（并不是所占内存空间大小）。宽度则为信息的大小，例如1个字节，4个字节等。

二 , 设计目标

一个简单易用的FIFO在嵌入式开发过程特别是裸机开发过程中的某些工作流程中，能够简化代码，提高效率。
FIFO的宽度一般由实际应用场合决定，虽然可以设计为针对嵌入式环境的32位CPU或者16位CPU或者8位CPU，但是宽度为1Byte的FIFO适用环境更广，在面对处理字符流，SPI数据流，IIC数据流，USART数据流等场合更加适合。当然，本文的代码想要改成别的宽度也是很容易的，就看各位看官的理解了。
同时，作者还希望它能够以很少的改动甚至无需改动，就能够同时适应裸机环境和具有内存管理的操作系统环境。

三 , 设计内容

FIFO在工作时，使用一个Buffer来保存数据，依靠两个指针来会将写入数据保存到写入指针的位置，同时将写入指针移动。读取数据时会将读取指针所指位置送出，同时将读取指针移动。

1.控制块

这个小模块我们使用一个结构体来管理整个队列

typedef struct
{
   
	u16 Head;
	u16 Tail;
	u16 isFull;
	u16 Deepth;
}JA_FIFO_TYPE_DEF;

整个结构体所占据的内存为8Byte，由于u16数据类型的特性，决定了队列最多可管理65535数量的元素，这个容量在很多时候都足够了。Head是指向待插入位置也就是队列头。Tail指向队列中最后一个元素位置。isFull则是一个队列满的标志，方便区分当下队列是满还是空。Deepth是队列的深度，即能够保存数据的最大数量。

2.队列创建

先贴代码

u32 Ja_fifo_creat(u32 *FifoID ,void *Container , u16 Deepth)
{
   
	JA_FIFO_TYPE_DEF *NewFifo;
	if(Container == NULL)
	{
   
		return ERROR;
	}
	if(Deepth == 0)
	{
   
		return ERROR;
	}
	NewFifo = Container;
	NewFifo->Deepth = Deepth;
	NewFifo->Head = NewFifo->Tail = 0;
	NewFifo->isFull = 0;
	*FifoID = (u32)NewFifo;
	return JA_OK;
}

队列创建函数包括三个输入参数，其中*FifoID为函数通过此参数输出创建的队列的编号，之后的写入读取操作都通过创建时得到的ID来操作。*FifoID的值其实就是该队列控制块的地址，得到了编号也就得到了队列控制块。
*Container 是提前准备好的的一段连续空间，用于保存该队列的控制块以及元素。该空间可以是一段预先声明的数组，也可以是通过系统申请的内存，其大小由一个宏定义确定：

//Fifo used size (byte)
# define JA_FIFO_SIZE(length) \
    (length + sizeof(JA_FIFO_TYPE_DEF))

只需要使用这个宏，就可以创建一个能够满足使用要求的空间，而并不需要了解这个空间里有什么东西。可以通过此宏提前声明数组，也可以随时申请内存。
队列中的控制数据初始化完成后，通过FifoID指针返回队列控制头所在地址，之后可以通过这个数据来操作整个队列。

3.写入一个元素

作为一个保存消息的队列，当然最重要的功能是读写啦

u32 Ja_fifo_write(u32 FifoID , u8 Dat)
{
   
 	JA_FIFO_TYPE_DEF *Fifo;
 	u8 *BaseBuffer;
 	Fifo = (JA_FIFO_TYPE_DEF*)FifoID;
 	BaseBuffer = (u8*)Fifo + sizeof(JA_FIFO_TYPE_DEF);
 	*(BaseBuffer + Fifo->Head) = Dat;
	Fifo->Head = ( Fifo->Head + 1 ) % Fifo->Deepth;
	if( Fifo->isFull )
		Fifo->Tail = Fifo->Head;
	else if( Fifo->Head == Fifo->Tail)
		Fifo->isFull = 1;
 	return JA_OK;
}

该函数的传入参数有两个，FifoID，Dat。FifoID即为创建队列时通过指针返回的变量。而Dat则是待写入的数据。
通过此函数也可以发现，我们的FIFO是覆盖型的，即在队列已满的情况下，继续向队列中写入，会在Head所指位置直接写入新的数据，最早写入的数据将被覆盖，而队列中元素个数并不会变化。

4.读取一个元素

我们已经完成了数据写入，那读取操作也就顺理成章了

u32 Ja_fifo_read(u32 FifoID, u8 *Dat)
{
   
 	JA_FIFO_TYPE_DEF *Fifo;
 	u8 *BaseBuffer;

 	Fifo = (JA_FIFO_TYPE_DEF*)FifoID;
	if( Fifo->Head == Fifo->Tail && Fifo->isFull==0)
		return JA_ERROR;
 	BaseBuffer = (u8*)Fifo + sizeof(JA_FIFO_TYPE_DEF);
	*Data = *((u8*)BaseBuffer + Fifo->Tail);
	Fifo->Tail = ( Fifo->Tail + 1