[linux-2.6-block.git] / drivers / platform / chrome / cros_ec_debugfs.c

// SPDX-License-Identifier: GPL-2.0+
// Debug logs for the ChromeOS EC
//
// Copyright (C) 2015 Google, Inc.

#include <linux/circ_buf.h>
#include <linux/debugfs.h>
#include <linux/delay.h>
#include <linux/fs.h>
#include <linux/mfd/cros_ec.h>
#include <linux/mfd/cros_ec_commands.h>
#include <linux/module.h>
#include <linux/mutex.h>
#include <linux/platform_device.h>
#include <linux/poll.h>
#include <linux/sched.h>
#include <linux/slab.h>
#include <linux/wait.h>

#define DRV_NAME "cros-ec-debugfs"

#define LOG_SHIFT		14
#define LOG_SIZE		(1 << LOG_SHIFT)
#define LOG_POLL_SEC		10

#define CIRC_ADD(idx, size, value)	(((idx) + (value)) & ((size) - 1))

/**
 * struct cros_ec_debugfs - EC debugging information.
 *
 * @ec: EC device this debugfs information belongs to
 * @dir: dentry for debugfs files
 * @log_buffer: circular buffer for console log information
 * @read_msg: preallocated EC command and buffer to read console log
 * @log_mutex: mutex to protect circular buffer
 * @log_wq: waitqueue for log readers
 * @log_poll_work: recurring task to poll EC for new console log data
 * @panicinfo_blob: panicinfo debugfs blob
 */
struct cros_ec_debugfs {
	struct cros_ec_dev *ec;
	struct dentry *dir;
	/* EC log */
	struct circ_buf log_buffer;
	struct cros_ec_command *read_msg;
	struct mutex log_mutex;
	wait_queue_head_t log_wq;
	struct delayed_work log_poll_work;
	/* EC panicinfo */
	struct debugfs_blob_wrapper panicinfo_blob;
};

/*
 * We need to make sure that the EC log buffer on the UART is large enough,
 * so that it is unlikely enough to overlow within LOG_POLL_SEC.
 */
static void cros_ec_console_log_work(struct work_struct *__work)
{
	struct cros_ec_debugfs *debug_info =
		container_of(to_delayed_work(__work),
			     struct cros_ec_debugfs,
			     log_poll_work);
	struct cros_ec_dev *ec = debug_info->ec;
	struct circ_buf *cb = &debug_info->log_buffer;
	struct cros_ec_command snapshot_msg = {
		.command = EC_CMD_CONSOLE_SNAPSHOT + ec->cmd_offset,
	};

	struct ec_params_console_read_v1 *read_params =
		(struct ec_params_console_read_v1 *)debug_info->read_msg->data;
	uint8_t *ec_buffer = (uint8_t *)debug_info->read_msg->data;
	int idx;
	int buf_space;
	int ret;

	ret = cros_ec_cmd_xfer_status(ec->ec_dev, &snapshot_msg);
	if (ret < 0)
		goto resched;

	/* Loop until we have read everything, or there's an error. */
	mutex_lock(&debug_info->log_mutex);
	buf_space = CIRC_SPACE(cb->head, cb->tail, LOG_SIZE);

	while (1) {
		if (!buf_space) {
			dev_info_once(ec->dev,
				      "Some logs may have been dropped...\n");
			break;
		}

		memset(read_params, '\0', sizeof(*read_params));
		read_params->subcmd = CONSOLE_READ_RECENT;
		ret = cros_ec_cmd_xfer_status(ec->ec_dev,
					      debug_info->read_msg);
		if (ret < 0)
			break;

		/* If the buffer is empty, we're done here. */
		if (ret == 0 || ec_buffer[0] == '\0')
			break;

		idx = 0;
		while (idx < ret && ec_buffer[idx] != '\0' && buf_space > 0) {
			cb->buf[cb->head] = ec_buffer[idx];
			cb->head = CIRC_ADD(cb->head, LOG_SIZE, 1);
			idx++;
			buf_space--;
		}

		wake_up(&debug_info->log_wq);
	}

	mutex_unlock(&debug_info->log_mutex);

resched:
	schedule_delayed_work(&debug_info->log_poll_work,
			      msecs_to_jiffies(LOG_POLL_SEC * 1000));
}

static int cros_ec_console_log_open(struct inode *inode, struct file *file)
{
	file->private_data = inode->i_private;

	return stream_open(inode, file);
}

static ssize_t cros_ec_console_log_read(struct file *file, char __user *buf,
					size_t count, loff_t *ppos)
{
	struct cros_ec_debugfs *debug_info = file->private_data;
	struct circ_buf *cb = &debug_info->log_buffer;
	ssize_t ret;

	mutex_lock(&debug_info->log_mutex);

	while (!CIRC_CNT(cb->head, cb->tail, LOG_SIZE)) {
		if (file->f_flags & O_NONBLOCK) {
			ret = -EAGAIN;
			goto error;
		}

		mutex_unlock(&debug_info->log_mutex);

		ret = wait_event_interruptible(debug_info->log_wq,
					CIRC_CNT(cb->head, cb->tail, LOG_SIZE));
		if (ret < 0)
			return ret;

		mutex_lock(&debug_info->log_mutex);
	}

	/* Only copy until the end of the circular buffer, and let userspace
	 * retry to get the rest of the data.
	 */
	ret = min_t(size_t, CIRC_CNT_TO_END(cb->head, cb->tail, LOG_SIZE),
		    count);

	if (copy_to_user(buf, cb->buf + cb->tail, ret)) {
		ret = -EFAULT;
		goto error;
	}

	cb->tail = CIRC_ADD(cb->tail, LOG_SIZE, ret);

error:
	mutex_unlock(&debug_info->log_mutex);
	return ret;
}

static __poll_t cros_ec_console_log_poll(struct file *file,
					     poll_table *wait)
{
	struct cros_ec_debugfs *debug_info = file->private_data;
	__poll_t mask = 0;

	poll_wait(file, &debug_info->log_wq, wait);

	mutex_lock(&debug_info->log_mutex);
	if (CIRC_CNT(debug_info->log_buffer.head,
		     debug_info->log_buffer.tail,
		     LOG_SIZE))
		mask |= EPOLLIN | EPOLLRDNORM;
	mutex_unlock(&debug_info->log_mutex);

	return mask;
}

static int cros_ec_console_log_release(struct inode *inode, struct file *file)
{
	return 0;
}

static ssize_t cros_ec_pdinfo_read(struct file *file,
				   char __user *user_buf,
				   size_t count,
				   loff_t *ppos)
{
	char read_buf[EC_USB_PD_MAX_PORTS * 40], *p = read_buf;
	struct cros_ec_debugfs *debug_info = file->private_data;
	struct cros_ec_device *ec_dev = debug_info->ec->ec_dev;
	struct {
		struct cros_ec_command msg;
		union {
			struct ec_response_usb_pd_control_v1 resp;
			struct ec_params_usb_pd_control params;
		};
	} __packed ec_buf;
	struct cros_ec_command *msg;
	struct ec_response_usb_pd_control_v1 *resp;
	struct ec_params_usb_pd_control *params;
	int i;

	msg = &ec_buf.msg;
	params = (struct ec_params_usb_pd_control *)msg->data;
	resp = (struct ec_response_usb_pd_control_v1 *)msg->data;

	msg->command = EC_CMD_USB_PD_CONTROL;
	msg->version = 1;
	msg->insize = sizeof(*resp);
	msg->outsize = sizeof(*params);

	/*
	 * Read status from all PD ports until failure, typically caused
	 * by attempting to read status on a port that doesn't exist.
	 */
	for (i = 0; i < EC_USB_PD_MAX_PORTS; ++i) {
		params->port = i;
		params->role = 0;
		params->mux = 0;
		params->swap = 0;

		if (cros_ec_cmd_xfer_status(ec_dev, msg) < 0)
			break;

		p += scnprintf(p, sizeof(read_buf) + read_buf - p,
			       "p%d: %s en:%.2x role:%.2x pol:%.2x\n", i,
			       resp->state, resp->enabled, resp->role,
			       resp->polarity);
	}

	return simple_read_from_buffer(user_buf, count, ppos,
				       read_buf, p - read_buf);
}

static ssize_t cros_ec_uptime_read(struct file *file, char __user *user_buf,
				   size_t count, loff_t *ppos)
{
	struct cros_ec_debugfs *debug_info = file->private_data;
	struct cros_ec_device *ec_dev = debug_info->ec->ec_dev;
	struct {
		struct cros_ec_command cmd;
		struct ec_response_uptime_info resp;
	} __packed msg = {};
	struct ec_response_uptime_info *resp;
	char read_buf[32];
	int ret;

	resp = (struct ec_response_uptime_info *)&msg.resp;

	msg.cmd.command = EC_CMD_GET_UPTIME_INFO;
	msg.cmd.insize = sizeof(*resp);

	ret = cros_ec_cmd_xfer_status(ec_dev, &msg.cmd);
	if (ret < 0)
		return ret;

	ret = scnprintf(read_buf, sizeof(read_buf), "%u\n",
			resp->time_since_ec_boot_ms);

	return simple_read_from_buffer(user_buf, count, ppos, read_buf, ret);
}

static const struct file_operations cros_ec_console_log_fops = {
	.owner = THIS_MODULE,
	.open = cros_ec_console_log_open,
	.read = cros_ec_console_log_read,
	.llseek = no_llseek,
	.poll = cros_ec_console_log_poll,
	.release = cros_ec_console_log_release,
};

static const struct file_operations cros_ec_pdinfo_fops = {
	.owner = THIS_MODULE,
	.open = simple_open,
	.read = cros_ec_pdinfo_read,
	.llseek = default_llseek,
};

static const struct file_operations cros_ec_uptime_fops = {
	.owner = THIS_MODULE,
	.open = simple_open,
	.read = cros_ec_uptime_read,
	.llseek = default_llseek,
};

static int ec_read_version_supported(struct cros_ec_dev *ec)
{
	struct ec_params_get_cmd_versions_v1 *params;
	struct ec_response_get_cmd_versions *response;
	int ret;

	struct cros_ec_command *msg;

	msg = kzalloc(sizeof(*msg) + max(sizeof(*params), sizeof(*response)),
		GFP_KERNEL);
	if (!msg)
		return 0;

	msg->command = EC_CMD_GET_CMD_VERSIONS + ec->cmd_offset;
	msg->outsize = sizeof(*params);
	msg->insize = sizeof(*response);

	params = (struct ec_params_get_cmd_versions_v1 *)msg->data;
	params->cmd = EC_CMD_CONSOLE_READ;
	response = (struct ec_response_get_cmd_versions *)msg->data;

	ret = cros_ec_cmd_xfer_status(ec->ec_dev, msg) >= 0 &&
	      response->version_mask & EC_VER_MASK(1);

	kfree(msg);

	return ret;
}

static int cros_ec_create_console_log(struct cros_ec_debugfs *debug_info)
{
	struct cros_ec_dev *ec = debug_info->ec;
	char *buf;
	int read_params_size;
	int read_response_size;

	/*
	 * If the console log feature is not supported return silently and
	 * don't create the console_log entry.
	 */
	if (!ec_read_version_supported(ec))
		return 0;

	buf = devm_kzalloc(ec->dev, LOG_SIZE, GFP_KERNEL);
	if (!buf)
		return -ENOMEM;

	read_params_size = sizeof(struct ec_params_console_read_v1);
	read_response_size = ec->ec_dev->max_response;
	debug_info->read_msg = devm_kzalloc(ec->dev,
		sizeof(*debug_info->read_msg) +
			max(read_params_size, read_response_size), GFP_KERNEL);
	if (!debug_info->read_msg)
		return -ENOMEM;

	debug_info->read_msg->version = 1;
	debug_info->read_msg->command = EC_CMD_CONSOLE_READ + ec->cmd_offset;
	debug_info->read_msg->outsize = read_params_size;
	debug_info->read_msg->insize = read_response_size;

	debug_info->log_buffer.buf = buf;
	debug_info->log_buffer.head = 0;
	debug_info->log_buffer.tail = 0;

	mutex_init(&debug_info->log_mutex);
	init_waitqueue_head(&debug_info->log_wq);

	debugfs_create_file("console_log", S_IFREG | 0444, debug_info->dir,
			    debug_info, &cros_ec_console_log_fops);

	INIT_DELAYED_WORK(&debug_info->log_poll_work,
			  cros_ec_console_log_work);
	schedule_delayed_work(&debug_info->log_poll_work, 0);

	return 0;
}

static void cros_ec_cleanup_console_log(struct cros_ec_debugfs *debug_info)
{
	if (debug_info->log_buffer.buf) {
		cancel_delayed_work_sync(&debug_info->log_poll_work);
		mutex_destroy(&debug_info->log_mutex);
	}
}

static int cros_ec_create_panicinfo(struct cros_ec_debugfs *debug_info)
{
	struct cros_ec_device *ec_dev = debug_info->ec->ec_dev;
	int ret;
	struct cros_ec_command *msg;
	int insize;

	insize = ec_dev->max_response;

	msg = devm_kzalloc(debug_info->ec->dev,
			sizeof(*msg) + insize, GFP_KERNEL);
	if (!msg)
		return -ENOMEM;

	msg->command = EC_CMD_GET_PANIC_INFO;
	msg->insize = insize;

	ret = cros_ec_cmd_xfer_status(ec_dev, msg);
	if (ret < 0) {
		ret = 0;
		goto free;
	}

	/* No panic data */
	if (ret == 0)
		goto free;

	debug_info->panicinfo_blob.data = msg->data;
	debug_info->panicinfo_blob.size = ret;

	debugfs_create_blob("panicinfo", S_IFREG | 0444, debug_info->dir,
			    &debug_info->panicinfo_blob);

	return 0;

free:
	devm_kfree(debug_info->ec->dev, msg);
	return ret;
}

static int cros_ec_debugfs_probe(struct platform_device *pd)
{
	struct cros_ec_dev *ec = dev_get_drvdata(pd->dev.parent);
	struct cros_ec_platform *ec_platform = dev_get_platdata(ec->dev);
	const char *name = ec_platform->ec_name;
	struct cros_ec_debugfs *debug_info;
	int ret;

	debug_info = devm_kzalloc(ec->dev, sizeof(*debug_info), GFP_KERNEL);
	if (!debug_info)
		return -ENOMEM;

	debug_info->ec = ec;
	debug_info->dir = debugfs_create_dir(name, NULL);

	ret = cros_ec_create_panicinfo(debug_info);
	if (ret)
		goto remove_debugfs;

	ret = cros_ec_create_console_log(debug_info);
	if (ret)
		goto remove_debugfs;

	debugfs_create_file("pdinfo", 0444, debug_info->dir, debug_info,
			    &cros_ec_pdinfo_fops);

	debugfs_create_file("uptime", 0444, debug_info->dir, debug_info,
			    &cros_ec_uptime_fops);

	ec->debug_info = debug_info;

	dev_set_drvdata(&pd->dev, ec);

	return 0;

remove_debugfs:
	debugfs_remove_recursive(debug_info->dir);
	return ret;
}

static int cros_ec_debugfs_remove(struct platform_device *pd)
{
	struct cros_ec_dev *ec = dev_get_drvdata(pd->dev.parent);

	debugfs_remove_recursive(ec->debug_info->dir);
	cros_ec_cleanup_console_log(ec->debug_info);

	return 0;
}

static int __maybe_unused cros_ec_debugfs_suspend(struct device *dev)
{
	struct cros_ec_dev *ec = dev_get_drvdata(dev);

	if (ec->debug_info->log_buffer.buf)
		cancel_delayed_work_sync(&ec->debug_info->log_poll_work);

	return 0;
}

static int __maybe_unused cros_ec_debugfs_resume(struct device *dev)
{
	struct cros_ec_dev *ec = dev_get_drvdata(dev);

	if (ec->debug_info->log_buffer.buf)
		schedule_delayed_work(&ec->debug_info->log_poll_work, 0);

	return 0;
}

static SIMPLE_DEV_PM_OPS(cros_ec_debugfs_pm_ops,
			 cros_ec_debugfs_suspend, cros_ec_debugfs_resume);

static struct platform_driver cros_ec_debugfs_driver = {
	.driver = {
		.name = DRV_NAME,
		.pm = &cros_ec_debugfs_pm_ops,
	},
	.probe = cros_ec_debugfs_probe,
	.remove = cros_ec_debugfs_remove,
};

module_platform_driver(cros_ec_debugfs_driver);

MODULE_LICENSE("GPL");
MODULE_DESCRIPTION("Debug logs for ChromeOS EC");
MODULE_ALIAS("platform:" DRV_NAME);
Commit	Line	Data
cc2db075 EBS	1	// SPDX-License-Identifier: GPL-2.0+
	2	// Debug logs for the ChromeOS EC
	3	//
	4	// Copyright (C) 2015 Google, Inc.
e8626459 EC	5
	6	#include <linux/circ_buf.h>
	7	#include <linux/debugfs.h>
	8	#include <linux/delay.h>
	9	#include <linux/fs.h>
	10	#include <linux/mfd/cros_ec.h>
	11	#include <linux/mfd/cros_ec_commands.h>
6fce0a2c	12	#include <linux/module.h>
e8626459	13	#include <linux/mutex.h>
6fce0a2c	14	#include <linux/platform_device.h>
e8626459 EC	15	#include <linux/poll.h>
	16	#include <linux/sched.h>
	17	#include <linux/slab.h>
	18	#include <linux/wait.h>
	19
6fce0a2c EBS	20	#define DRV_NAME "cros-ec-debugfs"
6fce0a2c EBS	21
e8626459 EC	22	#define LOG_SHIFT 14
	23	#define LOG_SIZE (1 << LOG_SHIFT)
	24	#define LOG_POLL_SEC 10
	25
	26	#define CIRC_ADD(idx, size, value) (((idx) + (value)) & ((size) - 1))
	27
cb78a163 EBS	28	/**
cb78a163 EBS	29	* struct cros_ec_debugfs - EC debugging information.
e8626459 EC	30	*
	31	* @ec: EC device this debugfs information belongs to
	32	* @dir: dentry for debugfs files
	33	* @log_buffer: circular buffer for console log information
	34	* @read_msg: preallocated EC command and buffer to read console log
	35	* @log_mutex: mutex to protect circular buffer
	36	* @log_wq: waitqueue for log readers
	37	* @log_poll_work: recurring task to poll EC for new console log data
6e494106	38	* @panicinfo_blob: panicinfo debugfs blob
e8626459 EC	39	*/
	40	struct cros_ec_debugfs {
	41	struct cros_ec_dev *ec;
	42	struct dentry *dir;
6e494106	43	/* EC log */
e8626459 EC	44	struct circ_buf log_buffer;
	45	struct cros_ec_command *read_msg;
	46	struct mutex log_mutex;
	47	wait_queue_head_t log_wq;
	48	struct delayed_work log_poll_work;
6e494106 NB	49	/* EC panicinfo */
6e494106 NB	50	struct debugfs_blob_wrapper panicinfo_blob;
e8626459 EC	51	};
	52
	53	/*
	54	* We need to make sure that the EC log buffer on the UART is large enough,
	55	* so that it is unlikely enough to overlow within LOG_POLL_SEC.
	56	*/
	57	static void cros_ec_console_log_work(struct work_struct *__work)
	58	{
	59	struct cros_ec_debugfs *debug_info =
	60	container_of(to_delayed_work(__work),
	61	struct cros_ec_debugfs,
	62	log_poll_work);
	63	struct cros_ec_dev *ec = debug_info->ec;
	64	struct circ_buf *cb = &debug_info->log_buffer;
	65	struct cros_ec_command snapshot_msg = {
	66	.command = EC_CMD_CONSOLE_SNAPSHOT + ec->cmd_offset,
	67	};
	68
	69	struct ec_params_console_read_v1 *read_params =
	70	(struct ec_params_console_read_v1 *)debug_info->read_msg->data;
	71	uint8_t ec_buffer = (uint8_t )debug_info->read_msg->data;
	72	int idx;
	73	int buf_space;
	74	int ret;
	75
81f6ec23 EBS	76	ret = cros_ec_cmd_xfer_status(ec->ec_dev, &snapshot_msg);
81f6ec23 EBS	77	if (ret < 0)
e8626459	78	goto resched;
e8626459 EC	79
	80	/* Loop until we have read everything, or there's an error. */
	81	mutex_lock(&debug_info->log_mutex);
	82	buf_space = CIRC_SPACE(cb->head, cb->tail, LOG_SIZE);
	83
	84	while (1) {
	85	if (!buf_space) {
	86	dev_info_once(ec->dev,
	87	"Some logs may have been dropped...\n");
	88	break;
	89	}
	90
	91	memset(read_params, '\0', sizeof(*read_params));
	92	read_params->subcmd = CONSOLE_READ_RECENT;
81f6ec23 EBS	93	ret = cros_ec_cmd_xfer_status(ec->ec_dev,
	94	debug_info->read_msg);
	95	if (ret < 0)
e8626459	96	break;
e8626459 EC	97
	98	/* If the buffer is empty, we're done here. */
	99	if (ret == 0 \|\| ec_buffer[0] == '\0')
	100	break;
	101
	102	idx = 0;
	103	while (idx < ret && ec_buffer[idx] != '\0' && buf_space > 0) {
	104	cb->buf[cb->head] = ec_buffer[idx];
	105	cb->head = CIRC_ADD(cb->head, LOG_SIZE, 1);
	106	idx++;
	107	buf_space--;
	108	}
	109
	110	wake_up(&debug_info->log_wq);
	111	}
	112
	113	mutex_unlock(&debug_info->log_mutex);
	114
	115	resched:
	116	schedule_delayed_work(&debug_info->log_poll_work,
	117	msecs_to_jiffies(LOG_POLL_SEC * 1000));
	118	}
	119
	120	static int cros_ec_console_log_open(struct inode inode, struct file file)
	121	{
	122	file->private_data = inode->i_private;
	123
c5bf68fe	124	return stream_open(inode, file);
e8626459 EC	125	}
	126
	127	static ssize_t cros_ec_console_log_read(struct file file, char __user buf,
	128	size_t count, loff_t *ppos)
	129	{
	130	struct cros_ec_debugfs *debug_info = file->private_data;
	131	struct circ_buf *cb = &debug_info->log_buffer;
	132	ssize_t ret;
	133
	134	mutex_lock(&debug_info->log_mutex);
	135
	136	while (!CIRC_CNT(cb->head, cb->tail, LOG_SIZE)) {
	137	if (file->f_flags & O_NONBLOCK) {
	138	ret = -EAGAIN;
	139	goto error;
	140	}
	141
	142	mutex_unlock(&debug_info->log_mutex);
	143
	144	ret = wait_event_interruptible(debug_info->log_wq,
	145	CIRC_CNT(cb->head, cb->tail, LOG_SIZE));
	146	if (ret < 0)
	147	return ret;
	148
	149	mutex_lock(&debug_info->log_mutex);
	150	}
	151
	152	/* Only copy until the end of the circular buffer, and let userspace
	153	* retry to get the rest of the data.
	154	*/
	155	ret = min_t(size_t, CIRC_CNT_TO_END(cb->head, cb->tail, LOG_SIZE),
	156	count);
	157
	158	if (copy_to_user(buf, cb->buf + cb->tail, ret)) {
	159	ret = -EFAULT;
	160	goto error;
	161	}
	162
	163	cb->tail = CIRC_ADD(cb->tail, LOG_SIZE, ret);
	164
	165	error:
	166	mutex_unlock(&debug_info->log_mutex);
	167	return ret;
	168	}
	169
afc9a42b	170	static __poll_t cros_ec_console_log_poll(struct file *file,
e8626459 EC	171	poll_table *wait)
	172	{
	173	struct cros_ec_debugfs *debug_info = file->private_data;
afc9a42b	174	__poll_t mask = 0;
e8626459 EC	175
	176	poll_wait(file, &debug_info->log_wq, wait);
	177
	178	mutex_lock(&debug_info->log_mutex);
	179	if (CIRC_CNT(debug_info->log_buffer.head,
	180	debug_info->log_buffer.tail,
	181	LOG_SIZE))
a9a08845	182	mask \|= EPOLLIN \| EPOLLRDNORM;
e8626459 EC	183	mutex_unlock(&debug_info->log_mutex);
	184
	185	return mask;
	186	}
	187
	188	static int cros_ec_console_log_release(struct inode inode, struct file file)
	189	{
	190	return 0;
	191	}
	192
b082b2e1 SN	193	static ssize_t cros_ec_pdinfo_read(struct file *file,
	194	char __user *user_buf,
	195	size_t count,
	196	loff_t *ppos)
	197	{
	198	char read_buf[EC_USB_PD_MAX_PORTS * 40], *p = read_buf;
	199	struct cros_ec_debugfs *debug_info = file->private_data;
	200	struct cros_ec_device *ec_dev = debug_info->ec->ec_dev;
	201	struct {
	202	struct cros_ec_command msg;
	203	union {
	204	struct ec_response_usb_pd_control_v1 resp;
	205	struct ec_params_usb_pd_control params;
	206	};
	207	} __packed ec_buf;
	208	struct cros_ec_command *msg;
	209	struct ec_response_usb_pd_control_v1 *resp;
	210	struct ec_params_usb_pd_control *params;
	211	int i;
	212
	213	msg = &ec_buf.msg;
	214	params = (struct ec_params_usb_pd_control *)msg->data;
	215	resp = (struct ec_response_usb_pd_control_v1 *)msg->data;
	216
	217	msg->command = EC_CMD_USB_PD_CONTROL;
	218	msg->version = 1;
	219	msg->insize = sizeof(*resp);
	220	msg->outsize = sizeof(*params);
	221
	222	/*
	223	* Read status from all PD ports until failure, typically caused
	224	* by attempting to read status on a port that doesn't exist.
	225	*/
	226	for (i = 0; i < EC_USB_PD_MAX_PORTS; ++i) {
	227	params->port = i;
	228	params->role = 0;
	229	params->mux = 0;
	230	params->swap = 0;
	231
	232	if (cros_ec_cmd_xfer_status(ec_dev, msg) < 0)
	233	break;
	234
	235	p += scnprintf(p, sizeof(read_buf) + read_buf - p,
	236	"p%d: %s en:%.2x role:%.2x pol:%.2x\n", i,
	237	resp->state, resp->enabled, resp->role,
	238	resp->polarity);
	239	}
	240
	241	return simple_read_from_buffer(user_buf, count, ppos,
	242	read_buf, p - read_buf);
	243	}
	244
e90716a6 TW	245	static ssize_t cros_ec_uptime_read(struct file file, char __user user_buf,
	246	size_t count, loff_t *ppos)
	247	{
	248	struct cros_ec_debugfs *debug_info = file->private_data;
	249	struct cros_ec_device *ec_dev = debug_info->ec->ec_dev;
	250	struct {
	251	struct cros_ec_command cmd;
	252	struct ec_response_uptime_info resp;
	253	} __packed msg = {};
	254	struct ec_response_uptime_info *resp;
	255	char read_buf[32];
	256	int ret;
	257
	258	resp = (struct ec_response_uptime_info *)&msg.resp;
	259
	260	msg.cmd.command = EC_CMD_GET_UPTIME_INFO;
	261	msg.cmd.insize = sizeof(*resp);
	262
	263	ret = cros_ec_cmd_xfer_status(ec_dev, &msg.cmd);
	264	if (ret < 0)
	265	return ret;
	266
	267	ret = scnprintf(read_buf, sizeof(read_buf), "%u\n",
	268	resp->time_since_ec_boot_ms);
	269
	270	return simple_read_from_buffer(user_buf, count, ppos, read_buf, ret);
	271	}
	272
81bc8c03	273	static const struct file_operations cros_ec_console_log_fops = {
e8626459 EC	274	.owner = THIS_MODULE,
	275	.open = cros_ec_console_log_open,
	276	.read = cros_ec_console_log_read,
	277	.llseek = no_llseek,
	278	.poll = cros_ec_console_log_poll,
	279	.release = cros_ec_console_log_release,
	280	};
	281
81bc8c03	282	static const struct file_operations cros_ec_pdinfo_fops = {
b082b2e1 SN	283	.owner = THIS_MODULE,
	284	.open = simple_open,
	285	.read = cros_ec_pdinfo_read,
	286	.llseek = default_llseek,
	287	};
	288
35b52b33	289	static const struct file_operations cros_ec_uptime_fops = {
e90716a6 TW	290	.owner = THIS_MODULE,
	291	.open = simple_open,
	292	.read = cros_ec_uptime_read,
	293	.llseek = default_llseek,
	294	};
	295
e8626459 EC	296	static int ec_read_version_supported(struct cros_ec_dev *ec)
	297	{
	298	struct ec_params_get_cmd_versions_v1 *params;
	299	struct ec_response_get_cmd_versions *response;
	300	int ret;
	301
	302	struct cros_ec_command *msg;
	303
73b44f40	304	msg = kzalloc(sizeof(msg) + max(sizeof(params), sizeof(*response)),
e8626459 EC	305	GFP_KERNEL);
	306	if (!msg)
	307	return 0;
	308
	309	msg->command = EC_CMD_GET_CMD_VERSIONS + ec->cmd_offset;
73b44f40 SN	310	msg->outsize = sizeof(*params);
73b44f40 SN	311	msg->insize = sizeof(*response);
e8626459 EC	312
	313	params = (struct ec_params_get_cmd_versions_v1 *)msg->data;
	314	params->cmd = EC_CMD_CONSOLE_READ;
	315	response = (struct ec_response_get_cmd_versions *)msg->data;
	316
81f6ec23 EBS	317	ret = cros_ec_cmd_xfer_status(ec->ec_dev, msg) >= 0 &&
81f6ec23 EBS	318	response->version_mask & EC_VER_MASK(1);
e8626459 EC	319
	320	kfree(msg);
	321
	322	return ret;
	323	}
	324
	325	static int cros_ec_create_console_log(struct cros_ec_debugfs *debug_info)
	326	{
	327	struct cros_ec_dev *ec = debug_info->ec;
	328	char *buf;
	329	int read_params_size;
	330	int read_response_size;
	331
e43c426a EBS	332	/*
	333	* If the console log feature is not supported return silently and
	334	* don't create the console_log entry.
	335	*/
	336	if (!ec_read_version_supported(ec))
e8626459	337	return 0;
e8626459 EC	338
	339	buf = devm_kzalloc(ec->dev, LOG_SIZE, GFP_KERNEL);
	340	if (!buf)
	341	return -ENOMEM;
	342
	343	read_params_size = sizeof(struct ec_params_console_read_v1);
	344	read_response_size = ec->ec_dev->max_response;
	345	debug_info->read_msg = devm_kzalloc(ec->dev,
	346	sizeof(*debug_info->read_msg) +
	347	max(read_params_size, read_response_size), GFP_KERNEL);
	348	if (!debug_info->read_msg)
	349	return -ENOMEM;
	350
	351	debug_info->read_msg->version = 1;
	352	debug_info->read_msg->command = EC_CMD_CONSOLE_READ + ec->cmd_offset;
	353	debug_info->read_msg->outsize = read_params_size;
	354	debug_info->read_msg->insize = read_response_size;
	355
	356	debug_info->log_buffer.buf = buf;
	357	debug_info->log_buffer.head = 0;
	358	debug_info->log_buffer.tail = 0;
	359
	360	mutex_init(&debug_info->log_mutex);
	361	init_waitqueue_head(&debug_info->log_wq);
	362
b18e606f EBS	363	debugfs_create_file("console_log", S_IFREG \| 0444, debug_info->dir,
b18e606f EBS	364	debug_info, &cros_ec_console_log_fops);
e8626459 EC	365
	366	INIT_DELAYED_WORK(&debug_info->log_poll_work,
	367	cros_ec_console_log_work);
	368	schedule_delayed_work(&debug_info->log_poll_work, 0);
	369
	370	return 0;
	371	}
	372
	373	static void cros_ec_cleanup_console_log(struct cros_ec_debugfs *debug_info)
	374	{
	375	if (debug_info->log_buffer.buf) {
	376	cancel_delayed_work_sync(&debug_info->log_poll_work);
	377	mutex_destroy(&debug_info->log_mutex);
	378	}
	379	}
	380
6e494106 NB	381	static int cros_ec_create_panicinfo(struct cros_ec_debugfs *debug_info)
	382	{
	383	struct cros_ec_device *ec_dev = debug_info->ec->ec_dev;
	384	int ret;
	385	struct cros_ec_command *msg;
	386	int insize;
	387
	388	insize = ec_dev->max_response;
	389
	390	msg = devm_kzalloc(debug_info->ec->dev,
	391	sizeof(*msg) + insize, GFP_KERNEL);
	392	if (!msg)
	393	return -ENOMEM;
	394
	395	msg->command = EC_CMD_GET_PANIC_INFO;
	396	msg->insize = insize;
	397
81f6ec23	398	ret = cros_ec_cmd_xfer_status(ec_dev, msg);
6e494106	399	if (ret < 0) {
6e494106 NB	400	ret = 0;
	401	goto free;
	402	}
	403
	404	/* No panic data */
	405	if (ret == 0)
	406	goto free;
	407
	408	debug_info->panicinfo_blob.data = msg->data;
	409	debug_info->panicinfo_blob.size = ret;
	410
b18e606f EBS	411	debugfs_create_blob("panicinfo", S_IFREG \| 0444, debug_info->dir,
b18e606f EBS	412	&debug_info->panicinfo_blob);
6e494106 NB	413
	414	return 0;
	415
	416	free:
	417	devm_kfree(debug_info->ec->dev, msg);
	418	return ret;
	419	}
	420
6fce0a2c	421	static int cros_ec_debugfs_probe(struct platform_device *pd)
e8626459	422	{
6fce0a2c	423	struct cros_ec_dev *ec = dev_get_drvdata(pd->dev.parent);
e8626459 EC	424	struct cros_ec_platform *ec_platform = dev_get_platdata(ec->dev);
	425	const char *name = ec_platform->ec_name;
	426	struct cros_ec_debugfs *debug_info;
	427	int ret;
	428
	429	debug_info = devm_kzalloc(ec->dev, sizeof(*debug_info), GFP_KERNEL);
	430	if (!debug_info)
	431	return -ENOMEM;
	432
	433	debug_info->ec = ec;
	434	debug_info->dir = debugfs_create_dir(name, NULL);
e8626459	435
6e494106 NB	436	ret = cros_ec_create_panicinfo(debug_info);
	437	if (ret)
	438	goto remove_debugfs;
	439
e8626459 EC	440	ret = cros_ec_create_console_log(debug_info);
	441	if (ret)
	442	goto remove_debugfs;
	443
b18e606f EBS	444	debugfs_create_file("pdinfo", 0444, debug_info->dir, debug_info,
b18e606f EBS	445	&cros_ec_pdinfo_fops);
b082b2e1	446
e90716a6 TW	447	debugfs_create_file("uptime", 0444, debug_info->dir, debug_info,
	448	&cros_ec_uptime_fops);
	449
e8626459 EC	450	ec->debug_info = debug_info;
e8626459 EC	451
6fce0a2c EBS	452	dev_set_drvdata(&pd->dev, ec);
6fce0a2c EBS	453
e8626459 EC	454	return 0;
	455
	456	remove_debugfs:
	457	debugfs_remove_recursive(debug_info->dir);
	458	return ret;
	459	}
	460
6fce0a2c	461	static int cros_ec_debugfs_remove(struct platform_device *pd)
e8626459	462	{
6fce0a2c	463	struct cros_ec_dev *ec = dev_get_drvdata(pd->dev.parent);
e8626459 EC	464
	465	debugfs_remove_recursive(ec->debug_info->dir);
	466	cros_ec_cleanup_console_log(ec->debug_info);
6fce0a2c EBS	467
6fce0a2c EBS	468	return 0;
e8626459	469	}
44d99d73	470
6fce0a2c	471	static int __maybe_unused cros_ec_debugfs_suspend(struct device *dev)
44d99d73	472	{
6fce0a2c EBS	473	struct cros_ec_dev *ec = dev_get_drvdata(dev);
6fce0a2c EBS	474
57aeef7f GR	475	if (ec->debug_info->log_buffer.buf)
57aeef7f GR	476	cancel_delayed_work_sync(&ec->debug_info->log_poll_work);
6fce0a2c EBS	477
6fce0a2c EBS	478	return 0;
44d99d73	479	}
44d99d73	480
6fce0a2c	481	static int __maybe_unused cros_ec_debugfs_resume(struct device *dev)
44d99d73	482	{
6fce0a2c EBS	483	struct cros_ec_dev *ec = dev_get_drvdata(dev);
6fce0a2c EBS	484
57aeef7f GR	485	if (ec->debug_info->log_buffer.buf)
57aeef7f GR	486	schedule_delayed_work(&ec->debug_info->log_poll_work, 0);
6fce0a2c EBS	487
6fce0a2c EBS	488	return 0;
44d99d73	489	}
6fce0a2c EBS	490
	491	static SIMPLE_DEV_PM_OPS(cros_ec_debugfs_pm_ops,
	492	cros_ec_debugfs_suspend, cros_ec_debugfs_resume);
	493
	494	static struct platform_driver cros_ec_debugfs_driver = {
	495	.driver = {
	496	.name = DRV_NAME,
	497	.pm = &cros_ec_debugfs_pm_ops,
	498	},
	499	.probe = cros_ec_debugfs_probe,
	500	.remove = cros_ec_debugfs_remove,
	501	};
	502
	503	module_platform_driver(cros_ec_debugfs_driver);
	504
	505	MODULE_LICENSE("GPL");
	506	MODULE_DESCRIPTION("Debug logs for ChromeOS EC");
	507	MODULE_ALIAS("platform:" DRV_NAME);