atmel_mxt_ts.c 81 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460
  1. // SPDX-License-Identifier: GPL-2.0-or-later
  2. /*
  3. * Atmel maXTouch Touchscreen driver
  4. *
  5. * Copyright (C) 2010 Samsung Electronics Co.Ltd
  6. * Copyright (C) 2011-2014 Atmel Corporation
  7. * Copyright (C) 2012 Google, Inc.
  8. * Copyright (C) 2016 Zodiac Inflight Innovations
  9. *
  10. * Author: Joonyoung Shim <jy0922.shim@samsung.com>
  11. */
  12. #include <linux/acpi.h>
  13. #include <linux/dmi.h>
  14. #include <linux/module.h>
  15. #include <linux/init.h>
  16. #include <linux/completion.h>
  17. #include <linux/delay.h>
  18. #include <linux/firmware.h>
  19. #include <linux/i2c.h>
  20. #include <linux/input/mt.h>
  21. #include <linux/interrupt.h>
  22. #include <linux/irq.h>
  23. #include <linux/of.h>
  24. #include <linux/property.h>
  25. #include <linux/slab.h>
  26. #include <linux/regulator/consumer.h>
  27. #include <linux/gpio/consumer.h>
  28. #include <linux/unaligned.h>
  29. #include <media/v4l2-device.h>
  30. #include <media/v4l2-ioctl.h>
  31. #include <media/videobuf2-v4l2.h>
  32. #include <media/videobuf2-vmalloc.h>
  33. #include <dt-bindings/input/atmel-maxtouch.h>
  34. /* Firmware files */
  35. #define MXT_FW_NAME "maxtouch.fw"
  36. #define MXT_CFG_NAME "maxtouch.cfg"
  37. #define MXT_CFG_MAGIC "OBP_RAW V1"
  38. /* Registers */
  39. #define MXT_OBJECT_START 0x07
  40. #define MXT_OBJECT_SIZE 6
  41. #define MXT_INFO_CHECKSUM_SIZE 3
  42. #define MXT_MAX_BLOCK_WRITE 256
  43. /* Object types */
  44. #define MXT_DEBUG_DIAGNOSTIC_T37 37
  45. #define MXT_GEN_MESSAGE_T5 5
  46. #define MXT_GEN_COMMAND_T6 6
  47. #define MXT_GEN_POWER_T7 7
  48. #define MXT_GEN_ACQUIRE_T8 8
  49. #define MXT_GEN_DATASOURCE_T53 53
  50. #define MXT_TOUCH_MULTI_T9 9
  51. #define MXT_TOUCH_KEYARRAY_T15 15
  52. #define MXT_TOUCH_PROXIMITY_T23 23
  53. #define MXT_TOUCH_PROXKEY_T52 52
  54. #define MXT_TOUCH_PTC_KEYS_T97 97
  55. #define MXT_PROCI_GRIPFACE_T20 20
  56. #define MXT_PROCG_NOISE_T22 22
  57. #define MXT_PROCI_ONETOUCH_T24 24
  58. #define MXT_PROCI_TWOTOUCH_T27 27
  59. #define MXT_PROCI_GRIP_T40 40
  60. #define MXT_PROCI_PALM_T41 41
  61. #define MXT_PROCI_TOUCHSUPPRESSION_T42 42
  62. #define MXT_PROCI_STYLUS_T47 47
  63. #define MXT_PROCG_NOISESUPPRESSION_T48 48
  64. #define MXT_SPT_COMMSCONFIG_T18 18
  65. #define MXT_SPT_GPIOPWM_T19 19
  66. #define MXT_SPT_SELFTEST_T25 25
  67. #define MXT_SPT_CTECONFIG_T28 28
  68. #define MXT_SPT_USERDATA_T38 38
  69. #define MXT_SPT_DIGITIZER_T43 43
  70. #define MXT_SPT_MESSAGECOUNT_T44 44
  71. #define MXT_SPT_CTECONFIG_T46 46
  72. #define MXT_SPT_DYNAMICCONFIGURATIONCONTAINER_T71 71
  73. #define MXT_TOUCH_MULTITOUCHSCREEN_T100 100
  74. /* MXT_GEN_MESSAGE_T5 object */
  75. #define MXT_RPTID_NOMSG 0xff
  76. /* MXT_GEN_COMMAND_T6 field */
  77. #define MXT_COMMAND_RESET 0
  78. #define MXT_COMMAND_BACKUPNV 1
  79. #define MXT_COMMAND_CALIBRATE 2
  80. #define MXT_COMMAND_REPORTALL 3
  81. #define MXT_COMMAND_DIAGNOSTIC 5
  82. /* Define for T6 status byte */
  83. #define MXT_T6_STATUS_RESET BIT(7)
  84. #define MXT_T6_STATUS_OFL BIT(6)
  85. #define MXT_T6_STATUS_SIGERR BIT(5)
  86. #define MXT_T6_STATUS_CAL BIT(4)
  87. #define MXT_T6_STATUS_CFGERR BIT(3)
  88. #define MXT_T6_STATUS_COMSERR BIT(2)
  89. /* MXT_GEN_POWER_T7 field */
  90. struct t7_config {
  91. u8 idle;
  92. u8 active;
  93. } __packed;
  94. #define MXT_POWER_CFG_RUN 0
  95. #define MXT_POWER_CFG_DEEPSLEEP 1
  96. /* MXT_TOUCH_MULTI_T9 field */
  97. #define MXT_T9_CTRL 0
  98. #define MXT_T9_XSIZE 3
  99. #define MXT_T9_YSIZE 4
  100. #define MXT_T9_ORIENT 9
  101. #define MXT_T9_RANGE 18
  102. /* MXT_TOUCH_MULTI_T9 status */
  103. #define MXT_T9_UNGRIP BIT(0)
  104. #define MXT_T9_SUPPRESS BIT(1)
  105. #define MXT_T9_AMP BIT(2)
  106. #define MXT_T9_VECTOR BIT(3)
  107. #define MXT_T9_MOVE BIT(4)
  108. #define MXT_T9_RELEASE BIT(5)
  109. #define MXT_T9_PRESS BIT(6)
  110. #define MXT_T9_DETECT BIT(7)
  111. struct t9_range {
  112. __le16 x;
  113. __le16 y;
  114. } __packed;
  115. /* MXT_TOUCH_MULTI_T9 orient */
  116. #define MXT_T9_ORIENT_SWITCH BIT(0)
  117. #define MXT_T9_ORIENT_INVERTX BIT(1)
  118. #define MXT_T9_ORIENT_INVERTY BIT(2)
  119. /* MXT_SPT_COMMSCONFIG_T18 */
  120. #define MXT_COMMS_CTRL 0
  121. #define MXT_COMMS_CMD 1
  122. #define MXT_COMMS_RETRIGEN BIT(6)
  123. /* MXT_DEBUG_DIAGNOSTIC_T37 */
  124. #define MXT_DIAGNOSTIC_PAGEUP 0x01
  125. #define MXT_DIAGNOSTIC_DELTAS 0x10
  126. #define MXT_DIAGNOSTIC_REFS 0x11
  127. #define MXT_DIAGNOSTIC_SIZE 128
  128. #define MXT_FAMILY_1386 160
  129. #define MXT1386_COLUMNS 3
  130. #define MXT1386_PAGES_PER_COLUMN 8
  131. struct t37_debug {
  132. #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
  133. u8 mode;
  134. u8 page;
  135. u8 data[MXT_DIAGNOSTIC_SIZE];
  136. #endif
  137. };
  138. /* Define for MXT_GEN_COMMAND_T6 */
  139. #define MXT_BOOT_VALUE 0xa5
  140. #define MXT_RESET_VALUE 0x01
  141. #define MXT_BACKUP_VALUE 0x55
  142. /* T100 Multiple Touch Touchscreen */
  143. #define MXT_T100_CTRL 0
  144. #define MXT_T100_CFG1 1
  145. #define MXT_T100_TCHAUX 3
  146. #define MXT_T100_XSIZE 9
  147. #define MXT_T100_XRANGE 13
  148. #define MXT_T100_YSIZE 20
  149. #define MXT_T100_YRANGE 24
  150. #define MXT_T100_CFG_SWITCHXY BIT(5)
  151. #define MXT_T100_CFG_INVERTY BIT(6)
  152. #define MXT_T100_CFG_INVERTX BIT(7)
  153. #define MXT_T100_TCHAUX_VECT BIT(0)
  154. #define MXT_T100_TCHAUX_AMPL BIT(1)
  155. #define MXT_T100_TCHAUX_AREA BIT(2)
  156. #define MXT_T100_DETECT BIT(7)
  157. #define MXT_T100_TYPE_MASK 0x70
  158. enum t100_type {
  159. MXT_T100_TYPE_FINGER = 1,
  160. MXT_T100_TYPE_PASSIVE_STYLUS = 2,
  161. MXT_T100_TYPE_HOVERING_FINGER = 4,
  162. MXT_T100_TYPE_GLOVE = 5,
  163. MXT_T100_TYPE_LARGE_TOUCH = 6,
  164. };
  165. #define MXT_DISTANCE_ACTIVE_TOUCH 0
  166. #define MXT_DISTANCE_HOVERING 1
  167. #define MXT_TOUCH_MAJOR_DEFAULT 1
  168. #define MXT_PRESSURE_DEFAULT 1
  169. /* Delay times */
  170. #define MXT_BACKUP_TIME 50 /* msec */
  171. #define MXT_RESET_GPIO_TIME 20 /* msec */
  172. #define MXT_RESET_INVALID_CHG 100 /* msec */
  173. #define MXT_RESET_TIME 200 /* msec */
  174. #define MXT_RESET_TIMEOUT 3000 /* msec */
  175. #define MXT_CRC_TIMEOUT 1000 /* msec */
  176. #define MXT_FW_RESET_TIME 3000 /* msec */
  177. #define MXT_FW_CHG_TIMEOUT 300 /* msec */
  178. #define MXT_WAKEUP_TIME 25 /* msec */
  179. /* Command to unlock bootloader */
  180. #define MXT_UNLOCK_CMD_MSB 0xaa
  181. #define MXT_UNLOCK_CMD_LSB 0xdc
  182. /* Bootloader mode status */
  183. #define MXT_WAITING_BOOTLOAD_CMD 0xc0 /* valid 7 6 bit only */
  184. #define MXT_WAITING_FRAME_DATA 0x80 /* valid 7 6 bit only */
  185. #define MXT_FRAME_CRC_CHECK 0x02
  186. #define MXT_FRAME_CRC_FAIL 0x03
  187. #define MXT_FRAME_CRC_PASS 0x04
  188. #define MXT_APP_CRC_FAIL 0x40 /* valid 7 8 bit only */
  189. #define MXT_BOOT_STATUS_MASK 0x3f
  190. #define MXT_BOOT_EXTENDED_ID BIT(5)
  191. #define MXT_BOOT_ID_MASK 0x1f
  192. /* Touchscreen absolute values */
  193. #define MXT_MAX_AREA 0xff
  194. #define MXT_PIXELS_PER_MM 20
  195. struct mxt_info {
  196. u8 family_id;
  197. u8 variant_id;
  198. u8 version;
  199. u8 build;
  200. u8 matrix_xsize;
  201. u8 matrix_ysize;
  202. u8 object_num;
  203. };
  204. struct mxt_object {
  205. u8 type;
  206. u16 start_address;
  207. u8 size_minus_one;
  208. u8 instances_minus_one;
  209. u8 num_report_ids;
  210. } __packed;
  211. struct mxt_dbg {
  212. u16 t37_address;
  213. u16 diag_cmd_address;
  214. struct t37_debug *t37_buf;
  215. unsigned int t37_pages;
  216. unsigned int t37_nodes;
  217. struct v4l2_device v4l2;
  218. struct v4l2_pix_format format;
  219. struct video_device vdev;
  220. struct vb2_queue queue;
  221. struct mutex lock;
  222. int input;
  223. };
  224. enum v4l_dbg_inputs {
  225. MXT_V4L_INPUT_DELTAS,
  226. MXT_V4L_INPUT_REFS,
  227. MXT_V4L_INPUT_MAX,
  228. };
  229. enum mxt_suspend_mode {
  230. MXT_SUSPEND_DEEP_SLEEP = 0,
  231. MXT_SUSPEND_T9_CTRL = 1,
  232. };
  233. /* Config update context */
  234. struct mxt_cfg {
  235. u8 *raw;
  236. size_t raw_size;
  237. off_t raw_pos;
  238. u8 *mem;
  239. size_t mem_size;
  240. int start_ofs;
  241. struct mxt_info info;
  242. };
  243. /* Each client has this additional data */
  244. struct mxt_data {
  245. struct i2c_client *client;
  246. struct input_dev *input_dev;
  247. char phys[64]; /* device physical location */
  248. struct mxt_object *object_table;
  249. struct mxt_info *info;
  250. void *raw_info_block;
  251. unsigned int irq;
  252. unsigned int max_x;
  253. unsigned int max_y;
  254. bool invertx;
  255. bool inverty;
  256. bool xy_switch;
  257. u8 xsize;
  258. u8 ysize;
  259. bool in_bootloader;
  260. u16 mem_size;
  261. u8 t100_aux_ampl;
  262. u8 t100_aux_area;
  263. u8 t100_aux_vect;
  264. u8 max_reportid;
  265. u32 config_crc;
  266. u32 info_crc;
  267. u8 bootloader_addr;
  268. u8 *msg_buf;
  269. u8 t6_status;
  270. bool update_input;
  271. u8 last_message_count;
  272. u8 num_touchids;
  273. u8 multitouch;
  274. struct t7_config t7_cfg;
  275. struct mxt_dbg dbg;
  276. struct regulator_bulk_data regulators[2];
  277. struct gpio_desc *reset_gpio;
  278. struct gpio_desc *wake_gpio;
  279. bool use_retrigen_workaround;
  280. /* Cached parameters from object table */
  281. u16 T5_address;
  282. u8 T5_msg_size;
  283. u8 T6_reportid;
  284. u16 T6_address;
  285. u16 T7_address;
  286. u16 T71_address;
  287. u8 T9_reportid_min;
  288. u8 T9_reportid_max;
  289. u8 T15_reportid_min;
  290. u8 T15_reportid_max;
  291. u16 T18_address;
  292. u8 T19_reportid;
  293. u16 T44_address;
  294. u8 T97_reportid_min;
  295. u8 T97_reportid_max;
  296. u8 T100_reportid_min;
  297. u8 T100_reportid_max;
  298. /* for fw update in bootloader */
  299. struct completion bl_completion;
  300. /* for reset handling */
  301. struct completion reset_completion;
  302. /* for config update handling */
  303. struct completion crc_completion;
  304. u32 *t19_keymap;
  305. unsigned int t19_num_keys;
  306. u32 *t15_keymap;
  307. unsigned int t15_num_keys;
  308. enum mxt_suspend_mode suspend_mode;
  309. u32 wakeup_method;
  310. };
  311. struct mxt_vb2_buffer {
  312. struct vb2_buffer vb;
  313. struct list_head list;
  314. };
  315. static size_t mxt_obj_size(const struct mxt_object *obj)
  316. {
  317. return obj->size_minus_one + 1;
  318. }
  319. static size_t mxt_obj_instances(const struct mxt_object *obj)
  320. {
  321. return obj->instances_minus_one + 1;
  322. }
  323. static bool mxt_object_readable(unsigned int type)
  324. {
  325. switch (type) {
  326. case MXT_GEN_COMMAND_T6:
  327. case MXT_GEN_POWER_T7:
  328. case MXT_GEN_ACQUIRE_T8:
  329. case MXT_GEN_DATASOURCE_T53:
  330. case MXT_TOUCH_MULTI_T9:
  331. case MXT_TOUCH_KEYARRAY_T15:
  332. case MXT_TOUCH_PROXIMITY_T23:
  333. case MXT_TOUCH_PROXKEY_T52:
  334. case MXT_TOUCH_PTC_KEYS_T97:
  335. case MXT_TOUCH_MULTITOUCHSCREEN_T100:
  336. case MXT_PROCI_GRIPFACE_T20:
  337. case MXT_PROCG_NOISE_T22:
  338. case MXT_PROCI_ONETOUCH_T24:
  339. case MXT_PROCI_TWOTOUCH_T27:
  340. case MXT_PROCI_GRIP_T40:
  341. case MXT_PROCI_PALM_T41:
  342. case MXT_PROCI_TOUCHSUPPRESSION_T42:
  343. case MXT_PROCI_STYLUS_T47:
  344. case MXT_PROCG_NOISESUPPRESSION_T48:
  345. case MXT_SPT_COMMSCONFIG_T18:
  346. case MXT_SPT_GPIOPWM_T19:
  347. case MXT_SPT_SELFTEST_T25:
  348. case MXT_SPT_CTECONFIG_T28:
  349. case MXT_SPT_USERDATA_T38:
  350. case MXT_SPT_DIGITIZER_T43:
  351. case MXT_SPT_CTECONFIG_T46:
  352. case MXT_SPT_DYNAMICCONFIGURATIONCONTAINER_T71:
  353. return true;
  354. default:
  355. return false;
  356. }
  357. }
  358. static void mxt_dump_message(struct mxt_data *data, u8 *message)
  359. {
  360. dev_dbg(&data->client->dev, "message: %*ph\n",
  361. data->T5_msg_size, message);
  362. }
  363. static int mxt_wait_for_completion(struct mxt_data *data,
  364. struct completion *comp,
  365. unsigned int timeout_ms)
  366. {
  367. struct device *dev = &data->client->dev;
  368. unsigned long timeout = msecs_to_jiffies(timeout_ms);
  369. long ret;
  370. ret = wait_for_completion_interruptible_timeout(comp, timeout);
  371. if (ret < 0) {
  372. return ret;
  373. } else if (ret == 0) {
  374. dev_err(dev, "Wait for completion timed out.\n");
  375. return -ETIMEDOUT;
  376. }
  377. return 0;
  378. }
  379. static int mxt_bootloader_read(struct mxt_data *data,
  380. u8 *val, unsigned int count)
  381. {
  382. int ret;
  383. struct i2c_msg msg;
  384. msg.addr = data->bootloader_addr;
  385. msg.flags = data->client->flags & I2C_M_TEN;
  386. msg.flags |= I2C_M_RD;
  387. msg.len = count;
  388. msg.buf = val;
  389. ret = i2c_transfer(data->client->adapter, &msg, 1);
  390. if (ret == 1) {
  391. ret = 0;
  392. } else {
  393. ret = ret < 0 ? ret : -EIO;
  394. dev_err(&data->client->dev, "%s: i2c recv failed (%d)\n",
  395. __func__, ret);
  396. }
  397. return ret;
  398. }
  399. static int mxt_bootloader_write(struct mxt_data *data,
  400. const u8 * const val, unsigned int count)
  401. {
  402. int ret;
  403. struct i2c_msg msg;
  404. msg.addr = data->bootloader_addr;
  405. msg.flags = data->client->flags & I2C_M_TEN;
  406. msg.len = count;
  407. msg.buf = (u8 *)val;
  408. ret = i2c_transfer(data->client->adapter, &msg, 1);
  409. if (ret == 1) {
  410. ret = 0;
  411. } else {
  412. ret = ret < 0 ? ret : -EIO;
  413. dev_err(&data->client->dev, "%s: i2c send failed (%d)\n",
  414. __func__, ret);
  415. }
  416. return ret;
  417. }
  418. static int mxt_lookup_bootloader_address(struct mxt_data *data, bool retry)
  419. {
  420. u8 appmode = data->client->addr;
  421. u8 bootloader;
  422. u8 family_id = data->info ? data->info->family_id : 0;
  423. switch (appmode) {
  424. case 0x4a:
  425. case 0x4b:
  426. /* Chips after 1664S use different scheme */
  427. if (retry || family_id >= 0xa2) {
  428. bootloader = appmode - 0x24;
  429. break;
  430. }
  431. fallthrough; /* for normal case */
  432. case 0x4c:
  433. case 0x4d:
  434. case 0x5a:
  435. case 0x5b:
  436. bootloader = appmode - 0x26;
  437. break;
  438. default:
  439. dev_err(&data->client->dev,
  440. "Appmode i2c address 0x%02x not found\n",
  441. appmode);
  442. return -EINVAL;
  443. }
  444. data->bootloader_addr = bootloader;
  445. return 0;
  446. }
  447. static int mxt_probe_bootloader(struct mxt_data *data, bool alt_address)
  448. {
  449. struct device *dev = &data->client->dev;
  450. int error;
  451. u8 val;
  452. bool crc_failure;
  453. error = mxt_lookup_bootloader_address(data, alt_address);
  454. if (error)
  455. return error;
  456. error = mxt_bootloader_read(data, &val, 1);
  457. if (error)
  458. return error;
  459. /* Check app crc fail mode */
  460. crc_failure = (val & ~MXT_BOOT_STATUS_MASK) == MXT_APP_CRC_FAIL;
  461. dev_err(dev, "Detected bootloader, status:%02X%s\n",
  462. val, crc_failure ? ", APP_CRC_FAIL" : "");
  463. return 0;
  464. }
  465. static u8 mxt_get_bootloader_version(struct mxt_data *data, u8 val)
  466. {
  467. struct device *dev = &data->client->dev;
  468. u8 buf[3];
  469. if (val & MXT_BOOT_EXTENDED_ID) {
  470. if (mxt_bootloader_read(data, &buf[0], 3) != 0) {
  471. dev_err(dev, "%s: i2c failure\n", __func__);
  472. return val;
  473. }
  474. dev_dbg(dev, "Bootloader ID:%d Version:%d\n", buf[1], buf[2]);
  475. return buf[0];
  476. } else {
  477. dev_dbg(dev, "Bootloader ID:%d\n", val & MXT_BOOT_ID_MASK);
  478. return val;
  479. }
  480. }
  481. static int mxt_check_bootloader(struct mxt_data *data, unsigned int state,
  482. bool wait)
  483. {
  484. struct device *dev = &data->client->dev;
  485. u8 val;
  486. int ret;
  487. recheck:
  488. if (wait) {
  489. /*
  490. * In application update mode, the interrupt
  491. * line signals state transitions. We must wait for the
  492. * CHG assertion before reading the status byte.
  493. * Once the status byte has been read, the line is deasserted.
  494. */
  495. ret = mxt_wait_for_completion(data, &data->bl_completion,
  496. MXT_FW_CHG_TIMEOUT);
  497. if (ret) {
  498. /*
  499. * TODO: handle -ERESTARTSYS better by terminating
  500. * fw update process before returning to userspace
  501. * by writing length 0x000 to device (iff we are in
  502. * WAITING_FRAME_DATA state).
  503. */
  504. dev_err(dev, "Update wait error %d\n", ret);
  505. return ret;
  506. }
  507. }
  508. ret = mxt_bootloader_read(data, &val, 1);
  509. if (ret)
  510. return ret;
  511. if (state == MXT_WAITING_BOOTLOAD_CMD)
  512. val = mxt_get_bootloader_version(data, val);
  513. switch (state) {
  514. case MXT_WAITING_BOOTLOAD_CMD:
  515. case MXT_WAITING_FRAME_DATA:
  516. case MXT_APP_CRC_FAIL:
  517. val &= ~MXT_BOOT_STATUS_MASK;
  518. break;
  519. case MXT_FRAME_CRC_PASS:
  520. if (val == MXT_FRAME_CRC_CHECK) {
  521. goto recheck;
  522. } else if (val == MXT_FRAME_CRC_FAIL) {
  523. dev_err(dev, "Bootloader CRC fail\n");
  524. return -EINVAL;
  525. }
  526. break;
  527. default:
  528. return -EINVAL;
  529. }
  530. if (val != state) {
  531. dev_err(dev, "Invalid bootloader state %02X != %02X\n",
  532. val, state);
  533. return -EINVAL;
  534. }
  535. return 0;
  536. }
  537. static int mxt_send_bootloader_cmd(struct mxt_data *data, bool unlock)
  538. {
  539. u8 buf[2];
  540. if (unlock) {
  541. buf[0] = MXT_UNLOCK_CMD_LSB;
  542. buf[1] = MXT_UNLOCK_CMD_MSB;
  543. } else {
  544. buf[0] = 0x01;
  545. buf[1] = 0x01;
  546. }
  547. return mxt_bootloader_write(data, buf, sizeof(buf));
  548. }
  549. static bool mxt_wakeup_toggle(struct i2c_client *client,
  550. bool wake_up, bool in_i2c)
  551. {
  552. struct mxt_data *data = i2c_get_clientdata(client);
  553. switch (data->wakeup_method) {
  554. case ATMEL_MXT_WAKEUP_I2C_SCL:
  555. if (!in_i2c)
  556. return false;
  557. break;
  558. case ATMEL_MXT_WAKEUP_GPIO:
  559. if (in_i2c)
  560. return false;
  561. gpiod_set_value(data->wake_gpio, wake_up);
  562. break;
  563. default:
  564. return false;
  565. }
  566. if (wake_up) {
  567. dev_dbg(&client->dev, "waking up controller\n");
  568. msleep(MXT_WAKEUP_TIME);
  569. }
  570. return true;
  571. }
  572. static int __mxt_read_reg(struct i2c_client *client,
  573. u16 reg, u16 len, void *val)
  574. {
  575. struct i2c_msg xfer[2];
  576. bool retried = false;
  577. u8 buf[2];
  578. int ret;
  579. buf[0] = reg & 0xff;
  580. buf[1] = (reg >> 8) & 0xff;
  581. /* Write register */
  582. xfer[0].addr = client->addr;
  583. xfer[0].flags = 0;
  584. xfer[0].len = 2;
  585. xfer[0].buf = buf;
  586. /* Read data */
  587. xfer[1].addr = client->addr;
  588. xfer[1].flags = I2C_M_RD;
  589. xfer[1].len = len;
  590. xfer[1].buf = val;
  591. retry:
  592. ret = i2c_transfer(client->adapter, xfer, 2);
  593. if (ret == 2) {
  594. ret = 0;
  595. } else if (!retried && mxt_wakeup_toggle(client, true, true)) {
  596. retried = true;
  597. goto retry;
  598. } else {
  599. if (ret >= 0)
  600. ret = -EIO;
  601. dev_err(&client->dev, "%s: i2c transfer failed (%d)\n",
  602. __func__, ret);
  603. }
  604. return ret;
  605. }
  606. static int __mxt_write_reg(struct i2c_client *client, u16 reg, u16 len,
  607. const void *val)
  608. {
  609. bool retried = false;
  610. u8 *buf;
  611. size_t count;
  612. int ret;
  613. count = len + 2;
  614. buf = kmalloc(count, GFP_KERNEL);
  615. if (!buf)
  616. return -ENOMEM;
  617. buf[0] = reg & 0xff;
  618. buf[1] = (reg >> 8) & 0xff;
  619. memcpy(&buf[2], val, len);
  620. retry:
  621. ret = i2c_master_send(client, buf, count);
  622. if (ret == count) {
  623. ret = 0;
  624. } else if (!retried && mxt_wakeup_toggle(client, true, true)) {
  625. retried = true;
  626. goto retry;
  627. } else {
  628. if (ret >= 0)
  629. ret = -EIO;
  630. dev_err(&client->dev, "%s: i2c send failed (%d)\n",
  631. __func__, ret);
  632. }
  633. kfree(buf);
  634. return ret;
  635. }
  636. static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
  637. {
  638. return __mxt_write_reg(client, reg, 1, &val);
  639. }
  640. static struct mxt_object *
  641. mxt_get_object(struct mxt_data *data, u8 type)
  642. {
  643. struct mxt_object *object;
  644. int i;
  645. for (i = 0; i < data->info->object_num; i++) {
  646. object = data->object_table + i;
  647. if (object->type == type)
  648. return object;
  649. }
  650. dev_warn(&data->client->dev, "Invalid object type T%u\n", type);
  651. return NULL;
  652. }
  653. static void mxt_proc_t6_messages(struct mxt_data *data, u8 *msg)
  654. {
  655. struct device *dev = &data->client->dev;
  656. u8 status = msg[1];
  657. u32 crc = msg[2] | (msg[3] << 8) | (msg[4] << 16);
  658. if (crc != data->config_crc) {
  659. data->config_crc = crc;
  660. dev_dbg(dev, "T6 Config Checksum: 0x%06X\n", crc);
  661. }
  662. complete(&data->crc_completion);
  663. /* Detect reset */
  664. if (status & MXT_T6_STATUS_RESET)
  665. complete(&data->reset_completion);
  666. /* Output debug if status has changed */
  667. if (status != data->t6_status)
  668. dev_dbg(dev, "T6 Status 0x%02X%s%s%s%s%s%s%s\n",
  669. status,
  670. status == 0 ? " OK" : "",
  671. status & MXT_T6_STATUS_RESET ? " RESET" : "",
  672. status & MXT_T6_STATUS_OFL ? " OFL" : "",
  673. status & MXT_T6_STATUS_SIGERR ? " SIGERR" : "",
  674. status & MXT_T6_STATUS_CAL ? " CAL" : "",
  675. status & MXT_T6_STATUS_CFGERR ? " CFGERR" : "",
  676. status & MXT_T6_STATUS_COMSERR ? " COMSERR" : "");
  677. /* Save current status */
  678. data->t6_status = status;
  679. }
  680. static int mxt_write_object(struct mxt_data *data,
  681. u8 type, u8 offset, u8 val)
  682. {
  683. struct mxt_object *object;
  684. u16 reg;
  685. object = mxt_get_object(data, type);
  686. if (!object || offset >= mxt_obj_size(object))
  687. return -EINVAL;
  688. reg = object->start_address;
  689. return mxt_write_reg(data->client, reg + offset, val);
  690. }
  691. static void mxt_input_button(struct mxt_data *data, u8 *message)
  692. {
  693. struct input_dev *input = data->input_dev;
  694. int i;
  695. for (i = 0; i < data->t19_num_keys; i++) {
  696. if (data->t19_keymap[i] == KEY_RESERVED)
  697. continue;
  698. /* Active-low switch */
  699. input_report_key(input, data->t19_keymap[i],
  700. !(message[1] & BIT(i)));
  701. }
  702. }
  703. static void mxt_input_sync(struct mxt_data *data)
  704. {
  705. input_mt_report_pointer_emulation(data->input_dev,
  706. data->t19_num_keys);
  707. input_sync(data->input_dev);
  708. }
  709. static void mxt_proc_t9_message(struct mxt_data *data, u8 *message)
  710. {
  711. struct device *dev = &data->client->dev;
  712. struct input_dev *input_dev = data->input_dev;
  713. int id;
  714. u8 status;
  715. int x;
  716. int y;
  717. int area;
  718. int amplitude;
  719. id = message[0] - data->T9_reportid_min;
  720. status = message[1];
  721. x = (message[2] << 4) | ((message[4] >> 4) & 0xf);
  722. y = (message[3] << 4) | ((message[4] & 0xf));
  723. /* Handle 10/12 bit switching */
  724. if (data->max_x < 1024)
  725. x >>= 2;
  726. if (data->max_y < 1024)
  727. y >>= 2;
  728. area = message[5];
  729. amplitude = message[6];
  730. dev_dbg(dev,
  731. "[%u] %c%c%c%c%c%c%c%c x: %5u y: %5u area: %3u amp: %3u\n",
  732. id,
  733. (status & MXT_T9_DETECT) ? 'D' : '.',
  734. (status & MXT_T9_PRESS) ? 'P' : '.',
  735. (status & MXT_T9_RELEASE) ? 'R' : '.',
  736. (status & MXT_T9_MOVE) ? 'M' : '.',
  737. (status & MXT_T9_VECTOR) ? 'V' : '.',
  738. (status & MXT_T9_AMP) ? 'A' : '.',
  739. (status & MXT_T9_SUPPRESS) ? 'S' : '.',
  740. (status & MXT_T9_UNGRIP) ? 'U' : '.',
  741. x, y, area, amplitude);
  742. input_mt_slot(input_dev, id);
  743. if (status & MXT_T9_DETECT) {
  744. /*
  745. * Multiple bits may be set if the host is slow to read
  746. * the status messages, indicating all the events that
  747. * have happened.
  748. */
  749. if (status & MXT_T9_RELEASE) {
  750. input_mt_report_slot_inactive(input_dev);
  751. mxt_input_sync(data);
  752. }
  753. /* if active, pressure must be non-zero */
  754. if (!amplitude)
  755. amplitude = MXT_PRESSURE_DEFAULT;
  756. /* Touch active */
  757. input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 1);
  758. input_report_abs(input_dev, ABS_MT_POSITION_X, x);
  759. input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
  760. input_report_abs(input_dev, ABS_MT_PRESSURE, amplitude);
  761. input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, area);
  762. } else {
  763. /* Touch no longer active, close out slot */
  764. input_mt_report_slot_inactive(input_dev);
  765. }
  766. data->update_input = true;
  767. }
  768. static void mxt_proc_t15_messages(struct mxt_data *data, u8 *message)
  769. {
  770. struct input_dev *input_dev = data->input_dev;
  771. unsigned long keystates = get_unaligned_le32(&message[2]);
  772. int key;
  773. for (key = 0; key < data->t15_num_keys; key++)
  774. input_report_key(input_dev, data->t15_keymap[key],
  775. keystates & BIT(key));
  776. data->update_input = true;
  777. }
  778. static void mxt_proc_t97_messages(struct mxt_data *data, u8 *message)
  779. {
  780. mxt_proc_t15_messages(data, message);
  781. }
  782. static void mxt_proc_t100_message(struct mxt_data *data, u8 *message)
  783. {
  784. struct device *dev = &data->client->dev;
  785. struct input_dev *input_dev = data->input_dev;
  786. int id;
  787. u8 status;
  788. u8 type = 0;
  789. u16 x;
  790. u16 y;
  791. int distance = 0;
  792. int tool = 0;
  793. u8 major = 0;
  794. u8 pressure = 0;
  795. u8 orientation = 0;
  796. id = message[0] - data->T100_reportid_min - 2;
  797. /* ignore SCRSTATUS events */
  798. if (id < 0)
  799. return;
  800. status = message[1];
  801. x = get_unaligned_le16(&message[2]);
  802. y = get_unaligned_le16(&message[4]);
  803. if (status & MXT_T100_DETECT) {
  804. type = (status & MXT_T100_TYPE_MASK) >> 4;
  805. switch (type) {
  806. case MXT_T100_TYPE_HOVERING_FINGER:
  807. tool = MT_TOOL_FINGER;
  808. distance = MXT_DISTANCE_HOVERING;
  809. if (data->t100_aux_vect)
  810. orientation = message[data->t100_aux_vect];
  811. break;
  812. case MXT_T100_TYPE_FINGER:
  813. case MXT_T100_TYPE_GLOVE:
  814. tool = MT_TOOL_FINGER;
  815. distance = MXT_DISTANCE_ACTIVE_TOUCH;
  816. if (data->t100_aux_area)
  817. major = message[data->t100_aux_area];
  818. if (data->t100_aux_ampl)
  819. pressure = message[data->t100_aux_ampl];
  820. if (data->t100_aux_vect)
  821. orientation = message[data->t100_aux_vect];
  822. break;
  823. case MXT_T100_TYPE_PASSIVE_STYLUS:
  824. tool = MT_TOOL_PEN;
  825. /*
  826. * Passive stylus is reported with size zero so
  827. * hardcode.
  828. */
  829. major = MXT_TOUCH_MAJOR_DEFAULT;
  830. if (data->t100_aux_ampl)
  831. pressure = message[data->t100_aux_ampl];
  832. break;
  833. case MXT_T100_TYPE_LARGE_TOUCH:
  834. /* Ignore suppressed touch */
  835. break;
  836. default:
  837. dev_dbg(dev, "Unexpected T100 type\n");
  838. return;
  839. }
  840. }
  841. /*
  842. * Values reported should be non-zero if tool is touching the
  843. * device
  844. */
  845. if (!pressure && type != MXT_T100_TYPE_HOVERING_FINGER)
  846. pressure = MXT_PRESSURE_DEFAULT;
  847. input_mt_slot(input_dev, id);
  848. if (status & MXT_T100_DETECT) {
  849. dev_dbg(dev, "[%u] type:%u x:%u y:%u a:%02X p:%02X v:%02X\n",
  850. id, type, x, y, major, pressure, orientation);
  851. input_mt_report_slot_state(input_dev, tool, 1);
  852. input_report_abs(input_dev, ABS_MT_POSITION_X, x);
  853. input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
  854. input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, major);
  855. input_report_abs(input_dev, ABS_MT_PRESSURE, pressure);
  856. input_report_abs(input_dev, ABS_MT_DISTANCE, distance);
  857. input_report_abs(input_dev, ABS_MT_ORIENTATION, orientation);
  858. } else {
  859. dev_dbg(dev, "[%u] release\n", id);
  860. /* close out slot */
  861. input_mt_report_slot_inactive(input_dev);
  862. }
  863. data->update_input = true;
  864. }
  865. static int mxt_proc_message(struct mxt_data *data, u8 *message)
  866. {
  867. u8 report_id = message[0];
  868. if (report_id == MXT_RPTID_NOMSG)
  869. return 0;
  870. if (report_id == data->T6_reportid) {
  871. mxt_proc_t6_messages(data, message);
  872. } else if (!data->input_dev) {
  873. /*
  874. * Do not report events if input device
  875. * is not yet registered.
  876. */
  877. mxt_dump_message(data, message);
  878. } else if (report_id >= data->T9_reportid_min &&
  879. report_id <= data->T9_reportid_max) {
  880. mxt_proc_t9_message(data, message);
  881. } else if (report_id >= data->T15_reportid_min &&
  882. report_id <= data->T15_reportid_max) {
  883. mxt_proc_t15_messages(data, message);
  884. } else if (report_id >= data->T97_reportid_min &&
  885. report_id <= data->T97_reportid_max) {
  886. mxt_proc_t97_messages(data, message);
  887. } else if (report_id >= data->T100_reportid_min &&
  888. report_id <= data->T100_reportid_max) {
  889. mxt_proc_t100_message(data, message);
  890. } else if (report_id == data->T19_reportid) {
  891. mxt_input_button(data, message);
  892. data->update_input = true;
  893. } else {
  894. mxt_dump_message(data, message);
  895. }
  896. return 1;
  897. }
  898. static int mxt_read_and_process_messages(struct mxt_data *data, u8 count)
  899. {
  900. struct device *dev = &data->client->dev;
  901. int ret;
  902. int i;
  903. u8 num_valid = 0;
  904. /* Safety check for msg_buf */
  905. if (count > data->max_reportid)
  906. return -EINVAL;
  907. /* Process remaining messages if necessary */
  908. ret = __mxt_read_reg(data->client, data->T5_address,
  909. data->T5_msg_size * count, data->msg_buf);
  910. if (ret) {
  911. dev_err(dev, "Failed to read %u messages (%d)\n", count, ret);
  912. return ret;
  913. }
  914. for (i = 0; i < count; i++) {
  915. ret = mxt_proc_message(data,
  916. data->msg_buf + data->T5_msg_size * i);
  917. if (ret == 1)
  918. num_valid++;
  919. }
  920. /* return number of messages read */
  921. return num_valid;
  922. }
  923. static irqreturn_t mxt_process_messages_t44(struct mxt_data *data)
  924. {
  925. struct device *dev = &data->client->dev;
  926. int ret;
  927. u8 count, num_left;
  928. /* Read T44 and T5 together */
  929. ret = __mxt_read_reg(data->client, data->T44_address,
  930. data->T5_msg_size + 1, data->msg_buf);
  931. if (ret) {
  932. dev_err(dev, "Failed to read T44 and T5 (%d)\n", ret);
  933. return IRQ_NONE;
  934. }
  935. count = data->msg_buf[0];
  936. /*
  937. * This condition may be caused by the CHG line being configured in
  938. * Mode 0. It results in unnecessary I2C operations but it is benign.
  939. */
  940. if (count == 0)
  941. return IRQ_NONE;
  942. if (count > data->max_reportid) {
  943. dev_warn(dev, "T44 count %d exceeded max report id\n", count);
  944. count = data->max_reportid;
  945. }
  946. /* Process first message */
  947. ret = mxt_proc_message(data, data->msg_buf + 1);
  948. if (ret < 0) {
  949. dev_warn(dev, "Unexpected invalid message\n");
  950. return IRQ_NONE;
  951. }
  952. num_left = count - 1;
  953. /* Process remaining messages if necessary */
  954. if (num_left) {
  955. ret = mxt_read_and_process_messages(data, num_left);
  956. if (ret < 0)
  957. goto end;
  958. else if (ret != num_left)
  959. dev_warn(dev, "Unexpected invalid message\n");
  960. }
  961. end:
  962. if (data->update_input) {
  963. mxt_input_sync(data);
  964. data->update_input = false;
  965. }
  966. return IRQ_HANDLED;
  967. }
  968. static int mxt_process_messages_until_invalid(struct mxt_data *data)
  969. {
  970. struct device *dev = &data->client->dev;
  971. int count, read;
  972. u8 tries = 2;
  973. count = data->max_reportid;
  974. /* Read messages until we force an invalid */
  975. do {
  976. read = mxt_read_and_process_messages(data, count);
  977. if (read < count)
  978. return 0;
  979. } while (--tries);
  980. if (data->update_input) {
  981. mxt_input_sync(data);
  982. data->update_input = false;
  983. }
  984. dev_err(dev, "CHG pin isn't cleared\n");
  985. return -EBUSY;
  986. }
  987. static irqreturn_t mxt_process_messages(struct mxt_data *data)
  988. {
  989. int total_handled, num_handled;
  990. u8 count = data->last_message_count;
  991. if (count < 1 || count > data->max_reportid)
  992. count = 1;
  993. /* include final invalid message */
  994. total_handled = mxt_read_and_process_messages(data, count + 1);
  995. if (total_handled < 0)
  996. return IRQ_NONE;
  997. /* if there were invalid messages, then we are done */
  998. else if (total_handled <= count)
  999. goto update_count;
  1000. /* keep reading two msgs until one is invalid or reportid limit */
  1001. do {
  1002. num_handled = mxt_read_and_process_messages(data, 2);
  1003. if (num_handled < 0)
  1004. return IRQ_NONE;
  1005. total_handled += num_handled;
  1006. if (num_handled < 2)
  1007. break;
  1008. } while (total_handled < data->num_touchids);
  1009. update_count:
  1010. data->last_message_count = total_handled;
  1011. if (data->update_input) {
  1012. mxt_input_sync(data);
  1013. data->update_input = false;
  1014. }
  1015. return IRQ_HANDLED;
  1016. }
  1017. static irqreturn_t mxt_interrupt(int irq, void *dev_id)
  1018. {
  1019. struct mxt_data *data = dev_id;
  1020. if (data->in_bootloader) {
  1021. /* bootloader state transition completion */
  1022. complete(&data->bl_completion);
  1023. return IRQ_HANDLED;
  1024. }
  1025. if (!data->object_table)
  1026. return IRQ_HANDLED;
  1027. if (data->T44_address) {
  1028. return mxt_process_messages_t44(data);
  1029. } else {
  1030. return mxt_process_messages(data);
  1031. }
  1032. }
  1033. static int mxt_t6_command(struct mxt_data *data, u16 cmd_offset,
  1034. u8 value, bool wait)
  1035. {
  1036. u16 reg;
  1037. u8 command_register;
  1038. int timeout_counter = 0;
  1039. int ret;
  1040. reg = data->T6_address + cmd_offset;
  1041. ret = mxt_write_reg(data->client, reg, value);
  1042. if (ret)
  1043. return ret;
  1044. if (!wait)
  1045. return 0;
  1046. do {
  1047. msleep(20);
  1048. ret = __mxt_read_reg(data->client, reg, 1, &command_register);
  1049. if (ret)
  1050. return ret;
  1051. } while (command_register != 0 && timeout_counter++ <= 100);
  1052. if (timeout_counter > 100) {
  1053. dev_err(&data->client->dev, "Command failed!\n");
  1054. return -EIO;
  1055. }
  1056. return 0;
  1057. }
  1058. static int mxt_acquire_irq(struct mxt_data *data)
  1059. {
  1060. int error;
  1061. enable_irq(data->irq);
  1062. if (data->use_retrigen_workaround) {
  1063. error = mxt_process_messages_until_invalid(data);
  1064. if (error)
  1065. return error;
  1066. }
  1067. return 0;
  1068. }
  1069. static int mxt_soft_reset(struct mxt_data *data)
  1070. {
  1071. struct device *dev = &data->client->dev;
  1072. int ret = 0;
  1073. dev_info(dev, "Resetting device\n");
  1074. disable_irq(data->irq);
  1075. reinit_completion(&data->reset_completion);
  1076. ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_RESET_VALUE, false);
  1077. if (ret)
  1078. return ret;
  1079. /* Ignore CHG line for 100ms after reset */
  1080. msleep(MXT_RESET_INVALID_CHG);
  1081. mxt_acquire_irq(data);
  1082. ret = mxt_wait_for_completion(data, &data->reset_completion,
  1083. MXT_RESET_TIMEOUT);
  1084. if (ret)
  1085. return ret;
  1086. return 0;
  1087. }
  1088. static void mxt_update_crc(struct mxt_data *data, u8 cmd, u8 value)
  1089. {
  1090. /*
  1091. * On failure, CRC is set to 0 and config will always be
  1092. * downloaded.
  1093. */
  1094. data->config_crc = 0;
  1095. reinit_completion(&data->crc_completion);
  1096. mxt_t6_command(data, cmd, value, true);
  1097. /*
  1098. * Wait for crc message. On failure, CRC is set to 0 and config will
  1099. * always be downloaded.
  1100. */
  1101. mxt_wait_for_completion(data, &data->crc_completion, MXT_CRC_TIMEOUT);
  1102. }
  1103. static void mxt_calc_crc24(u32 *crc, u8 firstbyte, u8 secondbyte)
  1104. {
  1105. static const unsigned int crcpoly = 0x80001B;
  1106. u32 result;
  1107. u32 data_word;
  1108. data_word = (secondbyte << 8) | firstbyte;
  1109. result = ((*crc << 1) ^ data_word);
  1110. if (result & 0x1000000)
  1111. result ^= crcpoly;
  1112. *crc = result;
  1113. }
  1114. static u32 mxt_calculate_crc(u8 *base, off_t start_off, off_t end_off)
  1115. {
  1116. u32 crc = 0;
  1117. u8 *ptr = base + start_off;
  1118. u8 *last_val = base + end_off - 1;
  1119. if (end_off < start_off)
  1120. return -EINVAL;
  1121. while (ptr < last_val) {
  1122. mxt_calc_crc24(&crc, *ptr, *(ptr + 1));
  1123. ptr += 2;
  1124. }
  1125. /* if len is odd, fill the last byte with 0 */
  1126. if (ptr == last_val)
  1127. mxt_calc_crc24(&crc, *ptr, 0);
  1128. /* Mask to 24-bit */
  1129. crc &= 0x00FFFFFF;
  1130. return crc;
  1131. }
  1132. static int mxt_check_retrigen(struct mxt_data *data)
  1133. {
  1134. struct i2c_client *client = data->client;
  1135. int error;
  1136. int val;
  1137. struct irq_data *irqd;
  1138. data->use_retrigen_workaround = false;
  1139. irqd = irq_get_irq_data(data->irq);
  1140. if (!irqd)
  1141. return -EINVAL;
  1142. if (irqd_is_level_type(irqd))
  1143. return 0;
  1144. if (data->T18_address) {
  1145. error = __mxt_read_reg(client,
  1146. data->T18_address + MXT_COMMS_CTRL,
  1147. 1, &val);
  1148. if (error)
  1149. return error;
  1150. if (val & MXT_COMMS_RETRIGEN)
  1151. return 0;
  1152. }
  1153. dev_warn(&client->dev, "Enabling RETRIGEN workaround\n");
  1154. data->use_retrigen_workaround = true;
  1155. return 0;
  1156. }
  1157. static int mxt_prepare_cfg_mem(struct mxt_data *data, struct mxt_cfg *cfg)
  1158. {
  1159. struct device *dev = &data->client->dev;
  1160. struct mxt_object *object;
  1161. unsigned int type, instance, size, byte_offset;
  1162. int offset;
  1163. int ret;
  1164. int i;
  1165. u16 reg;
  1166. u8 val;
  1167. while (cfg->raw_pos < cfg->raw_size) {
  1168. /* Read type, instance, length */
  1169. ret = sscanf(cfg->raw + cfg->raw_pos, "%x %x %x%n",
  1170. &type, &instance, &size, &offset);
  1171. if (ret == 0) {
  1172. /* EOF */
  1173. break;
  1174. } else if (ret != 3) {
  1175. dev_err(dev, "Bad format: failed to parse object\n");
  1176. return -EINVAL;
  1177. }
  1178. cfg->raw_pos += offset;
  1179. object = mxt_get_object(data, type);
  1180. if (!object) {
  1181. /* Skip object */
  1182. for (i = 0; i < size; i++) {
  1183. ret = sscanf(cfg->raw + cfg->raw_pos, "%hhx%n",
  1184. &val, &offset);
  1185. if (ret != 1) {
  1186. dev_err(dev, "Bad format in T%d at %d\n",
  1187. type, i);
  1188. return -EINVAL;
  1189. }
  1190. cfg->raw_pos += offset;
  1191. }
  1192. continue;
  1193. }
  1194. if (size > mxt_obj_size(object)) {
  1195. /*
  1196. * Either we are in fallback mode due to wrong
  1197. * config or config from a later fw version,
  1198. * or the file is corrupt or hand-edited.
  1199. */
  1200. dev_warn(dev, "Discarding %zu byte(s) in T%u\n",
  1201. size - mxt_obj_size(object), type);
  1202. } else if (mxt_obj_size(object) > size) {
  1203. /*
  1204. * If firmware is upgraded, new bytes may be added to
  1205. * end of objects. It is generally forward compatible
  1206. * to zero these bytes - previous behaviour will be
  1207. * retained. However this does invalidate the CRC and
  1208. * will force fallback mode until the configuration is
  1209. * updated. We warn here but do nothing else - the
  1210. * malloc has zeroed the entire configuration.
  1211. */
  1212. dev_warn(dev, "Zeroing %zu byte(s) in T%d\n",
  1213. mxt_obj_size(object) - size, type);
  1214. }
  1215. if (instance >= mxt_obj_instances(object)) {
  1216. dev_err(dev, "Object instances exceeded!\n");
  1217. return -EINVAL;
  1218. }
  1219. reg = object->start_address + mxt_obj_size(object) * instance;
  1220. for (i = 0; i < size; i++) {
  1221. ret = sscanf(cfg->raw + cfg->raw_pos, "%hhx%n",
  1222. &val,
  1223. &offset);
  1224. if (ret != 1) {
  1225. dev_err(dev, "Bad format in T%d at %d\n",
  1226. type, i);
  1227. return -EINVAL;
  1228. }
  1229. cfg->raw_pos += offset;
  1230. if (i > mxt_obj_size(object))
  1231. continue;
  1232. byte_offset = reg + i - cfg->start_ofs;
  1233. if (byte_offset >= 0 && byte_offset < cfg->mem_size) {
  1234. *(cfg->mem + byte_offset) = val;
  1235. } else {
  1236. dev_err(dev, "Bad object: reg:%d, T%d, ofs=%d\n",
  1237. reg, object->type, byte_offset);
  1238. return -EINVAL;
  1239. }
  1240. }
  1241. }
  1242. return 0;
  1243. }
  1244. static int mxt_upload_cfg_mem(struct mxt_data *data, struct mxt_cfg *cfg)
  1245. {
  1246. unsigned int byte_offset = 0;
  1247. int error;
  1248. /* Write configuration as blocks */
  1249. while (byte_offset < cfg->mem_size) {
  1250. unsigned int size = cfg->mem_size - byte_offset;
  1251. if (size > MXT_MAX_BLOCK_WRITE)
  1252. size = MXT_MAX_BLOCK_WRITE;
  1253. error = __mxt_write_reg(data->client,
  1254. cfg->start_ofs + byte_offset,
  1255. size, cfg->mem + byte_offset);
  1256. if (error) {
  1257. dev_err(&data->client->dev,
  1258. "Config write error, ret=%d\n", error);
  1259. return error;
  1260. }
  1261. byte_offset += size;
  1262. }
  1263. return 0;
  1264. }
  1265. static int mxt_init_t7_power_cfg(struct mxt_data *data);
  1266. /*
  1267. * mxt_update_cfg - download configuration to chip
  1268. *
  1269. * Atmel Raw Config File Format
  1270. *
  1271. * The first four lines of the raw config file contain:
  1272. * 1) Version
  1273. * 2) Chip ID Information (first 7 bytes of device memory)
  1274. * 3) Chip Information Block 24-bit CRC Checksum
  1275. * 4) Chip Configuration 24-bit CRC Checksum
  1276. *
  1277. * The rest of the file consists of one line per object instance:
  1278. * <TYPE> <INSTANCE> <SIZE> <CONTENTS>
  1279. *
  1280. * <TYPE> - 2-byte object type as hex
  1281. * <INSTANCE> - 2-byte object instance number as hex
  1282. * <SIZE> - 2-byte object size as hex
  1283. * <CONTENTS> - array of <SIZE> 1-byte hex values
  1284. */
  1285. static int mxt_update_cfg(struct mxt_data *data, const struct firmware *fw)
  1286. {
  1287. struct device *dev = &data->client->dev;
  1288. struct mxt_cfg cfg;
  1289. int ret;
  1290. int offset;
  1291. int i;
  1292. u32 info_crc, config_crc, calculated_crc;
  1293. u16 crc_start = 0;
  1294. /* Make zero terminated copy of the OBP_RAW file */
  1295. cfg.raw = kmemdup_nul(fw->data, fw->size, GFP_KERNEL);
  1296. if (!cfg.raw)
  1297. return -ENOMEM;
  1298. cfg.raw_size = fw->size;
  1299. mxt_update_crc(data, MXT_COMMAND_REPORTALL, 1);
  1300. if (strncmp(cfg.raw, MXT_CFG_MAGIC, strlen(MXT_CFG_MAGIC))) {
  1301. dev_err(dev, "Unrecognised config file\n");
  1302. ret = -EINVAL;
  1303. goto release_raw;
  1304. }
  1305. cfg.raw_pos = strlen(MXT_CFG_MAGIC);
  1306. /* Load information block and check */
  1307. for (i = 0; i < sizeof(struct mxt_info); i++) {
  1308. ret = sscanf(cfg.raw + cfg.raw_pos, "%hhx%n",
  1309. (unsigned char *)&cfg.info + i,
  1310. &offset);
  1311. if (ret != 1) {
  1312. dev_err(dev, "Bad format\n");
  1313. ret = -EINVAL;
  1314. goto release_raw;
  1315. }
  1316. cfg.raw_pos += offset;
  1317. }
  1318. if (cfg.info.family_id != data->info->family_id) {
  1319. dev_err(dev, "Family ID mismatch!\n");
  1320. ret = -EINVAL;
  1321. goto release_raw;
  1322. }
  1323. if (cfg.info.variant_id != data->info->variant_id) {
  1324. dev_err(dev, "Variant ID mismatch!\n");
  1325. ret = -EINVAL;
  1326. goto release_raw;
  1327. }
  1328. /* Read CRCs */
  1329. ret = sscanf(cfg.raw + cfg.raw_pos, "%x%n", &info_crc, &offset);
  1330. if (ret != 1) {
  1331. dev_err(dev, "Bad format: failed to parse Info CRC\n");
  1332. ret = -EINVAL;
  1333. goto release_raw;
  1334. }
  1335. cfg.raw_pos += offset;
  1336. ret = sscanf(cfg.raw + cfg.raw_pos, "%x%n", &config_crc, &offset);
  1337. if (ret != 1) {
  1338. dev_err(dev, "Bad format: failed to parse Config CRC\n");
  1339. ret = -EINVAL;
  1340. goto release_raw;
  1341. }
  1342. cfg.raw_pos += offset;
  1343. /*
  1344. * The Info Block CRC is calculated over mxt_info and the object
  1345. * table. If it does not match then we are trying to load the
  1346. * configuration from a different chip or firmware version, so
  1347. * the configuration CRC is invalid anyway.
  1348. */
  1349. if (info_crc == data->info_crc) {
  1350. if (config_crc == 0 || data->config_crc == 0) {
  1351. dev_info(dev, "CRC zero, attempting to apply config\n");
  1352. } else if (config_crc == data->config_crc) {
  1353. dev_dbg(dev, "Config CRC 0x%06X: OK\n",
  1354. data->config_crc);
  1355. ret = 0;
  1356. goto release_raw;
  1357. } else {
  1358. dev_info(dev, "Config CRC 0x%06X: does not match file 0x%06X\n",
  1359. data->config_crc, config_crc);
  1360. }
  1361. } else {
  1362. dev_warn(dev,
  1363. "Warning: Info CRC error - device=0x%06X file=0x%06X\n",
  1364. data->info_crc, info_crc);
  1365. }
  1366. /* Malloc memory to store configuration */
  1367. cfg.start_ofs = MXT_OBJECT_START +
  1368. data->info->object_num * sizeof(struct mxt_object) +
  1369. MXT_INFO_CHECKSUM_SIZE;
  1370. cfg.mem_size = data->mem_size - cfg.start_ofs;
  1371. cfg.mem = kzalloc(cfg.mem_size, GFP_KERNEL);
  1372. if (!cfg.mem) {
  1373. ret = -ENOMEM;
  1374. goto release_raw;
  1375. }
  1376. ret = mxt_prepare_cfg_mem(data, &cfg);
  1377. if (ret)
  1378. goto release_mem;
  1379. /* Calculate crc of the received configs (not the raw config file) */
  1380. if (data->T71_address)
  1381. crc_start = data->T71_address;
  1382. else if (data->T7_address)
  1383. crc_start = data->T7_address;
  1384. else
  1385. dev_warn(dev, "Could not find CRC start\n");
  1386. if (crc_start > cfg.start_ofs) {
  1387. calculated_crc = mxt_calculate_crc(cfg.mem,
  1388. crc_start - cfg.start_ofs,
  1389. cfg.mem_size);
  1390. if (config_crc > 0 && config_crc != calculated_crc)
  1391. dev_warn(dev, "Config CRC in file inconsistent, calculated=%06X, file=%06X\n",
  1392. calculated_crc, config_crc);
  1393. }
  1394. ret = mxt_upload_cfg_mem(data, &cfg);
  1395. if (ret)
  1396. goto release_mem;
  1397. mxt_update_crc(data, MXT_COMMAND_BACKUPNV, MXT_BACKUP_VALUE);
  1398. ret = mxt_check_retrigen(data);
  1399. if (ret)
  1400. goto release_mem;
  1401. ret = mxt_soft_reset(data);
  1402. if (ret)
  1403. goto release_mem;
  1404. dev_info(dev, "Config successfully updated\n");
  1405. /* T7 config may have changed */
  1406. mxt_init_t7_power_cfg(data);
  1407. release_mem:
  1408. kfree(cfg.mem);
  1409. release_raw:
  1410. kfree(cfg.raw);
  1411. return ret;
  1412. }
  1413. static void mxt_free_input_device(struct mxt_data *data)
  1414. {
  1415. if (data->input_dev) {
  1416. input_unregister_device(data->input_dev);
  1417. data->input_dev = NULL;
  1418. }
  1419. }
  1420. static void mxt_free_object_table(struct mxt_data *data)
  1421. {
  1422. #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
  1423. video_unregister_device(&data->dbg.vdev);
  1424. v4l2_device_unregister(&data->dbg.v4l2);
  1425. #endif
  1426. data->object_table = NULL;
  1427. data->info = NULL;
  1428. kfree(data->raw_info_block);
  1429. data->raw_info_block = NULL;
  1430. kfree(data->msg_buf);
  1431. data->msg_buf = NULL;
  1432. data->T5_address = 0;
  1433. data->T5_msg_size = 0;
  1434. data->T6_reportid = 0;
  1435. data->T7_address = 0;
  1436. data->T71_address = 0;
  1437. data->T9_reportid_min = 0;
  1438. data->T9_reportid_max = 0;
  1439. data->T15_reportid_min = 0;
  1440. data->T15_reportid_max = 0;
  1441. data->T18_address = 0;
  1442. data->T19_reportid = 0;
  1443. data->T44_address = 0;
  1444. data->T97_reportid_min = 0;
  1445. data->T97_reportid_max = 0;
  1446. data->T100_reportid_min = 0;
  1447. data->T100_reportid_max = 0;
  1448. data->max_reportid = 0;
  1449. }
  1450. static int mxt_parse_object_table(struct mxt_data *data,
  1451. struct mxt_object *object_table)
  1452. {
  1453. struct i2c_client *client = data->client;
  1454. int i;
  1455. u8 reportid;
  1456. u16 end_address;
  1457. /* Valid Report IDs start counting from 1 */
  1458. reportid = 1;
  1459. data->mem_size = 0;
  1460. for (i = 0; i < data->info->object_num; i++) {
  1461. struct mxt_object *object = object_table + i;
  1462. u8 min_id, max_id;
  1463. le16_to_cpus(&object->start_address);
  1464. if (object->num_report_ids) {
  1465. min_id = reportid;
  1466. reportid += object->num_report_ids *
  1467. mxt_obj_instances(object);
  1468. max_id = reportid - 1;
  1469. } else {
  1470. min_id = 0;
  1471. max_id = 0;
  1472. }
  1473. dev_dbg(&data->client->dev,
  1474. "T%u Start:%u Size:%zu Instances:%zu Report IDs:%u-%u\n",
  1475. object->type, object->start_address,
  1476. mxt_obj_size(object), mxt_obj_instances(object),
  1477. min_id, max_id);
  1478. switch (object->type) {
  1479. case MXT_GEN_MESSAGE_T5:
  1480. if (data->info->family_id == 0x80 &&
  1481. data->info->version < 0x20) {
  1482. /*
  1483. * On mXT224 firmware versions prior to V2.0
  1484. * read and discard unused CRC byte otherwise
  1485. * DMA reads are misaligned.
  1486. */
  1487. data->T5_msg_size = mxt_obj_size(object);
  1488. } else {
  1489. /* CRC not enabled, so skip last byte */
  1490. data->T5_msg_size = mxt_obj_size(object) - 1;
  1491. }
  1492. data->T5_address = object->start_address;
  1493. break;
  1494. case MXT_GEN_COMMAND_T6:
  1495. data->T6_reportid = min_id;
  1496. data->T6_address = object->start_address;
  1497. break;
  1498. case MXT_GEN_POWER_T7:
  1499. data->T7_address = object->start_address;
  1500. break;
  1501. case MXT_SPT_DYNAMICCONFIGURATIONCONTAINER_T71:
  1502. data->T71_address = object->start_address;
  1503. break;
  1504. case MXT_TOUCH_MULTI_T9:
  1505. data->multitouch = MXT_TOUCH_MULTI_T9;
  1506. /* Only handle messages from first T9 instance */
  1507. data->T9_reportid_min = min_id;
  1508. data->T9_reportid_max = min_id +
  1509. object->num_report_ids - 1;
  1510. data->num_touchids = object->num_report_ids;
  1511. break;
  1512. case MXT_TOUCH_KEYARRAY_T15:
  1513. data->T15_reportid_min = min_id;
  1514. data->T15_reportid_max = max_id;
  1515. break;
  1516. case MXT_SPT_COMMSCONFIG_T18:
  1517. data->T18_address = object->start_address;
  1518. break;
  1519. case MXT_SPT_MESSAGECOUNT_T44:
  1520. data->T44_address = object->start_address;
  1521. break;
  1522. case MXT_SPT_GPIOPWM_T19:
  1523. data->T19_reportid = min_id;
  1524. break;
  1525. case MXT_TOUCH_PTC_KEYS_T97:
  1526. data->T97_reportid_min = min_id;
  1527. data->T97_reportid_max = max_id;
  1528. break;
  1529. case MXT_TOUCH_MULTITOUCHSCREEN_T100:
  1530. data->multitouch = MXT_TOUCH_MULTITOUCHSCREEN_T100;
  1531. data->T100_reportid_min = min_id;
  1532. data->T100_reportid_max = max_id;
  1533. /* first two report IDs reserved */
  1534. data->num_touchids = object->num_report_ids - 2;
  1535. break;
  1536. }
  1537. end_address = object->start_address
  1538. + mxt_obj_size(object) * mxt_obj_instances(object) - 1;
  1539. if (end_address >= data->mem_size)
  1540. data->mem_size = end_address + 1;
  1541. }
  1542. /* Store maximum reportid */
  1543. data->max_reportid = reportid;
  1544. /* If T44 exists, T5 position has to be directly after */
  1545. if (data->T44_address && (data->T5_address != data->T44_address + 1)) {
  1546. dev_err(&client->dev, "Invalid T44 position\n");
  1547. return -EINVAL;
  1548. }
  1549. data->msg_buf = kcalloc(data->max_reportid,
  1550. data->T5_msg_size, GFP_KERNEL);
  1551. if (!data->msg_buf)
  1552. return -ENOMEM;
  1553. return 0;
  1554. }
  1555. static int mxt_read_info_block(struct mxt_data *data)
  1556. {
  1557. struct i2c_client *client = data->client;
  1558. int error;
  1559. size_t size;
  1560. void *id_buf, *buf;
  1561. uint8_t num_objects;
  1562. u32 calculated_crc;
  1563. u8 *crc_ptr;
  1564. /* If info block already allocated, free it */
  1565. if (data->raw_info_block)
  1566. mxt_free_object_table(data);
  1567. /* Read 7-byte ID information block starting at address 0 */
  1568. size = sizeof(struct mxt_info);
  1569. id_buf = kzalloc(size, GFP_KERNEL);
  1570. if (!id_buf)
  1571. return -ENOMEM;
  1572. error = __mxt_read_reg(client, 0, size, id_buf);
  1573. if (error)
  1574. goto err_free_mem;
  1575. /* Resize buffer to give space for rest of info block */
  1576. num_objects = ((struct mxt_info *)id_buf)->object_num;
  1577. size += (num_objects * sizeof(struct mxt_object))
  1578. + MXT_INFO_CHECKSUM_SIZE;
  1579. buf = krealloc(id_buf, size, GFP_KERNEL);
  1580. if (!buf) {
  1581. error = -ENOMEM;
  1582. goto err_free_mem;
  1583. }
  1584. id_buf = buf;
  1585. /* Read rest of info block */
  1586. error = __mxt_read_reg(client, MXT_OBJECT_START,
  1587. size - MXT_OBJECT_START,
  1588. id_buf + MXT_OBJECT_START);
  1589. if (error)
  1590. goto err_free_mem;
  1591. /* Extract & calculate checksum */
  1592. crc_ptr = id_buf + size - MXT_INFO_CHECKSUM_SIZE;
  1593. data->info_crc = crc_ptr[0] | (crc_ptr[1] << 8) | (crc_ptr[2] << 16);
  1594. calculated_crc = mxt_calculate_crc(id_buf, 0,
  1595. size - MXT_INFO_CHECKSUM_SIZE);
  1596. /*
  1597. * CRC mismatch can be caused by data corruption due to I2C comms
  1598. * issue or else device is not using Object Based Protocol (eg i2c-hid)
  1599. */
  1600. if ((data->info_crc == 0) || (data->info_crc != calculated_crc)) {
  1601. dev_err(&client->dev,
  1602. "Info Block CRC error calculated=0x%06X read=0x%06X\n",
  1603. calculated_crc, data->info_crc);
  1604. error = -EIO;
  1605. goto err_free_mem;
  1606. }
  1607. data->raw_info_block = id_buf;
  1608. data->info = (struct mxt_info *)id_buf;
  1609. dev_info(&client->dev,
  1610. "Family: %u Variant: %u Firmware V%u.%u.%02X Objects: %u\n",
  1611. data->info->family_id, data->info->variant_id,
  1612. data->info->version >> 4, data->info->version & 0xf,
  1613. data->info->build, data->info->object_num);
  1614. /* Parse object table information */
  1615. error = mxt_parse_object_table(data, id_buf + MXT_OBJECT_START);
  1616. if (error) {
  1617. dev_err(&client->dev, "Error %d parsing object table\n", error);
  1618. mxt_free_object_table(data);
  1619. return error;
  1620. }
  1621. data->object_table = (struct mxt_object *)(id_buf + MXT_OBJECT_START);
  1622. return 0;
  1623. err_free_mem:
  1624. kfree(id_buf);
  1625. return error;
  1626. }
  1627. static int mxt_read_t9_resolution(struct mxt_data *data)
  1628. {
  1629. struct i2c_client *client = data->client;
  1630. int error;
  1631. struct t9_range range;
  1632. unsigned char orient;
  1633. struct mxt_object *object;
  1634. object = mxt_get_object(data, MXT_TOUCH_MULTI_T9);
  1635. if (!object)
  1636. return -EINVAL;
  1637. error = __mxt_read_reg(client,
  1638. object->start_address + MXT_T9_XSIZE,
  1639. sizeof(data->xsize), &data->xsize);
  1640. if (error)
  1641. return error;
  1642. error = __mxt_read_reg(client,
  1643. object->start_address + MXT_T9_YSIZE,
  1644. sizeof(data->ysize), &data->ysize);
  1645. if (error)
  1646. return error;
  1647. error = __mxt_read_reg(client,
  1648. object->start_address + MXT_T9_RANGE,
  1649. sizeof(range), &range);
  1650. if (error)
  1651. return error;
  1652. data->max_x = get_unaligned_le16(&range.x);
  1653. data->max_y = get_unaligned_le16(&range.y);
  1654. error = __mxt_read_reg(client,
  1655. object->start_address + MXT_T9_ORIENT,
  1656. 1, &orient);
  1657. if (error)
  1658. return error;
  1659. data->xy_switch = orient & MXT_T9_ORIENT_SWITCH;
  1660. data->invertx = orient & MXT_T9_ORIENT_INVERTX;
  1661. data->inverty = orient & MXT_T9_ORIENT_INVERTY;
  1662. return 0;
  1663. }
  1664. static int mxt_read_t100_config(struct mxt_data *data)
  1665. {
  1666. struct i2c_client *client = data->client;
  1667. int error;
  1668. struct mxt_object *object;
  1669. u16 range_x, range_y;
  1670. u8 cfg, tchaux;
  1671. u8 aux;
  1672. object = mxt_get_object(data, MXT_TOUCH_MULTITOUCHSCREEN_T100);
  1673. if (!object)
  1674. return -EINVAL;
  1675. /* read touchscreen dimensions */
  1676. error = __mxt_read_reg(client,
  1677. object->start_address + MXT_T100_XRANGE,
  1678. sizeof(range_x), &range_x);
  1679. if (error)
  1680. return error;
  1681. data->max_x = get_unaligned_le16(&range_x);
  1682. error = __mxt_read_reg(client,
  1683. object->start_address + MXT_T100_YRANGE,
  1684. sizeof(range_y), &range_y);
  1685. if (error)
  1686. return error;
  1687. data->max_y = get_unaligned_le16(&range_y);
  1688. error = __mxt_read_reg(client,
  1689. object->start_address + MXT_T100_XSIZE,
  1690. sizeof(data->xsize), &data->xsize);
  1691. if (error)
  1692. return error;
  1693. error = __mxt_read_reg(client,
  1694. object->start_address + MXT_T100_YSIZE,
  1695. sizeof(data->ysize), &data->ysize);
  1696. if (error)
  1697. return error;
  1698. /* read orientation config */
  1699. error = __mxt_read_reg(client,
  1700. object->start_address + MXT_T100_CFG1,
  1701. 1, &cfg);
  1702. if (error)
  1703. return error;
  1704. data->xy_switch = cfg & MXT_T100_CFG_SWITCHXY;
  1705. data->invertx = cfg & MXT_T100_CFG_INVERTX;
  1706. data->inverty = cfg & MXT_T100_CFG_INVERTY;
  1707. /* allocate aux bytes */
  1708. error = __mxt_read_reg(client,
  1709. object->start_address + MXT_T100_TCHAUX,
  1710. 1, &tchaux);
  1711. if (error)
  1712. return error;
  1713. aux = 6;
  1714. if (tchaux & MXT_T100_TCHAUX_VECT)
  1715. data->t100_aux_vect = aux++;
  1716. if (tchaux & MXT_T100_TCHAUX_AMPL)
  1717. data->t100_aux_ampl = aux++;
  1718. if (tchaux & MXT_T100_TCHAUX_AREA)
  1719. data->t100_aux_area = aux++;
  1720. dev_dbg(&client->dev,
  1721. "T100 aux mappings vect:%u ampl:%u area:%u\n",
  1722. data->t100_aux_vect, data->t100_aux_ampl, data->t100_aux_area);
  1723. return 0;
  1724. }
  1725. static int mxt_input_open(struct input_dev *dev);
  1726. static void mxt_input_close(struct input_dev *dev);
  1727. static void mxt_set_up_as_touchpad(struct input_dev *input_dev,
  1728. struct mxt_data *data)
  1729. {
  1730. int i;
  1731. input_dev->name = "Atmel maXTouch Touchpad";
  1732. __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
  1733. input_abs_set_res(input_dev, ABS_X, MXT_PIXELS_PER_MM);
  1734. input_abs_set_res(input_dev, ABS_Y, MXT_PIXELS_PER_MM);
  1735. input_abs_set_res(input_dev, ABS_MT_POSITION_X,
  1736. MXT_PIXELS_PER_MM);
  1737. input_abs_set_res(input_dev, ABS_MT_POSITION_Y,
  1738. MXT_PIXELS_PER_MM);
  1739. for (i = 0; i < data->t19_num_keys; i++)
  1740. if (data->t19_keymap[i] != KEY_RESERVED)
  1741. input_set_capability(input_dev, EV_KEY,
  1742. data->t19_keymap[i]);
  1743. }
  1744. static int mxt_initialize_input_device(struct mxt_data *data)
  1745. {
  1746. struct device *dev = &data->client->dev;
  1747. struct input_dev *input_dev;
  1748. int error;
  1749. unsigned int num_mt_slots;
  1750. unsigned int mt_flags = 0;
  1751. int i;
  1752. switch (data->multitouch) {
  1753. case MXT_TOUCH_MULTI_T9:
  1754. num_mt_slots = data->T9_reportid_max - data->T9_reportid_min + 1;
  1755. error = mxt_read_t9_resolution(data);
  1756. if (error)
  1757. dev_warn(dev, "Failed to initialize T9 resolution\n");
  1758. break;
  1759. case MXT_TOUCH_MULTITOUCHSCREEN_T100:
  1760. num_mt_slots = data->num_touchids;
  1761. error = mxt_read_t100_config(data);
  1762. if (error)
  1763. dev_warn(dev, "Failed to read T100 config\n");
  1764. break;
  1765. default:
  1766. dev_err(dev, "Invalid multitouch object\n");
  1767. return -EINVAL;
  1768. }
  1769. /* Handle default values and orientation switch */
  1770. if (data->max_x == 0)
  1771. data->max_x = 1023;
  1772. if (data->max_y == 0)
  1773. data->max_y = 1023;
  1774. if (data->xy_switch)
  1775. swap(data->max_x, data->max_y);
  1776. dev_info(dev, "Touchscreen size X%uY%u\n", data->max_x, data->max_y);
  1777. /* Register input device */
  1778. input_dev = input_allocate_device();
  1779. if (!input_dev)
  1780. return -ENOMEM;
  1781. input_dev->name = "Atmel maXTouch Touchscreen";
  1782. input_dev->phys = data->phys;
  1783. input_dev->id.bustype = BUS_I2C;
  1784. input_dev->dev.parent = dev;
  1785. input_dev->open = mxt_input_open;
  1786. input_dev->close = mxt_input_close;
  1787. input_dev->keycode = data->t15_keymap;
  1788. input_dev->keycodemax = data->t15_num_keys;
  1789. input_dev->keycodesize = sizeof(data->t15_keymap[0]);
  1790. input_set_capability(input_dev, EV_KEY, BTN_TOUCH);
  1791. /* For single touch */
  1792. input_set_abs_params(input_dev, ABS_X, 0, data->max_x, 0, 0);
  1793. input_set_abs_params(input_dev, ABS_Y, 0, data->max_y, 0, 0);
  1794. if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
  1795. (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
  1796. data->t100_aux_ampl)) {
  1797. input_set_abs_params(input_dev, ABS_PRESSURE, 0, 255, 0, 0);
  1798. }
  1799. /* If device has buttons we assume it is a touchpad */
  1800. if (data->t19_num_keys) {
  1801. mxt_set_up_as_touchpad(input_dev, data);
  1802. mt_flags |= INPUT_MT_POINTER;
  1803. } else {
  1804. mt_flags |= INPUT_MT_DIRECT;
  1805. }
  1806. /* For multi touch */
  1807. error = input_mt_init_slots(input_dev, num_mt_slots, mt_flags);
  1808. if (error) {
  1809. dev_err(dev, "Error %d initialising slots\n", error);
  1810. goto err_free_mem;
  1811. }
  1812. if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100) {
  1813. input_set_abs_params(input_dev, ABS_MT_TOOL_TYPE,
  1814. 0, MT_TOOL_MAX, 0, 0);
  1815. input_set_abs_params(input_dev, ABS_MT_DISTANCE,
  1816. MXT_DISTANCE_ACTIVE_TOUCH,
  1817. MXT_DISTANCE_HOVERING,
  1818. 0, 0);
  1819. }
  1820. input_set_abs_params(input_dev, ABS_MT_POSITION_X,
  1821. 0, data->max_x, 0, 0);
  1822. input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
  1823. 0, data->max_y, 0, 0);
  1824. if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
  1825. (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
  1826. data->t100_aux_area)) {
  1827. input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
  1828. 0, MXT_MAX_AREA, 0, 0);
  1829. }
  1830. if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
  1831. (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
  1832. data->t100_aux_ampl)) {
  1833. input_set_abs_params(input_dev, ABS_MT_PRESSURE,
  1834. 0, 255, 0, 0);
  1835. }
  1836. if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
  1837. data->t100_aux_vect) {
  1838. input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
  1839. 0, 255, 0, 0);
  1840. }
  1841. if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
  1842. data->t100_aux_vect) {
  1843. input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
  1844. 0, 255, 0, 0);
  1845. }
  1846. /* For T15 and T97 Key Array */
  1847. if (data->T15_reportid_min || data->T97_reportid_min) {
  1848. for (i = 0; i < data->t15_num_keys; i++)
  1849. input_set_capability(input_dev,
  1850. EV_KEY, data->t15_keymap[i]);
  1851. }
  1852. input_set_drvdata(input_dev, data);
  1853. error = input_register_device(input_dev);
  1854. if (error) {
  1855. dev_err(dev, "Error %d registering input device\n", error);
  1856. goto err_free_mem;
  1857. }
  1858. data->input_dev = input_dev;
  1859. return 0;
  1860. err_free_mem:
  1861. input_free_device(input_dev);
  1862. return error;
  1863. }
  1864. static int mxt_configure_objects(struct mxt_data *data,
  1865. const struct firmware *cfg);
  1866. static void mxt_config_cb(const struct firmware *cfg, void *ctx)
  1867. {
  1868. mxt_configure_objects(ctx, cfg);
  1869. release_firmware(cfg);
  1870. }
  1871. static int mxt_initialize(struct mxt_data *data)
  1872. {
  1873. struct i2c_client *client = data->client;
  1874. int recovery_attempts = 0;
  1875. int error;
  1876. while (1) {
  1877. error = mxt_read_info_block(data);
  1878. if (!error)
  1879. break;
  1880. /* Check bootloader state */
  1881. error = mxt_probe_bootloader(data, false);
  1882. if (error) {
  1883. dev_info(&client->dev, "Trying alternate bootloader address\n");
  1884. error = mxt_probe_bootloader(data, true);
  1885. if (error) {
  1886. /* Chip is not in appmode or bootloader mode */
  1887. return error;
  1888. }
  1889. }
  1890. /* OK, we are in bootloader, see if we can recover */
  1891. if (++recovery_attempts > 1) {
  1892. dev_err(&client->dev, "Could not recover from bootloader mode\n");
  1893. /*
  1894. * We can reflash from this state, so do not
  1895. * abort initialization.
  1896. */
  1897. data->in_bootloader = true;
  1898. return 0;
  1899. }
  1900. /* Attempt to exit bootloader into app mode */
  1901. mxt_send_bootloader_cmd(data, false);
  1902. msleep(MXT_FW_RESET_TIME);
  1903. }
  1904. error = mxt_check_retrigen(data);
  1905. if (error)
  1906. return error;
  1907. error = mxt_acquire_irq(data);
  1908. if (error)
  1909. return error;
  1910. error = request_firmware_nowait(THIS_MODULE, true, MXT_CFG_NAME,
  1911. &client->dev, GFP_KERNEL, data,
  1912. mxt_config_cb);
  1913. if (error) {
  1914. dev_err(&client->dev, "Failed to invoke firmware loader: %d\n",
  1915. error);
  1916. return error;
  1917. }
  1918. return 0;
  1919. }
  1920. static int mxt_set_t7_power_cfg(struct mxt_data *data, u8 sleep)
  1921. {
  1922. struct device *dev = &data->client->dev;
  1923. int error;
  1924. struct t7_config *new_config;
  1925. struct t7_config deepsleep = { .active = 0, .idle = 0 };
  1926. if (sleep == MXT_POWER_CFG_DEEPSLEEP)
  1927. new_config = &deepsleep;
  1928. else
  1929. new_config = &data->t7_cfg;
  1930. error = __mxt_write_reg(data->client, data->T7_address,
  1931. sizeof(data->t7_cfg), new_config);
  1932. if (error)
  1933. return error;
  1934. dev_dbg(dev, "Set T7 ACTV:%d IDLE:%d\n",
  1935. new_config->active, new_config->idle);
  1936. return 0;
  1937. }
  1938. static int mxt_init_t7_power_cfg(struct mxt_data *data)
  1939. {
  1940. struct device *dev = &data->client->dev;
  1941. int error;
  1942. bool retry = false;
  1943. recheck:
  1944. error = __mxt_read_reg(data->client, data->T7_address,
  1945. sizeof(data->t7_cfg), &data->t7_cfg);
  1946. if (error)
  1947. return error;
  1948. if (data->t7_cfg.active == 0 || data->t7_cfg.idle == 0) {
  1949. if (!retry) {
  1950. dev_dbg(dev, "T7 cfg zero, resetting\n");
  1951. mxt_soft_reset(data);
  1952. retry = true;
  1953. goto recheck;
  1954. } else {
  1955. dev_dbg(dev, "T7 cfg zero after reset, overriding\n");
  1956. data->t7_cfg.active = 20;
  1957. data->t7_cfg.idle = 100;
  1958. return mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);
  1959. }
  1960. }
  1961. dev_dbg(dev, "Initialized power cfg: ACTV %d, IDLE %d\n",
  1962. data->t7_cfg.active, data->t7_cfg.idle);
  1963. return 0;
  1964. }
  1965. #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37
  1966. static const struct v4l2_file_operations mxt_video_fops = {
  1967. .owner = THIS_MODULE,
  1968. .open = v4l2_fh_open,
  1969. .release = vb2_fop_release,
  1970. .unlocked_ioctl = video_ioctl2,
  1971. .read = vb2_fop_read,
  1972. .mmap = vb2_fop_mmap,
  1973. .poll = vb2_fop_poll,
  1974. };
  1975. static u16 mxt_get_debug_value(struct mxt_data *data, unsigned int x,
  1976. unsigned int y)
  1977. {
  1978. struct mxt_info *info = data->info;
  1979. struct mxt_dbg *dbg = &data->dbg;
  1980. unsigned int ofs, page;
  1981. unsigned int col = 0;
  1982. unsigned int col_width;
  1983. if (info->family_id == MXT_FAMILY_1386) {
  1984. col_width = info->matrix_ysize / MXT1386_COLUMNS;
  1985. col = y / col_width;
  1986. y = y % col_width;
  1987. } else {
  1988. col_width = info->matrix_ysize;
  1989. }
  1990. ofs = (y + (x * col_width)) * sizeof(u16);
  1991. page = ofs / MXT_DIAGNOSTIC_SIZE;
  1992. ofs %= MXT_DIAGNOSTIC_SIZE;
  1993. if (info->family_id == MXT_FAMILY_1386)
  1994. page += col * MXT1386_PAGES_PER_COLUMN;
  1995. return get_unaligned_le16(&dbg->t37_buf[page].data[ofs]);
  1996. }
  1997. static int mxt_convert_debug_pages(struct mxt_data *data, u16 *outbuf)
  1998. {
  1999. struct mxt_dbg *dbg = &data->dbg;
  2000. unsigned int x = 0;
  2001. unsigned int y = 0;
  2002. unsigned int i, rx, ry;
  2003. for (i = 0; i < dbg->t37_nodes; i++) {
  2004. /* Handle orientation */
  2005. rx = data->xy_switch ? y : x;
  2006. ry = data->xy_switch ? x : y;
  2007. rx = data->invertx ? (data->xsize - 1 - rx) : rx;
  2008. ry = data->inverty ? (data->ysize - 1 - ry) : ry;
  2009. outbuf[i] = mxt_get_debug_value(data, rx, ry);
  2010. /* Next value */
  2011. if (++x >= (data->xy_switch ? data->ysize : data->xsize)) {
  2012. x = 0;
  2013. y++;
  2014. }
  2015. }
  2016. return 0;
  2017. }
  2018. static int mxt_read_diagnostic_debug(struct mxt_data *data, u8 mode,
  2019. u16 *outbuf)
  2020. {
  2021. struct mxt_dbg *dbg = &data->dbg;
  2022. int retries = 0;
  2023. int page;
  2024. int ret;
  2025. u8 cmd = mode;
  2026. struct t37_debug *p;
  2027. u8 cmd_poll;
  2028. for (page = 0; page < dbg->t37_pages; page++) {
  2029. p = dbg->t37_buf + page;
  2030. ret = mxt_write_reg(data->client, dbg->diag_cmd_address,
  2031. cmd);
  2032. if (ret)
  2033. return ret;
  2034. retries = 0;
  2035. msleep(20);
  2036. wait_cmd:
  2037. /* Read back command byte */
  2038. ret = __mxt_read_reg(data->client, dbg->diag_cmd_address,
  2039. sizeof(cmd_poll), &cmd_poll);
  2040. if (ret)
  2041. return ret;
  2042. /* Field is cleared once the command has been processed */
  2043. if (cmd_poll) {
  2044. if (retries++ > 100)
  2045. return -EINVAL;
  2046. msleep(20);
  2047. goto wait_cmd;
  2048. }
  2049. /* Read T37 page */
  2050. ret = __mxt_read_reg(data->client, dbg->t37_address,
  2051. sizeof(struct t37_debug), p);
  2052. if (ret)
  2053. return ret;
  2054. if (p->mode != mode || p->page != page) {
  2055. dev_err(&data->client->dev, "T37 page mismatch\n");
  2056. return -EINVAL;
  2057. }
  2058. dev_dbg(&data->client->dev, "%s page:%d retries:%d\n",
  2059. __func__, page, retries);
  2060. /* For remaining pages, write PAGEUP rather than mode */
  2061. cmd = MXT_DIAGNOSTIC_PAGEUP;
  2062. }
  2063. return mxt_convert_debug_pages(data, outbuf);
  2064. }
  2065. static int mxt_queue_setup(struct vb2_queue *q,
  2066. unsigned int *nbuffers, unsigned int *nplanes,
  2067. unsigned int sizes[], struct device *alloc_devs[])
  2068. {
  2069. struct mxt_data *data = q->drv_priv;
  2070. size_t size = data->dbg.t37_nodes * sizeof(u16);
  2071. if (*nplanes)
  2072. return sizes[0] < size ? -EINVAL : 0;
  2073. *nplanes = 1;
  2074. sizes[0] = size;
  2075. return 0;
  2076. }
  2077. static void mxt_buffer_queue(struct vb2_buffer *vb)
  2078. {
  2079. struct mxt_data *data = vb2_get_drv_priv(vb->vb2_queue);
  2080. u16 *ptr;
  2081. int ret;
  2082. u8 mode;
  2083. ptr = vb2_plane_vaddr(vb, 0);
  2084. if (!ptr) {
  2085. dev_err(&data->client->dev, "Error acquiring frame ptr\n");
  2086. goto fault;
  2087. }
  2088. switch (data->dbg.input) {
  2089. case MXT_V4L_INPUT_DELTAS:
  2090. default:
  2091. mode = MXT_DIAGNOSTIC_DELTAS;
  2092. break;
  2093. case MXT_V4L_INPUT_REFS:
  2094. mode = MXT_DIAGNOSTIC_REFS;
  2095. break;
  2096. }
  2097. ret = mxt_read_diagnostic_debug(data, mode, ptr);
  2098. if (ret)
  2099. goto fault;
  2100. vb2_set_plane_payload(vb, 0, data->dbg.t37_nodes * sizeof(u16));
  2101. vb2_buffer_done(vb, VB2_BUF_STATE_DONE);
  2102. return;
  2103. fault:
  2104. vb2_buffer_done(vb, VB2_BUF_STATE_ERROR);
  2105. }
  2106. /* V4L2 structures */
  2107. static const struct vb2_ops mxt_queue_ops = {
  2108. .queue_setup = mxt_queue_setup,
  2109. .buf_queue = mxt_buffer_queue,
  2110. .wait_prepare = vb2_ops_wait_prepare,
  2111. .wait_finish = vb2_ops_wait_finish,
  2112. };
  2113. static const struct vb2_queue mxt_queue = {
  2114. .type = V4L2_BUF_TYPE_VIDEO_CAPTURE,
  2115. .io_modes = VB2_MMAP | VB2_USERPTR | VB2_DMABUF | VB2_READ,
  2116. .buf_struct_size = sizeof(struct mxt_vb2_buffer),
  2117. .ops = &mxt_queue_ops,
  2118. .mem_ops = &vb2_vmalloc_memops,
  2119. .timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC,
  2120. .min_queued_buffers = 1,
  2121. };
  2122. static int mxt_vidioc_querycap(struct file *file, void *priv,
  2123. struct v4l2_capability *cap)
  2124. {
  2125. struct mxt_data *data = video_drvdata(file);
  2126. strscpy(cap->driver, "atmel_mxt_ts", sizeof(cap->driver));
  2127. strscpy(cap->card, "atmel_mxt_ts touch", sizeof(cap->card));
  2128. snprintf(cap->bus_info, sizeof(cap->bus_info),
  2129. "I2C:%s", dev_name(&data->client->dev));
  2130. return 0;
  2131. }
  2132. static int mxt_vidioc_enum_input(struct file *file, void *priv,
  2133. struct v4l2_input *i)
  2134. {
  2135. if (i->index >= MXT_V4L_INPUT_MAX)
  2136. return -EINVAL;
  2137. i->type = V4L2_INPUT_TYPE_TOUCH;
  2138. switch (i->index) {
  2139. case MXT_V4L_INPUT_REFS:
  2140. strscpy(i->name, "Mutual Capacitance References",
  2141. sizeof(i->name));
  2142. break;
  2143. case MXT_V4L_INPUT_DELTAS:
  2144. strscpy(i->name, "Mutual Capacitance Deltas", sizeof(i->name));
  2145. break;
  2146. }
  2147. return 0;
  2148. }
  2149. static int mxt_set_input(struct mxt_data *data, unsigned int i)
  2150. {
  2151. struct v4l2_pix_format *f = &data->dbg.format;
  2152. if (i >= MXT_V4L_INPUT_MAX)
  2153. return -EINVAL;
  2154. if (i == MXT_V4L_INPUT_DELTAS)
  2155. f->pixelformat = V4L2_TCH_FMT_DELTA_TD16;
  2156. else
  2157. f->pixelformat = V4L2_TCH_FMT_TU16;
  2158. f->width = data->xy_switch ? data->ysize : data->xsize;
  2159. f->height = data->xy_switch ? data->xsize : data->ysize;
  2160. f->field = V4L2_FIELD_NONE;
  2161. f->colorspace = V4L2_COLORSPACE_RAW;
  2162. f->bytesperline = f->width * sizeof(u16);
  2163. f->sizeimage = f->width * f->height * sizeof(u16);
  2164. data->dbg.input = i;
  2165. return 0;
  2166. }
  2167. static int mxt_vidioc_s_input(struct file *file, void *priv, unsigned int i)
  2168. {
  2169. return mxt_set_input(video_drvdata(file), i);
  2170. }
  2171. static int mxt_vidioc_g_input(struct file *file, void *priv, unsigned int *i)
  2172. {
  2173. struct mxt_data *data = video_drvdata(file);
  2174. *i = data->dbg.input;
  2175. return 0;
  2176. }
  2177. static int mxt_vidioc_fmt(struct file *file, void *priv, struct v4l2_format *f)
  2178. {
  2179. struct mxt_data *data = video_drvdata(file);
  2180. f->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
  2181. f->fmt.pix = data->dbg.format;
  2182. return 0;
  2183. }
  2184. static int mxt_vidioc_enum_fmt(struct file *file, void *priv,
  2185. struct v4l2_fmtdesc *fmt)
  2186. {
  2187. if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
  2188. return -EINVAL;
  2189. switch (fmt->index) {
  2190. case 0:
  2191. fmt->pixelformat = V4L2_TCH_FMT_TU16;
  2192. break;
  2193. case 1:
  2194. fmt->pixelformat = V4L2_TCH_FMT_DELTA_TD16;
  2195. break;
  2196. default:
  2197. return -EINVAL;
  2198. }
  2199. return 0;
  2200. }
  2201. static int mxt_vidioc_g_parm(struct file *file, void *fh,
  2202. struct v4l2_streamparm *a)
  2203. {
  2204. if (a->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
  2205. return -EINVAL;
  2206. a->parm.capture.readbuffers = 1;
  2207. a->parm.capture.timeperframe.numerator = 1;
  2208. a->parm.capture.timeperframe.denominator = 10;
  2209. return 0;
  2210. }
  2211. static const struct v4l2_ioctl_ops mxt_video_ioctl_ops = {
  2212. .vidioc_querycap = mxt_vidioc_querycap,
  2213. .vidioc_enum_fmt_vid_cap = mxt_vidioc_enum_fmt,
  2214. .vidioc_s_fmt_vid_cap = mxt_vidioc_fmt,
  2215. .vidioc_g_fmt_vid_cap = mxt_vidioc_fmt,
  2216. .vidioc_try_fmt_vid_cap = mxt_vidioc_fmt,
  2217. .vidioc_g_parm = mxt_vidioc_g_parm,
  2218. .vidioc_enum_input = mxt_vidioc_enum_input,
  2219. .vidioc_g_input = mxt_vidioc_g_input,
  2220. .vidioc_s_input = mxt_vidioc_s_input,
  2221. .vidioc_reqbufs = vb2_ioctl_reqbufs,
  2222. .vidioc_create_bufs = vb2_ioctl_create_bufs,
  2223. .vidioc_querybuf = vb2_ioctl_querybuf,
  2224. .vidioc_qbuf = vb2_ioctl_qbuf,
  2225. .vidioc_dqbuf = vb2_ioctl_dqbuf,
  2226. .vidioc_expbuf = vb2_ioctl_expbuf,
  2227. .vidioc_streamon = vb2_ioctl_streamon,
  2228. .vidioc_streamoff = vb2_ioctl_streamoff,
  2229. };
  2230. static const struct video_device mxt_video_device = {
  2231. .name = "Atmel maxTouch",
  2232. .fops = &mxt_video_fops,
  2233. .ioctl_ops = &mxt_video_ioctl_ops,
  2234. .release = video_device_release_empty,
  2235. .device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_TOUCH |
  2236. V4L2_CAP_READWRITE | V4L2_CAP_STREAMING,
  2237. };
  2238. static void mxt_debug_init(struct mxt_data *data)
  2239. {
  2240. struct mxt_info *info = data->info;
  2241. struct mxt_dbg *dbg = &data->dbg;
  2242. struct mxt_object *object;
  2243. int error;
  2244. object = mxt_get_object(data, MXT_GEN_COMMAND_T6);
  2245. if (!object)
  2246. goto error;
  2247. dbg->diag_cmd_address = object->start_address + MXT_COMMAND_DIAGNOSTIC;
  2248. object = mxt_get_object(data, MXT_DEBUG_DIAGNOSTIC_T37);
  2249. if (!object)
  2250. goto error;
  2251. if (mxt_obj_size(object) != sizeof(struct t37_debug)) {
  2252. dev_warn(&data->client->dev, "Bad T37 size");
  2253. goto error;
  2254. }
  2255. dbg->t37_address = object->start_address;
  2256. /* Calculate size of data and allocate buffer */
  2257. dbg->t37_nodes = data->xsize * data->ysize;
  2258. if (info->family_id == MXT_FAMILY_1386)
  2259. dbg->t37_pages = MXT1386_COLUMNS * MXT1386_PAGES_PER_COLUMN;
  2260. else
  2261. dbg->t37_pages = DIV_ROUND_UP(data->xsize *
  2262. info->matrix_ysize *
  2263. sizeof(u16),
  2264. sizeof(dbg->t37_buf->data));
  2265. dbg->t37_buf = devm_kmalloc_array(&data->client->dev, dbg->t37_pages,
  2266. sizeof(struct t37_debug), GFP_KERNEL);
  2267. if (!dbg->t37_buf)
  2268. goto error;
  2269. /* init channel to zero */
  2270. mxt_set_input(data, 0);
  2271. /* register video device */
  2272. snprintf(dbg->v4l2.name, sizeof(dbg->v4l2.name), "%s", "atmel_mxt_ts");
  2273. error = v4l2_device_register(&data->client->dev, &dbg->v4l2);
  2274. if (error)
  2275. goto error;
  2276. /* initialize the queue */
  2277. mutex_init(&dbg->lock);
  2278. dbg->queue = mxt_queue;
  2279. dbg->queue.drv_priv = data;
  2280. dbg->queue.lock = &dbg->lock;
  2281. dbg->queue.dev = &data->client->dev;
  2282. error = vb2_queue_init(&dbg->queue);
  2283. if (error)
  2284. goto error_unreg_v4l2;
  2285. dbg->vdev = mxt_video_device;
  2286. dbg->vdev.v4l2_dev = &dbg->v4l2;
  2287. dbg->vdev.lock = &dbg->lock;
  2288. dbg->vdev.vfl_dir = VFL_DIR_RX;
  2289. dbg->vdev.queue = &dbg->queue;
  2290. video_set_drvdata(&dbg->vdev, data);
  2291. error = video_register_device(&dbg->vdev, VFL_TYPE_TOUCH, -1);
  2292. if (error)
  2293. goto error_unreg_v4l2;
  2294. return;
  2295. error_unreg_v4l2:
  2296. v4l2_device_unregister(&dbg->v4l2);
  2297. error:
  2298. dev_warn(&data->client->dev, "Error initializing T37\n");
  2299. }
  2300. #else
  2301. static void mxt_debug_init(struct mxt_data *data)
  2302. {
  2303. }
  2304. #endif
  2305. static int mxt_configure_objects(struct mxt_data *data,
  2306. const struct firmware *cfg)
  2307. {
  2308. struct device *dev = &data->client->dev;
  2309. int error;
  2310. error = mxt_init_t7_power_cfg(data);
  2311. if (error) {
  2312. dev_err(dev, "Failed to initialize power cfg\n");
  2313. return error;
  2314. }
  2315. if (cfg) {
  2316. error = mxt_update_cfg(data, cfg);
  2317. if (error)
  2318. dev_warn(dev, "Error %d updating config\n", error);
  2319. }
  2320. if (data->multitouch) {
  2321. error = mxt_initialize_input_device(data);
  2322. if (error)
  2323. return error;
  2324. } else {
  2325. dev_warn(dev, "No touch object detected\n");
  2326. }
  2327. mxt_debug_init(data);
  2328. return 0;
  2329. }
  2330. /* Firmware Version is returned as Major.Minor.Build */
  2331. static ssize_t mxt_fw_version_show(struct device *dev,
  2332. struct device_attribute *attr, char *buf)
  2333. {
  2334. struct mxt_data *data = dev_get_drvdata(dev);
  2335. struct mxt_info *info = data->info;
  2336. return sysfs_emit(buf, "%u.%u.%02X\n",
  2337. info->version >> 4, info->version & 0xf, info->build);
  2338. }
  2339. /* Hardware Version is returned as FamilyID.VariantID */
  2340. static ssize_t mxt_hw_version_show(struct device *dev,
  2341. struct device_attribute *attr, char *buf)
  2342. {
  2343. struct mxt_data *data = dev_get_drvdata(dev);
  2344. struct mxt_info *info = data->info;
  2345. return sysfs_emit(buf, "%u.%u\n", info->family_id, info->variant_id);
  2346. }
  2347. static ssize_t mxt_show_instance(char *buf, int count,
  2348. struct mxt_object *object, int instance,
  2349. const u8 *val)
  2350. {
  2351. int i;
  2352. if (mxt_obj_instances(object) > 1)
  2353. count += sysfs_emit_at(buf, count, "Instance %u\n", instance);
  2354. for (i = 0; i < mxt_obj_size(object); i++)
  2355. count += sysfs_emit_at(buf, count, "\t[%2u]: %02x (%d)\n",
  2356. i, val[i], val[i]);
  2357. count += sysfs_emit_at(buf, count, "\n");
  2358. return count;
  2359. }
  2360. static ssize_t mxt_object_show(struct device *dev,
  2361. struct device_attribute *attr, char *buf)
  2362. {
  2363. struct mxt_data *data = dev_get_drvdata(dev);
  2364. struct mxt_object *object;
  2365. int count = 0;
  2366. int i, j;
  2367. int error;
  2368. u8 *obuf;
  2369. /* Pre-allocate buffer large enough to hold max sized object. */
  2370. obuf = kmalloc(256, GFP_KERNEL);
  2371. if (!obuf)
  2372. return -ENOMEM;
  2373. error = 0;
  2374. for (i = 0; i < data->info->object_num; i++) {
  2375. object = data->object_table + i;
  2376. if (!mxt_object_readable(object->type))
  2377. continue;
  2378. count += sysfs_emit_at(buf, count, "T%u:\n", object->type);
  2379. for (j = 0; j < mxt_obj_instances(object); j++) {
  2380. u16 size = mxt_obj_size(object);
  2381. u16 addr = object->start_address + j * size;
  2382. error = __mxt_read_reg(data->client, addr, size, obuf);
  2383. if (error)
  2384. goto done;
  2385. count = mxt_show_instance(buf, count, object, j, obuf);
  2386. }
  2387. }
  2388. done:
  2389. kfree(obuf);
  2390. return error ?: count;
  2391. }
  2392. static int mxt_check_firmware_format(struct device *dev,
  2393. const struct firmware *fw)
  2394. {
  2395. unsigned int pos = 0;
  2396. char c;
  2397. while (pos < fw->size) {
  2398. c = *(fw->data + pos);
  2399. if (c < '0' || (c > '9' && c < 'A') || c > 'F')
  2400. return 0;
  2401. pos++;
  2402. }
  2403. /*
  2404. * To convert file try:
  2405. * xxd -r -p mXTXXX__APP_VX-X-XX.enc > maxtouch.fw
  2406. */
  2407. dev_err(dev, "Aborting: firmware file must be in binary format\n");
  2408. return -EINVAL;
  2409. }
  2410. static int mxt_load_fw(struct device *dev, const char *fn)
  2411. {
  2412. struct mxt_data *data = dev_get_drvdata(dev);
  2413. const struct firmware *fw = NULL;
  2414. unsigned int frame_size;
  2415. unsigned int pos = 0;
  2416. unsigned int retry = 0;
  2417. unsigned int frame = 0;
  2418. int ret;
  2419. ret = request_firmware(&fw, fn, dev);
  2420. if (ret) {
  2421. dev_err(dev, "Unable to open firmware %s\n", fn);
  2422. return ret;
  2423. }
  2424. /* Check for incorrect enc file */
  2425. ret = mxt_check_firmware_format(dev, fw);
  2426. if (ret)
  2427. goto release_firmware;
  2428. if (!data->in_bootloader) {
  2429. /* Change to the bootloader mode */
  2430. data->in_bootloader = true;
  2431. ret = mxt_t6_command(data, MXT_COMMAND_RESET,
  2432. MXT_BOOT_VALUE, false);
  2433. if (ret)
  2434. goto release_firmware;
  2435. msleep(MXT_RESET_TIME);
  2436. /* Do not need to scan since we know family ID */
  2437. ret = mxt_lookup_bootloader_address(data, 0);
  2438. if (ret)
  2439. goto release_firmware;
  2440. mxt_free_input_device(data);
  2441. mxt_free_object_table(data);
  2442. } else {
  2443. enable_irq(data->irq);
  2444. }
  2445. reinit_completion(&data->bl_completion);
  2446. ret = mxt_check_bootloader(data, MXT_WAITING_BOOTLOAD_CMD, false);
  2447. if (ret) {
  2448. /* Bootloader may still be unlocked from previous attempt */
  2449. ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, false);
  2450. if (ret)
  2451. goto disable_irq;
  2452. } else {
  2453. dev_info(dev, "Unlocking bootloader\n");
  2454. /* Unlock bootloader */
  2455. ret = mxt_send_bootloader_cmd(data, true);
  2456. if (ret)
  2457. goto disable_irq;
  2458. }
  2459. while (pos < fw->size) {
  2460. ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, true);
  2461. if (ret)
  2462. goto disable_irq;
  2463. frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1));
  2464. /* Take account of CRC bytes */
  2465. frame_size += 2;
  2466. /* Write one frame to device */
  2467. ret = mxt_bootloader_write(data, fw->data + pos, frame_size);
  2468. if (ret)
  2469. goto disable_irq;
  2470. ret = mxt_check_bootloader(data, MXT_FRAME_CRC_PASS, true);
  2471. if (ret) {
  2472. retry++;
  2473. /* Back off by 20ms per retry */
  2474. msleep(retry * 20);
  2475. if (retry > 20) {
  2476. dev_err(dev, "Retry count exceeded\n");
  2477. goto disable_irq;
  2478. }
  2479. } else {
  2480. retry = 0;
  2481. pos += frame_size;
  2482. frame++;
  2483. }
  2484. if (frame % 50 == 0)
  2485. dev_dbg(dev, "Sent %d frames, %d/%zd bytes\n",
  2486. frame, pos, fw->size);
  2487. }
  2488. /* Wait for flash. */
  2489. ret = mxt_wait_for_completion(data, &data->bl_completion,
  2490. MXT_FW_RESET_TIME);
  2491. if (ret)
  2492. goto disable_irq;
  2493. dev_dbg(dev, "Sent %d frames, %d bytes\n", frame, pos);
  2494. /*
  2495. * Wait for device to reset. Some bootloader versions do not assert
  2496. * the CHG line after bootloading has finished, so ignore potential
  2497. * errors.
  2498. */
  2499. mxt_wait_for_completion(data, &data->bl_completion, MXT_FW_RESET_TIME);
  2500. data->in_bootloader = false;
  2501. disable_irq:
  2502. disable_irq(data->irq);
  2503. release_firmware:
  2504. release_firmware(fw);
  2505. return ret;
  2506. }
  2507. static ssize_t mxt_update_fw_store(struct device *dev,
  2508. struct device_attribute *attr,
  2509. const char *buf, size_t count)
  2510. {
  2511. struct mxt_data *data = dev_get_drvdata(dev);
  2512. int error;
  2513. error = mxt_load_fw(dev, MXT_FW_NAME);
  2514. if (error) {
  2515. dev_err(dev, "The firmware update failed(%d)\n", error);
  2516. count = error;
  2517. } else {
  2518. dev_info(dev, "The firmware update succeeded\n");
  2519. error = mxt_initialize(data);
  2520. if (error)
  2521. return error;
  2522. }
  2523. return count;
  2524. }
  2525. static DEVICE_ATTR(fw_version, S_IRUGO, mxt_fw_version_show, NULL);
  2526. static DEVICE_ATTR(hw_version, S_IRUGO, mxt_hw_version_show, NULL);
  2527. static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
  2528. static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store);
  2529. static struct attribute *mxt_attrs[] = {
  2530. &dev_attr_fw_version.attr,
  2531. &dev_attr_hw_version.attr,
  2532. &dev_attr_object.attr,
  2533. &dev_attr_update_fw.attr,
  2534. NULL
  2535. };
  2536. ATTRIBUTE_GROUPS(mxt);
  2537. static void mxt_start(struct mxt_data *data)
  2538. {
  2539. mxt_wakeup_toggle(data->client, true, false);
  2540. switch (data->suspend_mode) {
  2541. case MXT_SUSPEND_T9_CTRL:
  2542. mxt_soft_reset(data);
  2543. /* Touch enable */
  2544. /* 0x83 = SCANEN | RPTEN | ENABLE */
  2545. mxt_write_object(data,
  2546. MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0x83);
  2547. break;
  2548. case MXT_SUSPEND_DEEP_SLEEP:
  2549. default:
  2550. mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);
  2551. /* Recalibrate since chip has been in deep sleep */
  2552. mxt_t6_command(data, MXT_COMMAND_CALIBRATE, 1, false);
  2553. break;
  2554. }
  2555. }
  2556. static void mxt_stop(struct mxt_data *data)
  2557. {
  2558. switch (data->suspend_mode) {
  2559. case MXT_SUSPEND_T9_CTRL:
  2560. /* Touch disable */
  2561. mxt_write_object(data,
  2562. MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0);
  2563. break;
  2564. case MXT_SUSPEND_DEEP_SLEEP:
  2565. default:
  2566. mxt_set_t7_power_cfg(data, MXT_POWER_CFG_DEEPSLEEP);
  2567. break;
  2568. }
  2569. mxt_wakeup_toggle(data->client, false, false);
  2570. }
  2571. static int mxt_input_open(struct input_dev *dev)
  2572. {
  2573. struct mxt_data *data = input_get_drvdata(dev);
  2574. mxt_start(data);
  2575. return 0;
  2576. }
  2577. static void mxt_input_close(struct input_dev *dev)
  2578. {
  2579. struct mxt_data *data = input_get_drvdata(dev);
  2580. mxt_stop(data);
  2581. }
  2582. static int mxt_parse_device_properties(struct mxt_data *data)
  2583. {
  2584. static const char keymap_property[] = "linux,gpio-keymap";
  2585. static const char buttons_property[] = "linux,keycodes";
  2586. struct device *dev = &data->client->dev;
  2587. u32 *keymap;
  2588. u32 *buttonmap;
  2589. int n_keys;
  2590. int error;
  2591. if (device_property_present(dev, keymap_property)) {
  2592. n_keys = device_property_count_u32(dev, keymap_property);
  2593. if (n_keys <= 0) {
  2594. error = n_keys < 0 ? n_keys : -EINVAL;
  2595. dev_err(dev, "invalid/malformed '%s' property: %d\n",
  2596. keymap_property, error);
  2597. return error;
  2598. }
  2599. keymap = devm_kmalloc_array(dev, n_keys, sizeof(*keymap),
  2600. GFP_KERNEL);
  2601. if (!keymap)
  2602. return -ENOMEM;
  2603. error = device_property_read_u32_array(dev, keymap_property,
  2604. keymap, n_keys);
  2605. if (error) {
  2606. dev_err(dev, "failed to parse '%s' property: %d\n",
  2607. keymap_property, error);
  2608. return error;
  2609. }
  2610. data->t19_keymap = keymap;
  2611. data->t19_num_keys = n_keys;
  2612. }
  2613. if (device_property_present(dev, buttons_property)) {
  2614. n_keys = device_property_count_u32(dev, buttons_property);
  2615. if (n_keys <= 0) {
  2616. error = n_keys < 0 ? n_keys : -EINVAL;
  2617. dev_err(dev, "invalid/malformed '%s' property: %d\n",
  2618. buttons_property, error);
  2619. return error;
  2620. }
  2621. buttonmap = devm_kmalloc_array(dev, n_keys, sizeof(*buttonmap),
  2622. GFP_KERNEL);
  2623. if (!buttonmap)
  2624. return -ENOMEM;
  2625. error = device_property_read_u32_array(dev, buttons_property,
  2626. buttonmap, n_keys);
  2627. if (error) {
  2628. dev_err(dev, "failed to parse '%s' property: %d\n",
  2629. buttons_property, error);
  2630. return error;
  2631. }
  2632. data->t15_keymap = buttonmap;
  2633. data->t15_num_keys = n_keys;
  2634. }
  2635. return 0;
  2636. }
  2637. static const struct dmi_system_id chromebook_T9_suspend_dmi[] = {
  2638. {
  2639. .matches = {
  2640. DMI_MATCH(DMI_SYS_VENDOR, "GOOGLE"),
  2641. DMI_MATCH(DMI_PRODUCT_NAME, "Link"),
  2642. },
  2643. },
  2644. {
  2645. .matches = {
  2646. DMI_MATCH(DMI_PRODUCT_NAME, "Peppy"),
  2647. },
  2648. },
  2649. { }
  2650. };
  2651. static int mxt_probe(struct i2c_client *client)
  2652. {
  2653. struct mxt_data *data;
  2654. int error;
  2655. /*
  2656. * Ignore devices that do not have device properties attached to
  2657. * them, as we need help determining whether we are dealing with
  2658. * touch screen or touchpad.
  2659. *
  2660. * So far on x86 the only users of Atmel touch controllers are
  2661. * Chromebooks, and chromeos_laptop driver will ensure that
  2662. * necessary properties are provided (if firmware does not do that).
  2663. */
  2664. if (!device_property_present(&client->dev, "compatible"))
  2665. return -ENXIO;
  2666. /*
  2667. * Ignore ACPI devices representing bootloader mode.
  2668. *
  2669. * This is a bit of a hack: Google Chromebook BIOS creates ACPI
  2670. * devices for both application and bootloader modes, but we are
  2671. * interested in application mode only (if device is in bootloader
  2672. * mode we'll end up switching into application anyway). So far
  2673. * application mode addresses were all above 0x40, so we'll use it
  2674. * as a threshold.
  2675. */
  2676. if (ACPI_COMPANION(&client->dev) && client->addr < 0x40)
  2677. return -ENXIO;
  2678. data = devm_kzalloc(&client->dev, sizeof(struct mxt_data), GFP_KERNEL);
  2679. if (!data)
  2680. return -ENOMEM;
  2681. snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0",
  2682. client->adapter->nr, client->addr);
  2683. data->client = client;
  2684. data->irq = client->irq;
  2685. i2c_set_clientdata(client, data);
  2686. init_completion(&data->bl_completion);
  2687. init_completion(&data->reset_completion);
  2688. init_completion(&data->crc_completion);
  2689. data->suspend_mode = dmi_check_system(chromebook_T9_suspend_dmi) ?
  2690. MXT_SUSPEND_T9_CTRL : MXT_SUSPEND_DEEP_SLEEP;
  2691. error = mxt_parse_device_properties(data);
  2692. if (error)
  2693. return error;
  2694. /*
  2695. * VDDA is the analog voltage supply 2.57..3.47 V
  2696. * VDD is the digital voltage supply 1.71..3.47 V
  2697. */
  2698. data->regulators[0].supply = "vdda";
  2699. data->regulators[1].supply = "vdd";
  2700. error = devm_regulator_bulk_get(&client->dev, ARRAY_SIZE(data->regulators),
  2701. data->regulators);
  2702. if (error) {
  2703. if (error != -EPROBE_DEFER)
  2704. dev_err(&client->dev, "Failed to get regulators %d\n",
  2705. error);
  2706. return error;
  2707. }
  2708. /* Request the RESET line as asserted so we go into reset */
  2709. data->reset_gpio = devm_gpiod_get_optional(&client->dev,
  2710. "reset", GPIOD_OUT_HIGH);
  2711. if (IS_ERR(data->reset_gpio)) {
  2712. error = PTR_ERR(data->reset_gpio);
  2713. dev_err(&client->dev, "Failed to get reset gpio: %d\n", error);
  2714. return error;
  2715. }
  2716. /* Request the WAKE line as asserted so we go out of sleep */
  2717. data->wake_gpio = devm_gpiod_get_optional(&client->dev,
  2718. "wake", GPIOD_OUT_HIGH);
  2719. if (IS_ERR(data->wake_gpio)) {
  2720. error = PTR_ERR(data->wake_gpio);
  2721. dev_err(&client->dev, "Failed to get wake gpio: %d\n", error);
  2722. return error;
  2723. }
  2724. error = devm_request_threaded_irq(&client->dev, client->irq,
  2725. NULL, mxt_interrupt,
  2726. IRQF_ONESHOT | IRQF_NO_AUTOEN,
  2727. client->name, data);
  2728. if (error) {
  2729. dev_err(&client->dev, "Failed to register interrupt\n");
  2730. return error;
  2731. }
  2732. error = regulator_bulk_enable(ARRAY_SIZE(data->regulators),
  2733. data->regulators);
  2734. if (error) {
  2735. dev_err(&client->dev, "failed to enable regulators: %d\n",
  2736. error);
  2737. return error;
  2738. }
  2739. /*
  2740. * The device takes 40ms to come up after power-on according
  2741. * to the mXT224 datasheet, page 13.
  2742. */
  2743. msleep(MXT_BACKUP_TIME);
  2744. if (data->reset_gpio) {
  2745. /* Wait a while and then de-assert the RESET GPIO line */
  2746. msleep(MXT_RESET_GPIO_TIME);
  2747. gpiod_set_value_cansleep(data->reset_gpio, 0);
  2748. msleep(MXT_RESET_INVALID_CHG);
  2749. }
  2750. /*
  2751. * Controllers like mXT1386 have a dedicated WAKE line that could be
  2752. * connected to a GPIO or to I2C SCL pin, or permanently asserted low.
  2753. *
  2754. * This WAKE line is used for waking controller from a deep-sleep and
  2755. * it needs to be asserted low for 25 milliseconds before I2C transfers
  2756. * could be accepted by controller if it was in a deep-sleep mode.
  2757. * Controller will go into sleep automatically after 2 seconds of
  2758. * inactivity if WAKE line is deasserted and deep sleep is activated.
  2759. *
  2760. * If WAKE line is connected to I2C SCL pin, then the first I2C transfer
  2761. * will get an instant NAK and transfer needs to be retried after 25ms.
  2762. *
  2763. * If WAKE line is connected to a GPIO line, the line must be asserted
  2764. * 25ms before the host attempts to communicate with the controller.
  2765. */
  2766. device_property_read_u32(&client->dev, "atmel,wakeup-method",
  2767. &data->wakeup_method);
  2768. error = mxt_initialize(data);
  2769. if (error)
  2770. goto err_disable_regulators;
  2771. return 0;
  2772. err_disable_regulators:
  2773. regulator_bulk_disable(ARRAY_SIZE(data->regulators),
  2774. data->regulators);
  2775. return error;
  2776. }
  2777. static void mxt_remove(struct i2c_client *client)
  2778. {
  2779. struct mxt_data *data = i2c_get_clientdata(client);
  2780. disable_irq(data->irq);
  2781. mxt_free_input_device(data);
  2782. mxt_free_object_table(data);
  2783. regulator_bulk_disable(ARRAY_SIZE(data->regulators),
  2784. data->regulators);
  2785. }
  2786. static int mxt_suspend(struct device *dev)
  2787. {
  2788. struct i2c_client *client = to_i2c_client(dev);
  2789. struct mxt_data *data = i2c_get_clientdata(client);
  2790. struct input_dev *input_dev = data->input_dev;
  2791. if (!input_dev)
  2792. return 0;
  2793. mutex_lock(&input_dev->mutex);
  2794. if (input_device_enabled(input_dev))
  2795. mxt_stop(data);
  2796. mutex_unlock(&input_dev->mutex);
  2797. disable_irq(data->irq);
  2798. return 0;
  2799. }
  2800. static int mxt_resume(struct device *dev)
  2801. {
  2802. struct i2c_client *client = to_i2c_client(dev);
  2803. struct mxt_data *data = i2c_get_clientdata(client);
  2804. struct input_dev *input_dev = data->input_dev;
  2805. if (!input_dev)
  2806. return 0;
  2807. enable_irq(data->irq);
  2808. mutex_lock(&input_dev->mutex);
  2809. if (input_device_enabled(input_dev))
  2810. mxt_start(data);
  2811. mutex_unlock(&input_dev->mutex);
  2812. return 0;
  2813. }
  2814. static DEFINE_SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume);
  2815. static const struct of_device_id mxt_of_match[] = {
  2816. { .compatible = "atmel,maxtouch", },
  2817. /* Compatibles listed below are deprecated */
  2818. { .compatible = "atmel,qt602240_ts", },
  2819. { .compatible = "atmel,atmel_mxt_ts", },
  2820. { .compatible = "atmel,atmel_mxt_tp", },
  2821. { .compatible = "atmel,mXT224", },
  2822. {},
  2823. };
  2824. MODULE_DEVICE_TABLE(of, mxt_of_match);
  2825. #ifdef CONFIG_ACPI
  2826. static const struct acpi_device_id mxt_acpi_id[] = {
  2827. { "ATML0000", 0 }, /* Touchpad */
  2828. { "ATML0001", 0 }, /* Touchscreen */
  2829. { }
  2830. };
  2831. MODULE_DEVICE_TABLE(acpi, mxt_acpi_id);
  2832. #endif
  2833. static const struct i2c_device_id mxt_id[] = {
  2834. { "qt602240_ts" },
  2835. { "atmel_mxt_ts" },
  2836. { "atmel_mxt_tp" },
  2837. { "maxtouch" },
  2838. { "mXT224" },
  2839. { }
  2840. };
  2841. MODULE_DEVICE_TABLE(i2c, mxt_id);
  2842. static struct i2c_driver mxt_driver = {
  2843. .driver = {
  2844. .name = "atmel_mxt_ts",
  2845. .dev_groups = mxt_groups,
  2846. .of_match_table = mxt_of_match,
  2847. .acpi_match_table = ACPI_PTR(mxt_acpi_id),
  2848. .pm = pm_sleep_ptr(&mxt_pm_ops),
  2849. },
  2850. .probe = mxt_probe,
  2851. .remove = mxt_remove,
  2852. .id_table = mxt_id,
  2853. };
  2854. module_i2c_driver(mxt_driver);
  2855. /* Module information */
  2856. MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
  2857. MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
  2858. MODULE_LICENSE("GPL");