melfas_mip4.c 38 KB

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