Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
RT-Thread
rt-thread
提交
f76a192f
R
rt-thread
项目概览
RT-Thread
/
rt-thread
8 个月 前同步成功
通知
749
Star
8909
Fork
4735
代码
文件
提交
分支
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 搜索 >>
未验证
提交
f76a192f
编写于
9月 14, 2021
作者:
B
Bernard Xiong
提交者:
GitHub
9月 14, 2021
浏览文件
操作
浏览文件
下载
差异文件
Merge pull request #5040 from yangjie11/comments
[kernel]Normalized kernel API annotation
上级
673718c0
fe5d506e
变更
8
隐藏空白更改
内联
并排
Showing
8 changed file
with
444 addition
and
260 deletion
+444
-260
src/device.c
src/device.c
+60
-46
src/idle.c
src/idle.c
+20
-24
src/mem.c
src/mem.c
+35
-24
src/memheap.c
src/memheap.c
+130
-11
src/mempool.c
src/mempool.c
+34
-26
src/object.c
src/object.c
+71
-63
src/scheduler.c
src/scheduler.c
+40
-36
src/slab.c
src/slab.c
+54
-30
未找到文件。
src/device.c
浏览文件 @
f76a192f
...
...
@@ -39,11 +39,13 @@
#endif
/* RT_USING_DEVICE_OPS */
/**
*
This function registers a device driver with
specified name.
*
@brief This function registers a device driver with a
specified name.
*
* @param dev the pointer of device driver structure
* @param name the device driver's name
* @param flags the capabilities flag of device
* @param dev is the pointer of device driver structure.
*
* @param name is the device driver's name.
*
* @param flags is the capabilities flag of device.
*
* @return the error code, RT_EOK on initialization successfully.
*/
...
...
@@ -72,9 +74,9 @@ rt_err_t rt_device_register(rt_device_t dev,
RTM_EXPORT
(
rt_device_register
);
/**
*
This function removes a previously registered device driver
*
@brief This function removes a previously registered device driver.
*
* @param dev
the pointer of device driver structure
* @param dev
is the pointer of device driver structure.
*
* @return the error code, RT_EOK on successfully.
*/
...
...
@@ -91,9 +93,9 @@ rt_err_t rt_device_unregister(rt_device_t dev)
RTM_EXPORT
(
rt_device_unregister
);
/**
* This function finds a device driver by specified name.
*
@brief
This function finds a device driver by specified name.
*
* @param name
the device driver's name
* @param name
is the device driver's name.
*
* @return the registered device driver on successful, or RT_NULL on failure.
*/
...
...
@@ -105,10 +107,11 @@ RTM_EXPORT(rt_device_find);
#ifdef RT_USING_HEAP
/**
* This function creates a device object with user data size.
*
@brief
This function creates a device object with user data size.
*
* @param type, the kind type of this device object.
* @param attach_size, the size of user data.
* @param type is the type of the device object.
*
* @param attach_size is the size of user data.
*
* @return the allocated device object, or RT_NULL when failed.
*/
...
...
@@ -134,9 +137,9 @@ rt_device_t rt_device_create(int type, int attach_size)
RTM_EXPORT
(
rt_device_create
);
/**
* This function destroy the specific device object.
*
@brief
This function destroy the specific device object.
*
* @param dev
, the
specific device object.
* @param dev
is a
specific device object.
*/
void
rt_device_destroy
(
rt_device_t
dev
)
{
...
...
@@ -153,11 +156,11 @@ RTM_EXPORT(rt_device_destroy);
#endif
/* RT_USING_HEAP */
/**
*
This function will initialize the specified device
*
@brief This function will initialize the specified device.
*
* @param dev
the pointer of device driver structure
* @param dev
is the pointer of device driver structure.
*
* @return the result
* @return the result
, RT_EOK on successfully.
*/
rt_err_t
rt_device_init
(
rt_device_t
dev
)
{
...
...
@@ -187,12 +190,13 @@ rt_err_t rt_device_init(rt_device_t dev)
}
/**
* This function will open a device
* @brief This function will open a device.
*
* @param dev is the pointer of device driver structure.
*
* @param dev the pointer of device driver structure
* @param oflag the flags for device open
* @param oflag is the flags for device open.
*
* @return the result
* @return the result
, RT_EOK on successfully.
*/
rt_err_t
rt_device_open
(
rt_device_t
dev
,
rt_uint16_t
oflag
)
{
...
...
@@ -253,11 +257,11 @@ rt_err_t rt_device_open(rt_device_t dev, rt_uint16_t oflag)
RTM_EXPORT
(
rt_device_open
);
/**
*
This function will close a device
*
@brief This function will close a device.
*
* @param dev
the pointer of device driver structure
* @param dev
is the pointer of device driver structure.
*
* @return the result
* @return the result
, RT_EOK on successfully.
*/
rt_err_t
rt_device_close
(
rt_device_t
dev
)
{
...
...
@@ -289,12 +293,15 @@ rt_err_t rt_device_close(rt_device_t dev)
RTM_EXPORT
(
rt_device_close
);
/**
* This function will read some data from a device.
* @brief This function will read some data from a device.
*
* @param dev is the pointer of device driver structure.
*
* @param pos is the position when reading.
*
* @param buffer is a data buffer to save the read data.
*
* @param dev the pointer of device driver structure
* @param pos the position of reading
* @param buffer the data buffer to save read data
* @param size the size of buffer
* @param size is the size of buffer.
*
* @return the actually read size on successful, otherwise negative returned.
*
...
...
@@ -328,12 +335,15 @@ rt_size_t rt_device_read(rt_device_t dev,
RTM_EXPORT
(
rt_device_read
);
/**
* This function will write some data to a device.
*
@brief
This function will write some data to a device.
*
* @param dev the pointer of device driver structure
* @param pos the position of written
* @param buffer the data buffer to be written to device
* @param size the size of buffer
* @param dev is the pointer of device driver structure.
*
* @param pos is the position when writing.
*
* @param buffer is the data buffer to be written to device.
*
* @param size is the size of buffer.
*
* @return the actually written size on successful, otherwise negative returned.
*
...
...
@@ -367,13 +377,15 @@ rt_size_t rt_device_write(rt_device_t dev,
RTM_EXPORT
(
rt_device_write
);
/**
* This function will perform a variety of control functions on devices.
* @brief This function will perform a variety of control functions on devices.
*
* @param dev is the pointer of device driver structure.
*
* @param dev the pointer of device driver structure
* @param cmd the command sent to device
* @param arg the argument of command
* @param cmd is the command sent to device.
*
* @return the result
* @param arg is the argument of command.
*
* @return the result, -RT_ENOSYS for failed.
*/
rt_err_t
rt_device_control
(
rt_device_t
dev
,
int
cmd
,
void
*
arg
)
{
...
...
@@ -391,11 +403,12 @@ rt_err_t rt_device_control(rt_device_t dev, int cmd, void *arg)
RTM_EXPORT
(
rt_device_control
);
/**
* This function will set the reception indication callback function. This callback function
* is invoked when this device receives data.
* @brief This function will set the reception indication callback function. This callback function
* is invoked when this device receives data.
*
* @param dev is the pointer of device driver structure.
*
* @param dev the pointer of device driver structure
* @param rx_ind the indication callback function
* @param rx_ind is the indication callback function.
*
* @return RT_EOK
*/
...
...
@@ -413,11 +426,12 @@ rt_device_set_rx_indicate(rt_device_t dev,
RTM_EXPORT
(
rt_device_set_rx_indicate
);
/**
* This function will set the indication callback function when device has
* written data to physical hardware.
* @brief This function will set a callback function. The callback function
* will be called when device has written data to physical hardware.
*
* @param dev is the pointer of device driver structure.
*
* @param dev the pointer of device driver structure
* @param tx_done the indication callback function
* @param tx_done is the indication callback function.
*
* @return RT_EOK
*/
...
...
src/idle.c
浏览文件 @
f76a192f
...
...
@@ -68,14 +68,13 @@ static struct rt_semaphore system_sem;
static
void
(
*
idle_hook_list
[
RT_IDLE_HOOK_LIST_SIZE
])(
void
);
/**
* @ingroup Hook
* This function sets a hook function to idle thread loop. When the system performs
* idle loop, this hook function should be invoked.
* @brief This function sets a hook function to idle thread loop. When the system performs
* idle loop, this hook function should be invoked.
*
* @param hook the specified hook function
* @param hook the specified hook function
.
*
* @return RT_EOK: set OK
* -RT_EFULL: hook list is full
* @return RT_EOK: set OK
.
* -RT_EFULL: hook list is full
.
*
* @note the hook function must be simple and never be blocked or suspend.
*/
...
...
@@ -104,12 +103,12 @@ rt_err_t rt_thread_idle_sethook(void (*hook)(void))
}
/**
*
delete the idle hook on hook list
*
@brief delete the idle hook on hook list.
*
* @param hook the specified hook function
* @param hook the specified hook function
.
*
* @return RT_EOK: delete OK
* -RT_ENOSYS: hook was not found
* @return RT_EOK: delete OK
.
* -RT_ENOSYS: hook was not found
.
*/
rt_err_t
rt_thread_idle_delhook
(
void
(
*
hook
)(
void
))
{
...
...
@@ -153,8 +152,10 @@ rt_inline int _idle_has_defunct_thread(void)
}
#endif
/* RT_USING_MODULE */
/* enqueue a thread to defunct queue
* it must be called between rt_hw_interrupt_disable and rt_hw_interrupt_enable
/**
* @brief Enqueue a thread to defunct queue.
*
* @note It must be called between rt_hw_interrupt_disable and rt_hw_interrupt_enable
*/
void
rt_thread_defunct_enqueue
(
rt_thread_t
thread
)
{
...
...
@@ -164,8 +165,10 @@ void rt_thread_defunct_enqueue(rt_thread_t thread)
#endif
}
/* dequeue a thread from defunct queue
* it must be called between rt_hw_interrupt_disable and rt_hw_interrupt_enable
/**
* @brief Dequeue a thread from defunct queue.
*
* @note It must be called between rt_hw_interrupt_disable and rt_hw_interrupt_enable.
*/
rt_thread_t
rt_thread_defunct_dequeue
(
void
)
{
...
...
@@ -183,9 +186,7 @@ rt_thread_t rt_thread_defunct_dequeue(void)
}
/**
* @ingroup Thread
*
* This function will perform system background job when system idle.
* @brief This function will perform system background job when system idle.
*/
static
void
rt_defunct_execute
(
void
)
{
...
...
@@ -316,9 +317,7 @@ static void rt_thread_system_entry(void *parameter)
#endif
/**
* @ingroup SystemInit
*
* This function will initialize idle thread, then start it.
* @brief This function will initialize idle thread, then start it.
*
* @note this function must be invoked when system init.
*/
...
...
@@ -365,10 +364,7 @@ void rt_thread_idle_init(void)
}
/**
* @ingroup Thread
*
* This function will get the handler of the idle thread.
*
* @brief This function will get the handler of the idle thread.
*/
rt_thread_t
rt_thread_idle_gethandler
(
void
)
{
...
...
src/mem.c
浏览文件 @
f76a192f
...
...
@@ -66,10 +66,10 @@ static void (*rt_free_hook)(void *ptr);
/**@{*/
/**
* This function will set a hook function, which will be invoked when a memory
* block is allocated from heap memory.
*
@brief
This function will set a hook function, which will be invoked when a memory
*
block is allocated from heap memory.
*
* @param hook the hook function
* @param hook the hook function
.
*/
void
rt_malloc_sethook
(
void
(
*
hook
)(
void
*
ptr
,
rt_size_t
size
))
{
...
...
@@ -77,8 +77,8 @@ void rt_malloc_sethook(void (*hook)(void *ptr, rt_size_t size))
}
/**
* This function will set a hook function, which will be invoked when a memory
* block is released to heap memory.
*
@brief
This function will set a hook function, which will be invoked when a memory
*
block is released to heap memory.
*
* @param hook the hook function
*/
...
...
@@ -194,11 +194,10 @@ static void plug_holes(struct heap_mem *mem)
}
/**
* @ingroup SystemInit
*
* This function will initialize system heap memory.
* @brief This function will initialize system heap memory.
*
* @param begin_addr the beginning address of system heap memory.
*
* @param end_addr the end address of system heap memory.
*/
void
rt_system_heap_init
(
void
*
begin_addr
,
void
*
end_addr
)
...
...
@@ -263,11 +262,11 @@ void rt_system_heap_init(void *begin_addr, void *end_addr)
/**@{*/
/**
* Allocate a block of memory with a minimum of 'size' bytes.
*
@brief
Allocate a block of memory with a minimum of 'size' bytes.
*
* @param size is the minimum size of the requested block in bytes.
*
* @return pointer to allocated memory or NULL if no free memory was found.
* @return
the
pointer to allocated memory or NULL if no free memory was found.
*/
void
*
rt_malloc
(
rt_size_t
size
)
{
...
...
@@ -411,12 +410,13 @@ void *rt_malloc(rt_size_t size)
RTM_EXPORT
(
rt_malloc
);
/**
*
This function will change the
previously allocated memory block.
*
@brief This function will change the size of
previously allocated memory block.
*
* @param rmem pointer to memory allocated by rt_malloc
* @param newsize the required new size
* @param rmem is the pointer to memory allocated by rt_malloc.
*
* @return the changed memory block address
* @param newsize is the required new size.
*
* @return the changed memory block address.
*/
void
*
rt_realloc
(
void
*
rmem
,
rt_size_t
newsize
)
{
...
...
@@ -517,16 +517,17 @@ void *rt_realloc(void *rmem, rt_size_t newsize)
RTM_EXPORT
(
rt_realloc
);
/**
* This function will contiguously allocate enough space for count objects
* that are size bytes of memory each and returns a pointer to the allocated
* memory.
* @brief This function will contiguously allocate enough space for count objects
* that are size bytes of memory each and returns a pointer to the allocated
* memory.
*
* @note The allocated memory is filled with bytes of value zero.
*
*
The allocated memory is filled with bytes of value zero
.
*
@param count is the number of objects to allocate
.
*
* @param count number of objects to allocate
* @param size size of the objects to allocate
* @param size is the size of one object to allocate.
*
* @return pointer to allocated memory / NULL pointer if there is an error
* @return pointer to allocated memory / NULL pointer if there is an error
.
*/
void
*
rt_calloc
(
rt_size_t
count
,
rt_size_t
size
)
{
...
...
@@ -544,10 +545,10 @@ void *rt_calloc(rt_size_t count, rt_size_t size)
RTM_EXPORT
(
rt_calloc
);
/**
* This function will release the previously allocated memory block by
* rt_malloc. The released memory block is taken back to system heap.
*
@brief
This function will release the previously allocated memory block by
*
rt_malloc. The released memory block is taken back to system heap.
*
* @param rmem the address of memory which will be released
* @param rmem the address of memory which will be released
.
*/
void
rt_free
(
void
*
rmem
)
{
...
...
@@ -616,6 +617,16 @@ void rt_free(void *rmem)
RTM_EXPORT
(
rt_free
);
#ifdef RT_MEM_STATS
/**
* @brief This function will caculate the total memory, the used memory, and
* the max used memory.
*
* @param total is a pointer to get the total size of the memory.
*
* @param used is a pointer to get the size of memory used.
*
* @param max_used is a pointer to get the maximum memory used.
*/
void
rt_memory_info
(
rt_uint32_t
*
total
,
rt_uint32_t
*
used
,
rt_uint32_t
*
max_used
)
...
...
src/memheap.c
浏览文件 @
f76a192f
...
...
@@ -39,6 +39,13 @@
#define MEMITEM(ptr) (struct rt_memheap_item*)((rt_uint8_t*)ptr - RT_MEMHEAP_SIZE)
#ifdef RT_USING_MEMTRACE
/**
* @brief This function will set a new name for memheap.
*
* @param item is a pointer point to a memheap object.
*
* @param name is the new name to be set.
*/
rt_inline
void
rt_memheap_setname
(
struct
rt_memheap_item
*
item
,
const
char
*
name
)
{
int
index
;
...
...
@@ -64,6 +71,13 @@ rt_inline void rt_memheap_setname(struct rt_memheap_item *item, const char *name
}
}
/**
* @brief This function will set a new name for memheap.
*
* @param ptr is a pointer point to a memheap object.
*
* @param name is the new name to be set.
*/
void
rt_mem_set_tag
(
void
*
ptr
,
const
char
*
name
)
{
struct
rt_memheap_item
*
item
;
...
...
@@ -76,16 +90,28 @@ void rt_mem_set_tag(void *ptr, const char *name)
}
#endif
/* RT_USING_MEMTRACE */
/*
* The initialized memory pool will be:
* +-----------------------------------+--------------------------+
* | whole freed memory block | Used Memory Block Tailer |
* +-----------------------------------+--------------------------+
/**
* @brief This function initializes a piece of memory called memheap.
*
* @note The initialized memory pool will be:
* +-----------------------------------+--------------------------+
* | whole freed memory block | Used Memory Block Tailer |
* +-----------------------------------+--------------------------+
*
* block_list --> whole freed memory block
*
* The length of Used Memory Block Tailer is 0,
* which is prevents block merging across list
*
* @param memheap is a pointer of the memheap object.
*
* @param name is the name of the memheap.
*
* @param start_addr is the start address of the memheap.
*
*
block_list --> whole freed memory block
*
@param size is the size of the memheap.
*
* The length of Used Memory Block Tailer is 0,
* which is prevents block merging across list
* @return RT_EOK
*/
rt_err_t
rt_memheap_init
(
struct
rt_memheap
*
memheap
,
const
char
*
name
,
...
...
@@ -165,6 +191,13 @@ rt_err_t rt_memheap_init(struct rt_memheap *memheap,
}
RTM_EXPORT
(
rt_memheap_init
);
/**
* @brief This function will remove a memheap from the system.
*
* @param heap is a pointer of memheap object.
*
* @return RT_EOK
*/
rt_err_t
rt_memheap_detach
(
struct
rt_memheap
*
heap
)
{
RT_ASSERT
(
heap
);
...
...
@@ -179,6 +212,15 @@ rt_err_t rt_memheap_detach(struct rt_memheap *heap)
}
RTM_EXPORT
(
rt_memheap_detach
);
/**
* @brief Allocate a block of memory with a minimum of 'size' bytes on memheap.
*
* @param heap is a pointer for memheap object.
*
* @param size is the minimum size of the requested block in bytes.
*
* @return the pointer to allocated memory or NULL if no free memory was found.
*/
void
*
rt_memheap_alloc
(
struct
rt_memheap
*
heap
,
rt_size_t
size
)
{
rt_err_t
result
;
...
...
@@ -336,6 +378,18 @@ void *rt_memheap_alloc(struct rt_memheap *heap, rt_size_t size)
}
RTM_EXPORT
(
rt_memheap_alloc
);
/**
* @brief This function will change the size of previously allocated memory block.
*
* @param heap is a pointer to the memheap object, which will reallocate
* memory from the block
*
* @param ptr is a pointer to start address of memory.
*
* @param newsize is the required new size.
*
* @return the changed memory block address.
*/
void
*
rt_memheap_realloc
(
struct
rt_memheap
*
heap
,
void
*
ptr
,
rt_size_t
newsize
)
{
rt_err_t
result
;
...
...
@@ -556,6 +610,12 @@ void *rt_memheap_realloc(struct rt_memheap *heap, void *ptr, rt_size_t newsize)
}
RTM_EXPORT
(
rt_memheap_realloc
);
/**
* @brief This function will release the allocated memory block by
* rt_malloc. The released memory block is taken back to system heap.
*
* @param ptr the address of memory which will be released.
*/
void
rt_memheap_free
(
void
*
ptr
)
{
rt_err_t
result
;
...
...
@@ -680,7 +740,13 @@ static void _memheap_dump_tag(struct rt_memheap_item *item)
rt_kprintf
(
"%.*s"
,
2
*
sizeof
(
void
*
),
name
);
}
/**
* @brief This function will print the memheap infomation.
*
* @param heap is the pointer to the memheap to get information.
*
* @return 0
*/
int
rt_memheap_dump
(
struct
rt_memheap
*
heap
)
{
struct
rt_memheap_item
*
item
,
*
end
;
...
...
@@ -757,6 +823,13 @@ MSH_CMD_EXPORT(memheaptrace, dump memory trace information);
#ifdef RT_USING_MEMHEAP_AS_HEAP
static
struct
rt_memheap
_heap
;
/**
* @brief This function initializes a heap for system.
*
* @param begin_addr is the start address of the memory.
*
* @param end_addr is the end address of the memory.
*/
void
rt_system_heap_init
(
void
*
begin_addr
,
void
*
end_addr
)
{
RT_ASSERT
((
rt_uint32_t
)
end_addr
>
(
rt_uint32_t
)
begin_addr
);
...
...
@@ -768,6 +841,11 @@ void rt_system_heap_init(void *begin_addr, void *end_addr)
(
rt_uint32_t
)
end_addr
-
(
rt_uint32_t
)
begin_addr
);
}
/**
* @brief Allocate a block of memory with a minimum of 'size' bytes.
*
* @param size is the minimum size of the requested block in bytes.
*/
void
*
rt_malloc
(
rt_size_t
size
)
{
void
*
ptr
;
...
...
@@ -804,7 +882,6 @@ void *rt_malloc(rt_size_t size)
}
}
#ifdef RT_USING_MEMTRACE
if
(
ptr
==
RT_NULL
)
{
...
...
@@ -826,12 +903,27 @@ void *rt_malloc(rt_size_t size)
}
RTM_EXPORT
(
rt_malloc
);
/**
* @brief This function will release the previously allocated memory block by
* rt_malloc. The released memory block is taken back to system heap.
*
* @param rmem the address of memory which will be released.
*/
void
rt_free
(
void
*
rmem
)
{
rt_memheap_free
(
rmem
);
}
RTM_EXPORT
(
rt_free
);
/**
* @brief This function will change the size of previously allocated memory block.
*
* @param rmem is the pointer to memory allocated by rt_malloc.
*
* @param newsize is the required new size.
*
* @return the changed memory block address.
*/
void
*
rt_realloc
(
void
*
rmem
,
rt_size_t
newsize
)
{
void
*
new_ptr
;
...
...
@@ -892,6 +984,19 @@ void *rt_realloc(void *rmem, rt_size_t newsize)
}
RTM_EXPORT
(
rt_realloc
);
/**
* @brief This function will contiguously allocate enough space for count objects
* that are size bytes of memory each and returns a pointer to the allocated
* memory.
*
* @note The allocated memory is filled with bytes of value zero.
*
* @param count is the number of objects to allocate.
*
* @param size is the size of one object to allocate.
*
* @return pointer to allocated memory pointer.
*/
void
*
rt_calloc
(
rt_size_t
count
,
rt_size_t
size
)
{
void
*
ptr
;
...
...
@@ -922,6 +1027,16 @@ void *rt_calloc(rt_size_t count, rt_size_t size)
}
RTM_EXPORT
(
rt_calloc
);
/**
* @brief This function will caculate the total memory, the used memory, and
* the max used memory.
*
* @param total is a pointer to get the total size of the memory.
*
* @param used is a pointer to get the size of memory used.
*
* @param max_used is a pointer to get the maximum memory used.
*/
void
rt_memory_info
(
rt_uint32_t
*
total
,
rt_uint32_t
*
used
,
rt_uint32_t
*
max_used
)
...
...
@@ -940,12 +1055,16 @@ void rt_memory_info(rt_uint32_t *total,
#ifdef RT_USING_MEMTRACE
/**
* @brief This function will print the used memheap infomation.
*
* @param memheap is a pointer of the memheap object.
*/
void
dump_used_memheap
(
struct
rt_memheap
*
mh
)
{
struct
rt_memheap_item
*
header_ptr
;
rt_uint32_t
block_size
;
rt_kprintf
(
"
\n
memory heap address:
\n
"
);
rt_kprintf
(
"heap_ptr: 0x%08x
\n
"
,
mh
->
start_addr
);
rt_kprintf
(
"free : 0x%08x
\n
"
,
mh
->
available_size
);
...
...
src/mempool.c
浏览文件 @
f76a192f
...
...
@@ -32,8 +32,8 @@ static void (*rt_mp_free_hook)(struct rt_mempool *mp, void *block);
/**@{*/
/**
* This function will set a hook function, which will be invoked when a memory
*
block is allocated from
memory pool.
*
@brief
This function will set a hook function, which will be invoked when a memory
*
block is allocated from the
memory pool.
*
* @param hook the hook function
*/
...
...
@@ -43,8 +43,8 @@ void rt_mp_alloc_sethook(void (*hook)(struct rt_mempool *mp, void *block))
}
/**
* This function will set a hook function, which will be invoked when a memory
*
block is released to
memory pool.
*
@brief
This function will set a hook function, which will be invoked when a memory
*
block is released to the
memory pool.
*
* @param hook the hook function
*/
...
...
@@ -63,14 +63,18 @@ void rt_mp_free_sethook(void (*hook)(struct rt_mempool *mp, void *block))
/**@{*/
/**
* This function will initialize a memory pool object, normally which is used
* for static object.
*
@brief
This function will initialize a memory pool object, normally which is used
*
for static object.
*
* @param mp the memory pool object
* @param name the name of memory pool
* @param start the star address of memory pool
* @param size the total size of memory pool
* @param block_size the size for each block
* @param mp is the memory pool object.
*
* @param name is the name of the memory pool.
*
* @param start is the start address of the memory pool.
*
* @param size is the total size of the memory pool.
*
* @param block_size is the size for each block..
*
* @return RT_EOK
*/
...
...
@@ -125,9 +129,9 @@ rt_err_t rt_mp_init(struct rt_mempool *mp,
RTM_EXPORT
(
rt_mp_init
);
/**
* This function will detach a memory pool from system object management.
*
@brief
This function will detach a memory pool from system object management.
*
* @param
mp the memory pool object
* @param
mp is the memory pool object.
*
* @return RT_EOK
*/
...
...
@@ -172,12 +176,14 @@ RTM_EXPORT(rt_mp_detach);
#ifdef RT_USING_HEAP
/**
* This function will create a mempool object and allocate the memory pool from
* heap.
*
@brief
This function will create a mempool object and allocate the memory pool from
*
heap.
*
* @param name the name of memory pool
* @param block_count the count of blocks in memory pool
* @param block_size the size for each block
* @param name is the name of memory pool.
*
* @param block_count is the count of blocks in memory pool.
*
* @param block_size is the size for each block.
*
* @return the created mempool object
*/
...
...
@@ -241,9 +247,9 @@ rt_mp_t rt_mp_create(const char *name,
RTM_EXPORT
(
rt_mp_create
);
/**
* This function will delete a memory pool and release the object memory.
*
@brief
This function will delete a memory pool and release the object memory.
*
* @param mp
the memory pool object
* @param mp
is the memory pool object.
*
* @return RT_EOK
*/
...
...
@@ -293,12 +299,14 @@ RTM_EXPORT(rt_mp_delete);
#endif
/* RT_USING_HEAP */
/**
* This function will allocate a block from memory pool
* @brief This function will allocate a block from memory pool.
*
* @param mp is the memory pool object.
*
* @param
mp the memory pool object
*
@param time the waiting time
* @param
time is the maximum waiting time for allocating memory.
*
- 0 for not waiting, allocating memory immediately.
*
* @return the allocated memory block or RT_NULL on allocated failed
* @return the allocated memory block or RT_NULL on allocated failed
.
*/
void
*
rt_mp_alloc
(
rt_mp_t
mp
,
rt_int32_t
time
)
{
...
...
@@ -392,9 +400,9 @@ void *rt_mp_alloc(rt_mp_t mp, rt_int32_t time)
RTM_EXPORT
(
rt_mp_alloc
);
/**
*
This function will release a memory block
*
@brief This function will release a memory block.
*
* @param block the address of memory block to be released
* @param block the address of memory block to be released
.
*/
void
rt_mp_free
(
void
*
block
)
{
...
...
src/object.c
浏览文件 @
f76a192f
...
...
@@ -120,10 +120,10 @@ void (*rt_object_put_hook)(struct rt_object *object);
/**@{*/
/**
* This function will set a hook function, which will be invoked when object
* attaches to kernel object system.
*
@brief
This function will set a hook function, which will be invoked when object
*
attaches to kernel object system.
*
* @param hook
the hook function
* @param hook
is the hook function.
*/
void
rt_object_attach_sethook
(
void
(
*
hook
)(
struct
rt_object
*
object
))
{
...
...
@@ -131,10 +131,10 @@ void rt_object_attach_sethook(void (*hook)(struct rt_object *object))
}
/**
* This function will set a hook function, which will be invoked when object
* detaches from kernel object system.
*
@brief
This function will set a hook function, which will be invoked when object
*
detaches from kernel object system.
*
* @param hook the hook function
* @param hook
is
the hook function
*/
void
rt_object_detach_sethook
(
void
(
*
hook
)(
struct
rt_object
*
object
))
{
...
...
@@ -142,17 +142,17 @@ void rt_object_detach_sethook(void (*hook)(struct rt_object *object))
}
/**
* This function will set a hook function, which will be invoked when object
* is taken from kernel object system.
*
@brief
This function will set a hook function, which will be invoked when object
*
is taken from kernel object system.
*
* The object is taken means:
* semaphore - semaphore is taken by thread
* mutex - mutex is taken by thread
* event - event is received by thread
* mailbox - mail is received by thread
* message queue - message is received by thread
*
The object is taken means:
*
semaphore - semaphore is taken by thread
*
mutex - mutex is taken by thread
*
event - event is received by thread
*
mailbox - mail is received by thread
*
message queue - message is received by thread
*
* @param hook
the hook function
* @param hook
is the hook function.
*/
void
rt_object_trytake_sethook
(
void
(
*
hook
)(
struct
rt_object
*
object
))
{
...
...
@@ -160,18 +160,18 @@ void rt_object_trytake_sethook(void (*hook)(struct rt_object *object))
}
/**
* This function will set a hook function, which will be invoked when object
* have been taken from kernel object system.
*
* The object have been taken means:
* semaphore - semaphore have been taken by thread
* mutex - mutex have been taken by thread
* event - event have been received by thread
* mailbox - mail have been received by thread
* message queue - message have been received by thread
* timer - timer is started
*
* @param hook the hook function
*
@brief
This function will set a hook function, which will be invoked when object
*
have been taken from kernel object system.
*
*
The object have been taken means:
*
semaphore - semaphore have been taken by thread
*
mutex - mutex have been taken by thread
*
event - event have been received by thread
*
mailbox - mail have been received by thread
*
message queue - message have been received by thread
*
timer - timer is started
*
* @param hook the hook function
.
*/
void
rt_object_take_sethook
(
void
(
*
hook
)(
struct
rt_object
*
object
))
{
...
...
@@ -179,10 +179,10 @@ void rt_object_take_sethook(void (*hook)(struct rt_object *object))
}
/**
* This function will set a hook function, which will be invoked when object
* is put to kernel object system.
*
@brief
This function will set a hook function, which will be invoked when object
*
is put to kernel object system.
*
* @param hook the hook function
* @param hook
is
the hook function
*/
void
rt_object_put_sethook
(
void
(
*
hook
)(
struct
rt_object
*
object
))
{
...
...
@@ -199,9 +199,9 @@ void rt_object_put_sethook(void (*hook)(struct rt_object *object))
/**@{*/
/**
* This function will return the specified type of object information.
*
@brief
This function will return the specified type of object information.
*
* @param type the type of object, which can be
* @param type
is
the type of object, which can be
* RT_Object_Class_Thread/Semaphore/Mutex... etc
*
* @return the object type information or RT_NULL
...
...
@@ -219,10 +219,11 @@ rt_object_get_information(enum rt_object_class_type type)
RTM_EXPORT
(
rt_object_get_information
);
/**
* This function will return the length of object list in object container.
*
@brief
This function will return the length of object list in object container.
*
* @param type the type of object, which can be
* @param type
is
the type of object, which can be
* RT_Object_Class_Thread/Semaphore/Mutex... etc
*
* @return the length of object list
*/
int
rt_object_get_length
(
enum
rt_object_class_type
type
)
...
...
@@ -248,15 +249,17 @@ int rt_object_get_length(enum rt_object_class_type type)
RTM_EXPORT
(
rt_object_get_length
);
/**
* This function will copy the object pointer of the specified type,
* with the maximum size specified by maxlen.
*
@brief
This function will copy the object pointer of the specified type,
*
with the maximum size specified by maxlen.
*
* @param type the type of object, which can be
* @param type
is
the type of object, which can be
* RT_Object_Class_Thread/Semaphore/Mutex... etc
* @param pointers the pointers will be saved to
* @param maxlen the maximum number of pointers can be saved
*
* @return the copied number of object pointers
* @param pointers is the pointer will be saved to.
*
* @param maxlen is the maximum number of pointers can be saved.
*
* @return the copied number of object pointers.
*/
int
rt_object_get_pointers
(
enum
rt_object_class_type
type
,
rt_object_t
*
pointers
,
int
maxlen
)
{
...
...
@@ -290,12 +293,14 @@ int rt_object_get_pointers(enum rt_object_class_type type, rt_object_t *pointers
RTM_EXPORT
(
rt_object_get_pointers
);
/**
* This function will initialize an object and add it to object system
* management.
*
@brief
This function will initialize an object and add it to object system
*
management.
*
* @param object the specified object to be initialized.
* @param type the object type.
* @param name the object name. In system, the object's name must be unique.
* @param object is the specified object to be initialized.
*
* @param type is the object type.
*
* @param name is the object name. In system, the object's name must be unique.
*/
void
rt_object_init
(
struct
rt_object
*
object
,
enum
rt_object_class_type
type
,
...
...
@@ -361,8 +366,8 @@ void rt_object_init(struct rt_object *object,
}
/**
* This function will detach a static object from object system,
* and the memory of static object is not freed.
*
@brief
This function will detach a static object from object system,
*
and the memory of static object is not freed.
*
* @param object the specified object to be detached.
*/
...
...
@@ -390,10 +395,11 @@ void rt_object_detach(rt_object_t object)
#ifdef RT_USING_HEAP
/**
* This function will allocate an object from object system
* @brief This function will allocate an object from object system.
*
* @param type is the type of object.
*
* @param type the type of object
* @param name the object name. In system, the object's name must be unique.
* @param name is the object name. In system, the object's name must be unique.
*
* @return object
*/
...
...
@@ -459,9 +465,9 @@ rt_object_t rt_object_allocate(enum rt_object_class_type type, const char *name)
}
/**
* This function will delete an object and release object memory.
*
@brief
This function will delete an object and release object memory.
*
* @param object the specified object to be deleted.
* @param object
is
the specified object to be deleted.
*/
void
rt_object_delete
(
rt_object_t
object
)
{
...
...
@@ -491,11 +497,12 @@ void rt_object_delete(rt_object_t object)
#endif
/* RT_USING_HEAP */
/**
* This function will judge the object is system object or not.
* Normally, the system object is a static object and the type
* of object set to RT_Object_Class_Static.
* @brief This function will judge the object is system object or not.
*
* @param object the specified object to be judged.
* @note Normally, the system object is a static object and the type
* of object set to RT_Object_Class_Static.
*
* @param object is the specified object to be judged.
*
* @return RT_TRUE if a system object, RT_FALSE for others.
*/
...
...
@@ -511,10 +518,10 @@ rt_bool_t rt_object_is_systemobject(rt_object_t object)
}
/**
* This function will return the type of object without
* RT_Object_Class_Static flag.
*
@brief
This function will return the type of object without
*
RT_Object_Class_Static flag.
*
* @param object the specified object to be get type.
* @param object
is
the specified object to be get type.
*
* @return the type of object.
*/
...
...
@@ -527,11 +534,12 @@ rt_uint8_t rt_object_get_type(rt_object_t object)
}
/**
* This function will find specified name object from object
* container.
* @brief This function will find specified name object from object
* container.
*
* @param name is the specified name of object.
*
* @param name the specified name of object.
* @param type the type of object
* @param type is the type of object
*
* @return the found object or RT_NULL if there is no this object
* in object container.
...
...
src/scheduler.c
浏览文件 @
f76a192f
...
...
@@ -58,19 +58,23 @@ static void (*rt_scheduler_switch_hook)(struct rt_thread *tid);
/**@{*/
/**
* This function will set a hook function, which will be invoked when thread
* switch happens.
*
@brief
This function will set a hook function, which will be invoked when thread
*
switch happens.
*
* @param hook
the hook function
* @param hook
is the hook function.
*/
void
rt_scheduler_sethook
(
void
(
*
hook
)(
struct
rt_thread
*
from
,
struct
rt_thread
*
to
))
void
rt_scheduler_sethook
(
void
(
*
hook
)(
struct
rt_thread
*
from
,
struct
rt_thread
*
to
))
{
rt_scheduler_hook
=
hook
;
}
void
rt_scheduler_switch_sethook
(
void
(
*
hook
)(
struct
rt_thread
*
tid
))
/**
* @brief This function will set a hook function, which will be invoked when context
* switch happens.
*
* @param hook is the hook function.
*/
void
rt_scheduler_switch_sethook
(
void
(
*
hook
)(
struct
rt_thread
*
tid
))
{
rt_scheduler_switch_hook
=
hook
;
}
...
...
@@ -181,8 +185,7 @@ static struct rt_thread* _scheduler_get_highest_priority_thread(rt_ubase_t *high
#endif
/* RT_USING_SMP */
/**
* @ingroup SystemInit
* This function will initialize the system scheduler
* @brief This function will initialize the system scheduler.
*/
void
rt_system_scheduler_init
(
void
)
{
...
...
@@ -232,9 +235,8 @@ void rt_system_scheduler_init(void)
}
/**
* @ingroup SystemInit
* This function will startup scheduler. It will select one thread
* with the highest priority level, then switch to it.
* @brief This function will startup the scheduler. It will select one thread
* with the highest priority level, then switch to it.
*/
void
rt_system_scheduler_start
(
void
)
{
...
...
@@ -271,12 +273,13 @@ void rt_system_scheduler_start(void)
#ifdef RT_USING_SMP
/**
*
This function will handle IPI interrupt and do a scheduling in system;
*
@brief This function will handle IPI interrupt and do a scheduling in system.
*
* @param vector, the number of IPI interrupt for system scheduling
* @param param, use RT_NULL
* @param vector is the number of IPI interrupt for system scheduling.
*
* NOTE: this function should be invoke or register as ISR in BSP.
* @param param is not used, and can be set to RT_NULL.
*
* @note this function should be invoke or register as ISR in BSP.
*/
void
rt_scheduler_ipi_handler
(
int
vector
,
void
*
param
)
{
...
...
@@ -284,9 +287,9 @@ void rt_scheduler_ipi_handler(int vector, void *param)
}
/**
* This function will perform one scheduling. It will select one thread
* with the highest priority level in global ready queue or local ready queue,
* then switch to it.
*
@brief
This function will perform one scheduling. It will select one thread
*
with the highest priority level in global ready queue or local ready queue,
*
then switch to it.
*/
void
rt_schedule
(
void
)
{
...
...
@@ -407,8 +410,8 @@ __exit:
}
#else
/**
*
This function will perform one schedul
e. It will select one thread
*
with the highest priority level
, and switch to it immediately.
*
@brief This function will perform scheduling onc
e. It will select one thread
*
with the highest priority
, and switch to it immediately.
*/
void
rt_schedule
(
void
)
{
...
...
@@ -536,9 +539,9 @@ __exit:
#endif
/* RT_USING_SMP */
/**
*
This function checks if a scheduling is needed after IRQ context
. If yes,
* it will select one thread with the highest priority level, and then switch
* to it.
*
@brief This function checks whether a scheduling is needed after an IRQ context switching
. If yes,
*
it will select one thread with the highest priority level, and then switch
*
to it.
*/
#ifdef RT_USING_SMP
void
rt_scheduler_do_irq_switch
(
void
*
context
)
...
...
@@ -631,12 +634,13 @@ void rt_scheduler_do_irq_switch(void *context)
}
#endif
/* RT_USING_SMP */
/*
* This function will insert a thread to system ready queue. The state of
* thread will be set as READY and remove from suspend queue.
/**
* @brief This function will insert a thread to the system ready queue. The state of
* thread will be set as READY and the thread will be removed from suspend queue.
*
* @param thread is the thread to be inserted.
*
* @param thread the thread to be inserted
* @note Please do not invoke this function in user application.
* @note Please do not invoke this function in user application.
*/
#ifdef RT_USING_SMP
void
rt_schedule_insert_thread
(
struct
rt_thread
*
thread
)
...
...
@@ -741,12 +745,12 @@ __exit:
}
#endif
/* RT_USING_SMP */
/*
* This function will remove a thread from system ready queue.
/*
*
*
@brief
This function will remove a thread from system ready queue.
*
* @param thread
the thread to be removed
* @param thread
is the thread to be removed.
*
* @note Please do not invoke this function in user application.
* @note
Please do not invoke this function in user application.
*/
#ifdef RT_USING_SMP
void
rt_schedule_remove_thread
(
struct
rt_thread
*
thread
)
...
...
@@ -835,7 +839,7 @@ void rt_schedule_remove_thread(struct rt_thread *thread)
#endif
/* RT_USING_SMP */
/**
* This function will lock the thread scheduler.
*
@brief
This function will lock the thread scheduler.
*/
#ifdef RT_USING_SMP
void
rt_enter_critical
(
void
)
...
...
@@ -897,7 +901,7 @@ void rt_enter_critical(void)
RTM_EXPORT
(
rt_enter_critical
);
/**
* This function will unlock the thread scheduler.
*
@brief
This function will unlock the thread scheduler.
*/
#ifdef RT_USING_SMP
void
rt_exit_critical
(
void
)
...
...
@@ -971,7 +975,7 @@ void rt_exit_critical(void)
RTM_EXPORT
(
rt_exit_critical
);
/**
*
Get the scheduler lock level
*
@brief Get the scheduler lock level.
*
* @return the level of the scheduler lock. 0 means unlocked.
*/
...
...
src/slab.c
浏览文件 @
f76a192f
...
...
@@ -74,10 +74,10 @@ static void (*rt_free_hook)(void *ptr);
/**@{*/
/**
* This function will set a hook function, which will be invoked when a memory
* block is allocated from heap memory.
*
@brief
This function will set a hook function, which will be invoked when a memory
*
block is allocated from heap memory.
*
* @param hook the hook function
* @param hook the hook function
.
*/
void
rt_malloc_sethook
(
void
(
*
hook
)(
void
*
ptr
,
rt_size_t
size
))
{
...
...
@@ -86,8 +86,8 @@ void rt_malloc_sethook(void (*hook)(void *ptr, rt_size_t size))
RTM_EXPORT
(
rt_malloc_sethook
);
/**
* This function will set a hook function, which will be invoked when a memory
* block is released to heap memory.
*
@brief
This function will set a hook function, which will be invoked when a memory
*
block is released to heap memory.
*
* @param hook the hook function
*/
...
...
@@ -233,6 +233,11 @@ struct rt_page_head
static
struct
rt_page_head
*
rt_page_list
;
static
struct
rt_semaphore
heap_sem
;
/**
* @brief Alloc memory size by page.
*
* @param npages the number of pages.
*/
void
*
rt_page_alloc
(
rt_size_t
npages
)
{
struct
rt_page_head
*
b
,
*
n
;
...
...
@@ -269,6 +274,13 @@ void *rt_page_alloc(rt_size_t npages)
return
b
;
}
/**
* @brief Free memory by page.
*
* @param addr is the head address of first page.
*
* @param npages is the number of pages.
*/
void
rt_page_free
(
void
*
addr
,
rt_size_t
npages
)
{
struct
rt_page_head
*
b
,
*
n
;
...
...
@@ -334,12 +346,11 @@ static void rt_page_init(void *addr, rt_size_t npages)
}
/**
* @
ingroup SystemInit
* @
brief This function will init system heap.
*
*
This function will init system heap
*
@param begin_addr the beginning address of system page.
*
* @param begin_addr the beginning address of system page
* @param end_addr the end address of system page
* @param end_addr the end address of system page.
*/
void
rt_system_heap_init
(
void
*
begin_addr
,
void
*
end_addr
)
{
...
...
@@ -465,15 +476,15 @@ rt_inline int zoneindex(rt_size_t *bytes)
/**@{*/
/**
* This function will allocate a block from system heap memory.
*
- If the nbytes is less than zero,
*
or
*
- If there is no nbytes sized memory valid in system,
*
the RT_NULL is returned
.
*
@brief
This function will allocate a block from system heap memory.
*
*
@note the RT_NULL is returned if
*
- the nbytes is less than zero.
*
- there is no nbytes sized memory valid in system
.
*
* @param size
the size of memory to be allocated
* @param size
is the size of memory to be allocated.
*
* @return the allocated memory
* @return the allocated memory
.
*/
void
*
rt_malloc
(
rt_size_t
size
)
{
...
...
@@ -668,12 +679,13 @@ __exit:
RTM_EXPORT
(
rt_malloc
);
/**
* This function will change the size of previously allocated memory block.
* @brief This function will change the size of previously allocated memory block.
*
* @param ptr is the previously allocated memory block.
*
* @param ptr the previously allocated memory block
* @param size the new size of memory block
* @param size is the new size of memory block.
*
* @return the allocated memory
* @return the allocated memory
.
*/
void
*
rt_realloc
(
void
*
ptr
,
rt_size_t
size
)
{
...
...
@@ -736,16 +748,17 @@ void *rt_realloc(void *ptr, rt_size_t size)
RTM_EXPORT
(
rt_realloc
);
/**
* This function will contiguously allocate enough space for count objects
* that are size bytes of memory each and returns a pointer to the allocated
* memory.
*
@brief
This function will contiguously allocate enough space for count objects
*
that are size bytes of memory each and returns a pointer to the allocated
*
memory.
*
* The allocated memory is filled with bytes of value zero.
*
@note
The allocated memory is filled with bytes of value zero.
*
* @param count number of objects to allocate
* @param size size of the objects to allocate
* @param count is the number of objects to allocate.
*
* @return pointer to allocated memory / NULL pointer if there is an error
* @param size is the size of the objects to allocate.
*
* @return pointer to allocated memory / NULL pointer if there is an error.
*/
void
*
rt_calloc
(
rt_size_t
count
,
rt_size_t
size
)
{
...
...
@@ -763,10 +776,11 @@ void *rt_calloc(rt_size_t count, rt_size_t size)
RTM_EXPORT
(
rt_calloc
);
/**
* This function will release the previous allocated memory block by rt_malloc.
* The released memory block is taken back to system heap.
* @brief This function will release the previous allocated memory block by rt_malloc.
*
* @note The released memory block is taken back to system heap.
*
* @param ptr the address of memory which will be released
* @param ptr
is
the address of memory which will be released
*/
void
rt_free
(
void
*
ptr
)
{
...
...
@@ -905,6 +919,16 @@ void rt_free(void *ptr)
RTM_EXPORT
(
rt_free
);
#ifdef RT_MEM_STATS
/**
* @brief This function will caculate the total memory, the used memory, and
* the max used memory.
*
* @param total is a pointer to get the total size of the memory.
*
* @param used is a pointer to get the size of memory used.
*
* @param max_used is a pointer to get the maximum memory used.
*/
void
rt_memory_info
(
rt_uint32_t
*
total
,
rt_uint32_t
*
used
,
rt_uint32_t
*
max_used
)
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录