1 // Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD 2 // 3 // Licensed under the Apache License, Version 2.0 (the "License"); 4 // you may not use this file except in compliance with the License. 5 // You may obtain a copy of the License at 6 7 // http://www.apache.org/licenses/LICENSE-2.0 8 // 9 // Unless required by applicable law or agreed to in writing, software 10 // distributed under the License is distributed on an "AS IS" BASIS, 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 // See the License for the specific language governing permissions and 13 // limitations under the License. 14 #ifndef __ESP_ATTR_H__ 15 #define __ESP_ATTR_H__ 16 17 #include "sdkconfig.h" 18 19 #define ROMFN_ATTR 20 21 //Normally, the linker script will put all code and rodata in flash, 22 //and all variables in shared RAM. These macros can be used to redirect 23 //particular functions/variables to other memory regions. 24 25 // Forces code into IRAM instead of flash 26 #define IRAM_ATTR _SECTION_ATTR_IMPL(".iram1", __COUNTER__) 27 28 // Forces data into DRAM instead of flash 29 #define DRAM_ATTR _SECTION_ATTR_IMPL(".dram1", __COUNTER__) 30 31 #ifdef CONFIG_ESP32_IRAM_AS_8BIT_ACCESSIBLE_MEMORY 32 // Forces data into IRAM instead of DRAM 33 #define IRAM_DATA_ATTR __attribute__((section(".iram.data"))) 34 35 // Forces data into IRAM instead of DRAM and map it to coredump 36 #define COREDUMP_IRAM_DATA_ATTR _SECTION_ATTR_IMPL(".iram.data.coredump", __COUNTER__) 37 38 // Forces bss into IRAM instead of DRAM 39 #define IRAM_BSS_ATTR __attribute__((section(".iram.bss"))) 40 #else 41 #define COREDUMP_IRAM_DATA_ATTR 42 #define IRAM_DATA_ATTR 43 44 #define IRAM_BSS_ATTR 45 #endif 46 47 // Forces data to be 4 bytes aligned 48 #define WORD_ALIGNED_ATTR __attribute__((aligned(4))) 49 50 // Forces data to be placed to DMA-capable places 51 #define DMA_ATTR WORD_ALIGNED_ATTR DRAM_ATTR 52 53 // Forces a function to be inlined 54 #define FORCE_INLINE_ATTR static inline __attribute__((always_inline)) 55 56 // Forces a string into DRAM instead of flash 57 // Use as esp_rom_printf(DRAM_STR("Hello world!\n")); 58 #define DRAM_STR(str) (__extension__({static const DRAM_ATTR char __c[] = (str); (const char *)&__c;})) 59 60 // Forces code into RTC fast memory. See "docs/deep-sleep-stub.rst" 61 #define RTC_IRAM_ATTR _SECTION_ATTR_IMPL(".rtc.text", __COUNTER__) 62 63 #if CONFIG_SPIRAM_ALLOW_BSS_SEG_EXTERNAL_MEMORY 64 // Forces bss variable into external memory. " 65 #define EXT_RAM_ATTR _SECTION_ATTR_IMPL(".ext_ram.bss", __COUNTER__) 66 #else 67 #define EXT_RAM_ATTR 68 #endif 69 70 // Forces data into RTC slow memory. See "docs/deep-sleep-stub.rst" 71 // Any variable marked with this attribute will keep its value 72 // during a deep sleep / wake cycle. 73 #define RTC_DATA_ATTR _SECTION_ATTR_IMPL(".rtc.data", __COUNTER__) 74 75 // Forces read-only data into RTC memory. See "docs/deep-sleep-stub.rst" 76 #define RTC_RODATA_ATTR _SECTION_ATTR_IMPL(".rtc.rodata", __COUNTER__) 77 78 // Allows to place data into RTC_SLOW memory. 79 #define RTC_SLOW_ATTR _SECTION_ATTR_IMPL(".rtc.force_slow", __COUNTER__) 80 81 // Allows to place data into RTC_FAST memory. 82 #define RTC_FAST_ATTR _SECTION_ATTR_IMPL(".rtc.force_fast", __COUNTER__) 83 84 // Forces data into noinit section to avoid initialization after restart. 85 #define __NOINIT_ATTR _SECTION_ATTR_IMPL(".noinit", __COUNTER__) 86 87 // Forces data into RTC slow memory of .noinit section. 88 // Any variable marked with this attribute will keep its value 89 // after restart or during a deep sleep / wake cycle. 90 #define RTC_NOINIT_ATTR _SECTION_ATTR_IMPL(".rtc_noinit", __COUNTER__) 91 92 // Forces code into DRAM instead of flash and map it to coredump 93 #define COREDUMP_DRAM_ATTR _SECTION_ATTR_IMPL(".dram1.coredump", __COUNTER__) 94 95 // Forces data into RTC memory and map it to coredump 96 #define COREDUMP_RTC_DATA_ATTR _SECTION_ATTR_IMPL(".rtc.coredump", __COUNTER__) 97 98 // Allows to place data into RTC_FAST memory and map it to coredump 99 #define COREDUMP_RTC_FAST_ATTR _SECTION_ATTR_IMPL(".rtc.fast.coredump", __COUNTER__) 100 101 // Forces to not inline function 102 #define NOINLINE_ATTR __attribute__((noinline)) 103 104 // This allows using enum as flags in C++ 105 // Format: FLAG_ATTR(flag_enum_t) 106 #ifdef __cplusplus 107 108 // Inline is required here to avoid multiple definition error in linker 109 #define FLAG_ATTR_IMPL(TYPE, INT_TYPE) \ 110 FORCE_INLINE_ATTR constexpr TYPE operator~ (TYPE a) { return (TYPE)~(INT_TYPE)a; } \ 111 FORCE_INLINE_ATTR constexpr TYPE operator| (TYPE a, TYPE b) { return (TYPE)((INT_TYPE)a | (INT_TYPE)b); } \ 112 FORCE_INLINE_ATTR constexpr TYPE operator& (TYPE a, TYPE b) { return (TYPE)((INT_TYPE)a & (INT_TYPE)b); } \ 113 FORCE_INLINE_ATTR constexpr TYPE operator^ (TYPE a, TYPE b) { return (TYPE)((INT_TYPE)a ^ (INT_TYPE)b); } \ 114 FORCE_INLINE_ATTR constexpr TYPE operator>> (TYPE a, int b) { return (TYPE)((INT_TYPE)a >> b); } \ 115 FORCE_INLINE_ATTR constexpr TYPE operator<< (TYPE a, int b) { return (TYPE)((INT_TYPE)a << b); } \ 116 FORCE_INLINE_ATTR TYPE& operator|=(TYPE& a, TYPE b) { a = a | b; return a; } \ 117 FORCE_INLINE_ATTR TYPE& operator&=(TYPE& a, TYPE b) { a = a & b; return a; } \ 118 FORCE_INLINE_ATTR TYPE& operator^=(TYPE& a, TYPE b) { a = a ^ b; return a; } \ 119 FORCE_INLINE_ATTR TYPE& operator>>=(TYPE& a, int b) { a >>= b; return a; } \ 120 FORCE_INLINE_ATTR TYPE& operator<<=(TYPE& a, int b) { a <<= b; return a; } 121 122 #define FLAG_ATTR_U32(TYPE) FLAG_ATTR_IMPL(TYPE, uint32_t) 123 #define FLAG_ATTR FLAG_ATTR_U32 124 125 #else 126 #define FLAG_ATTR(TYPE) 127 #endif 128 129 // Implementation for a unique custom section 130 // 131 // This prevents gcc producing "x causes a section type conflict with y" 132 // errors if two variables in the same source file have different linkage (maybe const & non-const) but are placed in the same custom section 133 // 134 // Using unique sections also means --gc-sections can remove unused 135 // data with a custom section type set 136 #define _SECTION_ATTR_IMPL(SECTION, COUNTER) __attribute__((section(SECTION "." _COUNTER_STRINGIFY(COUNTER)))) 137 138 #define _COUNTER_STRINGIFY(COUNTER) #COUNTER 139 140 /* Use IDF_DEPRECATED attribute to mark anything deprecated from use in 141 ESP-IDF's own source code, but not deprecated for external users. 142 */ 143 #ifdef IDF_CI_BUILD 144 #define IDF_DEPRECATED(REASON) __attribute__((deprecated(REASON))) 145 #else 146 #define IDF_DEPRECATED(REASON) 147 #endif 148 149 #endif /* __ESP_ATTR_H__ */ 150