Merge pull request #473 from NordicSemiconductor/fix/sdfu-cancel-wait-for-device

Fix/sdfu cancel wait for device

Author: kylebonnici

Changelog.md

@@ -6,6 +6,8 @@
     with UICR will not be displayed anymore.
 -   The SoC is now detected before each operation to ensure the app works even
     if the SoC changes between operations.
+-   Memory layout and device informaion now updates correclty when switching
+    between selected devices quickly.
 
 ## 4.4.0 - 2024-06-13
 

package-lock.json

@@ -46,7 +46,7 @@
         "prepare": "husky install"
     },
     "devDependencies": {
-        "@nordicsemiconductor/pc-nrfconnect-shared": "^182.0.0"
+        "@nordicsemiconductor/pc-nrfconnect-shared": "^185.0.0"
     },
     "eslintConfig": {
         "extends": "./node_modules/@nordicsemiconductor/pc-nrfconnect-shared/config/eslintrc"

package.json

@@ -21,13 +21,9 @@ import * as jlinkTargetActions from './jlinkTargetActions';
 import * as mcubootTargetActions from './mcubootTargetActions';
 import * as usbsdfuTargetActions from './usbsdfuTargetActions';
 
-let abortController: AbortController;
-
 export const openDevice =
-    (device: Device): AppThunk =>
+    (device: Device, abortController: AbortController): AppThunk =>
     async dispatch => {
-        abortController = new AbortController();
-
         dispatch(setDeviceBusy(true));
         try {
             if (device.traits.jlink) {
@@ -37,7 +33,9 @@ export const openDevice =
             } else if (device.traits.mcuBoot) {
                 dispatch(mcubootTargetActions.openDevice(device));
             } else if (device.traits.nordicDfu) {
-                dispatch(usbsdfuTargetActions.openDevice(device));
+                dispatch(
+                    usbsdfuTargetActions.openDevice(device, abortController)
+                );
             } else {
                 logger.warn('No operations possible for device.');
                 logger.warn(
@@ -62,10 +60,6 @@ export const openDevice =
         dispatch(setDeviceBusy(false));
     };
 
-export const closeDevice = () => {
-    abortController.abort();
-};
-
 export const updateTargetWritable =
     (): AppThunk<RootState> => (dispatch, getState) => {
         const device = selectedDevice(getState());

src/actions/targetActions.ts

@@ -57,15 +57,18 @@ import {
 } from '../util/usbsdfuHelpers';
 import * as userInputActions from './userInputActions';
 
+let abortController: AbortController | undefined;
+
 const defaultDfuImage: DfuImage = {
     name: '',
     initPacket: defaultInitPacket,
     firmwareImage: Buffer.alloc(0),
 };
 
 export const openDevice =
-    (device: Device): AppThunk<RootState> =>
+    (device: Device, controller: AbortController): AppThunk<RootState> =>
     dispatch => {
+        abortController = controller;
         logger.info(
             'Using nrfutil-device to communicate with target via USB SDFU protocol'
         );
@@ -91,7 +94,10 @@ export const refreshMemoryLayout =
                 device,
                 async deviceInBootLoader => {
                     const fwInfo = await NrfutilDeviceLib.getFwInfo(
-                        deviceInBootLoader
+                        deviceInBootLoader,
+                        undefined,
+                        undefined,
+                        abortController
                     );
                     dispatch(
                         updateCoreOperations({
@@ -219,7 +225,13 @@ export const resetDevice =
                 state: 'loading',
             })
         );
-        await NrfutilDeviceLib.reset(device);
+        await NrfutilDeviceLib.reset(
+            device,
+            undefined,
+            undefined,
+            undefined,
+            abortController
+        );
         logger.info(`Resetting device completed`);
         dispatch(
             updateCoreOperations({
@@ -521,7 +533,10 @@ export const operateDFU = async (
         await NrfutilDeviceLib.program(
             device,
             { buffer: zipBuffer, type: 'zip' },
-            onProgress
+            onProgress,
+            undefined,
+            undefined,
+            abortController
         );
 
         logger.info('All dfu images have been written to the target device');

src/actions/usbsdfuTargetActions.ts

@@ -11,32 +11,27 @@ import {
     DeviceSelector,
 } from '@nordicsemiconductor/pc-nrfconnect-shared';
 
-import { closeDevice, openDevice } from '../actions/targetActions';
+import { openDevice } from '../actions/targetActions';
 import { resetDeviceInfo } from '../reducers/deviceDefinitionReducer';
 import { setShowMcuBootProgrammingDialog } from '../reducers/mcubootReducer';
 import { setShowModemProgrammingDialog } from '../reducers/modemReducer';
 import { deselectDevice } from '../reducers/targetReducer';
 import { setUsbSdfuProgrammingDialog } from '../reducers/usbSdfuReducer';
 
-const abortController = new AbortController();
-
-export const getAbortController = () => abortController;
-
 export default () => {
     const dispatch = useDispatch();
     return (
         <DeviceSelector
             deviceFilter={device => !!device.serialNumber}
-            onDeviceSelected={(device: SharedDevice) => {
-                dispatch(openDevice(device));
+            onDeviceSelected={(device: SharedDevice, _, abortController) => {
+                dispatch(openDevice(device, abortController));
             }}
             onDeviceDeselected={() => {
                 dispatch(setShowMcuBootProgrammingDialog(false));
                 dispatch(setShowModemProgrammingDialog(false));
                 dispatch(setUsbSdfuProgrammingDialog(false));
                 dispatch(deselectDevice());
                 dispatch(resetDeviceInfo());
-                closeDevice();
             }}
             deviceListing={{
                 nordicUsb: true,

src/components/DeviceSelector.tsx

@@ -73,13 +73,18 @@ export default () => {
             })
         );
 
+        let canceled = false;
+
         // We might have more that one reboot of the device during the next operation
         dispatch(
             setWaitForDevice({
                 timeout: 10000,
                 when: 'always',
                 once: false,
                 skipRefetchDeviceInfo: true,
+                onCanceled: () => {
+                    canceled = true;
+                },
             })
         );
 
@@ -121,23 +126,25 @@ Are you sure you want to continue?`,
         setWriting(false);
         dispatch(clearConfirmBeforeClose('usbSdfuProgramming'));
 
-        // Operation done reconnect one more time only
-        dispatch(
-            setWaitForDevice({
-                timeout: 10000,
-                when: 'always',
-                once: true,
-                onSuccess: programmedDevice =>
-                    dispatch(refreshMemoryLayout(programmedDevice)),
-            })
-        );
-
-        dispatch(
-            updateCoreOperations({
-                core: 'Application',
-                state: 'idle',
-            })
-        );
+        if (!canceled) {
+            // Operation done reconnect one more time only
+            dispatch(
+                setWaitForDevice({
+                    timeout: 10000,
+                    when: 'always',
+                    once: true,
+                    onSuccess: programmedDevice =>
+                        dispatch(refreshMemoryLayout(programmedDevice)),
+                })
+            );
+
+            dispatch(
+                updateCoreOperations({
+                    core: 'Application',
+                    state: 'idle',
+                })
+            );
+        }
     }, [device, dispatch, images]);
 
     useEffect(() => {