1 /* SPDX-License-Identifier: MIT */
2 /*
3  * Copyright © 2022 Intel Corporation
4  */
5 #ifndef __INTEL_DISPLAY_POWER_WELL_H__
6 #define __INTEL_DISPLAY_POWER_WELL_H__
7 
8 #include <linux/types.h>
9 
10 #include "intel_display_power.h"
11 #include "intel_dpio_phy.h"
12 
13 struct drm_i915_private;
14 struct i915_power_well;
15 
16 #define for_each_power_well(__dev_priv, __power_well)				\
17 	for ((__power_well) = (__dev_priv)->display.power.domains.power_wells;	\
18 	     (__power_well) - (__dev_priv)->display.power.domains.power_wells <	\
19 		(__dev_priv)->display.power.domains.power_well_count;		\
20 	     (__power_well)++)
21 
22 #define for_each_power_well_reverse(__dev_priv, __power_well)			\
23 	for ((__power_well) = (__dev_priv)->display.power.domains.power_wells +		\
24 			      (__dev_priv)->display.power.domains.power_well_count - 1;	\
25 	     (__power_well) - (__dev_priv)->display.power.domains.power_wells >= 0;	\
26 	     (__power_well)--)
27 
28 /*
29  * i915_power_well_id:
30  *
31  * IDs used to look up power wells. Power wells accessed directly bypassing
32  * the power domains framework must be assigned a unique ID. The rest of power
33  * wells must be assigned DISP_PW_ID_NONE.
34  */
35 enum i915_power_well_id {
36 	DISP_PW_ID_NONE = 0,		/* must be kept zero */
37 
38 	VLV_DISP_PW_DISP2D,
39 	BXT_DISP_PW_DPIO_CMN_A,
40 	VLV_DISP_PW_DPIO_CMN_BC,
41 	GLK_DISP_PW_DPIO_CMN_C,
42 	CHV_DISP_PW_DPIO_CMN_D,
43 	HSW_DISP_PW_GLOBAL,
44 	SKL_DISP_PW_MISC_IO,
45 	SKL_DISP_PW_1,
46 	SKL_DISP_PW_2,
47 	ICL_DISP_PW_3,
48 	SKL_DISP_DC_OFF,
49 	TGL_DISP_PW_TC_COLD_OFF,
50 };
51 
52 struct i915_power_well_instance {
53 	const char *name;
54 	const struct i915_power_domain_list {
55 		const enum intel_display_power_domain *list;
56 		u8 count;
57 	} *domain_list;
58 
59 	/* unique identifier for this power well */
60 	enum i915_power_well_id id;
61 	/*
62 	 * Arbitraty data associated with this power well. Platform and power
63 	 * well specific.
64 	 */
65 	union {
66 		struct {
67 			/*
68 			 * request/status flag index in the PUNIT power well
69 			 * control/status registers.
70 			 */
71 			u8 idx;
72 		} vlv;
73 		struct {
74 			enum dpio_phy phy;
75 		} bxt;
76 		struct {
77 			/*
78 			 * request/status flag index in the power well
79 			 * constrol/status registers.
80 			 */
81 			u8 idx;
82 		} hsw;
83 		struct {
84 			u8 aux_ch;
85 		} xelpdp;
86 	};
87 };
88 
89 struct i915_power_well_desc {
90 	const struct i915_power_well_ops *ops;
91 	const struct i915_power_well_instance_list {
92 		const struct i915_power_well_instance *list;
93 		u8 count;
94 	} *instances;
95 
96 	/* Mask of pipes whose IRQ logic is backed by the pw */
97 	u16 irq_pipe_mask:4;
98 	u16 always_on:1;
99 	/*
100 	 * Instead of waiting for the status bit to ack enables,
101 	 * just wait a specific amount of time and then consider
102 	 * the well enabled.
103 	 */
104 	u16 fixed_enable_delay:1;
105 	/* The pw is backing the VGA functionality */
106 	u16 has_vga:1;
107 	u16 has_fuses:1;
108 	/*
109 	 * The pw is for an ICL+ TypeC PHY port in
110 	 * Thunderbolt mode.
111 	 */
112 	u16 is_tc_tbt:1;
113 };
114 
115 struct i915_power_well {
116 	const struct i915_power_well_desc *desc;
117 	struct intel_power_domain_mask domains;
118 	/* power well enable/disable usage count */
119 	int count;
120 	/* cached hw enabled state */
121 	bool hw_enabled;
122 	/* index into desc->instances->list */
123 	u8 instance_idx;
124 };
125 
126 struct i915_power_well *lookup_power_well(struct drm_i915_private *i915,
127 					  enum i915_power_well_id id);
128 
129 void intel_power_well_enable(struct drm_i915_private *i915,
130 			     struct i915_power_well *power_well);
131 void intel_power_well_disable(struct drm_i915_private *i915,
132 			      struct i915_power_well *power_well);
133 void intel_power_well_sync_hw(struct drm_i915_private *i915,
134 			      struct i915_power_well *power_well);
135 void intel_power_well_get(struct drm_i915_private *i915,
136 			  struct i915_power_well *power_well);
137 void intel_power_well_put(struct drm_i915_private *i915,
138 			  struct i915_power_well *power_well);
139 bool intel_power_well_is_enabled(struct drm_i915_private *i915,
140 				 struct i915_power_well *power_well);
141 bool intel_power_well_is_enabled_cached(struct i915_power_well *power_well);
142 bool intel_display_power_well_is_enabled(struct drm_i915_private *dev_priv,
143 					 enum i915_power_well_id power_well_id);
144 bool intel_power_well_is_always_on(struct i915_power_well *power_well);
145 const char *intel_power_well_name(struct i915_power_well *power_well);
146 struct intel_power_domain_mask *intel_power_well_domains(struct i915_power_well *power_well);
147 int intel_power_well_refcount(struct i915_power_well *power_well);
148 
149 void chv_phy_powergate_lanes(struct intel_encoder *encoder,
150 			     bool override, unsigned int mask);
151 bool chv_phy_powergate_ch(struct drm_i915_private *dev_priv, enum dpio_phy phy,
152 			  enum dpio_channel ch, bool override);
153 
154 void gen9_enable_dc5(struct drm_i915_private *dev_priv);
155 void skl_enable_dc6(struct drm_i915_private *dev_priv);
156 void gen9_sanitize_dc_state(struct drm_i915_private *dev_priv);
157 void gen9_set_dc_state(struct drm_i915_private *dev_priv, u32 state);
158 void gen9_disable_dc_states(struct drm_i915_private *dev_priv);
159 void bxt_enable_dc9(struct drm_i915_private *dev_priv);
160 void bxt_disable_dc9(struct drm_i915_private *dev_priv);
161 
162 extern const struct i915_power_well_ops i9xx_always_on_power_well_ops;
163 extern const struct i915_power_well_ops chv_pipe_power_well_ops;
164 extern const struct i915_power_well_ops chv_dpio_cmn_power_well_ops;
165 extern const struct i915_power_well_ops i830_pipes_power_well_ops;
166 extern const struct i915_power_well_ops hsw_power_well_ops;
167 extern const struct i915_power_well_ops gen9_dc_off_power_well_ops;
168 extern const struct i915_power_well_ops bxt_dpio_cmn_power_well_ops;
169 extern const struct i915_power_well_ops vlv_display_power_well_ops;
170 extern const struct i915_power_well_ops vlv_dpio_cmn_power_well_ops;
171 extern const struct i915_power_well_ops vlv_dpio_power_well_ops;
172 extern const struct i915_power_well_ops icl_aux_power_well_ops;
173 extern const struct i915_power_well_ops icl_ddi_power_well_ops;
174 extern const struct i915_power_well_ops tgl_tc_cold_off_ops;
175 extern const struct i915_power_well_ops xelpdp_aux_power_well_ops;
176 
177 #endif
178