@mchp-mcc/dspic33a-flash 1.0.1

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

@@ -0,0 +1,217 @@
+<#assign headerFiles = interfaceApi.interfaceApi.headerFiles>
+/**
+ * ${moduleNameUpperCase} Generated Driver Source File
+ *
+ * @file      ${moduleNameLowerCase}.c
+ *
+ * @ingroup   ${moduleNameLowerCase}driver
+ *
+ * @brief     This is the generated driver source file for ${moduleNameUpperCase} driver
+ *
+ * @skipline @version   Firmware Driver Version 1.0.0
+<#if generatePLIBVersion == true>
+ *
+ * @skipline @version   PLIB Version ${PLIBVersion}
+</#if>
+ *
+ * @skipline  Device : ${selectedDevice}
+*/
+
+${disclaimer}
+
+#include <stddef.h>
+#include <xc.h>
+#include "../${moduleNameLowerCase}.h"
+
+enum FLASH_PROGRAM_ERASE_ERROR_CODE getProgramEraseErrorCode(void);
+
+enum FLASH_PROGRAM_ERASE_ERROR_CODE {
+    ERROR_INVALID_OP = 1,
+    ERROR_SECURITY_ACCESS_VIOLATION,
+    ERROR_FLASH_PANEL_CONTROL_LOGIC,
+    ERROR_ROW_OP_SYSTEM_BUS,
+    ERROR_ROW_OP_WARM_RESET
+};
+
+<#if generateNonBlockingAPI == false && generateInterfaceContent == true>
+// Section: Driver Interface
+const struct ${moduleNameUpperCase}_INTERFACE flash = {
+    .PageErase = FLASH_PageErase,
+    .Write = FLASH_WordWrite,
+    <#if flashHasRowProgramming == 1>
+    .RowWrite = FLASH_RowWrite,
+    <#else>
+    .RowWrite = NULL,
+    </#if>
+    .Read = FLASH_Read,
+    .PageAddressGet = FLASH_ErasePageAddressGet,
+    .PageOffsetGet = FLASH_ErasePageOffsetGet,
+    .NonBlockingPageErase = NULL,
+    .NonBlockingBulkErase = NULL,
+    .NonBlockingRead = NULL,
+    .NonBlockingWordWrite = NULL,
+    .NonBlockingRowWrite = NULL,
+    .NonBlockingPolledPageErase = NULL,
+    .NonBlockingPolledBulkErase = NULL,
+    .NonBlockingPolledRead = NULL,
+    .NonBlockingPolledWordWrite = NULL,
+    .NonBlockingPolledRowWrite = NULL,
+};
+</#if>
+
+enum FLASH_RETURN_STATUS ${moduleNameUpperCase}_PageErase(flash_adr_t flashAddress, 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 (0U != (flashAddress & ~FLASH_ERASE_PAGE_MASK))
+    {
+        flashReturnStatus = FLASH_INVALID_ADDRESS;
+    }
+    else
+    {
+        ${nvmAddressRegister} = flashAddress;
+        ${nvmControlRegister} = FLASH_PAGE_ERASE_OPCODE;
+        ${nvmControlRegister}bits.WR = 1U;
+        while(1U == ${nvmControlRegister}bits.WR){};
+
+        flashReturnStatus = getProgramEraseErrorCode();
+    }
+    return flashReturnStatus;
+}
+
+enum FLASH_RETURN_STATUS ${moduleNameUpperCase}_WordWrite(flash_adr_t flashAddress, flash_data_t *data, flash_key_t unlockKey)
+{
+    enum FLASH_RETURN_STATUS flashReturnStatus = FLASH_NO_ERROR;
+    if (NULL == data)
+    {
+        flashReturnStatus = FLASH_INVALID_DATA;
+    }
+    else if(unlockKey != (flash_key_t)FLASH_UNLOCK_KEY)
+    {
+        flashReturnStatus = FLASH_INVALID_KEY;
+    }
+    else if (0U != (flashAddress % FLASH_ADDRESS_MASK))
+    {
+        flashReturnStatus = FLASH_INVALID_ADDRESS;
+    }
+    else
+    {
+	    ${nvmDataRegister0} = *data;
+        ${nvmDataRegister1} = *(data + 1U);
+        ${nvmDataRegister2} = *(data + 2U);
+        ${nvmDataRegister3} = *(data + 3U);
+
+        ${nvmAddressRegister} = flashAddress;
+        ${nvmControlRegister} = FLASH_WORD_WRITE_OPCODE;
+
+        ${nvmControlRegister}bits.WR = 1U;
+        while (1U == ${nvmControlRegister}bits.WR){};
+
+        flashReturnStatus = getProgramEraseErrorCode();
+    }
+    return flashReturnStatus;
+}
+
+<#if properties.FLASH_HAS_ROW_PROGRAMMING.value  == "TRUE">
+enum FLASH_RETURN_STATUS  ${moduleNameUpperCase}_RowWrite(flash_adr_t flashAddress, flash_data_t *data, flash_key_t unlockKey)
+{
+    enum FLASH_RETURN_STATUS flashReturnStatus = FLASH_NO_ERROR;
+    if (NULL == data)
+    {
+        flashReturnStatus = FLASH_INVALID_DATA;
+    }
+    else if(unlockKey != (flash_key_t)FLASH_UNLOCK_KEY)
+    {
+        flashReturnStatus = FLASH_INVALID_KEY;
+    }
+    else if (0U != (flashAddress % FLASH_ADDRESS_MASK))
+    {
+        flashReturnStatus = FLASH_INVALID_ADDRESS;
+    }
+    else
+    {
+        ${nvmSrcAddressRegister} = (uint32_t)data;
+        ${nvmAddressRegister} = flashAddress;
+        ${nvmControlRegister} = FLASH_ROW_WRITE_OPCODE;
+
+        ${nvmControlRegister}bits.WR = 1U;
+        while (1U == ${nvmControlRegister}bits.WR){};
+
+        flashReturnStatus = getProgramEraseErrorCode();
+    }
+    return flashReturnStatus;
+}
+</#if>
+
+enum FLASH_RETURN_STATUS ${moduleNameUpperCase}_Read(flash_adr_t flashAddress, size_t count, flash_data_t *data)
+{
+    flash_adr_t *flashReadAddress = (flash_adr_t *)flashAddress;
+    enum FLASH_RETURN_STATUS flashReturnStatus = FLASH_NO_ERROR;
+
+    if ((NULL == data) || (0U == count))
+    {
+        flashReturnStatus = FLASH_INVALID_DATA;
+    }
+    else if (0U != (flashAddress % FLASH_ADDRESS_MASK))
+    {
+        flashReturnStatus = FLASH_INVALID_ADDRESS;
+    }
+    else
+    {
+        uint32_t index;
+        for(index = 0; index < count ; index++)
+        {
+            *data = *(flashReadAddress+index);
+            data++;
+        }
+    }
+    return flashReturnStatus;
+}
+
+uint16_t ${moduleNameUpperCase}_ErasePageOffsetGet(flash_adr_t address)
+{
+    return ((~FLASH_ERASE_PAGE_MASK) & address);
+}
+
+uint32_t ${moduleNameUpperCase}_ErasePageAddressGet(flash_adr_t address)
+{
+    return (FLASH_ERASE_PAGE_MASK & address);
+}
+
+enum FLASH_PROGRAM_ERASE_ERROR_CODE getProgramEraseErrorCode(void)
+{
+    enum FLASH_RETURN_STATUS flashErrorCode = FLASH_NO_ERROR;
+    if(1U == ${nvmControlRegister}bits.WRERR)
+    {
+       flashErrorCode = FLASH_WRITE_ERROR;
+    }
+    else if(ERROR_INVALID_OP == ${nvmControlRegister}bits.WREC)
+    {
+        flashErrorCode = FLASH_INVALID_OEPRATION;
+    }
+    else if(ERROR_SECURITY_ACCESS_VIOLATION == ${nvmControlRegister}bits.WREC)
+    {
+        flashErrorCode = FLASH_SECURITY_ACCESS_CONTROL_ERROR;
+    }
+    else if(ERROR_FLASH_PANEL_CONTROL_LOGIC == ${nvmControlRegister}bits.WREC)
+    {
+        flashErrorCode = FLASH_PANEL_CONTROL_LOGIC_ERROR;
+    }
+    else if(ERROR_ROW_OP_SYSTEM_BUS == ${nvmControlRegister}bits.WREC)
+    {
+        flashErrorCode = FLASH_ROW_OP_SYSTEM_BUS_ERROR;
+    }
+    else if(ERROR_ROW_OP_WARM_RESET == ${nvmControlRegister}bits.WREC)
+    {
+        flashErrorCode = FLASH_ROW_OP_WARM_RESET_ERROR;
+    }
+    else
+    {
+        flashErrorCode = FLASH_NO_ERROR;
+    }
+    return flashErrorCode;
+}

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

@@ -0,0 +1,155 @@
+<#assign functionHeaderExample = false>
+
+/**
+ * ${moduleNameUpperCase} Generated Driver Header File
+ *
+ * @file         ${moduleNameLowerCase}.h
+ *
+ * @ingroup      ${moduleNameLowerCase}driver
+ *
+ * @brief        ${moduleNameUpperCase} driver using dsPIC MCUs
+ *
+ * @skipline @version   Firmware Driver Version 1.0.0
+<#if generatePLIBVersion == true>
+ *
+ * @skipline @version   PLIB Version ${PLIBVersion}
+</#if>
+ *
+ * @skipline     Device : ${selectedDevice}
+*/
+
+${disclaimer}
+
+#ifndef FLASH_H
+#define FLASH_H
+
+#include <stdint.h>
+#include <stddef.h>
+#include <stdbool.h>
+<#if generateInterfaceContent == true>
+#include "${moduleNameLowerCase}_interface.h"
+/**
+ @ingroup   ${moduleNameLowerCase}driver
+ @brief     Structure object of type ${moduleNameUpperCase}_INTERFACE assigned with name
+            displayed in the Melody Driver User interface. A structure pointer can be used to achieve portability
+            across the ${moduleNameUpperCase} having same interface structure.
+*/
+extern const struct ${moduleNameUpperCase}_INTERFACE flash;
+</#if>
+
+/**
+ * @ingroup ${moduleNameLowerCase}driver
+ * @brief This function erases a page.
+ * @param[in]  flashAddress : Flash address
+ * @param[in]  unlockKey : Pointer of the data to be written
+ * @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}_PageErase(flashAddress), unlockKey);
+ * @endcode
+</#if>
+ */
+enum FLASH_RETURN_STATUS ${moduleNameUpperCase}_PageErase(flash_adr_t flashAddress, flash_key_t unlockKey);
+
+
+/**
+ * @ingroup ${moduleNameLowerCase}driver
+ * @brief This function writes the specified data to the specified address.
+ * @param[in]  flashAddress : Flash address
+ * @param[in]  data : Pointer of the data to be written.
+<#if properties.FLASH_WORD_WRITE_SIZE_IN_INSTRUCTIONS.value  == "4">
+ *  This will write the 4 WORDS pointed to by the pointer.
+</#if>
+ * @return FLASH_RETURN_STATUS: returns FLASH_NO_ERROR if operation is successful , else returns errors like FLASH_INVALID_ADDRESS, FLASH_INVALID_DATA, FLASH_WRITE_ERROR
+<#if functionHeaderExample == true>
+ *
+ * @b Example:
+ * @code
+ *    uint32_t data[10];
+ *    uint32_t index = 0;
+ *    for(index = 0; index < ROW_SIZE; index++)
+ *    {
+ *        data[index] = index;
+ *    }
+ *    FLASH_RETURN_STATUS status = ${moduleNameUpperCase}_WordWrite(flashAddress), &data, unlockKey);
+ * @endcode
+</#if>
+ */
+enum FLASH_RETURN_STATUS ${moduleNameUpperCase}_WordWrite(flash_adr_t flashAddress, flash_data_t *data, flash_key_t unlockKey);
+
+<#if properties.FLASH_HAS_ROW_PROGRAMMING.value  == "TRUE">
+/**
+ * @ingroup ${moduleNameLowerCase}driver
+ * @brief This function writes the specified data to the specified address.
+ * @param[in]  flashAddress : Flash address
+ * @param[in]  data : Pointer of the data to be written
+ * @return FLASH_RETURN_STATUS: returns FLASH_NO_ERROR if operation is successful , else returns errors like FLASH_INVALID_ADDRESS, FLASH_INVALID_DATA, FLASH_WRITE_ERROR
+<#if functionHeaderExample == true>
+ *
+ * @b Example:
+ * @code
+ *    uint32_t data[FLASH_WRITE_INSTRUCTION_COUNT];
+ *    uint32_t index = 0;
+ *    for(index = 0; index<ROW_SIZE; index++)
+ *    {
+ *        data[index] = index;
+ *    }
+ *    FLASH_RETURN_STATUS status = ${moduleNameUpperCase}_RowWrite(flashAddress), &data, unlockKey);
+ * @endcode
+</#if>
+ */
+enum FLASH_RETURN_STATUS ${moduleNameUpperCase}_RowWrite(flash_adr_t flashAddress, flash_data_t *data, flash_key_t unlockKey);
+</#if>
+
+/**
+ * @ingroup ${moduleNameLowerCase}driver
+ * @brief This function reads the data from the specified address.
+ * @param[in]  flashAddress : Flash address
+ * @param[out]  data : Pointer to read the data
+ * @return  FLASH_RETURN_STATUS: returns FLASH_NO_ERROR if operation is successful , else returns errors like FLASH_INVALID_ADDRESS, FLASH_INVALID_DATA
+<#if functionHeaderExample == true>
+ *
+ * @b Example:
+ * @code
+ *    uint32_t data[2];
+ *    FLASH_RETURN_STATUS status = ${moduleNameUpperCase}_Read(flashAddress, &data);
+ * @endcode
+</#if>
+ */
+enum FLASH_RETURN_STATUS ${moduleNameUpperCase}_Read(flash_adr_t flashAddress, size_t count, flash_data_t *data);
+
+/**
+ * @ingroup ${moduleNameLowerCase}driver
+ * @brief This function returns the offest from page start.
+ * @param[in]  flashAddress : Flash address
+ * @return  FLASH_RETURN_STATUS: returns the flash offset from page start address
+<#if functionHeaderExample == true>
+ *
+ * @b Example:
+ * @code
+ *    uint16_t offset = ${moduleNameUpperCase}_ErasePageOffsetGet(flashAddress);
+ * @endcode
+</#if>
+ */
+uint16_t ${moduleNameUpperCase}_ErasePageOffsetGet(flash_adr_t flashAddress);
+
+
+/**
+ * @ingroup ${moduleNameLowerCase}driver
+ * @brief This function returns the offest from page start.
+ * @param[in]  flashAddress : Flash address
+ * @return  FLASH_RETURN_STATUS: returns page start address for the given address
+<#if functionHeaderExample == true>
+ *
+ * @b Example:
+ * @code
+ *    uint32_t pageStartAddress = ${moduleNameUpperCase}_ErasePageAddressGet(flashAddress);
+ * @endcode
+</#if>
+ */
+uint32_t ${moduleNameUpperCase}_ErasePageAddressGet(flash_adr_t flashAddress);
+
+
+#endif    /* FLASH_H */

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

@@ -0,0 +1,93 @@
+
+/**
+ * ${moduleNameLowerCase} Generated Driver Interface Header File
+ *
+ * @file        ${moduleNameLowerCase}_interface.h
+ *
+ * @defgroup    ${moduleNameLowerCase}driver ${doxyDriverGroupName}
+ *
+ * @brief       ${moduleNameUpperCase} Driver using dsPIC MCUs
+ *
+ * @skipline @version   Firmware Driver Version 1.1.0
+<#if generatePLIBVersion == true>
+ *
+ * @skipline @version   PLIB Version ${PLIBVersion}
+</#if>
+ *
+ * @skipline    Device : ${selectedDevice}
+*/
+
+${disclaimer}
+
+#ifndef ${moduleNameUpperCase}_INTERFACE_H
+#define ${moduleNameUpperCase}_INTERFACE_H
+
+// Section: Included Files
+#include <stdint.h>
+#include <stdbool.h>
+#include <stddef.h>
+#include "flash_types.h"
+
+// Section: Data Type Definitions
+
+
+/**
+ @ingroup ${moduleNameLowerCase}driver
+ @struct ${moduleNameUpperCase}_INTERFACE
+ @brief Structure containing the function pointers of ${moduleNameUpperCase} driver.
+*/
+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 (*Write)(flash_adr_t address, flash_data_t* data, flash_key_t unlockKey);
+    ///< Pointer to FLASH_WordWrite e.g. \ref FLASH_WordWrite
+
+    enum FLASH_RETURN_STATUS (*RowWrite)(flash_adr_t address, flash_data_t* data, flash_key_t unlockKey);
+    ///< Pointer to FLASH_RowWrite e.g. \ref FLASH_RowWrite
+
+    enum FLASH_RETURN_STATUS (*Read)(flash_adr_t address, size_t count, uint32_t *data);
+    ///< Pointer to FLASH_Read e.g. \ref FLASH_Read
+
+    uint32_t (*PageAddressGet)(flash_adr_t address);
+    ///< Pointer to FLASH_ErasePageAddressGet e.g. \ref FLASH_ErasePageAddressGet
+
+    uint16_t (*PageOffsetGet)(flash_adr_t address);
+    ///< Pointer to FLASH_ErasePageOffsetGet e.g. \ref FLASH_ErasePageOffsetGet
+
+    enum FLASH_RETURN_STATUS (*OperationStatusGet)(void);
+    ///< Pointer to FLASH_OperationStatusGet e.g. \ref FLASH_OperationStatusGet
+
+    enum FLASH_RETURN_STATUS (*NonBlockingPageErase)(flash_adr_t address, flash_key_t unlockKey, FLASH_CALLBACK callbackHandler, void* context);
+    ///< Pointer to FLASH_NonBlockingPageErase e.g. \ref FLASH_NonBlockingPageErase
+
+    enum FLASH_RETURN_STATUS (*NonBlockingBulkErase)(enum FLASH_PANEL panel, flash_key_t unlockKey, FLASH_CALLBACK callbackHandler, void* context);
+    ///< Pointer to FLASH_NonBlockingBulkErase e.g. \ref FLASH_NonBlockingBulkErase
+
+    enum FLASH_RETURN_STATUS (*NonBlockingWordWrite)(flash_adr_t address, flash_data_t* data, flash_key_t unlockKey, FLASH_CALLBACK callbackHandler, void* context);
+    ///< Pointer to FLASH_NonBlockingWordWrite e.g. \ref FLASH_NonBlockingWordWrite
+
+    enum FLASH_RETURN_STATUS (*NonBlockingRowWrite)(flash_adr_t address, flash_data_t* data, flash_key_t unlockKey, FLASH_CALLBACK callbackHandler, void* context);
+    ///< Pointer to FLASH_NonBlockingRowWrite e.g. \ref FLASH_NonBlockingRowWrite
+
+    enum FLASH_RETURN_STATUS (*NonBlockingRead)(flash_adr_t address, size_t count, uint32_t *data);
+    ///< Pointer to FLASH_NonBlockingRead e.g. \ref FLASH_NonBlockingRead
+
+    enum FLASH_RETURN_STATUS (*NonBlockingPolledPageErase)(flash_adr_t address, flash_key_t unlockKey);
+    ///< Pointer to FLASH_NonBlockingPolledPageErase e.g. \ref FLASH_NonBlockingPolledPageErase
+
+    enum FLASH_RETURN_STATUS (*NonBlockingPolledBulkErase)(enum FLASH_PANEL panel, flash_key_t unlockKey);
+    ///< Pointer to FLASH_NonBlockingPolledBulkErase e.g. \ref FLASH_NonBlockingPolledBulkErase
+
+    enum FLASH_RETURN_STATUS (*NonBlockingPolledWordWrite)(flash_adr_t address, flash_data_t* data, flash_key_t unlockKey);
+    ///< Pointer to FLASH_NonBlockingPolledWordWrite e.g. \ref FLASH_NonBlockingPolledWordWrite
+
+    enum FLASH_RETURN_STATUS (*NonBlockingPolledRowWrite)(flash_adr_t address, flash_data_t* data, flash_key_t unlockKey);
+    ///< Pointer to FLASH_NonBlockingPolledRowWrite e.g. \ref FLASH_NonBlockingPolledRowWrite
+
+    enum FLASH_RETURN_STATUS (*NonBlockingPolledRead)(flash_adr_t address, size_t count, uint32_t *data);
+    ///< Pointer to FLASH_NonBlockingPolledRead e.g. \ref FLASH_NonBlockingPolledRead
+};
+
+#endif //${moduleNameUpperCase}_INTERFACE_H