@mchp-mcc/dspic33a-flash 1.0.5 → 1.0.7

package/output/flash-a-core-ftl/flash.c.ftl

@@ -37,6 +37,11 @@ enum FLASH_PROGRAM_ERASE_ERROR_CODE {
 // Section: Driver Interface
 const struct ${moduleNameUpperCase}_INTERFACE flash = {
     .PageErase = FLASH_PageErase,
+    <#if flashHasDualPartition == true>
+    .BulkErase = FLASH_BulkErase,
+    <#else>
+    .BulkErase = NULL,
+    </#if>
     .Write = FLASH_WordWrite,
     <#if flashHasRowProgramming == 1>
     .RowWrite = FLASH_RowWrite,
@@ -77,11 +82,35 @@ enum FLASH_RETURN_STATUS ${moduleNameUpperCase}_PageErase(flash_adr_t flashAddre
         ${nvmControlRegister} = FLASH_PAGE_ERASE_OPCODE;
         ${nvmControlRegister}bits.WR = 1U;
         while(1U == ${nvmControlRegister}bits.WR){};
+        ${nvmControlRegister}bits.WREN = 0U;
 
         flashReturnStatus = getProgramEraseErrorCode();
     }
     return flashReturnStatus;
 }
+<#if flashHasDualPartition == true>
+enum FLASH_RETURN_STATUS ${moduleNameUpperCase}_BulkErase(enum FLASH_PANEL panel, flash_key_t unlockKey)
+{
+    enum FLASH_RETURN_STATUS flashReturnStatus = FLASH_NO_ERROR;
+    if(unlockKey != (flash_key_t)FLASH_UNLOCK_KEY)
+    {
+        flashReturnStatus = FLASH_INVALID_KEY;
+    }
+    else if ((panel < 1U) || (panel >= FLASH_PANEL_MAX_PANELS))
+    {
+        flashReturnStatus = FLASH_INVALID_ADDRESS;
+    }
+    else
+    {
+        ${nvmControlRegister} = FLASH_INACTIVE_PARTITION_ERASE_OPCODE;
+        ${nvmControlRegister}bits.WR = 1U;
+        while(1U == ${nvmControlRegister}bits.WR){};
+        ${nvmControlRegister}bits.WREN = 0U;
+        flashReturnStatus = getProgramEraseErrorCode();
+    }
+    return flashReturnStatus;
+}
+</#if>
 
 enum FLASH_RETURN_STATUS ${moduleNameUpperCase}_WordWrite(flash_adr_t flashAddress, flash_data_t *data, flash_key_t unlockKey)
 {
@@ -110,6 +139,7 @@ enum FLASH_RETURN_STATUS ${moduleNameUpperCase}_WordWrite(flash_adr_t flashAddre
 
         ${nvmControlRegister}bits.WR = 1U;
         while (1U == ${nvmControlRegister}bits.WR){};
+        ${nvmControlRegister}bits.WREN = 0U;
 
         flashReturnStatus = getProgramEraseErrorCode();
     }
@@ -140,6 +170,7 @@ enum FLASH_RETURN_STATUS  ${moduleNameUpperCase}_RowWrite(flash_adr_t flashAddre
 
         ${nvmControlRegister}bits.WR = 1U;
         while (1U == ${nvmControlRegister}bits.WR){};
+        ${nvmControlRegister}bits.WREN = 0U;
 
         flashReturnStatus = getProgramEraseErrorCode();
     }

package/output/flash-a-core-ftl/flash.h.ftl

@@ -53,6 +53,23 @@ extern const struct ${moduleNameUpperCase}_INTERFACE flash;
  */
 enum FLASH_RETURN_STATUS ${moduleNameUpperCase}_PageErase(flash_adr_t flashAddress, flash_key_t unlockKey);
 
+<#if flashHasDualPartition == true>
+/**
+ * @ingroup ${moduleNameLowerCase}driver
+ * @brief This function erases a partition (most of the devices support only inactive panel erase).
+ * @param[in]  panel : Flash Panel ( 0 = active panel , 1 = inactive panel)
+ * @param[in]  unlockKey : Flash unlock key
+ * @return  FLASH_RETURN_STATUS: returns FLASH_NO_ERROR if operation is successful , else returns errors like FLASH_INVALID_ADDRESS, FLASH_WRITE_ERROR
+<#if functionHeaderExample == true>
+ *
+ * @b Example:
+ * @code
+ *    FLASH_RETURN_STATUS status = ${moduleNameUpperCase}_BulkeErase(panel, unlockKey);
+ * @endcode
+</#if>
+ */
+enum FLASH_RETURN_STATUS ${moduleNameUpperCase}_BulkErase(enum FLASH_PANEL panel, flash_key_t unlockKey);
+</#if>
 
 /**
  * @ingroup ${moduleNameLowerCase}driver

package/output/flash-a-core-ftl/flash_interface.h.ftl

@@ -40,6 +40,8 @@ struct ${moduleNameUpperCase}_INTERFACE
 {
     enum FLASH_RETURN_STATUS (*PageErase)(flash_adr_t address, flash_key_t unlockKey);
     ///< Pointer to FLASH_PageErase e.g. \ref FLASH_PageErase
+    enum FLASH_RETURN_STATUS (*BulkErase)(enum FLASH_PANEL panel, flash_key_t unlockKey);
+    ///< Pointer to FLASH_BulkErase e.g. \ref FLASH_BulkErase
 
     enum FLASH_RETURN_STATUS (*Write)(flash_adr_t address, flash_data_t* data, flash_key_t unlockKey);
     ///< Pointer to FLASH_WordWrite e.g. \ref FLASH_WordWrite

package/output/flash-a-core-ftl/flash_nonblocking.c.ftl

@@ -43,6 +43,11 @@ static bool lock = false;
 const struct ${moduleNameUpperCase}_INTERFACE flash = {
     <#if generateBlockingAPI == true>
     .PageErase = FLASH_PageErase,
+    <#if flashHasDualPartition == true>
+    .BulkErase = FLASH_BulkErase,
+    <#else>
+    .BulkErase == NULL,
+    </#if>
     .Read = FLASH_Read,
     .Write = FLASH_WordWrite,
     <#if flashHasRowProgramming == 1>
@@ -55,7 +60,11 @@ const struct ${moduleNameUpperCase}_INTERFACE flash = {
     .PageOffsetGet = FLASH_ErasePageOffsetGet,
     <#if interruptDriven == true>
     .NonBlockingPageErase = FLASH_NonBlockingPageErase,
+    <#if flashHasDualPartition == true>
+    .NonBlockingBulkErase = FLASH_NonBlockingBulkErase,
+    <#else>
     .NonBlockingBulkErase = NULL,
+    </#if>
     .NonBlockingRead = FLASH_NonBlockingRead,
     .NonBlockingWordWrite = FLASH_NonBlockingWordWrite,
     <#if flashHasRowProgramming == 1>
@@ -75,7 +84,11 @@ const struct ${moduleNameUpperCase}_INTERFACE flash = {
     .NonBlockingWordWrite = NULL,
     .NonBlockingRowWrite = NULL,
     .NonBlockingPolledPageErase = FLASH_NonBlockingPolledPageErase,
+    <#if flashHasDualPartition == true>
+    .NonBlockingPolledBulkErase = FLASH_NonBlockingPolledBulkErase,
+    <#else>
     .NonBlockingPolledBulkErase = NULL,
+    </#if>
     .NonBlockingPolledRead = FLASH_NonBlockingPolledRead,
     .NonBlockingPolledWordWrite = FLASH_NonBlockingPolledWordWrite,
     <#if flashHasRowProgramming == 1>
@@ -100,8 +113,28 @@ void FLASH_Initialize(void)
 
 <#if interruptDriven == true>
 <#if isFlashContextSupported>
+<#if suppressMisraWarning == true>
+/* cppcheck-suppress misra-c2012-8.4
+*
+* (Rule 8.4) REQUIRED: A compatible declaration shall be visible when an object or 
+* function with external linkage is defined
+*
+* Reasoning: Interrupt declaration are provided by compiler and are available
+* outside the driver folder
+*/
+</#if>
 void __attribute__ ( ( interrupt, context ) ) ${flashIsrHandlerName}(void)
 <#else>
+<#if suppressMisraWarning == true>
+/* cppcheck-suppress misra-c2012-8.4
+*
+* (Rule 8.4) REQUIRED: A compatible declaration shall be visible when an object or 
+* function with external linkage is defined
+*
+* Reasoning: Interrupt declaration are provided by compiler and are available
+* outside the driver folder
+*/
+</#if>
 void __attribute__ ( ( interrupt ) ) ${flashIsrHandlerName}(void)
 </#if>
 {
@@ -202,6 +235,49 @@ enum FLASH_RETURN_STATUS FLASH_NonBlockingPolledPageErase(flash_adr_t flashAddre
     }
     return flashReturnStatus;
 }
+<#if flashHasDualPartition == true>
+<#if interruptDriven == true>
+enum FLASH_RETURN_STATUS FLASH_NonBlockingBulkErase(enum FLASH_PANEL panel, flash_key_t unlockKey, FLASH_CALLBACK callbackHandler, void* context)
+<#else>
+enum FLASH_RETURN_STATUS FLASH_NonBlockingPolledBulkErase(enum FLASH_PANEL panel, flash_key_t unlockKey)
+</#if>
+{
+    enum FLASH_RETURN_STATUS flashReturnStatus = FLASH_OP_IN_PROGRESS;
+    if(false == lock)
+    {
+        if(unlockKey != (flash_key_t)FLASH_UNLOCK_KEY)
+        {
+            flashReturnStatus = FLASH_INVALID_KEY;
+        }
+        if ((panel < 1U) || (panel >= FLASH_PANEL_MAX_PANELS))
+        {
+            flashReturnStatus = FLASH_INVALID_ADDRESS;
+        }
+        <#if interruptDriven == true>
+        else if(NULL == callbackHandler)
+        {
+            flashReturnStatus  = FLASH_INVALID_CALLBACK_HANDLER;
+        }
+        </#if>
+        else if(0U != ${nvmControlRegister}bits.WR)
+        {
+            flashReturnStatus = FLASH_OP_BUSY;
+        }
+        else
+        {
+            <#if interruptDriven == true>
+            userCallbackHandler = callbackHandler;
+            userContext = context;
+            </#if>
+            lock = true;
+            ${nvmControlRegister} = FLASH_INACTIVE_PARTITION_ERASE_OPCODE;
+            ${nvmControlRegister}bits.WR = 1U;
+            lock = false;
+        }
+    }
+    return flashReturnStatus;
+}
+</#if>
 
 
 <#if interruptDriven == true>

package/output/flash-a-core-ftl/flash_nonblocking.h.ftl

@@ -104,6 +104,49 @@ enum FLASH_RETURN_STATUS FLASH_NonBlockingPageErase(flash_adr_t flashAddress, fl
 enum FLASH_RETURN_STATUS FLASH_NonBlockingPolledPageErase(flash_adr_t flashAddress, flash_key_t unlockKey);
 </#if>
 
+<#if flashHasDualPartition == true>
+<#if interruptDriven == true>
+/**
+ * @ingroup ${moduleNameLowerCase}driver
+ * @brief This function erases a partition (most of the devices support only inactive panel erase).
+ * @param[in]  panel : Flash Panel ( 0 = active panel , 1 = inactive panel)
+ * @param[in]  unlockKey : Flash unlock key
+ * @param[in]  callbackHandler : Pointer to call back handler
+ * @param[in]  context : Optional pointer to context to handle user contexts
+ * @return  FLASH_RETURN_STATUS: returns FLASH_NO_ERROR if operation is successful, if the operation is in progress then it returns FLASH_OP_IN_PROGRESS,
+ *          if there is a previous operation in progress then it returns FLASH_OP_BUSY , in case of any unsuccessful operation  it returns errors like
+ *          FLASH_INVALID_ADDRESS, FLASH_INVALID_CALLBACK_HANDLER, FLASH_WRITE_ERROR
+<#if functionHeaderExample == true>
+ *
+ * @b Example:
+ * @code
+ *    FLASH_RETURN_STATUS status = FLASH_NonBlockingBulkErase(panel, unlockKey, callbackHandler, context);
+ * @endcode
+</#if>
+ */
+enum FLASH_RETURN_STATUS FLASH_NonBlockingBulkErase(enum FLASH_PANEL panel, flash_key_t unlockKey, FLASH_CALLBACK callbackHandler, void* context);
+<#else>
+/**
+ * @ingroup ${moduleNameLowerCase}driver
+ * @brief his function erases a partition (most of the devices support only inactive panel erase).
+ * @param[in]  panel : Flash Panel ( 0 = active panel , 1 = inactive panel)
+ * @param[in]  unlockKey : Flash unlock key
+ * @return  FLASH_RETURN_STATUS : returns FLASH_NO_ERROR if operation is successful, if the operation is in progress then it returns FLASH_OP_IN_PROGRESS,
+ *          if there is a previous operation in progress then it returns FLASH_OP_BUSY , in case of any unsuccessful operation  it returns errors like
+ *          FLASH_INVALID_ADDRESS, FLASH_WRITE_ERROR
+ * This function locks flash operations to prevent multiple access. Make sure to call FLASH_OperationStatusGet() after calling FLASH_NonBlockingPolledPageErase() to release the lock.
+<#if functionHeaderExample == true>
+ *
+ * @b Example:
+ * @code
+ *    FLASH_RETURN_STATUS status = FLASH_NonBlockingPolledBulkErase(panel, unlockKey);
+      while (FLASH_OperationStatusGet() == FLASH_OP_BUSY);
+ * @endcode
+</#if>
+ */
+enum FLASH_RETURN_STATUS FLASH_NonBlockingPolledBulkErase(enum FLASH_PANEL panel, flash_key_t unlockKey);
+</#if>
+</#if>
 <#if interruptDriven == true>
 /**
  * @ingroup flashdriver

package/output/flash-a-core-ftl/flash_types.h.ftl

@@ -46,6 +46,13 @@ ${disclaimer}
  @brief    Defines ${moduleNameUpperCase} word write opcode
 */
 #define  FLASH_ROW_WRITE_OPCODE  ${flashRowWriteOpcode}
+<#if flashHasDualPartition == true>
+/**
+ @ingroup  ${moduleNameLowerCase}driver
+ @brief    Defines ${moduleNameUpperCase} inactive partition erase opcode
+*/
+#define  FLASH_INACTIVE_PARTITION_ERASE_OPCODE  ${flashOpcodeInactivePartitionErase}
+</#if>
 /**
  @ingroup  ${moduleNameLowerCase}driver
  @brief    Defines ${moduleNameUpperCase} flash page size