text stringlengths 9 39.2M | dir stringlengths 25 226 | lang stringclasses 163
values | created_date timestamp[s] | updated_date timestamp[s] | repo_name stringclasses 751
values | repo_full_name stringclasses 752
values | star int64 1.01k 183k | len_tokens int64 1 18.5M |
|---|---|---|---|---|---|---|---|---|
```restructuredtext
.. _toolchain_xtools:
Crosstool-NG (Deprecated)
#########################
.. warning::
``xtools`` toolchain variant is deprecated. The
:ref:`cross-compile toolchain variant <other_x_compilers>` should be used
when using a custom toolchain built with Crosstool-NG.
You can build toolchain... | /content/code_sandbox/doc/develop/toolchains/crosstool_ng.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 370 |
```restructuredtext
.. _other_x_compilers:
Other Cross Compilers
######################
This toolchain variant is borrowed from the Linux kernel build system's
mechanism of using a ``CROSS_COMPILE`` environment variable to set up a
GNU-based cross toolchain.
Examples of such "other cross compilers" are cross toolcha... | /content/code_sandbox/doc/develop/toolchains/other_x_compilers.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 608 |
```restructuredtext
.. _toolchain_designware_arc_mwdt:
DesignWare ARC MetaWare Development Toolkit (MWDT)
##################################################
#. You need to have `ARC MWDT <path_to_url`_ installed on
your host.
#. You need to have :ref:`Zephyr SDK <toolchain_zephyr_sdk>` installed on your host.
... | /content/code_sandbox/doc/develop/toolchains/designware_arc_mwdt.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 534 |
```restructuredtext
.. _api_overview:
API Overview
############
The table lists Zephyr's APIs and information about them, including their
current :ref:`stability level <api_lifecycle>`. More details about API changes
between major releases are available in the :ref:`zephyr_release_notes`.
The version column uses `s... | /content/code_sandbox/doc/develop/api/overview.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 568 |
```restructuredtext
.. _api_status_and_guidelines:
API Status and Guidelines
#########################
.. toctree::
:maxdepth: 1
overview.rst
api_lifecycle.rst
design_guidelines.rst
terminology.rst
``` | /content/code_sandbox/doc/develop/api/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 53 |
```restructuredtext
.. _toolchain_zephyr_sdk:
Zephyr SDK
##########
The Zephyr Software Development Kit (SDK) contains toolchains for each of
Zephyr's supported architectures. It also includes additional host tools, such
as custom QEMU and OpenOCD.
Use of the Zephyr SDK is highly recommended and may even be required... | /content/code_sandbox/doc/develop/toolchains/zephyr_sdk.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,926 |
```restructuredtext
.. _api_terms:
API Terminology
###############
The following terms may be used as shorthand API tags to indicate the
allowed calling context (thread, ISR, pre-kernel), the effect of a call
on the current thread state, and other behavioral characteristics.
:ref:`api_term_reschedule`
if executin... | /content/code_sandbox/doc/develop/api/terminology.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,536 |
```restructuredtext
.. _design_guidelines:
API Design Guidelines
#####################
Zephyr development and evolution is a group effort, and to simplify
maintenance and enhancements there are some general policies that should
be followed when developing a new capability or interface.
Using Callbacks
**************... | /content/code_sandbox/doc/develop/api/design_guidelines.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,117 |
```restructuredtext
.. _code_data_relocation:
Code And Data Relocation
########################
Overview
********
This feature will allow relocating .text, .rodata, .data, and .bss sections from
required files and place them in the required memory region. The memory region
and file are given to the :ref:`gen_relocate... | /content/code_sandbox/doc/kernel/code-relocation.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,505 |
```restructuredtext
.. _kernel:
Kernel
######
.. toctree::
:maxdepth: 1
services/index.rst
drivers/index.rst
usermode/index.rst
memory_management/index.rst
data_structures/index.rst
timing_functions/index.rst
object_cores/index.rst
timeutil.rst
util/index.rst
iterable_sections/index.... | /content/code_sandbox/doc/kernel/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 96 |
```restructuredtext
.. _api_lifecycle:
API Lifecycle
#############
Developers using Zephyr's APIs need to know how long they can trust that a
given API will not change in future releases. At the same time, developers
maintaining and extending Zephyr's APIs need to be able to introduce
new APIs that aren't yet fully p... | /content/code_sandbox/doc/develop/api/api_lifecycle.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,423 |
```restructuredtext
.. _kernel_api:
Kernel Services
###############
The Zephyr kernel lies at the heart of every Zephyr application. It provides
a low footprint, high performance, multi-threaded execution environment
with a rich set of available features. The rest of the Zephyr ecosystem,
including device drivers, ne... | /content/code_sandbox/doc/kernel/services/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 956 |
```restructuredtext
.. _timeutil_api:
Time Utilities
##############
Overview
********
:ref:`kernel_timing_uptime` in Zephyr is based on the a tick counter. With
the default :kconfig:option:`CONFIG_TICKLESS_KERNEL` this counter advances at a
nominally constant rate from zero at the instant the system started. The PO... | /content/code_sandbox/doc/kernel/timeutil.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,555 |
```restructuredtext
.. _polling_v2:
Polling API
###########
The polling API is used to wait concurrently for any one of multiple conditions
to be fulfilled.
.. contents::
:local:
:depth: 2
Concepts
********
The polling API's main function is :c:func:`k_poll`, which is very similar
in concept to the POSIX :... | /content/code_sandbox/doc/kernel/services/polling.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,812 |
```restructuredtext
.. _condvar:
Condition Variables
###################
A :dfn:`condition variable` is a synchronization primitive
that enables threads to wait until a particular condition occurs.
.. contents::
:local:
:depth: 2
Concepts
********
Any number of condition variables can be defined (limited o... | /content/code_sandbox/doc/kernel/services/synchronization/condvar.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 784 |
```restructuredtext
.. _semaphores_v2:
Semaphores
##########
A :dfn:`semaphore` is a kernel object that implements a traditional
counting semaphore.
.. contents::
:local:
:depth: 2
Concepts
********
Any number of semaphores can be defined (limited only by available RAM). Each
semaphore is referenced by its... | /content/code_sandbox/doc/kernel/services/synchronization/semaphores.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 906 |
```restructuredtext
.. _mutexes_v2:
Mutexes
#######
A :dfn:`mutex` is a kernel object that implements a traditional
reentrant mutex. A mutex allows multiple threads to safely share
an associated hardware or software resource by ensuring mutually exclusive
access to the resource.
.. contents::
:local:
:depth:... | /content/code_sandbox/doc/kernel/services/synchronization/mutexes.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,293 |
```restructuredtext
.. _events:
Events
######
An :dfn:`event object` is a kernel object that implements traditional events.
.. contents::
:local:
:depth: 2
Concepts
********
Any number of event objects can be defined (limited only by available RAM). Each
event object is referenced by its memory address. On... | /content/code_sandbox/doc/kernel/services/synchronization/events.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,000 |
```restructuredtext
.. _interrupts_v2:
Interrupts
##########
An :dfn:`interrupt service routine` (ISR) is a function that executes
asynchronously in response to a hardware or software interrupt.
An ISR normally preempts the execution of the current thread,
allowing the response to occur with very low overhead.
Thread... | /content/code_sandbox/doc/kernel/services/interrupts.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 6,919 |
```restructuredtext
.. _scheduling_v2:
Scheduling
##########
The kernel's priority-based scheduler allows an application's threads
to share the CPU.
Concepts
********
The scheduler determines which thread is allowed to execute
at any point in time; this thread is known as the **current thread**.
There are various ... | /content/code_sandbox/doc/kernel/services/scheduling/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,156 |
```restructuredtext
.. _nothread:
Operation without Threads
#########################
Thread support is not necessary in some applications:
* Bootloaders
* Simple event-driven applications
* Examples intended to demonstrate core functionality
Thread support can be disabled by setting
:kconfig:option:`CONFIG_MULTITH... | /content/code_sandbox/doc/kernel/services/threads/nothread.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 780 |
```restructuredtext
.. _threads_v2:
Threads
#######
.. note::
There is also limited support for using :ref:`nothread`.
.. contents::
:local:
:depth: 2
This section describes kernel services for creating, scheduling, and deleting
independently executable threads of instructions.
A :dfn:`thread` is a kern... | /content/code_sandbox/doc/kernel/services/threads/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 4,880 |
```restructuredtext
.. _system_threads_v2:
System Threads
##############
.. contents::
:local:
:depth: 2
A :dfn:`system thread` is a thread that the kernel spawns automatically
during system initialization.
The kernel spawns the following system threads:
**Main thread**
This thread performs kernel init... | /content/code_sandbox/doc/kernel/services/threads/system_threads.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 615 |
```restructuredtext
.. _workqueues_v2:
Workqueue Threads
#################
.. contents::
:local:
:depth: 1
A :dfn:`workqueue` is a kernel object that uses a dedicated thread to process
work items in a first in, first out manner. Each work item is processed by
calling the function specified by the work item. ... | /content/code_sandbox/doc/kernel/services/threads/workqueue.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 5,560 |
```restructuredtext
.. _fatal:
Fatal Errors
############
Software Errors Triggered in Source Code
****************************************
Zephyr provides several methods for inducing fatal error conditions through
either build-time checks, conditionally compiled assertions, or deliberately
invoked panic or oops con... | /content/code_sandbox/doc/kernel/services/other/fatal.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,411 |
```restructuredtext
.. _thread_local_storage:
Thread Local Storage (TLS)
##########################
Thread Local Storage (TLS) allows variables to be allocated on a per-thread
basis. These variables are stored in the thread stack which means every
thread has its own copy of these variables.
Zephyr currently requires... | /content/code_sandbox/doc/kernel/services/other/thread_local_storage.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 361 |
```restructuredtext
.. _atomic_v2:
Atomic Services
###############
An :dfn:`atomic variable` is one that can be read and modified
by threads and ISRs in an uninterruptible manner. It is a 32-bit variable on
32-bit machines and a 64-bit variable on 64-bit machines.
.. contents::
:local:
:depth: 2
Concepts
**... | /content/code_sandbox/doc/kernel/services/other/atomic.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 812 |
```restructuredtext
.. _version:
Version
#######
Kernel version handling and APIs related to kernel version being used.
API Reference
**************
.. doxygengroup:: version_apis
``` | /content/code_sandbox/doc/kernel/services/other/version.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 37 |
```restructuredtext
.. _float_v2:
Floating Point Services
#######################
The kernel allows threads to use floating point registers on board
configurations that support these registers.
.. note::
Floating point services are currently available only for boards
based on ARM Cortex-M SoCs supporting the... | /content/code_sandbox/doc/kernel/services/other/float.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,335 |
```restructuredtext
.. _timers_v2:
Timers
######
A :dfn:`timer` is a kernel object that measures the passage of time
using the kernel's system clock. When a timer's specified time limit
is reached it can perform an application-defined action,
or it can simply record the expiration and wait for the application
to read... | /content/code_sandbox/doc/kernel/services/timing/timers.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,829 |
```restructuredtext
.. _kernel_timing:
Kernel Timing
#############
Zephyr provides a robust and scalable timing framework to enable
reporting and tracking of timed events from hardware timing sources of
arbitrary precision.
Time Units
==========
Kernel time is tracked in several units which are used for different
p... | /content/code_sandbox/doc/kernel/services/timing/clocks.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,760 |
```restructuredtext
.. _message_queues_v2:
Message Queues
##############
A :dfn:`message queue` is a kernel object that implements a simple
message queue, allowing threads and ISRs to asynchronously send and receive
fixed-size data items.
.. contents::
:local:
:depth: 2
Concepts
********
Any number of mess... | /content/code_sandbox/doc/kernel/services/data_passing/message_queues.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,496 |
```restructuredtext
.. _stacks_v2:
Stacks
######
A :dfn:`stack` is a kernel object that implements a traditional
last in, first out (LIFO) queue, allowing threads and ISRs
to add and remove a limited number of integer data values.
.. contents::
:local:
:depth: 2
Concepts
********
Any number of stacks can b... | /content/code_sandbox/doc/kernel/services/data_passing/stacks.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 995 |
```restructuredtext
.. _lifos_v2:
LIFOs
#####
A :dfn:`LIFO` is a kernel object that implements a traditional
last in, first out (LIFO) queue, allowing threads and ISRs
to add and remove data items of any size.
.. contents::
:local:
:depth: 2
Concepts
********
Any number of LIFOs can be defined (limited onl... | /content/code_sandbox/doc/kernel/services/data_passing/lifos.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,053 |
```restructuredtext
.. _smp_arch:
Symmetric Multiprocessing
#########################
On multiprocessor architectures, Zephyr supports the use of multiple
physical CPUs running Zephyr application code. This support is
"symmetric" in the sense that no specific CPU is treated specially by
default. Any processor is ca... | /content/code_sandbox/doc/kernel/services/smp/smp.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 4,275 |
```restructuredtext
.. _queues:
Queues
######
A Queue in Zephyr is a kernel object that implements a traditional queue, allowing
threads and ISRs to add and remove data items of any size. The queue is similar
to a FIFO and serves as the underlying implementation for both :ref:`k_fifo
<fifos_v2>` and :ref:`k_lifo <lif... | /content/code_sandbox/doc/kernel/services/data_passing/queues.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 132 |
```restructuredtext
.. _fifos_v2:
FIFOs
#####
A :dfn:`FIFO` is a kernel object that implements a traditional
first in, first out (FIFO) queue, allowing threads and ISRs
to add and remove data items of any size.
.. contents::
:local:
:depth: 2
Concepts
********
Any number of FIFOs can be defined (limited on... | /content/code_sandbox/doc/kernel/services/data_passing/fifos.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,171 |
```restructuredtext
.. _pipes_v2:
Pipes
#####
A :dfn:`pipe` is a kernel object that allows a thread to send a byte stream
to another thread. Pipes can be used to synchronously transfer chunks of data
in whole or in part.
.. contents::
:local:
:depth: 2
Concepts
********
The pipe can be configured with a ri... | /content/code_sandbox/doc/kernel/services/data_passing/pipes.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,568 |
```restructuredtext
.. _mailboxes_v2:
Mailboxes
#########
A :dfn:`mailbox` is a kernel object that provides enhanced message queue
capabilities that go beyond the capabilities of a message queue object.
A mailbox allows threads to send and receive messages of any size
synchronously or asynchronously.
.. contents::
... | /content/code_sandbox/doc/kernel/services/data_passing/mailboxes.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,962 |
```restructuredtext
.. _ring_buffers_v2:
Ring Buffers
############
A :dfn:`ring buffer` is a circular buffer, whose contents are stored in
first-in-first-out order.
For circumstances where an application needs to implement asynchronous
"streaming" copying of data, Zephyr provides a ``struct ring_buf``
abstraction to... | /content/code_sandbox/doc/kernel/data_structures/ring_buffers.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,340 |
```restructuredtext
.. _mpsc_pbuf:
Multi Producer Single Consumer Packet Buffer
============================================
A :dfn:`Multi Producer Single Consumer Packet Buffer (MPSC_PBUF)` is a circular
buffer, whose contents are stored in first-in-first-out order. Variable size
packets are stored in the buffer. Pa... | /content/code_sandbox/doc/kernel/data_structures/mpsc_pbuf.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,107 |
```restructuredtext
.. _data_structures:
Data Structures
###############
Zephyr provides a library of common general purpose data structures
used within the kernel, but useful by application code in general.
These include list and balanced tree structures for storing ordered
data, and a ring buffer for managing "byte... | /content/code_sandbox/doc/kernel/data_structures/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 335 |
```restructuredtext
.. _spsc_lockfree:
Single Producer Single Consumer Lock Free Queue
===============================================
A :dfn:`Single Producer Single Consumer Lock Free Queue (SPSC)` is a lock free
atomic ring buffer based queue.
API Reference
*************
.. doxygengroup:: spsc_lockfree
``` | /content/code_sandbox/doc/kernel/data_structures/spsc_lockfree.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 63 |
```restructuredtext
.. _mpsc_lockfree:
Multi Producer Single Consumer Lock Free Queue
==============================================
A :dfn:`Multi Producer Single Consumer Lock Free Queue (MPSC)` is an lockfree
intrusive queue based on atomic pointer swaps as described by Dmitry Vyukov
at `1024cores <path_to_url`_.
... | /content/code_sandbox/doc/kernel/data_structures/mpsc_lockfree.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 85 |
```restructuredtext
.. _dlist_api:
Double-linked List
==================
Similar to the single-linked list in many respects, Zephyr includes a
double-linked implementation. This provides the same algorithmic
behavior for all the existing slist operations, but also allows for
constant-time removal and insertion (at a... | /content/code_sandbox/doc/kernel/data_structures/dlist.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,033 |
```restructuredtext
.. _spsc_pbuf:
Single Producer Single Consumer Packet Buffer
=============================================
A :dfn:`Single Producer Single Consumer Packet Buffer (SPSC_PBUF)` is a circular
buffer, whose contents are stored in first-in-first-out order. Variable size
packets are stored in the buffer.... | /content/code_sandbox/doc/kernel/data_structures/spsc_pbuf.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 154 |
```restructuredtext
.. _slist_api:
Single-linked List
==================
Zephyr provides a :c:type:`sys_slist_t` type for storing simple
singly-linked list data (i.e. data where each list element stores a
pointer to the next element, but not the previous one). This supports
constant-time access to the first (head) a... | /content/code_sandbox/doc/kernel/data_structures/slist.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,325 |
```restructuredtext
.. _rbtree_api:
Balanced Red/Black Tree
=======================
For circumstances where sorted containers may become large at runtime,
a list becomes problematic due to algorithmic costs of searching it.
For these situations, Zephyr provides a balanced tree implementation
which has runtimes on sea... | /content/code_sandbox/doc/kernel/data_structures/rbtree.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,430 |
```restructuredtext
.. _sys_mem_blocks:
Memory Blocks Allocator
#######################
The Memory Blocks Allocator allows memory blocks to be dynamically
allocated from a designated memory region, where:
* All memory blocks have a single fixed size.
* Multiple blocks can be allocated or freed at the same time.
* ... | /content/code_sandbox/doc/kernel/memory_management/sys_mem_blocks.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,412 |
```restructuredtext
.. _memory_management_api:
Memory Management
#################
The following contains various topics regarding memory management.
.. toctree::
:maxdepth: 1
heap.rst
shared_multi_heap.rst
slabs.rst
sys_mem_blocks.rst
demand_paging.rst
virtual_memory.rst
``` | /content/code_sandbox/doc/kernel/memory_management/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 72 |
```restructuredtext
.. _heap_v2:
Memory Heaps
############
Zephyr provides a collection of utilities that allow threads to
dynamically allocate memory.
Synchronized Heap Allocator
***************************
Creating a Heap
===============
The simplest way to define a heap is statically, with the
:c:macro:`K_HEAP_... | /content/code_sandbox/doc/kernel/memory_management/heap.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,095 |
```restructuredtext
.. _memory_management_shared_multi_heap:
Shared Multi Heap
#################
The shared multi-heap memory pool manager uses the multi-heap allocator to
manage a set of reserved memory regions with different capabilities /
attributes (cacheable, non-cacheable, etc...).
All the different regions ca... | /content/code_sandbox/doc/kernel/memory_management/shared_multi_heap.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 697 |
```restructuredtext
.. _memory_slabs_v2:
Memory Slabs
############
A :dfn:`memory slab` is a kernel object that allows memory blocks
to be dynamically allocated from a designated memory region.
All memory blocks in a memory slab have a single fixed size,
allowing them to be allocated and released efficiently
and avoi... | /content/code_sandbox/doc/kernel/memory_management/slabs.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,108 |
```restructuredtext
.. _memory_management_api_demand_paging:
Demand Paging
#############
Demand paging provides a mechanism where data is only brought into physical
memory as required by current execution context. The physical memory is
conceptually divided in page-sized page frames as regions to hold data.
* When t... | /content/code_sandbox/doc/kernel/memory_management/demand_paging.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,988 |
```restructuredtext
.. _memory_management_api_virtual_memory:
Virtual Memory
##############
Virtual memory (VM) in Zephyr provides developers with the ability to fine tune
access to memory. To utilize virtual memory, the platform must support
Memory Management Unit (MMU) and it must be enabled in the build. Due to
th... | /content/code_sandbox/doc/kernel/memory_management/virtual_memory.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,656 |
```restructuredtext
.. _iterable_sections_api:
Iterable Sections
#################
This page contains the reference documentation for the iterable sections APIs,
which can be used for defining iterable areas of equally-sized data structures,
that can be iterated on using :c:macro:`STRUCT_SECTION_FOREACH`.
Usage
****... | /content/code_sandbox/doc/kernel/iterable_sections/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 471 |
```restructuredtext
.. _timing_functions:
Executing Time Functions
########################
The timing functions can be used to obtain execution time of
a section of code to aid in analysis and optimization.
Please note that the timing functions may use a different timer
than the default kernel timer, where the time... | /content/code_sandbox/doc/kernel/timing_functions/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 477 |
```restructuredtext
.. _object_cores_api:
Object Cores
############
Object cores are a kernel debugging tool that can be used to both identify and
perform operations on registered objects.
.. contents::
:local:
:depth: 2
Object Core Concepts
********************
Each instance of an object embeds an object ... | /content/code_sandbox/doc/kernel/object_cores/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,766 |
```restructuredtext
.. _util_api:
Utilities
#########
This page contains reference documentation for ``<sys/util.h>``, which provides
miscellaneous utility functions and macros.
.. doxygengroup:: sys-util
``` | /content/code_sandbox/doc/kernel/util/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 43 |
```restructuredtext
.. _device_model_api:
Device Driver Model
###################
Introduction
************
The Zephyr kernel supports a variety of device drivers. Whether a
driver is available depends on the board and the driver.
The Zephyr device model provides a consistent device model for configuring the
drivers... | /content/code_sandbox/doc/kernel/drivers/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 4,521 |
```restructuredtext
.. _usermode_overview:
Overview
########
Threat Model
************
User mode threads are considered to be untrusted by Zephyr and are therefore
isolated from other user mode threads and from the kernel. A flawed or
malicious user mode thread cannot leak or modify the private data/resources
of ano... | /content/code_sandbox/doc/kernel/usermode/overview.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,705 |
```restructuredtext
.. _usermode_api:
User Mode
#########
Zephyr offers the capability to run threads at a reduced privilege level
which we call user mode. The current implementation is designed for devices
with MPU hardware.
For details on creating threads that run in user mode, please see
:ref:`lifecycle_v2`.
.. ... | /content/code_sandbox/doc/kernel/usermode/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 119 |
```restructuredtext
.. _kernelobjects:
Kernel Objects
##############
A kernel object can be one of three classes of data:
* A core kernel object, such as a semaphore, thread, pipe, etc.
* A thread stack, which is an array of :c:struct:`z_thread_stack_element`
and declared with :c:macro:`K_THREAD_STACK_DEFINE()`
* ... | /content/code_sandbox/doc/kernel/usermode/kernelobjects.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,503 |
```restructuredtext
.. _mpu_stack_objects:
MPU Stack Objects
#################
Thread Stack Creation
*********************
Thread stacks are declared statically with :c:macro:`K_THREAD_STACK_DEFINE()`.
For architectures which utilize memory protection unit (MPU) hardware,
stacks are physically contiguous allocation... | /content/code_sandbox/doc/kernel/usermode/mpu_stack_objects.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 582 |
```restructuredtext
.. _memory_domain:
Memory Protection Design
########################
Zephyr's memory protection design is geared towards microcontrollers with MPU
(Memory Protection Unit) hardware. We do support some architectures, such as x86,
which have a paged MMU (Memory Management Unit), but in that case the... | /content/code_sandbox/doc/kernel/usermode/memory_domain.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 4,152 |
```restructuredtext
.. _mpu_userspace:
MPU Backed Userspace
####################
The MPU backed userspace implementation requires the creation of a secondary
set of stacks. These stacks exist in a 1:1 relationship with each thread stack
defined in the system. The privileged stacks are created as a part of the
build... | /content/code_sandbox/doc/kernel/usermode/mpu_userspace.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 263 |
```restructuredtext
.. _cmake_pkg:
Zephyr CMake Package
####################
The Zephyr `CMake package`_ is a convenient way to create a Zephyr-based application.
.. note::
The :ref:`zephyr-app-types` section introduces the application types
used in this page.
The Zephyr CMake package ensures that CMake can a... | /content/code_sandbox/doc/build/zephyr_cmake_package.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,966 |
```restructuredtext
.. _build_overview:
Build and Configuration Systems
###############################
.. toctree::
:maxdepth: 1
cmake/index.rst
dts/index
kconfig/index.rst
snippets/index.rst
zephyr_cmake_package.rst
sysbuild/index.rst
version/index.rst
flashing/index.rst
``` | /content/code_sandbox/doc/build/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 81 |
```restructuredtext
.. _syscalls:
System Calls
############
User threads run with a reduced set of privileges than supervisor threads:
certain CPU instructions may not be used, and they have access to only a
limited part of the memory map. System calls (may) allow user threads to
perform operations not directly availa... | /content/code_sandbox/doc/kernel/usermode/syscalls.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 6,281 |
```restructuredtext
.. _dt_vs_kconfig:
Devicetree versus Kconfig
#########################
Along with devicetree, Zephyr also uses the Kconfig language to configure the
source code. Whether to use devicetree or Kconfig for a particular purpose can
sometimes be confusing. This section should help you decide which one ... | /content/code_sandbox/doc/build/dts/dt-vs-kconfig.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 748 |
```restructuredtext
.. _devicetree-intro:
Introduction to devicetree
##########################
.. tip::
This is a conceptual overview of devicetree and how Zephyr uses it. For
step-by-step guides and examples, see :ref:`dt-howtos`.
The following pages introduce general devicetree concepts and how they apply ... | /content/code_sandbox/doc/build/dts/intro.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 115 |
```restructuredtext
.. _dt-howtos:
Devicetree HOWTOs
#################
This page has step-by-step advice for getting things done with devicetree.
.. tip:: See :ref:`dt-trouble` for troubleshooting advice.
.. _get-devicetree-outputs:
Get your devicetree and generated header
****************************************
... | /content/code_sandbox/doc/build/dts/howtos.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 5,577 |
```restructuredtext
.. _dt-trouble:
Troubleshooting devicetree
##########################
Here are some tips for fixing misbehaving devicetree related code.
See :ref:`dt-howtos` for other "HOWTO" style information.
.. _dt-trouble-try-pristine:
Try again with a pristine build directory
*****************************... | /content/code_sandbox/doc/build/dts/troubleshooting.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,215 |
```unknown
/*
*
*
* This is used multiple times in the documentation.
* If you change it for one example, you could break others, so be careful.
*/
/* start-after-here */
/dts-v1/;
/ {
aliases {
sensor-controller = &i2c1;
};
soc {
i2c1: i2c@40002000 {
compatible = "vnd,soc-i2c";
label = "I2C_1";
... | /content/code_sandbox/doc/build/dts/main-example.dts | unknown | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 140 |
```restructuredtext
.. _dt-from-c:
Devicetree access from C/C++
############################
This guide describes Zephyr's ``<zephyr/devicetree.h>`` API for reading the
devicetree from C source files. It assumes you're familiar with the concepts in
:ref:`devicetree-intro` and :ref:`dt-bindings`. See :ref:`dt-referenc... | /content/code_sandbox/doc/build/dts/api-usage.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,598 |
```restructuredtext
.. _dt-writing-bindings:
Rules for upstream bindings
###########################
This section includes general rules for writing bindings that you want to
submit to the upstream Zephyr Project. (You don't need to follow these rules
for bindings you don't intend to contribute to the Zephyr Project,... | /content/code_sandbox/doc/build/dts/bindings-upstream.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,958 |
```restructuredtext
.. _devicetree:
Devicetree
##########
A *devicetree* is a hierarchical data structure primarily used to describe
hardware. Zephyr uses devicetree in two main ways:
- to describe hardware to the :ref:`device_model_api`
- to provide that hardware's initial configuration
This page links to a high l... | /content/code_sandbox/doc/build/dts/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 293 |
```restructuredtext
.. _dt-design:
Design goals
############
Zephyr's use of devicetree has evolved significantly over time, and further
changes are expected. The following are the general design goals, along with
specific examples about how they impact Zephyr's source code, and areas where
more work remains to be do... | /content/code_sandbox/doc/build/dts/design.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 762 |
```restructuredtext
.. _dt-bindings-file-syntax:
Devicetree bindings syntax
##########################
This page documents the syntax of Zephyr's bindings format. Zephyr bindings
files are YAML files. A :ref:`simple example <dt-bindings-simple-example>` was
given in the introduction page.
.. contents:: Contents
:... | /content/code_sandbox/doc/build/dts/bindings-syntax.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 5,671 |
```restructuredtext
.. _dt-binding-compat:
Introduction to Devicetree Bindings
###################################
.. note::
For a detailed syntax reference, see :ref:`dt-bindings-file-syntax`.
Devicetree nodes are matched to bindings using their :ref:`compatible
properties <dt-important-props>`.
During the :re... | /content/code_sandbox/doc/build/dts/bindings-intro.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,079 |
```restructuredtext
.. _dt-inferred-bindings:
.. _dt-zephyr-user:
The ``/zephyr,user`` node
#########################
Zephyr's devicetree scripts handle the ``/zephyr,user`` node as a special case:
you can put essentially arbitrary properties inside it and retrieve their
values without having to write a binding. It i... | /content/code_sandbox/doc/build/dts/zephyr-user-node.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 984 |
```restructuredtext
.. _dt-bindings:
Devicetree bindings
###################
A devicetree on its own is only half the story for describing hardware, as it
is a relatively unstructured format. *Devicetree bindings* provide the other
half.
A devicetree binding declares requirements on the contents of nodes, and
provid... | /content/code_sandbox/doc/build/dts/bindings.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 202 |
```restructuredtext
.. _devicetree-scope-purpose:
Scope and purpose
*****************
A *devicetree* is primarily a hierarchical data structure that describes
hardware. The `Devicetree specification`_ defines its source and binary
representations.
.. _Devicetree specification: path_to_url
Zephyr uses devicetree to ... | /content/code_sandbox/doc/build/dts/intro-scope-purpose.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 472 |
```restructuredtext
.. _dt-phandles:
Phandles
########
The devicetree concept of a *phandle* is very similar to pointers in
C. You can use phandles to refer to nodes in devicetree similarly to the way
you can use pointers to refer to structures in C.
.. contents:: Contents
:local:
Getting phandles
**************... | /content/code_sandbox/doc/build/dts/phandles.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,895 |
```restructuredtext
.. _dt-syntax:
Syntax and structure
####################
As the name indicates, a devicetree is a tree. The human-readable text format
for this tree is called DTS (for devicetree source), and is defined in the
`Devicetree specification`_.
.. _Devicetree specification: path_to_url
This page's pur... | /content/code_sandbox/doc/build/dts/intro-syntax-structure.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 4,220 |
```unknown
; An RFC 7405 ABNF grammar for devicetree macros.
;
; This does *not* cover macros pulled out of DT via Kconfig,
; like CONFIG_SRAM_BASE_ADDRESS, etc. It only describes the
; ones that start with DT_ and are directly generated.
; your_sha256_hash----
; dt-macro: the top level nonterminal for a devicetree ma... | /content/code_sandbox/doc/build/dts/macros.bnf | unknown | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 5,311 |
```restructuredtext
.. _devicetree-in-out-files:
Input and output files
######################
This section describes the input and output files shown in the figure in
:ref:`devicetree-scope-purpose` in more detail.
.. figure:: zephyr_dt_inputs_outputs.svg
:figclass: align-center
Devicetree input (green) and ... | /content/code_sandbox/doc/build/dts/intro-input-output.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,438 |
```restructuredtext
.. _flashing-soc-board-config:
Flashing configuration
######################
Zephyr supports setting up configuration for flash runners (invoked from
:ref:`west flash<west-flashing>`) which allows for customising how commands are used when
programming boards. This configuration is used for :ref:`s... | /content/code_sandbox/doc/build/flashing/configuration.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,009 |
```restructuredtext
.. _flashing:
Flashing
########
.. toctree::
:maxdepth: 1
configuration.rst
``` | /content/code_sandbox/doc/build/flashing/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 29 |
```restructuredtext
.. _devicetree_api:
Devicetree API
##############
This is a reference page for the ``<zephyr/devicetree.h>`` API. The API is macro
based. Use of these macros has no impact on scheduling. They can be used from
any calling context and at file scope.
Some of these -- the ones beginning with ``DT_INS... | /content/code_sandbox/doc/build/dts/api/api.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,894 |
```restructuredtext
.. _snippets:
Snippets
########
Snippets are a way to save build system settings in one place, and then use
those settings when you build any Zephyr application. This lets you save common
configuration separately when it applies to multiple different applications.
Some example use cases for snipp... | /content/code_sandbox/doc/build/snippets/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 162 |
```restructuredtext
Snippets Design
###############
This page documents design goals for the snippets feature.
Further information can be found in `Issue #51834`_.
.. _Issue #51834: path_to_url
- **extensible**: for example, it is possible to add board support for an
existing built-in snippet without modifying the... | /content/code_sandbox/doc/build/snippets/design.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 334 |
```restructuredtext
.. _using-snippets:
Using Snippets
##############
.. tip::
See :ref:`built-in-snippets` for a list of snippets that are provided by
Zephyr.
Snippets have names. You use snippets by giving their names to the build
system.
With west build
***************
To use a snippet named ``foo`` when... | /content/code_sandbox/doc/build/snippets/using.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 290 |
```restructuredtext
.. _cmake-details:
Build System (CMake)
********************
CMake is used to build your application together with the Zephyr kernel. A
CMake build is done in two stages. The first stage is called
**configuration**. During configuration, the CMakeLists.txt build scripts are
executed. After config... | /content/code_sandbox/doc/build/cmake/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,406 |
```restructuredtext
Writing Snippets
################
.. contents::
:local:
Basics
******
Snippets are defined using YAML files named :file:`snippet.yml`.
A :file:`snippet.yml` file contains the name of the snippet, along with
additional build system settings, like this:
.. code-block:: yaml
name: snippet-n... | /content/code_sandbox/doc/build/snippets/writing.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,501 |
```restructuredtext
.. _app-version-details:
Application version management
******************************
Zephyr supports an application version management system for applications which is built around the
system that Zephyr uses for its own version system management. This allows applications to define a
version fil... | /content/code_sandbox/doc/build/version/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,562 |
```restructuredtext
.. _kconfig_extensions:
Kconfig extensions
##################
Zephyr uses the `Kconfiglib <path_to_url`__
implementation of `Kconfig
<path_to_url`__,
which includes some Kconfig extensions:
- Default values can be applied to existing symbols without
:ref:`weakening <multiple_symbol_definitions>... | /content/code_sandbox/doc/build/kconfig/extensions.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 950 |
```restructuredtext
.. _sysbuild:
Sysbuild (System build)
#######################
Sysbuild is a higher-level build system that can be used to combine multiple
other build systems together. It is a higher-level layer that combines one
or more Zephyr build systems and optional additional build systems
into a hierarchic... | /content/code_sandbox/doc/build/sysbuild/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 6,469 |
```restructuredtext
.. _kconfig-functions:
Custom Kconfig Preprocessor Functions
#####################################
Kconfiglib supports custom Kconfig preprocessor functions written in Python.
These functions are defined in
:zephyr_file:`scripts/kconfig/kconfigfunctions.py`.
.. note::
The official Kconfig pre... | /content/code_sandbox/doc/build/kconfig/preprocessor-functions.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,428 |
```restructuredtext
.. _kconfig:
Configuration System (Kconfig)
*******************************
The Zephyr kernel and subsystems can be configured at build time to adapt them
for specific application and platform needs. Configuration is handled through
Kconfig, which is the same configuration system used by the Linux... | /content/code_sandbox/doc/build/kconfig/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 284 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.