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