BLE - Devirtualization of the Cordio port.

Author: pan-

features/FEATURE_BLE/targets/TARGET_CORDIO/BleImplementationForward.h

@@ -0,0 +1,165 @@
+/* mbed Microcontroller Library
+ * Copyright (c) 2019 ARM Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef MBED_OS_EXAMPLE_BLINKY_BLEIMPLEMENTATIONFORWARD_H
+#define MBED_OS_EXAMPLE_BLINKY_BLEIMPLEMENTATIONFORWARD_H
+
+////////////////////////////////////////////////////////////////////////////////
+// Forward declarations of the implementation types
+//
+namespace ble {
+
+    namespace interface {
+
+        template<class Impl>
+        class LegacyGap;
+
+        template<class Impl>
+        class Gap;
+
+        template<class Impl>
+        class GattClient;
+
+        template<class Impl>
+        class SecurityManager;
+
+        template<class Impl>
+        class GattServer;
+
+    } // namespace interface
+
+
+    namespace generic {
+
+        template<
+            template<class> class TGapImpl,
+            class PalSecurityManager,
+            class ConnectionEventMonitorEventHandler
+        >
+        class GenericGap;
+
+        template <
+            template<class> class TPalSecurityManager,
+            template<class> class SigningMonitor
+        >
+        class GenericSecurityManager;
+
+        template<template<class> class TPalGattClient, class SigningMonitorEventHandler>
+        class GenericGattClient;
+
+    } // namespace generic
+
+    namespace pal {
+
+        template<class Impl, class EventHandler>
+        class SecurityManager;
+
+        template<class AttClient, class EventHandler>
+        class AttClientToGattClientAdapter;
+
+        namespace vendor {
+            namespace cordio {
+
+                template <class EventHandler>
+                class CordioSecurityManager;
+
+                template<class EventHandler>
+                class Gap;
+
+                template<class EventHandler>
+                class CordioGattClient;
+            } // cordio
+        } // vendor
+    } // pal
+
+    namespace vendor {
+        namespace cordio {
+
+            template<class EventHandler>
+            class SigningEventMonitor;
+
+            class GattServer;
+
+        } // cordio
+    } // vendor
+} // ble
+
+
+// implementation assembly
+namespace ble {
+    namespace impl {
+        // SECURITY MANAGER
+        typedef generic::GenericSecurityManager<
+            pal::vendor::cordio::CordioSecurityManager,
+            vendor::cordio::SigningEventMonitor
+        > GenericSecurityManagerImpl;
+
+        typedef interface::SecurityManager<GenericSecurityManagerImpl> SecurityManager;
+
+        typedef GenericSecurityManagerImpl SigningEventHandler;
+
+        typedef pal::vendor::cordio::CordioSecurityManager<
+            GenericSecurityManagerImpl
+        > PalSecurityManagerImpl;
+
+        typedef ::ble::pal::SecurityManager<
+            PalSecurityManagerImpl,
+            GenericSecurityManagerImpl
+        > PalSecurityManager;
+
+        // GAP
+        typedef generic::GenericGap<
+            pal::vendor::cordio::Gap,
+            PalSecurityManager,
+            GenericSecurityManagerImpl
+        > GenericGapImpl;
+
+        typedef pal::vendor::cordio::Gap<impl::GenericGapImpl> PalGapImpl;
+
+        typedef interface::LegacyGap<GenericGapImpl> LegacyGap;
+
+        typedef interface::Gap<GenericGapImpl> Gap;
+
+        // GATT CLIENT
+        using pal::AttClientToGattClientAdapter;
+        using pal::vendor::cordio::CordioGattClient;
+        using generic::GenericGattClient;
+
+        // construct the pal::GattClient
+        typedef GenericGattClient<
+            CordioGattClient,
+            SigningEventHandler
+        > GenericGattClientImpl;
+
+        typedef CordioGattClient<GenericGattClientImpl> PalGattClientImpl;
+
+        // construct the final GattClient type
+        typedef interface::GattClient<
+            GenericGattClientImpl
+        > GattClient;
+
+        // GATT SERVER
+        typedef ble::vendor::cordio::GattServer GattServerImpl;
+
+        typedef ble::interface::GattServer<
+            GattServerImpl
+        > GattServer;
+
+    } // impl
+} // ble
+
+
+#endif //MBED_OS_EXAMPLE_BLINKY_BLEIMPLEMENTATIONFORWARD_H

features/FEATURE_BLE/targets/TARGET_CORDIO/CordioBLE.h

@@ -32,6 +32,9 @@
 #include "ble/generic/GenericSecurityManager.h"
 #include "SimpleEventQueue.h"
 #include "Timer.h"
+#include "SigningMonitorProxy.h"
+#include "CordioPalSecurityManager.h"
+#include "BleImplementationForward.h"
 
 namespace ble {
 namespace vendor {
@@ -85,12 +88,12 @@ class BLE : public ::BLEInstanceBase {
     /**
      * @see BLEInstanceBase::getGap
      */
-    virtual generic::GenericGap& getGap();
+    virtual impl::GenericGapImpl& getGap();
 
     /**
      * @see BLEInstanceBase::getGap
      */
-    virtual const generic::GenericGap& getGap() const;
+    virtual const impl::GenericGapImpl& getGap() const;
 
     /**
      * @see BLEInstanceBase::getGattServer
@@ -105,14 +108,14 @@ class BLE : public ::BLEInstanceBase {
     /**
      * @see BLEInstanceBase::getGattClient
      */
-    virtual generic::GenericGattClient &getGattClient();
+    virtual impl::GenericGattClientImpl &getGattClient();
 
     /**
      * Get the PAL Gatt Client.
      *
      * @return PAL Gatt Client.
      */
-    pal::AttClientToGattClientAdapter &getPalGattClient();
+    impl::PalGattClientImpl &getPalGattClient();
 
     /**
      * @see BLEInstanceBase::getSecurityManager
@@ -139,7 +142,7 @@ class BLE : public ::BLEInstanceBase {
      * Return singleton.
      * @return GenericGap instance.
      */
-    const generic::GenericGap& getGenericGap() const;
+    const impl::GenericGapImpl& getGenericGap() const;
 
     static void stack_handler(wsfEventMask_t event, wsfMsgHdr_t* msg);
     static void device_manager_cb(dmEvt_t* dm_event);
@@ -163,17 +166,6 @@ class BLE : public ::BLEInstanceBase {
     mutable SimpleEventQueue _event_queue;
     mbed::Timer _timer;
     uint64_t _last_update_us;
-
-    class SigningEventMonitorProxy : public pal::SigningEventMonitor {
-    public:
-        SigningEventMonitorProxy(BLE &ble) : _ble(ble) { }
-        virtual void set_signing_event_handler(pal::SigningEventMonitor::EventHandler *handler) {
-            _ble.getGattClient().set_signing_event_handler(handler);
-            _ble.getGattServer().set_signing_event_handler(handler);
-        }
-    private:
-        BLE &_ble;
-    };
 };
 
 } // namespace cordio

features/FEATURE_BLE/targets/TARGET_CORDIO/CordioGattServer.h

@@ -24,6 +24,7 @@
 #include "ble/Gap.h"
 #include "wsf_types.h"
 #include "att_api.h"
+#include "SecurityManager.h"
 
 /*! Maximum count of characteristics that can be stored for authorisation purposes */
 #define MAX_CHARACTERISTIC_AUTHORIZATION_CNT 20
@@ -50,12 +51,14 @@ class BLE;
 /**
  * Cordio implementation of ::GattServer
  */
-class GattServer : public ::GattServer,
-                   public pal::SigningEventMonitor
+class GattServer : public ::ble::interface::GattServer<GattServer>,
+                   public pal::SigningEventMonitor<GattServer, impl::SigningEventHandler>
 {
     friend ble::vendor::cordio::BLE;
     friend ble::pal::vendor::cordio::CordioAttClient;
 
+    typedef ::ble::interface::GattServer<GattServer> Base;
+
 public:
     /**
      * Return the singleton of the Cordio implementation of ::GattServer.
@@ -75,12 +78,12 @@ class GattServer : public ::GattServer,
     /**
      * @see ::GattServer::addService
      */
-    virtual ble_error_t addService(GattService &);
+    ble_error_t addService_(GattService &);
 
     /**
      * @see ::GattServer::read
      */
-    virtual ble_error_t read(
+    ble_error_t read_(
         GattAttribute::Handle_t attributeHandle,
         uint8_t buffer[],
         uint16_t *lengthP
@@ -89,7 +92,7 @@ class GattServer : public ::GattServer,
     /**
      * @see ::GattServer::read
      */
-    virtual ble_error_t read(
+    ble_error_t read_(
         connection_handle_t connectionHandle,
         GattAttribute::Handle_t attributeHandle,
         uint8_t buffer[], uint16_t *lengthP
@@ -98,7 +101,7 @@ class GattServer : public ::GattServer,
     /**
      * @see ::GattServer::write
      */
-    virtual ble_error_t write(
+    ble_error_t write_(
         GattAttribute::Handle_t,
         const uint8_t[], uint16_t,
         bool localOnly = false
@@ -107,7 +110,7 @@ class GattServer : public ::GattServer,
     /**
      * @see ::GattServer::write
      */
-    virtual ble_error_t write(
+    ble_error_t write_(
         connection_handle_t connectionHandle,
         GattAttribute::Handle_t,
         const uint8_t[],
@@ -118,14 +121,14 @@ class GattServer : public ::GattServer,
     /**
      * @see ::GattServer::areUpdatesEnabled
      */
-    virtual ble_error_t areUpdatesEnabled(
+    ble_error_t areUpdatesEnabled_(
         const GattCharacteristic &characteristic, bool *enabledP
     );
 
     /**
      * @see ::GattServer::areUpdatesEnabled
      */
-    virtual ble_error_t areUpdatesEnabled(
+    ble_error_t areUpdatesEnabled_(
         connection_handle_t connectionHandle,
         const GattCharacteristic &characteristic,
         bool *enabledP
@@ -134,52 +137,53 @@ class GattServer : public ::GattServer,
     /**
      * @see ::GattServer::isOnDataReadAvailable
      */
-    virtual bool isOnDataReadAvailable() const;
+    bool isOnDataReadAvailable_() const;
 
     /**
      * @see ::GattServer::getPreferredConnectionParams
      */
-    virtual ::Gap::ConnectionParams_t getPreferredConnectionParams();
+    ::Gap::ConnectionParams_t getPreferredConnectionParams();
 
     /**
      * @see ::GattServer::setPreferredConnectionParams
      */
-    virtual void setPreferredConnectionParams(const ::Gap::ConnectionParams_t& params);
+    void setPreferredConnectionParams(const ::Gap::ConnectionParams_t& params);
 
     /**
      * @see ::GattServer::setDeviceName
      */
-    virtual ble_error_t setDeviceName(const uint8_t *deviceName);
+    ble_error_t setDeviceName(const uint8_t *deviceName);
 
     /**
      * @see ::GattServer::getDeviceName
      */
-    virtual void getDeviceName(const uint8_t*& name, uint16_t& length);
+    void getDeviceName(const uint8_t*& name, uint16_t& length);
 
     /**
      * @see ::GattServer::setAppearance
      */
-    virtual void setAppearance(GapAdvertisingData::Appearance appearance);
+    void setAppearance(GapAdvertisingData::Appearance appearance);
 
     /**
      * @see ::GattServer::getAppearance
      */
-    virtual GapAdvertisingData::Appearance getAppearance();
+    GapAdvertisingData::Appearance getAppearance();
 
     /**
      * @see ::GattServer::reset
      */
-    virtual ble_error_t reset(void);
+    ble_error_t reset_(void);
 
     /**
      * @see pal::SigningEventMonitor::set_signing_event_handler
      */
-    virtual void set_signing_event_handler(
-        pal::SigningEventMonitor::EventHandler *signing_event_handler
+    void set_signing_event_handler_(
+        impl::SigningEventHandler *signing_event_handler
     ) {
         _signing_event_handler = signing_event_handler;
     }
 
+
 private:
     static uint16_t compute_attributes_count(GattService& service);
 
@@ -240,7 +244,7 @@ class GattServer : public ::GattServer,
         internal_service_t *next;
     };
 
-    pal::SigningEventMonitor::EventHandler *_signing_event_handler;
+    impl::SigningEventHandler *_signing_event_handler;
 
     attsCccSet_t cccds[MAX_CCCD_CNT];
     uint16_t cccd_values[MAX_CCCD_CNT];