1
2
3
4
5
6
7
8
9
10
11
12
13
14#include <linux/acpi.h>
15#include <linux/dmi.h>
16#include <linux/delay.h>
17#include <linux/io.h>
18#include <linux/interrupt.h>
19#include <linux/mfd/cros_ec.h>
20#include <linux/mfd/cros_ec_commands.h>
21#include <linux/module.h>
22#include <linux/platform_device.h>
23#include <linux/printk.h>
24#include <linux/suspend.h>
25
26#include "cros_ec_lpc_mec.h"
27
28#define DRV_NAME "cros_ec_lpcs"
29#define ACPI_DRV_NAME "GOOG0004"
30
31
32static bool cros_ec_lpc_acpi_device_found;
33
34
35
36
37
38
39
40
41struct lpc_driver_ops {
42 u8 (*read)(unsigned int offset, unsigned int length, u8 *dest);
43 u8 (*write)(unsigned int offset, unsigned int length, const u8 *msg);
44};
45
46static struct lpc_driver_ops cros_ec_lpc_ops = { };
47
48
49
50
51
52static u8 cros_ec_lpc_read_bytes(unsigned int offset, unsigned int length,
53 u8 *dest)
54{
55 int sum = 0;
56 int i;
57
58 for (i = 0; i < length; ++i) {
59 dest[i] = inb(offset + i);
60 sum += dest[i];
61 }
62
63
64 return sum;
65}
66
67
68
69
70
71static u8 cros_ec_lpc_write_bytes(unsigned int offset, unsigned int length,
72 const u8 *msg)
73{
74 int sum = 0;
75 int i;
76
77 for (i = 0; i < length; ++i) {
78 outb(msg[i], offset + i);
79 sum += msg[i];
80 }
81
82
83 return sum;
84}
85
86
87
88
89
90static u8 cros_ec_lpc_mec_read_bytes(unsigned int offset, unsigned int length,
91 u8 *dest)
92{
93 int in_range = cros_ec_lpc_mec_in_range(offset, length);
94
95 if (in_range < 0)
96 return 0;
97
98 return in_range ?
99 cros_ec_lpc_io_bytes_mec(MEC_IO_READ,
100 offset - EC_HOST_CMD_REGION0,
101 length, dest) :
102 cros_ec_lpc_read_bytes(offset, length, dest);
103}
104
105
106
107
108
109static u8 cros_ec_lpc_mec_write_bytes(unsigned int offset, unsigned int length,
110 const u8 *msg)
111{
112 int in_range = cros_ec_lpc_mec_in_range(offset, length);
113
114 if (in_range < 0)
115 return 0;
116
117 return in_range ?
118 cros_ec_lpc_io_bytes_mec(MEC_IO_WRITE,
119 offset - EC_HOST_CMD_REGION0,
120 length, (u8 *)msg) :
121 cros_ec_lpc_write_bytes(offset, length, msg);
122}
123
124static int ec_response_timed_out(void)
125{
126 unsigned long one_second = jiffies + HZ;
127 u8 data;
128
129 usleep_range(200, 300);
130 do {
131 if (!(cros_ec_lpc_ops.read(EC_LPC_ADDR_HOST_CMD, 1, &data) &
132 EC_LPC_STATUS_BUSY_MASK))
133 return 0;
134 usleep_range(100, 200);
135 } while (time_before(jiffies, one_second));
136
137 return 1;
138}
139
140static int cros_ec_pkt_xfer_lpc(struct cros_ec_device *ec,
141 struct cros_ec_command *msg)
142{
143 struct ec_host_response response;
144 u8 sum;
145 int ret = 0;
146 u8 *dout;
147
148 ret = cros_ec_prepare_tx(ec, msg);
149
150
151 cros_ec_lpc_ops.write(EC_LPC_ADDR_HOST_PACKET, ret, ec->dout);
152
153
154 sum = EC_COMMAND_PROTOCOL_3;
155 cros_ec_lpc_ops.write(EC_LPC_ADDR_HOST_CMD, 1, &sum);
156
157 if (ec_response_timed_out()) {
158 dev_warn(ec->dev, "EC responsed timed out\n");
159 ret = -EIO;
160 goto done;
161 }
162
163
164 msg->result = cros_ec_lpc_ops.read(EC_LPC_ADDR_HOST_DATA, 1, &sum);
165 ret = cros_ec_check_result(ec, msg);
166 if (ret)
167 goto done;
168
169
170 dout = (u8 *)&response;
171 sum = cros_ec_lpc_ops.read(EC_LPC_ADDR_HOST_PACKET, sizeof(response),
172 dout);
173
174 msg->result = response.result;
175
176 if (response.data_len > msg->insize) {
177 dev_err(ec->dev,
178 "packet too long (%d bytes, expected %d)",
179 response.data_len, msg->insize);
180 ret = -EMSGSIZE;
181 goto done;
182 }
183
184
185 sum += cros_ec_lpc_ops.read(EC_LPC_ADDR_HOST_PACKET +
186 sizeof(response), response.data_len,
187 msg->data);
188
189 if (sum) {
190 dev_err(ec->dev,
191 "bad packet checksum %02x\n",
192 response.checksum);
193 ret = -EBADMSG;
194 goto done;
195 }
196
197
198 ret = response.data_len;
199done:
200 return ret;
201}
202
203static int cros_ec_cmd_xfer_lpc(struct cros_ec_device *ec,
204 struct cros_ec_command *msg)
205{
206 struct ec_lpc_host_args args;
207 u8 sum;
208 int ret = 0;
209
210 if (msg->outsize > EC_PROTO2_MAX_PARAM_SIZE ||
211 msg->insize > EC_PROTO2_MAX_PARAM_SIZE) {
212 dev_err(ec->dev,
213 "invalid buffer sizes (out %d, in %d)\n",
214 msg->outsize, msg->insize);
215 return -EINVAL;
216 }
217
218
219 args.flags = EC_HOST_ARGS_FLAG_FROM_HOST;
220 args.command_version = msg->version;
221 args.data_size = msg->outsize;
222
223
224 sum = msg->command + args.flags + args.command_version + args.data_size;
225
226
227 sum += cros_ec_lpc_ops.write(EC_LPC_ADDR_HOST_PARAM, msg->outsize,
228 msg->data);
229
230
231 args.checksum = sum;
232 cros_ec_lpc_ops.write(EC_LPC_ADDR_HOST_ARGS, sizeof(args),
233 (u8 *)&args);
234
235
236 sum = msg->command;
237 cros_ec_lpc_ops.write(EC_LPC_ADDR_HOST_CMD, 1, &sum);
238
239 if (ec_response_timed_out()) {
240 dev_warn(ec->dev, "EC responsed timed out\n");
241 ret = -EIO;
242 goto done;
243 }
244
245
246 msg->result = cros_ec_lpc_ops.read(EC_LPC_ADDR_HOST_DATA, 1, &sum);
247 ret = cros_ec_check_result(ec, msg);
248 if (ret)
249 goto done;
250
251
252 cros_ec_lpc_ops.read(EC_LPC_ADDR_HOST_ARGS, sizeof(args), (u8 *)&args);
253
254 if (args.data_size > msg->insize) {
255 dev_err(ec->dev,
256 "packet too long (%d bytes, expected %d)",
257 args.data_size, msg->insize);
258 ret = -ENOSPC;
259 goto done;
260 }
261
262
263 sum = msg->command + args.flags + args.command_version + args.data_size;
264
265
266 sum += cros_ec_lpc_ops.read(EC_LPC_ADDR_HOST_PARAM, args.data_size,
267 msg->data);
268
269
270 if (args.checksum != sum) {
271 dev_err(ec->dev,
272 "bad packet checksum, expected %02x, got %02x\n",
273 args.checksum, sum);
274 ret = -EBADMSG;
275 goto done;
276 }
277
278
279 ret = args.data_size;
280done:
281 return ret;
282}
283
284
285static int cros_ec_lpc_readmem(struct cros_ec_device *ec, unsigned int offset,
286 unsigned int bytes, void *dest)
287{
288 int i = offset;
289 char *s = dest;
290 int cnt = 0;
291
292 if (offset >= EC_MEMMAP_SIZE - bytes)
293 return -EINVAL;
294
295
296 if (bytes) {
297 cros_ec_lpc_ops.read(EC_LPC_ADDR_MEMMAP + offset, bytes, s);
298 return bytes;
299 }
300
301
302 for (; i < EC_MEMMAP_SIZE; i++, s++) {
303 cros_ec_lpc_ops.read(EC_LPC_ADDR_MEMMAP + i, 1, s);
304 cnt++;
305 if (!*s)
306 break;
307 }
308
309 return cnt;
310}
311
312static void cros_ec_lpc_acpi_notify(acpi_handle device, u32 value, void *data)
313{
314 struct cros_ec_device *ec_dev = data;
315
316 if (ec_dev->mkbp_event_supported &&
317 cros_ec_get_next_event(ec_dev, NULL) > 0)
318 blocking_notifier_call_chain(&ec_dev->event_notifier, 0,
319 ec_dev);
320
321 if (value == ACPI_NOTIFY_DEVICE_WAKE)
322 pm_system_wakeup();
323}
324
325static int cros_ec_lpc_probe(struct platform_device *pdev)
326{
327 struct device *dev = &pdev->dev;
328 struct acpi_device *adev;
329 acpi_status status;
330 struct cros_ec_device *ec_dev;
331 u8 buf[2];
332 int irq, ret;
333
334 if (!devm_request_region(dev, EC_LPC_ADDR_MEMMAP, EC_MEMMAP_SIZE,
335 dev_name(dev))) {
336 dev_err(dev, "couldn't reserve memmap region\n");
337 return -EBUSY;
338 }
339
340
341
342
343
344
345
346 cros_ec_lpc_ops.read = cros_ec_lpc_mec_read_bytes;
347 cros_ec_lpc_ops.write = cros_ec_lpc_mec_write_bytes;
348 cros_ec_lpc_ops.read(EC_LPC_ADDR_MEMMAP + EC_MEMMAP_ID, 2, buf);
349 if (buf[0] != 'E' || buf[1] != 'C') {
350
351 cros_ec_lpc_ops.read = cros_ec_lpc_read_bytes;
352 cros_ec_lpc_ops.write = cros_ec_lpc_write_bytes;
353 cros_ec_lpc_ops.read(EC_LPC_ADDR_MEMMAP + EC_MEMMAP_ID, 2,
354 buf);
355 if (buf[0] != 'E' || buf[1] != 'C') {
356 dev_err(dev, "EC ID not detected\n");
357 return -ENODEV;
358 }
359 }
360
361 if (!devm_request_region(dev, EC_HOST_CMD_REGION0,
362 EC_HOST_CMD_REGION_SIZE, dev_name(dev))) {
363 dev_err(dev, "couldn't reserve region0\n");
364 return -EBUSY;
365 }
366 if (!devm_request_region(dev, EC_HOST_CMD_REGION1,
367 EC_HOST_CMD_REGION_SIZE, dev_name(dev))) {
368 dev_err(dev, "couldn't reserve region1\n");
369 return -EBUSY;
370 }
371
372 ec_dev = devm_kzalloc(dev, sizeof(*ec_dev), GFP_KERNEL);
373 if (!ec_dev)
374 return -ENOMEM;
375
376 platform_set_drvdata(pdev, ec_dev);
377 ec_dev->dev = dev;
378 ec_dev->phys_name = dev_name(dev);
379 ec_dev->cmd_xfer = cros_ec_cmd_xfer_lpc;
380 ec_dev->pkt_xfer = cros_ec_pkt_xfer_lpc;
381 ec_dev->cmd_readmem = cros_ec_lpc_readmem;
382 ec_dev->din_size = sizeof(struct ec_host_response) +
383 sizeof(struct ec_response_get_protocol_info);
384 ec_dev->dout_size = sizeof(struct ec_host_request);
385
386
387
388
389
390 irq = platform_get_irq(pdev, 0);
391 if (irq > 0)
392 ec_dev->irq = irq;
393 else if (irq != -ENXIO) {
394 dev_err(dev, "couldn't retrieve IRQ number (%d)\n", irq);
395 return irq;
396 }
397
398 ret = cros_ec_register(ec_dev);
399 if (ret) {
400 dev_err(dev, "couldn't register ec_dev (%d)\n", ret);
401 return ret;
402 }
403
404
405
406
407
408 adev = ACPI_COMPANION(dev);
409 if (adev) {
410 status = acpi_install_notify_handler(adev->handle,
411 ACPI_ALL_NOTIFY,
412 cros_ec_lpc_acpi_notify,
413 ec_dev);
414 if (ACPI_FAILURE(status))
415 dev_warn(dev, "Failed to register notifier %08x\n",
416 status);
417 }
418
419 return 0;
420}
421
422static int cros_ec_lpc_remove(struct platform_device *pdev)
423{
424 struct acpi_device *adev;
425
426 adev = ACPI_COMPANION(&pdev->dev);
427 if (adev)
428 acpi_remove_notify_handler(adev->handle, ACPI_ALL_NOTIFY,
429 cros_ec_lpc_acpi_notify);
430
431 return 0;
432}
433
434static const struct acpi_device_id cros_ec_lpc_acpi_device_ids[] = {
435 { ACPI_DRV_NAME, 0 },
436 { }
437};
438MODULE_DEVICE_TABLE(acpi, cros_ec_lpc_acpi_device_ids);
439
440static const struct dmi_system_id cros_ec_lpc_dmi_table[] __initconst = {
441 {
442
443
444
445
446
447 .matches = {
448 DMI_MATCH(DMI_BIOS_VENDOR, "coreboot"),
449 DMI_MATCH(DMI_BIOS_VERSION, "Google_"),
450 },
451 },
452 {
453
454
455
456
457
458
459 .matches = {
460 DMI_MATCH(DMI_BIOS_VENDOR, "coreboot"),
461 DMI_MATCH(DMI_SYS_VENDOR, "GOOGLE"),
462 },
463 },
464 {
465
466 .matches = {
467 DMI_MATCH(DMI_SYS_VENDOR, "GOOGLE"),
468 DMI_MATCH(DMI_PRODUCT_NAME, "Link"),
469 },
470 },
471 {
472
473 .matches = {
474 DMI_MATCH(DMI_SYS_VENDOR, "GOOGLE"),
475 DMI_MATCH(DMI_PRODUCT_NAME, "Samus"),
476 },
477 },
478 {
479
480 .matches = {
481 DMI_MATCH(DMI_SYS_VENDOR, "Acer"),
482 DMI_MATCH(DMI_PRODUCT_NAME, "Peppy"),
483 },
484 },
485 {
486
487 .matches = {
488 DMI_MATCH(DMI_SYS_VENDOR, "GOOGLE"),
489 DMI_MATCH(DMI_PRODUCT_NAME, "Glimmer"),
490 },
491 },
492 { }
493};
494MODULE_DEVICE_TABLE(dmi, cros_ec_lpc_dmi_table);
495
496#ifdef CONFIG_PM_SLEEP
497static int cros_ec_lpc_suspend(struct device *dev)
498{
499 struct cros_ec_device *ec_dev = dev_get_drvdata(dev);
500
501 return cros_ec_suspend(ec_dev);
502}
503
504static int cros_ec_lpc_resume(struct device *dev)
505{
506 struct cros_ec_device *ec_dev = dev_get_drvdata(dev);
507
508 return cros_ec_resume(ec_dev);
509}
510#endif
511
512static const struct dev_pm_ops cros_ec_lpc_pm_ops = {
513 SET_LATE_SYSTEM_SLEEP_PM_OPS(cros_ec_lpc_suspend, cros_ec_lpc_resume)
514};
515
516static struct platform_driver cros_ec_lpc_driver = {
517 .driver = {
518 .name = DRV_NAME,
519 .acpi_match_table = cros_ec_lpc_acpi_device_ids,
520 .pm = &cros_ec_lpc_pm_ops,
521 },
522 .probe = cros_ec_lpc_probe,
523 .remove = cros_ec_lpc_remove,
524};
525
526static struct platform_device cros_ec_lpc_device = {
527 .name = DRV_NAME
528};
529
530static acpi_status cros_ec_lpc_parse_device(acpi_handle handle, u32 level,
531 void *context, void **retval)
532{
533 *(bool *)context = true;
534 return AE_CTRL_TERMINATE;
535}
536
537static int __init cros_ec_lpc_init(void)
538{
539 int ret;
540 acpi_status status;
541
542 status = acpi_get_devices(ACPI_DRV_NAME, cros_ec_lpc_parse_device,
543 &cros_ec_lpc_acpi_device_found, NULL);
544 if (ACPI_FAILURE(status))
545 pr_warn(DRV_NAME ": Looking for %s failed\n", ACPI_DRV_NAME);
546
547 if (!cros_ec_lpc_acpi_device_found &&
548 !dmi_check_system(cros_ec_lpc_dmi_table)) {
549 pr_err(DRV_NAME ": unsupported system.\n");
550 return -ENODEV;
551 }
552
553 cros_ec_lpc_mec_init(EC_HOST_CMD_REGION0,
554 EC_LPC_ADDR_MEMMAP + EC_MEMMAP_SIZE);
555
556
557 ret = platform_driver_register(&cros_ec_lpc_driver);
558 if (ret) {
559 pr_err(DRV_NAME ": can't register driver: %d\n", ret);
560 cros_ec_lpc_mec_destroy();
561 return ret;
562 }
563
564 if (!cros_ec_lpc_acpi_device_found) {
565
566 ret = platform_device_register(&cros_ec_lpc_device);
567 if (ret) {
568 pr_err(DRV_NAME ": can't register device: %d\n", ret);
569 platform_driver_unregister(&cros_ec_lpc_driver);
570 cros_ec_lpc_mec_destroy();
571 }
572 }
573
574 return ret;
575}
576
577static void __exit cros_ec_lpc_exit(void)
578{
579 if (!cros_ec_lpc_acpi_device_found)
580 platform_device_unregister(&cros_ec_lpc_device);
581 platform_driver_unregister(&cros_ec_lpc_driver);
582 cros_ec_lpc_mec_destroy();
583}
584
585module_init(cros_ec_lpc_init);
586module_exit(cros_ec_lpc_exit);
587
588MODULE_LICENSE("GPL");
589MODULE_DESCRIPTION("ChromeOS EC LPC driver");
590