Commit | Line | Data |
---|---|---|
33a732f4 AD |
1 | /* |
2 | * Copyright © 2014 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 | * Authors: | |
24 | * Vinit Azad <vinit.azad@intel.com> | |
25 | * Ben Widawsky <ben@bwidawsk.net> | |
26 | * Dave Gordon <david.s.gordon@intel.com> | |
27 | * Alex Dai <yu.dai@intel.com> | |
28 | */ | |
29 | #include <linux/firmware.h> | |
30 | #include "i915_drv.h" | |
31 | #include "intel_guc.h" | |
32 | ||
33 | /** | |
feda33ef | 34 | * DOC: GuC-specific firmware loader |
33a732f4 AD |
35 | * |
36 | * intel_guc: | |
37 | * Top level structure of guc. It handles firmware loading and manages client | |
38 | * pool and doorbells. intel_guc owns a i915_guc_client to replace the legacy | |
39 | * ExecList submission. | |
40 | * | |
41 | * Firmware versioning: | |
42 | * The firmware build process will generate a version header file with major and | |
43 | * minor version defined. The versions are built into CSS header of firmware. | |
44 | * i915 kernel driver set the minimal firmware version required per platform. | |
45 | * The firmware installation package will install (symbolic link) proper version | |
46 | * of firmware. | |
47 | * | |
48 | * GuC address space: | |
49 | * GuC does not allow any gfx GGTT address that falls into range [0, WOPCM_TOP), | |
50 | * which is reserved for Boot ROM, SRAM and WOPCM. Currently this top address is | |
51 | * 512K. In order to exclude 0-512K address space from GGTT, all gfx objects | |
52 | * used by GuC is pinned with PIN_OFFSET_BIAS along with size of WOPCM. | |
53 | * | |
54 | * Firmware log: | |
55 | * Firmware log is enabled by setting i915.guc_log_level to non-negative level. | |
56 | * Log data is printed out via reading debugfs i915_guc_log_dump. Reading from | |
57 | * i915_guc_load_status will print out firmware loading status and scratch | |
58 | * registers value. | |
59 | * | |
60 | */ | |
61 | ||
4d3ba7e4 | 62 | #define I915_SKL_GUC_UCODE "i915/skl_guc_ver6_1.bin" |
33a732f4 AD |
63 | MODULE_FIRMWARE(I915_SKL_GUC_UCODE); |
64 | ||
57bf5c81 NH |
65 | #define I915_BXT_GUC_UCODE "i915/bxt_guc_ver8_7.bin" |
66 | MODULE_FIRMWARE(I915_BXT_GUC_UCODE); | |
67 | ||
33a732f4 AD |
68 | /* User-friendly representation of an enum */ |
69 | const char *intel_guc_fw_status_repr(enum intel_guc_fw_status status) | |
70 | { | |
71 | switch (status) { | |
72 | case GUC_FIRMWARE_FAIL: | |
73 | return "FAIL"; | |
74 | case GUC_FIRMWARE_NONE: | |
75 | return "NONE"; | |
76 | case GUC_FIRMWARE_PENDING: | |
77 | return "PENDING"; | |
78 | case GUC_FIRMWARE_SUCCESS: | |
79 | return "SUCCESS"; | |
80 | default: | |
81 | return "UNKNOWN!"; | |
82 | } | |
83 | }; | |
84 | ||
4df001d3 DG |
85 | static void direct_interrupts_to_host(struct drm_i915_private *dev_priv) |
86 | { | |
e2f80391 | 87 | struct intel_engine_cs *engine; |
b4ac5afc | 88 | int irqs; |
4df001d3 DG |
89 | |
90 | /* tell all command streamers NOT to forward interrupts and vblank to GuC */ | |
91 | irqs = _MASKED_FIELD(GFX_FORWARD_VBLANK_MASK, GFX_FORWARD_VBLANK_NEVER); | |
92 | irqs |= _MASKED_BIT_DISABLE(GFX_INTERRUPT_STEERING); | |
b4ac5afc | 93 | for_each_engine(engine, dev_priv) |
e2f80391 | 94 | I915_WRITE(RING_MODE_GEN7(engine), irqs); |
4df001d3 | 95 | |
4df001d3 DG |
96 | /* route all GT interrupts to the host */ |
97 | I915_WRITE(GUC_BCS_RCS_IER, 0); | |
98 | I915_WRITE(GUC_VCS2_VCS1_IER, 0); | |
99 | I915_WRITE(GUC_WD_VECS_IER, 0); | |
100 | } | |
101 | ||
102 | static void direct_interrupts_to_guc(struct drm_i915_private *dev_priv) | |
103 | { | |
e2f80391 | 104 | struct intel_engine_cs *engine; |
b4ac5afc | 105 | int irqs; |
4df001d3 DG |
106 | |
107 | /* tell all command streamers to forward interrupts and vblank to GuC */ | |
108 | irqs = _MASKED_FIELD(GFX_FORWARD_VBLANK_MASK, GFX_FORWARD_VBLANK_ALWAYS); | |
109 | irqs |= _MASKED_BIT_ENABLE(GFX_INTERRUPT_STEERING); | |
b4ac5afc | 110 | for_each_engine(engine, dev_priv) |
e2f80391 | 111 | I915_WRITE(RING_MODE_GEN7(engine), irqs); |
4df001d3 | 112 | |
4df001d3 DG |
113 | /* route USER_INTERRUPT to Host, all others are sent to GuC. */ |
114 | irqs = GT_RENDER_USER_INTERRUPT << GEN8_RCS_IRQ_SHIFT | | |
115 | GT_RENDER_USER_INTERRUPT << GEN8_BCS_IRQ_SHIFT; | |
116 | /* These three registers have the same bit definitions */ | |
117 | I915_WRITE(GUC_BCS_RCS_IER, ~irqs); | |
118 | I915_WRITE(GUC_VCS2_VCS1_IER, ~irqs); | |
119 | I915_WRITE(GUC_WD_VECS_IER, ~irqs); | |
120 | } | |
121 | ||
33a732f4 AD |
122 | static u32 get_gttype(struct drm_i915_private *dev_priv) |
123 | { | |
124 | /* XXX: GT type based on PCI device ID? field seems unused by fw */ | |
125 | return 0; | |
126 | } | |
127 | ||
128 | static u32 get_core_family(struct drm_i915_private *dev_priv) | |
129 | { | |
130 | switch (INTEL_INFO(dev_priv)->gen) { | |
131 | case 9: | |
132 | return GFXCORE_FAMILY_GEN9; | |
133 | ||
134 | default: | |
135 | DRM_ERROR("GUC: unsupported core family\n"); | |
136 | return GFXCORE_FAMILY_UNKNOWN; | |
137 | } | |
138 | } | |
139 | ||
140 | static void set_guc_init_params(struct drm_i915_private *dev_priv) | |
141 | { | |
142 | struct intel_guc *guc = &dev_priv->guc; | |
143 | u32 params[GUC_CTL_MAX_DWORDS]; | |
144 | int i; | |
145 | ||
146 | memset(¶ms, 0, sizeof(params)); | |
147 | ||
148 | params[GUC_CTL_DEVICE_INFO] |= | |
149 | (get_gttype(dev_priv) << GUC_CTL_GTTYPE_SHIFT) | | |
150 | (get_core_family(dev_priv) << GUC_CTL_COREFAMILY_SHIFT); | |
151 | ||
152 | /* | |
153 | * GuC ARAT increment is 10 ns. GuC default scheduler quantum is one | |
154 | * second. This ARAR is calculated by: | |
155 | * Scheduler-Quantum-in-ns / ARAT-increment-in-ns = 1000000000 / 10 | |
156 | */ | |
157 | params[GUC_CTL_ARAT_HIGH] = 0; | |
158 | params[GUC_CTL_ARAT_LOW] = 100000000; | |
159 | ||
160 | params[GUC_CTL_WA] |= GUC_CTL_WA_UK_BY_DRIVER; | |
161 | ||
162 | params[GUC_CTL_FEATURE] |= GUC_CTL_DISABLE_SCHEDULER | | |
163 | GUC_CTL_VCS2_ENABLED; | |
164 | ||
165 | if (i915.guc_log_level >= 0) { | |
166 | params[GUC_CTL_LOG_PARAMS] = guc->log_flags; | |
167 | params[GUC_CTL_DEBUG] = | |
168 | i915.guc_log_level << GUC_LOG_VERBOSITY_SHIFT; | |
169 | } | |
170 | ||
b6a5cd7e AD |
171 | if (guc->ads_obj) { |
172 | u32 ads = (u32)i915_gem_obj_ggtt_offset(guc->ads_obj) | |
173 | >> PAGE_SHIFT; | |
174 | params[GUC_CTL_DEBUG] |= ads << GUC_ADS_ADDR_SHIFT; | |
175 | params[GUC_CTL_DEBUG] |= GUC_ADS_ENABLED; | |
176 | } | |
177 | ||
bac427f8 AD |
178 | /* If GuC submission is enabled, set up additional parameters here */ |
179 | if (i915.enable_guc_submission) { | |
180 | u32 pgs = i915_gem_obj_ggtt_offset(dev_priv->guc.ctx_pool_obj); | |
181 | u32 ctx_in_16 = GUC_MAX_GPU_CONTEXTS / 16; | |
182 | ||
183 | pgs >>= PAGE_SHIFT; | |
184 | params[GUC_CTL_CTXINFO] = (pgs << GUC_CTL_BASE_ADDR_SHIFT) | | |
185 | (ctx_in_16 << GUC_CTL_CTXNUM_IN16_SHIFT); | |
186 | ||
187 | params[GUC_CTL_FEATURE] |= GUC_CTL_KERNEL_SUBMISSIONS; | |
188 | ||
189 | /* Unmask this bit to enable the GuC's internal scheduler */ | |
190 | params[GUC_CTL_FEATURE] &= ~GUC_CTL_DISABLE_SCHEDULER; | |
191 | } | |
192 | ||
33a732f4 AD |
193 | I915_WRITE(SOFT_SCRATCH(0), 0); |
194 | ||
195 | for (i = 0; i < GUC_CTL_MAX_DWORDS; i++) | |
196 | I915_WRITE(SOFT_SCRATCH(1 + i), params[i]); | |
197 | } | |
198 | ||
199 | /* | |
200 | * Read the GuC status register (GUC_STATUS) and store it in the | |
201 | * specified location; then return a boolean indicating whether | |
202 | * the value matches either of two values representing completion | |
203 | * of the GuC boot process. | |
204 | * | |
36894e8b | 205 | * This is used for polling the GuC status in a wait_for() |
33a732f4 AD |
206 | * loop below. |
207 | */ | |
208 | static inline bool guc_ucode_response(struct drm_i915_private *dev_priv, | |
209 | u32 *status) | |
210 | { | |
211 | u32 val = I915_READ(GUC_STATUS); | |
0d44d3fa | 212 | u32 uk_val = val & GS_UKERNEL_MASK; |
33a732f4 | 213 | *status = val; |
0d44d3fa AD |
214 | return (uk_val == GS_UKERNEL_READY || |
215 | ((val & GS_MIA_CORE_STATE) && uk_val == GS_UKERNEL_LAPIC_DONE)); | |
33a732f4 AD |
216 | } |
217 | ||
218 | /* | |
219 | * Transfer the firmware image to RAM for execution by the microcontroller. | |
220 | * | |
33a732f4 AD |
221 | * Architecturally, the DMA engine is bidirectional, and can potentially even |
222 | * transfer between GTT locations. This functionality is left out of the API | |
223 | * for now as there is no need for it. | |
224 | * | |
225 | * Note that GuC needs the CSS header plus uKernel code to be copied by the | |
226 | * DMA engine in one operation, whereas the RSA signature is loaded via MMIO. | |
227 | */ | |
33a732f4 AD |
228 | static int guc_ucode_xfer_dma(struct drm_i915_private *dev_priv) |
229 | { | |
230 | struct intel_guc_fw *guc_fw = &dev_priv->guc.guc_fw; | |
231 | struct drm_i915_gem_object *fw_obj = guc_fw->guc_fw_obj; | |
232 | unsigned long offset; | |
233 | struct sg_table *sg = fw_obj->pages; | |
feda33ef | 234 | u32 status, rsa[UOS_RSA_SCRATCH_MAX_COUNT]; |
33a732f4 AD |
235 | int i, ret = 0; |
236 | ||
feda33ef AD |
237 | /* where RSA signature starts */ |
238 | offset = guc_fw->rsa_offset; | |
33a732f4 AD |
239 | |
240 | /* Copy RSA signature from the fw image to HW for verification */ | |
feda33ef AD |
241 | sg_pcopy_to_buffer(sg->sgl, sg->nents, rsa, sizeof(rsa), offset); |
242 | for (i = 0; i < UOS_RSA_SCRATCH_MAX_COUNT; i++) | |
ab9cc558 | 243 | I915_WRITE(UOS_RSA_SCRATCH(i), rsa[i]); |
33a732f4 | 244 | |
feda33ef AD |
245 | /* The header plus uCode will be copied to WOPCM via DMA, excluding any |
246 | * other components */ | |
247 | I915_WRITE(DMA_COPY_SIZE, guc_fw->header_size + guc_fw->ucode_size); | |
248 | ||
33a732f4 | 249 | /* Set the source address for the new blob */ |
feda33ef | 250 | offset = i915_gem_obj_ggtt_offset(fw_obj) + guc_fw->header_offset; |
33a732f4 AD |
251 | I915_WRITE(DMA_ADDR_0_LOW, lower_32_bits(offset)); |
252 | I915_WRITE(DMA_ADDR_0_HIGH, upper_32_bits(offset) & 0xFFFF); | |
253 | ||
254 | /* | |
255 | * Set the DMA destination. Current uCode expects the code to be | |
256 | * loaded at 8k; locations below this are used for the stack. | |
257 | */ | |
258 | I915_WRITE(DMA_ADDR_1_LOW, 0x2000); | |
259 | I915_WRITE(DMA_ADDR_1_HIGH, DMA_ADDRESS_SPACE_WOPCM); | |
260 | ||
261 | /* Finally start the DMA */ | |
262 | I915_WRITE(DMA_CTRL, _MASKED_BIT_ENABLE(UOS_MOVE | START_DMA)); | |
263 | ||
264 | /* | |
36894e8b | 265 | * Wait for the DMA to complete & the GuC to start up. |
33a732f4 AD |
266 | * NB: Docs recommend not using the interrupt for completion. |
267 | * Measurements indicate this should take no more than 20ms, so a | |
268 | * timeout here indicates that the GuC has failed and is unusable. | |
269 | * (Higher levels of the driver will attempt to fall back to | |
270 | * execlist mode if this happens.) | |
271 | */ | |
36894e8b | 272 | ret = wait_for(guc_ucode_response(dev_priv, &status), 100); |
33a732f4 AD |
273 | |
274 | DRM_DEBUG_DRIVER("DMA status 0x%x, GuC status 0x%x\n", | |
275 | I915_READ(DMA_CTRL), status); | |
276 | ||
277 | if ((status & GS_BOOTROM_MASK) == GS_BOOTROM_RSA_FAILED) { | |
278 | DRM_ERROR("GuC firmware signature verification failed\n"); | |
279 | ret = -ENOEXEC; | |
280 | } | |
281 | ||
282 | DRM_DEBUG_DRIVER("returning %d\n", ret); | |
283 | ||
284 | return ret; | |
285 | } | |
286 | ||
287 | /* | |
288 | * Load the GuC firmware blob into the MinuteIA. | |
289 | */ | |
290 | static int guc_ucode_xfer(struct drm_i915_private *dev_priv) | |
291 | { | |
292 | struct intel_guc_fw *guc_fw = &dev_priv->guc.guc_fw; | |
293 | struct drm_device *dev = dev_priv->dev; | |
294 | int ret; | |
295 | ||
296 | ret = i915_gem_object_set_to_gtt_domain(guc_fw->guc_fw_obj, false); | |
297 | if (ret) { | |
298 | DRM_DEBUG_DRIVER("set-domain failed %d\n", ret); | |
299 | return ret; | |
300 | } | |
301 | ||
302 | ret = i915_gem_obj_ggtt_pin(guc_fw->guc_fw_obj, 0, 0); | |
303 | if (ret) { | |
304 | DRM_DEBUG_DRIVER("pin failed %d\n", ret); | |
305 | return ret; | |
306 | } | |
307 | ||
308 | /* Invalidate GuC TLB to let GuC take the latest updates to GTT. */ | |
309 | I915_WRITE(GEN8_GTCR, GEN8_GTCR_INVALIDATE); | |
310 | ||
311 | intel_uncore_forcewake_get(dev_priv, FORCEWAKE_ALL); | |
312 | ||
313 | /* init WOPCM */ | |
314 | I915_WRITE(GUC_WOPCM_SIZE, GUC_WOPCM_SIZE_VALUE); | |
315 | I915_WRITE(DMA_GUC_WOPCM_OFFSET, GUC_WOPCM_OFFSET_VALUE); | |
316 | ||
317 | /* Enable MIA caching. GuC clock gating is disabled. */ | |
318 | I915_WRITE(GUC_SHIM_CONTROL, GUC_SHIM_CONTROL_VALUE); | |
319 | ||
b970b486 | 320 | /* WaDisableMinuteIaClockGating:skl,bxt */ |
e87a005d | 321 | if (IS_SKL_REVID(dev, 0, SKL_REVID_B0) || |
cbdc12a9 | 322 | IS_BXT_REVID(dev, 0, BXT_REVID_A1)) { |
b970b486 NH |
323 | I915_WRITE(GUC_SHIM_CONTROL, (I915_READ(GUC_SHIM_CONTROL) & |
324 | ~GUC_ENABLE_MIA_CLOCK_GATING)); | |
325 | } | |
326 | ||
33a732f4 AD |
327 | /* WaC6DisallowByGfxPause*/ |
328 | I915_WRITE(GEN6_GFXPAUSE, 0x30FFF); | |
329 | ||
330 | if (IS_BROXTON(dev)) | |
331 | I915_WRITE(GEN9LP_GT_PM_CONFIG, GT_DOORBELL_ENABLE); | |
332 | else | |
333 | I915_WRITE(GEN9_GT_PM_CONFIG, GT_DOORBELL_ENABLE); | |
334 | ||
335 | if (IS_GEN9(dev)) { | |
336 | /* DOP Clock Gating Enable for GuC clocks */ | |
337 | I915_WRITE(GEN7_MISCCPCTL, (GEN8_DOP_CLOCK_GATE_GUC_ENABLE | | |
338 | I915_READ(GEN7_MISCCPCTL))); | |
339 | ||
340 | /* allows for 5us before GT can go to RC6 */ | |
341 | I915_WRITE(GUC_ARAT_C6DIS, 0x1FF); | |
342 | } | |
343 | ||
344 | set_guc_init_params(dev_priv); | |
345 | ||
346 | ret = guc_ucode_xfer_dma(dev_priv); | |
347 | ||
348 | intel_uncore_forcewake_put(dev_priv, FORCEWAKE_ALL); | |
349 | ||
350 | /* | |
351 | * We keep the object pages for reuse during resume. But we can unpin it | |
352 | * now that DMA has completed, so it doesn't continue to take up space. | |
353 | */ | |
354 | i915_gem_object_ggtt_unpin(guc_fw->guc_fw_obj); | |
355 | ||
356 | return ret; | |
357 | } | |
358 | ||
6b332fa2 AS |
359 | static int i915_reset_guc(struct drm_i915_private *dev_priv) |
360 | { | |
361 | int ret; | |
362 | u32 guc_status; | |
363 | ||
364 | ret = intel_guc_reset(dev_priv); | |
365 | if (ret) { | |
366 | DRM_ERROR("GuC reset failed, ret = %d\n", ret); | |
367 | return ret; | |
368 | } | |
369 | ||
370 | guc_status = I915_READ(GUC_STATUS); | |
371 | WARN(!(guc_status & GS_MIA_IN_RESET), | |
372 | "GuC status: 0x%x, MIA core expected to be in reset\n", guc_status); | |
373 | ||
374 | return ret; | |
375 | } | |
376 | ||
33a732f4 AD |
377 | /** |
378 | * intel_guc_ucode_load() - load GuC uCode into the device | |
379 | * @dev: drm device | |
380 | * | |
381 | * Called from gem_init_hw() during driver loading and also after a GPU reset. | |
382 | * | |
383 | * The firmware image should have already been fetched into memory by the | |
384 | * earlier call to intel_guc_ucode_init(), so here we need only check that | |
385 | * is succeeded, and then transfer the image to the h/w. | |
386 | * | |
387 | * Return: non-zero code on error | |
388 | */ | |
389 | int intel_guc_ucode_load(struct drm_device *dev) | |
390 | { | |
391 | struct drm_i915_private *dev_priv = dev->dev_private; | |
392 | struct intel_guc_fw *guc_fw = &dev_priv->guc.guc_fw; | |
d761701c | 393 | int retries, err = 0; |
33a732f4 | 394 | |
9f9e539f DV |
395 | if (!i915.enable_guc_submission) |
396 | return 0; | |
397 | ||
33a732f4 AD |
398 | DRM_DEBUG_DRIVER("GuC fw status: fetch %s, load %s\n", |
399 | intel_guc_fw_status_repr(guc_fw->guc_fw_fetch_status), | |
400 | intel_guc_fw_status_repr(guc_fw->guc_fw_load_status)); | |
401 | ||
4df001d3 | 402 | direct_interrupts_to_host(dev_priv); |
44a28b1d | 403 | |
33a732f4 AD |
404 | if (guc_fw->guc_fw_fetch_status == GUC_FIRMWARE_NONE) |
405 | return 0; | |
406 | ||
407 | if (guc_fw->guc_fw_fetch_status == GUC_FIRMWARE_SUCCESS && | |
408 | guc_fw->guc_fw_load_status == GUC_FIRMWARE_FAIL) | |
409 | return -ENOEXEC; | |
410 | ||
411 | guc_fw->guc_fw_load_status = GUC_FIRMWARE_PENDING; | |
412 | ||
413 | DRM_DEBUG_DRIVER("GuC fw fetch status %s\n", | |
414 | intel_guc_fw_status_repr(guc_fw->guc_fw_fetch_status)); | |
415 | ||
416 | switch (guc_fw->guc_fw_fetch_status) { | |
417 | case GUC_FIRMWARE_FAIL: | |
418 | /* something went wrong :( */ | |
419 | err = -EIO; | |
420 | goto fail; | |
421 | ||
422 | case GUC_FIRMWARE_NONE: | |
423 | case GUC_FIRMWARE_PENDING: | |
424 | default: | |
425 | /* "can't happen" */ | |
426 | WARN_ONCE(1, "GuC fw %s invalid guc_fw_fetch_status %s [%d]\n", | |
427 | guc_fw->guc_fw_path, | |
428 | intel_guc_fw_status_repr(guc_fw->guc_fw_fetch_status), | |
429 | guc_fw->guc_fw_fetch_status); | |
430 | err = -ENXIO; | |
431 | goto fail; | |
432 | ||
433 | case GUC_FIRMWARE_SUCCESS: | |
434 | break; | |
435 | } | |
436 | ||
bac427f8 AD |
437 | err = i915_guc_submission_init(dev); |
438 | if (err) | |
439 | goto fail; | |
440 | ||
6b332fa2 AS |
441 | /* |
442 | * WaEnableuKernelHeaderValidFix:skl,bxt | |
443 | * For BXT, this is only upto B0 but below WA is required for later | |
444 | * steppings also so this is extended as well. | |
445 | */ | |
446 | /* WaEnableGuCBootHashCheckNotSet:skl,bxt */ | |
d761701c DG |
447 | for (retries = 3; ; ) { |
448 | /* | |
449 | * Always reset the GuC just before (re)loading, so | |
450 | * that the state and timing are fairly predictable | |
451 | */ | |
452 | err = i915_reset_guc(dev_priv); | |
6b332fa2 | 453 | if (err) { |
d761701c | 454 | DRM_ERROR("GuC reset failed, err %d\n", err); |
6b332fa2 AS |
455 | goto fail; |
456 | } | |
d761701c DG |
457 | |
458 | err = guc_ucode_xfer(dev_priv); | |
459 | if (!err) | |
460 | break; | |
461 | ||
462 | if (--retries == 0) | |
463 | goto fail; | |
464 | ||
465 | DRM_INFO("GuC fw load failed, err %d; will reset and " | |
466 | "retry %d more time(s)\n", err, retries); | |
6b332fa2 | 467 | } |
33a732f4 AD |
468 | |
469 | guc_fw->guc_fw_load_status = GUC_FIRMWARE_SUCCESS; | |
470 | ||
471 | DRM_DEBUG_DRIVER("GuC fw status: fetch %s, load %s\n", | |
472 | intel_guc_fw_status_repr(guc_fw->guc_fw_fetch_status), | |
473 | intel_guc_fw_status_repr(guc_fw->guc_fw_load_status)); | |
474 | ||
44a28b1d | 475 | if (i915.enable_guc_submission) { |
a1c41994 AD |
476 | /* The execbuf_client will be recreated. Release it first. */ |
477 | i915_guc_submission_disable(dev); | |
478 | ||
44a28b1d DG |
479 | err = i915_guc_submission_enable(dev); |
480 | if (err) | |
481 | goto fail; | |
4df001d3 | 482 | direct_interrupts_to_guc(dev_priv); |
44a28b1d DG |
483 | } |
484 | ||
33a732f4 AD |
485 | return 0; |
486 | ||
487 | fail: | |
d761701c | 488 | DRM_ERROR("GuC firmware load failed, err %d\n", err); |
33a732f4 AD |
489 | if (guc_fw->guc_fw_load_status == GUC_FIRMWARE_PENDING) |
490 | guc_fw->guc_fw_load_status = GUC_FIRMWARE_FAIL; | |
491 | ||
4df001d3 | 492 | direct_interrupts_to_host(dev_priv); |
44a28b1d | 493 | i915_guc_submission_disable(dev); |
a9d8adad | 494 | i915_guc_submission_fini(dev); |
44a28b1d | 495 | |
33a732f4 AD |
496 | return err; |
497 | } | |
498 | ||
499 | static void guc_fw_fetch(struct drm_device *dev, struct intel_guc_fw *guc_fw) | |
500 | { | |
501 | struct drm_i915_gem_object *obj; | |
502 | const struct firmware *fw; | |
feda33ef AD |
503 | struct guc_css_header *css; |
504 | size_t size; | |
33a732f4 AD |
505 | int err; |
506 | ||
507 | DRM_DEBUG_DRIVER("before requesting firmware: GuC fw fetch status %s\n", | |
508 | intel_guc_fw_status_repr(guc_fw->guc_fw_fetch_status)); | |
509 | ||
510 | err = request_firmware(&fw, guc_fw->guc_fw_path, &dev->pdev->dev); | |
511 | if (err) | |
512 | goto fail; | |
513 | if (!fw) | |
514 | goto fail; | |
515 | ||
516 | DRM_DEBUG_DRIVER("fetch GuC fw from %s succeeded, fw %p\n", | |
517 | guc_fw->guc_fw_path, fw); | |
33a732f4 | 518 | |
feda33ef AD |
519 | /* Check the size of the blob before examining buffer contents */ |
520 | if (fw->size < sizeof(struct guc_css_header)) { | |
521 | DRM_ERROR("Firmware header is missing\n"); | |
33a732f4 | 522 | goto fail; |
feda33ef AD |
523 | } |
524 | ||
525 | css = (struct guc_css_header *)fw->data; | |
526 | ||
527 | /* Firmware bits always start from header */ | |
528 | guc_fw->header_offset = 0; | |
529 | guc_fw->header_size = (css->header_size_dw - css->modulus_size_dw - | |
530 | css->key_size_dw - css->exponent_size_dw) * sizeof(u32); | |
531 | ||
532 | if (guc_fw->header_size != sizeof(struct guc_css_header)) { | |
533 | DRM_ERROR("CSS header definition mismatch\n"); | |
534 | goto fail; | |
535 | } | |
536 | ||
537 | /* then, uCode */ | |
538 | guc_fw->ucode_offset = guc_fw->header_offset + guc_fw->header_size; | |
539 | guc_fw->ucode_size = (css->size_dw - css->header_size_dw) * sizeof(u32); | |
540 | ||
541 | /* now RSA */ | |
542 | if (css->key_size_dw != UOS_RSA_SCRATCH_MAX_COUNT) { | |
543 | DRM_ERROR("RSA key size is bad\n"); | |
544 | goto fail; | |
545 | } | |
546 | guc_fw->rsa_offset = guc_fw->ucode_offset + guc_fw->ucode_size; | |
547 | guc_fw->rsa_size = css->key_size_dw * sizeof(u32); | |
548 | ||
549 | /* At least, it should have header, uCode and RSA. Size of all three. */ | |
550 | size = guc_fw->header_size + guc_fw->ucode_size + guc_fw->rsa_size; | |
551 | if (fw->size < size) { | |
552 | DRM_ERROR("Missing firmware components\n"); | |
553 | goto fail; | |
554 | } | |
555 | ||
556 | /* Header and uCode will be loaded to WOPCM. Size of the two. */ | |
557 | size = guc_fw->header_size + guc_fw->ucode_size; | |
558 | ||
559 | /* Top 32k of WOPCM is reserved (8K stack + 24k RC6 context). */ | |
560 | if (size > GUC_WOPCM_SIZE_VALUE - 0x8000) { | |
561 | DRM_ERROR("Firmware is too large to fit in WOPCM\n"); | |
562 | goto fail; | |
563 | } | |
33a732f4 AD |
564 | |
565 | /* | |
566 | * The GuC firmware image has the version number embedded at a well-known | |
567 | * offset within the firmware blob; note that major / minor version are | |
568 | * TWO bytes each (i.e. u16), although all pointers and offsets are defined | |
569 | * in terms of bytes (u8). | |
570 | */ | |
feda33ef AD |
571 | guc_fw->guc_fw_major_found = css->guc_sw_version >> 16; |
572 | guc_fw->guc_fw_minor_found = css->guc_sw_version & 0xFFFF; | |
33a732f4 AD |
573 | |
574 | if (guc_fw->guc_fw_major_found != guc_fw->guc_fw_major_wanted || | |
575 | guc_fw->guc_fw_minor_found < guc_fw->guc_fw_minor_wanted) { | |
576 | DRM_ERROR("GuC firmware version %d.%d, required %d.%d\n", | |
577 | guc_fw->guc_fw_major_found, guc_fw->guc_fw_minor_found, | |
578 | guc_fw->guc_fw_major_wanted, guc_fw->guc_fw_minor_wanted); | |
579 | err = -ENOEXEC; | |
580 | goto fail; | |
581 | } | |
582 | ||
583 | DRM_DEBUG_DRIVER("firmware version %d.%d OK (minimum %d.%d)\n", | |
584 | guc_fw->guc_fw_major_found, guc_fw->guc_fw_minor_found, | |
585 | guc_fw->guc_fw_major_wanted, guc_fw->guc_fw_minor_wanted); | |
586 | ||
bf248ca1 | 587 | mutex_lock(&dev->struct_mutex); |
33a732f4 | 588 | obj = i915_gem_object_create_from_data(dev, fw->data, fw->size); |
bf248ca1 | 589 | mutex_unlock(&dev->struct_mutex); |
33a732f4 AD |
590 | if (IS_ERR_OR_NULL(obj)) { |
591 | err = obj ? PTR_ERR(obj) : -ENOMEM; | |
592 | goto fail; | |
593 | } | |
594 | ||
595 | guc_fw->guc_fw_obj = obj; | |
596 | guc_fw->guc_fw_size = fw->size; | |
597 | ||
598 | DRM_DEBUG_DRIVER("GuC fw fetch status SUCCESS, obj %p\n", | |
599 | guc_fw->guc_fw_obj); | |
600 | ||
601 | release_firmware(fw); | |
602 | guc_fw->guc_fw_fetch_status = GUC_FIRMWARE_SUCCESS; | |
603 | return; | |
604 | ||
605 | fail: | |
606 | DRM_DEBUG_DRIVER("GuC fw fetch status FAIL; err %d, fw %p, obj %p\n", | |
607 | err, fw, guc_fw->guc_fw_obj); | |
608 | DRM_ERROR("Failed to fetch GuC firmware from %s (error %d)\n", | |
609 | guc_fw->guc_fw_path, err); | |
610 | ||
a9d8adad | 611 | mutex_lock(&dev->struct_mutex); |
33a732f4 AD |
612 | obj = guc_fw->guc_fw_obj; |
613 | if (obj) | |
614 | drm_gem_object_unreference(&obj->base); | |
615 | guc_fw->guc_fw_obj = NULL; | |
a9d8adad | 616 | mutex_unlock(&dev->struct_mutex); |
33a732f4 AD |
617 | |
618 | release_firmware(fw); /* OK even if fw is NULL */ | |
619 | guc_fw->guc_fw_fetch_status = GUC_FIRMWARE_FAIL; | |
620 | } | |
621 | ||
622 | /** | |
623 | * intel_guc_ucode_init() - define parameters and fetch firmware | |
624 | * @dev: drm device | |
625 | * | |
626 | * Called early during driver load, but after GEM is initialised. | |
33a732f4 AD |
627 | * |
628 | * The firmware will be transferred to the GuC's memory later, | |
629 | * when intel_guc_ucode_load() is called. | |
630 | */ | |
631 | void intel_guc_ucode_init(struct drm_device *dev) | |
632 | { | |
633 | struct drm_i915_private *dev_priv = dev->dev_private; | |
634 | struct intel_guc_fw *guc_fw = &dev_priv->guc.guc_fw; | |
635 | const char *fw_path; | |
636 | ||
637 | if (!HAS_GUC_SCHED(dev)) | |
638 | i915.enable_guc_submission = false; | |
639 | ||
640 | if (!HAS_GUC_UCODE(dev)) { | |
641 | fw_path = NULL; | |
642 | } else if (IS_SKYLAKE(dev)) { | |
643 | fw_path = I915_SKL_GUC_UCODE; | |
ab65cce8 AD |
644 | guc_fw->guc_fw_major_wanted = 6; |
645 | guc_fw->guc_fw_minor_wanted = 1; | |
57bf5c81 NH |
646 | } else if (IS_BROXTON(dev)) { |
647 | fw_path = I915_BXT_GUC_UCODE; | |
648 | guc_fw->guc_fw_major_wanted = 8; | |
649 | guc_fw->guc_fw_minor_wanted = 7; | |
33a732f4 AD |
650 | } else { |
651 | i915.enable_guc_submission = false; | |
652 | fw_path = ""; /* unknown device */ | |
653 | } | |
654 | ||
9f9e539f DV |
655 | if (!i915.enable_guc_submission) |
656 | return; | |
657 | ||
33a732f4 AD |
658 | guc_fw->guc_dev = dev; |
659 | guc_fw->guc_fw_path = fw_path; | |
660 | guc_fw->guc_fw_fetch_status = GUC_FIRMWARE_NONE; | |
661 | guc_fw->guc_fw_load_status = GUC_FIRMWARE_NONE; | |
662 | ||
663 | if (fw_path == NULL) | |
664 | return; | |
665 | ||
666 | if (*fw_path == '\0') { | |
667 | DRM_ERROR("No GuC firmware known for this platform\n"); | |
668 | guc_fw->guc_fw_fetch_status = GUC_FIRMWARE_FAIL; | |
669 | return; | |
670 | } | |
671 | ||
672 | guc_fw->guc_fw_fetch_status = GUC_FIRMWARE_PENDING; | |
673 | DRM_DEBUG_DRIVER("GuC firmware pending, path %s\n", fw_path); | |
674 | guc_fw_fetch(dev, guc_fw); | |
675 | /* status must now be FAIL or SUCCESS */ | |
676 | } | |
677 | ||
678 | /** | |
679 | * intel_guc_ucode_fini() - clean up all allocated resources | |
680 | * @dev: drm device | |
681 | */ | |
682 | void intel_guc_ucode_fini(struct drm_device *dev) | |
683 | { | |
684 | struct drm_i915_private *dev_priv = dev->dev_private; | |
685 | struct intel_guc_fw *guc_fw = &dev_priv->guc.guc_fw; | |
686 | ||
a9d8adad | 687 | mutex_lock(&dev->struct_mutex); |
4df001d3 | 688 | direct_interrupts_to_host(dev_priv); |
a9d8adad | 689 | i915_guc_submission_disable(dev); |
bac427f8 AD |
690 | i915_guc_submission_fini(dev); |
691 | ||
33a732f4 AD |
692 | if (guc_fw->guc_fw_obj) |
693 | drm_gem_object_unreference(&guc_fw->guc_fw_obj->base); | |
694 | guc_fw->guc_fw_obj = NULL; | |
bf248ca1 | 695 | mutex_unlock(&dev->struct_mutex); |
33a732f4 AD |
696 | |
697 | guc_fw->guc_fw_fetch_status = GUC_FIRMWARE_NONE; | |
698 | } |