GNU Linux-libre 4.19.286-gnu1
[releases.git] / drivers / gpu / drm / amd / amdgpu / amdgpu_bios.c
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         phys_addr_t rom = adev->pdev->rom;
195         size_t romlen = adev->pdev->romlen;
196         void __iomem *bios;
197
198         adev->bios = NULL;
199
200         if (!rom || romlen == 0)
201                 return false;
202
203         adev->bios = kzalloc(romlen, GFP_KERNEL);
204         if (!adev->bios)
205                 return false;
206
207         bios = ioremap(rom, romlen);
208         if (!bios)
209                 goto free_bios;
210
211         memcpy_fromio(adev->bios, bios, romlen);
212         iounmap(bios);
213
214         if (!check_atom_bios(adev->bios, romlen))
215                 goto free_bios;
216
217         adev->bios_size = romlen;
218
219         return true;
220 free_bios:
221         kfree(adev->bios);
222         return false;
223 }
224
225 #ifdef CONFIG_ACPI
226 /* ATRM is used to get the BIOS on the discrete cards in
227  * dual-gpu systems.
228  */
229 /* retrieve the ROM in 4k blocks */
230 #define ATRM_BIOS_PAGE 4096
231 /**
232  * amdgpu_atrm_call - fetch a chunk of the vbios
233  *
234  * @atrm_handle: acpi ATRM handle
235  * @bios: vbios image pointer
236  * @offset: offset of vbios image data to fetch
237  * @len: length of vbios image data to fetch
238  *
239  * Executes ATRM to fetch a chunk of the discrete
240  * vbios image on PX systems (all asics).
241  * Returns the length of the buffer fetched.
242  */
243 static int amdgpu_atrm_call(acpi_handle atrm_handle, uint8_t *bios,
244                             int offset, int len)
245 {
246         acpi_status status;
247         union acpi_object atrm_arg_elements[2], *obj;
248         struct acpi_object_list atrm_arg;
249         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL};
250
251         atrm_arg.count = 2;
252         atrm_arg.pointer = &atrm_arg_elements[0];
253
254         atrm_arg_elements[0].type = ACPI_TYPE_INTEGER;
255         atrm_arg_elements[0].integer.value = offset;
256
257         atrm_arg_elements[1].type = ACPI_TYPE_INTEGER;
258         atrm_arg_elements[1].integer.value = len;
259
260         status = acpi_evaluate_object(atrm_handle, NULL, &atrm_arg, &buffer);
261         if (ACPI_FAILURE(status)) {
262                 printk("failed to evaluate ATRM got %s\n", acpi_format_exception(status));
263                 return -ENODEV;
264         }
265
266         obj = (union acpi_object *)buffer.pointer;
267         memcpy(bios+offset, obj->buffer.pointer, obj->buffer.length);
268         len = obj->buffer.length;
269         kfree(buffer.pointer);
270         return len;
271 }
272
273 static bool amdgpu_atrm_get_bios(struct amdgpu_device *adev)
274 {
275         int ret;
276         int size = 256 * 1024;
277         int i;
278         struct pci_dev *pdev = NULL;
279         acpi_handle dhandle, atrm_handle;
280         acpi_status status;
281         bool found = false;
282
283         /* ATRM is for the discrete card only */
284         if (adev->flags & AMD_IS_APU)
285                 return false;
286
287         while ((pdev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, pdev)) != NULL) {
288                 dhandle = ACPI_HANDLE(&pdev->dev);
289                 if (!dhandle)
290                         continue;
291
292                 status = acpi_get_handle(dhandle, "ATRM", &atrm_handle);
293                 if (!ACPI_FAILURE(status)) {
294                         found = true;
295                         break;
296                 }
297         }
298
299         if (!found) {
300                 while ((pdev = pci_get_class(PCI_CLASS_DISPLAY_OTHER << 8, pdev)) != NULL) {
301                         dhandle = ACPI_HANDLE(&pdev->dev);
302                         if (!dhandle)
303                                 continue;
304
305                         status = acpi_get_handle(dhandle, "ATRM", &atrm_handle);
306                         if (!ACPI_FAILURE(status)) {
307                                 found = true;
308                                 break;
309                         }
310                 }
311         }
312
313         if (!found)
314                 return false;
315         pci_dev_put(pdev);
316
317         adev->bios = kmalloc(size, GFP_KERNEL);
318         if (!adev->bios) {
319                 DRM_ERROR("Unable to allocate bios\n");
320                 return false;
321         }
322
323         for (i = 0; i < size / ATRM_BIOS_PAGE; i++) {
324                 ret = amdgpu_atrm_call(atrm_handle,
325                                        adev->bios,
326                                        (i * ATRM_BIOS_PAGE),
327                                        ATRM_BIOS_PAGE);
328                 if (ret < ATRM_BIOS_PAGE)
329                         break;
330         }
331
332         if (!check_atom_bios(adev->bios, size)) {
333                 kfree(adev->bios);
334                 return false;
335         }
336         adev->bios_size = size;
337         return true;
338 }
339 #else
340 static inline bool amdgpu_atrm_get_bios(struct amdgpu_device *adev)
341 {
342         return false;
343 }
344 #endif
345
346 static bool amdgpu_read_disabled_bios(struct amdgpu_device *adev)
347 {
348         if (adev->flags & AMD_IS_APU)
349                 return igp_read_bios_from_vram(adev);
350         else
351                 return amdgpu_asic_read_disabled_bios(adev);
352 }
353
354 #ifdef CONFIG_ACPI
355 static bool amdgpu_acpi_vfct_bios(struct amdgpu_device *adev)
356 {
357         struct acpi_table_header *hdr;
358         acpi_size tbl_size;
359         UEFI_ACPI_VFCT *vfct;
360         unsigned offset;
361
362         if (!ACPI_SUCCESS(acpi_get_table("VFCT", 1, &hdr)))
363                 return false;
364         tbl_size = hdr->length;
365         if (tbl_size < sizeof(UEFI_ACPI_VFCT)) {
366                 DRM_ERROR("ACPI VFCT table present but broken (too short #1)\n");
367                 return false;
368         }
369
370         vfct = (UEFI_ACPI_VFCT *)hdr;
371         offset = vfct->VBIOSImageOffset;
372
373         while (offset < tbl_size) {
374                 GOP_VBIOS_CONTENT *vbios = (GOP_VBIOS_CONTENT *)((char *)hdr + offset);
375                 VFCT_IMAGE_HEADER *vhdr = &vbios->VbiosHeader;
376
377                 offset += sizeof(VFCT_IMAGE_HEADER);
378                 if (offset > tbl_size) {
379                         DRM_ERROR("ACPI VFCT image header truncated\n");
380                         return false;
381                 }
382
383                 offset += vhdr->ImageLength;
384                 if (offset > tbl_size) {
385                         DRM_ERROR("ACPI VFCT image truncated\n");
386                         return false;
387                 }
388
389                 if (vhdr->ImageLength &&
390                     vhdr->PCIBus == adev->pdev->bus->number &&
391                     vhdr->PCIDevice == PCI_SLOT(adev->pdev->devfn) &&
392                     vhdr->PCIFunction == PCI_FUNC(adev->pdev->devfn) &&
393                     vhdr->VendorID == adev->pdev->vendor &&
394                     vhdr->DeviceID == adev->pdev->device) {
395                         adev->bios = kmemdup(&vbios->VbiosContent,
396                                              vhdr->ImageLength,
397                                              GFP_KERNEL);
398
399                         if (!check_atom_bios(adev->bios, vhdr->ImageLength)) {
400                                 kfree(adev->bios);
401                                 return false;
402                         }
403                         adev->bios_size = vhdr->ImageLength;
404                         return true;
405                 }
406         }
407
408         DRM_ERROR("ACPI VFCT table present but broken (too short #2)\n");
409         return false;
410 }
411 #else
412 static inline bool amdgpu_acpi_vfct_bios(struct amdgpu_device *adev)
413 {
414         return false;
415 }
416 #endif
417
418 bool amdgpu_get_bios(struct amdgpu_device *adev)
419 {
420         if (amdgpu_atrm_get_bios(adev))
421                 goto success;
422
423         if (amdgpu_acpi_vfct_bios(adev))
424                 goto success;
425
426         if (igp_read_bios_from_vram(adev))
427                 goto success;
428
429         if (amdgpu_read_bios(adev))
430                 goto success;
431
432         if (amdgpu_read_bios_from_rom(adev))
433                 goto success;
434
435         if (amdgpu_read_disabled_bios(adev))
436                 goto success;
437
438         if (amdgpu_read_platform_bios(adev))
439                 goto success;
440
441         DRM_ERROR("Unable to locate a BIOS ROM\n");
442         return false;
443
444 success:
445         adev->is_atom_fw = (adev->asic_type >= CHIP_VEGA10) ? true : false;
446         return true;
447 }