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 /* If you boot an IGP board with a discrete card as the primary,
46  * the IGP rom is not accessible via the rom bar as the IGP rom is
47  * part of the system bios.  On boot, the system bios puts a
48  * copy of the igp rom at the start of vram if a discrete card is
49  * present.
50  */
51 static bool igp_read_bios_from_vram(struct amdgpu_device *adev)
52 {
53 	uint8_t __iomem *bios;
54 	resource_size_t vram_base;
55 	resource_size_t size = 256 * 1024; /* ??? */
56 
57 	if (!(adev->flags & AMD_IS_APU))
58 		if (!amdgpu_card_posted(adev))
59 			return false;
60 
61 	adev->bios = NULL;
62 	vram_base = pci_resource_start(adev->pdev, 0);
63 	bios = ioremap(vram_base, size);
64 	if (!bios) {
65 		return false;
66 	}
67 
68 	if (size == 0 || !AMD_IS_VALID_VBIOS(bios)) {
69 		iounmap(bios);
70 		return false;
71 	}
72 	adev->bios = kmalloc(size, GFP_KERNEL);
73 	if (!adev->bios) {
74 		iounmap(bios);
75 		return false;
76 	}
77 	adev->bios_size = size;
78 	memcpy_fromio(adev->bios, bios, size);
79 	iounmap(bios);
80 	return true;
81 }
82 
83 bool amdgpu_read_bios(struct amdgpu_device *adev)
84 {
85 	uint8_t __iomem *bios, val[2];
86 	size_t size;
87 
88 	adev->bios = NULL;
89 	/* XXX: some cards may return 0 for rom size? ddx has a workaround */
90 	bios = pci_map_rom(adev->pdev, &size);
91 	if (!bios) {
92 		return false;
93 	}
94 
95 	val[0] = readb(&bios[0]);
96 	val[1] = readb(&bios[1]);
97 
98 	if (size == 0 || !AMD_IS_VALID_VBIOS(val)) {
99 		pci_unmap_rom(adev->pdev, bios);
100 		return false;
101 	}
102 	adev->bios = kzalloc(size, GFP_KERNEL);
103 	if (adev->bios == NULL) {
104 		pci_unmap_rom(adev->pdev, bios);
105 		return false;
106 	}
107 	adev->bios_size = size;
108 	memcpy_fromio(adev->bios, bios, size);
109 	pci_unmap_rom(adev->pdev, bios);
110 	return true;
111 }
112 
113 static bool amdgpu_read_bios_from_rom(struct amdgpu_device *adev)
114 {
115 	u8 header[AMD_VBIOS_SIGNATURE_END+1] = {0};
116 	int len;
117 
118 	if (!adev->asic_funcs->read_bios_from_rom)
119 		return false;
120 
121 	/* validate VBIOS signature */
122 	if (amdgpu_asic_read_bios_from_rom(adev, &header[0], sizeof(header)) == false)
123 		return false;
124 	header[AMD_VBIOS_SIGNATURE_END] = 0;
125 
126 	if ((!AMD_IS_VALID_VBIOS(header)) ||
127 	    0 != memcmp((char *)&header[AMD_VBIOS_SIGNATURE_OFFSET],
128 			AMD_VBIOS_SIGNATURE,
129 			strlen(AMD_VBIOS_SIGNATURE)))
130 		return false;
131 
132 	/* valid vbios, go on */
133 	len = AMD_VBIOS_LENGTH(header);
134 	len = ALIGN(len, 4);
135 	adev->bios = kmalloc(len, GFP_KERNEL);
136 	if (!adev->bios) {
137 		DRM_ERROR("no memory to allocate for BIOS\n");
138 		return false;
139 	}
140 	adev->bios_size = len;
141 
142 	/* read complete BIOS */
143 	return amdgpu_asic_read_bios_from_rom(adev, adev->bios, len);
144 }
145 
146 static bool amdgpu_read_platform_bios(struct amdgpu_device *adev)
147 {
148 	uint8_t __iomem *bios;
149 	size_t size;
150 
151 	adev->bios = NULL;
152 
153 	bios = pci_platform_rom(adev->pdev, &size);
154 	if (!bios) {
155 		return false;
156 	}
157 
158 	if (size == 0 || !AMD_IS_VALID_VBIOS(bios)) {
159 		return false;
160 	}
161 	adev->bios = kmemdup(bios, size, GFP_KERNEL);
162 	if (adev->bios == NULL) {
163 		return false;
164 	}
165 	adev->bios_size = size;
166 
167 	return true;
168 }
169 
170 #ifdef CONFIG_ACPI
171 /* ATRM is used to get the BIOS on the discrete cards in
172  * dual-gpu systems.
173  */
174 /* retrieve the ROM in 4k blocks */
175 #define ATRM_BIOS_PAGE 4096
176 /**
177  * amdgpu_atrm_call - fetch a chunk of the vbios
178  *
179  * @atrm_handle: acpi ATRM handle
180  * @bios: vbios image pointer
181  * @offset: offset of vbios image data to fetch
182  * @len: length of vbios image data to fetch
183  *
184  * Executes ATRM to fetch a chunk of the discrete
185  * vbios image on PX systems (all asics).
186  * Returns the length of the buffer fetched.
187  */
188 static int amdgpu_atrm_call(acpi_handle atrm_handle, uint8_t *bios,
189 			    int offset, int len)
190 {
191 	acpi_status status;
192 	union acpi_object atrm_arg_elements[2], *obj;
193 	struct acpi_object_list atrm_arg;
194 	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL};
195 
196 	atrm_arg.count = 2;
197 	atrm_arg.pointer = &atrm_arg_elements[0];
198 
199 	atrm_arg_elements[0].type = ACPI_TYPE_INTEGER;
200 	atrm_arg_elements[0].integer.value = offset;
201 
202 	atrm_arg_elements[1].type = ACPI_TYPE_INTEGER;
203 	atrm_arg_elements[1].integer.value = len;
204 
205 	status = acpi_evaluate_object(atrm_handle, NULL, &atrm_arg, &buffer);
206 	if (ACPI_FAILURE(status)) {
207 		printk("failed to evaluate ATRM got %s\n", acpi_format_exception(status));
208 		return -ENODEV;
209 	}
210 
211 	obj = (union acpi_object *)buffer.pointer;
212 	memcpy(bios+offset, obj->buffer.pointer, obj->buffer.length);
213 	len = obj->buffer.length;
214 	kfree(buffer.pointer);
215 	return len;
216 }
217 
218 static bool amdgpu_atrm_get_bios(struct amdgpu_device *adev)
219 {
220 	int ret;
221 	int size = 256 * 1024;
222 	int i;
223 	struct pci_dev *pdev = NULL;
224 	acpi_handle dhandle, atrm_handle;
225 	acpi_status status;
226 	bool found = false;
227 
228 	/* ATRM is for the discrete card only */
229 	if (adev->flags & AMD_IS_APU)
230 		return false;
231 
232 	while ((pdev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, pdev)) != NULL) {
233 		dhandle = ACPI_HANDLE(&pdev->dev);
234 		if (!dhandle)
235 			continue;
236 
237 		status = acpi_get_handle(dhandle, "ATRM", &atrm_handle);
238 		if (!ACPI_FAILURE(status)) {
239 			found = true;
240 			break;
241 		}
242 	}
243 
244 	if (!found) {
245 		while ((pdev = pci_get_class(PCI_CLASS_DISPLAY_OTHER << 8, pdev)) != NULL) {
246 			dhandle = ACPI_HANDLE(&pdev->dev);
247 			if (!dhandle)
248 				continue;
249 
250 			status = acpi_get_handle(dhandle, "ATRM", &atrm_handle);
251 			if (!ACPI_FAILURE(status)) {
252 				found = true;
253 				break;
254 			}
255 		}
256 	}
257 
258 	if (!found)
259 		return false;
260 
261 	adev->bios = kmalloc(size, GFP_KERNEL);
262 	if (!adev->bios) {
263 		DRM_ERROR("Unable to allocate bios\n");
264 		return false;
265 	}
266 
267 	for (i = 0; i < size / ATRM_BIOS_PAGE; i++) {
268 		ret = amdgpu_atrm_call(atrm_handle,
269 				       adev->bios,
270 				       (i * ATRM_BIOS_PAGE),
271 				       ATRM_BIOS_PAGE);
272 		if (ret < ATRM_BIOS_PAGE)
273 			break;
274 	}
275 
276 	if (i == 0 || !AMD_IS_VALID_VBIOS(adev->bios)) {
277 		kfree(adev->bios);
278 		return false;
279 	}
280 	adev->bios_size = size;
281 	return true;
282 }
283 #else
284 static inline bool amdgpu_atrm_get_bios(struct amdgpu_device *adev)
285 {
286 	return false;
287 }
288 #endif
289 
290 static bool amdgpu_read_disabled_bios(struct amdgpu_device *adev)
291 {
292 	if (adev->flags & AMD_IS_APU)
293 		return igp_read_bios_from_vram(adev);
294 	else
295 		return amdgpu_asic_read_disabled_bios(adev);
296 }
297 
298 #ifdef CONFIG_ACPI
299 static bool amdgpu_acpi_vfct_bios(struct amdgpu_device *adev)
300 {
301 	bool ret = false;
302 	struct acpi_table_header *hdr;
303 	acpi_size tbl_size;
304 	UEFI_ACPI_VFCT *vfct;
305 	GOP_VBIOS_CONTENT *vbios;
306 	VFCT_IMAGE_HEADER *vhdr;
307 
308 	if (!ACPI_SUCCESS(acpi_get_table("VFCT", 1, &hdr)))
309 		return false;
310 	tbl_size = hdr->length;
311 	if (tbl_size < sizeof(UEFI_ACPI_VFCT)) {
312 		DRM_ERROR("ACPI VFCT table present but broken (too short #1)\n");
313 		goto out_unmap;
314 	}
315 
316 	vfct = (UEFI_ACPI_VFCT *)hdr;
317 	if (vfct->VBIOSImageOffset + sizeof(VFCT_IMAGE_HEADER) > tbl_size) {
318 		DRM_ERROR("ACPI VFCT table present but broken (too short #2)\n");
319 		goto out_unmap;
320 	}
321 
322 	vbios = (GOP_VBIOS_CONTENT *)((char *)hdr + vfct->VBIOSImageOffset);
323 	vhdr = &vbios->VbiosHeader;
324 	DRM_INFO("ACPI VFCT contains a BIOS for %02x:%02x.%d %04x:%04x, size %d\n",
325 			vhdr->PCIBus, vhdr->PCIDevice, vhdr->PCIFunction,
326 			vhdr->VendorID, vhdr->DeviceID, vhdr->ImageLength);
327 
328 	if (vhdr->PCIBus != adev->pdev->bus->number ||
329 	    vhdr->PCIDevice != PCI_SLOT(adev->pdev->devfn) ||
330 	    vhdr->PCIFunction != PCI_FUNC(adev->pdev->devfn) ||
331 	    vhdr->VendorID != adev->pdev->vendor ||
332 	    vhdr->DeviceID != adev->pdev->device) {
333 		DRM_INFO("ACPI VFCT table is not for this card\n");
334 		goto out_unmap;
335 	}
336 
337 	if (vfct->VBIOSImageOffset + sizeof(VFCT_IMAGE_HEADER) + vhdr->ImageLength > tbl_size) {
338 		DRM_ERROR("ACPI VFCT image truncated\n");
339 		goto out_unmap;
340 	}
341 
342 	adev->bios = kmemdup(&vbios->VbiosContent, vhdr->ImageLength, GFP_KERNEL);
343 	adev->bios_size = vhdr->ImageLength;
344 	ret = !!adev->bios;
345 
346 out_unmap:
347 	return ret;
348 }
349 #else
350 static inline bool amdgpu_acpi_vfct_bios(struct amdgpu_device *adev)
351 {
352 	return false;
353 }
354 #endif
355 
356 bool amdgpu_get_bios(struct amdgpu_device *adev)
357 {
358 	bool r;
359 	uint16_t tmp, bios_header_start;
360 
361 	r = amdgpu_atrm_get_bios(adev);
362 	if (!r)
363 		r = amdgpu_acpi_vfct_bios(adev);
364 	if (!r)
365 		r = igp_read_bios_from_vram(adev);
366 	if (!r)
367 		r = amdgpu_read_bios(adev);
368 	if (!r) {
369 		r = amdgpu_read_bios_from_rom(adev);
370 	}
371 	if (!r) {
372 		r = amdgpu_read_disabled_bios(adev);
373 	}
374 	if (!r) {
375 		r = amdgpu_read_platform_bios(adev);
376 	}
377 	if (!r || adev->bios == NULL) {
378 		DRM_ERROR("Unable to locate a BIOS ROM\n");
379 		adev->bios = NULL;
380 		return false;
381 	}
382 	if (!AMD_IS_VALID_VBIOS(adev->bios)) {
383 		printk("BIOS signature incorrect %x %x\n", adev->bios[0], adev->bios[1]);
384 		goto free_bios;
385 	}
386 
387 	tmp = RBIOS16(0x18);
388 	if (RBIOS8(tmp + 0x14) != 0x0) {
389 		DRM_INFO("Not an x86 BIOS ROM, not using.\n");
390 		goto free_bios;
391 	}
392 
393 	bios_header_start = RBIOS16(0x48);
394 	if (!bios_header_start) {
395 		goto free_bios;
396 	}
397 	tmp = bios_header_start + 4;
398 	if (!memcmp(adev->bios + tmp, "ATOM", 4) ||
399 	    !memcmp(adev->bios + tmp, "MOTA", 4)) {
400 		adev->is_atom_bios = true;
401 	} else {
402 		adev->is_atom_bios = false;
403 	}
404 
405 	DRM_DEBUG("%sBIOS detected\n", adev->is_atom_bios ? "ATOM" : "COM");
406 	return true;
407 free_bios:
408 	kfree(adev->bios);
409 	adev->bios = NULL;
410 	return false;
411 }
412