Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 | /* SPDX-License-Identifier: MIT */ /* * Copyright © 2014-2019 Intel Corporation */ #ifndef _INTEL_UC_FW_H_ #define _INTEL_UC_FW_H_ #include <linux/types.h> #include "intel_uc_fw_abi.h" #include "intel_device_info.h" #include "i915_gem.h" struct drm_printer; struct drm_i915_private; struct intel_gt; /* 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" /* * +------------+---------------------------------------------------+ * | PHASE | FIRMWARE STATUS TRANSITIONS | * +============+===================================================+ * | | UNINITIALIZED | * +------------+- / | \ -+ * | | DISABLED <--/ | \--> NOT_SUPPORTED | * | init_early | V | * | | SELECTED | * +------------+- / | \ -+ * | | MISSING <--/ | \--> ERROR | * | fetch | V | * | | AVAILABLE | * +------------+- | \ -+ * | | | \--> INIT FAIL | * | init | V | * | | /------> LOADABLE <----<-----------\ | * +------------+- \ / \ \ \ -+ * | | LOAD FAIL <--< \--> TRANSFERRED \ | * | upload | \ / \ / | * | | \---------/ \--> RUNNING | * +------------+---------------------------------------------------+ */ enum intel_uc_fw_status { INTEL_UC_FIRMWARE_NOT_SUPPORTED = -1, /* no uc HW */ INTEL_UC_FIRMWARE_UNINITIALIZED = 0, /* used to catch checks done too early */ INTEL_UC_FIRMWARE_DISABLED, /* disabled */ INTEL_UC_FIRMWARE_SELECTED, /* selected the blob we want to load */ INTEL_UC_FIRMWARE_MISSING, /* blob not found on the system */ INTEL_UC_FIRMWARE_ERROR, /* invalid format or version */ INTEL_UC_FIRMWARE_AVAILABLE, /* blob found and copied in mem */ INTEL_UC_FIRMWARE_INIT_FAIL, /* failed to prepare fw objects for load */ INTEL_UC_FIRMWARE_LOADABLE, /* all fw-required objects are ready */ INTEL_UC_FIRMWARE_LOAD_FAIL, /* failed to xfer or init/auth the fw */ INTEL_UC_FIRMWARE_TRANSFERRED, /* dma xfer done */ INTEL_UC_FIRMWARE_RUNNING /* init/auth done */ }; enum intel_uc_fw_type { INTEL_UC_FW_TYPE_GUC = 0, INTEL_UC_FW_TYPE_HUC }; #define INTEL_UC_FW_NUM_TYPES 2 /* * 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 { enum intel_uc_fw_type type; union { const enum intel_uc_fw_status status; enum intel_uc_fw_status __status; /* no accidental overwrites */ }; const char *path; bool user_overridden; size_t size; struct drm_i915_gem_object *obj; /* * 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; u32 rsa_size; u32 ucode_size; u32 private_data_size; }; #ifdef CONFIG_DRM_I915_DEBUG_GUC void intel_uc_fw_change_status(struct intel_uc_fw *uc_fw, enum intel_uc_fw_status status); #else static inline void intel_uc_fw_change_status(struct intel_uc_fw *uc_fw, enum intel_uc_fw_status status) { uc_fw->__status = status; } #endif static inline const char *intel_uc_fw_status_repr(enum intel_uc_fw_status status) { switch (status) { case INTEL_UC_FIRMWARE_NOT_SUPPORTED: return "N/A"; case INTEL_UC_FIRMWARE_UNINITIALIZED: return "UNINITIALIZED"; case INTEL_UC_FIRMWARE_DISABLED: return "DISABLED"; case INTEL_UC_FIRMWARE_SELECTED: return "SELECTED"; case INTEL_UC_FIRMWARE_MISSING: return "MISSING"; case INTEL_UC_FIRMWARE_ERROR: return "ERROR"; case INTEL_UC_FIRMWARE_AVAILABLE: return "AVAILABLE"; case INTEL_UC_FIRMWARE_INIT_FAIL: return "INIT FAIL"; case INTEL_UC_FIRMWARE_LOADABLE: return "LOADABLE"; case INTEL_UC_FIRMWARE_LOAD_FAIL: return "LOAD FAIL"; case INTEL_UC_FIRMWARE_TRANSFERRED: return "TRANSFERRED"; case INTEL_UC_FIRMWARE_RUNNING: return "RUNNING"; } return "<invalid>"; } static inline int intel_uc_fw_status_to_error(enum intel_uc_fw_status status) { switch (status) { case INTEL_UC_FIRMWARE_NOT_SUPPORTED: return -ENODEV; case INTEL_UC_FIRMWARE_UNINITIALIZED: return -EACCES; case INTEL_UC_FIRMWARE_DISABLED: return -EPERM; case INTEL_UC_FIRMWARE_MISSING: return -ENOENT; case INTEL_UC_FIRMWARE_ERROR: return -ENOEXEC; case INTEL_UC_FIRMWARE_INIT_FAIL: case INTEL_UC_FIRMWARE_LOAD_FAIL: return -EIO; case INTEL_UC_FIRMWARE_SELECTED: return -ESTALE; case INTEL_UC_FIRMWARE_AVAILABLE: case INTEL_UC_FIRMWARE_LOADABLE: case INTEL_UC_FIRMWARE_TRANSFERRED: case INTEL_UC_FIRMWARE_RUNNING: return 0; } return -EINVAL; } 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 enum intel_uc_fw_status __intel_uc_fw_status(struct intel_uc_fw *uc_fw) { /* shouldn't call this before checking hw/blob availability */ GEM_BUG_ON(uc_fw->status == INTEL_UC_FIRMWARE_UNINITIALIZED); return uc_fw->status; } static inline bool intel_uc_fw_is_supported(struct intel_uc_fw *uc_fw) { return __intel_uc_fw_status(uc_fw) != INTEL_UC_FIRMWARE_NOT_SUPPORTED; } static inline bool intel_uc_fw_is_enabled(struct intel_uc_fw *uc_fw) { return __intel_uc_fw_status(uc_fw) > INTEL_UC_FIRMWARE_DISABLED; } static inline bool intel_uc_fw_is_available(struct intel_uc_fw *uc_fw) { return __intel_uc_fw_status(uc_fw) >= INTEL_UC_FIRMWARE_AVAILABLE; } static inline bool intel_uc_fw_is_loadable(struct intel_uc_fw *uc_fw) { return __intel_uc_fw_status(uc_fw) >= INTEL_UC_FIRMWARE_LOADABLE; } static inline bool intel_uc_fw_is_loaded(struct intel_uc_fw *uc_fw) { return __intel_uc_fw_status(uc_fw) >= INTEL_UC_FIRMWARE_TRANSFERRED; } static inline bool intel_uc_fw_is_running(struct intel_uc_fw *uc_fw) { return __intel_uc_fw_status(uc_fw) == INTEL_UC_FIRMWARE_RUNNING; } static inline bool intel_uc_fw_is_overridden(const struct intel_uc_fw *uc_fw) { return uc_fw->user_overridden; } static inline void intel_uc_fw_sanitize(struct intel_uc_fw *uc_fw) { if (intel_uc_fw_is_loaded(uc_fw)) intel_uc_fw_change_status(uc_fw, INTEL_UC_FIRMWARE_LOADABLE); } static inline u32 __intel_uc_fw_get_upload_size(struct intel_uc_fw *uc_fw) { return sizeof(struct uc_css_header) + uc_fw->ucode_size; } /** * 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 (!intel_uc_fw_is_available(uc_fw)) return 0; return __intel_uc_fw_get_upload_size(uc_fw); } void intel_uc_fw_init_early(struct intel_uc_fw *uc_fw, enum intel_uc_fw_type type); int intel_uc_fw_fetch(struct intel_uc_fw *uc_fw); void intel_uc_fw_cleanup_fetch(struct intel_uc_fw *uc_fw); int intel_uc_fw_upload(struct intel_uc_fw *uc_fw, u32 offset, u32 dma_flags); int intel_uc_fw_init(struct intel_uc_fw *uc_fw); void intel_uc_fw_fini(struct intel_uc_fw *uc_fw); size_t intel_uc_fw_copy_rsa(struct intel_uc_fw *uc_fw, void *dst, u32 max_len); void intel_uc_fw_dump(const struct intel_uc_fw *uc_fw, struct drm_printer *p); #endif |