sections.h

/*
 * Copyright (c) 2020 Raspberry Pi (Trading) Ltd.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _PICO_PLATFORM_SECTION_MACROS_H
#define _PICO_PLATFORM_SECTION_MACROS_H
 
#ifndef __ASSEMBLER__

#ifndef __after_data
#define __after_data(group) __attribute__((section(".after_data." group)))
#endif

#ifndef __in_ram
#define __in_ram(group) __attribute__((section(".time_critical." group)))
#endif

#ifndef __in_scratch_x
#define __in_scratch_x(group) __attribute__((section(".scratch_x." group)))
#endif

#ifndef __scratch_x
#define __scratch_x(group) __in_scratch_x(group)
#endif

#ifndef __in_scratch_y
#define __in_scratch_y(group) __attribute__((section(".scratch_y." group)))
#endif

#ifndef __scratch_y
#define __scratch_y(group) __in_scratch_y(group)
#endif

#ifndef __in_psram
#define __in_psram(group) __attribute__((section(".psram_initialised." group)))
#endif

#ifndef __uninitialized_psram
#define __uninitialized_psram(group) __attribute__((section(".psram_uninitialised." group)))
#endif

#ifndef __in_xip_ram
#if PICO_USE_XIP_CACHE_AS_RAM || PICO_COMBINED_DOCS
#define __in_xip_ram(group) __attribute__((section(".xip_ram." group)))
#elif PICO_XIP_RAM
#define __in_xip_ram(group) __in_ram(group)
#else
#define __in_xip_ram(group) x; static_assert(false, "Must set PICO_USE_XIP_CACHE_AS_RAM=1 to use the __in_xip_ram macro");
#endif
#endif

#ifndef __uninitialized_ram
#define __uninitialized_ram(group) __attribute__((section(".uninitialized_data." #group))) group
#endif

#if (LIB_PICO_LOW_POWER && HAS_POWMAN_TIMER) || PICO_COMBINED_DOCS
#ifndef __persistent_data
#define __persistent_data(name) __attribute__((section(".persistent_data." #name))) name
#endif
#else
// If not supported, use the .bss section, as that will be zeroed on boot
#ifndef __persistent_data
#define __persistent_data(name) __attribute__((section(".bss." #name))) name
#endif
#endif

#ifndef __in_flash
#define __in_flash(group) __attribute__((section(".flashdata." group)))
#endif
 
// Above the doxygen, to avoid confusing it
#ifndef PICO_NOT_IN_FLASH_PLACEMENT
#define PICO_NOT_IN_FLASH_PLACEMENT __in_ram
#endif
#ifndef __not_in_flash
#define __not_in_flash(group) PICO_NOT_IN_FLASH_PLACEMENT(group)
#endif

#ifndef __not_in_flash_func
#define __not_in_flash_func(func_name) __not_in_flash(__STRING(func_name)) func_name
#endif

#ifndef __no_inline_not_in_flash_func
#define __no_inline_not_in_flash_func(func_name) __noinline __not_in_flash_func(func_name)
#endif
 
// Above the doxygen, to avoid confusing it
#ifndef PICO_TIME_CRITICAL_PLACEMENT
#define PICO_TIME_CRITICAL_PLACEMENT __in_ram
#endif

#ifndef __time_critical_func
#define __time_critical_func(func_name) PICO_TIME_CRITICAL_PLACEMENT(__STRING(func_name)) func_name
#endif

#ifndef __no_inline_time_critical_func
#define __no_inline_time_critical_func(func_name) __noinline __time_critical_func(func_name)
#endif
 
#else
 
#ifndef RAM_SECTION_NAME
#define RAM_SECTION_NAME(x) .time_critical.##x
#endif
 
#ifndef SECTION_NAME
#define SECTION_NAME(x) .text.##x
#endif
 
#endif // !__ASSEMBLER__
 
#endif