1 #pragma once
2
3 #include <DragonOS/stdint.h>
4 #include <common/spinlock.h>
5
6 struct kfifo_t
7 {
8 uint32_t total_size; // 缓冲区总空间
9 uint32_t size; // 元素所占的字节数
10 uint32_t in_offset; // 入口偏移
11 uint32_t out_offset; // 出口偏移
12 void *buffer; // 缓冲区
13 } __attribute__((aligned(sizeof(long))));
14
15 /**
16 * @brief 忽略kfifo队列中的所有内容，并把输入和输出偏移量都归零
17 *
18 */
19 #define kfifo_reset(fifo) (void)({ \
20 (fifo)->size = 0; \
21 (fifo)->in_offset = 0; \
22 (fifo)->out_offset = 0; \
23 })
24
25 /**
26 * @brief 忽略kfifo队列中的所有内容，并将输入偏移量赋值给输出偏移量
27 *
28 */
29 #define kfifo_reset_out(fifo) (void)({ \
30 (fifo)->size = 0; \
31 (fifo)->out_offset = (fifo)->in_offset; \
32 })
33
34 /**
35 * @brief 获取kfifo缓冲区的最大大小
36 *
37 * @param fifo 队列结构体
38 * @return uint32_t 缓冲区最大大小
39 */
40 #define kfifo_total_size(fifo) ((fifo)->total_size)
41 /**
42 * @brief 获取kfifo缓冲区当前已使用的大小
43 *
44 * @param fifo 队列结构体
45 * @return uint32_t 缓冲区当前已使用的大小
46 */
47 #define kfifo_size(fifo) ((fifo)->size)
48
49 /**
50 * @brief 判断kfifo缓冲区当前是否为空
51 *
52 * @param fifo 队列结构体
53 * @return uint32_t 0->非空， 1->空
54 */
55 #define kfifo_empty(fifo) (((fifo)->size == 0) ? 1 : 0)
56
57 /**
58 * @brief 判断kfifo缓冲区当前是否为满
59 *
60 * @param fifo 队列结构体
61 * @return uint32_t 0->不满， 1->满
62 */
63 #define kfifo_full(fifo) (((fifo)->size == (fifo)->total_size) ? 1 : 0)
64
65 /**
66 * @brief 通过动态方式初始化kfifo缓冲队列
67 *
68 * @param fifo 队列结构体
69 * @param size 缓冲区大小
70 * @param reserved 暂时保留，请置为0
71 * @return int 错误码：成功->0
72 */
73 int kfifo_alloc(struct kfifo_t *fifo, uint32_t size, uint64_t reserved);
74
75 /**
76 * @brief 释放通过kfifo_alloc创建的fifo缓冲区
77 *
78 * @param fifo fifo队列结构体
79 */
80 void kfifo_free_alloc(struct kfifo_t *fifo);
81
82 /**
83 * @brief 使用指定的缓冲区来初始化kfifo缓冲队列
84 *
85 * @param fifo 队列结构体
86 * @param buffer 缓冲区
87 * @param size 缓冲区大小
88 */
89 void kfifo_init(struct kfifo_t *fifo, void *buffer, uint32_t size);
90
91 /**
92 * @brief 向kfifo缓冲区推入指定大小的数据
93 *
94 * @param fifo 队列结构体
95 * @param from 来源数据地址
96 * @param size 数据大小（字节数）
97 * @return uint32_t 推入的数据大小
98 */
99 uint32_t kfifo_in(struct kfifo_t *fifo, const void *from, uint32_t size);
100
101 /**
102 * @brief 从kfifo缓冲区取出数据，并从队列中删除数据
103 *
104 * @param fifo 队列结构体
105 * @param to 拷贝目标地址
106 * @param size 数据大小（字节数）
107 * @return uint32_t 取出的数据大小
108 */
109 uint32_t kfifo_out(struct kfifo_t *fifo, void *to, uint32_t size);
110
111 /**
112 * @brief 从kfifo缓冲区取出数据，但是不从队列中删除数据
113 *
114 * @param fifo 队列结构体
115 * @param to 拷贝目标地址
116 * @param size 数据大小（字节数）
117 * @return uint32_t 取出的数据大小
118 */
119 uint32_t kfifo_out_peek(struct kfifo_t *fifo, void *to, uint32_t size);
120
121 /**
122 * @brief 向kfifo缓冲区推入指定大小的数据并在过程加锁
123 *
124 * @param fifo 队列结构体
125 * @param from 来源数据地址
126 * @param size 数据大小（字节数）
127 * @param lock 自旋锁
128 * @return uint32_t 推入的数据大小
129 */
kfifo_in_locked(struct kfifo_t * fifo,const void * from,uint32_t size,spinlock_t * lock)130 uint32_t __always_inline kfifo_in_locked(struct kfifo_t *fifo, const void *from, uint32_t size, spinlock_t *lock)
131 {
132 spin_lock(lock);
133 uint32_t retval = kfifo_in(fifo, from, size);
134 spin_unlock(lock);
135 return retval;
136 }
137
138 /**
139 * @brief 从kfifo缓冲区取出数据，并从队列中删除数据，并在过程加锁
140 *
141 * @param fifo 队列结构体
142 * @param to 拷贝目标地址
143 * @param size 数据大小（字节数）
144 * @param lock 自旋锁
145 * @return uint32_t 取出的数据大小
146 */
kfifo_out_locked(struct kfifo_t * fifo,void * to,uint32_t size,spinlock_t * lock)147 uint32_t __always_inline kfifo_out_locked(struct kfifo_t *fifo, void *to, uint32_t size, spinlock_t *lock)
148 {
149 spin_lock(lock);
150 uint32_t retval = kfifo_out(fifo, to, size);
151 spin_unlock(lock);
152 return retval;
153 }
154