Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
BaiXuePrincess
rt-thread
提交
48c7a455
R
rt-thread
项目概览
BaiXuePrincess
/
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,发现更多精彩内容 >>
提交
48c7a455
编写于
9月 10, 2021
作者:
L
liukangcc
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
[update] src/thread.c function description.
上级
45440d24
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
117 addition
and
88 deletion
+117
-88
src/thread.c
src/thread.c
+117
-88
未找到文件。
src/thread.c
浏览文件 @
48c7a455
...
...
@@ -38,12 +38,11 @@ static void (*rt_thread_resume_hook) (rt_thread_t thread);
static
void
(
*
rt_thread_inited_hook
)
(
rt_thread_t
thread
);
/**
* @ingroup Hook
* This function sets a hook function when the system suspend a thread.
* @brief This function sets a hook function when the system suspend a thread.
*
* @
param hook the specified hook function
* @
note the hook function must be simple and never be blocked or suspend.
*
* @
note the hook function must be simple and never be blocked or suspend
.
* @
param hook the specified hook function
.
*/
void
rt_thread_suspend_sethook
(
void
(
*
hook
)(
rt_thread_t
thread
))
{
...
...
@@ -51,12 +50,11 @@ void rt_thread_suspend_sethook(void (*hook)(rt_thread_t thread))
}
/**
* @ingroup Hook
* This function sets a hook function when the system resume a thread.
* @brief This function sets a hook function when the system resume a thread.
*
* @
param hook the specified hook function
* @
note the hook function must be simple and never be blocked or suspend.
*
* @
note the hook function must be simple and never be blocked or suspend
.
* @
param hook the specified hook function
.
*/
void
rt_thread_resume_sethook
(
void
(
*
hook
)(
rt_thread_t
thread
))
{
...
...
@@ -64,10 +62,9 @@ void rt_thread_resume_sethook(void (*hook)(rt_thread_t thread))
}
/**
* @ingroup Hook
* This function sets a hook function when a thread is initialized.
* @brief This function sets a hook function when a thread is initialized.
*
* @param
hook the specified hook function
* @param
hook the specified hook function.
*/
void
rt_thread_inited_sethook
(
void
(
*
hook
)(
rt_thread_t
thread
))
{
...
...
@@ -76,7 +73,6 @@ void rt_thread_inited_sethook(void (*hook)(rt_thread_t thread))
#endif
/* RT_USING_HOOK */
/* must be invoke witch rt_hw_interrupt_disable */
static
void
_thread_cleanup_execute
(
rt_thread_t
thread
)
{
register
rt_base_t
level
;
...
...
@@ -244,19 +240,27 @@ static rt_err_t _thread_init(struct rt_thread *thread,
/**@{*/
/**
* This function will initialize a thread, normally it's used to initialize a
* static thread object.
*
* @param thread the static thread object
* @param name the name of thread, which shall be unique
* @param entry the entry function of thread
* @param parameter the parameter of thread enter function
* @param stack_start the start address of thread stack
* @param stack_size the size of thread stack
* @param priority the priority of thread
* @param tick the time slice if there are same priority thread
*
* @return the operation status, RT_EOK on OK, -RT_ERROR on error
* @brief This function will initialize a thread, normally it's used to initialize a
* static thread object.
*
* @param thread the static thread object.
*
* @param name the name of thread, which shall be unique.
*
* @param entry the entry function of thread.
*
* @param parameter the parameter of thread enter function.
*
* @param stack_start the start address of thread stack.
*
* @param stack_size the size of thread stack.
*
* @param priority the priority of thread.
*
* @param tick the time slice if there are same priority thread.
*
* @return Return the operation status. When the return value is RT_EOK, the function is successfully executed.
* When the return value is any other values, it means this operation failed.
*/
rt_err_t
rt_thread_init
(
struct
rt_thread
*
thread
,
const
char
*
name
,
...
...
@@ -286,9 +290,9 @@ rt_err_t rt_thread_init(struct rt_thread *thread,
RTM_EXPORT
(
rt_thread_init
);
/**
*
This function will return self thread object
*
@brief This function will return self thread object.
*
* @return
the self thread object
* @return
the self thread object.
*/
rt_thread_t
rt_thread_self
(
void
)
{
...
...
@@ -309,11 +313,12 @@ rt_thread_t rt_thread_self(void)
RTM_EXPORT
(
rt_thread_self
);
/**
*
This function will start a thread and put it to system ready queue
*
@brief This function will start a thread and put it to system ready queue.
*
* @param
thread the thread to be started
* @param
thread the thread to be started.
*
* @return the operation status, RT_EOK on OK, -RT_ERROR on error
* @return Return the operation status. When the return value is RT_EOK, the function is successfully executed.
* When the return value is any other values, it means this operation failed.
*/
rt_err_t
rt_thread_startup
(
rt_thread_t
thread
)
{
...
...
@@ -351,12 +356,13 @@ rt_err_t rt_thread_startup(rt_thread_t thread)
RTM_EXPORT
(
rt_thread_startup
);
/**
* This function will detach a thread. The thread object will be removed from
* thread queue and detached/deleted from system object management.
*
@brief
This function will detach a thread. The thread object will be removed from
*
thread queue and detached/deleted from system object management.
*
* @param
thread the thread to be deleted
* @param
thread the thread to be deleted.
*
* @return the operation status, RT_EOK on OK, -RT_ERROR on error
* @return Return the operation status. When the return value is RT_EOK, the function is successfully executed.
* When the return value is any other values, it means this operation failed.
*/
rt_err_t
rt_thread_detach
(
rt_thread_t
thread
)
{
...
...
@@ -404,17 +410,22 @@ RTM_EXPORT(rt_thread_detach);
#ifdef RT_USING_HEAP
/**
* This function will create a thread object and allocate thread object memory
* and stack.
* @brief This function will create a thread object and allocate thread object memory.
* and stack.
*
* @param name the name of thread, which shall be unique.
*
* @param entry the entry function of thread.
*
* @param name the name of thread, which shall be unique
* @param entry the entry function of thread
* @param parameter the parameter of thread enter function
* @param stack_size the size of thread stack
* @param priority the priority of thread
* @param tick the time slice if there are same priority thread
* @param parameter the parameter of thread enter function.
*
* @return the created thread object
* @param stack_size the size of thread stack.
*
* @param priority the priority of thread.
*
* @param tick the time slice if there are same priority thread.
*
* @return the created thread object.
*/
rt_thread_t
rt_thread_create
(
const
char
*
name
,
void
(
*
entry
)(
void
*
parameter
),
...
...
@@ -454,12 +465,13 @@ rt_thread_t rt_thread_create(const char *name,
RTM_EXPORT
(
rt_thread_create
);
/**
* This function will delete a thread. The thread object will be removed from
* thread queue and deleted from system object management in the idle thread.
*
@brief
This function will delete a thread. The thread object will be removed from
*
thread queue and deleted from system object management in the idle thread.
*
* @param
thread the thread to be deleted
* @param
thread the thread to be deleted.
*
* @return the operation status, RT_EOK on OK, -RT_ERROR on error
* @return Return the operation status. When the return value is RT_EOK, the function is successfully executed.
* When the return value is any other values, it means this operation failed.
*/
rt_err_t
rt_thread_delete
(
rt_thread_t
thread
)
{
...
...
@@ -502,11 +514,12 @@ RTM_EXPORT(rt_thread_delete);
#endif
/* RT_USING_HEAP */
/**
* This function will let current thread yield processor, and scheduler will
* choose a highest thread to run. After yield processor, the current thread
* is still in READY state.
*
@brief
This function will let current thread yield processor, and scheduler will
*
choose a highest thread to run. After yield processor, the current thread
*
is still in READY state.
*
* @return RT_EOK
* @return Return the operation status. When the return value is RT_EOK, the function is successfully executed.
* When the return value is any other values, it means this operation failed.
*/
rt_err_t
rt_thread_yield
(
void
)
{
...
...
@@ -525,11 +538,13 @@ rt_err_t rt_thread_yield(void)
RTM_EXPORT
(
rt_thread_yield
);
/**
* This function will let current thread sleep for some ticks.
* @brief This function will let current thread sleep for some ticks. Change current thread state to suspend,
* when the thread timer reaches the tick value, scheduler will awaken this thread.
*
* @param
tick the sleep ticks
* @param
tick the sleep ticks.
*
* @return RT_EOK
* @return Return the operation status. When the return value is RT_EOK, the function is successfully executed.
* When the return value is any other values, it means this operation failed.
*/
rt_err_t
rt_thread_sleep
(
rt_tick_t
tick
)
{
...
...
@@ -564,11 +579,12 @@ rt_err_t rt_thread_sleep(rt_tick_t tick)
}
/**
* This function will let current thread delay for some ticks.
*
@brief
This function will let current thread delay for some ticks.
*
* @param
tick the delay ticks
* @param
tick the delay ticks.
*
* @return RT_EOK
* @return Return the operation status. When the return value is RT_EOK, the function is successfully executed.
* When the return value is any other values, it means this operation failed.
*/
rt_err_t
rt_thread_delay
(
rt_tick_t
tick
)
{
...
...
@@ -577,12 +593,14 @@ rt_err_t rt_thread_delay(rt_tick_t tick)
RTM_EXPORT
(
rt_thread_delay
);
/**
* This function will let current thread delay until (*tick + inc_tick).
*
@brief
This function will let current thread delay until (*tick + inc_tick).
*
* @param tick the tick of last wakeup.
* @param inc_tick the increment tick
* @param tick the tick of last wakeup.
*
* @return RT_EOK
* @param inc_tick the increment tick.
*
* @return Return the operation status. When the return value is RT_EOK, the function is successfully executed.
* When the return value is any other values, it means this operation failed.
*/
rt_err_t
rt_thread_delay_until
(
rt_tick_t
*
tick
,
rt_tick_t
inc_tick
)
{
...
...
@@ -637,11 +655,12 @@ rt_err_t rt_thread_delay_until(rt_tick_t *tick, rt_tick_t inc_tick)
RTM_EXPORT
(
rt_thread_delay_until
);
/**
* This function will let current thread delay for some milliseconds.
*
@brief
This function will let current thread delay for some milliseconds.
*
* @param
ms the delay ms time
* @param
ms the delay ms time.
*
* @return RT_EOK
* @return Return the operation status. When the return value is RT_EOK, the function is successfully executed.
* When the return value is any other values, it means this operation failed.
*/
rt_err_t
rt_thread_mdelay
(
rt_int32_t
ms
)
{
...
...
@@ -654,17 +673,24 @@ rt_err_t rt_thread_mdelay(rt_int32_t ms)
RTM_EXPORT
(
rt_thread_mdelay
);
/**
* This function will control thread behaviors according to control command.
* @brief This function will control thread behaviors according to control command.
*
* @param thread the specified thread to be controlled.
*
* @param cmd the control command, which includes.
*
* @param thread the specified thread to be controlled
* @param cmd the control command, which includes
* RT_THREAD_CTRL_CHANGE_PRIORITY for changing priority level of thread;
* RT_THREAD_CTRL_STARTUP for starting a thread;
* RT_THREAD_CTRL_CLOSE for delete a thread;
* RT_THREAD_CTRL_BIND_CPU for bind the thread to a CPU.
* @param arg the argument of control command
* RT_THREAD_CTRL_CHANGE_PRIORITY for changing priority level of thread.
*
* @return RT_EOK
* RT_THREAD_CTRL_STARTUP for starting a thread.
*
* RT_THREAD_CTRL_CLOSE for delete a thread.
*
* RT_THREAD_CTRL_BIND_CPU for bind the thread to a CPU.
*
* @param arg the argument of control command.
*
* @return Return the operation status. When the return value is RT_EOK, the function is successfully executed.
* When the return value is any other values, it means this operation failed.
*/
rt_err_t
rt_thread_control
(
rt_thread_t
thread
,
int
cmd
,
void
*
arg
)
{
...
...
@@ -770,14 +796,15 @@ rt_err_t rt_thread_control(rt_thread_t thread, int cmd, void *arg)
RTM_EXPORT
(
rt_thread_control
);
/**
*
This function will suspend the specified thread
.
*
@brief This function will suspend the specified thread and change it to suspend state
.
*
* @param thread the thread to be suspended
* @note if suspend self thread, after this function call, the
* rt_schedule() must be invoked.
*
* @
return the operation status, RT_EOK on OK, -RT_ERROR on error
* @
param thread the thread to be suspended.
*
* @
note if suspend self thread, after this function call, the
*
rt_schedule() must be invok
ed.
* @
return Return the operation status. When the return value is RT_EOK, the function is successfully executed.
*
When the return value is any other values, it means this operation fail
ed.
*/
rt_err_t
rt_thread_suspend
(
rt_thread_t
thread
)
{
...
...
@@ -822,11 +849,12 @@ rt_err_t rt_thread_suspend(rt_thread_t thread)
RTM_EXPORT
(
rt_thread_suspend
);
/**
* This function will resume a thread and put it to system ready queue.
*
@brief
This function will resume a thread and put it to system ready queue.
*
* @param
thread the thread to be resumed
* @param
thread the thread to be resumed.
*
* @return the operation status, RT_EOK on OK, -RT_ERROR on error
* @return Return the operation status. When the return value is RT_EOK, the function is successfully executed.
* When the return value is any other values, it means this operation failed.
*/
rt_err_t
rt_thread_resume
(
rt_thread_t
thread
)
{
...
...
@@ -866,10 +894,10 @@ rt_err_t rt_thread_resume(rt_thread_t thread)
RTM_EXPORT
(
rt_thread_resume
);
/**
* This function is the timeout function for thread, normally which is invoked
* when thread is timeout to wait some resource.
*
@brief
This function is the timeout function for thread, normally which is invoked
*
when thread is timeout to wait some resource.
*
* @param parameter the parameter of thread timeout function
* @param
parameter the parameter of thread timeout function
*/
void
rt_thread_timeout
(
void
*
parameter
)
{
...
...
@@ -904,18 +932,19 @@ void rt_thread_timeout(void *parameter)
RTM_EXPORT
(
rt_thread_timeout
);
/**
* This function will find the specified thread.
*
@brief
This function will find the specified thread.
*
* @
param name the name of thread finding
* @
note please don't invoke this function in interrupt status.
*
* @
return the found thread
* @
param name the name of thread finding.
*
* @
note please don't invoke this function in interrupt status
.
* @
return the found thread
.
*/
rt_thread_t
rt_thread_find
(
char
*
name
)
{
return
(
rt_thread_t
)
rt_object_find
(
name
,
RT_Object_Class_Thread
);
}
RTM_EXPORT
(
rt_thread_find
);
/**@}*/
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录