xref: /openbmc/u-boot/include/env_attr.h (revision e8f80a5a)
1*83d290c5STom Rini /* SPDX-License-Identifier: GPL-2.0+ */
2170ab110SJoe Hershberger /*
3170ab110SJoe Hershberger  * (C) Copyright 2012
4170ab110SJoe Hershberger  * Joe Hershberger, National Instruments, joe.hershberger@ni.com
5170ab110SJoe Hershberger  */
6170ab110SJoe Hershberger 
7170ab110SJoe Hershberger #ifndef __ENV_ATTR_H__
8170ab110SJoe Hershberger #define __ENV_ATTR_H__
9170ab110SJoe Hershberger 
10170ab110SJoe Hershberger #define ENV_ATTR_LIST_DELIM	','
11170ab110SJoe Hershberger #define ENV_ATTR_SEP		':'
12170ab110SJoe Hershberger 
13170ab110SJoe Hershberger /*
14170ab110SJoe Hershberger  * env_attr_walk takes as input an "attr_list" that takes the form:
15170ab110SJoe Hershberger  *	attributes = [^,:\s]*
16170ab110SJoe Hershberger  *	entry = name[:attributes]
17170ab110SJoe Hershberger  *	list = entry[,list]
18cca98fd6SJoe Hershberger  * It will call the "callback" function with the "name" and "attributes"
19170ab110SJoe Hershberger  * The callback may return a non-0 to abort the list walk.
20170ab110SJoe Hershberger  * This return value will be passed through to the caller.
21170ab110SJoe Hershberger  * 0 is returned on success.
22170ab110SJoe Hershberger  */
23cca98fd6SJoe Hershberger int env_attr_walk(const char *attr_list,
24cca98fd6SJoe Hershberger 	int (*callback)(const char *name, const char *attributes, void *priv),
25cca98fd6SJoe Hershberger 	void *priv);
26170ab110SJoe Hershberger 
27170ab110SJoe Hershberger /*
28170ab110SJoe Hershberger  * env_attr_lookup takes as input an "attr_list" with the same form as above.
29170ab110SJoe Hershberger  * It also takes as input a "name" to look for.
30170ab110SJoe Hershberger  * If the name is found in the list, it's value is copied into "attributes".
31170ab110SJoe Hershberger  * There is no protection on attributes being too small for the value.
32170ab110SJoe Hershberger  * It returns -1 if attributes is NULL, 1 if "name" is not found, 2 if
33170ab110SJoe Hershberger  * "attr_list" is NULL.
34170ab110SJoe Hershberger  * Returns 0 on success.
35170ab110SJoe Hershberger  */
36cca98fd6SJoe Hershberger int env_attr_lookup(const char *attr_list, const char *name, char *attributes);
37170ab110SJoe Hershberger 
38170ab110SJoe Hershberger #endif /* __ENV_ATTR_H__ */
39