xref: /rk3399_rockchip-uboot/include/env_callback.h (revision bdf1fe4e68b0d240f0ee666ea9d92d3f42f1a23f)
1170ab110SJoe Hershberger /*
2170ab110SJoe Hershberger  * (C) Copyright 2012
3170ab110SJoe Hershberger  * Joe Hershberger, National Instruments, joe.hershberger@ni.com
4170ab110SJoe Hershberger  *
51a459660SWolfgang Denk  * SPDX-License-Identifier:	GPL-2.0+
6170ab110SJoe Hershberger  */
7170ab110SJoe Hershberger 
8170ab110SJoe Hershberger #ifndef __ENV_CALLBACK_H__
9170ab110SJoe Hershberger #define __ENV_CALLBACK_H__
10170ab110SJoe Hershberger 
112598090bSJoe Hershberger #include <env_flags.h>
12170ab110SJoe Hershberger #include <linker_lists.h>
13170ab110SJoe Hershberger #include <search.h>
14170ab110SJoe Hershberger 
15170ab110SJoe Hershberger #define ENV_CALLBACK_VAR ".callbacks"
16170ab110SJoe Hershberger 
17170ab110SJoe Hershberger /* Board configs can define additional static callback bindings */
18170ab110SJoe Hershberger #ifndef CONFIG_ENV_CALLBACK_LIST_STATIC
19170ab110SJoe Hershberger #define CONFIG_ENV_CALLBACK_LIST_STATIC
20170ab110SJoe Hershberger #endif
21170ab110SJoe Hershberger 
22e080d545SJoe Hershberger #ifdef CONFIG_SILENT_CONSOLE
23e080d545SJoe Hershberger #define SILENT_CALLBACK "silent:silent,"
24e080d545SJoe Hershberger #else
25e080d545SJoe Hershberger #define SILENT_CALLBACK
26e080d545SJoe Hershberger #endif
27e080d545SJoe Hershberger 
28c0880485SNikita Kiryanov #ifdef CONFIG_SPLASHIMAGE_GUARD
29c0880485SNikita Kiryanov #define SPLASHIMAGE_CALLBACK "splashimage:splashimage,"
30c0880485SNikita Kiryanov #else
31c0880485SNikita Kiryanov #define SPLASHIMAGE_CALLBACK
32c0880485SNikita Kiryanov #endif
33c0880485SNikita Kiryanov 
34*bdf1fe4eSJoe Hershberger #ifdef CONFIG_REGEX
35*bdf1fe4eSJoe Hershberger #define ENV_DOT_ESCAPE "\\"
36*bdf1fe4eSJoe Hershberger #else
37*bdf1fe4eSJoe Hershberger #define ENV_DOT_ESCAPE
38*bdf1fe4eSJoe Hershberger #endif
39*bdf1fe4eSJoe Hershberger 
40170ab110SJoe Hershberger /*
41170ab110SJoe Hershberger  * This list of callback bindings is static, but may be overridden by defining
42170ab110SJoe Hershberger  * a new association in the ".callbacks" environment variable.
43170ab110SJoe Hershberger  */
44*bdf1fe4eSJoe Hershberger #define ENV_CALLBACK_LIST_STATIC ENV_DOT_ESCAPE ENV_CALLBACK_VAR ":callbacks," \
45*bdf1fe4eSJoe Hershberger 	ENV_DOT_ESCAPE ENV_FLAGS_VAR ":flags," \
4632057717SJoe Hershberger 	"baudrate:baudrate," \
47a9f51c9bSJoe Hershberger 	"bootfile:bootfile," \
481cf0a8b2SJoe Hershberger 	"loadaddr:loadaddr," \
49e080d545SJoe Hershberger 	SILENT_CALLBACK \
50c0880485SNikita Kiryanov 	SPLASHIMAGE_CALLBACK \
51849d5d9cSJoe Hershberger 	"stdin:console,stdout:console,stderr:console," \
52170ab110SJoe Hershberger 	CONFIG_ENV_CALLBACK_LIST_STATIC
53170ab110SJoe Hershberger 
54170ab110SJoe Hershberger struct env_clbk_tbl {
55170ab110SJoe Hershberger 	const char *name;		/* Callback name */
56170ab110SJoe Hershberger 	int (*callback)(const char *name, const char *value, enum env_op op,
57170ab110SJoe Hershberger 		int flags);
58170ab110SJoe Hershberger };
59170ab110SJoe Hershberger 
60170ab110SJoe Hershberger void env_callback_init(ENTRY *var_entry);
61170ab110SJoe Hershberger 
62170ab110SJoe Hershberger /*
63170ab110SJoe Hershberger  * Define a callback that can be associated with variables.
64170ab110SJoe Hershberger  * when associated through the ".callbacks" environment variable, the callback
65170ab110SJoe Hershberger  * will be executed any time the variable is inserted, overwritten, or deleted.
66170ab110SJoe Hershberger  */
67f8cfcf1bSScott Wood #ifdef CONFIG_SPL_BUILD
68f8cfcf1bSScott Wood #define U_BOOT_ENV_CALLBACK(name, callback) \
693ea664c7SJeroen Hofstee 	static inline __maybe_unused void _u_boot_env_noop_##name(void) \
70f8cfcf1bSScott Wood 	{ \
71f8cfcf1bSScott Wood 		(void)callback; \
72f8cfcf1bSScott Wood 	}
73f8cfcf1bSScott Wood #else
74170ab110SJoe Hershberger #define U_BOOT_ENV_CALLBACK(name, callback) \
75ef123c52SAlbert ARIBAUD 	ll_entry_declare(struct env_clbk_tbl, name, env_clbk) = \
76170ab110SJoe Hershberger 	{#name, callback}
77f8cfcf1bSScott Wood #endif
78170ab110SJoe Hershberger 
79170ab110SJoe Hershberger #endif /* __ENV_CALLBACK_H__ */
80