atmel_mxt_ts.c 27 KB

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