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
.. _mcumgr_smp_group_1:
Application/software image management group
###########################################
Application/software image management group defines following commands:
.. table::
:align: center
+-------------------+-----------------------------------------------+
| ``... | /content/code_sandbox/doc/services/device_mgmt/smp_groups/smp_group_1.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 4,620 |
```restructuredtext
.. _input:
Input
#####
The input subsystem provides an API for dispatching input events from input
devices to the application.
Input Events
************
The subsystem is built around the :c:struct:`input_event` structure. An input
event represents a change in an individual event entity, for exam... | /content/code_sandbox/doc/services/input/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,062 |
```restructuredtext
.. _gpio-kbd:
GPIO Keyboard Matrix
####################
The :dtcompatible:`gpio-kbd-matrix` driver supports a large variety of keyboard
matrix hardware configurations and has numerous options to change its behavior.
This is an overview of some common setups and how they can be supported by the
dri... | /content/code_sandbox/doc/services/input/gpio-kbd.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,212 |
```restructuredtext
.. _smf:
State Machine Framework
#######################
.. highlight:: c
Overview
========
The State Machine Framework (SMF) is an application agnostic framework that
provides an easy way for developers to integrate state machines into their
application. The framework can be added to any projec... | /content/code_sandbox/doc/services/smf/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 4,260 |
```restructuredtext
.. _tracing:
Tracing
#######
Overview
********
The tracing feature provides hooks that permits you to collect data from
your application and allows :ref:`tools` running on a host to visualize the inner-working of
the kernel and various subsystems.
Every system has application-specific events to ... | /content/code_sandbox/doc/services/tracing/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 6,248 |
```restructuredtext
.. _psa_crypto:
PSA Crypto
##########
Overview
********
The PSA (Platform Security Architecture) Crypto API offers a portable
programming interface for cryptographic operations and key storage
across a wide range of hardware. It is designed to be user-friendly
while still providing access to the ... | /content/code_sandbox/doc/services/crypto/psa_crypto.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,425 |
```restructuredtext
.. _cryptography:
Cryptography
############
The crypto section contains information regarding the cryptographic primitives
supported by the Zephyr kernel. Use the information to understand the principles
behind the operation of the different algorithms and how they were implemented.
The following... | /content/code_sandbox/doc/services/crypto/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 91 |
```restructuredtext
.. _rtio:
Real Time I/O (RTIO)
####################
.. contents::
:local:
:depth: 2
.. image:: rings.png
:width: 800
:alt: Submissions and Completion Ring Queues
RTIO provides a framework for doing asynchronous operation chains with event
driven I/O. This section covers the RTIO API, que... | /content/code_sandbox/doc/services/rtio/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,052 |
```restructuredtext
.. _random_api:
Random Number Generation
########################
The random API subsystem provides random number generation APIs in both
cryptographically and non-cryptographically secure instances. Which
random API to use is based on the cryptographic requirements of the
random number. The non-c... | /content/code_sandbox/doc/services/crypto/random/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 706 |
```restructuredtext
.. _crypto_api:
Crypto APIs
###########
Overview
********
API Reference
*************
Generic API for crypto drivers
==============================
.. doxygengroup:: crypto
Ciphers API
===========
.. doxygengroup:: crypto_cipher
``` | /content/code_sandbox/doc/services/crypto/api/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 52 |
```restructuredtext
.. _storage_reference:
Storage
#######
.. toctree::
:maxdepth: 1
nvs/nvs.rst
disk/access.rst
flash_map/flash_map.rst
fcb/fcb.rst
stream/stream_flash.rst
``` | /content/code_sandbox/doc/services/storage/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 61 |
```restructuredtext
.. _fcb_api:
Flash Circular Buffer (FCB)
###########################
Flash circular buffer provides an abstraction through which you can treat
flash like a FIFO. You append entries to the end, and read data from the
beginning.
.. note::
As of Zephyr release 2.1 the :ref:`NVS <nvs_api>` storag... | /content/code_sandbox/doc/services/storage/fcb/fcb.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 656 |
```restructuredtext
.. _mem_mgmt_api:
Memory Attributes
#################
It is possible in the devicetree to mark the memory regions with attributes by
using the ``zephyr,memory-attr`` property. This property and the related memory
region can then be retrieved at run-time by leveraging a provided helper
library.
Th... | /content/code_sandbox/doc/services/mem_mgmt/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,913 |
```restructuredtext
.. _flash_map_api:
Flash map
#########
The ``<zephyr/storage/flash_map.h>`` API allows accessing information about device
flash partitions via :c:struct:`flash_area` structures.
Each :c:struct:`flash_area` describes a flash partition. The API provides access
to a "flash map", which contains prede... | /content/code_sandbox/doc/services/storage/flash_map/flash_map.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,098 |
```unknown
/*
*/
/* start-after-here */
/ {
soc {
flashctrl: flash-controller@deadbeef {
flash0: flash@0 {
compatible = "soc-nv-flash";
reg = <0x0 0x100000>;
partitions {
compatible = "fixed-partitions";
#address-cells = <0x1>;
#size-cells = <0x1>;
boot_partition: partition@0 {
... | /content/code_sandbox/doc/services/storage/flash_map/example_fragment.dts | unknown | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 245 |
```restructuredtext
.. _stream_flash:
Stream Flash
############
The Stream Flash module takes contiguous fragments of a stream of data (e.g.
from radio packets), aggregates them into a user-provided buffer, then when the
buffer fills (or stream ends) writes it to a raw flash partition. It supports
providing the read-... | /content/code_sandbox/doc/services/storage/stream/stream_flash.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 306 |
```restructuredtext
.. _disk_nvme:
NVMe
####
NVMe is a standardized logical device interface on PCIe bus exposing storage devices.
NVMe controllers and disks are supported. Disks can be accessed via the :ref:`Disk Access API <disk_access_api>` they expose
and thus be used through the :ref:`File System API <file_syst... | /content/code_sandbox/doc/services/storage/disk/nvme.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 706 |
```restructuredtext
.. _disk_access_api:
Disk Access
###########
Overview
********
The disk access API provides access to storage devices.
Initializing Disks
******************
Since many disk devices (such as SD cards) are hotpluggable, the disk access
API provides IOCTLs to initialize and de-initialize the disk.... | /content/code_sandbox/doc/services/storage/disk/access.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,074 |
```restructuredtext
.. _nvs_api:
Non-Volatile Storage (NVS)
##########################
Elements, represented as id-data pairs, are stored in flash using a
FIFO-managed circular buffer. The flash area is divided into sectors. Elements
are appended to a sector until storage space in the sector is exhausted. Then a
new ... | /content/code_sandbox/doc/services/storage/nvs/nvs.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,454 |
```restructuredtext
.. _modem:
Modem modules
#############
This service provides modules necessary to communicate with modems.
Modems are self-contained devices that implement the hardware and
software necessary to perform RF (Radio-Frequency) communication,
including GNSS, Cellular, WiFi etc.
The modem modules are... | /content/code_sandbox/doc/services/modem/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 479 |
```restructuredtext
.. _cmsis_rtos_v2:
CMSIS RTOS v2
##########################
Cortex-M Software Interface Standard (CMSIS) RTOS is a vendor-independent
hardware abstraction layer for the ARM Cortex-M processor series and defines
generic tool interfaces. Though it was originally defined for ARM Cortex-M
microcontrol... | /content/code_sandbox/doc/services/portability/cmsis_rtos_v2.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 706 |
```restructuredtext
.. _osal:
OS Abstraction
##############
OS abstraction layers (OSAL) provide wrapper function APIs that
encapsulate common system functions offered by any operating system.
These APIs make it easier and quicker to develop for, and port code to
multiple software and hardware platforms.
These secti... | /content/code_sandbox/doc/services/portability/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 116 |
```restructuredtext
.. _cmsis_rtos_v1:
CMSIS RTOS v1
##########################
Cortex-M Software Interface Standard (CMSIS) RTOS is a vendor-independent
hardware abstraction layer for the ARM Cortex-M processor series and defines
generic tool interfaces. Though it was originally defined for ARM Cortex-M
microcontrol... | /content/code_sandbox/doc/services/portability/cmsis_rtos_v1.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 99 |
```restructuredtext
.. _posix_support:
POSIX
#####
.. toctree::
:maxdepth: 2
overview/index.rst
conformance/index.rst
aep/index.rst
implementation/index.rst
option_groups/index.rst
kconfig/index.rst
``` | /content/code_sandbox/doc/services/portability/posix/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 64 |
```restructuredtext
.. _posix_overview:
Overview
########
The Portable Operating System Interface (POSIX) is a family of standards specified by the
`IEEE Computer Society`_ for maintaining compatibility between operating systems. Zephyr
implements a subset of the standard POSIX API specified by `IEEE 1003.1-2017`_ (a... | /content/code_sandbox/doc/services/portability/posix/overview/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,654 |
```restructuredtext
.. _posix_details:
Implementation Details
######################
In many ways, Zephyr provides support like any POSIX OS; API bindings are provided in the C
programming language, POSIX headers are available in the standard include path, when configured.
Unlike other multi-purpose POSIX operating ... | /content/code_sandbox/doc/services/portability/posix/implementation/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 733 |
```restructuredtext
.. _posix_aep:
POSIX Application Environment Profiles (AEP)
############################################
Although inactive, `IEEE 1003.13-2003`_ defined a number of AEP that inspired the modern
subprofiling options of `IEEE 1003.1-2017`_. The single-purpose realtime system profiles
are listed belo... | /content/code_sandbox/doc/services/portability/posix/aep/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,027 |
```restructuredtext
.. _logging_api:
Logging
#######
.. contents::
:local:
:depth: 2
The logging API provides a common interface to process messages issued by
developers. Messages are passed through a frontend and are then
processed by active backends.
Custom frontend and backends can be used if needed.
Sum... | /content/code_sandbox/doc/services/logging/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 7,922 |
```restructuredtext
.. _posix_conformance:
POSIX Conformance
#################
As per `IEEE 1003.1-2017`, this section details Zephyr's POSIX conformance.
.. _posix_system_interfaces:
POSIX System Interfaces
=======================
.. The following have values greater than -1 in Zephyr, conformant with the POSIX s... | /content/code_sandbox/doc/services/portability/posix/conformance/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,551 |
```restructuredtext
.. _posix_kconfig_options:
Additional Configuration Options
********************************
Below is a non-exhaustive list of additional :ref:`kconfig` options relating to Zephyr's
implementation of the POSIX API.
* :kconfig:option:`CONFIG_DYNAMIC_THREAD`
* :kconfig:option:`CONFIG_DYNAMIC_THREAD... | /content/code_sandbox/doc/services/portability/posix/kconfig/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 497 |
```restructuredtext
.. _zdsp_api:
Digital Signal Processing (DSP)
###############################
.. contents::
:local:
:depth: 2
The DSP API provides an architecture agnostic way for signal processing.
Currently, the API will work on any architecture but will likely not be
optimized. The status of the vario... | /content/code_sandbox/doc/services/dsp/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 483 |
```restructuredtext
.. _task_wdt_api:
Task Watchdog
#############
Overview
********
Many microcontrollers feature a hardware watchdog timer peripheral. Its purpose
is to trigger an action (usually a system reset) in case of severe software
malfunctions. Once initialized, the watchdog timer has to be restarted ("fed"... | /content/code_sandbox/doc/services/task_wdt/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 410 |
```restructuredtext
.. _ipc_service_api:
Interprocessor Communication (IPC)
##################################
.. toctree::
:maxdepth: 1
ipc_service/ipc_service.rst
``` | /content/code_sandbox/doc/services/ipc/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 37 |
```restructuredtext
POSIX Option and Option Group Details
#####################################
.. _posix_option_groups:
POSIX Option Groups
===================
.. _posix_option_group_barriers:
POSIX_BARRIERS
++++++++++++++
Enable this option group with :kconfig:option:`CONFIG_POSIX_BARRIERS`.
.. csv-table:: POSI... | /content/code_sandbox/doc/services/portability/posix/option_groups/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 6,553 |
```restructuredtext
.. _ipc_service:
IPC service
###########
.. contents::
:local:
:depth: 2
The IPC service API provides an interface to exchange data between two domains
or CPUs.
Overview
========
An IPC service communication channel consists of one instance and one or
several endpoints associated with t... | /content/code_sandbox/doc/services/ipc/ipc_service/ipc_service.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,228 |
```restructuredtext
.. _ipc_service_backend_icbmsg:
ICMsg with dynamically allocated buffers backend
################################################
This backend is built on top of the :ref:`ipc_service_backend_icmsg`.
Data transferred over this backend travels in dynamically allocated buffers on shared memory.
The ... | /content/code_sandbox/doc/services/ipc/ipc_service/backends/ipc_service_icbmsg.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 747 |
```restructuredtext
.. _ipc_service_backend_icmsg:
ICMsg backend
#############
The inter core messaging backend (ICMsg) is a lighter alternative to the
heavier RPMsg static vrings backend. It offers a minimal feature set in a small
memory footprint. The ICMsg backend is build on top of :ref:`spsc_pbuf`.
Overview
===... | /content/code_sandbox/doc/services/ipc/ipc_service/backends/ipc_service_icmsg.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 665 |
```restructuredtext
.. _pm-system:
System Power Management
#######################
Introduction
************
The kernel enters the idle state when it has nothing to schedule.
Enabling :kconfig:option:`CONFIG_PM` allows the kernel to call upon the
power management subsystem to put an idle system into one of the suppo... | /content/code_sandbox/doc/services/pm/system.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,268 |
```restructuredtext
Overview
########
The interfaces and APIs provided by the power management subsystem
are designed to be architecture and SOC independent. This enables power
management implementations to be easily adapted to different SOCs and
architectures.
The architecture and SOC independence is achieved by sep... | /content/code_sandbox/doc/services/pm/overview.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 106 |
```restructuredtext
.. _pm-guide:
Power Management
################
Zephyr RTOS power management subsystem provides several means for a system
integrator to implement power management support that can take full
advantage of the power saving features of SOCs.
.. toctree::
:maxdepth: 2
overview
system
dev... | /content/code_sandbox/doc/services/pm/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 85 |
```restructuredtext
.. _pm-device-runtime:
Device Runtime Power Management
###############################
Introduction
************
The device runtime power management (PM) framework is an active power management
mechanism which reduces the overall system power consumption by suspending the
devices which are idle o... | /content/code_sandbox/doc/services/pm/device_runtime.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,021 |
```restructuredtext
.. _pm-power-domain:
Power Domain
############
Introduction
************
The Zephyr power domain abstraction is designed to support groupings of devices
powered by a common source to be notified of power source state changes in a
generic fashion. Application code that is using device A does not n... | /content/code_sandbox/doc/services/pm/power_domain.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,256 |
```restructuredtext
.. _pm_api:
Power Management APIs
#####################
System PM APIs
**************
.. doxygengroup:: subsys_pm_sys
States
======
.. doxygengroup:: subsys_pm_states
Policy
======
.. doxygengroup:: subsys_pm_sys_policy
Hooks
=====
.. doxygengroup:: subsys_pm_sys_hooks
Device PM APIs
*****... | /content/code_sandbox/doc/services/pm/api/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 126 |
```restructuredtext
Test Suites
###########
TF-M includes two sets of test suites:
* tf-m-tests - Standard TF-M specific regression tests
* psa-arch-tests - Test suites for specific PSA APIs (secure storage, etc.)
These test suites can be run from Zephyr via an appropriate sample application
in the samples/tfm_integ... | /content/code_sandbox/doc/services/tfm/testsuites.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 352 |
```restructuredtext
Device Power Management
#######################
Introduction
************
Device power management (PM) on Zephyr is a feature that enables devices to
save energy when they are not being used. This feature can be enabled by
setting :kconfig:option:`CONFIG_PM_DEVICE` to ``y``. When this option is
se... | /content/code_sandbox/doc/services/pm/device.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,612 |
```restructuredtext
.. _tfm_build_system:
TF-M Build System
#################
When building a valid ``_ns`` board target, TF-M will be built in the
background, and linked with the Zephyr non-secure application. No knowledge
of TF-M's build system is required in most cases, and the following will
build a TF-M and Zeph... | /content/code_sandbox/doc/services/tfm/build.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,569 |
```restructuredtext
Trusted Firmware-M Integration
##############################
The Trusted Firmware-M (TF-M) section contains information about the
integration between TF-M and Zephyr RTOS. Use this information to help
understand how to integrate TF-M with Zephyr for Cortex-M platforms and make
use of its secure ru... | /content/code_sandbox/doc/services/tfm/integration.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 892 |
```restructuredtext
TF-M Requirements
#################
The following are some of the boards that can be used with TF-M:
.. list-table::
:header-rows: 1
* - Board
- NSPE board name
* - :ref:`mps2_an521_board`
- ``mps2_an521_ns`` (qemu supported)
* - :ref:`mps3_an547_board`
- ``mps3_an547_n... | /content/code_sandbox/doc/services/tfm/requirements.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 689 |
```restructuredtext
.. _tfm:
Trusted Firmware-M
##################
.. toctree::
:maxdepth: 1
overview.rst
requirements.rst
build.rst
integration.rst
testsuites.rst
``` | /content/code_sandbox/doc/services/tfm/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 53 |
```restructuredtext
Trusted Firmware-M Overview
###########################
`Trusted Firmware-M (TF-M) <path_to_url`__
is a reference implementation of the Platform Security Architecture (PSA)
`IoT Security Framework <path_to_url`__.
It defines and implements an architecture and a set of software components
that aim t... | /content/code_sandbox/doc/services/tfm/overview.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,848 |
```restructuredtext
.. _retention_api:
Retention System
################
The retention system provides an API which allows applications to read and
write data from and to memory areas or devices that retain the data while the
device is powered. This allows for sharing information between different
applications or wit... | /content/code_sandbox/doc/services/retention/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,820 |
```restructuredtext
.. _blinfo_api:
Bootloader Information
######################
The bootloader information (abbreviated to blinfo) subsystem is an extension of
the :ref:`retention_api` which allows for reading shared data from a bootloader
and allowing applications to query it. It has an optional feature of organis... | /content/code_sandbox/doc/services/retention/blinfo.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,109 |
```html
{% extends "!footer.html" %}
{% block contentinfo %}
<p>
{%- if show_copyright %}
{%- endif %}
{%- if last_updated %}
<span class="lastupdated">
Last generated on {{ last_updated }}.
</span>
{%- endif -%}
</p>
{%- set git_last_updated, sha1 = pagename | git_info | default((None, None), true) %}... | /content/code_sandbox/doc/_templates/footer.html | html | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 238 |
```html
{%- extends "!search.html" %}
{%- block scripts %}
{{ super.super() }}
<link rel="stylesheet" href="{{ pathto('_static/css/gcs.css', 1) }}" type="text/css" />
{%- endblock %}
{% block footer %}
{{ super.super() }}
{% endblock %}
{% block body %}
<h2>{{ _('Search Results') }}</h2>
<script async src=... | /content/code_sandbox/doc/_templates/gsearch.html | html | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 124 |
```html
{# remove from this spot#}
``` | /content/code_sandbox/doc/_templates/versions.html | html | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 9 |
```html
{% extends "!breadcrumbs.html" %}
{% block breadcrumbs %}
<!-- {{ docs_title }} -->
{# parameterize default name "Docs" in breadcrumb via docs_title in conf.py #}
{% if not docs_title %}
{% set docs_title = "Docs" %}
{% endif %}
<li><a href="{{ pathto(master_doc) }}">{{ docs_title }}</a> »</l... | /content/code_sandbox/doc/_templates/breadcrumbs.html | html | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 334 |
```html
{% extends "!layout.html" %}
{% block document %}
{% if is_release %}
<div class="wy-alert wy-alert-danger" data-nosnippet>
The <a href="/latest/{{ pagename }}.html">latest development version</a>
of this page may be more current than this released {{ version }} version.
</div>
{% else %... | /content/code_sandbox/doc/_templates/layout.html | html | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 416 |
```html
{#
Override the default searchbox from RTD theme to provide the ability to select a search method
(ex. built-in search, Google Custom Search, ...)
#}
{%- if ('singlehtml' not in builder) %}
<div class="search-container" role="search">
<form id="rtd-search-form" class="wy-form" action="{{ pathto('search') ... | /content/code_sandbox/doc/_templates/searchbox.html | html | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,147 |
```html
{# Add rst-badge after rst-versions for small badge style. #}
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Zephyr Project</span>
v: latest
<span class... | /content/code_sandbox/doc/_templates/zversions.html | html | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 304 |
```restructuredtext
.. _hardware_support:
Hardware Support
################
.. toctree::
:maxdepth: 1
arch/index.rst
barriers/index.rst
cache/index.rst
emulator/index.rst
emulator/bus_emulators.rst
peripherals/index.rst
pinctrl/index.rst
porting/index
``` | /content/code_sandbox/doc/hardware/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 75 |
```restructuredtext
.. _zbus:
Zephyr bus (zbus)
#################
..
Note to documentation authors: the diagrams included in this documentation page were designed
using the following Figma library:
path_to_url
The :dfn:`Zephyr bus - zbus` is a lightweight and flexible software bus enabling a simple way for... | /content/code_sandbox/doc/services/zbus/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 9,005 |
```restructuredtext
.. _rtc_api:
Real-Time Clock (RTC)
#####################
Overview
********
.. list-table:: **Glossary**
:widths: 30 80
:header-rows: 1
* - Word
- Definition
* - Real-time clock
- Low power device tracking time using broken-down time
* - Real-time counter
- L... | /content/code_sandbox/doc/hardware/peripherals/rtc.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,094 |
```restructuredtext
.. _pinctrl-guide:
Pin Control
###########
This is a high-level guide to pin control. See :ref:`pinctrl_api` for API
reference material.
Introduction
************
The hardware blocks that control pin multiplexing and pin configuration
parameters such as pin direction, pull-up/down resistors, etc... | /content/code_sandbox/doc/hardware/pinctrl/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 4,723 |
```restructuredtext
.. _pcie_api:
Peripheral Component Interconnect express Bus (PCIe)
####################################################
Overview
********
API Reference
*************
.. doxygengroup:: pcie_host_interface
``` | /content/code_sandbox/doc/hardware/peripherals/pcie.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 41 |
```restructuredtext
.. _w1_api:
1-Wire Bus
##########
Overview
********
1-Wire is a low speed half-duplex serial bus using only a single wire plus
ground for both data transmission and device power supply.
Similarly to I2C, 1-Wire uses a bidirectional open-collector data line,
and is a single master multidrop bus. T... | /content/code_sandbox/doc/hardware/peripherals/w1.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 719 |
```restructuredtext
.. _tcpc_api:
USB Type-C Port Controller (TCPC)
#################################
Overview
********
`TCPC <tcpc-specification_>`_ (USB Type-C Port Controller)
The TCPC is a device used to simplify the implementation of a USB-C system
by providing the following three function:
* VBUS and VCONN co... | /content/code_sandbox/doc/hardware/peripherals/tcpc.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 387 |
```restructuredtext
.. _espi_api:
Enhanced Serial Peripheral Interface (eSPI) Bus
###############################################
Overview
********
The eSPI (enhanced serial peripheral interface) is a serial bus that is
based on SPI. It also features a four-wire interface (receive, transmit, clock
and target select)... | /content/code_sandbox/doc/hardware/peripherals/espi.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 189 |
```restructuredtext
.. _retained_mem_api:
Retained Memory
###############
Overview
********
The retained memory driver API provides a way of reading from/writing to memory
areas whereby the contents of the memory is retained whilst the device is
powered (data may be lost in low power modes).
Configuration Options
*... | /content/code_sandbox/doc/hardware/peripherals/retained_mem.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 241 |
```restructuredtext
.. _gnss_api:
GNSS (Global Navigation Satellite System)
#########################################
Overview
********
GNSS is a general term which covers satellite systems used for
navigation, like GPS (Global Positioning System). GNSS services
are usually accessed through GNSS modems which receive... | /content/code_sandbox/doc/hardware/peripherals/gnss.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 309 |
```restructuredtext
.. _led_api:
Light-Emitting Diode (LED)
##########################
Overview
********
The LED API provides access to Light Emitting Diodes, both in individual and
strip form.
Configuration Options
*********************
Related configuration options:
* :kconfig:option:`CONFIG_LED`
* :kconfig:opt... | /content/code_sandbox/doc/hardware/peripherals/led.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 106 |
```restructuredtext
.. _adc_api:
Analog-to-Digital Converter (ADC)
#################################
Overview
********
API Reference
*************
.. doxygengroup:: adc_interface
``` | /content/code_sandbox/doc/hardware/peripherals/adc.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 36 |
```restructuredtext
.. _uart_api:
Universal Asynchronous Receiver-Transmitter (UART)
##################################################
Overview
********
Zephyr provides three different ways to access the UART peripheral. Depending
on the method, different API functions are used according to below sections:
1. :ref... | /content/code_sandbox/doc/hardware/peripherals/uart.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 556 |
```restructuredtext
.. _ipm_api:
Inter-Processor Mailbox (IPM)
#############################
Overview
********
API Reference
*************
.. doxygengroup:: ipm_interface
``` | /content/code_sandbox/doc/hardware/peripherals/ipm.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 38 |
```restructuredtext
.. _regulator_api:
Regulators
##########
This subsystem provides control of voltage and current regulators. A common
example is a GPIO that controls a transistor that supplies current to a device
that is not always needed. Another example is a PMIC, typically a much more
complex device.
The ``*-s... | /content/code_sandbox/doc/hardware/peripherals/regulators.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 229 |
```restructuredtext
.. _pwm_api:
Pulse Width Modulation (PWM)
############################
Overview
********
API Reference
*************
.. doxygengroup:: pwm_interface
``` | /content/code_sandbox/doc/hardware/peripherals/pwm.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 36 |
```restructuredtext
.. _usb_bc12_api:
BC1.2 Devices (Experimental)
#######################################
The Battery Charging specification, currently at revision 1.2, is commonly
referred to as just BC1.2. BC1.2 defines limits and detection mechanisms for USB
devices to draw current exceeding the USB 2.0 specifica... | /content/code_sandbox/doc/hardware/peripherals/bc12.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 942 |
```restructuredtext
.. _video_api:
Video
#####
The video driver API offers a generic interface to video devices.
Basic Operation
***************
Video Device
============
A video device is the abstraction of a hardware or software video function,
which can produce, process, consume or transform video data. The vid... | /content/code_sandbox/doc/hardware/peripherals/video.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 312 |
```restructuredtext
.. _i3c_api:
Improved Inter-Integrated Circuit (I3C) Bus
###########################################
I3C (Improved Inter-Integrated Circuit) is a two-signal shared
peripheral interface bus. Devices on the bus can operate in
two roles: as a "controller" that initiates transactions and
controls the... | /content/code_sandbox/doc/hardware/peripherals/i3c.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,152 |
```restructuredtext
.. _i2c_api:
Inter-Integrated Circuit (I2C) Bus
##################################
Overview
********
.. note::
The terminology used in Zephyr I2C APIs follows that of the
`NXP I2C Bus Specification Rev 7.0 <i2c-specification_>`_. These changed
from previous revisions as of its release O... | /content/code_sandbox/doc/hardware/peripherals/i2c.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 491 |
```restructuredtext
.. _counter_api:
Counter
#######
Overview
********
API Reference
*************
.. doxygengroup:: counter_interface
``` | /content/code_sandbox/doc/hardware/peripherals/counter.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 29 |
```restructuredtext
.. _mipi_dsi_api:
MIPI Display Serial Interface (DSI)
###################################
API Reference
*************
.. doxygengroup:: mipi_dsi_interface
``` | /content/code_sandbox/doc/hardware/peripherals/mipi_dsi.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 38 |
```restructuredtext
.. _smbus_api:
System Management Bus (SMBus)
#############################
.. contents::
:local:
:depth: 2
Overview
********
System Management Bus (SMBus) is derived from I2C for communication
with devices on the motherboard. A system may use SMBus to communicate
with the peripherals on... | /content/code_sandbox/doc/hardware/peripherals/smbus.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 466 |
```restructuredtext
.. _usbc_vbus_api:
USB-C VBUS
##########
Overview
********
USB-C VBUS is the line in a USB Type-C connection that delivers power from a
Source to a Sink device.
.. _usbc-vbus-api:
USB-C VBUS API
==============
The USB-C VBUS device driver presents an API that's used to control and measure
VBUS... | /content/code_sandbox/doc/hardware/peripherals/usbc_vbus.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 123 |
```restructuredtext
.. _mipi_dbi_api:
MIPI Display Bus Interface (DBI)
###################################
The MIPI DBI driver class implements support for MIPI DBI compliant display
controllers.
MIPI DBI defines 3 interface types:
* Type A: Motorola 6800 parallel bus
* Type B: Intel 8080 parallel bus
* Type C: S... | /content/code_sandbox/doc/hardware/peripherals/mipi_dbi.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 170 |
```restructuredtext
.. _hwinfo_api:
Hardware Information
####################
Overview
********
The HW Info API provides access to hardware information such as device
identifiers and reset cause flags.
Reset cause flags can be used to determine why the device was reset; for
example due to a watchdog timeout or due ... | /content/code_sandbox/doc/hardware/peripherals/hwinfo.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 136 |
```restructuredtext
.. _api_peripherals:
Peripherals
###########
..
Please keep the ToC tree sorted based on the titles of the pages included
.. toctree::
:maxdepth: 1
w1.rst
adc.rst
auxdisplay.rst
audio/index.rst
bbram.rst
bc12.rst
clock_control.rst
can/index.rst
charger.rst
core... | /content/code_sandbox/doc/hardware/peripherals/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 361 |
```restructuredtext
.. _ps2_api:
PS/2
####
Overview
********
The PS/2 connector first hit the market in 1987 on
IBM's desktop PC line of the same name before
becoming an industry-wide standard for mouse and
keyboard connections. Starting around 2007, USB
superseded PS/2 and is the modern peripheral device
connection... | /content/code_sandbox/doc/hardware/peripherals/ps2.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 140 |
```restructuredtext
.. _fuel_gauge_api:
Fuel Gauge
##########
The fuel gauge subsystem exposes an API to uniformly access battery fuel gauge devices. Currently,
only reading data is supported.
Note: This API is currently experimental and this doc will be significantly changed as new features
are added to the API.
B... | /content/code_sandbox/doc/hardware/peripherals/fuel_gauge.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 331 |
```restructuredtext
.. _flash_api:
Flash
#####
Overview
********
**Flash offset concept**
Offsets used by the user API are expressed in relation to
the flash memory beginning address. This rule shall be applied to
all flash controller regular memory that layout is accessible via
API for retrieving the layout of pag... | /content/code_sandbox/doc/hardware/peripherals/flash.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 147 |
```restructuredtext
.. _kscan_api:
Keyboard Scan
#############
Overview
********
The kscan driver (keyboard scan matrix) is used for detecting a key press in a
connected matrix keyboard or any device with buttons such as joysticks.
Typically, matrix keyboards are implemented using a two-dimensional
configuration in ... | /content/code_sandbox/doc/hardware/peripherals/kscan.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 210 |
```restructuredtext
.. _reset_api:
Reset Controller
################
Overview
********
Reset controllers are units that control the reset signals to multiple
peripherals. The reset controller API allows peripheral drivers to request
control over their reset input signals, including the ability to assert,
deassert an... | /content/code_sandbox/doc/hardware/peripherals/reset.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 137 |
```restructuredtext
.. _watchdog_api:
Watchdog
########
Overview
********
API Reference
*************
.. doxygengroup:: watchdog_interface
``` | /content/code_sandbox/doc/hardware/peripherals/watchdog.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 31 |
```restructuredtext
.. _entropy_api:
Entropy
#######
Overview
********
The entropy API provides functions to retrieve entropy values from
entropy hardware present on the platform. The entropy APIs are provided
for use by the random subsystem and cryptographic services. They are not
suitable to be used as random numb... | /content/code_sandbox/doc/hardware/peripherals/entropy.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 78 |
```restructuredtext
.. _mspi_api:
Multi-bit SPI Bus
#################
The MSPI (multi-bit SPI) is provided as a generic API to accommodate
advanced SPI peripherals and devices that typically require command,
address and data phases, and multiple signal lines during these phases.
While the API supports advanced featur... | /content/code_sandbox/doc/hardware/peripherals/mspi.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,802 |
```restructuredtext
.. _clock_control_api:
Clock Control
#############
Overview
********
The clock control API provides access to clocks in the system, including the
ability to turn them on and off.
Configuration Options
*********************
Related configuration options:
* :kconfig:option:`CONFIG_CLOCK_CONTROL`... | /content/code_sandbox/doc/hardware/peripherals/clock_control.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 75 |
```restructuredtext
.. _peci_api:
Platform Environment Control Interface (PECI)
#############################################
Overview
********
The Platform Environment Control Interface, abbreviated as PECI,
is a thermal management standard introduced in 2006
with the Intel Core 2 Duo Microprocessors.
The PECI inter... | /content/code_sandbox/doc/hardware/peripherals/peci.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 139 |
```restructuredtext
.. _tgpio_api:
Time-aware General-Purpose Input/Output (TGPIO)
###############################################
Overview
********
Configuration Options
*********************
Related configuration options:
* :kconfig:option:`CONFIG_TIMEAWARE_GPIO`
API Reference
*************
.. doxygengroup:: ... | /content/code_sandbox/doc/hardware/peripherals/tgpio.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 64 |
```restructuredtext
.. _auxdisplay_api:
Auxiliary Display (auxdisplay)
##############################
Overview
********
Auxiliary Displays are text-based displays that have simple interfaces for
displaying textual, numeric or alphanumeric data, as opposed to the
:ref:`display_api`, auxiliary displays do not support ... | /content/code_sandbox/doc/hardware/peripherals/auxdisplay.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 169 |
```restructuredtext
.. _gpio_api:
General-Purpose Input/Output (GPIO)
###################################
Overview
********
Configuration Options
*********************
Related configuration options:
* :kconfig:option:`CONFIG_GPIO`
API Reference
*************
.. doxygengroup:: gpio_interface
``` | /content/code_sandbox/doc/hardware/peripherals/gpio.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 55 |
```restructuredtext
.. _charger_api:
Chargers
########
The charger subsystem exposes an API to uniformly access battery charger devices.
A charger device, or charger peripheral, is a device used to take external power provided to the
system as an input and provide power as an output downstream to the battery pack(s)... | /content/code_sandbox/doc/hardware/peripherals/charger.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 335 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.