This is the documentation for the latest (main) development branch of Zephyr. If you are looking for the documentation of previous releases, use the drop-down menu on the left and select the desired version.

API Reference

• API Status and Guidelines
  • API Overview
  • API Lifecycle
  • API Design Guidelines
  • API Terminology
• Audio
  • Audio Codec
  • Audio DMIC
  • I2S
• Asynchronous Notifications
• Bluetooth
  • Connection Management
  • Bluetooth Controller
  • Cryptography
  • Data Buffers
  • Generic Access Profile (GAP)
  • Generic Attribute Profile (GATT)
  • HCI Drivers
  • HCI RAW channel
  • Hands Free Profile (HFP)
  • Logical Link Control and Adaptation Protocol (L2CAP)
  • Bluetooth Mesh Profile
  • Serial Port Emulation (RFCOMM)
  • Service Discovery Protocol (SDP)
  • Universal Unique Identifiers (UUIDs)
• Controller Area Network (CAN)
  • CAN Controller
  • ISO-TP Transport Protocol
• Crypto
• Devicetree
  • Devicetree API
  • Bindings index
• Device Driver Model
• Display Interface
• Error Detection And Correction (EDAC)
• File Systems
• Iterable Sections
• Formatted Output
• Kernel Services
  • Threads
  • Scheduling
  • System Threads
  • Workqueue Threads
  • Zephyr Without Threads
  • Interrupts
  • Polling API
  • Semaphores
  • Mutexes
  • Condition Variables
  • Events
  • Symmetric Multiprocessing
  • Queues
  • FIFOs
  • LIFOs
  • Stacks
  • Message Queues
  • Mailboxes
  • Pipes
  • Memory Heaps
  • Memory Slabs
  • Kernel Timing
  • Timers
  • CPU Idling
  • Atomic Services
  • Floating Point Services
  • C++ Support for Applications
  • Version
  • Fatal Errors
  • Thread Local Storage (TLS)
• C standard library
• Logging
• Memory Management
  • Demand Paging
  • Shared Multi Heap
  • Memory Blocks Allocator
• Miscellaneous
• Data Structures
  • Single-linked List
  • Double-linked List
  • Multi Producer Single Consumer Packet Buffer
  • Balanced Red/Black Tree
  • Ring Buffers
• Modbus
• Networking
  • Network APIs
  • Network Buffer Management
  • Networking Technologies
  • Protocols
  • Network System Management
  • Time Sensitive Networking
  • Generic GSM Modem
• Peripherals
  • ADC
  • Counter
  • Clock Control
  • DAC
  • DMA
  • EC Host Command
  • EEPROM
  • Entropy
  • Flash
  • GNA
  • GPIO
  • Hardware Information
  • I2C EEPROM Slave
  • I2C
  • IPM
  • KSCAN
  • LED
  • MBOX
  • Pinmux
  • PWM
  • PS/2
  • PECI
  • Regulators
  • RTC
  • Sensors
  • SPI
  • UART
  • MDIO
  • Watchdog
  • Video
  • eSPI
• Pin Control
• Power Management
• Random Number Generation
• Resource Management
• Shell
• Storage
  • Non-Volatile Storage (NVS)
  • Disk Access
  • Flash map
  • Flash Circular Buffer (FCB)
  • Stream Flash
• Task Watchdog
• Time Utilities
• USB device support
  • USB device controller driver
  • USB device stack
  • Testing USB device support
  • USB Human Interface Devices (HID) support
  • USB device stack CDC ACM support
• User Mode
  • Overview
  • Memory Protection Design
  • Kernel Objects
  • System Calls
  • MPU Stack Objects
  • MPU Backed Userspace
• Utilities
• Settings
• Executing Time Functions
• Virtualization
  • Inter-VM Shared Memory