drm/i915/huc: better define HuC status getparam possible return values.

Bugzilla: https://bugzilla.redhat.com/show_bug.cgi?id=2041690
Upstream Status: git://anongit.freedesktop.org/drm/drm

commit b76c14c
Author:     Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com>
AuthorDate: Tue Sep 27 17:41:43 2022 -0700
Commit:     Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com>
CommitDate: Mon Oct  3 11:29:20 2022 -0700

    The current HuC status getparam return values are a bit confusing in
    regards to what happens in some scenarios. In particular, most of the
    error cases cause the ioctl to return an error, but a couple of them,
    INIT_FAIL and LOAD_FAIL, are not explicitly handled and neither is
    their expected return value documented; these 2 error cases therefore
    end up into the catch-all umbrella of the "HuC not loaded" case, with
    this case therefore including both some error scenarios and the load
    in progress one.

    The updates included in this patch change the handling so that all
    error cases behave the same way, i.e. return an errno code, and so
    that the HuC load in progress case is unambiguous.

    The patch also includes a small change to the FW init path to make sure
    we always transition to an error state if something goes wrong.

    Signed-off-by: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com>
    Cc: Tvrtko Ursulin <tvrtko.ursulin@linux.intel.com>
    Cc: Tony Ye <tony.ye@intel.com>
    Acked-by: Tvrtko Ursulin <tvrtko.ursulin@intel.com>
    Acked-by: Tony Ye <tony.ye@intel.com>
    Reviewed-by: Alan Previn <alan.previn.teres.alexis@intel.com>
    Link: https://patchwork.freedesktop.org/patch/msgid/20220928004145.745803-14-daniele.ceraolospurio@intel.com

Signed-off-by: Jocelyn Falempe <jfalempe@redhat.com>

Author: Jocelyn Falempe

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

@@ -474,6 +474,7 @@ int intel_guc_init(struct intel_guc *guc)
 err_fw:
 	intel_uc_fw_fini(&guc->fw);
 out:
+	intel_uc_fw_change_status(&guc->fw, INTEL_UC_FIRMWARE_INIT_FAIL);
 	i915_probe_error(gt->i915, "failed with %d\n", ret);
 	return ret;
 }

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

@@ -285,6 +285,7 @@ int intel_huc_init(struct intel_huc *huc)
 	return 0;
 
 out:
+	intel_uc_fw_change_status(&huc->fw, INTEL_UC_FIRMWARE_INIT_FAIL);
 	drm_info(&i915->drm, "HuC init failed with %d\n", err);
 	return err;
 }
@@ -404,13 +405,8 @@ bool intel_huc_is_authenticated(struct intel_huc *huc)
  * This function reads status register to verify if HuC
  * firmware was successfully loaded.
  *
- * Returns:
- *  * -ENODEV if HuC is not present on this platform,
- *  * -EOPNOTSUPP if HuC firmware is disabled,
- *  * -ENOPKG if HuC firmware was not installed,
- *  * -ENOEXEC if HuC firmware is invalid or mismatched,
- *  * 0 if HuC firmware is not running,
- *  * 1 if HuC firmware is authenticated and running.
+ * The return values match what is expected for the I915_PARAM_HUC_STATUS
+ * getparam.
  */
 int intel_huc_check_status(struct intel_huc *huc)
 {
@@ -423,6 +419,10 @@ int intel_huc_check_status(struct intel_huc *huc)
 		return -ENOPKG;
 	case INTEL_UC_FIRMWARE_ERROR:
 		return -ENOEXEC;
+	case INTEL_UC_FIRMWARE_INIT_FAIL:
+		return -ENOMEM;
+	case INTEL_UC_FIRMWARE_LOAD_FAIL:
+		return -EIO;
 	default:
 		break;
 	}

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

@@ -894,7 +894,6 @@ int intel_uc_fw_init(struct intel_uc_fw *uc_fw)
 out_unpin:
 	i915_gem_object_unpin_pages(uc_fw->obj);
 out:
-	intel_uc_fw_change_status(uc_fw, INTEL_UC_FIRMWARE_INIT_FAIL);
 	return err;
 }
 

include/uapi/drm/i915_drm.h

@@ -645,6 +645,22 @@ typedef struct drm_i915_irq_wait {
  */
 #define   I915_SCHEDULER_CAP_STATIC_PRIORITY_MAP	(1ul << 5)
 
+/*
+ * Query the status of HuC load.
+ *
+ * The query can fail in the following scenarios with the listed error codes:
+ *  -ENODEV if HuC is not present on this platform,
+ *  -EOPNOTSUPP if HuC firmware usage is disabled,
+ *  -ENOPKG if HuC firmware fetch failed,
+ *  -ENOEXEC if HuC firmware is invalid or mismatched,
+ *  -ENOMEM if i915 failed to prepare the FW objects for transfer to the uC,
+ *  -EIO if the FW transfer or the FW authentication failed.
+ *
+ * If the IOCTL is successful, the returned parameter will be set to one of the
+ * following values:
+ *  * 0 if HuC firmware load is not complete,
+ *  * 1 if HuC firmware is authenticated and running.
+ */
 #define I915_PARAM_HUC_STATUS		 42
 
 /* Query whether DRM_I915_GEM_EXECBUFFER2 supports the ability to opt-out of