michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: move usermode API documentation

Browse source 
Move API reference to the main documentation section under the kernel.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2019-01-23 23:06:29 -05:00
commit 4bcb294f45
5 changed files with 17 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

18
doc/api/kernel_api.rst
View file

@ -19,12 +19,6 @@ as described in the :ref:`kernel`.
.. doxygengroup:: kernel_apis
Profiling
*********
.. doxygengroup:: profiling_apis
:project: Zephyr
Kernel Version
**************
@ -34,15 +28,3 @@ Kernel version handling and APIs related to kernel version being used.
:project: Zephyr
:content-only:
Memory Domain
*************
A memory domain contains some number of memory partitions. Threads can
specify the range and attribute (access permission) for memory partitions
in a memory domain. Threads in the same memory domain have the
same access permissions to the memory partitions belong to the
memory domain.
(See :ref:`memory_domain`.)
.. doxygengroup:: mem_domain_apis
:project: Zephyr

16
doc/kernel/usermode/kernelobjects.rst
View file

@ -277,16 +277,8 @@ Related configuration options:
* :option:`CONFIG_APPLICATION_MEMORY`
* :option:`CONFIG_MAX_THREAD_BYTES`
APIs
****
* :c:func:`k_object_access_grant()`
* :c:func:`k_object_access_revoke()`
* :c:func:`k_object_access_all_grant()`
* :c:func:`k_object_alloc()`
* :c:func:`k_object_free()`
* :c:func:`k_object_release()`
* :c:func:`k_thread_access_grant()`
* :c:func:`k_thread_user_mode_enter()`
* :c:macro:`K_THREAD_ACCESS_GRANT()`
API Reference
*************
.. doxygengroup:: usermode_apis
:project: Zephyr

13
doc/kernel/usermode/memory_domain.rst
View file

@ -176,15 +176,10 @@ Related configuration options:
* :option:`CONFIG_MAX_DOMAIN_PARTITIONS`
APIs
****
API Reference
*************
The following memory domain APIs are provided by :zephyr_file:`include/kernel.h`:
* :c:macro:`K_MEM_PARTITION_DEFINE`
* :cpp:func:`k_mem_domain_init()`
* :cpp:func:`k_mem_domain_destroy()`
* :cpp:func:`k_mem_domain_add_partition()`
* :cpp:func:`k_mem_domain_remove_partition()`
* :cpp:func:`k_mem_domain_add_thread()`
* :cpp:func:`k_mem_domain_remove_thread()`
.. doxygengroup:: mem_domain_apis
:project: Zephyr

1
doc/zephyr.doxyfile.in
View file

@ -1974,6 +1974,7 @@ PREDEFINED = "CONFIG_SYS_CLOCK_EXISTS=y" \
"CONFIG_THREAD_MONITOR=y" \
"CONFIG_NET_MGMT_EVENT=y" \
"CONFIG_THREAD_CUSTOM_DATA=y" \
"CONFIG_SCHED_DEADLINE=y" \
"CONFIG_ERRNO=y" \
"CONFIG_THREAD_STACK_INFO=y" \
"CONFIG_UART_INTERRUPT_DRIVEN=y" \

10
include/kernel.h
View file

@ -149,6 +149,11 @@ enum k_objects {
K_OBJ_LAST
};
/**
* @defgroup usermode_apis User Mode APIs
* @ingroup kernel_apis
* @{
*/
#ifdef CONFIG_USERSPACE
/* Table generated by gperf, these objects are retrieved via
@ -334,6 +339,8 @@ static inline void k_obj_free(void *obj)
}
#endif /* CONFIG_DYNAMIC_OBJECTS */
/** @} */
/* Using typedef deliberately here, this is quite intended to be an opaque
* type. K_THREAD_STACK_BUFFER() should be used to access the data within.
*
@ -583,8 +590,7 @@ enum execution_context_types {
};
/**
* @defgroup profiling_apis Profiling APIs
* @ingroup kernel_apis
* @addtogroup thread_apis
* @{
*/
typedef void (*k_thread_user_cb_t)(const struct k_thread *thread,