10540: Modify linker scripts to include the relavant Linker Fragments (zephyrproject-rtos#19)

linker: Updated Linker script with linker script fragments

Modified linker script to use linker script fragments and added MACROs
for section definitions

Signed-off-by: Adhil Xavier <adhil.xavier@ignitarium.com>

Author: Adhil-Ign

cmake/compiler/xcdsc/generic.cmake

@@ -3,6 +3,7 @@ set(CMAKE_SYSTEM_PROCESSOR ${ARCH})
 # Find and validate the xc-dsc-gcc compiler binary
 find_program(CMAKE_C_COMPILER xc-dsc-gcc PATHS ${XCDSC_TOOLCHAIN_PATH}/bin/ NO_DEFAULT_PATH REQUIRED )
 add_definitions(-D__XC_DSC__)
+add_definitions(-DQUICK_FIX_XCDSC_LINKER_EMPTY_OUTPUT_SECTION)
 # Get compiler version
 execute_process(
 	COMMAND ${CMAKE_C_COMPILER} --version

cmake/linker/xcdsc/target.cmake

@@ -19,7 +19,10 @@ macro(configure_linker_script linker_script_gen linker_pass_define)
                         ${extra_dependencies}
                         ${linker_script_dep}
                         COMMAND ${CMAKE_C_COMPILER} -x assembler-with-cpp -MD -MF ${linker_script_gen}.dep -MT ${linker_script_gen}
+                        -D_LINKER
+                        -D_ASM_LANGUAGE
                         -D__XCDSC_LINKER_CMD__
+                        -DQUICK_FIX_XCDSC_LINKER_EMPTY_OUTPUT_SECTION
                         -imacros ${AUTOCONF_H}
                         -I${ZEPHYR_BASE}/include
                         -imacros${ZEPHYR_BASE}/include/zephyr/linker/sections.h

include/zephyr/arch/dspic/linker.ld

@@ -1,12 +1,10 @@
+/*
+ * Copyright (c) 2025, Microchip Technology Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 /*
  * Generic Zephyr Linker Script
- *.
- * Note: For some of the input sections such as init levels and
- *       data sections and kernel objects needs to be added via
- *       linker script fragment files, At this point, only have added those
- *       input sections required and kept minimal because when adding
- *       linker script linker fragment files, it affects the syntax of
- *       XC-DSC Linker.
  */
 
 #include <zephyr/linker/sections.h>
@@ -27,11 +25,10 @@
 #define ROMABLE_REGION program
 #define RAMABLE_REGION data
 
-OUTPUT_ARCH("33AK128MC106")
+
 CRT0_STARTUP(reset0.S.obj)
 CRT1_STARTUP(reset1.S.obj)
 CRT_STARTMODE(crt_start_mode_normal)
-
 MEMORY
 {
     /* Memory map from the original target-specific script */
@@ -40,7 +37,6 @@ MEMORY
     /* Used by and documented in include/linker/intlist.ld */
     IDT_LIST (wx) : ORIGIN = 0xFFFFFFFF, LENGTH = 0
 }
-
 SECTIONS
 {
     /* Start of the ROM-based sections */
@@ -55,7 +51,6 @@ SECTIONS
         * table and debug information.
         */
         #include <snippets-rom-start.ld>
-
     } GROUP_LINK_IN(ROMABLE_REGION)
 
     /*
@@ -67,25 +62,41 @@ SECTIONS
     SECTION_PROLOGUE(._TEXT_SECTION_NAME,,)
     {
         __text_region_start = .;
+        #include <zephyr/linker/kobject-text.ld>
         *(.init);
         *(.text);
         *(.text*);
         *(.user_init);
         KEEP (*(.handle));
         KEEP (*(.isr*));
         *(.lib*);
-	    ___rodata_region_start = .;
-	    *(.rodata) *(.rodata.*)
-	    ___rodata_region_end = .;
-        *(.rodata)         /* Read-Only Data */
-        ___static_thread_data_list_start = .;
-        KEEP(*(SORT(.static_thread_data*)))
-        ___static_thread_data_list_end = .;
+        __text_region_end = .;
         . = ALIGN(4);
     } GROUP_LINK_IN(ROMABLE_REGION)
-    __text_region_end = .;
-    ITERABLE_SECTION_ROM_NUMERIC(service, Z_LINK_ITERABLE_SUBALIGN)
+
+    ___rodata_region_start = .;
+    #include <zephyr/linker/common-rom.ld>
+
+    /* Located in generated directory. This file is populated by calling
+    * zephyr_linker_sources(ROM_SECTIONS ...). Useful for grouping iterable RO structs.
+    */
+    #include <snippets-rom-sections.ld>
+    #include <zephyr/linker/thread-local-storage.ld>
+
+    SECTION_PROLOGUE(.rodata,,)
+    {
+        *(.rodata)
+        *(.rodata.*)
+        /* Located in generated directory. This file is populated by the
+        * zephyr_linker_sources() Cmake function.
+        */
+        #include <snippets-rodata.ld>
+        #include <zephyr/linker/kobject-rom.ld>
+    } GROUP_LINK_IN(ROMABLE_REGION)
+
     . = ALIGN(4);
+    ___rodata_region_end = .;
+    #include <zephyr/linker/cplusplus-rom.ld>
     GROUP_END(ROMABLE_REGION)
 
     /* Start of the RAM-based sections */
@@ -108,27 +119,32 @@ SECTIONS
         __data_region_start = .;
         *(.data)
         *(".data.*")
-        __device_list_start = .;
-        KEEP(*(SORT(.z_device*)))
-        __device_list_end = .;
-        /* Initialization levels: Early -> Application */
-        ___init_EARLY_start = .;
-        KEEP(*(SORT(.init_EARLY*)))
-        ___init_PRE_KERNEL_1_start = .;
-        KEEP(*(SORT(.init_PRE_KERNEL_1*)))
-        ___init_PRE_KERNEL_2_start = .;
-        KEEP(*(SORT(.init_PRE_KERNEL_2*)))
-        ___init_POST_KERNEL_start = .;
-        KEEP(*(SORT(.init_POST_KERNEL*)))
-        ___init_APPLICATION_start = .;
-        KEEP(*(SORT(.init_APPLICATION*)))
-        ___init_SMP_start = .;
-        KEEP(*(SORT(.init_SMP*)))
-        ___init_end = .;
-        __data_region_start = .;
+	    *(".kernel.*")
 
+        /* Located in generated directory. This file is populated by the
+        * zephyr_linker_sources() Cmake function.
+        */
+        #include <snippets-rwdata.ld>
+        __data_region_end = .;
     } GROUP_DATA_LINK_IN(RAMABLE_REGION, ROMABLE_REGION)
 
+    #include <zephyr/linker/common-ram.ld>
+
+    #include <zephyr/linker/kobject-data.ld>
+
+    #include <zephyr/linker/cplusplus-ram.ld>
+
+    /* Located in generated directory. This file is populated by the
+    * zephyr_linker_sources() Cmake function.
+    */
+    #include <snippets-data-sections.ld>
+
+    /* Located in generated directory. This file is populated by the
+    * zephyr_linker_sources() Cmake function.
+    */
+    #include <snippets-sections.ld>
+
+    #include <zephyr/linker/debug-sections.ld>
 
     /*
      * This section handles uninitialized data (BSS). It occupies space
@@ -145,7 +161,9 @@ SECTIONS
         ___bss_end = .;
     } GROUP_LINK_IN(RAMABLE_REGION)
 
+
     GROUP_END(RAMABLE_REGION)
+
 }
 
 /*

include/zephyr/linker/common-ram.ld

@@ -41,6 +41,9 @@ ITERABLE_SECTION_RAM(scmi_protocol, Z_LINK_ITERABLE_SUBALIGN)
 
         SECTION_DATA_PROLOGUE(device_states,,)
         {
+		#ifdef QUICK_FIX_XCDSC_LINKER_EMPTY_OUTPUT_SECTION
+			. = . + 4;
+		#endif
 		. = ALIGN(CONFIG_ARCH_DEVICE_STATE_ALIGN);
 		/* Device states used by the device objects. */
                 PLACE_SYMBOL_HERE(__device_states_start);
@@ -61,7 +64,11 @@ ITERABLE_SECTION_RAM(scmi_protocol, Z_LINK_ITERABLE_SUBALIGN)
 	} GROUP_DATA_LINK_IN(RAMABLE_REGION, ROMABLE_REGION)
 #endif 	/* CONFIG_DEVICE_DEPS_DYNAMIC */
 
+#ifdef QUICK_FIX_XCDSC_LINKER_EMPTY_OUTPUT_SECTION
+	#ifdef CONFIG_LOG_MODE_DEFERRED
 	ITERABLE_SECTION_RAM_GC_ALLOWED(log_mpsc_pbuf, Z_LINK_ITERABLE_SUBALIGN)
+	#endif
+#endif
 	ITERABLE_SECTION_RAM(log_msg_ptr, Z_LINK_ITERABLE_SUBALIGN)
 	ITERABLE_SECTION_RAM(log_dynamic, Z_LINK_ITERABLE_SUBALIGN)
 
@@ -90,8 +97,15 @@ ITERABLE_SECTION_RAM(scmi_protocol, Z_LINK_ITERABLE_SUBALIGN)
 	ITERABLE_SECTION_RAM_GC_ALLOWED(k_fifo, Z_LINK_ITERABLE_SUBALIGN)
 	ITERABLE_SECTION_RAM_GC_ALLOWED(k_lifo, Z_LINK_ITERABLE_SUBALIGN)
 	ITERABLE_SECTION_RAM_GC_ALLOWED(k_condvar, Z_LINK_ITERABLE_SUBALIGN)
+	/* For placing kernel objects section and "sys_mem_blocks_ptr" section using
+	 * same MACRO. Dummy instances were created for all kernel objects in application
+	 * but not for the below section. 
+	 */
+#ifdef QUICK_FIX_XCDSC_LINKER_EMPTY_OUTPUT_SECTION
+	#ifdef CONFIG_OBJ_CORE_SYS_MEM_BLOCKS 
 	ITERABLE_SECTION_RAM_GC_ALLOWED(sys_mem_blocks_ptr, Z_LINK_ITERABLE_SUBALIGN)
-
+	#endif
+#endif
 	ITERABLE_SECTION_RAM(net_buf_pool, Z_LINK_ITERABLE_SUBALIGN)
 
 #if defined(CONFIG_NETWORKING)

include/zephyr/linker/common-rom/common-rom-init.ld

@@ -3,6 +3,9 @@
 #if defined(CONFIG_TOOLCHAIN_SUPPORTS_STATIC_INIT_GNU) || defined(CONFIG_NATIVE_APPLICATION)
 	SECTION_PROLOGUE(init_array,,)
 	{
+		#ifdef QUICK_FIX_XCDSC_LINKER_EMPTY_OUTPUT_SECTION
+			. = . + 4;
+		#endif
 		/*
 		 * Add all of the GNU-style constructors in priority order. Note
 		 * that this doesn't build the ctors in the "usual" fashion with

include/zephyr/linker/common-rom/common-rom-kernel-devices.ld

@@ -82,13 +82,16 @@
 
 	SECTION_DATA_PROLOGUE(app_shmem_regions,,)
 	{
+
+		#ifdef QUICK_FIX_XCDSC_LINKER_EMPTY_OUTPUT_SECTION
+		. = . + 4;
+		#endif
 		PLACE_SYMBOL_HERE(__app_shmem_regions_start);
 		KEEP(*(SORT(.app_regions.*)));
 		PLACE_SYMBOL_HERE(__app_shmem_regions_end);
 	} GROUP_ROM_LINK_IN(RAMABLE_REGION, ROMABLE_REGION)
 
 	ITERABLE_SECTION_ROM(k_p4wq_initparam, Z_LINK_ITERABLE_SUBALIGN)
-
 	ITERABLE_SECTION_ROM(_static_thread_data, Z_LINK_ITERABLE_SUBALIGN)
 
 #if defined(CONFIG_PCIE)
@@ -98,8 +101,10 @@
 #if !defined(CONFIG_DEVICE_DEPS_DYNAMIC)
 	SECTION_DATA_PROLOGUE(device_deps,,)
 	{
+		#ifdef QUICK_FIX_XCDSC_LINKER_EMPTY_OUTPUT_SECTION
+			. = . + 4;
+		#endif
 #include <zephyr/linker/device-deps.ld>
 	} GROUP_ROM_LINK_IN(RAMABLE_REGION, ROMABLE_REGION)
 #endif /* !CONFIG_DEVICE_DEPS_DYNAMIC */
-
 #include <device-api-sections.ld>

include/zephyr/linker/common-rom/common-rom-misc.ld

@@ -46,6 +46,9 @@
 
 	SECTION_DATA_PROLOGUE(symbol_to_keep,,)
 	{
+		#ifdef QUICK_FIX_XCDSC_LINKER_EMPTY_OUTPUT_SECTION
+		. = . + 4;
+		#endif
 		PLACE_SYMBOL_HERE(__symbol_to_keep_start);
 		KEEP(*(SORT(.symbol_to_keep*)));
 		PLACE_SYMBOL_HERE(__symbol_to_keep_end);

include/zephyr/linker/iterable_sections.h

@@ -13,13 +13,27 @@
  */
 
 /* clang-format off */
+
+/* Microchip's XCDSC linker doesn't generate empty sections
+ * unlike the other toolchains. So adding a dummy byte to empty
+ * sections to create it otherwise will get an assertion fail
+ * error at build time. This workaround will be removed later
+ */
+#ifdef QUICK_FIX_XCDSC_LINKER_EMPTY_OUTPUT_SECTION
+#define Z_LINK_ITERABLE_PREFIX . = . + 4;
+#else
+#define Z_LINK_ITERABLE_PREFIX
+#endif
+
 #define Z_LINK_ITERABLE(struct_type) \
+	Z_LINK_ITERABLE_PREFIX	\
 	PLACE_SYMBOL_HERE(_CONCAT(_##struct_type, _list_start)); \
 	KEEP(*(SORT_BY_NAME(._##struct_type.static.*))); \
 	PLACE_SYMBOL_HERE(_CONCAT(_##struct_type, _list_end));
 
 
 #define Z_LINK_ITERABLE_NUMERIC(struct_type) \
+	Z_LINK_ITERABLE_PREFIX	\
 	PLACE_SYMBOL_HERE(_CONCAT(_##struct_type, _list_start)); \
 	KEEP(*(SORT(._##struct_type.static.*_?_*))); \
 	KEEP(*(SORT(._##struct_type.static.*_??_*))); \
@@ -36,6 +50,7 @@
 	PLACE_SYMBOL_HERE(_CONCAT(_##struct_type, _list_start)); \
 	*(SORT_BY_NAME(._##struct_type.static.*)); \
 	PLACE_SYMBOL_HERE(_CONCAT(_##struct_type, _list_end));
+
 /* clang-format on */
 
 #define Z_LINK_ITERABLE_SUBALIGN CONFIG_LINKER_ITERABLE_SUBALIGN