1 // SPDX-License-Identifier: GPL-2.0
17 /* embedded_bootconfig_data is defined in bootconfig-data.S */
23 	*size = embedded_bootconfig_data_end - embedded_bootconfig_data;  in xbc_get_embedded_bootconfig()
40  * Extra Boot Config (XBC) is given as tree-structured ascii text of
41  * key-value pairs on memory.
42  * xbc_parse() parses the text to build a simple tree. Each tree node is
43  * simply a key word or a value. A key node may have a next key node or/and
44  * a child node (both key and value). A value node may have a next value
45  * node (for array).
82  * xbc_get_info() - Get the information of loaded boot config
88  * Return 0 if the boot config is initialized, or return -ENODEV.
93 		return -ENODEV;  in xbc_get_info()
105 	xbc_err_pos = (int)(p - xbc_data);  in xbc_parse_error()
107 	return -EINVAL;  in xbc_parse_error()
111  * xbc_root_node() - Get the root node of extended boot config
113  * Return the address of root node of extended boot config. If the
125  * xbc_node_index() - Get the index of XBC node
126  * @node: A target node of getting index.
128  * Return the index number of @node in XBC node list.
130 int __init xbc_node_index(struct xbc_node *node)  in xbc_node_index()  argument
132 	return node - &xbc_nodes[0];  in xbc_node_index()
136  * xbc_node_get_parent() - Get the parent XBC node
137  * @node: An XBC node.
139  * Return the parent node of @node. If the node is top node of the tree,
142 struct xbc_node * __init xbc_node_get_parent(struct xbc_node *node)  in xbc_node_get_parent()  argument
144 	return node->parent == XBC_NODE_MAX ? NULL : &xbc_nodes[node->parent];  in xbc_node_get_parent()
148  * xbc_node_get_child() - Get the child XBC node
149  * @node: An XBC node.
151  * Return the first child node of @node. If the node has no child, return
154 struct xbc_node * __init xbc_node_get_child(struct xbc_node *node)  in xbc_node_get_child()  argument
156 	return node->child ? &xbc_nodes[node->child] : NULL;  in xbc_node_get_child()
160  * xbc_node_get_next() - Get the next sibling XBC node
161  * @node: An XBC node.
163  * Return the NEXT sibling node of @node. If the node has no next sibling,
164  * return NULL. Note that even if this returns NULL, it doesn't mean @node
165  * has no siblings. (You also has to check whether the parent's child node
166  * is @node or not.)
168 struct xbc_node * __init xbc_node_get_next(struct xbc_node *node)  in xbc_node_get_next()  argument
170 	return node->next ? &xbc_nodes[node->next] : NULL;  in xbc_node_get_next()
174  * xbc_node_get_data() - Get the data of XBC node
175  * @node: An XBC node.
177  * Return the data (which is always a null terminated string) of @node.
178  * If the node has invalid data, warn and return NULL.
180 const char * __init xbc_node_get_data(struct xbc_node *node)  in xbc_node_get_data()  argument
182 	int offset = node->data & ~XBC_VALUE;  in xbc_node_get_data()
191 xbc_node_match_prefix(struct xbc_node *node, const char **prefix)  in xbc_node_match_prefix()  argument
193 	const char *p = xbc_node_get_data(node);  in xbc_node_match_prefix()
210  * xbc_node_find_subkey() - Find a subkey node which matches given key
211  * @parent: An XBC node.
214  * Search a key node under @parent which matches @key. The @key can contain
216  * node from whole tree. Return NULL if no node is matched.
221 	struct xbc_node *node;  in xbc_node_find_subkey()  local
224 		node = xbc_node_get_subkey(parent);  in xbc_node_find_subkey()
226 		node = xbc_root_node();  in xbc_node_find_subkey()
228 	while (node && xbc_node_is_key(node)) {  in xbc_node_find_subkey()
229 		if (!xbc_node_match_prefix(node, &key))  in xbc_node_find_subkey()
230 			node = xbc_node_get_next(node);  in xbc_node_find_subkey()
232 			node = xbc_node_get_subkey(node);  in xbc_node_find_subkey()
237 	return node;  in xbc_node_find_subkey()
241  * xbc_node_find_value() - Find a value node which matches given key
242  * @parent: An XBC node.
244  * @vnode: A container pointer of found XBC node.
246  * Search a value node under @parent whose (parent) key node matches @key,
249  * this searches the node from whole tree. Return the value string if a
250  * matched key found, return NULL if no node is matched.
251  * Note that this returns 0-length string and stores NULL in *@vnode if the
259 	struct xbc_node *node = xbc_node_find_subkey(parent, key);  in xbc_node_find_value()  local
261 	if (!node || !xbc_node_is_key(node))  in xbc_node_find_value()
264 	node = xbc_node_get_child(node);  in xbc_node_find_value()
265 	if (node && !xbc_node_is_value(node))  in xbc_node_find_value()
269 		*vnode = node;  in xbc_node_find_value()
271 	return node ? xbc_node_get_data(node) : "";  in xbc_node_find_value()
275  * xbc_node_compose_key_after() - Compose partial key string of the XBC node
276  * @root: Root XBC node
277  * @node: Target XBC node.
281  * Compose the partial key of the @node into @buf, which is starting right
283  * key words of @node.
284  * Returns the total length of the key stored in @buf. Returns -EINVAL
285  * if @node is NULL or @root is not the ancestor of @node or @root is @node,
286  * or returns -ERANGE if the key depth is deeper than max depth.
287  * This is expected to be used with xbc_find_node() to list up all (child)
291 				      struct xbc_node *node,  in xbc_node_compose_key_after()  argument
297 	if (!node || node == root)  in xbc_node_compose_key_after()
298 		return -EINVAL;  in xbc_node_compose_key_after()
300 	if (xbc_node_is_value(node))  in xbc_node_compose_key_after()
301 		node = xbc_node_get_parent(node);  in xbc_node_compose_key_after()
303 	while (node && node != root) {  in xbc_node_compose_key_after()
304 		keys[depth++] = xbc_node_index(node);  in xbc_node_compose_key_after()
306 			return -ERANGE;  in xbc_node_compose_key_after()
307 		node = xbc_node_get_parent(node);  in xbc_node_compose_key_after()
309 	if (!node && root)  in xbc_node_compose_key_after()
310 		return -EINVAL;  in xbc_node_compose_key_after()
312 	while (--depth >= 0) {  in xbc_node_compose_key_after()
313 		node = xbc_nodes + keys[depth];  in xbc_node_compose_key_after()
314 		ret = snprintf(buf, size, "%s%s", xbc_node_get_data(node),  in xbc_node_compose_key_after()
321 			size -= ret;  in xbc_node_compose_key_after()
331  * xbc_node_find_next_leaf() - Find the next leaf node under given node
332  * @root: An XBC root node
333  * @node: An XBC node which starts from.
335  * Search the next leaf node (which means the terminal key node) of @node
336  * under @root node (including @root node itself).
337  * Return the next node or NULL if next leaf node is not found.
340 						 struct xbc_node *node)  in xbc_node_find_next_leaf()  argument
347 	if (!node) {	/* First try */  in xbc_node_find_next_leaf()
348 		node = root;  in xbc_node_find_next_leaf()
349 		if (!node)  in xbc_node_find_next_leaf()
350 			node = xbc_nodes;  in xbc_node_find_next_leaf()
352 		/* Leaf node may have a subkey */  in xbc_node_find_next_leaf()
353 		next = xbc_node_get_subkey(node);  in xbc_node_find_next_leaf()
355 			node = next;  in xbc_node_find_next_leaf()
359 		if (node == root)	/* @root was a leaf, no child node. */  in xbc_node_find_next_leaf()
362 		while (!node->next) {  in xbc_node_find_next_leaf()
363 			node = xbc_node_get_parent(node);  in xbc_node_find_next_leaf()
364 			if (node == root)  in xbc_node_find_next_leaf()
366 			/* User passed a node which is not uder parent */  in xbc_node_find_next_leaf()
367 			if (WARN_ON(!node))  in xbc_node_find_next_leaf()
370 		node = xbc_node_get_next(node);  in xbc_node_find_next_leaf()
374 	while (node && !xbc_node_is_leaf(node))  in xbc_node_find_next_leaf()
375 		node = xbc_node_get_child(node);  in xbc_node_find_next_leaf()
377 	return node;  in xbc_node_find_next_leaf()
381  * xbc_node_find_next_key_value() - Find the next key-value pair nodes
382  * @root: An XBC root node
383  * @leaf: A container pointer of XBC node which starts from.
385  * Search the next leaf node (which means the terminal key node) of *@leaf
386  * under @root node. Returns the value and update *@leaf if next leaf node
387  * is found, or NULL if no next leaf node is found.
388  * Note that this returns 0-length string if the key has no value, or
401 	if ((*leaf)->child)  in xbc_node_find_next_key_value()
409 static int __init xbc_init_node(struct xbc_node *node, char *data, uint32_t flag)  in xbc_init_node()  argument
411 	unsigned long offset = data - xbc_data;  in xbc_init_node()
414 		return -EINVAL;  in xbc_init_node()
416 	node->data = (uint16_t)offset | flag;  in xbc_init_node()
417 	node->child = 0;  in xbc_init_node()
418 	node->next = 0;  in xbc_init_node()
425 	struct xbc_node *node;  in xbc_add_node()  local
430 	node = &xbc_nodes[xbc_node_num++];  in xbc_add_node()
431 	if (xbc_init_node(node, data, flag) < 0)  in xbc_add_node()
434 	return node;  in xbc_add_node()
437 static inline __init struct xbc_node *xbc_last_sibling(struct xbc_node *node)  in xbc_last_sibling()  argument
439 	while (node->next)  in xbc_last_sibling()
440 		node = xbc_node_get_next(node);  in xbc_last_sibling()
442 	return node;  in xbc_last_sibling()
445 static inline __init struct xbc_node *xbc_last_child(struct xbc_node *node)  in xbc_last_child()  argument
447 	while (node->child)  in xbc_last_child()
448 		node = xbc_node_get_child(node);  in xbc_last_child()
450 	return node;  in xbc_last_child()
455 	struct xbc_node *sib, *node = xbc_add_node(data, flag);  in __xbc_add_sibling()  local
457 	if (node) {  in __xbc_add_sibling()
460 			node->parent = XBC_NODE_MAX;  in __xbc_add_sibling()
462 			sib->next = xbc_node_index(node);  in __xbc_add_sibling()
464 			node->parent = xbc_node_index(last_parent);  in __xbc_add_sibling()
465 			if (!last_parent->child || head) {  in __xbc_add_sibling()
466 				node->next = last_parent->child;  in __xbc_add_sibling()
467 				last_parent->child = xbc_node_index(node);  in __xbc_add_sibling()
471 				sib->next = xbc_node_index(node);  in __xbc_add_sibling()
477 	return node;  in __xbc_add_sibling()
492 	struct xbc_node *node = xbc_add_sibling(data, flag);  in xbc_add_child()  local
494 	if (node)  in xbc_add_child()
495 		last_parent = node;  in xbc_add_child()
497 	return node;  in xbc_add_child()
505 	while (isalnum(*key) || *key == '-' || *key == '_')  in xbc_valid_keyword()
543 	brace_index--;  in __xbc_close_brace()
551 		last_parent = &xbc_nodes[open_brace[brace_index - 1]];  in __xbc_close_brace()
557  * Return delimiter or error, no node added. As same as lib/cmdline.c,
574 	p = v - 1;  in __xbc_parse_value()
611 	struct xbc_node *node;  in xbc_parse_array()  local
615 	if (last_parent->child)  in xbc_parse_array()
623 		node = xbc_add_child(*__v, XBC_VALUE);  in xbc_parse_array()
624 		if (!node)  in xbc_parse_array()
625 			return -ENOMEM;  in xbc_parse_array()
628 	node->child = 0;  in xbc_parse_array()
634 struct xbc_node *find_match_node(struct xbc_node *node, char *k)  in find_match_node()  argument
636 	while (node) {  in find_match_node()
637 		if (!strcmp(xbc_node_get_data(node), k))  in find_match_node()
639 		node = xbc_node_get_next(node);  in find_match_node()
641 	return node;  in find_match_node()
646 	struct xbc_node *node, *child;  in __xbc_add_key()  local
655 		node = find_match_node(xbc_nodes, k);  in __xbc_add_key()
657 		child = xbc_node_get_child(last_parent);  in __xbc_add_key()
658 		/* Since the value node is the first child, skip it. */  in __xbc_add_key()
659 		if (child && xbc_node_is_value(child))  in __xbc_add_key()
660 			child = xbc_node_get_next(child);  in __xbc_add_key()
661 		node = find_match_node(child, k);  in __xbc_add_key()
664 	if (node)  in __xbc_add_key()
665 		last_parent = node;  in __xbc_add_key()
668 		node = xbc_add_child(k, XBC_KEY);  in __xbc_add_key()
669 		if (!node)  in __xbc_add_key()
670 			return -ENOMEM;  in __xbc_add_key()
695 	struct xbc_node *child;  in xbc_parse_kv()  local
707 	child = xbc_node_get_child(last_parent);  in xbc_parse_kv()
708 	if (child && xbc_node_is_value(child)) {  in xbc_parse_kv()
712 			unsigned short nidx = child->next;  in xbc_parse_kv()
714 			xbc_init_node(child, v, XBC_VALUE);  in xbc_parse_kv()
715 			child->next = nidx;	/* keep subkeys */  in xbc_parse_kv()
719 		last_parent = xbc_last_child(child);  in xbc_parse_kv()
721 	/* The value node should always be the first child */  in xbc_parse_kv()
723 		return -ENOMEM;  in xbc_parse_kv()
735 		ret = __xbc_close_brace(next - 1);  in xbc_parse_kv()
771 	return __xbc_open_brace(n - 1);  in xbc_open_brace()
783 	return __xbc_close_brace(n - 1);  in xbc_close_brace()
801 		return -ENOENT;  in xbc_verify_tree()
832 		len -= wlen;  in xbc_verify_tree()
838 			len -= strlen(xbc_node_get_data(n)) + 1;  in xbc_verify_tree()
839 			depth--;  in xbc_verify_tree()
874 							q - 2);  in xbc_parse_tree()
901  * xbc_exit() - Clean up all parsed bootconfig
919  * xbc_init() - Parse given XBC file and build XBC internal tree
927  * Return the number of stored nodes (>0) if succeeded, or -errno
931  * of @buf. If the error is not a parser error, @epos will be -1.
938 		*epos = -1;  in xbc_init()
943 		return -EBUSY;  in xbc_init()
949 		return -ERANGE;  in xbc_init()
956 		return -ENOMEM;  in xbc_init()
967 		return -ENOMEM;  in xbc_init()