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