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 ""
42 #define ETHADDR_WILDCARD "\\d?"
44 #define ETHADDR_WILDCARD
46 #ifdef CONFIG_ENV_OVERWRITE
47 #define ETHADDR_FLAGS "eth" ETHADDR_WILDCARD "addr:ma,"
49 #ifdef CONFIG_OVERWRITE_ETHADDR_ONCE
50 #define ETHADDR_FLAGS "eth" ETHADDR_WILDCARD "addr:mc,"
52 #define ETHADDR_FLAGS "eth" ETHADDR_WILDCARD "addr:mo,"
68 #ifndef CONFIG_ENV_OVERWRITE
69 #define SERIAL_FLAGS "serial#:so,"
71 #define SERIAL_FLAGS ""
74 #define ENV_FLAGS_LIST_STATIC \
78 CONFIG_ENV_FLAGS_LIST_STATIC
80 #ifdef CONFIG_CMD_ENV_FLAGS
82 * Print the whole list of available type flags.
84 void env_flags_print_vartypes(void);
86 * Print the whole list of available access flags.
88 void env_flags_print_varaccess(void);
90 * Return the name of the type.
92 const char *env_flags_get_vartype_name(enum env_flags_vartype type);
94 * Return the name of the access.
96 const char *env_flags_get_varaccess_name(enum env_flags_varaccess access);
100 * Parse the flags string from a .flags attribute list into the vartype enum.
102 enum env_flags_vartype env_flags_parse_vartype(const char *flags);
104 * Parse the flags string from a .flags attribute list into the varaccess enum.
106 enum env_flags_varaccess env_flags_parse_varaccess(const char *flags);
108 * Parse the binary flags from a hash table entry into the varaccess enum.
110 enum env_flags_varaccess env_flags_parse_varaccess_from_binflags(int binflags);
112 #ifdef CONFIG_CMD_NET
114 * Check if a string has the format of an Ethernet MAC address
116 int eth_validate_ethaddr_str(const char *addr);
121 * Look up the type of a variable directly from the .flags var.
123 enum env_flags_vartype env_flags_get_type(const char *name);
125 * Look up the access of a variable directly from the .flags var.
127 enum env_flags_varaccess env_flags_get_access(const char *name);
129 * Validate the newval for its type to conform with the requirements defined by
130 * its flags (directly looked at the .flags var).
132 int env_flags_validate_type(const char *name, const char *newval);
134 * Validate the newval for its access to conform with the requirements defined
135 * by its flags (directly looked at the .flags var).
137 int env_flags_validate_access(const char *name, int check_mask);
139 * Validate that the proposed access to variable "name" is valid according to
140 * the defined flags for that variable, if any.
142 int env_flags_validate_varaccess(const char *name, int check_mask);
144 * Validate the parameters passed to "env set" for type compliance
146 int env_flags_validate_env_set_params(char *name, char *const val[], int count);
148 #else /* !USE_HOSTCC */
153 * When adding a variable to the environment, initialize the flags for that
156 void env_flags_init(ENTRY *var_entry);
159 * Validate the newval for to conform with the requirements defined by its flags
161 int env_flags_validate(const ENTRY *item, const char *newval, enum env_op op,
164 #endif /* USE_HOSTCC */
167 * These are the binary flags used in the environment entry->flags variable to
168 * decribe properties of veriables in the table
170 #define ENV_FLAGS_VARTYPE_BIN_MASK 0x00000007
171 /* The actual variable type values use the enum value (within the mask) */
172 #define ENV_FLAGS_VARACCESS_PREVENT_DELETE 0x00000008
173 #define ENV_FLAGS_VARACCESS_PREVENT_CREATE 0x00000010
174 #define ENV_FLAGS_VARACCESS_PREVENT_OVERWR 0x00000020
175 #define ENV_FLAGS_VARACCESS_PREVENT_NONDEF_OVERWR 0x00000040
176 #define ENV_FLAGS_VARACCESS_BIN_MASK 0x00000078
178 #endif /* __ENV_FLAGS_H__ */