cregit-Linux how code gets into the kernel

Release 4.11 drivers/input/touchscreen/raydium_i2c_ts.c

/*
 * Raydium touchscreen I2C driver.
 *
 * Copyright (C) 2012-2014, Raydium Semiconductor Corporation.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2, and only version 2, as published by the
 * Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * Raydium reserves the right to make changes without further notice
 * to the materials described herein. Raydium does not assume any
 * liability arising out of the application described herein.
 *
 * Contact Raydium Semiconductor Corporation at www.rad-ic.com
 */

#include <linux/acpi.h>
#include <linux/delay.h>
#include <linux/firmware.h>
#include <linux/gpio/consumer.h>
#include <linux/i2c.h>
#include <linux/input.h>
#include <linux/input/mt.h>
#include <linux/interrupt.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/regulator/consumer.h>
#include <linux/slab.h>
#include <asm/unaligned.h>

/* Slave I2C mode */

#define RM_BOOT_BLDR		0x02

#define RM_BOOT_MAIN		0x03

/* I2C bootoloader commands */

#define RM_CMD_BOOT_PAGE_WRT	0x0B		
/* send bl page write */

#define RM_CMD_BOOT_WRT		0x11		
/* send bl write */

#define RM_CMD_BOOT_ACK		0x22		
/* send ack*/

#define RM_CMD_BOOT_CHK		0x33		
/* send data check */

#define RM_CMD_BOOT_READ	0x44		
/* send wait bl data ready*/


#define RM_BOOT_RDY		0xFF		
/* bl data ready */

/* I2C main commands */

#define RM_CMD_QUERY_BANK	0x2B

#define RM_CMD_DATA_BANK	0x4D

#define RM_CMD_ENTER_SLEEP	0x4E

#define RM_CMD_BANK_SWITCH	0xAA


#define RM_RESET_MSG_ADDR	0x40000004


#define RM_MAX_READ_SIZE	56

#define RM_PACKET_CRC_SIZE	2

/* Touch relative info */

#define RM_MAX_RETRIES		3

#define RM_MAX_TOUCH_NUM	10

#define RM_BOOT_DELAY_MS	100

/* Offsets in contact data */

#define RM_CONTACT_STATE_POS	0

#define RM_CONTACT_X_POS	1

#define RM_CONTACT_Y_POS	3

#define RM_CONTACT_PRESSURE_POS	5

#define RM_CONTACT_WIDTH_X_POS	6

#define RM_CONTACT_WIDTH_Y_POS	7

/* Bootloader relative info */

#define RM_BL_WRT_CMD_SIZE	3	
/* bl flash wrt cmd size */

#define RM_BL_WRT_PKG_SIZE	32	
/* bl wrt pkg size */

#define RM_BL_WRT_LEN		(RM_BL_WRT_PKG_SIZE + RM_BL_WRT_CMD_SIZE)

#define RM_FW_PAGE_SIZE		128

#define RM_MAX_FW_RETRIES	30

#define RM_MAX_FW_SIZE		0xD000


#define RM_POWERON_DELAY_USEC	500

#define RM_RESET_DELAY_MSEC	50


enum raydium_bl_cmd {
	
BL_HEADER = 0,
	
BL_PAGE_STR,
	
BL_PKG_IDX,
	
BL_DATA_STR,
};


enum raydium_bl_ack {
	
RAYDIUM_ACK_NULL = 0,
	
RAYDIUM_WAIT_READY,
	
RAYDIUM_PATH_READY,
};


enum raydium_boot_mode {
	
RAYDIUM_TS_MAIN = 0,
	
RAYDIUM_TS_BLDR,
};

/* Response to RM_CMD_DATA_BANK request */

struct raydium_data_info {
	
__le32 data_bank_addr;
	
u8 pkg_size;
	
u8 tp_info_size;
};


struct raydium_info {
	
__le32 hw_ver;		/*device version */
	
u8 main_ver;
	
u8 sub_ver;
	
__le16 ft_ver;		/* test version */
	
u8 x_num;
	
u8 y_num;
	
__le16 x_max;
	
__le16 y_max;
	
u8 x_res;		/* units/mm */
	
u8 y_res;		/* units/mm */
};

/* struct raydium_data - represents state of Raydium touchscreen device */

struct raydium_data {
	
struct i2c_client *client;
	
struct input_dev *input;

	
struct regulator *avdd;
	
struct regulator *vccio;
	
struct gpio_desc *reset_gpio;

	
struct raydium_info info;

	
struct mutex sysfs_mutex;

	
u8 *report_data;

	
u32 data_bank_addr;
	
u8 report_size;
	
u8 contact_size;
	
u8 pkg_size;

	
enum raydium_boot_mode boot_mode;

	
bool wake_irq_enabled;
};


static int raydium_i2c_send(struct i2c_client *client, u8 addr, const void *data, size_t len) { u8 *buf; int tries = 0; int ret; buf = kmalloc(len + 1, GFP_KERNEL); if (!buf) return -ENOMEM; buf[0] = addr; memcpy(buf + 1, data, len); do { ret = i2c_master_send(client, buf, len + 1); if (likely(ret == len + 1)) break; msleep(20); } while (++tries < RM_MAX_RETRIES); kfree(buf); if (unlikely(ret != len + 1)) { if (ret >= 0) ret = -EIO; dev_err(&client->dev, "%s failed: %d\n", __func__, ret); return ret; } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Jeffrey Lin162100.00%1100.00%
Total162100.00%1100.00%


static int raydium_i2c_read(struct i2c_client *client, u8 addr, void *data, size_t len) { struct i2c_msg xfer[] = { { .addr = client->addr, .len = 1, .buf = &addr, }, { .addr = client->addr, .flags = I2C_M_RD, .len = len, .buf = data, } }; int ret; ret = i2c_transfer(client->adapter, xfer, ARRAY_SIZE(xfer)); if (unlikely(ret != ARRAY_SIZE(xfer))) return ret < 0 ? ret : -EIO; return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Jeffrey Lin116100.00%1100.00%
Total116100.00%1100.00%


static int raydium_i2c_read_message(struct i2c_client *client, u32 addr, void *data, size_t len) { __be32 be_addr; size_t xfer_len; int error; while (len) { xfer_len = min_t(size_t, len, RM_MAX_READ_SIZE); be_addr = cpu_to_be32(addr); error = raydium_i2c_send(client, RM_CMD_BANK_SWITCH, &be_addr, sizeof(be_addr)); if (!error) error = raydium_i2c_read(client, addr & 0xff, data, xfer_len); if (error) return error; len -= xfer_len; data += xfer_len; addr += xfer_len; } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Jeffrey Lin113100.00%1100.00%
Total113100.00%1100.00%


static int raydium_i2c_send_message(struct i2c_client *client, u32 addr, const void *data, size_t len) { __be32 be_addr = cpu_to_be32(addr); int error; error = raydium_i2c_send(client, RM_CMD_BANK_SWITCH, &be_addr, sizeof(be_addr)); if (!error) error = raydium_i2c_send(client, addr & 0xff, data, len); return error; }

Contributors

PersonTokensPropCommitsCommitProp
Jeffrey Lin73100.00%1100.00%
Total73100.00%1100.00%


static int raydium_i2c_sw_reset(struct i2c_client *client) { const u8 soft_rst_cmd = 0x01; int error; error = raydium_i2c_send_message(client, RM_RESET_MSG_ADDR, &soft_rst_cmd, sizeof(soft_rst_cmd)); if (error) { dev_err(&client->dev, "software reset failed: %d\n", error); return error; } msleep(RM_RESET_DELAY_MSEC); return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Jeffrey Lin66100.00%1100.00%
Total66100.00%1100.00%


static int raydium_i2c_query_ts_info(struct raydium_data *ts) { struct i2c_client *client = ts->client; struct raydium_data_info data_info; __le32 query_bank_addr; int error, retry_cnt; for (retry_cnt = 0; retry_cnt < RM_MAX_RETRIES; retry_cnt++) { error = raydium_i2c_read(client, RM_CMD_DATA_BANK, &data_info, sizeof(data_info)); if (error) continue; /* * Warn user if we already allocated memory for reports and * then the size changed (due to firmware update?) and keep * old size instead. */ if (ts->report_data && ts->pkg_size != data_info.pkg_size) { dev_warn(&client->dev, "report size changes, was: %d, new: %d\n", ts->pkg_size, data_info.pkg_size); } else { ts->pkg_size = data_info.pkg_size; ts->report_size = ts->pkg_size - RM_PACKET_CRC_SIZE; } ts->contact_size = data_info.tp_info_size; ts->data_bank_addr = le32_to_cpu(data_info.data_bank_addr); dev_dbg(&client->dev, "data_bank_addr: %#08x, report_size: %d, contact_size: %d\n", ts->data_bank_addr, ts->report_size, ts->contact_size); error = raydium_i2c_read(client, RM_CMD_QUERY_BANK, &query_bank_addr, sizeof(query_bank_addr)); if (error) continue; error = raydium_i2c_read_message(client, le32_to_cpu(query_bank_addr), &ts->info, sizeof(ts->info)); if (error) continue; return 0; } dev_err(&client->dev, "failed to query device parameters: %d\n", error); return error; }

Contributors

PersonTokensPropCommitsCommitProp
Jeffrey Lin235100.00%2100.00%
Total235100.00%2100.00%


static int raydium_i2c_check_fw_status(struct raydium_data *ts) { struct i2c_client *client = ts->client; static const u8 bl_ack = 0x62; static const u8 main_ack = 0x66; u8 buf[4]; int error; error = raydium_i2c_read(client, RM_CMD_BOOT_READ, buf, sizeof(buf)); if (!error) { if (buf[0] == bl_ack) ts->boot_mode = RAYDIUM_TS_BLDR; else if (buf[0] == main_ack) ts->boot_mode = RAYDIUM_TS_MAIN; return 0; } return error; }

Contributors

PersonTokensPropCommitsCommitProp
Jeffrey Lin103100.00%1100.00%
Total103100.00%1100.00%


static int raydium_i2c_initialize(struct raydium_data *ts) { struct i2c_client *client = ts->client; int error, retry_cnt; for (retry_cnt = 0; retry_cnt < RM_MAX_RETRIES; retry_cnt++) { /* Wait for Hello packet */ msleep(RM_BOOT_DELAY_MS); error = raydium_i2c_check_fw_status(ts); if (error) { dev_err(&client->dev, "failed to read 'hello' packet: %d\n", error); continue; } if (ts->boot_mode == RAYDIUM_TS_BLDR || ts->boot_mode == RAYDIUM_TS_MAIN) { break; } } if (error) ts->boot_mode = RAYDIUM_TS_BLDR; if (ts->boot_mode == RAYDIUM_TS_BLDR) { ts->info.hw_ver = cpu_to_le32(0xffffffffUL); ts->info.main_ver = 0xff; ts->info.sub_ver = 0xff; } else { raydium_i2c_query_ts_info(ts); } return error; }

Contributors

PersonTokensPropCommitsCommitProp
Jeffrey Lin147100.00%1100.00%
Total147100.00%1100.00%


static int raydium_i2c_bl_chk_state(struct i2c_client *client, enum raydium_bl_ack state) { static const u8 ack_ok[] = { 0xFF, 0x39, 0x30, 0x30, 0x54 }; u8 rbuf[sizeof(ack_ok)]; u8 retry; int error; for (retry = 0; retry < RM_MAX_FW_RETRIES; retry++) { switch (state) { case RAYDIUM_ACK_NULL: return 0; case RAYDIUM_WAIT_READY: error = raydium_i2c_read(client, RM_CMD_BOOT_CHK, &rbuf[0], 1); if (!error && rbuf[0] == RM_BOOT_RDY) return 0; break; case RAYDIUM_PATH_READY: error = raydium_i2c_read(client, RM_CMD_BOOT_CHK, rbuf, sizeof(rbuf)); if (!error && !memcmp(rbuf, ack_ok, sizeof(ack_ok))) return 0; break; default: dev_err(&client->dev, "%s: invalid target state %d\n", __func__, state); return -EINVAL; } msleep(20); } return -ETIMEDOUT; }

Contributors

PersonTokensPropCommitsCommitProp
Jeffrey Lin180100.00%1100.00%
Total180100.00%1100.00%


static int raydium_i2c_write_object(struct i2c_client *client, const void *data, size_t len, enum raydium_bl_ack state) { int error; error = raydium_i2c_send(client, RM_CMD_BOOT_WRT, data, len); if (error) { dev_err(&client->dev, "WRT obj command failed: %d\n", error); return error; } error = raydium_i2c_send(client, RM_CMD_BOOT_ACK, NULL, 0); if (error) { dev_err(&client->dev, "Ack obj command failed: %d\n", error); return error; } error = raydium_i2c_bl_chk_state(client, state); if (error) { dev_err(&client->dev, "BL check state failed: %d\n", error); return error; } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Jeffrey Lin127100.00%1100.00%
Total127100.00%1100.00%


static bool raydium_i2c_boot_trigger(struct i2c_client *client) { static const u8 cmd[7][6] = { { 0x08, 0x0C, 0x09, 0x00, 0x50, 0xD7 }, { 0x08, 0x04, 0x09, 0x00, 0x50, 0xA5 }, { 0x08, 0x04, 0x09, 0x00, 0x50, 0x00 }, { 0x08, 0x04, 0x09, 0x00, 0x50, 0xA5 }, { 0x08, 0x0C, 0x09, 0x00, 0x50, 0x00 }, { 0x06, 0x01, 0x00, 0x00, 0x00, 0x00 }, { 0x02, 0xA2, 0x00, 0x00, 0x00, 0x00 }, }; int i; int error; for (i = 0; i < 7; i++) { error = raydium_i2c_write_object(client, cmd[i], sizeof(cmd[i]), RAYDIUM_WAIT_READY); if (error) { dev_err(&client->dev, "boot trigger failed at step %d: %d\n", i, error); return error; } } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Jeffrey Lin191100.00%1100.00%
Total191100.00%1100.00%


static bool raydium_i2c_fw_trigger(struct i2c_client *client) { static const u8 cmd[5][11] = { { 0, 0x09, 0x71, 0x0C, 0x09, 0x00, 0x50, 0xD7, 0, 0, 0 }, { 0, 0x09, 0x71, 0x04, 0x09, 0x00, 0x50, 0xA5, 0, 0, 0 }, { 0, 0x09, 0x71, 0x04, 0x09, 0x00, 0x50, 0x00, 0, 0, 0 }, { 0, 0x09, 0x71, 0x04, 0x09, 0x00, 0x50, 0xA5, 0, 0, 0 }, { 0, 0x09, 0x71, 0x0C, 0x09, 0x00, 0x50, 0x00, 0, 0, 0 }, }; int i; int error; for (i = 0; i < 5; i++) { error = raydium_i2c_write_object(client, cmd[i], sizeof(cmd[i]), RAYDIUM_ACK_NULL); if (error) { dev_err(&client->dev, "fw trigger failed at step %d: %d\n", i, error); return error; } } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Jeffrey Lin213100.00%1100.00%
Total213100.00%1100.00%


static int raydium_i2c_check_path(struct i2c_client *client) { static const u8 cmd[] = { 0x09, 0x00, 0x09, 0x00, 0x50, 0x10, 0x00 }; int error; error = raydium_i2c_write_object(client, cmd, sizeof(cmd), RAYDIUM_PATH_READY); if (error) { dev_err(&client->dev, "check path command failed: %d\n", error); return error; } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Jeffrey Lin76100.00%1100.00%
Total76100.00%1100.00%


static int raydium_i2c_enter_bl(struct i2c_client *client) { static const u8 cal_cmd[] = { 0x00, 0x01, 0x52 }; int error; error = raydium_i2c_write_object(client, cal_cmd, sizeof(cal_cmd), RAYDIUM_ACK_NULL); if (error) { dev_err(&client->dev, "enter bl command failed: %d\n", error); return error; } msleep(RM_BOOT_DELAY_MS); return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Jeffrey Lin73100.00%1100.00%
Total73100.00%1100.00%


static int raydium_i2c_leave_bl(struct i2c_client *client) { static const u8 leave_cmd[] = { 0x05, 0x00 }; int error; error = raydium_i2c_write_object(client, leave_cmd, sizeof(leave_cmd), RAYDIUM_ACK_NULL); if (error) { dev_err(&client->dev, "leave bl command failed: %d\n", error); return error; } msleep(RM_BOOT_DELAY_MS); return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Jeffrey Lin71100.00%1100.00%
Total71100.00%1100.00%


static int raydium_i2c_write_checksum(struct i2c_client *client, size_t length, u16 checksum) { u8 checksum_cmd[] = { 0x00, 0x05, 0x6D, 0x00, 0x00, 0x00, 0x00 }; int error; put_unaligned_le16(length, &checksum_cmd[3]); put_unaligned_le16(checksum, &checksum_cmd[5]); error = raydium_i2c_write_object(client, checksum_cmd, sizeof(checksum_cmd), RAYDIUM_ACK_NULL); if (error) { dev_err(&client->dev, "failed to write checksum: %d\n", error); return error; } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Jeffrey Lin102100.00%1100.00%
Total102100.00%1100.00%


static int raydium_i2c_disable_watch_dog(struct i2c_client *client) { static const u8 cmd[] = { 0x0A, 0xAA }; int error; error = raydium_i2c_write_object(client, cmd, sizeof(cmd), RAYDIUM_WAIT_READY); if (error) { dev_err(&client->dev, "disable watchdog command failed: %d\n", error); return error; } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Jeffrey Lin66100.00%1100.00%
Total66100.00%1100.00%


static int raydium_i2c_fw_write_page(struct i2c_client *client, u16 page_idx, const void *data, size_t len) { u8 buf[RM_BL_WRT_LEN]; size_t xfer_len; int error; int i; BUILD_BUG_ON((RM_FW_PAGE_SIZE % RM_BL_WRT_PKG_SIZE) != 0); for (i = 0; i < RM_FW_PAGE_SIZE / RM_BL_WRT_PKG_SIZE; i++) { buf[BL_HEADER] = RM_CMD_BOOT_PAGE_WRT; buf[BL_PAGE_STR] = page_idx ? 0xff : 0; buf[BL_PKG_IDX] = i + 1; xfer_len = min_t(size_t, len, RM_BL_WRT_PKG_SIZE); memcpy(&buf[BL_DATA_STR], data, xfer_len); if (len < RM_BL_WRT_PKG_SIZE) memset(&buf[BL_DATA_STR + xfer_len], 0xff, RM_BL_WRT_PKG_SIZE - xfer_len); error = raydium_i2c_write_object(client, buf, RM_BL_WRT_LEN, RAYDIUM_WAIT_READY); if (error) { dev_err(&client->dev, "page write command failed for page %d, chunk %d: %d\n", page_idx, i, error); return error; } data += xfer_len; len -= xfer_len; } return error; }

Contributors

PersonTokensPropCommitsCommitProp
Jeffrey Lin188100.00%1100.00%
Total188100.00%1100.00%


static u16 raydium_calc_chksum(const u8 *buf, u16 len) { u16 checksum = 0; u16 i; for (i = 0; i < len; i++) checksum += buf[i]; return checksum; }

Contributors

PersonTokensPropCommitsCommitProp
Jeffrey Lin45100.00%1100.00%
Total45100.00%1100.00%


static int raydium_i2c_do_update_firmware(struct raydium_data *ts, const struct firmware *fw) { struct i2c_client *client = ts->client; const void *data; size_t data_len; size_t len; int page_nr; int i; int error; u16 fw_checksum; if (fw->size == 0 || fw->size > RM_MAX_FW_SIZE) { dev_err(&client->dev, "Invalid firmware length\n"); return -EINVAL; } error = raydium_i2c_check_fw_status(ts); if (error) { dev_err(&client->dev, "Unable to access IC %d\n", error); return error; } if (ts->boot_mode == RAYDIUM_TS_MAIN) { for (i = 0; i < RM_MAX_RETRIES; i++) { error = raydium_i2c_enter_bl(client); if (!error) { error = raydium_i2c_check_fw_status(ts); if (error) { dev_err(&client->dev, "unable to access IC: %d\n", error); return error; } if (ts->boot_mode == RAYDIUM_TS_BLDR) break; } } if (ts->boot_mode == RAYDIUM_TS_MAIN) { dev_err(&client->dev, "failed to jump to boot loader: %d\n", error); return -EIO; } } error = raydium_i2c_disable_watch_dog(client); if (error) return error; error = raydium_i2c_check_path(client); if (error) return error; error = raydium_i2c_boot_trigger(client); if (error) { dev_err(&client->dev, "send boot trigger fail: %d\n", error); return error; } msleep(RM_BOOT_DELAY_MS); data = fw->data; data_len = fw->size; page_nr = 0; while (data_len) { len = min_t(size_t, data_len, RM_FW_PAGE_SIZE); error = raydium_i2c_fw_write_page(client, page_nr++, data, len); if (error) return error; msleep(20); data += len; data_len -= len; } error = raydium_i2c_leave_bl(client); if (error) { dev_err(&client->dev, "failed to leave boot loader: %d\n", error); return error; } dev_dbg(&client->dev, "left boot loader mode\n");