1# SPDX-License-Identifier: Apache-2.0
2
3set_property(TARGET linker PROPERTY devices_start_symbol "Image$$device$$Base")
4
5find_program(CMAKE_LINKER ${CROSS_COMPILE}armlink PATHS ${TOOLCHAIN_HOME} NO_DEFAULT_PATH)
6
7add_custom_target(armlink)
8
9function(toolchain_ld_force_undefined_symbols)
10  foreach(symbol ${ARGN})
11    zephyr_link_libraries(--undefined=${symbol})
12  endforeach()
13endfunction()
14
15macro(configure_linker_script linker_script_gen linker_pass_define)
16  set(STEERING_FILE)
17  set(STEERING_C)
18  set(STEERING_FILE_ARG)
19  set(STEERING_C_ARG)
20  set(linker_pass_define_list ${linker_pass_define})
21  set(cmake_linker_script_settings
22      ${PROJECT_BINARY_DIR}/include/generated/ld_script_settings_${linker_pass_define}.cmake
23  )
24
25  if("LINKER_ZEPHYR_FINAL" IN_LIST linker_pass_define_list)
26    set(STEERING_FILE ${CMAKE_CURRENT_BINARY_DIR}/armlink_symbol_steering.steer)
27    set(STEERING_C ${CMAKE_CURRENT_BINARY_DIR}/armlink_symbol_steering.c)
28    set(STEERING_FILE_ARG "-DSTEERING_FILE=${STEERING_FILE}")
29    set(STEERING_C_ARG "-DSTEERING_C=${STEERING_C}")
30  endif()
31
32  zephyr_linker_generate_linker_settings_file(${cmake_linker_script_settings})
33
34  add_custom_command(
35    OUTPUT ${linker_script_gen}
36           ${STEERING_FILE}
37           ${STEERING_C}
38    COMMAND ${CMAKE_COMMAND}
39      -C ${cmake_linker_script_settings}
40      -DPASS="${linker_pass_define}"
41      ${STEERING_FILE_ARG}
42      ${STEERING_C_ARG}
43      -DOUT_FILE=${CMAKE_CURRENT_BINARY_DIR}/${linker_script_gen}
44      -P ${ZEPHYR_BASE}/cmake/linker/armlink/scatter_script.cmake
45    DEPENDS ${DEVICE_API_LD_TARGET}
46            ${cmake_linker_script_settings}
47  )
48
49  if("LINKER_ZEPHYR_FINAL" IN_LIST linker_pass_define_list)
50    add_library(armlink_steering OBJECT ${STEERING_C})
51    target_link_libraries(armlink_steering PRIVATE zephyr_interface)
52  endif()
53endmacro()
54
55function(toolchain_ld_link_elf)
56  cmake_parse_arguments(
57    TOOLCHAIN_LD_LINK_ELF                                     # prefix of output variables
58    ""                                                        # list of names of the boolean arguments
59    "TARGET_ELF;OUTPUT_MAP;LINKER_SCRIPT"                     # list of names of scalar arguments
60    "LIBRARIES_PRE_SCRIPT;LIBRARIES_POST_SCRIPT;DEPENDENCIES" # list of names of list arguments
61    ${ARGN}                                                   # input args to parse
62  )
63
64  foreach(lib ${ZEPHYR_LIBS_PROPERTY})
65    if(NOT ${lib} STREQUAL arch__arm__core__cortex_m)
66      list(APPEND ZEPHYR_LIBS_OBJECTS $<TARGET_OBJECTS:${lib}>)
67      list(APPEND ZEPHYR_LIBS_OBJECTS $<TARGET_PROPERTY:${lib},LINK_LIBRARIES>)
68    endif()
69  endforeach()
70
71  target_link_libraries(
72    ${TOOLCHAIN_LD_LINK_ELF_TARGET_ELF}
73    ${TOOLCHAIN_LD_LINK_ELF_LIBRARIES_PRE_SCRIPT}
74    --scatter=${TOOLCHAIN_LD_LINK_ELF_LINKER_SCRIPT}
75    ${TOOLCHAIN_LD_LINK_ELF_LIBRARIES_POST_SCRIPT}
76    $<TARGET_OBJECTS:arch__arm__core__cortex_m>
77    --map --list=${TOOLCHAIN_LD_LINK_ELF_OUTPUT_MAP}
78    ${ZEPHYR_LIBS_OBJECTS}
79    kernel
80    $<TARGET_OBJECTS:${OFFSETS_LIB}>
81    --library_type=microlib
82    --entry=$<TARGET_PROPERTY:linker,ENTRY>
83    "--keep=\"*.o(.init_*)\""
84    "--keep=\"*.o(.device_*)\""
85    $<TARGET_OBJECTS:armlink_steering>
86    --edit=${CMAKE_CURRENT_BINARY_DIR}/armlink_symbol_steering.steer
87    # Resolving symbols using generated steering files will emit the warnings 6331 and 6332.
88    # Steering files are used because we want to be able to use `__device_end` instead of `Image$$device$$Limit`.
89    # Thus silence those two warnings.
90    --diag_suppress=6331,6332
91    # The scatter file is generated, and thus sometimes input sections are specified
92    # even though there will be no such sections found in the libraries linked.
93    --diag_suppress=6314
94    # We use empty execution sections in order to define custom symbols, such as
95    # __kernel_ram_x symbols, but nothing will go in those section, so silence
96    # the warning. Note, marking the section EMPTY causes armlink to reserve the
97    # address which in some cases leads to overlapping section errors.
98    --diag_suppress=6312
99    # Use of '.gnu.linkonce' sections. Those are used by ld, and # supported by armlink, albeit
100    # deprecated there. For current ARMClang support phase, we accept this warning, but we should
101    # look into changing to COMDAT groups.
102    --diag_suppress=6092
103    # Wildcard matching of keep sections, Those are needed for gnu ld, and thus we inherit the same
104    # keep flags and apply them to armlink. Consider adjusting keep flags per linker in future.
105    --diag_suppress=6319
106    # Match pattern for an unused section that is being removed.
107    --diag_suppress=6329
108    ${TOOLCHAIN_LIBS_OBJECTS}
109
110    ${TOOLCHAIN_LD_LINK_ELF_DEPENDENCIES}
111  )
112endfunction(toolchain_ld_link_elf)
113
114# This function will generate the correct CMAKE_C_LINK_EXECUTABLE / CMAKE_CXX_LINK_EXECUTABLE
115# rule to ensure that standard c and runtime libraries are correctly placed
116# and the end of link invocation and doesn't appear in the middle of the link
117# command invocation.
118macro(toolchain_linker_finalize)
119  set(zephyr_std_libs)
120  get_property(link_order TARGET linker PROPERTY link_order_library)
121  foreach(lib ${link_order})
122    get_property(link_flag TARGET linker PROPERTY ${lib}_library)
123    set(zephyr_std_libs "${zephyr_std_libs} ${link_flag}")
124  endforeach()
125
126  set(common_link "<LINK_FLAGS> <LINK_LIBRARIES> <OBJECTS> ${zephyr_std_libs} -o <TARGET>")
127  set(CMAKE_C_LINK_EXECUTABLE "<CMAKE_LINKER> <CMAKE_C_LINK_FLAGS> ${common_link}")
128  set(CMAKE_CXX_LINK_EXECUTABLE "<CMAKE_LINKER> <CMAKE_CXX_LINK_FLAGS> ${common_link}")
129  set(CMAKE_ASM_LINK_EXECUTABLE "<CMAKE_LINKER> <CMAKE_ASM_LINK_FLAGS> ${common_link}")
130endmacro()
131
132include(${ZEPHYR_BASE}/cmake/linker/ld/target_relocation.cmake)
133include(${ZEPHYR_BASE}/cmake/linker/ld/target_configure.cmake)
134