ADLX SDK v1.5

Author: ericjunwei

SDK/ADLXHelper/Windows/C/ADLXHelper.c

@@ -1,5 +1,5 @@
 //
-// Copyright (c) 2021 - 2025 Advanced Micro Devices, Inc. All rights reserved.
+// Copyright Advanced Micro Devices, Inc. All rights reserved.
 //
 //-------------------------------------------------------------------------------------------------
 #include "ADLXHelper.h"
@@ -36,6 +36,12 @@ typedef struct ADLXHelper
 	//ADLX function - initialize
 	ADLXInitialize_Fn m_initFn;
 
+	//ADLX function - initialize with incompatible driver
+	ADLXInitialize2_Fn m_init2FnEx;
+
+	//ADLX function - initialize
+	ADLXInitialize2_Fn m_init2Fn;
+
 	//ADLX function - terminate
 	ADLXTerminate_Fn m_terminateFn;
 }ADLXHelper;
@@ -132,12 +138,18 @@ ADLX_RESULT LoadADLXDll()
 			g_ADLX.m_fullVersionFn = (ADLXQueryFullVersion_Fn)adlx_get_proc_address(g_ADLX.m_hDLLHandle, ADLX_QUERY_FULL_VERSION_FUNCTION_NAME);
 			g_ADLX.m_versionFn = (ADLXQueryVersion_Fn)adlx_get_proc_address(g_ADLX.m_hDLLHandle, ADLX_QUERY_VERSION_FUNCTION_NAME);
 			g_ADLX.m_initWithADLFn = (ADLXInitializeWithCallerAdl_Fn)adlx_get_proc_address(g_ADLX.m_hDLLHandle, ADLX_INIT_WITH_CALLER_ADL_FUNCTION_NAME);
-			g_ADLX.m_initFnEx = (ADLXInitialize_Fn)adlx_get_proc_address(g_ADLX.m_hDLLHandle, ADLX_INIT_WITH_INCOMPATIBLE_DRIVER_FUNCTION_NAME);
-			g_ADLX.m_initFn = (ADLXInitialize_Fn)adlx_get_proc_address(g_ADLX.m_hDLLHandle, ADLX_INIT_FUNCTION_NAME);
+			g_ADLX.m_init2FnEx = (ADLXInitialize2_Fn)adlx_get_proc_address(g_ADLX.m_hDLLHandle, ADLX_INIT2_WITH_INCOMPATIBLE_DRIVER_FUNCTION_NAME);
+			g_ADLX.m_init2Fn = (ADLXInitialize2_Fn)adlx_get_proc_address(g_ADLX.m_hDLLHandle, ADLX_INIT2_FUNCTION_NAME);
+			if (g_ADLX.m_init2FnEx == NULL)
+			{
+				//try to get the ADLXInitialize function pointers if ADLXInitialize2 is not found
+				g_ADLX.m_initFnEx = (ADLXInitialize_Fn)adlx_get_proc_address(g_ADLX.m_hDLLHandle, ADLX_INIT_WITH_INCOMPATIBLE_DRIVER_FUNCTION_NAME);
+				g_ADLX.m_initFn = (ADLXInitialize_Fn)adlx_get_proc_address(g_ADLX.m_hDLLHandle, ADLX_INIT_FUNCTION_NAME);
+			}
 			g_ADLX.m_terminateFn = (ADLXTerminate_Fn)adlx_get_proc_address(g_ADLX.m_hDLLHandle, ADLX_TERMINATE_FUNCTION_NAME);
 		}
 	}
-	if (g_ADLX.m_fullVersionFn && g_ADLX.m_versionFn && g_ADLX.m_initWithADLFn && g_ADLX.m_initFnEx && g_ADLX.m_initFn && g_ADLX.m_terminateFn)
+	if (g_ADLX.m_fullVersionFn && g_ADLX.m_versionFn && g_ADLX.m_initWithADLFn && ((g_ADLX.m_init2FnEx && g_ADLX.m_init2Fn) || (g_ADLX.m_initFnEx && g_ADLX.m_initFn)) && g_ADLX.m_terminateFn)
 	{
 		return ADLX_OK;
 	}
@@ -161,15 +173,21 @@ ADLX_RESULT InitializePrivate (adlx_handle  adlContext, ADLX_ADL_Main_Memory_Fre
 		{
 			if (useIncompatibleDriver)
 			{
-				res = g_ADLX.m_initFnEx(ADLX_FULL_VERSION, &g_ADLX.m_pSystemServices);
+				if (g_ADLX.m_init2FnEx)
+					res = g_ADLX.m_init2FnEx(ADLX_FULL_VERSION, &g_ADLX.m_pSystemServices, &g_ADLX.m_pAdlMapping);
+				else
+					res = g_ADLX.m_initFnEx(ADLX_FULL_VERSION, &g_ADLX.m_pSystemServices);
 			}
 			else
 			{
-				res = g_ADLX.m_initFn(ADLX_FULL_VERSION, &g_ADLX.m_pSystemServices);
+				if (g_ADLX.m_init2Fn)
+					res = g_ADLX.m_init2Fn(ADLX_FULL_VERSION, &g_ADLX.m_pSystemServices, &g_ADLX.m_pAdlMapping);
+				else
+					res = g_ADLX.m_initFn(ADLX_FULL_VERSION, &g_ADLX.m_pSystemServices);
 			}
 		}
 		return res;
 	}
 
 	return ADLX_FAIL;
-}
+}

SDK/ADLXHelper/Windows/C/ADLXHelper.h

@@ -1,5 +1,5 @@
 // 
-// Copyright (c) 2021 - 2025 Advanced Micro Devices, Inc. All rights reserved.
+// Copyright Advanced Micro Devices, Inc. All rights reserved.
 //
 //-------------------------------------------------------------------------------------------------
 

SDK/ADLXHelper/Windows/Cpp/ADLXHelper.cpp

@@ -1,5 +1,5 @@
 //
-// Copyright (c) 2021 - 2025 Advanced Micro Devices, Inc. All rights reserved.
+// Copyright Advanced Micro Devices, Inc. All rights reserved.
 //
 //-------------------------------------------------------------------------------------------------
 
@@ -107,13 +107,19 @@ ADLX_RESULT ADLXHelper::LoadADLXDll()
             m_fullVersionFn = (ADLXQueryFullVersion_Fn)adlx_get_proc_address (m_hDLLHandle, ADLX_QUERY_FULL_VERSION_FUNCTION_NAME);
             m_versionFn = (ADLXQueryVersion_Fn)adlx_get_proc_address (m_hDLLHandle, ADLX_QUERY_VERSION_FUNCTION_NAME);
             m_initWithADLFn = (ADLXInitializeWithCallerAdl_Fn)adlx_get_proc_address (m_hDLLHandle, ADLX_INIT_WITH_CALLER_ADL_FUNCTION_NAME);
-            m_initFnEx = (ADLXInitialize_Fn)adlx_get_proc_address (m_hDLLHandle, ADLX_INIT_WITH_INCOMPATIBLE_DRIVER_FUNCTION_NAME);
-            m_initFn = (ADLXInitialize_Fn)adlx_get_proc_address (m_hDLLHandle, ADLX_INIT_FUNCTION_NAME);
+            m_init2FnEx = (ADLXInitialize2_Fn)adlx_get_proc_address (m_hDLLHandle, ADLX_INIT2_WITH_INCOMPATIBLE_DRIVER_FUNCTION_NAME);
+            m_init2Fn = (ADLXInitialize2_Fn)adlx_get_proc_address (m_hDLLHandle, ADLX_INIT2_FUNCTION_NAME);
+            if (m_init2FnEx == nullptr)
+            {
+                //try to get the ADLXInitialize function pointers if ADLXInitialize2 is not found
+                m_initFnEx = (ADLXInitialize_Fn)adlx_get_proc_address (m_hDLLHandle, ADLX_INIT_WITH_INCOMPATIBLE_DRIVER_FUNCTION_NAME);
+                m_initFn = (ADLXInitialize_Fn)adlx_get_proc_address (m_hDLLHandle, ADLX_INIT_FUNCTION_NAME);
+            }
             m_terminateFn = (ADLXTerminate_Fn)adlx_get_proc_address (m_hDLLHandle, ADLX_TERMINATE_FUNCTION_NAME);
         }
     }
 
-    if (m_fullVersionFn && m_versionFn && m_initWithADLFn && m_initFnEx && m_initFn && m_terminateFn)
+    if (m_fullVersionFn && m_versionFn && m_initWithADLFn && ((m_init2FnEx && m_init2Fn) || (m_initFnEx && m_initFn)) && m_terminateFn)
     {
         return ADLX_OK;
     }
@@ -138,15 +144,21 @@ ADLX_RESULT ADLXHelper::InitializePrivate(adlx_handle  adlContext, ADLX_ADL_Main
         {
             if (useIncompatibleDriver)
             {
-                res = m_initFnEx (ADLX_FULL_VERSION, &m_pSystemServices);
+                if (m_init2FnEx)
+                    res = m_init2FnEx (ADLX_FULL_VERSION, &m_pSystemServices, &m_pAdlMapping);
+                else
+                    res = m_initFnEx (ADLX_FULL_VERSION, &m_pSystemServices);
             }
             else
             {
-                res = m_initFn (ADLX_FULL_VERSION, &m_pSystemServices);
+                if (m_init2Fn)
+                    res = m_init2Fn (ADLX_FULL_VERSION, &m_pSystemServices, &m_pAdlMapping);
+                else
+                    res = m_initFn (ADLX_FULL_VERSION, &m_pSystemServices);
             }
         }
         return res;
     }
 
     return ADLX_FAIL;
-}
+}

SDK/ADLXHelper/Windows/Cpp/ADLXHelper.h

@@ -1,5 +1,5 @@
 //
-// Copyright (c) 2021 - 2025 Advanced Micro Devices, Inc. All rights reserved.
+// Copyright Advanced Micro Devices, Inc. All rights reserved.
 //
 //-------------------------------------------------------------------------------------------------
 
@@ -340,6 +340,12 @@ class ADLXHelper
     //ADLX function - initialize
     ADLXInitialize_Fn m_initFn = nullptr;
 
+    //ADLX function - initialize with incompatible driver
+    ADLXInitialize2_Fn m_init2FnEx = nullptr;
+
+    //ADLX function - initialize
+    ADLXInitialize2_Fn m_init2Fn = nullptr;
+
     //ADLX function - terminate
     ADLXTerminate_Fn m_terminateFn = nullptr;
 
@@ -352,4 +358,4 @@ class ADLXHelper
 
 extern ::ADLXHelper g_ADLX;
 
-#endif //ADLX_ADLXHelper_h
+#endif //ADLX_ADLXHelper_h

SDK/Include/ADLX.h

@@ -1,5 +1,5 @@
 //
-// Copyright (c) 2021 - 2025 Advanced Micro Devices, Inc. All rights reserved.
+// Copyright Advanced Micro Devices, Inc. All rights reserved.
 //
 //-------------------------------------------------------------------------------------------------
 
@@ -132,17 +132,39 @@ typedef void (ADLX_STD_CALL* ADLX_ADL_Main_Memory_Free)(void** buffer);
   */
 #define ADLX_INIT_FUNCTION_NAME                             "ADLXInitialize"
 
-  /**
-   * @def ADLX_INIT_WITH_INCOMPATIBLE_DRIVER_FUNCTION_NAME
-   * @ingroup ADLXMacro
-   * @ENG_START_DOX The function name of ADLXInitializeWithIncompatibleDriver @ENG_END_DOX
-   * @definition
-   *  @codeStart
-   *   \#define ADLX_INIT_WITH_INCOMPATIBLE_DRIVER_FUNCTION_NAME          "ADLXInitializeWithIncompatibleDriver"
-   *  @codeEnd
-   */
+/**
+ * @def ADLX_INIT_WITH_INCOMPATIBLE_DRIVER_FUNCTION_NAME
+ * @ingroup ADLXMacro
+ * @ENG_START_DOX The function name of ADLXInitializeWithIncompatibleDriver @ENG_END_DOX
+ * @definition
+ *  @codeStart
+ *   \#define ADLX_INIT_WITH_INCOMPATIBLE_DRIVER_FUNCTION_NAME          "ADLXInitializeWithIncompatibleDriver"
+ *  @codeEnd
+ */
 #define ADLX_INIT_WITH_INCOMPATIBLE_DRIVER_FUNCTION_NAME          "ADLXInitializeWithIncompatibleDriver"
 
+ /**
+  * @def ADLX_INIT2_FUNCTION_NAME
+  * @ingroup ADLXMacro
+  * @ENG_START_DOX The function name of ADLXInitialize2 @ENG_END_DOX
+  * @definition
+  *  @codeStart
+  *   \#define ADLX_INIT2_FUNCTION_NAME                             "ADLXInitialize2"
+  *  @codeEnd
+  */
+#define ADLX_INIT2_FUNCTION_NAME                             "ADLXInitialize2"
+
+/**
+ * @def ADLX_INIT_WITH_INCOMPATIBLE_DRIVER_FUNCTION_NAME
+ * @ingroup ADLXMacro
+ * @ENG_START_DOX The function name of ADLXInitializeWithIncompatibleDriver @ENG_END_DOX
+ * @definition
+ *  @codeStart
+ *   \#define ADLX_INIT2_WITH_INCOMPATIBLE_DRIVER_FUNCTION_NAME          "ADLXInitializeWithIncompatibleDriver2"
+ *  @codeEnd
+ */
+#define ADLX_INIT2_WITH_INCOMPATIBLE_DRIVER_FUNCTION_NAME          "ADLXInitializeWithIncompatibleDriver2"
+
 /**
 * @def ADLX_INIT_WITH_CALLER_ADL_FUNCTION_NAME
 * @ingroup ADLXMacro
@@ -278,6 +300,44 @@ extern "C"
     */
     typedef ADLX_RESULT (ADLX_CDECL_CALL *ADLXInitialize_Fn)(adlx_uint64 version, adlx::IADLXSystem** ppSystem);
 
+    /**
+    * @page page_ADLXInitialize2_Fn ADLXInitialize2_Fn
+    * @ENG_START_DOX
+    * @brief A pointer to the function to initialize ADLX with default parameters or a pointer to the function to initialize ADLX with a legacy driver.
+    * @ENG_END_DOX
+    *
+    * @syntax
+    * @codeStart
+    *  typedef @ref ADLX_RESULT (ADLX_CDECL_CALL *ADLXInitialize2_Fn)(adlx_uint64 version, @ref DOX_IADLXSystem** ppSystem, @ref DOX_IADLMapping** ppAdlMapping)
+    * @codeEnd
+    * @params
+    * @paramrow{1.,[in],version,adlx_uint64,@ENG_START_DOX The version of ADLX. @ENG_END_DOX}
+    * @paramrow{1.,[out],ppSystem,@ref DOX_IADLXSystem**,@ENG_START_DOX The address of a pointer to the ADLX system interface. If ADLX initialization failed\, the method sets the dereferenced address __*ppSystem__ to __nullptr__. @ENG_END_DOX}
+    * @paramrow{3.,[out],ppAdlMapping,@ref DOX_IADLMapping**,@ENG_START_DOX The address of a pointer to the ADLX mapping interface. If ADLX initialization failed\, the method sets the dereferenced address __*ppAdlMapping__ to __nullptr__. @ENG_END_DOX}    
+    *
+    * @retvalues
+    * @ENG_START_DOX
+    * If ADLX was successfully initialized, __ADLX_OK__ is returned.<br>
+    * If ADLX was not successfully initialized, an error code is returned.<br>
+    * Refer to @ref ADLX_RESULT for success codes and error codes.<br>
+    * @detaileddesc
+    * The pointer of the function is returned by the @ref adlx_get_proc_address using the @ref ADLX_INIT_FUNCTION_NAME or @ref ADLX_INIT_WITH_INCOMPATIBLE_DRIVER_FUNCTION_NAME as the function name.
+    * @ENG_END_DOX
+    * @requirements
+    * @DetailsTable{#include "ADLX.h", @ADLX_1_5_Ver}
+    */
+
+    /**
+    * @typedef ADLXInitialize2_Fn
+    * @ingroup ADLXDefs
+    * @ENG_START_DOX The typedef of ADLXInitialize function. @ENG_END_DOX
+    * @definition
+    *  @codeStart
+    *  typedef @ref ADLX_RESULT (ADLX_CDECL_CALL *ADLXInitialize2_Fn)(adlx_uint64 version, @ref DOX_IADLXSystem** ppSystem, @ref DOX_IADLMapping** ppAdlMapping)
+    *  @codeEnd
+    */
+    typedef ADLX_RESULT (ADLX_CDECL_CALL *ADLXInitialize2_Fn)(adlx_uint64 version, adlx::IADLXSystem** ppSystem, adlx::IADLMapping** ppAdlMapping);
+
     /**
     * @page page_ADLXInitializeWithCallerAdl_Fn ADLXInitializeWithCallerAdl_Fn
     * @ENG_START_DOX
@@ -358,10 +418,11 @@ extern "C"
 typedef ADLX_RESULT (ADLX_CDECL_CALL *ADLXQueryFullVersion_Fn)(adlx_uint64* fullVersion);
 typedef ADLX_RESULT (ADLX_CDECL_CALL *ADLXQueryVersion_Fn)(const char** version);
 typedef ADLX_RESULT (ADLX_CDECL_CALL *ADLXInitialize_Fn)(adlx_uint64 version, IADLXSystem** ppSystem);
+typedef ADLX_RESULT (ADLX_CDECL_CALL *ADLXInitialize2_Fn)(adlx_uint64 version, IADLXSystem** ppSystem, IADLMapping** ppAdlMapping);
 typedef ADLX_RESULT (ADLX_CDECL_CALL *ADLXInitializeWithCallerAdl_Fn)(adlx_uint64 version, IADLXSystem** ppSystem, IADLMapping** ppAdlMapping, adlx_handle adlContext, ADLX_ADL_Main_Memory_Free adlMainMemoryFree);
 typedef ADLX_RESULT (ADLX_CDECL_CALL *ADLXTerminate_Fn)();
 #endif
 
 #pragma endregion C-style functions
 
-#endif  //ADLX_H
+#endif  //ADLX_H