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 
29 #include "amdgpu.h"
30 #include "atom.h"
31 
32 #include <linux/pci.h>
33 #include <linux/slab.h>
34 #include <linux/acpi.h>
35 /*
36  * BIOS.
37  */
38 
39 #define AMD_VBIOS_SIGNATURE " 761295520"
40 #define AMD_VBIOS_SIGNATURE_OFFSET 0x30
41 #define AMD_VBIOS_SIGNATURE_SIZE sizeof(AMD_VBIOS_SIGNATURE)
42 #define AMD_VBIOS_SIGNATURE_END (AMD_VBIOS_SIGNATURE_OFFSET + AMD_VBIOS_SIGNATURE_SIZE)
43 #define AMD_IS_VALID_VBIOS(p) ((p)[0] == 0x55 && (p)[1] == 0xAA)
44 #define AMD_VBIOS_LENGTH(p) ((p)[2] << 9)
45 
46 /* Check if current bios is an ATOM BIOS.
47  * Return true if it is ATOM BIOS. Otherwise, return false.
48  */
49 static bool check_atom_bios(uint8_t *bios, size_t size)
50 {
51 	uint16_t tmp, bios_header_start;
52 
53 	if (!bios || size < 0x49) {
54 		DRM_INFO("vbios mem is null or mem size is wrong\n");
55 		return false;
56 	}
57 
58 	if (!AMD_IS_VALID_VBIOS(bios)) {
59 		DRM_INFO("BIOS signature incorrect %x %x\n", bios[0], bios[1]);
60 		return false;
61 	}
62 
63 	bios_header_start = bios[0x48] | (bios[0x49] << 8);
64 	if (!bios_header_start) {
65 		DRM_INFO("Can't locate bios header\n");
66 		return false;
67 	}
68 
69 	tmp = bios_header_start + 4;
70 	if (size < tmp) {
71 		DRM_INFO("BIOS header is broken\n");
72 		return false;
73 	}
74 
75 	if (!memcmp(bios + tmp, "ATOM", 4) ||
76 	    !memcmp(bios + tmp, "MOTA", 4)) {
77 		DRM_DEBUG("ATOMBIOS detected\n");
78 		return true;
79 	}
80 
81 	return false;
82 }
83 
84 /* If you boot an IGP board with a discrete card as the primary,
85  * the IGP rom is not accessible via the rom bar as the IGP rom is
86  * part of the system bios.  On boot, the system bios puts a
87  * copy of the igp rom at the start of vram if a discrete card is
88  * present.
89  */
90 static bool igp_read_bios_from_vram(struct amdgpu_device *adev)
91 {
92 	uint8_t __iomem *bios;
93 	resource_size_t vram_base;
94 	resource_size_t size = 256 * 1024; /* ??? */
95 
96 	if (!(adev->flags & AMD_IS_APU))
97 		if (amdgpu_device_need_post(adev))
98 			return false;
99 
100 	/* FB BAR not enabled */
101 	if (pci_resource_len(adev->pdev, 0) == 0)
102 		return false;
103 
104 	adev->bios = NULL;
105 	vram_base = pci_resource_start(adev->pdev, 0);
106 	bios = ioremap_wc(vram_base, size);
107 	if (!bios)
108 		return false;
109 
110 	adev->bios = kmalloc(size, GFP_KERNEL);
111 	if (!adev->bios) {
112 		iounmap(bios);
113 		return false;
114 	}
115 	adev->bios_size = size;
116 	memcpy_fromio(adev->bios, bios, size);
117 	iounmap(bios);
118 
119 	if (!check_atom_bios(adev->bios, size)) {
120 		kfree(adev->bios);
121 		return false;
122 	}
123 
124 	return true;
125 }
126 
127 bool amdgpu_read_bios(struct amdgpu_device *adev)
128 {
129 	uint8_t __iomem *bios;
130 	size_t size;
131 
132 	adev->bios = NULL;
133 	/* XXX: some cards may return 0 for rom size? ddx has a workaround */
134 	bios = pci_map_rom(adev->pdev, &size);
135 	if (!bios)
136 		return false;
137 
138 	adev->bios = kzalloc(size, GFP_KERNEL);
139 	if (adev->bios == NULL) {
140 		pci_unmap_rom(adev->pdev, bios);
141 		return false;
142 	}
143 	adev->bios_size = size;
144 	memcpy_fromio(adev->bios, bios, size);
145 	pci_unmap_rom(adev->pdev, bios);
146 
147 	if (!check_atom_bios(adev->bios, size)) {
148 		kfree(adev->bios);
149 		return false;
150 	}
151 
152 	return true;
153 }
154 
155 static bool amdgpu_read_bios_from_rom(struct amdgpu_device *adev)
156 {
157 	u8 header[AMD_VBIOS_SIGNATURE_END+1] = {0};
158 	int len;
159 
160 	if (!adev->asic_funcs || !adev->asic_funcs->read_bios_from_rom)
161 		return false;
162 
163 	/* validate VBIOS signature */
164 	if (amdgpu_asic_read_bios_from_rom(adev, &header[0], sizeof(header)) == false)
165 		return false;
166 	header[AMD_VBIOS_SIGNATURE_END] = 0;
167 
168 	if ((!AMD_IS_VALID_VBIOS(header)) ||
169 		memcmp((char *)&header[AMD_VBIOS_SIGNATURE_OFFSET],
170 		       AMD_VBIOS_SIGNATURE,
171 		       strlen(AMD_VBIOS_SIGNATURE)) != 0)
172 		return false;
173 
174 	/* valid vbios, go on */
175 	len = AMD_VBIOS_LENGTH(header);
176 	len = ALIGN(len, 4);
177 	adev->bios = kmalloc(len, GFP_KERNEL);
178 	if (!adev->bios) {
179 		DRM_ERROR("no memory to allocate for BIOS\n");
180 		return false;
181 	}
182 	adev->bios_size = len;
183 
184 	/* read complete BIOS */
185 	amdgpu_asic_read_bios_from_rom(adev, adev->bios, len);
186 
187 	if (!check_atom_bios(adev->bios, len)) {
188 		kfree(adev->bios);
189 		return false;
190 	}
191 
192 	return true;
193 }
194 
195 static bool amdgpu_read_platform_bios(struct amdgpu_device *adev)
196 {
197 	phys_addr_t rom = adev->pdev->rom;
198 	size_t romlen = adev->pdev->romlen;
199 	void __iomem *bios;
200 
201 	adev->bios = NULL;
202 
203 	if (!rom || romlen == 0)
204 		return false;
205 
206 	adev->bios = kzalloc(romlen, GFP_KERNEL);
207 	if (!adev->bios)
208 		return false;
209 
210 	bios = ioremap(rom, romlen);
211 	if (!bios)
212 		goto free_bios;
213 
214 	memcpy_fromio(adev->bios, bios, romlen);
215 	iounmap(bios);
216 
217 	if (!check_atom_bios(adev->bios, romlen))
218 		goto free_bios;
219 
220 	adev->bios_size = romlen;
221 
222 	return true;
223 free_bios:
224 	kfree(adev->bios);
225 	return false;
226 }
227 
228 #ifdef CONFIG_ACPI
229 /* ATRM is used to get the BIOS on the discrete cards in
230  * dual-gpu systems.
231  */
232 /* retrieve the ROM in 4k blocks */
233 #define ATRM_BIOS_PAGE 4096
234 /**
235  * amdgpu_atrm_call - fetch a chunk of the vbios
236  *
237  * @atrm_handle: acpi ATRM handle
238  * @bios: vbios image pointer
239  * @offset: offset of vbios image data to fetch
240  * @len: length of vbios image data to fetch
241  *
242  * Executes ATRM to fetch a chunk of the discrete
243  * vbios image on PX systems (all asics).
244  * Returns the length of the buffer fetched.
245  */
246 static int amdgpu_atrm_call(acpi_handle atrm_handle, uint8_t *bios,
247 			    int offset, int len)
248 {
249 	acpi_status status;
250 	union acpi_object atrm_arg_elements[2], *obj;
251 	struct acpi_object_list atrm_arg;
252 	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL};
253 
254 	atrm_arg.count = 2;
255 	atrm_arg.pointer = &atrm_arg_elements[0];
256 
257 	atrm_arg_elements[0].type = ACPI_TYPE_INTEGER;
258 	atrm_arg_elements[0].integer.value = offset;
259 
260 	atrm_arg_elements[1].type = ACPI_TYPE_INTEGER;
261 	atrm_arg_elements[1].integer.value = len;
262 
263 	status = acpi_evaluate_object(atrm_handle, NULL, &atrm_arg, &buffer);
264 	if (ACPI_FAILURE(status)) {
265 		DRM_ERROR("failed to evaluate ATRM got %s\n", acpi_format_exception(status));
266 		return -ENODEV;
267 	}
268 
269 	obj = (union acpi_object *)buffer.pointer;
270 	memcpy(bios+offset, obj->buffer.pointer, obj->buffer.length);
271 	len = obj->buffer.length;
272 	kfree(buffer.pointer);
273 	return len;
274 }
275 
276 static bool amdgpu_atrm_get_bios(struct amdgpu_device *adev)
277 {
278 	int ret;
279 	int size = 256 * 1024;
280 	int i;
281 	struct pci_dev *pdev = NULL;
282 	acpi_handle dhandle, atrm_handle;
283 	acpi_status status;
284 	bool found = false;
285 
286 	/* ATRM is for the discrete card only */
287 	if (adev->flags & AMD_IS_APU)
288 		return false;
289 
290 	while ((pdev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, pdev)) != NULL) {
291 		dhandle = ACPI_HANDLE(&pdev->dev);
292 		if (!dhandle)
293 			continue;
294 
295 		status = acpi_get_handle(dhandle, "ATRM", &atrm_handle);
296 		if (ACPI_SUCCESS(status)) {
297 			found = true;
298 			break;
299 		}
300 	}
301 
302 	if (!found) {
303 		while ((pdev = pci_get_class(PCI_CLASS_DISPLAY_OTHER << 8, pdev)) != NULL) {
304 			dhandle = ACPI_HANDLE(&pdev->dev);
305 			if (!dhandle)
306 				continue;
307 
308 			status = acpi_get_handle(dhandle, "ATRM", &atrm_handle);
309 			if (ACPI_SUCCESS(status)) {
310 				found = true;
311 				break;
312 			}
313 		}
314 	}
315 
316 	if (!found)
317 		return false;
318 	pci_dev_put(pdev);
319 
320 	adev->bios = kmalloc(size, GFP_KERNEL);
321 	if (!adev->bios) {
322 		dev_err(adev->dev, "Unable to allocate bios\n");
323 		return false;
324 	}
325 
326 	for (i = 0; i < size / ATRM_BIOS_PAGE; i++) {
327 		ret = amdgpu_atrm_call(atrm_handle,
328 				       adev->bios,
329 				       (i * ATRM_BIOS_PAGE),
330 				       ATRM_BIOS_PAGE);
331 		if (ret < ATRM_BIOS_PAGE)
332 			break;
333 	}
334 
335 	if (!check_atom_bios(adev->bios, size)) {
336 		kfree(adev->bios);
337 		return false;
338 	}
339 	adev->bios_size = size;
340 	return true;
341 }
342 #else
343 static inline bool amdgpu_atrm_get_bios(struct amdgpu_device *adev)
344 {
345 	return false;
346 }
347 #endif
348 
349 static bool amdgpu_read_disabled_bios(struct amdgpu_device *adev)
350 {
351 	if (adev->flags & AMD_IS_APU)
352 		return igp_read_bios_from_vram(adev);
353 	else
354 		return (!adev->asic_funcs || !adev->asic_funcs->read_disabled_bios) ?
355 			false : amdgpu_asic_read_disabled_bios(adev);
356 }
357 
358 #ifdef CONFIG_ACPI
359 static bool amdgpu_acpi_vfct_bios(struct amdgpu_device *adev)
360 {
361 	struct acpi_table_header *hdr;
362 	acpi_size tbl_size;
363 	UEFI_ACPI_VFCT *vfct;
364 	unsigned int offset;
365 
366 	if (!ACPI_SUCCESS(acpi_get_table("VFCT", 1, &hdr)))
367 		return false;
368 	tbl_size = hdr->length;
369 	if (tbl_size < sizeof(UEFI_ACPI_VFCT)) {
370 		dev_info(adev->dev, "ACPI VFCT table present but broken (too short #1),skipping\n");
371 		return false;
372 	}
373 
374 	vfct = (UEFI_ACPI_VFCT *)hdr;
375 	offset = vfct->VBIOSImageOffset;
376 
377 	while (offset < tbl_size) {
378 		GOP_VBIOS_CONTENT *vbios = (GOP_VBIOS_CONTENT *)((char *)hdr + offset);
379 		VFCT_IMAGE_HEADER *vhdr = &vbios->VbiosHeader;
380 
381 		offset += sizeof(VFCT_IMAGE_HEADER);
382 		if (offset > tbl_size) {
383 			dev_info(adev->dev, "ACPI VFCT image header truncated,skipping\n");
384 			return false;
385 		}
386 
387 		offset += vhdr->ImageLength;
388 		if (offset > tbl_size) {
389 			dev_info(adev->dev, "ACPI VFCT image truncated,skipping\n");
390 			return false;
391 		}
392 
393 		if (vhdr->ImageLength &&
394 		    vhdr->PCIBus == adev->pdev->bus->number &&
395 		    vhdr->PCIDevice == PCI_SLOT(adev->pdev->devfn) &&
396 		    vhdr->PCIFunction == PCI_FUNC(adev->pdev->devfn) &&
397 		    vhdr->VendorID == adev->pdev->vendor &&
398 		    vhdr->DeviceID == adev->pdev->device) {
399 			adev->bios = kmemdup(&vbios->VbiosContent,
400 					     vhdr->ImageLength,
401 					     GFP_KERNEL);
402 
403 			if (!check_atom_bios(adev->bios, vhdr->ImageLength)) {
404 				kfree(adev->bios);
405 				return false;
406 			}
407 			adev->bios_size = vhdr->ImageLength;
408 			return true;
409 		}
410 	}
411 
412 	dev_info(adev->dev, "ACPI VFCT table present but broken (too short #2),skipping\n");
413 	return false;
414 }
415 #else
416 static inline bool amdgpu_acpi_vfct_bios(struct amdgpu_device *adev)
417 {
418 	return false;
419 }
420 #endif
421 
422 bool amdgpu_get_bios(struct amdgpu_device *adev)
423 {
424 	if (amdgpu_atrm_get_bios(adev)) {
425 		dev_info(adev->dev, "Fetched VBIOS from ATRM\n");
426 		goto success;
427 	}
428 
429 	if (amdgpu_acpi_vfct_bios(adev)) {
430 		dev_info(adev->dev, "Fetched VBIOS from VFCT\n");
431 		goto success;
432 	}
433 
434 	if (igp_read_bios_from_vram(adev)) {
435 		dev_info(adev->dev, "Fetched VBIOS from VRAM BAR\n");
436 		goto success;
437 	}
438 
439 	if (amdgpu_read_bios(adev)) {
440 		dev_info(adev->dev, "Fetched VBIOS from ROM BAR\n");
441 		goto success;
442 	}
443 
444 	if (amdgpu_read_bios_from_rom(adev)) {
445 		dev_info(adev->dev, "Fetched VBIOS from ROM\n");
446 		goto success;
447 	}
448 
449 	if (amdgpu_read_disabled_bios(adev)) {
450 		dev_info(adev->dev, "Fetched VBIOS from disabled ROM BAR\n");
451 		goto success;
452 	}
453 
454 	if (amdgpu_read_platform_bios(adev)) {
455 		dev_info(adev->dev, "Fetched VBIOS from platform\n");
456 		goto success;
457 	}
458 
459 	dev_err(adev->dev, "Unable to locate a BIOS ROM\n");
460 	return false;
461 
462 success:
463 	adev->is_atom_fw = (adev->asic_type >= CHIP_VEGA10) ? true : false;
464 	return true;
465 }
466 
467 /* helper function for soc15 and onwards to read bios from rom */
468 bool amdgpu_soc15_read_bios_from_rom(struct amdgpu_device *adev,
469 				     u8 *bios, u32 length_bytes)
470 {
471 	u32 *dw_ptr;
472 	u32 i, length_dw;
473 	u32 rom_offset;
474 	u32 rom_index_offset;
475 	u32 rom_data_offset;
476 
477 	if (bios == NULL)
478 		return false;
479 	if (length_bytes == 0)
480 		return false;
481 	/* APU vbios image is part of sbios image */
482 	if (adev->flags & AMD_IS_APU)
483 		return false;
484 	if (!adev->smuio.funcs ||
485 	    !adev->smuio.funcs->get_rom_index_offset ||
486 	    !adev->smuio.funcs->get_rom_data_offset)
487 		return false;
488 
489 	dw_ptr = (u32 *)bios;
490 	length_dw = ALIGN(length_bytes, 4) / 4;
491 
492 	rom_index_offset =
493 		adev->smuio.funcs->get_rom_index_offset(adev);
494 	rom_data_offset =
495 		adev->smuio.funcs->get_rom_data_offset(adev);
496 
497 	if (adev->nbio.funcs &&
498 	    adev->nbio.funcs->get_rom_offset) {
499 		rom_offset = adev->nbio.funcs->get_rom_offset(adev);
500 		rom_offset = rom_offset << 17;
501 	} else {
502 		rom_offset = 0;
503 	}
504 
505 	/* set rom index to rom_offset */
506 	WREG32(rom_index_offset, rom_offset);
507 	/* read out the rom data */
508 	for (i = 0; i < length_dw; i++)
509 		dw_ptr[i] = RREG32(rom_data_offset);
510 
511 	return true;
512 }
513