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