[linux-2.6-block.git] / drivers / gpu / drm / i915 / intel_uc_fw.h

/*
 * Copyright © 2014-2017 Intel Corporation
 *
 * 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 (including the next
 * paragraph) 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 AUTHORS OR COPYRIGHT HOLDERS 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.
 *
 */

#ifndef _INTEL_UC_FW_H_
#define _INTEL_UC_FW_H_

struct drm_printer;
struct drm_i915_private;
struct i915_vma;

/* Home of GuC, HuC and DMC firmwares */
#define INTEL_UC_FIRMWARE_URL "https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/i915"

enum intel_uc_fw_status {
	INTEL_UC_FIRMWARE_FAIL = -1,
	INTEL_UC_FIRMWARE_NONE = 0,
	INTEL_UC_FIRMWARE_PENDING,
	INTEL_UC_FIRMWARE_SUCCESS
};

enum intel_uc_fw_type {
	INTEL_UC_FW_TYPE_GUC,
	INTEL_UC_FW_TYPE_HUC
};

/*
 * This structure encapsulates all the data needed during the process
 * of fetching, caching, and loading the firmware image into the uC.
 */
struct intel_uc_fw {
	const char *path;
	size_t size;
	struct drm_i915_gem_object *obj;
	enum intel_uc_fw_status fetch_status;
	enum intel_uc_fw_status load_status;

	/*
	 * The firmware build process will generate a version header file with major and
	 * minor version defined. The versions are built into CSS header of firmware.
	 * i915 kernel driver set the minimal firmware version required per platform.
	 */
	u16 major_ver_wanted;
	u16 minor_ver_wanted;
	u16 major_ver_found;
	u16 minor_ver_found;

	enum intel_uc_fw_type type;
	u32 header_size;
	u32 header_offset;
	u32 rsa_size;
	u32 rsa_offset;
	u32 ucode_size;
	u32 ucode_offset;
};

static inline
const char *intel_uc_fw_status_repr(enum intel_uc_fw_status status)
{
	switch (status) {
	case INTEL_UC_FIRMWARE_FAIL:
		return "FAIL";
	case INTEL_UC_FIRMWARE_NONE:
		return "NONE";
	case INTEL_UC_FIRMWARE_PENDING:
		return "PENDING";
	case INTEL_UC_FIRMWARE_SUCCESS:
		return "SUCCESS";
	}
	return "<invalid>";
}

static inline const char *intel_uc_fw_type_repr(enum intel_uc_fw_type type)
{
	switch (type) {
	case INTEL_UC_FW_TYPE_GUC:
		return "GuC";
	case INTEL_UC_FW_TYPE_HUC:
		return "HuC";
	}
	return "uC";
}

static inline
void intel_uc_fw_init(struct intel_uc_fw *uc_fw, enum intel_uc_fw_type type)
{
	uc_fw->path = NULL;
	uc_fw->fetch_status = INTEL_UC_FIRMWARE_NONE;
	uc_fw->load_status = INTEL_UC_FIRMWARE_NONE;
	uc_fw->type = type;
}

static inline bool intel_uc_fw_is_selected(struct intel_uc_fw *uc_fw)
{
	return uc_fw->path != NULL;
}

static inline void intel_uc_fw_sanitize(struct intel_uc_fw *uc_fw)
{
	if (uc_fw->load_status == INTEL_UC_FIRMWARE_SUCCESS)
		uc_fw->load_status = INTEL_UC_FIRMWARE_PENDING;
}

/**
 * intel_uc_fw_get_upload_size() - Get size of firmware needed to be uploaded.
 * @uc_fw: uC firmware.
 *
 * Get the size of the firmware and header that will be uploaded to WOPCM.
 *
 * Return: Upload firmware size, or zero on firmware fetch failure.
 */
static inline u32 intel_uc_fw_get_upload_size(struct intel_uc_fw *uc_fw)
{
	if (uc_fw->fetch_status != INTEL_UC_FIRMWARE_SUCCESS)
		return 0;

	return uc_fw->header_size + uc_fw->ucode_size;
}

void intel_uc_fw_fetch(struct drm_i915_private *dev_priv,
		       struct intel_uc_fw *uc_fw);
int intel_uc_fw_upload(struct intel_uc_fw *uc_fw,
		       int (*xfer)(struct intel_uc_fw *uc_fw,
				   struct i915_vma *vma));
void intel_uc_fw_fini(struct intel_uc_fw *uc_fw);
void intel_uc_fw_dump(const struct intel_uc_fw *uc_fw, struct drm_printer *p);

#endif
Commit	Line	Data
a16b4313 MW	1	/*
	2	* Copyright © 2014-2017 Intel Corporation
	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 (including the next
	12	* paragraph) shall be included in all copies or substantial portions of the
	13	* Software.
	14	*
	15	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	16	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	17	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	18	* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	19	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
	20	* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
	21	* IN THE SOFTWARE.
	22	*
	23	*/
	24
	25	#ifndef _INTEL_UC_FW_H_
	26	#define _INTEL_UC_FW_H_
	27
56ffc742	28	struct drm_printer;
a16b4313	29	struct drm_i915_private;
4502e9ec	30	struct i915_vma;
a16b4313	31
f1e86cec	32	/* Home of GuC, HuC and DMC firmwares */
81cf8b74	33	#define INTEL_UC_FIRMWARE_URL "https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/i915"
1e913d27	34
a16b4313 MW	35	enum intel_uc_fw_status {
	36	INTEL_UC_FIRMWARE_FAIL = -1,
	37	INTEL_UC_FIRMWARE_NONE = 0,
	38	INTEL_UC_FIRMWARE_PENDING,
	39	INTEL_UC_FIRMWARE_SUCCESS
	40	};
	41
	42	enum intel_uc_fw_type {
	43	INTEL_UC_FW_TYPE_GUC,
	44	INTEL_UC_FW_TYPE_HUC
	45	};
	46
	47	/*
	48	* This structure encapsulates all the data needed during the process
	49	* of fetching, caching, and loading the firmware image into the uC.
	50	*/
	51	struct intel_uc_fw {
	52	const char *path;
	53	size_t size;
	54	struct drm_i915_gem_object *obj;
	55	enum intel_uc_fw_status fetch_status;
	56	enum intel_uc_fw_status load_status;
	57
d9e2e014 MW	58	/*
	59	* The firmware build process will generate a version header file with major and
	60	* minor version defined. The versions are built into CSS header of firmware.
	61	* i915 kernel driver set the minimal firmware version required per platform.
	62	*/
faf65486 JL	63	u16 major_ver_wanted;
	64	u16 minor_ver_wanted;
	65	u16 major_ver_found;
	66	u16 minor_ver_found;
a16b4313 MW	67
a16b4313 MW	68	enum intel_uc_fw_type type;
faf65486 JL	69	u32 header_size;
	70	u32 header_offset;
	71	u32 rsa_size;
	72	u32 rsa_offset;
	73	u32 ucode_size;
	74	u32 ucode_offset;
a16b4313 MW	75	};
	76
	77	static inline
	78	const char *intel_uc_fw_status_repr(enum intel_uc_fw_status status)
	79	{
	80	switch (status) {
	81	case INTEL_UC_FIRMWARE_FAIL:
	82	return "FAIL";
	83	case INTEL_UC_FIRMWARE_NONE:
	84	return "NONE";
	85	case INTEL_UC_FIRMWARE_PENDING:
	86	return "PENDING";
	87	case INTEL_UC_FIRMWARE_SUCCESS:
	88	return "SUCCESS";
	89	}
	90	return "<invalid>";
	91	}
	92
	93	static inline const char *intel_uc_fw_type_repr(enum intel_uc_fw_type type)
	94	{
	95	switch (type) {
	96	case INTEL_UC_FW_TYPE_GUC:
	97	return "GuC";
	98	case INTEL_UC_FW_TYPE_HUC:
	99	return "HuC";
	100	}
	101	return "uC";
	102	}
	103
959a3b6f MW	104	static inline
	105	void intel_uc_fw_init(struct intel_uc_fw *uc_fw, enum intel_uc_fw_type type)
	106	{
	107	uc_fw->path = NULL;
	108	uc_fw->fetch_status = INTEL_UC_FIRMWARE_NONE;
	109	uc_fw->load_status = INTEL_UC_FIRMWARE_NONE;
	110	uc_fw->type = type;
	111	}
	112
0dd940c8 MW	113	static inline bool intel_uc_fw_is_selected(struct intel_uc_fw *uc_fw)
	114	{
	115	return uc_fw->path != NULL;
	116	}
	117
c37d5728 MW	118	static inline void intel_uc_fw_sanitize(struct intel_uc_fw *uc_fw)
	119	{
	120	if (uc_fw->load_status == INTEL_UC_FIRMWARE_SUCCESS)
	121	uc_fw->load_status = INTEL_UC_FIRMWARE_PENDING;
	122	}
	123
6b0478fb JL	124	/**
	125	* intel_uc_fw_get_upload_size() - Get size of firmware needed to be uploaded.
	126	* @uc_fw: uC firmware.
	127	*
	128	* Get the size of the firmware and header that will be uploaded to WOPCM.
	129	*
	130	* Return: Upload firmware size, or zero on firmware fetch failure.
	131	*/
	132	static inline u32 intel_uc_fw_get_upload_size(struct intel_uc_fw *uc_fw)
	133	{
	134	if (uc_fw->fetch_status != INTEL_UC_FIRMWARE_SUCCESS)
	135	return 0;
	136
	137	return uc_fw->header_size + uc_fw->ucode_size;
	138	}
	139
a16b4313 MW	140	void intel_uc_fw_fetch(struct drm_i915_private *dev_priv,
a16b4313 MW	141	struct intel_uc_fw *uc_fw);
4502e9ec MW	142	int intel_uc_fw_upload(struct intel_uc_fw *uc_fw,
	143	int (xfer)(struct intel_uc_fw uc_fw,
	144	struct i915_vma *vma));
a16b4313	145	void intel_uc_fw_fini(struct intel_uc_fw *uc_fw);
7d41ef34	146	void intel_uc_fw_dump(const struct intel_uc_fw uc_fw, struct drm_printer p);
a16b4313 MW	147
a16b4313 MW	148	#endif