2 * Copyright © 2017 Intel Corporation
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:
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
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
25 #ifndef __INTEL_UNCORE_H__
26 #define __INTEL_UNCORE_H__
28 struct drm_i915_private;
30 enum forcewake_domain_id {
31 FW_DOMAIN_ID_RENDER = 0,
38 enum forcewake_domains {
39 FORCEWAKE_RENDER = BIT(FW_DOMAIN_ID_RENDER),
40 FORCEWAKE_BLITTER = BIT(FW_DOMAIN_ID_BLITTER),
41 FORCEWAKE_MEDIA = BIT(FW_DOMAIN_ID_MEDIA),
42 FORCEWAKE_ALL = (FORCEWAKE_RENDER |
47 struct intel_uncore_funcs {
48 void (*force_wake_get)(struct drm_i915_private *dev_priv,
49 enum forcewake_domains domains);
50 void (*force_wake_put)(struct drm_i915_private *dev_priv,
51 enum forcewake_domains domains);
53 uint8_t (*mmio_readb)(struct drm_i915_private *dev_priv,
54 i915_reg_t r, bool trace);
55 uint16_t (*mmio_readw)(struct drm_i915_private *dev_priv,
56 i915_reg_t r, bool trace);
57 uint32_t (*mmio_readl)(struct drm_i915_private *dev_priv,
58 i915_reg_t r, bool trace);
59 uint64_t (*mmio_readq)(struct drm_i915_private *dev_priv,
60 i915_reg_t r, bool trace);
62 void (*mmio_writeb)(struct drm_i915_private *dev_priv,
63 i915_reg_t r, uint8_t val, bool trace);
64 void (*mmio_writew)(struct drm_i915_private *dev_priv,
65 i915_reg_t r, uint16_t val, bool trace);
66 void (*mmio_writel)(struct drm_i915_private *dev_priv,
67 i915_reg_t r, uint32_t val, bool trace);
70 struct intel_forcewake_range {
74 enum forcewake_domains domains;
78 spinlock_t lock; /** lock is also taken in irq contexts. */
80 const struct intel_forcewake_range *fw_domains_table;
81 unsigned int fw_domains_table_entries;
83 struct notifier_block pmic_bus_access_nb;
84 struct intel_uncore_funcs funcs;
86 unsigned int fifo_count;
88 enum forcewake_domains fw_domains;
89 enum forcewake_domains fw_domains_active;
95 struct intel_uncore_forcewake_domain {
96 enum forcewake_domain_id id;
97 enum forcewake_domains mask;
98 unsigned int wake_count;
100 struct hrtimer timer;
103 } fw_domain[FW_DOMAIN_ID_COUNT];
105 int unclaimed_mmio_check;
108 /* Iterate over initialised fw domains */
109 #define for_each_fw_domain_masked(domain__, mask__, dev_priv__, tmp__) \
110 for (tmp__ = (mask__); \
111 tmp__ ? (domain__ = &(dev_priv__)->uncore.fw_domain[__mask_next_bit(tmp__)]), 1 : 0;)
113 #define for_each_fw_domain(domain__, dev_priv__, tmp__) \
114 for_each_fw_domain_masked(domain__, (dev_priv__)->uncore.fw_domains, dev_priv__, tmp__)
117 void intel_uncore_sanitize(struct drm_i915_private *dev_priv);
118 void intel_uncore_init(struct drm_i915_private *dev_priv);
119 bool intel_uncore_unclaimed_mmio(struct drm_i915_private *dev_priv);
120 bool intel_uncore_arm_unclaimed_mmio_detection(struct drm_i915_private *dev_priv);
121 void intel_uncore_fini(struct drm_i915_private *dev_priv);
122 void intel_uncore_suspend(struct drm_i915_private *dev_priv);
123 void intel_uncore_resume_early(struct drm_i915_private *dev_priv);
125 u64 intel_uncore_edram_size(struct drm_i915_private *dev_priv);
126 void assert_forcewakes_inactive(struct drm_i915_private *dev_priv);
127 const char *intel_uncore_forcewake_domain_to_str(const enum forcewake_domain_id id);
129 enum forcewake_domains
130 intel_uncore_forcewake_for_reg(struct drm_i915_private *dev_priv,
131 i915_reg_t reg, unsigned int op);
132 #define FW_REG_READ (1)
133 #define FW_REG_WRITE (2)
135 void intel_uncore_forcewake_get(struct drm_i915_private *dev_priv,
136 enum forcewake_domains domains);
137 void intel_uncore_forcewake_put(struct drm_i915_private *dev_priv,
138 enum forcewake_domains domains);
139 /* Like above but the caller must manage the uncore.lock itself.
140 * Must be used with I915_READ_FW and friends.
142 void intel_uncore_forcewake_get__locked(struct drm_i915_private *dev_priv,
143 enum forcewake_domains domains);
144 void intel_uncore_forcewake_put__locked(struct drm_i915_private *dev_priv,
145 enum forcewake_domains domains);
147 int intel_wait_for_register(struct drm_i915_private *dev_priv,
151 unsigned int timeout_ms);
152 int __intel_wait_for_register_fw(struct drm_i915_private *dev_priv,
156 unsigned int fast_timeout_us,
157 unsigned int slow_timeout_ms,
160 int intel_wait_for_register_fw(struct drm_i915_private *dev_priv,
164 unsigned int timeout_ms)
166 return __intel_wait_for_register_fw(dev_priv, reg, mask, value,
167 2, timeout_ms, NULL);
170 #endif /* !__INTEL_UNCORE_H__ */