Merge git://git.denx.de/u-boot-mmc

[people/ms/u-boot.git] / include / environment.h

diff --git a/include/environment.h b/include/environment.h
index ad2331c90b4d8f2e1f162b37ad1b6174b7c9a368..7986a242778d1cc3cf37ea29953b4e74e01308f0 100644 (file)
--- a/include/environment.h
+++ b/include/environment.h
@@ -143,16 +143,7 @@ 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))
-#else
 #define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE)
-#endif
 
 typedef struct environment_s {
        uint32_t        crc;            /* CRC32 over data bytes        */
@@ -160,12 +151,7 @@ typedef struct environment_s {
        unsigned char   flags;          /* active/obsolete flags        */
 #endif
        unsigned char   data[ENV_SIZE]; /* Environment data             */
-} env_t
-#ifdef CONFIG_ENV_AES
-/* Make sure the env is aligned to block size. */
-__attribute__((aligned(16)))
-#endif
-;
+} env_t;
 
 #ifdef ENV_IS_EMBEDDED
 extern env_t environment;
@@ -174,9 +160,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
@@ -204,16 +187,90 @@ enum env_valid {
        ENV_REDUND,     /* Redundant environment is valid */
 };
 
-extern struct hsearch_data env_htab;
+enum env_location {
+       ENVL_UNKNOWN,
+       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,
+};
+
+/* value for the various operations we want to perform on the env */
+enum env_operation {
+       ENVOP_GET_CHAR, /* we want to call the get_char function */
+       ENVOP_INIT,     /* we want to call the init function */
+       ENVOP_LOAD,     /* we want to call the load function */
+       ENVOP_SAVE,     /* we want to call the save function */
+};
+
+struct env_driver {
+       const char *name;
+       enum env_location location;
+
+       /**
+        * load() - Load the environment from storage
+        *
+        * This method is optional. If not provided, no environment will be
+        * loaded.
+        *
+        * @return 0 if OK, -ve on error
+        */
+       int (*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
+
+#ifdef CONFIG_CMD_SAVEENV
+#define env_save_ptr(x) x
+#else
+#define env_save_ptr(x) NULL
+#endif
 
-/* Function that returns a character from the environment */
-unsigned char env_get_char(int);
+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);
@@ -229,9 +286,34 @@ 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);
+int env_import_redund(const char *buf1, int buf1_status,
+                     const char *buf2, int buf2_status);
 #endif
 
+/**
+ * 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_ */