3
* Joe Hershberger, National Instruments, joe.hershberger@ni.com
5
* SPDX-License-Identifier: GPL-2.0+
8
#ifndef __ENV_FLAGS_H__
9
#define __ENV_FLAGS_H__
11
enum env_flags_vartype {
12
env_flags_vartype_string,
13
env_flags_vartype_decimal,
14
env_flags_vartype_hex,
15
env_flags_vartype_bool,
17
env_flags_vartype_ipaddr,
18
env_flags_vartype_macaddr,
23
enum env_flags_varaccess {
24
env_flags_varaccess_any,
25
env_flags_varaccess_readonly,
26
env_flags_varaccess_writeonce,
27
env_flags_varaccess_changedefault,
28
env_flags_varaccess_end
31
#define ENV_FLAGS_VAR ".flags"
32
#define ENV_FLAGS_ATTR_MAX_LEN 2
33
#define ENV_FLAGS_VARTYPE_LOC 0
34
#define ENV_FLAGS_VARACCESS_LOC 1
36
#ifndef CONFIG_ENV_FLAGS_LIST_STATIC
37
#define CONFIG_ENV_FLAGS_LIST_STATIC ""
41
#ifdef CONFIG_ENV_OVERWRITE
42
#define ETHADDR_FLAGS "ethaddr:ma,"
44
#ifdef CONFIG_OVERWRITE_ETHADDR_ONCE
45
#define ETHADDR_FLAGS "ethaddr:mc,"
47
#define ETHADDR_FLAGS "ethaddr:mo,"
51
#define ETHADDR_FLAGS ""
54
#ifndef CONFIG_ENV_OVERWRITE
55
#define SERIAL_FLAGS "serial#:so,"
57
#define SERIAL_FLAGS ""
60
#define ENV_FLAGS_LIST_STATIC \
63
CONFIG_ENV_FLAGS_LIST_STATIC
65
#ifdef CONFIG_CMD_ENV_FLAGS
67
* Print the whole list of available type flags.
69
void env_flags_print_vartypes(void);
71
* Print the whole list of available access flags.
73
void env_flags_print_varaccess(void);
75
* Return the name of the type.
77
const char *env_flags_get_vartype_name(enum env_flags_vartype type);
79
* Return the name of the access.
81
const char *env_flags_get_varaccess_name(enum env_flags_varaccess access);
85
* Parse the flags string from a .flags attribute list into the vartype enum.
87
enum env_flags_vartype env_flags_parse_vartype(const char *flags);
89
* Parse the flags string from a .flags attribute list into the varaccess enum.
91
enum env_flags_varaccess env_flags_parse_varaccess(const char *flags);
93
* Parse the binary flags from a hash table entry into the varaccess enum.
95
enum env_flags_varaccess env_flags_parse_varaccess_from_binflags(int binflags);
99
* Look up the type of a variable directly from the .flags var.
101
enum env_flags_vartype env_flags_get_type(const char *name);
103
* Look up the access of a variable directly from the .flags var.
105
enum env_flags_varaccess env_flags_get_access(const char *name);
107
* Validate the newval for its type to conform with the requirements defined by
108
* its flags (directly looked at the .flags var).
110
int env_flags_validate_type(const char *name, const char *newval);
112
* Validate the newval for its access to conform with the requirements defined
113
* by its flags (directly looked at the .flags var).
115
int env_flags_validate_access(const char *name, int check_mask);
117
* Validate that the proposed access to variable "name" is valid according to
118
* the defined flags for that variable, if any.
120
int env_flags_validate_varaccess(const char *name, int check_mask);
122
* Validate the parameters passed to "env set" for type compliance
124
int env_flags_validate_env_set_params(int argc, char * const argv[]);
126
#else /* !USE_HOSTCC */
131
* When adding a variable to the environment, initialize the flags for that
134
void env_flags_init(ENTRY *var_entry);
137
* Validate the newval for to conform with the requirements defined by its flags
139
int env_flags_validate(const ENTRY *item, const char *newval, enum env_op op,
142
#endif /* USE_HOSTCC */
145
* These are the binary flags used in the environment entry->flags variable to
146
* decribe properties of veriables in the table
148
#define ENV_FLAGS_VARTYPE_BIN_MASK 0x00000007
149
/* The actual variable type values use the enum value (within the mask) */
150
#define ENV_FLAGS_VARACCESS_PREVENT_DELETE 0x00000008
151
#define ENV_FLAGS_VARACCESS_PREVENT_CREATE 0x00000010
152
#define ENV_FLAGS_VARACCESS_PREVENT_OVERWR 0x00000020
153
#define ENV_FLAGS_VARACCESS_PREVENT_NONDEF_OVERWR 0x00000040
154
#define ENV_FLAGS_VARACCESS_BIN_MASK 0x00000078
156
#endif /* __ENV_FLAGS_H__ */