1 /*
2  * Copyright 2008 Advanced Micro Devices, Inc.
3  * Copyright 2008 Red Hat Inc.
4  * Copyright 2009 Jerome Glisse.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
19  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22  * OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * Authors: Dave Airlie
25  *          Alex Deucher
26  *          Jerome Glisse
27  */
28 #include <drm/drmP.h>
29 #include "amdgpu.h"
30 #include "atom.h"
31 
32 #include <linux/slab.h>
33 #include <linux/acpi.h>
34 /*
35  * BIOS.
36  */
37 
38 #define AMD_VBIOS_SIGNATURE " 761295520"
39 #define AMD_VBIOS_SIGNATURE_OFFSET 0x30
40 #define AMD_VBIOS_SIGNATURE_SIZE sizeof(AMD_VBIOS_SIGNATURE)
41 #define AMD_VBIOS_SIGNATURE_END (AMD_VBIOS_SIGNATURE_OFFSET + AMD_VBIOS_SIGNATURE_SIZE)
42 #define AMD_IS_VALID_VBIOS(p) ((p)[0] == 0x55 && (p)[1] == 0xAA)
43 #define AMD_VBIOS_LENGTH(p) ((p)[2] << 9)
44 
45 /* Check if current bios is an ATOM BIOS.
46  * Return true if it is ATOM BIOS. Otherwise, return false.
47  */
48 static bool check_atom_bios(uint8_t *bios, size_t size)
49 {
50 	uint16_t tmp, bios_header_start;
51 
52 	if (!bios || size < 0x49) {
53 		DRM_INFO("vbios mem is null or mem size is wrong\n");
54 		return false;
55 	}
56 
57 	if (!AMD_IS_VALID_VBIOS(bios)) {
58 		DRM_INFO("BIOS signature incorrect %x %x\n", bios[0], bios[1]);
59 		return false;
60 	}
61 
62 	bios_header_start = bios[0x48] | (bios[0x49] << 8);
63 	if (!bios_header_start) {
64 		DRM_INFO("Can't locate bios header\n");
65 		return false;
66 	}
67 
68 	tmp = bios_header_start + 4;
69 	if (size < tmp) {
70 		DRM_INFO("BIOS header is broken\n");
71 		return false;
72 	}
73 
74 	if (!memcmp(bios + tmp, "ATOM", 4) ||
75 	    !memcmp(bios + tmp, "MOTA", 4)) {
76 		DRM_DEBUG("ATOMBIOS detected\n");
77 		return true;
78 	}
79 
80 	return false;
81 }
82 
83 /* If you boot an IGP board with a discrete card as the primary,
84  * the IGP rom is not accessible via the rom bar as the IGP rom is
85  * part of the system bios.  On boot, the system bios puts a
86  * copy of the igp rom at the start of vram if a discrete card is
87  * present.
88  */
89 static bool igp_read_bios_from_vram(struct amdgpu_device *adev)
90 {
91 	uint8_t __iomem *bios;
92 	resource_size_t vram_base;
93 	resource_size_t size = 256 * 1024; /* ??? */
94 
95 	if (!(adev->flags & AMD_IS_APU))
96 		if (amdgpu_device_need_post(adev))
97 			return false;
98 
99 	adev->bios = NULL;
100 	vram_base = pci_resource_start(adev->pdev, 0);
101 	bios = ioremap_wc(vram_base, size);
102 	if (!bios) {
103 		return false;
104 	}
105 
106 	adev->bios = kmalloc(size, GFP_KERNEL);
107 	if (!adev->bios) {
108 		iounmap(bios);
109 		return false;
110 	}
111 	adev->bios_size = size;
112 	memcpy_fromio(adev->bios, bios, size);
113 	iounmap(bios);
114 
115 	if (!check_atom_bios(adev->bios, size)) {
116 		kfree(adev->bios);
117 		return false;
118 	}
119 
120 	return true;
121 }
122 
123 bool amdgpu_read_bios(struct amdgpu_device *adev)
124 {
125 	uint8_t __iomem *bios;
126 	size_t size;
127 
128 	adev->bios = NULL;
129 	/* XXX: some cards may return 0 for rom size? ddx has a workaround */
130 	bios = pci_map_rom(adev->pdev, &size);
131 	if (!bios) {
132 		return false;
133 	}
134 
135 	adev->bios = kzalloc(size, GFP_KERNEL);
136 	if (adev->bios == NULL) {
137 		pci_unmap_rom(adev->pdev, bios);
138 		return false;
139 	}
140 	adev->bios_size = size;
141 	memcpy_fromio(adev->bios, bios, size);
142 	pci_unmap_rom(adev->pdev, bios);
143 
144 	if (!check_atom_bios(adev->bios, size)) {
145 		kfree(adev->bios);
146 		return false;
147 	}
148 
149 	return true;
150 }
151 
152 static bool amdgpu_read_bios_from_rom(struct amdgpu_device *adev)
153 {
154 	u8 header[AMD_VBIOS_SIGNATURE_END+1] = {0};
155 	int len;
156 
157 	if (!adev->asic_funcs->read_bios_from_rom)
158 		return false;
159 
160 	/* validate VBIOS signature */
161 	if (amdgpu_asic_read_bios_from_rom(adev, &header[0], sizeof(header)) == false)
162 		return false;
163 	header[AMD_VBIOS_SIGNATURE_END] = 0;
164 
165 	if ((!AMD_IS_VALID_VBIOS(header)) ||
166 	    0 != memcmp((char *)&header[AMD_VBIOS_SIGNATURE_OFFSET],
167 			AMD_VBIOS_SIGNATURE,
168 			strlen(AMD_VBIOS_SIGNATURE)))
169 		return false;
170 
171 	/* valid vbios, go on */
172 	len = AMD_VBIOS_LENGTH(header);
173 	len = ALIGN(len, 4);
174 	adev->bios = kmalloc(len, GFP_KERNEL);
175 	if (!adev->bios) {
176 		DRM_ERROR("no memory to allocate for BIOS\n");
177 		return false;
178 	}
179 	adev->bios_size = len;
180 
181 	/* read complete BIOS */
182 	amdgpu_asic_read_bios_from_rom(adev, adev->bios, len);
183 
184 	if (!check_atom_bios(adev->bios, len)) {
185 		kfree(adev->bios);
186 		return false;
187 	}
188 
189 	return true;
190 }
191 
192 static bool amdgpu_read_platform_bios(struct amdgpu_device *adev)
193 {
194 	uint8_t __iomem *bios;
195 	size_t size;
196 
197 	adev->bios = NULL;
198 
199 	bios = pci_platform_rom(adev->pdev, &size);
200 	if (!bios) {
201 		return false;
202 	}
203 
204 	adev->bios = kzalloc(size, GFP_KERNEL);
205 	if (adev->bios == NULL)
206 		return false;
207 
208 	memcpy_fromio(adev->bios, bios, size);
209 
210 	if (!check_atom_bios(adev->bios, size)) {
211 		kfree(adev->bios);
212 		return false;
213 	}
214 
215 	adev->bios_size = size;
216 
217 	return true;
218 }
219 
220 #ifdef CONFIG_ACPI
221 /* ATRM is used to get the BIOS on the discrete cards in
222  * dual-gpu systems.
223  */
224 /* retrieve the ROM in 4k blocks */
225 #define ATRM_BIOS_PAGE 4096
226 /**
227  * amdgpu_atrm_call - fetch a chunk of the vbios
228  *
229  * @atrm_handle: acpi ATRM handle
230  * @bios: vbios image pointer
231  * @offset: offset of vbios image data to fetch
232  * @len: length of vbios image data to fetch
233  *
234  * Executes ATRM to fetch a chunk of the discrete
235  * vbios image on PX systems (all asics).
236  * Returns the length of the buffer fetched.
237  */
238 static int amdgpu_atrm_call(acpi_handle atrm_handle, uint8_t *bios,
239 			    int offset, int len)
240 {
241 	acpi_status status;
242 	union acpi_object atrm_arg_elements[2], *obj;
243 	struct acpi_object_list atrm_arg;
244 	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL};
245 
246 	atrm_arg.count = 2;
247 	atrm_arg.pointer = &atrm_arg_elements[0];
248 
249 	atrm_arg_elements[0].type = ACPI_TYPE_INTEGER;
250 	atrm_arg_elements[0].integer.value = offset;
251 
252 	atrm_arg_elements[1].type = ACPI_TYPE_INTEGER;
253 	atrm_arg_elements[1].integer.value = len;
254 
255 	status = acpi_evaluate_object(atrm_handle, NULL, &atrm_arg, &buffer);
256 	if (ACPI_FAILURE(status)) {
257 		printk("failed to evaluate ATRM got %s\n", acpi_format_exception(status));
258 		return -ENODEV;
259 	}
260 
261 	obj = (union acpi_object *)buffer.pointer;
262 	memcpy(bios+offset, obj->buffer.pointer, obj->buffer.length);
263 	len = obj->buffer.length;
264 	kfree(buffer.pointer);
265 	return len;
266 }
267 
268 static bool amdgpu_atrm_get_bios(struct amdgpu_device *adev)
269 {
270 	int ret;
271 	int size = 256 * 1024;
272 	int i;
273 	struct pci_dev *pdev = NULL;
274 	acpi_handle dhandle, atrm_handle;
275 	acpi_status status;
276 	bool found = false;
277 
278 	/* ATRM is for the discrete card only */
279 	if (adev->flags & AMD_IS_APU)
280 		return false;
281 
282 	while ((pdev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, pdev)) != NULL) {
283 		dhandle = ACPI_HANDLE(&pdev->dev);
284 		if (!dhandle)
285 			continue;
286 
287 		status = acpi_get_handle(dhandle, "ATRM", &atrm_handle);
288 		if (!ACPI_FAILURE(status)) {
289 			found = true;
290 			break;
291 		}
292 	}
293 
294 	if (!found) {
295 		while ((pdev = pci_get_class(PCI_CLASS_DISPLAY_OTHER << 8, pdev)) != NULL) {
296 			dhandle = ACPI_HANDLE(&pdev->dev);
297 			if (!dhandle)
298 				continue;
299 
300 			status = acpi_get_handle(dhandle, "ATRM", &atrm_handle);
301 			if (!ACPI_FAILURE(status)) {
302 				found = true;
303 				break;
304 			}
305 		}
306 	}
307 
308 	if (!found)
309 		return false;
310 
311 	adev->bios = kmalloc(size, GFP_KERNEL);
312 	if (!adev->bios) {
313 		DRM_ERROR("Unable to allocate bios\n");
314 		return false;
315 	}
316 
317 	for (i = 0; i < size / ATRM_BIOS_PAGE; i++) {
318 		ret = amdgpu_atrm_call(atrm_handle,
319 				       adev->bios,
320 				       (i * ATRM_BIOS_PAGE),
321 				       ATRM_BIOS_PAGE);
322 		if (ret < ATRM_BIOS_PAGE)
323 			break;
324 	}
325 
326 	if (!check_atom_bios(adev->bios, size)) {
327 		kfree(adev->bios);
328 		return false;
329 	}
330 	adev->bios_size = size;
331 	return true;
332 }
333 #else
334 static inline bool amdgpu_atrm_get_bios(struct amdgpu_device *adev)
335 {
336 	return false;
337 }
338 #endif
339 
340 static bool amdgpu_read_disabled_bios(struct amdgpu_device *adev)
341 {
342 	if (adev->flags & AMD_IS_APU)
343 		return igp_read_bios_from_vram(adev);
344 	else
345 		return amdgpu_asic_read_disabled_bios(adev);
346 }
347 
348 #ifdef CONFIG_ACPI
349 static bool amdgpu_acpi_vfct_bios(struct amdgpu_device *adev)
350 {
351 	struct acpi_table_header *hdr;
352 	acpi_size tbl_size;
353 	UEFI_ACPI_VFCT *vfct;
354 	unsigned offset;
355 
356 	if (!ACPI_SUCCESS(acpi_get_table("VFCT", 1, &hdr)))
357 		return false;
358 	tbl_size = hdr->length;
359 	if (tbl_size < sizeof(UEFI_ACPI_VFCT)) {
360 		DRM_ERROR("ACPI VFCT table present but broken (too short #1)\n");
361 		return false;
362 	}
363 
364 	vfct = (UEFI_ACPI_VFCT *)hdr;
365 	offset = vfct->VBIOSImageOffset;
366 
367 	while (offset < tbl_size) {
368 		GOP_VBIOS_CONTENT *vbios = (GOP_VBIOS_CONTENT *)((char *)hdr + offset);
369 		VFCT_IMAGE_HEADER *vhdr = &vbios->VbiosHeader;
370 
371 		offset += sizeof(VFCT_IMAGE_HEADER);
372 		if (offset > tbl_size) {
373 			DRM_ERROR("ACPI VFCT image header truncated\n");
374 			return false;
375 		}
376 
377 		offset += vhdr->ImageLength;
378 		if (offset > tbl_size) {
379 			DRM_ERROR("ACPI VFCT image truncated\n");
380 			return false;
381 		}
382 
383 		if (vhdr->ImageLength &&
384 		    vhdr->PCIBus == adev->pdev->bus->number &&
385 		    vhdr->PCIDevice == PCI_SLOT(adev->pdev->devfn) &&
386 		    vhdr->PCIFunction == PCI_FUNC(adev->pdev->devfn) &&
387 		    vhdr->VendorID == adev->pdev->vendor &&
388 		    vhdr->DeviceID == adev->pdev->device) {
389 			adev->bios = kmemdup(&vbios->VbiosContent,
390 					     vhdr->ImageLength,
391 					     GFP_KERNEL);
392 
393 			if (!check_atom_bios(adev->bios, vhdr->ImageLength)) {
394 				kfree(adev->bios);
395 				return false;
396 			}
397 			adev->bios_size = vhdr->ImageLength;
398 			return true;
399 		}
400 	}
401 
402 	DRM_ERROR("ACPI VFCT table present but broken (too short #2)\n");
403 	return false;
404 }
405 #else
406 static inline bool amdgpu_acpi_vfct_bios(struct amdgpu_device *adev)
407 {
408 	return false;
409 }
410 #endif
411 
412 bool amdgpu_get_bios(struct amdgpu_device *adev)
413 {
414 	if (amdgpu_atrm_get_bios(adev))
415 		goto success;
416 
417 	if (amdgpu_acpi_vfct_bios(adev))
418 		goto success;
419 
420 	if (igp_read_bios_from_vram(adev))
421 		goto success;
422 
423 	if (amdgpu_read_bios(adev))
424 		goto success;
425 
426 	if (amdgpu_read_bios_from_rom(adev))
427 		goto success;
428 
429 	if (amdgpu_read_disabled_bios(adev))
430 		goto success;
431 
432 	if (amdgpu_read_platform_bios(adev))
433 		goto success;
434 
435 	DRM_ERROR("Unable to locate a BIOS ROM\n");
436 	return false;
437 
438 success:
439 	adev->is_atom_fw = (adev->asic_type >= CHIP_VEGA10) ? true : false;
440 	return true;
441 }
442