Removes System feature FEATURE_NCP_FW_UPDATES

Author: technobly

hal/inc/core_hal.h

@@ -223,8 +223,7 @@ typedef enum HAL_Feature {
     FEATURE_RESET_INFO,              // [read/write] enables handling of last reset info (may affect backup registers)
     FEATURE_WIFI_POWERSAVE_CLOCK,    // [write only] enables/disables the WiFi powersave clock on the TESTMODE pin. This setting is persisted to the DCT.
     FEATURE_ETHERNET_DETECTION,      // [read/write] enables Ethernet FeatherWing detection on boot
-    FEATURE_LED_OVERRIDDEN,          // [read/write] override system RGB signaling on boot.
-    FEATURE_NCP_FW_UPDATES,          // [read/write] enables/disables NCP FW updates
+    FEATURE_LED_OVERRIDDEN           // [read/write] override system RGB signaling on boot.
 } HAL_Feature;
 
 int HAL_Feature_Set(HAL_Feature feature, bool enabled);

hal/network/ncp_client/sara/sara_ncp_client.cpp

@@ -181,7 +181,6 @@ int SaraNcpClient::init(const NcpClientConfig& conf) {
     registeredTime_ = 0;
     memoryIssuePresent_ = true; // default to safe state until we determine modem firmware version
     oldFirmwarePresent_ = true; // default to safe state until we determine modem firmware version
-    savedNVMR510_ = false; // R510: Save connection state to NVM for fast cold boot registration times
     parserError_ = 0;
     ready_ = false;
     firmwareUpdateR510_ = false;
@@ -745,9 +744,6 @@ int SaraNcpClient::getCellularGlobalIdentity(CellularGlobalIdentity* cgi) {
     } else {
         CHECK_PARSER_OK(parser_.execCommand("AT+CEREG?"));
     }
-    // FIXME: CREG is not set to verbose mode for Cat-M1/Cat-1 devices, can we really
-    // "fallback to CSD" here for gathering LAC and CID?
-    CHECK_PARSER_OK(parser_.execCommand("AT+CREG?"));
 
     switch (cgi->version)
     {
@@ -1145,7 +1141,7 @@ int SaraNcpClient::selectNetworkProf(ModemState& state) {
         if (r == 1 && (static_cast<UbloxSaraUmnoprof>(curProf) == UbloxSaraUmnoprof::SW_DEFAULT ||
                 (netConf_.netProv() == CellularNetworkProvider::TWILIO && static_cast<UbloxSaraUmnoprof>(curProf) != UbloxSaraUmnoprof::STANDARD_EUROPE) ||
                 (conf_.ncpIdentifier() == PLATFORM_NCP_SARA_R410 && netConf_.netProv() == CellularNetworkProvider::KORE_ATT && static_cast<UbloxSaraUmnoprof>(curProf) != UbloxSaraUmnoprof::ATT) ||
-                (conf_.ncpIdentifier() == PLATFORM_NCP_SARA_R510 && netConf_.netProv() == CellularNetworkProvider::KORE_ATT && static_cast<UbloxSaraUmnoprof>(curProf) != UbloxSaraUmnoprof::STANDARD_EUROPE)) ) {
+                (conf_.ncpIdentifier() == PLATFORM_NCP_SARA_R510 && netConf_.netProv() == CellularNetworkProvider::KORE_ATT && static_cast<UbloxSaraUmnoprof>(curProf) != UbloxSaraUmnoprof::ATT)) ) {
             int newProf = static_cast<int>(UbloxSaraUmnoprof::SIM_SELECT);
             // TWILIO Super SIM
             if (netConf_.netProv() == CellularNetworkProvider::TWILIO) {
@@ -1163,11 +1159,8 @@ int SaraNcpClient::selectNetworkProf(ModemState& state) {
             }
             // KORE AT&T or 3rd Party SIM
             else {
-                if (conf_.ncpIdentifier() == PLATFORM_NCP_SARA_R510) {
-                    newProf = static_cast<int>(UbloxSaraUmnoprof::STANDARD_EUROPE);
-                }
-                // Hard code ATT for 05.12 firmware versions
-                if (fwVersion_ == UBLOX_NCP_R4_APP_FW_VERSION_0512) {
+                // Hard code ATT for R410 05.12 firmware versions or R510 Kore AT&T SIMs
+                if (fwVersion_ == UBLOX_NCP_R4_APP_FW_VERSION_0512 || conf_.ncpIdentifier() == PLATFORM_NCP_SARA_R510) {
                     if (netConf_.netProv() == CellularNetworkProvider::KORE_ATT) {
                         newProf = static_cast<int>(UbloxSaraUmnoprof::ATT);
                     }
@@ -1198,11 +1191,10 @@ int SaraNcpClient::selectNetworkProf(ModemState& state) {
             char ubandStr[24] = {};
             auto retBand = CHECK_PARSER(respBand.scanf("+UBANDMASK: 0,%23[^,]", ubandStr));
             CHECK_PARSER_OK(respBand.readResult());
-            if (retBand == 1 && ((netConf_.netProv() == CellularNetworkProvider::TWILIO) || 
-                    (netConf_.netProv() == CellularNetworkProvider::KORE_ATT && conf_.ncpIdentifier() == PLATFORM_NCP_SARA_R510)) ) {
+            if (netConf_.netProv() == CellularNetworkProvider::TWILIO && retBand == 1) {
                 char* pEnd = &ubandStr[0];
                 ubandUint64 = strtoull(ubandStr, &pEnd, 10);
-                // Only update if not set to correct bands
+                // Only update if Twilio Super SIM and not set to correct bands
                 if (pEnd - ubandStr > 0 && ubandUint64 != 6170) {
                     // Enable Cat-M1 bands 2,4,5,12 (AT&T), 13 (VZW) = 6170
                     parser_.execCommand(UBLOX_UBANDMASK_TIMEOUT, "AT+UBANDMASK=0,6170");
@@ -2152,25 +2144,14 @@ void SaraNcpClient::resetRegistrationState() {
     regCheckTime_ = regStartTime_;
     imsiCheckTime_ = regStartTime_;
     registrationInterventions_ = 0;
-    savedNVMR510_ = false;
 }
 
-int SaraNcpClient::checkRegistrationState() {
+void SaraNcpClient::checkRegistrationState() {
     if (connState_ != NcpConnectionState::DISCONNECTED) {
         if ((csd_.registered() && psd_.registered()) || eps_.registered()) {
             if (memoryIssuePresent_ && connState_ != NcpConnectionState::CONNECTED) {
                 registeredTime_ = millis(); // start registered timer for memory issue power off delays
             }
-            // FIXME: Workaround for R510S NVM issue, avoid this step with updated firmware.
-            // Switch to airplane mode / full functionality to save connection details for fast cold connection times.
-            // This will skip setting the CONNECTED state and stay CONNECTING, since that's what will happen on the modem.
-            if (conf_.ncpIdentifier() == PLATFORM_NCP_SARA_R510 && !savedNVMR510_) {
-                // TODO: Completely remove CFUN=4/1 toggle after registration
-                // CHECK_PARSER(parser_.execCommand(UBLOX_CFUN_TIMEOUT, "AT+CFUN=4,0"));
-                // CHECK_PARSER(parser_.execCommand(UBLOX_CFUN_TIMEOUT, "AT+CFUN=1,0"));
-                savedNVMR510_ = true;
-                return SYSTEM_ERROR_NONE;
-            }
             connectionState(NcpConnectionState::CONNECTED);
         } else if (connState_ == NcpConnectionState::CONNECTED) {
             // FIXME: potentially go back into connecting state only when getting into
@@ -2179,7 +2160,6 @@ int SaraNcpClient::checkRegistrationState() {
             connectionState(NcpConnectionState::CONNECTING);
         }
     }
-    return SYSTEM_ERROR_NONE;
 }
 
 int SaraNcpClient::interveneRegistration() {

hal/network/ncp_client/sara/sara_ncp_client.h

@@ -113,7 +113,6 @@ class SaraNcpClient: public CellularNcpClient {
     unsigned int fwVersion_ = 0;
     bool memoryIssuePresent_;
     bool oldFirmwarePresent_;
-    bool savedNVMR510_ = false;
     unsigned registrationTimeout_;
     unsigned registrationInterventions_;
     volatile bool inFlowControl_ = false;
@@ -146,7 +145,7 @@ class SaraNcpClient: public CellularNcpClient {
     void connectionState(NcpConnectionState state);
     void parserError(int error);
     void resetRegistrationState();
-    int checkRegistrationState();
+    void checkRegistrationState();
     int interveneRegistration();
     int checkRunningImsi();
     int processEventsImpl();

hal/src/nRF52840/core_hal.c

@@ -801,9 +801,6 @@ int HAL_Feature_Set(HAL_Feature feature, bool enabled) {
         case FEATURE_LED_OVERRIDDEN: {
             return Write_Feature_Flag(FEATURE_FLAG_LED_OVERRIDDEN, enabled, NULL);
         }
-        case FEATURE_NCP_FW_UPDATES: {
-            return Write_Feature_Flag(FEATURE_FLAG_NCP_FW_UPDATES, enabled, NULL);
-        }
     }
 
     return -1;
@@ -825,10 +822,6 @@ bool HAL_Feature_Get(HAL_Feature feature) {
             bool value = false;
             return (Read_Feature_Flag(FEATURE_FLAG_LED_OVERRIDDEN, &value) == 0) ? value : false;
         }
-        case FEATURE_NCP_FW_UPDATES: {
-            bool value = false;
-            return (Read_Feature_Flag(FEATURE_FLAG_NCP_FW_UPDATES, &value) == 0) ? value : false;
-        }
     }
     return false;
 }

modules/electron/system-part1/src/cellular_hal.cpp

@@ -8,4 +8,4 @@
 #include "../src/electron/inet_hal_new.cpp"
 #include "../src/electron/socket_hal.cpp"
 #include "../shared/cellular_sig_perc_mapping.cpp"
-#include "../src/electron/platform_ncp_electron.cpp"
+#include "../src/electron/platform_ncp_electron.cpp"

platform/MCU/nRF52840/inc/dct.h

@@ -72,8 +72,7 @@ PARTICLE_STATIC_ASSERT(static_ip_config_size, sizeof(static_ip_config_t)==24);
 typedef enum Feature_Flag {
     FEATURE_FLAG_RESET_INFO = 0x01,
     FEATURE_FLAG_ETHERNET_DETECTION = 0x02,
-    FEATURE_FLAG_LED_OVERRIDDEN = 0x04,
-    FEATURE_FLAG_NCP_FW_UPDATES = 0x08,
+    FEATURE_FLAG_LED_OVERRIDDEN = 0x04
 } Feature_Flag;
 
 /**

services/src/ncp_fw_update.cpp

@@ -16,33 +16,41 @@
  */
 
 /*
-    R510 Firmware Update:
+    R510 Firmware Update Background Check:
     =====================
+    1.  Baked into sara_ncp_client.cpp init process
+    2.  When ATI9 is used to determine the modem version (thus, only when modem is on), 
+        check if there is an update firmware version available.
+    3.  Set a flag for Cellular.updatePending() if update available.
+
+
+    R510 Firmware Update
+    =====================
+    0.  (Blocking Call) Once Cellular.startUpdate() is called, initialize state_/status_ from Idle to Qualify.
     1.  Check ncpId() == PLATFORM_NCP_SARA_R510
     2.  Is System.enableUpdates() == true?
     3.  Check modem firmware version - compatible upgrade version will be baked into Device OS with MD5 sum.
     4.  Reboot into Safe Mode to start the update process
-    5.  Is Particle.connected()?
-    6.  Setup HTTPS security options
-    7.  When ready to start update process, publish a "spark/device/ncp/update" system event that Device OS has "started" a modem update.
-        Only try to update once per hour if something should fail the first time, so we're not stuck in a hard
-        loop offline?
-    8.  Disconnect the Cloud
-    9.  If an existing FOAT file is present, delete it since there is no way to validate what it is after it's present.
-    10. Start the download based on step 3, keep track of update version
-    11. Download is only complete when the the MD5SUM URC of the file is received and verified
-    12. Disconnect from the Cellular network
-    13. Apply the firmware update
-    14. Sit in a tight loop it will take about 18 to 20 minutes
+    5.  Particle.connect()
+    6.  Publish a "spark/device/ncp/update" system event that Device OS has "started" a modem update.
+    7.  Particle.disconnect()
+    8.  Disable PPP link and Cellular.connect(), timeout after 10 minutes
+    9.  Setup HTTPS security options
+    10. If an existing FOAT file is present, delete it since there is no way to validate what it is after it's present.
+    11. Start the download based our database entry
+    12. Download is only complete when the the MD5SUM URC of the file is received and verified
+    13. Cellular.disconnect()
+    14. Apply the firmware update
+    15. Sit in a tight loop while the modem is updating, it will take about 18 to 20 minutes
         a. waiting for final INSTALL URC of 128
         b. polling for AT/OK every 10 seconds
         c. monitoring a timeout counter of 40 minutes
-    15. Save the download/install result to be published once connected to the Cloud again
-    16. Power cycle the modem by switching it off, and..
-    17. Connect to the Cloud
-    18. Publish a "spark/device/ncp/update" system event that Device OS has finished with "success" or "failed"
-    19. Reset the system to exit Safe Mode
-    20. Add result status to device diagnostics
+    16. Save the download/install result to be published once connected to the Cloud again
+    17. Re-enable PPP link and Power off the modem
+    18. Particle.connect()
+    19. Publish a "spark/device/ncp/update" system event that Device OS has finished with "success" or "failed"
+    20. Reset the system to exit Safe Mode
+    21. On next init, add result status to device diagnostics
 
     TODO:
     ====================
@@ -52,7 +60,7 @@
     Done - Move ncp_fw_update.cpp to services/ instead of system/ since we have more space available there
     Done - Add correct cipher settings
     Done - Save state_, status_, firmwareVersion_ variables in retained system memory to ensure
-            Done - we complete step 11/12
+            Done - we complete step INSTALL/WAITING
             Done - we do enter and exit safe mode fw updating cleanly
             Done - we do not get stuck in a fail-retry loop
     Done - Refactor retained structure to use systemCache instead
@@ -61,25 +69,23 @@
             Done - Gen 3, extends timer 5 minutes for every received URC.
     Done - When do we retry failures?  Quick loops can retry a few times, but long ones shouldn't
     Done - Create a database of starting firmware version / desired firmware version / filename / MD5SUM value, similar to APN DB.
-         - Minimize logging output, move some statements to LOG_DEBUG
     Done - Make sure there is a final status log
     Done - Allow user firmware to pass a database entry that overrides the system firmware update database
     Done - Add final status to Device Diagnostics
-         - add modem version to Device Diagnostics?
-         - Make publishEvent's an async call with timeout?
-         - When do we clear the g_ncpFwUpdateRetained.state == FW_UPDATE_FINISHED_IDLE_STATE to kickoff a new update attempt?
+       ? - add modem version to Device Diagnostics
     Done - Remove callbacks
     Done - Remove Gen 2 code
     Done - Gen 3
-            Done - allow normal connection at first for publishing
-            Done - avoid connecting PPP for downloading
-            Done - enable PDP context with a few AT commands for downloading
+            Done - allow normal connection first
+            Done - optionally avoid connecting PPP
+            Done - enable PDP context with a few AT commands
     Done - Remove System feature flag
          - implement background update check, only perform checks if modem is on.
          - ncp_fw_udpate_check should drive an update check, implement no argument as system check
          - implement Cellular.updatesPending() API
          - implement Cellular.startUpdate() API
-
+         - add 10 minute cellular connect timeout when PPP link disabled
+         - add URC handler for +CGEV: ME PDN DEACT 1 or +CGEV: ME DETACH or +UUPSDD: 0 to wait for cellular disconnected
 */
 
 #include "logging.h"
@@ -337,13 +343,6 @@ int NcpFwUpdate::process() {
                 break;
             }
             LOG(INFO, "PLATFORM_NCP == SARA_R510");
-            // Check system feature is enabled
-            if (!HAL_Feature_Get(FEATURE_NCP_FW_UPDATES)) {
-                LOG(ERROR, "FEATURE_NCP_FW_UPDATES disabled");
-                ncpFwUpdateState_ = FW_UPDATE_IDLE_STATE;
-                break;
-            }
-            LOG(INFO, "FEATURE_NCP_FW_UPDATES enabled");
             // Check if System.updatesEnabled()
             uint8_t updatesEnabled = 0;
             ncpFwUpdateCallbacks_->system_get_flag(SYSTEM_FLAG_OTA_UPDATE_ENABLED, &updatesEnabled, nullptr);
@@ -483,6 +482,7 @@ int NcpFwUpdate::process() {
 
         case FW_UPDATE_DOWNLOAD_CELL_CONNECTING_STATE:
         {
+            // TODO: Add 10 minute timeout here
             if (!network_ready(0, 0, 0)) { // Cellular.ready()
                 LOG(INFO, "Connecting Cellular...");
                 cellular_start_ncp_firmware_update(true, nullptr); // ensure we don't connect PPP