Zephyr Project API  3.1.0
A Scalable Open Source RTOS
linker-defs.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2013-2014, Wind River Systems, Inc.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7/*
8 * DESCRIPTION
9 * Platform independent, commonly used macros and defines related to linker
10 * script.
11 *
12 * This file may be included by:
13 * - Linker script files: for linker section declarations
14 * - C files: for external declaration of address or size of linker section
15 * - Assembly files: for external declaration of address or size of linker
16 * section
17 */
18
19#ifndef ZEPHYR_INCLUDE_LINKER_LINKER_DEFS_H_
20#define ZEPHYR_INCLUDE_LINKER_LINKER_DEFS_H_
21
22#include <zephyr/toolchain.h>
23#include <zephyr/toolchain/common.h>
24#include <zephyr/linker/sections.h>
25#include <zephyr/sys/util.h>
26#include <offsets.h>
27
28/* We need to dummy out DT_NODE_HAS_STATUS when building the unittests.
29 * Including devicetree.h would require generating dummy header files
30 * to match what gen_defines creates, so it's easier to just dummy out
31 * DT_NODE_HAS_STATUS.
32 */
33#ifdef ZTEST_UNITTEST
34#define DT_NODE_HAS_STATUS(node, status) 0
35#else
36#include <zephyr/linker/devicetree_reserved.h>
37#include <zephyr/devicetree.h>
38#endif
39
40#ifdef _LINKER
41
47#define Z_LINK_ITERABLE(struct_type) \
48 _CONCAT(_##struct_type, _list_start) = .; \
49 KEEP(*(SORT_BY_NAME(._##struct_type.static.*))); \
50 _CONCAT(_##struct_type, _list_end) = .
51
52#define Z_LINK_ITERABLE_ALIGNED(struct_type, align) \
53 . = ALIGN(align); \
54 Z_LINK_ITERABLE(struct_type);
55
56#define Z_LINK_ITERABLE_GC_ALLOWED(struct_type) \
57 _CONCAT(_##struct_type, _list_start) = .; \
58 *(SORT_BY_NAME(._##struct_type.static.*)); \
59 _CONCAT(_##struct_type, _list_end) = .
60
75#define ITERABLE_SECTION_ROM(struct_type, subalign) \
76 SECTION_PROLOGUE(struct_type##_area,,SUBALIGN(subalign)) \
77 { \
78 Z_LINK_ITERABLE(struct_type); \
79 } GROUP_ROM_LINK_IN(RAMABLE_REGION, ROMABLE_REGION)
80
93#define ITERABLE_SECTION_ROM_GC_ALLOWED(struct_type, subalign) \
94 SECTION_PROLOGUE(struct_type##_area,,SUBALIGN(subalign)) \
95 { \
96 Z_LINK_ITERABLE_GC_ALLOWED(struct_type); \
97 } GROUP_LINK_IN(ROMABLE_REGION)
98
113#define ITERABLE_SECTION_RAM(struct_type, subalign) \
114 SECTION_DATA_PROLOGUE(struct_type##_area,,SUBALIGN(subalign)) \
115 { \
116 Z_LINK_ITERABLE(struct_type); \
117 } GROUP_DATA_LINK_IN(RAMABLE_REGION, ROMABLE_REGION)
118
131#define ITERABLE_SECTION_RAM_GC_ALLOWED(struct_type, subalign) \
132 SECTION_DATA_PROLOGUE(struct_type##_area,,SUBALIGN(subalign)) \
133 { \
134 Z_LINK_ITERABLE_GC_ALLOWED(struct_type); \
135 } GROUP_DATA_LINK_IN(RAMABLE_REGION, ROMABLE_REGION)
136 /* end of struct_section_apis */
140
141/*
142 * generate a symbol to mark the start of the objects array for
143 * the specified object and level, then link all of those objects
144 * (sorted by priority). Ensure the objects aren't discarded if there is
145 * no direct reference to them
146 */
147#define CREATE_OBJ_LEVEL(object, level) \
148 __##object##_##level##_start = .; \
149 KEEP(*(SORT(.z_##object##_##level[0-9]_*))); \
150 KEEP(*(SORT(.z_##object##_##level[1-9][0-9]_*)));
151
152/*
153 * link in shell initialization objects for all modules that use shell and
154 * their shell commands are automatically initialized by the kernel.
155 */
156
157#elif defined(_ASMLANGUAGE)
158
159/* Assembly FILES: declaration defined by the linker script */
160GDATA(__bss_start)
161GDATA(__bss_num_words)
162#ifdef CONFIG_XIP
163GDATA(__data_region_load_start)
164GDATA(__data_region_start)
165GDATA(__data_region_num_words)
166#endif
167
168#else /* ! _ASMLANGUAGE */
169
170#include <zephyr/types.h>
171/*
172 * Memory owned by the kernel, to be used as shared memory between
173 * application threads.
174 *
175 * The following are extern symbols from the linker. This enables
176 * the dynamic k_mem_domain and k_mem_partition creation and alignment
177 * to the section produced in the linker.
178
179 * The policy for this memory will be to initially configure all of it as
180 * kernel / supervisor thread accessible.
181 */
182extern char _app_smem_start[];
183extern char _app_smem_end[];
184extern char _app_smem_size[];
185extern char _app_smem_rom_start[];
186extern char _app_smem_num_words[];
187
188#ifdef CONFIG_LINKER_USE_PINNED_SECTION
189extern char _app_smem_pinned_start[];
190extern char _app_smem_pinned_end[];
191extern char _app_smem_pinned_size[];
192extern char _app_smem_pinned_num_words[];
193#endif
194
195/* Memory owned by the kernel. Start and end will be aligned for memory
196 * management/protection hardware for the target architecture.
197 *
198 * Consists of all kernel-side globals, all kernel objects, all thread stacks,
199 * and all currently unused RAM.
200 *
201 * Except for the stack of the currently executing thread, none of this memory
202 * is normally accessible to user threads unless specifically granted at
203 * runtime.
204 */
205extern char __kernel_ram_start[];
206extern char __kernel_ram_end[];
207extern char __kernel_ram_size[];
208
209/* Used by z_bss_zero or arch-specific implementation */
210extern char __bss_start[];
211extern char __bss_end[];
212
213/* Used by z_data_copy() or arch-specific implementation */
214#ifdef CONFIG_XIP
215extern char __data_region_load_start[];
216extern char __data_region_start[];
217extern char __data_region_end[];
218#endif /* CONFIG_XIP */
219
220#ifdef CONFIG_MMU
221/* Virtual addresses of page-aligned kernel image mapped into RAM at boot */
222extern char z_mapped_start[];
223extern char z_mapped_end[];
224#endif /* CONFIG_MMU */
225
226/* Includes text and rodata */
227extern char __rom_region_start[];
228extern char __rom_region_end[];
229extern char __rom_region_size[];
230
231/* Includes all ROMable data, i.e. the size of the output image file. */
232extern char _flash_used[];
233
234/* datas, bss, noinit */
235extern char _image_ram_start[];
236extern char _image_ram_end[];
237
238extern char __text_region_start[];
239extern char __text_region_end[];
240extern char __text_region_size[];
241
242extern char __rodata_region_start[];
243extern char __rodata_region_end[];
244extern char __rodata_region_size[];
245
246extern char _vector_start[];
247extern char _vector_end[];
248
249#if DT_NODE_HAS_STATUS(_NODE_RESERVED, okay)
250LINKER_DT_RESERVED_MEM_SYMBOLS()
251#endif
252
253#ifdef CONFIG_SW_VECTOR_RELAY
254extern char __vector_relay_table[];
255#endif
256
257#ifdef CONFIG_COVERAGE_GCOV
258extern char __gcov_bss_start[];
259extern char __gcov_bss_end[];
260extern char __gcov_bss_size[];
261#endif /* CONFIG_COVERAGE_GCOV */
262
263/* end address of image, used by newlib for the heap */
264extern char _end[];
265
266#if DT_NODE_HAS_STATUS(DT_CHOSEN(zephyr_ccm), okay)
267extern char __ccm_data_rom_start[];
268extern char __ccm_start[];
269extern char __ccm_data_start[];
270extern char __ccm_data_end[];
271extern char __ccm_bss_start[];
272extern char __ccm_bss_end[];
273extern char __ccm_noinit_start[];
274extern char __ccm_noinit_end[];
275extern char __ccm_end[];
276#endif
277
278#if DT_NODE_HAS_STATUS(DT_CHOSEN(zephyr_itcm), okay)
279extern char __itcm_start[];
280extern char __itcm_end[];
281extern char __itcm_size[];
282extern char __itcm_load_start[];
283#endif
284
285#if DT_NODE_HAS_STATUS(DT_CHOSEN(zephyr_dtcm), okay)
286extern char __dtcm_data_start[];
287extern char __dtcm_data_end[];
288extern char __dtcm_bss_start[];
289extern char __dtcm_bss_end[];
290extern char __dtcm_noinit_start[];
291extern char __dtcm_noinit_end[];
292extern char __dtcm_data_load_start[];
293extern char __dtcm_start[];
294extern char __dtcm_end[];
295#endif
296
297#if DT_NODE_HAS_STATUS(DT_CHOSEN(zephyr_ocm), okay)
298extern char __ocm_data_start[];
299extern char __ocm_data_end[];
300extern char __ocm_bss_start[];
301extern char __ocm_bss_end[];
302extern char __ocm_start[];
303extern char __ocm_end[];
304extern char __ocm_size[];
305#endif
306
307/* Used by the Security Attribution Unit to configure the
308 * Non-Secure Callable region.
309 */
310#ifdef CONFIG_ARM_FIRMWARE_HAS_SECURE_ENTRY_FUNCS
311extern char __sg_start[];
312extern char __sg_end[];
313extern char __sg_size[];
314#endif /* CONFIG_ARM_FIRMWARE_HAS_SECURE_ENTRY_FUNCS */
315
316/*
317 * Non-cached kernel memory region, currently only available on ARM Cortex-M7
318 * with a MPU. Start and end will be aligned for memory management/protection
319 * hardware for the target architecture.
320 *
321 * All the functions with '__nocache' keyword will be placed into this
322 * section.
323 */
324#ifdef CONFIG_NOCACHE_MEMORY
325extern char _nocache_ram_start[];
326extern char _nocache_ram_end[];
327extern char _nocache_ram_size[];
328#endif /* CONFIG_NOCACHE_MEMORY */
329
330/* Memory owned by the kernel. Start and end will be aligned for memory
331 * management/protection hardware for the target architecture.
332 *
333 * All the functions with '__ramfunc' keyword will be placed into this
334 * section, stored in RAM instead of FLASH.
335 */
336#ifdef CONFIG_ARCH_HAS_RAMFUNC_SUPPORT
337extern char __ramfunc_start[];
338extern char __ramfunc_end[];
339extern char __ramfunc_size[];
340extern char __ramfunc_load_start[];
341#endif /* CONFIG_ARCH_HAS_RAMFUNC_SUPPORT */
342
343/* Memory owned by the kernel. Memory region for thread privilege stack buffers,
344 * currently only applicable on ARM Cortex-M architecture when building with
345 * support for User Mode.
346 *
347 * All thread privilege stack buffers will be placed into this section.
348 */
349#ifdef CONFIG_USERSPACE
350extern char z_priv_stacks_ram_start[];
351extern char z_priv_stacks_ram_end[];
352extern char z_user_stacks_start[];
353extern char z_user_stacks_end[];
354extern char z_kobject_data_begin[];
355#endif /* CONFIG_USERSPACE */
356
357#ifdef CONFIG_THREAD_LOCAL_STORAGE
358extern char __tdata_start[];
359extern char __tdata_end[];
360extern char __tdata_size[];
361extern char __tdata_align[];
362extern char __tbss_start[];
363extern char __tbss_end[];
364extern char __tbss_size[];
365extern char __tbss_align[];
366extern char __tls_start[];
367extern char __tls_end[];
368extern char __tls_size[];
369#endif /* CONFIG_THREAD_LOCAL_STORAGE */
370
371#ifdef CONFIG_LINKER_USE_BOOT_SECTION
372/* lnkr_boot_start[] and lnkr_boot_end[]
373 * must encapsulate all the boot sections.
374 */
375extern char lnkr_boot_start[];
376extern char lnkr_boot_end[];
377
378extern char lnkr_boot_text_start[];
379extern char lnkr_boot_text_end[];
380extern char lnkr_boot_text_size[];
381extern char lnkr_boot_data_start[];
382extern char lnkr_boot_data_end[];
383extern char lnkr_boot_data_size[];
384extern char lnkr_boot_rodata_start[];
385extern char lnkr_boot_rodata_end[];
386extern char lnkr_boot_rodata_size[];
387extern char lnkr_boot_bss_start[];
388extern char lnkr_boot_bss_end[];
389extern char lnkr_boot_bss_size[];
390extern char lnkr_boot_noinit_start[];
391extern char lnkr_boot_noinit_end[];
392extern char lnkr_boot_noinit_size[];
393#endif /* CONFIG_LINKER_USE_BOOT_SECTION */
394
395#ifdef CONFIG_LINKER_USE_PINNED_SECTION
396/* lnkr_pinned_start[] and lnkr_pinned_end[] must encapsulate
397 * all the pinned sections as these are used by
398 * the MMU code to mark the physical page frames with
399 * Z_PAGE_FRAME_PINNED.
400 */
401extern char lnkr_pinned_start[];
402extern char lnkr_pinned_end[];
403
404extern char lnkr_pinned_text_start[];
405extern char lnkr_pinned_text_end[];
406extern char lnkr_pinned_text_size[];
407extern char lnkr_pinned_data_start[];
408extern char lnkr_pinned_data_end[];
409extern char lnkr_pinned_data_size[];
410extern char lnkr_pinned_rodata_start[];
411extern char lnkr_pinned_rodata_end[];
412extern char lnkr_pinned_rodata_size[];
413extern char lnkr_pinned_bss_start[];
414extern char lnkr_pinned_bss_end[];
415extern char lnkr_pinned_bss_size[];
416extern char lnkr_pinned_noinit_start[];
417extern char lnkr_pinned_noinit_end[];
418extern char lnkr_pinned_noinit_size[];
419
420__pinned_func
421static inline bool lnkr_is_pinned(uint8_t *addr)
422{
423 if ((addr >= (uint8_t *)lnkr_pinned_start) &&
424 (addr < (uint8_t *)lnkr_pinned_end)) {
425 return true;
426 } else {
427 return false;
428 }
429}
430
431__pinned_func
432static inline bool lnkr_is_region_pinned(uint8_t *addr, size_t sz)
433{
434 if ((addr >= (uint8_t *)lnkr_pinned_start) &&
435 ((addr + sz) < (uint8_t *)lnkr_pinned_end)) {
436 return true;
437 } else {
438 return false;
439 }
440}
441
442#endif /* CONFIG_LINKER_USE_PINNED_SECTION */
443
444#endif /* ! _ASMLANGUAGE */
445
446#endif /* ZEPHYR_INCLUDE_LINKER_LINKER_DEFS_H_ */
common.h
Common toolchain abstraction.
devicetree.h
Devicetree main header.
devicetree_reserved.h
LINKER_DT_RESERVED_MEM_SYMBOLS
#define LINKER_DT_RESERVED_MEM_SYMBOLS()
Generate linker script symbols for all the reserved memory regions.
Definition: devicetree_reserved.h:59
sections.h
Definitions of various linker Sections.
uint8_t
__UINT8_TYPE__ uint8_t
Definition: stdint.h:88
toolchain.h
Macros to abstract toolchain specific capabilities.
util.h
Misc utilities.