ec.c 23.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 29 30 31 32 33 34 35
 *  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.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */

#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 已提交
36
#include <linux/interrupt.h>
37
#include <linux/list.h>
L
Linus Torvalds 已提交
38 39 40 41 42 43 44 45
#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"
46

47 48
#undef PREFIX
#define PREFIX				"ACPI: EC: "
49

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

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

65
/* EC events */
66
enum ec_event {
67
	ACPI_EC_EVENT_OBF_1 = 1,	/* Output buffer full */
68
	ACPI_EC_EVENT_IBF_0,		/* Input buffer empty */
69 70
};

71
#define ACPI_EC_DELAY		500	/* Wait 500ms max. during EC ops */
72 73
#define ACPI_EC_UDELAY_GLK	1000	/* Wait 1ms max. to get global lock */

74 75 76
enum {
	EC_FLAGS_WAIT_GPE = 0,		/* Don't check status until GPE arrives */
	EC_FLAGS_QUERY_PENDING,		/* Query is pending */
77
	EC_FLAGS_GPE_MODE,		/* Expect GPE to be sent for status change */
78
	EC_FLAGS_ONLY_IBF_GPE,		/* Expect GPE only for IBF = 0 event */
79 80
};

L
Len Brown 已提交
81 82 83
static int acpi_ec_remove(struct acpi_device *device, int type);
static int acpi_ec_start(struct acpi_device *device);
static int acpi_ec_stop(struct acpi_device *device, int type);
84
static int acpi_ec_add(struct acpi_device *device);
L
Linus Torvalds 已提交
85

86 87 88 89 90
static const struct acpi_device_id ec_device_ids[] = {
	{"PNP0C09", 0},
	{"", 0},
};

L
Linus Torvalds 已提交
91
static struct acpi_driver acpi_ec_driver = {
L
Len Brown 已提交
92
	.name = "ec",
L
Len Brown 已提交
93
	.class = ACPI_EC_CLASS,
94
	.ids = ec_device_ids,
L
Len Brown 已提交
95
	.ops = {
96
		.add = acpi_ec_add,
L
Len Brown 已提交
97 98 99 100
		.remove = acpi_ec_remove,
		.start = acpi_ec_start,
		.stop = acpi_ec_stop,
		},
L
Linus Torvalds 已提交
101
};
102 103

/* If we find an EC via the ECDT, we need to keep a ptr to its context */
104
/* External interfaces use first EC only, so remember */
105 106 107 108 109 110 111 112 113 114
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;
};

115
static struct acpi_ec {
116
	acpi_handle handle;
117
	unsigned long gpe;
118 119
	unsigned long command_addr;
	unsigned long data_addr;
120
	unsigned long global_lock;
121
	unsigned long flags;
122
	struct mutex lock;
123
	wait_queue_head_t wait;
124
	struct list_head list;
125
	u8 handlers_installed;
126
} *boot_ec, *first_ec;
127

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

132
static inline u8 acpi_ec_read_status(struct acpi_ec *ec)
L
Linus Torvalds 已提交
133
{
134
	return inb(ec->command_addr);
D
Dmitry Torokhov 已提交
135 136
}

137
static inline u8 acpi_ec_read_data(struct acpi_ec *ec)
138
{
139
	return inb(ec->data_addr);
140 141
}

142
static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command)
L
Luming Yu 已提交
143
{
144
	outb(command, ec->command_addr);
L
Luming Yu 已提交
145 146
}

147
static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data)
L
Luming Yu 已提交
148
{
149
	outb(data, ec->data_addr);
150
}
L
Luming Yu 已提交
151

152
static inline int acpi_ec_check_status(struct acpi_ec *ec, enum ec_event event)
153
{
154
	if (test_bit(EC_FLAGS_WAIT_GPE, &ec->flags))
155
		return 0;
A
Alexey Starikovskiy 已提交
156
	if (event == ACPI_EC_EVENT_OBF_1) {
157
		if (acpi_ec_read_status(ec) & ACPI_EC_FLAG_OBF)
158
			return 1;
A
Alexey Starikovskiy 已提交
159
	} else if (event == ACPI_EC_EVENT_IBF_0) {
160
		if (!(acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF))
161
			return 1;
L
Luming Yu 已提交
162 163
	}

164
	return 0;
L
Luming Yu 已提交
165
}
D
Dmitry Torokhov 已提交
166

167
static int acpi_ec_wait(struct acpi_ec *ec, enum ec_event event, int force_poll)
168
{
169 170
	if (likely(test_bit(EC_FLAGS_GPE_MODE, &ec->flags)) &&
	    likely(!force_poll)) {
171 172 173 174 175
		if (wait_event_timeout(ec->wait, acpi_ec_check_status(ec, event),
				       msecs_to_jiffies(ACPI_EC_DELAY)))
			return 0;
		clear_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
		if (acpi_ec_check_status(ec, event)) {
176
			if (event == ACPI_EC_EVENT_OBF_1) {
177
				/* miss OBF = 1 GPE, don't expect it anymore */
178 179
				printk(KERN_INFO PREFIX "missing OBF_1 confirmation,"
					"switching to degraded mode.\n");
180
				set_bit(EC_FLAGS_ONLY_IBF_GPE, &ec->flags);
181
			} else {
182
				/* missing GPEs, switch back to poll mode */
183 184
				printk(KERN_INFO PREFIX "missing IBF_1 confirmations,"
					"switch off interrupt mode.\n");
185
				clear_bit(EC_FLAGS_GPE_MODE, &ec->flags);
186
			}
187 188
			return 0;
		}
189 190 191 192 193 194 195
	} 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))
				return 0;
		}
196
	}
197 198 199
	printk(KERN_ERR PREFIX "acpi_ec_wait timeout,"
			       " status = %d, expect_event = %d\n",
			       acpi_ec_read_status(ec), event);
200
	return -ETIME;
L
Linus Torvalds 已提交
201 202
}

203
static int acpi_ec_transaction_unlocked(struct acpi_ec *ec, u8 command,
A
Alexey Starikovskiy 已提交
204
					const u8 * wdata, unsigned wdata_len,
205 206
					u8 * rdata, unsigned rdata_len,
					int force_poll)
L
Luming Yu 已提交
207
{
208
	int result = 0;
209
	set_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
210
	acpi_ec_write_cmd(ec, command);
L
Luming Yu 已提交
211

A
Alexey Starikovskiy 已提交
212
	for (; wdata_len > 0; --wdata_len) {
213
		result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0, force_poll);
214
		if (result) {
A
Alexey Starikovskiy 已提交
215 216
			printk(KERN_ERR PREFIX
			       "write_cmd timeout, command = %d\n", command);
217 218
			goto end;
		}
219
		set_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
220
		acpi_ec_write_data(ec, *(wdata++));
221
	}
L
Luming Yu 已提交
222

223
	if (!rdata_len) {
224
		result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0, force_poll);
225
		if (result) {
A
Alexey Starikovskiy 已提交
226 227
			printk(KERN_ERR PREFIX
			       "finish-write timeout, command = %d\n", command);
228 229
			goto end;
		}
230 231
	} else if (command == ACPI_EC_COMMAND_QUERY)
		clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
L
Luming Yu 已提交
232

A
Alexey Starikovskiy 已提交
233
	for (; rdata_len > 0; --rdata_len) {
234 235
		if (test_bit(EC_FLAGS_ONLY_IBF_GPE, &ec->flags))
			force_poll = 1;
236
		result = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF_1, force_poll);
237 238
		if (result) {
			printk(KERN_ERR PREFIX "read timeout, command = %d\n",
A
Alexey Starikovskiy 已提交
239
			       command);
240 241
			goto end;
		}
242 243 244
		/* Don't expect GPE after last read */
		if (rdata_len > 1)
			set_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
245
		*(rdata++) = acpi_ec_read_data(ec);
246
	}
247 248
      end:
	return result;
L
Luming Yu 已提交
249 250
}

251
static int acpi_ec_transaction(struct acpi_ec *ec, u8 command,
A
Alexey Starikovskiy 已提交
252
			       const u8 * wdata, unsigned wdata_len,
253 254
			       u8 * rdata, unsigned rdata_len,
			       int force_poll)
L
Linus Torvalds 已提交
255
{
256
	int status;
L
Len Brown 已提交
257
	u32 glk;
L
Linus Torvalds 已提交
258

259
	if (!ec || (wdata_len && !wdata) || (rdata_len && !rdata))
260
		return -EINVAL;
L
Linus Torvalds 已提交
261

A
Alexey Starikovskiy 已提交
262 263
	if (rdata)
		memset(rdata, 0, rdata_len);
L
Linus Torvalds 已提交
264

265
	mutex_lock(&ec->lock);
266
	if (ec->global_lock) {
L
Linus Torvalds 已提交
267
		status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
268 269
		if (ACPI_FAILURE(status)) {
			mutex_unlock(&ec->lock);
270
			return -ENODEV;
271
		}
L
Linus Torvalds 已提交
272
	}
D
Dmitry Torokhov 已提交
273

274
	status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0, 0);
275
	if (status) {
276
		printk(KERN_ERR PREFIX
A
Alexey Starikovskiy 已提交
277
		       "input buffer is not empty, aborting transaction\n");
D
Dmitry Torokhov 已提交
278
		goto end;
279
	}
L
Linus Torvalds 已提交
280

A
Alexey Starikovskiy 已提交
281 282
	status = acpi_ec_transaction_unlocked(ec, command,
					      wdata, wdata_len,
283 284
					      rdata, rdata_len,
					      force_poll);
L
Linus Torvalds 已提交
285

A
Alexey Starikovskiy 已提交
286
      end:
L
Linus Torvalds 已提交
287

288
	if (ec->global_lock)
L
Linus Torvalds 已提交
289
		acpi_release_global_lock(glk);
290
	mutex_unlock(&ec->lock);
L
Linus Torvalds 已提交
291

292
	return status;
L
Linus Torvalds 已提交
293 294
}

295 296 297 298 299 300 301
/*
 * 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;
302
	return acpi_ec_transaction(ec, ACPI_EC_BURST_ENABLE, NULL, 0, &d, 1, 0);
303 304 305 306
}

int acpi_ec_burst_disable(struct acpi_ec *ec)
{
307
	return acpi_ec_transaction(ec, ACPI_EC_BURST_DISABLE, NULL, 0, NULL, 0, 0);
308 309
}

A
Alexey Starikovskiy 已提交
310
static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 * data)
311 312 313 314 315
{
	int result;
	u8 d;

	result = acpi_ec_transaction(ec, ACPI_EC_COMMAND_READ,
316
				     &address, 1, &d, 1, 0);
317 318 319
	*data = d;
	return result;
}
320

321 322
static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data)
{
A
Alexey Starikovskiy 已提交
323 324
	u8 wdata[2] = { address, data };
	return acpi_ec_transaction(ec, ACPI_EC_COMMAND_WRITE,
325
				   wdata, 2, NULL, 0, 0);
326 327
}

L
Linus Torvalds 已提交
328 329 330
/*
 * Externally callable EC access functions. For now, assume 1 EC only
 */
331 332 333 334
int ec_burst_enable(void)
{
	if (!first_ec)
		return -ENODEV;
335
	return acpi_ec_burst_enable(first_ec);
336 337 338 339 340 341 342 343
}

EXPORT_SYMBOL(ec_burst_enable);

int ec_burst_disable(void)
{
	if (!first_ec)
		return -ENODEV;
344
	return acpi_ec_burst_disable(first_ec);
345 346 347 348
}

EXPORT_SYMBOL(ec_burst_disable);

A
Alexey Starikovskiy 已提交
349
int ec_read(u8 addr, u8 * val)
L
Linus Torvalds 已提交
350 351
{
	int err;
352
	u8 temp_data;
L
Linus Torvalds 已提交
353 354 355 356

	if (!first_ec)
		return -ENODEV;

357
	err = acpi_ec_read(first_ec, addr, &temp_data);
L
Linus Torvalds 已提交
358 359 360 361

	if (!err) {
		*val = temp_data;
		return 0;
L
Len Brown 已提交
362
	} else
L
Linus Torvalds 已提交
363 364
		return err;
}
L
Len Brown 已提交
365

L
Linus Torvalds 已提交
366 367
EXPORT_SYMBOL(ec_read);

L
Len Brown 已提交
368
int ec_write(u8 addr, u8 val)
L
Linus Torvalds 已提交
369 370 371 372 373 374
{
	int err;

	if (!first_ec)
		return -ENODEV;

375
	err = acpi_ec_write(first_ec, addr, val);
L
Linus Torvalds 已提交
376 377 378

	return err;
}
L
Len Brown 已提交
379

L
Linus Torvalds 已提交
380 381
EXPORT_SYMBOL(ec_write);

382
int ec_transaction(u8 command,
383
		   const u8 * wdata, unsigned wdata_len,
384 385
		   u8 * rdata, unsigned rdata_len,
		   int force_poll)
L
Luming Yu 已提交
386
{
387 388
	if (!first_ec)
		return -ENODEV;
L
Luming Yu 已提交
389

390
	return acpi_ec_transaction(first_ec, command, wdata,
391 392
				   wdata_len, rdata, rdata_len,
				   force_poll);
L
Luming Yu 已提交
393
}
L
Linus Torvalds 已提交
394

395 396
EXPORT_SYMBOL(ec_transaction);

A
Alexey Starikovskiy 已提交
397
static int acpi_ec_query(struct acpi_ec *ec, u8 * data)
398 399
{
	int result;
A
Alexey Starikovskiy 已提交
400
	u8 d;
L
Linus Torvalds 已提交
401

A
Alexey Starikovskiy 已提交
402 403
	if (!ec || !data)
		return -EINVAL;
L
Linus Torvalds 已提交
404

A
Alexey Starikovskiy 已提交
405 406 407 408 409
	/*
	 * 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).
	 */
410

411
	result = acpi_ec_transaction(ec, ACPI_EC_COMMAND_QUERY, NULL, 0, &d, 1, 0);
A
Alexey Starikovskiy 已提交
412 413
	if (result)
		return result;
L
Linus Torvalds 已提交
414

A
Alexey Starikovskiy 已提交
415 416
	if (!d)
		return -ENODATA;
L
Linus Torvalds 已提交
417

A
Alexey Starikovskiy 已提交
418 419
	*data = d;
	return 0;
L
Linus Torvalds 已提交
420 421 422 423 424
}

/* --------------------------------------------------------------------------
                                Event Management
   -------------------------------------------------------------------------- */
425 426 427 428 429 430 431 432 433 434 435 436 437 438
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);
439
	list_add(&handler->node, &ec->list);
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
	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)
{
	struct acpi_ec_query_handler *handler;
	mutex_lock(&ec->lock);
	list_for_each_entry(handler, &ec->list, node) {
		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 已提交
460

L
Len Brown 已提交
461
static void acpi_ec_gpe_query(void *ec_cxt)
L
Luming Yu 已提交
462
{
463
	struct acpi_ec *ec = ec_cxt;
464
	u8 value = 0;
465
	struct acpi_ec_query_handler *handler, copy;
L
Luming Yu 已提交
466

467
	if (!ec || acpi_ec_query(ec, &value))
468
		return;
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
	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 已提交
484
}
L
Linus Torvalds 已提交
485

L
Len Brown 已提交
486
static u32 acpi_ec_gpe_handler(void *data)
L
Linus Torvalds 已提交
487
{
L
Len Brown 已提交
488
	acpi_status status = AE_OK;
489
	struct acpi_ec *ec = data;
490

491
	clear_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
492
	if (test_bit(EC_FLAGS_GPE_MODE, &ec->flags))
493
		wake_up(&ec->wait);
D
Dmitry Torokhov 已提交
494

495 496 497 498
	if (acpi_ec_read_status(ec) & ACPI_EC_FLAG_SCI) {
		if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags))
			status = acpi_os_execute(OSL_EC_BURST_HANDLER,
				acpi_ec_gpe_query, ec);
499 500 501 502
	} else if (unlikely(!test_bit(EC_FLAGS_GPE_MODE, &ec->flags))) {
		/* this is non-query, must be confirmation */
		printk(KERN_INFO PREFIX "non-query interrupt received,"
			" switching to interrupt mode\n");
503
		set_bit(EC_FLAGS_GPE_MODE, &ec->flags);
504
	}
505

506
	return ACPI_SUCCESS(status) ?
L
Len Brown 已提交
507
	    ACPI_INTERRUPT_HANDLED : ACPI_INTERRUPT_NOT_HANDLED;
L
Linus Torvalds 已提交
508 509 510 511 512 513 514
}

/* --------------------------------------------------------------------------
                             Address Space Management
   -------------------------------------------------------------------------- */

static acpi_status
L
Len Brown 已提交
515 516
acpi_ec_space_setup(acpi_handle region_handle,
		    u32 function, void *handler_context, void **return_context)
L
Linus Torvalds 已提交
517 518 519 520 521
{
	/*
	 * The EC object is in the handler context and is needed
	 * when calling the acpi_ec_space_handler.
	 */
L
Len Brown 已提交
522 523
	*return_context = (function != ACPI_REGION_DEACTIVATE) ?
	    handler_context : NULL;
L
Linus Torvalds 已提交
524 525 526 527 528

	return AE_OK;
}

static acpi_status
529 530
acpi_ec_space_handler(u32 function, acpi_physical_address address,
		      u32 bits, acpi_integer *value,
L
Len Brown 已提交
531
		      void *handler_context, void *region_context)
L
Linus Torvalds 已提交
532
{
533
	struct acpi_ec *ec = handler_context;
534 535
	int result = 0, i = 0;
	u8 temp = 0;
L
Linus Torvalds 已提交
536 537

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

540
	if (function != ACPI_READ && function != ACPI_WRITE)
541
		return AE_BAD_PARAMETER;
L
Linus Torvalds 已提交
542

543 544
	if (bits != 8 && acpi_strict)
		return AE_BAD_PARAMETER;
L
Linus Torvalds 已提交
545

546 547 548 549 550 551 552 553 554 555
	while (bits - i > 0) {
		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);
		}
		i += 8;
		++address;
L
Linus Torvalds 已提交
556 557 558 559
	}

	switch (result) {
	case -EINVAL:
560
		return AE_BAD_PARAMETER;
L
Linus Torvalds 已提交
561 562
		break;
	case -ENODEV:
563
		return AE_NOT_FOUND;
L
Linus Torvalds 已提交
564 565
		break;
	case -ETIME:
566
		return AE_TIME;
L
Linus Torvalds 已提交
567 568
		break;
	default:
569
		return AE_OK;
L
Linus Torvalds 已提交
570 571 572 573 574 575 576
	}
}

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

L
Len Brown 已提交
577
static struct proc_dir_entry *acpi_ec_dir;
L
Linus Torvalds 已提交
578

L
Len Brown 已提交
579
static int acpi_ec_read_info(struct seq_file *seq, void *offset)
L
Linus Torvalds 已提交
580
{
581
	struct acpi_ec *ec = seq->private;
L
Linus Torvalds 已提交
582 583 584 585

	if (!ec)
		goto end;

586 587 588 589
	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",
590
		   ec->global_lock ? "yes" : "no");
L
Len Brown 已提交
591
      end:
592
	return 0;
L
Linus Torvalds 已提交
593 594 595 596 597 598 599
}

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

600
static struct file_operations acpi_ec_info_ops = {
L
Len Brown 已提交
601 602 603 604
	.open = acpi_ec_info_open_fs,
	.read = seq_read,
	.llseek = seq_lseek,
	.release = single_release,
L
Linus Torvalds 已提交
605 606 607
	.owner = THIS_MODULE,
};

L
Len Brown 已提交
608
static int acpi_ec_add_fs(struct acpi_device *device)
L
Linus Torvalds 已提交
609
{
L
Len Brown 已提交
610
	struct proc_dir_entry *entry = NULL;
L
Linus Torvalds 已提交
611 612 613

	if (!acpi_device_dir(device)) {
		acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
L
Len Brown 已提交
614
						     acpi_ec_dir);
L
Linus Torvalds 已提交
615
		if (!acpi_device_dir(device))
616
			return -ENODEV;
L
Linus Torvalds 已提交
617 618 619
	}

	entry = create_proc_entry(ACPI_EC_FILE_INFO, S_IRUGO,
L
Len Brown 已提交
620
				  acpi_device_dir(device));
L
Linus Torvalds 已提交
621
	if (!entry)
622
		return -ENODEV;
L
Linus Torvalds 已提交
623 624 625 626 627 628
	else {
		entry->proc_fops = &acpi_ec_info_ops;
		entry->data = acpi_driver_data(device);
		entry->owner = THIS_MODULE;
	}

629
	return 0;
L
Linus Torvalds 已提交
630 631
}

L
Len Brown 已提交
632
static int acpi_ec_remove_fs(struct acpi_device *device)
L
Linus Torvalds 已提交
633 634 635 636 637 638 639 640
{

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

641
	return 0;
L
Linus Torvalds 已提交
642 643 644 645 646
}

/* --------------------------------------------------------------------------
                               Driver Interface
   -------------------------------------------------------------------------- */
647 648 649 650 651 652 653 654
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;
655
	ec->flags = 1 << EC_FLAGS_QUERY_PENDING;
656 657
	mutex_init(&ec->lock);
	init_waitqueue_head(&ec->wait);
658
	INIT_LIST_HEAD(&ec->list);
659 660
	return ec;
}
661

662 663 664 665 666 667 668 669 670 671 672 673 674
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;
}

675 676
static acpi_status
ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval)
677
{
678 679 680 681 682 683 684
	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;
685 686 687

	/* Get GPE bit assignment (EC events). */
	/* TODO: Add support for _GPE returning a package */
688 689 690
	status = acpi_evaluate_integer(handle, "_GPE", NULL, &ec->gpe);
	if (ACPI_FAILURE(status))
		return status;
691 692 693
	/* Find and register all query methods */
	acpi_walk_namespace(ACPI_TYPE_METHOD, handle, 1,
			    acpi_ec_register_query_methods, ec, NULL);
694 695 696
	/* Use the global lock for all EC transactions? */
	acpi_evaluate_integer(handle, "_GLK", NULL, &ec->global_lock);
	ec->handle = handle;
697
	return AE_CTRL_TERMINATE;
698 699
}

700 701 702 703 704 705 706 707 708 709 710
static void ec_remove_handlers(struct acpi_ec *ec)
{
	if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle,
				ACPI_ADR_SPACE_EC, &acpi_ec_space_handler)))
		printk(KERN_ERR PREFIX "failed to remove space handler\n");
	if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe,
				&acpi_ec_gpe_handler)))
		printk(KERN_ERR PREFIX "failed to remove gpe handler\n");
	ec->handlers_installed = 0;
}

711
static int acpi_ec_add(struct acpi_device *device)
L
Linus Torvalds 已提交
712
{
713
	struct acpi_ec *ec = NULL;
L
Luming Yu 已提交
714 715

	if (!device)
716
		return -EINVAL;
717 718 719
	strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
	strcpy(acpi_device_class(device), ACPI_EC_CLASS);

720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
	/* Check for boot EC */
	if (boot_ec) {
		if (boot_ec->handle == device->handle) {
			/* Pre-loaded EC from DSDT, just move pointer */
			ec = boot_ec;
			boot_ec = NULL;
			goto end;
		} else if (boot_ec->handle == ACPI_ROOT_OBJECT) {
			/* ECDT-based EC, time to shut it down */
			ec_remove_handlers(boot_ec);
			kfree(boot_ec);
			first_ec = boot_ec = NULL;
		}
	}

735
	ec = make_acpi_ec();
L
Luming Yu 已提交
736
	if (!ec)
737
		return -ENOMEM;
738

739 740
	if (ec_parse_device(device->handle, 0, ec, NULL) !=
	    AE_CTRL_TERMINATE) {
741 742
		kfree(ec);
		return -EINVAL;
L
Luming Yu 已提交
743
	}
744
	ec->handle = device->handle;
745 746 747
      end:
	if (!first_ec)
		first_ec = ec;
748 749
	acpi_driver_data(device) = ec;
	acpi_ec_add_fs(device);
750 751
	printk(KERN_INFO PREFIX "GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n",
			  ec->gpe, ec->command_addr, ec->data_addr);
752 753
	printk(KERN_INFO PREFIX "driver started in %s mode\n",
		(test_bit(EC_FLAGS_GPE_MODE, &ec->flags))?"interrupt":"poll");
754
	return 0;
L
Linus Torvalds 已提交
755 756
}

L
Len Brown 已提交
757
static int acpi_ec_remove(struct acpi_device *device, int type)
L
Linus Torvalds 已提交
758
{
759
	struct acpi_ec *ec;
760
	struct acpi_ec_query_handler *handler, *tmp;
L
Linus Torvalds 已提交
761 762

	if (!device)
763
		return -EINVAL;
L
Linus Torvalds 已提交
764 765

	ec = acpi_driver_data(device);
766
	mutex_lock(&ec->lock);
767
	list_for_each_entry_safe(handler, tmp, &ec->list, node) {
768 769 770 771
		list_del(&handler->node);
		kfree(handler);
	}
	mutex_unlock(&ec->lock);
L
Linus Torvalds 已提交
772
	acpi_ec_remove_fs(device);
773
	acpi_driver_data(device) = NULL;
774
	if (ec == first_ec)
775
		first_ec = NULL;
776
	kfree(ec);
777
	return 0;
L
Linus Torvalds 已提交
778 779 780
}

static acpi_status
781
ec_parse_io_ports(struct acpi_resource *resource, void *context)
L
Linus Torvalds 已提交
782
{
783
	struct acpi_ec *ec = context;
L
Linus Torvalds 已提交
784

785
	if (resource->type != ACPI_RESOURCE_TYPE_IO)
L
Linus Torvalds 已提交
786 787 788 789 790 791 792
		return AE_OK;

	/*
	 * The first address region returned is the data port, and
	 * the second address region returned is the status/command
	 * port.
	 */
793
	if (ec->data_addr == 0)
794
		ec->data_addr = resource->data.io.minimum;
795
	else if (ec->command_addr == 0)
796
		ec->command_addr = resource->data.io.minimum;
797
	else
L
Linus Torvalds 已提交
798 799 800 801 802
		return AE_CTRL_TERMINATE;

	return AE_OK;
}

803 804
static int ec_install_handlers(struct acpi_ec *ec)
{
805
	acpi_status status;
806 807
	if (ec->handlers_installed)
		return 0;
808 809 810
	status = acpi_install_gpe_handler(NULL, ec->gpe,
					  ACPI_GPE_EDGE_TRIGGERED,
					  &acpi_ec_gpe_handler, ec);
811 812
	if (ACPI_FAILURE(status))
		return -ENODEV;
813

814 815 816 817 818 819 820 821 822 823 824 825
	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,
						    &acpi_ec_space_setup, ec);
	if (ACPI_FAILURE(status)) {
		acpi_remove_gpe_handler(NULL, ec->gpe, &acpi_ec_gpe_handler);
		return -ENODEV;
	}

826
	ec->handlers_installed = 1;
827 828 829
	return 0;
}

L
Len Brown 已提交
830
static int acpi_ec_start(struct acpi_device *device)
L
Linus Torvalds 已提交
831
{
832
	struct acpi_ec *ec;
833
	int ret = 0;
L
Linus Torvalds 已提交
834 835

	if (!device)
836
		return -EINVAL;
L
Linus Torvalds 已提交
837 838 839 840

	ec = acpi_driver_data(device);

	if (!ec)
841
		return -EINVAL;
L
Linus Torvalds 已提交
842

843
	ret = ec_install_handlers(ec);
844 845

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

L
Len Brown 已提交
850
static int acpi_ec_stop(struct acpi_device *device, int type)
L
Linus Torvalds 已提交
851
{
852
	struct acpi_ec *ec;
L
Linus Torvalds 已提交
853
	if (!device)
854
		return -EINVAL;
L
Linus Torvalds 已提交
855
	ec = acpi_driver_data(device);
856 857
	if (!ec)
		return -EINVAL;
858
	ec_remove_handlers(ec);
859

860
	return 0;
L
Linus Torvalds 已提交
861 862
}

863 864 865 866
int __init acpi_ec_ecdt_probe(void)
{
	int ret;
	acpi_status status;
L
Len Brown 已提交
867
	struct acpi_table_ecdt *ecdt_ptr;
L
Luming Yu 已提交
868

869 870
	boot_ec = make_acpi_ec();
	if (!boot_ec)
871 872 873 874
		return -ENOMEM;
	/*
	 * Generate a boot ec context
	 */
875 876
	status = acpi_get_table(ACPI_SIG_ECDT, 1,
				(struct acpi_table_header **)&ecdt_ptr);
877
	if (ACPI_SUCCESS(status)) {
878
		printk(KERN_INFO PREFIX "EC description table is found, configuring boot EC\n");
879 880 881 882 883 884 885 886
		boot_ec->command_addr = ecdt_ptr->control.address;
		boot_ec->data_addr = ecdt_ptr->data.address;
		boot_ec->gpe = ecdt_ptr->gpe;
		boot_ec->handle = ACPI_ROOT_OBJECT;
	} else {
		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);
887 888
		/* Check that acpi_get_devices actually find something */
		if (ACPI_FAILURE(status) || !boot_ec->handle)
889 890
			goto error;
	}
L
Linus Torvalds 已提交
891

892
	ret = ec_install_handlers(boot_ec);
893 894
	if (!ret) {
		first_ec = boot_ec;
895
		return 0;
896
	}
897
      error:
898 899
	kfree(boot_ec);
	boot_ec = NULL;
L
Linus Torvalds 已提交
900 901 902
	return -ENODEV;
}

L
Len Brown 已提交
903
static int __init acpi_ec_init(void)
L
Linus Torvalds 已提交
904
{
L
Len Brown 已提交
905
	int result = 0;
L
Linus Torvalds 已提交
906 907

	if (acpi_disabled)
908
		return 0;
L
Linus Torvalds 已提交
909 910 911

	acpi_ec_dir = proc_mkdir(ACPI_EC_CLASS, acpi_root_dir);
	if (!acpi_ec_dir)
912
		return -ENODEV;
L
Linus Torvalds 已提交
913 914 915 916 917

	/* 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);
918
		return -ENODEV;
L
Linus Torvalds 已提交
919 920
	}

921
	return result;
L
Linus Torvalds 已提交
922 923 924 925 926 927
}

subsys_initcall(acpi_ec_init);

/* EC driver currently not unloadable */
#if 0
L
Len Brown 已提交
928
static void __exit acpi_ec_exit(void)
L
Linus Torvalds 已提交
929 930 931 932 933 934
{

	acpi_bus_unregister_driver(&acpi_ec_driver);

	remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);

935
	return;
L
Linus Torvalds 已提交
936
}
937
#endif	/* 0 */