1 /* 2 * Copyright (c) 2020 Raspberry Pi (Trading) Ltd. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef _PICO_BINARY_INFO_CODE_H 8 #define _PICO_BINARY_INFO_CODE_H 9 10 // pico.h is not available when PICO_NO_BINARY_INFO=1 is used for builds outside of the SDK (e.g. picotool) 11 // and only needed anyway (because of macro definitions) in PICO_NO_BINARY_INFO=0 builds 12 #if !PICO_NO_BINARY_INFO 13 #include "pico.h" 14 #endif 15 16 #include "pico/binary_info/structure.h" 17 18 #if !PICO_NO_BINARY_INFO 19 #define __bi_decl(name, bi, section_prefix, attr) static const attr __attribute__((section(section_prefix __STRING(name)))) struct _binary_info_core *name = bi 20 #define __bi_lineno_var_name __CONCAT(__bi_, __LINE__) 21 #define __bi_ptr_lineno_var_name __CONCAT(__bi_ptr, __LINE__) 22 #define __bi_enclosure_check_lineno_var_name __CONCAT(_error_bi_is_missing_enclosing_decl_,__LINE__) 23 #define __bi_mark_enclosure static const __unused int __bi_enclosure_check_lineno_var_name=0; 24 #if !defined(__GNUC__) || __cplusplus || __GNUC__ >= 8 25 #define __bi_enclosure_check(x) (x + __bi_enclosure_check_lineno_var_name) 26 #else 27 // skip the version check on older GCC non C++, as it doesn't compile.. this is only here to catch the 28 // user accidentally forgetting to enclose the binary item with bi_decl 29 #define __bi_enclosure_check(x) (x) 30 #endif 31 /** 32 * Declare some binary information that will be included if the contain source file/line is compiled into the binary 33 * \ingroup pico_binary_info 34 */ 35 #define bi_decl(_decl) __bi_mark_enclosure _decl; __bi_decl(__bi_ptr_lineno_var_name, &__bi_lineno_var_name.core, ".binary_info.keep.", __used); 36 /** 37 * Declare some binary information that will be included if the function containing the decl is linked into the binary. 38 * The SDK uses --gc-sections, so functions that are never called will be removed by the linker, and any associated 39 * binary information declared this way will also be stripped 40 * \ingroup pico_binary_info 41 */ 42 #define bi_decl_if_func_used(_decl) ({__bi_mark_enclosure _decl; __bi_decl(__bi_ptr_lineno_var_name, &__bi_lineno_var_name.core, ".binary_info.", ); *(volatile uint8_t *)&__bi_ptr_lineno_var_name;}); 43 44 #define bi_decl_with_attr(_decl, _attr) __bi_mark_enclosure _attr _decl; __bi_decl(__bi_ptr_lineno_var_name, &__bi_lineno_var_name.core, ".binary_info.keep.", __used); 45 #define bi_decl_if_func_used_with_attr(_decl, _attr) ({__bi_mark_enclosure _attr _decl; __bi_decl(__bi_ptr_lineno_var_name, &__bi_lineno_var_name.core, ".binary_info.", ); *(volatile uint8_t *)&__bi_ptr_lineno_var_name;}); 46 #else 47 #define __bi_decl(bi, name, attr) 48 #define bi_decl_with_attr(_decl, _attr) 49 #define bi_decl(_decl) 50 #define bi_decl_if_func_used_with_attr(_decl, _attr) ((void)0); 51 #define bi_decl_if_func_used(_decl) ((void)0); 52 #endif 53 54 #define bi_int(_tag, _id, _value) \ 55 static const struct _binary_info_id_and_int __bi_lineno_var_name = { \ 56 .core = { \ 57 .type = __bi_enclosure_check(BINARY_INFO_TYPE_ID_AND_INT), \ 58 .tag = _tag, \ 59 },\ 60 .id = _id, \ 61 .value = _value \ 62 }; 63 64 #define bi_string(_tag, _id, _value) \ 65 static const struct _binary_info_id_and_string __bi_lineno_var_name = { \ 66 .core = { \ 67 .type = __bi_enclosure_check(BINARY_INFO_TYPE_ID_AND_STRING), \ 68 .tag = _tag, \ 69 },\ 70 .id = _id, \ 71 .value = _value, \ 72 } 73 74 #define bi_block_device(_tag, _name, _address, _size, _extra, _flags) \ 75 static const struct _binary_info_block_device __bi_lineno_var_name = { \ 76 .core = { \ 77 .type = __bi_enclosure_check(BINARY_INFO_TYPE_BLOCK_DEVICE), \ 78 .tag = _tag, \ 79 },\ 80 .name = _name, \ 81 .address = _address, \ 82 .size = _size, \ 83 .extra = _extra, \ 84 .flags = _flags, \ 85 } 86 87 #define __bi_encoded_pins_with_func(_encoding) \ 88 static const struct _binary_info_pins_with_func __bi_lineno_var_name = { \ 89 .core = { \ 90 .type = __bi_enclosure_check(BINARY_INFO_TYPE_PINS_WITH_FUNC), \ 91 .tag = BINARY_INFO_TAG_RASPBERRY_PI, \ 92 },\ 93 .pin_encoding = _encoding \ 94 } 95 96 #define __bi_pins_with_name(_mask, _label) \ 97 static const struct _binary_info_pins_with_name __bi_lineno_var_name = { \ 98 .core = { \ 99 .type = __bi_enclosure_check(BINARY_INFO_TYPE_PINS_WITH_NAME), \ 100 .tag = BINARY_INFO_TAG_RASPBERRY_PI, \ 101 },\ 102 .pin_mask = _mask, \ 103 .label = _label \ 104 } 105 106 #define __bi_named_group(_parent_tag, _parent_id, _group_tag, _group_id, _label, _flags) \ 107 static const struct _binary_info_named_group __bi_lineno_var_name = { \ 108 .core = { \ 109 .type = __bi_enclosure_check(BINARY_INFO_TYPE_NAMED_GROUP), \ 110 .tag = _parent_tag, \ 111 },\ 112 .parent_id = _parent_id, \ 113 .group_tag = _group_tag, \ 114 .flags = _flags, \ 115 .group_id = _group_id, \ 116 .label = _label \ 117 } 118 119 #define bi_binary_end(end) bi_int(BINARY_INFO_TAG_RASPBERRY_PI, BINARY_INFO_ID_RP_BINARY_END, end) 120 #define bi_program_name(name) bi_string(BINARY_INFO_TAG_RASPBERRY_PI, BINARY_INFO_ID_RP_PROGRAM_NAME, name) 121 #define bi_program_description(description) bi_string(BINARY_INFO_TAG_RASPBERRY_PI, BINARY_INFO_ID_RP_PROGRAM_DESCRIPTION, description) 122 #define bi_program_version_string(version_string) bi_string(BINARY_INFO_TAG_RASPBERRY_PI, BINARY_INFO_ID_RP_PROGRAM_VERSION_STRING, version_string) 123 #define bi_program_build_date_string(date_string) bi_string(BINARY_INFO_TAG_RASPBERRY_PI, BINARY_INFO_ID_RP_PROGRAM_BUILD_DATE_STRING, date_string) 124 #define bi_program_url(url) bi_string(BINARY_INFO_TAG_RASPBERRY_PI, BINARY_INFO_ID_RP_PROGRAM_URL, url) 125 // multiple of these may be added 126 #define bi_program_feature(feature) bi_string(BINARY_INFO_TAG_RASPBERRY_PI, BINARY_INFO_ID_RP_PROGRAM_FEATURE, feature) 127 #define bi_program_build_attribute(attr) bi_string(BINARY_INFO_TAG_RASPBERRY_PI, BINARY_INFO_ID_RP_PROGRAM_BUILD_ATTRIBUTE, attr) 128 #define bi_program_feature_group(tag, id, name) __bi_named_group(BINARY_INFO_TAG_RASPBERRY_PI, BINARY_INFO_ID_RP_PROGRAM_FEATURE, tag, id, name, 0) 129 #define bi_program_feature_group_with_flags(tag, id, name, flags) __bi_named_group(BINARY_INFO_TAG_RASPBERRY_PI, BINARY_INFO_ID_RP_PROGRAM_FEATURE, tag, id, name, flags) 130 131 #define bi_1pin_with_func(p0, func) __bi_encoded_pins_with_func(BI_PINS_ENCODING_MULTI | ((func << 3)) | ((p0) << 7) | ((p0) << 12)) 132 #define bi_2pins_with_func(p0, p1, func) __bi_encoded_pins_with_func(BI_PINS_ENCODING_MULTI | ((func << 3)) | ((p0) << 7) | ((p1) << 12) | ((p1) << 17)) 133 #define bi_3pins_with_func(p0, p1, p2, func) __bi_encoded_pins_with_func(BI_PINS_ENCODING_MULTI | ((func << 3)) | ((p0) << 7) | ((p1) << 12) | ((p2) << 17) | ((p2) << 22)) 134 #define bi_4pins_with_func(p0, p1, p2, p3, func) __bi_encoded_pins_with_func(BI_PINS_ENCODING_MULTI | ((func << 3)) | ((p0) << 7) | ((p1) << 12) | ((p2) << 17) | ((p3) << 22) | ((p3) << 27)) 135 #define bi_5pins_with_func(p0, p1, p2, p3, p4, func) __bi_encoded_pins_with_func(BI_PINS_ENCODING_MULTI | ((func << 3)) | ((p0) << 7) | ((p1) << 12) | ((p2) << 17) | ((p3) << 22) | ((p4) << 27)) 136 #define bi_pin_range_with_func(plo, phi, func) __bi_encoded_pins_with_func(BI_PINS_ENCODING_RANGE | ((func << 3)) | ((plo) << 7) | ((phi) << 12)) 137 138 #define bi_pin_mask_with_name(pmask, label) __bi_pins_with_name((pmask), (label)) 139 // names are separated by | ... i.e. "name1|name2|name3" 140 #define bi_pin_mask_with_names(pmask, label) __bi_pins_with_name((pmask), (label)) 141 #define bi_1pin_with_name(p0, name) bi_pin_mask_with_name(1u << (p0), name) 142 #define bi_2pins_with_names(p0, name0, p1, name1) bi_pin_mask_with_names((1u << (p0)) | (1u << (p1)), name0 "|" name1) 143 #define bi_3pins_with_names(p0, name0, p1, name1, p2, name2) bi_pin_mask_with_names((1u << (p0)) | (1u << (p1)) | (1u << (p2)), name0 "|" name1 "|" name2) 144 #define bi_4pins_with_names(p0, name0, p1, name1, p2, name2, p3, name3) bi_pin_mask_with_names((1u << (p0)) | (1u << (p1)) | (1u << (p2)) | (1u << (p3)), name0 "|" name1 "|" name2 "|" name3) 145 146 #endif 147
