Merge pull request #8981 from donatieng/cordio_nordic_memory_optimizations

Cordio Nordic memory optimizations

Author: Cruz Monrreal

features/FEATURE_BLE/targets/TARGET_CORDIO/doc/PortingGuide.md

@@ -149,17 +149,26 @@ The functions `do_initialize` and `do_terminate` handle initialization and termi
 
 ##### Memory pool
 
-The function `get_buffer_pool_description` in the base class returns a buffer of 1040 bytes divided into different memory pools:
+Porters must override the `get_buffer_pool_description` function, which should return a buffer pool for the Cordio stack to use.
+
+The function `get_default_buffer_pool_description` in the base class returns a buffer of 2250 bytes divided into different memory pools, and most implementations can use it:
 
 | Chunk size (bytes) | Number of chunks |
 |--------------------|------------------|
-| 16                 | 8                |
-| 32                 | 4                |
-| 64                 | 2                |
-| 128                | 2                |
+| 16                 | 16               |
+| 32                 | 16               |
+| 64                 | 8                |
+| 128                | 4                |
 | 272                | 1                |
 
-Porting overrides this function if the memory provided by the base class doesn't match what is required by the Bluetooth controller driver.
+**Example:**
+```
+buf_pool_desc_t CordioHCIDriver::get_buffer_pool_description()  {
+    return get_default_buffer_pool_description();
+}
+```
+
+If the memory the base class provides doesn't match what the Bluetooth controller driver requires, a custom pool can be returned.
 
 **Example:**
 

features/FEATURE_BLE/targets/TARGET_CORDIO/driver/CordioHCIDriver.cpp

@@ -78,7 +78,7 @@ void CordioHCIDriver::terminate()
     _transport_driver.terminate();
 }
 
-buf_pool_desc_t CordioHCIDriver::get_buffer_pool_description()
+buf_pool_desc_t CordioHCIDriver::get_default_buffer_pool_description()
 {
     static union {
         uint8_t buffer[2250];

features/FEATURE_BLE/targets/TARGET_CORDIO/driver/CordioHCIDriver.h

@@ -77,7 +77,7 @@ class CordioHCIDriver {
     /**
      * Return the set of memory pool which will be used by the Cordio stack
      */
-    virtual buf_pool_desc_t get_buffer_pool_description();
+    virtual buf_pool_desc_t get_buffer_pool_description() = 0;
 
     /**
      * Initialize the HCI driver.
@@ -126,6 +126,13 @@ class CordioHCIDriver {
      */
     uint16_t write(uint8_t type, uint16_t len, uint8_t *pData);
 
+protected:
+    /**
+     * Return a default set of memory pool that the Cordio stack can use.
+     * This function can be used to implement get_buffer_pool_description().
+     */
+    buf_pool_desc_t get_default_buffer_pool_description();
+
 private:
     /**
      * Initialize the chip.

features/FEATURE_BLE/targets/TARGET_CORDIO/source/CordioBLE.cpp

@@ -330,8 +330,15 @@ void BLE::stack_setup()
         buf_pool_desc.pool_count, buf_pool_desc.pool_description
     );
 
+    // Raise assert if not enough memory was allocated
     MBED_ASSERT(bytes_used != 0);
 
+    // This warning will be raised if we've allocated too much memory
+    if(bytes_used < buf_pool_desc.buffer_size)
+    {
+        MBED_WARNING1(MBED_MAKE_ERROR(MBED_MODULE_BLE, MBED_ERROR_CODE_INVALID_SIZE), "Too much memory allocated for Cordio memory pool, reduce buf_pool_desc.buffer_size by value below.", buf_pool_desc.buffer_size - bytes_used);
+    }
+
     WsfTimerInit();
     SecInit();
 

features/FEATURE_BLE/targets/TARGET_CORDIO_ODIN_W2/HCIDriver.cpp

@@ -41,6 +41,8 @@ class HCIDriver : public cordio::CordioHCIDriver {
         service_pack_transfered(false) {
     };
 
+    virtual cordio::buf_pool_desc_t get_buffer_pool_description();
+
     virtual void do_initialize();
 
     virtual void do_terminate();
@@ -134,6 +136,13 @@ class HCIDriver : public cordio::CordioHCIDriver {
 } // namespace vendor
 } // namespace ble
 
+
+ble::vendor::cordio::buf_pool_desc_t ble::vendor::odin_w2::HCIDriver::get_buffer_pool_description()
+{
+    // Use default buffer pool
+    return ble::vendor::cordio::CordioHCIDriver::get_default_buffer_pool_description();
+}
+
 void ble::vendor::odin_w2::HCIDriver::do_initialize()
 {
     cordio_callback_s    callback;

features/FEATURE_BLE/targets/TARGET_CYW4343X/HCIDriver.cpp

@@ -84,6 +84,12 @@ class HCIDriver : public cordio::CordioHCIDriver {
         service_pack_transfered(false) {
     }
 
+    virtual cordio::buf_pool_desc_t get_buffer_pool_description()
+    {
+        // Use default buffer pool
+        return cordio::CordioHCIDriver::get_default_buffer_pool_description();
+    }
+
     virtual void do_initialize()
     {
         output_mode(bt_host_wake_name, 1);

features/FEATURE_BLE/targets/TARGET_Cypress/TARGET_CY8C63XX/Psoc6BLE.cpp

@@ -46,6 +46,8 @@ class Psoc6HCIDriver : public CordioHCIDriver
         BdAddress() : addr_type(0) {}
     };
 
+    virtual cordio::buf_pool_desc_t get_buffer_pool_description();
+
     /**
      * Initialize the chip.
      * The transport is up at that time.
@@ -63,6 +65,12 @@ class Psoc6HCIDriver : public CordioHCIDriver
     BdAddress   bd_address;
 };
 
+cordio::buf_pool_desc_t Psoc6HCIDriver::get_buffer_pool_description()
+{
+    // Use default buffer pool
+    return ble::vendor::cordio::CordioHCIDriver::get_default_buffer_pool_description();
+}
+
 
 void Psoc6HCIDriver::do_initialize()
 {

features/FEATURE_BLE/targets/TARGET_NORDIC/TARGET_NORDIC_CORDIO/TARGET_NRF5x/NRFCordioHCIDriver.cpp

@@ -56,7 +56,11 @@ using namespace ble::vendor::nordic;
 using namespace ble::vendor::cordio;
 
 /*! \brief      Memory that should be reserved for the stack. */
+#if defined(NRF52840_XXAA)
 #define CORDIO_LL_MEMORY_FOOTPRINT  41906UL
+#else
+#define CORDIO_LL_MEMORY_FOOTPRINT  12768UL
+#endif
 
 /*! \brief      Typical implementation revision number (LlRtCfg_t::implRev). */
 #define LL_IMPL_REV             0x2303
@@ -107,7 +111,11 @@ const LlRtCfg_t NRFCordioHCIDriver::_ll_cfg = {
     /*maxScanReqRcvdEvt*/         4,
     /*maxExtScanDataLen*/         advDataLen,
     /* Connection */
+    #if defined(NRF52840_XXAA)
     /*maxConn*/          4,
+    #else
+    /*maxConn*/          2,
+    #endif
     /*numTxBufs*/          numTxBufs,
     /*numRxBufs*/          numRxBufs,
     /*maxAclLen*/          connDataLen,
@@ -117,7 +125,11 @@ const LlRtCfg_t NRFCordioHCIDriver::_ll_cfg = {
     /*dtmRxSyncMs*/          10000,
     /* PHY */
     /*phy2mSup*/          TRUE,
+    #if defined(NRF52840_XXAA)
     /*phyCodedSup*/          TRUE,
+    #else
+    /*phyCodedSup*/          FALSE,
+    #endif
     /*stableModIdxTxSup*/         TRUE,
     /*stableModIdxRxSup*/          TRUE
 };
@@ -184,7 +196,11 @@ NRFCordioHCIDriver::~NRFCordioHCIDriver()
 ble::vendor::cordio::buf_pool_desc_t NRFCordioHCIDriver::get_buffer_pool_description()
 {
     static union {
+        #if defined(NRF52840_XXAA)
         uint8_t buffer[ 17304 ];
+        #else
+        uint8_t buffer[ 8920 ];
+        #endif
         uint64_t align;
     };
     static const wsfBufPoolDesc_t pool_desc[] = {