remoteproc: Support custom firmware handlers

Firmware handling is made customizable.
This is done by creating a separate ops structure for the
firmware functions that depends on a particular firmware
format (such as ELF). The ELF functions are default used
unless the HW driver explicitly injects another firmware
handler by updating rproc->fw_ops.
The function rproc_da_to_va() is exported, as custom
firmware handlers may need to use this function.

Signed-off-by: Sjur Brændeland <sjur.brandeland@stericsson.com>
[ohad: namespace fixes, whitespace fixes, style fixes]
Signed-off-by: Ohad Ben-Cohen <ohad@wizery.com>

1 files changed, 54 insertions, 5 deletions

diff --git a/drivers/remoteproc/remoteproc_internal.h b/drivers/remoteproc/remoteproc_internal.h
index a44e1926e4c3..a690ebe7aa51 100644
--- a/drivers/remoteproc/remoteproc_internal.h
+++ b/drivers/remoteproc/remoteproc_internal.h
@@ -25,6 +25,23 @@
 
 struct rproc;
 
+/**
+ * struct rproc_fw_ops - firmware format specific operations.
+ * @find_rsc_table:     finds the resource table inside the firmware image
+ * @load:               load firmeware to memory, where the remote processor
+ *                      expects to find it
+ * @sanity_check:       sanity check the fw image
+ * @get_boot_addr:      get boot address to entry point specified in firmware
+ */
+struct rproc_fw_ops {
+        struct resource_table *(*find_rsc_table) (struct rproc *rproc,
+                                                const struct firmware *fw,
+                                                int *tablesz);
+        int (*load)(struct rproc *rproc, const struct firmware *fw);
+        int (*sanity_check)(struct rproc *rproc, const struct firmware *fw);
+        u32 (*get_boot_addr)(struct rproc *rproc, const struct firmware *fw);
+};
+
 /* from remoteproc_core.c */
 void rproc_release(struct kref *kref);
 irqreturn_t rproc_vq_interrupt(struct rproc *rproc, int vq_id);
@@ -47,11 +64,43 @@ int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
 
 void *rproc_da_to_va(struct rproc *rproc, u64 da, int len);
 
+static inline
+int rproc_fw_sanity_check(struct rproc *rproc, const struct firmware *fw)
+{
+        if (rproc->fw_ops->sanity_check)
+                return rproc->fw_ops->sanity_check(rproc, fw);
+
+        return 0;
+}
+
+static inline
+u32 rproc_get_boot_addr(struct rproc *rproc, const struct firmware *fw)
+{
+        if (rproc->fw_ops->get_boot_addr)
+                return rproc->fw_ops->get_boot_addr(rproc, fw);
+
+        return 0;
+}
+
+static inline
+int rproc_load_segments(struct rproc *rproc, const struct firmware *fw)
+{
+        if (rproc->fw_ops->load)
+                return rproc->fw_ops->load(rproc, fw);
+
+        return -EINVAL;
+}
+
+static inline
 struct resource_table *rproc_find_rsc_table(struct rproc *rproc,
-                                                const struct firmware *fw,
-                                                int *tablesz);
-int rproc_load_segments(struct rproc *rproc, const struct firmware *fw);
-int rproc_fw_sanity_check(struct rproc *rproc, const struct firmware *fw);
-u32 rproc_get_boot_addr(struct rproc *rproc, const struct firmware *fw);
+                                const struct firmware *fw, int *tablesz)
+{
+        if (rproc->fw_ops->find_rsc_table)
+                return rproc->fw_ops->find_rsc_table(rproc, fw, tablesz);
+
+        return NULL;
+}
+
+extern const struct rproc_fw_ops rproc_elf_fw_ops;
 
 #endif /* REMOTEPROC_INTERNAL_H */