Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
7c6db4e0 | 2 | * ec.c - ACPI Embedded Controller Driver (v2.1) |
1da177e4 | 3 | * |
7c6db4e0 | 4 | * Copyright (C) 2006-2008 Alexey Starikovskiy <astarikovskiy@suse.de> |
01f22462 | 5 | * Copyright (C) 2006 Denis Sadykov <denis.m.sadykov@intel.com> |
1da177e4 LT |
6 | * 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 | ||
7c6db4e0 | 29 | /* Uncomment next line to get verbose printout */ |
d772b3b3 | 30 | /* #define DEBUG */ |
16a26e85 | 31 | #define pr_fmt(fmt) "ACPI : EC: " fmt |
d772b3b3 | 32 | |
1da177e4 LT |
33 | #include <linux/kernel.h> |
34 | #include <linux/module.h> | |
35 | #include <linux/init.h> | |
36 | #include <linux/types.h> | |
37 | #include <linux/delay.h> | |
451566f4 | 38 | #include <linux/interrupt.h> |
837012ed | 39 | #include <linux/list.h> |
7c6db4e0 | 40 | #include <linux/spinlock.h> |
5a0e3ad6 | 41 | #include <linux/slab.h> |
8b48463f | 42 | #include <linux/acpi.h> |
eb27cae8 | 43 | #include <linux/dmi.h> |
8b48463f | 44 | #include <asm/io.h> |
1da177e4 | 45 | |
1195a098 TR |
46 | #include "internal.h" |
47 | ||
1da177e4 | 48 | #define ACPI_EC_CLASS "embedded_controller" |
1da177e4 LT |
49 | #define ACPI_EC_DEVICE_NAME "Embedded Controller" |
50 | #define ACPI_EC_FILE_INFO "info" | |
837012ed | 51 | |
703959d4 | 52 | /* EC status register */ |
1da177e4 LT |
53 | #define ACPI_EC_FLAG_OBF 0x01 /* Output buffer full */ |
54 | #define ACPI_EC_FLAG_IBF 0x02 /* Input buffer full */ | |
451566f4 | 55 | #define ACPI_EC_FLAG_BURST 0x10 /* burst mode */ |
1da177e4 | 56 | #define ACPI_EC_FLAG_SCI 0x20 /* EC-SCI occurred */ |
4350933a | 57 | |
703959d4 | 58 | /* EC commands */ |
3261ff4d | 59 | enum ec_command { |
6ccedb10 AS |
60 | ACPI_EC_COMMAND_READ = 0x80, |
61 | ACPI_EC_COMMAND_WRITE = 0x81, | |
62 | ACPI_EC_BURST_ENABLE = 0x82, | |
63 | ACPI_EC_BURST_DISABLE = 0x83, | |
64 | ACPI_EC_COMMAND_QUERY = 0x84, | |
3261ff4d | 65 | }; |
837012ed | 66 | |
5c406412 | 67 | #define ACPI_EC_DELAY 500 /* Wait 500ms max. during EC ops */ |
703959d4 | 68 | #define ACPI_EC_UDELAY_GLK 1000 /* Wait 1ms max. to get global lock */ |
2a84cb98 | 69 | #define ACPI_EC_MSI_UDELAY 550 /* Wait 550us for MSI EC */ |
ad332c8a KC |
70 | #define ACPI_EC_CLEAR_MAX 100 /* Maximum number of events to query |
71 | * when trying to clear the EC */ | |
703959d4 | 72 | |
080e412c | 73 | enum { |
080e412c | 74 | EC_FLAGS_QUERY_PENDING, /* Query is pending */ |
7c6db4e0 | 75 | EC_FLAGS_GPE_STORM, /* GPE storm detected */ |
f6bb13aa | 76 | EC_FLAGS_HANDLERS_INSTALLED, /* Handlers for GPE and |
7c6db4e0 | 77 | * OpReg are installed */ |
fe955682 | 78 | EC_FLAGS_BLOCKED, /* Transactions are blocked */ |
1da177e4 | 79 | }; |
6ffb221a | 80 | |
7a18e96d TR |
81 | /* ec.c is compiled in acpi namespace so this shows up as acpi.ec_delay param */ |
82 | static unsigned int ec_delay __read_mostly = ACPI_EC_DELAY; | |
83 | module_param(ec_delay, uint, 0644); | |
84 | MODULE_PARM_DESC(ec_delay, "Timeout(ms) waited until an EC command completes"); | |
85 | ||
a520d52e FT |
86 | /* |
87 | * If the number of false interrupts per one transaction exceeds | |
88 | * this threshold, will think there is a GPE storm happened and | |
89 | * will disable the GPE for normal transaction. | |
90 | */ | |
91 | static unsigned int ec_storm_threshold __read_mostly = 8; | |
92 | module_param(ec_storm_threshold, uint, 0644); | |
93 | MODULE_PARM_DESC(ec_storm_threshold, "Maxim false GPE numbers not considered as GPE storm"); | |
94 | ||
837012ed AS |
95 | struct acpi_ec_query_handler { |
96 | struct list_head node; | |
97 | acpi_ec_query_func func; | |
98 | acpi_handle handle; | |
99 | void *data; | |
100 | u8 query_bit; | |
101 | }; | |
102 | ||
8463200a | 103 | struct transaction { |
7c6db4e0 AS |
104 | const u8 *wdata; |
105 | u8 *rdata; | |
106 | unsigned short irq_count; | |
8463200a | 107 | u8 command; |
a2f93aea AS |
108 | u8 wi; |
109 | u8 ri; | |
7c6db4e0 AS |
110 | u8 wlen; |
111 | u8 rlen; | |
dd15f8c4 | 112 | bool done; |
7c6db4e0 AS |
113 | }; |
114 | ||
1195a098 TR |
115 | struct acpi_ec *boot_ec, *first_ec; |
116 | EXPORT_SYMBOL(first_ec); | |
703959d4 | 117 | |
5423a0cb | 118 | static int EC_FLAGS_MSI; /* Out-of-spec MSI controller */ |
0adf3c74 | 119 | static int EC_FLAGS_VALIDATE_ECDT; /* ASUStec ECDTs need to be validated */ |
478fa03b | 120 | static int EC_FLAGS_SKIP_DSDT_SCAN; /* Not all BIOS survive early DSDT scan */ |
ad332c8a | 121 | static int EC_FLAGS_CLEAR_ON_RESUME; /* Needs acpi_ec_clear() on boot/resume */ |
5423a0cb | 122 | |
1da177e4 LT |
123 | /* -------------------------------------------------------------------------- |
124 | Transaction Management | |
125 | -------------------------------------------------------------------------- */ | |
126 | ||
6ffb221a | 127 | static inline u8 acpi_ec_read_status(struct acpi_ec *ec) |
1da177e4 | 128 | { |
3ebe08a7 | 129 | u8 x = inb(ec->command_addr); |
16a26e85 | 130 | pr_debug("---> status = 0x%2.2x\n", x); |
3ebe08a7 | 131 | return x; |
451566f4 DT |
132 | } |
133 | ||
6ffb221a | 134 | static inline u8 acpi_ec_read_data(struct acpi_ec *ec) |
703959d4 | 135 | { |
3ebe08a7 | 136 | u8 x = inb(ec->data_addr); |
16a26e85 | 137 | pr_debug("---> data = 0x%2.2x\n", x); |
7c6db4e0 | 138 | return x; |
7c6db5e5 DS |
139 | } |
140 | ||
6ffb221a | 141 | static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command) |
45bea155 | 142 | { |
16a26e85 | 143 | pr_debug("<--- command = 0x%2.2x\n", command); |
6ffb221a | 144 | outb(command, ec->command_addr); |
45bea155 LY |
145 | } |
146 | ||
6ffb221a | 147 | static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data) |
45bea155 | 148 | { |
16a26e85 | 149 | pr_debug("<--- data = 0x%2.2x\n", data); |
6ffb221a | 150 | outb(data, ec->data_addr); |
703959d4 | 151 | } |
45bea155 | 152 | |
7c6db4e0 | 153 | static int ec_transaction_done(struct acpi_ec *ec) |
6ffb221a | 154 | { |
7c6db4e0 AS |
155 | unsigned long flags; |
156 | int ret = 0; | |
f351d027 | 157 | spin_lock_irqsave(&ec->lock, flags); |
dd15f8c4 | 158 | if (!ec->curr || ec->curr->done) |
7c6db4e0 | 159 | ret = 1; |
f351d027 | 160 | spin_unlock_irqrestore(&ec->lock, flags); |
7c6db4e0 | 161 | return ret; |
45bea155 | 162 | } |
451566f4 | 163 | |
a2f93aea AS |
164 | static 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 | ||
2a84cb98 | 171 | static void advance_transaction(struct acpi_ec *ec, u8 status) |
7c6db5e5 | 172 | { |
7c6db4e0 | 173 | unsigned long flags; |
36b15875 | 174 | struct transaction *t; |
b76b51ba | 175 | |
f351d027 | 176 | spin_lock_irqsave(&ec->lock, flags); |
36b15875 | 177 | t = ec->curr; |
b76b51ba | 178 | if (!t) |
7c6db4e0 | 179 | goto unlock; |
b76b51ba | 180 | if (t->wlen > t->wi) { |
a2f93aea AS |
181 | if ((status & ACPI_EC_FLAG_IBF) == 0) |
182 | acpi_ec_write_data(ec, | |
b76b51ba | 183 | t->wdata[t->wi++]); |
a2f93aea | 184 | else |
dd15f8c4 | 185 | goto err; |
b76b51ba | 186 | } else if (t->rlen > t->ri) { |
7c6db4e0 | 187 | if ((status & ACPI_EC_FLAG_OBF) == 1) { |
b76b51ba FT |
188 | t->rdata[t->ri++] = acpi_ec_read_data(ec); |
189 | if (t->rlen == t->ri) | |
190 | t->done = true; | |
7c6db4e0 | 191 | } else |
dd15f8c4 | 192 | goto err; |
b76b51ba | 193 | } else if (t->wlen == t->wi && |
a2f93aea | 194 | (status & ACPI_EC_FLAG_IBF) == 0) |
b76b51ba | 195 | t->done = true; |
dd15f8c4 AS |
196 | goto unlock; |
197 | err: | |
a3cd8d27 FT |
198 | /* |
199 | * If SCI bit is set, then don't think it's a false IRQ | |
200 | * otherwise will take a not handled IRQ as a false one. | |
201 | */ | |
202 | if (in_interrupt() && !(status & ACPI_EC_FLAG_SCI)) | |
b76b51ba | 203 | ++t->irq_count; |
a3cd8d27 | 204 | |
7c6db4e0 | 205 | unlock: |
f351d027 | 206 | spin_unlock_irqrestore(&ec->lock, flags); |
845625cd | 207 | } |
03d1d99c | 208 | |
3eba563e | 209 | static int acpi_ec_sync_query(struct acpi_ec *ec, u8 *data); |
7c6db4e0 | 210 | |
a62e8f19 | 211 | static int ec_check_sci_sync(struct acpi_ec *ec, u8 state) |
7c6db5e5 | 212 | { |
7c6db4e0 AS |
213 | if (state & ACPI_EC_FLAG_SCI) { |
214 | if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags)) | |
3eba563e | 215 | return acpi_ec_sync_query(ec, NULL); |
7c6db4e0 AS |
216 | } |
217 | return 0; | |
218 | } | |
219 | ||
220 | static int ec_poll(struct acpi_ec *ec) | |
221 | { | |
2a84cb98 | 222 | unsigned long flags; |
28fe5c82 | 223 | int repeat = 5; /* number of command restarts */ |
2a84cb98 AS |
224 | while (repeat--) { |
225 | unsigned long delay = jiffies + | |
7a18e96d | 226 | msecs_to_jiffies(ec_delay); |
2a84cb98 AS |
227 | do { |
228 | /* don't sleep with disabled interrupts */ | |
229 | if (EC_FLAGS_MSI || irqs_disabled()) { | |
230 | udelay(ACPI_EC_MSI_UDELAY); | |
231 | if (ec_transaction_done(ec)) | |
232 | return 0; | |
233 | } else { | |
234 | if (wait_event_timeout(ec->wait, | |
235 | ec_transaction_done(ec), | |
236 | msecs_to_jiffies(1))) | |
237 | return 0; | |
238 | } | |
239 | advance_transaction(ec, acpi_ec_read_status(ec)); | |
240 | } while (time_before(jiffies, delay)); | |
16a26e85 | 241 | pr_debug("controller reset, restart transaction\n"); |
f351d027 | 242 | spin_lock_irqsave(&ec->lock, flags); |
2a84cb98 | 243 | start_transaction(ec); |
f351d027 | 244 | spin_unlock_irqrestore(&ec->lock, flags); |
af3fd140 | 245 | } |
b77d81b2 | 246 | return -ETIME; |
1da177e4 LT |
247 | } |
248 | ||
8463200a | 249 | static int acpi_ec_transaction_unlocked(struct acpi_ec *ec, |
2a84cb98 | 250 | struct transaction *t) |
45bea155 | 251 | { |
7c6db4e0 | 252 | unsigned long tmp; |
7c6db4e0 | 253 | int ret = 0; |
5423a0cb | 254 | if (EC_FLAGS_MSI) |
2a84cb98 | 255 | udelay(ACPI_EC_MSI_UDELAY); |
7c6db4e0 | 256 | /* start transaction */ |
f351d027 | 257 | spin_lock_irqsave(&ec->lock, tmp); |
7c6db4e0 | 258 | /* following two actions should be kept atomic */ |
8463200a | 259 | ec->curr = t; |
a2f93aea | 260 | start_transaction(ec); |
8463200a | 261 | if (ec->curr->command == ACPI_EC_COMMAND_QUERY) |
080e412c | 262 | clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags); |
f351d027 | 263 | spin_unlock_irqrestore(&ec->lock, tmp); |
2a84cb98 | 264 | ret = ec_poll(ec); |
f351d027 | 265 | spin_lock_irqsave(&ec->lock, tmp); |
8463200a | 266 | ec->curr = NULL; |
f351d027 | 267 | spin_unlock_irqrestore(&ec->lock, tmp); |
7c6db4e0 AS |
268 | return ret; |
269 | } | |
270 | ||
271 | static int ec_check_ibf0(struct acpi_ec *ec) | |
272 | { | |
273 | u8 status = acpi_ec_read_status(ec); | |
274 | return (status & ACPI_EC_FLAG_IBF) == 0; | |
45bea155 LY |
275 | } |
276 | ||
c0ff1772 AS |
277 | static int ec_wait_ibf0(struct acpi_ec *ec) |
278 | { | |
7a18e96d | 279 | unsigned long delay = jiffies + msecs_to_jiffies(ec_delay); |
c0ff1772 | 280 | /* interrupt wait manually if GPE mode is not active */ |
c0ff1772 | 281 | while (time_before(jiffies, delay)) |
2a84cb98 AS |
282 | if (wait_event_timeout(ec->wait, ec_check_ibf0(ec), |
283 | msecs_to_jiffies(1))) | |
c0ff1772 AS |
284 | return 0; |
285 | return -ETIME; | |
45bea155 LY |
286 | } |
287 | ||
2a84cb98 | 288 | static int acpi_ec_transaction(struct acpi_ec *ec, struct transaction *t) |
1da177e4 | 289 | { |
d7a76e4c | 290 | int status; |
50526df6 | 291 | u32 glk; |
8463200a | 292 | if (!ec || (!t) || (t->wlen && !t->wdata) || (t->rlen && !t->rdata)) |
d550d98d | 293 | return -EINVAL; |
8463200a AS |
294 | if (t->rdata) |
295 | memset(t->rdata, 0, t->rlen); | |
f351d027 | 296 | mutex_lock(&ec->mutex); |
fe955682 | 297 | if (test_bit(EC_FLAGS_BLOCKED, &ec->flags)) { |
f6bb13aa RW |
298 | status = -EINVAL; |
299 | goto unlock; | |
300 | } | |
703959d4 | 301 | if (ec->global_lock) { |
1da177e4 | 302 | status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk); |
c24e912b | 303 | if (ACPI_FAILURE(status)) { |
7c6db4e0 AS |
304 | status = -ENODEV; |
305 | goto unlock; | |
c24e912b | 306 | } |
1da177e4 | 307 | } |
c0ff1772 | 308 | if (ec_wait_ibf0(ec)) { |
16a26e85 | 309 | pr_err("input buffer is not empty, " |
3ebe08a7 | 310 | "aborting transaction\n"); |
7c6db4e0 | 311 | status = -ETIME; |
451566f4 | 312 | goto end; |
716e084e | 313 | } |
16a26e85 | 314 | pr_debug("transaction start (cmd=0x%02x, addr=0x%02x)\n", |
b76b51ba | 315 | t->command, t->wdata ? t->wdata[0] : 0); |
a62e8f19 AS |
316 | /* disable GPE during transaction if storm is detected */ |
317 | if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) { | |
3784730b RW |
318 | /* It has to be disabled, so that it doesn't trigger. */ |
319 | acpi_disable_gpe(NULL, ec->gpe); | |
a62e8f19 AS |
320 | } |
321 | ||
2a84cb98 | 322 | status = acpi_ec_transaction_unlocked(ec, t); |
a62e8f19 AS |
323 | |
324 | /* check if we received SCI during transaction */ | |
325 | ec_check_sci_sync(ec, acpi_ec_read_status(ec)); | |
326 | if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) { | |
54070101 | 327 | msleep(1); |
3784730b RW |
328 | /* It is safe to enable the GPE outside of the transaction. */ |
329 | acpi_enable_gpe(NULL, ec->gpe); | |
a520d52e | 330 | } else if (t->irq_count > ec_storm_threshold) { |
16a26e85 | 331 | pr_info("GPE storm detected(%d GPEs), " |
b76b51ba FT |
332 | "transactions will use polling mode\n", |
333 | t->irq_count); | |
a62e8f19 AS |
334 | set_bit(EC_FLAGS_GPE_STORM, &ec->flags); |
335 | } | |
16a26e85 | 336 | pr_debug("transaction end\n"); |
7c6db4e0 | 337 | end: |
703959d4 | 338 | if (ec->global_lock) |
1da177e4 | 339 | acpi_release_global_lock(glk); |
7c6db4e0 | 340 | unlock: |
f351d027 | 341 | mutex_unlock(&ec->mutex); |
d550d98d | 342 | return status; |
1da177e4 LT |
343 | } |
344 | ||
8a383ef0 | 345 | static int acpi_ec_burst_enable(struct acpi_ec *ec) |
c45aac43 AS |
346 | { |
347 | u8 d; | |
8463200a AS |
348 | struct transaction t = {.command = ACPI_EC_BURST_ENABLE, |
349 | .wdata = NULL, .rdata = &d, | |
350 | .wlen = 0, .rlen = 1}; | |
351 | ||
2a84cb98 | 352 | return acpi_ec_transaction(ec, &t); |
c45aac43 AS |
353 | } |
354 | ||
8a383ef0 | 355 | static int acpi_ec_burst_disable(struct acpi_ec *ec) |
c45aac43 | 356 | { |
8463200a AS |
357 | struct transaction t = {.command = ACPI_EC_BURST_DISABLE, |
358 | .wdata = NULL, .rdata = NULL, | |
359 | .wlen = 0, .rlen = 0}; | |
360 | ||
7c6db4e0 | 361 | return (acpi_ec_read_status(ec) & ACPI_EC_FLAG_BURST) ? |
2a84cb98 | 362 | acpi_ec_transaction(ec, &t) : 0; |
c45aac43 AS |
363 | } |
364 | ||
6ccedb10 | 365 | static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 * data) |
3576cf61 DS |
366 | { |
367 | int result; | |
368 | u8 d; | |
8463200a AS |
369 | struct transaction t = {.command = ACPI_EC_COMMAND_READ, |
370 | .wdata = &address, .rdata = &d, | |
371 | .wlen = 1, .rlen = 1}; | |
3576cf61 | 372 | |
2a84cb98 | 373 | result = acpi_ec_transaction(ec, &t); |
3576cf61 DS |
374 | *data = d; |
375 | return result; | |
376 | } | |
6ffb221a | 377 | |
3576cf61 DS |
378 | static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data) |
379 | { | |
6ccedb10 | 380 | u8 wdata[2] = { address, data }; |
8463200a AS |
381 | struct transaction t = {.command = ACPI_EC_COMMAND_WRITE, |
382 | .wdata = wdata, .rdata = NULL, | |
383 | .wlen = 2, .rlen = 0}; | |
384 | ||
2a84cb98 | 385 | return acpi_ec_transaction(ec, &t); |
3576cf61 DS |
386 | } |
387 | ||
b76b51ba | 388 | int ec_read(u8 addr, u8 *val) |
1da177e4 | 389 | { |
1da177e4 | 390 | int err; |
6ffb221a | 391 | u8 temp_data; |
1da177e4 LT |
392 | |
393 | if (!first_ec) | |
394 | return -ENODEV; | |
395 | ||
d033879c | 396 | err = acpi_ec_read(first_ec, addr, &temp_data); |
1da177e4 LT |
397 | |
398 | if (!err) { | |
399 | *val = temp_data; | |
400 | return 0; | |
50526df6 | 401 | } else |
1da177e4 LT |
402 | return err; |
403 | } | |
50526df6 | 404 | |
1da177e4 LT |
405 | EXPORT_SYMBOL(ec_read); |
406 | ||
50526df6 | 407 | int ec_write(u8 addr, u8 val) |
1da177e4 | 408 | { |
1da177e4 LT |
409 | int err; |
410 | ||
411 | if (!first_ec) | |
412 | return -ENODEV; | |
413 | ||
d033879c | 414 | err = acpi_ec_write(first_ec, addr, val); |
1da177e4 LT |
415 | |
416 | return err; | |
417 | } | |
50526df6 | 418 | |
1da177e4 LT |
419 | EXPORT_SYMBOL(ec_write); |
420 | ||
616362de | 421 | int ec_transaction(u8 command, |
9e197219 | 422 | const u8 * wdata, unsigned wdata_len, |
1cb7b1e0 | 423 | u8 * rdata, unsigned rdata_len) |
45bea155 | 424 | { |
8463200a AS |
425 | struct transaction t = {.command = command, |
426 | .wdata = wdata, .rdata = rdata, | |
427 | .wlen = wdata_len, .rlen = rdata_len}; | |
d7a76e4c LP |
428 | if (!first_ec) |
429 | return -ENODEV; | |
45bea155 | 430 | |
2a84cb98 | 431 | return acpi_ec_transaction(first_ec, &t); |
45bea155 | 432 | } |
1da177e4 | 433 | |
ab9e43c6 LP |
434 | EXPORT_SYMBOL(ec_transaction); |
435 | ||
3e2abc5a SF |
436 | /* Get the handle to the EC device */ |
437 | acpi_handle ec_get_handle(void) | |
438 | { | |
439 | if (!first_ec) | |
440 | return NULL; | |
441 | return first_ec->handle; | |
442 | } | |
443 | ||
444 | EXPORT_SYMBOL(ec_get_handle); | |
445 | ||
ad332c8a | 446 | /* |
3eba563e | 447 | * Process _Q events that might have accumulated in the EC. |
ad332c8a KC |
448 | * Run with locked ec mutex. |
449 | */ | |
450 | static void acpi_ec_clear(struct acpi_ec *ec) | |
451 | { | |
452 | int i, status; | |
453 | u8 value = 0; | |
454 | ||
455 | for (i = 0; i < ACPI_EC_CLEAR_MAX; i++) { | |
3eba563e | 456 | status = acpi_ec_sync_query(ec, &value); |
ad332c8a KC |
457 | if (status || !value) |
458 | break; | |
459 | } | |
460 | ||
461 | if (unlikely(i == ACPI_EC_CLEAR_MAX)) | |
462 | pr_warn("Warning: Maximum of %d stale EC events cleared\n", i); | |
463 | else | |
464 | pr_info("%d stale EC events cleared\n", i); | |
465 | } | |
466 | ||
fe955682 | 467 | void acpi_ec_block_transactions(void) |
f6bb13aa RW |
468 | { |
469 | struct acpi_ec *ec = first_ec; | |
470 | ||
471 | if (!ec) | |
472 | return; | |
473 | ||
f351d027 | 474 | mutex_lock(&ec->mutex); |
f6bb13aa | 475 | /* Prevent transactions from being carried out */ |
fe955682 | 476 | set_bit(EC_FLAGS_BLOCKED, &ec->flags); |
f351d027 | 477 | mutex_unlock(&ec->mutex); |
f6bb13aa RW |
478 | } |
479 | ||
fe955682 | 480 | void acpi_ec_unblock_transactions(void) |
f6bb13aa RW |
481 | { |
482 | struct acpi_ec *ec = first_ec; | |
483 | ||
484 | if (!ec) | |
485 | return; | |
486 | ||
f351d027 | 487 | mutex_lock(&ec->mutex); |
f6bb13aa | 488 | /* Allow transactions to be carried out again */ |
fe955682 | 489 | clear_bit(EC_FLAGS_BLOCKED, &ec->flags); |
ad332c8a KC |
490 | |
491 | if (EC_FLAGS_CLEAR_ON_RESUME) | |
492 | acpi_ec_clear(ec); | |
493 | ||
f351d027 | 494 | mutex_unlock(&ec->mutex); |
f6bb13aa RW |
495 | } |
496 | ||
fe955682 | 497 | void acpi_ec_unblock_transactions_early(void) |
d5a64513 RW |
498 | { |
499 | /* | |
500 | * Allow transactions to happen again (this function is called from | |
501 | * atomic context during wakeup, so we don't need to acquire the mutex). | |
502 | */ | |
503 | if (first_ec) | |
fe955682 | 504 | clear_bit(EC_FLAGS_BLOCKED, &first_ec->flags); |
d5a64513 RW |
505 | } |
506 | ||
a62e8f19 | 507 | static int acpi_ec_query_unlocked(struct acpi_ec *ec, u8 * data) |
3576cf61 DS |
508 | { |
509 | int result; | |
6ccedb10 | 510 | u8 d; |
8463200a AS |
511 | struct transaction t = {.command = ACPI_EC_COMMAND_QUERY, |
512 | .wdata = NULL, .rdata = &d, | |
513 | .wlen = 0, .rlen = 1}; | |
6ccedb10 AS |
514 | if (!ec || !data) |
515 | return -EINVAL; | |
6ccedb10 AS |
516 | /* |
517 | * Query the EC to find out which _Qxx method we need to evaluate. | |
518 | * Note that successful completion of the query causes the ACPI_EC_SCI | |
519 | * bit to be cleared (and thus clearing the interrupt source). | |
520 | */ | |
a62e8f19 | 521 | result = acpi_ec_transaction_unlocked(ec, &t); |
6ccedb10 AS |
522 | if (result) |
523 | return result; | |
6ccedb10 AS |
524 | if (!d) |
525 | return -ENODATA; | |
6ccedb10 AS |
526 | *data = d; |
527 | return 0; | |
1da177e4 LT |
528 | } |
529 | ||
1da177e4 LT |
530 | /* -------------------------------------------------------------------------- |
531 | Event Management | |
532 | -------------------------------------------------------------------------- */ | |
837012ed AS |
533 | int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit, |
534 | acpi_handle handle, acpi_ec_query_func func, | |
535 | void *data) | |
536 | { | |
537 | struct acpi_ec_query_handler *handler = | |
538 | kzalloc(sizeof(struct acpi_ec_query_handler), GFP_KERNEL); | |
539 | if (!handler) | |
540 | return -ENOMEM; | |
541 | ||
542 | handler->query_bit = query_bit; | |
543 | handler->handle = handle; | |
544 | handler->func = func; | |
545 | handler->data = data; | |
f351d027 | 546 | mutex_lock(&ec->mutex); |
30c08574 | 547 | list_add(&handler->node, &ec->list); |
f351d027 | 548 | mutex_unlock(&ec->mutex); |
837012ed AS |
549 | return 0; |
550 | } | |
551 | ||
552 | EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler); | |
553 | ||
554 | void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit) | |
555 | { | |
1544fdbc | 556 | struct acpi_ec_query_handler *handler, *tmp; |
f351d027 | 557 | mutex_lock(&ec->mutex); |
1544fdbc | 558 | list_for_each_entry_safe(handler, tmp, &ec->list, node) { |
837012ed AS |
559 | if (query_bit == handler->query_bit) { |
560 | list_del(&handler->node); | |
561 | kfree(handler); | |
837012ed AS |
562 | } |
563 | } | |
f351d027 | 564 | mutex_unlock(&ec->mutex); |
837012ed AS |
565 | } |
566 | ||
567 | EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler); | |
1da177e4 | 568 | |
a62e8f19 | 569 | static void acpi_ec_run(void *cxt) |
45bea155 | 570 | { |
a62e8f19 AS |
571 | struct acpi_ec_query_handler *handler = cxt; |
572 | if (!handler) | |
e41334c0 | 573 | return; |
16a26e85 | 574 | pr_debug("start query execution\n"); |
a62e8f19 AS |
575 | if (handler->func) |
576 | handler->func(handler->data); | |
577 | else if (handler->handle) | |
578 | acpi_evaluate_object(handler->handle, NULL, NULL, NULL); | |
16a26e85 | 579 | pr_debug("stop query execution\n"); |
a62e8f19 AS |
580 | kfree(handler); |
581 | } | |
582 | ||
3eba563e | 583 | static int acpi_ec_sync_query(struct acpi_ec *ec, u8 *data) |
a62e8f19 AS |
584 | { |
585 | u8 value = 0; | |
586 | int status; | |
587 | struct acpi_ec_query_handler *handler, *copy; | |
3eba563e KC |
588 | |
589 | status = acpi_ec_query_unlocked(ec, &value); | |
590 | if (data) | |
591 | *data = value; | |
592 | if (status) | |
a62e8f19 | 593 | return status; |
3eba563e | 594 | |
837012ed AS |
595 | list_for_each_entry(handler, &ec->list, node) { |
596 | if (value == handler->query_bit) { | |
597 | /* have custom handler for this bit */ | |
a62e8f19 AS |
598 | copy = kmalloc(sizeof(*handler), GFP_KERNEL); |
599 | if (!copy) | |
600 | return -ENOMEM; | |
601 | memcpy(copy, handler, sizeof(*copy)); | |
16a26e85 LT |
602 | pr_debug("push query execution (0x%2x) on queue\n", |
603 | value); | |
f5347867 AS |
604 | return acpi_os_execute((copy->func) ? |
605 | OSL_NOTIFY_HANDLER : OSL_GPE_HANDLER, | |
a62e8f19 | 606 | acpi_ec_run, copy); |
837012ed AS |
607 | } |
608 | } | |
a62e8f19 AS |
609 | return 0; |
610 | } | |
611 | ||
612 | static void acpi_ec_gpe_query(void *ec_cxt) | |
613 | { | |
614 | struct acpi_ec *ec = ec_cxt; | |
615 | if (!ec) | |
616 | return; | |
f351d027 | 617 | mutex_lock(&ec->mutex); |
3eba563e | 618 | acpi_ec_sync_query(ec, NULL); |
f351d027 | 619 | mutex_unlock(&ec->mutex); |
45bea155 | 620 | } |
1da177e4 | 621 | |
a62e8f19 AS |
622 | static int ec_check_sci(struct acpi_ec *ec, u8 state) |
623 | { | |
624 | if (state & ACPI_EC_FLAG_SCI) { | |
625 | if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags)) { | |
16a26e85 | 626 | pr_debug("push gpe query to the queue\n"); |
a62e8f19 AS |
627 | return acpi_os_execute(OSL_NOTIFY_HANDLER, |
628 | acpi_ec_gpe_query, ec); | |
629 | } | |
630 | } | |
631 | return 0; | |
632 | } | |
633 | ||
8b6cd8ad LM |
634 | static u32 acpi_ec_gpe_handler(acpi_handle gpe_device, |
635 | u32 gpe_number, void *data) | |
1da177e4 | 636 | { |
3d02b90b | 637 | struct acpi_ec *ec = data; |
b76b51ba | 638 | u8 status = acpi_ec_read_status(ec); |
00eb43a1 | 639 | |
16a26e85 | 640 | pr_debug("~~~> interrupt, status:0x%02x\n", status); |
7c6db4e0 | 641 | |
b76b51ba | 642 | advance_transaction(ec, status); |
a62e8f19 AS |
643 | if (ec_transaction_done(ec) && |
644 | (acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF) == 0) { | |
2a84cb98 | 645 | wake_up(&ec->wait); |
a62e8f19 AS |
646 | ec_check_sci(ec, acpi_ec_read_status(ec)); |
647 | } | |
bba63a29 | 648 | return ACPI_INTERRUPT_HANDLED | ACPI_REENABLE_GPE; |
845625cd AS |
649 | } |
650 | ||
1da177e4 LT |
651 | /* -------------------------------------------------------------------------- |
652 | Address Space Management | |
653 | -------------------------------------------------------------------------- */ | |
654 | ||
1da177e4 | 655 | static acpi_status |
5b7734b4 | 656 | acpi_ec_space_handler(u32 function, acpi_physical_address address, |
dadf28a1 | 657 | u32 bits, u64 *value64, |
50526df6 | 658 | void *handler_context, void *region_context) |
1da177e4 | 659 | { |
3d02b90b | 660 | struct acpi_ec *ec = handler_context; |
dadf28a1 AS |
661 | int result = 0, i, bytes = bits / 8; |
662 | u8 *value = (u8 *)value64; | |
1da177e4 | 663 | |
1da177e4 | 664 | if ((address > 0xFF) || !value || !handler_context) |
d550d98d | 665 | return AE_BAD_PARAMETER; |
1da177e4 | 666 | |
5b7734b4 | 667 | if (function != ACPI_READ && function != ACPI_WRITE) |
d550d98d | 668 | return AE_BAD_PARAMETER; |
1da177e4 | 669 | |
dadf28a1 | 670 | if (EC_FLAGS_MSI || bits > 8) |
6a63b06f | 671 | acpi_ec_burst_enable(ec); |
b3b233c7 | 672 | |
dadf28a1 AS |
673 | for (i = 0; i < bytes; ++i, ++address, ++value) |
674 | result = (function == ACPI_READ) ? | |
675 | acpi_ec_read(ec, address, value) : | |
676 | acpi_ec_write(ec, address, *value); | |
1da177e4 | 677 | |
dadf28a1 | 678 | if (EC_FLAGS_MSI || bits > 8) |
6a63b06f | 679 | acpi_ec_burst_disable(ec); |
b3b233c7 | 680 | |
1da177e4 LT |
681 | switch (result) { |
682 | case -EINVAL: | |
d550d98d | 683 | return AE_BAD_PARAMETER; |
1da177e4 LT |
684 | break; |
685 | case -ENODEV: | |
d550d98d | 686 | return AE_NOT_FOUND; |
1da177e4 LT |
687 | break; |
688 | case -ETIME: | |
d550d98d | 689 | return AE_TIME; |
1da177e4 LT |
690 | break; |
691 | default: | |
d550d98d | 692 | return AE_OK; |
1da177e4 | 693 | } |
1da177e4 LT |
694 | } |
695 | ||
1da177e4 LT |
696 | /* -------------------------------------------------------------------------- |
697 | Driver Interface | |
698 | -------------------------------------------------------------------------- */ | |
c0900c35 AS |
699 | static acpi_status |
700 | ec_parse_io_ports(struct acpi_resource *resource, void *context); | |
701 | ||
c0900c35 AS |
702 | static struct acpi_ec *make_acpi_ec(void) |
703 | { | |
704 | struct acpi_ec *ec = kzalloc(sizeof(struct acpi_ec), GFP_KERNEL); | |
705 | if (!ec) | |
706 | return NULL; | |
080e412c | 707 | ec->flags = 1 << EC_FLAGS_QUERY_PENDING; |
f351d027 | 708 | mutex_init(&ec->mutex); |
c0900c35 | 709 | init_waitqueue_head(&ec->wait); |
837012ed | 710 | INIT_LIST_HEAD(&ec->list); |
f351d027 | 711 | spin_lock_init(&ec->lock); |
c0900c35 AS |
712 | return ec; |
713 | } | |
837012ed | 714 | |
c019b193 AS |
715 | static acpi_status |
716 | acpi_ec_register_query_methods(acpi_handle handle, u32 level, | |
717 | void *context, void **return_value) | |
718 | { | |
0175d562 LM |
719 | char node_name[5]; |
720 | struct acpi_buffer buffer = { sizeof(node_name), node_name }; | |
c019b193 AS |
721 | struct acpi_ec *ec = context; |
722 | int value = 0; | |
0175d562 LM |
723 | acpi_status status; |
724 | ||
725 | status = acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer); | |
726 | ||
727 | if (ACPI_SUCCESS(status) && sscanf(node_name, "_Q%x", &value) == 1) { | |
c019b193 AS |
728 | acpi_ec_add_query_handler(ec, value, handle, NULL, NULL); |
729 | } | |
730 | return AE_OK; | |
731 | } | |
732 | ||
cd8c93a4 AS |
733 | static acpi_status |
734 | ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval) | |
837012ed | 735 | { |
cd8c93a4 | 736 | acpi_status status; |
d21cf3c1 | 737 | unsigned long long tmp = 0; |
cd8c93a4 AS |
738 | |
739 | struct acpi_ec *ec = context; | |
a5032bfd AS |
740 | |
741 | /* clear addr values, ec_parse_io_ports depend on it */ | |
742 | ec->command_addr = ec->data_addr = 0; | |
743 | ||
cd8c93a4 AS |
744 | status = acpi_walk_resources(handle, METHOD_NAME__CRS, |
745 | ec_parse_io_ports, ec); | |
746 | if (ACPI_FAILURE(status)) | |
747 | return status; | |
837012ed AS |
748 | |
749 | /* Get GPE bit assignment (EC events). */ | |
750 | /* TODO: Add support for _GPE returning a package */ | |
27663c58 | 751 | status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp); |
cd8c93a4 AS |
752 | if (ACPI_FAILURE(status)) |
753 | return status; | |
27663c58 | 754 | ec->gpe = tmp; |
837012ed | 755 | /* Use the global lock for all EC transactions? */ |
d21cf3c1 | 756 | tmp = 0; |
27663c58 MW |
757 | acpi_evaluate_integer(handle, "_GLK", NULL, &tmp); |
758 | ec->global_lock = tmp; | |
837012ed | 759 | ec->handle = handle; |
cd8c93a4 | 760 | return AE_CTRL_TERMINATE; |
837012ed AS |
761 | } |
762 | ||
5efc5476 BH |
763 | static int ec_install_handlers(struct acpi_ec *ec) |
764 | { | |
765 | acpi_status status; | |
766 | if (test_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags)) | |
767 | return 0; | |
768 | status = acpi_install_gpe_handler(NULL, ec->gpe, | |
769 | ACPI_GPE_EDGE_TRIGGERED, | |
770 | &acpi_ec_gpe_handler, ec); | |
771 | if (ACPI_FAILURE(status)) | |
772 | return -ENODEV; | |
9630bdd9 | 773 | |
a44061aa | 774 | acpi_enable_gpe(NULL, ec->gpe); |
5efc5476 BH |
775 | status = acpi_install_address_space_handler(ec->handle, |
776 | ACPI_ADR_SPACE_EC, | |
777 | &acpi_ec_space_handler, | |
778 | NULL, ec); | |
779 | if (ACPI_FAILURE(status)) { | |
780 | if (status == AE_NOT_FOUND) { | |
781 | /* | |
782 | * Maybe OS fails in evaluating the _REG object. | |
783 | * The AE_NOT_FOUND error will be ignored and OS | |
784 | * continue to initialize EC. | |
785 | */ | |
16a26e85 | 786 | pr_err("Fail in evaluating the _REG object" |
5efc5476 BH |
787 | " of EC device. Broken bios is suspected.\n"); |
788 | } else { | |
42b946bb | 789 | acpi_disable_gpe(NULL, ec->gpe); |
5efc5476 BH |
790 | acpi_remove_gpe_handler(NULL, ec->gpe, |
791 | &acpi_ec_gpe_handler); | |
792 | return -ENODEV; | |
793 | } | |
794 | } | |
795 | ||
796 | set_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags); | |
797 | return 0; | |
798 | } | |
799 | ||
4c611060 AS |
800 | static void ec_remove_handlers(struct acpi_ec *ec) |
801 | { | |
a44061aa | 802 | acpi_disable_gpe(NULL, ec->gpe); |
4c611060 AS |
803 | if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle, |
804 | ACPI_ADR_SPACE_EC, &acpi_ec_space_handler))) | |
16a26e85 | 805 | pr_err("failed to remove space handler\n"); |
4c611060 AS |
806 | if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe, |
807 | &acpi_ec_gpe_handler))) | |
16a26e85 | 808 | pr_err("failed to remove gpe handler\n"); |
7c6db4e0 | 809 | clear_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags); |
4c611060 AS |
810 | } |
811 | ||
703959d4 | 812 | static int acpi_ec_add(struct acpi_device *device) |
1da177e4 | 813 | { |
703959d4 | 814 | struct acpi_ec *ec = NULL; |
d02be047 | 815 | int ret; |
45bea155 | 816 | |
c0900c35 AS |
817 | strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME); |
818 | strcpy(acpi_device_class(device), ACPI_EC_CLASS); | |
819 | ||
4c611060 | 820 | /* Check for boot EC */ |
ce52ddf5 AS |
821 | if (boot_ec && |
822 | (boot_ec->handle == device->handle || | |
823 | boot_ec->handle == ACPI_ROOT_OBJECT)) { | |
824 | ec = boot_ec; | |
825 | boot_ec = NULL; | |
826 | } else { | |
827 | ec = make_acpi_ec(); | |
828 | if (!ec) | |
829 | return -ENOMEM; | |
a5032bfd AS |
830 | } |
831 | if (ec_parse_device(device->handle, 0, ec, NULL) != | |
832 | AE_CTRL_TERMINATE) { | |
ce52ddf5 AS |
833 | kfree(ec); |
834 | return -EINVAL; | |
4c611060 AS |
835 | } |
836 | ||
ce52ddf5 AS |
837 | /* Find and register all query methods */ |
838 | acpi_walk_namespace(ACPI_TYPE_METHOD, ec->handle, 1, | |
2263576c | 839 | acpi_ec_register_query_methods, NULL, ec, NULL); |
ce52ddf5 | 840 | |
4c611060 AS |
841 | if (!first_ec) |
842 | first_ec = ec; | |
db89b4f0 | 843 | device->driver_data = ec; |
de4f1046 | 844 | |
d6795fe3 AK |
845 | ret = !!request_region(ec->data_addr, 1, "EC data"); |
846 | WARN(!ret, "Could not request EC data io port 0x%lx", ec->data_addr); | |
847 | ret = !!request_region(ec->command_addr, 1, "EC cmd"); | |
848 | WARN(!ret, "Could not request EC cmd io port 0x%lx", ec->command_addr); | |
de4f1046 | 849 | |
16a26e85 | 850 | pr_info("GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n", |
4c611060 | 851 | ec->gpe, ec->command_addr, ec->data_addr); |
5efc5476 BH |
852 | |
853 | ret = ec_install_handlers(ec); | |
854 | ||
855 | /* EC is fully operational, allow queries */ | |
856 | clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags); | |
ad332c8a KC |
857 | |
858 | /* Clear stale _Q events if hardware might require that */ | |
859 | if (EC_FLAGS_CLEAR_ON_RESUME) { | |
860 | mutex_lock(&ec->mutex); | |
861 | acpi_ec_clear(ec); | |
862 | mutex_unlock(&ec->mutex); | |
863 | } | |
5efc5476 | 864 | return ret; |
1da177e4 LT |
865 | } |
866 | ||
51fac838 | 867 | static int acpi_ec_remove(struct acpi_device *device) |
1da177e4 | 868 | { |
01f22462 | 869 | struct acpi_ec *ec; |
07ddf768 | 870 | struct acpi_ec_query_handler *handler, *tmp; |
1da177e4 | 871 | |
1da177e4 | 872 | if (!device) |
d550d98d | 873 | return -EINVAL; |
1da177e4 LT |
874 | |
875 | ec = acpi_driver_data(device); | |
cf745ec7 | 876 | ec_remove_handlers(ec); |
f351d027 | 877 | mutex_lock(&ec->mutex); |
07ddf768 | 878 | list_for_each_entry_safe(handler, tmp, &ec->list, node) { |
837012ed AS |
879 | list_del(&handler->node); |
880 | kfree(handler); | |
881 | } | |
f351d027 | 882 | mutex_unlock(&ec->mutex); |
de4f1046 TR |
883 | release_region(ec->data_addr, 1); |
884 | release_region(ec->command_addr, 1); | |
db89b4f0 | 885 | device->driver_data = NULL; |
d033879c | 886 | if (ec == first_ec) |
c0900c35 | 887 | first_ec = NULL; |
4c611060 | 888 | kfree(ec); |
d550d98d | 889 | return 0; |
1da177e4 LT |
890 | } |
891 | ||
1da177e4 | 892 | static acpi_status |
c0900c35 | 893 | ec_parse_io_ports(struct acpi_resource *resource, void *context) |
1da177e4 | 894 | { |
3d02b90b | 895 | struct acpi_ec *ec = context; |
1da177e4 | 896 | |
01f22462 | 897 | if (resource->type != ACPI_RESOURCE_TYPE_IO) |
1da177e4 | 898 | return AE_OK; |
1da177e4 LT |
899 | |
900 | /* | |
901 | * The first address region returned is the data port, and | |
902 | * the second address region returned is the status/command | |
903 | * port. | |
904 | */ | |
de4f1046 | 905 | if (ec->data_addr == 0) |
6ffb221a | 906 | ec->data_addr = resource->data.io.minimum; |
de4f1046 | 907 | else if (ec->command_addr == 0) |
6ffb221a | 908 | ec->command_addr = resource->data.io.minimum; |
01f22462 | 909 | else |
1da177e4 | 910 | return AE_CTRL_TERMINATE; |
1da177e4 | 911 | |
1da177e4 LT |
912 | return AE_OK; |
913 | } | |
914 | ||
c04209a7 AS |
915 | int __init acpi_boot_ec_enable(void) |
916 | { | |
7c6db4e0 | 917 | if (!boot_ec || test_bit(EC_FLAGS_HANDLERS_INSTALLED, &boot_ec->flags)) |
c04209a7 AS |
918 | return 0; |
919 | if (!ec_install_handlers(boot_ec)) { | |
920 | first_ec = boot_ec; | |
921 | return 0; | |
922 | } | |
923 | return -EFAULT; | |
924 | } | |
925 | ||
223883b7 AS |
926 | static const struct acpi_device_id ec_device_ids[] = { |
927 | {"PNP0C09", 0}, | |
928 | {"", 0}, | |
929 | }; | |
930 | ||
478fa03b AS |
931 | /* Some BIOS do not survive early DSDT scan, skip it */ |
932 | static int ec_skip_dsdt_scan(const struct dmi_system_id *id) | |
933 | { | |
934 | EC_FLAGS_SKIP_DSDT_SCAN = 1; | |
935 | return 0; | |
936 | } | |
937 | ||
0adf3c74 AS |
938 | /* ASUStek often supplies us with broken ECDT, validate it */ |
939 | static int ec_validate_ecdt(const struct dmi_system_id *id) | |
940 | { | |
941 | EC_FLAGS_VALIDATE_ECDT = 1; | |
942 | return 0; | |
943 | } | |
944 | ||
945 | /* MSI EC needs special treatment, enable it */ | |
946 | static int ec_flag_msi(const struct dmi_system_id *id) | |
947 | { | |
16a26e85 | 948 | pr_debug("Detected MSI hardware, enabling workarounds.\n"); |
0adf3c74 AS |
949 | EC_FLAGS_MSI = 1; |
950 | EC_FLAGS_VALIDATE_ECDT = 1; | |
951 | return 0; | |
952 | } | |
953 | ||
67bfa9b6 FT |
954 | /* |
955 | * Clevo M720 notebook actually works ok with IRQ mode, if we lifted | |
956 | * the GPE storm threshold back to 20 | |
957 | */ | |
958 | static int ec_enlarge_storm_threshold(const struct dmi_system_id *id) | |
959 | { | |
960 | pr_debug("Setting the EC GPE storm threshold to 20\n"); | |
961 | ec_storm_threshold = 20; | |
962 | return 0; | |
963 | } | |
964 | ||
ad332c8a KC |
965 | /* |
966 | * On some hardware it is necessary to clear events accumulated by the EC during | |
967 | * sleep. These ECs stop reporting GPEs until they are manually polled, if too | |
968 | * many events are accumulated. (e.g. Samsung Series 5/9 notebooks) | |
969 | * | |
970 | * https://bugzilla.kernel.org/show_bug.cgi?id=44161 | |
971 | * | |
972 | * Ideally, the EC should also be instructed NOT to accumulate events during | |
973 | * sleep (which Windows seems to do somehow), but the interface to control this | |
974 | * behaviour is not known at this time. | |
975 | * | |
976 | * Models known to be affected are Samsung 530Uxx/535Uxx/540Uxx/550Pxx/900Xxx, | |
977 | * however it is very likely that other Samsung models are affected. | |
978 | * | |
979 | * On systems which don't accumulate _Q events during sleep, this extra check | |
980 | * should be harmless. | |
981 | */ | |
982 | static int ec_clear_on_resume(const struct dmi_system_id *id) | |
983 | { | |
984 | pr_debug("Detected system needing EC poll on resume.\n"); | |
985 | EC_FLAGS_CLEAR_ON_RESUME = 1; | |
986 | return 0; | |
987 | } | |
988 | ||
6cef7497 | 989 | static struct dmi_system_id ec_dmi_table[] __initdata = { |
478fa03b AS |
990 | { |
991 | ec_skip_dsdt_scan, "Compal JFL92", { | |
992 | DMI_MATCH(DMI_BIOS_VENDOR, "COMPAL"), | |
993 | DMI_MATCH(DMI_BOARD_NAME, "JFL92") }, NULL}, | |
0adf3c74 AS |
994 | { |
995 | ec_flag_msi, "MSI hardware", { | |
55b313f2 AS |
996 | DMI_MATCH(DMI_BIOS_VENDOR, "Micro-Star")}, NULL}, |
997 | { | |
998 | ec_flag_msi, "MSI hardware", { | |
999 | DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star")}, NULL}, | |
1000 | { | |
1001 | ec_flag_msi, "MSI hardware", { | |
1002 | DMI_MATCH(DMI_CHASSIS_VENDOR, "MICRO-Star")}, NULL}, | |
0adf3c74 | 1003 | { |
a5dc4f89 AS |
1004 | ec_flag_msi, "MSI hardware", { |
1005 | DMI_MATCH(DMI_CHASSIS_VENDOR, "MICRO-STAR")}, NULL}, | |
1006 | { | |
534bc4e3 ZR |
1007 | ec_flag_msi, "Quanta hardware", { |
1008 | DMI_MATCH(DMI_SYS_VENDOR, "Quanta"), | |
1009 | DMI_MATCH(DMI_PRODUCT_NAME, "TW8/SW8/DW8"),}, NULL}, | |
1010 | { | |
1011 | ec_flag_msi, "Quanta hardware", { | |
1012 | DMI_MATCH(DMI_SYS_VENDOR, "Quanta"), | |
1013 | DMI_MATCH(DMI_PRODUCT_NAME, "TW9/SW9"),}, NULL}, | |
1014 | { | |
0adf3c74 AS |
1015 | ec_validate_ecdt, "ASUS hardware", { |
1016 | DMI_MATCH(DMI_BIOS_VENDOR, "ASUS") }, NULL}, | |
af986d10 PC |
1017 | { |
1018 | ec_validate_ecdt, "ASUS hardware", { | |
1019 | DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer Inc.") }, NULL}, | |
67bfa9b6 FT |
1020 | { |
1021 | ec_enlarge_storm_threshold, "CLEVO hardware", { | |
1022 | DMI_MATCH(DMI_SYS_VENDOR, "CLEVO Co."), | |
1023 | DMI_MATCH(DMI_PRODUCT_NAME, "M720T/M730T"),}, NULL}, | |
eff9a4b6 LT |
1024 | { |
1025 | ec_skip_dsdt_scan, "HP Folio 13", { | |
1026 | DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"), | |
1027 | DMI_MATCH(DMI_PRODUCT_NAME, "HP Folio 13"),}, NULL}, | |
524f42fa LT |
1028 | { |
1029 | ec_validate_ecdt, "ASUS hardware", { | |
1030 | DMI_MATCH(DMI_SYS_VENDOR, "ASUSTek Computer Inc."), | |
1031 | DMI_MATCH(DMI_PRODUCT_NAME, "L4R"),}, NULL}, | |
ad332c8a KC |
1032 | { |
1033 | ec_clear_on_resume, "Samsung hardware", { | |
1034 | DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD.")}, NULL}, | |
0adf3c74 AS |
1035 | {}, |
1036 | }; | |
1037 | ||
c0900c35 AS |
1038 | int __init acpi_ec_ecdt_probe(void) |
1039 | { | |
c0900c35 | 1040 | acpi_status status; |
c6cb0e87 | 1041 | struct acpi_ec *saved_ec = NULL; |
50526df6 | 1042 | struct acpi_table_ecdt *ecdt_ptr; |
45bea155 | 1043 | |
d66d969d AS |
1044 | boot_ec = make_acpi_ec(); |
1045 | if (!boot_ec) | |
c0900c35 AS |
1046 | return -ENOMEM; |
1047 | /* | |
1048 | * Generate a boot ec context | |
1049 | */ | |
0adf3c74 | 1050 | dmi_check_system(ec_dmi_table); |
15a58ed1 AS |
1051 | status = acpi_get_table(ACPI_SIG_ECDT, 1, |
1052 | (struct acpi_table_header **)&ecdt_ptr); | |
cd8c93a4 | 1053 | if (ACPI_SUCCESS(status)) { |
16a26e85 | 1054 | pr_info("EC description table is found, configuring boot EC\n"); |
cd8c93a4 AS |
1055 | boot_ec->command_addr = ecdt_ptr->control.address; |
1056 | boot_ec->data_addr = ecdt_ptr->data.address; | |
1057 | boot_ec->gpe = ecdt_ptr->gpe; | |
4af8e10a | 1058 | boot_ec->handle = ACPI_ROOT_OBJECT; |
ce52ddf5 | 1059 | acpi_get_handle(ACPI_ROOT_OBJECT, ecdt_ptr->id, &boot_ec->handle); |
c6cb0e87 | 1060 | /* Don't trust ECDT, which comes from ASUSTek */ |
0adf3c74 | 1061 | if (!EC_FLAGS_VALIDATE_ECDT) |
c5279dee | 1062 | goto install; |
d6bd535d | 1063 | saved_ec = kmemdup(boot_ec, sizeof(struct acpi_ec), GFP_KERNEL); |
c6cb0e87 AS |
1064 | if (!saved_ec) |
1065 | return -ENOMEM; | |
c5279dee | 1066 | /* fall through */ |
cd8c93a4 | 1067 | } |
0adf3c74 | 1068 | |
478fa03b AS |
1069 | if (EC_FLAGS_SKIP_DSDT_SCAN) |
1070 | return -ENODEV; | |
1071 | ||
c5279dee AS |
1072 | /* This workaround is needed only on some broken machines, |
1073 | * which require early EC, but fail to provide ECDT */ | |
16a26e85 | 1074 | pr_debug("Look up EC in DSDT\n"); |
c5279dee AS |
1075 | status = acpi_get_devices(ec_device_ids[0].id, ec_parse_device, |
1076 | boot_ec, NULL); | |
1077 | /* Check that acpi_get_devices actually find something */ | |
1078 | if (ACPI_FAILURE(status) || !boot_ec->handle) | |
1079 | goto error; | |
c6cb0e87 AS |
1080 | if (saved_ec) { |
1081 | /* try to find good ECDT from ASUSTek */ | |
1082 | if (saved_ec->command_addr != boot_ec->command_addr || | |
1083 | saved_ec->data_addr != boot_ec->data_addr || | |
1084 | saved_ec->gpe != boot_ec->gpe || | |
1085 | saved_ec->handle != boot_ec->handle) | |
16a26e85 | 1086 | pr_info("ASUSTek keeps feeding us with broken " |
c6cb0e87 AS |
1087 | "ECDT tables, which are very hard to workaround. " |
1088 | "Trying to use DSDT EC info instead. Please send " | |
1089 | "output of acpidump to linux-acpi@vger.kernel.org\n"); | |
1090 | kfree(saved_ec); | |
1091 | saved_ec = NULL; | |
1092 | } else { | |
1093 | /* We really need to limit this workaround, the only ASUS, | |
1094 | * which needs it, has fake EC._INI method, so use it as flag. | |
1095 | * Keep boot_ec struct as it will be needed soon. | |
1096 | */ | |
c6cb0e87 | 1097 | if (!dmi_name_in_vendors("ASUS") || |
952c63e9 | 1098 | !acpi_has_method(boot_ec->handle, "_INI")) |
c6cb0e87 AS |
1099 | return -ENODEV; |
1100 | } | |
c5279dee AS |
1101 | install: |
1102 | if (!ec_install_handlers(boot_ec)) { | |
d033879c | 1103 | first_ec = boot_ec; |
e8284321 | 1104 | return 0; |
d033879c | 1105 | } |
c5279dee | 1106 | error: |
d66d969d AS |
1107 | kfree(boot_ec); |
1108 | boot_ec = NULL; | |
1da177e4 LT |
1109 | return -ENODEV; |
1110 | } | |
1111 | ||
223883b7 AS |
1112 | static struct acpi_driver acpi_ec_driver = { |
1113 | .name = "ec", | |
1114 | .class = ACPI_EC_CLASS, | |
1115 | .ids = ec_device_ids, | |
1116 | .ops = { | |
1117 | .add = acpi_ec_add, | |
1118 | .remove = acpi_ec_remove, | |
223883b7 AS |
1119 | }, |
1120 | }; | |
1121 | ||
a5f820fe | 1122 | int __init acpi_ec_init(void) |
1da177e4 | 1123 | { |
50526df6 | 1124 | int result = 0; |
1da177e4 | 1125 | |
1da177e4 LT |
1126 | /* Now register the driver for the EC */ |
1127 | result = acpi_bus_register_driver(&acpi_ec_driver); | |
49c6c5ff | 1128 | if (result < 0) |
d550d98d | 1129 | return -ENODEV; |
1da177e4 | 1130 | |
d550d98d | 1131 | return result; |
1da177e4 LT |
1132 | } |
1133 | ||
1da177e4 LT |
1134 | /* EC driver currently not unloadable */ |
1135 | #if 0 | |
50526df6 | 1136 | static void __exit acpi_ec_exit(void) |
1da177e4 | 1137 | { |
1da177e4 LT |
1138 | |
1139 | acpi_bus_unregister_driver(&acpi_ec_driver); | |
d550d98d | 1140 | return; |
1da177e4 | 1141 | } |
7843932a | 1142 | #endif /* 0 */ |