]>
Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
a8d4fc22 | 2 | * ec.c - ACPI Embedded Controller Driver (v3) |
1da177e4 | 3 | * |
a8d4fc22 LZ |
4 | * Copyright (C) 2001-2015 Intel Corporation |
5 | * Author: 2014, 2015 Lv Zheng <lv.zheng@intel.com> | |
4a3f6b5b LZ |
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 | |
1d68d261 LZ |
62 | /* |
63 | * The SCI_EVT clearing timing is not defined by the ACPI specification. | |
64 | * This leads to lots of practical timing issues for the host EC driver. | |
65 | * The following variations are defined (from the target EC firmware's | |
66 | * perspective): | |
67 | * STATUS: After indicating SCI_EVT edge triggered IRQ to the host, the | |
68 | * target can clear SCI_EVT at any time so long as the host can see | |
69 | * the indication by reading the status register (EC_SC). So the | |
70 | * host should re-check SCI_EVT after the first time the SCI_EVT | |
71 | * indication is seen, which is the same time the query request | |
72 | * (QR_EC) is written to the command register (EC_CMD). SCI_EVT set | |
73 | * at any later time could indicate another event. Normally such | |
74 | * kind of EC firmware has implemented an event queue and will | |
75 | * return 0x00 to indicate "no outstanding event". | |
76 | * QUERY: After seeing the query request (QR_EC) written to the command | |
77 | * register (EC_CMD) by the host and having prepared the responding | |
78 | * event value in the data register (EC_DATA), the target can safely | |
79 | * clear SCI_EVT because the target can confirm that the current | |
80 | * event is being handled by the host. The host then should check | |
81 | * SCI_EVT right after reading the event response from the data | |
82 | * register (EC_DATA). | |
83 | * EVENT: After seeing the event response read from the data register | |
84 | * (EC_DATA) by the host, the target can clear SCI_EVT. As the | |
85 | * target requires time to notice the change in the data register | |
86 | * (EC_DATA), the host may be required to wait additional guarding | |
87 | * time before checking the SCI_EVT again. Such guarding may not be | |
88 | * necessary if the host is notified via another IRQ. | |
89 | */ | |
90 | #define ACPI_EC_EVT_TIMING_STATUS 0x00 | |
91 | #define ACPI_EC_EVT_TIMING_QUERY 0x01 | |
92 | #define ACPI_EC_EVT_TIMING_EVENT 0x02 | |
93 | ||
703959d4 | 94 | /* EC commands */ |
3261ff4d | 95 | enum ec_command { |
6ccedb10 AS |
96 | ACPI_EC_COMMAND_READ = 0x80, |
97 | ACPI_EC_COMMAND_WRITE = 0x81, | |
98 | ACPI_EC_BURST_ENABLE = 0x82, | |
99 | ACPI_EC_BURST_DISABLE = 0x83, | |
100 | ACPI_EC_COMMAND_QUERY = 0x84, | |
3261ff4d | 101 | }; |
837012ed | 102 | |
5c406412 | 103 | #define ACPI_EC_DELAY 500 /* Wait 500ms max. during EC ops */ |
703959d4 | 104 | #define ACPI_EC_UDELAY_GLK 1000 /* Wait 1ms max. to get global lock */ |
d8d031a6 | 105 | #define ACPI_EC_UDELAY_POLL 550 /* Wait 1ms for EC transaction polling */ |
ad332c8a KC |
106 | #define ACPI_EC_CLEAR_MAX 100 /* Maximum number of events to query |
107 | * when trying to clear the EC */ | |
703959d4 | 108 | |
080e412c | 109 | enum { |
37d11391 | 110 | EC_FLAGS_QUERY_PENDING, /* Query is pending */ |
1d68d261 | 111 | EC_FLAGS_QUERY_GUARDING, /* Guard for SCI_EVT check */ |
f6bb13aa | 112 | EC_FLAGS_HANDLERS_INSTALLED, /* Handlers for GPE and |
7c6db4e0 | 113 | * OpReg are installed */ |
ad479e7f LZ |
114 | EC_FLAGS_STARTED, /* Driver is started */ |
115 | EC_FLAGS_STOPPED, /* Driver is stopped */ | |
e1d4d90f LZ |
116 | EC_FLAGS_COMMAND_STORM, /* GPE storms occurred to the |
117 | * current command processing */ | |
1da177e4 | 118 | }; |
6ffb221a | 119 | |
f92fca00 LZ |
120 | #define ACPI_EC_COMMAND_POLL 0x01 /* Available for command byte */ |
121 | #define ACPI_EC_COMMAND_COMPLETE 0x02 /* Completed last byte */ | |
122 | ||
7a18e96d TR |
123 | /* ec.c is compiled in acpi namespace so this shows up as acpi.ec_delay param */ |
124 | static unsigned int ec_delay __read_mostly = ACPI_EC_DELAY; | |
125 | module_param(ec_delay, uint, 0644); | |
126 | MODULE_PARM_DESC(ec_delay, "Timeout(ms) waited until an EC command completes"); | |
127 | ||
15de603b LZ |
128 | static bool ec_busy_polling __read_mostly; |
129 | module_param(ec_busy_polling, bool, 0644); | |
130 | MODULE_PARM_DESC(ec_busy_polling, "Use busy polling to advance EC transaction"); | |
131 | ||
132 | static unsigned int ec_polling_guard __read_mostly = ACPI_EC_UDELAY_POLL; | |
133 | module_param(ec_polling_guard, uint, 0644); | |
134 | MODULE_PARM_DESC(ec_polling_guard, "Guard time(us) between EC accesses in polling modes"); | |
135 | ||
1d68d261 LZ |
136 | static unsigned int ec_event_clearing __read_mostly = ACPI_EC_EVT_TIMING_STATUS; |
137 | ||
a520d52e FT |
138 | /* |
139 | * If the number of false interrupts per one transaction exceeds | |
140 | * this threshold, will think there is a GPE storm happened and | |
141 | * will disable the GPE for normal transaction. | |
142 | */ | |
143 | static unsigned int ec_storm_threshold __read_mostly = 8; | |
144 | module_param(ec_storm_threshold, uint, 0644); | |
145 | MODULE_PARM_DESC(ec_storm_threshold, "Maxim false GPE numbers not considered as GPE storm"); | |
146 | ||
837012ed AS |
147 | struct acpi_ec_query_handler { |
148 | struct list_head node; | |
149 | acpi_ec_query_func func; | |
150 | acpi_handle handle; | |
151 | void *data; | |
152 | u8 query_bit; | |
01305d41 | 153 | struct kref kref; |
837012ed AS |
154 | }; |
155 | ||
8463200a | 156 | struct transaction { |
7c6db4e0 AS |
157 | const u8 *wdata; |
158 | u8 *rdata; | |
159 | unsigned short irq_count; | |
8463200a | 160 | u8 command; |
a2f93aea AS |
161 | u8 wi; |
162 | u8 ri; | |
7c6db4e0 AS |
163 | u8 wlen; |
164 | u8 rlen; | |
f92fca00 | 165 | u8 flags; |
7c6db4e0 AS |
166 | }; |
167 | ||
550b3aac | 168 | static int acpi_ec_query(struct acpi_ec *ec, u8 *data); |
ca37bfdf | 169 | static void advance_transaction(struct acpi_ec *ec); |
74443bbe | 170 | |
1195a098 TR |
171 | struct acpi_ec *boot_ec, *first_ec; |
172 | EXPORT_SYMBOL(first_ec); | |
703959d4 | 173 | |
0adf3c74 | 174 | static int EC_FLAGS_VALIDATE_ECDT; /* ASUStec ECDTs need to be validated */ |
478fa03b | 175 | static int EC_FLAGS_SKIP_DSDT_SCAN; /* Not all BIOS survive early DSDT scan */ |
ad332c8a | 176 | static int EC_FLAGS_CLEAR_ON_RESUME; /* Needs acpi_ec_clear() on boot/resume */ |
79149001 | 177 | static int EC_FLAGS_QUERY_HANDSHAKE; /* Needs QR_EC issued when SCI_EVT set */ |
5423a0cb | 178 | |
3535a3c1 LZ |
179 | /* -------------------------------------------------------------------------- |
180 | * Logging/Debugging | |
181 | * -------------------------------------------------------------------------- */ | |
182 | ||
183 | /* | |
184 | * Splitters used by the developers to track the boundary of the EC | |
185 | * handling processes. | |
186 | */ | |
187 | #ifdef DEBUG | |
188 | #define EC_DBG_SEP " " | |
189 | #define EC_DBG_DRV "+++++" | |
190 | #define EC_DBG_STM "=====" | |
191 | #define EC_DBG_REQ "*****" | |
192 | #define EC_DBG_EVT "#####" | |
193 | #else | |
194 | #define EC_DBG_SEP "" | |
195 | #define EC_DBG_DRV | |
196 | #define EC_DBG_STM | |
197 | #define EC_DBG_REQ | |
198 | #define EC_DBG_EVT | |
199 | #endif | |
200 | ||
201 | #define ec_log_raw(fmt, ...) \ | |
202 | pr_info(fmt "\n", ##__VA_ARGS__) | |
203 | #define ec_dbg_raw(fmt, ...) \ | |
204 | pr_debug(fmt "\n", ##__VA_ARGS__) | |
205 | #define ec_log(filter, fmt, ...) \ | |
206 | ec_log_raw(filter EC_DBG_SEP fmt EC_DBG_SEP filter, ##__VA_ARGS__) | |
207 | #define ec_dbg(filter, fmt, ...) \ | |
208 | ec_dbg_raw(filter EC_DBG_SEP fmt EC_DBG_SEP filter, ##__VA_ARGS__) | |
209 | ||
210 | #define ec_log_drv(fmt, ...) \ | |
211 | ec_log(EC_DBG_DRV, fmt, ##__VA_ARGS__) | |
212 | #define ec_dbg_drv(fmt, ...) \ | |
213 | ec_dbg(EC_DBG_DRV, fmt, ##__VA_ARGS__) | |
214 | #define ec_dbg_stm(fmt, ...) \ | |
215 | ec_dbg(EC_DBG_STM, fmt, ##__VA_ARGS__) | |
216 | #define ec_dbg_req(fmt, ...) \ | |
217 | ec_dbg(EC_DBG_REQ, fmt, ##__VA_ARGS__) | |
218 | #define ec_dbg_evt(fmt, ...) \ | |
219 | ec_dbg(EC_DBG_EVT, fmt, ##__VA_ARGS__) | |
770970f0 LZ |
220 | #define ec_dbg_ref(ec, fmt, ...) \ |
221 | ec_dbg_raw("%lu: " fmt, ec->reference_count, ## __VA_ARGS__) | |
3535a3c1 | 222 | |
ad479e7f LZ |
223 | /* -------------------------------------------------------------------------- |
224 | * Device Flags | |
225 | * -------------------------------------------------------------------------- */ | |
226 | ||
227 | static bool acpi_ec_started(struct acpi_ec *ec) | |
228 | { | |
229 | return test_bit(EC_FLAGS_STARTED, &ec->flags) && | |
230 | !test_bit(EC_FLAGS_STOPPED, &ec->flags); | |
231 | } | |
232 | ||
9887d22a LZ |
233 | static bool acpi_ec_flushed(struct acpi_ec *ec) |
234 | { | |
235 | return ec->reference_count == 1; | |
236 | } | |
237 | ||
1da177e4 | 238 | /* -------------------------------------------------------------------------- |
ca37bfdf | 239 | * EC Registers |
7a73e60e | 240 | * -------------------------------------------------------------------------- */ |
1da177e4 | 241 | |
6ffb221a | 242 | static inline u8 acpi_ec_read_status(struct acpi_ec *ec) |
1da177e4 | 243 | { |
3ebe08a7 | 244 | u8 x = inb(ec->command_addr); |
7a73e60e | 245 | |
3535a3c1 LZ |
246 | ec_dbg_raw("EC_SC(R) = 0x%2.2x " |
247 | "SCI_EVT=%d BURST=%d CMD=%d IBF=%d OBF=%d", | |
248 | x, | |
249 | !!(x & ACPI_EC_FLAG_SCI), | |
250 | !!(x & ACPI_EC_FLAG_BURST), | |
251 | !!(x & ACPI_EC_FLAG_CMD), | |
252 | !!(x & ACPI_EC_FLAG_IBF), | |
253 | !!(x & ACPI_EC_FLAG_OBF)); | |
3ebe08a7 | 254 | return x; |
451566f4 DT |
255 | } |
256 | ||
6ffb221a | 257 | static inline u8 acpi_ec_read_data(struct acpi_ec *ec) |
703959d4 | 258 | { |
3ebe08a7 | 259 | u8 x = inb(ec->data_addr); |
7a73e60e | 260 | |
d8d031a6 | 261 | ec->timestamp = jiffies; |
3535a3c1 | 262 | ec_dbg_raw("EC_DATA(R) = 0x%2.2x", x); |
7c6db4e0 | 263 | return x; |
7c6db5e5 DS |
264 | } |
265 | ||
6ffb221a | 266 | static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command) |
45bea155 | 267 | { |
3535a3c1 | 268 | ec_dbg_raw("EC_SC(W) = 0x%2.2x", command); |
6ffb221a | 269 | outb(command, ec->command_addr); |
d8d031a6 | 270 | ec->timestamp = jiffies; |
45bea155 LY |
271 | } |
272 | ||
6ffb221a | 273 | static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data) |
45bea155 | 274 | { |
3535a3c1 | 275 | ec_dbg_raw("EC_DATA(W) = 0x%2.2x", data); |
6ffb221a | 276 | outb(data, ec->data_addr); |
d8d031a6 | 277 | ec->timestamp = jiffies; |
703959d4 | 278 | } |
45bea155 | 279 | |
e34c0e2b LZ |
280 | #ifdef DEBUG |
281 | static const char *acpi_ec_cmd_string(u8 cmd) | |
282 | { | |
283 | switch (cmd) { | |
284 | case 0x80: | |
285 | return "RD_EC"; | |
286 | case 0x81: | |
287 | return "WR_EC"; | |
288 | case 0x82: | |
289 | return "BE_EC"; | |
290 | case 0x83: | |
291 | return "BD_EC"; | |
292 | case 0x84: | |
293 | return "QR_EC"; | |
294 | } | |
295 | return "UNKNOWN"; | |
296 | } | |
297 | #else | |
298 | #define acpi_ec_cmd_string(cmd) "UNDEF" | |
299 | #endif | |
300 | ||
ca37bfdf LZ |
301 | /* -------------------------------------------------------------------------- |
302 | * GPE Registers | |
303 | * -------------------------------------------------------------------------- */ | |
304 | ||
305 | static inline bool acpi_ec_is_gpe_raised(struct acpi_ec *ec) | |
306 | { | |
307 | acpi_event_status gpe_status = 0; | |
308 | ||
309 | (void)acpi_get_gpe_status(NULL, ec->gpe, &gpe_status); | |
7c0b2595 | 310 | return (gpe_status & ACPI_EVENT_FLAG_STATUS_SET) ? true : false; |
ca37bfdf LZ |
311 | } |
312 | ||
313 | static inline void acpi_ec_enable_gpe(struct acpi_ec *ec, bool open) | |
314 | { | |
315 | if (open) | |
316 | acpi_enable_gpe(NULL, ec->gpe); | |
e1d4d90f LZ |
317 | else { |
318 | BUG_ON(ec->reference_count < 1); | |
ca37bfdf | 319 | acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_ENABLE); |
e1d4d90f | 320 | } |
ca37bfdf LZ |
321 | if (acpi_ec_is_gpe_raised(ec)) { |
322 | /* | |
323 | * On some platforms, EN=1 writes cannot trigger GPE. So | |
324 | * software need to manually trigger a pseudo GPE event on | |
325 | * EN=1 writes. | |
326 | */ | |
3535a3c1 | 327 | ec_dbg_raw("Polling quirk"); |
ca37bfdf LZ |
328 | advance_transaction(ec); |
329 | } | |
330 | } | |
331 | ||
332 | static inline void acpi_ec_disable_gpe(struct acpi_ec *ec, bool close) | |
333 | { | |
334 | if (close) | |
335 | acpi_disable_gpe(NULL, ec->gpe); | |
e1d4d90f LZ |
336 | else { |
337 | BUG_ON(ec->reference_count < 1); | |
ca37bfdf | 338 | acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_DISABLE); |
e1d4d90f | 339 | } |
ca37bfdf LZ |
340 | } |
341 | ||
342 | static inline void acpi_ec_clear_gpe(struct acpi_ec *ec) | |
343 | { | |
344 | /* | |
345 | * GPE STS is a W1C register, which means: | |
346 | * 1. Software can clear it without worrying about clearing other | |
347 | * GPEs' STS bits when the hardware sets them in parallel. | |
348 | * 2. As long as software can ensure only clearing it when it is | |
349 | * set, hardware won't set it in parallel. | |
350 | * So software can clear GPE in any contexts. | |
351 | * Warning: do not move the check into advance_transaction() as the | |
352 | * EC commands will be sent without GPE raised. | |
353 | */ | |
354 | if (!acpi_ec_is_gpe_raised(ec)) | |
355 | return; | |
356 | acpi_clear_gpe(NULL, ec->gpe); | |
357 | } | |
358 | ||
359 | /* -------------------------------------------------------------------------- | |
360 | * Transaction Management | |
361 | * -------------------------------------------------------------------------- */ | |
362 | ||
9887d22a LZ |
363 | static void acpi_ec_submit_request(struct acpi_ec *ec) |
364 | { | |
365 | ec->reference_count++; | |
366 | if (ec->reference_count == 1) | |
367 | acpi_ec_enable_gpe(ec, true); | |
368 | } | |
369 | ||
370 | static void acpi_ec_complete_request(struct acpi_ec *ec) | |
371 | { | |
372 | bool flushed = false; | |
373 | ||
374 | ec->reference_count--; | |
375 | if (ec->reference_count == 0) | |
376 | acpi_ec_disable_gpe(ec, true); | |
377 | flushed = acpi_ec_flushed(ec); | |
378 | if (flushed) | |
379 | wake_up(&ec->wait); | |
380 | } | |
381 | ||
e1d4d90f LZ |
382 | static void acpi_ec_set_storm(struct acpi_ec *ec, u8 flag) |
383 | { | |
384 | if (!test_bit(flag, &ec->flags)) { | |
385 | acpi_ec_disable_gpe(ec, false); | |
3535a3c1 | 386 | ec_dbg_drv("Polling enabled"); |
e1d4d90f LZ |
387 | set_bit(flag, &ec->flags); |
388 | } | |
389 | } | |
390 | ||
391 | static void acpi_ec_clear_storm(struct acpi_ec *ec, u8 flag) | |
392 | { | |
393 | if (test_bit(flag, &ec->flags)) { | |
394 | clear_bit(flag, &ec->flags); | |
395 | acpi_ec_enable_gpe(ec, false); | |
3535a3c1 | 396 | ec_dbg_drv("Polling disabled"); |
e1d4d90f LZ |
397 | } |
398 | } | |
399 | ||
9887d22a LZ |
400 | /* |
401 | * acpi_ec_submit_flushable_request() - Increase the reference count unless | |
402 | * the flush operation is not in | |
403 | * progress | |
404 | * @ec: the EC device | |
405 | * | |
406 | * This function must be used before taking a new action that should hold | |
407 | * the reference count. If this function returns false, then the action | |
408 | * must be discarded or it will prevent the flush operation from being | |
409 | * completed. | |
410 | */ | |
37d11391 | 411 | static bool acpi_ec_submit_flushable_request(struct acpi_ec *ec) |
9887d22a | 412 | { |
37d11391 RW |
413 | if (!acpi_ec_started(ec)) |
414 | return false; | |
9887d22a LZ |
415 | acpi_ec_submit_request(ec); |
416 | return true; | |
417 | } | |
418 | ||
37d11391 | 419 | static void acpi_ec_submit_query(struct acpi_ec *ec) |
74443bbe | 420 | { |
37d11391 | 421 | if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags)) { |
9d8993be LZ |
422 | ec_dbg_evt("Command(%s) submitted/blocked", |
423 | acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY)); | |
424 | ec->nr_pending_queries++; | |
74443bbe LZ |
425 | schedule_work(&ec->work); |
426 | } | |
427 | } | |
428 | ||
37d11391 | 429 | static void acpi_ec_complete_query(struct acpi_ec *ec) |
74443bbe | 430 | { |
f8b8eb71 | 431 | if (test_bit(EC_FLAGS_QUERY_PENDING, &ec->flags)) { |
37d11391 | 432 | clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags); |
9d8993be LZ |
433 | ec_dbg_evt("Command(%s) unblocked", |
434 | acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY)); | |
74443bbe LZ |
435 | } |
436 | } | |
437 | ||
1d68d261 LZ |
438 | static bool acpi_ec_guard_event(struct acpi_ec *ec) |
439 | { | |
440 | if (ec_event_clearing == ACPI_EC_EVT_TIMING_STATUS || | |
441 | ec_event_clearing == ACPI_EC_EVT_TIMING_QUERY || | |
442 | !test_bit(EC_FLAGS_QUERY_PENDING, &ec->flags) || | |
443 | (ec->curr && ec->curr->command == ACPI_EC_COMMAND_QUERY)) | |
444 | return false; | |
445 | ||
446 | /* | |
447 | * Postpone the query submission to allow the firmware to proceed, | |
448 | * we shouldn't check SCI_EVT before the firmware reflagging it. | |
449 | */ | |
450 | return true; | |
451 | } | |
452 | ||
d8d031a6 LZ |
453 | static int ec_transaction_polled(struct acpi_ec *ec) |
454 | { | |
455 | unsigned long flags; | |
456 | int ret = 0; | |
457 | ||
458 | spin_lock_irqsave(&ec->lock, flags); | |
459 | if (ec->curr && (ec->curr->flags & ACPI_EC_COMMAND_POLL)) | |
460 | ret = 1; | |
461 | spin_unlock_irqrestore(&ec->lock, flags); | |
462 | return ret; | |
463 | } | |
464 | ||
f92fca00 | 465 | static int ec_transaction_completed(struct acpi_ec *ec) |
6ffb221a | 466 | { |
7c6db4e0 AS |
467 | unsigned long flags; |
468 | int ret = 0; | |
7a73e60e | 469 | |
f351d027 | 470 | spin_lock_irqsave(&ec->lock, flags); |
c0d65341 | 471 | if (ec->curr && (ec->curr->flags & ACPI_EC_COMMAND_COMPLETE)) |
7c6db4e0 | 472 | ret = 1; |
f351d027 | 473 | spin_unlock_irqrestore(&ec->lock, flags); |
7c6db4e0 | 474 | return ret; |
45bea155 | 475 | } |
451566f4 | 476 | |
f8b8eb71 LZ |
477 | static inline void ec_transaction_transition(struct acpi_ec *ec, unsigned long flag) |
478 | { | |
479 | ec->curr->flags |= flag; | |
480 | if (ec->curr->command == ACPI_EC_COMMAND_QUERY) { | |
1d68d261 LZ |
481 | if (ec_event_clearing == ACPI_EC_EVT_TIMING_STATUS && |
482 | flag == ACPI_EC_COMMAND_POLL) | |
483 | acpi_ec_complete_query(ec); | |
484 | if (ec_event_clearing == ACPI_EC_EVT_TIMING_QUERY && | |
485 | flag == ACPI_EC_COMMAND_COMPLETE) | |
f8b8eb71 | 486 | acpi_ec_complete_query(ec); |
1d68d261 LZ |
487 | if (ec_event_clearing == ACPI_EC_EVT_TIMING_EVENT && |
488 | flag == ACPI_EC_COMMAND_COMPLETE) | |
489 | set_bit(EC_FLAGS_QUERY_GUARDING, &ec->flags); | |
f8b8eb71 LZ |
490 | } |
491 | } | |
492 | ||
0c78808f | 493 | static void advance_transaction(struct acpi_ec *ec) |
7c6db5e5 | 494 | { |
36b15875 | 495 | struct transaction *t; |
66b42b78 | 496 | u8 status; |
c0d65341 | 497 | bool wakeup = false; |
b76b51ba | 498 | |
3535a3c1 LZ |
499 | ec_dbg_stm("%s (%d)", in_interrupt() ? "IRQ" : "TASK", |
500 | smp_processor_id()); | |
ca37bfdf LZ |
501 | /* |
502 | * By always clearing STS before handling all indications, we can | |
503 | * ensure a hardware STS 0->1 change after this clearing can always | |
504 | * trigger a GPE interrupt. | |
505 | */ | |
506 | acpi_ec_clear_gpe(ec); | |
66b42b78 | 507 | status = acpi_ec_read_status(ec); |
36b15875 | 508 | t = ec->curr; |
1d68d261 LZ |
509 | /* |
510 | * Another IRQ or a guarded polling mode advancement is detected, | |
511 | * the next QR_EC submission is then allowed. | |
512 | */ | |
513 | if (!t || !(t->flags & ACPI_EC_COMMAND_POLL)) { | |
514 | if (ec_event_clearing == ACPI_EC_EVT_TIMING_EVENT && | |
515 | test_bit(EC_FLAGS_QUERY_GUARDING, &ec->flags)) { | |
516 | clear_bit(EC_FLAGS_QUERY_GUARDING, &ec->flags); | |
517 | acpi_ec_complete_query(ec); | |
518 | } | |
519 | } | |
b76b51ba | 520 | if (!t) |
f92fca00 LZ |
521 | goto err; |
522 | if (t->flags & ACPI_EC_COMMAND_POLL) { | |
523 | if (t->wlen > t->wi) { | |
524 | if ((status & ACPI_EC_FLAG_IBF) == 0) | |
525 | acpi_ec_write_data(ec, t->wdata[t->wi++]); | |
526 | else | |
527 | goto err; | |
528 | } else if (t->rlen > t->ri) { | |
529 | if ((status & ACPI_EC_FLAG_OBF) == 1) { | |
530 | t->rdata[t->ri++] = acpi_ec_read_data(ec); | |
c0d65341 | 531 | if (t->rlen == t->ri) { |
f8b8eb71 | 532 | ec_transaction_transition(ec, ACPI_EC_COMMAND_COMPLETE); |
3afcf2ec | 533 | if (t->command == ACPI_EC_COMMAND_QUERY) |
9d8993be LZ |
534 | ec_dbg_evt("Command(%s) completed by hardware", |
535 | acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY)); | |
c0d65341 LZ |
536 | wakeup = true; |
537 | } | |
f92fca00 LZ |
538 | } else |
539 | goto err; | |
540 | } else if (t->wlen == t->wi && | |
c0d65341 | 541 | (status & ACPI_EC_FLAG_IBF) == 0) { |
f8b8eb71 | 542 | ec_transaction_transition(ec, ACPI_EC_COMMAND_COMPLETE); |
c0d65341 LZ |
543 | wakeup = true; |
544 | } | |
0c78808f | 545 | goto out; |
f92fca00 | 546 | } else { |
79149001 LZ |
547 | if (EC_FLAGS_QUERY_HANDSHAKE && |
548 | !(status & ACPI_EC_FLAG_SCI) && | |
3afcf2ec | 549 | (t->command == ACPI_EC_COMMAND_QUERY)) { |
f8b8eb71 | 550 | ec_transaction_transition(ec, ACPI_EC_COMMAND_POLL); |
3afcf2ec | 551 | t->rdata[t->ri++] = 0x00; |
f8b8eb71 | 552 | ec_transaction_transition(ec, ACPI_EC_COMMAND_COMPLETE); |
9d8993be LZ |
553 | ec_dbg_evt("Command(%s) completed by software", |
554 | acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY)); | |
3afcf2ec LZ |
555 | wakeup = true; |
556 | } else if ((status & ACPI_EC_FLAG_IBF) == 0) { | |
f92fca00 | 557 | acpi_ec_write_cmd(ec, t->command); |
f8b8eb71 | 558 | ec_transaction_transition(ec, ACPI_EC_COMMAND_POLL); |
7c6db4e0 | 559 | } else |
dd15f8c4 | 560 | goto err; |
0c78808f | 561 | goto out; |
f92fca00 | 562 | } |
dd15f8c4 | 563 | err: |
a3cd8d27 FT |
564 | /* |
565 | * If SCI bit is set, then don't think it's a false IRQ | |
566 | * otherwise will take a not handled IRQ as a false one. | |
567 | */ | |
f92fca00 | 568 | if (!(status & ACPI_EC_FLAG_SCI)) { |
e1d4d90f LZ |
569 | if (in_interrupt() && t) { |
570 | if (t->irq_count < ec_storm_threshold) | |
571 | ++t->irq_count; | |
572 | /* Allow triggering on 0 threshold */ | |
573 | if (t->irq_count == ec_storm_threshold) | |
574 | acpi_ec_set_storm(ec, EC_FLAGS_COMMAND_STORM); | |
575 | } | |
f92fca00 | 576 | } |
0c78808f | 577 | out: |
74443bbe | 578 | if (status & ACPI_EC_FLAG_SCI) |
37d11391 | 579 | acpi_ec_submit_query(ec); |
0c78808f LZ |
580 | if (wakeup && in_interrupt()) |
581 | wake_up(&ec->wait); | |
f92fca00 | 582 | } |
a3cd8d27 | 583 | |
f92fca00 LZ |
584 | static void start_transaction(struct acpi_ec *ec) |
585 | { | |
586 | ec->curr->irq_count = ec->curr->wi = ec->curr->ri = 0; | |
587 | ec->curr->flags = 0; | |
d8d031a6 LZ |
588 | } |
589 | ||
590 | static int ec_guard(struct acpi_ec *ec) | |
591 | { | |
15de603b | 592 | unsigned long guard = usecs_to_jiffies(ec_polling_guard); |
d8d031a6 LZ |
593 | unsigned long timeout = ec->timestamp + guard; |
594 | ||
595 | do { | |
15de603b | 596 | if (ec_busy_polling) { |
d8d031a6 LZ |
597 | /* Perform busy polling */ |
598 | if (ec_transaction_completed(ec)) | |
599 | return 0; | |
600 | udelay(jiffies_to_usecs(guard)); | |
601 | } else { | |
602 | /* | |
603 | * Perform wait polling | |
604 | * | |
1d68d261 LZ |
605 | * For SCI_EVT clearing timing of "event", |
606 | * performing guarding before re-checking the | |
607 | * SCI_EVT. Otherwise, such guarding is not needed | |
608 | * due to the old practices. | |
d8d031a6 | 609 | */ |
1d68d261 LZ |
610 | if (!ec_transaction_polled(ec) && |
611 | !acpi_ec_guard_event(ec)) | |
d8d031a6 LZ |
612 | break; |
613 | if (wait_event_timeout(ec->wait, | |
614 | ec_transaction_completed(ec), | |
615 | guard)) | |
616 | return 0; | |
617 | } | |
618 | /* Guard the register accesses for the polling modes */ | |
619 | } while (time_before(jiffies, timeout)); | |
620 | return -ETIME; | |
845625cd | 621 | } |
03d1d99c | 622 | |
7c6db4e0 AS |
623 | static int ec_poll(struct acpi_ec *ec) |
624 | { | |
2a84cb98 | 625 | unsigned long flags; |
28fe5c82 | 626 | int repeat = 5; /* number of command restarts */ |
7a73e60e | 627 | |
2a84cb98 AS |
628 | while (repeat--) { |
629 | unsigned long delay = jiffies + | |
7a18e96d | 630 | msecs_to_jiffies(ec_delay); |
2a84cb98 | 631 | do { |
d8d031a6 LZ |
632 | if (!ec_guard(ec)) |
633 | return 0; | |
f92fca00 | 634 | spin_lock_irqsave(&ec->lock, flags); |
d8d031a6 | 635 | advance_transaction(ec); |
f92fca00 | 636 | spin_unlock_irqrestore(&ec->lock, flags); |
2a84cb98 | 637 | } while (time_before(jiffies, delay)); |
16a26e85 | 638 | pr_debug("controller reset, restart transaction\n"); |
f351d027 | 639 | spin_lock_irqsave(&ec->lock, flags); |
2a84cb98 | 640 | start_transaction(ec); |
f351d027 | 641 | spin_unlock_irqrestore(&ec->lock, flags); |
af3fd140 | 642 | } |
b77d81b2 | 643 | return -ETIME; |
1da177e4 LT |
644 | } |
645 | ||
8463200a | 646 | static int acpi_ec_transaction_unlocked(struct acpi_ec *ec, |
2a84cb98 | 647 | struct transaction *t) |
45bea155 | 648 | { |
7c6db4e0 | 649 | unsigned long tmp; |
7c6db4e0 | 650 | int ret = 0; |
7a73e60e | 651 | |
7c6db4e0 | 652 | /* start transaction */ |
f351d027 | 653 | spin_lock_irqsave(&ec->lock, tmp); |
9887d22a | 654 | /* Enable GPE for command processing (IBF=0/OBF=1) */ |
37d11391 | 655 | if (!acpi_ec_submit_flushable_request(ec)) { |
ad479e7f LZ |
656 | ret = -EINVAL; |
657 | goto unlock; | |
658 | } | |
770970f0 | 659 | ec_dbg_ref(ec, "Increase command"); |
7c6db4e0 | 660 | /* following two actions should be kept atomic */ |
8463200a | 661 | ec->curr = t; |
3535a3c1 | 662 | ec_dbg_req("Command(%s) started", acpi_ec_cmd_string(t->command)); |
a2f93aea | 663 | start_transaction(ec); |
df9ff918 | 664 | spin_unlock_irqrestore(&ec->lock, tmp); |
d8d031a6 | 665 | |
df9ff918 | 666 | ret = ec_poll(ec); |
d8d031a6 | 667 | |
df9ff918 | 668 | spin_lock_irqsave(&ec->lock, tmp); |
e1d4d90f LZ |
669 | if (t->irq_count == ec_storm_threshold) |
670 | acpi_ec_clear_storm(ec, EC_FLAGS_COMMAND_STORM); | |
3535a3c1 | 671 | ec_dbg_req("Command(%s) stopped", acpi_ec_cmd_string(t->command)); |
8463200a | 672 | ec->curr = NULL; |
9887d22a LZ |
673 | /* Disable GPE for command processing (IBF=0/OBF=1) */ |
674 | acpi_ec_complete_request(ec); | |
770970f0 | 675 | ec_dbg_ref(ec, "Decrease command"); |
ad479e7f | 676 | unlock: |
f351d027 | 677 | spin_unlock_irqrestore(&ec->lock, tmp); |
7c6db4e0 AS |
678 | return ret; |
679 | } | |
680 | ||
2a84cb98 | 681 | static int acpi_ec_transaction(struct acpi_ec *ec, struct transaction *t) |
1da177e4 | 682 | { |
d7a76e4c | 683 | int status; |
50526df6 | 684 | u32 glk; |
7a73e60e | 685 | |
8463200a | 686 | if (!ec || (!t) || (t->wlen && !t->wdata) || (t->rlen && !t->rdata)) |
d550d98d | 687 | return -EINVAL; |
8463200a AS |
688 | if (t->rdata) |
689 | memset(t->rdata, 0, t->rlen); | |
d8d031a6 | 690 | |
f351d027 | 691 | mutex_lock(&ec->mutex); |
703959d4 | 692 | if (ec->global_lock) { |
1da177e4 | 693 | status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk); |
c24e912b | 694 | if (ACPI_FAILURE(status)) { |
7c6db4e0 AS |
695 | status = -ENODEV; |
696 | goto unlock; | |
c24e912b | 697 | } |
1da177e4 | 698 | } |
a62e8f19 | 699 | |
2a84cb98 | 700 | status = acpi_ec_transaction_unlocked(ec, t); |
a62e8f19 | 701 | |
703959d4 | 702 | if (ec->global_lock) |
1da177e4 | 703 | acpi_release_global_lock(glk); |
7c6db4e0 | 704 | unlock: |
f351d027 | 705 | mutex_unlock(&ec->mutex); |
d550d98d | 706 | return status; |
1da177e4 LT |
707 | } |
708 | ||
8a383ef0 | 709 | static int acpi_ec_burst_enable(struct acpi_ec *ec) |
c45aac43 AS |
710 | { |
711 | u8 d; | |
8463200a AS |
712 | struct transaction t = {.command = ACPI_EC_BURST_ENABLE, |
713 | .wdata = NULL, .rdata = &d, | |
714 | .wlen = 0, .rlen = 1}; | |
715 | ||
2a84cb98 | 716 | return acpi_ec_transaction(ec, &t); |
c45aac43 AS |
717 | } |
718 | ||
8a383ef0 | 719 | static int acpi_ec_burst_disable(struct acpi_ec *ec) |
c45aac43 | 720 | { |
8463200a AS |
721 | struct transaction t = {.command = ACPI_EC_BURST_DISABLE, |
722 | .wdata = NULL, .rdata = NULL, | |
723 | .wlen = 0, .rlen = 0}; | |
724 | ||
7c6db4e0 | 725 | return (acpi_ec_read_status(ec) & ACPI_EC_FLAG_BURST) ? |
2a84cb98 | 726 | acpi_ec_transaction(ec, &t) : 0; |
c45aac43 AS |
727 | } |
728 | ||
7a73e60e | 729 | static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 *data) |
3576cf61 DS |
730 | { |
731 | int result; | |
732 | u8 d; | |
8463200a AS |
733 | struct transaction t = {.command = ACPI_EC_COMMAND_READ, |
734 | .wdata = &address, .rdata = &d, | |
735 | .wlen = 1, .rlen = 1}; | |
3576cf61 | 736 | |
2a84cb98 | 737 | result = acpi_ec_transaction(ec, &t); |
3576cf61 DS |
738 | *data = d; |
739 | return result; | |
740 | } | |
6ffb221a | 741 | |
3576cf61 DS |
742 | static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data) |
743 | { | |
6ccedb10 | 744 | u8 wdata[2] = { address, data }; |
8463200a AS |
745 | struct transaction t = {.command = ACPI_EC_COMMAND_WRITE, |
746 | .wdata = wdata, .rdata = NULL, | |
747 | .wlen = 2, .rlen = 0}; | |
748 | ||
2a84cb98 | 749 | return acpi_ec_transaction(ec, &t); |
3576cf61 DS |
750 | } |
751 | ||
b76b51ba | 752 | int ec_read(u8 addr, u8 *val) |
1da177e4 | 753 | { |
1da177e4 | 754 | int err; |
6ffb221a | 755 | u8 temp_data; |
1da177e4 LT |
756 | |
757 | if (!first_ec) | |
758 | return -ENODEV; | |
759 | ||
d033879c | 760 | err = acpi_ec_read(first_ec, addr, &temp_data); |
1da177e4 LT |
761 | |
762 | if (!err) { | |
763 | *val = temp_data; | |
764 | return 0; | |
7a73e60e LZ |
765 | } |
766 | return err; | |
1da177e4 LT |
767 | } |
768 | EXPORT_SYMBOL(ec_read); | |
769 | ||
50526df6 | 770 | int ec_write(u8 addr, u8 val) |
1da177e4 | 771 | { |
1da177e4 LT |
772 | int err; |
773 | ||
774 | if (!first_ec) | |
775 | return -ENODEV; | |
776 | ||
d033879c | 777 | err = acpi_ec_write(first_ec, addr, val); |
1da177e4 LT |
778 | |
779 | return err; | |
780 | } | |
781 | EXPORT_SYMBOL(ec_write); | |
782 | ||
616362de | 783 | int ec_transaction(u8 command, |
7a73e60e LZ |
784 | const u8 *wdata, unsigned wdata_len, |
785 | u8 *rdata, unsigned rdata_len) | |
45bea155 | 786 | { |
8463200a AS |
787 | struct transaction t = {.command = command, |
788 | .wdata = wdata, .rdata = rdata, | |
789 | .wlen = wdata_len, .rlen = rdata_len}; | |
7a73e60e | 790 | |
d7a76e4c LP |
791 | if (!first_ec) |
792 | return -ENODEV; | |
45bea155 | 793 | |
2a84cb98 | 794 | return acpi_ec_transaction(first_ec, &t); |
45bea155 | 795 | } |
ab9e43c6 LP |
796 | EXPORT_SYMBOL(ec_transaction); |
797 | ||
3e2abc5a SF |
798 | /* Get the handle to the EC device */ |
799 | acpi_handle ec_get_handle(void) | |
800 | { | |
801 | if (!first_ec) | |
802 | return NULL; | |
803 | return first_ec->handle; | |
804 | } | |
3e2abc5a SF |
805 | EXPORT_SYMBOL(ec_get_handle); |
806 | ||
ad332c8a | 807 | /* |
3eba563e | 808 | * Process _Q events that might have accumulated in the EC. |
ad332c8a KC |
809 | * Run with locked ec mutex. |
810 | */ | |
811 | static void acpi_ec_clear(struct acpi_ec *ec) | |
812 | { | |
813 | int i, status; | |
814 | u8 value = 0; | |
815 | ||
816 | for (i = 0; i < ACPI_EC_CLEAR_MAX; i++) { | |
550b3aac | 817 | status = acpi_ec_query(ec, &value); |
ad332c8a KC |
818 | if (status || !value) |
819 | break; | |
820 | } | |
821 | ||
822 | if (unlikely(i == ACPI_EC_CLEAR_MAX)) | |
823 | pr_warn("Warning: Maximum of %d stale EC events cleared\n", i); | |
824 | else | |
825 | pr_info("%d stale EC events cleared\n", i); | |
826 | } | |
827 | ||
ad479e7f LZ |
828 | static void acpi_ec_start(struct acpi_ec *ec, bool resuming) |
829 | { | |
830 | unsigned long flags; | |
831 | ||
832 | spin_lock_irqsave(&ec->lock, flags); | |
833 | if (!test_and_set_bit(EC_FLAGS_STARTED, &ec->flags)) { | |
3535a3c1 | 834 | ec_dbg_drv("Starting EC"); |
9887d22a | 835 | /* Enable GPE for event processing (SCI_EVT=1) */ |
770970f0 | 836 | if (!resuming) { |
9887d22a | 837 | acpi_ec_submit_request(ec); |
770970f0 LZ |
838 | ec_dbg_ref(ec, "Increase driver"); |
839 | } | |
3535a3c1 | 840 | ec_log_drv("EC started"); |
ad479e7f LZ |
841 | } |
842 | spin_unlock_irqrestore(&ec->lock, flags); | |
843 | } | |
844 | ||
9887d22a LZ |
845 | static bool acpi_ec_stopped(struct acpi_ec *ec) |
846 | { | |
847 | unsigned long flags; | |
848 | bool flushed; | |
849 | ||
850 | spin_lock_irqsave(&ec->lock, flags); | |
851 | flushed = acpi_ec_flushed(ec); | |
852 | spin_unlock_irqrestore(&ec->lock, flags); | |
853 | return flushed; | |
854 | } | |
855 | ||
ad479e7f LZ |
856 | static void acpi_ec_stop(struct acpi_ec *ec, bool suspending) |
857 | { | |
858 | unsigned long flags; | |
859 | ||
860 | spin_lock_irqsave(&ec->lock, flags); | |
861 | if (acpi_ec_started(ec)) { | |
3535a3c1 | 862 | ec_dbg_drv("Stopping EC"); |
ad479e7f | 863 | set_bit(EC_FLAGS_STOPPED, &ec->flags); |
9887d22a LZ |
864 | spin_unlock_irqrestore(&ec->lock, flags); |
865 | wait_event(ec->wait, acpi_ec_stopped(ec)); | |
866 | spin_lock_irqsave(&ec->lock, flags); | |
867 | /* Disable GPE for event processing (SCI_EVT=1) */ | |
770970f0 | 868 | if (!suspending) { |
9887d22a | 869 | acpi_ec_complete_request(ec); |
770970f0 LZ |
870 | ec_dbg_ref(ec, "Decrease driver"); |
871 | } | |
ad479e7f LZ |
872 | clear_bit(EC_FLAGS_STARTED, &ec->flags); |
873 | clear_bit(EC_FLAGS_STOPPED, &ec->flags); | |
3535a3c1 | 874 | ec_log_drv("EC stopped"); |
ad479e7f LZ |
875 | } |
876 | spin_unlock_irqrestore(&ec->lock, flags); | |
877 | } | |
878 | ||
fe955682 | 879 | void acpi_ec_block_transactions(void) |
f6bb13aa RW |
880 | { |
881 | struct acpi_ec *ec = first_ec; | |
882 | ||
883 | if (!ec) | |
884 | return; | |
885 | ||
f351d027 | 886 | mutex_lock(&ec->mutex); |
f6bb13aa | 887 | /* Prevent transactions from being carried out */ |
ad479e7f | 888 | acpi_ec_stop(ec, true); |
f351d027 | 889 | mutex_unlock(&ec->mutex); |
f6bb13aa RW |
890 | } |
891 | ||
fe955682 | 892 | void acpi_ec_unblock_transactions(void) |
f6bb13aa RW |
893 | { |
894 | struct acpi_ec *ec = first_ec; | |
895 | ||
896 | if (!ec) | |
897 | return; | |
898 | ||
f6bb13aa | 899 | /* Allow transactions to be carried out again */ |
ad479e7f | 900 | acpi_ec_start(ec, true); |
ad332c8a KC |
901 | |
902 | if (EC_FLAGS_CLEAR_ON_RESUME) | |
903 | acpi_ec_clear(ec); | |
f6bb13aa RW |
904 | } |
905 | ||
fe955682 | 906 | void acpi_ec_unblock_transactions_early(void) |
d5a64513 RW |
907 | { |
908 | /* | |
909 | * Allow transactions to happen again (this function is called from | |
910 | * atomic context during wakeup, so we don't need to acquire the mutex). | |
911 | */ | |
912 | if (first_ec) | |
ad479e7f | 913 | acpi_ec_start(first_ec, true); |
d5a64513 RW |
914 | } |
915 | ||
1da177e4 LT |
916 | /* -------------------------------------------------------------------------- |
917 | Event Management | |
918 | -------------------------------------------------------------------------- */ | |
01305d41 LZ |
919 | static struct acpi_ec_query_handler * |
920 | acpi_ec_get_query_handler(struct acpi_ec_query_handler *handler) | |
921 | { | |
922 | if (handler) | |
923 | kref_get(&handler->kref); | |
924 | return handler; | |
925 | } | |
926 | ||
927 | static void acpi_ec_query_handler_release(struct kref *kref) | |
928 | { | |
929 | struct acpi_ec_query_handler *handler = | |
930 | container_of(kref, struct acpi_ec_query_handler, kref); | |
931 | ||
932 | kfree(handler); | |
933 | } | |
934 | ||
935 | static void acpi_ec_put_query_handler(struct acpi_ec_query_handler *handler) | |
936 | { | |
937 | kref_put(&handler->kref, acpi_ec_query_handler_release); | |
938 | } | |
939 | ||
837012ed AS |
940 | int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit, |
941 | acpi_handle handle, acpi_ec_query_func func, | |
942 | void *data) | |
943 | { | |
944 | struct acpi_ec_query_handler *handler = | |
945 | kzalloc(sizeof(struct acpi_ec_query_handler), GFP_KERNEL); | |
7a73e60e | 946 | |
837012ed AS |
947 | if (!handler) |
948 | return -ENOMEM; | |
949 | ||
950 | handler->query_bit = query_bit; | |
951 | handler->handle = handle; | |
952 | handler->func = func; | |
953 | handler->data = data; | |
f351d027 | 954 | mutex_lock(&ec->mutex); |
01305d41 | 955 | kref_init(&handler->kref); |
30c08574 | 956 | list_add(&handler->node, &ec->list); |
f351d027 | 957 | mutex_unlock(&ec->mutex); |
837012ed AS |
958 | return 0; |
959 | } | |
837012ed AS |
960 | EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler); |
961 | ||
962 | void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit) | |
963 | { | |
1544fdbc | 964 | struct acpi_ec_query_handler *handler, *tmp; |
01305d41 | 965 | LIST_HEAD(free_list); |
7a73e60e | 966 | |
f351d027 | 967 | mutex_lock(&ec->mutex); |
1544fdbc | 968 | list_for_each_entry_safe(handler, tmp, &ec->list, node) { |
837012ed | 969 | if (query_bit == handler->query_bit) { |
01305d41 LZ |
970 | list_del_init(&handler->node); |
971 | list_add(&handler->node, &free_list); | |
837012ed AS |
972 | } |
973 | } | |
f351d027 | 974 | mutex_unlock(&ec->mutex); |
6b5eab54 | 975 | list_for_each_entry_safe(handler, tmp, &free_list, node) |
01305d41 | 976 | acpi_ec_put_query_handler(handler); |
837012ed | 977 | } |
837012ed | 978 | EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler); |
1da177e4 | 979 | |
a62e8f19 | 980 | static void acpi_ec_run(void *cxt) |
45bea155 | 981 | { |
a62e8f19 | 982 | struct acpi_ec_query_handler *handler = cxt; |
7a73e60e | 983 | |
a62e8f19 | 984 | if (!handler) |
e41334c0 | 985 | return; |
3535a3c1 | 986 | ec_dbg_evt("Query(0x%02x) started", handler->query_bit); |
a62e8f19 AS |
987 | if (handler->func) |
988 | handler->func(handler->data); | |
989 | else if (handler->handle) | |
990 | acpi_evaluate_object(handler->handle, NULL, NULL, NULL); | |
3535a3c1 | 991 | ec_dbg_evt("Query(0x%02x) stopped", handler->query_bit); |
01305d41 | 992 | acpi_ec_put_query_handler(handler); |
a62e8f19 AS |
993 | } |
994 | ||
550b3aac | 995 | static int acpi_ec_query(struct acpi_ec *ec, u8 *data) |
a62e8f19 AS |
996 | { |
997 | u8 value = 0; | |
c2cf5769 LZ |
998 | int result; |
999 | acpi_status status; | |
01305d41 | 1000 | struct acpi_ec_query_handler *handler; |
550b3aac LZ |
1001 | struct transaction t = {.command = ACPI_EC_COMMAND_QUERY, |
1002 | .wdata = NULL, .rdata = &value, | |
1003 | .wlen = 0, .rlen = 1}; | |
3eba563e | 1004 | |
550b3aac LZ |
1005 | /* |
1006 | * Query the EC to find out which _Qxx method we need to evaluate. | |
1007 | * Note that successful completion of the query causes the ACPI_EC_SCI | |
1008 | * bit to be cleared (and thus clearing the interrupt source). | |
1009 | */ | |
1010 | result = acpi_ec_transaction(ec, &t); | |
c2cf5769 LZ |
1011 | if (result) |
1012 | return result; | |
550b3aac LZ |
1013 | if (data) |
1014 | *data = value; | |
1015 | if (!value) | |
1016 | return -ENODATA; | |
3eba563e | 1017 | |
550b3aac | 1018 | mutex_lock(&ec->mutex); |
837012ed AS |
1019 | list_for_each_entry(handler, &ec->list, node) { |
1020 | if (value == handler->query_bit) { | |
1021 | /* have custom handler for this bit */ | |
01305d41 | 1022 | handler = acpi_ec_get_query_handler(handler); |
3535a3c1 LZ |
1023 | ec_dbg_evt("Query(0x%02x) scheduled", |
1024 | handler->query_bit); | |
c2cf5769 | 1025 | status = acpi_os_execute((handler->func) ? |
f5347867 | 1026 | OSL_NOTIFY_HANDLER : OSL_GPE_HANDLER, |
01305d41 | 1027 | acpi_ec_run, handler); |
c2cf5769 LZ |
1028 | if (ACPI_FAILURE(status)) |
1029 | result = -EBUSY; | |
1030 | break; | |
837012ed AS |
1031 | } |
1032 | } | |
550b3aac | 1033 | mutex_unlock(&ec->mutex); |
c2cf5769 | 1034 | return result; |
a62e8f19 AS |
1035 | } |
1036 | ||
1d68d261 LZ |
1037 | static void acpi_ec_check_event(struct acpi_ec *ec) |
1038 | { | |
1039 | unsigned long flags; | |
1040 | ||
1041 | if (ec_event_clearing == ACPI_EC_EVT_TIMING_EVENT) { | |
1042 | if (ec_guard(ec)) { | |
1043 | spin_lock_irqsave(&ec->lock, flags); | |
1044 | /* | |
1045 | * Take care of the SCI_EVT unless no one else is | |
1046 | * taking care of it. | |
1047 | */ | |
1048 | if (!ec->curr) | |
1049 | advance_transaction(ec); | |
1050 | spin_unlock_irqrestore(&ec->lock, flags); | |
1051 | } | |
1052 | } | |
1053 | } | |
1054 | ||
9d8993be | 1055 | static void acpi_ec_event_handler(struct work_struct *work) |
a62e8f19 | 1056 | { |
9d8993be | 1057 | unsigned long flags; |
74443bbe | 1058 | struct acpi_ec *ec = container_of(work, struct acpi_ec, work); |
7a73e60e | 1059 | |
9d8993be LZ |
1060 | ec_dbg_evt("Event started"); |
1061 | ||
1062 | spin_lock_irqsave(&ec->lock, flags); | |
1063 | while (ec->nr_pending_queries) { | |
1064 | spin_unlock_irqrestore(&ec->lock, flags); | |
1065 | (void)acpi_ec_query(ec, NULL); | |
1066 | spin_lock_irqsave(&ec->lock, flags); | |
1067 | ec->nr_pending_queries--; | |
1068 | } | |
1069 | spin_unlock_irqrestore(&ec->lock, flags); | |
1070 | ||
1071 | ec_dbg_evt("Event stopped"); | |
1d68d261 LZ |
1072 | |
1073 | acpi_ec_check_event(ec); | |
45bea155 | 1074 | } |
1da177e4 | 1075 | |
8b6cd8ad LM |
1076 | static u32 acpi_ec_gpe_handler(acpi_handle gpe_device, |
1077 | u32 gpe_number, void *data) | |
1da177e4 | 1078 | { |
f92fca00 | 1079 | unsigned long flags; |
3d02b90b | 1080 | struct acpi_ec *ec = data; |
7c6db4e0 | 1081 | |
f92fca00 | 1082 | spin_lock_irqsave(&ec->lock, flags); |
0c78808f | 1083 | advance_transaction(ec); |
c0d65341 | 1084 | spin_unlock_irqrestore(&ec->lock, flags); |
ca37bfdf | 1085 | return ACPI_INTERRUPT_HANDLED; |
845625cd AS |
1086 | } |
1087 | ||
1da177e4 | 1088 | /* -------------------------------------------------------------------------- |
7a73e60e LZ |
1089 | * Address Space Management |
1090 | * -------------------------------------------------------------------------- */ | |
1da177e4 | 1091 | |
1da177e4 | 1092 | static acpi_status |
5b7734b4 | 1093 | acpi_ec_space_handler(u32 function, acpi_physical_address address, |
dadf28a1 | 1094 | u32 bits, u64 *value64, |
50526df6 | 1095 | void *handler_context, void *region_context) |
1da177e4 | 1096 | { |
3d02b90b | 1097 | struct acpi_ec *ec = handler_context; |
dadf28a1 AS |
1098 | int result = 0, i, bytes = bits / 8; |
1099 | u8 *value = (u8 *)value64; | |
1da177e4 | 1100 | |
1da177e4 | 1101 | if ((address > 0xFF) || !value || !handler_context) |
d550d98d | 1102 | return AE_BAD_PARAMETER; |
1da177e4 | 1103 | |
5b7734b4 | 1104 | if (function != ACPI_READ && function != ACPI_WRITE) |
d550d98d | 1105 | return AE_BAD_PARAMETER; |
1da177e4 | 1106 | |
15de603b | 1107 | if (ec_busy_polling || bits > 8) |
6a63b06f | 1108 | acpi_ec_burst_enable(ec); |
b3b233c7 | 1109 | |
dadf28a1 AS |
1110 | for (i = 0; i < bytes; ++i, ++address, ++value) |
1111 | result = (function == ACPI_READ) ? | |
1112 | acpi_ec_read(ec, address, value) : | |
1113 | acpi_ec_write(ec, address, *value); | |
1da177e4 | 1114 | |
15de603b | 1115 | if (ec_busy_polling || bits > 8) |
6a63b06f | 1116 | acpi_ec_burst_disable(ec); |
b3b233c7 | 1117 | |
1da177e4 LT |
1118 | switch (result) { |
1119 | case -EINVAL: | |
d550d98d | 1120 | return AE_BAD_PARAMETER; |
1da177e4 | 1121 | case -ENODEV: |
d550d98d | 1122 | return AE_NOT_FOUND; |
1da177e4 | 1123 | case -ETIME: |
d550d98d | 1124 | return AE_TIME; |
1da177e4 | 1125 | default: |
d550d98d | 1126 | return AE_OK; |
1da177e4 | 1127 | } |
1da177e4 LT |
1128 | } |
1129 | ||
1da177e4 | 1130 | /* -------------------------------------------------------------------------- |
7a73e60e LZ |
1131 | * Driver Interface |
1132 | * -------------------------------------------------------------------------- */ | |
1133 | ||
c0900c35 AS |
1134 | static acpi_status |
1135 | ec_parse_io_ports(struct acpi_resource *resource, void *context); | |
1136 | ||
c0900c35 AS |
1137 | static struct acpi_ec *make_acpi_ec(void) |
1138 | { | |
1139 | struct acpi_ec *ec = kzalloc(sizeof(struct acpi_ec), GFP_KERNEL); | |
7a73e60e | 1140 | |
c0900c35 AS |
1141 | if (!ec) |
1142 | return NULL; | |
37d11391 | 1143 | ec->flags = 1 << EC_FLAGS_QUERY_PENDING; |
f351d027 | 1144 | mutex_init(&ec->mutex); |
c0900c35 | 1145 | init_waitqueue_head(&ec->wait); |
837012ed | 1146 | INIT_LIST_HEAD(&ec->list); |
f351d027 | 1147 | spin_lock_init(&ec->lock); |
9d8993be | 1148 | INIT_WORK(&ec->work, acpi_ec_event_handler); |
d8d031a6 | 1149 | ec->timestamp = jiffies; |
c0900c35 AS |
1150 | return ec; |
1151 | } | |
837012ed | 1152 | |
c019b193 AS |
1153 | static acpi_status |
1154 | acpi_ec_register_query_methods(acpi_handle handle, u32 level, | |
1155 | void *context, void **return_value) | |
1156 | { | |
0175d562 LM |
1157 | char node_name[5]; |
1158 | struct acpi_buffer buffer = { sizeof(node_name), node_name }; | |
c019b193 AS |
1159 | struct acpi_ec *ec = context; |
1160 | int value = 0; | |
0175d562 LM |
1161 | acpi_status status; |
1162 | ||
1163 | status = acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer); | |
1164 | ||
7a73e60e | 1165 | if (ACPI_SUCCESS(status) && sscanf(node_name, "_Q%x", &value) == 1) |
c019b193 | 1166 | acpi_ec_add_query_handler(ec, value, handle, NULL, NULL); |
c019b193 AS |
1167 | return AE_OK; |
1168 | } | |
1169 | ||
cd8c93a4 AS |
1170 | static acpi_status |
1171 | ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval) | |
837012ed | 1172 | { |
cd8c93a4 | 1173 | acpi_status status; |
d21cf3c1 | 1174 | unsigned long long tmp = 0; |
cd8c93a4 | 1175 | struct acpi_ec *ec = context; |
a5032bfd AS |
1176 | |
1177 | /* clear addr values, ec_parse_io_ports depend on it */ | |
1178 | ec->command_addr = ec->data_addr = 0; | |
1179 | ||
cd8c93a4 AS |
1180 | status = acpi_walk_resources(handle, METHOD_NAME__CRS, |
1181 | ec_parse_io_ports, ec); | |
1182 | if (ACPI_FAILURE(status)) | |
1183 | return status; | |
837012ed AS |
1184 | |
1185 | /* Get GPE bit assignment (EC events). */ | |
1186 | /* TODO: Add support for _GPE returning a package */ | |
27663c58 | 1187 | status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp); |
cd8c93a4 AS |
1188 | if (ACPI_FAILURE(status)) |
1189 | return status; | |
27663c58 | 1190 | ec->gpe = tmp; |
837012ed | 1191 | /* Use the global lock for all EC transactions? */ |
d21cf3c1 | 1192 | tmp = 0; |
27663c58 MW |
1193 | acpi_evaluate_integer(handle, "_GLK", NULL, &tmp); |
1194 | ec->global_lock = tmp; | |
837012ed | 1195 | ec->handle = handle; |
cd8c93a4 | 1196 | return AE_CTRL_TERMINATE; |
837012ed AS |
1197 | } |
1198 | ||
5efc5476 BH |
1199 | static int ec_install_handlers(struct acpi_ec *ec) |
1200 | { | |
1201 | acpi_status status; | |
7a73e60e | 1202 | |
5efc5476 BH |
1203 | if (test_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags)) |
1204 | return 0; | |
ca37bfdf | 1205 | status = acpi_install_gpe_raw_handler(NULL, ec->gpe, |
5efc5476 BH |
1206 | ACPI_GPE_EDGE_TRIGGERED, |
1207 | &acpi_ec_gpe_handler, ec); | |
1208 | if (ACPI_FAILURE(status)) | |
1209 | return -ENODEV; | |
9630bdd9 | 1210 | |
ad479e7f | 1211 | acpi_ec_start(ec, false); |
5efc5476 BH |
1212 | status = acpi_install_address_space_handler(ec->handle, |
1213 | ACPI_ADR_SPACE_EC, | |
1214 | &acpi_ec_space_handler, | |
1215 | NULL, ec); | |
1216 | if (ACPI_FAILURE(status)) { | |
1217 | if (status == AE_NOT_FOUND) { | |
1218 | /* | |
1219 | * Maybe OS fails in evaluating the _REG object. | |
1220 | * The AE_NOT_FOUND error will be ignored and OS | |
1221 | * continue to initialize EC. | |
1222 | */ | |
16a26e85 | 1223 | pr_err("Fail in evaluating the _REG object" |
5efc5476 BH |
1224 | " of EC device. Broken bios is suspected.\n"); |
1225 | } else { | |
ad479e7f | 1226 | acpi_ec_stop(ec, false); |
5efc5476 BH |
1227 | acpi_remove_gpe_handler(NULL, ec->gpe, |
1228 | &acpi_ec_gpe_handler); | |
1229 | return -ENODEV; | |
1230 | } | |
1231 | } | |
1232 | ||
1233 | set_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags); | |
1234 | return 0; | |
1235 | } | |
1236 | ||
4c611060 AS |
1237 | static void ec_remove_handlers(struct acpi_ec *ec) |
1238 | { | |
1741acea LZ |
1239 | if (!test_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags)) |
1240 | return; | |
ad479e7f | 1241 | acpi_ec_stop(ec, false); |
4c611060 AS |
1242 | if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle, |
1243 | ACPI_ADR_SPACE_EC, &acpi_ec_space_handler))) | |
16a26e85 | 1244 | pr_err("failed to remove space handler\n"); |
4c611060 AS |
1245 | if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe, |
1246 | &acpi_ec_gpe_handler))) | |
16a26e85 | 1247 | pr_err("failed to remove gpe handler\n"); |
7c6db4e0 | 1248 | clear_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags); |
4c611060 AS |
1249 | } |
1250 | ||
703959d4 | 1251 | static int acpi_ec_add(struct acpi_device *device) |
1da177e4 | 1252 | { |
703959d4 | 1253 | struct acpi_ec *ec = NULL; |
d02be047 | 1254 | int ret; |
45bea155 | 1255 | |
c0900c35 AS |
1256 | strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME); |
1257 | strcpy(acpi_device_class(device), ACPI_EC_CLASS); | |
1258 | ||
4c611060 | 1259 | /* Check for boot EC */ |
ce52ddf5 AS |
1260 | if (boot_ec && |
1261 | (boot_ec->handle == device->handle || | |
1262 | boot_ec->handle == ACPI_ROOT_OBJECT)) { | |
1263 | ec = boot_ec; | |
1264 | boot_ec = NULL; | |
1265 | } else { | |
1266 | ec = make_acpi_ec(); | |
1267 | if (!ec) | |
1268 | return -ENOMEM; | |
a5032bfd AS |
1269 | } |
1270 | if (ec_parse_device(device->handle, 0, ec, NULL) != | |
1271 | AE_CTRL_TERMINATE) { | |
ce52ddf5 AS |
1272 | kfree(ec); |
1273 | return -EINVAL; | |
4c611060 AS |
1274 | } |
1275 | ||
ce52ddf5 AS |
1276 | /* Find and register all query methods */ |
1277 | acpi_walk_namespace(ACPI_TYPE_METHOD, ec->handle, 1, | |
2263576c | 1278 | acpi_ec_register_query_methods, NULL, ec, NULL); |
ce52ddf5 | 1279 | |
4c611060 AS |
1280 | if (!first_ec) |
1281 | first_ec = ec; | |
db89b4f0 | 1282 | device->driver_data = ec; |
de4f1046 | 1283 | |
d6795fe3 AK |
1284 | ret = !!request_region(ec->data_addr, 1, "EC data"); |
1285 | WARN(!ret, "Could not request EC data io port 0x%lx", ec->data_addr); | |
1286 | ret = !!request_region(ec->command_addr, 1, "EC cmd"); | |
1287 | WARN(!ret, "Could not request EC cmd io port 0x%lx", ec->command_addr); | |
de4f1046 | 1288 | |
16a26e85 | 1289 | pr_info("GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n", |
4c611060 | 1290 | ec->gpe, ec->command_addr, ec->data_addr); |
5efc5476 BH |
1291 | |
1292 | ret = ec_install_handlers(ec); | |
1293 | ||
1c832b3e LT |
1294 | /* Reprobe devices depending on the EC */ |
1295 | acpi_walk_dep_device_list(ec->handle); | |
1296 | ||
5efc5476 | 1297 | /* EC is fully operational, allow queries */ |
37d11391 | 1298 | clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags); |
ad332c8a KC |
1299 | |
1300 | /* Clear stale _Q events if hardware might require that */ | |
550b3aac | 1301 | if (EC_FLAGS_CLEAR_ON_RESUME) |
ad332c8a | 1302 | acpi_ec_clear(ec); |
5efc5476 | 1303 | return ret; |
1da177e4 LT |
1304 | } |
1305 | ||
51fac838 | 1306 | static int acpi_ec_remove(struct acpi_device *device) |
1da177e4 | 1307 | { |
01f22462 | 1308 | struct acpi_ec *ec; |
07ddf768 | 1309 | struct acpi_ec_query_handler *handler, *tmp; |
1da177e4 | 1310 | |
1da177e4 | 1311 | if (!device) |
d550d98d | 1312 | return -EINVAL; |
1da177e4 LT |
1313 | |
1314 | ec = acpi_driver_data(device); | |
cf745ec7 | 1315 | ec_remove_handlers(ec); |
f351d027 | 1316 | mutex_lock(&ec->mutex); |
07ddf768 | 1317 | list_for_each_entry_safe(handler, tmp, &ec->list, node) { |
837012ed AS |
1318 | list_del(&handler->node); |
1319 | kfree(handler); | |
1320 | } | |
f351d027 | 1321 | mutex_unlock(&ec->mutex); |
de4f1046 TR |
1322 | release_region(ec->data_addr, 1); |
1323 | release_region(ec->command_addr, 1); | |
db89b4f0 | 1324 | device->driver_data = NULL; |
d033879c | 1325 | if (ec == first_ec) |
c0900c35 | 1326 | first_ec = NULL; |
4c611060 | 1327 | kfree(ec); |
d550d98d | 1328 | return 0; |
1da177e4 LT |
1329 | } |
1330 | ||
1da177e4 | 1331 | static acpi_status |
c0900c35 | 1332 | ec_parse_io_ports(struct acpi_resource *resource, void *context) |
1da177e4 | 1333 | { |
3d02b90b | 1334 | struct acpi_ec *ec = context; |
1da177e4 | 1335 | |
01f22462 | 1336 | if (resource->type != ACPI_RESOURCE_TYPE_IO) |
1da177e4 | 1337 | return AE_OK; |
1da177e4 LT |
1338 | |
1339 | /* | |
1340 | * The first address region returned is the data port, and | |
1341 | * the second address region returned is the status/command | |
1342 | * port. | |
1343 | */ | |
de4f1046 | 1344 | if (ec->data_addr == 0) |
6ffb221a | 1345 | ec->data_addr = resource->data.io.minimum; |
de4f1046 | 1346 | else if (ec->command_addr == 0) |
6ffb221a | 1347 | ec->command_addr = resource->data.io.minimum; |
01f22462 | 1348 | else |
1da177e4 | 1349 | return AE_CTRL_TERMINATE; |
1da177e4 | 1350 | |
1da177e4 LT |
1351 | return AE_OK; |
1352 | } | |
1353 | ||
c04209a7 AS |
1354 | int __init acpi_boot_ec_enable(void) |
1355 | { | |
7c6db4e0 | 1356 | if (!boot_ec || test_bit(EC_FLAGS_HANDLERS_INSTALLED, &boot_ec->flags)) |
c04209a7 AS |
1357 | return 0; |
1358 | if (!ec_install_handlers(boot_ec)) { | |
1359 | first_ec = boot_ec; | |
1360 | return 0; | |
1361 | } | |
1362 | return -EFAULT; | |
1363 | } | |
1364 | ||
223883b7 AS |
1365 | static const struct acpi_device_id ec_device_ids[] = { |
1366 | {"PNP0C09", 0}, | |
1367 | {"", 0}, | |
1368 | }; | |
1369 | ||
478fa03b AS |
1370 | /* Some BIOS do not survive early DSDT scan, skip it */ |
1371 | static int ec_skip_dsdt_scan(const struct dmi_system_id *id) | |
1372 | { | |
1373 | EC_FLAGS_SKIP_DSDT_SCAN = 1; | |
1374 | return 0; | |
1375 | } | |
1376 | ||
0adf3c74 AS |
1377 | /* ASUStek often supplies us with broken ECDT, validate it */ |
1378 | static int ec_validate_ecdt(const struct dmi_system_id *id) | |
1379 | { | |
1380 | EC_FLAGS_VALIDATE_ECDT = 1; | |
1381 | return 0; | |
1382 | } | |
1383 | ||
79149001 LZ |
1384 | /* |
1385 | * Acer EC firmware refuses to respond QR_EC when SCI_EVT is not set, for | |
1386 | * which case, we complete the QR_EC without issuing it to the firmware. | |
1387 | * https://bugzilla.kernel.org/show_bug.cgi?id=86211 | |
1388 | */ | |
1389 | static int ec_flag_query_handshake(const struct dmi_system_id *id) | |
1390 | { | |
1391 | pr_debug("Detected the EC firmware requiring QR_EC issued when SCI_EVT set\n"); | |
1392 | EC_FLAGS_QUERY_HANDSHAKE = 1; | |
1393 | return 0; | |
1394 | } | |
1395 | ||
ad332c8a KC |
1396 | /* |
1397 | * On some hardware it is necessary to clear events accumulated by the EC during | |
1398 | * sleep. These ECs stop reporting GPEs until they are manually polled, if too | |
1399 | * many events are accumulated. (e.g. Samsung Series 5/9 notebooks) | |
1400 | * | |
1401 | * https://bugzilla.kernel.org/show_bug.cgi?id=44161 | |
1402 | * | |
1403 | * Ideally, the EC should also be instructed NOT to accumulate events during | |
1404 | * sleep (which Windows seems to do somehow), but the interface to control this | |
1405 | * behaviour is not known at this time. | |
1406 | * | |
1407 | * Models known to be affected are Samsung 530Uxx/535Uxx/540Uxx/550Pxx/900Xxx, | |
1408 | * however it is very likely that other Samsung models are affected. | |
1409 | * | |
1410 | * On systems which don't accumulate _Q events during sleep, this extra check | |
1411 | * should be harmless. | |
1412 | */ | |
1413 | static int ec_clear_on_resume(const struct dmi_system_id *id) | |
1414 | { | |
1415 | pr_debug("Detected system needing EC poll on resume.\n"); | |
1416 | EC_FLAGS_CLEAR_ON_RESUME = 1; | |
1417 | return 0; | |
1418 | } | |
1419 | ||
6cef7497 | 1420 | static struct dmi_system_id ec_dmi_table[] __initdata = { |
478fa03b AS |
1421 | { |
1422 | ec_skip_dsdt_scan, "Compal JFL92", { | |
1423 | DMI_MATCH(DMI_BIOS_VENDOR, "COMPAL"), | |
1424 | DMI_MATCH(DMI_BOARD_NAME, "JFL92") }, NULL}, | |
0adf3c74 | 1425 | { |
3174abcf LZ |
1426 | ec_validate_ecdt, "MSI MS-171F", { |
1427 | DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star"), | |
1428 | DMI_MATCH(DMI_PRODUCT_NAME, "MS-171F"),}, NULL}, | |
777cb382 | 1429 | { |
0adf3c74 AS |
1430 | ec_validate_ecdt, "ASUS hardware", { |
1431 | DMI_MATCH(DMI_BIOS_VENDOR, "ASUS") }, NULL}, | |
af986d10 PC |
1432 | { |
1433 | ec_validate_ecdt, "ASUS hardware", { | |
1434 | DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer Inc.") }, NULL}, | |
67bfa9b6 | 1435 | { |
eff9a4b6 LT |
1436 | ec_skip_dsdt_scan, "HP Folio 13", { |
1437 | DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"), | |
1438 | DMI_MATCH(DMI_PRODUCT_NAME, "HP Folio 13"),}, NULL}, | |
524f42fa LT |
1439 | { |
1440 | ec_validate_ecdt, "ASUS hardware", { | |
1441 | DMI_MATCH(DMI_SYS_VENDOR, "ASUSTek Computer Inc."), | |
1442 | DMI_MATCH(DMI_PRODUCT_NAME, "L4R"),}, NULL}, | |
ad332c8a KC |
1443 | { |
1444 | ec_clear_on_resume, "Samsung hardware", { | |
1445 | DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD.")}, NULL}, | |
79149001 LZ |
1446 | { |
1447 | ec_flag_query_handshake, "Acer hardware", { | |
1448 | DMI_MATCH(DMI_SYS_VENDOR, "Acer"), }, NULL}, | |
0adf3c74 AS |
1449 | {}, |
1450 | }; | |
1451 | ||
c0900c35 AS |
1452 | int __init acpi_ec_ecdt_probe(void) |
1453 | { | |
c0900c35 | 1454 | acpi_status status; |
c6cb0e87 | 1455 | struct acpi_ec *saved_ec = NULL; |
50526df6 | 1456 | struct acpi_table_ecdt *ecdt_ptr; |
45bea155 | 1457 | |
d66d969d AS |
1458 | boot_ec = make_acpi_ec(); |
1459 | if (!boot_ec) | |
c0900c35 AS |
1460 | return -ENOMEM; |
1461 | /* | |
1462 | * Generate a boot ec context | |
1463 | */ | |
0adf3c74 | 1464 | dmi_check_system(ec_dmi_table); |
15a58ed1 AS |
1465 | status = acpi_get_table(ACPI_SIG_ECDT, 1, |
1466 | (struct acpi_table_header **)&ecdt_ptr); | |
cd8c93a4 | 1467 | if (ACPI_SUCCESS(status)) { |
16a26e85 | 1468 | pr_info("EC description table is found, configuring boot EC\n"); |
cd8c93a4 AS |
1469 | boot_ec->command_addr = ecdt_ptr->control.address; |
1470 | boot_ec->data_addr = ecdt_ptr->data.address; | |
1471 | boot_ec->gpe = ecdt_ptr->gpe; | |
4af8e10a | 1472 | boot_ec->handle = ACPI_ROOT_OBJECT; |
7a73e60e LZ |
1473 | acpi_get_handle(ACPI_ROOT_OBJECT, ecdt_ptr->id, |
1474 | &boot_ec->handle); | |
c6cb0e87 | 1475 | /* Don't trust ECDT, which comes from ASUSTek */ |
0adf3c74 | 1476 | if (!EC_FLAGS_VALIDATE_ECDT) |
c5279dee | 1477 | goto install; |
d6bd535d | 1478 | saved_ec = kmemdup(boot_ec, sizeof(struct acpi_ec), GFP_KERNEL); |
c6cb0e87 AS |
1479 | if (!saved_ec) |
1480 | return -ENOMEM; | |
c5279dee | 1481 | /* fall through */ |
cd8c93a4 | 1482 | } |
0adf3c74 | 1483 | |
ed4b197d CIK |
1484 | if (EC_FLAGS_SKIP_DSDT_SCAN) { |
1485 | kfree(saved_ec); | |
478fa03b | 1486 | return -ENODEV; |
ed4b197d | 1487 | } |
478fa03b | 1488 | |
c5279dee AS |
1489 | /* This workaround is needed only on some broken machines, |
1490 | * which require early EC, but fail to provide ECDT */ | |
16a26e85 | 1491 | pr_debug("Look up EC in DSDT\n"); |
c5279dee AS |
1492 | status = acpi_get_devices(ec_device_ids[0].id, ec_parse_device, |
1493 | boot_ec, NULL); | |
1494 | /* Check that acpi_get_devices actually find something */ | |
1495 | if (ACPI_FAILURE(status) || !boot_ec->handle) | |
1496 | goto error; | |
c6cb0e87 AS |
1497 | if (saved_ec) { |
1498 | /* try to find good ECDT from ASUSTek */ | |
1499 | if (saved_ec->command_addr != boot_ec->command_addr || | |
1500 | saved_ec->data_addr != boot_ec->data_addr || | |
1501 | saved_ec->gpe != boot_ec->gpe || | |
1502 | saved_ec->handle != boot_ec->handle) | |
16a26e85 | 1503 | pr_info("ASUSTek keeps feeding us with broken " |
c6cb0e87 AS |
1504 | "ECDT tables, which are very hard to workaround. " |
1505 | "Trying to use DSDT EC info instead. Please send " | |
1506 | "output of acpidump to linux-acpi@vger.kernel.org\n"); | |
1507 | kfree(saved_ec); | |
1508 | saved_ec = NULL; | |
1509 | } else { | |
1510 | /* We really need to limit this workaround, the only ASUS, | |
1511 | * which needs it, has fake EC._INI method, so use it as flag. | |
1512 | * Keep boot_ec struct as it will be needed soon. | |
1513 | */ | |
c6cb0e87 | 1514 | if (!dmi_name_in_vendors("ASUS") || |
952c63e9 | 1515 | !acpi_has_method(boot_ec->handle, "_INI")) |
c6cb0e87 AS |
1516 | return -ENODEV; |
1517 | } | |
c5279dee AS |
1518 | install: |
1519 | if (!ec_install_handlers(boot_ec)) { | |
d033879c | 1520 | first_ec = boot_ec; |
e8284321 | 1521 | return 0; |
d033879c | 1522 | } |
c5279dee | 1523 | error: |
d66d969d | 1524 | kfree(boot_ec); |
ed4b197d | 1525 | kfree(saved_ec); |
d66d969d | 1526 | boot_ec = NULL; |
1da177e4 LT |
1527 | return -ENODEV; |
1528 | } | |
1529 | ||
1d68d261 LZ |
1530 | static int param_set_event_clearing(const char *val, struct kernel_param *kp) |
1531 | { | |
1532 | int result = 0; | |
1533 | ||
1534 | if (!strncmp(val, "status", sizeof("status") - 1)) { | |
1535 | ec_event_clearing = ACPI_EC_EVT_TIMING_STATUS; | |
1536 | pr_info("Assuming SCI_EVT clearing on EC_SC accesses\n"); | |
1537 | } else if (!strncmp(val, "query", sizeof("query") - 1)) { | |
1538 | ec_event_clearing = ACPI_EC_EVT_TIMING_QUERY; | |
1539 | pr_info("Assuming SCI_EVT clearing on QR_EC writes\n"); | |
1540 | } else if (!strncmp(val, "event", sizeof("event") - 1)) { | |
1541 | ec_event_clearing = ACPI_EC_EVT_TIMING_EVENT; | |
1542 | pr_info("Assuming SCI_EVT clearing on event reads\n"); | |
1543 | } else | |
1544 | result = -EINVAL; | |
1545 | return result; | |
1546 | } | |
1547 | ||
1548 | static int param_get_event_clearing(char *buffer, struct kernel_param *kp) | |
1549 | { | |
1550 | switch (ec_event_clearing) { | |
1551 | case ACPI_EC_EVT_TIMING_STATUS: | |
1552 | return sprintf(buffer, "status"); | |
1553 | case ACPI_EC_EVT_TIMING_QUERY: | |
1554 | return sprintf(buffer, "query"); | |
1555 | case ACPI_EC_EVT_TIMING_EVENT: | |
1556 | return sprintf(buffer, "event"); | |
1557 | default: | |
1558 | return sprintf(buffer, "invalid"); | |
1559 | } | |
1560 | return 0; | |
1561 | } | |
1562 | ||
1563 | module_param_call(ec_event_clearing, param_set_event_clearing, param_get_event_clearing, | |
1564 | NULL, 0644); | |
1565 | MODULE_PARM_DESC(ec_event_clearing, "Assumed SCI_EVT clearing timing"); | |
1566 | ||
223883b7 AS |
1567 | static struct acpi_driver acpi_ec_driver = { |
1568 | .name = "ec", | |
1569 | .class = ACPI_EC_CLASS, | |
1570 | .ids = ec_device_ids, | |
1571 | .ops = { | |
1572 | .add = acpi_ec_add, | |
1573 | .remove = acpi_ec_remove, | |
223883b7 AS |
1574 | }, |
1575 | }; | |
1576 | ||
a5f820fe | 1577 | int __init acpi_ec_init(void) |
1da177e4 | 1578 | { |
50526df6 | 1579 | int result = 0; |
1da177e4 | 1580 | |
1da177e4 LT |
1581 | /* Now register the driver for the EC */ |
1582 | result = acpi_bus_register_driver(&acpi_ec_driver); | |
49c6c5ff | 1583 | if (result < 0) |
d550d98d | 1584 | return -ENODEV; |
1da177e4 | 1585 | |
d550d98d | 1586 | return result; |
1da177e4 LT |
1587 | } |
1588 | ||
1da177e4 LT |
1589 | /* EC driver currently not unloadable */ |
1590 | #if 0 | |
50526df6 | 1591 | static void __exit acpi_ec_exit(void) |
1da177e4 | 1592 | { |
1da177e4 LT |
1593 | |
1594 | acpi_bus_unregister_driver(&acpi_ec_driver); | |
1da177e4 | 1595 | } |
7843932a | 1596 | #endif /* 0 */ |