flash: clarify protect documentation

some chips unprotect more than the range asked for. The
protect fn, must unprotect/protect minimally the range given.

Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>

diff --git a/src/flash/nor/driver.h b/src/flash/nor/driver.h
index 3757442fcc8788206b4aa0c6f2074edab3ec1bad..cbf9c5282a2ce61bb2fc97950ba7c4a3c2d09e77 100644 (file)
--- a/src/flash/nor/driver.h
+++ b/src/flash/nor/driver.h
@@ -105,9 +105,12 @@ struct flash_driver
 
        /**
         * Bank/sector protection routine (target-specific).
-        * When called, the driver should disable 'flash write' bits (or
-        * enable 'erase protection' bits) for the given @a bank and @a
-        * sectors.
+        *
+        * When called, the driver should enable/disable protection
+        * for MINIMUM the range covered by first..last sectors
+        * inclusive. Some chips have alignment requirements will
+        * cause the actual range to be protected / unprotected to
+        * be larger than the first..last range.
         *
         * @param bank The bank to protect or unprotect.
         * @param set If non-zero, enable protection; if 0, disable it.