GNU Linux-libre 4.14.266-gnu1
[releases.git] / drivers / gpu / drm / amd / amdgpu / amdgpu_ucode.c
1 /*
2  * Copyright 2014 Advanced Micro Devices, Inc.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  *
22  */
23
24 #include <linux/firmware.h>
25 #include <linux/slab.h>
26 #include <linux/module.h>
27 #include <drm/drmP.h>
28 #include "amdgpu.h"
29 #include "amdgpu_ucode.h"
30
31 static void amdgpu_ucode_print_common_hdr(const struct common_firmware_header *hdr)
32 {
33         DRM_DEBUG("size_bytes: %u\n", le32_to_cpu(hdr->size_bytes));
34         DRM_DEBUG("header_size_bytes: %u\n", le32_to_cpu(hdr->header_size_bytes));
35         DRM_DEBUG("header_version_major: %u\n", le16_to_cpu(hdr->header_version_major));
36         DRM_DEBUG("header_version_minor: %u\n", le16_to_cpu(hdr->header_version_minor));
37         DRM_DEBUG("ip_version_major: %u\n", le16_to_cpu(hdr->ip_version_major));
38         DRM_DEBUG("ip_version_minor: %u\n", le16_to_cpu(hdr->ip_version_minor));
39         DRM_DEBUG("ucode_version: 0x%08x\n", le32_to_cpu(hdr->ucode_version));
40         DRM_DEBUG("ucode_size_bytes: %u\n", le32_to_cpu(hdr->ucode_size_bytes));
41         DRM_DEBUG("ucode_array_offset_bytes: %u\n",
42                   le32_to_cpu(hdr->ucode_array_offset_bytes));
43         DRM_DEBUG("crc32: 0x%08x\n", le32_to_cpu(hdr->crc32));
44 }
45
46 void amdgpu_ucode_print_mc_hdr(const struct common_firmware_header *hdr)
47 {
48         uint16_t version_major = le16_to_cpu(hdr->header_version_major);
49         uint16_t version_minor = le16_to_cpu(hdr->header_version_minor);
50
51         DRM_DEBUG("MC\n");
52         amdgpu_ucode_print_common_hdr(hdr);
53
54         if (version_major == 1) {
55                 const struct mc_firmware_header_v1_0 *mc_hdr =
56                         container_of(hdr, struct mc_firmware_header_v1_0, header);
57
58                 DRM_DEBUG("io_debug_size_bytes: %u\n",
59                           le32_to_cpu(mc_hdr->io_debug_size_bytes));
60                 DRM_DEBUG("io_debug_array_offset_bytes: %u\n",
61                           le32_to_cpu(mc_hdr->io_debug_array_offset_bytes));
62         } else {
63                 DRM_ERROR("Unknown MC ucode version: %u.%u\n", version_major, version_minor);
64         }
65 }
66
67 void amdgpu_ucode_print_smc_hdr(const struct common_firmware_header *hdr)
68 {
69         uint16_t version_major = le16_to_cpu(hdr->header_version_major);
70         uint16_t version_minor = le16_to_cpu(hdr->header_version_minor);
71
72         DRM_DEBUG("SMC\n");
73         amdgpu_ucode_print_common_hdr(hdr);
74
75         if (version_major == 1) {
76                 const struct smc_firmware_header_v1_0 *smc_hdr =
77                         container_of(hdr, struct smc_firmware_header_v1_0, header);
78
79                 DRM_DEBUG("ucode_start_addr: %u\n", le32_to_cpu(smc_hdr->ucode_start_addr));
80         } else {
81                 DRM_ERROR("Unknown SMC ucode version: %u.%u\n", version_major, version_minor);
82         }
83 }
84
85 void amdgpu_ucode_print_gfx_hdr(const struct common_firmware_header *hdr)
86 {
87         uint16_t version_major = le16_to_cpu(hdr->header_version_major);
88         uint16_t version_minor = le16_to_cpu(hdr->header_version_minor);
89
90         DRM_DEBUG("GFX\n");
91         amdgpu_ucode_print_common_hdr(hdr);
92
93         if (version_major == 1) {
94                 const struct gfx_firmware_header_v1_0 *gfx_hdr =
95                         container_of(hdr, struct gfx_firmware_header_v1_0, header);
96
97                 DRM_DEBUG("ucode_feature_version: %u\n",
98                           le32_to_cpu(gfx_hdr->ucode_feature_version));
99                 DRM_DEBUG("jt_offset: %u\n", le32_to_cpu(gfx_hdr->jt_offset));
100                 DRM_DEBUG("jt_size: %u\n", le32_to_cpu(gfx_hdr->jt_size));
101         } else {
102                 DRM_ERROR("Unknown GFX ucode version: %u.%u\n", version_major, version_minor);
103         }
104 }
105
106 void amdgpu_ucode_print_rlc_hdr(const struct common_firmware_header *hdr)
107 {
108         uint16_t version_major = le16_to_cpu(hdr->header_version_major);
109         uint16_t version_minor = le16_to_cpu(hdr->header_version_minor);
110
111         DRM_DEBUG("RLC\n");
112         amdgpu_ucode_print_common_hdr(hdr);
113
114         if (version_major == 1) {
115                 const struct rlc_firmware_header_v1_0 *rlc_hdr =
116                         container_of(hdr, struct rlc_firmware_header_v1_0, header);
117
118                 DRM_DEBUG("ucode_feature_version: %u\n",
119                           le32_to_cpu(rlc_hdr->ucode_feature_version));
120                 DRM_DEBUG("save_and_restore_offset: %u\n",
121                           le32_to_cpu(rlc_hdr->save_and_restore_offset));
122                 DRM_DEBUG("clear_state_descriptor_offset: %u\n",
123                           le32_to_cpu(rlc_hdr->clear_state_descriptor_offset));
124                 DRM_DEBUG("avail_scratch_ram_locations: %u\n",
125                           le32_to_cpu(rlc_hdr->avail_scratch_ram_locations));
126                 DRM_DEBUG("master_pkt_description_offset: %u\n",
127                           le32_to_cpu(rlc_hdr->master_pkt_description_offset));
128         } else if (version_major == 2) {
129                 const struct rlc_firmware_header_v2_0 *rlc_hdr =
130                         container_of(hdr, struct rlc_firmware_header_v2_0, header);
131
132                 DRM_DEBUG("ucode_feature_version: %u\n",
133                           le32_to_cpu(rlc_hdr->ucode_feature_version));
134                 DRM_DEBUG("jt_offset: %u\n", le32_to_cpu(rlc_hdr->jt_offset));
135                 DRM_DEBUG("jt_size: %u\n", le32_to_cpu(rlc_hdr->jt_size));
136                 DRM_DEBUG("save_and_restore_offset: %u\n",
137                           le32_to_cpu(rlc_hdr->save_and_restore_offset));
138                 DRM_DEBUG("clear_state_descriptor_offset: %u\n",
139                           le32_to_cpu(rlc_hdr->clear_state_descriptor_offset));
140                 DRM_DEBUG("avail_scratch_ram_locations: %u\n",
141                           le32_to_cpu(rlc_hdr->avail_scratch_ram_locations));
142                 DRM_DEBUG("reg_restore_list_size: %u\n",
143                           le32_to_cpu(rlc_hdr->reg_restore_list_size));
144                 DRM_DEBUG("reg_list_format_start: %u\n",
145                           le32_to_cpu(rlc_hdr->reg_list_format_start));
146                 DRM_DEBUG("reg_list_format_separate_start: %u\n",
147                           le32_to_cpu(rlc_hdr->reg_list_format_separate_start));
148                 DRM_DEBUG("starting_offsets_start: %u\n",
149                           le32_to_cpu(rlc_hdr->starting_offsets_start));
150                 DRM_DEBUG("reg_list_format_size_bytes: %u\n",
151                           le32_to_cpu(rlc_hdr->reg_list_format_size_bytes));
152                 DRM_DEBUG("reg_list_format_array_offset_bytes: %u\n",
153                           le32_to_cpu(rlc_hdr->reg_list_format_array_offset_bytes));
154                 DRM_DEBUG("reg_list_size_bytes: %u\n",
155                           le32_to_cpu(rlc_hdr->reg_list_size_bytes));
156                 DRM_DEBUG("reg_list_array_offset_bytes: %u\n",
157                           le32_to_cpu(rlc_hdr->reg_list_array_offset_bytes));
158                 DRM_DEBUG("reg_list_format_separate_size_bytes: %u\n",
159                           le32_to_cpu(rlc_hdr->reg_list_format_separate_size_bytes));
160                 DRM_DEBUG("reg_list_format_separate_array_offset_bytes: %u\n",
161                           le32_to_cpu(rlc_hdr->reg_list_format_separate_array_offset_bytes));
162                 DRM_DEBUG("reg_list_separate_size_bytes: %u\n",
163                           le32_to_cpu(rlc_hdr->reg_list_separate_size_bytes));
164                 DRM_DEBUG("reg_list_separate_size_bytes: %u\n",
165                           le32_to_cpu(rlc_hdr->reg_list_separate_size_bytes));
166         } else {
167                 DRM_ERROR("Unknown RLC ucode version: %u.%u\n", version_major, version_minor);
168         }
169 }
170
171 void amdgpu_ucode_print_sdma_hdr(const struct common_firmware_header *hdr)
172 {
173         uint16_t version_major = le16_to_cpu(hdr->header_version_major);
174         uint16_t version_minor = le16_to_cpu(hdr->header_version_minor);
175
176         DRM_DEBUG("SDMA\n");
177         amdgpu_ucode_print_common_hdr(hdr);
178
179         if (version_major == 1) {
180                 const struct sdma_firmware_header_v1_0 *sdma_hdr =
181                         container_of(hdr, struct sdma_firmware_header_v1_0, header);
182
183                 DRM_DEBUG("ucode_feature_version: %u\n",
184                           le32_to_cpu(sdma_hdr->ucode_feature_version));
185                 DRM_DEBUG("ucode_change_version: %u\n",
186                           le32_to_cpu(sdma_hdr->ucode_change_version));
187                 DRM_DEBUG("jt_offset: %u\n", le32_to_cpu(sdma_hdr->jt_offset));
188                 DRM_DEBUG("jt_size: %u\n", le32_to_cpu(sdma_hdr->jt_size));
189                 if (version_minor >= 1) {
190                         const struct sdma_firmware_header_v1_1 *sdma_v1_1_hdr =
191                                 container_of(sdma_hdr, struct sdma_firmware_header_v1_1, v1_0);
192                         DRM_DEBUG("digest_size: %u\n", le32_to_cpu(sdma_v1_1_hdr->digest_size));
193                 }
194         } else {
195                 DRM_ERROR("Unknown SDMA ucode version: %u.%u\n",
196                           version_major, version_minor);
197         }
198 }
199
200 void amdgpu_ucode_print_gpu_info_hdr(const struct common_firmware_header *hdr)
201 {
202         uint16_t version_major = le16_to_cpu(hdr->header_version_major);
203         uint16_t version_minor = le16_to_cpu(hdr->header_version_minor);
204
205         DRM_DEBUG("GPU_INFO\n");
206         amdgpu_ucode_print_common_hdr(hdr);
207
208         if (version_major == 1) {
209                 const struct gpu_info_firmware_header_v1_0 *gpu_info_hdr =
210                         container_of(hdr, struct gpu_info_firmware_header_v1_0, header);
211
212                 DRM_DEBUG("version_major: %u\n",
213                           le16_to_cpu(gpu_info_hdr->version_major));
214                 DRM_DEBUG("version_minor: %u\n",
215                           le16_to_cpu(gpu_info_hdr->version_minor));
216         } else {
217                 DRM_ERROR("Unknown gpu_info ucode version: %u.%u\n", version_major, version_minor);
218         }
219 }
220
221 int amdgpu_ucode_validate(const struct firmware *fw)
222 {
223         const struct common_firmware_header *hdr =
224                 (const struct common_firmware_header *)fw->data;
225
226         if (fw->size == le32_to_cpu(hdr->size_bytes))
227                 return 0;
228
229         return -EINVAL;
230 }
231
232 bool amdgpu_ucode_hdr_version(union amdgpu_firmware_header *hdr,
233                                 uint16_t hdr_major, uint16_t hdr_minor)
234 {
235         if ((hdr->common.header_version_major == hdr_major) &&
236                 (hdr->common.header_version_minor == hdr_minor))
237                 return false;
238         return true;
239 }
240
241 enum amdgpu_firmware_load_type
242 amdgpu_ucode_get_load_type(struct amdgpu_device *adev, int load_type)
243 {
244         switch (adev->asic_type) {
245 #ifdef CONFIG_DRM_AMDGPU_SI
246         case CHIP_TAHITI:
247         case CHIP_PITCAIRN:
248         case CHIP_VERDE:
249         case CHIP_OLAND:
250         case CHIP_HAINAN:
251                 return AMDGPU_FW_LOAD_DIRECT;
252 #endif
253 #ifdef CONFIG_DRM_AMDGPU_CIK
254         case CHIP_BONAIRE:
255         case CHIP_KAVERI:
256         case CHIP_KABINI:
257         case CHIP_HAWAII:
258         case CHIP_MULLINS:
259                 return AMDGPU_FW_LOAD_DIRECT;
260 #endif
261         case CHIP_TOPAZ:
262         case CHIP_TONGA:
263         case CHIP_FIJI:
264         case CHIP_CARRIZO:
265         case CHIP_STONEY:
266         case CHIP_POLARIS10:
267         case CHIP_POLARIS11:
268         case CHIP_POLARIS12:
269                 if (!load_type)
270                         return AMDGPU_FW_LOAD_DIRECT;
271                 else
272                         return AMDGPU_FW_LOAD_SMU;
273         case CHIP_VEGA10:
274                 if (!load_type)
275                         return AMDGPU_FW_LOAD_DIRECT;
276                 else
277                         return AMDGPU_FW_LOAD_PSP;
278         case CHIP_RAVEN:
279                 if (load_type != 2)
280                         return AMDGPU_FW_LOAD_DIRECT;
281                 else
282                         return AMDGPU_FW_LOAD_PSP;
283         default:
284                 DRM_ERROR("Unknow firmware load type\n");
285         }
286
287         return AMDGPU_FW_LOAD_DIRECT;
288 }
289
290 static int amdgpu_ucode_init_single_fw(struct amdgpu_device *adev,
291                                        struct amdgpu_firmware_info *ucode,
292                                        uint64_t mc_addr, void *kptr)
293 {
294         const struct common_firmware_header *header = NULL;
295         const struct gfx_firmware_header_v1_0 *cp_hdr = NULL;
296
297         if (NULL == ucode->fw)
298                 return 0;
299
300         ucode->mc_addr = mc_addr;
301         ucode->kaddr = kptr;
302
303         if (ucode->ucode_id == AMDGPU_UCODE_ID_STORAGE)
304                 return 0;
305
306         header = (const struct common_firmware_header *)ucode->fw->data;
307
308         cp_hdr = (const struct gfx_firmware_header_v1_0 *)ucode->fw->data;
309
310         if (adev->firmware.load_type != AMDGPU_FW_LOAD_PSP ||
311             (ucode->ucode_id != AMDGPU_UCODE_ID_CP_MEC1 &&
312              ucode->ucode_id != AMDGPU_UCODE_ID_CP_MEC2 &&
313              ucode->ucode_id != AMDGPU_UCODE_ID_CP_MEC1_JT &&
314              ucode->ucode_id != AMDGPU_UCODE_ID_CP_MEC2_JT)) {
315                 ucode->ucode_size = le32_to_cpu(header->ucode_size_bytes);
316
317                 memcpy(ucode->kaddr, (void *)((uint8_t *)ucode->fw->data +
318                                               le32_to_cpu(header->ucode_array_offset_bytes)),
319                        ucode->ucode_size);
320         } else if (ucode->ucode_id == AMDGPU_UCODE_ID_CP_MEC1 ||
321                    ucode->ucode_id == AMDGPU_UCODE_ID_CP_MEC2) {
322                 ucode->ucode_size = le32_to_cpu(header->ucode_size_bytes) -
323                         le32_to_cpu(cp_hdr->jt_size) * 4;
324
325                 memcpy(ucode->kaddr, (void *)((uint8_t *)ucode->fw->data +
326                                               le32_to_cpu(header->ucode_array_offset_bytes)),
327                        ucode->ucode_size);
328         } else if (ucode->ucode_id == AMDGPU_UCODE_ID_CP_MEC1_JT ||
329                    ucode->ucode_id == AMDGPU_UCODE_ID_CP_MEC2_JT) {
330                 ucode->ucode_size = le32_to_cpu(cp_hdr->jt_size) * 4;
331
332                 memcpy(ucode->kaddr, (void *)((uint8_t *)ucode->fw->data +
333                                               le32_to_cpu(header->ucode_array_offset_bytes) +
334                                               le32_to_cpu(cp_hdr->jt_offset) * 4),
335                        ucode->ucode_size);
336         }
337
338         return 0;
339 }
340
341 static int amdgpu_ucode_patch_jt(struct amdgpu_firmware_info *ucode,
342                                 uint64_t mc_addr, void *kptr)
343 {
344         const struct gfx_firmware_header_v1_0 *header = NULL;
345         const struct common_firmware_header *comm_hdr = NULL;
346         uint8_t* src_addr = NULL;
347         uint8_t* dst_addr = NULL;
348
349         if (NULL == ucode->fw)
350                 return 0;
351
352         comm_hdr = (const struct common_firmware_header *)ucode->fw->data;
353         header = (const struct gfx_firmware_header_v1_0 *)ucode->fw->data;
354         dst_addr = ucode->kaddr +
355                            ALIGN(le32_to_cpu(comm_hdr->ucode_size_bytes),
356                            PAGE_SIZE);
357         src_addr = (uint8_t *)ucode->fw->data +
358                            le32_to_cpu(comm_hdr->ucode_array_offset_bytes) +
359                            (le32_to_cpu(header->jt_offset) * 4);
360         memcpy(dst_addr, src_addr, le32_to_cpu(header->jt_size) * 4);
361
362         return 0;
363 }
364
365 int amdgpu_ucode_init_bo(struct amdgpu_device *adev)
366 {
367         struct amdgpu_bo **bo = &adev->firmware.fw_buf;
368         uint64_t fw_mc_addr;
369         void *fw_buf_ptr = NULL;
370         uint64_t fw_offset = 0;
371         int i, err;
372         struct amdgpu_firmware_info *ucode = NULL;
373         const struct common_firmware_header *header = NULL;
374
375         if (!adev->firmware.fw_size) {
376                 dev_warn(adev->dev, "No ip firmware need to load\n");
377                 return 0;
378         }
379
380         err = amdgpu_bo_create(adev, adev->firmware.fw_size, PAGE_SIZE, true,
381                                 amdgpu_sriov_vf(adev) ? AMDGPU_GEM_DOMAIN_VRAM : AMDGPU_GEM_DOMAIN_GTT,
382                                 AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS,
383                                 NULL, NULL, 0, bo);
384         if (err) {
385                 dev_err(adev->dev, "(%d) Firmware buffer allocate failed\n", err);
386                 goto failed;
387         }
388
389         err = amdgpu_bo_reserve(*bo, false);
390         if (err) {
391                 dev_err(adev->dev, "(%d) Firmware buffer reserve failed\n", err);
392                 goto failed_reserve;
393         }
394
395         err = amdgpu_bo_pin(*bo, amdgpu_sriov_vf(adev) ? AMDGPU_GEM_DOMAIN_VRAM : AMDGPU_GEM_DOMAIN_GTT,
396                                 &fw_mc_addr);
397         if (err) {
398                 dev_err(adev->dev, "(%d) Firmware buffer pin failed\n", err);
399                 goto failed_pin;
400         }
401
402         err = amdgpu_bo_kmap(*bo, &fw_buf_ptr);
403         if (err) {
404                 dev_err(adev->dev, "(%d) Firmware buffer kmap failed\n", err);
405                 goto failed_kmap;
406         }
407
408         amdgpu_bo_unreserve(*bo);
409
410         memset(fw_buf_ptr, 0, adev->firmware.fw_size);
411
412         /*
413          * if SMU loaded firmware, it needn't add SMC, UVD, and VCE
414          * ucode info here
415          */
416         if (adev->firmware.load_type != AMDGPU_FW_LOAD_PSP) {
417                 if (amdgpu_sriov_vf(adev))
418                         adev->firmware.max_ucodes = AMDGPU_UCODE_ID_MAXIMUM - 3;
419                 else
420                         adev->firmware.max_ucodes = AMDGPU_UCODE_ID_MAXIMUM - 4;
421         } else {
422                 adev->firmware.max_ucodes = AMDGPU_UCODE_ID_MAXIMUM;
423         }
424
425         for (i = 0; i < adev->firmware.max_ucodes; i++) {
426                 ucode = &adev->firmware.ucode[i];
427                 if (ucode->fw) {
428                         header = (const struct common_firmware_header *)ucode->fw->data;
429                         amdgpu_ucode_init_single_fw(adev, ucode, fw_mc_addr + fw_offset,
430                                                     (void *)((uint8_t *)fw_buf_ptr + fw_offset));
431                         if (i == AMDGPU_UCODE_ID_CP_MEC1 &&
432                             adev->firmware.load_type != AMDGPU_FW_LOAD_PSP) {
433                                 const struct gfx_firmware_header_v1_0 *cp_hdr;
434                                 cp_hdr = (const struct gfx_firmware_header_v1_0 *)ucode->fw->data;
435                                 amdgpu_ucode_patch_jt(ucode, fw_mc_addr + fw_offset,
436                                                     fw_buf_ptr + fw_offset);
437                                 fw_offset += ALIGN(le32_to_cpu(cp_hdr->jt_size) << 2, PAGE_SIZE);
438                         }
439                         fw_offset += ALIGN(ucode->ucode_size, PAGE_SIZE);
440                 }
441         }
442         return 0;
443
444 failed_kmap:
445         amdgpu_bo_unpin(*bo);
446 failed_pin:
447         amdgpu_bo_unreserve(*bo);
448 failed_reserve:
449         amdgpu_bo_unref(bo);
450 failed:
451         if (err)
452                 adev->firmware.load_type = AMDGPU_FW_LOAD_DIRECT;
453
454         return err;
455 }
456
457 int amdgpu_ucode_fini_bo(struct amdgpu_device *adev)
458 {
459         int i;
460         struct amdgpu_firmware_info *ucode = NULL;
461
462         if (!adev->firmware.fw_size)
463                 return 0;
464
465         for (i = 0; i < adev->firmware.max_ucodes; i++) {
466                 ucode = &adev->firmware.ucode[i];
467                 if (ucode->fw) {
468                         ucode->mc_addr = 0;
469                         ucode->kaddr = NULL;
470                 }
471         }
472         amdgpu_bo_unref(&adev->firmware.fw_buf);
473         adev->firmware.fw_buf = NULL;
474
475         return 0;
476 }