blob: 48d4815603e5a79e10a2f26c17f8ea90ea118eb1 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Lv Zhenga8d4fc22015-02-05 16:27:35 +08002 * ec.c - ACPI Embedded Controller Driver (v3)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Lv Zhenga8d4fc22015-02-05 16:27:35 +08004 * Copyright (C) 2001-2015 Intel Corporation
5 * Author: 2014, 2015 Lv Zheng <lv.zheng@intel.com>
Lv Zheng4a3f6b52014-06-15 08:42:19 +08006 * 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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 *
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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26 */
27
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +040028/* Uncomment next line to get verbose printout */
Márton Némethd772b3b2008-01-23 22:34:09 -050029/* #define DEBUG */
Vincent Legollb6aeab42017-05-20 20:38:13 +020030#define pr_fmt(fmt) "ACPI: EC: " fmt
Márton Némethd772b3b2008-01-23 22:34:09 -050031
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/kernel.h>
33#include <linux/module.h>
34#include <linux/init.h>
35#include <linux/types.h>
36#include <linux/delay.h>
Dmitry Torokhov451566f2005-03-19 01:10:05 -050037#include <linux/interrupt.h>
Alexey Starikovskiy837012e2007-05-29 16:43:02 +040038#include <linux/list.h>
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +040039#include <linux/spinlock.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090040#include <linux/slab.h>
Lv Zheng8b484632013-12-03 08:49:16 +080041#include <linux/acpi.h>
Len Browneb27cae2009-07-06 23:40:19 -040042#include <linux/dmi.h>
Lv Zheng8b484632013-12-03 08:49:16 +080043#include <asm/io.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Thomas Renninger1195a092010-07-16 13:11:31 +020045#include "internal.h"
46
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#define ACPI_EC_CLASS "embedded_controller"
Linus Torvalds1da177e2005-04-16 15:20:36 -070048#define ACPI_EC_DEVICE_NAME "Embedded Controller"
49#define ACPI_EC_FILE_INFO "info"
Alexey Starikovskiy837012e2007-05-29 16:43:02 +040050
Denis M. Sadykov703959d2006-09-26 19:50:33 +040051/* EC status register */
Linus Torvalds1da177e2005-04-16 15:20:36 -070052#define ACPI_EC_FLAG_OBF 0x01 /* Output buffer full */
53#define ACPI_EC_FLAG_IBF 0x02 /* Input buffer full */
Lv Zhengdd43de22014-06-15 08:42:42 +080054#define ACPI_EC_FLAG_CMD 0x08 /* Input buffer contains a command */
Dmitry Torokhov451566f2005-03-19 01:10:05 -050055#define ACPI_EC_FLAG_BURST 0x10 /* burst mode */
Linus Torvalds1da177e2005-04-16 15:20:36 -070056#define ACPI_EC_FLAG_SCI 0x20 /* EC-SCI occurred */
Alexey Starikovskiy43509332007-05-29 16:42:57 +040057
Lv Zheng1d68d262015-06-11 13:21:38 +080058/*
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
Denis M. Sadykov703959d2006-09-26 19:50:33 +040090/* EC commands */
Alexey Starikovskiy3261ff42006-12-07 18:42:17 +030091enum ec_command {
Alexey Starikovskiy6ccedb12006-12-07 18:42:17 +030092 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,
Alexey Starikovskiy3261ff42006-12-07 18:42:17 +030097};
Alexey Starikovskiy837012e2007-05-29 16:43:02 +040098
Alexey Starikovskiy5c406412006-12-07 18:42:16 +030099#define ACPI_EC_DELAY 500 /* Wait 500ms max. during EC ops */
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400100#define ACPI_EC_UDELAY_GLK 1000 /* Wait 1ms max. to get global lock */
Lv Zhengd8d031a2015-05-15 14:16:42 +0800101#define ACPI_EC_UDELAY_POLL 550 /* Wait 1ms for EC transaction polling */
Kieran Clancyad332c82014-03-01 00:42:28 +1030102#define ACPI_EC_CLEAR_MAX 100 /* Maximum number of events to query
103 * when trying to clear the EC */
Lv Zhenge1191bd2016-08-03 09:00:14 +0800104#define ACPI_EC_MAX_QUERIES 16 /* Maximum number of parallel queries */
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400105
Alexey Starikovskiy080e4122007-10-22 14:18:30 +0400106enum {
Lv Zheng750f628b2016-08-03 16:01:24 +0800107 EC_FLAGS_QUERY_ENABLED, /* Query is enabled */
Rafael J. Wysocki37d11392015-02-11 17:35:05 +0100108 EC_FLAGS_QUERY_PENDING, /* Query is pending */
Lv Zheng1d68d262015-06-11 13:21:38 +0800109 EC_FLAGS_QUERY_GUARDING, /* Guard for SCI_EVT check */
Lv Zheng0e1affe2016-03-24 10:42:47 +0800110 EC_FLAGS_GPE_HANDLER_INSTALLED, /* GPE handler installed */
111 EC_FLAGS_EC_HANDLER_INSTALLED, /* OpReg handler installed */
Lv Zheng2a570842016-09-07 16:50:21 +0800112 EC_FLAGS_EVT_HANDLER_INSTALLED, /* _Qxx handlers installed */
Lv Zhengad479e72015-02-06 08:57:52 +0800113 EC_FLAGS_STARTED, /* Driver is started */
114 EC_FLAGS_STOPPED, /* Driver is stopped */
Lv Zheng56f77ee2017-08-11 14:36:28 +0800115 EC_FLAGS_GPE_MASKED, /* GPE masked */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116};
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400117
Lv Zhengf92fca02014-06-15 08:41:35 +0800118#define ACPI_EC_COMMAND_POLL 0x01 /* Available for command byte */
119#define ACPI_EC_COMMAND_COMPLETE 0x02 /* Completed last byte */
120
Thomas Renninger7a18e962010-10-21 18:24:57 +0200121/* ec.c is compiled in acpi namespace so this shows up as acpi.ec_delay param */
122static unsigned int ec_delay __read_mostly = ACPI_EC_DELAY;
123module_param(ec_delay, uint, 0644);
124MODULE_PARM_DESC(ec_delay, "Timeout(ms) waited until an EC command completes");
125
Lv Zhenge1191bd2016-08-03 09:00:14 +0800126static unsigned int ec_max_queries __read_mostly = ACPI_EC_MAX_QUERIES;
127module_param(ec_max_queries, uint, 0644);
128MODULE_PARM_DESC(ec_max_queries, "Maximum parallel _Qxx evaluations");
129
Lv Zheng15de6032015-05-15 14:16:48 +0800130static bool ec_busy_polling __read_mostly;
131module_param(ec_busy_polling, bool, 0644);
132MODULE_PARM_DESC(ec_busy_polling, "Use busy polling to advance EC transaction");
133
134static unsigned int ec_polling_guard __read_mostly = ACPI_EC_UDELAY_POLL;
135module_param(ec_polling_guard, uint, 0644);
136MODULE_PARM_DESC(ec_polling_guard, "Guard time(us) between EC accesses in polling modes");
137
Lv Zheng3cb02ae2015-06-11 13:21:45 +0800138static unsigned int ec_event_clearing __read_mostly = ACPI_EC_EVT_TIMING_QUERY;
Lv Zheng1d68d262015-06-11 13:21:38 +0800139
Feng Tanga520d522012-09-28 15:22:00 +0800140/*
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 */
145static unsigned int ec_storm_threshold __read_mostly = 8;
146module_param(ec_storm_threshold, uint, 0644);
147MODULE_PARM_DESC(ec_storm_threshold, "Maxim false GPE numbers not considered as GPE storm");
148
Lv Zheng9c40f952017-07-12 11:09:17 +0800149static bool ec_freeze_events __read_mostly = false;
Lv Zheng39a2a2a2016-08-03 16:01:43 +0800150module_param(ec_freeze_events, bool, 0644);
151MODULE_PARM_DESC(ec_freeze_events, "Disabling event handling during suspend/resume");
152
Rafael J. Wysocki76380632017-07-19 14:41:58 +0200153static bool ec_no_wakeup __read_mostly;
154module_param(ec_no_wakeup, bool, 0644);
155MODULE_PARM_DESC(ec_no_wakeup, "Do not wake up from suspend-to-idle");
156
Alexey Starikovskiy837012e2007-05-29 16:43:02 +0400157struct acpi_ec_query_handler {
158 struct list_head node;
159 acpi_ec_query_func func;
160 acpi_handle handle;
161 void *data;
162 u8 query_bit;
Lv Zheng01305d42015-01-14 19:28:28 +0800163 struct kref kref;
Alexey Starikovskiy837012e2007-05-29 16:43:02 +0400164};
165
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400166struct transaction {
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400167 const u8 *wdata;
168 u8 *rdata;
169 unsigned short irq_count;
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400170 u8 command;
Alexey Starikovskiya2f93ae2008-11-12 01:40:19 +0300171 u8 wi;
172 u8 ri;
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400173 u8 wlen;
174 u8 rlen;
Lv Zhengf92fca02014-06-15 08:41:35 +0800175 u8 flags;
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400176};
177
Lv Zheng02b771b2015-08-12 11:12:02 +0800178struct acpi_ec_query {
179 struct transaction transaction;
180 struct work_struct work;
181 struct acpi_ec_query_handler *handler;
182};
183
Lv Zheng550b3aac2015-01-14 19:28:53 +0800184static int acpi_ec_query(struct acpi_ec *ec, u8 *data);
Lv Zhengca37bfd2015-02-05 16:27:22 +0800185static void advance_transaction(struct acpi_ec *ec);
Lv Zheng02b771b2015-08-12 11:12:02 +0800186static void acpi_ec_event_handler(struct work_struct *work);
187static void acpi_ec_event_processor(struct work_struct *work);
Lv Zheng74443bb2015-01-14 19:28:47 +0800188
Rafael J. Wysockia9c30762019-02-01 10:57:01 +0100189struct acpi_ec *first_ec;
Thomas Renninger1195a092010-07-16 13:11:31 +0200190EXPORT_SYMBOL(first_ec);
Rafael J. Wysockia9c30762019-02-01 10:57:01 +0100191
192static struct acpi_ec *boot_ec;
Lv Zheng72c77b72016-09-07 16:50:08 +0800193static bool boot_ec_is_ecdt = false;
Lv Zhenge1191bd2016-08-03 09:00:14 +0800194static struct workqueue_struct *ec_query_wq;
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400195
Lv Zheng79149002014-10-29 11:33:49 +0800196static int EC_FLAGS_QUERY_HANDSHAKE; /* Needs QR_EC issued when SCI_EVT set */
Lv Zheng59f0aa92016-03-24 10:42:53 +0800197static int EC_FLAGS_CORRECT_ECDT; /* Needs ECDT port address correction */
Chris Chiu440f53d2017-06-15 09:41:47 +0800198static int EC_FLAGS_IGNORE_DSDT_GPE; /* Needs ECDT GPE as correction setting */
Zhang Ruib6a3e142019-02-01 14:13:41 +0800199static int EC_FLAGS_CLEAR_ON_RESUME; /* Needs acpi_ec_clear() on boot/resume */
Alexey Starikovskiy5423a0c2009-02-21 12:18:13 -0500200
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201/* --------------------------------------------------------------------------
Lv Zheng3535a3c2015-02-27 14:48:15 +0800202 * Logging/Debugging
203 * -------------------------------------------------------------------------- */
204
205/*
206 * Splitters used by the developers to track the boundary of the EC
207 * handling processes.
208 */
209#ifdef DEBUG
210#define EC_DBG_SEP " "
211#define EC_DBG_DRV "+++++"
212#define EC_DBG_STM "====="
213#define EC_DBG_REQ "*****"
214#define EC_DBG_EVT "#####"
215#else
216#define EC_DBG_SEP ""
217#define EC_DBG_DRV
218#define EC_DBG_STM
219#define EC_DBG_REQ
220#define EC_DBG_EVT
221#endif
222
223#define ec_log_raw(fmt, ...) \
224 pr_info(fmt "\n", ##__VA_ARGS__)
225#define ec_dbg_raw(fmt, ...) \
226 pr_debug(fmt "\n", ##__VA_ARGS__)
227#define ec_log(filter, fmt, ...) \
228 ec_log_raw(filter EC_DBG_SEP fmt EC_DBG_SEP filter, ##__VA_ARGS__)
229#define ec_dbg(filter, fmt, ...) \
230 ec_dbg_raw(filter EC_DBG_SEP fmt EC_DBG_SEP filter, ##__VA_ARGS__)
231
232#define ec_log_drv(fmt, ...) \
233 ec_log(EC_DBG_DRV, fmt, ##__VA_ARGS__)
234#define ec_dbg_drv(fmt, ...) \
235 ec_dbg(EC_DBG_DRV, fmt, ##__VA_ARGS__)
236#define ec_dbg_stm(fmt, ...) \
237 ec_dbg(EC_DBG_STM, fmt, ##__VA_ARGS__)
238#define ec_dbg_req(fmt, ...) \
239 ec_dbg(EC_DBG_REQ, fmt, ##__VA_ARGS__)
240#define ec_dbg_evt(fmt, ...) \
241 ec_dbg(EC_DBG_EVT, fmt, ##__VA_ARGS__)
Lv Zheng770970f2015-02-27 14:48:24 +0800242#define ec_dbg_ref(ec, fmt, ...) \
243 ec_dbg_raw("%lu: " fmt, ec->reference_count, ## __VA_ARGS__)
Lv Zheng3535a3c2015-02-27 14:48:15 +0800244
245/* --------------------------------------------------------------------------
Lv Zhengad479e72015-02-06 08:57:52 +0800246 * Device Flags
247 * -------------------------------------------------------------------------- */
248
249static bool acpi_ec_started(struct acpi_ec *ec)
250{
251 return test_bit(EC_FLAGS_STARTED, &ec->flags) &&
252 !test_bit(EC_FLAGS_STOPPED, &ec->flags);
253}
254
Lv Zheng750f628b2016-08-03 16:01:24 +0800255static bool acpi_ec_event_enabled(struct acpi_ec *ec)
256{
257 /*
258 * There is an OSPM early stage logic. During the early stages
259 * (boot/resume), OSPMs shouldn't enable the event handling, only
260 * the EC transactions are allowed to be performed.
261 */
262 if (!test_bit(EC_FLAGS_QUERY_ENABLED, &ec->flags))
263 return false;
264 /*
Lv Zheng39a2a2a2016-08-03 16:01:43 +0800265 * However, disabling the event handling is experimental for late
266 * stage (suspend), and is controlled by the boot parameter of
267 * "ec_freeze_events":
268 * 1. true: The EC event handling is disabled before entering
269 * the noirq stage.
270 * 2. false: The EC event handling is automatically disabled as
271 * soon as the EC driver is stopped.
Lv Zheng750f628b2016-08-03 16:01:24 +0800272 */
Lv Zheng39a2a2a2016-08-03 16:01:43 +0800273 if (ec_freeze_events)
274 return acpi_ec_started(ec);
275 else
276 return test_bit(EC_FLAGS_STARTED, &ec->flags);
Lv Zheng750f628b2016-08-03 16:01:24 +0800277}
278
Lv Zheng9887d222015-02-06 08:57:59 +0800279static bool acpi_ec_flushed(struct acpi_ec *ec)
280{
281 return ec->reference_count == 1;
282}
283
Lv Zhengad479e72015-02-06 08:57:52 +0800284/* --------------------------------------------------------------------------
Lv Zhengca37bfd2015-02-05 16:27:22 +0800285 * EC Registers
Lv Zheng7a73e602014-10-14 14:24:01 +0800286 * -------------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400288static inline u8 acpi_ec_read_status(struct acpi_ec *ec)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289{
Márton Németh3ebe08a2007-11-21 03:23:26 +0300290 u8 x = inb(ec->command_addr);
Lv Zheng7a73e602014-10-14 14:24:01 +0800291
Lv Zheng3535a3c2015-02-27 14:48:15 +0800292 ec_dbg_raw("EC_SC(R) = 0x%2.2x "
293 "SCI_EVT=%d BURST=%d CMD=%d IBF=%d OBF=%d",
294 x,
295 !!(x & ACPI_EC_FLAG_SCI),
296 !!(x & ACPI_EC_FLAG_BURST),
297 !!(x & ACPI_EC_FLAG_CMD),
298 !!(x & ACPI_EC_FLAG_IBF),
299 !!(x & ACPI_EC_FLAG_OBF));
Márton Németh3ebe08a2007-11-21 03:23:26 +0300300 return x;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301}
302
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400303static inline u8 acpi_ec_read_data(struct acpi_ec *ec)
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400304{
Márton Németh3ebe08a2007-11-21 03:23:26 +0300305 u8 x = inb(ec->data_addr);
Lv Zheng7a73e602014-10-14 14:24:01 +0800306
Lv Zhengd8d031a2015-05-15 14:16:42 +0800307 ec->timestamp = jiffies;
Lv Zheng3535a3c2015-02-27 14:48:15 +0800308 ec_dbg_raw("EC_DATA(R) = 0x%2.2x", x);
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400309 return x;
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400310}
311
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400312static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command)
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400313{
Lv Zheng3535a3c2015-02-27 14:48:15 +0800314 ec_dbg_raw("EC_SC(W) = 0x%2.2x", command);
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400315 outb(command, ec->command_addr);
Lv Zhengd8d031a2015-05-15 14:16:42 +0800316 ec->timestamp = jiffies;
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400317}
318
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400319static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data)
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400320{
Lv Zheng3535a3c2015-02-27 14:48:15 +0800321 ec_dbg_raw("EC_DATA(W) = 0x%2.2x", data);
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400322 outb(data, ec->data_addr);
Lv Zhengd8d031a2015-05-15 14:16:42 +0800323 ec->timestamp = jiffies;
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400324}
325
Lv Zheng4625d752017-06-14 13:59:18 +0800326#if defined(DEBUG) || defined(CONFIG_DYNAMIC_DEBUG)
Lv Zhenge34c0e22014-10-14 14:23:49 +0800327static const char *acpi_ec_cmd_string(u8 cmd)
328{
329 switch (cmd) {
330 case 0x80:
331 return "RD_EC";
332 case 0x81:
333 return "WR_EC";
334 case 0x82:
335 return "BE_EC";
336 case 0x83:
337 return "BD_EC";
338 case 0x84:
339 return "QR_EC";
340 }
341 return "UNKNOWN";
342}
343#else
344#define acpi_ec_cmd_string(cmd) "UNDEF"
345#endif
346
Lv Zhengca37bfd2015-02-05 16:27:22 +0800347/* --------------------------------------------------------------------------
348 * GPE Registers
349 * -------------------------------------------------------------------------- */
350
351static inline bool acpi_ec_is_gpe_raised(struct acpi_ec *ec)
352{
353 acpi_event_status gpe_status = 0;
354
355 (void)acpi_get_gpe_status(NULL, ec->gpe, &gpe_status);
Lv Zheng7c0b2592015-05-15 14:16:17 +0800356 return (gpe_status & ACPI_EVENT_FLAG_STATUS_SET) ? true : false;
Lv Zhengca37bfd2015-02-05 16:27:22 +0800357}
358
359static inline void acpi_ec_enable_gpe(struct acpi_ec *ec, bool open)
360{
361 if (open)
362 acpi_enable_gpe(NULL, ec->gpe);
Lv Zhenge1d4d902015-02-06 08:58:05 +0800363 else {
364 BUG_ON(ec->reference_count < 1);
Lv Zhengca37bfd2015-02-05 16:27:22 +0800365 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_ENABLE);
Lv Zhenge1d4d902015-02-06 08:58:05 +0800366 }
Lv Zhengca37bfd2015-02-05 16:27:22 +0800367 if (acpi_ec_is_gpe_raised(ec)) {
368 /*
369 * On some platforms, EN=1 writes cannot trigger GPE. So
370 * software need to manually trigger a pseudo GPE event on
371 * EN=1 writes.
372 */
Lv Zheng3535a3c2015-02-27 14:48:15 +0800373 ec_dbg_raw("Polling quirk");
Lv Zhengca37bfd2015-02-05 16:27:22 +0800374 advance_transaction(ec);
375 }
376}
377
378static inline void acpi_ec_disable_gpe(struct acpi_ec *ec, bool close)
379{
380 if (close)
381 acpi_disable_gpe(NULL, ec->gpe);
Lv Zhenge1d4d902015-02-06 08:58:05 +0800382 else {
383 BUG_ON(ec->reference_count < 1);
Lv Zhengca37bfd2015-02-05 16:27:22 +0800384 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_DISABLE);
Lv Zhenge1d4d902015-02-06 08:58:05 +0800385 }
Lv Zhengca37bfd2015-02-05 16:27:22 +0800386}
387
388static inline void acpi_ec_clear_gpe(struct acpi_ec *ec)
389{
390 /*
391 * GPE STS is a W1C register, which means:
392 * 1. Software can clear it without worrying about clearing other
393 * GPEs' STS bits when the hardware sets them in parallel.
394 * 2. As long as software can ensure only clearing it when it is
395 * set, hardware won't set it in parallel.
396 * So software can clear GPE in any contexts.
397 * Warning: do not move the check into advance_transaction() as the
398 * EC commands will be sent without GPE raised.
399 */
400 if (!acpi_ec_is_gpe_raised(ec))
401 return;
402 acpi_clear_gpe(NULL, ec->gpe);
403}
404
405/* --------------------------------------------------------------------------
406 * Transaction Management
407 * -------------------------------------------------------------------------- */
408
Lv Zheng9887d222015-02-06 08:57:59 +0800409static void acpi_ec_submit_request(struct acpi_ec *ec)
410{
411 ec->reference_count++;
Lv Zheng0e1affe2016-03-24 10:42:47 +0800412 if (test_bit(EC_FLAGS_GPE_HANDLER_INSTALLED, &ec->flags) &&
413 ec->reference_count == 1)
Lv Zheng9887d222015-02-06 08:57:59 +0800414 acpi_ec_enable_gpe(ec, true);
415}
416
417static void acpi_ec_complete_request(struct acpi_ec *ec)
418{
419 bool flushed = false;
420
421 ec->reference_count--;
Lv Zheng0e1affe2016-03-24 10:42:47 +0800422 if (test_bit(EC_FLAGS_GPE_HANDLER_INSTALLED, &ec->flags) &&
423 ec->reference_count == 0)
Lv Zheng9887d222015-02-06 08:57:59 +0800424 acpi_ec_disable_gpe(ec, true);
425 flushed = acpi_ec_flushed(ec);
426 if (flushed)
427 wake_up(&ec->wait);
428}
429
Lv Zheng56f77ee2017-08-11 14:36:28 +0800430static void acpi_ec_mask_gpe(struct acpi_ec *ec)
Lv Zhenge1d4d902015-02-06 08:58:05 +0800431{
Lv Zheng56f77ee2017-08-11 14:36:28 +0800432 if (!test_bit(EC_FLAGS_GPE_MASKED, &ec->flags)) {
Lv Zhenge1d4d902015-02-06 08:58:05 +0800433 acpi_ec_disable_gpe(ec, false);
Lv Zheng3535a3c2015-02-27 14:48:15 +0800434 ec_dbg_drv("Polling enabled");
Lv Zheng56f77ee2017-08-11 14:36:28 +0800435 set_bit(EC_FLAGS_GPE_MASKED, &ec->flags);
Lv Zhenge1d4d902015-02-06 08:58:05 +0800436 }
437}
438
Lv Zheng56f77ee2017-08-11 14:36:28 +0800439static void acpi_ec_unmask_gpe(struct acpi_ec *ec)
Lv Zhenge1d4d902015-02-06 08:58:05 +0800440{
Lv Zheng56f77ee2017-08-11 14:36:28 +0800441 if (test_bit(EC_FLAGS_GPE_MASKED, &ec->flags)) {
442 clear_bit(EC_FLAGS_GPE_MASKED, &ec->flags);
Lv Zhenge1d4d902015-02-06 08:58:05 +0800443 acpi_ec_enable_gpe(ec, false);
Lv Zheng3535a3c2015-02-27 14:48:15 +0800444 ec_dbg_drv("Polling disabled");
Lv Zhenge1d4d902015-02-06 08:58:05 +0800445 }
446}
447
Lv Zheng9887d222015-02-06 08:57:59 +0800448/*
449 * acpi_ec_submit_flushable_request() - Increase the reference count unless
450 * the flush operation is not in
451 * progress
452 * @ec: the EC device
453 *
454 * This function must be used before taking a new action that should hold
455 * the reference count. If this function returns false, then the action
456 * must be discarded or it will prevent the flush operation from being
457 * completed.
458 */
Rafael J. Wysocki37d11392015-02-11 17:35:05 +0100459static bool acpi_ec_submit_flushable_request(struct acpi_ec *ec)
Lv Zheng9887d222015-02-06 08:57:59 +0800460{
Rafael J. Wysocki37d11392015-02-11 17:35:05 +0100461 if (!acpi_ec_started(ec))
462 return false;
Lv Zheng9887d222015-02-06 08:57:59 +0800463 acpi_ec_submit_request(ec);
464 return true;
465}
466
Rafael J. Wysocki37d11392015-02-11 17:35:05 +0100467static void acpi_ec_submit_query(struct acpi_ec *ec)
Lv Zheng74443bb2015-01-14 19:28:47 +0800468{
Lv Zheng56f77ee2017-08-11 14:36:28 +0800469 acpi_ec_mask_gpe(ec);
Lv Zheng1ab69f22017-06-14 13:59:09 +0800470 if (!acpi_ec_event_enabled(ec))
471 return;
472 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags)) {
Lv Zheng9d8993b2015-06-11 13:21:32 +0800473 ec_dbg_evt("Command(%s) submitted/blocked",
474 acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY));
475 ec->nr_pending_queries++;
Lv Zheng74443bb2015-01-14 19:28:47 +0800476 schedule_work(&ec->work);
Lv Zhengf252cb02015-02-06 08:58:10 +0800477 }
Lv Zhengf252cb02015-02-06 08:58:10 +0800478}
479
Rafael J. Wysocki37d11392015-02-11 17:35:05 +0100480static void acpi_ec_complete_query(struct acpi_ec *ec)
Lv Zhengf252cb02015-02-06 08:58:10 +0800481{
Lv Zheng1ab69f22017-06-14 13:59:09 +0800482 if (test_and_clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags))
Lv Zheng9d8993b2015-06-11 13:21:32 +0800483 ec_dbg_evt("Command(%s) unblocked",
484 acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY));
Lv Zheng56f77ee2017-08-11 14:36:28 +0800485 acpi_ec_unmask_gpe(ec);
Lv Zheng74443bb2015-01-14 19:28:47 +0800486}
487
Lv Zheng750f628b2016-08-03 16:01:24 +0800488static inline void __acpi_ec_enable_event(struct acpi_ec *ec)
489{
490 if (!test_and_set_bit(EC_FLAGS_QUERY_ENABLED, &ec->flags))
491 ec_log_drv("event unblocked");
Lv Zheng53c5eaa2017-09-26 16:54:03 +0800492 /*
493 * Unconditionally invoke this once after enabling the event
494 * handling mechanism to detect the pending events.
495 */
496 advance_transaction(ec);
Lv Zheng750f628b2016-08-03 16:01:24 +0800497}
498
499static inline void __acpi_ec_disable_event(struct acpi_ec *ec)
500{
501 if (test_and_clear_bit(EC_FLAGS_QUERY_ENABLED, &ec->flags))
502 ec_log_drv("event blocked");
503}
504
Zhang Ruib6a3e142019-02-01 14:13:41 +0800505/*
506 * Process _Q events that might have accumulated in the EC.
507 * Run with locked ec mutex.
508 */
509static void acpi_ec_clear(struct acpi_ec *ec)
510{
511 int i, status;
512 u8 value = 0;
513
514 for (i = 0; i < ACPI_EC_CLEAR_MAX; i++) {
515 status = acpi_ec_query(ec, &value);
516 if (status || !value)
517 break;
518 }
519 if (unlikely(i == ACPI_EC_CLEAR_MAX))
520 pr_warn("Warning: Maximum of %d stale EC events cleared\n", i);
521 else
522 pr_info("%d stale EC events cleared\n", i);
523}
524
Lv Zheng750f628b2016-08-03 16:01:24 +0800525static void acpi_ec_enable_event(struct acpi_ec *ec)
526{
527 unsigned long flags;
528
529 spin_lock_irqsave(&ec->lock, flags);
530 if (acpi_ec_started(ec))
531 __acpi_ec_enable_event(ec);
532 spin_unlock_irqrestore(&ec->lock, flags);
Zhang Ruib6a3e142019-02-01 14:13:41 +0800533
534 /* Drain additional events if hardware requires that */
535 if (EC_FLAGS_CLEAR_ON_RESUME)
536 acpi_ec_clear(ec);
Lv Zheng750f628b2016-08-03 16:01:24 +0800537}
538
Eric Biggerseab05ec2016-10-05 10:33:16 -0700539#ifdef CONFIG_PM_SLEEP
Lv Zheng39a2a2a2016-08-03 16:01:43 +0800540static bool acpi_ec_query_flushed(struct acpi_ec *ec)
541{
542 bool flushed;
543 unsigned long flags;
544
545 spin_lock_irqsave(&ec->lock, flags);
546 flushed = !ec->nr_pending_queries;
547 spin_unlock_irqrestore(&ec->lock, flags);
548 return flushed;
549}
550
551static void __acpi_ec_flush_event(struct acpi_ec *ec)
552{
553 /*
554 * When ec_freeze_events is true, we need to flush events in
555 * the proper position before entering the noirq stage.
556 */
557 wait_event(ec->wait, acpi_ec_query_flushed(ec));
558 if (ec_query_wq)
559 flush_workqueue(ec_query_wq);
560}
561
562static void acpi_ec_disable_event(struct acpi_ec *ec)
563{
564 unsigned long flags;
565
566 spin_lock_irqsave(&ec->lock, flags);
567 __acpi_ec_disable_event(ec);
568 spin_unlock_irqrestore(&ec->lock, flags);
569 __acpi_ec_flush_event(ec);
570}
Rafael J. Wysocki880a6622017-07-20 03:43:12 +0200571
572void acpi_ec_flush_work(void)
573{
574 if (first_ec)
575 __acpi_ec_flush_event(first_ec);
576
577 flush_scheduled_work();
578}
Eric Biggerseab05ec2016-10-05 10:33:16 -0700579#endif /* CONFIG_PM_SLEEP */
Lv Zheng39a2a2a2016-08-03 16:01:43 +0800580
Lv Zheng1d68d262015-06-11 13:21:38 +0800581static bool acpi_ec_guard_event(struct acpi_ec *ec)
582{
Lv Zheng61197542015-09-24 14:54:54 +0800583 bool guarded = true;
584 unsigned long flags;
585
586 spin_lock_irqsave(&ec->lock, flags);
587 /*
588 * If firmware SCI_EVT clearing timing is "event", we actually
589 * don't know when the SCI_EVT will be cleared by firmware after
590 * evaluating _Qxx, so we need to re-check SCI_EVT after waiting an
591 * acceptable period.
592 *
593 * The guarding period begins when EC_FLAGS_QUERY_PENDING is
594 * flagged, which means SCI_EVT check has just been performed.
595 * But if the current transaction is ACPI_EC_COMMAND_QUERY, the
596 * guarding should have already been performed (via
597 * EC_FLAGS_QUERY_GUARDING) and should not be applied so that the
598 * ACPI_EC_COMMAND_QUERY transaction can be transitioned into
599 * ACPI_EC_COMMAND_POLL state immediately.
600 */
Lv Zheng1d68d262015-06-11 13:21:38 +0800601 if (ec_event_clearing == ACPI_EC_EVT_TIMING_STATUS ||
602 ec_event_clearing == ACPI_EC_EVT_TIMING_QUERY ||
603 !test_bit(EC_FLAGS_QUERY_PENDING, &ec->flags) ||
604 (ec->curr && ec->curr->command == ACPI_EC_COMMAND_QUERY))
Lv Zheng61197542015-09-24 14:54:54 +0800605 guarded = false;
606 spin_unlock_irqrestore(&ec->lock, flags);
607 return guarded;
Lv Zheng1d68d262015-06-11 13:21:38 +0800608}
609
Lv Zhengd8d031a2015-05-15 14:16:42 +0800610static int ec_transaction_polled(struct acpi_ec *ec)
611{
612 unsigned long flags;
613 int ret = 0;
614
615 spin_lock_irqsave(&ec->lock, flags);
616 if (ec->curr && (ec->curr->flags & ACPI_EC_COMMAND_POLL))
617 ret = 1;
618 spin_unlock_irqrestore(&ec->lock, flags);
619 return ret;
620}
621
Lv Zhengf92fca02014-06-15 08:41:35 +0800622static int ec_transaction_completed(struct acpi_ec *ec)
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400623{
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400624 unsigned long flags;
625 int ret = 0;
Lv Zheng7a73e602014-10-14 14:24:01 +0800626
Feng Tangf351d022012-10-23 01:29:27 +0200627 spin_lock_irqsave(&ec->lock, flags);
Lv Zhengc0d65342014-06-15 08:42:07 +0800628 if (ec->curr && (ec->curr->flags & ACPI_EC_COMMAND_COMPLETE))
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400629 ret = 1;
Feng Tangf351d022012-10-23 01:29:27 +0200630 spin_unlock_irqrestore(&ec->lock, flags);
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400631 return ret;
632}
Denis M. Sadykov7c6db5e2006-09-26 19:50:33 +0400633
Lv Zhengf8b8eb72015-06-11 13:21:23 +0800634static inline void ec_transaction_transition(struct acpi_ec *ec, unsigned long flag)
635{
636 ec->curr->flags |= flag;
637 if (ec->curr->command == ACPI_EC_COMMAND_QUERY) {
Lv Zheng1d68d262015-06-11 13:21:38 +0800638 if (ec_event_clearing == ACPI_EC_EVT_TIMING_STATUS &&
639 flag == ACPI_EC_COMMAND_POLL)
Lv Zhengf8b8eb72015-06-11 13:21:23 +0800640 acpi_ec_complete_query(ec);
Lv Zheng1d68d262015-06-11 13:21:38 +0800641 if (ec_event_clearing == ACPI_EC_EVT_TIMING_QUERY &&
642 flag == ACPI_EC_COMMAND_COMPLETE)
643 acpi_ec_complete_query(ec);
644 if (ec_event_clearing == ACPI_EC_EVT_TIMING_EVENT &&
645 flag == ACPI_EC_COMMAND_COMPLETE)
646 set_bit(EC_FLAGS_QUERY_GUARDING, &ec->flags);
Lv Zhengf8b8eb72015-06-11 13:21:23 +0800647 }
648}
649
Lv Zheng0c788082015-01-14 19:28:22 +0800650static void advance_transaction(struct acpi_ec *ec)
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400651{
Puneet Kumar36b15872013-11-15 11:41:29 -0800652 struct transaction *t;
Lv Zheng66b42b72014-06-15 08:41:17 +0800653 u8 status;
Lv Zhengc0d65342014-06-15 08:42:07 +0800654 bool wakeup = false;
Feng Tangb76b51b2012-10-23 01:29:38 +0200655
Lv Zheng3535a3c2015-02-27 14:48:15 +0800656 ec_dbg_stm("%s (%d)", in_interrupt() ? "IRQ" : "TASK",
657 smp_processor_id());
Lv Zhengca37bfd2015-02-05 16:27:22 +0800658 /*
659 * By always clearing STS before handling all indications, we can
660 * ensure a hardware STS 0->1 change after this clearing can always
661 * trigger a GPE interrupt.
662 */
663 acpi_ec_clear_gpe(ec);
Lv Zheng66b42b72014-06-15 08:41:17 +0800664 status = acpi_ec_read_status(ec);
Puneet Kumar36b15872013-11-15 11:41:29 -0800665 t = ec->curr;
Lv Zheng1d68d262015-06-11 13:21:38 +0800666 /*
667 * Another IRQ or a guarded polling mode advancement is detected,
668 * the next QR_EC submission is then allowed.
669 */
670 if (!t || !(t->flags & ACPI_EC_COMMAND_POLL)) {
671 if (ec_event_clearing == ACPI_EC_EVT_TIMING_EVENT &&
Lv Zheng66db3832015-06-11 13:21:51 +0800672 (!ec->nr_pending_queries ||
673 test_bit(EC_FLAGS_QUERY_GUARDING, &ec->flags))) {
Lv Zheng1d68d262015-06-11 13:21:38 +0800674 clear_bit(EC_FLAGS_QUERY_GUARDING, &ec->flags);
675 acpi_ec_complete_query(ec);
676 }
677 }
Feng Tangb76b51b2012-10-23 01:29:38 +0200678 if (!t)
Lv Zhengf92fca02014-06-15 08:41:35 +0800679 goto err;
680 if (t->flags & ACPI_EC_COMMAND_POLL) {
681 if (t->wlen > t->wi) {
682 if ((status & ACPI_EC_FLAG_IBF) == 0)
683 acpi_ec_write_data(ec, t->wdata[t->wi++]);
684 else
685 goto err;
686 } else if (t->rlen > t->ri) {
687 if ((status & ACPI_EC_FLAG_OBF) == 1) {
688 t->rdata[t->ri++] = acpi_ec_read_data(ec);
Lv Zhengc0d65342014-06-15 08:42:07 +0800689 if (t->rlen == t->ri) {
Lv Zhengf8b8eb72015-06-11 13:21:23 +0800690 ec_transaction_transition(ec, ACPI_EC_COMMAND_COMPLETE);
Lv Zheng3afcf2e2014-08-21 14:41:13 +0800691 if (t->command == ACPI_EC_COMMAND_QUERY)
Lv Zheng9d8993b2015-06-11 13:21:32 +0800692 ec_dbg_evt("Command(%s) completed by hardware",
693 acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY));
Lv Zhengc0d65342014-06-15 08:42:07 +0800694 wakeup = true;
695 }
Lv Zhengf92fca02014-06-15 08:41:35 +0800696 } else
697 goto err;
698 } else if (t->wlen == t->wi &&
Lv Zhengc0d65342014-06-15 08:42:07 +0800699 (status & ACPI_EC_FLAG_IBF) == 0) {
Lv Zhengf8b8eb72015-06-11 13:21:23 +0800700 ec_transaction_transition(ec, ACPI_EC_COMMAND_COMPLETE);
Lv Zhengc0d65342014-06-15 08:42:07 +0800701 wakeup = true;
702 }
Lv Zheng0c788082015-01-14 19:28:22 +0800703 goto out;
Lv Zhengf92fca02014-06-15 08:41:35 +0800704 } else {
Lv Zheng79149002014-10-29 11:33:49 +0800705 if (EC_FLAGS_QUERY_HANDSHAKE &&
706 !(status & ACPI_EC_FLAG_SCI) &&
Lv Zheng3afcf2e2014-08-21 14:41:13 +0800707 (t->command == ACPI_EC_COMMAND_QUERY)) {
Lv Zhengf8b8eb72015-06-11 13:21:23 +0800708 ec_transaction_transition(ec, ACPI_EC_COMMAND_POLL);
Lv Zheng3afcf2e2014-08-21 14:41:13 +0800709 t->rdata[t->ri++] = 0x00;
Lv Zhengf8b8eb72015-06-11 13:21:23 +0800710 ec_transaction_transition(ec, ACPI_EC_COMMAND_COMPLETE);
Lv Zheng9d8993b2015-06-11 13:21:32 +0800711 ec_dbg_evt("Command(%s) completed by software",
712 acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY));
Lv Zheng3afcf2e2014-08-21 14:41:13 +0800713 wakeup = true;
714 } else if ((status & ACPI_EC_FLAG_IBF) == 0) {
Lv Zhengf92fca02014-06-15 08:41:35 +0800715 acpi_ec_write_cmd(ec, t->command);
Lv Zhengf8b8eb72015-06-11 13:21:23 +0800716 ec_transaction_transition(ec, ACPI_EC_COMMAND_POLL);
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400717 } else
Alexey Starikovskiydd15f8c2008-11-08 21:42:30 +0300718 goto err;
Lv Zheng0c788082015-01-14 19:28:22 +0800719 goto out;
Lv Zhengf92fca02014-06-15 08:41:35 +0800720 }
Alexey Starikovskiydd15f8c2008-11-08 21:42:30 +0300721err:
Feng Tanga3cd8d22012-10-23 01:30:12 +0200722 /*
723 * If SCI bit is set, then don't think it's a false IRQ
724 * otherwise will take a not handled IRQ as a false one.
725 */
Lv Zhengf92fca02014-06-15 08:41:35 +0800726 if (!(status & ACPI_EC_FLAG_SCI)) {
Lv Zhenge1d4d902015-02-06 08:58:05 +0800727 if (in_interrupt() && t) {
728 if (t->irq_count < ec_storm_threshold)
729 ++t->irq_count;
730 /* Allow triggering on 0 threshold */
731 if (t->irq_count == ec_storm_threshold)
Lv Zheng56f77ee2017-08-11 14:36:28 +0800732 acpi_ec_mask_gpe(ec);
Lv Zhenge1d4d902015-02-06 08:58:05 +0800733 }
Lv Zhengf92fca02014-06-15 08:41:35 +0800734 }
Lv Zheng0c788082015-01-14 19:28:22 +0800735out:
Lv Zheng74443bb2015-01-14 19:28:47 +0800736 if (status & ACPI_EC_FLAG_SCI)
Rafael J. Wysocki37d11392015-02-11 17:35:05 +0100737 acpi_ec_submit_query(ec);
Lv Zheng0c788082015-01-14 19:28:22 +0800738 if (wakeup && in_interrupt())
739 wake_up(&ec->wait);
Lv Zhengf92fca02014-06-15 08:41:35 +0800740}
Feng Tanga3cd8d22012-10-23 01:30:12 +0200741
Lv Zhengf92fca02014-06-15 08:41:35 +0800742static void start_transaction(struct acpi_ec *ec)
743{
744 ec->curr->irq_count = ec->curr->wi = ec->curr->ri = 0;
745 ec->curr->flags = 0;
Lv Zhengd8d031a2015-05-15 14:16:42 +0800746}
747
748static int ec_guard(struct acpi_ec *ec)
749{
Lv Zhengc3a696b2017-01-20 16:42:48 +0800750 unsigned long guard = usecs_to_jiffies(ec->polling_guard);
Lv Zhengd8d031a2015-05-15 14:16:42 +0800751 unsigned long timeout = ec->timestamp + guard;
752
Lv Zheng61197542015-09-24 14:54:54 +0800753 /* Ensure guarding period before polling EC status */
Lv Zhengd8d031a2015-05-15 14:16:42 +0800754 do {
Lv Zhengc3a696b2017-01-20 16:42:48 +0800755 if (ec->busy_polling) {
Lv Zhengd8d031a2015-05-15 14:16:42 +0800756 /* Perform busy polling */
757 if (ec_transaction_completed(ec))
758 return 0;
759 udelay(jiffies_to_usecs(guard));
760 } else {
761 /*
762 * Perform wait polling
Lv Zheng61197542015-09-24 14:54:54 +0800763 * 1. Wait the transaction to be completed by the
764 * GPE handler after the transaction enters
765 * ACPI_EC_COMMAND_POLL state.
766 * 2. A special guarding logic is also required
767 * for event clearing mode "event" before the
768 * transaction enters ACPI_EC_COMMAND_POLL
769 * state.
Lv Zhengd8d031a2015-05-15 14:16:42 +0800770 */
Lv Zheng1d68d262015-06-11 13:21:38 +0800771 if (!ec_transaction_polled(ec) &&
772 !acpi_ec_guard_event(ec))
Lv Zhengd8d031a2015-05-15 14:16:42 +0800773 break;
774 if (wait_event_timeout(ec->wait,
775 ec_transaction_completed(ec),
776 guard))
777 return 0;
778 }
Lv Zhengd8d031a2015-05-15 14:16:42 +0800779 } while (time_before(jiffies, timeout));
780 return -ETIME;
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400781}
782
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400783static int ec_poll(struct acpi_ec *ec)
Alexey Starikovskiy845625c2008-03-21 17:07:03 +0300784{
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400785 unsigned long flags;
Lan Tianyu28fe5c82013-05-06 03:23:40 +0000786 int repeat = 5; /* number of command restarts */
Lv Zheng7a73e602014-10-14 14:24:01 +0800787
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400788 while (repeat--) {
789 unsigned long delay = jiffies +
Thomas Renninger7a18e962010-10-21 18:24:57 +0200790 msecs_to_jiffies(ec_delay);
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400791 do {
Lv Zhengd8d031a2015-05-15 14:16:42 +0800792 if (!ec_guard(ec))
793 return 0;
Lv Zhengf92fca02014-06-15 08:41:35 +0800794 spin_lock_irqsave(&ec->lock, flags);
Lv Zhengd8d031a2015-05-15 14:16:42 +0800795 advance_transaction(ec);
Lv Zhengf92fca02014-06-15 08:41:35 +0800796 spin_unlock_irqrestore(&ec->lock, flags);
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400797 } while (time_before(jiffies, delay));
Lan Tianyu16a26e82013-09-12 03:32:04 -0400798 pr_debug("controller reset, restart transaction\n");
Feng Tangf351d022012-10-23 01:29:27 +0200799 spin_lock_irqsave(&ec->lock, flags);
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400800 start_transaction(ec);
Feng Tangf351d022012-10-23 01:29:27 +0200801 spin_unlock_irqrestore(&ec->lock, flags);
Alexey Starikovskiyaf3fd142006-12-07 18:42:16 +0300802 }
Alexey Starikovskiyb77d81b2008-03-21 17:07:15 +0300803 return -ETIME;
Dmitry Torokhov451566f2005-03-19 01:10:05 -0500804}
805
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400806static int acpi_ec_transaction_unlocked(struct acpi_ec *ec,
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400807 struct transaction *t)
Lennart Poetteringd7a76e42006-09-05 12:12:24 -0400808{
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400809 unsigned long tmp;
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400810 int ret = 0;
Lv Zheng7a73e602014-10-14 14:24:01 +0800811
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400812 /* start transaction */
Feng Tangf351d022012-10-23 01:29:27 +0200813 spin_lock_irqsave(&ec->lock, tmp);
Lv Zheng9887d222015-02-06 08:57:59 +0800814 /* Enable GPE for command processing (IBF=0/OBF=1) */
Rafael J. Wysocki37d11392015-02-11 17:35:05 +0100815 if (!acpi_ec_submit_flushable_request(ec)) {
Lv Zhengad479e72015-02-06 08:57:52 +0800816 ret = -EINVAL;
817 goto unlock;
818 }
Lv Zheng770970f2015-02-27 14:48:24 +0800819 ec_dbg_ref(ec, "Increase command");
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400820 /* following two actions should be kept atomic */
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400821 ec->curr = t;
Lv Zheng3535a3c2015-02-27 14:48:15 +0800822 ec_dbg_req("Command(%s) started", acpi_ec_cmd_string(t->command));
Alexey Starikovskiya2f93ae2008-11-12 01:40:19 +0300823 start_transaction(ec);
Lv Zhengdf9ff912014-10-29 11:33:43 +0800824 spin_unlock_irqrestore(&ec->lock, tmp);
Lv Zhengd8d031a2015-05-15 14:16:42 +0800825
Lv Zhengdf9ff912014-10-29 11:33:43 +0800826 ret = ec_poll(ec);
Lv Zhengd8d031a2015-05-15 14:16:42 +0800827
Lv Zhengdf9ff912014-10-29 11:33:43 +0800828 spin_lock_irqsave(&ec->lock, tmp);
Lv Zhenge1d4d902015-02-06 08:58:05 +0800829 if (t->irq_count == ec_storm_threshold)
Lv Zheng56f77ee2017-08-11 14:36:28 +0800830 acpi_ec_unmask_gpe(ec);
Lv Zheng3535a3c2015-02-27 14:48:15 +0800831 ec_dbg_req("Command(%s) stopped", acpi_ec_cmd_string(t->command));
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400832 ec->curr = NULL;
Lv Zheng9887d222015-02-06 08:57:59 +0800833 /* Disable GPE for command processing (IBF=0/OBF=1) */
834 acpi_ec_complete_request(ec);
Lv Zheng770970f2015-02-27 14:48:24 +0800835 ec_dbg_ref(ec, "Decrease command");
Lv Zhengad479e72015-02-06 08:57:52 +0800836unlock:
Feng Tangf351d022012-10-23 01:29:27 +0200837 spin_unlock_irqrestore(&ec->lock, tmp);
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400838 return ret;
Lennart Poetteringd7a76e42006-09-05 12:12:24 -0400839}
840
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400841static int acpi_ec_transaction(struct acpi_ec *ec, struct transaction *t)
Luming Yu45bea152005-07-23 04:08:00 -0400842{
Lennart Poetteringd7a76e42006-09-05 12:12:24 -0400843 int status;
Len Brown50526df2005-08-11 17:32:05 -0400844 u32 glk;
Lv Zheng7a73e602014-10-14 14:24:01 +0800845
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400846 if (!ec || (!t) || (t->wlen && !t->wdata) || (t->rlen && !t->rdata))
Patrick Mocheld550d982006-06-27 00:41:40 -0400847 return -EINVAL;
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400848 if (t->rdata)
849 memset(t->rdata, 0, t->rlen);
Lv Zhengd8d031a2015-05-15 14:16:42 +0800850
Feng Tangf351d022012-10-23 01:29:27 +0200851 mutex_lock(&ec->mutex);
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400852 if (ec->global_lock) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
Alexey Starikovskiyc24e9122007-02-15 23:16:18 +0300854 if (ACPI_FAILURE(status)) {
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400855 status = -ENODEV;
856 goto unlock;
Alexey Starikovskiyc24e9122007-02-15 23:16:18 +0300857 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 }
Alexey Starikovskiya62e8f12009-12-24 11:34:16 +0300859
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400860 status = acpi_ec_transaction_unlocked(ec, t);
Alexey Starikovskiya62e8f12009-12-24 11:34:16 +0300861
Denis M. Sadykov703959d2006-09-26 19:50:33 +0400862 if (ec->global_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 acpi_release_global_lock(glk);
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400864unlock:
Feng Tangf351d022012-10-23 01:29:27 +0200865 mutex_unlock(&ec->mutex);
Patrick Mocheld550d982006-06-27 00:41:40 -0400866 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867}
868
Roel Kluin8a383ef2008-12-09 20:45:30 +0100869static int acpi_ec_burst_enable(struct acpi_ec *ec)
Alexey Starikovskiyc45aac42007-03-07 22:28:00 +0300870{
871 u8 d;
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400872 struct transaction t = {.command = ACPI_EC_BURST_ENABLE,
873 .wdata = NULL, .rdata = &d,
874 .wlen = 0, .rlen = 1};
875
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400876 return acpi_ec_transaction(ec, &t);
Alexey Starikovskiyc45aac42007-03-07 22:28:00 +0300877}
878
Roel Kluin8a383ef2008-12-09 20:45:30 +0100879static int acpi_ec_burst_disable(struct acpi_ec *ec)
Alexey Starikovskiyc45aac42007-03-07 22:28:00 +0300880{
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400881 struct transaction t = {.command = ACPI_EC_BURST_DISABLE,
882 .wdata = NULL, .rdata = NULL,
883 .wlen = 0, .rlen = 0};
884
Alexey Starikovskiy7c6db4e2008-09-25 21:00:31 +0400885 return (acpi_ec_read_status(ec) & ACPI_EC_FLAG_BURST) ?
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400886 acpi_ec_transaction(ec, &t) : 0;
Alexey Starikovskiyc45aac42007-03-07 22:28:00 +0300887}
888
Lv Zheng7a73e602014-10-14 14:24:01 +0800889static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 *data)
Denis M. Sadykov3576cf62006-09-26 19:50:33 +0400890{
891 int result;
892 u8 d;
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400893 struct transaction t = {.command = ACPI_EC_COMMAND_READ,
894 .wdata = &address, .rdata = &d,
895 .wlen = 1, .rlen = 1};
Denis M. Sadykov3576cf62006-09-26 19:50:33 +0400896
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400897 result = acpi_ec_transaction(ec, &t);
Denis M. Sadykov3576cf62006-09-26 19:50:33 +0400898 *data = d;
899 return result;
900}
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400901
Denis M. Sadykov3576cf62006-09-26 19:50:33 +0400902static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data)
903{
Alexey Starikovskiy6ccedb12006-12-07 18:42:17 +0300904 u8 wdata[2] = { address, data };
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400905 struct transaction t = {.command = ACPI_EC_COMMAND_WRITE,
906 .wdata = wdata, .rdata = NULL,
907 .wlen = 2, .rlen = 0};
908
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400909 return acpi_ec_transaction(ec, &t);
Denis M. Sadykov3576cf62006-09-26 19:50:33 +0400910}
911
Feng Tangb76b51b2012-10-23 01:29:38 +0200912int ec_read(u8 addr, u8 *val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 int err;
Denis M. Sadykov6ffb2212006-09-26 19:50:33 +0400915 u8 temp_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916
917 if (!first_ec)
918 return -ENODEV;
919
Alexey Starikovskiyd0338792007-03-07 22:28:00 +0300920 err = acpi_ec_read(first_ec, addr, &temp_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
922 if (!err) {
923 *val = temp_data;
924 return 0;
Lv Zheng7a73e602014-10-14 14:24:01 +0800925 }
926 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927}
928EXPORT_SYMBOL(ec_read);
929
Len Brown50526df2005-08-11 17:32:05 -0400930int ec_write(u8 addr, u8 val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 int err;
933
934 if (!first_ec)
935 return -ENODEV;
936
Alexey Starikovskiyd0338792007-03-07 22:28:00 +0300937 err = acpi_ec_write(first_ec, addr, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
939 return err;
940}
941EXPORT_SYMBOL(ec_write);
942
Randy Dunlap616362d2006-10-27 01:47:34 -0400943int ec_transaction(u8 command,
Lv Zheng7a73e602014-10-14 14:24:01 +0800944 const u8 *wdata, unsigned wdata_len,
945 u8 *rdata, unsigned rdata_len)
Luming Yu45bea152005-07-23 04:08:00 -0400946{
Alexey Starikovskiy84632002008-09-26 00:54:28 +0400947 struct transaction t = {.command = command,
948 .wdata = wdata, .rdata = rdata,
949 .wlen = wdata_len, .rlen = rdata_len};
Lv Zheng7a73e602014-10-14 14:24:01 +0800950
Lennart Poetteringd7a76e42006-09-05 12:12:24 -0400951 if (!first_ec)
952 return -ENODEV;
953
Alexey Starikovskiy2a84cb92009-08-30 03:06:14 +0400954 return acpi_ec_transaction(first_ec, &t);
Luming Yu45bea152005-07-23 04:08:00 -0400955}
Lennart Poetteringab9e43c2006-10-03 22:49:00 -0400956EXPORT_SYMBOL(ec_transaction);
957
Seth Forshee3e2abc52012-01-18 13:44:08 -0600958/* Get the handle to the EC device */
959acpi_handle ec_get_handle(void)
960{
961 if (!first_ec)
962 return NULL;
963 return first_ec->handle;
964}
Seth Forshee3e2abc52012-01-18 13:44:08 -0600965EXPORT_SYMBOL(ec_get_handle);
966
Lv Zhengad479e72015-02-06 08:57:52 +0800967static void acpi_ec_start(struct acpi_ec *ec, bool resuming)
968{
969 unsigned long flags;
970
971 spin_lock_irqsave(&ec->lock, flags);
972 if (!test_and_set_bit(EC_FLAGS_STARTED, &ec->flags)) {
Lv Zheng3535a3c2015-02-27 14:48:15 +0800973 ec_dbg_drv("Starting EC");
Lv Zheng9887d222015-02-06 08:57:59 +0800974 /* Enable GPE for event processing (SCI_EVT=1) */
Lv Zheng770970f2015-02-27 14:48:24 +0800975 if (!resuming) {
Lv Zheng9887d222015-02-06 08:57:59 +0800976 acpi_ec_submit_request(ec);
Lv Zheng770970f2015-02-27 14:48:24 +0800977 ec_dbg_ref(ec, "Increase driver");
Lv Zhengc2b46d62016-08-03 16:01:36 +0800978 }
Lv Zheng3535a3c2015-02-27 14:48:15 +0800979 ec_log_drv("EC started");
Lv Zhengad479e72015-02-06 08:57:52 +0800980 }
981 spin_unlock_irqrestore(&ec->lock, flags);
982}
983
Lv Zheng9887d222015-02-06 08:57:59 +0800984static bool acpi_ec_stopped(struct acpi_ec *ec)
985{
986 unsigned long flags;
987 bool flushed;
988
989 spin_lock_irqsave(&ec->lock, flags);
990 flushed = acpi_ec_flushed(ec);
991 spin_unlock_irqrestore(&ec->lock, flags);
992 return flushed;
993}
994
Lv Zhengad479e72015-02-06 08:57:52 +0800995static void acpi_ec_stop(struct acpi_ec *ec, bool suspending)
996{
997 unsigned long flags;
998
999 spin_lock_irqsave(&ec->lock, flags);
1000 if (acpi_ec_started(ec)) {
Lv Zheng3535a3c2015-02-27 14:48:15 +08001001 ec_dbg_drv("Stopping EC");
Lv Zhengad479e72015-02-06 08:57:52 +08001002 set_bit(EC_FLAGS_STOPPED, &ec->flags);
Lv Zheng9887d222015-02-06 08:57:59 +08001003 spin_unlock_irqrestore(&ec->lock, flags);
1004 wait_event(ec->wait, acpi_ec_stopped(ec));
1005 spin_lock_irqsave(&ec->lock, flags);
1006 /* Disable GPE for event processing (SCI_EVT=1) */
Lv Zheng770970f2015-02-27 14:48:24 +08001007 if (!suspending) {
Lv Zheng9887d222015-02-06 08:57:59 +08001008 acpi_ec_complete_request(ec);
Lv Zheng770970f2015-02-27 14:48:24 +08001009 ec_dbg_ref(ec, "Decrease driver");
Lv Zheng39a2a2a2016-08-03 16:01:43 +08001010 } else if (!ec_freeze_events)
Lv Zheng750f628b2016-08-03 16:01:24 +08001011 __acpi_ec_disable_event(ec);
Lv Zhengad479e72015-02-06 08:57:52 +08001012 clear_bit(EC_FLAGS_STARTED, &ec->flags);
1013 clear_bit(EC_FLAGS_STOPPED, &ec->flags);
Lv Zheng3535a3c2015-02-27 14:48:15 +08001014 ec_log_drv("EC stopped");
Lv Zhengad479e72015-02-06 08:57:52 +08001015 }
1016 spin_unlock_irqrestore(&ec->lock, flags);
1017}
1018
Lv Zhengc3a696b2017-01-20 16:42:48 +08001019static void acpi_ec_enter_noirq(struct acpi_ec *ec)
1020{
1021 unsigned long flags;
1022
1023 spin_lock_irqsave(&ec->lock, flags);
1024 ec->busy_polling = true;
1025 ec->polling_guard = 0;
1026 ec_log_drv("interrupt blocked");
1027 spin_unlock_irqrestore(&ec->lock, flags);
1028}
1029
1030static void acpi_ec_leave_noirq(struct acpi_ec *ec)
1031{
1032 unsigned long flags;
1033
1034 spin_lock_irqsave(&ec->lock, flags);
1035 ec->busy_polling = ec_busy_polling;
1036 ec->polling_guard = ec_polling_guard;
1037 ec_log_drv("interrupt unblocked");
1038 spin_unlock_irqrestore(&ec->lock, flags);
1039}
1040
Rafael J. Wysockife955682010-04-09 01:40:38 +02001041void acpi_ec_block_transactions(void)
Rafael J. Wysockif6bb13a2010-03-04 01:52:58 +01001042{
1043 struct acpi_ec *ec = first_ec;
1044
1045 if (!ec)
1046 return;
1047
Feng Tangf351d022012-10-23 01:29:27 +02001048 mutex_lock(&ec->mutex);
Rafael J. Wysockif6bb13a2010-03-04 01:52:58 +01001049 /* Prevent transactions from being carried out */
Lv Zhengad479e72015-02-06 08:57:52 +08001050 acpi_ec_stop(ec, true);
Feng Tangf351d022012-10-23 01:29:27 +02001051 mutex_unlock(&ec->mutex);
Rafael J. Wysockif6bb13a2010-03-04 01:52:58 +01001052}
1053
Rafael J. Wysockife955682010-04-09 01:40:38 +02001054void acpi_ec_unblock_transactions(void)
Rafael J. Wysockif6bb13a2010-03-04 01:52:58 +01001055{
Rafael J. Wysockid5a64512010-04-09 01:39:40 +02001056 /*
1057 * Allow transactions to happen again (this function is called from
1058 * atomic context during wakeup, so we don't need to acquire the mutex).
1059 */
1060 if (first_ec)
Lv Zhengad479e72015-02-06 08:57:52 +08001061 acpi_ec_start(first_ec, true);
Rafael J. Wysockid5a64512010-04-09 01:39:40 +02001062}
1063
Rafael J. Wysockif941d3e2018-12-17 12:21:55 +01001064void acpi_ec_mark_gpe_for_wake(void)
1065{
1066 if (first_ec && !ec_no_wakeup)
1067 acpi_mark_gpe_for_wake(NULL, first_ec->gpe);
1068}
1069
1070void acpi_ec_set_gpe_wake_mask(u8 action)
1071{
1072 if (first_ec && !ec_no_wakeup)
1073 acpi_set_gpe_wake_mask(NULL, first_ec->gpe, action);
1074}
1075
Rafael J. Wysocki68e22012018-05-16 14:13:21 +02001076void acpi_ec_dispatch_gpe(void)
1077{
1078 if (first_ec)
1079 acpi_dispatch_gpe(NULL, first_ec->gpe);
1080}
1081
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082/* --------------------------------------------------------------------------
1083 Event Management
1084 -------------------------------------------------------------------------- */
Lv Zheng01305d42015-01-14 19:28:28 +08001085static struct acpi_ec_query_handler *
1086acpi_ec_get_query_handler(struct acpi_ec_query_handler *handler)
1087{
1088 if (handler)
1089 kref_get(&handler->kref);
1090 return handler;
1091}
1092
Lv Zheng0700c042015-09-24 14:54:48 +08001093static struct acpi_ec_query_handler *
1094acpi_ec_get_query_handler_by_value(struct acpi_ec *ec, u8 value)
1095{
1096 struct acpi_ec_query_handler *handler;
1097 bool found = false;
1098
1099 mutex_lock(&ec->mutex);
1100 list_for_each_entry(handler, &ec->list, node) {
1101 if (value == handler->query_bit) {
1102 found = true;
1103 break;
1104 }
1105 }
1106 mutex_unlock(&ec->mutex);
1107 return found ? acpi_ec_get_query_handler(handler) : NULL;
1108}
1109
Lv Zheng01305d42015-01-14 19:28:28 +08001110static void acpi_ec_query_handler_release(struct kref *kref)
1111{
1112 struct acpi_ec_query_handler *handler =
1113 container_of(kref, struct acpi_ec_query_handler, kref);
1114
1115 kfree(handler);
1116}
1117
1118static void acpi_ec_put_query_handler(struct acpi_ec_query_handler *handler)
1119{
1120 kref_put(&handler->kref, acpi_ec_query_handler_release);
1121}
1122
Alexey Starikovskiy837012e2007-05-29 16:43:02 +04001123int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit,
1124 acpi_handle handle, acpi_ec_query_func func,
1125 void *data)
1126{
1127 struct acpi_ec_query_handler *handler =
1128 kzalloc(sizeof(struct acpi_ec_query_handler), GFP_KERNEL);
Lv Zheng7a73e602014-10-14 14:24:01 +08001129
Alexey Starikovskiy837012e2007-05-29 16:43:02 +04001130 if (!handler)
1131 return -ENOMEM;
1132
1133 handler->query_bit = query_bit;
1134 handler->handle = handle;
1135 handler->func = func;
1136 handler->data = data;
Feng Tangf351d022012-10-23 01:29:27 +02001137 mutex_lock(&ec->mutex);
Lv Zheng01305d42015-01-14 19:28:28 +08001138 kref_init(&handler->kref);
Alexey Starikovskiy30c08572007-09-26 19:43:22 +04001139 list_add(&handler->node, &ec->list);
Feng Tangf351d022012-10-23 01:29:27 +02001140 mutex_unlock(&ec->mutex);
Alexey Starikovskiy837012e2007-05-29 16:43:02 +04001141 return 0;
1142}
Alexey Starikovskiy837012e2007-05-29 16:43:02 +04001143EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler);
1144
Lv Zheng0700c042015-09-24 14:54:48 +08001145static void acpi_ec_remove_query_handlers(struct acpi_ec *ec,
1146 bool remove_all, u8 query_bit)
Alexey Starikovskiy837012e2007-05-29 16:43:02 +04001147{
Adrian Bunk1544fdb2007-10-24 18:26:00 +02001148 struct acpi_ec_query_handler *handler, *tmp;
Lv Zheng01305d42015-01-14 19:28:28 +08001149 LIST_HEAD(free_list);
Lv Zheng7a73e602014-10-14 14:24:01 +08001150
Feng Tangf351d022012-10-23 01:29:27 +02001151 mutex_lock(&ec->mutex);
Adrian Bunk1544fdb2007-10-24 18:26:00 +02001152 list_for_each_entry_safe(handler, tmp, &ec->list, node) {
Lv Zheng0700c042015-09-24 14:54:48 +08001153 if (remove_all || query_bit == handler->query_bit) {
Lv Zheng01305d42015-01-14 19:28:28 +08001154 list_del_init(&handler->node);
1155 list_add(&handler->node, &free_list);
Alexey Starikovskiy837012e2007-05-29 16:43:02 +04001156 }
1157 }
Feng Tangf351d022012-10-23 01:29:27 +02001158 mutex_unlock(&ec->mutex);
Chris Bainbridge6b5eab52015-04-22 00:25:36 +01001159 list_for_each_entry_safe(handler, tmp, &free_list, node)
Lv Zheng01305d42015-01-14 19:28:28 +08001160 acpi_ec_put_query_handler(handler);
Alexey Starikovskiy837012e2007-05-29 16:43:02 +04001161}
Lv Zheng0700c042015-09-24 14:54:48 +08001162
1163void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit)
1164{
1165 acpi_ec_remove_query_handlers(ec, false, query_bit);
1166}
Alexey Starikovskiy837012e2007-05-29 16:43:02 +04001167EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168
Lv Zheng02b771b2015-08-12 11:12:02 +08001169static struct acpi_ec_query *acpi_ec_create_query(u8 *pval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170{
Lv Zheng02b771b2015-08-12 11:12:02 +08001171 struct acpi_ec_query *q;
1172 struct transaction *t;
Lv Zheng7a73e602014-10-14 14:24:01 +08001173
Lv Zheng02b771b2015-08-12 11:12:02 +08001174 q = kzalloc(sizeof (struct acpi_ec_query), GFP_KERNEL);
1175 if (!q)
1176 return NULL;
1177 INIT_WORK(&q->work, acpi_ec_event_processor);
1178 t = &q->transaction;
1179 t->command = ACPI_EC_COMMAND_QUERY;
1180 t->rdata = pval;
1181 t->rlen = 1;
1182 return q;
1183}
1184
1185static void acpi_ec_delete_query(struct acpi_ec_query *q)
1186{
1187 if (q) {
1188 if (q->handler)
1189 acpi_ec_put_query_handler(q->handler);
1190 kfree(q);
1191 }
1192}
1193
1194static void acpi_ec_event_processor(struct work_struct *work)
1195{
1196 struct acpi_ec_query *q = container_of(work, struct acpi_ec_query, work);
1197 struct acpi_ec_query_handler *handler = q->handler;
1198
Lv Zheng3535a3c2015-02-27 14:48:15 +08001199 ec_dbg_evt("Query(0x%02x) started", handler->query_bit);
Alexey Starikovskiya62e8f12009-12-24 11:34:16 +03001200 if (handler->func)
1201 handler->func(handler->data);
1202 else if (handler->handle)
1203 acpi_evaluate_object(handler->handle, NULL, NULL, NULL);
Lv Zheng3535a3c2015-02-27 14:48:15 +08001204 ec_dbg_evt("Query(0x%02x) stopped", handler->query_bit);
Lv Zheng02b771b2015-08-12 11:12:02 +08001205 acpi_ec_delete_query(q);
Alexey Starikovskiya62e8f12009-12-24 11:34:16 +03001206}
1207
Lv Zheng550b3aac2015-01-14 19:28:53 +08001208static int acpi_ec_query(struct acpi_ec *ec, u8 *data)
Alexey Starikovskiya62e8f12009-12-24 11:34:16 +03001209{
1210 u8 value = 0;
Lv Zhengc2cf5762015-01-14 19:28:33 +08001211 int result;
Lv Zheng02b771b2015-08-12 11:12:02 +08001212 struct acpi_ec_query *q;
1213
1214 q = acpi_ec_create_query(&value);
1215 if (!q)
1216 return -ENOMEM;
Kieran Clancy3eba5632014-04-30 00:21:20 +09301217
Lv Zheng550b3aac2015-01-14 19:28:53 +08001218 /*
1219 * Query the EC to find out which _Qxx method we need to evaluate.
1220 * Note that successful completion of the query causes the ACPI_EC_SCI
1221 * bit to be cleared (and thus clearing the interrupt source).
1222 */
Lv Zheng02b771b2015-08-12 11:12:02 +08001223 result = acpi_ec_transaction(ec, &q->transaction);
Lv Zheng550b3aac2015-01-14 19:28:53 +08001224 if (!value)
Lv Zheng02b771b2015-08-12 11:12:02 +08001225 result = -ENODATA;
1226 if (result)
1227 goto err_exit;
Kieran Clancy3eba5632014-04-30 00:21:20 +09301228
Lv Zheng0700c042015-09-24 14:54:48 +08001229 q->handler = acpi_ec_get_query_handler_by_value(ec, value);
1230 if (!q->handler) {
1231 result = -ENODATA;
1232 goto err_exit;
Alexey Starikovskiy837012e2007-05-29 16:43:02 +04001233 }
Lv Zheng0700c042015-09-24 14:54:48 +08001234
1235 /*
1236 * It is reported that _Qxx are evaluated in a parallel way on
1237 * Windows:
1238 * https://bugzilla.kernel.org/show_bug.cgi?id=94411
1239 *
1240 * Put this log entry before schedule_work() in order to make
1241 * it appearing before any other log entries occurred during the
1242 * work queue execution.
1243 */
1244 ec_dbg_evt("Query(0x%02x) scheduled", value);
Lv Zhenge1191bd2016-08-03 09:00:14 +08001245 if (!queue_work(ec_query_wq, &q->work)) {
Lv Zheng0700c042015-09-24 14:54:48 +08001246 ec_dbg_evt("Query(0x%02x) overlapped", value);
1247 result = -EBUSY;
1248 }
Lv Zheng02b771b2015-08-12 11:12:02 +08001249
1250err_exit:
Markus Elfring4981c2b2015-11-15 22:42:27 +01001251 if (result)
Lv Zheng02b771b2015-08-12 11:12:02 +08001252 acpi_ec_delete_query(q);
1253 if (data)
1254 *data = value;
Lv Zhengc2cf5762015-01-14 19:28:33 +08001255 return result;
Alexey Starikovskiya62e8f12009-12-24 11:34:16 +03001256}
1257
Lv Zheng1d68d262015-06-11 13:21:38 +08001258static void acpi_ec_check_event(struct acpi_ec *ec)
1259{
1260 unsigned long flags;
1261
1262 if (ec_event_clearing == ACPI_EC_EVT_TIMING_EVENT) {
1263 if (ec_guard(ec)) {
1264 spin_lock_irqsave(&ec->lock, flags);
1265 /*
1266 * Take care of the SCI_EVT unless no one else is
1267 * taking care of it.
1268 */
1269 if (!ec->curr)
1270 advance_transaction(ec);
1271 spin_unlock_irqrestore(&ec->lock, flags);
1272 }
1273 }
1274}
1275
Lv Zheng9d8993b2015-06-11 13:21:32 +08001276static void acpi_ec_event_handler(struct work_struct *work)
Alexey Starikovskiya62e8f12009-12-24 11:34:16 +03001277{
Lv Zheng9d8993b2015-06-11 13:21:32 +08001278 unsigned long flags;
Lv Zheng74443bb2015-01-14 19:28:47 +08001279 struct acpi_ec *ec = container_of(work, struct acpi_ec, work);
Lv Zheng7a73e602014-10-14 14:24:01 +08001280
Lv Zheng9d8993b2015-06-11 13:21:32 +08001281 ec_dbg_evt("Event started");
1282
1283 spin_lock_irqsave(&ec->lock, flags);
1284 while (ec->nr_pending_queries) {
1285 spin_unlock_irqrestore(&ec->lock, flags);
1286 (void)acpi_ec_query(ec, NULL);
1287 spin_lock_irqsave(&ec->lock, flags);
1288 ec->nr_pending_queries--;
Lv Zheng66db3832015-06-11 13:21:51 +08001289 /*
1290 * Before exit, make sure that this work item can be
1291 * scheduled again. There might be QR_EC failures, leaving
1292 * EC_FLAGS_QUERY_PENDING uncleared and preventing this work
1293 * item from being scheduled again.
1294 */
1295 if (!ec->nr_pending_queries) {
1296 if (ec_event_clearing == ACPI_EC_EVT_TIMING_STATUS ||
1297 ec_event_clearing == ACPI_EC_EVT_TIMING_QUERY)
1298 acpi_ec_complete_query(ec);
1299 }
Lv Zheng9d8993b2015-06-11 13:21:32 +08001300 }
1301 spin_unlock_irqrestore(&ec->lock, flags);
1302
1303 ec_dbg_evt("Event stopped");
Lv Zheng1d68d262015-06-11 13:21:38 +08001304
1305 acpi_ec_check_event(ec);
Luming Yu45bea152005-07-23 04:08:00 -04001306}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307
Lin Ming8b6cd8a2010-12-13 13:38:46 +08001308static u32 acpi_ec_gpe_handler(acpi_handle gpe_device,
1309 u32 gpe_number, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310{
Lv Zhengf92fca02014-06-15 08:41:35 +08001311 unsigned long flags;
Alexey Starikovskiy3d02b902007-03-07 22:28:00 +03001312 struct acpi_ec *ec = data;
Lennart Poettering00eb43a2007-05-04 14:16:19 +02001313
Lv Zhengf92fca02014-06-15 08:41:35 +08001314 spin_lock_irqsave(&ec->lock, flags);
Lv Zheng0c788082015-01-14 19:28:22 +08001315 advance_transaction(ec);
Lv Zhengc0d65342014-06-15 08:42:07 +08001316 spin_unlock_irqrestore(&ec->lock, flags);
Lv Zhengca37bfd2015-02-05 16:27:22 +08001317 return ACPI_INTERRUPT_HANDLED;
Alexey Starikovskiy845625c2008-03-21 17:07:03 +03001318}
1319
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320/* --------------------------------------------------------------------------
Lv Zheng7a73e602014-10-14 14:24:01 +08001321 * Address Space Management
1322 * -------------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323
1324static acpi_status
Alexey Starikovskiy5b7734b2007-05-29 16:42:52 +04001325acpi_ec_space_handler(u32 function, acpi_physical_address address,
Alexey Starikovskiydadf28a2010-03-17 13:14:13 -04001326 u32 bits, u64 *value64,
Len Brown50526df2005-08-11 17:32:05 -04001327 void *handler_context, void *region_context)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328{
Alexey Starikovskiy3d02b902007-03-07 22:28:00 +03001329 struct acpi_ec *ec = handler_context;
Alexey Starikovskiydadf28a2010-03-17 13:14:13 -04001330 int result = 0, i, bytes = bits / 8;
1331 u8 *value = (u8 *)value64;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 if ((address > 0xFF) || !value || !handler_context)
Patrick Mocheld550d982006-06-27 00:41:40 -04001334 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335
Alexey Starikovskiy5b7734b2007-05-29 16:42:52 +04001336 if (function != ACPI_READ && function != ACPI_WRITE)
Patrick Mocheld550d982006-06-27 00:41:40 -04001337 return AE_BAD_PARAMETER;
Alexey Starikovskiy5b7734b2007-05-29 16:42:52 +04001338
Lv Zhengc3a696b2017-01-20 16:42:48 +08001339 if (ec->busy_polling || bits > 8)
Alexey Starikovskiy6a63b06f2009-08-28 23:29:44 +04001340 acpi_ec_burst_enable(ec);
Alexey Starikovskiyb3b233c2008-01-11 02:42:57 +03001341
Alexey Starikovskiydadf28a2010-03-17 13:14:13 -04001342 for (i = 0; i < bytes; ++i, ++address, ++value)
1343 result = (function == ACPI_READ) ?
1344 acpi_ec_read(ec, address, value) :
1345 acpi_ec_write(ec, address, *value);
Alexey Starikovskiy3e71a872008-01-11 02:42:51 +03001346
Lv Zhengc3a696b2017-01-20 16:42:48 +08001347 if (ec->busy_polling || bits > 8)
Alexey Starikovskiy6a63b06f2009-08-28 23:29:44 +04001348 acpi_ec_burst_disable(ec);
Alexey Starikovskiyb3b233c2008-01-11 02:42:57 +03001349
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350 switch (result) {
1351 case -EINVAL:
Patrick Mocheld550d982006-06-27 00:41:40 -04001352 return AE_BAD_PARAMETER;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 case -ENODEV:
Patrick Mocheld550d982006-06-27 00:41:40 -04001354 return AE_NOT_FOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 case -ETIME:
Patrick Mocheld550d982006-06-27 00:41:40 -04001356 return AE_TIME;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 default:
Patrick Mocheld550d982006-06-27 00:41:40 -04001358 return AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360}
1361
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362/* --------------------------------------------------------------------------
Lv Zheng7a73e602014-10-14 14:24:01 +08001363 * Driver Interface
1364 * -------------------------------------------------------------------------- */
1365
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +03001366static acpi_status
1367ec_parse_io_ports(struct acpi_resource *resource, void *context);
1368
Lv Zheng72c77b72016-09-07 16:50:08 +08001369static void acpi_ec_free(struct acpi_ec *ec)
1370{
1371 if (first_ec == ec)
1372 first_ec = NULL;
1373 if (boot_ec == ec)
1374 boot_ec = NULL;
1375 kfree(ec);
1376}
1377
1378static struct acpi_ec *acpi_ec_alloc(void)
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +03001379{
1380 struct acpi_ec *ec = kzalloc(sizeof(struct acpi_ec), GFP_KERNEL);
Lv Zheng7a73e602014-10-14 14:24:01 +08001381
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +03001382 if (!ec)
1383 return NULL;
Feng Tangf351d022012-10-23 01:29:27 +02001384 mutex_init(&ec->mutex);
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +03001385 init_waitqueue_head(&ec->wait);
Alexey Starikovskiy837012e2007-05-29 16:43:02 +04001386 INIT_LIST_HEAD(&ec->list);
Feng Tangf351d022012-10-23 01:29:27 +02001387 spin_lock_init(&ec->lock);
Lv Zheng9d8993b2015-06-11 13:21:32 +08001388 INIT_WORK(&ec->work, acpi_ec_event_handler);
Lv Zhengd8d031a2015-05-15 14:16:42 +08001389 ec->timestamp = jiffies;
Lv Zhengc3a696b2017-01-20 16:42:48 +08001390 ec->busy_polling = true;
1391 ec->polling_guard = 0;
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +03001392 return ec;
1393}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394
Alexey Starikovskiy837012e2007-05-29 16:43:02 +04001395static acpi_status
Alexey Starikovskiyc019b192007-08-14 01:03:42 -04001396acpi_ec_register_query_methods(acpi_handle handle, u32 level,
1397 void *context, void **return_value)
1398{
Lin Ming0175d562008-12-16 16:46:12 +08001399 char node_name[5];
1400 struct acpi_buffer buffer = { sizeof(node_name), node_name };
Alexey Starikovskiyc019b192007-08-14 01:03:42 -04001401 struct acpi_ec *ec = context;
1402 int value = 0;
Lin Ming0175d562008-12-16 16:46:12 +08001403 acpi_status status;
1404
1405 status = acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer);
1406
Lv Zheng7a73e602014-10-14 14:24:01 +08001407 if (ACPI_SUCCESS(status) && sscanf(node_name, "_Q%x", &value) == 1)
Alexey Starikovskiyc019b192007-08-14 01:03:42 -04001408 acpi_ec_add_query_handler(ec, value, handle, NULL, NULL);
Alexey Starikovskiyc019b192007-08-14 01:03:42 -04001409 return AE_OK;
1410}
1411
1412static acpi_status
Alexey Starikovskiycd8c93a2007-08-03 17:52:48 -04001413ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval)
Alexey Starikovskiy837012e2007-05-29 16:43:02 +04001414{
Alexey Starikovskiycd8c93a2007-08-03 17:52:48 -04001415 acpi_status status;
Alexey Starikovskiyd21cf3c2008-11-03 14:26:40 -05001416 unsigned long long tmp = 0;
Alexey Starikovskiycd8c93a2007-08-03 17:52:48 -04001417 struct acpi_ec *ec = context;
Alexey Starikovskiya5032bf2009-04-01 01:33:15 -04001418
1419 /* clear addr values, ec_parse_io_ports depend on it */
1420 ec->command_addr = ec->data_addr = 0;
1421
Alexey Starikovskiycd8c93a2007-08-03 17:52:48 -04001422 status = acpi_walk_resources(handle, METHOD_NAME__CRS,
1423 ec_parse_io_ports, ec);
1424 if (ACPI_FAILURE(status))
1425 return status;
Lv Zhengae56c9f2017-06-15 09:41:35 +08001426 if (ec->data_addr == 0 || ec->command_addr == 0)
1427 return AE_OK;
Alexey Starikovskiy837012e2007-05-29 16:43:02 +04001428
Chris Chiu440f53d2017-06-15 09:41:47 +08001429 if (boot_ec && boot_ec_is_ecdt && EC_FLAGS_IGNORE_DSDT_GPE) {
1430 /*
1431 * Always inherit the GPE number setting from the ECDT
1432 * EC.
1433 */
1434 ec->gpe = boot_ec->gpe;
1435 } else {
1436 /* Get GPE bit assignment (EC events). */
1437 /* TODO: Add support for _GPE returning a package */
1438 status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp);
1439 if (ACPI_FAILURE(status))
1440 return status;
1441 ec->gpe = tmp;
1442 }
Alexey Starikovskiy837012e2007-05-29 16:43:02 +04001443 /* Use the global lock for all EC transactions? */
Alexey Starikovskiyd21cf3c2008-11-03 14:26:40 -05001444 tmp = 0;
Matthew Wilcox27663c52008-10-10 02:22:59 -04001445 acpi_evaluate_integer(handle, "_GLK", NULL, &tmp);
1446 ec->global_lock = tmp;
Alexey Starikovskiy837012e2007-05-29 16:43:02 +04001447 ec->handle = handle;
Alexey Starikovskiycd8c93a2007-08-03 17:52:48 -04001448 return AE_CTRL_TERMINATE;
Alexey Starikovskiy837012e2007-05-29 16:43:02 +04001449}
1450
Lv Zheng72c77b72016-09-07 16:50:08 +08001451/*
1452 * Note: This function returns an error code only when the address space
1453 * handler is not installed, which means "not able to handle
1454 * transactions".
1455 */
Lv Zheng2a570842016-09-07 16:50:21 +08001456static int ec_install_handlers(struct acpi_ec *ec, bool handle_events)
Alexey Starikovskiye8284322007-03-07 22:28:00 +03001457{
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +03001458 acpi_status status;
Lv Zheng7a73e602014-10-14 14:24:01 +08001459
Lv Zhengad479e72015-02-06 08:57:52 +08001460 acpi_ec_start(ec, false);
Lv Zheng0e1affe2016-03-24 10:42:47 +08001461
1462 if (!test_bit(EC_FLAGS_EC_HANDLER_INSTALLED, &ec->flags)) {
Lv Zhengc3a696b2017-01-20 16:42:48 +08001463 acpi_ec_enter_noirq(ec);
Lv Zheng0e1affe2016-03-24 10:42:47 +08001464 status = acpi_install_address_space_handler(ec->handle,
1465 ACPI_ADR_SPACE_EC,
1466 &acpi_ec_space_handler,
1467 NULL, ec);
1468 if (ACPI_FAILURE(status)) {
1469 if (status == AE_NOT_FOUND) {
1470 /*
1471 * Maybe OS fails in evaluating the _REG
1472 * object. The AE_NOT_FOUND error will be
1473 * ignored and OS * continue to initialize
1474 * EC.
1475 */
1476 pr_err("Fail in evaluating the _REG object"
1477 " of EC device. Broken bios is suspected.\n");
1478 } else {
1479 acpi_ec_stop(ec, false);
1480 return -ENODEV;
1481 }
1482 }
1483 set_bit(EC_FLAGS_EC_HANDLER_INSTALLED, &ec->flags);
1484 }
1485
Lv Zheng2a570842016-09-07 16:50:21 +08001486 if (!handle_events)
1487 return 0;
1488
1489 if (!test_bit(EC_FLAGS_EVT_HANDLER_INSTALLED, &ec->flags)) {
1490 /* Find and register all query methods */
1491 acpi_walk_namespace(ACPI_TYPE_METHOD, ec->handle, 1,
1492 acpi_ec_register_query_methods,
1493 NULL, ec, NULL);
1494 set_bit(EC_FLAGS_EVT_HANDLER_INSTALLED, &ec->flags);
1495 }
Lv Zheng0e1affe2016-03-24 10:42:47 +08001496 if (!test_bit(EC_FLAGS_GPE_HANDLER_INSTALLED, &ec->flags)) {
1497 status = acpi_install_gpe_raw_handler(NULL, ec->gpe,
1498 ACPI_GPE_EDGE_TRIGGERED,
1499 &acpi_ec_gpe_handler, ec);
1500 /* This is not fatal as we can poll EC events */
1501 if (ACPI_SUCCESS(status)) {
1502 set_bit(EC_FLAGS_GPE_HANDLER_INSTALLED, &ec->flags);
Lv Zhengc3a696b2017-01-20 16:42:48 +08001503 acpi_ec_leave_noirq(ec);
Lv Zheng0e1affe2016-03-24 10:42:47 +08001504 if (test_bit(EC_FLAGS_STARTED, &ec->flags) &&
1505 ec->reference_count >= 1)
1506 acpi_ec_enable_gpe(ec, true);
Zhao Yakui20edd742008-10-17 02:02:44 -04001507 }
Alexey Starikovskiye8284322007-03-07 22:28:00 +03001508 }
Lv Zheng53c5eaa2017-09-26 16:54:03 +08001509 /* EC is fully operational, allow queries */
1510 acpi_ec_enable_event(ec);
Alexey Starikovskiye8284322007-03-07 22:28:00 +03001511
1512 return 0;
1513}
1514
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515static void ec_remove_handlers(struct acpi_ec *ec)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516{
Lv Zheng0e1affe2016-03-24 10:42:47 +08001517 if (test_bit(EC_FLAGS_EC_HANDLER_INSTALLED, &ec->flags)) {
1518 if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle,
1519 ACPI_ADR_SPACE_EC, &acpi_ec_space_handler)))
1520 pr_err("failed to remove space handler\n");
1521 clear_bit(EC_FLAGS_EC_HANDLER_INSTALLED, &ec->flags);
1522 }
1523
Lv Zhengfa5b4a502016-07-08 09:25:05 +08001524 /*
1525 * Stops handling the EC transactions after removing the operation
1526 * region handler. This is required because _REG(DISCONNECT)
1527 * invoked during the removal can result in new EC transactions.
1528 *
1529 * Flushes the EC requests and thus disables the GPE before
1530 * removing the GPE handler. This is required by the current ACPICA
1531 * GPE core. ACPICA GPE core will automatically disable a GPE when
1532 * it is indicated but there is no way to handle it. So the drivers
1533 * must disable the GPEs prior to removing the GPE handlers.
1534 */
1535 acpi_ec_stop(ec, false);
1536
Lv Zheng0e1affe2016-03-24 10:42:47 +08001537 if (test_bit(EC_FLAGS_GPE_HANDLER_INSTALLED, &ec->flags)) {
1538 if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe,
1539 &acpi_ec_gpe_handler)))
1540 pr_err("failed to remove gpe handler\n");
1541 clear_bit(EC_FLAGS_GPE_HANDLER_INSTALLED, &ec->flags);
1542 }
Lv Zheng2a570842016-09-07 16:50:21 +08001543 if (test_bit(EC_FLAGS_EVT_HANDLER_INSTALLED, &ec->flags)) {
1544 acpi_ec_remove_query_handlers(ec, true, 0);
1545 clear_bit(EC_FLAGS_EVT_HANDLER_INSTALLED, &ec->flags);
1546 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548
Lv Zheng2a570842016-09-07 16:50:21 +08001549static int acpi_ec_setup(struct acpi_ec *ec, bool handle_events)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550{
Lv Zheng72c77b72016-09-07 16:50:08 +08001551 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552
Lv Zheng2a570842016-09-07 16:50:21 +08001553 ret = ec_install_handlers(ec, handle_events);
Lv Zheng72c77b72016-09-07 16:50:08 +08001554 if (ret)
1555 return ret;
1556
1557 /* First EC capable of handling transactions */
1558 if (!first_ec) {
1559 first_ec = ec;
1560 acpi_handle_info(first_ec->handle, "Used as first EC\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 }
Lv Zheng72c77b72016-09-07 16:50:08 +08001562
1563 acpi_handle_info(ec->handle,
Geert Uytterhoeven3522f862018-01-02 16:26:31 +01001564 "GPE=0x%x, EC_CMD/EC_SC=0x%lx, EC_DATA=0x%lx\n",
Lv Zheng72c77b72016-09-07 16:50:08 +08001565 ec->gpe, ec->command_addr, ec->data_addr);
1566 return ret;
1567}
1568
Lv Zheng97cb1592016-09-07 16:50:27 +08001569static bool acpi_ec_ecdt_get_handle(acpi_handle *phandle)
1570{
1571 struct acpi_table_ecdt *ecdt_ptr;
1572 acpi_status status;
1573 acpi_handle handle;
1574
1575 status = acpi_get_table(ACPI_SIG_ECDT, 1,
1576 (struct acpi_table_header **)&ecdt_ptr);
1577 if (ACPI_FAILURE(status))
1578 return false;
1579
1580 status = acpi_get_handle(NULL, ecdt_ptr->id, &handle);
1581 if (ACPI_FAILURE(status))
1582 return false;
1583
1584 *phandle = handle;
1585 return true;
1586}
1587
Lv Zhengfd6231e2016-06-21 17:42:05 +08001588static int acpi_ec_add(struct acpi_device *device)
1589{
1590 struct acpi_ec *ec = NULL;
Rafael J. Wysocki116f2b32019-02-01 12:56:03 +01001591 bool dep_update = true;
Lv Zhenga64a62c2017-09-26 16:54:09 +08001592 acpi_status status;
Rafael J. Wysocki116f2b32019-02-01 12:56:03 +01001593 int ret;
Lv Zhengfd6231e2016-06-21 17:42:05 +08001594
1595 strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
1596 strcpy(acpi_device_class(device), ACPI_EC_CLASS);
1597
Lv Zhenga64a62c2017-09-26 16:54:09 +08001598 if (!strcmp(acpi_device_hid(device), ACPI_ECDT_HID)) {
Rafael J. Wysocki116f2b32019-02-01 12:56:03 +01001599 boot_ec_is_ecdt = true;
Lv Zhenga64a62c2017-09-26 16:54:09 +08001600 ec = boot_ec;
Rafael J. Wysocki116f2b32019-02-01 12:56:03 +01001601 dep_update = false;
Lv Zhenga64a62c2017-09-26 16:54:09 +08001602 } else {
1603 ec = acpi_ec_alloc();
1604 if (!ec)
1605 return -ENOMEM;
Rafael J. Wysocki116f2b32019-02-01 12:56:03 +01001606
Lv Zhenga64a62c2017-09-26 16:54:09 +08001607 status = ec_parse_device(device->handle, 0, ec, NULL);
1608 if (status != AE_CTRL_TERMINATE) {
Lv Zheng46922d22016-09-07 16:50:14 +08001609 ret = -EINVAL;
1610 goto err_alloc;
Lv Zhenga64a62c2017-09-26 16:54:09 +08001611 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612
Rafael J. Wysocki116f2b32019-02-01 12:56:03 +01001613 if (boot_ec && ec->command_addr == boot_ec->command_addr &&
1614 ec->data_addr == boot_ec->data_addr) {
1615 boot_ec_is_ecdt = false;
Lv Zhenga64a62c2017-09-26 16:54:09 +08001616 /*
1617 * Trust PNP0C09 namespace location rather than
1618 * ECDT ID. But trust ECDT GPE rather than _GPE
1619 * because of ASUS quirks, so do not change
1620 * boot_ec->gpe to ec->gpe.
1621 */
1622 boot_ec->handle = ec->handle;
1623 acpi_handle_debug(ec->handle, "duplicated.\n");
1624 acpi_ec_free(ec);
1625 ec = boot_ec;
1626 }
Rafael J. Wysockid2c62ae2019-02-01 12:55:31 +01001627 }
1628
1629 ret = acpi_ec_setup(ec, true);
Lv Zheng46922d22016-09-07 16:50:14 +08001630 if (ret)
1631 goto err_query;
1632
Rafael J. Wysockid2c62ae2019-02-01 12:55:31 +01001633 if (ec == boot_ec)
1634 acpi_handle_info(boot_ec->handle,
1635 "Boot %s EC used to handle transactions and events\n",
Rafael J. Wysocki116f2b32019-02-01 12:56:03 +01001636 boot_ec_is_ecdt ? "ECDT" : "DSDT");
Rafael J. Wysockid2c62ae2019-02-01 12:55:31 +01001637
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 device->driver_data = ec;
Thomas Renningerde4f1042010-07-29 22:08:44 +02001639
Andi Kleend6795fe32012-02-06 08:17:08 -08001640 ret = !!request_region(ec->data_addr, 1, "EC data");
1641 WARN(!ret, "Could not request EC data io port 0x%lx", ec->data_addr);
1642 ret = !!request_region(ec->command_addr, 1, "EC cmd");
1643 WARN(!ret, "Could not request EC cmd io port 0x%lx", ec->command_addr);
Thomas Renningerde4f1042010-07-29 22:08:44 +02001644
Rafael J. Wysocki116f2b32019-02-01 12:56:03 +01001645 if (dep_update) {
Lv Zhenga64a62c2017-09-26 16:54:09 +08001646 /* Reprobe devices depending on the EC */
1647 acpi_walk_dep_device_list(ec->handle);
1648 }
Lv Zheng97cb1592016-09-07 16:50:27 +08001649 acpi_handle_debug(ec->handle, "enumerated.\n");
Lv Zheng46922d22016-09-07 16:50:14 +08001650 return 0;
1651
1652err_query:
Lv Zheng97cb1592016-09-07 16:50:27 +08001653 if (ec != boot_ec)
1654 acpi_ec_remove_query_handlers(ec, true, 0);
Lv Zheng46922d22016-09-07 16:50:14 +08001655err_alloc:
Lv Zheng97cb1592016-09-07 16:50:27 +08001656 if (ec != boot_ec)
1657 acpi_ec_free(ec);
Alexey Starikovskiy837012e2007-05-29 16:43:02 +04001658 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659}
1660
Rafael J. Wysocki51fac832013-01-24 00:24:48 +01001661static int acpi_ec_remove(struct acpi_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662{
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +03001663 struct acpi_ec *ec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665 if (!device)
Patrick Mocheld550d982006-06-27 00:41:40 -04001666 return -EINVAL;
Alexey Starikovskiyf9319f92007-08-24 08:10:11 +04001667
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668 ec = acpi_driver_data(device);
Thomas Renningerde4f1042010-07-29 22:08:44 +02001669 release_region(ec->data_addr, 1);
1670 release_region(ec->command_addr, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 device->driver_data = NULL;
Lv Zheng97cb1592016-09-07 16:50:27 +08001672 if (ec != boot_ec) {
1673 ec_remove_handlers(ec);
1674 acpi_ec_free(ec);
1675 }
Patrick Mocheld550d982006-06-27 00:41:40 -04001676 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677}
1678
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679static acpi_status
1680ec_parse_io_ports(struct acpi_resource *resource, void *context)
1681{
1682 struct acpi_ec *ec = context;
1683
1684 if (resource->type != ACPI_RESOURCE_TYPE_IO)
1685 return AE_OK;
1686
1687 /*
1688 * The first address region returned is the data port, and
1689 * the second address region returned is the status/command
1690 * port.
1691 */
Thomas Renningerde4f1042010-07-29 22:08:44 +02001692 if (ec->data_addr == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 ec->data_addr = resource->data.io.minimum;
Thomas Renningerde4f1042010-07-29 22:08:44 +02001694 else if (ec->command_addr == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695 ec->command_addr = resource->data.io.minimum;
1696 else
1697 return AE_CTRL_TERMINATE;
1698
1699 return AE_OK;
1700}
1701
Lv Zhengdcf15cb2016-06-03 10:26:12 +08001702static const struct acpi_device_id ec_device_ids[] = {
1703 {"PNP0C09", 0},
Lv Zhenga64a62c2017-09-26 16:54:09 +08001704 {ACPI_ECDT_HID, 0},
Lv Zhengdcf15cb2016-06-03 10:26:12 +08001705 {"", 0},
1706};
1707
Lv Zhengc712bb52017-06-15 09:41:41 +08001708/*
1709 * This function is not Windows-compatible as Windows never enumerates the
1710 * namespace EC before the main ACPI device enumeration process. It is
1711 * retained for historical reason and will be deprecated in the future.
1712 */
Rafael J. Wysockifdb3c1772019-01-21 13:07:50 +01001713void __init acpi_ec_dsdt_probe(void)
Alexey Starikovskiyc04209a2008-01-01 14:12:55 -05001714{
Lv Zhengfd6231e2016-06-21 17:42:05 +08001715 struct acpi_ec *ec;
Rafael J. Wysockifdb3c1772019-01-21 13:07:50 +01001716 acpi_status status;
Lv Zhengfd6231e2016-06-21 17:42:05 +08001717 int ret;
Lv Zhengdcf15cb2016-06-03 10:26:12 +08001718
Lv Zhengc712bb52017-06-15 09:41:41 +08001719 /*
1720 * If a platform has ECDT, there is no need to proceed as the
1721 * following probe is not a part of the ACPI device enumeration,
1722 * executing _STA is not safe, and thus this probe may risk of
1723 * picking up an invalid EC device.
1724 */
1725 if (boot_ec)
Rafael J. Wysockifdb3c1772019-01-21 13:07:50 +01001726 return;
Lv Zhengc712bb52017-06-15 09:41:41 +08001727
Lv Zhengfd6231e2016-06-21 17:42:05 +08001728 ec = acpi_ec_alloc();
1729 if (!ec)
Rafael J. Wysockifdb3c1772019-01-21 13:07:50 +01001730 return;
1731
Lv Zhengdcf15cb2016-06-03 10:26:12 +08001732 /*
Lv Zheng2a570842016-09-07 16:50:21 +08001733 * At this point, the namespace is initialized, so start to find
1734 * the namespace objects.
Lv Zhengdcf15cb2016-06-03 10:26:12 +08001735 */
Rafael J. Wysockifdb3c1772019-01-21 13:07:50 +01001736 status = acpi_get_devices(ec_device_ids[0].id, ec_parse_device, ec, NULL);
Lv Zhengfd6231e2016-06-21 17:42:05 +08001737 if (ACPI_FAILURE(status) || !ec->handle) {
Rafael J. Wysockifdb3c1772019-01-21 13:07:50 +01001738 acpi_ec_free(ec);
1739 return;
Alexey Starikovskiyc04209a2008-01-01 14:12:55 -05001740 }
Rafael J. Wysockifdb3c1772019-01-21 13:07:50 +01001741
Lv Zheng2a570842016-09-07 16:50:21 +08001742 /*
1743 * When the DSDT EC is available, always re-configure boot EC to
1744 * have _REG evaluated. _REG can only be evaluated after the
1745 * namespace initialization.
1746 * At this point, the GPE is not fully initialized, so do not to
1747 * handle the events.
1748 */
Rafael J. Wysockic746b6b2019-02-01 10:59:42 +01001749 ret = acpi_ec_setup(ec, false);
1750 if (ret) {
Lv Zheng72c77b72016-09-07 16:50:08 +08001751 acpi_ec_free(ec);
Rafael J. Wysockic746b6b2019-02-01 10:59:42 +01001752 return;
1753 }
1754
1755 boot_ec = ec;
1756
1757 acpi_handle_info(ec->handle,
1758 "Boot DSDT EC used to handle transactions\n");
Alexey Starikovskiyc04209a2008-01-01 14:12:55 -05001759}
1760
Lv Zheng2a570842016-09-07 16:50:21 +08001761/*
1762 * If the DSDT EC is not functioning, we still need to prepare a fully
1763 * functioning ECDT EC first in order to handle the events.
1764 * https://bugzilla.kernel.org/show_bug.cgi?id=115021
1765 */
Lv Zheng98529b92017-08-16 15:29:49 +08001766static int __init acpi_ec_ecdt_start(void)
Lv Zheng2a570842016-09-07 16:50:21 +08001767{
Lv Zheng2a570842016-09-07 16:50:21 +08001768 acpi_handle handle;
1769
1770 if (!boot_ec)
1771 return -ENODEV;
Lv Zheng69b957c2017-08-17 10:21:12 +08001772 /* In case acpi_ec_ecdt_start() is called after acpi_ec_add() */
Lv Zheng2a570842016-09-07 16:50:21 +08001773 if (!boot_ec_is_ecdt)
1774 return -ENODEV;
1775
Lv Zheng2a570842016-09-07 16:50:21 +08001776 /*
1777 * At this point, the namespace and the GPE is initialized, so
1778 * start to find the namespace objects and handle the events.
Lv Zheng69b957c2017-08-17 10:21:12 +08001779 *
1780 * Note: ec->handle can be valid if this function is called after
1781 * acpi_ec_add(), hence the fast path.
Lv Zheng2a570842016-09-07 16:50:21 +08001782 */
Lv Zhenga64a62c2017-09-26 16:54:09 +08001783 if (boot_ec->handle == ACPI_ROOT_OBJECT) {
1784 if (!acpi_ec_ecdt_get_handle(&handle))
1785 return -ENODEV;
1786 boot_ec->handle = handle;
1787 }
1788
1789 /* Register to ACPI bus with PM ops attached */
1790 return acpi_bus_register_early_device(ACPI_BUS_TYPE_ECDT_EC);
Lv Zheng2a570842016-09-07 16:50:21 +08001791}
1792
Lv Zheng3cb02ae2015-06-11 13:21:45 +08001793#if 0
Feng Tang67bfa9b2012-09-28 15:22:01 +08001794/*
Lv Zheng3cb02ae2015-06-11 13:21:45 +08001795 * Some EC firmware variations refuses to respond QR_EC when SCI_EVT is not
1796 * set, for which case, we complete the QR_EC without issuing it to the
1797 * firmware.
1798 * https://bugzilla.kernel.org/show_bug.cgi?id=82611
1799 * https://bugzilla.kernel.org/show_bug.cgi?id=97381
Lv Zheng79149002014-10-29 11:33:49 +08001800 */
1801static int ec_flag_query_handshake(const struct dmi_system_id *id)
1802{
1803 pr_debug("Detected the EC firmware requiring QR_EC issued when SCI_EVT set\n");
1804 EC_FLAGS_QUERY_HANDSHAKE = 1;
1805 return 0;
1806}
Lv Zheng3cb02ae2015-06-11 13:21:45 +08001807#endif
Lv Zheng79149002014-10-29 11:33:49 +08001808
1809/*
Zhang Ruib6a3e142019-02-01 14:13:41 +08001810 * On some hardware it is necessary to clear events accumulated by the EC during
1811 * sleep. These ECs stop reporting GPEs until they are manually polled, if too
1812 * many events are accumulated. (e.g. Samsung Series 5/9 notebooks)
1813 *
1814 * https://bugzilla.kernel.org/show_bug.cgi?id=44161
1815 *
1816 * Ideally, the EC should also be instructed NOT to accumulate events during
1817 * sleep (which Windows seems to do somehow), but the interface to control this
1818 * behaviour is not known at this time.
1819 *
1820 * Models known to be affected are Samsung 530Uxx/535Uxx/540Uxx/550Pxx/900Xxx,
1821 * however it is very likely that other Samsung models are affected.
1822 *
1823 * On systems which don't accumulate _Q events during sleep, this extra check
1824 * should be harmless.
1825 */
1826static int ec_clear_on_resume(const struct dmi_system_id *id)
1827{
1828 pr_debug("Detected system needing EC poll on resume.\n");
1829 EC_FLAGS_CLEAR_ON_RESUME = 1;
1830 ec_event_clearing = ACPI_EC_EVT_TIMING_STATUS;
1831 return 0;
1832}
1833
1834/*
Lv Zhengbc539562016-06-21 17:42:12 +08001835 * Some ECDTs contain wrong register addresses.
1836 * MSI MS-171F
1837 * https://bugzilla.kernel.org/show_bug.cgi?id=12461
1838 */
Lv Zheng59f0aa92016-03-24 10:42:53 +08001839static int ec_correct_ecdt(const struct dmi_system_id *id)
1840{
1841 pr_debug("Detected system needing ECDT address correction.\n");
1842 EC_FLAGS_CORRECT_ECDT = 1;
1843 return 0;
1844}
1845
Chris Chiu440f53d2017-06-15 09:41:47 +08001846/*
1847 * Some DSDTs contain wrong GPE setting.
Carlo Caioneef750402017-06-15 09:41:53 +08001848 * Asus FX502VD/VE, GL702VMK, X550VXK, X580VD
Chris Chiu440f53d2017-06-15 09:41:47 +08001849 * https://bugzilla.kernel.org/show_bug.cgi?id=195651
1850 */
1851static int ec_honor_ecdt_gpe(const struct dmi_system_id *id)
1852{
1853 pr_debug("Detected system needing ignore DSDT GPE setting.\n");
1854 EC_FLAGS_IGNORE_DSDT_GPE = 1;
1855 return 0;
1856}
1857
Christoph Hellwig6faadbb2017-09-14 11:59:30 +02001858static const struct dmi_system_id ec_dmi_table[] __initconst = {
Alexey Starikovskiy0adf3c72009-10-02 20:21:33 +04001859 {
Lv Zheng59f0aa92016-03-24 10:42:53 +08001860 ec_correct_ecdt, "MSI MS-171F", {
Lv Zheng3174abc2015-05-15 14:37:11 +08001861 DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star"),
1862 DMI_MATCH(DMI_PRODUCT_NAME, "MS-171F"),}, NULL},
Chris Chiu440f53d2017-06-15 09:41:47 +08001863 {
1864 ec_honor_ecdt_gpe, "ASUS FX502VD", {
1865 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
1866 DMI_MATCH(DMI_PRODUCT_NAME, "FX502VD"),}, NULL},
1867 {
1868 ec_honor_ecdt_gpe, "ASUS FX502VE", {
1869 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
1870 DMI_MATCH(DMI_PRODUCT_NAME, "FX502VE"),}, NULL},
1871 {
Carlo Caioneef750402017-06-15 09:41:53 +08001872 ec_honor_ecdt_gpe, "ASUS GL702VMK", {
1873 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
1874 DMI_MATCH(DMI_PRODUCT_NAME, "GL702VMK"),}, NULL},
1875 {
Chris Chiu440f53d2017-06-15 09:41:47 +08001876 ec_honor_ecdt_gpe, "ASUS X550VXK", {
1877 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
1878 DMI_MATCH(DMI_PRODUCT_NAME, "X550VXK"),}, NULL},
1879 {
1880 ec_honor_ecdt_gpe, "ASUS X580VD", {
1881 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
1882 DMI_MATCH(DMI_PRODUCT_NAME, "X580VD"),}, NULL},
Zhang Ruib6a3e142019-02-01 14:13:41 +08001883 {
1884 ec_clear_on_resume, "Samsung hardware", {
1885 DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD.")}, NULL},
Alexey Starikovskiy0adf3c72009-10-02 20:21:33 +04001886 {},
1887};
1888
Rafael J. Wysockifdb3c1772019-01-21 13:07:50 +01001889void __init acpi_ec_ecdt_probe(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890{
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +03001891 struct acpi_table_ecdt *ecdt_ptr;
Lv Zhengfd6231e2016-06-21 17:42:05 +08001892 struct acpi_ec *ec;
Rafael J. Wysockifdb3c1772019-01-21 13:07:50 +01001893 acpi_status status;
1894 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895
Rafael J. Wysockifdb3c1772019-01-21 13:07:50 +01001896 /* Generate a boot ec context. */
Alexey Starikovskiy0adf3c72009-10-02 20:21:33 +04001897 dmi_check_system(ec_dmi_table);
Alexey Starikovskiyc0900c32007-03-07 22:28:00 +03001898 status = acpi_get_table(ACPI_SIG_ECDT, 1,
1899 (struct acpi_table_header **)&ecdt_ptr);
Rafael J. Wysockifdb3c1772019-01-21 13:07:50 +01001900 if (ACPI_FAILURE(status))
1901 return;
Lv Zheng59f0aa92016-03-24 10:42:53 +08001902
1903 if (!ecdt_ptr->control.address || !ecdt_ptr->data.address) {
1904 /*
1905 * Asus X50GL:
1906 * https://bugzilla.kernel.org/show_bug.cgi?id=11880
1907 */
Rafael J. Wysockifdb3c1772019-01-21 13:07:50 +01001908 return;
Lv Zheng59f0aa92016-03-24 10:42:53 +08001909 }
1910
Rafael J. Wysockifdb3c1772019-01-21 13:07:50 +01001911 ec = acpi_ec_alloc();
1912 if (!ec)
1913 return;
1914
Lv Zheng59f0aa92016-03-24 10:42:53 +08001915 if (EC_FLAGS_CORRECT_ECDT) {
Lv Zhengfd6231e2016-06-21 17:42:05 +08001916 ec->command_addr = ecdt_ptr->data.address;
1917 ec->data_addr = ecdt_ptr->control.address;
Lv Zheng59f0aa92016-03-24 10:42:53 +08001918 } else {
Lv Zhengfd6231e2016-06-21 17:42:05 +08001919 ec->command_addr = ecdt_ptr->control.address;
1920 ec->data_addr = ecdt_ptr->data.address;
Alexey Starikovskiycd8c93a2007-08-03 17:52:48 -04001921 }
Lv Zhengfd6231e2016-06-21 17:42:05 +08001922 ec->gpe = ecdt_ptr->gpe;
Rafael J. Wysocki15684262019-02-01 10:58:20 +01001923 ec->handle = ACPI_ROOT_OBJECT;
Lv Zheng2a570842016-09-07 16:50:21 +08001924
1925 /*
1926 * At this point, the namespace is not initialized, so do not find
1927 * the namespace objects, or handle the events.
1928 */
Rafael J. Wysocki15684262019-02-01 10:58:20 +01001929 ret = acpi_ec_setup(ec, false);
1930 if (ret) {
Lv Zheng72c77b72016-09-07 16:50:08 +08001931 acpi_ec_free(ec);
Rafael J. Wysocki15684262019-02-01 10:58:20 +01001932 return;
1933 }
1934
1935 boot_ec = ec;
1936 boot_ec_is_ecdt = true;
1937
1938 pr_info("Boot ECDT EC used to handle transactions\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939}
1940
Lv Zhengdf45db62016-08-03 09:07:58 +08001941#ifdef CONFIG_PM_SLEEP
Lv Zheng39a2a2a2016-08-03 16:01:43 +08001942static int acpi_ec_suspend(struct device *dev)
1943{
1944 struct acpi_ec *ec =
1945 acpi_driver_data(to_acpi_device(dev));
1946
Rafael J. Wysocki8110dd282017-06-23 15:24:32 +02001947 if (acpi_sleep_no_ec_events() && ec_freeze_events)
Lv Zheng39a2a2a2016-08-03 16:01:43 +08001948 acpi_ec_disable_event(ec);
1949 return 0;
1950}
1951
Rafael J. Wysocki76380632017-07-19 14:41:58 +02001952static int acpi_ec_suspend_noirq(struct device *dev)
1953{
1954 struct acpi_ec *ec = acpi_driver_data(to_acpi_device(dev));
1955
1956 /*
1957 * The SCI handler doesn't run at this point, so the GPE can be
1958 * masked at the low level without side effects.
1959 */
1960 if (ec_no_wakeup && test_bit(EC_FLAGS_STARTED, &ec->flags) &&
1961 ec->reference_count >= 1)
1962 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_DISABLE);
1963
Rafael J. Wysocki3cd091a2018-02-09 22:55:28 +01001964 if (acpi_sleep_no_ec_events())
1965 acpi_ec_enter_noirq(ec);
1966
Rafael J. Wysocki76380632017-07-19 14:41:58 +02001967 return 0;
1968}
1969
1970static int acpi_ec_resume_noirq(struct device *dev)
1971{
1972 struct acpi_ec *ec = acpi_driver_data(to_acpi_device(dev));
1973
Rafael J. Wysocki3cd091a2018-02-09 22:55:28 +01001974 if (acpi_sleep_no_ec_events())
1975 acpi_ec_leave_noirq(ec);
1976
Rafael J. Wysocki76380632017-07-19 14:41:58 +02001977 if (ec_no_wakeup && test_bit(EC_FLAGS_STARTED, &ec->flags) &&
1978 ec->reference_count >= 1)
1979 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_ENABLE);
1980
1981 return 0;
1982}
1983
Lv Zhengc2b46d62016-08-03 16:01:36 +08001984static int acpi_ec_resume(struct device *dev)
1985{
1986 struct acpi_ec *ec =
1987 acpi_driver_data(to_acpi_device(dev));
1988
1989 acpi_ec_enable_event(ec);
1990 return 0;
1991}
Lv Zhengdf45db62016-08-03 09:07:58 +08001992#endif
1993
1994static const struct dev_pm_ops acpi_ec_pm = {
Rafael J. Wysocki76380632017-07-19 14:41:58 +02001995 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(acpi_ec_suspend_noirq, acpi_ec_resume_noirq)
Lv Zheng39a2a2a2016-08-03 16:01:43 +08001996 SET_SYSTEM_SLEEP_PM_OPS(acpi_ec_suspend, acpi_ec_resume)
Lv Zhengdf45db62016-08-03 09:07:58 +08001997};
1998
Kees Cooke4dca7b2017-10-17 19:04:42 -07001999static int param_set_event_clearing(const char *val,
2000 const struct kernel_param *kp)
Lv Zheng1d68d262015-06-11 13:21:38 +08002001{
2002 int result = 0;
2003
2004 if (!strncmp(val, "status", sizeof("status") - 1)) {
2005 ec_event_clearing = ACPI_EC_EVT_TIMING_STATUS;
2006 pr_info("Assuming SCI_EVT clearing on EC_SC accesses\n");
2007 } else if (!strncmp(val, "query", sizeof("query") - 1)) {
2008 ec_event_clearing = ACPI_EC_EVT_TIMING_QUERY;
2009 pr_info("Assuming SCI_EVT clearing on QR_EC writes\n");
2010 } else if (!strncmp(val, "event", sizeof("event") - 1)) {
2011 ec_event_clearing = ACPI_EC_EVT_TIMING_EVENT;
2012 pr_info("Assuming SCI_EVT clearing on event reads\n");
2013 } else
2014 result = -EINVAL;
2015 return result;
2016}
2017
Kees Cooke4dca7b2017-10-17 19:04:42 -07002018static int param_get_event_clearing(char *buffer,
2019 const struct kernel_param *kp)
Lv Zheng1d68d262015-06-11 13:21:38 +08002020{
2021 switch (ec_event_clearing) {
2022 case ACPI_EC_EVT_TIMING_STATUS:
2023 return sprintf(buffer, "status");
2024 case ACPI_EC_EVT_TIMING_QUERY:
2025 return sprintf(buffer, "query");
2026 case ACPI_EC_EVT_TIMING_EVENT:
2027 return sprintf(buffer, "event");
2028 default:
2029 return sprintf(buffer, "invalid");
2030 }
2031 return 0;
2032}
2033
2034module_param_call(ec_event_clearing, param_set_event_clearing, param_get_event_clearing,
2035 NULL, 0644);
2036MODULE_PARM_DESC(ec_event_clearing, "Assumed SCI_EVT clearing timing");
2037
Alexey Starikovskiy223883b2008-03-21 17:07:21 +03002038static struct acpi_driver acpi_ec_driver = {
2039 .name = "ec",
2040 .class = ACPI_EC_CLASS,
2041 .ids = ec_device_ids,
2042 .ops = {
2043 .add = acpi_ec_add,
2044 .remove = acpi_ec_remove,
Alexey Starikovskiy223883b2008-03-21 17:07:21 +03002045 },
Lv Zhengdf45db62016-08-03 09:07:58 +08002046 .drv.pm = &acpi_ec_pm,
Alexey Starikovskiy223883b2008-03-21 17:07:21 +03002047};
2048
Lv Zhenge1191bd2016-08-03 09:00:14 +08002049static inline int acpi_ec_query_init(void)
2050{
2051 if (!ec_query_wq) {
2052 ec_query_wq = alloc_workqueue("kec_query", 0,
2053 ec_max_queries);
2054 if (!ec_query_wq)
2055 return -ENODEV;
2056 }
2057 return 0;
2058}
2059
2060static inline void acpi_ec_query_exit(void)
2061{
2062 if (ec_query_wq) {
2063 destroy_workqueue(ec_query_wq);
2064 ec_query_wq = NULL;
2065 }
2066}
2067
Mika Westerberg8195a652018-06-18 14:17:16 +03002068static const struct dmi_system_id acpi_ec_no_wakeup[] = {
2069 {
2070 .ident = "Thinkpad X1 Carbon 6th",
2071 .matches = {
2072 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
Robin H. Johnson2c4d6ba2018-07-13 20:50:47 +00002073 DMI_MATCH(DMI_PRODUCT_FAMILY, "Thinkpad X1 Carbon 6th"),
Mika Westerberg8195a652018-06-18 14:17:16 +03002074 },
2075 },
Aaron Mab047c622018-07-31 18:52:39 +08002076 {
Mika Westerberg4c3be61e2018-08-08 12:50:37 +03002077 .ident = "ThinkPad X1 Carbon 6th",
2078 .matches = {
2079 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
2080 DMI_MATCH(DMI_PRODUCT_FAMILY, "ThinkPad X1 Carbon 6th"),
2081 },
2082 },
2083 {
Aaron Mab047c622018-07-31 18:52:39 +08002084 .ident = "ThinkPad X1 Yoga 3rd",
2085 .matches = {
2086 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
2087 DMI_MATCH(DMI_PRODUCT_FAMILY, "ThinkPad X1 Yoga 3rd"),
2088 },
2089 },
Mika Westerberg8195a652018-06-18 14:17:16 +03002090 { },
2091};
2092
Bjorn Helgaasa5f820f2009-03-24 16:49:48 -06002093int __init acpi_ec_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094{
Lv Zhenge1191bd2016-08-03 09:00:14 +08002095 int result;
Lv Zheng98529b92017-08-16 15:29:49 +08002096 int ecdt_fail, dsdt_fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097
Lv Zhenge1191bd2016-08-03 09:00:14 +08002098 /* register workqueue for _Qxx evaluations */
2099 result = acpi_ec_query_init();
2100 if (result)
Lv Zheng98529b92017-08-16 15:29:49 +08002101 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102
Mika Westerberg8195a652018-06-18 14:17:16 +03002103 /*
2104 * Disable EC wakeup on following systems to prevent periodic
2105 * wakeup from EC GPE.
2106 */
2107 if (dmi_check_system(acpi_ec_no_wakeup)) {
2108 ec_no_wakeup = true;
2109 pr_debug("Disabling EC wakeup on suspend-to-idle\n");
2110 }
2111
Lv Zheng98529b92017-08-16 15:29:49 +08002112 /* Drivers must be started after acpi_ec_query_init() */
Lv Zheng98529b92017-08-16 15:29:49 +08002113 dsdt_fail = acpi_bus_register_driver(&acpi_ec_driver);
Lv Zhenga64a62c2017-09-26 16:54:09 +08002114 /*
2115 * Register ECDT to ACPI bus only when PNP0C09 probe fails. This is
2116 * useful for platforms (confirmed on ASUS X550ZE) with valid ECDT
2117 * settings but invalid DSDT settings.
2118 * https://bugzilla.kernel.org/show_bug.cgi?id=196847
2119 */
Lv Zheng69b957c2017-08-17 10:21:12 +08002120 ecdt_fail = acpi_ec_ecdt_start();
Lv Zheng98529b92017-08-16 15:29:49 +08002121 return ecdt_fail && dsdt_fail ? -ENODEV : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122}
2123
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124/* EC driver currently not unloadable */
2125#if 0
Len Brown50526df2005-08-11 17:32:05 -04002126static void __exit acpi_ec_exit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128
2129 acpi_bus_unregister_driver(&acpi_ec_driver);
Lv Zhenge1191bd2016-08-03 09:00:14 +08002130 acpi_ec_query_exit();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131}
Alexey Starikovskiy78439322007-10-22 14:18:43 +04002132#endif /* 0 */