Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Verify flash contents after programming #1702

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Verify flash contents after programming #1702

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions pyocd/core/options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,8 @@ class OptionInfo(NamedTuple):
"Name of test firmware binary."),
OptionInfo('user_script', str, None,
"Path of the user script file."),
OptionInfo('verify', bool, True,
"Controls whether a verify pass should be performed after flash programming has finished. Default is True"),
OptionInfo('warning.cortex_m_default', bool, True,
"Whether to show the warning about use of the cortex_m target type. Default is True."),

Expand Down
40 changes: 27 additions & 13 deletions pyocd/flash/builder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,11 @@ def mark_all_pages_not_same(self):
for page in self.page_list:
page.same = False

def mark_all_pages_unknown(self):
"""@brief Sets the same flag to False for all pages in this sector."""
for page in self.page_list:
page.same = None

def __repr__(self):
return "<_FlashSector@%x addr=%x size=%x wgt=%g pages=%s, subsectors=%d>" % (
id(self), self.addr, self.size, self.erase_weight, self.page_list, self.n_subsectors)
Expand Down Expand Up @@ -417,7 +422,7 @@ def add_page_with_existing_data():
page = add_page_with_existing_data()
sector_page_addr += page.size

def program(self, chip_erase=None, progress_cb=None, smart_flash=True, fast_verify=False, keep_unwritten=True, no_reset=False):
def program(self, chip_erase=None, progress_cb=None, smart_flash=True, fast_verify=False, keep_unwritten=True, no_reset=False, verify=True):
"""@brief Determine fastest method of flashing and then run flash programming.

Data must have already been added with add_data().
Expand All @@ -444,6 +449,8 @@ def program(self, chip_erase=None, progress_cb=None, smart_flash=True, fast_veri
be read from memory and restored while programming.
@param no_reset Boolean indicating whether if the device should not be reset after the
programming process has finished.
@param verify Boolean indicating whether a verify pass should be performed after the
programming process has finished.
"""

# Send notification that we're about to program flash.
Expand Down Expand Up @@ -535,12 +542,6 @@ def program(self, chip_erase=None, progress_cb=None, smart_flash=True, fast_veri
else:
flash_operation = self._sector_erase_program(progress_cb)

# Cleanup flash algo and reset target after programming.
self.flash.cleanup()

if no_reset is not True:
self.flash.target.reset_and_halt()

program_finish = time()
self.perf.program_time = program_finish - program_start
self.perf.program_type = flash_operation
Expand Down Expand Up @@ -571,6 +572,23 @@ def program(self, chip_erase=None, progress_cb=None, smart_flash=True, fast_veri
self.perf.skipped_byte_count = skipped_byte_count
self.perf.skipped_page_count = skipped_page_count

if verify:
LOG.info("Verifying")
# Reset same flag for all pages to enable rescanning
for sector in self.sector_list:
sector.mark_all_pages_unknown()
self._scan_pages_for_same(progress_cb)
failed_pages = [page for page in self.page_list if page.same is False]
if failed_pages:
LOG.debug("Verify failed for pages {}".format(failed_pages))
raise FlashProgramFailure('flash verify failure', address=failed_pages[0].addr)

# Cleanup flash algo and reset target after programming.
self.flash.cleanup()

if no_reset is not True:
self.flash.target.reset_and_halt()

if self.log_performance:
if chip_erase:
LOG.info("Erased chip, programmed %d bytes (%s), skipped %d bytes (%s) at %.02f kB/s",
Expand Down Expand Up @@ -899,12 +917,6 @@ def _scan_pages_for_same(self, progress_cb=_stub_progress):
if self.sector_erase_weight > 0:
progress_cb(float(progress) / float(self.sector_erase_weight))

# If we have to program any pages of a sector, then mark all pages of that sector
# as needing to be programmed, since the sector will be erased.
for sector in self.sector_list:
if sector.are_any_pages_not_same():
sector.mark_all_pages_not_same()

return progress

def _next_nonsame_page(self, i):
Expand Down Expand Up @@ -937,6 +949,8 @@ def _sector_erase_program_double_buffer(self, progress_cb=_stub_progress):
self.flash.init(self.flash.Operation.ERASE)
for sector in self.sector_list:
if sector.are_any_pages_not_same():
# If the sector is erased, all its pages must be programmed
sector.mark_all_pages_not_same()
# Erase the sector
for addr in sector.addrs:
self.flash.erase_sector(addr)
Expand Down
9 changes: 7 additions & 2 deletions pyocd/flash/file_programmer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@ def __init__(self,
smart_flash: Optional[bool] = None,
trust_crc: Optional[bool] = None,
keep_unwritten: Optional[bool] = None,
no_reset: Optional[bool] = None
no_reset: Optional[bool] = None,
verify: Optional[bool] = None
):
"""@brief Constructor.

Expand All @@ -88,13 +89,16 @@ def __init__(self,
be read from memory and restored while programming.
@param no_reset Boolean indicating whether if the device should not be reset after the
programming process has finished.
@param verify Boolean indicating whether a verify pass should be performed after the
programming process has finished.
"""
self._session = session
self._chip_erase = chip_erase
self._smart_flash = smart_flash
self._trust_crc = trust_crc
self._keep_unwritten = keep_unwritten
self._no_reset = no_reset
self._verify = verify
self._progress = progress
self._loader = None

Expand Down Expand Up @@ -154,7 +158,8 @@ def program(self, file_or_path: Union[str, IO[bytes]], file_format: Optional[str
smart_flash=self._smart_flash,
trust_crc=self._trust_crc,
keep_unwritten=self._keep_unwritten,
no_reset=self._no_reset)
no_reset=self._no_reset,
verify=self._verify)

# file_obj = None
# Open the file if a path was provided.
Expand Down
11 changes: 9 additions & 2 deletions pyocd/flash/loader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ class MemoryLoader:
_trust_crc: Optional[bool]
_keep_unwritten: Optional[bool]
_no_reset: Optional[bool]
_verify: Optional[bool]

def __init__(self,
session: "Session",
Expand All @@ -154,7 +155,8 @@ def __init__(self,
smart_flash: Optional[bool] = None,
trust_crc: Optional[bool] = None,
keep_unwritten: Optional[bool] = None,
no_reset: Optional[bool] = None
no_reset: Optional[bool] = None,
verify: Optional[bool] = None
):
"""@brief Constructor.

Expand All @@ -177,6 +179,8 @@ def __init__(self,
be read from memory and restored while programming.
@param no_reset Boolean indicating whether if the device should not be reset after the
programming process has finished.
@param verify Boolean indicating whether a verify pass should be performed after the
programming process has finished.
"""
self._session = session
assert session.board
Expand All @@ -201,6 +205,8 @@ def __init__(self,
else self._session.options.get('keep_unwritten')
self._no_reset = no_reset if (no_reset is not None) \
else self._session.options.get('no_reset')
self._verify = verify if (verify is not None) \
else self._session.options.get('verify')

self._reset_state()

Expand Down Expand Up @@ -297,7 +303,8 @@ def commit(self):
smart_flash=self._smart_flash,
fast_verify=self._trust_crc,
keep_unwritten=self._keep_unwritten,
no_reset=self._no_reset)
no_reset=self._no_reset,
verify=self._verify)
perfList.append(perf)
didChipErase = True

Expand Down
3 changes: 2 additions & 1 deletion pyocd/subcommands/load_cmd.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,8 @@ def invoke(self) -> int:
programmer = FileProgrammer(session,
chip_erase=self._args.erase,
trust_crc=self._args.trust_crc,
no_reset=self._args.no_reset)
no_reset=self._args.no_reset,
verify=self._args.verify)
for filename in self._args.file:
# Get an initial path with the argument as-is.
file_path = Path(filename).expanduser()
Expand Down