PR proposal to add jlink.resume() operation

[TheColector]

PR proposal

I noticed that pylink API exposes halt and halted but doesn't offer a direct way to resume the target (command named Go in JLink commander does that).
If one makes a call for a Halt and then calls for reset, the target will run again (provided that reset does its job), but that will wipe any modifications to volatile memory that user did before which might not be desired.

To address the above, I propose to add a new jlink API method and name it Resume (I'm open to alternative names for it),
It should utilize already used DLL call to JLINKARM_Go, which effectively resumes the target (takes it out of the Halted state) and allows it to run again.

BR,
Michael

[hkpeprah]

restart() is the API that provides this: https://pylink.readthedocs.io/en/latest/pylink.html#pylink.jlink.JLink.restart

[TheColector]

Yes, I mentioned that.
However that does not provide a resume on it's own, it performs a reset which inherently does resume the target while doing reset, but it's not the same.
Hence my proposal to include that in the API

[hkpeprah]

Admittedly I named this poorly (not sure why I chose this name), but restart() does what you're asking. The API could probably use more documentation to make that clearer and/or be renamed. reset() is the one that performs a reset.

[TheColector]

Admittedly I named this poorly (not sure why I chose this name), but restart() does what you're asking. The API could probably use more documentation to make that clearer and/or be renamed. reset() is the one that performs a reset.

Ahh, yes you are right.
From the first post you mentioned RESTART but for some reason I kept reading reset, hence the confusion and my reply.

Is there any action you think we could take here?
Updating documentation to explicitly state it works like resume or something else?
Guess changing the API is out of the question for the moment unless you plan on some breaking changes in the future.

Thanks for clarifying that.

BR,
Michael

[hkpeprah]

We should do two things:

1. Updated the documentation string for the method to clearly indicate what it is doing.
2. Add an alias method, .resume(), to replace my poor naming. We can mark the .restart() as deprecated using a warning:

warnings.warn(".restart() is deprecated, please use .resume() instead", DeprecationWarning, stacklevel=2)