]>
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 | |
c0d65341 | 203 | static bool 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 | } | |
238 | return wakeup; | |
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; |
c0d65341 | 254 | return wakeup; |
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 | } | |
c0d65341 | 265 | return wakeup; |
f92fca00 | 266 | } |
a3cd8d27 | 267 | |
f92fca00 LZ |
268 | static void start_transaction(struct acpi_ec *ec) |
269 | { | |
270 | ec->curr->irq_count = ec->curr->wi = ec->curr->ri = 0; | |
271 | ec->curr->flags = 0; | |
c0d65341 | 272 | (void)advance_transaction(ec); |
845625cd | 273 | } |
03d1d99c | 274 | |
3eba563e | 275 | static int acpi_ec_sync_query(struct acpi_ec *ec, u8 *data); |
7c6db4e0 | 276 | |
a62e8f19 | 277 | static int ec_check_sci_sync(struct acpi_ec *ec, u8 state) |
7c6db5e5 | 278 | { |
7c6db4e0 AS |
279 | if (state & ACPI_EC_FLAG_SCI) { |
280 | if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags)) | |
3eba563e | 281 | return acpi_ec_sync_query(ec, NULL); |
7c6db4e0 AS |
282 | } |
283 | return 0; | |
284 | } | |
285 | ||
286 | static int ec_poll(struct acpi_ec *ec) | |
287 | { | |
2a84cb98 | 288 | unsigned long flags; |
28fe5c82 | 289 | int repeat = 5; /* number of command restarts */ |
7a73e60e | 290 | |
2a84cb98 AS |
291 | while (repeat--) { |
292 | unsigned long delay = jiffies + | |
7a18e96d | 293 | msecs_to_jiffies(ec_delay); |
2a84cb98 AS |
294 | do { |
295 | /* don't sleep with disabled interrupts */ | |
296 | if (EC_FLAGS_MSI || irqs_disabled()) { | |
297 | udelay(ACPI_EC_MSI_UDELAY); | |
f92fca00 | 298 | if (ec_transaction_completed(ec)) |
2a84cb98 AS |
299 | return 0; |
300 | } else { | |
301 | if (wait_event_timeout(ec->wait, | |
f92fca00 | 302 | ec_transaction_completed(ec), |
2a84cb98 AS |
303 | msecs_to_jiffies(1))) |
304 | return 0; | |
305 | } | |
f92fca00 | 306 | spin_lock_irqsave(&ec->lock, flags); |
c0d65341 | 307 | (void)advance_transaction(ec); |
f92fca00 | 308 | spin_unlock_irqrestore(&ec->lock, flags); |
2a84cb98 | 309 | } while (time_before(jiffies, delay)); |
16a26e85 | 310 | pr_debug("controller reset, restart transaction\n"); |
f351d027 | 311 | spin_lock_irqsave(&ec->lock, flags); |
2a84cb98 | 312 | start_transaction(ec); |
f351d027 | 313 | spin_unlock_irqrestore(&ec->lock, flags); |
af3fd140 | 314 | } |
b77d81b2 | 315 | return -ETIME; |
1da177e4 LT |
316 | } |
317 | ||
8463200a | 318 | static int acpi_ec_transaction_unlocked(struct acpi_ec *ec, |
2a84cb98 | 319 | struct transaction *t) |
45bea155 | 320 | { |
7c6db4e0 | 321 | unsigned long tmp; |
7c6db4e0 | 322 | int ret = 0; |
7a73e60e | 323 | |
5423a0cb | 324 | if (EC_FLAGS_MSI) |
2a84cb98 | 325 | udelay(ACPI_EC_MSI_UDELAY); |
7c6db4e0 | 326 | /* start transaction */ |
f351d027 | 327 | spin_lock_irqsave(&ec->lock, tmp); |
7c6db4e0 | 328 | /* following two actions should be kept atomic */ |
8463200a | 329 | ec->curr = t; |
e34c0e2b LZ |
330 | pr_debug("***** Command(%s) started *****\n", |
331 | acpi_ec_cmd_string(t->command)); | |
a2f93aea | 332 | start_transaction(ec); |
d3090b6a | 333 | if (ec->curr->command == ACPI_EC_COMMAND_QUERY) { |
558e4736 | 334 | clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags); |
d3090b6a LZ |
335 | pr_debug("***** Event stopped *****\n"); |
336 | } | |
df9ff918 LZ |
337 | spin_unlock_irqrestore(&ec->lock, tmp); |
338 | ret = ec_poll(ec); | |
339 | spin_lock_irqsave(&ec->lock, tmp); | |
e34c0e2b LZ |
340 | pr_debug("***** Command(%s) stopped *****\n", |
341 | acpi_ec_cmd_string(t->command)); | |
8463200a | 342 | ec->curr = NULL; |
f351d027 | 343 | spin_unlock_irqrestore(&ec->lock, tmp); |
7c6db4e0 AS |
344 | return ret; |
345 | } | |
346 | ||
2a84cb98 | 347 | static int acpi_ec_transaction(struct acpi_ec *ec, struct transaction *t) |
1da177e4 | 348 | { |
d7a76e4c | 349 | int status; |
50526df6 | 350 | u32 glk; |
7a73e60e | 351 | |
8463200a | 352 | if (!ec || (!t) || (t->wlen && !t->wdata) || (t->rlen && !t->rdata)) |
d550d98d | 353 | return -EINVAL; |
8463200a AS |
354 | if (t->rdata) |
355 | memset(t->rdata, 0, t->rlen); | |
f351d027 | 356 | mutex_lock(&ec->mutex); |
fe955682 | 357 | if (test_bit(EC_FLAGS_BLOCKED, &ec->flags)) { |
f6bb13aa RW |
358 | status = -EINVAL; |
359 | goto unlock; | |
360 | } | |
703959d4 | 361 | if (ec->global_lock) { |
1da177e4 | 362 | status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk); |
c24e912b | 363 | if (ACPI_FAILURE(status)) { |
7c6db4e0 AS |
364 | status = -ENODEV; |
365 | goto unlock; | |
c24e912b | 366 | } |
1da177e4 | 367 | } |
a62e8f19 AS |
368 | /* disable GPE during transaction if storm is detected */ |
369 | if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) { | |
3784730b RW |
370 | /* It has to be disabled, so that it doesn't trigger. */ |
371 | acpi_disable_gpe(NULL, ec->gpe); | |
a62e8f19 AS |
372 | } |
373 | ||
2a84cb98 | 374 | status = acpi_ec_transaction_unlocked(ec, t); |
a62e8f19 AS |
375 | |
376 | /* check if we received SCI during transaction */ | |
377 | ec_check_sci_sync(ec, acpi_ec_read_status(ec)); | |
378 | if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) { | |
54070101 | 379 | msleep(1); |
3784730b RW |
380 | /* It is safe to enable the GPE outside of the transaction. */ |
381 | acpi_enable_gpe(NULL, ec->gpe); | |
a520d52e | 382 | } else if (t->irq_count > ec_storm_threshold) { |
16a26e85 | 383 | pr_info("GPE storm detected(%d GPEs), " |
b76b51ba FT |
384 | "transactions will use polling mode\n", |
385 | t->irq_count); | |
a62e8f19 AS |
386 | set_bit(EC_FLAGS_GPE_STORM, &ec->flags); |
387 | } | |
703959d4 | 388 | if (ec->global_lock) |
1da177e4 | 389 | acpi_release_global_lock(glk); |
7c6db4e0 | 390 | unlock: |
f351d027 | 391 | mutex_unlock(&ec->mutex); |
d550d98d | 392 | return status; |
1da177e4 LT |
393 | } |
394 | ||
8a383ef0 | 395 | static int acpi_ec_burst_enable(struct acpi_ec *ec) |
c45aac43 AS |
396 | { |
397 | u8 d; | |
8463200a AS |
398 | struct transaction t = {.command = ACPI_EC_BURST_ENABLE, |
399 | .wdata = NULL, .rdata = &d, | |
400 | .wlen = 0, .rlen = 1}; | |
401 | ||
2a84cb98 | 402 | return acpi_ec_transaction(ec, &t); |
c45aac43 AS |
403 | } |
404 | ||
8a383ef0 | 405 | static int acpi_ec_burst_disable(struct acpi_ec *ec) |
c45aac43 | 406 | { |
8463200a AS |
407 | struct transaction t = {.command = ACPI_EC_BURST_DISABLE, |
408 | .wdata = NULL, .rdata = NULL, | |
409 | .wlen = 0, .rlen = 0}; | |
410 | ||
7c6db4e0 | 411 | return (acpi_ec_read_status(ec) & ACPI_EC_FLAG_BURST) ? |
2a84cb98 | 412 | acpi_ec_transaction(ec, &t) : 0; |
c45aac43 AS |
413 | } |
414 | ||
7a73e60e | 415 | static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 *data) |
3576cf61 DS |
416 | { |
417 | int result; | |
418 | u8 d; | |
8463200a AS |
419 | struct transaction t = {.command = ACPI_EC_COMMAND_READ, |
420 | .wdata = &address, .rdata = &d, | |
421 | .wlen = 1, .rlen = 1}; | |
3576cf61 | 422 | |
2a84cb98 | 423 | result = acpi_ec_transaction(ec, &t); |
3576cf61 DS |
424 | *data = d; |
425 | return result; | |
426 | } | |
6ffb221a | 427 | |
3576cf61 DS |
428 | static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data) |
429 | { | |
6ccedb10 | 430 | u8 wdata[2] = { address, data }; |
8463200a AS |
431 | struct transaction t = {.command = ACPI_EC_COMMAND_WRITE, |
432 | .wdata = wdata, .rdata = NULL, | |
433 | .wlen = 2, .rlen = 0}; | |
434 | ||
2a84cb98 | 435 | return acpi_ec_transaction(ec, &t); |
3576cf61 DS |
436 | } |
437 | ||
b76b51ba | 438 | int ec_read(u8 addr, u8 *val) |
1da177e4 | 439 | { |
1da177e4 | 440 | int err; |
6ffb221a | 441 | u8 temp_data; |
1da177e4 LT |
442 | |
443 | if (!first_ec) | |
444 | return -ENODEV; | |
445 | ||
d033879c | 446 | err = acpi_ec_read(first_ec, addr, &temp_data); |
1da177e4 LT |
447 | |
448 | if (!err) { | |
449 | *val = temp_data; | |
450 | return 0; | |
7a73e60e LZ |
451 | } |
452 | return err; | |
1da177e4 LT |
453 | } |
454 | EXPORT_SYMBOL(ec_read); | |
455 | ||
50526df6 | 456 | int ec_write(u8 addr, u8 val) |
1da177e4 | 457 | { |
1da177e4 LT |
458 | int err; |
459 | ||
460 | if (!first_ec) | |
461 | return -ENODEV; | |
462 | ||
d033879c | 463 | err = acpi_ec_write(first_ec, addr, val); |
1da177e4 LT |
464 | |
465 | return err; | |
466 | } | |
467 | EXPORT_SYMBOL(ec_write); | |
468 | ||
616362de | 469 | int ec_transaction(u8 command, |
7a73e60e LZ |
470 | const u8 *wdata, unsigned wdata_len, |
471 | u8 *rdata, unsigned rdata_len) | |
45bea155 | 472 | { |
8463200a AS |
473 | struct transaction t = {.command = command, |
474 | .wdata = wdata, .rdata = rdata, | |
475 | .wlen = wdata_len, .rlen = rdata_len}; | |
7a73e60e | 476 | |
d7a76e4c LP |
477 | if (!first_ec) |
478 | return -ENODEV; | |
45bea155 | 479 | |
2a84cb98 | 480 | return acpi_ec_transaction(first_ec, &t); |
45bea155 | 481 | } |
ab9e43c6 LP |
482 | EXPORT_SYMBOL(ec_transaction); |
483 | ||
3e2abc5a SF |
484 | /* Get the handle to the EC device */ |
485 | acpi_handle ec_get_handle(void) | |
486 | { | |
487 | if (!first_ec) | |
488 | return NULL; | |
489 | return first_ec->handle; | |
490 | } | |
3e2abc5a SF |
491 | EXPORT_SYMBOL(ec_get_handle); |
492 | ||
ad332c8a | 493 | /* |
3eba563e | 494 | * Process _Q events that might have accumulated in the EC. |
ad332c8a KC |
495 | * Run with locked ec mutex. |
496 | */ | |
497 | static void acpi_ec_clear(struct acpi_ec *ec) | |
498 | { | |
499 | int i, status; | |
500 | u8 value = 0; | |
501 | ||
502 | for (i = 0; i < ACPI_EC_CLEAR_MAX; i++) { | |
3eba563e | 503 | status = acpi_ec_sync_query(ec, &value); |
ad332c8a KC |
504 | if (status || !value) |
505 | break; | |
506 | } | |
507 | ||
508 | if (unlikely(i == ACPI_EC_CLEAR_MAX)) | |
509 | pr_warn("Warning: Maximum of %d stale EC events cleared\n", i); | |
510 | else | |
511 | pr_info("%d stale EC events cleared\n", i); | |
512 | } | |
513 | ||
fe955682 | 514 | void acpi_ec_block_transactions(void) |
f6bb13aa RW |
515 | { |
516 | struct acpi_ec *ec = first_ec; | |
517 | ||
518 | if (!ec) | |
519 | return; | |
520 | ||
f351d027 | 521 | mutex_lock(&ec->mutex); |
f6bb13aa | 522 | /* Prevent transactions from being carried out */ |
fe955682 | 523 | set_bit(EC_FLAGS_BLOCKED, &ec->flags); |
f351d027 | 524 | mutex_unlock(&ec->mutex); |
f6bb13aa RW |
525 | } |
526 | ||
fe955682 | 527 | void acpi_ec_unblock_transactions(void) |
f6bb13aa RW |
528 | { |
529 | struct acpi_ec *ec = first_ec; | |
530 | ||
531 | if (!ec) | |
532 | return; | |
533 | ||
f351d027 | 534 | mutex_lock(&ec->mutex); |
f6bb13aa | 535 | /* Allow transactions to be carried out again */ |
fe955682 | 536 | clear_bit(EC_FLAGS_BLOCKED, &ec->flags); |
ad332c8a KC |
537 | |
538 | if (EC_FLAGS_CLEAR_ON_RESUME) | |
539 | acpi_ec_clear(ec); | |
540 | ||
f351d027 | 541 | mutex_unlock(&ec->mutex); |
f6bb13aa RW |
542 | } |
543 | ||
fe955682 | 544 | void acpi_ec_unblock_transactions_early(void) |
d5a64513 RW |
545 | { |
546 | /* | |
547 | * Allow transactions to happen again (this function is called from | |
548 | * atomic context during wakeup, so we don't need to acquire the mutex). | |
549 | */ | |
550 | if (first_ec) | |
fe955682 | 551 | clear_bit(EC_FLAGS_BLOCKED, &first_ec->flags); |
d5a64513 RW |
552 | } |
553 | ||
7a73e60e | 554 | static int acpi_ec_query_unlocked(struct acpi_ec *ec, u8 *data) |
3576cf61 DS |
555 | { |
556 | int result; | |
6ccedb10 | 557 | u8 d; |
8463200a AS |
558 | struct transaction t = {.command = ACPI_EC_COMMAND_QUERY, |
559 | .wdata = NULL, .rdata = &d, | |
560 | .wlen = 0, .rlen = 1}; | |
7a73e60e | 561 | |
6ccedb10 AS |
562 | if (!ec || !data) |
563 | return -EINVAL; | |
6ccedb10 AS |
564 | /* |
565 | * Query the EC to find out which _Qxx method we need to evaluate. | |
566 | * Note that successful completion of the query causes the ACPI_EC_SCI | |
567 | * bit to be cleared (and thus clearing the interrupt source). | |
568 | */ | |
a62e8f19 | 569 | result = acpi_ec_transaction_unlocked(ec, &t); |
6ccedb10 AS |
570 | if (result) |
571 | return result; | |
6ccedb10 AS |
572 | if (!d) |
573 | return -ENODATA; | |
6ccedb10 AS |
574 | *data = d; |
575 | return 0; | |
1da177e4 LT |
576 | } |
577 | ||
1da177e4 LT |
578 | /* -------------------------------------------------------------------------- |
579 | Event Management | |
580 | -------------------------------------------------------------------------- */ | |
837012ed AS |
581 | int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit, |
582 | acpi_handle handle, acpi_ec_query_func func, | |
583 | void *data) | |
584 | { | |
585 | struct acpi_ec_query_handler *handler = | |
586 | kzalloc(sizeof(struct acpi_ec_query_handler), GFP_KERNEL); | |
7a73e60e | 587 | |
837012ed AS |
588 | if (!handler) |
589 | return -ENOMEM; | |
590 | ||
591 | handler->query_bit = query_bit; | |
592 | handler->handle = handle; | |
593 | handler->func = func; | |
594 | handler->data = data; | |
f351d027 | 595 | mutex_lock(&ec->mutex); |
30c08574 | 596 | list_add(&handler->node, &ec->list); |
f351d027 | 597 | mutex_unlock(&ec->mutex); |
837012ed AS |
598 | return 0; |
599 | } | |
837012ed AS |
600 | EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler); |
601 | ||
602 | void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit) | |
603 | { | |
1544fdbc | 604 | struct acpi_ec_query_handler *handler, *tmp; |
7a73e60e | 605 | |
f351d027 | 606 | mutex_lock(&ec->mutex); |
1544fdbc | 607 | list_for_each_entry_safe(handler, tmp, &ec->list, node) { |
837012ed AS |
608 | if (query_bit == handler->query_bit) { |
609 | list_del(&handler->node); | |
610 | kfree(handler); | |
837012ed AS |
611 | } |
612 | } | |
f351d027 | 613 | mutex_unlock(&ec->mutex); |
837012ed | 614 | } |
837012ed | 615 | EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler); |
1da177e4 | 616 | |
a62e8f19 | 617 | static void acpi_ec_run(void *cxt) |
45bea155 | 618 | { |
a62e8f19 | 619 | struct acpi_ec_query_handler *handler = cxt; |
7a73e60e | 620 | |
a62e8f19 | 621 | if (!handler) |
e41334c0 | 622 | return; |
d3090b6a | 623 | pr_debug("##### Query(0x%02x) started #####\n", handler->query_bit); |
a62e8f19 AS |
624 | if (handler->func) |
625 | handler->func(handler->data); | |
626 | else if (handler->handle) | |
627 | acpi_evaluate_object(handler->handle, NULL, NULL, NULL); | |
d3090b6a | 628 | pr_debug("##### Query(0x%02x) stopped #####\n", handler->query_bit); |
a62e8f19 AS |
629 | kfree(handler); |
630 | } | |
631 | ||
3eba563e | 632 | static int acpi_ec_sync_query(struct acpi_ec *ec, u8 *data) |
a62e8f19 AS |
633 | { |
634 | u8 value = 0; | |
635 | int status; | |
636 | struct acpi_ec_query_handler *handler, *copy; | |
3eba563e KC |
637 | |
638 | status = acpi_ec_query_unlocked(ec, &value); | |
639 | if (data) | |
640 | *data = value; | |
641 | if (status) | |
a62e8f19 | 642 | return status; |
3eba563e | 643 | |
837012ed AS |
644 | list_for_each_entry(handler, &ec->list, node) { |
645 | if (value == handler->query_bit) { | |
646 | /* have custom handler for this bit */ | |
a62e8f19 AS |
647 | copy = kmalloc(sizeof(*handler), GFP_KERNEL); |
648 | if (!copy) | |
649 | return -ENOMEM; | |
650 | memcpy(copy, handler, sizeof(*copy)); | |
d3090b6a LZ |
651 | pr_debug("##### Query(0x%02x) scheduled #####\n", |
652 | handler->query_bit); | |
f5347867 AS |
653 | return acpi_os_execute((copy->func) ? |
654 | OSL_NOTIFY_HANDLER : OSL_GPE_HANDLER, | |
a62e8f19 | 655 | acpi_ec_run, copy); |
837012ed AS |
656 | } |
657 | } | |
a62e8f19 AS |
658 | return 0; |
659 | } | |
660 | ||
661 | static void acpi_ec_gpe_query(void *ec_cxt) | |
662 | { | |
663 | struct acpi_ec *ec = ec_cxt; | |
7a73e60e | 664 | |
a62e8f19 AS |
665 | if (!ec) |
666 | return; | |
f351d027 | 667 | mutex_lock(&ec->mutex); |
3eba563e | 668 | acpi_ec_sync_query(ec, NULL); |
f351d027 | 669 | mutex_unlock(&ec->mutex); |
45bea155 | 670 | } |
1da177e4 | 671 | |
a62e8f19 AS |
672 | static int ec_check_sci(struct acpi_ec *ec, u8 state) |
673 | { | |
674 | if (state & ACPI_EC_FLAG_SCI) { | |
675 | if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags)) { | |
d3090b6a | 676 | pr_debug("***** Event started *****\n"); |
a62e8f19 AS |
677 | return acpi_os_execute(OSL_NOTIFY_HANDLER, |
678 | acpi_ec_gpe_query, ec); | |
679 | } | |
680 | } | |
681 | return 0; | |
682 | } | |
683 | ||
8b6cd8ad LM |
684 | static u32 acpi_ec_gpe_handler(acpi_handle gpe_device, |
685 | u32 gpe_number, void *data) | |
1da177e4 | 686 | { |
f92fca00 | 687 | unsigned long flags; |
3d02b90b | 688 | struct acpi_ec *ec = data; |
7c6db4e0 | 689 | |
f92fca00 | 690 | spin_lock_irqsave(&ec->lock, flags); |
c0d65341 | 691 | if (advance_transaction(ec)) |
2a84cb98 | 692 | wake_up(&ec->wait); |
c0d65341 LZ |
693 | spin_unlock_irqrestore(&ec->lock, flags); |
694 | ec_check_sci(ec, acpi_ec_read_status(ec)); | |
bba63a29 | 695 | return ACPI_INTERRUPT_HANDLED | ACPI_REENABLE_GPE; |
845625cd AS |
696 | } |
697 | ||
1da177e4 | 698 | /* -------------------------------------------------------------------------- |
7a73e60e LZ |
699 | * Address Space Management |
700 | * -------------------------------------------------------------------------- */ | |
1da177e4 | 701 | |
1da177e4 | 702 | static acpi_status |
5b7734b4 | 703 | acpi_ec_space_handler(u32 function, acpi_physical_address address, |
dadf28a1 | 704 | u32 bits, u64 *value64, |
50526df6 | 705 | void *handler_context, void *region_context) |
1da177e4 | 706 | { |
3d02b90b | 707 | struct acpi_ec *ec = handler_context; |
dadf28a1 AS |
708 | int result = 0, i, bytes = bits / 8; |
709 | u8 *value = (u8 *)value64; | |
1da177e4 | 710 | |
1da177e4 | 711 | if ((address > 0xFF) || !value || !handler_context) |
d550d98d | 712 | return AE_BAD_PARAMETER; |
1da177e4 | 713 | |
5b7734b4 | 714 | if (function != ACPI_READ && function != ACPI_WRITE) |
d550d98d | 715 | return AE_BAD_PARAMETER; |
1da177e4 | 716 | |
dadf28a1 | 717 | if (EC_FLAGS_MSI || bits > 8) |
6a63b06f | 718 | acpi_ec_burst_enable(ec); |
b3b233c7 | 719 | |
dadf28a1 AS |
720 | for (i = 0; i < bytes; ++i, ++address, ++value) |
721 | result = (function == ACPI_READ) ? | |
722 | acpi_ec_read(ec, address, value) : | |
723 | acpi_ec_write(ec, address, *value); | |
1da177e4 | 724 | |
dadf28a1 | 725 | if (EC_FLAGS_MSI || bits > 8) |
6a63b06f | 726 | acpi_ec_burst_disable(ec); |
b3b233c7 | 727 | |
1da177e4 LT |
728 | switch (result) { |
729 | case -EINVAL: | |
d550d98d | 730 | return AE_BAD_PARAMETER; |
1da177e4 | 731 | case -ENODEV: |
d550d98d | 732 | return AE_NOT_FOUND; |
1da177e4 | 733 | case -ETIME: |
d550d98d | 734 | return AE_TIME; |
1da177e4 | 735 | default: |
d550d98d | 736 | return AE_OK; |
1da177e4 | 737 | } |
1da177e4 LT |
738 | } |
739 | ||
1da177e4 | 740 | /* -------------------------------------------------------------------------- |
7a73e60e LZ |
741 | * Driver Interface |
742 | * -------------------------------------------------------------------------- */ | |
743 | ||
c0900c35 AS |
744 | static acpi_status |
745 | ec_parse_io_ports(struct acpi_resource *resource, void *context); | |
746 | ||
c0900c35 AS |
747 | static struct acpi_ec *make_acpi_ec(void) |
748 | { | |
749 | struct acpi_ec *ec = kzalloc(sizeof(struct acpi_ec), GFP_KERNEL); | |
7a73e60e | 750 | |
c0900c35 AS |
751 | if (!ec) |
752 | return NULL; | |
080e412c | 753 | ec->flags = 1 << EC_FLAGS_QUERY_PENDING; |
f351d027 | 754 | mutex_init(&ec->mutex); |
c0900c35 | 755 | init_waitqueue_head(&ec->wait); |
837012ed | 756 | INIT_LIST_HEAD(&ec->list); |
f351d027 | 757 | spin_lock_init(&ec->lock); |
c0900c35 AS |
758 | return ec; |
759 | } | |
837012ed | 760 | |
c019b193 AS |
761 | static acpi_status |
762 | acpi_ec_register_query_methods(acpi_handle handle, u32 level, | |
763 | void *context, void **return_value) | |
764 | { | |
0175d562 LM |
765 | char node_name[5]; |
766 | struct acpi_buffer buffer = { sizeof(node_name), node_name }; | |
c019b193 AS |
767 | struct acpi_ec *ec = context; |
768 | int value = 0; | |
0175d562 LM |
769 | acpi_status status; |
770 | ||
771 | status = acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer); | |
772 | ||
7a73e60e | 773 | if (ACPI_SUCCESS(status) && sscanf(node_name, "_Q%x", &value) == 1) |
c019b193 | 774 | acpi_ec_add_query_handler(ec, value, handle, NULL, NULL); |
c019b193 AS |
775 | return AE_OK; |
776 | } | |
777 | ||
cd8c93a4 AS |
778 | static acpi_status |
779 | ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval) | |
837012ed | 780 | { |
cd8c93a4 | 781 | acpi_status status; |
d21cf3c1 | 782 | unsigned long long tmp = 0; |
cd8c93a4 | 783 | struct acpi_ec *ec = context; |
a5032bfd AS |
784 | |
785 | /* clear addr values, ec_parse_io_ports depend on it */ | |
786 | ec->command_addr = ec->data_addr = 0; | |
787 | ||
cd8c93a4 AS |
788 | status = acpi_walk_resources(handle, METHOD_NAME__CRS, |
789 | ec_parse_io_ports, ec); | |
790 | if (ACPI_FAILURE(status)) | |
791 | return status; | |
837012ed AS |
792 | |
793 | /* Get GPE bit assignment (EC events). */ | |
794 | /* TODO: Add support for _GPE returning a package */ | |
27663c58 | 795 | status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp); |
cd8c93a4 AS |
796 | if (ACPI_FAILURE(status)) |
797 | return status; | |
27663c58 | 798 | ec->gpe = tmp; |
837012ed | 799 | /* Use the global lock for all EC transactions? */ |
d21cf3c1 | 800 | tmp = 0; |
27663c58 MW |
801 | acpi_evaluate_integer(handle, "_GLK", NULL, &tmp); |
802 | ec->global_lock = tmp; | |
837012ed | 803 | ec->handle = handle; |
cd8c93a4 | 804 | return AE_CTRL_TERMINATE; |
837012ed AS |
805 | } |
806 | ||
5efc5476 BH |
807 | static int ec_install_handlers(struct acpi_ec *ec) |
808 | { | |
809 | acpi_status status; | |
7a73e60e | 810 | |
5efc5476 BH |
811 | if (test_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags)) |
812 | return 0; | |
813 | status = acpi_install_gpe_handler(NULL, ec->gpe, | |
814 | ACPI_GPE_EDGE_TRIGGERED, | |
815 | &acpi_ec_gpe_handler, ec); | |
816 | if (ACPI_FAILURE(status)) | |
817 | return -ENODEV; | |
9630bdd9 | 818 | |
a44061aa | 819 | acpi_enable_gpe(NULL, ec->gpe); |
5efc5476 BH |
820 | status = acpi_install_address_space_handler(ec->handle, |
821 | ACPI_ADR_SPACE_EC, | |
822 | &acpi_ec_space_handler, | |
823 | NULL, ec); | |
824 | if (ACPI_FAILURE(status)) { | |
825 | if (status == AE_NOT_FOUND) { | |
826 | /* | |
827 | * Maybe OS fails in evaluating the _REG object. | |
828 | * The AE_NOT_FOUND error will be ignored and OS | |
829 | * continue to initialize EC. | |
830 | */ | |
16a26e85 | 831 | pr_err("Fail in evaluating the _REG object" |
5efc5476 BH |
832 | " of EC device. Broken bios is suspected.\n"); |
833 | } else { | |
42b946bb | 834 | acpi_disable_gpe(NULL, ec->gpe); |
5efc5476 BH |
835 | acpi_remove_gpe_handler(NULL, ec->gpe, |
836 | &acpi_ec_gpe_handler); | |
837 | return -ENODEV; | |
838 | } | |
839 | } | |
840 | ||
841 | set_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags); | |
842 | return 0; | |
843 | } | |
844 | ||
4c611060 AS |
845 | static void ec_remove_handlers(struct acpi_ec *ec) |
846 | { | |
a44061aa | 847 | acpi_disable_gpe(NULL, ec->gpe); |
4c611060 AS |
848 | if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle, |
849 | ACPI_ADR_SPACE_EC, &acpi_ec_space_handler))) | |
16a26e85 | 850 | pr_err("failed to remove space handler\n"); |
4c611060 AS |
851 | if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe, |
852 | &acpi_ec_gpe_handler))) | |
16a26e85 | 853 | pr_err("failed to remove gpe handler\n"); |
7c6db4e0 | 854 | clear_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags); |
4c611060 AS |
855 | } |
856 | ||
703959d4 | 857 | static int acpi_ec_add(struct acpi_device *device) |
1da177e4 | 858 | { |
703959d4 | 859 | struct acpi_ec *ec = NULL; |
d02be047 | 860 | int ret; |
45bea155 | 861 | |
c0900c35 AS |
862 | strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME); |
863 | strcpy(acpi_device_class(device), ACPI_EC_CLASS); | |
864 | ||
4c611060 | 865 | /* Check for boot EC */ |
ce52ddf5 AS |
866 | if (boot_ec && |
867 | (boot_ec->handle == device->handle || | |
868 | boot_ec->handle == ACPI_ROOT_OBJECT)) { | |
869 | ec = boot_ec; | |
870 | boot_ec = NULL; | |
871 | } else { | |
872 | ec = make_acpi_ec(); | |
873 | if (!ec) | |
874 | return -ENOMEM; | |
a5032bfd AS |
875 | } |
876 | if (ec_parse_device(device->handle, 0, ec, NULL) != | |
877 | AE_CTRL_TERMINATE) { | |
ce52ddf5 AS |
878 | kfree(ec); |
879 | return -EINVAL; | |
4c611060 AS |
880 | } |
881 | ||
ce52ddf5 AS |
882 | /* Find and register all query methods */ |
883 | acpi_walk_namespace(ACPI_TYPE_METHOD, ec->handle, 1, | |
2263576c | 884 | acpi_ec_register_query_methods, NULL, ec, NULL); |
ce52ddf5 | 885 | |
4c611060 AS |
886 | if (!first_ec) |
887 | first_ec = ec; | |
db89b4f0 | 888 | device->driver_data = ec; |
de4f1046 | 889 | |
d6795fe3 AK |
890 | ret = !!request_region(ec->data_addr, 1, "EC data"); |
891 | WARN(!ret, "Could not request EC data io port 0x%lx", ec->data_addr); | |
892 | ret = !!request_region(ec->command_addr, 1, "EC cmd"); | |
893 | WARN(!ret, "Could not request EC cmd io port 0x%lx", ec->command_addr); | |
de4f1046 | 894 | |
16a26e85 | 895 | pr_info("GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n", |
4c611060 | 896 | ec->gpe, ec->command_addr, ec->data_addr); |
5efc5476 BH |
897 | |
898 | ret = ec_install_handlers(ec); | |
899 | ||
900 | /* EC is fully operational, allow queries */ | |
901 | clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags); | |
ad332c8a KC |
902 | |
903 | /* Clear stale _Q events if hardware might require that */ | |
904 | if (EC_FLAGS_CLEAR_ON_RESUME) { | |
905 | mutex_lock(&ec->mutex); | |
906 | acpi_ec_clear(ec); | |
907 | mutex_unlock(&ec->mutex); | |
908 | } | |
5efc5476 | 909 | return ret; |
1da177e4 LT |
910 | } |
911 | ||
51fac838 | 912 | static int acpi_ec_remove(struct acpi_device *device) |
1da177e4 | 913 | { |
01f22462 | 914 | struct acpi_ec *ec; |
07ddf768 | 915 | struct acpi_ec_query_handler *handler, *tmp; |
1da177e4 | 916 | |
1da177e4 | 917 | if (!device) |
d550d98d | 918 | return -EINVAL; |
1da177e4 LT |
919 | |
920 | ec = acpi_driver_data(device); | |
cf745ec7 | 921 | ec_remove_handlers(ec); |
f351d027 | 922 | mutex_lock(&ec->mutex); |
07ddf768 | 923 | list_for_each_entry_safe(handler, tmp, &ec->list, node) { |
837012ed AS |
924 | list_del(&handler->node); |
925 | kfree(handler); | |
926 | } | |
f351d027 | 927 | mutex_unlock(&ec->mutex); |
de4f1046 TR |
928 | release_region(ec->data_addr, 1); |
929 | release_region(ec->command_addr, 1); | |
db89b4f0 | 930 | device->driver_data = NULL; |
d033879c | 931 | if (ec == first_ec) |
c0900c35 | 932 | first_ec = NULL; |
4c611060 | 933 | kfree(ec); |
d550d98d | 934 | return 0; |
1da177e4 LT |
935 | } |
936 | ||
1da177e4 | 937 | static acpi_status |
c0900c35 | 938 | ec_parse_io_ports(struct acpi_resource *resource, void *context) |
1da177e4 | 939 | { |
3d02b90b | 940 | struct acpi_ec *ec = context; |
1da177e4 | 941 | |
01f22462 | 942 | if (resource->type != ACPI_RESOURCE_TYPE_IO) |
1da177e4 | 943 | return AE_OK; |
1da177e4 LT |
944 | |
945 | /* | |
946 | * The first address region returned is the data port, and | |
947 | * the second address region returned is the status/command | |
948 | * port. | |
949 | */ | |
de4f1046 | 950 | if (ec->data_addr == 0) |
6ffb221a | 951 | ec->data_addr = resource->data.io.minimum; |
de4f1046 | 952 | else if (ec->command_addr == 0) |
6ffb221a | 953 | ec->command_addr = resource->data.io.minimum; |
01f22462 | 954 | else |
1da177e4 | 955 | return AE_CTRL_TERMINATE; |
1da177e4 | 956 | |
1da177e4 LT |
957 | return AE_OK; |
958 | } | |
959 | ||
c04209a7 AS |
960 | int __init acpi_boot_ec_enable(void) |
961 | { | |
7c6db4e0 | 962 | if (!boot_ec || test_bit(EC_FLAGS_HANDLERS_INSTALLED, &boot_ec->flags)) |
c04209a7 AS |
963 | return 0; |
964 | if (!ec_install_handlers(boot_ec)) { | |
965 | first_ec = boot_ec; | |
966 | return 0; | |
967 | } | |
968 | return -EFAULT; | |
969 | } | |
970 | ||
223883b7 AS |
971 | static const struct acpi_device_id ec_device_ids[] = { |
972 | {"PNP0C09", 0}, | |
973 | {"", 0}, | |
974 | }; | |
975 | ||
478fa03b AS |
976 | /* Some BIOS do not survive early DSDT scan, skip it */ |
977 | static int ec_skip_dsdt_scan(const struct dmi_system_id *id) | |
978 | { | |
979 | EC_FLAGS_SKIP_DSDT_SCAN = 1; | |
980 | return 0; | |
981 | } | |
982 | ||
0adf3c74 AS |
983 | /* ASUStek often supplies us with broken ECDT, validate it */ |
984 | static int ec_validate_ecdt(const struct dmi_system_id *id) | |
985 | { | |
986 | EC_FLAGS_VALIDATE_ECDT = 1; | |
987 | return 0; | |
988 | } | |
989 | ||
990 | /* MSI EC needs special treatment, enable it */ | |
991 | static int ec_flag_msi(const struct dmi_system_id *id) | |
992 | { | |
16a26e85 | 993 | pr_debug("Detected MSI hardware, enabling workarounds.\n"); |
0adf3c74 AS |
994 | EC_FLAGS_MSI = 1; |
995 | EC_FLAGS_VALIDATE_ECDT = 1; | |
996 | return 0; | |
997 | } | |
998 | ||
67bfa9b6 FT |
999 | /* |
1000 | * Clevo M720 notebook actually works ok with IRQ mode, if we lifted | |
1001 | * the GPE storm threshold back to 20 | |
1002 | */ | |
1003 | static int ec_enlarge_storm_threshold(const struct dmi_system_id *id) | |
1004 | { | |
1005 | pr_debug("Setting the EC GPE storm threshold to 20\n"); | |
1006 | ec_storm_threshold = 20; | |
1007 | return 0; | |
1008 | } | |
1009 | ||
79149001 LZ |
1010 | /* |
1011 | * Acer EC firmware refuses to respond QR_EC when SCI_EVT is not set, for | |
1012 | * which case, we complete the QR_EC without issuing it to the firmware. | |
1013 | * https://bugzilla.kernel.org/show_bug.cgi?id=86211 | |
1014 | */ | |
1015 | static int ec_flag_query_handshake(const struct dmi_system_id *id) | |
1016 | { | |
1017 | pr_debug("Detected the EC firmware requiring QR_EC issued when SCI_EVT set\n"); | |
1018 | EC_FLAGS_QUERY_HANDSHAKE = 1; | |
1019 | return 0; | |
1020 | } | |
1021 | ||
ad332c8a KC |
1022 | /* |
1023 | * On some hardware it is necessary to clear events accumulated by the EC during | |
1024 | * sleep. These ECs stop reporting GPEs until they are manually polled, if too | |
1025 | * many events are accumulated. (e.g. Samsung Series 5/9 notebooks) | |
1026 | * | |
1027 | * https://bugzilla.kernel.org/show_bug.cgi?id=44161 | |
1028 | * | |
1029 | * Ideally, the EC should also be instructed NOT to accumulate events during | |
1030 | * sleep (which Windows seems to do somehow), but the interface to control this | |
1031 | * behaviour is not known at this time. | |
1032 | * | |
1033 | * Models known to be affected are Samsung 530Uxx/535Uxx/540Uxx/550Pxx/900Xxx, | |
1034 | * however it is very likely that other Samsung models are affected. | |
1035 | * | |
1036 | * On systems which don't accumulate _Q events during sleep, this extra check | |
1037 | * should be harmless. | |
1038 | */ | |
1039 | static int ec_clear_on_resume(const struct dmi_system_id *id) | |
1040 | { | |
1041 | pr_debug("Detected system needing EC poll on resume.\n"); | |
1042 | EC_FLAGS_CLEAR_ON_RESUME = 1; | |
1043 | return 0; | |
1044 | } | |
1045 | ||
6cef7497 | 1046 | static struct dmi_system_id ec_dmi_table[] __initdata = { |
478fa03b AS |
1047 | { |
1048 | ec_skip_dsdt_scan, "Compal JFL92", { | |
1049 | DMI_MATCH(DMI_BIOS_VENDOR, "COMPAL"), | |
1050 | DMI_MATCH(DMI_BOARD_NAME, "JFL92") }, NULL}, | |
0adf3c74 AS |
1051 | { |
1052 | ec_flag_msi, "MSI hardware", { | |
55b313f2 AS |
1053 | DMI_MATCH(DMI_BIOS_VENDOR, "Micro-Star")}, NULL}, |
1054 | { | |
1055 | ec_flag_msi, "MSI hardware", { | |
1056 | DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star")}, NULL}, | |
1057 | { | |
1058 | ec_flag_msi, "MSI hardware", { | |
1059 | DMI_MATCH(DMI_CHASSIS_VENDOR, "MICRO-Star")}, NULL}, | |
0adf3c74 | 1060 | { |
a5dc4f89 AS |
1061 | ec_flag_msi, "MSI hardware", { |
1062 | DMI_MATCH(DMI_CHASSIS_VENDOR, "MICRO-STAR")}, NULL}, | |
1063 | { | |
534bc4e3 ZR |
1064 | ec_flag_msi, "Quanta hardware", { |
1065 | DMI_MATCH(DMI_SYS_VENDOR, "Quanta"), | |
1066 | DMI_MATCH(DMI_PRODUCT_NAME, "TW8/SW8/DW8"),}, NULL}, | |
1067 | { | |
1068 | ec_flag_msi, "Quanta hardware", { | |
1069 | DMI_MATCH(DMI_SYS_VENDOR, "Quanta"), | |
1070 | DMI_MATCH(DMI_PRODUCT_NAME, "TW9/SW9"),}, NULL}, | |
1071 | { | |
777cb382 LT |
1072 | ec_flag_msi, "Clevo W350etq", { |
1073 | DMI_MATCH(DMI_SYS_VENDOR, "CLEVO CO."), | |
1074 | DMI_MATCH(DMI_PRODUCT_NAME, "W35_37ET"),}, NULL}, | |
1075 | { | |
0adf3c74 AS |
1076 | ec_validate_ecdt, "ASUS hardware", { |
1077 | DMI_MATCH(DMI_BIOS_VENDOR, "ASUS") }, NULL}, | |
af986d10 PC |
1078 | { |
1079 | ec_validate_ecdt, "ASUS hardware", { | |
1080 | DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer Inc.") }, NULL}, | |
67bfa9b6 FT |
1081 | { |
1082 | ec_enlarge_storm_threshold, "CLEVO hardware", { | |
1083 | DMI_MATCH(DMI_SYS_VENDOR, "CLEVO Co."), | |
1084 | DMI_MATCH(DMI_PRODUCT_NAME, "M720T/M730T"),}, NULL}, | |
eff9a4b6 LT |
1085 | { |
1086 | ec_skip_dsdt_scan, "HP Folio 13", { | |
1087 | DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"), | |
1088 | DMI_MATCH(DMI_PRODUCT_NAME, "HP Folio 13"),}, NULL}, | |
524f42fa LT |
1089 | { |
1090 | ec_validate_ecdt, "ASUS hardware", { | |
1091 | DMI_MATCH(DMI_SYS_VENDOR, "ASUSTek Computer Inc."), | |
1092 | DMI_MATCH(DMI_PRODUCT_NAME, "L4R"),}, NULL}, | |
ad332c8a KC |
1093 | { |
1094 | ec_clear_on_resume, "Samsung hardware", { | |
1095 | DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD.")}, NULL}, | |
79149001 LZ |
1096 | { |
1097 | ec_flag_query_handshake, "Acer hardware", { | |
1098 | DMI_MATCH(DMI_SYS_VENDOR, "Acer"), }, NULL}, | |
0adf3c74 AS |
1099 | {}, |
1100 | }; | |
1101 | ||
c0900c35 AS |
1102 | int __init acpi_ec_ecdt_probe(void) |
1103 | { | |
c0900c35 | 1104 | acpi_status status; |
c6cb0e87 | 1105 | struct acpi_ec *saved_ec = NULL; |
50526df6 | 1106 | struct acpi_table_ecdt *ecdt_ptr; |
45bea155 | 1107 | |
d66d969d AS |
1108 | boot_ec = make_acpi_ec(); |
1109 | if (!boot_ec) | |
c0900c35 AS |
1110 | return -ENOMEM; |
1111 | /* | |
1112 | * Generate a boot ec context | |
1113 | */ | |
0adf3c74 | 1114 | dmi_check_system(ec_dmi_table); |
15a58ed1 AS |
1115 | status = acpi_get_table(ACPI_SIG_ECDT, 1, |
1116 | (struct acpi_table_header **)&ecdt_ptr); | |
cd8c93a4 | 1117 | if (ACPI_SUCCESS(status)) { |
16a26e85 | 1118 | pr_info("EC description table is found, configuring boot EC\n"); |
cd8c93a4 AS |
1119 | boot_ec->command_addr = ecdt_ptr->control.address; |
1120 | boot_ec->data_addr = ecdt_ptr->data.address; | |
1121 | boot_ec->gpe = ecdt_ptr->gpe; | |
4af8e10a | 1122 | boot_ec->handle = ACPI_ROOT_OBJECT; |
7a73e60e LZ |
1123 | acpi_get_handle(ACPI_ROOT_OBJECT, ecdt_ptr->id, |
1124 | &boot_ec->handle); | |
c6cb0e87 | 1125 | /* Don't trust ECDT, which comes from ASUSTek */ |
0adf3c74 | 1126 | if (!EC_FLAGS_VALIDATE_ECDT) |
c5279dee | 1127 | goto install; |
d6bd535d | 1128 | saved_ec = kmemdup(boot_ec, sizeof(struct acpi_ec), GFP_KERNEL); |
c6cb0e87 AS |
1129 | if (!saved_ec) |
1130 | return -ENOMEM; | |
c5279dee | 1131 | /* fall through */ |
cd8c93a4 | 1132 | } |
0adf3c74 | 1133 | |
ed4b197d CIK |
1134 | if (EC_FLAGS_SKIP_DSDT_SCAN) { |
1135 | kfree(saved_ec); | |
478fa03b | 1136 | return -ENODEV; |
ed4b197d | 1137 | } |
478fa03b | 1138 | |
c5279dee AS |
1139 | /* This workaround is needed only on some broken machines, |
1140 | * which require early EC, but fail to provide ECDT */ | |
16a26e85 | 1141 | pr_debug("Look up EC in DSDT\n"); |
c5279dee AS |
1142 | status = acpi_get_devices(ec_device_ids[0].id, ec_parse_device, |
1143 | boot_ec, NULL); | |
1144 | /* Check that acpi_get_devices actually find something */ | |
1145 | if (ACPI_FAILURE(status) || !boot_ec->handle) | |
1146 | goto error; | |
c6cb0e87 AS |
1147 | if (saved_ec) { |
1148 | /* try to find good ECDT from ASUSTek */ | |
1149 | if (saved_ec->command_addr != boot_ec->command_addr || | |
1150 | saved_ec->data_addr != boot_ec->data_addr || | |
1151 | saved_ec->gpe != boot_ec->gpe || | |
1152 | saved_ec->handle != boot_ec->handle) | |
16a26e85 | 1153 | pr_info("ASUSTek keeps feeding us with broken " |
c6cb0e87 AS |
1154 | "ECDT tables, which are very hard to workaround. " |
1155 | "Trying to use DSDT EC info instead. Please send " | |
1156 | "output of acpidump to linux-acpi@vger.kernel.org\n"); | |
1157 | kfree(saved_ec); | |
1158 | saved_ec = NULL; | |
1159 | } else { | |
1160 | /* We really need to limit this workaround, the only ASUS, | |
1161 | * which needs it, has fake EC._INI method, so use it as flag. | |
1162 | * Keep boot_ec struct as it will be needed soon. | |
1163 | */ | |
c6cb0e87 | 1164 | if (!dmi_name_in_vendors("ASUS") || |
952c63e9 | 1165 | !acpi_has_method(boot_ec->handle, "_INI")) |
c6cb0e87 AS |
1166 | return -ENODEV; |
1167 | } | |
c5279dee AS |
1168 | install: |
1169 | if (!ec_install_handlers(boot_ec)) { | |
d033879c | 1170 | first_ec = boot_ec; |
e8284321 | 1171 | return 0; |
d033879c | 1172 | } |
c5279dee | 1173 | error: |
d66d969d | 1174 | kfree(boot_ec); |
ed4b197d | 1175 | kfree(saved_ec); |
d66d969d | 1176 | boot_ec = NULL; |
1da177e4 LT |
1177 | return -ENODEV; |
1178 | } | |
1179 | ||
223883b7 AS |
1180 | static struct acpi_driver acpi_ec_driver = { |
1181 | .name = "ec", | |
1182 | .class = ACPI_EC_CLASS, | |
1183 | .ids = ec_device_ids, | |
1184 | .ops = { | |
1185 | .add = acpi_ec_add, | |
1186 | .remove = acpi_ec_remove, | |
223883b7 AS |
1187 | }, |
1188 | }; | |
1189 | ||
a5f820fe | 1190 | int __init acpi_ec_init(void) |
1da177e4 | 1191 | { |
50526df6 | 1192 | int result = 0; |
1da177e4 | 1193 | |
1da177e4 LT |
1194 | /* Now register the driver for the EC */ |
1195 | result = acpi_bus_register_driver(&acpi_ec_driver); | |
49c6c5ff | 1196 | if (result < 0) |
d550d98d | 1197 | return -ENODEV; |
1da177e4 | 1198 | |
d550d98d | 1199 | return result; |
1da177e4 LT |
1200 | } |
1201 | ||
1da177e4 LT |
1202 | /* EC driver currently not unloadable */ |
1203 | #if 0 | |
50526df6 | 1204 | static void __exit acpi_ec_exit(void) |
1da177e4 | 1205 | { |
1da177e4 LT |
1206 | |
1207 | acpi_bus_unregister_driver(&acpi_ec_driver); | |
1da177e4 | 1208 | } |
7843932a | 1209 | #endif /* 0 */ |