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