ec.c 26.1 KB
Newer Older
L
Linus Torvalds 已提交
1
/*
2
 *  ec.c - ACPI Embedded Controller Driver (v2.0)
L
Linus Torvalds 已提交
3
 *
4 5
 *  Copyright (C) 2006, 2007 Alexey Starikovskiy <alexey.y.starikovskiy@intel.com>
 *  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 30 31
/* Uncomment next line to get verbose print outs*/
/* #define DEBUG */

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

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

50 51
#undef PREFIX
#define PREFIX				"ACPI: EC: "
52

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

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

68
/* EC events */
69
enum ec_event {
70
	ACPI_EC_EVENT_OBF_1 = 1,	/* Output buffer full */
71
	ACPI_EC_EVENT_IBF_0,		/* Input buffer empty */
72 73
};

74
#define ACPI_EC_DELAY		500	/* Wait 500ms max. during EC ops */
75
#define ACPI_EC_UDELAY_GLK	1000	/* Wait 1ms max. to get global lock */
76
#define ACPI_EC_UDELAY		100	/* Wait 100us before polling EC again */
77

78 79 80
enum {
	EC_FLAGS_WAIT_GPE = 0,		/* Don't check status until GPE arrives */
	EC_FLAGS_QUERY_PENDING,		/* Query is pending */
81
	EC_FLAGS_GPE_MODE,		/* Expect GPE to be sent for status change */
82
	EC_FLAGS_NO_GPE,		/* Don't use GPE mode */
A
Alexey Starikovskiy 已提交
83
	EC_FLAGS_RESCHEDULE_POLL	/* Re-schedule poll */
L
Linus Torvalds 已提交
84
};
85 86

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

98
static struct acpi_ec {
99
	acpi_handle handle;
100
	unsigned long gpe;
101 102
	unsigned long command_addr;
	unsigned long data_addr;
103
	unsigned long global_lock;
104
	unsigned long flags;
105
	struct mutex lock;
106
	wait_queue_head_t wait;
107
	struct list_head list;
A
Alexey Starikovskiy 已提交
108
	struct delayed_work work;
A
Alexey Starikovskiy 已提交
109
	atomic_t irq_count;
110
	u8 handlers_installed;
111
} *boot_ec, *first_ec;
112

113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
/* 
 * Some Asus system have exchanged ECDT data/command IO addresses.
 */
static int print_ecdt_error(const struct dmi_system_id *id)
{
	printk(KERN_NOTICE PREFIX "%s detected - "
		"ECDT has exchanged control/data I/O address\n",
		id->ident);
	return 0;
}

static struct dmi_system_id __cpuinitdata ec_dmi_table[] = {
	{
	print_ecdt_error, "Asus L4R", {
	DMI_MATCH(DMI_BIOS_VERSION, "1008.006"),
	DMI_MATCH(DMI_PRODUCT_NAME, "L4R"),
	DMI_MATCH(DMI_BOARD_NAME, "L4R") }, NULL},
	{
	print_ecdt_error, "Asus M6R", {
	DMI_MATCH(DMI_BIOS_VERSION, "0207"),
	DMI_MATCH(DMI_PRODUCT_NAME, "M6R"),
	DMI_MATCH(DMI_BOARD_NAME, "M6R") }, NULL},
	{},
};

L
Linus Torvalds 已提交
138 139 140 141
/* --------------------------------------------------------------------------
                             Transaction Management
   -------------------------------------------------------------------------- */

142
static inline u8 acpi_ec_read_status(struct acpi_ec *ec)
L
Linus Torvalds 已提交
143
{
144
	u8 x = inb(ec->command_addr);
145
	pr_debug(PREFIX "---> status = 0x%2.2x\n", x);
146
	return x;
D
Dmitry Torokhov 已提交
147 148
}

149
static inline u8 acpi_ec_read_data(struct acpi_ec *ec)
150
{
151
	u8 x = inb(ec->data_addr);
152
	pr_debug(PREFIX "---> data = 0x%2.2x\n", x);
153
	return inb(ec->data_addr);
154 155
}

156
static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command)
L
Luming Yu 已提交
157
{
158
	pr_debug(PREFIX "<--- command = 0x%2.2x\n", command);
159
	outb(command, ec->command_addr);
L
Luming Yu 已提交
160 161
}

162
static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data)
L
Luming Yu 已提交
163
{
164
	pr_debug(PREFIX "<--- data = 0x%2.2x\n", data);
165
	outb(data, ec->data_addr);
166
}
L
Luming Yu 已提交
167

168
static inline int acpi_ec_check_status(struct acpi_ec *ec, enum ec_event event)
169
{
170
	if (test_bit(EC_FLAGS_WAIT_GPE, &ec->flags))
171
		return 0;
A
Alexey Starikovskiy 已提交
172
	if (event == ACPI_EC_EVENT_OBF_1) {
173
		if (acpi_ec_read_status(ec) & ACPI_EC_FLAG_OBF)
174
			return 1;
A
Alexey Starikovskiy 已提交
175
	} else if (event == ACPI_EC_EVENT_IBF_0) {
176
		if (!(acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF))
177
			return 1;
L
Luming Yu 已提交
178 179
	}

180
	return 0;
L
Luming Yu 已提交
181
}
D
Dmitry Torokhov 已提交
182

A
Alexey Starikovskiy 已提交
183
static void ec_schedule_ec_poll(struct acpi_ec *ec)
184
{
A
Alexey Starikovskiy 已提交
185 186 187 188
	if (test_bit(EC_FLAGS_RESCHEDULE_POLL, &ec->flags))
		schedule_delayed_work(&ec->work,
				      msecs_to_jiffies(ACPI_EC_DELAY));
}
189

A
Alexey Starikovskiy 已提交
190 191
static void ec_switch_to_poll_mode(struct acpi_ec *ec)
{
192
	set_bit(EC_FLAGS_NO_GPE, &ec->flags);
A
Alexey Starikovskiy 已提交
193 194 195 196 197
	clear_bit(EC_FLAGS_GPE_MODE, &ec->flags);
	acpi_disable_gpe(NULL, ec->gpe, ACPI_NOT_ISR);
	set_bit(EC_FLAGS_RESCHEDULE_POLL, &ec->flags);
}

198
static int acpi_ec_wait(struct acpi_ec *ec, enum ec_event event, int force_poll)
199
{
A
Alexey Starikovskiy 已提交
200
	atomic_set(&ec->irq_count, 0);
201 202
	if (likely(test_bit(EC_FLAGS_GPE_MODE, &ec->flags)) &&
	    likely(!force_poll)) {
203 204
		if (wait_event_timeout(ec->wait, acpi_ec_check_status(ec, event),
				       msecs_to_jiffies(ACPI_EC_DELAY)))
205
			return 0;
206 207
		clear_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
		if (acpi_ec_check_status(ec, event)) {
208 209 210
			/* missing GPEs, switch back to poll mode */
			if (printk_ratelimit())
				pr_info(PREFIX "missing confirmations, "
211
						"switch off interrupt mode.\n");
212 213 214
			ec_switch_to_poll_mode(ec);
			ec_schedule_ec_poll(ec);
			return 0;
215
		}
216 217 218 219 220
	} else {
		unsigned long delay = jiffies + msecs_to_jiffies(ACPI_EC_DELAY);
		clear_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
		while (time_before(jiffies, delay)) {
			if (acpi_ec_check_status(ec, event))
221
				return 0;
222
			msleep(1);
223
		}
224 225
		if (acpi_ec_check_status(ec,event))
			return 0;
226
	}
227 228 229
	pr_err(PREFIX "acpi_ec_wait timeout, status = 0x%2.2x, event = %s\n",
		acpi_ec_read_status(ec),
		(event == ACPI_EC_EVENT_OBF_1) ? "\"b0=1\"" : "\"b1=0\"");
230
	return -ETIME;
L
Linus Torvalds 已提交
231 232
}

233
static int acpi_ec_transaction_unlocked(struct acpi_ec *ec, u8 command,
A
Alexey Starikovskiy 已提交
234
					const u8 * wdata, unsigned wdata_len,
235 236
					u8 * rdata, unsigned rdata_len,
					int force_poll)
L
Luming Yu 已提交
237
{
238
	int result = 0;
239
	set_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
240
	pr_debug(PREFIX "transaction start\n");
241
	acpi_ec_write_cmd(ec, command);
A
Alexey Starikovskiy 已提交
242
	for (; wdata_len > 0; --wdata_len) {
243
		result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0, force_poll);
244
		if (result) {
245
			pr_err(PREFIX
A
Alexey Starikovskiy 已提交
246
			       "write_cmd timeout, command = %d\n", command);
247 248
			goto end;
		}
249
		set_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
250
		acpi_ec_write_data(ec, *(wdata++));
251
	}
L
Luming Yu 已提交
252

253
	if (!rdata_len) {
254
		result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0, force_poll);
255
		if (result) {
256
			pr_err(PREFIX
A
Alexey Starikovskiy 已提交
257
			       "finish-write timeout, command = %d\n", command);
258 259
			goto end;
		}
260 261
	} else if (command == ACPI_EC_COMMAND_QUERY)
		clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
L
Luming Yu 已提交
262

A
Alexey Starikovskiy 已提交
263
	for (; rdata_len > 0; --rdata_len) {
264
		result = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF_1, force_poll);
265
		if (result) {
266
			pr_err(PREFIX "read timeout, command = %d\n", command);
267 268
			goto end;
		}
269 270 271
		/* Don't expect GPE after last read */
		if (rdata_len > 1)
			set_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
272
		*(rdata++) = acpi_ec_read_data(ec);
273
	}
274
      end:
275
	pr_debug(PREFIX "transaction end\n");
276
	return result;
L
Luming Yu 已提交
277 278
}

279
static int acpi_ec_transaction(struct acpi_ec *ec, u8 command,
A
Alexey Starikovskiy 已提交
280
			       const u8 * wdata, unsigned wdata_len,
281 282
			       u8 * rdata, unsigned rdata_len,
			       int force_poll)
L
Linus Torvalds 已提交
283
{
284
	int status;
L
Len Brown 已提交
285
	u32 glk;
L
Linus Torvalds 已提交
286

287
	if (!ec || (wdata_len && !wdata) || (rdata_len && !rdata))
288
		return -EINVAL;
L
Linus Torvalds 已提交
289

A
Alexey Starikovskiy 已提交
290 291
	if (rdata)
		memset(rdata, 0, rdata_len);
L
Linus Torvalds 已提交
292

293
	mutex_lock(&ec->lock);
294
	if (ec->global_lock) {
L
Linus Torvalds 已提交
295
		status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
296 297
		if (ACPI_FAILURE(status)) {
			mutex_unlock(&ec->lock);
298
			return -ENODEV;
299
		}
L
Linus Torvalds 已提交
300
	}
D
Dmitry Torokhov 已提交
301

302
	status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0, 0);
303
	if (status) {
304 305
		pr_err(PREFIX "input buffer is not empty, "
				"aborting transaction\n");
D
Dmitry Torokhov 已提交
306
		goto end;
307
	}
L
Linus Torvalds 已提交
308

A
Alexey Starikovskiy 已提交
309 310
	status = acpi_ec_transaction_unlocked(ec, command,
					      wdata, wdata_len,
311 312
					      rdata, rdata_len,
					      force_poll);
L
Linus Torvalds 已提交
313

A
Alexey Starikovskiy 已提交
314
      end:
L
Linus Torvalds 已提交
315

316
	if (ec->global_lock)
L
Linus Torvalds 已提交
317
		acpi_release_global_lock(glk);
318
	mutex_unlock(&ec->lock);
L
Linus Torvalds 已提交
319

320
	return status;
L
Linus Torvalds 已提交
321 322
}

323 324 325 326 327 328 329
/*
 * Note: samsung nv5000 doesn't work with ec burst mode.
 * http://bugzilla.kernel.org/show_bug.cgi?id=4980
 */
int acpi_ec_burst_enable(struct acpi_ec *ec)
{
	u8 d;
330
	return acpi_ec_transaction(ec, ACPI_EC_BURST_ENABLE, NULL, 0, &d, 1, 0);
331 332 333 334
}

int acpi_ec_burst_disable(struct acpi_ec *ec)
{
335
	return acpi_ec_transaction(ec, ACPI_EC_BURST_DISABLE, NULL, 0, NULL, 0, 0);
336 337
}

A
Alexey Starikovskiy 已提交
338
static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 * data)
339 340 341 342 343
{
	int result;
	u8 d;

	result = acpi_ec_transaction(ec, ACPI_EC_COMMAND_READ,
344
				     &address, 1, &d, 1, 0);
345 346 347
	*data = d;
	return result;
}
348

349 350
static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data)
{
A
Alexey Starikovskiy 已提交
351 352
	u8 wdata[2] = { address, data };
	return acpi_ec_transaction(ec, ACPI_EC_COMMAND_WRITE,
353
				   wdata, 2, NULL, 0, 0);
354 355
}

L
Linus Torvalds 已提交
356 357 358
/*
 * Externally callable EC access functions. For now, assume 1 EC only
 */
359 360 361 362
int ec_burst_enable(void)
{
	if (!first_ec)
		return -ENODEV;
363
	return acpi_ec_burst_enable(first_ec);
364 365 366 367 368 369 370 371
}

EXPORT_SYMBOL(ec_burst_enable);

int ec_burst_disable(void)
{
	if (!first_ec)
		return -ENODEV;
372
	return acpi_ec_burst_disable(first_ec);
373 374 375 376
}

EXPORT_SYMBOL(ec_burst_disable);

A
Alexey Starikovskiy 已提交
377
int ec_read(u8 addr, u8 * val)
L
Linus Torvalds 已提交
378 379
{
	int err;
380
	u8 temp_data;
L
Linus Torvalds 已提交
381 382 383 384

	if (!first_ec)
		return -ENODEV;

385
	err = acpi_ec_read(first_ec, addr, &temp_data);
L
Linus Torvalds 已提交
386 387 388 389

	if (!err) {
		*val = temp_data;
		return 0;
L
Len Brown 已提交
390
	} else
L
Linus Torvalds 已提交
391 392
		return err;
}
L
Len Brown 已提交
393

L
Linus Torvalds 已提交
394 395
EXPORT_SYMBOL(ec_read);

L
Len Brown 已提交
396
int ec_write(u8 addr, u8 val)
L
Linus Torvalds 已提交
397 398 399 400 401 402
{
	int err;

	if (!first_ec)
		return -ENODEV;

403
	err = acpi_ec_write(first_ec, addr, val);
L
Linus Torvalds 已提交
404 405 406

	return err;
}
L
Len Brown 已提交
407

L
Linus Torvalds 已提交
408 409
EXPORT_SYMBOL(ec_write);

410
int ec_transaction(u8 command,
411
		   const u8 * wdata, unsigned wdata_len,
412 413
		   u8 * rdata, unsigned rdata_len,
		   int force_poll)
L
Luming Yu 已提交
414
{
415 416
	if (!first_ec)
		return -ENODEV;
L
Luming Yu 已提交
417

418
	return acpi_ec_transaction(first_ec, command, wdata,
419 420
				   wdata_len, rdata, rdata_len,
				   force_poll);
L
Luming Yu 已提交
421
}
L
Linus Torvalds 已提交
422

423 424
EXPORT_SYMBOL(ec_transaction);

A
Alexey Starikovskiy 已提交
425
static int acpi_ec_query(struct acpi_ec *ec, u8 * data)
426 427
{
	int result;
A
Alexey Starikovskiy 已提交
428
	u8 d;
L
Linus Torvalds 已提交
429

A
Alexey Starikovskiy 已提交
430 431
	if (!ec || !data)
		return -EINVAL;
L
Linus Torvalds 已提交
432

A
Alexey Starikovskiy 已提交
433 434 435 436 437
	/*
	 * 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).
	 */
438

439
	result = acpi_ec_transaction(ec, ACPI_EC_COMMAND_QUERY, NULL, 0, &d, 1, 0);
A
Alexey Starikovskiy 已提交
440 441
	if (result)
		return result;
L
Linus Torvalds 已提交
442

A
Alexey Starikovskiy 已提交
443 444
	if (!d)
		return -ENODATA;
L
Linus Torvalds 已提交
445

A
Alexey Starikovskiy 已提交
446 447
	*data = d;
	return 0;
L
Linus Torvalds 已提交
448 449 450 451 452
}

/* --------------------------------------------------------------------------
                                Event Management
   -------------------------------------------------------------------------- */
453 454 455 456 457 458 459 460 461 462 463 464 465 466
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);
467
	list_add(&handler->node, &ec->list);
468 469 470 471 472 473 474 475
	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 已提交
476
	struct acpi_ec_query_handler *handler, *tmp;
477
	mutex_lock(&ec->lock);
A
Adrian Bunk 已提交
478
	list_for_each_entry_safe(handler, tmp, &ec->list, node) {
479 480 481 482 483 484 485 486 487
		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 已提交
488

L
Len Brown 已提交
489
static void acpi_ec_gpe_query(void *ec_cxt)
L
Luming Yu 已提交
490
{
491
	struct acpi_ec *ec = ec_cxt;
492
	u8 value = 0;
493
	struct acpi_ec_query_handler *handler, copy;
L
Luming Yu 已提交
494

495
	if (!ec || acpi_ec_query(ec, &value))
496
		return;
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
	mutex_lock(&ec->lock);
	list_for_each_entry(handler, &ec->list, node) {
		if (value == handler->query_bit) {
			/* have custom handler for this bit */
			memcpy(&copy, handler, sizeof(copy));
			mutex_unlock(&ec->lock);
			if (copy.func) {
				copy.func(copy.data);
			} else if (copy.handle) {
				acpi_evaluate_object(copy.handle, NULL, NULL, NULL);
			}
			return;
		}
	}
	mutex_unlock(&ec->lock);
L
Luming Yu 已提交
512
}
L
Linus Torvalds 已提交
513

L
Len Brown 已提交
514
static u32 acpi_ec_gpe_handler(void *data)
L
Linus Torvalds 已提交
515
{
L
Len Brown 已提交
516
	acpi_status status = AE_OK;
517
	struct acpi_ec *ec = data;
A
Alexey Starikovskiy 已提交
518
	u8 state = acpi_ec_read_status(ec);
519

520
	pr_debug(PREFIX "~~~> interrupt\n");
A
Alexey Starikovskiy 已提交
521 522 523 524 525 526
	atomic_inc(&ec->irq_count);
	if (atomic_read(&ec->irq_count) > 5) {
		pr_err(PREFIX "GPE storm detected, disabling EC GPE\n");
		ec_switch_to_poll_mode(ec);
		goto end;
	}
527
	clear_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
528
	if (test_bit(EC_FLAGS_GPE_MODE, &ec->flags))
529
		wake_up(&ec->wait);
D
Dmitry Torokhov 已提交
530

A
Alexey Starikovskiy 已提交
531
	if (state & ACPI_EC_FLAG_SCI) {
532 533 534
		if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags))
			status = acpi_os_execute(OSL_EC_BURST_HANDLER,
				acpi_ec_gpe_query, ec);
A
Alexey Starikovskiy 已提交
535
	} else if (!test_bit(EC_FLAGS_GPE_MODE, &ec->flags) &&
536
		   !test_bit(EC_FLAGS_NO_GPE, &ec->flags) &&
A
Alexey Starikovskiy 已提交
537
		   in_interrupt()) {
538
		/* this is non-query, must be confirmation */
539 540 541
		if (printk_ratelimit())
			pr_info(PREFIX "non-query interrupt received,"
				" switching to interrupt mode\n");
542
		set_bit(EC_FLAGS_GPE_MODE, &ec->flags);
A
Alexey Starikovskiy 已提交
543
		clear_bit(EC_FLAGS_RESCHEDULE_POLL, &ec->flags);
544
	}
A
Alexey Starikovskiy 已提交
545
end:
A
Alexey Starikovskiy 已提交
546
	ec_schedule_ec_poll(ec);
547
	return ACPI_SUCCESS(status) ?
L
Len Brown 已提交
548
	    ACPI_INTERRUPT_HANDLED : ACPI_INTERRUPT_NOT_HANDLED;
L
Linus Torvalds 已提交
549 550
}

A
Alexey Starikovskiy 已提交
551 552 553
static void do_ec_poll(struct work_struct *work)
{
	struct acpi_ec *ec = container_of(work, struct acpi_ec, work.work);
A
Alexey Starikovskiy 已提交
554
	atomic_set(&ec->irq_count, 0);
A
Alexey Starikovskiy 已提交
555 556 557
	(void)acpi_ec_gpe_handler(ec);
}

L
Linus Torvalds 已提交
558 559 560 561 562
/* --------------------------------------------------------------------------
                             Address Space Management
   -------------------------------------------------------------------------- */

static acpi_status
563 564
acpi_ec_space_handler(u32 function, acpi_physical_address address,
		      u32 bits, acpi_integer *value,
L
Len Brown 已提交
565
		      void *handler_context, void *region_context)
L
Linus Torvalds 已提交
566
{
567
	struct acpi_ec *ec = handler_context;
568
	int result = 0, i;
569
	u8 temp = 0;
L
Linus Torvalds 已提交
570 571

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

574
	if (function != ACPI_READ && function != ACPI_WRITE)
575
		return AE_BAD_PARAMETER;
L
Linus Torvalds 已提交
576

577 578
	if (bits != 8 && acpi_strict)
		return AE_BAD_PARAMETER;
L
Linus Torvalds 已提交
579

580 581
	acpi_ec_burst_enable(ec);

582 583 584 585 586 587 588 589 590 591
	if (function == ACPI_READ) {
		result = acpi_ec_read(ec, address, &temp);
		*value = temp;
	} else {
		temp = 0xff & (*value);
		result = acpi_ec_write(ec, address, temp);
	}

	for (i = 8; unlikely(bits - i > 0); i += 8) {
		++address;
592 593 594 595 596 597 598
		if (function == ACPI_READ) {
			result = acpi_ec_read(ec, address, &temp);
			(*value) |= ((acpi_integer)temp) << i;
		} else {
			temp = 0xff & ((*value) >> i);
			result = acpi_ec_write(ec, address, temp);
		}
L
Linus Torvalds 已提交
599 600
	}

601 602
	acpi_ec_burst_disable(ec);

L
Linus Torvalds 已提交
603 604
	switch (result) {
	case -EINVAL:
605
		return AE_BAD_PARAMETER;
L
Linus Torvalds 已提交
606 607
		break;
	case -ENODEV:
608
		return AE_NOT_FOUND;
L
Linus Torvalds 已提交
609 610
		break;
	case -ETIME:
611
		return AE_TIME;
L
Linus Torvalds 已提交
612 613
		break;
	default:
614
		return AE_OK;
L
Linus Torvalds 已提交
615 616 617 618 619 620 621
	}
}

/* --------------------------------------------------------------------------
                              FS Interface (/proc)
   -------------------------------------------------------------------------- */

L
Len Brown 已提交
622
static struct proc_dir_entry *acpi_ec_dir;
L
Linus Torvalds 已提交
623

L
Len Brown 已提交
624
static int acpi_ec_read_info(struct seq_file *seq, void *offset)
L
Linus Torvalds 已提交
625
{
626
	struct acpi_ec *ec = seq->private;
L
Linus Torvalds 已提交
627 628 629 630

	if (!ec)
		goto end;

631 632 633 634
	seq_printf(seq, "gpe:\t\t\t0x%02x\n", (u32) ec->gpe);
	seq_printf(seq, "ports:\t\t\t0x%02x, 0x%02x\n",
		   (unsigned)ec->command_addr, (unsigned)ec->data_addr);
	seq_printf(seq, "use global lock:\t%s\n",
635
		   ec->global_lock ? "yes" : "no");
L
Len Brown 已提交
636
      end:
637
	return 0;
L
Linus Torvalds 已提交
638 639 640 641 642 643 644
}

static int acpi_ec_info_open_fs(struct inode *inode, struct file *file)
{
	return single_open(file, acpi_ec_read_info, PDE(inode)->data);
}

645
static struct file_operations acpi_ec_info_ops = {
L
Len Brown 已提交
646 647 648 649
	.open = acpi_ec_info_open_fs,
	.read = seq_read,
	.llseek = seq_lseek,
	.release = single_release,
L
Linus Torvalds 已提交
650 651 652
	.owner = THIS_MODULE,
};

L
Len Brown 已提交
653
static int acpi_ec_add_fs(struct acpi_device *device)
L
Linus Torvalds 已提交
654
{
L
Len Brown 已提交
655
	struct proc_dir_entry *entry = NULL;
L
Linus Torvalds 已提交
656 657 658

	if (!acpi_device_dir(device)) {
		acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
L
Len Brown 已提交
659
						     acpi_ec_dir);
L
Linus Torvalds 已提交
660
		if (!acpi_device_dir(device))
661
			return -ENODEV;
L
Linus Torvalds 已提交
662 663
	}

664 665 666
	entry = proc_create_data(ACPI_EC_FILE_INFO, S_IRUGO,
				 acpi_device_dir(device),
				 &acpi_ec_info_ops, acpi_driver_data(device));
L
Linus Torvalds 已提交
667
	if (!entry)
668 669
		return -ENODEV;
	return 0;
L
Linus Torvalds 已提交
670 671
}

L
Len Brown 已提交
672
static int acpi_ec_remove_fs(struct acpi_device *device)
L
Linus Torvalds 已提交
673 674 675 676 677 678 679 680
{

	if (acpi_device_dir(device)) {
		remove_proc_entry(ACPI_EC_FILE_INFO, acpi_device_dir(device));
		remove_proc_entry(acpi_device_bid(device), acpi_ec_dir);
		acpi_device_dir(device) = NULL;
	}

681
	return 0;
L
Linus Torvalds 已提交
682 683 684 685 686
}

/* --------------------------------------------------------------------------
                               Driver Interface
   -------------------------------------------------------------------------- */
687 688 689 690 691 692 693 694
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;
695
	ec->flags = 1 << EC_FLAGS_QUERY_PENDING;
696 697
	mutex_init(&ec->lock);
	init_waitqueue_head(&ec->wait);
698
	INIT_LIST_HEAD(&ec->list);
A
Alexey Starikovskiy 已提交
699
	INIT_DELAYED_WORK_DEFERRABLE(&ec->work, do_ec_poll);
A
Alexey Starikovskiy 已提交
700
	atomic_set(&ec->irq_count, 0);
701 702
	return ec;
}
703

704 705 706 707 708 709 710 711 712 713 714 715 716
static acpi_status
acpi_ec_register_query_methods(acpi_handle handle, u32 level,
			       void *context, void **return_value)
{
	struct acpi_namespace_node *node = handle;
	struct acpi_ec *ec = context;
	int value = 0;
	if (sscanf(node->name.ascii, "_Q%x", &value) == 1) {
		acpi_ec_add_query_handler(ec, value, handle, NULL, NULL);
	}
	return AE_OK;
}

717 718
static acpi_status
ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval)
719
{
720 721 722 723 724 725 726
	acpi_status status;

	struct acpi_ec *ec = context;
	status = acpi_walk_resources(handle, METHOD_NAME__CRS,
				     ec_parse_io_ports, ec);
	if (ACPI_FAILURE(status))
		return status;
727 728 729

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

A
Alexey Starikovskiy 已提交
739 740 741 742 743 744
static void ec_poll_stop(struct acpi_ec *ec)
{
	clear_bit(EC_FLAGS_RESCHEDULE_POLL, &ec->flags);
	cancel_delayed_work(&ec->work);
}

745 746
static void ec_remove_handlers(struct acpi_ec *ec)
{
A
Alexey Starikovskiy 已提交
747
	ec_poll_stop(ec);
748 749
	if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle,
				ACPI_ADR_SPACE_EC, &acpi_ec_space_handler)))
750
		pr_err(PREFIX "failed to remove space handler\n");
751 752
	if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe,
				&acpi_ec_gpe_handler)))
753
		pr_err(PREFIX "failed to remove gpe handler\n");
754 755 756
	ec->handlers_installed = 0;
}

757
static int acpi_ec_add(struct acpi_device *device)
L
Linus Torvalds 已提交
758
{
759
	struct acpi_ec *ec = NULL;
L
Luming Yu 已提交
760 761

	if (!device)
762
		return -EINVAL;
763 764 765
	strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
	strcpy(acpi_device_class(device), ACPI_EC_CLASS);

766
	/* Check for boot EC */
767 768 769 770 771 772 773 774 775 776 777 778 779
	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;
		if (ec_parse_device(device->handle, 0, ec, NULL) !=
		    AE_CTRL_TERMINATE) {
			kfree(ec);
			return -EINVAL;
780 781 782
		}
	}

783
	ec->handle = device->handle;
784 785 786 787 788

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

789 790
	if (!first_ec)
		first_ec = ec;
791 792
	acpi_driver_data(device) = ec;
	acpi_ec_add_fs(device);
793
	pr_info(PREFIX "GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n",
794
			  ec->gpe, ec->command_addr, ec->data_addr);
795
	pr_info(PREFIX "driver started in %s mode\n",
796
		(test_bit(EC_FLAGS_GPE_MODE, &ec->flags))?"interrupt":"poll");
797
	return 0;
L
Linus Torvalds 已提交
798 799
}

L
Len Brown 已提交
800
static int acpi_ec_remove(struct acpi_device *device, int type)
L
Linus Torvalds 已提交
801
{
802
	struct acpi_ec *ec;
803
	struct acpi_ec_query_handler *handler, *tmp;
L
Linus Torvalds 已提交
804 805

	if (!device)
806
		return -EINVAL;
L
Linus Torvalds 已提交
807 808

	ec = acpi_driver_data(device);
809
	mutex_lock(&ec->lock);
810
	list_for_each_entry_safe(handler, tmp, &ec->list, node) {
811 812 813 814
		list_del(&handler->node);
		kfree(handler);
	}
	mutex_unlock(&ec->lock);
L
Linus Torvalds 已提交
815
	acpi_ec_remove_fs(device);
816
	acpi_driver_data(device) = NULL;
817
	if (ec == first_ec)
818
		first_ec = NULL;
819
	kfree(ec);
820
	return 0;
L
Linus Torvalds 已提交
821 822 823
}

static acpi_status
824
ec_parse_io_ports(struct acpi_resource *resource, void *context)
L
Linus Torvalds 已提交
825
{
826
	struct acpi_ec *ec = context;
L
Linus Torvalds 已提交
827

828
	if (resource->type != ACPI_RESOURCE_TYPE_IO)
L
Linus Torvalds 已提交
829 830 831 832 833 834 835
		return AE_OK;

	/*
	 * The first address region returned is the data port, and
	 * the second address region returned is the status/command
	 * port.
	 */
836
	if (ec->data_addr == 0)
837
		ec->data_addr = resource->data.io.minimum;
838
	else if (ec->command_addr == 0)
839
		ec->command_addr = resource->data.io.minimum;
840
	else
L
Linus Torvalds 已提交
841 842 843 844 845
		return AE_CTRL_TERMINATE;

	return AE_OK;
}

846 847
static int ec_install_handlers(struct acpi_ec *ec)
{
848
	acpi_status status;
849 850
	if (ec->handlers_installed)
		return 0;
851 852 853
	status = acpi_install_gpe_handler(NULL, ec->gpe,
					  ACPI_GPE_EDGE_TRIGGERED,
					  &acpi_ec_gpe_handler, ec);
854 855
	if (ACPI_FAILURE(status))
		return -ENODEV;
856

857 858 859 860 861 862
	acpi_set_gpe_type(NULL, ec->gpe, ACPI_GPE_TYPE_RUNTIME);
	acpi_enable_gpe(NULL, ec->gpe, ACPI_NOT_ISR);

	status = acpi_install_address_space_handler(ec->handle,
						    ACPI_ADR_SPACE_EC,
						    &acpi_ec_space_handler,
863
						    NULL, ec);
864 865 866 867 868
	if (ACPI_FAILURE(status)) {
		acpi_remove_gpe_handler(NULL, ec->gpe, &acpi_ec_gpe_handler);
		return -ENODEV;
	}

869
	ec->handlers_installed = 1;
870 871 872
	return 0;
}

L
Len Brown 已提交
873
static int acpi_ec_start(struct acpi_device *device)
L
Linus Torvalds 已提交
874
{
875
	struct acpi_ec *ec;
876
	int ret = 0;
L
Linus Torvalds 已提交
877 878

	if (!device)
879
		return -EINVAL;
L
Linus Torvalds 已提交
880 881 882 883

	ec = acpi_driver_data(device);

	if (!ec)
884
		return -EINVAL;
L
Linus Torvalds 已提交
885

886
	ret = ec_install_handlers(ec);
887 888

	/* EC is fully operational, allow queries */
889
	clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
A
Alexey Starikovskiy 已提交
890
	ec_schedule_ec_poll(ec);
891
	return ret;
L
Linus Torvalds 已提交
892 893
}

L
Len Brown 已提交
894
static int acpi_ec_stop(struct acpi_device *device, int type)
L
Linus Torvalds 已提交
895
{
896
	struct acpi_ec *ec;
L
Linus Torvalds 已提交
897
	if (!device)
898
		return -EINVAL;
L
Linus Torvalds 已提交
899
	ec = acpi_driver_data(device);
900 901
	if (!ec)
		return -EINVAL;
902
	ec_remove_handlers(ec);
903

904
	return 0;
L
Linus Torvalds 已提交
905 906
}

907 908 909 910 911 912 913 914 915 916 917
int __init acpi_boot_ec_enable(void)
{
	if (!boot_ec || boot_ec->handlers_installed)
		return 0;
	if (!ec_install_handlers(boot_ec)) {
		first_ec = boot_ec;
		return 0;
	}
	return -EFAULT;
}

918 919 920 921 922
static const struct acpi_device_id ec_device_ids[] = {
	{"PNP0C09", 0},
	{"", 0},
};

923 924 925 926
int __init acpi_ec_ecdt_probe(void)
{
	int ret;
	acpi_status status;
L
Len Brown 已提交
927
	struct acpi_table_ecdt *ecdt_ptr;
L
Luming Yu 已提交
928

929 930
	boot_ec = make_acpi_ec();
	if (!boot_ec)
931 932 933 934
		return -ENOMEM;
	/*
	 * Generate a boot ec context
	 */
935 936
	status = acpi_get_table(ACPI_SIG_ECDT, 1,
				(struct acpi_table_header **)&ecdt_ptr);
937
	if (ACPI_SUCCESS(status)) {
938
		pr_info(PREFIX "EC description table is found, configuring boot EC\n");
939 940
		boot_ec->command_addr = ecdt_ptr->control.address;
		boot_ec->data_addr = ecdt_ptr->data.address;
941 942 943 944 945 946 947 948 949
		if (dmi_check_system(ec_dmi_table)) {
			/*
			 * If the board falls into ec_dmi_table, it means
			 * that ECDT table gives the incorrect command/status
			 * & data I/O address. Just fix it.
			 */
			boot_ec->data_addr = ecdt_ptr->control.address;
			boot_ec->command_addr = ecdt_ptr->data.address;
		}
950
		boot_ec->gpe = ecdt_ptr->gpe;
951
		boot_ec->handle = ACPI_ROOT_OBJECT;
952
		acpi_get_handle(ACPI_ROOT_OBJECT, ecdt_ptr->id, &boot_ec->handle);
953
	} else {
954 955 956
		/* This workaround is needed only on some broken machines,
		 * which require early EC, but fail to provide ECDT */
		acpi_handle x;
957 958 959
		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);
960 961
		/* Check that acpi_get_devices actually find something */
		if (ACPI_FAILURE(status) || !boot_ec->handle)
962
			goto error;
963 964
		/* We really need to limit this workaround, the only ASUS,
		 * which needs it, has fake EC._INI method, so use it as flag.
965
		 * Keep boot_ec struct as it will be needed soon.
966 967
		 */
		if (ACPI_FAILURE(acpi_get_handle(boot_ec->handle, "_INI", &x)))
968
			return -ENODEV;
969
	}
L
Linus Torvalds 已提交
970

971
	ret = ec_install_handlers(boot_ec);
972 973
	if (!ret) {
		first_ec = boot_ec;
974
		return 0;
975
	}
976
      error:
977 978
	kfree(boot_ec);
	boot_ec = NULL;
L
Linus Torvalds 已提交
979 980 981
	return -ENODEV;
}

982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
static int acpi_ec_suspend(struct acpi_device *device, pm_message_t state)
{
	struct acpi_ec *ec = acpi_driver_data(device);
	/* Stop using GPE */
	set_bit(EC_FLAGS_NO_GPE, &ec->flags);
	clear_bit(EC_FLAGS_GPE_MODE, &ec->flags);
	acpi_disable_gpe(NULL, ec->gpe, ACPI_NOT_ISR);
	return 0;
}

static int acpi_ec_resume(struct acpi_device *device)
{
	struct acpi_ec *ec = acpi_driver_data(device);
	/* Enable use of GPE back */
	clear_bit(EC_FLAGS_NO_GPE, &ec->flags);
	acpi_enable_gpe(NULL, ec->gpe, ACPI_NOT_ISR);
	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,
		.start = acpi_ec_start,
		.stop = acpi_ec_stop,
		.suspend = acpi_ec_suspend,
		.resume = acpi_ec_resume,
		},
};

L
Len Brown 已提交
1015
static int __init acpi_ec_init(void)
L
Linus Torvalds 已提交
1016
{
L
Len Brown 已提交
1017
	int result = 0;
L
Linus Torvalds 已提交
1018 1019

	if (acpi_disabled)
1020
		return 0;
L
Linus Torvalds 已提交
1021 1022 1023

	acpi_ec_dir = proc_mkdir(ACPI_EC_CLASS, acpi_root_dir);
	if (!acpi_ec_dir)
1024
		return -ENODEV;
L
Linus Torvalds 已提交
1025 1026 1027 1028 1029

	/* Now register the driver for the EC */
	result = acpi_bus_register_driver(&acpi_ec_driver);
	if (result < 0) {
		remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
1030
		return -ENODEV;
L
Linus Torvalds 已提交
1031 1032
	}

1033
	return result;
L
Linus Torvalds 已提交
1034 1035 1036 1037 1038 1039
}

subsys_initcall(acpi_ec_init);

/* EC driver currently not unloadable */
#if 0
L
Len Brown 已提交
1040
static void __exit acpi_ec_exit(void)
L
Linus Torvalds 已提交
1041 1042 1043 1044 1045 1046
{

	acpi_bus_unregister_driver(&acpi_ec_driver);

	remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);

1047
	return;
L
Linus Torvalds 已提交
1048
}
1049
#endif	/* 0 */