NXP Backend: Update Neutron Software to SDK_25.09

Author: robert-kalmar

backends/nxp/nxp_backend.py

@@ -64,7 +64,7 @@ def neutron_compile_spec(
         Args:
             config: Neutron accelerator configuration, e.g. "imxrt700"
             neutron_converter_flavor: Flavor of the neutron-converter module to use. Neutron-converter module named "
-             "'neutron_converter_SDK_25_06' has flavor 'SDK_25_06'.
+             "'neutron_converter_SDK_25_09' has flavor 'SDK_25_09'.
             extra_flags: Extra flags for the Neutron compiler
             operators_not_to_delegate: List of operators that should not be delegated
         """

backends/nxp/requirements-tests-eiq.txt

@@ -1,2 +1,2 @@
 --index-url https://eiq.nxp.com/repository
-neutron_converter_SDK_25_06
+neutron_converter_SDK_25_09

backends/nxp/runtime/NeutronDriver.h

@@ -18,22 +18,6 @@ extern "C" {
 
 #include "NeutronErrors.h"
 
-/* Neutron Driver error category codes */
-typedef enum ERROR_CATEGORY_DRIVER {
-  ERROR_CATEGORY_DRIVER_GENERIC, /* Generic error category */
-  ERROR_CATEGORY_DRIVER_UNSUPPORTED, /* Unsupported function */
-  ERROR_CATEGORY_DRIVER_UCODE, /* Microcode bad magic or version incompatible.
-                                */
-  ERROR_CATEGORY_DRIVER_INVALID, /* Invalid arguments */
-  ERROR_CATEGORY_DRIVER_BAD_HANDLE, /* Bad inference handle */
-  ERROR_CATEGORY_DRIVER_NO_MEMORY, /* Not enough memory */
-  ERROR_CATEGORY_DRIVER_INTERNAL_FAULT, /* Internal error */
-  ERROR_CATEGORY_DRIVER_UNKNOWN_ARCH, /* Unknown architecture */
-  ERROR_CATEGORY_DRIVER_TRACE_NOT_RUN, /* Tracing did not run, but trace buffer
-                                          was requested. */
-  ERROR_CATEGORY_DRIVER_TIMEOUT /* Timeout error. */
-} ERROR_CATEGORY_DRIVER;
-
 /// Trace configuration to enable kernel level tracing.
 #define TRACE_CONFIG_KERNEL_LEVEL (1U << 0)
 
@@ -169,6 +153,12 @@ NeutronError neutronCustomExec(
     NeutronModelHandle hdl,
     const NeutronDataConfig* neutron_dcfg);
 
+/// - Setup the input and output data ptr to use Neutron memory area.
+/// - The input and ouput data ptr is stored in neutron_dcfg.
+NeutronError neutronDataSetup(
+    NeutronModelHandle hdl,
+    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.
@@ -245,6 +235,29 @@ void* neutronMemAlloc(size_t alignment, size_t size);
 /// - This function is only available for Neutron-S in the Linux environment.
 void neutronMemFree(void* ptr);
 
+/// - Allocates size bytes large buffer in DDR to be used for specialized
+/// kernels (e.g. batch matmul)
+///   Uses Linux CMA allocator
+NeutronError allocateBuffer(uint64_t size, void** pBuffer, bool userspace);
+
+/// - Frees buffer allocated via allocateBuffer function
+NeutronError releaseBuffer(void* buffer);
+
+/// - Clean/flush cache for DDR allocated buffer
+///   TODO: rename function as "cleanCache" to satisfy neutron-software naming
+///   convention
+NeutronError clean_cache(const void* addr, int size);
+
+/// - Function for calling firmware for specialized kernel (matmul)
+NeutronError matmul(
+    const void* info,
+    int sizeInfo,
+    const void* in,
+    int sizeIn,
+    const void* out,
+    int sizeOut,
+    int idxSlot);
+
 /// Other functions to control the state of driver/firmware.
 #ifdef __cplusplus
 }

backends/nxp/runtime/NeutronErrors.h

@@ -39,6 +39,32 @@ typedef enum ERROR_COMPONENT_ID {
   ERROR_COMPONENT_DRIVER = 0x3
 } ERROR_COMPONENT_ID;
 
+/* Neutron Firmware error category codes */
+typedef enum ERROR_CATEGORY_FW {
+  ERROR_CATEGORY_FW_GENERIC, /* Generic error category */
+  ERROR_CATEGORY_FW_UCODE, /* Microcode bad magic or version incompatible. */
+  ERROR_CATEGORY_FW_BUFFER_OVERFLOW, /* Buffer overflow error category */
+  ERROR_CATEGORY_FW_NULL_POINTER, /* Pointer is null */
+  ERROR_CATEGORY_FW_INTR_ERROR, /* Interrupt triggering error */
+  ERROR_CATEGORY_FW_DMAPI_ERROR, /* DM API parameter error */
+} ERROR_CATEGORY_FW;
+
+/* Neutron Driver error category codes */
+typedef enum ERROR_CATEGORY_DRIVER {
+  ERROR_CATEGORY_DRIVER_GENERIC, /* Generic error category */
+  ERROR_CATEGORY_DRIVER_UNSUPPORTED, /* Unsupported function */
+  ERROR_CATEGORY_DRIVER_UCODE, /* Microcode bad magic or version incompatible.
+                                */
+  ERROR_CATEGORY_DRIVER_INVALID, /* Invalid arguments */
+  ERROR_CATEGORY_DRIVER_BAD_HANDLE, /* Bad inference handle */
+  ERROR_CATEGORY_DRIVER_NO_MEMORY, /* Not enough memory */
+  ERROR_CATEGORY_DRIVER_INTERNAL_FAULT, /* Internal error */
+  ERROR_CATEGORY_DRIVER_UNKNOWN_ARCH, /* Unknown architecture */
+  ERROR_CATEGORY_DRIVER_TRACE_NOT_RUN, /* Tracing did not run, but trace buffer
+                                          was requested. */
+  ERROR_CATEGORY_DRIVER_TIMEOUT /* Timeout error. */
+} ERROR_CATEGORY_DRIVER;
+
 /// Retrieve component name as string from NeutronError code.
 char* getNeutronErrorComponent(NeutronError ne);
 

backends/nxp/tests/executorch_pipeline.py

@@ -88,7 +88,7 @@ def to_quantized_edge_program(
         [tuple[ModelInputSpec, ...]], list[tuple[torch.Tensor, ...]]
     ] = get_random_calibration_inputs,
     target="imxrt700",
-    neutron_converter_flavor="SDK_25_06",
+    neutron_converter_flavor="SDK_25_09",
     remove_quant_io_ops=False,
     custom_delegation_options=CustomDelegationOptions(),  # noqa B008
 ) -> EdgeProgramManager:

backends/nxp/tests/test_neutron_converter_manager.py

@@ -30,7 +30,7 @@ def test_conv2d_neutron_conversion__default_flavor():
 
     neutron_converter_manager = NeutronConverterManager()
     neutron_model = neutron_converter_manager.convert(
-        tflite_model, "imxrt700", "SDK_25_06"
+        tflite_model, "imxrt700", "SDK_25_09"
     )
 
     assert len(

backends/nxp/tests/test_split_group_convolution.py

@@ -49,7 +49,7 @@ def _quantize_and_lower_module(
         edge_compile_config=edge_compile_config,
     )
 
-    compile_spec = generate_neutron_compile_spec(target, "SDK_25_06")
+    compile_spec = generate_neutron_compile_spec(target, "SDK_25_09")
     partitioner = NeutronPartitioner(compile_spec)
     return edge_program_manager.to_backend(partitioner)
 

examples/nxp/README.md

@@ -13,7 +13,7 @@ $ examples/nxp/setup.sh
 2. Now run the `aot_neutron_compile.py` example with the `cifar10` model 
 ```commandline
 $ python -m examples.nxp.aot_neutron_compile --quantize \
-    --delegate --neutron_converter_flavor SDK_25_06 -m cifar10 
+    --delegate --neutron_converter_flavor SDK_25_09 -m cifar10 
 ```
 
 3. It will generate you `cifar10_nxp_delegate.pte` file which can be used with the MXUXpresso SDK `cifarnet_example` project, presented [here](https://mcuxpresso.nxp.com/mcuxsdk/latest/html/middleware/eiq/executorch/docs/nxp/topics/example_applications.html#how-to-build-and-run-executorch-cifarnet-example).

examples/nxp/aot_neutron_compile.py

@@ -164,9 +164,9 @@ def _get_batch_size(data):
         "-c",
         "--neutron_converter_flavor",
         required=False,
-        default="SDK_25_06",
+        default="SDK_25_09",
         help="Flavor of installed neutron-converter module. Neutron-converter module named "
-        "'neutron_converter_SDK_24_12' has flavor 'SDK_24_12'.",
+        "'neutron_converter_SDK_25_09' has flavor 'SDK_25_09'.",
     )
     parser.add_argument(
         "-q",

examples/nxp/run_aot_example.sh

@@ -13,6 +13,6 @@ cd $EXECUTORCH_DIR
 
 # Run the AoT example
 python -m examples.nxp.aot_neutron_compile --quantize \
-    --delegate --neutron_converter_flavor SDK_25_06 -m ${MODEL}
+    --delegate --neutron_converter_flavor SDK_25_09 -m ${MODEL}
 # verify file exists
 test -f ${MODEL}_nxp_delegate.pte