ec.c 24.4 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

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

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

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

68
#define ACPI_EC_DELAY		500	/* Wait 500ms max. during EC ops */
69 70
#define ACPI_EC_UDELAY_GLK	1000	/* Wait 1ms max. to get global lock */
#define ACPI_EC_UDELAY         100	/* Poll @ 100us increments */
71
#define ACPI_EC_UDELAY_COUNT   1000	/* Wait 100ms max. during EC ops */
72 73 74

enum {
	EC_INTR = 1,	/* Output buffer full */
75
	EC_POLL,	/* Input buffer empty */
76 77
};

L
Len Brown 已提交
78 79 80
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);
81
static int acpi_ec_add(struct acpi_device *device);
L
Linus Torvalds 已提交
82 83

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

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

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

L
Linus Torvalds 已提交
113 114 115 116
/* --------------------------------------------------------------------------
                             Transaction Management
   -------------------------------------------------------------------------- */

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

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

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

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

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

153
	return 0;
L
Luming Yu 已提交
154
}
D
Dmitry Torokhov 已提交
155

156
static int acpi_ec_wait(struct acpi_ec *ec, u8 event)
157
{
158 159
	int i = (acpi_ec_mode == EC_POLL) ? ACPI_EC_UDELAY_COUNT : 0;
	long time_left;
D
Dmitry Torokhov 已提交
160

161
	ec->expect_event = event;
162
	if (acpi_ec_check_status(ec, event)) {
163 164
		ec->expect_event = 0;
		return 0;
165 166
	}

167 168 169 170 171 172 173 174 175
	do {
		if (acpi_ec_mode == EC_POLL) {
			udelay(ACPI_EC_UDELAY);
		} else {
			time_left = wait_event_timeout(ec->wait,
				    !ec->expect_event,
				    msecs_to_jiffies(ACPI_EC_DELAY));
			if (time_left > 0) {
				ec->expect_event = 0;
176
				return 0;
177
			}
178
		}
179
		if (acpi_ec_check_status(ec, event)) {
180 181 182 183 184 185
			ec->expect_event = 0;
			return 0;
		}
	} while (--i > 0);

	ec->expect_event = 0;
L
Linus Torvalds 已提交
186

187
	return -ETIME;
L
Linus Torvalds 已提交
188 189
}

190
#ifdef ACPI_FUTURE_USAGE
191 192 193 194
/*
 * Note: samsung nv5000 doesn't work with ec burst mode.
 * http://bugzilla.kernel.org/show_bug.cgi?id=4980
 */
195
int acpi_ec_enter_burst_mode(struct acpi_ec *ec)
D
Dmitry Torokhov 已提交
196
{
197 198
	u8 tmp = 0;
	u8 status = 0;
D
Dmitry Torokhov 已提交
199 200 201


	status = acpi_ec_read_status(ec);
L
Len Brown 已提交
202
	if (status != -EINVAL && !(status & ACPI_EC_FLAG_BURST)) {
203
		status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0);
L
Len Brown 已提交
204
		if (status)
205
			goto end;
206 207 208
		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 已提交
209
		if (tmp != 0x90) {	/* Burst ACK byte */
210
			return -EINVAL;
D
Dmitry Torokhov 已提交
211
		}
212 213
	}

214
	atomic_set(&ec->leaving_burst, 0);
215
	return 0;
216 217
  end:
	ACPI_EXCEPTION((AE_INFO, status, "EC wait, burst mode"));
218
	return -1;
D
Dmitry Torokhov 已提交
219 220
}

221
int acpi_ec_leave_burst_mode(struct acpi_ec *ec)
D
Dmitry Torokhov 已提交
222
{
223
	u8 status = 0;
D
Dmitry Torokhov 已提交
224 225


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

242
static int acpi_ec_transaction_unlocked(struct acpi_ec *ec, u8 command,
243 244
					const u8 *wdata, unsigned wdata_len,
					u8 *rdata, unsigned rdata_len)
L
Luming Yu 已提交
245
{
246
	int result;
L
Luming Yu 已提交
247

248
	acpi_ec_write_cmd(ec, command);
L
Luming Yu 已提交
249

250
	for (; wdata_len > 0; wdata_len --) {
251
		result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0);
252 253
		if (result)
			return result;
254
		acpi_ec_write_data(ec, *(wdata++));
255
	}
L
Luming Yu 已提交
256

257
	if (!rdata_len) {
258
		result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0);
259 260 261
		if (result)
			return result;
	}
L
Luming Yu 已提交
262

263
	for (; rdata_len > 0; rdata_len --) {
264
		result = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF_1);
265 266
		if (result)
			return result;
L
Len Brown 已提交
267

268
		*(rdata++) = acpi_ec_read_data(ec);
269
	}
L
Luming Yu 已提交
270

271
	return 0;
L
Luming Yu 已提交
272 273
}

274 275 276
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 已提交
277
{
278
	int status;
L
Len Brown 已提交
279
	u32 glk;
L
Linus Torvalds 已提交
280

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

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

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

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

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

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

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

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

313
	return status;
L
Linus Torvalds 已提交
314 315
}

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

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

327 328 329 330 331 332 333
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 已提交
334 335 336
/*
 * Externally callable EC access functions. For now, assume 1 EC only
 */
337
int ec_read(u8 addr, u8 *val)
L
Linus Torvalds 已提交
338
{
339
	struct acpi_ec *ec;
L
Linus Torvalds 已提交
340
	int err;
341
	u8 temp_data;
L
Linus Torvalds 已提交
342 343 344 345 346 347 348 349 350 351 352

	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 已提交
353
	} else
L
Linus Torvalds 已提交
354 355
		return err;
}
L
Len Brown 已提交
356

L
Linus Torvalds 已提交
357 358
EXPORT_SYMBOL(ec_read);

L
Len Brown 已提交
359
int ec_write(u8 addr, u8 val)
L
Linus Torvalds 已提交
360
{
361
	struct acpi_ec *ec;
L
Linus Torvalds 已提交
362 363 364 365 366 367 368 369 370 371 372
	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 已提交
373

L
Linus Torvalds 已提交
374 375
EXPORT_SYMBOL(ec_write);

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

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

385
	ec = acpi_driver_data(first_ec);
L
Luming Yu 已提交
386

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

391 392
EXPORT_SYMBOL(ec_transaction);

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

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

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

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

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

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

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

422
struct acpi_ec_query_data {
L
Len Brown 已提交
423 424
	acpi_handle handle;
	u8 data;
L
Linus Torvalds 已提交
425 426
};

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

433
	if (!ec)
L
Luming Yu 已提交
434 435
		goto end;

436
	value = acpi_ec_read_status(ec);
L
Luming Yu 已提交
437 438 439 440 441 442 443

	if (!(value & ACPI_EC_FLAG_SCI))
		goto end;

	if (acpi_ec_query(ec, &value))
		goto end;

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

446
	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluating %s", object_name));
L
Luming Yu 已提交
447

448
	acpi_evaluate_object(ec->handle, object_name, NULL, NULL);
L
Luming Yu 已提交
449

L
Len Brown 已提交
450
      end:
451
	acpi_enable_gpe(NULL, ec->gpe_bit, ACPI_NOT_ISR);
L
Luming Yu 已提交
452
}
L
Linus Torvalds 已提交
453

L
Len Brown 已提交
454
static u32 acpi_ec_gpe_handler(void *data)
L
Linus Torvalds 已提交
455
{
L
Len Brown 已提交
456
	acpi_status status = AE_OK;
457
	u8 value;
458
	struct acpi_ec *ec = (struct acpi_ec *)data;
L
Linus Torvalds 已提交
459

460
	acpi_clear_gpe(NULL, ec->gpe_bit, ACPI_ISR);
L
Linus Torvalds 已提交
461

462
	if (acpi_ec_mode == EC_INTR) {
463
		if (acpi_ec_check_status(ec, ec->expect_event)) {
464 465 466
			ec->expect_event = 0;
			wake_up(&ec->wait);
		}
D
Dmitry Torokhov 已提交
467 468
	}

469
	value = acpi_ec_read_status(ec);
L
Len Brown 已提交
470
	if (value & ACPI_EC_FLAG_SCI) {
471
		status = acpi_os_execute(OSL_EC_BURST_HANDLER, acpi_ec_gpe_query, ec);
L
Luming Yu 已提交
472
		return status == AE_OK ?
L
Len Brown 已提交
473 474
		    ACPI_INTERRUPT_HANDLED : ACPI_INTERRUPT_NOT_HANDLED;
	}
475
	acpi_enable_gpe(NULL, ec->gpe_bit, ACPI_ISR);
D
Dmitry Torokhov 已提交
476
	return status == AE_OK ?
L
Len Brown 已提交
477
	    ACPI_INTERRUPT_HANDLED : ACPI_INTERRUPT_NOT_HANDLED;
L
Linus Torvalds 已提交
478 479 480 481 482 483 484
}

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

static acpi_status
L
Len Brown 已提交
485 486
acpi_ec_space_setup(acpi_handle region_handle,
		    u32 function, void *handler_context, void **return_context)
L
Linus Torvalds 已提交
487 488 489 490 491
{
	/*
	 * The EC object is in the handler context and is needed
	 * when calling the acpi_ec_space_handler.
	 */
L
Len Brown 已提交
492 493
	*return_context = (function != ACPI_REGION_DEACTIVATE) ?
	    handler_context : NULL;
L
Linus Torvalds 已提交
494 495 496 497 498

	return AE_OK;
}

static acpi_status
L
Len Brown 已提交
499 500 501 502 503
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 已提交
504
{
L
Len Brown 已提交
505
	int result = 0;
506
	struct acpi_ec *ec = NULL;
L
Len Brown 已提交
507 508 509
	u64 temp = *value;
	acpi_integer f_v = 0;
	int i = 0;
L
Linus Torvalds 已提交
510 511 512


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

L
Luming Yu 已提交
515
	if (bit_width != 8 && acpi_strict) {
516
		return AE_BAD_PARAMETER;
L
Linus Torvalds 已提交
517 518
	}

519
	ec = (struct acpi_ec *)handler_context;
L
Linus Torvalds 已提交
520

L
Len Brown 已提交
521
      next_byte:
L
Linus Torvalds 已提交
522 523
	switch (function) {
	case ACPI_READ:
L
Luming Yu 已提交
524
		temp = 0;
525
		result = acpi_ec_read(ec, (u8) address, (u8 *) &temp);
L
Linus Torvalds 已提交
526 527
		break;
	case ACPI_WRITE:
L
Luming Yu 已提交
528
		result = acpi_ec_write(ec, (u8) address, (u8) temp);
L
Linus Torvalds 已提交
529 530 531 532 533 534 535 536
		break;
	default:
		result = -EINVAL;
		goto out;
		break;
	}

	bit_width -= 8;
L
Luming Yu 已提交
537 538 539 540 541
	if (bit_width) {
		if (function == ACPI_READ)
			f_v |= temp << 8 * i;
		if (function == ACPI_WRITE)
			temp >>= 8;
L
Linus Torvalds 已提交
542
		i++;
A
Andrew Morton 已提交
543
		address++;
L
Linus Torvalds 已提交
544 545 546
		goto next_byte;
	}

L
Luming Yu 已提交
547 548
	if (function == ACPI_READ) {
		f_v |= temp << 8 * i;
L
Linus Torvalds 已提交
549 550 551
		*value = f_v;
	}

L
Len Brown 已提交
552
      out:
L
Linus Torvalds 已提交
553 554
	switch (result) {
	case -EINVAL:
555
		return AE_BAD_PARAMETER;
L
Linus Torvalds 已提交
556 557
		break;
	case -ENODEV:
558
		return AE_NOT_FOUND;
L
Linus Torvalds 已提交
559 560
		break;
	case -ETIME:
561
		return AE_TIME;
L
Linus Torvalds 已提交
562 563
		break;
	default:
564
		return AE_OK;
L
Linus Torvalds 已提交
565 566 567 568 569 570 571
	}
}

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

L
Len Brown 已提交
572
static struct proc_dir_entry *acpi_ec_dir;
L
Linus Torvalds 已提交
573

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


	if (!ec)
		goto end;

	seq_printf(seq, "gpe bit:                 0x%02x\n",
583
		   (u32) ec->gpe_bit);
L
Linus Torvalds 已提交
584
	seq_printf(seq, "ports:                   0x%02x, 0x%02x\n",
585 586
		   (u32) ec->command_addr,
		   (u32) ec->data_addr);
L
Linus Torvalds 已提交
587
	seq_printf(seq, "use global lock:         %s\n",
588 589
		   ec->global_lock ? "yes" : "no");
	acpi_enable_gpe(NULL, ec->gpe_bit, ACPI_NOT_ISR);
L
Linus Torvalds 已提交
590

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 614


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

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

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

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

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

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

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

649
static int acpi_ec_add(struct acpi_device *device)
L
Linus Torvalds 已提交
650
{
L
Len Brown 已提交
651 652
	int result = 0;
	acpi_status status = AE_OK;
653
	struct acpi_ec *ec = NULL;
L
Luming Yu 已提交
654 655 656


	if (!device)
657
		return -EINVAL;
L
Luming Yu 已提交
658

659
	ec = kmalloc(sizeof(struct acpi_ec), GFP_KERNEL);
L
Luming Yu 已提交
660
	if (!ec)
661
		return -ENOMEM;
662 663 664 665 666 667 668 669
	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 已提交
670
	}
L
Linus Torvalds 已提交
671 672 673 674 675
	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? */
676 677
	acpi_evaluate_integer(ec->handle, "_GLK", NULL,
			      &ec->global_lock);
L
Linus Torvalds 已提交
678

J
Jiri Slaby 已提交
679 680 681
	/* 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 已提交
682
		acpi_remove_address_space_handler(ACPI_ROOT_OBJECT,
L
Len Brown 已提交
683 684
						  ACPI_ADR_SPACE_EC,
						  &acpi_ec_space_handler);
D
Dmitry Torokhov 已提交
685

686
		acpi_remove_gpe_handler(NULL, ec_ecdt->gpe_bit,
L
Len Brown 已提交
687
					&acpi_ec_gpe_handler);
L
Linus Torvalds 已提交
688 689 690 691 692 693

		kfree(ec_ecdt);
	}

	/* Get GPE bit assignment (EC events). */
	/* TODO: Add support for _GPE returning a package */
L
Len Brown 已提交
694
	status =
695 696
	    acpi_evaluate_integer(ec->handle, "_GPE", NULL,
				  &ec->gpe_bit);
L
Linus Torvalds 已提交
697
	if (ACPI_FAILURE(status)) {
698
		ACPI_EXCEPTION((AE_INFO, status, "Obtaining GPE bit assignment"));
L
Linus Torvalds 已提交
699 700 701 702 703 704 705 706
		result = -ENODEV;
		goto end;
	}

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

707
	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "%s [%s] (gpe %d) interrupt mode.",
L
Len Brown 已提交
708
	       acpi_device_name(device), acpi_device_bid(device),
709
	       (u32) ec->gpe_bit));
L
Linus Torvalds 已提交
710 711 712 713

	if (!first_ec)
		first_ec = device;

714
  end:
L
Linus Torvalds 已提交
715 716 717
	if (result)
		kfree(ec);

718
	return result;
L
Linus Torvalds 已提交
719 720
}

L
Len Brown 已提交
721
static int acpi_ec_remove(struct acpi_device *device, int type)
L
Linus Torvalds 已提交
722
{
723
	struct acpi_ec *ec = NULL;
L
Linus Torvalds 已提交
724 725 726


	if (!device)
727
		return -EINVAL;
L
Linus Torvalds 已提交
728 729 730 731 732 733 734

	ec = acpi_driver_data(device);

	acpi_ec_remove_fs(device);

	kfree(ec);

735
	return 0;
L
Linus Torvalds 已提交
736 737 738
}

static acpi_status
L
Len Brown 已提交
739
acpi_ec_io_ports(struct acpi_resource *resource, void *context)
L
Linus Torvalds 已提交
740
{
741
	struct acpi_ec *ec = (struct acpi_ec *)context;
L
Linus Torvalds 已提交
742

B
Bob Moore 已提交
743
	if (resource->type != ACPI_RESOURCE_TYPE_IO) {
L
Linus Torvalds 已提交
744 745 746 747 748 749 750 751
		return AE_OK;
	}

	/*
	 * The first address region returned is the data port, and
	 * the second address region returned is the status/command
	 * port.
	 */
752 753 754 755
	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 已提交
756 757 758 759 760 761 762
	} else {
		return AE_CTRL_TERMINATE;
	}

	return AE_OK;
}

L
Len Brown 已提交
763
static int acpi_ec_start(struct acpi_device *device)
L
Linus Torvalds 已提交
764
{
L
Len Brown 已提交
765
	acpi_status status = AE_OK;
766
	struct acpi_ec *ec = NULL;
L
Linus Torvalds 已提交
767 768 769


	if (!device)
770
		return -EINVAL;
L
Linus Torvalds 已提交
771 772 773 774

	ec = acpi_driver_data(device);

	if (!ec)
775
		return -EINVAL;
L
Linus Torvalds 已提交
776 777 778 779

	/*
	 * Get I/O port addresses. Convert to GAS format.
	 */
780
	status = acpi_walk_resources(ec->handle, METHOD_NAME__CRS,
L
Len Brown 已提交
781
				     acpi_ec_io_ports, ec);
782
	if (ACPI_FAILURE(status) || ec->command_addr == 0) {
783 784
		ACPI_EXCEPTION((AE_INFO, status,
				"Error getting I/O port addresses"));
785
		return -ENODEV;
L
Linus Torvalds 已提交
786 787
	}

788 789
	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 已提交
790 791 792 793

	/*
	 * Install GPE handler
	 */
794
	status = acpi_install_gpe_handler(NULL, ec->gpe_bit,
L
Len Brown 已提交
795 796
					  ACPI_GPE_EDGE_TRIGGERED,
					  &acpi_ec_gpe_handler, ec);
L
Linus Torvalds 已提交
797
	if (ACPI_FAILURE(status)) {
798
		return -ENODEV;
L
Linus Torvalds 已提交
799
	}
800 801
	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 已提交
802

803
	status = acpi_install_address_space_handler(ec->handle,
L
Len Brown 已提交
804 805 806
						    ACPI_ADR_SPACE_EC,
						    &acpi_ec_space_handler,
						    &acpi_ec_space_setup, ec);
L
Linus Torvalds 已提交
807
	if (ACPI_FAILURE(status)) {
808
		acpi_remove_gpe_handler(NULL, ec->gpe_bit,
L
Len Brown 已提交
809
					&acpi_ec_gpe_handler);
810
		return -ENODEV;
L
Linus Torvalds 已提交
811 812
	}

813
	return AE_OK;
L
Linus Torvalds 已提交
814 815
}

L
Len Brown 已提交
816
static int acpi_ec_stop(struct acpi_device *device, int type)
L
Linus Torvalds 已提交
817
{
L
Len Brown 已提交
818
	acpi_status status = AE_OK;
819
	struct acpi_ec *ec = NULL;
L
Linus Torvalds 已提交
820 821 822


	if (!device)
823
		return -EINVAL;
L
Linus Torvalds 已提交
824 825 826

	ec = acpi_driver_data(device);

827
	status = acpi_remove_address_space_handler(ec->handle,
L
Len Brown 已提交
828 829
						   ACPI_ADR_SPACE_EC,
						   &acpi_ec_space_handler);
L
Linus Torvalds 已提交
830
	if (ACPI_FAILURE(status))
831
		return -ENODEV;
L
Linus Torvalds 已提交
832

L
Len Brown 已提交
833
	status =
834
	    acpi_remove_gpe_handler(NULL, ec->gpe_bit,
L
Len Brown 已提交
835
				    &acpi_ec_gpe_handler);
L
Linus Torvalds 已提交
836
	if (ACPI_FAILURE(status))
837
		return -ENODEV;
L
Linus Torvalds 已提交
838

839
	return 0;
L
Linus Torvalds 已提交
840 841 842
}

static acpi_status __init
L
Len Brown 已提交
843 844
acpi_fake_ecdt_callback(acpi_handle handle,
			u32 Level, void *context, void **retval)
L
Linus Torvalds 已提交
845
{
L
Len Brown 已提交
846
	acpi_status status;
L
Linus Torvalds 已提交
847

848 849 850 851
	init_MUTEX(&ec_ecdt->sem);
	if (acpi_ec_mode == EC_INTR) {
		init_waitqueue_head(&ec_ecdt->wait);
	}
L
Linus Torvalds 已提交
852
	status = acpi_walk_resources(handle, METHOD_NAME__CRS,
L
Len Brown 已提交
853
				     acpi_ec_io_ports, ec_ecdt);
L
Linus Torvalds 已提交
854 855 856
	if (ACPI_FAILURE(status))
		return status;

857 858
	ec_ecdt->uid = -1;
	acpi_evaluate_integer(handle, "_UID", NULL, &ec_ecdt->uid);
L
Linus Torvalds 已提交
859

L
Len Brown 已提交
860 861
	status =
	    acpi_evaluate_integer(handle, "_GPE", NULL,
862
				  &ec_ecdt->gpe_bit);
L
Linus Torvalds 已提交
863 864
	if (ACPI_FAILURE(status))
		return status;
865 866
	ec_ecdt->global_lock = TRUE;
	ec_ecdt->handle = handle;
L
Linus Torvalds 已提交
867

868 869
	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 已提交
870 871 872 873 874 875 876 877 878 879 880 881 882 883

	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 已提交
884
static int __init acpi_ec_fake_ecdt(void)
L
Linus Torvalds 已提交
885
{
L
Len Brown 已提交
886 887
	acpi_status status;
	int ret = 0;
L
Linus Torvalds 已提交
888

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

891
	ec_ecdt = kmalloc(sizeof(struct acpi_ec), GFP_KERNEL);
L
Linus Torvalds 已提交
892 893 894 895
	if (!ec_ecdt) {
		ret = -ENOMEM;
		goto error;
	}
896
	memset(ec_ecdt, 0, sizeof(struct acpi_ec));
L
Linus Torvalds 已提交
897

L
Len Brown 已提交
898 899
	status = acpi_get_devices(ACPI_EC_HID,
				  acpi_fake_ecdt_callback, NULL, NULL);
L
Linus Torvalds 已提交
900 901 902 903
	if (ACPI_FAILURE(status)) {
		kfree(ec_ecdt);
		ec_ecdt = NULL;
		ret = -ENODEV;
904
		ACPI_EXCEPTION((AE_INFO, status, "Can't make an fake ECDT"));
L
Linus Torvalds 已提交
905 906 907
		goto error;
	}
	return 0;
908
  error:
L
Linus Torvalds 已提交
909 910 911
	return ret;
}

L
Len Brown 已提交
912
static int __init acpi_ec_get_real_ecdt(void)
L
Luming Yu 已提交
913
{
L
Len Brown 已提交
914 915
	acpi_status status;
	struct acpi_table_ecdt *ecdt_ptr;
L
Luming Yu 已提交
916

L
Len Brown 已提交
917 918 919
	status = acpi_get_firmware_table("ECDT", 1, ACPI_LOGICAL_ADDRESSING,
					 (struct acpi_table_header **)
					 &ecdt_ptr);
L
Luming Yu 已提交
920 921 922
	if (ACPI_FAILURE(status))
		return -ENODEV;

923
	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found ECDT"));
L
Luming Yu 已提交
924 925 926 927

	/*
	 * Generate a temporary ec context to use until the namespace is scanned
	 */
928
	ec_ecdt = kmalloc(sizeof(struct acpi_ec), GFP_KERNEL);
L
Luming Yu 已提交
929 930
	if (!ec_ecdt)
		return -ENOMEM;
931
	memset(ec_ecdt, 0, sizeof(struct acpi_ec));
L
Luming Yu 已提交
932

933 934 935
	init_MUTEX(&ec_ecdt->sem);
	if (acpi_ec_mode == EC_INTR) {
		init_waitqueue_head(&ec_ecdt->wait);
L
Luming Yu 已提交
936
	}
937 938
	ec_ecdt->command_addr = ecdt_ptr->ec_control.address;
	ec_ecdt->data_addr = ecdt_ptr->ec_data.address;
939
	ec_ecdt->gpe_bit = ecdt_ptr->gpe_bit;
L
Linus Torvalds 已提交
940
	/* use the GL just to be safe */
941 942
	ec_ecdt->global_lock = TRUE;
	ec_ecdt->uid = ecdt_ptr->uid;
L
Linus Torvalds 已提交
943

L
Len Brown 已提交
944
	status =
945
	    acpi_get_handle(NULL, ecdt_ptr->ec_id, &ec_ecdt->handle);
L
Linus Torvalds 已提交
946 947 948 949 950
	if (ACPI_FAILURE(status)) {
		goto error;
	}

	return 0;
951 952
  error:
	ACPI_EXCEPTION((AE_INFO, status, "Could not use ECDT"));
L
Linus Torvalds 已提交
953 954 955 956 957 958 959
	kfree(ec_ecdt);
	ec_ecdt = NULL;

	return -ENODEV;
}

static int __initdata acpi_fake_ecdt_enabled;
L
Len Brown 已提交
960
int __init acpi_ec_ecdt_probe(void)
L
Linus Torvalds 已提交
961
{
L
Len Brown 已提交
962 963
	acpi_status status;
	int ret;
L
Linus Torvalds 已提交
964 965 966 967 968 969 970 971 972 973 974 975 976

	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
	 */
977
	status = acpi_install_gpe_handler(NULL, ec_ecdt->gpe_bit,
L
Len Brown 已提交
978 979
					  ACPI_GPE_EDGE_TRIGGERED,
					  &acpi_ec_gpe_handler, ec_ecdt);
L
Linus Torvalds 已提交
980 981 982
	if (ACPI_FAILURE(status)) {
		goto error;
	}
983 984
	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 已提交
985 986 987 988 989 990

	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 已提交
991
	if (ACPI_FAILURE(status)) {
992
		acpi_remove_gpe_handler(NULL, ec_ecdt->gpe_bit,
L
Len Brown 已提交
993
					&acpi_ec_gpe_handler);
L
Linus Torvalds 已提交
994 995 996 997 998
		goto error;
	}

	return 0;

L
Len Brown 已提交
999
      error:
1000
	ACPI_EXCEPTION((AE_INFO, status, "Could not use ECDT"));
L
Linus Torvalds 已提交
1001 1002 1003 1004 1005 1006
	kfree(ec_ecdt);
	ec_ecdt = NULL;

	return -ENODEV;
}

L
Len Brown 已提交
1007
static int __init acpi_ec_init(void)
L
Linus Torvalds 已提交
1008
{
L
Len Brown 已提交
1009
	int result = 0;
L
Linus Torvalds 已提交
1010 1011 1012


	if (acpi_disabled)
1013
		return 0;
L
Linus Torvalds 已提交
1014 1015 1016

	acpi_ec_dir = proc_mkdir(ACPI_EC_CLASS, acpi_root_dir);
	if (!acpi_ec_dir)
1017
		return -ENODEV;
L
Linus Torvalds 已提交
1018 1019 1020 1021 1022

	/* 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);
1023
		return -ENODEV;
L
Linus Torvalds 已提交
1024 1025
	}

1026
	return result;
L
Linus Torvalds 已提交
1027 1028 1029 1030 1031 1032
}

subsys_initcall(acpi_ec_init);

/* EC driver currently not unloadable */
#if 0
L
Len Brown 已提交
1033
static void __exit acpi_ec_exit(void)
L
Linus Torvalds 已提交
1034 1035 1036 1037 1038 1039
{

	acpi_bus_unregister_driver(&acpi_ec_driver);

	remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);

1040
	return;
L
Linus Torvalds 已提交
1041
}
L
Len Brown 已提交
1042
#endif				/* 0 */
L
Linus Torvalds 已提交
1043 1044 1045 1046

static int __init acpi_fake_ecdt_setup(char *str)
{
	acpi_fake_ecdt_enabled = 1;
1047
	return 1;
L
Linus Torvalds 已提交
1048
}
1049

L
Linus Torvalds 已提交
1050
__setup("acpi_fake_ecdt", acpi_fake_ecdt_setup);
1051
static int __init acpi_ec_set_intr_mode(char *str)
L
Luming Yu 已提交
1052
{
1053
	int intr;
1054

1055
	if (!get_option(&str, &intr))
1056 1057
		return 0;

1058
	if (intr) {
1059
		acpi_ec_mode = EC_INTR;
1060
	} else {
1061
		acpi_ec_mode = EC_POLL;
1062
	}
1063 1064 1065
	acpi_ec_driver.ops.add = acpi_ec_add;
	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "EC %s mode.\n", intr ? "interrupt" : "polling"));

1066
	return 1;
L
Luming Yu 已提交
1067
}
L
Len Brown 已提交
1068

1069
__setup("ec_intr=", acpi_ec_set_intr_mode);