Zephyr API Documentation 4.5.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Kernel APIs

Kernel APIs. More...

Topics

 Async polling APIs
 An API to wait concurrently for any one of multiple conditions to be fulfilled.
 Atomic Services APIs
 
 Barrier Services APIs
 
 CPU Idling APIs
 Condition Variables APIs
 Event APIs
 FIFO APIs
 A FIFO is a typed view of a queue, so for user threads the object to grant with k_object_access_grant() is the underlying k_queue, not the wrapper.
 FUTEX APIs
 Fatal error APIs
 Floating Point APIs
 Heap APIs
 Memory allocation from the Heap.
 Interrupt Service Routine APIs
 
 Kernel Memory Management
 Kernel Memory Management.
 LIFO APIs
 A LIFO is a typed view of a queue, so the same rule applies as for the FIFO: a user thread needs the underlying k_queue granted to it.
 Mailbox APIs
 Memory Slab APIs
 Memory domain APIs
 Message Queue APIs
 Mutex APIs
 Object Core APIs
 Object Core Statistics APIs
 Pipe APIs
 Queue APIs
 A queue is a kernel object, so a user thread reaches one only after the object has been granted to that thread with k_object_access_grant().
 Semaphore APIs
 Spinlock APIs
 Spinlock APIs.
 Stack APIs
 System Clock APIs
 System Clock APIs.
 Thread APIs
 
 Thread Stack APIs
 Thread Stack APIs.
 Timer APIs
 User Mode APIs
 Version APIs
 Kernel Version APIs.
 Work Queue APIs
 

Macros

#define K_ANY   NULL
 Wildcard used to match any thread.

Enumerations

enum  execution_context_types { K_ISR = 0 , K_COOP_THREAD , K_PREEMPT_THREAD }
 Types of execution contexts. More...

Detailed Description

Kernel APIs.

Since
1.0
Version
1.0.0

Macro Definition Documentation

◆ K_ANY

#define K_ANY   NULL

#include <zephyr/kernel.h>

Wildcard used to match any thread.

Can be used wherever a thread identifier is expected but any thread is acceptable, such as the source or target thread of a mailbox message.

Enumeration Type Documentation

◆ execution_context_types

#include <zephyr/kernel.h>

Types of execution contexts.

Enumerator
K_ISR 

Executing in an interrupt service routine.

K_COOP_THREAD 

Executing in a cooperative thread.

K_PREEMPT_THREAD 

Executing in a preemptible thread.