API Reference

nRF5 SDK v17.1.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-FS client device simulator The ANT-FS client device simulator
| | \ ANT File Share module. configuration
| 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
| \ 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 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 BLE Link Context Manager Storage for link-related data
| 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
| | \ Initiating and executing a connection parameters negotiation procedure configuration
| 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 Database Service Structure
| o GATT module Module for negotiating and keeping track of GATT connection parameters and updating the data length
| | \ GATT module configuration
| o BLE GATT Queue Queue for the BLE GATT requests
| | \ BLE GATT Queue Module configuration
| o Queued Writes module Module for handling Queued Write operations
| | \ Queued writes support module (prepare/execute write) configuration
| o Scanning Module Module for handling the BLE scanning
| | o Scanning Module configuration
| | \ Filter modes
| 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 LESC module Module for handling LESC related events
| | | \ Le Secure Connection configuration
| | o Peer Manager Standard Event Handlers Standard event handlers implementing some best practices for BLE security
| | o Peer Manager defined security errors
| | \ All versions of Peer IDs. The data ID for each iteration of the data formats in flash
| \ Sensor Data Simulator Functions for simulating sensor data
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
| | \ Device Firmware Update configuration
| o Device Information Service Device Information Service module
| | o Vendor ID Source values
| | \ Device Information Service configuration
| o Device Information Service Client Device information Service Client module
| | \ Device Information Client 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 Internet Protocol Support Profile Internet Protocol Support Profile
| | \ Internet Protocol Support Profile 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 up 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 Object Transfer Service Object Transfer Service module
| | o Object Transfer Service, l2cap channel handling Object Transfer Service module
| | o Object Transfer Service, OACP handling Object Transfer Service module
| | o Object Transfer Service, Object characteristics Object Transfer Service module
| | \ Object transfer service configuration
| o GATT Service Client GATT Service Client module
| | \ GATT Service Client configuration
| 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
| o Object Transfer Service Client Object Transfer Service Client module
| | o Object Transfer Service Client configuration
| | o Object Transfer Service Client Object Transfer Service client module
| | | \ OTS Client L2CAP configuration
| | \ Object Transfer Service Client Object Action Control Point Object Action Control Point module
| |   \ OTS Client Object Action Control Point configuration
| o Bond Management Service Bond Management Service (BMS) module
| | \ BMS feature bits
| \ 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 Cryptography API Application Programming Interface for cryptography libraries
| o CryptoCell API nRF52840 only: Application Programming Interface for CryptoCell
| | o CryptoCell AES-CCM APIs
| | | \ CryptoCell AES-CCM specific errors
| | o CryptoCell CHACHA APIs
| | | \ CryptoCell CHACHA specific errors
| | o CryptoCell CHACHA-POLY APIs
| | | \ CryptoCell CHACHA POLY specific errors
| | o CryptoCell DH APIs
| | | o CryptoCell DH specific errors
| | | \ CryptoCell DH Key Generation APIs
| | o CryptoCell EC 25519 curve APIs This group is the cryptocell EC 25519 curve root group
| | | o CryptoCell EC Edwards APIs
| | | o CryptoCell EC Montgomery APIs
| | | \ CryptoCell ECC-25519 errors
| | o CryptoCell ECC APIs This group is the cryptocell ECC root group
| | | o CryptoCell key build for ECC APIs
| | | o CryptoCell ECC Diffie-Hellman APIs
| | | o CryptoCell ECC domain APIs
| | | o CryptoCell ECDSA APIs
| | | o CryptoCell ECC specific errors
| | | o CryptoCell ECC Key Generation APIs
| | | \ CryptoCell ECC specific types
| | o CryptoCell general base error codes
| | o CryptoCell HASH APIs
| | | o CryptoCell Hash definitions
| | | \ CryptoCell HASH specific errors
| | o CryptoCell HMAC Key Derivation APIs
| | | \ HMAC Key Derivation specific errors
| | o CryptoCell HMAC APIs
| | | o CryptoCell Hmac definitions
| | | \ CryptoCell HMAC specific errors
| | o CryptoCell Key Derivation APIs
| | | \ CryptoCell Key Derivation specific errors
| | o CryptoCell PKA group This group is the cryptocell PKA root group
| | | o CryptoCell PKA specific definitions
| | | \ CryptoCell PKA specific types and definitions
| | o CryptoCell POLY APIs
| | | \ CryptoCell POLY specific errors
| | o CryptoCell Random Generator APIs
| | | \ CryptoCell RND specific errors
| | o CryptoCell RSA APIs This group is the cryptocell ECC root group
| | | o CryptoCell RSA Utility APIs
| | | o CryptoCell RSA specific errors
| | | o CryptoCell RSA key generation APIs
| | | o CryptoCell RSA primitive APIs
| | | o CryptoCell RSA encryption and signature schemes
| | | \ CryptoCell RSA used definitions and enums
| | o CryptoCell SRP APIs
| | | \ CryptoCell SRP specific errors
| | o CryptoCell library basic APIs
| | o CryptoCell AES APIs
| | | o CryptoCell AES definitions
| | | \ CryptoCell AES specific errors
| | o CryptoCell PAL APIs This group is the PAL root group
| | | o CryptoCell PAL abort APIs
| | | o CryptoCell PAL memory Barrier APIs
| | | o CryptoCell PAL platform dependant compiler specific definitions
| | | o CryptoCell PAL DMA related APIs
| | | o CryptoCell PAL DMA specific definitions
| | | o CryptoCell PAL specific errors
| | | o CryptoCell PAL entryexit point APIs
| | | o CryptoCell PAL logging APIs and definitions
| | | o CryptoCell PAL memory operations
| | | o CryptoCell PAL memory mapping APIs
| | | o CryptoCell PAL mutex APIs
| | | \ CryptoCell PAL platform dependant types
| | o CryptoCell SRAM mapping APIs
| | \ CryptoCell utility APIs This group is the utility apis group
| |   o CryptoCell utils general definitions
| |   o CryptoCell utils error definitions
| |   o CryptoCell utility key derivation APIs
| |   \ CryptoCell utils general key definitions
| \ Infineon API Application Programming interface for Infineon devices
|   o Infineon OPTIGA(TM) Trust X crypto APIs Application Programming interface for OPTIGA(TM) Trust X devices
|   | o Infineon OPTIGA(TM) Trust X command library APIs Infineon OPTIGA(TM) Trust X command library APIS
|   | o Infineon OPTIGA(TM) Trust X mutual authentication APIs Infineon OPTIGA(TM) Trust X mutual authentication APIs
|   | o Infineon OPTIGA(TM) Trust X OCP APIs Infineon OPTIGA(TM) Trust X OCP APIs
|   | o Infineon OPTIGA(TM) Trust X types Infineon OPTIGA(TM) Trust X types
|   | o Infineon OPTIGA(TM) Trust X error types Infineon OPTIGA(TM) Trust X error types
|   | o Infineon OPTIGA(TM) Trust X logger APIs Infineon OPTIGA(TM) Trust X logger APIs
|   | o Infineon OPTIGA(TM) Trust X util module APIs Infineon OPTIGA(TM) Trust X util module APIs
|   | \ OPTIGA(TM) crypt module Infineon OPTIGA(TM) Trust X crypt module APIs
|   o Infineon OPTIGA(TM) Trust X command library APIs Module for application-level commands for Infineon OPTIGA Trust X
|   o Infineon platform abstraction APIs Infineon platform abstraction APIs
|   \ Infineon I2C protocol APIs Infineon I2C protocol stack library
o External hardware drivers Drivers for external hardware components that can be connected to nRF5 Development Kits
| 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
| o nRF21540 front-end Bluetooth range extender. NRF21540 front-end Bluetooth range extender
| | o nRF21540 board peripherals driver configuration
| | \ nRF21540 front-end Bluetooth range extender types
| o PCAL6408A Driver Module for configuring and using PCAL6408A GPIO expander
| o Synaptics Touchpad driver Synaptics Touchpad driver
| o ST7735R TFT controller configuration
| \ ILI9341 TFT controller configuration
o IEEE 802.15.4 stack API nRF52840 only: Application Programming Interface for the 802.15.4 stack
| o MAC layer
| | o MAC auto request
| | o MAC Common API Module for declaring MAC Common API
| | o MAC MCPS Data API Module to declare MAC MCPS Data API
| | o MAC MCPS Purge API Module to declare MAC MCPS Purge API
| | o MAC MLME Association API Module to declare MAC MLME Association API
| | o MAC MLME Beacon Notify API Module to declare MAC MLME Beacon Notify API
| | o MAC MLME Comm Status API Module to declare MAC MLME Comm Status API
| | o MAC MLME Disassociate API Module to declare MAC MLME Disassociate API
| | o MAC MLME GTS API Module to declare MAC MLME GTS API
| | o MAC MLME Orphan API Module to declare MAC MLME Orphan API
| | o MAC MLME PIB API Module to declare MAC MLME PIB API
| | o MAC MLME Poll API Module to declare MAC MLME Poll API
| | o MAC MLME Reset API Module to declare MAC MLME Reset API
| | o MAC MLME RX-Enable API Module to declare MAC MLME RX-Enable API
| | o MAC MLME Scan API Module to declare MAC MLME Scan API
| | o MAC MLME Start API Module to declare MAC MLME Start API
| | o MAC MLME Sync API Module to declare MAC MLME Sync API
| | o PAN ID Conflict API Module for handling PAN ID conflicts
| | o MAC MLME Security API Module to declare MAC MLME Security API
| | o MAC task scheduler Module for MAC task scheduling
| | \ MAC Time API Module to declare MAC Time API
| o System abstraction library
| | o System CRC API Module to declare System CRC API
| | o Debugging macros Functions used for debugging
| | o System events API Module for declaring system events API
| | o Finite State Machine API Module to declare Finite State Machine API
| | o Initialization API API for initizalizing the system abstraction library
| | o Doubly linked list API. Module to declare the doubly linked list API
| | o Memory Manager API Module to declare Memory Manager API
| | o Queue API Module to declare the queue API
| | o System Ring buffer API Module for declaring System Ring buffer API
| | o SLAB Allocator API Module for declaring the SLAB Allocator API
| | o Falling Asleep API Module for declaring the Falling Asleep API
| | o Task scheduler Module for task scheduling
| | o Time API Module for declaring Time API
| | \ System Utilities API Module to declare System Utilities API
| o PHY layer
| | o PHY Common API Module to declare Common PHY API
| | o PHY Data API Module to declare PHY Data API
| | o PHY CCA API Module to declare PHY Clear Channel Assessment API
| | o PHY ED API Module to declare PHY Energy Detection API
| | o PHY PIB API Module to declare PHY Information Base API
| | \ PHY TRX API Module to declare PHY Transceiver State API
| o Hardware abstraction layer
| | o HAL Atomic API Module to declare HAL Atomic API
| | o HAL Clock API Module to declare HAL Clock library
| | o HAL Debug Interface Module to declare HAL debug interface
| | o HAL Delay API Module to declare HAL Delay API
| | o HAL Mutex API
| | o HAL Random Number Generator API Module to declare HAL Random Number Generator API
| | o HAL Sleep API Module to declare HAL Sleep API
| | o HAL Tasks Module to declare HAL tasks library
| | o HAL Timer Module to declare HAL timer interface
| | o HAL Hardware Critical Timer Module to declare HAL hardware critical timer interface
| | o HAL Trace Interface Module to declare HAL Trace Interface
| | o HAL UART protocol Module to declare HAL UART protocol
| | o HAL UART Task Scheduler Module to declare HAL UART Task Scheduler interface
| | \ Chip-specific library interface
| |   o HAL exceptions
| |   o HAL RTC
| |   \ HAL timer - additional features
| o Radio abstraction layer
| | \ Radio Abstraction Layer common API Radio abstraction layer common interface
| |   o RAL Special API
| |   o RAL FSM API
| |   o RAL FSM private API
| |   o RAL auxiliary functions
| |   \ RAL RF initialization API
| \ Security abstraction library
|   o Security AES CCM declarations Module to declare Security AES CCM API
|   \ Security AES entity declarations Module to declare AES entity API
o NFC libraries Near field communication (NFC) library and modules
| o NFC BLE Pairing Library High-level library for BLE Connection Handover pairing using NFC
| | \ Library parameters 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 Alternative Carrier records parser Functions for parsing and decoding Alternative Carrier records
| | | | | \ Alternative Carrier record parser configuration
| | | | o Advertising and Scan Response Data Parser for NFC OOB pairing Functions for parsing and decoding data in the Advertising and Scan Response Data format for NFC OOB pairing
| | | | | \ BLE OOB pairing AD data parser configuration
| | | | o LE OOB records parser Functions for parsing and decoding LE OOB records
| | | | | \ LE record parser configuration
| | | | o ac (Alternative carrier) records Generation of NFC NDEF Alternative Carrier records for NDEF messages
| | | | | \ NFC NDEF Alternative Carrier record encoder configuration
| | | | 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
| | | | | \ AD data for OOB pairing encoder configuration
| | | | o NDEF message for OOB pairing encoder configuration
| | | | o Common data for Connection Handover and Connection Handover Parser modules
| | | | | \ OOB pairing common data configuration
| | | | o EP OOB records Generation of NFC NDEF EP OOB records for NDEF messages
| | | | | \ EP record for BLE pairing encoder configuration
| | | | o Hs (Handover Select) records Generation of NFC NDEF Handover Select records for NDEF messages
| | | | | \ Handover Select NDEF record encoder configuration
| | | | \ LE OOB records Generation of NFC NDEF LE OOB records for NDEF messages
| | | |   \ LE record for BLE pairing encoder configuration
| | | o Launch app messages Generation of NFC NDEF messages that can be used to launch apps
| | | | o Encoding data for NDEF Application Launching message for NFC Tag configuration
| | | | \ Launch app records Generation of NFC NDEF record descriptions that launch apps
| | | |   \ Encoding data for NDEF Application Launching record for NFC Tag configuration
| | | o Text records Generation of NFC NDEF Text record descriptions
| | | | \ Encoding data for a text record for NFC Tag configuration
| | | \ URI messages Generation of NFC NDEF messages with a URI record
| | |   o Encoding data for NDEF message with URI record for NFC Tag configuration
| | |   \ URI records Generation of NFC NDEF URI record descriptions
| | |     \ Encoding data for a URI record for NFC Tag configuration
| | 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
| | |   \ NFC NDEF Record generator module configuration
| | \ 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
| o Platform-specific module for NFC Platform-specific module for Near Field Communication Tag (NFCT)
| | \ NFC platform module for Clock control. configuration
| o NFC Type 2 Tag Implementation of NFC Type 2 Tag
| | o NFC tag 2 type emulation library The T2T emulation library interface
| | \ NFC Type 2 Tag parser Parser for Type 2 Tag data
| |   o Parser for decoding Type 2 Tag data configuration
| |   o Type 2 Tag Descriptor for a Type 2 Tag
| |   \ Type 2 Tag TLV blocks Descriptor for a Type 2 Tag TLV block
| \ NFC Type 4 Tag Implementation of NFC Type 4 Tag
|   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 Peripheral drivers
| o Peripheral drivers List of all drivers available in SDK
| | o ACL
| | | \ ACL HAL Hardware access layer for managing the Access Control List (ACL) peripheral
| | o ADC
| | | o ADC driver Analog-to-Digital Converter (ADC) peripheral driver
| | | | \ ADC peripheral driver configuration
| | | \ ADC HAL Hardware access layer for managing the Analog-to-Digital Converter (ADC) peripheral
| | o AAR
| | | \ AAR HAL Hardware access layer for managing the Accelerated Address Resolver (AAR) peripheral
| | o BPROT
| | | \ BPROT HAL Hardware access layer for managing the Block Protection (BPROT) mechanism
| | o CLOCK
| | | o Clock driver - legacy layer Layer providing compatibility with the former API
| | | | \ CLOCK peripheral driver - legacy layer configuration
| | | o CLOCK driver CLOCK peripheral driver
| | | | \ CLOCK peripheral driver configuration
| | | \ Clock HAL Hardware access layer for managing the CLOCK peripheral
| | o COMP
| | | o COMP driver - legacy layer Layer providing compatibility with the former API
| | | | \ COMP peripheral driver - legacy layer configuration
| | | o COMP driver Comparator (COMP) peripheral driver
| | | | \ COMP peripheral driver configuration
| | | \ COMP HAL Hardware access layer (HAL) for managing the Comparator (COMP) peripheral
| | o DPPI (not supported in SDK)
| | | o DPPI allocator Distributed Programmable Peripheral Interconnect (DPPI) allocator
| | | \ DPPI Controller HAL Hardware access layer for managing the Distributed Programmable Peripheral Interconnect Controller (DPPIC)
| | o KMU (not supported in SDK)
| | | \ KMU HAL Hardware access layer for managing the Key Management Unit (KMU) peripheral
| | o SPU (not supported in SDK)
| | | \ SPU HAL Hardware access layer for managing the System Protection Unit (SPU) peripheral
| | o VMC (not supported in SDK)
| | | \ VMC HAL Hardware access layer for managing the Volatile Memory Controller (VMC) peripheral
| | o CCM
| | | \ AES CCM HAL Hardware access layer for managing the AES CCM peripheral
| | o ECB
| | | o AES ECB encryption driver Driver for the Advanced Encryption Standard (AES) Electronic Code Book (ECB) peripheral
| | | \ AES ECB encryption HAL Hardware access layer (HAL) for managing the Advanced Encryption Standard (AES) Electronic Codebook (ECB) peripheral
| | o FICR
| | | \ FICR HAL Hardware access layer (HAL) for getting data from the Factory Information Configuration Registers (FICR)
| | o GPIO
| | | \ GPIO HAL Hardware access layer for managing the GPIO peripheral
| | o GPIOTE
| | | o GPIOTE driver - legacy layer Layer providing compatibility with the former API
| | | | \ GPIOTE peripheral driver - legacy layer configuration
| | | o GPIOTE driver GPIO Task Event (GPIOTE) peripheral driver
| | | | \ GPIOTE peripheral driver configuration
| | | \ GPIOTE HAL Hardware access layer (HAL) for managing the GPIOTE peripheral
| | o I2S
| | | o I2S driver - legacy layer Layer providing compatibility with the former API
| | | | \ I2S peripheral driver - legacy layer configuration
| | | o I2S driver Inter-IC Sound (I2S) peripheral driver
| | | | \ I2S peripheral driver configuration
| | | \ I2S HAL Hardware access layer for managing the Inter-IC Sound (I2S) peripheral
| | o LPCOMP
| | | o LPCOMP driver - legacy layer Layer providing compatibility with the former API
| | | | \ LPCOMP peripheral driver - legacy layer configuration
| | | o LPCOMP driver Low Power Comparator (LPCOMP) peripheral driver
| | | | \ LPCOMP peripheral driver configuration
| | | \ LPCOMP HAL Hardware access layer for managing the Low Power Comparator (LPCOMP) peripheral
| | o MPU
| | | \ MPU HAL Hardware access layer for managing the Memory Protection Unit (MPU) peripheral
| | o MWU
| | | \ MWU HAL Hardware access layer for managing the Memory Watch Unit (MWU) peripheral
| | o NFCT
| | | o NFCT driver Near Field Communication Tag (NFCT) peripheral driver
| | | | \ NFCT peripheral driver configuration
| | | o NFCT driver fixes and workarounds Fixes for hardware-related anomalies
| | | \ NFCT HAL Hardware access layer (HAL) for the Near Field Communication Tag (NFCT) peripheral
| | o NVMC
| | | o NVMC driver Non-Volatile Memory Controller (NVMC) peripheral driver
| | | o NVMC HAL (deprecated) Hardware access layer (HAL) for managing the Non-Volatile Memory Controller (NVMC) peripheral
| | | \ NVMC HAL Hardware access layer (HAL) for managing the Non-Volatile Memory Controller (NVMC) peripheral
| | o PDM
| | | o PDM driver - legacy layer Layer providing compatibility with the former API
| | | | \ PDM peripheral driver - legacy layer configuration
| | | o PDM driver Pulse Density Modulation (PDM) peripheral driver
| | | | \ PDM peripheral driver configuration
| | | \ PDM HAL Hardware access layer for managing the Pulse Density Modulation (PDM) peripheral
| | o POWER
| | | o POWER driver - legacy layer Layer providing compatibility with the former API
| | | | \ POWER peripheral driver - legacy layer configuration
| | | o POWER driver POWER peripheral driver
| | | | \ POWER peripheral driver configuration
| | | o POWER HAL Hardware access layer for managing the POWER peripheral
| | | \ REGULATORS HAL Hardware access layer for managing the REGULATORS peripheral
| | o PPI
| | | o PPI driver - legacy layer Layer providing compatibility with the former API
| | | | \ PPI peripheral driver - legacy layer configuration
| | | o PPI allocator Programmable Peripheral Interconnect (PPI) allocator
| | | | \ PPI peripheral allocator configuration
| | | \ PPI HAL Hardware access layer (HAL) for managing the Programmable Peripheral Interconnect (PPI) channels
| | o PWM
| | | o PWM driver - legacy layer Layer providing compatibility with the former API
| | | | \ PWM peripheral driver - legacy layer configuration
| | | o PWM driver Pulse Width Modulation (PWM) peripheral driver
| | | | \ PWM peripheral driver configuration
| | | \ PWM HAL Hardware access layer for managing the Pulse Width Modulation (PWM) peripheral
| | o QDEC
| | | o QDEC driver - legacy layer Layer providing compatibility with the former API
| | | | \ QDEC peripheral driver - legacy layer configuration
| | | o QDEC driver Quadrature Decoder (QDEC) peripheral driver
| | | | \ QDEC peripheral driver configuration
| | | \ QDEC HAL Hardware access layer for managing the Quadrature Decoder (QDEC) peripheral
| | o QSPI
| | | o QSPI driver - legacy layer nRF52840 only: Layer providing compatibility with the former API
| | | | \ QSPI peripheral driver - legacy layer configuration
| | | o QSPI driver Quad Serial Peripheral Interface (QSPI) peripheral driver
| | | | \ QSPI peripheral driver configuration
| | | \ QSPI HAL Hardware access layer for managing the QSPI peripheral
| | o RADIO
| | | \ RADIO HAL Hardware access layer for managing the RADIO peripheral
| | o RNG
| | | o RNG driver - legacy layer Layer providing compatibility with the former API
| | | | \ RNG peripheral driver - legacy layer configuration
| | | o RNG driver Random Number Generator (RNG) peripheral driver
| | | | \ RNG peripheral driver configuration
| | | \ RNG HAL Hardware access layer (HAL) for managing the Random Number Generator (RNG) peripheral
| | o RTC
| | | o RTC driver - legacy layer Layer providing compatibility with the former API
| | | | \ RTC peripheral driver - legacy layer configuration
| | | o RTC driver Real Timer Counter (RTC) peripheral driver
| | | | \ RTC peripheral driver configuration
| | | \ RTC HAL Hardware access layer for managing the Real Time Counter (RTC) peripheral
| | o SAADC
| | | o SAADC driver - legacy layer Layer providing compatibility with the former API
| | | | \ SAADC peripheral driver - legacy layer configuration
| | | o SAADC legacy driver Successive Approximation Analog-to-Digital Converter (SAADC) peripheral legacy driver
| | | | \ SAADC peripheral driver configuration
| | | o SAADC v2 driver Successive Approximation Analog-to-Digital Converter (SAADC) peripheral v2 driver
| | | \ SAADC HAL Hardware access layer for managing the SAADC peripheral
| | o SPI
| | | o SPI master driver Layer providing compatibility with the former API
| | | | \ SPI/SPIM peripheral driver - legacy layer configuration
| | | o SPI driver Serial Peripheral Interface master (SPI) driver
| | | | \ SPI peripheral driver configuration
| | | \ SPI HAL Hardware access layer for managing the SPI peripheral
| | o SPIM
| | | o SPIM driver Serial Peripheral Interface Master with EasyDMA (SPIM) driver
| | | | \ SPIM peripheral driver configuration
| | | \ SPIM HAL Hardware access layer for managing the SPIM peripheral
| | o SPIS
| | | o SPIS driver - legacy layer Layer providing compatibility with the former API
| | | | \ SPIS peripheral driver - legacy layer configuration
| | | o SPIS driver Serial Peripheral Interface Slave with EasyDMA (SPIS) driver
| | | | \ SPIS peripheral driver configuration
| | | \ SPIS HAL Hardware access layer for managing the SPIS peripheral
| | o Cortex-M Systick
| | | o ARM(R) SysTick driver - legacy layer Layer providing compatibility with the former API
| | | | \ ARM(R) SysTick driver - legacy layer configuration
| | | o ARM(R) SysTick driver ARM(R) SysTick driver
| | | | \ ARM(R) SysTick driver configuration
| | | \ SYSTICK HAL Hardware access layer (HAL) for managing the SYSTICK peripheral
| | o SWI/EGU
| | | o SWI driver - legacy layer Layer providing compatibility with the former API
| | | | \ SWI(EGU) peripheral driver - legacy layer configuration
| | | o SWI driver Driver for managing software interrupts (SWI)
| | | | \ SWI/EGU peripheral allocator configuration
| | | \ EGU HAL Hardware access layer for managing the Event Generator Unit (EGU) peripheral
| | o TEMP
| | | o TEMP driver Temperature sensor (TEMP) driver
| | | o TEMP HAL (deprecated) Temperature module init and read functions
| | | \ TEMP HAL Hardware access layer for managing the Temperature sensor (TEMP)
| | o TIMER
| | | o TIMER driver - legacy layer Layer providing compatibility with the former API
| | | | \ TIMER periperal driver - legacy layer configuration
| | | o Timer driver TIMER peripheral driver
| | | | \ TIMER periperal driver configuration
| | | \ TIMER HAL Hardware access layer for managing the TIMER peripheral
| | o TWI
| | | o Software controlled TWI Master driver Software controlled TWI Master driver (deprecated)
| | | o TWI driver - legacy layer Layer providing compatibility with the former API
| | | | \ TWI/TWIM peripheral driver - legacy layer configuration
| | | o TWI driver Two Wire Interface master (TWI) peripheral driver
| | | | \ TWI peripheral driver configuration
| | | \ TWI HAL Hardware access layer for managing the TWI peripheral
| | o TWIM
| | | o TWIM driver Two Wire Interface Master with EasyDMA (TWIM) peripheral driver
| | | | \ TWIM peripheral driver configuration
| | | \ TWIM HAL Hardware access layer for managing the TWIM peripheral
| | o TWIS
| | | o TWIS driver - legacy layer Layer providing compatibility with the former API
| | | | \ TWIS peripheral driver - legacy layer configuration
| | | o TWIS driver Two Wire Interface Slave with EasyDMA (TWIS) peripheral driver
| | | | \ TWIS peripheral driver configuration
| | | \ TWIS HAL Hardware access layer for managing the Two Wire Interface Slave with EasyDMA (TWIS) peripheral
| | o UART
| | | o UART driver - legacy layer Layer providing compatibility with the former API
| | | | \ UART/UARTE peripheral driver - legacy layer configuration
| | | o UART driver UART peripheral driver
| | | | \ UART peripheral driver configuration
| | | \ UART HAL Hardware access layer for managing the UART peripheral
| | o UARTE
| | | o UARTE driver UARTE peripheral driver
| | | | \ UARTE peripheral driver configuration
| | | \ UARTE HAL Hardware access layer for managing the UARTE peripheral
| | o USBD
| | | o USBD driver - legacy layer Layer providing compatibility with the former API
| | | | \ Software Component configuration
| | | o USBD driver Universal Serial Bus Device (USBD) peripheral driver
| | | | \ USBD peripheral driver configuration
| | | \ USBD HAL Hardware access layer for managing the Universal Serial Bus Device (USBD) peripheral
| | o WDT
| | | o WDT driver - legacy layer A layer providing compatibility with former API
| | | | \ WDT peripheral driver - legacy layer configuration
| | | o WDT driver Watchdog Timer (WDT) peripheral driver
| | | | \ WDT peripheral driver configuration
| | | \ WDT HAL Hardware access layer for managing the Watchdog Timer (WDT) peripheral
| | \ SDIO driver 2-wire serial interface driver
| \ nrfx API
|   o nrfx_glue.h This file contains macros that should be implemented according to the needs of the host environment into which nrfx is integrated
|   o Bitmask module Bitmask managing module
|   o Common module Common module
|   o Global Error Codes Global error code definitions
|   o Peripheral Resource Sharing (PRS) Peripheral Resource Sharing interface (PRS)
|   | \ Peripheral Resource Sharing module configuration
|   o Atomic operations API This module implements C11 stdatomic.h simplified API
|   \ Core-dependent functionality Module containing functions with core-dependent implementation, like delay
o 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 Gazell Link Layer Application Programming Interface (API)
| \ Gazell Pairing Gazell Pairing Application Programming Interface (API)
o SDK common libraries
| o Eddystone library Library for Eddystone beacons. This library is used in the 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 GATTS read Functions for handling GATTS read requests
| | | \ GATTS write Functions for handling GATTS write 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 Atomic operations API 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
| o Atomic FIFO FIFO implementation that allows for making atomic transactions without locking interrupts
| | \ FIFO instance macros
| o Atomic flags (bitmaps) This module implements atomic flags as bitmaps
| o Block memory allocator This module handles block memory allocator features
| | o Block allocator module configuration
| | \ Macros for preparing debug flags for block allocator module.
| o Block device This module implements unified block device API. It could used as a middle layer between filesystems and memories
| | o Empty implementation
| | | \ Empty block device configuration
| | o QSPI implementation
| | | \ QSPI block device configuration
| | o Serial flash memory parameters
| | o RAM implementation This module implements block device API. It should be used as a reference block device
| | | \ RAM block device configuration
| | \ SDC implementation
| o USB DFU trigger library nRF52840 only: USB DFU trigger library is used to enter the bootloader and read the firmware version
| | \ USB DFU Trigger library configuration
| o Bootloader modules Bootloader and DFU modules
| | o DFU modules Modules providing Device Firmware Update (DFU) functionality
| | | o DFU BLE Service Device Firmware Update (DFU) transport layer for Bluetooth low energy
| | | o Supervisor call interface for bond sharing The Supervisor call interface is a thread-safe method to call into the current application or into an external application using a Supervisor instruction
| | | o Device Firmware Upgrade configuration
| | | o Flash operations
| | | o MBR functions
| | | o Request handling
| | | o DFU settings
| | | | \ DFU Settings configuration
| | | o DFU transport Generic Device Firmware Update (DFU) transport interface
| | | | \ DFU result codes When the DFU controller sends requests to the DFU bootloader on the DFU target, the DFU bootloader answers with any of these result codes
| | | o DFU types
| | | o DFU utilities
| | | o Validation
| | | | \ DFU validation configuration
| | | \ DFU Serial transports shared part Shared part of Device Firmware Update (DFU) transport layers using serial interface (UART, USB CDC ACM)
| | |   o DFU Serial UART transport Configuration for Device Firmware Update (DFU) transport layer using UART
| | |   | \ UART DFU transport configuration
| | |   \ DFU Serial USB CDC ACM transport Configuration for Device Firmware Update (DFU) transport layer using USB CDC ACM
| | |     \ USB DFU transport configuration
| | o Bootloader settings configuration
| | o Application start
| | o Timers for DFU in the bootloader
| | o Firmware activation
| | o Bootloader Information
| | \ Automated feeding of the watchdog Module that keeps the WDT from timing out if the WDT has been started in the application
| o Board Support Package BSP module
| | o BSP: ANT Button Module Module for controlling ANT behavior through button actions
| | | \ Button Control for ANT configuration
| | o BSP: BLE Button Module Module for controlling BLE behavior through button actions
| | | \ Button Control for BLE configuration
| | o BSP over CLI Module Module for sending BSP events over CLI
| | \ NFC BSP Module Module for setting the NFCT peripheral as a wakeup source
| o Button Handler Buttons handling module
| | \ buttons handling module configuration
| o Command Line Interface Module for unified command line handling
| | o BLE UART command line interface transport layer
| | | \ BLE UART command line interface transport configuration
| | o CDC ACM command line interface transport layer
| | | \ CDC ACM command line interface transport configuration
| | o Command line interface configuration
| | o libUARTE command line interface transport layer.
| | | \ libUARTE command line interface transport configuration
| | o RTT command line interface transport layer
| | | \ RTT command line interface transport configuration
| | \ UART command line interface transport layer
| |   \ UART command line interface transport configuration
| o Cryptography library Cryptography library (nrf_crypto)
| | o Cryptography library. configuration
| | o AEAD (Authenticated Encryption with Associated Data) related Provides AEAD related functionality through nrf_crypto
| | o AEAD related functions Provides AEAD related functionality through nrf_crypto
| | o AES related functions Provides AES related functionality through nrf_crypto
| | o Edwards-curve Digital Signature Algorithm (EdDSA) Provides functionality related to Edwards-curve Digital Signature Algorithm (EdDSA)
| | o nrf_crypto error codes
| | o Cryptographic hash related functions Provides cryptographic hash related functionality through nrf_crypto
| | o HMAC based Key Derivation Function (HKDF) related functions Provides functions to generate HMAC based Key Derivation Function (HKDF)
| | o Hash-based message authentication code (HMAC) related functions Provides functions to generate Hash-based message authentication code (HMAC)
| | | o Meta backend. Includes all backends definitions
| | | \ Types shared between all @ref nrf_crypto_hmac backends. Types shared between all Hash-based message authentication code (HMAC) related functions backends
| | o Initialization Initialization related functions for nrf_crypto
| | o Dynamic memory management module Module to manage dynamically allocated memory used by nrf_crypto APIs
| | o RNG related functions RNG related functions
| | | o RNG Configuration configuration
| | | o Meta RNG backend. Includes all backends definitions
| | | \ Types shared between all @ref nrf_crypto_rng backends. Types shared between all RNG related functions backends
| | o Commonly shared types Provides definitions of commonly shared cryptographic types like hashes and curves used in the nrf_crypto APIs
| | | \ Cryptographic hash sizes Sizes of different cryptographic hashes
| | o Backends The following backends can be configured for the rf_crypto library
| | | o nrf_crypto HW RNG backend RNG functionality provided by the nrf_crypto nRF HW RNG backend
| | | | \ nrf_crypto HW RNG backend using mbedtls CTR-DRBG RNG functionality provided by the nrf_crypto nRF HW RNG backend and mbedtls CTR-DRBG
| | | o nrf_crypto OPTIGA RNG backend RNG functionality provided by the nrf_crypto OPTIGA RNG backend
| | | o CC310 backend CC310 backend API
| | | | o nrf_crypto CC310 backend AES AES functionality provided by the nrf_crypto CC310 backend
| | | | o nrf_crypto CC310 backend AES AEAD AES AEAD functionality provided by the nrf_crypto CC310 backend
| | | | o nrf_crypto CC310 backend CHACHA_POLY AEAD CHACHA_POLY AEAD functionality provided by the nrf_crypto CC310 backend
| | | | o nrf_crypto CC310 backend hash Hash functionality provided by the nrf_crypto CC310 backend
| | | | o CC310 backend for HMAC Backend wrapper for CryptoCell (CC310). None of these types should be used directly by the application
| | | | o nrf_crypto CC310 backend mutex. Mutex control for the nrf_crypto CC310 backend
| | | | o nRF Crypto CC310 RNG backend RNG functionality provided by the nrf_crypto CC310 backend
| | | | \ nrf_crypto CC310 backend shared Shared functionality for the nrf_crypto CC310 backend
| | | o CC310_BL backend CC310_BL backend API
| | | | o nrf_crypto CC310_BL backend hash Hash functionality provided by the nrf_crypto CC310_BL backend
| | | | \ nrf_crypto CC310_BL backend shared Shared functionality for the nrf_crypto CC310_BL backend
| | | o Cifra backend Cifra backend API
| | | | \ nrf_crypto Cifra backend AES AEAD AES AEAD functionality provided by the nrf_crypto Cifra backend
| | | o mbed TLS backend mbed TLS backend API
| | | | o nrf_crypto mbed TLS backend AES AES functionality provided by the nrf_crypto mbed TLS backend
| | | | o nrf_crypto mbed TLS backend AES AEAD AES AEAD functionality provided by the nrf_crypto mbed TLS backend
| | | | o nrf_crypto mbedtls backend hash Hash functionality provided by the nrf_crypto mbedtls backend
| | | | \ mbed TLS backend for HMAC Backend wrapper for mbed TLS. None of these types should be used directly by the application
| | | o nRF software backend nRF software backend API
| | | | \ nrf_crypto nRF SW backend hash Legacy hash functionality for bootloader use in nRFx devices
| | | \ Oberon backend nrf_oberon backend API
| | |   o nrf_crypto Oberon backend CHACHA_POLY AEAD AES AEAD functionality provided by the nrf_crypto Oberon backend
| | |   o Oberon backend hash Hash functionality provided by the Oberon nrf_crypto backend
| | |   \ Oberon backend for HMAC Backend wrapper for Oberon. None of these types should be used directly by the application
| | o Elliptic Curve Cryptography Key Management Provides elliptic curve cryptography API for public and private key management
| | | o Definitions specific to secp160r1 (NIST 160-bit)
| | | o Definitions specific to secp160r2 (NIST 160-bit)
| | | o Definitions specific to secp192r1 (NIST 192-bit)
| | | o Definitions specific to secp224r1 (NIST 224-bit)
| | | o Definitions specific to secp256r1 (NIST 256-bit)
| | | o Definitions specific to secp384r1 (NIST 384-bit)
| | | o Definitions specific to secp521r1 (NIST 521-bit)
| | | o Definitions specific to secp160k1 (Koblitz 160-bit)
| | | o Definitions specific to secp192k1 (Koblitz 192-bit)
| | | o Definitions specific to secp224k1 (Koblitz 224-bit)
| | | o Definitions specific to secp256k1 (Koblitz 256-bit)
| | | o Definitions specific to bp256r1 (Brainpool 256-bit)
| | | o Definitions specific to bp384r1 (Brainpool 384-bit)
| | | o Definitions specific to bp512r1 (Brainpool 512-bit)
| | | o Definitions specific to Curve25519
| | | \ Definitions specific to Ed25519
| | o Elliptic Curve Diffie-Hellman (ECDH) Provides elliptic curve cryptography functions for Diffie-Hellman shared secret exchange
| | | o Definitions specific to secp160r1 (NIST 160-bit)
| | | o Definitions specific to secp160r2 (NIST 160-bit)
| | | o Definitions specific to secp192r1 (NIST 192-bit)
| | | o Definitions specific to secp224r1 (NIST 224-bit)
| | | o Definitions specific to secp256r1 (NIST 256-bit)
| | | o Definitions specific to secp384r1 (NIST 384-bit)
| | | o Definitions specific to secp521r1 (NIST 521-bit)
| | | o Definitions specific to secp160k1 (Koblitz 160-bit)
| | | o Definitions specific to secp192k1 (Koblitz 192-bit)
| | | o Definitions specific to secp224k1 (Koblitz 224-bit)
| | | o Definitions specific to secp256k1 (Koblitz 256-bit)
| | | o Definitions specific to bp256r1 (Brainpool 256-bit)
| | | o Definitions specific to bp384r1 (Brainpool 384-bit)
| | | o Definitions specific to bp512r1 (Brainpool 512-bit)
| | | \ Definitions specific to Curve25519
| | \ Elliptic Curve Digital Signature (ECDSA) Provides elliptic curve cryptography functions for digital signature
| |   o Definitions specific to secp160r1 (NIST 160-bit)
| |   o Definitions specific to secp160r2 (NIST 160-bit)
| |   o Definitions specific to secp192r1 (NIST 192-bit)
| |   o Definitions specific to secp224r1 (NIST 224-bit)
| |   o Definitions specific to secp256r1 (NIST 256-bit)
| |   o Definitions specific to secp384r1 (NIST 384-bit)
| |   o Definitions specific to secp521r1 (NIST 521-bit)
| |   o Definitions specific to secp160k1 (Koblitz 160-bit)
| |   o Definitions specific to secp192k1 (Koblitz 192-bit)
| |   o Definitions specific to secp224k1 (Koblitz 224-bit)
| |   o Definitions specific to secp256k1 (Koblitz 256-bit)
| |   o Definitions specific to bp256r1 (Brainpool 256-bit)
| |   o Definitions specific to bp384r1 (Brainpool 384-bit)
| |   o Definitions specific to bp512r1 (Brainpool 512-bit)
| |   \ Definitions specific to Curve25519
| o Capacitive sensor library Module for using the capacitive sensor library with support for many instances of sliders, wheels, and buttons
| | o Capacitive sensor module configuration
| | \ Capacitive sensor macros A set of macros to facilitate creation of a new capacitive sensor instance
| o Capacitive sensor low-level library Module for using the capacitive sensor on low-energy level
| | \ Capacitive sensor low-level module configuration
| o Elliptic Curve Cryptography interface Elliptic Curve Cryptography interface
| | \ Elliptic Curve Cryptography Library configuration
| o Section variables Section variables
| o Section variables iterator
| | \ Section iterator configuration
| o Task manager (Cooperative Scheduler) Functions for managing tasks
| | \ Task manager. configuration
| o Flash Data Storage Flash Data Storage (FDS)
| | \ Flash data storage module configuration
| o FIFO implementation FIFO implementation
| | \ Software FIFO implementation configuration
| o Flash storage (fstorage) Flash abstraction library that provides basic read, write, and erase operations
| | o Flash abstraction library configuration
| | o NVMC implementation API implementation of fstorage that uses the non-volatile memory controller (NVMC)
| | \ SoftDevice implementation API implementation of fstorage that uses the SoftDevice
| o GFX Library Module for drawing graphical objects like lines, circles, and rectangles. Provides support for different fonts
| | o GFX module configuration
| | o Macros for defining new graphic objects
| | o LCD Library This module defines generic API for LCDs
| | \ Font header Generated font structures
| o GPIOTE Handler GPIOTE handler module
| | \ GPIOTE events dispatcher configuration
| o HardFault exception Default HardFault exception implementation
| | o HardFault default handler for debugging and release configuration
| | \ Generating HardFaults for testing Macros and functions used to generate a HardFault in a selected place.This functionality is meant to be used while testing the HardFault exception library functionality
| 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 LED softblink Module for generating a changing pulse-width modulated output signal that is used to smoothly blink LEDs
| | \ led_softblink module configuration
| o libUARTE asynchronous library Module for reliable communication over UARTE
| | \ libUARTE_async library configuration
| o libUARTE driver Module for reliable communication over UARTE
| | \ libUARTE library configuration
| o Logger module The nrf_log module interface
| | o Logger configuration
| | o Flash logger backend Flash logger backend
| | | \ Log flash backend configuration
| | o Logger backend interface The nrf_log backend interface
| | o Log RTT backend Log RTT backend
| | | \ Log RTT backend configuration
| | o Log UART backend Log UART backend
| | | \ Log UART backend configuration
| | o Functions for controlling nrf_log The nrf_log control interface
| | o Functions for initializing and adding default backends The nrf_log default backends
| | o Macros for logging on instance level Macros for logging on instance level
| | o String formatter for the logger messages
| | | \ Log string formatter configuration
| | \ Common part of serial backends The nrf_log serial backend common put function
| o Low-power PWM Module for generating a low-power pulse-width modulated output signal
| | \ low_power_pwm module configuration
| o Memory Manager Memory Manager for the nRF5 SDK
| | \ Dynamic memory allocator configuration
| o Memory Object module Functions for controlling a memory object
| | \ Linked memory allocator module configuration
| o MPU (Memory Protection Unit) driver Functions for controlling MPU
| | \ Module for MPU configuration
| o nRF Mutex Mutex used for protecting resources
| 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 Ring buffer Functions for controlling the ring buffer
| 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 and decoding This module encodes and decodes SLIP packages
| | \ SLIP encoding and decoding configuration
| o Sorted list Module for storing items in the ordered list
| | \ Sorted list configuration
| o SPI transaction manager Module for scheduling SPI transactions
| | \ SPI transaction manager configuration
| o Stack guard Functions for enabling stack violation control
| | \ Stack guard configuration
| o Stack info functions and definitions Functions and definitions used to obtain information about the state of the stack
| o Error code to string converter Module for converting error code into a printable string
| | \ Library for converting error code to string. configuration
| o Supervisor function Macros to create Supervisor functions
| o Supervisor instructions with indirect number Macros to create Supervisor instructions using indirect number
| o Asynchronous Supervisor function interface Macros to create Asynchronous Supervisor interface functions
| o Asynchronous Supervisor handler functions Macros to create Asynchronous Supervisor interface handler functions
| o Application Timer Application timer functionality
| | o Application timer functionality configuration
| | \ RTC driver Real Timer Counter (RTC) peripheral driver for app_timer
| o TWI transaction manager Module for scheduling TWI transactions
| | \ TWI transaction manager configuration
| o TWI Sensor module.
| | \ nRF TWI Sensor module 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 standard requests nRF52840 only: Module with types definitions used for standard requests processing
| | o USBD serial number generator nRF52840 only: Generate a standard USB serial number that is unique for each device
| | o USBD string descriptors nRF52840 only: USBD string descriptor management
| | 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 internals nRF52840 only: USB Audio class internals
| | | o USB Audio types nRF52840 only: Type definitions for the USB Audio class
| | | \ USB AUDIO class configuration
| | o USB CDC ACM class nRF52840 only: Module with types, definitions and API used by CDC ACM class
| | | o USB CDC ACM internals nRF52840 only: Internals of the USB ACM class implementation
| | | o USB CDC ACM class configuration
| | | 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 Dummy class nRF52840 only: Module with types, definitions, and API used by the USB Dummy class
| | | o USB Dummy internals nRF52840 only: Internals of the USB Dummy class
| | | o USB Dummy types nRF52840 only: Types used in the USB Dummy class
| | | \ USBD Dummy class configuration
| | o USB HID class nRF52840 only: Module with generic HID event data processing
| | | o USB HID class types nRF52840 only: Module with types and definitions used by HID modules
| | | o USB HID class configuration
| | | 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 internals nRF52840 only: Module with types, definitions, and API used by the HID generic protocol
| | | | \ USB HID generic configuration
| | | 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 internals nRF52840 only: Module with types, definitions, and API used by the HID keyboard class
| | | | \ USB HID keyboard configuration
| | | \ 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 internals nRF52840 only: Module with types, definitions, and API used by the HID mouse class
| | |   \ USB HID mouse configuration
| | o 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 internals nRF52840 only: Internals of the USB MSC class
| | | o USB MSC SCSI data structures nRF52840 only: USB MSC SCSI data structures
| | | o USB MSC types nRF52840 only: Types used in the USB MSC class
| | | \ USB MSC class configuration
| | o USB Nordic DFU Trigger class nRF52840 only: Module with types, definitions, and API used by the USB Nordic DFU Trigger class
| | | o USB Nordic DFU Trigger internals nRF52840 only: Internals of the USB Nordic DFU Trigger class
| | | o USB Nordic DFU Trigger types nRF52840 only: Types used in the USB Nordic DFU Trigger class
| | | \ USBD Nordic DFU Trigger class configuration
| | \ USB Device library configuration
| 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.
| | o Error / status codes specific to drivers.
| | \ IPSP codes Error and status codes specific to IPSP
| 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 Handler API for initializing and disabling the SoftDevice
| | o SoftDevice handler configuration
| | o ANT support in SoftDevice Handler This file contains the declarations of types and functions required for ANT stack support
| | | \ SoftDevice ANT event handler configuration
| | o BLE support in SoftDevice Handler This file contains the declarations of types and functions required for BLE stack support
| | | \ SoftDevice BLE event handler configuration
| | \ SoC support in SoftDevice Handler This file contains the declarations of types and functions required for SoftDevice Handler SoC support
| |   \ SoftDevice SoC event handler configuration
| 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 Serialization Serialization API
| o Serialization Application Hardware Abstraction Layer (HAL) Functions that set up hardware on Application Board and perform the reset of the Connectivity Board
| o Serialization HAL Transport HAL Transport layer for serialization
| o Serialization PHY PHY layer for serialization
| o HCI Serialization PHY HCI PHY layer for serialization
| o Serialization codecs Application and Connectivity codecs
| | o Application 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 codecs for S132 and S140
| | | | 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
| | | \ Application codecs for S212
| | |   \ Application command request encoders and command response decoders Application command request encoders and command response decoders
| | o Connectivity codecs
| | | o Connectivity common codecs
| | | | \ DTM Connectivity command request decoder and command response encoder DTM Connectivity command request decoder and command response encoder
| | | o Connectivity codecs for S132 and S140
| | | | 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
| | | \ Connectivity codecs for S212
| | |   \ Connectivity command request decoders and command response encoders Connectivity command request decoders and command response encoders
| | \ Connectivity middleware codecs
| |   o Connectivity middleware common codecs
| |   o Connectivity middleware codecs for S132 and S140 (connectivity side)
| |   | o Middleware command handlers
| |   | o GAP Middleware command handlers
| |   | o GATTC Middleware command handlers
| |   | o GATTS Middleware command handlers
| |   | \ L2CAP Middleware command handlers
| |   \ Connectivity middleware codecs for S212 (connectivity side)
| |     \ Middleware codecs for S212 (connectivity side) configuration
| o Application side code 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 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
\ External BLE Libraries
  \ Tile Over-the-air API Tile Over-the-air Api: defines Tile communication protocol over the air
    o Tile Library API Tile Library Api
    o Tile Diagnostics module Tile Diagnostics module
    o Tile mode
    \ Tile Over-the-air API module