u-boot/include/linker_lists.h

4  * Implementation of linker-generated arrays
8  * SPDX-License-Identifier:	GPL-2.0+
25  * sections, each containing one entry of the list. Each input section
26  * contains a constant initialized variable which holds the entry's
28  * and entry names, plus a prefix which allows grouping all lists
29  * together. Assuming _list and _entry are the list and entry names,
30  * then the corresponding input section name is
34  * and the C variable name is
38  * This ensures uniqueness for both input section and C variable name.
47  * Entry variables need never be referred to directly.
79  * part of a list), one can simply give the list a name of the form
80  * 'outer_2_inner', where 'outer' is the global list name and 'inner'
81  * is the sub-list name. Iterators for the whole list should use the
82  * global list name ("outer"); iterators for only a sub-list should use
83  * the full sub-list name ("outer_2_inner").
86  * named "drivers", two sub-lists named "i2c" and "pci", and iterators
87  * defined for the whole list and each sub-list:
105  * llsym() - Access a linker-generated array entry
106  * @_type:	Data type of the entry
107  * @_name:	Name of the entry
108  * @_list:	name of the list. Should contain only characters allowed
109  *		in a C variable name!
115  * ll_entry_declare() - Declare linker-generated array entry
116  * @_type:	Data type of the entry
117  * @_name:	Name of the entry
118  * @_list:	name of the list. Should contain only characters allowed
119  *		in a C variable name!
121  * This macro declares a variable that is placed into a linker-generated
122  * array. This is a basic building block for more advanced use of linker-
126  * A variable declared using this macro must be compile-time initialized.
131  *    entry is generated and can be iterated but is listed in the map
132  *    file and cannot be retrieved by name.
155  * ll_entry_declare_list() - Declare a list of link-generated array entries
156  * @_type:	Data type of each entry
157  * @_name:	Name of the entry
158  * @_list:	name of the list. Should contain only characters allowed
159  *		in a C variable name!
176  * We need a 0-byte-size type for iterator symbols, and the compiler
180  * thing: zero-sized arrays, which are both 0-byte-size and exempt from
185  * ll_entry_start() - Point to first entry of linker-generated array
186  * @_type:	Data type of the entry
187  * @_list:	Name of the list in which this entry is placed
189  * This function returns (_type *) pointer to the very first entry of a
190  * linker-generated array placed into subsection of .u_boot_list section
207  * ll_entry_end() - Point after last entry of linker-generated array
208  * @_type:	Data type of the entry
209  * @_list:	Name of the list in which this entry is placed
212  * This function returns (_type *) pointer after the very last entry of
213  * a linker-generated array placed into subsection of .u_boot_list
229  * ll_entry_count() - Return the number of elements in linker-generated array
230  * @_type:	Data type of the entry
231  * @_list:	Name of the list of which the number of elements is computed
233  * This function returns the number of elements of a linker-generated array
242  *         printf("Entry %i, x=%i y=%i\n", i, msc->x, msc->y);
248 		unsigned int _ll_result = end - start;			\
253  * ll_entry_get() - Retrieve entry from linker-generated array by name
254  * @_type:	Data type of the entry
255  * @_name:	Name of the entry
256  * @_list:	Name of the list in which this entry is placed
258  * This function returns a pointer to a particular entry in linker-generated
259  * array identified by the subsection of u_boot_list where the entry resides
260  * and it's name.
279  * ll_start() - Point to first entry of first linker-generated array
280  * @_type:	Data type of the entry
282  * This function returns (_type *) pointer to the very first entry of
283  * the very first linker-generated array.
285  * Since this macro defines the start of the linker-generated arrays,
299  * ll_end() - Point after last entry of last linker-generated array
300  * @_type:	Data type of the entry
302  * This function returns (_type *) pointer after the very last entry of
303  * the very last linker-generated array.
305  * Since this macro defines the end of the linker-generated arrays,