Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
人间散章
rt-thread
提交
0b4603d5
R
rt-thread
项目概览
人间散章
/
rt-thread
与 Fork 源项目一致
Fork自
RT-Thread / rt-thread
通知
1
Star
1
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
R
rt-thread
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
前往新版Gitcode,体验更适合开发者的 AI 搜索 >>
提交
0b4603d5
编写于
8月 14, 2021
作者:
J
Jackistang
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
[workqueue] 添加了 workqueue 接口的注释
上级
a6df4391
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
93 addition
and
0 deletion
+93
-0
components/drivers/include/ipc/workqueue.h
components/drivers/include/ipc/workqueue.h
+7
-0
components/drivers/src/workqueue.c
components/drivers/src/workqueue.c
+86
-0
未找到文件。
components/drivers/include/ipc/workqueue.h
浏览文件 @
0b4603d5
...
...
@@ -67,6 +67,13 @@ rt_err_t rt_work_submit(struct rt_work *work, rt_tick_t time);
rt_err_t
rt_work_cancel
(
struct
rt_work
*
work
);
#endif
/* RT_USING_SYSTEM_WORKQUEUE */
/**
* @brief Init a work item, and bind it with a callback function.
*
* @param work A pointer to work item object.
* @param work_func A callback function will be called when this work item is being executed.
* @param work_data A user data passed to the callback function as it's second parameter.
*/
rt_inline
void
rt_work_init
(
struct
rt_work
*
work
,
void
(
*
work_func
)(
struct
rt_work
*
work
,
void
*
work_data
),
void
*
work_data
)
{
...
...
components/drivers/src/workqueue.c
浏览文件 @
0b4603d5
...
...
@@ -209,6 +209,15 @@ static void _delayed_work_timeout_handler(void *parameter)
}
}
/**
* @brief Create a work queue, which contains a thread.
*
* @param name The name for work queue thread.
* @param stack_size The stack size for work queue thread.
* @param priority The priority for work queue thread.
*
* @return Return a pointer to workqueue object. When the return value is RT_NULL, it means the creation failed.
*/
struct
rt_workqueue
*
rt_workqueue_create
(
const
char
*
name
,
rt_uint16_t
stack_size
,
rt_uint8_t
priority
)
{
struct
rt_workqueue
*
queue
=
RT_NULL
;
...
...
@@ -236,6 +245,13 @@ struct rt_workqueue *rt_workqueue_create(const char *name, rt_uint16_t stack_siz
return
queue
;
}
/**
* @brief Destroy a work queue.
*
* @param queue A pointer to workqueue object.
*
* @return RT_EOK Success.
*/
rt_err_t
rt_workqueue_destroy
(
struct
rt_workqueue
*
queue
)
{
RT_ASSERT
(
queue
!=
RT_NULL
);
...
...
@@ -248,6 +264,15 @@ rt_err_t rt_workqueue_destroy(struct rt_workqueue *queue)
return
RT_EOK
;
}
/**
* @brief Submit a work item to the work queue immediately.
*
* @param queue A pointer to workqueue object.
* @param work A pointer to work item object.
*
* @return RT_EOK Success.
* @return -RT_EBUSY This work item is been executing now.
*/
rt_err_t
rt_workqueue_dowork
(
struct
rt_workqueue
*
queue
,
struct
rt_work
*
work
)
{
RT_ASSERT
(
queue
!=
RT_NULL
);
...
...
@@ -256,6 +281,17 @@ rt_err_t rt_workqueue_dowork(struct rt_workqueue *queue, struct rt_work *work)
return
_workqueue_submit_work
(
queue
,
work
,
0
);
}
/**
* @brief Submit a work item to the work queue with a delay of time.
*
* @param queue A pointer to workqueue object.
* @param work A pointer to work item object.
* @param time This work item will be delayed by time (unit: an OS tick) before it's been submitted to the work queue.
*
* @return RT_EOK Success.
* @return -RT_EBUSY This work item is been executing now.
* @return -RT_ERROR Time is invalid.
*/
rt_err_t
rt_workqueue_submit_work
(
struct
rt_workqueue
*
queue
,
struct
rt_work
*
work
,
rt_tick_t
time
)
{
RT_ASSERT
(
queue
!=
RT_NULL
);
...
...
@@ -264,6 +300,14 @@ rt_err_t rt_workqueue_submit_work(struct rt_workqueue *queue, struct rt_work *wo
return
_workqueue_submit_work
(
queue
,
work
,
time
);
}
/**
* @brief This function submit a work item to the work queue. This work item will be executed immediately after the current work item is executed.
*
* @param queue A pointer to workqueue object.
* @param work A pointer to work item object.
*
* @return RT_EOK Success.
*/
rt_err_t
rt_workqueue_critical_work
(
struct
rt_workqueue
*
queue
,
struct
rt_work
*
work
)
{
rt_base_t
level
;
...
...
@@ -291,6 +335,15 @@ rt_err_t rt_workqueue_critical_work(struct rt_workqueue *queue, struct rt_work *
return
RT_EOK
;
}
/**
* @brief Cancel a work item in the work queue.
*
* @param queue A pointer to workqueue object.
* @param work A pointer to work item object.
*
* @return RT_EOK Success.
* @return -RT_EBUSY This work item is been executing now.
*/
rt_err_t
rt_workqueue_cancel_work
(
struct
rt_workqueue
*
queue
,
struct
rt_work
*
work
)
{
RT_ASSERT
(
work
!=
RT_NULL
);
...
...
@@ -298,6 +351,14 @@ rt_err_t rt_workqueue_cancel_work(struct rt_workqueue *queue, struct rt_work *wo
return
_workqueue_cancel_work
(
queue
,
work
);
}
/**
* @brief Cancel a work item in the work queue. If the work item is been executing now, this function will block until it is done.
*
* @param queue A pointer to workqueue object.
* @param work A pointer to work item object.
*
* @return RT_EOK Success.
*/
rt_err_t
rt_workqueue_cancel_work_sync
(
struct
rt_workqueue
*
queue
,
struct
rt_work
*
work
)
{
RT_ASSERT
(
queue
!=
RT_NULL
);
...
...
@@ -316,6 +377,13 @@ rt_err_t rt_workqueue_cancel_work_sync(struct rt_workqueue *queue, struct rt_wor
return
RT_EOK
;
}
/**
* @brief This function will cancel all work item in work queue.
*
* @param queue A pointer to workqueue object.
*
* @return RT_EOK Success.
*/
rt_err_t
rt_workqueue_cancel_all_work
(
struct
rt_workqueue
*
queue
)
{
struct
rt_work
*
work
;
...
...
@@ -343,11 +411,29 @@ rt_err_t rt_workqueue_cancel_all_work(struct rt_workqueue *queue)
#ifdef RT_USING_SYSTEM_WORKQUEUE
static
struct
rt_workqueue
*
sys_workq
;
/**
* @brief Submit a work item to the system work queue with a delay of time.
*
* @param work A pointer to work item object.
* @param time This work item will be delayed by time (unit: an OS tick) before it's been submitted to system work queue.
*
* @return RT_EOK Success.
* @return -RT_EBUSY This work item is been executing now.
* @return -RT_ERROR Time is invalid.
*/
rt_err_t
rt_work_submit
(
struct
rt_work
*
work
,
rt_tick_t
time
)
{
return
rt_workqueue_submit_work
(
sys_workq
,
work
,
time
);
}
/**
* @brief Cancel a work item in system work queue.
*
* @param work A pointer to work item object.
*
* @return RT_EOK Success.
* @return -RT_EBUSY This work item is been executing now.
*/
rt_err_t
rt_work_cancel
(
struct
rt_work
*
work
)
{
return
rt_workqueue_cancel_work
(
sys_workq
,
work
);
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录