Zephyr API Documentation 4.0.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
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>
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
30/*
31 * Zephyr currently assumes the size of a couple standard types to simplify
32 * print string formats. Let's make sure this doesn't change without notice.
33 */
34BUILD_ASSERT(sizeof(int32_t) == sizeof(int));
35BUILD_ASSERT(sizeof(int64_t) == sizeof(long long));
36BUILD_ASSERT(sizeof(intptr_t) == sizeof(long));
37
47#define K_ANY NULL
48
49#if (CONFIG_NUM_COOP_PRIORITIES + CONFIG_NUM_PREEMPT_PRIORITIES) == 0
50#error Zero available thread priorities defined!
51#endif
52
53#define K_PRIO_COOP(x) (-(CONFIG_NUM_COOP_PRIORITIES - (x)))
54#define K_PRIO_PREEMPT(x) (x)
55
56#define K_HIGHEST_THREAD_PRIO (-CONFIG_NUM_COOP_PRIORITIES)
57#define K_LOWEST_THREAD_PRIO CONFIG_NUM_PREEMPT_PRIORITIES
58#define K_IDLE_PRIO K_LOWEST_THREAD_PRIO
59#define K_HIGHEST_APPLICATION_THREAD_PRIO (K_HIGHEST_THREAD_PRIO)
60#define K_LOWEST_APPLICATION_THREAD_PRIO (K_LOWEST_THREAD_PRIO - 1)
61
62#ifdef CONFIG_POLL
63#define Z_POLL_EVENT_OBJ_INIT(obj) \
64 .poll_events = SYS_DLIST_STATIC_INIT(&obj.poll_events),
65#define Z_DECL_POLL_EVENT sys_dlist_t poll_events;
66#else
67#define Z_POLL_EVENT_OBJ_INIT(obj)
68#define Z_DECL_POLL_EVENT
69#endif
70
71struct k_thread;
72struct k_mutex;
73struct k_sem;
74struct k_msgq;
75struct k_mbox;
76struct k_pipe;
77struct k_queue;
78struct k_fifo;
79struct k_lifo;
80struct k_stack;
81struct k_mem_slab;
82struct k_timer;
83struct k_poll_event;
84struct k_poll_signal;
85struct k_mem_domain;
86struct k_mem_partition;
87struct k_futex;
88struct k_event;
89
95
96/* private, used by k_poll and k_work_poll */
97struct k_work_poll;
98typedef int (*_poller_cb_t)(struct k_poll_event *event, uint32_t state);
99
105typedef void (*k_thread_user_cb_t)(const struct k_thread *thread,
106 void *user_data);
107
123void k_thread_foreach(k_thread_user_cb_t user_cb, void *user_data);
124
143#ifdef CONFIG_SMP
144void k_thread_foreach_filter_by_cpu(unsigned int cpu,
145 k_thread_user_cb_t user_cb, void *user_data);
146#else
147static inline
148void k_thread_foreach_filter_by_cpu(unsigned int cpu,
149 k_thread_user_cb_t user_cb, void *user_data)
150{
151 __ASSERT(cpu == 0, "cpu filter out of bounds");
152 ARG_UNUSED(cpu);
153 k_thread_foreach(user_cb, user_data);
154}
155#endif
156
185 k_thread_user_cb_t user_cb, void *user_data);
186
218#ifdef CONFIG_SMP
220 k_thread_user_cb_t user_cb, void *user_data);
221#else
222static inline
223void k_thread_foreach_unlocked_filter_by_cpu(unsigned int cpu,
224 k_thread_user_cb_t user_cb, void *user_data)
225{
226 __ASSERT(cpu == 0, "cpu filter out of bounds");
227 ARG_UNUSED(cpu);
228 k_thread_foreach_unlocked(user_cb, user_data);
229}
230#endif
231
240#endif /* !_ASMLANGUAGE */
241
242
243/*
244 * Thread user options. May be needed by assembly code. Common part uses low
245 * bits, arch-specific use high bits.
246 */
247
251#define K_ESSENTIAL (BIT(0))
252
253#define K_FP_IDX 1
263#define K_FP_REGS (BIT(K_FP_IDX))
264
271#define K_USER (BIT(2))
272
281#define K_INHERIT_PERMS (BIT(3))
282
292#define K_CALLBACK_STATE (BIT(4))
293
303#define K_DSP_IDX 6
304#define K_DSP_REGS (BIT(K_DSP_IDX))
305
314#define K_AGU_IDX 7
315#define K_AGU_REGS (BIT(K_AGU_IDX))
316
326#define K_SSE_REGS (BIT(7))
327
328/* end - thread options */
329
330#if !defined(_ASMLANGUAGE)
345__syscall k_thread_stack_t *k_thread_stack_alloc(size_t size, int flags);
346
360
409__syscall k_tid_t k_thread_create(struct k_thread *new_thread,
410 k_thread_stack_t *stack,
411 size_t stack_size,
413 void *p1, void *p2, void *p3,
414 int prio, uint32_t options, k_timeout_t delay);
415
438 void *p1, void *p2,
439 void *p3);
440
454#define k_thread_access_grant(thread, ...) \
455 FOR_EACH_FIXED_ARG(k_object_access_grant, (;), (thread), __VA_ARGS__)
456
471static inline void k_thread_heap_assign(struct k_thread *thread,
472 struct k_heap *heap)
473{
474 thread->resource_pool = heap;
475}
476
477#if defined(CONFIG_INIT_STACKS) && defined(CONFIG_THREAD_STACK_INFO)
498__syscall int k_thread_stack_space_get(const struct k_thread *thread,
499 size_t *unused_ptr);
500#endif
501
502#if (K_HEAP_MEM_POOL_SIZE > 0)
515void k_thread_system_pool_assign(struct k_thread *thread);
516#endif /* (K_HEAP_MEM_POOL_SIZE > 0) */
517
537__syscall int k_thread_join(struct k_thread *thread, k_timeout_t timeout);
538
553__syscall int32_t k_sleep(k_timeout_t timeout);
554
566static inline int32_t k_msleep(int32_t ms)
567{
568 return k_sleep(Z_TIMEOUT_MS(ms));
569}
570
588
605__syscall void k_busy_wait(uint32_t usec_to_wait);
606
618bool k_can_yield(void);
619
627__syscall void k_yield(void);
628
638__syscall void k_wakeup(k_tid_t thread);
639
653__attribute_const__
655
662__attribute_const__
663static inline k_tid_t k_current_get(void)
664{
665#ifdef CONFIG_CURRENT_THREAD_USE_TLS
666
667 /* Thread-local cache of current thread ID, set in z_thread_entry() */
668 extern Z_THREAD_LOCAL k_tid_t z_tls_current;
669
670 return z_tls_current;
671#else
673#endif
674}
675
695__syscall void k_thread_abort(k_tid_t thread);
696
697k_ticks_t z_timeout_expires(const struct _timeout *timeout);
698k_ticks_t z_timeout_remaining(const struct _timeout *timeout);
699
700#ifdef CONFIG_SYS_CLOCK_EXISTS
701
709__syscall k_ticks_t k_thread_timeout_expires_ticks(const struct k_thread *thread);
710
711static inline k_ticks_t z_impl_k_thread_timeout_expires_ticks(
712 const struct k_thread *thread)
713{
714 return z_timeout_expires(&thread->base.timeout);
715}
716
725
726static inline k_ticks_t z_impl_k_thread_timeout_remaining_ticks(
727 const struct k_thread *thread)
728{
729 return z_timeout_remaining(&thread->base.timeout);
730}
731
732#endif /* CONFIG_SYS_CLOCK_EXISTS */
733
738struct _static_thread_data {
739 struct k_thread *init_thread;
740 k_thread_stack_t *init_stack;
741 unsigned int init_stack_size;
743 void *init_p1;
744 void *init_p2;
745 void *init_p3;
746 int init_prio;
747 uint32_t init_options;
748 const char *init_name;
749#ifdef CONFIG_TIMER_READS_ITS_FREQUENCY_AT_RUNTIME
750 int32_t init_delay_ms;
751#else
752 k_timeout_t init_delay;
753#endif
754};
755
756#ifdef CONFIG_TIMER_READS_ITS_FREQUENCY_AT_RUNTIME
757#define Z_THREAD_INIT_DELAY_INITIALIZER(ms) .init_delay_ms = (ms)
758#define Z_THREAD_INIT_DELAY(thread) SYS_TIMEOUT_MS((thread)->init_delay_ms)
759#else
760#define Z_THREAD_INIT_DELAY_INITIALIZER(ms) .init_delay = SYS_TIMEOUT_MS(ms)
761#define Z_THREAD_INIT_DELAY(thread) (thread)->init_delay
762#endif
763
764#define Z_THREAD_INITIALIZER(thread, stack, stack_size, \
765 entry, p1, p2, p3, \
766 prio, options, delay, tname) \
767 { \
768 .init_thread = (thread), \
769 .init_stack = (stack), \
770 .init_stack_size = (stack_size), \
771 .init_entry = (k_thread_entry_t)entry, \
772 .init_p1 = (void *)p1, \
773 .init_p2 = (void *)p2, \
774 .init_p3 = (void *)p3, \
775 .init_prio = (prio), \
776 .init_options = (options), \
777 .init_name = STRINGIFY(tname), \
778 Z_THREAD_INIT_DELAY_INITIALIZER(delay) \
779 }
780
781/*
782 * Refer to K_THREAD_DEFINE() and K_KERNEL_THREAD_DEFINE() for
783 * information on arguments.
784 */
785#define Z_THREAD_COMMON_DEFINE(name, stack_size, \
786 entry, p1, p2, p3, \
787 prio, options, delay) \
788 struct k_thread _k_thread_obj_##name; \
789 STRUCT_SECTION_ITERABLE(_static_thread_data, \
790 _k_thread_data_##name) = \
791 Z_THREAD_INITIALIZER(&_k_thread_obj_##name, \
792 _k_thread_stack_##name, stack_size,\
793 entry, p1, p2, p3, prio, options, \
794 delay, name); \
795 const k_tid_t name = (k_tid_t)&_k_thread_obj_##name
796
832#define K_THREAD_DEFINE(name, stack_size, \
833 entry, p1, p2, p3, \
834 prio, options, delay) \
835 K_THREAD_STACK_DEFINE(_k_thread_stack_##name, stack_size); \
836 Z_THREAD_COMMON_DEFINE(name, stack_size, entry, p1, p2, p3, \
837 prio, options, delay)
838
869#define K_KERNEL_THREAD_DEFINE(name, stack_size, \
870 entry, p1, p2, p3, \
871 prio, options, delay) \
872 K_KERNEL_STACK_DEFINE(_k_thread_stack_##name, stack_size); \
873 Z_THREAD_COMMON_DEFINE(name, stack_size, entry, p1, p2, p3, \
874 prio, options, delay)
875
885__syscall int k_thread_priority_get(k_tid_t thread);
886
912__syscall void k_thread_priority_set(k_tid_t thread, int prio);
913
914
915#ifdef CONFIG_SCHED_DEADLINE
948__syscall void k_thread_deadline_set(k_tid_t thread, int deadline);
949#endif
950
951#ifdef CONFIG_SCHED_CPU_MASK
965
979
993
1007
1018int k_thread_cpu_pin(k_tid_t thread, int cpu);
1019#endif
1020
1041__syscall void k_thread_suspend(k_tid_t thread);
1042
1053__syscall void k_thread_resume(k_tid_t thread);
1054
1068static inline void k_thread_start(k_tid_t thread)
1069{
1070 k_thread_resume(thread);
1071}
1072
1099void k_sched_time_slice_set(int32_t slice, int prio);
1100
1139void k_thread_time_slice_set(struct k_thread *th, int32_t slice_ticks,
1140 k_thread_timeslice_fn_t expired, void *data);
1141
1160bool k_is_in_isr(void);
1161
1178__syscall int k_is_preempt_thread(void);
1179
1191static inline bool k_is_pre_kernel(void)
1192{
1193 extern bool z_sys_post_kernel; /* in init.c */
1194
1195 return !z_sys_post_kernel;
1196}
1197
1232void k_sched_lock(void);
1233
1242
1255__syscall void k_thread_custom_data_set(void *value);
1256
1264__syscall void *k_thread_custom_data_get(void);
1265
1279__syscall int k_thread_name_set(k_tid_t thread, const char *str);
1280
1289const char *k_thread_name_get(k_tid_t thread);
1290
1302__syscall int k_thread_name_copy(k_tid_t thread, char *buf,
1303 size_t size);
1304
1317const char *k_thread_state_str(k_tid_t thread_id, char *buf, size_t buf_size);
1318
1336#define K_NO_WAIT Z_TIMEOUT_NO_WAIT
1337
1350#define K_NSEC(t) Z_TIMEOUT_NS(t)
1351
1364#define K_USEC(t) Z_TIMEOUT_US(t)
1365
1376#define K_CYC(t) Z_TIMEOUT_CYC(t)
1377
1388#define K_TICKS(t) Z_TIMEOUT_TICKS(t)
1389
1400#define K_MSEC(ms) Z_TIMEOUT_MS(ms)
1401
1412#define K_SECONDS(s) K_MSEC((s) * MSEC_PER_SEC)
1413
1424#define K_MINUTES(m) K_SECONDS((m) * 60)
1425
1436#define K_HOURS(h) K_MINUTES((h) * 60)
1437
1446#define K_FOREVER Z_FOREVER
1447
1448#ifdef CONFIG_TIMEOUT_64BIT
1449
1461#define K_TIMEOUT_ABS_TICKS(t) \
1462 Z_TIMEOUT_TICKS(Z_TICK_ABS((k_ticks_t)MAX(t, 0)))
1463
1475#define K_TIMEOUT_ABS_MS(t) K_TIMEOUT_ABS_TICKS(k_ms_to_ticks_ceil64(t))
1476
1489#define K_TIMEOUT_ABS_US(t) K_TIMEOUT_ABS_TICKS(k_us_to_ticks_ceil64(t))
1490
1503#define K_TIMEOUT_ABS_NS(t) K_TIMEOUT_ABS_TICKS(k_ns_to_ticks_ceil64(t))
1504
1517#define K_TIMEOUT_ABS_CYC(t) K_TIMEOUT_ABS_TICKS(k_cyc_to_ticks_ceil64(t))
1518
1519#endif
1520
1529struct k_timer {
1530 /*
1531 * _timeout structure must be first here if we want to use
1532 * dynamic timer allocation. timeout.node is used in the double-linked
1533 * list of free timers
1534 */
1535 struct _timeout timeout;
1536
1537 /* wait queue for the (single) thread waiting on this timer */
1538 _wait_q_t wait_q;
1539
1540 /* runs in ISR context */
1541 void (*expiry_fn)(struct k_timer *timer);
1542
1543 /* runs in the context of the thread that calls k_timer_stop() */
1544 void (*stop_fn)(struct k_timer *timer);
1545
1546 /* timer period */
1547 k_timeout_t period;
1548
1549 /* timer status */
1550 uint32_t status;
1551
1552 /* user-specific data, also used to support legacy features */
1553 void *user_data;
1554
1556
1557#ifdef CONFIG_OBJ_CORE_TIMER
1558 struct k_obj_core obj_core;
1559#endif
1560};
1561
1562#define Z_TIMER_INITIALIZER(obj, expiry, stop) \
1563 { \
1564 .timeout = { \
1565 .node = {},\
1566 .fn = z_timer_expiration_handler, \
1567 .dticks = 0, \
1568 }, \
1569 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
1570 .expiry_fn = expiry, \
1571 .stop_fn = stop, \
1572 .status = 0, \
1573 .user_data = 0, \
1574 }
1575
1596typedef void (*k_timer_expiry_t)(struct k_timer *timer);
1597
1612typedef void (*k_timer_stop_t)(struct k_timer *timer);
1613
1625#define K_TIMER_DEFINE(name, expiry_fn, stop_fn) \
1626 STRUCT_SECTION_ITERABLE(k_timer, name) = \
1627 Z_TIMER_INITIALIZER(name, expiry_fn, stop_fn)
1628
1638void k_timer_init(struct k_timer *timer,
1639 k_timer_expiry_t expiry_fn,
1640 k_timer_stop_t stop_fn);
1641
1656__syscall void k_timer_start(struct k_timer *timer,
1657 k_timeout_t duration, k_timeout_t period);
1658
1675__syscall void k_timer_stop(struct k_timer *timer);
1676
1689__syscall uint32_t k_timer_status_get(struct k_timer *timer);
1690
1708__syscall uint32_t k_timer_status_sync(struct k_timer *timer);
1709
1710#ifdef CONFIG_SYS_CLOCK_EXISTS
1711
1722__syscall k_ticks_t k_timer_expires_ticks(const struct k_timer *timer);
1723
1724static inline k_ticks_t z_impl_k_timer_expires_ticks(
1725 const struct k_timer *timer)
1726{
1727 return z_timeout_expires(&timer->timeout);
1728}
1729
1740__syscall k_ticks_t k_timer_remaining_ticks(const struct k_timer *timer);
1741
1742static inline k_ticks_t z_impl_k_timer_remaining_ticks(
1743 const struct k_timer *timer)
1744{
1745 return z_timeout_remaining(&timer->timeout);
1746}
1747
1758static inline uint32_t k_timer_remaining_get(struct k_timer *timer)
1759{
1761}
1762
1763#endif /* CONFIG_SYS_CLOCK_EXISTS */
1764
1777__syscall void k_timer_user_data_set(struct k_timer *timer, void *user_data);
1778
1782static inline void z_impl_k_timer_user_data_set(struct k_timer *timer,
1783 void *user_data)
1784{
1785 timer->user_data = user_data;
1786}
1787
1795__syscall void *k_timer_user_data_get(const struct k_timer *timer);
1796
1797static inline void *z_impl_k_timer_user_data_get(const struct k_timer *timer)
1798{
1799 return timer->user_data;
1800}
1801
1819__syscall int64_t k_uptime_ticks(void);
1820
1834static inline int64_t k_uptime_get(void)
1835{
1837}
1838
1858static inline uint32_t k_uptime_get_32(void)
1859{
1860 return (uint32_t)k_uptime_get();
1861}
1862
1871static inline uint32_t k_uptime_seconds(void)
1872{
1874}
1875
1887static inline int64_t k_uptime_delta(int64_t *reftime)
1888{
1889 int64_t uptime, delta;
1890
1891 uptime = k_uptime_get();
1892 delta = uptime - *reftime;
1893 *reftime = uptime;
1894
1895 return delta;
1896}
1897
1906static inline uint32_t k_cycle_get_32(void)
1907{
1908 return arch_k_cycle_get_32();
1909}
1910
1921static inline uint64_t k_cycle_get_64(void)
1922{
1923 if (!IS_ENABLED(CONFIG_TIMER_HAS_64BIT_CYCLE_COUNTER)) {
1924 __ASSERT(0, "64-bit cycle counter not enabled on this platform. "
1925 "See CONFIG_TIMER_HAS_64BIT_CYCLE_COUNTER");
1926 return 0;
1927 }
1928
1929 return arch_k_cycle_get_64();
1930}
1931
1936struct k_queue {
1939 _wait_q_t wait_q;
1940
1941 Z_DECL_POLL_EVENT
1942
1944};
1945
1950#define Z_QUEUE_INITIALIZER(obj) \
1951 { \
1952 .data_q = SYS_SFLIST_STATIC_INIT(&obj.data_q), \
1953 .lock = { }, \
1954 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
1955 Z_POLL_EVENT_OBJ_INIT(obj) \
1956 }
1957
1975__syscall void k_queue_init(struct k_queue *queue);
1976
1990__syscall void k_queue_cancel_wait(struct k_queue *queue);
1991
2004void k_queue_append(struct k_queue *queue, void *data);
2005
2022__syscall int32_t k_queue_alloc_append(struct k_queue *queue, void *data);
2023
2036void k_queue_prepend(struct k_queue *queue, void *data);
2037
2054__syscall int32_t k_queue_alloc_prepend(struct k_queue *queue, void *data);
2055
2069void k_queue_insert(struct k_queue *queue, void *prev, void *data);
2070
2089int k_queue_append_list(struct k_queue *queue, void *head, void *tail);
2090
2106int k_queue_merge_slist(struct k_queue *queue, sys_slist_t *list);
2107
2125__syscall void *k_queue_get(struct k_queue *queue, k_timeout_t timeout);
2126
2143bool k_queue_remove(struct k_queue *queue, void *data);
2144
2159bool k_queue_unique_append(struct k_queue *queue, void *data);
2160
2174__syscall int k_queue_is_empty(struct k_queue *queue);
2175
2176static inline int z_impl_k_queue_is_empty(struct k_queue *queue)
2177{
2178 return sys_sflist_is_empty(&queue->data_q) ? 1 : 0;
2179}
2180
2190__syscall void *k_queue_peek_head(struct k_queue *queue);
2191
2201__syscall void *k_queue_peek_tail(struct k_queue *queue);
2202
2212#define K_QUEUE_DEFINE(name) \
2213 STRUCT_SECTION_ITERABLE(k_queue, name) = \
2214 Z_QUEUE_INITIALIZER(name)
2215
2218#ifdef CONFIG_USERSPACE
2228struct k_futex {
2230};
2231
2239struct z_futex_data {
2240 _wait_q_t wait_q;
2241 struct k_spinlock lock;
2242};
2243
2244#define Z_FUTEX_DATA_INITIALIZER(obj) \
2245 { \
2246 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q) \
2247 }
2248
2274__syscall int k_futex_wait(struct k_futex *futex, int expected,
2275 k_timeout_t timeout);
2276
2291__syscall int k_futex_wake(struct k_futex *futex, bool wake_all);
2292
2294#endif
2295
2307struct k_event {
2308 _wait_q_t wait_q;
2311
2313
2314#ifdef CONFIG_OBJ_CORE_EVENT
2315 struct k_obj_core obj_core;
2316#endif
2317
2318};
2319
2320#define Z_EVENT_INITIALIZER(obj) \
2321 { \
2322 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
2323 .events = 0 \
2324 }
2325
2333__syscall void k_event_init(struct k_event *event);
2334
2350__syscall uint32_t k_event_post(struct k_event *event, uint32_t events);
2351
2367__syscall uint32_t k_event_set(struct k_event *event, uint32_t events);
2368
2383__syscall uint32_t k_event_set_masked(struct k_event *event, uint32_t events,
2384 uint32_t events_mask);
2385
2396__syscall uint32_t k_event_clear(struct k_event *event, uint32_t events);
2397
2419__syscall uint32_t k_event_wait(struct k_event *event, uint32_t events,
2420 bool reset, k_timeout_t timeout);
2421
2443__syscall uint32_t k_event_wait_all(struct k_event *event, uint32_t events,
2444 bool reset, k_timeout_t timeout);
2445
2454static inline uint32_t k_event_test(struct k_event *event, uint32_t events_mask)
2455{
2456 return k_event_wait(event, events_mask, false, K_NO_WAIT);
2457}
2458
2468#define K_EVENT_DEFINE(name) \
2469 STRUCT_SECTION_ITERABLE(k_event, name) = \
2470 Z_EVENT_INITIALIZER(name);
2471
2474struct k_fifo {
2475 struct k_queue _queue;
2476#ifdef CONFIG_OBJ_CORE_FIFO
2477 struct k_obj_core obj_core;
2478#endif
2479};
2480
2484#define Z_FIFO_INITIALIZER(obj) \
2485 { \
2486 ._queue = Z_QUEUE_INITIALIZER(obj._queue) \
2487 }
2488
2506#define k_fifo_init(fifo) \
2507 ({ \
2508 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, init, fifo); \
2509 k_queue_init(&(fifo)->_queue); \
2510 K_OBJ_CORE_INIT(K_OBJ_CORE(fifo), _obj_type_fifo); \
2511 K_OBJ_CORE_LINK(K_OBJ_CORE(fifo)); \
2512 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, init, fifo); \
2513 })
2514
2526#define k_fifo_cancel_wait(fifo) \
2527 ({ \
2528 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, cancel_wait, fifo); \
2529 k_queue_cancel_wait(&(fifo)->_queue); \
2530 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, cancel_wait, fifo); \
2531 })
2532
2545#define k_fifo_put(fifo, data) \
2546 ({ \
2547 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put, fifo, data); \
2548 k_queue_append(&(fifo)->_queue, data); \
2549 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put, fifo, data); \
2550 })
2551
2568#define k_fifo_alloc_put(fifo, data) \
2569 ({ \
2570 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, alloc_put, fifo, data); \
2571 int fap_ret = k_queue_alloc_append(&(fifo)->_queue, data); \
2572 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, alloc_put, fifo, data, fap_ret); \
2573 fap_ret; \
2574 })
2575
2590#define k_fifo_put_list(fifo, head, tail) \
2591 ({ \
2592 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put_list, fifo, head, tail); \
2593 k_queue_append_list(&(fifo)->_queue, head, tail); \
2594 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put_list, fifo, head, tail); \
2595 })
2596
2610#define k_fifo_put_slist(fifo, list) \
2611 ({ \
2612 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put_slist, fifo, list); \
2613 k_queue_merge_slist(&(fifo)->_queue, list); \
2614 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put_slist, fifo, list); \
2615 })
2616
2634#define k_fifo_get(fifo, timeout) \
2635 ({ \
2636 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, get, fifo, timeout); \
2637 void *fg_ret = k_queue_get(&(fifo)->_queue, timeout); \
2638 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, get, fifo, timeout, fg_ret); \
2639 fg_ret; \
2640 })
2641
2655#define k_fifo_is_empty(fifo) \
2656 k_queue_is_empty(&(fifo)->_queue)
2657
2671#define k_fifo_peek_head(fifo) \
2672 ({ \
2673 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, peek_head, fifo); \
2674 void *fph_ret = k_queue_peek_head(&(fifo)->_queue); \
2675 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, peek_head, fifo, fph_ret); \
2676 fph_ret; \
2677 })
2678
2690#define k_fifo_peek_tail(fifo) \
2691 ({ \
2692 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, peek_tail, fifo); \
2693 void *fpt_ret = k_queue_peek_tail(&(fifo)->_queue); \
2694 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, peek_tail, fifo, fpt_ret); \
2695 fpt_ret; \
2696 })
2697
2707#define K_FIFO_DEFINE(name) \
2708 STRUCT_SECTION_ITERABLE(k_fifo, name) = \
2709 Z_FIFO_INITIALIZER(name)
2710
2713struct k_lifo {
2714 struct k_queue _queue;
2715#ifdef CONFIG_OBJ_CORE_LIFO
2716 struct k_obj_core obj_core;
2717#endif
2718};
2719
2724#define Z_LIFO_INITIALIZER(obj) \
2725 { \
2726 ._queue = Z_QUEUE_INITIALIZER(obj._queue) \
2727 }
2728
2746#define k_lifo_init(lifo) \
2747 ({ \
2748 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, init, lifo); \
2749 k_queue_init(&(lifo)->_queue); \
2750 K_OBJ_CORE_INIT(K_OBJ_CORE(lifo), _obj_type_lifo); \
2751 K_OBJ_CORE_LINK(K_OBJ_CORE(lifo)); \
2752 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, init, lifo); \
2753 })
2754
2767#define k_lifo_put(lifo, data) \
2768 ({ \
2769 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, put, lifo, data); \
2770 k_queue_prepend(&(lifo)->_queue, data); \
2771 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, put, lifo, data); \
2772 })
2773
2790#define k_lifo_alloc_put(lifo, data) \
2791 ({ \
2792 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, alloc_put, lifo, data); \
2793 int lap_ret = k_queue_alloc_prepend(&(lifo)->_queue, data); \
2794 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, alloc_put, lifo, data, lap_ret); \
2795 lap_ret; \
2796 })
2797
2815#define k_lifo_get(lifo, timeout) \
2816 ({ \
2817 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, get, lifo, timeout); \
2818 void *lg_ret = k_queue_get(&(lifo)->_queue, timeout); \
2819 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, get, lifo, timeout, lg_ret); \
2820 lg_ret; \
2821 })
2822
2832#define K_LIFO_DEFINE(name) \
2833 STRUCT_SECTION_ITERABLE(k_lifo, name) = \
2834 Z_LIFO_INITIALIZER(name)
2835
2841#define K_STACK_FLAG_ALLOC ((uint8_t)1) /* Buffer was allocated */
2842
2843typedef uintptr_t stack_data_t;
2844
2845struct k_stack {
2846 _wait_q_t wait_q;
2847 struct k_spinlock lock;
2848 stack_data_t *base, *next, *top;
2849
2850 uint8_t flags;
2851
2853
2854#ifdef CONFIG_OBJ_CORE_STACK
2855 struct k_obj_core obj_core;
2856#endif
2857};
2858
2859#define Z_STACK_INITIALIZER(obj, stack_buffer, stack_num_entries) \
2860 { \
2861 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
2862 .base = (stack_buffer), \
2863 .next = (stack_buffer), \
2864 .top = (stack_buffer) + (stack_num_entries), \
2865 }
2866
2886void k_stack_init(struct k_stack *stack,
2887 stack_data_t *buffer, uint32_t num_entries);
2888
2889
2904__syscall int32_t k_stack_alloc_init(struct k_stack *stack,
2905 uint32_t num_entries);
2906
2918int k_stack_cleanup(struct k_stack *stack);
2919
2933__syscall int k_stack_push(struct k_stack *stack, stack_data_t data);
2934
2955__syscall int k_stack_pop(struct k_stack *stack, stack_data_t *data,
2956 k_timeout_t timeout);
2957
2968#define K_STACK_DEFINE(name, stack_num_entries) \
2969 stack_data_t __noinit \
2970 _k_stack_buf_##name[stack_num_entries]; \
2971 STRUCT_SECTION_ITERABLE(k_stack, name) = \
2972 Z_STACK_INITIALIZER(name, _k_stack_buf_##name, \
2973 stack_num_entries)
2974
2981struct k_work;
2982struct k_work_q;
2983struct k_work_queue_config;
2984extern struct k_work_q k_sys_work_q;
2985
3000struct k_mutex {
3002 _wait_q_t wait_q;
3005
3008
3011
3013
3014#ifdef CONFIG_OBJ_CORE_MUTEX
3015 struct k_obj_core obj_core;
3016#endif
3017};
3018
3022#define Z_MUTEX_INITIALIZER(obj) \
3023 { \
3024 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
3025 .owner = NULL, \
3026 .lock_count = 0, \
3027 .owner_orig_prio = K_LOWEST_APPLICATION_THREAD_PRIO, \
3028 }
3029
3043#define K_MUTEX_DEFINE(name) \
3044 STRUCT_SECTION_ITERABLE(k_mutex, name) = \
3045 Z_MUTEX_INITIALIZER(name)
3046
3059__syscall int k_mutex_init(struct k_mutex *mutex);
3060
3061
3083__syscall int k_mutex_lock(struct k_mutex *mutex, k_timeout_t timeout);
3084
3105__syscall int k_mutex_unlock(struct k_mutex *mutex);
3106
3113 _wait_q_t wait_q;
3114
3115#ifdef CONFIG_OBJ_CORE_CONDVAR
3116 struct k_obj_core obj_core;
3117#endif
3118};
3119
3120#define Z_CONDVAR_INITIALIZER(obj) \
3121 { \
3122 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
3123 }
3124
3137__syscall int k_condvar_init(struct k_condvar *condvar);
3138
3145__syscall int k_condvar_signal(struct k_condvar *condvar);
3146
3154__syscall int k_condvar_broadcast(struct k_condvar *condvar);
3155
3173__syscall int k_condvar_wait(struct k_condvar *condvar, struct k_mutex *mutex,
3174 k_timeout_t timeout);
3175
3186#define K_CONDVAR_DEFINE(name) \
3187 STRUCT_SECTION_ITERABLE(k_condvar, name) = \
3188 Z_CONDVAR_INITIALIZER(name)
3197struct k_sem {
3198 _wait_q_t wait_q;
3199 unsigned int count;
3200 unsigned int limit;
3201
3202 Z_DECL_POLL_EVENT
3203
3205
3206#ifdef CONFIG_OBJ_CORE_SEM
3207 struct k_obj_core obj_core;
3208#endif
3209};
3210
3211#define Z_SEM_INITIALIZER(obj, initial_count, count_limit) \
3212 { \
3213 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
3214 .count = (initial_count), \
3215 .limit = (count_limit), \
3216 Z_POLL_EVENT_OBJ_INIT(obj) \
3217 }
3218
3237#define K_SEM_MAX_LIMIT UINT_MAX
3238
3254__syscall int k_sem_init(struct k_sem *sem, unsigned int initial_count,
3255 unsigned int limit);
3256
3275__syscall int k_sem_take(struct k_sem *sem, k_timeout_t timeout);
3276
3287__syscall void k_sem_give(struct k_sem *sem);
3288
3298__syscall void k_sem_reset(struct k_sem *sem);
3299
3309__syscall unsigned int k_sem_count_get(struct k_sem *sem);
3310
3314static inline unsigned int z_impl_k_sem_count_get(struct k_sem *sem)
3315{
3316 return sem->count;
3317}
3318
3330#define K_SEM_DEFINE(name, initial_count, count_limit) \
3331 STRUCT_SECTION_ITERABLE(k_sem, name) = \
3332 Z_SEM_INITIALIZER(name, initial_count, count_limit); \
3333 BUILD_ASSERT(((count_limit) != 0) && \
3334 (((initial_count) < (count_limit)) || ((initial_count) == (count_limit))) && \
3335 ((count_limit) <= K_SEM_MAX_LIMIT));
3336
3343struct k_work_delayable;
3344struct k_work_sync;
3345
3362typedef void (*k_work_handler_t)(struct k_work *work);
3363
3377void k_work_init(struct k_work *work,
3379
3394int k_work_busy_get(const struct k_work *work);
3395
3409static inline bool k_work_is_pending(const struct k_work *work);
3410
3432 struct k_work *work);
3433
3442int k_work_submit(struct k_work *work);
3443
3468bool k_work_flush(struct k_work *work,
3469 struct k_work_sync *sync);
3470
3490int k_work_cancel(struct k_work *work);
3491
3522bool k_work_cancel_sync(struct k_work *work, struct k_work_sync *sync);
3523
3534
3555 k_thread_stack_t *stack, size_t stack_size,
3556 int prio, const struct k_work_queue_config *cfg);
3557
3567static inline k_tid_t k_work_queue_thread_get(struct k_work_q *queue);
3568
3592int k_work_queue_drain(struct k_work_q *queue, bool plug);
3593
3608
3624
3636static inline struct k_work_delayable *
3638
3653
3668static inline bool k_work_delayable_is_pending(
3669 const struct k_work_delayable *dwork);
3670
3685 const struct k_work_delayable *dwork);
3686
3701 const struct k_work_delayable *dwork);
3702
3731 struct k_work_delayable *dwork,
3732 k_timeout_t delay);
3733
3748 k_timeout_t delay);
3749
3786 struct k_work_delayable *dwork,
3787 k_timeout_t delay);
3788
3802 k_timeout_t delay);
3803
3829 struct k_work_sync *sync);
3830
3852
3882 struct k_work_sync *sync);
3883
3884enum {
3889 /* The atomic API is used for all work and queue flags fields to
3890 * enforce sequential consistency in SMP environments.
3891 */
3892
3893 /* Bits that represent the work item states. At least nine of the
3894 * combinations are distinct valid stable states.
3895 */
3896 K_WORK_RUNNING_BIT = 0,
3897 K_WORK_CANCELING_BIT = 1,
3898 K_WORK_QUEUED_BIT = 2,
3899 K_WORK_DELAYED_BIT = 3,
3900 K_WORK_FLUSHING_BIT = 4,
3901
3902 K_WORK_MASK = BIT(K_WORK_DELAYED_BIT) | BIT(K_WORK_QUEUED_BIT)
3903 | BIT(K_WORK_RUNNING_BIT) | BIT(K_WORK_CANCELING_BIT) | BIT(K_WORK_FLUSHING_BIT),
3904
3905 /* Static work flags */
3906 K_WORK_DELAYABLE_BIT = 8,
3907 K_WORK_DELAYABLE = BIT(K_WORK_DELAYABLE_BIT),
3908
3909 /* Dynamic work queue flags */
3910 K_WORK_QUEUE_STARTED_BIT = 0,
3911 K_WORK_QUEUE_STARTED = BIT(K_WORK_QUEUE_STARTED_BIT),
3912 K_WORK_QUEUE_BUSY_BIT = 1,
3913 K_WORK_QUEUE_BUSY = BIT(K_WORK_QUEUE_BUSY_BIT),
3914 K_WORK_QUEUE_DRAIN_BIT = 2,
3915 K_WORK_QUEUE_DRAIN = BIT(K_WORK_QUEUE_DRAIN_BIT),
3916 K_WORK_QUEUE_PLUGGED_BIT = 3,
3917 K_WORK_QUEUE_PLUGGED = BIT(K_WORK_QUEUE_PLUGGED_BIT),
3918
3919 /* Static work queue flags */
3920 K_WORK_QUEUE_NO_YIELD_BIT = 8,
3921 K_WORK_QUEUE_NO_YIELD = BIT(K_WORK_QUEUE_NO_YIELD_BIT),
3922
3926 /* Transient work flags */
3927
3933 K_WORK_RUNNING = BIT(K_WORK_RUNNING_BIT),
3934
3939 K_WORK_CANCELING = BIT(K_WORK_CANCELING_BIT),
3940
3946 K_WORK_QUEUED = BIT(K_WORK_QUEUED_BIT),
3947
3953 K_WORK_DELAYED = BIT(K_WORK_DELAYED_BIT),
3954
3959 K_WORK_FLUSHING = BIT(K_WORK_FLUSHING_BIT),
3960};
3961
3963struct k_work {
3964 /* All fields are protected by the work module spinlock. No fields
3965 * are to be accessed except through kernel API.
3966 */
3967
3968 /* Node to link into k_work_q pending list. */
3970
3971 /* The function to be invoked by the work queue thread. */
3973
3974 /* The queue on which the work item was last submitted. */
3976
3977 /* State of the work item.
3978 *
3979 * The item can be DELAYED, QUEUED, and RUNNING simultaneously.
3980 *
3981 * It can be RUNNING and CANCELING simultaneously.
3982 */
3984};
3985
3986#define Z_WORK_INITIALIZER(work_handler) { \
3987 .handler = (work_handler), \
3988}
3989
3992 /* The work item. */
3993 struct k_work work;
3994
3995 /* Timeout used to submit work after a delay. */
3996 struct _timeout timeout;
3997
3998 /* The queue to which the work should be submitted. */
4000};
4001
4002#define Z_WORK_DELAYABLE_INITIALIZER(work_handler) { \
4003 .work = { \
4004 .handler = (work_handler), \
4005 .flags = K_WORK_DELAYABLE, \
4006 }, \
4007}
4008
4025#define K_WORK_DELAYABLE_DEFINE(work, work_handler) \
4026 struct k_work_delayable work \
4027 = Z_WORK_DELAYABLE_INITIALIZER(work_handler)
4028
4033/* Record used to wait for work to flush.
4034 *
4035 * The work item is inserted into the queue that will process (or is
4036 * processing) the item, and will be processed as soon as the item
4037 * completes. When the flusher is processed the semaphore will be
4038 * signaled, releasing the thread waiting for the flush.
4039 */
4040struct z_work_flusher {
4041 struct k_work work;
4042 struct k_sem sem;
4043};
4044
4045/* Record used to wait for work to complete a cancellation.
4046 *
4047 * The work item is inserted into a global queue of pending cancels.
4048 * When a cancelling work item goes idle any matching waiters are
4049 * removed from pending_cancels and are woken.
4050 */
4051struct z_work_canceller {
4052 sys_snode_t node;
4053 struct k_work *work;
4054 struct k_sem sem;
4055};
4056
4075 union {
4076 struct z_work_flusher flusher;
4077 struct z_work_canceller canceller;
4078 };
4079};
4080
4092 const char *name;
4093
4107
4112};
4113
4115struct k_work_q {
4116 /* The thread that animates the work. */
4118
4119 /* All the following fields must be accessed only while the
4120 * work module spinlock is held.
4121 */
4122
4123 /* List of k_work items to be worked. */
4125
4126 /* Wait queue for idle work thread. */
4127 _wait_q_t notifyq;
4128
4129 /* Wait queue for threads waiting for the queue to drain. */
4130 _wait_q_t drainq;
4131
4132 /* Flags describing queue state. */
4134};
4135
4136/* Provide the implementation for inline functions declared above */
4137
4138static inline bool k_work_is_pending(const struct k_work *work)
4139{
4140 return k_work_busy_get(work) != 0;
4141}
4142
4143static inline struct k_work_delayable *
4148
4150 const struct k_work_delayable *dwork)
4151{
4152 return k_work_delayable_busy_get(dwork) != 0;
4153}
4154
4156 const struct k_work_delayable *dwork)
4157{
4158 return z_timeout_expires(&dwork->timeout);
4159}
4160
4162 const struct k_work_delayable *dwork)
4163{
4164 return z_timeout_remaining(&dwork->timeout);
4165}
4166
4168{
4169 return &queue->thread;
4170}
4171
4174struct k_work_user;
4175
4190typedef void (*k_work_user_handler_t)(struct k_work_user *work);
4191
4196struct k_work_user_q {
4197 struct k_queue queue;
4198 struct k_thread thread;
4199};
4200
4201enum {
4202 K_WORK_USER_STATE_PENDING, /* Work item pending state */
4203};
4204
4205struct k_work_user {
4206 void *_reserved; /* Used by k_queue implementation. */
4207 k_work_user_handler_t handler;
4209};
4210
4215#if defined(__cplusplus) && ((__cplusplus - 0) < 202002L)
4216#define Z_WORK_USER_INITIALIZER(work_handler) { NULL, work_handler, 0 }
4217#else
4218#define Z_WORK_USER_INITIALIZER(work_handler) \
4219 { \
4220 ._reserved = NULL, \
4221 .handler = (work_handler), \
4222 .flags = 0 \
4223 }
4224#endif
4225
4237#define K_WORK_USER_DEFINE(work, work_handler) \
4238 struct k_work_user work = Z_WORK_USER_INITIALIZER(work_handler)
4239
4249static inline void k_work_user_init(struct k_work_user *work,
4250 k_work_user_handler_t handler)
4251{
4252 *work = (struct k_work_user)Z_WORK_USER_INITIALIZER(handler);
4253}
4254
4271static inline bool k_work_user_is_pending(struct k_work_user *work)
4272{
4273 return atomic_test_bit(&work->flags, K_WORK_USER_STATE_PENDING);
4274}
4275
4294static inline int k_work_user_submit_to_queue(struct k_work_user_q *work_q,
4295 struct k_work_user *work)
4296{
4297 int ret = -EBUSY;
4298
4299 if (!atomic_test_and_set_bit(&work->flags,
4300 K_WORK_USER_STATE_PENDING)) {
4301 ret = k_queue_alloc_append(&work_q->queue, work);
4302
4303 /* Couldn't insert into the queue. Clear the pending bit
4304 * so the work item can be submitted again
4305 */
4306 if (ret != 0) {
4307 atomic_clear_bit(&work->flags,
4308 K_WORK_USER_STATE_PENDING);
4309 }
4310 }
4311
4312 return ret;
4313}
4314
4334void k_work_user_queue_start(struct k_work_user_q *work_q,
4335 k_thread_stack_t *stack,
4336 size_t stack_size, int prio,
4337 const char *name);
4338
4349static inline k_tid_t k_work_user_queue_thread_get(struct k_work_user_q *work_q)
4350{
4351 return &work_q->thread;
4352}
4353
4360struct k_work_poll {
4361 struct k_work work;
4362 struct k_work_q *workq;
4363 struct z_poller poller;
4364 struct k_poll_event *events;
4365 int num_events;
4366 k_work_handler_t real_handler;
4367 struct _timeout timeout;
4368 int poll_result;
4369};
4370
4391#define K_WORK_DEFINE(work, work_handler) \
4392 struct k_work work = Z_WORK_INITIALIZER(work_handler)
4393
4403void k_work_poll_init(struct k_work_poll *work,
4404 k_work_handler_t handler);
4405
4441 struct k_work_poll *work,
4442 struct k_poll_event *events,
4443 int num_events,
4444 k_timeout_t timeout);
4445
4477int k_work_poll_submit(struct k_work_poll *work,
4478 struct k_poll_event *events,
4479 int num_events,
4480 k_timeout_t timeout);
4481
4496int k_work_poll_cancel(struct k_work_poll *work);
4497
4509struct k_msgq {
4511 _wait_q_t wait_q;
4515 size_t msg_size;
4528
4529 Z_DECL_POLL_EVENT
4530
4533
4535
4536#ifdef CONFIG_OBJ_CORE_MSGQ
4537 struct k_obj_core obj_core;
4538#endif
4539};
4545#define Z_MSGQ_INITIALIZER(obj, q_buffer, q_msg_size, q_max_msgs) \
4546 { \
4547 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
4548 .msg_size = q_msg_size, \
4549 .max_msgs = q_max_msgs, \
4550 .buffer_start = q_buffer, \
4551 .buffer_end = q_buffer + (q_max_msgs * q_msg_size), \
4552 .read_ptr = q_buffer, \
4553 .write_ptr = q_buffer, \
4554 .used_msgs = 0, \
4555 Z_POLL_EVENT_OBJ_INIT(obj) \
4556 }
4557
4563#define K_MSGQ_FLAG_ALLOC BIT(0)
4564
4576
4577
4596#define K_MSGQ_DEFINE(q_name, q_msg_size, q_max_msgs, q_align) \
4597 static char __noinit __aligned(q_align) \
4598 _k_fifo_buf_##q_name[(q_max_msgs) * (q_msg_size)]; \
4599 STRUCT_SECTION_ITERABLE(k_msgq, q_name) = \
4600 Z_MSGQ_INITIALIZER(q_name, _k_fifo_buf_##q_name, \
4601 (q_msg_size), (q_max_msgs))
4602
4617void k_msgq_init(struct k_msgq *msgq, char *buffer, size_t msg_size,
4618 uint32_t max_msgs);
4619
4639__syscall int k_msgq_alloc_init(struct k_msgq *msgq, size_t msg_size,
4640 uint32_t max_msgs);
4641
4652int k_msgq_cleanup(struct k_msgq *msgq);
4653
4674__syscall int k_msgq_put(struct k_msgq *msgq, const void *data, k_timeout_t timeout);
4675
4696__syscall int k_msgq_get(struct k_msgq *msgq, void *data, k_timeout_t timeout);
4697
4712__syscall int k_msgq_peek(struct k_msgq *msgq, void *data);
4713
4730__syscall int k_msgq_peek_at(struct k_msgq *msgq, void *data, uint32_t idx);
4731
4741__syscall void k_msgq_purge(struct k_msgq *msgq);
4742
4753__syscall uint32_t k_msgq_num_free_get(struct k_msgq *msgq);
4754
4763__syscall void k_msgq_get_attrs(struct k_msgq *msgq,
4764 struct k_msgq_attrs *attrs);
4765
4766
4767static inline uint32_t z_impl_k_msgq_num_free_get(struct k_msgq *msgq)
4768{
4769 return msgq->max_msgs - msgq->used_msgs;
4770}
4771
4781__syscall uint32_t k_msgq_num_used_get(struct k_msgq *msgq);
4782
4783static inline uint32_t z_impl_k_msgq_num_used_get(struct k_msgq *msgq)
4784{
4785 return msgq->used_msgs;
4786}
4787
4802 size_t size;
4806 void *tx_data;
4812 k_tid_t _syncing_thread;
4813#if (CONFIG_NUM_MBOX_ASYNC_MSGS > 0)
4815 struct k_sem *_async_sem;
4816#endif
4817};
4822struct k_mbox {
4824 _wait_q_t tx_msg_queue;
4826 _wait_q_t rx_msg_queue;
4828
4830
4831#ifdef CONFIG_OBJ_CORE_MAILBOX
4832 struct k_obj_core obj_core;
4833#endif
4834};
4839#define Z_MBOX_INITIALIZER(obj) \
4840 { \
4841 .tx_msg_queue = Z_WAIT_Q_INIT(&obj.tx_msg_queue), \
4842 .rx_msg_queue = Z_WAIT_Q_INIT(&obj.rx_msg_queue), \
4843 }
4844
4858#define K_MBOX_DEFINE(name) \
4859 STRUCT_SECTION_ITERABLE(k_mbox, name) = \
4860 Z_MBOX_INITIALIZER(name) \
4861
4869void k_mbox_init(struct k_mbox *mbox);
4870
4890int k_mbox_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg,
4891 k_timeout_t timeout);
4892
4906void k_mbox_async_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg,
4907 struct k_sem *sem);
4908
4926int k_mbox_get(struct k_mbox *mbox, struct k_mbox_msg *rx_msg,
4927 void *buffer, k_timeout_t timeout);
4928
4942void k_mbox_data_get(struct k_mbox_msg *rx_msg, void *buffer);
4943
4953struct k_pipe {
4954 unsigned char *buffer;
4955 size_t size;
4956 size_t bytes_used;
4957 size_t read_index;
4961 struct {
4962 _wait_q_t readers;
4963 _wait_q_t writers;
4966 Z_DECL_POLL_EVENT
4967
4971
4972#ifdef CONFIG_OBJ_CORE_PIPE
4973 struct k_obj_core obj_core;
4974#endif
4975};
4976
4980#define K_PIPE_FLAG_ALLOC BIT(0)
4982#define Z_PIPE_INITIALIZER(obj, pipe_buffer, pipe_buffer_size) \
4983 { \
4984 .buffer = pipe_buffer, \
4985 .size = pipe_buffer_size, \
4986 .bytes_used = 0, \
4987 .read_index = 0, \
4988 .write_index = 0, \
4989 .lock = {}, \
4990 .wait_q = { \
4991 .readers = Z_WAIT_Q_INIT(&obj.wait_q.readers), \
4992 .writers = Z_WAIT_Q_INIT(&obj.wait_q.writers) \
4993 }, \
4994 Z_POLL_EVENT_OBJ_INIT(obj) \
4995 .flags = 0, \
4996 }
4997
5015#define K_PIPE_DEFINE(name, pipe_buffer_size, pipe_align) \
5016 static unsigned char __noinit __aligned(pipe_align) \
5017 _k_pipe_buf_##name[pipe_buffer_size]; \
5018 STRUCT_SECTION_ITERABLE(k_pipe, name) = \
5019 Z_PIPE_INITIALIZER(name, _k_pipe_buf_##name, pipe_buffer_size)
5020
5032void k_pipe_init(struct k_pipe *pipe, unsigned char *buffer, size_t size);
5033
5045int k_pipe_cleanup(struct k_pipe *pipe);
5046
5062__syscall int k_pipe_alloc_init(struct k_pipe *pipe, size_t size);
5063
5082__syscall int k_pipe_put(struct k_pipe *pipe, const void *data,
5083 size_t bytes_to_write, size_t *bytes_written,
5084 size_t min_xfer, k_timeout_t timeout);
5085
5105__syscall int k_pipe_get(struct k_pipe *pipe, void *data,
5106 size_t bytes_to_read, size_t *bytes_read,
5107 size_t min_xfer, k_timeout_t timeout);
5108
5117__syscall size_t k_pipe_read_avail(struct k_pipe *pipe);
5118
5127__syscall size_t k_pipe_write_avail(struct k_pipe *pipe);
5128
5139__syscall void k_pipe_flush(struct k_pipe *pipe);
5140
5152__syscall void k_pipe_buffer_flush(struct k_pipe *pipe);
5153
5160struct k_mem_slab_info {
5161 uint32_t num_blocks;
5162 size_t block_size;
5163 uint32_t num_used;
5164#ifdef CONFIG_MEM_SLAB_TRACE_MAX_UTILIZATION
5165 uint32_t max_used;
5166#endif
5167};
5168
5169struct k_mem_slab {
5170 _wait_q_t wait_q;
5171 struct k_spinlock lock;
5172 char *buffer;
5173 char *free_list;
5174 struct k_mem_slab_info info;
5175
5177
5178#ifdef CONFIG_OBJ_CORE_MEM_SLAB
5179 struct k_obj_core obj_core;
5180#endif
5181};
5182
5183#define Z_MEM_SLAB_INITIALIZER(_slab, _slab_buffer, _slab_block_size, \
5184 _slab_num_blocks) \
5185 { \
5186 .wait_q = Z_WAIT_Q_INIT(&(_slab).wait_q), \
5187 .lock = {}, \
5188 .buffer = _slab_buffer, \
5189 .free_list = NULL, \
5190 .info = {_slab_num_blocks, _slab_block_size, 0} \
5191 }
5192
5193
5227#define K_MEM_SLAB_DEFINE(name, slab_block_size, slab_num_blocks, slab_align) \
5228 char __noinit_named(k_mem_slab_buf_##name) \
5229 __aligned(WB_UP(slab_align)) \
5230 _k_mem_slab_buf_##name[(slab_num_blocks) * WB_UP(slab_block_size)]; \
5231 STRUCT_SECTION_ITERABLE(k_mem_slab, name) = \
5232 Z_MEM_SLAB_INITIALIZER(name, _k_mem_slab_buf_##name, \
5233 WB_UP(slab_block_size), slab_num_blocks)
5234
5249#define K_MEM_SLAB_DEFINE_STATIC(name, slab_block_size, slab_num_blocks, slab_align) \
5250 static char __noinit_named(k_mem_slab_buf_##name) \
5251 __aligned(WB_UP(slab_align)) \
5252 _k_mem_slab_buf_##name[(slab_num_blocks) * WB_UP(slab_block_size)]; \
5253 static STRUCT_SECTION_ITERABLE(k_mem_slab, name) = \
5254 Z_MEM_SLAB_INITIALIZER(name, _k_mem_slab_buf_##name, \
5255 WB_UP(slab_block_size), slab_num_blocks)
5256
5278int k_mem_slab_init(struct k_mem_slab *slab, void *buffer,
5279 size_t block_size, uint32_t num_blocks);
5280
5303int k_mem_slab_alloc(struct k_mem_slab *slab, void **mem,
5304 k_timeout_t timeout);
5305
5315void k_mem_slab_free(struct k_mem_slab *slab, void *mem);
5316
5327static inline uint32_t k_mem_slab_num_used_get(struct k_mem_slab *slab)
5328{
5329 return slab->info.num_used;
5330}
5331
5342static inline uint32_t k_mem_slab_max_used_get(struct k_mem_slab *slab)
5343{
5344#ifdef CONFIG_MEM_SLAB_TRACE_MAX_UTILIZATION
5345 return slab->info.max_used;
5346#else
5347 ARG_UNUSED(slab);
5348 return 0;
5349#endif
5350}
5351
5362static inline uint32_t k_mem_slab_num_free_get(struct k_mem_slab *slab)
5363{
5364 return slab->info.num_blocks - slab->info.num_used;
5365}
5366
5379int k_mem_slab_runtime_stats_get(struct k_mem_slab *slab, struct sys_memory_stats *stats);
5380
5392int k_mem_slab_runtime_stats_reset_max(struct k_mem_slab *slab);
5393
5401/* kernel synchronized heap struct */
5402
5403struct k_heap {
5405 _wait_q_t wait_q;
5407};
5408
5422void k_heap_init(struct k_heap *h, void *mem,
5423 size_t bytes) __attribute_nonnull(1);
5424
5445void *k_heap_aligned_alloc(struct k_heap *h, size_t align, size_t bytes,
5446 k_timeout_t timeout) __attribute_nonnull(1);
5447
5469void *k_heap_alloc(struct k_heap *h, size_t bytes,
5470 k_timeout_t timeout) __attribute_nonnull(1);
5471
5495void *k_heap_realloc(struct k_heap *h, void *ptr, size_t bytes, k_timeout_t timeout)
5496 __attribute_nonnull(1);
5497
5508void k_heap_free(struct k_heap *h, void *mem) __attribute_nonnull(1);
5509
5510/* Hand-calculated minimum heap sizes needed to return a successful
5511 * 1-byte allocation. See details in lib/os/heap.[ch]
5512 */
5513#define Z_HEAP_MIN_SIZE ((sizeof(void *) > 4) ? 56 : 44)
5514
5531#define Z_HEAP_DEFINE_IN_SECT(name, bytes, in_section) \
5532 char in_section \
5533 __aligned(8) /* CHUNK_UNIT */ \
5534 kheap_##name[MAX(bytes, Z_HEAP_MIN_SIZE)]; \
5535 STRUCT_SECTION_ITERABLE(k_heap, name) = { \
5536 .heap = { \
5537 .init_mem = kheap_##name, \
5538 .init_bytes = MAX(bytes, Z_HEAP_MIN_SIZE), \
5539 }, \
5540 }
5541
5556#define K_HEAP_DEFINE(name, bytes) \
5557 Z_HEAP_DEFINE_IN_SECT(name, bytes, \
5558 __noinit_named(kheap_buf_##name))
5559
5574#define K_HEAP_DEFINE_NOCACHE(name, bytes) \
5575 Z_HEAP_DEFINE_IN_SECT(name, bytes, __nocache)
5576
5605void *k_aligned_alloc(size_t align, size_t size);
5606
5618void *k_malloc(size_t size);
5619
5630void k_free(void *ptr);
5631
5643void *k_calloc(size_t nmemb, size_t size);
5644
5662void *k_realloc(void *ptr, size_t size);
5663
5666/* polling API - PRIVATE */
5667
5668#ifdef CONFIG_POLL
5669#define _INIT_OBJ_POLL_EVENT(obj) do { (obj)->poll_event = NULL; } while (false)
5670#else
5671#define _INIT_OBJ_POLL_EVENT(obj) do { } while (false)
5672#endif
5673
5674/* private - types bit positions */
5675enum _poll_types_bits {
5676 /* can be used to ignore an event */
5677 _POLL_TYPE_IGNORE,
5678
5679 /* to be signaled by k_poll_signal_raise() */
5680 _POLL_TYPE_SIGNAL,
5681
5682 /* semaphore availability */
5683 _POLL_TYPE_SEM_AVAILABLE,
5684
5685 /* queue/FIFO/LIFO data availability */
5686 _POLL_TYPE_DATA_AVAILABLE,
5687
5688 /* msgq data availability */
5689 _POLL_TYPE_MSGQ_DATA_AVAILABLE,
5690
5691 /* pipe data availability */
5692 _POLL_TYPE_PIPE_DATA_AVAILABLE,
5693
5694 _POLL_NUM_TYPES
5695};
5696
5697#define Z_POLL_TYPE_BIT(type) (1U << ((type) - 1U))
5698
5699/* private - states bit positions */
5700enum _poll_states_bits {
5701 /* default state when creating event */
5702 _POLL_STATE_NOT_READY,
5703
5704 /* signaled by k_poll_signal_raise() */
5705 _POLL_STATE_SIGNALED,
5706
5707 /* semaphore is available */
5708 _POLL_STATE_SEM_AVAILABLE,
5709
5710 /* data is available to read on queue/FIFO/LIFO */
5711 _POLL_STATE_DATA_AVAILABLE,
5712
5713 /* queue/FIFO/LIFO wait was cancelled */
5714 _POLL_STATE_CANCELLED,
5715
5716 /* data is available to read on a message queue */
5717 _POLL_STATE_MSGQ_DATA_AVAILABLE,
5718
5719 /* data is available to read from a pipe */
5720 _POLL_STATE_PIPE_DATA_AVAILABLE,
5721
5722 _POLL_NUM_STATES
5723};
5724
5725#define Z_POLL_STATE_BIT(state) (1U << ((state) - 1U))
5726
5727#define _POLL_EVENT_NUM_UNUSED_BITS \
5728 (32 - (0 \
5729 + 8 /* tag */ \
5730 + _POLL_NUM_TYPES \
5731 + _POLL_NUM_STATES \
5732 + 1 /* modes */ \
5733 ))
5734
5735/* end of polling API - PRIVATE */
5736
5737
5744/* Public polling API */
5745
5746/* public - values for k_poll_event.type bitfield */
5747#define K_POLL_TYPE_IGNORE 0
5748#define K_POLL_TYPE_SIGNAL Z_POLL_TYPE_BIT(_POLL_TYPE_SIGNAL)
5749#define K_POLL_TYPE_SEM_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_SEM_AVAILABLE)
5750#define K_POLL_TYPE_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_DATA_AVAILABLE)
5751#define K_POLL_TYPE_FIFO_DATA_AVAILABLE K_POLL_TYPE_DATA_AVAILABLE
5752#define K_POLL_TYPE_MSGQ_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_MSGQ_DATA_AVAILABLE)
5753#define K_POLL_TYPE_PIPE_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_PIPE_DATA_AVAILABLE)
5754
5755/* public - polling modes */
5757 /* polling thread does not take ownership of objects when available */
5759
5762
5763/* public - values for k_poll_event.state bitfield */
5764#define K_POLL_STATE_NOT_READY 0
5765#define K_POLL_STATE_SIGNALED Z_POLL_STATE_BIT(_POLL_STATE_SIGNALED)
5766#define K_POLL_STATE_SEM_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_SEM_AVAILABLE)
5767#define K_POLL_STATE_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_DATA_AVAILABLE)
5768#define K_POLL_STATE_FIFO_DATA_AVAILABLE K_POLL_STATE_DATA_AVAILABLE
5769#define K_POLL_STATE_MSGQ_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_MSGQ_DATA_AVAILABLE)
5770#define K_POLL_STATE_PIPE_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_PIPE_DATA_AVAILABLE)
5771#define K_POLL_STATE_CANCELLED Z_POLL_STATE_BIT(_POLL_STATE_CANCELLED)
5772
5773/* public - poll signal object */
5777
5782 unsigned int signaled;
5783
5786};
5787
5788#define K_POLL_SIGNAL_INITIALIZER(obj) \
5789 { \
5790 .poll_events = SYS_DLIST_STATIC_INIT(&obj.poll_events), \
5791 .signaled = 0, \
5792 .result = 0, \
5793 }
5800 sys_dnode_t _node;
5801
5803 struct z_poller *poller;
5804
5807
5809 uint32_t type:_POLL_NUM_TYPES;
5810
5812 uint32_t state:_POLL_NUM_STATES;
5813
5816
5818 uint32_t unused:_POLL_EVENT_NUM_UNUSED_BITS;
5819
5821 union {
5822 /* The typed_* fields below are used by K_POLL_EVENT_*INITIALIZER() macros to ensure
5823 * type safety of polled objects.
5824 */
5825 void *obj, *typed_K_POLL_TYPE_IGNORE;
5826 struct k_poll_signal *signal, *typed_K_POLL_TYPE_SIGNAL;
5827 struct k_sem *sem, *typed_K_POLL_TYPE_SEM_AVAILABLE;
5828 struct k_fifo *fifo, *typed_K_POLL_TYPE_FIFO_DATA_AVAILABLE;
5829 struct k_queue *queue, *typed_K_POLL_TYPE_DATA_AVAILABLE;
5830 struct k_msgq *msgq, *typed_K_POLL_TYPE_MSGQ_DATA_AVAILABLE;
5831#ifdef CONFIG_PIPES
5832 struct k_pipe *pipe, *typed_K_POLL_TYPE_PIPE_DATA_AVAILABLE;
5833#endif
5834 };
5835};
5836
5837#define K_POLL_EVENT_INITIALIZER(_event_type, _event_mode, _event_obj) \
5838 { \
5839 .poller = NULL, \
5840 .type = _event_type, \
5841 .state = K_POLL_STATE_NOT_READY, \
5842 .mode = _event_mode, \
5843 .unused = 0, \
5844 { \
5845 .typed_##_event_type = _event_obj, \
5846 }, \
5847 }
5848
5849#define K_POLL_EVENT_STATIC_INITIALIZER(_event_type, _event_mode, _event_obj, \
5850 event_tag) \
5851 { \
5852 .tag = event_tag, \
5853 .type = _event_type, \
5854 .state = K_POLL_STATE_NOT_READY, \
5855 .mode = _event_mode, \
5856 .unused = 0, \
5857 { \
5858 .typed_##_event_type = _event_obj, \
5859 }, \
5860 }
5861
5877void k_poll_event_init(struct k_poll_event *event, uint32_t type,
5878 int mode, void *obj);
5879
5923__syscall int k_poll(struct k_poll_event *events, int num_events,
5924 k_timeout_t timeout);
5925
5934__syscall void k_poll_signal_init(struct k_poll_signal *sig);
5935
5941__syscall void k_poll_signal_reset(struct k_poll_signal *sig);
5942
5953__syscall void k_poll_signal_check(struct k_poll_signal *sig,
5954 unsigned int *signaled, int *result);
5955
5980__syscall int k_poll_signal_raise(struct k_poll_signal *sig, int result);
5981
6002static inline void k_cpu_idle(void)
6003{
6004 arch_cpu_idle();
6005}
6006
6021static inline void k_cpu_atomic_idle(unsigned int key)
6022{
6024}
6025
6034#ifdef ARCH_EXCEPT
6035/* This architecture has direct support for triggering a CPU exception */
6036#define z_except_reason(reason) ARCH_EXCEPT(reason)
6037#else
6038
6039#if !defined(CONFIG_ASSERT_NO_FILE_INFO)
6040#define __EXCEPT_LOC() __ASSERT_PRINT("@ %s:%d\n", __FILE__, __LINE__)
6041#else
6042#define __EXCEPT_LOC()
6043#endif
6044
6045/* NOTE: This is the implementation for arches that do not implement
6046 * ARCH_EXCEPT() to generate a real CPU exception.
6047 *
6048 * We won't have a real exception frame to determine the PC value when
6049 * the oops occurred, so print file and line number before we jump into
6050 * the fatal error handler.
6051 */
6052#define z_except_reason(reason) do { \
6053 __EXCEPT_LOC(); \
6054 z_fatal_error(reason, NULL); \
6055 } while (false)
6056
6057#endif /* _ARCH__EXCEPT */
6073#define k_oops() z_except_reason(K_ERR_KERNEL_OOPS)
6074
6083#define k_panic() z_except_reason(K_ERR_KERNEL_PANIC)
6084
6089/*
6090 * private APIs that are utilized by one or more public APIs
6091 */
6092
6096void z_timer_expiration_handler(struct _timeout *timeout);
6101#ifdef CONFIG_PRINTK
6109__syscall void k_str_out(char *c, size_t n);
6110#endif
6111
6138__syscall int k_float_disable(struct k_thread *thread);
6139
6178__syscall int k_float_enable(struct k_thread *thread, unsigned int options);
6179
6193
6201
6210
6221
6232
6241
6250
6251#ifdef __cplusplus
6252}
6253#endif
6254
6255#include <zephyr/tracing/tracing.h>
6256#include <zephyr/syscalls/kernel.h>
6257
6258#endif /* !_ASMLANGUAGE */
6259
6260#endif /* ZEPHYR_INCLUDE_KERNEL_H_ */
static uint32_t arch_k_cycle_get_32(void)
Definition misc.h:26
static uint64_t arch_k_cycle_get_64(void)
Definition misc.h:33
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
long atomic_t
Definition atomic_types.h:15
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 bool atomic_test_bit(const atomic_t *target, int bit)
Atomically get and test a bit.
Definition atomic.h:127
static void atomic_clear_bit(atomic_t *target, int bit)
Atomically clear a bit.
Definition atomic.h:191
static bool atomic_test_and_set_bit(atomic_t *target, int bit)
Atomically set a bit and test it.
Definition atomic.h:170
static uint32_t k_cycle_get_32(void)
Read the hardware clock.
Definition kernel.h:1906
#define K_NO_WAIT
Generate null timeout delay.
Definition kernel.h:1336
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:1858
uint32_t k_ticks_t
Tick precision used in timeout APIs.
Definition sys_clock.h:48
static int64_t k_uptime_delta(int64_t *reftime)
Get elapsed time.
Definition kernel.h:1887
static uint32_t k_uptime_seconds(void)
Get system uptime in seconds.
Definition kernel.h:1871
static uint64_t k_cycle_get_64(void)
Read the 64-bit hardware clock.
Definition kernel.h:1921
static int64_t k_uptime_get(void)
Get system uptime.
Definition kernel.h:1834
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:6002
static void k_cpu_atomic_idle(unsigned int key)
Make the CPU idle in an atomic fashion.
Definition kernel.h:6021
struct _dnode sys_dnode_t
Doubly-linked list node structure.
Definition dlist.h:54
struct _dnode sys_dlist_t
Doubly-linked list structure.
Definition dlist.h:50
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.
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:2454
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.
struct _sflist sys_sflist_t
Flagged single-linked list structure.
Definition sflist.h:54
static bool sys_sflist_is_empty(sys_sflist_t *list)
Test if the given list is empty.
Definition sflist.h:336
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.
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.
static bool k_is_pre_kernel(void)
Test whether startup is in the before-main-task phase.
Definition kernel.h:1191
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:5327
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:5342
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:5362
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 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_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.
size_t k_pipe_read_avail(struct k_pipe *pipe)
Query the number of bytes that may be read from pipe.
int k_pipe_alloc_init(struct k_pipe *pipe, size_t size)
Initialize a pipe and allocate a buffer for it.
void k_pipe_flush(struct k_pipe *pipe)
Flush the pipe of write data.
void k_pipe_buffer_flush(struct k_pipe *pipe)
Flush the pipe's internal buffer.
int k_pipe_cleanup(struct k_pipe *pipe)
Release a pipe's allocated buffer.
int k_pipe_get(struct k_pipe *pipe, void *data, size_t bytes_to_read, size_t *bytes_read, size_t min_xfer, k_timeout_t timeout)
Read data from a pipe.
void k_pipe_init(struct k_pipe *pipe, unsigned char *buffer, size_t size)
Initialize a pipe.
size_t k_pipe_write_avail(struct k_pipe *pipe)
Query the number of bytes that may be written to pipe.
int k_pipe_put(struct k_pipe *pipe, const void *data, size_t bytes_to_write, size_t *bytes_written, size_t min_xfer, k_timeout_t timeout)
Write data to a pipe.
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:5756
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:5758
@ K_POLL_NUM_MODES
Definition kernel.h:5760
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:49
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:39
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:366
#define IS_ENABLED(config_macro)
Check for macro definition in compiler-visible expressions.
Definition util_macro.h:140
#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:284
#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.
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:471
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:566
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.
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:663
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:1068
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_thread_deadline_set(k_tid_t thread, int deadline)
Set 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.
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:105
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:1612
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:1596
void k_timer_init(struct k_timer *timer, k_timer_expiry_t expiry_fn, k_timer_stop_t stop_fn)
Initialize a timer.
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:1758
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:1701
#define k_ticks_to_sec_floor32(t)
Convert ticks to seconds.
Definition time_units.h:1605
#define k_ticks_to_ms_floor64(t)
Convert ticks to milliseconds.
Definition time_units.h:1717
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:4167
static bool k_work_is_pending(const struct k_work *work)
Test whether a work item is currently pending.
Definition kernel.h:4138
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:4155
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.
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:4294
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:4271
void(* k_work_handler_t)(struct k_work *work)
The signature for a work item handler function.
Definition kernel.h:3362
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:4149
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:4249
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:4190
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:4349
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:4144
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:4161
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.
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:3939
@ K_WORK_QUEUED
Flag indicating a work item that has been submitted to a queue but has not started running.
Definition kernel.h:3946
@ K_WORK_DELAYED
Flag indicating a delayed work item that is scheduled for submission to a queue.
Definition kernel.h:3953
@ K_WORK_RUNNING
Flag indicating a work item that is running under a work queue thread.
Definition kernel.h:3933
@ K_WORK_FLUSHING
Flag indicating a synced work item that is being flushed.
Definition kernel.h:3959
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.
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.
execution_context_types
Definition kernel.h:90
@ K_ISR
Definition kernel.h:91
@ K_COOP_THREAD
Definition kernel.h:92
@ K_PREEMPT_THREAD
Definition kernel.h:93
int k_thread_runtime_stats_all_get(k_thread_runtime_stats_t *stats)
Get the runtime statistics of all threads.
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:304
Memory Statistics.
flags
Definition parser.h:96
state
Definition parser_state.h:29
__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
Structure to store initialization entry information.
Definition init.h:103
Definition kernel.h:3112
_wait_q_t wait_q
Definition kernel.h:3113
Event Structure.
Definition kernel.h:2307
struct k_spinlock lock
Definition kernel.h:2310
uint32_t events
Definition kernel.h:2309
_wait_q_t wait_q
Definition kernel.h:2308
Definition kernel.h:2474
futex structure
Definition kernel.h:2228
atomic_t val
Definition kernel.h:2229
Definition kernel.h:5403
struct k_spinlock lock
Definition kernel.h:5406
struct sys_heap heap
Definition kernel.h:5404
_wait_q_t wait_q
Definition kernel.h:5405
Definition kernel.h:2713
Mailbox Message Structure.
Definition kernel.h:4800
k_tid_t tx_target_thread
target thread id
Definition kernel.h:4810
void * tx_data
sender's message data buffer
Definition kernel.h:4806
k_tid_t rx_source_thread
source thread id
Definition kernel.h:4808
uint32_t info
application-defined information value
Definition kernel.h:4804
size_t size
size of message (in bytes)
Definition kernel.h:4802
Mailbox Structure.
Definition kernel.h:4822
_wait_q_t tx_msg_queue
Transmit messages queue.
Definition kernel.h:4824
struct k_spinlock lock
Definition kernel.h:4827
_wait_q_t rx_msg_queue
Receive message queue.
Definition kernel.h:4826
Memory Domain.
Definition mem_domain.h:80
Memory Partition.
Definition mem_domain.h:55
Message Queue Attributes.
Definition kernel.h:4568
uint32_t used_msgs
Used messages.
Definition kernel.h:4574
size_t msg_size
Message Size.
Definition kernel.h:4570
uint32_t max_msgs
Maximal number of messages.
Definition kernel.h:4572
Message Queue Structure.
Definition kernel.h:4509
size_t msg_size
Message size.
Definition kernel.h:4515
char * read_ptr
Read pointer.
Definition kernel.h:4523
uint32_t used_msgs
Number of used messages.
Definition kernel.h:4527
char * buffer_end
End of message buffer.
Definition kernel.h:4521
struct k_spinlock lock
Lock.
Definition kernel.h:4513
char * write_ptr
Write pointer.
Definition kernel.h:4525
char * buffer_start
Start of message buffer.
Definition kernel.h:4519
uint8_t flags
Message queue.
Definition kernel.h:4532
_wait_q_t wait_q
Message queue wait queue.
Definition kernel.h:4511
uint32_t max_msgs
Maximal number of messages.
Definition kernel.h:4517
Mutex Structure.
Definition kernel.h:3000
uint32_t lock_count
Current lock count.
Definition kernel.h:3007
_wait_q_t wait_q
Mutex wait queue.
Definition kernel.h:3002
int owner_orig_prio
Original thread priority.
Definition kernel.h:3010
struct k_thread * owner
Mutex owner.
Definition kernel.h:3004
Object core structure.
Definition obj_core.h:121
Pipe Structure.
Definition kernel.h:4953
uint8_t flags
Wait queue.
Definition kernel.h:4968
struct k_pipe::@314 wait_q
_wait_q_t readers
Reader wait queue.
Definition kernel.h:4962
size_t write_index
Where in buffer to write.
Definition kernel.h:4958
size_t bytes_used
Number of bytes used in buffer.
Definition kernel.h:4956
struct k_spinlock lock
Synchronization lock.
Definition kernel.h:4959
_wait_q_t writers
Writer wait queue.
Definition kernel.h:4963
size_t size
Buffer size.
Definition kernel.h:4955
unsigned char * buffer
Pipe buffer: may be NULL.
Definition kernel.h:4954
size_t read_index
Where in buffer to read from.
Definition kernel.h:4957
Poll Event.
Definition kernel.h:5798
struct k_poll_signal * signal
Definition kernel.h:5826
uint32_t tag
optional user-specified tag, opaque, untouched by the API
Definition kernel.h:5806
struct k_fifo * fifo
Definition kernel.h:5828
struct k_msgq * msgq
Definition kernel.h:5830
struct k_queue * queue
Definition kernel.h:5829
uint32_t unused
unused bits in 32-bit word
Definition kernel.h:5818
uint32_t type
bitfield of event types (bitwise-ORed K_POLL_TYPE_xxx values)
Definition kernel.h:5809
struct k_sem * sem
Definition kernel.h:5827
uint32_t state
bitfield of event states (bitwise-ORed K_POLL_STATE_xxx values)
Definition kernel.h:5812
uint32_t mode
mode of operation, from enum k_poll_modes
Definition kernel.h:5815
struct z_poller * poller
PRIVATE - DO NOT TOUCH.
Definition kernel.h:5803
void * obj
Definition kernel.h:5825
Definition kernel.h:5774
sys_dlist_t poll_events
PRIVATE - DO NOT TOUCH.
Definition kernel.h:5776
int result
custom result value passed to k_poll_signal_raise() if needed
Definition kernel.h:5785
unsigned int signaled
1 if the event has been signaled, 0 otherwise.
Definition kernel.h:5782
Definition kernel.h:1936
struct k_spinlock lock
Definition kernel.h:1938
_wait_q_t wait_q
Definition kernel.h:1939
sys_sflist_t data_q
Definition kernel.h:1937
Kernel Spin Lock.
Definition spinlock.h:45
Definition thread.h:207
Thread Structure.
Definition thread.h:259
struct _thread_base base
Definition thread.h:261
struct k_heap * resource_pool
resource pool
Definition thread.h:349
struct __thread_entry entry
thread entry and parameters description
Definition thread.h:288
Kernel timeout type.
Definition sys_clock.h:65
A structure used to submit work after a delay.
Definition kernel.h:3991
struct _timeout timeout
Definition kernel.h:3996
struct k_work_q * queue
Definition kernel.h:3999
struct k_work work
Definition kernel.h:3993
A structure used to hold work until it can be processed.
Definition kernel.h:4115
sys_slist_t pending
Definition kernel.h:4124
_wait_q_t drainq
Definition kernel.h:4130
_wait_q_t notifyq
Definition kernel.h:4127
uint32_t flags
Definition kernel.h:4133
struct k_thread thread
Definition kernel.h:4117
A structure holding optional configuration items for a work queue.
Definition kernel.h:4087
const char * name
The name to be given to the work queue thread.
Definition kernel.h:4092
bool essential
Control whether the work queue thread should be marked as essential thread.
Definition kernel.h:4111
bool no_yield
Control whether the work queue thread should yield between items.
Definition kernel.h:4106
A structure holding internal state for a pending synchronous operation on a work item or queue.
Definition kernel.h:4074
struct z_work_canceller canceller
Definition kernel.h:4077
struct z_work_flusher flusher
Definition kernel.h:4076
A structure used to submit work.
Definition kernel.h:3963
k_work_handler_t handler
Definition kernel.h:3972
uint32_t flags
Definition kernel.h:3983
struct k_work_q * queue
Definition kernel.h:3975
sys_snode_t node
Definition kernel.h:3969
Definition sys_heap.h:57
Definition mem_stats.h:24
Macros to abstract toolchain specific capabilities.