Zephyr Project API 3.7.0
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
124
153 k_thread_user_cb_t user_cb, void *user_data);
154
163#endif /* !_ASMLANGUAGE */
164
165
166/*
167 * Thread user options. May be needed by assembly code. Common part uses low
168 * bits, arch-specific use high bits.
169 */
170
174#define K_ESSENTIAL (BIT(0))
175
185#define K_FP_IDX 1
186#define K_FP_REGS (BIT(K_FP_IDX))
187
194#define K_USER (BIT(2))
195
204#define K_INHERIT_PERMS (BIT(3))
205
215#define K_CALLBACK_STATE (BIT(4))
216
226#define K_DSP_IDX 6
227#define K_DSP_REGS (BIT(K_DSP_IDX))
228
237#define K_AGU_IDX 7
238#define K_AGU_REGS (BIT(K_AGU_IDX))
239
249#define K_SSE_REGS (BIT(7))
250
251/* end - thread options */
252
253#if !defined(_ASMLANGUAGE)
268__syscall k_thread_stack_t *k_thread_stack_alloc(size_t size, int flags);
269
283
332__syscall k_tid_t k_thread_create(struct k_thread *new_thread,
334 size_t stack_size,
336 void *p1, void *p2, void *p3,
337 int prio, uint32_t options, k_timeout_t delay);
338
361 void *p1, void *p2,
362 void *p3);
363
377#define k_thread_access_grant(thread, ...) \
378 FOR_EACH_FIXED_ARG(k_object_access_grant, (;), (thread), __VA_ARGS__)
379
394static inline void k_thread_heap_assign(struct k_thread *thread,
395 struct k_heap *heap)
396{
397 thread->resource_pool = heap;
398}
399
400#if defined(CONFIG_INIT_STACKS) && defined(CONFIG_THREAD_STACK_INFO)
421__syscall int k_thread_stack_space_get(const struct k_thread *thread,
422 size_t *unused_ptr);
423#endif
424
425#if (K_HEAP_MEM_POOL_SIZE > 0)
438void k_thread_system_pool_assign(struct k_thread *thread);
439#endif /* (K_HEAP_MEM_POOL_SIZE > 0) */
440
461
477
490{
491 return k_sleep(Z_TIMEOUT_MS(ms));
492}
493
511
528__syscall void k_busy_wait(uint32_t usec_to_wait);
529
541bool k_can_yield(void);
542
550__syscall void k_yield(void);
551
561__syscall void k_wakeup(k_tid_t thread);
562
576__attribute_const__
578
585__attribute_const__
586static inline k_tid_t k_current_get(void)
587{
588#ifdef CONFIG_CURRENT_THREAD_USE_TLS
589
590 /* Thread-local cache of current thread ID, set in z_thread_entry() */
591 extern __thread k_tid_t z_tls_current;
592
593 return z_tls_current;
594#else
596#endif
597}
598
619
620
631
632k_ticks_t z_timeout_expires(const struct _timeout *timeout);
633k_ticks_t z_timeout_remaining(const struct _timeout *timeout);
634
635#ifdef CONFIG_SYS_CLOCK_EXISTS
636
645
646static inline k_ticks_t z_impl_k_thread_timeout_expires_ticks(
647 const struct k_thread *thread)
648{
649 return z_timeout_expires(&thread->base.timeout);
650}
651
660
661static inline k_ticks_t z_impl_k_thread_timeout_remaining_ticks(
662 const struct k_thread *thread)
663{
664 return z_timeout_remaining(&thread->base.timeout);
665}
666
667#endif /* CONFIG_SYS_CLOCK_EXISTS */
668
673struct _static_thread_data {
674 struct k_thread *init_thread;
675 k_thread_stack_t *init_stack;
676 unsigned int init_stack_size;
678 void *init_p1;
679 void *init_p2;
680 void *init_p3;
681 int init_prio;
682 uint32_t init_options;
683 const char *init_name;
684#ifdef CONFIG_TIMER_READS_ITS_FREQUENCY_AT_RUNTIME
685 int32_t init_delay_ms;
686#else
687 k_timeout_t init_delay;
688#endif
689};
690
691#ifdef CONFIG_TIMER_READS_ITS_FREQUENCY_AT_RUNTIME
692#define Z_THREAD_INIT_DELAY_INITIALIZER(ms) .init_delay_ms = (ms)
693#define Z_THREAD_INIT_DELAY(thread) SYS_TIMEOUT_MS((thread)->init_delay_ms)
694#else
695#define Z_THREAD_INIT_DELAY_INITIALIZER(ms) .init_delay = SYS_TIMEOUT_MS(ms)
696#define Z_THREAD_INIT_DELAY(thread) (thread)->init_delay
697#endif
698
699#define Z_THREAD_INITIALIZER(thread, stack, stack_size, \
700 entry, p1, p2, p3, \
701 prio, options, delay, tname) \
702 { \
703 .init_thread = (thread), \
704 .init_stack = (stack), \
705 .init_stack_size = (stack_size), \
706 .init_entry = (k_thread_entry_t)entry, \
707 .init_p1 = (void *)p1, \
708 .init_p2 = (void *)p2, \
709 .init_p3 = (void *)p3, \
710 .init_prio = (prio), \
711 .init_options = (options), \
712 .init_name = STRINGIFY(tname), \
713 Z_THREAD_INIT_DELAY_INITIALIZER(delay) \
714 }
715
716/*
717 * Refer to K_THREAD_DEFINE() and K_KERNEL_THREAD_DEFINE() for
718 * information on arguments.
719 */
720#define Z_THREAD_COMMON_DEFINE(name, stack_size, \
721 entry, p1, p2, p3, \
722 prio, options, delay) \
723 struct k_thread _k_thread_obj_##name; \
724 STRUCT_SECTION_ITERABLE(_static_thread_data, \
725 _k_thread_data_##name) = \
726 Z_THREAD_INITIALIZER(&_k_thread_obj_##name, \
727 _k_thread_stack_##name, stack_size,\
728 entry, p1, p2, p3, prio, options, \
729 delay, name); \
730 const k_tid_t name = (k_tid_t)&_k_thread_obj_##name
731
767#define K_THREAD_DEFINE(name, stack_size, \
768 entry, p1, p2, p3, \
769 prio, options, delay) \
770 K_THREAD_STACK_DEFINE(_k_thread_stack_##name, stack_size); \
771 Z_THREAD_COMMON_DEFINE(name, stack_size, entry, p1, p2, p3, \
772 prio, options, delay)
773
804#define K_KERNEL_THREAD_DEFINE(name, stack_size, \
805 entry, p1, p2, p3, \
806 prio, options, delay) \
807 K_KERNEL_STACK_DEFINE(_k_thread_stack_##name, stack_size); \
808 Z_THREAD_COMMON_DEFINE(name, stack_size, entry, p1, p2, p3, \
809 prio, options, delay)
810
821
847__syscall void k_thread_priority_set(k_tid_t thread, int prio);
848
849
850#ifdef CONFIG_SCHED_DEADLINE
883__syscall void k_thread_deadline_set(k_tid_t thread, int deadline);
884#endif
885
886#ifdef CONFIG_SCHED_CPU_MASK
900
914
928
942
954#endif
955
977
989
1016void k_sched_time_slice_set(int32_t slice, int prio);
1017
1056void k_thread_time_slice_set(struct k_thread *th, int32_t slice_ticks,
1057 k_thread_timeslice_fn_t expired, void *data);
1058
1077bool k_is_in_isr(void);
1078
1095__syscall int k_is_preempt_thread(void);
1096
1108static inline bool k_is_pre_kernel(void)
1109{
1110 extern bool z_sys_post_kernel; /* in init.c */
1111
1112 return !z_sys_post_kernel;
1113}
1114
1149void k_sched_lock(void);
1150
1159
1172__syscall void k_thread_custom_data_set(void *value);
1173
1181__syscall void *k_thread_custom_data_get(void);
1182
1196__syscall int k_thread_name_set(k_tid_t thread, const char *str);
1197
1207
1219__syscall int k_thread_name_copy(k_tid_t thread, char *buf,
1220 size_t size);
1221
1234const char *k_thread_state_str(k_tid_t thread_id, char *buf, size_t buf_size);
1235
1253#define K_NO_WAIT Z_TIMEOUT_NO_WAIT
1254
1267#define K_NSEC(t) Z_TIMEOUT_NS(t)
1268
1281#define K_USEC(t) Z_TIMEOUT_US(t)
1282
1293#define K_CYC(t) Z_TIMEOUT_CYC(t)
1294
1305#define K_TICKS(t) Z_TIMEOUT_TICKS(t)
1306
1317#define K_MSEC(ms) Z_TIMEOUT_MS(ms)
1318
1329#define K_SECONDS(s) K_MSEC((s) * MSEC_PER_SEC)
1330
1341#define K_MINUTES(m) K_SECONDS((m) * 60)
1342
1353#define K_HOURS(h) K_MINUTES((h) * 60)
1354
1363#define K_FOREVER Z_FOREVER
1364
1365#ifdef CONFIG_TIMEOUT_64BIT
1366
1378#define K_TIMEOUT_ABS_TICKS(t) \
1379 Z_TIMEOUT_TICKS(Z_TICK_ABS((k_ticks_t)MAX(t, 0)))
1380
1392#define K_TIMEOUT_ABS_MS(t) K_TIMEOUT_ABS_TICKS(k_ms_to_ticks_ceil64(t))
1393
1406#define K_TIMEOUT_ABS_US(t) K_TIMEOUT_ABS_TICKS(k_us_to_ticks_ceil64(t))
1407
1420#define K_TIMEOUT_ABS_NS(t) K_TIMEOUT_ABS_TICKS(k_ns_to_ticks_ceil64(t))
1421
1434#define K_TIMEOUT_ABS_CYC(t) K_TIMEOUT_ABS_TICKS(k_cyc_to_ticks_ceil64(t))
1435
1436#endif
1437
1446struct k_timer {
1447 /*
1448 * _timeout structure must be first here if we want to use
1449 * dynamic timer allocation. timeout.node is used in the double-linked
1450 * list of free timers
1451 */
1452 struct _timeout timeout;
1453
1454 /* wait queue for the (single) thread waiting on this timer */
1455 _wait_q_t wait_q;
1456
1457 /* runs in ISR context */
1458 void (*expiry_fn)(struct k_timer *timer);
1459
1460 /* runs in the context of the thread that calls k_timer_stop() */
1461 void (*stop_fn)(struct k_timer *timer);
1462
1463 /* timer period */
1464 k_timeout_t period;
1465
1466 /* timer status */
1467 uint32_t status;
1468
1469 /* user-specific data, also used to support legacy features */
1470 void *user_data;
1471
1473
1474#ifdef CONFIG_OBJ_CORE_TIMER
1475 struct k_obj_core obj_core;
1476#endif
1477};
1478
1479#define Z_TIMER_INITIALIZER(obj, expiry, stop) \
1480 { \
1481 .timeout = { \
1482 .node = {},\
1483 .fn = z_timer_expiration_handler, \
1484 .dticks = 0, \
1485 }, \
1486 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
1487 .expiry_fn = expiry, \
1488 .stop_fn = stop, \
1489 .status = 0, \
1490 .user_data = 0, \
1491 }
1492
1513typedef void (*k_timer_expiry_t)(struct k_timer *timer);
1514
1529typedef void (*k_timer_stop_t)(struct k_timer *timer);
1530
1542#define K_TIMER_DEFINE(name, expiry_fn, stop_fn) \
1543 STRUCT_SECTION_ITERABLE(k_timer, name) = \
1544 Z_TIMER_INITIALIZER(name, expiry_fn, stop_fn)
1545
1555void k_timer_init(struct k_timer *timer,
1556 k_timer_expiry_t expiry_fn,
1557 k_timer_stop_t stop_fn);
1558
1573__syscall void k_timer_start(struct k_timer *timer,
1574 k_timeout_t duration, k_timeout_t period);
1575
1592__syscall void k_timer_stop(struct k_timer *timer);
1593
1606__syscall uint32_t k_timer_status_get(struct k_timer *timer);
1607
1625__syscall uint32_t k_timer_status_sync(struct k_timer *timer);
1626
1627#ifdef CONFIG_SYS_CLOCK_EXISTS
1628
1639__syscall k_ticks_t k_timer_expires_ticks(const struct k_timer *timer);
1640
1641static inline k_ticks_t z_impl_k_timer_expires_ticks(
1642 const struct k_timer *timer)
1643{
1644 return z_timeout_expires(&timer->timeout);
1645}
1646
1657__syscall k_ticks_t k_timer_remaining_ticks(const struct k_timer *timer);
1658
1659static inline k_ticks_t z_impl_k_timer_remaining_ticks(
1660 const struct k_timer *timer)
1661{
1662 return z_timeout_remaining(&timer->timeout);
1663}
1664
1675static inline uint32_t k_timer_remaining_get(struct k_timer *timer)
1676{
1678}
1679
1680#endif /* CONFIG_SYS_CLOCK_EXISTS */
1681
1694__syscall void k_timer_user_data_set(struct k_timer *timer, void *user_data);
1695
1699static inline void z_impl_k_timer_user_data_set(struct k_timer *timer,
1700 void *user_data)
1701{
1702 timer->user_data = user_data;
1703}
1704
1712__syscall void *k_timer_user_data_get(const struct k_timer *timer);
1713
1714static inline void *z_impl_k_timer_user_data_get(const struct k_timer *timer)
1715{
1716 return timer->user_data;
1717}
1718
1736__syscall int64_t k_uptime_ticks(void);
1737
1751static inline int64_t k_uptime_get(void)
1752{
1754}
1755
1775static inline uint32_t k_uptime_get_32(void)
1776{
1777 return (uint32_t)k_uptime_get();
1778}
1779
1788static inline uint32_t k_uptime_seconds(void)
1789{
1791}
1792
1804static inline int64_t k_uptime_delta(int64_t *reftime)
1805{
1806 int64_t uptime, delta;
1807
1808 uptime = k_uptime_get();
1809 delta = uptime - *reftime;
1810 *reftime = uptime;
1811
1812 return delta;
1813}
1814
1823static inline uint32_t k_cycle_get_32(void)
1824{
1825 return arch_k_cycle_get_32();
1826}
1827
1838static inline uint64_t k_cycle_get_64(void)
1839{
1840 if (!IS_ENABLED(CONFIG_TIMER_HAS_64BIT_CYCLE_COUNTER)) {
1841 __ASSERT(0, "64-bit cycle counter not enabled on this platform. "
1842 "See CONFIG_TIMER_HAS_64BIT_CYCLE_COUNTER");
1843 return 0;
1844 }
1845
1846 return arch_k_cycle_get_64();
1847}
1848
1853struct k_queue {
1856 _wait_q_t wait_q;
1857
1858 Z_DECL_POLL_EVENT
1859
1861};
1862
1867#define Z_QUEUE_INITIALIZER(obj) \
1868 { \
1869 .data_q = SYS_SFLIST_STATIC_INIT(&obj.data_q), \
1870 .lock = { }, \
1871 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
1872 Z_POLL_EVENT_OBJ_INIT(obj) \
1873 }
1874
1892__syscall void k_queue_init(struct k_queue *queue);
1893
1907__syscall void k_queue_cancel_wait(struct k_queue *queue);
1908
1921void k_queue_append(struct k_queue *queue, void *data);
1922
1940
1953void k_queue_prepend(struct k_queue *queue, void *data);
1954
1972
1986void k_queue_insert(struct k_queue *queue, void *prev, void *data);
1987
2006int k_queue_append_list(struct k_queue *queue, void *head, void *tail);
2007
2024
2042__syscall void *k_queue_get(struct k_queue *queue, k_timeout_t timeout);
2043
2060bool k_queue_remove(struct k_queue *queue, void *data);
2061
2077
2091__syscall int k_queue_is_empty(struct k_queue *queue);
2092
2093static inline int z_impl_k_queue_is_empty(struct k_queue *queue)
2094{
2095 return sys_sflist_is_empty(&queue->data_q) ? 1 : 0;
2096}
2097
2107__syscall void *k_queue_peek_head(struct k_queue *queue);
2108
2118__syscall void *k_queue_peek_tail(struct k_queue *queue);
2119
2129#define K_QUEUE_DEFINE(name) \
2130 STRUCT_SECTION_ITERABLE(k_queue, name) = \
2131 Z_QUEUE_INITIALIZER(name)
2132
2135#ifdef CONFIG_USERSPACE
2145struct k_futex {
2147};
2148
2156struct z_futex_data {
2157 _wait_q_t wait_q;
2158 struct k_spinlock lock;
2159};
2160
2161#define Z_FUTEX_DATA_INITIALIZER(obj) \
2162 { \
2163 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q) \
2164 }
2165
2191__syscall int k_futex_wait(struct k_futex *futex, int expected,
2193
2208__syscall int k_futex_wake(struct k_futex *futex, bool wake_all);
2209
2211#endif
2212
2224struct k_event {
2225 _wait_q_t wait_q;
2228
2230
2231#ifdef CONFIG_OBJ_CORE_EVENT
2232 struct k_obj_core obj_core;
2233#endif
2234
2235};
2236
2237#define Z_EVENT_INITIALIZER(obj) \
2238 { \
2239 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
2240 .events = 0 \
2241 }
2242
2250__syscall void k_event_init(struct k_event *event);
2251
2267__syscall uint32_t k_event_post(struct k_event *event, uint32_t events);
2268
2284__syscall uint32_t k_event_set(struct k_event *event, uint32_t events);
2285
2300__syscall uint32_t k_event_set_masked(struct k_event *event, uint32_t events,
2301 uint32_t events_mask);
2302
2313__syscall uint32_t k_event_clear(struct k_event *event, uint32_t events);
2314
2336__syscall uint32_t k_event_wait(struct k_event *event, uint32_t events,
2337 bool reset, k_timeout_t timeout);
2338
2360__syscall uint32_t k_event_wait_all(struct k_event *event, uint32_t events,
2361 bool reset, k_timeout_t timeout);
2362
2371static inline uint32_t k_event_test(struct k_event *event, uint32_t events_mask)
2372{
2373 return k_event_wait(event, events_mask, false, K_NO_WAIT);
2374}
2375
2385#define K_EVENT_DEFINE(name) \
2386 STRUCT_SECTION_ITERABLE(k_event, name) = \
2387 Z_EVENT_INITIALIZER(name);
2388
2391struct k_fifo {
2392 struct k_queue _queue;
2393#ifdef CONFIG_OBJ_CORE_FIFO
2394 struct k_obj_core obj_core;
2395#endif
2396};
2397
2401#define Z_FIFO_INITIALIZER(obj) \
2402 { \
2403 ._queue = Z_QUEUE_INITIALIZER(obj._queue) \
2404 }
2405
2423#define k_fifo_init(fifo) \
2424 ({ \
2425 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, init, fifo); \
2426 k_queue_init(&(fifo)->_queue); \
2427 K_OBJ_CORE_INIT(K_OBJ_CORE(fifo), _obj_type_fifo); \
2428 K_OBJ_CORE_LINK(K_OBJ_CORE(fifo)); \
2429 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, init, fifo); \
2430 })
2431
2443#define k_fifo_cancel_wait(fifo) \
2444 ({ \
2445 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, cancel_wait, fifo); \
2446 k_queue_cancel_wait(&(fifo)->_queue); \
2447 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, cancel_wait, fifo); \
2448 })
2449
2462#define k_fifo_put(fifo, data) \
2463 ({ \
2464 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put, fifo, data); \
2465 k_queue_append(&(fifo)->_queue, data); \
2466 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put, fifo, data); \
2467 })
2468
2485#define k_fifo_alloc_put(fifo, data) \
2486 ({ \
2487 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, alloc_put, fifo, data); \
2488 int fap_ret = k_queue_alloc_append(&(fifo)->_queue, data); \
2489 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, alloc_put, fifo, data, fap_ret); \
2490 fap_ret; \
2491 })
2492
2507#define k_fifo_put_list(fifo, head, tail) \
2508 ({ \
2509 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put_list, fifo, head, tail); \
2510 k_queue_append_list(&(fifo)->_queue, head, tail); \
2511 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put_list, fifo, head, tail); \
2512 })
2513
2527#define k_fifo_put_slist(fifo, list) \
2528 ({ \
2529 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put_slist, fifo, list); \
2530 k_queue_merge_slist(&(fifo)->_queue, list); \
2531 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put_slist, fifo, list); \
2532 })
2533
2551#define k_fifo_get(fifo, timeout) \
2552 ({ \
2553 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, get, fifo, timeout); \
2554 void *fg_ret = k_queue_get(&(fifo)->_queue, timeout); \
2555 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, get, fifo, timeout, fg_ret); \
2556 fg_ret; \
2557 })
2558
2572#define k_fifo_is_empty(fifo) \
2573 k_queue_is_empty(&(fifo)->_queue)
2574
2588#define k_fifo_peek_head(fifo) \
2589 ({ \
2590 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, peek_head, fifo); \
2591 void *fph_ret = k_queue_peek_head(&(fifo)->_queue); \
2592 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, peek_head, fifo, fph_ret); \
2593 fph_ret; \
2594 })
2595
2607#define k_fifo_peek_tail(fifo) \
2608 ({ \
2609 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, peek_tail, fifo); \
2610 void *fpt_ret = k_queue_peek_tail(&(fifo)->_queue); \
2611 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, peek_tail, fifo, fpt_ret); \
2612 fpt_ret; \
2613 })
2614
2624#define K_FIFO_DEFINE(name) \
2625 STRUCT_SECTION_ITERABLE(k_fifo, name) = \
2626 Z_FIFO_INITIALIZER(name)
2627
2630struct k_lifo {
2631 struct k_queue _queue;
2632#ifdef CONFIG_OBJ_CORE_LIFO
2633 struct k_obj_core obj_core;
2634#endif
2635};
2636
2641#define Z_LIFO_INITIALIZER(obj) \
2642 { \
2643 ._queue = Z_QUEUE_INITIALIZER(obj._queue) \
2644 }
2645
2663#define k_lifo_init(lifo) \
2664 ({ \
2665 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, init, lifo); \
2666 k_queue_init(&(lifo)->_queue); \
2667 K_OBJ_CORE_INIT(K_OBJ_CORE(lifo), _obj_type_lifo); \
2668 K_OBJ_CORE_LINK(K_OBJ_CORE(lifo)); \
2669 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, init, lifo); \
2670 })
2671
2684#define k_lifo_put(lifo, data) \
2685 ({ \
2686 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, put, lifo, data); \
2687 k_queue_prepend(&(lifo)->_queue, data); \
2688 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, put, lifo, data); \
2689 })
2690
2707#define k_lifo_alloc_put(lifo, data) \
2708 ({ \
2709 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, alloc_put, lifo, data); \
2710 int lap_ret = k_queue_alloc_prepend(&(lifo)->_queue, data); \
2711 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, alloc_put, lifo, data, lap_ret); \
2712 lap_ret; \
2713 })
2714
2732#define k_lifo_get(lifo, timeout) \
2733 ({ \
2734 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, get, lifo, timeout); \
2735 void *lg_ret = k_queue_get(&(lifo)->_queue, timeout); \
2736 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, get, lifo, timeout, lg_ret); \
2737 lg_ret; \
2738 })
2739
2749#define K_LIFO_DEFINE(name) \
2750 STRUCT_SECTION_ITERABLE(k_lifo, name) = \
2751 Z_LIFO_INITIALIZER(name)
2752
2758#define K_STACK_FLAG_ALLOC ((uint8_t)1) /* Buffer was allocated */
2759
2760typedef uintptr_t stack_data_t;
2761
2762struct k_stack {
2763 _wait_q_t wait_q;
2764 struct k_spinlock lock;
2765 stack_data_t *base, *next, *top;
2766
2767 uint8_t flags;
2768
2770
2771#ifdef CONFIG_OBJ_CORE_STACK
2772 struct k_obj_core obj_core;
2773#endif
2774};
2775
2776#define Z_STACK_INITIALIZER(obj, stack_buffer, stack_num_entries) \
2777 { \
2778 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
2779 .base = (stack_buffer), \
2780 .next = (stack_buffer), \
2781 .top = (stack_buffer) + (stack_num_entries), \
2782 }
2783
2803void k_stack_init(struct k_stack *stack,
2804 stack_data_t *buffer, uint32_t num_entries);
2805
2806
2821__syscall int32_t k_stack_alloc_init(struct k_stack *stack,
2822 uint32_t num_entries);
2823
2835int k_stack_cleanup(struct k_stack *stack);
2836
2850__syscall int k_stack_push(struct k_stack *stack, stack_data_t data);
2851
2872__syscall int k_stack_pop(struct k_stack *stack, stack_data_t *data,
2874
2885#define K_STACK_DEFINE(name, stack_num_entries) \
2886 stack_data_t __noinit \
2887 _k_stack_buf_##name[stack_num_entries]; \
2888 STRUCT_SECTION_ITERABLE(k_stack, name) = \
2889 Z_STACK_INITIALIZER(name, _k_stack_buf_##name, \
2890 stack_num_entries)
2891
2898struct k_work;
2899struct k_work_q;
2900struct k_work_queue_config;
2901extern struct k_work_q k_sys_work_q;
2902
2917struct k_mutex {
2919 _wait_q_t wait_q;
2922
2925
2928
2930
2931#ifdef CONFIG_OBJ_CORE_MUTEX
2932 struct k_obj_core obj_core;
2933#endif
2934};
2935
2939#define Z_MUTEX_INITIALIZER(obj) \
2940 { \
2941 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
2942 .owner = NULL, \
2943 .lock_count = 0, \
2944 .owner_orig_prio = K_LOWEST_APPLICATION_THREAD_PRIO, \
2945 }
2946
2960#define K_MUTEX_DEFINE(name) \
2961 STRUCT_SECTION_ITERABLE(k_mutex, name) = \
2962 Z_MUTEX_INITIALIZER(name)
2963
2976__syscall int k_mutex_init(struct k_mutex *mutex);
2977
2978
3001
3022__syscall int k_mutex_unlock(struct k_mutex *mutex);
3023
3030 _wait_q_t wait_q;
3031
3032#ifdef CONFIG_OBJ_CORE_CONDVAR
3033 struct k_obj_core obj_core;
3034#endif
3035};
3036
3037#define Z_CONDVAR_INITIALIZER(obj) \
3038 { \
3039 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
3040 }
3041
3054__syscall int k_condvar_init(struct k_condvar *condvar);
3055
3062__syscall int k_condvar_signal(struct k_condvar *condvar);
3063
3072
3090__syscall int k_condvar_wait(struct k_condvar *condvar, struct k_mutex *mutex,
3092
3103#define K_CONDVAR_DEFINE(name) \
3104 STRUCT_SECTION_ITERABLE(k_condvar, name) = \
3105 Z_CONDVAR_INITIALIZER(name)
3114struct k_sem {
3115 _wait_q_t wait_q;
3116 unsigned int count;
3117 unsigned int limit;
3118
3119 Z_DECL_POLL_EVENT
3120
3122
3123#ifdef CONFIG_OBJ_CORE_SEM
3124 struct k_obj_core obj_core;
3125#endif
3126};
3127
3128#define Z_SEM_INITIALIZER(obj, initial_count, count_limit) \
3129 { \
3130 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
3131 .count = (initial_count), \
3132 .limit = (count_limit), \
3133 Z_POLL_EVENT_OBJ_INIT(obj) \
3134 }
3135
3154#define K_SEM_MAX_LIMIT UINT_MAX
3155
3171__syscall int k_sem_init(struct k_sem *sem, unsigned int initial_count,
3172 unsigned int limit);
3173
3192__syscall int k_sem_take(struct k_sem *sem, k_timeout_t timeout);
3193
3204__syscall void k_sem_give(struct k_sem *sem);
3205
3215__syscall void k_sem_reset(struct k_sem *sem);
3216
3226__syscall unsigned int k_sem_count_get(struct k_sem *sem);
3227
3231static inline unsigned int z_impl_k_sem_count_get(struct k_sem *sem)
3232{
3233 return sem->count;
3234}
3235
3247#define K_SEM_DEFINE(name, initial_count, count_limit) \
3248 STRUCT_SECTION_ITERABLE(k_sem, name) = \
3249 Z_SEM_INITIALIZER(name, initial_count, count_limit); \
3250 BUILD_ASSERT(((count_limit) != 0) && \
3251 ((initial_count) <= (count_limit)) && \
3252 ((count_limit) <= K_SEM_MAX_LIMIT));
3253
3260struct k_work_delayable;
3261struct k_work_sync;
3262
3279typedef void (*k_work_handler_t)(struct k_work *work);
3280
3296
3311int k_work_busy_get(const struct k_work *work);
3312
3326static inline bool k_work_is_pending(const struct k_work *work);
3327
3349 struct k_work *work);
3350
3360
3386 struct k_work_sync *sync);
3387
3408
3440
3451
3472 k_thread_stack_t *stack, size_t stack_size,
3473 int prio, const struct k_work_queue_config *cfg);
3474
3484static inline k_tid_t k_work_queue_thread_get(struct k_work_q *queue);
3485
3509int k_work_queue_drain(struct k_work_q *queue, bool plug);
3510
3525
3541
3553static inline struct k_work_delayable *
3555
3570
3585static inline bool k_work_delayable_is_pending(
3586 const struct k_work_delayable *dwork);
3587
3602 const struct k_work_delayable *dwork);
3603
3618 const struct k_work_delayable *dwork);
3619
3648 struct k_work_delayable *dwork,
3649 k_timeout_t delay);
3650
3665 k_timeout_t delay);
3666
3703 struct k_work_delayable *dwork,
3704 k_timeout_t delay);
3705
3719 k_timeout_t delay);
3720
3746 struct k_work_sync *sync);
3747
3769
3799 struct k_work_sync *sync);
3800
3801enum {
3806 /* The atomic API is used for all work and queue flags fields to
3807 * enforce sequential consistency in SMP environments.
3808 */
3809
3810 /* Bits that represent the work item states. At least nine of the
3811 * combinations are distinct valid stable states.
3812 */
3813 K_WORK_RUNNING_BIT = 0,
3814 K_WORK_CANCELING_BIT = 1,
3815 K_WORK_QUEUED_BIT = 2,
3816 K_WORK_DELAYED_BIT = 3,
3817 K_WORK_FLUSHING_BIT = 4,
3818
3819 K_WORK_MASK = BIT(K_WORK_DELAYED_BIT) | BIT(K_WORK_QUEUED_BIT)
3820 | BIT(K_WORK_RUNNING_BIT) | BIT(K_WORK_CANCELING_BIT) | BIT(K_WORK_FLUSHING_BIT),
3821
3822 /* Static work flags */
3823 K_WORK_DELAYABLE_BIT = 8,
3824 K_WORK_DELAYABLE = BIT(K_WORK_DELAYABLE_BIT),
3825
3826 /* Dynamic work queue flags */
3827 K_WORK_QUEUE_STARTED_BIT = 0,
3828 K_WORK_QUEUE_STARTED = BIT(K_WORK_QUEUE_STARTED_BIT),
3829 K_WORK_QUEUE_BUSY_BIT = 1,
3830 K_WORK_QUEUE_BUSY = BIT(K_WORK_QUEUE_BUSY_BIT),
3831 K_WORK_QUEUE_DRAIN_BIT = 2,
3832 K_WORK_QUEUE_DRAIN = BIT(K_WORK_QUEUE_DRAIN_BIT),
3833 K_WORK_QUEUE_PLUGGED_BIT = 3,
3834 K_WORK_QUEUE_PLUGGED = BIT(K_WORK_QUEUE_PLUGGED_BIT),
3835
3836 /* Static work queue flags */
3837 K_WORK_QUEUE_NO_YIELD_BIT = 8,
3838 K_WORK_QUEUE_NO_YIELD = BIT(K_WORK_QUEUE_NO_YIELD_BIT),
3839
3843 /* Transient work flags */
3844
3850 K_WORK_RUNNING = BIT(K_WORK_RUNNING_BIT),
3851
3856 K_WORK_CANCELING = BIT(K_WORK_CANCELING_BIT),
3857
3863 K_WORK_QUEUED = BIT(K_WORK_QUEUED_BIT),
3864
3870 K_WORK_DELAYED = BIT(K_WORK_DELAYED_BIT),
3871
3876 K_WORK_FLUSHING = BIT(K_WORK_FLUSHING_BIT),
3877};
3878
3880struct k_work {
3881 /* All fields are protected by the work module spinlock. No fields
3882 * are to be accessed except through kernel API.
3883 */
3884
3885 /* Node to link into k_work_q pending list. */
3887
3888 /* The function to be invoked by the work queue thread. */
3890
3891 /* The queue on which the work item was last submitted. */
3893
3894 /* State of the work item.
3895 *
3896 * The item can be DELAYED, QUEUED, and RUNNING simultaneously.
3897 *
3898 * It can be RUNNING and CANCELING simultaneously.
3899 */
3901};
3902
3903#define Z_WORK_INITIALIZER(work_handler) { \
3904 .handler = (work_handler), \
3905}
3906
3909 /* The work item. */
3910 struct k_work work;
3911
3912 /* Timeout used to submit work after a delay. */
3913 struct _timeout timeout;
3914
3915 /* The queue to which the work should be submitted. */
3917};
3918
3919#define Z_WORK_DELAYABLE_INITIALIZER(work_handler) { \
3920 .work = { \
3921 .handler = (work_handler), \
3922 .flags = K_WORK_DELAYABLE, \
3923 }, \
3924}
3925
3942#define K_WORK_DELAYABLE_DEFINE(work, work_handler) \
3943 struct k_work_delayable work \
3944 = Z_WORK_DELAYABLE_INITIALIZER(work_handler)
3945
3950/* Record used to wait for work to flush.
3951 *
3952 * The work item is inserted into the queue that will process (or is
3953 * processing) the item, and will be processed as soon as the item
3954 * completes. When the flusher is processed the semaphore will be
3955 * signaled, releasing the thread waiting for the flush.
3956 */
3957struct z_work_flusher {
3958 struct k_work work;
3959 struct k_sem sem;
3960};
3961
3962/* Record used to wait for work to complete a cancellation.
3963 *
3964 * The work item is inserted into a global queue of pending cancels.
3965 * When a cancelling work item goes idle any matching waiters are
3966 * removed from pending_cancels and are woken.
3967 */
3968struct z_work_canceller {
3969 sys_snode_t node;
3970 struct k_work *work;
3971 struct k_sem sem;
3972};
3973
3992 union {
3993 struct z_work_flusher flusher;
3994 struct z_work_canceller canceller;
3995 };
3996};
3997
4009 const char *name;
4010
4024
4029};
4030
4032struct k_work_q {
4033 /* The thread that animates the work. */
4035
4036 /* All the following fields must be accessed only while the
4037 * work module spinlock is held.
4038 */
4039
4040 /* List of k_work items to be worked. */
4042
4043 /* Wait queue for idle work thread. */
4044 _wait_q_t notifyq;
4045
4046 /* Wait queue for threads waiting for the queue to drain. */
4047 _wait_q_t drainq;
4048
4049 /* Flags describing queue state. */
4051};
4052
4053/* Provide the implementation for inline functions declared above */
4054
4055static inline bool k_work_is_pending(const struct k_work *work)
4056{
4057 return k_work_busy_get(work) != 0;
4058}
4059
4060static inline struct k_work_delayable *
4065
4067 const struct k_work_delayable *dwork)
4068{
4069 return k_work_delayable_busy_get(dwork) != 0;
4070}
4071
4073 const struct k_work_delayable *dwork)
4074{
4075 return z_timeout_expires(&dwork->timeout);
4076}
4077
4079 const struct k_work_delayable *dwork)
4080{
4081 return z_timeout_remaining(&dwork->timeout);
4082}
4083
4085{
4086 return &queue->thread;
4087}
4088
4091struct k_work_user;
4092
4107typedef void (*k_work_user_handler_t)(struct k_work_user *work);
4108
4113struct k_work_user_q {
4114 struct k_queue queue;
4115 struct k_thread thread;
4116};
4117
4118enum {
4119 K_WORK_USER_STATE_PENDING, /* Work item pending state */
4120};
4121
4122struct k_work_user {
4123 void *_reserved; /* Used by k_queue implementation. */
4126};
4127
4132#if defined(__cplusplus) && ((__cplusplus - 0) < 202002L)
4133#define Z_WORK_USER_INITIALIZER(work_handler) { NULL, work_handler, 0 }
4134#else
4135#define Z_WORK_USER_INITIALIZER(work_handler) \
4136 { \
4137 ._reserved = NULL, \
4138 .handler = (work_handler), \
4139 .flags = 0 \
4140 }
4141#endif
4142
4154#define K_WORK_USER_DEFINE(work, work_handler) \
4155 struct k_work_user work = Z_WORK_USER_INITIALIZER(work_handler)
4156
4166static inline void k_work_user_init(struct k_work_user *work,
4168{
4169 *work = (struct k_work_user)Z_WORK_USER_INITIALIZER(handler);
4170}
4171
4188static inline bool k_work_user_is_pending(struct k_work_user *work)
4189{
4190 return atomic_test_bit(&work->flags, K_WORK_USER_STATE_PENDING);
4191}
4192
4211static inline int k_work_user_submit_to_queue(struct k_work_user_q *work_q,
4212 struct k_work_user *work)
4213{
4214 int ret = -EBUSY;
4215
4217 K_WORK_USER_STATE_PENDING)) {
4218 ret = k_queue_alloc_append(&work_q->queue, work);
4219
4220 /* Couldn't insert into the queue. Clear the pending bit
4221 * so the work item can be submitted again
4222 */
4223 if (ret != 0) {
4225 K_WORK_USER_STATE_PENDING);
4226 }
4227 }
4228
4229 return ret;
4230}
4231
4251void k_work_user_queue_start(struct k_work_user_q *work_q,
4253 size_t stack_size, int prio,
4254 const char *name);
4255
4266static inline k_tid_t k_work_user_queue_thread_get(struct k_work_user_q *work_q)
4267{
4268 return &work_q->thread;
4269}
4270
4277struct k_work_poll {
4278 struct k_work work;
4279 struct k_work_q *workq;
4280 struct z_poller poller;
4281 struct k_poll_event *events;
4282 int num_events;
4283 k_work_handler_t real_handler;
4284 struct _timeout timeout;
4285 int poll_result;
4286};
4287
4308#define K_WORK_DEFINE(work, work_handler) \
4309 struct k_work work = Z_WORK_INITIALIZER(work_handler)
4310
4320void k_work_poll_init(struct k_work_poll *work,
4322
4358 struct k_work_poll *work,
4359 struct k_poll_event *events,
4360 int num_events,
4362
4394int k_work_poll_submit(struct k_work_poll *work,
4395 struct k_poll_event *events,
4396 int num_events,
4398
4413int k_work_poll_cancel(struct k_work_poll *work);
4414
4426struct k_msgq {
4428 _wait_q_t wait_q;
4432 size_t msg_size;
4445
4446 Z_DECL_POLL_EVENT
4447
4450
4452
4453#ifdef CONFIG_OBJ_CORE_MSGQ
4454 struct k_obj_core obj_core;
4455#endif
4456};
4462#define Z_MSGQ_INITIALIZER(obj, q_buffer, q_msg_size, q_max_msgs) \
4463 { \
4464 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
4465 .msg_size = q_msg_size, \
4466 .max_msgs = q_max_msgs, \
4467 .buffer_start = q_buffer, \
4468 .buffer_end = q_buffer + (q_max_msgs * q_msg_size), \
4469 .read_ptr = q_buffer, \
4470 .write_ptr = q_buffer, \
4471 .used_msgs = 0, \
4472 Z_POLL_EVENT_OBJ_INIT(obj) \
4473 }
4474
4480#define K_MSGQ_FLAG_ALLOC BIT(0)
4481
4493
4494
4513#define K_MSGQ_DEFINE(q_name, q_msg_size, q_max_msgs, q_align) \
4514 static char __noinit __aligned(q_align) \
4515 _k_fifo_buf_##q_name[(q_max_msgs) * (q_msg_size)]; \
4516 STRUCT_SECTION_ITERABLE(k_msgq, q_name) = \
4517 Z_MSGQ_INITIALIZER(q_name, _k_fifo_buf_##q_name, \
4518 (q_msg_size), (q_max_msgs))
4519
4534void k_msgq_init(struct k_msgq *msgq, char *buffer, size_t msg_size,
4535 uint32_t max_msgs);
4536
4556__syscall int k_msgq_alloc_init(struct k_msgq *msgq, size_t msg_size,
4557 uint32_t max_msgs);
4558
4570
4591__syscall int k_msgq_put(struct k_msgq *msgq, const void *data, k_timeout_t timeout);
4592
4613__syscall int k_msgq_get(struct k_msgq *msgq, void *data, k_timeout_t timeout);
4614
4629__syscall int k_msgq_peek(struct k_msgq *msgq, void *data);
4630
4647__syscall int k_msgq_peek_at(struct k_msgq *msgq, void *data, uint32_t idx);
4648
4658__syscall void k_msgq_purge(struct k_msgq *msgq);
4659
4671
4680__syscall void k_msgq_get_attrs(struct k_msgq *msgq,
4681 struct k_msgq_attrs *attrs);
4682
4683
4684static inline uint32_t z_impl_k_msgq_num_free_get(struct k_msgq *msgq)
4685{
4686 return msgq->max_msgs - msgq->used_msgs;
4687}
4688
4699
4700static inline uint32_t z_impl_k_msgq_num_used_get(struct k_msgq *msgq)
4701{
4702 return msgq->used_msgs;
4703}
4704
4719 size_t size;
4723 void *tx_data;
4729 k_tid_t _syncing_thread;
4730#if (CONFIG_NUM_MBOX_ASYNC_MSGS > 0)
4732 struct k_sem *_async_sem;
4733#endif
4734};
4739struct k_mbox {
4741 _wait_q_t tx_msg_queue;
4743 _wait_q_t rx_msg_queue;
4745
4747
4748#ifdef CONFIG_OBJ_CORE_MAILBOX
4749 struct k_obj_core obj_core;
4750#endif
4751};
4756#define Z_MBOX_INITIALIZER(obj) \
4757 { \
4758 .tx_msg_queue = Z_WAIT_Q_INIT(&obj.tx_msg_queue), \
4759 .rx_msg_queue = Z_WAIT_Q_INIT(&obj.rx_msg_queue), \
4760 }
4761
4775#define K_MBOX_DEFINE(name) \
4776 STRUCT_SECTION_ITERABLE(k_mbox, name) = \
4777 Z_MBOX_INITIALIZER(name) \
4778
4787
4807int k_mbox_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg,
4809
4823void k_mbox_async_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg,
4824 struct k_sem *sem);
4825
4843int k_mbox_get(struct k_mbox *mbox, struct k_mbox_msg *rx_msg,
4844 void *buffer, k_timeout_t timeout);
4845
4859void k_mbox_data_get(struct k_mbox_msg *rx_msg, void *buffer);
4860
4870struct k_pipe {
4871 unsigned char *buffer;
4872 size_t size;
4873 size_t bytes_used;
4874 size_t read_index;
4878 struct {
4879 _wait_q_t readers;
4880 _wait_q_t writers;
4883 Z_DECL_POLL_EVENT
4884
4888
4889#ifdef CONFIG_OBJ_CORE_PIPE
4890 struct k_obj_core obj_core;
4891#endif
4892};
4893
4897#define K_PIPE_FLAG_ALLOC BIT(0)
4899#define Z_PIPE_INITIALIZER(obj, pipe_buffer, pipe_buffer_size) \
4900 { \
4901 .buffer = pipe_buffer, \
4902 .size = pipe_buffer_size, \
4903 .bytes_used = 0, \
4904 .read_index = 0, \
4905 .write_index = 0, \
4906 .lock = {}, \
4907 .wait_q = { \
4908 .readers = Z_WAIT_Q_INIT(&obj.wait_q.readers), \
4909 .writers = Z_WAIT_Q_INIT(&obj.wait_q.writers) \
4910 }, \
4911 Z_POLL_EVENT_OBJ_INIT(obj) \
4912 .flags = 0, \
4913 }
4914
4932#define K_PIPE_DEFINE(name, pipe_buffer_size, pipe_align) \
4933 static unsigned char __noinit __aligned(pipe_align) \
4934 _k_pipe_buf_##name[pipe_buffer_size]; \
4935 STRUCT_SECTION_ITERABLE(k_pipe, name) = \
4936 Z_PIPE_INITIALIZER(name, _k_pipe_buf_##name, pipe_buffer_size)
4937
4949void k_pipe_init(struct k_pipe *pipe, unsigned char *buffer, size_t size);
4950
4963
4979__syscall int k_pipe_alloc_init(struct k_pipe *pipe, size_t size);
4980
4999__syscall int k_pipe_put(struct k_pipe *pipe, const void *data,
5000 size_t bytes_to_write, size_t *bytes_written,
5001 size_t min_xfer, k_timeout_t timeout);
5002
5022__syscall int k_pipe_get(struct k_pipe *pipe, void *data,
5023 size_t bytes_to_read, size_t *bytes_read,
5024 size_t min_xfer, k_timeout_t timeout);
5025
5034__syscall size_t k_pipe_read_avail(struct k_pipe *pipe);
5035
5044__syscall size_t k_pipe_write_avail(struct k_pipe *pipe);
5045
5056__syscall void k_pipe_flush(struct k_pipe *pipe);
5057
5069__syscall void k_pipe_buffer_flush(struct k_pipe *pipe);
5070
5077struct k_mem_slab_info {
5078 uint32_t num_blocks;
5079 size_t block_size;
5080 uint32_t num_used;
5081#ifdef CONFIG_MEM_SLAB_TRACE_MAX_UTILIZATION
5082 uint32_t max_used;
5083#endif
5084};
5085
5086struct k_mem_slab {
5087 _wait_q_t wait_q;
5088 struct k_spinlock lock;
5089 char *buffer;
5090 char *free_list;
5091 struct k_mem_slab_info info;
5092
5094
5095#ifdef CONFIG_OBJ_CORE_MEM_SLAB
5096 struct k_obj_core obj_core;
5097#endif
5098};
5099
5100#define Z_MEM_SLAB_INITIALIZER(_slab, _slab_buffer, _slab_block_size, \
5101 _slab_num_blocks) \
5102 { \
5103 .wait_q = Z_WAIT_Q_INIT(&(_slab).wait_q), \
5104 .lock = {}, \
5105 .buffer = _slab_buffer, \
5106 .free_list = NULL, \
5107 .info = {_slab_num_blocks, _slab_block_size, 0} \
5108 }
5109
5110
5144#define K_MEM_SLAB_DEFINE(name, slab_block_size, slab_num_blocks, slab_align) \
5145 char __noinit_named(k_mem_slab_buf_##name) \
5146 __aligned(WB_UP(slab_align)) \
5147 _k_mem_slab_buf_##name[(slab_num_blocks) * WB_UP(slab_block_size)]; \
5148 STRUCT_SECTION_ITERABLE(k_mem_slab, name) = \
5149 Z_MEM_SLAB_INITIALIZER(name, _k_mem_slab_buf_##name, \
5150 WB_UP(slab_block_size), slab_num_blocks)
5151
5166#define K_MEM_SLAB_DEFINE_STATIC(name, slab_block_size, slab_num_blocks, slab_align) \
5167 static char __noinit_named(k_mem_slab_buf_##name) \
5168 __aligned(WB_UP(slab_align)) \
5169 _k_mem_slab_buf_##name[(slab_num_blocks) * WB_UP(slab_block_size)]; \
5170 static STRUCT_SECTION_ITERABLE(k_mem_slab, name) = \
5171 Z_MEM_SLAB_INITIALIZER(name, _k_mem_slab_buf_##name, \
5172 WB_UP(slab_block_size), slab_num_blocks)
5173
5195int k_mem_slab_init(struct k_mem_slab *slab, void *buffer,
5196 size_t block_size, uint32_t num_blocks);
5197
5220int k_mem_slab_alloc(struct k_mem_slab *slab, void **mem,
5222
5232void k_mem_slab_free(struct k_mem_slab *slab, void *mem);
5233
5244static inline uint32_t k_mem_slab_num_used_get(struct k_mem_slab *slab)
5245{
5246 return slab->info.num_used;
5247}
5248
5259static inline uint32_t k_mem_slab_max_used_get(struct k_mem_slab *slab)
5260{
5261#ifdef CONFIG_MEM_SLAB_TRACE_MAX_UTILIZATION
5262 return slab->info.max_used;
5263#else
5264 ARG_UNUSED(slab);
5265 return 0;
5266#endif
5267}
5268
5279static inline uint32_t k_mem_slab_num_free_get(struct k_mem_slab *slab)
5280{
5281 return slab->info.num_blocks - slab->info.num_used;
5282}
5283
5296int k_mem_slab_runtime_stats_get(struct k_mem_slab *slab, struct sys_memory_stats *stats);
5297
5309int k_mem_slab_runtime_stats_reset_max(struct k_mem_slab *slab);
5310
5318/* kernel synchronized heap struct */
5319
5320struct k_heap {
5322 _wait_q_t wait_q;
5324};
5325
5339void k_heap_init(struct k_heap *h, void *mem,
5340 size_t bytes) __attribute_nonnull(1);
5341
5362void *k_heap_aligned_alloc(struct k_heap *h, size_t align, size_t bytes,
5363 k_timeout_t timeout) __attribute_nonnull(1);
5364
5386void *k_heap_alloc(struct k_heap *h, size_t bytes,
5387 k_timeout_t timeout) __attribute_nonnull(1);
5388
5412void *k_heap_realloc(struct k_heap *h, void *ptr, size_t bytes, k_timeout_t timeout)
5413 __attribute_nonnull(1);
5414
5425void k_heap_free(struct k_heap *h, void *mem) __attribute_nonnull(1);
5426
5427/* Hand-calculated minimum heap sizes needed to return a successful
5428 * 1-byte allocation. See details in lib/os/heap.[ch]
5429 */
5430#define Z_HEAP_MIN_SIZE ((sizeof(void *) > 4) ? 56 : 44)
5431
5448#define Z_HEAP_DEFINE_IN_SECT(name, bytes, in_section) \
5449 char in_section \
5450 __aligned(8) /* CHUNK_UNIT */ \
5451 kheap_##name[MAX(bytes, Z_HEAP_MIN_SIZE)]; \
5452 STRUCT_SECTION_ITERABLE(k_heap, name) = { \
5453 .heap = { \
5454 .init_mem = kheap_##name, \
5455 .init_bytes = MAX(bytes, Z_HEAP_MIN_SIZE), \
5456 }, \
5457 }
5458
5473#define K_HEAP_DEFINE(name, bytes) \
5474 Z_HEAP_DEFINE_IN_SECT(name, bytes, \
5475 __noinit_named(kheap_buf_##name))
5476
5491#define K_HEAP_DEFINE_NOCACHE(name, bytes) \
5492 Z_HEAP_DEFINE_IN_SECT(name, bytes, __nocache)
5493
5522void *k_aligned_alloc(size_t align, size_t size);
5523
5535void *k_malloc(size_t size);
5536
5547void k_free(void *ptr);
5548
5560void *k_calloc(size_t nmemb, size_t size);
5561
5579void *k_realloc(void *ptr, size_t size);
5580
5583/* polling API - PRIVATE */
5584
5585#ifdef CONFIG_POLL
5586#define _INIT_OBJ_POLL_EVENT(obj) do { (obj)->poll_event = NULL; } while (false)
5587#else
5588#define _INIT_OBJ_POLL_EVENT(obj) do { } while (false)
5589#endif
5590
5591/* private - types bit positions */
5592enum _poll_types_bits {
5593 /* can be used to ignore an event */
5594 _POLL_TYPE_IGNORE,
5595
5596 /* to be signaled by k_poll_signal_raise() */
5597 _POLL_TYPE_SIGNAL,
5598
5599 /* semaphore availability */
5600 _POLL_TYPE_SEM_AVAILABLE,
5601
5602 /* queue/FIFO/LIFO data availability */
5603 _POLL_TYPE_DATA_AVAILABLE,
5604
5605 /* msgq data availability */
5606 _POLL_TYPE_MSGQ_DATA_AVAILABLE,
5607
5608 /* pipe data availability */
5609 _POLL_TYPE_PIPE_DATA_AVAILABLE,
5610
5611 _POLL_NUM_TYPES
5612};
5613
5614#define Z_POLL_TYPE_BIT(type) (1U << ((type) - 1U))
5615
5616/* private - states bit positions */
5617enum _poll_states_bits {
5618 /* default state when creating event */
5619 _POLL_STATE_NOT_READY,
5620
5621 /* signaled by k_poll_signal_raise() */
5622 _POLL_STATE_SIGNALED,
5623
5624 /* semaphore is available */
5625 _POLL_STATE_SEM_AVAILABLE,
5626
5627 /* data is available to read on queue/FIFO/LIFO */
5628 _POLL_STATE_DATA_AVAILABLE,
5629
5630 /* queue/FIFO/LIFO wait was cancelled */
5631 _POLL_STATE_CANCELLED,
5632
5633 /* data is available to read on a message queue */
5634 _POLL_STATE_MSGQ_DATA_AVAILABLE,
5635
5636 /* data is available to read from a pipe */
5637 _POLL_STATE_PIPE_DATA_AVAILABLE,
5638
5639 _POLL_NUM_STATES
5640};
5641
5642#define Z_POLL_STATE_BIT(state) (1U << ((state) - 1U))
5643
5644#define _POLL_EVENT_NUM_UNUSED_BITS \
5645 (32 - (0 \
5646 + 8 /* tag */ \
5647 + _POLL_NUM_TYPES \
5648 + _POLL_NUM_STATES \
5649 + 1 /* modes */ \
5650 ))
5651
5652/* end of polling API - PRIVATE */
5653
5654
5661/* Public polling API */
5662
5663/* public - values for k_poll_event.type bitfield */
5664#define K_POLL_TYPE_IGNORE 0
5665#define K_POLL_TYPE_SIGNAL Z_POLL_TYPE_BIT(_POLL_TYPE_SIGNAL)
5666#define K_POLL_TYPE_SEM_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_SEM_AVAILABLE)
5667#define K_POLL_TYPE_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_DATA_AVAILABLE)
5668#define K_POLL_TYPE_FIFO_DATA_AVAILABLE K_POLL_TYPE_DATA_AVAILABLE
5669#define K_POLL_TYPE_MSGQ_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_MSGQ_DATA_AVAILABLE)
5670#define K_POLL_TYPE_PIPE_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_PIPE_DATA_AVAILABLE)
5671
5672/* public - polling modes */
5674 /* polling thread does not take ownership of objects when available */
5676
5679
5680/* public - values for k_poll_event.state bitfield */
5681#define K_POLL_STATE_NOT_READY 0
5682#define K_POLL_STATE_SIGNALED Z_POLL_STATE_BIT(_POLL_STATE_SIGNALED)
5683#define K_POLL_STATE_SEM_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_SEM_AVAILABLE)
5684#define K_POLL_STATE_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_DATA_AVAILABLE)
5685#define K_POLL_STATE_FIFO_DATA_AVAILABLE K_POLL_STATE_DATA_AVAILABLE
5686#define K_POLL_STATE_MSGQ_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_MSGQ_DATA_AVAILABLE)
5687#define K_POLL_STATE_PIPE_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_PIPE_DATA_AVAILABLE)
5688#define K_POLL_STATE_CANCELLED Z_POLL_STATE_BIT(_POLL_STATE_CANCELLED)
5689
5690/* public - poll signal object */
5694
5699 unsigned int signaled;
5700
5703};
5704
5705#define K_POLL_SIGNAL_INITIALIZER(obj) \
5706 { \
5707 .poll_events = SYS_DLIST_STATIC_INIT(&obj.poll_events), \
5708 .signaled = 0, \
5709 .result = 0, \
5710 }
5717 sys_dnode_t _node;
5718
5720 struct z_poller *poller;
5721
5724
5726 uint32_t type:_POLL_NUM_TYPES;
5727
5729 uint32_t state:_POLL_NUM_STATES;
5730
5733
5735 uint32_t unused:_POLL_EVENT_NUM_UNUSED_BITS;
5736
5738 union {
5739 /* The typed_* fields below are used by K_POLL_EVENT_*INITIALIZER() macros to ensure
5740 * type safety of polled objects.
5741 */
5742 void *obj, *typed_K_POLL_TYPE_IGNORE;
5743 struct k_poll_signal *signal, *typed_K_POLL_TYPE_SIGNAL;
5744 struct k_sem *sem, *typed_K_POLL_TYPE_SEM_AVAILABLE;
5745 struct k_fifo *fifo, *typed_K_POLL_TYPE_FIFO_DATA_AVAILABLE;
5746 struct k_queue *queue, *typed_K_POLL_TYPE_DATA_AVAILABLE;
5747 struct k_msgq *msgq, *typed_K_POLL_TYPE_MSGQ_DATA_AVAILABLE;
5748#ifdef CONFIG_PIPES
5749 struct k_pipe *pipe, *typed_K_POLL_TYPE_PIPE_DATA_AVAILABLE;
5750#endif
5751 };
5752};
5753
5754#define K_POLL_EVENT_INITIALIZER(_event_type, _event_mode, _event_obj) \
5755 { \
5756 .poller = NULL, \
5757 .type = _event_type, \
5758 .state = K_POLL_STATE_NOT_READY, \
5759 .mode = _event_mode, \
5760 .unused = 0, \
5761 { \
5762 .typed_##_event_type = _event_obj, \
5763 }, \
5764 }
5765
5766#define K_POLL_EVENT_STATIC_INITIALIZER(_event_type, _event_mode, _event_obj, \
5767 event_tag) \
5768 { \
5769 .tag = event_tag, \
5770 .type = _event_type, \
5771 .state = K_POLL_STATE_NOT_READY, \
5772 .mode = _event_mode, \
5773 .unused = 0, \
5774 { \
5775 .typed_##_event_type = _event_obj, \
5776 }, \
5777 }
5778
5794void k_poll_event_init(struct k_poll_event *event, uint32_t type,
5795 int mode, void *obj);
5796
5840__syscall int k_poll(struct k_poll_event *events, int num_events,
5842
5851__syscall void k_poll_signal_init(struct k_poll_signal *sig);
5852
5858__syscall void k_poll_signal_reset(struct k_poll_signal *sig);
5859
5870__syscall void k_poll_signal_check(struct k_poll_signal *sig,
5871 unsigned int *signaled, int *result);
5872
5897__syscall int k_poll_signal_raise(struct k_poll_signal *sig, int result);
5898
5919static inline void k_cpu_idle(void)
5920{
5921 arch_cpu_idle();
5922}
5923
5938static inline void k_cpu_atomic_idle(unsigned int key)
5939{
5941}
5942
5951#ifdef ARCH_EXCEPT
5952/* This architecture has direct support for triggering a CPU exception */
5953#define z_except_reason(reason) ARCH_EXCEPT(reason)
5954#else
5955
5956#if !defined(CONFIG_ASSERT_NO_FILE_INFO)
5957#define __EXCEPT_LOC() __ASSERT_PRINT("@ %s:%d\n", __FILE__, __LINE__)
5958#else
5959#define __EXCEPT_LOC()
5960#endif
5961
5962/* NOTE: This is the implementation for arches that do not implement
5963 * ARCH_EXCEPT() to generate a real CPU exception.
5964 *
5965 * We won't have a real exception frame to determine the PC value when
5966 * the oops occurred, so print file and line number before we jump into
5967 * the fatal error handler.
5968 */
5969#define z_except_reason(reason) do { \
5970 __EXCEPT_LOC(); \
5971 z_fatal_error(reason, NULL); \
5972 } while (false)
5973
5974#endif /* _ARCH__EXCEPT */
5990#define k_oops() z_except_reason(K_ERR_KERNEL_OOPS)
5991
6000#define k_panic() z_except_reason(K_ERR_KERNEL_PANIC)
6001
6006/*
6007 * private APIs that are utilized by one or more public APIs
6008 */
6009
6013void z_timer_expiration_handler(struct _timeout *timeout);
6018#ifdef CONFIG_PRINTK
6026__syscall void k_str_out(char *c, size_t n);
6027#endif
6028
6055__syscall int k_float_disable(struct k_thread *thread);
6056
6095__syscall int k_float_enable(struct k_thread *thread, unsigned int options);
6096
6110
6118
6129
6140
6149
6158
6159#ifdef __cplusplus
6160}
6161#endif
6162
6163#include <zephyr/tracing/tracing.h>
6164#include <zephyr/syscalls/kernel.h>
6165
6166#endif /* !_ASMLANGUAGE */
6167
6168#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
struct z_thread_stack_element k_thread_stack_t
Typedef of struct z_thread_stack_element.
Definition arch_interface.h:46
void(* k_thread_entry_t)(void *p1, void *p2, void *p3)
Thread entry point function type.
Definition arch_interface.h:48
static struct k_thread thread[2]
Definition atomic.c:26
long atomic_t
Definition atomic_types.h:15
ZTEST_BMEM int timeout
Definition main.c:31
ZTEST_BMEM int count
Definition main.c:33
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 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.
Definition atomic.h:170
static uint32_t k_cycle_get_32(void)
Read the hardware clock.
Definition kernel.h:1823
#define K_NO_WAIT
Generate null timeout delay.
Definition kernel.h:1253
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:1775
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:1804
static uint32_t k_uptime_seconds(void)
Get system uptime in seconds.
Definition kernel.h:1788
static uint64_t k_cycle_get_64(void)
Read the 64-bit hardware clock.
Definition kernel.h:1838
static int64_t k_uptime_get(void)
Get system uptime.
Definition kernel.h:1751
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:5919
static void k_cpu_atomic_idle(unsigned int key)
Make the CPU idle in an atomic fashion.
Definition kernel.h:5938
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:2371
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:1108
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:5244
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:5259
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:5279
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:5673
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:5675
@ K_POLL_NUM_MODES
Definition kernel.h:5677
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:360
#define IS_ENABLED(config_macro)
Check for macro definition in compiler-visible expressions.
Definition util_macro.h:124
#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:268
#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:394
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:489
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:586
int k_thread_cpu_mask_clear(k_tid_t thread)
Sets all CPU enable masks to zero.
void k_sched_time_slice_set(int32_t slice, int prio)
Set time-slicing period and scope.
void k_thread_start(k_tid_t thread)
Start an inactive thread.
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.
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.
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.
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_stop_t)(struct k_timer *timer)
Timer stop function type.
Definition kernel.h:1529
void * k_timer_user_data_get(const struct k_timer *timer)
Retrieve the user-specific data from a timer.
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_expiry_t)(struct k_timer *timer)
Timer expiry function type.
Definition kernel.h:1513
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:1675
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:4084
static bool k_work_is_pending(const struct k_work *work)
Test whether a work item is currently pending.
Definition kernel.h:4055
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:4072
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:4211
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:4188
void(* k_work_handler_t)(struct k_work *work)
The signature for a work item handler function.
Definition kernel.h:3279
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:4066
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:4166
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.
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:4266
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:4061
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:4078
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.
void(* k_work_user_handler_t)(struct k_work_user *work)
Work item handler function type for user work queues.
Definition kernel.h:4107
@ K_WORK_CANCELING
Flag indicating a work item that is being canceled.
Definition kernel.h:3856
@ K_WORK_QUEUED
Flag indicating a work item that has been submitted to a queue but has not started running.
Definition kernel.h:3863
@ K_WORK_DELAYED
Flag indicating a delayed work item that is scheduled for submission to a queue.
Definition kernel.h:3870
@ K_WORK_RUNNING
Flag indicating a work item that is running under a work queue thread.
Definition kernel.h:3850
@ K_WORK_FLUSHING
Flag indicating a synced work item that is being flushed.
Definition kernel.h:3876
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.
Header files included by kernel.h.
void(* k_thread_timeslice_fn_t)(struct k_thread *thread, void *data)
Definition kernel_structs.h:307
struct k_mem_slab ms
Definition kobject.c:1316
struct k_mutex mutex
Definition kobject.c:1318
struct k_condvar condvar
Definition kobject.c:1328
static ZTEST_BMEM int ret
Definition main.c:16
Memory Statistics.
struct k_msgq msgq
Definition test_msgq_contexts.c:12
flags
Definition parser.h:96
state
Definition parser_state.h:29
char c
Definition printk.c:169
void * ptr
Definition printk.c:177
static struct k_work work[2]
Definition main.c:16
volatile bool sync[CONFIG_MP_MAX_NUM_CPUS]
Definition main.c:28
char stack[2048]
Definition main.c:22
static struct k_spinlock lock
Definition spinlock_error_case.c:13
static k_spinlock_key_t key
Definition spinlock_error_case.c:15
__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:3029
_wait_q_t wait_q
Definition kernel.h:3030
Event Structure.
Definition kernel.h:2224
struct k_spinlock lock
Definition kernel.h:2227
uint32_t events
Definition kernel.h:2226
_wait_q_t wait_q
Definition kernel.h:2225
Definition kernel.h:2391
futex structure
Definition kernel.h:2145
atomic_t val
Definition kernel.h:2146
Definition kernel.h:5320
struct k_spinlock lock
Definition kernel.h:5323
struct sys_heap heap
Definition kernel.h:5321
_wait_q_t wait_q
Definition kernel.h:5322
Definition kernel.h:2630
Mailbox Message Structure.
Definition kernel.h:4717
k_tid_t tx_target_thread
target thread id
Definition kernel.h:4727
void * tx_data
sender's message data buffer
Definition kernel.h:4723
k_tid_t rx_source_thread
source thread id
Definition kernel.h:4725
uint32_t info
application-defined information value
Definition kernel.h:4721
size_t size
size of message (in bytes)
Definition kernel.h:4719
Mailbox Structure.
Definition kernel.h:4739
_wait_q_t tx_msg_queue
Transmit messages queue.
Definition kernel.h:4741
struct k_spinlock lock
Definition kernel.h:4744
_wait_q_t rx_msg_queue
Receive message queue.
Definition kernel.h:4743
Memory Domain.
Definition mem_domain.h:80
Memory Partition.
Definition mem_domain.h:55
Message Queue Attributes.
Definition kernel.h:4485
uint32_t used_msgs
Used messages.
Definition kernel.h:4491
size_t msg_size
Message Size.
Definition kernel.h:4487
uint32_t max_msgs
Maximal number of messages.
Definition kernel.h:4489
Message Queue Structure.
Definition kernel.h:4426
size_t msg_size
Message size.
Definition kernel.h:4432
char * read_ptr
Read pointer.
Definition kernel.h:4440
uint32_t used_msgs
Number of used messages.
Definition kernel.h:4444
char * buffer_end
End of message buffer.
Definition kernel.h:4438
struct k_spinlock lock
Lock.
Definition kernel.h:4430
char * write_ptr
Write pointer.
Definition kernel.h:4442
char * buffer_start
Start of message buffer.
Definition kernel.h:4436
uint8_t flags
Message queue.
Definition kernel.h:4449
_wait_q_t wait_q
Message queue wait queue.
Definition kernel.h:4428
uint32_t max_msgs
Maximal number of messages.
Definition kernel.h:4434
Mutex Structure.
Definition kernel.h:2917
uint32_t lock_count
Current lock count.
Definition kernel.h:2924
_wait_q_t wait_q
Mutex wait queue.
Definition kernel.h:2919
int owner_orig_prio
Original thread priority.
Definition kernel.h:2927
struct k_thread * owner
Mutex owner.
Definition kernel.h:2921
Object core structure.
Definition obj_core.h:121
Pipe Structure.
Definition kernel.h:4870
uint8_t flags
Wait queue.
Definition kernel.h:4885
_wait_q_t readers
Reader wait queue.
Definition kernel.h:4879
size_t write_index
Where in buffer to write.
Definition kernel.h:4875
size_t bytes_used
Number of bytes used in buffer.
Definition kernel.h:4873
struct k_spinlock lock
Synchronization lock.
Definition kernel.h:4876
_wait_q_t writers
Writer wait queue.
Definition kernel.h:4880
size_t size
Buffer size.
Definition kernel.h:4872
unsigned char * buffer
Pipe buffer: may be NULL.
Definition kernel.h:4871
struct k_pipe::@253 wait_q
size_t read_index
Where in buffer to read from.
Definition kernel.h:4874
Poll Event.
Definition kernel.h:5715
struct k_poll_signal * signal
Definition kernel.h:5743
uint32_t tag
optional user-specified tag, opaque, untouched by the API
Definition kernel.h:5723
struct k_fifo * fifo
Definition kernel.h:5745
struct k_msgq * msgq
Definition kernel.h:5747
struct k_queue * queue
Definition kernel.h:5746
uint32_t unused
unused bits in 32-bit word
Definition kernel.h:5735
uint32_t type
bitfield of event types (bitwise-ORed K_POLL_TYPE_xxx values)
Definition kernel.h:5726
struct k_sem * sem
Definition kernel.h:5744
uint32_t state
bitfield of event states (bitwise-ORed K_POLL_STATE_xxx values)
Definition kernel.h:5729
uint32_t mode
mode of operation, from enum k_poll_modes
Definition kernel.h:5732
struct z_poller * poller
PRIVATE - DO NOT TOUCH.
Definition kernel.h:5720
void * obj
Definition kernel.h:5742
Definition kernel.h:5691
sys_dlist_t poll_events
PRIVATE - DO NOT TOUCH.
Definition kernel.h:5693
int result
custom result value passed to k_poll_signal_raise() if needed
Definition kernel.h:5702
unsigned int signaled
1 if the event has been signaled, 0 otherwise.
Definition kernel.h:5699
Definition kernel.h:1853
struct k_spinlock lock
Definition kernel.h:1855
_wait_q_t wait_q
Definition kernel.h:1856
sys_sflist_t data_q
Definition kernel.h:1854
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:3908
struct _timeout timeout
Definition kernel.h:3913
struct k_work_q * queue
Definition kernel.h:3916
struct k_work work
Definition kernel.h:3910
A structure used to hold work until it can be processed.
Definition kernel.h:4032
sys_slist_t pending
Definition kernel.h:4041
_wait_q_t drainq
Definition kernel.h:4047
_wait_q_t notifyq
Definition kernel.h:4044
uint32_t flags
Definition kernel.h:4050
struct k_thread thread
Definition kernel.h:4034
A structure holding optional configuration items for a work queue.
Definition kernel.h:4004
const char * name
The name to be given to the work queue thread.
Definition kernel.h:4009
bool essential
Control whether the work queue thread should be marked as essential thread.
Definition kernel.h:4028
bool no_yield
Control whether the work queue thread should yield between items.
Definition kernel.h:4023
A structure holding internal state for a pending synchronous operation on a work item or queue.
Definition kernel.h:3991
struct z_work_canceller canceller
Definition kernel.h:3994
struct z_work_flusher flusher
Definition kernel.h:3993
A structure used to submit work.
Definition kernel.h:3880
k_work_handler_t handler
Definition kernel.h:3889
uint32_t flags
Definition kernel.h:3900
struct k_work_q * queue
Definition kernel.h:3892
sys_snode_t node
Definition kernel.h:3886
Definition errno.c:37
Definition sys_heap.h:56
Definition mem_stats.h:24
static fdata_t data[2]
Definition test_fifo_contexts.c:15
static struct k_mbox mbox
Definition test_mbox_api.c:28
static ZTEST_BMEM char buffer[8]
Definition test_mbox_api.c:433
static struct k_queue queue
Definition test_mutex_error.c:19
static struct k_pipe pipe
Definition test_mutex_error.c:18
static int init_prio
Definition test_sched_timeslice_and_lock.c:15
static ZTEST_BMEM struct thread_data expected
static struct k_timer timer[3]
Definition timeout_order.c:13
static struct k_sem sem[3]
Definition timeout_order.c:14
static void handler(struct k_timer *timer)
Definition main.c:19
static const intptr_t user_data[5]
Definition main.c:588
Macros to abstract toolchain specific capabilities.
static struct k_work_delayable dwork
Definition main.c:50