melfas_mip4.c 36 KB

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