docs(linux): configs: Add replacement and configuration variables

sinha-shreyash · ravi-rahul · commit 540a8ec5b51c · 2024-12-05T13:33:05.000+05:30
added '__IMAGE_TYPE__' and 'CONFIG_image_type' in non-Focus SDK platforms

Signed-off-by: Shreyash Sinha &lt;s-sinha@ti.com&gt;
diff --git a/.rstcheck.cfg b/.rstcheck.cfg
@@ -3,4 +3,4 @@ ignore_directives = ifconfig
 # ignore the following languages because they require external compilers and
 # snippets in this repo depend on external code
 ignore_languages = c,cpp,c++
-ignore_substitutions = __PART_FAMILY_NAME__,__PART_FAMILY_DEVICE_NAMES__,__PRODUCT_LINE_NAME__,__SDK_BUILD_MACHINE__,__SDK_FULL_NAME__,__SDK_SHORT_NAME__,__SDK_INSTALL_FILE__,__SDK_INSTALL_DIR__,__SDK_DOWNLOAD_URL__,__LINUX_UBUNTU_VERSION_LONG__,__LINUX_UBUNTU_VERSION_SHORT__,__OPTEE_PLATFORM_FLAVOR__,__RTOS_UBUNTU_VERSION_LONG__,__WINDOWS_SUPPORTED_LONG__,__FEATURINGMATRIX__,__SYSFW_CORE_NAME__,__PCIE_BASE_ADDRESS__,__PCIE_DEVICE_ID__
+ignore_substitutions = __PART_FAMILY_NAME__,__PART_FAMILY_DEVICE_NAMES__,__PRODUCT_LINE_NAME__,__SDK_BUILD_MACHINE__,__SDK_FULL_NAME__,__SDK_SHORT_NAME__,__SDK_INSTALL_FILE__,__SDK_INSTALL_DIR__,__SDK_DOWNLOAD_URL__,__LINUX_UBUNTU_VERSION_LONG__,__LINUX_UBUNTU_VERSION_SHORT__,__OPTEE_PLATFORM_FLAVOR__,__RTOS_UBUNTU_VERSION_LONG__,__WINDOWS_SUPPORTED_LONG__,__FEATURINGMATRIX__,__SYSFW_CORE_NAME__,__PCIE_BASE_ADDRESS__,__PCIE_DEVICE_ID__,__IMAGE_TYPE__
diff --git a/configs/AM335X/AM335X_linux_config.txt b/configs/AM335X/AM335X_linux_config.txt
@@ -28,12 +28,14 @@ Replacement Variables
 '__WINDOWS_SUPPORTED_LONG__'     : '7 (64-bit)'
 '__FEATURINGMATRIX__'            : 'featuring Matrix'
 '__SYSFW_CORE_NAME__'            : \
+'__IMAGE_TYPE__'                 : 'default'
 
 Configuration Values
 --------------------
 'CONFIG_part_family'      : 'AM335X_family'
 'CONFIG_part_variant'     : 'AM335X'
 'CONFIG_sdk'              : 'SITARA'
+'CONFIG_image_type'       : 'default'
 'CONFIG_icss_support'     : 'yes'
 'CONFIG_rt_linux_support' : 'yes'
 'CONFIG_gpu_ip'           : 'SGX'
diff --git a/configs/AM437X/AM437X_linux_config.txt b/configs/AM437X/AM437X_linux_config.txt
@@ -28,12 +28,14 @@ Replacement Variables
 '__WINDOWS_SUPPORTED_LONG__'     : '7 (64-bit)'
 '__FEATURINGMATRIX__'            : 'featuring Matrix'
 '__SYSFW_CORE_NAME__'            : \
+'__IMAGE_TYPE__'                 : 'default'
 
 Configuration Values
 --------------------
 'CONFIG_part_family'      : 'AM437X_family'
 'CONFIG_part_variant'     : 'AM437X'
 'CONFIG_sdk'              : 'SITARA'
+'CONFIG_image_type'       : 'default'
 'CONFIG_icss_support'     : 'yes'
 'CONFIG_rt_linux_support' : 'yes'
 'CONFIG_gpu_ip'           : 'SGX'
diff --git a/configs/AM57X/AM57X_linux_config.txt b/configs/AM57X/AM57X_linux_config.txt
@@ -29,12 +29,14 @@ Replacement Variables
 '__WINDOWS_SUPPORTED_LONG__'     : '7 (64-bit)'
 '__FEATURINGMATRIX__'            : \
 '__SYSFW_CORE_NAME__'            : \
+'__IMAGE_TYPE__'                 : 'default'
 
 Configuration Values
 --------------------
 'CONFIG_part_family'      : 'AM57X_family'
 'CONFIG_part_variant'     : 'AM57X'
 'CONFIG_sdk'              : 'JACINTO'
+'CONFIG_image_type'       : 'default'
 'CONFIG_icss_support'     : 'yes'
 'CONFIG_rt_linux_support' : 'yes'
 'CONFIG_gpu_ip'           : 'SGX'
diff --git a/configs/AM62PX/AM62PX_linux_config.txt b/configs/AM62PX/AM62PX_linux_config.txt
@@ -30,12 +30,14 @@ Replacement Variables
 '__WINDOWS_SUPPORTED_LONG__'     : '10 (64-bit)'
 '__FEATURINGMATRIX__'            : \
 '__SYSFW_CORE_NAME__'            : 'TIFS'
+'__IMAGE_TYPE__'                 : 'default'
 
 Configuration Values
 --------------------
 'CONFIG_part_family'      : 'AM62PX_family'
 'CONFIG_part_variant'     : 'AM62PX'
 'CONFIG_sdk'              : 'SITARA'
+'CONFIG_image_type'       : 'default'
 'CONFIG_icss_support'     : 'yes'
 'CONFIG_rt_linux_support' : 'yes'
 'CONFIG_gpu_ip'           : 'Rogue_BXS'
diff --git a/configs/AM62X/AM62X_linux_config.txt b/configs/AM62X/AM62X_linux_config.txt
@@ -30,12 +30,14 @@ Replacement Variables
 '__WINDOWS_SUPPORTED_LONG__'     : '10 (64-bit)'
 '__FEATURINGMATRIX__'            : \
 '__SYSFW_CORE_NAME__'            : 'TIFS'
+'__IMAGE_TYPE__'                 : 'default'
 
 Configuration Values
 --------------------
 'CONFIG_part_family'      : 'AM62X_family'
 'CONFIG_part_variant'     : 'AM62X'
 'CONFIG_sdk'              : 'SITARA'
+'CONFIG_image_type'       : 'default'
 'CONFIG_icss_support'     : 'yes'
 'CONFIG_rt_linux_support' : 'yes'
 'CONFIG_gpu_ip'           : 'Rogue_AXE'
diff --git a/configs/AM64X/AM64X_linux_config.txt b/configs/AM64X/AM64X_linux_config.txt
@@ -32,12 +32,14 @@ Replacement Variables
 '__SYSFW_CORE_NAME__'            : 'DMSC'
 '__PCIE_BASE_ADDRESS__'          : 'f102000'
 '__PCIE_DEVICE_ID__'             : '0xb010'
+'__IMAGE_TYPE__'                 : 'default'
 
 Configuration Values
 --------------------
 'CONFIG_part_family'      : 'AM64X_family'
 'CONFIG_part_variant'     : 'AM64X'
 'CONFIG_sdk'              : 'SITARA'
+'CONFIG_image_type'       : 'default'
 'CONFIG_icss_support'     : 'yes'
 'CONFIG_rt_linux_support' : 'yes'
 'CONFIG_gpu_ip'           : \
diff --git a/configs/AM65X/AM65X_linux_config.txt b/configs/AM65X/AM65X_linux_config.txt
@@ -29,12 +29,14 @@ Replacement Variables
 '__WINDOWS_SUPPORTED_LONG__'     : '7 (64-bit)'
 '__FEATURINGMATRIX__'            : \
 '__SYSFW_CORE_NAME__'            : 'DMSC'
+'__IMAGE_TYPE__'                 : 'default'
 
 Configuration Values
 --------------------
 'CONFIG_part_family'      : 'AM65X_family'
 'CONFIG_part_variant'     : 'AM65X'
 'CONFIG_sdk'              : 'SITARA'
+'CONFIG_image_type'       : 'default'
 'CONFIG_icss_support'     : 'yes'
 'CONFIG_rt_linux_support' : 'yes'
 'CONFIG_gpu_ip'           : 'SGX'
diff --git a/configs/AM67/AM67_linux_config.txt b/configs/AM67/AM67_linux_config.txt
@@ -29,12 +29,14 @@ Replacement Variables
 '__WINDOWS_SUPPORTED_LONG__'     : '7 (64-bit)'
 '__FEATURINGMATRIX__'            : \
 '__SYSFW_CORE_NAME__'            : 'TIFS'
+'__IMAGE_TYPE__'                 : 'default'
 
 Configuration Values
 --------------------
 'CONFIG_part_family'      : 'J7_family'
 'CONFIG_part_variant'     : 'J722S'
 'CONFIG_sdk'              : 'j7_foundational'
+'CONFIG_image_type'       : 'default'
 'CONFIG_icss_support'     : 'no'
 'CONFIG_rt_linux_support' : 'yes'
 'CONFIG_gpu_ip'           : 'Rogue_BXS'
diff --git a/configs/AM68/AM68_linux_config.txt b/configs/AM68/AM68_linux_config.txt
@@ -31,12 +31,14 @@ Replacement Variables
 '__SYSFW_CORE_NAME__'            : 'TIFS'
 '__PCIE_BASE_ADDRESS__'          : '2910000'
 '__PCIE_DEVICE_ID__'             : '0xb00d'
+'__IMAGE_TYPE__'                 : 'default'
 
 Configuration Values
 --------------------
 'CONFIG_part_family'      : 'J7_family'
 'CONFIG_part_variant'     : 'J721S2'
 'CONFIG_sdk'              : 'j7_foundational'
+'CONFIG_image_type'       : 'default'
 'CONFIG_icss_support'     : 'no'
 'CONFIG_rt_linux_support' : 'yes'
 'CONFIG_gpu_ip'           : 'Rogue_BXS'
diff --git a/configs/AM69/AM69_linux_config.txt b/configs/AM69/AM69_linux_config.txt
@@ -31,12 +31,14 @@ Replacement Variables
 '__SYSFW_CORE_NAME__'            : 'TIFS'
 '__PCIE_BASE_ADDRESS__'          : '2900000'
 '__PCIE_DEVICE_ID__'             : '0xb00d'
+'__IMAGE_TYPE__'                 : 'default'
 
 Configuration Values
 --------------------
 'CONFIG_part_family'      : 'J7_family'
 'CONFIG_part_variant'     : 'J784S4'
 'CONFIG_sdk'              : 'j7_foundational'
+'CONFIG_image_type'       : 'default'
 'CONFIG_icss_support'     : 'no'
 'CONFIG_rt_linux_support' : 'yes'
 'CONFIG_gpu_ip'           : 'Rogue_BXS'
diff --git a/configs/CORESDK/CORESDK_linux_config.txt b/configs/CORESDK/CORESDK_linux_config.txt
@@ -27,12 +27,14 @@ Replacement Variables
 '__WINDOWS_SUPPORTED_LONG__'     : '7 (64-bit)'
 '__FEATURINGMATRIX__'            : 'featuring Matrix'
 '__SYSFW_CORE_NAME__'            : \
+'__IMAGE_TYPE__'                 : 'default'
 
 Configuration Values
 --------------------
 'CONFIG_part_family'      : 'AM335X_family'
 'CONFIG_part_variant'     : 'AM335X'
 'CONFIG_sdk'              : 'SITARA'
+'CONFIG_image_type'       : 'default'
 'CONFIG_icss_support'     : 'no'
 'CONFIG_rt_linux_support' : 'yes'
 'CONFIG_gpu_ip'           : 'SGX'
diff --git a/configs/DRA821A/DRA821A_linux_config.txt b/configs/DRA821A/DRA821A_linux_config.txt
@@ -28,12 +28,14 @@ Replacement Variables
 '__WINDOWS_SUPPORTED_LONG__'     : '7 (64-bit)'
 '__FEATURINGMATRIX__'            : \
 '__SYSFW_CORE_NAME__'            : \
+'__IMAGE_TYPE__'                 : 'default'
 
 Configuration Values
 --------------------
 'CONFIG_part_family'      : 'J7_family'
 'CONFIG_part_variant'     : 'DRA821A'
 'CONFIG_sdk'              : 'JACINTO'
+'CONFIG_image_type'       : 'default'
 'CONFIG_icss_support'     : 'no'
 'CONFIG_rt_linux_support' : 'no'
 'CONFIG_gpu_ip'           : 'no'
diff --git a/configs/GEN/GEN_linux_config.txt b/configs/GEN/GEN_linux_config.txt
@@ -27,12 +27,14 @@ Replacement Variables
 '__RTOS_UBUNTU_VERSION_LONG__'   : '14.04 (64-bit), 16.04 (64-bit)'
 '__WINDOWS_SUPPORTED_LONG__'     : '7 (64-bit)'
 '__FEATURINGMATRIX__'            : 'featuring Matrix'
+'__IMAGE_TYPE__'                 : 'default'
 
 Configuration Values
 --------------------
 'CONFIG_part_family'      : 'General_family'
 'CONFIG_part_variant'     : 'Gen'
 'CONFIG_sdk'              : 'SITARA'
+'CONFIG_image_type'       : 'default'
 'CONFIG_icss_support'     : 'yes'
 'CONFIG_rt_linux_support' : 'yes'
 'CONFIG_gpu_ip'           : 'SGX'
diff --git a/configs/J7200/J7200_linux_config.txt b/configs/J7200/J7200_linux_config.txt
@@ -31,12 +31,14 @@ Replacement Variables
 '__SYSFW_CORE_NAME__'            : 'DMSC'
 '__PCIE_BASE_ADDRESS__'          : '2910000'
 '__PCIE_DEVICE_ID__'             : '0xb00f'
+'__IMAGE_TYPE__'                 : 'default'
 
 Configuration Values
 --------------------
 'CONFIG_part_family'      : 'J7_family'
 'CONFIG_part_variant'     : 'J7200'
 'CONFIG_sdk'              : 'JACINTO'
+'CONFIG_image_type'       : 'default'
 'CONFIG_icss_support'     : 'no'
 'CONFIG_rt_linux_support' : 'yes'
 'CONFIG_gpu_ip'           : 'Rogue_8XE'
