[people/ms/u-boot.git] / include / env_attr.h

/*
 * (C) Copyright 2012
 * Joe Hershberger, National Instruments, joe.hershberger@ni.com
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#ifndef __ENV_ATTR_H__
#define __ENV_ATTR_H__

#define ENV_ATTR_LIST_DELIM	','
#define ENV_ATTR_SEP		':'

/*
 * env_attr_walk takes as input an "attr_list" that takes the form:
 *	attributes = [^,:\s]*
 *	entry = name[:attributes]
 *	list = entry[,list]
 * It will call the "callback" function with the "name" and "attributes"
 * The callback may return a non-0 to abort the list walk.
 * This return value will be passed through to the caller.
 * 0 is returned on success.
 */
int env_attr_walk(const char *attr_list,
	int (*callback)(const char *name, const char *attributes, void *priv),
	void *priv);

/*
 * env_attr_lookup takes as input an "attr_list" with the same form as above.
 * It also takes as input a "name" to look for.
 * If the name is found in the list, it's value is copied into "attributes".
 * There is no protection on attributes being too small for the value.
 * It returns -1 if attributes is NULL, 1 if "name" is not found, 2 if
 * "attr_list" is NULL.
 * Returns 0 on success.
 */
int env_attr_lookup(const char *attr_list, const char *name, char *attributes);

#endif /* __ENV_ATTR_H__ */
Commit	Line	Data
170ab110 JH	1	/*
	2	* (C) Copyright 2012
	3	* Joe Hershberger, National Instruments, joe.hershberger@ni.com
	4	*
1a459660	5	* SPDX-License-Identifier: GPL-2.0+
170ab110 JH	6	*/
	7
	8	#ifndef __ENV_ATTR_H__
	9	#define __ENV_ATTR_H__
	10
	11	#define ENV_ATTR_LIST_DELIM ','
	12	#define ENV_ATTR_SEP ':'
	13
	14	/*
	15	* env_attr_walk takes as input an "attr_list" that takes the form:
	16	* attributes = [^,:\s]*
	17	* entry = name[:attributes]
	18	* list = entry[,list]
cca98fd6	19	* It will call the "callback" function with the "name" and "attributes"
170ab110 JH	20	* The callback may return a non-0 to abort the list walk.
	21	* This return value will be passed through to the caller.
	22	* 0 is returned on success.
	23	*/
cca98fd6 JH	24	int env_attr_walk(const char *attr_list,
	25	int (callback)(const char name, const char attributes, void priv),
	26	void *priv);
170ab110 JH	27
	28	/*
	29	* env_attr_lookup takes as input an "attr_list" with the same form as above.
	30	* It also takes as input a "name" to look for.
	31	* If the name is found in the list, it's value is copied into "attributes".
	32	* There is no protection on attributes being too small for the value.
	33	* It returns -1 if attributes is NULL, 1 if "name" is not found, 2 if
	34	* "attr_list" is NULL.
	35	* Returns 0 on success.
	36	*/
cca98fd6	37	int env_attr_lookup(const char attr_list, const char name, char *attributes);
170ab110 JH	38
170ab110 JH	39	#endif /* __ENV_ATTR_H__ */