ec.c 24.2 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 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
/*
 *  acpi_ec.c - ACPI Embedded Controller Driver ($Revision: 38 $)
 *
 *  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 已提交
34
#include <linux/interrupt.h>
L
Linus Torvalds 已提交
35 36 37 38 39 40
#include <asm/io.h>
#include <acpi/acpi_bus.h>
#include <acpi/acpi_drivers.h>
#include <acpi/actypes.h>

#define _COMPONENT		ACPI_EC_COMPONENT
L
Len Brown 已提交
41
ACPI_MODULE_NAME("acpi_ec")
L
Linus Torvalds 已提交
42 43 44 45 46 47
#define ACPI_EC_COMPONENT		0x00100000
#define ACPI_EC_CLASS			"embedded_controller"
#define ACPI_EC_HID			"PNP0C09"
#define ACPI_EC_DRIVER_NAME		"ACPI Embedded Controller Driver"
#define ACPI_EC_DEVICE_NAME		"Embedded Controller"
#define ACPI_EC_FILE_INFO		"info"
48

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

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

/* EC commands */
L
Linus Torvalds 已提交
59 60
#define ACPI_EC_COMMAND_READ	0x80
#define ACPI_EC_COMMAND_WRITE	0x81
D
Dmitry Torokhov 已提交
61 62
#define ACPI_EC_BURST_ENABLE	0x82
#define ACPI_EC_BURST_DISABLE	0x83
L
Linus Torvalds 已提交
63
#define ACPI_EC_COMMAND_QUERY	0x84
64 65 66 67 68 69 70

/* EC events */
enum {
	ACPI_EC_EVENT_OBF_1 = 1,	/* Output buffer full */
	ACPI_EC_EVENT_IBF_0,		/* Input buffer empty */
};

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 */
#define ACPI_EC_UDELAY         100	/* Poll @ 100us increments */
74
#define ACPI_EC_UDELAY_COUNT   1000	/* Wait 100ms max. during EC ops */
75 76 77

enum {
	EC_INTR = 1,	/* Output buffer full */
78
	EC_POLL,	/* Input buffer empty */
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

static struct acpi_driver acpi_ec_driver = {
L
Len Brown 已提交
87 88 89 90
	.name = ACPI_EC_DRIVER_NAME,
	.class = ACPI_EC_CLASS,
	.ids = ACPI_EC_HID,
	.ops = {
91
		.add = acpi_ec_add,
L
Len Brown 已提交
92 93 94 95
		.remove = acpi_ec_remove,
		.start = acpi_ec_start,
		.stop = acpi_ec_stop,
		},
L
Linus Torvalds 已提交
96
};
97 98

/* If we find an EC via the ECDT, we need to keep a ptr to its context */
99 100 101 102
struct acpi_ec {
	acpi_handle handle;
	unsigned long uid;
	unsigned long gpe_bit;
103 104
	unsigned long command_addr;
	unsigned long data_addr;
105 106 107 108
	unsigned long global_lock;
	struct semaphore sem;
	atomic_t leaving_burst;	/* 0 : No, 1 : Yes, 2: abort */
	wait_queue_head_t wait;
109
} *ec_ecdt;
110 111 112 113 114

/* External interfaces use first EC only, so remember */
static struct acpi_device *first_ec;
static int acpi_ec_mode = EC_INTR;

L
Linus Torvalds 已提交
115 116 117 118
/* --------------------------------------------------------------------------
                             Transaction Management
   -------------------------------------------------------------------------- */

119
static inline u8 acpi_ec_read_status(struct acpi_ec *ec)
L
Linus Torvalds 已提交
120
{
121
	return inb(ec->command_addr);
D
Dmitry Torokhov 已提交
122 123
}

124
static inline u8 acpi_ec_read_data(struct acpi_ec *ec)
125
{
126
	return inb(ec->data_addr);
127 128
}

129
static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command)
L
Luming Yu 已提交
130
{
131
	outb(command, ec->command_addr);
L
Luming Yu 已提交
132 133
}

134
static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data)
L
Luming Yu 已提交
135
{
136
	outb(data, ec->data_addr);
137
}
L
Luming Yu 已提交
138

139
static int acpi_ec_check_status(struct acpi_ec *ec, u8 event)
140
{
141
	u8 status = acpi_ec_read_status(ec);
L
Luming Yu 已提交
142
	switch (event) {
143 144 145
	case ACPI_EC_EVENT_OBF_1:
		if (status & ACPI_EC_FLAG_OBF)
			return 1;
L
Luming Yu 已提交
146
		break;
147 148 149
	case ACPI_EC_EVENT_IBF_0:
		if (!(status & ACPI_EC_FLAG_IBF))
			return 1;
L
Luming Yu 已提交
150 151
		break;
	default:
152
		break;
L
Luming Yu 已提交
153 154
	}

155
	return 0;
L
Luming Yu 已提交
156
}
D
Dmitry Torokhov 已提交
157

158
static int acpi_ec_wait(struct acpi_ec *ec, u8 event)
159
{
160 161 162 163
	if (acpi_ec_mode == EC_POLL) {
		int i;
		for (i = 0; i < ACPI_EC_UDELAY_COUNT; ++i) {
			if (acpi_ec_check_status(ec, event))
164
				return 0;
165
			udelay(ACPI_EC_UDELAY);
166
		}
167 168 169 170 171
	} else {
		if (wait_event_timeout(ec->wait,
				       acpi_ec_check_status(ec, event),
				       msecs_to_jiffies(ACPI_EC_DELAY)) ||
		    acpi_ec_check_status(ec, event)) {
172
			return 0;
173 174 175 176
		} else {
			printk(KERN_ERR PREFIX "acpi_ec_wait timeout,"
			       " status = %d, expect_event = %d\n",
			     acpi_ec_read_status(ec), event);
177
		}
178
	}
L
Linus Torvalds 已提交
179

180
	return -ETIME;
L
Linus Torvalds 已提交
181 182
}

183
#ifdef ACPI_FUTURE_USAGE
184 185 186 187
/*
 * Note: samsung nv5000 doesn't work with ec burst mode.
 * http://bugzilla.kernel.org/show_bug.cgi?id=4980
 */
188
int acpi_ec_enter_burst_mode(struct acpi_ec *ec)
D
Dmitry Torokhov 已提交
189
{
190 191
	u8 tmp = 0;
	u8 status = 0;
D
Dmitry Torokhov 已提交
192 193 194


	status = acpi_ec_read_status(ec);
L
Len Brown 已提交
195
	if (status != -EINVAL && !(status & ACPI_EC_FLAG_BURST)) {
196
		status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0);
L
Len Brown 已提交
197
		if (status)
198
			goto end;
199 200 201
		acpi_ec_write_cmd(ec, ACPI_EC_BURST_ENABLE);
		status = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF_1);
		tmp = acpi_ec_read_data(ec);
L
Len Brown 已提交
202
		if (tmp != 0x90) {	/* Burst ACK byte */
203
			return -EINVAL;
D
Dmitry Torokhov 已提交
204
		}
205 206
	}

207
	atomic_set(&ec->leaving_burst, 0);
208
	return 0;
209 210
  end:
	ACPI_EXCEPTION((AE_INFO, status, "EC wait, burst mode"));
211
	return -1;
D
Dmitry Torokhov 已提交
212 213
}

214
int acpi_ec_leave_burst_mode(struct acpi_ec *ec)
D
Dmitry Torokhov 已提交
215
{
216
	u8 status = 0;
D
Dmitry Torokhov 已提交
217 218


219 220
	status = acpi_ec_read_status(ec);
	if (status != -EINVAL && (status & ACPI_EC_FLAG_BURST)){
221
		status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0);
222 223
		if(status)
			goto end;
224 225
		acpi_ec_write_cmd(ec, ACPI_EC_BURST_DISABLE);
		acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0);
226
	}
227
	atomic_set(&ec->leaving_burst, 1);
228
	return 0;
229 230
  end:
	ACPI_EXCEPTION((AE_INFO, status, "EC leave burst mode"));
231
	return -1;
D
Dmitry Torokhov 已提交
232
}
233
#endif /* ACPI_FUTURE_USAGE */
D
Dmitry Torokhov 已提交
234

235
static int acpi_ec_transaction_unlocked(struct acpi_ec *ec, u8 command,
236 237
					const u8 *wdata, unsigned wdata_len,
					u8 *rdata, unsigned rdata_len)
L
Luming Yu 已提交
238
{
239
	int result = 0;
L
Luming Yu 已提交
240

241
	acpi_ec_write_cmd(ec, command);
L
Luming Yu 已提交
242

243
	for (; wdata_len > 0; wdata_len --) {
244
		result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0);
245 246 247 248 249
		if (result) {
			printk(KERN_ERR PREFIX "write_cmd timeout, command = %d\n",
			     command);
			goto end;
		}
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);
255 256 257 258 259
		if (result) {
			printk(KERN_ERR PREFIX "finish-write timeout, command = %d\n",
			     command);
			goto end;
		}
260
	}
L
Luming Yu 已提交
261

262
	for (; rdata_len > 0; rdata_len --) {
263
		result = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF_1);
264 265 266 267 268
		if (result) {
			printk(KERN_ERR PREFIX "read timeout, command = %d\n",
			     command);
			goto end;
		}
L
Len Brown 已提交
269

270
		*(rdata++) = acpi_ec_read_data(ec);
271
	}
272 273
      end:
	return result;
L
Luming Yu 已提交
274 275
}

276 277 278
static int acpi_ec_transaction(struct acpi_ec *ec, u8 command,
				const u8 *wdata, unsigned wdata_len,
				u8 *rdata, unsigned rdata_len)
L
Linus Torvalds 已提交
279
{
280
	int status;
L
Len Brown 已提交
281
	u32 glk;
L
Linus Torvalds 已提交
282

283
	if (!ec || (wdata_len && !wdata) || (rdata_len && !rdata))
284
		return -EINVAL;
L
Linus Torvalds 已提交
285

286 287
        if (rdata)
                memset(rdata, 0, rdata_len);
L
Linus Torvalds 已提交
288

289
	if (ec->global_lock) {
L
Linus Torvalds 已提交
290 291
		status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
		if (ACPI_FAILURE(status))
292
			return -ENODEV;
L
Linus Torvalds 已提交
293
	}
294
	down(&ec->sem);
D
Dmitry Torokhov 已提交
295

296 297 298
	/* Make sure GPE is enabled before doing transaction */
	acpi_enable_gpe(NULL, ec->gpe_bit, ACPI_NOT_ISR);

299
	status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0);
300
	if (status) {
301
		printk(KERN_DEBUG PREFIX "read EC, IB not empty\n");
D
Dmitry Torokhov 已提交
302
		goto end;
303
	}
L
Linus Torvalds 已提交
304

305 306 307
        status = acpi_ec_transaction_unlocked(ec, command,
                                              wdata, wdata_len,
                                              rdata, rdata_len);
L
Linus Torvalds 已提交
308

309
end:
310
	up(&ec->sem);
L
Linus Torvalds 已提交
311

312
	if (ec->global_lock)
L
Linus Torvalds 已提交
313 314
		acpi_release_global_lock(glk);

315
	return status;
L
Linus Torvalds 已提交
316 317
}

318
static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 *data)
319 320 321 322 323 324 325 326 327
{
	int result;
	u8 d;

	result = acpi_ec_transaction(ec, ACPI_EC_COMMAND_READ,
				     &address, 1, &d, 1);
	*data = d;
	return result;
}
328

329 330 331 332 333 334 335
static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data)
{
        u8 wdata[2] = { address, data };
        return acpi_ec_transaction(ec, ACPI_EC_COMMAND_WRITE,
				   wdata, 2, NULL, 0);
}

L
Linus Torvalds 已提交
336 337 338
/*
 * Externally callable EC access functions. For now, assume 1 EC only
 */
339
int ec_read(u8 addr, u8 *val)
L
Linus Torvalds 已提交
340
{
341
	struct acpi_ec *ec;
L
Linus Torvalds 已提交
342
	int err;
343
	u8 temp_data;
L
Linus Torvalds 已提交
344 345 346 347 348 349 350 351 352 353 354

	if (!first_ec)
		return -ENODEV;

	ec = acpi_driver_data(first_ec);

	err = acpi_ec_read(ec, addr, &temp_data);

	if (!err) {
		*val = temp_data;
		return 0;
L
Len Brown 已提交
355
	} else
L
Linus Torvalds 已提交
356 357
		return err;
}
L
Len Brown 已提交
358

L
Linus Torvalds 已提交
359 360
EXPORT_SYMBOL(ec_read);

L
Len Brown 已提交
361
int ec_write(u8 addr, u8 val)
L
Linus Torvalds 已提交
362
{
363
	struct acpi_ec *ec;
L
Linus Torvalds 已提交
364 365 366 367 368 369 370 371 372 373 374
	int err;

	if (!first_ec)
		return -ENODEV;

	ec = acpi_driver_data(first_ec);

	err = acpi_ec_write(ec, addr, val);

	return err;
}
L
Len Brown 已提交
375

L
Linus Torvalds 已提交
376 377
EXPORT_SYMBOL(ec_write);

378 379 380
extern int ec_transaction(u8 command,
                          const u8 *wdata, unsigned wdata_len,
                          u8 *rdata, unsigned rdata_len)
L
Luming Yu 已提交
381
{
382
	struct acpi_ec *ec;
L
Luming Yu 已提交
383

384 385
	if (!first_ec)
		return -ENODEV;
L
Luming Yu 已提交
386

387
	ec = acpi_driver_data(first_ec);
L
Luming Yu 已提交
388

389 390
	return acpi_ec_transaction(ec, command, wdata,
				   wdata_len, rdata, rdata_len);
L
Luming Yu 已提交
391
}
L
Linus Torvalds 已提交
392

393 394
EXPORT_SYMBOL(ec_transaction);

395
static int acpi_ec_query(struct acpi_ec *ec, u8 *data)
396 397
{
	int result;
398
        u8 d;
L
Linus Torvalds 已提交
399

400 401
        if (!ec || !data)
                return -EINVAL;
L
Linus Torvalds 已提交
402

403 404 405 406 407
        /*
         * 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).
         */
408

409 410 411
        result = acpi_ec_transaction(ec, ACPI_EC_COMMAND_QUERY, NULL, 0, &d, 1);
        if (result)
                return result;
L
Linus Torvalds 已提交
412

413 414
        if (!d)
                return -ENODATA;
L
Linus Torvalds 已提交
415

416 417
        *data = d;
        return 0;
L
Linus Torvalds 已提交
418 419 420 421 422 423
}

/* --------------------------------------------------------------------------
                                Event Management
   -------------------------------------------------------------------------- */

L
Len Brown 已提交
424
static void acpi_ec_gpe_query(void *ec_cxt)
L
Luming Yu 已提交
425
{
426
	struct acpi_ec *ec = (struct acpi_ec *)ec_cxt;
427 428
	u8 value = 0;
	static char object_name[8];
L
Luming Yu 已提交
429

430
	if (!ec)
431
		return;
L
Luming Yu 已提交
432

433
	value = acpi_ec_read_status(ec);
L
Luming Yu 已提交
434 435

	if (!(value & ACPI_EC_FLAG_SCI))
436
		return;
L
Luming Yu 已提交
437 438

	if (acpi_ec_query(ec, &value))
439
		return;
L
Luming Yu 已提交
440

441
	snprintf(object_name, 8, "_Q%2.2X", value);
L
Luming Yu 已提交
442

443
	printk(KERN_INFO PREFIX "evaluating %s\n", object_name);
L
Luming Yu 已提交
444

445
	acpi_evaluate_object(ec->handle, object_name, NULL, NULL);
L
Luming Yu 已提交
446
}
L
Linus Torvalds 已提交
447

L
Len Brown 已提交
448
static u32 acpi_ec_gpe_handler(void *data)
L
Linus Torvalds 已提交
449
{
L
Len Brown 已提交
450
	acpi_status status = AE_OK;
451
	u8 value;
452
	struct acpi_ec *ec = (struct acpi_ec *)data;
L
Linus Torvalds 已提交
453 454


455
	if (acpi_ec_mode == EC_INTR) {
456
		wake_up(&ec->wait);
D
Dmitry Torokhov 已提交
457 458
	}

459
	value = acpi_ec_read_status(ec);
L
Len Brown 已提交
460
	if (value & ACPI_EC_FLAG_SCI) {
461
		status = acpi_os_execute(OSL_EC_BURST_HANDLER, acpi_ec_gpe_query, ec);
L
Len Brown 已提交
462
	}
463

D
Dmitry Torokhov 已提交
464
	return status == AE_OK ?
L
Len Brown 已提交
465
	    ACPI_INTERRUPT_HANDLED : ACPI_INTERRUPT_NOT_HANDLED;
L
Linus Torvalds 已提交
466 467 468 469 470 471 472
}

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

static acpi_status
L
Len Brown 已提交
473 474
acpi_ec_space_setup(acpi_handle region_handle,
		    u32 function, void *handler_context, void **return_context)
L
Linus Torvalds 已提交
475 476 477 478 479
{
	/*
	 * The EC object is in the handler context and is needed
	 * when calling the acpi_ec_space_handler.
	 */
L
Len Brown 已提交
480 481
	*return_context = (function != ACPI_REGION_DEACTIVATE) ?
	    handler_context : NULL;
L
Linus Torvalds 已提交
482 483 484 485 486

	return AE_OK;
}

static acpi_status
L
Len Brown 已提交
487 488 489 490 491
acpi_ec_space_handler(u32 function,
		      acpi_physical_address address,
		      u32 bit_width,
		      acpi_integer * value,
		      void *handler_context, void *region_context)
L
Linus Torvalds 已提交
492
{
L
Len Brown 已提交
493
	int result = 0;
494
	struct acpi_ec *ec = NULL;
L
Len Brown 已提交
495 496 497
	u64 temp = *value;
	acpi_integer f_v = 0;
	int i = 0;
L
Linus Torvalds 已提交
498 499 500


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

L
Luming Yu 已提交
503
	if (bit_width != 8 && acpi_strict) {
504
		return AE_BAD_PARAMETER;
L
Linus Torvalds 已提交
505 506
	}

507
	ec = (struct acpi_ec *)handler_context;
L
Linus Torvalds 已提交
508

L
Len Brown 已提交
509
      next_byte:
L
Linus Torvalds 已提交
510 511
	switch (function) {
	case ACPI_READ:
L
Luming Yu 已提交
512
		temp = 0;
513
		result = acpi_ec_read(ec, (u8) address, (u8 *) &temp);
L
Linus Torvalds 已提交
514 515
		break;
	case ACPI_WRITE:
L
Luming Yu 已提交
516
		result = acpi_ec_write(ec, (u8) address, (u8) temp);
L
Linus Torvalds 已提交
517 518 519 520 521 522 523 524
		break;
	default:
		result = -EINVAL;
		goto out;
		break;
	}

	bit_width -= 8;
L
Luming Yu 已提交
525 526 527 528 529
	if (bit_width) {
		if (function == ACPI_READ)
			f_v |= temp << 8 * i;
		if (function == ACPI_WRITE)
			temp >>= 8;
L
Linus Torvalds 已提交
530
		i++;
A
Andrew Morton 已提交
531
		address++;
L
Linus Torvalds 已提交
532 533 534
		goto next_byte;
	}

L
Luming Yu 已提交
535 536
	if (function == ACPI_READ) {
		f_v |= temp << 8 * i;
L
Linus Torvalds 已提交
537 538 539
		*value = f_v;
	}

L
Len Brown 已提交
540
      out:
L
Linus Torvalds 已提交
541 542
	switch (result) {
	case -EINVAL:
543
		return AE_BAD_PARAMETER;
L
Linus Torvalds 已提交
544 545
		break;
	case -ENODEV:
546
		return AE_NOT_FOUND;
L
Linus Torvalds 已提交
547 548
		break;
	case -ETIME:
549
		return AE_TIME;
L
Linus Torvalds 已提交
550 551
		break;
	default:
552
		return AE_OK;
L
Linus Torvalds 已提交
553 554 555 556 557 558 559
	}
}

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

L
Len Brown 已提交
560
static struct proc_dir_entry *acpi_ec_dir;
L
Linus Torvalds 已提交
561

L
Len Brown 已提交
562
static int acpi_ec_read_info(struct seq_file *seq, void *offset)
L
Linus Torvalds 已提交
563
{
564
	struct acpi_ec *ec = (struct acpi_ec *)seq->private;
L
Linus Torvalds 已提交
565 566 567 568 569 570


	if (!ec)
		goto end;

	seq_printf(seq, "gpe bit:                 0x%02x\n",
571
		   (u32) ec->gpe_bit);
L
Linus Torvalds 已提交
572
	seq_printf(seq, "ports:                   0x%02x, 0x%02x\n",
573 574
		   (u32) ec->command_addr,
		   (u32) ec->data_addr);
L
Linus Torvalds 已提交
575
	seq_printf(seq, "use global lock:         %s\n",
576 577
		   ec->global_lock ? "yes" : "no");
	acpi_enable_gpe(NULL, ec->gpe_bit, ACPI_NOT_ISR);
L
Linus Torvalds 已提交
578

L
Len Brown 已提交
579
      end:
580
	return 0;
L
Linus Torvalds 已提交
581 582 583 584 585 586 587
}

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

588
static struct file_operations acpi_ec_info_ops = {
L
Len Brown 已提交
589 590 591 592
	.open = acpi_ec_info_open_fs,
	.read = seq_read,
	.llseek = seq_lseek,
	.release = single_release,
L
Linus Torvalds 已提交
593 594 595
	.owner = THIS_MODULE,
};

L
Len Brown 已提交
596
static int acpi_ec_add_fs(struct acpi_device *device)
L
Linus Torvalds 已提交
597
{
L
Len Brown 已提交
598
	struct proc_dir_entry *entry = NULL;
L
Linus Torvalds 已提交
599 600 601 602


	if (!acpi_device_dir(device)) {
		acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
L
Len Brown 已提交
603
						     acpi_ec_dir);
L
Linus Torvalds 已提交
604
		if (!acpi_device_dir(device))
605
			return -ENODEV;
L
Linus Torvalds 已提交
606 607 608
	}

	entry = create_proc_entry(ACPI_EC_FILE_INFO, S_IRUGO,
L
Len Brown 已提交
609
				  acpi_device_dir(device));
L
Linus Torvalds 已提交
610
	if (!entry)
611
		return -ENODEV;
L
Linus Torvalds 已提交
612 613 614 615 616 617
	else {
		entry->proc_fops = &acpi_ec_info_ops;
		entry->data = acpi_driver_data(device);
		entry->owner = THIS_MODULE;
	}

618
	return 0;
L
Linus Torvalds 已提交
619 620
}

L
Len Brown 已提交
621
static int acpi_ec_remove_fs(struct acpi_device *device)
L
Linus Torvalds 已提交
622 623 624 625 626 627 628 629
{

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

630
	return 0;
L
Linus Torvalds 已提交
631 632 633 634 635 636
}

/* --------------------------------------------------------------------------
                               Driver Interface
   -------------------------------------------------------------------------- */

637
static int acpi_ec_add(struct acpi_device *device)
L
Linus Torvalds 已提交
638
{
L
Len Brown 已提交
639 640
	int result = 0;
	acpi_status status = AE_OK;
641
	struct acpi_ec *ec = NULL;
L
Luming Yu 已提交
642 643 644


	if (!device)
645
		return -EINVAL;
L
Luming Yu 已提交
646

647
	ec = kmalloc(sizeof(struct acpi_ec), GFP_KERNEL);
L
Luming Yu 已提交
648
	if (!ec)
649
		return -ENOMEM;
650 651 652 653 654 655 656 657
	memset(ec, 0, sizeof(struct acpi_ec));

	ec->handle = device->handle;
	ec->uid = -1;
	init_MUTEX(&ec->sem);
	if (acpi_ec_mode == EC_INTR) {
		atomic_set(&ec->leaving_burst, 1);
		init_waitqueue_head(&ec->wait);
L
Luming Yu 已提交
658
	}
L
Linus Torvalds 已提交
659 660 661 662 663
	strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
	strcpy(acpi_device_class(device), ACPI_EC_CLASS);
	acpi_driver_data(device) = ec;

	/* Use the global lock for all EC transactions? */
664 665
	acpi_evaluate_integer(ec->handle, "_GLK", NULL,
			      &ec->global_lock);
L
Linus Torvalds 已提交
666

J
Jiri Slaby 已提交
667 668 669
	/* XXX we don't test uids, because on some boxes ecdt uid = 0, see:
	   http://bugzilla.kernel.org/show_bug.cgi?id=6111 */
	if (ec_ecdt) {
L
Linus Torvalds 已提交
670
		acpi_remove_address_space_handler(ACPI_ROOT_OBJECT,
L
Len Brown 已提交
671 672
						  ACPI_ADR_SPACE_EC,
						  &acpi_ec_space_handler);
D
Dmitry Torokhov 已提交
673

674
		acpi_remove_gpe_handler(NULL, ec_ecdt->gpe_bit,
L
Len Brown 已提交
675
					&acpi_ec_gpe_handler);
L
Linus Torvalds 已提交
676 677 678 679 680 681

		kfree(ec_ecdt);
	}

	/* Get GPE bit assignment (EC events). */
	/* TODO: Add support for _GPE returning a package */
L
Len Brown 已提交
682
	status =
683 684
	    acpi_evaluate_integer(ec->handle, "_GPE", NULL,
				  &ec->gpe_bit);
L
Linus Torvalds 已提交
685
	if (ACPI_FAILURE(status)) {
686
		ACPI_EXCEPTION((AE_INFO, status, "Obtaining GPE bit assignment"));
L
Linus Torvalds 已提交
687 688 689 690 691 692 693 694
		result = -ENODEV;
		goto end;
	}

	result = acpi_ec_add_fs(device);
	if (result)
		goto end;

695
	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "%s [%s] (gpe %d) interrupt mode.",
L
Len Brown 已提交
696
	       acpi_device_name(device), acpi_device_bid(device),
697
	       (u32) ec->gpe_bit));
L
Linus Torvalds 已提交
698 699 700 701

	if (!first_ec)
		first_ec = device;

702
  end:
L
Linus Torvalds 已提交
703 704 705
	if (result)
		kfree(ec);

706
	return result;
L
Linus Torvalds 已提交
707 708
}

L
Len Brown 已提交
709
static int acpi_ec_remove(struct acpi_device *device, int type)
L
Linus Torvalds 已提交
710
{
711
	struct acpi_ec *ec = NULL;
L
Linus Torvalds 已提交
712 713 714


	if (!device)
715
		return -EINVAL;
L
Linus Torvalds 已提交
716 717 718 719 720 721 722

	ec = acpi_driver_data(device);

	acpi_ec_remove_fs(device);

	kfree(ec);

723
	return 0;
L
Linus Torvalds 已提交
724 725 726
}

static acpi_status
L
Len Brown 已提交
727
acpi_ec_io_ports(struct acpi_resource *resource, void *context)
L
Linus Torvalds 已提交
728
{
729
	struct acpi_ec *ec = (struct acpi_ec *)context;
L
Linus Torvalds 已提交
730

B
Bob Moore 已提交
731
	if (resource->type != ACPI_RESOURCE_TYPE_IO) {
L
Linus Torvalds 已提交
732 733 734 735 736 737 738 739
		return AE_OK;
	}

	/*
	 * The first address region returned is the data port, and
	 * the second address region returned is the status/command
	 * port.
	 */
740 741 742 743
	if (ec->data_addr == 0) {
		ec->data_addr = resource->data.io.minimum;
	} else if (ec->command_addr == 0) {
		ec->command_addr = resource->data.io.minimum;
L
Linus Torvalds 已提交
744 745 746 747 748 749 750
	} else {
		return AE_CTRL_TERMINATE;
	}

	return AE_OK;
}

L
Len Brown 已提交
751
static int acpi_ec_start(struct acpi_device *device)
L
Linus Torvalds 已提交
752
{
L
Len Brown 已提交
753
	acpi_status status = AE_OK;
754
	struct acpi_ec *ec = NULL;
L
Linus Torvalds 已提交
755 756 757


	if (!device)
758
		return -EINVAL;
L
Linus Torvalds 已提交
759 760 761 762

	ec = acpi_driver_data(device);

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

	/*
	 * Get I/O port addresses. Convert to GAS format.
	 */
768
	status = acpi_walk_resources(ec->handle, METHOD_NAME__CRS,
L
Len Brown 已提交
769
				     acpi_ec_io_ports, ec);
770
	if (ACPI_FAILURE(status) || ec->command_addr == 0) {
771 772
		ACPI_EXCEPTION((AE_INFO, status,
				"Error getting I/O port addresses"));
773
		return -ENODEV;
L
Linus Torvalds 已提交
774 775
	}

776 777
	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "gpe=0x%02lx, ports=0x%2lx,0x%2lx",
			  ec->gpe_bit, ec->command_addr, ec->data_addr));
L
Linus Torvalds 已提交
778 779 780 781

	/*
	 * Install GPE handler
	 */
782
	status = acpi_install_gpe_handler(NULL, ec->gpe_bit,
L
Len Brown 已提交
783 784
					  ACPI_GPE_EDGE_TRIGGERED,
					  &acpi_ec_gpe_handler, ec);
L
Linus Torvalds 已提交
785
	if (ACPI_FAILURE(status)) {
786
		return -ENODEV;
L
Linus Torvalds 已提交
787
	}
788 789
	acpi_set_gpe_type(NULL, ec->gpe_bit, ACPI_GPE_TYPE_RUNTIME);
	acpi_enable_gpe(NULL, ec->gpe_bit, ACPI_NOT_ISR);
L
Linus Torvalds 已提交
790

791
	status = acpi_install_address_space_handler(ec->handle,
L
Len Brown 已提交
792 793 794
						    ACPI_ADR_SPACE_EC,
						    &acpi_ec_space_handler,
						    &acpi_ec_space_setup, ec);
L
Linus Torvalds 已提交
795
	if (ACPI_FAILURE(status)) {
796
		acpi_remove_gpe_handler(NULL, ec->gpe_bit,
L
Len Brown 已提交
797
					&acpi_ec_gpe_handler);
798
		return -ENODEV;
L
Linus Torvalds 已提交
799 800
	}

801
	return AE_OK;
L
Linus Torvalds 已提交
802 803
}

L
Len Brown 已提交
804
static int acpi_ec_stop(struct acpi_device *device, int type)
L
Linus Torvalds 已提交
805
{
L
Len Brown 已提交
806
	acpi_status status = AE_OK;
807
	struct acpi_ec *ec = NULL;
L
Linus Torvalds 已提交
808 809 810


	if (!device)
811
		return -EINVAL;
L
Linus Torvalds 已提交
812 813 814

	ec = acpi_driver_data(device);

815
	status = acpi_remove_address_space_handler(ec->handle,
L
Len Brown 已提交
816 817
						   ACPI_ADR_SPACE_EC,
						   &acpi_ec_space_handler);
L
Linus Torvalds 已提交
818
	if (ACPI_FAILURE(status))
819
		return -ENODEV;
L
Linus Torvalds 已提交
820

L
Len Brown 已提交
821
	status =
822
	    acpi_remove_gpe_handler(NULL, ec->gpe_bit,
L
Len Brown 已提交
823
				    &acpi_ec_gpe_handler);
L
Linus Torvalds 已提交
824
	if (ACPI_FAILURE(status))
825
		return -ENODEV;
L
Linus Torvalds 已提交
826

827
	return 0;
L
Linus Torvalds 已提交
828 829 830
}

static acpi_status __init
L
Len Brown 已提交
831 832
acpi_fake_ecdt_callback(acpi_handle handle,
			u32 Level, void *context, void **retval)
L
Linus Torvalds 已提交
833
{
L
Len Brown 已提交
834
	acpi_status status;
L
Linus Torvalds 已提交
835

836 837 838 839
	init_MUTEX(&ec_ecdt->sem);
	if (acpi_ec_mode == EC_INTR) {
		init_waitqueue_head(&ec_ecdt->wait);
	}
L
Linus Torvalds 已提交
840
	status = acpi_walk_resources(handle, METHOD_NAME__CRS,
L
Len Brown 已提交
841
				     acpi_ec_io_ports, ec_ecdt);
L
Linus Torvalds 已提交
842 843 844
	if (ACPI_FAILURE(status))
		return status;

845 846
	ec_ecdt->uid = -1;
	acpi_evaluate_integer(handle, "_UID", NULL, &ec_ecdt->uid);
L
Linus Torvalds 已提交
847

L
Len Brown 已提交
848 849
	status =
	    acpi_evaluate_integer(handle, "_GPE", NULL,
850
				  &ec_ecdt->gpe_bit);
L
Linus Torvalds 已提交
851 852
	if (ACPI_FAILURE(status))
		return status;
853 854
	ec_ecdt->global_lock = TRUE;
	ec_ecdt->handle = handle;
L
Linus Torvalds 已提交
855

856 857
	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "GPE=0x%02lx, ports=0x%2lx, 0x%2lx",
	       ec_ecdt->gpe_bit, ec_ecdt->command_addr, ec_ecdt->data_addr));
L
Linus Torvalds 已提交
858 859 860 861 862 863 864 865 866 867 868 869 870 871

	return AE_CTRL_TERMINATE;
}

/*
 * Some BIOS (such as some from Gateway laptops) access EC region very early
 * such as in BAT0._INI or EC._INI before an EC device is found and
 * do not provide an ECDT. According to ACPI spec, ECDT isn't mandatorily
 * required, but if EC regison is accessed early, it is required.
 * The routine tries to workaround the BIOS bug by pre-scan EC device
 * It assumes that _CRS, _HID, _GPE, _UID methods of EC don't touch any
 * op region (since _REG isn't invoked yet). The assumption is true for
 * all systems found.
 */
L
Len Brown 已提交
872
static int __init acpi_ec_fake_ecdt(void)
L
Linus Torvalds 已提交
873
{
L
Len Brown 已提交
874 875
	acpi_status status;
	int ret = 0;
L
Linus Torvalds 已提交
876

877
	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Try to make an fake ECDT"));
L
Linus Torvalds 已提交
878

879
	ec_ecdt = kmalloc(sizeof(struct acpi_ec), GFP_KERNEL);
L
Linus Torvalds 已提交
880 881 882 883
	if (!ec_ecdt) {
		ret = -ENOMEM;
		goto error;
	}
884
	memset(ec_ecdt, 0, sizeof(struct acpi_ec));
L
Linus Torvalds 已提交
885

L
Len Brown 已提交
886 887
	status = acpi_get_devices(ACPI_EC_HID,
				  acpi_fake_ecdt_callback, NULL, NULL);
L
Linus Torvalds 已提交
888 889 890 891
	if (ACPI_FAILURE(status)) {
		kfree(ec_ecdt);
		ec_ecdt = NULL;
		ret = -ENODEV;
892
		ACPI_EXCEPTION((AE_INFO, status, "Can't make an fake ECDT"));
L
Linus Torvalds 已提交
893 894 895
		goto error;
	}
	return 0;
896
  error:
L
Linus Torvalds 已提交
897 898 899
	return ret;
}

L
Len Brown 已提交
900
static int __init acpi_ec_get_real_ecdt(void)
L
Luming Yu 已提交
901
{
L
Len Brown 已提交
902 903
	acpi_status status;
	struct acpi_table_ecdt *ecdt_ptr;
L
Luming Yu 已提交
904

L
Len Brown 已提交
905 906 907
	status = acpi_get_firmware_table("ECDT", 1, ACPI_LOGICAL_ADDRESSING,
					 (struct acpi_table_header **)
					 &ecdt_ptr);
L
Luming Yu 已提交
908 909 910
	if (ACPI_FAILURE(status))
		return -ENODEV;

911
	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found ECDT"));
L
Luming Yu 已提交
912 913 914 915

	/*
	 * Generate a temporary ec context to use until the namespace is scanned
	 */
916
	ec_ecdt = kmalloc(sizeof(struct acpi_ec), GFP_KERNEL);
L
Luming Yu 已提交
917 918
	if (!ec_ecdt)
		return -ENOMEM;
919
	memset(ec_ecdt, 0, sizeof(struct acpi_ec));
L
Luming Yu 已提交
920

921 922 923
	init_MUTEX(&ec_ecdt->sem);
	if (acpi_ec_mode == EC_INTR) {
		init_waitqueue_head(&ec_ecdt->wait);
L
Luming Yu 已提交
924
	}
925 926
	ec_ecdt->command_addr = ecdt_ptr->ec_control.address;
	ec_ecdt->data_addr = ecdt_ptr->ec_data.address;
927
	ec_ecdt->gpe_bit = ecdt_ptr->gpe_bit;
L
Linus Torvalds 已提交
928
	/* use the GL just to be safe */
929 930
	ec_ecdt->global_lock = TRUE;
	ec_ecdt->uid = ecdt_ptr->uid;
L
Linus Torvalds 已提交
931

L
Len Brown 已提交
932
	status =
933
	    acpi_get_handle(NULL, ecdt_ptr->ec_id, &ec_ecdt->handle);
L
Linus Torvalds 已提交
934 935 936 937 938
	if (ACPI_FAILURE(status)) {
		goto error;
	}

	return 0;
939 940
  error:
	ACPI_EXCEPTION((AE_INFO, status, "Could not use ECDT"));
L
Linus Torvalds 已提交
941 942 943 944 945 946 947
	kfree(ec_ecdt);
	ec_ecdt = NULL;

	return -ENODEV;
}

static int __initdata acpi_fake_ecdt_enabled;
L
Len Brown 已提交
948
int __init acpi_ec_ecdt_probe(void)
L
Linus Torvalds 已提交
949
{
L
Len Brown 已提交
950 951
	acpi_status status;
	int ret;
L
Linus Torvalds 已提交
952 953 954 955 956 957 958 959 960 961 962 963 964

	ret = acpi_ec_get_real_ecdt();
	/* Try to make a fake ECDT */
	if (ret && acpi_fake_ecdt_enabled) {
		ret = acpi_ec_fake_ecdt();
	}

	if (ret)
		return 0;

	/*
	 * Install GPE handler
	 */
965
	status = acpi_install_gpe_handler(NULL, ec_ecdt->gpe_bit,
L
Len Brown 已提交
966 967
					  ACPI_GPE_EDGE_TRIGGERED,
					  &acpi_ec_gpe_handler, ec_ecdt);
L
Linus Torvalds 已提交
968 969 970
	if (ACPI_FAILURE(status)) {
		goto error;
	}
971 972
	acpi_set_gpe_type(NULL, ec_ecdt->gpe_bit, ACPI_GPE_TYPE_RUNTIME);
	acpi_enable_gpe(NULL, ec_ecdt->gpe_bit, ACPI_NOT_ISR);
L
Len Brown 已提交
973 974 975 976 977 978

	status = acpi_install_address_space_handler(ACPI_ROOT_OBJECT,
						    ACPI_ADR_SPACE_EC,
						    &acpi_ec_space_handler,
						    &acpi_ec_space_setup,
						    ec_ecdt);
L
Linus Torvalds 已提交
979
	if (ACPI_FAILURE(status)) {
980
		acpi_remove_gpe_handler(NULL, ec_ecdt->gpe_bit,
L
Len Brown 已提交
981
					&acpi_ec_gpe_handler);
L
Linus Torvalds 已提交
982 983 984 985 986
		goto error;
	}

	return 0;

L
Len Brown 已提交
987
      error:
988
	ACPI_EXCEPTION((AE_INFO, status, "Could not use ECDT"));
L
Linus Torvalds 已提交
989 990 991 992 993 994
	kfree(ec_ecdt);
	ec_ecdt = NULL;

	return -ENODEV;
}

L
Len Brown 已提交
995
static int __init acpi_ec_init(void)
L
Linus Torvalds 已提交
996
{
L
Len Brown 已提交
997
	int result = 0;
L
Linus Torvalds 已提交
998 999 1000


	if (acpi_disabled)
1001
		return 0;
L
Linus Torvalds 已提交
1002 1003 1004

	acpi_ec_dir = proc_mkdir(ACPI_EC_CLASS, acpi_root_dir);
	if (!acpi_ec_dir)
1005
		return -ENODEV;
L
Linus Torvalds 已提交
1006 1007 1008 1009 1010

	/* 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);
1011
		return -ENODEV;
L
Linus Torvalds 已提交
1012 1013
	}

1014
	return result;
L
Linus Torvalds 已提交
1015 1016 1017 1018 1019 1020
}

subsys_initcall(acpi_ec_init);

/* EC driver currently not unloadable */
#if 0
L
Len Brown 已提交
1021
static void __exit acpi_ec_exit(void)
L
Linus Torvalds 已提交
1022 1023 1024 1025 1026 1027
{

	acpi_bus_unregister_driver(&acpi_ec_driver);

	remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);

1028
	return;
L
Linus Torvalds 已提交
1029
}
L
Len Brown 已提交
1030
#endif				/* 0 */
L
Linus Torvalds 已提交
1031 1032 1033 1034

static int __init acpi_fake_ecdt_setup(char *str)
{
	acpi_fake_ecdt_enabled = 1;
1035
	return 1;
L
Linus Torvalds 已提交
1036
}
1037

L
Linus Torvalds 已提交
1038
__setup("acpi_fake_ecdt", acpi_fake_ecdt_setup);
1039
static int __init acpi_ec_set_intr_mode(char *str)
L
Luming Yu 已提交
1040
{
1041
	int intr;
1042

1043
	if (!get_option(&str, &intr))
1044 1045
		return 0;

1046
	if (intr) {
1047
		acpi_ec_mode = EC_INTR;
1048
	} else {
1049
		acpi_ec_mode = EC_POLL;
1050
	}
1051 1052 1053
	acpi_ec_driver.ops.add = acpi_ec_add;
	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "EC %s mode.\n", intr ? "interrupt" : "polling"));

1054
	return 1;
L
Luming Yu 已提交
1055
}
L
Len Brown 已提交
1056

1057
__setup("ec_intr=", acpi_ec_set_intr_mode);