atmel_mxt_ts.c 27 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214
  1. /*
  2. * Atmel maXTouch Touchscreen driver
  3. *
  4. * Copyright (C) 2010 Samsung Electronics Co.Ltd
  5. * Author: Joonyoung Shim <jy0922.shim@samsung.com>
  6. *
  7. * This program is free software; you can redistribute it and/or modify it
  8. * under the terms of the GNU General Public License as published by the
  9. * Free Software Foundation; either version 2 of the License, or (at your
  10. * option) any later version.
  11. *
  12. */
  13. #include <linux/module.h>
  14. #include <linux/init.h>
  15. #include <linux/delay.h>
  16. #include <linux/firmware.h>
  17. #include <linux/i2c.h>
  18. #include <linux/i2c/atmel_mxt_ts.h>
  19. #include <linux/input.h>
  20. #include <linux/interrupt.h>
  21. #include <linux/slab.h>
  22. /* Version */
  23. #define MXT_VER_20 20
  24. #define MXT_VER_21 21
  25. #define MXT_VER_22 22
  26. /* Slave addresses */
  27. #define MXT_APP_LOW 0x4a
  28. #define MXT_APP_HIGH 0x4b
  29. #define MXT_BOOT_LOW 0x24
  30. #define MXT_BOOT_HIGH 0x25
  31. /* Firmware */
  32. #define MXT_FW_NAME "maxtouch.fw"
  33. /* Registers */
  34. #define MXT_FAMILY_ID 0x00
  35. #define MXT_VARIANT_ID 0x01
  36. #define MXT_VERSION 0x02
  37. #define MXT_BUILD 0x03
  38. #define MXT_MATRIX_X_SIZE 0x04
  39. #define MXT_MATRIX_Y_SIZE 0x05
  40. #define MXT_OBJECT_NUM 0x06
  41. #define MXT_OBJECT_START 0x07
  42. #define MXT_OBJECT_SIZE 6
  43. /* Object types */
  44. #define MXT_DEBUG_DIAGNOSTIC 37
  45. #define MXT_GEN_MESSAGE 5
  46. #define MXT_GEN_COMMAND 6
  47. #define MXT_GEN_POWER 7
  48. #define MXT_GEN_ACQUIRE 8
  49. #define MXT_TOUCH_MULTI 9
  50. #define MXT_TOUCH_KEYARRAY 15
  51. #define MXT_TOUCH_PROXIMITY 23
  52. #define MXT_PROCI_GRIPFACE 20
  53. #define MXT_PROCG_NOISE 22
  54. #define MXT_PROCI_ONETOUCH 24
  55. #define MXT_PROCI_TWOTOUCH 27
  56. #define MXT_SPT_COMMSCONFIG 18 /* firmware ver 21 over */
  57. #define MXT_SPT_GPIOPWM 19
  58. #define MXT_SPT_SELFTEST 25
  59. #define MXT_SPT_CTECONFIG 28
  60. #define MXT_SPT_USERDATA 38 /* firmware ver 21 over */
  61. /* MXT_GEN_COMMAND field */
  62. #define MXT_COMMAND_RESET 0
  63. #define MXT_COMMAND_BACKUPNV 1
  64. #define MXT_COMMAND_CALIBRATE 2
  65. #define MXT_COMMAND_REPORTALL 3
  66. #define MXT_COMMAND_DIAGNOSTIC 5
  67. /* MXT_GEN_POWER field */
  68. #define MXT_POWER_IDLEACQINT 0
  69. #define MXT_POWER_ACTVACQINT 1
  70. #define MXT_POWER_ACTV2IDLETO 2
  71. /* MXT_GEN_ACQUIRE field */
  72. #define MXT_ACQUIRE_CHRGTIME 0
  73. #define MXT_ACQUIRE_TCHDRIFT 2
  74. #define MXT_ACQUIRE_DRIFTST 3
  75. #define MXT_ACQUIRE_TCHAUTOCAL 4
  76. #define MXT_ACQUIRE_SYNC 5
  77. #define MXT_ACQUIRE_ATCHCALST 6
  78. #define MXT_ACQUIRE_ATCHCALSTHR 7
  79. /* MXT_TOUCH_MULTI field */
  80. #define MXT_TOUCH_CTRL 0
  81. #define MXT_TOUCH_XORIGIN 1
  82. #define MXT_TOUCH_YORIGIN 2
  83. #define MXT_TOUCH_XSIZE 3
  84. #define MXT_TOUCH_YSIZE 4
  85. #define MXT_TOUCH_BLEN 6
  86. #define MXT_TOUCH_TCHTHR 7
  87. #define MXT_TOUCH_TCHDI 8
  88. #define MXT_TOUCH_ORIENT 9
  89. #define MXT_TOUCH_MOVHYSTI 11
  90. #define MXT_TOUCH_MOVHYSTN 12
  91. #define MXT_TOUCH_NUMTOUCH 14
  92. #define MXT_TOUCH_MRGHYST 15
  93. #define MXT_TOUCH_MRGTHR 16
  94. #define MXT_TOUCH_AMPHYST 17
  95. #define MXT_TOUCH_XRANGE_LSB 18
  96. #define MXT_TOUCH_XRANGE_MSB 19
  97. #define MXT_TOUCH_YRANGE_LSB 20
  98. #define MXT_TOUCH_YRANGE_MSB 21
  99. #define MXT_TOUCH_XLOCLIP 22
  100. #define MXT_TOUCH_XHICLIP 23
  101. #define MXT_TOUCH_YLOCLIP 24
  102. #define MXT_TOUCH_YHICLIP 25
  103. #define MXT_TOUCH_XEDGECTRL 26
  104. #define MXT_TOUCH_XEDGEDIST 27
  105. #define MXT_TOUCH_YEDGECTRL 28
  106. #define MXT_TOUCH_YEDGEDIST 29
  107. #define MXT_TOUCH_JUMPLIMIT 30 /* firmware ver 22 over */
  108. /* MXT_PROCI_GRIPFACE field */
  109. #define MXT_GRIPFACE_CTRL 0
  110. #define MXT_GRIPFACE_XLOGRIP 1
  111. #define MXT_GRIPFACE_XHIGRIP 2
  112. #define MXT_GRIPFACE_YLOGRIP 3
  113. #define MXT_GRIPFACE_YHIGRIP 4
  114. #define MXT_GRIPFACE_MAXTCHS 5
  115. #define MXT_GRIPFACE_SZTHR1 7
  116. #define MXT_GRIPFACE_SZTHR2 8
  117. #define MXT_GRIPFACE_SHPTHR1 9
  118. #define MXT_GRIPFACE_SHPTHR2 10
  119. #define MXT_GRIPFACE_SUPEXTTO 11
  120. /* MXT_PROCI_NOISE field */
  121. #define MXT_NOISE_CTRL 0
  122. #define MXT_NOISE_OUTFLEN 1
  123. #define MXT_NOISE_GCAFUL_LSB 3
  124. #define MXT_NOISE_GCAFUL_MSB 4
  125. #define MXT_NOISE_GCAFLL_LSB 5
  126. #define MXT_NOISE_GCAFLL_MSB 6
  127. #define MXT_NOISE_ACTVGCAFVALID 7
  128. #define MXT_NOISE_NOISETHR 8
  129. #define MXT_NOISE_FREQHOPSCALE 10
  130. #define MXT_NOISE_FREQ0 11
  131. #define MXT_NOISE_FREQ1 12
  132. #define MXT_NOISE_FREQ2 13
  133. #define MXT_NOISE_FREQ3 14
  134. #define MXT_NOISE_FREQ4 15
  135. #define MXT_NOISE_IDLEGCAFVALID 16
  136. /* MXT_SPT_COMMSCONFIG */
  137. #define MXT_COMMS_CTRL 0
  138. #define MXT_COMMS_CMD 1
  139. /* MXT_SPT_CTECONFIG field */
  140. #define MXT_CTE_CTRL 0
  141. #define MXT_CTE_CMD 1
  142. #define MXT_CTE_MODE 2
  143. #define MXT_CTE_IDLEGCAFDEPTH 3
  144. #define MXT_CTE_ACTVGCAFDEPTH 4
  145. #define MXT_CTE_VOLTAGE 5 /* firmware ver 21 over */
  146. #define MXT_VOLTAGE_DEFAULT 2700000
  147. #define MXT_VOLTAGE_STEP 10000
  148. /* Define for MXT_GEN_COMMAND */
  149. #define MXT_BOOT_VALUE 0xa5
  150. #define MXT_BACKUP_VALUE 0x55
  151. #define MXT_BACKUP_TIME 25 /* msec */
  152. #define MXT_RESET_TIME 65 /* msec */
  153. #define MXT_FWRESET_TIME 175 /* msec */
  154. /* Command to unlock bootloader */
  155. #define MXT_UNLOCK_CMD_MSB 0xaa
  156. #define MXT_UNLOCK_CMD_LSB 0xdc
  157. /* Bootloader mode status */
  158. #define MXT_WAITING_BOOTLOAD_CMD 0xc0 /* valid 7 6 bit only */
  159. #define MXT_WAITING_FRAME_DATA 0x80 /* valid 7 6 bit only */
  160. #define MXT_FRAME_CRC_CHECK 0x02
  161. #define MXT_FRAME_CRC_FAIL 0x03
  162. #define MXT_FRAME_CRC_PASS 0x04
  163. #define MXT_APP_CRC_FAIL 0x40 /* valid 7 8 bit only */
  164. #define MXT_BOOT_STATUS_MASK 0x3f
  165. /* Touch status */
  166. #define MXT_SUPPRESS (1 << 1)
  167. #define MXT_AMP (1 << 2)
  168. #define MXT_VECTOR (1 << 3)
  169. #define MXT_MOVE (1 << 4)
  170. #define MXT_RELEASE (1 << 5)
  171. #define MXT_PRESS (1 << 6)
  172. #define MXT_DETECT (1 << 7)
  173. /* Touchscreen absolute values */
  174. #define MXT_MAX_XC 0x3ff
  175. #define MXT_MAX_YC 0x3ff
  176. #define MXT_MAX_AREA 0xff
  177. #define MXT_MAX_FINGER 10
  178. struct mxt_info {
  179. u8 family_id;
  180. u8 variant_id;
  181. u8 version;
  182. u8 build;
  183. u8 matrix_xsize;
  184. u8 matrix_ysize;
  185. u8 object_num;
  186. };
  187. struct mxt_object {
  188. u8 type;
  189. u16 start_address;
  190. u8 size;
  191. u8 instances;
  192. u8 num_report_ids;
  193. /* to map object and message */
  194. u8 max_reportid;
  195. };
  196. struct mxt_message {
  197. u8 reportid;
  198. u8 message[7];
  199. u8 checksum;
  200. };
  201. struct mxt_finger {
  202. int status;
  203. int x;
  204. int y;
  205. int area;
  206. };
  207. /* Each client has this additional data */
  208. struct mxt_data {
  209. struct i2c_client *client;
  210. struct input_dev *input_dev;
  211. const struct mxt_platform_data *pdata;
  212. struct mxt_object *object_table;
  213. struct mxt_info info;
  214. struct mxt_finger finger[MXT_MAX_FINGER];
  215. unsigned int irq;
  216. };
  217. static bool mxt_object_readable(unsigned int type)
  218. {
  219. switch (type) {
  220. case MXT_GEN_MESSAGE:
  221. case MXT_GEN_COMMAND:
  222. case MXT_GEN_POWER:
  223. case MXT_GEN_ACQUIRE:
  224. case MXT_TOUCH_MULTI:
  225. case MXT_TOUCH_KEYARRAY:
  226. case MXT_TOUCH_PROXIMITY:
  227. case MXT_PROCI_GRIPFACE:
  228. case MXT_PROCG_NOISE:
  229. case MXT_PROCI_ONETOUCH:
  230. case MXT_PROCI_TWOTOUCH:
  231. case MXT_SPT_COMMSCONFIG:
  232. case MXT_SPT_GPIOPWM:
  233. case MXT_SPT_SELFTEST:
  234. case MXT_SPT_CTECONFIG:
  235. case MXT_SPT_USERDATA:
  236. return true;
  237. default:
  238. return false;
  239. }
  240. }
  241. static bool mxt_object_writable(unsigned int type)
  242. {
  243. switch (type) {
  244. case MXT_GEN_COMMAND:
  245. case MXT_GEN_POWER:
  246. case MXT_GEN_ACQUIRE:
  247. case MXT_TOUCH_MULTI:
  248. case MXT_TOUCH_KEYARRAY:
  249. case MXT_TOUCH_PROXIMITY:
  250. case MXT_PROCI_GRIPFACE:
  251. case MXT_PROCG_NOISE:
  252. case MXT_PROCI_ONETOUCH:
  253. case MXT_PROCI_TWOTOUCH:
  254. case MXT_SPT_GPIOPWM:
  255. case MXT_SPT_SELFTEST:
  256. case MXT_SPT_CTECONFIG:
  257. return true;
  258. default:
  259. return false;
  260. }
  261. }
  262. static void mxt_dump_message(struct device *dev,
  263. struct mxt_message *message)
  264. {
  265. dev_dbg(dev, "reportid:\t0x%x\n", message->reportid);
  266. dev_dbg(dev, "message1:\t0x%x\n", message->message[0]);
  267. dev_dbg(dev, "message2:\t0x%x\n", message->message[1]);
  268. dev_dbg(dev, "message3:\t0x%x\n", message->message[2]);
  269. dev_dbg(dev, "message4:\t0x%x\n", message->message[3]);
  270. dev_dbg(dev, "message5:\t0x%x\n", message->message[4]);
  271. dev_dbg(dev, "message6:\t0x%x\n", message->message[5]);
  272. dev_dbg(dev, "message7:\t0x%x\n", message->message[6]);
  273. dev_dbg(dev, "checksum:\t0x%x\n", message->checksum);
  274. }
  275. static int mxt_check_bootloader(struct i2c_client *client,
  276. unsigned int state)
  277. {
  278. u8 val;
  279. recheck:
  280. if (i2c_master_recv(client, &val, 1) != 1) {
  281. dev_err(&client->dev, "%s: i2c recv failed\n", __func__);
  282. return -EIO;
  283. }
  284. switch (state) {
  285. case MXT_WAITING_BOOTLOAD_CMD:
  286. case MXT_WAITING_FRAME_DATA:
  287. val &= ~MXT_BOOT_STATUS_MASK;
  288. break;
  289. case MXT_FRAME_CRC_PASS:
  290. if (val == MXT_FRAME_CRC_CHECK)
  291. goto recheck;
  292. break;
  293. default:
  294. return -EINVAL;
  295. }
  296. if (val != state) {
  297. dev_err(&client->dev, "Unvalid bootloader mode state\n");
  298. return -EINVAL;
  299. }
  300. return 0;
  301. }
  302. static int mxt_unlock_bootloader(struct i2c_client *client)
  303. {
  304. u8 buf[2];
  305. buf[0] = MXT_UNLOCK_CMD_LSB;
  306. buf[1] = MXT_UNLOCK_CMD_MSB;
  307. if (i2c_master_send(client, buf, 2) != 2) {
  308. dev_err(&client->dev, "%s: i2c send failed\n", __func__);
  309. return -EIO;
  310. }
  311. return 0;
  312. }
  313. static int mxt_fw_write(struct i2c_client *client,
  314. const u8 *data, unsigned int frame_size)
  315. {
  316. if (i2c_master_send(client, data, frame_size) != frame_size) {
  317. dev_err(&client->dev, "%s: i2c send failed\n", __func__);
  318. return -EIO;
  319. }
  320. return 0;
  321. }
  322. static int __mxt_read_reg(struct i2c_client *client,
  323. u16 reg, u16 len, void *val)
  324. {
  325. struct i2c_msg xfer[2];
  326. u8 buf[2];
  327. buf[0] = reg & 0xff;
  328. buf[1] = (reg >> 8) & 0xff;
  329. /* Write register */
  330. xfer[0].addr = client->addr;
  331. xfer[0].flags = 0;
  332. xfer[0].len = 2;
  333. xfer[0].buf = buf;
  334. /* Read data */
  335. xfer[1].addr = client->addr;
  336. xfer[1].flags = I2C_M_RD;
  337. xfer[1].len = len;
  338. xfer[1].buf = val;
  339. if (i2c_transfer(client->adapter, xfer, 2) != 2) {
  340. dev_err(&client->dev, "%s: i2c transfer failed\n", __func__);
  341. return -EIO;
  342. }
  343. return 0;
  344. }
  345. static int mxt_read_reg(struct i2c_client *client, u16 reg, u8 *val)
  346. {
  347. return __mxt_read_reg(client, reg, 1, val);
  348. }
  349. static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
  350. {
  351. u8 buf[3];
  352. buf[0] = reg & 0xff;
  353. buf[1] = (reg >> 8) & 0xff;
  354. buf[2] = val;
  355. if (i2c_master_send(client, buf, 3) != 3) {
  356. dev_err(&client->dev, "%s: i2c send failed\n", __func__);
  357. return -EIO;
  358. }
  359. return 0;
  360. }
  361. static int mxt_read_object_table(struct i2c_client *client,
  362. u16 reg, u8 *object_buf)
  363. {
  364. return __mxt_read_reg(client, reg, MXT_OBJECT_SIZE,
  365. object_buf);
  366. }
  367. static struct mxt_object *
  368. mxt_get_object(struct mxt_data *data, u8 type)
  369. {
  370. struct mxt_object *object;
  371. int i;
  372. for (i = 0; i < data->info.object_num; i++) {
  373. object = data->object_table + i;
  374. if (object->type == type)
  375. return object;
  376. }
  377. dev_err(&data->client->dev, "Invalid object type\n");
  378. return NULL;
  379. }
  380. static int mxt_read_message(struct mxt_data *data,
  381. struct mxt_message *message)
  382. {
  383. struct mxt_object *object;
  384. u16 reg;
  385. object = mxt_get_object(data, MXT_GEN_MESSAGE);
  386. if (!object)
  387. return -EINVAL;
  388. reg = object->start_address;
  389. return __mxt_read_reg(data->client, reg,
  390. sizeof(struct mxt_message), message);
  391. }
  392. static int mxt_read_object(struct mxt_data *data,
  393. u8 type, u8 offset, u8 *val)
  394. {
  395. struct mxt_object *object;
  396. u16 reg;
  397. object = mxt_get_object(data, type);
  398. if (!object)
  399. return -EINVAL;
  400. reg = object->start_address;
  401. return __mxt_read_reg(data->client, reg + offset, 1, val);
  402. }
  403. static int mxt_write_object(struct mxt_data *data,
  404. u8 type, u8 offset, u8 val)
  405. {
  406. struct mxt_object *object;
  407. u16 reg;
  408. object = mxt_get_object(data, type);
  409. if (!object)
  410. return -EINVAL;
  411. reg = object->start_address;
  412. return mxt_write_reg(data->client, reg + offset, val);
  413. }
  414. static void mxt_input_report(struct mxt_data *data, int single_id)
  415. {
  416. struct mxt_finger *finger = data->finger;
  417. struct input_dev *input_dev = data->input_dev;
  418. int status = finger[single_id].status;
  419. int finger_num = 0;
  420. int id;
  421. for (id = 0; id < MXT_MAX_FINGER; id++) {
  422. if (!finger[id].status)
  423. continue;
  424. input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR,
  425. finger[id].status != MXT_RELEASE ?
  426. finger[id].area : 0);
  427. input_report_abs(input_dev, ABS_MT_POSITION_X,
  428. finger[id].x);
  429. input_report_abs(input_dev, ABS_MT_POSITION_Y,
  430. finger[id].y);
  431. input_mt_sync(input_dev);
  432. if (finger[id].status == MXT_RELEASE)
  433. finger[id].status = 0;
  434. else
  435. finger_num++;
  436. }
  437. input_report_key(input_dev, BTN_TOUCH, finger_num > 0);
  438. if (status != MXT_RELEASE) {
  439. input_report_abs(input_dev, ABS_X, finger[single_id].x);
  440. input_report_abs(input_dev, ABS_Y, finger[single_id].y);
  441. }
  442. input_sync(input_dev);
  443. }
  444. static void mxt_input_touchevent(struct mxt_data *data,
  445. struct mxt_message *message, int id)
  446. {
  447. struct mxt_finger *finger = data->finger;
  448. struct device *dev = &data->client->dev;
  449. u8 status = message->message[0];
  450. int x;
  451. int y;
  452. int area;
  453. /* Check the touch is present on the screen */
  454. if (!(status & MXT_DETECT)) {
  455. if (status & MXT_RELEASE) {
  456. dev_dbg(dev, "[%d] released\n", id);
  457. finger[id].status = MXT_RELEASE;
  458. mxt_input_report(data, id);
  459. }
  460. return;
  461. }
  462. /* Check only AMP detection */
  463. if (!(status & (MXT_PRESS | MXT_MOVE)))
  464. return;
  465. x = (message->message[1] << 2) | ((message->message[3] & ~0x3f) >> 6);
  466. y = (message->message[2] << 2) | ((message->message[3] & ~0xf3) >> 2);
  467. area = message->message[4];
  468. dev_dbg(dev, "[%d] %s x: %d, y: %d, area: %d\n", id,
  469. status & MXT_MOVE ? "moved" : "pressed",
  470. x, y, area);
  471. finger[id].status = status & MXT_MOVE ?
  472. MXT_MOVE : MXT_PRESS;
  473. finger[id].x = x;
  474. finger[id].y = y;
  475. finger[id].area = area;
  476. mxt_input_report(data, id);
  477. }
  478. static irqreturn_t mxt_interrupt(int irq, void *dev_id)
  479. {
  480. struct mxt_data *data = dev_id;
  481. struct mxt_message message;
  482. struct mxt_object *object;
  483. struct device *dev = &data->client->dev;
  484. int id;
  485. u8 reportid;
  486. u8 max_reportid;
  487. u8 min_reportid;
  488. do {
  489. if (mxt_read_message(data, &message)) {
  490. dev_err(dev, "Failed to read message\n");
  491. goto end;
  492. }
  493. reportid = message.reportid;
  494. /* whether reportid is thing of MXT_TOUCH_MULTI */
  495. object = mxt_get_object(data, MXT_TOUCH_MULTI);
  496. if (!object)
  497. goto end;
  498. max_reportid = object->max_reportid;
  499. min_reportid = max_reportid - object->num_report_ids + 1;
  500. id = reportid - min_reportid;
  501. if (reportid >= min_reportid && reportid <= max_reportid)
  502. mxt_input_touchevent(data, &message, id);
  503. else
  504. mxt_dump_message(dev, &message);
  505. } while (reportid != 0xff);
  506. end:
  507. return IRQ_HANDLED;
  508. }
  509. static int mxt_check_reg_init(struct mxt_data *data)
  510. {
  511. const struct mxt_platform_data *pdata = data->pdata;
  512. struct mxt_object *object;
  513. struct device *dev = &data->client->dev;
  514. int index = 0;
  515. int i, j, config_offset;
  516. if (!pdata->config) {
  517. dev_dbg(dev, "No cfg data defined, skipping reg init\n");
  518. return 0;
  519. }
  520. for (i = 0; i < data->info.object_num; i++) {
  521. object = data->object_table + i;
  522. if (!mxt_object_writable(object->type))
  523. continue;
  524. for (j = 0; j < object->size + 1; j++) {
  525. config_offset = index + j;
  526. if (config_offset > pdata->config_length) {
  527. dev_err(dev, "Not enough config data!\n");
  528. return -EINVAL;
  529. }
  530. mxt_write_object(data, object->type, j,
  531. pdata->config[config_offset]);
  532. }
  533. index += object->size + 1;
  534. }
  535. return 0;
  536. }
  537. static int mxt_make_highchg(struct mxt_data *data)
  538. {
  539. struct device *dev = &data->client->dev;
  540. struct mxt_message message;
  541. int count = 10;
  542. int error;
  543. /* Read dummy message to make high CHG pin */
  544. do {
  545. error = mxt_read_message(data, &message);
  546. if (error)
  547. return error;
  548. } while (message.reportid != 0xff && --count);
  549. if (!count) {
  550. dev_err(dev, "CHG pin isn't cleared\n");
  551. return -EBUSY;
  552. }
  553. return 0;
  554. }
  555. static void mxt_handle_pdata(struct mxt_data *data)
  556. {
  557. const struct mxt_platform_data *pdata = data->pdata;
  558. u8 voltage;
  559. /* Set touchscreen lines */
  560. mxt_write_object(data, MXT_TOUCH_MULTI, MXT_TOUCH_XSIZE,
  561. pdata->x_line);
  562. mxt_write_object(data, MXT_TOUCH_MULTI, MXT_TOUCH_YSIZE,
  563. pdata->y_line);
  564. /* Set touchscreen orient */
  565. mxt_write_object(data, MXT_TOUCH_MULTI, MXT_TOUCH_ORIENT,
  566. pdata->orient);
  567. /* Set touchscreen burst length */
  568. mxt_write_object(data, MXT_TOUCH_MULTI,
  569. MXT_TOUCH_BLEN, pdata->blen);
  570. /* Set touchscreen threshold */
  571. mxt_write_object(data, MXT_TOUCH_MULTI,
  572. MXT_TOUCH_TCHTHR, pdata->threshold);
  573. /* Set touchscreen resolution */
  574. mxt_write_object(data, MXT_TOUCH_MULTI,
  575. MXT_TOUCH_XRANGE_LSB, (pdata->x_size - 1) & 0xff);
  576. mxt_write_object(data, MXT_TOUCH_MULTI,
  577. MXT_TOUCH_XRANGE_MSB, (pdata->x_size - 1) >> 8);
  578. mxt_write_object(data, MXT_TOUCH_MULTI,
  579. MXT_TOUCH_YRANGE_LSB, (pdata->y_size - 1) & 0xff);
  580. mxt_write_object(data, MXT_TOUCH_MULTI,
  581. MXT_TOUCH_YRANGE_MSB, (pdata->y_size - 1) >> 8);
  582. /* Set touchscreen voltage */
  583. if (data->info.version >= MXT_VER_21 && pdata->voltage) {
  584. if (pdata->voltage < MXT_VOLTAGE_DEFAULT) {
  585. voltage = (MXT_VOLTAGE_DEFAULT - pdata->voltage) /
  586. MXT_VOLTAGE_STEP;
  587. voltage = 0xff - voltage + 1;
  588. } else
  589. voltage = (pdata->voltage - MXT_VOLTAGE_DEFAULT) /
  590. MXT_VOLTAGE_STEP;
  591. mxt_write_object(data, MXT_SPT_CTECONFIG,
  592. MXT_CTE_VOLTAGE, voltage);
  593. }
  594. }
  595. static int mxt_get_info(struct mxt_data *data)
  596. {
  597. struct i2c_client *client = data->client;
  598. struct mxt_info *info = &data->info;
  599. int error;
  600. u8 val;
  601. error = mxt_read_reg(client, MXT_FAMILY_ID, &val);
  602. if (error)
  603. return error;
  604. info->family_id = val;
  605. error = mxt_read_reg(client, MXT_VARIANT_ID, &val);
  606. if (error)
  607. return error;
  608. info->variant_id = val;
  609. error = mxt_read_reg(client, MXT_VERSION, &val);
  610. if (error)
  611. return error;
  612. info->version = val;
  613. error = mxt_read_reg(client, MXT_BUILD, &val);
  614. if (error)
  615. return error;
  616. info->build = val;
  617. error = mxt_read_reg(client, MXT_OBJECT_NUM, &val);
  618. if (error)
  619. return error;
  620. info->object_num = val;
  621. return 0;
  622. }
  623. static int mxt_get_object_table(struct mxt_data *data)
  624. {
  625. int error;
  626. int i;
  627. u16 reg;
  628. u8 reportid = 0;
  629. u8 buf[MXT_OBJECT_SIZE];
  630. for (i = 0; i < data->info.object_num; i++) {
  631. struct mxt_object *object = data->object_table + i;
  632. reg = MXT_OBJECT_START + MXT_OBJECT_SIZE * i;
  633. error = mxt_read_object_table(data->client, reg, buf);
  634. if (error)
  635. return error;
  636. object->type = buf[0];
  637. object->start_address = (buf[2] << 8) | buf[1];
  638. object->size = buf[3];
  639. object->instances = buf[4];
  640. object->num_report_ids = buf[5];
  641. if (object->num_report_ids) {
  642. reportid += object->num_report_ids *
  643. (object->instances + 1);
  644. object->max_reportid = reportid;
  645. }
  646. }
  647. return 0;
  648. }
  649. static int mxt_initialize(struct mxt_data *data)
  650. {
  651. struct i2c_client *client = data->client;
  652. struct mxt_info *info = &data->info;
  653. int error;
  654. u8 val;
  655. error = mxt_get_info(data);
  656. if (error)
  657. return error;
  658. data->object_table = kcalloc(info->object_num,
  659. sizeof(struct mxt_object),
  660. GFP_KERNEL);
  661. if (!data->object_table) {
  662. dev_err(&client->dev, "Failed to allocate memory\n");
  663. return -ENOMEM;
  664. }
  665. /* Get object table information */
  666. error = mxt_get_object_table(data);
  667. if (error)
  668. return error;
  669. /* Check register init values */
  670. error = mxt_check_reg_init(data);
  671. if (error)
  672. return error;
  673. error = mxt_make_highchg(data);
  674. if (error)
  675. return error;
  676. mxt_handle_pdata(data);
  677. /* Backup to memory */
  678. mxt_write_object(data, MXT_GEN_COMMAND,
  679. MXT_COMMAND_BACKUPNV,
  680. MXT_BACKUP_VALUE);
  681. msleep(MXT_BACKUP_TIME);
  682. /* Soft reset */
  683. mxt_write_object(data, MXT_GEN_COMMAND,
  684. MXT_COMMAND_RESET, 1);
  685. msleep(MXT_RESET_TIME);
  686. /* Update matrix size at info struct */
  687. error = mxt_read_reg(client, MXT_MATRIX_X_SIZE, &val);
  688. if (error)
  689. return error;
  690. info->matrix_xsize = val;
  691. error = mxt_read_reg(client, MXT_MATRIX_Y_SIZE, &val);
  692. if (error)
  693. return error;
  694. info->matrix_ysize = val;
  695. dev_info(&client->dev,
  696. "Family ID: %d Variant ID: %d Version: %d Build: %d\n",
  697. info->family_id, info->variant_id, info->version,
  698. info->build);
  699. dev_info(&client->dev,
  700. "Matrix X Size: %d Matrix Y Size: %d Object Num: %d\n",
  701. info->matrix_xsize, info->matrix_ysize,
  702. info->object_num);
  703. return 0;
  704. }
  705. static ssize_t mxt_object_show(struct device *dev,
  706. struct device_attribute *attr, char *buf)
  707. {
  708. struct mxt_data *data = dev_get_drvdata(dev);
  709. struct mxt_object *object;
  710. int count = 0;
  711. int i, j;
  712. int error;
  713. u8 val;
  714. for (i = 0; i < data->info.object_num; i++) {
  715. object = data->object_table + i;
  716. count += sprintf(buf + count,
  717. "Object Table Element %d(Type %d)\n",
  718. i + 1, object->type);
  719. if (!mxt_object_readable(object->type)) {
  720. count += sprintf(buf + count, "\n");
  721. continue;
  722. }
  723. for (j = 0; j < object->size + 1; j++) {
  724. error = mxt_read_object(data,
  725. object->type, j, &val);
  726. if (error)
  727. return error;
  728. count += sprintf(buf + count,
  729. " Byte %d: 0x%x (%d)\n", j, val, val);
  730. }
  731. count += sprintf(buf + count, "\n");
  732. }
  733. return count;
  734. }
  735. static int mxt_load_fw(struct device *dev, const char *fn)
  736. {
  737. struct mxt_data *data = dev_get_drvdata(dev);
  738. struct i2c_client *client = data->client;
  739. const struct firmware *fw = NULL;
  740. unsigned int frame_size;
  741. unsigned int pos = 0;
  742. int ret;
  743. ret = request_firmware(&fw, fn, dev);
  744. if (ret) {
  745. dev_err(dev, "Unable to open firmware %s\n", fn);
  746. return ret;
  747. }
  748. /* Change to the bootloader mode */
  749. mxt_write_object(data, MXT_GEN_COMMAND,
  750. MXT_COMMAND_RESET, MXT_BOOT_VALUE);
  751. msleep(MXT_RESET_TIME);
  752. /* Change to slave address of bootloader */
  753. if (client->addr == MXT_APP_LOW)
  754. client->addr = MXT_BOOT_LOW;
  755. else
  756. client->addr = MXT_BOOT_HIGH;
  757. ret = mxt_check_bootloader(client, MXT_WAITING_BOOTLOAD_CMD);
  758. if (ret)
  759. goto out;
  760. /* Unlock bootloader */
  761. mxt_unlock_bootloader(client);
  762. while (pos < fw->size) {
  763. ret = mxt_check_bootloader(client,
  764. MXT_WAITING_FRAME_DATA);
  765. if (ret)
  766. goto out;
  767. frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1));
  768. /* We should add 2 at frame size as the the firmware data is not
  769. * included the CRC bytes.
  770. */
  771. frame_size += 2;
  772. /* Write one frame to device */
  773. mxt_fw_write(client, fw->data + pos, frame_size);
  774. ret = mxt_check_bootloader(client,
  775. MXT_FRAME_CRC_PASS);
  776. if (ret)
  777. goto out;
  778. pos += frame_size;
  779. dev_dbg(dev, "Updated %d bytes / %zd bytes\n", pos, fw->size);
  780. }
  781. out:
  782. release_firmware(fw);
  783. /* Change to slave address of application */
  784. if (client->addr == MXT_BOOT_LOW)
  785. client->addr = MXT_APP_LOW;
  786. else
  787. client->addr = MXT_APP_HIGH;
  788. return ret;
  789. }
  790. static ssize_t mxt_update_fw_store(struct device *dev,
  791. struct device_attribute *attr,
  792. const char *buf, size_t count)
  793. {
  794. struct mxt_data *data = dev_get_drvdata(dev);
  795. unsigned int version;
  796. int error;
  797. if (sscanf(buf, "%u", &version) != 1) {
  798. dev_err(dev, "Invalid values\n");
  799. return -EINVAL;
  800. }
  801. if (data->info.version < MXT_VER_21 || version < MXT_VER_21) {
  802. dev_err(dev, "FW update supported starting with version 21\n");
  803. return -EINVAL;
  804. }
  805. disable_irq(data->irq);
  806. error = mxt_load_fw(dev, MXT_FW_NAME);
  807. if (error) {
  808. dev_err(dev, "The firmware update failed(%d)\n", error);
  809. count = error;
  810. } else {
  811. dev_dbg(dev, "The firmware update succeeded\n");
  812. /* Wait for reset */
  813. msleep(MXT_FWRESET_TIME);
  814. kfree(data->object_table);
  815. data->object_table = NULL;
  816. mxt_initialize(data);
  817. }
  818. enable_irq(data->irq);
  819. return count;
  820. }
  821. static DEVICE_ATTR(object, 0444, mxt_object_show, NULL);
  822. static DEVICE_ATTR(update_fw, 0664, NULL, mxt_update_fw_store);
  823. static struct attribute *mxt_attrs[] = {
  824. &dev_attr_object.attr,
  825. &dev_attr_update_fw.attr,
  826. NULL
  827. };
  828. static const struct attribute_group mxt_attr_group = {
  829. .attrs = mxt_attrs,
  830. };
  831. static void mxt_start(struct mxt_data *data)
  832. {
  833. /* Touch enable */
  834. mxt_write_object(data,
  835. MXT_TOUCH_MULTI, MXT_TOUCH_CTRL, 0x83);
  836. }
  837. static void mxt_stop(struct mxt_data *data)
  838. {
  839. /* Touch disable */
  840. mxt_write_object(data,
  841. MXT_TOUCH_MULTI, MXT_TOUCH_CTRL, 0);
  842. }
  843. static int mxt_input_open(struct input_dev *dev)
  844. {
  845. struct mxt_data *data = input_get_drvdata(dev);
  846. mxt_start(data);
  847. return 0;
  848. }
  849. static void mxt_input_close(struct input_dev *dev)
  850. {
  851. struct mxt_data *data = input_get_drvdata(dev);
  852. mxt_stop(data);
  853. }
  854. static int __devinit mxt_probe(struct i2c_client *client,
  855. const struct i2c_device_id *id)
  856. {
  857. const struct mxt_platform_data *pdata = client->dev.platform_data;
  858. struct mxt_data *data;
  859. struct input_dev *input_dev;
  860. int error;
  861. if (!pdata)
  862. return -EINVAL;
  863. data = kzalloc(sizeof(struct mxt_data), GFP_KERNEL);
  864. input_dev = input_allocate_device();
  865. if (!data || !input_dev) {
  866. dev_err(&client->dev, "Failed to allocate memory\n");
  867. error = -ENOMEM;
  868. goto err_free_mem;
  869. }
  870. input_dev->name = "Atmel maXTouch Touchscreen";
  871. input_dev->id.bustype = BUS_I2C;
  872. input_dev->dev.parent = &client->dev;
  873. input_dev->open = mxt_input_open;
  874. input_dev->close = mxt_input_close;
  875. __set_bit(EV_ABS, input_dev->evbit);
  876. __set_bit(EV_KEY, input_dev->evbit);
  877. __set_bit(BTN_TOUCH, input_dev->keybit);
  878. /* For single touch */
  879. input_set_abs_params(input_dev, ABS_X,
  880. 0, MXT_MAX_XC, 0, 0);
  881. input_set_abs_params(input_dev, ABS_Y,
  882. 0, MXT_MAX_YC, 0, 0);
  883. /* For multi touch */
  884. input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
  885. 0, MXT_MAX_AREA, 0, 0);
  886. input_set_abs_params(input_dev, ABS_MT_POSITION_X,
  887. 0, MXT_MAX_XC, 0, 0);
  888. input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
  889. 0, MXT_MAX_YC, 0, 0);
  890. input_set_drvdata(input_dev, data);
  891. data->client = client;
  892. data->input_dev = input_dev;
  893. data->pdata = pdata;
  894. data->irq = client->irq;
  895. i2c_set_clientdata(client, data);
  896. error = mxt_initialize(data);
  897. if (error)
  898. goto err_free_object;
  899. error = request_threaded_irq(client->irq, NULL, mxt_interrupt,
  900. pdata->irqflags, client->dev.driver->name, data);
  901. if (error) {
  902. dev_err(&client->dev, "Failed to register interrupt\n");
  903. goto err_free_object;
  904. }
  905. error = input_register_device(input_dev);
  906. if (error)
  907. goto err_free_irq;
  908. error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
  909. if (error)
  910. goto err_unregister_device;
  911. return 0;
  912. err_unregister_device:
  913. input_unregister_device(input_dev);
  914. input_dev = NULL;
  915. err_free_irq:
  916. free_irq(client->irq, data);
  917. err_free_object:
  918. kfree(data->object_table);
  919. err_free_mem:
  920. input_free_device(input_dev);
  921. kfree(data);
  922. return error;
  923. }
  924. static int __devexit mxt_remove(struct i2c_client *client)
  925. {
  926. struct mxt_data *data = i2c_get_clientdata(client);
  927. sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
  928. free_irq(data->irq, data);
  929. input_unregister_device(data->input_dev);
  930. kfree(data->object_table);
  931. kfree(data);
  932. return 0;
  933. }
  934. #ifdef CONFIG_PM
  935. static int mxt_suspend(struct device *dev)
  936. {
  937. struct i2c_client *client = to_i2c_client(dev);
  938. struct mxt_data *data = i2c_get_clientdata(client);
  939. struct input_dev *input_dev = data->input_dev;
  940. mutex_lock(&input_dev->mutex);
  941. if (input_dev->users)
  942. mxt_stop(data);
  943. mutex_unlock(&input_dev->mutex);
  944. return 0;
  945. }
  946. static int mxt_resume(struct device *dev)
  947. {
  948. struct i2c_client *client = to_i2c_client(dev);
  949. struct mxt_data *data = i2c_get_clientdata(client);
  950. struct input_dev *input_dev = data->input_dev;
  951. /* Soft reset */
  952. mxt_write_object(data, MXT_GEN_COMMAND,
  953. MXT_COMMAND_RESET, 1);
  954. msleep(MXT_RESET_TIME);
  955. mutex_lock(&input_dev->mutex);
  956. if (input_dev->users)
  957. mxt_start(data);
  958. mutex_unlock(&input_dev->mutex);
  959. return 0;
  960. }
  961. static const struct dev_pm_ops mxt_pm_ops = {
  962. .suspend = mxt_suspend,
  963. .resume = mxt_resume,
  964. };
  965. #endif
  966. static const struct i2c_device_id mxt_id[] = {
  967. { "qt602240_ts", 0 },
  968. { "atmel_mxt_ts", 0 },
  969. { "mXT224", 0 },
  970. { }
  971. };
  972. MODULE_DEVICE_TABLE(i2c, mxt_id);
  973. static struct i2c_driver mxt_driver = {
  974. .driver = {
  975. .name = "atmel_mxt_ts",
  976. .owner = THIS_MODULE,
  977. #ifdef CONFIG_PM
  978. .pm = &mxt_pm_ops,
  979. #endif
  980. },
  981. .probe = mxt_probe,
  982. .remove = __devexit_p(mxt_remove),
  983. .id_table = mxt_id,
  984. };
  985. static int __init mxt_init(void)
  986. {
  987. return i2c_add_driver(&mxt_driver);
  988. }
  989. static void __exit mxt_exit(void)
  990. {
  991. i2c_del_driver(&mxt_driver);
  992. }
  993. module_init(mxt_init);
  994. module_exit(mxt_exit);
  995. /* Module information */
  996. MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
  997. MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
  998. MODULE_LICENSE("GPL");