ec.c 37.9 KB
Newer Older
L
Linus Torvalds 已提交
1
/*
2
 *  ec.c - ACPI Embedded Controller Driver (v3)
L
Linus Torvalds 已提交
3
 *
4 5
 *  Copyright (C) 2001-2015 Intel Corporation
 *    Author: 2014, 2015 Lv Zheng <lv.zheng@intel.com>
6 7 8 9 10 11
 *            2006, 2007 Alexey Starikovskiy <alexey.y.starikovskiy@intel.com>
 *            2006       Denis Sadykov <denis.m.sadykov@intel.com>
 *            2004       Luming Yu <luming.yu@intel.com>
 *            2001, 2002 Andy Grover <andrew.grover@intel.com>
 *            2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
 *  Copyright (C) 2008      Alexey Starikovskiy <astarikovskiy@suse.de>
L
Linus Torvalds 已提交
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 *  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.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */

32
/* Uncomment next line to get verbose printout */
33
/* #define DEBUG */
34
#define pr_fmt(fmt) "ACPI : EC: " fmt
35

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

49 50
#include "internal.h"

L
Linus Torvalds 已提交
51 52 53
#define ACPI_EC_CLASS			"embedded_controller"
#define ACPI_EC_DEVICE_NAME		"Embedded Controller"
#define ACPI_EC_FILE_INFO		"info"
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 */
58
#define ACPI_EC_FLAG_CMD	0x08	/* Input buffer contains a command */
D
Dmitry Torokhov 已提交
59
#define ACPI_EC_FLAG_BURST	0x10	/* burst mode */
L
Linus Torvalds 已提交
60
#define ACPI_EC_FLAG_SCI	0x20	/* EC-SCI occurred */
61

62
/* EC commands */
63
enum ec_command {
A
Alexey Starikovskiy 已提交
64 65 66 67 68
	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,
69
};
70

71
#define ACPI_EC_DELAY		500	/* Wait 500ms max. during EC ops */
72
#define ACPI_EC_UDELAY_GLK	1000	/* Wait 1ms max. to get global lock */
73
#define ACPI_EC_UDELAY_POLL	550	/* Wait 1ms for EC transaction polling */
74 75
#define ACPI_EC_CLEAR_MAX	100	/* Maximum number of events to query
					 * when trying to clear the EC */
76

77
enum {
78
	EC_FLAGS_QUERY_PENDING,		/* Query is pending */
79
	EC_FLAGS_HANDLERS_INSTALLED,	/* Handlers for GPE and
80
					 * OpReg are installed */
81 82
	EC_FLAGS_STARTED,		/* Driver is started */
	EC_FLAGS_STOPPED,		/* Driver is stopped */
83 84
	EC_FLAGS_COMMAND_STORM,		/* GPE storms occurred to the
					 * current command processing */
L
Linus Torvalds 已提交
85
};
86

87 88 89
#define ACPI_EC_COMMAND_POLL		0x01 /* Available for command byte */
#define ACPI_EC_COMMAND_COMPLETE	0x02 /* Completed last byte */

90 91 92 93 94
/* 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");

95 96 97 98 99 100 101 102
static bool ec_busy_polling __read_mostly;
module_param(ec_busy_polling, bool, 0644);
MODULE_PARM_DESC(ec_busy_polling, "Use busy polling to advance EC transaction");

static unsigned int ec_polling_guard __read_mostly = ACPI_EC_UDELAY_POLL;
module_param(ec_polling_guard, uint, 0644);
MODULE_PARM_DESC(ec_polling_guard, "Guard time(us) between EC accesses in polling modes");

103 104 105 106 107 108 109 110 111
/*
 * 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");

112 113 114 115 116 117
struct acpi_ec_query_handler {
	struct list_head node;
	acpi_ec_query_func func;
	acpi_handle handle;
	void *data;
	u8 query_bit;
118
	struct kref kref;
119 120
};

121
struct transaction {
122 123 124
	const u8 *wdata;
	u8 *rdata;
	unsigned short irq_count;
125
	u8 command;
126 127
	u8 wi;
	u8 ri;
128 129
	u8 wlen;
	u8 rlen;
130
	u8 flags;
131 132
};

L
Lv Zheng 已提交
133
static int acpi_ec_query(struct acpi_ec *ec, u8 *data);
134
static void advance_transaction(struct acpi_ec *ec);
135

136 137
struct acpi_ec *boot_ec, *first_ec;
EXPORT_SYMBOL(first_ec);
138

A
Alexey Starikovskiy 已提交
139
static int EC_FLAGS_VALIDATE_ECDT; /* ASUStec ECDTs need to be validated */
140
static int EC_FLAGS_SKIP_DSDT_SCAN; /* Not all BIOS survive early DSDT scan */
141
static int EC_FLAGS_CLEAR_ON_RESUME; /* Needs acpi_ec_clear() on boot/resume */
142
static int EC_FLAGS_QUERY_HANDSHAKE; /* Needs QR_EC issued when SCI_EVT set */
143

144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
/* --------------------------------------------------------------------------
 *                           Logging/Debugging
 * -------------------------------------------------------------------------- */

/*
 * Splitters used by the developers to track the boundary of the EC
 * handling processes.
 */
#ifdef DEBUG
#define EC_DBG_SEP	" "
#define EC_DBG_DRV	"+++++"
#define EC_DBG_STM	"====="
#define EC_DBG_REQ	"*****"
#define EC_DBG_EVT	"#####"
#else
#define EC_DBG_SEP	""
#define EC_DBG_DRV
#define EC_DBG_STM
#define EC_DBG_REQ
#define EC_DBG_EVT
#endif

#define ec_log_raw(fmt, ...) \
	pr_info(fmt "\n", ##__VA_ARGS__)
#define ec_dbg_raw(fmt, ...) \
	pr_debug(fmt "\n", ##__VA_ARGS__)
#define ec_log(filter, fmt, ...) \
	ec_log_raw(filter EC_DBG_SEP fmt EC_DBG_SEP filter, ##__VA_ARGS__)
#define ec_dbg(filter, fmt, ...) \
	ec_dbg_raw(filter EC_DBG_SEP fmt EC_DBG_SEP filter, ##__VA_ARGS__)

#define ec_log_drv(fmt, ...) \
	ec_log(EC_DBG_DRV, fmt, ##__VA_ARGS__)
#define ec_dbg_drv(fmt, ...) \
	ec_dbg(EC_DBG_DRV, fmt, ##__VA_ARGS__)
#define ec_dbg_stm(fmt, ...) \
	ec_dbg(EC_DBG_STM, fmt, ##__VA_ARGS__)
#define ec_dbg_req(fmt, ...) \
	ec_dbg(EC_DBG_REQ, fmt, ##__VA_ARGS__)
#define ec_dbg_evt(fmt, ...) \
	ec_dbg(EC_DBG_EVT, fmt, ##__VA_ARGS__)
185 186
#define ec_dbg_ref(ec, fmt, ...) \
	ec_dbg_raw("%lu: " fmt, ec->reference_count, ## __VA_ARGS__)
187

188 189 190 191 192 193 194 195 196 197
/* --------------------------------------------------------------------------
 *                           Device Flags
 * -------------------------------------------------------------------------- */

static bool acpi_ec_started(struct acpi_ec *ec)
{
	return test_bit(EC_FLAGS_STARTED, &ec->flags) &&
	       !test_bit(EC_FLAGS_STOPPED, &ec->flags);
}

198 199 200 201 202
static bool acpi_ec_flushed(struct acpi_ec *ec)
{
	return ec->reference_count == 1;
}

L
Linus Torvalds 已提交
203
/* --------------------------------------------------------------------------
204
 *                           EC Registers
L
Lv Zheng 已提交
205
 * -------------------------------------------------------------------------- */
L
Linus Torvalds 已提交
206

207
static inline u8 acpi_ec_read_status(struct acpi_ec *ec)
L
Linus Torvalds 已提交
208
{
209
	u8 x = inb(ec->command_addr);
L
Lv Zheng 已提交
210

211 212 213 214 215 216 217 218
	ec_dbg_raw("EC_SC(R) = 0x%2.2x "
		   "SCI_EVT=%d BURST=%d CMD=%d IBF=%d OBF=%d",
		   x,
		   !!(x & ACPI_EC_FLAG_SCI),
		   !!(x & ACPI_EC_FLAG_BURST),
		   !!(x & ACPI_EC_FLAG_CMD),
		   !!(x & ACPI_EC_FLAG_IBF),
		   !!(x & ACPI_EC_FLAG_OBF));
219
	return x;
D
Dmitry Torokhov 已提交
220 221
}

222
static inline u8 acpi_ec_read_data(struct acpi_ec *ec)
223
{
224
	u8 x = inb(ec->data_addr);
L
Lv Zheng 已提交
225

226
	ec->timestamp = jiffies;
227
	ec_dbg_raw("EC_DATA(R) = 0x%2.2x", x);
228
	return x;
229 230
}

231
static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command)
L
Luming Yu 已提交
232
{
233
	ec_dbg_raw("EC_SC(W) = 0x%2.2x", command);
234
	outb(command, ec->command_addr);
235
	ec->timestamp = jiffies;
L
Luming Yu 已提交
236 237
}

238
static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data)
L
Luming Yu 已提交
239
{
240
	ec_dbg_raw("EC_DATA(W) = 0x%2.2x", data);
241
	outb(data, ec->data_addr);
242
	ec->timestamp = jiffies;
243
}
L
Luming Yu 已提交
244

245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
#ifdef DEBUG
static const char *acpi_ec_cmd_string(u8 cmd)
{
	switch (cmd) {
	case 0x80:
		return "RD_EC";
	case 0x81:
		return "WR_EC";
	case 0x82:
		return "BE_EC";
	case 0x83:
		return "BD_EC";
	case 0x84:
		return "QR_EC";
	}
	return "UNKNOWN";
}
#else
#define acpi_ec_cmd_string(cmd)		"UNDEF"
#endif

266 267 268 269 270 271 272 273 274
/* --------------------------------------------------------------------------
 *                           GPE Registers
 * -------------------------------------------------------------------------- */

static inline bool acpi_ec_is_gpe_raised(struct acpi_ec *ec)
{
	acpi_event_status gpe_status = 0;

	(void)acpi_get_gpe_status(NULL, ec->gpe, &gpe_status);
275
	return (gpe_status & ACPI_EVENT_FLAG_STATUS_SET) ? true : false;
276 277 278 279 280 281
}

static inline void acpi_ec_enable_gpe(struct acpi_ec *ec, bool open)
{
	if (open)
		acpi_enable_gpe(NULL, ec->gpe);
282 283
	else {
		BUG_ON(ec->reference_count < 1);
284
		acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_ENABLE);
285
	}
286 287 288 289 290 291
	if (acpi_ec_is_gpe_raised(ec)) {
		/*
		 * On some platforms, EN=1 writes cannot trigger GPE. So
		 * software need to manually trigger a pseudo GPE event on
		 * EN=1 writes.
		 */
292
		ec_dbg_raw("Polling quirk");
293 294 295 296 297 298 299 300
		advance_transaction(ec);
	}
}

static inline void acpi_ec_disable_gpe(struct acpi_ec *ec, bool close)
{
	if (close)
		acpi_disable_gpe(NULL, ec->gpe);
301 302
	else {
		BUG_ON(ec->reference_count < 1);
303
		acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_DISABLE);
304
	}
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
}

static inline void acpi_ec_clear_gpe(struct acpi_ec *ec)
{
	/*
	 * GPE STS is a W1C register, which means:
	 * 1. Software can clear it without worrying about clearing other
	 *    GPEs' STS bits when the hardware sets them in parallel.
	 * 2. As long as software can ensure only clearing it when it is
	 *    set, hardware won't set it in parallel.
	 * So software can clear GPE in any contexts.
	 * Warning: do not move the check into advance_transaction() as the
	 * EC commands will be sent without GPE raised.
	 */
	if (!acpi_ec_is_gpe_raised(ec))
		return;
	acpi_clear_gpe(NULL, ec->gpe);
}

/* --------------------------------------------------------------------------
 *                           Transaction Management
 * -------------------------------------------------------------------------- */

328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
static void acpi_ec_submit_request(struct acpi_ec *ec)
{
	ec->reference_count++;
	if (ec->reference_count == 1)
		acpi_ec_enable_gpe(ec, true);
}

static void acpi_ec_complete_request(struct acpi_ec *ec)
{
	bool flushed = false;

	ec->reference_count--;
	if (ec->reference_count == 0)
		acpi_ec_disable_gpe(ec, true);
	flushed = acpi_ec_flushed(ec);
	if (flushed)
		wake_up(&ec->wait);
}

347 348 349 350
static void acpi_ec_set_storm(struct acpi_ec *ec, u8 flag)
{
	if (!test_bit(flag, &ec->flags)) {
		acpi_ec_disable_gpe(ec, false);
351
		ec_dbg_drv("Polling enabled");
352 353 354 355 356 357 358 359 360
		set_bit(flag, &ec->flags);
	}
}

static void acpi_ec_clear_storm(struct acpi_ec *ec, u8 flag)
{
	if (test_bit(flag, &ec->flags)) {
		clear_bit(flag, &ec->flags);
		acpi_ec_enable_gpe(ec, false);
361
		ec_dbg_drv("Polling disabled");
362 363 364
	}
}

365 366 367 368 369 370 371 372 373 374 375
/*
 * acpi_ec_submit_flushable_request() - Increase the reference count unless
 *                                      the flush operation is not in
 *                                      progress
 * @ec: the EC device
 *
 * This function must be used before taking a new action that should hold
 * the reference count.  If this function returns false, then the action
 * must be discarded or it will prevent the flush operation from being
 * completed.
 */
376
static bool acpi_ec_submit_flushable_request(struct acpi_ec *ec)
377
{
378 379
	if (!acpi_ec_started(ec))
		return false;
380 381 382 383
	acpi_ec_submit_request(ec);
	return true;
}

384
static void acpi_ec_submit_query(struct acpi_ec *ec)
385
{
386
	if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags)) {
387
		ec_dbg_req("Event started");
388 389 390 391
		schedule_work(&ec->work);
	}
}

392
static void acpi_ec_complete_query(struct acpi_ec *ec)
393 394
{
	if (ec->curr->command == ACPI_EC_COMMAND_QUERY) {
395
		clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
396
		ec_dbg_req("Event stopped");
397 398 399
	}
}

400 401 402 403 404 405 406 407 408 409 410 411
static int ec_transaction_polled(struct acpi_ec *ec)
{
	unsigned long flags;
	int ret = 0;

	spin_lock_irqsave(&ec->lock, flags);
	if (ec->curr && (ec->curr->flags & ACPI_EC_COMMAND_POLL))
		ret = 1;
	spin_unlock_irqrestore(&ec->lock, flags);
	return ret;
}

412
static int ec_transaction_completed(struct acpi_ec *ec)
413
{
414 415
	unsigned long flags;
	int ret = 0;
L
Lv Zheng 已提交
416

417
	spin_lock_irqsave(&ec->lock, flags);
418
	if (ec->curr && (ec->curr->flags & ACPI_EC_COMMAND_COMPLETE))
419
		ret = 1;
420
	spin_unlock_irqrestore(&ec->lock, flags);
421
	return ret;
L
Luming Yu 已提交
422
}
D
Dmitry Torokhov 已提交
423

424
static void advance_transaction(struct acpi_ec *ec)
425
{
426
	struct transaction *t;
427
	u8 status;
428
	bool wakeup = false;
429

430 431
	ec_dbg_stm("%s (%d)", in_interrupt() ? "IRQ" : "TASK",
		   smp_processor_id());
432 433 434 435 436 437
	/*
	 * By always clearing STS before handling all indications, we can
	 * ensure a hardware STS 0->1 change after this clearing can always
	 * trigger a GPE interrupt.
	 */
	acpi_ec_clear_gpe(ec);
438
	status = acpi_ec_read_status(ec);
439
	t = ec->curr;
440
	if (!t)
441 442 443 444 445 446 447 448 449 450
		goto err;
	if (t->flags & ACPI_EC_COMMAND_POLL) {
		if (t->wlen > t->wi) {
			if ((status & ACPI_EC_FLAG_IBF) == 0)
				acpi_ec_write_data(ec, t->wdata[t->wi++]);
			else
				goto err;
		} else if (t->rlen > t->ri) {
			if ((status & ACPI_EC_FLAG_OBF) == 1) {
				t->rdata[t->ri++] = acpi_ec_read_data(ec);
451
				if (t->rlen == t->ri) {
452
					t->flags |= ACPI_EC_COMMAND_COMPLETE;
453
					if (t->command == ACPI_EC_COMMAND_QUERY)
454 455
						ec_dbg_req("Command(%s) hardware completion",
							   acpi_ec_cmd_string(t->command));
456 457
					wakeup = true;
				}
458 459 460
			} else
				goto err;
		} else if (t->wlen == t->wi &&
461
			   (status & ACPI_EC_FLAG_IBF) == 0) {
462
			t->flags |= ACPI_EC_COMMAND_COMPLETE;
463 464
			wakeup = true;
		}
465
		goto out;
466
	} else {
467 468
		if (EC_FLAGS_QUERY_HANDSHAKE &&
		    !(status & ACPI_EC_FLAG_SCI) &&
469 470
		    (t->command == ACPI_EC_COMMAND_QUERY)) {
			t->flags |= ACPI_EC_COMMAND_POLL;
471
			acpi_ec_complete_query(ec);
472 473
			t->rdata[t->ri++] = 0x00;
			t->flags |= ACPI_EC_COMMAND_COMPLETE;
474 475
			ec_dbg_req("Command(%s) software completion",
				   acpi_ec_cmd_string(t->command));
476 477
			wakeup = true;
		} else if ((status & ACPI_EC_FLAG_IBF) == 0) {
478 479
			acpi_ec_write_cmd(ec, t->command);
			t->flags |= ACPI_EC_COMMAND_POLL;
480
			acpi_ec_complete_query(ec);
481
		} else
482
			goto err;
483
		goto out;
484
	}
485
err:
486 487 488 489
	/*
	 * 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.
	 */
490
	if (!(status & ACPI_EC_FLAG_SCI)) {
491 492 493 494 495 496 497
		if (in_interrupt() && t) {
			if (t->irq_count < ec_storm_threshold)
				++t->irq_count;
			/* Allow triggering on 0 threshold */
			if (t->irq_count == ec_storm_threshold)
				acpi_ec_set_storm(ec, EC_FLAGS_COMMAND_STORM);
		}
498
	}
499
out:
500
	if (status & ACPI_EC_FLAG_SCI)
501
		acpi_ec_submit_query(ec);
502 503
	if (wakeup && in_interrupt())
		wake_up(&ec->wait);
504
}
505

506 507 508 509
static void start_transaction(struct acpi_ec *ec)
{
	ec->curr->irq_count = ec->curr->wi = ec->curr->ri = 0;
	ec->curr->flags = 0;
510 511 512 513
}

static int ec_guard(struct acpi_ec *ec)
{
514
	unsigned long guard = usecs_to_jiffies(ec_polling_guard);
515 516 517
	unsigned long timeout = ec->timestamp + guard;

	do {
518
		if (ec_busy_polling) {
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
			/* Perform busy polling */
			if (ec_transaction_completed(ec))
				return 0;
			udelay(jiffies_to_usecs(guard));
		} else {
			/*
			 * Perform wait polling
			 *
			 * The following check is there to keep the old
			 * logic - no inter-transaction guarding for the
			 * wait polling mode.
			 */
			if (!ec_transaction_polled(ec))
				break;
			if (wait_event_timeout(ec->wait,
					       ec_transaction_completed(ec),
					       guard))
				return 0;
		}
		/* Guard the register accesses for the polling modes */
	} while (time_before(jiffies, timeout));
	return -ETIME;
A
Alexey Starikovskiy 已提交
541
}
542

543 544
static int ec_poll(struct acpi_ec *ec)
{
545
	unsigned long flags;
546
	int repeat = 5; /* number of command restarts */
L
Lv Zheng 已提交
547

548 549
	while (repeat--) {
		unsigned long delay = jiffies +
550
			msecs_to_jiffies(ec_delay);
551
		do {
552 553
			if (!ec_guard(ec))
				return 0;
554
			spin_lock_irqsave(&ec->lock, flags);
555
			advance_transaction(ec);
556
			spin_unlock_irqrestore(&ec->lock, flags);
557
		} while (time_before(jiffies, delay));
558
		pr_debug("controller reset, restart transaction\n");
559
		spin_lock_irqsave(&ec->lock, flags);
560
		start_transaction(ec);
561
		spin_unlock_irqrestore(&ec->lock, flags);
562
	}
563
	return -ETIME;
L
Linus Torvalds 已提交
564 565
}

566
static int acpi_ec_transaction_unlocked(struct acpi_ec *ec,
567
					struct transaction *t)
L
Luming Yu 已提交
568
{
569 570
	unsigned long tmp;
	int ret = 0;
L
Lv Zheng 已提交
571

572
	/* start transaction */
573
	spin_lock_irqsave(&ec->lock, tmp);
574
	/* Enable GPE for command processing (IBF=0/OBF=1) */
575
	if (!acpi_ec_submit_flushable_request(ec)) {
576 577 578
		ret = -EINVAL;
		goto unlock;
	}
579
	ec_dbg_ref(ec, "Increase command");
580
	/* following two actions should be kept atomic */
581
	ec->curr = t;
582
	ec_dbg_req("Command(%s) started", acpi_ec_cmd_string(t->command));
583
	start_transaction(ec);
584
	spin_unlock_irqrestore(&ec->lock, tmp);
585

586
	ret = ec_poll(ec);
587

588
	spin_lock_irqsave(&ec->lock, tmp);
589 590
	if (t->irq_count == ec_storm_threshold)
		acpi_ec_clear_storm(ec, EC_FLAGS_COMMAND_STORM);
591
	ec_dbg_req("Command(%s) stopped", acpi_ec_cmd_string(t->command));
592
	ec->curr = NULL;
593 594
	/* Disable GPE for command processing (IBF=0/OBF=1) */
	acpi_ec_complete_request(ec);
595
	ec_dbg_ref(ec, "Decrease command");
596
unlock:
597
	spin_unlock_irqrestore(&ec->lock, tmp);
598 599 600
	return ret;
}

601
static int acpi_ec_transaction(struct acpi_ec *ec, struct transaction *t)
L
Linus Torvalds 已提交
602
{
603
	int status;
L
Len Brown 已提交
604
	u32 glk;
L
Lv Zheng 已提交
605

606
	if (!ec || (!t) || (t->wlen && !t->wdata) || (t->rlen && !t->rdata))
607
		return -EINVAL;
608 609
	if (t->rdata)
		memset(t->rdata, 0, t->rlen);
610

611
	mutex_lock(&ec->mutex);
612
	if (ec->global_lock) {
L
Linus Torvalds 已提交
613
		status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
614
		if (ACPI_FAILURE(status)) {
615 616
			status = -ENODEV;
			goto unlock;
617
		}
L
Linus Torvalds 已提交
618
	}
619

620
	status = acpi_ec_transaction_unlocked(ec, t);
621

622
	if (ec->global_lock)
L
Linus Torvalds 已提交
623
		acpi_release_global_lock(glk);
624
unlock:
625
	mutex_unlock(&ec->mutex);
626
	return status;
L
Linus Torvalds 已提交
627 628
}

629
static int acpi_ec_burst_enable(struct acpi_ec *ec)
630 631
{
	u8 d;
632 633 634 635
	struct transaction t = {.command = ACPI_EC_BURST_ENABLE,
				.wdata = NULL, .rdata = &d,
				.wlen = 0, .rlen = 1};

636
	return acpi_ec_transaction(ec, &t);
637 638
}

639
static int acpi_ec_burst_disable(struct acpi_ec *ec)
640
{
641 642 643 644
	struct transaction t = {.command = ACPI_EC_BURST_DISABLE,
				.wdata = NULL, .rdata = NULL,
				.wlen = 0, .rlen = 0};

645
	return (acpi_ec_read_status(ec) & ACPI_EC_FLAG_BURST) ?
646
				acpi_ec_transaction(ec, &t) : 0;
647 648
}

L
Lv Zheng 已提交
649
static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 *data)
650 651 652
{
	int result;
	u8 d;
653 654 655
	struct transaction t = {.command = ACPI_EC_COMMAND_READ,
				.wdata = &address, .rdata = &d,
				.wlen = 1, .rlen = 1};
656

657
	result = acpi_ec_transaction(ec, &t);
658 659 660
	*data = d;
	return result;
}
661

662 663
static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data)
{
A
Alexey Starikovskiy 已提交
664
	u8 wdata[2] = { address, data };
665 666 667 668
	struct transaction t = {.command = ACPI_EC_COMMAND_WRITE,
				.wdata = wdata, .rdata = NULL,
				.wlen = 2, .rlen = 0};

669
	return acpi_ec_transaction(ec, &t);
670 671
}

672
int ec_read(u8 addr, u8 *val)
L
Linus Torvalds 已提交
673 674
{
	int err;
675
	u8 temp_data;
L
Linus Torvalds 已提交
676 677 678 679

	if (!first_ec)
		return -ENODEV;

680
	err = acpi_ec_read(first_ec, addr, &temp_data);
L
Linus Torvalds 已提交
681 682 683 684

	if (!err) {
		*val = temp_data;
		return 0;
L
Lv Zheng 已提交
685 686
	}
	return err;
L
Linus Torvalds 已提交
687 688 689
}
EXPORT_SYMBOL(ec_read);

L
Len Brown 已提交
690
int ec_write(u8 addr, u8 val)
L
Linus Torvalds 已提交
691 692 693 694 695 696
{
	int err;

	if (!first_ec)
		return -ENODEV;

697
	err = acpi_ec_write(first_ec, addr, val);
L
Linus Torvalds 已提交
698 699 700 701 702

	return err;
}
EXPORT_SYMBOL(ec_write);

703
int ec_transaction(u8 command,
L
Lv Zheng 已提交
704 705
		   const u8 *wdata, unsigned wdata_len,
		   u8 *rdata, unsigned rdata_len)
L
Luming Yu 已提交
706
{
707 708 709
	struct transaction t = {.command = command,
				.wdata = wdata, .rdata = rdata,
				.wlen = wdata_len, .rlen = rdata_len};
L
Lv Zheng 已提交
710

711 712
	if (!first_ec)
		return -ENODEV;
L
Luming Yu 已提交
713

714
	return acpi_ec_transaction(first_ec, &t);
L
Luming Yu 已提交
715
}
716 717
EXPORT_SYMBOL(ec_transaction);

S
Seth Forshee 已提交
718 719 720 721 722 723 724 725 726
/* 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);

727
/*
728
 * Process _Q events that might have accumulated in the EC.
729 730 731 732 733 734 735 736
 * Run with locked ec mutex.
 */
static void acpi_ec_clear(struct acpi_ec *ec)
{
	int i, status;
	u8 value = 0;

	for (i = 0; i < ACPI_EC_CLEAR_MAX; i++) {
L
Lv Zheng 已提交
737
		status = acpi_ec_query(ec, &value);
738 739 740 741 742 743 744 745 746 747
		if (status || !value)
			break;
	}

	if (unlikely(i == ACPI_EC_CLEAR_MAX))
		pr_warn("Warning: Maximum of %d stale EC events cleared\n", i);
	else
		pr_info("%d stale EC events cleared\n", i);
}

748 749 750 751 752 753
static void acpi_ec_start(struct acpi_ec *ec, bool resuming)
{
	unsigned long flags;

	spin_lock_irqsave(&ec->lock, flags);
	if (!test_and_set_bit(EC_FLAGS_STARTED, &ec->flags)) {
754
		ec_dbg_drv("Starting EC");
755
		/* Enable GPE for event processing (SCI_EVT=1) */
756
		if (!resuming) {
757
			acpi_ec_submit_request(ec);
758 759
			ec_dbg_ref(ec, "Increase driver");
		}
760
		ec_log_drv("EC started");
761 762 763 764
	}
	spin_unlock_irqrestore(&ec->lock, flags);
}

765 766 767 768 769 770 771 772 773 774 775
static bool acpi_ec_stopped(struct acpi_ec *ec)
{
	unsigned long flags;
	bool flushed;

	spin_lock_irqsave(&ec->lock, flags);
	flushed = acpi_ec_flushed(ec);
	spin_unlock_irqrestore(&ec->lock, flags);
	return flushed;
}

776 777 778 779 780 781
static void acpi_ec_stop(struct acpi_ec *ec, bool suspending)
{
	unsigned long flags;

	spin_lock_irqsave(&ec->lock, flags);
	if (acpi_ec_started(ec)) {
782
		ec_dbg_drv("Stopping EC");
783
		set_bit(EC_FLAGS_STOPPED, &ec->flags);
784 785 786 787
		spin_unlock_irqrestore(&ec->lock, flags);
		wait_event(ec->wait, acpi_ec_stopped(ec));
		spin_lock_irqsave(&ec->lock, flags);
		/* Disable GPE for event processing (SCI_EVT=1) */
788
		if (!suspending) {
789
			acpi_ec_complete_request(ec);
790 791
			ec_dbg_ref(ec, "Decrease driver");
		}
792 793
		clear_bit(EC_FLAGS_STARTED, &ec->flags);
		clear_bit(EC_FLAGS_STOPPED, &ec->flags);
794
		ec_log_drv("EC stopped");
795 796 797 798
	}
	spin_unlock_irqrestore(&ec->lock, flags);
}

799
void acpi_ec_block_transactions(void)
800 801 802 803 804 805
{
	struct acpi_ec *ec = first_ec;

	if (!ec)
		return;

806
	mutex_lock(&ec->mutex);
807
	/* Prevent transactions from being carried out */
808
	acpi_ec_stop(ec, true);
809
	mutex_unlock(&ec->mutex);
810 811
}

812
void acpi_ec_unblock_transactions(void)
813 814 815 816 817 818 819
{
	struct acpi_ec *ec = first_ec;

	if (!ec)
		return;

	/* Allow transactions to be carried out again */
820
	acpi_ec_start(ec, true);
821 822 823

	if (EC_FLAGS_CLEAR_ON_RESUME)
		acpi_ec_clear(ec);
824 825
}

826
void acpi_ec_unblock_transactions_early(void)
827 828 829 830 831 832
{
	/*
	 * 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)
833
		acpi_ec_start(first_ec, true);
834 835
}

L
Linus Torvalds 已提交
836 837 838
/* --------------------------------------------------------------------------
                                Event Management
   -------------------------------------------------------------------------- */
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
static struct acpi_ec_query_handler *
acpi_ec_get_query_handler(struct acpi_ec_query_handler *handler)
{
	if (handler)
		kref_get(&handler->kref);
	return handler;
}

static void acpi_ec_query_handler_release(struct kref *kref)
{
	struct acpi_ec_query_handler *handler =
		container_of(kref, struct acpi_ec_query_handler, kref);

	kfree(handler);
}

static void acpi_ec_put_query_handler(struct acpi_ec_query_handler *handler)
{
	kref_put(&handler->kref, acpi_ec_query_handler_release);
}

860 861 862 863 864 865
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);
L
Lv Zheng 已提交
866

867 868 869 870 871 872 873
	if (!handler)
		return -ENOMEM;

	handler->query_bit = query_bit;
	handler->handle = handle;
	handler->func = func;
	handler->data = data;
874
	mutex_lock(&ec->mutex);
875
	kref_init(&handler->kref);
876
	list_add(&handler->node, &ec->list);
877
	mutex_unlock(&ec->mutex);
878 879 880 881 882 883
	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 已提交
884
	struct acpi_ec_query_handler *handler, *tmp;
885
	LIST_HEAD(free_list);
L
Lv Zheng 已提交
886

887
	mutex_lock(&ec->mutex);
A
Adrian Bunk 已提交
888
	list_for_each_entry_safe(handler, tmp, &ec->list, node) {
889
		if (query_bit == handler->query_bit) {
890 891
			list_del_init(&handler->node);
			list_add(&handler->node, &free_list);
892 893
		}
	}
894
	mutex_unlock(&ec->mutex);
895
	list_for_each_entry_safe(handler, tmp, &free_list, node)
896
		acpi_ec_put_query_handler(handler);
897 898
}
EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler);
L
Linus Torvalds 已提交
899

900
static void acpi_ec_run(void *cxt)
L
Luming Yu 已提交
901
{
902
	struct acpi_ec_query_handler *handler = cxt;
L
Lv Zheng 已提交
903

904
	if (!handler)
905
		return;
906
	ec_dbg_evt("Query(0x%02x) started", handler->query_bit);
907 908 909 910
	if (handler->func)
		handler->func(handler->data);
	else if (handler->handle)
		acpi_evaluate_object(handler->handle, NULL, NULL, NULL);
911
	ec_dbg_evt("Query(0x%02x) stopped", handler->query_bit);
912
	acpi_ec_put_query_handler(handler);
913 914
}

L
Lv Zheng 已提交
915
static int acpi_ec_query(struct acpi_ec *ec, u8 *data)
916 917
{
	u8 value = 0;
918 919
	int result;
	acpi_status status;
920
	struct acpi_ec_query_handler *handler;
L
Lv Zheng 已提交
921 922 923
	struct transaction t = {.command = ACPI_EC_COMMAND_QUERY,
				.wdata = NULL, .rdata = &value,
				.wlen = 0, .rlen = 1};
924

L
Lv Zheng 已提交
925 926 927 928 929 930
	/*
	 * 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).
	 */
	result = acpi_ec_transaction(ec, &t);
931 932
	if (result)
		return result;
L
Lv Zheng 已提交
933 934 935 936
	if (data)
		*data = value;
	if (!value)
		return -ENODATA;
937

L
Lv Zheng 已提交
938
	mutex_lock(&ec->mutex);
939 940 941
	list_for_each_entry(handler, &ec->list, node) {
		if (value == handler->query_bit) {
			/* have custom handler for this bit */
942
			handler = acpi_ec_get_query_handler(handler);
943 944
			ec_dbg_evt("Query(0x%02x) scheduled",
				   handler->query_bit);
945
			status = acpi_os_execute((handler->func) ?
946
				OSL_NOTIFY_HANDLER : OSL_GPE_HANDLER,
947
				acpi_ec_run, handler);
948 949 950
			if (ACPI_FAILURE(status))
				result = -EBUSY;
			break;
951 952
		}
	}
L
Lv Zheng 已提交
953
	mutex_unlock(&ec->mutex);
954
	return result;
955 956
}

957
static void acpi_ec_gpe_poller(struct work_struct *work)
958
{
959
	struct acpi_ec *ec = container_of(work, struct acpi_ec, work);
L
Lv Zheng 已提交
960

L
Lv Zheng 已提交
961
	acpi_ec_query(ec, NULL);
L
Luming Yu 已提交
962
}
L
Linus Torvalds 已提交
963

964 965
static u32 acpi_ec_gpe_handler(acpi_handle gpe_device,
	u32 gpe_number, void *data)
L
Linus Torvalds 已提交
966
{
967
	unsigned long flags;
968
	struct acpi_ec *ec = data;
969

970
	spin_lock_irqsave(&ec->lock, flags);
971
	advance_transaction(ec);
972
	spin_unlock_irqrestore(&ec->lock, flags);
973
	return ACPI_INTERRUPT_HANDLED;
A
Alexey Starikovskiy 已提交
974 975
}

L
Linus Torvalds 已提交
976
/* --------------------------------------------------------------------------
L
Lv Zheng 已提交
977 978
 *                           Address Space Management
 * -------------------------------------------------------------------------- */
L
Linus Torvalds 已提交
979 980

static acpi_status
981
acpi_ec_space_handler(u32 function, acpi_physical_address address,
982
		      u32 bits, u64 *value64,
L
Len Brown 已提交
983
		      void *handler_context, void *region_context)
L
Linus Torvalds 已提交
984
{
985
	struct acpi_ec *ec = handler_context;
986 987
	int result = 0, i, bytes = bits / 8;
	u8 *value = (u8 *)value64;
L
Linus Torvalds 已提交
988 989

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

992
	if (function != ACPI_READ && function != ACPI_WRITE)
993
		return AE_BAD_PARAMETER;
L
Linus Torvalds 已提交
994

995
	if (ec_busy_polling || bits > 8)
996
		acpi_ec_burst_enable(ec);
997

998 999 1000 1001
	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 已提交
1002

1003
	if (ec_busy_polling || bits > 8)
1004
		acpi_ec_burst_disable(ec);
1005

L
Linus Torvalds 已提交
1006 1007
	switch (result) {
	case -EINVAL:
1008
		return AE_BAD_PARAMETER;
L
Linus Torvalds 已提交
1009
	case -ENODEV:
1010
		return AE_NOT_FOUND;
L
Linus Torvalds 已提交
1011
	case -ETIME:
1012
		return AE_TIME;
L
Linus Torvalds 已提交
1013
	default:
1014
		return AE_OK;
L
Linus Torvalds 已提交
1015 1016 1017 1018
	}
}

/* --------------------------------------------------------------------------
L
Lv Zheng 已提交
1019 1020 1021
 *                             Driver Interface
 * -------------------------------------------------------------------------- */

1022 1023 1024 1025 1026 1027
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);
L
Lv Zheng 已提交
1028

1029 1030
	if (!ec)
		return NULL;
1031
	ec->flags = 1 << EC_FLAGS_QUERY_PENDING;
1032
	mutex_init(&ec->mutex);
1033
	init_waitqueue_head(&ec->wait);
1034
	INIT_LIST_HEAD(&ec->list);
1035
	spin_lock_init(&ec->lock);
1036
	INIT_WORK(&ec->work, acpi_ec_gpe_poller);
1037
	ec->timestamp = jiffies;
1038 1039
	return ec;
}
1040

1041 1042 1043 1044
static acpi_status
acpi_ec_register_query_methods(acpi_handle handle, u32 level,
			       void *context, void **return_value)
{
1045 1046
	char node_name[5];
	struct acpi_buffer buffer = { sizeof(node_name), node_name };
1047 1048
	struct acpi_ec *ec = context;
	int value = 0;
1049 1050 1051 1052
	acpi_status status;

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

L
Lv Zheng 已提交
1053
	if (ACPI_SUCCESS(status) && sscanf(node_name, "_Q%x", &value) == 1)
1054 1055 1056 1057
		acpi_ec_add_query_handler(ec, value, handle, NULL, NULL);
	return AE_OK;
}

1058 1059
static acpi_status
ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval)
1060
{
1061
	acpi_status status;
1062
	unsigned long long tmp = 0;
1063
	struct acpi_ec *ec = context;
1064 1065 1066 1067

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

1068 1069 1070 1071
	status = acpi_walk_resources(handle, METHOD_NAME__CRS,
				     ec_parse_io_ports, ec);
	if (ACPI_FAILURE(status))
		return status;
1072 1073 1074

	/* Get GPE bit assignment (EC events). */
	/* TODO: Add support for _GPE returning a package */
1075
	status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp);
1076 1077
	if (ACPI_FAILURE(status))
		return status;
1078
	ec->gpe = tmp;
1079
	/* Use the global lock for all EC transactions? */
1080
	tmp = 0;
1081 1082
	acpi_evaluate_integer(handle, "_GLK", NULL, &tmp);
	ec->global_lock = tmp;
1083
	ec->handle = handle;
1084
	return AE_CTRL_TERMINATE;
1085 1086
}

1087 1088 1089
static int ec_install_handlers(struct acpi_ec *ec)
{
	acpi_status status;
L
Lv Zheng 已提交
1090

1091 1092
	if (test_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags))
		return 0;
1093
	status = acpi_install_gpe_raw_handler(NULL, ec->gpe,
1094 1095 1096 1097
				  ACPI_GPE_EDGE_TRIGGERED,
				  &acpi_ec_gpe_handler, ec);
	if (ACPI_FAILURE(status))
		return -ENODEV;
1098

1099
	acpi_ec_start(ec, false);
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
	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.
			 */
1111
			pr_err("Fail in evaluating the _REG object"
1112 1113
				" of EC device. Broken bios is suspected.\n");
		} else {
1114
			acpi_ec_stop(ec, false);
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
			acpi_remove_gpe_handler(NULL, ec->gpe,
				&acpi_ec_gpe_handler);
			return -ENODEV;
		}
	}

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

1125 1126
static void ec_remove_handlers(struct acpi_ec *ec)
{
1127 1128
	if (!test_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags))
		return;
1129
	acpi_ec_stop(ec, false);
1130 1131
	if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle,
				ACPI_ADR_SPACE_EC, &acpi_ec_space_handler)))
1132
		pr_err("failed to remove space handler\n");
1133 1134
	if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe,
				&acpi_ec_gpe_handler)))
1135
		pr_err("failed to remove gpe handler\n");
1136
	clear_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags);
1137 1138
}

1139
static int acpi_ec_add(struct acpi_device *device)
L
Linus Torvalds 已提交
1140
{
1141
	struct acpi_ec *ec = NULL;
B
Bjorn Helgaas 已提交
1142
	int ret;
L
Luming Yu 已提交
1143

1144 1145 1146
	strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
	strcpy(acpi_device_class(device), ACPI_EC_CLASS);

1147
	/* Check for boot EC */
1148 1149 1150 1151 1152 1153 1154 1155 1156
	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;
1157 1158 1159
	}
	if (ec_parse_device(device->handle, 0, ec, NULL) !=
		AE_CTRL_TERMINATE) {
1160 1161
			kfree(ec);
			return -EINVAL;
1162 1163
	}

1164 1165
	/* Find and register all query methods */
	acpi_walk_namespace(ACPI_TYPE_METHOD, ec->handle, 1,
1166
			    acpi_ec_register_query_methods, NULL, ec, NULL);
1167

1168 1169
	if (!first_ec)
		first_ec = ec;
1170
	device->driver_data = ec;
1171

1172 1173 1174 1175
	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);
1176

1177
	pr_info("GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n",
1178
			  ec->gpe, ec->command_addr, ec->data_addr);
1179 1180 1181

	ret = ec_install_handlers(ec);

1182 1183 1184
	/* Reprobe devices depending on the EC */
	acpi_walk_dep_device_list(ec->handle);

1185
	/* EC is fully operational, allow queries */
1186
	clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
1187 1188

	/* Clear stale _Q events if hardware might require that */
L
Lv Zheng 已提交
1189
	if (EC_FLAGS_CLEAR_ON_RESUME)
1190
		acpi_ec_clear(ec);
1191
	return ret;
L
Linus Torvalds 已提交
1192 1193
}

1194
static int acpi_ec_remove(struct acpi_device *device)
L
Linus Torvalds 已提交
1195
{
1196
	struct acpi_ec *ec;
1197
	struct acpi_ec_query_handler *handler, *tmp;
L
Linus Torvalds 已提交
1198 1199

	if (!device)
1200
		return -EINVAL;
L
Linus Torvalds 已提交
1201 1202

	ec = acpi_driver_data(device);
B
Bjorn Helgaas 已提交
1203
	ec_remove_handlers(ec);
1204
	mutex_lock(&ec->mutex);
1205
	list_for_each_entry_safe(handler, tmp, &ec->list, node) {
1206 1207 1208
		list_del(&handler->node);
		kfree(handler);
	}
1209
	mutex_unlock(&ec->mutex);
1210 1211
	release_region(ec->data_addr, 1);
	release_region(ec->command_addr, 1);
1212
	device->driver_data = NULL;
1213
	if (ec == first_ec)
1214
		first_ec = NULL;
1215
	kfree(ec);
1216
	return 0;
L
Linus Torvalds 已提交
1217 1218 1219
}

static acpi_status
1220
ec_parse_io_ports(struct acpi_resource *resource, void *context)
L
Linus Torvalds 已提交
1221
{
1222
	struct acpi_ec *ec = context;
L
Linus Torvalds 已提交
1223

1224
	if (resource->type != ACPI_RESOURCE_TYPE_IO)
L
Linus Torvalds 已提交
1225 1226 1227 1228 1229 1230 1231
		return AE_OK;

	/*
	 * The first address region returned is the data port, and
	 * the second address region returned is the status/command
	 * port.
	 */
1232
	if (ec->data_addr == 0)
1233
		ec->data_addr = resource->data.io.minimum;
1234
	else if (ec->command_addr == 0)
1235
		ec->command_addr = resource->data.io.minimum;
1236
	else
L
Linus Torvalds 已提交
1237 1238 1239 1240 1241
		return AE_CTRL_TERMINATE;

	return AE_OK;
}

1242 1243
int __init acpi_boot_ec_enable(void)
{
1244
	if (!boot_ec || test_bit(EC_FLAGS_HANDLERS_INSTALLED, &boot_ec->flags))
1245 1246 1247 1248 1249 1250 1251 1252
		return 0;
	if (!ec_install_handlers(boot_ec)) {
		first_ec = boot_ec;
		return 0;
	}
	return -EFAULT;
}

1253 1254 1255 1256 1257
static const struct acpi_device_id ec_device_ids[] = {
	{"PNP0C09", 0},
	{"", 0},
};

1258 1259 1260 1261 1262 1263 1264
/* 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 已提交
1265 1266 1267 1268 1269 1270 1271
/* 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;
}

1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283
/*
 * Acer EC firmware refuses to respond QR_EC when SCI_EVT is not set, for
 * which case, we complete the QR_EC without issuing it to the firmware.
 * https://bugzilla.kernel.org/show_bug.cgi?id=86211
 */
static int ec_flag_query_handshake(const struct dmi_system_id *id)
{
	pr_debug("Detected the EC firmware requiring QR_EC issued when SCI_EVT set\n");
	EC_FLAGS_QUERY_HANDSHAKE = 1;
	return 0;
}

1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307
/*
 * On some hardware it is necessary to clear events accumulated by the EC during
 * sleep. These ECs stop reporting GPEs until they are manually polled, if too
 * many events are accumulated. (e.g. Samsung Series 5/9 notebooks)
 *
 * https://bugzilla.kernel.org/show_bug.cgi?id=44161
 *
 * Ideally, the EC should also be instructed NOT to accumulate events during
 * sleep (which Windows seems to do somehow), but the interface to control this
 * behaviour is not known at this time.
 *
 * Models known to be affected are Samsung 530Uxx/535Uxx/540Uxx/550Pxx/900Xxx,
 * however it is very likely that other Samsung models are affected.
 *
 * On systems which don't accumulate _Q events during sleep, this extra check
 * should be harmless.
 */
static int ec_clear_on_resume(const struct dmi_system_id *id)
{
	pr_debug("Detected system needing EC poll on resume.\n");
	EC_FLAGS_CLEAR_ON_RESUME = 1;
	return 0;
}

1308
static struct dmi_system_id ec_dmi_table[] __initdata = {
1309 1310 1311 1312
	{
	ec_skip_dsdt_scan, "Compal JFL92", {
	DMI_MATCH(DMI_BIOS_VENDOR, "COMPAL"),
	DMI_MATCH(DMI_BOARD_NAME, "JFL92") }, NULL},
A
Alexey Starikovskiy 已提交
1313
	{
1314 1315 1316
	ec_validate_ecdt, "MSI MS-171F", {
	DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star"),
	DMI_MATCH(DMI_PRODUCT_NAME, "MS-171F"),}, NULL},
1317
	{
A
Alexey Starikovskiy 已提交
1318 1319
	ec_validate_ecdt, "ASUS hardware", {
	DMI_MATCH(DMI_BIOS_VENDOR, "ASUS") }, NULL},
1320 1321 1322
	{
	ec_validate_ecdt, "ASUS hardware", {
	DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer Inc.") }, NULL},
1323
	{
1324 1325 1326
	ec_skip_dsdt_scan, "HP Folio 13", {
	DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
	DMI_MATCH(DMI_PRODUCT_NAME, "HP Folio 13"),}, NULL},
1327 1328 1329 1330
	{
	ec_validate_ecdt, "ASUS hardware", {
	DMI_MATCH(DMI_SYS_VENDOR, "ASUSTek Computer Inc."),
	DMI_MATCH(DMI_PRODUCT_NAME, "L4R"),}, NULL},
1331 1332 1333
	{
	ec_clear_on_resume, "Samsung hardware", {
	DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD.")}, NULL},
1334 1335 1336
	{
	ec_flag_query_handshake, "Acer hardware", {
	DMI_MATCH(DMI_SYS_VENDOR, "Acer"), }, NULL},
A
Alexey Starikovskiy 已提交
1337 1338 1339
	{},
};

1340 1341 1342
int __init acpi_ec_ecdt_probe(void)
{
	acpi_status status;
1343
	struct acpi_ec *saved_ec = NULL;
L
Len Brown 已提交
1344
	struct acpi_table_ecdt *ecdt_ptr;
L
Luming Yu 已提交
1345

1346 1347
	boot_ec = make_acpi_ec();
	if (!boot_ec)
1348 1349 1350 1351
		return -ENOMEM;
	/*
	 * Generate a boot ec context
	 */
A
Alexey Starikovskiy 已提交
1352
	dmi_check_system(ec_dmi_table);
1353 1354
	status = acpi_get_table(ACPI_SIG_ECDT, 1,
				(struct acpi_table_header **)&ecdt_ptr);
1355
	if (ACPI_SUCCESS(status)) {
1356
		pr_info("EC description table is found, configuring boot EC\n");
1357 1358 1359
		boot_ec->command_addr = ecdt_ptr->control.address;
		boot_ec->data_addr = ecdt_ptr->data.address;
		boot_ec->gpe = ecdt_ptr->gpe;
1360
		boot_ec->handle = ACPI_ROOT_OBJECT;
L
Lv Zheng 已提交
1361 1362
		acpi_get_handle(ACPI_ROOT_OBJECT, ecdt_ptr->id,
				&boot_ec->handle);
1363
		/* Don't trust ECDT, which comes from ASUSTek */
A
Alexey Starikovskiy 已提交
1364
		if (!EC_FLAGS_VALIDATE_ECDT)
1365
			goto install;
J
Julia Lawall 已提交
1366
		saved_ec = kmemdup(boot_ec, sizeof(struct acpi_ec), GFP_KERNEL);
1367 1368
		if (!saved_ec)
			return -ENOMEM;
1369
	/* fall through */
1370
	}
A
Alexey Starikovskiy 已提交
1371

1372 1373
	if (EC_FLAGS_SKIP_DSDT_SCAN) {
		kfree(saved_ec);
1374
		return -ENODEV;
1375
	}
1376

1377 1378
	/* This workaround is needed only on some broken machines,
	 * which require early EC, but fail to provide ECDT */
1379
	pr_debug("Look up EC in DSDT\n");
1380 1381 1382 1383 1384
	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;
1385 1386 1387 1388 1389 1390
	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)
1391
			pr_info("ASUSTek keeps feeding us with broken "
1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402
			"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.
		*/
		if (!dmi_name_in_vendors("ASUS") ||
1403
		    !acpi_has_method(boot_ec->handle, "_INI"))
1404 1405
			return -ENODEV;
	}
1406 1407
install:
	if (!ec_install_handlers(boot_ec)) {
1408
		first_ec = boot_ec;
1409
		return 0;
1410
	}
1411
error:
1412
	kfree(boot_ec);
1413
	kfree(saved_ec);
1414
	boot_ec = NULL;
L
Linus Torvalds 已提交
1415 1416 1417
	return -ENODEV;
}

1418 1419 1420 1421 1422 1423 1424 1425 1426 1427
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,
		},
};

1428
int __init acpi_ec_init(void)
L
Linus Torvalds 已提交
1429
{
L
Len Brown 已提交
1430
	int result = 0;
L
Linus Torvalds 已提交
1431 1432 1433

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

1437
	return result;
L
Linus Torvalds 已提交
1438 1439 1440 1441
}

/* EC driver currently not unloadable */
#if 0
L
Len Brown 已提交
1442
static void __exit acpi_ec_exit(void)
L
Linus Torvalds 已提交
1443 1444 1445 1446
{

	acpi_bus_unregister_driver(&acpi_ec_driver);
}
1447
#endif	/* 0 */