Update Neutron software to v1.2.0+0X1b86b19d

Signed-off-by: Alison Wang <[email protected]>

Author: alisonwh

backends/nxp/runtime/NeutronDriver.h

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 NXP
+ * Copyright 2022-2024 NXP
  *
  * SPDX-License-Identifier: BSD-3-Clause
  *
@@ -54,21 +54,21 @@ typedef void *NeutronModelHandle;
 typedef struct {
     /// Neutron microcode buffer address.
     /// The Neutron microcode is generated by the Neutron converter tool.
-    /// The microcode buffer is allocated and initialized by the application or ML framework.
+    /// The microcode buffer, 16 bytes aligned, is allocated and initialized by the application or ML framework.
     /// The microcode buffer is passed by reference to the Neutron firmware.
     /// The microcode buffer is specific for a given ML model.
     const void *microcode;
 
     /// Neutron weights buffer address.
     /// The Neutron weights is generated by the Neutron converter tool.
-    /// The weights buffer is allocated and initialized by the application or ML framework.
+    /// The weights buffer, 16 bytes aligned, is allocated and initialized by the application or ML framework.
     /// The weights buffer address is passed by reference to the Neutron-firmware.
     /// The weights buffer is specific for a given ML model.
     const void *weights;
 
     /// Neutron kernels buffer address.
     /// The Neutron kernels are generated by the Neutron converter tool.
-    /// The kernels buffer is allocated and initialized by the application or ML framework.
+    /// The kernels buffer, 16 bytes aligned, is allocated and initialized by the application or ML framework.
     /// The kernels buffer address is passed by reference to the Neutron-firmware.
     /// The kernels buffer is specific for a given ML model.
     const void *kernels;
@@ -137,6 +137,15 @@ NeutronError neutronInit();
 /// - Deinitialize the Neutron Driver library, releasing any resources aquired by neutronInit
 NeutronError neutronDeinit();
 
+/// - Prepare Neutron execution for a model with custom firmware.
+/// - This function is only available for Neutron-S.
+NeutronError neutronCustomPrepare(uint32_t *inputSize, int32_t numInputs, uint32_t *outputSize, int32_t numOutputs,
+                                  const void *firmware, size_t firmwareSize, NeutronModelHandle *hdl);
+
+/// - Run Neutron custom firmware and get the results.
+/// - This function is only available for Neutron-S.
+NeutronError neutronCustomExec(NeutronModelHandle hdl, const NeutronDataConfig *neutron_dcfg);
+
 /// - Prepare Neutron execution for a model with the given configuration.
 /// - This function only prepares the execution by transferring the parameters to the firmware.
 /// - This function allows caching a model and then running the same model but with different
@@ -188,6 +197,17 @@ NeutronError neutronSetConfig(NeutronConfig *config);
 /// - Used to get NeutronContext size.
 size_t neutronGetModelContextSize();
 
+/// - Allocates size bytes and returns a pointer to the allocated memory.
+///   The returned pointer address will be a multiple of the alignment.
+///   Returns NULL on failure.
+/// - alignment: Set to 0 if unsure of alignment requirements.
+/// - This function is only available for Neutron-S in the Linux environment.
+void *neutronMemAlloc(size_t alignment, size_t size);
+
+/// - Frees the memory buffer pointed to by ptr.
+/// - This function is only available for Neutron-S in the Linux environment.
+void neutronMemFree(void *ptr);
+
 /// Other functions to control the state of driver/firmware.
 #ifdef __cplusplus
 }

backends/nxp/runtime/NeutronErrors.h

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 NXP
+ * Copyright 2022-2024 NXP
  *
  * SPDX-License-Identifier: BSD-3-Clause
  *
@@ -13,6 +13,40 @@
 
 typedef int32_t NeutronError;
 
+/*
+    Generate error code.
+    A code is composed of (from least to most significant bit):
+        3 bits = component id
+        5 bits = category id
+        23 bits = code
+        1 bit = sign
+*/
+#define GEN_NEUTRON_ERROR(component, category, code) ((NeutronError)( \
+    ((component & 0xF) << 0) |                                        \
+    ((category  & 0xF) << 3) |                                        \
+    ((code & 0x7FFFFF) << 8)                                          \
+    ))
+
 #define ENONE 0
 
+#define GET_ERROR_COMPONENT(e) ((e >> 0) & 0x00000007)
+#define GET_ERROR_CATEGORY(e)  ((e >> 3) & 0x0000001F)
+#define GET_ERROR_CODE(e)      ((e >> 8) & 0x007FFFFF)
+
+
+/* Components ids*/
+// DO NOT USE 0x0 as component magic number!
+typedef enum ERROR_COMPONENT_ID {
+	ERROR_COMPONENT_LIBRARY  = 0x1,
+	ERROR_COMPONENT_FIRMWARE = 0x2,
+	ERROR_COMPONENT_DRIVER   = 0x3
+} ERROR_COMPONENT_ID;
+
+
+/// Retrieve component name as string from NeutronError code.
+char *getNeutronErrorComponent(NeutronError ne);
+
+/// Retrieve catefory as string from NeutronError code.
+char *getNeutronErrorCategory(NeutronError ne);
+
 #endif // NEUTRON_ERRORS_H