blob: f70796081c4c0ad93c0e5c751cc2297b81dea9f4 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +04002 * ec.c - ACPI Embedded Controller Driver (v2.1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +04004 * Copyright (C) 2006-2008 Alexey Starikovskiy <astarikovskiy@suse.de>
Alexey Starikovskiy01f22462007-03-07 22:28:00 +03005 * Copyright (C) 2006 Denis Sadykov <denis.m.sadykov@intel.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 * Copyright (C) 2004 Luming Yu <luming.yu@intel.com>
7 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
8 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
9 *
10 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or (at
15 * your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License along
23 * with this program; if not, write to the Free Software Foundation, Inc.,
24 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
25 *
26 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
27 */
28
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +040029/* Uncomment next line to get verbose printout */
Márton Némethd772b3b2008-01-23 22:34:09 -050030/* #define DEBUG */
31
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/kernel.h>
33#include <linux/module.h>
34#include <linux/init.h>
35#include <linux/types.h>
36#include <linux/delay.h>
37#include <linux/proc_fs.h>
38#include <linux/seq_file.h>
Dmitry Torokhov451566f2005-03-19 01:10:05 -050039#include <linux/interrupt.h>
Alexey Starikovskiy837012e2007-05-29 16:43:02 +040040#include <linux/list.h>
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +040041#include <linux/spinlock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070042#include <asm/io.h>
43#include <acpi/acpi_bus.h>
44#include <acpi/acpi_drivers.h>
Len Browneb27cae2009-07-06 23:40:19 -040045#include <linux/dmi.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#define ACPI_EC_CLASS "embedded_controller"
Linus Torvalds1da177e2005-04-16 15:20:36 -070048#define ACPI_EC_DEVICE_NAME "Embedded Controller"
49#define ACPI_EC_FILE_INFO "info"
Alexey Starikovskiy837012e2007-05-29 16:43:02 +040050
Alexey Starikovskiyaf3fd142006-12-07 18:42:16 +030051#define PREFIX "ACPI: EC: "
Alexey Starikovskiy43509332007-05-29 16:42:57 +040052
Denis M. Sadykov703959d2006-09-26 19:50:33 +040053/* EC status register */
Linus Torvalds1da177e2005-04-16 15:20:36 -070054#define ACPI_EC_FLAG_OBF 0x01 /* Output buffer full */
55#define ACPI_EC_FLAG_IBF 0x02 /* Input buffer full */
Dmitry Torokhov451566f2005-03-19 01:10:05 -050056#define ACPI_EC_FLAG_BURST 0x10 /* burst mode */
Linus Torvalds1da177e2005-04-16 15:20:36 -070057#define ACPI_EC_FLAG_SCI 0x20 /* EC-SCI occurred */
Alexey Starikovskiy43509332007-05-29 16:42:57 +040058
Denis M. Sadykov703959d2006-09-26 19:50:33 +040059/* EC commands */
Alexey Starikovskiy3261ff42006-12-07 18:42:17 +030060enum ec_command {
Alexey Starikovskiy6ccedb12006-12-07 18:42:17 +030061 ACPI_EC_COMMAND_READ = 0x80,
62 ACPI_EC_COMMAND_WRITE = 0x81,
63 ACPI_EC_BURST_ENABLE = 0x82,
64 ACPI_EC_BURST_DISABLE = 0x83,
65 ACPI_EC_COMMAND_QUERY = 0x84,
Alexey Starikovskiy3261ff42006-12-07 18:42:17 +030066};
Alexey Starikovskiy837012e2007-05-29 16:43:02 +040067
Alexey Starikovskiy5c406412006-12-07 18:42:16 +030068#define ACPI_EC_DELAY 500 /* Wait 500ms max. during EC ops */
Denis M. Sadykov703959d2006-09-26 19:50:33 +040069#define ACPI_EC_UDELAY_GLK 1000 /* Wait 1ms max. to get global lock */
Alexey Starikovskiy34ff4db2009-04-01 00:25:10 -040070#define ACPI_EC_CDELAY 10 /* Wait 10us before polling EC */
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +040071#define ACPI_EC_MSI_UDELAY 550 /* Wait 550us for MSI EC */
Denis M. Sadykov703959d2006-09-26 19:50:33 +040072
Alexey Starikovskiy06cf7d32008-11-09 19:01:06 +030073#define ACPI_EC_STORM_THRESHOLD 8 /* number of false interrupts
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +040074 per one transaction */
75
Alexey Starikovskiy080e4122007-10-22 14:18:30 +040076enum {
Alexey Starikovskiy080e4122007-10-22 14:18:30 +040077 EC_FLAGS_QUERY_PENDING, /* Query is pending */
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +040078 EC_FLAGS_GPE_STORM, /* GPE storm detected */
79 EC_FLAGS_HANDLERS_INSTALLED /* Handlers for GPE and
80 * OpReg are installed */
Linus Torvalds1da177e2005-04-16 15:20:36 -070081};
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +040082
83/* If we find an EC via the ECDT, we need to keep a ptr to its context */
Alexey Starikovskiyd0338792007-03-07 22:28:00 +030084/* External interfaces use first EC only, so remember */
Alexey Starikovskiy837012e2007-05-29 16:43:02 +040085typedef int (*acpi_ec_query_func) (void *data);
86
87struct acpi_ec_query_handler {
88 struct list_head node;
89 acpi_ec_query_func func;
90 acpi_handle handle;
91 void *data;
92 u8 query_bit;
93};
94
Alexey Starikovskiy84632002008-09-26 00:54:28 +040095struct transaction {
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +040096 const u8 *wdata;
97 u8 *rdata;
98 unsigned short irq_count;
Alexey Starikovskiy84632002008-09-26 00:54:28 +040099 u8 command;
Alexey Starikovskiya2f93ae2008-11-12 01:40:19 +0300100 u8 wi;
101 u8 ri;
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400102 u8 wlen;
103 u8 rlen;
Alexey Starikovskiydd15f8c2008-11-08 21:42:30 +0300104 bool done;
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400105};
106
Adrian Bunka854e082006-12-19 12:56:12 -0800107static struct acpi_ec {
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400108 acpi_handle handle;
Alexey Starikovskiya86e2772006-12-07 18:42:16 +0300109 unsigned long gpe;
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400110 unsigned long command_addr;
111 unsigned long data_addr;
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400112 unsigned long global_lock;
Alexey Starikovskiy080e4122007-10-22 14:18:30 +0400113 unsigned long flags;
Alexey Starikovskiyc787a852006-12-07 18:42:16 +0300114 struct mutex lock;
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400115 wait_queue_head_t wait;
Alexey Starikovskiy837012e2007-05-29 16:43:02 +0400116 struct list_head list;
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400117 struct transaction *curr;
118 spinlock_t curr_lock;
Alexey Starikovskiyd0338792007-03-07 22:28:00 +0300119} *boot_ec, *first_ec;
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400120
Alexey Starikovskiy5423a0c2009-02-21 12:18:13 -0500121static int EC_FLAGS_MSI; /* Out-of-spec MSI controller */
122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123/* --------------------------------------------------------------------------
124 Transaction Management
125 -------------------------------------------------------------------------- */
126
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400127static inline u8 acpi_ec_read_status(struct acpi_ec *ec)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128{
Márton Németh3ebe08a2007-11-21 03:23:26 +0300129 u8 x = inb(ec->command_addr);
Márton Németh86dae012008-01-23 22:33:06 -0500130 pr_debug(PREFIX "---> status = 0x%2.2x\n", x);
Márton Németh3ebe08a2007-11-21 03:23:26 +0300131 return x;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132}
133
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400134static inline u8 acpi_ec_read_data(struct acpi_ec *ec)
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400135{
Márton Németh3ebe08a2007-11-21 03:23:26 +0300136 u8 x = inb(ec->data_addr);
Márton Németh86dae012008-01-23 22:33:06 -0500137 pr_debug(PREFIX "---> data = 0x%2.2x\n", x);
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400138 return x;
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400139}
140
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400141static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command)
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400142{
Márton Németh86dae012008-01-23 22:33:06 -0500143 pr_debug(PREFIX "<--- command = 0x%2.2x\n", command);
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400144 outb(command, ec->command_addr);
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400145}
146
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400147static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data)
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400148{
Márton Németh86dae012008-01-23 22:33:06 -0500149 pr_debug(PREFIX "<--- data = 0x%2.2x\n", data);
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400150 outb(data, ec->data_addr);
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400151}
152
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400153static int ec_transaction_done(struct acpi_ec *ec)
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400154{
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400155 unsigned long flags;
156 int ret = 0;
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400157 spin_lock_irqsave(&ec->curr_lock, flags);
Alexey Starikovskiydd15f8c2008-11-08 21:42:30 +0300158 if (!ec->curr || ec->curr->done)
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400159 ret = 1;
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400160 spin_unlock_irqrestore(&ec->curr_lock, flags);
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400161 return ret;
162}
Denis M. Sadykov7c6db5e2006-09-26 19:50:33 +0400163
Alexey Starikovskiya2f93ae2008-11-12 01:40:19 +0300164static void start_transaction(struct acpi_ec *ec)
165{
166 ec->curr->irq_count = ec->curr->wi = ec->curr->ri = 0;
167 ec->curr->done = false;
168 acpi_ec_write_cmd(ec, ec->curr->command);
169}
170
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400171static void advance_transaction(struct acpi_ec *ec, u8 status)
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400172{
173 unsigned long flags;
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400174 spin_lock_irqsave(&ec->curr_lock, flags);
175 if (!ec->curr)
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400176 goto unlock;
Alexey Starikovskiya2f93ae2008-11-12 01:40:19 +0300177 if (ec->curr->wlen > ec->curr->wi) {
178 if ((status & ACPI_EC_FLAG_IBF) == 0)
179 acpi_ec_write_data(ec,
180 ec->curr->wdata[ec->curr->wi++]);
181 else
Alexey Starikovskiydd15f8c2008-11-08 21:42:30 +0300182 goto err;
Alexey Starikovskiya2f93ae2008-11-12 01:40:19 +0300183 } else if (ec->curr->rlen > ec->curr->ri) {
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400184 if ((status & ACPI_EC_FLAG_OBF) == 1) {
Alexey Starikovskiya2f93ae2008-11-12 01:40:19 +0300185 ec->curr->rdata[ec->curr->ri++] = acpi_ec_read_data(ec);
186 if (ec->curr->rlen == ec->curr->ri)
Alexey Starikovskiydd15f8c2008-11-08 21:42:30 +0300187 ec->curr->done = true;
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400188 } else
Alexey Starikovskiydd15f8c2008-11-08 21:42:30 +0300189 goto err;
Alexey Starikovskiya2f93ae2008-11-12 01:40:19 +0300190 } else if (ec->curr->wlen == ec->curr->wi &&
191 (status & ACPI_EC_FLAG_IBF) == 0)
Alexey Starikovskiydd15f8c2008-11-08 21:42:30 +0300192 ec->curr->done = true;
193 goto unlock;
194err:
195 /* false interrupt, state didn't change */
Alexey Starikovskiy7b4d4692008-11-13 12:00:03 +0300196 if (in_interrupt())
197 ++ec->curr->irq_count;
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400198unlock:
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400199 spin_unlock_irqrestore(&ec->curr_lock, flags);
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400200}
201
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400202static void acpi_ec_gpe_query(void *ec_cxt);
203
204static int ec_check_sci(struct acpi_ec *ec, u8 state)
205{
206 if (state & ACPI_EC_FLAG_SCI) {
207 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags))
208 return acpi_os_execute(OSL_EC_BURST_HANDLER,
209 acpi_ec_gpe_query, ec);
210 }
Denis M. Sadykov7c6db5e2006-09-26 19:50:33 +0400211 return 0;
212}
213
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400214static int ec_poll(struct acpi_ec *ec)
Alexey Starikovskiy845625c2008-03-21 17:07:03 +0300215{
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400216 unsigned long flags;
217 int repeat = 2; /* number of command restarts */
218 while (repeat--) {
219 unsigned long delay = jiffies +
220 msecs_to_jiffies(ACPI_EC_DELAY);
221 do {
222 /* don't sleep with disabled interrupts */
223 if (EC_FLAGS_MSI || irqs_disabled()) {
224 udelay(ACPI_EC_MSI_UDELAY);
225 if (ec_transaction_done(ec))
226 return 0;
227 } else {
228 if (wait_event_timeout(ec->wait,
229 ec_transaction_done(ec),
230 msecs_to_jiffies(1)))
231 return 0;
232 }
233 advance_transaction(ec, acpi_ec_read_status(ec));
234 } while (time_before(jiffies, delay));
235 if (!ec->curr->irq_count ||
236 (acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF))
237 break;
238 /* try restart command if we get any false interrupts */
239 pr_debug(PREFIX "controller reset, restart transaction\n");
240 spin_lock_irqsave(&ec->curr_lock, flags);
241 start_transaction(ec);
242 spin_unlock_irqrestore(&ec->curr_lock, flags);
Alexey Starikovskiyaf3fd142006-12-07 18:42:16 +0300243 }
Alexey Starikovskiyb77d81b2008-03-21 17:07:15 +0300244 return -ETIME;
Dmitry Torokhov451566f2005-03-19 01:10:05 -0500245}
246
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400247static int acpi_ec_transaction_unlocked(struct acpi_ec *ec,
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400248 struct transaction *t)
Lennart Poetteringd7a76e42006-09-05 12:12:24 -0400249{
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400250 unsigned long tmp;
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400251 int ret = 0;
Márton Németh3ebe08a2007-11-21 03:23:26 +0300252 pr_debug(PREFIX "transaction start\n");
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400253 /* disable GPE during transaction if storm is detected */
254 if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) {
Alexey Starikovskiy0b7084a2008-10-25 21:48:46 +0400255 acpi_disable_gpe(NULL, ec->gpe);
Denis M. Sadykov3576cf62006-09-26 19:50:33 +0400256 }
Alexey Starikovskiy5423a0c2009-02-21 12:18:13 -0500257 if (EC_FLAGS_MSI)
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400258 udelay(ACPI_EC_MSI_UDELAY);
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400259 /* start transaction */
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400260 spin_lock_irqsave(&ec->curr_lock, tmp);
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400261 /* following two actions should be kept atomic */
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400262 ec->curr = t;
Alexey Starikovskiya2f93ae2008-11-12 01:40:19 +0300263 start_transaction(ec);
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400264 if (ec->curr->command == ACPI_EC_COMMAND_QUERY)
Alexey Starikovskiy080e4122007-10-22 14:18:30 +0400265 clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400266 spin_unlock_irqrestore(&ec->curr_lock, tmp);
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400267 ret = ec_poll(ec);
Márton Németh3ebe08a2007-11-21 03:23:26 +0300268 pr_debug(PREFIX "transaction end\n");
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400269 spin_lock_irqsave(&ec->curr_lock, tmp);
270 ec->curr = NULL;
271 spin_unlock_irqrestore(&ec->curr_lock, tmp);
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400272 if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) {
273 /* check if we received SCI during transaction */
274 ec_check_sci(ec, acpi_ec_read_status(ec));
275 /* it is safe to enable GPE outside of transaction */
Alexey Starikovskiy0b7084a2008-10-25 21:48:46 +0400276 acpi_enable_gpe(NULL, ec->gpe);
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400277 } else if (t->irq_count > ACPI_EC_STORM_THRESHOLD) {
Alan Jenkinsf8248432008-11-01 11:05:26 +0000278 pr_info(PREFIX "GPE storm detected, "
279 "transactions will use polling mode\n");
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400280 set_bit(EC_FLAGS_GPE_STORM, &ec->flags);
281 }
282 return ret;
Lennart Poetteringd7a76e42006-09-05 12:12:24 -0400283}
284
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400285static int ec_check_ibf0(struct acpi_ec *ec)
286{
287 u8 status = acpi_ec_read_status(ec);
288 return (status & ACPI_EC_FLAG_IBF) == 0;
Lennart Poetteringd7a76e42006-09-05 12:12:24 -0400289}
290
Alexey Starikovskiyc0ff1772008-10-16 02:02:33 +0400291static int ec_wait_ibf0(struct acpi_ec *ec)
292{
293 unsigned long delay = jiffies + msecs_to_jiffies(ACPI_EC_DELAY);
294 /* interrupt wait manually if GPE mode is not active */
Alexey Starikovskiyc0ff1772008-10-16 02:02:33 +0400295 while (time_before(jiffies, delay))
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400296 if (wait_event_timeout(ec->wait, ec_check_ibf0(ec),
297 msecs_to_jiffies(1)))
Alexey Starikovskiyc0ff1772008-10-16 02:02:33 +0400298 return 0;
299 return -ETIME;
300}
301
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400302static int acpi_ec_transaction(struct acpi_ec *ec, struct transaction *t)
Luming Yu45bea152005-07-23 04:08:00 -0400303{
Lennart Poetteringd7a76e42006-09-05 12:12:24 -0400304 int status;
Len Brown50526df2005-08-11 17:32:05 -0400305 u32 glk;
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400306 if (!ec || (!t) || (t->wlen && !t->wdata) || (t->rlen && !t->rdata))
Patrick Mocheld550d982006-06-27 00:41:40 -0400307 return -EINVAL;
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400308 if (t->rdata)
309 memset(t->rdata, 0, t->rlen);
Alexey Starikovskiy523953b2006-12-07 18:42:17 +0300310 mutex_lock(&ec->lock);
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400311 if (ec->global_lock) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
Alexey Starikovskiyc24e9122007-02-15 23:16:18 +0300313 if (ACPI_FAILURE(status)) {
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400314 status = -ENODEV;
315 goto unlock;
Alexey Starikovskiyc24e9122007-02-15 23:16:18 +0300316 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 }
Alexey Starikovskiyc0ff1772008-10-16 02:02:33 +0400318 if (ec_wait_ibf0(ec)) {
Márton Németh3ebe08a2007-11-21 03:23:26 +0300319 pr_err(PREFIX "input buffer is not empty, "
320 "aborting transaction\n");
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400321 status = -ETIME;
Dmitry Torokhov451566f2005-03-19 01:10:05 -0500322 goto end;
Luming Yu716e0842005-08-10 01:40:00 -0400323 }
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400324 status = acpi_ec_transaction_unlocked(ec, t);
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400325end:
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400326 if (ec->global_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 acpi_release_global_lock(glk);
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400328unlock:
Alexey Starikovskiy523953b2006-12-07 18:42:17 +0300329 mutex_unlock(&ec->lock);
Patrick Mocheld550d982006-06-27 00:41:40 -0400330 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331}
332
Roel Kluin8a383ef2008-12-09 20:45:30 +0100333static int acpi_ec_burst_enable(struct acpi_ec *ec)
Alexey Starikovskiyc45aac42007-03-07 22:28:00 +0300334{
335 u8 d;
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400336 struct transaction t = {.command = ACPI_EC_BURST_ENABLE,
337 .wdata = NULL, .rdata = &d,
338 .wlen = 0, .rlen = 1};
339
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400340 return acpi_ec_transaction(ec, &t);
Alexey Starikovskiyc45aac42007-03-07 22:28:00 +0300341}
342
Roel Kluin8a383ef2008-12-09 20:45:30 +0100343static int acpi_ec_burst_disable(struct acpi_ec *ec)
Alexey Starikovskiyc45aac42007-03-07 22:28:00 +0300344{
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400345 struct transaction t = {.command = ACPI_EC_BURST_DISABLE,
346 .wdata = NULL, .rdata = NULL,
347 .wlen = 0, .rlen = 0};
348
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400349 return (acpi_ec_read_status(ec) & ACPI_EC_FLAG_BURST) ?
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400350 acpi_ec_transaction(ec, &t) : 0;
Alexey Starikovskiyc45aac42007-03-07 22:28:00 +0300351}
352
Alexey Starikovskiy6ccedb12006-12-07 18:42:17 +0300353static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 * data)
Denis M. Sadykov3576cf62006-09-26 19:50:33 +0400354{
355 int result;
356 u8 d;
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400357 struct transaction t = {.command = ACPI_EC_COMMAND_READ,
358 .wdata = &address, .rdata = &d,
359 .wlen = 1, .rlen = 1};
Denis M. Sadykov3576cf62006-09-26 19:50:33 +0400360
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400361 result = acpi_ec_transaction(ec, &t);
Denis M. Sadykov3576cf62006-09-26 19:50:33 +0400362 *data = d;
363 return result;
364}
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400365
Denis M. Sadykov3576cf62006-09-26 19:50:33 +0400366static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data)
367{
Alexey Starikovskiy6ccedb12006-12-07 18:42:17 +0300368 u8 wdata[2] = { address, data };
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400369 struct transaction t = {.command = ACPI_EC_COMMAND_WRITE,
370 .wdata = wdata, .rdata = NULL,
371 .wlen = 2, .rlen = 0};
372
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400373 return acpi_ec_transaction(ec, &t);
Denis M. Sadykov3576cf62006-09-26 19:50:33 +0400374}
375
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376/*
377 * Externally callable EC access functions. For now, assume 1 EC only
378 */
Alexey Starikovskiyc45aac42007-03-07 22:28:00 +0300379int ec_burst_enable(void)
380{
Alexey Starikovskiyc45aac42007-03-07 22:28:00 +0300381 if (!first_ec)
382 return -ENODEV;
Alexey Starikovskiyd0338792007-03-07 22:28:00 +0300383 return acpi_ec_burst_enable(first_ec);
Alexey Starikovskiyc45aac42007-03-07 22:28:00 +0300384}
385
386EXPORT_SYMBOL(ec_burst_enable);
387
388int ec_burst_disable(void)
389{
Alexey Starikovskiyc45aac42007-03-07 22:28:00 +0300390 if (!first_ec)
391 return -ENODEV;
Alexey Starikovskiyd0338792007-03-07 22:28:00 +0300392 return acpi_ec_burst_disable(first_ec);
Alexey Starikovskiyc45aac42007-03-07 22:28:00 +0300393}
394
395EXPORT_SYMBOL(ec_burst_disable);
396
Alexey Starikovskiy6ccedb12006-12-07 18:42:17 +0300397int ec_read(u8 addr, u8 * val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 int err;
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400400 u8 temp_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
402 if (!first_ec)
403 return -ENODEV;
404
Alexey Starikovskiyd0338792007-03-07 22:28:00 +0300405 err = acpi_ec_read(first_ec, addr, &temp_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
407 if (!err) {
408 *val = temp_data;
409 return 0;
Len Brown50526df2005-08-11 17:32:05 -0400410 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 return err;
412}
Len Brown50526df2005-08-11 17:32:05 -0400413
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414EXPORT_SYMBOL(ec_read);
415
Len Brown50526df2005-08-11 17:32:05 -0400416int ec_write(u8 addr, u8 val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 int err;
419
420 if (!first_ec)
421 return -ENODEV;
422
Alexey Starikovskiyd0338792007-03-07 22:28:00 +0300423 err = acpi_ec_write(first_ec, addr, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
425 return err;
426}
Len Brown50526df2005-08-11 17:32:05 -0400427
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428EXPORT_SYMBOL(ec_write);
429
Randy Dunlap616362d2006-10-27 01:47:34 -0400430int ec_transaction(u8 command,
Alexey Starikovskiy9e197212007-03-07 18:29:35 -0500431 const u8 * wdata, unsigned wdata_len,
Lennart Poettering00eb43a2007-05-04 14:16:19 +0200432 u8 * rdata, unsigned rdata_len,
433 int force_poll)
Luming Yu45bea152005-07-23 04:08:00 -0400434{
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400435 struct transaction t = {.command = command,
436 .wdata = wdata, .rdata = rdata,
437 .wlen = wdata_len, .rlen = rdata_len};
Lennart Poetteringd7a76e42006-09-05 12:12:24 -0400438 if (!first_ec)
439 return -ENODEV;
440
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400441 return acpi_ec_transaction(first_ec, &t);
Luming Yu45bea152005-07-23 04:08:00 -0400442}
Luming Yu45bea152005-07-23 04:08:00 -0400443
Lennart Poetteringab9e43c2006-10-03 22:49:00 -0400444EXPORT_SYMBOL(ec_transaction);
445
Alexey Starikovskiy6ccedb12006-12-07 18:42:17 +0300446static int acpi_ec_query(struct acpi_ec *ec, u8 * data)
Denis M. Sadykov3576cf62006-09-26 19:50:33 +0400447{
448 int result;
Alexey Starikovskiy6ccedb12006-12-07 18:42:17 +0300449 u8 d;
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400450 struct transaction t = {.command = ACPI_EC_COMMAND_QUERY,
451 .wdata = NULL, .rdata = &d,
452 .wlen = 0, .rlen = 1};
Alexey Starikovskiy6ccedb12006-12-07 18:42:17 +0300453 if (!ec || !data)
454 return -EINVAL;
Luming Yu45bea152005-07-23 04:08:00 -0400455
Alexey Starikovskiy6ccedb12006-12-07 18:42:17 +0300456 /*
457 * Query the EC to find out which _Qxx method we need to evaluate.
458 * Note that successful completion of the query causes the ACPI_EC_SCI
459 * bit to be cleared (and thus clearing the interrupt source).
460 */
Luming Yu45bea152005-07-23 04:08:00 -0400461
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400462 result = acpi_ec_transaction(ec, &t);
Alexey Starikovskiy6ccedb12006-12-07 18:42:17 +0300463 if (result)
464 return result;
Luming Yu45bea152005-07-23 04:08:00 -0400465
Alexey Starikovskiy6ccedb12006-12-07 18:42:17 +0300466 if (!d)
467 return -ENODATA;
Luming Yu45bea152005-07-23 04:08:00 -0400468
Alexey Starikovskiy6ccedb12006-12-07 18:42:17 +0300469 *data = d;
470 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471}
472
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473/* --------------------------------------------------------------------------
474 Event Management
475 -------------------------------------------------------------------------- */
Alexey Starikovskiy837012e2007-05-29 16:43:02 +0400476int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit,
477 acpi_handle handle, acpi_ec_query_func func,
478 void *data)
479{
480 struct acpi_ec_query_handler *handler =
481 kzalloc(sizeof(struct acpi_ec_query_handler), GFP_KERNEL);
482 if (!handler)
483 return -ENOMEM;
484
485 handler->query_bit = query_bit;
486 handler->handle = handle;
487 handler->func = func;
488 handler->data = data;
489 mutex_lock(&ec->lock);
Alexey Starikovskiy30c08572007-09-26 19:43:22 +0400490 list_add(&handler->node, &ec->list);
Alexey Starikovskiy837012e2007-05-29 16:43:02 +0400491 mutex_unlock(&ec->lock);
492 return 0;
493}
494
495EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler);
496
497void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit)
498{
Adrian Bunk1544fdb2007-10-24 18:26:00 +0200499 struct acpi_ec_query_handler *handler, *tmp;
Alexey Starikovskiy837012e2007-05-29 16:43:02 +0400500 mutex_lock(&ec->lock);
Adrian Bunk1544fdb2007-10-24 18:26:00 +0200501 list_for_each_entry_safe(handler, tmp, &ec->list, node) {
Alexey Starikovskiy837012e2007-05-29 16:43:02 +0400502 if (query_bit == handler->query_bit) {
503 list_del(&handler->node);
504 kfree(handler);
Alexey Starikovskiy837012e2007-05-29 16:43:02 +0400505 }
506 }
507 mutex_unlock(&ec->lock);
508}
509
510EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
Len Brown50526df2005-08-11 17:32:05 -0400512static void acpi_ec_gpe_query(void *ec_cxt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513{
Alexey Starikovskiy3d02b902007-03-07 22:28:00 +0300514 struct acpi_ec *ec = ec_cxt;
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400515 u8 value = 0;
Alexey Starikovskiy837012e2007-05-29 16:43:02 +0400516 struct acpi_ec_query_handler *handler, copy;
Luming Yu45bea152005-07-23 04:08:00 -0400517
Alexey Starikovskiy5d0c2882006-12-07 18:42:16 +0300518 if (!ec || acpi_ec_query(ec, &value))
Alexey Starikovskiye41334c2006-12-07 18:42:16 +0300519 return;
Alexey Starikovskiy837012e2007-05-29 16:43:02 +0400520 mutex_lock(&ec->lock);
521 list_for_each_entry(handler, &ec->list, node) {
522 if (value == handler->query_bit) {
523 /* have custom handler for this bit */
524 memcpy(&copy, handler, sizeof(copy));
525 mutex_unlock(&ec->lock);
526 if (copy.func) {
527 copy.func(copy.data);
528 } else if (copy.handle) {
529 acpi_evaluate_object(copy.handle, NULL, NULL, NULL);
530 }
531 return;
532 }
533 }
534 mutex_unlock(&ec->lock);
Luming Yu45bea152005-07-23 04:08:00 -0400535}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536
Len Brown50526df2005-08-11 17:32:05 -0400537static u32 acpi_ec_gpe_handler(void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538{
Alexey Starikovskiy3d02b902007-03-07 22:28:00 +0300539 struct acpi_ec *ec = data;
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400540 u8 status;
Lennart Poettering00eb43a2007-05-04 14:16:19 +0200541
Márton Németh3ebe08a2007-11-21 03:23:26 +0300542 pr_debug(PREFIX "~~~> interrupt\n");
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400543 status = acpi_ec_read_status(ec);
544
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400545 advance_transaction(ec, status);
546 if (ec_transaction_done(ec) && (status & ACPI_EC_FLAG_IBF) == 0)
547 wake_up(&ec->wait);
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400548 ec_check_sci(ec, status);
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400549 return ACPI_INTERRUPT_HANDLED;
Alexey Starikovskiy845625c2008-03-21 17:07:03 +0300550}
551
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552/* --------------------------------------------------------------------------
553 Address Space Management
554 -------------------------------------------------------------------------- */
555
556static acpi_status
Alexey Starikovskiy5b7734b2007-05-29 16:42:52 +0400557acpi_ec_space_handler(u32 function, acpi_physical_address address,
558 u32 bits, acpi_integer *value,
Len Brown50526df2005-08-11 17:32:05 -0400559 void *handler_context, void *region_context)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560{
Alexey Starikovskiy3d02b902007-03-07 22:28:00 +0300561 struct acpi_ec *ec = handler_context;
Alexey Starikovskiy3e71a872008-01-11 02:42:51 +0300562 int result = 0, i;
Alexey Starikovskiy5b7734b2007-05-29 16:42:52 +0400563 u8 temp = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 if ((address > 0xFF) || !value || !handler_context)
Patrick Mocheld550d982006-06-27 00:41:40 -0400566 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
Alexey Starikovskiy5b7734b2007-05-29 16:42:52 +0400568 if (function != ACPI_READ && function != ACPI_WRITE)
Patrick Mocheld550d982006-06-27 00:41:40 -0400569 return AE_BAD_PARAMETER;
Alexey Starikovskiy5b7734b2007-05-29 16:42:52 +0400570
571 if (bits != 8 && acpi_strict)
572 return AE_BAD_PARAMETER;
573
Alexey Starikovskiy6a63b06f2009-08-28 23:29:44 +0400574 if (EC_FLAGS_MSI)
575 acpi_ec_burst_enable(ec);
Alexey Starikovskiyb3b233c2008-01-11 02:42:57 +0300576
Alexey Starikovskiy3e71a872008-01-11 02:42:51 +0300577 if (function == ACPI_READ) {
578 result = acpi_ec_read(ec, address, &temp);
579 *value = temp;
580 } else {
581 temp = 0xff & (*value);
582 result = acpi_ec_write(ec, address, temp);
583 }
584
585 for (i = 8; unlikely(bits - i > 0); i += 8) {
586 ++address;
Alexey Starikovskiy5b7734b2007-05-29 16:42:52 +0400587 if (function == ACPI_READ) {
588 result = acpi_ec_read(ec, address, &temp);
589 (*value) |= ((acpi_integer)temp) << i;
590 } else {
591 temp = 0xff & ((*value) >> i);
592 result = acpi_ec_write(ec, address, temp);
593 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 }
595
Alexey Starikovskiy6a63b06f2009-08-28 23:29:44 +0400596 if (EC_FLAGS_MSI)
597 acpi_ec_burst_disable(ec);
Alexey Starikovskiyb3b233c2008-01-11 02:42:57 +0300598
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 switch (result) {
600 case -EINVAL:
Patrick Mocheld550d982006-06-27 00:41:40 -0400601 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 break;
603 case -ENODEV:
Patrick Mocheld550d982006-06-27 00:41:40 -0400604 return AE_NOT_FOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 break;
606 case -ETIME:
Patrick Mocheld550d982006-06-27 00:41:40 -0400607 return AE_TIME;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 break;
609 default:
Patrick Mocheld550d982006-06-27 00:41:40 -0400610 return AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612}
613
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614/* --------------------------------------------------------------------------
615 FS Interface (/proc)
616 -------------------------------------------------------------------------- */
617
Len Brown50526df2005-08-11 17:32:05 -0400618static struct proc_dir_entry *acpi_ec_dir;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
Len Brown50526df2005-08-11 17:32:05 -0400620static int acpi_ec_read_info(struct seq_file *seq, void *offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621{
Alexey Starikovskiy3d02b902007-03-07 22:28:00 +0300622 struct acpi_ec *ec = seq->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 if (!ec)
625 goto end;
626
Alexey Starikovskiy01f22462007-03-07 22:28:00 +0300627 seq_printf(seq, "gpe:\t\t\t0x%02x\n", (u32) ec->gpe);
628 seq_printf(seq, "ports:\t\t\t0x%02x, 0x%02x\n",
629 (unsigned)ec->command_addr, (unsigned)ec->data_addr);
630 seq_printf(seq, "use global lock:\t%s\n",
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400631 ec->global_lock ? "yes" : "no");
Len Brown50526df2005-08-11 17:32:05 -0400632 end:
Patrick Mocheld550d982006-06-27 00:41:40 -0400633 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634}
635
636static int acpi_ec_info_open_fs(struct inode *inode, struct file *file)
637{
638 return single_open(file, acpi_ec_read_info, PDE(inode)->data);
639}
640
Jan Engelhardt070d8eb2009-01-12 00:07:55 +0100641static const struct file_operations acpi_ec_info_ops = {
Len Brown50526df2005-08-11 17:32:05 -0400642 .open = acpi_ec_info_open_fs,
643 .read = seq_read,
644 .llseek = seq_lseek,
645 .release = single_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 .owner = THIS_MODULE,
647};
648
Len Brown50526df2005-08-11 17:32:05 -0400649static int acpi_ec_add_fs(struct acpi_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650{
Len Brown50526df2005-08-11 17:32:05 -0400651 struct proc_dir_entry *entry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 if (!acpi_device_dir(device)) {
654 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
Len Brown50526df2005-08-11 17:32:05 -0400655 acpi_ec_dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 if (!acpi_device_dir(device))
Patrick Mocheld550d982006-06-27 00:41:40 -0400657 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 }
659
Denis V. Lunevcf7acfa2008-04-29 01:02:27 -0700660 entry = proc_create_data(ACPI_EC_FILE_INFO, S_IRUGO,
661 acpi_device_dir(device),
662 &acpi_ec_info_ops, acpi_driver_data(device));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 if (!entry)
Patrick Mocheld550d982006-06-27 00:41:40 -0400664 return -ENODEV;
Patrick Mocheld550d982006-06-27 00:41:40 -0400665 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666}
667
Len Brown50526df2005-08-11 17:32:05 -0400668static int acpi_ec_remove_fs(struct acpi_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670
671 if (acpi_device_dir(device)) {
672 remove_proc_entry(ACPI_EC_FILE_INFO, acpi_device_dir(device));
673 remove_proc_entry(acpi_device_bid(device), acpi_ec_dir);
674 acpi_device_dir(device) = NULL;
675 }
676
Patrick Mocheld550d982006-06-27 00:41:40 -0400677 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678}
679
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680/* --------------------------------------------------------------------------
681 Driver Interface
682 -------------------------------------------------------------------------- */
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +0300683static acpi_status
684ec_parse_io_ports(struct acpi_resource *resource, void *context);
685
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +0300686static struct acpi_ec *make_acpi_ec(void)
687{
688 struct acpi_ec *ec = kzalloc(sizeof(struct acpi_ec), GFP_KERNEL);
689 if (!ec)
690 return NULL;
Alexey Starikovskiy080e4122007-10-22 14:18:30 +0400691 ec->flags = 1 << EC_FLAGS_QUERY_PENDING;
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +0300692 mutex_init(&ec->lock);
693 init_waitqueue_head(&ec->wait);
Alexey Starikovskiy837012e2007-05-29 16:43:02 +0400694 INIT_LIST_HEAD(&ec->list);
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400695 spin_lock_init(&ec->curr_lock);
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +0300696 return ec;
697}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698
Alexey Starikovskiy837012e2007-05-29 16:43:02 +0400699static acpi_status
Alexey Starikovskiyc019b192007-08-14 01:03:42 -0400700acpi_ec_register_query_methods(acpi_handle handle, u32 level,
701 void *context, void **return_value)
702{
Lin Ming0175d562008-12-16 16:46:12 +0800703 char node_name[5];
704 struct acpi_buffer buffer = { sizeof(node_name), node_name };
Alexey Starikovskiyc019b192007-08-14 01:03:42 -0400705 struct acpi_ec *ec = context;
706 int value = 0;
Lin Ming0175d562008-12-16 16:46:12 +0800707 acpi_status status;
708
709 status = acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer);
710
711 if (ACPI_SUCCESS(status) && sscanf(node_name, "_Q%x", &value) == 1) {
Alexey Starikovskiyc019b192007-08-14 01:03:42 -0400712 acpi_ec_add_query_handler(ec, value, handle, NULL, NULL);
713 }
714 return AE_OK;
715}
716
717static acpi_status
Alexey Starikovskiycd8c93a2007-08-03 17:52:48 -0400718ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval)
Alexey Starikovskiy837012e2007-05-29 16:43:02 +0400719{
Alexey Starikovskiycd8c93a2007-08-03 17:52:48 -0400720 acpi_status status;
Alexey Starikovskiyd21cf3c2008-11-03 14:26:40 -0500721 unsigned long long tmp = 0;
Alexey Starikovskiycd8c93a2007-08-03 17:52:48 -0400722
723 struct acpi_ec *ec = context;
Alexey Starikovskiya5032bf2009-04-01 01:33:15 -0400724
725 /* clear addr values, ec_parse_io_ports depend on it */
726 ec->command_addr = ec->data_addr = 0;
727
Alexey Starikovskiycd8c93a2007-08-03 17:52:48 -0400728 status = acpi_walk_resources(handle, METHOD_NAME__CRS,
729 ec_parse_io_ports, ec);
730 if (ACPI_FAILURE(status))
731 return status;
Alexey Starikovskiy837012e2007-05-29 16:43:02 +0400732
733 /* Get GPE bit assignment (EC events). */
734 /* TODO: Add support for _GPE returning a package */
Matthew Wilcox27663c52008-10-10 02:22:59 -0400735 status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp);
Alexey Starikovskiycd8c93a2007-08-03 17:52:48 -0400736 if (ACPI_FAILURE(status))
737 return status;
Matthew Wilcox27663c52008-10-10 02:22:59 -0400738 ec->gpe = tmp;
Alexey Starikovskiy837012e2007-05-29 16:43:02 +0400739 /* Use the global lock for all EC transactions? */
Alexey Starikovskiyd21cf3c2008-11-03 14:26:40 -0500740 tmp = 0;
Matthew Wilcox27663c52008-10-10 02:22:59 -0400741 acpi_evaluate_integer(handle, "_GLK", NULL, &tmp);
742 ec->global_lock = tmp;
Alexey Starikovskiy837012e2007-05-29 16:43:02 +0400743 ec->handle = handle;
Alexey Starikovskiycd8c93a2007-08-03 17:52:48 -0400744 return AE_CTRL_TERMINATE;
Alexey Starikovskiy837012e2007-05-29 16:43:02 +0400745}
746
Alexey Starikovskiye8284322007-03-07 22:28:00 +0300747static int ec_install_handlers(struct acpi_ec *ec)
748{
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +0300749 acpi_status status;
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400750 if (test_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags))
Alexey Starikovskiy4c611062007-09-05 19:56:38 -0400751 return 0;
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +0300752 status = acpi_install_gpe_handler(NULL, ec->gpe,
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400753 ACPI_GPE_EDGE_TRIGGERED,
754 &acpi_ec_gpe_handler, ec);
Alexey Starikovskiye8284322007-03-07 22:28:00 +0300755 if (ACPI_FAILURE(status))
756 return -ENODEV;
757 acpi_set_gpe_type(NULL, ec->gpe, ACPI_GPE_TYPE_RUNTIME);
Alexey Starikovskiy0b7084a2008-10-25 21:48:46 +0400758 acpi_enable_gpe(NULL, ec->gpe);
Alexey Starikovskiye8284322007-03-07 22:28:00 +0300759 status = acpi_install_address_space_handler(ec->handle,
760 ACPI_ADR_SPACE_EC,
761 &acpi_ec_space_handler,
Alexey Starikovskiy6d9e1122008-03-24 23:22:29 +0300762 NULL, ec);
Alexey Starikovskiye8284322007-03-07 22:28:00 +0300763 if (ACPI_FAILURE(status)) {
Zhao Yakui20edd742008-10-17 02:02:44 -0400764 if (status == AE_NOT_FOUND) {
765 /*
766 * Maybe OS fails in evaluating the _REG object.
767 * The AE_NOT_FOUND error will be ignored and OS
768 * continue to initialize EC.
769 */
770 printk(KERN_ERR "Fail in evaluating the _REG object"
771 " of EC device. Broken bios is suspected.\n");
772 } else {
773 acpi_remove_gpe_handler(NULL, ec->gpe,
774 &acpi_ec_gpe_handler);
775 return -ENODEV;
776 }
Alexey Starikovskiye8284322007-03-07 22:28:00 +0300777 }
778
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400779 set_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags);
Alexey Starikovskiye8284322007-03-07 22:28:00 +0300780 return 0;
781}
782
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783static void ec_remove_handlers(struct acpi_ec *ec)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle,
786 ACPI_ADR_SPACE_EC, &acpi_ec_space_handler)))
787 pr_err(PREFIX "failed to remove space handler\n");
788 if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe,
789 &acpi_ec_gpe_handler)))
790 pr_err(PREFIX "failed to remove gpe handler\n");
791 clear_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags);
792}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794static int acpi_ec_add(struct acpi_device *device)
795{
796 struct acpi_ec *ec = NULL;
Bjorn Helgaasd02be042009-06-22 20:41:35 +0000797 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
800 strcpy(acpi_device_class(device), ACPI_EC_CLASS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 /* Check for boot EC */
803 if (boot_ec &&
804 (boot_ec->handle == device->handle ||
805 boot_ec->handle == ACPI_ROOT_OBJECT)) {
806 ec = boot_ec;
807 boot_ec = NULL;
808 } else {
809 ec = make_acpi_ec();
810 if (!ec)
811 return -ENOMEM;
812 }
813 if (ec_parse_device(device->handle, 0, ec, NULL) !=
814 AE_CTRL_TERMINATE) {
815 kfree(ec);
816 return -EINVAL;
817 }
818
819 ec->handle = device->handle;
820
821 /* Find and register all query methods */
822 acpi_walk_namespace(ACPI_TYPE_METHOD, ec->handle, 1,
823 acpi_ec_register_query_methods, ec, NULL);
824
825 if (!first_ec)
826 first_ec = ec;
827 device->driver_data = ec;
828 acpi_ec_add_fs(device);
829 pr_info(PREFIX "GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n",
830 ec->gpe, ec->command_addr, ec->data_addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831
Alexey Starikovskiy4c611062007-09-05 19:56:38 -0400832 ret = ec_install_handlers(ec);
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +0300833
Alexey Starikovskiy837012e2007-05-29 16:43:02 +0400834 /* EC is fully operational, allow queries */
Alexey Starikovskiy080e4122007-10-22 14:18:30 +0400835 clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
Alexey Starikovskiy837012e2007-05-29 16:43:02 +0400836 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837}
838
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839static int acpi_ec_remove(struct acpi_device *device, int type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840{
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +0300841 struct acpi_ec *ec;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 struct acpi_ec_query_handler *handler, *tmp;
843
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 if (!device)
Patrick Mocheld550d982006-06-27 00:41:40 -0400845 return -EINVAL;
Alexey Starikovskiyf9319f92007-08-24 08:10:11 +0400846
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 ec = acpi_driver_data(device);
Bjorn Helgaascf745ec2009-06-22 20:41:40 +0000848 ec_remove_handlers(ec);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 mutex_lock(&ec->lock);
850 list_for_each_entry_safe(handler, tmp, &ec->list, node) {
851 list_del(&handler->node);
852 kfree(handler);
853 }
854 mutex_unlock(&ec->lock);
855 acpi_ec_remove_fs(device);
856 device->driver_data = NULL;
857 if (ec == first_ec)
858 first_ec = NULL;
859 kfree(ec);
Patrick Mocheld550d982006-06-27 00:41:40 -0400860 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861}
862
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863static acpi_status
864ec_parse_io_ports(struct acpi_resource *resource, void *context)
865{
866 struct acpi_ec *ec = context;
867
868 if (resource->type != ACPI_RESOURCE_TYPE_IO)
869 return AE_OK;
870
871 /*
872 * The first address region returned is the data port, and
873 * the second address region returned is the status/command
874 * port.
875 */
876 if (ec->data_addr == 0)
877 ec->data_addr = resource->data.io.minimum;
878 else if (ec->command_addr == 0)
879 ec->command_addr = resource->data.io.minimum;
880 else
881 return AE_CTRL_TERMINATE;
882
883 return AE_OK;
884}
885
Alexey Starikovskiyc04209a2008-01-01 14:12:55 -0500886int __init acpi_boot_ec_enable(void)
887{
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400888 if (!boot_ec || test_bit(EC_FLAGS_HANDLERS_INSTALLED, &boot_ec->flags))
Alexey Starikovskiyc04209a2008-01-01 14:12:55 -0500889 return 0;
890 if (!ec_install_handlers(boot_ec)) {
891 first_ec = boot_ec;
892 return 0;
893 }
894 return -EFAULT;
895}
896
Alexey Starikovskiy223883b2008-03-21 17:07:21 +0300897static const struct acpi_device_id ec_device_ids[] = {
898 {"PNP0C09", 0},
899 {"", 0},
900};
901
Len Brown50526df2005-08-11 17:32:05 -0400902int __init acpi_ec_ecdt_probe(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903{
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +0300904 acpi_status status;
Alexey Starikovskiyc6cb0e82009-01-14 02:57:53 +0300905 struct acpi_ec *saved_ec = NULL;
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +0300906 struct acpi_table_ecdt *ecdt_ptr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907
Alexey Starikovskiyd66d9692007-03-07 22:28:00 +0300908 boot_ec = make_acpi_ec();
909 if (!boot_ec)
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +0300910 return -ENOMEM;
911 /*
912 * Generate a boot ec context
913 */
Alexey Starikovskiy5423a0c2009-02-21 12:18:13 -0500914 if (dmi_name_in_vendors("Micro-Star") ||
915 dmi_name_in_vendors("Notebook")) {
916 pr_info(PREFIX "Enabling special treatment for EC from MSI.\n");
917 EC_FLAGS_MSI = 1;
918 }
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +0300919 status = acpi_get_table(ACPI_SIG_ECDT, 1,
920 (struct acpi_table_header **)&ecdt_ptr);
Alexey Starikovskiycd8c93a2007-08-03 17:52:48 -0400921 if (ACPI_SUCCESS(status)) {
Márton Németh3ebe08a2007-11-21 03:23:26 +0300922 pr_info(PREFIX "EC description table is found, configuring boot EC\n");
Alexey Starikovskiycd8c93a2007-08-03 17:52:48 -0400923 boot_ec->command_addr = ecdt_ptr->control.address;
924 boot_ec->data_addr = ecdt_ptr->data.address;
925 boot_ec->gpe = ecdt_ptr->gpe;
Len Brown4af8e102008-03-11 00:27:16 -0400926 boot_ec->handle = ACPI_ROOT_OBJECT;
Alexey Starikovskiyce52ddf2008-03-24 23:22:36 +0300927 acpi_get_handle(ACPI_ROOT_OBJECT, ecdt_ptr->id, &boot_ec->handle);
Alexey Starikovskiyc6cb0e82009-01-14 02:57:53 +0300928 /* Don't trust ECDT, which comes from ASUSTek */
Alexey Starikovskiya5032bf2009-04-01 01:33:15 -0400929 if (!dmi_name_in_vendors("ASUS") && EC_FLAGS_MSI == 0)
Alexey Starikovskiyc5279de2008-11-26 17:11:53 -0500930 goto install;
Alexey Starikovskiyc6cb0e82009-01-14 02:57:53 +0300931 saved_ec = kmalloc(sizeof(struct acpi_ec), GFP_KERNEL);
932 if (!saved_ec)
933 return -ENOMEM;
Alexey Starikovskiya5032bf2009-04-01 01:33:15 -0400934 memcpy(saved_ec, boot_ec, sizeof(struct acpi_ec));
Alexey Starikovskiyc5279de2008-11-26 17:11:53 -0500935 /* fall through */
Alexey Starikovskiycd8c93a2007-08-03 17:52:48 -0400936 }
Alexey Starikovskiyc5279de2008-11-26 17:11:53 -0500937 /* This workaround is needed only on some broken machines,
938 * which require early EC, but fail to provide ECDT */
Alexey Starikovskiyc5279de2008-11-26 17:11:53 -0500939 printk(KERN_DEBUG PREFIX "Look up EC in DSDT\n");
940 status = acpi_get_devices(ec_device_ids[0].id, ec_parse_device,
941 boot_ec, NULL);
942 /* Check that acpi_get_devices actually find something */
943 if (ACPI_FAILURE(status) || !boot_ec->handle)
944 goto error;
Alexey Starikovskiyc6cb0e82009-01-14 02:57:53 +0300945 if (saved_ec) {
946 /* try to find good ECDT from ASUSTek */
947 if (saved_ec->command_addr != boot_ec->command_addr ||
948 saved_ec->data_addr != boot_ec->data_addr ||
949 saved_ec->gpe != boot_ec->gpe ||
950 saved_ec->handle != boot_ec->handle)
951 pr_info(PREFIX "ASUSTek keeps feeding us with broken "
952 "ECDT tables, which are very hard to workaround. "
953 "Trying to use DSDT EC info instead. Please send "
954 "output of acpidump to linux-acpi@vger.kernel.org\n");
955 kfree(saved_ec);
956 saved_ec = NULL;
957 } else {
958 /* We really need to limit this workaround, the only ASUS,
959 * which needs it, has fake EC._INI method, so use it as flag.
960 * Keep boot_ec struct as it will be needed soon.
961 */
962 acpi_handle dummy;
963 if (!dmi_name_in_vendors("ASUS") ||
964 ACPI_FAILURE(acpi_get_handle(boot_ec->handle, "_INI",
965 &dummy)))
966 return -ENODEV;
967 }
Alexey Starikovskiyc5279de2008-11-26 17:11:53 -0500968install:
969 if (!ec_install_handlers(boot_ec)) {
Alexey Starikovskiyd0338792007-03-07 22:28:00 +0300970 first_ec = boot_ec;
Alexey Starikovskiye8284322007-03-07 22:28:00 +0300971 return 0;
Alexey Starikovskiyd0338792007-03-07 22:28:00 +0300972 }
Alexey Starikovskiyc5279de2008-11-26 17:11:53 -0500973error:
Alexey Starikovskiyd66d9692007-03-07 22:28:00 +0300974 kfree(boot_ec);
975 boot_ec = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 return -ENODEV;
977}
978
Alexey Starikovskiy223883b2008-03-21 17:07:21 +0300979static int acpi_ec_suspend(struct acpi_device *device, pm_message_t state)
980{
981 struct acpi_ec *ec = acpi_driver_data(device);
982 /* Stop using GPE */
Alexey Starikovskiy0b7084a2008-10-25 21:48:46 +0400983 acpi_disable_gpe(NULL, ec->gpe);
Alexey Starikovskiy223883b2008-03-21 17:07:21 +0300984 return 0;
985}
986
987static int acpi_ec_resume(struct acpi_device *device)
988{
989 struct acpi_ec *ec = acpi_driver_data(device);
990 /* Enable use of GPE back */
Alexey Starikovskiy0b7084a2008-10-25 21:48:46 +0400991 acpi_enable_gpe(NULL, ec->gpe);
Alexey Starikovskiy223883b2008-03-21 17:07:21 +0300992 return 0;
993}
994
995static struct acpi_driver acpi_ec_driver = {
996 .name = "ec",
997 .class = ACPI_EC_CLASS,
998 .ids = ec_device_ids,
999 .ops = {
1000 .add = acpi_ec_add,
1001 .remove = acpi_ec_remove,
Alexey Starikovskiy223883b2008-03-21 17:07:21 +03001002 .suspend = acpi_ec_suspend,
1003 .resume = acpi_ec_resume,
1004 },
1005};
1006
Bjorn Helgaasa5f820f2009-03-24 16:49:48 -06001007int __init acpi_ec_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008{
Len Brown50526df2005-08-11 17:32:05 -04001009 int result = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 acpi_ec_dir = proc_mkdir(ACPI_EC_CLASS, acpi_root_dir);
1012 if (!acpi_ec_dir)
Patrick Mocheld550d982006-06-27 00:41:40 -04001013 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014
1015 /* Now register the driver for the EC */
1016 result = acpi_bus_register_driver(&acpi_ec_driver);
1017 if (result < 0) {
1018 remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
Patrick Mocheld550d982006-06-27 00:41:40 -04001019 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 }
1021
Patrick Mocheld550d982006-06-27 00:41:40 -04001022 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023}
1024
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025/* EC driver currently not unloadable */
1026#if 0
Len Brown50526df2005-08-11 17:32:05 -04001027static void __exit acpi_ec_exit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029
1030 acpi_bus_unregister_driver(&acpi_ec_driver);
1031
1032 remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
1033
Patrick Mocheld550d982006-06-27 00:41:40 -04001034 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035}
Alexey Starikovskiy78439322007-10-22 14:18:43 +04001036#endif /* 0 */