mtd: spi-nor: Fix clearing of QE bit on lock()/unlock()
[linux-2.6-microblaze.git] / drivers / mtd / spi-nor / spi-nor.c
index 83da510..d696334 100644 (file)
@@ -959,13 +959,19 @@ static int spi_nor_write_sr(struct spi_nor *nor, const u8 *sr, size_t len)
        return spi_nor_wait_till_ready(nor);
 }
 
-/* Write status register and ensure bits in mask match written values */
-static int spi_nor_write_sr_and_check(struct spi_nor *nor, u8 status_new,
-                                     u8 mask)
+/**
+ * spi_nor_write_sr1_and_check() - Write one byte to the Status Register 1 and
+ * ensure that the byte written match the received value.
+ * @nor:       pointer to a 'struct spi_nor'.
+ * @sr1:       byte value to be written to the Status Register.
+ *
+ * Return: 0 on success, -errno otherwise.
+ */
+static int spi_nor_write_sr1_and_check(struct spi_nor *nor, u8 sr1)
 {
        int ret;
 
-       nor->bouncebuf[0] = status_new;
+       nor->bouncebuf[0] = sr1;
 
        ret = spi_nor_write_sr(nor, nor->bouncebuf, 1);
        if (ret)
@@ -975,7 +981,94 @@ static int spi_nor_write_sr_and_check(struct spi_nor *nor, u8 status_new,
        if (ret)
                return ret;
 
-       return ((nor->bouncebuf[0] & mask) != (status_new & mask)) ? -EIO : 0;
+       if (nor->bouncebuf[0] != sr1) {
+               dev_dbg(nor->dev, "SR1: read back test failed\n");
+               return -EIO;
+       }
+
+       return 0;
+}
+
+/**
+ * spi_nor_write_16bit_sr_and_check() - Write the Status Register 1 and the
+ * Status Register 2 in one shot. Ensure that the byte written in the Status
+ * Register 1 match the received value, and that the 16-bit Write did not
+ * affect what was already in the Status Register 2.
+ * @nor:       pointer to a 'struct spi_nor'.
+ * @sr1:       byte value to be written to the Status Register 1.
+ *
+ * Return: 0 on success, -errno otherwise.
+ */
+static int spi_nor_write_16bit_sr_and_check(struct spi_nor *nor, u8 sr1)
+{
+       int ret;
+       u8 *sr_cr = nor->bouncebuf;
+       u8 cr_written;
+
+       /* Make sure we don't overwrite the contents of Status Register 2. */
+       if (!(nor->flags & SNOR_F_NO_READ_CR)) {
+               ret = spi_nor_read_cr(nor, &sr_cr[1]);
+               if (ret)
+                       return ret;
+       } else if (nor->params.quad_enable) {
+               /*
+                * If the Status Register 2 Read command (35h) is not
+                * supported, we should at least be sure we don't
+                * change the value of the SR2 Quad Enable bit.
+                *
+                * We can safely assume that when the Quad Enable method is
+                * set, the value of the QE bit is one, as a consequence of the
+                * nor->params.quad_enable() call.
+                *
+                * We can safely assume that the Quad Enable bit is present in
+                * the Status Register 2 at BIT(1). According to the JESD216
+                * revB standard, BFPT DWORDS[15], bits 22:20, the 16-bit
+                * Write Status (01h) command is available just for the cases
+                * in which the QE bit is described in SR2 at BIT(1).
+                */
+               sr_cr[1] = CR_QUAD_EN_SPAN;
+       } else {
+               sr_cr[1] = 0;
+       }
+
+       sr_cr[0] = sr1;
+
+       ret = spi_nor_write_sr(nor, sr_cr, 2);
+       if (ret)
+               return ret;
+
+       if (nor->flags & SNOR_F_NO_READ_CR)
+               return 0;
+
+       cr_written = sr_cr[1];
+
+       ret = spi_nor_read_cr(nor, &sr_cr[1]);
+       if (ret)
+               return ret;
+
+       if (cr_written != sr_cr[1]) {
+               dev_dbg(nor->dev, "CR: read back test failed\n");
+               return -EIO;
+       }
+
+       return 0;
+}
+
+/**
+ * spi_nor_write_sr_and_check() - Write the Status Register 1 and ensure that
+ * the byte written match the received value without affecting other bits in the
+ * Status Register 1 and 2.
+ * @nor:       pointer to a 'struct spi_nor'.
+ * @sr1:       byte value to be written to the Status Register.
+ *
+ * Return: 0 on success, -errno otherwise.
+ */
+static int spi_nor_write_sr_and_check(struct spi_nor *nor, u8 sr1)
+{
+       if (nor->flags & SNOR_F_HAS_16BIT_SR)
+               return spi_nor_write_16bit_sr_and_check(nor, sr1);
+
+       return spi_nor_write_sr1_and_check(nor, sr1);
 }
 
 /**
@@ -1774,7 +1867,7 @@ static int stm_lock(struct spi_nor *nor, loff_t ofs, uint64_t len)
        if ((status_new & mask) < (status_old & mask))
                return -EINVAL;
 
-       return spi_nor_write_sr_and_check(nor, status_new, mask);
+       return spi_nor_write_sr_and_check(nor, status_new);
 }
 
 /*
@@ -1859,7 +1952,7 @@ static int stm_unlock(struct spi_nor *nor, loff_t ofs, uint64_t len)
        if ((status_new & mask) > (status_old & mask))
                return -EINVAL;
 
-       return spi_nor_write_sr_and_check(nor, status_new, mask);
+       return spi_nor_write_sr_and_check(nor, status_new);
 }
 
 /*
@@ -1964,55 +2057,7 @@ static int macronix_quad_enable(struct spi_nor *nor)
 
        if (!(nor->bouncebuf[0] & SR_QUAD_EN_MX)) {
                dev_dbg(nor->dev, "Macronix Quad bit not set\n");
-               return -EINVAL;
-       }
-
-       return 0;
-}
-
-/**
- * spansion_quad_enable() - set QE bit in Configuraiton Register.
- * @nor:       pointer to a 'struct spi_nor'
- *
- * Set the Quad Enable (QE) bit in the Configuration Register.
- * This function is kept for legacy purpose because it has been used for a
- * long time without anybody complaining but it should be considered as
- * deprecated and maybe buggy.
- * First, this function doesn't care about the previous values of the Status
- * and Configuration Registers when it sets the QE bit (bit 1) in the
- * Configuration Register: all other bits are cleared, which may have unwanted
- * side effects like removing some block protections.
- * Secondly, it uses the Read Configuration Register (35h) instruction though
- * some very old and few memories don't support this instruction. If a pull-up
- * resistor is present on the MISO/IO1 line, we might still be able to pass the
- * "read back" test because the QSPI memory doesn't recognize the command,
- * so leaves the MISO/IO1 line state unchanged, hence spi_nor_read_cr() returns
- * 0xFF.
- *
- * bit 1 of the Configuration Register is the QE bit for Spansion like QSPI
- * memories.
- *
- * Return: 0 on success, -errno otherwise.
- */
-static int spansion_quad_enable(struct spi_nor *nor)
-{
-       u8 *sr_cr = nor->bouncebuf;
-       int ret;
-
-       sr_cr[0] = 0;
-       sr_cr[1] = CR_QUAD_EN_SPAN;
-       ret = spi_nor_write_sr(nor, sr_cr, 2);
-       if (ret)
-               return ret;
-
-       /* read back and check it */
-       ret = spi_nor_read_cr(nor, nor->bouncebuf);
-       if (ret)
-               return ret;
-
-       if (!(nor->bouncebuf[0] & CR_QUAD_EN_SPAN)) {
-               dev_dbg(nor->dev, "Spansion Quad bit not set\n");
-               return -EINVAL;
+               return -EIO;
        }
 
        return 0;
@@ -2090,7 +2135,7 @@ static int spansion_read_cr_quad_enable(struct spi_nor *nor)
 
        if (!(sr_cr[1] & CR_QUAD_EN_SPAN)) {
                dev_dbg(nor->dev, "Spansion Quad bit not set\n");
-               return -EINVAL;
+               return -EIO;
        }
 
        return 0;
@@ -2134,7 +2179,7 @@ static int sr2_bit7_quad_enable(struct spi_nor *nor)
 
        if (!(*sr2 & SR2_QUAD_EN_BIT7)) {
                dev_dbg(nor->dev, "SR2 Quad bit not set\n");
-               return -EINVAL;
+               return -EIO;
        }
 
        return 0;
@@ -2170,9 +2215,9 @@ static int spi_nor_clear_sr_bp(struct spi_nor *nor)
  *
  * Read-modify-write function that clears the Block Protection bits from the
  * Status Register without affecting other bits. The function is tightly
- * coupled with the spansion_quad_enable() function. Both assume that the Write
- * Register with 16 bits, together with the Read Configuration Register (35h)
- * instructions are supported.
+ * coupled with the spansion_read_cr_quad_enable() function. Both assume that
+ * the Write Register with 16 bits, together with the Read Configuration
+ * Register (35h) instructions are supported.
  *
  * Return: 0 on success, -errno otherwise.
  */
@@ -3678,19 +3723,38 @@ static int spi_nor_parse_bfpt(struct spi_nor *nor,
                break;
 
        case BFPT_DWORD15_QER_SR2_BIT1_BUGGY:
+               /*
+                * Writing only one byte to the Status Register has the
+                * side-effect of clearing Status Register 2.
+                */
        case BFPT_DWORD15_QER_SR2_BIT1_NO_RD:
+               /*
+                * Read Configuration Register (35h) instruction is not
+                * supported.
+                */
+               nor->flags |= SNOR_F_HAS_16BIT_SR | SNOR_F_NO_READ_CR;
                params->quad_enable = spansion_no_read_cr_quad_enable;
                break;
 
        case BFPT_DWORD15_QER_SR1_BIT6:
+               nor->flags &= ~SNOR_F_HAS_16BIT_SR;
                params->quad_enable = macronix_quad_enable;
                break;
 
        case BFPT_DWORD15_QER_SR2_BIT7:
+               nor->flags &= ~SNOR_F_HAS_16BIT_SR;
                params->quad_enable = sr2_bit7_quad_enable;
                break;
 
        case BFPT_DWORD15_QER_SR2_BIT1:
+               /*
+                * JESD216 rev B or later does not specify if writing only one
+                * byte to the Status Register clears or not the Status
+                * Register 2, so let's be cautious and keep the default
+                * assumption of a 16-bit Write Status (01h) command.
+                */
+               nor->flags |= SNOR_F_HAS_16BIT_SR;
+
                params->quad_enable = spansion_read_cr_quad_enable;
                break;
 
@@ -4654,9 +4718,11 @@ static void spi_nor_info_init_params(struct spi_nor *nor)
        u8 i, erase_mask;
 
        /* Initialize legacy flash parameters and settings. */
-       params->quad_enable = spansion_quad_enable;
+       params->quad_enable = spansion_read_cr_quad_enable;
        params->set_4byte = spansion_set_4byte;
        params->setup = spi_nor_default_setup;
+       /* Default to 16-bit Write Status (01h) Command */
+       nor->flags |= SNOR_F_HAS_16BIT_SR;
 
        /* Set SPI NOR sizes. */
        params->size = (u64)info->sector_size * info->n_sectors;
@@ -4869,7 +4935,7 @@ static int spi_nor_init(struct spi_nor *nor)
        int err;
 
        if (nor->clear_sr_bp) {
-               if (nor->params.quad_enable == spansion_quad_enable)
+               if (nor->params.quad_enable == spansion_read_cr_quad_enable)
                        nor->clear_sr_bp = spi_nor_spansion_clear_sr_bp;
 
                err = nor->clear_sr_bp(nor);