env: Move env_valid to env.h

[oweals/u-boot.git] / include / environment.h

diff --git a/include/environment.h b/include/environment.h
index 03b41e0c51160d295b17f4764abfb4cb6dff312e..c3e8d7840a88dd402d5e29183448bfe242d783ee 100644 (file)
--- a/include/environment.h
+++ b/include/environment.h
@@ -1,8 +1,7 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
 /*
  * (C) Copyright 2002
  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #ifndef _ENVIRONMENT_H_
@@ -143,12 +142,7 @@ extern unsigned long nand_env_oob_offset;
 # define ENV_HEADER_SIZE       (sizeof(uint32_t))
 #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        */
@@ -156,32 +150,13 @@ 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;
+extern env_t embedded_environment;
 #endif /* ENV_IS_EMBEDDED */
 
 extern const unsigned char default_environment[];
-extern env_t *env_ptr;
-
-#if defined(CONFIG_NEEDS_MANUAL_RELOC)
-extern void env_reloc(void);
-#endif
-
-#ifdef CONFIG_ENV_IS_IN_MMC
-#include <mmc.h>
-
-extern int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr);
-# ifdef CONFIG_SYS_MMC_ENV_PART
-extern uint mmc_get_env_part(struct mmc *mmc);
-# endif
-#endif
 
 #ifndef DO_DEPS_ONLY
 
@@ -190,15 +165,8 @@ extern uint mmc_get_env_part(struct mmc *mmc);
 #include <env_flags.h>
 #include <search.h>
 
-/* 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_UNKNOWN,
        ENVL_EEPROM,
        ENVL_EXT4,
        ENVL_FAT,
@@ -213,24 +181,21 @@ enum env_location {
        ENVL_NOWHERE,
 
        ENVL_COUNT,
-       ENVL_UNKNOWN,
+};
+
+/* 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 */
+       ENVOP_ERASE,    /* we want to call the erase function */
 };
 
 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, or -ve on error
-        */
-       int (*get_char)(int index);
-
        /**
         * load() - Load the environment from storage
         *
@@ -250,6 +215,15 @@ struct env_driver {
         */
        int (*save)(void);
 
+       /**
+        * erase() - Erase the environment on storage
+        *
+        * This method is optional and required for 'eraseenv' to work.
+        *
+        * @return 0 if OK, -ve on error
+        */
+       int (*erase)(void);
+
        /**
         * init() - Set up the initial pre-relocation environment
         *
@@ -280,60 +254,6 @@ struct env_driver {
 
 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 *env_get_default(const char *name);
-
-/* [re]set to the default environment */
-void set_default_env(const char *s);
-
-/* [re]set individual variables to their value in the default environment */
-int set_default_vars(int nvars, char * const vars[]);
-
-/* Import from binary representation into hash table */
-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_ */