1 /* SPDX-License-Identifier: GPL-2.0+ */
4 * Joe Hershberger, National Instruments, joe.hershberger@ni.com
7 #ifndef __ENV_FLAGS_H__
8 #define __ENV_FLAGS_H__
10 enum env_flags_vartype
{
11 env_flags_vartype_string
,
12 env_flags_vartype_decimal
,
13 env_flags_vartype_hex
,
14 env_flags_vartype_bool
,
16 env_flags_vartype_ipaddr
,
17 env_flags_vartype_macaddr
,
22 enum env_flags_varaccess
{
23 env_flags_varaccess_any
,
24 env_flags_varaccess_readonly
,
25 env_flags_varaccess_writeonce
,
26 env_flags_varaccess_changedefault
,
27 #ifdef CONFIG_ENV_WRITEABLE_LIST
28 env_flags_varaccess_writeable
,
30 env_flags_varaccess_end
33 #define ENV_FLAGS_VAR ".flags"
34 #define ENV_FLAGS_ATTR_MAX_LEN 2
35 #define ENV_FLAGS_VARTYPE_LOC 0
36 #define ENV_FLAGS_VARACCESS_LOC 1
38 #ifndef CONFIG_ENV_FLAGS_LIST_STATIC
39 #define CONFIG_ENV_FLAGS_LIST_STATIC ""
44 #define ETHADDR_WILDCARD "\\d*"
46 #define ETHADDR_WILDCARD
48 #ifdef CONFIG_ENV_OVERWRITE
49 #define ETHADDR_FLAGS "eth" ETHADDR_WILDCARD "addr:ma,"
51 #ifdef CONFIG_OVERWRITE_ETHADDR_ONCE
52 #define ETHADDR_FLAGS "eth" ETHADDR_WILDCARD "addr:mc,"
54 #define ETHADDR_FLAGS "eth" ETHADDR_WILDCARD "addr:mo,"
70 #ifndef CONFIG_ENV_OVERWRITE
71 #define SERIAL_FLAGS "serial#:so,"
73 #define SERIAL_FLAGS ""
76 #define ENV_FLAGS_LIST_STATIC \
80 CONFIG_ENV_FLAGS_LIST_STATIC
82 #ifdef CONFIG_CMD_ENV_FLAGS
84 * Print the whole list of available type flags.
86 void env_flags_print_vartypes(void);
88 * Print the whole list of available access flags.
90 void env_flags_print_varaccess(void);
92 * Return the name of the type.
94 const char *env_flags_get_vartype_name(enum env_flags_vartype type
);
96 * Return the name of the access.
98 const char *env_flags_get_varaccess_name(enum env_flags_varaccess access
);
102 * Parse the flags string from a .flags attribute list into the vartype enum.
104 enum env_flags_vartype
env_flags_parse_vartype(const char *flags
);
106 * Parse the flags string from a .flags attribute list into the varaccess enum.
108 enum env_flags_varaccess
env_flags_parse_varaccess(const char *flags
);
110 * Parse the binary flags from a hash table entry into the varaccess enum.
112 enum env_flags_varaccess
env_flags_parse_varaccess_from_binflags(int binflags
);
114 #ifdef CONFIG_CMD_NET
116 * Check if a string has the format of an Ethernet MAC address
118 int eth_validate_ethaddr_str(const char *addr
);
123 * Look up the type of a variable directly from the .flags var.
125 enum env_flags_vartype
env_flags_get_type(const char *name
);
127 * Look up the access of a variable directly from the .flags var.
129 enum env_flags_varaccess
env_flags_get_access(const char *name
);
131 * Validate the newval for its type to conform with the requirements defined by
132 * its flags (directly looked at the .flags var).
134 int env_flags_validate_type(const char *name
, const char *newval
);
136 * Validate the newval for its access to conform with the requirements defined
137 * by its flags (directly looked at the .flags var).
139 int env_flags_validate_access(const char *name
, int check_mask
);
141 * Validate that the proposed access to variable "name" is valid according to
142 * the defined flags for that variable, if any.
144 int env_flags_validate_varaccess(const char *name
, int check_mask
);
146 * Validate the parameters passed to "env set" for type compliance
148 int env_flags_validate_env_set_params(char *name
, char *const val
[], int count
);
150 #else /* !USE_HOSTCC */
156 * When adding a variable to the environment, initialize the flags for that
159 void env_flags_init(struct env_entry
*var_entry
);
162 * Validate the newval for to conform with the requirements defined by its flags
164 int env_flags_validate(const struct env_entry
*item
, const char *newval
,
165 enum env_op op
, int flag
);
167 #endif /* USE_HOSTCC */
170 * These are the binary flags used in the environment entry->flags variable to
171 * decribe properties of veriables in the table
173 #define ENV_FLAGS_VARTYPE_BIN_MASK 0x00000007
174 /* The actual variable type values use the enum value (within the mask) */
175 #define ENV_FLAGS_VARACCESS_PREVENT_DELETE 0x00000008
176 #define ENV_FLAGS_VARACCESS_PREVENT_CREATE 0x00000010
177 #define ENV_FLAGS_VARACCESS_PREVENT_OVERWR 0x00000020
178 #define ENV_FLAGS_VARACCESS_PREVENT_NONDEF_OVERWR 0x00000040
179 #define ENV_FLAGS_VARACCESS_WRITEABLE 0x00000080
180 #define ENV_FLAGS_VARACCESS_BIN_MASK 0x000000f8
182 #endif /* __ENV_FLAGS_H__ */