xref: /rk3399_rockchip-uboot/include/env_callback.h (revision bdf1fe4e68b0d240f0ee666ea9d92d3f42f1a23f)
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 #ifdef CONFIG_REGEX
35 #define ENV_DOT_ESCAPE "\\"
36 #else
37 #define ENV_DOT_ESCAPE
38 #endif
39 
40 /*
41  * This list of callback bindings is static, but may be overridden by defining
42  * a new association in the ".callbacks" environment variable.
43  */
44 #define ENV_CALLBACK_LIST_STATIC ENV_DOT_ESCAPE ENV_CALLBACK_VAR ":callbacks," \
45 	ENV_DOT_ESCAPE ENV_FLAGS_VAR ":flags," \
46 	"baudrate:baudrate," \
47 	"bootfile:bootfile," \
48 	"loadaddr:loadaddr," \
49 	SILENT_CALLBACK \
50 	SPLASHIMAGE_CALLBACK \
51 	"stdin:console,stdout:console,stderr:console," \
52 	CONFIG_ENV_CALLBACK_LIST_STATIC
53 
54 struct env_clbk_tbl {
55 	const char *name;		/* Callback name */
56 	int (*callback)(const char *name, const char *value, enum env_op op,
57 		int flags);
58 };
59 
60 void env_callback_init(ENTRY *var_entry);
61 
62 /*
63  * Define a callback that can be associated with variables.
64  * when associated through the ".callbacks" environment variable, the callback
65  * will be executed any time the variable is inserted, overwritten, or deleted.
66  */
67 #ifdef CONFIG_SPL_BUILD
68 #define U_BOOT_ENV_CALLBACK(name, callback) \
69 	static inline __maybe_unused void _u_boot_env_noop_##name(void) \
70 	{ \
71 		(void)callback; \
72 	}
73 #else
74 #define U_BOOT_ENV_CALLBACK(name, callback) \
75 	ll_entry_declare(struct env_clbk_tbl, name, env_clbk) = \
76 	{#name, callback}
77 #endif
78 
79 #endif /* __ENV_CALLBACK_H__ */
80