xref: /openbmc/linux/drivers/gpu/drm/gma500/opregion.c (revision afc98d90)
1 /*
2  * Copyright 2011 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
21  * DEALINGS IN THE SOFTWARE.
22  *
23  */
24 #include <linux/acpi.h>
25 #include "psb_drv.h"
26 #include "psb_intel_reg.h"
27 
28 #define PCI_ASLE 0xe4
29 #define PCI_ASLS 0xfc
30 
31 #define OPREGION_HEADER_OFFSET 0
32 #define OPREGION_ACPI_OFFSET   0x100
33 #define   ACPI_CLID 0x01ac /* current lid state indicator */
34 #define   ACPI_CDCK 0x01b0 /* current docking state indicator */
35 #define OPREGION_SWSCI_OFFSET  0x200
36 #define OPREGION_ASLE_OFFSET   0x300
37 #define OPREGION_VBT_OFFSET    0x400
38 
39 #define OPREGION_SIGNATURE "IntelGraphicsMem"
40 #define MBOX_ACPI      (1<<0)
41 #define MBOX_SWSCI     (1<<1)
42 #define MBOX_ASLE      (1<<2)
43 
44 struct opregion_header {
45 	u8 signature[16];
46 	u32 size;
47 	u32 opregion_ver;
48 	u8 bios_ver[32];
49 	u8 vbios_ver[16];
50 	u8 driver_ver[16];
51 	u32 mboxes;
52 	u8 reserved[164];
53 } __packed;
54 
55 /* OpRegion mailbox #1: public ACPI methods */
56 struct opregion_acpi {
57 	u32 drdy;	/* driver readiness */
58 	u32 csts;	/* notification status */
59 	u32 cevt;	/* current event */
60 	u8 rsvd1[20];
61 	u32 didl[8];	/* supported display devices ID list */
62 	u32 cpdl[8];	/* currently presented display list */
63 	u32 cadl[8];	/* currently active display list */
64 	u32 nadl[8];	/* next active devices list */
65 	u32 aslp;	/* ASL sleep time-out */
66 	u32 tidx;	/* toggle table index */
67 	u32 chpd;	/* current hotplug enable indicator */
68 	u32 clid;	/* current lid state*/
69 	u32 cdck;	/* current docking state */
70 	u32 sxsw;	/* Sx state resume */
71 	u32 evts;	/* ASL supported events */
72 	u32 cnot;	/* current OS notification */
73 	u32 nrdy;	/* driver status */
74 	u8 rsvd2[60];
75 } __packed;
76 
77 /* OpRegion mailbox #2: SWSCI */
78 struct opregion_swsci {
79 	/*FIXME: add it later*/
80 } __packed;
81 
82 /* OpRegion mailbox #3: ASLE */
83 struct opregion_asle {
84 	u32 ardy;	/* driver readiness */
85 	u32 aslc;	/* ASLE interrupt command */
86 	u32 tche;	/* technology enabled indicator */
87 	u32 alsi;	/* current ALS illuminance reading */
88 	u32 bclp;	/* backlight brightness to set */
89 	u32 pfit;	/* panel fitting state */
90 	u32 cblv;	/* current brightness level */
91 	u16 bclm[20];	/* backlight level duty cycle mapping table */
92 	u32 cpfm;	/* current panel fitting mode */
93 	u32 epfm;	/* enabled panel fitting modes */
94 	u8 plut[74];	/* panel LUT and identifier */
95 	u32 pfmb;	/* PWM freq and min brightness */
96 	u8 rsvd[102];
97 } __packed;
98 
99 /* ASLE irq request bits */
100 #define ASLE_SET_ALS_ILLUM     (1 << 0)
101 #define ASLE_SET_BACKLIGHT     (1 << 1)
102 #define ASLE_SET_PFIT          (1 << 2)
103 #define ASLE_SET_PWM_FREQ      (1 << 3)
104 #define ASLE_REQ_MSK           0xf
105 
106 /* response bits of ASLE irq request */
107 #define ASLE_ALS_ILLUM_FAILED   (1<<10)
108 #define ASLE_BACKLIGHT_FAILED   (1<<12)
109 #define ASLE_PFIT_FAILED        (1<<14)
110 #define ASLE_PWM_FREQ_FAILED    (1<<16)
111 
112 /* ASLE backlight brightness to set */
113 #define ASLE_BCLP_VALID                (1<<31)
114 #define ASLE_BCLP_MSK          (~(1<<31))
115 
116 /* ASLE panel fitting request */
117 #define ASLE_PFIT_VALID         (1<<31)
118 #define ASLE_PFIT_CENTER (1<<0)
119 #define ASLE_PFIT_STRETCH_TEXT (1<<1)
120 #define ASLE_PFIT_STRETCH_GFX (1<<2)
121 
122 /* response bits of ASLE irq request */
123 #define ASLE_ALS_ILLUM_FAILED	(1<<10)
124 #define ASLE_BACKLIGHT_FAILED	(1<<12)
125 #define ASLE_PFIT_FAILED	(1<<14)
126 #define ASLE_PWM_FREQ_FAILED	(1<<16)
127 
128 /* ASLE backlight brightness to set */
129 #define ASLE_BCLP_VALID                (1<<31)
130 #define ASLE_BCLP_MSK          (~(1<<31))
131 
132 /* ASLE panel fitting request */
133 #define ASLE_PFIT_VALID         (1<<31)
134 #define ASLE_PFIT_CENTER (1<<0)
135 #define ASLE_PFIT_STRETCH_TEXT (1<<1)
136 #define ASLE_PFIT_STRETCH_GFX (1<<2)
137 
138 /* PWM frequency and minimum brightness */
139 #define ASLE_PFMB_BRIGHTNESS_MASK (0xff)
140 #define ASLE_PFMB_BRIGHTNESS_VALID (1<<8)
141 #define ASLE_PFMB_PWM_MASK (0x7ffffe00)
142 #define ASLE_PFMB_PWM_VALID (1<<31)
143 
144 #define ASLE_CBLV_VALID         (1<<31)
145 
146 static struct psb_intel_opregion *system_opregion;
147 
148 static u32 asle_set_backlight(struct drm_device *dev, u32 bclp)
149 {
150 	struct drm_psb_private *dev_priv = dev->dev_private;
151 	struct opregion_asle *asle = dev_priv->opregion.asle;
152 	struct backlight_device *bd = dev_priv->backlight_device;
153 
154 	DRM_DEBUG_DRIVER("asle set backlight %x\n", bclp);
155 
156 	if (!(bclp & ASLE_BCLP_VALID))
157 		return ASLE_BACKLIGHT_FAILED;
158 
159 	if (bd == NULL)
160 		return ASLE_BACKLIGHT_FAILED;
161 
162 	bclp &= ASLE_BCLP_MSK;
163 	if (bclp > 255)
164 		return ASLE_BACKLIGHT_FAILED;
165 
166 	if (config_enabled(CONFIG_BACKLIGHT_CLASS_DEVICE)) {
167 		int max = bd->props.max_brightness;
168 		gma_backlight_set(dev, bclp * max / 255);
169 	}
170 
171 	asle->cblv = (bclp * 0x64) / 0xff | ASLE_CBLV_VALID;
172 
173 	return 0;
174 }
175 
176 void psb_intel_opregion_asle_intr(struct drm_device *dev)
177 {
178 	struct drm_psb_private *dev_priv = dev->dev_private;
179 	struct opregion_asle *asle = dev_priv->opregion.asle;
180 	u32 asle_stat = 0;
181 	u32 asle_req;
182 
183 	if (!asle)
184 		return;
185 
186 	asle_req = asle->aslc & ASLE_REQ_MSK;
187 	if (!asle_req) {
188 		DRM_DEBUG_DRIVER("non asle set request??\n");
189 		return;
190 	}
191 
192 	if (asle_req & ASLE_SET_BACKLIGHT)
193 		asle_stat |= asle_set_backlight(dev, asle->bclp);
194 
195 	asle->aslc = asle_stat;
196 }
197 
198 #define ASLE_ALS_EN    (1<<0)
199 #define ASLE_BLC_EN    (1<<1)
200 #define ASLE_PFIT_EN   (1<<2)
201 #define ASLE_PFMB_EN   (1<<3)
202 
203 void psb_intel_opregion_enable_asle(struct drm_device *dev)
204 {
205 	struct drm_psb_private *dev_priv = dev->dev_private;
206 	struct opregion_asle *asle = dev_priv->opregion.asle;
207 
208 	if (asle && system_opregion ) {
209 		/* Don't do this on Medfield or other non PC like devices, they
210 		   use the bit for something different altogether */
211 		psb_enable_pipestat(dev_priv, 0, PIPE_LEGACY_BLC_EVENT_ENABLE);
212 		psb_enable_pipestat(dev_priv, 1, PIPE_LEGACY_BLC_EVENT_ENABLE);
213 
214 		asle->tche = ASLE_ALS_EN | ASLE_BLC_EN | ASLE_PFIT_EN
215 								| ASLE_PFMB_EN;
216 		asle->ardy = 1;
217 	}
218 }
219 
220 #define ACPI_EV_DISPLAY_SWITCH (1<<0)
221 #define ACPI_EV_LID            (1<<1)
222 #define ACPI_EV_DOCK           (1<<2)
223 
224 
225 static int psb_intel_opregion_video_event(struct notifier_block *nb,
226 					  unsigned long val, void *data)
227 {
228 	/* The only video events relevant to opregion are 0x80. These indicate
229 	   either a docking event, lid switch or display switch request. In
230 	   Linux, these are handled by the dock, button and video drivers.
231 	   We might want to fix the video driver to be opregion-aware in
232 	   future, but right now we just indicate to the firmware that the
233 	   request has been handled */
234 
235 	struct opregion_acpi *acpi;
236 
237 	if (!system_opregion)
238 		return NOTIFY_DONE;
239 
240 	acpi = system_opregion->acpi;
241 	acpi->csts = 0;
242 
243 	return NOTIFY_OK;
244 }
245 
246 static struct notifier_block psb_intel_opregion_notifier = {
247 	.notifier_call = psb_intel_opregion_video_event,
248 };
249 
250 void psb_intel_opregion_init(struct drm_device *dev)
251 {
252 	struct drm_psb_private *dev_priv = dev->dev_private;
253 	struct psb_intel_opregion *opregion = &dev_priv->opregion;
254 
255 	if (!opregion->header)
256 		return;
257 
258 	if (opregion->acpi) {
259 		/* Notify BIOS we are ready to handle ACPI video ext notifs.
260 		 * Right now, all the events are handled by the ACPI video
261 		 * module. We don't actually need to do anything with them. */
262 		opregion->acpi->csts = 0;
263 		opregion->acpi->drdy = 1;
264 
265 		system_opregion = opregion;
266 		register_acpi_notifier(&psb_intel_opregion_notifier);
267 	}
268 }
269 
270 void psb_intel_opregion_fini(struct drm_device *dev)
271 {
272 	struct drm_psb_private *dev_priv = dev->dev_private;
273 	struct psb_intel_opregion *opregion = &dev_priv->opregion;
274 
275 	if (!opregion->header)
276 		return;
277 
278 	if (opregion->acpi) {
279 		opregion->acpi->drdy = 0;
280 
281 		system_opregion = NULL;
282 		unregister_acpi_notifier(&psb_intel_opregion_notifier);
283 	}
284 
285 	/* just clear all opregion memory pointers now */
286 	iounmap(opregion->header);
287 	opregion->header = NULL;
288 	opregion->acpi = NULL;
289 	opregion->swsci = NULL;
290 	opregion->asle = NULL;
291 	opregion->vbt = NULL;
292 }
293 
294 int psb_intel_opregion_setup(struct drm_device *dev)
295 {
296 	struct drm_psb_private *dev_priv = dev->dev_private;
297 	struct psb_intel_opregion *opregion = &dev_priv->opregion;
298 	u32 opregion_phy, mboxes;
299 	void __iomem *base;
300 	int err = 0;
301 
302 	pci_read_config_dword(dev->pdev, PCI_ASLS, &opregion_phy);
303 	if (opregion_phy == 0) {
304 		DRM_DEBUG_DRIVER("ACPI Opregion not supported\n");
305 		return -ENOTSUPP;
306 	}
307 	DRM_DEBUG("OpRegion detected at 0x%8x\n", opregion_phy);
308 	base = acpi_os_ioremap(opregion_phy, 8*1024);
309 	if (!base)
310 		return -ENOMEM;
311 
312 	if (memcmp(base, OPREGION_SIGNATURE, 16)) {
313 		DRM_DEBUG_DRIVER("opregion signature mismatch\n");
314 		err = -EINVAL;
315 		goto err_out;
316 	}
317 
318 	opregion->header = base;
319 	opregion->vbt = base + OPREGION_VBT_OFFSET;
320 
321 	opregion->lid_state = base + ACPI_CLID;
322 
323 	mboxes = opregion->header->mboxes;
324 	if (mboxes & MBOX_ACPI) {
325 		DRM_DEBUG_DRIVER("Public ACPI methods supported\n");
326 		opregion->acpi = base + OPREGION_ACPI_OFFSET;
327 	}
328 
329 	if (mboxes & MBOX_ASLE) {
330 		DRM_DEBUG_DRIVER("ASLE supported\n");
331 		opregion->asle = base + OPREGION_ASLE_OFFSET;
332 	}
333 
334 	return 0;
335 
336 err_out:
337 	iounmap(base);
338 	return err;
339 }
340 
341