xref: /openbmc/u-boot/include/env_callback.h (revision 3765b3e7)
1 /*
2  * (C) Copyright 2012
3  * Joe Hershberger, National Instruments, joe.hershberger@ni.com
4  *
5  * SPDX-License-Identifier:	GPL-2.0+
6  */
7 
8 #ifndef __ENV_CALLBACK_H__
9 #define __ENV_CALLBACK_H__
10 
11 #include <env_flags.h>
12 #include <linker_lists.h>
13 #include <search.h>
14 
15 #define ENV_CALLBACK_VAR ".callbacks"
16 
17 /* Board configs can define additional static callback bindings */
18 #ifndef CONFIG_ENV_CALLBACK_LIST_STATIC
19 #define CONFIG_ENV_CALLBACK_LIST_STATIC
20 #endif
21 
22 #ifdef CONFIG_SILENT_CONSOLE
23 #define SILENT_CALLBACK "silent:silent,"
24 #else
25 #define SILENT_CALLBACK
26 #endif
27 
28 #ifdef CONFIG_SPLASHIMAGE_GUARD
29 #define SPLASHIMAGE_CALLBACK "splashimage:splashimage,"
30 #else
31 #define SPLASHIMAGE_CALLBACK
32 #endif
33 
34 /*
35  * This list of callback bindings is static, but may be overridden by defining
36  * a new association in the ".callbacks" environment variable.
37  */
38 #define ENV_CALLBACK_LIST_STATIC ENV_CALLBACK_VAR ":callbacks," \
39 	ENV_FLAGS_VAR ":flags," \
40 	"baudrate:baudrate," \
41 	"bootfile:bootfile," \
42 	"loadaddr:loadaddr," \
43 	SILENT_CALLBACK \
44 	SPLASHIMAGE_CALLBACK \
45 	"stdin:console,stdout:console,stderr:console," \
46 	CONFIG_ENV_CALLBACK_LIST_STATIC
47 
48 struct env_clbk_tbl {
49 	const char *name;		/* Callback name */
50 	int (*callback)(const char *name, const char *value, enum env_op op,
51 		int flags);
52 };
53 
54 void env_callback_init(ENTRY *var_entry);
55 
56 /*
57  * Define a callback that can be associated with variables.
58  * when associated through the ".callbacks" environment variable, the callback
59  * will be executed any time the variable is inserted, overwritten, or deleted.
60  */
61 #ifdef CONFIG_SPL_BUILD
62 #define U_BOOT_ENV_CALLBACK(name, callback) \
63 	static inline void _u_boot_env_noop_##name(void) \
64 	{ \
65 		(void)callback; \
66 	}
67 #else
68 #define U_BOOT_ENV_CALLBACK(name, callback) \
69 	ll_entry_declare(struct env_clbk_tbl, name, env_clbk) = \
70 	{#name, callback}
71 #endif
72 
73 #endif /* __ENV_CALLBACK_H__ */
74