QSPIFBlockDevice: Add quirk for inconsistent CR3NV register value

Cypress S25FS512S's SFDP table suggests that bit-1 of the register
CR3NV on 25FS512S should equal 1. But it is a known issue that the
value is actually 0 on hardware. So if we query the value of CR3NV
during configuration detection, we can't find a configuration that
matches the SFDP data. This issue has been discussed in the Linux MTD
(Memory Technology Devices) mailing list:
https://linux-mtd.infradead.narkive.com/ylHK6CyT/spi-nor-fs512s-incorrect-cr3nv-1-value

This commit adds a quirk to report bit-1 of CR3NV as 1.

Note: In Mbed OS, vendor-specific quirks can only be handled in block
devices. The SFDP functions assume data from hardware to be correct.
So this quirk is in the block device.

Author: LDong-Arm

storage/blockdevice/COMPONENT_QSPIF/include/QSPIF/QSPIFBlockDevice.h

@@ -376,6 +376,9 @@ class QSPIFBlockDevice : public mbed::BlockDevice {
 
     bool _needs_fast_mode;
 
+    // S25FS512S needs a quirk
+    bool _S25FS512S_quirk;
+
     // Clear block protection
     qspif_clear_protection_method_t _clear_protection_method;
 

storage/blockdevice/COMPONENT_QSPIF/source/QSPIFBlockDevice.cpp

@@ -176,6 +176,9 @@ QSPIFBlockDevice::QSPIFBlockDevice(PinName io0, PinName io1, PinName io2, PinNam
     // Set default 4-byte addressing extension register write instruction
     _attempt_4_byte_addressing = true;
     _4byte_msb_reg_write_inst = QSPIF_INST_4BYTE_REG_WRITE_DEFAULT;
+
+    // Quirk for Cypress S25FS512S
+    _S25FS512S_quirk = false;
 }
 
 int QSPIFBlockDevice::init()
@@ -1099,6 +1102,16 @@ int QSPIFBlockDevice::_handle_vendor_quirks()
             tr_debug("Applying quirks for ISSI");
             _num_status_registers = 1;
             break;
+        case 0x01:
+            if (vendor_device_ids[1] == 0x02 && vendor_device_ids[2] == 0x20) {
+                tr_debug("Applying quirks for Cypress S25FS512S");
+                // On a Cypress S25FS512S flash chip
+                // * The SFDP table expects the register bitfield CR3NV[1] to be 1
+                //   but its actual value on the hardware is 0. In order for SFDP parsing
+                //   to work, the quirk reports CR3NV[1] as 1.
+                _S25FS512S_quirk = true;
+            }
+            break;
     }
 
     return 0;
@@ -1469,6 +1482,16 @@ int QSPIFBlockDevice::_qspi_send_read_sfdp_command(mbed::bd_addr_t addr, mbed::s
         return status;
     }
 
+    // Handle S25FS512S quirk.
+    const mbed::bd_addr_t S25FS512S_CR3NV = 0x4;
+    if (_S25FS512S_quirk) {
+        if (addr == S25FS512S_CR3NV) {
+            // If we reach here, rx_buffer is guaranteed to be non-null
+            // because it's been checked by _qspi.read() above.
+            static_cast<uint8_t *>(rx_buffer)[0] |= (1 << 1);
+        }
+    }
+
     return QSPI_STATUS_OK;
 }