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_irq.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
45struct 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 */
57struct 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 */
79struct opregion_swsci {
80	/*FIXME: add it later*/
81} __packed;
82
83/* OpRegion mailbox #3: ASLE */
84struct 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
147static struct psb_intel_opregion *system_opregion;
148
149static u32 asle_set_backlight(struct drm_device *dev, u32 bclp)
150{
151	struct drm_psb_private *dev_priv = to_drm_psb_private(dev);
152	struct opregion_asle *asle = dev_priv->opregion.asle;
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	bclp &= ASLE_BCLP_MSK;
160	if (bclp > 255)
161		return ASLE_BACKLIGHT_FAILED;
162
163	gma_backlight_set(dev, bclp * PSB_MAX_BRIGHTNESS / 255);
164
165	asle->cblv = (bclp * 0x64) / 0xff | ASLE_CBLV_VALID;
166
167	return 0;
168}
169
170static void psb_intel_opregion_asle_work(struct work_struct *work)
171{
172	struct psb_intel_opregion *opregion =
173		container_of(work, struct psb_intel_opregion, asle_work);
174	struct drm_psb_private *dev_priv =
175		container_of(opregion, struct drm_psb_private, opregion);
176	struct opregion_asle *asle = opregion->asle;
177	u32 asle_stat = 0;
178	u32 asle_req;
179
180	if (!asle)
181		return;
182
183	asle_req = asle->aslc & ASLE_REQ_MSK;
184	if (!asle_req) {
185		DRM_DEBUG_DRIVER("non asle set request??\n");
186		return;
187	}
188
189	if (asle_req & ASLE_SET_BACKLIGHT)
190		asle_stat |= asle_set_backlight(&dev_priv->dev, asle->bclp);
191
192	asle->aslc = asle_stat;
193
194}
195
196void psb_intel_opregion_asle_intr(struct drm_device *dev)
197{
198	struct drm_psb_private *dev_priv = to_drm_psb_private(dev);
199
200	if (dev_priv->opregion.asle)
201		schedule_work(&dev_priv->opregion.asle_work);
202}
203
204#define ASLE_ALS_EN    (1<<0)
205#define ASLE_BLC_EN    (1<<1)
206#define ASLE_PFIT_EN   (1<<2)
207#define ASLE_PFMB_EN   (1<<3)
208
209void psb_intel_opregion_enable_asle(struct drm_device *dev)
210{
211	struct drm_psb_private *dev_priv = to_drm_psb_private(dev);
212	struct opregion_asle *asle = dev_priv->opregion.asle;
213
214	if (asle && system_opregion ) {
215		/* Don't do this on Medfield or other non PC like devices, they
216		   use the bit for something different altogether */
217		gma_enable_pipestat(dev_priv, 0, PIPE_LEGACY_BLC_EVENT_ENABLE);
218		gma_enable_pipestat(dev_priv, 1, PIPE_LEGACY_BLC_EVENT_ENABLE);
219
220		asle->tche = ASLE_ALS_EN | ASLE_BLC_EN | ASLE_PFIT_EN
221								| ASLE_PFMB_EN;
222		asle->ardy = 1;
223	}
224}
225
226#define ACPI_EV_DISPLAY_SWITCH (1<<0)
227#define ACPI_EV_LID            (1<<1)
228#define ACPI_EV_DOCK           (1<<2)
229
230
231static int psb_intel_opregion_video_event(struct notifier_block *nb,
232					  unsigned long val, void *data)
233{
234	/* The only video events relevant to opregion are 0x80. These indicate
235	   either a docking event, lid switch or display switch request. In
236	   Linux, these are handled by the dock, button and video drivers.
237	   We might want to fix the video driver to be opregion-aware in
238	   future, but right now we just indicate to the firmware that the
239	   request has been handled */
240
241	struct opregion_acpi *acpi;
242
243	if (!system_opregion)
244		return NOTIFY_DONE;
245
246	acpi = system_opregion->acpi;
247	acpi->csts = 0;
248
249	return NOTIFY_OK;
250}
251
252static struct notifier_block psb_intel_opregion_notifier = {
253	.notifier_call = psb_intel_opregion_video_event,
254};
255
256void psb_intel_opregion_init(struct drm_device *dev)
257{
258	struct drm_psb_private *dev_priv = to_drm_psb_private(dev);
259	struct psb_intel_opregion *opregion = &dev_priv->opregion;
260
261	if (!opregion->header)
262		return;
263
264	if (opregion->acpi) {
265		/* Notify BIOS we are ready to handle ACPI video ext notifs.
266		 * Right now, all the events are handled by the ACPI video
267		 * module. We don't actually need to do anything with them. */
268		opregion->acpi->csts = 0;
269		opregion->acpi->drdy = 1;
270
271		system_opregion = opregion;
272		register_acpi_notifier(&psb_intel_opregion_notifier);
273	}
274}
275
276void psb_intel_opregion_fini(struct drm_device *dev)
277{
278	struct drm_psb_private *dev_priv = to_drm_psb_private(dev);
279	struct psb_intel_opregion *opregion = &dev_priv->opregion;
280
281	if (!opregion->header)
282		return;
283
284	if (opregion->acpi) {
285		opregion->acpi->drdy = 0;
286
287		system_opregion = NULL;
288		unregister_acpi_notifier(&psb_intel_opregion_notifier);
289	}
290
291	cancel_work_sync(&opregion->asle_work);
292
293	/* just clear all opregion memory pointers now */
294	iounmap(opregion->header);
295	opregion->header = NULL;
296	opregion->acpi = NULL;
297	opregion->swsci = NULL;
298	opregion->asle = NULL;
299	opregion->vbt = NULL;
300}
301
302int psb_intel_opregion_setup(struct drm_device *dev)
303{
304	struct drm_psb_private *dev_priv = to_drm_psb_private(dev);
305	struct pci_dev *pdev = to_pci_dev(dev->dev);
306	struct psb_intel_opregion *opregion = &dev_priv->opregion;
307	u32 opregion_phy, mboxes;
308	void __iomem *base;
309	int err = 0;
310
311	pci_read_config_dword(pdev, PCI_ASLS, &opregion_phy);
312	if (opregion_phy == 0) {
313		DRM_DEBUG_DRIVER("ACPI Opregion not supported\n");
314		return -ENOTSUPP;
315	}
316
317	INIT_WORK(&opregion->asle_work, psb_intel_opregion_asle_work);
318
319	DRM_DEBUG("OpRegion detected at 0x%8x\n", opregion_phy);
320	base = acpi_os_ioremap(opregion_phy, 8*1024);
321	if (!base)
322		return -ENOMEM;
323
324	if (memcmp(base, OPREGION_SIGNATURE, 16)) {
325		DRM_DEBUG_DRIVER("opregion signature mismatch\n");
326		err = -EINVAL;
327		goto err_out;
328	}
329
330	opregion->header = base;
331	opregion->vbt = base + OPREGION_VBT_OFFSET;
332
333	opregion->lid_state = base + ACPI_CLID;
334
335	mboxes = opregion->header->mboxes;
336	if (mboxes & MBOX_ACPI) {
337		DRM_DEBUG_DRIVER("Public ACPI methods supported\n");
338		opregion->acpi = base + OPREGION_ACPI_OFFSET;
339	}
340
341	if (mboxes & MBOX_ASLE) {
342		DRM_DEBUG_DRIVER("ASLE supported\n");
343		opregion->asle = base + OPREGION_ASLE_OFFSET;
344	}
345
346	return 0;
347
348err_out:
349	iounmap(base);
350	return err;
351}
352
353