2019-05-29 22:17:56 +08:00
|
|
|
// SPDX-License-Identifier: GPL-2.0-only
|
2013-02-26 06:08:37 +08:00
|
|
|
/*
|
|
|
|
* ChromeOS EC multi-function device
|
|
|
|
*
|
|
|
|
* Copyright (C) 2012 Google, Inc
|
|
|
|
*
|
|
|
|
* The ChromeOS EC multi function device is used to mux all the requests
|
|
|
|
* to the EC device for its multiple features: keyboard controller,
|
|
|
|
* battery charging and regulator control, firmware update.
|
|
|
|
*/
|
|
|
|
|
2015-05-20 17:31:28 +08:00
|
|
|
#include <linux/of_platform.h>
|
2013-02-26 06:08:37 +08:00
|
|
|
#include <linux/interrupt.h>
|
|
|
|
#include <linux/slab.h>
|
2013-03-20 16:46:15 +08:00
|
|
|
#include <linux/module.h>
|
2019-09-02 17:53:05 +08:00
|
|
|
#include <linux/platform_data/cros_ec_commands.h>
|
|
|
|
#include <linux/platform_data/cros_ec_proto.h>
|
2016-12-17 01:57:37 +08:00
|
|
|
#include <linux/suspend.h>
|
2016-08-11 01:05:24 +08:00
|
|
|
#include <asm/unaligned.h>
|
2014-09-18 23:18:56 +08:00
|
|
|
|
2015-06-09 19:04:47 +08:00
|
|
|
#define CROS_EC_DEV_EC_INDEX 0
|
|
|
|
#define CROS_EC_DEV_PD_INDEX 1
|
|
|
|
|
2015-06-15 21:39:39 +08:00
|
|
|
static struct cros_ec_platform ec_p = {
|
2015-06-09 19:04:47 +08:00
|
|
|
.ec_name = CROS_EC_DEV_NAME,
|
|
|
|
.cmd_offset = EC_CMD_PASSTHRU_OFFSET(CROS_EC_DEV_EC_INDEX),
|
|
|
|
};
|
|
|
|
|
2015-06-15 21:39:39 +08:00
|
|
|
static struct cros_ec_platform pd_p = {
|
2015-06-09 19:04:47 +08:00
|
|
|
.ec_name = CROS_EC_DEV_PD_NAME,
|
|
|
|
.cmd_offset = EC_CMD_PASSTHRU_OFFSET(CROS_EC_DEV_PD_INDEX),
|
|
|
|
};
|
|
|
|
|
2019-11-19 20:45:46 +08:00
|
|
|
static irqreturn_t ec_irq_handler(int irq, void *data)
|
|
|
|
{
|
|
|
|
struct cros_ec_device *ec_dev = data;
|
|
|
|
|
|
|
|
ec_dev->last_event_time = cros_ec_get_time_ns();
|
|
|
|
|
|
|
|
return IRQ_WAKE_THREAD;
|
|
|
|
}
|
|
|
|
|
2016-08-11 01:05:24 +08:00
|
|
|
static irqreturn_t ec_irq_thread(int irq, void *data)
|
|
|
|
{
|
|
|
|
struct cros_ec_device *ec_dev = data;
|
2017-02-15 03:58:02 +08:00
|
|
|
bool wake_event = true;
|
2016-08-11 01:05:24 +08:00
|
|
|
int ret;
|
|
|
|
|
2017-02-15 03:58:02 +08:00
|
|
|
ret = cros_ec_get_next_event(ec_dev, &wake_event);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Signal only if wake host events or any interrupt if
|
|
|
|
* cros_ec_get_next_event() returned an error (default value for
|
|
|
|
* wake_event is true)
|
|
|
|
*/
|
|
|
|
if (wake_event && device_may_wakeup(ec_dev->dev))
|
2016-08-11 01:05:24 +08:00
|
|
|
pm_wakeup_event(ec_dev->dev, 0);
|
|
|
|
|
|
|
|
if (ret > 0)
|
|
|
|
blocking_notifier_call_chain(&ec_dev->event_notifier,
|
|
|
|
0, ec_dev);
|
|
|
|
return IRQ_HANDLED;
|
|
|
|
}
|
|
|
|
|
2016-12-17 01:57:37 +08:00
|
|
|
static int cros_ec_sleep_event(struct cros_ec_device *ec_dev, u8 sleep_event)
|
|
|
|
{
|
2019-04-04 05:34:28 +08:00
|
|
|
int ret;
|
2016-12-17 01:57:37 +08:00
|
|
|
struct {
|
|
|
|
struct cros_ec_command msg;
|
2019-04-04 05:34:28 +08:00
|
|
|
union {
|
|
|
|
struct ec_params_host_sleep_event req0;
|
|
|
|
struct ec_params_host_sleep_event_v1 req1;
|
|
|
|
struct ec_response_host_sleep_event_v1 resp1;
|
|
|
|
} u;
|
2016-12-17 01:57:37 +08:00
|
|
|
} __packed buf;
|
|
|
|
|
|
|
|
memset(&buf, 0, sizeof(buf));
|
|
|
|
|
2019-04-04 05:34:28 +08:00
|
|
|
if (ec_dev->host_sleep_v1) {
|
|
|
|
buf.u.req1.sleep_event = sleep_event;
|
|
|
|
buf.u.req1.suspend_params.sleep_timeout_ms =
|
|
|
|
EC_HOST_SLEEP_TIMEOUT_DEFAULT;
|
|
|
|
|
|
|
|
buf.msg.outsize = sizeof(buf.u.req1);
|
|
|
|
if ((sleep_event == HOST_SLEEP_EVENT_S3_RESUME) ||
|
|
|
|
(sleep_event == HOST_SLEEP_EVENT_S0IX_RESUME))
|
|
|
|
buf.msg.insize = sizeof(buf.u.resp1);
|
|
|
|
|
|
|
|
buf.msg.version = 1;
|
|
|
|
|
|
|
|
} else {
|
|
|
|
buf.u.req0.sleep_event = sleep_event;
|
|
|
|
buf.msg.outsize = sizeof(buf.u.req0);
|
|
|
|
}
|
2016-12-17 01:57:37 +08:00
|
|
|
|
|
|
|
buf.msg.command = EC_CMD_HOST_SLEEP_EVENT;
|
|
|
|
|
2019-04-04 05:34:28 +08:00
|
|
|
ret = cros_ec_cmd_xfer(ec_dev, &buf.msg);
|
|
|
|
|
|
|
|
/* For now, report failure to transition to S0ix with a warning. */
|
|
|
|
if (ret >= 0 && ec_dev->host_sleep_v1 &&
|
2019-06-28 04:44:45 +08:00
|
|
|
(sleep_event == HOST_SLEEP_EVENT_S0IX_RESUME)) {
|
|
|
|
ec_dev->last_resume_result =
|
|
|
|
buf.u.resp1.resume_response.sleep_transitions;
|
|
|
|
|
2019-04-04 05:34:28 +08:00
|
|
|
WARN_ONCE(buf.u.resp1.resume_response.sleep_transitions &
|
|
|
|
EC_HOST_RESUME_SLEEP_TIMEOUT,
|
|
|
|
"EC detected sleep transition timeout. Total slp_s0 transitions: %d",
|
|
|
|
buf.u.resp1.resume_response.sleep_transitions &
|
|
|
|
EC_HOST_RESUME_SLEEP_TRANSITIONS_MASK);
|
2019-06-28 04:44:45 +08:00
|
|
|
}
|
2019-04-04 05:34:28 +08:00
|
|
|
|
|
|
|
return ret;
|
2016-12-17 01:57:37 +08:00
|
|
|
}
|
|
|
|
|
2019-11-19 20:45:45 +08:00
|
|
|
/**
|
|
|
|
* cros_ec_register() - Register a new ChromeOS EC, using the provided info.
|
|
|
|
* @ec_dev: Device to register.
|
|
|
|
*
|
|
|
|
* Before calling this, allocate a pointer to a new device and then fill
|
|
|
|
* in all the fields up to the --private-- marker.
|
|
|
|
*
|
|
|
|
* Return: 0 on success or negative error code.
|
|
|
|
*/
|
2013-02-26 06:08:37 +08:00
|
|
|
int cros_ec_register(struct cros_ec_device *ec_dev)
|
|
|
|
{
|
|
|
|
struct device *dev = ec_dev->dev;
|
|
|
|
int err = 0;
|
|
|
|
|
2016-08-11 01:05:24 +08:00
|
|
|
BLOCKING_INIT_NOTIFIER_HEAD(&ec_dev->event_notifier);
|
|
|
|
|
2015-06-09 19:04:45 +08:00
|
|
|
ec_dev->max_request = sizeof(struct ec_params_hello);
|
|
|
|
ec_dev->max_response = sizeof(struct ec_response_get_protocol_info);
|
|
|
|
ec_dev->max_passthru = 0;
|
|
|
|
|
|
|
|
ec_dev->din = devm_kzalloc(dev, ec_dev->din_size, GFP_KERNEL);
|
|
|
|
if (!ec_dev->din)
|
|
|
|
return -ENOMEM;
|
|
|
|
|
|
|
|
ec_dev->dout = devm_kzalloc(dev, ec_dev->dout_size, GFP_KERNEL);
|
|
|
|
if (!ec_dev->dout)
|
|
|
|
return -ENOMEM;
|
2013-02-26 06:08:37 +08:00
|
|
|
|
2014-09-18 23:18:57 +08:00
|
|
|
mutex_init(&ec_dev->lock);
|
|
|
|
|
2018-04-18 18:23:58 +08:00
|
|
|
err = cros_ec_query_all(ec_dev);
|
|
|
|
if (err) {
|
|
|
|
dev_err(dev, "Cannot identify the EC: error %d\n", err);
|
|
|
|
return err;
|
|
|
|
}
|
2015-06-09 19:04:45 +08:00
|
|
|
|
2019-11-19 20:45:46 +08:00
|
|
|
if (ec_dev->irq > 0) {
|
2019-11-19 20:45:46 +08:00
|
|
|
err = devm_request_threaded_irq(dev, ec_dev->irq,
|
|
|
|
ec_irq_handler,
|
|
|
|
ec_irq_thread,
|
|
|
|
IRQF_TRIGGER_LOW | IRQF_ONESHOT,
|
|
|
|
"chromeos-ec", ec_dev);
|
2016-08-11 01:05:24 +08:00
|
|
|
if (err) {
|
|
|
|
dev_err(dev, "Failed to request IRQ %d: %d",
|
|
|
|
ec_dev->irq, err);
|
|
|
|
return err;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-09-02 17:53:00 +08:00
|
|
|
/* Register a platform device for the main EC instance */
|
|
|
|
ec_dev->ec = platform_device_register_data(ec_dev->dev, "cros-ec-dev",
|
|
|
|
PLATFORM_DEVID_AUTO, &ec_p,
|
|
|
|
sizeof(struct cros_ec_platform));
|
|
|
|
if (IS_ERR(ec_dev->ec)) {
|
|
|
|
dev_err(ec_dev->dev,
|
|
|
|
"Failed to create CrOS EC platform device\n");
|
|
|
|
return PTR_ERR(ec_dev->ec);
|
2013-02-26 06:08:37 +08:00
|
|
|
}
|
|
|
|
|
2015-06-09 19:04:47 +08:00
|
|
|
if (ec_dev->max_passthru) {
|
|
|
|
/*
|
2019-09-02 17:53:00 +08:00
|
|
|
* Register a platform device for the PD behind the main EC.
|
2015-06-09 19:04:47 +08:00
|
|
|
* We make the following assumptions:
|
|
|
|
* - behind an EC, we have a pd
|
|
|
|
* - only one device added.
|
|
|
|
* - the EC is responsive at init time (it is not true for a
|
2019-09-02 17:53:00 +08:00
|
|
|
* sensor hub).
|
2015-06-09 19:04:47 +08:00
|
|
|
*/
|
2019-09-02 17:53:00 +08:00
|
|
|
ec_dev->pd = platform_device_register_data(ec_dev->dev,
|
|
|
|
"cros-ec-dev",
|
|
|
|
PLATFORM_DEVID_AUTO, &pd_p,
|
|
|
|
sizeof(struct cros_ec_platform));
|
|
|
|
if (IS_ERR(ec_dev->pd)) {
|
|
|
|
dev_err(ec_dev->dev,
|
|
|
|
"Failed to create CrOS PD platform device\n");
|
|
|
|
platform_device_unregister(ec_dev->ec);
|
|
|
|
return PTR_ERR(ec_dev->pd);
|
2015-06-09 19:04:47 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-05-20 17:31:28 +08:00
|
|
|
if (IS_ENABLED(CONFIG_OF) && dev->of_node) {
|
2017-05-29 23:45:55 +08:00
|
|
|
err = devm_of_platform_populate(dev);
|
2015-05-20 17:31:28 +08:00
|
|
|
if (err) {
|
2019-09-02 17:53:00 +08:00
|
|
|
platform_device_unregister(ec_dev->pd);
|
|
|
|
platform_device_unregister(ec_dev->ec);
|
2015-05-20 17:31:28 +08:00
|
|
|
dev_err(dev, "Failed to register sub-devices\n");
|
2018-04-18 18:23:59 +08:00
|
|
|
return err;
|
2015-05-20 17:31:28 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-12-17 01:57:37 +08:00
|
|
|
/*
|
|
|
|
* Clear sleep event - this will fail harmlessly on platforms that
|
|
|
|
* don't implement the sleep event host command.
|
|
|
|
*/
|
|
|
|
err = cros_ec_sleep_event(ec_dev, 0);
|
|
|
|
if (err < 0)
|
|
|
|
dev_dbg(ec_dev->dev, "Error %d clearing sleep event to ec",
|
|
|
|
err);
|
|
|
|
|
2014-06-19 02:14:03 +08:00
|
|
|
dev_info(dev, "Chrome EC device registered\n");
|
2013-02-26 06:08:37 +08:00
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
2013-03-20 16:46:15 +08:00
|
|
|
EXPORT_SYMBOL(cros_ec_register);
|
2013-02-26 06:08:37 +08:00
|
|
|
|
2019-11-19 20:45:45 +08:00
|
|
|
/**
|
|
|
|
* cros_ec_unregister() - Remove a ChromeOS EC.
|
|
|
|
* @ec_dev: Device to unregister.
|
|
|
|
*
|
|
|
|
* Call this to deregister a ChromeOS EC, then clean up any private data.
|
|
|
|
*
|
|
|
|
* Return: 0 on success or negative error code.
|
|
|
|
*/
|
2019-09-02 17:53:00 +08:00
|
|
|
int cros_ec_unregister(struct cros_ec_device *ec_dev)
|
|
|
|
{
|
|
|
|
if (ec_dev->pd)
|
|
|
|
platform_device_unregister(ec_dev->pd);
|
|
|
|
platform_device_unregister(ec_dev->ec);
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
EXPORT_SYMBOL(cros_ec_unregister);
|
|
|
|
|
2013-02-26 06:08:37 +08:00
|
|
|
#ifdef CONFIG_PM_SLEEP
|
2019-11-19 20:45:45 +08:00
|
|
|
/**
|
|
|
|
* cros_ec_suspend() - Handle a suspend operation for the ChromeOS EC device.
|
|
|
|
* @ec_dev: Device to suspend.
|
|
|
|
*
|
|
|
|
* This can be called by drivers to handle a suspend event.
|
|
|
|
*
|
|
|
|
* Return: 0 on success or negative error code.
|
|
|
|
*/
|
2013-02-26 06:08:37 +08:00
|
|
|
int cros_ec_suspend(struct cros_ec_device *ec_dev)
|
|
|
|
{
|
|
|
|
struct device *dev = ec_dev->dev;
|
2016-12-17 01:57:37 +08:00
|
|
|
int ret;
|
|
|
|
u8 sleep_event;
|
|
|
|
|
2018-02-23 05:30:52 +08:00
|
|
|
sleep_event = (!IS_ENABLED(CONFIG_ACPI) || pm_suspend_via_firmware()) ?
|
|
|
|
HOST_SLEEP_EVENT_S3_SUSPEND :
|
|
|
|
HOST_SLEEP_EVENT_S0IX_SUSPEND;
|
2016-12-17 01:57:37 +08:00
|
|
|
|
|
|
|
ret = cros_ec_sleep_event(ec_dev, sleep_event);
|
|
|
|
if (ret < 0)
|
|
|
|
dev_dbg(ec_dev->dev, "Error %d sending suspend event to ec",
|
|
|
|
ret);
|
2013-02-26 06:08:37 +08:00
|
|
|
|
|
|
|
if (device_may_wakeup(dev))
|
|
|
|
ec_dev->wake_enabled = !enable_irq_wake(ec_dev->irq);
|
|
|
|
|
|
|
|
disable_irq(ec_dev->irq);
|
|
|
|
ec_dev->was_wake_device = ec_dev->wake_enabled;
|
2016-12-17 01:57:36 +08:00
|
|
|
ec_dev->suspended = true;
|
2013-02-26 06:08:37 +08:00
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
2013-03-20 16:46:15 +08:00
|
|
|
EXPORT_SYMBOL(cros_ec_suspend);
|
2013-02-26 06:08:37 +08:00
|
|
|
|
2018-05-31 03:22:04 +08:00
|
|
|
static void cros_ec_report_events_during_suspend(struct cros_ec_device *ec_dev)
|
2016-08-11 01:05:24 +08:00
|
|
|
{
|
2018-08-20 23:34:19 +08:00
|
|
|
while (ec_dev->mkbp_event_supported &&
|
|
|
|
cros_ec_get_next_event(ec_dev, NULL) > 0)
|
2016-08-11 01:05:24 +08:00
|
|
|
blocking_notifier_call_chain(&ec_dev->event_notifier,
|
|
|
|
1, ec_dev);
|
|
|
|
}
|
|
|
|
|
2019-11-19 20:45:45 +08:00
|
|
|
/**
|
|
|
|
* cros_ec_resume() - Handle a resume operation for the ChromeOS EC device.
|
|
|
|
* @ec_dev: Device to resume.
|
|
|
|
*
|
|
|
|
* This can be called by drivers to handle a resume event.
|
|
|
|
*
|
|
|
|
* Return: 0 on success or negative error code.
|
|
|
|
*/
|
2013-02-26 06:08:37 +08:00
|
|
|
int cros_ec_resume(struct cros_ec_device *ec_dev)
|
|
|
|
{
|
2016-12-17 01:57:37 +08:00
|
|
|
int ret;
|
|
|
|
u8 sleep_event;
|
|
|
|
|
2016-12-17 01:57:36 +08:00
|
|
|
ec_dev->suspended = false;
|
2013-02-26 06:08:37 +08:00
|
|
|
enable_irq(ec_dev->irq);
|
|
|
|
|
2017-01-13 23:04:32 +08:00
|
|
|
sleep_event = (!IS_ENABLED(CONFIG_ACPI) || pm_suspend_via_firmware()) ?
|
|
|
|
HOST_SLEEP_EVENT_S3_RESUME :
|
|
|
|
HOST_SLEEP_EVENT_S0IX_RESUME;
|
2016-12-17 01:57:37 +08:00
|
|
|
|
|
|
|
ret = cros_ec_sleep_event(ec_dev, sleep_event);
|
|
|
|
if (ret < 0)
|
|
|
|
dev_dbg(ec_dev->dev, "Error %d sending resume event to ec",
|
|
|
|
ret);
|
|
|
|
|
2013-02-26 06:08:37 +08:00
|
|
|
if (ec_dev->wake_enabled) {
|
|
|
|
disable_irq_wake(ec_dev->irq);
|
|
|
|
ec_dev->wake_enabled = 0;
|
|
|
|
}
|
2018-05-31 03:22:04 +08:00
|
|
|
/*
|
|
|
|
* Let the mfd devices know about events that occur during
|
|
|
|
* suspend. This way the clients know what to do with them.
|
|
|
|
*/
|
|
|
|
cros_ec_report_events_during_suspend(ec_dev);
|
|
|
|
|
2013-02-26 06:08:37 +08:00
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
2013-03-20 16:46:15 +08:00
|
|
|
EXPORT_SYMBOL(cros_ec_resume);
|
|
|
|
|
2013-02-26 06:08:37 +08:00
|
|
|
#endif
|
2014-04-18 03:32:17 +08:00
|
|
|
|
|
|
|
MODULE_LICENSE("GPL");
|
|
|
|
MODULE_DESCRIPTION("ChromeOS EC core driver");
|