X-Git-Url: http://git.ozlabs.org/?p=petitboot;a=blobdiff_plain;f=discover%2Fparser.h;h=2aaa07744d62281334df79fdaa3411321a4cc5d5;hp=c2f02d683d3f50b85b487752ac256f68e9abdc7b;hb=9fbd73a208c9465b4bf9e2c80c7290b72e62ead1;hpb=39e06f5cfda0ed0c1eeb7a7604a3d05dda81ccf1;ds=sidebyside

diff --git a/discover/parser.h b/discover/parser.h
index c2f02d6..2aaa077 100644
--- a/discover/parser.h
+++ b/discover/parser.h
@@ -1,12 +1,39 @@
 #ifndef _PARSER_H
 #define _PARSER_H
 
+#include <stdbool.h>
+
+#include "device-handler.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;
+	enum conf_method	method;
 	const char * const	*filenames;
-	int			(*parse)(struct discover_context *ctx);
+	int			(*parse)(struct discover_context *ctx,
+						char *buf, int len);
+	bool			(*resolve_resource)(
+						struct device_handler *handler,
+						struct resource *res);
 };
 
 enum generic_icon_type {
@@ -21,7 +48,20 @@ enum generic_icon_type {
 
 void parser_init(void);
 
-void iterate_parsers(struct discover_context *ctx);
+void iterate_parsers(struct discover_context *ctx, enum conf_method method);
 int parse_user_event(struct discover_context *ctx, struct event *event);
 
+/* File IO functions for parsers; these should be the only interface that
+ * parsers use to access a device's filesystem.
+ *
+ * These are intended for small amounts of data, typically text configuration
+ * and state files.
+ */
+int parser_request_file(struct discover_context *ctx,
+		struct discover_device *dev, const char *filename,
+		char **buf, int *len);
+int parser_replace_file(struct discover_context *ctx,
+		struct discover_device *dev, const char *filename,
+		char *buf, int len);
+
 #endif /* _PARSER_H */