Commit abf30f23 authored by Michal Wajdeczko's avatar Michal Wajdeczko Committed by Chris Wilson
Browse files

drm/i915/uc: Move uc firmware layout definitions to dedicated file 



Generic uc firmware layout definitions are unlikely to change and
are separate to other GuC specific definitions.

v2: reordered

Signed-off-by: default avatarMichal Wajdeczko <michal.wajdeczko@intel.com>
Cc: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com>
Reviewed-by: default avatarDaniele Ceraolo Spurio <daniele.ceraolospurio@intel.com>
Signed-off-by: default avatarChris Wilson <chris@chris-wilson.co.uk>
Link: https://patchwork.freedesktop.org/patch/msgid/20190725141308.24660-3-michal.wajdeczko@intel.com
parent 199ddded

Documentation/gpu/i915.rst

+1 −1
Original line number Diff line number Diff line
@@ -433,7 +433,7 @@ GuC 
Firmware Layout

-------------------



.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h

.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h

   :doc: Firmware Layout



GuC-specific firmware loader

drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h

+0 −67
Original line number Diff line number Diff line
@@ -121,73 +121,6 @@ 


#define GUC_CTL_MAX_DWORDS		(SOFT_SCRATCH_COUNT - 2) /* [1..14] */



/**

 * DOC: Firmware Layout

 *

 * The GuC/HuC firmware layout looks like this::

 *

 *      +======================================================================+

 *      |  Firmware blob                                                       |

 *      +===============+===============+============+============+============+

 *      |  CSS header   |     uCode     |  RSA key   |  modulus   |  exponent  |

 *      +===============+===============+============+============+============+

 *       <-header size->                 <---header size continued ----------->

 *       <--- size ----------------------------------------------------------->

 *                                       <-key size->

 *                                                    <-mod size->

 *                                                                 <-exp size->

 *

 * The firmware may or may not have modulus key and exponent data. The header,

 * uCode and RSA signature are must-have components that will be used by driver.

 * Length of each components, which is all in dwords, can be found in header.

 * In the case that modulus and exponent are not present in fw, a.k.a truncated

 * image, the length value still appears in header.

 *

 * Driver will do some basic fw size validation based on the following rules:

 *

 * 1. Header, uCode and RSA are must-have components.

 * 2. All firmware components, if they present, are in the sequence illustrated

 *    in the layout table above.

 * 3. Length info of each component can be found in header, in dwords.

 * 4. Modulus and exponent key are not required by driver. They may not appear

 *    in fw. So driver will load a truncated firmware in this case.

 *

 * The only difference between GuC and HuC firmwares is how the version

 * information is saved.

 */



struct uc_css_header {

	u32 module_type;

	/* header_size includes all non-uCode bits, including css_header, rsa

	 * key, modulus key and exponent data. */

	u32 header_size_dw;

	u32 header_version;

	u32 module_id;

	u32 module_vendor;

	u32 date;

#define CSS_DATE_DAY			(0xFF << 0)

#define CSS_DATE_MONTH			(0xFF << 8)

#define CSS_DATE_YEAR			(0xFFFF << 16)

	u32 size_dw; /* uCode plus header_size_dw */

	u32 key_size_dw;

	u32 modulus_size_dw;

	u32 exponent_size_dw;

	u32 time;

#define CSS_TIME_HOUR			(0xFF << 0)

#define CSS_DATE_MIN			(0xFF << 8)

#define CSS_DATE_SEC			(0xFFFF << 16)

	char username[8];

	char buildnumber[12];

	u32 sw_version;

#define CSS_SW_VERSION_GUC_MAJOR	(0xFF << 16)

#define CSS_SW_VERSION_GUC_MINOR	(0xFF << 8)

#define CSS_SW_VERSION_GUC_PATCH	(0xFF << 0)

#define CSS_SW_VERSION_HUC_MAJOR	(0xFFFF << 16)

#define CSS_SW_VERSION_HUC_MINOR	(0xFFFF << 0)

	u32 reserved[14];

	u32 header_info;

} __packed;



/* Work item for submitting workloads into work queue of GuC. */

struct guc_wq_item {

	u32 header;

drivers/gpu/drm/i915/gt/uc/intel_uc_fw.c

+1 −0
Original line number Diff line number Diff line
@@ -27,6 +27,7 @@ 
#include <drm/drm_print.h>



#include "intel_uc_fw.h"

#include "intel_uc_fw_abi.h"

#include "i915_drv.h"



/*

drivers/gpu/drm/i915/gt/uc/intel_uc_fw_abi.h

0 → 100644
+80 −0
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: MIT */

/*

 * Copyright © 2019 Intel Corporation

 */



#ifndef _INTEL_UC_FW_ABI_H

#define _INTEL_UC_FW_ABI_H



#include <linux/types.h>



/**

 * DOC: Firmware Layout

 *

 * The GuC/HuC firmware layout looks like this::

 *

 *      +======================================================================+

 *      |  Firmware blob                                                       |

 *      +===============+===============+============+============+============+

 *      |  CSS header   |     uCode     |  RSA key   |  modulus   |  exponent  |

 *      +===============+===============+============+============+============+

 *       <-header size->                 <---header size continued ----------->

 *       <--- size ----------------------------------------------------------->

 *                                       <-key size->

 *                                                    <-mod size->

 *                                                                 <-exp size->

 *

 * The firmware may or may not have modulus key and exponent data. The header,

 * uCode and RSA signature are must-have components that will be used by driver.

 * Length of each components, which is all in dwords, can be found in header.

 * In the case that modulus and exponent are not present in fw, a.k.a truncated

 * image, the length value still appears in header.

 *

 * Driver will do some basic fw size validation based on the following rules:

 *

 * 1. Header, uCode and RSA are must-have components.

 * 2. All firmware components, if they present, are in the sequence illustrated

 *    in the layout table above.

 * 3. Length info of each component can be found in header, in dwords.

 * 4. Modulus and exponent key are not required by driver. They may not appear

 *    in fw. So driver will load a truncated firmware in this case.

 *

 * The only difference between GuC and HuC firmwares is how the version

 * information is saved.

 */



struct uc_css_header {

	u32 module_type;

	/*

	 * header_size includes all non-uCode bits, including css_header, rsa

	 * key, modulus key and exponent data.

	 */

	u32 header_size_dw;

	u32 header_version;

	u32 module_id;

	u32 module_vendor;

	u32 date;

#define CSS_DATE_DAY			(0xFF << 0)

#define CSS_DATE_MONTH			(0xFF << 8)

#define CSS_DATE_YEAR			(0xFFFF << 16)

	u32 size_dw; /* uCode plus header_size_dw */

	u32 key_size_dw;

	u32 modulus_size_dw;

	u32 exponent_size_dw;

	u32 time;

#define CSS_TIME_HOUR			(0xFF << 0)

#define CSS_DATE_MIN			(0xFF << 8)

#define CSS_DATE_SEC			(0xFFFF << 16)

	char username[8];

	char buildnumber[12];

	u32 sw_version;

#define CSS_SW_VERSION_GUC_MAJOR	(0xFF << 16)

#define CSS_SW_VERSION_GUC_MINOR	(0xFF << 8)

#define CSS_SW_VERSION_GUC_PATCH	(0xFF << 0)

#define CSS_SW_VERSION_HUC_MAJOR	(0xFFFF << 16)

#define CSS_SW_VERSION_HUC_MINOR	(0xFFFF << 0)

	u32 reserved[14];

	u32 header_info;

} __packed;



#endif /* _INTEL_UC_FW_ABI_H */