Linux Audio

Check our new training course

Embedded Linux training

Mar 31-Apr 8, 2025
Register
Loading...
Note: File does not exist in v3.1.
  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
 31static 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
 46void 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
 67void 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
 85void 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
106void 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
171void 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
200int amdgpu_ucode_validate(const struct firmware *fw)
201{
202	const struct common_firmware_header *hdr =
203		(const struct common_firmware_header *)fw->data;
204
205	if (fw->size == le32_to_cpu(hdr->size_bytes))
206		return 0;
207
208	return -EINVAL;
209}
210
211bool amdgpu_ucode_hdr_version(union amdgpu_firmware_header *hdr,
212				uint16_t hdr_major, uint16_t hdr_minor)
213{
214	if ((hdr->common.header_version_major == hdr_major) &&
215		(hdr->common.header_version_minor == hdr_minor))
216		return false;
217	return true;
218}
219
220static int amdgpu_ucode_init_single_fw(struct amdgpu_firmware_info *ucode,
221				uint64_t mc_addr, void *kptr)
222{
223	const struct common_firmware_header *header = NULL;
224
225	if (NULL == ucode->fw)
226		return 0;
227
228	ucode->mc_addr = mc_addr;
229	ucode->kaddr = kptr;
230
231	header = (const struct common_firmware_header *)ucode->fw->data;
232	memcpy(ucode->kaddr, (void *)((uint8_t *)ucode->fw->data +
233		le32_to_cpu(header->ucode_array_offset_bytes)),
234		le32_to_cpu(header->ucode_size_bytes));
235
236	return 0;
237}
238
239int amdgpu_ucode_init_bo(struct amdgpu_device *adev)
240{
241	struct amdgpu_bo **bo = &adev->firmware.fw_buf;
242	uint64_t fw_mc_addr;
243	void *fw_buf_ptr = NULL;
244	uint64_t fw_offset = 0;
245	int i, err;
246	struct amdgpu_firmware_info *ucode = NULL;
247	const struct common_firmware_header *header = NULL;
248
249	err = amdgpu_bo_create(adev, adev->firmware.fw_size, PAGE_SIZE, true,
250			AMDGPU_GEM_DOMAIN_GTT, 0, NULL, NULL, bo);
251	if (err) {
252		dev_err(adev->dev, "(%d) Firmware buffer allocate failed\n", err);
253		err = -ENOMEM;
254		goto failed;
255	}
256
257	err = amdgpu_bo_reserve(*bo, false);
258	if (err) {
259		amdgpu_bo_unref(bo);
260		dev_err(adev->dev, "(%d) Firmware buffer reserve failed\n", err);
261		goto failed;
262	}
263
264	err = amdgpu_bo_pin(*bo, AMDGPU_GEM_DOMAIN_GTT, &fw_mc_addr);
265	if (err) {
266		amdgpu_bo_unreserve(*bo);
267		amdgpu_bo_unref(bo);
268		dev_err(adev->dev, "(%d) Firmware buffer pin failed\n", err);
269		goto failed;
270	}
271
272	err = amdgpu_bo_kmap(*bo, &fw_buf_ptr);
273	if (err) {
274		dev_err(adev->dev, "(%d) Firmware buffer kmap failed\n", err);
275		amdgpu_bo_unpin(*bo);
276		amdgpu_bo_unreserve(*bo);
277		amdgpu_bo_unref(bo);
278		goto failed;
279	}
280
281	amdgpu_bo_unreserve(*bo);
282
283	fw_offset = 0;
284	for (i = 0; i < AMDGPU_UCODE_ID_MAXIMUM; i++) {
285		ucode = &adev->firmware.ucode[i];
286		if (ucode->fw) {
287			header = (const struct common_firmware_header *)ucode->fw->data;
288			amdgpu_ucode_init_single_fw(ucode, fw_mc_addr + fw_offset,
289						    fw_buf_ptr + fw_offset);
290			fw_offset += ALIGN(le32_to_cpu(header->ucode_size_bytes), PAGE_SIZE);
291		}
292	}
293
294failed:
295	if (err)
296		adev->firmware.smu_load = false;
297
298	return err;
299}
300
301int amdgpu_ucode_fini_bo(struct amdgpu_device *adev)
302{
303	int i;
304	struct amdgpu_firmware_info *ucode = NULL;
305
306	for (i = 0; i < AMDGPU_UCODE_ID_MAXIMUM; i++) {
307		ucode = &adev->firmware.ucode[i];
308		if (ucode->fw) {
309			ucode->mc_addr = 0;
310			ucode->kaddr = NULL;
311		}
312	}
313	amdgpu_bo_unref(&adev->firmware.fw_buf);
314	adev->firmware.fw_buf = NULL;
315
316	return 0;
317}