X-Git-Url: http://git.ipfire.org/?a=blobdiff_plain;f=include%2Flinker_lists.h;h=6ef89a2090a9eaa36d7188266692a2f44f16f62e;hb=f1754f08102781f855370c7d47db0e3d85da5694;hp=6c28bf961b0b96dc5d067a84d5c315dc0ef4bef0;hpb=6579d15c58e2b6b051f126ea8b77dd767252aa14;p=people%2Fms%2Fu-boot.git diff --git a/include/linker_lists.h b/include/linker_lists.h index 6c28bf961b..6ef89a2090 100644 --- a/include/linker_lists.h +++ b/include/linker_lists.h @@ -5,18 +5,16 @@ * * Copyright (C) 2012 Marek Vasut * - * See file CREDITS for list of people who contributed to this - * project. - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation; either version 2 of - * the License, or (at your option) any later version. + * SPDX-License-Identifier: GPL-2.0+ */ +#ifndef __LINKER_LISTS_H__ +#define __LINKER_LISTS_H__ + +#include + /* - * There is no use in including this from ASM files, but that happens - * anyway, e.g. PPC kgdb.S includes command.h which incluse us. + * There is no use in including this from ASM files. * So just don't define anything when included from ASM. */ @@ -24,23 +22,23 @@ /** * A linker list is constructed by grouping together linker input - * sections, each containning one entry of the list. Each input section + * sections, each containing one entry of the list. Each input section * contains a constant initialized variable which holds the entry's * content. Linker list input sections are constructed from the list * and entry names, plus a prefix which allows grouping all lists * together. Assuming _list and _entry are the list and entry names, * then the corresponding input section name is * - * _u_boot_list + _2_ + @_list + _2_ + @_entry + * .u_boot_list_ + 2_ + @_list + _2_ + @_entry * * and the C variable name is * - * .u_boot_list_ + 2_ + @_list + _2_ + @_entry + * _u_boot_list + _2_ + @_list + _2_ + @_entry * * This ensures uniqueness for both input section and C variable name. * * Note that the names differ only in the first character, "." for the - * setion and "_" for the variable, so that the linker cannot confuse + * section and "_" for the variable, so that the linker cannot confuse * section and symbol names. From now on, both names will be referred * to as * @@ -84,7 +82,7 @@ * global list name ("outer"); iterators for only a sub-list should use * the full sub-list name ("outer_2_inner"). * - * Here is an example of the sections generated from a global list + * Here is an example of the sections generated from a global list * named "drivers", two sub-lists named "i2c" and "pci", and iterators * defined for the whole list and each sub-list: * @@ -103,8 +101,15 @@ * %u_boot_list_2_drivers_3 */ -#ifndef __LINKER_LISTS_H__ -#define __LINKER_LISTS_H__ +/** + * llsym() - Access a linker-generated array entry + * @_type: Data type of the entry + * @_name: Name of the entry + * @_list: name of the list. Should contain only characters allowed + * in a C variable name! + */ +#define llsym(_type, _name, _list) \ + ((_type *)&_u_boot_list_2_##_list##_2_##_name) /** * ll_entry_declare() - Declare linker-generated array entry @@ -136,7 +141,7 @@ * the inner sections are present in the array. * * Example: - * ll_entry_declare(struct my_sub_cmd, my_sub_cmd, cmd_sub, cmd.sub) = { + * ll_entry_declare(struct my_sub_cmd, my_sub_cmd, cmd_sub) = { * .x = 3, * .y = 4, * }; @@ -146,6 +151,27 @@ __attribute__((unused, \ section(".u_boot_list_2_"#_list"_2_"#_name))) +/** + * ll_entry_declare_list() - Declare a list of link-generated array entries + * @_type: Data type of each entry + * @_name: Name of the entry + * @_list: name of the list. Should contain only characters allowed + * in a C variable name! + * + * This is like ll_entry_declare() but creates multiple entries. It should + * be assigned to an array. + * + * ll_entry_declare_list(struct my_sub_cmd, my_sub_cmd, cmd_sub) = { + * { .x = 3, .y = 4 }, + * { .x = 8, .y = 2 }, + * { .x = 1, .y = 7 } + * }; + */ +#define ll_entry_declare_list(_type, _name, _list) \ + _type _u_boot_list_2_##_list##_2_##_name[] __aligned(4) \ + __attribute__((unused, \ + section(".u_boot_list_2_"#_list"_2_"#_name))) + /** * We need a 0-byte-size type for iterator symbols, and the compiler * does not allow defining objects of C type 'void'. Using an empty @@ -195,7 +221,7 @@ */ #define ll_entry_end(_type, _list) \ ({ \ - static char end[0] __aligned(4) __attribute__((unused, \ + static char end[0] __aligned(4) __attribute__((unused, \ section(".u_boot_list_2_"#_list"_3"))); \ (_type *)&end; \ }) @@ -229,12 +255,12 @@ * @_name: Name of the entry * @_list: Name of the list in which this entry is placed * - * This function returns a pointer to a particular entry in LG-array - * identified by the subsection of u_boot_list where the entry resides + * This function returns a pointer to a particular entry in linker-generated + * array identified by the subsection of u_boot_list where the entry resides * and it's name. * * Example: - * ll_entry_declare(struct my_sub_cmd, my_sub_cmd, cmd_sub, cmd.sub) = { + * ll_entry_declare(struct my_sub_cmd, my_sub_cmd, cmd_sub) = { * .x = 3, * .y = 4, * }; @@ -245,7 +271,7 @@ ({ \ extern _type _u_boot_list_2_##_list##_2_##_name; \ _type *_ll_result = \ - &_u_boot_list_2_##_list##_2_##_name; \ + &_u_boot_list_2_##_list##_2_##_name; \ _ll_result; \ }) @@ -270,7 +296,7 @@ }) /** - * ll_entry_end() - Point after last entry of last linker-generated array + * ll_end() - Point after last entry of last linker-generated array * @_type: Data type of the entry * * This function returns (_type *) pointer after the very last entry of @@ -284,7 +310,7 @@ */ #define ll_end(_type) \ ({ \ - static char end[0] __aligned(4) __attribute__((unused, \ + static char end[0] __aligned(4) __attribute__((unused, \ section(".u_boot_list_3"))); \ (_type *)&end; \ })