From 24e1df9de5e2858b3a32cc076f7bd855b3a84055 Mon Sep 17 00:00:00 2001 From: Matthias Ringwald Date: Mon, 14 Aug 2017 11:45:26 +0200 Subject: [PATCH] docs: document NVM keys --- doc/manual/docs/how_to.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/doc/manual/docs/how_to.md b/doc/manual/docs/how_to.md index 86192316f..2fb5561d9 100644 --- a/doc/manual/docs/how_to.md +++ b/doc/manual/docs/how_to.md @@ -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). @@ -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: + + + + +#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.