u-boot/include/env.h
Simon Glass 3f989e7b0e env: Move env_relocate() to env.h
Move env_relocate() over to the new header file.

Signed-off-by: Simon Glass <sjg@chromium.org>
Acked-by: Joe Hershberger <joe.hershberger@ni.com>
2019-08-11 16:43:41 -04:00

69 lines
1.9 KiB
C

/* SPDX-License-Identifier: GPL-2.0+ */
/*
* Common environment functions
*
* (C) Copyright 2000-2009
* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
*/
#ifndef __ENV_H
#define __ENV_H
#include <stdbool.h>
/**
* env_get_id() - Gets a sequence number for the environment
*
* This value increments every time the environment changes, so can be used an
* an indication of this
*
* @return environment ID
*/
int env_get_id(void);
/**
* env_init() - Set up the pre-relocation environment
*
* This locates the environment or uses the default if nothing is available.
* This must be called before env_get() will work.
*
* @return 0 if OK, -ENODEV if no environment drivers are enabled
*/
int env_init(void);
/**
* env_relocate() - Set up the post-relocation environment
*
* This loads the environment into RAM so that it can be modified. This is
* called after relocation, before the environment is used
*/
void env_relocate(void);
/**
* env_get_f() - Look up the value of an environment variable (early)
*
* This function is called from env_get() if the environment has not been
* loaded yet (GD_FLG_ENV_READY flag is 0). Some environment locations will
* support reading the value (slowly) and some will not.
*
* @varname: Variable to look up
* @return value of variable, or NULL if not found
*/
int env_get_f(const char *name, char *buf, unsigned int len);
/**
* env_complete() - return an auto-complete for environment variables
*
* @var: partial name to auto-complete
* @maxv: Maximum number of matches to return
* @cmdv: Returns a list of possible matches
* @maxsz: Size of buffer to use for matches
* @buf: Buffer to use for matches
* @dollar_comp: non-zero to wrap each match in ${...}
* @return number of matches found (in @cmdv)
*/
int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf,
bool dollar_comp);
#endif