Upload block-storage [3062]

.cyignore

@@ -1 +1 @@
-docs
+docs

docs/html/group__group__block__storage.html

@@ -6,7 +6,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 <meta name="generator" content="Doxygen 1.9.2"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Block Storage (block-storage)</title>
+<title>(block-storage)</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
@@ -27,7 +27,7 @@
  <tr style="height: 56px;">
   <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="logo.png"/></a></td>
   <td id="projectalign" style="padding-left: 0.5em;">
-   <div id="projectname">Block Storage (block-storage)</div>
+   <div id="projectname">(block-storage)</div>
   </td>
  </tr>
  </tbody>
@@ -100,28 +100,28 @@ <h1><a class="anchor" id="section_block_storage_getting_started"></a>
 </div><!-- fragment --></li>
 <li>Initialize the block storage device Example initialization using the pre implemented device built on top of HAL NVM <div class="fragment"><div class="line">    <a class="code hl_struct" href="group__group__block__storage.html#structmtb__block__storage__t">mtb_block_storage_t</a> my_nvm_bsd;</div>
 <div class="line">    <a class="code hl_function" href="group__group__block__storage.html#gaf015526bd6a314dbfd78e2d12ad0533d">mtb_block_storage_nvm_create</a>(&amp;my_nvm_bsd);</div>
-<div class="ttc" id="agroup__group__block__storage_html_gaf015526bd6a314dbfd78e2d12ad0533d"><div class="ttname"><a href="group__group__block__storage.html#gaf015526bd6a314dbfd78e2d12ad0533d">mtb_block_storage_nvm_create</a></div><div class="ttdeci">cy_rslt_t mtb_block_storage_nvm_create(mtb_block_storage_t *bsd)</div><div class="ttdoc">Function to create the block storage elements for devices that have HAL support.</div><div class="ttdef"><b>Definition:</b> mtb_block_storage_nvm.c:503</div></div>
-<div class="ttc" id="agroup__group__block__storage_html_structmtb__block__storage__t"><div class="ttname"><a href="group__group__block__storage.html#structmtb__block__storage__t">mtb_block_storage_t</a></div><div class="ttdoc">Block device interface.</div><div class="ttdef"><b>Definition:</b> mtb_block_storage.h:186</div></div>
+<div class="ttc" id="agroup__group__block__storage_html_gaf015526bd6a314dbfd78e2d12ad0533d"><div class="ttname"><a href="group__group__block__storage.html#gaf015526bd6a314dbfd78e2d12ad0533d">mtb_block_storage_nvm_create</a></div><div class="ttdeci">cy_rslt_t mtb_block_storage_nvm_create(mtb_block_storage_t *bsd)</div><div class="ttdoc">Function to create the block storage elements for devices that have HAL support.</div><div class="ttdef"><b>Definition:</b> mtb_block_storage_nvm.c:529</div></div>
+<div class="ttc" id="agroup__group__block__storage_html_structmtb__block__storage__t"><div class="ttname"><a href="group__group__block__storage.html#structmtb__block__storage__t">mtb_block_storage_t</a></div><div class="ttdoc">Block device interface.</div><div class="ttdef"><b>Definition:</b> mtb_block_storage.h:188</div></div>
 </div><!-- fragment --></li>
 <li>The library should now be ready to perform operations.<ul>
 <li>Program operation. <div class="fragment"><div class="line">    uint8_t data[MAX_PROG_SIZE];</div>
 <div class="line">    uint32_t programSize = my_nvm_bsd-&gt;<a class="code hl_variable" href="group__group__block__storage.html#a04052bfa9b52af3b3d5668768cebd98b">get_program_size</a>(my_nvm_bsd-&gt;<a class="code hl_variable" href="group__group__block__storage.html#a27d8bdfefc3b80ef1d8c8307669d5712">context</a>, address);</div>
 <div class="line">    result = my_nvm_bsd-&gt;<a class="code hl_variable" href="group__group__block__storage.html#af846e706b42e31d7950e3a4a75bd14d7">program</a>(my_nvm_bsd-&gt;<a class="code hl_variable" href="group__group__block__storage.html#a27d8bdfefc3b80ef1d8c8307669d5712">context</a>, address, programSize, data);</div>
 <div class="line">    CY_ASSERT(result == CY_RSLT_SUCCESS);</div>
-<div class="ttc" id="agroup__group__block__storage_html_a04052bfa9b52af3b3d5668768cebd98b"><div class="ttname"><a href="group__group__block__storage.html#a04052bfa9b52af3b3d5668768cebd98b">mtb_block_storage_t::get_program_size</a></div><div class="ttdeci">mtb_block_storage_program_size_t get_program_size</div><div class="ttdoc">Function to get program size for an address.</div><div class="ttdef"><b>Definition:</b> mtb_block_storage.h:194</div></div>
-<div class="ttc" id="agroup__group__block__storage_html_a27d8bdfefc3b80ef1d8c8307669d5712"><div class="ttname"><a href="group__group__block__storage.html#a27d8bdfefc3b80ef1d8c8307669d5712">mtb_block_storage_t::context</a></div><div class="ttdeci">void * context</div><div class="ttdoc">Context object that can be used in the block device implementation.</div><div class="ttdef"><b>Definition:</b> mtb_block_storage.h:187</div></div>
-<div class="ttc" id="agroup__group__block__storage_html_af846e706b42e31d7950e3a4a75bd14d7"><div class="ttname"><a href="group__group__block__storage.html#af846e706b42e31d7950e3a4a75bd14d7">mtb_block_storage_t::program</a></div><div class="ttdeci">mtb_block_storage_program_t program</div><div class="ttdoc">Function to program to device.</div><div class="ttdef"><b>Definition:</b> mtb_block_storage.h:205</div></div>
+<div class="ttc" id="agroup__group__block__storage_html_a04052bfa9b52af3b3d5668768cebd98b"><div class="ttname"><a href="group__group__block__storage.html#a04052bfa9b52af3b3d5668768cebd98b">mtb_block_storage_t::get_program_size</a></div><div class="ttdeci">mtb_block_storage_program_size_t get_program_size</div><div class="ttdoc">Function to get program size for an address.</div><div class="ttdef"><b>Definition:</b> mtb_block_storage.h:196</div></div>
+<div class="ttc" id="agroup__group__block__storage_html_a27d8bdfefc3b80ef1d8c8307669d5712"><div class="ttname"><a href="group__group__block__storage.html#a27d8bdfefc3b80ef1d8c8307669d5712">mtb_block_storage_t::context</a></div><div class="ttdeci">void * context</div><div class="ttdoc">Context object that can be used in the block device implementation.</div><div class="ttdef"><b>Definition:</b> mtb_block_storage.h:189</div></div>
+<div class="ttc" id="agroup__group__block__storage_html_af846e706b42e31d7950e3a4a75bd14d7"><div class="ttname"><a href="group__group__block__storage.html#af846e706b42e31d7950e3a4a75bd14d7">mtb_block_storage_t::program</a></div><div class="ttdeci">mtb_block_storage_program_t program</div><div class="ttdoc">Function to program to device.</div><div class="ttdef"><b>Definition:</b> mtb_block_storage.h:207</div></div>
 </div><!-- fragment --></li>
 <li>Read operation. <div class="fragment"><div class="line">    uint8_t read_data[10];</div>
 <div class="line">    result = my_nvm_bsd-&gt;<a class="code hl_variable" href="group__group__block__storage.html#a75886e0eb4c32fb4244bf15d5c521fa7">read</a>(my_nvm_bsd-&gt;<a class="code hl_variable" href="group__group__block__storage.html#a27d8bdfefc3b80ef1d8c8307669d5712">context</a>, address, <span class="keyword">sizeof</span>(read_data), read_data);</div>
 <div class="line">    CY_ASSERT(result == CY_RSLT_SUCCESS);</div>
-<div class="ttc" id="agroup__group__block__storage_html_a75886e0eb4c32fb4244bf15d5c521fa7"><div class="ttname"><a href="group__group__block__storage.html#a75886e0eb4c32fb4244bf15d5c521fa7">mtb_block_storage_t::read</a></div><div class="ttdeci">mtb_block_storage_read_t read</div><div class="ttdoc">Function to read from device.</div><div class="ttdef"><b>Definition:</b> mtb_block_storage.h:204</div></div>
+<div class="ttc" id="agroup__group__block__storage_html_a75886e0eb4c32fb4244bf15d5c521fa7"><div class="ttname"><a href="group__group__block__storage.html#a75886e0eb4c32fb4244bf15d5c521fa7">mtb_block_storage_t::read</a></div><div class="ttdeci">mtb_block_storage_read_t read</div><div class="ttdoc">Function to read from device.</div><div class="ttdef"><b>Definition:</b> mtb_block_storage.h:206</div></div>
 </div><!-- fragment --></li>
 <li>Erase operation. <div class="fragment"><div class="line">    uint32_t eraseSize = my_nvm_bsd-&gt;<a class="code hl_variable" href="group__group__block__storage.html#a55cbb7162d29c1d87ee0f1b011f9f3fa">get_erase_size</a>(my_nvm_bsd-&gt;<a class="code hl_variable" href="group__group__block__storage.html#a27d8bdfefc3b80ef1d8c8307669d5712">context</a>, address);</div>
 <div class="line">    result = my_nvm_bsd-&gt;<a class="code hl_variable" href="group__group__block__storage.html#a1ff632b7d402bc19284f3bc3d55f3ae2">erase</a>(my_nvm_bsd-&gt;<a class="code hl_variable" href="group__group__block__storage.html#a27d8bdfefc3b80ef1d8c8307669d5712">context</a>, address, eraseSize);</div>
 <div class="line">    CY_ASSERT(result == CY_RSLT_SUCCESS);</div>
-<div class="ttc" id="agroup__group__block__storage_html_a1ff632b7d402bc19284f3bc3d55f3ae2"><div class="ttname"><a href="group__group__block__storage.html#a1ff632b7d402bc19284f3bc3d55f3ae2">mtb_block_storage_t::erase</a></div><div class="ttdeci">mtb_block_storage_erase_t erase</div><div class="ttdoc">Function to erase device.</div><div class="ttdef"><b>Definition:</b> mtb_block_storage.h:206</div></div>
-<div class="ttc" id="agroup__group__block__storage_html_a55cbb7162d29c1d87ee0f1b011f9f3fa"><div class="ttname"><a href="group__group__block__storage.html#a55cbb7162d29c1d87ee0f1b011f9f3fa">mtb_block_storage_t::get_erase_size</a></div><div class="ttdeci">mtb_block_storage_erase_size_t get_erase_size</div><div class="ttdoc">Function to get erase size for an address.</div><div class="ttdef"><b>Definition:</b> mtb_block_storage.h:197</div></div>
+<div class="ttc" id="agroup__group__block__storage_html_a1ff632b7d402bc19284f3bc3d55f3ae2"><div class="ttname"><a href="group__group__block__storage.html#a1ff632b7d402bc19284f3bc3d55f3ae2">mtb_block_storage_t::erase</a></div><div class="ttdeci">mtb_block_storage_erase_t erase</div><div class="ttdoc">Function to erase device.</div><div class="ttdef"><b>Definition:</b> mtb_block_storage.h:208</div></div>
+<div class="ttc" id="agroup__group__block__storage_html_a55cbb7162d29c1d87ee0f1b011f9f3fa"><div class="ttname"><a href="group__group__block__storage.html#a55cbb7162d29c1d87ee0f1b011f9f3fa">mtb_block_storage_t::get_erase_size</a></div><div class="ttdeci">mtb_block_storage_erase_size_t get_erase_size</div><div class="ttdoc">Function to get erase size for an address.</div><div class="ttdef"><b>Definition:</b> mtb_block_storage.h:199</div></div>
 </div><!-- fragment --></li>
 </ul>
 </li>
@@ -575,7 +575,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf015526bd6a314dbfd78e2d
 <div id="nav-path" class="navpath">
     <ul>
         <li class="footer">
-            Generated for <b>Block Storage (block-storage)</b> by <b>Cypress Semiconductor Corporation</b>.
+            Generated for <b>(block-storage)</b> by <b>Cypress Semiconductor Corporation</b>.
             All rights reserved.
         </li>
     </ul>

docs/html/index.html

@@ -6,7 +6,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 <meta name="generator" content="Doxygen 1.9.2"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Block Storage (block-storage)</title>
+<title>(block-storage)</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
@@ -27,7 +27,7 @@
  <tr style="height: 56px;">
   <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="logo.png"/></a></td>
   <td id="projectalign" style="padding-left: 0.5em;">
-   <div id="projectname">Block Storage (block-storage)</div>
+   <div id="projectname">(block-storage)</div>
   </td>
  </tr>
  </tbody>
@@ -86,7 +86,7 @@
   <div class="headertitle"><div class="title">Block Storage Library </div></div>
 </div><!--header-->
 <div class="contents">
-<div class="textblock"><p ><a class="anchor" id="md_source_support_block_storage_README_doxygen"></a></p>
+<div class="textblock"><p ><a class="anchor" id="md_output_README_doxygen"></a></p>
 <h1><a class="anchor" id="autotoc_md1"></a>
 Overview</h1>
 <p >This library provides a convenient way to store information in non-volatile storage.</p>
@@ -176,7 +176,7 @@ <h1><a class="anchor" id="autotoc_md8"></a>
 <div id="nav-path" class="navpath">
     <ul>
         <li class="footer">
-            Generated for <b>Block Storage (block-storage)</b> by <b>Cypress Semiconductor Corporation</b>.
+            Generated for <b>(block-storage)</b> by <b>Cypress Semiconductor Corporation</b>.
             All rights reserved.
         </li>
     </ul>

docs/html/modules.html

@@ -6,7 +6,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 <meta name="generator" content="Doxygen 1.9.2"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Block Storage (block-storage)</title>
+<title>(block-storage)</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
@@ -27,7 +27,7 @@
  <tr style="height: 56px;">
   <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="logo.png"/></a></td>
   <td id="projectalign" style="padding-left: 0.5em;">
-   <div id="projectname">Block Storage (block-storage)</div>
+   <div id="projectname">(block-storage)</div>
   </td>
  </tr>
  </tbody>
@@ -97,7 +97,7 @@
 <div id="nav-path" class="navpath">
     <ul>
         <li class="footer">
-            Generated for <b>Block Storage (block-storage)</b> by <b>Cypress Semiconductor Corporation</b>.
+            Generated for <b>(block-storage)</b> by <b>Cypress Semiconductor Corporation</b>.
             All rights reserved.
         </li>
     </ul>

docs/html/navtreedata.js

@@ -24,7 +24,7 @@
 */
 var NAVTREE =
 [
-  [ "Block Storage (block-storage)", "index.html", [
+  [ "(block-storage)", "index.html", [
     [ "Block Storage Library", "index.html", [
       [ "Overview", "index.html#autotoc_md1", null ],
       [ "Features", "index.html#autotoc_md2", null ],

mtb_block_storage.h → include/mtb_block_storage.h

@@ -23,6 +23,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  **************************************************************************************************/
+#pragma once
 
 
 #include "cy_result.h"
@@ -39,7 +40,8 @@
     CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_ABSTRACTION_BLOCK_STORAGE, 3)
 
 //Only limit support for non blocking functionality to PSoC6 for the moment
-#if (defined(COMPONENT_CAT1A) && !defined(CY_DEVICE_TVIIBE))
+#if (defined(COMPONENT_CAT1A) && !defined(CY_DEVICE_TVIIBE)) && \
+    !defined(MTB_HAL_DRIVER_AVAILABLE_NVM)
 #define MTB_BLOCK_STORAGE_NON_BLOCKING_SUPPORTED
 #endif
 /**

props.json

@@ -2,6 +2,6 @@
     "core": {
         "id": "de8de308-fe93-5eb5-b140-70ee6ac997f0",
         "name": "block-storage",
-        "version": "1.1.0.42993"
+        "version": "1.2.0.19"
     }
 }

mtb_block_storage_nvm.c → source/mtb_block_storage_nvm.c

@@ -26,13 +26,17 @@
  **************************************************************************************************/
 #if !defined(COMPONENT_CAT2)
 #include "mtb_block_storage.h"
+#if defined(CY_USING_HAL) || defined(CY_USING_HAL_LITE)
 #include "cyhal.h"
 #if (CYHAL_DRIVER_AVAILABLE_NVM)
 #include "cyhal_nvm.h"
 #else // if (CYHAL_DRIVER_AVAILABLE_NVM)
 #include "cyhal_flash.h"
 #endif // if (CYHAL_DRIVER_AVAILABLE_NVM)
 
+
+#define MTB_HAL_NVM_TYPE_RRAM  CYHAL_NVM_TYPE_RRAM
+
 #if (CYHAL_DRIVER_AVAILABLE_NVM)
 typedef cyhal_nvm_region_info_t mtb_block_storage_nvm_region_info_t;
 typedef cyhal_nvm_t             mtb_block_storage_nvm_t;
@@ -105,6 +109,22 @@ const mtb_block_storage_nvm_region_info_t* mtb_block_storage_nvm_get_region_for_
 }
 
 
+#else // if defined(CY_USING_HAL) || defined(CY_USING_HAL_LITE)
+
+
+#include "mtb_hal.h"
+
+typedef mtb_hal_nvm_region_info_t mtb_block_storage_nvm_region_info_t;
+typedef mtb_hal_nvm_t             mtb_block_storage_nvm_t;
+typedef mtb_hal_nvm_info_t        mtb_block_storage_nvm_info_t;
+
+/** Deprecated, for backwards compatibility */
+#define mtb_block_storage_nvm_get_region_for_address mtb_hal_nvm_get_region_for_address
+
+#define MTB_BLOCK_STORAGE_NVM_SUPPORT
+
+#endif // if defined(CY_USING_HAL) || defined(CY_USING_HAL_LITE)
+
 mtb_block_storage_nvm_t obj;
 
 #if (CPUSS_FLASHC_ECT == 1)
@@ -148,7 +168,7 @@ static uint32_t mtb_block_storage_nvm_program_size(void* context, uint32_t addr)
         //For this reason we need to select different measures for this function based on the
         // memory type.
         #if defined(MTB_BLOCK_STORAGE_NVM_SUPPORT)
-        if (region_info->nvm_type == CYHAL_NVM_TYPE_RRAM)
+        if (region_info->nvm_type == MTB_HAL_NVM_TYPE_RRAM)
         {
             programSize = (region_info->block_size);
         }
@@ -181,7 +201,7 @@ static uint32_t mtb_block_storage_nvm_erase_size(void* context, uint32_t addr)
         //For this reason we need to select different measures for this function based on the
         //memory type.
         #if defined(MTB_BLOCK_STORAGE_NVM_SUPPORT)
-        if (region_info->nvm_type == CYHAL_NVM_TYPE_RRAM)
+        if (region_info->nvm_type == MTB_HAL_NVM_TYPE_RRAM)
         {
             eraseSize = (region_info->block_size);
         }
@@ -222,7 +242,9 @@ static uint8_t mtb_block_storage_nvm_erase_value(void* context, uint32_t addr)
 static cy_rslt_t mtb_block_storage_nvm_read(void* context, uint32_t addr, uint32_t length,
                                             uint8_t* buf)
 {
-    #if (CYHAL_DRIVER_AVAILABLE_NVM)
+    #if (MTB_HAL_DRIVER_AVAILABLE_NVM)
+    return mtb_hal_nvm_read((mtb_hal_nvm_t*)context, addr, buf, length);
+    #elif (CYHAL_DRIVER_AVAILABLE_NVM)
     return cyhal_nvm_read((cyhal_nvm_t*)context, addr, buf, length);
     #else // if (CYHAL_DRIVER_AVAILABLE_NVM)
     return cyhal_flash_read((cyhal_flash_t*)context, addr, buf, length);
@@ -252,7 +274,9 @@ static cy_rslt_t mtb_block_storage_nvm_program(void* context, uint32_t addr, uin
             #if (CPUSS_FLASHC_ECT == 1)
             result = WorkFlashProgramRow((uint32_t*)addr, (const uint32_t*)buf, prog_size);
             #else // if (CPUSS_FLASHC_ECT == 1)
-            #if (CYHAL_DRIVER_AVAILABLE_NVM)
+            #if (MTB_HAL_DRIVER_AVAILABLE_NVM)
+            result = mtb_hal_nvm_program((mtb_hal_nvm_t*)context, loc, (const uint32_t*)buf);
+            #elif (CYHAL_DRIVER_AVAILABLE_NVM)
             result = cyhal_nvm_program((cyhal_nvm_t*)context, loc, (const uint32_t*)buf);
             #else // if (CYHAL_DRIVER_AVAILABLE_NVM)
             result = cyhal_flash_program((cyhal_flash_t*)context, loc, (const uint32_t*)buf);
@@ -384,7 +408,9 @@ static cy_rslt_t mtb_block_storage_nvm_erase(void* context, uint32_t addr, uint3
         for (uint32_t loc = addr; result == CY_RSLT_SUCCESS && loc < addr + length;
              loc += erase_size)
         {
-            #if (CYHAL_DRIVER_AVAILABLE_NVM)
+            #if (MTB_HAL_DRIVER_AVAILABLE_NVM)
+            result = mtb_hal_nvm_erase((mtb_hal_nvm_t*)context, loc);
+            #elif (CYHAL_DRIVER_AVAILABLE_NVM)
             result = cyhal_nvm_erase((cyhal_nvm_t*)context, loc);
             #else // if (CYHAL_DRIVER_AVAILABLE_NVM)
             result = cyhal_flash_erase((cyhal_flash_t*)context, loc);
@@ -509,6 +535,7 @@ cy_rslt_t mtb_block_storage_nvm_create(mtb_block_storage_t* bsd)
         result = MTB_BLOCK_STORAGE_INVALID_INPUT_ERROR;
     }
 
+    #if !defined(MTB_HAL_DRIVER_AVAILABLE_NVM)
     if (result == CY_RSLT_SUCCESS)
     {
         #if (CYHAL_DRIVER_AVAILABLE_NVM)
@@ -517,6 +544,7 @@ cy_rslt_t mtb_block_storage_nvm_create(mtb_block_storage_t* bsd)
         result = cyhal_flash_init(&obj);
         #endif // (CYHAL_DRIVER_AVAILABLE_NVM)
     }
+    #endif // !defined(MTB_HAL_DRIVER_AVAILABLE_NVM)
 
     if (result == CY_RSLT_SUCCESS)
     {
@@ -533,6 +561,7 @@ cy_rslt_t mtb_block_storage_nvm_create(mtb_block_storage_t* bsd)
         bsd->is_erase_required = mtb_block_storage_nvm_is_erase_required;
         bsd->context = &obj;
     }
+    #if !defined(MTB_HAL_DRIVER_AVAILABLE_NVM)
     else
     {
         #if (CYHAL_DRIVER_AVAILABLE_NVM)
@@ -541,7 +570,7 @@ cy_rslt_t mtb_block_storage_nvm_create(mtb_block_storage_t* bsd)
         cyhal_flash_free(&obj);
         #endif
     }
-
+    #endif // !defined(MTB_HAL_DRIVER_AVAILABLE_NVM)
     return result;
 }