. | |
►Architecture Interface | Internal kernel APIs with public scope |
Architecture thread APIs | |
Architecture timing APIs | |
Architecture-specific IRQ APIs | |
Architecture-specific SMP APIs | |
Architecture-specific Thread Local Storage APIs | |
Architecture-specific cache functions | |
Architecture-specific core dump APIs | |
Architecture-specific gdbstub APIs | |
Architecture-specific memory-mapping APIs | |
Architecture-specific power management APIs | |
Architecture-specific userspace APIs | |
Miscellaneous architecture APIs | |
►Audio | |
Audio Codec Interface | Abstraction for audio codecs |
Digital Microphone Interface | Abstraction for digital microphones |
►Bluetooth APIs | Bluetooth APIs |
AUDIO | LC3 |
Attribute Protocol (ATT) | Attribute Protocol (ATT) |
Audio Input Control Service (AICS) | Audio Input Control Service (AICS) |
Battery Service (BAS) | Battery Service (BAS) |
►Bluetooth Audio | Bluetooth Audio |
Audio Broadcast APIs | Audio Broadcast APIs |
Audio Client APIs | |
Audio Server APIs | |
Codec config parsing APIs | Audio codec Config APIs |
Bluetooth Controller | Bluetooth Controller |
►Bluetooth mesh | Bluetooth mesh |
Access layer | Access layer |
Configuration Client Model | Configuration Client Model |
Configuration Server Model | Configuration Server Model |
Health Client Model | Health Client Model |
Health Server Model | Health Server Model |
Health faults | List of specification defined Health fault values |
Heartbeat | Heartbeat |
Message | Message |
Provisioning | Provisioning |
Proxy | Proxy |
►Runtime Configuration | Runtime Configuration |
Application Configuration | Application Configuration |
Subnet Configuration | Subnet Configuration |
Bluetooth testing callbacks | Bluetooth testing |
Common Audio Profile (CAP) | Common Audio Profile (CAP) |
Connection management | Connection management |
Coordinated Set Identification Profile (CSIP) | Coordinated Set Identification Profile (CSIP) |
Cryptography | Cryptography |
Data buffers | Data buffers |
Defines and Assigned Numbers | Bluetooth Generic Access Profile defines and Assigned Numbers |
Device Address | Bluetooth device address definitions and utilities |
Generic Access Profile | Generic Access Profile |
►Generic Attribute Profile (GATT) | Generic Attribute Profile (GATT) |
GATT Client APIs | |
GATT Server APIs | |
HCI RAW channel | HCI RAW channel |
HCI drivers | HCI drivers |
Hands Free Profile (HFP) | Hands Free Profile (HFP) |
Hearing Access Service (HAS) | Hearing Access Service (HAS) |
Heart Rate Service (HRS) | Heart Rate Service (HRS) |
ISO | ISO |
Immediate Alert Service (IAS) | Immediate Alert Service (IAS) |
L2CAP | L2CAP |
Media Control Client (MCC) | Bluetooth Media Control Client (MCC) interface |
Media Control Service (MCS) | Media Control Service (MCS) |
Media Proxy | Media proxy module |
Microphone Input Control Profile (MICP) | Microphone Input Control Profile (MICP) |
Object Transfer Service (OTS) | Object Transfer Service (OTS) |
RFCOMM | RFCOMM |
Service Discovery Protocol (SDP) | Service Discovery Protocol (SDP) |
UUIDs | UUIDs |
Volume Control Profile (VCP) | Volume Control Profile (VCP) |
Volume Offset Control Service (VOCS) | Volume Offset Control Service (VOCS) |
CAN ISO-TP Interface | CAN ISO-TP Interface |
CPU Power Management | |
Cache Interface | |
►Checksum | |
CRC | |
Coredump APIs | Coredump APIs |
►Crypto | Crypto APIs |
Cipher | Crypto Cipher APIs |
Hash | Crypto Hash APIs |
Random Function APIs | Random Function APIs |
►DSP Interface | DSP Interface |
►Basic Math Functions | |
Vector Absolute Value | |
Vector Addition | |
Vector Clipping | |
Vector Dot Product | |
Vector Multiplication | |
Vector Negate | |
Vector Offset | |
Vector Scale | |
Vector Shift | |
Vector Subtraction | |
Vector bitwise AND | |
Vector bitwise NOT | |
Vector bitwise OR | |
Vector bitwise XOR | |
►Data Structure APIs | Data Structure APIs |
Balanced Red/Black Tree | |
Doubly-linked list | |
Flagged Single-linked list | |
Ring Buffer APIs | |
Single-linked list | |
►Device Driver APIs | Device Driver APIs |
►1-Wire Interface | 1-Wire Interface |
1-Wire Sensor API | 1-Wire Sensor API |
1-Wire data link layer | 1-Wire data link layer |
1-Wire network layer | 1-Wire network layer |
►ADC driver APIs | ADC driver APIs |
Emulated ADC | Emulated ADC backend API |
CAN Interface | CAN Interface |
CAN Transceiver | CAN Transceiver Driver APIs |
►Clock Control Interface | Clock Control Interface |
LiteX Clock Control driver interface | LiteX Clock Control driver interface |
Coredump pseudo-device driver APIs | Coredump pseudo-device driver APIs |
►Counter Interface | Counter Interface |
Alarm configuration flags | Used in alarm configuration structure (counter_alarm_cfg) |
Counter device capabilities | |
Counter guard period flags | Used by counter_set_guard_period and counter_get_guard_period |
Flags used by @ref counter_top_cfg. | |
DAC driver APIs | DAC driver APIs |
DAI Interface | DAI Interface |
DMA Interface | DMA Interface |
Disk Driver Interface | Disk Driver Interface |
EC Host Command Interface | EC Host Command Interface |
EDAC API | |
EEPROM Interface | EEPROM Interface |
ESPI Driver APIs | ESPI Driver APIs |
Entropy Interface | Entropy Interface |
External Cache Controller Interface | External Cache Controller Interface |
FLASH Interface | FLASH Interface |
FLASH internal Interface | FLASH internal Interface |
Fuel Gauge Interface | Fuel Gauge Interface |
GNA Interface | |
►GPIO Driver APIs | GPIO Driver APIs |
Emulated GPIO | Emulated GPIO backend API |
nPM6001-specific GPIO Flags | NPM6001-specific GPIO Flags |
nRF-specific GPIO Flags | NRF-specific GPIO Flags |
GPIO KeysDriver APIs | GPIO Keys Driver APIs |
Hardware Info Interface | Hardware Information Interface |
Host Command Peripherals API | Host Command Peripherals API |
I2C EEPROM Target Driver API | I2C EEPROM Target Driver API |
I2C Interface | I2C Interface |
I2S Interface | I2S (Inter-IC Sound) Interface |
►I3C Interface | I3C Interface |
I3C Address-related Helper Code | I3C Address-related Helper Code |
I3C Common Command Codes | I3C Common Command Codes |
I3C Devicetree related bits | I3C Devicetree related bits |
I3C In-Band Interrupts | I3C In-Band Interrupts |
Target Device API | I3C Target Device API |
IPM Interface | IPM Interface |
Keyboard Scan Driver APIs | KSCAN APIs |
LED Interface | LED Interface |
LED Strip Interface | LED Strip Interface |
LoRa APIs | |
MBOX Interface | MBOX Interface |
MDIO Interface | MDIO Interface |
MIPI-DSI driver APIs | MIPI-DSI driver APIs |
MODBUS | MODBUS transport protocol API |
►Miscellaneous Drivers APIs | Miscellaneous Drivers APIs |
►FT8xx driver APIs | FT8xx driver public APIs |
FT8xx co-processor | FT8xx co-processor engine functions |
FT8xx common functions | FT8xx functions to write and read memory |
FT8xx display list | FT8xx display list commands |
FT8xx memory map | FT8xx memory addresses |
FT8xx reference API | FT8xx reference API |
PCI Express Controller Interface | PCI Express Controller Interface |
PECI Interface | PECI Interface 3.0 |
PS/2 Driver APIs | PS/2 Driver APIs |
PWM Interface | PWM Interface |
►Pin Controller Interface | Pin Controller Interface |
Dynamic Pin Control | |
Pinmux Interface | Pinmux Interface |
Real Time Clock interfaces | RTC DS3231 Driver-Specific API |
►Regulator Interface | Regulator Interface |
NPM1100 Devicetree helpers. | |
NPM6001 Devicetree helpers. | |
►Regulator Parent Interface | Regulator Parent Interface |
PCA9420 Utilities. | |
Reset Controller Interface | Reset Controller Interface |
SDHC interface | SDHC interface |
SPI Interface | SPI Interface |
SYSCON Interface | SYSCON Interface |
Sensor Interface | Sensor Interface |
►UART Interface | UART Interface |
Async UART API | |
Interrupt-driven UART API | |
Polling UART API | |
UART Mux Interface | UART Mux Interface |
USB Power Delivery | USB Power Delivery |
USB Type-C | USB Type-C |
USB Type-C Port Controller API | USB Type-C Port Controller API |
USB device controller driver API | New USB device controller (UDC) driver API |
USB host controller driver API | USB host controller (UHC) driver API |
USB-C VBUS API | USB-C VBUS API |
Video Controls | Video controls |
Video Interface | Video Interface |
Watchdog Interface | Watchdog Interface |
►Device Model | Device Model |
►Device memory-mapped IO management | |
Named MMIO region macros | |
Single MMIO region macros | |
Top-level MMIO region macros | |
►Devicetree | Devicetree.h API |
"For-each" macros | |
Bus helpers | |
Chosen nodes | |
Dependency tracking | |
Devicetree CAN API | |
Devicetree Clocks API | |
Devicetree DMA API | |
Devicetree Fixed Partition API | |
Devicetree GPIO API | |
Devicetree IO Channels API | |
Devicetree MBOX API | |
Devicetree PWMs API | |
Devicetree Reset Controller API | |
Devicetree SPI API | |
Existence checks | |
Instance-based devicetree APIs | |
Node identifiers and helpers | |
Pin control | |
Property accessors | |
Vendor and model name helpers | |
interrupts property | |
ranges property | |
reg property | |
►Display Drivers | Display Drivers |
BBC micro:bit display APIs | BBC micro:bit display APIs |
Display Interface | Display Interface |
Grove display APIs | Grove display APIs |
Monochrome Character Framebuffer | Public Monochrome Character Framebuffer API |
►Emulator interface | Emulators used to test drivers and higher-level code that uses them |
I2C Emulation Interface | I2C Emulation Interface |
SPI Emulation Interface | SPI Emulation Interface |
eSPI Emulation Interface | ESPI Emulation Interface |
Error numbers | System error numbers Error codes returned by functions. Includes a list of those defined by IEEE Std 1003.1-2017 |
File System APIs | File System APIs |
►File System Storage | |
►Flash Circular Buffer (FCB) | |
Flash Circular Buffer Data Structures | |
fcb API | Flash Circular Buffer APIs |
fcb non-API prototypes | Flash Circular internal |
►Non-volatile Storage | Non-volatile Storage |
Non-volatile Storage APIs | Non-volatile Storage APIs |
Non-volatile Storage Data Structures | Non-volatile Storage Data Structures |
►Settings | |
Settings backend interface | |
Settings name processing | API for const name processing |
Settings subsystem runtime | API for runtime settings |
Flash image API | Abstraction layer to write firmware images to flash |
►Formatted Output APIs | |
Package flags. | |
Package flags. | |
►Heap Management | Heap Management |
Heap Listener APIs | |
Shared multi-heap interface | Shared Multi-Heap (SMH) interface |
IDs of message. | |
►IPC | IPC |
IPC service APIs | IPC Service API |
IPC service RPMsg API | IPC service RPMsg API |
IPC service backend | IPC service backend |
IPC service static VRINGs API | IPC service static VRINGs API |
RPMsg service APIs | RPMsg service API |
Iterable Sections APIs | Iterable Sections APIs |
►Kernel APIs | Kernel APIs |
Async polling APIs | |
Asynchronous Notification APIs | |
Atomic Services APIs | |
CPU Idling APIs | |
Clock APIs | Clock APIs |
Condition Variables APIs | |
Event APIs | |
FIFO APIs | |
FUTEX APIs | |
►Fatal error APIs | |
Fatal error base types | |
Floating Point APIs | |
Heap APIs | |
Interrupt Service Routine APIs | |
LIFO APIs | |
►MPSC (Multi producer, single consumer) packet buffer API | Multi producer, single consumer packet buffer API |
MPSC (Multi producer, single consumer) packet header | Multi producer, single consumer packet header |
MPSC packet buffer flags | |
MPSC packet buffer flags | Single producer, single consumer packet buffer API |
Mailbox APIs | |
Memory Slab APIs | |
Memory domain APIs | |
Message Queue APIs | |
Mutex APIs | |
On-Off Service APIs | |
Pipe APIs | |
Queue APIs | |
Semaphore APIs | |
Spinlock APIs | Spinlock APIs |
Stack APIs | |
Thread APIs | |
Thread Stack APIs | Thread Stack APIs |
Timer APIs | |
User Mode APIs | |
User mode mutex APIs | |
User mode semaphore APIs | |
Version APIs | |
Work Queue APIs | |
Linear Range | |
LoRaWAN APIs | |
►Logging | Logging |
►Logger system | Logger |
Log link API | Log link API |
Log message API | Log message API |
►Log output API | Log output API |
Log output formatting flags. | |
Logger backend interface | Logger backend interface |
Logger backend standard interface | Logger backend interface for forwarding to standard backend |
Logger control API | Logger control API |
Logging API | Logger API |
MCUboot image control API | MCUboot public API for MCUboot control of image boot process |
►MCUmgr callback API | MCUmgr callback API |
MCUmgr fs_mgmt callback API | MCUmgr fs_mgmt callback API |
MCUmgr img_mgmt callback API | MCUmgr img_mgmt callback API |
MCUmgr handler API | MCUmgr handler registration API |
MCUmgr img_mgmt API | MCUmgr img_mgmt API |
MCUmgr mgmt API | MCUmgr mgmt API |
MCUmgr transport SMP API | MCUmgr transport SMP API |
►Memory Management | Memory Management |
►Demand Paging | |
Backing Store APIs | |
Demand Paging APIs | |
Eviction Algorithm APIs | |
Memory Blocks APIs | |
Memory Management Driver APIs | Memory Management Driver APIs |
►Networking | Networking |
- Distributed Switch Architecture definitions and helpers | DSA definitions and helpers |
Application network context | Application network context |
►BSD Sockets compatible API | BSD Sockets compatible API |
Socket options for TLS | |
COAP Library | COAP library |
DHCPv4 | DHCPv4 |
DNS Resolve Library | DNS resolving library |
DNS Service Discovery | DNS Service Discovery |
Dummy L2/driver Support Functions | Dummy L2/driver support functions |
Ethernet Bridging API | Ethernet Bridging API |
Ethernet Library | Ethernet library |
Ethernet PHY Interface | Ethernet PHY Interface |
►Ethernet Support Functions | Ethernet support functions |
Ethernet MII Support Functions | Ethernet MII (media independent interface) functions |
HTTP client API | HTTP client API |
HTTP request methods | HTTP request methods |
HTTP response status codes | HTTP response status codes |
IEEE 802.15.4 Library | IEEE 802.15.4 library |
IEEE 802.15.4 Net Management Library | IEEE 802.15.4 net management library |
IGMP API | IGMP (Internet Group Management Protocol) |
IPv4/IPv6 primitives and helpers | IPv4/IPv6 primitives and helpers |
Link Layer Discovery Protocol definitions and helpers | LLDP definitions and helpers |
LwM2M high-level API | LwM2M high-level API |
MQTT Client library | MQTT Client Implementation |
MQTT Client library | MQTT-SN Client Implementation |
Network Buffer Library | Network buffer library |
Network Configuration Library | Network configuration library |
Network Core Library | Socket NET_MGMT library |
Network Core Library | Network core library |
Network Core Library | SocketCAN library |
Network Hostname Library | Network hostname configuration library |
Network Interface abstraction layer | Network Interface abstraction layer |
Network L2 Abstraction Layer | Network Layer 2 abstraction layer |
Network Link Address Library | Network link address library |
Network Management | Network Management |
Network Offloading Interface | Network offloading interface |
►Network Packet Filter API | Network Packet Filter API |
Basic Filter Conditions | |
Ethernet Filter Conditions | |
Network Packet Library | Network packet management library |
Network Statistics Library | Network statistics library |
Network long timeout primitives and helpers | Network long timeout primitives and helpers |
Network packet capture | Network packet capture support functions |
PPP L2/driver Support Functions | Point-to-point (PPP) L2/driver support functions |
PTP time | Precision Time Protocol time specification |
Promiscuous mode | Promiscuous mode support |
SNTP | Simple Network Time Protocol API |
TLS credentials management | TLS credentials management |
Trickle Algorithm Library | Trickle algorithm library |
Virtual Interface Library | Virtual interface library |
Virtual LAN definitions and helpers | VLAN definitions and helpers |
Virtual Network Interface Support Functions | Virtual network interface support functions |
Websocket API | Websocket API |
Zperf API | |
gPTP support | Generic Precision Time Protocol (gPTP) support |
l2 layer | OpenThread l2 stack api |
►RTIO | RTIO |
►RTIO API | RTIO API |
RTIO Priorities | RTIO Predefined Priorties |
RTIO SQE Flags | RTIO SQE Flags |
RTIO SPSC API | RTIO Single Producer Single Consumer (SPSC) Queue API |
RTIO Simple Executor | RTIO Simple Executor |
RTIO concurrent Executor | RTIO Concurrent Executor |
S2RAM APIs | |
Semihosting APIs | |
Shell API | Shell API |
►Storage APIs | Storage APIs |
Disk Access Interface | Disk Access APIs |
Stream to flash interface | Abstraction over stream writes to flash |
flash area Interface | Abstraction over flash partitions/areas and their drivers |
►Structured Data | Structured Data |
JSON | |
JSON Web Token (JWT) | JSON Web Token (JWT) |
►Subsystems | Zephyr Subsystems |
►Power Management (PM) | System and device power management |
Device | Device Power Management API |
Device Runtime | Device Runtime Power Management API |
States | System Power Management States |
►System | System Power Management API |
Hooks | System Power Management Hooks |
Policy | System Power Management Policy API |
►Tracing | Tracing |
Object tracking | Object tracking |
►Tracing APIs | Tracing APIs |
Conditional Variable Tracing APIs | Conditional Variable Tracing APIs |
Event Tracing APIs | Event Tracing APIs |
FIFO Tracing APIs | FIFO Tracing APIs |
Heap Tracing APIs | Heap Tracing APIs |
LIFO Tracing APIs | LIFO Tracing APIs |
Mailbox Tracing APIs | Mailbox Tracing APIs |
Memory Slab Tracing APIs | Memory Slab Tracing APIs |
Message Queue Tracing APIs | Message Queue Tracing APIs |
Mutex Tracing APIs | Mutex Tracing APIs |
PM Device Runtime Tracing APIs | PM Device Runtime Tracing APIs |
Pipe Tracing APIs | Pipe Tracing APIs |
Poll Tracing APIs | Poll Tracing APIs |
Queue Tracing APIs | Queue Tracing APIs |
Semaphore Tracing APIs | Semaphore Tracing APIs |
Stack Tracing APIs | Stack Tracing APIs |
Syscall Tracing APIs | Syscall Tracing APIs |
System PM Tracing APIs | System PM Tracing APIs |
Thread Tracing APIs | Thread Tracing APIs |
Timer Tracing APIs | Timer Tracing APIs |
Work Delayable Tracing APIs | Work Delayable Tracing APIs |
Work Poll Tracing APIs | Work Poll Tracing APIs |
Work Queue Tracing APIs | Work Queue Tracing APIs |
Work Tracing APIs | Work Tracing APIs |
Tracing format APIs | Tracing format APIs |
Tracing utility macros | Tracing utility macros |
System Initialization | |
Task Watchdog APIs | Task Watchdog APIs |
Thread analyzer | Module for analyzing threads |
►Time Utility APIs | |
Time Representation APIs | |
Time Synchronization APIs | |
Timing APIs | Timing Measurement APIs |
►USB HID class API | Usb_hid.h API |
HID class USB specific definitions | |
►USB HID common definitions | Hid.h API |
Mouse and keyboard report descriptors | |
USB HID Item helpers | |
USB HID types and values | |
USB device core API | New USB device stack core API |
UpdateHub Firmware Over-the-Air | UpdateHub Firmware Over-the-Air for Zephyr Project |
Utility Functions | |
Zbus APIs | Zbus API |
►Zephyr Tests | Zephyr Tests (ZTest) |
Common Tests | |
Device | Test cases to verify device objects |
FIFOs | Tests for the FIFO kernel object |
Futex | Tests for Kernel Futex objects |
Heap Memory Tests | Heap tests |
Init | Test delay during boot |
LIFOs | LIFOs |
MP Tests | Tests for multi processing |
Mailbox | Tests for the mailbox kernel object |
Memory Slab Tests | Test memory slab APIs |
Message Queue | |
PIPEs | |
Pending tests | Test pending |
Poll tests | Test cases to verify poll |
Profiling | Tests for kernel profiling |
Queues | Tests for queue |
►SMP Tests | SMP |
SMP Integration Tests | |
SMP Module Tests | |
Scheduling Tests | Test scheduling |
Semaphore | |
Semaphore | |
Sleep Tests | Test sleep and wakeup APIs |
Spinlock Tests | Tests for spinlock |
Stacks | Tests for Kernel stack objects |
Thread Context Tests | Test the thread context |
Threads | Thread Tests |
Tickless | |
Timer | Tests for the Timer kernel object |
Workqueue | Workqueue Tests |
XIP Tests | Test to verify XIP |
Z_POW2_CEIL() tests | Test the Z_POW2_CEIL() macro |
api Tests | K heap api tests |
events | Tests for the events kernel object |
►Zephyr testing suite | |
Ztest assertion macros | |
Ztest assumption macros | |
Ztest mocking support | |
Ztest testing macros | |
Ztest testing macros | |
Ztest ztress macros | |
hawkBit Firmware Over-the-Air | HawkBit Firmware Over-the-Air for Zephyr Project |
ivshmem reference API | Ivshmem reference API |