env: Rename some other getenv()-related functions

[u-boot] / include / environment.h

diff --git a/include/environment.h b/include/environment.h
index 6f94986c6b3e0fca6c4954ed83fb0f9cf148cc78..9a4421523555db78d0f86495e0cbeb2b720242dc 100644 (file)
--- a/include/environment.h
+++ b/include/environment.h
@@ -143,10 +143,6 @@ extern unsigned long nand_env_oob_offset;
 # define ENV_HEADER_SIZE       (sizeof(uint32_t))
 #endif
 
-#if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
-extern char *env_name_spec;
-#endif
-
 #ifdef CONFIG_ENV_AES
 /* Make sure the payload is multiple of AES block size */
 #define ENV_SIZE ((CONFIG_ENV_SIZE - ENV_HEADER_SIZE) & ~(16 - 1))
@@ -174,9 +170,6 @@ extern env_t environment;
 extern const unsigned char default_environment[];
 extern env_t *env_ptr;
 
-extern void env_relocate_spec(void);
-extern unsigned char env_get_char_spec(int);
-
 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
 extern void env_reloc(void);
 #endif
@@ -197,20 +190,99 @@ extern uint mmc_get_env_part(struct mmc *mmc);
 #include <env_flags.h>
 #include <search.h>
 
-extern struct hsearch_data env_htab;
+/* Value for environment validity */
+enum env_valid {
+       ENV_INVALID,    /* No valid environment */
+       ENV_VALID,      /* First or only environment is valid */
+       ENV_REDUND,     /* Redundant environment is valid */
+};
+
+enum env_location {
+       ENVL_DATAFLASH,
+       ENVL_EEPROM,
+       ENVL_EXT4,
+       ENVL_FAT,
+       ENVL_FLASH,
+       ENVL_MMC,
+       ENVL_NAND,
+       ENVL_NVRAM,
+       ENVL_ONENAND,
+       ENVL_REMOTE,
+       ENVL_SPI_FLASH,
+       ENVL_UBI,
+       ENVL_NOWHERE,
+
+       ENVL_COUNT,
+       ENVL_UNKNOWN,
+};
+
+struct env_driver {
+       const char *name;
+       enum env_location location;
+
+       /**
+        * get_char() - Read a character from the environment
+        *
+        * This method is optional. If not provided, a default implementation
+        * will read from gd->env_addr.
+        *
+        * @index: Index of character to read (0=first)
+        * @return character read
+        */
+       unsigned char (*get_char)(int index);
+
+       /**
+        * load() - Load the environment from storage
+        *
+        * This method is optional. If not provided, no environment will be
+        * loaded.
+        */
+       void (*load)(void);
+
+       /**
+        * save() - Save the environment to storage
+        *
+        * This method is required for 'saveenv' to work.
+        *
+        * @return 0 if OK, -ve on error
+        */
+       int (*save)(void);
+
+       /**
+        * init() - Set up the initial pre-relocation environment
+        *
+        * This method is optional.
+        *
+        * @return 0 if OK, -ENOENT if no initial environment could be found,
+        * other -ve on error
+        */
+       int (*init)(void);
+};
+
+/* Declare a new environment location driver */
+#define U_BOOT_ENV_LOCATION(__name)                                    \
+       ll_entry_declare(struct env_driver, __name, env_driver)
+
+/* Declare the name of a location */
+#ifdef CONFIG_CMD_SAVEENV
+#define ENV_NAME(_name) .name = _name,
+#else
+#define ENV_NAME(_name)
+#endif
 
-/* Function that returns a character from the environment */
-unsigned char env_get_char(int);
+#ifdef CONFIG_CMD_SAVEENV
+#define env_save_ptr(x) x
+#else
+#define env_save_ptr(x) NULL
+#endif
 
-/* Function that returns a pointer to a value from the environment */
-const unsigned char *env_get_addr(int);
-unsigned char env_get_char_memory(int index);
+extern struct hsearch_data env_htab;
 
 /* Function that updates CRC of the enironment */
 void env_crc_update(void);
 
 /* Look up the variable from the default environment */
-char *getenv_default(const char *name);
+char *env_get_default(const char *name);
 
 /* [re]set to the default environment */
 void set_default_env(const char *s);
@@ -224,6 +296,42 @@ int env_import(const char *buf, int check);
 /* Export from hash table into binary representation */
 int env_export(env_t *env_out);
 
+#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
+/* Select and import one of two redundant environments */
+int env_import_redund(const char *buf1, const char *buf2);
+#endif
+
+/**
+ * env_driver_lookup_default() - Look up the default environment driver
+ *
+ * @return pointer to driver, or NULL if none (which should not happen)
+ */
+struct env_driver *env_driver_lookup_default(void);
+
+/**
+ * env_get_char() - Get a character from the early environment
+ *
+ * This reads from the pre-relocation environemnt
+ *
+ * @index: Index of character to read (0 = first)
+ * @return character read, or -ve on error
+ */
+int env_get_char(int index);
+
+/**
+ * env_load() - Load the environment from storage
+ *
+ * @return 0 if OK, -ve on error
+ */
+int env_load(void);
+
+/**
+ * env_save() - Save the environment to storage
+ *
+ * @return 0 if OK, -ve on error
+ */
+int env_save(void);
+
 #endif /* DO_DEPS_ONLY */
 
 #endif /* _ENVIRONMENT_H_ */