Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
kernel.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2016, Wind River Systems, Inc.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
12
13#ifndef ZEPHYR_INCLUDE_KERNEL_H_
14#define ZEPHYR_INCLUDE_KERNEL_H_
15
16#if !defined(_ASMLANGUAGE)
18#include <errno.h>
19#include <limits.h>
20#include <stdbool.h>
21#include <zephyr/toolchain.h>
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
31/*
32 * Zephyr currently assumes the size of a couple standard types to simplify
33 * print string formats. Let's make sure this doesn't change without notice.
34 */
35BUILD_ASSERT(sizeof(int32_t) == sizeof(int));
36BUILD_ASSERT(sizeof(int64_t) == sizeof(long long));
37BUILD_ASSERT(sizeof(intptr_t) == sizeof(long));
38
47
48#define K_ANY NULL
49
50#if (CONFIG_NUM_COOP_PRIORITIES + CONFIG_NUM_PREEMPT_PRIORITIES) == 0
51#error Zero available thread priorities defined!
52#endif
53
54#define K_PRIO_COOP(x) (-(CONFIG_NUM_COOP_PRIORITIES - (x)))
55#define K_PRIO_PREEMPT(x) (x)
56
57#define K_HIGHEST_THREAD_PRIO (-CONFIG_NUM_COOP_PRIORITIES)
58#define K_LOWEST_THREAD_PRIO CONFIG_NUM_PREEMPT_PRIORITIES
59#define K_IDLE_PRIO K_LOWEST_THREAD_PRIO
60#define K_HIGHEST_APPLICATION_THREAD_PRIO (K_HIGHEST_THREAD_PRIO)
61#define K_LOWEST_APPLICATION_THREAD_PRIO (K_LOWEST_THREAD_PRIO - 1)
62
63#ifdef CONFIG_POLL
64#define Z_POLL_EVENT_OBJ_INIT(obj) \
65 .poll_events = SYS_DLIST_STATIC_INIT(&obj.poll_events),
66#define Z_DECL_POLL_EVENT sys_dlist_t poll_events;
67#else
68#define Z_POLL_EVENT_OBJ_INIT(obj)
69#define Z_DECL_POLL_EVENT
70#endif
71
72struct k_thread;
73struct k_mutex;
74struct k_sem;
75struct k_msgq;
76struct k_mbox;
77struct k_pipe;
78struct k_queue;
79struct k_fifo;
80struct k_lifo;
81struct k_stack;
82struct k_mem_slab;
83struct k_timer;
84struct k_poll_event;
85struct k_poll_signal;
86struct k_mem_domain;
87struct k_mem_partition;
88struct k_futex;
89struct k_event;
90
96
97/* private, used by k_poll and k_work_poll */
98struct k_work_poll;
99typedef int (*_poller_cb_t)(struct k_poll_event *event, uint32_t state);
100
105
119static inline void
121{
122#ifdef CONFIG_SCHED_THREAD_USAGE_ANALYSIS
123 thread->base.usage.longest = 0ULL;
124#endif
125}
126
127typedef void (*k_thread_user_cb_t)(const struct k_thread *thread,
128 void *user_data);
129
145void k_thread_foreach(k_thread_user_cb_t user_cb, void *user_data);
146
165#ifdef CONFIG_SMP
166void k_thread_foreach_filter_by_cpu(unsigned int cpu,
167 k_thread_user_cb_t user_cb, void *user_data);
168#else
169static inline
170void k_thread_foreach_filter_by_cpu(unsigned int cpu,
171 k_thread_user_cb_t user_cb, void *user_data)
172{
173 __ASSERT(cpu == 0, "cpu filter out of bounds");
174 ARG_UNUSED(cpu);
175 k_thread_foreach(user_cb, user_data);
176}
177#endif
178
207 k_thread_user_cb_t user_cb, void *user_data);
208
240#ifdef CONFIG_SMP
242 k_thread_user_cb_t user_cb, void *user_data);
243#else
244static inline
245void k_thread_foreach_unlocked_filter_by_cpu(unsigned int cpu,
246 k_thread_user_cb_t user_cb, void *user_data)
247{
248 __ASSERT(cpu == 0, "cpu filter out of bounds");
249 ARG_UNUSED(cpu);
250 k_thread_foreach_unlocked(user_cb, user_data);
251}
252#endif
253
255
261
262#endif /* !_ASMLANGUAGE */
263
264
265/*
266 * Thread user options. May be needed by assembly code. Common part uses low
267 * bits, arch-specific use high bits.
268 */
269
273#define K_ESSENTIAL (BIT(0))
274
275#define K_FP_IDX 1
285#define K_FP_REGS (BIT(K_FP_IDX))
286
293#define K_USER (BIT(2))
294
303#define K_INHERIT_PERMS (BIT(3))
304
314#define K_CALLBACK_STATE (BIT(4))
315
325#define K_DSP_IDX 13
326#define K_DSP_REGS (BIT(K_DSP_IDX))
327
336#define K_AGU_IDX 14
337#define K_AGU_REGS (BIT(K_AGU_IDX))
338
348#define K_SSE_REGS (BIT(15))
349
350/* end - thread options */
351
352#if !defined(_ASMLANGUAGE)
377__syscall k_thread_stack_t *k_thread_stack_alloc(size_t size, int flags);
378
392
444__syscall k_tid_t k_thread_create(struct k_thread *new_thread,
445 k_thread_stack_t *stack,
446 size_t stack_size,
448 void *p1, void *p2, void *p3,
449 int prio, uint32_t options, k_timeout_t delay);
450
473 void *p1, void *p2,
474 void *p3);
475
489#define k_thread_access_grant(thread, ...) \
490 FOR_EACH_FIXED_ARG(k_object_access_grant, (;), (thread), __VA_ARGS__)
491
506static inline void k_thread_heap_assign(struct k_thread *thread,
507 struct k_heap *heap)
508{
509 thread->resource_pool = heap;
510}
511
512#if defined(CONFIG_INIT_STACKS) && defined(CONFIG_THREAD_STACK_INFO)
533__syscall int k_thread_stack_space_get(const struct k_thread *thread,
534 size_t *unused_ptr);
535
551__syscall int k_thread_runtime_stack_unused_threshold_pct_set(struct k_thread *thread,
552 uint32_t pct);
553
569__syscall int k_thread_runtime_stack_unused_threshold_set(struct k_thread *thread,
570 size_t threshold);
571
584__syscall size_t k_thread_runtime_stack_unused_threshold_get(struct k_thread *thread);
585
597typedef void (*k_thread_stack_safety_handler_t)(const struct k_thread *thread,
598 size_t unused_space, void *arg);
599
614int k_thread_runtime_stack_safety_full_check(const struct k_thread *thread,
615 size_t *unused_ptr,
616 k_thread_stack_safety_handler_t handler,
617 void *arg);
618
633int k_thread_runtime_stack_safety_threshold_check(const struct k_thread *thread,
634 size_t *unused_ptr,
635 k_thread_stack_safety_handler_t handler,
636 void *arg);
637#endif
638
639#if (K_HEAP_MEM_POOL_SIZE > 0)
652void k_thread_system_pool_assign(struct k_thread *thread);
653#endif /* (K_HEAP_MEM_POOL_SIZE > 0) */
654
674__syscall int k_thread_join(struct k_thread *thread, k_timeout_t timeout);
675
689__syscall int32_t k_sleep(k_timeout_t timeout);
690
702static inline int32_t k_msleep(int32_t ms)
703{
704 return k_sleep(Z_TIMEOUT_MS(ms));
705}
706
724
741__syscall void k_busy_wait(uint32_t usec_to_wait);
742
754bool k_can_yield(void);
755
763__syscall void k_yield(void);
764
774__syscall void k_wakeup(k_tid_t thread);
775
789__attribute_const__
791
803static inline bool k_is_pre_kernel(void)
804{
805 extern bool z_sys_post_kernel; /* in init.c */
806
807 /*
808 * If called from userspace, it must be post kernel.
809 * This guard is necessary because z_sys_post_kernel memory
810 * is not accessible to user threads.
811 */
812 if (k_is_user_context()) {
813 return false;
814 }
815
816 /*
817 * Some compilers might optimize by pre-reading
818 * z_sys_post_kernel. This is absolutely not desirable.
819 * We are trying to avoid reading it if we are in user
820 * context as reading z_sys_post_kernel in user context
821 * will result in access fault. So add a compiler barrier
822 * here to stop that kind of optimizations.
823 */
824 compiler_barrier();
825
826 return !z_sys_post_kernel;
827}
828
835__attribute_const__
836static inline k_tid_t k_current_get(void)
837{
838 __ASSERT(!k_is_pre_kernel(), "k_current_get called pre-kernel");
839
840#ifdef CONFIG_CURRENT_THREAD_USE_TLS
841
842 /* Thread-local cache of current thread ID, set in z_thread_entry() */
843 extern Z_THREAD_LOCAL k_tid_t z_tls_current;
844
845 return z_tls_current;
846#else
848#endif
849}
850
870__syscall void k_thread_abort(k_tid_t thread);
871
872k_ticks_t z_timeout_expires(const struct _timeout *timeout);
873k_ticks_t z_timeout_remaining(const struct _timeout *timeout);
874
875#ifdef CONFIG_SYS_CLOCK_EXISTS
876
884__syscall k_ticks_t k_thread_timeout_expires_ticks(const struct k_thread *thread);
885
886static inline k_ticks_t z_impl_k_thread_timeout_expires_ticks(
887 const struct k_thread *thread)
888{
889 return z_timeout_expires(&thread->base.timeout);
890}
891
900
901static inline k_ticks_t z_impl_k_thread_timeout_remaining_ticks(
902 const struct k_thread *thread)
903{
904 return z_timeout_remaining(&thread->base.timeout);
905}
906
907#endif /* CONFIG_SYS_CLOCK_EXISTS */
908
912struct _static_thread_data {
913 struct k_thread *init_thread;
914 k_thread_stack_t *init_stack;
915 unsigned int init_stack_size;
916 k_thread_entry_t init_entry;
917 void *init_p1;
918 void *init_p2;
919 void *init_p3;
920 int init_prio;
921 uint32_t init_options;
922 const char *init_name;
923#ifdef CONFIG_TIMER_READS_ITS_FREQUENCY_AT_RUNTIME
924 int32_t init_delay_ms;
925#else
926 k_timeout_t init_delay;
927#endif
928};
929
930#ifdef CONFIG_TIMER_READS_ITS_FREQUENCY_AT_RUNTIME
931#define Z_THREAD_INIT_DELAY_INITIALIZER(ms) .init_delay_ms = (ms)
932#define Z_THREAD_INIT_DELAY(thread) SYS_TIMEOUT_MS((thread)->init_delay_ms)
933#else
934#define Z_THREAD_INIT_DELAY_INITIALIZER(ms) .init_delay = SYS_TIMEOUT_MS_INIT(ms)
935#define Z_THREAD_INIT_DELAY(thread) (thread)->init_delay
936#endif
937
938#define Z_THREAD_INITIALIZER(thread, stack, stack_size, \
939 entry, p1, p2, p3, \
940 prio, options, delay, tname) \
941 { \
942 .init_thread = (thread), \
943 .init_stack = (stack), \
944 .init_stack_size = (stack_size), \
945 .init_entry = (k_thread_entry_t)entry, \
946 .init_p1 = (void *)p1, \
947 .init_p2 = (void *)p2, \
948 .init_p3 = (void *)p3, \
949 .init_prio = (prio), \
950 .init_options = (options), \
951 .init_name = STRINGIFY(tname), \
952 Z_THREAD_INIT_DELAY_INITIALIZER(delay) \
953 }
954
955/*
956 * Refer to K_THREAD_DEFINE() and K_KERNEL_THREAD_DEFINE() for
957 * information on arguments.
958 */
959#define Z_THREAD_COMMON_DEFINE(name, stack_size, \
960 entry, p1, p2, p3, \
961 prio, options, delay) \
962 struct k_thread _k_thread_obj_##name; \
963 const STRUCT_SECTION_ITERABLE(_static_thread_data, \
964 _k_thread_data_##name) = \
965 Z_THREAD_INITIALIZER(&_k_thread_obj_##name, \
966 _k_thread_stack_##name, stack_size,\
967 entry, p1, p2, p3, prio, options, \
968 delay, name); \
969 __maybe_unused const k_tid_t name = (k_tid_t)&_k_thread_obj_##name
973
1005#define K_THREAD_DEFINE(name, stack_size, \
1006 entry, p1, p2, p3, \
1007 prio, options, delay) \
1008 K_THREAD_STACK_DEFINE(_k_thread_stack_##name, stack_size); \
1009 Z_THREAD_COMMON_DEFINE(name, stack_size, entry, p1, p2, p3, \
1010 prio, options, delay)
1011
1042#define K_KERNEL_THREAD_DEFINE(name, stack_size, \
1043 entry, p1, p2, p3, \
1044 prio, options, delay) \
1045 K_KERNEL_STACK_DEFINE(_k_thread_stack_##name, stack_size); \
1046 Z_THREAD_COMMON_DEFINE(name, stack_size, entry, p1, p2, p3, \
1047 prio, options, delay)
1048
1058__syscall int k_thread_priority_get(k_tid_t thread);
1059
1085__syscall void k_thread_priority_set(k_tid_t thread, int prio);
1086
1087
1088#ifdef CONFIG_SCHED_DEADLINE
1124__syscall void k_thread_deadline_set(k_tid_t thread, int deadline);
1125
1166__syscall void k_thread_absolute_deadline_set(k_tid_t thread, int deadline);
1167#endif
1168
1187__syscall void k_reschedule(void);
1188
1189#ifdef CONFIG_SCHED_CPU_MASK
1207
1226
1240
1259
1270int k_thread_cpu_pin(k_tid_t thread, int cpu);
1271#endif
1272
1294__syscall void k_thread_suspend(k_tid_t thread);
1295
1307__syscall void k_thread_resume(k_tid_t thread);
1308
1322static inline void k_thread_start(k_tid_t thread)
1323{
1324 k_wakeup(thread);
1325}
1326
1353void k_sched_time_slice_set(int32_t slice, int prio);
1354
1393void k_thread_time_slice_set(struct k_thread *th, int32_t slice_ticks,
1394 k_thread_timeslice_fn_t expired, void *data);
1395
1397
1402
1414bool k_is_in_isr(void);
1415
1432__syscall int k_is_preempt_thread(void);
1433
1437
1442
1468void k_sched_lock(void);
1469
1478
1491__syscall void k_thread_custom_data_set(void *value);
1492
1500__syscall void *k_thread_custom_data_get(void);
1501
1515__syscall int k_thread_name_set(k_tid_t thread, const char *str);
1516
1525const char *k_thread_name_get(k_tid_t thread);
1526
1538__syscall int k_thread_name_copy(k_tid_t thread, char *buf,
1539 size_t size);
1540
1553const char *k_thread_state_str(k_tid_t thread_id, char *buf, size_t buf_size);
1554
1558
1563
1572#define K_NO_WAIT Z_TIMEOUT_NO_WAIT
1573
1586#define K_NSEC(t) Z_TIMEOUT_NS(t)
1587
1600#define K_USEC(t) Z_TIMEOUT_US(t)
1601
1612#define K_CYC(t) Z_TIMEOUT_CYC(t)
1613
1624#define K_TICKS(t) Z_TIMEOUT_TICKS(t)
1625
1636#define K_MSEC(ms) Z_TIMEOUT_MS(ms)
1637
1648#define K_SECONDS(s) K_MSEC((s) * MSEC_PER_SEC)
1649
1660#define K_MINUTES(m) K_SECONDS((m) * 60)
1661
1672#define K_HOURS(h) K_MINUTES((h) * 60)
1673
1682#define K_FOREVER Z_FOREVER
1683
1698#define K_TIMEOUT_SUM(timeout1, timeout2) K_TICKS(z_timeout_sum(timeout1, timeout2))
1699
1700#ifdef CONFIG_TIMEOUT_64BIT
1701
1713#define K_TIMEOUT_ABS_TICKS(t) \
1714 Z_TIMEOUT_TICKS(Z_TICK_ABS((k_ticks_t)CLAMP(t, 0, (INT64_MAX - 1))))
1715
1727#define K_TIMEOUT_ABS_SEC(t) K_TIMEOUT_ABS_TICKS(k_sec_to_ticks_ceil64(t))
1728
1740#define K_TIMEOUT_ABS_MS(t) K_TIMEOUT_ABS_TICKS(k_ms_to_ticks_ceil64(t))
1741
1754#define K_TIMEOUT_ABS_US(t) K_TIMEOUT_ABS_TICKS(k_us_to_ticks_ceil64(t))
1755
1768#define K_TIMEOUT_ABS_NS(t) K_TIMEOUT_ABS_TICKS(k_ns_to_ticks_ceil64(t))
1769
1782#define K_TIMEOUT_ABS_CYC(t) K_TIMEOUT_ABS_TICKS(k_cyc_to_ticks_ceil64(t))
1783#endif
1784
1788
1795struct k_timer {
1799 /*
1800 * _timeout structure must be first here if we want to use
1801 * dynamic timer allocation. timeout.node is used in the double-linked
1802 * list of free timers
1803 */
1804 struct _timeout timeout;
1805
1806 /* wait queue for the (single) thread waiting on this timer */
1807 _wait_q_t wait_q;
1808
1809 /* runs in ISR context */
1810 void (*expiry_fn)(struct k_timer *timer);
1811
1812 /* runs in the context of the thread that calls k_timer_stop() */
1813 void (*stop_fn)(struct k_timer *timer);
1814
1815 /* timer period */
1816 k_timeout_t period;
1817
1818 /* timer status */
1819 uint32_t status;
1820
1821 /* user-specific data, also used to support legacy features */
1822 void *user_data;
1823
1825
1826#ifdef CONFIG_OBJ_CORE_TIMER
1827 struct k_obj_core obj_core;
1828#endif
1832};
1833
1834#ifdef CONFIG_TIMER_OBSERVER
1835struct k_timer_observer {
1836 /* Invoked upon completion of k_timer initialization */
1837 void (*on_init)(struct k_timer *timer);
1838
1839 /* Invoked after the timer transitions to the running state */
1840 void (*on_start)(struct k_timer *timer, k_timeout_t duration,
1841 k_timeout_t period);
1842
1843 /* Invoked when the active timer is explicitly stopped */
1844 void (*on_stop)(struct k_timer *timer);
1845
1846 /* Executes in ISR context, keep minimal and non-blocking */
1847 void (*on_expiry)(struct k_timer *timer);
1848};
1849#endif /* CONFIG_TIMER_OBSERVER */
1850
1854#define Z_TIMER_INITIALIZER(obj, expiry, stop) \
1855 { \
1856 .timeout = { \
1857 .node = {},\
1858 .fn = z_timer_expiration_handler, \
1859 .dticks = 0, \
1860 }, \
1861 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
1862 .expiry_fn = expiry, \
1863 .stop_fn = stop, \
1864 .period = {}, \
1865 .status = 0, \
1866 .user_data = 0, \
1867 }
1871
1877
1888typedef void (*k_timer_expiry_t)(struct k_timer *timer);
1889
1904typedef void (*k_timer_stop_t)(struct k_timer *timer);
1905
1917#define K_TIMER_DEFINE(name, expiry_fn, stop_fn) \
1918 STRUCT_SECTION_ITERABLE(k_timer, name) = \
1919 Z_TIMER_INITIALIZER(name, expiry_fn, stop_fn)
1920
1921
1922#ifdef CONFIG_TIMER_OBSERVER
1923
1927#define Z_TIMER_OBSERVER_INITIALIZER(name, init, start, stop, expiry) \
1928 { \
1929 .on_init = init, \
1930 .on_start = start, \
1931 .on_stop = stop, \
1932 .on_expiry = expiry \
1933 }
1937
1951#define K_TIMER_OBSERVER_DEFINE(name, init, start, stop, expiry) \
1952 static const STRUCT_SECTION_ITERABLE(k_timer_observer, name) = \
1953 Z_TIMER_OBSERVER_INITIALIZER(name, init, start, stop, expiry)
1954
1955#endif /* CONFIG_TIMER_OBSERVER */
1956
1966void k_timer_init(struct k_timer *timer,
1967 k_timer_expiry_t expiry_fn,
1968 k_timer_stop_t stop_fn);
1969
1987__syscall void k_timer_start(struct k_timer *timer,
1988 k_timeout_t duration, k_timeout_t period);
1989
2006__syscall void k_timer_stop(struct k_timer *timer);
2007
2020__syscall uint32_t k_timer_status_get(struct k_timer *timer);
2021
2039__syscall uint32_t k_timer_status_sync(struct k_timer *timer);
2040
2041#ifdef CONFIG_SYS_CLOCK_EXISTS
2042
2053__syscall k_ticks_t k_timer_expires_ticks(const struct k_timer *timer);
2054
2055static inline k_ticks_t z_impl_k_timer_expires_ticks(
2056 const struct k_timer *timer)
2057{
2058 return z_timeout_expires(&timer->timeout);
2059}
2060
2071__syscall k_ticks_t k_timer_remaining_ticks(const struct k_timer *timer);
2072
2073static inline k_ticks_t z_impl_k_timer_remaining_ticks(
2074 const struct k_timer *timer)
2075{
2076 return z_timeout_remaining(&timer->timeout);
2077}
2078
2089static inline uint32_t k_timer_remaining_get(struct k_timer *timer)
2090{
2092}
2093
2094#endif /* CONFIG_SYS_CLOCK_EXISTS */
2095
2108__syscall void k_timer_user_data_set(struct k_timer *timer, void *user_data);
2109
2113static inline void z_impl_k_timer_user_data_set(struct k_timer *timer,
2114 void *user_data)
2115{
2116 timer->user_data = user_data;
2117}
2118
2126__syscall void *k_timer_user_data_get(const struct k_timer *timer);
2127
2128static inline void *z_impl_k_timer_user_data_get(const struct k_timer *timer)
2129{
2130 return timer->user_data;
2131}
2132
2153int k_timer_cleanup(struct k_timer *timer);
2154
2156
2162
2172__syscall int64_t k_uptime_ticks(void);
2173
2187static inline int64_t k_uptime_get(void)
2188{
2190}
2191
2211static inline uint32_t k_uptime_get_32(void)
2212{
2213 return (uint32_t)k_uptime_get();
2214}
2215
2224static inline uint32_t k_uptime_seconds(void)
2225{
2227}
2228
2240static inline int64_t k_uptime_delta(int64_t *reftime)
2241{
2242 int64_t uptime, delta;
2243
2244 uptime = k_uptime_get();
2245 delta = uptime - *reftime;
2246 *reftime = uptime;
2247
2248 return delta;
2249}
2250
2259static inline uint32_t k_cycle_get_32(void)
2260{
2261 return arch_k_cycle_get_32();
2262}
2263
2274static inline uint64_t k_cycle_get_64(void)
2275{
2276 if (!IS_ENABLED(CONFIG_TIMER_HAS_64BIT_CYCLE_COUNTER)) {
2277 __ASSERT(0, "64-bit cycle counter not enabled on this platform. "
2278 "See CONFIG_TIMER_HAS_64BIT_CYCLE_COUNTER");
2279 return 0;
2280 }
2281
2282 return arch_k_cycle_get_64();
2283}
2284
2288
2295struct k_queue {
2299 sys_sflist_t data_q;
2300 struct k_spinlock lock;
2301 _wait_q_t wait_q;
2302
2303 Z_DECL_POLL_EVENT
2304
2309};
2310
2314#define Z_QUEUE_INITIALIZER(obj) \
2315 { \
2316 .data_q = SYS_SFLIST_STATIC_INIT(&obj.data_q), \
2317 .lock = { }, \
2318 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
2319 Z_POLL_EVENT_OBJ_INIT(obj) \
2320 }
2324
2330
2338__syscall void k_queue_init(struct k_queue *queue);
2339
2353__syscall void k_queue_cancel_wait(struct k_queue *queue);
2354
2367void k_queue_append(struct k_queue *queue, void *data);
2368
2385__syscall int32_t k_queue_alloc_append(struct k_queue *queue, void *data);
2386
2399void k_queue_prepend(struct k_queue *queue, void *data);
2400
2417__syscall int32_t k_queue_alloc_prepend(struct k_queue *queue, void *data);
2418
2432void k_queue_insert(struct k_queue *queue, void *prev, void *data);
2433
2452int k_queue_append_list(struct k_queue *queue, void *head, void *tail);
2453
2471int k_queue_merge_slist(struct k_queue *queue, sys_slist_t *list);
2472
2490__syscall void *k_queue_get(struct k_queue *queue, k_timeout_t timeout);
2491
2506bool k_queue_remove(struct k_queue *queue, void *data);
2507
2522bool k_queue_unique_append(struct k_queue *queue, void *data);
2523
2537__syscall int k_queue_is_empty(struct k_queue *queue);
2538
2539static inline int z_impl_k_queue_is_empty(struct k_queue *queue)
2540{
2541 return sys_sflist_is_empty(&queue->data_q) ? 1 : 0;
2542}
2543
2553__syscall void *k_queue_peek_head(struct k_queue *queue);
2554
2564__syscall void *k_queue_peek_tail(struct k_queue *queue);
2565
2575#define K_QUEUE_DEFINE(name) \
2576 STRUCT_SECTION_ITERABLE(k_queue, name) = \
2577 Z_QUEUE_INITIALIZER(name)
2578
2580
2581#ifdef CONFIG_USERSPACE
2591struct k_futex {
2593};
2594
2604struct z_futex_data {
2608 _wait_q_t wait_q;
2609 struct k_spinlock lock;
2613};
2614
2618#define Z_FUTEX_DATA_INITIALIZER(obj) \
2619 { \
2620 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q) \
2621 }
2625
2631
2651__syscall int k_futex_wait(struct k_futex *futex, int expected,
2652 k_timeout_t timeout);
2653
2668__syscall int k_futex_wake(struct k_futex *futex, bool wake_all);
2669
2671#endif
2672
2678
2683
2690
2691struct k_event {
2695 _wait_q_t wait_q;
2696 uint32_t events;
2697 struct k_spinlock lock;
2698
2700
2701#ifdef CONFIG_OBJ_CORE_EVENT
2702 struct k_obj_core obj_core;
2703#endif
2707};
2708
2712#define Z_EVENT_INITIALIZER(obj) \
2713 { \
2714 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
2715 .events = 0, \
2716 .lock = {}, \
2717 }
2721
2729__syscall void k_event_init(struct k_event *event);
2730
2748__syscall uint32_t k_event_post(struct k_event *event, uint32_t events);
2749
2767__syscall uint32_t k_event_set(struct k_event *event, uint32_t events);
2768
2785__syscall uint32_t k_event_set_masked(struct k_event *event, uint32_t events,
2786 uint32_t events_mask);
2787
2800__syscall uint32_t k_event_clear(struct k_event *event, uint32_t events);
2801
2826__syscall uint32_t k_event_wait(struct k_event *event, uint32_t events,
2827 bool reset, k_timeout_t timeout);
2828
2853__syscall uint32_t k_event_wait_all(struct k_event *event, uint32_t events,
2854 bool reset, k_timeout_t timeout);
2855
2875__syscall uint32_t k_event_wait_safe(struct k_event *event, uint32_t events,
2876 bool reset, k_timeout_t timeout);
2877
2897__syscall uint32_t k_event_wait_all_safe(struct k_event *event, uint32_t events,
2898 bool reset, k_timeout_t timeout);
2899
2910static inline uint32_t k_event_test(struct k_event *event, uint32_t events_mask)
2911{
2912 return k_event_wait(event, events_mask, false, K_NO_WAIT);
2913}
2914
2924#define K_EVENT_DEFINE(name) \
2925 STRUCT_SECTION_ITERABLE(k_event, name) = \
2926 Z_EVENT_INITIALIZER(name);
2927
2929
2935struct k_fifo {
2939 struct k_queue _queue;
2940#ifdef CONFIG_OBJ_CORE_FIFO
2941 struct k_obj_core obj_core;
2942#endif
2946};
2947
2951#define Z_FIFO_INITIALIZER(obj) \
2952 { \
2953 ._queue = Z_QUEUE_INITIALIZER(obj._queue) \
2954 }
2958
2964
2972#define k_fifo_init(fifo) \
2973 ({ \
2974 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, init, fifo); \
2975 k_queue_init(&(fifo)->_queue); \
2976 K_OBJ_CORE_INIT(K_OBJ_CORE(fifo), _obj_type_fifo); \
2977 K_OBJ_CORE_LINK(K_OBJ_CORE(fifo)); \
2978 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, init, fifo); \
2979 })
2980
2992#define k_fifo_cancel_wait(fifo) \
2993 ({ \
2994 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, cancel_wait, fifo); \
2995 k_queue_cancel_wait(&(fifo)->_queue); \
2996 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, cancel_wait, fifo); \
2997 })
2998
3011#define k_fifo_put(fifo, data) \
3012 ({ \
3013 void *_data = data; \
3014 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put, fifo, _data); \
3015 k_queue_append(&(fifo)->_queue, _data); \
3016 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put, fifo, _data); \
3017 })
3018
3035#define k_fifo_alloc_put(fifo, data) \
3036 ({ \
3037 void *_data = data; \
3038 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, alloc_put, fifo, _data); \
3039 int fap_ret = k_queue_alloc_append(&(fifo)->_queue, _data); \
3040 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, alloc_put, fifo, _data, fap_ret); \
3041 fap_ret; \
3042 })
3043
3058#define k_fifo_put_list(fifo, head, tail) \
3059 ({ \
3060 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put_list, fifo, head, tail); \
3061 k_queue_append_list(&(fifo)->_queue, head, tail); \
3062 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put_list, fifo, head, tail); \
3063 })
3064
3078#define k_fifo_put_slist(fifo, list) \
3079 ({ \
3080 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put_slist, fifo, list); \
3081 k_queue_merge_slist(&(fifo)->_queue, list); \
3082 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put_slist, fifo, list); \
3083 })
3084
3102#define k_fifo_get(fifo, timeout) \
3103 ({ \
3104 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, get, fifo, timeout); \
3105 void *fg_ret = k_queue_get(&(fifo)->_queue, timeout); \
3106 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, get, fifo, timeout, fg_ret); \
3107 fg_ret; \
3108 })
3109
3123#define k_fifo_is_empty(fifo) \
3124 k_queue_is_empty(&(fifo)->_queue)
3125
3139#define k_fifo_peek_head(fifo) \
3140 ({ \
3141 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, peek_head, fifo); \
3142 void *fph_ret = k_queue_peek_head(&(fifo)->_queue); \
3143 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, peek_head, fifo, fph_ret); \
3144 fph_ret; \
3145 })
3146
3158#define k_fifo_peek_tail(fifo) \
3159 ({ \
3160 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, peek_tail, fifo); \
3161 void *fpt_ret = k_queue_peek_tail(&(fifo)->_queue); \
3162 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, peek_tail, fifo, fpt_ret); \
3163 fpt_ret; \
3164 })
3165
3175#define K_FIFO_DEFINE(name) \
3176 STRUCT_SECTION_ITERABLE(k_fifo, name) = \
3177 Z_FIFO_INITIALIZER(name)
3178
3180
3186struct k_lifo {
3190 struct k_queue _queue;
3191#ifdef CONFIG_OBJ_CORE_LIFO
3192 struct k_obj_core obj_core;
3193#endif
3197};
3198
3202#define Z_LIFO_INITIALIZER(obj) \
3203 { \
3204 ._queue = Z_QUEUE_INITIALIZER(obj._queue) \
3205 }
3209
3215
3223#define k_lifo_init(lifo) \
3224 ({ \
3225 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, init, lifo); \
3226 k_queue_init(&(lifo)->_queue); \
3227 K_OBJ_CORE_INIT(K_OBJ_CORE(lifo), _obj_type_lifo); \
3228 K_OBJ_CORE_LINK(K_OBJ_CORE(lifo)); \
3229 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, init, lifo); \
3230 })
3231
3244#define k_lifo_put(lifo, data) \
3245 ({ \
3246 void *_data = data; \
3247 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, put, lifo, _data); \
3248 k_queue_prepend(&(lifo)->_queue, _data); \
3249 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, put, lifo, _data); \
3250 })
3251
3268#define k_lifo_alloc_put(lifo, data) \
3269 ({ \
3270 void *_data = data; \
3271 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, alloc_put, lifo, _data); \
3272 int lap_ret = k_queue_alloc_prepend(&(lifo)->_queue, _data); \
3273 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, alloc_put, lifo, _data, lap_ret); \
3274 lap_ret; \
3275 })
3276
3294#define k_lifo_get(lifo, timeout) \
3295 ({ \
3296 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, get, lifo, timeout); \
3297 void *lg_ret = k_queue_get(&(lifo)->_queue, timeout); \
3298 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, get, lifo, timeout, lg_ret); \
3299 lg_ret; \
3300 })
3301
3311#define K_LIFO_DEFINE(name) \
3312 STRUCT_SECTION_ITERABLE(k_lifo, name) = \
3313 Z_LIFO_INITIALIZER(name)
3314
3316
3320#define K_STACK_FLAG_ALLOC ((uint8_t)1) /* Buffer was allocated */
3321
3322typedef uintptr_t stack_data_t;
3323
3324struct k_stack {
3325 _wait_q_t wait_q;
3326 struct k_spinlock lock;
3327 stack_data_t *base, *next, *top;
3328
3329 uint8_t flags;
3330
3332
3333#ifdef CONFIG_OBJ_CORE_STACK
3334 struct k_obj_core obj_core;
3335#endif
3336};
3337
3338#define Z_STACK_INITIALIZER(obj, stack_buffer, stack_num_entries) \
3339 { \
3340 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
3341 .base = (stack_buffer), \
3342 .next = (stack_buffer), \
3343 .top = (stack_buffer) + (stack_num_entries), \
3344 }
3348
3354
3364void k_stack_init(struct k_stack *stack,
3365 stack_data_t *buffer, uint32_t num_entries);
3366
3367
3381
3382__syscall int32_t k_stack_alloc_init(struct k_stack *stack,
3383 uint32_t num_entries);
3384
3396int k_stack_cleanup(struct k_stack *stack);
3397
3411__syscall int k_stack_push(struct k_stack *stack, stack_data_t data);
3412
3433__syscall int k_stack_pop(struct k_stack *stack, stack_data_t *data,
3434 k_timeout_t timeout);
3435
3446#define K_STACK_DEFINE(name, stack_num_entries) \
3447 stack_data_t __noinit \
3448 _k_stack_buf_##name[stack_num_entries]; \
3449 STRUCT_SECTION_ITERABLE(k_stack, name) = \
3450 Z_STACK_INITIALIZER(name, _k_stack_buf_##name, \
3451 stack_num_entries)
3452
3454
3458struct k_work;
3459struct k_work_q;
3460struct k_work_queue_config;
3461extern struct k_work_q k_sys_work_q;
3465
3471
3477struct k_mutex {
3482 _wait_q_t wait_q;
3484 struct k_thread *owner;
3485
3487 uint32_t lock_count;
3488
3490 int owner_orig_prio;
3491
3493
3494#ifdef CONFIG_OBJ_CORE_MUTEX
3495 struct k_obj_core obj_core;
3496#endif
3500};
3501
3505#define Z_MUTEX_INITIALIZER(obj) \
3506 { \
3507 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
3508 .owner = NULL, \
3509 .lock_count = 0, \
3510 .owner_orig_prio = K_LOWEST_APPLICATION_THREAD_PRIO, \
3511 }
3515
3525#define K_MUTEX_DEFINE(name) \
3526 STRUCT_SECTION_ITERABLE(k_mutex, name) = \
3527 Z_MUTEX_INITIALIZER(name)
3528
3541__syscall int k_mutex_init(struct k_mutex *mutex);
3542
3543
3565__syscall int k_mutex_lock(struct k_mutex *mutex, k_timeout_t timeout);
3566
3587__syscall int k_mutex_unlock(struct k_mutex *mutex);
3588
3592
3602 _wait_q_t wait_q;
3603
3604#ifdef CONFIG_OBJ_CORE_CONDVAR
3605 struct k_obj_core obj_core;
3606#endif
3610};
3611
3615#define Z_CONDVAR_INITIALIZER(obj) \
3616 { \
3617 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
3618 }
3622
3628
3635__syscall int k_condvar_init(struct k_condvar *condvar);
3636
3643__syscall int k_condvar_signal(struct k_condvar *condvar);
3644
3652__syscall int k_condvar_broadcast(struct k_condvar *condvar);
3653
3671__syscall int k_condvar_wait(struct k_condvar *condvar, struct k_mutex *mutex,
3672 k_timeout_t timeout);
3673
3684#define K_CONDVAR_DEFINE(name) \
3685 STRUCT_SECTION_ITERABLE(k_condvar, name) = \
3686 Z_CONDVAR_INITIALIZER(name)
3687
3690
3696
3703struct k_sem {
3707 _wait_q_t wait_q;
3708 unsigned int count;
3709 unsigned int limit;
3710
3711 Z_DECL_POLL_EVENT
3712
3714
3715#ifdef CONFIG_OBJ_CORE_SEM
3716 struct k_obj_core obj_core;
3717#endif
3721};
3722
3726#define Z_SEM_INITIALIZER(obj, initial_count, count_limit) \
3727 { \
3728 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
3729 .count = (initial_count), \
3730 .limit = (count_limit), \
3731 Z_POLL_EVENT_OBJ_INIT(obj) \
3732 }
3736
3745#define K_SEM_MAX_LIMIT UINT_MAX
3746
3762__syscall int k_sem_init(struct k_sem *sem, unsigned int initial_count,
3763 unsigned int limit);
3764
3783__syscall int k_sem_take(struct k_sem *sem, k_timeout_t timeout);
3784
3795__syscall void k_sem_give(struct k_sem *sem);
3796
3806__syscall void k_sem_reset(struct k_sem *sem);
3807
3817__syscall unsigned int k_sem_count_get(struct k_sem *sem);
3818
3822static inline unsigned int z_impl_k_sem_count_get(struct k_sem *sem)
3823{
3824 return sem->count;
3825}
3826
3838#define K_SEM_DEFINE(name, initial_count, count_limit) \
3839 STRUCT_SECTION_ITERABLE(k_sem, name) = \
3840 Z_SEM_INITIALIZER(name, initial_count, count_limit); \
3841 BUILD_ASSERT(((count_limit) != 0) && \
3842 (((initial_count) < (count_limit)) || ((initial_count) == (count_limit))) && \
3843 ((count_limit) <= K_SEM_MAX_LIMIT));
3844
3846
3847#if defined(CONFIG_SCHED_IPI_SUPPORTED) || defined(__DOXYGEN__)
3848struct k_ipi_work;
3849
3850
3851typedef void (*k_ipi_func_t)(struct k_ipi_work *work);
3852
3863 sys_dnode_t node[CONFIG_MP_MAX_NUM_CPUS]; /* Node in IPI work queue */
3864 k_ipi_func_t func; /* Function to execute on target CPU */
3865 struct k_event event; /* Event to signal when processed */
3866 uint32_t bitmask; /* Bitmask of targeted CPUs */
3870};
3871
3872
3880static inline void k_ipi_work_init(struct k_ipi_work *work)
3881{
3882 k_event_init(&work->event);
3883 for (unsigned int i = 0; i < CONFIG_MP_MAX_NUM_CPUS; i++) {
3884 sys_dnode_init(&work->node[i]);
3885 }
3886 work->bitmask = 0;
3887}
3888
3907int k_ipi_work_add(struct k_ipi_work *work, uint32_t cpu_bitmask,
3908 k_ipi_func_t func);
3909
3932int k_ipi_work_wait(struct k_ipi_work *work, k_timeout_t timeout);
3933
3943
3944#endif /* CONFIG_SCHED_IPI_SUPPORTED */
3945
3949struct k_work_delayable;
3950struct k_work_sync;
3954
3960
3967typedef void (*k_work_handler_t)(struct k_work *work);
3968
3982void k_work_init(struct k_work *work,
3983 k_work_handler_t handler);
3984
3999int k_work_busy_get(const struct k_work *work);
4000
4014static inline bool k_work_is_pending(const struct k_work *work);
4015
4037 struct k_work *work);
4038
4047int k_work_submit(struct k_work *work);
4048
4073bool k_work_flush(struct k_work *work,
4074 struct k_work_sync *sync);
4075
4095int k_work_cancel(struct k_work *work);
4096
4127bool k_work_cancel_sync(struct k_work *work, struct k_work_sync *sync);
4128
4138void k_work_queue_init(struct k_work_q *queue);
4139
4159void k_work_queue_start(struct k_work_q *queue,
4160 k_thread_stack_t *stack, size_t stack_size,
4161 int prio, const struct k_work_queue_config *cfg);
4162
4173void k_work_queue_run(struct k_work_q *queue, const struct k_work_queue_config *cfg);
4174
4184static inline k_tid_t k_work_queue_thread_get(struct k_work_q *queue);
4185
4209int k_work_queue_drain(struct k_work_q *queue, bool plug);
4210
4225
4241int k_work_queue_stop(struct k_work_q *queue, k_timeout_t timeout);
4242
4257 k_work_handler_t handler);
4258
4270static inline struct k_work_delayable *
4272
4287
4302static inline bool k_work_delayable_is_pending(
4303 const struct k_work_delayable *dwork);
4304
4319 const struct k_work_delayable *dwork);
4320
4335 const struct k_work_delayable *dwork);
4336
4365 struct k_work_delayable *dwork,
4366 k_timeout_t delay);
4367
4382 k_timeout_t delay);
4383
4420 struct k_work_delayable *dwork,
4421 k_timeout_t delay);
4422
4436 k_timeout_t delay);
4437
4463 struct k_work_sync *sync);
4464
4486
4516 struct k_work_sync *sync);
4517
4518enum {
4522 /* The atomic API is used for all work and queue flags fields to
4523 * enforce sequential consistency in SMP environments.
4524 */
4525
4526 /* Bits that represent the work item states. At least nine of the
4527 * combinations are distinct valid stable states.
4528 */
4529 K_WORK_RUNNING_BIT = 0,
4530 K_WORK_CANCELING_BIT = 1,
4531 K_WORK_QUEUED_BIT = 2,
4532 K_WORK_DELAYED_BIT = 3,
4533 K_WORK_FLUSHING_BIT = 4,
4534
4535 K_WORK_MASK = BIT(K_WORK_DELAYED_BIT) | BIT(K_WORK_QUEUED_BIT)
4536 | BIT(K_WORK_RUNNING_BIT) | BIT(K_WORK_CANCELING_BIT) | BIT(K_WORK_FLUSHING_BIT),
4537
4538 /* Static work flags */
4539 K_WORK_DELAYABLE_BIT = 8,
4540 K_WORK_DELAYABLE = BIT(K_WORK_DELAYABLE_BIT),
4541
4542 /* Dynamic work queue flags */
4543 K_WORK_QUEUE_STARTED_BIT = 0,
4544 K_WORK_QUEUE_STARTED = BIT(K_WORK_QUEUE_STARTED_BIT),
4545 K_WORK_QUEUE_BUSY_BIT = 1,
4546 K_WORK_QUEUE_BUSY = BIT(K_WORK_QUEUE_BUSY_BIT),
4547 K_WORK_QUEUE_DRAIN_BIT = 2,
4548 K_WORK_QUEUE_DRAIN = BIT(K_WORK_QUEUE_DRAIN_BIT),
4549 K_WORK_QUEUE_PLUGGED_BIT = 3,
4550 K_WORK_QUEUE_PLUGGED = BIT(K_WORK_QUEUE_PLUGGED_BIT),
4551 K_WORK_QUEUE_STOP_BIT = 4,
4552 K_WORK_QUEUE_STOP = BIT(K_WORK_QUEUE_STOP_BIT),
4553
4554 /* Static work queue flags */
4555 K_WORK_QUEUE_NO_YIELD_BIT = 8,
4556 K_WORK_QUEUE_NO_YIELD = BIT(K_WORK_QUEUE_NO_YIELD_BIT),
4560 /* Transient work flags */
4561
4567 K_WORK_RUNNING = BIT(K_WORK_RUNNING_BIT),
4568
4573 K_WORK_CANCELING = BIT(K_WORK_CANCELING_BIT),
4574
4580 K_WORK_QUEUED = BIT(K_WORK_QUEUED_BIT),
4581
4587 K_WORK_DELAYED = BIT(K_WORK_DELAYED_BIT),
4588
4593 K_WORK_FLUSHING = BIT(K_WORK_FLUSHING_BIT),
4594};
4595
4601struct k_work {
4605 /* All fields are protected by the work module spinlock. */
4606
4607 /* Node to link into k_work_q pending list. */
4608 sys_snode_t node;
4609
4610 /* The function to be invoked by the work queue thread. */
4611 k_work_handler_t handler;
4612
4613 /* The queue on which the work item was last submitted. */
4614 struct k_work_q *queue;
4615
4616 /* State of the work item.
4617 *
4618 * The item can be DELAYED, QUEUED, and RUNNING simultaneously.
4619 *
4620 * It can be RUNNING and CANCELING simultaneously.
4621 */
4626};
4627
4631#define Z_WORK_INITIALIZER(work_handler) { \
4632 .handler = (work_handler), \
4633}
4637
4647 /* The work item. */
4648 struct k_work work;
4649
4650 /* Timeout used to submit work after a delay. */
4651 struct _timeout timeout;
4652
4653 /* The queue to which the work should be submitted. */
4654 struct k_work_q *queue;
4658};
4659
4663#define Z_WORK_DELAYABLE_INITIALIZER(work_handler) { \
4664 .work = { \
4665 .handler = (work_handler), \
4666 .flags = K_WORK_DELAYABLE, \
4667 }, \
4668}
4672
4689#define K_WORK_DELAYABLE_DEFINE(work, work_handler) \
4690 struct k_work_delayable work \
4691 = Z_WORK_DELAYABLE_INITIALIZER(work_handler)
4692
4696/* Record used to wait for work to flush.
4697 *
4698 * The work item is inserted into the queue that will process (or is
4699 * processing) the item, and will be processed as soon as the item
4700 * completes. When the flusher is processed the semaphore will be
4701 * signaled, releasing the thread waiting for the flush.
4702 */
4703struct z_work_flusher {
4704 struct k_work work;
4705 struct k_sem sem;
4706};
4707
4708/* Record used to wait for work to complete a cancellation.
4709 *
4710 * The work item is inserted into a global queue of pending cancels.
4711 * When a cancelling work item goes idle any matching waiters are
4712 * removed from pending_cancels and are woken.
4713 */
4714struct z_work_canceller {
4715 sys_snode_t node;
4716 struct k_work *work;
4717 struct k_sem sem;
4718};
4722
4742 union {
4743 struct z_work_flusher flusher;
4744 struct z_work_canceller canceller;
4745 };
4749};
4750
4762 const char *name;
4763
4777
4782
4792};
4793
4799struct k_work_q {
4803 /* The thread that animates the work. */
4804 struct k_thread thread;
4805
4806 /* The thread ID that animates the work. This may be an external thread
4807 * if k_work_queue_run() is used.
4808 */
4809 k_tid_t thread_id;
4810
4811 /* All the following fields must be accessed only while the
4812 * work module spinlock is held.
4813 */
4814
4815 /* List of k_work items to be worked. */
4816 sys_slist_t pending;
4817
4818 /* Wait queue for idle work thread. */
4819 _wait_q_t notifyq;
4820
4821 /* Wait queue for threads waiting for the queue to drain. */
4822 _wait_q_t drainq;
4823
4824 /* Flags describing queue state. */
4826
4827#if defined(CONFIG_WORKQUEUE_WORK_TIMEOUT)
4828 struct _timeout work_timeout_record;
4829 struct k_work *work;
4830 k_timeout_t work_timeout;
4831 bool finished;
4832#endif /* defined(CONFIG_WORKQUEUE_WORK_TIMEOUT) */
4836};
4837
4838/* Provide the implementation for inline functions declared above */
4839
4840static inline bool k_work_is_pending(const struct k_work *work)
4841{
4842 return k_work_busy_get(work) != 0;
4843}
4844
4845static inline struct k_work_delayable *
4847{
4848 return CONTAINER_OF(work, struct k_work_delayable, work);
4849}
4850
4852 const struct k_work_delayable *dwork)
4853{
4854 return k_work_delayable_busy_get(dwork) != 0;
4855}
4856
4858 const struct k_work_delayable *dwork)
4859{
4860 return z_timeout_expires(&dwork->timeout);
4861}
4862
4864 const struct k_work_delayable *dwork)
4865{
4866 return z_timeout_remaining(&dwork->timeout);
4867}
4868
4869static inline k_tid_t k_work_queue_thread_get(struct k_work_q *queue)
4870{
4871 return queue->thread_id;
4872}
4873
4875
4876struct k_work_user;
4877
4882
4892typedef void (*k_work_user_handler_t)(struct k_work_user *work);
4893
4897struct k_work_user_q {
4898 struct k_queue queue;
4899 struct k_thread thread;
4900};
4901
4902enum {
4903 K_WORK_USER_STATE_PENDING, /* Work item pending state */
4904};
4905
4906struct k_work_user {
4907 void *_reserved; /* Used by k_queue implementation. */
4908 k_work_user_handler_t handler;
4910};
4911
4912#if defined(__cplusplus) && ((__cplusplus - 0) < 202002L)
4913#define Z_WORK_USER_INITIALIZER(work_handler) { NULL, work_handler, 0 }
4914#else
4915#define Z_WORK_USER_INITIALIZER(work_handler) \
4916 { \
4917 ._reserved = NULL, \
4918 .handler = (work_handler), \
4919 .flags = 0 \
4920 }
4921#endif
4925
4937#define K_WORK_USER_DEFINE(work, work_handler) \
4938 struct k_work_user work = Z_WORK_USER_INITIALIZER(work_handler)
4939
4949static inline void k_work_user_init(struct k_work_user *work,
4950 k_work_user_handler_t handler)
4951{
4952 *work = (struct k_work_user)Z_WORK_USER_INITIALIZER(handler);
4953}
4954
4971static inline bool k_work_user_is_pending(struct k_work_user *work)
4972{
4973 return atomic_test_bit(&work->flags, K_WORK_USER_STATE_PENDING);
4974}
4975
4994static inline int k_work_user_submit_to_queue(struct k_work_user_q *work_q,
4995 struct k_work_user *work)
4996{
4997 int ret = -EBUSY;
4998
4999 if (!atomic_test_and_set_bit(&work->flags,
5000 K_WORK_USER_STATE_PENDING)) {
5001 ret = k_queue_alloc_append(&work_q->queue, work);
5002
5003 /* Couldn't insert into the queue. Clear the pending bit
5004 * so the work item can be submitted again
5005 */
5006 if (ret != 0) {
5007 atomic_clear_bit(&work->flags,
5008 K_WORK_USER_STATE_PENDING);
5009 }
5010 }
5011
5012 return ret;
5013}
5014
5034void k_work_user_queue_start(struct k_work_user_q *work_q,
5035 k_thread_stack_t *stack,
5036 size_t stack_size, int prio,
5037 const char *name);
5038
5049static inline k_tid_t k_work_user_queue_thread_get(struct k_work_user_q *work_q)
5050{
5051 return &work_q->thread;
5052}
5053
5055
5059struct k_work_poll {
5060 struct k_work work;
5061 struct k_work_q *workq;
5062 struct z_poller poller;
5063 struct k_poll_event *events;
5064 int num_events;
5065 k_work_handler_t real_handler;
5066 struct _timeout timeout;
5067 int poll_result;
5068};
5072
5077
5089#define K_WORK_DEFINE(work, work_handler) \
5090 struct k_work work = Z_WORK_INITIALIZER(work_handler)
5091
5101void k_work_poll_init(struct k_work_poll *work,
5102 k_work_handler_t handler);
5103
5139 struct k_work_poll *work,
5140 struct k_poll_event *events,
5141 int num_events,
5142 k_timeout_t timeout);
5143
5175int k_work_poll_submit(struct k_work_poll *work,
5176 struct k_poll_event *events,
5177 int num_events,
5178 k_timeout_t timeout);
5179
5194int k_work_poll_cancel(struct k_work_poll *work);
5195
5197
5203
5209struct k_msgq {
5214 _wait_q_t wait_q;
5216 struct k_spinlock lock;
5218 size_t msg_size;
5220 uint32_t max_msgs;
5222 char *buffer_start;
5224 char *buffer_end;
5226 char *read_ptr;
5228 char *write_ptr;
5230 uint32_t used_msgs;
5231
5232 Z_DECL_POLL_EVENT
5233
5235 uint8_t flags;
5236
5238
5239#ifdef CONFIG_OBJ_CORE_MSGQ
5240 struct k_obj_core obj_core;
5241#endif
5245};
5246
5250#define Z_MSGQ_INITIALIZER(obj, q_buffer, q_msg_size, q_max_msgs) \
5251 { \
5252 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
5253 .lock = {}, \
5254 .msg_size = q_msg_size, \
5255 .max_msgs = q_max_msgs, \
5256 .buffer_start = q_buffer, \
5257 .buffer_end = q_buffer + (q_max_msgs * q_msg_size), \
5258 .read_ptr = q_buffer, \
5259 .write_ptr = q_buffer, \
5260 .used_msgs = 0, \
5261 Z_POLL_EVENT_OBJ_INIT(obj) \
5262 .flags = 0, \
5263 }
5267
5268
5269#define K_MSGQ_FLAG_ALLOC BIT(0)
5270
5282
5283
5302#define K_MSGQ_DEFINE(q_name, q_msg_size, q_max_msgs, q_align) \
5303 static char __noinit __aligned(q_align) \
5304 _k_fifo_buf_##q_name[(q_max_msgs) * (q_msg_size)]; \
5305 STRUCT_SECTION_ITERABLE(k_msgq, q_name) = \
5306 Z_MSGQ_INITIALIZER(q_name, _k_fifo_buf_##q_name, \
5307 (q_msg_size), (q_max_msgs))
5308
5323void k_msgq_init(struct k_msgq *msgq, char *buffer, size_t msg_size,
5324 uint32_t max_msgs);
5325
5345__syscall int k_msgq_alloc_init(struct k_msgq *msgq, size_t msg_size,
5346 uint32_t max_msgs);
5347
5358int k_msgq_cleanup(struct k_msgq *msgq);
5359
5380__syscall int k_msgq_put(struct k_msgq *msgq, const void *data, k_timeout_t timeout);
5381
5406__syscall int k_msgq_put_front(struct k_msgq *msgq, const void *data);
5407
5428__syscall int k_msgq_get(struct k_msgq *msgq, void *data, k_timeout_t timeout);
5429
5444__syscall int k_msgq_peek(struct k_msgq *msgq, void *data);
5445
5462__syscall int k_msgq_peek_at(struct k_msgq *msgq, void *data, uint32_t idx);
5463
5473__syscall void k_msgq_purge(struct k_msgq *msgq);
5474
5485__syscall uint32_t k_msgq_num_free_get(struct k_msgq *msgq);
5486
5495__syscall void k_msgq_get_attrs(struct k_msgq *msgq,
5496 struct k_msgq_attrs *attrs);
5497
5498
5499static inline uint32_t z_impl_k_msgq_num_free_get(struct k_msgq *msgq)
5500{
5501 return msgq->max_msgs - msgq->used_msgs;
5502}
5503
5513__syscall uint32_t k_msgq_num_used_get(struct k_msgq *msgq);
5514
5515static inline uint32_t z_impl_k_msgq_num_used_get(struct k_msgq *msgq)
5516{
5517 return msgq->used_msgs;
5518}
5519
5521
5527
5534 size_t size;
5538 void *tx_data;
5547 k_tid_t _syncing_thread;
5548#if (CONFIG_NUM_MBOX_ASYNC_MSGS > 0)
5550 struct k_sem *_async_sem;
5551#endif
5555};
5556
5561struct k_mbox {
5566 _wait_q_t tx_msg_queue;
5568 _wait_q_t rx_msg_queue;
5569 struct k_spinlock lock;
5570
5572
5573#ifdef CONFIG_OBJ_CORE_MAILBOX
5574 struct k_obj_core obj_core;
5575#endif
5579};
5580
5584#define Z_MBOX_INITIALIZER(obj) \
5585 { \
5586 .tx_msg_queue = Z_WAIT_Q_INIT(&obj.tx_msg_queue), \
5587 .rx_msg_queue = Z_WAIT_Q_INIT(&obj.rx_msg_queue), \
5588 }
5592
5602#define K_MBOX_DEFINE(name) \
5603 STRUCT_SECTION_ITERABLE(k_mbox, name) = \
5604 Z_MBOX_INITIALIZER(name) \
5605
5606
5613void k_mbox_init(struct k_mbox *mbox);
5614
5634int k_mbox_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg,
5635 k_timeout_t timeout);
5636
5650void k_mbox_async_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg,
5651 struct k_sem *sem);
5652
5670int k_mbox_get(struct k_mbox *mbox, struct k_mbox_msg *rx_msg,
5671 void *buffer, k_timeout_t timeout);
5672
5686void k_mbox_data_get(struct k_mbox_msg *rx_msg, void *buffer);
5687
5689
5695
5705__syscall void k_pipe_init(struct k_pipe *pipe, uint8_t *buffer, size_t buffer_size);
5706
5711
5717struct k_pipe {
5721 size_t waiting;
5722 struct ring_buf buf;
5723 struct k_spinlock lock;
5724 _wait_q_t data;
5725 _wait_q_t space;
5726 uint8_t flags;
5727
5728 Z_DECL_POLL_EVENT
5729#ifdef CONFIG_OBJ_CORE_PIPE
5730 struct k_obj_core obj_core;
5731#endif
5736};
5737
5741#define Z_PIPE_INITIALIZER(obj, pipe_buffer, pipe_buffer_size) \
5742{ \
5743 .waiting = 0, \
5744 .buf = RING_BUF_INIT(pipe_buffer, pipe_buffer_size), \
5745 .data = Z_WAIT_Q_INIT(&obj.data), \
5746 .space = Z_WAIT_Q_INIT(&obj.space), \
5747 .flags = PIPE_FLAG_OPEN, \
5748 Z_POLL_EVENT_OBJ_INIT(obj) \
5749}
5753
5767#define K_PIPE_DEFINE(name, pipe_buffer_size, pipe_align) \
5768 static unsigned char __noinit __aligned(pipe_align) \
5769 _k_pipe_buf_##name[pipe_buffer_size]; \
5770 STRUCT_SECTION_ITERABLE(k_pipe, name) = \
5771 Z_PIPE_INITIALIZER(name, _k_pipe_buf_##name, pipe_buffer_size)
5772
5773
5790__syscall int k_pipe_write(struct k_pipe *pipe, const uint8_t *data, size_t len,
5791 k_timeout_t timeout);
5792
5808__syscall int k_pipe_read(struct k_pipe *pipe, uint8_t *data, size_t len,
5809 k_timeout_t timeout);
5810
5820__syscall void k_pipe_reset(struct k_pipe *pipe);
5821
5830__syscall void k_pipe_close(struct k_pipe *pipe);
5832
5836struct k_mem_slab_info {
5837 uint32_t num_blocks;
5838 size_t block_size;
5839 uint32_t num_used;
5840#ifdef CONFIG_MEM_SLAB_TRACE_MAX_UTILIZATION
5841 uint32_t max_used;
5842#endif
5843};
5844
5845struct k_mem_slab {
5846 _wait_q_t wait_q;
5847 struct k_spinlock lock;
5848 char *buffer;
5849 char *free_list;
5850 struct k_mem_slab_info info;
5851
5853
5854#ifdef CONFIG_OBJ_CORE_MEM_SLAB
5855 struct k_obj_core obj_core;
5856#endif
5857};
5858
5859#define Z_MEM_SLAB_INITIALIZER(_slab, _slab_buffer, _slab_block_size, \
5860 _slab_num_blocks) \
5861 { \
5862 .wait_q = Z_WAIT_Q_INIT(&(_slab).wait_q), \
5863 .lock = {}, \
5864 .buffer = _slab_buffer, \
5865 .free_list = NULL, \
5866 .info = {_slab_num_blocks, _slab_block_size, 0} \
5867 }
5871
5877
5903#define K_MEM_SLAB_DEFINE_IN_SECT(name, in_section, slab_block_size, slab_num_blocks, slab_align) \
5904 BUILD_ASSERT(((slab_block_size) % (slab_align)) == 0, \
5905 "slab_block_size must be a multiple of slab_align"); \
5906 BUILD_ASSERT((((slab_align) & ((slab_align) - 1)) == 0), \
5907 "slab_align must be a power of 2"); \
5908 char in_section __aligned(WB_UP( \
5909 slab_align)) _k_mem_slab_buf_##name[(slab_num_blocks) * WB_UP(slab_block_size)]; \
5910 STRUCT_SECTION_ITERABLE(k_mem_slab, name) = Z_MEM_SLAB_INITIALIZER( \
5911 name, _k_mem_slab_buf_##name, WB_UP(slab_block_size), slab_num_blocks)
5912
5936#define K_MEM_SLAB_DEFINE(name, slab_block_size, slab_num_blocks, slab_align) \
5937 K_MEM_SLAB_DEFINE_IN_SECT(name, __noinit_named(k_mem_slab_buf_##name), slab_block_size, \
5938 slab_num_blocks, slab_align)
5939
5961#define K_MEM_SLAB_DEFINE_TYPE(name, type, slab_num_blocks) \
5962 K_MEM_SLAB_DEFINE(name, sizeof(type), slab_num_blocks, __alignof(type))
5963
5980#define K_MEM_SLAB_DEFINE_IN_SECT_STATIC(name, in_section, slab_block_size, slab_num_blocks, \
5981 slab_align) \
5982 BUILD_ASSERT(((slab_block_size) % (slab_align)) == 0, \
5983 "slab_block_size must be a multiple of slab_align"); \
5984 BUILD_ASSERT((((slab_align) & ((slab_align) - 1)) == 0), \
5985 "slab_align must be a power of 2"); \
5986 static char in_section __aligned(WB_UP( \
5987 slab_align)) _k_mem_slab_buf_##name[(slab_num_blocks) * WB_UP(slab_block_size)]; \
5988 static STRUCT_SECTION_ITERABLE(k_mem_slab, name) = Z_MEM_SLAB_INITIALIZER( \
5989 name, _k_mem_slab_buf_##name, WB_UP(slab_block_size), slab_num_blocks)
5990
6005#define K_MEM_SLAB_DEFINE_STATIC(name, slab_block_size, slab_num_blocks, slab_align) \
6006 K_MEM_SLAB_DEFINE_IN_SECT_STATIC(name, __noinit_named(k_mem_slab_buf_##name), \
6007 slab_block_size, slab_num_blocks, slab_align)
6008
6021#define K_MEM_SLAB_DEFINE_STATIC_TYPE(name, type, slab_num_blocks) \
6022 K_MEM_SLAB_DEFINE_STATIC(name, sizeof(type), slab_num_blocks, __alignof(type))
6023
6045int k_mem_slab_init(struct k_mem_slab *slab, void *buffer,
6046 size_t block_size, uint32_t num_blocks);
6047
6070int k_mem_slab_alloc(struct k_mem_slab *slab, void **mem,
6071 k_timeout_t timeout);
6072
6084void k_mem_slab_free(struct k_mem_slab *slab, void *mem);
6085
6098static inline uint32_t k_mem_slab_num_used_get(struct k_mem_slab *slab)
6099{
6100 return slab->info.num_used;
6101}
6102
6115static inline uint32_t k_mem_slab_max_used_get(struct k_mem_slab *slab)
6116{
6117#ifdef CONFIG_MEM_SLAB_TRACE_MAX_UTILIZATION
6118 return slab->info.max_used;
6119#else
6120 ARG_UNUSED(slab);
6121 return 0;
6122#endif
6123}
6124
6137static inline uint32_t k_mem_slab_num_free_get(struct k_mem_slab *slab)
6138{
6139 return slab->info.num_blocks - slab->info.num_used;
6140}
6141
6155
6156int k_mem_slab_runtime_stats_get(struct k_mem_slab *slab, struct sys_memory_stats *stats);
6157
6171int k_mem_slab_runtime_stats_reset_max(struct k_mem_slab *slab);
6172
6174
6179
6185struct k_heap {
6189 struct sys_heap heap;
6190 _wait_q_t wait_q;
6191 struct k_spinlock lock;
6195};
6196
6210void k_heap_init(struct k_heap *h, void *mem,
6211 size_t bytes) __attribute_nonnull(1);
6212
6233void *k_heap_aligned_alloc(struct k_heap *h, size_t align, size_t bytes,
6234 k_timeout_t timeout) __attribute_nonnull(1);
6235
6257void *k_heap_alloc(struct k_heap *h, size_t bytes,
6258 k_timeout_t timeout) __attribute_nonnull(1);
6259
6282void *k_heap_calloc(struct k_heap *h, size_t num, size_t size, k_timeout_t timeout)
6283 __attribute_nonnull(1);
6284
6308void *k_heap_realloc(struct k_heap *h, void *ptr, size_t bytes, k_timeout_t timeout)
6309 __attribute_nonnull(1);
6310
6321void k_heap_free(struct k_heap *h, void *mem) __attribute_nonnull(1);
6322
6323/*
6324 * Heap sizing constants computed at build time from actual struct layouts
6325 * in lib/heap/heap_constants.c via the gen_offset mechanism.
6326 */
6327#include <zephyr/heap_constants.h>
6328
6329/* chunk0 size in bytes for nb buckets (includes trailer metadata) */
6330#define _Z_HEAP_C0(nb) \
6331 (ROUND_UP(___z_heap_struct_SIZEOF + \
6332 (nb) * ___z_heap_bucket_SIZEOF, ___z_heap_chunk_unit_SIZEOF) + \
6333 ___z_heap_trailer_SIZEOF)
6334
6335/* Allocation chunk size in bytes (header + data rounded up, plus trailer) */
6336#define _Z_HEAP_AC(ab) \
6337 (ROUND_UP(___z_heap_hdr_SIZEOF + (ab), ___z_heap_chunk_unit_SIZEOF) + \
6338 ___z_heap_trailer_SIZEOF)
6339
6340/* Total heap size in chunk units */
6341#define _Z_HEAP_SZ(nb, ab) \
6342 ((_Z_HEAP_C0(nb) + _Z_HEAP_AC(ab)) / ___z_heap_chunk_unit_SIZEOF)
6343
6344/* Bucket count from heap size in chunk units (mirrors bucket_idx() + 1) */
6345#define _Z_HEAP_NB(sz) \
6346 (32 - __builtin_clz((unsigned int)((sz) - \
6347 ___z_heap_min_chunk_SIZEOF + 1)))
6348
6349/* 3-round convergent iteration starting from 1 bucket */
6350#define _Z_HEAP_NB1(ab) _Z_HEAP_NB(_Z_HEAP_SZ(1, ab))
6351#define _Z_HEAP_NB2(ab) _Z_HEAP_NB(_Z_HEAP_SZ(_Z_HEAP_NB1(ab), ab))
6352#define _Z_HEAP_NB3(ab) _Z_HEAP_NB(_Z_HEAP_SZ(_Z_HEAP_NB2(ab), ab))
6353
6367#define Z_HEAP_MIN_SIZE_FOR(alloc_bytes) \
6368 (_Z_HEAP_C0(_Z_HEAP_NB3(alloc_bytes)) + \
6369 _Z_HEAP_AC(alloc_bytes) + ___z_heap_ftr_SIZEOF)
6370
6371#define Z_HEAP_MIN_SIZE Z_HEAP_MIN_SIZE_FOR(1)
6372
6389#define Z_HEAP_DEFINE_IN_SECT(name, bytes, in_section) \
6390 char in_section \
6391 __aligned(8) /* CHUNK_UNIT */ \
6392 kheap_##name[MAX(bytes, Z_HEAP_MIN_SIZE)]; \
6393 STRUCT_SECTION_ITERABLE(k_heap, name) = { \
6394 .heap = { \
6395 .init_mem = kheap_##name, \
6396 .init_bytes = MAX(bytes, Z_HEAP_MIN_SIZE), \
6397 }, \
6398 }
6399
6414#define K_HEAP_DEFINE(name, bytes) \
6415 Z_HEAP_DEFINE_IN_SECT(name, bytes, \
6416 __noinit_named(kheap_buf_##name))
6417
6432#define K_HEAP_DEFINE_NOCACHE(name, bytes) \
6433 Z_HEAP_DEFINE_IN_SECT(name, bytes, __nocache)
6434
6444int k_heap_array_get(struct k_heap **heap);
6445
6449
6456
6475void *k_aligned_alloc(size_t align, size_t size);
6476
6488void *k_malloc(size_t size);
6489
6500void k_free(void *ptr);
6501
6513void *k_calloc(size_t nmemb, size_t size);
6514
6532void *k_realloc(void *ptr, size_t size);
6533
6535
6536/* polling API - PRIVATE */
6537
6538#ifdef CONFIG_POLL
6539#define _INIT_OBJ_POLL_EVENT(obj) do { (obj)->poll_event = NULL; } while (false)
6540#else
6541#define _INIT_OBJ_POLL_EVENT(obj) do { } while (false)
6542#endif
6543
6544/* private - types bit positions */
6545enum _poll_types_bits {
6546 /* can be used to ignore an event */
6547 _POLL_TYPE_IGNORE,
6548
6549 /* to be signaled by k_poll_signal_raise() */
6550 _POLL_TYPE_SIGNAL,
6551
6552 /* semaphore availability */
6553 _POLL_TYPE_SEM_AVAILABLE,
6554
6555 /* queue/FIFO/LIFO data availability */
6556 _POLL_TYPE_DATA_AVAILABLE,
6557
6558 /* msgq data availability */
6559 _POLL_TYPE_MSGQ_DATA_AVAILABLE,
6560
6561 /* pipe data availability */
6562 _POLL_TYPE_PIPE_DATA_AVAILABLE,
6563
6564 _POLL_NUM_TYPES
6565};
6566
6567#define Z_POLL_TYPE_BIT(type) (1U << ((type) - 1U))
6568
6569/* private - states bit positions */
6570enum _poll_states_bits {
6571 /* default state when creating event */
6572 _POLL_STATE_NOT_READY,
6573
6574 /* signaled by k_poll_signal_raise() */
6575 _POLL_STATE_SIGNALED,
6576
6577 /* semaphore is available */
6578 _POLL_STATE_SEM_AVAILABLE,
6579
6580 /* data is available to read on queue/FIFO/LIFO */
6581 _POLL_STATE_DATA_AVAILABLE,
6582
6583 /* queue/FIFO/LIFO wait was cancelled */
6584 _POLL_STATE_CANCELLED,
6585
6586 /* data is available to read on a message queue */
6587 _POLL_STATE_MSGQ_DATA_AVAILABLE,
6588
6589 /* data is available to read from a pipe */
6590 _POLL_STATE_PIPE_DATA_AVAILABLE,
6591
6592 _POLL_NUM_STATES
6593};
6594
6595#define Z_POLL_STATE_BIT(state) (1U << ((state) - 1U))
6596
6597#define _POLL_EVENT_NUM_UNUSED_BITS \
6598 (32 - (0 \
6599 + 8 /* tag */ \
6600 + _POLL_NUM_TYPES \
6601 + _POLL_NUM_STATES \
6602 + 1 /* modes */ \
6603 ))
6604
6605/* end of polling API - PRIVATE */
6606
6607
6615
6616/* Public polling API */
6617
6618/* public - values for k_poll_event.type bitfield */
6619#define K_POLL_TYPE_IGNORE 0
6620#define K_POLL_TYPE_SIGNAL Z_POLL_TYPE_BIT(_POLL_TYPE_SIGNAL)
6621#define K_POLL_TYPE_SEM_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_SEM_AVAILABLE)
6622#define K_POLL_TYPE_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_DATA_AVAILABLE)
6623#define K_POLL_TYPE_FIFO_DATA_AVAILABLE K_POLL_TYPE_DATA_AVAILABLE
6624#define K_POLL_TYPE_MSGQ_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_MSGQ_DATA_AVAILABLE)
6625#define K_POLL_TYPE_PIPE_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_PIPE_DATA_AVAILABLE)
6626
6627/* public - polling modes */
6629 /* polling thread does not take ownership of objects when available */
6631
6633};
6634
6635/* public - values for k_poll_event.state bitfield */
6636#define K_POLL_STATE_NOT_READY 0
6637#define K_POLL_STATE_SIGNALED Z_POLL_STATE_BIT(_POLL_STATE_SIGNALED)
6638#define K_POLL_STATE_SEM_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_SEM_AVAILABLE)
6639#define K_POLL_STATE_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_DATA_AVAILABLE)
6640#define K_POLL_STATE_FIFO_DATA_AVAILABLE K_POLL_STATE_DATA_AVAILABLE
6641#define K_POLL_STATE_MSGQ_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_MSGQ_DATA_AVAILABLE)
6642#define K_POLL_STATE_PIPE_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_PIPE_DATA_AVAILABLE)
6643#define K_POLL_STATE_CANCELLED Z_POLL_STATE_BIT(_POLL_STATE_CANCELLED)
6644
6645/* public - poll signal object */
6651 sys_dlist_t poll_events;
6655
6660 unsigned int signaled;
6661
6664};
6665
6666#define K_POLL_SIGNAL_INITIALIZER(obj) \
6667 { \
6668 .poll_events = SYS_DLIST_STATIC_INIT(&obj.poll_events), \
6669 .signaled = 0, \
6670 .result = 0, \
6671 }
6672
6681 sys_dnode_t _node;
6682
6684 struct z_poller *poller;
6688
6691
6693 uint32_t type:_POLL_NUM_TYPES;
6694
6696 uint32_t state:_POLL_NUM_STATES;
6697
6700
6702 uint32_t unused:_POLL_EVENT_NUM_UNUSED_BITS;
6703
6705 union {
6706 /* The typed_* fields below are used by K_POLL_EVENT_*INITIALIZER() macros to ensure
6707 * type safety of polled objects.
6708 */
6716 };
6717};
6718
6719#define K_POLL_EVENT_INITIALIZER(_event_type, _event_mode, _event_obj) \
6720 { \
6721 .poller = NULL, \
6722 .type = _event_type, \
6723 .state = K_POLL_STATE_NOT_READY, \
6724 .mode = _event_mode, \
6725 .unused = 0, \
6726 { \
6727 .typed_##_event_type = _event_obj, \
6728 }, \
6729 }
6730
6731#define K_POLL_EVENT_STATIC_INITIALIZER(_event_type, _event_mode, _event_obj, \
6732 event_tag) \
6733 { \
6734 .tag = event_tag, \
6735 .type = _event_type, \
6736 .state = K_POLL_STATE_NOT_READY, \
6737 .mode = _event_mode, \
6738 .unused = 0, \
6739 { \
6740 .typed_##_event_type = _event_obj, \
6741 }, \
6742 }
6743
6758
6759void k_poll_event_init(struct k_poll_event *event, uint32_t type,
6760 int mode, void *obj);
6761
6804
6805__syscall int k_poll(struct k_poll_event *events, int num_events,
6806 k_timeout_t timeout);
6807
6815
6816__syscall void k_poll_signal_init(struct k_poll_signal *sig);
6817
6823__syscall void k_poll_signal_reset(struct k_poll_signal *sig);
6824
6835__syscall void k_poll_signal_check(struct k_poll_signal *sig,
6836 unsigned int *signaled, int *result);
6837
6861
6862__syscall int k_poll_signal_raise(struct k_poll_signal *sig, int result);
6863
6865
6884static inline void k_cpu_idle(void)
6885{
6886 arch_cpu_idle();
6887}
6888
6903static inline void k_cpu_atomic_idle(unsigned int key)
6904{
6906}
6907
6911
6916#ifdef ARCH_EXCEPT
6917/* This architecture has direct support for triggering a CPU exception */
6918#define z_except_reason(reason) ARCH_EXCEPT(reason)
6919#else
6920
6921#if !defined(CONFIG_ASSERT_NO_FILE_INFO)
6922#define __EXCEPT_LOC() __ASSERT_PRINT("@ %s:%d\n", __FILE__, __LINE__)
6923#else
6924#define __EXCEPT_LOC()
6925#endif
6926
6927/* NOTE: This is the implementation for arches that do not implement
6928 * ARCH_EXCEPT() to generate a real CPU exception.
6929 *
6930 * We won't have a real exception frame to determine the PC value when
6931 * the oops occurred, so print file and line number before we jump into
6932 * the fatal error handler.
6933 */
6934#define z_except_reason(reason) do { \
6935 __EXCEPT_LOC(); \
6936 z_fatal_error(reason, NULL); \
6937 } while (false)
6938
6939#endif /* _ARCH__EXCEPT */
6943
6955#define k_oops() z_except_reason(K_ERR_KERNEL_OOPS)
6956
6965#define k_panic() z_except_reason(K_ERR_KERNEL_PANIC)
6966
6970/*
6971 * private APIs that are utilized by one or more public APIs
6972 */
6973
6977void z_timer_expiration_handler(struct _timeout *timeout);
6981
6982#ifdef CONFIG_PRINTK
6990__syscall void k_str_out(char *c, size_t n);
6991#endif
6992
6998
7019__syscall int k_float_disable(struct k_thread *thread);
7020
7059__syscall int k_float_enable(struct k_thread *thread, unsigned int options);
7060
7064
7074
7082
7091
7102
7113
7123
7132
7141
7142#ifdef __cplusplus
7143}
7144#endif
7145
7146#include <zephyr/tracing/tracing.h>
7147#include <zephyr/syscalls/kernel.h>
7148
7149#endif /* !_ASMLANGUAGE */
7150
7151#endif /* ZEPHYR_INCLUDE_KERNEL_H_ */
void(* k_thread_entry_t)(void *p1, void *p2, void *p3)
Thread entry point function type.
Definition arch_interface.h:48
struct z_thread_stack_element k_thread_stack_t
Typedef of struct z_thread_stack_element.
Definition arch_interface.h:46
System error numbers.
void arch_cpu_atomic_idle(unsigned int key)
Atomically re-enable interrupts and enter low power mode.
void arch_cpu_idle(void)
Power save idle routine.
static uint32_t arch_k_cycle_get_32(void)
Obtain the current cycle count, in units specified by CONFIG_SYS_CLOCK_HW_CYCLES_PER_SEC.
static uint64_t arch_k_cycle_get_64(void)
As for arch_k_cycle_get_32(), but with a 64 bit return value.
long atomic_t
Atomic integer variable.
Definition atomic_types.h:31
static bool atomic_test_bit(const atomic_t *target, int bit)
Atomically get and test a bit.
Definition atomic.h:135
static void atomic_clear_bit(atomic_t *target, int bit)
Atomically clear a bit.
Definition atomic.h:224
static bool atomic_test_and_set_bit(atomic_t *target, int bit)
Atomically set a bit and test it.
Definition atomic.h:178
static uint32_t k_cycle_get_32(void)
Read the hardware clock.
Definition kernel.h:2259
#define K_NO_WAIT
Generate null timeout delay.
Definition kernel.h:1572
int64_t k_uptime_ticks(void)
Get system uptime, in system ticks.
static uint32_t k_uptime_get_32(void)
Get system uptime (32-bit version).
Definition kernel.h:2211
uint32_t k_ticks_t
Tick precision used in timeout APIs.
Definition clock.h:48
static int64_t k_uptime_delta(int64_t *reftime)
Get elapsed time, and update the referenced time.
Definition kernel.h:2240
static uint32_t k_uptime_seconds(void)
Get system uptime in seconds.
Definition kernel.h:2224
static uint64_t k_cycle_get_64(void)
Read the 64-bit hardware clock.
Definition kernel.h:2274
static int64_t k_uptime_get(void)
Get system uptime.
Definition kernel.h:2187
int k_condvar_signal(struct k_condvar *condvar)
Signals one thread that is pending on the condition variable.
int k_condvar_wait(struct k_condvar *condvar, struct k_mutex *mutex, k_timeout_t timeout)
Waits on the condition variable releasing the mutex lock.
int k_condvar_init(struct k_condvar *condvar)
Initialize a condition variable.
int k_condvar_broadcast(struct k_condvar *condvar)
Unblock all threads that are pending on the condition variable.
static void k_cpu_idle(void)
Make the CPU idle.
Definition kernel.h:6884
static void k_cpu_atomic_idle(unsigned int key)
Make the CPU idle in an atomic fashion.
Definition kernel.h:6903
struct _dnode sys_dnode_t
Doubly-linked list node structure.
Definition dlist.h:57
struct _dnode sys_dlist_t
Doubly-linked list structure.
Definition dlist.h:53
static void sys_dnode_init(sys_dnode_t *node)
initialize node to its state when not in a list
Definition dlist.h:222
uint32_t k_event_wait(struct k_event *event, uint32_t events, bool reset, k_timeout_t timeout)
Wait for any of the specified events.
uint32_t k_event_set_masked(struct k_event *event, uint32_t events, uint32_t events_mask)
Set or clear the events in an event object.
uint32_t k_event_wait_all_safe(struct k_event *event, uint32_t events, bool reset, k_timeout_t timeout)
Wait for all of the specified events (safe version).
static uint32_t k_event_test(struct k_event *event, uint32_t events_mask)
Test the events currently tracked in the event object.
Definition kernel.h:2910
uint32_t k_event_wait_safe(struct k_event *event, uint32_t events, bool reset, k_timeout_t timeout)
Wait for any of the specified events (safe version).
uint32_t k_event_set(struct k_event *event, uint32_t events)
Set the events in an event object.
uint32_t k_event_post(struct k_event *event, uint32_t events)
Post one or more events to an event object.
void k_event_init(struct k_event *event)
Initialize an event object.
uint32_t k_event_clear(struct k_event *event, uint32_t events)
Clear the events in an event object.
uint32_t k_event_wait_all(struct k_event *event, uint32_t events, bool reset, k_timeout_t timeout)
Wait for all of the specified events.
static bool sys_sflist_is_empty(const sys_sflist_t *list)
Test if the given list is empty.
Definition sflist.h:339
struct _sflist sys_sflist_t
Flagged single-linked list structure.
Definition sflist.h:57
int k_float_disable(struct k_thread *thread)
Disable preservation of floating point context information.
int k_float_enable(struct k_thread *thread, unsigned int options)
Enable preservation of floating point context information.
int k_futex_wait(struct k_futex *futex, int expected, k_timeout_t timeout)
Pend the current thread on a futex.
int k_futex_wake(struct k_futex *futex, bool wake_all)
Wake one/all threads pending on a futex.
void * k_heap_alloc(struct k_heap *h, size_t bytes, k_timeout_t timeout)
Allocate memory from a k_heap.
int k_heap_array_get(struct k_heap **heap)
Get the array of statically defined heaps.
void * k_heap_calloc(struct k_heap *h, size_t num, size_t size, k_timeout_t timeout)
Allocate and initialize memory for an array of objects from a k_heap.
void k_heap_free(struct k_heap *h, void *mem)
Free memory allocated by k_heap_alloc().
void k_free(void *ptr)
Free memory allocated from heap.
void * k_realloc(void *ptr, size_t size)
Expand the size of an existing allocation.
void k_heap_init(struct k_heap *h, void *mem, size_t bytes)
Initialize a k_heap.
void * k_malloc(size_t size)
Allocate memory from the heap.
void * k_heap_realloc(struct k_heap *h, void *ptr, size_t bytes, k_timeout_t timeout)
Reallocate memory from a k_heap.
void * k_calloc(size_t nmemb, size_t size)
Allocate memory from heap, array style.
void * k_aligned_alloc(size_t align, size_t size)
Allocate memory from the heap with a specified alignment.
void * k_heap_aligned_alloc(struct k_heap *h, size_t align, size_t bytes, k_timeout_t timeout)
Allocate aligned memory from a k_heap.
bool k_is_in_isr(void)
Determine if code is running at interrupt level.
int k_is_preempt_thread(void)
Determine if code is running in a preemptible thread.
int k_mbox_get(struct k_mbox *mbox, struct k_mbox_msg *rx_msg, void *buffer, k_timeout_t timeout)
Receive a mailbox message.
void k_mbox_data_get(struct k_mbox_msg *rx_msg, void *buffer)
Retrieve mailbox message data into a buffer.
void k_mbox_init(struct k_mbox *mbox)
Initialize a mailbox.
int k_mbox_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg, k_timeout_t timeout)
Send a mailbox message in a synchronous manner.
void k_mbox_async_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg, struct k_sem *sem)
Send a mailbox message in an asynchronous manner.
int k_mem_slab_init(struct k_mem_slab *slab, void *buffer, size_t block_size, uint32_t num_blocks)
Initialize a memory slab.
void k_mem_slab_free(struct k_mem_slab *slab, void *mem)
Free memory allocated from a memory slab.
int k_mem_slab_runtime_stats_get(struct k_mem_slab *slab, struct sys_memory_stats *stats)
Get the memory stats for a memory slab.
int k_mem_slab_runtime_stats_reset_max(struct k_mem_slab *slab)
Reset the maximum memory usage for a slab.
int k_mem_slab_alloc(struct k_mem_slab *slab, void **mem, k_timeout_t timeout)
Allocate memory from a memory slab.
static uint32_t k_mem_slab_num_used_get(struct k_mem_slab *slab)
Get the number of used blocks in a memory slab.
Definition kernel.h:6098
static uint32_t k_mem_slab_max_used_get(struct k_mem_slab *slab)
Get the number of maximum used blocks so far in a memory slab.
Definition kernel.h:6115
static uint32_t k_mem_slab_num_free_get(struct k_mem_slab *slab)
Get the number of unused blocks in a memory slab.
Definition kernel.h:6137
int k_msgq_peek(struct k_msgq *msgq, void *data)
Peek/read a message from a message queue.
uint32_t k_msgq_num_used_get(struct k_msgq *msgq)
Get the number of messages in a message queue.
void k_msgq_init(struct k_msgq *msgq, char *buffer, size_t msg_size, uint32_t max_msgs)
Initialize a message queue.
int k_msgq_put(struct k_msgq *msgq, const void *data, k_timeout_t timeout)
Send a message to the end of a message queue.
int k_msgq_peek_at(struct k_msgq *msgq, void *data, uint32_t idx)
Peek/read a message from a message queue at the specified index.
uint32_t k_msgq_num_free_get(struct k_msgq *msgq)
Get the amount of free space in a message queue.
void k_msgq_get_attrs(struct k_msgq *msgq, struct k_msgq_attrs *attrs)
Get basic attributes of a message queue.
void k_msgq_purge(struct k_msgq *msgq)
Purge a message queue.
int k_msgq_alloc_init(struct k_msgq *msgq, size_t msg_size, uint32_t max_msgs)
Initialize a message queue.
int k_msgq_put_front(struct k_msgq *msgq, const void *data)
Send a message to the front of a message queue.
int k_msgq_get(struct k_msgq *msgq, void *data, k_timeout_t timeout)
Receive a message from a message queue.
int k_msgq_cleanup(struct k_msgq *msgq)
Release allocated buffer for a queue.
int k_mutex_unlock(struct k_mutex *mutex)
Unlock a mutex.
int k_mutex_init(struct k_mutex *mutex)
Initialize a mutex.
int k_mutex_lock(struct k_mutex *mutex, k_timeout_t timeout)
Lock a mutex.
int k_pipe_write(struct k_pipe *pipe, const uint8_t *data, size_t len, k_timeout_t timeout)
Write data to a pipe.
void k_pipe_close(struct k_pipe *pipe)
Close a pipe.
void k_pipe_reset(struct k_pipe *pipe)
Reset a pipe This routine resets the pipe, discarding any unread data and unblocking any threads wait...
void k_pipe_init(struct k_pipe *pipe, uint8_t *buffer, size_t buffer_size)
initialize a pipe
pipe_flags
Definition kernel.h:5707
int k_pipe_read(struct k_pipe *pipe, uint8_t *data, size_t len, k_timeout_t timeout)
Read data from a pipe This routine reads up to len bytes of data from pipe.
@ PIPE_FLAG_RESET
Definition kernel.h:5709
@ PIPE_FLAG_OPEN
Definition kernel.h:5708
void k_poll_signal_reset(struct k_poll_signal *sig)
Reset a poll signal object's state to unsignaled.
k_poll_modes
Definition kernel.h:6628
void k_poll_signal_check(struct k_poll_signal *sig, unsigned int *signaled, int *result)
Fetch the signaled state and result value of a poll signal.
void k_poll_event_init(struct k_poll_event *event, uint32_t type, int mode, void *obj)
Initialize one struct k_poll_event instance.
int k_poll(struct k_poll_event *events, int num_events, k_timeout_t timeout)
Wait for one or many of multiple poll events to occur.
int k_poll_signal_raise(struct k_poll_signal *sig, int result)
Signal a poll signal object.
void k_poll_signal_init(struct k_poll_signal *sig)
Initialize a poll signal object.
@ K_POLL_MODE_NOTIFY_ONLY
Definition kernel.h:6630
@ K_POLL_NUM_MODES
Definition kernel.h:6632
void k_queue_init(struct k_queue *queue)
Initialize a queue.
void * k_queue_get(struct k_queue *queue, k_timeout_t timeout)
Get an element from a queue.
void * k_queue_peek_tail(struct k_queue *queue)
Peek element at the tail of queue.
bool k_queue_unique_append(struct k_queue *queue, void *data)
Append an element to a queue only if it's not present already.
bool k_queue_remove(struct k_queue *queue, void *data)
Remove an element from a queue.
int k_queue_merge_slist(struct k_queue *queue, sys_slist_t *list)
Atomically add a list of elements to a queue.
int32_t k_queue_alloc_append(struct k_queue *queue, void *data)
Append an element to a queue.
void k_queue_cancel_wait(struct k_queue *queue)
Cancel waiting on a queue.
void * k_queue_peek_head(struct k_queue *queue)
Peek element at the head of queue.
void k_queue_prepend(struct k_queue *queue, void *data)
Prepend an element to a queue.
int k_queue_append_list(struct k_queue *queue, void *head, void *tail)
Atomically append a list of elements to a queue.
void k_queue_append(struct k_queue *queue, void *data)
Append an element to the end of a queue.
int32_t k_queue_alloc_prepend(struct k_queue *queue, void *data)
Prepend an element to a queue.
void k_queue_insert(struct k_queue *queue, void *prev, void *data)
Inserts an element to a queue.
int k_queue_is_empty(struct k_queue *queue)
Query a queue to see if it has data available.
void k_sem_reset(struct k_sem *sem)
Resets a semaphore's count to zero.
unsigned int k_sem_count_get(struct k_sem *sem)
Get a semaphore's count.
void k_sem_give(struct k_sem *sem)
Give a semaphore.
int k_sem_take(struct k_sem *sem, k_timeout_t timeout)
Take a semaphore.
int k_sem_init(struct k_sem *sem, unsigned int initial_count, unsigned int limit)
Initialize a semaphore.
struct _slist sys_slist_t
Single-linked list structure.
Definition slist.h:52
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:42
int k_stack_pop(struct k_stack *stack, stack_data_t *data, k_timeout_t timeout)
Pop an element from a stack.
void k_stack_init(struct k_stack *stack, stack_data_t *buffer, uint32_t num_entries)
Initialize a stack.
int k_stack_cleanup(struct k_stack *stack)
Release a stack's allocated buffer.
int k_stack_push(struct k_stack *stack, stack_data_t data)
Push an element onto a stack.
int32_t k_stack_alloc_init(struct k_stack *stack, uint32_t num_entries)
Initialize a stack.
#define SYS_PORT_TRACING_TRACKING_FIELD(type)
Field added to kernel objects so they are tracked.
Definition tracing_macros.h:375
#define IS_ENABLED(config_macro)
Check for macro definition in compiler-visible expressions.
Definition util_macro.h:154
#define BIT(n)
Unsigned integer with bit position n set (signed in assembly language).
Definition util_macro.h:44
#define CONTAINER_OF(ptr, type, field)
Get a pointer to a structure containing the element.
Definition util.h:281
#define EBUSY
Mount device busy.
Definition errno.h:54
int k_thread_name_copy(k_tid_t thread, char *buf, size_t size)
Copy the thread name into a supplied buffer.
void k_yield(void)
Yield the current thread.
const char * k_thread_state_str(k_tid_t thread_id, char *buf, size_t buf_size)
Get thread state string.
void k_thread_resume(k_tid_t thread)
Resume a suspended thread.
void * k_thread_custom_data_get(void)
Get current thread's custom data.
void k_thread_abort(k_tid_t thread)
Abort a thread.
int k_thread_name_set(k_tid_t thread, const char *str)
Set current thread name.
void k_thread_priority_set(k_tid_t thread, int prio)
Set a thread's priority.
void k_thread_absolute_deadline_set(k_tid_t thread, int deadline)
Set absolute deadline expiration time for scheduler.
int k_thread_cpu_mask_enable(k_tid_t thread, int cpu)
Enable thread to run on specified CPU.
void k_thread_foreach_unlocked(k_thread_user_cb_t user_cb, void *user_data)
Iterate over all the threads in the system without locking.
bool k_can_yield(void)
Check whether it is possible to yield in the current context.
int k_thread_priority_get(k_tid_t thread)
Get a thread's priority.
static void k_thread_heap_assign(struct k_thread *thread, struct k_heap *heap)
Assign a resource memory pool to a thread.
Definition kernel.h:506
FUNC_NORETURN void k_thread_user_mode_enter(k_thread_entry_t entry, void *p1, void *p2, void *p3)
Drop a thread's privileges permanently to user mode.
int k_thread_join(struct k_thread *thread, k_timeout_t timeout)
Sleep until a thread exits.
k_ticks_t k_thread_timeout_remaining_ticks(const struct k_thread *thread)
Get time remaining before a thread wakes up, in system ticks.
void k_thread_custom_data_set(void *value)
Set current thread's custom data.
int32_t k_sleep(k_timeout_t timeout)
Put the current thread to sleep.
void k_sched_lock(void)
Lock the scheduler.
static int32_t k_msleep(int32_t ms)
Put the current thread to sleep.
Definition kernel.h:702
void k_busy_wait(uint32_t usec_to_wait)
Cause the current thread to busy wait.
void k_thread_time_slice_set(struct k_thread *th, int32_t slice_ticks, k_thread_timeslice_fn_t expired, void *data)
Set thread time slice.
static void k_thread_runtime_stats_longest_frame_reset(__maybe_unused struct k_thread *thread)
Resets thread longest frame usage data for specified thread.
Definition kernel.h:120
void k_thread_suspend(k_tid_t thread)
Suspend a thread.
void k_sched_unlock(void)
Unlock the scheduler.
static __attribute_const__ k_tid_t k_current_get(void)
Get thread ID of the current thread.
Definition kernel.h:836
int k_thread_cpu_mask_clear(k_tid_t thread)
Sets all CPU enable masks to zero.
void k_thread_foreach_filter_by_cpu(unsigned int cpu, k_thread_user_cb_t user_cb, void *user_data)
Iterate over all the threads in running on specified cpu.
void k_sched_time_slice_set(int32_t slice, int prio)
Set time-slicing period and scope.
int k_thread_cpu_mask_disable(k_tid_t thread, int cpu)
Prevent thread to run on specified CPU.
void k_wakeup(k_tid_t thread)
Wake up a sleeping thread.
int k_thread_stack_free(k_thread_stack_t *stack)
Free a dynamically allocated thread stack.
k_ticks_t k_thread_timeout_expires_ticks(const struct k_thread *thread)
Get time when a thread wakes up, in system ticks.
__attribute_const__ k_tid_t k_sched_current_thread_query(void)
Query thread ID of the current thread.
static void k_thread_start(k_tid_t thread)
Start an inactive thread.
Definition kernel.h:1322
k_tid_t k_thread_create(struct k_thread *new_thread, k_thread_stack_t *stack, size_t stack_size, k_thread_entry_t entry, void *p1, void *p2, void *p3, int prio, uint32_t options, k_timeout_t delay)
Create a thread.
void k_reschedule(void)
Invoke the scheduler.
void k_thread_deadline_set(k_tid_t thread, int deadline)
Set relative deadline expiration time for scheduler.
void k_thread_foreach_unlocked_filter_by_cpu(unsigned int cpu, k_thread_user_cb_t user_cb, void *user_data)
Iterate over the threads in running on current cpu without locking.
const char * k_thread_name_get(k_tid_t thread)
Get thread name.
void k_thread_foreach(k_thread_user_cb_t user_cb, void *user_data)
Iterate over all the threads in the system.
static bool k_is_pre_kernel(void)
Test whether startup is in the before-main-task phase.
Definition kernel.h:803
int k_thread_cpu_pin(k_tid_t thread, int cpu)
Pin a thread to a CPU.
int32_t k_usleep(int32_t us)
Put the current thread to sleep with microsecond resolution.
int k_thread_cpu_mask_enable_all(k_tid_t thread)
Sets all CPU enable masks to one.
void(* k_thread_user_cb_t)(const struct k_thread *thread, void *user_data)
Definition kernel.h:127
k_thread_stack_t * k_thread_stack_alloc(size_t size, int flags)
Dynamically allocate a thread stack.
k_ticks_t k_timer_expires_ticks(const struct k_timer *timer)
Get next expiration time of a timer, in system ticks.
void(* k_timer_stop_t)(struct k_timer *timer)
Timer stop function type.
Definition kernel.h:1904
k_ticks_t k_timer_remaining_ticks(const struct k_timer *timer)
Get time remaining before a timer next expires, in system ticks.
void * k_timer_user_data_get(const struct k_timer *timer)
Retrieve the user-specific data from a timer.
void(* k_timer_expiry_t)(struct k_timer *timer)
Timer expiry function type.
Definition kernel.h:1888
void k_timer_init(struct k_timer *timer, k_timer_expiry_t expiry_fn, k_timer_stop_t stop_fn)
Initialize a timer.
int k_timer_cleanup(struct k_timer *timer)
Clean up a dynamically allocated timer before freeing it.
void k_timer_start(struct k_timer *timer, k_timeout_t duration, k_timeout_t period)
Start a timer.
static uint32_t k_timer_remaining_get(struct k_timer *timer)
Get time remaining before a timer next expires.
Definition kernel.h:2089
uint32_t k_timer_status_sync(struct k_timer *timer)
Synchronize thread to timer expiration.
void k_timer_stop(struct k_timer *timer)
Stop a timer.
uint32_t k_timer_status_get(struct k_timer *timer)
Read timer status.
void k_timer_user_data_set(struct k_timer *timer, void *user_data)
Associate user-specific data with a timer.
#define k_ticks_to_ms_floor32(t)
Convert ticks to milliseconds.
Definition time_units.h:1718
#define k_ticks_to_sec_floor32(t)
Convert ticks to seconds.
Definition time_units.h:1622
#define k_ticks_to_ms_floor64(t)
Convert ticks to milliseconds.
Definition time_units.h:1734
int k_work_poll_submit_to_queue(struct k_work_q *work_q, struct k_work_poll *work, struct k_poll_event *events, int num_events, k_timeout_t timeout)
Submit a triggered work item.
static k_tid_t k_work_queue_thread_get(struct k_work_q *queue)
Access the thread that animates a work queue.
Definition kernel.h:4869
static bool k_work_is_pending(const struct k_work *work)
Test whether a work item is currently pending.
Definition kernel.h:4840
int k_work_queue_drain(struct k_work_q *queue, bool plug)
Wait until the work queue has drained, optionally plugging it.
static k_ticks_t k_work_delayable_expires_get(const struct k_work_delayable *dwork)
Get the absolute tick count at which a scheduled delayable work will be submitted.
Definition kernel.h:4857
int k_work_schedule_for_queue(struct k_work_q *queue, struct k_work_delayable *dwork, k_timeout_t delay)
Submit an idle work item to a queue after a delay.
int k_work_delayable_busy_get(const struct k_work_delayable *dwork)
Busy state flags from the delayable work item.
int k_work_queue_stop(struct k_work_q *queue, k_timeout_t timeout)
Stop a work queue.
void k_work_init_delayable(struct k_work_delayable *dwork, k_work_handler_t handler)
Initialize a delayable work structure.
int k_work_poll_cancel(struct k_work_poll *work)
Cancel a triggered work item.
void k_work_user_queue_start(struct k_work_user_q *work_q, k_thread_stack_t *stack, size_t stack_size, int prio, const char *name)
Start a workqueue in user mode.
void k_work_poll_init(struct k_work_poll *work, k_work_handler_t handler)
Initialize a triggered work item.
int k_work_cancel(struct k_work *work)
Cancel a work item.
static int k_work_user_submit_to_queue(struct k_work_user_q *work_q, struct k_work_user *work)
Submit a work item to a user mode workqueue.
Definition kernel.h:4994
int k_work_submit_to_queue(struct k_work_q *queue, struct k_work *work)
Submit a work item to a queue.
static bool k_work_user_is_pending(struct k_work_user *work)
Check if a userspace work item is pending.
Definition kernel.h:4971
void(* k_work_handler_t)(struct k_work *work)
The signature for a work item handler function.
Definition kernel.h:3967
int k_work_schedule(struct k_work_delayable *dwork, k_timeout_t delay)
Submit an idle work item to the system work queue after a delay.
static bool k_work_delayable_is_pending(const struct k_work_delayable *dwork)
Test whether a delayed work item is currently pending.
Definition kernel.h:4851
bool k_work_cancel_delayable_sync(struct k_work_delayable *dwork, struct k_work_sync *sync)
Cancel delayable work and wait.
int k_work_cancel_delayable(struct k_work_delayable *dwork)
Cancel delayable work.
static void k_work_user_init(struct k_work_user *work, k_work_user_handler_t handler)
Initialize a userspace work item.
Definition kernel.h:4949
int k_work_queue_unplug(struct k_work_q *queue)
Release a work queue to accept new submissions.
int k_work_reschedule(struct k_work_delayable *dwork, k_timeout_t delay)
Reschedule a work item to the system work queue after a delay.
void(* k_work_user_handler_t)(struct k_work_user *work)
Work item handler function type for user work queues.
Definition kernel.h:4892
bool k_work_cancel_sync(struct k_work *work, struct k_work_sync *sync)
Cancel a work item and wait for it to complete.
static k_tid_t k_work_user_queue_thread_get(struct k_work_user_q *work_q)
Access the user mode thread that animates a work queue.
Definition kernel.h:5049
int k_work_busy_get(const struct k_work *work)
Busy state flags from the work item.
static struct k_work_delayable * k_work_delayable_from_work(struct k_work *work)
Get the parent delayable work structure from a work pointer.
Definition kernel.h:4846
static k_ticks_t k_work_delayable_remaining_get(const struct k_work_delayable *dwork)
Get the number of ticks until a scheduled delayable work will be submitted.
Definition kernel.h:4863
bool k_work_flush(struct k_work *work, struct k_work_sync *sync)
Wait for last-submitted instance to complete.
int k_work_reschedule_for_queue(struct k_work_q *queue, struct k_work_delayable *dwork, k_timeout_t delay)
Reschedule a work item to a queue after a delay.
void k_work_queue_run(struct k_work_q *queue, const struct k_work_queue_config *cfg)
Run work queue using calling thread.
int k_work_submit(struct k_work *work)
Submit a work item to the system queue.
bool k_work_flush_delayable(struct k_work_delayable *dwork, struct k_work_sync *sync)
Flush delayable work.
int k_work_poll_submit(struct k_work_poll *work, struct k_poll_event *events, int num_events, k_timeout_t timeout)
Submit a triggered work item to the system workqueue.
void k_work_queue_init(struct k_work_q *queue)
Initialize a work queue structure.
void k_work_queue_start(struct k_work_q *queue, k_thread_stack_t *stack, size_t stack_size, int prio, const struct k_work_queue_config *cfg)
Initialize a work queue.
void k_work_init(struct k_work *work, k_work_handler_t handler)
Initialize a (non-delayable) work structure.
@ K_WORK_CANCELING
Flag indicating a work item that is being canceled.
Definition kernel.h:4573
@ K_WORK_QUEUED
Flag indicating a work item that has been submitted to a queue but has not started running.
Definition kernel.h:4580
@ K_WORK_DELAYED
Flag indicating a delayed work item that is scheduled for submission to a queue.
Definition kernel.h:4587
@ K_WORK_RUNNING
Flag indicating a work item that is running under a work queue thread.
Definition kernel.h:4567
@ K_WORK_FLUSHING
Flag indicating a synced work item that is being flushed.
Definition kernel.h:4593
void k_sys_runtime_stats_disable(void)
Disable gathering of system runtime statistics.
int k_thread_runtime_stats_enable(k_tid_t thread)
Enable gathering of runtime statistics for specified thread.
int k_ipi_work_add(struct k_ipi_work *work, uint32_t cpu_bitmask, k_ipi_func_t func)
Add an IPI work item to the IPI work queue.
void k_sys_runtime_stats_enable(void)
Enable gathering of system runtime statistics.
int k_thread_runtime_stats_get(k_tid_t thread, k_thread_runtime_stats_t *stats)
Get the runtime statistics of a thread.
bool k_thread_runtime_stats_is_enabled(k_tid_t thread)
Check if runtime statistics gathering is enabled for a thread.
void k_ipi_work_signal(void)
Signal that there is one or more IPI work items to process.
int k_ipi_work_wait(struct k_ipi_work *work, k_timeout_t timeout)
Wait until the IPI work item has been processed by all targeted CPUs.
execution_context_types
Definition kernel.h:91
@ K_ISR
Definition kernel.h:92
@ K_COOP_THREAD
Definition kernel.h:93
@ K_PREEMPT_THREAD
Definition kernel.h:94
void(* k_ipi_func_t)(struct k_ipi_work *work)
Definition kernel.h:3851
int k_thread_runtime_stats_all_get(k_thread_runtime_stats_t *stats)
Get the runtime statistics of all threads.
static void k_ipi_work_init(struct k_ipi_work *work)
Initialize the specified IPI work item.
Definition kernel.h:3880
int k_thread_runtime_stats_disable(k_tid_t thread)
Disable gathering of runtime statistics for specified thread.
int k_thread_runtime_stats_cpu_get(int cpu, k_thread_runtime_stats_t *stats)
Get the runtime statistics of all threads on specified cpu.
Header files included by kernel.h.
void(* k_thread_timeslice_fn_t)(struct k_thread *thread, void *data)
Definition kernel_structs.h:310
Memory Statistics.
flags
Definition parser.h:97
state
Definition parser_state.h:29
Header file for the ring buffer API.
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__INTPTR_TYPE__ intptr_t
Definition stdint.h:104
__INT32_TYPE__ int32_t
Definition stdint.h:74
__UINT64_TYPE__ uint64_t
Definition stdint.h:91
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINTPTR_TYPE__ uintptr_t
Definition stdint.h:105
__INT64_TYPE__ int64_t
Definition stdint.h:75
Kernel condition variable structure.
Definition kernel.h:3598
Event Structure.
Definition kernel.h:2691
Kernel FIFO structure.
Definition kernel.h:2935
futex structure
Definition kernel.h:2591
atomic_t val
Definition kernel.h:2592
Kernel synchronized heap structure.
Definition kernel.h:6185
IPI work item structure.
Definition kernel.h:3859
Kernel LIFO structure.
Definition kernel.h:3186
Mailbox Message Structure.
Definition kernel.h:5532
k_tid_t tx_target_thread
target thread id
Definition kernel.h:5542
void * tx_data
sender's message data buffer
Definition kernel.h:5538
k_tid_t rx_source_thread
source thread id
Definition kernel.h:5540
uint32_t info
application-defined information value
Definition kernel.h:5536
size_t size
size of message (in bytes)
Definition kernel.h:5534
Mailbox Structure.
Definition kernel.h:5561
Memory Domain.
Definition mem_domain.h:80
Memory Partition.
Definition mem_domain.h:55
Message Queue Attributes.
Definition kernel.h:5274
uint32_t used_msgs
Used messages.
Definition kernel.h:5280
size_t msg_size
Message Size.
Definition kernel.h:5276
uint32_t max_msgs
Maximal number of messages.
Definition kernel.h:5278
Message Queue Structure.
Definition kernel.h:5209
Kernel mutex structure.
Definition kernel.h:3477
Object core structure.
Definition obj_core.h:121
Kernel pipe structure.
Definition kernel.h:5717
Poll Event.
Definition kernel.h:6676
struct k_msgq * typed_K_POLL_TYPE_MSGQ_DATA_AVAILABLE
Definition kernel.h:6714
void * typed_K_POLL_TYPE_IGNORE
Definition kernel.h:6709
struct k_poll_signal * signal
Definition kernel.h:6710
struct k_pipe * pipe
Definition kernel.h:6715
uint32_t tag
optional user-specified tag, opaque, untouched by the API
Definition kernel.h:6690
struct k_fifo * fifo
Definition kernel.h:6712
struct k_msgq * msgq
Definition kernel.h:6714
struct k_queue * queue
Definition kernel.h:6713
uint32_t unused
unused bits in 32-bit word
Definition kernel.h:6702
struct k_pipe * typed_K_POLL_TYPE_PIPE_DATA_AVAILABLE
Definition kernel.h:6715
uint32_t type
bitfield of event types (bitwise-ORed K_POLL_TYPE_xxx values)
Definition kernel.h:6693
struct k_sem * sem
Definition kernel.h:6711
struct k_queue * typed_K_POLL_TYPE_DATA_AVAILABLE
Definition kernel.h:6713
struct k_sem * typed_K_POLL_TYPE_SEM_AVAILABLE
Definition kernel.h:6711
uint32_t state
bitfield of event states (bitwise-ORed K_POLL_STATE_xxx values)
Definition kernel.h:6696
uint32_t mode
mode of operation, from enum k_poll_modes
Definition kernel.h:6699
struct k_poll_signal * typed_K_POLL_TYPE_SIGNAL
Definition kernel.h:6710
void * obj
Definition kernel.h:6709
struct k_fifo * typed_K_POLL_TYPE_FIFO_DATA_AVAILABLE
Definition kernel.h:6712
Definition kernel.h:6646
int result
custom result value passed to k_poll_signal_raise() if needed
Definition kernel.h:6663
unsigned int signaled
1 if the event has been signaled, 0 otherwise.
Definition kernel.h:6660
Kernel queue structure.
Definition kernel.h:2295
Semaphore structure.
Definition kernel.h:3703
Kernel Spin Lock.
Definition spinlock.h:45
Thread Structure.
Definition thread.h:259
struct _thread_base base
Definition thread.h:261
struct k_heap * resource_pool
resource pool
Definition thread.h:357
struct __thread_entry entry
thread entry and parameters description
Definition thread.h:296
Kernel timeout type.
Definition clock.h:65
Kernel timer structure.
Definition kernel.h:1795
A structure used to submit work after a delay.
Definition kernel.h:4643
Kernel workqueue structure.
Definition kernel.h:4799
A structure holding optional configuration items for a work queue.
Definition kernel.h:4757
const char * name
The name to be given to the work queue thread.
Definition kernel.h:4762
uint32_t work_timeout_ms
Controls whether work queue monitors work timeouts.
Definition kernel.h:4791
bool essential
Control whether the work queue thread should be marked as essential thread.
Definition kernel.h:4781
bool no_yield
Control whether the work queue thread should yield between items.
Definition kernel.h:4776
A structure holding internal state for a pending synchronous operation on a work item or queue.
Definition kernel.h:4738
A structure used to submit work.
Definition kernel.h:4601
A structure to represent a ring buffer.
Definition ring_buffer.h:65
Definition sys_heap.h:57
Definition mem_stats.h:24
Iterable sections helpers.
static __pinned_func bool k_is_user_context(void)
Indicate whether the CPU is currently in user mode.
Definition syscall.h:121
struct k_thread * k_tid_t
Definition thread.h:383
struct k_thread_runtime_stats k_thread_runtime_stats_t
Macros to abstract toolchain specific capabilities.
Main header file for tracing subsystem API.
Header file for tracing macros.