[linux-2.6-block.git] / drivers / gpu / drm / amd / amdgpu / amdgpu_ucode.c

/*
 * Copyright 2014 Advanced Micro Devices, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 */

#include <linux/firmware.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <drm/drmP.h>
#include "amdgpu.h"
#include "amdgpu_ucode.h"

static void amdgpu_ucode_print_common_hdr(const struct common_firmware_header *hdr)
{
	DRM_DEBUG("size_bytes: %u\n", le32_to_cpu(hdr->size_bytes));
	DRM_DEBUG("header_size_bytes: %u\n", le32_to_cpu(hdr->header_size_bytes));
	DRM_DEBUG("header_version_major: %u\n", le16_to_cpu(hdr->header_version_major));
	DRM_DEBUG("header_version_minor: %u\n", le16_to_cpu(hdr->header_version_minor));
	DRM_DEBUG("ip_version_major: %u\n", le16_to_cpu(hdr->ip_version_major));
	DRM_DEBUG("ip_version_minor: %u\n", le16_to_cpu(hdr->ip_version_minor));
	DRM_DEBUG("ucode_version: 0x%08x\n", le32_to_cpu(hdr->ucode_version));
	DRM_DEBUG("ucode_size_bytes: %u\n", le32_to_cpu(hdr->ucode_size_bytes));
	DRM_DEBUG("ucode_array_offset_bytes: %u\n",
		  le32_to_cpu(hdr->ucode_array_offset_bytes));
	DRM_DEBUG("crc32: 0x%08x\n", le32_to_cpu(hdr->crc32));
}

void amdgpu_ucode_print_mc_hdr(const struct common_firmware_header *hdr)
{
	uint16_t version_major = le16_to_cpu(hdr->header_version_major);
	uint16_t version_minor = le16_to_cpu(hdr->header_version_minor);

	DRM_DEBUG("MC\n");
	amdgpu_ucode_print_common_hdr(hdr);

	if (version_major == 1) {
		const struct mc_firmware_header_v1_0 *mc_hdr =
			container_of(hdr, struct mc_firmware_header_v1_0, header);

		DRM_DEBUG("io_debug_size_bytes: %u\n",
			  le32_to_cpu(mc_hdr->io_debug_size_bytes));
		DRM_DEBUG("io_debug_array_offset_bytes: %u\n",
			  le32_to_cpu(mc_hdr->io_debug_array_offset_bytes));
	} else {
		DRM_ERROR("Unknown MC ucode version: %u.%u\n", version_major, version_minor);
	}
}

void amdgpu_ucode_print_smc_hdr(const struct common_firmware_header *hdr)
{
	uint16_t version_major = le16_to_cpu(hdr->header_version_major);
	uint16_t version_minor = le16_to_cpu(hdr->header_version_minor);

	DRM_DEBUG("SMC\n");
	amdgpu_ucode_print_common_hdr(hdr);

	if (version_major == 1) {
		const struct smc_firmware_header_v1_0 *smc_hdr =
			container_of(hdr, struct smc_firmware_header_v1_0, header);

		DRM_DEBUG("ucode_start_addr: %u\n", le32_to_cpu(smc_hdr->ucode_start_addr));
	} else {
		DRM_ERROR("Unknown SMC ucode version: %u.%u\n", version_major, version_minor);
	}
}

void amdgpu_ucode_print_gfx_hdr(const struct common_firmware_header *hdr)
{
	uint16_t version_major = le16_to_cpu(hdr->header_version_major);
	uint16_t version_minor = le16_to_cpu(hdr->header_version_minor);

	DRM_DEBUG("GFX\n");
	amdgpu_ucode_print_common_hdr(hdr);

	if (version_major == 1) {
		const struct gfx_firmware_header_v1_0 *gfx_hdr =
			container_of(hdr, struct gfx_firmware_header_v1_0, header);

		DRM_DEBUG("ucode_feature_version: %u\n",
			  le32_to_cpu(gfx_hdr->ucode_feature_version));
		DRM_DEBUG("jt_offset: %u\n", le32_to_cpu(gfx_hdr->jt_offset));
		DRM_DEBUG("jt_size: %u\n", le32_to_cpu(gfx_hdr->jt_size));
	} else {
		DRM_ERROR("Unknown GFX ucode version: %u.%u\n", version_major, version_minor);
	}
}

void amdgpu_ucode_print_rlc_hdr(const struct common_firmware_header *hdr)
{
	uint16_t version_major = le16_to_cpu(hdr->header_version_major);
	uint16_t version_minor = le16_to_cpu(hdr->header_version_minor);

	DRM_DEBUG("RLC\n");
	amdgpu_ucode_print_common_hdr(hdr);

	if (version_major == 1) {
		const struct rlc_firmware_header_v1_0 *rlc_hdr =
			container_of(hdr, struct rlc_firmware_header_v1_0, header);

		DRM_DEBUG("ucode_feature_version: %u\n",
			  le32_to_cpu(rlc_hdr->ucode_feature_version));
		DRM_DEBUG("save_and_restore_offset: %u\n",
			  le32_to_cpu(rlc_hdr->save_and_restore_offset));
		DRM_DEBUG("clear_state_descriptor_offset: %u\n",
			  le32_to_cpu(rlc_hdr->clear_state_descriptor_offset));
		DRM_DEBUG("avail_scratch_ram_locations: %u\n",
			  le32_to_cpu(rlc_hdr->avail_scratch_ram_locations));
		DRM_DEBUG("master_pkt_description_offset: %u\n",
			  le32_to_cpu(rlc_hdr->master_pkt_description_offset));
	} else if (version_major == 2) {
		const struct rlc_firmware_header_v2_0 *rlc_hdr =
			container_of(hdr, struct rlc_firmware_header_v2_0, header);

		DRM_DEBUG("ucode_feature_version: %u\n",
			  le32_to_cpu(rlc_hdr->ucode_feature_version));
		DRM_DEBUG("jt_offset: %u\n", le32_to_cpu(rlc_hdr->jt_offset));
		DRM_DEBUG("jt_size: %u\n", le32_to_cpu(rlc_hdr->jt_size));
		DRM_DEBUG("save_and_restore_offset: %u\n",
			  le32_to_cpu(rlc_hdr->save_and_restore_offset));
		DRM_DEBUG("clear_state_descriptor_offset: %u\n",
			  le32_to_cpu(rlc_hdr->clear_state_descriptor_offset));
		DRM_DEBUG("avail_scratch_ram_locations: %u\n",
			  le32_to_cpu(rlc_hdr->avail_scratch_ram_locations));
		DRM_DEBUG("reg_restore_list_size: %u\n",
			  le32_to_cpu(rlc_hdr->reg_restore_list_size));
		DRM_DEBUG("reg_list_format_start: %u\n",
			  le32_to_cpu(rlc_hdr->reg_list_format_start));
		DRM_DEBUG("reg_list_format_separate_start: %u\n",
			  le32_to_cpu(rlc_hdr->reg_list_format_separate_start));
		DRM_DEBUG("starting_offsets_start: %u\n",
			  le32_to_cpu(rlc_hdr->starting_offsets_start));
		DRM_DEBUG("reg_list_format_size_bytes: %u\n",
			  le32_to_cpu(rlc_hdr->reg_list_format_size_bytes));
		DRM_DEBUG("reg_list_format_array_offset_bytes: %u\n",
			  le32_to_cpu(rlc_hdr->reg_list_format_array_offset_bytes));
		DRM_DEBUG("reg_list_size_bytes: %u\n",
			  le32_to_cpu(rlc_hdr->reg_list_size_bytes));
		DRM_DEBUG("reg_list_array_offset_bytes: %u\n",
			  le32_to_cpu(rlc_hdr->reg_list_array_offset_bytes));
		DRM_DEBUG("reg_list_format_separate_size_bytes: %u\n",
			  le32_to_cpu(rlc_hdr->reg_list_format_separate_size_bytes));
		DRM_DEBUG("reg_list_format_separate_array_offset_bytes: %u\n",
			  le32_to_cpu(rlc_hdr->reg_list_format_separate_array_offset_bytes));
		DRM_DEBUG("reg_list_separate_size_bytes: %u\n",
			  le32_to_cpu(rlc_hdr->reg_list_separate_size_bytes));
		DRM_DEBUG("reg_list_separate_size_bytes: %u\n",
			  le32_to_cpu(rlc_hdr->reg_list_separate_size_bytes));
	} else {
		DRM_ERROR("Unknown RLC ucode version: %u.%u\n", version_major, version_minor);
	}
}

void amdgpu_ucode_print_sdma_hdr(const struct common_firmware_header *hdr)
{
	uint16_t version_major = le16_to_cpu(hdr->header_version_major);
	uint16_t version_minor = le16_to_cpu(hdr->header_version_minor);

	DRM_DEBUG("SDMA\n");
	amdgpu_ucode_print_common_hdr(hdr);

	if (version_major == 1) {
		const struct sdma_firmware_header_v1_0 *sdma_hdr =
			container_of(hdr, struct sdma_firmware_header_v1_0, header);

		DRM_DEBUG("ucode_feature_version: %u\n",
			  le32_to_cpu(sdma_hdr->ucode_feature_version));
		DRM_DEBUG("ucode_change_version: %u\n",
			  le32_to_cpu(sdma_hdr->ucode_change_version));
		DRM_DEBUG("jt_offset: %u\n", le32_to_cpu(sdma_hdr->jt_offset));
		DRM_DEBUG("jt_size: %u\n", le32_to_cpu(sdma_hdr->jt_size));
		if (version_minor >= 1) {
			const struct sdma_firmware_header_v1_1 *sdma_v1_1_hdr =
				container_of(sdma_hdr, struct sdma_firmware_header_v1_1, v1_0);
			DRM_DEBUG("digest_size: %u\n", le32_to_cpu(sdma_v1_1_hdr->digest_size));
		}
	} else {
		DRM_ERROR("Unknown SDMA ucode version: %u.%u\n",
			  version_major, version_minor);
	}
}

void amdgpu_ucode_print_gpu_info_hdr(const struct common_firmware_header *hdr)
{
	uint16_t version_major = le16_to_cpu(hdr->header_version_major);
	uint16_t version_minor = le16_to_cpu(hdr->header_version_minor);

	DRM_DEBUG("GPU_INFO\n");
	amdgpu_ucode_print_common_hdr(hdr);

	if (version_major == 1) {
		const struct gpu_info_firmware_header_v1_0 *gpu_info_hdr =
			container_of(hdr, struct gpu_info_firmware_header_v1_0, header);

		DRM_DEBUG("version_major: %u\n",
			  le16_to_cpu(gpu_info_hdr->version_major));
		DRM_DEBUG("version_minor: %u\n",
			  le16_to_cpu(gpu_info_hdr->version_minor));
	} else {
		DRM_ERROR("Unknown gpu_info ucode version: %u.%u\n", version_major, version_minor);
	}
}

int amdgpu_ucode_validate(const struct firmware *fw)
{
	const struct common_firmware_header *hdr =
		(const struct common_firmware_header *)fw->data;

	if (fw->size == le32_to_cpu(hdr->size_bytes))
		return 0;

	return -EINVAL;
}

bool amdgpu_ucode_hdr_version(union amdgpu_firmware_header *hdr,
				uint16_t hdr_major, uint16_t hdr_minor)
{
	if ((hdr->common.header_version_major == hdr_major) &&
		(hdr->common.header_version_minor == hdr_minor))
		return false;
	return true;
}

enum amdgpu_firmware_load_type
amdgpu_ucode_get_load_type(struct amdgpu_device *adev, int load_type)
{
	switch (adev->asic_type) {
#ifdef CONFIG_DRM_AMDGPU_SI
	case CHIP_TAHITI:
	case CHIP_PITCAIRN:
	case CHIP_VERDE:
	case CHIP_OLAND:
		return AMDGPU_FW_LOAD_DIRECT;
#endif
#ifdef CONFIG_DRM_AMDGPU_CIK
	case CHIP_BONAIRE:
	case CHIP_KAVERI:
	case CHIP_KABINI:
	case CHIP_HAWAII:
	case CHIP_MULLINS:
		return AMDGPU_FW_LOAD_DIRECT;
#endif
	case CHIP_TOPAZ:
	case CHIP_TONGA:
	case CHIP_FIJI:
	case CHIP_CARRIZO:
	case CHIP_STONEY:
	case CHIP_POLARIS10:
	case CHIP_POLARIS11:
	case CHIP_POLARIS12:
		if (!load_type)
			return AMDGPU_FW_LOAD_DIRECT;
		else
			return AMDGPU_FW_LOAD_SMU;
	case CHIP_VEGA10:
	case CHIP_RAVEN:
		if (!load_type)
			return AMDGPU_FW_LOAD_DIRECT;
		else
			return AMDGPU_FW_LOAD_PSP;
	default:
		DRM_ERROR("Unknow firmware load type\n");
	}

	return AMDGPU_FW_LOAD_DIRECT;
}

static int amdgpu_ucode_init_single_fw(struct amdgpu_device *adev,
				       struct amdgpu_firmware_info *ucode,
				       uint64_t mc_addr, void *kptr)
{
	const struct common_firmware_header *header = NULL;
	const struct gfx_firmware_header_v1_0 *cp_hdr = NULL;

	if (NULL == ucode->fw)
		return 0;

	ucode->mc_addr = mc_addr;
	ucode->kaddr = kptr;

	if (ucode->ucode_id == AMDGPU_UCODE_ID_STORAGE)
		return 0;

	header = (const struct common_firmware_header *)ucode->fw->data;

	cp_hdr = (const struct gfx_firmware_header_v1_0 *)ucode->fw->data;

	if (adev->firmware.load_type != AMDGPU_FW_LOAD_PSP ||
	    (ucode->ucode_id != AMDGPU_UCODE_ID_CP_MEC1 &&
	     ucode->ucode_id != AMDGPU_UCODE_ID_CP_MEC2 &&
	     ucode->ucode_id != AMDGPU_UCODE_ID_CP_MEC1_JT &&
	     ucode->ucode_id != AMDGPU_UCODE_ID_CP_MEC2_JT)) {
		ucode->ucode_size = le32_to_cpu(header->ucode_size_bytes);

		memcpy(ucode->kaddr, (void *)((uint8_t *)ucode->fw->data +
					      le32_to_cpu(header->ucode_array_offset_bytes)),
		       ucode->ucode_size);
	} else if (ucode->ucode_id == AMDGPU_UCODE_ID_CP_MEC1 ||
		   ucode->ucode_id == AMDGPU_UCODE_ID_CP_MEC2) {
		ucode->ucode_size = le32_to_cpu(header->ucode_size_bytes) -
			le32_to_cpu(cp_hdr->jt_size) * 4;

		memcpy(ucode->kaddr, (void *)((uint8_t *)ucode->fw->data +
					      le32_to_cpu(header->ucode_array_offset_bytes)),
		       ucode->ucode_size);
	} else if (ucode->ucode_id == AMDGPU_UCODE_ID_CP_MEC1_JT ||
		   ucode->ucode_id == AMDGPU_UCODE_ID_CP_MEC2_JT) {
		ucode->ucode_size = le32_to_cpu(cp_hdr->jt_size) * 4;

		memcpy(ucode->kaddr, (void *)((uint8_t *)ucode->fw->data +
					      le32_to_cpu(header->ucode_array_offset_bytes) +
					      le32_to_cpu(cp_hdr->jt_offset) * 4),
		       ucode->ucode_size);
	}

	return 0;
}

static int amdgpu_ucode_patch_jt(struct amdgpu_firmware_info *ucode,
				uint64_t mc_addr, void *kptr)
{
	const struct gfx_firmware_header_v1_0 *header = NULL;
	const struct common_firmware_header *comm_hdr = NULL;
	uint8_t* src_addr = NULL;
	uint8_t* dst_addr = NULL;

	if (NULL == ucode->fw)
		return 0;

	comm_hdr = (const struct common_firmware_header *)ucode->fw->data;
	header = (const struct gfx_firmware_header_v1_0 *)ucode->fw->data;
	dst_addr = ucode->kaddr +
			   ALIGN(le32_to_cpu(comm_hdr->ucode_size_bytes),
			   PAGE_SIZE);
	src_addr = (uint8_t *)ucode->fw->data +
			   le32_to_cpu(comm_hdr->ucode_array_offset_bytes) +
			   (le32_to_cpu(header->jt_offset) * 4);
	memcpy(dst_addr, src_addr, le32_to_cpu(header->jt_size) * 4);

	return 0;
}

int amdgpu_ucode_init_bo(struct amdgpu_device *adev)
{
	struct amdgpu_bo **bo = &adev->firmware.fw_buf;
	uint64_t fw_offset = 0;
	int i, err;
	struct amdgpu_firmware_info *ucode = NULL;
	const struct common_firmware_header *header = NULL;

	if (!adev->firmware.fw_size) {
		dev_warn(adev->dev, "No ip firmware need to load\n");
		return 0;
	}

	if (!amdgpu_sriov_vf(adev) || !adev->in_sriov_reset) {
		err = amdgpu_bo_create(adev, adev->firmware.fw_size, PAGE_SIZE, true,
					amdgpu_sriov_vf(adev) ? AMDGPU_GEM_DOMAIN_VRAM : AMDGPU_GEM_DOMAIN_GTT,
					AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS,
					NULL, NULL, 0, bo);
		if (err) {
			dev_err(adev->dev, "(%d) Firmware buffer allocate failed\n", err);
			goto failed;
		}

		err = amdgpu_bo_reserve(*bo, false);
		if (err) {
			dev_err(adev->dev, "(%d) Firmware buffer reserve failed\n", err);
			goto failed_reserve;
		}

		err = amdgpu_bo_pin(*bo, amdgpu_sriov_vf(adev) ? AMDGPU_GEM_DOMAIN_VRAM : AMDGPU_GEM_DOMAIN_GTT,
					&adev->firmware.fw_buf_mc);
		if (err) {
			dev_err(adev->dev, "(%d) Firmware buffer pin failed\n", err);
			goto failed_pin;
		}

		err = amdgpu_bo_kmap(*bo, &adev->firmware.fw_buf_ptr);
		if (err) {
			dev_err(adev->dev, "(%d) Firmware buffer kmap failed\n", err);
			goto failed_kmap;
		}

		amdgpu_bo_unreserve(*bo);
	}

	memset(adev->firmware.fw_buf_ptr, 0, adev->firmware.fw_size);

	/*
	 * if SMU loaded firmware, it needn't add SMC, UVD, and VCE
	 * ucode info here
	 */
	if (adev->firmware.load_type != AMDGPU_FW_LOAD_PSP) {
		if (amdgpu_sriov_vf(adev))
			adev->firmware.max_ucodes = AMDGPU_UCODE_ID_MAXIMUM - 3;
		else
			adev->firmware.max_ucodes = AMDGPU_UCODE_ID_MAXIMUM - 4;
	} else {
		adev->firmware.max_ucodes = AMDGPU_UCODE_ID_MAXIMUM;
	}

	for (i = 0; i < adev->firmware.max_ucodes; i++) {
		ucode = &adev->firmware.ucode[i];
		if (ucode->fw) {
			header = (const struct common_firmware_header *)ucode->fw->data;
			amdgpu_ucode_init_single_fw(adev, ucode, adev->firmware.fw_buf_mc + fw_offset,
						    adev->firmware.fw_buf_ptr + fw_offset);
			if (i == AMDGPU_UCODE_ID_CP_MEC1 &&
			    adev->firmware.load_type != AMDGPU_FW_LOAD_PSP) {
				const struct gfx_firmware_header_v1_0 *cp_hdr;
				cp_hdr = (const struct gfx_firmware_header_v1_0 *)ucode->fw->data;
				amdgpu_ucode_patch_jt(ucode,  adev->firmware.fw_buf_mc + fw_offset,
						    adev->firmware.fw_buf_ptr + fw_offset);
				fw_offset += ALIGN(le32_to_cpu(cp_hdr->jt_size) << 2, PAGE_SIZE);
			}
			fw_offset += ALIGN(ucode->ucode_size, PAGE_SIZE);
		}
	}
	return 0;

failed_kmap:
	amdgpu_bo_unpin(*bo);
failed_pin:
	amdgpu_bo_unreserve(*bo);
failed_reserve:
	amdgpu_bo_unref(bo);
failed:
	if (err)
		adev->firmware.load_type = AMDGPU_FW_LOAD_DIRECT;

	return err;
}

int amdgpu_ucode_fini_bo(struct amdgpu_device *adev)
{
	int i;
	struct amdgpu_firmware_info *ucode = NULL;

	if (!adev->firmware.fw_size)
		return 0;

	for (i = 0; i < adev->firmware.max_ucodes; i++) {
		ucode = &adev->firmware.ucode[i];
		if (ucode->fw) {
			ucode->mc_addr = 0;
			ucode->kaddr = NULL;
		}
	}
	amdgpu_bo_unref(&adev->firmware.fw_buf);
	adev->firmware.fw_buf = NULL;

	return 0;
}
Commit	Line	Data
d38ceaf9 AD	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
8ae1a336 AD	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
d38ceaf9 AD	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
e635ee07 HR	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	return AMDGPU_FW_LOAD_DIRECT;
	251	#endif
	252	#ifdef CONFIG_DRM_AMDGPU_CIK
	253	case CHIP_BONAIRE:
	254	case CHIP_KAVERI:
	255	case CHIP_KABINI:
	256	case CHIP_HAWAII:
	257	case CHIP_MULLINS:
	258	return AMDGPU_FW_LOAD_DIRECT;
	259	#endif
	260	case CHIP_TOPAZ:
	261	case CHIP_TONGA:
	262	case CHIP_FIJI:
	263	case CHIP_CARRIZO:
	264	case CHIP_STONEY:
	265	case CHIP_POLARIS10:
	266	case CHIP_POLARIS11:
	267	case CHIP_POLARIS12:
	268	if (!load_type)
	269	return AMDGPU_FW_LOAD_DIRECT;
	270	else
	271	return AMDGPU_FW_LOAD_SMU;
	272	case CHIP_VEGA10:
4456ef4e	273	case CHIP_RAVEN:
50811c71	274	if (!load_type)
4456ef4e CZ	275	return AMDGPU_FW_LOAD_DIRECT;
	276	else
	277	return AMDGPU_FW_LOAD_PSP;
e635ee07 HR	278	default:
	279	DRM_ERROR("Unknow firmware load type\n");
	280	}
	281
	282	return AMDGPU_FW_LOAD_DIRECT;
	283	}
	284
2445b227 HR	285	static int amdgpu_ucode_init_single_fw(struct amdgpu_device *adev,
	286	struct amdgpu_firmware_info *ucode,
	287	uint64_t mc_addr, void *kptr)
d38ceaf9 AD	288	{
d38ceaf9 AD	289	const struct common_firmware_header *header = NULL;
2445b227	290	const struct gfx_firmware_header_v1_0 *cp_hdr = NULL;
d38ceaf9 AD	291
	292	if (NULL == ucode->fw)
	293	return 0;
	294
	295	ucode->mc_addr = mc_addr;
	296	ucode->kaddr = kptr;
	297
bed5712e ML	298	if (ucode->ucode_id == AMDGPU_UCODE_ID_STORAGE)
	299	return 0;
	300
d38ceaf9	301	header = (const struct common_firmware_header *)ucode->fw->data;
daf42c31	302
2445b227 HR	303	cp_hdr = (const struct gfx_firmware_header_v1_0 *)ucode->fw->data;
	304
	305	if (adev->firmware.load_type != AMDGPU_FW_LOAD_PSP \|\|
	306	(ucode->ucode_id != AMDGPU_UCODE_ID_CP_MEC1 &&
	307	ucode->ucode_id != AMDGPU_UCODE_ID_CP_MEC2 &&
	308	ucode->ucode_id != AMDGPU_UCODE_ID_CP_MEC1_JT &&
	309	ucode->ucode_id != AMDGPU_UCODE_ID_CP_MEC2_JT)) {
	310	ucode->ucode_size = le32_to_cpu(header->ucode_size_bytes);
	311
	312	memcpy(ucode->kaddr, (void )((uint8_t )ucode->fw->data +
	313	le32_to_cpu(header->ucode_array_offset_bytes)),
	314	ucode->ucode_size);
	315	} else if (ucode->ucode_id == AMDGPU_UCODE_ID_CP_MEC1 \|\|
	316	ucode->ucode_id == AMDGPU_UCODE_ID_CP_MEC2) {
	317	ucode->ucode_size = le32_to_cpu(header->ucode_size_bytes) -
	318	le32_to_cpu(cp_hdr->jt_size) * 4;
	319
	320	memcpy(ucode->kaddr, (void )((uint8_t )ucode->fw->data +
	321	le32_to_cpu(header->ucode_array_offset_bytes)),
	322	ucode->ucode_size);
	323	} else if (ucode->ucode_id == AMDGPU_UCODE_ID_CP_MEC1_JT \|\|
	324	ucode->ucode_id == AMDGPU_UCODE_ID_CP_MEC2_JT) {
	325	ucode->ucode_size = le32_to_cpu(cp_hdr->jt_size) * 4;
	326
	327	memcpy(ucode->kaddr, (void )((uint8_t )ucode->fw->data +
	328	le32_to_cpu(header->ucode_array_offset_bytes) +
	329	le32_to_cpu(cp_hdr->jt_offset) * 4),
	330	ucode->ucode_size);
	331	}
d38ceaf9 AD	332
	333	return 0;
	334	}
	335
4c2b2453 ML	336	static int amdgpu_ucode_patch_jt(struct amdgpu_firmware_info *ucode,
	337	uint64_t mc_addr, void *kptr)
	338	{
	339	const struct gfx_firmware_header_v1_0 *header = NULL;
	340	const struct common_firmware_header *comm_hdr = NULL;
	341	uint8_t* src_addr = NULL;
	342	uint8_t* dst_addr = NULL;
	343
	344	if (NULL == ucode->fw)
	345	return 0;
	346
	347	comm_hdr = (const struct common_firmware_header *)ucode->fw->data;
	348	header = (const struct gfx_firmware_header_v1_0 *)ucode->fw->data;
	349	dst_addr = ucode->kaddr +
	350	ALIGN(le32_to_cpu(comm_hdr->ucode_size_bytes),
	351	PAGE_SIZE);
	352	src_addr = (uint8_t *)ucode->fw->data +
	353	le32_to_cpu(comm_hdr->ucode_array_offset_bytes) +
	354	(le32_to_cpu(header->jt_offset) * 4);
	355	memcpy(dst_addr, src_addr, le32_to_cpu(header->jt_size) * 4);
	356
	357	return 0;
	358	}
	359
d38ceaf9 AD	360	int amdgpu_ucode_init_bo(struct amdgpu_device *adev)
	361	{
	362	struct amdgpu_bo **bo = &adev->firmware.fw_buf;
d38ceaf9	363	uint64_t fw_offset = 0;
2445b227	364	int i, err;
d38ceaf9 AD	365	struct amdgpu_firmware_info *ucode = NULL;
	366	const struct common_firmware_header *header = NULL;
	367
7504938f HR	368	if (!adev->firmware.fw_size) {
	369	dev_warn(adev->dev, "No ip firmware need to load\n");
	370	return 0;
	371	}
	372
d59c026b ML	373	if (!amdgpu_sriov_vf(adev) \|\| !adev->in_sriov_reset) {
	374	err = amdgpu_bo_create(adev, adev->firmware.fw_size, PAGE_SIZE, true,
	375	amdgpu_sriov_vf(adev) ? AMDGPU_GEM_DOMAIN_VRAM : AMDGPU_GEM_DOMAIN_GTT,
	376	AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS,
	377	NULL, NULL, 0, bo);
	378	if (err) {
	379	dev_err(adev->dev, "(%d) Firmware buffer allocate failed\n", err);
	380	goto failed;
	381	}
d38ceaf9	382
d59c026b ML	383	err = amdgpu_bo_reserve(*bo, false);
	384	if (err) {
	385	dev_err(adev->dev, "(%d) Firmware buffer reserve failed\n", err);
	386	goto failed_reserve;
	387	}
d38ceaf9	388
d59c026b ML	389	err = amdgpu_bo_pin(*bo, amdgpu_sriov_vf(adev) ? AMDGPU_GEM_DOMAIN_VRAM : AMDGPU_GEM_DOMAIN_GTT,
	390	&adev->firmware.fw_buf_mc);
	391	if (err) {
	392	dev_err(adev->dev, "(%d) Firmware buffer pin failed\n", err);
	393	goto failed_pin;
	394	}
d38ceaf9	395
d59c026b ML	396	err = amdgpu_bo_kmap(*bo, &adev->firmware.fw_buf_ptr);
	397	if (err) {
	398	dev_err(adev->dev, "(%d) Firmware buffer kmap failed\n", err);
	399	goto failed_kmap;
	400	}
d38ceaf9	401
d59c026b ML	402	amdgpu_bo_unreserve(*bo);
d59c026b ML	403	}
d38ceaf9	404
d59c026b	405	memset(adev->firmware.fw_buf_ptr, 0, adev->firmware.fw_size);
2445b227	406
e635ee07 HR	407	/*
	408	* if SMU loaded firmware, it needn't add SMC, UVD, and VCE
	409	* ucode info here
	410	*/
bc108ec7 TH	411	if (adev->firmware.load_type != AMDGPU_FW_LOAD_PSP) {
	412	if (amdgpu_sriov_vf(adev))
	413	adev->firmware.max_ucodes = AMDGPU_UCODE_ID_MAXIMUM - 3;
	414	else
	415	adev->firmware.max_ucodes = AMDGPU_UCODE_ID_MAXIMUM - 4;
	416	} else {
2445b227	417	adev->firmware.max_ucodes = AMDGPU_UCODE_ID_MAXIMUM;
bc108ec7	418	}
e635ee07	419
2445b227	420	for (i = 0; i < adev->firmware.max_ucodes; i++) {
d38ceaf9 AD	421	ucode = &adev->firmware.ucode[i];
	422	if (ucode->fw) {
	423	header = (const struct common_firmware_header *)ucode->fw->data;
d59c026b ML	424	amdgpu_ucode_init_single_fw(adev, ucode, adev->firmware.fw_buf_mc + fw_offset,
d59c026b ML	425	adev->firmware.fw_buf_ptr + fw_offset);
2445b227 HR	426	if (i == AMDGPU_UCODE_ID_CP_MEC1 &&
2445b227 HR	427	adev->firmware.load_type != AMDGPU_FW_LOAD_PSP) {
4c2b2453 ML	428	const struct gfx_firmware_header_v1_0 *cp_hdr;
4c2b2453 ML	429	cp_hdr = (const struct gfx_firmware_header_v1_0 *)ucode->fw->data;
d59c026b ML	430	amdgpu_ucode_patch_jt(ucode, adev->firmware.fw_buf_mc + fw_offset,
d59c026b ML	431	adev->firmware.fw_buf_ptr + fw_offset);
4c2b2453 ML	432	fw_offset += ALIGN(le32_to_cpu(cp_hdr->jt_size) << 2, PAGE_SIZE);
4c2b2453 ML	433	}
2445b227	434	fw_offset += ALIGN(ucode->ucode_size, PAGE_SIZE);
d38ceaf9 AD	435	}
d38ceaf9 AD	436	}
fd506558	437	return 0;
d38ceaf9	438
fd506558 HR	439	failed_kmap:
	440	amdgpu_bo_unpin(*bo);
	441	failed_pin:
	442	amdgpu_bo_unreserve(*bo);
	443	failed_reserve:
	444	amdgpu_bo_unref(bo);
d38ceaf9	445	failed:
e635ee07 HR	446	if (err)
e635ee07 HR	447	adev->firmware.load_type = AMDGPU_FW_LOAD_DIRECT;
d38ceaf9 AD	448
	449	return err;
	450	}
	451
	452	int amdgpu_ucode_fini_bo(struct amdgpu_device *adev)
	453	{
	454	int i;
	455	struct amdgpu_firmware_info *ucode = NULL;
	456
7504938f HR	457	if (!adev->firmware.fw_size)
	458	return 0;
	459
2445b227	460	for (i = 0; i < adev->firmware.max_ucodes; i++) {
d38ceaf9 AD	461	ucode = &adev->firmware.ucode[i];
	462	if (ucode->fw) {
	463	ucode->mc_addr = 0;
	464	ucode->kaddr = NULL;
	465	}
	466	}
	467	amdgpu_bo_unref(&adev->firmware.fw_buf);
	468	adev->firmware.fw_buf = NULL;
	469
	470	return 0;
	471	}