melfas_mip4.c 38 KB

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