X-Git-Url: http://git.ozlabs.org/?p=petitboot;a=blobdiff_plain;f=discover%2Fparser.h;h=03ba8d4d704134b3a9a239c9da9f6657ff449505;hp=18c9963e863021b642f7adbd840278a99fbfe53f;hb=5be946c;hpb=4e8b779626da98e2896efbb2df99b64f76e878f6;ds=sidebyside

diff --git a/discover/parser.h b/discover/parser.h
index 18c9963..03ba8d4 100644
--- a/discover/parser.h
+++ b/discover/parser.h
@@ -1,13 +1,36 @@
 #ifndef _PARSER_H
 #define _PARSER_H
 
+#include <stdbool.h>
+
 struct discover_context;
+struct device_handler;
+struct resource;
 
+/**
+ * Our config parser.
+ *
+ * Each parser is responsible for creating discover_boot_options from config
+ * files found on new devices. The boot items discovered during parse will have
+ * 'resources' attached (see @discover_boot_option), which may already be
+ * resolved (in the case of a device-local filename, or a URL), or unresolved
+ * (in the case of a filename on another device).
+ *
+ * If the boot option contains references to unresolved resources, the
+ * device handler will not inform clients about the boot options, as
+ * they're not properly "available" at this stage. The handler will attempt to
+ * resolve them whenever new devices are discovered, by calling the parser's
+ * resolve_resource function. Once a boot option's resources are full resolved,
+ * the option can be sent to clients.
+ */
 struct parser {
 	char			*name;
 	const char * const	*filenames;
 	int			(*parse)(struct discover_context *ctx,
 						char *buf, int len);
+	bool			(*resolve_resource)(
+						struct device_handler *handler,
+						struct resource *res);
 };
 
 enum generic_icon_type {