Merge tag 'v5.3-rc3' into drm-next-5.4
[sfrench/cifs-2.6.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
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         adev->bios = NULL;
101         vram_base = pci_resource_start(adev->pdev, 0);
102         bios = ioremap_wc(vram_base, size);
103         if (!bios) {
104                 return false;
105         }
106
107         adev->bios = kmalloc(size, GFP_KERNEL);
108         if (!adev->bios) {
109                 iounmap(bios);
110                 return false;
111         }
112         adev->bios_size = size;
113         memcpy_fromio(adev->bios, bios, size);
114         iounmap(bios);
115
116         if (!check_atom_bios(adev->bios, size)) {
117                 kfree(adev->bios);
118                 return false;
119         }
120
121         return true;
122 }
123
124 bool amdgpu_read_bios(struct amdgpu_device *adev)
125 {
126         uint8_t __iomem *bios;
127         size_t size;
128
129         adev->bios = NULL;
130         /* XXX: some cards may return 0 for rom size? ddx has a workaround */
131         bios = pci_map_rom(adev->pdev, &size);
132         if (!bios) {
133                 return false;
134         }
135
136         adev->bios = kzalloc(size, GFP_KERNEL);
137         if (adev->bios == NULL) {
138                 pci_unmap_rom(adev->pdev, bios);
139                 return false;
140         }
141         adev->bios_size = size;
142         memcpy_fromio(adev->bios, bios, size);
143         pci_unmap_rom(adev->pdev, bios);
144
145         if (!check_atom_bios(adev->bios, size)) {
146                 kfree(adev->bios);
147                 return false;
148         }
149
150         return true;
151 }
152
153 static bool amdgpu_read_bios_from_rom(struct amdgpu_device *adev)
154 {
155         u8 header[AMD_VBIOS_SIGNATURE_END+1] = {0};
156         int len;
157
158         if (!adev->asic_funcs->read_bios_from_rom)
159                 return false;
160
161         /* validate VBIOS signature */
162         if (amdgpu_asic_read_bios_from_rom(adev, &header[0], sizeof(header)) == false)
163                 return false;
164         header[AMD_VBIOS_SIGNATURE_END] = 0;
165
166         if ((!AMD_IS_VALID_VBIOS(header)) ||
167             0 != memcmp((char *)&header[AMD_VBIOS_SIGNATURE_OFFSET],
168                         AMD_VBIOS_SIGNATURE,
169                         strlen(AMD_VBIOS_SIGNATURE)))
170                 return false;
171
172         /* valid vbios, go on */
173         len = AMD_VBIOS_LENGTH(header);
174         len = ALIGN(len, 4);
175         adev->bios = kmalloc(len, GFP_KERNEL);
176         if (!adev->bios) {
177                 DRM_ERROR("no memory to allocate for BIOS\n");
178                 return false;
179         }
180         adev->bios_size = len;
181
182         /* read complete BIOS */
183         amdgpu_asic_read_bios_from_rom(adev, adev->bios, len);
184
185         if (!check_atom_bios(adev->bios, len)) {
186                 kfree(adev->bios);
187                 return false;
188         }
189
190         return true;
191 }
192
193 static bool amdgpu_read_platform_bios(struct amdgpu_device *adev)
194 {
195         uint8_t __iomem *bios;
196         size_t size;
197
198         adev->bios = NULL;
199
200         bios = pci_platform_rom(adev->pdev, &size);
201         if (!bios) {
202                 return false;
203         }
204
205         adev->bios = kzalloc(size, GFP_KERNEL);
206         if (adev->bios == NULL)
207                 return false;
208
209         memcpy_fromio(adev->bios, bios, size);
210
211         if (!check_atom_bios(adev->bios, size)) {
212                 kfree(adev->bios);
213                 return false;
214         }
215
216         adev->bios_size = size;
217
218         return true;
219 }
220
221 #ifdef CONFIG_ACPI
222 /* ATRM is used to get the BIOS on the discrete cards in
223  * dual-gpu systems.
224  */
225 /* retrieve the ROM in 4k blocks */
226 #define ATRM_BIOS_PAGE 4096
227 /**
228  * amdgpu_atrm_call - fetch a chunk of the vbios
229  *
230  * @atrm_handle: acpi ATRM handle
231  * @bios: vbios image pointer
232  * @offset: offset of vbios image data to fetch
233  * @len: length of vbios image data to fetch
234  *
235  * Executes ATRM to fetch a chunk of the discrete
236  * vbios image on PX systems (all asics).
237  * Returns the length of the buffer fetched.
238  */
239 static int amdgpu_atrm_call(acpi_handle atrm_handle, uint8_t *bios,
240                             int offset, int len)
241 {
242         acpi_status status;
243         union acpi_object atrm_arg_elements[2], *obj;
244         struct acpi_object_list atrm_arg;
245         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL};
246
247         atrm_arg.count = 2;
248         atrm_arg.pointer = &atrm_arg_elements[0];
249
250         atrm_arg_elements[0].type = ACPI_TYPE_INTEGER;
251         atrm_arg_elements[0].integer.value = offset;
252
253         atrm_arg_elements[1].type = ACPI_TYPE_INTEGER;
254         atrm_arg_elements[1].integer.value = len;
255
256         status = acpi_evaluate_object(atrm_handle, NULL, &atrm_arg, &buffer);
257         if (ACPI_FAILURE(status)) {
258                 printk("failed to evaluate ATRM got %s\n", acpi_format_exception(status));
259                 return -ENODEV;
260         }
261
262         obj = (union acpi_object *)buffer.pointer;
263         memcpy(bios+offset, obj->buffer.pointer, obj->buffer.length);
264         len = obj->buffer.length;
265         kfree(buffer.pointer);
266         return len;
267 }
268
269 static bool amdgpu_atrm_get_bios(struct amdgpu_device *adev)
270 {
271         int ret;
272         int size = 256 * 1024;
273         int i;
274         struct pci_dev *pdev = NULL;
275         acpi_handle dhandle, atrm_handle;
276         acpi_status status;
277         bool found = false;
278
279         /* ATRM is for the discrete card only */
280         if (adev->flags & AMD_IS_APU)
281                 return false;
282
283         while ((pdev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, pdev)) != NULL) {
284                 dhandle = ACPI_HANDLE(&pdev->dev);
285                 if (!dhandle)
286                         continue;
287
288                 status = acpi_get_handle(dhandle, "ATRM", &atrm_handle);
289                 if (!ACPI_FAILURE(status)) {
290                         found = true;
291                         break;
292                 }
293         }
294
295         if (!found) {
296                 while ((pdev = pci_get_class(PCI_CLASS_DISPLAY_OTHER << 8, pdev)) != NULL) {
297                         dhandle = ACPI_HANDLE(&pdev->dev);
298                         if (!dhandle)
299                                 continue;
300
301                         status = acpi_get_handle(dhandle, "ATRM", &atrm_handle);
302                         if (!ACPI_FAILURE(status)) {
303                                 found = true;
304                                 break;
305                         }
306                 }
307         }
308
309         if (!found)
310                 return false;
311
312         adev->bios = kmalloc(size, GFP_KERNEL);
313         if (!adev->bios) {
314                 DRM_ERROR("Unable to allocate bios\n");
315                 return false;
316         }
317
318         for (i = 0; i < size / ATRM_BIOS_PAGE; i++) {
319                 ret = amdgpu_atrm_call(atrm_handle,
320                                        adev->bios,
321                                        (i * ATRM_BIOS_PAGE),
322                                        ATRM_BIOS_PAGE);
323                 if (ret < ATRM_BIOS_PAGE)
324                         break;
325         }
326
327         if (!check_atom_bios(adev->bios, size)) {
328                 kfree(adev->bios);
329                 return false;
330         }
331         adev->bios_size = size;
332         return true;
333 }
334 #else
335 static inline bool amdgpu_atrm_get_bios(struct amdgpu_device *adev)
336 {
337         return false;
338 }
339 #endif
340
341 static bool amdgpu_read_disabled_bios(struct amdgpu_device *adev)
342 {
343         if (adev->flags & AMD_IS_APU)
344                 return igp_read_bios_from_vram(adev);
345         else
346                 return amdgpu_asic_read_disabled_bios(adev);
347 }
348
349 #ifdef CONFIG_ACPI
350 static bool amdgpu_acpi_vfct_bios(struct amdgpu_device *adev)
351 {
352         struct acpi_table_header *hdr;
353         acpi_size tbl_size;
354         UEFI_ACPI_VFCT *vfct;
355         unsigned offset;
356
357         if (!ACPI_SUCCESS(acpi_get_table("VFCT", 1, &hdr)))
358                 return false;
359         tbl_size = hdr->length;
360         if (tbl_size < sizeof(UEFI_ACPI_VFCT)) {
361                 DRM_ERROR("ACPI VFCT table present but broken (too short #1)\n");
362                 return false;
363         }
364
365         vfct = (UEFI_ACPI_VFCT *)hdr;
366         offset = vfct->VBIOSImageOffset;
367
368         while (offset < tbl_size) {
369                 GOP_VBIOS_CONTENT *vbios = (GOP_VBIOS_CONTENT *)((char *)hdr + offset);
370                 VFCT_IMAGE_HEADER *vhdr = &vbios->VbiosHeader;
371
372                 offset += sizeof(VFCT_IMAGE_HEADER);
373                 if (offset > tbl_size) {
374                         DRM_ERROR("ACPI VFCT image header truncated\n");
375                         return false;
376                 }
377
378                 offset += vhdr->ImageLength;
379                 if (offset > tbl_size) {
380                         DRM_ERROR("ACPI VFCT image truncated\n");
381                         return false;
382                 }
383
384                 if (vhdr->ImageLength &&
385                     vhdr->PCIBus == adev->pdev->bus->number &&
386                     vhdr->PCIDevice == PCI_SLOT(adev->pdev->devfn) &&
387                     vhdr->PCIFunction == PCI_FUNC(adev->pdev->devfn) &&
388                     vhdr->VendorID == adev->pdev->vendor &&
389                     vhdr->DeviceID == adev->pdev->device) {
390                         adev->bios = kmemdup(&vbios->VbiosContent,
391                                              vhdr->ImageLength,
392                                              GFP_KERNEL);
393
394                         if (!check_atom_bios(adev->bios, vhdr->ImageLength)) {
395                                 kfree(adev->bios);
396                                 return false;
397                         }
398                         adev->bios_size = vhdr->ImageLength;
399                         return true;
400                 }
401         }
402
403         DRM_ERROR("ACPI VFCT table present but broken (too short #2)\n");
404         return false;
405 }
406 #else
407 static inline bool amdgpu_acpi_vfct_bios(struct amdgpu_device *adev)
408 {
409         return false;
410 }
411 #endif
412
413 bool amdgpu_get_bios(struct amdgpu_device *adev)
414 {
415         if (amdgpu_atrm_get_bios(adev))
416                 goto success;
417
418         if (amdgpu_acpi_vfct_bios(adev))
419                 goto success;
420
421         if (igp_read_bios_from_vram(adev))
422                 goto success;
423
424         if (amdgpu_read_bios(adev))
425                 goto success;
426
427         if (amdgpu_read_bios_from_rom(adev))
428                 goto success;
429
430         if (amdgpu_read_disabled_bios(adev))
431                 goto success;
432
433         if (amdgpu_read_platform_bios(adev))
434                 goto success;
435
436         DRM_ERROR("Unable to locate a BIOS ROM\n");
437         return false;
438
439 success:
440         adev->is_atom_fw = (adev->asic_type >= CHIP_VEGA10) ? true : false;
441         return true;
442 }