DTMESH-496: Add WPS results callback registration API

Reason for change: To be able start WPS session from OVSDB

Test procedure:
    1) Verify successful build.
    2) Change wps_pbc value in Wifi_VIF_Config
    3) Confirm that callback executes correctly and updates runtime/OVSDB state.

Risks: Low. Scoped to WPS feature with guarded code paths.

Priority: P1

Signed-off-by: Arsen Podoba <[email protected]>

Author: ArsenPodoba

include/wifi_events.h

@@ -111,6 +111,7 @@ typedef enum {
     wifi_event_type_csi_data,
     wifi_event_br_report,
     wifi_event_hal_csa_beacon_frame,
+    wifi_event_hal_wps_results,
     wifi_event_hal_max,
 
     // Commands

source/core/wifi_ctrl.c

@@ -1289,6 +1289,18 @@ void channel_change_callback(wifi_channel_change_event_t radio_channel_param)
     return;
 }
 
+int wps_event_callback(int apIndex, wifi_wps_ev_t event)
+{
+    wifi_wps_event_t wps_event;
+
+    wps_event.vap_index = apIndex;
+    wps_event.event = event;
+
+    push_event_to_ctrl_queue((wifi_wps_event_t *)&wps_event, sizeof(wifi_wps_event_t), wifi_event_type_hal_ind, wifi_event_hal_wps_results, NULL);
+
+    return RETURN_OK;
+}
+
 int init_wifi_ctrl(wifi_ctrl_t *ctrl)
 {
     unsigned int i;
@@ -1371,6 +1383,8 @@ int init_wifi_ctrl(wifi_ctrl_t *ctrl)
     /* Register wifi hal channel change events callback */
     wifi_chan_event_register(channel_change_callback);
 
+    wifi_wpsEvent_callback_register(wps_event_callback);
+
     ctrl->bus_events_subscribed = false;
     ctrl->tunnel_events_subscribed = false;
 

source/core/wifi_ctrl_queue_handlers.c

@@ -1994,6 +1994,50 @@ void process_assoc_device_event(void *data)
     }
 }
 
+void process_wps_results_event(wifi_wps_event_t *wps_event)
+{
+#ifdef FEATURE_SUPPORT_WPS
+    wifi_ctrl_t *ctrl = (wifi_ctrl_t *)get_wifictrl_obj();
+    wifi_vap_info_t *vap_info = NULL;
+    rdk_wifi_vap_info_t *rdk_vap_info = NULL;
+    unsigned int vap_index = wps_event->vap_index;
+    bool wpsPushButton = false;
+
+    wifi_util_info_print(WIFI_CTRL, "%s:%d wps event[%d] is received\n", __func__, __LINE__, wps_event->event);
+
+    switch(wps_event->event) {
+        case wifi_wps_ev_pbc_active:
+            wpsPushButton = true;
+            break;
+
+        case wifi_wps_ev_success:
+        case wifi_wps_ev_fail:
+        case wifi_wps_ev_pbc_timeout:
+        case wifi_wps_ev_pbc_disable:
+            wpsPushButton = false;
+            break;
+    }
+
+    vap_info = get_wifidb_vap_parameters(vap_index);
+    if (vap_info == NULL) {
+        wifi_util_error_print(WIFI_CTRL, "%s:%d failed to get vap info for index %d\n",
+            __func__, __LINE__, vap_index);
+        return;
+    }
+
+    rdk_vap_info = get_wifidb_rdk_vap_info(vap_index);
+    if (rdk_vap_info == NULL) {
+        wifi_util_error_print(WIFI_CTRL, "%s:%d failed to get rdk vap info for index %d\n",
+            __func__, __LINE__, vap_index);
+        return;
+    }
+
+    vap_info->u.bss_info.wpsPushButton = wpsPushButton;
+    get_wifidb_obj()->desc.update_wifi_vap_info_fn(vap_info->vap_name, vap_info, rdk_vap_info);
+    ctrl->webconfig_state |= ctrl_webconfig_state_vap_private_cfg_rsp_pending;
+#endif
+}
+
 void process_factory_reset_command(bool type)
 {
     wifi_mgr_t *p_wifi_mgr = get_wifimgr_obj();
@@ -3687,6 +3731,10 @@ void handle_hal_indication(wifi_ctrl_t *ctrl, void *data, unsigned int len,
         process_csa_beacon_frame_event(data, len, ctrl);
         break;
 
+    case wifi_event_hal_wps_results:
+        process_wps_results_event(data);
+        break;
+
     default:
 
         wifi_util_error_print(WIFI_CTRL, "[%s]:WIFI hal handler not supported this event %s\r\n",

source/core/wifi_ctrl_webconfig.c

@@ -732,6 +732,7 @@ int webconfig_hal_vap_apply_by_name(wifi_ctrl_t *ctrl, webconfig_subdoc_decoded_
     vap_svc_t *svc;
     wifi_vap_info_map_t *mgr_vap_map, *p_tgt_vap_map = NULL;
     bool found_target = false;
+    bool wpsPushButtonChanged = false;
     wifi_mgr_t *mgr = get_wifimgr_obj();
     char update_status[128];
     public_vaps_data_t pub;
@@ -825,8 +826,10 @@ int webconfig_hal_vap_apply_by_name(wifi_ctrl_t *ctrl, webconfig_subdoc_decoded_
             mgr_rdk_vap_info->exists = rdk_vap_info->exists;
         }
 
+        wpsPushButtonChanged = isVapPrivate(tgt_vap_index) && is_wpsPushButton_changed(mgr_vap_info, vap_info);
+
         wifi_util_dbg_print(WIFI_CTRL,"%s:%d: Comparing VAP [%s] with [%s]. \n",__func__, __LINE__,mgr_vap_info->vap_name,vap_info->vap_name);
-        if (is_vap_param_config_changed(mgr_vap_info, vap_info, mgr_rdk_vap_info, rdk_vap_info,
+        if (is_vap_param_config_changed_except_wpsPushButton(mgr_vap_info, vap_info, mgr_rdk_vap_info, rdk_vap_info,
                 isVapSTAMesh(tgt_vap_index)) || is_force_apply_true(rdk_vap_info)) {
             // radio data changed apply
             wifi_util_info_print(WIFI_CTRL, "%s:%d: Change detected in received vap config, applying new configuration for vap: %s\n",
@@ -914,6 +917,13 @@ int webconfig_hal_vap_apply_by_name(wifi_ctrl_t *ctrl, webconfig_subdoc_decoded_
             wifi_util_info_print(WIFI_WEBCONFIG, "%s:%d: Received vap config is same for %s, not applying\n",
                         __func__, __LINE__, vap_names[i]);
         }
+
+        if (wpsPushButtonChanged)
+        {
+            push_event_to_ctrl_queue(&tgt_vap_index, sizeof(tgt_vap_index), wifi_event_type_command,
+                vap_info->u.bss_info.wpsPushButton ? wifi_event_type_command_wps : wifi_event_type_command_wps_cancel, NULL);
+            mgr_vap_info->u.bss_info.wpsPushButton = false;
+        }
     }
 
     return RETURN_OK;

source/core/wifi_events.c

@@ -105,6 +105,7 @@ const char *wifi_event_subtype_to_string(wifi_event_subtype_t type)
         DOC2S(wifi_event_radius_eap_failure)
         DOC2S(wifi_event_radius_fallback_and_failover)
         DOC2S(wifi_event_type_csi_data)
+        DOC2S(wifi_event_hal_wps_results)
         DOC2S(wifi_event_hal_max)
         DOC2S(wifi_event_type_active_gw_check)
         DOC2S(wifi_event_type_command_factory_reset)

source/utils/wifi_util.c

@@ -3876,8 +3876,8 @@ static bool is_vap_preassoc_cac_config_changed(char *vap_name,
     }
 }
 
-bool is_vap_param_config_changed(wifi_vap_info_t *vap_info_old, wifi_vap_info_t *vap_info_new,
-    rdk_wifi_vap_info_t *rdk_old, rdk_wifi_vap_info_t *rdk_new, bool isSta)
+bool is_vap_param_config_changed_core(wifi_vap_info_t *vap_info_old, wifi_vap_info_t *vap_info_new,
+    rdk_wifi_vap_info_t *rdk_old, rdk_wifi_vap_info_t *rdk_new, bool isSta, bool include_wpsPushButton)
 {
 
     if ((vap_info_old == NULL) || (vap_info_new == NULL) || (rdk_old == NULL) ||
@@ -3957,8 +3957,7 @@ bool is_vap_param_config_changed(wifi_vap_info_t *vap_info_old, wifi_vap_info_t
             IS_CHANGED(vap_info_old->u.bss_info.wepKeyLength,
                 vap_info_new->u.bss_info.wepKeyLength) ||
             IS_CHANGED(vap_info_old->u.bss_info.bssHotspot, vap_info_new->u.bss_info.bssHotspot) ||
-            IS_CHANGED(vap_info_old->u.bss_info.wpsPushButton,
-                vap_info_new->u.bss_info.wpsPushButton) ||
+            (include_wpsPushButton && IS_CHANGED(vap_info_old->u.bss_info.wpsPushButton, vap_info_new->u.bss_info.wpsPushButton)) ||
             IS_CHANGED(vap_info_old->u.bss_info.connected_building_enabled,
                 vap_info_new->u.bss_info.connected_building_enabled) ||
             IS_CHANGED(vap_info_old->u.bss_info.mdu_enabled, vap_info_new->u.bss_info.mdu_enabled) ||
@@ -3996,6 +3995,26 @@ bool is_vap_param_config_changed(wifi_vap_info_t *vap_info_old, wifi_vap_info_t
     return false;
 }
 
+bool is_vap_param_config_changed(wifi_vap_info_t *vap_info_old, wifi_vap_info_t *vap_info_new,
+                                 rdk_wifi_vap_info_t *rdk_old, rdk_wifi_vap_info_t *rdk_new, bool isSta)
+{
+    return is_vap_param_config_changed_core(vap_info_old, vap_info_new, rdk_old, rdk_new, isSta, /*include_wpsPushButton=*/true);
+}
+
+bool is_vap_param_config_changed_except_wpsPushButton(wifi_vap_info_t *vap_info_old,
+                                                      wifi_vap_info_t *vap_info_new,
+                                                      rdk_wifi_vap_info_t *rdk_old,
+                                                      rdk_wifi_vap_info_t *rdk_new,
+                                                      bool isSta)
+{
+    return is_vap_param_config_changed_core(vap_info_old, vap_info_new, rdk_old, rdk_new, isSta, /*include_wpsPushButton=*/false);
+}
+
+bool is_wpsPushButton_changed(wifi_vap_info_t *vap_info_old, wifi_vap_info_t *vap_info_new)
+{
+    return IS_CHANGED(vap_info_old->u.bss_info.wpsPushButton, vap_info_new->u.bss_info.wpsPushButton);
+}
+
 // Countrycode: US, Band 2.4G
 static const wifi_operating_classes_t us_24G[] = {
     { 81, -30, 2, { 12, 13 } },

source/utils/wifi_util.h

@@ -456,6 +456,12 @@ bool is_6g_supported_device(wifi_platform_property_t *wifi_prop);
 int scan_mode_type_conversion(wifi_neighborScanMode_t *scan_mode_enum, char *scan_mode_str, int scan_mode_len, unsigned int conv_type);
 bool is_vap_param_config_changed(wifi_vap_info_t *vap_info_old, wifi_vap_info_t *vap_info_new,
     rdk_wifi_vap_info_t *rdk_old, rdk_wifi_vap_info_t *rdk_new, bool isSta);
+bool is_vap_param_config_changed_except_wpsPushButton(wifi_vap_info_t *vap_info_old,
+                                                      wifi_vap_info_t *vap_info_new,
+                                                      rdk_wifi_vap_info_t *rdk_old,
+                                                      rdk_wifi_vap_info_t *rdk_new,
+                                                      bool isSta);
+bool is_wpsPushButton_changed(wifi_vap_info_t *vap_info_old, wifi_vap_info_t *vap_info_new);
 int update_radio_operating_classes(wifi_radio_operationParam_t *oper);
 int get_partner_id(char *partner_id);
 int interfacename_from_mac(const mac_address_t *mac, char *ifname);

source/webconfig/wifi_ovsdb_translator.c

@@ -2198,6 +2198,7 @@ webconfig_error_t translate_vap_info_to_ovsdb_common(const wifi_vap_info_t *vap,
     vap_row->btm = vap->u.bss_info.bssTransitionActivated;
     vap_row->rrm = vap->u.bss_info.nbrReportActivated;
     vap_row->wps = vap->u.bss_info.wps.enable;
+    vap_row->wps_pbc = vap->u.bss_info.wpsPushButton;
     strncpy(vap_row->wps_pbc_key_id, vap->u.bss_info.wps.pin, sizeof(vap_row->wps_pbc_key_id));
     vap_row->vlan_id = iface_map->vlan_id;
     return webconfig_error_none;
@@ -2752,6 +2753,13 @@ webconfig_error_t translate_vap_info_to_vif_state_common(const wifi_vap_info_t *
         vap_row->wps_exists=false;
     }
 
+    if (vap->u.bss_info.wpsPushButton) {
+        vap_row->wps_pbc = vap->u.bss_info.wpsPushButton;
+        vap_row->wps_pbc_exists = true;
+    } else {
+        vap_row->wps_pbc_exists = false;
+    }
+
     if (strlen(vap->u.bss_info.wps.pin) != 0) {
         strncpy(vap_row->wps_pbc_key_id, vap->u.bss_info.wps.pin, sizeof(vap_row->wps_pbc_key_id));
         vap_row->wps_pbc_key_id_exists = true;
@@ -3914,8 +3922,13 @@ webconfig_error_t translate_ovsdb_to_vap_info_common(const struct schema_Wifi_VI
     vap->u.bss_info.bssTransitionActivated = vap_row->btm;
     vap->u.bss_info.nbrReportActivated = vap_row->rrm;
     vap->u.bss_info.wps.enable = vap_row->wps;
+    vap->u.bss_info.wpsPushButton = vap_row->wps_pbc;
     snprintf(vap->u.bss_info.wps.pin, sizeof(vap->u.bss_info.wps.pin), "%s",
         vap_row->wps_pbc_key_id);
+    if (vap->u.bss_info.wps.enable)
+        vap->u.bss_info.wps.methods |= WIFI_ONBOARDINGMETHODS_PUSHBUTTON;
+    if (strlen(vap->u.bss_info.wps.pin))
+        vap->u.bss_info.wps.methods |= WIFI_ONBOARDINGMETHODS_PIN;
     wifi_util_dbg_print(WIFI_WEBCONFIG, "%s:%d: vapIndex : %d min_hw_mode %s\n", __func__, __LINE__,
         vap->vap_index, vap_row->min_hw_mode);
     min_hw_mode_conversion(vap->vap_index, (char *)vap_row->min_hw_mode, "", "CONFIG");