SFDP: splits header parsing to its own file

SFDP logic is the same between SPIF and QSIP.

Author: Veijo Pesonen

components/storage/blockdevice/COMPONENT_QSPIF/QSPIFBlockDevice.cpp

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+#include "drivers/internal/SFDP.h"
 #include "QSPIFBlockDevice.h"
 #include <string.h>
 #include "rtos/ThisThread.h"
@@ -204,10 +205,8 @@ int QSPIFBlockDevice::init()
     }
 
     int status = QSPIF_BD_ERROR_OK;
-    uint32_t basic_table_addr = 0;
-    size_t basic_table_size = 0;
-    uint32_t sector_map_table_addr = 0;
-    size_t sector_map_table_size = 0;
+    sfdp_hdr_info hdr_info;
+    memset(&hdr_info, 0, sizeof hdr_info);
 
     _mutex.lock();
 
@@ -251,14 +250,14 @@ int QSPIFBlockDevice::init()
     }
 
     /**************************** Parse SFDP Header ***********************************/
-    if (0 != _sfdp_parse_sfdp_headers(basic_table_addr, basic_table_size, sector_map_table_addr, sector_map_table_size)) {
+    if (0 != _sfdp_parse_sfdp_headers(hdr_info)) {
         tr_error("Init - Parse SFDP Headers Failed");
         status = QSPIF_BD_ERROR_PARSING_FAILED;
         goto exit_point;
     }
 
     /**************************** Parse Basic Parameters Table ***********************************/
-    if (0 != _sfdp_parse_basic_param_table(basic_table_addr, basic_table_size)) {
+    if (0 != _sfdp_parse_basic_param_table(hdr_info.basic_table_addr, hdr_info.basic_table_size)) {
         tr_error("Init - Parse Basic Param Table Failed");
         status = QSPIF_BD_ERROR_PARSING_FAILED;
         goto exit_point;
@@ -269,10 +268,10 @@ int QSPIFBlockDevice::init()
         _device_size_bytes; // If there's no region map, we have a single region sized the entire device size
     _region_high_boundary[0] = _device_size_bytes - 1;
 
-    if ((sector_map_table_addr != 0) && (0 != sector_map_table_size)) {
-        tr_debug("Init - Parsing Sector Map Table - addr: 0x%lxh, Size: %d", sector_map_table_addr,
-                 sector_map_table_size);
-        if (0 != _sfdp_parse_sector_map_table(sector_map_table_addr, sector_map_table_size)) {
+    if ((hdr_info.sector_map_table_addr != 0) && (0 != hdr_info.sector_map_table_size)) {
+        tr_debug("Init - Parsing Sector Map Table - addr: 0x%lxh, Size: %d", hdr_info.sector_map_table_addr,
+                 hdr_info.sector_map_table_size);
+        if (0 != _sfdp_parse_sector_map_table(hdr_info.sector_map_table_addr, hdr_info.sector_map_table_size)) {
             tr_error("Init - Parse Sector Map Table Failed");
             status = QSPIF_BD_ERROR_PARSING_FAILED;
             goto exit_point;
@@ -629,65 +628,51 @@ int QSPIFBlockDevice::remove_csel_instance(PinName csel)
 /*********************************************************/
 /********** SFDP Parsing and Detection Functions *********/
 /*********************************************************/
-int QSPIFBlockDevice::_sfdp_parse_sfdp_headers(uint32_t &basic_table_addr, size_t &basic_table_size,
-                                               uint32_t &sector_map_table_addr, size_t &sector_map_table_size)
+int QSPIFBlockDevice::_sfdp_parse_sfdp_headers(mbed::sfdp_hdr_info &hdr_info)
 {
-    uint8_t sfdp_header[QSPIF_SFDP_HEADER_SIZE];
-    uint8_t param_header[QSPIF_PARAM_HEADER_SIZE];
-    size_t data_length = QSPIF_SFDP_HEADER_SIZE;
     bd_addr_t addr = 0x0;
+    int number_of_param_headers = 0;
+    size_t data_length;
 
-    qspi_status_t status = _qspi_send_read_sfdp_command(addr, (char *) sfdp_header, data_length);
-    if (status != QSPI_STATUS_OK) {
-        tr_error("Init - Read SFDP Failed");
-        return -1;
-    }
-
-    // Verify SFDP signature for sanity
-    // Also check that major/minor version is acceptable
-    if (!(memcmp(&sfdp_header[0], "SFDP", 4) == 0 && sfdp_header[5] == 1)) {
-        tr_error("Init - Verification of SFDP signature and version failed");
-        return -1;
-    } else {
-        tr_debug("Init - Verification of SFDP signature and version succeeded");
-    }
-
-    // Discover Number of Parameter Headers
-    int number_of_param_headers = (int)(sfdp_header[6]) + 1;
-    tr_debug("Number of Param Headers: %d", number_of_param_headers);
-
-
-    addr += QSPIF_SFDP_HEADER_SIZE;
-    data_length = QSPIF_PARAM_HEADER_SIZE;
+    {
+        data_length = QSPIF_SFDP_HEADER_SIZE;
+        uint8_t sfdp_header[QSPIF_SFDP_HEADER_SIZE];
 
-    // Loop over Param Headers and parse them (currently supports Basic Param Table and Sector Region Map Table)
-    for (int i_ind = 0; i_ind < number_of_param_headers; i_ind++) {
-        status = _qspi_send_read_sfdp_command(addr, (char *) param_header, data_length);
+        qspi_status_t status = _qspi_send_read_sfdp_command(addr, (char *)sfdp_header, data_length);
         if (status != QSPI_STATUS_OK) {
-            tr_error("Init - Read Param Table %d Failed", i_ind + 1);
+            tr_error("init - Retrieving SFDP Header failed");
             return -1;
         }
 
-        // The SFDP spec indicates the standard table is always at offset 0
-        // in the parameter headers, we check just to be safe
-        if (param_header[2] != 1) {
-            tr_error("Param Table %d - Major Version should be 1!", i_ind + 1);
-            return -1;
+        number_of_param_headers = sfdp_parse_sfdp_header((sfdp_hdr *)sfdp_header);
+        if (number_of_param_headers < 0) {
+            return number_of_param_headers;
         }
+    }
 
-        if ((param_header[0] == 0) && (param_header[7] == 0xFF)) {
-            tr_debug("Parameter Header %d: Basic Parameter Header", i_ind);
-            basic_table_addr = ((param_header[6] << 16) | (param_header[5] << 8) | (param_header[4]));
-            // Supporting up to 64 Bytes Table (16 DWORDS)
-            basic_table_size = ((param_header[3] * 4) < SFDP_DEFAULT_BASIC_PARAMS_TABLE_SIZE_BYTES) ? (param_header[3] * 4) : 64;
-        } else if ((param_header[0] == 0x81) && (param_header[7] == 0xFF)) {
-            tr_debug("Parameter Header %d: Sector Map Parameter Header", i_ind);
-            sector_map_table_addr = ((param_header[6] << 16) | (param_header[5] << 8) | (param_header[4]));
-            sector_map_table_size = param_header[3] * 4;
-        } else {
-            tr_debug("Parameter Header %d: Vendor specific or unknown header", i_ind);
+    addr += QSPIF_SFDP_HEADER_SIZE;
+
+    {
+        data_length = QSPIF_PARAM_HEADER_SIZE;
+        uint8_t param_header[QSPIF_PARAM_HEADER_SIZE];
+        qspi_status_t status;
+        int hdr_status;
+
+        // Loop over Param Headers and parse them (currently supports Basic Param Table and Sector Region Map Table)
+        for (int i_ind = 0; i_ind < number_of_param_headers; i_ind++) {
+            status = _qspi_send_read_sfdp_command(addr, (char *)param_header, data_length);
+            if (status != QSPI_STATUS_OK) {
+                tr_error("init - Retrieving Parameter Header %d failed", i_ind + 1);
+                return -1;
+            }
+
+            hdr_status = sfdp_parse_single_param_header((sfdp_prm_hdr *)param_header, hdr_info);
+            if (hdr_status < 0) {
+                return hdr_status;
+            }
+
+            addr += QSPIF_PARAM_HEADER_SIZE;
         }
-        addr += QSPIF_PARAM_HEADER_SIZE;
     }
 
     return 0;

components/storage/blockdevice/COMPONENT_QSPIF/QSPIFBlockDevice.h

@@ -17,6 +17,7 @@
 #define MBED_QSPIF_BLOCK_DEVICE_H
 
 #include "drivers/QSPI.h"
+#include "drivers/internal/SFDP.h"
 #include "features/storage/blockdevice/BlockDevice.h"
 
 #ifndef MBED_CONF_QSPIF_QSPI_IO0
@@ -312,8 +313,7 @@ class QSPIFBlockDevice : public mbed::BlockDevice {
     /* SFDP Detection and Parsing Functions */
     /****************************************/
     // Parse SFDP Headers and retrieve Basic Param and Sector Map Tables (if exist)
-    int _sfdp_parse_sfdp_headers(uint32_t &basic_table_addr, size_t &basic_table_size,
-                                 uint32_t &sector_map_table_addr, size_t &sector_map_table_size);
+    int _sfdp_parse_sfdp_headers(mbed::sfdp_hdr_info &hdr_info);
 
     // Parse and Detect required Basic Parameters from Table
     int _sfdp_parse_basic_param_table(uint32_t basic_table_addr, size_t basic_table_size);

components/storage/blockdevice/COMPONENT_SPIF/SPIFBlockDevice.cpp

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+#include "drivers/internal/SFDP.h"
 #include "SPIFBlockDevice.h"
 #include "rtos/ThisThread.h"
 #include "mbed_critical.h"
@@ -133,12 +134,11 @@ int SPIFBlockDevice::init()
     uint8_t vendor_device_ids[4];
     size_t data_length = 3;
     int status = SPIF_BD_ERROR_OK;
-    uint32_t basic_table_addr = 0;
-    size_t basic_table_size = 0;
-    uint32_t sector_map_table_addr = 0;
-    size_t sector_map_table_size = 0;
+    struct sfdp_hdr_info hdr_info;
     spif_bd_error spi_status = SPIF_BD_ERROR_OK;
 
+    memset(&hdr_info, 0, sizeof hdr_info);
+
     _mutex->lock();
 
     if (!_is_initialized) {
@@ -186,15 +186,15 @@ int SPIFBlockDevice::init()
     }
 
     /**************************** Parse SFDP Header ***********************************/
-    if (0 != _sfdp_parse_sfdp_headers(basic_table_addr, basic_table_size, sector_map_table_addr, sector_map_table_size)) {
+    if (0 != _sfdp_parse_sfdp_headers(hdr_info)) {
         tr_error("init - Parse SFDP Headers Failed");
         status = SPIF_BD_ERROR_PARSING_FAILED;
         goto exit_point;
     }
 
 
     /**************************** Parse Basic Parameters Table ***********************************/
-    if (0 != _sfdp_parse_basic_param_table(basic_table_addr, basic_table_size)) {
+    if (0 != _sfdp_parse_basic_param_table(hdr_info.basic_table_addr, hdr_info.basic_table_size)) {
         tr_error("init - Parse Basic Param Table Failed");
         status = SPIF_BD_ERROR_PARSING_FAILED;
         goto exit_point;
@@ -205,10 +205,10 @@ int SPIFBlockDevice::init()
         _device_size_bytes; // If there's no region map, we have a single region sized the entire device size
     _region_high_boundary[0] = _device_size_bytes - 1;
 
-    if ((sector_map_table_addr != 0) && (0 != sector_map_table_size)) {
-        tr_debug("init - Parsing Sector Map Table - addr: 0x%" PRIx32 "h, Size: %d", sector_map_table_addr,
-                 sector_map_table_size);
-        if (0 != _sfdp_parse_sector_map_table(sector_map_table_addr, sector_map_table_size)) {
+    if ((hdr_info.sector_map_table_addr != 0) && (0 != hdr_info.sector_map_table_size)) {
+        tr_debug("init - Parsing Sector Map Table - addr: 0x%" PRIx32 "h, Size: %d", hdr_info.sector_map_table_addr,
+                 hdr_info.sector_map_table_size);
+        if (0 != _sfdp_parse_sector_map_table(hdr_info.sector_map_table_addr, hdr_info.sector_map_table_size)) {
             tr_error("init - Parse Sector Map Table Failed");
             status = SPIF_BD_ERROR_PARSING_FAILED;
             goto exit_point;
@@ -719,73 +719,57 @@ int SPIFBlockDevice::_sfdp_parse_basic_param_table(uint32_t basic_table_addr, si
     return 0;
 }
 
-int SPIFBlockDevice::_sfdp_parse_sfdp_headers(uint32_t &basic_table_addr, size_t &basic_table_size,
-                                              uint32_t &sector_map_table_addr, size_t &sector_map_table_size)
+int SPIFBlockDevice::_sfdp_parse_sfdp_headers(sfdp_hdr_info &hdr_info)
 {
-    uint8_t sfdp_header[16];
-    uint8_t param_header[SPIF_SFDP_HEADER_SIZE];
-    size_t data_length = SPIF_SFDP_HEADER_SIZE;
     bd_addr_t addr = 0x0;
+    int number_of_param_headers = 0;
+    size_t data_length;
 
-    // Set 1-1-1 bus mode for SFDP header parsing
-    // Initial SFDP read tables are read with 8 dummy cycles
-    _read_dummy_and_mode_cycles = 8;
-    _dummy_and_mode_cycles = 8;
-
-    spif_bd_error status = _spi_send_read_command(SPIF_SFDP, sfdp_header, addr /*address*/, data_length);
-    if (status != SPIF_BD_ERROR_OK) {
-        tr_error("init - Read SFDP Failed");
-        return -1;
-    }
-
-    // Verify SFDP signature for sanity
-    // Also check that major/minor version is acceptable
-    if (!(memcmp(&sfdp_header[0], "SFDP", 4) == 0 && sfdp_header[5] == 1)) {
-        tr_error("init - _verify SFDP signature and version Failed");
-        return -1;
-    } else {
-        tr_debug("init - verified SFDP Signature and version Successfully");
-    }
-
-    // Discover Number of Parameter Headers
-    int number_of_param_headers = (int)(sfdp_header[6]) + 1;
-    tr_debug("number of Param Headers: %d", number_of_param_headers);
+    {
+        data_length = SPIF_SFDP_HEADER_SIZE;
+        uint8_t sfdp_header[SPIF_SFDP_HEADER_SIZE];
 
-    addr += SPIF_SFDP_HEADER_SIZE;
-    data_length = SPIF_PARAM_HEADER_SIZE;
-
-    // Loop over Param Headers and parse them (currently supported Basic Param Table and Sector Region Map Table)
-    for (int i_ind = 0; i_ind < number_of_param_headers; i_ind++) {
+        // Set 1-1-1 bus mode for SFDP header parsing
+        // Initial SFDP read tables are read with 8 dummy cycles
+        _read_dummy_and_mode_cycles = 8;
+        _dummy_and_mode_cycles = 8;
 
-        status = _spi_send_read_command(SPIF_SFDP, param_header, addr, data_length);
+        spif_bd_error status = _spi_send_read_command(SPIF_SFDP, sfdp_header, addr /*address*/, data_length);
         if (status != SPIF_BD_ERROR_OK) {
-            tr_error("init - Read Param Table %d Failed", i_ind + 1);
+            tr_error("init - Read SFDP Failed");
             return -1;
         }
 
-        // The SFDP spec indicates the standard table is always at offset 0
-        // in the parameter headers, we check just to be safe
-        if (param_header[2] != 1) {
-            tr_error("Param Table %d - Major Version should be 1!", i_ind + 1);
-            return -1;
+        number_of_param_headers = sfdp_parse_sfdp_header((sfdp_hdr *)sfdp_header);
+        if (number_of_param_headers < 0) {
+            return number_of_param_headers;
         }
+    }
 
-        if ((param_header[0] == 0) && (param_header[7] == 0xFF)) {
-            tr_debug("Parameter Header %d: Basic Parameter Header", i_ind);
-            basic_table_addr = ((param_header[6] << 16) | (param_header[5] << 8) | (param_header[4]));
-            // Supporting up to 64 Bytes Table (16 DWORDS)
-            basic_table_size = ((param_header[3] * 4) < SFDP_DEFAULT_BASIC_PARAMS_TABLE_SIZE_BYTES) ? (param_header[3] * 4) : 64;
+    addr += SPIF_SFDP_HEADER_SIZE;
 
-        } else if ((param_header[0] == 0x81) && (param_header[7] == 0xFF)) {
-            tr_debug("Parameter Header %d: Sector Map Parameter Header", i_ind);
-            sector_map_table_addr = ((param_header[6] << 16) | (param_header[5] << 8) | (param_header[4]));
-            sector_map_table_size = param_header[3] * 4;
+    {
+        data_length = SPIF_PARAM_HEADER_SIZE;
+        uint8_t param_header[SPIF_SFDP_HEADER_SIZE];
+        spif_bd_error status;
+        int hdr_status;
 
-        } else {
-            tr_debug("Parameter Header %d: Vendor specific or unknown header", i_ind);
-        }
-        addr += SPIF_PARAM_HEADER_SIZE;
+        // Loop over Param Headers and parse them (currently supported Basic Param Table and Sector Region Map Table)
+        for (int i_ind = 0; i_ind < number_of_param_headers; i_ind++) {
+
+            status = _spi_send_read_command(SPIF_SFDP, param_header, addr, data_length);
+            if (status != SPIF_BD_ERROR_OK) {
+                tr_error("init - Read Param Table %d Failed", i_ind + 1);
+                return -1;
+            }
 
+            hdr_status = sfdp_parse_single_param_header((sfdp_prm_hdr *)param_header, hdr_info);
+            if (hdr_status < 0) {
+                return hdr_status;
+            }
+
+            addr += SPIF_PARAM_HEADER_SIZE;
+        }
     }
     return 0;
 }

components/storage/blockdevice/COMPONENT_SPIF/SPIFBlockDevice.h

@@ -19,6 +19,7 @@
 #include "platform/SingletonPtr.h"
 #include "drivers/SPI.h"
 #include "drivers/DigitalOut.h"
+#include "drivers/internal/SFDP.h"
 #include "features/storage/blockdevice/BlockDevice.h"
 
 #ifndef MBED_CONF_SPIF_DRIVER_SPI_MOSI
@@ -225,8 +226,7 @@ class SPIFBlockDevice : public mbed::BlockDevice {
     /* SFDP Detection and Parsing Functions */
     /****************************************/
     // Parse SFDP Headers and retrieve Basic Param and Sector Map Tables (if exist)
-    int _sfdp_parse_sfdp_headers(uint32_t &basic_table_addr, size_t &basic_table_size,
-                                 uint32_t &sector_map_table_addr, size_t &sector_map_table_size);
+    int _sfdp_parse_sfdp_headers(mbed::sfdp_hdr_info &hdr_info);
 
     // Parse and Detect required Basic Parameters from Table
     int _sfdp_parse_basic_param_table(uint32_t basic_table_addr, size_t basic_table_size);