1 /*
2  * Copyright 2012 Red Hat Inc.
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 COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * Authors: Ben Skeggs
23  */
24 #include "priv.h"
25 
26 #include <subdev/bios.h>
27 #include <subdev/bios/bmp.h>
28 #include <subdev/bios/bit.h>
29 #include <subdev/bios/image.h>
30 
31 static bool
32 nvbios_addr(struct nvkm_bios *bios, u32 *addr, u8 size)
33 {
34 	u32 p = *addr;
35 
36 	if (*addr > bios->image0_size && bios->imaged_addr) {
37 		*addr -= bios->image0_size;
38 		*addr += bios->imaged_addr;
39 	}
40 
41 	if (unlikely(*addr + size > bios->size)) {
42 		nvkm_error(&bios->subdev, "OOB %d %08x %08x\n", size, p, *addr);
43 		return false;
44 	}
45 
46 	return true;
47 }
48 
49 u8
50 nvbios_rd08(struct nvkm_bios *bios, u32 addr)
51 {
52 	if (likely(nvbios_addr(bios, &addr, 1)))
53 		return bios->data[addr];
54 	return 0x00;
55 }
56 
57 u16
58 nvbios_rd16(struct nvkm_bios *bios, u32 addr)
59 {
60 	if (likely(nvbios_addr(bios, &addr, 2)))
61 		return get_unaligned_le16(&bios->data[addr]);
62 	return 0x0000;
63 }
64 
65 u32
66 nvbios_rd32(struct nvkm_bios *bios, u32 addr)
67 {
68 	if (likely(nvbios_addr(bios, &addr, 4)))
69 		return get_unaligned_le32(&bios->data[addr]);
70 	return 0x00000000;
71 }
72 
73 u8
74 nvbios_checksum(const u8 *data, int size)
75 {
76 	u8 sum = 0;
77 	while (size--)
78 		sum += *data++;
79 	return sum;
80 }
81 
82 u16
83 nvbios_findstr(const u8 *data, int size, const char *str, int len)
84 {
85 	int i, j;
86 
87 	for (i = 0; i <= (size - len); i++) {
88 		for (j = 0; j < len; j++)
89 			if ((char)data[i + j] != str[j])
90 				break;
91 		if (j == len)
92 			return i;
93 	}
94 
95 	return 0;
96 }
97 
98 int
99 nvbios_memcmp(struct nvkm_bios *bios, u32 addr, const char *str, u32 len)
100 {
101 	unsigned char c1, c2;
102 
103 	while (len--) {
104 		c1 = nvbios_rd08(bios, addr++);
105 		c2 = *(str++);
106 		if (c1 != c2)
107 			return c1 - c2;
108 	}
109 	return 0;
110 }
111 
112 int
113 nvbios_extend(struct nvkm_bios *bios, u32 length)
114 {
115 	if (bios->size < length) {
116 		u8 *prev = bios->data;
117 		if (!(bios->data = kmalloc(length, GFP_KERNEL))) {
118 			bios->data = prev;
119 			return -ENOMEM;
120 		}
121 		memcpy(bios->data, prev, bios->size);
122 		bios->size = length;
123 		kfree(prev);
124 		return 1;
125 	}
126 	return 0;
127 }
128 
129 static void *
130 nvkm_bios_dtor(struct nvkm_subdev *subdev)
131 {
132 	struct nvkm_bios *bios = nvkm_bios(subdev);
133 	kfree(bios->data);
134 	return bios;
135 }
136 
137 static const struct nvkm_subdev_func
138 nvkm_bios = {
139 	.dtor = nvkm_bios_dtor,
140 };
141 
142 int
143 nvkm_bios_new(struct nvkm_device *device, enum nvkm_subdev_type type, int inst,
144 	      struct nvkm_bios **pbios)
145 {
146 	struct nvkm_bios *bios;
147 	struct nvbios_image image;
148 	struct bit_entry bit_i;
149 	int ret, idx = 0;
150 
151 	if (!(bios = *pbios = kzalloc(sizeof(*bios), GFP_KERNEL)))
152 		return -ENOMEM;
153 	nvkm_subdev_ctor(&nvkm_bios, device, type, inst, &bios->subdev);
154 
155 	ret = nvbios_shadow(bios);
156 	if (ret)
157 		return ret;
158 
159 	/* Some tables have weird pointers that need adjustment before
160 	 * they're dereferenced.  I'm not entirely sure why...
161 	 */
162 	if (nvbios_image(bios, idx++, &image)) {
163 		bios->image0_size = image.size;
164 		while (nvbios_image(bios, idx++, &image)) {
165 			if (image.type == 0xe0) {
166 				bios->imaged_addr = image.base;
167 				break;
168 			}
169 		}
170 	}
171 
172 	/* detect type of vbios we're dealing with */
173 	bios->bmp_offset = nvbios_findstr(bios->data, bios->size,
174 					  "\xff\x7f""NV\0", 5);
175 	if (bios->bmp_offset) {
176 		nvkm_debug(&bios->subdev, "BMP version %x.%x\n",
177 			   bmp_version(bios) >> 8,
178 			   bmp_version(bios) & 0xff);
179 	}
180 
181 	bios->bit_offset = nvbios_findstr(bios->data, bios->size,
182 					  "\xff\xb8""BIT", 5);
183 	if (bios->bit_offset)
184 		nvkm_debug(&bios->subdev, "BIT signature found\n");
185 
186 	/* determine the vbios version number */
187 	if (!bit_entry(bios, 'i', &bit_i) && bit_i.length >= 4) {
188 		bios->version.major = nvbios_rd08(bios, bit_i.offset + 3);
189 		bios->version.chip  = nvbios_rd08(bios, bit_i.offset + 2);
190 		bios->version.minor = nvbios_rd08(bios, bit_i.offset + 1);
191 		bios->version.micro = nvbios_rd08(bios, bit_i.offset + 0);
192 		bios->version.patch = nvbios_rd08(bios, bit_i.offset + 4);
193 	} else
194 	if (bmp_version(bios)) {
195 		bios->version.major = nvbios_rd08(bios, bios->bmp_offset + 13);
196 		bios->version.chip  = nvbios_rd08(bios, bios->bmp_offset + 12);
197 		bios->version.minor = nvbios_rd08(bios, bios->bmp_offset + 11);
198 		bios->version.micro = nvbios_rd08(bios, bios->bmp_offset + 10);
199 	}
200 
201 	nvkm_info(&bios->subdev, "version %02x.%02x.%02x.%02x.%02x\n",
202 		  bios->version.major, bios->version.chip,
203 		  bios->version.minor, bios->version.micro, bios->version.patch);
204 	return 0;
205 }
206