From: Tomas Vanek Date: Thu, 15 Nov 2018 23:23:10 +0000 (+0100) Subject: flash/nor/core.h: clarify comment flash_sector::is_erased X-Git-Tag: v0.11.0-rc1~768 X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff_plain;h=07da3b3913dcb6b65564f4fe67c2f26032f180c0;ds=sidebyside flash/nor/core.h: clarify comment flash_sector::is_erased Setting of flash_sector::is_erased in flash erase and mass erase is popular folklore. Make clear it is useless. Change-Id: Ide397eb6d24fc8fa38931e6c8a0693d39668a5d2 Signed-off-by: Tomas Vanek Reviewed-on: http://openocd.zylin.com/4768 Tested-by: jenkins Reviewed-by: Christopher Head --- diff --git a/src/flash/nor/core.h b/src/flash/nor/core.h index f6bd0cf1ae..a8edb2dc9b 100644 --- a/src/flash/nor/core.h +++ b/src/flash/nor/core.h @@ -45,9 +45,12 @@ struct flash_sector { uint32_t size; /** * Indication of erasure status: 0 = not erased, 1 = erased, - * other = unknown. Set by @c flash_driver_s::erase_check. + * other = unknown. Set by @c flash_driver_s::erase_check only. * - * Flag is not used in protection block + * This information must be considered stale immediately. + * Don't set it in flash_driver_s::erase or a device mass_erase + * Don't clear it in flash_driver_s::write + * The flag is not used in a protection block */ int is_erased; /**