gpu: nvgpu: Add abstraction for firmware loading

Add nvgpu_firmware data structure, and return it instead of Linux
struct firmare from nvgpu_request_firmware. Also add abstraction
for releasing firmware: nvgpu_release_firmware.

JIRA NVGPU-16

Change-Id: I6dae8262957c0d4506f710289e3a43a6c1729fc7
Signed-off-by: Terje Bergstrom <tbergstrom@nvidia.com>
Reviewed-on: http://git-master/r/1463538
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>

2 files changed, 114 insertions, 66 deletions

diff --git a/drivers/gpu/nvgpu/common/linux/driver_common.c b/drivers/gpu/nvgpu/common/linux/driver_common.c
index 5c96b4e8..af26996b 100644
--- a/drivers/gpu/nvgpu/common/linux/driver_common.c
+++ b/drivers/gpu/nvgpu/common/linux/driver_common.c
@@ -15,7 +15,6 @@
  */
 
 #include <linux/dma-mapping.h>
-#include <linux/firmware.h>
 
 #include <nvgpu/kmem.h>
 #include <nvgpu/nvgpu_common.h>
@@ -201,71 +200,6 @@ int nvgpu_probe(struct gk20a *g,
         return 0;
 }
 
-static const struct firmware *do_request_firmware(struct device *dev,
-                const char *prefix, const char *fw_name, int flags)
-{
-        const struct firmware *fw;
-        char *fw_path = NULL;
-        int path_len, err;
-
-        if (prefix) {
-                path_len = strlen(prefix) + strlen(fw_name);
-                path_len += 2; /* for the path separator and zero terminator*/
-
-                fw_path = nvgpu_kzalloc(get_gk20a(dev),
-                                        sizeof(*fw_path) * path_len);
-                if (!fw_path)
-                        return NULL;
-
-                sprintf(fw_path, "%s/%s", prefix, fw_name);
-                fw_name = fw_path;
-        }
-
-#if LINUX_VERSION_CODE < KERNEL_VERSION(3,18,0)
-        err = request_firmware(&fw, fw_name, dev);
-#else
-        if (flags & NVGPU_REQUEST_FIRMWARE_NO_WARN)
-                err = request_firmware_direct(&fw, fw_name, dev);
-        else
-                err = request_firmware(&fw, fw_name, dev);
-#endif
-
-        nvgpu_kfree(get_gk20a(dev), fw_path);
-        if (err)
-                return NULL;
-        return fw;
-}
-
-/* This is a simple wrapper around request_firmware that takes 'fw_name' and
- * applies an IP specific relative path prefix to it. The caller is
- * responsible for calling release_firmware later. */
-const struct firmware *nvgpu_request_firmware(struct gk20a *g,
-                                              const char *fw_name,
-                                              int flags)
-{
-        struct device *dev = g->dev;
-        const struct firmware *fw;
-
-        /* current->fs is NULL when calling from SYS_EXIT.
-           Add a check here to prevent crash in request_firmware */
-        if (!current->fs || !fw_name)
-                return NULL;
-
-        BUG_ON(!g->name);
-        fw = do_request_firmware(dev, g->name, fw_name, flags);
-
-#ifdef CONFIG_TEGRA_GK20A
-        /* TO BE REMOVED - Support loading from legacy SOC specific path. */
-        if (!fw && !(flags & NVGPU_REQUEST_FIRMWARE_NO_SOC)) {
-                struct gk20a_platform *platform = gk20a_get_platform(dev);
-                fw = do_request_firmware(dev,
-                                platform->soc_name, fw_name, flags);
-        }
-#endif
-
-        return fw;
-}
-
 /**
  * cyclic_delta - Returns delta of cyclic integers a and b.
  *
diff --git a/drivers/gpu/nvgpu/common/linux/firmware.c b/drivers/gpu/nvgpu/common/linux/firmware.c
new file mode 100644
index 00000000..32b1e61f
--- /dev/null
+++ b/drivers/gpu/nvgpu/common/linux/firmware.c
@@ -0,0 +1,114 @@
+/*
+ * Copyright (c) 2017, NVIDIA CORPORATION.  All rights reserved.
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <linux/firmware.h>
+
+#include <nvgpu/kmem.h>
+#include <nvgpu/bug.h>
+#include <nvgpu/firmware.h>
+
+#include "gk20a/gk20a.h"
+
+static const struct firmware *do_request_firmware(struct device *dev,
+                const char *prefix, const char *fw_name, int flags)
+{
+        const struct firmware *fw;
+        char *fw_path = NULL;
+        int path_len, err;
+
+        if (prefix) {
+                path_len = strlen(prefix) + strlen(fw_name);
+                path_len += 2; /* for the path separator and zero terminator*/
+
+                fw_path = nvgpu_kzalloc(get_gk20a(dev),
+                                        sizeof(*fw_path) * path_len);
+                if (!fw_path)
+                        return NULL;
+
+                sprintf(fw_path, "%s/%s", prefix, fw_name);
+                fw_name = fw_path;
+        }
+
+#if LINUX_VERSION_CODE < KERNEL_VERSION(3,18,0)
+        err = request_firmware(&fw, fw_name, dev);
+#else
+        if (flags & NVGPU_REQUEST_FIRMWARE_NO_WARN)
+                err = request_firmware_direct(&fw, fw_name, dev);
+        else
+                err = request_firmware(&fw, fw_name, dev);
+#endif
+
+        nvgpu_kfree(get_gk20a(dev), fw_path);
+        if (err)
+                return NULL;
+        return fw;
+}
+
+/* This is a simple wrapper around request_firmware that takes 'fw_name' and
+ * applies an IP specific relative path prefix to it. The caller is
+ * responsible for calling nvgpu_release_firmware later. */
+struct nvgpu_firmware *nvgpu_request_firmware(struct gk20a *g,
+                                              const char *fw_name,
+                                              int flags)
+{
+        struct device *dev = g->dev;
+        struct nvgpu_firmware *fw;
+        const struct firmware *linux_fw;
+
+        /* current->fs is NULL when calling from SYS_EXIT.
+           Add a check here to prevent crash in request_firmware */
+        if (!current->fs || !fw_name)
+                return NULL;
+
+        fw = nvgpu_kzalloc(g, sizeof(*fw));
+        if (!fw)
+                return NULL;
+
+        linux_fw = do_request_firmware(dev, g->name, fw_name, flags);
+
+#ifdef CONFIG_TEGRA_GK20A
+        /* TO BE REMOVED - Support loading from legacy SOC specific path. */
+        if (!linux_fw && !(flags & NVGPU_REQUEST_FIRMWARE_NO_SOC)) {
+                struct gk20a_platform *platform = gk20a_get_platform(dev);
+                linux_fw = do_request_firmware(dev,
+                                platform->soc_name, fw_name, flags);
+        }
+#endif
+
+        if (!linux_fw)
+                goto err;
+
+        fw->data = nvgpu_kmalloc(g, linux_fw->size);
+        if (!fw->data)
+                goto err;
+
+        memcpy(fw->data, linux_fw->data, linux_fw->size);
+        fw->size = linux_fw->size;
+
+        release_firmware(linux_fw);
+
+        return fw;
+
+err:
+        nvgpu_kfree(g, fw);
+        return NULL;
+}
+
+void nvgpu_release_firmware(struct gk20a *g, struct nvgpu_firmware *fw)
+{
+        nvgpu_kfree(g, fw->data);
+        nvgpu_kfree(g, fw);
+}