API Reference

S112 SoftDevice v7.0.1 API
Here is a list of all modules:
[detail level 1 2 3 4 5 ]
o BLE SoftDevice Common Type definitions, macros, error codes, SVC and event number subranges etc. common to all S112 SoftDevice modules
| o Bluetooth status codes
| o Common types and macro definitions Common types and macro definitions for the BLE SoftDevice
| | o Defines
| | | o Assigned Values for BLE UUIDs
| | | o BLE Connection Handles
| | | o Bluetooth Appearance values
| | | \ Types of UUID
| | \ Structures
| o Events, type definitions and API calls Module independent events, type definitions and API calls for the BLE SoftDevice
| | o Defines
| | | o Configuration defaults.
| | | o User Memory Types
| | | \ Vendor Specific base UUID counts
| | o Enumerations
| | o Functions
| | \ Structures
| o General error codes General error code definitions for the BLE API
| o Message Sequence Charts
| | o BLE Stack Enable
| | o Connection Configuration
| | o Interrupt-driven Event Retrieval
| | \ Thread Mode Event Retrieval
| o Module specific SVC, event and option number subranges Definition of SVC, event and option number subranges for each API module
| o Module specific error code subranges Assignment of subranges for module specific error codes
| \ SoftDevice Global Error Codes Global Error definitions
|   \ Error Codes Base number definitions
o Generic Access Profile (GAP) Definitions and prototypes for the GAP interface
| o Characteristic inclusion default values
| o Defines
| | o Advertising data sizes.
| | o Authenticated payload timeout defines.
| | o GAP Address types
| | o GAP Advertisement Flags
| | o GAP Advertising Set Terminated reasons
| | o GAP Advertising and Scan Response Data format
| | o GAP Advertising filter policies
| | o GAP Advertising interval max and min
| | o GAP Advertising timeout values in 10 ms units
| | o GAP Advertising types
| | o GAP Authentication Key Types
| | o GAP Connection Parameters Limits
| | o GAP Discovery modes
| | o GAP IO Capabilities
| | o GAP Keypress Notification Types
| | o GAP PHYs
| | o GAP Roles
| | o GAP Security Modes
| | o GAP Security status
| | o GAP Security status sources
| | o GAP Timeout sources
| | o GAP attribute security requirement setters
| | o GAP concurrent connection count defines.
| | o GAP device name defines.
| | o GAP event length defines.
| | o Privacy modes
| | \ SVC return values specific to GAP
| o Enumerations
| o Functions
| o GAP Characteristic inclusion configurations
| o Message Sequence Charts
| | o Advertising
| | o PHY Update Procedure
| | | \ Peripheral PHY Update
| | o Peripheral Connection Establishment and Termination
| | o Peripheral Connection Parameter Update
| | o Peripheral Security Procedures
| | | o GAP Failed Pairing: Keysize too small
| | | o Pairing failure: Keysize out of supported range
| | | o Pairing failure: Pairing aborted by the application
| | | o Pairing failure: Pairing failed from central
| | | o Pairing failure: Timeout
| | | o Peripheral Encryption Establishment using stored keys
| | | o Peripheral LESC Pairing
| | | | o Bonding: Numeric Comparison
| | | | o Bonding: Out of Band
| | | | o Bonding: Passkey Entry, Peripheral Displays
| | | | o Bonding: Passkey Entry, User Inputs on Peripheral
| | | | \ Pairing: Just Works
| | | o Peripheral Legacy Pairing
| | | | o Bonding: Just Works
| | | | o Bonding: Passkey Entry with static passkey
| | | | o Bonding: Passkey Entry, Peripheral displays
| | | | o Bonding: Passkey Entry, User Inputs on Peripheral or OOB
| | | | o Pairing failure: Confirm failed
| | | | \ Pairing: Just Works
| | | o Peripheral Security Request
| | | \ Unexpected Security Packet Reception
| | o Privacy
| | | o Directed Advertising
| | | o Peripheral Connection Establishment with Private Peer
| | | \ Private Advertising
| | o RSSI for connections with event filter
| | \ RSSI get sample
| \ Structures
o Generic Attribute Profile (GATT) Client Definitions and prototypes for the GATT Client interface
| o Defines
| | o Attribute Information Formats
| | o GATT Client defaults
| | \ SVC return values specific to GATTC
| o Enumerations
| o Functions
| o Message Sequence Charts
| | o GATTC ATT_MTU Exchange
| | o GATTC Characteristic Discovery
| | o GATTC Characteristic Value Write Without Response
| | o GATTC Characteristic or Descriptor Value Long Write
| | o GATTC Characteristic or Descriptor Value Read
| | o GATTC Characteristic or Descriptor Value Reliable Write
| | o GATTC Characteristic or Descriptor Value Write
| | o GATTC Descriptor Discovery
| | o GATTC Handle Value Indication
| | o GATTC Handle Value Notification
| | o GATTC Primary Service Discovery
| | o GATTC Read Characteristic Value by UUID
| | o GATTC Read Multiple Characteristic Values
| | o GATTC Relationship Discovery
| | \ GATTC Timeout
| \ Structures
o Generic Attribute Profile (GATT) Common Common definitions and prototypes for the GATT interfaces
| o Defines
| | o Characteristic Presentation Formats
| | o GATT Bluetooth Namespaces
| | o GATT Execute Write flags
| | o GATT Handle Value operations
| | o GATT Status Codes
| | o GATT Timeout sources
| | \ GATT Write operations
| \ Structures
o Generic Attribute Profile (GATT) Server Definitions and prototypes for the GATTS interface
| o Defines
| | o Attribute Table size
| | o GATT Server Attribute Types
| | o GATT Server Authorization Types
| | o GATT Server Operations
| | o GATT Server Service Types
| | o GATT Server defaults
| | o GATT Value Locations
| | o Maximum attribute lengths
| | o SVC return values specific to GATTS
| | o Service Changed Inclusion Values
| | \ System Attribute Flags
| o Enumerations
| o Functions
| o Message Sequence Charts
| | o GATTS ATT Table Population
| | o GATTS ATT_MTU Exchange
| | o GATTS Handle Value Indication
| | o GATTS Handle Value Indication or Notification disabled
| | o GATTS Handle Value Indication or Notification with System Attributes Missing
| | o GATTS Handle Value Notification
| | o GATTS Queued Writes: App handled, no attributes require authorization
| | o GATTS Queued Writes: App handled, one or more attributes require authorization
| | o GATTS Queued Writes: Execute Write without Prepare Write
| | o GATTS Queued Writes: Peer cancels operation
| | o GATTS Queued Writes: Prepare Queue Full
| | o GATTS Queued Writes: Stack handled, no attributes require authorization
| | o GATTS Queued Writes: Stack handled, one or more attributes require authorization
| | o GATTS Read Request with Authorization
| | o GATTS Read Request without Authorization
| | o GATTS Service Changed
| | o GATTS System Attributes Handling: Bonded Peer
| | o GATTS System Attributes Handling: Unknown Peer
| | o GATTS Timeout
| | o GATTS Write Command With Authorization
| | o GATTS Write Command Without Authorization
| | o GATTS Write Request with Authorization
| | \ GATTS Write Request without Authorization
| o Structures
| o User memory layout for Queued Writes
| \ User memory layout for System Attributes
o Master Boot Record API APIs for updating SoftDevice and BootLoader
| o Defines
| o Enumerations
| o Functions
| \ Types
o SoC Library API APIs for the SoC library
| o Defines
| o Enumerations
| o Functions
| o SoC Library Error Codes Error definitions for the SoC library
| \ Structures
o SoftDevice Manager API APIs for SoftDevice management
| o Defines
| | o Clock accuracy
| | o Fault ID ranges
| | o Fault ID types
| | \ Possible LFCLK oscillator sources
| o Enumerations
| o Functions
| o SoftDevice Manager Error Codes Error definitions for the SDM API
| \ Types
\ SoftDevice NVIC API APIs for the accessing NVIC when using a SoftDevice
  o Defines
  | \ SoftDevice NVIC internal definitions
  o SoftDevice NVIC internal functions
  o SoftDevice NVIC public functions
  \ Variables