move pal to cordio, remove cordio mentions from API

Author: paul-szczepanek-arm

components/BLE/COMPONENT_BlueNRG_MS/BlueNrgMsHCIDriver.cpp

@@ -27,7 +27,7 @@
 #include "platform/mbed_wait_api.h"
 
 // FEATURE_BLE/targets/TARGET_CORDIO
-#include "CordioBLEInstanceBase.h"
+#include "BLEInstanceBase.h"
 #include "CordioHCIDriver.h"
 #include "CordioHCITransportDriver.h"
 #include "hci_api.h"

connectivity/FEATURE_BLE/cordio/TARGET_CORDIO/driver/CordioHCIDriver.cpp

@@ -17,7 +17,7 @@
 #include <stddef.h>
 #include <string.h>
 
-#include "ble/internal/cordio/CordioBLEInstanceBase.h"
+#include "ble/internal/BLEInstanceBase.h"
 #include "ble/BLE.h"
 #include "ble/Gap.h"
 #include "CordioHCIDriver.h"
@@ -98,7 +98,7 @@ buf_pool_desc_t CordioHCIDriver::get_default_buffer_pool_description()
 
 void CordioHCIDriver::set_random_static_address(const ble::address_t& address)
 {
-    ble_error_t err = CordioBLEInstanceBase::deviceInstance().getGap().setRandomStaticAddress(address);
+    ble_error_t err = BLEInstanceBase::deviceInstance().getGap().setRandomStaticAddress(address);
     MBED_ASSERT(err == BLE_ERROR_NONE);
 }
 

connectivity/FEATURE_BLE/cordio/TARGET_CORDIO/driver/CordioHCIDriver.h

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-#ifndef CORDIO_HCI_DRIVER_H_
-#define CORDIO_HCI_DRIVER_H_
+#ifndef IMPL_HCI_DRIVER_H_
+#define IMPL_HCI_DRIVER_H_
 
 #include <stddef.h>
 #include <stdint.h>
@@ -229,4 +229,4 @@ class CordioHCIDriver {
 
 } // namespace ble
 
-#endif /* CORDIO_HCI_DRIVER_H_ */
+#endif /* IMPL_HCI_DRIVER_H_ */

connectivity/FEATURE_BLE/cordio/TARGET_CORDIO/driver/CordioHCITransportDriver.h

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-#ifndef CORDIO_HCI_TRANSPORT_DRIVER_H_
-#define CORDIO_HCI_TRANSPORT_DRIVER_H_
+#ifndef IMPL_HCI_TRANSPORT_DRIVER_H_
+#define IMPL_HCI_TRANSPORT_DRIVER_H_
 
 #include <stdint.h>
 
@@ -78,4 +78,4 @@ class CordioHCITransportDriver {
 
 } // namespace ble
 
-#endif /* CORDIO_HCI_TRANSPORT_DRIVER_H_ */
+#endif /* IMPL_HCI_TRANSPORT_DRIVER_H_ */

connectivity/FEATURE_BLE/cordio/TARGET_CORDIO/driver/H4TransportDriver.h

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-#ifndef CORDIO_H4_TRANSPORT_DRIVER_H_
-#define CORDIO_H4_TRANSPORT_DRIVER_H_
+#ifndef IMPL_H4_TRANSPORT_DRIVER_H_
+#define IMPL_H4_TRANSPORT_DRIVER_H_
 
 #if (DEVICE_SERIAL && DEVICE_SERIAL_FC) || defined(DOXYGEN_ONLY)
 
@@ -78,4 +78,4 @@ class H4TransportDriver : public CordioHCITransportDriver {
 
 #endif
 
-#endif /* CORDIO_H4_TRANSPORT_DRIVER_H_ */
+#endif /* IMPL_H4_TRANSPORT_DRIVER_H_ */

connectivity/FEATURE_BLE/include/ble/internal/cordio/CordioBLEInstanceBase.h renamed to connectivity/FEATURE_BLE/cordio/TARGET_CORDIO/include/ble/internal/BLEInstanceBaseImpl.h

@@ -16,25 +16,25 @@
  * limitations under the License.
  */
 
-#ifndef CORDIO_BLE_H_
-#define CORDIO_BLE_H_
+#ifndef IMPL_BLE_INSTANCE_BASE_H_
+#define IMPL_BLE_INSTANCE_BASE_H_
 
 #include "ble/BLE.h"
 #include "ble/types/blecommon.h"
 #include "ble/internal/BLEInstanceBase.h"
 
 #include "CordioHCIDriver.h"
 #include "ble/GattServer.h"
-#include "CordioPalAttClient.h"
-#include "CordioPalGattClient.h"
+#include "PalAttClient.h"
+#include "PalGattClient.h"
 #include "ble/GattClient.h"
-#include "ble/internal/pal/PalGap.h"
+#include "ble/internal/PalGap.h"
 #include "ble/Gap.h"
-#include "CordioPalGenericAccessService.h"
+#include "PalGenericAccessService.h"
 #include "ble/SecurityManager.h"
-#include "CordioPalEventQueue.h"
+#include "PalEventQueue.h"
 #include "drivers/LowPowerTimer.h"
-#include "ble/internal/pal/PalSecurityManager.h"
+#include "ble/internal/PalSecurityManager.h"
 
 namespace ble {
 
@@ -43,25 +43,25 @@ class PalSigningMonitor;
 /**
  * @see BLEInstanceBase
  */
-class CordioBLEInstanceBase : public BLEInstanceBase {
+class BLEInstanceBase : public interface::BLEInstanceBase {
     friend PalSigningMonitor;
     /**
      * Construction with an HCI driver.
      */
-    CordioBLEInstanceBase(CordioHCIDriver& hci_driver);
+    BLEInstanceBase(CordioHCIDriver& hci_driver);
 
     /**
      * Destructor
      */
-    virtual ~CordioBLEInstanceBase();
+    virtual ~BLEInstanceBase();
 
 public:
 
     /**
      * Access to the singleton containing the implementation of BLEInstanceBase
      * for the Cordio stack.
      */
-    static CordioBLEInstanceBase& deviceInstance();
+    static BLEInstanceBase& deviceInstance();
 
     /**
     * @see BLEInstanceBase::init
@@ -171,4 +171,4 @@ class CordioBLEInstanceBase : public BLEInstanceBase {
 } // namespace ble
 
 
-#endif /* CORDIO_BLE_H_ */
+#endif /* IMPL_BLE_INSTANCE_BASE_H_ */

connectivity/FEATURE_BLE/include/ble/internal/cordio/CordioPalAttClient.h renamed to connectivity/FEATURE_BLE/cordio/TARGET_CORDIO/include/ble/internal/PalAttClientImpl.h

@@ -16,12 +16,12 @@
  * limitations under the License.
  */
 
-#ifndef CORDIO_PAL_ATT_CLIENT_
-#define CORDIO_PAL_ATT_CLIENT_
+#ifndef IMPL_PAL_ATT_CLIENT_
+#define IMPL_PAL_ATT_CLIENT_
 
 #include "PalSimpleAttServerMessage.h"
 #include "att_api.h"
-#include "ble/internal/pal/PalAttClient.h"
+#include "ble/internal/PalAttClient.h"
 
 namespace ble {
 
@@ -475,4 +475,4 @@ class PalAttClient : public interface::PalAttClient {
 
 } // ble
 
-#endif /* CORDIO_PAL_ATT_CLIENT_ */
+#endif /* IMPL_PAL_ATT_CLIENT_ */

connectivity/FEATURE_BLE/include/ble/internal/cordio/CordioPalEventQueue.h renamed to connectivity/FEATURE_BLE/cordio/TARGET_CORDIO/include/ble/internal/PalEventQueueImpl.h

@@ -20,19 +20,19 @@
 #define BLE_PAL_SIMPLE_EVENT_QUEUE_H_
 
 #include <new>
-#include "pal/PalEventQueue.h"
-#include "ble/internal/BLEInstanceBase.h"
-#include "ble/BLE.h"
+#include "ble/internal/PalEventQueue.h"
 
 #include "wsf_buf.h"
 
 namespace ble {
 
+class BLEInstanceBase;
+
 /**
  * Simple implementation of the EventQueue.
  */
-struct PalEventQueue : interface::PalEventQueue {
-
+class PalEventQueue : interface::PalEventQueue {
+public:
     typedef mbed::Callback<void()> event_t;
 
     /**
@@ -130,10 +130,7 @@ struct PalEventQueue : interface::PalEventQueue {
         EventNode* next;
     };
 
-    void signal_event()
-    {
-        _ble_base->signalEventsToProcess();
-    }
+    void signal_event();
 
     BLEInstanceBase* _ble_base;
     EventNode* _events;

connectivity/FEATURE_BLE/include/ble/internal/cordio/CordioPalGap.h renamed to connectivity/FEATURE_BLE/cordio/TARGET_CORDIO/include/ble/internal/PalGapImpl.h

@@ -16,10 +16,10 @@
  * limitations under the License.
  */
 
-#ifndef CORDIO_PAL_GAP_
-#define CORDIO_PAL_GAP_
+#ifndef IMPL_PAL_GAP_
+#define IMPL_PAL_GAP_
 
-#include "ble/internal/pal/PalGap.h"
+#include "ble/internal/PalGap.h"
 #include "dm_api.h"
 
 namespace ble {
@@ -144,7 +144,7 @@ class PalGap : public interface::PalGap {
     );
 
     bool is_privacy_supported();
-    
+
     ble_error_t set_address_resolution(
         bool enable
     );
@@ -328,7 +328,12 @@ class PalGap : public interface::PalGap {
     PalGapEventHandler *get_event_handler();
 
 private:
-
+    /**
+     * Called this function whenever the LE subsystem
+     * generate a PalGap event.
+     *
+     * @param gap_event The event to emit to higher layer.
+     */
     void emit_gap_event(const GapEvent &gap_event)
     {
         if (_gap_event_cb) {
@@ -496,6 +501,27 @@ class PalGap : public interface::PalGap {
         advertising_peer_address_type_t peer_address_type
     );
 
+    /**
+     * Create an ALL_PHYS parameter used in LE Set PHY Command
+     * and LE Set Default PHY Command.
+     * @see BLUETOOTH SPECIFICATION Version 5.0 | Vol 2, Part E - 7.8.49
+     */
+    static uint8_t create_all_phys_value(
+        const phy_set_t &tx_phys,
+        const phy_set_t &rx_phys
+    )
+    {
+        /* if phy set is empty set corresponding all_phys bit to 1 */
+        uint8_t all_phys = 0;
+        if (tx_phys.value() == 0) {
+            all_phys |= 0x01;
+        }
+        if (rx_phys.value() == 0) {
+            all_phys |= 0x02;
+        }
+        return all_phys;
+    }
+
 private:
     PalGapEventHandler* _pal_event_handler;
     address_t device_random_address;
@@ -512,4 +538,4 @@ class PalGap : public interface::PalGap {
 
 } // ble
 
-#endif /* CORDIO_PAL_GAP_ */
+#endif /* IMPL_PAL_GAP_ */

connectivity/FEATURE_BLE/include/ble/internal/cordio/CordioPalGattClient.h renamed to connectivity/FEATURE_BLE/cordio/TARGET_CORDIO/include/ble/internal/PalGattClientImpl.h

@@ -19,7 +19,7 @@
 #ifndef BLE_PAL_ATTCLIENTTOGATTCLIENTADAPTER_H_
 #define BLE_PAL_ATTCLIENTTOGATTCLIENTADAPTER_H_
 
-#include "ble/internal/pal/PalGattClient.h"
+#include "ble/internal/PalGattClient.h"
 
 namespace ble {
 
@@ -223,7 +223,11 @@ class PalGattClient : public interface::PalGattClient {
 
 private:
     /**
-     * @see ble::PalGattClient::on_server_event
+     * Upon server message reception an implementation shall call this function.
+     *
+     * @param connection_handle The handle of the connection which has received
+     * the server message.
+     * @param server_message The message received from the server.
      */
     void on_server_event(
         connection_handle_t connection_handle,
@@ -235,7 +239,13 @@ class PalGattClient : public interface::PalGattClient {
     }
 
     /**
-     * @see ble::PalGattClient::on_transaction_timeout
+     * Upon transaction timeout an implementation shall call this function.
+     *
+     * @param connection_handle The handle of the connection of the transaction
+     * which has times out.
+     *
+     * @note see BLUETOOTH SPECIFICATION Version 5.0 | Vol 3, Part F Section 3.3.3
+     * @note see BLUETOOTH SPECIFICATION Version 5.0 | Vol 3, Part G Section 4.4.14
      */
     void on_transaction_timeout(
         connection_handle_t connection_handle