From: Nick Dyer <nick.dyer@itdev.co.uk>
To: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: Daniel Kurtz <djkurtz@chromium.org>,
Henrik Rydberg <rydberg@euromail.se>,
Joonyoung Shim <jy0922.shim@samsung.com>,
Alan Bowens <Alan.Bowens@atmel.com>,
linux-input@vger.kernel.org, linux-kernel@vger.kernel.org,
Peter Meerwald <pmeerw@pmeerw.net>,
Benson Leung <bleung@chromium.org>,
Olof Johansson <olofj@chromium.org>,
Nick Dyer <nick.dyer@itdev.co.uk>
Subject: [PATCH 42/51] Input: atmel_mxt_ts - Verify Information Block checksum on probe
Date: Thu, 27 Jun 2013 13:49:17 +0100 [thread overview]
Message-ID: <1372337366-9286-43-git-send-email-nick.dyer@itdev.co.uk> (raw)
In-Reply-To: <1372337366-9286-1-git-send-email-nick.dyer@itdev.co.uk>
By reading the information block and the object table into a contiguous region
of memory, we can verify the checksum at probe time. This means we verify that
we are indeed talking to a chip that supports object protocol correctly. We
also detect I2C comms problems much earlier, resulting in easier diagnosis.
Signed-off-by: Nick Dyer <nick.dyer@itdev.co.uk>
Acked-by: Benson Leung <bleung@chromium.org>
---
drivers/input/touchscreen/atmel_mxt_ts.c | 182 ++++++++++++++++++------------
1 file changed, 112 insertions(+), 70 deletions(-)
diff --git a/drivers/input/touchscreen/atmel_mxt_ts.c b/drivers/input/touchscreen/atmel_mxt_ts.c
index c01a457..8827bbd 100644
--- a/drivers/input/touchscreen/atmel_mxt_ts.c
+++ b/drivers/input/touchscreen/atmel_mxt_ts.c
@@ -194,7 +194,8 @@ struct mxt_data {
char phys[64]; /* device physical location */
struct mxt_platform_data *pdata;
struct mxt_object *object_table;
- struct mxt_info info;
+ struct mxt_info *info;
+ void *raw_info_block;
unsigned int irq;
unsigned int max_x;
unsigned int max_y;
@@ -363,12 +364,16 @@ static int mxt_lookup_bootloader_address(struct mxt_data *data, bool retry)
{
u8 appmode = data->client->addr;
u8 bootloader;
+ u8 family_id = 0;
+
+ if (data->info)
+ family_id = data->info->family_id;
switch (appmode) {
case 0x4a:
case 0x4b:
/* Chips after 1664S use different scheme */
- if (retry || data->info.family_id >= 0xa2) {
+ if (retry || family_id >= 0xa2) {
bootloader = appmode - 0x24;
break;
}
@@ -608,7 +613,7 @@ mxt_get_object(struct mxt_data *data, u8 type)
struct mxt_object *object;
int i;
- for (i = 0; i < data->info.object_num; i++) {
+ for (i = 0; i < data->info->object_num; i++) {
object = data->object_table + i;
if (object->type == type)
return object;
@@ -1245,13 +1250,13 @@ static int mxt_check_reg_init(struct mxt_data *data)
data_pos += offset;
}
- if (cfg_info.family_id != data->info.family_id) {
+ if (cfg_info.family_id != data->info->family_id) {
dev_err(dev, "Family ID mismatch!\n");
ret = -EINVAL;
goto release;
}
- if (cfg_info.variant_id != data->info.variant_id) {
+ if (cfg_info.variant_id != data->info->variant_id) {
dev_err(dev, "Variant ID mismatch!\n");
ret = -EINVAL;
goto release;
@@ -1298,7 +1303,7 @@ static int mxt_check_reg_init(struct mxt_data *data)
/* Malloc memory to store configuration */
cfg_start_ofs = MXT_OBJECT_START
- + data->info.object_num * sizeof(struct mxt_object)
+ + data->info->object_num * sizeof(struct mxt_object)
+ MXT_INFO_CHECKSUM_SIZE;
config_mem_size = data->mem_size - cfg_start_ofs;
config_mem = kzalloc(config_mem_size, GFP_KERNEL);
@@ -1506,24 +1511,12 @@ static int mxt_acquire_irq(struct mxt_data *data)
return 0;
}
-static int mxt_get_info(struct mxt_data *data)
-{
- struct i2c_client *client = data->client;
- struct mxt_info *info = &data->info;
- int error;
-
- /* Read 7-byte info block starting at address 0 */
- error = __mxt_read_reg(client, 0, sizeof(*info), info);
- if (error)
- return error;
-
- return 0;
-}
-
static void mxt_free_object_table(struct mxt_data *data)
{
- kfree(data->object_table);
+ kfree(data->raw_info_block);
data->object_table = NULL;
+ data->info = NULL;
+ data->raw_info_block = NULL;
kfree(data->msg_buf);
data->msg_buf = NULL;
data->enable_reporting = false;
@@ -1545,25 +1538,17 @@ static void mxt_free_object_table(struct mxt_data *data)
data->max_reportid = 0;
}
-static int mxt_get_object_table(struct mxt_data *data)
+static int mxt_parse_object_table(struct mxt_data *data)
{
struct i2c_client *client = data->client;
- size_t table_size;
- int error;
int i;
u8 reportid;
u16 end_address;
- table_size = data->info.object_num * sizeof(struct mxt_object);
- error = __mxt_read_reg(client, MXT_OBJECT_START, table_size,
- data->object_table);
- if (error)
- return error;
-
/* Valid Report IDs start counting from 1 */
reportid = 1;
data->mem_size = 0;
- for (i = 0; i < data->info.object_num; i++) {
+ for (i = 0; i < data->info->object_num; i++) {
struct mxt_object *object = data->object_table + i;
u8 min_id, max_id;
@@ -1587,7 +1572,7 @@ static int mxt_get_object_table(struct mxt_data *data)
switch (object->type) {
case MXT_GEN_MESSAGE_T5:
- if (data->info.family_id == 0x80) {
+ if (data->info->family_id == 0x80) {
/* On mXT224 read and discard unused CRC byte
* otherwise DMA reads are misaligned */
data->T5_msg_size = mxt_obj_size(object);
@@ -1647,22 +1632,103 @@ static int mxt_get_object_table(struct mxt_data *data)
/* If T44 exists, T5 position has to be directly after */
if (data->T44_address && (data->T5_address != data->T44_address + 1)) {
dev_err(&client->dev, "Invalid T44 position\n");
- error = -EINVAL;
- goto free_object_table;
+ return -EINVAL;
}
data->msg_buf = kcalloc(data->max_reportid,
data->T5_msg_size, GFP_KERNEL);
if (!data->msg_buf) {
dev_err(&client->dev, "Failed to allocate message buffer\n");
+ return -ENOMEM;
+ }
+
+ return 0;
+}
+
+static int mxt_read_info_block(struct mxt_data *data)
+{
+ struct i2c_client *client = data->client;
+ int error;
+ size_t size;
+ void *buf;
+ uint8_t num_objects;
+ u32 calculated_crc;
+ u8 *crc_ptr;
+
+ /* If info block already allocated, free it */
+ if (data->raw_info_block != NULL)
+ mxt_free_object_table(data);
+
+ /* Read 7-byte ID information block starting at address 0 */
+ size = sizeof(struct mxt_info);
+ buf = kzalloc(size, GFP_KERNEL);
+ if (!buf) {
+ dev_err(&client->dev, "Failed to allocate memory\n");
+ return -ENOMEM;
+ }
+
+ error = __mxt_read_reg(client, 0, size, buf);
+ if (error)
+ goto err_free_mem;
+
+ /* Resize buffer to give space for rest of info block */
+ num_objects = ((struct mxt_info *)buf)->object_num;
+ size += (num_objects * sizeof(struct mxt_object))
+ + MXT_INFO_CHECKSUM_SIZE;
+
+ buf = krealloc(buf, size, GFP_KERNEL);
+ if (!buf) {
+ dev_err(&client->dev, "Failed to allocate memory\n");
error = -ENOMEM;
- goto free_object_table;
+ goto err_free_mem;
+ }
+
+ /* Read rest of info block */
+ error = __mxt_read_reg(client, MXT_OBJECT_START,
+ size - MXT_OBJECT_START,
+ buf + MXT_OBJECT_START);
+ if (error)
+ goto err_free_mem;
+
+ /* Extract & calculate checksum */
+ crc_ptr = buf + size - MXT_INFO_CHECKSUM_SIZE;
+ data->info_crc = crc_ptr[0] | (crc_ptr[1] << 8) | (crc_ptr[2] << 16);
+
+ calculated_crc = mxt_calculate_crc(buf, 0,
+ size - MXT_INFO_CHECKSUM_SIZE);
+
+ /* CRC mismatch can be caused by data corruption due to I2C comms
+ * issue or else device is not using Object Based Protocol */
+ if ((data->info_crc == 0) || (data->info_crc != calculated_crc)) {
+ dev_err(&client->dev,
+ "Info Block CRC error calculated=0x%06X read=0x%06X\n",
+ data->info_crc, calculated_crc);
+ return -EIO;
+ }
+
+ /* Save pointers in device data structure */
+ data->raw_info_block = buf;
+ data->info = (struct mxt_info *)buf;
+ data->object_table = (struct mxt_object *)(buf + MXT_OBJECT_START);
+
+ dev_info(&client->dev,
+ "Family: %u Variant: %u Firmware V%u.%u.%02X Objects: %u\n",
+ data->info->family_id, data->info->variant_id,
+ data->info->version >> 4, data->info->version & 0xf,
+ data->info->build, data->info->object_num);
+
+ /* Parse object table information */
+ error = mxt_parse_object_table(data);
+ if (error) {
+ dev_err(&client->dev, "Error %d reading object table\n", error);
+ mxt_free_object_table(data);
+ return error;
}
return 0;
-free_object_table:
- mxt_free_object_table(data);
+err_free_mem:
+ kfree(buf);
return error;
}
@@ -1717,13 +1783,12 @@ static int mxt_read_t9_resolution(struct mxt_data *data)
static int mxt_initialize(struct mxt_data *data)
{
struct i2c_client *client = data->client;
- struct mxt_info *info = &data->info;
int error;
bool alt_bootloader_addr = false;
bool retry = false;
retry_info:
- error = mxt_get_info(data);
+ error = mxt_read_info_block(data);
if (error) {
retry_bootloader:
error = mxt_probe_bootloader(data, alt_bootloader_addr);
@@ -1755,21 +1820,6 @@ retry_bootloader:
}
}
- data->object_table = kcalloc(info->object_num,
- sizeof(struct mxt_object),
- GFP_KERNEL);
- if (!data->object_table) {
- dev_err(&client->dev, "Failed to allocate memory\n");
- return -ENOMEM;
- }
-
- /* Get object table information */
- error = mxt_get_object_table(data);
- if (error) {
- dev_err(&client->dev, "Error %d reading object table\n", error);
- goto err_free_object_table;
- }
-
error = mxt_acquire_irq(data);
if (error)
goto err_free_object_table;
@@ -1788,17 +1838,6 @@ retry_bootloader:
goto err_free_object_table;
}
- error = mxt_read_t9_resolution(data);
- if (error) {
- dev_err(&client->dev, "Failed to initialize T9 resolution\n");
- goto err_free_object_table;
- }
-
- dev_info(&client->dev,
- "Family: %u Variant: %u Firmware V%u.%u.%02X Objects: %u\n",
- info->family_id, info->variant_id, info->version >> 4,
- info->version & 0xf, info->build, info->object_num);
-
data->enable_reporting = true;
return 0;
@@ -1813,9 +1852,9 @@ static ssize_t mxt_fw_version_show(struct device *dev,
struct device_attribute *attr, char *buf)
{
struct mxt_data *data = dev_get_drvdata(dev);
- struct mxt_info *info = &data->info;
return scnprintf(buf, PAGE_SIZE, "%u.%u.%02X\n",
- info->version >> 4, info->version & 0xf, info->build);
+ data->info->version >> 4, data->info->version & 0xf,
+ data->info->build);
}
/* Hardware Version is returned as FamilyID.VariantID */
@@ -1823,9 +1862,8 @@ static ssize_t mxt_hw_version_show(struct device *dev,
struct device_attribute *attr, char *buf)
{
struct mxt_data *data = dev_get_drvdata(dev);
- struct mxt_info *info = &data->info;
return scnprintf(buf, PAGE_SIZE, "%u.%u\n",
- info->family_id, info->variant_id);
+ data->info->family_id, data->info->variant_id);
}
static ssize_t mxt_show_instance(char *buf, int count,
@@ -1862,7 +1900,7 @@ static ssize_t mxt_object_show(struct device *dev,
return -ENOMEM;
error = 0;
- for (i = 0; i < data->info.object_num; i++) {
+ for (i = 0; i < data->info->object_num; i++) {
object = data->object_table + i;
if (!mxt_object_readable(object->type))
@@ -2127,6 +2165,10 @@ static int mxt_initialize_t9_input_device(struct mxt_data *data)
unsigned int mt_flags = 0;
int i;
+ error = mxt_read_t9_resolution(data);
+ if (error)
+ dev_warn(dev, "Failed to initialize T9 resolution\n");
+
input_dev = input_allocate_device();
if (!input_dev) {
dev_err(dev, "Failed to allocate memory\n");
--
1.7.10.4
next prev parent reply other threads:[~2013-06-27 12:54 UTC|newest]
Thread overview: 87+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-06-27 12:48 Atmel updates to atmel_mxt_ts touch controller driver - v6 Nick Dyer
2013-06-27 12:48 ` [PATCH 01/51] Input: atmel_mxt_ts - Remove unnecessary platform data Nick Dyer
2013-06-27 12:48 ` [PATCH 02/51] Input: atmel_mxt_ts - Improve T19 GPIO keys handling Nick Dyer
2013-07-18 17:11 ` rydberg
2013-06-27 12:48 ` [PATCH 03/51] Input: atmel_mxt_ts - Return IRQ_NONE when interrupt handler fails Nick Dyer
2013-06-27 12:48 ` [PATCH 04/51] Input: atmel_mxt_ts - define helper functions for size and instances Nick Dyer
2013-06-27 12:48 ` [PATCH 05/51] Input: atmel_mxt_ts - Select FW_LOADER for firmware code Nick Dyer
2013-06-27 12:48 ` [PATCH 06/51] Input: atmel_mxt_ts - wait for CHG assert in mxt_check_bootloader Nick Dyer
2013-06-27 12:48 ` [PATCH 07/51] Input: atmel_mxt_ts - wait for CHG after bootloader resets Nick Dyer
2013-06-27 12:48 ` [PATCH 08/51] Input: atmel_mxt_ts - Initialise IRQ before probing Nick Dyer
2013-07-18 17:13 ` rydberg
2013-06-27 12:48 ` [PATCH 09/51] Input: atmel_mxt_ts - Make wait-after-reset period compatible with all chips Nick Dyer
2013-06-27 12:48 ` [PATCH 10/51] Input: atmel_mxt_ts - Improve error reporting and debug Nick Dyer
2013-06-27 12:48 ` [PATCH 11/51] Input: atmel_mxt_ts - Implement CRC check for configuration data Nick Dyer
2013-09-18 16:59 ` [11/51] " Martin Fuzzey
2013-06-27 12:48 ` [PATCH 12/51] Input: atmel_mxt_ts - Download device config using firmware loader Nick Dyer
2013-09-18 17:08 ` [12/51] " Martin Fuzzey
2013-06-27 12:48 ` [PATCH 13/51] Input: atmel_mxt_ts - Calculate and check CRC in config file Nick Dyer
2013-06-27 12:48 ` [PATCH 14/51] Input: atmel_mxt_ts - Add additional bootloader addresses Nick Dyer
2013-06-27 12:48 ` [PATCH 15/51] Input: atmel_mxt_ts - Read and report bootloader version Nick Dyer
2013-06-27 12:48 ` [PATCH 16/51] Input: atmel_mxt_ts - Implement bootloader frame retries Nick Dyer
2013-06-27 12:48 ` [PATCH 17/51] Input: atmel_mxt_ts - Improve bootloader progress output Nick Dyer
2013-06-27 12:48 ` [PATCH 18/51] Input: atmel_mxt_ts - Add check for incorrect firmware file format Nick Dyer
2013-06-27 12:48 ` [PATCH 19/51] Input: atmel_mxt_ts - Read screen config from chip Nick Dyer
2013-06-27 12:48 ` [PATCH 20/51] Input: atmel_mxt_ts - Set default irqflags when there is no pdata Nick Dyer
2013-07-18 17:17 ` rydberg
2013-09-16 2:25 ` Dmitry Torokhov
2014-05-22 14:29 ` Nick Dyer
2014-05-23 16:37 ` Yufeng Shen
2014-05-24 12:41 ` Nick Dyer
2014-05-26 18:17 ` Yufeng Shen
2014-05-26 5:23 ` Dmitry Torokhov
2014-05-26 18:13 ` Yufeng Shen
2013-06-27 12:48 ` [PATCH 21/51] Input: atmel_mxt_ts - Use deep sleep mode when stopped Nick Dyer
2013-06-27 12:48 ` [PATCH 22/51] Input: atmel_mxt_ts - Add shutdown function Nick Dyer
2013-07-07 5:29 ` Dmitry Torokhov
2013-07-08 9:56 ` Nick Dyer
2013-07-10 16:55 ` Dmitry Torokhov
2013-07-10 18:32 ` Nick Dyer
2013-06-27 12:48 ` [PATCH 23/51] Input: atmel_mxt_ts - Rename pressure to amplitude to match spec Nick Dyer
2013-06-27 12:48 ` [PATCH 24/51] Input: atmel_mxt_ts - Rename touchscreen defines to include T9 Nick Dyer
2013-06-27 12:49 ` [PATCH 25/51] Input: atmel_mxt_ts - Handle multiple input reports in one message Nick Dyer
2013-07-18 17:18 ` rydberg
2013-06-27 12:49 ` [PATCH 26/51] Input: atmel_mxt_ts - Move input device init into separate function Nick Dyer
2013-07-07 5:34 ` Dmitry Torokhov
2013-07-08 9:41 ` Nick Dyer
2013-07-10 16:53 ` Dmitry Torokhov
2013-07-18 17:20 ` rydberg
2013-06-27 12:49 ` [PATCH 27/51] Input: atmel_mxt_ts - Handle APP_CRC_FAIL on startup Nick Dyer
2013-06-27 12:49 ` [PATCH 28/51] Input: atmel_mxt_ts - Handle bootloader previously unlocked Nick Dyer
2013-06-27 12:49 ` [PATCH 29/51] Input: atmel_mxt_ts - Add bootloader addresses for new chips Nick Dyer
2013-06-27 12:49 ` [PATCH 30/51] Input: atmel_mxt_ts - Recover from bootloader on probe Nick Dyer
2013-06-27 12:49 ` [PATCH 31/51] Input: atmel_mxt_ts - Add support for dynamic message size Nick Dyer
2013-06-27 12:49 ` [PATCH 32/51] Input: atmel_mxt_ts - Decode T6 status messages Nick Dyer
2013-06-27 12:49 ` [PATCH 33/51] Input: atmel_mxt_ts - Split message handler into separate functions Nick Dyer
2013-06-27 12:49 ` [PATCH 34/51] Input: atmel_mxt_ts - Implement T44 message handling Nick Dyer
2013-06-27 12:49 ` [PATCH 35/51] Input: atmel_mxt_ts - Output status from T48 Noise Supression Nick Dyer
2013-06-27 12:49 ` [PATCH 36/51] Input: atmel_mxt_ts - Output status from T42 Touch Suppression Nick Dyer
2013-06-27 12:49 ` [PATCH 37/51] Input: atmel_mxt_ts - Implement vector/orientation support Nick Dyer
2013-07-18 17:20 ` rydberg
2013-08-15 16:18 ` Nick Dyer
2013-06-27 12:49 ` [PATCH 38/51] Input: atmel_mxt_ts - implement I2C retries Nick Dyer
2013-06-27 12:49 ` [PATCH 39/51] Input: atmel_mxt_ts - Implement T63 Active Stylus support Nick Dyer
2013-07-18 17:21 ` rydberg
2013-06-27 12:49 ` [PATCH 40/51] Input: atmel_mxt_ts - Implement support for T15 Key Array Nick Dyer
2013-06-27 12:49 ` [PATCH 41/51] Input: atmel_mxt_ts - Remove unused defines Nick Dyer
2013-06-27 12:49 ` Nick Dyer [this message]
2013-06-27 12:49 ` [PATCH 43/51] Input: atmel_mxt_ts - Use T18 RETRIGEN to handle IRQF_TRIGGER_LOW Nick Dyer
2013-06-27 12:49 ` [PATCH 44/51] Input: atmel_mxt_ts - Handle reports from T47 Stylus object Nick Dyer
2013-07-18 17:23 ` rydberg
2013-06-27 12:49 ` [PATCH 45/51] Input: atmel_mxt_ts - Release touch state during suspend Nick Dyer
2013-07-18 17:29 ` rydberg
2013-08-15 15:52 ` Nick Dyer
2013-06-27 12:49 ` [PATCH 46/51] Input: atmel_mxt_ts - Initialize power config before and after downloading cfg Nick Dyer
2013-06-27 12:49 ` [PATCH 47/51] Input: atmel_mxt_ts - Add regulator control support Nick Dyer
2013-06-27 12:49 ` [PATCH 48/51] Input: atmel_mxt_ts - Implement support for T100 touch object Nick Dyer
2013-06-27 12:49 ` [PATCH 49/51] Input: atmel_mxt_ts - Allow specification of firmware file name Nick Dyer
2013-06-27 12:49 ` [PATCH 50/51] Input: atmel_mxt_ts - Handle cfg filename via pdata/sysfs Nick Dyer
2013-06-27 12:49 ` [PATCH 51/51] Input: atmel_mxt_ts - Only use first T9 instance Nick Dyer
2013-06-27 15:17 ` Atmel updates to atmel_mxt_ts touch controller driver - v6 Nick Dyer
2013-07-18 19:47 ` rydberg
2013-08-15 15:55 ` Nick Dyer
2013-08-15 16:07 ` Dmitry Torokhov
2013-08-19 14:24 ` Nick Dyer
2013-09-10 13:58 ` Nick Dyer
[not found] ` <CAPDwgkOo7FYLujk16kJM=BqmXRKvZ2S_LOYURW0cXT5t=cmi6w@mail.gmail.com>
2014-01-15 10:44 ` Nick Dyer
[not found] ` <CAPDwgkOsP4K7r0-Mo-U52X9knRbGgbuD4dGptmj3x-LMTN75BA@mail.gmail.com>
2014-01-17 20:01 ` Nick Dyer
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=1372337366-9286-43-git-send-email-nick.dyer@itdev.co.uk \
--to=nick.dyer@itdev.co.uk \
--cc=Alan.Bowens@atmel.com \
--cc=bleung@chromium.org \
--cc=djkurtz@chromium.org \
--cc=dmitry.torokhov@gmail.com \
--cc=jy0922.shim@samsung.com \
--cc=linux-input@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=olofj@chromium.org \
--cc=pmeerw@pmeerw.net \
--cc=rydberg@euromail.se \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).