From: Sjur Brændeland <[email protected]>
Add firmware loader plugin for STE-modem firmware. This plugin add
functions for extracting the resource table and loading the
firmware image into shared memory.
Signed-off-by: Sjur Brændeland <[email protected]>
---
Hi Ohad,
>Any chance you have the customer loader patch ready ? Can you submit it too ?
>
>Ideally we should review (and merge) the custom fw groundwork together
>with the new fw loader.
OK, here is an early version of the STE-Modem firmware loader.
Haven't done the Makefile and Kconfig updates yet though.
I have done some basic testing on this patch, and it seems ok.
But I have one issue, I need the firmware image to be allocated
at the start of shared memory. But the vring gets allocated first.
I could work around this by calling dma_mark_declared_memory_occupied(),
from the driver and then call dma_release_from_coherent() before booting.
But this feels like a hack. Any ideas on how to handle this properly?
Regards,
Sjur
drivers/remoteproc/remoteproc_ste_modem_loader.c | 179 ++++++++++++++++++++++
1 files changed, 179 insertions(+), 0 deletions(-)
create mode 100644 drivers/remoteproc/remoteproc_ste_modem_loader.c
diff --git a/drivers/remoteproc/remoteproc_ste_modem_loader.c b/drivers/remoteproc/remoteproc_ste_modem_loader.c
new file mode 100644
index 0000000..cb823bb
--- /dev/null
+++ b/drivers/remoteproc/remoteproc_ste_modem_loader.c
@@ -0,0 +1,179 @@
+/*
+ * Copyright (C) ST-Ericsson AB 2012
+ * Author: Sjur Brendeland / [email protected]
+ * License terms: GNU General Public License (GPL) version 2.
+ */
+
+#define pr_fmt(fmt) "%s: " fmt, __func__
+#include <linux/module.h>
+#include <linux/firmware.h>
+#include <linux/remoteproc.h>
+#include "remoteproc_internal.h"
+
+#define TOC_RSC_TAB_NAME "rsc-table"
+
+/* struct toc_entry - Table of content entry
+ *
+ * @start: Offset to the image data.
+ * @size: Size of the images in bytes.
+ * @flags: Use 0 if no flags are in use.
+ * @entry_point: Modem internal information. Where to jump to start executing.
+ * Only applicable when using SDRAM. Set to 0xffffffff if unused.
+ * @load_addr: Modem internal information. Location in SDRAM to move image.
+ * Set to 0xffffffff if not applicable.
+ * @name: Name of image.
+ */
+struct toc_entry {
+ __le32 start;
+ __le32 size;
+ __le32 flags;
+ __le32 entry_point;
+ __le32 load_addr;
+ char name[12];
+};
+
+/** struct toc - Table of content
+ * @table: Table of toc entries.
+ * The Table Of Content is located at the start of the firmware image and
+ * at offset zero in the shared memory region. The resource table typically
+ * contains the initial boot image (boot strap) and other information elements
+ * such as remoteproc resource table. Each entry is identified by a unique
+ * @name.
+ */
+struct toc {
+ struct toc_entry table[32];
+};
+
+/**
+ * rproc_load_segments() - load firmware segments to memory
+ * @rproc: remote processor which will be booted using these fw segments
+ * @fw: the TOC and firmware image to load
+ *
+ * This function loads the firmware segments to memory. STE Modem SHM
+ * does not use an IOMMU, and expects the firmware containing the
+ * "Table Of Content" (TOC) first in the firmware. The TOC specifies the
+ * offset and size of the boot image.
+ */
+static int
+rproc_load_segments(struct rproc *rproc, const struct firmware *fw)
+{
+ /*
+ * STE-Modem does not use a IOMMU and the virtual and physical
+ * addresses of the device (modem) is not known. Instead
+ * offsets from the start of the shared memory region is used
+ * as device address (da).
+ *
+ * The STE-Modem must provide a carveout as the first entry with
+ * sufficient space for the firmware image. The device address in
+ * this carveout must be set to zero.
+ *
+ * The firmware must be copied into offset zero, i.e at the start of
+ * the shared memory area.
+ */
+
+ u32 offset = 0;
+ void *ptr = rproc_da_to_va(rproc, offset, fw->size);
+
+ if (!ptr) {
+ dev_err(rproc->dev, "bad offset 0x%x mem 0x%zx\n",
+ offset, fw->size);
+ return -EINVAL;
+ }
+
+ memcpy(ptr, fw->data, fw->size);
+ return 0;
+}
+
+/* Find the entry for resource table in the Table of Content */
+static struct toc_entry *__find_rsc_entry(const struct firmware *fw)
+{
+ int i;
+ struct toc *toc = (void *)fw->data;
+ int entries = ARRAY_SIZE(toc->table);
+
+ /* Search the table for the resource table */
+ for (i = 0; i < entries && toc->table[i].start != 0xffffffff; i++) {
+ if (!strncmp(toc->table[i].name, TOC_RSC_TAB_NAME,
+ sizeof(toc->table[i].name))) {
+ if (toc->table[i].start > fw->size)
+ return NULL;
+ return &toc->table[i];
+ }
+ }
+ return NULL;
+}
+
+/**
+ * rproc_find_rsc_table() - find the resource table
+ * @rproc: the rproc handle
+ * @fw: the firmware image
+ * @tablesz: place holder for providing back the table size
+ *
+ * This function finds the resource table inside the remote processor's
+ * firmware. It is used both upon the registration of @rproc (in order
+ * to look for and register the supported virito devices), and when the
+ * @rproc is booted.
+ *
+ * Returns the pointer to the resource table if it is found, and write its
+ * size into @tablesz. If a valid table isn't found, NULL is returned
+ * (and @tablesz isn't set).
+ */
+static struct resource_table *
+rproc_find_rsc_table(struct rproc *rproc, const struct firmware *fw,
+ int *tablesz)
+{
+ struct resource_table *table;
+ struct device *dev = rproc->dev;
+ struct toc_entry *entry = __find_rsc_entry(fw);
+
+ if (!entry) {
+ dev_err(dev, "resource table not found in fw\n");
+ return NULL;
+ }
+
+ table = (void *) (fw->data + entry->start);
+
+ /* make sure we have the entire table */
+ if (entry->start + entry->size > fw->size) {
+ dev_err(dev, "resource table truncated\n");
+ return NULL;
+ }
+
+ /* make sure table has at least the header */
+ if (sizeof(struct resource_table) > entry->size) {
+ dev_err(dev, "header-less resource table\n");
+ return NULL;
+ }
+
+ /* we don't support any version beyond the first */
+ if (table->ver != 1) {
+ dev_err(dev, "unsupported fw ver: %d\n", table->ver);
+ return NULL;
+ }
+
+ /* make sure reserved bytes are zeroes */
+ if (table->reserved[0] || table->reserved[1]) {
+ dev_err(dev, "non zero reserved bytes\n");
+ return NULL;
+ }
+
+ /* make sure the offsets array isn't truncated */
+ if (table->num * sizeof(table->offset[0]) +
+ sizeof(struct resource_table) > entry->size) {
+ dev_err(dev, "resource table incomplete\n");
+ return NULL;
+ }
+
+ *tablesz = entry->size;
+
+ return table;
+}
+
+struct rproc_fw_ops rproc_ste_modem_fw_ops = {
+ .load_fw = rproc_load_segments,
+ .find_rsc_table = rproc_find_rsc_table,
+ .owner = THIS_MODULE
+};
+EXPORT_SYMBOL(rproc_ste_modem_fw_ops);
+MODULE_LICENSE("GPL v2");
+MODULE_DESCRIPTION("Remoteproc Firmware handling for STE modem");
--
1.7.5.4
Hi Sjur,
On Thu, May 31, 2012 at 5:12 PM, <[email protected]> wrote:
> OK, here is an early version of the STE-Modem firmware loader.
> Haven't done the Makefile and Kconfig updates yet though.
Thanks for posting this! I'll find the time to review this asap.
> But I have one issue, I need the firmware image to be allocated
> at the start of shared memory. But the vring gets allocated first.
> I could work around this by calling dma_mark_declared_memory_occupied(),
> from the driver and then call dma_release_from_coherent() before booting.
> But this feels like a hack. Any ideas on how to handle this properly?
One proper way to handle this is to allow platforms to provide
separate memory regions for separate purposes by binding each memory
region to a different per-purpose subdevices.
This way remoteproc could then use the right device whenever it
invokes the DMA API, and memory will then always be allocated from the
expected region, without being affected by different allocation
orders.
Ludovic was working on a patch that does exactly that, and the zynq
folks also need it, so the timing of your request looks perfect :)
Thanks,
Ohad.