Linux Input Archive on lore.kernel.org
 help / color / Atom feed
From: Jiada Wang <jiada_wang@mentor.com>
To: <nick@shmanahar.org>, <dmitry.torokhov@gmail.com>,
	<jikos@kernel.org>, <benjamin.tissoires@redhat.com>,
	<bsz@semihalf.com>, <rydberg@bitmath.org>
Cc: <linux-input@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
	<erosca@de.adit-jv.com>, <Andrew_Gabbasov@mentor.com>,
	<jiada_wang@mentor.com>
Subject: [PATCH v9 35/55] Input: atmel_mxt_ts - implement improved debug message interface
Date: Wed, 25 Mar 2020 06:33:14 -0700
Message-ID: <20200325133334.19346-36-jiada_wang@mentor.com> (raw)
In-Reply-To: <20200325133334.19346-1-jiada_wang@mentor.com>

From: Nick Dyer <nick.dyer@itdev.co.uk>

Implement improved debug message interface

Signed-off-by: Nick Dyer <nick.dyer@itdev.co.uk>
(cherry picked from ndyer/linux/for-upstream commit 078569c13c88dcb6f8d882bfe17168587712df7d)
[gdavis: Resolve forward port conflicts due to v4.14.51 commit
	 960fe000b1d3 ("Input: atmel_mxt_ts - fix the firmware
	 update").]
Signed-off-by: George G. Davis <george_davis@mentor.com>
[gdavis: Squash fixes from Dirk Behme:
	 - Input: atmel_mxt_ts - add missing unlock in error path
	 - Input: atmel_mxt_ts - add missing unlock in error path
	 - Input: atmel_mxt_ts - call mxt_debug_msg_remove() in error path
	 - Input: atmel_mxt_ts - protect debug_v2_enabled by mutex
Signed-off-by: Dirk Behme <dirk.behme@de.bosch.com>
[gdavis: Squash fix from Vladimir Zapolskiy:
	 - Input: atmel_mxt_ts - simplify debug_msg binary attribute
	   handling]
Signed-off-by: Vladimir Zapolskiy <vladimir_zapolskiy@mentor.com>
[jiada: Rename mxt_debug_notify_show to debug_notify_show
	Rename mxt_debug_v2_enable_store to debug_v2_enable_store
	Add debug_v2_enable_show
	Replace DEVICE_ATTR with DEVICE_ATTR_[RW|RO] ]
Signed-off-by: Jiada Wang <jiada_wang@mentor.com>
---
 drivers/input/touchscreen/atmel_mxt_ts.c | 203 ++++++++++++++++++++++-
 1 file changed, 201 insertions(+), 2 deletions(-)

diff --git a/drivers/input/touchscreen/atmel_mxt_ts.c b/drivers/input/touchscreen/atmel_mxt_ts.c
index 656d956f9c93..9476326596d9 100644
--- a/drivers/input/touchscreen/atmel_mxt_ts.c
+++ b/drivers/input/touchscreen/atmel_mxt_ts.c
@@ -242,6 +242,8 @@ enum t100_type {
 
 #define MXT_PIXELS_PER_MM	20
 
+#define DEBUG_MSG_MAX		200
+
 struct mxt_info {
 	u8 family_id;
 	u8 variant_id;
@@ -336,6 +338,11 @@ struct mxt_data {
 	u8 t100_aux_area;
 	u8 t100_aux_vect;
 	bool debug_enabled;
+	bool debug_v2_enabled;
+	u8 *debug_msg_data;
+	u16 debug_msg_count;
+	struct bin_attribute *debug_msg_attr;
+	struct mutex debug_msg_lock;
 	u8 max_reportid;
 	u32 config_crc;
 	u32 info_crc;
@@ -468,6 +475,144 @@ static void mxt_dump_message(struct mxt_data *data, u8 *message)
 		       data->T5_msg_size, message);
 }
 
+static void mxt_debug_msg_enable(struct mxt_data *data)
+{
+	struct device *dev = &data->client->dev;
+
+	if (data->debug_v2_enabled)
+		return;
+
+	mutex_lock(&data->debug_msg_lock);
+
+	data->debug_msg_data = kcalloc(DEBUG_MSG_MAX,
+				data->T5_msg_size, GFP_KERNEL);
+	if (!data->debug_msg_data) {
+		mutex_unlock(&data->debug_msg_lock);
+		return;
+	}
+
+	data->debug_v2_enabled = true;
+	mutex_unlock(&data->debug_msg_lock);
+
+	dev_dbg(dev, "Enabled message output\n");
+}
+
+static void mxt_debug_msg_disable(struct mxt_data *data)
+{
+	struct device *dev = &data->client->dev;
+
+	if (!data->debug_v2_enabled)
+		return;
+
+	mutex_lock(&data->debug_msg_lock);
+
+	data->debug_v2_enabled = false;
+
+	kfree(data->debug_msg_data);
+	data->debug_msg_data = NULL;
+	data->debug_msg_count = 0;
+	mutex_unlock(&data->debug_msg_lock);
+	dev_dbg(dev, "Disabled message output\n");
+}
+
+static void mxt_debug_msg_add(struct mxt_data *data, u8 *msg)
+{
+	struct device *dev = &data->client->dev;
+
+	mutex_lock(&data->debug_msg_lock);
+
+	if (!data->debug_msg_data) {
+		mutex_unlock(&data->debug_msg_lock);
+		dev_err(dev, "No buffer!\n");
+		return;
+	}
+
+	if (data->debug_msg_count < DEBUG_MSG_MAX) {
+		memcpy(data->debug_msg_data +
+		       data->debug_msg_count * data->T5_msg_size,
+		       msg,
+		       data->T5_msg_size);
+		data->debug_msg_count++;
+	} else {
+		dev_dbg(dev, "Discarding %u messages\n", data->debug_msg_count);
+		data->debug_msg_count = 0;
+	}
+
+	mutex_unlock(&data->debug_msg_lock);
+
+	sysfs_notify(&data->client->dev.kobj, NULL, "debug_notify");
+}
+
+static ssize_t mxt_debug_msg_read(struct file *filp, struct kobject *kobj,
+	struct bin_attribute *bin_attr, char *buf, loff_t off, size_t bytes)
+{
+	struct device *dev = container_of(kobj, struct device, kobj);
+	struct mxt_data *data = dev_get_drvdata(dev);
+	int count;
+	size_t bytes_read;
+
+	if (!data->debug_msg_data) {
+		dev_err(dev, "No buffer!\n");
+		return 0;
+	}
+
+	count = bytes / data->T5_msg_size;
+
+	if (count > DEBUG_MSG_MAX)
+		count = DEBUG_MSG_MAX;
+
+	mutex_lock(&data->debug_msg_lock);
+
+	if (count > data->debug_msg_count)
+		count = data->debug_msg_count;
+
+	bytes_read = count * data->T5_msg_size;
+
+	memcpy(buf, data->debug_msg_data, bytes_read);
+	data->debug_msg_count = 0;
+
+	mutex_unlock(&data->debug_msg_lock);
+
+	return bytes_read;
+}
+
+static struct bin_attribute debug_msg_attr = {
+	.attr = {
+		.name = "debug_msg",
+		.mode = 0444,
+	},
+	.read = mxt_debug_msg_read,
+};
+
+static int mxt_debug_msg_init(struct mxt_data *data)
+{
+	/*
+	 * Binary attribute is not used in callback, removal is done by name,
+	 * so it is safe to update a single struct bin_attribute entity
+	 */
+	debug_msg_attr.size = data->T5_msg_size * DEBUG_MSG_MAX;
+
+	if (sysfs_create_bin_file(&data->client->dev.kobj,
+				  &debug_msg_attr) < 0) {
+		dev_err(&data->client->dev, "Failed to create %s\n",
+			debug_msg_attr.attr.name);
+		return -EINVAL;
+	}
+
+	data->debug_msg_attr = &debug_msg_attr;
+
+	return 0;
+}
+
+static void mxt_debug_msg_remove(struct mxt_data *data)
+{
+	if (data->debug_msg_attr) {
+		sysfs_remove_bin_file(&data->client->dev.kobj,
+				      data->debug_msg_attr);
+		data->debug_msg_attr = NULL;
+	}
+}
+
 static int mxt_wait_for_completion(struct mxt_data *data,
 				   struct completion *comp,
 				   unsigned int timeout_ms)
@@ -1256,6 +1401,9 @@ static int mxt_proc_message(struct mxt_data *data, u8 *message)
 	if (dump)
 		mxt_dump_message(data, message);
 
+	if (data->debug_v2_enabled)
+		mxt_debug_msg_add(data, message);
+
 	return 1;
 }
 
@@ -2674,6 +2822,10 @@ static int mxt_initialize(struct mxt_data *data)
 	if (error)
 		return error;
 
+	error = mxt_debug_msg_init(data);
+	if (error)
+		goto err_free_sysfs;
+
 	if (data->cfg_name) {
 		error = request_firmware_nowait(THIS_MODULE, true,
 						data->cfg_name,
@@ -2683,16 +2835,18 @@ static int mxt_initialize(struct mxt_data *data)
 		if (error) {
 			dev_err(&client->dev, "Failed to invoke firmware loader: %d\n",
 				error);
-			goto err_free_sysfs;
+			goto err_free_dbg_msg;
 		}
 	} else {
 		error = mxt_configure_objects(data, NULL);
 		if (error)
-			goto err_free_sysfs;
+			goto err_free_dbg_msg;
 	}
 
 	return 0;
 
+err_free_dbg_msg:
+	mxt_debug_msg_remove(data);
 err_free_sysfs:
 	mxt_sysfs_remove(data);
 	return error;
@@ -3354,6 +3508,7 @@ static int mxt_enter_bootloader(struct mxt_data *data)
 			return ret;
 
 		data->in_bootloader = true;
+		mxt_debug_msg_remove(data);
 		mxt_sysfs_remove(data);
 		mxt_free_input_device(data);
 		mxt_free_object_table(data);
@@ -3527,6 +3682,44 @@ static ssize_t update_cfg_store(struct device *dev,
 	return ret;
 }
 
+static ssize_t debug_notify_show(struct device *dev,
+	struct device_attribute *attr, char *buf)
+{
+	return sprintf(buf, "0\n");
+}
+
+static ssize_t debug_v2_enable_store(struct device *dev,
+	struct device_attribute *attr, const char *buf, size_t count)
+{
+	struct mxt_data *data = dev_get_drvdata(dev);
+	u8 i;
+	ssize_t ret;
+
+	if (kstrtou8(buf, 0, &i) == 0 && i < 2) {
+		if (i == 1)
+			mxt_debug_msg_enable(data);
+		else
+			mxt_debug_msg_disable(data);
+
+		ret = count;
+	} else {
+		dev_dbg(dev, "debug_enabled write error\n");
+		ret = -EINVAL;
+	}
+
+	return ret;
+}
+
+static ssize_t debug_v2_enable_show(struct device *dev,
+	struct device_attribute *attr, char *buf)
+{
+	struct mxt_data *data = dev_get_drvdata(dev);
+	char c;
+
+	c = data->debug_v2_enabled ? '1' : '0';
+	return scnprintf(buf, PAGE_SIZE, "%c\n", c);
+}
+
 static ssize_t debug_enable_show(struct device *dev,
 	struct device_attribute *attr, char *buf)
 {
@@ -3574,6 +3767,8 @@ static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
 static DEVICE_ATTR_WO(update_cfg);
 static DEVICE_ATTR_RO(config_crc);
 static DEVICE_ATTR_RW(debug_enable);
+static DEVICE_ATTR_RW(debug_v2_enable);
+static DEVICE_ATTR_RO(debug_notify);
 
 static struct attribute *mxt_attrs[] = {
 	&dev_attr_fw_version.attr,
@@ -3582,6 +3777,8 @@ static struct attribute *mxt_attrs[] = {
 	&dev_attr_update_cfg.attr,
 	&dev_attr_config_crc.attr,
 	&dev_attr_debug_enable.attr,
+	&dev_attr_debug_v2_enable.attr,
+	&dev_attr_debug_notify.attr,
 	NULL
 };
 
@@ -3871,6 +4068,7 @@ static int mxt_probe(struct i2c_client *client, const struct i2c_device_id *id)
 	init_completion(&data->chg_completion);
 	init_completion(&data->reset_completion);
 	init_completion(&data->crc_completion);
+	mutex_init(&data->debug_msg_lock);
 
 	data->suspend_mode = dmi_check_system(chromebook_T9_suspend_dmi) ?
 		MXT_SUSPEND_T9_CTRL : MXT_SUSPEND_DEEP_SLEEP;
@@ -3929,6 +4127,7 @@ static int mxt_remove(struct i2c_client *client)
 
 	disable_irq(data->irq);
 	sysfs_remove_group(&client->dev.kobj, &mxt_fw_attr_group);
+	mxt_debug_msg_remove(data);
 	mxt_sysfs_remove(data);
 	mxt_free_input_device(data);
 	mxt_free_object_table(data);
-- 
2.17.1


  parent reply index

Thread overview: 65+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-25 13:32 [PATCH v9 00/55] atmel_mxt_ts misc Jiada Wang
2020-03-25 13:32 ` [PATCH v9 01/55] Input: introduce input_mt_report_slot_inactive Jiada Wang
2020-03-25 13:32 ` [PATCH v9 02/55] Input: atmel_mxt_ts - rework sysfs init/remove Jiada Wang
2020-03-25 13:32 ` [PATCH v9 03/55] Input: atmel_mxt_ts - only read messages in mxt_acquire_irq() when necessary Jiada Wang
2020-03-25 13:32 ` [PATCH v9 04/55] Input: atmel_mxt_ts - split large i2c transfers into blocks Jiada Wang
2020-03-25 13:32 ` [PATCH v9 05/55] Input: atmel_mxt_ts - output status from T48 Noise Supression Jiada Wang
2020-03-25 13:32 ` [PATCH v9 06/55] Input: atmel_mxt_ts - output status from T42 Touch Suppression Jiada Wang
2020-03-25 13:32 ` [PATCH v9 07/55] Input: atmel_mxt_ts - implement T9 vector/orientation support Jiada Wang
2020-03-25 13:32 ` [PATCH v9 08/55] Input: atmel_mxt_ts - implement T15 Key Array support Jiada Wang
2020-03-25 13:32 ` [PATCH v9 09/55] Input: atmel_mxt_ts - handle reports from T47 Stylus object Jiada Wang
2020-03-25 13:32 ` [PATCH v9 10/55] Input: atmel_mxt_ts - implement support for T107 active stylus Jiada Wang
2020-03-25 13:32 ` [PATCH v9 11/55] Input: atmel_mxt_ts - add debug for T92 gesture and T93 touch seq msgs Jiada Wang
2020-03-25 13:32 ` [PATCH v9 12/55] Input: atmel_mxt_ts - release touch state during suspend Jiada Wang
2020-03-25 13:32 ` [PATCH v9 13/55] Input: atmel_mxt_ts - add regulator control support Jiada Wang
2020-03-25 19:05   ` Dmitry Osipenko
2020-03-27 11:09     ` Wang, Jiada
2020-03-29 18:54       ` Dmitry Osipenko
2020-03-30  4:10         ` Wang, Jiada
2020-03-25 13:32 ` [PATCH v9 14/55] dt-bindings: input: atmel: add suspend mode support Jiada Wang
2020-03-25 13:32 ` [PATCH v9 15/55] Input: atmel_mxt_ts - report failures in suspend/resume Jiada Wang
2020-03-25 13:32 ` [PATCH v9 16/55] Input: atmel_mxt_ts - allow specification of firmware file name Jiada Wang
2020-03-25 13:32 ` [PATCH v9 17/55] Input: atmel_mxt_ts: Rename mxt_fw_version_show to fw_version_show Jiada Wang
2020-03-25 13:32 ` [PATCH v9 18/55] Input: atmel_mxt_ts: Rename mxt_hw_version_show to hw_version_show Jiada Wang
2020-03-25 13:32 ` [PATCH v9 19/55] Input: atmel_mxt_ts: rename mxt_update_fw_store to update_fw_store Jiada Wang
2020-03-25 13:32 ` [PATCH v9 20/55] Input: atmel_mxt_ts - handle cfg filename via pdata/sysfs Jiada Wang
2020-03-25 13:33 ` [PATCH v9 21/55] dt-bindings: input: atmel: provide name of configuration file Jiada Wang
2020-03-25 13:33 ` [PATCH v9 22/55] Input: atmel_mxt_ts - allow input name to be specified in platform data Jiada Wang
2020-03-25 13:33 ` [PATCH v9 23/55] dt-bindings: input: atmel: support to specify input name Jiada Wang
2020-03-25 13:33 ` [PATCH v9 24/55] Input: atmel_mxt_ts - add config checksum attribute to sysfs Jiada Wang
2020-03-25 13:33 ` [PATCH v9 25/55] Input: atmel_mxt_ts - refactor firmware flash to extract context into struct Jiada Wang
2020-03-25 13:33 ` [PATCH v9 26/55] Input: atmel_mxt_ts - refactor code to enter bootloader into separate func Jiada Wang
2020-03-25 13:33 ` [PATCH v9 27/55] Input: atmel_mxt_ts - combine bootloader version query with probe Jiada Wang
2020-03-25 13:33 ` [PATCH v9 28/55] Input: atmel_mxt_ts - improve bootloader state machine handling Jiada Wang
2020-03-25 13:33 ` [PATCH v9 29/55] Input: atmel_mxt_ts - rename bl_completion to chg_completion Jiada Wang
2020-03-25 13:33 ` [PATCH v9 30/55] Input: atmel_mxt_ts - make bootloader interrupt driven Jiada Wang
2020-03-25 13:33 ` [PATCH v9 31/55] Input: atmel_mxt_ts - delay enabling IRQ when not using regulators Jiada Wang
2020-03-25 13:33 ` [PATCH v9 32/55] Input: atmel_mxt_ts - implement I2C retries Jiada Wang
2020-03-25 13:33 ` [PATCH v9 33/55] Input: atmel_mxt_ts - orientation is not present in hover Jiada Wang
2020-03-25 13:33 ` [PATCH v9 34/55] Input: atmel_mxt_ts - implement debug output for messages Jiada Wang
2020-03-25 13:33 ` Jiada Wang [this message]
2020-03-25 13:33 ` [PATCH v9 36/55] Input: atmel_mxt_ts - eliminate data->raw_info_block Jiada Wang
2020-03-25 13:33 ` [PATCH v9 37/55] Input: atmel_mxt_ts - Change call-points of mxt_free_* functions Jiada Wang
2020-03-25 13:33 ` [PATCH v9 38/55] Input: atmel_mxt_ts - rely on calculated_crc rather than file config_crc Jiada Wang
2020-03-25 13:33 ` [PATCH v9 39/55] input: atmel_mxt_ts: export GPIO reset line via sysfs Jiada Wang
2020-03-25 13:33 ` [PATCH v9 40/55] input: atmel_mxt_ts: Add Missing Delay for reset handling of Atmel touch panel controller in detachable displays Jiada Wang
2020-03-25 13:33 ` [PATCH v9 41/55] Input: atmel_mxt_ts: Add support for run self-test routine Jiada Wang
2020-03-25 13:33 ` [PATCH v9 42/55] Input: atmel_mxt_ts: Limit the max bytes transferred in an i2c transaction Jiada Wang
2020-03-25 13:33 ` [PATCH v9 43/55] dt-bindings: input: atmel: support to set max bytes transferred Jiada Wang
2020-03-25 13:33 ` [PATCH v9 44/55] Input: atmel_mxt_ts: return error from mxt_process_messages_until_invalid() Jiada Wang
2020-03-25 13:33 ` [PATCH v9 45/55] Input: Atmel: improve error handling in mxt_start() Jiada Wang
2020-03-25 13:33 ` [PATCH v9 46/55] Input: Atmel: improve error handling in mxt_initialize() Jiada Wang
2020-03-25 13:33 ` [PATCH v9 47/55] Input: Atmel: improve error handling in mxt_update_cfg() Jiada Wang
2020-03-25 13:33 ` [PATCH v9 48/55] Input: Atmel: Improve error handling in mxt_initialize_input_device() Jiada Wang
2020-03-25 13:33 ` [PATCH v9 49/55] Input: Atmel: handle ReportID "0x00" while processing T5 messages Jiada Wang
2020-03-25 13:33 ` [PATCH v9 50/55] Input: Atmel: use T44 object to process " Jiada Wang
2020-03-25 13:33 ` [PATCH v9 51/55] Input: atmel_mxt_ts: use gpiod_set_value_cansleep for reset pin Jiada Wang
2020-03-25 13:33 ` [PATCH v9 52/55] input: touchscreen: atmel_mxt_ts: Added sysfs entry for touchscreen status Jiada Wang
2020-03-25 19:35   ` Dmitry Osipenko
2020-03-25 19:41     ` Dmitry Osipenko
2020-03-27 12:49     ` Wang, Jiada
2020-03-27 13:37       ` Dmitry Osipenko
2020-03-27 13:43         ` Dmitry Osipenko
2020-03-25 13:33 ` [PATCH v9 53/55] input: atmel_mxt_ts: added sysfs interface to update atmel T38 data Jiada Wang
2020-03-25 13:33 ` [PATCH v9 54/55] Input: atmel_mxt_ts: Implement synchronization during various operation Jiada Wang
2020-03-25 13:33 ` [PATCH v9 55/55] Input: atmel_mxt_ts - Fix compilation warning Jiada Wang

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200325133334.19346-36-jiada_wang@mentor.com \
    --to=jiada_wang@mentor.com \
    --cc=Andrew_Gabbasov@mentor.com \
    --cc=benjamin.tissoires@redhat.com \
    --cc=bsz@semihalf.com \
    --cc=dmitry.torokhov@gmail.com \
    --cc=erosca@de.adit-jv.com \
    --cc=jikos@kernel.org \
    --cc=linux-input@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=nick@shmanahar.org \
    --cc=rydberg@bitmath.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Linux Input Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-input/0 linux-input/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-input linux-input/ https://lore.kernel.org/linux-input \
		linux-input@vger.kernel.org
	public-inbox-index linux-input

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-input


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git