xref: /openbmc/u-boot/include/env_callback.h (revision dd1033e4)
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * (C) Copyright 2012
4  * Joe Hershberger, National Instruments, joe.hershberger@ni.com
5  */
6 
7 #ifndef __ENV_CALLBACK_H__
8 #define __ENV_CALLBACK_H__
9 
10 #include <env_flags.h>
11 #include <linker_lists.h>
12 #include <search.h>
13 
14 #define ENV_CALLBACK_VAR ".callbacks"
15 
16 /* Board configs can define additional static callback bindings */
17 #ifndef CONFIG_ENV_CALLBACK_LIST_STATIC
18 #define CONFIG_ENV_CALLBACK_LIST_STATIC
19 #endif
20 
21 #ifdef CONFIG_SILENT_CONSOLE
22 #define SILENT_CALLBACK "silent:silent,"
23 #else
24 #define SILENT_CALLBACK
25 #endif
26 
27 #ifdef CONFIG_SPLASHIMAGE_GUARD
28 #define SPLASHIMAGE_CALLBACK "splashimage:splashimage,"
29 #else
30 #define SPLASHIMAGE_CALLBACK
31 #endif
32 
33 #ifdef CONFIG_REGEX
34 #define ENV_DOT_ESCAPE "\\"
35 #define ETHADDR_WILDCARD "\\d?"
36 #else
37 #define ENV_DOT_ESCAPE
38 #define ETHADDR_WILDCARD
39 #endif
40 
41 #ifdef CONFIG_CMD_DNS
42 #define DNS_CALLBACK "dnsip:dnsip,"
43 #else
44 #define DNS_CALLBACK
45 #endif
46 
47 #ifdef CONFIG_CMD_NET
48 #define NET_CALLBACKS \
49 	"bootfile:bootfile," \
50 	"ipaddr:ipaddr," \
51 	"gatewayip:gatewayip," \
52 	"netmask:netmask," \
53 	"serverip:serverip," \
54 	"nvlan:nvlan," \
55 	"vlan:vlan," \
56 	DNS_CALLBACK \
57 	"eth" ETHADDR_WILDCARD "addr:ethaddr,"
58 #else
59 #define NET_CALLBACKS
60 #endif
61 
62 /*
63  * This list of callback bindings is static, but may be overridden by defining
64  * a new association in the ".callbacks" environment variable.
65  */
66 #define ENV_CALLBACK_LIST_STATIC ENV_DOT_ESCAPE ENV_CALLBACK_VAR ":callbacks," \
67 	ENV_DOT_ESCAPE ENV_FLAGS_VAR ":flags," \
68 	"baudrate:baudrate," \
69 	NET_CALLBACKS \
70 	"loadaddr:loadaddr," \
71 	SILENT_CALLBACK \
72 	SPLASHIMAGE_CALLBACK \
73 	"stdin:console,stdout:console,stderr:console," \
74 	"serial#:serialno," \
75 	CONFIG_ENV_CALLBACK_LIST_STATIC
76 
77 struct env_clbk_tbl {
78 	const char *name;		/* Callback name */
79 	int (*callback)(const char *name, const char *value, enum env_op op,
80 		int flags);
81 };
82 
83 void env_callback_init(ENTRY *var_entry);
84 
85 /*
86  * Define a callback that can be associated with variables.
87  * when associated through the ".callbacks" environment variable, the callback
88  * will be executed any time the variable is inserted, overwritten, or deleted.
89  */
90 #ifdef CONFIG_SPL_BUILD
91 #define U_BOOT_ENV_CALLBACK(name, callback) \
92 	static inline __maybe_unused void _u_boot_env_noop_##name(void) \
93 	{ \
94 		(void)callback; \
95 	}
96 #else
97 #define U_BOOT_ENV_CALLBACK(name, callback) \
98 	ll_entry_declare(struct env_clbk_tbl, name, env_clbk) = \
99 	{#name, callback}
100 #endif
101 
102 #endif /* __ENV_CALLBACK_H__ */
103