Create canonical CyReservedRegionBlockDevice for working with/around Cypress WiFi firmware in external memory

This change allows external memory to be used for other purposes while
the WiFi firmware is stored in it by interacting with it via the
reserved region block device.

Author: Matthew Macovsky

connectivity/drivers/emac/TARGET_Cypress/COMPONENT_WHD/interface/whd_emac.cpp

@@ -27,10 +27,15 @@
 #include "events/mbed_shared_queues.h"
 #include "whd_wlioctl.h"
 #include "whd_buffer_api.h"
+#include "wiced_resource.h"
 #include "cybsp_wifi.h"
 #include "emac_eapol.h"
 #include "cy_result.h"
 
+#if defined(CY_EXT_WIFI_FW_STORAGE) && !MBED_CONF_TARGET_XIP_ENABLE
+#include "cy_ext_wifi_fw_reserved_region_bd.h"
+#endif /* defined(CY_EXT_WIFI_FW_STORAGE) && !MBED_CONF_TARGET_XIP_ENABLE */
+
 #define NULL_MAC(a)  ( ( ( ( (unsigned char *)a )[0] ) == 0 ) && \
                        ( ( ( (unsigned char *)a )[1] ) == 0 ) && \
                        ( ( ( (unsigned char *)a )[2] ) == 0 ) && \
@@ -112,7 +117,17 @@ bool WHD_EMAC::power_up()
             WHD_EMAC &emac_other = WHD_EMAC::get_instance(interface_type == WHD_STA_ROLE ? WHD_AP_ROLE :
                                                           WHD_STA_ROLE);
             if (!emac_other.powered_up) {
+#if defined(CY_EXT_WIFI_FW_STORAGE) && !MBED_CONF_TARGET_XIP_ENABLE
+                CyReservedRegionBlockDevice *reserved_region_bd = cy_get_ext_wifi_fw_reserved_region_bd();
+                reserved_region_bd->init();
+
+                extern whd_resource_source_t cy_ext_wifi_fw_resource_ops;
+                res = cybsp_wifi_init_primary_extended(&ifp /* OUT */, &cy_ext_wifi_fw_resource_ops, NULL, NULL);
+
+                reserved_region_bd->deinit();
+#else
                 res = cybsp_wifi_init_primary(&ifp /* OUT */);
+#endif /* defined(CY_EXT_WIFI_FW_STORAGE) && !MBED_CONF_TARGET_XIP_ENABLE */
             } else {
                 ifp = emac_other.ifp;
             }
@@ -295,4 +310,13 @@ extern "C"
         }
     }
 
+#if defined(CY_EXT_WIFI_FW_STORAGE) && !MBED_CONF_TARGET_XIP_ENABLE
+    resource_result_t platform_read_external_resource(const resource_hnd_t *resource, uint32_t offset, uint32_t maxsize, uint32_t *size, void *buffer)
+    {
+        CyReservedRegionBlockDevice *bd = cy_get_ext_wifi_fw_reserved_region_bd();
+        int status = bd->reserved_read(buffer, (mbed::bd_addr_t) resource->val.external_storage_context + offset, *size);
+        return (status == 0) ? RESOURCE_SUCCESS : RESOURCE_FILE_READ_FAIL;
+    }
+#endif /* defined(CY_EXT_WIFI_FW_STORAGE) && !MBED_CONF_TARGET_XIP_ENABLE */
+
 } // extern "C"

targets/TARGET_Cypress/TARGET_PSOC6/common/ext-wifi-fw/cy_ext_wifi_fw_reserved_region_bd.cpp

@@ -0,0 +1,89 @@
+/***************************************************************************//**
+* \file cy_ext_wifi_fw_reserved_region_bd.cpp
+*
+* \brief
+* Block device use to interact with external memory without interfering with
+* the region reserved for the WiFi firmware.
+*
+* Creates a canonical instance that can be accessed via cy_get_ext_wifi_fw_reserved_region_bd().
+* Provides overrides for Mbed OS functions so that storage mechanisms such as KVStore
+* will default to using this block device.
+*
+********************************************************************************
+* \copyright
+* Copyright 2020 Cypress Semiconductor Corporation
+* 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.
+*******************************************************************************/
+
+// Use of xip-enable by user overrides definition of CY_EXT_WIFI_FW_STORAGE in target configuration
+#if defined(CY_EXT_WIFI_FW_STORAGE) && !MBED_CONF_TARGET_XIP_ENABLE
+
+#include "cy_ext_wifi_fw_reserved_region_bd.h"
+#include "cy_wifi_fw_section.h"
+#include "QSPIFBlockDevice.h"
+
+BlockDevice *cy_get_ext_wifi_fw_reserved_region_underlying_bd()
+{
+#if CY_EXT_WIFI_FW_STORAGE == QSPIF
+    static QSPIFBlockDevice underlying_bd;
+#else
+#error "Invalid WiFi storage type"
+#endif
+
+    return &underlying_bd;
+}
+
+CyReservedRegionBlockDevice *cy_get_ext_wifi_fw_reserved_region_bd()
+{
+    BlockDevice *underlying_bd = cy_get_ext_wifi_fw_reserved_region_underlying_bd();
+    static CyReservedRegionBlockDevice default_instance(underlying_bd, (mbed::bd_addr_t) CY_WIFI_FW_SECTION_END - (mbed::bd_addr_t) CY_WIFI_FW_SECTION_START);
+    return &default_instance;
+}
+
+extern "C" {
+extern void cy_ext_wifi_fw_resources_update_handles(void *image_addr, unsigned long image_size, void *clm_blob_addr, unsigned long clm_blob_size);
+}
+
+int cy_update_ext_wifi_fw_location_and_size(mbed::bd_addr_t image_addr, mbed::bd_size_t image_size, mbed::bd_addr_t clm_blob_addr, mbed::bd_size_t clm_blob_size)
+{
+    CyReservedRegionBlockDevice *bd = cy_get_ext_wifi_fw_reserved_region_bd();
+    // If the reserved region end is NULL, the block device hasn't been initialized yet, so we can't perform this check
+    if ((bd->reserved_region_end() != 0) && (image_addr + image_size > bd->reserved_region_end() || clm_blob_addr + clm_blob_size > bd->reserved_region_end()))
+    {
+        // Should not exceed originally computed reserved region size, as this will break anything that was using the rest of external storage
+        return -1;
+    }
+
+    // These addresses are not valid pointers, but are converted to pointers so as to be used with the WHD resource handles
+    cy_ext_wifi_fw_resources_update_handles((void *) image_addr, image_size, (void *) clm_blob_addr, clm_blob_size);
+
+    return 0;
+}
+
+//
+// Overrides for other Mbed OS storage mechanisms to that this is the default block device
+//
+
+BlockDevice *get_other_blockdevice()
+{
+    return cy_get_ext_wifi_fw_reserved_region_bd();
+}
+
+BlockDevice *BlockDevice::get_default_instance()
+{
+    return cy_get_ext_wifi_fw_reserved_region_bd();
+}
+
+#endif /* defined(CY_EXT_WIFI_FW_STORAGE) && !MBED_CONF_TARGET_XIP_ENABLE */

targets/TARGET_Cypress/TARGET_PSOC6/common/ext-wifi-fw/cy_ext_wifi_fw_reserved_region_bd.h

@@ -0,0 +1,90 @@
+/***************************************************************************//**
+* \file cy_ext_wifi_fw_reserved_region_bd.h
+*
+* \brief
+* Block device use to interact with external memory without interfering with
+* the region reserved for the WiFi firmware.
+*
+* Creates a canonical instance that can be accessed via cy_get_ext_wifi_fw_reserved_region_bd().
+* Provides overrides for Mbed OS functions so that storage mechanisms such as KVStore
+* will default to using this block device.
+*
+* See cy_get_ext_wifi_fw_reserved_region_bd() for more details.
+*
+********************************************************************************
+* \copyright
+* Copyright 2020 Cypress Semiconductor Corporation
+* 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 CY_EXT_WIFI_FW_RESERVED_REGION_BD_H
+#define CY_EXT_WIFI_FW_RESERVED_REGION_BD_H
+
+// Use of xip-enable by user overrides definition of CY_EXT_WIFI_FW_STORAGE in target configuration
+#if defined(CY_EXT_WIFI_FW_STORAGE) && !MBED_CONF_TARGET_XIP_ENABLE
+
+#include "CyReservedRegionBlockDevice.h"
+
+/**
+ * Get the canonical instance of the underlying block device used by the canonical
+ * CyReservedRegionBlockDevice instance (retrieved via cy_get_ext_wifi_fw_reserved_region_bd()).
+ * Uses the macro CY_EXT_WIFI_FW_STORAGE to determine the type of the underlying block device.
+ * Valid values of CY_EXT_WIFI_FW_STORAGE are: QSPIF.
+ *
+ * @return A pointer to the canonical instance of the underlying block device
+ */
+BlockDevice *cy_get_ext_wifi_fw_reserved_region_underlying_bd();
+
+/**
+ * Get the canonical instance of the block device used for interacting with external memory
+ * without interfering with the region reserved for the WiFi firmware.
+ *
+ * This block device and the overrides that use it will only be defined if the macro CY_EXT_WIFI_FW_STORAGE is defined.
+ * If it is, then its value is used by to determine the default block device for accessing
+ * the external storage where the WiFi firmware is located.
+ * See cy_get_ext_wifi_fw_reserved_region_underlying_bd() for more details.
+ *
+ * In order to store the WiFi firmware in external storage at all, the macro CY_ENABLE_XIP_PROGRAM must be defined.
+ * Further, the macro CY_STORAGE_WIFI_DATA must be set to the name of the input section where the WiFi firmware is
+ * to be placed, with surrounding quotation marks. The macro CY_STORAGE_WIFI_DATA_OUTPUT must be set to the name of the
+ * output section that the linker script places the input section in, without quotation marks. The name of this output
+ * section must not contain a '.' character.
+ *
+ * Using XIP by adding the xip-enable configuration override will prevent any of this from begin defined.
+ *
+ * @return A pointer to the canonical instance of the block device
+ */
+CyReservedRegionBlockDevice *cy_get_ext_wifi_fw_reserved_region_bd();
+
+/**
+ * Modify the location and size of the WiFi firmware image/CLM blob.
+ *
+ * If the WiFi firmware is ever updated, this function must be called afterward as well as
+ * on every startup as long as the updated firmware continues to be used.
+ * The defaults are the initial locations and sizes on compilation.
+ * New firmware end should not exceed the initial end of the WiFi firmware output section
+ * so that storage mechanisms keep a consistent storage region.
+ *
+ * @param image_addr[in]    New address of the WiFi firmware image
+ * @param image_size[in]    New size of the WiFi firmware image
+ * @param clm_blob_addr[in] New address of the CLM blob
+ * @param clm_blob_size[in] New size of the CLM blob
+ * @return 0 on success, negative on failure
+ */
+int cy_update_ext_wifi_fw_location_and_size(mbed::bd_addr_t image_addr, mbed::bd_size_t image_size, mbed::bd_addr_t clm_blob_addr, mbed::bd_size_t clm_blob_size);
+
+#endif /* defined(CY_EXT_WIFI_FW_STORAGE) && !MBED_CONF_TARGET_XIP_ENABLE */
+
+#endif /* CY_EXT_WIFI_FW_RESERVED_REGION_BD_H */