ec.c 27.2 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 48

#define ACPI_EC_CLASS			"embedded_controller"
#define ACPI_EC_DEVICE_NAME		"Embedded Controller"
#define ACPI_EC_FILE_INFO		"info"
49

50
#define PREFIX				"ACPI: EC: "
51

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

58
/* EC commands */
59
enum ec_command {
A
Alexey Starikovskiy 已提交
60 61 62 63 64
	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,
65
};
66

67
#define ACPI_EC_DELAY		500	/* Wait 500ms max. during EC ops */
68
#define ACPI_EC_UDELAY_GLK	1000	/* Wait 1ms max. to get global lock */
69
#define ACPI_EC_CDELAY		10	/* Wait 10us before polling EC */
70
#define ACPI_EC_MSI_UDELAY	550	/* Wait 550us for MSI EC */
71

72
#define ACPI_EC_STORM_THRESHOLD 8	/* number of false interrupts
73 74
					   per one transaction */

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

/* If we find an EC via the ECDT, we need to keep a ptr to its context */
84
/* External interfaces use first EC only, so remember */
85 86 87 88 89 90 91 92 93 94
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;
};

95
struct transaction {
96 97 98
	const u8 *wdata;
	u8 *rdata;
	unsigned short irq_count;
99
	u8 command;
100 101
	u8 wi;
	u8 ri;
102 103
	u8 wlen;
	u8 rlen;
104
	bool done;
105 106
};

107
static struct acpi_ec {
108
	acpi_handle handle;
109
	unsigned long gpe;
110 111
	unsigned long command_addr;
	unsigned long data_addr;
112
	unsigned long global_lock;
113
	unsigned long flags;
114
	struct mutex lock;
115
	wait_queue_head_t wait;
116
	struct list_head list;
117 118
	struct transaction *curr;
	spinlock_t curr_lock;
119
} *boot_ec, *first_ec;
120

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

L
Linus Torvalds 已提交
125 126 127 128
/* --------------------------------------------------------------------------
                             Transaction Management
   -------------------------------------------------------------------------- */

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

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

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

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

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

166 167 168 169 170 171 172
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);
}

173
static void advance_transaction(struct acpi_ec *ec, u8 status)
174
{
175
	unsigned long flags;
176 177
	spin_lock_irqsave(&ec->curr_lock, flags);
	if (!ec->curr)
178
		goto unlock;
179 180 181 182 183
	if (ec->curr->wlen > ec->curr->wi) {
		if ((status & ACPI_EC_FLAG_IBF) == 0)
			acpi_ec_write_data(ec,
				ec->curr->wdata[ec->curr->wi++]);
		else
184
			goto err;
185
	} else if (ec->curr->rlen > ec->curr->ri) {
186
		if ((status & ACPI_EC_FLAG_OBF) == 1) {
187 188
			ec->curr->rdata[ec->curr->ri++] = acpi_ec_read_data(ec);
			if (ec->curr->rlen == ec->curr->ri)
189
				ec->curr->done = true;
190
		} else
191
			goto err;
192 193
	} else if (ec->curr->wlen == ec->curr->wi &&
		   (status & ACPI_EC_FLAG_IBF) == 0)
194 195 196 197
		ec->curr->done = true;
	goto unlock;
err:
	/* false interrupt, state didn't change */
198 199
	if (in_interrupt())
		++ec->curr->irq_count;
200
unlock:
201
	spin_unlock_irqrestore(&ec->curr_lock, flags);
A
Alexey Starikovskiy 已提交
202
}
203

204
static int acpi_ec_sync_query(struct acpi_ec *ec);
205

206
static int ec_check_sci_sync(struct acpi_ec *ec, u8 state)
207
{
208 209
	if (state & ACPI_EC_FLAG_SCI) {
		if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags))
210
			return acpi_ec_sync_query(ec);
211 212 213 214 215 216
	}
	return 0;
}

static int ec_poll(struct acpi_ec *ec)
{
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
	unsigned long flags;
	int repeat = 2; /* number of command restarts */
	while (repeat--) {
		unsigned long delay = jiffies +
			msecs_to_jiffies(ACPI_EC_DELAY);
		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));
236
		if (acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF)
237 238 239 240 241
			break;
		pr_debug(PREFIX "controller reset, restart transaction\n");
		spin_lock_irqsave(&ec->curr_lock, flags);
		start_transaction(ec);
		spin_unlock_irqrestore(&ec->curr_lock, flags);
242
	}
243
	return -ETIME;
L
Linus Torvalds 已提交
244 245
}

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

274 275 276 277 278
static int ec_wait_ibf0(struct acpi_ec *ec)
{
	unsigned long delay = jiffies + msecs_to_jiffies(ACPI_EC_DELAY);
	/* interrupt wait manually if GPE mode is not active */
	while (time_before(jiffies, delay))
279 280
		if (wait_event_timeout(ec->wait, ec_check_ibf0(ec),
					msecs_to_jiffies(1)))
281 282
			return 0;
	return -ETIME;
L
Luming Yu 已提交
283 284
}

285
static int acpi_ec_transaction(struct acpi_ec *ec, struct transaction *t)
L
Linus Torvalds 已提交
286
{
287
	int status;
L
Len Brown 已提交
288
	u32 glk;
289
	if (!ec || (!t) || (t->wlen && !t->wdata) || (t->rlen && !t->rdata))
290
		return -EINVAL;
291 292
	if (t->rdata)
		memset(t->rdata, 0, t->rlen);
293
	mutex_lock(&ec->lock);
294
	if (test_bit(EC_FLAGS_BLOCKED, &ec->flags)) {
295 296 297
		status = -EINVAL;
		goto unlock;
	}
298
	if (ec->global_lock) {
L
Linus Torvalds 已提交
299
		status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
300
		if (ACPI_FAILURE(status)) {
301 302
			status = -ENODEV;
			goto unlock;
303
		}
L
Linus Torvalds 已提交
304
	}
305
	if (ec_wait_ibf0(ec)) {
306 307
		pr_err(PREFIX "input buffer is not empty, "
				"aborting transaction\n");
308
		status = -ETIME;
D
Dmitry Torokhov 已提交
309
		goto end;
310
	}
311 312 313
	pr_debug(PREFIX "transaction start\n");
	/* disable GPE during transaction if storm is detected */
	if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) {
314 315 316 317
		/*
		 * It has to be disabled at the hardware level regardless of the
		 * GPE reference counting, so that it doesn't trigger.
		 */
318
		acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_DISABLE);
319 320
	}

321
	status = acpi_ec_transaction_unlocked(ec, t);
322 323 324 325

	/* 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)) {
326
		msleep(1);
327 328 329 330 331
		/*
		 * It is safe to enable the GPE outside of the transaction.  Use
		 * acpi_set_gpe() for that, since we used it to disable the GPE
		 * above.
		 */
332
		acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_ENABLE);
333 334 335 336 337
	} else if (t->irq_count > ACPI_EC_STORM_THRESHOLD) {
		pr_info(PREFIX "GPE storm detected, "
			"transactions will use polling mode\n");
		set_bit(EC_FLAGS_GPE_STORM, &ec->flags);
	}
338
	pr_debug(PREFIX "transaction end\n");
339
end:
340
	if (ec->global_lock)
L
Linus Torvalds 已提交
341
		acpi_release_global_lock(glk);
342
unlock:
343
	mutex_unlock(&ec->lock);
344
	return status;
L
Linus Torvalds 已提交
345 346
}

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

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

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

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

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

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

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

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

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

EXPORT_SYMBOL(ec_burst_enable);

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

EXPORT_SYMBOL(ec_burst_disable);

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

	if (!first_ec)
		return -ENODEV;

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

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

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

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

	if (!first_ec)
		return -ENODEV;

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

	return err;
}
L
Len Brown 已提交
441

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

444
int ec_transaction(u8 command,
445
		   const u8 * wdata, unsigned wdata_len,
446 447
		   u8 * rdata, unsigned rdata_len,
		   int force_poll)
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);

460
void acpi_ec_block_transactions(void)
461 462 463 464 465 466 467 468
{
	struct acpi_ec *ec = first_ec;

	if (!ec)
		return;

	mutex_lock(&ec->lock);
	/* Prevent transactions from being carried out */
469
	set_bit(EC_FLAGS_BLOCKED, &ec->flags);
470 471 472
	mutex_unlock(&ec->lock);
}

473
void acpi_ec_unblock_transactions(void)
474 475 476 477 478 479 480 481
{
	struct acpi_ec *ec = first_ec;

	if (!ec)
		return;

	mutex_lock(&ec->lock);
	/* Allow transactions to be carried out again */
482
	clear_bit(EC_FLAGS_BLOCKED, &ec->flags);
483 484 485
	mutex_unlock(&ec->lock);
}

486
void acpi_ec_unblock_transactions_early(void)
487 488 489 490 491 492
{
	/*
	 * 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)
493
		clear_bit(EC_FLAGS_BLOCKED, &first_ec->flags);
494 495
}

496
static int acpi_ec_query_unlocked(struct acpi_ec *ec, u8 * data)
497 498
{
	int result;
A
Alexey Starikovskiy 已提交
499
	u8 d;
500 501 502
	struct transaction t = {.command = ACPI_EC_COMMAND_QUERY,
				.wdata = NULL, .rdata = &d,
				.wlen = 0, .rlen = 1};
A
Alexey Starikovskiy 已提交
503 504 505 506 507 508 509
	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).
	 */
510
	result = acpi_ec_transaction_unlocked(ec, &t);
A
Alexey Starikovskiy 已提交
511 512 513 514 515 516
	if (result)
		return result;
	if (!d)
		return -ENODATA;
	*data = d;
	return 0;
L
Linus Torvalds 已提交
517 518 519 520 521
}

/* --------------------------------------------------------------------------
                                Event Management
   -------------------------------------------------------------------------- */
522 523 524 525 526 527 528 529 530 531 532 533 534 535
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;
	mutex_lock(&ec->lock);
536
	list_add(&handler->node, &ec->list);
537 538 539 540 541 542 543 544
	mutex_unlock(&ec->lock);
	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 已提交
545
	struct acpi_ec_query_handler *handler, *tmp;
546
	mutex_lock(&ec->lock);
A
Adrian Bunk 已提交
547
	list_for_each_entry_safe(handler, tmp, &ec->list, node) {
548 549 550 551 552 553 554 555 556
		if (query_bit == handler->query_bit) {
			list_del(&handler->node);
			kfree(handler);
		}
	}
	mutex_unlock(&ec->lock);
}

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

558
static void acpi_ec_run(void *cxt)
L
Luming Yu 已提交
559
{
560 561
	struct acpi_ec_query_handler *handler = cxt;
	if (!handler)
562
		return;
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
	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;
579 580 581
	list_for_each_entry(handler, &ec->list, node) {
		if (value == handler->query_bit) {
			/* have custom handler for this bit */
582 583 584 585 586
			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);
587 588
			return acpi_os_execute((copy->func) ?
				OSL_NOTIFY_HANDLER : OSL_GPE_HANDLER,
589
				acpi_ec_run, copy);
590 591
		}
	}
592 593 594 595 596 597 598 599 600 601
	return 0;
}

static void acpi_ec_gpe_query(void *ec_cxt)
{
	struct acpi_ec *ec = ec_cxt;
	if (!ec)
		return;
	mutex_lock(&ec->lock);
	acpi_ec_sync_query(ec);
602
	mutex_unlock(&ec->lock);
L
Luming Yu 已提交
603
}
L
Linus Torvalds 已提交
604

605 606 607 608 609 610 611 612 613 614 615 616 617 618
static void acpi_ec_gpe_query(void *ec_cxt);

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;
}

L
Len Brown 已提交
619
static u32 acpi_ec_gpe_handler(void *data)
L
Linus Torvalds 已提交
620
{
621
	struct acpi_ec *ec = data;
622

623
	pr_debug(PREFIX "~~~> interrupt\n");
624

625 626 627
	advance_transaction(ec, acpi_ec_read_status(ec));
	if (ec_transaction_done(ec) &&
	    (acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF) == 0) {
628
		wake_up(&ec->wait);
629 630
		ec_check_sci(ec, acpi_ec_read_status(ec));
	}
631
	return ACPI_INTERRUPT_HANDLED;
A
Alexey Starikovskiy 已提交
632 633
}

L
Linus Torvalds 已提交
634 635 636 637 638
/* --------------------------------------------------------------------------
                             Address Space Management
   -------------------------------------------------------------------------- */

static acpi_status
639
acpi_ec_space_handler(u32 function, acpi_physical_address address,
640
		      u32 bits, u64 *value64,
L
Len Brown 已提交
641
		      void *handler_context, void *region_context)
L
Linus Torvalds 已提交
642
{
643
	struct acpi_ec *ec = handler_context;
644 645
	int result = 0, i, bytes = bits / 8;
	u8 *value = (u8 *)value64;
L
Linus Torvalds 已提交
646 647

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

650
	if (function != ACPI_READ && function != ACPI_WRITE)
651
		return AE_BAD_PARAMETER;
L
Linus Torvalds 已提交
652

653
	if (EC_FLAGS_MSI || bits > 8)
654
		acpi_ec_burst_enable(ec);
655

656 657 658 659
	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 已提交
660

661
	if (EC_FLAGS_MSI || bits > 8)
662
		acpi_ec_burst_disable(ec);
663

L
Linus Torvalds 已提交
664 665
	switch (result) {
	case -EINVAL:
666
		return AE_BAD_PARAMETER;
L
Linus Torvalds 已提交
667 668
		break;
	case -ENODEV:
669
		return AE_NOT_FOUND;
L
Linus Torvalds 已提交
670 671
		break;
	case -ETIME:
672
		return AE_TIME;
L
Linus Torvalds 已提交
673 674
		break;
	default:
675
		return AE_OK;
L
Linus Torvalds 已提交
676 677 678 679 680 681
	}
}

/* --------------------------------------------------------------------------
                               Driver Interface
   -------------------------------------------------------------------------- */
682 683 684 685 686 687 688 689
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;
690
	ec->flags = 1 << EC_FLAGS_QUERY_PENDING;
691 692
	mutex_init(&ec->lock);
	init_waitqueue_head(&ec->wait);
693
	INIT_LIST_HEAD(&ec->list);
694
	spin_lock_init(&ec->curr_lock);
695 696
	return ec;
}
697

698 699 700 701
static acpi_status
acpi_ec_register_query_methods(acpi_handle handle, u32 level,
			       void *context, void **return_value)
{
702 703
	char node_name[5];
	struct acpi_buffer buffer = { sizeof(node_name), node_name };
704 705
	struct acpi_ec *ec = context;
	int value = 0;
706 707 708 709 710
	acpi_status status;

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

	if (ACPI_SUCCESS(status) && sscanf(node_name, "_Q%x", &value) == 1) {
711 712 713 714 715
		acpi_ec_add_query_handler(ec, value, handle, NULL, NULL);
	}
	return AE_OK;
}

716 717
static acpi_status
ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval)
718
{
719
	acpi_status status;
720
	unsigned long long tmp = 0;
721 722

	struct acpi_ec *ec = context;
723 724 725 726

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

727 728 729 730
	status = acpi_walk_resources(handle, METHOD_NAME__CRS,
				     ec_parse_io_ports, ec);
	if (ACPI_FAILURE(status))
		return status;
731 732 733

	/* Get GPE bit assignment (EC events). */
	/* TODO: Add support for _GPE returning a package */
734
	status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp);
735 736
	if (ACPI_FAILURE(status))
		return status;
737
	ec->gpe = tmp;
738
	/* Use the global lock for all EC transactions? */
739
	tmp = 0;
740 741
	acpi_evaluate_integer(handle, "_GLK", NULL, &tmp);
	ec->global_lock = tmp;
742
	ec->handle = handle;
743
	return AE_CTRL_TERMINATE;
744 745
}

746 747 748 749 750 751 752 753 754 755
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;
756 757

	acpi_enable_gpe(NULL, ec->gpe, ACPI_GPE_TYPE_RUNTIME);
758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
	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);
774
			acpi_disable_gpe(NULL, ec->gpe, ACPI_GPE_TYPE_RUNTIME);
775 776 777 778 779 780 781 782
			return -ENODEV;
		}
	}

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

783 784
static void ec_remove_handlers(struct acpi_ec *ec)
{
785
	acpi_disable_gpe(NULL, ec->gpe, ACPI_GPE_TYPE_RUNTIME);
786 787
	if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle,
				ACPI_ADR_SPACE_EC, &acpi_ec_space_handler)))
788
		pr_err(PREFIX "failed to remove space handler\n");
789 790
	if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe,
				&acpi_ec_gpe_handler)))
791
		pr_err(PREFIX "failed to remove gpe handler\n");
792
	clear_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags);
793 794
}

795
static int acpi_ec_add(struct acpi_device *device)
L
Linus Torvalds 已提交
796
{
797
	struct acpi_ec *ec = NULL;
B
Bjorn Helgaas 已提交
798
	int ret;
L
Luming Yu 已提交
799

800 801 802
	strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
	strcpy(acpi_device_class(device), ACPI_EC_CLASS);

803
	/* Check for boot EC */
804 805 806 807 808 809 810 811 812
	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;
813 814 815
	}
	if (ec_parse_device(device->handle, 0, ec, NULL) !=
		AE_CTRL_TERMINATE) {
816 817
			kfree(ec);
			return -EINVAL;
818 819
	}

820
	ec->handle = device->handle;
821 822 823

	/* Find and register all query methods */
	acpi_walk_namespace(ACPI_TYPE_METHOD, ec->handle, 1,
824
			    acpi_ec_register_query_methods, NULL, ec, NULL);
825

826 827
	if (!first_ec)
		first_ec = ec;
828
	device->driver_data = ec;
829
	pr_info(PREFIX "GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n",
830
			  ec->gpe, ec->command_addr, ec->data_addr);
831 832 833 834 835 836

	ret = ec_install_handlers(ec);

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

L
Len Brown 已提交
839
static int acpi_ec_remove(struct acpi_device *device, int type)
L
Linus Torvalds 已提交
840
{
841
	struct acpi_ec *ec;
842
	struct acpi_ec_query_handler *handler, *tmp;
L
Linus Torvalds 已提交
843 844

	if (!device)
845
		return -EINVAL;
L
Linus Torvalds 已提交
846 847

	ec = acpi_driver_data(device);
B
Bjorn Helgaas 已提交
848
	ec_remove_handlers(ec);
849
	mutex_lock(&ec->lock);
850
	list_for_each_entry_safe(handler, tmp, &ec->list, node) {
851 852 853 854
		list_del(&handler->node);
		kfree(handler);
	}
	mutex_unlock(&ec->lock);
855
	device->driver_data = NULL;
856
	if (ec == first_ec)
857
		first_ec = NULL;
858
	kfree(ec);
859
	return 0;
L
Linus Torvalds 已提交
860 861 862
}

static acpi_status
863
ec_parse_io_ports(struct acpi_resource *resource, void *context)
L
Linus Torvalds 已提交
864
{
865
	struct acpi_ec *ec = context;
L
Linus Torvalds 已提交
866

867
	if (resource->type != ACPI_RESOURCE_TYPE_IO)
L
Linus Torvalds 已提交
868 869 870 871 872 873 874
		return AE_OK;

	/*
	 * The first address region returned is the data port, and
	 * the second address region returned is the status/command
	 * port.
	 */
875
	if (ec->data_addr == 0)
876
		ec->data_addr = resource->data.io.minimum;
877
	else if (ec->command_addr == 0)
878
		ec->command_addr = resource->data.io.minimum;
879
	else
L
Linus Torvalds 已提交
880 881 882 883 884
		return AE_CTRL_TERMINATE;

	return AE_OK;
}

885 886
int __init acpi_boot_ec_enable(void)
{
887
	if (!boot_ec || test_bit(EC_FLAGS_HANDLERS_INSTALLED, &boot_ec->flags))
888 889 890 891 892 893 894 895
		return 0;
	if (!ec_install_handlers(boot_ec)) {
		first_ec = boot_ec;
		return 0;
	}
	return -EFAULT;
}

896 897 898 899 900
static const struct acpi_device_id ec_device_ids[] = {
	{"PNP0C09", 0},
	{"", 0},
};

901 902 903 904 905 906 907
/* 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 已提交
908 909 910 911 912 913 914 915 916 917
/* 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)
{
918
	printk(KERN_DEBUG PREFIX "Detected MSI hardware, enabling workarounds.\n");
A
Alexey Starikovskiy 已提交
919 920 921 922 923 924
	EC_FLAGS_MSI = 1;
	EC_FLAGS_VALIDATE_ECDT = 1;
	return 0;
}

static struct dmi_system_id __initdata ec_dmi_table[] = {
925 926 927 928
	{
	ec_skip_dsdt_scan, "Compal JFL92", {
	DMI_MATCH(DMI_BIOS_VENDOR, "COMPAL"),
	DMI_MATCH(DMI_BOARD_NAME, "JFL92") }, NULL},
A
Alexey Starikovskiy 已提交
929 930
	{
	ec_flag_msi, "MSI hardware", {
931 932 933 934 935 936 937
	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 已提交
938 939 940 941 942 943 944
	{
	ec_validate_ecdt, "ASUS hardware", {
	DMI_MATCH(DMI_BIOS_VENDOR, "ASUS") }, NULL},
	{},
};


945 946 947
int __init acpi_ec_ecdt_probe(void)
{
	acpi_status status;
948
	struct acpi_ec *saved_ec = NULL;
L
Len Brown 已提交
949
	struct acpi_table_ecdt *ecdt_ptr;
L
Luming Yu 已提交
950

951 952
	boot_ec = make_acpi_ec();
	if (!boot_ec)
953 954 955 956
		return -ENOMEM;
	/*
	 * Generate a boot ec context
	 */
A
Alexey Starikovskiy 已提交
957
	dmi_check_system(ec_dmi_table);
958 959
	status = acpi_get_table(ACPI_SIG_ECDT, 1,
				(struct acpi_table_header **)&ecdt_ptr);
960
	if (ACPI_SUCCESS(status)) {
961
		pr_info(PREFIX "EC description table is found, configuring boot EC\n");
962 963 964
		boot_ec->command_addr = ecdt_ptr->control.address;
		boot_ec->data_addr = ecdt_ptr->data.address;
		boot_ec->gpe = ecdt_ptr->gpe;
965
		boot_ec->handle = ACPI_ROOT_OBJECT;
966
		acpi_get_handle(ACPI_ROOT_OBJECT, ecdt_ptr->id, &boot_ec->handle);
967
		/* Don't trust ECDT, which comes from ASUSTek */
A
Alexey Starikovskiy 已提交
968
		if (!EC_FLAGS_VALIDATE_ECDT)
969
			goto install;
J
Julia Lawall 已提交
970
		saved_ec = kmemdup(boot_ec, sizeof(struct acpi_ec), GFP_KERNEL);
971 972
		if (!saved_ec)
			return -ENOMEM;
973
	/* fall through */
974
	}
A
Alexey Starikovskiy 已提交
975

976 977 978
	if (EC_FLAGS_SKIP_DSDT_SCAN)
		return -ENODEV;

979 980 981 982 983 984 985 986
	/* 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;
987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
	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;
	}
1010 1011
install:
	if (!ec_install_handlers(boot_ec)) {
1012
		first_ec = boot_ec;
1013
		return 0;
1014
	}
1015
error:
1016 1017
	kfree(boot_ec);
	boot_ec = NULL;
L
Linus Torvalds 已提交
1018 1019 1020
	return -ENODEV;
}

1021 1022 1023
static int acpi_ec_suspend(struct acpi_device *device, pm_message_t state)
{
	struct acpi_ec *ec = acpi_driver_data(device);
1024
	/* Stop using the GPE, but keep it reference counted. */
1025
	acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_DISABLE);
1026 1027 1028 1029 1030 1031
	return 0;
}

static int acpi_ec_resume(struct acpi_device *device)
{
	struct acpi_ec *ec = acpi_driver_data(device);
1032
	/* Enable the GPE again, but don't reference count it once more. */
1033
	acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_ENABLE);
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
	return 0;
}

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,
		.suspend = acpi_ec_suspend,
		.resume = acpi_ec_resume,
		},
};

1049
int __init acpi_ec_init(void)
L
Linus Torvalds 已提交
1050
{
L
Len Brown 已提交
1051
	int result = 0;
L
Linus Torvalds 已提交
1052 1053 1054

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

1058
	return result;
L
Linus Torvalds 已提交
1059 1060 1061 1062
}

/* EC driver currently not unloadable */
#if 0
L
Len Brown 已提交
1063
static void __exit acpi_ec_exit(void)
L
Linus Torvalds 已提交
1064 1065 1066
{

	acpi_bus_unregister_driver(&acpi_ec_driver);
1067
	return;
L
Linus Torvalds 已提交
1068
}
1069
#endif	/* 0 */