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