]> git.ipfire.org Git - thirdparty/kernel/stable.git/commitdiff
mtd: spi-nor: swp: Add support for the complement feature
authorMiquel Raynal <miquel.raynal@bootlin.com>
Tue, 26 May 2026 14:56:45 +0000 (16:56 +0200)
committerPratyush Yadav <pratyush@kernel.org>
Wed, 27 May 2026 12:36:02 +0000 (14:36 +0200)
The current locking implementation allows to select a power of two
number of blocks, which is going to be the protected amount, as well as
telling whether this is the data at the top (end of the device) or the
bottom (beginning of the device). This means at most we can cover half
of the device or the entire device, but nothing in between.

The complement feature allows a much finer grain of configuration, by
allowing to invert what is considered locked and unlocked.

Add support for this feature. The only known position for the CMP bit is
bit 6 of the configuration register.

The locking and unlocking logics are kept unchanged if the CMP bit is
unavailable. Otherwise, once the regular logic has been applied, we
check if we already found an optimal configuration. If not, we try with
the CMP bit set. If the coverage is closer to the request, we use it.

Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
Signed-off-by: Pratyush Yadav <pratyush@kernel.org>
drivers/mtd/spi-nor/core.c
drivers/mtd/spi-nor/core.h
drivers/mtd/spi-nor/debugfs.c
drivers/mtd/spi-nor/swp.c
include/linux/mtd/spi-nor.h

index 1fc71d6e0fec21b30b319ad4180ac4133a8e81d3..b25d1a870a22e75b75532af76f8bd3fe537ab5c4 100644 (file)
@@ -2974,6 +2974,9 @@ static void spi_nor_init_flags(struct spi_nor *nor)
                        nor->flags |= SNOR_F_HAS_SR_BP3_BIT6;
        }
 
+       if (flags & SPI_NOR_HAS_CMP)
+               nor->flags |= SNOR_F_HAS_SR2_CMP_BIT6;
+
        if (flags & SPI_NOR_RWW && nor->params->n_banks > 1 &&
            !nor->controller_ops)
                nor->flags |= SNOR_F_RWW;
index ce46771ecdc82f399ecdcb98d45d3ad37772346c..ba2d1a862c9d4eae353421a4ec2c555ea7fbc224 100644 (file)
@@ -141,6 +141,7 @@ enum spi_nor_option_flags {
        SNOR_F_ECC              = BIT(15),
        SNOR_F_NO_WP            = BIT(16),
        SNOR_F_SWAP16           = BIT(17),
+       SNOR_F_HAS_SR2_CMP_BIT6 = BIT(18),
 };
 
 struct spi_nor_read_command {
@@ -491,6 +492,8 @@ struct spi_nor_id {
  *   SPI_NOR_NO_ERASE:        no erase command needed.
  *   SPI_NOR_QUAD_PP:         flash supports Quad Input Page Program.
  *   SPI_NOR_RWW:             flash supports reads while write.
+ *   SPI_NOR_HAS_CMP:         flash SR2 has complement (CMP) protect bit. Must
+ *                            be used with SPI_NOR_HAS_LOCK.
  *
  * @no_sfdp_flags:  flags that indicate support that can be discovered via SFDP.
  *                  Used when SFDP tables are not defined in the flash. These
@@ -539,6 +542,7 @@ struct flash_info {
 #define SPI_NOR_NO_ERASE               BIT(6)
 #define SPI_NOR_QUAD_PP                        BIT(8)
 #define SPI_NOR_RWW                    BIT(9)
+#define SPI_NOR_HAS_CMP                        BIT(10)
 
        u8 no_sfdp_flags;
 #define SPI_NOR_SKIP_SFDP              BIT(0)
index ef710bd4f30789945a71b7ef40cd6fdaa5dfa68f..e80c03dd54611a7bfc51ed28f43e9b36ded2fc9c 100644 (file)
@@ -30,6 +30,7 @@ static const char *const snor_f_names[] = {
        SNOR_F_NAME(ECC),
        SNOR_F_NAME(NO_WP),
        SNOR_F_NAME(SWAP16),
+       SNOR_F_NAME(HAS_SR2_CMP_BIT6),
 };
 #undef SNOR_F_NAME
 
index 2411d8f1012d15cca21a34b5fc2216d1342cac13..235070b215d1e144179e5dd210c380d505540b54 100644 (file)
@@ -34,6 +34,15 @@ static u8 spi_nor_get_sr_tb_mask(struct spi_nor *nor)
                return 0;
 }
 
+static u8 spi_nor_get_sr_cmp_mask(struct spi_nor *nor)
+{
+       if (!(nor->flags & SNOR_F_NO_READ_CR) &&
+           nor->flags & SNOR_F_HAS_SR2_CMP_BIT6)
+               return SR2_CMP_BIT6;
+       else
+               return 0;
+}
+
 u64 spi_nor_get_min_prot_length_sr(struct spi_nor *nor)
 {
        unsigned int bp_slots, bp_slots_needed;
@@ -61,8 +70,10 @@ void spi_nor_get_locked_range_sr(struct spi_nor *nor, const u8 *sr, loff_t *ofs,
        u64 min_prot_len;
        u8 bp_mask = spi_nor_get_sr_bp_mask(nor);
        u8 tb_mask = spi_nor_get_sr_tb_mask(nor);
+       u8 cmp_mask = spi_nor_get_sr_cmp_mask(nor);
        u8 bp, val = sr[0] & bp_mask;
        bool tb = (nor->flags & SNOR_F_HAS_SR_TB) ? sr[0] & tb_mask : 0;
+       bool cmp = sr[1] & cmp_mask;
 
        if (nor->flags & SNOR_F_HAS_SR_BP3_BIT6 && val & SR_BP3_BIT6)
                val = (val & ~SR_BP3_BIT6) | SR_BP3;
@@ -70,22 +81,37 @@ void spi_nor_get_locked_range_sr(struct spi_nor *nor, const u8 *sr, loff_t *ofs,
        bp = val >> SR_BP_SHIFT;
 
        if (!bp) {
-               /* No protection */
-               *ofs = 0;
-               *len = 0;
+               if (!cmp) {
+                       /* No protection */
+                       *ofs = 0;
+                       *len = 0;
+               } else {
+                       /* Full protection */
+                       *ofs = 0;
+                       *len = nor->params->size;
+               }
                return;
        }
 
        min_prot_len = spi_nor_get_min_prot_length_sr(nor);
        *len = min_prot_len << (bp - 1);
-
        if (*len > nor->params->size)
                *len = nor->params->size;
 
-       if (tb)
-               *ofs = 0;
-       else
-               *ofs = nor->params->size - *len;
+       if (cmp)
+               *len = nor->params->size - *len;
+
+       if (!cmp) {
+               if (tb)
+                       *ofs = 0;
+               else
+                       *ofs = nor->params->size - *len;
+       } else {
+               if (tb)
+                       *ofs = nor->params->size - *len;
+               else
+                       *ofs = 0;
+       }
 }
 
 /*
@@ -142,13 +168,15 @@ static int spi_nor_sr_set_bp_mask(struct spi_nor *nor, u8 *sr, u8 pow)
 }
 
 static int spi_nor_build_sr(struct spi_nor *nor, const u8 *old_sr, u8 *new_sr,
-                           u8 pow, bool use_top)
+                           u8 pow, bool use_top, bool cmp)
 {
        u8 bp_mask = spi_nor_get_sr_bp_mask(nor);
        u8 tb_mask = spi_nor_get_sr_tb_mask(nor);
+       u8 cmp_mask = spi_nor_get_sr_cmp_mask(nor);
        int ret;
 
        new_sr[0] = old_sr[0] & ~bp_mask & ~tb_mask;
+       new_sr[1] = old_sr[1] & ~cmp_mask;
 
        /* Build BP field */
        ret = spi_nor_sr_set_bp_mask(nor, &new_sr[0], pow);
@@ -156,9 +184,13 @@ static int spi_nor_build_sr(struct spi_nor *nor, const u8 *old_sr, u8 *new_sr,
                return ret;
 
        /* Build TB field */
-       if (!use_top)
+       if ((!cmp && !use_top) || (cmp && use_top))
                new_sr[0] |= tb_mask;
 
+       /* Build CMP field */
+       if (cmp)
+               new_sr[1] |= cmp_mask;
+
        return 0;
 }
 
@@ -170,15 +202,27 @@ void spi_nor_cache_sr_lock_bits(struct spi_nor *nor, u8 *sr)
 {
        u8 bp_mask = spi_nor_get_sr_bp_mask(nor);
        u8 tb_mask = spi_nor_get_sr_tb_mask(nor);
+       u8 cmp_mask = spi_nor_get_sr_cmp_mask(nor);
+       u8 sr_cr[2] = {};
+
 
        if (!sr) {
                if (spi_nor_read_sr(nor, nor->bouncebuf))
                        return;
 
-               sr = nor->bouncebuf;
+               sr_cr[0] = nor->bouncebuf[0];
+
+               if (!(nor->flags & SNOR_F_NO_READ_CR)) {
+                       if (spi_nor_read_cr(nor, nor->bouncebuf))
+                               return;
+               }
+
+               sr_cr[1] = nor->bouncebuf[0];
+               sr = sr_cr;
        }
 
        nor->dfs_sr_cache[0] = sr[0] & (bp_mask | tb_mask | SR_SRWD);
+       nor->dfs_sr_cache[1] = sr[1] & cmp_mask;
 }
 
 /*
@@ -187,10 +231,11 @@ void spi_nor_cache_sr_lock_bits(struct spi_nor *nor, u8 *sr)
  * register
  * (SR). Does not support these features found in newer SR bitfields:
  *   - SEC: sector/block protect - only handle SEC=0 (block protect)
- *   - CMP: complement protect - only support CMP=0 (range is not complemented)
  *
  * Support for the following is provided conditionally for some flash:
  *   - TB: top/bottom protect
+ *   - CMP: complement protect (BP and TP describe the unlocked part, while
+ *          the reminder is locked)
  *
  * Sample table portion for 8MB flash (Winbond w25q64fw):
  *
@@ -217,11 +262,13 @@ void spi_nor_cache_sr_lock_bits(struct spi_nor *nor, u8 *sr)
 static int spi_nor_sr_lock(struct spi_nor *nor, loff_t ofs, u64 len)
 {
        u64 min_prot_len = spi_nor_get_min_prot_length_sr(nor);
-       u8 status_old[1] = {}, status_new[1] = {};
-       loff_t ofs_old, ofs_new;
-       u64 len_old, len_new;
+       u8 status_old[2] = {}, status_new[2] = {}, status_new_cmp[2] = {};
+       u8 *best_status_new = status_new;
+       loff_t ofs_old, ofs_new, ofs_new_cmp;
+       u64 len_old, len_new, len_new_cmp;
        loff_t lock_len;
-       bool can_be_top = true, can_be_bottom = nor->flags & SNOR_F_HAS_SR_TB;
+       bool can_be_top = true, can_be_bottom = nor->flags & SNOR_F_HAS_SR_TB,
+               can_be_cmp = spi_nor_get_sr_cmp_mask(nor);
        bool use_top;
        int ret;
        u8 pow;
@@ -232,6 +279,14 @@ static int spi_nor_sr_lock(struct spi_nor *nor, loff_t ofs, u64 len)
 
        status_old[0] = nor->bouncebuf[0];
 
+       if (!(nor->flags & SNOR_F_NO_READ_CR)) {
+               ret = spi_nor_read_cr(nor, nor->bouncebuf);
+               if (ret)
+                       return ret;
+
+               status_old[1] = nor->bouncebuf[0];
+       }
+
        /* If nothing in our range is unlocked, we don't need to do anything */
        if (spi_nor_is_locked_sr(nor, ofs, len, status_old))
                return 0;
@@ -262,27 +317,60 @@ static int spi_nor_sr_lock(struct spi_nor *nor, loff_t ofs, u64 len)
        else
                pow = ilog2(lock_len) - ilog2(min_prot_len) + 1;
 
-       ret = spi_nor_build_sr(nor, status_old, status_new, pow, use_top);
+       ret = spi_nor_build_sr(nor, status_old, status_new, pow, use_top, false);
        if (ret)
                return ret;
 
+       /*
+        * In case the region asked is not fully met, maybe we can try with the
+        * complement feature
+        */
+       spi_nor_get_locked_range_sr(nor, status_new, &ofs_new, &len_new);
+       if (can_be_cmp && len_new != lock_len) {
+               pow = ilog2(nor->params->size - lock_len) - ilog2(min_prot_len) + 1;
+               ret = spi_nor_build_sr(nor, status_old, status_new_cmp, pow, use_top, true);
+               if (ret)
+                       return ret;
+
+               /*
+                * ilog2() "floors" the result, which means in some cases we may have to
+                * manually reduce the scope when the complement feature is used.
+                * The uAPI is to never lock more than what is requested, but less is accepted.
+                * Make sure we are not covering a too wide range, reduce it otherwise.
+                */
+               spi_nor_get_locked_range_sr(nor, status_new_cmp, &ofs_new_cmp, &len_new_cmp);
+               if (len_new_cmp > lock_len) {
+                       pow++;
+                       ret = spi_nor_build_sr(nor, status_old, status_new_cmp, pow, use_top, true);
+                       if (ret)
+                               return ret;
+               }
+
+               /* Pick the CMP configuration if we cover a closer range */
+               spi_nor_get_locked_range_sr(nor, status_new, &ofs_new, &len_new);
+               spi_nor_get_locked_range_sr(nor, status_new_cmp, &ofs_new_cmp, &len_new_cmp);
+               if (len_new_cmp <= lock_len &&
+                   (lock_len - len_new_cmp) < (lock_len - len_new))
+                       best_status_new = status_new_cmp;
+       }
+
        /*
         * Disallow further writes if WP# pin is neither left floating nor
         * wrongly tied to GND (that includes internal pull-downs).
         * WP# pin hard strapped to GND can be a valid use case.
         */
        if (!(nor->flags & SNOR_F_NO_WP))
-               status_new[0] |= SR_SRWD;
+               best_status_new[0] |= SR_SRWD;
 
        spi_nor_get_locked_range_sr(nor, status_old, &ofs_old, &len_old);
-       spi_nor_get_locked_range_sr(nor, status_new, &ofs_new, &len_new);
+       spi_nor_get_locked_range_sr(nor, best_status_new, &ofs_new, &len_new);
 
        /* Don't "lock" with no region! */
        if (!len_new)
                return -EINVAL;
 
        /* Don't bother if they're the same */
-       if (status_new[0] == status_old[0])
+       if (best_status_new[0] == status_old[0] && best_status_new[1] == status_old[1])
                return 0;
 
        /* Only modify protection if it will not unlock other areas */
@@ -290,11 +378,14 @@ static int spi_nor_sr_lock(struct spi_nor *nor, loff_t ofs, u64 len)
            (ofs_old < ofs_new || (ofs_new + len_new) < (ofs_old + len_old)))
                return -EINVAL;
 
-       ret = spi_nor_write_sr_and_check(nor, status_new[0]);
+       if (nor->flags & SNOR_F_NO_READ_CR)
+               ret = spi_nor_write_sr_and_check(nor, best_status_new[0]);
+       else
+               ret = spi_nor_write_sr_cr_and_check(nor, best_status_new);
        if (ret)
                return ret;
 
-       spi_nor_cache_sr_lock_bits(nor, status_new);
+       spi_nor_cache_sr_lock_bits(nor, best_status_new);
 
        return 0;
 }
@@ -307,11 +398,13 @@ static int spi_nor_sr_lock(struct spi_nor *nor, loff_t ofs, u64 len)
 static int spi_nor_sr_unlock(struct spi_nor *nor, loff_t ofs, u64 len)
 {
        u64 min_prot_len = spi_nor_get_min_prot_length_sr(nor);
-       u8 status_old[1], status_new[1];
-       loff_t ofs_old, ofs_new;
-       u64 len_old, len_new;
+       u8 status_old[2] = {}, status_new[2] = {}, status_new_cmp[2] = {};
+       u8 *best_status_new = status_new;
+       loff_t ofs_old, ofs_new, ofs_new_cmp;
+       u64 len_old, len_new, len_new_cmp;
        loff_t lock_len;
-       bool can_be_top = true, can_be_bottom = nor->flags & SNOR_F_HAS_SR_TB;
+       bool can_be_top = true, can_be_bottom = nor->flags & SNOR_F_HAS_SR_TB,
+               can_be_cmp = spi_nor_get_sr_cmp_mask(nor);
        bool use_top;
        int ret;
        u8 pow;
@@ -322,6 +415,14 @@ static int spi_nor_sr_unlock(struct spi_nor *nor, loff_t ofs, u64 len)
 
        status_old[0] = nor->bouncebuf[0];
 
+       if (!(nor->flags & SNOR_F_NO_READ_CR)) {
+               ret = spi_nor_read_cr(nor, nor->bouncebuf);
+               if (ret)
+                       return ret;
+
+               status_old[1] = nor->bouncebuf[0];
+       }
+
        /* If nothing in our range is locked, we don't need to do anything */
        if (spi_nor_is_unlocked_sr(nor, ofs, len, status_old))
                return 0;
@@ -359,30 +460,66 @@ static int spi_nor_sr_unlock(struct spi_nor *nor, loff_t ofs, u64 len)
        else
                pow = ilog2(lock_len) - ilog2(min_prot_len) + 1;
 
-       ret = spi_nor_build_sr(nor, status_old, status_new, pow, use_top);
+       ret = spi_nor_build_sr(nor, status_old, status_new, pow, use_top, false);
        if (ret)
                return ret;
 
+       /*
+        * In case the region asked is not fully met, maybe we can try with the
+        * complement feature
+        */
+       spi_nor_get_locked_range_sr(nor, status_new, &ofs_new, &len_new);
+       if (can_be_cmp && len_new != lock_len) {
+               pow = ilog2(nor->params->size - lock_len) - ilog2(min_prot_len) + 1;
+               ret = spi_nor_build_sr(nor, status_old, status_new_cmp, pow, use_top, true);
+               if (ret)
+                       return ret;
+
+               /*
+                * ilog2() "floors" the result, which means in some cases we may have to
+                * manually reduce the scope when the complement feature is used.
+                * The uAPI is to never unlock more than what is requested, but less is accepted.
+                * Make sure we are not covering a too small range, increase it otherwise.
+                */
+               spi_nor_get_locked_range_sr(nor, status_new_cmp, &ofs_new_cmp, &len_new_cmp);
+               if (len_new_cmp < lock_len) {
+                       pow--;
+                       ret = spi_nor_build_sr(nor, status_old, status_new_cmp, pow, use_top, true);
+                       if (ret)
+                               return ret;
+               }
+
+               /* Pick the CMP configuration if we cover a closer range */
+               spi_nor_get_locked_range_sr(nor, status_new, &ofs_new, &len_new);
+               spi_nor_get_locked_range_sr(nor, status_new_cmp, &ofs_new_cmp, &len_new_cmp);
+               if (len_new_cmp <= lock_len &&
+                   (lock_len - len_new_cmp) < (lock_len - len_new))
+                       best_status_new = status_new_cmp;
+       }
+
        /* Don't protect status register if we're fully unlocked */
        if (lock_len == 0)
-               status_new[0] &= ~SR_SRWD;
+               best_status_new[0] &= ~SR_SRWD;
 
        /* Don't bother if they're the same */
-       if (status_new[0] == status_old[0])
+       if (best_status_new[0] == status_old[0] && best_status_new[1] == status_old[1])
                return 0;
 
        /* Only modify protection if it will not lock other areas */
        spi_nor_get_locked_range_sr(nor, status_old, &ofs_old, &len_old);
-       spi_nor_get_locked_range_sr(nor, status_new, &ofs_new, &len_new);
+       spi_nor_get_locked_range_sr(nor, best_status_new, &ofs_new, &len_new);
        if (len_old && len_new &&
            (ofs_new < ofs_old || (ofs_old + len_old) < (ofs_new + len_new)))
                return -EINVAL;
 
-       ret = spi_nor_write_sr_and_check(nor, status_new[0]);
+       if (nor->flags & SNOR_F_NO_READ_CR)
+               ret = spi_nor_write_sr_and_check(nor, best_status_new[0]);
+       else
+               ret = spi_nor_write_sr_cr_and_check(nor, best_status_new);
        if (ret)
                return ret;
 
-       spi_nor_cache_sr_lock_bits(nor, status_new);
+       spi_nor_cache_sr_lock_bits(nor, best_status_new);
 
        return 0;
 }
@@ -396,13 +533,24 @@ static int spi_nor_sr_unlock(struct spi_nor *nor, loff_t ofs, u64 len)
  */
 static int spi_nor_sr_is_locked(struct spi_nor *nor, loff_t ofs, u64 len)
 {
+       u8 sr_cr[2] = {};
        int ret;
 
        ret = spi_nor_read_sr(nor, nor->bouncebuf);
        if (ret)
                return ret;
 
-       return spi_nor_is_locked_sr(nor, ofs, len, nor->bouncebuf);
+       sr_cr[0] = nor->bouncebuf[0];
+
+       if (!(nor->flags & SNOR_F_NO_READ_CR)) {
+               ret = spi_nor_read_cr(nor, nor->bouncebuf);
+               if (ret)
+                       return ret;
+
+               sr_cr[1] = nor->bouncebuf[0];
+       }
+
+       return spi_nor_is_locked_sr(nor, ofs, len, sr_cr);
 }
 
 static const struct spi_nor_locking_ops spi_nor_sr_locking_ops = {
index 9ad77f9e76c270f4cb332f73de5a84b748aefa22..4b92494827b151d5b0b903c16568fc53b892a182 100644 (file)
 #define SR2_LB1                        BIT(3)  /* Security Register Lock Bit 1 */
 #define SR2_LB2                        BIT(4)  /* Security Register Lock Bit 2 */
 #define SR2_LB3                        BIT(5)  /* Security Register Lock Bit 3 */
+#define SR2_CMP_BIT6           BIT(6)
 #define SR2_QUAD_EN_BIT7       BIT(7)
 
 /* Supported SPI protocols */