1 /*
2 * Copyright (c) 2006-2023, RT-Thread Development Team
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 *
6 * Change Logs:
7 * Date Author Notes
8 * 2018/06/26 Bernard Fix the wait queue issue when wakeup a soon
9 * to blocked thread.
10 */
11
12 #ifndef WAITQUEUE_H__
13 #define WAITQUEUE_H__
14
15 #include <rtdef.h>
16 #include <rtconfig.h>
17
18 #define RT_WQ_FLAG_CLEAN 0x00
19 #define RT_WQ_FLAG_WAKEUP 0x01
20
21 struct rt_wqueue_node;
22 typedef int (*rt_wqueue_func_t)(struct rt_wqueue_node *wait, void *key);
23
24 struct rt_wqueue_node
25 {
26 rt_thread_t polling_thread;
27 rt_list_t list;
28
29 rt_wqueue_t *wqueue;
30 rt_wqueue_func_t wakeup;
31 rt_uint32_t key;
32 };
33 typedef struct rt_wqueue_node rt_wqueue_node_t;
34
35 int __wqueue_default_wake(struct rt_wqueue_node *wait, void *key);
36
rt_wqueue_init(rt_wqueue_t * queue)37 rt_inline void rt_wqueue_init(rt_wqueue_t *queue)
38 {
39 RT_ASSERT(queue != RT_NULL);
40
41 queue->flag = RT_WQ_FLAG_CLEAN;
42 rt_list_init(&(queue->waiting_list));
43 rt_spin_lock_init(&(queue->spinlock));
44 }
45
46 void rt_wqueue_add(rt_wqueue_t *queue, struct rt_wqueue_node *node);
47 void rt_wqueue_remove(struct rt_wqueue_node *node);
48 int rt_wqueue_wait(rt_wqueue_t *queue, int condition, int timeout);
49 int rt_wqueue_wait_killable(rt_wqueue_t *queue, int condition, int timeout);
50 int rt_wqueue_wait_interruptible(rt_wqueue_t *queue, int condition, int timeout);
51 void rt_wqueue_wakeup(rt_wqueue_t *queue, void *key);
52 void rt_wqueue_wakeup_all(rt_wqueue_t *queue, void *key);
53
54 #define DEFINE_WAIT_FUNC(name, function) \
55 struct rt_wqueue_node name = { \
56 rt_current_thread, \
57 RT_LIST_OBJECT_INIT(((name).list)), \
58 function, \
59 0 \
60 }
61
62 #define DEFINE_WAIT(name) DEFINE_WAIT_FUNC(name, __wqueue_default_wake)
63
64 #endif
65