mirror/btstack
1
0
Fork 0
mirror of https://github.com/bluekitchen/btstack.git synced 2025-01-07 09:55:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: document NVM keys

Browse Source
This commit is contained in:
Matthias Ringwald 2017-08-14 11:45:26 +02:00
parent 0c92bcc661
commit 24e1df9de5
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/manual/docs/how_to.md
View File

@ -29,7 +29,7 @@ The file *btstack_config.h* contains three parts:
- \#define HAVE_* directives [listed here](#sec:haveDirectives). These directives describe available system properties, similar to config.h in a autoconf setup.
- \#define ENABLE_* directives [listed here](#sec:enableDirectives). These directives list enabled properties, most importantly ENABLE_CLASSIC and ENABLE_BLE.
- other #define directives for BTstack configuration, most notably static memory, [see next section](#sec:memoryConfigurationHowTo).
- other #define directives for BTstack configuration, most notably static memory, [see next section](#sec:memoryConfigurationHowTo) and [NVM configuration](#sec:nvmConfiguration).
<!-- a name "lst:platformConfiguration"></a-->
<!-- -->
@ -162,6 +162,19 @@ In this example, the size of ACL packets is limited to the minimum of 52 bytes,
<!-- -->
### Non-volatile memory (NVM) directives {#sec:nvmConfiguration}
If implemented, bonding information is stored in Non-volatile memory. For Classic, a single link keys and its type is stored. For LE, the bonding information contains various values (long term key, random number, EDIV, signing counter, identity, ...)Often, this implemented using Flash memory. Then, the number of stored entries are limited by:
<!-- a name "lst:nvmDefines"></a-->
<!-- -->
#define | Description
--------------------------|------------
NVM_NUM_LINK_KEYS | Max number of Classic Link Keys that can be stored
NVM_NUM_DEVICE_DB_ENTRIES | Max number of LE Device DB entries that can be stored
## Source tree structure {#sec:sourceTreeHowTo}
The source tree has been organized to easily setup new projects.