applespi.c 55 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971
  1. // SPDX-License-Identifier: GPL-2.0
  2. /*
  3. * MacBook (Pro) SPI keyboard and touchpad driver
  4. *
  5. * Copyright (c) 2015-2018 Federico Lorenzi
  6. * Copyright (c) 2017-2018 Ronald Tschalär
  7. */
  8. /*
  9. * The keyboard and touchpad controller on the MacBookAir6, MacBookPro12,
  10. * MacBook8 and newer can be driven either by USB or SPI. However the USB
  11. * pins are only connected on the MacBookAir6 and 7 and the MacBookPro12.
  12. * All others need this driver. The interface is selected using ACPI methods:
  13. *
  14. * * UIEN ("USB Interface Enable"): If invoked with argument 1, disables SPI
  15. * and enables USB. If invoked with argument 0, disables USB.
  16. * * UIST ("USB Interface Status"): Returns 1 if USB is enabled, 0 otherwise.
  17. * * SIEN ("SPI Interface Enable"): If invoked with argument 1, disables USB
  18. * and enables SPI. If invoked with argument 0, disables SPI.
  19. * * SIST ("SPI Interface Status"): Returns 1 if SPI is enabled, 0 otherwise.
  20. * * ISOL: Resets the four GPIO pins used for SPI. Intended to be invoked with
  21. * argument 1, then once more with argument 0.
  22. *
  23. * UIEN and UIST are only provided on models where the USB pins are connected.
  24. *
  25. * SPI-based Protocol
  26. * ------------------
  27. *
  28. * The device and driver exchange messages (struct message); each message is
  29. * encapsulated in one or more packets (struct spi_packet). There are two types
  30. * of exchanges: reads, and writes. A read is signaled by a GPE, upon which one
  31. * message can be read from the device. A write exchange consists of writing a
  32. * command message, immediately reading a short status packet, and then, upon
  33. * receiving a GPE, reading the response message. Write exchanges cannot be
  34. * interleaved, i.e. a new write exchange must not be started till the previous
  35. * write exchange is complete. Whether a received message is part of a read or
  36. * write exchange is indicated in the encapsulating packet's flags field.
  37. *
  38. * A single message may be too large to fit in a single packet (which has a
  39. * fixed, 256-byte size). In that case it will be split over multiple,
  40. * consecutive packets.
  41. */
  42. #include <linux/acpi.h>
  43. #include <linux/crc16.h>
  44. #include <linux/debugfs.h>
  45. #include <linux/delay.h>
  46. #include <linux/efi.h>
  47. #include <linux/input.h>
  48. #include <linux/input/mt.h>
  49. #include <linux/ktime.h>
  50. #include <linux/leds.h>
  51. #include <linux/module.h>
  52. #include <linux/spinlock.h>
  53. #include <linux/spi/spi.h>
  54. #include <linux/wait.h>
  55. #include <linux/workqueue.h>
  56. #include <asm/barrier.h>
  57. #include <asm/unaligned.h>
  58. #define CREATE_TRACE_POINTS
  59. #include "applespi.h"
  60. #include "applespi_trace.h"
  61. #define APPLESPI_PACKET_SIZE 256
  62. #define APPLESPI_STATUS_SIZE 4
  63. #define PACKET_TYPE_READ 0x20
  64. #define PACKET_TYPE_WRITE 0x40
  65. #define PACKET_DEV_KEYB 0x01
  66. #define PACKET_DEV_TPAD 0x02
  67. #define PACKET_DEV_INFO 0xd0
  68. #define MAX_ROLLOVER 6
  69. #define MAX_FINGERS 11
  70. #define MAX_FINGER_ORIENTATION 16384
  71. #define MAX_PKTS_PER_MSG 2
  72. #define KBD_BL_LEVEL_MIN 32U
  73. #define KBD_BL_LEVEL_MAX 255U
  74. #define KBD_BL_LEVEL_SCALE 1000000U
  75. #define KBD_BL_LEVEL_ADJ \
  76. ((KBD_BL_LEVEL_MAX - KBD_BL_LEVEL_MIN) * KBD_BL_LEVEL_SCALE / 255U)
  77. #define EFI_BL_LEVEL_NAME L"KeyboardBacklightLevel"
  78. #define EFI_BL_LEVEL_GUID EFI_GUID(0xa076d2af, 0x9678, 0x4386, 0x8b, 0x58, 0x1f, 0xc8, 0xef, 0x04, 0x16, 0x19)
  79. #define APPLE_FLAG_FKEY 0x01
  80. #define SPI_RW_CHG_DELAY_US 100 /* from experimentation, in µs */
  81. #define SYNAPTICS_VENDOR_ID 0x06cb
  82. static unsigned int fnmode = 1;
  83. module_param(fnmode, uint, 0644);
  84. MODULE_PARM_DESC(fnmode, "Mode of Fn key on Apple keyboards (0 = disabled, [1] = fkeyslast, 2 = fkeysfirst)");
  85. static unsigned int fnremap;
  86. module_param(fnremap, uint, 0644);
  87. MODULE_PARM_DESC(fnremap, "Remap Fn key ([0] = no-remap; 1 = left-ctrl, 2 = left-shift, 3 = left-alt, 4 = left-meta, 6 = right-shift, 7 = right-alt, 8 = right-meta)");
  88. static bool iso_layout;
  89. module_param(iso_layout, bool, 0644);
  90. MODULE_PARM_DESC(iso_layout, "Enable/Disable hardcoded ISO-layout of the keyboard. ([0] = disabled, 1 = enabled)");
  91. static char touchpad_dimensions[40];
  92. module_param_string(touchpad_dimensions, touchpad_dimensions,
  93. sizeof(touchpad_dimensions), 0444);
  94. MODULE_PARM_DESC(touchpad_dimensions, "The pixel dimensions of the touchpad, as XxY+W+H .");
  95. /**
  96. * struct keyboard_protocol - keyboard message.
  97. * message.type = 0x0110, message.length = 0x000a
  98. *
  99. * @unknown1: unknown
  100. * @modifiers: bit-set of modifier/control keys pressed
  101. * @unknown2: unknown
  102. * @keys_pressed: the (non-modifier) keys currently pressed
  103. * @fn_pressed: whether the fn key is currently pressed
  104. * @crc16: crc over the whole message struct (message header +
  105. * this struct) minus this @crc16 field
  106. */
  107. struct keyboard_protocol {
  108. u8 unknown1;
  109. u8 modifiers;
  110. u8 unknown2;
  111. u8 keys_pressed[MAX_ROLLOVER];
  112. u8 fn_pressed;
  113. __le16 crc16;
  114. };
  115. /**
  116. * struct tp_finger - single trackpad finger structure, le16-aligned
  117. *
  118. * @origin: zero when switching track finger
  119. * @abs_x: absolute x coordinate
  120. * @abs_y: absolute y coordinate
  121. * @rel_x: relative x coordinate
  122. * @rel_y: relative y coordinate
  123. * @tool_major: tool area, major axis
  124. * @tool_minor: tool area, minor axis
  125. * @orientation: 16384 when point, else 15 bit angle
  126. * @touch_major: touch area, major axis
  127. * @touch_minor: touch area, minor axis
  128. * @unused: zeros
  129. * @pressure: pressure on forcetouch touchpad
  130. * @multi: one finger: varies, more fingers: constant
  131. * @crc16: on last finger: crc over the whole message struct
  132. * (i.e. message header + this struct) minus the last
  133. * @crc16 field; unknown on all other fingers.
  134. */
  135. struct tp_finger {
  136. __le16 origin;
  137. __le16 abs_x;
  138. __le16 abs_y;
  139. __le16 rel_x;
  140. __le16 rel_y;
  141. __le16 tool_major;
  142. __le16 tool_minor;
  143. __le16 orientation;
  144. __le16 touch_major;
  145. __le16 touch_minor;
  146. __le16 unused[2];
  147. __le16 pressure;
  148. __le16 multi;
  149. __le16 crc16;
  150. };
  151. /**
  152. * struct touchpad_protocol - touchpad message.
  153. * message.type = 0x0210
  154. *
  155. * @unknown1: unknown
  156. * @clicked: 1 if a button-click was detected, 0 otherwise
  157. * @unknown2: unknown
  158. * @number_of_fingers: the number of fingers being reported in @fingers
  159. * @clicked2: same as @clicked
  160. * @unknown3: unknown
  161. * @fingers: the data for each finger
  162. */
  163. struct touchpad_protocol {
  164. u8 unknown1[1];
  165. u8 clicked;
  166. u8 unknown2[28];
  167. u8 number_of_fingers;
  168. u8 clicked2;
  169. u8 unknown3[16];
  170. struct tp_finger fingers[];
  171. };
  172. /**
  173. * struct command_protocol_tp_info - get touchpad info.
  174. * message.type = 0x1020, message.length = 0x0000
  175. *
  176. * @crc16: crc over the whole message struct (message header +
  177. * this struct) minus this @crc16 field
  178. */
  179. struct command_protocol_tp_info {
  180. __le16 crc16;
  181. };
  182. /**
  183. * struct touchpad_info - touchpad info response.
  184. * message.type = 0x1020, message.length = 0x006e
  185. *
  186. * @unknown1: unknown
  187. * @model_flags: flags (vary by model number, but significance otherwise
  188. * unknown)
  189. * @model_no: the touchpad model number
  190. * @unknown2: unknown
  191. * @crc16: crc over the whole message struct (message header +
  192. * this struct) minus this @crc16 field
  193. */
  194. struct touchpad_info_protocol {
  195. u8 unknown1[105];
  196. u8 model_flags;
  197. u8 model_no;
  198. u8 unknown2[3];
  199. __le16 crc16;
  200. };
  201. /**
  202. * struct command_protocol_mt_init - initialize multitouch.
  203. * message.type = 0x0252, message.length = 0x0002
  204. *
  205. * @cmd: value: 0x0102
  206. * @crc16: crc over the whole message struct (message header +
  207. * this struct) minus this @crc16 field
  208. */
  209. struct command_protocol_mt_init {
  210. __le16 cmd;
  211. __le16 crc16;
  212. };
  213. /**
  214. * struct command_protocol_capsl - toggle caps-lock led
  215. * message.type = 0x0151, message.length = 0x0002
  216. *
  217. * @unknown: value: 0x01 (length?)
  218. * @led: 0 off, 2 on
  219. * @crc16: crc over the whole message struct (message header +
  220. * this struct) minus this @crc16 field
  221. */
  222. struct command_protocol_capsl {
  223. u8 unknown;
  224. u8 led;
  225. __le16 crc16;
  226. };
  227. /**
  228. * struct command_protocol_bl - set keyboard backlight brightness
  229. * message.type = 0xB051, message.length = 0x0006
  230. *
  231. * @const1: value: 0x01B0
  232. * @level: the brightness level to set
  233. * @const2: value: 0x0001 (backlight off), 0x01F4 (backlight on)
  234. * @crc16: crc over the whole message struct (message header +
  235. * this struct) minus this @crc16 field
  236. */
  237. struct command_protocol_bl {
  238. __le16 const1;
  239. __le16 level;
  240. __le16 const2;
  241. __le16 crc16;
  242. };
  243. /**
  244. * struct message - a complete spi message.
  245. *
  246. * Each message begins with fixed header, followed by a message-type specific
  247. * payload, and ends with a 16-bit crc. Because of the varying lengths of the
  248. * payload, the crc is defined at the end of each payload struct, rather than
  249. * in this struct.
  250. *
  251. * @type: the message type
  252. * @zero: always 0
  253. * @counter: incremented on each message, rolls over after 255; there is a
  254. * separate counter for each message type.
  255. * @rsp_buf_len:response buffer length (the exact nature of this field is quite
  256. * speculative). On a request/write this is often the same as
  257. * @length, though in some cases it has been seen to be much larger
  258. * (e.g. 0x400); on a response/read this the same as on the
  259. * request; for reads that are not responses it is 0.
  260. * @length: length of the remainder of the data in the whole message
  261. * structure (after re-assembly in case of being split over
  262. * multiple spi-packets), minus the trailing crc. The total size
  263. * of the message struct is therefore @length + 10.
  264. */
  265. struct message {
  266. __le16 type;
  267. u8 zero;
  268. u8 counter;
  269. __le16 rsp_buf_len;
  270. __le16 length;
  271. union {
  272. struct keyboard_protocol keyboard;
  273. struct touchpad_protocol touchpad;
  274. struct touchpad_info_protocol tp_info;
  275. struct command_protocol_tp_info tp_info_command;
  276. struct command_protocol_mt_init init_mt_command;
  277. struct command_protocol_capsl capsl_command;
  278. struct command_protocol_bl bl_command;
  279. u8 data[0];
  280. };
  281. };
  282. /* type + zero + counter + rsp_buf_len + length */
  283. #define MSG_HEADER_SIZE 8
  284. /**
  285. * struct spi_packet - a complete spi packet; always 256 bytes. This carries
  286. * the (parts of the) message in the data. But note that this does not
  287. * necessarily contain a complete message, as in some cases (e.g. many
  288. * fingers pressed) the message is split over multiple packets (see the
  289. * @offset, @remaining, and @length fields). In general the data parts in
  290. * spi_packet's are concatenated until @remaining is 0, and the result is an
  291. * message.
  292. *
  293. * @flags: 0x40 = write (to device), 0x20 = read (from device); note that
  294. * the response to a write still has 0x40.
  295. * @device: 1 = keyboard, 2 = touchpad
  296. * @offset: specifies the offset of this packet's data in the complete
  297. * message; i.e. > 0 indicates this is a continuation packet (in
  298. * the second packet for a message split over multiple packets
  299. * this would then be the same as the @length in the first packet)
  300. * @remaining: number of message bytes remaining in subsequents packets (in
  301. * the first packet of a message split over two packets this would
  302. * then be the same as the @length in the second packet)
  303. * @length: length of the valid data in the @data in this packet
  304. * @data: all or part of a message
  305. * @crc16: crc over this whole structure minus this @crc16 field. This
  306. * covers just this packet, even on multi-packet messages (in
  307. * contrast to the crc in the message).
  308. */
  309. struct spi_packet {
  310. u8 flags;
  311. u8 device;
  312. __le16 offset;
  313. __le16 remaining;
  314. __le16 length;
  315. u8 data[246];
  316. __le16 crc16;
  317. };
  318. struct spi_settings {
  319. u64 spi_cs_delay; /* cs-to-clk delay in us */
  320. u64 reset_a2r_usec; /* active-to-receive delay? */
  321. u64 reset_rec_usec; /* ? (cur val: 10) */
  322. };
  323. /* this mimics struct drm_rect */
  324. struct applespi_tp_info {
  325. int x_min;
  326. int y_min;
  327. int x_max;
  328. int y_max;
  329. };
  330. struct applespi_data {
  331. struct spi_device *spi;
  332. struct spi_settings spi_settings;
  333. struct input_dev *keyboard_input_dev;
  334. struct input_dev *touchpad_input_dev;
  335. u8 *tx_buffer;
  336. u8 *tx_status;
  337. u8 *rx_buffer;
  338. u8 *msg_buf;
  339. unsigned int saved_msg_len;
  340. struct applespi_tp_info tp_info;
  341. u8 last_keys_pressed[MAX_ROLLOVER];
  342. u8 last_keys_fn_pressed[MAX_ROLLOVER];
  343. u8 last_fn_pressed;
  344. struct input_mt_pos pos[MAX_FINGERS];
  345. int slots[MAX_FINGERS];
  346. int gpe;
  347. acpi_handle sien;
  348. acpi_handle sist;
  349. struct spi_transfer dl_t;
  350. struct spi_transfer rd_t;
  351. struct spi_message rd_m;
  352. struct spi_transfer ww_t;
  353. struct spi_transfer wd_t;
  354. struct spi_transfer wr_t;
  355. struct spi_transfer st_t;
  356. struct spi_message wr_m;
  357. bool want_tp_info_cmd;
  358. bool want_mt_init_cmd;
  359. bool want_cl_led_on;
  360. bool have_cl_led_on;
  361. unsigned int want_bl_level;
  362. unsigned int have_bl_level;
  363. unsigned int cmd_msg_cntr;
  364. /* lock to protect the above parameters and flags below */
  365. spinlock_t cmd_msg_lock;
  366. ktime_t cmd_msg_queued;
  367. enum applespi_evt_type cmd_evt_type;
  368. struct led_classdev backlight_info;
  369. bool suspended;
  370. bool drain;
  371. wait_queue_head_t drain_complete;
  372. bool read_active;
  373. bool write_active;
  374. struct work_struct work;
  375. struct touchpad_info_protocol rcvd_tp_info;
  376. struct dentry *debugfs_root;
  377. bool debug_tp_dim;
  378. char tp_dim_val[40];
  379. int tp_dim_min_x;
  380. int tp_dim_max_x;
  381. int tp_dim_min_y;
  382. int tp_dim_max_y;
  383. };
  384. static const unsigned char applespi_scancodes[] = {
  385. 0, 0, 0, 0,
  386. KEY_A, KEY_B, KEY_C, KEY_D, KEY_E, KEY_F, KEY_G, KEY_H, KEY_I, KEY_J,
  387. KEY_K, KEY_L, KEY_M, KEY_N, KEY_O, KEY_P, KEY_Q, KEY_R, KEY_S, KEY_T,
  388. KEY_U, KEY_V, KEY_W, KEY_X, KEY_Y, KEY_Z,
  389. KEY_1, KEY_2, KEY_3, KEY_4, KEY_5, KEY_6, KEY_7, KEY_8, KEY_9, KEY_0,
  390. KEY_ENTER, KEY_ESC, KEY_BACKSPACE, KEY_TAB, KEY_SPACE, KEY_MINUS,
  391. KEY_EQUAL, KEY_LEFTBRACE, KEY_RIGHTBRACE, KEY_BACKSLASH, 0,
  392. KEY_SEMICOLON, KEY_APOSTROPHE, KEY_GRAVE, KEY_COMMA, KEY_DOT, KEY_SLASH,
  393. KEY_CAPSLOCK,
  394. KEY_F1, KEY_F2, KEY_F3, KEY_F4, KEY_F5, KEY_F6, KEY_F7, KEY_F8, KEY_F9,
  395. KEY_F10, KEY_F11, KEY_F12, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  396. KEY_RIGHT, KEY_LEFT, KEY_DOWN, KEY_UP,
  397. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, KEY_102ND,
  398. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  399. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, KEY_RO, 0, KEY_YEN, 0, 0, 0, 0, 0,
  400. 0, KEY_KATAKANAHIRAGANA, KEY_MUHENKAN
  401. };
  402. /*
  403. * This must have exactly as many entries as there are bits in
  404. * struct keyboard_protocol.modifiers .
  405. */
  406. static const unsigned char applespi_controlcodes[] = {
  407. KEY_LEFTCTRL,
  408. KEY_LEFTSHIFT,
  409. KEY_LEFTALT,
  410. KEY_LEFTMETA,
  411. 0,
  412. KEY_RIGHTSHIFT,
  413. KEY_RIGHTALT,
  414. KEY_RIGHTMETA
  415. };
  416. struct applespi_key_translation {
  417. u16 from;
  418. u16 to;
  419. u8 flags;
  420. };
  421. static const struct applespi_key_translation applespi_fn_codes[] = {
  422. { KEY_BACKSPACE, KEY_DELETE },
  423. { KEY_ENTER, KEY_INSERT },
  424. { KEY_F1, KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
  425. { KEY_F2, KEY_BRIGHTNESSUP, APPLE_FLAG_FKEY },
  426. { KEY_F3, KEY_SCALE, APPLE_FLAG_FKEY },
  427. { KEY_F4, KEY_DASHBOARD, APPLE_FLAG_FKEY },
  428. { KEY_F5, KEY_KBDILLUMDOWN, APPLE_FLAG_FKEY },
  429. { KEY_F6, KEY_KBDILLUMUP, APPLE_FLAG_FKEY },
  430. { KEY_F7, KEY_PREVIOUSSONG, APPLE_FLAG_FKEY },
  431. { KEY_F8, KEY_PLAYPAUSE, APPLE_FLAG_FKEY },
  432. { KEY_F9, KEY_NEXTSONG, APPLE_FLAG_FKEY },
  433. { KEY_F10, KEY_MUTE, APPLE_FLAG_FKEY },
  434. { KEY_F11, KEY_VOLUMEDOWN, APPLE_FLAG_FKEY },
  435. { KEY_F12, KEY_VOLUMEUP, APPLE_FLAG_FKEY },
  436. { KEY_RIGHT, KEY_END },
  437. { KEY_LEFT, KEY_HOME },
  438. { KEY_DOWN, KEY_PAGEDOWN },
  439. { KEY_UP, KEY_PAGEUP },
  440. { }
  441. };
  442. static const struct applespi_key_translation apple_iso_keyboard[] = {
  443. { KEY_GRAVE, KEY_102ND },
  444. { KEY_102ND, KEY_GRAVE },
  445. { }
  446. };
  447. struct applespi_tp_model_info {
  448. u16 model;
  449. struct applespi_tp_info tp_info;
  450. };
  451. static const struct applespi_tp_model_info applespi_tp_models[] = {
  452. {
  453. .model = 0x04, /* MB8 MB9 MB10 */
  454. .tp_info = { -5087, -182, 5579, 6089 },
  455. },
  456. {
  457. .model = 0x05, /* MBP13,1 MBP13,2 MBP14,1 MBP14,2 */
  458. .tp_info = { -6243, -170, 6749, 7685 },
  459. },
  460. {
  461. .model = 0x06, /* MBP13,3 MBP14,3 */
  462. .tp_info = { -7456, -163, 7976, 9283 },
  463. },
  464. {}
  465. };
  466. typedef void (*applespi_trace_fun)(enum applespi_evt_type,
  467. enum applespi_pkt_type, u8 *, size_t);
  468. static applespi_trace_fun applespi_get_trace_fun(enum applespi_evt_type type)
  469. {
  470. switch (type) {
  471. case ET_CMD_TP_INI:
  472. return trace_applespi_tp_ini_cmd;
  473. case ET_CMD_BL:
  474. return trace_applespi_backlight_cmd;
  475. case ET_CMD_CL:
  476. return trace_applespi_caps_lock_cmd;
  477. case ET_RD_KEYB:
  478. return trace_applespi_keyboard_data;
  479. case ET_RD_TPAD:
  480. return trace_applespi_touchpad_data;
  481. case ET_RD_UNKN:
  482. return trace_applespi_unknown_data;
  483. default:
  484. WARN_ONCE(1, "Unknown msg type %d", type);
  485. return trace_applespi_unknown_data;
  486. }
  487. }
  488. static void applespi_setup_read_txfrs(struct applespi_data *applespi)
  489. {
  490. struct spi_message *msg = &applespi->rd_m;
  491. struct spi_transfer *dl_t = &applespi->dl_t;
  492. struct spi_transfer *rd_t = &applespi->rd_t;
  493. memset(dl_t, 0, sizeof(*dl_t));
  494. memset(rd_t, 0, sizeof(*rd_t));
  495. dl_t->delay_usecs = applespi->spi_settings.spi_cs_delay;
  496. rd_t->rx_buf = applespi->rx_buffer;
  497. rd_t->len = APPLESPI_PACKET_SIZE;
  498. spi_message_init(msg);
  499. spi_message_add_tail(dl_t, msg);
  500. spi_message_add_tail(rd_t, msg);
  501. }
  502. static void applespi_setup_write_txfrs(struct applespi_data *applespi)
  503. {
  504. struct spi_message *msg = &applespi->wr_m;
  505. struct spi_transfer *wt_t = &applespi->ww_t;
  506. struct spi_transfer *dl_t = &applespi->wd_t;
  507. struct spi_transfer *wr_t = &applespi->wr_t;
  508. struct spi_transfer *st_t = &applespi->st_t;
  509. memset(wt_t, 0, sizeof(*wt_t));
  510. memset(dl_t, 0, sizeof(*dl_t));
  511. memset(wr_t, 0, sizeof(*wr_t));
  512. memset(st_t, 0, sizeof(*st_t));
  513. /*
  514. * All we need here is a delay at the beginning of the message before
  515. * asserting cs. But the current spi API doesn't support this, so we
  516. * end up with an extra unnecessary (but harmless) cs assertion and
  517. * deassertion.
  518. */
  519. wt_t->delay_usecs = SPI_RW_CHG_DELAY_US;
  520. wt_t->cs_change = 1;
  521. dl_t->delay_usecs = applespi->spi_settings.spi_cs_delay;
  522. wr_t->tx_buf = applespi->tx_buffer;
  523. wr_t->len = APPLESPI_PACKET_SIZE;
  524. wr_t->delay_usecs = SPI_RW_CHG_DELAY_US;
  525. st_t->rx_buf = applespi->tx_status;
  526. st_t->len = APPLESPI_STATUS_SIZE;
  527. spi_message_init(msg);
  528. spi_message_add_tail(wt_t, msg);
  529. spi_message_add_tail(dl_t, msg);
  530. spi_message_add_tail(wr_t, msg);
  531. spi_message_add_tail(st_t, msg);
  532. }
  533. static int applespi_async(struct applespi_data *applespi,
  534. struct spi_message *message, void (*complete)(void *))
  535. {
  536. message->complete = complete;
  537. message->context = applespi;
  538. return spi_async(applespi->spi, message);
  539. }
  540. static inline bool applespi_check_write_status(struct applespi_data *applespi,
  541. int sts)
  542. {
  543. static u8 status_ok[] = { 0xac, 0x27, 0x68, 0xd5 };
  544. if (sts < 0) {
  545. dev_warn(&applespi->spi->dev, "Error writing to device: %d\n",
  546. sts);
  547. return false;
  548. }
  549. if (memcmp(applespi->tx_status, status_ok, APPLESPI_STATUS_SIZE)) {
  550. dev_warn(&applespi->spi->dev, "Error writing to device: %*ph\n",
  551. APPLESPI_STATUS_SIZE, applespi->tx_status);
  552. return false;
  553. }
  554. return true;
  555. }
  556. static int applespi_get_spi_settings(struct applespi_data *applespi)
  557. {
  558. struct acpi_device *adev = ACPI_COMPANION(&applespi->spi->dev);
  559. const union acpi_object *o;
  560. struct spi_settings *settings = &applespi->spi_settings;
  561. if (!acpi_dev_get_property(adev, "spiCSDelay", ACPI_TYPE_BUFFER, &o))
  562. settings->spi_cs_delay = *(u64 *)o->buffer.pointer;
  563. else
  564. dev_warn(&applespi->spi->dev,
  565. "Property spiCSDelay not found\n");
  566. if (!acpi_dev_get_property(adev, "resetA2RUsec", ACPI_TYPE_BUFFER, &o))
  567. settings->reset_a2r_usec = *(u64 *)o->buffer.pointer;
  568. else
  569. dev_warn(&applespi->spi->dev,
  570. "Property resetA2RUsec not found\n");
  571. if (!acpi_dev_get_property(adev, "resetRecUsec", ACPI_TYPE_BUFFER, &o))
  572. settings->reset_rec_usec = *(u64 *)o->buffer.pointer;
  573. else
  574. dev_warn(&applespi->spi->dev,
  575. "Property resetRecUsec not found\n");
  576. dev_dbg(&applespi->spi->dev,
  577. "SPI settings: spi_cs_delay=%llu reset_a2r_usec=%llu reset_rec_usec=%llu\n",
  578. settings->spi_cs_delay, settings->reset_a2r_usec,
  579. settings->reset_rec_usec);
  580. return 0;
  581. }
  582. static int applespi_setup_spi(struct applespi_data *applespi)
  583. {
  584. int sts;
  585. sts = applespi_get_spi_settings(applespi);
  586. if (sts)
  587. return sts;
  588. spin_lock_init(&applespi->cmd_msg_lock);
  589. init_waitqueue_head(&applespi->drain_complete);
  590. return 0;
  591. }
  592. static int applespi_enable_spi(struct applespi_data *applespi)
  593. {
  594. acpi_status acpi_sts;
  595. unsigned long long spi_status;
  596. /* check if SPI is already enabled, so we can skip the delay below */
  597. acpi_sts = acpi_evaluate_integer(applespi->sist, NULL, NULL,
  598. &spi_status);
  599. if (ACPI_SUCCESS(acpi_sts) && spi_status)
  600. return 0;
  601. /* SIEN(1) will enable SPI communication */
  602. acpi_sts = acpi_execute_simple_method(applespi->sien, NULL, 1);
  603. if (ACPI_FAILURE(acpi_sts)) {
  604. dev_err(&applespi->spi->dev, "SIEN failed: %s\n",
  605. acpi_format_exception(acpi_sts));
  606. return -ENODEV;
  607. }
  608. /*
  609. * Allow the SPI interface to come up before returning. Without this
  610. * delay, the SPI commands to enable multitouch mode may not reach
  611. * the trackpad controller, causing pointer movement to break upon
  612. * resume from sleep.
  613. */
  614. msleep(50);
  615. return 0;
  616. }
  617. static int applespi_send_cmd_msg(struct applespi_data *applespi);
  618. static void applespi_msg_complete(struct applespi_data *applespi,
  619. bool is_write_msg, bool is_read_compl)
  620. {
  621. unsigned long flags;
  622. spin_lock_irqsave(&applespi->cmd_msg_lock, flags);
  623. if (is_read_compl)
  624. applespi->read_active = false;
  625. if (is_write_msg)
  626. applespi->write_active = false;
  627. if (applespi->drain && !applespi->write_active)
  628. wake_up_all(&applespi->drain_complete);
  629. if (is_write_msg) {
  630. applespi->cmd_msg_queued = 0;
  631. applespi_send_cmd_msg(applespi);
  632. }
  633. spin_unlock_irqrestore(&applespi->cmd_msg_lock, flags);
  634. }
  635. static void applespi_async_write_complete(void *context)
  636. {
  637. struct applespi_data *applespi = context;
  638. enum applespi_evt_type evt_type = applespi->cmd_evt_type;
  639. applespi_get_trace_fun(evt_type)(evt_type, PT_WRITE,
  640. applespi->tx_buffer,
  641. APPLESPI_PACKET_SIZE);
  642. applespi_get_trace_fun(evt_type)(evt_type, PT_STATUS,
  643. applespi->tx_status,
  644. APPLESPI_STATUS_SIZE);
  645. if (!applespi_check_write_status(applespi, applespi->wr_m.status)) {
  646. /*
  647. * If we got an error, we presumably won't get the expected
  648. * response message either.
  649. */
  650. applespi_msg_complete(applespi, true, false);
  651. }
  652. }
  653. static int applespi_send_cmd_msg(struct applespi_data *applespi)
  654. {
  655. u16 crc;
  656. int sts;
  657. struct spi_packet *packet = (struct spi_packet *)applespi->tx_buffer;
  658. struct message *message = (struct message *)packet->data;
  659. u16 msg_len;
  660. u8 device;
  661. /* check if draining */
  662. if (applespi->drain)
  663. return 0;
  664. /* check whether send is in progress */
  665. if (applespi->cmd_msg_queued) {
  666. if (ktime_ms_delta(ktime_get(), applespi->cmd_msg_queued) < 1000)
  667. return 0;
  668. dev_warn(&applespi->spi->dev, "Command %d timed out\n",
  669. applespi->cmd_evt_type);
  670. applespi->cmd_msg_queued = 0;
  671. applespi->write_active = false;
  672. }
  673. /* set up packet */
  674. memset(packet, 0, APPLESPI_PACKET_SIZE);
  675. /* are we processing init commands? */
  676. if (applespi->want_tp_info_cmd) {
  677. applespi->want_tp_info_cmd = false;
  678. applespi->want_mt_init_cmd = true;
  679. applespi->cmd_evt_type = ET_CMD_TP_INI;
  680. /* build init command */
  681. device = PACKET_DEV_INFO;
  682. message->type = cpu_to_le16(0x1020);
  683. msg_len = sizeof(message->tp_info_command);
  684. message->zero = 0x02;
  685. message->rsp_buf_len = cpu_to_le16(0x0200);
  686. } else if (applespi->want_mt_init_cmd) {
  687. applespi->want_mt_init_cmd = false;
  688. applespi->cmd_evt_type = ET_CMD_TP_INI;
  689. /* build init command */
  690. device = PACKET_DEV_TPAD;
  691. message->type = cpu_to_le16(0x0252);
  692. msg_len = sizeof(message->init_mt_command);
  693. message->init_mt_command.cmd = cpu_to_le16(0x0102);
  694. /* do we need caps-lock command? */
  695. } else if (applespi->want_cl_led_on != applespi->have_cl_led_on) {
  696. applespi->have_cl_led_on = applespi->want_cl_led_on;
  697. applespi->cmd_evt_type = ET_CMD_CL;
  698. /* build led command */
  699. device = PACKET_DEV_KEYB;
  700. message->type = cpu_to_le16(0x0151);
  701. msg_len = sizeof(message->capsl_command);
  702. message->capsl_command.unknown = 0x01;
  703. message->capsl_command.led = applespi->have_cl_led_on ? 2 : 0;
  704. /* do we need backlight command? */
  705. } else if (applespi->want_bl_level != applespi->have_bl_level) {
  706. applespi->have_bl_level = applespi->want_bl_level;
  707. applespi->cmd_evt_type = ET_CMD_BL;
  708. /* build command buffer */
  709. device = PACKET_DEV_KEYB;
  710. message->type = cpu_to_le16(0xB051);
  711. msg_len = sizeof(message->bl_command);
  712. message->bl_command.const1 = cpu_to_le16(0x01B0);
  713. message->bl_command.level =
  714. cpu_to_le16(applespi->have_bl_level);
  715. if (applespi->have_bl_level > 0)
  716. message->bl_command.const2 = cpu_to_le16(0x01F4);
  717. else
  718. message->bl_command.const2 = cpu_to_le16(0x0001);
  719. /* everything's up-to-date */
  720. } else {
  721. return 0;
  722. }
  723. /* finalize packet */
  724. packet->flags = PACKET_TYPE_WRITE;
  725. packet->device = device;
  726. packet->length = cpu_to_le16(MSG_HEADER_SIZE + msg_len);
  727. message->counter = applespi->cmd_msg_cntr++ % (U8_MAX + 1);
  728. message->length = cpu_to_le16(msg_len - 2);
  729. if (!message->rsp_buf_len)
  730. message->rsp_buf_len = message->length;
  731. crc = crc16(0, (u8 *)message, le16_to_cpu(packet->length) - 2);
  732. put_unaligned_le16(crc, &message->data[msg_len - 2]);
  733. crc = crc16(0, (u8 *)packet, sizeof(*packet) - 2);
  734. packet->crc16 = cpu_to_le16(crc);
  735. /* send command */
  736. sts = applespi_async(applespi, &applespi->wr_m,
  737. applespi_async_write_complete);
  738. if (sts) {
  739. dev_warn(&applespi->spi->dev,
  740. "Error queueing async write to device: %d\n", sts);
  741. return sts;
  742. }
  743. applespi->cmd_msg_queued = ktime_get_coarse();
  744. applespi->write_active = true;
  745. return 0;
  746. }
  747. static void applespi_init(struct applespi_data *applespi, bool is_resume)
  748. {
  749. unsigned long flags;
  750. spin_lock_irqsave(&applespi->cmd_msg_lock, flags);
  751. if (is_resume)
  752. applespi->want_mt_init_cmd = true;
  753. else
  754. applespi->want_tp_info_cmd = true;
  755. applespi_send_cmd_msg(applespi);
  756. spin_unlock_irqrestore(&applespi->cmd_msg_lock, flags);
  757. }
  758. static int applespi_set_capsl_led(struct applespi_data *applespi,
  759. bool capslock_on)
  760. {
  761. unsigned long flags;
  762. int sts;
  763. spin_lock_irqsave(&applespi->cmd_msg_lock, flags);
  764. applespi->want_cl_led_on = capslock_on;
  765. sts = applespi_send_cmd_msg(applespi);
  766. spin_unlock_irqrestore(&applespi->cmd_msg_lock, flags);
  767. return sts;
  768. }
  769. static void applespi_set_bl_level(struct led_classdev *led_cdev,
  770. enum led_brightness value)
  771. {
  772. struct applespi_data *applespi =
  773. container_of(led_cdev, struct applespi_data, backlight_info);
  774. unsigned long flags;
  775. spin_lock_irqsave(&applespi->cmd_msg_lock, flags);
  776. if (value == 0) {
  777. applespi->want_bl_level = value;
  778. } else {
  779. /*
  780. * The backlight does not turn on till level 32, so we scale
  781. * the range here so that from a user's perspective it turns
  782. * on at 1.
  783. */
  784. applespi->want_bl_level =
  785. ((value * KBD_BL_LEVEL_ADJ) / KBD_BL_LEVEL_SCALE +
  786. KBD_BL_LEVEL_MIN);
  787. }
  788. applespi_send_cmd_msg(applespi);
  789. spin_unlock_irqrestore(&applespi->cmd_msg_lock, flags);
  790. }
  791. static int applespi_event(struct input_dev *dev, unsigned int type,
  792. unsigned int code, int value)
  793. {
  794. struct applespi_data *applespi = input_get_drvdata(dev);
  795. switch (type) {
  796. case EV_LED:
  797. applespi_set_capsl_led(applespi, !!test_bit(LED_CAPSL, dev->led));
  798. return 0;
  799. }
  800. return -EINVAL;
  801. }
  802. /* lifted from the BCM5974 driver and renamed from raw2int */
  803. /* convert 16-bit little endian to signed integer */
  804. static inline int le16_to_int(__le16 x)
  805. {
  806. return (signed short)le16_to_cpu(x);
  807. }
  808. static void applespi_debug_update_dimensions(struct applespi_data *applespi,
  809. const struct tp_finger *f)
  810. {
  811. applespi->tp_dim_min_x = min(applespi->tp_dim_min_x,
  812. le16_to_int(f->abs_x));
  813. applespi->tp_dim_max_x = max(applespi->tp_dim_max_x,
  814. le16_to_int(f->abs_x));
  815. applespi->tp_dim_min_y = min(applespi->tp_dim_min_y,
  816. le16_to_int(f->abs_y));
  817. applespi->tp_dim_max_y = max(applespi->tp_dim_max_y,
  818. le16_to_int(f->abs_y));
  819. }
  820. static int applespi_tp_dim_open(struct inode *inode, struct file *file)
  821. {
  822. struct applespi_data *applespi = inode->i_private;
  823. file->private_data = applespi;
  824. snprintf(applespi->tp_dim_val, sizeof(applespi->tp_dim_val),
  825. "0x%.4x %dx%d+%u+%u\n",
  826. applespi->touchpad_input_dev->id.product,
  827. applespi->tp_dim_min_x, applespi->tp_dim_min_y,
  828. applespi->tp_dim_max_x - applespi->tp_dim_min_x,
  829. applespi->tp_dim_max_y - applespi->tp_dim_min_y);
  830. return nonseekable_open(inode, file);
  831. }
  832. static ssize_t applespi_tp_dim_read(struct file *file, char __user *buf,
  833. size_t len, loff_t *off)
  834. {
  835. struct applespi_data *applespi = file->private_data;
  836. return simple_read_from_buffer(buf, len, off, applespi->tp_dim_val,
  837. strlen(applespi->tp_dim_val));
  838. }
  839. static const struct file_operations applespi_tp_dim_fops = {
  840. .owner = THIS_MODULE,
  841. .open = applespi_tp_dim_open,
  842. .read = applespi_tp_dim_read,
  843. .llseek = no_llseek,
  844. };
  845. static void report_finger_data(struct input_dev *input, int slot,
  846. const struct input_mt_pos *pos,
  847. const struct tp_finger *f)
  848. {
  849. input_mt_slot(input, slot);
  850. input_mt_report_slot_state(input, MT_TOOL_FINGER, true);
  851. input_report_abs(input, ABS_MT_TOUCH_MAJOR,
  852. le16_to_int(f->touch_major) << 1);
  853. input_report_abs(input, ABS_MT_TOUCH_MINOR,
  854. le16_to_int(f->touch_minor) << 1);
  855. input_report_abs(input, ABS_MT_WIDTH_MAJOR,
  856. le16_to_int(f->tool_major) << 1);
  857. input_report_abs(input, ABS_MT_WIDTH_MINOR,
  858. le16_to_int(f->tool_minor) << 1);
  859. input_report_abs(input, ABS_MT_ORIENTATION,
  860. MAX_FINGER_ORIENTATION - le16_to_int(f->orientation));
  861. input_report_abs(input, ABS_MT_POSITION_X, pos->x);
  862. input_report_abs(input, ABS_MT_POSITION_Y, pos->y);
  863. }
  864. static void report_tp_state(struct applespi_data *applespi,
  865. struct touchpad_protocol *t)
  866. {
  867. const struct tp_finger *f;
  868. struct input_dev *input;
  869. const struct applespi_tp_info *tp_info = &applespi->tp_info;
  870. int i, n;
  871. /* touchpad_input_dev is set async in worker */
  872. input = smp_load_acquire(&applespi->touchpad_input_dev);
  873. if (!input)
  874. return; /* touchpad isn't initialized yet */
  875. n = 0;
  876. for (i = 0; i < t->number_of_fingers; i++) {
  877. f = &t->fingers[i];
  878. if (le16_to_int(f->touch_major) == 0)
  879. continue;
  880. applespi->pos[n].x = le16_to_int(f->abs_x);
  881. applespi->pos[n].y = tp_info->y_min + tp_info->y_max -
  882. le16_to_int(f->abs_y);
  883. n++;
  884. if (applespi->debug_tp_dim)
  885. applespi_debug_update_dimensions(applespi, f);
  886. }
  887. input_mt_assign_slots(input, applespi->slots, applespi->pos, n, 0);
  888. for (i = 0; i < n; i++)
  889. report_finger_data(input, applespi->slots[i],
  890. &applespi->pos[i], &t->fingers[i]);
  891. input_mt_sync_frame(input);
  892. input_report_key(input, BTN_LEFT, t->clicked);
  893. input_sync(input);
  894. }
  895. static const struct applespi_key_translation *
  896. applespi_find_translation(const struct applespi_key_translation *table, u16 key)
  897. {
  898. const struct applespi_key_translation *trans;
  899. for (trans = table; trans->from; trans++)
  900. if (trans->from == key)
  901. return trans;
  902. return NULL;
  903. }
  904. static unsigned int applespi_translate_fn_key(unsigned int key, int fn_pressed)
  905. {
  906. const struct applespi_key_translation *trans;
  907. int do_translate;
  908. trans = applespi_find_translation(applespi_fn_codes, key);
  909. if (trans) {
  910. if (trans->flags & APPLE_FLAG_FKEY)
  911. do_translate = (fnmode == 2 && fn_pressed) ||
  912. (fnmode == 1 && !fn_pressed);
  913. else
  914. do_translate = fn_pressed;
  915. if (do_translate)
  916. key = trans->to;
  917. }
  918. return key;
  919. }
  920. static unsigned int applespi_translate_iso_layout(unsigned int key)
  921. {
  922. const struct applespi_key_translation *trans;
  923. trans = applespi_find_translation(apple_iso_keyboard, key);
  924. if (trans)
  925. key = trans->to;
  926. return key;
  927. }
  928. static unsigned int applespi_code_to_key(u8 code, int fn_pressed)
  929. {
  930. unsigned int key = applespi_scancodes[code];
  931. if (fnmode)
  932. key = applespi_translate_fn_key(key, fn_pressed);
  933. if (iso_layout)
  934. key = applespi_translate_iso_layout(key);
  935. return key;
  936. }
  937. static void
  938. applespi_remap_fn_key(struct keyboard_protocol *keyboard_protocol)
  939. {
  940. unsigned char tmp;
  941. u8 bit = BIT((fnremap - 1) & 0x07);
  942. if (!fnremap || fnremap > ARRAY_SIZE(applespi_controlcodes) ||
  943. !applespi_controlcodes[fnremap - 1])
  944. return;
  945. tmp = keyboard_protocol->fn_pressed;
  946. keyboard_protocol->fn_pressed = !!(keyboard_protocol->modifiers & bit);
  947. if (tmp)
  948. keyboard_protocol->modifiers |= bit;
  949. else
  950. keyboard_protocol->modifiers &= ~bit;
  951. }
  952. static void
  953. applespi_handle_keyboard_event(struct applespi_data *applespi,
  954. struct keyboard_protocol *keyboard_protocol)
  955. {
  956. unsigned int key;
  957. int i;
  958. compiletime_assert(ARRAY_SIZE(applespi_controlcodes) ==
  959. sizeof_field(struct keyboard_protocol, modifiers) * 8,
  960. "applespi_controlcodes has wrong number of entries");
  961. /* check for rollover overflow, which is signalled by all keys == 1 */
  962. if (!memchr_inv(keyboard_protocol->keys_pressed, 1, MAX_ROLLOVER))
  963. return;
  964. /* remap fn key if desired */
  965. applespi_remap_fn_key(keyboard_protocol);
  966. /* check released keys */
  967. for (i = 0; i < MAX_ROLLOVER; i++) {
  968. if (memchr(keyboard_protocol->keys_pressed,
  969. applespi->last_keys_pressed[i], MAX_ROLLOVER))
  970. continue; /* key is still pressed */
  971. key = applespi_code_to_key(applespi->last_keys_pressed[i],
  972. applespi->last_keys_fn_pressed[i]);
  973. input_report_key(applespi->keyboard_input_dev, key, 0);
  974. applespi->last_keys_fn_pressed[i] = 0;
  975. }
  976. /* check pressed keys */
  977. for (i = 0; i < MAX_ROLLOVER; i++) {
  978. if (keyboard_protocol->keys_pressed[i] <
  979. ARRAY_SIZE(applespi_scancodes) &&
  980. keyboard_protocol->keys_pressed[i] > 0) {
  981. key = applespi_code_to_key(
  982. keyboard_protocol->keys_pressed[i],
  983. keyboard_protocol->fn_pressed);
  984. input_report_key(applespi->keyboard_input_dev, key, 1);
  985. applespi->last_keys_fn_pressed[i] =
  986. keyboard_protocol->fn_pressed;
  987. }
  988. }
  989. /* check control keys */
  990. for (i = 0; i < ARRAY_SIZE(applespi_controlcodes); i++) {
  991. if (keyboard_protocol->modifiers & BIT(i))
  992. input_report_key(applespi->keyboard_input_dev,
  993. applespi_controlcodes[i], 1);
  994. else
  995. input_report_key(applespi->keyboard_input_dev,
  996. applespi_controlcodes[i], 0);
  997. }
  998. /* check function key */
  999. if (keyboard_protocol->fn_pressed && !applespi->last_fn_pressed)
  1000. input_report_key(applespi->keyboard_input_dev, KEY_FN, 1);
  1001. else if (!keyboard_protocol->fn_pressed && applespi->last_fn_pressed)
  1002. input_report_key(applespi->keyboard_input_dev, KEY_FN, 0);
  1003. applespi->last_fn_pressed = keyboard_protocol->fn_pressed;
  1004. /* done */
  1005. input_sync(applespi->keyboard_input_dev);
  1006. memcpy(&applespi->last_keys_pressed, keyboard_protocol->keys_pressed,
  1007. sizeof(applespi->last_keys_pressed));
  1008. }
  1009. static const struct applespi_tp_info *applespi_find_touchpad_info(u8 model)
  1010. {
  1011. const struct applespi_tp_model_info *info;
  1012. for (info = applespi_tp_models; info->model; info++) {
  1013. if (info->model == model)
  1014. return &info->tp_info;
  1015. }
  1016. return NULL;
  1017. }
  1018. static int
  1019. applespi_register_touchpad_device(struct applespi_data *applespi,
  1020. struct touchpad_info_protocol *rcvd_tp_info)
  1021. {
  1022. const struct applespi_tp_info *tp_info;
  1023. struct input_dev *touchpad_input_dev;
  1024. int sts;
  1025. /* set up touchpad dimensions */
  1026. tp_info = applespi_find_touchpad_info(rcvd_tp_info->model_no);
  1027. if (!tp_info) {
  1028. dev_warn(&applespi->spi->dev,
  1029. "Unknown touchpad model %x - falling back to MB8 touchpad\n",
  1030. rcvd_tp_info->model_no);
  1031. tp_info = &applespi_tp_models[0].tp_info;
  1032. }
  1033. applespi->tp_info = *tp_info;
  1034. if (touchpad_dimensions[0]) {
  1035. int x, y, w, h;
  1036. sts = sscanf(touchpad_dimensions, "%dx%d+%u+%u", &x, &y, &w, &h);
  1037. if (sts == 4) {
  1038. dev_info(&applespi->spi->dev,
  1039. "Overriding touchpad dimensions from module param\n");
  1040. applespi->tp_info.x_min = x;
  1041. applespi->tp_info.y_min = y;
  1042. applespi->tp_info.x_max = x + w;
  1043. applespi->tp_info.y_max = y + h;
  1044. } else {
  1045. dev_warn(&applespi->spi->dev,
  1046. "Invalid touchpad dimensions '%s': must be in the form XxY+W+H\n",
  1047. touchpad_dimensions);
  1048. touchpad_dimensions[0] = '\0';
  1049. }
  1050. }
  1051. if (!touchpad_dimensions[0]) {
  1052. snprintf(touchpad_dimensions, sizeof(touchpad_dimensions),
  1053. "%dx%d+%u+%u",
  1054. applespi->tp_info.x_min,
  1055. applespi->tp_info.y_min,
  1056. applespi->tp_info.x_max - applespi->tp_info.x_min,
  1057. applespi->tp_info.y_max - applespi->tp_info.y_min);
  1058. }
  1059. /* create touchpad input device */
  1060. touchpad_input_dev = devm_input_allocate_device(&applespi->spi->dev);
  1061. if (!touchpad_input_dev) {
  1062. dev_err(&applespi->spi->dev,
  1063. "Failed to allocate touchpad input device\n");
  1064. return -ENOMEM;
  1065. }
  1066. touchpad_input_dev->name = "Apple SPI Touchpad";
  1067. touchpad_input_dev->phys = "applespi/input1";
  1068. touchpad_input_dev->dev.parent = &applespi->spi->dev;
  1069. touchpad_input_dev->id.bustype = BUS_SPI;
  1070. touchpad_input_dev->id.vendor = SYNAPTICS_VENDOR_ID;
  1071. touchpad_input_dev->id.product =
  1072. rcvd_tp_info->model_no << 8 | rcvd_tp_info->model_flags;
  1073. /* basic properties */
  1074. input_set_capability(touchpad_input_dev, EV_REL, REL_X);
  1075. input_set_capability(touchpad_input_dev, EV_REL, REL_Y);
  1076. __set_bit(INPUT_PROP_POINTER, touchpad_input_dev->propbit);
  1077. __set_bit(INPUT_PROP_BUTTONPAD, touchpad_input_dev->propbit);
  1078. /* finger touch area */
  1079. input_set_abs_params(touchpad_input_dev, ABS_MT_TOUCH_MAJOR,
  1080. 0, 5000, 0, 0);
  1081. input_set_abs_params(touchpad_input_dev, ABS_MT_TOUCH_MINOR,
  1082. 0, 5000, 0, 0);
  1083. /* finger approach area */
  1084. input_set_abs_params(touchpad_input_dev, ABS_MT_WIDTH_MAJOR,
  1085. 0, 5000, 0, 0);
  1086. input_set_abs_params(touchpad_input_dev, ABS_MT_WIDTH_MINOR,
  1087. 0, 5000, 0, 0);
  1088. /* finger orientation */
  1089. input_set_abs_params(touchpad_input_dev, ABS_MT_ORIENTATION,
  1090. -MAX_FINGER_ORIENTATION, MAX_FINGER_ORIENTATION,
  1091. 0, 0);
  1092. /* finger position */
  1093. input_set_abs_params(touchpad_input_dev, ABS_MT_POSITION_X,
  1094. applespi->tp_info.x_min, applespi->tp_info.x_max,
  1095. 0, 0);
  1096. input_set_abs_params(touchpad_input_dev, ABS_MT_POSITION_Y,
  1097. applespi->tp_info.y_min, applespi->tp_info.y_max,
  1098. 0, 0);
  1099. /* touchpad button */
  1100. input_set_capability(touchpad_input_dev, EV_KEY, BTN_LEFT);
  1101. /* multitouch */
  1102. sts = input_mt_init_slots(touchpad_input_dev, MAX_FINGERS,
  1103. INPUT_MT_POINTER | INPUT_MT_DROP_UNUSED |
  1104. INPUT_MT_TRACK);
  1105. if (sts) {
  1106. dev_err(&applespi->spi->dev,
  1107. "failed to initialize slots: %d", sts);
  1108. return sts;
  1109. }
  1110. /* register input device */
  1111. sts = input_register_device(touchpad_input_dev);
  1112. if (sts) {
  1113. dev_err(&applespi->spi->dev,
  1114. "Unable to register touchpad input device (%d)\n", sts);
  1115. return sts;
  1116. }
  1117. /* touchpad_input_dev is read async in spi callback */
  1118. smp_store_release(&applespi->touchpad_input_dev, touchpad_input_dev);
  1119. return 0;
  1120. }
  1121. static void applespi_worker(struct work_struct *work)
  1122. {
  1123. struct applespi_data *applespi =
  1124. container_of(work, struct applespi_data, work);
  1125. applespi_register_touchpad_device(applespi, &applespi->rcvd_tp_info);
  1126. }
  1127. static void applespi_handle_cmd_response(struct applespi_data *applespi,
  1128. struct spi_packet *packet,
  1129. struct message *message)
  1130. {
  1131. if (packet->device == PACKET_DEV_INFO &&
  1132. le16_to_cpu(message->type) == 0x1020) {
  1133. /*
  1134. * We're not allowed to sleep here, but registering an input
  1135. * device can sleep.
  1136. */
  1137. applespi->rcvd_tp_info = message->tp_info;
  1138. schedule_work(&applespi->work);
  1139. return;
  1140. }
  1141. if (le16_to_cpu(message->length) != 0x0000) {
  1142. dev_warn_ratelimited(&applespi->spi->dev,
  1143. "Received unexpected write response: length=%x\n",
  1144. le16_to_cpu(message->length));
  1145. return;
  1146. }
  1147. if (packet->device == PACKET_DEV_TPAD &&
  1148. le16_to_cpu(message->type) == 0x0252 &&
  1149. le16_to_cpu(message->rsp_buf_len) == 0x0002)
  1150. dev_info(&applespi->spi->dev, "modeswitch done.\n");
  1151. }
  1152. static bool applespi_verify_crc(struct applespi_data *applespi, u8 *buffer,
  1153. size_t buflen)
  1154. {
  1155. u16 crc;
  1156. crc = crc16(0, buffer, buflen);
  1157. if (crc) {
  1158. dev_warn_ratelimited(&applespi->spi->dev,
  1159. "Received corrupted packet (crc mismatch)\n");
  1160. trace_applespi_bad_crc(ET_RD_CRC, READ, buffer, buflen);
  1161. return false;
  1162. }
  1163. return true;
  1164. }
  1165. static void applespi_debug_print_read_packet(struct applespi_data *applespi,
  1166. struct spi_packet *packet)
  1167. {
  1168. unsigned int evt_type;
  1169. if (packet->flags == PACKET_TYPE_READ &&
  1170. packet->device == PACKET_DEV_KEYB)
  1171. evt_type = ET_RD_KEYB;
  1172. else if (packet->flags == PACKET_TYPE_READ &&
  1173. packet->device == PACKET_DEV_TPAD)
  1174. evt_type = ET_RD_TPAD;
  1175. else if (packet->flags == PACKET_TYPE_WRITE)
  1176. evt_type = applespi->cmd_evt_type;
  1177. else
  1178. evt_type = ET_RD_UNKN;
  1179. applespi_get_trace_fun(evt_type)(evt_type, PT_READ, applespi->rx_buffer,
  1180. APPLESPI_PACKET_SIZE);
  1181. }
  1182. static void applespi_got_data(struct applespi_data *applespi)
  1183. {
  1184. struct spi_packet *packet;
  1185. struct message *message;
  1186. unsigned int msg_len;
  1187. unsigned int off;
  1188. unsigned int rem;
  1189. unsigned int len;
  1190. /* process packet header */
  1191. if (!applespi_verify_crc(applespi, applespi->rx_buffer,
  1192. APPLESPI_PACKET_SIZE)) {
  1193. unsigned long flags;
  1194. spin_lock_irqsave(&applespi->cmd_msg_lock, flags);
  1195. if (applespi->drain) {
  1196. applespi->read_active = false;
  1197. applespi->write_active = false;
  1198. wake_up_all(&applespi->drain_complete);
  1199. }
  1200. spin_unlock_irqrestore(&applespi->cmd_msg_lock, flags);
  1201. return;
  1202. }
  1203. packet = (struct spi_packet *)applespi->rx_buffer;
  1204. applespi_debug_print_read_packet(applespi, packet);
  1205. off = le16_to_cpu(packet->offset);
  1206. rem = le16_to_cpu(packet->remaining);
  1207. len = le16_to_cpu(packet->length);
  1208. if (len > sizeof(packet->data)) {
  1209. dev_warn_ratelimited(&applespi->spi->dev,
  1210. "Received corrupted packet (invalid packet length %u)\n",
  1211. len);
  1212. goto msg_complete;
  1213. }
  1214. /* handle multi-packet messages */
  1215. if (rem > 0 || off > 0) {
  1216. if (off != applespi->saved_msg_len) {
  1217. dev_warn_ratelimited(&applespi->spi->dev,
  1218. "Received unexpected offset (got %u, expected %u)\n",
  1219. off, applespi->saved_msg_len);
  1220. goto msg_complete;
  1221. }
  1222. if (off + rem > MAX_PKTS_PER_MSG * APPLESPI_PACKET_SIZE) {
  1223. dev_warn_ratelimited(&applespi->spi->dev,
  1224. "Received message too large (size %u)\n",
  1225. off + rem);
  1226. goto msg_complete;
  1227. }
  1228. if (off + len > MAX_PKTS_PER_MSG * APPLESPI_PACKET_SIZE) {
  1229. dev_warn_ratelimited(&applespi->spi->dev,
  1230. "Received message too large (size %u)\n",
  1231. off + len);
  1232. goto msg_complete;
  1233. }
  1234. memcpy(applespi->msg_buf + off, &packet->data, len);
  1235. applespi->saved_msg_len += len;
  1236. if (rem > 0)
  1237. return;
  1238. message = (struct message *)applespi->msg_buf;
  1239. msg_len = applespi->saved_msg_len;
  1240. } else {
  1241. message = (struct message *)&packet->data;
  1242. msg_len = len;
  1243. }
  1244. /* got complete message - verify */
  1245. if (!applespi_verify_crc(applespi, (u8 *)message, msg_len))
  1246. goto msg_complete;
  1247. if (le16_to_cpu(message->length) != msg_len - MSG_HEADER_SIZE - 2) {
  1248. dev_warn_ratelimited(&applespi->spi->dev,
  1249. "Received corrupted packet (invalid message length %u - expected %u)\n",
  1250. le16_to_cpu(message->length),
  1251. msg_len - MSG_HEADER_SIZE - 2);
  1252. goto msg_complete;
  1253. }
  1254. /* handle message */
  1255. if (packet->flags == PACKET_TYPE_READ &&
  1256. packet->device == PACKET_DEV_KEYB) {
  1257. applespi_handle_keyboard_event(applespi, &message->keyboard);
  1258. } else if (packet->flags == PACKET_TYPE_READ &&
  1259. packet->device == PACKET_DEV_TPAD) {
  1260. struct touchpad_protocol *tp;
  1261. size_t tp_len;
  1262. tp = &message->touchpad;
  1263. tp_len = struct_size(tp, fingers, tp->number_of_fingers);
  1264. if (le16_to_cpu(message->length) + 2 != tp_len) {
  1265. dev_warn_ratelimited(&applespi->spi->dev,
  1266. "Received corrupted packet (invalid message length %u - num-fingers %u, tp-len %zu)\n",
  1267. le16_to_cpu(message->length),
  1268. tp->number_of_fingers, tp_len);
  1269. goto msg_complete;
  1270. }
  1271. if (tp->number_of_fingers > MAX_FINGERS) {
  1272. dev_warn_ratelimited(&applespi->spi->dev,
  1273. "Number of reported fingers (%u) exceeds max (%u))\n",
  1274. tp->number_of_fingers,
  1275. MAX_FINGERS);
  1276. tp->number_of_fingers = MAX_FINGERS;
  1277. }
  1278. report_tp_state(applespi, tp);
  1279. } else if (packet->flags == PACKET_TYPE_WRITE) {
  1280. applespi_handle_cmd_response(applespi, packet, message);
  1281. }
  1282. msg_complete:
  1283. applespi->saved_msg_len = 0;
  1284. applespi_msg_complete(applespi, packet->flags == PACKET_TYPE_WRITE,
  1285. true);
  1286. }
  1287. static void applespi_async_read_complete(void *context)
  1288. {
  1289. struct applespi_data *applespi = context;
  1290. if (applespi->rd_m.status < 0) {
  1291. dev_warn(&applespi->spi->dev, "Error reading from device: %d\n",
  1292. applespi->rd_m.status);
  1293. /*
  1294. * We don't actually know if this was a pure read, or a response
  1295. * to a write. But this is a rare error condition that should
  1296. * never occur, so clearing both flags to avoid deadlock.
  1297. */
  1298. applespi_msg_complete(applespi, true, true);
  1299. } else {
  1300. applespi_got_data(applespi);
  1301. }
  1302. acpi_finish_gpe(NULL, applespi->gpe);
  1303. }
  1304. static u32 applespi_notify(acpi_handle gpe_device, u32 gpe, void *context)
  1305. {
  1306. struct applespi_data *applespi = context;
  1307. int sts;
  1308. unsigned long flags;
  1309. trace_applespi_irq_received(ET_RD_IRQ, PT_READ);
  1310. spin_lock_irqsave(&applespi->cmd_msg_lock, flags);
  1311. if (!applespi->suspended) {
  1312. sts = applespi_async(applespi, &applespi->rd_m,
  1313. applespi_async_read_complete);
  1314. if (sts)
  1315. dev_warn(&applespi->spi->dev,
  1316. "Error queueing async read to device: %d\n",
  1317. sts);
  1318. else
  1319. applespi->read_active = true;
  1320. }
  1321. spin_unlock_irqrestore(&applespi->cmd_msg_lock, flags);
  1322. return ACPI_INTERRUPT_HANDLED;
  1323. }
  1324. static int applespi_get_saved_bl_level(struct applespi_data *applespi)
  1325. {
  1326. struct efivar_entry *efivar_entry;
  1327. u16 efi_data = 0;
  1328. unsigned long efi_data_len;
  1329. int sts;
  1330. efivar_entry = kmalloc(sizeof(*efivar_entry), GFP_KERNEL);
  1331. if (!efivar_entry)
  1332. return -ENOMEM;
  1333. memcpy(efivar_entry->var.VariableName, EFI_BL_LEVEL_NAME,
  1334. sizeof(EFI_BL_LEVEL_NAME));
  1335. efivar_entry->var.VendorGuid = EFI_BL_LEVEL_GUID;
  1336. efi_data_len = sizeof(efi_data);
  1337. sts = efivar_entry_get(efivar_entry, NULL, &efi_data_len, &efi_data);
  1338. if (sts && sts != -ENOENT)
  1339. dev_warn(&applespi->spi->dev,
  1340. "Error getting backlight level from EFI vars: %d\n",
  1341. sts);
  1342. kfree(efivar_entry);
  1343. return sts ? sts : efi_data;
  1344. }
  1345. static void applespi_save_bl_level(struct applespi_data *applespi,
  1346. unsigned int level)
  1347. {
  1348. efi_guid_t efi_guid;
  1349. u32 efi_attr;
  1350. unsigned long efi_data_len;
  1351. u16 efi_data;
  1352. int sts;
  1353. /* Save keyboard backlight level */
  1354. efi_guid = EFI_BL_LEVEL_GUID;
  1355. efi_data = (u16)level;
  1356. efi_data_len = sizeof(efi_data);
  1357. efi_attr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS |
  1358. EFI_VARIABLE_RUNTIME_ACCESS;
  1359. sts = efivar_entry_set_safe((efi_char16_t *)EFI_BL_LEVEL_NAME, efi_guid,
  1360. efi_attr, true, efi_data_len, &efi_data);
  1361. if (sts)
  1362. dev_warn(&applespi->spi->dev,
  1363. "Error saving backlight level to EFI vars: %d\n", sts);
  1364. }
  1365. static int applespi_probe(struct spi_device *spi)
  1366. {
  1367. struct applespi_data *applespi;
  1368. acpi_handle spi_handle = ACPI_HANDLE(&spi->dev);
  1369. acpi_status acpi_sts;
  1370. int sts, i;
  1371. unsigned long long gpe, usb_status;
  1372. /* check if the USB interface is present and enabled already */
  1373. acpi_sts = acpi_evaluate_integer(spi_handle, "UIST", NULL, &usb_status);
  1374. if (ACPI_SUCCESS(acpi_sts) && usb_status) {
  1375. /* let the USB driver take over instead */
  1376. dev_info(&spi->dev, "USB interface already enabled\n");
  1377. return -ENODEV;
  1378. }
  1379. /* allocate driver data */
  1380. applespi = devm_kzalloc(&spi->dev, sizeof(*applespi), GFP_KERNEL);
  1381. if (!applespi)
  1382. return -ENOMEM;
  1383. applespi->spi = spi;
  1384. INIT_WORK(&applespi->work, applespi_worker);
  1385. /* store the driver data */
  1386. spi_set_drvdata(spi, applespi);
  1387. /* create our buffers */
  1388. applespi->tx_buffer = devm_kmalloc(&spi->dev, APPLESPI_PACKET_SIZE,
  1389. GFP_KERNEL);
  1390. applespi->tx_status = devm_kmalloc(&spi->dev, APPLESPI_STATUS_SIZE,
  1391. GFP_KERNEL);
  1392. applespi->rx_buffer = devm_kmalloc(&spi->dev, APPLESPI_PACKET_SIZE,
  1393. GFP_KERNEL);
  1394. applespi->msg_buf = devm_kmalloc_array(&spi->dev, MAX_PKTS_PER_MSG,
  1395. APPLESPI_PACKET_SIZE,
  1396. GFP_KERNEL);
  1397. if (!applespi->tx_buffer || !applespi->tx_status ||
  1398. !applespi->rx_buffer || !applespi->msg_buf)
  1399. return -ENOMEM;
  1400. /* set up our spi messages */
  1401. applespi_setup_read_txfrs(applespi);
  1402. applespi_setup_write_txfrs(applespi);
  1403. /* cache ACPI method handles */
  1404. acpi_sts = acpi_get_handle(spi_handle, "SIEN", &applespi->sien);
  1405. if (ACPI_FAILURE(acpi_sts)) {
  1406. dev_err(&applespi->spi->dev,
  1407. "Failed to get SIEN ACPI method handle: %s\n",
  1408. acpi_format_exception(acpi_sts));
  1409. return -ENODEV;
  1410. }
  1411. acpi_sts = acpi_get_handle(spi_handle, "SIST", &applespi->sist);
  1412. if (ACPI_FAILURE(acpi_sts)) {
  1413. dev_err(&applespi->spi->dev,
  1414. "Failed to get SIST ACPI method handle: %s\n",
  1415. acpi_format_exception(acpi_sts));
  1416. return -ENODEV;
  1417. }
  1418. /* switch on the SPI interface */
  1419. sts = applespi_setup_spi(applespi);
  1420. if (sts)
  1421. return sts;
  1422. sts = applespi_enable_spi(applespi);
  1423. if (sts)
  1424. return sts;
  1425. /* setup the keyboard input dev */
  1426. applespi->keyboard_input_dev = devm_input_allocate_device(&spi->dev);
  1427. if (!applespi->keyboard_input_dev)
  1428. return -ENOMEM;
  1429. applespi->keyboard_input_dev->name = "Apple SPI Keyboard";
  1430. applespi->keyboard_input_dev->phys = "applespi/input0";
  1431. applespi->keyboard_input_dev->dev.parent = &spi->dev;
  1432. applespi->keyboard_input_dev->id.bustype = BUS_SPI;
  1433. applespi->keyboard_input_dev->evbit[0] =
  1434. BIT_MASK(EV_KEY) | BIT_MASK(EV_LED) | BIT_MASK(EV_REP);
  1435. applespi->keyboard_input_dev->ledbit[0] = BIT_MASK(LED_CAPSL);
  1436. input_set_drvdata(applespi->keyboard_input_dev, applespi);
  1437. applespi->keyboard_input_dev->event = applespi_event;
  1438. for (i = 0; i < ARRAY_SIZE(applespi_scancodes); i++)
  1439. if (applespi_scancodes[i])
  1440. input_set_capability(applespi->keyboard_input_dev,
  1441. EV_KEY, applespi_scancodes[i]);
  1442. for (i = 0; i < ARRAY_SIZE(applespi_controlcodes); i++)
  1443. if (applespi_controlcodes[i])
  1444. input_set_capability(applespi->keyboard_input_dev,
  1445. EV_KEY, applespi_controlcodes[i]);
  1446. for (i = 0; i < ARRAY_SIZE(applespi_fn_codes); i++)
  1447. if (applespi_fn_codes[i].to)
  1448. input_set_capability(applespi->keyboard_input_dev,
  1449. EV_KEY, applespi_fn_codes[i].to);
  1450. input_set_capability(applespi->keyboard_input_dev, EV_KEY, KEY_FN);
  1451. sts = input_register_device(applespi->keyboard_input_dev);
  1452. if (sts) {
  1453. dev_err(&applespi->spi->dev,
  1454. "Unable to register keyboard input device (%d)\n", sts);
  1455. return -ENODEV;
  1456. }
  1457. /*
  1458. * The applespi device doesn't send interrupts normally (as is described
  1459. * in its DSDT), but rather seems to use ACPI GPEs.
  1460. */
  1461. acpi_sts = acpi_evaluate_integer(spi_handle, "_GPE", NULL, &gpe);
  1462. if (ACPI_FAILURE(acpi_sts)) {
  1463. dev_err(&applespi->spi->dev,
  1464. "Failed to obtain GPE for SPI slave device: %s\n",
  1465. acpi_format_exception(acpi_sts));
  1466. return -ENODEV;
  1467. }
  1468. applespi->gpe = (int)gpe;
  1469. acpi_sts = acpi_install_gpe_handler(NULL, applespi->gpe,
  1470. ACPI_GPE_LEVEL_TRIGGERED,
  1471. applespi_notify, applespi);
  1472. if (ACPI_FAILURE(acpi_sts)) {
  1473. dev_err(&applespi->spi->dev,
  1474. "Failed to install GPE handler for GPE %d: %s\n",
  1475. applespi->gpe, acpi_format_exception(acpi_sts));
  1476. return -ENODEV;
  1477. }
  1478. applespi->suspended = false;
  1479. acpi_sts = acpi_enable_gpe(NULL, applespi->gpe);
  1480. if (ACPI_FAILURE(acpi_sts)) {
  1481. dev_err(&applespi->spi->dev,
  1482. "Failed to enable GPE handler for GPE %d: %s\n",
  1483. applespi->gpe, acpi_format_exception(acpi_sts));
  1484. acpi_remove_gpe_handler(NULL, applespi->gpe, applespi_notify);
  1485. return -ENODEV;
  1486. }
  1487. /* trigger touchpad setup */
  1488. applespi_init(applespi, false);
  1489. /*
  1490. * By default this device is not enabled for wakeup; but USB keyboards
  1491. * generally are, so the expectation is that by default the keyboard
  1492. * will wake the system.
  1493. */
  1494. device_wakeup_enable(&spi->dev);
  1495. /* set up keyboard-backlight */
  1496. sts = applespi_get_saved_bl_level(applespi);
  1497. if (sts >= 0)
  1498. applespi_set_bl_level(&applespi->backlight_info, sts);
  1499. applespi->backlight_info.name = "spi::kbd_backlight";
  1500. applespi->backlight_info.default_trigger = "kbd-backlight";
  1501. applespi->backlight_info.brightness_set = applespi_set_bl_level;
  1502. sts = devm_led_classdev_register(&spi->dev, &applespi->backlight_info);
  1503. if (sts)
  1504. dev_warn(&applespi->spi->dev,
  1505. "Unable to register keyboard backlight class dev (%d)\n",
  1506. sts);
  1507. /* set up debugfs entries for touchpad dimensions logging */
  1508. applespi->debugfs_root = debugfs_create_dir("applespi", NULL);
  1509. debugfs_create_bool("enable_tp_dim", 0600, applespi->debugfs_root,
  1510. &applespi->debug_tp_dim);
  1511. debugfs_create_file("tp_dim", 0400, applespi->debugfs_root, applespi,
  1512. &applespi_tp_dim_fops);
  1513. return 0;
  1514. }
  1515. static void applespi_drain_writes(struct applespi_data *applespi)
  1516. {
  1517. unsigned long flags;
  1518. spin_lock_irqsave(&applespi->cmd_msg_lock, flags);
  1519. applespi->drain = true;
  1520. wait_event_lock_irq(applespi->drain_complete, !applespi->write_active,
  1521. applespi->cmd_msg_lock);
  1522. spin_unlock_irqrestore(&applespi->cmd_msg_lock, flags);
  1523. }
  1524. static void applespi_drain_reads(struct applespi_data *applespi)
  1525. {
  1526. unsigned long flags;
  1527. spin_lock_irqsave(&applespi->cmd_msg_lock, flags);
  1528. wait_event_lock_irq(applespi->drain_complete, !applespi->read_active,
  1529. applespi->cmd_msg_lock);
  1530. applespi->suspended = true;
  1531. spin_unlock_irqrestore(&applespi->cmd_msg_lock, flags);
  1532. }
  1533. static int applespi_remove(struct spi_device *spi)
  1534. {
  1535. struct applespi_data *applespi = spi_get_drvdata(spi);
  1536. applespi_drain_writes(applespi);
  1537. acpi_disable_gpe(NULL, applespi->gpe);
  1538. acpi_remove_gpe_handler(NULL, applespi->gpe, applespi_notify);
  1539. device_wakeup_disable(&spi->dev);
  1540. applespi_drain_reads(applespi);
  1541. debugfs_remove_recursive(applespi->debugfs_root);
  1542. return 0;
  1543. }
  1544. static void applespi_shutdown(struct spi_device *spi)
  1545. {
  1546. struct applespi_data *applespi = spi_get_drvdata(spi);
  1547. applespi_save_bl_level(applespi, applespi->have_bl_level);
  1548. }
  1549. static int applespi_poweroff_late(struct device *dev)
  1550. {
  1551. struct spi_device *spi = to_spi_device(dev);
  1552. struct applespi_data *applespi = spi_get_drvdata(spi);
  1553. applespi_save_bl_level(applespi, applespi->have_bl_level);
  1554. return 0;
  1555. }
  1556. static int __maybe_unused applespi_suspend(struct device *dev)
  1557. {
  1558. struct spi_device *spi = to_spi_device(dev);
  1559. struct applespi_data *applespi = spi_get_drvdata(spi);
  1560. acpi_status acpi_sts;
  1561. int sts;
  1562. /* turn off caps-lock - it'll stay on otherwise */
  1563. sts = applespi_set_capsl_led(applespi, false);
  1564. if (sts)
  1565. dev_warn(&applespi->spi->dev,
  1566. "Failed to turn off caps-lock led (%d)\n", sts);
  1567. applespi_drain_writes(applespi);
  1568. /* disable the interrupt */
  1569. acpi_sts = acpi_disable_gpe(NULL, applespi->gpe);
  1570. if (ACPI_FAILURE(acpi_sts))
  1571. dev_err(&applespi->spi->dev,
  1572. "Failed to disable GPE handler for GPE %d: %s\n",
  1573. applespi->gpe, acpi_format_exception(acpi_sts));
  1574. applespi_drain_reads(applespi);
  1575. return 0;
  1576. }
  1577. static int __maybe_unused applespi_resume(struct device *dev)
  1578. {
  1579. struct spi_device *spi = to_spi_device(dev);
  1580. struct applespi_data *applespi = spi_get_drvdata(spi);
  1581. acpi_status acpi_sts;
  1582. unsigned long flags;
  1583. /* ensure our flags and state reflect a newly resumed device */
  1584. spin_lock_irqsave(&applespi->cmd_msg_lock, flags);
  1585. applespi->drain = false;
  1586. applespi->have_cl_led_on = false;
  1587. applespi->have_bl_level = 0;
  1588. applespi->cmd_msg_queued = 0;
  1589. applespi->read_active = false;
  1590. applespi->write_active = false;
  1591. applespi->suspended = false;
  1592. spin_unlock_irqrestore(&applespi->cmd_msg_lock, flags);
  1593. /* switch on the SPI interface */
  1594. applespi_enable_spi(applespi);
  1595. /* re-enable the interrupt */
  1596. acpi_sts = acpi_enable_gpe(NULL, applespi->gpe);
  1597. if (ACPI_FAILURE(acpi_sts))
  1598. dev_err(&applespi->spi->dev,
  1599. "Failed to re-enable GPE handler for GPE %d: %s\n",
  1600. applespi->gpe, acpi_format_exception(acpi_sts));
  1601. /* switch the touchpad into multitouch mode */
  1602. applespi_init(applespi, true);
  1603. return 0;
  1604. }
  1605. static const struct acpi_device_id applespi_acpi_match[] = {
  1606. { "APP000D", 0 },
  1607. { }
  1608. };
  1609. MODULE_DEVICE_TABLE(acpi, applespi_acpi_match);
  1610. static const struct dev_pm_ops applespi_pm_ops = {
  1611. SET_SYSTEM_SLEEP_PM_OPS(applespi_suspend, applespi_resume)
  1612. .poweroff_late = applespi_poweroff_late,
  1613. };
  1614. static struct spi_driver applespi_driver = {
  1615. .driver = {
  1616. .name = "applespi",
  1617. .acpi_match_table = applespi_acpi_match,
  1618. .pm = &applespi_pm_ops,
  1619. },
  1620. .probe = applespi_probe,
  1621. .remove = applespi_remove,
  1622. .shutdown = applespi_shutdown,
  1623. };
  1624. module_spi_driver(applespi_driver)
  1625. MODULE_LICENSE("GPL v2");
  1626. MODULE_DESCRIPTION("MacBook(Pro) SPI Keyboard/Touchpad driver");
  1627. MODULE_AUTHOR("Federico Lorenzi");
  1628. MODULE_AUTHOR("Ronald Tschalär");