1 /* SPDX-License-Identifier: MIT */
2 /*
3 * Copyright © 2014-2019 Intel Corporation
4 */
5
6 #ifndef _INTEL_UC_H_
7 #define _INTEL_UC_H_
8
9 #include "intel_gsc_uc.h"
10 #include "intel_guc.h"
11 #include "intel_guc_rc.h"
12 #include "intel_guc_submission.h"
13 #include "intel_guc_slpc.h"
14 #include "intel_huc.h"
15 #include "i915_params.h"
16
17 struct intel_uc;
18
19 struct intel_uc_ops {
20 int (*sanitize)(struct intel_uc *uc);
21 void (*init_fw)(struct intel_uc *uc);
22 void (*fini_fw)(struct intel_uc *uc);
23 int (*init)(struct intel_uc *uc);
24 void (*fini)(struct intel_uc *uc);
25 int (*init_hw)(struct intel_uc *uc);
26 void (*fini_hw)(struct intel_uc *uc);
27 };
28
29 struct intel_uc {
30 struct intel_uc_ops const *ops;
31 struct intel_gsc_uc gsc;
32 struct intel_guc guc;
33 struct intel_huc huc;
34
35 /* Snapshot of GuC log from last failed load */
36 struct drm_i915_gem_object *load_err_log;
37
38 bool reset_in_progress;
39 };
40
41 void intel_uc_init_early(struct intel_uc *uc);
42 void intel_uc_init_late(struct intel_uc *uc);
43 void intel_uc_driver_late_release(struct intel_uc *uc);
44 void intel_uc_driver_remove(struct intel_uc *uc);
45 void intel_uc_init_mmio(struct intel_uc *uc);
46 void intel_uc_reset_prepare(struct intel_uc *uc);
47 void intel_uc_reset(struct intel_uc *uc, intel_engine_mask_t stalled);
48 void intel_uc_reset_finish(struct intel_uc *uc);
49 void intel_uc_cancel_requests(struct intel_uc *uc);
50 void intel_uc_suspend(struct intel_uc *uc);
51 void intel_uc_runtime_suspend(struct intel_uc *uc);
52 int intel_uc_resume(struct intel_uc *uc);
53 int intel_uc_runtime_resume(struct intel_uc *uc);
54
55 /*
56 * We need to know as early as possible if we're going to use GuC or not to
57 * take the correct setup paths. Additionally, once we've started loading the
58 * GuC, it is unsafe to keep executing without it because some parts of the HW,
59 * a subset of which is not cleaned on GT reset, will start expecting the GuC FW
60 * to be running.
61 * To solve both these requirements, we commit to using the microcontrollers if
62 * the relevant modparam is set and the blobs are found on the system. At this
63 * stage, the only thing that can stop us from attempting to load the blobs on
64 * the HW and use them is a fundamental issue (e.g. no memory for our
65 * structures); if we hit such a problem during driver load we're broken even
66 * without GuC, so there is no point in trying to fall back.
67 *
68 * Given the above, we can be in one of 4 states, with the last one implying
69 * we're committed to using the microcontroller:
70 * - Not supported: not available in HW and/or firmware not defined.
71 * - Supported: available in HW and firmware defined.
72 * - Wanted: supported + enabled in modparam.
73 * - In use: wanted + firmware found on the system and successfully fetched.
74 */
75
76 #define __uc_state_checker(x, func, state, required) \
77 static inline bool intel_uc_##state##_##func(struct intel_uc *uc) \
78 { \
79 return intel_##func##_is_##required(&uc->x); \
80 }
81
82 #define uc_state_checkers(x, func) \
83 __uc_state_checker(x, func, supports, supported) \
84 __uc_state_checker(x, func, wants, wanted) \
85 __uc_state_checker(x, func, uses, used)
86
87 uc_state_checkers(guc, guc);
88 uc_state_checkers(huc, huc);
89 uc_state_checkers(guc, guc_submission);
90 uc_state_checkers(guc, guc_slpc);
91 uc_state_checkers(guc, guc_rc);
92 uc_state_checkers(gsc, gsc_uc);
93
94 #undef uc_state_checkers
95 #undef __uc_state_checker
96
intel_uc_wait_for_idle(struct intel_uc * uc,long timeout)97 static inline int intel_uc_wait_for_idle(struct intel_uc *uc, long timeout)
98 {
99 return intel_guc_wait_for_idle(&uc->guc, timeout);
100 }
101
102 #define intel_uc_ops_function(_NAME, _OPS, _TYPE, _RET) \
103 static inline _TYPE intel_uc_##_NAME(struct intel_uc *uc) \
104 { \
105 if (uc->ops->_OPS) \
106 return uc->ops->_OPS(uc); \
107 return _RET; \
108 }
109 intel_uc_ops_function(sanitize, sanitize, int, 0);
110 intel_uc_ops_function(fetch_firmwares, init_fw, void, );
111 intel_uc_ops_function(cleanup_firmwares, fini_fw, void, );
112 intel_uc_ops_function(init, init, int, 0);
113 intel_uc_ops_function(fini, fini, void, );
114 intel_uc_ops_function(init_hw, init_hw, int, 0);
115 intel_uc_ops_function(fini_hw, fini_hw, void, );
116 #undef intel_uc_ops_function
117
118 #endif
119