1 /*
2  * Copyright (c) 2016, NVIDIA CORPORATION. All rights reserved.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20  * DEALINGS IN THE SOFTWARE.
21  */
22 #include <core/device.h>
23 #include <core/firmware.h>
24 
25 int
nvkm_firmware_load_name(const struct nvkm_subdev * subdev,const char * base,const char * name,int ver,const struct firmware ** pfw)26 nvkm_firmware_load_name(const struct nvkm_subdev *subdev, const char *base,
27 			const char *name, int ver, const struct firmware **pfw)
28 {
29 	char path[64];
30 	int ret;
31 
32 	snprintf(path, sizeof(path), "%s%s", base, name);
33 	ret = nvkm_firmware_get(subdev, path, ver, pfw);
34 	if (ret < 0)
35 		return ret;
36 
37 	return 0;
38 }
39 
40 int
nvkm_firmware_load_blob(const struct nvkm_subdev * subdev,const char * base,const char * name,int ver,struct nvkm_blob * blob)41 nvkm_firmware_load_blob(const struct nvkm_subdev *subdev, const char *base,
42 			const char *name, int ver, struct nvkm_blob *blob)
43 {
44 	const struct firmware *fw;
45 	int ret;
46 
47 	ret = nvkm_firmware_load_name(subdev, base, name, ver, &fw);
48 	if (ret == 0) {
49 		blob->data = kmemdup(fw->data, fw->size, GFP_KERNEL);
50 		blob->size = fw->size;
51 		nvkm_firmware_put(fw);
52 		if (!blob->data)
53 			return -ENOMEM;
54 	}
55 
56 	return ret;
57 }
58 
59 /**
60  * nvkm_firmware_get - load firmware from the official nvidia/chip/ directory
61  * @subdev:	subdevice that will use that firmware
62  * @fwname:	name of firmware file to load
63  * @ver:	firmware version to load
64  * @fw:		firmware structure to load to
65  *
66  * Use this function to load firmware files in the form nvidia/chip/fwname.bin.
67  * Firmware files released by NVIDIA will always follow this format.
68  */
69 int
nvkm_firmware_get(const struct nvkm_subdev * subdev,const char * fwname,int ver,const struct firmware ** fw)70 nvkm_firmware_get(const struct nvkm_subdev *subdev, const char *fwname, int ver,
71 		  const struct firmware **fw)
72 {
73 	struct nvkm_device *device = subdev->device;
74 	char f[64];
75 	char cname[16];
76 	int i;
77 
78 	/* Convert device name to lowercase */
79 	strncpy(cname, device->chip->name, sizeof(cname));
80 	cname[sizeof(cname) - 1] = '\0';
81 	i = strlen(cname);
82 	while (i) {
83 		--i;
84 		cname[i] = tolower(cname[i]);
85 	}
86 
87 	if (ver != 0)
88 		snprintf(f, sizeof(f), "nvidia/%s/%s-%d.bin", cname, fwname, ver);
89 	else
90 		snprintf(f, sizeof(f), "nvidia/%s/%s.bin", cname, fwname);
91 
92 	if (!firmware_request_nowarn(fw, f, device->dev)) {
93 		nvkm_debug(subdev, "firmware \"%s\" loaded - %zu byte(s)\n",
94 			   f, (*fw)->size);
95 		return 0;
96 	}
97 
98 	nvkm_debug(subdev, "firmware \"%s\" unavailable\n", f);
99 	return -ENOENT;
100 }
101 
102 /*
103  * nvkm_firmware_put - release firmware loaded with nvkm_firmware_get
104  */
105 void
nvkm_firmware_put(const struct firmware * fw)106 nvkm_firmware_put(const struct firmware *fw)
107 {
108 	release_firmware(fw);
109 }
110