translate error codes in adv set terminated event

Author: paul-szczepanek-arm

connectivity/FEATURE_BLE/include/ble/gap/Events.h

@@ -629,9 +629,13 @@ struct AdvertisingEndEvent {
      * @param advHandle Advertising set handle.
      * @param connection Connection handle - only valid if connected is True.
      * @param completed_events Number of events created during before advertising end - only valid
-     *        if advertising end has been caused by a connection or timeout, not the local user.
+     *        if advertising end has been caused by BLE_ERROR_LIMIT_REACHED, not the local user.
+     *        Check getStatus().
      * @param connected True if connection has been established.
-     * @param status Error code if stop command failed.
+     * @param status Error code showing the reason for event. BLE_ERROR_LIMIT_REACHED if set number
+     *        of events have been reached. BLE_ERROR_TIMEOUT if set time has elapsed.
+     *        BLE_ERROR_SUCCESS if connection occurred or user ended the set. Check isConnected()
+     *        to determine which.
      */
     AdvertisingEndEvent(
         advertising_handle_t advHandle,

connectivity/FEATURE_BLE/source/generic/GapImpl.cpp

@@ -3484,11 +3484,17 @@ void Gap::on_advertising_set_terminated(
     ble_error_t error_code = BLE_ERROR_UNSPECIFIED;
     bool connected = false;
 
-    if (status == hci_error_code_t::SUCCESS && connection_handle != DM_CONN_ID_NONE) {
-        connected = true;
+    /* translate HCI error into BLE API error code */
+    if (status == hci_error_code_t::SUCCESS) {
         error_code = BLE_ERROR_NONE;
+        /* self cancelled set will have the handle set to invalid value */
+        if (connection_handle != DM_CONN_ID_NONE) {
+            connected = true;
+        }
     } else if (status == hci_error_code_t::ADVERTISING_TIMEOUT) {
-        error_code = BLE_ERROR_NONE;
+        error_code = BLE_ERROR_TIMEOUT;
+    } else if (status == hci_error_code_t::LIMIT_REACHED) {
+        error_code = BLE_ERROR_LIMIT_REACHED;
     }
 
     if (error_code == BLE_ERROR_NONE) {