Merge pull request #14221 from macronix/macronix_rww

Enable the RWW function of Macronix Flash MX25LW51245G in OSPI block device driver

Author: 0xc0170

storage/blockdevice/COMPONENT_OSPIF/include/OSPIF/MX25LM51245G_config.h

@@ -17,7 +17,6 @@
 #ifndef MBED_OSPI_FLASH_MX25LM51245G_H
 #define MBED_OSPI_FLASH_MX25LM51245G_H
 
-
 #define OSPI_FLASH_CHIP_STRING "macronix MX25LM51245G"
 
 // This is a workaround,
@@ -26,20 +25,13 @@
 // The code below can be removed when users test with the new flash.
 #define NEED_DEFINE_SFDP_PARA
 
-#ifdef NEED_DEFINE_SFDP_PARA
-uint8_t _sfdp_head_table[32] = {0x53, 0x46, 0x44, 0x50, 0x06, 0x01, 0x02, 0xFF, 0x00, 0x06, 0x01,
-                                0x10, 0x30, 0x00, 0x00, 0xFF, 0xC2, 0x00, 0x01, 0x04, 0x10, 0x01,
-                                0x00, 0xFF, 0x84, 0x00, 0x01, 0x02, 0xC0, 0x00, 0x00, 0xFF
-                               };
-uint8_t _sfdp_basic_param_table[64] = {0x30, 0xFF, 0xFB, 0xFF, 0xFF, 0xFF, 0xFF, 0x1F, 0xFF, 0xFF,
-                                       0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x01, 0x14, 0xEC,
-                                       0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x0C, 0x20,
-                                       0x10, 0xDC, 0x00, 0xFF, 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
-                                       0x81, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
-                                       0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
-                                       0xFF, 0x50, 0xF9, 0x80
-                                      };
-uint8_t _sfdp_4_byte_inst_table[8] = {0x7F, 0xEF, 0xFF, 0xFF, 0x21, 0x5C, 0xDC, 0x14};
-#endif
+#define OSPIF_CR2_OPI_EN_ADDR      0x00000000
+
+#define MX_FLASH_BLOCK_SIZE        0x10000    /* 1024 blocks of 64 KBytes */
+#define MX_FLASH_SECTOR_SIZE       0x1000     /* 16384 sectors of 4 kBytes */
+#define MX_FLASH_PAGE_SIZE         0x100      /* 262144 pages of 256 bytes */
+#define MX_FLASH_CHUNK_SIZE        0x10       /* 16 bytes */
+#define MX_FLASH_BANK_SIZE         0x01000000 /* 16 MBytes */
+#define MX_FLASH_BANK_SIZE_MASK    ~(MX_FLASH_BANK_SIZE - 1) /* 0xFF000000 */
 
 #endif // MBED_OSPI_FLASH_MX25LM51245G_H

storage/blockdevice/COMPONENT_OSPIF/include/OSPIF/MX25LW51245G_config.h

@@ -0,0 +1,44 @@
+/* mbed Microcontroller Library
+ * Copyright (c) 2020 ARM Limited
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef MBED_OSPI_FLASH_MX25LW51245G_H
+#define MBED_OSPI_FLASH_MX25LW51245G_H
+
+#define OSPI_FLASH_CHIP_STRING "macronix MX25LW51245G"
+
+// This is a workaround,
+// The sfdp parameter values in Macronix old octaflash(include the MX25LW51245G on L4R9I_DISCO) are all 0xFF,
+// so we need to define the parameter values by software to support SFDP parsing.
+// The code below can be removed when users test with the new flash.
+#define NEED_DEFINE_SFDP_PARA
+
+#define MX_FLASH_SUPPORT_RWW 1
+
+// Configuration Register2 address
+#define OSPIF_CR2_OPI_EN_ADDR         0x00000000
+#define OSPIF_CR2_BANK_STATUS_ADDR    0xc0000000
+#define OSPIF_CR2_RWWDI               ((uint8_t)0x00)        /*!< No active program or erase operation */
+#define OSPIF_CR2_RWWDS               ((uint8_t)0x01)        /*!< Program/erase in other bank */
+#define OSPIF_CR2_RWWBS               ((uint8_t)0x03)        /*!< program/erase operation in addressed bank */
+
+#define MX_FLASH_BLOCK_SIZE           0x10000    /* 1024 blocks of 64 KBytes */
+#define MX_FLASH_SECTOR_SIZE          0x1000     /* 16384 sectors of 4 kBytes */
+#define MX_FLASH_PAGE_SIZE            0x100      /* 262144 pages of 256 bytes */
+#define MX_FLASH_CHUNK_SIZE           0x10       /* 16 bytes */
+#define MX_FLASH_BANK_SIZE            0x01000000 /* 16 MBytes */
+#define MX_FLASH_BANK_SIZE_MASK       ~(MX_FLASH_BANK_SIZE - 1) /* 0xFF000000 */
+
+#endif // MBED_OSPI_FLASH_MX25LW51245G_H

storage/blockdevice/COMPONENT_OSPIF/include/OSPIF/OSPIFBlockDevice.h

@@ -22,6 +22,14 @@
 #include "blockdevice/BlockDevice.h"
 #include "platform/Callback.h"
 
+#if defined(TARGET_MX25LM51245G)
+#include "MX25LM51245G_config.h"
+#endif
+
+#if defined(TARGET_MX25LW51245G)
+#include "MX25LW51245G_config.h"
+#endif
+
 #ifndef MBED_CONF_OSPIF_OSPI_IO0
 #define MBED_CONF_OSPIF_OSPI_IO0 NC
 #endif
@@ -381,6 +389,10 @@ class OSPIFBlockDevice : public mbed::BlockDevice {
     // Detect 4-byte addressing mode and enable it if supported
     int _sfdp_detect_and_enable_4byte_addressing(uint8_t *basic_param_table_ptr, int basic_param_table_size);
 
+#ifdef MX_FLASH_SUPPORT_RWW
+    bool _is_mem_ready_rww(bd_addr_t addr, uint8_t rw);
+#endif
+
 private:
     enum ospif_clear_protection_method_t {
         OSPIF_BP_ULBPR,    // Issue global protection unlock instruction
@@ -449,6 +461,16 @@ class OSPIFBlockDevice : public mbed::BlockDevice {
 
     uint32_t _init_ref_count;
     bool _is_initialized;
+#ifdef MX_FLASH_SUPPORT_RWW
+    enum wait_flag {
+        NOT_STARTED,         // no wait is started
+        WRITE_WAIT_STARTED,  // write wait is started
+        ERASE_WAIT_STARTED,  // erase wait is started
+    };
+    uint32_t _busy_bank;    // Current busy bank
+    wait_flag _wait_flag;  // wait flag
+    PlatformMutex _busy_mutex;
+#endif
 };
 
 #endif