API Reference

nRF5 SDK v12.2.0
Here is a list of all modules:
[detail level 1 2 3 4 5 6 ]
o ANT+ profiles
| o Bicycle Power profile This module implements the Bicycle Power profile
| | o Bicycle Power Profile configuration
| | o Bicycle Power profile pages This module implements functions for the BPWR data pages
| | | o Stride Based Speed and Distance Monitor profile common data
| | | o Bicycle Power profile page 1
| | | o Bicycle Power profile page 16
| | | o Bicycle Power profile page 17
| | | o Bicycle Power profile page 18
| | | \ Bicycle Power profile pages 17, 18 (commons)
| | \ Bicycle Power profile utilities This module implements utilities for the Bicycle Power profile
| o Bicycle Speed and Cadence profile This module implements the Bicycle Speed and Cadence profile
| | o Bicycle Speed and Cadence Profile configuration
| | o Bicycle Speed and Cadence profile pages This module implements functions for the BSC data pages
| | | o BSC profile page 0 (combined speed & cadence)
| | | o BSC profile page 0
| | | o BSC profile page 1
| | | o BSC profile page 2
| | | o BSC profile page 3
| | | o BSC profile page 4
| | | \ BSC profile page 5
| | \ Bicycle Speed and Cadence profile utilities This module implements utilities for the Bicycle Speed and Cadence profile
| o ANT+ common pages This module implements functions for the ANT+ common pages
| | o ANT+ common page 70
| | | \ ANT+ common page 70 configuration
| | o ANT+ common page 80
| | | \ ANT+ common page 80 configuration
| | \ ANT+ common page 81
| |   \ ANT+ common page 81 configuration
| o Heart Rate Monitor profile This module implements the Heart Rate Monitor profile
| | o Heart Rate Monitor Profile configuration
| | o Heart Rate Monitor profile pages This module implements functions for the HRM data pages
| | | o HRM profile page 0
| | | o HRM profile page 1
| | | o HRM profile page 2
| | | o HRM profile page 3
| | | \ HRM profile page 4
| | \ Heart Rate Monitor profile utilities This module implements utilities for the Heart Rate Monitor profile
| \ Stride Based Speed and Distance Monitor profile This module implements the Stride Based Speed and Distance Monitor profile
|   o Stride Based Speed and Distance Monitor Profile configuration
|   o Stride Based Speed and Distance Monitor profile pages This module implements functions for the SDM data pages
|   | o Stride Based Speed and Distance Monitor profile common data
|   | o Stride Based Speed and Distance Monitor profile page 1
|   | o Stride Based Speed and Distance Monitor profile page 16
|   | o Stride Based Speed and Distance Monitor profile page 2
|   | o Stride Based Speed and Distance Monitor profile page 22
|   | \ Stride Based Speed and Distance Monitor profile page 3
|   \ Stride Based Speed and Distance Monitor profile utilities This module implements utilities for the Stride Based Speed and Distance Monitor profile
o ANT utilities
| o ANT channel configuration ANT channel configuration module
| | \ ANT common channel configuration configuration
| o ANT encryption configuration Encryption configuration for the ANT stack and channels
| | \ Cryptographic ANT stack configuration configuration
| o ANT encryption negotiation Encryption negotiation for encrypted ANT slave channels
| | \ Encryption negotiation for encrypted ANT slave channels configuration
| o ANT-FS client device simulator The ANT-FS client device simulator
| | o ANT File Share module. configuration
| | \ ANT-FS client device simulator The ANT-FS client device simulator
| o ANT key manager Module for registering common and custom ANT network keys
| | \ Software Component configuration
| o ANT simulators Modules that simulate sensors
| | o ANT BPWR simulator ANT BPWR simulator module
| | o ANT BSC simulator ANT BSC simulator module
| | o ANT HRM simulator ANT HRM simulator module
| | \ ANT SDM simulator ANT SDM simulator module
| o ANT request controller Module for handling page requests related to page 70
| | \ ANT+ request controller configuration
| o ANT search configuration ANT channel search configuration module
| | \ ANT common search configuration configuration
| o ANT stack configuration Configuration of resources used in the ANT stack
| | \ Common ANT stack configuration configuration
| \ ANT channel state indicator ANT channel state indicator module
|   \ ANT state indicator using BSP configuration
o BLE libraries
| o Advertising Module Module for handling connectable BLE advertising
| | \ Advertising module configuration
| o Database Discovery Database discovery module
| | \ Database discovery module configuration
| o Assert handler for debug purposes Module for handling of assert during application development when debugging
| o DTM - Direct Test Mode Module for testing RF/PHY using DTM commands
| | \ Module for testing RF/PHY using DTM commands configuration
| o Direct Test Mode HW Module contains hardware related function for testing RF/PHY using DTM commands
| o Error Log Module Module for writing error and stack to flash memory
| o Record Access Control Point Record Access Control Point library
| | \ Record Access Control Point library configuration
| o Radio Notification Event Handler Module for propagating Radio Notification events to the application
| o Advertising and Scan Response Data Encoder Functions for encoding data in the Advertising and Scan Response Data format, and for passing the data to the stack
| o Connection Parameters Negotiation Module for initiating and executing a connection parameters negotiation procedure
| o Connection state Module for storing data on BLE connections
| | \ BLE connection state functions
| o BLE Date Time characteristic type Definition of ble_date_time_t type
| o GATT module Module for negotiating and keeping track of the maximum ATT_MTU size
| | \ GATT module configuration
| o Queued Writes module Module for handling Queued Write operations
| | \ Queued writes support module (prepare/execute write) configuration
| o Peer Manager Module for managing BLE bonding, which includes controlling encryption and pairing procedures as well as persistently storing different pieces of data that must be stored when bonded
| | o Peer Manager configuration
| | o Peer Manager defined security errors
| | o All versions of Peer IDs. The data ID for each iteration of the data formats in flash
| | \ Privacy modes
| o Flash Manager Module for accessing flash memory
| \ Sensor Data Simulator Functions for simulating sensor data
o BLE serialization nRF52832 only: BLE serialization API
| o Serialization Application Hardware Abstraction Layer (HAL) nRF52832 only: Functions that set up hardware on Application Board and perform the reset of the Connectivity Board
| o Serialization HAL Transport nRF52832 only: HAL Transport layer for serialization
| o Serialization PHY nRF52832 only: PHY layer for serialization
| o HCI Serialization PHY nRF52832 only: HCI PHY layer for serialization
| o Serialization codecs nRF52832 only: Application and Connectivity codecs
| | o Application common codecs
| | | o DTM Application command request encoders and command response decoders DTM Application command request encoders and command response decoders
| | | \ Connectivity chip reset command request encoder Connectivity chip reset command request encoder
| | o Application S132 codecs
| | | o GAP Functions for managing memory for security keys in the application device. GAP Application auxiliary functions for synchronizing the GAP security keys with the ones stored in the connectivity device
| | | o Functions for managing memory for user memory request in the application device. Application auxiliary functions for synchronizing user memory with the one stored in the connectivity device
| | | o Application command request encoders and command response decoders Application command request encoders and command response decoders
| | | o Application event decoders Application event decoders
| | | o GAP Application command request encoders and command response decoders GAP Application command request encoders and command response decoders
| | | o GAP Application event decoders GAP Application event decoders
| | | o GATTC Application command request encoders and command response decoders GATTC Application command request encoders and command response decoders
| | | o GATTC Application event decoders GATTC Application event decoders
| | | o GATTS Application command request encoders and command response decoders GATTS Application command request encoders and command response decoders
| | | o GATTS Application event decoders GATTS Application event decoders
| | | o L2CAP Application command request encoders and command response decoders L2CAP Application command request encoders and command response decoders
| | | o L2CAP Application event decoders L2CAP Application event decoders
| | | \ SOC Application command request encoders and command response decoders SOC Application command request encoders and command response decoders
| | o Connectivity common codecs
| | | \ DTM Connectivity command request decoder and command response encoder DTM Connectivity command request decoder and command response encoder
| | \ Connectivity S132 codecs
| |   o Connectivity command request decoders and command response encoders Connectivity command request decoders and command response encoders
| |   o Connectivity event encoders Connectivity event encoders
| |   o GAP Connectivity command request decoders and command response encoders GAP Connectivity command request decoders and command response encoders
| |   o GAP Connectivity event encoders GAP Connectivity event encoders
| |   o GATTC connectivity command request decoders and command response encoders GATTC Connectivity command request decoders and command response encoders
| |   o GATTC Connectivity event encoders GATTC Connectivity event encoders
| |   o GATTS Connectivity command request decoders and command response encoders GATTS Connectivity command request decoders and command response encoders
| |   o GATTS Connectivity event encoders GATTS Connectivity event encoders
| |   o L2CAP Connectivity command request decoders and command response encoders L2CAP Connectivity command request decoders and command response encoders
| |   o L2CAP Connectivity event encoders L2CAP Connectivity event encoders
| |   o GAP Functions for managing memory for security keys on connectivity device GAP Connectivity auxiliary functions for providing static memory required by the SoftDevice. This memory is used to store GAP security keys
| |   o Functions for managing memory for user memory request on connectivity device. Connectivity auxiliary functions for providing static memory required by the SoftDevice
| |   \ SOC Connectivity command request decoders and command response encoders SOC Connectivity command request decoders and command response encoders
| o Application side code nRF52832 only: SoftDevice handler and transport on the application side
| | o Serialization SoftDevice Transport Serialization SoftDevice Transport on application side
| | \ Serialization SoftDevice Handler Serialization SoftDevice Handler on application side
| \ Connectivity application code nRF52832 only: Encoders, decoders, and event handlers related to the Connectivity Chip
|   o Command decoder in the Connectivity Chip Decoder for serialized commands from the Application Chip
|   o DTM Command Decoder in the Connectivity Chip Decoder for serialized DTM commands from the Application Chip
|   o Events encoder in the Connectivity Chip Events encoder for BLE SoftDevice
|   o Events handlers in the Connectivity Chip Events handlers used to process high level events in the connectivity application
|   \ Packets decoder in the Connectivity Chip Decoder for serialized packets from the Application Chip
o BLE Services
| o Apple Notification Service client Apple Notification Center Service Client Module
| | o Apple Notification Service Client configuration
| | \ Notification Provider (iOS) Error Codes
| o Alert Notification Service Client Alert Notification module
| | \ Alert Notification Service Client configuration
| o Battery Service Battery Service module
| | \ Battery Service configuration
| o Battery Service Client Battery Service Client module
| | o Enumerations
| | o Structures
| | o Types
| | o Functions
| | \ Battery Service Client configuration
| o Blood Pressure Service Blood Pressure Service module
| | \ Blood Pressure Service configuration
| o Cycling Speed and Cadence Service Cycling Speed and Cadence Service module
| | o Cycling Speed and Cadence Service feature bits
| | \ Cycling Speed and Cadence Service configuration
| o Speed and Cadence Control Point Speed and Cadence Control Point module
| | \ Control point functionalities.
| o Current Time Service client Current Time Service client module
| | \ Current Time Service Client configuration
| o Buttonless DFU Service Buttonless DFU Service module
| o Device Information Service Device Information Service module
| | o Vendor ID Source values
| | \ Device Information Service configuration
| o Eddystone Configuration Service Eddystone Configuration Service module
| | \ Eddystone Configuration Service configuration
| o Glucose Service Glucose Service module
| | \ Glucose Service configuration
| o Glucose Database Service Glucose Service module
| o Human Interface Device Service Human Interface Device Service module
| | \ Human Interface Device Service configuration
| o Heart Rate Service Heart Rate Service module
| | \ Heart Rate Service configuration
| o Heart Rate Service Client Heart Rate Service Client module
| | o Enumerations
| | o Structures
| | o Types
| | o Functions
| | \ Heart Rate Service Client configuration
| o Health Thermometer Service Health Thermometer Service module
| | \ Health Thermometer Service configuration
| o Immediate Alert Service Immediate Alert Service module
| | \ Immediate Alert Service configuration
| o Immediate Alert Service Client Immediate Alert Service Client module
| | \ Immediate Alert Service Client configuration
| o LED Button Service Server LED Button Service Server module
| | \ LED Button Service configuration
| o LED Button Service Client The LED Button Service client can be used to set a LED, and read a button state on a LED button service server
| | \ Nordic LED Button Service Client configuration
| o Link Loss Service Link Loss Service module
| | \ Link Loss Service configuration
| o Nordic UART Service Nordic UART Service implementation
| | \ Nordic UART Service configuration
| o Nordic UART Service Client Nordic UART Service Client module
| | \ Nordic UART Central Service configuration
| o Running Speed and Cadence Service Running Speed and Cadence Service module
| | \ Running Speed and Cadence Service configuration
| o Running Speed and Cadence Service Client
| | \ Running Speed and Cadence Client configuration
| o TX Power Service TX Power Service module
| | \ TX Power Service configuration
| o Location and Navigation common defines Location and Navigation common defines
| o Location and Navigation Service Control Point Location and Navigation Service Control Point module
| o Location and Navigation database Location and Navigation route database
| o Location and Navigation Service Location and Navigation Service module
| o Bond Management Service Bond Management Service (BMS) module
| | \ BMS feature bits
| o Continuous Glucose Monitoring Service Continuous Glucose Monitoring Service (CGMS) module
| | o Continuous Glucose Monitoring Service database Continuous Glucose Monitoring Service database module
| | o Continuous Glucose Monitoring Service Measurement Continuous Glucose Monitoring Service Measurement module
| | o Record Access Control Point Continuous Glucose Monitoring Service RACP module
| | o Specific Operations Control Point Continuous Glucose Monitoring Service SOCP module
| | o Session Start Time Continuous Glucose Monitoring Service SST module
| | o Enumerations
| | o Structures
| | o Types
| | \ Functions
| \ Common service definitions Constants, type definitions, and functions that are common to all services
|   o Service UUID definitions
|   o Characteristic UUID definitions
|   \ Definitions for the Alert Level characteristic values
o NFC libraries Near field communication (NFC) library and modules
| o NFC Type 4 Tag Implementation of NFC Type 4 Tag
| | o NFC Type 4 Tag HAL nRF52 Series only: Hardware abstraction layer for the NFC Type 4 Tag library
| | | \ Hardware Abstraction Layer for NFC library. configuration
| | o NFC fixes and workarounds nRF52 Series only: Fixes for hardware-related anomalies
| | o NFC tag 4 type emulation library The T4T emulation library interface
| | \ NFC Type 4 Tag parser Parser for Type 4 Tag data
| |   o APDU reader/writer APDU reader/writer for Type 4 Tag communication
| |   | \ APDU encoder/decoder for Type 4 Tag configuration
| |   o CC file parser Capability Container file parser for Type 4 Tag
| |   | o Capability Container file for Type 4 Tag configuration
| |   | \ File Control TLV block parser for Type 4 Tag. File Control TLV block parser for Type 4 Tag (T4T)
| |   |   \ TLV block for Type 4 Tag configuration
| |   \ High-level NDEF Detection Procedure High-level NDEF Detection Procedure for Type 4 Tag communication
| |     \ NDEF Detection Procedure for Type 4 Tag configuration
| o NDEF message modules Implementation of NDEF messages
| | o Predefined NDEF messages Predefined NDEF messages for standard use
| | | o BLE pairing messages Generation of NFC NDEF messages used for BLE pairing
| | | | o ac (Alternative carrier) records Generation of NFC NDEF Alternative Carrier records for NDEF messages
| | | | o Advertising and Scan Response Data Encoder for NFC OOB pairing Function for encoding data in the Advertising and Scan Response Data format, which can be used to create payload of NFC message intended for initiating the Out-of-Band pairing
| | | | o EP OOB records Generation of NFC NDEF EP OOB records for NDEF messages
| | | | o Hs (Handover Select) records Generation of NFC NDEF Handover Select records for NDEF messages
| | | | \ LE OOB records Generation of NFC NDEF LE OOB records for NDEF messages
| | | o Launch app messages Generation of NFC NDEF messages that can be used to launch apps
| | | | \ Launch app records Generation of NFC NDEF record descriptions that launch apps
| | | o Text records Generation of NFC NDEF Text record descriptions
| | | \ URI messages Generation of NFC NDEF messages with a URI record
| | |   \ URI records Generation of NFC NDEF URI record descriptions
| | o Custom NDEF messages Generation of NFC NDEF messages for the NFC tag
| | | o NFC NDEF Message generator module configuration
| | | \ Custom NDEF records Generation of NFC NDEF records for NFC messages
| | \ NDEF message parser Parser for NFC NDEF messages and records
| |   o Parser for NDEF messages Parser for NFC NDEF messages
| |   | o NFC NDEF message parser module configuration
| |   | \ NDEF message parser (internal) Internal part of the parser for NFC NDEF messages
| |   \ Parser for NDEF records Parser for NFC NDEF records
| |     \ NFC NDEF Record parser module configuration
| \ NFC Type 2 Tag Implementation of NFC Type 2 Tag
|   o NFC Type 2 Tag HAL nRF52 Series only: Hardware abstraction layer for the NFC Type 2 Tag library
|   | \ Hardware Abstraction Layer for NFC library. configuration
|   o NFC fixes and workarounds nRF52 Series only: Fixes for hardware-related anomalies
|   o NFC tag 2 type emulation library The T2T emulation library interface
|   \ NFC Type 2 Tag parser Parser for Type 2 Tag data
|     o Type 2 Tag Descriptor for a Type 2 Tag
|     o Type 2 Tag TLV blocks Descriptor for a Type 2 Tag TLV block
|     \ Parser for decoding Type 2 Tag data configuration
o Peripheral drivers
| o ADC HAL and driver Analog-to-digital converter (ADC) APIs
| | o ADC driver Analog-to-digital converter (ADC) driver
| | | \ Driver for ADC peripheral (nRF51) configuration
| | \ ADC HAL nRF51 Series only: Hardware access layer for managing the analog-to-digital converter (ADC)
| o Clock HAL and driver Clock APIs
| | o Clock driver Driver for managing the low-frequency clock (LFCLK) and the high-frequency clock (HFCLK)
| | | \ CLOCK peripheral driver configuration
| | \ Clock HAL Hardware access layer for managing the low-frequency clock (LFCLK) and the high-frequency clock (HFCLK)
| o Peripheral drivers common module
| | \ Peripheral drivers common module configuration
| o COMP HAL and driver nRF52 Series only: Comparator (COMP) APIs
| | o COMP driver nRF52 Series only: Comparator (COMP) driver
| | | \ COMP peripheral driver configuration
| | \ COMP HAL nRF52 Series only: Hardware access layer for managing the Comparator (COMP)
| o GPIOTE abstraction and driver GPIOTE APIs
| | o GPIOTE driver GPIOTE driver for managing input and output pins
| | | \ GPIOTE peripheral driver configuration
| | \ GPIOTE abstraction GPIOTE abstraction for configuration of channels
| o AES ECB encryption Driver for the AES Electronic Code Book (ECB) peripheral
| o EGU (Event Generator Unit) abstraction nRF52 Series only: EGU (Event Generator Unit) module functions
| o GPIO abstraction GPIO pin abstraction and port abstraction for reading and writing byte-wise to GPIO ports
| o Non-volatile memory controller Driver for the NVMC peripheral
| o TEMP (temperature) abstraction Temperature module init and read functions
| o USBD HAL nRF52840 only: Hardware access layer for Two Wire Interface Slave with EasyDMA (USBD) peripheral
| o I2S HAL and driver nRF52 Series only: Inter-IC Sound (I2S) interface APIs
| | o I2S HAL nRF52 Series only: Hardware access layer for managing the Inter-IC Sound (I2S) peripheral
| | \ I2S driver nRF52 Series only: Inter-IC Sound (I2S) interface driver
| |   \ I2S peripheral driver configuration
| o LPCOMP HAL and driver Low Power Comparator (LPCOMP) APIs
| | o LPCOMP HAL Hardware access layer for managing the Low Power Comparator (LPCOMP)
| | \ LPCOMP driver Low Power Comparator (LPCOMP) driver
| |   \ LPCOMP peripheral driver configuration
| o PDM HAL and driver nRF52 Series only: Pulse density modulation (PDM) interface APIs
| | o PDM HAL nRF52 Series only: Hardware abstraction layer for accessing the pulse density modulation (PDM) peripheral
| | \ PDM driver nRF52 Series only: Pulse density modulation (PDM) interface driver
| |   \ PDM peripheral driver configuration
| o Power HAL and driver POWER peripheral APIs
| | o POWER HAL
| | \ POWER driver Driver for managing events and the state of POWER peripheral
| |   \ POWER peripheral driver configuration
| o PPI HAL and driver Programmable Peripheral Interconnect (PPI) APIs
| | o PPI HAL Hardware access layer for setting up Programmable Peripheral Interconnect (PPI) channels
| | \ PPI driver Programmable Peripheral Interconnect (PPI) driver
| |   \ PPI peripheral driver configuration
| o PWM HAL and driver nRF52 Series only: Pulse Width Modulation (PWM) module APIs
| | o PWM HAL nRF52 Series only: Hardware access layer for managing the Pulse Width Modulation (PWM) peripheral
| | \ PWM driver nRF52 Series only: Pulse Width Modulation (PWM) module driver
| |   \ PWM peripheral driver configuration
| o QDEC HAL and driver Quadrature decoder (QDEC) APIs
| | o QDEC HAL Hardware access layer for accessing the quadrature decoder (QDEC) peripheral
| | \ QDEC driver Quadrature decoder (QDEC) driver
| |   \ QDEC peripheral driver configuration
| o QSPI HAL and driver nRF52840 only: Quad serial peripheral interface (QSPI) APIs
| | o QSPI HAL Hardware access layer for accessing the QSPI peripheral
| | \ QSPI driver nRF52840 only: Quad serial peripheral interface (QSPI) driver
| |   \ QSPI peripheral driver. configuration
| o RNG HAL and driver Random number generator (RNG) APIs
| | o RNG HAL Hardware access layer for managing the random number generator (RNG)
| | \ RNG driver Driver for managing the random number generator (RNG)
| |   \ RNG peripheral driver configuration
| o RTC HAL and driver Real timer counter (RTC) APIs
| | o RTC HAL Hardware access layer for managing the real time counter (RTC)
| | \ RTC driver Real timer counter (RTC) driver
| |   \ RTC peripheral driver configuration
| o SAADC HAL and driver nRF52 Series only: Successive Approximation Analog-to-Digital Converter (SAADC) APIs
| | o SAADC HAL nRF52 Series only: Hardware access layer for accessing the SAADC peripheral
| | \ SAADC driver nRF52 Series only: Successive Approximation Analog-to-Digital Converter (SAADC) driver
| |   \ SAADC peripheral driver configuration
| o SDIO driver 2-wire serial interface driver
| o SWI driver Driver for software interrupts (SWI)
| | \ SWI(EGU) peripheral driver configuration
| o Timer HAL and driver Timer APIs
| | o Timer HAL Hardware access layer for accessing the timer peripheral
| | \ Timer driver Multi-instance timer driver
| |   \ TIMER periperal driver configuration
| o Two Wire master interface (TWI/TWIM) Two Wire master interface (TWI/TWIM) APIs
| | o TWI HAL Hardware access layer for managing the TWI peripheral
| | o TWIM HAL Hardware access layer for managing the TWIM peripheral
| | o Software controlled TWI Master driver Software controlled TWI Master driver (deprecated)
| | \ TWIS driver TWI master APIs
| |   \ TWI/TWIM peripheral driver configuration
| o Two Wire slave interface (TWIS) Two Wire slave interface (TWIS) APIs
| | o TWIS HAL nRF52 Series only: Hardware access layer for Two Wire Interface Slave with EasyDMA (TWIS) peripheral
| | \ TWIS driver TWI slave APIs
| |   \ TWIS peripheral driver configuration
| o UART driver and HAL UART API
| | o UART HAL Hardware access layer for accessing the UART peripheral
| | o UARTE HAL Hardware access layer for accessing the UARTE peripheral
| | \ UART driver UART driver
| |   \ UART/UARTE peripheral driver configuration
| o USB Device raw IP HAL and driver nRF52840 only: USB Device APIs
| | o USB Device raw IP driver nRF52840 only: USB Device raw IP driver
| | \ USB driver configuration
| o WDT HAL and driver Watchdog timer (WDT) APIs
| | o WDT HAL Hardware access layer for accessing the watchdog timer (WDT) peripheral
| | \ WDT driver Driver for managing the watchdog timer (WDT)
| |   \ WDT peripheral driver configuration
| o Serial peripheral interface (SPI/SPIM) Serial peripheral interface (SPI/SPIM) APIs
| | o SPI HAL Hardware access layer for accessing the SPI peripheral
| | o SPIM HAL Hardware access layer for accessing the SPIM peripheral
| | \ SPI master driver Multi-instance SPI master driver
| |   \ SPI/SPIM peripheral driver configuration
| o SPIS HAL and driver SPIS APIs
| | o SPIS HAL Hardware access layer for accessing the SPIS peripheral
| | \ SPI slave driver Multi-instance SPI slave driver
| |   \ SPI Slave driver configuration
| \ SysTick HAL and driver System Timer (SysTick) APIs
|   o SYSTICK HAL Hardware access layer for accessing the SYSTICK peripheral
|   \ SysTick driver
|     \ SysTick driver configuration
o Components drivers
| o ADNS2080 driver ADNS2080 mouse sensor driver
| o Cherry 8x16 keyboard matrix driver Cherry 8x16 keyboard matrix driver
| o DS1624 digital temperature sensor driver DS1624 digital temperature sensor driver
| o MCP4725 digital DAC driver MCP4725 digital DAC driver
| | \ MCP4725 digital DAC driver configuration
| o MPU6050 gyro/accelerometer driver MPU6050 gyro/accelerometer driver
| \ Synaptics Touchpad driver Synaptics Touchpad driver
o SDK common libraries
| o GATT Database Service Structure
| o Atomic FIFO implementation nRF52 Series only: FIFO implementation that allows for making atomic transactions without locking interrupts
| | o Atomic operations API nRF52 Series only: This module implements C11 stdatomic.h simplified API. At this point only Cortex-M3/M4 cores are supported (LDREX/STREX instructions). Atomic types are limited to nrf_atomic_u32_t and nrf_atomic_flag_t
| | | \ Atomic operations internals
| | \ FIFO instance macros
| o Block memory allocator This module handles block memory allocator features
| | o Macros for preparing debug flags for block allocator module.
| | \ Block allocator module configuration
| o Block device This module implements unified block device API. It could used as a middle layer between filesystems and memories
| | o Empty implementation
| | o QSPI implementation
| | o Serial flash memory parameters
| | o RAM implementation This module implements block device API. It should be used as a reference block device
| | \ SDC implementation
| o Bootloader modules Modules for creating a bootloader
| | o DFU BLE Service Device Firmware Update (DFU) transport layer for Bluetooth low energy
| | o DFU bootloader Bootloader with Device Firmware Update (DFU) functionality
| | | o Flash operations
| | | o MBR functions
| | | o Request handling
| | | o DFU settings
| | | o DFU types
| | | \ DFU utilities
| | o DFU transport Generic Device Firmware Update (DFU) transport interface
| | \ Bootloader Basic bootloader
| |   o Application start
| |   \ Information
| o Board Support Package BSP module
| | o BSP: ANT Button Module Module for controlling ANT behavior through button actions
| | o BSP: BLE Button Module Module for controlling BLE behavior through button actions
| | \ NFC BSP Module Module for setting the NFCT peripheral as a wakeup source
| o Button Handler Buttons handling module
| | \ buttons handling module configuration
| o Cryptography library Cryptography library (nrf_crypto)
| | o Cryptographic curves Cryptographic curves that are available to the application. Currently, the nrf_crypto library supports only NIST p-256
| | \ Hashing algorithms Hashing algorithms that are available to the application. Currently, the nrf_crypto library supports only SHA-256
| o Capacitive Sensor Library Module for using the capacitive sensor library with support for many instances of sliders, wheels, and buttons
| | o nrf_csense module configuration
| | \ Capacitive Sensor A set of macros to facilitate creation of a new capacitive sensor instance
| o Capacitive sensor support Module for using a capacitive sensor on low-energy level
| | \ Capacitive sensor module configuration
| o Elliptic Curve Cryptography interface Elliptic Curve Cryptography interface
| | \ Elliptic Curve Cryptography Library configuration
| o Eddystone library Library for Eddystone beacons. This library is used in the Experimental: Eddystone Beacon Application
| | o Frame types and data formats Definitions specific to Eddystone frame types and data formats
| | o Eddystone advertising module Types and functions for handling advertising in Eddystone beacons
| | | o Timing Events and functions for advertisement timing
| | | \ TLM Functions for the Eddystone telemetry (TLM) manager
| | o Flash access Types and functions to access the flash of the Eddystone beacon
| | o GATTS Functions for handling GATTS write and read requests
| | o Security Types and functions for dealing with security of Eddystone beacons
| | o Slots Types and functions for handling Eddystone slots
| | \ Application configuration Configuration settings for the application
| o Section variables Section variables
| o Flash Data Storage Flash Data Storage (FDS)
| | \ Flash data storage module configuration
| o FIFO implementation FIFO implementation
| | \ Software FIFO implementation configuration
| o fstorage Module which provides functionality to store data to flash and erase flash pages
| | \ Flash storage module configuration
| o GPIOTE Handler GPIOTE handler module
| | \ GPIOTE events dispatcher configuration
| o HardFault exception Default HardFault exception implementation
| | \ HardFault default handler for debugging and release configuration
| o Memory pool Memory pool implementation
| | \ memory pool implementation used by HCI configuration
| o SLIP module SLIP layer for supporting packet framing in HCI transport
| | \ SLIP protocol implementation used by HCI configuration
| o HCI Transport HCI transport module implementation
| | o CRC16 compute This module implements CRC-16-CCITT (polynomial 0x1021) with 0xFFFF initial value. The data can be passed in multiple blocks
| | | \ CRC16 calculation routines configuration
| | o CRC32 compute This module implements the CRC-32 calculation in the blocks
| | | \ CRC32 calculation routines configuration
| | \ HCI transport configuration
| o IC information Library for checking IC information (IC revision, RAM size, FLASH size)
| o LED softblink Module for generating a changing pulse-width modulated output signal that is used to smoothly blink LEDs
| | \ led_softblink module configuration
| o Logger module The nrf_log module interface
| | o Backend of nrf_log The nrf_log backend interface
| | | \ Logging sink configuration
| | o Functions for controlling nrf_log The nrf_log control interface
| | \ Logging configuration
| o Low-power PWM Module for generating a low-power pulse-width modulated output signal
| | \ low_power_pwm module configuration
| o Mailbox library Mailbox for safely queuing items
| | \ Thread safe mailbox configuration
| o Memory Manager Memory Manager for the nRF5 SDK
| | \ Dynamic memory allocator configuration
| o Pulse-width modulation (PWM) Module for generating a pulse-width modulated output signal
| | \ PWM functionality configuration
| o Power management This module handles power management features
| | \ Power management module configuration
| o Queue module Functions that handle the queue instances
| | \ Queue module configuration
| o Scheduler The scheduler is used for transferring execution from the interrupt context to the main context
| | \ Events scheduler configuration
| o SD card library Asynchronous Secure Digital card (SDC) and MultiMedia card (MMC) library
| | \ SD/MMC card support using SPI configuration
| o SHA-256 hash library This module calculates SHA-256 (SHA-2, FIPS-180) hashes
| o Simple Timer Simple timer module
| | \ Simple application timer functionality configuration
| o SLIP encoding decoding This module encodes and decodes slip packages (RFC1055)
| | \ SLIP encoding decoding configuration
| o Application Timer Application timer functionality
| | \ Application timer functionality configuration
| o TWI transaction manager Module for scheduling TWI transactions
| | \ TWI transaction manager configuration
| o UART module UART module interface
| | \ UART driver configuration
| o USB Device high level library nRF52840 only: Module for easy support for any USB device configuration
| | o USBD Class Base module nRF52840 only: The base for any class instance is defined in this module
| | o USB Device high level library core module nRF52840 only: Core module that manages current USB state and process device requests
| | o USB standard descriptors nRF52840 only: Module with types definitions used for standard descriptors
| | o USB Device library configuration
| | o USB standard requests nRF52840 only: Module with types definitions used for standard requests processing
| | o USBD string descriptors nRF52840 only: USBD string descriptors management
| | | \ USBD string configuration nRF52840 only: Configuration of the string module that can be easily affected by the final user
| | o USB Device high level library variable types definition nRF52840 only: All types used by USB Device high level library are defined here. This helps to avoid cross referencing into types in different files
| | o USB AUDIO class nRF52840 only: Module with types, definitions, and API used by USB Audio class
| | | o USB Audio descriptors nRF52840 only: Descriptors used in the USB Audio class
| | | o USB AUDIO class configuration
| | | o USB Audio internals nRF52840 only: USB Audio class internals
| | | \ USB Audio types nRF52840 only: Type definitions for the USB Audio class
| | o USB CDC ACM class nRF52840 only: Module with types, definitions and API used by CDC ACM class
| | | o USB CDC ACM class configuration
| | | o USB CDC ACM internals nRF52840 only: Internals of the USB ACM class implementation
| | | o CDC class descriptors nRF52840 only: Descriptors used in the USB CDC class implementation.A group of macros used to initialize CDC descriptors
| | | \ CDC class types nRF52840 only: Variable types used by the CDC class implementation
| | o USB HID class nRF52840 only: Module with generic HID event data processing
| | | o USB HID class configuration
| | | o USB HID class types nRF52840 only: Module with types and definitions used by HID modules
| | | o USB HID generic nRF52840 only: Module with types, definitions, and API used by the HID generic class
| | | | o USB HID generic descriptors nRF52840 only: Module with descriptors used by the HID generic class
| | | | o USB HID generic configuration
| | | | \ USB HID generic internals nRF52840 only: Module with types, definitions, and API used by the HID generic protocol
| | | o USB HID keyboard nRF52840 only: Module with types, definitions, and API used by the HID keyboard class
| | | | o USB HID keyboard descriptors nRF52840 only: Module with types, definitions, and API used by the HID keyboard class
| | | | o USB HID keyboard configuration
| | | | \ USB HID keyboard internals nRF52840 only: Module with types, definitions, and API used by the HID keyboard class
| | | \ USB HID mouse nRF52840 only: Module with types, definitions, and API used by the HID mouse class
| | |   o USB HID mouse descriptors nRF52840 only: Module with types, definitions, and API used by the HID mouse class
| | |   o USB HID mouse configuration
| | |   \ USB HID mouse internals nRF52840 only: Module with types, definitions, and API used by the HID mouse class
| | \ USB MSC class nRF52840 only: Module with types, definitions, and API used by the USB MSC class
| |   o USB MSC descriptors nRF52840 only: Descriptors for the USB MSC class
| |   o USB MSC class configuration
| |   o USB MSC internals nRF52840 only: Internals of the USB MSC class
| |   o USB MSC SCSI data structures nRF52840 only: USB MSC SCSI data structures
| |   \ USB MSC types nRF52840 only: Types used in the USB MSC class
| o Common application error handler Common application error handler and macros for utilizing a common error handler
| | \ Fault ID types
| o Utility Functions and Definitions Various types and definitions available to all applications
| o Utility Functions and Definitions (Platform) Various types and definitions available to all applications when using SoftDevice
| o SDK Error codes
| | o Base defined for SDK Modules
| | o Codes reserved as identification for module where the error occurred.
| | o Codes reserved as identification for IoT errors.
| | o Codes reserved as identification for common errors.
| | \ Error / status codes specific to drivers.
| o SDK Common Header Macros for parameter checking and similar tasks
| o Mapped flags Module for writing and reading flags that are associated with keys
| o SoftDevice Event Handler API for initializing and disabling the SoftDevice
| | o Types definitions for ANT support in SoftDevice handler. This file contains the declarations of types required for ANT stack support. These types will be defined when the preprocessor define ANT_STACK_SUPPORT_REQD is defined
| | \ Types definitions for BLE support in SoftDevice handler. This file contains the declarations of types required for BLE stack support. These types will be defined when the preprocessor define BLE_STACK_SUPPORT_REQD is defined
| o Retarget layer for stdio functions
| | \ Retargeting stdio functions configuration
| \ Adafruit PN532 NFC Shield library Adafruit PN532 NFC Shield library for reading and writing tags
|   o Frame header Macros related to the frame header and checksum parts
|   o Frame tokens and offsets Macros related to frame tokens and offsets
|   o Frame direction identifiers Macro codes identifying the communication direction
|   o Command codes Macros for the available command codes
|   o Mifare command codes Macros for the available Mifare command codes
|   o Type 2 Tag specific parameters Macros for Type 2 Tag specific parameters
|   o NFC-A initialisation response parameters. Macros for NFC-A initialisation response parameters
|   \ Adafruit PN532 implementation for nRF5x configuration
o CryptoCell API nRF52840 only: Application Programming Interface for CryptoCell
| o crys_aesccm This file contains all of the enums and definitions that are used for the CRYS AESCCM APIs, as well as the APIs themselves. The API supports AES-CCM and AES-CCM* as defined in ieee-802.15.4
| o crys_aesccm_error This module contains the definitions of the CRYS AESCCM errors
| o crys_chacha This file contains all of the enums and definitions that are used for the CRYS CHACHA APIs, as well as the APIs themselves
| o crys_chacha_error This module contains the definitions of the CRYS CHACHA errors
| o crys_chacha_poly This file contains all of the enums and definitions that are used for the CRYS CHACHA-POLY APIs, as well as the APIs themselves
| o crys_chacha_poly_error This module contains the definitions of the CRYS CHACHA POLY errors
| o crys_dh This module defines the API that supports Diffie-Hellman key exchange, as defined in [PKCS3] and in [X9.42] (key lengths 1024 and 2048 bits)
| o crys_dh_error This file contains error codes definitions for CRYS DH module
| o crys_dh_kg This module defines the API that supports Diffie-Hellman domain
| o crys_ec_edw_api This file contains the CRYS APIs used for EC EDW (Edwards) ed25519 algorithms
| o crys_ec_mont_api This file contains the CRYS APIs used for EC MONT (Montgomery Curve25519) algorithms
| o crys_ecpki_build This module defines functions for building key structures used in Elliptic Curves Cryptography (ECC)
| o crys_ecpki_dh Defines the API that supports EC Diffie-Hellman shared secret value derivation primitives
| o crys_ecpki_domain Defines the ecpki build domain API
| o crys_ecpki_ecdsa Defines the APIs that support the ECDSA functions
| o crys_ecpki_error This module contains the definitions of the CRYS ECPKI errors
| o crys_ecpki_kg Defines the API for generation of ECC private and public keys
| o crys_ecpki_types Contains all of the enums and definitions that are used for the CRYS ECPKI APIs
| o crys_error This module defines the error return code types and the numbering spaces of the error codes for each module of the layers listed below
| o crys_hash This file contains all of the enums and definitions that are used for the CRYS HASH APIs, as well as the APIs themselves
| o crys_hash_defs This file contains HASH definitions
| o crys_hash_error This module contains the definitions of the CRYS HASH errors
| o crys_hkdf This module defines the API that supports HMAC Key derivation function as defined by RFC5869
| o crys_hkdf_error This module contains the definitions of the CRYS HKDF errors
| o crys_hmac This file contains all of the enums and definitions that are used for the CRYS HMAC APIs, as well as the APIs themselves
| o crys_hmac_error This module contains the definitions of the CRYS HMAC errors
| o crys_kdf This module defines the API that supports Key derivation function in modes as defined in PKCS#3, ANSI X9.42-2001, and ANSI X9.63-1999
| o crys_kdf_error This module contains the definitions of the CRYS KDF errors
| o crys_pka_defs_hw The file contains all of the enums and definitions that are used in the PKA related code
| o crys_poly This file contains all of the enums and definitions that are used for the CRYS POLY APIs, as well as the APIs themselves
| o crys_rnd This file contains the CRYS APIs used for random number generation. The random-number generation module implements referenced standard [SP800-90]
| o crys_rnd_error This module contains the definitions of the CRYS RND errors
| o crys_rsa_build This module defines some utility functions for working with RSA cryptography
| o crys_rsa_error This module contains the definitions of the CRYS RSA errors
| o crys_rsa_kg Generates a RSA pair of public and private keys
| o crys_rsa_prim This module defines the API that implements the [PKCS1_2.1] primitive functions
| o crys_rsa_schemes This module defines APIs that support [PKCS1_1.5] and [PKCS1_2.1] encryption and signature schemes
| o crys_rsa_types This file contains all of the enums and definitions that are used for the CRYS RSA APIs
| o crys_srp This file contains all of the enums and definitions that are used for the CRYS SRP APIs, as well as the APIs themselves
| o crys_srp_error This module contains the definitions of the CRYS SRP errors
| o sns_silib This file contains all of the enums and definitions that are used for the CryptoCell Lib init and finish APIs, as well as the APIs themselves
| o ssi_aes This file contains all of the enums and definitions that are used for the CryptoCell AES APIs, as well as the APIs themselves
| o ssi_aes_defs This file contains definitions that are used for the ARM CryptoCell 3xx version of the CryptoCell AES APIs
| o ssi_aes_error This file contains the definitions of the CryptoCell AES errors
| o ssi_ecpki_domains_defs This file contains domains supported by project
| o ssi_general_defs This file contains general definitions
| o ssi_pal_abort This file contains definitions for PAL Abort API
| o ssi_pal_barrier This file contains the definitions and APIs for memory barrier implementation. This is a place holder for platform specific memory barrier implementation The secure core driver should include a memory barrier before and after the last word of the descriptor to allow correct order between the words and different descriptors
| o ssi_pal_compiler This file contains compiler related definitions
| o ssi_pal_dma This file contains definitions that are used for the DMA related APIs. The implementation of these functions need to be replaced according to Platform and OS
| o ssi_pal_dma_defs This file contains the platform dependent DMA definitions
| o ssi_pal_error This file contains the platform dependent error definitions
| o ssi_pal_init This file contains the PAL layer entry point, it includes the definitions and APIs for PAL initialization and termination
| o ssi_pal_log This file contains the PAL layer log definitions, by default the log is disabled
| o ssi_pal_mem This file contains functions for memory operations. The functions implementations are generally just wrappers to different operating system calls. None of the described functions will check the input parameters so the behavior of the APIs in illegal parameters case is dependent on the operating system behavior
| o ssi_pal_memmap This file contains functions for memory mapping None of the described functions will check the input parameters so the behavior of the APIs in illegal parameters case is dependent on the operating system behavior
| o ssi_pal_mutex This file contains functions for resource management (mutex operations). The functions implementations are generally just wrappers to different operating system calls. None of the described functions will check the input parameters so the behavior of the APIs in illegal parameters case is dependent on the operating system behavior
| o ssi_pal_types This file contains the platform dependent definitions and types
| o ssi_pal_types_plat This file contains basic type definitions that are platform dependent
| o ssi_pka_hw_plat_defs Contains the enums and definitions that are used in the PKA code (definitions that are platform dependent)
| o ssi_regs Macro definitions for accessing ARM TrustZone CryptoCell register space
| \ ssi_sram_map This file contains internal SRAM mapping definitions
\ Proprietary stacks Application Programming Interface for proprietary protocols
  o Enhanced ShockBurst Enhanced ShockBurst (ESB) is a basic protocol that supports two-way data packet communication including packet buffering, packet acknowledgment, and automatic retransmission of lost packets
  | \ ESB resources
  o Gazell Link Layer nRF51 Series only: Gazell Link Layer Application Programming Interface (API)
  \ Gazell Pairing nRF51 Series only: Gazell Pairing API