Skip to content

Commit 4bcb294

Browse files
committed
doc: move usermode API documentation
Move API reference to the main documentation section under the kernel. Signed-off-by: Anas Nashif <[email protected]>
1 parent 3499312 commit 4bcb294

File tree

5 files changed

+17
-41
lines changed

5 files changed

+17
-41
lines changed

doc/api/kernel_api.rst

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,6 @@ as described in the :ref:`kernel`.
1919
.. doxygengroup:: kernel_apis
2020
2121
22-
Profiling
23-
*********
24-
25-
.. doxygengroup:: profiling_apis
26-
:project: Zephyr
27-
2822
2923
Kernel Version
3024
**************
@@ -34,15 +28,3 @@ Kernel version handling and APIs related to kernel version being used.
3428
:project: Zephyr
3529
:content-only:
3630

37-
Memory Domain
38-
*************
39-
40-
A memory domain contains some number of memory partitions. Threads can
41-
specify the range and attribute (access permission) for memory partitions
42-
in a memory domain. Threads in the same memory domain have the
43-
same access permissions to the memory partitions belong to the
44-
memory domain.
45-
(See :ref:`memory_domain`.)
46-
47-
.. doxygengroup:: mem_domain_apis
48-
:project: Zephyr

doc/kernel/usermode/kernelobjects.rst

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -277,16 +277,8 @@ Related configuration options:
277277
* :option:`CONFIG_APPLICATION_MEMORY`
278278
* :option:`CONFIG_MAX_THREAD_BYTES`
279279

280-
APIs
281-
****
282-
283-
* :c:func:`k_object_access_grant()`
284-
* :c:func:`k_object_access_revoke()`
285-
* :c:func:`k_object_access_all_grant()`
286-
* :c:func:`k_object_alloc()`
287-
* :c:func:`k_object_free()`
288-
* :c:func:`k_object_release()`
289-
* :c:func:`k_thread_access_grant()`
290-
* :c:func:`k_thread_user_mode_enter()`
291-
* :c:macro:`K_THREAD_ACCESS_GRANT()`
280+
API Reference
281+
*************
292282

283+
.. doxygengroup:: usermode_apis
284+
:project: Zephyr

doc/kernel/usermode/memory_domain.rst

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -176,15 +176,10 @@ Related configuration options:
176176

177177
* :option:`CONFIG_MAX_DOMAIN_PARTITIONS`
178178

179-
APIs
180-
****
179+
API Reference
180+
*************
181181

182182
The following memory domain APIs are provided by :zephyr_file:`include/kernel.h`:
183183

184-
* :c:macro:`K_MEM_PARTITION_DEFINE`
185-
* :cpp:func:`k_mem_domain_init()`
186-
* :cpp:func:`k_mem_domain_destroy()`
187-
* :cpp:func:`k_mem_domain_add_partition()`
188-
* :cpp:func:`k_mem_domain_remove_partition()`
189-
* :cpp:func:`k_mem_domain_add_thread()`
190-
* :cpp:func:`k_mem_domain_remove_thread()`
184+
.. doxygengroup:: mem_domain_apis
185+
:project: Zephyr

doc/zephyr.doxyfile.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1974,6 +1974,7 @@ PREDEFINED = "CONFIG_SYS_CLOCK_EXISTS=y" \
19741974
"CONFIG_THREAD_MONITOR=y" \
19751975
"CONFIG_NET_MGMT_EVENT=y" \
19761976
"CONFIG_THREAD_CUSTOM_DATA=y" \
1977+
"CONFIG_SCHED_DEADLINE=y" \
19771978
"CONFIG_ERRNO=y" \
19781979
"CONFIG_THREAD_STACK_INFO=y" \
19791980
"CONFIG_UART_INTERRUPT_DRIVEN=y" \

include/kernel.h

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,11 @@ enum k_objects {
149149

150150
K_OBJ_LAST
151151
};
152+
/**
153+
* @defgroup usermode_apis User Mode APIs
154+
* @ingroup kernel_apis
155+
* @{
156+
*/
152157

153158
#ifdef CONFIG_USERSPACE
154159
/* Table generated by gperf, these objects are retrieved via
@@ -334,6 +339,8 @@ static inline void k_obj_free(void *obj)
334339
}
335340
#endif /* CONFIG_DYNAMIC_OBJECTS */
336341

342+
/** @} */
343+
337344
/* Using typedef deliberately here, this is quite intended to be an opaque
338345
* type. K_THREAD_STACK_BUFFER() should be used to access the data within.
339346
*
@@ -583,8 +590,7 @@ enum execution_context_types {
583590
};
584591

585592
/**
586-
* @defgroup profiling_apis Profiling APIs
587-
* @ingroup kernel_apis
593+
* @addtogroup thread_apis
588594
* @{
589595
*/
590596
typedef void (*k_thread_user_cb_t)(const struct k_thread *thread,

0 commit comments

Comments
 (0)