Thanks, Dmitry > -----Original Message----- > From: Dmitry Torokhov [mailto:dmitry.torokhov@xxxxxxxxx] > Sent: 2014?11?10? 16:19 > To: Dudley Du > Cc: rydberg@xxxxxxxxxxx; Dudley Du; bleung@xxxxxxxxxx; > linux-input@xxxxxxxxxxxxxxx; linux-kernel@xxxxxxxxxxxxxxx > Subject: Re: [PATCH v9 02/18] input: cyapa: re-design driver to support > multi-trackpad in one driver > > Hi Dudley, > > On Mon, Nov 03, 2014 at 04:32:54PM +0800, Dudley Du wrote: > > In order to support multiple different chipsets and communication protocols > > trackpad devices in one cyapa driver, the new cyapa driver is re-designed > > with one cyapa driver core and multiple device specific functions component. > > The cyapa driver core is contained in this patch, it supplies basic functions > > that working with kernel and input subsystem, and also supplies the interfaces > > that the specific devices' component can connect and work together with as > > one driver. > > > > Signed-off-by: Dudley Du <dudl@xxxxxxxxxxx> > > Thank you for addressing my previous comments, the driver looks much > better now. Still, a few comments. > > We should try to avoid breaking the driver withing the patch series, so > please merge this change together with the next patch re-adding the gen3 > support. The gen5 is new functionality and can stay in separate > patch(es). Thanks for your review and comments. I will re-adding the gen3 support in next upstream. > > > --- > > drivers/input/mouse/cyapa.c | 1087 ++++++++++++++----------------------------- > > drivers/input/mouse/cyapa.h | 321 +++++++++++++ > > 2 files changed, 682 insertions(+), 726 deletions(-) > > create mode 100644 drivers/input/mouse/cyapa.h > > > > diff --git a/drivers/input/mouse/cyapa.c b/drivers/input/mouse/cyapa.c > > index b3d7a2a..5029618 100644 > > --- a/drivers/input/mouse/cyapa.c > > +++ b/drivers/input/mouse/cyapa.c > > @@ -6,7 +6,7 @@ > > * Daniel Kurtz <djkurtz@xxxxxxxxxxxx> > > * Benson Leung <bleung@xxxxxxxxxxxx> > > * > > - * Copyright (C) 2011-2012 Cypress Semiconductor, Inc. > > + * Copyright (C) 2011-2014 Cypress Semiconductor, Inc. > > * Copyright (C) 2011-2012 Google, Inc. > > * > > * This file is subject to the terms and conditions of the GNU General Public > > @@ -20,601 +20,193 @@ > > #include <linux/input/mt.h> > > #include <linux/interrupt.h> > > #include <linux/module.h> > > +#include <linux/mutex.h> > > #include <linux/slab.h> > > +#include <linux/uaccess.h> > > +#include "cyapa.h" > > > > -/* APA trackpad firmware generation */ > > -#define CYAPA_GEN3 0x03 /* support MT-protocol B with tracking ID. */ > > - > > -#define CYAPA_NAME "Cypress APA Trackpad (cyapa)" > > - > > -/* commands for read/write registers of Cypress trackpad */ > > -#define CYAPA_CMD_SOFT_RESET 0x00 > > -#define CYAPA_CMD_POWER_MODE 0x01 > > -#define CYAPA_CMD_DEV_STATUS 0x02 > > -#define CYAPA_CMD_GROUP_DATA 0x03 > > -#define CYAPA_CMD_GROUP_CMD 0x04 > > -#define CYAPA_CMD_GROUP_QUERY 0x05 > > -#define CYAPA_CMD_BL_STATUS 0x06 > > -#define CYAPA_CMD_BL_HEAD 0x07 > > -#define CYAPA_CMD_BL_CMD 0x08 > > -#define CYAPA_CMD_BL_DATA 0x09 > > -#define CYAPA_CMD_BL_ALL 0x0a > > -#define CYAPA_CMD_BLK_PRODUCT_ID 0x0b > > -#define CYAPA_CMD_BLK_HEAD 0x0c > > - > > -/* report data start reg offset address. */ > > -#define DATA_REG_START_OFFSET 0x0000 > > - > > -#define BL_HEAD_OFFSET 0x00 > > -#define BL_DATA_OFFSET 0x10 > > - > > -/* > > - * Operational Device Status Register > > - * > > - * bit 7: Valid interrupt source > > - * bit 6 - 4: Reserved > > - * bit 3 - 2: Power status > > - * bit 1 - 0: Device status > > - */ > > -#define REG_OP_STATUS 0x00 > > -#define OP_STATUS_SRC 0x80 > > -#define OP_STATUS_POWER 0x0c > > -#define OP_STATUS_DEV 0x03 > > -#define OP_STATUS_MASK (OP_STATUS_SRC | OP_STATUS_POWER | > OP_STATUS_DEV) > > - > > -/* > > - * Operational Finger Count/Button Flags Register > > - * > > - * bit 7 - 4: Number of touched finger > > - * bit 3: Valid data > > - * bit 2: Middle Physical Button > > - * bit 1: Right Physical Button > > - * bit 0: Left physical Button > > - */ > > -#define REG_OP_DATA1 0x01 > > -#define OP_DATA_VALID 0x08 > > -#define OP_DATA_MIDDLE_BTN 0x04 > > -#define OP_DATA_RIGHT_BTN 0x02 > > -#define OP_DATA_LEFT_BTN 0x01 > > -#define OP_DATA_BTN_MASK (OP_DATA_MIDDLE_BTN | OP_DATA_RIGHT_BTN > | \ > > - OP_DATA_LEFT_BTN) > > - > > -/* > > - * Bootloader Status Register > > - * > > - * bit 7: Busy > > - * bit 6 - 5: Reserved > > - * bit 4: Bootloader running > > - * bit 3 - 1: Reserved > > - * bit 0: Checksum valid > > - */ > > -#define REG_BL_STATUS 0x01 > > -#define BL_STATUS_BUSY 0x80 > > -#define BL_STATUS_RUNNING 0x10 > > -#define BL_STATUS_DATA_VALID 0x08 > > -#define BL_STATUS_CSUM_VALID 0x01 > > - > > -/* > > - * Bootloader Error Register > > - * > > - * bit 7: Invalid > > - * bit 6: Invalid security key > > - * bit 5: Bootloading > > - * bit 4: Command checksum > > - * bit 3: Flash protection error > > - * bit 2: Flash checksum error > > - * bit 1 - 0: Reserved > > - */ > > -#define REG_BL_ERROR 0x02 > > -#define BL_ERROR_INVALID 0x80 > > -#define BL_ERROR_INVALID_KEY 0x40 > > -#define BL_ERROR_BOOTLOADING 0x20 > > -#define BL_ERROR_CMD_CSUM 0x10 > > -#define BL_ERROR_FLASH_PROT 0x08 > > -#define BL_ERROR_FLASH_CSUM 0x04 > > - > > -#define BL_STATUS_SIZE 3 /* length of bootloader status registers */ > > -#define BLK_HEAD_BYTES 32 > > - > > -#define PRODUCT_ID_SIZE 16 > > -#define QUERY_DATA_SIZE 27 > > -#define REG_PROTOCOL_GEN_QUERY_OFFSET 20 > > - > > -#define REG_OFFSET_DATA_BASE 0x0000 > > -#define REG_OFFSET_COMMAND_BASE 0x0028 > > -#define REG_OFFSET_QUERY_BASE 0x002a > > - > > -#define CAPABILITY_LEFT_BTN_MASK(0x01 << 3) > > -#define CAPABILITY_RIGHT_BTN_MASK(0x01 << 4) > > -#define CAPABILITY_MIDDLE_BTN_MASK(0x01 << 5) > > -#define CAPABILITY_BTN_MASK (CAPABILITY_LEFT_BTN_MASK | \ > > - CAPABILITY_RIGHT_BTN_MASK | \ > > - CAPABILITY_MIDDLE_BTN_MASK) > > - > > -#define CYAPA_OFFSET_SOFT_RESET REG_OFFSET_COMMAND_BASE > > - > > -#define REG_OFFSET_POWER_MODE (REG_OFFSET_COMMAND_BASE + 1) > > - > > -#define PWR_MODE_MASK 0xfc > > -#define PWR_MODE_FULL_ACTIVE (0x3f << 2) > > -#define PWR_MODE_IDLE (0x05 << 2) /* default sleep time is 50 ms. */ > > -#define PWR_MODE_OFF (0x00 << 2) > > - > > -#define PWR_STATUS_MASK 0x0c > > -#define PWR_STATUS_ACTIVE (0x03 << 2) > > -#define PWR_STATUS_IDLE (0x02 << 2) > > -#define PWR_STATUS_OFF (0x00 << 2) > > - > > -/* > > - * CYAPA trackpad device states. > > - * Used in register 0x00, bit1-0, DeviceStatus field. > > - * Other values indicate device is in an abnormal state and must be reset. > > - */ > > -#define CYAPA_DEV_NORMAL 0x03 > > -#define CYAPA_DEV_BUSY 0x01 > > - > > -enum cyapa_state { > > -CYAPA_STATE_OP, > > -CYAPA_STATE_BL_IDLE, > > -CYAPA_STATE_BL_ACTIVE, > > -CYAPA_STATE_BL_BUSY, > > -CYAPA_STATE_NO_DEVICE, > > -}; > > - > > - > > -struct cyapa_touch { > > -/* > > - * high bits or x/y position value > > - * bit 7 - 4: high 4 bits of x position value > > - * bit 3 - 0: high 4 bits of y position value > > - */ > > -u8 xy_hi; > > -u8 x_lo; /* low 8 bits of x position value. */ > > -u8 y_lo; /* low 8 bits of y position value. */ > > -u8 pressure; > > -/* id range is 1 - 15. It is incremented with every new touch. */ > > -u8 id; > > -} __packed; > > - > > -/* The touch.id is used as the MT slot id, thus max MT slot is 15 */ > > -#define CYAPA_MAX_MT_SLOTS 15 > > - > > -struct cyapa_reg_data { > > -/* > > - * bit 0 - 1: device status > > - * bit 3 - 2: power mode > > - * bit 6 - 4: reserved > > - * bit 7: interrupt valid bit > > - */ > > -u8 device_status; > > -/* > > - * bit 7 - 4: number of fingers currently touching pad > > - * bit 3: valid data check bit > > - * bit 2: middle mechanism button state if exists > > - * bit 1: right mechanism button state if exists > > - * bit 0: left mechanism button state if exists > > - */ > > -u8 finger_btn; > > -/* CYAPA reports up to 5 touches per packet. */ > > -struct cyapa_touch touches[5]; > > -} __packed; > > - > > -/* The main device structure */ > > -struct cyapa { > > -enum cyapa_state state; > > - > > -struct i2c_client *client; > > -struct input_dev *input; > > -char phys[32];/* device physical location */ > > -int irq; > > -bool irq_wake; /* irq wake is enabled */ > > -bool smbus; > > - > > -/* read from query data region. */ > > -char product_id[16]; > > -u8 btn_capability; > > -u8 gen; > > -int max_abs_x; > > -int max_abs_y; > > -int physical_size_x; > > -int physical_size_y; > > -}; > > - > > -static const u8 bl_deactivate[] = { 0x00, 0xff, 0x3b, 0x00, 0x01, 0x02, 0x03, > > -0x04, 0x05, 0x06, 0x07 }; > > -static const u8 bl_exit[] = { 0x00, 0xff, 0xa5, 0x00, 0x01, 0x02, 0x03, 0x04, > > -0x05, 0x06, 0x07 }; > > - > > -struct cyapa_cmd_len { > > -u8 cmd; > > -u8 len; > > -}; > > > > #define CYAPA_ADAPTER_FUNC_NONE 0 > > #define CYAPA_ADAPTER_FUNC_I2C 1 > > #define CYAPA_ADAPTER_FUNC_SMBUS 2 > > #define CYAPA_ADAPTER_FUNC_BOTH 3 > > > > -/* > > - * macros for SMBus communication > > - */ > > -#define SMBUS_READ 0x01 > > -#define SMBUS_WRITE 0x00 > > -#define SMBUS_ENCODE_IDX(cmd, idx) ((cmd) | (((idx) & 0x03) << 1)) > > -#define SMBUS_ENCODE_RW(cmd, rw) ((cmd) | ((rw) & 0x01)) > > -#define SMBUS_BYTE_BLOCK_CMD_MASK 0x80 > > -#define SMBUS_GROUP_BLOCK_CMD_MASK 0x40 > > - > > - /* for byte read/write command */ > > -#define CMD_RESET 0 > > -#define CMD_POWER_MODE 1 > > -#define CMD_DEV_STATUS 2 > > -#define SMBUS_BYTE_CMD(cmd) (((cmd) & 0x3f) << 1) > > -#define CYAPA_SMBUS_RESET SMBUS_BYTE_CMD(CMD_RESET) > > -#define CYAPA_SMBUS_POWER_MODE > SMBUS_BYTE_CMD(CMD_POWER_MODE) > > -#define CYAPA_SMBUS_DEV_STATUS SMBUS_BYTE_CMD(CMD_DEV_STATUS) > > - > > - /* for group registers read/write command */ > > -#define REG_GROUP_DATA 0 > > -#define REG_GROUP_CMD 2 > > -#define REG_GROUP_QUERY 3 > > -#define SMBUS_GROUP_CMD(grp) (0x80 | (((grp) & 0x07) << 3)) > > -#define CYAPA_SMBUS_GROUP_DATA > SMBUS_GROUP_CMD(REG_GROUP_DATA) > > -#define CYAPA_SMBUS_GROUP_CMD > SMBUS_GROUP_CMD(REG_GROUP_CMD) > > -#define CYAPA_SMBUS_GROUP_QUERY > SMBUS_GROUP_CMD(REG_GROUP_QUERY) > > - > > - /* for register block read/write command */ > > -#define CMD_BL_STATUS 0 > > -#define CMD_BL_HEAD 1 > > -#define CMD_BL_CMD 2 > > -#define CMD_BL_DATA 3 > > -#define CMD_BL_ALL 4 > > -#define CMD_BLK_PRODUCT_ID 5 > > -#define CMD_BLK_HEAD 6 > > -#define SMBUS_BLOCK_CMD(cmd) (0xc0 | (((cmd) & 0x1f) << 1)) > > - > > -/* register block read/write command in bootloader mode */ > > -#define CYAPA_SMBUS_BL_STATUS SMBUS_BLOCK_CMD(CMD_BL_STATUS) > > -#define CYAPA_SMBUS_BL_HEAD SMBUS_BLOCK_CMD(CMD_BL_HEAD) > > -#define CYAPA_SMBUS_BL_CMD SMBUS_BLOCK_CMD(CMD_BL_CMD) > > -#define CYAPA_SMBUS_BL_DATA SMBUS_BLOCK_CMD(CMD_BL_DATA) > > -#define CYAPA_SMBUS_BL_ALL SMBUS_BLOCK_CMD(CMD_BL_ALL) > > - > > -/* register block read/write command in operational mode */ > > -#define CYAPA_SMBUS_BLK_PRODUCT_ID > SMBUS_BLOCK_CMD(CMD_BLK_PRODUCT_ID) > > -#define CYAPA_SMBUS_BLK_HEAD SMBUS_BLOCK_CMD(CMD_BLK_HEAD) > > - > > -static const struct cyapa_cmd_len cyapa_i2c_cmds[] = { > > -{ CYAPA_OFFSET_SOFT_RESET, 1 }, > > -{ REG_OFFSET_COMMAND_BASE + 1, 1 }, > > -{ REG_OFFSET_DATA_BASE, 1 }, > > -{ REG_OFFSET_DATA_BASE, sizeof(struct cyapa_reg_data) }, > > -{ REG_OFFSET_COMMAND_BASE, 0 }, > > -{ REG_OFFSET_QUERY_BASE, QUERY_DATA_SIZE }, > > -{ BL_HEAD_OFFSET, 3 }, > > -{ BL_HEAD_OFFSET, 16 }, > > -{ BL_HEAD_OFFSET, 16 }, > > -{ BL_DATA_OFFSET, 16 }, > > -{ BL_HEAD_OFFSET, 32 }, > > -{ REG_OFFSET_QUERY_BASE, PRODUCT_ID_SIZE }, > > -{ REG_OFFSET_DATA_BASE, 32 } > > -}; > > +#define CYAPA_DEBUGFS_READ_FW"read_fw" > > +#define CYAPA_DEBUGFS_RAW_DATA"raw_data" > > +#define CYAPA_FW_NAME"cyapa.bin" > > These do not seem to belong to the current patch, please introduce them > only when you need them. Thanks, I will fix it in next upstream. > > > + > > +const char unique_str[] = "CYTRA"; > > > > -static const struct cyapa_cmd_len cyapa_smbus_cmds[] = { > > -{ CYAPA_SMBUS_RESET, 1 }, > > -{ CYAPA_SMBUS_POWER_MODE, 1 }, > > -{ CYAPA_SMBUS_DEV_STATUS, 1 }, > > -{ CYAPA_SMBUS_GROUP_DATA, sizeof(struct cyapa_reg_data) }, > > -{ CYAPA_SMBUS_GROUP_CMD, 2 }, > > -{ CYAPA_SMBUS_GROUP_QUERY, QUERY_DATA_SIZE }, > > -{ CYAPA_SMBUS_BL_STATUS, 3 }, > > -{ CYAPA_SMBUS_BL_HEAD, 16 }, > > -{ CYAPA_SMBUS_BL_CMD, 16 }, > > -{ CYAPA_SMBUS_BL_DATA, 16 }, > > -{ CYAPA_SMBUS_BL_ALL, 32 }, > > -{ CYAPA_SMBUS_BLK_PRODUCT_ID, PRODUCT_ID_SIZE }, > > -{ CYAPA_SMBUS_BLK_HEAD, 16 }, > > -}; > > > > -static ssize_t cyapa_i2c_reg_read_block(struct cyapa *cyapa, u8 reg, size_t len, > > +ssize_t cyapa_i2c_reg_read_block(struct cyapa *cyapa, u8 reg, size_t len, > > u8 *values) > > { > > return i2c_smbus_read_i2c_block_data(cyapa->client, reg, len, values); > > } > > > > -static ssize_t cyapa_i2c_reg_write_block(struct cyapa *cyapa, u8 reg, > > +ssize_t cyapa_i2c_reg_write_block(struct cyapa *cyapa, u8 reg, > > size_t len, const u8 *values) > > { > > return i2c_smbus_write_i2c_block_data(cyapa->client, reg, len, values); > > } > > > > -/* > > - * cyapa_smbus_read_block - perform smbus block read command > > - * @cyapa - private data structure of the driver > > - * @cmd - the properly encoded smbus command > > - * @len - expected length of smbus command result > > - * @values - buffer to store smbus command result > > - * > > - * Returns negative errno, else the number of bytes written. > > - * > > - * Note: > > - * In trackpad device, the memory block allocated for I2C register map > > - * is 256 bytes, so the max read block for I2C bus is 256 bytes. > > - */ > > -static ssize_t cyapa_smbus_read_block(struct cyapa *cyapa, u8 cmd, size_t len, > > - u8 *values) > > -{ > > -ssize_t ret; > > -u8 index; > > -u8 smbus_cmd; > > -u8 *buf; > > -struct i2c_client *client = cyapa->client; > > - > > -if (!(SMBUS_BYTE_BLOCK_CMD_MASK & cmd)) > > -return -EINVAL; > > - > > -if (SMBUS_GROUP_BLOCK_CMD_MASK & cmd) { > > -/* read specific block registers command. */ > > -smbus_cmd = SMBUS_ENCODE_RW(cmd, SMBUS_READ); > > -ret = i2c_smbus_read_block_data(client, smbus_cmd, values); > > -goto out; > > -} > > - > > -ret = 0; > > -for (index = 0; index * I2C_SMBUS_BLOCK_MAX < len; index++) { > > -smbus_cmd = SMBUS_ENCODE_IDX(cmd, index); > > -smbus_cmd = SMBUS_ENCODE_RW(smbus_cmd, SMBUS_READ); > > -buf = values + I2C_SMBUS_BLOCK_MAX * index; > > -ret = i2c_smbus_read_block_data(client, smbus_cmd, buf); > > -if (ret < 0) > > -goto out; > > -} > > - > > -out: > > -return ret > 0 ? len : ret; > > -} > > - > > -static s32 cyapa_read_byte(struct cyapa *cyapa, u8 cmd_idx) > > -{ > > -u8 cmd; > > - > > -if (cyapa->smbus) { > > -cmd = cyapa_smbus_cmds[cmd_idx].cmd; > > -cmd = SMBUS_ENCODE_RW(cmd, SMBUS_READ); > > -} else { > > -cmd = cyapa_i2c_cmds[cmd_idx].cmd; > > -} > > -return i2c_smbus_read_byte_data(cyapa->client, cmd); > > -} > > - > > -static s32 cyapa_write_byte(struct cyapa *cyapa, u8 cmd_idx, u8 value) > > -{ > > -u8 cmd; > > - > > -if (cyapa->smbus) { > > -cmd = cyapa_smbus_cmds[cmd_idx].cmd; > > -cmd = SMBUS_ENCODE_RW(cmd, SMBUS_WRITE); > > -} else { > > -cmd = cyapa_i2c_cmds[cmd_idx].cmd; > > -} > > -return i2c_smbus_write_byte_data(cyapa->client, cmd, value); > > -} > > - > > -static ssize_t cyapa_read_block(struct cyapa *cyapa, u8 cmd_idx, u8 *values) > > -{ > > -u8 cmd; > > -size_t len; > > - > > -if (cyapa->smbus) { > > -cmd = cyapa_smbus_cmds[cmd_idx].cmd; > > -len = cyapa_smbus_cmds[cmd_idx].len; > > -return cyapa_smbus_read_block(cyapa, cmd, len, values); > > -} > > - > > -cmd = cyapa_i2c_cmds[cmd_idx].cmd; > > -len = cyapa_i2c_cmds[cmd_idx].len; > > -return cyapa_i2c_reg_read_block(cyapa, cmd, len, values); > > -} > > - > > -/* > > - * Query device for its current operating state. > > - * > > - */ > > -static int cyapa_get_state(struct cyapa *cyapa) > > +/* Returns 0 on success, else negative errno on failure. */ > > +ssize_t cyapa_i2c_read(struct cyapa *cyapa, u8 reg, size_t len, > > +u8 *values) > > { > > int ret; > > -u8 status[BL_STATUS_SIZE]; > > - > > -cyapa->state = CYAPA_STATE_NO_DEVICE; > > - > > -/* > > - * Get trackpad status by reading 3 registers starting from 0. > > - * If the device is in the bootloader, this will be BL_HEAD. > > - * If the device is in operation mode, this will be the DATA regs. > > - * > > - */ > > -ret = cyapa_i2c_reg_read_block(cyapa, BL_HEAD_OFFSET, BL_STATUS_SIZE, > > - status); > > - > > -/* > > - * On smbus systems in OP mode, the i2c_reg_read will fail with > > - * -ETIMEDOUT. In this case, try again using the smbus equivalent > > - * command. This should return a BL_HEAD indicating CYAPA_STATE_OP. > > - */ > > -if (cyapa->smbus && (ret == -ETIMEDOUT || ret == -ENXIO)) > > -ret = cyapa_read_block(cyapa, CYAPA_CMD_BL_STATUS, status); > > - > > -if (ret != BL_STATUS_SIZE) > > -goto error; > > - > > -if ((status[REG_OP_STATUS] & OP_STATUS_SRC) == OP_STATUS_SRC) { > > -switch (status[REG_OP_STATUS] & OP_STATUS_DEV) { > > -case CYAPA_DEV_NORMAL: > > -case CYAPA_DEV_BUSY: > > -cyapa->state = CYAPA_STATE_OP; > > -break; > > -default: > > -ret = -EAGAIN; > > -goto error; > > -} > > -} else { > > -if (status[REG_BL_STATUS] & BL_STATUS_BUSY) > > -cyapa->state = CYAPA_STATE_BL_BUSY; > > -else if (status[REG_BL_ERROR] & BL_ERROR_BOOTLOADING) > > -cyapa->state = CYAPA_STATE_BL_ACTIVE; > > -else > > -cyapa->state = CYAPA_STATE_BL_IDLE; > > -} > > +struct i2c_client *client = cyapa->client; > > +struct i2c_msg msgs[] = { > > +{ > > +.addr = client->addr, > > +.flags = 0, > > +.len = 1, > > +.buf = ®, > > +}, > > +{ > > +.addr = client->addr, > > +.flags = I2C_M_RD, > > +.len = len, > > +.buf = values, > > +}, > > +}; > > + > > +ret = i2c_transfer(client->adapter, msgs, 2); > > + > > +if (ret != ARRAY_SIZE(msgs)) > > +return ret < 0 ? ret : -EIO; > > > > return 0; > > -error: > > -return (ret < 0) ? ret : -EAGAIN; > > } > > > > -/* > > - * Poll device for its status in a loop, waiting up to timeout for a response. > > - * > > - * When the device switches state, it usually takes ~300 ms. > > - * However, when running a new firmware image, the device must calibrate its > > - * sensors, which can take as long as 2 seconds. > > +/** > > + * cyapa_i2c_write - Execute i2c block data write operation > > + * @cyapa: Handle to this driver > > + * @ret: Offset of the data to written in the register map > > + * @len: number of bytes to write > > + * @values: Data to be written > > * > > - * Note: The timeout has granularity of the polling rate, which is 100 ms. > > - * > > - * Returns: > > - * 0 when the device eventually responds with a valid non-busy state. > > - * -ETIMEDOUT if device never responds (too many -EAGAIN) > > - * < 0 other errors > > + * Return negative errno code on error; return zero when success. > > */ > > -static int cyapa_poll_state(struct cyapa *cyapa, unsigned int timeout) > > +ssize_t cyapa_i2c_write(struct cyapa *cyapa, u8 reg, > > + size_t len, const void *values) > > { > > int ret; > > -int tries = timeout / 100; > > - > > -ret = cyapa_get_state(cyapa); > > -while ((ret || cyapa->state >= CYAPA_STATE_BL_BUSY) && tries--) { > > -msleep(100); > > -ret = cyapa_get_state(cyapa); > > -} > > -return (ret == -EAGAIN || ret == -ETIMEDOUT) ? -ETIMEDOUT : ret; > > -} > > - > > -static int cyapa_bl_deactivate(struct cyapa *cyapa) > > -{ > > -int ret; > > - > > -ret = cyapa_i2c_reg_write_block(cyapa, 0, sizeof(bl_deactivate), > > -bl_deactivate); > > -if (ret < 0) > > -return ret; > > - > > -/* wait for bootloader to switch to idle state; should take < 100ms */ > > -msleep(100); > > -ret = cyapa_poll_state(cyapa, 500); > > -if (ret < 0) > > -return ret; > > -if (cyapa->state != CYAPA_STATE_BL_IDLE) > > -return -EAGAIN; > > -return 0; > > +struct i2c_client *client = cyapa->client; > > +char data[32], *buf; > > + > > +if (len > 31) { > > +buf = kzalloc(len + 1, GFP_KERNEL); > > +if (!buf) > > +return -ENOMEM; > > +} else > > +buf = data; > > + > > +buf[0] = reg; > > +memcpy(&buf[1], values, len); > > +ret = i2c_master_send(client, buf, len + 1); > > + > > +if (buf != data) > > +kfree(buf); > > +return (ret == (len + 1)) ? 0 : ((ret < 0) ? ret : -EIO); > > } > > > > -/* > > - * Exit bootloader > > - * > > - * Send bl_exit command, then wait 50 - 100 ms to let device transition to > > - * operational mode. If this is the first time the device's firmware is > > - * running, it can take up to 2 seconds to calibrate its sensors. So, poll > > - * the device's new state for up to 2 seconds. > > - * > > - * Returns: > > - * -EIO failure while reading from device > > - * -EAGAIN device is stuck in bootloader, b/c it has invalid firmware > > - * 0 device is supported and in operational mode > > - */ > > -static int cyapa_bl_exit(struct cyapa *cyapa) > > +static u8 cyapa_check_adapter_functionality(struct i2c_client *client) > > { > > -int ret; > > - > > -ret = cyapa_i2c_reg_write_block(cyapa, 0, sizeof(bl_exit), bl_exit); > > -if (ret < 0) > > -return ret; > > - > > -/* > > - * Wait for bootloader to exit, and operation mode to start. > > - * Normally, this takes at least 50 ms. > > - */ > > -usleep_range(50000, 100000); > > -/* > > - * In addition, when a device boots for the first time after being > > - * updated to new firmware, it must first calibrate its sensors, which > > - * can take up to an additional 2 seconds. > > - */ > > -ret = cyapa_poll_state(cyapa, 2000); > > -if (ret < 0) > > -return ret; > > -if (cyapa->state != CYAPA_STATE_OP) > > -return -EAGAIN; > > +u8 ret = CYAPA_ADAPTER_FUNC_NONE; > > > > -return 0; > > +if (i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) > > +ret |= CYAPA_ADAPTER_FUNC_I2C; > > +if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA | > > + I2C_FUNC_SMBUS_BLOCK_DATA | > > + I2C_FUNC_SMBUS_I2C_BLOCK)) > > +ret |= CYAPA_ADAPTER_FUNC_SMBUS; > > +return ret; > > } > > > > -/* > > - * Set device power mode > > - * > > - */ > > -static int cyapa_set_power_mode(struct cyapa *cyapa, u8 power_mode) > > +static int cyapa_create_input_dev(struct cyapa *cyapa) > > { > > struct device *dev = &cyapa->client->dev; > > int ret; > > -u8 power; > > +struct input_dev *input; > > > > -if (cyapa->state != CYAPA_STATE_OP) > > -return 0; > > +if (!cyapa->physical_size_x || !cyapa->physical_size_y) > > +return -EINVAL; > > > > -ret = cyapa_read_byte(cyapa, CYAPA_CMD_POWER_MODE); > > -if (ret < 0) > > -return ret; > > +input = cyapa->input = devm_input_allocate_device(dev); > > +if (!input) { > > +dev_err(dev, "failed to allocate memory for input device.\n"); > > +return -ENOMEM; > > +} > > > > -power = ret & ~PWR_MODE_MASK; > > -power |= power_mode & PWR_MODE_MASK; > > -ret = cyapa_write_byte(cyapa, CYAPA_CMD_POWER_MODE, power); > > -if (ret < 0) > > -dev_err(dev, "failed to set power_mode 0x%02x err = %d\n", > > -power_mode, ret); > > -return ret; > > -} > > +input->name = CYAPA_NAME; > > +input->phys = cyapa->phys; > > +input->id.bustype = BUS_I2C; > > +input->id.version = 1; > > +input->id.product = 0; /* Means any product in eventcomm. */ > > +input->dev.parent = &cyapa->client->dev; > > > > -static int cyapa_get_query_data(struct cyapa *cyapa) > > -{ > > -u8 query_data[QUERY_DATA_SIZE]; > > -int ret; > > +input_set_drvdata(input, cyapa); > > > > -if (cyapa->state != CYAPA_STATE_OP) > > -return -EBUSY; > > +__set_bit(EV_ABS, input->evbit); > > > > -ret = cyapa_read_block(cyapa, CYAPA_CMD_GROUP_QUERY, query_data); > > -if (ret < 0) > > -return ret; > > -if (ret != QUERY_DATA_SIZE) > > -return -EIO; > > +/* Finger position */ > > +input_set_abs_params(input, ABS_MT_POSITION_X, 0, cyapa->max_abs_x, 0, > > + 0); > > +input_set_abs_params(input, ABS_MT_POSITION_Y, 0, cyapa->max_abs_y, 0, > > + 0); > > +input_set_abs_params(input, ABS_MT_PRESSURE, 0, cyapa->max_z, 0, 0); > > +if (cyapa->gen > CYAPA_GEN3) { > > +input_set_abs_params(input, ABS_MT_TOUCH_MAJOR, 0, 255, 0, 0); > > +input_set_abs_params(input, ABS_MT_TOUCH_MINOR, 0, 255, 0, 0); > > +/* > > + * Orientation is the angle between the vertical axis and > > + * the major axis of the contact ellipse. > > + * The range is -127 to 127. > > + * the positive direction is clockwise form the vertical axis. > > + * If the ellipse of contact degenerates into a circle, > > + * orientation is reported as 0. > > + * > > + * Also, for Gen5 trackpad the accurate of this orientation > > + * value is value + (-30 ~ 30). > > + */ > > +input_set_abs_params(input, ABS_MT_ORIENTATION, > > +-127, 127, 0, 0); > > +} > > +if (cyapa->gen >= CYAPA_GEN5) { > > +input_set_abs_params(input, ABS_MT_WIDTH_MAJOR, 0, 255, 0, 0); > > +input_set_abs_params(input, ABS_MT_WIDTH_MINOR, 0, 255, 0, 0); > > +} > > > > -memcpy(&cyapa->product_id[0], &query_data[0], 5); > > -cyapa->product_id[5] = '-'; > > -memcpy(&cyapa->product_id[6], &query_data[5], 6); > > -cyapa->product_id[12] = '-'; > > -memcpy(&cyapa->product_id[13], &query_data[11], 2); > > -cyapa->product_id[15] = '\0'; > > +input_abs_set_res(input, ABS_MT_POSITION_X, > > + cyapa->max_abs_x / cyapa->physical_size_x); > > +input_abs_set_res(input, ABS_MT_POSITION_Y, > > + cyapa->max_abs_y / cyapa->physical_size_y); > > > > -cyapa->btn_capability = query_data[19] & CAPABILITY_BTN_MASK; > > +if (cyapa->btn_capability & CAPABILITY_LEFT_BTN_MASK) > > +__set_bit(BTN_LEFT, input->keybit); > > +if (cyapa->btn_capability & CAPABILITY_MIDDLE_BTN_MASK) > > +__set_bit(BTN_MIDDLE, input->keybit); > > +if (cyapa->btn_capability & CAPABILITY_RIGHT_BTN_MASK) > > +__set_bit(BTN_RIGHT, input->keybit); > > > > -cyapa->gen = query_data[20] & 0x0f; > > +if (cyapa->btn_capability == CAPABILITY_LEFT_BTN_MASK) > > +__set_bit(INPUT_PROP_BUTTONPAD, input->propbit); > > > > -cyapa->max_abs_x = ((query_data[21] & 0xf0) << 4) | query_data[22]; > > -cyapa->max_abs_y = ((query_data[21] & 0x0f) << 8) | query_data[23]; > > +/* Handle pointer emulation and unused slots in core */ > > +ret = input_mt_init_slots(input, CYAPA_MAX_MT_SLOTS, > > + INPUT_MT_POINTER | INPUT_MT_DROP_UNUSED); > > +if (ret) { > > +dev_err(dev, "failed to initialize MT slots, %d\n", ret); > > +return ret; > > +} > > > > -cyapa->physical_size_x = > > -((query_data[24] & 0xf0) << 4) | query_data[25]; > > -cyapa->physical_size_y = > > -((query_data[24] & 0x0f) << 8) | query_data[26]; > > +/* Register the device in input subsystem */ > > +ret = input_register_device(input); > > +if (ret) { > > +dev_err(dev, "failed to register input device, %d\n", ret); > > +return ret; > > +} > > > > return 0; > > } > > @@ -635,192 +227,213 @@ static int cyapa_get_query_data(struct cyapa > *cyapa) > > */ > > static int cyapa_check_is_operational(struct cyapa *cyapa) > > { > > -struct device *dev = &cyapa->client->dev; > > -static const char unique_str[] = "CYTRA"; > > int ret; > > > > -ret = cyapa_poll_state(cyapa, 2000); > > -if (ret < 0) > > +ret = cyapa_poll_state(cyapa, 4000); > > +if (ret) > > return ret; > > -switch (cyapa->state) { > > -case CYAPA_STATE_BL_ACTIVE: > > -ret = cyapa_bl_deactivate(cyapa); > > -if (ret) > > -return ret; > > - > > -/* Fallthrough state */ > > -case CYAPA_STATE_BL_IDLE: > > -ret = cyapa_bl_exit(cyapa); > > -if (ret) > > -return ret; > > - > > -/* Fallthrough state */ > > -case CYAPA_STATE_OP: > > -ret = cyapa_get_query_data(cyapa); > > -if (ret < 0) > > -return ret; > > - > > -/* only support firmware protocol gen3 */ > > -if (cyapa->gen != CYAPA_GEN3) { > > -dev_err(dev, "unsupported protocol version (%d)", > > -cyapa->gen); > > -return -EINVAL; > > -} > > - > > -/* only support product ID starting with CYTRA */ > > -if (memcmp(cyapa->product_id, unique_str, > > - sizeof(unique_str) - 1) != 0) { > > -dev_err(dev, "unsupported product ID (%s)\n", > > -cyapa->product_id); > > -return -EINVAL; > > -} > > -return 0; > > > > +switch (cyapa->gen) { > > default: > > -return -EIO; > > +return -ENODEV; > > } > > -return 0; > > + > > +if (cyapa->ops->operational_check) > > +ret = cyapa->ops->operational_check(cyapa); > > + > > +return ret; > > } > > > > + > > static irqreturn_t cyapa_irq(int irq, void *dev_id) > > { > > struct cyapa *cyapa = dev_id; > > struct device *dev = &cyapa->client->dev; > > struct input_dev *input = cyapa->input; > > -struct cyapa_reg_data data; > > -int i; > > +bool cont; > > int ret; > > -int num_fingers; > > > > if (device_may_wakeup(dev)) > > pm_wakeup_event(dev, 0); > > > > -ret = cyapa_read_block(cyapa, CYAPA_CMD_GROUP_DATA, (u8 *)&data); > > -if (ret != sizeof(data)) > > -goto out; > > - > > -if ((data.device_status & OP_STATUS_SRC) != OP_STATUS_SRC || > > - (data.device_status & OP_STATUS_DEV) != CYAPA_DEV_NORMAL || > > - (data.finger_btn & OP_DATA_VALID) != OP_DATA_VALID) { > > -goto out; > > -} > > - > > -num_fingers = (data.finger_btn >> 4) & 0x0f; > > -for (i = 0; i < num_fingers; i++) { > > -const struct cyapa_touch *touch = &data.touches[i]; > > -/* Note: touch->id range is 1 to 15; slots are 0 to 14. */ > > -int slot = touch->id - 1; > > - > > -input_mt_slot(input, slot); > > -input_mt_report_slot_state(input, MT_TOOL_FINGER, true); > > -input_report_abs(input, ABS_MT_POSITION_X, > > - ((touch->xy_hi & 0xf0) << 4) | touch->x_lo); > > -input_report_abs(input, ABS_MT_POSITION_Y, > > - ((touch->xy_hi & 0x0f) << 8) | touch->y_lo); > > -input_report_abs(input, ABS_MT_PRESSURE, touch->pressure); > > +/* Interrupt event maybe cuased by host command to trackpad device. */ > > +cont = true; > > +if (cyapa->ops->irq_cmd_handler) > > +cont = cyapa->ops->irq_cmd_handler(cyapa); > > + > > +/* Interrupt event maybe from trackpad device input reporting. */ > > +if (cont && cyapa->ops->irq_handler) { > > +if (!input || cyapa->ops->irq_handler(cyapa)) { > > +ret = mutex_lock_interruptible(&cyapa->state_sync_lock); > > +if (ret && cyapa->ops->sort_empty_output_data) { > > +cyapa->ops->sort_empty_output_data(cyapa, > > +NULL, NULL, NULL); > > +goto out; > > +} > > +cyapa_detect(cyapa); > > +mutex_unlock(&cyapa->state_sync_lock); > > +} > > } > > > > -input_mt_sync_frame(input); > > - > > -if (cyapa->btn_capability & CAPABILITY_LEFT_BTN_MASK) > > -input_report_key(input, BTN_LEFT, > > - data.finger_btn & OP_DATA_LEFT_BTN); > > - > > -if (cyapa->btn_capability & CAPABILITY_MIDDLE_BTN_MASK) > > -input_report_key(input, BTN_MIDDLE, > > - data.finger_btn & OP_DATA_MIDDLE_BTN); > > - > > -if (cyapa->btn_capability & CAPABILITY_RIGHT_BTN_MASK) > > -input_report_key(input, BTN_RIGHT, > > - data.finger_btn & OP_DATA_RIGHT_BTN); > > - > > -input_sync(input); > > - > > out: > > return IRQ_HANDLED; > > } > > > > -static u8 cyapa_check_adapter_functionality(struct i2c_client *client) > > +/* > > + * Query device for its current operating state. > > + */ > > +static int cyapa_get_state(struct cyapa *cyapa) > > { > > -u8 ret = CYAPA_ADAPTER_FUNC_NONE; > > +return -ENODEV; > > +} > > > > -if (i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) > > -ret |= CYAPA_ADAPTER_FUNC_I2C; > > -if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA | > > - I2C_FUNC_SMBUS_BLOCK_DATA | > > - I2C_FUNC_SMBUS_I2C_BLOCK)) > > -ret |= CYAPA_ADAPTER_FUNC_SMBUS; > > -return ret; > > +/* > > + * Poll device for its status in a loop, waiting up to timeout for a response. > > + * > > + * When the device switches state, it usually takes ~300 ms. > > + * However, when running a new firmware image, the device must calibrate its > > + * sensors, which can take as long as 2 seconds. > > + * > > + * Note: The timeout has granularity of the polling rate, which is 100 ms. > > + * > > + * Returns: > > + * 0 when the device eventually responds with a valid non-busy state. > > + * -ETIMEDOUT if device never responds (too many -EAGAIN) > > + * < 0 other errors > > + */ > > +int cyapa_poll_state(struct cyapa *cyapa, unsigned int timeout) > > +{ > > +int ret; > > +int tries = timeout / 100; > > + > > +ret = cyapa_get_state(cyapa); > > +while ((ret || cyapa->state <= CYAPA_STATE_BL_BUSY) && tries--) { > > +msleep(100); > > +ret = cyapa_get_state(cyapa); > > +} > > + > > +return (ret == -EAGAIN || ret == -ETIMEDOUT) ? -ETIMEDOUT : ret; > > } > > > > -static int cyapa_create_input_dev(struct cyapa *cyapa) > > +/* > > + * Returns: > > + * 0 when device is detected, and operatioinal. > > + * > 0 when device is detected, but not operational. > > + * < 0 when device is not detected, or other errors. > > + * e.g.: IO communication error with the device. > > + */ > > +int cyapa_detect(struct cyapa *cyapa) > > We have cyapa->state. Can we check it to see if device is operational or > not? Or introduce another variable instead of returning tristate from > cyapa_detect? Do you mean in cyapa_detect() method, just get the result of operational or not? If not operational, then in other method to get the detail state of the device, right? > > > { > > struct device *dev = &cyapa->client->dev; > > +char *envp[2] = {"ERROR=1", NULL}; > > int ret; > > -struct input_dev *input; > > > > -if (!cyapa->physical_size_x || !cyapa->physical_size_y) > > -return -EINVAL; > > +ret = cyapa_check_is_operational(cyapa); > > +if (ret) { > > +if (ret != -ETIMEDOUT && ret != -ENODEV && > > +((cyapa->gen == CYAPA_GEN3 && > > +cyapa->state >= CYAPA_STATE_BL_BUSY && > > +cyapa->state <= CYAPA_STATE_BL_ACTIVE) || > > +(cyapa->gen == CYAPA_GEN5 && > > +cyapa->state == CYAPA_STATE_GEN5_BL))) { > > +dev_warn(dev, "device detected, but no operatinal.\n"); > > +dev_warn(dev, "device gen=%d, state=0x%02x\n", > > +cyapa->gen, cyapa->state); > > +dev_warn(dev, "munually fw image recover required.\n"); > > +return 1; > > Hmm, what userspace uses this kind of notification? My idea is, when device waiting in bootloader for firmware image error, then the driver should keep actived, so user/system can have the chance to update the firmware to recover it. And you are correct, usersapce may don't know the return status of 1. We could add an sysfs interface, such state, so usersapce can read the state (0: operational, 1 or non-0: bootloader). > > > +} > > > > -input = cyapa->input = devm_input_allocate_device(dev); > > -if (!input) { > > -dev_err(dev, "allocate memory for input device failed\n"); > > -return -ENOMEM; > > +dev_err(dev, "no device detected, (%d)\n", ret); > > +kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp); > > +return ret; > > } > > > > -input->name = CYAPA_NAME; > > -input->phys = cyapa->phys; > > -input->id.bustype = BUS_I2C; > > -input->id.version = 1; > > -input->id.product = 0; /* means any product in eventcomm. */ > > -input->dev.parent = &cyapa->client->dev; > > +if (!cyapa->input) { > > +ret = cyapa_create_input_dev(cyapa); > > +if (ret) { > > +dev_err(dev, "create input_dev instance failed, (%d)\n", > > +ret); > > +return ret; > > +} > > > > -input_set_drvdata(input, cyapa); > > +/* > > + * On some systems, a system crash / warm boot does not reset > > + * the device's current power mode to FULL_ACTIVE. > > + * If such an event happens during suspend, after the device > > + * has been put in a low power mode, the device will still be > > + * in low power mode on a subsequent boot, since there was > > + * never a matching resume(). > > + * Handle this by always forcing full power here, when a > > + * device is first detected to be in operational mode. > > + */ > > +if (cyapa->ops->set_power_mode) { > > +ret = cyapa->ops->set_power_mode(cyapa, > > +PWR_MODE_FULL_ACTIVE, 0); > > +if (ret) > > +dev_warn(dev, "set active power failed, (%d)\n", > > +ret); > > +} > > +} > > > > -__set_bit(EV_ABS, input->evbit); > > +return 0; > > +} > > > > -/* finger position */ > > -input_set_abs_params(input, ABS_MT_POSITION_X, 0, cyapa->max_abs_x, 0, > > - 0); > > -input_set_abs_params(input, ABS_MT_POSITION_Y, 0, cyapa->max_abs_y, 0, > > - 0); > > -input_set_abs_params(input, ABS_MT_PRESSURE, 0, 255, 0, 0); > > +/* > > + * Sysfs Interface. > > + */ > > > > -input_abs_set_res(input, ABS_MT_POSITION_X, > > - cyapa->max_abs_x / cyapa->physical_size_x); > > -input_abs_set_res(input, ABS_MT_POSITION_Y, > > - cyapa->max_abs_y / cyapa->physical_size_y); > > +/* > > + * cyapa_sleep_time_to_pwr_cmd and cyapa_pwr_cmd_to_sleep_time > > + * > > + * These are helper functions that convert to and from integer idle > > + * times and register settings to write to the PowerMode register. > > + * The trackpad supports between 20ms to 1000ms scan intervals. > > + * The time will be increased in increments of 10ms from 20ms to 100ms. > > + * From 100ms to 1000ms, time will be increased in increments of 20ms. > > + * > > + * When Idle_Time < 100, the format to convert Idle_Time to Idle_Command is: > > + * Idle_Command = Idle Time / 10; > > + * When Idle_Time >= 100, the format to convert Idle_Time to Idle_Command is: > > + * Idle_Command = Idle Time / 20 + 5; > > + */ > > +u8 cyapa_sleep_time_to_pwr_cmd(u16 sleep_time) > > +{ > > +sleep_time = clamp_val(sleep_time, 20, 1000); > > > > -if (cyapa->btn_capability & CAPABILITY_LEFT_BTN_MASK) > > -__set_bit(BTN_LEFT, input->keybit); > > -if (cyapa->btn_capability & CAPABILITY_MIDDLE_BTN_MASK) > > -__set_bit(BTN_MIDDLE, input->keybit); > > -if (cyapa->btn_capability & CAPABILITY_RIGHT_BTN_MASK) > > -__set_bit(BTN_RIGHT, input->keybit); > > +if (sleep_time < 100) > > +return ((sleep_time / 10) << 2) & PWR_MODE_MASK; > > +return ((sleep_time / 20 + 5) << 2) & PWR_MODE_MASK; > > +} > > Maybe: > > encoded_time = sleep_time < 100 ? > sleep_time / 10 : sleep_time / 20 + 5; > return (encode_time << 2) & PWR_MODE_MASK; Thanks, applied. > > > > -if (cyapa->btn_capability == CAPABILITY_LEFT_BTN_MASK) > > -__set_bit(INPUT_PROP_BUTTONPAD, input->propbit); > > +u16 cyapa_pwr_cmd_to_sleep_time(u8 pwr_mode) > > +{ > > +u8 encoded_time = pwr_mode >> 2; > > > > -/* handle pointer emulation and unused slots in core */ > > -ret = input_mt_init_slots(input, CYAPA_MAX_MT_SLOTS, > > - INPUT_MT_POINTER | INPUT_MT_DROP_UNUSED); > > -if (ret) { > > -dev_err(dev, "allocate memory for MT slots failed, %d\n", ret); > > -goto err_free_device; > > -} > > +return (encoded_time < 10) ? encoded_time * 10 > > + : (encoded_time - 5) * 20; > > +} > > > > -/* Register the device in input subsystem */ > > -ret = input_register_device(input); > > -if (ret) { > > -dev_err(dev, "input device register failed, %d\n", ret); > > -goto err_free_device; > > -} > > -return 0; > > +/* > > + * Returns: > > + * 0 Driver and device initialization successfully done. > > + * > 0 Driver initialized and device is detected, but not operational yet. > > + * < 0 Device is not detected, or driver initialization failed. > > + */ > > +static int cyapa_initialize(struct cyapa *cyapa) > > +{ > > +cyapa->state = CYAPA_STATE_NO_DEVICE; > > +cyapa->gen = CYAPA_GEN_UNKNOWN; > > +mutex_init(&cyapa->state_sync_lock); > > > > -err_free_device: > > -input_free_device(input); > > -cyapa->input = NULL; > > -return ret; > > +/* > > + * Set to hard code default, they will be updated with trackpad set > > + * default values after probe and initialized. > > + */ > > +cyapa->suspend_power_mode = PWR_MODE_SLEEP; > > +cyapa->suspend_sleep_time = > > +cyapa_pwr_cmd_to_sleep_time(cyapa->suspend_power_mode); > > + > > +return cyapa_detect(cyapa); > > } > > > > static int cyapa_probe(struct i2c_client *client, > > @@ -830,6 +443,7 @@ static int cyapa_probe(struct i2c_client *client, > > u8 adapter_func; > > struct cyapa *cyapa; > > struct device *dev = &client->dev; > > +union i2c_smbus_data dummy; > > > > adapter_func = cyapa_check_adapter_functionality(client); > > if (adapter_func == CYAPA_ADAPTER_FUNC_NONE) { > > @@ -837,48 +451,39 @@ static int cyapa_probe(struct i2c_client *client, > > return -EIO; > > } > > > > +/* Make sure there is something at this address */ > > +if (i2c_smbus_xfer(client->adapter, client->addr, 0, > > +I2C_SMBUS_READ, 0, I2C_SMBUS_BYTE, &dummy) < 0) > > +return -ENODEV; > > + > > cyapa = devm_kzalloc(dev, sizeof(struct cyapa), GFP_KERNEL); > > if (!cyapa) > > return -ENOMEM; > > > > -cyapa->gen = CYAPA_GEN3; > > -cyapa->client = client; > > -i2c_set_clientdata(client, cyapa); > > -sprintf(cyapa->phys, "i2c-%d-%04x/input0", client->adapter->nr, > > -client->addr); > > - > > /* i2c isn't supported, use smbus */ > > if (adapter_func == CYAPA_ADAPTER_FUNC_SMBUS) > > cyapa->smbus = true; > > -cyapa->state = CYAPA_STATE_NO_DEVICE; > > -ret = cyapa_check_is_operational(cyapa); > > -if (ret) { > > -dev_err(dev, "device not operational, %d\n", ret); > > -return ret; > > -} > > > > -ret = cyapa_create_input_dev(cyapa); > > -if (ret) { > > -dev_err(dev, "create input_dev instance failed, %d\n", ret); > > -return ret; > > -} > > +cyapa->client = client; > > +i2c_set_clientdata(client, cyapa); > > +sprintf(cyapa->phys, "i2c-%d-%04x/input0", client->adapter->nr, > > +client->addr); > > > > -ret = cyapa_set_power_mode(cyapa, PWR_MODE_FULL_ACTIVE); > > -if (ret) { > > -dev_err(dev, "set active power failed, %d\n", ret); > > +ret = cyapa_initialize(cyapa); > > +if (ret < 0) { > > +dev_err(dev, "failed to detect and initialize tp device.\n"); > > return ret; > > } > > > > -cyapa->irq = client->irq; > > ret = devm_request_threaded_irq(dev, > > -cyapa->irq, > > +client->irq, > > NULL, > > cyapa_irq, > > IRQF_TRIGGER_FALLING | IRQF_ONESHOT, > > "cyapa", > > cyapa); > > if (ret) { > > -dev_err(dev, "IRQ request failed: %d\n, ", ret); > > +dev_err(dev, "failed to request threaded irq, (%d)\n, ", ret); > > return ret; > > } > > > > @@ -889,8 +494,10 @@ static int cyapa_remove(struct i2c_client *client) > > { > > struct cyapa *cyapa = i2c_get_clientdata(client); > > > > -disable_irq(cyapa->irq); > > -cyapa_set_power_mode(cyapa, PWR_MODE_OFF); > > +disable_irq(cyapa->client->irq); > > + > > +if (cyapa->ops->set_power_mode) > > +cyapa->ops->set_power_mode(cyapa, PWR_MODE_OFF, 0); > > > > return 0; > > } > > @@ -902,20 +509,38 @@ static int cyapa_suspend(struct device *dev) > > u8 power_mode; > > struct cyapa *cyapa = dev_get_drvdata(dev); > > > > -disable_irq(cyapa->irq); > > +ret = mutex_lock_interruptible(&cyapa->state_sync_lock); > > +if (ret) { > > +dev_err(dev, "suspend interrupted by signal, (%d)\n", ret); > > +return ret; > > +} > > For patterns: > > var = action(); > if (var) { > .. error handling ... > return var; > } > > return 0; > > i.e. when value of 'var' ony used in error handling path I strongly > prefer to call 'var' error. If you do return value of 'var' in both > error and success paths then 'ret' or 'retval' are preferred names. Thanks for the suggestion, I will update it to keep them consistence. > > > + > > +/* > > + * Disable IRQ to avoid the command response interrupt cause system > > + * suspending process interrupted and failed. > > + * Because the gen5 devices will always assert interrupt to host after > > + * executed the set power mode command. > > + */ > > +disable_irq(cyapa->client->irq); > > > > /* > > * Set trackpad device to idle mode if wakeup is allowed, > > * otherwise turn off. > > */ > > -power_mode = device_may_wakeup(dev) ? PWR_MODE_IDLE > > +power_mode = device_may_wakeup(dev) ? cyapa->suspend_power_mode > > : PWR_MODE_OFF; > > -ret = cyapa_set_power_mode(cyapa, power_mode); > > -if (ret < 0) > > -dev_err(dev, "set power mode failed, %d\n", ret); > > +if (cyapa->input && cyapa->ops->set_power_mode) { > > The gating on cyapa->input is not obvious. Should we check the device > status (or introduce one to indicate that the device in fully > initialized state). Also, instead of checking presence of various > methods I'd rather have providers supply stubs if they do not implement > something. I think it can be solved as your suggestion before for cyapa_detect() only return operational or not. and add other variable for detail of the device state. > > > +ret = cyapa->ops->set_power_mode(cyapa, power_mode, > > +cyapa->suspend_sleep_time); > > +if (ret < 0) > > +dev_err(dev, "suspend set power mode failed, %d\n", > > +ret); > > +} > > > > if (device_may_wakeup(dev)) > > -cyapa->irq_wake = (enable_irq_wake(cyapa->irq) == 0); > > +cyapa->irq_wake = (enable_irq_wake(cyapa->client->irq) == 0); > > + > > +mutex_unlock(&cyapa->state_sync_lock); > > return 0; > > } > > > > @@ -924,19 +549,29 @@ static int cyapa_resume(struct device *dev) > > int ret; > > struct cyapa *cyapa = dev_get_drvdata(dev); > > > > -if (device_may_wakeup(dev) && cyapa->irq_wake) > > -disable_irq_wake(cyapa->irq); > > - > > -ret = cyapa_set_power_mode(cyapa, PWR_MODE_FULL_ACTIVE); > > +ret = mutex_lock_interruptible(&cyapa->state_sync_lock); > > if (ret) > > -dev_warn(dev, "resume active power failed, %d\n", ret); > > +dev_err(dev, "resume interrupted by signal, (%d)\n", ret); > > > > -enable_irq(cyapa->irq); > > +if (cyapa->irq_wake) { > > +disable_irq_wake(cyapa->client->irq); > > +cyapa->irq_wake = false; > > +} > > + > > +/* Reset to active power state after re-detected. */ > > +cyapa_detect(cyapa); > > + > > +enable_irq(cyapa->client->irq); > > + > > +if (!ret) > > +mutex_unlock(&cyapa->state_sync_lock); > > return 0; > > } > > #endif /* CONFIG_PM_SLEEP */ > > > > -static SIMPLE_DEV_PM_OPS(cyapa_pm_ops, cyapa_suspend, cyapa_resume); > > +static const struct dev_pm_ops cyapa_pm_ops = { > > +SET_SYSTEM_SLEEP_PM_OPS(cyapa_suspend, cyapa_resume) > > +}; > > > > static const struct i2c_device_id cyapa_id_table[] = { > > { "cyapa", 0 }, > > diff --git a/drivers/input/mouse/cyapa.h b/drivers/input/mouse/cyapa.h > > new file mode 100644 > > index 0000000..ee97d7c > > --- /dev/null > > +++ b/drivers/input/mouse/cyapa.h > > @@ -0,0 +1,321 @@ > > +/* > > + * Cypress APA trackpad with I2C interface > > + * > > + * Author: Dudley Du <dudl@xxxxxxxxxxx> > > + * > > + * Copyright (C) 2014 Cypress Semiconductor, Inc. > > + * > > + * This file is subject to the terms and conditions of the GNU General Public > > + * License. See the file COPYING in the main directory of this archive for > > + * more details. > > + */ > > + > > +#ifndef _CYAPA_H > > +#define _CYAPA_H > > + > > +#include <linux/async.h> > > +#include <linux/firmware.h> > > +#include <linux/regulator/consumer.h> > > +#include <linux/regulator/driver.h> > > + > > +/* APA trackpad firmware generation number. */ > > +#define CYAPA_GEN_UNKNOWN 0x00 /* unknown protocol. */ > > +#define CYAPA_GEN3 0x03 /* support MT-protocol B with tracking ID. */ > > +#define CYAPA_GEN5 0x05 /* support TrueTouch GEN5 trackpad device. */ > > + > > +#define CYAPA_NAME "Cypress APA Trackpad (cyapa)" > > + > > +/* > > + * Macros for SMBus communication > > + */ > > +#define SMBUS_READ 0x01 > > +#define SMBUS_WRITE 0x00 > > +#define SMBUS_ENCODE_IDX(cmd, idx) ((cmd) | (((idx) & 0x03) << 1)) > > +#define SMBUS_ENCODE_RW(cmd, rw) ((cmd) | ((rw) & 0x01)) > > +#define SMBUS_BYTE_BLOCK_CMD_MASK 0x80 > > +#define SMBUS_GROUP_BLOCK_CMD_MASK 0x40 > > + > > +/* Commands for read/write registers of Cypress trackpad */ > > +#define CYAPA_CMD_SOFT_RESET 0x00 > > +#define CYAPA_CMD_POWER_MODE 0x01 > > +#define CYAPA_CMD_DEV_STATUS 0x02 > > +#define CYAPA_CMD_GROUP_DATA 0x03 > > +#define CYAPA_CMD_GROUP_CMD 0x04 > > +#define CYAPA_CMD_GROUP_QUERY 0x05 > > +#define CYAPA_CMD_BL_STATUS 0x06 > > +#define CYAPA_CMD_BL_HEAD 0x07 > > +#define CYAPA_CMD_BL_CMD 0x08 > > +#define CYAPA_CMD_BL_DATA 0x09 > > +#define CYAPA_CMD_BL_ALL 0x0a > > +#define CYAPA_CMD_BLK_PRODUCT_ID 0x0b > > +#define CYAPA_CMD_BLK_HEAD 0x0c > > +#define CYAPA_CMD_MAX_BASELINE 0x0d > > +#define CYAPA_CMD_MIN_BASELINE 0x0e > > + > > +#define BL_HEAD_OFFSET 0x00 > > +#define BL_DATA_OFFSET 0x10 > > + > > +#define BL_STATUS_SIZE 3 /* Length of gen3 bootloader status registers */ > > +#define CYAPA_REG_MAP_SIZE 256 > > + > > +/* > > + * Gen3 Operational Device Status Register > > + * > > + * bit 7: Valid interrupt source > > + * bit 6 - 4: Reserved > > + * bit 3 - 2: Power status > > + * bit 1 - 0: Device status > > + */ > > +#define REG_OP_STATUS 0x00 > > +#define OP_STATUS_SRC 0x80 > > +#define OP_STATUS_POWER 0x0c > > +#define OP_STATUS_DEV 0x03 > > +#define OP_STATUS_MASK (OP_STATUS_SRC | OP_STATUS_POWER | > OP_STATUS_DEV) > > + > > +/* > > + * Operational Finger Count/Button Flags Register > > + * > > + * bit 7 - 4: Number of touched finger > > + * bit 3: Valid data > > + * bit 2: Middle Physical Button > > + * bit 1: Right Physical Button > > + * bit 0: Left physical Button > > + */ > > +#define REG_OP_DATA1 0x01 > > +#define OP_DATA_VALID 0x08 > > +#define OP_DATA_MIDDLE_BTN 0x04 > > +#define OP_DATA_RIGHT_BTN 0x02 > > +#define OP_DATA_LEFT_BTN 0x01 > > +#define OP_DATA_BTN_MASK (OP_DATA_MIDDLE_BTN | OP_DATA_RIGHT_BTN > | \ > > + OP_DATA_LEFT_BTN) > > + > > +/* > > + * Write-only command file register used to issue commands and > > + * parameters to the bootloader. > > + * The default value read from it is always 0x00. > > + */ > > +#define REG_BL_FILE0x00 > > +#define BL_FILE0x00 > > + > > +/* > > + * Bootloader Status Register > > + * > > + * bit 7: Busy > > + * bit 6 - 5: Reserved > > + * bit 4: Bootloader running > > + * bit 3 - 2: Reserved > > + * bit 1: Watchdog Reset > > + * bit 0: Checksum valid > > + */ > > +#define REG_BL_STATUS 0x01 > > +#define BL_STATUS_REV_6_5 0x60 > > +#define BL_STATUS_BUSY 0x80 > > +#define BL_STATUS_RUNNING 0x10 > > +#define BL_STATUS_REV_3_2 0x0c > > +#define BL_STATUS_WATCHDOG 0x02 > > +#define BL_STATUS_CSUM_VALID 0x01 > > +#define BL_STATUS_REV_MASK (BL_STATUS_WATCHDOG | BL_STATUS_REV_3_2 > | \ > > + BL_STATUS_REV_6_5) > > + > > +/* > > + * Bootloader Error Register > > + * > > + * bit 7: Invalid > > + * bit 6: Invalid security key > > + * bit 5: Bootloading > > + * bit 4: Command checksum > > + * bit 3: Flash protection error > > + * bit 2: Flash checksum error > > + * bit 1 - 0: Reserved > > + */ > > +#define REG_BL_ERROR 0x02 > > +#define BL_ERROR_INVALID 0x80 > > +#define BL_ERROR_INVALID_KEY 0x40 > > +#define BL_ERROR_BOOTLOADING 0x20 > > +#define BL_ERROR_CMD_CSUM 0x10 > > +#define BL_ERROR_FLASH_PROT 0x08 > > +#define BL_ERROR_FLASH_CSUM 0x04 > > +#define BL_ERROR_RESERVED 0x03 > > +#define BL_ERROR_NO_ERR_IDLE 0x00 > > +#define BL_ERROR_NO_ERR_ACTIVE (BL_ERROR_BOOTLOADING) > > + > > +#define CAPABILITY_BTN_SHIFT 3 > > +#define CAPABILITY_LEFT_BTN_MASK(0x01 << 3) > > +#define CAPABILITY_RIGHT_BTN_MASK(0x01 << 4) > > +#define CAPABILITY_MIDDLE_BTN_MASK(0x01 << 5) > > +#define CAPABILITY_BTN_MASK (CAPABILITY_LEFT_BTN_MASK | \ > > + CAPABILITY_RIGHT_BTN_MASK | \ > > + CAPABILITY_MIDDLE_BTN_MASK) > > + > > +#define PWR_MODE_MASK 0xfc > > +#define PWR_MODE_FULL_ACTIVE (0x3f << 2) > > +#define PWR_MODE_IDLE (0x03 << 2) /* Default rt suspend scanrate: > 30ms */ > > +#define PWR_MODE_SLEEP (0x05 << 2) /* Default suspend scanrate: > 50ms */ > > +#define PWR_MODE_BTN_ONLY (0x01 << 2) > > +#define PWR_MODE_OFF (0x00 << 2) > > + > > +#define PWR_STATUS_MASK 0x0c > > +#define PWR_STATUS_ACTIVE (0x03 << 2) > > +#define PWR_STATUS_IDLE (0x02 << 2) > > +#define PWR_STATUS_BTN_ONLY (0x01 << 2) > > +#define PWR_STATUS_OFF (0x00 << 2) > > + > > +#define AUTOSUSPEND_DELAY 2000 /* unit : ms */ > > + > > +#define UNINIT_SLEEP_TIME 0xFFFF > > +#define UNINIT_PWR_MODE 0xFF > > + > > +#define BTN_ONLY_MODE_NAME "buttononly" > > +#define OFF_MODE_NAME "off" > > + > > +/* The touch.id is used as the MT slot id, thus max MT slot is 15 */ > > +#define CYAPA_MAX_MT_SLOTS 15 > > + > > +struct cyapa; > > + > > +typedef bool (*cb_sort)(struct cyapa *, u8 *, int); > > + > > +struct cyapa_dev_ops { > > +int (*check_fw)(struct cyapa *, const struct firmware *); > > +int (*bl_enter)(struct cyapa *); > > +int (*bl_activate)(struct cyapa *); > > +int (*bl_initiate)(struct cyapa *, const struct firmware *); > > +int (*update_fw)(struct cyapa *, const struct firmware *); > > +int (*bl_verify_app_integrity)(struct cyapa *); > > +int (*bl_deactivate)(struct cyapa *); > > + > > +ssize_t (*show_baseline)(struct device *, > > +struct device_attribute *, char *); > > +ssize_t (*calibrate_store)(struct device *, > > +struct device_attribute *, const char *, size_t); > > + > > +int (*initialize)(struct cyapa *cyapa); > > + > > +int (*state_parse)(struct cyapa *cyapa, u8 *reg_status, int len); > > +int (*operational_check)(struct cyapa *cyapa); > > + > > +int (*irq_handler)(struct cyapa *); > > +bool (*irq_cmd_handler)(struct cyapa *); > > +int (*sort_empty_output_data)(struct cyapa *, > > +u8 *, int *, cb_sort); > > + > > +int (*set_power_mode)(struct cyapa *, u8, u16); > > +}; > > + > > +struct cyapa_gen5_cmd_states { > > +struct mutex cmd_lock; > > +struct completion cmd_ready; > > +atomic_t cmd_issued; > > +u8 in_progress_cmd; > > +bool is_irq_mode; > > + > > +cb_sort resp_sort_func; > > +u8 *resp_data; > > +int *resp_len; > > + > > +u8 irq_cmd_buf[CYAPA_REG_MAP_SIZE]; > > +u8 empty_buf[CYAPA_REG_MAP_SIZE]; > > +}; > > + > > +union cyapa_cmd_states { > > +struct cyapa_gen5_cmd_states gen5; > > +}; > > + > > +enum cyapa_state { > > +CYAPA_STATE_NO_DEVICE, > > +CYAPA_STATE_BL_BUSY, > > +CYAPA_STATE_BL_IDLE, > > +CYAPA_STATE_BL_ACTIVE, > > +CYAPA_STATE_OP, > > +CYAPA_STATE_GEN5_BL, > > +CYAPA_STATE_GEN5_APP, > > +}; > > + > > +struct cyapa_tsg_bin_image_head { > > +u8 head_size; /* Unit: bytes, including itself. */ > > +u8 ttda_driver_major_version; /* Reserved as 0. */ > > +u8 ttda_driver_minor_version; /* Reserved as 0. */ > > +u8 fw_major_version; > > +u8 fw_minor_version; > > +u8 fw_revision_control_number[8]; > > +} __packed; > > + > > +/* The main device structure */ > > +struct cyapa { > > +enum cyapa_state state; > > +u8 status[BL_STATUS_SIZE]; > > + > > +struct i2c_client *client; > > +struct input_dev *input; > > +char phys[32];/* Device physical location */ > > +bool irq_wake; /* Irq wake is enabled */ > > +bool smbus; > > + > > +/* power mode settings */ > > +u8 suspend_power_mode; > > +u16 suspend_sleep_time; > > +#ifdef CONFIG_PM_RUNTIME > > +u8 runtime_suspend_power_mode; > > +u16 runtime_suspend_sleep_time; > > +#endif /* CONFIG_PM_RUNTIME */ > > This I think should be introduce later, with runtime PM changes. Thanks. > > > +u8 dev_pwr_mode; > > +u16 dev_sleep_time; > > + > > +/* Read from query data region. */ > > +char product_id[16]; > > +u8 fw_maj_ver; /* Firmware major version. */ > > +u8 fw_min_ver; /* Firmware minor version. */ > > +u8 btn_capability; > > +u8 gen; > > +int max_abs_x; > > +int max_abs_y; > > +int physical_size_x; > > +int physical_size_y; > > + > > +/* Used in ttsp and truetouch based trackpad devices. */ > > +u8 x_origin; /* X Axis Origin: 0 = left side; 1 = rigth side. */ > > +u8 y_origin; /* Y Axis Origin: 0 = top; 1 = bottom. */ > > +int electrodes_x; /* Number of electrodes on the X Axis*/ > > +int electrodes_y; /* Number of electrodes on the Y Axis*/ > > +int electrodes_rx; /* Number of Rx electrodes */ > > +int max_z; > > + > > +/* > > + * Used to synchronize the access or update the device state. > > + * And since update firmware and read firmware image process will take > > + * quite long time, maybe more than 10 seconds, so use mutex_lock > > + * to sync and wait other interface and detecting are done or ready. > > + */ > > +struct mutex state_sync_lock; > > + > > +const struct cyapa_dev_ops *ops; > > + > > +union cyapa_cmd_states cmd_states; > > +}; > > + > > + > > +ssize_t cyapa_i2c_reg_read_block(struct cyapa *cyapa, u8 reg, size_t len, > > +u8 *values); > > +ssize_t cyapa_i2c_reg_write_block(struct cyapa *cyapa, u8 reg, > > +size_t len, const u8 *values); > > +ssize_t cyapa_smbus_read_block(struct cyapa *cyapa, u8 cmd, size_t len, > > +u8 *values); > > + > > +s32 cyapa_read_byte(struct cyapa *cyapa, u8 cmd_idx); > > +s32 cyapa_write_byte(struct cyapa *cyapa, u8 cmd_idx, u8 value); > > Do we still use these 2 fucntions? You are correct, Thanks. It has been moved to and only used in cyapa_gen3.c. > > > +ssize_t cyapa_read_block(struct cyapa *cyapa, u8 cmd_idx, u8 *values); > > + > > +ssize_t cyapa_i2c_read(struct cyapa *cyapa, u8 reg, size_t len, u8 *values); > > +ssize_t cyapa_i2c_write(struct cyapa *cyapa, u8 reg, > > +size_t len, const void *values); > > + > > +int cyapa_poll_state(struct cyapa *cyapa, unsigned int timeout); > > +int cyapa_detect(struct cyapa *cyapa); > > + > > +u8 cyapa_sleep_time_to_pwr_cmd(u16 sleep_time); > > +u16 cyapa_pwr_cmd_to_sleep_time(u8 pwr_mode); > > + > > + > > +extern const char unique_str[]; > > + > > +#endif > > -- > > 1.9.1 > > > > Thanks. > > -- > Dmitry This message and any attachments may contain Cypress (or its subsidiaries) confidential information. If it has been received in error, please advise the sender and immediately delete this message. -- To unsubscribe from this list: send the line "unsubscribe linux-input" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
