Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
Keyboard Man_俊
rt-thread
提交
3a789b33
R
rt-thread
项目概览
Keyboard Man_俊
/
rt-thread
与 Fork 源项目一致
Fork自
RT-Thread / rt-thread
通知
1
Star
0
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,发现更多精彩内容 >>
提交
3a789b33
编写于
1月 16, 2022
作者:
mysterywolf
提交者:
Bernard Xiong
1月 20, 2022
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
[workqueue] improve comment
上级
1874bd25
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
44 addition
and
30 deletion
+44
-30
components/drivers/src/workqueue.c
components/drivers/src/workqueue.c
+44
-30
未找到文件。
components/drivers/src/workqueue.c
浏览文件 @
3a789b33
/*
* Copyright (c) 2006-202
1
, RT-Thread Development Team
* Copyright (c) 2006-202
2
, RT-Thread Development Team
*
* SPDX-License-Identifier: Apache-2.0
*
...
...
@@ -213,11 +213,13 @@ static void _delayed_work_timeout_handler(void *parameter)
/**
* @brief Create a work queue with a thread inside.
*
* @param name The name of the work queue thread.
* @param stack_size The stack size of the work queue thread.
* @param priority The priority of the work queue thread.
* @param name is a name of the work queue thread.
*
* @return Return A pointer to the workqueue object. It will return RT_NULL if failed.
* @param stack_size is stack size of the work queue thread.
*
* @param priority is a priority of the work queue thread.
*
* @return Return a pointer to the workqueue object. It will return RT_NULL if failed.
*/
struct
rt_workqueue
*
rt_workqueue_create
(
const
char
*
name
,
rt_uint16_t
stack_size
,
rt_uint8_t
priority
)
{
...
...
@@ -249,9 +251,9 @@ struct rt_workqueue *rt_workqueue_create(const char *name, rt_uint16_t stack_siz
/**
* @brief Destroy a work queue.
*
* @param queue
A
pointer to the workqueue object.
* @param queue
is a
pointer to the workqueue object.
*
* @return RT_EOK
Success.
* @return RT_EOK Success.
*/
rt_err_t
rt_workqueue_destroy
(
struct
rt_workqueue
*
queue
)
{
...
...
@@ -268,11 +270,12 @@ rt_err_t rt_workqueue_destroy(struct rt_workqueue *queue)
/**
* @brief Submit a work item to the work queue without delay.
*
* @param queue A pointer to the workqueue object.
* @param work A pointer to the work item object.
* @param queue is a pointer to the workqueue object.
*
* @param work is a pointer to the work item object.
*
* @return RT_EOK Success.
*
@return
-RT_EBUSY This work item is executing.
*
-RT_EBUSY This work item is executing.
*/
rt_err_t
rt_workqueue_dowork
(
struct
rt_workqueue
*
queue
,
struct
rt_work
*
work
)
{
...
...
@@ -285,14 +288,17 @@ rt_err_t rt_workqueue_dowork(struct rt_workqueue *queue, struct rt_work *work)
/**
* @brief Submit a work item to the work queue with a delay.
*
* @param queue A pointer to the workqueue object.
* @param work A pointer to the work item object.
* @param time The delay time (unit: OS ticks) for the work item to be submitted to the work queue.
* The max timeout tick should be no more than (RT_TICK_MAX/2 - 1)
* @param queue is a pointer to the workqueue object.
*
* @param work is a pointer to the work item object.
*
* @param time is the delay time (unit: OS ticks) for the work item to be submitted to the work queue.
*
* NOTE: The max timeout tick should be no more than (RT_TICK_MAX/2 - 1)
*
* @return RT_EOK Success.
*
@return
-RT_EBUSY This work item is executing.
*
@return
-RT_ERROR The time parameter is invalid.
*
-RT_EBUSY This work item is executing.
*
-RT_ERROR The time parameter is invalid.
*/
rt_err_t
rt_workqueue_submit_work
(
struct
rt_workqueue
*
queue
,
struct
rt_work
*
work
,
rt_tick_t
time
)
{
...
...
@@ -305,14 +311,16 @@ rt_err_t rt_workqueue_submit_work(struct rt_workqueue *queue, struct rt_work *wo
/**
* @brief Submit a work item to the work queue without delay. This work item will be executed after the current work item.
*
* @param queue A pointer to the workqueue object.
* @param work A pointer to the work item object.
* @param queue is a pointer to the workqueue object.
*
* @param work is a pointer to the work item object.
*
* @return RT_EOK Success.
*/
rt_err_t
rt_workqueue_urgent_work
(
struct
rt_workqueue
*
queue
,
struct
rt_work
*
work
)
{
rt_base_t
level
;
RT_ASSERT
(
queue
!=
RT_NULL
);
RT_ASSERT
(
work
!=
RT_NULL
);
...
...
@@ -340,24 +348,27 @@ rt_err_t rt_workqueue_urgent_work(struct rt_workqueue *queue, struct rt_work *wo
/**
* @brief Cancel a work item in the work queue.
*
* @param queue A pointer to the workqueue object.
* @param work A pointer to the work item object.
* @param queue is a pointer to the workqueue object.
*
* @param work is a pointer to the work item object.
*
* @return RT_EOK Success.
*
@return
-RT_EBUSY This work item is executing.
*
-RT_EBUSY This work item is executing.
*/
rt_err_t
rt_workqueue_cancel_work
(
struct
rt_workqueue
*
queue
,
struct
rt_work
*
work
)
{
RT_ASSERT
(
work
!=
RT_NULL
);
RT_ASSERT
(
queue
!=
RT_NULL
);
return
_workqueue_cancel_work
(
queue
,
work
);
}
/**
* @brief Cancel a work item in the work queue. If the work item is executing, this function will block until it is done.
*
* @param queue A pointer to the workqueue object.
* @param work A pointer to the work item object.
* @param queue is a pointer to the workqueue object.
*
* @param work is a pointer to the work item object.
*
* @return RT_EOK Success.
*/
...
...
@@ -382,7 +393,7 @@ rt_err_t rt_workqueue_cancel_work_sync(struct rt_workqueue *queue, struct rt_wor
/**
* @brief This function will cancel all work items in work queue.
*
* @param queue
A
pointer to the workqueue object.
* @param queue
is a
pointer to the workqueue object.
*
* @return RT_EOK Success.
*/
...
...
@@ -416,12 +427,15 @@ static struct rt_workqueue *sys_workq;
/**
* @brief Submit a work item to the system work queue with a delay.
*
* @param work A pointer to the work item object.
* @param time The delay time (unit: OS ticks) for the work item to be submitted to the work queue.
* @param work is a pointer to the work item object.
*
* @param time is the delay time (unit: OS ticks) for the work item to be submitted to the work queue.
*
* NOTE: The max timeout tick should be no more than (RT_TICK_MAX/2 - 1)
*
* @return RT_EOK Success.
*
@return
-RT_EBUSY This work item is executing.
*
@return
-RT_ERROR The time parameter is invalid.
*
-RT_EBUSY This work item is executing.
*
-RT_ERROR The time parameter is invalid.
*/
rt_err_t
rt_work_submit
(
struct
rt_work
*
work
,
rt_tick_t
time
)
{
...
...
@@ -431,10 +445,10 @@ rt_err_t rt_work_submit(struct rt_work *work, rt_tick_t time)
/**
* @brief Cancel a work item in the system work queue.
*
* @param work
A
pointer to the work item object.
* @param work
is a
pointer to the work item object.
*
* @return RT_EOK Success.
*
@return
-RT_EBUSY This work item is executing.
*
-RT_EBUSY This work item is executing.
*/
rt_err_t
rt_work_cancel
(
struct
rt_work
*
work
)
{
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录