/* SPDX-License-Identifier: GPL-2.0+ */

  /*
   * (C) Copyright 2012
   * Joe Hershberger, National Instruments, joe.hershberger@ni.com

   */
  
  #ifndef __ENV_CALLBACK_H__
  #define __ENV_CALLBACK_H__

  #include <env_flags.h>

  #include <linker_lists.h>
  #include <search.h>
  
  #define ENV_CALLBACK_VAR ".callbacks"
  
  /* Board configs can define additional static callback bindings */
  #ifndef CONFIG_ENV_CALLBACK_LIST_STATIC
  #define CONFIG_ENV_CALLBACK_LIST_STATIC
  #endif

  #ifdef CONFIG_SILENT_CONSOLE
  #define SILENT_CALLBACK "silent:silent,"
  #else
  #define SILENT_CALLBACK
  #endif

  #ifdef CONFIG_SPLASHIMAGE_GUARD
  #define SPLASHIMAGE_CALLBACK "splashimage:splashimage,"
  #else
  #define SPLASHIMAGE_CALLBACK
  #endif

  #ifdef CONFIG_REGEX
  #define ENV_DOT_ESCAPE "\\"
  #else
  #define ENV_DOT_ESCAPE
  #endif

  #ifdef CONFIG_CMD_DNS
  #define DNS_CALLBACK "dnsip:dnsip,"
  #else
  #define DNS_CALLBACK
  #endif

  #ifdef CONFIG_CMD_NET

  #define NET_CALLBACKS \
  	"bootfile:bootfile," \
  	"ipaddr:ipaddr," \
  	"gatewayip:gatewayip," \
  	"netmask:netmask," \
  	"serverip:serverip," \
  	"nvlan:nvlan," \
  	"vlan:vlan," \

  	DNS_CALLBACK \

  	"eth" ETHADDR_WILDCARD "addr:ethaddr,"

  #else
  #define NET_CALLBACKS
  #endif

  /*
   * This list of callback bindings is static, but may be overridden by defining
   * a new association in the ".callbacks" environment variable.
   */

  #define ENV_CALLBACK_LIST_STATIC ENV_DOT_ESCAPE ENV_CALLBACK_VAR ":callbacks," \
  	ENV_DOT_ESCAPE ENV_FLAGS_VAR ":flags," \

  	"baudrate:baudrate," \

  	NET_CALLBACKS \

  	"loadaddr:loadaddr," \

  	SILENT_CALLBACK \

  	SPLASHIMAGE_CALLBACK \

  	"stdin:console,stdout:console,stderr:console," \

  	"serial#:serialno," \

  	CONFIG_ENV_CALLBACK_LIST_STATIC
  
  struct env_clbk_tbl {
  	const char *name;		/* Callback name */
  	int (*callback)(const char *name, const char *value, enum env_op op,
  		int flags);
  };

  void env_callback_init(ENTRY *var_entry);
  
  /*
   * Define a callback that can be associated with variables.
   * when associated through the ".callbacks" environment variable, the callback
   * will be executed any time the variable is inserted, overwritten, or deleted.
   */

  #ifdef CONFIG_SPL_BUILD
  #define U_BOOT_ENV_CALLBACK(name, callback) \

  	static inline __maybe_unused void _u_boot_env_noop_##name(void) \

  	{ \
  		(void)callback; \
  	}
  #else

  #define U_BOOT_ENV_CALLBACK(name, callback) \

  	ll_entry_declare(struct env_clbk_tbl, name, env_clbk) = \

  	{#name, callback}

  #endif

  
  #endif /* __ENV_CALLBACK_H__ */