@mchp-mcc/dspic33a-flash 1.0.1

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

@@ -0,0 +1,101 @@
+
+/**
+ * ${moduleNameLowerCase} Generated Driver Types Header File
+ *
+ * @file        ${moduleNameLowerCase}_types.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 ${moduleNameUpperCase}_TYPES_H
+#define ${moduleNameUpperCase}_TYPES_H
+/**
+ @ingroup  ${moduleNameLowerCase}driver
+ @brief    Defines ${moduleNameUpperCase} odd address mask value
+*/
+#define  FLASH_ADDRESS_MASK  4U
+/**
+ @ingroup  ${moduleNameLowerCase}driver
+ @brief    Defines ${moduleNameUpperCase} unlock key
+*/
+#define  FLASH_UNLOCK_KEY  ${flashUnlockKey}
+/**
+ @ingroup  ${moduleNameLowerCase}driver
+ @brief    Defines ${moduleNameUpperCase} page erase opcode
+*/
+#define  FLASH_PAGE_ERASE_OPCODE  ${flashPageEraseOpcode}
+/**
+ @ingroup  ${moduleNameLowerCase}driver
+ @brief    Defines ${moduleNameUpperCase} word write opcode
+*/
+#define  FLASH_WORD_WRITE_OPCODE  ${flashWordWriteOpCode}
+/**
+ @ingroup  ${moduleNameLowerCase}driver
+ @brief    Defines ${moduleNameUpperCase} word write opcode
+*/
+#define  FLASH_ROW_WRITE_OPCODE  ${flashRowWriteOpcode}
+/**
+ @ingroup  ${moduleNameLowerCase}driver
+ @brief    Defines ${moduleNameUpperCase} flash page size
+*/
+#define  FLASH_ERASE_PAGE_SIZE_IN_INSTRUCTIONS  ${flashErasePageSizeInInstructions}U
+/**
+ @ingroup  ${moduleNameLowerCase}driver
+ @brief    Defines ${moduleNameUpperCase} erase page mask
+*/
+#define  FLASH_ERASE_PAGE_MASK  (~(FLASH_ERASE_PAGE_SIZE_IN_INSTRUCTIONS - 1U))
+
+typedef void (*FLASH_CALLBACK)(void *);
+
+typedef uint32_t flash_adr_t;
+typedef ${flashInstructionType} flash_data_t;
+typedef uint32_t flash_key_t;
+
+/**
+ @ingroup  ${moduleNameLowerCase}driver
+ @enum     FLASH_PANEL
+ @brief    This enum is be used for the flash panel numbers and maximum flash panels.
+*/
+enum FLASH_PANEL
+{
+    FLASH_PANEL_1 = 0,
+    FLASH_PANEL_2 = 1,
+    FLASH_PANEL_MAX_PANELS
+};
+
+/**
+ @ingroup  ${moduleNameLowerCase}driver
+ @enum     FLASH_RETURN_STATUS
+ @brief    This enum is be used to return the status of write, read and erase operation.
+*/
+enum FLASH_RETURN_STATUS {
+    FLASH_NO_ERROR,                           /**< No error occurred */
+    FLASH_INVALID_ADDRESS,                    /**< Invalid address */
+    FLASH_INVALID_DATA,                       /**< Invalid data */
+    FLASH_WRITE_ERROR,                        /**< Write error has occurred */
+    FLASH_READ_ERROR,                         /**< Read error has occurred */
+    FLASH_ERASE_ERROR,                        /**< Flash erase error occurred */
+    FLASH_INVALID_CALLBACK_HANDLER,           /**< Invalid parameter to operation */
+    FLASH_OP_BUSY,                            /**< Flash is physically busy */
+    FLASH_OP_IN_PROGRESS,                     /**< Flash operation is in progress */
+    FLASH_INVALID_KEY,                        /**< Invalid NVM unlock Key  */
+    FLASH_INVALID_OEPRATION,                  /**< Invalid program/erase operation (PROGOP) */
+    FLASH_SECURITY_ACCESS_CONTROL_ERROR,      /**< Flash Security access control violation  */
+    FLASH_PANEL_CONTROL_LOGIC_ERROR,          /**< Error reported by flash panel control logic  */
+    FLASH_ROW_OP_SYSTEM_BUS_ERROR,            /**< Flash System bus error during row operation  */
+    FLASH_ROW_OP_WARM_RESET_ERROR             /**< Row programming operation not completed due to warm reset */
+};
+
+#endif //${moduleNameUpperCase}_TYPES_H

package/output/nullPrototype.json

@@ -0,0 +1,43 @@
+{
+    "payload": null,
+    "imports": {
+        "nvm_ctrl_32bit_upb_v1": {
+            "interfaceId": {
+                "name": "nvm_ctrl_32bit_upb_v1",
+                "version": "1.0.0"
+            },
+            "isRequired": true
+        },
+        "system_16bit_initializer": {
+            "interfaceId": {
+                "name": "system-16bit-initializer",
+                "version": "^1.0.0"
+            }
+        },
+        "config_16bit_interface": {
+            "interfaceId": {
+                "name": "config-16bit-interface",
+                "version": "^1.0.0"
+            }
+        },
+        "interrupt_service": {
+            "interfaceId": {
+                "name": "interrupt-16bit-interface",
+                "version": "^1.0.0"
+            }
+        }
+    },
+    "exports": {
+        "flash_interface": {
+            "interfaces": [
+                {
+                    "interfaceId": {
+                        "name": "flash-interface",
+                        "version": "1.3.1"
+                    }
+                }
+            ]
+        }
+    },
+    "isEntryPoint": false
+}