melfas_mip4.c 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605
  1. // SPDX-License-Identifier: GPL-2.0-or-later
  2. /*
  3. * MELFAS MIP4 Touchscreen
  4. *
  5. * Copyright (C) 2016 MELFAS Inc.
  6. *
  7. * Author : Sangwon Jee <[email protected]>
  8. */
  9. #include <linux/acpi.h>
  10. #include <linux/delay.h>
  11. #include <linux/firmware.h>
  12. #include <linux/gpio/consumer.h>
  13. #include <linux/i2c.h>
  14. #include <linux/input.h>
  15. #include <linux/input/mt.h>
  16. #include <linux/interrupt.h>
  17. #include <linux/module.h>
  18. #include <linux/of.h>
  19. #include <linux/slab.h>
  20. #include <asm/unaligned.h>
  21. #define MIP4_DEVICE_NAME "mip4_ts"
  22. /*****************************************************************
  23. * Protocol
  24. * Version : MIP 4.0 Rev 5.4
  25. *****************************************************************/
  26. /* Address */
  27. #define MIP4_R0_BOOT 0x00
  28. #define MIP4_R1_BOOT_MODE 0x01
  29. #define MIP4_R1_BOOT_BUF_ADDR 0x10
  30. #define MIP4_R1_BOOT_STATUS 0x20
  31. #define MIP4_R1_BOOT_CMD 0x30
  32. #define MIP4_R1_BOOT_TARGET_ADDR 0x40
  33. #define MIP4_R1_BOOT_SIZE 0x44
  34. #define MIP4_R0_INFO 0x01
  35. #define MIP4_R1_INFO_PRODUCT_NAME 0x00
  36. #define MIP4_R1_INFO_RESOLUTION_X 0x10
  37. #define MIP4_R1_INFO_RESOLUTION_Y 0x12
  38. #define MIP4_R1_INFO_NODE_NUM_X 0x14
  39. #define MIP4_R1_INFO_NODE_NUM_Y 0x15
  40. #define MIP4_R1_INFO_KEY_NUM 0x16
  41. #define MIP4_R1_INFO_PRESSURE_NUM 0x17
  42. #define MIP4_R1_INFO_LENGTH_X 0x18
  43. #define MIP4_R1_INFO_LENGTH_Y 0x1A
  44. #define MIP4_R1_INFO_PPM_X 0x1C
  45. #define MIP4_R1_INFO_PPM_Y 0x1D
  46. #define MIP4_R1_INFO_VERSION_BOOT 0x20
  47. #define MIP4_R1_INFO_VERSION_CORE 0x22
  48. #define MIP4_R1_INFO_VERSION_APP 0x24
  49. #define MIP4_R1_INFO_VERSION_PARAM 0x26
  50. #define MIP4_R1_INFO_SECT_BOOT_START 0x30
  51. #define MIP4_R1_INFO_SECT_BOOT_END 0x31
  52. #define MIP4_R1_INFO_SECT_CORE_START 0x32
  53. #define MIP4_R1_INFO_SECT_CORE_END 0x33
  54. #define MIP4_R1_INFO_SECT_APP_START 0x34
  55. #define MIP4_R1_INFO_SECT_APP_END 0x35
  56. #define MIP4_R1_INFO_SECT_PARAM_START 0x36
  57. #define MIP4_R1_INFO_SECT_PARAM_END 0x37
  58. #define MIP4_R1_INFO_BUILD_DATE 0x40
  59. #define MIP4_R1_INFO_BUILD_TIME 0x44
  60. #define MIP4_R1_INFO_CHECKSUM_PRECALC 0x48
  61. #define MIP4_R1_INFO_CHECKSUM_REALTIME 0x4A
  62. #define MIP4_R1_INFO_PROTOCOL_NAME 0x50
  63. #define MIP4_R1_INFO_PROTOCOL_VERSION 0x58
  64. #define MIP4_R1_INFO_IC_ID 0x70
  65. #define MIP4_R1_INFO_IC_NAME 0x71
  66. #define MIP4_R1_INFO_IC_VENDOR_ID 0x75
  67. #define MIP4_R1_INFO_IC_HW_CATEGORY 0x77
  68. #define MIP4_R1_INFO_CONTACT_THD_SCR 0x78
  69. #define MIP4_R1_INFO_CONTACT_THD_KEY 0x7A
  70. #define MIP4_R1_INFO_PID 0x7C
  71. #define MIP4_R1_INFO_VID 0x7E
  72. #define MIP4_R1_INFO_SLAVE_ADDR 0x80
  73. #define MIP4_R0_EVENT 0x02
  74. #define MIP4_R1_EVENT_SUPPORTED_FUNC 0x00
  75. #define MIP4_R1_EVENT_FORMAT 0x04
  76. #define MIP4_R1_EVENT_SIZE 0x06
  77. #define MIP4_R1_EVENT_PACKET_INFO 0x10
  78. #define MIP4_R1_EVENT_PACKET_DATA 0x11
  79. #define MIP4_R0_CTRL 0x06
  80. #define MIP4_R1_CTRL_READY_STATUS 0x00
  81. #define MIP4_R1_CTRL_EVENT_READY 0x01
  82. #define MIP4_R1_CTRL_MODE 0x10
  83. #define MIP4_R1_CTRL_EVENT_TRIGGER_TYPE 0x11
  84. #define MIP4_R1_CTRL_RECALIBRATE 0x12
  85. #define MIP4_R1_CTRL_POWER_STATE 0x13
  86. #define MIP4_R1_CTRL_GESTURE_TYPE 0x14
  87. #define MIP4_R1_CTRL_DISABLE_ESD_ALERT 0x18
  88. #define MIP4_R1_CTRL_CHARGER_MODE 0x19
  89. #define MIP4_R1_CTRL_HIGH_SENS_MODE 0x1A
  90. #define MIP4_R1_CTRL_WINDOW_MODE 0x1B
  91. #define MIP4_R1_CTRL_PALM_REJECTION 0x1C
  92. #define MIP4_R1_CTRL_EDGE_CORRECTION 0x1D
  93. #define MIP4_R1_CTRL_ENTER_GLOVE_MODE 0x1E
  94. #define MIP4_R1_CTRL_I2C_ON_LPM 0x1F
  95. #define MIP4_R1_CTRL_GESTURE_DEBUG 0x20
  96. #define MIP4_R1_CTRL_PALM_EVENT 0x22
  97. #define MIP4_R1_CTRL_PROXIMITY_SENSING 0x23
  98. /* Value */
  99. #define MIP4_BOOT_MODE_BOOT 0x01
  100. #define MIP4_BOOT_MODE_APP 0x02
  101. #define MIP4_BOOT_STATUS_BUSY 0x05
  102. #define MIP4_BOOT_STATUS_ERROR 0x0E
  103. #define MIP4_BOOT_STATUS_DONE 0xA0
  104. #define MIP4_BOOT_CMD_MASS_ERASE 0x15
  105. #define MIP4_BOOT_CMD_PROGRAM 0x54
  106. #define MIP4_BOOT_CMD_ERASE 0x8F
  107. #define MIP4_BOOT_CMD_WRITE 0xA5
  108. #define MIP4_BOOT_CMD_READ 0xC2
  109. #define MIP4_EVENT_INPUT_TYPE_KEY 0
  110. #define MIP4_EVENT_INPUT_TYPE_SCREEN 1
  111. #define MIP4_EVENT_INPUT_TYPE_PROXIMITY 2
  112. #define I2C_RETRY_COUNT 3 /* 2~ */
  113. #define MIP4_BUF_SIZE 128
  114. #define MIP4_MAX_FINGERS 10
  115. #define MIP4_MAX_KEYS 4
  116. #define MIP4_TOUCH_MAJOR_MIN 0
  117. #define MIP4_TOUCH_MAJOR_MAX 255
  118. #define MIP4_TOUCH_MINOR_MIN 0
  119. #define MIP4_TOUCH_MINOR_MAX 255
  120. #define MIP4_PRESSURE_MIN 0
  121. #define MIP4_PRESSURE_MAX 255
  122. #define MIP4_FW_NAME "melfas_mip4.fw"
  123. #define MIP4_FW_UPDATE_DEBUG 0 /* 0 (default) or 1 */
  124. struct mip4_fw_version {
  125. u16 boot;
  126. u16 core;
  127. u16 app;
  128. u16 param;
  129. };
  130. struct mip4_ts {
  131. struct i2c_client *client;
  132. struct input_dev *input;
  133. struct gpio_desc *gpio_ce;
  134. char phys[32];
  135. char product_name[16];
  136. u16 product_id;
  137. char ic_name[4];
  138. char fw_name[32];
  139. unsigned int max_x;
  140. unsigned int max_y;
  141. u8 node_x;
  142. u8 node_y;
  143. u8 node_key;
  144. unsigned int ppm_x;
  145. unsigned int ppm_y;
  146. struct mip4_fw_version fw_version;
  147. unsigned int event_size;
  148. unsigned int event_format;
  149. unsigned int key_num;
  150. unsigned short key_code[MIP4_MAX_KEYS];
  151. bool wake_irq_enabled;
  152. u8 buf[MIP4_BUF_SIZE];
  153. };
  154. static int mip4_i2c_xfer(struct mip4_ts *ts,
  155. char *write_buf, unsigned int write_len,
  156. char *read_buf, unsigned int read_len)
  157. {
  158. struct i2c_msg msg[] = {
  159. {
  160. .addr = ts->client->addr,
  161. .flags = 0,
  162. .buf = write_buf,
  163. .len = write_len,
  164. }, {
  165. .addr = ts->client->addr,
  166. .flags = I2C_M_RD,
  167. .buf = read_buf,
  168. .len = read_len,
  169. },
  170. };
  171. int retry = I2C_RETRY_COUNT;
  172. int res;
  173. int error;
  174. do {
  175. res = i2c_transfer(ts->client->adapter, msg, ARRAY_SIZE(msg));
  176. if (res == ARRAY_SIZE(msg))
  177. return 0;
  178. error = res < 0 ? res : -EIO;
  179. dev_err(&ts->client->dev,
  180. "%s - i2c_transfer failed: %d (%d)\n",
  181. __func__, error, res);
  182. } while (--retry);
  183. return error;
  184. }
  185. static void mip4_parse_fw_version(const u8 *buf, struct mip4_fw_version *v)
  186. {
  187. v->boot = get_unaligned_le16(buf + 0);
  188. v->core = get_unaligned_le16(buf + 2);
  189. v->app = get_unaligned_le16(buf + 4);
  190. v->param = get_unaligned_le16(buf + 6);
  191. }
  192. /*
  193. * Read chip firmware version
  194. */
  195. static int mip4_get_fw_version(struct mip4_ts *ts)
  196. {
  197. u8 cmd[] = { MIP4_R0_INFO, MIP4_R1_INFO_VERSION_BOOT };
  198. u8 buf[sizeof(ts->fw_version)];
  199. int error;
  200. error = mip4_i2c_xfer(ts, cmd, sizeof(cmd), buf, sizeof(buf));
  201. if (error) {
  202. memset(&ts->fw_version, 0xff, sizeof(ts->fw_version));
  203. return error;
  204. }
  205. mip4_parse_fw_version(buf, &ts->fw_version);
  206. return 0;
  207. }
  208. /*
  209. * Fetch device characteristics
  210. */
  211. static int mip4_query_device(struct mip4_ts *ts)
  212. {
  213. union i2c_smbus_data dummy;
  214. int error;
  215. u8 cmd[2];
  216. u8 buf[14];
  217. /*
  218. * Make sure there is something at this address as we do not
  219. * consider subsequent failures as fatal.
  220. */
  221. if (i2c_smbus_xfer(ts->client->adapter, ts->client->addr,
  222. 0, I2C_SMBUS_READ, 0, I2C_SMBUS_BYTE, &dummy) < 0) {
  223. dev_err(&ts->client->dev, "nothing at this address\n");
  224. return -ENXIO;
  225. }
  226. /* Product name */
  227. cmd[0] = MIP4_R0_INFO;
  228. cmd[1] = MIP4_R1_INFO_PRODUCT_NAME;
  229. error = mip4_i2c_xfer(ts, cmd, sizeof(cmd),
  230. ts->product_name, sizeof(ts->product_name));
  231. if (error)
  232. dev_warn(&ts->client->dev,
  233. "Failed to retrieve product name: %d\n", error);
  234. else
  235. dev_dbg(&ts->client->dev, "product name: %.*s\n",
  236. (int)sizeof(ts->product_name), ts->product_name);
  237. /* Product ID */
  238. cmd[0] = MIP4_R0_INFO;
  239. cmd[1] = MIP4_R1_INFO_PID;
  240. error = mip4_i2c_xfer(ts, cmd, sizeof(cmd), buf, 2);
  241. if (error) {
  242. dev_warn(&ts->client->dev,
  243. "Failed to retrieve product id: %d\n", error);
  244. } else {
  245. ts->product_id = get_unaligned_le16(&buf[0]);
  246. dev_dbg(&ts->client->dev, "product id: %04X\n", ts->product_id);
  247. }
  248. /* Firmware name */
  249. snprintf(ts->fw_name, sizeof(ts->fw_name),
  250. "melfas_mip4_%04X.fw", ts->product_id);
  251. dev_dbg(&ts->client->dev, "firmware name: %s\n", ts->fw_name);
  252. /* IC name */
  253. cmd[0] = MIP4_R0_INFO;
  254. cmd[1] = MIP4_R1_INFO_IC_NAME;
  255. error = mip4_i2c_xfer(ts, cmd, sizeof(cmd),
  256. ts->ic_name, sizeof(ts->ic_name));
  257. if (error)
  258. dev_warn(&ts->client->dev,
  259. "Failed to retrieve IC name: %d\n", error);
  260. else
  261. dev_dbg(&ts->client->dev, "IC name: %.*s\n",
  262. (int)sizeof(ts->ic_name), ts->ic_name);
  263. /* Firmware version */
  264. error = mip4_get_fw_version(ts);
  265. if (error)
  266. dev_warn(&ts->client->dev,
  267. "Failed to retrieve FW version: %d\n", error);
  268. else
  269. dev_dbg(&ts->client->dev, "F/W Version: %04X %04X %04X %04X\n",
  270. ts->fw_version.boot, ts->fw_version.core,
  271. ts->fw_version.app, ts->fw_version.param);
  272. /* Resolution */
  273. cmd[0] = MIP4_R0_INFO;
  274. cmd[1] = MIP4_R1_INFO_RESOLUTION_X;
  275. error = mip4_i2c_xfer(ts, cmd, sizeof(cmd), buf, 14);
  276. if (error) {
  277. dev_warn(&ts->client->dev,
  278. "Failed to retrieve touchscreen parameters: %d\n",
  279. error);
  280. } else {
  281. ts->max_x = get_unaligned_le16(&buf[0]);
  282. ts->max_y = get_unaligned_le16(&buf[2]);
  283. dev_dbg(&ts->client->dev, "max_x: %d, max_y: %d\n",
  284. ts->max_x, ts->max_y);
  285. ts->node_x = buf[4];
  286. ts->node_y = buf[5];
  287. ts->node_key = buf[6];
  288. dev_dbg(&ts->client->dev,
  289. "node_x: %d, node_y: %d, node_key: %d\n",
  290. ts->node_x, ts->node_y, ts->node_key);
  291. ts->ppm_x = buf[12];
  292. ts->ppm_y = buf[13];
  293. dev_dbg(&ts->client->dev, "ppm_x: %d, ppm_y: %d\n",
  294. ts->ppm_x, ts->ppm_y);
  295. /* Key ts */
  296. if (ts->node_key > 0)
  297. ts->key_num = ts->node_key;
  298. }
  299. /* Protocol */
  300. cmd[0] = MIP4_R0_EVENT;
  301. cmd[1] = MIP4_R1_EVENT_SUPPORTED_FUNC;
  302. error = mip4_i2c_xfer(ts, cmd, sizeof(cmd), buf, 7);
  303. if (error) {
  304. dev_warn(&ts->client->dev,
  305. "Failed to retrieve device type: %d\n", error);
  306. ts->event_format = 0xff;
  307. } else {
  308. ts->event_format = get_unaligned_le16(&buf[4]);
  309. ts->event_size = buf[6];
  310. dev_dbg(&ts->client->dev, "event_format: %d, event_size: %d\n",
  311. ts->event_format, ts->event_size);
  312. if (ts->event_format == 2 || ts->event_format > 3)
  313. dev_warn(&ts->client->dev,
  314. "Unknown event format %d\n", ts->event_format);
  315. }
  316. return 0;
  317. }
  318. static int mip4_power_on(struct mip4_ts *ts)
  319. {
  320. if (ts->gpio_ce) {
  321. gpiod_set_value_cansleep(ts->gpio_ce, 1);
  322. /* Booting delay : 200~300ms */
  323. usleep_range(200 * 1000, 300 * 1000);
  324. }
  325. return 0;
  326. }
  327. static void mip4_power_off(struct mip4_ts *ts)
  328. {
  329. if (ts->gpio_ce)
  330. gpiod_set_value_cansleep(ts->gpio_ce, 0);
  331. }
  332. /*
  333. * Clear touch input event status
  334. */
  335. static void mip4_clear_input(struct mip4_ts *ts)
  336. {
  337. int i;
  338. /* Screen */
  339. for (i = 0; i < MIP4_MAX_FINGERS; i++) {
  340. input_mt_slot(ts->input, i);
  341. input_mt_report_slot_inactive(ts->input);
  342. }
  343. /* Keys */
  344. for (i = 0; i < ts->key_num; i++)
  345. input_report_key(ts->input, ts->key_code[i], 0);
  346. input_sync(ts->input);
  347. }
  348. static int mip4_enable(struct mip4_ts *ts)
  349. {
  350. int error;
  351. error = mip4_power_on(ts);
  352. if (error)
  353. return error;
  354. enable_irq(ts->client->irq);
  355. return 0;
  356. }
  357. static void mip4_disable(struct mip4_ts *ts)
  358. {
  359. disable_irq(ts->client->irq);
  360. mip4_power_off(ts);
  361. mip4_clear_input(ts);
  362. }
  363. /*****************************************************************
  364. * Input handling
  365. *****************************************************************/
  366. static void mip4_report_keys(struct mip4_ts *ts, u8 *packet)
  367. {
  368. u8 key;
  369. bool down;
  370. switch (ts->event_format) {
  371. case 0:
  372. case 1:
  373. key = packet[0] & 0x0F;
  374. down = packet[0] & 0x80;
  375. break;
  376. case 3:
  377. default:
  378. key = packet[0] & 0x0F;
  379. down = packet[1] & 0x01;
  380. break;
  381. }
  382. /* Report key event */
  383. if (key >= 1 && key <= ts->key_num) {
  384. unsigned short keycode = ts->key_code[key - 1];
  385. dev_dbg(&ts->client->dev,
  386. "Key - ID: %d, keycode: %d, state: %d\n",
  387. key, keycode, down);
  388. input_event(ts->input, EV_MSC, MSC_SCAN, keycode);
  389. input_report_key(ts->input, keycode, down);
  390. } else {
  391. dev_err(&ts->client->dev, "Unknown key: %d\n", key);
  392. }
  393. }
  394. static void mip4_report_touch(struct mip4_ts *ts, u8 *packet)
  395. {
  396. int id;
  397. bool __always_unused hover;
  398. bool __always_unused palm;
  399. bool state;
  400. u16 x, y;
  401. u8 __always_unused pressure_stage = 0;
  402. u8 pressure;
  403. u8 __always_unused size;
  404. u8 touch_major;
  405. u8 touch_minor;
  406. switch (ts->event_format) {
  407. case 0:
  408. case 1:
  409. /* Touch only */
  410. state = packet[0] & BIT(7);
  411. hover = packet[0] & BIT(5);
  412. palm = packet[0] & BIT(4);
  413. id = (packet[0] & 0x0F) - 1;
  414. x = ((packet[1] & 0x0F) << 8) | packet[2];
  415. y = (((packet[1] >> 4) & 0x0F) << 8) |
  416. packet[3];
  417. pressure = packet[4];
  418. size = packet[5];
  419. if (ts->event_format == 0) {
  420. touch_major = packet[5];
  421. touch_minor = packet[5];
  422. } else {
  423. touch_major = packet[6];
  424. touch_minor = packet[7];
  425. }
  426. break;
  427. case 3:
  428. default:
  429. /* Touch + Force(Pressure) */
  430. id = (packet[0] & 0x0F) - 1;
  431. hover = packet[1] & BIT(2);
  432. palm = packet[1] & BIT(1);
  433. state = packet[1] & BIT(0);
  434. x = ((packet[2] & 0x0F) << 8) | packet[3];
  435. y = (((packet[2] >> 4) & 0x0F) << 8) |
  436. packet[4];
  437. size = packet[6];
  438. pressure_stage = (packet[7] & 0xF0) >> 4;
  439. pressure = ((packet[7] & 0x0F) << 8) |
  440. packet[8];
  441. touch_major = packet[9];
  442. touch_minor = packet[10];
  443. break;
  444. }
  445. dev_dbg(&ts->client->dev,
  446. "Screen - Slot: %d State: %d X: %04d Y: %04d Z: %d\n",
  447. id, state, x, y, pressure);
  448. if (unlikely(id < 0 || id >= MIP4_MAX_FINGERS)) {
  449. dev_err(&ts->client->dev, "Screen - invalid slot ID: %d\n", id);
  450. } else if (state) {
  451. /* Press or Move event */
  452. input_mt_slot(ts->input, id);
  453. input_mt_report_slot_state(ts->input, MT_TOOL_FINGER, true);
  454. input_report_abs(ts->input, ABS_MT_POSITION_X, x);
  455. input_report_abs(ts->input, ABS_MT_POSITION_Y, y);
  456. input_report_abs(ts->input, ABS_MT_PRESSURE, pressure);
  457. input_report_abs(ts->input, ABS_MT_TOUCH_MAJOR, touch_major);
  458. input_report_abs(ts->input, ABS_MT_TOUCH_MINOR, touch_minor);
  459. } else {
  460. /* Release event */
  461. input_mt_slot(ts->input, id);
  462. input_mt_report_slot_inactive(ts->input);
  463. }
  464. input_mt_sync_frame(ts->input);
  465. }
  466. static int mip4_handle_packet(struct mip4_ts *ts, u8 *packet)
  467. {
  468. u8 type;
  469. switch (ts->event_format) {
  470. case 0:
  471. case 1:
  472. type = (packet[0] & 0x40) >> 6;
  473. break;
  474. case 3:
  475. type = (packet[0] & 0xF0) >> 4;
  476. break;
  477. default:
  478. /* Should not happen unless we have corrupted firmware */
  479. return -EINVAL;
  480. }
  481. dev_dbg(&ts->client->dev, "Type: %d\n", type);
  482. /* Report input event */
  483. switch (type) {
  484. case MIP4_EVENT_INPUT_TYPE_KEY:
  485. mip4_report_keys(ts, packet);
  486. break;
  487. case MIP4_EVENT_INPUT_TYPE_SCREEN:
  488. mip4_report_touch(ts, packet);
  489. break;
  490. default:
  491. dev_err(&ts->client->dev, "Unknown event type: %d\n", type);
  492. break;
  493. }
  494. return 0;
  495. }
  496. static irqreturn_t mip4_interrupt(int irq, void *dev_id)
  497. {
  498. struct mip4_ts *ts = dev_id;
  499. struct i2c_client *client = ts->client;
  500. unsigned int i;
  501. int error;
  502. u8 cmd[2];
  503. u8 size;
  504. bool alert;
  505. /* Read packet info */
  506. cmd[0] = MIP4_R0_EVENT;
  507. cmd[1] = MIP4_R1_EVENT_PACKET_INFO;
  508. error = mip4_i2c_xfer(ts, cmd, sizeof(cmd), ts->buf, 1);
  509. if (error) {
  510. dev_err(&client->dev,
  511. "Failed to read packet info: %d\n", error);
  512. goto out;
  513. }
  514. size = ts->buf[0] & 0x7F;
  515. alert = ts->buf[0] & BIT(7);
  516. dev_dbg(&client->dev, "packet size: %d, alert: %d\n", size, alert);
  517. /* Check size */
  518. if (!size) {
  519. dev_err(&client->dev, "Empty packet\n");
  520. goto out;
  521. }
  522. /* Read packet data */
  523. cmd[0] = MIP4_R0_EVENT;
  524. cmd[1] = MIP4_R1_EVENT_PACKET_DATA;
  525. error = mip4_i2c_xfer(ts, cmd, sizeof(cmd), ts->buf, size);
  526. if (error) {
  527. dev_err(&client->dev,
  528. "Failed to read packet data: %d\n", error);
  529. goto out;
  530. }
  531. if (alert) {
  532. dev_dbg(&client->dev, "Alert: %d\n", ts->buf[0]);
  533. } else {
  534. for (i = 0; i < size; i += ts->event_size) {
  535. error = mip4_handle_packet(ts, &ts->buf[i]);
  536. if (error)
  537. break;
  538. }
  539. input_sync(ts->input);
  540. }
  541. out:
  542. return IRQ_HANDLED;
  543. }
  544. static int mip4_input_open(struct input_dev *dev)
  545. {
  546. struct mip4_ts *ts = input_get_drvdata(dev);
  547. return mip4_enable(ts);
  548. }
  549. static void mip4_input_close(struct input_dev *dev)
  550. {
  551. struct mip4_ts *ts = input_get_drvdata(dev);
  552. mip4_disable(ts);
  553. }
  554. /*****************************************************************
  555. * Firmware update
  556. *****************************************************************/
  557. /* Firmware Info */
  558. #define MIP4_BL_PAGE_SIZE 512 /* 512 */
  559. #define MIP4_BL_PACKET_SIZE 512 /* 512, 256, 128, 64, ... */
  560. /*
  561. * Firmware binary tail info
  562. */
  563. struct mip4_bin_tail {
  564. u8 tail_mark[4];
  565. u8 chip_name[4];
  566. __le32 bin_start_addr;
  567. __le32 bin_length;
  568. __le16 ver_boot;
  569. __le16 ver_core;
  570. __le16 ver_app;
  571. __le16 ver_param;
  572. u8 boot_start;
  573. u8 boot_end;
  574. u8 core_start;
  575. u8 core_end;
  576. u8 app_start;
  577. u8 app_end;
  578. u8 param_start;
  579. u8 param_end;
  580. u8 checksum_type;
  581. u8 hw_category;
  582. __le16 param_id;
  583. __le32 param_length;
  584. __le32 build_date;
  585. __le32 build_time;
  586. __le32 reserved1;
  587. __le32 reserved2;
  588. __le16 reserved3;
  589. __le16 tail_size;
  590. __le32 crc;
  591. } __packed;
  592. #define MIP4_BIN_TAIL_MARK "MBT\001"
  593. #define MIP4_BIN_TAIL_SIZE (sizeof(struct mip4_bin_tail))
  594. /*
  595. * Bootloader - Read status
  596. */
  597. static int mip4_bl_read_status(struct mip4_ts *ts)
  598. {
  599. u8 cmd[] = { MIP4_R0_BOOT, MIP4_R1_BOOT_STATUS };
  600. u8 result;
  601. struct i2c_msg msg[] = {
  602. {
  603. .addr = ts->client->addr,
  604. .flags = 0,
  605. .buf = cmd,
  606. .len = sizeof(cmd),
  607. }, {
  608. .addr = ts->client->addr,
  609. .flags = I2C_M_RD,
  610. .buf = &result,
  611. .len = sizeof(result),
  612. },
  613. };
  614. int ret;
  615. int error;
  616. int retry = 1000;
  617. do {
  618. ret = i2c_transfer(ts->client->adapter, msg, ARRAY_SIZE(msg));
  619. if (ret != ARRAY_SIZE(msg)) {
  620. error = ret < 0 ? ret : -EIO;
  621. dev_err(&ts->client->dev,
  622. "Failed to read bootloader status: %d\n",
  623. error);
  624. return error;
  625. }
  626. switch (result) {
  627. case MIP4_BOOT_STATUS_DONE:
  628. dev_dbg(&ts->client->dev, "%s - done\n", __func__);
  629. return 0;
  630. case MIP4_BOOT_STATUS_ERROR:
  631. dev_err(&ts->client->dev, "Bootloader failure\n");
  632. return -EIO;
  633. case MIP4_BOOT_STATUS_BUSY:
  634. dev_dbg(&ts->client->dev, "%s - Busy\n", __func__);
  635. error = -EBUSY;
  636. break;
  637. default:
  638. dev_err(&ts->client->dev,
  639. "Unexpected bootloader status: %#02x\n",
  640. result);
  641. error = -EINVAL;
  642. break;
  643. }
  644. usleep_range(1000, 2000);
  645. } while (--retry);
  646. return error;
  647. }
  648. /*
  649. * Bootloader - Change mode
  650. */
  651. static int mip4_bl_change_mode(struct mip4_ts *ts, u8 mode)
  652. {
  653. u8 mode_chg_cmd[] = { MIP4_R0_BOOT, MIP4_R1_BOOT_MODE, mode };
  654. u8 mode_read_cmd[] = { MIP4_R0_BOOT, MIP4_R1_BOOT_MODE };
  655. u8 result;
  656. struct i2c_msg msg[] = {
  657. {
  658. .addr = ts->client->addr,
  659. .flags = 0,
  660. .buf = mode_read_cmd,
  661. .len = sizeof(mode_read_cmd),
  662. }, {
  663. .addr = ts->client->addr,
  664. .flags = I2C_M_RD,
  665. .buf = &result,
  666. .len = sizeof(result),
  667. },
  668. };
  669. int retry = 10;
  670. int ret;
  671. int error;
  672. do {
  673. /* Send mode change command */
  674. ret = i2c_master_send(ts->client,
  675. mode_chg_cmd, sizeof(mode_chg_cmd));
  676. if (ret != sizeof(mode_chg_cmd)) {
  677. error = ret < 0 ? ret : -EIO;
  678. dev_err(&ts->client->dev,
  679. "Failed to send %d mode change: %d (%d)\n",
  680. mode, error, ret);
  681. return error;
  682. }
  683. dev_dbg(&ts->client->dev,
  684. "Sent mode change request (mode: %d)\n", mode);
  685. /* Wait */
  686. msleep(1000);
  687. /* Verify target mode */
  688. ret = i2c_transfer(ts->client->adapter, msg, ARRAY_SIZE(msg));
  689. if (ret != ARRAY_SIZE(msg)) {
  690. error = ret < 0 ? ret : -EIO;
  691. dev_err(&ts->client->dev,
  692. "Failed to read device mode: %d\n", error);
  693. return error;
  694. }
  695. dev_dbg(&ts->client->dev,
  696. "Current device mode: %d, want: %d\n", result, mode);
  697. if (result == mode)
  698. return 0;
  699. } while (--retry);
  700. return -EIO;
  701. }
  702. /*
  703. * Bootloader - Start bootloader mode
  704. */
  705. static int mip4_bl_enter(struct mip4_ts *ts)
  706. {
  707. return mip4_bl_change_mode(ts, MIP4_BOOT_MODE_BOOT);
  708. }
  709. /*
  710. * Bootloader - Exit bootloader mode
  711. */
  712. static int mip4_bl_exit(struct mip4_ts *ts)
  713. {
  714. return mip4_bl_change_mode(ts, MIP4_BOOT_MODE_APP);
  715. }
  716. static int mip4_bl_get_address(struct mip4_ts *ts, u16 *buf_addr)
  717. {
  718. u8 cmd[] = { MIP4_R0_BOOT, MIP4_R1_BOOT_BUF_ADDR };
  719. u8 result[sizeof(u16)];
  720. struct i2c_msg msg[] = {
  721. {
  722. .addr = ts->client->addr,
  723. .flags = 0,
  724. .buf = cmd,
  725. .len = sizeof(cmd),
  726. }, {
  727. .addr = ts->client->addr,
  728. .flags = I2C_M_RD,
  729. .buf = result,
  730. .len = sizeof(result),
  731. },
  732. };
  733. int ret;
  734. int error;
  735. ret = i2c_transfer(ts->client->adapter, msg, ARRAY_SIZE(msg));
  736. if (ret != ARRAY_SIZE(msg)) {
  737. error = ret < 0 ? ret : -EIO;
  738. dev_err(&ts->client->dev,
  739. "Failed to retrieve bootloader buffer address: %d\n",
  740. error);
  741. return error;
  742. }
  743. *buf_addr = get_unaligned_le16(result);
  744. dev_dbg(&ts->client->dev,
  745. "Bootloader buffer address %#04x\n", *buf_addr);
  746. return 0;
  747. }
  748. static int mip4_bl_program_page(struct mip4_ts *ts, int offset,
  749. const u8 *data, int length, u16 buf_addr)
  750. {
  751. u8 cmd[6];
  752. u8 *data_buf;
  753. u16 buf_offset;
  754. int ret;
  755. int error;
  756. dev_dbg(&ts->client->dev, "Writing page @%#06x (%d)\n",
  757. offset, length);
  758. if (length > MIP4_BL_PAGE_SIZE || length % MIP4_BL_PACKET_SIZE) {
  759. dev_err(&ts->client->dev,
  760. "Invalid page length: %d\n", length);
  761. return -EINVAL;
  762. }
  763. data_buf = kmalloc(2 + MIP4_BL_PACKET_SIZE, GFP_KERNEL);
  764. if (!data_buf)
  765. return -ENOMEM;
  766. /* Addr */
  767. cmd[0] = MIP4_R0_BOOT;
  768. cmd[1] = MIP4_R1_BOOT_TARGET_ADDR;
  769. put_unaligned_le32(offset, &cmd[2]);
  770. ret = i2c_master_send(ts->client, cmd, 6);
  771. if (ret != 6) {
  772. error = ret < 0 ? ret : -EIO;
  773. dev_err(&ts->client->dev,
  774. "Failed to send write page address: %d\n", error);
  775. goto out;
  776. }
  777. /* Size */
  778. cmd[0] = MIP4_R0_BOOT;
  779. cmd[1] = MIP4_R1_BOOT_SIZE;
  780. put_unaligned_le32(length, &cmd[2]);
  781. ret = i2c_master_send(ts->client, cmd, 6);
  782. if (ret != 6) {
  783. error = ret < 0 ? ret : -EIO;
  784. dev_err(&ts->client->dev,
  785. "Failed to send write page size: %d\n", error);
  786. goto out;
  787. }
  788. /* Data */
  789. for (buf_offset = 0;
  790. buf_offset < length;
  791. buf_offset += MIP4_BL_PACKET_SIZE) {
  792. dev_dbg(&ts->client->dev,
  793. "writing chunk at %#04x (size %d)\n",
  794. buf_offset, MIP4_BL_PACKET_SIZE);
  795. put_unaligned_be16(buf_addr + buf_offset, data_buf);
  796. memcpy(&data_buf[2], &data[buf_offset], MIP4_BL_PACKET_SIZE);
  797. ret = i2c_master_send(ts->client,
  798. data_buf, 2 + MIP4_BL_PACKET_SIZE);
  799. if (ret != 2 + MIP4_BL_PACKET_SIZE) {
  800. error = ret < 0 ? ret : -EIO;
  801. dev_err(&ts->client->dev,
  802. "Failed to read chunk at %#04x (size %d): %d\n",
  803. buf_offset, MIP4_BL_PACKET_SIZE, error);
  804. goto out;
  805. }
  806. }
  807. /* Command */
  808. cmd[0] = MIP4_R0_BOOT;
  809. cmd[1] = MIP4_R1_BOOT_CMD;
  810. cmd[2] = MIP4_BOOT_CMD_PROGRAM;
  811. ret = i2c_master_send(ts->client, cmd, 3);
  812. if (ret != 3) {
  813. error = ret < 0 ? ret : -EIO;
  814. dev_err(&ts->client->dev,
  815. "Failed to send 'write' command: %d\n", error);
  816. goto out;
  817. }
  818. /* Status */
  819. error = mip4_bl_read_status(ts);
  820. out:
  821. kfree(data_buf);
  822. return error ? error : 0;
  823. }
  824. static int mip4_bl_verify_page(struct mip4_ts *ts, int offset,
  825. const u8 *data, int length, int buf_addr)
  826. {
  827. u8 cmd[8];
  828. u8 *read_buf;
  829. int buf_offset;
  830. struct i2c_msg msg[] = {
  831. {
  832. .addr = ts->client->addr,
  833. .flags = 0,
  834. .buf = cmd,
  835. .len = 2,
  836. }, {
  837. .addr = ts->client->addr,
  838. .flags = I2C_M_RD,
  839. .len = MIP4_BL_PACKET_SIZE,
  840. },
  841. };
  842. int ret;
  843. int error;
  844. dev_dbg(&ts->client->dev, "Validating page @%#06x (%d)\n",
  845. offset, length);
  846. /* Addr */
  847. cmd[0] = MIP4_R0_BOOT;
  848. cmd[1] = MIP4_R1_BOOT_TARGET_ADDR;
  849. put_unaligned_le32(offset, &cmd[2]);
  850. ret = i2c_master_send(ts->client, cmd, 6);
  851. if (ret != 6) {
  852. error = ret < 0 ? ret : -EIO;
  853. dev_err(&ts->client->dev,
  854. "Failed to send read page address: %d\n", error);
  855. return error;
  856. }
  857. /* Size */
  858. cmd[0] = MIP4_R0_BOOT;
  859. cmd[1] = MIP4_R1_BOOT_SIZE;
  860. put_unaligned_le32(length, &cmd[2]);
  861. ret = i2c_master_send(ts->client, cmd, 6);
  862. if (ret != 6) {
  863. error = ret < 0 ? ret : -EIO;
  864. dev_err(&ts->client->dev,
  865. "Failed to send read page size: %d\n", error);
  866. return error;
  867. }
  868. /* Command */
  869. cmd[0] = MIP4_R0_BOOT;
  870. cmd[1] = MIP4_R1_BOOT_CMD;
  871. cmd[2] = MIP4_BOOT_CMD_READ;
  872. ret = i2c_master_send(ts->client, cmd, 3);
  873. if (ret != 3) {
  874. error = ret < 0 ? ret : -EIO;
  875. dev_err(&ts->client->dev,
  876. "Failed to send 'read' command: %d\n", error);
  877. return error;
  878. }
  879. /* Status */
  880. error = mip4_bl_read_status(ts);
  881. if (error)
  882. return error;
  883. /* Read */
  884. msg[1].buf = read_buf = kmalloc(MIP4_BL_PACKET_SIZE, GFP_KERNEL);
  885. if (!read_buf)
  886. return -ENOMEM;
  887. for (buf_offset = 0;
  888. buf_offset < length;
  889. buf_offset += MIP4_BL_PACKET_SIZE) {
  890. dev_dbg(&ts->client->dev,
  891. "reading chunk at %#04x (size %d)\n",
  892. buf_offset, MIP4_BL_PACKET_SIZE);
  893. put_unaligned_be16(buf_addr + buf_offset, cmd);
  894. ret = i2c_transfer(ts->client->adapter, msg, ARRAY_SIZE(msg));
  895. if (ret != ARRAY_SIZE(msg)) {
  896. error = ret < 0 ? ret : -EIO;
  897. dev_err(&ts->client->dev,
  898. "Failed to read chunk at %#04x (size %d): %d\n",
  899. buf_offset, MIP4_BL_PACKET_SIZE, error);
  900. break;
  901. }
  902. if (memcmp(&data[buf_offset], read_buf, MIP4_BL_PACKET_SIZE)) {
  903. dev_err(&ts->client->dev,
  904. "Failed to validate chunk at %#04x (size %d)\n",
  905. buf_offset, MIP4_BL_PACKET_SIZE);
  906. #if MIP4_FW_UPDATE_DEBUG
  907. print_hex_dump(KERN_DEBUG,
  908. MIP4_DEVICE_NAME " F/W File: ",
  909. DUMP_PREFIX_OFFSET, 16, 1,
  910. data + offset, MIP4_BL_PACKET_SIZE,
  911. false);
  912. print_hex_dump(KERN_DEBUG,
  913. MIP4_DEVICE_NAME " F/W Chip: ",
  914. DUMP_PREFIX_OFFSET, 16, 1,
  915. read_buf, MIP4_BL_PAGE_SIZE, false);
  916. #endif
  917. error = -EINVAL;
  918. break;
  919. }
  920. }
  921. kfree(read_buf);
  922. return error ? error : 0;
  923. }
  924. /*
  925. * Flash chip firmware
  926. */
  927. static int mip4_flash_fw(struct mip4_ts *ts,
  928. const u8 *fw_data, u32 fw_size, u32 fw_offset)
  929. {
  930. struct i2c_client *client = ts->client;
  931. int offset;
  932. u16 buf_addr;
  933. int error, error2;
  934. /* Enter bootloader mode */
  935. dev_dbg(&client->dev, "Entering bootloader mode\n");
  936. error = mip4_bl_enter(ts);
  937. if (error) {
  938. dev_err(&client->dev,
  939. "Failed to enter bootloader mode: %d\n",
  940. error);
  941. return error;
  942. }
  943. /* Read info */
  944. error = mip4_bl_get_address(ts, &buf_addr);
  945. if (error)
  946. goto exit_bl;
  947. /* Program & Verify */
  948. dev_dbg(&client->dev,
  949. "Program & Verify, page size: %d, packet size: %d\n",
  950. MIP4_BL_PAGE_SIZE, MIP4_BL_PACKET_SIZE);
  951. for (offset = fw_offset;
  952. offset < fw_offset + fw_size;
  953. offset += MIP4_BL_PAGE_SIZE) {
  954. /* Program */
  955. error = mip4_bl_program_page(ts, offset, fw_data + offset,
  956. MIP4_BL_PAGE_SIZE, buf_addr);
  957. if (error)
  958. break;
  959. /* Verify */
  960. error = mip4_bl_verify_page(ts, offset, fw_data + offset,
  961. MIP4_BL_PAGE_SIZE, buf_addr);
  962. if (error)
  963. break;
  964. }
  965. exit_bl:
  966. /* Exit bootloader mode */
  967. dev_dbg(&client->dev, "Exiting bootloader mode\n");
  968. error2 = mip4_bl_exit(ts);
  969. if (error2) {
  970. dev_err(&client->dev,
  971. "Failed to exit bootloader mode: %d\n", error2);
  972. if (!error)
  973. error = error2;
  974. }
  975. /* Reset chip */
  976. mip4_power_off(ts);
  977. mip4_power_on(ts);
  978. mip4_query_device(ts);
  979. /* Refresh device parameters */
  980. input_set_abs_params(ts->input, ABS_MT_POSITION_X, 0, ts->max_x, 0, 0);
  981. input_set_abs_params(ts->input, ABS_MT_POSITION_Y, 0, ts->max_y, 0, 0);
  982. input_set_abs_params(ts->input, ABS_X, 0, ts->max_x, 0, 0);
  983. input_set_abs_params(ts->input, ABS_Y, 0, ts->max_y, 0, 0);
  984. input_abs_set_res(ts->input, ABS_MT_POSITION_X, ts->ppm_x);
  985. input_abs_set_res(ts->input, ABS_MT_POSITION_Y, ts->ppm_y);
  986. input_abs_set_res(ts->input, ABS_X, ts->ppm_x);
  987. input_abs_set_res(ts->input, ABS_Y, ts->ppm_y);
  988. return error ? error : 0;
  989. }
  990. static int mip4_parse_firmware(struct mip4_ts *ts, const struct firmware *fw,
  991. u32 *fw_offset_start, u32 *fw_size,
  992. const struct mip4_bin_tail **pfw_info)
  993. {
  994. const struct mip4_bin_tail *fw_info;
  995. struct mip4_fw_version fw_version;
  996. u16 tail_size;
  997. if (fw->size < MIP4_BIN_TAIL_SIZE) {
  998. dev_err(&ts->client->dev,
  999. "Invalid firmware, size mismatch (tail %zd vs %zd)\n",
  1000. MIP4_BIN_TAIL_SIZE, fw->size);
  1001. return -EINVAL;
  1002. }
  1003. fw_info = (const void *)&fw->data[fw->size - MIP4_BIN_TAIL_SIZE];
  1004. #if MIP4_FW_UPDATE_DEBUG
  1005. print_hex_dump(KERN_ERR, MIP4_DEVICE_NAME " Bin Info: ",
  1006. DUMP_PREFIX_OFFSET, 16, 1, *fw_info, tail_size, false);
  1007. #endif
  1008. tail_size = get_unaligned_le16(&fw_info->tail_size);
  1009. if (tail_size != MIP4_BIN_TAIL_SIZE) {
  1010. dev_err(&ts->client->dev,
  1011. "wrong tail size: %d (expected %zd)\n",
  1012. tail_size, MIP4_BIN_TAIL_SIZE);
  1013. return -EINVAL;
  1014. }
  1015. /* Check bin format */
  1016. if (memcmp(fw_info->tail_mark, MIP4_BIN_TAIL_MARK,
  1017. sizeof(fw_info->tail_mark))) {
  1018. dev_err(&ts->client->dev,
  1019. "unable to locate tail marker (%*ph vs %*ph)\n",
  1020. (int)sizeof(fw_info->tail_mark), fw_info->tail_mark,
  1021. (int)sizeof(fw_info->tail_mark), MIP4_BIN_TAIL_MARK);
  1022. return -EINVAL;
  1023. }
  1024. *fw_offset_start = get_unaligned_le32(&fw_info->bin_start_addr);
  1025. *fw_size = get_unaligned_le32(&fw_info->bin_length);
  1026. dev_dbg(&ts->client->dev,
  1027. "F/W Data offset: %#08x, size: %d\n",
  1028. *fw_offset_start, *fw_size);
  1029. if (*fw_size % MIP4_BL_PAGE_SIZE) {
  1030. dev_err(&ts->client->dev,
  1031. "encoded fw length %d is not multiple of pages (%d)\n",
  1032. *fw_size, MIP4_BL_PAGE_SIZE);
  1033. return -EINVAL;
  1034. }
  1035. if (fw->size != *fw_offset_start + *fw_size) {
  1036. dev_err(&ts->client->dev,
  1037. "Wrong firmware size, expected %d bytes, got %zd\n",
  1038. *fw_offset_start + *fw_size, fw->size);
  1039. return -EINVAL;
  1040. }
  1041. mip4_parse_fw_version((const u8 *)&fw_info->ver_boot, &fw_version);
  1042. dev_dbg(&ts->client->dev,
  1043. "F/W file version %04X %04X %04X %04X\n",
  1044. fw_version.boot, fw_version.core,
  1045. fw_version.app, fw_version.param);
  1046. dev_dbg(&ts->client->dev, "F/W chip version: %04X %04X %04X %04X\n",
  1047. ts->fw_version.boot, ts->fw_version.core,
  1048. ts->fw_version.app, ts->fw_version.param);
  1049. /* Check F/W type */
  1050. if (fw_version.boot != 0xEEEE && fw_version.boot != 0xFFFF &&
  1051. fw_version.core == 0xEEEE &&
  1052. fw_version.app == 0xEEEE &&
  1053. fw_version.param == 0xEEEE) {
  1054. dev_dbg(&ts->client->dev, "F/W type: Bootloader\n");
  1055. } else if (fw_version.boot == 0xEEEE &&
  1056. fw_version.core != 0xEEEE && fw_version.core != 0xFFFF &&
  1057. fw_version.app != 0xEEEE && fw_version.app != 0xFFFF &&
  1058. fw_version.param != 0xEEEE && fw_version.param != 0xFFFF) {
  1059. dev_dbg(&ts->client->dev, "F/W type: Main\n");
  1060. } else {
  1061. dev_err(&ts->client->dev, "Wrong firmware type\n");
  1062. return -EINVAL;
  1063. }
  1064. return 0;
  1065. }
  1066. static int mip4_execute_fw_update(struct mip4_ts *ts, const struct firmware *fw)
  1067. {
  1068. const struct mip4_bin_tail *fw_info;
  1069. u32 fw_start_offset;
  1070. u32 fw_size;
  1071. int retires = 3;
  1072. int error;
  1073. error = mip4_parse_firmware(ts, fw,
  1074. &fw_start_offset, &fw_size, &fw_info);
  1075. if (error)
  1076. return error;
  1077. if (input_device_enabled(ts->input)) {
  1078. disable_irq(ts->client->irq);
  1079. } else {
  1080. error = mip4_power_on(ts);
  1081. if (error)
  1082. return error;
  1083. }
  1084. /* Update firmware */
  1085. do {
  1086. error = mip4_flash_fw(ts, fw->data, fw_size, fw_start_offset);
  1087. if (!error)
  1088. break;
  1089. } while (--retires);
  1090. if (error)
  1091. dev_err(&ts->client->dev,
  1092. "Failed to flash firmware: %d\n", error);
  1093. /* Enable IRQ */
  1094. if (input_device_enabled(ts->input))
  1095. enable_irq(ts->client->irq);
  1096. else
  1097. mip4_power_off(ts);
  1098. return error ? error : 0;
  1099. }
  1100. static ssize_t mip4_sysfs_fw_update(struct device *dev,
  1101. struct device_attribute *attr,
  1102. const char *buf, size_t count)
  1103. {
  1104. struct i2c_client *client = to_i2c_client(dev);
  1105. struct mip4_ts *ts = i2c_get_clientdata(client);
  1106. const struct firmware *fw;
  1107. int error;
  1108. error = request_firmware(&fw, ts->fw_name, dev);
  1109. if (error) {
  1110. dev_err(&ts->client->dev,
  1111. "Failed to retrieve firmware %s: %d\n",
  1112. ts->fw_name, error);
  1113. return error;
  1114. }
  1115. /*
  1116. * Take input mutex to prevent racing with itself and also with
  1117. * userspace opening and closing the device and also suspend/resume
  1118. * transitions.
  1119. */
  1120. mutex_lock(&ts->input->mutex);
  1121. error = mip4_execute_fw_update(ts, fw);
  1122. mutex_unlock(&ts->input->mutex);
  1123. release_firmware(fw);
  1124. if (error) {
  1125. dev_err(&ts->client->dev,
  1126. "Firmware update failed: %d\n", error);
  1127. return error;
  1128. }
  1129. return count;
  1130. }
  1131. static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mip4_sysfs_fw_update);
  1132. static ssize_t mip4_sysfs_read_fw_version(struct device *dev,
  1133. struct device_attribute *attr,
  1134. char *buf)
  1135. {
  1136. struct i2c_client *client = to_i2c_client(dev);
  1137. struct mip4_ts *ts = i2c_get_clientdata(client);
  1138. size_t count;
  1139. /* Take lock to prevent racing with firmware update */
  1140. mutex_lock(&ts->input->mutex);
  1141. count = snprintf(buf, PAGE_SIZE, "%04X %04X %04X %04X\n",
  1142. ts->fw_version.boot, ts->fw_version.core,
  1143. ts->fw_version.app, ts->fw_version.param);
  1144. mutex_unlock(&ts->input->mutex);
  1145. return count;
  1146. }
  1147. static DEVICE_ATTR(fw_version, S_IRUGO, mip4_sysfs_read_fw_version, NULL);
  1148. static ssize_t mip4_sysfs_read_hw_version(struct device *dev,
  1149. struct device_attribute *attr,
  1150. char *buf)
  1151. {
  1152. struct i2c_client *client = to_i2c_client(dev);
  1153. struct mip4_ts *ts = i2c_get_clientdata(client);
  1154. size_t count;
  1155. /* Take lock to prevent racing with firmware update */
  1156. mutex_lock(&ts->input->mutex);
  1157. /*
  1158. * product_name shows the name or version of the hardware
  1159. * paired with current firmware in the chip.
  1160. */
  1161. count = snprintf(buf, PAGE_SIZE, "%.*s\n",
  1162. (int)sizeof(ts->product_name), ts->product_name);
  1163. mutex_unlock(&ts->input->mutex);
  1164. return count;
  1165. }
  1166. static DEVICE_ATTR(hw_version, S_IRUGO, mip4_sysfs_read_hw_version, NULL);
  1167. static ssize_t mip4_sysfs_read_product_id(struct device *dev,
  1168. struct device_attribute *attr,
  1169. char *buf)
  1170. {
  1171. struct i2c_client *client = to_i2c_client(dev);
  1172. struct mip4_ts *ts = i2c_get_clientdata(client);
  1173. size_t count;
  1174. mutex_lock(&ts->input->mutex);
  1175. count = snprintf(buf, PAGE_SIZE, "%04X\n", ts->product_id);
  1176. mutex_unlock(&ts->input->mutex);
  1177. return count;
  1178. }
  1179. static DEVICE_ATTR(product_id, S_IRUGO, mip4_sysfs_read_product_id, NULL);
  1180. static ssize_t mip4_sysfs_read_ic_name(struct device *dev,
  1181. struct device_attribute *attr,
  1182. char *buf)
  1183. {
  1184. struct i2c_client *client = to_i2c_client(dev);
  1185. struct mip4_ts *ts = i2c_get_clientdata(client);
  1186. size_t count;
  1187. mutex_lock(&ts->input->mutex);
  1188. count = snprintf(buf, PAGE_SIZE, "%.*s\n",
  1189. (int)sizeof(ts->ic_name), ts->ic_name);
  1190. mutex_unlock(&ts->input->mutex);
  1191. return count;
  1192. }
  1193. static DEVICE_ATTR(ic_name, S_IRUGO, mip4_sysfs_read_ic_name, NULL);
  1194. static struct attribute *mip4_attrs[] = {
  1195. &dev_attr_fw_version.attr,
  1196. &dev_attr_hw_version.attr,
  1197. &dev_attr_product_id.attr,
  1198. &dev_attr_ic_name.attr,
  1199. &dev_attr_update_fw.attr,
  1200. NULL,
  1201. };
  1202. static const struct attribute_group mip4_attr_group = {
  1203. .attrs = mip4_attrs,
  1204. };
  1205. static int mip4_probe(struct i2c_client *client, const struct i2c_device_id *id)
  1206. {
  1207. struct mip4_ts *ts;
  1208. struct input_dev *input;
  1209. int error;
  1210. if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
  1211. dev_err(&client->dev, "Not supported I2C adapter\n");
  1212. return -ENXIO;
  1213. }
  1214. ts = devm_kzalloc(&client->dev, sizeof(*ts), GFP_KERNEL);
  1215. if (!ts)
  1216. return -ENOMEM;
  1217. input = devm_input_allocate_device(&client->dev);
  1218. if (!input)
  1219. return -ENOMEM;
  1220. ts->client = client;
  1221. ts->input = input;
  1222. snprintf(ts->phys, sizeof(ts->phys),
  1223. "%s/input0", dev_name(&client->dev));
  1224. ts->gpio_ce = devm_gpiod_get_optional(&client->dev,
  1225. "ce", GPIOD_OUT_LOW);
  1226. if (IS_ERR(ts->gpio_ce)) {
  1227. error = PTR_ERR(ts->gpio_ce);
  1228. if (error != -EPROBE_DEFER)
  1229. dev_err(&client->dev,
  1230. "Failed to get gpio: %d\n", error);
  1231. return error;
  1232. }
  1233. error = mip4_power_on(ts);
  1234. if (error)
  1235. return error;
  1236. error = mip4_query_device(ts);
  1237. mip4_power_off(ts);
  1238. if (error)
  1239. return error;
  1240. input->name = "MELFAS MIP4 Touchscreen";
  1241. input->phys = ts->phys;
  1242. input->id.bustype = BUS_I2C;
  1243. input->id.vendor = 0x13c5;
  1244. input->id.product = ts->product_id;
  1245. input->open = mip4_input_open;
  1246. input->close = mip4_input_close;
  1247. input_set_drvdata(input, ts);
  1248. input->keycode = ts->key_code;
  1249. input->keycodesize = sizeof(*ts->key_code);
  1250. input->keycodemax = ts->key_num;
  1251. input_set_abs_params(input, ABS_MT_POSITION_X, 0, ts->max_x, 0, 0);
  1252. input_set_abs_params(input, ABS_MT_POSITION_Y, 0, ts->max_y, 0, 0);
  1253. input_set_abs_params(input, ABS_MT_PRESSURE,
  1254. MIP4_PRESSURE_MIN, MIP4_PRESSURE_MAX, 0, 0);
  1255. input_set_abs_params(input, ABS_MT_TOUCH_MAJOR,
  1256. MIP4_TOUCH_MAJOR_MIN, MIP4_TOUCH_MAJOR_MAX, 0, 0);
  1257. input_set_abs_params(input, ABS_MT_TOUCH_MINOR,
  1258. MIP4_TOUCH_MINOR_MIN, MIP4_TOUCH_MINOR_MAX, 0, 0);
  1259. input_abs_set_res(ts->input, ABS_MT_POSITION_X, ts->ppm_x);
  1260. input_abs_set_res(ts->input, ABS_MT_POSITION_Y, ts->ppm_y);
  1261. error = input_mt_init_slots(input, MIP4_MAX_FINGERS, INPUT_MT_DIRECT);
  1262. if (error)
  1263. return error;
  1264. i2c_set_clientdata(client, ts);
  1265. error = devm_request_threaded_irq(&client->dev, client->irq,
  1266. NULL, mip4_interrupt,
  1267. IRQF_ONESHOT | IRQF_NO_AUTOEN,
  1268. MIP4_DEVICE_NAME, ts);
  1269. if (error) {
  1270. dev_err(&client->dev,
  1271. "Failed to request interrupt %d: %d\n",
  1272. client->irq, error);
  1273. return error;
  1274. }
  1275. error = input_register_device(input);
  1276. if (error) {
  1277. dev_err(&client->dev,
  1278. "Failed to register input device: %d\n", error);
  1279. return error;
  1280. }
  1281. error = devm_device_add_group(&client->dev, &mip4_attr_group);
  1282. if (error) {
  1283. dev_err(&client->dev,
  1284. "Failed to create sysfs attribute group: %d\n", error);
  1285. return error;
  1286. }
  1287. return 0;
  1288. }
  1289. static int __maybe_unused mip4_suspend(struct device *dev)
  1290. {
  1291. struct i2c_client *client = to_i2c_client(dev);
  1292. struct mip4_ts *ts = i2c_get_clientdata(client);
  1293. struct input_dev *input = ts->input;
  1294. mutex_lock(&input->mutex);
  1295. if (device_may_wakeup(dev))
  1296. ts->wake_irq_enabled = enable_irq_wake(client->irq) == 0;
  1297. else if (input_device_enabled(input))
  1298. mip4_disable(ts);
  1299. mutex_unlock(&input->mutex);
  1300. return 0;
  1301. }
  1302. static int __maybe_unused mip4_resume(struct device *dev)
  1303. {
  1304. struct i2c_client *client = to_i2c_client(dev);
  1305. struct mip4_ts *ts = i2c_get_clientdata(client);
  1306. struct input_dev *input = ts->input;
  1307. mutex_lock(&input->mutex);
  1308. if (ts->wake_irq_enabled)
  1309. disable_irq_wake(client->irq);
  1310. else if (input_device_enabled(input))
  1311. mip4_enable(ts);
  1312. mutex_unlock(&input->mutex);
  1313. return 0;
  1314. }
  1315. static SIMPLE_DEV_PM_OPS(mip4_pm_ops, mip4_suspend, mip4_resume);
  1316. #ifdef CONFIG_OF
  1317. static const struct of_device_id mip4_of_match[] = {
  1318. { .compatible = "melfas,"MIP4_DEVICE_NAME, },
  1319. { },
  1320. };
  1321. MODULE_DEVICE_TABLE(of, mip4_of_match);
  1322. #endif
  1323. #ifdef CONFIG_ACPI
  1324. static const struct acpi_device_id mip4_acpi_match[] = {
  1325. { "MLFS0000", 0},
  1326. { },
  1327. };
  1328. MODULE_DEVICE_TABLE(acpi, mip4_acpi_match);
  1329. #endif
  1330. static const struct i2c_device_id mip4_i2c_ids[] = {
  1331. { MIP4_DEVICE_NAME, 0 },
  1332. { },
  1333. };
  1334. MODULE_DEVICE_TABLE(i2c, mip4_i2c_ids);
  1335. static struct i2c_driver mip4_driver = {
  1336. .id_table = mip4_i2c_ids,
  1337. .probe = mip4_probe,
  1338. .driver = {
  1339. .name = MIP4_DEVICE_NAME,
  1340. .of_match_table = of_match_ptr(mip4_of_match),
  1341. .acpi_match_table = ACPI_PTR(mip4_acpi_match),
  1342. .pm = &mip4_pm_ops,
  1343. },
  1344. };
  1345. module_i2c_driver(mip4_driver);
  1346. MODULE_DESCRIPTION("MELFAS MIP4 Touchscreen");
  1347. MODULE_AUTHOR("Sangwon Jee <[email protected]>");
  1348. MODULE_LICENSE("GPL");