Merge pull request #102 from sjanc/docs

Documentation update

docs/.gitignore

@@ -0,0 +1,5 @@
+xml
+node_modules
+_build
+doxygen_*
+*.pyc

docs/Makefile

@@ -0,0 +1,25 @@
+# Make a preview site for Sphinx & Doxygen output
+
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = Mynewt
+SOURCEDIR     = .
+BUILDDIR      = _build/sphinx
+
+.PHONY: Makefile clean preview doxygen
+
+clean:
+	rm -rf _build
+
+preview: _build doxygen sphinx
+
+_build:
+	mkdir -p _build
+
+doxygen:
+	mkdir -p _build/html
+	cd .. && doxygen docs/doxygen.xml
+
+sphinx:
+	sphinx-build . _build/sphinx
+	mv _build/sphinx _build/html/documentation

docs/README.rst

@@ -0,0 +1,33 @@
+NimBLE Bluetooth Stack Documentation
+#################################
+
+This folder holds the documentation for the NimBLE Bluetooth stack from the
+`Apache Mynewt`_ project. It is  built using `Sphinx`_.
+The source code also contains inline comments in `Doxygen`_
+format to document the APIs.
+
+The complete project documentation can be found at `mynewt documentation`_
+
+.. contents::
+
+Writing Documentation
+=======================
+
+See: https://github.com/apache/mynewt-documentation#writing-documentation
+
+Previewing Changes
+==========================
+
+In order to preview any changes you make you must first install a Sphinx
+toolchain as described at https://github.com/apache/mynewt-documentation#id3.
+ Then:
+
+.. code-block:: bash
+
+  $ cd docs
+  $ make clean && make preview && (cd _build/html && python -m SimpleHTTPServer 8080)
+
+.. _Apache Mynewt: https://mynewt.apache.org/
+.. _mynewt documentation: https://github.com/apache/mynewt-documentation
+.. _Sphinx: http://www.sphinx-doc.org/
+.. _Doxygen: http://www.doxygen.org/

docs/ble_hs/ble_att.rst

@@ -0,0 +1,22 @@
+NimBLE Host ATT Client Reference
+--------------------------------
+
+Introduction
+~~~~~~~~~~~~
+
+The Attribute Protocol (ATT) is a mid-level protocol that all BLE devices use to exchange data. Data is exchanged when
+an ATT client reads or writes an attribute belonging to an ATT server. Any device that needs to send or receive data
+must support both the client and server functionality of the ATT protocol. The only devices which do not support ATT
+are the most basic ones: broadcasters and observers (i.e., beaconing devices and listening devices).
+
+Most ATT functionality is not interesting to an application. Rather than use ATT directly, an application uses the
+higher level GATT profile, which sits directly above ATT in the host. NimBLE exposes the few bits of ATT functionality
+which are not encompassed by higher level GATT functions. This section documents the ATT functionality that the NimBLE
+host exposes to the application.
+
+Header
+~~~~~~
+
+.. code-block:: cpp
+
+    #include "host/ble_hs.h"

docs/ble_hs/ble_gap.rst

@@ -0,0 +1,14 @@
+NimBLE Host GAP Reference
+-------------------------
+
+Introduction
+~~~~~~~~~~~~
+
+The Generic Access Profile (GAP) is responsible for all connecting, advertising, scanning, and connection updating operations.
+
+Header
+~~~~~~
+
+.. code-block:: cpp
+
+    #include "host/ble_hs.h"

docs/ble_hs/ble_gattc.rst

@@ -0,0 +1,15 @@
+NimBLE Host GATT Client Reference
+---------------------------------
+
+Introduction
+~~~~~~~~~~~~
+
+The Generic Attribute Profile (GATT) manages all activities involving services, characteristics, and descriptors. The
+client half of the GATT API initiates GATT procedures.
+
+Header
+~~~~~~
+
+.. code-block:: cpp
+
+    #include "host/ble_hs.h"

docs/ble_hs/ble_gatts.rst

@@ -0,0 +1,15 @@
+NimBLE Host GATT Server Reference
+---------------------------------
+
+Introduction
+~~~~~~~~~~~~
+
+The Generic Attribute Profile (GATT) manages all activities involving services, characteristics, and descriptors. The
+server half of the GATT API handles registration and responding to GATT clients.
+
+Header
+~~~~~~
+
+.. code-block:: cpp
+
+    #include "host/ble_hs.h"

docs/ble_hs/ble_hs.rst

@@ -0,0 +1,27 @@
+NimBLE Host
+-----------
+
+Introduction
+~~~~~~~~~~~~
+
+At a high level, the NimBLE stack is divided into two components:
+
+-  Host
+-  Controller
+
+This document is an API reference for the host component. If you are
+interested in the general structure of the NimBLE stack and its non-host
+components, you might want to read the :doc:`../index`.
+
+The host sits directly below the application, and it serves as the
+interface to the application for all BLE operations.
+
+.. toctree::
+   :titlesonly:
+
+   Return Codes <ble_hs_return_codes>
+   GAP <ble_gap>
+   GATT Client <ble_gattc>
+   GATT Server <ble_gatts>
+   Identity <ble_hs_id>
+   ATT <ble_att>

docs/ble_hs/ble_hs_id.rst

@@ -0,0 +1,45 @@
+NimBLE Host Identity Reference
+------------------------------
+
+Introduction
+~~~~~~~~~~~~
+
+The identity API provides facilities for querying and configuring your device's addresses. BLE's addressing scheme is
+quite involved; the summary that follows is only a brief introduction.
+
+BLE defines four address types:
+
++---------------------------------+---------------------------------------------------------------------------------------------------+-------------+----------------------------------------------+
+| Type                            | Description                                                                                       | Identity?   | Configured with                              |
++=================================+===================================================================================================+=============+==============================================+
+| Public                          | Address assigned by manufacturer; the three most significant bytes form the manufacturer's OUI.   | Yes         | N/A; read from controller at startup.        |
++---------------------------------+---------------------------------------------------------------------------------------------------+-------------+----------------------------------------------+
+| Static random                   | Randomly generated address.                                                                       | Yes         | *ble_hs_id_set_rnd()*                        |
++---------------------------------+---------------------------------------------------------------------------------------------------+-------------+----------------------------------------------+
+| Resolvable private (RPA)        | Address randomly generated from an identity address and an identity resolving key (IRK).          | No          | N/A; generated by controller periodically.   |
++---------------------------------+---------------------------------------------------------------------------------------------------+-------------+----------------------------------------------+
+| Non-resolvable private (NRPA)   | Randomly generated address.                                                                       | No          | *ble_hs_id_set_rnd()*                        |
++---------------------------------+---------------------------------------------------------------------------------------------------+-------------+----------------------------------------------+
+
+Identity Addresses
+^^^^^^^^^^^^^^^^^^
+
+The third column in the above table indicates the *identity* property of each address type. An identity address never
+changes, and a device can be identified by one of its unique identity addresses.
+
+Non-identity addresses are used by devices supporting BLE privacy. A device using the privacy feature frequently changes
+its own address to a newly-generated non-identity address. By cycling its address, the device makes it impossible for
+eavesdroppers to track its location.
+
+A device can have up to two identity addresses at once: one public and one static random. As indicated in the above table,
+the public identity address cannot be configured; the static random identity address can be set by calling *ble_hs_id_set_rnd()*.
+
+The address type is selected on a per-GAP-procedure basis. Each time you initiate a GAP procedure, you indicate which
+address type the device should use for the duration of the procedure.
+
+Header
+~~~~~~
+
+.. code-block:: cpp
+
+    #include "host/ble_hs.h"

docs/ble_hs/ble_hs_return_codes.rst

@@ -0,0 +1,437 @@
+NimBLE Host Return Codes
+------------------------
+
+.. contents::
+    :local:
+    :depth: 2
+
+Introduction
+~~~~~~~~~~~~
+
+Summary
+^^^^^^^
+
+The NimBLE host reports status to the application via a set of return codes. The host encompasses several layers of the Bluetooth specification that each defines its own set of status codes. Rather than "abstract away" information from lower layers that the application developer might find useful, the NimBLE host aims to indicate precisely what happened when something fails. Consequently, the host utilizes a rather large set of return codes.
+
+A return code of 0 indicates success. For failure conditions, the return codes are partitioned into five separate sets:
+
++---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Set                       | Condition                                                                                                                                                                                                   |
++===========================+=============================================================================================================================================================================================================+
+| Core                      | Errors detected internally by the NimBLE host.                                                                                                                                                              |
++---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ATT                       | The ATT server has reported a failure via the transmission of an ATT Error Response. The return code corresponds to the value of the Error Code field in the response.                                      |
++---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| HCI                       | The controller has reported an error to the host via a command complete or command status HCI event. The return code corresponds to the value of the Status field in the event.                             |
++---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| L2CAP                     | An L2CAP signaling procedure has failed and an L2CAP Command Reject was sent as a result. The return code corresponds to the value of the Reason field in the command.                                      |
++---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Security manager (us)     | The host detected an error during a security manager procedure and sent a Pairing Failed command to the peer. The return code corresponds to the value of the Reason field in the Pairing Failed command.   |
++---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Security manager (peer)   | A security manager procedure failed because the peer sent us a Pairing Failed command. The return code corresponds to the value of the Reason field in the Pairing Failed command.                          |
++---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+The return codes in the core set are defined by the NimBLE Host. The other sets are defined in the Bluetooth specification; the codes in this latter group are referred to as *formal status codes*. As defined in the Bluetooth specification, the formal status code sets are not disjoint. That is, they overlap. For example, the spec defines a status code of 1 to have all of the following meanings:
+
++---------+----------------------------+
+| Layer   | Meaning                    |
++=========+============================+
+| ATT     | Invalid handle.            |
++---------+----------------------------+
+| HCI     | Unknown HCI command.       |
++---------+----------------------------+
+| L2CAP   | Signalling MTU exceeded.   |
++---------+----------------------------+
+| SM      | Passkey entry failed.      |
++---------+----------------------------+
+
+Clearly, the host can't just return an unadorned formal status code and expect the application to make sense of it. To resolve this ambiguity, the NimBLE host divides the full range of an int into several subranges. Each subrange corresponds to one of the five return code sets. For example, the ATT set is mapped onto the subrange *[0x100, 0x200)*. To indicate an ATT error of 3 (write not permitted), the NimBLE host returns a value 0x103 to the application.
+
+The host defines a set of convenience macros for converting from a formal status code to NimBLE host status code. These macros are documented in the table below.
+
++----------------------------+---------------------------+--------------+
+| Macro                      | Status code set           | Base value   |
++============================+===========================+==============+
+| BLE\_HS\_ATT\_ERR()        | ATT                       | 0x100        |
++----------------------------+---------------------------+--------------+
+| BLE\_HS\_HCI\_ERR()        | HCI                       | 0x200        |
++----------------------------+---------------------------+--------------+
+| BLE\_HS\_L2C\_ERR()        | L2CAP                     | 0x300        |
++----------------------------+---------------------------+--------------+
+| BLE\_HS\_SM\_US\_ERR()     | Security manager (us)     | 0x400        |
++----------------------------+---------------------------+--------------+
+| BLE\_HS\_SM\_PEER\_ERR()   | Security manager (peer)   | 0x500        |
++----------------------------+---------------------------+--------------+
+
+Example
+^^^^^^^
+
+The following example demonstrates how an application might determine which error is being reported by the host. In this example, the application performs the GAP encryption procedure and checks the return code. To simplify the example, the application uses a hypothetical *my\_blocking\_enc\_proc()* function, which blocks until the pairing operation has completed.
+
+.. code:: c
+
+    void
+    encrypt_connection(uint16_t conn_handle)
+    {
+        int rc;
+
+        /* Perform a blocking GAP encryption procedure. */
+        rc = my_blocking_enc_proc(conn_handle);
+        switch (rc) {
+        case 0:
+            console_printf("success - link successfully encrypted\n");
+            break;
+
+        case BLE_HS_ENOTCONN:
+            console_printf("failure - no connection with handle %d\n",
+                           conn_handle);
+            break;
+
+        case BLE_HS_ERR_SM_US_BASE(BLE_SM_ERR_CONFIRM_MISMATCH):
+            console_printf("failure - mismatch in peer's confirm and random "
+                           "commands.\n");
+            break;
+
+        case BLE_HS_ERR_SM_PEER_BASE(BLE_SM_ERR_CONFIRM_MISMATCH):
+            console_printf("failure - peer reports mismatch in our confirm and "
+                           "random commands.\n");
+            break;
+
+        default:
+            console_printf("failure - other error: 0x%04x\n", rc);
+            break;
+        }
+    }
+
+Return Code Reference
+~~~~~~~~~~~~~~~~~~~~~
+
+Header
+^^^^^^
+
+All NimBLE host return codes are made accessible by including the following header:
+
+.. code:: c
+
+    #include "host/ble_hs.h"
+
+Return codes - Core
+^^^^^^^^^^^^^^^^^^^
+
+The precise meaning of each of these error codes depends on the function that returns it.
+The API reference for a particular function indicates the conditions under which each of these codes are returned.
+
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| Value   | Name                         | Condition                                                                                   |
++=========+==============================+=============================================================================================+
+| 0x00    | *N/A*                        | Success                                                                                     |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x01    | BLE\_HS\_EAGAIN              | Temporary failure; try again.                                                               |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x02    | BLE\_HS\_EALREADY            | Operation already in progress or completed.                                                 |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x03    | BLE\_HS\_EINVAL              | One or more arguments are invalid.                                                          |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x04    | BLE\_HS\_EMSGSIZE            | The provided buffer is too small.                                                           |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x05    | BLE\_HS\_ENOENT              | No entry matching the specified criteria.                                                   |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x06    | BLE\_HS\_ENOMEM              | Operation failed due to resource exhaustion.                                                |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x07    | BLE\_HS\_ENOTCONN            | No open connection with the specified handle.                                               |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x08    | BLE\_HS\_ENOTSUP             | Operation disabled at compile time.                                                         |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x09    | BLE\_HS\_EAPP                | Application callback behaved unexpectedly.                                                  |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x0a    | BLE\_HS\_EBADDATA            | Command from peer is invalid.                                                               |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x0b    | BLE\_HS\_EOS                 | Mynewt OS error.                                                                            |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x0c    | BLE\_HS\_ECONTROLLER         | Event from controller is invalid.                                                           |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x0d    | BLE\_HS\_ETIMEOUT            | Operation timed out.                                                                        |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x0e    | BLE\_HS\_EDONE               | Operation completed successfully.                                                           |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x0f    | BLE\_HS\_EBUSY               | Operation cannot be performed until procedure completes.                                    |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x10    | BLE\_HS\_EREJECT             | Peer rejected a connection parameter update request.                                        |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x11    | BLE\_HS\_EUNKNOWN            | Unexpected failure; catch all.                                                              |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x12    | BLE\_HS\_EROLE               | Operation requires different role (e.g., central vs. peripheral).                           |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x13    | BLE\_HS\_ETIMEOUT\_HCI       | HCI request timed out; controller unresponsive.                                             |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x14    | BLE\_HS\_ENOMEM\_EVT         | Controller failed to send event due to memory exhaustion (combined host-controller only).   |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x15    | BLE\_HS\_ENOADDR             | Operation requires an identity address but none configured.                                 |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x16    | BLE\_HS\_ENOTSYNCED          | Attempt to use the host before it is synced with controller.                                |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x17    | BLE\_HS\_EAUTHEN             | Insufficient authentication.                                                                |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x18    | BLE\_HS\_EAUTHOR             | Insufficient authorization.                                                                 |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x19    | BLE\_HS\_EENCRYPT            | Insufficient encryption level.                                                              |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x1a    | BLE\_HS\_EENCRYPT\_KEY\_SZ   | Insufficient key size.                                                                      |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x1b    | BLE\_HS\_ESTORE\_CAP         | Storage at capacity.                                                                        |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+| 0x1c    | BLE\_HS\_ESTORE\_FAIL        | Storage IO error.                                                                           |
++---------+------------------------------+---------------------------------------------------------------------------------------------+
+
+Return codes - ATT
+^^^^^^^^^^^^^^^^^^
+
++----------------+----------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| NimBLE Value   | Formal Value   | Name                                       | Condition                                                                                                                                 |
++================+================+============================================+===========================================================================================================================================+
+| 0x0101         | 0x01           | BLE\_ATT\_ERR\_INVALID\_HANDLE             | The attribute handle given was not valid on this server.                                                                                  |
++----------------+----------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0102         | 0x02           | BLE\_ATT\_ERR\_READ\_NOT\_PERMITTED        | The attribute cannot be read.                                                                                                             |
++----------------+----------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0103         | 0x03           | BLE\_ATT\_ERR\_WRITE\_NOT\_PERMITTED       | The attribute cannot be written.                                                                                                          |
++----------------+----------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0104         | 0x04           | BLE\_ATT\_ERR\_INVALID\_PDU                | The attribute PDU was invalid.                                                                                                            |
++----------------+----------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0105         | 0x05           | BLE\_ATT\_ERR\_INSUFFICIENT\_AUTHEN        | The attribute requires authentication before it can be read or written.                                                                   |
++----------------+----------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0106         | 0x06           | BLE\_ATT\_ERR\_REQ\_NOT\_SUPPORTED         | Attribute server does not support the request received from the client.                                                                   |
++----------------+----------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0107         | 0x07           | BLE\_ATT\_ERR\_INVALID\_OFFSET             | Offset specified was past the end of the attribute.                                                                                       |
++----------------+----------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0108         | 0x08           | BLE\_ATT\_ERR\_INSUFFICIENT\_AUTHOR        | The attribute requires authorization before it can be read or written.                                                                    |
++----------------+----------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0109         | 0x09           | BLE\_ATT\_ERR\_PREPARE\_QUEUE\_FULL        | Too many prepare writes have been queued.                                                                                                 |
++----------------+----------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x010a         | 0x0a           | BLE\_ATT\_ERR\_ATTR\_NOT\_FOUND            | No attribute found within the given attribute handle range.                                                                               |
++----------------+----------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x010b         | 0x0b           | BLE\_ATT\_ERR\_ATTR\_NOT\_LONG             | The attribute cannot be read or written using the Read Blob Request.                                                                      |
++----------------+----------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x010c         | 0x0c           | BLE\_ATT\_ERR\_INSUFFICIENT\_KEY\_SZ       | The Encryption Key Size used for encrypting this link is insufficient.                                                                    |
++----------------+----------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x010d         | 0x0d           | BLE\_ATT\_ERR\_INVALID\_ATTR\_VALUE\_LEN   | The attribute value length is invalid for the operation.                                                                                  |
++----------------+----------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x010e         | 0x0e           | BLE\_ATT\_ERR\_UNLIKELY                    | The attribute request that was requested has encountered an error that was unlikely, and therefore could not be completed as requested.   |
++----------------+----------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x010f         | 0x0f           | BLE\_ATT\_ERR\_INSUFFICIENT\_ENC           | The attribute requires encryption before it can be read or written.                                                                       |
++----------------+----------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0110         | 0x10           | BLE\_ATT\_ERR\_UNSUPPORTED\_GROUP          | The attribute type is not a supported grouping attribute as defined by a higher layer specification.                                      |
++----------------+----------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0111         | 0x11           | BLE\_ATT\_ERR\_INSUFFICIENT\_RES           | Insufficient Resources to complete the request.                                                                                           |
++----------------+----------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+
+Return codes - HCI
+^^^^^^^^^^^^^^^^^^
+
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| NimBLE Value   | Formal Value   | Name                               | Condition                                                                      |
++================+================+====================================+================================================================================+
+| 0x0201         | 0x01           | BLE\_ERR\_UNKNOWN\_HCI\_CMD        | Unknown HCI Command                                                            |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0202         | 0x02           | BLE\_ERR\_UNK\_CONN\_ID            | Unknown Connection Identifier                                                  |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0203         | 0x03           | BLE\_ERR\_HW\_FAIL                 | Hardware Failure                                                               |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0204         | 0x04           | BLE\_ERR\_PAGE\_TMO                | Page Timeout                                                                   |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0205         | 0x05           | BLE\_ERR\_AUTH\_FAIL               | Authentication Failure                                                         |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0206         | 0x06           | BLE\_ERR\_PINKEY\_MISSING          | PIN or Key Missing                                                             |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0207         | 0x07           | BLE\_ERR\_MEM\_CAPACITY            | Memory Capacity Exceeded                                                       |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0208         | 0x08           | BLE\_ERR\_CONN\_SPVN\_TMO          | Connection Timeout                                                             |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0209         | 0x09           | BLE\_ERR\_CONN\_LIMIT              | Connection Limit Exceeded                                                      |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x020a         | 0x0a           | BLE\_ERR\_SYNCH\_CONN\_LIMIT       | Synchronous Connection Limit To A Device Exceeded                              |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x020b         | 0x0b           | BLE\_ERR\_ACL\_CONN\_EXISTS        | ACL Connection Already Exists                                                  |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x020c         | 0x0c           | BLE\_ERR\_CMD\_DISALLOWED          | Command Disallowed                                                             |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x020d         | 0x0d           | BLE\_ERR\_CONN\_REJ\_RESOURCES     | Connection Rejected due to Limited Resources                                   |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x020e         | 0x0e           | BLE\_ERR\_CONN\_REJ\_SECURITY      | Connection Rejected Due To Security Reasons                                    |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x020f         | 0x0f           | BLE\_ERR\_CONN\_REJ\_BD\_ADDR      | Connection Rejected due to Unacceptable BD\_ADDR                               |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0210         | 0x10           | BLE\_ERR\_CONN\_ACCEPT\_TMO        | Connection Accept Timeout Exceeded                                             |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0211         | 0x11           | BLE\_ERR\_UNSUPPORTED              | Unsupported Feature or Parameter Value                                         |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0212         | 0x12           | BLE\_ERR\_INV\_HCI\_CMD\_PARMS     | Invalid HCI Command Parameters                                                 |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0213         | 0x13           | BLE\_ERR\_REM\_USER\_CONN\_TERM    | Remote User Terminated Connection                                              |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0214         | 0x14           | BLE\_ERR\_RD\_CONN\_TERM\_RESRCS   | Remote Device Terminated Connection due to Low Resources                       |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0215         | 0x15           | BLE\_ERR\_RD\_CONN\_TERM\_PWROFF   | Remote Device Terminated Connection due to Power Off                           |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0216         | 0x16           | BLE\_ERR\_CONN\_TERM\_LOCAL        | Connection Terminated By Local Host                                            |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0217         | 0x17           | BLE\_ERR\_REPEATED\_ATTEMPTS       | Repeated Attempts                                                              |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0218         | 0x18           | BLE\_ERR\_NO\_PAIRING              | Pairing Not Allowed                                                            |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0219         | 0x19           | BLE\_ERR\_UNK\_LMP                 | Unknown LMP PDU                                                                |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x021a         | 0x1a           | BLE\_ERR\_UNSUPP\_REM\_FEATURE     | Unsupported Remote Feature / Unsupported LMP Feature                           |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x021b         | 0x1b           | BLE\_ERR\_SCO\_OFFSET              | SCO Offset Rejected                                                            |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x021c         | 0x1c           | BLE\_ERR\_SCO\_ITVL                | SCO Interval Rejected                                                          |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x021d         | 0x1d           | BLE\_ERR\_SCO\_AIR\_MODE           | SCO Air Mode Rejected                                                          |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x021e         | 0x1e           | BLE\_ERR\_INV\_LMP\_LL\_PARM       | Invalid LMP Parameters / Invalid LL Parameters                                 |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x021f         | 0x1f           | BLE\_ERR\_UNSPECIFIED              | Unspecified Error                                                              |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0220         | 0x20           | BLE\_ERR\_UNSUPP\_LMP\_LL\_PARM    | Unsupported LMP Parameter Value / Unsupported LL Parameter Value               |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0221         | 0x21           | BLE\_ERR\_NO\_ROLE\_CHANGE         | Role Change Not Allowed                                                        |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0222         | 0x22           | BLE\_ERR\_LMP\_LL\_RSP\_TMO        | LMP Response Timeout / LL Response Timeout                                     |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0223         | 0x23           | BLE\_ERR\_LMP\_COLLISION           | LMP Error Transaction Collision                                                |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0224         | 0x24           | BLE\_ERR\_LMP\_PDU                 | LMP PDU Not Allowed                                                            |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0225         | 0x25           | BLE\_ERR\_ENCRYPTION\_MODE         | Encryption Mode Not Acceptable                                                 |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0226         | 0x26           | BLE\_ERR\_LINK\_KEY\_CHANGE        | Link Key cannot be Changed                                                     |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0227         | 0x27           | BLE\_ERR\_UNSUPP\_QOS              | Requested QoS Not Supported                                                    |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0228         | 0x28           | BLE\_ERR\_INSTANT\_PASSED          | Instant Passed                                                                 |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0229         | 0x29           | BLE\_ERR\_UNIT\_KEY\_PAIRING       | Pairing With Unit Key Not Supported                                            |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x022a         | 0x2a           | BLE\_ERR\_DIFF\_TRANS\_COLL        | Different Transaction Collision                                                |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x022c         | 0x2c           | BLE\_ERR\_QOS\_PARM                | QoS Unacceptable Parameter                                                     |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x022d         | 0x2d           | BLE\_ERR\_QOS\_REJECTED            | QoS Rejected                                                                   |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x022e         | 0x2e           | BLE\_ERR\_CHAN\_CLASS              | Channel Classification Not Supported                                           |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x022f         | 0x2f           | BLE\_ERR\_INSUFFICIENT\_SEC        | Insufficient Security                                                          |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0230         | 0x30           | BLE\_ERR\_PARM\_OUT\_OF\_RANGE     | Parameter Out Of Mandatory Range                                               |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0232         | 0x32           | BLE\_ERR\_PENDING\_ROLE\_SW        | Role Switch Pending                                                            |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0234         | 0x34           | BLE\_ERR\_RESERVED\_SLOT           | Reserved Slot Violation                                                        |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0235         | 0x35           | BLE\_ERR\_ROLE\_SW\_FAIL           | Role Switch Failed                                                             |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0236         | 0x36           | BLE\_ERR\_INQ\_RSP\_TOO\_BIG       | Extended Inquiry Response Too Large                                            |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0237         | 0x37           | BLE\_ERR\_SEC\_SIMPLE\_PAIR        | Secure Simple Pairing Not Supported By Host                                    |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0238         | 0x38           | BLE\_ERR\_HOST\_BUSY\_PAIR         | Host Busy - Pairing                                                            |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0239         | 0x39           | BLE\_ERR\_CONN\_REJ\_CHANNEL       | Connection Rejected due to No Suitable Channel Found                           |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x023a         | 0x3a           | BLE\_ERR\_CTLR\_BUSY               | Controller Busy                                                                |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x023b         | 0x3b           | BLE\_ERR\_CONN\_PARMS              | Unacceptable Connection Parameters                                             |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x023c         | 0x3c           | BLE\_ERR\_DIR\_ADV\_TMO            | Directed Advertising Timeout                                                   |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x023d         | 0x3d           | BLE\_ERR\_CONN\_TERM\_MIC          | Connection Terminated due to MIC Failure                                       |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x023e         | 0x3e           | BLE\_ERR\_CONN\_ESTABLISHMENT      | Connection Failed to be Established                                            |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x023f         | 0x3f           | BLE\_ERR\_MAC\_CONN\_FAIL          | MAC Connection Failed                                                          |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+| 0x0240         | 0x40           | BLE\_ERR\_COARSE\_CLK\_ADJ         | Coarse Clock Adjustment Rejected but Will Try to Adjust Using Clock Dragging   |
++----------------+----------------+------------------------------------+--------------------------------------------------------------------------------+
+
+Return codes - L2CAP
+^^^^^^^^^^^^^^^^^^^^
+
++----------------+----------------+----------------------------------------------+------------------------------------------------------+
+| NimBLE Value   | Formal Value   | Name                                         | Condition                                            |
++================+================+==============================================+======================================================+
+| 0x0300         | 0x00           | BLE\_L2CAP\_SIG\_ERR\_CMD\_NOT\_UNDERSTOOD   | Invalid or unsupported incoming L2CAP sig command.   |
++----------------+----------------+----------------------------------------------+------------------------------------------------------+
+| 0x0301         | 0x01           | BLE\_L2CAP\_SIG\_ERR\_MTU\_EXCEEDED          | Incoming packet too large.                           |
++----------------+----------------+----------------------------------------------+------------------------------------------------------+
+| 0x0302         | 0x02           | BLE\_L2CAP\_SIG\_ERR\_INVALID\_CID           | No channel with specified ID.                        |
++----------------+----------------+----------------------------------------------+------------------------------------------------------+
+
+Return codes - Security manager (us)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| NimBLE Value   | Formal Value   | Name                              | Condition                                                                                                                                 |
++================+================+===================================+===========================================================================================================================================+
+| 0x0401         | 0x01           | BLE\_SM\_ERR\_PASSKEY             | The user input of passkey failed, for example, the user cancelled the operation.                                                          |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0402         | 0x02           | BLE\_SM\_ERR\_OOB                 | The OOB data is not available.                                                                                                            |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0403         | 0x03           | BLE\_SM\_ERR\_AUTHREQ             | The pairing procedure cannot be performed as authentication requirements cannot be met due to IO capabilities of one or both devices.     |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0404         | 0x04           | BLE\_SM\_ERR\_CONFIRM\_MISMATCH   | The confirm value does not match the calculated compare value.                                                                            |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0405         | 0x05           | BLE\_SM\_ERR\_PAIR\_NOT\_SUPP     | Pairing is not supported by the device.                                                                                                   |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0406         | 0x06           | BLE\_SM\_ERR\_ENC\_KEY\_SZ        | The resultant encryption key size is insufficient for the security requirements of this device.                                           |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0407         | 0x07           | BLE\_SM\_ERR\_CMD\_NOT\_SUPP      | The SMP command received is not supported on this device.                                                                                 |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0408         | 0x08           | BLE\_SM\_ERR\_UNSPECIFIED         | Pairing failed due to an unspecified reason.                                                                                              |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0409         | 0x09           | BLE\_SM\_ERR\_REPEATED            | Pairing or authentication procedure is disallowed because too little time has elapsed since last pairing request or security request.     |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x040a         | 0x0a           | BLE\_SM\_ERR\_INVAL               | The Invalid Parameters error code indicates that the command length is invalid or that a parameter is outside of the specified range.     |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x040b         | 0x0b           | BLE\_SM\_ERR\_DHKEY               | Indicates to the remote device that the DHKey Check value received doesn’t match the one calculated by the local device.                  |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x040c         | 0x0c           | BLE\_SM\_ERR\_NUMCMP              | Indicates that the confirm values in the numeric comparison protocol do not match.                                                        |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x040d         | 0x0d           | BLE\_SM\_ERR\_ALREADY             | Indicates that the pairing over the LE transport failed due to a Pairing Request sent over the BR/EDR transport in process.               |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x040e         | 0x0e           | BLE\_SM\_ERR\_CROSS\_TRANS        | Indicates that the BR/EDR Link Key generated on the BR/EDR transport cannot be used to derive and distribute keys for the LE transport.   |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+
+Return codes - Security manager (peer)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| NimBLE Value   | Formal Value   | Name                              | Condition                                                                                                                                 |
++================+================+===================================+===========================================================================================================================================+
+| 0x0501         | 0x01           | BLE\_SM\_ERR\_PASSKEY             | The user input of passkey failed, for example, the user cancelled the operation.                                                          |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0502         | 0x02           | BLE\_SM\_ERR\_OOB                 | The OOB data is not available.                                                                                                            |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0503         | 0x03           | BLE\_SM\_ERR\_AUTHREQ             | The pairing procedure cannot be performed as authentication requirements cannot be met due to IO capabilities of one or both devices.     |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0504         | 0x04           | BLE\_SM\_ERR\_CONFIRM\_MISMATCH   | The confirm value does not match the calculated compare value.                                                                            |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0505         | 0x05           | BLE\_SM\_ERR\_PAIR\_NOT\_SUPP     | Pairing is not supported by the device.                                                                                                   |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0506         | 0x06           | BLE\_SM\_ERR\_ENC\_KEY\_SZ        | The resultant encryption key size is insufficient for the security requirements of this device.                                           |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0507         | 0x07           | BLE\_SM\_ERR\_CMD\_NOT\_SUPP      | The SMP command received is not supported on this device.                                                                                 |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0508         | 0x08           | BLE\_SM\_ERR\_UNSPECIFIED         | Pairing failed due to an unspecified reason.                                                                                              |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x0509         | 0x09           | BLE\_SM\_ERR\_REPEATED            | Pairing or authentication procedure is disallowed because too little time has elapsed since last pairing request or security request.     |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x050a         | 0x0a           | BLE\_SM\_ERR\_INVAL               | The Invalid Parameters error code indicates that the command length is invalid or that a parameter is outside of the specified range.     |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x050b         | 0x0b           | BLE\_SM\_ERR\_DHKEY               | Indicates to the remote device that the DHKey Check value received doesn’t match the one calculated by the local device.                  |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x050c         | 0x0c           | BLE\_SM\_ERR\_NUMCMP              | Indicates that the confirm values in the numeric comparison protocol do not match.                                                        |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x050d         | 0x0d           | BLE\_SM\_ERR\_ALREADY             | Indicates that the pairing over the LE transport failed due to a Pairing Request sent over the BR/EDR transport in process.               |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| 0x050e         | 0x0e           | BLE\_SM\_ERR\_CROSS\_TRANS        | Indicates that the BR/EDR Link Key generated on the BR/EDR transport cannot be used to derive and distribute keys for the LE transport.   |
++----------------+----------------+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+

docs/ble_sec.rst

@@ -0,0 +1,76 @@
+NimBLE Security
+---------------
+
+The Bluetooth Low Energy security model includes five distinct security
+concepts as listed below. For detailed specifications, see BLUETOOTH
+SPECIFICATION Version 4.2 [Vol 1, Part A].
+
+-  **Pairing**: The process for creating one or more shared secret keys.
+   In LE a single link key is generated by combining contributions from
+   each device into a link key used during pairing.
+
+-  **Bonding**: The act of storing the keys created during pairing for
+   use in subsequent connections in order to form a trusted device pair.
+
+-  **Device authentication**: Verification that the two devices have the
+   same keys (verify device identity)
+
+-  **Encryption**: Keeps message confidential. Encryption in Bluetooth
+   LE uses AES-CCM cryptography and is performed in the *Controller*.
+
+-  **Message integrity**: Protects against message forgeries.
+
+Bluetooth LE uses four association models depending on the I/O
+capabilities of the devices.
+
+-  **Just Works**: designed for scenarios where at least one of the
+   devices does not have a display capable of displaying a six digit
+   number nor does it have a keyboard capable of entering six decimal
+   digits.
+
+-  **Numeric Comparison**: designed for scenarios where both devices are
+   capable of displaying a six digit number and both are capable of
+   having the user enter "yes" or "no". A good example of this model is
+   the cell phone / PC scenario.
+
+-  **Out of Band**: designed for scenarios where an Out of Band
+   mechanism is used to both discover the devices as well as to exchange
+   or transfer cryptographic numbers used in the pairing process.
+
+-  **Passkey Entry**: designed for the scenario where one device has
+   input capability but does not have the capability to display six
+   digits and the other device has output capabilities. A good example
+   of this model is the PC and keyboard scenario.
+
+Key Generation
+~~~~~~~~~~~~~~
+
+Key generation for all purposes in Bluetooth LE is performed by the
+*Host* on each LE device independent of any other LE device.
+
+Privacy Feature
+~~~~~~~~~~~~~~~
+
+Bluetooth LE supports an optional feature during connection mode and
+connection procedures that reduces the ability to track a LE device over
+a period of time by changing the Bluetooth device address on a frequent
+basis.
+
+There are two variants of the privacy feature.
+
+-  In the first variant, private addresses are resolved and generated by
+   the *Host*.
+-  In the second variant, private addresses are resolved and generated
+   by the *Controller* without involving the Host after the Host
+   provides the Controller device identity information. The Host may
+   provide the Controller with a complete resolving list or a subset of
+   the resolving list. Device filtering becomes possible in the second
+   variant when address resolution is performed in the Controller
+   because the peer’s device identity address can be resolved prior to
+   checking whether it is in the white list.
+
+**Note**: When address resolution is performed exclusively in the Host,
+a device may experience increased power consumption because device
+filtering must be disabled. For more details on the privacy feature,
+refer to BLUETOOTH SPECIFICATION Version 4.2 [Vol 3, Part C] (Published
+02 December 2014), Page 592.

docs/ble_setup/ble_addr.rst

@@ -0,0 +1,63 @@
+Configure device address
+------------------------
+
+A BLE device needs an address to do just about anything. For information
+on the various types of Bluetooth addresses, see the `NimBLE Host
+Identity Reference :doc:`<../ble_hs/ble_hs_id/ble_hs_id>`.
+
+There are several methods for assigning an address to a NimBLE device.
+The available options are documented below:
+
+Method 1: Configure nRF hardware with a public address
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+When Mynewt is running on a Nordic nRF platform, the NimBLE controller
+will attempt to read a public address out of the board's FICR or UICR
+registers. The controller uses the following logic while trying to read
+an address from hardware:
+
+1. If the *DEVICEADDRTYPE* FICR register is written, read the address
+   programmed in the *DEVICEADDR[0]* and *DEVICEADDR[1]* FICR registers.
+2. Else if the upper 16 bits of the *CUSTOMER[1]* UICR register are 0,
+   read the address programmed in the *CUSTOMER[0]* and *CUSTOMER[1]*
+   UCI registers.
+3. Else, no address available.
+
+Method 2: Hardcode a public address in the Mynewt target
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The NimBLE controller package exports a
+:doc:`syscfg <../../../os/modules/sysinitconfig/sysinitconfig>` setting
+called ``BLE_PUBLIC_DEV_ADDR``. This setting can be overridden at the
+application or target level to configure a public Bluetooth address. For
+example, a target can assign the public address *11:22:33:44:55:66* as
+follows:
+
+::
+
+    syscfg.vals:
+        BLE_PUBLIC_DEV_ADDR: '(uint8_t[6]){0x66, 0x55, 0x44, 0x33, 0x22, 0x11}'
+
+This setting takes the form of a C expression. Specifically, the value
+is a designated initializer expressing a six-byte array. Also note that
+the bytes are reversed, as an array is inherently little-endian, while
+addresses are generally expressed in big-endian.
+
+Note: this method takes precedence over method 1. Whatever is written to
+the ``BLE_PUBLIC_DEV_ADDR`` setting is the address that gets used.
+
+Method 3: Configure a random address at runtime
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Random addresses get configured through the NimBLE host. The following
+two functions are used in random address configuration:
+
+-  :doc:`ble_hs_id_gen_rnd <../ble_hs/ble_hs_id/functions/ble_hs_id_gen_rnd>`:
+   Generates a new random address.
+-  :doc:`ble_hs_id_set_rnd <../ble_hs/ble_hs_id/functions/ble_hs_id_set_rnd>`:
+   Sets the device's random address.
+
+For an example of how this is done, see the :doc:`<../../../os/tutorials/ibeacon>`.
+
+*Note:* A NimBLE device can be configured with multiple addresses; at
+most one of each address type.

docs/ble_setup/ble_lp_clock.rst

@@ -0,0 +1,67 @@
+Configure clock for controller
+------------------------------
+
+The NimBLE stack uses OS cputime for scheduling various events inside
+controller. Since the code of controller is optimized to work with 32768
+Hz clock, the OS cputime has to be configured accordingly.
+
+To make things easier, controller package (``net/nimble/controller``)
+defines new system configuration setting ``BLE_LP_CLOCK`` as sets it to
+``1`` so other packages can be configured if necessary. The next section
+describes configuration required for controller to work properly.
+
+System configuration
+~~~~~~~~~~~~~~~~~~~~
+
+**Note:** All BSPs based on nRF5x have below settings automatically
+applied when ``BLE_LP_CLOCK`` is set, there is no need to configure this
+in application.
+
+The following things need to be configured for NimBLE controller to work
+properly:
+
+-  OS cputime frequency shall be set to ``32768``
+-  OS cputime timer source shall be set to 32768 Hz clock source
+-  Default 1 MHz clock source can be disabled if not used by application
+-  32768 Hz clock source shall be enabled
+-  Crystal settling time shall be set to non-zero value (see below)
+
+For example, on nRF52 platform timer 5 can be used as source for 32768
+Hz clock. Also, timer 0 can be disabled since this is the default source
+for OS cputime clock and is no longer used. The configuration will look
+as below:
+
+::
+
+    syscfg.vals:
+        OS_CPUTIME_FREQ: 32768
+        OS_CPUTIME_TIMER_NUM: 5
+        TIMER_0: 0
+        TIMER_5: 1
+        BLE_XTAL_SETTLE_TIME: 1500
+
+On nRF51 platform the only difference is to use timer 3 instead of timer
+5.
+
+On platforms without 32768 Hz crystal available it usually can be
+synthesized by setting ``XTAL_32768_SYNTH`` to ``1`` - this is also
+already configured in existing BSPs.
+
+Crystal settle time configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The configuration variable ``BLE_XTAL_SETTLE_TIME`` is used by the
+controller to turn on the necessary clock source(s) for the radio and
+associated peripherals prior to Bluetooth events (advertising, scanning,
+connections, etc). For the nRF5x platforms, the HFXO needs to be turned
+on prior to using the radio and the ``BLE_XTAL_SETTLE_TIME`` must be set
+to accommodate this time. The amount of time required is board
+dependent, so users must characterize their hardware and set
+``BLE_XTAL_SETTLE_TIME`` accordingly. The current value of 1500
+microseconds is a fairly long time and was intended to work for most, if
+not all, platforms.
+
+Note that changing this time will impact battery life with the amount
+depending on the application. The HFXO draws a fairly large amount of
+current when running so keeping this time as small as possible will
+reduce overall current drain.

docs/ble_setup/ble_setup_intro.rst

@@ -0,0 +1,13 @@
+NimBLE Setup
+------------
+
+Most NimBLE initialization is done automatically by
+:doc:`sysinit <../../../os/modules/sysinitconfig/sysinitconfig>`. This
+section documents the few bits of initialization that an application
+must perform manually.
+
+.. toctree::
+
+    ble_lp_clock
+    ble_addr
+    ble_sync_cb

docs/ble_setup/ble_sync_cb.rst

@@ -0,0 +1,80 @@
+Respond to *sync* and *reset* events
+------------------------------------
+
+sync
+~~~~
+
+The NimBLE stack is inoperable while the host and controller are out of
+sync. In a combined host-controller app, the sync happens immediately at
+startup. When the host and controller are separate, sync typically
+occurs in under a second after the application starts. An application
+learns when sync is achieved by configuring the host's *sync callback*:
+``ble_hs_cfg.sync_cb``. The host calls the sync callback whenever sync
+is acquired. The sync callback has the following form:
+
+.. code-block:: cpp
+
+    typedef void ble_hs_sync_fn(void);
+
+Because the NimBLE stack begins in the unsynced state, the application
+should delay all BLE operations until the sync callback has been called.
+
+reset
+~~~~~
+
+Another event indicated by the host is a *controller reset*. The NimBLE
+stack resets itself when a catastrophic error occurs, such as loss of
+communication between the host and controller. Upon resetting, the host
+drops all BLE connections and loses sync with the controller. After a
+reset, the application should refrain from using the host until sync is
+again signaled via the sync callback.
+
+An application learns of a host reset by configuring the host's *reset
+callback*: ``ble_hs_cfg.reset_cb``. This callback has the following
+form:
+
+.. code-block:: cpp
+
+    typedef void ble_hs_reset_fn(int reason);
+
+The ``reason`` parameter is a :doc:`NimBLE host return
+code <../ble_hs/ble_hs_return_codes>`.
+
+Example
+~~~~~~~
+
+The following example demonstrates the configuration of the sync and
+reset callbacks.
+
+.. code-block:: cpp
+
+    #include "sysinit/sysinit.h"
+    #include "console/console.h"
+    #include "host/ble_hs.h"
+
+    static void
+    on_sync(void)
+    {
+        /* Begin advertising, scanning for peripherals, etc. */
+    }
+
+    static void
+    on_reset(int reason)
+    {
+        console_printf("Resetting state; reason=%d\n", reason);
+    }
+
+    int
+    main(void)
+    {
+        /* Initialize all packages. */
+        sysinit();
+
+        ble_hs_cfg.sync_cb = on_sync;
+        ble_hs_cfg.reset_cb = on_reset;
+
+        /* As the last thing, process events from default event queue. */
+        while (1) {
+            os_eventq_run(os_eventq_dflt_get());
+        }
+    }

docs/btshell/btshell_GAP.rst

@@ -0,0 +1,660 @@
+GAP API for btshell
+===================
+
+Generic Access Profile (GAP) defines the generic procedures related to discovery of Bluetooth devices (idle mode
+procedures) and link management aspects of connecting to Bluetooth devices (connecting mode procedures). It also defines
+procedures related to use of different security levels.
+
+Several different modes and procedures may be performed simultaneously over an LE physical transport. The following
+modes and procedures are defined for use over an LE physical transport:
+
+1. **Broadcast mode and observation procedure**
+
+   -  These allow two devices to communicate in a unidirectional connectionless manner using the advertising events.
+
+2. **Discovery modes and procedures**
+
+   -  All devices shall be in either non-discoverable mode or one of the discoverable modes.
+   -  A device in the discoverable mode shall be in either the general discoverable mode or the limited discoverable mode.
+   -  A device in non-discoverable mode will not be discovered by any device that is performing either the general
+      discovery procedure or the limited discovery procedure.
+
+3. **Connection modes and procedures**
+
+   -  allow a device to establish a connection to another device.
+   -  allow updating of parameters of the connection
+   -  allow termination of the connection
+
+4. **Bonding modes and procedures**
+
+   -  Bonding allows two connected devices to exchange and store security and identity information to create a trusted
+      relationship.
+   -  Bonding can occur only between two devices in bondable mode.
+
+Available commands
+~~~~~~~~~~~~~~~~~~
+
+Parameters default values are marked red.
+
+Configuration
+-------------
+
++---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+
+| **Command**         | **Parmeters**   | \*\* Possible values\*\*   | **Description**                                                                                         |
++=====================+=================+============================+=========================================================================================================+
+| **set**             |                 |                            | Set configuration options                                                                               |
++---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+
+|                     | addr            | XX:XX:XX:XX:XX:XX          | Local device address                                                                                    |
++---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+
+|                     | addr\_type      | ``public``                 | Local device address type                                                                               |
++---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+
+|                     |                 | random                     | Use random address for scan requests                                                                    |
++---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+
+|                     | mtu             | [23-UINT16\_MAX]           | GATT Maximum Transmission Unit (MTU)                                                                    |
++---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+
+|                     | irk             | XX:XX:XX...                | Local Identity Resolving Key (16 byte                                                                   |
++---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+
+| **set-priv-mode**   |                 |                            | Set privacy mode for device                                                                             |
++---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+
+|                     | addr            | XX:XX:XX:XX:XX:XX          | Remote device address                                                                                   |
++---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+
+|                     | addr\_type      | ``public``                 | Remote device public address type                                                                       |
++---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+
+|                     |                 | random                     | Remote device random address type                                                                       |
++---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+
+|                     | mode            | [``0``-1]                  | 0 - use network privacy, 1 - use device privacy                                                         |
++---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+
+| **white-list**      |                 |                            | Add devices to white list (this command accepts multiple instances of addr and addr\_type parameters)   |
++---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+
+|                     | addr            | XX:XX:XX:XX:XX:XX          | Remote device address                                                                                   |
++---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+
+|                     | addr\_type      | ``public``                 | Remote device public address type                                                                       |
++---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+
+|                     |                 | random                     | Remote device random address type                                                                       |
++---------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------------------+
+
+Device discovery and connection
+-------------------------------
+
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+| **Command**              | **Parmeters**                  | \*\* Possible values\*\*   | **Description**                                                                                            |
++==========================+================================+============================+============================================================================================================+
+| **scan**                 |                                |                            | Discover remote devices                                                                                    |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | cancel                         |                            | cancel ongoing scan procedure                                                                              |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | extended                       | ``none``                   | Start legacy scan                                                                                          |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          |                                | 1M                         | Start extended scan on 1M PHY                                                                              |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          |                                | coded                      | Start extended scan on Coded PHY                                                                           |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          |                                | both                       | Start extended scan on both PHYs                                                                           |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | duration                       | [1-``INT32_MAX``],         | Duration of scan in milliseconds                                                                           |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | limited                        | [``0``-1]                  | Use limited discovery procedure                                                                            |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | passive                        | [``0``-1]                  | Use passive scan                                                                                           |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | interval                       | [``0``-UINT16\_MAX]        | Scan interval, if 0 use stack's default                                                                    |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | window                         | [``0``-UINT16\_MAX]        | Scan window, if 0 use stack's default                                                                      |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | filter                         | ``no_wl``                  | Scan filter policy - Accept all advertising packets                                                        |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          |                                | use\_wl                    | Accept only advertising packets from devices on White List                                                 |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          |                                | no\_wl\_inita              | Accept all advertising packets (including directed RPA)                                                    |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          |                                | use\_wl\_inita             | Accept only advertising packets from devices on White List (including directed RPA)                        |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | nodups                         | [``0``-1]                  | Disable duplicates filtering                                                                               |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | own\_addr\_type                | ``public``                 | Use public address for scan requests                                                                       |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          |                                | random                     | Use random address for scan requests                                                                       |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          |                                | rpa\_pub                   | Use RPA address for scan requests (fallback to public if no IRK)                                           |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          |                                | rpa\_rnd                   | Use RPA address for scan requests (fallback to random if no IRK)                                           |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | extended\_duration             | [``0``-UINT16\_MAX]        | Duration of extended scan in 10 milliseconds                                                               |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | extended\_period               | [``0``-UINT16\_MAX]        | Periodic scan interval in 1.28 seconds (0 disabled)                                                        |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | longrange\_interval            | [``0``-UINT16\_MAX]        | Scan interval for Coded Scan , if 0 use stack's default                                                    |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | longrange\_window              | [``0``-UINT16\_MAX]        | Scan window for Coded Scan , if 0 use stack's default                                                      |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | longrange\_passive             | [``0``-1]                  | Use passive scan for Coded Scan                                                                            |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+| **connect**              |                                |                            | Initiate connection to remote device                                                                       |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | cancel                         |                            | Cancel ongoing connection procedure                                                                        |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | extended                       | ``none``                   | Use legacy connection procedure                                                                            |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          |                                | 1M                         | Extended connect using 1M PHY scan parameters                                                              |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          |                                | coded                      | Extended connect using Coded PHY scan parameters                                                           |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          |                                | both                       | Extended connect using 1M and Coded PHYs scan parameters                                                   |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          |                                | all                        | Extended connect using 1M and Coded PHYs scan parameters (Provide also connection parameters for 2M PHY)   |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | peer\_addr\_type               | ``public``                 | Remote device public address type                                                                          |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          |                                | random                     | Remote device random address type                                                                          |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          |                                | public\_id                 | Remote device public address type (Identity)                                                               |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          |                                | random\_id                 | Remote device random address type (Identity)                                                               |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | peer\_addr                     | XX:XX:XX:XX:XX:XX          | Remote device address                                                                                      |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | own\_addr\_type                | ``public``                 | Use public address for scan requests                                                                       |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          |                                | random                     | Use random address for scan requests                                                                       |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          |                                | rpa\_pub                   | Use RPA address for scan requests (fallback to public if no IRK)                                           |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          |                                | rpa\_rnd                   | Use RPA address for scan requests (fallback to random if no IRK)                                           |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | duration                       | [``0``-INT32\_MAX]         | Connection attempt duration, if 0 use stack's default                                                      |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | scan\_interval                 | [0-UINT16\_MAX]            | Scan interval, default: 0x0010                                                                             |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | scan\_window                   | [0-UINT16\_MAX]            | Scan window, default: 0x0010                                                                               |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | interval\_min                  | [0-UINT16\_MAX]            | Minimum connection interval, default: 30                                                                   |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | interval\_max                  | [0-UINT16\_MAX]            | Maximum connection interval, default: 50                                                                   |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | latency                        | [UINT16]                   | Connection latency, default: 0                                                                             |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | timeout                        | [UINT16]                   | Connection timeout, default: 0x0100                                                                        |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | min\_conn\_event\_len          | [UINT16]                   | Minimum length of connection event, default: 0x0010                                                        |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | max\_conn\_event\_len          | [UINT16]                   | Maximum length of connection event, default: 0x0300                                                        |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | coded\_scan\_interval          | [0-UINT16\_MAX]            | Coded PHY Scan interval, default: 0x0010                                                                   |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | coded\_scan\_window            | [0-UINT16\_MAX]            | Coded PHY Scan window, default: 0x0010                                                                     |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | coded\_interval\_min           | [0-UINT16\_MAX]            | Coded PHY Minimum connection interval, default: 30                                                         |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | coded\_interval\_max           | [0-UINT16\_MAX]            | Coded PHY Maximum connection interval, default: 50                                                         |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | coded\_latency                 | [UINT16]                   | Coded PHY Connection latency, default: 0                                                                   |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | coded\_timeout                 | [UINT16]                   | Coded PHY Connection timeout, default: 0x0100                                                              |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | coded\_min\_conn\_event\_len   | [UINT16]                   | Coded PHY Minimum length of connection event, default: 0x0010                                              |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | coded\_max\_conn\_event\_len   | [UINT16]                   | Coded PHY Maximum length of connection event, default: 0x0300                                              |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | 2M\_scan\_interval             | [0-UINT16\_MAX]            | 2M PHY Scan interval, default: 0x0010                                                                      |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | 2M\_scan\_window               | [0-UINT16\_MAX]            | 2M PHY Scan window, default: 0x0010                                                                        |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | 2M\_interval\_min              | [0-UINT16\_MAX]            | 2M PHY Minimum connection interval, default: 30                                                            |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | 2M\_interval\_max              | [0-UINT16\_MAX]            | 2M PHY Maximum connection interval, default: 50                                                            |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | 2M\_latency                    | [UINT16]                   | 2M PHY Connection latency, default: 0                                                                      |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | 2M\_timeout                    | [UINT16]                   | 2M PHY Connection timeout, default: 0x0100                                                                 |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | 2M\_min\_conn\_event\_len      | [UINT16]                   | 2M PHY Minimum length of connection event, default: 0x0010                                                 |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | 2M\_max\_conn\_event\_len      | [UINT16]                   | 2M PHY Maximum length of connection event, default: 0x0300                                                 |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+| **disconnect**           |                                |                            | Disconnect exisiting connection                                                                            |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | conn                           | [UINT16]                   | Connection handle                                                                                          |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | reason                         | [UINT8]                    | Disconnect reason                                                                                          |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+| **show-addr**            |                                |                            | Show local public and random identity addresses                                                            |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+| **show-conn**            |                                |                            | Show current connections                                                                                   |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+| **conn-rssi**            |                                |                            | Obtain RSSI of specified connection                                                                        |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | conn                           | [UINT16]                   | Connection handle                                                                                          |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+| **conn-update-params**   |                                |                            | Update parameters of specified connection                                                                  |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | conn                           | [UINT16]                   | Connection handle                                                                                          |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | interval\_min                  | [0-UINT16\_MAX]            | Minimum connection interval, default: 30                                                                   |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | interval\_max                  | [0-UINT16\_MAX]            | Maximum connection interval, default: 50                                                                   |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | latency                        | [UINT16]                   | Connection latency, default: 0                                                                             |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | timeout                        | [UINT16]                   | Connection timeout, default: 0x0100                                                                        |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | min\_conn\_event\_len          | [UINT16]                   | Minimum length of connection event, default: 0x0010                                                        |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | max\_conn\_event\_len          | [UINT16]                   | Maximum length of connection event, default: 0x0300                                                        |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+| **conn-datalen**         |                                |                            | Set DLE parmaeters for connection                                                                          |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | conn                           | [UINT16]                   | Connection handle                                                                                          |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | octets                         | [UINT16]                   | Maximum transmission packet size                                                                           |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | time                           | [UINT16]                   | Maximum transmission packet time                                                                           |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+| **phy-set**              |                                |                            | Set prefered PHYs used for connection                                                                      |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | conn                           | [UINT16]                   | Connection handle                                                                                          |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | tx\_phys\_mask                 | [UINT8]                    | Prefered PHYs on TX is mask of following bits0x00 - no preference0x01 - 1M, 0x02 - 2M, 0x04 - Coded        |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | rx\_phys\_mask                 | [UINT8]                    | Prefered PHYs on RX is mask of following bits0x00 - no preference0x01 - 1M, 0x02 - 2M, 0x04 - Coded        |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | phy\_opts                      | [UINT16]                   | Options for Coded PHY 0 - any coding, 1 - prefer S2, 2 - prefer S8                                         |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+| **phy-set-default**      |                                |                            | Set default prefered PHYs used for new connection                                                          |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | tx\_phys\_mask                 | [UINT8]                    | Prefered PHYs on TX is mask of following bits0x00 - no preference0x01 - 1M, 0x02 - 2M, 0x04 - Coded        |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | rx\_phys\_mask                 | [UINT8]                    | Prefered PHYs on RX is mask of following bits0x00 - no preference0x01 - 1M, 0x02 - 2M, 0x04 - Coded        |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+| **phy-read**             |                                |                            | Read connection current PHY                                                                                |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | conn                           | [UINT16]                   | Connection handle                                                                                          |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+| **l2cap-update**         |                                |                            | Update connection parameters                                                                               |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | interval\_min                  | [0-UINT16\_MAX]            | Minimum connection interval, default: 30                                                                   |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | interval\_max                  | [0-UINT16\_MAX]            | Maximum connection interval, default: 50                                                                   |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | latency                        | [UINT16]                   | Connection latency, default: 0                                                                             |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+|                          | timeout                        | [UINT16]                   | Connection timeout, default: 0x0100                                                                        |
++--------------------------+--------------------------------+----------------------------+------------------------------------------------------------------------------------------------------------+
+
+Security
+--------
+
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+| **Command**               | **Parmeters**      | \*\* Possible values\*\*   | **Description**                                                                                                            |
++===========================+====================+============================+============================================================================================================================+
+| **security-set-data**     |                    |                            | Set security configuration                                                                                                 |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           | oob-flag           | [``0``-1]                  | Set Out-Of-Band (OOB) flag in Security Manager                                                                             |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           | mitm-flag          | [``0``-1]                  | Set Man-In-The-Middle (MITM) flag in Security Manager                                                                      |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           | io\_capabilities   | 0                          | Set Input-Output Capabilities to "DisplayOnly"                                                                             |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           |                    | 1                          | Set Input-Output Capabilities to "DisplayYesNo"                                                                            |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           |                    | 2                          | Set Input-Output Capabilities to "KeyboardOnly"                                                                            |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           |                    | 3                          | Set Input-Output Capabilities to "NoInputNoOutput"                                                                         |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           |                    | 4                          | Set Input-Output Capabilities to "KeyboardDisplay"                                                                         |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           | our\_key\_dist     | [UINT8]                    | Set Local Keys Distribution, this is a bit field of possible values: LTK (0x01), IRK (0x02), CSRK (0x04), LTK\_SC(0x08)    |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           | their\_key\_dist   | [UINT8]                    | Set Remote Keys Distribution, this is a bit field of possible values: LTK (0x01), IRK (0x02), CSRK (0x04), LTK\_SC(0x08)   |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           | bonding-flag       | [``0``-1]                  | Set Bonding flag in Security Manager                                                                                       |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           | sc-flag            | [``0``-1]                  | Set Secure Connections flag in Security Manager                                                                            |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+| **security-pair**         |                    |                            | Start pairing procedure                                                                                                    |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           | conn               | [UINT16]                   | Connection handle                                                                                                          |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+| **security-encryption**   |                    |                            | Start encryption procedure                                                                                                 |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           | conn               | [UINT16]                   | Connection handle                                                                                                          |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           | ediv               | [UINT16]                   | EDIV for LTK to use (use storage if not provided)                                                                          |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           | rand               | [UINT64]                   | Rand for LTK                                                                                                               |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           | ltk                | XX:XX:XX...                | LTK (16 bytes)                                                                                                             |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+| **security-start**        |                    |                            | Start security procedure (This starts either pairing or encryption depending if keys are stored)                           |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           | conn               | [UINT16]                   | Connection handle                                                                                                          |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+| **auth-passkey**          |                    |                            | Reply to Passkey request                                                                                                   |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           | conn               | [UINT16]                   | Connection handle                                                                                                          |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           | action             | [UINT16]                   | Action to reply (as received in event)                                                                                     |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           | key                | [0-999999]                 | Passkey to reply (Input or Display action)                                                                                 |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           | oob                | XX:XX:XX:...               | Out-Of-Band secret (16 bytes) (OOB action)                                                                                 |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+|                           | yesno              | Yy-Ny                      | Confirm passkey (for Passkey Confirm action)                                                                               |
++---------------------------+--------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
+
+Advertising with Extended Advertising enabled
+---------------------------------------------
+
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+| **Command**                  | **Parmeters**            | \*\* Possible values\*\*   | **Description**                                                                     |
++==============================+==========================+============================+=====================================================================================+
+| **advertise-configure**      |                          |                            | Configure new advertising instance                                                  |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | instance                 | [``0``-UINT8\_MAX]         | Advertising instance                                                                |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | connectable              | [``0``-1]                  | Use connectable advertising                                                         |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | scannable                | [``0``-1]                  | Use scannable advertising                                                           |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | peer\_addr\_type         | ``public``                 | Remote device public address type                                                   |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              |                          | random                     | Remote device random address type                                                   |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              |                          | public\_id                 | Remote device public address type (Identity)                                        |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              |                          | random\_id                 | Remote device random address type (Identity)                                        |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | peer\_addr               | XX:XX:XX:XX:XX:XX          | Remote device address - if provided perform directed advertising                    |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | own\_addr\_type          | ``public``                 | Use public address for scan requests                                                |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              |                          | random                     | Use random address for scan requests                                                |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              |                          | rpa\_pub                   | Use RPA address for scan requests (fallback to public if no IRK)                    |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              |                          | rpa\_rnd                   | Use RPA address for scan requests (fallback to random if no IRK)                    |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | channel\_map             | [``0``-UINT8\_MAX}         | Primary advertising channels map. If 0 use all channels.                            |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | filter                   | ``none``                   | Advertising filter policy - no filtering, no whitelist used                         |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              |                          | scan                       | process all connection requests but only scans from white list                      |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              |                          | conn                       | process all scan request but only connection requests from white list               |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              |                          | both                       | ignore all scan and connection requests unless in white list                        |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | interval\_min            | [``0``-UINT32\_MAX]        | Minimum advertising interval in 0.625 miliseconds If 0 use stack default.           |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | interval\_max            | [``0``-UINT32\_MAX]        | Maximum advertising interval in 0.625 miliseconds If 0 use stack default.           |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | rx\_power                | [-127 - ``127``]           | Advertising TX power in dBm                                                         |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | primary\_phy             | ``1M``                     | Use 1M PHY on primary advertising channels                                          |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              |                          | ``coded``                  | Use Coded PHY on primary advertising channels                                       |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | secondary\_phy           | ``1M``                     | Use 1M PHY on secondary advertising channels                                        |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              |                          | ``coded``                  | Use coded PHY on primary advertising channels                                       |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              |                          | ``2M``                     | Use 2M PHY on primary advertising channels                                          |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | sid                      | [``0``-16]                 | Adsertising instance SID                                                            |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | high\_duty               | [``0``-1]                  | Use high\_duty advertising                                                          |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | anonymous                | [``0``-1]                  | Use anonymous advertising                                                           |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | legacy                   | [``0``-1]                  | Use legacy PDUs for advertising                                                     |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | include\_tx\_power       | [``0``-1]                  | Include TX power information in advertising PDUs                                    |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | scan\_req\_notif         | [``0``-1]                  | Enable SCAN\_REQ notifications                                                      |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+| **advertise-set-addr**       |                          |                            | Configure *random* adress for instance                                              |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | instance                 | [``0``-UINT8\_MAX]         | Advertising instance                                                                |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | addr                     | XX:XX:XX:XX:XX:XX          | Random address                                                                      |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+| **advertise-set-adv-data**   |                          |                            | Configure advertising instance ADV\_DATA. This allow to configure following TLVs:   |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+| **advertise-set-scan-rsp**   |                          |                            | Configure advertising instance SCAN\_RSP. This allow to configure following TLVs:   |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | instance                 | [``0``-UINT8\_MAX]         | Advertising instance                                                                |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | flags                    | [``0``-UINT8\_MAX]         | Flags value                                                                         |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | uuid16                   | [UINT16]                   | 16-bit UUID value (can be passed multiple times)                                    |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | uuid16\_is\_complete     | [``0``-1]                  | I 16-bit UUID list is complete                                                      |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | uuid32                   | [UINT32]                   | 32-bit UUID value (can be passed multiple times)                                    |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | uuid32\_is\_complete     | [``0``-1]                  | I 32-bit UUID list is complete                                                      |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | uuid128                  | XX:XX:XX:...               | 128-bit UUID value (16 bytes) (can be passed multiple times)                        |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | uuid128\_is\_complete    | [``0``-1]                  | I 128-bit UUID list is complete                                                     |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | tx\_power\_level         | [-127 - 127]               | TX Power level to include                                                           |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | appearance               | [UINT16]                   | Appearance                                                                          |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | name                     | string                     | Name                                                                                |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | advertising\_interval    | [UINT16]                   | Advertising interval                                                                |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | service\_data\_uuid32    | XX:XX:XX:...               | 32-bit UUID service data                                                            |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | service\_data\_uuid128   | XX:XX:XX:...               | 128-bit UUID service data                                                           |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | uri                      | XX:XX:XX:...               | URI                                                                                 |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | msg\_data                | XX:XX:XX:...               | Manufacturer data                                                                   |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | eddystone\_url           | string                     | Eddystone with specified URL                                                        |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+| **advertise-start**          |                          |                            | Start advertising with configured instance                                          |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | instance                 | [``0``-UINT8\_MAX]         | Advertising instance                                                                |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | duration                 | [``0``-UINT16\_MAX]        | Advertising duration in 10ms units. 0 - forver                                      |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | max\_events              | [``0``-UINT8\_MAX]         | Maximum number of advertising events. 0 - no limit                                  |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+| **advertise-stop**           |                          |                            | Stop advertising                                                                    |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | instance                 | [``0``-UINT8\_MAX]         | Advertising instance                                                                |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+| **advertise-remove**         |                          |                            | Remove configured advertising instance                                              |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                              | instance                 | [``0``-UINT8\_MAX]         | Advertising instance                                                                |
++------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+
+Legacy Advertising with Extended Advertising disabled
+-----------------------------------------------------
+
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+| **Command**        | **Parmeters**            | \*\* Possible values\*\*   | **Description**                                                                     |
++====================+==========================+============================+=====================================================================================+
+| **advertise**      |                          |                            | Enable advertising                                                                  |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | stop                     |                            | Stop enabled advertising                                                            |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | conn                     | ``und``                    | Connectable mode: undirected                                                        |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    |                          | non                        | non-connectable                                                                     |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    |                          | dir                        | directed                                                                            |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | discov                   | ``gen``                    | Discoverable mode: general discoverable                                             |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    |                          | ltd                        | limited discoverable                                                                |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    |                          | non                        | non-discoverable                                                                    |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | scannable                | [``0``-1]                  | Use scannable advertising                                                           |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | peer\_addr\_type         | ``public``                 | Remote device public address type                                                   |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    |                          | random                     | Remote device random address type                                                   |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    |                          | public\_id                 | Remote device public address type (Identity)                                        |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    |                          | random\_id                 | Remote device random address type (Identity)                                        |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | peer\_addr               | XX:XX:XX:XX:XX:XX          | Remote device address - if provided perform directed advertising                    |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | own\_addr\_type          | ``public``                 | Use public address for scan requests                                                |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    |                          | random                     | Use random address for scan requests                                                |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    |                          | rpa\_pub                   | Use RPA address for scan requests (fallback to public if no IRK)                    |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    |                          | rpa\_rnd                   | Use RPA address for scan requests (fallback to random if no IRK)                    |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | channel\_map             | [``0``-UINT8\_MAX}         | Primary advertising channels map. If 0 use all channels.                            |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | filter                   | ``none``                   | Advertising filter policy - no filtering, no whitelist used                         |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    |                          | scan                       | process all connection requests but only scans from white list                      |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    |                          | conn                       | process all scan request but only connection requests from white list               |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    |                          | both                       | ignore all scan and connection requests unless in white list                        |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | interval\_min            | [``0``-UINT32\_MAX]        | Minimum advertising interval in 0.625 miliseconds If 0 use stack default.           |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | interval\_max            | [``0``-UINT32\_MAX]        | Maximum advertising interval in 0.625 miliseconds If 0 use stack default.           |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | high\_duty               | [``0``-1]                  | Use high\_duty advertising                                                          |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | duration                 | [``1``-INT32\_MAX]         | Advertising duration in ms                                                          |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+| **set-adv-data**   |                          |                            | Configure advertising instance ADV\_DATA. This allow to configure following TLVs:   |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+| **set-scan-rsp**   |                          |                            | Configure advertising instance SCAN\_RSP. This allow to configure following TLVs:   |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | flags                    | [``0``-UINT8\_MAX]         | Flags value                                                                         |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | uuid16                   | [UINT16]                   | 16-bit UUID value (can be passed multiple times)                                    |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | uuid16\_is\_complete     | [``0``-1]                  | I 16-bit UUID list is complete                                                      |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | uuid32                   | [UINT32]                   | 32-bit UUID value (can be passed multiple times)                                    |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | uuid32\_is\_complete     | [``0``-1]                  | I 32-bit UUID list is complete                                                      |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | uuid128                  | XX:XX:XX:...               | 128-bit UUID value (16 bytes) (can be passed multiple times)                        |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | uuid128\_is\_complete    | [``0``-1]                  | I 128-bit UUID list is complete                                                     |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | tx\_power\_level         | [-127 - 127]               | TX Power level to include                                                           |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | appearance               | [UINT16]                   | Appearance                                                                          |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | name                     | string                     | Name                                                                                |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | advertising\_interval    | [UINT16]                   | Advertising interval                                                                |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | service\_data\_uuid32    | XX:XX:XX:...               | 32-bit UUID service data                                                            |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | service\_data\_uuid128   | XX:XX:XX:...               | 128-bit UUID service data                                                           |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | uri                      | XX:XX:XX:...               | URI                                                                                 |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | msg\_data                | XX:XX:XX:...               | Manufacturer data                                                                   |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+|                    | eddystone\_url           | string                     | Eddystone with specified URL                                                        |
++--------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
+
+L2CAP Connection Oriented Channels
+----------------------------------
+
++---------------------------+-----------------+----------------------------+----------------------------------------------------+
+| **Command**               | **Parmeters**   | \*\* Possible values\*\*   | **Description**                                    |
++===========================+=================+============================+====================================================+
+| **l2cap-create-server**   |                 |                            | Create L2CAP server                                |
++---------------------------+-----------------+----------------------------+----------------------------------------------------+
+|                           | psm             | [UINT16]                   | PSM                                                |
++---------------------------+-----------------+----------------------------+----------------------------------------------------+
+| **l2cap-connect**         |                 |                            | Connect to remote L2CAP server                     |
++---------------------------+-----------------+----------------------------+----------------------------------------------------+
+|                           | conn            | [UINT16]                   | Connection handle                                  |
++---------------------------+-----------------+----------------------------+----------------------------------------------------+
+|                           | psm             | [UINT16]                   | PSM                                                |
++---------------------------+-----------------+----------------------------+----------------------------------------------------+
+| **l2cap-disconnect**      |                 |                            | Disconnec from L2CAP server                        |
++---------------------------+-----------------+----------------------------+----------------------------------------------------+
+|                           | conn            | [UINT16]                   | Connection handle                                  |
++---------------------------+-----------------+----------------------------+----------------------------------------------------+
+|                           | idx             | [UINT16]                   | L2CAP connection oriented channel identifier       |
++---------------------------+-----------------+----------------------------+----------------------------------------------------+
+| **l2cap-send**            |                 |                            | Send data over connected L2CAP channel             |
++---------------------------+-----------------+----------------------------+----------------------------------------------------+
+|                           | conn            | [UINT16]                   | Connection handle                                  |
++---------------------------+-----------------+----------------------------+----------------------------------------------------+
+|                           | idx             | [UINT16]                   | L2CAP connection oriented channel identifier       |
++---------------------------+-----------------+----------------------------+----------------------------------------------------+
+|                           | bytes           | [UINT16]                   | Number of bytes to send (hardcoded data pattern)   |
++---------------------------+-----------------+----------------------------+----------------------------------------------------+
+| **l2cap-show-coc**        |                 |                            | Show connected L2CAP channels                      |
++---------------------------+-----------------+----------------------------+----------------------------------------------------+
+
+Keys storage
+------------
+
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+| **Command**         | **Parmeters**   | \*\* Possible values\*\*   | **Description**                                    |
++=====================+=================+============================+====================================================+
+| **keystore-add**    |                 |                            | Add keys to storage                                |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     | type            | msec                       | Master Key                                         |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     |                 | ssec                       | Slave Key                                          |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     |                 | cccd                       | Client Characteristic Configuration Descriptor     |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     | addr            | XX:XX:XX:XX:XX:XX          | Device address                                     |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     | addr\_type      | ``public``                 | Device address type                                |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     |                 | random                     | Use random address for scan requests               |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     | ediv            | [UINT16]                   | EDIV for LTK to add                                |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     | rand            | [UINT64]                   | Rand for LTK                                       |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     | ltk             | XX:XX:XX...                | LTK (16 bytes)                                     |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     | irk             | XX:XX:XX...                | Identity Resolving Key (16 bytes)                  |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     | csrk            | XX:XX:XX...                | Connection Signature Resolving Key (16 bytes)      |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+| **keystore-del**    |                 |                            | Delete keys from storage                           |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     | type            | msec                       | Master Key                                         |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     |                 | ssec                       | Slave Key                                          |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     |                 | cccd                       | Client Characteristic Configuration Descriptor     |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     | addr            | XX:XX:XX:XX:XX:XX          | Device address                                     |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     | addr\_type      | ``public``                 | Device address type                                |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     |                 | random                     | Use random address for scan requests               |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     | ediv            | [UINT16]                   | EDIV for LTK to remove                             |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     | rand            | [UINT64]                   | Rand for LTK                                       |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+| **keystore-show**   |                 |                            | Show stored keys                                   |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     | type            | msec                       | Master Keys                                        |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     |                 | ssec                       | Slave Keys                                         |
++---------------------+-----------------+----------------------------+----------------------------------------------------+
+|                     |                 | cccd                       | Client Characteristic Configuration Descriptor s   |
++---------------------+-----------------+----------------------------+----------------------------------------------------+

docs/btshell/btshell_GATT.rst

@@ -0,0 +1,108 @@
+GATT feature API for btshell
+============================
+
+GATT(GENERIC ATTRIBUTE PROFILE) describes a service framework using the Attribute Protocol for discovering services,
+and for reading and writing characteristic values on a peer device. There are 11 features defined in the GATT Profile,
+and each of the features is mapped to procedures and sub-procedures:
+
+Available commands
+~~~~~~~~~~~~~~~~~~
+
+Parameters default values (if applicable) are marked red.
+
+Configuration
+-------------
+
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+| **Command**                        | **Parmeters**   | \*\* Possible values\*\*   | **Description**                                           |
++====================================+=================+============================+===========================================================+
+| **gatt-discover-characteristic**   |                 |                            | Discover GATT characteristics                             |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | conn            | [UINT16]                   | Connection handle                                         |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | uuid            | [UINT16]                   | Characteristic UUID                                       |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | start           | [UINT16]                   | Discovery start handle                                    |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | end             | [UINT16]                   | Discovery end handle                                      |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+| **gatt-discover-descriptor**       |                 |                            | Discover GATT descriptors                                 |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | conn            | [UINT16]                   | Connection handle                                         |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | start           | [UINT16]                   | Discovery start handle                                    |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | end             | [UINT16]                   | Discovery end handle                                      |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+| **gatt-discover-service**          |                 |                            | Discover services                                         |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | conn            | [UINT16]                   | Connection handle                                         |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | uuid16          | [UINT16]                   | Service UUID                                              |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+| **gatt-discover-full**             |                 |                            | Discover services, characteristic and descriptors         |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | conn            | [UINT16]                   | Connection handle                                         |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+| **gatt-find-included-services**    |                 |                            | Find included services                                    |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | conn            | [UINT16]                   | Connection handle                                         |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | start           | [UINT16]                   | Discovery start handle                                    |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | end             | [UINT16]                   | Discovery end handle                                      |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+| **gatt-exchange-mtu**              |                 |                            | Initiate ATT MTU exchange procedure                       |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | conn            | [UINT16]                   | Connection handle                                         |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+| **gatt-read**                      |                 |                            | Read attribute                                            |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | conn            | [UINT16]                   | Connection handle                                         |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | long            | [``0``-1]                  | Long read                                                 |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | attr            | [UINT16]                   | Attribute handle                                          |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | offset          | [UINT16]                   | Long read offset value                                    |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | uuid            | [UINT16]                   | Characteristic UUID                                       |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | start           | [UINT16]                   | Discovery start handle                                    |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | end             | [UINT16]                   | Discovery end handle                                      |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+| **gatt-notify**                    |                 |                            | Send notification or indication to all subscribed peers   |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | attr            | [UINT16]                   | Attribute handle                                          |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+| **gatt-service-changed**           |                 |                            | Send Services Changed notification                        |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | start           | [UINT16]                   | Start handle                                              |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | end             | [UINT16]                   | End handle                                                |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+| **gatt-service-visibility**        |                 |                            | Set service visibility                                    |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | handle          | [UINT16]                   | Service handle                                            |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | visibility      | [``0``-1]                  | Service visibility                                        |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+| **gatt-show**                      |                 |                            | Show remote devices discovered databases structure        |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+| **gatt-show-local**                |                 |                            | Show local database structure                             |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+| **gatt-write**                     |                 |                            | Write attribute                                           |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | conn            | [UINT16]                   | Connection handle                                         |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | no\_rsp         | [``0``-1]                  | Use Write Without Response                                |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | long            | [``0``-1]                  | Use Long Write procedure                                  |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | attr            | [UINT16]                   | Attribute handle                                          |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | offset          | [UINT16]                   | Long write offset value                                   |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+
+|                                    | value           | XX:XX:XX...                | Data to write                                             |
++------------------------------------+-----------------+----------------------------+-----------------------------------------------------------+

docs/btshell/btshell_advdata.rst

@@ -0,0 +1,47 @@
+Advertisement Data Fields
+-------------------------
+
+This part defines the advertisement data fields used in the ``btshell`` app. For a complete list of all data types and
+formats used for Extended Inquiry Response (EIR), Advertising Data (AD), and OOB data blocks, refer to the Supplement
+to the Bluetooth Core Specification, CSSv6, available for download
+`here <https://www.bluetooth.org/DocMan/handlers/DownloadDoc.ashx?doc_id=302735&_ga=1.133090766.1368218946.1444779486>`__.
+
++---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
+| **Name**                  | **Definition**                                      | **Details**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | **btshell Notes**                            |
++===========================+=====================================================+===========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+==============================================+
+| flags                     | Indicates basic information about the advertiser.   | Flags used over the LE physical channel are: \* Limited Discoverable Mode \* General Discoverable Mode \* BR/EDR Not Supported \* Simultaneous LE and BR/EDR to Same Device Capable (Controller) \* Simultaneous LE and BR/EDR to Same Device Capable (Host)                                                                                                                                                                                                                                                                                                                                                                                                                              | NimBLE will auto-calculate if set to 0.      |
++---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
+| uuid16                    | 16-bit Bluetooth Service UUIDs                      | Indicates the Service UUID list is incomplete i.e. more 16-bit Service UUIDs available. 16 bit UUIDs shall only be used if they are assigned by the Bluetooth SIG.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Set repeatedly for multiple service UUIDs.   |
++---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
+| uuid16\_is\_complete      | 16-bit Bluetooth Service UUIDs                      | Indicates the Service UUID list is complete. 16 bit UUIDs shall only be used if they are assigned by the Bluetooth SIG.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                              |
++---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
+| uuid32                    | 32-bit Bluetooth Service UUIDs                      | Indicates the Service UUID list is incomplete i.e. more 32-bit Service UUIDs available. 32 bit UUIDs shall only be used if they are assigned by the Bluetooth SIG.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Set repeatedly for multiple service UUIDs.   |
++---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
+| uuid32\_is\_complete      | 32-bit Bluetooth Service UUIDs                      | Indicates the Service UUID list is complete. 32 bit UUIDs shall only be used if they are assigned by the Bluetooth SIG.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                              |
++---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
+| uuid128                   | Global 128-bit Service UUIDs                        | More 128-bit Service UUIDs available.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | Set repeatedly for multiple service UUIDs.   |
++---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
+| uuid128\_is\_complete     | Global 128-bit Service UUIDs                        | Complete list of 128-bit Service UUIDs                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                              |
++---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
+| tx\_power\_level          | TX Power Level                                      | Indicates the transmitted power level of the packet containing the data type. The TX Power Level data type may be used to calculate path loss on a received packet using the following equation: pathloss = Tx Power Level – RSSI where “RSSI” is the received signal strength, in dBm, of the packet received.                                                                                                                                                                                                                                                                                                                                                                           | NimBLE will auto-calculate if set to -128.   |
++---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
+| slave\_interval\_range    | Slave Connection Interval Range                     | Contains the Peripheral’s preferred connection interval range, for all logical connections. Size: 4 Octets . The first 2 octets defines the minimum value for the connection interval in the following manner: connIntervalmin = Conn\_Interval\_Min \* 1.25 ms Conn\_Interval\_Min range: 0x0006 to 0x0C80 Value of 0xFFFF indicates no specific minimum. The other 2 octets defines the maximum value for the connection interval in the following manner: connIntervalmax = Conn\_Interval\_Max \* 1.25 ms Conn\_Interval\_Max range: 0x0006 to 0x0C80 Conn\_Interval\_Max shall be equal to or greater than the Conn\_Interval\_Min. Value of 0xFFFF indicates no specific maximum.   |                                              |
++---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
+| service\_data\_uuid16     | Service Data - 16 bit UUID                          | Size: 2 or more octets The first 2 octets contain the 16 bit Service UUID followed by additional service data                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                              |
++---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
+| public\_target\_address   | Public Target Address                               | Defines the address of one or more intended recipients of an advertisement when one or more devices were bonded using a public address. This data type shall exist only once. It may be sent in either the Advertising or Scan Response data, but not both.                                                                                                                                                                                                                                                                                                                                                                                                                               |                                              |
++---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
+| appearance                | Appearance                                          | Defines the external appearance of the device. The Appearance data type shall exist only once. It may be sent in either the Advertising or Scan Response data, but not both.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                              |
++---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
+| advertising\_interval     | Advertising Interval                                | Contains the advInterval value as defined in the Core specification, Volume 6, Part B, Section 4.4.2.2.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                              |
++---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
+| service\_data\_uuid32     | Service Data - 32 bit UUID                          | Size: 4 or more octets The first 4 octets contain the 32 bit Service UUID followed by additional service data                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                              |
++---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
+| service\_data\_uuid128    | Service Data - 128 bit UUID                         | Size: 16 or more octets The first 16 octets contain the 128 bit Service UUID followed by additional service data                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                              |
++---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
+| uri                       | Uniform Resource Identifier (URI)                   | Scheme name string and URI as a UTF-8 string                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                              |
++---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
+| mfg\_data                 | Manufacturer Specific data                          | Size: 2 or more octets The first 2 octets contain the Company Identifier Code followed by additional manufacturer specific data                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                              |
++---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+
+| eddystone\_url            |                                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                              |
++---------------------------+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+

docs/btshell/btshell_api.rst

@@ -0,0 +1,153 @@
+API for btshell app
+-------------------
+
+"btshell" is one of the sample applications that come with Mynewt. It is a shell application which provides a basic
+interface to the host-side of the BLE stack. "btshell" includes all the possible roles (Central/Peripheral) and they may
+be run simultaneously. You can run btshell on a board and issue commands that make it behave as a central or a peripheral
+with different peers.
+
+**btshell** is a new application that uses shell subsystem introduced in Mynewt 1.1 and has updated commands and
+parameters names. Thanks to support for tab completion commands names are more descriptive and self-explanatory
+without requiring extensive typing.
+
+Highlighted below are some of the ways you can use the API to establish connections and discover services and
+characteristics from peer devices. For descriptions of the full API, go to the next sections on
+:doc:`btshell_GAP` and :doc:`btshell_GATT`.
+
+.. contents::
+   :local:
+   :depth: 2
+
+.. toctree::
+   :hidden:
+   :titlesonly:
+
+   GAP <btshell_GAP>
+   GATT <btshell_GATT>
+   btshell_advdata
+
+Set device address.
+~~~~~~~~~~~~~~~~~~~
+
+On startup, btshell has the following identity address configuration:
+
+-  Public address: None
+-  Random address: None
+
+The below ``set`` commands can be used to change the address configuration:
+
+::
+
+    set addr_type=public addr=<device-address>
+    set addr_type=random addr=<device-address>
+
+For example:
+
+::
+
+    set addr_type=public addr=01:02:03:04:05:06
+    set addr_type=random addr=c1:aa:bb:cc:dd:ee
+
+The address configuration can be viewed with the ``gatt-show-addr`` command, as follows:
+
+::
+
+    gatt-show-addr
+    public_id_addr=01:02:03:04:05:06 random_id_addr=c1:aa:bb:cc:dd:ee
+
+Initiate a direct connection to a device
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In this case, your board is acting as a central and initiating a connection with another BLE device. The example
+assumes you know the address of the peer, either by scanning for available peers or because you have set up the peer
+yourself.
+
+.. code-block:: none
+    :emphasize-lines: 1
+
+    connect peer_addr=d4:f5:13:53:d2:43
+    connection established; handle=1 our_ota_addr_type=0 our_ota_addr=0a:0b:0c:0d:0e:0f out_id_addr_type=0 our_id_addr=0a:0b:0c:0d:0e:0f peer_addr_type=0 peer_addr=43:d2:53:13:f5:d4 conn_itvl=40 conn_latency=0 supervision_timeout=256 encrypted=0 authenticated=0 bonded=0
+
+The ``handle=1`` in the output indicates that it is connection-1.
+
+Configure advertisements to include device name
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In this case, your board is acting as a peripheral.
+
+With Extended Advertising enabled (should be executed after advertise-configure):
+
+::
+
+    advertise-set-adv-data name=<your-device-name>
+
+With Extended Advertising disabled:
+
+::
+
+    set-adv-data name=<your-device-name>
+
+Begin sending undirected general advertisements
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In this case, your board is acting as a peripheral.
+
+With Extended Advertising enabled:
+
+::
+
+    advertise-configure connectable=1 legacy=1 scannable=1
+    advertise-start
+
+With Extended Advertising disabled:
+
+::
+
+    advertise conn=und discov=gen
+
+Show established connections.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+    gatt-show-conn
+
+Discover and display peer's services, characteristics, and descriptors.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This is how you discover and then display the services of the peer you established earlier across connection-1.
+
+.. code-block:: none
+    :emphasize-lines: 1,2
+
+    gatt-discover-full conn=1
+    gatt-show
+    [ts=132425ssb, mod=64 level=2] CONNECTION: handle=1 addr=d4:f5:13:53:d2:43
+    [ts=132428ssb, mod=64 level=2]     start=1 end=5 uuid=0x1800
+    [ts=132433ssb, mod=64 level=2]     start=6 end=16 uuid=0x1808
+    [ts=132437ssb, mod=64 level=2]     start=17 end=31 uuid=0x180a
+    [ts=132441ssb, mod=64 level=2]     start=32 end=65535 uuid=00000000-0000-1000-1000000000000000
+
+
+Read an attribute belonging to the peer
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+    gatt-read conn=1 attr=21
+
+Write to an attribute belonging to the peer
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+    gatt-write conn=1 attr=3 value=0x01:0x02:0x03
+
+Perform a passive scan
+~~~~~~~~~~~~~~~~~~~~~~
+
+This is how you tell your board to listen to all advertisements around it. The duration is specified in ms.
+
+::
+
+    scan duration=1000 passive=1 filter=no_wl

docs/conf.py

@@ -0,0 +1,177 @@
+# -*- coding: utf-8 -*-
+#
+# Mynewt documentation build configuration file, created by
+# sphinx-quickstart on Tue Jan 10 11:33:44 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('_ext'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc', 'breathe', 'sphinx.ext.todo',
+    'sphinx.ext.extlinks'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = []
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'NimBLE Bluetooth Stack'
+copyright = u'Copyright © 2018 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.'
+author = u'The Apache Software Foundation'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u'1.0'
+# The full version, including alpha/beta/rc tags.
+release = u'1.0.0-b1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'README.rst', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+highlight_language = 'none'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+
+html_theme = 'alabaster'
+html_theme_path = []
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',
+        'searchbox.html',
+        'donate.html',
+    ]
+}
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+html_theme_options = {
+}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = []
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Mynewtdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'Mynewt.tex', u'NimBLE Bluetooth Stack',
+     u'The Apache Software Foundation', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'mynewt', u'Mynewt Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'Mynewt', u'NimBLE Bluetooth Stack',
+     author, 'Mynewt', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+breathe_projects = {
+    "mynewt": "_build/xml"
+}
+breathe_default_project = "mynewt"
+breathe_domain_by_extension = {
+    "h" : "c",
+}

docs/index.rst

@@ -0,0 +1,122 @@
+BLE User Guide
+----------------
+
+Apache Mynewt offers the world's first fully open-source Bluetooth Low
+Energy (BLE) or Bluetooth Smart stack fully compliant with Bluetooth 5
+specifications with support for Bluetooth Mesh. It is called NimBLE.
+
+BLE technology operates in the unlicensed industrial, scientific and
+medical (ISM) band at 2.4 to 2.485 GHz which is available in most
+countries. It uses a spread spectrum, frequency hopping, full-duplex
+signal. BLE FHSS employs 40 2-MHz-wide channels to ensure greater
+reliability over longer distances. It also features 0-dBm (1 mW) power
+output and a typical maximum range of 50 meters. With Bluetooth 5
+specification range can be increased 4 times and speed 2 time.
+
+.. toctree::
+   :hidden:
+   :titlesonly:
+
+   ble_sec
+   ble_setup/ble_setup_intro
+   ble_hs/ble_hs
+   btshell Usage API <btshell/btshell_api>
+   mesh/index
+
+.. contents::
+    :local:
+    :depth: 2
+
+Note that BLE is not compatible with standard Bluetooth.
+
+Features
+~~~~~~~~
+
+NimBLE complies with Bluetooth Core Specification 5.0 which makes it an
+ideal wireless technology for the Internet of Things (IoT).
+
+-  LE Advertising Extensions
+-  2Msym/s PHY for higher throughput
+-  Coded PHY for LE Long Range
+-  High Duty Cycle Non-Connectable Advertising
+-  Channel Selection Algorithm #2 to utilize channels in more efficient
+   way.
+-  LE Privacy 1.2 for frequent changes to the device address to make it
+   difficult to track for outsiders
+-  LE Secure Connections featuring FIPS-compliant algorithms.
+-  LE Data Length Extension for higher throughput
+-  **Coming Soon**: Assigning an Internet Protocol (IP) address
+   (complaint with the IPv6 or 6LoWPAN standard) to a Bluetooth device
+   through Internet Protocol Support Profile (IPSP)
+
+The Bluetooth 5 is backward compatible with previous Bluetooth version
+4.2 which is also supported by Apache Mynewt.
+
+Bluetooth Mesh features
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Bluetooth Mesh is a great addition to and opens a wide range of new
+possibilities for the IoT connectivity space. NimBLE fully supports the
+following Bluetooth Mesh features:
+
+-  Advertising and GATT bearers
+-  PB-GATT and PB-ADV provisioning
+-  Foundation Models (server role)
+-  Relay support
+-  GATT Proxy
+
+Components
+~~~~~~~~~~
+
+A Bluetooth low energy stack (NimBLE included) consists of two
+components with several subcomponents:
+
+-  **Controller**
+
+   -  **Physical Layer**: adaptive frequency-hopping Gaussian Frequency
+      Shift Keying (GFSK) radio using 40 RF channels (0-39), with 2 MHz
+      spacing.
+   -  **Link Layer**: with one of five states (Standby, Advertising,
+      Scanning, Initiating, Connection states) active at any time
+
+-  **Host**
+
+   -  **Logical Link Control and Adaptation Protocol (L2CAP)**: provides
+      logical channels, named L2CAP channels, which are multiplexed over
+      one or more logical links to provide packet segmentation and
+      reassembly, flow control, error control, streaming, QoS etc.
+   -  **Security Manager (SM)**: uses Security Manager Protocol (SMP)
+      for pairing and transport specific key distribution for securing
+      radio communication
+   -  **Attribute protocol (ATT)**: allows a device (*Server*) to expose
+      certain pieces of data, known as *Attributes*, to another device
+      (*Client*)
+   -  **Generic Attribute Profile (GATT)**: a framework for using the
+      ATT protocol to exchange attributes encapsulated as
+      *Characteristics* or *Services*
+   -  **Generic Access Profile (GAP)**: a base profile which all
+      Bluetooth devices implement, which in the case of LE, defines the
+      Physical Layer, Link Layer, L2CAP, Security Manager, Attribute
+      Protocol and Generic Attribute Profile.
+   -  **Host Controller Interface (HCI)**: the interface between the
+      host and controller either through software API or by a hardware
+      interface such as SPI, UART or USB.
+
+Subsequent chapters in this manual will go into the details of the
+implementation of each component, APIs available, and things to consider
+while designing a NimBLE app.
+
+Example NimBLE projects
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Mynewt comes with two built-in projects that allow users to play with
+NimBLE, try the tutorials out with, and see how to use available
+services.
+
+1. **btshell** : A simple shell application which provides a basic
+   interface to the host-side of the BLE stack.
+2. **bleprph**: A basic peripheral device with no user interface. It
+   advertises automatically on startup, and resumes advertising whenever
+   a connection is terminated. It supports a maximum of one connection.
+3. **blemesh**: A sample application for Bluetooth Mesh Node using
+   on/off model.

docs/mesh/index.rst

@@ -0,0 +1,95 @@
+Bluetooth Mesh
+--------------
+
+.. toctree::
+   :hidden:
+   :titlesonly:
+
+   sample
+
+.. contents::
+   :local:
+   :depth: 2
+
+Introduction to Mesh
+~~~~~~~~~~~~~~~~~~~~
+
+Bluetooth Mesh is a new standard from Bluetooth SIG that was released in 2017. It enables many-to-many device
+communication (as opposed to point-to-point approach in BLE) and is optimised for large-scale networks like building
+automation or sensors network. It utilizes managed flood based approach where only mains-powered nodes relay messages
+making it very power efficient (battery powered low-power nodes that don't relay messages can operate in mesh network for years).
+
+Bluetooth Mesh is complementary to Bluetooth specification and requires features from 4.0 release only. This allows
+deployment of networks using hardware already available on the market.
+
+Topology
+~~~~~~~~
+
+.. figure:: mesh_topology.jpg
+   :alt: Bluetooth Mesh Topology (source: Mesh Profile Specification 1.0)
+
+Bluetooth Mesh defines few features (roles) for devices in network. Those are:
+
+-  Relay - receive and retransmit mesh messages over the advertising bearer to enable larger networks
+-  Proxy - receive and retransmit mesh messages between GATT and advertising bearers.
+-  Low Power - operate within a mesh network at significantly reduced receiver duty cycles only in conjunction with a
+   node supporting the Friend feature
+-  Friend - the ability to help a node supporting the Low Power feature to operate by storing messages destined for those nodes
+
+Bearers
+~~~~~~~
+
+Mesh Profile specification allows two kinds of bearers for transmitting data:
+
+-  Advertising Bearer
+
+   -  Uses LE advertising to broadcast messages to all nodes that are listening at this time
+   -  Uses non-connectable advertising only
+   -  29 octets of network message
+
+-  GATT Bearer
+
+   -  Uses LE Connections to send messages
+   -  Uses standard GATT service (one for Provisioning and one for Proxy)
+
+Provisioning
+~~~~~~~~~~~~
+
+Provisioning is a process of adding an unprovisioned device to a mesh network managed by a Provisioner. A Provisioner
+provides the unprovisioned device with provisioning data that allows it to become a mesh node (network key, current IV
+index and unicast address). A Provisioner is typically a smart phone or other mobile computing device.
+
+Models
+~~~~~~
+
+Models define basic functionality of nodes on a mesh network. Mesh Profile Specification defines foundation models used
+to configure and manage network. Mesh Model Specification includes models defininig functionality that is standard
+across device types. Those consists of:
+
+-  Generics - root models
+
+   -  On/Off
+   -  Level
+   -  Battery Server
+   -  Location
+   -  Client Property
+   -  and others
+
+-  Sensors - defines a standard way of interfacing with sensors
+-  Time and Scenes - defines a set of functionalities related to time and saved states on devices
+-  Lighting - defines a set functionalities related to lighting control
+
+Complex models e.g. Lighting may contain other models eg Generic On/Off. The following image shows an example of Light
+Lightness Server Model.
+
+.. figure:: mesh_lightning_model.jpg
+   :alt: Light Lightness Server model (source: Mesh Model Specification 1.0)
+
+Mesh Node features supported by Apache Mynewt
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+-  Advertising and GATT bearers
+-  PB-GATT and PB-ADV provisioning
+-  Foundation Models (server role)
+-  Relay support
+-  GATT Proxy

docs/mesh/sample.rst

@@ -0,0 +1,30 @@
+Sample application
+------------------
+
+**blemesh** sample application implements Bluetooth Mesh node that supports On/Off and Level models.
+
+To build application use following target. Note that since this application uses Non-resolvable Private Address there is
+no need for configuring public address.
+
+::
+
+    newt target create blemesh
+    newt target set blemesh app=@apache-mynewt-core/apps/blemesh
+    newt target set blemesh bsp=@apache-mynewt-core/hw/bsp/nrf52840pdk
+    newt target set blemesh build_profile=optimized
+    newt target set blemesh syscfg=BLE_MESH_PB_GATT=1:BLE_MESH_DEV_UUID='(uint8_t[16]){0x22, 0x20, 0}'
+
+Every device should have unique Device UUID so config amend and rebuild is needed for each of the devices that will be
+added to a network.
+
+::
+
+    newt target set blemesh syscfg=BLE_MESH_PB_GATT=1:BLE_MESH_DEV_UUID='(uint8_t[16]){0x22, 0x21, 0}'
+    ...
+    newt target set blemesh syscfg=BLE_MESH_PB_GATT=1:BLE_MESH_DEV_UUID='(uint8_t[16]){0x22, 0x22, 0}'
+    ...
+    newt target set blemesh syscfg=BLE_MESH_PB_GATT=1:BLE_MESH_DEV_UUID='(uint8_t[16]){0x22, 0x23, 0}'
+
+GATT bearer is enabled so that it is possible to provision those with Bluetooth Mesh application from Silicon Labs
+(available `here <https://play.google.com/store/apps/details?id=com.siliconlabs.bluetoothmesh>`__) which doesn't
+support advertising bearer.

nimble/host/include/host/ble_gap.h

@@ -20,6 +20,13 @@
 #ifndef H_BLE_GAP_
 #define H_BLE_GAP_
 
+/**
+ * @brief Bluetooth Host Generic Access Profile (GAP)
+ * @defgroup bt_host_gap Bluetooth Host Generic Access Profile (GAP)
+ * @ingroup bt_host
+ * @{
+ */
+
 #include <inttypes.h>
 #include "host/ble_hs.h"
 #include "host/ble_hs_adv.h"
@@ -86,7 +93,8 @@ struct hci_conn_update;
 /* 50 ms. */
 #define BLE_GAP_INITIAL_CONN_ITVL_MAX       (50 * 1000 / BLE_HCI_CONN_ITVL)
 
-#define BLE_GAP_ADV_DFLT_CHANNEL_MAP        0x07 /* All three channels. */
+/** Default channels mask: all three channels are used. */
+#define BLE_GAP_ADV_DFLT_CHANNEL_MAP        0x07
 
 #define BLE_GAP_INITIAL_CONN_LATENCY        0
 #define BLE_GAP_INITIAL_SUPERVISION_TIMEOUT 0x0100
@@ -134,53 +142,85 @@ struct hci_conn_update;
 #define BLE_GAP_REPEAT_PAIRING_RETRY        1
 #define BLE_GAP_REPEAT_PAIRING_IGNORE       2
 
+/** Connection security state */
 struct ble_gap_sec_state {
+    /** If connection is encrypted */
     unsigned encrypted:1;
+
+    /** If connection is authenticated */
     unsigned authenticated:1;
+
+    /** If connection is bonded (security information is stored)  */
     unsigned bonded:1;
+
+    /** Size of a key used for encryption */
     unsigned key_size:5;
 };
 
-/**
- * conn_mode:                   One of the following constants:
- *                                  o BLE_GAP_CONN_MODE_NON
- *                                      (non-connectable; 3.C.9.3.2).
- *                                  o BLE_GAP_CONN_MODE_DIR
- *                                      (directed-connectable; 3.C.9.3.3).
- *                                  o BLE_GAP_CONN_MODE_UND
- *                                      (undirected-connectable; 3.C.9.3.4).
- * disc_mode:                   One of the following constants:
- *                                  o BLE_GAP_DISC_MODE_NON
- *                                      (non-discoverable; 3.C.9.2.2).
- *                                  o BLE_GAP_DISC_MODE_LTD
- *                                      (limited-discoverable; 3.C.9.2.3).
- *                                  o BLE_GAP_DISC_MODE_GEN
- *                                      (general-discoverable; 3.C.9.2.4).
- */
+/** Advertising parameters */
 struct ble_gap_adv_params {
-    /*** Mandatory fields. */
+    /** Advertising mode. Can be one of following constants:
+     *  - BLE_GAP_CONN_MODE_NON (non-connectable; 3.C.9.3.2).
+     *  - BLE_GAP_CONN_MODE_DIR (directed-connectable; 3.C.9.3.3).
+     *  - BLE_GAP_CONN_MODE_UND (undirected-connectable; 3.C.9.3.4).
+     */
     uint8_t conn_mode;
+    /** Discoverable mode. Can be one of following constants:
+     *  - BLE_GAP_DISC_MODE_NON  (non-discoverable; 3.C.9.2.2).
+     *  - BLE_GAP_DISC_MODE_LTD (limited-discoverable; 3.C.9.2.3).
+     *  - BLE_GAP_DISC_MODE_GEN (general-discoverable; 3.C.9.2.4).
+     */
     uint8_t disc_mode;
 
-    /*** Optional fields; assign 0 to make the stack calculate them. */
+    /** Minimum advertising interval, if 0 stack use sane defaults */
     uint16_t itvl_min;
+    /** Maximum advertising interval, if 0 stack use sane defaults */
     uint16_t itvl_max;
+    /** Advertising channel map , if 0 stack use sane defaults */
     uint8_t channel_map;
+
+    /** Advertising  Filter policy */
     uint8_t filter_policy;
+
+    /** If do High Duty cycle for Directed Advertising */
     uint8_t high_duty_cycle:1;
 };
 
+/** @brief Connection descriptor */
 struct ble_gap_conn_desc {
+    /** Connection security state */
     struct ble_gap_sec_state sec_state;
+
+    /** Local identity address */
     ble_addr_t our_id_addr;
+
+    /** Peer identity address */
     ble_addr_t peer_id_addr;
+
+    /** Local over-the-air address */
     ble_addr_t our_ota_addr;
+
+    /** Peer over-the-air address */
     ble_addr_t peer_ota_addr;
+
+    /** Connection handle */
     uint16_t conn_handle;
+
+    /** Connection interval */
     uint16_t conn_itvl;
+
+    /** Connection latency */
     uint16_t conn_latency;
+
+    /** Connection supervision timeout */
     uint16_t supervision_timeout;
+
+    /** Connection Role
+     * Possible values BLE_GAP_ROLE_SLAVE or BLE_GAP_ROLE_MASTER
+     */
     uint8_t role;
+
+    /** Master clock accuracy */
     uint8_t master_clock_accuracy;
 };
 
@@ -681,19 +721,135 @@ typedef int ble_gap_event_fn(struct ble_gap_event *event, void *arg);
 #define BLE_GAP_DISC_MODE_LTD               1
 #define BLE_GAP_DISC_MODE_GEN               2
 
+/**
+ * Searches for a connection with the specified handle.  If a matching
+ * connection is found, the supplied connection descriptor is filled
+ * correspondingly.
+ *
+ * @param handle    The connection handle to search for.
+ * @param out_desc  On success, this is populated with information relating to
+ *                  the matching connection.  Pass NULL if you don't need this
+ *                  information.
+ *
+ * @return          0 on success, BLE_HS_ENOTCONN if no matching connection was
+ *                  found.
+ */
 int ble_gap_conn_find(uint16_t handle, struct ble_gap_conn_desc *out_desc);
+
+/**
+ * Configures a connection to use the specified GAP event callback.  A
+ * connection's GAP event callback is first specified when the connection is
+ * created, either via advertising or initiation.  This function replaces the
+ * callback that was last configured.
+ *
+ * @param conn_handle   The handle of the connection to configure.
+ * @param cb            The callback to associate with the connection.
+ * @param cb_arg        An optional argument that the callback receives.
+ *
+ * @return              0 on success, BLE_HS_ENOTCONN if there is no connection
+ *                      with the specified handle.
+ */
 int ble_gap_set_event_cb(uint16_t conn_handle,
                          ble_gap_event_fn *cb, void *cb_arg);
 
+/** @brief Start advertising
+ *
+ * This function configures and start advertising procedure.
+ *
+ * @param own_addr_type The type of address the stack should use for itself.
+ *                      Valid values are:
+ *                         - BLE_OWN_ADDR_PUBLIC
+ *                         - BLE_OWN_ADDR_RANDOM
+ *                         - BLE_OWN_ADDR_RPA_PUBLIC_DEFAULT
+ *                         - BLE_OWN_ADDR_RPA_RANDOM_DEFAULT
+ * @param direct_addr   The peer's address for directed advertising. his
+ *                      parameter shall be non-NULL if directed advertising is
+ *                      being used.
+ * @param duration_ms   The duration of the advertisement procedure. On
+ *                      expiration, the procedure ends and a
+ *                      BLE_GAP_EVENT_ADV_COMPLETE event is reported. Units are
+ *                      milliseconds. Specify BLE_HS_FOREVER for no expiration.
+ * @param adv_params    Additional arguments specifying the particulars of the
+ *                      advertising procedure.
+ * @param cb            The callback to associate with this advertising
+ *                      procedure.  If advertising ends, the event is reported
+ *                      through this callback.  If advertising results in a
+ *                      connection, the connection inherits this callback as its
+ *                      event-reporting mechanism.
+ * @param cb_arg        The optional argument to pass to the callback function.
+ *
+ * @return              0 on success, error code on failure.
+ */
 int ble_gap_adv_start(uint8_t own_addr_type, const ble_addr_t *direct_addr,
                       int32_t duration_ms,
                       const struct ble_gap_adv_params *adv_params,
                       ble_gap_event_fn *cb, void *cb_arg);
+
+/**
+ * Stops the currently-active advertising procedure.  A success return
+ * code indicates that advertising has been fully aborted and a new advertising
+ * procedure can be initiated immediately.
+ *
+ * @return  0 on success, BLE_HS_EALREADY if there is no active advertising
+ *          procedure, other error code on failure.
+ */
 int ble_gap_adv_stop(void);
+
+/**
+ * Indicates whether an advertisement procedure is currently in progress.
+ *
+ * @return 0 if no advertisement procedure in progress, 1 otherwise.
+ */
 int ble_gap_adv_active(void);
+
+/**
+ * Configures the data to include in subsequent advertisements.
+ *
+ * @param data      Buffer containing the advertising data.
+ * @param data_len  The size of the advertising data, in bytes.
+ *
+ * @return          0 on succes,  BLE_HS_EBUSY if advertising is in progress,
+ *                  other error code on failure.
+ */
 int ble_gap_adv_set_data(const uint8_t *data, int data_len);
+
+/**
+ * Configures the data to include in subsequent scan responses.
+ *
+ * @param data      Buffer containing the scan response data.
+ * @param data_len  The size of the response data, in bytes.
+ *
+ * @return          0 on succes,  BLE_HS_EBUSY if advertising is in progress,
+ *                  other error code on failure.
+ */
 int ble_gap_adv_rsp_set_data(const uint8_t *data, int data_len);
+
+/**
+ * Configures the fields to include in subsequent advertisements.  This is a
+ * convenience wrapper for ble_gap_adv_set_data().
+ *
+ * @param adv_fields    Specifies the advertisement data.
+ *
+ * @return              0 on success,
+ *                      BLE_HS_EBUSY if advertising is in progress,
+ *                      BLE_HS_EMSGSIZE if the specified data is too large to
+ *                      fit in an advertisement,
+ *                      other error code on failure.
+ */
 int ble_gap_adv_set_fields(const struct ble_hs_adv_fields *rsp_fields);
+
+/**
+ * Configures the fields to include in subsequent scan responses.  This is a
+ * convenience wrapper for ble_gap_adv_rsp_set_data().
+ *
+ * @param adv_fields   Specifies the scan response data.
+ *
+ * @return              0 on success,
+ *                      BLE_HS_EBUSY if advertising is in progress,
+ *                      BLE_HS_EMSGSIZE if the specified data is too large to
+ *                      fit in a scan response,
+ *                      other error code on failure.
+ */
 int ble_gap_adv_rsp_set_fields(const struct ble_hs_adv_fields *rsp_fields);
 
 #if MYNEWT_VAL(BLE_EXT_ADV)
@@ -731,37 +887,298 @@ int ble_gap_ext_adv_rsp_set_data(uint8_t instance, struct os_mbuf *data);
 int ble_gap_ext_adv_remove(uint8_t instance);
 #endif
 
+/**
+ * Performs the Limited or General Discovery Procedures.
+ *
+ * @param own_addr_type         The type of address the stack should use for
+ *                                  itself when sending scan requests.  Valid
+ *                                  values are:
+ *                                      - BLE_ADDR_TYPE_PUBLIC
+ *                                      - BLE_ADDR_TYPE_RANDOM
+ *                                      - BLE_ADDR_TYPE_RPA_PUB_DEFAULT
+ *                                      - BLE_ADDR_TYPE_RPA_RND_DEFAULT
+ *                                  This parameter is ignored unless active
+ *                                  scanning is being used.
+ * @param duration_ms           The duration of the discovery procedure.
+ *                                  On expiration, the procedure ends and a
+ *                                  BLE_GAP_EVENT_DISC_COMPLETE event is
+ *                                  reported.  Units are milliseconds.  Specify
+ *                                  BLE_HS_FOREVER for no expiration.
+ * @param disc_params           Additional arguments specifying the particulars
+ *                                  of the discovery procedure.
+ * @param cb                    The callback to associate with this discovery
+ *                                  procedure.  Advertising reports and
+ *                                  discovery termination events are reported
+ *                                  through this callback.
+ * @param cb_arg                The optional argument to pass to the callback
+ *                                  function.
+ *
+ * @return                      0 on success; nonzero on failure.
+ */
 int ble_gap_disc(uint8_t own_addr_type, int32_t duration_ms,
                  const struct ble_gap_disc_params *disc_params,
                  ble_gap_event_fn *cb, void *cb_arg);
+
 int ble_gap_ext_disc(uint8_t own_addr_type, uint16_t duration, uint16_t period,
                      uint8_t filter_duplicates, uint8_t filter_policy,
                      uint8_t limited,
                      const struct ble_gap_ext_disc_params *uncoded_params,
                      const struct ble_gap_ext_disc_params *coded_params,
                      ble_gap_event_fn *cb, void *cb_arg);
+
+/**
+ * Cancels the discovery procedure currently in progress.  A success return
+ * code indicates that scanning has been fully aborted; a new discovery or
+ * connect procedure can be initiated immediately.
+ *
+ * @return                      0 on success;
+ *                              BLE_HS_EALREADY if there is no discovery
+ *                                  procedure to cancel;
+ *                              Other nonzero on unexpected error.
+ */
 int ble_gap_disc_cancel(void);
+
+/**
+ * Indicates whether a discovery procedure is currently in progress.
+ *
+ * @return                      0: No discovery procedure in progress;
+ *                              1: Discovery procedure in progress.
+ */
 int ble_gap_disc_active(void);
+
+/**
+ * Initiates a connect procedure.
+ *
+ * @param own_addr_type         The type of address the stack should use for
+ *                                  itself during connection establishment.
+ *                                      - BLE_OWN_ADDR_PUBLIC
+ *                                      - BLE_OWN_ADDR_RANDOM
+ *                                      - BLE_OWN_ADDR_RPA_PUBLIC_DEFAULT
+ *                                      - BLE_OWN_ADDR_RPA_RANDOM_DEFAULT
+ * @param peer_addr             The address of the peer to connect to.
+ *                                  If this parameter is NULL, the white list
+ *                                  is used.
+ * @param duration_ms           The duration of the discovery procedure.
+ *                                  On expiration, the procedure ends and a
+ *                                  BLE_GAP_EVENT_DISC_COMPLETE event is
+ *                                  reported.  Units are milliseconds.
+ * @param conn_params           Additional arguments specifying the particulars
+ *                                  of the connect procedure.  Specify null for
+ *                                  default values.
+ * @param cb                    The callback to associate with this connect
+ *                                  procedure.  When the connect procedure
+ *                                  completes, the result is reported through
+ *                                  this callback.  If the connect procedure
+ *                                  succeeds, the connection inherits this
+ *                                  callback as its event-reporting mechanism.
+ * @param cb_arg                The optional argument to pass to the callback
+ *                                  function.
+ *
+ * @return                      0 on success;
+ *                              BLE_HS_EALREADY if a connection attempt is
+ *                                  already in progress;
+ *                              BLE_HS_EBUSY if initiating a connection is not
+ *                                  possible because scanning is in progress;
+ *                              BLE_HS_EDONE if the specified peer is already
+ *                                  connected;
+ *                              Other nonzero on error.
+ */
 int ble_gap_connect(uint8_t own_addr_type, const ble_addr_t *peer_addr,
                     int32_t duration_ms,
                     const struct ble_gap_conn_params *params,
                     ble_gap_event_fn *cb, void *cb_arg);
+
+/**
+ * Initiates an extended connect procedure.
+ *
+ * @param own_addr_type         The type of address the stack should use for
+ *                                  itself during connection establishment.
+ *                                      - BLE_OWN_ADDR_PUBLIC
+ *                                      - BLE_OWN_ADDR_RANDOM
+ *                                      - BLE_OWN_ADDR_RPA_PUBLIC_DEFAULT
+ *                                      - BLE_OWN_ADDR_RPA_RANDOM_DEFAULT
+ * @param peer_addr             The address of the peer to connect to.
+ *                                  If this parameter is NULL, the white list
+ *                                  is used.
+ * @param duration_ms           The duration of the discovery procedure.
+ *                                  On expiration, the procedure ends and a
+ *                                  BLE_GAP_EVENT_DISC_COMPLETE event is
+ *                                  reported.  Units are milliseconds.
+ * @param phy_mask              Define on which PHYs connection attempt should
+ *                                  be done
+ * @param phy_1m_conn_params     Additional arguments specifying the
+ *                                  particulars of the connect procedure. When
+ *                                  BLE_GAP_LE_PHY_1M_MASK is set in phy_mask
+ *                                  this parameter can be specify to null for
+ *                                  default values.
+ * @param phy_2m_conn_params     Additional arguments specifying the
+ *                                  particulars of the connect procedure. When
+ *                                  BLE_GAP_LE_PHY_2M_MASK is set in phy_mask
+ *                                  this parameter can be specify to null for
+ *                                  default values.
+ * @param phy_coded_conn_params  Additional arguments specifying the
+ *                                  particulars of the connect procedure. When
+ *                                  BLE_GAP_LE_PHY_CODED_MASK is set in
+ *                                  phy_mask this parameter can be specify to
+ *                                  null for default values.
+ * @param cb                    The callback to associate with this connect
+ *                                  procedure.  When the connect procedure
+ *                                  completes, the result is reported through
+ *                                  this callback.  If the connect procedure
+ *                                  succeeds, the connection inherits this
+ *                                  callback as its event-reporting mechanism.
+ * @param cb_arg                The optional argument to pass to the callback
+ *                                  function.
+ *
+ * @return                      0 on success;
+ *                              BLE_HS_EALREADY if a connection attempt is
+ *                                  already in progress;
+ *                              BLE_HS_EBUSY if initiating a connection is not
+ *                                  possible because scanning is in progress;
+ *                              BLE_HS_EDONE if the specified peer is already
+ *                                  connected;
+ *                              Other nonzero on error.
+ */
 int ble_gap_ext_connect(uint8_t own_addr_type, const ble_addr_t *peer_addr,
                         int32_t duration_ms, uint8_t phy_mask,
                         const struct ble_gap_conn_params *phy_1m_conn_params,
                         const struct ble_gap_conn_params *phy_2m_conn_params,
                         const struct ble_gap_conn_params *phy_coded_conn_params,
                         ble_gap_event_fn *cb, void *cb_arg);
+
+/**
+ * Aborts a connect procedure in progress.
+ *
+ * @return                      0 on success;
+ *                              BLE_HS_EALREADY if there is no active connect
+ *                                  procedure.
+ *                              Other nonzero on error.
+ */
 int ble_gap_conn_cancel(void);
+
+/**
+ * Indicates whether a connect procedure is currently in progress.
+ *
+ * @return                      0: No connect procedure in progress;
+ *                              1: Connect procedure in progress.
+ */
 int ble_gap_conn_active(void);
+
+/**
+ * Terminates an established connection.
+ *
+ * @param conn_handle           The handle corresponding to the connection to
+ *                                  terminate.
+ * @param hci_reason            The HCI error code to indicate as the reason
+ *                                  for termination.
+ *
+ * @return                      0 on success;
+ *                              BLE_HS_ENOTCONN if there is no connection with
+ *                                  the specified handle;
+ *                              Other nonzero on failure.
+ */
 int ble_gap_terminate(uint16_t conn_handle, uint8_t hci_reason);
+
+/**
+ * Overwrites the controller's white list with the specified contents.
+ *
+ * @param addrs                 The entries to write to the white list.
+ * @param white_list_count      The number of entries in the white list.
+ *
+ * @return                      0 on success; nonzero on failure.
+ */
 int ble_gap_wl_set(const ble_addr_t *addrs, uint8_t white_list_count);
+
+/**
+ * Initiates a connection parameter update procedure.
+ *
+ * @param conn_handle           The handle corresponding to the connection to
+ *                                  update.
+ * @param params                The connection parameters to attempt to update
+ *                                  to.
+ *
+ * @return                      0 on success;
+ *                              BLE_HS_ENOTCONN if the there is no connection
+ *                                  with the specified handle;
+ *                              BLE_HS_EALREADY if a connection update
+ *                                  procedure for this connection is already in
+ *                                  progress;
+ *                              BLE_HS_EINVAL if requested parameters are
+ *                                  invalid;
+ *                              Other nonzero on error.
+ */
 int ble_gap_update_params(uint16_t conn_handle,
                           const struct ble_gap_upd_params *params);
+
+/**
+ * Initiates the GAP security procedure.
+ *
+ * Depending on connection role and stored security information this function
+ * will start appropriate security procedure (pairing or encryption).
+ *
+ * @param conn_handle           The handle corresponding to the connection to
+ *                              secure.
+ *
+ * @return                      0 on success;
+ *                              BLE_HS_ENOTCONN if the there is no connection
+ *                                  with the specified handle;
+ *                              BLE_HS_EALREADY if an security procedure for
+ *                                  this connection is already in progress;
+ *                              Other nonzero on error.
+ */
 int ble_gap_security_initiate(uint16_t conn_handle);
+
+/**
+ * Initiates the GAP pairing procedure as a master. This is for testing only and
+ * should not be used by application. Use ble_gap_security_initiate() instead.
+ *
+ * @param conn_handle           The handle corresponding to the connection to
+ *                              start pairing on.
+ *
+ * @return                      0 on success;
+ *                              BLE_HS_ENOTCONN if the there is no connection
+ *                                  with the specified handle;
+ *                              BLE_HS_EALREADY if an pairing procedure for
+ *                                  this connection is already in progress;
+ *                              Other nonzero on error.
+ */
 int ble_gap_pair_initiate(uint16_t conn_handle);
+
+/**
+ * Initiates the GAP encryption procedure as a master. This is for testing only
+ * and should not be used by application. Use ble_gap_security_initiate()
+ * instead.
+ *
+ * @param conn_handle           The handle corresponding to the connection to
+ *                              start encryption.
+ * @param ltk                   Long Term Key to be used for encryption.
+ * @param udiv                  Encryption Diversifier for LTK
+ * @param rand_val              Random Value for EDIV and LTK
+ * @param auth                  If LTK provided is authenticated.
+ *
+ * @return                      0 on success;
+ *                              BLE_HS_ENOTCONN if the there is no connection
+ *                                  with the specified handle;
+ *                              BLE_HS_EALREADY if an encryption procedure for
+ *                                  this connection is already in progress;
+ *                              Other nonzero on error.
+ */
 int ble_gap_encryption_initiate(uint16_t conn_handle, const uint8_t *ltk,
                                 uint16_t ediv, uint64_t rand_val, int auth);
+
+/**
+ * Retrieves the most-recently measured RSSI for the specified connection.  A
+ * connection's RSSI is updated whenever a data channel PDU is received.
+ *
+ * @param conn_handle           Specifies the connection to query.
+ * @param out_rssi              On success, the retrieved RSSI is written here.
+ *
+ * @return                      0 on success;
+ *                              A BLE host HCI return code if the controller
+ *                                  rejected the request;
+ *                              A BLE host core return code on unexpected
+ *                                  error.
+ */
 int ble_gap_conn_rssi(uint16_t conn_handle, int8_t *out_rssi);
 
 #define BLE_GAP_PRIVATE_MODE_NETWORK        0
@@ -794,4 +1211,8 @@ int ble_gap_mesh_cb_register(ble_gap_event_fn *cb, void *cb_arg);
 }
 #endif
 
+/**
+ * @}
+ */
+
 #endif

nimble/host/include/host/ble_hs.h

@@ -20,6 +20,12 @@
 #ifndef H_BLE_HS_
 #define H_BLE_HS_
 
+/**
+ * @brief Bluetooth Host
+ * @defgroup bt_host Bluetooth Host
+ * @{
+ */
+
 #include <inttypes.h>
 #include "nimble/hci_common.h"
 #include "host/ble_att.h"
@@ -45,8 +51,19 @@ extern "C" {
 
 #define BLE_HS_FOREVER              INT32_MAX
 
+/** Connection handle not present */
 #define BLE_HS_CONN_HANDLE_NONE     0xffff
 
+/**
+ * @brief Bluetooth Host Error Code
+ * @defgroup bt_host_err Bluetooth Host Error Code
+ *
+ * Defines error codes returned by Bluetooth host. If error comes from specific
+ * component (eg L2CAP or Security Manager) it is shifted by base allowing to
+ * identify component.
+ * @{
+ */
+
 #define BLE_HS_EAGAIN               1
 #define BLE_HS_EALREADY             2
 #define BLE_HS_EINVAL               3
@@ -77,37 +94,98 @@ extern "C" {
 #define BLE_HS_ESTORE_FAIL          28
 #define BLE_HS_EPREEMPTED           29
 
-#define BLE_HS_ERR_ATT_BASE         0x100   /* 256 */
+/** Error base for ATT errors */
+#define BLE_HS_ERR_ATT_BASE         0x100
+
+/** Converts error to ATT base */
 #define BLE_HS_ATT_ERR(x)           ((x) ? BLE_HS_ERR_ATT_BASE + (x) : 0)
 
-#define BLE_HS_ERR_HCI_BASE         0x200   /* 512 */
+/** Error base for HCI errors */
+#define BLE_HS_ERR_HCI_BASE         0x200
+
+/** Converts error to HCI base */
 #define BLE_HS_HCI_ERR(x)           ((x) ? BLE_HS_ERR_HCI_BASE + (x) : 0)
 
-#define BLE_HS_ERR_L2C_BASE         0x300   /* 768 */
+/** Error base for L2CAP errors */
+#define BLE_HS_ERR_L2C_BASE         0x300
+
+/** Converts error to L2CAP base */
 #define BLE_HS_L2C_ERR(x)           ((x) ? BLE_HS_ERR_L2C_BASE + (x) : 0)
 
-#define BLE_HS_ERR_SM_US_BASE       0x400   /* 1024 */
+/** Error base for local Security Manager errors */
+#define BLE_HS_ERR_SM_US_BASE       0x400
+
+/** Converts error to local Security Manager base */
 #define BLE_HS_SM_US_ERR(x)         ((x) ? BLE_HS_ERR_SM_US_BASE + (x) : 0)
 
-#define BLE_HS_ERR_SM_PEER_BASE     0x500   /* 1280 */
+/** Error base for remote (peer) Security Manager errors */
+#define BLE_HS_ERR_SM_PEER_BASE     0x500
+
+/** Converts error to remote (peer) Security Manager base */
 #define BLE_HS_SM_PEER_ERR(x)       ((x) ? BLE_HS_ERR_SM_PEER_BASE + (x) : 0)
 
-/* Note: A hardware error of 0 is not success. */
-#define BLE_HS_ERR_HW_BASE          0x600   /* 1536 */
+/** Error base for hardware errors */
+#define BLE_HS_ERR_HW_BASE          0x600
+
+/** Converts error to hardware error  base */
 #define BLE_HS_HW_ERR(x)            (BLE_HS_ERR_HW_BASE + (x))
 
-/* Defines the IO capabilities for the local device. */
+/**
+ * @}
+ */
+
+/**
+ * @brief Bluetooth Host Configuration
+ * @defgroup bt_host_conf Bluetooth Host Configuration
+ *
+ * @{
+ */
+
+/**
+ * @brief Local Input-Output capabilities of device
+ * @defgroup bt_host_io_local Local Input-Output capabilities of device
+ *
+ * @{
+ */
+
+/** DisplayOnly IO capability */
 #define BLE_HS_IO_DISPLAY_ONLY              0x00
+
+/** DisplayYesNo IO capability */
 #define BLE_HS_IO_DISPLAY_YESNO             0x01
+
+/** KeyboardOnly IO capability */
 #define BLE_HS_IO_KEYBOARD_ONLY             0x02
+
+/** NoInputNoOutput IO capability */
 #define BLE_HS_IO_NO_INPUT_OUTPUT           0x03
+
+/** KeyboardDisplay Only IO capability */
 #define BLE_HS_IO_KEYBOARD_DISPLAY          0x04
 
+/**
+ * @}
+ */
+
+/** @brief Stack reset callback
+ *
+ * @param reason Reason code for reset
+ */
 typedef void ble_hs_reset_fn(int reason);
+
+
+/** @brief Stack sync callback */
 typedef void ble_hs_sync_fn(void);
 
+/** @brief Bluetooth Host main configuration structure
+ *
+ * Those can be used by application to configure stack.
+ *
+ * The only reason Security Manager (sm_ members) is configurable at runtime is
+ * to simplify security testing. Defaults for those are configured by selecting
+ * proper options in application's syscfg.
+ */
 struct ble_hs_cfg {
-    /*** GATT server settings. */
     /**
      * An optional callback that gets executed upon registration of each GATT
      * resource (service, characteristic, or descriptor).
@@ -120,64 +198,151 @@ struct ble_hs_cfg {
      */
     void *gatts_register_arg;
 
-    /***
-     * Security manager settings.  The only reason these are configurable at
-     * runtime is to simplify security testing.
-     */
+    /** Security Manager Local Input Output Capabilities */
     uint8_t sm_io_cap;
+
+    /** @brief Security Manager OOB flag
+     *
+     * If set proper flag in Pairing Request/Response will be set.
+     */
     unsigned sm_oob_data_flag:1;
+
+    /** @brief Security Manager Bond flag
+     *
+     * If set proper flag in Pairing Request/Response will be set. This results
+     * in storing keys distributed during bonding.
+     */
     unsigned sm_bonding:1;
+
+    /** @brief Security Manager MITM flag
+     *
+     * If set proper flag in Pairing Request/Response will be set. This results
+     * in requiring Man-In-The-Middle protection when pairing.
+     */
     unsigned sm_mitm:1;
+
+    /** @brief Security Manager Secure Connections flag
+     *
+     * If set proper flag in Pairing Request/Response will be set. This results
+     * in using LE Secure Connections for pairing if also supported by remote
+     * device. Fallback to legacy pairing if not supported by remote.
+     */
     unsigned sm_sc:1;
+
+    /** @brief Security Manager Key Press Notification flag
+     *
+     * Currently unsupported and should not be set.
+     */
     unsigned sm_keypress:1;
+
+    /** @brief Security Manager Local Key Distribution Mask */
     uint8_t sm_our_key_dist;
+
+    /** @brief Security Manager Remote Key Distribution Mask */
     uint8_t sm_their_key_dist;
 
-    /*** HCI settings */
-    /**
+    /** @brief Stack reset callback
+     *
      * This callback is executed when the host resets itself and the controller
      * due to fatal error.
      */
     ble_hs_reset_fn *reset_cb;
 
-    /**
+    /** @brief Stack sync callback
+     *
      * This callback is executed when the host and controller become synced.
      * This happens at startup and after a reset.
      */
     ble_hs_sync_fn *sync_cb;
 
-    /*** Store settings. */
-    /**
-     * These function callbacks handle persistence of sercurity material
-     * (bonding).
-     * XXX: These need to go away.  Instead, the nimble host package should
+    /* XXX: These need to go away. Instead, the nimble host package should
      * require the host-store API (not yet implemented)..
      */
+    /** Storage Read callback handles read of security material */
     ble_store_read_fn *store_read_cb;
+
+    /** Storage Write callback handles write of security material */
     ble_store_write_fn *store_write_cb;
+
+    /** Storage Delete callback handles deletion of security material */
     ble_store_delete_fn *store_delete_cb;
 
-    /**
+    /** @brief Storage Status callback.
+     *
      * This callback gets executed when a persistence operation cannot be
-     * performed or a persistence failure is imminent.  For example, if is
+     * performed or a persistence failure is imminent. For example, if is
      * insufficient storage capacity for a record to be persisted, this
      * function gets called to give the application the opportunity to make
      * room.
      */
     ble_store_status_fn *store_status_cb;
+
+    /** An optional argument that gets passed to the storage status callback. */
     void *store_status_arg;
 };
 
 extern struct ble_hs_cfg ble_hs_cfg;
 
+/**
+ * @}
+ */
+
+/**
+ * Indicates whether the host has synchronized with the controller.
+ * Synchronization must occur before any host procedures can be performed.
+ *
+ * @return 1 if the host and controller are in sync;
+ *         0 if the host and controller our out of sync.
+ */
 int ble_hs_synced(void);
+
+/**
+ * Synchronizes the host with the controller by sending a sequence of HCI
+ * commands.  This function must be called before any other host functionality
+ * is used, but it must be called after both the host and controller are
+ * initialized.  Typically, the host-parent-task calls this function at the top
+ * of its task routine.
+ *
+ * If the host fails to synchronize with the controller (if the controller is
+ * not fully booted, for example), the host will attempt to resynchronize every
+ * 100 ms. For this reason, an error return code is not necessarily fatal.
+ *
+ * @return 0 on success; nonzero on error.
+ */
 int ble_hs_start(void);
+
+/**
+ * Causes the host to reset the NimBLE stack as soon as possible.  The
+ * application is notified when the reset occurs via the host reset callback.
+ *
+ * @param reason The host error code that gets passed to the reset callback.
+ */
 void ble_hs_sched_reset(int reason);
+
+/**
+ * Designates the specified event queue for NimBLE host work. By default, the
+ * host uses the default event queue and runs in the main task. This function
+ * is useful if you want the host to run in a different task.
+ *
+ * @param evq The event queue to use for host work.
+ */
 void ble_hs_evq_set(struct ble_npl_eventq *evq);
+
+/**
+ * Initializes the NimBLE host. This function must be called before the OS is
+ * started. The NimBLE stack requires an application task to function.  One
+ * application task in particular is designated as the "host parent task". In
+ * addition to application-specific work, the host parent task does work for
+ * NimBLE by processing events generated by the host.
+ */
 void ble_hs_init(void);
 
 #ifdef __cplusplus
 }
 #endif
 
+/**
+ * @}
+ */
+
 #endif

nimble/host/include/host/ble_hs_mbuf.h

@@ -20,6 +20,13 @@
 #ifndef H_BLE_HS_MBUF_
 #define H_BLE_HS_MBUF_
 
+/**
+ * @brief Bluetooth Host chained memory buffer (mbuf)
+ * @defgroup bt_host_mbuf Bluetooth Host chained memory buffer (mbuf)
+ * @ingroup bt_host
+ * @{
+ */
+
 #include <inttypes.h>
 #ifdef __cplusplus
 extern "C" {
@@ -27,8 +34,40 @@ extern "C" {
 
 struct os_mbuf;
 
+/**
+ * Allocates an mbuf suitable for an ATT command packet.  The resulting packet
+ * has sufficient leading space for:
+ *  - ACL data header
+ *  - L2CAP B-frame header
+ *  - Largest ATT command base (prepare write request / response).
+ *
+ * @return An empty mbuf on success, NULLl on error.
+ */
 struct os_mbuf *ble_hs_mbuf_att_pkt(void);
+
+/**
+ * Allocates an mbuf and fills it with the contents of the specified flat
+ * buffer.
+ *
+ * @param buf The flat buffer to copy from.
+ * @param len The length of the flat buffer.
+ *
+ * @return A newly-allocated mbuf on success, NULL on error.
+ */
 struct os_mbuf *ble_hs_mbuf_from_flat(const void *buf, uint16_t len);
+
+/**
+ * Copies the contents of an mbuf into the specified flat buffer.  If the flat
+ * buffer is too small to contain the mbuf's contents, it is filled to capacity
+ * and BLE_HS_EMSGSIZE is returned.
+ *
+ * @param om            The mbuf to copy from.
+ * @param flat          The destination flat buffer.
+ * @param max_len       The size of the flat buffer.
+ * @param out_copy_len  The number of bytes actually copied gets written here.
+ *
+ * @return               0 on success or BLE host core return code on error.
+ */
 int ble_hs_mbuf_to_flat(const struct os_mbuf *om, void *flat, uint16_t max_len,
                         uint16_t *out_copy_len);
 
@@ -36,4 +75,8 @@ int ble_hs_mbuf_to_flat(const struct os_mbuf *om, void *flat, uint16_t max_len,
 }
 #endif
 
+/**
+ * @}
+ */
+
 #endif

nimble/host/include/host/ble_uuid.h

@@ -20,6 +20,13 @@
 #ifndef H_BLE_UUID_
 #define H_BLE_UUID_
 
+/**
+ * @brief Bluetooth UUID
+ * @defgroup bt_uuid Bluetooth UUID
+ * @ingroup bt_host
+ * @{
+ */
+
 #include <inttypes.h>
 #include <stddef.h>
 
@@ -29,33 +36,43 @@ extern "C" {
 
 struct os_mbuf;
 
+/** Type of UUID */
 enum {
+    /** 16-bit UUID (BT SIG assigned) */
     BLE_UUID_TYPE_16 = 16,
+
+    /** 32-bit UUID (BT SIG assigned) */
     BLE_UUID_TYPE_32 = 32,
+
+    /** 128-bit UUID */
     BLE_UUID_TYPE_128 = 128,
 };
 
-/* Generic UUID type, to be used only as a pointer */
+/** Generic UUID type, to be used only as a pointer */
 typedef struct {
+    /** Type of the UUID */
     uint8_t type;
 } ble_uuid_t;
 
+/** 16-bit UUID */
 typedef struct {
     ble_uuid_t u;
     uint16_t value;
 } ble_uuid16_t;
 
+/** 32-bit UUID */
 typedef struct {
     ble_uuid_t u;
     uint32_t value;
 } ble_uuid32_t;
 
+/** 128-bit UUID */
 typedef struct {
     ble_uuid_t u;
     uint8_t value[16];
 } ble_uuid128_t;
 
-/* Universal UUID type, to be used for any-UUID static allocation */
+/** Universal UUID type, to be used for any-UUID static allocation */
 typedef union {
     ble_uuid_t u;
     ble_uuid16_t u16;
@@ -99,19 +116,67 @@ typedef union {
 #define BLE_UUID128(u) \
     ((ble_uuid128_t *) (u))
 
-/** Includes trailing \0. */
+/** Size of buffer needed to store UUID as a string.
+ *  Includes trailing \0.
+ */
 #define BLE_UUID_STR_LEN (37)
 
+/** @brief Constructs a UUID object from a byte array.
+ *
+ * @param uuid  On success, this gets populated with the constructed UUID.
+ * @param buf   The source buffer to parse.
+ * @param len   The size of the buffer, in bytes.
+ *
+ * @return      0 on success, BLE_HS_EINVAL if the source buffer does not contain
+ *              a valid UUID.
+ */
 int ble_uuid_init_from_buf(ble_uuid_any_t *uuid, const void *buf, size_t len);
-int ble_uuid_cmp(const ble_uuid_t *uuid1, const ble_uuid_t *uuid2);
-void ble_uuid_copy(ble_uuid_any_t *dst, const ble_uuid_t *src);
-char *ble_uuid_to_str(const ble_uuid_t *uuid, char *dst);
-uint16_t ble_uuid_u16(const ble_uuid_t *uuid);
 
-int ble_uuid_to_s(char *dst, int dst_sz, const void *uuid128);
+/** @brief Compares two Bluetooth UUIDs.
+ *
+ * @param uuid1  The first UUID to compare.
+ * @param uuid2  The second UUID to compare.
+ *
+ * @return       0 if the two UUIDs are equal, nonzero if the UUIDs differ.
+ */
+int ble_uuid_cmp(const ble_uuid_t *uuid1, const ble_uuid_t *uuid2);
+
+/** @brief Copy Bluetooth UUID
+ *
+ * @param dst    Destination UUID.
+ * @param src    Source UUID.
+ */
+void ble_uuid_copy(ble_uuid_any_t *dst, const ble_uuid_t *src);
+
+/** @brief Converts the specified UUID to its string representation.
+ *
+ * Example string representations:
+ *     o 16-bit:  0x1234
+ *     o 32-bit:  0x12345678
+ *     o 128-bit: 12345678-1234-1234-1234-123456789abc
+ *
+ * @param uuid   The source UUID to convert.
+ * @param dst    The destination buffer.
+ *
+ * @return       A pointer to the supplied destination buffer.
+ */
+char *ble_uuid_to_str(const ble_uuid_t *uuid, char *dst);
+
+/** @brief Converts the specified 16-bit UUID to a uint16_t.
+ *
+ * @param uuid   The source UUID to convert.
+ *
+ * @return       The converted integer on success, NULL if the specified UUID is
+ *               not 16 bits.
+ */
+uint16_t ble_uuid_u16(const ble_uuid_t *uuid);
 
 #ifdef __cplusplus
 }
 #endif
 
+/**
+ * @}
+ */
+
 #endif /* _BLE_HOST_UUID_H */

nimble/host/src/ble_gap.c

@@ -414,19 +414,6 @@ ble_gap_find_snapshot(uint16_t handle, struct ble_gap_snapshot *snap)
     }
 }
 
-/**
- * Searches for a connection with the specified handle.  If a matching
- * connection is found, the supplied connection descriptor is filled
- * correspondingly.
- *
- * @param handle                The connection handle to search for.
- * @param out_desc              On success, this is populated with information
- *                                  relating to the matching connection.  Pass
- *                                  NULL if you don't need this information.
- *
- * @return                      0 on success; BLE_HS_ENOTCONN if no matching
- *                                  connection was found.
- */
 int
 ble_gap_conn_find(uint16_t handle, struct ble_gap_conn_desc *out_desc)
 {
@@ -1630,21 +1617,6 @@ ble_gap_update_timer(void)
     return ticks_until_exp;
 }
 
-/**
- * Configures a connection to use the specified GAP event callback.  A
- * connection's GAP event callback is first specified when the connection is
- * created, either via advertising or initiation.  This function replaces the
- * callback that was last configured.
- *
- * @param conn_handle           The handle of the connection to configure.
- * @param cb                    The callback to associate with the connection.
- * @param cb_arg                An optional argument that the callback
- *                                  receives.
- *
- * @return                      0 on success;
- *                              BLE_HS_ENOTCONN if there is no connection with
- *                                  the specified handle.
- */
 int
 ble_gap_set_event_cb(uint16_t conn_handle, ble_gap_event_fn *cb, void *cb_arg)
 {
@@ -1747,14 +1719,6 @@ ble_gap_wl_tx_clear(void)
     return 0;
 }
 
-/**
- * Overwrites the controller's white list with the specified contents.
- *
- * @param addrs                 The entries to write to the white list.
- * @param white_list_count      The number of entries in the white list.
- *
- * @return                      0 on success; nonzero on failure.
- */
 int
 ble_gap_wl_set(const ble_addr_t *addrs, uint8_t white_list_count)
 {
@@ -1875,16 +1839,6 @@ done:
     return rc;
 }
 
-/**
- * Stops the currently-active advertising procedure.  A success return
- * code indicates that advertising has been fully aborted; a new advertising
- * procedure can be initiated immediately.
- *
- * @return                      0 on success;
- *                              BLE_HS_EALREADY if there is no active
- *                                  advertising procedure;
- *                              Other nonzero on error.
- */
 int
 ble_gap_adv_stop(void)
 {
@@ -2083,36 +2037,6 @@ ble_gap_adv_validate(uint8_t own_addr_type, const ble_addr_t *peer_addr,
 }
 #endif
 
-/**
- * Initiates advertising.
- *
- * @param own_addr_type         The type of address the stack should use for
- *                                  itself.  Valid values are:
- *                                      o BLE_OWN_ADDR_PUBLIC
- *                                      o BLE_OWN_ADDR_RANDOM
- *                                      o BLE_OWN_ADDR_RPA_PUBLIC_DEFAULT
- *                                      o BLE_OWN_ADDR_RPA_RANDOM_DEFAULT
- * @param direct_addr           The peer's address for directed advertising.
- *                                  This parameter shall be non-NULL if
- *                                  directed advertising is being used.
- * @param duration_ms           The duration of the advertisement procedure.
- *                                  On expiration, the procedure ends and a
- *                                  BLE_GAP_EVENT_ADV_COMPLETE event is
- *                                  reported.  Units are milliseconds.  Specify
- *                                  BLE_HS_FOREVER for no expiration.
- * @param adv_params            Additional arguments specifying the particulars
- *                                  of the advertising procedure.
- * @param cb                    The callback to associate with this advertising
- *                                  procedure.  If advertising ends, the event
- *                                  is reported through this callback.  If
- *                                  advertising results in a connection, the
- *                                  connection inherits this callback as its
- *                                  event-reporting mechanism.
- * @param cb_arg                The optional argument to pass to the callback
- *                                  function.
- *
- * @return                      0 on success; nonzero on failure.
- */
 int
 ble_gap_adv_start(uint8_t own_addr_type, const ble_addr_t *direct_addr,
                   int32_t duration_ms,
@@ -2196,16 +2120,6 @@ done:
 #endif
 }
 
-/**
- * Configures the data to include in subsequent advertisements.
- *
- * @param data                  Buffer containing the advertising data.
- * @param data_len              The size of the advertising data, in bytes.
- *
- * @return                      0 on success;
- *                              BLE_HS_EBUSY if advertising is in progress;
- *                              Other nonzero on failure.
- */
 int
 ble_gap_adv_set_data(const uint8_t *data, int data_len)
 {
@@ -2240,16 +2154,6 @@ done:
     return rc;
 }
 
-/**
- * Configures the data to include in subsequent scan responses.
- *
- * @param data                  Buffer containing the scan response data.
- * @param data_len              The size of the response data, in bytes.
- *
- * @return                      0 on success;
- *                              BLE_HS_EBUSY if advertising is in progress;
- *                              Other nonzero on failure.
- */
 int
 ble_gap_adv_rsp_set_data(const uint8_t *data, int data_len)
 {
@@ -2283,18 +2187,6 @@ done:
     return rc;
 }
 
-/**
- * Configures the fields to include in subsequent advertisements.  This is a
- * convenience wrapper for ble_gap_adv_set_data().
- *
- * @param adv_fields            Specifies the advertisement data.
- *
- * @return                      0 on success;
- *                              BLE_HS_EBUSY if advertising is in progress;
- *                              BLE_HS_EMSGSIZE if the specified data is too
- *                                  large to fit in an advertisement;
- *                              Other nonzero on failure.
- */
 int
 ble_gap_adv_set_fields(const struct ble_hs_adv_fields *adv_fields)
 {
@@ -2319,16 +2211,6 @@ ble_gap_adv_set_fields(const struct ble_hs_adv_fields *adv_fields)
     return 0;
 }
 
-/**
- * Configures the fields to include in subsequent scan responses.  This is a
- * convenience wrapper for ble_gap_adv_rsp_set_data().
- *
- * @param adv_fields            Specifies the scan response data.
- *
- * @return                      0 on success;
- *                              BLE_HS_EBUSY if advertising is in progress;
- *                              Other nonzero on failure.
- */
 int
 ble_gap_adv_rsp_set_fields(const struct ble_hs_adv_fields *rsp_fields)
 {
@@ -2353,12 +2235,6 @@ ble_gap_adv_rsp_set_fields(const struct ble_hs_adv_fields *rsp_fields)
     return 0;
 }
 
-/**
- * Indicates whether an advertisement procedure is currently in progress.
- *
- * @return                      0: No advertisement procedure in progress;
- *                              1: Advertisement procedure in progress.
- */
 int
 ble_gap_adv_active(void)
 {
@@ -3169,16 +3045,6 @@ done:
 }
 #endif
 
-/**
- * Cancels the discovery procedure currently in progress.  A success return
- * code indicates that scanning has been fully aborted; a new discovery or
- * connect procedure can be initiated immediately.
- *
- * @return                      0 on success;
- *                              BLE_HS_EALREADY if there is no discovery
- *                                  procedure to cancel;
- *                              Other nonzero on unexpected error.
- */
 int
 ble_gap_disc_cancel(void)
 {
@@ -3380,34 +3246,6 @@ ble_gap_disc_validate(uint8_t own_addr_type,
 }
 #endif
 
-/**
- * Performs the Limited or General Discovery Procedures.
- *
- * @param own_addr_type         The type of address the stack should use for
- *                                  itself when sending scan requests.  Valid
- *                                  values are:
- *                                      o BLE_ADDR_TYPE_PUBLIC
- *                                      o BLE_ADDR_TYPE_RANDOM
- *                                      o BLE_ADDR_TYPE_RPA_PUB_DEFAULT
- *                                      o BLE_ADDR_TYPE_RPA_RND_DEFAULT
- *                                  This parameter is ignored unless active
- *                                  scanning is being used.
- * @param duration_ms           The duration of the discovery procedure.
- *                                  On expiration, the procedure ends and a
- *                                  BLE_GAP_EVENT_DISC_COMPLETE event is
- *                                  reported.  Units are milliseconds.  Specify
- *                                  BLE_HS_FOREVER for no expiration.
- * @param disc_params           Additional arguments specifying the particulars
- *                                  of the discovery procedure.
- * @param cb                    The callback to associate with this discovery
- *                                  procedure.  Advertising reports and
- *                                  discovery termination events are reported
- *                                  through this callback.
- * @param cb_arg                The optional argument to pass to the callback
- *                                  function.
- *
- * @return                      0 on success; nonzero on failure.
- */
 int
 ble_gap_disc(uint8_t own_addr_type, int32_t duration_ms,
              const struct ble_gap_disc_params *disc_params,
@@ -3494,12 +3332,6 @@ done:
 #endif
 }
 
-/**
- * Indicates whether a discovery procedure is currently in progress.
- *
- * @return                      0: No discovery procedure in progress;
- *                              1: Discovery procedure in progress.
- */
 int
 ble_gap_disc_active(void)
 {
@@ -3804,43 +3636,6 @@ done:
 }
 #endif
 
-/**
- * Initiates a connect procedure.
- *
- * @param own_addr_type         The type of address the stack should use for
- *                                  itself during connection establishment.
- *                                      o BLE_OWN_ADDR_PUBLIC
- *                                      o BLE_OWN_ADDR_RANDOM
- *                                      o BLE_OWN_ADDR_RPA_PUBLIC_DEFAULT
- *                                      o BLE_OWN_ADDR_RPA_RANDOM_DEFAULT
- * @param peer_addr             The address of the peer to connect to.
- *                                  If this parameter is NULL, the white list
- *                                  is used.
- * @param duration_ms           The duration of the discovery procedure.
- *                                  On expiration, the procedure ends and a
- *                                  BLE_GAP_EVENT_DISC_COMPLETE event is
- *                                  reported.  Units are milliseconds.
- * @param conn_params           Additional arguments specifying the particulars
- *                                  of the connect procedure.  Specify null for
- *                                  default values.
- * @param cb                    The callback to associate with this connect
- *                                  procedure.  When the connect procedure
- *                                  completes, the result is reported through
- *                                  this callback.  If the connect procedure
- *                                  succeeds, the connection inherits this
- *                                  callback as its event-reporting mechanism.
- * @param cb_arg                The optional argument to pass to the callback
- *                                  function.
- *
- * @return                      0 on success;
- *                              BLE_HS_EALREADY if a connection attempt is
- *                                  already in progress;
- *                              BLE_HS_EBUSY if initiating a connection is not
- *                                  possible because scanning is in progress;
- *                              BLE_HS_EDONE if the specified peer is already
- *                                  connected;
- *                              Other nonzero on error.
- */
 int
 ble_gap_connect(uint8_t own_addr_type, const ble_addr_t *peer_addr,
                 int32_t duration_ms,
@@ -3951,12 +3746,6 @@ done:
     return rc;
 }
 
-/**
- * Indicates whether a connect procedure is currently in progress.
- *
- * @return                      0: No connect procedure in progress;
- *                              1: Connect procedure in progress.
- */
 int
 ble_gap_conn_active(void)
 {
@@ -3967,20 +3756,6 @@ ble_gap_conn_active(void)
 /*****************************************************************************
  * $terminate connection procedure                                           *
  *****************************************************************************/
-
-/**
- * Terminates an established connection.
- *
- * @param conn_handle           The handle corresponding to the connection to
- *                                  terminate.
- * @param hci_reason            The HCI error code to indicate as the reason
- *                                  for termination.
- *
- * @return                      0 on success;
- *                              BLE_HS_ENOTCONN if there is no connection with
- *                                  the specified handle;
- *                              Other nonzero on failure.
- */
 int
 ble_gap_terminate(uint16_t conn_handle, uint8_t hci_reason)
 {
@@ -4081,14 +3856,6 @@ done:
     return rc;
 }
 
-/**
- * Aborts a connect procedure in progress.
- *
- * @return                      0 on success;
- *                              BLE_HS_EALREADY if there is no active connect
- *                                  procedure.
- *                              Other nonzero on error.
- */
 int
 ble_gap_conn_cancel(void)
 {
@@ -4359,24 +4126,6 @@ ble_gap_validate_conn_params(const struct ble_gap_upd_params *params)
     return true;
 }
 
-/**
- * Initiates a connection parameter update procedure.
- *
- * @param conn_handle           The handle corresponding to the connection to
- *                                  update.
- * @param params                The connection parameters to attempt to update
- *                                  to.
- *
- * @return                      0 on success;
- *                              BLE_HS_ENOTCONN if the there is no connection
- *                                  with the specified handle;
- *                              BLE_HS_EALREADY if a connection update
- *                                  procedure for this connection is already in
- *                                  progress;
- *                              BLE_HS_EINVAL if requested parameters are
- *                                  invalid;
- *                              Other nonzero on error.
- */
 int
 ble_gap_update_params(uint16_t conn_handle,
                       const struct ble_gap_upd_params *params)
@@ -4473,20 +4222,6 @@ done:
 /*****************************************************************************
  * $security                                                                 *
  *****************************************************************************/
-
-/**
- * Initiates the GAP encryption procedure.
- *
- * @param conn_handle           The handle corresponding to the connection to
- *                                  encrypt.
- *
- * @return                      0 on success;
- *                              BLE_HS_ENOTCONN if the there is no connection
- *                                  with the specified handle;
- *                              BLE_HS_EALREADY if an encrpytion procedure for
- *                                  this connection is already in progress;
- *                              Other nonzero on error.
- */
 int
 ble_gap_security_initiate(uint16_t conn_handle)
 {
@@ -4670,19 +4405,6 @@ ble_gap_repeat_pairing_event(const struct ble_gap_repeat_pairing *rp)
  * $rssi                                                                     *
  *****************************************************************************/
 
-/**
- * Retrieves the most-recently measured RSSI for the specified connection.  A
- * connection's RSSI is updated whenever a data channel PDU is received.
- *
- * @param conn_handle           Specifies the connection to query.
- * @param out_rssi              On success, the retrieved RSSI is written here.
- *
- * @return                      0 on success;
- *                              A BLE host HCI return code if the controller
- *                                  rejected the request;
- *                              A BLE host core return code on unexpected
- *                                  error.
- */
 int
 ble_gap_conn_rssi(uint16_t conn_handle, int8_t *out_rssi)
 {

nimble/host/src/ble_hs.c

@@ -104,13 +104,6 @@ ble_hs_evq_get(void)
     return ble_hs_evq;
 }
 
-/**
- * Designates the specified event queue for NimBLE host work.  By default, the
- * host uses the default event queue and runs in the main task.  This function
- * is useful if you want the host to run in a different task.
- *
- * @param evq                   The event queue to use for host work.
- */
 void
 ble_hs_evq_set(struct ble_npl_eventq *evq)
 {
@@ -304,13 +297,6 @@ ble_hs_clear_rx_queue(void)
     }
 }
 
-/**
- * Indicates whether the host has synchronized with the controller.
- * Synchronization must occur before any host procedures can be performed.
- *
- * @return                      1 if the host and controller are in sync;
- *                              0 if the host and controller our out of sync.
- */
 int
 ble_hs_synced(void)
 {
@@ -537,13 +523,6 @@ ble_hs_notifications_sched(void)
     ble_npl_eventq_put(ble_hs_evq, &ble_hs_ev_tx_notifications);
 }
 
-/**
- * Causes the host to reset the NimBLE stack as soon as possible.  The
- * application is notified when the reset occurs via the host reset callback.
- *
- * @param reason                The host error code that gets passed to the
- *                                  reset callback.
- */
 void
 ble_hs_sched_reset(int reason)
 {
@@ -559,19 +538,6 @@ ble_hs_hw_error(uint8_t hw_code)
     ble_hs_sched_reset(BLE_HS_HW_ERR(hw_code));
 }
 
-/**
- * Synchronizes the host with the controller by sending a sequence of HCI
- * commands.  This function must be called before any other host functionality
- * is used, but it must be called after both the host and controller are
- * initialized.  Typically, the host-parent-task calls this function at the top
- * of its task routine.
- *
- * If the host fails to synchronize with the controller (if the controller is
- * not fully booted, for example), the host will attempt to resynchronize every
- * 100 ms.  For this reason, an error return code is not necessarily fatal.
- *
- * @return                      0 on success; nonzero on error.
- */
 int
 ble_hs_start(void)
 {
@@ -640,13 +606,6 @@ ble_hs_tx_data(struct os_mbuf *om)
     return 0;
 }
 
-/**
- * Initializes the NimBLE host.  This function must be called before the OS is
- * started.  The NimBLE stack requires an application task to function.  One
- * application task in particular is designated as the "host parent task".  In
- * addition to application-specific work, the host parent task does work for
- * NimBLE by processing events generated by the host.
- */
 void
 ble_hs_init(void)
 {

nimble/host/src/ble_hs_mbuf.c

@@ -84,16 +84,6 @@ ble_hs_mbuf_l2cap_pkt(void)
     return ble_hs_mbuf_gen_pkt(BLE_HCI_DATA_HDR_SZ + BLE_L2CAP_HDR_SZ);
 }
 
-/**
- * Allocates an mbuf suitable for an ATT command packet.  The resulting packet
- * has sufficient leading space for:
- *     o ACL data header
- *     o L2CAP B-frame header
- *     o Largest ATT command base (prepare write request / response).
- *
- * @return                  An empty mbuf on success; null on memory
- *                              exhaustion.
- */
 struct os_mbuf *
 ble_hs_mbuf_att_pkt(void)
 {
@@ -105,16 +95,6 @@ ble_hs_mbuf_att_pkt(void)
                                 BLE_ATT_PREP_WRITE_CMD_BASE_SZ);
 }
 
-/**
- * Allocates a an mbuf and fills it with the contents of the specified flat
- * buffer.
- *
- * @param buf                   The flat buffer to copy from.
- * @param len                   The length of the flat buffer.
- *
- * @return                      A newly-allocated mbuf on success;
- *                              NULL on memory exhaustion.
- */
 struct os_mbuf *
 ble_hs_mbuf_from_flat(const void *buf, uint16_t len)
 {
@@ -135,23 +115,6 @@ ble_hs_mbuf_from_flat(const void *buf, uint16_t len)
     return om;
 }
 
-/**
- * Copies the contents of an mbuf into the specified flat buffer.  If the flat
- * buffer is too small to contain the mbuf's contents, it is filled to capacity
- * and BLE_HS_EMSGSIZE is returned.
- *
- * @param om                    The mbuf to copy from.
- * @param flat                  The destination flat buffer.
- * @param max_len               The size of the flat buffer.
- * @param out_copy_len          The number of bytes actually copied gets
- *                                  written here.
- *
- * @return                      0 on success;
- *                              BLE_HS_EMSGSIZE if the flat buffer is too small
- *                                  to contain the mbuf's contents;
- *                              A BLE host core return code on unexpected
- *                                  error.
- */
 int
 ble_hs_mbuf_to_flat(const struct os_mbuf *om, void *flat, uint16_t max_len,
                     uint16_t *out_copy_len)

nimble/host/src/ble_uuid.c

@@ -50,18 +50,6 @@ static int verify_uuid(const ble_uuid_t *uuid)
 }
 #endif
 
-/**
- * Constructs a UUID object from a byte array.
- *
- * @param uuid                  On success, this gets populated with the
- *                                  constructed UUID.
- * @param buf                   The source buffer to parse.
- * @param len                   The size of the buffer, in bytes.
- *
- * @return                      0 on success;
- *                              BLE_HS_EINVAL if the source buffer does not
- *                                  contain a valid UUID.
- */
 int
 ble_uuid_init_from_buf(ble_uuid_any_t *uuid, const void *buf, size_t len)
 {
@@ -83,15 +71,6 @@ ble_uuid_init_from_buf(ble_uuid_any_t *uuid, const void *buf, size_t len)
     return BLE_HS_EINVAL;
 }
 
-/**
- * Compares two Bluetooth UUIDs.
- *
- * @param uuid1                 The first UUID to compare.
- * @param uuid2                 The second UUID to compare.
- *
- * @return                      0 if the two UUIDs are equal;
- *                              nonzero if the UUIDs differ.
- */
 int
 ble_uuid_cmp(const ble_uuid_t *uuid1, const ble_uuid_t *uuid2)
 {
@@ -135,19 +114,6 @@ ble_uuid_copy(ble_uuid_any_t *dst, const ble_uuid_t *src)
     }
 }
 
-/**
- * Converts the specified UUID to its string representation.
- *
- * Example string representations:
- *     o 16-bit:  0x1234
- *     o 32-bit:  0x12345678
- *     o 128-bit: 12345678-1234-1234-1234-123456789abc
- *
- * @param uuid                  The source UUID to convert.
- * @param dst                   The destination buffer.
- *
- * @return                      A pointer to the supplied destination buffer.
- */
 char *
 ble_uuid_to_str(const ble_uuid_t *uuid, char *dst)
 {
@@ -178,14 +144,6 @@ ble_uuid_to_str(const ble_uuid_t *uuid, char *dst)
     return dst;
 }
 
-/**
- * Converts the specified 16-bit UUID to a uint16_t.
- *
- * @param uuid                  The source UUID to convert.
- *
- * @return                      The converted integer on success;
- *                              0 if the specified UUID is not 16 bits.
- */
 uint16_t
 ble_uuid_u16(const ble_uuid_t *uuid)
 {