ec.c 28.1 KB
Newer Older
L
Linus Torvalds 已提交
1
/*
2
 *  ec.c - ACPI Embedded Controller Driver (v2.1)
L
Linus Torvalds 已提交
3
 *
4
 *  Copyright (C) 2006-2008 Alexey Starikovskiy <astarikovskiy@suse.de>
5
 *  Copyright (C) 2006 Denis Sadykov <denis.m.sadykov@intel.com>
L
Linus Torvalds 已提交
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
 *  Copyright (C) 2004 Luming Yu <luming.yu@intel.com>
 *  Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
 *  Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or (at
 *  your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */

29
/* Uncomment next line to get verbose printout */
30 31
/* #define DEBUG */

L
Linus Torvalds 已提交
32 33 34 35 36
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/types.h>
#include <linux/delay.h>
D
Dmitry Torokhov 已提交
37
#include <linux/interrupt.h>
38
#include <linux/list.h>
39
#include <linux/spinlock.h>
40
#include <linux/slab.h>
L
Linus Torvalds 已提交
41 42 43
#include <asm/io.h>
#include <acpi/acpi_bus.h>
#include <acpi/acpi_drivers.h>
44
#include <linux/dmi.h>
L
Linus Torvalds 已提交
45

46 47
#include "internal.h"

L
Linus Torvalds 已提交
48 49 50
#define ACPI_EC_CLASS			"embedded_controller"
#define ACPI_EC_DEVICE_NAME		"Embedded Controller"
#define ACPI_EC_FILE_INFO		"info"
51

52
#undef PREFIX
53
#define PREFIX				"ACPI: EC: "
54

55
/* EC status register */
L
Linus Torvalds 已提交
56 57
#define ACPI_EC_FLAG_OBF	0x01	/* Output buffer full */
#define ACPI_EC_FLAG_IBF	0x02	/* Input buffer full */
D
Dmitry Torokhov 已提交
58
#define ACPI_EC_FLAG_BURST	0x10	/* burst mode */
L
Linus Torvalds 已提交
59
#define ACPI_EC_FLAG_SCI	0x20	/* EC-SCI occurred */
60

61
/* EC commands */
62
enum ec_command {
A
Alexey Starikovskiy 已提交
63 64 65 66 67
	ACPI_EC_COMMAND_READ = 0x80,
	ACPI_EC_COMMAND_WRITE = 0x81,
	ACPI_EC_BURST_ENABLE = 0x82,
	ACPI_EC_BURST_DISABLE = 0x83,
	ACPI_EC_COMMAND_QUERY = 0x84,
68
};
69

70
#define ACPI_EC_DELAY		500	/* Wait 500ms max. during EC ops */
71
#define ACPI_EC_UDELAY_GLK	1000	/* Wait 1ms max. to get global lock */
72
#define ACPI_EC_MSI_UDELAY	550	/* Wait 550us for MSI EC */
73

74 75
enum {
	EC_FLAGS_QUERY_PENDING,		/* Query is pending */
76
	EC_FLAGS_GPE_STORM,		/* GPE storm detected */
77
	EC_FLAGS_HANDLERS_INSTALLED,	/* Handlers for GPE and
78
					 * OpReg are installed */
79
	EC_FLAGS_BLOCKED,		/* Transactions are blocked */
L
Linus Torvalds 已提交
80
};
81

82 83 84 85 86
/* ec.c is compiled in acpi namespace so this shows up as acpi.ec_delay param */
static unsigned int ec_delay __read_mostly = ACPI_EC_DELAY;
module_param(ec_delay, uint, 0644);
MODULE_PARM_DESC(ec_delay, "Timeout(ms) waited until an EC command completes");

87 88 89 90 91 92 93 94 95
/*
 * If the number of false interrupts per one transaction exceeds
 * this threshold, will think there is a GPE storm happened and
 * will disable the GPE for normal transaction.
 */
static unsigned int ec_storm_threshold  __read_mostly = 8;
module_param(ec_storm_threshold, uint, 0644);
MODULE_PARM_DESC(ec_storm_threshold, "Maxim false GPE numbers not considered as GPE storm");

96
/* If we find an EC via the ECDT, we need to keep a ptr to its context */
97
/* External interfaces use first EC only, so remember */
98 99 100 101 102 103 104 105 106 107
typedef int (*acpi_ec_query_func) (void *data);

struct acpi_ec_query_handler {
	struct list_head node;
	acpi_ec_query_func func;
	acpi_handle handle;
	void *data;
	u8 query_bit;
};

108
struct transaction {
109 110 111
	const u8 *wdata;
	u8 *rdata;
	unsigned short irq_count;
112
	u8 command;
113 114
	u8 wi;
	u8 ri;
115 116
	u8 wlen;
	u8 rlen;
117
	bool done;
118 119
};

120 121
struct acpi_ec *boot_ec, *first_ec;
EXPORT_SYMBOL(first_ec);
122

123
static int EC_FLAGS_MSI; /* Out-of-spec MSI controller */
A
Alexey Starikovskiy 已提交
124
static int EC_FLAGS_VALIDATE_ECDT; /* ASUStec ECDTs need to be validated */
125
static int EC_FLAGS_SKIP_DSDT_SCAN; /* Not all BIOS survive early DSDT scan */
126

L
Linus Torvalds 已提交
127 128 129 130
/* --------------------------------------------------------------------------
                             Transaction Management
   -------------------------------------------------------------------------- */

131
static inline u8 acpi_ec_read_status(struct acpi_ec *ec)
L
Linus Torvalds 已提交
132
{
133
	u8 x = inb(ec->command_addr);
134
	pr_debug(PREFIX "---> status = 0x%2.2x\n", x);
135
	return x;
D
Dmitry Torokhov 已提交
136 137
}

138
static inline u8 acpi_ec_read_data(struct acpi_ec *ec)
139
{
140
	u8 x = inb(ec->data_addr);
141
	pr_debug(PREFIX "---> data = 0x%2.2x\n", x);
142
	return x;
143 144
}

145
static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command)
L
Luming Yu 已提交
146
{
147
	pr_debug(PREFIX "<--- command = 0x%2.2x\n", command);
148
	outb(command, ec->command_addr);
L
Luming Yu 已提交
149 150
}

151
static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data)
L
Luming Yu 已提交
152
{
153
	pr_debug(PREFIX "<--- data = 0x%2.2x\n", data);
154
	outb(data, ec->data_addr);
155
}
L
Luming Yu 已提交
156

157
static int ec_transaction_done(struct acpi_ec *ec)
158
{
159 160
	unsigned long flags;
	int ret = 0;
161
	spin_lock_irqsave(&ec->lock, flags);
162
	if (!ec->curr || ec->curr->done)
163
		ret = 1;
164
	spin_unlock_irqrestore(&ec->lock, flags);
165
	return ret;
L
Luming Yu 已提交
166
}
D
Dmitry Torokhov 已提交
167

168 169 170 171 172 173 174
static void start_transaction(struct acpi_ec *ec)
{
	ec->curr->irq_count = ec->curr->wi = ec->curr->ri = 0;
	ec->curr->done = false;
	acpi_ec_write_cmd(ec, ec->curr->command);
}

175
static void advance_transaction(struct acpi_ec *ec, u8 status)
176
{
177
	unsigned long flags;
178 179
	struct transaction *t = ec->curr;

180
	spin_lock_irqsave(&ec->lock, flags);
181
	if (!t)
182
		goto unlock;
183
	if (t->wlen > t->wi) {
184 185
		if ((status & ACPI_EC_FLAG_IBF) == 0)
			acpi_ec_write_data(ec,
186
				t->wdata[t->wi++]);
187
		else
188
			goto err;
189
	} else if (t->rlen > t->ri) {
190
		if ((status & ACPI_EC_FLAG_OBF) == 1) {
191 192 193
			t->rdata[t->ri++] = acpi_ec_read_data(ec);
			if (t->rlen == t->ri)
				t->done = true;
194
		} else
195
			goto err;
196
	} else if (t->wlen == t->wi &&
197
		   (status & ACPI_EC_FLAG_IBF) == 0)
198
		t->done = true;
199 200
	goto unlock;
err:
201 202 203 204 205
	/*
	 * If SCI bit is set, then don't think it's a false IRQ
	 * otherwise will take a not handled IRQ as a false one.
	 */
	if (in_interrupt() && !(status & ACPI_EC_FLAG_SCI))
206
		++t->irq_count;
207

208
unlock:
209
	spin_unlock_irqrestore(&ec->lock, flags);
A
Alexey Starikovskiy 已提交
210
}
211

212
static int acpi_ec_sync_query(struct acpi_ec *ec);
213

214
static int ec_check_sci_sync(struct acpi_ec *ec, u8 state)
215
{
216 217
	if (state & ACPI_EC_FLAG_SCI) {
		if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags))
218
			return acpi_ec_sync_query(ec);
219 220 221 222 223 224
	}
	return 0;
}

static int ec_poll(struct acpi_ec *ec)
{
225
	unsigned long flags;
226
	int repeat = 5; /* number of command restarts */
227 228
	while (repeat--) {
		unsigned long delay = jiffies +
229
			msecs_to_jiffies(ec_delay);
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
		do {
			/* don't sleep with disabled interrupts */
			if (EC_FLAGS_MSI || irqs_disabled()) {
				udelay(ACPI_EC_MSI_UDELAY);
				if (ec_transaction_done(ec))
					return 0;
			} else {
				if (wait_event_timeout(ec->wait,
						ec_transaction_done(ec),
						msecs_to_jiffies(1)))
					return 0;
			}
			advance_transaction(ec, acpi_ec_read_status(ec));
		} while (time_before(jiffies, delay));
		pr_debug(PREFIX "controller reset, restart transaction\n");
245
		spin_lock_irqsave(&ec->lock, flags);
246
		start_transaction(ec);
247
		spin_unlock_irqrestore(&ec->lock, flags);
248
	}
249
	return -ETIME;
L
Linus Torvalds 已提交
250 251
}

252
static int acpi_ec_transaction_unlocked(struct acpi_ec *ec,
253
					struct transaction *t)
L
Luming Yu 已提交
254
{
255 256
	unsigned long tmp;
	int ret = 0;
257
	if (EC_FLAGS_MSI)
258
		udelay(ACPI_EC_MSI_UDELAY);
259
	/* start transaction */
260
	spin_lock_irqsave(&ec->lock, tmp);
261
	/* following two actions should be kept atomic */
262
	ec->curr = t;
263
	start_transaction(ec);
264
	if (ec->curr->command == ACPI_EC_COMMAND_QUERY)
265
		clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
266
	spin_unlock_irqrestore(&ec->lock, tmp);
267
	ret = ec_poll(ec);
268
	spin_lock_irqsave(&ec->lock, tmp);
269
	ec->curr = NULL;
270
	spin_unlock_irqrestore(&ec->lock, tmp);
271 272 273 274 275 276 277
	return ret;
}

static int ec_check_ibf0(struct acpi_ec *ec)
{
	u8 status = acpi_ec_read_status(ec);
	return (status & ACPI_EC_FLAG_IBF) == 0;
L
Luming Yu 已提交
278 279
}

280 281
static int ec_wait_ibf0(struct acpi_ec *ec)
{
282
	unsigned long delay = jiffies + msecs_to_jiffies(ec_delay);
283 284
	/* interrupt wait manually if GPE mode is not active */
	while (time_before(jiffies, delay))
285 286
		if (wait_event_timeout(ec->wait, ec_check_ibf0(ec),
					msecs_to_jiffies(1)))
287 288
			return 0;
	return -ETIME;
L
Luming Yu 已提交
289 290
}

291
static int acpi_ec_transaction(struct acpi_ec *ec, struct transaction *t)
L
Linus Torvalds 已提交
292
{
293
	int status;
L
Len Brown 已提交
294
	u32 glk;
295
	if (!ec || (!t) || (t->wlen && !t->wdata) || (t->rlen && !t->rdata))
296
		return -EINVAL;
297 298
	if (t->rdata)
		memset(t->rdata, 0, t->rlen);
299
	mutex_lock(&ec->mutex);
300
	if (test_bit(EC_FLAGS_BLOCKED, &ec->flags)) {
301 302 303
		status = -EINVAL;
		goto unlock;
	}
304
	if (ec->global_lock) {
L
Linus Torvalds 已提交
305
		status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
306
		if (ACPI_FAILURE(status)) {
307 308
			status = -ENODEV;
			goto unlock;
309
		}
L
Linus Torvalds 已提交
310
	}
311
	if (ec_wait_ibf0(ec)) {
312 313
		pr_err(PREFIX "input buffer is not empty, "
				"aborting transaction\n");
314
		status = -ETIME;
D
Dmitry Torokhov 已提交
315
		goto end;
316
	}
317 318
	pr_debug(PREFIX "transaction start (cmd=0x%02x, addr=0x%02x)\n",
			t->command, t->wdata ? t->wdata[0] : 0);
319 320
	/* disable GPE during transaction if storm is detected */
	if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) {
321 322
		/* It has to be disabled, so that it doesn't trigger. */
		acpi_disable_gpe(NULL, ec->gpe);
323 324
	}

325
	status = acpi_ec_transaction_unlocked(ec, t);
326 327 328 329

	/* check if we received SCI during transaction */
	ec_check_sci_sync(ec, acpi_ec_read_status(ec));
	if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) {
330
		msleep(1);
331 332
		/* It is safe to enable the GPE outside of the transaction. */
		acpi_enable_gpe(NULL, ec->gpe);
333
	} else if (t->irq_count > ec_storm_threshold) {
334 335 336
		pr_info(PREFIX "GPE storm detected(%d GPEs), "
			"transactions will use polling mode\n",
			t->irq_count);
337 338
		set_bit(EC_FLAGS_GPE_STORM, &ec->flags);
	}
339
	pr_debug(PREFIX "transaction end\n");
340
end:
341
	if (ec->global_lock)
L
Linus Torvalds 已提交
342
		acpi_release_global_lock(glk);
343
unlock:
344
	mutex_unlock(&ec->mutex);
345
	return status;
L
Linus Torvalds 已提交
346 347
}

348
static int acpi_ec_burst_enable(struct acpi_ec *ec)
349 350
{
	u8 d;
351 352 353 354
	struct transaction t = {.command = ACPI_EC_BURST_ENABLE,
				.wdata = NULL, .rdata = &d,
				.wlen = 0, .rlen = 1};

355
	return acpi_ec_transaction(ec, &t);
356 357
}

358
static int acpi_ec_burst_disable(struct acpi_ec *ec)
359
{
360 361 362 363
	struct transaction t = {.command = ACPI_EC_BURST_DISABLE,
				.wdata = NULL, .rdata = NULL,
				.wlen = 0, .rlen = 0};

364
	return (acpi_ec_read_status(ec) & ACPI_EC_FLAG_BURST) ?
365
				acpi_ec_transaction(ec, &t) : 0;
366 367
}

A
Alexey Starikovskiy 已提交
368
static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 * data)
369 370 371
{
	int result;
	u8 d;
372 373 374
	struct transaction t = {.command = ACPI_EC_COMMAND_READ,
				.wdata = &address, .rdata = &d,
				.wlen = 1, .rlen = 1};
375

376
	result = acpi_ec_transaction(ec, &t);
377 378 379
	*data = d;
	return result;
}
380

381 382
static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data)
{
A
Alexey Starikovskiy 已提交
383
	u8 wdata[2] = { address, data };
384 385 386 387
	struct transaction t = {.command = ACPI_EC_COMMAND_WRITE,
				.wdata = wdata, .rdata = NULL,
				.wlen = 2, .rlen = 0};

388
	return acpi_ec_transaction(ec, &t);
389 390
}

L
Linus Torvalds 已提交
391 392 393
/*
 * Externally callable EC access functions. For now, assume 1 EC only
 */
394 395 396 397
int ec_burst_enable(void)
{
	if (!first_ec)
		return -ENODEV;
398
	return acpi_ec_burst_enable(first_ec);
399 400 401 402 403 404 405 406
}

EXPORT_SYMBOL(ec_burst_enable);

int ec_burst_disable(void)
{
	if (!first_ec)
		return -ENODEV;
407
	return acpi_ec_burst_disable(first_ec);
408 409 410 411
}

EXPORT_SYMBOL(ec_burst_disable);

412
int ec_read(u8 addr, u8 *val)
L
Linus Torvalds 已提交
413 414
{
	int err;
415
	u8 temp_data;
L
Linus Torvalds 已提交
416 417 418 419

	if (!first_ec)
		return -ENODEV;

420
	err = acpi_ec_read(first_ec, addr, &temp_data);
L
Linus Torvalds 已提交
421 422 423 424

	if (!err) {
		*val = temp_data;
		return 0;
L
Len Brown 已提交
425
	} else
L
Linus Torvalds 已提交
426 427
		return err;
}
L
Len Brown 已提交
428

L
Linus Torvalds 已提交
429 430
EXPORT_SYMBOL(ec_read);

L
Len Brown 已提交
431
int ec_write(u8 addr, u8 val)
L
Linus Torvalds 已提交
432 433 434 435 436 437
{
	int err;

	if (!first_ec)
		return -ENODEV;

438
	err = acpi_ec_write(first_ec, addr, val);
L
Linus Torvalds 已提交
439 440 441

	return err;
}
L
Len Brown 已提交
442

L
Linus Torvalds 已提交
443 444
EXPORT_SYMBOL(ec_write);

445
int ec_transaction(u8 command,
446
		   const u8 * wdata, unsigned wdata_len,
T
Thomas Renninger 已提交
447
		   u8 * rdata, unsigned rdata_len)
L
Luming Yu 已提交
448
{
449 450 451
	struct transaction t = {.command = command,
				.wdata = wdata, .rdata = rdata,
				.wlen = wdata_len, .rlen = rdata_len};
452 453
	if (!first_ec)
		return -ENODEV;
L
Luming Yu 已提交
454

455
	return acpi_ec_transaction(first_ec, &t);
L
Luming Yu 已提交
456
}
L
Linus Torvalds 已提交
457

458 459
EXPORT_SYMBOL(ec_transaction);

S
Seth Forshee 已提交
460 461 462 463 464 465 466 467 468 469
/* Get the handle to the EC device */
acpi_handle ec_get_handle(void)
{
	if (!first_ec)
		return NULL;
	return first_ec->handle;
}

EXPORT_SYMBOL(ec_get_handle);

470
void acpi_ec_block_transactions(void)
471 472 473 474 475 476
{
	struct acpi_ec *ec = first_ec;

	if (!ec)
		return;

477
	mutex_lock(&ec->mutex);
478
	/* Prevent transactions from being carried out */
479
	set_bit(EC_FLAGS_BLOCKED, &ec->flags);
480
	mutex_unlock(&ec->mutex);
481 482
}

483
void acpi_ec_unblock_transactions(void)
484 485 486 487 488 489
{
	struct acpi_ec *ec = first_ec;

	if (!ec)
		return;

490
	mutex_lock(&ec->mutex);
491
	/* Allow transactions to be carried out again */
492
	clear_bit(EC_FLAGS_BLOCKED, &ec->flags);
493
	mutex_unlock(&ec->mutex);
494 495
}

496
void acpi_ec_unblock_transactions_early(void)
497 498 499 500 501 502
{
	/*
	 * Allow transactions to happen again (this function is called from
	 * atomic context during wakeup, so we don't need to acquire the mutex).
	 */
	if (first_ec)
503
		clear_bit(EC_FLAGS_BLOCKED, &first_ec->flags);
504 505
}

506
static int acpi_ec_query_unlocked(struct acpi_ec *ec, u8 * data)
507 508
{
	int result;
A
Alexey Starikovskiy 已提交
509
	u8 d;
510 511 512
	struct transaction t = {.command = ACPI_EC_COMMAND_QUERY,
				.wdata = NULL, .rdata = &d,
				.wlen = 0, .rlen = 1};
A
Alexey Starikovskiy 已提交
513 514 515 516 517 518 519
	if (!ec || !data)
		return -EINVAL;
	/*
	 * Query the EC to find out which _Qxx method we need to evaluate.
	 * Note that successful completion of the query causes the ACPI_EC_SCI
	 * bit to be cleared (and thus clearing the interrupt source).
	 */
520
	result = acpi_ec_transaction_unlocked(ec, &t);
A
Alexey Starikovskiy 已提交
521 522 523 524 525 526
	if (result)
		return result;
	if (!d)
		return -ENODATA;
	*data = d;
	return 0;
L
Linus Torvalds 已提交
527 528 529 530 531
}

/* --------------------------------------------------------------------------
                                Event Management
   -------------------------------------------------------------------------- */
532 533 534 535 536 537 538 539 540 541 542 543 544
int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit,
			      acpi_handle handle, acpi_ec_query_func func,
			      void *data)
{
	struct acpi_ec_query_handler *handler =
	    kzalloc(sizeof(struct acpi_ec_query_handler), GFP_KERNEL);
	if (!handler)
		return -ENOMEM;

	handler->query_bit = query_bit;
	handler->handle = handle;
	handler->func = func;
	handler->data = data;
545
	mutex_lock(&ec->mutex);
546
	list_add(&handler->node, &ec->list);
547
	mutex_unlock(&ec->mutex);
548 549 550 551 552 553 554
	return 0;
}

EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler);

void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit)
{
A
Adrian Bunk 已提交
555
	struct acpi_ec_query_handler *handler, *tmp;
556
	mutex_lock(&ec->mutex);
A
Adrian Bunk 已提交
557
	list_for_each_entry_safe(handler, tmp, &ec->list, node) {
558 559 560 561 562
		if (query_bit == handler->query_bit) {
			list_del(&handler->node);
			kfree(handler);
		}
	}
563
	mutex_unlock(&ec->mutex);
564 565 566
}

EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler);
L
Linus Torvalds 已提交
567

568
static void acpi_ec_run(void *cxt)
L
Luming Yu 已提交
569
{
570 571
	struct acpi_ec_query_handler *handler = cxt;
	if (!handler)
572
		return;
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
	pr_debug(PREFIX "start query execution\n");
	if (handler->func)
		handler->func(handler->data);
	else if (handler->handle)
		acpi_evaluate_object(handler->handle, NULL, NULL, NULL);
	pr_debug(PREFIX "stop query execution\n");
	kfree(handler);
}

static int acpi_ec_sync_query(struct acpi_ec *ec)
{
	u8 value = 0;
	int status;
	struct acpi_ec_query_handler *handler, *copy;
	if ((status = acpi_ec_query_unlocked(ec, &value)))
		return status;
589 590 591
	list_for_each_entry(handler, &ec->list, node) {
		if (value == handler->query_bit) {
			/* have custom handler for this bit */
592 593 594 595 596
			copy = kmalloc(sizeof(*handler), GFP_KERNEL);
			if (!copy)
				return -ENOMEM;
			memcpy(copy, handler, sizeof(*copy));
			pr_debug(PREFIX "push query execution (0x%2x) on queue\n", value);
597 598
			return acpi_os_execute((copy->func) ?
				OSL_NOTIFY_HANDLER : OSL_GPE_HANDLER,
599
				acpi_ec_run, copy);
600 601
		}
	}
602 603 604 605 606 607 608 609
	return 0;
}

static void acpi_ec_gpe_query(void *ec_cxt)
{
	struct acpi_ec *ec = ec_cxt;
	if (!ec)
		return;
610
	mutex_lock(&ec->mutex);
611
	acpi_ec_sync_query(ec);
612
	mutex_unlock(&ec->mutex);
L
Luming Yu 已提交
613
}
L
Linus Torvalds 已提交
614

615 616 617 618 619 620 621 622 623 624 625 626
static int ec_check_sci(struct acpi_ec *ec, u8 state)
{
	if (state & ACPI_EC_FLAG_SCI) {
		if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags)) {
			pr_debug(PREFIX "push gpe query to the queue\n");
			return acpi_os_execute(OSL_NOTIFY_HANDLER,
				acpi_ec_gpe_query, ec);
		}
	}
	return 0;
}

627 628
static u32 acpi_ec_gpe_handler(acpi_handle gpe_device,
	u32 gpe_number, void *data)
L
Linus Torvalds 已提交
629
{
630
	struct acpi_ec *ec = data;
631
	u8 status = acpi_ec_read_status(ec);
632

633
	pr_debug(PREFIX "~~~> interrupt, status:0x%02x\n", status);
634

635
	advance_transaction(ec, status);
636 637
	if (ec_transaction_done(ec) &&
	    (acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF) == 0) {
638
		wake_up(&ec->wait);
639 640
		ec_check_sci(ec, acpi_ec_read_status(ec));
	}
L
Lin Ming 已提交
641
	return ACPI_INTERRUPT_HANDLED | ACPI_REENABLE_GPE;
A
Alexey Starikovskiy 已提交
642 643
}

L
Linus Torvalds 已提交
644 645 646 647 648
/* --------------------------------------------------------------------------
                             Address Space Management
   -------------------------------------------------------------------------- */

static acpi_status
649
acpi_ec_space_handler(u32 function, acpi_physical_address address,
650
		      u32 bits, u64 *value64,
L
Len Brown 已提交
651
		      void *handler_context, void *region_context)
L
Linus Torvalds 已提交
652
{
653
	struct acpi_ec *ec = handler_context;
654 655
	int result = 0, i, bytes = bits / 8;
	u8 *value = (u8 *)value64;
L
Linus Torvalds 已提交
656 657

	if ((address > 0xFF) || !value || !handler_context)
658
		return AE_BAD_PARAMETER;
L
Linus Torvalds 已提交
659

660
	if (function != ACPI_READ && function != ACPI_WRITE)
661
		return AE_BAD_PARAMETER;
L
Linus Torvalds 已提交
662

663
	if (EC_FLAGS_MSI || bits > 8)
664
		acpi_ec_burst_enable(ec);
665

666 667 668 669
	for (i = 0; i < bytes; ++i, ++address, ++value)
		result = (function == ACPI_READ) ?
			acpi_ec_read(ec, address, value) :
			acpi_ec_write(ec, address, *value);
L
Linus Torvalds 已提交
670

671
	if (EC_FLAGS_MSI || bits > 8)
672
		acpi_ec_burst_disable(ec);
673

L
Linus Torvalds 已提交
674 675
	switch (result) {
	case -EINVAL:
676
		return AE_BAD_PARAMETER;
L
Linus Torvalds 已提交
677 678
		break;
	case -ENODEV:
679
		return AE_NOT_FOUND;
L
Linus Torvalds 已提交
680 681
		break;
	case -ETIME:
682
		return AE_TIME;
L
Linus Torvalds 已提交
683 684
		break;
	default:
685
		return AE_OK;
L
Linus Torvalds 已提交
686 687 688 689 690 691
	}
}

/* --------------------------------------------------------------------------
                               Driver Interface
   -------------------------------------------------------------------------- */
692 693 694 695 696 697 698 699
static acpi_status
ec_parse_io_ports(struct acpi_resource *resource, void *context);

static struct acpi_ec *make_acpi_ec(void)
{
	struct acpi_ec *ec = kzalloc(sizeof(struct acpi_ec), GFP_KERNEL);
	if (!ec)
		return NULL;
700
	ec->flags = 1 << EC_FLAGS_QUERY_PENDING;
701
	mutex_init(&ec->mutex);
702
	init_waitqueue_head(&ec->wait);
703
	INIT_LIST_HEAD(&ec->list);
704
	spin_lock_init(&ec->lock);
705 706
	return ec;
}
707

708 709 710 711
static acpi_status
acpi_ec_register_query_methods(acpi_handle handle, u32 level,
			       void *context, void **return_value)
{
712 713
	char node_name[5];
	struct acpi_buffer buffer = { sizeof(node_name), node_name };
714 715
	struct acpi_ec *ec = context;
	int value = 0;
716 717 718 719 720
	acpi_status status;

	status = acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer);

	if (ACPI_SUCCESS(status) && sscanf(node_name, "_Q%x", &value) == 1) {
721 722 723 724 725
		acpi_ec_add_query_handler(ec, value, handle, NULL, NULL);
	}
	return AE_OK;
}

726 727
static acpi_status
ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval)
728
{
729
	acpi_status status;
730
	unsigned long long tmp = 0;
731 732

	struct acpi_ec *ec = context;
733 734 735 736

	/* clear addr values, ec_parse_io_ports depend on it */
	ec->command_addr = ec->data_addr = 0;

737 738 739 740
	status = acpi_walk_resources(handle, METHOD_NAME__CRS,
				     ec_parse_io_ports, ec);
	if (ACPI_FAILURE(status))
		return status;
741 742 743

	/* Get GPE bit assignment (EC events). */
	/* TODO: Add support for _GPE returning a package */
744
	status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp);
745 746
	if (ACPI_FAILURE(status))
		return status;
747
	ec->gpe = tmp;
748
	/* Use the global lock for all EC transactions? */
749
	tmp = 0;
750 751
	acpi_evaluate_integer(handle, "_GLK", NULL, &tmp);
	ec->global_lock = tmp;
752
	ec->handle = handle;
753
	return AE_CTRL_TERMINATE;
754 755
}

756 757 758 759 760 761 762 763 764 765
static int ec_install_handlers(struct acpi_ec *ec)
{
	acpi_status status;
	if (test_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags))
		return 0;
	status = acpi_install_gpe_handler(NULL, ec->gpe,
				  ACPI_GPE_EDGE_TRIGGERED,
				  &acpi_ec_gpe_handler, ec);
	if (ACPI_FAILURE(status))
		return -ENODEV;
766

767
	acpi_enable_gpe(NULL, ec->gpe);
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
	status = acpi_install_address_space_handler(ec->handle,
						    ACPI_ADR_SPACE_EC,
						    &acpi_ec_space_handler,
						    NULL, ec);
	if (ACPI_FAILURE(status)) {
		if (status == AE_NOT_FOUND) {
			/*
			 * Maybe OS fails in evaluating the _REG object.
			 * The AE_NOT_FOUND error will be ignored and OS
			 * continue to initialize EC.
			 */
			printk(KERN_ERR "Fail in evaluating the _REG object"
				" of EC device. Broken bios is suspected.\n");
		} else {
			acpi_remove_gpe_handler(NULL, ec->gpe,
				&acpi_ec_gpe_handler);
784
			acpi_disable_gpe(NULL, ec->gpe);
785 786 787 788 789 790 791 792
			return -ENODEV;
		}
	}

	set_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags);
	return 0;
}

793 794
static void ec_remove_handlers(struct acpi_ec *ec)
{
795
	acpi_disable_gpe(NULL, ec->gpe);
796 797
	if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle,
				ACPI_ADR_SPACE_EC, &acpi_ec_space_handler)))
798
		pr_err(PREFIX "failed to remove space handler\n");
799 800
	if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe,
				&acpi_ec_gpe_handler)))
801
		pr_err(PREFIX "failed to remove gpe handler\n");
802
	clear_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags);
803 804
}

805
static int acpi_ec_add(struct acpi_device *device)
L
Linus Torvalds 已提交
806
{
807
	struct acpi_ec *ec = NULL;
B
Bjorn Helgaas 已提交
808
	int ret;
L
Luming Yu 已提交
809

810 811 812
	strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
	strcpy(acpi_device_class(device), ACPI_EC_CLASS);

813
	/* Check for boot EC */
814 815 816 817 818 819 820 821 822
	if (boot_ec &&
	    (boot_ec->handle == device->handle ||
	     boot_ec->handle == ACPI_ROOT_OBJECT)) {
		ec = boot_ec;
		boot_ec = NULL;
	} else {
		ec = make_acpi_ec();
		if (!ec)
			return -ENOMEM;
823 824 825
	}
	if (ec_parse_device(device->handle, 0, ec, NULL) !=
		AE_CTRL_TERMINATE) {
826 827
			kfree(ec);
			return -EINVAL;
828 829
	}

830 831
	/* Find and register all query methods */
	acpi_walk_namespace(ACPI_TYPE_METHOD, ec->handle, 1,
832
			    acpi_ec_register_query_methods, NULL, ec, NULL);
833

834 835
	if (!first_ec)
		first_ec = ec;
836
	device->driver_data = ec;
837

838 839 840 841
	ret = !!request_region(ec->data_addr, 1, "EC data");
	WARN(!ret, "Could not request EC data io port 0x%lx", ec->data_addr);
	ret = !!request_region(ec->command_addr, 1, "EC cmd");
	WARN(!ret, "Could not request EC cmd io port 0x%lx", ec->command_addr);
842

843
	pr_info(PREFIX "GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n",
844
			  ec->gpe, ec->command_addr, ec->data_addr);
845 846 847 848 849 850

	ret = ec_install_handlers(ec);

	/* EC is fully operational, allow queries */
	clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
	return ret;
L
Linus Torvalds 已提交
851 852
}

853
static int acpi_ec_remove(struct acpi_device *device)
L
Linus Torvalds 已提交
854
{
855
	struct acpi_ec *ec;
856
	struct acpi_ec_query_handler *handler, *tmp;
L
Linus Torvalds 已提交
857 858

	if (!device)
859
		return -EINVAL;
L
Linus Torvalds 已提交
860 861

	ec = acpi_driver_data(device);
B
Bjorn Helgaas 已提交
862
	ec_remove_handlers(ec);
863
	mutex_lock(&ec->mutex);
864
	list_for_each_entry_safe(handler, tmp, &ec->list, node) {
865 866 867
		list_del(&handler->node);
		kfree(handler);
	}
868
	mutex_unlock(&ec->mutex);
869 870
	release_region(ec->data_addr, 1);
	release_region(ec->command_addr, 1);
871
	device->driver_data = NULL;
872
	if (ec == first_ec)
873
		first_ec = NULL;
874
	kfree(ec);
875
	return 0;
L
Linus Torvalds 已提交
876 877 878
}

static acpi_status
879
ec_parse_io_ports(struct acpi_resource *resource, void *context)
L
Linus Torvalds 已提交
880
{
881
	struct acpi_ec *ec = context;
L
Linus Torvalds 已提交
882

883
	if (resource->type != ACPI_RESOURCE_TYPE_IO)
L
Linus Torvalds 已提交
884 885 886 887 888 889 890
		return AE_OK;

	/*
	 * The first address region returned is the data port, and
	 * the second address region returned is the status/command
	 * port.
	 */
891
	if (ec->data_addr == 0)
892
		ec->data_addr = resource->data.io.minimum;
893
	else if (ec->command_addr == 0)
894
		ec->command_addr = resource->data.io.minimum;
895
	else
L
Linus Torvalds 已提交
896 897 898 899 900
		return AE_CTRL_TERMINATE;

	return AE_OK;
}

901 902
int __init acpi_boot_ec_enable(void)
{
903
	if (!boot_ec || test_bit(EC_FLAGS_HANDLERS_INSTALLED, &boot_ec->flags))
904 905 906 907 908 909 910 911
		return 0;
	if (!ec_install_handlers(boot_ec)) {
		first_ec = boot_ec;
		return 0;
	}
	return -EFAULT;
}

912 913 914 915 916
static const struct acpi_device_id ec_device_ids[] = {
	{"PNP0C09", 0},
	{"", 0},
};

917 918 919 920 921 922 923
/* Some BIOS do not survive early DSDT scan, skip it */
static int ec_skip_dsdt_scan(const struct dmi_system_id *id)
{
	EC_FLAGS_SKIP_DSDT_SCAN = 1;
	return 0;
}

A
Alexey Starikovskiy 已提交
924 925 926 927 928 929 930 931 932 933
/* ASUStek often supplies us with broken ECDT, validate it */
static int ec_validate_ecdt(const struct dmi_system_id *id)
{
	EC_FLAGS_VALIDATE_ECDT = 1;
	return 0;
}

/* MSI EC needs special treatment, enable it */
static int ec_flag_msi(const struct dmi_system_id *id)
{
934
	printk(KERN_DEBUG PREFIX "Detected MSI hardware, enabling workarounds.\n");
A
Alexey Starikovskiy 已提交
935 936 937 938 939
	EC_FLAGS_MSI = 1;
	EC_FLAGS_VALIDATE_ECDT = 1;
	return 0;
}

940 941 942 943 944 945 946 947 948 949 950
/*
 * Clevo M720 notebook actually works ok with IRQ mode, if we lifted
 * the GPE storm threshold back to 20
 */
static int ec_enlarge_storm_threshold(const struct dmi_system_id *id)
{
	pr_debug("Setting the EC GPE storm threshold to 20\n");
	ec_storm_threshold  = 20;
	return 0;
}

A
Alexey Starikovskiy 已提交
951
static struct dmi_system_id __initdata ec_dmi_table[] = {
952 953 954 955
	{
	ec_skip_dsdt_scan, "Compal JFL92", {
	DMI_MATCH(DMI_BIOS_VENDOR, "COMPAL"),
	DMI_MATCH(DMI_BOARD_NAME, "JFL92") }, NULL},
A
Alexey Starikovskiy 已提交
956 957
	{
	ec_flag_msi, "MSI hardware", {
958 959 960 961 962 963 964
	DMI_MATCH(DMI_BIOS_VENDOR, "Micro-Star")}, NULL},
	{
	ec_flag_msi, "MSI hardware", {
	DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star")}, NULL},
	{
	ec_flag_msi, "MSI hardware", {
	DMI_MATCH(DMI_CHASSIS_VENDOR, "MICRO-Star")}, NULL},
A
Alexey Starikovskiy 已提交
965
	{
966 967 968
	ec_flag_msi, "MSI hardware", {
	DMI_MATCH(DMI_CHASSIS_VENDOR, "MICRO-STAR")}, NULL},
	{
969 970 971 972 973 974 975 976
	ec_flag_msi, "Quanta hardware", {
	DMI_MATCH(DMI_SYS_VENDOR, "Quanta"),
	DMI_MATCH(DMI_PRODUCT_NAME, "TW8/SW8/DW8"),}, NULL},
	{
	ec_flag_msi, "Quanta hardware", {
	DMI_MATCH(DMI_SYS_VENDOR, "Quanta"),
	DMI_MATCH(DMI_PRODUCT_NAME, "TW9/SW9"),}, NULL},
	{
A
Alexey Starikovskiy 已提交
977 978
	ec_validate_ecdt, "ASUS hardware", {
	DMI_MATCH(DMI_BIOS_VENDOR, "ASUS") }, NULL},
979 980 981
	{
	ec_validate_ecdt, "ASUS hardware", {
	DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer Inc.") }, NULL},
982 983 984 985
	{
	ec_enlarge_storm_threshold, "CLEVO hardware", {
	DMI_MATCH(DMI_SYS_VENDOR, "CLEVO Co."),
	DMI_MATCH(DMI_PRODUCT_NAME, "M720T/M730T"),}, NULL},
986 987 988 989
	{
	ec_skip_dsdt_scan, "HP Folio 13", {
	DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
	DMI_MATCH(DMI_PRODUCT_NAME, "HP Folio 13"),}, NULL},
A
Alexey Starikovskiy 已提交
990 991 992
	{},
};

993 994 995
int __init acpi_ec_ecdt_probe(void)
{
	acpi_status status;
996
	struct acpi_ec *saved_ec = NULL;
L
Len Brown 已提交
997
	struct acpi_table_ecdt *ecdt_ptr;
L
Luming Yu 已提交
998

999 1000
	boot_ec = make_acpi_ec();
	if (!boot_ec)
1001 1002 1003 1004
		return -ENOMEM;
	/*
	 * Generate a boot ec context
	 */
A
Alexey Starikovskiy 已提交
1005
	dmi_check_system(ec_dmi_table);
1006 1007
	status = acpi_get_table(ACPI_SIG_ECDT, 1,
				(struct acpi_table_header **)&ecdt_ptr);
1008
	if (ACPI_SUCCESS(status)) {
1009
		pr_info(PREFIX "EC description table is found, configuring boot EC\n");
1010 1011 1012
		boot_ec->command_addr = ecdt_ptr->control.address;
		boot_ec->data_addr = ecdt_ptr->data.address;
		boot_ec->gpe = ecdt_ptr->gpe;
1013
		boot_ec->handle = ACPI_ROOT_OBJECT;
1014
		acpi_get_handle(ACPI_ROOT_OBJECT, ecdt_ptr->id, &boot_ec->handle);
1015
		/* Don't trust ECDT, which comes from ASUSTek */
A
Alexey Starikovskiy 已提交
1016
		if (!EC_FLAGS_VALIDATE_ECDT)
1017
			goto install;
J
Julia Lawall 已提交
1018
		saved_ec = kmemdup(boot_ec, sizeof(struct acpi_ec), GFP_KERNEL);
1019 1020
		if (!saved_ec)
			return -ENOMEM;
1021
	/* fall through */
1022
	}
A
Alexey Starikovskiy 已提交
1023

1024 1025 1026
	if (EC_FLAGS_SKIP_DSDT_SCAN)
		return -ENODEV;

1027 1028 1029 1030 1031 1032 1033 1034
	/* This workaround is needed only on some broken machines,
	 * which require early EC, but fail to provide ECDT */
	printk(KERN_DEBUG PREFIX "Look up EC in DSDT\n");
	status = acpi_get_devices(ec_device_ids[0].id, ec_parse_device,
					boot_ec, NULL);
	/* Check that acpi_get_devices actually find something */
	if (ACPI_FAILURE(status) || !boot_ec->handle)
		goto error;
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
	if (saved_ec) {
		/* try to find good ECDT from ASUSTek */
		if (saved_ec->command_addr != boot_ec->command_addr ||
		    saved_ec->data_addr != boot_ec->data_addr ||
		    saved_ec->gpe != boot_ec->gpe ||
		    saved_ec->handle != boot_ec->handle)
			pr_info(PREFIX "ASUSTek keeps feeding us with broken "
			"ECDT tables, which are very hard to workaround. "
			"Trying to use DSDT EC info instead. Please send "
			"output of acpidump to linux-acpi@vger.kernel.org\n");
		kfree(saved_ec);
		saved_ec = NULL;
	} else {
		/* We really need to limit this workaround, the only ASUS,
		* which needs it, has fake EC._INI method, so use it as flag.
		* Keep boot_ec struct as it will be needed soon.
		*/
		acpi_handle dummy;
		if (!dmi_name_in_vendors("ASUS") ||
		    ACPI_FAILURE(acpi_get_handle(boot_ec->handle, "_INI",
							&dummy)))
			return -ENODEV;
	}
1058 1059
install:
	if (!ec_install_handlers(boot_ec)) {
1060
		first_ec = boot_ec;
1061
		return 0;
1062
	}
1063
error:
1064 1065
	kfree(boot_ec);
	boot_ec = NULL;
L
Linus Torvalds 已提交
1066 1067 1068
	return -ENODEV;
}

1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
static struct acpi_driver acpi_ec_driver = {
	.name = "ec",
	.class = ACPI_EC_CLASS,
	.ids = ec_device_ids,
	.ops = {
		.add = acpi_ec_add,
		.remove = acpi_ec_remove,
		},
};

1079
int __init acpi_ec_init(void)
L
Linus Torvalds 已提交
1080
{
L
Len Brown 已提交
1081
	int result = 0;
L
Linus Torvalds 已提交
1082 1083 1084

	/* Now register the driver for the EC */
	result = acpi_bus_register_driver(&acpi_ec_driver);
1085
	if (result < 0)
1086
		return -ENODEV;
L
Linus Torvalds 已提交
1087

1088
	return result;
L
Linus Torvalds 已提交
1089 1090 1091 1092
}

/* EC driver currently not unloadable */
#if 0
L
Len Brown 已提交
1093
static void __exit acpi_ec_exit(void)
L
Linus Torvalds 已提交
1094 1095 1096
{

	acpi_bus_unregister_driver(&acpi_ec_driver);
1097
	return;
L
Linus Torvalds 已提交
1098
}
1099
#endif	/* 0 */