Loading...
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 */
24
25#include <linux/debugfs.h>
26#include <linux/firmware.h>
27
28#include "i915_drv.h"
29#include "i915_reg.h"
30#include "intel_de.h"
31#include "intel_dmc.h"
32#include "intel_dmc_regs.h"
33#include "intel_step.h"
34
35/**
36 * DOC: DMC Firmware Support
37 *
38 * From gen9 onwards we have newly added DMC (Display microcontroller) in display
39 * engine to save and restore the state of display engine when it enter into
40 * low-power state and comes back to normal.
41 */
42
43#define INTEL_DMC_FIRMWARE_URL "https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git"
44
45enum intel_dmc_id {
46 DMC_FW_MAIN = 0,
47 DMC_FW_PIPEA,
48 DMC_FW_PIPEB,
49 DMC_FW_PIPEC,
50 DMC_FW_PIPED,
51 DMC_FW_MAX
52};
53
54struct intel_dmc {
55 struct intel_display *display;
56 struct work_struct work;
57 const char *fw_path;
58 u32 max_fw_size; /* bytes */
59 u32 version;
60 struct dmc_fw_info {
61 u32 mmio_count;
62 i915_reg_t mmioaddr[20];
63 u32 mmiodata[20];
64 u32 dmc_offset;
65 u32 start_mmioaddr;
66 u32 dmc_fw_size; /*dwords */
67 u32 *payload;
68 bool present;
69 } dmc_info[DMC_FW_MAX];
70};
71
72/* Note: This may be NULL. */
73static struct intel_dmc *display_to_dmc(struct intel_display *display)
74{
75 return display->dmc.dmc;
76}
77
78static const char *dmc_firmware_param(struct intel_display *display)
79{
80 const char *p = display->params.dmc_firmware_path;
81
82 return p && *p ? p : NULL;
83}
84
85static bool dmc_firmware_param_disabled(struct intel_display *display)
86{
87 const char *p = dmc_firmware_param(display);
88
89 /* Magic path to indicate disabled */
90 return p && !strcmp(p, "/dev/null");
91}
92
93#define DMC_VERSION(major, minor) ((major) << 16 | (minor))
94#define DMC_VERSION_MAJOR(version) ((version) >> 16)
95#define DMC_VERSION_MINOR(version) ((version) & 0xffff)
96
97#define DMC_PATH(platform) \
98 "i915/" __stringify(platform) "_dmc.bin"
99
100/*
101 * New DMC additions should not use this. This is used solely to remain
102 * compatible with systems that have not yet updated DMC blobs to use
103 * unversioned file names.
104 */
105#define DMC_LEGACY_PATH(platform, major, minor) \
106 "i915/" \
107 __stringify(platform) "_dmc_ver" \
108 __stringify(major) "_" \
109 __stringify(minor) ".bin"
110
111#define XE2LPD_DMC_MAX_FW_SIZE 0x8000
112#define XELPDP_DMC_MAX_FW_SIZE 0x7000
113#define DISPLAY_VER13_DMC_MAX_FW_SIZE 0x20000
114#define DISPLAY_VER12_DMC_MAX_FW_SIZE ICL_DMC_MAX_FW_SIZE
115
116#define XE3LPD_DMC_PATH DMC_PATH(xe3lpd)
117MODULE_FIRMWARE(XE3LPD_DMC_PATH);
118
119#define XE2LPD_DMC_PATH DMC_PATH(xe2lpd)
120MODULE_FIRMWARE(XE2LPD_DMC_PATH);
121
122#define BMG_DMC_PATH DMC_PATH(bmg)
123MODULE_FIRMWARE(BMG_DMC_PATH);
124
125#define MTL_DMC_PATH DMC_PATH(mtl)
126MODULE_FIRMWARE(MTL_DMC_PATH);
127
128#define DG2_DMC_PATH DMC_LEGACY_PATH(dg2, 2, 08)
129MODULE_FIRMWARE(DG2_DMC_PATH);
130
131#define ADLP_DMC_PATH DMC_PATH(adlp)
132#define ADLP_DMC_FALLBACK_PATH DMC_LEGACY_PATH(adlp, 2, 16)
133MODULE_FIRMWARE(ADLP_DMC_PATH);
134MODULE_FIRMWARE(ADLP_DMC_FALLBACK_PATH);
135
136#define ADLS_DMC_PATH DMC_LEGACY_PATH(adls, 2, 01)
137MODULE_FIRMWARE(ADLS_DMC_PATH);
138
139#define DG1_DMC_PATH DMC_LEGACY_PATH(dg1, 2, 02)
140MODULE_FIRMWARE(DG1_DMC_PATH);
141
142#define RKL_DMC_PATH DMC_LEGACY_PATH(rkl, 2, 03)
143MODULE_FIRMWARE(RKL_DMC_PATH);
144
145#define TGL_DMC_PATH DMC_LEGACY_PATH(tgl, 2, 12)
146MODULE_FIRMWARE(TGL_DMC_PATH);
147
148#define ICL_DMC_PATH DMC_LEGACY_PATH(icl, 1, 09)
149#define ICL_DMC_MAX_FW_SIZE 0x6000
150MODULE_FIRMWARE(ICL_DMC_PATH);
151
152#define GLK_DMC_PATH DMC_LEGACY_PATH(glk, 1, 04)
153#define GLK_DMC_MAX_FW_SIZE 0x4000
154MODULE_FIRMWARE(GLK_DMC_PATH);
155
156#define KBL_DMC_PATH DMC_LEGACY_PATH(kbl, 1, 04)
157#define KBL_DMC_MAX_FW_SIZE BXT_DMC_MAX_FW_SIZE
158MODULE_FIRMWARE(KBL_DMC_PATH);
159
160#define SKL_DMC_PATH DMC_LEGACY_PATH(skl, 1, 27)
161#define SKL_DMC_MAX_FW_SIZE BXT_DMC_MAX_FW_SIZE
162MODULE_FIRMWARE(SKL_DMC_PATH);
163
164#define BXT_DMC_PATH DMC_LEGACY_PATH(bxt, 1, 07)
165#define BXT_DMC_MAX_FW_SIZE 0x3000
166MODULE_FIRMWARE(BXT_DMC_PATH);
167
168static const char *dmc_firmware_default(struct intel_display *display, u32 *size)
169{
170 struct drm_i915_private *i915 = to_i915(display->drm);
171 const char *fw_path = NULL;
172 u32 max_fw_size = 0;
173
174 if (DISPLAY_VERx100(display) == 3000) {
175 fw_path = XE3LPD_DMC_PATH;
176 max_fw_size = XE2LPD_DMC_MAX_FW_SIZE;
177 } else if (DISPLAY_VERx100(display) == 2000) {
178 fw_path = XE2LPD_DMC_PATH;
179 max_fw_size = XE2LPD_DMC_MAX_FW_SIZE;
180 } else if (DISPLAY_VERx100(display) == 1401) {
181 fw_path = BMG_DMC_PATH;
182 max_fw_size = XELPDP_DMC_MAX_FW_SIZE;
183 } else if (DISPLAY_VERx100(display) == 1400) {
184 fw_path = MTL_DMC_PATH;
185 max_fw_size = XELPDP_DMC_MAX_FW_SIZE;
186 } else if (IS_DG2(i915)) {
187 fw_path = DG2_DMC_PATH;
188 max_fw_size = DISPLAY_VER13_DMC_MAX_FW_SIZE;
189 } else if (IS_ALDERLAKE_P(i915)) {
190 fw_path = ADLP_DMC_PATH;
191 max_fw_size = DISPLAY_VER13_DMC_MAX_FW_SIZE;
192 } else if (IS_ALDERLAKE_S(i915)) {
193 fw_path = ADLS_DMC_PATH;
194 max_fw_size = DISPLAY_VER12_DMC_MAX_FW_SIZE;
195 } else if (IS_DG1(i915)) {
196 fw_path = DG1_DMC_PATH;
197 max_fw_size = DISPLAY_VER12_DMC_MAX_FW_SIZE;
198 } else if (IS_ROCKETLAKE(i915)) {
199 fw_path = RKL_DMC_PATH;
200 max_fw_size = DISPLAY_VER12_DMC_MAX_FW_SIZE;
201 } else if (IS_TIGERLAKE(i915)) {
202 fw_path = TGL_DMC_PATH;
203 max_fw_size = DISPLAY_VER12_DMC_MAX_FW_SIZE;
204 } else if (DISPLAY_VER(display) == 11) {
205 fw_path = ICL_DMC_PATH;
206 max_fw_size = ICL_DMC_MAX_FW_SIZE;
207 } else if (IS_GEMINILAKE(i915)) {
208 fw_path = GLK_DMC_PATH;
209 max_fw_size = GLK_DMC_MAX_FW_SIZE;
210 } else if (IS_KABYLAKE(i915) ||
211 IS_COFFEELAKE(i915) ||
212 IS_COMETLAKE(i915)) {
213 fw_path = KBL_DMC_PATH;
214 max_fw_size = KBL_DMC_MAX_FW_SIZE;
215 } else if (IS_SKYLAKE(i915)) {
216 fw_path = SKL_DMC_PATH;
217 max_fw_size = SKL_DMC_MAX_FW_SIZE;
218 } else if (IS_BROXTON(i915)) {
219 fw_path = BXT_DMC_PATH;
220 max_fw_size = BXT_DMC_MAX_FW_SIZE;
221 }
222
223 *size = max_fw_size;
224
225 return fw_path;
226}
227
228#define DMC_DEFAULT_FW_OFFSET 0xFFFFFFFF
229#define PACKAGE_MAX_FW_INFO_ENTRIES 20
230#define PACKAGE_V2_MAX_FW_INFO_ENTRIES 32
231#define DMC_V1_MAX_MMIO_COUNT 8
232#define DMC_V3_MAX_MMIO_COUNT 20
233#define DMC_V1_MMIO_START_RANGE 0x80000
234
235#define PIPE_TO_DMC_ID(pipe) (DMC_FW_PIPEA + ((pipe) - PIPE_A))
236
237struct intel_css_header {
238 /* 0x09 for DMC */
239 u32 module_type;
240
241 /* Includes the DMC specific header in dwords */
242 u32 header_len;
243
244 /* always value would be 0x10000 */
245 u32 header_ver;
246
247 /* Not used */
248 u32 module_id;
249
250 /* Not used */
251 u32 module_vendor;
252
253 /* in YYYYMMDD format */
254 u32 date;
255
256 /* Size in dwords (CSS_Headerlen + PackageHeaderLen + dmc FWsLen)/4 */
257 u32 size;
258
259 /* Not used */
260 u32 key_size;
261
262 /* Not used */
263 u32 modulus_size;
264
265 /* Not used */
266 u32 exponent_size;
267
268 /* Not used */
269 u32 reserved1[12];
270
271 /* Major Minor */
272 u32 version;
273
274 /* Not used */
275 u32 reserved2[8];
276
277 /* Not used */
278 u32 kernel_header_info;
279} __packed;
280
281struct intel_fw_info {
282 u8 reserved1;
283
284 /* reserved on package_header version 1, must be 0 on version 2 */
285 u8 dmc_id;
286
287 /* Stepping (A, B, C, ..., *). * is a wildcard */
288 char stepping;
289
290 /* Sub-stepping (0, 1, ..., *). * is a wildcard */
291 char substepping;
292
293 u32 offset;
294 u32 reserved2;
295} __packed;
296
297struct intel_package_header {
298 /* DMC container header length in dwords */
299 u8 header_len;
300
301 /* 0x01, 0x02 */
302 u8 header_ver;
303
304 u8 reserved[10];
305
306 /* Number of valid entries in the FWInfo array below */
307 u32 num_entries;
308} __packed;
309
310struct intel_dmc_header_base {
311 /* always value would be 0x40403E3E */
312 u32 signature;
313
314 /* DMC binary header length */
315 u8 header_len;
316
317 /* 0x01 */
318 u8 header_ver;
319
320 /* Reserved */
321 u16 dmcc_ver;
322
323 /* Major, Minor */
324 u32 project;
325
326 /* Firmware program size (excluding header) in dwords */
327 u32 fw_size;
328
329 /* Major Minor version */
330 u32 fw_version;
331} __packed;
332
333struct intel_dmc_header_v1 {
334 struct intel_dmc_header_base base;
335
336 /* Number of valid MMIO cycles present. */
337 u32 mmio_count;
338
339 /* MMIO address */
340 u32 mmioaddr[DMC_V1_MAX_MMIO_COUNT];
341
342 /* MMIO data */
343 u32 mmiodata[DMC_V1_MAX_MMIO_COUNT];
344
345 /* FW filename */
346 char dfile[32];
347
348 u32 reserved1[2];
349} __packed;
350
351struct intel_dmc_header_v3 {
352 struct intel_dmc_header_base base;
353
354 /* DMC RAM start MMIO address */
355 u32 start_mmioaddr;
356
357 u32 reserved[9];
358
359 /* FW filename */
360 char dfile[32];
361
362 /* Number of valid MMIO cycles present. */
363 u32 mmio_count;
364
365 /* MMIO address */
366 u32 mmioaddr[DMC_V3_MAX_MMIO_COUNT];
367
368 /* MMIO data */
369 u32 mmiodata[DMC_V3_MAX_MMIO_COUNT];
370} __packed;
371
372struct stepping_info {
373 char stepping;
374 char substepping;
375};
376
377#define for_each_dmc_id(__dmc_id) \
378 for ((__dmc_id) = DMC_FW_MAIN; (__dmc_id) < DMC_FW_MAX; (__dmc_id)++)
379
380static bool is_valid_dmc_id(enum intel_dmc_id dmc_id)
381{
382 return dmc_id >= DMC_FW_MAIN && dmc_id < DMC_FW_MAX;
383}
384
385static bool has_dmc_id_fw(struct intel_display *display, enum intel_dmc_id dmc_id)
386{
387 struct intel_dmc *dmc = display_to_dmc(display);
388
389 return dmc && dmc->dmc_info[dmc_id].payload;
390}
391
392bool intel_dmc_has_payload(struct intel_display *display)
393{
394 return has_dmc_id_fw(display, DMC_FW_MAIN);
395}
396
397static const struct stepping_info *
398intel_get_stepping_info(struct intel_display *display,
399 struct stepping_info *si)
400{
401 const char *step_name = intel_step_name(INTEL_DISPLAY_STEP(display));
402
403 si->stepping = step_name[0];
404 si->substepping = step_name[1];
405 return si;
406}
407
408static void gen9_set_dc_state_debugmask(struct intel_display *display)
409{
410 /* The below bit doesn't need to be cleared ever afterwards */
411 intel_de_rmw(display, DC_STATE_DEBUG, 0,
412 DC_STATE_DEBUG_MASK_CORES | DC_STATE_DEBUG_MASK_MEMORY_UP);
413 intel_de_posting_read(display, DC_STATE_DEBUG);
414}
415
416static void disable_event_handler(struct intel_display *display,
417 i915_reg_t ctl_reg, i915_reg_t htp_reg)
418{
419 intel_de_write(display, ctl_reg,
420 REG_FIELD_PREP(DMC_EVT_CTL_TYPE_MASK,
421 DMC_EVT_CTL_TYPE_EDGE_0_1) |
422 REG_FIELD_PREP(DMC_EVT_CTL_EVENT_ID_MASK,
423 DMC_EVT_CTL_EVENT_ID_FALSE));
424 intel_de_write(display, htp_reg, 0);
425}
426
427static void disable_all_event_handlers(struct intel_display *display)
428{
429 enum intel_dmc_id dmc_id;
430
431 /* TODO: disable the event handlers on pre-GEN12 platforms as well */
432 if (DISPLAY_VER(display) < 12)
433 return;
434
435 for_each_dmc_id(dmc_id) {
436 int handler;
437
438 if (!has_dmc_id_fw(display, dmc_id))
439 continue;
440
441 for (handler = 0; handler < DMC_EVENT_HANDLER_COUNT_GEN12; handler++)
442 disable_event_handler(display,
443 DMC_EVT_CTL(display, dmc_id, handler),
444 DMC_EVT_HTP(display, dmc_id, handler));
445 }
446}
447
448static void adlp_pipedmc_clock_gating_wa(struct intel_display *display, bool enable)
449{
450 enum pipe pipe;
451
452 /*
453 * Wa_16015201720:adl-p,dg2
454 * The WA requires clock gating to be disabled all the time
455 * for pipe A and B.
456 * For pipe C and D clock gating needs to be disabled only
457 * during initializing the firmware.
458 */
459 if (enable)
460 for (pipe = PIPE_A; pipe <= PIPE_D; pipe++)
461 intel_de_rmw(display, CLKGATE_DIS_PSL_EXT(pipe),
462 0, PIPEDMC_GATING_DIS);
463 else
464 for (pipe = PIPE_C; pipe <= PIPE_D; pipe++)
465 intel_de_rmw(display, CLKGATE_DIS_PSL_EXT(pipe),
466 PIPEDMC_GATING_DIS, 0);
467}
468
469static void mtl_pipedmc_clock_gating_wa(struct intel_display *display)
470{
471 /*
472 * Wa_16015201720
473 * The WA requires clock gating to be disabled all the time
474 * for pipe A and B.
475 */
476 intel_de_rmw(display, GEN9_CLKGATE_DIS_0, 0,
477 MTL_PIPEDMC_GATING_DIS_A | MTL_PIPEDMC_GATING_DIS_B);
478}
479
480static void pipedmc_clock_gating_wa(struct intel_display *display, bool enable)
481{
482 if (DISPLAY_VER(display) >= 14 && enable)
483 mtl_pipedmc_clock_gating_wa(display);
484 else if (DISPLAY_VER(display) == 13)
485 adlp_pipedmc_clock_gating_wa(display, enable);
486}
487
488void intel_dmc_enable_pipe(struct intel_display *display, enum pipe pipe)
489{
490 enum intel_dmc_id dmc_id = PIPE_TO_DMC_ID(pipe);
491
492 if (!is_valid_dmc_id(dmc_id) || !has_dmc_id_fw(display, dmc_id))
493 return;
494
495 if (DISPLAY_VER(display) >= 14)
496 intel_de_rmw(display, MTL_PIPEDMC_CONTROL, 0, PIPEDMC_ENABLE_MTL(pipe));
497 else
498 intel_de_rmw(display, PIPEDMC_CONTROL(pipe), 0, PIPEDMC_ENABLE);
499}
500
501void intel_dmc_disable_pipe(struct intel_display *display, enum pipe pipe)
502{
503 enum intel_dmc_id dmc_id = PIPE_TO_DMC_ID(pipe);
504
505 if (!is_valid_dmc_id(dmc_id) || !has_dmc_id_fw(display, dmc_id))
506 return;
507
508 if (DISPLAY_VER(display) >= 14)
509 intel_de_rmw(display, MTL_PIPEDMC_CONTROL, PIPEDMC_ENABLE_MTL(pipe), 0);
510 else
511 intel_de_rmw(display, PIPEDMC_CONTROL(pipe), PIPEDMC_ENABLE, 0);
512}
513
514static bool is_dmc_evt_ctl_reg(struct intel_display *display,
515 enum intel_dmc_id dmc_id, i915_reg_t reg)
516{
517 u32 offset = i915_mmio_reg_offset(reg);
518 u32 start = i915_mmio_reg_offset(DMC_EVT_CTL(display, dmc_id, 0));
519 u32 end = i915_mmio_reg_offset(DMC_EVT_CTL(display, dmc_id, DMC_EVENT_HANDLER_COUNT_GEN12));
520
521 return offset >= start && offset < end;
522}
523
524static bool is_dmc_evt_htp_reg(struct intel_display *display,
525 enum intel_dmc_id dmc_id, i915_reg_t reg)
526{
527 u32 offset = i915_mmio_reg_offset(reg);
528 u32 start = i915_mmio_reg_offset(DMC_EVT_HTP(display, dmc_id, 0));
529 u32 end = i915_mmio_reg_offset(DMC_EVT_HTP(display, dmc_id, DMC_EVENT_HANDLER_COUNT_GEN12));
530
531 return offset >= start && offset < end;
532}
533
534static bool disable_dmc_evt(struct intel_display *display,
535 enum intel_dmc_id dmc_id,
536 i915_reg_t reg, u32 data)
537{
538 struct drm_i915_private *i915 = to_i915(display->drm);
539
540 if (!is_dmc_evt_ctl_reg(display, dmc_id, reg))
541 return false;
542
543 /* keep all pipe DMC events disabled by default */
544 if (dmc_id != DMC_FW_MAIN)
545 return true;
546
547 /* also disable the flip queue event on the main DMC on TGL */
548 if (IS_TIGERLAKE(i915) &&
549 REG_FIELD_GET(DMC_EVT_CTL_EVENT_ID_MASK, data) == DMC_EVT_CTL_EVENT_ID_CLK_MSEC)
550 return true;
551
552 /* also disable the HRR event on the main DMC on TGL/ADLS */
553 if ((IS_TIGERLAKE(i915) || IS_ALDERLAKE_S(i915)) &&
554 REG_FIELD_GET(DMC_EVT_CTL_EVENT_ID_MASK, data) == DMC_EVT_CTL_EVENT_ID_VBLANK_A)
555 return true;
556
557 return false;
558}
559
560static u32 dmc_mmiodata(struct intel_display *display,
561 struct intel_dmc *dmc,
562 enum intel_dmc_id dmc_id, int i)
563{
564 if (disable_dmc_evt(display, dmc_id,
565 dmc->dmc_info[dmc_id].mmioaddr[i],
566 dmc->dmc_info[dmc_id].mmiodata[i]))
567 return REG_FIELD_PREP(DMC_EVT_CTL_TYPE_MASK,
568 DMC_EVT_CTL_TYPE_EDGE_0_1) |
569 REG_FIELD_PREP(DMC_EVT_CTL_EVENT_ID_MASK,
570 DMC_EVT_CTL_EVENT_ID_FALSE);
571 else
572 return dmc->dmc_info[dmc_id].mmiodata[i];
573}
574
575/**
576 * intel_dmc_load_program() - write the firmware from memory to register.
577 * @display: display instance
578 *
579 * DMC firmware is read from a .bin file and kept in internal memory one time.
580 * Everytime display comes back from low power state this function is called to
581 * copy the firmware from internal memory to registers.
582 */
583void intel_dmc_load_program(struct intel_display *display)
584{
585 struct drm_i915_private *i915 __maybe_unused = to_i915(display->drm);
586 struct i915_power_domains *power_domains = &display->power.domains;
587 struct intel_dmc *dmc = display_to_dmc(display);
588 enum intel_dmc_id dmc_id;
589 u32 i;
590
591 if (!intel_dmc_has_payload(display))
592 return;
593
594 pipedmc_clock_gating_wa(display, true);
595
596 disable_all_event_handlers(display);
597
598 assert_rpm_wakelock_held(&i915->runtime_pm);
599
600 preempt_disable();
601
602 for_each_dmc_id(dmc_id) {
603 for (i = 0; i < dmc->dmc_info[dmc_id].dmc_fw_size; i++) {
604 intel_de_write_fw(display,
605 DMC_PROGRAM(dmc->dmc_info[dmc_id].start_mmioaddr, i),
606 dmc->dmc_info[dmc_id].payload[i]);
607 }
608 }
609
610 preempt_enable();
611
612 for_each_dmc_id(dmc_id) {
613 for (i = 0; i < dmc->dmc_info[dmc_id].mmio_count; i++) {
614 intel_de_write(display, dmc->dmc_info[dmc_id].mmioaddr[i],
615 dmc_mmiodata(display, dmc, dmc_id, i));
616 }
617 }
618
619 power_domains->dc_state = 0;
620
621 gen9_set_dc_state_debugmask(display);
622
623 pipedmc_clock_gating_wa(display, false);
624}
625
626/**
627 * intel_dmc_disable_program() - disable the firmware
628 * @display: display instance
629 *
630 * Disable all event handlers in the firmware, making sure the firmware is
631 * inactive after the display is uninitialized.
632 */
633void intel_dmc_disable_program(struct intel_display *display)
634{
635 if (!intel_dmc_has_payload(display))
636 return;
637
638 pipedmc_clock_gating_wa(display, true);
639 disable_all_event_handlers(display);
640 pipedmc_clock_gating_wa(display, false);
641
642 intel_dmc_wl_disable(display);
643}
644
645void assert_dmc_loaded(struct intel_display *display)
646{
647 struct intel_dmc *dmc = display_to_dmc(display);
648
649 drm_WARN_ONCE(display->drm, !dmc, "DMC not initialized\n");
650 drm_WARN_ONCE(display->drm, dmc &&
651 !intel_de_read(display, DMC_PROGRAM(dmc->dmc_info[DMC_FW_MAIN].start_mmioaddr, 0)),
652 "DMC program storage start is NULL\n");
653 drm_WARN_ONCE(display->drm, !intel_de_read(display, DMC_SSP_BASE),
654 "DMC SSP Base Not fine\n");
655 drm_WARN_ONCE(display->drm, !intel_de_read(display, DMC_HTP_SKL),
656 "DMC HTP Not fine\n");
657}
658
659static bool fw_info_matches_stepping(const struct intel_fw_info *fw_info,
660 const struct stepping_info *si)
661{
662 if ((fw_info->substepping == '*' && si->stepping == fw_info->stepping) ||
663 (si->stepping == fw_info->stepping && si->substepping == fw_info->substepping) ||
664 /*
665 * If we don't find a more specific one from above two checks, we
666 * then check for the generic one to be sure to work even with
667 * "broken firmware"
668 */
669 (si->stepping == '*' && si->substepping == fw_info->substepping) ||
670 (fw_info->stepping == '*' && fw_info->substepping == '*'))
671 return true;
672
673 return false;
674}
675
676/*
677 * Search fw_info table for dmc_offset to find firmware binary: num_entries is
678 * already sanitized.
679 */
680static void dmc_set_fw_offset(struct intel_dmc *dmc,
681 const struct intel_fw_info *fw_info,
682 unsigned int num_entries,
683 const struct stepping_info *si,
684 u8 package_ver)
685{
686 struct intel_display *display = dmc->display;
687 enum intel_dmc_id dmc_id;
688 unsigned int i;
689
690 for (i = 0; i < num_entries; i++) {
691 dmc_id = package_ver <= 1 ? DMC_FW_MAIN : fw_info[i].dmc_id;
692
693 if (!is_valid_dmc_id(dmc_id)) {
694 drm_dbg(display->drm, "Unsupported firmware id: %u\n", dmc_id);
695 continue;
696 }
697
698 /* More specific versions come first, so we don't even have to
699 * check for the stepping since we already found a previous FW
700 * for this id.
701 */
702 if (dmc->dmc_info[dmc_id].present)
703 continue;
704
705 if (fw_info_matches_stepping(&fw_info[i], si)) {
706 dmc->dmc_info[dmc_id].present = true;
707 dmc->dmc_info[dmc_id].dmc_offset = fw_info[i].offset;
708 }
709 }
710}
711
712static bool dmc_mmio_addr_sanity_check(struct intel_dmc *dmc,
713 const u32 *mmioaddr, u32 mmio_count,
714 int header_ver, enum intel_dmc_id dmc_id)
715{
716 struct intel_display *display = dmc->display;
717 u32 start_range, end_range;
718 int i;
719
720 if (header_ver == 1) {
721 start_range = DMC_MMIO_START_RANGE;
722 end_range = DMC_MMIO_END_RANGE;
723 } else if (dmc_id == DMC_FW_MAIN) {
724 start_range = TGL_MAIN_MMIO_START;
725 end_range = TGL_MAIN_MMIO_END;
726 } else if (DISPLAY_VER(display) >= 13) {
727 start_range = ADLP_PIPE_MMIO_START;
728 end_range = ADLP_PIPE_MMIO_END;
729 } else if (DISPLAY_VER(display) >= 12) {
730 start_range = TGL_PIPE_MMIO_START(dmc_id);
731 end_range = TGL_PIPE_MMIO_END(dmc_id);
732 } else {
733 drm_warn(display->drm, "Unknown mmio range for sanity check");
734 return false;
735 }
736
737 for (i = 0; i < mmio_count; i++) {
738 if (mmioaddr[i] < start_range || mmioaddr[i] > end_range)
739 return false;
740 }
741
742 return true;
743}
744
745static u32 parse_dmc_fw_header(struct intel_dmc *dmc,
746 const struct intel_dmc_header_base *dmc_header,
747 size_t rem_size, enum intel_dmc_id dmc_id)
748{
749 struct intel_display *display = dmc->display;
750 struct dmc_fw_info *dmc_info = &dmc->dmc_info[dmc_id];
751 unsigned int header_len_bytes, dmc_header_size, payload_size, i;
752 const u32 *mmioaddr, *mmiodata;
753 u32 mmio_count, mmio_count_max, start_mmioaddr;
754 u8 *payload;
755
756 BUILD_BUG_ON(ARRAY_SIZE(dmc_info->mmioaddr) < DMC_V3_MAX_MMIO_COUNT ||
757 ARRAY_SIZE(dmc_info->mmioaddr) < DMC_V1_MAX_MMIO_COUNT);
758
759 /*
760 * Check if we can access common fields, we will checkc again below
761 * after we have read the version
762 */
763 if (rem_size < sizeof(struct intel_dmc_header_base))
764 goto error_truncated;
765
766 /* Cope with small differences between v1 and v3 */
767 if (dmc_header->header_ver == 3) {
768 const struct intel_dmc_header_v3 *v3 =
769 (const struct intel_dmc_header_v3 *)dmc_header;
770
771 if (rem_size < sizeof(struct intel_dmc_header_v3))
772 goto error_truncated;
773
774 mmioaddr = v3->mmioaddr;
775 mmiodata = v3->mmiodata;
776 mmio_count = v3->mmio_count;
777 mmio_count_max = DMC_V3_MAX_MMIO_COUNT;
778 /* header_len is in dwords */
779 header_len_bytes = dmc_header->header_len * 4;
780 start_mmioaddr = v3->start_mmioaddr;
781 dmc_header_size = sizeof(*v3);
782 } else if (dmc_header->header_ver == 1) {
783 const struct intel_dmc_header_v1 *v1 =
784 (const struct intel_dmc_header_v1 *)dmc_header;
785
786 if (rem_size < sizeof(struct intel_dmc_header_v1))
787 goto error_truncated;
788
789 mmioaddr = v1->mmioaddr;
790 mmiodata = v1->mmiodata;
791 mmio_count = v1->mmio_count;
792 mmio_count_max = DMC_V1_MAX_MMIO_COUNT;
793 header_len_bytes = dmc_header->header_len;
794 start_mmioaddr = DMC_V1_MMIO_START_RANGE;
795 dmc_header_size = sizeof(*v1);
796 } else {
797 drm_err(display->drm, "Unknown DMC fw header version: %u\n",
798 dmc_header->header_ver);
799 return 0;
800 }
801
802 if (header_len_bytes != dmc_header_size) {
803 drm_err(display->drm, "DMC firmware has wrong dmc header length "
804 "(%u bytes)\n", header_len_bytes);
805 return 0;
806 }
807
808 /* Cache the dmc header info. */
809 if (mmio_count > mmio_count_max) {
810 drm_err(display->drm, "DMC firmware has wrong mmio count %u\n", mmio_count);
811 return 0;
812 }
813
814 if (!dmc_mmio_addr_sanity_check(dmc, mmioaddr, mmio_count,
815 dmc_header->header_ver, dmc_id)) {
816 drm_err(display->drm, "DMC firmware has Wrong MMIO Addresses\n");
817 return 0;
818 }
819
820 drm_dbg_kms(display->drm, "DMC %d:\n", dmc_id);
821 for (i = 0; i < mmio_count; i++) {
822 dmc_info->mmioaddr[i] = _MMIO(mmioaddr[i]);
823 dmc_info->mmiodata[i] = mmiodata[i];
824
825 drm_dbg_kms(display->drm, " mmio[%d]: 0x%x = 0x%x%s%s\n",
826 i, mmioaddr[i], mmiodata[i],
827 is_dmc_evt_ctl_reg(display, dmc_id, dmc_info->mmioaddr[i]) ? " (EVT_CTL)" :
828 is_dmc_evt_htp_reg(display, dmc_id, dmc_info->mmioaddr[i]) ? " (EVT_HTP)" : "",
829 disable_dmc_evt(display, dmc_id, dmc_info->mmioaddr[i],
830 dmc_info->mmiodata[i]) ? " (disabling)" : "");
831 }
832 dmc_info->mmio_count = mmio_count;
833 dmc_info->start_mmioaddr = start_mmioaddr;
834
835 rem_size -= header_len_bytes;
836
837 /* fw_size is in dwords, so multiplied by 4 to convert into bytes. */
838 payload_size = dmc_header->fw_size * 4;
839 if (rem_size < payload_size)
840 goto error_truncated;
841
842 if (payload_size > dmc->max_fw_size) {
843 drm_err(display->drm, "DMC FW too big (%u bytes)\n", payload_size);
844 return 0;
845 }
846 dmc_info->dmc_fw_size = dmc_header->fw_size;
847
848 dmc_info->payload = kmalloc(payload_size, GFP_KERNEL);
849 if (!dmc_info->payload)
850 return 0;
851
852 payload = (u8 *)(dmc_header) + header_len_bytes;
853 memcpy(dmc_info->payload, payload, payload_size);
854
855 return header_len_bytes + payload_size;
856
857error_truncated:
858 drm_err(display->drm, "Truncated DMC firmware, refusing.\n");
859 return 0;
860}
861
862static u32
863parse_dmc_fw_package(struct intel_dmc *dmc,
864 const struct intel_package_header *package_header,
865 const struct stepping_info *si,
866 size_t rem_size)
867{
868 struct intel_display *display = dmc->display;
869 u32 package_size = sizeof(struct intel_package_header);
870 u32 num_entries, max_entries;
871 const struct intel_fw_info *fw_info;
872
873 if (rem_size < package_size)
874 goto error_truncated;
875
876 if (package_header->header_ver == 1) {
877 max_entries = PACKAGE_MAX_FW_INFO_ENTRIES;
878 } else if (package_header->header_ver == 2) {
879 max_entries = PACKAGE_V2_MAX_FW_INFO_ENTRIES;
880 } else {
881 drm_err(display->drm, "DMC firmware has unknown header version %u\n",
882 package_header->header_ver);
883 return 0;
884 }
885
886 /*
887 * We should always have space for max_entries,
888 * even if not all are used
889 */
890 package_size += max_entries * sizeof(struct intel_fw_info);
891 if (rem_size < package_size)
892 goto error_truncated;
893
894 if (package_header->header_len * 4 != package_size) {
895 drm_err(display->drm, "DMC firmware has wrong package header length "
896 "(%u bytes)\n", package_size);
897 return 0;
898 }
899
900 num_entries = package_header->num_entries;
901 if (WARN_ON(package_header->num_entries > max_entries))
902 num_entries = max_entries;
903
904 fw_info = (const struct intel_fw_info *)
905 ((u8 *)package_header + sizeof(*package_header));
906 dmc_set_fw_offset(dmc, fw_info, num_entries, si,
907 package_header->header_ver);
908
909 /* dmc_offset is in dwords */
910 return package_size;
911
912error_truncated:
913 drm_err(display->drm, "Truncated DMC firmware, refusing.\n");
914 return 0;
915}
916
917/* Return number of bytes parsed or 0 on error */
918static u32 parse_dmc_fw_css(struct intel_dmc *dmc,
919 struct intel_css_header *css_header,
920 size_t rem_size)
921{
922 struct intel_display *display = dmc->display;
923
924 if (rem_size < sizeof(struct intel_css_header)) {
925 drm_err(display->drm, "Truncated DMC firmware, refusing.\n");
926 return 0;
927 }
928
929 if (sizeof(struct intel_css_header) !=
930 (css_header->header_len * 4)) {
931 drm_err(display->drm, "DMC firmware has wrong CSS header length "
932 "(%u bytes)\n",
933 (css_header->header_len * 4));
934 return 0;
935 }
936
937 dmc->version = css_header->version;
938
939 return sizeof(struct intel_css_header);
940}
941
942static int parse_dmc_fw(struct intel_dmc *dmc, const struct firmware *fw)
943{
944 struct intel_display *display = dmc->display;
945 struct intel_css_header *css_header;
946 struct intel_package_header *package_header;
947 struct intel_dmc_header_base *dmc_header;
948 struct stepping_info display_info = { '*', '*'};
949 const struct stepping_info *si = intel_get_stepping_info(display, &display_info);
950 enum intel_dmc_id dmc_id;
951 u32 readcount = 0;
952 u32 r, offset;
953
954 if (!fw)
955 return -EINVAL;
956
957 /* Extract CSS Header information */
958 css_header = (struct intel_css_header *)fw->data;
959 r = parse_dmc_fw_css(dmc, css_header, fw->size);
960 if (!r)
961 return -EINVAL;
962
963 readcount += r;
964
965 /* Extract Package Header information */
966 package_header = (struct intel_package_header *)&fw->data[readcount];
967 r = parse_dmc_fw_package(dmc, package_header, si, fw->size - readcount);
968 if (!r)
969 return -EINVAL;
970
971 readcount += r;
972
973 for_each_dmc_id(dmc_id) {
974 if (!dmc->dmc_info[dmc_id].present)
975 continue;
976
977 offset = readcount + dmc->dmc_info[dmc_id].dmc_offset * 4;
978 if (offset > fw->size) {
979 drm_err(display->drm, "Reading beyond the fw_size\n");
980 continue;
981 }
982
983 dmc_header = (struct intel_dmc_header_base *)&fw->data[offset];
984 parse_dmc_fw_header(dmc, dmc_header, fw->size - offset, dmc_id);
985 }
986
987 if (!intel_dmc_has_payload(display)) {
988 drm_err(display->drm, "DMC firmware main program not found\n");
989 return -ENOENT;
990 }
991
992 return 0;
993}
994
995static void intel_dmc_runtime_pm_get(struct intel_display *display)
996{
997 struct drm_i915_private *i915 = to_i915(display->drm);
998
999 drm_WARN_ON(display->drm, display->dmc.wakeref);
1000 display->dmc.wakeref = intel_display_power_get(i915, POWER_DOMAIN_INIT);
1001}
1002
1003static void intel_dmc_runtime_pm_put(struct intel_display *display)
1004{
1005 struct drm_i915_private *i915 = to_i915(display->drm);
1006 intel_wakeref_t wakeref __maybe_unused =
1007 fetch_and_zero(&display->dmc.wakeref);
1008
1009 intel_display_power_put(i915, POWER_DOMAIN_INIT, wakeref);
1010}
1011
1012static const char *dmc_fallback_path(struct intel_display *display)
1013{
1014 struct drm_i915_private *i915 = to_i915(display->drm);
1015
1016 if (IS_ALDERLAKE_P(i915))
1017 return ADLP_DMC_FALLBACK_PATH;
1018
1019 return NULL;
1020}
1021
1022static void dmc_load_work_fn(struct work_struct *work)
1023{
1024 struct intel_dmc *dmc = container_of(work, typeof(*dmc), work);
1025 struct intel_display *display = dmc->display;
1026 const struct firmware *fw = NULL;
1027 const char *fallback_path;
1028 int err;
1029
1030 err = request_firmware(&fw, dmc->fw_path, display->drm->dev);
1031
1032 if (err == -ENOENT && !dmc_firmware_param(display)) {
1033 fallback_path = dmc_fallback_path(display);
1034 if (fallback_path) {
1035 drm_dbg_kms(display->drm, "%s not found, falling back to %s\n",
1036 dmc->fw_path, fallback_path);
1037 err = request_firmware(&fw, fallback_path, display->drm->dev);
1038 if (err == 0)
1039 dmc->fw_path = fallback_path;
1040 }
1041 }
1042
1043 if (err) {
1044 drm_notice(display->drm,
1045 "Failed to load DMC firmware %s (%pe). Disabling runtime power management.\n",
1046 dmc->fw_path, ERR_PTR(err));
1047 drm_notice(display->drm, "DMC firmware homepage: %s",
1048 INTEL_DMC_FIRMWARE_URL);
1049 return;
1050 }
1051
1052 err = parse_dmc_fw(dmc, fw);
1053 if (err) {
1054 drm_notice(display->drm,
1055 "Failed to parse DMC firmware %s (%pe). Disabling runtime power management.\n",
1056 dmc->fw_path, ERR_PTR(err));
1057 goto out;
1058 }
1059
1060 intel_dmc_load_program(display);
1061 intel_dmc_runtime_pm_put(display);
1062
1063 drm_info(display->drm, "Finished loading DMC firmware %s (v%u.%u)\n",
1064 dmc->fw_path, DMC_VERSION_MAJOR(dmc->version),
1065 DMC_VERSION_MINOR(dmc->version));
1066
1067out:
1068 release_firmware(fw);
1069}
1070
1071/**
1072 * intel_dmc_init() - initialize the firmware loading.
1073 * @display: display instance
1074 *
1075 * This function is called at the time of loading the display driver to read
1076 * firmware from a .bin file and copied into a internal memory.
1077 */
1078void intel_dmc_init(struct intel_display *display)
1079{
1080 struct drm_i915_private *i915 = to_i915(display->drm);
1081 struct intel_dmc *dmc;
1082
1083 if (!HAS_DMC(display))
1084 return;
1085
1086 /*
1087 * Obtain a runtime pm reference, until DMC is loaded, to avoid entering
1088 * runtime-suspend.
1089 *
1090 * On error, we return with the rpm wakeref held to prevent runtime
1091 * suspend as runtime suspend *requires* a working DMC for whatever
1092 * reason.
1093 */
1094 intel_dmc_runtime_pm_get(display);
1095
1096 dmc = kzalloc(sizeof(*dmc), GFP_KERNEL);
1097 if (!dmc)
1098 return;
1099
1100 dmc->display = display;
1101
1102 INIT_WORK(&dmc->work, dmc_load_work_fn);
1103
1104 dmc->fw_path = dmc_firmware_default(display, &dmc->max_fw_size);
1105
1106 if (dmc_firmware_param_disabled(display)) {
1107 drm_info(display->drm, "Disabling DMC firmware and runtime PM\n");
1108 goto out;
1109 }
1110
1111 if (dmc_firmware_param(display))
1112 dmc->fw_path = dmc_firmware_param(display);
1113
1114 if (!dmc->fw_path) {
1115 drm_dbg_kms(display->drm,
1116 "No known DMC firmware for platform, disabling runtime PM\n");
1117 goto out;
1118 }
1119
1120 display->dmc.dmc = dmc;
1121
1122 drm_dbg_kms(display->drm, "Loading %s\n", dmc->fw_path);
1123 queue_work(i915->unordered_wq, &dmc->work);
1124
1125 return;
1126
1127out:
1128 kfree(dmc);
1129}
1130
1131/**
1132 * intel_dmc_suspend() - prepare DMC firmware before system suspend
1133 * @display: display instance
1134 *
1135 * Prepare the DMC firmware before entering system suspend. This includes
1136 * flushing pending work items and releasing any resources acquired during
1137 * init.
1138 */
1139void intel_dmc_suspend(struct intel_display *display)
1140{
1141 struct intel_dmc *dmc = display_to_dmc(display);
1142
1143 if (!HAS_DMC(display))
1144 return;
1145
1146 if (dmc)
1147 flush_work(&dmc->work);
1148
1149 intel_dmc_wl_disable(display);
1150
1151 /* Drop the reference held in case DMC isn't loaded. */
1152 if (!intel_dmc_has_payload(display))
1153 intel_dmc_runtime_pm_put(display);
1154}
1155
1156/**
1157 * intel_dmc_resume() - init DMC firmware during system resume
1158 * @display: display instance
1159 *
1160 * Reinitialize the DMC firmware during system resume, reacquiring any
1161 * resources released in intel_dmc_suspend().
1162 */
1163void intel_dmc_resume(struct intel_display *display)
1164{
1165 if (!HAS_DMC(display))
1166 return;
1167
1168 /*
1169 * Reacquire the reference to keep RPM disabled in case DMC isn't
1170 * loaded.
1171 */
1172 if (!intel_dmc_has_payload(display))
1173 intel_dmc_runtime_pm_get(display);
1174}
1175
1176/**
1177 * intel_dmc_fini() - unload the DMC firmware.
1178 * @display: display instance
1179 *
1180 * Firmmware unloading includes freeing the internal memory and reset the
1181 * firmware loading status.
1182 */
1183void intel_dmc_fini(struct intel_display *display)
1184{
1185 struct intel_dmc *dmc = display_to_dmc(display);
1186 enum intel_dmc_id dmc_id;
1187
1188 if (!HAS_DMC(display))
1189 return;
1190
1191 intel_dmc_suspend(display);
1192 drm_WARN_ON(display->drm, display->dmc.wakeref);
1193
1194 if (dmc) {
1195 for_each_dmc_id(dmc_id)
1196 kfree(dmc->dmc_info[dmc_id].payload);
1197
1198 kfree(dmc);
1199 display->dmc.dmc = NULL;
1200 }
1201}
1202
1203struct intel_dmc_snapshot {
1204 bool initialized;
1205 bool loaded;
1206 u32 version;
1207};
1208
1209struct intel_dmc_snapshot *intel_dmc_snapshot_capture(struct intel_display *display)
1210{
1211 struct intel_dmc *dmc = display_to_dmc(display);
1212 struct intel_dmc_snapshot *snapshot;
1213
1214 if (!HAS_DMC(display))
1215 return NULL;
1216
1217 snapshot = kzalloc(sizeof(*snapshot), GFP_ATOMIC);
1218 if (!snapshot)
1219 return NULL;
1220
1221 snapshot->initialized = dmc;
1222 snapshot->loaded = intel_dmc_has_payload(display);
1223 if (dmc)
1224 snapshot->version = dmc->version;
1225
1226 return snapshot;
1227}
1228
1229void intel_dmc_snapshot_print(const struct intel_dmc_snapshot *snapshot, struct drm_printer *p)
1230{
1231 if (!snapshot)
1232 return;
1233
1234 drm_printf(p, "DMC initialized: %s\n", str_yes_no(snapshot->initialized));
1235 drm_printf(p, "DMC loaded: %s\n", str_yes_no(snapshot->loaded));
1236 if (snapshot->initialized)
1237 drm_printf(p, "DMC fw version: %d.%d\n",
1238 DMC_VERSION_MAJOR(snapshot->version),
1239 DMC_VERSION_MINOR(snapshot->version));
1240}
1241
1242static int intel_dmc_debugfs_status_show(struct seq_file *m, void *unused)
1243{
1244 struct intel_display *display = m->private;
1245 struct drm_i915_private *i915 = to_i915(display->drm);
1246 struct intel_dmc *dmc = display_to_dmc(display);
1247 intel_wakeref_t wakeref;
1248 i915_reg_t dc5_reg, dc6_reg = INVALID_MMIO_REG;
1249
1250 if (!HAS_DMC(display))
1251 return -ENODEV;
1252
1253 wakeref = intel_runtime_pm_get(&i915->runtime_pm);
1254
1255 seq_printf(m, "DMC initialized: %s\n", str_yes_no(dmc));
1256 seq_printf(m, "fw loaded: %s\n",
1257 str_yes_no(intel_dmc_has_payload(display)));
1258 seq_printf(m, "path: %s\n", dmc ? dmc->fw_path : "N/A");
1259 seq_printf(m, "Pipe A fw needed: %s\n",
1260 str_yes_no(DISPLAY_VER(display) >= 12));
1261 seq_printf(m, "Pipe A fw loaded: %s\n",
1262 str_yes_no(has_dmc_id_fw(display, DMC_FW_PIPEA)));
1263 seq_printf(m, "Pipe B fw needed: %s\n",
1264 str_yes_no(IS_ALDERLAKE_P(i915) ||
1265 DISPLAY_VER(display) >= 14));
1266 seq_printf(m, "Pipe B fw loaded: %s\n",
1267 str_yes_no(has_dmc_id_fw(display, DMC_FW_PIPEB)));
1268
1269 if (!intel_dmc_has_payload(display))
1270 goto out;
1271
1272 seq_printf(m, "version: %d.%d\n", DMC_VERSION_MAJOR(dmc->version),
1273 DMC_VERSION_MINOR(dmc->version));
1274
1275 if (DISPLAY_VER(display) >= 12) {
1276 i915_reg_t dc3co_reg;
1277
1278 if (IS_DGFX(i915) || DISPLAY_VER(display) >= 14) {
1279 dc3co_reg = DG1_DMC_DEBUG3;
1280 dc5_reg = DG1_DMC_DEBUG_DC5_COUNT;
1281 } else {
1282 dc3co_reg = TGL_DMC_DEBUG3;
1283 dc5_reg = TGL_DMC_DEBUG_DC5_COUNT;
1284 dc6_reg = TGL_DMC_DEBUG_DC6_COUNT;
1285 }
1286
1287 seq_printf(m, "DC3CO count: %d\n",
1288 intel_de_read(display, dc3co_reg));
1289 } else {
1290 dc5_reg = IS_BROXTON(i915) ? BXT_DMC_DC3_DC5_COUNT :
1291 SKL_DMC_DC3_DC5_COUNT;
1292 if (!IS_GEMINILAKE(i915) && !IS_BROXTON(i915))
1293 dc6_reg = SKL_DMC_DC5_DC6_COUNT;
1294 }
1295
1296 seq_printf(m, "DC3 -> DC5 count: %d\n", intel_de_read(display, dc5_reg));
1297 if (i915_mmio_reg_valid(dc6_reg))
1298 seq_printf(m, "DC5 -> DC6 count: %d\n",
1299 intel_de_read(display, dc6_reg));
1300
1301 seq_printf(m, "program base: 0x%08x\n",
1302 intel_de_read(display, DMC_PROGRAM(dmc->dmc_info[DMC_FW_MAIN].start_mmioaddr, 0)));
1303
1304out:
1305 seq_printf(m, "ssp base: 0x%08x\n",
1306 intel_de_read(display, DMC_SSP_BASE));
1307 seq_printf(m, "htp: 0x%08x\n", intel_de_read(display, DMC_HTP_SKL));
1308
1309 intel_runtime_pm_put(&i915->runtime_pm, wakeref);
1310
1311 return 0;
1312}
1313
1314DEFINE_SHOW_ATTRIBUTE(intel_dmc_debugfs_status);
1315
1316void intel_dmc_debugfs_register(struct intel_display *display)
1317{
1318 struct drm_minor *minor = display->drm->primary;
1319
1320 debugfs_create_file("i915_dmc_info", 0444, minor->debugfs_root,
1321 display, &intel_dmc_debugfs_status_fops);
1322}
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 */
24
25#include <linux/firmware.h>
26
27#include "i915_drv.h"
28#include "i915_reg.h"
29#include "intel_de.h"
30#include "intel_dmc.h"
31
32/**
33 * DOC: DMC Firmware Support
34 *
35 * From gen9 onwards we have newly added DMC (Display microcontroller) in display
36 * engine to save and restore the state of display engine when it enter into
37 * low-power state and comes back to normal.
38 */
39
40#define DMC_PATH(platform, major, minor) \
41 "i915/" \
42 __stringify(platform) "_dmc_ver" \
43 __stringify(major) "_" \
44 __stringify(minor) ".bin"
45
46#define GEN12_DMC_MAX_FW_SIZE ICL_DMC_MAX_FW_SIZE
47
48#define ADLS_DMC_PATH DMC_PATH(adls, 2, 01)
49#define ADLS_DMC_VERSION_REQUIRED DMC_VERSION(2, 1)
50MODULE_FIRMWARE(ADLS_DMC_PATH);
51
52#define DG1_DMC_PATH DMC_PATH(dg1, 2, 02)
53#define DG1_DMC_VERSION_REQUIRED DMC_VERSION(2, 2)
54MODULE_FIRMWARE(DG1_DMC_PATH);
55
56#define RKL_DMC_PATH DMC_PATH(rkl, 2, 02)
57#define RKL_DMC_VERSION_REQUIRED DMC_VERSION(2, 2)
58MODULE_FIRMWARE(RKL_DMC_PATH);
59
60#define TGL_DMC_PATH DMC_PATH(tgl, 2, 08)
61#define TGL_DMC_VERSION_REQUIRED DMC_VERSION(2, 8)
62MODULE_FIRMWARE(TGL_DMC_PATH);
63
64#define ICL_DMC_PATH DMC_PATH(icl, 1, 09)
65#define ICL_DMC_VERSION_REQUIRED DMC_VERSION(1, 9)
66#define ICL_DMC_MAX_FW_SIZE 0x6000
67MODULE_FIRMWARE(ICL_DMC_PATH);
68
69#define CNL_DMC_PATH DMC_PATH(cnl, 1, 07)
70#define CNL_DMC_VERSION_REQUIRED DMC_VERSION(1, 7)
71#define CNL_DMC_MAX_FW_SIZE GLK_DMC_MAX_FW_SIZE
72MODULE_FIRMWARE(CNL_DMC_PATH);
73
74#define GLK_DMC_PATH DMC_PATH(glk, 1, 04)
75#define GLK_DMC_VERSION_REQUIRED DMC_VERSION(1, 4)
76#define GLK_DMC_MAX_FW_SIZE 0x4000
77MODULE_FIRMWARE(GLK_DMC_PATH);
78
79#define KBL_DMC_PATH DMC_PATH(kbl, 1, 04)
80#define KBL_DMC_VERSION_REQUIRED DMC_VERSION(1, 4)
81#define KBL_DMC_MAX_FW_SIZE BXT_DMC_MAX_FW_SIZE
82MODULE_FIRMWARE(KBL_DMC_PATH);
83
84#define SKL_DMC_PATH DMC_PATH(skl, 1, 27)
85#define SKL_DMC_VERSION_REQUIRED DMC_VERSION(1, 27)
86#define SKL_DMC_MAX_FW_SIZE BXT_DMC_MAX_FW_SIZE
87MODULE_FIRMWARE(SKL_DMC_PATH);
88
89#define BXT_DMC_PATH DMC_PATH(bxt, 1, 07)
90#define BXT_DMC_VERSION_REQUIRED DMC_VERSION(1, 7)
91#define BXT_DMC_MAX_FW_SIZE 0x3000
92MODULE_FIRMWARE(BXT_DMC_PATH);
93
94#define DMC_DEFAULT_FW_OFFSET 0xFFFFFFFF
95#define PACKAGE_MAX_FW_INFO_ENTRIES 20
96#define PACKAGE_V2_MAX_FW_INFO_ENTRIES 32
97#define DMC_V1_MAX_MMIO_COUNT 8
98#define DMC_V3_MAX_MMIO_COUNT 20
99
100struct intel_css_header {
101 /* 0x09 for DMC */
102 u32 module_type;
103
104 /* Includes the DMC specific header in dwords */
105 u32 header_len;
106
107 /* always value would be 0x10000 */
108 u32 header_ver;
109
110 /* Not used */
111 u32 module_id;
112
113 /* Not used */
114 u32 module_vendor;
115
116 /* in YYYYMMDD format */
117 u32 date;
118
119 /* Size in dwords (CSS_Headerlen + PackageHeaderLen + dmc FWsLen)/4 */
120 u32 size;
121
122 /* Not used */
123 u32 key_size;
124
125 /* Not used */
126 u32 modulus_size;
127
128 /* Not used */
129 u32 exponent_size;
130
131 /* Not used */
132 u32 reserved1[12];
133
134 /* Major Minor */
135 u32 version;
136
137 /* Not used */
138 u32 reserved2[8];
139
140 /* Not used */
141 u32 kernel_header_info;
142} __packed;
143
144struct intel_fw_info {
145 u8 reserved1;
146
147 /* reserved on package_header version 1, must be 0 on version 2 */
148 u8 dmc_id;
149
150 /* Stepping (A, B, C, ..., *). * is a wildcard */
151 char stepping;
152
153 /* Sub-stepping (0, 1, ..., *). * is a wildcard */
154 char substepping;
155
156 u32 offset;
157 u32 reserved2;
158} __packed;
159
160struct intel_package_header {
161 /* DMC container header length in dwords */
162 u8 header_len;
163
164 /* 0x01, 0x02 */
165 u8 header_ver;
166
167 u8 reserved[10];
168
169 /* Number of valid entries in the FWInfo array below */
170 u32 num_entries;
171} __packed;
172
173struct intel_dmc_header_base {
174 /* always value would be 0x40403E3E */
175 u32 signature;
176
177 /* DMC binary header length */
178 u8 header_len;
179
180 /* 0x01 */
181 u8 header_ver;
182
183 /* Reserved */
184 u16 dmcc_ver;
185
186 /* Major, Minor */
187 u32 project;
188
189 /* Firmware program size (excluding header) in dwords */
190 u32 fw_size;
191
192 /* Major Minor version */
193 u32 fw_version;
194} __packed;
195
196struct intel_dmc_header_v1 {
197 struct intel_dmc_header_base base;
198
199 /* Number of valid MMIO cycles present. */
200 u32 mmio_count;
201
202 /* MMIO address */
203 u32 mmioaddr[DMC_V1_MAX_MMIO_COUNT];
204
205 /* MMIO data */
206 u32 mmiodata[DMC_V1_MAX_MMIO_COUNT];
207
208 /* FW filename */
209 char dfile[32];
210
211 u32 reserved1[2];
212} __packed;
213
214struct intel_dmc_header_v3 {
215 struct intel_dmc_header_base base;
216
217 /* DMC RAM start MMIO address */
218 u32 start_mmioaddr;
219
220 u32 reserved[9];
221
222 /* FW filename */
223 char dfile[32];
224
225 /* Number of valid MMIO cycles present. */
226 u32 mmio_count;
227
228 /* MMIO address */
229 u32 mmioaddr[DMC_V3_MAX_MMIO_COUNT];
230
231 /* MMIO data */
232 u32 mmiodata[DMC_V3_MAX_MMIO_COUNT];
233} __packed;
234
235struct stepping_info {
236 char stepping;
237 char substepping;
238};
239
240bool intel_dmc_has_payload(struct drm_i915_private *i915)
241{
242 return i915->dmc.dmc_payload;
243}
244
245static const struct stepping_info skl_stepping_info[] = {
246 {'A', '0'}, {'B', '0'}, {'C', '0'},
247 {'D', '0'}, {'E', '0'}, {'F', '0'},
248 {'G', '0'}, {'H', '0'}, {'I', '0'},
249 {'J', '0'}, {'K', '0'}
250};
251
252static const struct stepping_info bxt_stepping_info[] = {
253 {'A', '0'}, {'A', '1'}, {'A', '2'},
254 {'B', '0'}, {'B', '1'}, {'B', '2'}
255};
256
257static const struct stepping_info icl_stepping_info[] = {
258 {'A', '0'}, {'A', '1'}, {'A', '2'},
259 {'B', '0'}, {'B', '2'},
260 {'C', '0'}
261};
262
263static const struct stepping_info no_stepping_info = { '*', '*' };
264
265static const struct stepping_info *
266intel_get_stepping_info(struct drm_i915_private *dev_priv)
267{
268 const struct stepping_info *si;
269 unsigned int size;
270
271 if (IS_ICELAKE(dev_priv)) {
272 size = ARRAY_SIZE(icl_stepping_info);
273 si = icl_stepping_info;
274 } else if (IS_SKYLAKE(dev_priv)) {
275 size = ARRAY_SIZE(skl_stepping_info);
276 si = skl_stepping_info;
277 } else if (IS_BROXTON(dev_priv)) {
278 size = ARRAY_SIZE(bxt_stepping_info);
279 si = bxt_stepping_info;
280 } else {
281 size = 0;
282 si = NULL;
283 }
284
285 if (INTEL_REVID(dev_priv) < size)
286 return si + INTEL_REVID(dev_priv);
287
288 return &no_stepping_info;
289}
290
291static void gen9_set_dc_state_debugmask(struct drm_i915_private *dev_priv)
292{
293 u32 val, mask;
294
295 mask = DC_STATE_DEBUG_MASK_MEMORY_UP;
296
297 if (IS_GEMINILAKE(dev_priv) || IS_BROXTON(dev_priv))
298 mask |= DC_STATE_DEBUG_MASK_CORES;
299
300 /* The below bit doesn't need to be cleared ever afterwards */
301 val = intel_de_read(dev_priv, DC_STATE_DEBUG);
302 if ((val & mask) != mask) {
303 val |= mask;
304 intel_de_write(dev_priv, DC_STATE_DEBUG, val);
305 intel_de_posting_read(dev_priv, DC_STATE_DEBUG);
306 }
307}
308
309/**
310 * intel_dmc_load_program() - write the firmware from memory to register.
311 * @dev_priv: i915 drm device.
312 *
313 * DMC firmware is read from a .bin file and kept in internal memory one time.
314 * Everytime display comes back from low power state this function is called to
315 * copy the firmware from internal memory to registers.
316 */
317void intel_dmc_load_program(struct drm_i915_private *dev_priv)
318{
319 u32 *payload = dev_priv->dmc.dmc_payload;
320 u32 i, fw_size;
321
322 if (!HAS_DMC(dev_priv)) {
323 drm_err(&dev_priv->drm,
324 "No DMC support available for this platform\n");
325 return;
326 }
327
328 if (!intel_dmc_has_payload(dev_priv)) {
329 drm_err(&dev_priv->drm,
330 "Tried to program CSR with empty payload\n");
331 return;
332 }
333
334 fw_size = dev_priv->dmc.dmc_fw_size;
335 assert_rpm_wakelock_held(&dev_priv->runtime_pm);
336
337 preempt_disable();
338
339 for (i = 0; i < fw_size; i++)
340 intel_uncore_write_fw(&dev_priv->uncore, DMC_PROGRAM(i),
341 payload[i]);
342
343 preempt_enable();
344
345 for (i = 0; i < dev_priv->dmc.mmio_count; i++) {
346 intel_de_write(dev_priv, dev_priv->dmc.mmioaddr[i],
347 dev_priv->dmc.mmiodata[i]);
348 }
349
350 dev_priv->dmc.dc_state = 0;
351
352 gen9_set_dc_state_debugmask(dev_priv);
353}
354
355/*
356 * Search fw_info table for dmc_offset to find firmware binary: num_entries is
357 * already sanitized.
358 */
359static u32 find_dmc_fw_offset(const struct intel_fw_info *fw_info,
360 unsigned int num_entries,
361 const struct stepping_info *si,
362 u8 package_ver)
363{
364 u32 dmc_offset = DMC_DEFAULT_FW_OFFSET;
365 unsigned int i;
366
367 for (i = 0; i < num_entries; i++) {
368 if (package_ver > 1 && fw_info[i].dmc_id != 0)
369 continue;
370
371 if (fw_info[i].substepping == '*' &&
372 si->stepping == fw_info[i].stepping) {
373 dmc_offset = fw_info[i].offset;
374 break;
375 }
376
377 if (si->stepping == fw_info[i].stepping &&
378 si->substepping == fw_info[i].substepping) {
379 dmc_offset = fw_info[i].offset;
380 break;
381 }
382
383 if (fw_info[i].stepping == '*' &&
384 fw_info[i].substepping == '*') {
385 /*
386 * In theory we should stop the search as generic
387 * entries should always come after the more specific
388 * ones, but let's continue to make sure to work even
389 * with "broken" firmwares. If we don't find a more
390 * specific one, then we use this entry
391 */
392 dmc_offset = fw_info[i].offset;
393 }
394 }
395
396 return dmc_offset;
397}
398
399static u32 parse_dmc_fw_header(struct intel_dmc *dmc,
400 const struct intel_dmc_header_base *dmc_header,
401 size_t rem_size)
402{
403 struct drm_i915_private *i915 = container_of(dmc, typeof(*i915), dmc);
404 unsigned int header_len_bytes, dmc_header_size, payload_size, i;
405 const u32 *mmioaddr, *mmiodata;
406 u32 mmio_count, mmio_count_max;
407 u8 *payload;
408
409 BUILD_BUG_ON(ARRAY_SIZE(dmc->mmioaddr) < DMC_V3_MAX_MMIO_COUNT ||
410 ARRAY_SIZE(dmc->mmioaddr) < DMC_V1_MAX_MMIO_COUNT);
411
412 /*
413 * Check if we can access common fields, we will checkc again below
414 * after we have read the version
415 */
416 if (rem_size < sizeof(struct intel_dmc_header_base))
417 goto error_truncated;
418
419 /* Cope with small differences between v1 and v3 */
420 if (dmc_header->header_ver == 3) {
421 const struct intel_dmc_header_v3 *v3 =
422 (const struct intel_dmc_header_v3 *)dmc_header;
423
424 if (rem_size < sizeof(struct intel_dmc_header_v3))
425 goto error_truncated;
426
427 mmioaddr = v3->mmioaddr;
428 mmiodata = v3->mmiodata;
429 mmio_count = v3->mmio_count;
430 mmio_count_max = DMC_V3_MAX_MMIO_COUNT;
431 /* header_len is in dwords */
432 header_len_bytes = dmc_header->header_len * 4;
433 dmc_header_size = sizeof(*v3);
434 } else if (dmc_header->header_ver == 1) {
435 const struct intel_dmc_header_v1 *v1 =
436 (const struct intel_dmc_header_v1 *)dmc_header;
437
438 if (rem_size < sizeof(struct intel_dmc_header_v1))
439 goto error_truncated;
440
441 mmioaddr = v1->mmioaddr;
442 mmiodata = v1->mmiodata;
443 mmio_count = v1->mmio_count;
444 mmio_count_max = DMC_V1_MAX_MMIO_COUNT;
445 header_len_bytes = dmc_header->header_len;
446 dmc_header_size = sizeof(*v1);
447 } else {
448 drm_err(&i915->drm, "Unknown DMC fw header version: %u\n",
449 dmc_header->header_ver);
450 return 0;
451 }
452
453 if (header_len_bytes != dmc_header_size) {
454 drm_err(&i915->drm, "DMC firmware has wrong dmc header length "
455 "(%u bytes)\n", header_len_bytes);
456 return 0;
457 }
458
459 /* Cache the dmc header info. */
460 if (mmio_count > mmio_count_max) {
461 drm_err(&i915->drm, "DMC firmware has wrong mmio count %u\n", mmio_count);
462 return 0;
463 }
464
465 for (i = 0; i < mmio_count; i++) {
466 if (mmioaddr[i] < DMC_MMIO_START_RANGE ||
467 mmioaddr[i] > DMC_MMIO_END_RANGE) {
468 drm_err(&i915->drm, "DMC firmware has wrong mmio address 0x%x\n",
469 mmioaddr[i]);
470 return 0;
471 }
472 dmc->mmioaddr[i] = _MMIO(mmioaddr[i]);
473 dmc->mmiodata[i] = mmiodata[i];
474 }
475 dmc->mmio_count = mmio_count;
476
477 rem_size -= header_len_bytes;
478
479 /* fw_size is in dwords, so multiplied by 4 to convert into bytes. */
480 payload_size = dmc_header->fw_size * 4;
481 if (rem_size < payload_size)
482 goto error_truncated;
483
484 if (payload_size > dmc->max_fw_size) {
485 drm_err(&i915->drm, "DMC FW too big (%u bytes)\n", payload_size);
486 return 0;
487 }
488 dmc->dmc_fw_size = dmc_header->fw_size;
489
490 dmc->dmc_payload = kmalloc(payload_size, GFP_KERNEL);
491 if (!dmc->dmc_payload)
492 return 0;
493
494 payload = (u8 *)(dmc_header) + header_len_bytes;
495 memcpy(dmc->dmc_payload, payload, payload_size);
496
497 return header_len_bytes + payload_size;
498
499error_truncated:
500 drm_err(&i915->drm, "Truncated DMC firmware, refusing.\n");
501 return 0;
502}
503
504static u32
505parse_dmc_fw_package(struct intel_dmc *dmc,
506 const struct intel_package_header *package_header,
507 const struct stepping_info *si,
508 size_t rem_size)
509{
510 struct drm_i915_private *i915 = container_of(dmc, typeof(*i915), dmc);
511 u32 package_size = sizeof(struct intel_package_header);
512 u32 num_entries, max_entries, dmc_offset;
513 const struct intel_fw_info *fw_info;
514
515 if (rem_size < package_size)
516 goto error_truncated;
517
518 if (package_header->header_ver == 1) {
519 max_entries = PACKAGE_MAX_FW_INFO_ENTRIES;
520 } else if (package_header->header_ver == 2) {
521 max_entries = PACKAGE_V2_MAX_FW_INFO_ENTRIES;
522 } else {
523 drm_err(&i915->drm, "DMC firmware has unknown header version %u\n",
524 package_header->header_ver);
525 return 0;
526 }
527
528 /*
529 * We should always have space for max_entries,
530 * even if not all are used
531 */
532 package_size += max_entries * sizeof(struct intel_fw_info);
533 if (rem_size < package_size)
534 goto error_truncated;
535
536 if (package_header->header_len * 4 != package_size) {
537 drm_err(&i915->drm, "DMC firmware has wrong package header length "
538 "(%u bytes)\n", package_size);
539 return 0;
540 }
541
542 num_entries = package_header->num_entries;
543 if (WARN_ON(package_header->num_entries > max_entries))
544 num_entries = max_entries;
545
546 fw_info = (const struct intel_fw_info *)
547 ((u8 *)package_header + sizeof(*package_header));
548 dmc_offset = find_dmc_fw_offset(fw_info, num_entries, si,
549 package_header->header_ver);
550 if (dmc_offset == DMC_DEFAULT_FW_OFFSET) {
551 drm_err(&i915->drm, "DMC firmware not supported for %c stepping\n",
552 si->stepping);
553 return 0;
554 }
555
556 /* dmc_offset is in dwords */
557 return package_size + dmc_offset * 4;
558
559error_truncated:
560 drm_err(&i915->drm, "Truncated DMC firmware, refusing.\n");
561 return 0;
562}
563
564/* Return number of bytes parsed or 0 on error */
565static u32 parse_dmc_fw_css(struct intel_dmc *dmc,
566 struct intel_css_header *css_header,
567 size_t rem_size)
568{
569 struct drm_i915_private *i915 = container_of(dmc, typeof(*i915), dmc);
570
571 if (rem_size < sizeof(struct intel_css_header)) {
572 drm_err(&i915->drm, "Truncated DMC firmware, refusing.\n");
573 return 0;
574 }
575
576 if (sizeof(struct intel_css_header) !=
577 (css_header->header_len * 4)) {
578 drm_err(&i915->drm, "DMC firmware has wrong CSS header length "
579 "(%u bytes)\n",
580 (css_header->header_len * 4));
581 return 0;
582 }
583
584 if (dmc->required_version &&
585 css_header->version != dmc->required_version) {
586 drm_info(&i915->drm, "Refusing to load DMC firmware v%u.%u,"
587 " please use v%u.%u\n",
588 DMC_VERSION_MAJOR(css_header->version),
589 DMC_VERSION_MINOR(css_header->version),
590 DMC_VERSION_MAJOR(dmc->required_version),
591 DMC_VERSION_MINOR(dmc->required_version));
592 return 0;
593 }
594
595 dmc->version = css_header->version;
596
597 return sizeof(struct intel_css_header);
598}
599
600static void parse_dmc_fw(struct drm_i915_private *dev_priv,
601 const struct firmware *fw)
602{
603 struct intel_css_header *css_header;
604 struct intel_package_header *package_header;
605 struct intel_dmc_header_base *dmc_header;
606 struct intel_dmc *dmc = &dev_priv->dmc;
607 const struct stepping_info *si = intel_get_stepping_info(dev_priv);
608 u32 readcount = 0;
609 u32 r;
610
611 if (!fw)
612 return;
613
614 /* Extract CSS Header information */
615 css_header = (struct intel_css_header *)fw->data;
616 r = parse_dmc_fw_css(dmc, css_header, fw->size);
617 if (!r)
618 return;
619
620 readcount += r;
621
622 /* Extract Package Header information */
623 package_header = (struct intel_package_header *)&fw->data[readcount];
624 r = parse_dmc_fw_package(dmc, package_header, si, fw->size - readcount);
625 if (!r)
626 return;
627
628 readcount += r;
629
630 /* Extract dmc_header information */
631 dmc_header = (struct intel_dmc_header_base *)&fw->data[readcount];
632 parse_dmc_fw_header(dmc, dmc_header, fw->size - readcount);
633}
634
635static void intel_dmc_runtime_pm_get(struct drm_i915_private *dev_priv)
636{
637 drm_WARN_ON(&dev_priv->drm, dev_priv->dmc.wakeref);
638 dev_priv->dmc.wakeref =
639 intel_display_power_get(dev_priv, POWER_DOMAIN_INIT);
640}
641
642static void intel_dmc_runtime_pm_put(struct drm_i915_private *dev_priv)
643{
644 intel_wakeref_t wakeref __maybe_unused =
645 fetch_and_zero(&dev_priv->dmc.wakeref);
646
647 intel_display_power_put(dev_priv, POWER_DOMAIN_INIT, wakeref);
648}
649
650static void dmc_load_work_fn(struct work_struct *work)
651{
652 struct drm_i915_private *dev_priv;
653 struct intel_dmc *dmc;
654 const struct firmware *fw = NULL;
655
656 dev_priv = container_of(work, typeof(*dev_priv), dmc.work);
657 dmc = &dev_priv->dmc;
658
659 request_firmware(&fw, dev_priv->dmc.fw_path, dev_priv->drm.dev);
660 parse_dmc_fw(dev_priv, fw);
661
662 if (intel_dmc_has_payload(dev_priv)) {
663 intel_dmc_load_program(dev_priv);
664 intel_dmc_runtime_pm_put(dev_priv);
665
666 drm_info(&dev_priv->drm,
667 "Finished loading DMC firmware %s (v%u.%u)\n",
668 dev_priv->dmc.fw_path, DMC_VERSION_MAJOR(dmc->version),
669 DMC_VERSION_MINOR(dmc->version));
670 } else {
671 drm_notice(&dev_priv->drm,
672 "Failed to load DMC firmware %s."
673 " Disabling runtime power management.\n",
674 dmc->fw_path);
675 drm_notice(&dev_priv->drm, "DMC firmware homepage: %s",
676 INTEL_UC_FIRMWARE_URL);
677 }
678
679 release_firmware(fw);
680}
681
682/**
683 * intel_dmc_ucode_init() - initialize the firmware loading.
684 * @dev_priv: i915 drm device.
685 *
686 * This function is called at the time of loading the display driver to read
687 * firmware from a .bin file and copied into a internal memory.
688 */
689void intel_dmc_ucode_init(struct drm_i915_private *dev_priv)
690{
691 struct intel_dmc *dmc = &dev_priv->dmc;
692
693 INIT_WORK(&dev_priv->dmc.work, dmc_load_work_fn);
694
695 if (!HAS_DMC(dev_priv))
696 return;
697
698 /*
699 * Obtain a runtime pm reference, until DMC is loaded, to avoid entering
700 * runtime-suspend.
701 *
702 * On error, we return with the rpm wakeref held to prevent runtime
703 * suspend as runtime suspend *requires* a working DMC for whatever
704 * reason.
705 */
706 intel_dmc_runtime_pm_get(dev_priv);
707
708 if (IS_ALDERLAKE_S(dev_priv)) {
709 dmc->fw_path = ADLS_DMC_PATH;
710 dmc->required_version = ADLS_DMC_VERSION_REQUIRED;
711 dmc->max_fw_size = GEN12_DMC_MAX_FW_SIZE;
712 } else if (IS_DG1(dev_priv)) {
713 dmc->fw_path = DG1_DMC_PATH;
714 dmc->required_version = DG1_DMC_VERSION_REQUIRED;
715 dmc->max_fw_size = GEN12_DMC_MAX_FW_SIZE;
716 } else if (IS_ROCKETLAKE(dev_priv)) {
717 dmc->fw_path = RKL_DMC_PATH;
718 dmc->required_version = RKL_DMC_VERSION_REQUIRED;
719 dmc->max_fw_size = GEN12_DMC_MAX_FW_SIZE;
720 } else if (DISPLAY_VER(dev_priv) >= 12) {
721 dmc->fw_path = TGL_DMC_PATH;
722 dmc->required_version = TGL_DMC_VERSION_REQUIRED;
723 dmc->max_fw_size = GEN12_DMC_MAX_FW_SIZE;
724 } else if (DISPLAY_VER(dev_priv) == 11) {
725 dmc->fw_path = ICL_DMC_PATH;
726 dmc->required_version = ICL_DMC_VERSION_REQUIRED;
727 dmc->max_fw_size = ICL_DMC_MAX_FW_SIZE;
728 } else if (IS_CANNONLAKE(dev_priv)) {
729 dmc->fw_path = CNL_DMC_PATH;
730 dmc->required_version = CNL_DMC_VERSION_REQUIRED;
731 dmc->max_fw_size = CNL_DMC_MAX_FW_SIZE;
732 } else if (IS_GEMINILAKE(dev_priv)) {
733 dmc->fw_path = GLK_DMC_PATH;
734 dmc->required_version = GLK_DMC_VERSION_REQUIRED;
735 dmc->max_fw_size = GLK_DMC_MAX_FW_SIZE;
736 } else if (IS_KABYLAKE(dev_priv) ||
737 IS_COFFEELAKE(dev_priv) ||
738 IS_COMETLAKE(dev_priv)) {
739 dmc->fw_path = KBL_DMC_PATH;
740 dmc->required_version = KBL_DMC_VERSION_REQUIRED;
741 dmc->max_fw_size = KBL_DMC_MAX_FW_SIZE;
742 } else if (IS_SKYLAKE(dev_priv)) {
743 dmc->fw_path = SKL_DMC_PATH;
744 dmc->required_version = SKL_DMC_VERSION_REQUIRED;
745 dmc->max_fw_size = SKL_DMC_MAX_FW_SIZE;
746 } else if (IS_BROXTON(dev_priv)) {
747 dmc->fw_path = BXT_DMC_PATH;
748 dmc->required_version = BXT_DMC_VERSION_REQUIRED;
749 dmc->max_fw_size = BXT_DMC_MAX_FW_SIZE;
750 }
751
752 if (dev_priv->params.dmc_firmware_path) {
753 if (strlen(dev_priv->params.dmc_firmware_path) == 0) {
754 dmc->fw_path = NULL;
755 drm_info(&dev_priv->drm,
756 "Disabling DMC firmware and runtime PM\n");
757 return;
758 }
759
760 dmc->fw_path = dev_priv->params.dmc_firmware_path;
761 /* Bypass version check for firmware override. */
762 dmc->required_version = 0;
763 }
764
765 if (!dmc->fw_path) {
766 drm_dbg_kms(&dev_priv->drm,
767 "No known DMC firmware for platform, disabling runtime PM\n");
768 return;
769 }
770
771 drm_dbg_kms(&dev_priv->drm, "Loading %s\n", dmc->fw_path);
772 schedule_work(&dev_priv->dmc.work);
773}
774
775/**
776 * intel_dmc_ucode_suspend() - prepare DMC firmware before system suspend
777 * @dev_priv: i915 drm device
778 *
779 * Prepare the DMC firmware before entering system suspend. This includes
780 * flushing pending work items and releasing any resources acquired during
781 * init.
782 */
783void intel_dmc_ucode_suspend(struct drm_i915_private *dev_priv)
784{
785 if (!HAS_DMC(dev_priv))
786 return;
787
788 flush_work(&dev_priv->dmc.work);
789
790 /* Drop the reference held in case DMC isn't loaded. */
791 if (!intel_dmc_has_payload(dev_priv))
792 intel_dmc_runtime_pm_put(dev_priv);
793}
794
795/**
796 * intel_dmc_ucode_resume() - init DMC firmware during system resume
797 * @dev_priv: i915 drm device
798 *
799 * Reinitialize the DMC firmware during system resume, reacquiring any
800 * resources released in intel_dmc_ucode_suspend().
801 */
802void intel_dmc_ucode_resume(struct drm_i915_private *dev_priv)
803{
804 if (!HAS_DMC(dev_priv))
805 return;
806
807 /*
808 * Reacquire the reference to keep RPM disabled in case DMC isn't
809 * loaded.
810 */
811 if (!intel_dmc_has_payload(dev_priv))
812 intel_dmc_runtime_pm_get(dev_priv);
813}
814
815/**
816 * intel_dmc_ucode_fini() - unload the DMC firmware.
817 * @dev_priv: i915 drm device.
818 *
819 * Firmmware unloading includes freeing the internal memory and reset the
820 * firmware loading status.
821 */
822void intel_dmc_ucode_fini(struct drm_i915_private *dev_priv)
823{
824 if (!HAS_DMC(dev_priv))
825 return;
826
827 intel_dmc_ucode_suspend(dev_priv);
828 drm_WARN_ON(&dev_priv->drm, dev_priv->dmc.wakeref);
829
830 kfree(dev_priv->dmc.dmc_payload);
831}