xref: /rk3399_rockchip-uboot/include/env_attr.h (revision 170ab11075d3be56e89d6444abf1148329130f4b)
1*170ab110SJoe Hershberger /*
2*170ab110SJoe Hershberger  * (C) Copyright 2012
3*170ab110SJoe Hershberger  * Joe Hershberger, National Instruments, joe.hershberger@ni.com
4*170ab110SJoe Hershberger  *
5*170ab110SJoe Hershberger  * See file CREDITS for list of people who contributed to this
6*170ab110SJoe Hershberger  * project.
7*170ab110SJoe Hershberger  *
8*170ab110SJoe Hershberger  * This program is free software; you can redistribute it and/or
9*170ab110SJoe Hershberger  * modify it under the terms of the GNU General Public License as
10*170ab110SJoe Hershberger  * published by the Free Software Foundation; either version 2 of
11*170ab110SJoe Hershberger  * the License, or (at your option) any later version.
12*170ab110SJoe Hershberger  *
13*170ab110SJoe Hershberger  * This program is distributed in the hope that it will be useful,
14*170ab110SJoe Hershberger  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15*170ab110SJoe Hershberger  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16*170ab110SJoe Hershberger  * GNU General Public License for more details.
17*170ab110SJoe Hershberger  *
18*170ab110SJoe Hershberger  * You should have received a copy of the GNU General Public License
19*170ab110SJoe Hershberger  * along with this program; if not, write to the Free Software
20*170ab110SJoe Hershberger  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21*170ab110SJoe Hershberger  * MA 02111-1307 USA
22*170ab110SJoe Hershberger  */
23*170ab110SJoe Hershberger 
24*170ab110SJoe Hershberger #ifndef __ENV_ATTR_H__
25*170ab110SJoe Hershberger #define __ENV_ATTR_H__
26*170ab110SJoe Hershberger 
27*170ab110SJoe Hershberger #define ENV_ATTR_LIST_DELIM	','
28*170ab110SJoe Hershberger #define ENV_ATTR_SEP		':'
29*170ab110SJoe Hershberger 
30*170ab110SJoe Hershberger /*
31*170ab110SJoe Hershberger  * env_attr_walk takes as input an "attr_list" that takes the form:
32*170ab110SJoe Hershberger  *	attributes = [^,:\s]*
33*170ab110SJoe Hershberger  *	entry = name[:attributes]
34*170ab110SJoe Hershberger  *	list = entry[,list]
35*170ab110SJoe Hershberger  * It will call the "callback" function with the "name" and attribute as "value"
36*170ab110SJoe Hershberger  * The callback may return a non-0 to abort the list walk.
37*170ab110SJoe Hershberger  * This return value will be passed through to the caller.
38*170ab110SJoe Hershberger  * 0 is returned on success.
39*170ab110SJoe Hershberger  */
40*170ab110SJoe Hershberger extern int env_attr_walk(const char *attr_list,
41*170ab110SJoe Hershberger 	int (*callback)(const char *name, const char *value));
42*170ab110SJoe Hershberger 
43*170ab110SJoe Hershberger /*
44*170ab110SJoe Hershberger  * env_attr_lookup takes as input an "attr_list" with the same form as above.
45*170ab110SJoe Hershberger  * It also takes as input a "name" to look for.
46*170ab110SJoe Hershberger  * If the name is found in the list, it's value is copied into "attributes".
47*170ab110SJoe Hershberger  * There is no protection on attributes being too small for the value.
48*170ab110SJoe Hershberger  * It returns -1 if attributes is NULL, 1 if "name" is not found, 2 if
49*170ab110SJoe Hershberger  * "attr_list" is NULL.
50*170ab110SJoe Hershberger  * Returns 0 on success.
51*170ab110SJoe Hershberger  */
52*170ab110SJoe Hershberger extern int env_attr_lookup(const char *attr_list, const char *name,
53*170ab110SJoe Hershberger 	char *attributes);
54*170ab110SJoe Hershberger 
55*170ab110SJoe Hershberger #endif /* __ENV_ATTR_H__ */
56