1 // SPDX-License-Identifier: GPL-2.0+ 2 /* 3 * Chromium OS cros_ec driver 4 * 5 * Copyright (c) 2012 The Chromium OS Authors. 6 */ 7 8 /* 9 * This is the interface to the Chrome OS EC. It provides keyboard functions, 10 * power control and battery management. Quite a few other functions are 11 * provided to enable the EC software to be updated, talk to the EC's I2C bus 12 * and store a small amount of data in a memory which persists while the EC 13 * is not reset. 14 */ 15 16 #include <common.h> 17 #include <command.h> 18 #include <dm.h> 19 #include <i2c.h> 20 #include <cros_ec.h> 21 #include <fdtdec.h> 22 #include <malloc.h> 23 #include <spi.h> 24 #include <linux/errno.h> 25 #include <asm/io.h> 26 #include <asm-generic/gpio.h> 27 #include <dm/device-internal.h> 28 #include <dm/of_extra.h> 29 #include <dm/uclass-internal.h> 30 31 #ifdef DEBUG_TRACE 32 #define debug_trace(fmt, b...) debug(fmt, #b) 33 #else 34 #define debug_trace(fmt, b...) 35 #endif 36 37 enum { 38 /* Timeout waiting for a flash erase command to complete */ 39 CROS_EC_CMD_TIMEOUT_MS = 5000, 40 /* Timeout waiting for a synchronous hash to be recomputed */ 41 CROS_EC_CMD_HASH_TIMEOUT_MS = 2000, 42 }; 43 44 void cros_ec_dump_data(const char *name, int cmd, const uint8_t *data, int len) 45 { 46 #ifdef DEBUG 47 int i; 48 49 printf("%s: ", name); 50 if (cmd != -1) 51 printf("cmd=%#x: ", cmd); 52 for (i = 0; i < len; i++) 53 printf("%02x ", data[i]); 54 printf("\n"); 55 #endif 56 } 57 58 /* 59 * Calculate a simple 8-bit checksum of a data block 60 * 61 * @param data Data block to checksum 62 * @param size Size of data block in bytes 63 * @return checksum value (0 to 255) 64 */ 65 int cros_ec_calc_checksum(const uint8_t *data, int size) 66 { 67 int csum, i; 68 69 for (i = csum = 0; i < size; i++) 70 csum += data[i]; 71 return csum & 0xff; 72 } 73 74 /** 75 * Create a request packet for protocol version 3. 76 * 77 * The packet is stored in the device's internal output buffer. 78 * 79 * @param dev CROS-EC device 80 * @param cmd Command to send (EC_CMD_...) 81 * @param cmd_version Version of command to send (EC_VER_...) 82 * @param dout Output data (may be NULL If dout_len=0) 83 * @param dout_len Size of output data in bytes 84 * @return packet size in bytes, or <0 if error. 85 */ 86 static int create_proto3_request(struct cros_ec_dev *dev, 87 int cmd, int cmd_version, 88 const void *dout, int dout_len) 89 { 90 struct ec_host_request *rq = (struct ec_host_request *)dev->dout; 91 int out_bytes = dout_len + sizeof(*rq); 92 93 /* Fail if output size is too big */ 94 if (out_bytes > (int)sizeof(dev->dout)) { 95 debug("%s: Cannot send %d bytes\n", __func__, dout_len); 96 return -EC_RES_REQUEST_TRUNCATED; 97 } 98 99 /* Fill in request packet */ 100 rq->struct_version = EC_HOST_REQUEST_VERSION; 101 rq->checksum = 0; 102 rq->command = cmd; 103 rq->command_version = cmd_version; 104 rq->reserved = 0; 105 rq->data_len = dout_len; 106 107 /* Copy data after header */ 108 memcpy(rq + 1, dout, dout_len); 109 110 /* Write checksum field so the entire packet sums to 0 */ 111 rq->checksum = (uint8_t)(-cros_ec_calc_checksum(dev->dout, out_bytes)); 112 113 cros_ec_dump_data("out", cmd, dev->dout, out_bytes); 114 115 /* Return size of request packet */ 116 return out_bytes; 117 } 118 119 /** 120 * Prepare the device to receive a protocol version 3 response. 121 * 122 * @param dev CROS-EC device 123 * @param din_len Maximum size of response in bytes 124 * @return maximum expected number of bytes in response, or <0 if error. 125 */ 126 static int prepare_proto3_response_buffer(struct cros_ec_dev *dev, int din_len) 127 { 128 int in_bytes = din_len + sizeof(struct ec_host_response); 129 130 /* Fail if input size is too big */ 131 if (in_bytes > (int)sizeof(dev->din)) { 132 debug("%s: Cannot receive %d bytes\n", __func__, din_len); 133 return -EC_RES_RESPONSE_TOO_BIG; 134 } 135 136 /* Return expected size of response packet */ 137 return in_bytes; 138 } 139 140 /** 141 * Handle a protocol version 3 response packet. 142 * 143 * The packet must already be stored in the device's internal input buffer. 144 * 145 * @param dev CROS-EC device 146 * @param dinp Returns pointer to response data 147 * @param din_len Maximum size of response in bytes 148 * @return number of bytes of response data, or <0 if error. Note that error 149 * codes can be from errno.h or -ve EC_RES_INVALID_CHECKSUM values (and they 150 * overlap!) 151 */ 152 static int handle_proto3_response(struct cros_ec_dev *dev, 153 uint8_t **dinp, int din_len) 154 { 155 struct ec_host_response *rs = (struct ec_host_response *)dev->din; 156 int in_bytes; 157 int csum; 158 159 cros_ec_dump_data("in-header", -1, dev->din, sizeof(*rs)); 160 161 /* Check input data */ 162 if (rs->struct_version != EC_HOST_RESPONSE_VERSION) { 163 debug("%s: EC response version mismatch\n", __func__); 164 return -EC_RES_INVALID_RESPONSE; 165 } 166 167 if (rs->reserved) { 168 debug("%s: EC response reserved != 0\n", __func__); 169 return -EC_RES_INVALID_RESPONSE; 170 } 171 172 if (rs->data_len > din_len) { 173 debug("%s: EC returned too much data\n", __func__); 174 return -EC_RES_RESPONSE_TOO_BIG; 175 } 176 177 cros_ec_dump_data("in-data", -1, dev->din + sizeof(*rs), rs->data_len); 178 179 /* Update in_bytes to actual data size */ 180 in_bytes = sizeof(*rs) + rs->data_len; 181 182 /* Verify checksum */ 183 csum = cros_ec_calc_checksum(dev->din, in_bytes); 184 if (csum) { 185 debug("%s: EC response checksum invalid: 0x%02x\n", __func__, 186 csum); 187 return -EC_RES_INVALID_CHECKSUM; 188 } 189 190 /* Return error result, if any */ 191 if (rs->result) 192 return -(int)rs->result; 193 194 /* If we're still here, set response data pointer and return length */ 195 *dinp = (uint8_t *)(rs + 1); 196 197 return rs->data_len; 198 } 199 200 static int send_command_proto3(struct cros_ec_dev *dev, 201 int cmd, int cmd_version, 202 const void *dout, int dout_len, 203 uint8_t **dinp, int din_len) 204 { 205 struct dm_cros_ec_ops *ops; 206 int out_bytes, in_bytes; 207 int rv; 208 209 /* Create request packet */ 210 out_bytes = create_proto3_request(dev, cmd, cmd_version, 211 dout, dout_len); 212 if (out_bytes < 0) 213 return out_bytes; 214 215 /* Prepare response buffer */ 216 in_bytes = prepare_proto3_response_buffer(dev, din_len); 217 if (in_bytes < 0) 218 return in_bytes; 219 220 ops = dm_cros_ec_get_ops(dev->dev); 221 rv = ops->packet ? ops->packet(dev->dev, out_bytes, in_bytes) : -ENOSYS; 222 if (rv < 0) 223 return rv; 224 225 /* Process the response */ 226 return handle_proto3_response(dev, dinp, din_len); 227 } 228 229 static int send_command(struct cros_ec_dev *dev, uint8_t cmd, int cmd_version, 230 const void *dout, int dout_len, 231 uint8_t **dinp, int din_len) 232 { 233 struct dm_cros_ec_ops *ops; 234 int ret = -1; 235 236 /* Handle protocol version 3 support */ 237 if (dev->protocol_version == 3) { 238 return send_command_proto3(dev, cmd, cmd_version, 239 dout, dout_len, dinp, din_len); 240 } 241 242 ops = dm_cros_ec_get_ops(dev->dev); 243 ret = ops->command(dev->dev, cmd, cmd_version, 244 (const uint8_t *)dout, dout_len, dinp, din_len); 245 246 return ret; 247 } 248 249 /** 250 * Send a command to the CROS-EC device and return the reply. 251 * 252 * The device's internal input/output buffers are used. 253 * 254 * @param dev CROS-EC device 255 * @param cmd Command to send (EC_CMD_...) 256 * @param cmd_version Version of command to send (EC_VER_...) 257 * @param dout Output data (may be NULL If dout_len=0) 258 * @param dout_len Size of output data in bytes 259 * @param dinp Response data (may be NULL If din_len=0). 260 * If not NULL, it will be updated to point to the data 261 * and will always be double word aligned (64-bits) 262 * @param din_len Maximum size of response in bytes 263 * @return number of bytes in response, or -ve on error 264 */ 265 static int ec_command_inptr(struct cros_ec_dev *dev, uint8_t cmd, 266 int cmd_version, const void *dout, int dout_len, uint8_t **dinp, 267 int din_len) 268 { 269 uint8_t *din = NULL; 270 int len; 271 272 len = send_command(dev, cmd, cmd_version, dout, dout_len, 273 &din, din_len); 274 275 /* If the command doesn't complete, wait a while */ 276 if (len == -EC_RES_IN_PROGRESS) { 277 struct ec_response_get_comms_status *resp = NULL; 278 ulong start; 279 280 /* Wait for command to complete */ 281 start = get_timer(0); 282 do { 283 int ret; 284 285 mdelay(50); /* Insert some reasonable delay */ 286 ret = send_command(dev, EC_CMD_GET_COMMS_STATUS, 0, 287 NULL, 0, 288 (uint8_t **)&resp, sizeof(*resp)); 289 if (ret < 0) 290 return ret; 291 292 if (get_timer(start) > CROS_EC_CMD_TIMEOUT_MS) { 293 debug("%s: Command %#02x timeout\n", 294 __func__, cmd); 295 return -EC_RES_TIMEOUT; 296 } 297 } while (resp->flags & EC_COMMS_STATUS_PROCESSING); 298 299 /* OK it completed, so read the status response */ 300 /* not sure why it was 0 for the last argument */ 301 len = send_command(dev, EC_CMD_RESEND_RESPONSE, 0, 302 NULL, 0, &din, din_len); 303 } 304 305 debug("%s: len=%d, din=%p\n", __func__, len, din); 306 if (dinp) { 307 /* If we have any data to return, it must be 64bit-aligned */ 308 assert(len <= 0 || !((uintptr_t)din & 7)); 309 *dinp = din; 310 } 311 312 return len; 313 } 314 315 /** 316 * Send a command to the CROS-EC device and return the reply. 317 * 318 * The device's internal input/output buffers are used. 319 * 320 * @param dev CROS-EC device 321 * @param cmd Command to send (EC_CMD_...) 322 * @param cmd_version Version of command to send (EC_VER_...) 323 * @param dout Output data (may be NULL If dout_len=0) 324 * @param dout_len Size of output data in bytes 325 * @param din Response data (may be NULL If din_len=0). 326 * It not NULL, it is a place for ec_command() to copy the 327 * data to. 328 * @param din_len Maximum size of response in bytes 329 * @return number of bytes in response, or -ve on error 330 */ 331 static int ec_command(struct cros_ec_dev *dev, uint8_t cmd, int cmd_version, 332 const void *dout, int dout_len, 333 void *din, int din_len) 334 { 335 uint8_t *in_buffer; 336 int len; 337 338 assert((din_len == 0) || din); 339 len = ec_command_inptr(dev, cmd, cmd_version, dout, dout_len, 340 &in_buffer, din_len); 341 if (len > 0) { 342 /* 343 * If we were asked to put it somewhere, do so, otherwise just 344 * disregard the result. 345 */ 346 if (din && in_buffer) { 347 assert(len <= din_len); 348 memmove(din, in_buffer, len); 349 } 350 } 351 return len; 352 } 353 354 int cros_ec_scan_keyboard(struct udevice *dev, struct mbkp_keyscan *scan) 355 { 356 struct cros_ec_dev *cdev = dev_get_uclass_priv(dev); 357 358 if (ec_command(cdev, EC_CMD_MKBP_STATE, 0, NULL, 0, scan, 359 sizeof(scan->data)) != sizeof(scan->data)) 360 return -1; 361 362 return 0; 363 } 364 365 int cros_ec_read_id(struct cros_ec_dev *dev, char *id, int maxlen) 366 { 367 struct ec_response_get_version *r; 368 369 if (ec_command_inptr(dev, EC_CMD_GET_VERSION, 0, NULL, 0, 370 (uint8_t **)&r, sizeof(*r)) != sizeof(*r)) 371 return -1; 372 373 if (maxlen > (int)sizeof(r->version_string_ro)) 374 maxlen = sizeof(r->version_string_ro); 375 376 switch (r->current_image) { 377 case EC_IMAGE_RO: 378 memcpy(id, r->version_string_ro, maxlen); 379 break; 380 case EC_IMAGE_RW: 381 memcpy(id, r->version_string_rw, maxlen); 382 break; 383 default: 384 return -1; 385 } 386 387 id[maxlen - 1] = '\0'; 388 return 0; 389 } 390 391 int cros_ec_read_version(struct cros_ec_dev *dev, 392 struct ec_response_get_version **versionp) 393 { 394 if (ec_command_inptr(dev, EC_CMD_GET_VERSION, 0, NULL, 0, 395 (uint8_t **)versionp, sizeof(**versionp)) 396 != sizeof(**versionp)) 397 return -1; 398 399 return 0; 400 } 401 402 int cros_ec_read_build_info(struct cros_ec_dev *dev, char **strp) 403 { 404 if (ec_command_inptr(dev, EC_CMD_GET_BUILD_INFO, 0, NULL, 0, 405 (uint8_t **)strp, EC_PROTO2_MAX_PARAM_SIZE) < 0) 406 return -1; 407 408 return 0; 409 } 410 411 int cros_ec_read_current_image(struct cros_ec_dev *dev, 412 enum ec_current_image *image) 413 { 414 struct ec_response_get_version *r; 415 416 if (ec_command_inptr(dev, EC_CMD_GET_VERSION, 0, NULL, 0, 417 (uint8_t **)&r, sizeof(*r)) != sizeof(*r)) 418 return -1; 419 420 *image = r->current_image; 421 return 0; 422 } 423 424 static int cros_ec_wait_on_hash_done(struct cros_ec_dev *dev, 425 struct ec_response_vboot_hash *hash) 426 { 427 struct ec_params_vboot_hash p; 428 ulong start; 429 430 start = get_timer(0); 431 while (hash->status == EC_VBOOT_HASH_STATUS_BUSY) { 432 mdelay(50); /* Insert some reasonable delay */ 433 434 p.cmd = EC_VBOOT_HASH_GET; 435 if (ec_command(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p), 436 hash, sizeof(*hash)) < 0) 437 return -1; 438 439 if (get_timer(start) > CROS_EC_CMD_HASH_TIMEOUT_MS) { 440 debug("%s: EC_VBOOT_HASH_GET timeout\n", __func__); 441 return -EC_RES_TIMEOUT; 442 } 443 } 444 return 0; 445 } 446 447 448 int cros_ec_read_hash(struct cros_ec_dev *dev, 449 struct ec_response_vboot_hash *hash) 450 { 451 struct ec_params_vboot_hash p; 452 int rv; 453 454 p.cmd = EC_VBOOT_HASH_GET; 455 if (ec_command(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p), 456 hash, sizeof(*hash)) < 0) 457 return -1; 458 459 /* If the EC is busy calculating the hash, fidget until it's done. */ 460 rv = cros_ec_wait_on_hash_done(dev, hash); 461 if (rv) 462 return rv; 463 464 /* If the hash is valid, we're done. Otherwise, we have to kick it off 465 * again and wait for it to complete. Note that we explicitly assume 466 * that hashing zero bytes is always wrong, even though that would 467 * produce a valid hash value. */ 468 if (hash->status == EC_VBOOT_HASH_STATUS_DONE && hash->size) 469 return 0; 470 471 debug("%s: No valid hash (status=%d size=%d). Compute one...\n", 472 __func__, hash->status, hash->size); 473 474 p.cmd = EC_VBOOT_HASH_START; 475 p.hash_type = EC_VBOOT_HASH_TYPE_SHA256; 476 p.nonce_size = 0; 477 p.offset = EC_VBOOT_HASH_OFFSET_RW; 478 479 if (ec_command(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p), 480 hash, sizeof(*hash)) < 0) 481 return -1; 482 483 rv = cros_ec_wait_on_hash_done(dev, hash); 484 if (rv) 485 return rv; 486 487 debug("%s: hash done\n", __func__); 488 489 return 0; 490 } 491 492 static int cros_ec_invalidate_hash(struct cros_ec_dev *dev) 493 { 494 struct ec_params_vboot_hash p; 495 struct ec_response_vboot_hash *hash; 496 497 /* We don't have an explict command for the EC to discard its current 498 * hash value, so we'll just tell it to calculate one that we know is 499 * wrong (we claim that hashing zero bytes is always invalid). 500 */ 501 p.cmd = EC_VBOOT_HASH_RECALC; 502 p.hash_type = EC_VBOOT_HASH_TYPE_SHA256; 503 p.nonce_size = 0; 504 p.offset = 0; 505 p.size = 0; 506 507 debug("%s:\n", __func__); 508 509 if (ec_command_inptr(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p), 510 (uint8_t **)&hash, sizeof(*hash)) < 0) 511 return -1; 512 513 /* No need to wait for it to finish */ 514 return 0; 515 } 516 517 int cros_ec_reboot(struct cros_ec_dev *dev, enum ec_reboot_cmd cmd, 518 uint8_t flags) 519 { 520 struct ec_params_reboot_ec p; 521 522 p.cmd = cmd; 523 p.flags = flags; 524 525 if (ec_command_inptr(dev, EC_CMD_REBOOT_EC, 0, &p, sizeof(p), NULL, 0) 526 < 0) 527 return -1; 528 529 if (!(flags & EC_REBOOT_FLAG_ON_AP_SHUTDOWN)) { 530 /* 531 * EC reboot will take place immediately so delay to allow it 532 * to complete. Note that some reboot types (EC_REBOOT_COLD) 533 * will reboot the AP as well, in which case we won't actually 534 * get to this point. 535 */ 536 /* 537 * TODO(rspangler (at) chromium.org): Would be nice if we had a 538 * better way to determine when the reboot is complete. Could 539 * we poll a memory-mapped LPC value? 540 */ 541 udelay(50000); 542 } 543 544 return 0; 545 } 546 547 int cros_ec_interrupt_pending(struct udevice *dev) 548 { 549 struct cros_ec_dev *cdev = dev_get_uclass_priv(dev); 550 551 /* no interrupt support : always poll */ 552 if (!dm_gpio_is_valid(&cdev->ec_int)) 553 return -ENOENT; 554 555 return dm_gpio_get_value(&cdev->ec_int); 556 } 557 558 int cros_ec_info(struct cros_ec_dev *dev, struct ec_response_mkbp_info *info) 559 { 560 if (ec_command(dev, EC_CMD_MKBP_INFO, 0, NULL, 0, info, 561 sizeof(*info)) != sizeof(*info)) 562 return -1; 563 564 return 0; 565 } 566 567 int cros_ec_get_host_events(struct cros_ec_dev *dev, uint32_t *events_ptr) 568 { 569 struct ec_response_host_event_mask *resp; 570 571 /* 572 * Use the B copy of the event flags, because the main copy is already 573 * used by ACPI/SMI. 574 */ 575 if (ec_command_inptr(dev, EC_CMD_HOST_EVENT_GET_B, 0, NULL, 0, 576 (uint8_t **)&resp, sizeof(*resp)) < (int)sizeof(*resp)) 577 return -1; 578 579 if (resp->mask & EC_HOST_EVENT_MASK(EC_HOST_EVENT_INVALID)) 580 return -1; 581 582 *events_ptr = resp->mask; 583 return 0; 584 } 585 586 int cros_ec_clear_host_events(struct cros_ec_dev *dev, uint32_t events) 587 { 588 struct ec_params_host_event_mask params; 589 590 params.mask = events; 591 592 /* 593 * Use the B copy of the event flags, so it affects the data returned 594 * by cros_ec_get_host_events(). 595 */ 596 if (ec_command_inptr(dev, EC_CMD_HOST_EVENT_CLEAR_B, 0, 597 ¶ms, sizeof(params), NULL, 0) < 0) 598 return -1; 599 600 return 0; 601 } 602 603 int cros_ec_flash_protect(struct cros_ec_dev *dev, 604 uint32_t set_mask, uint32_t set_flags, 605 struct ec_response_flash_protect *resp) 606 { 607 struct ec_params_flash_protect params; 608 609 params.mask = set_mask; 610 params.flags = set_flags; 611 612 if (ec_command(dev, EC_CMD_FLASH_PROTECT, EC_VER_FLASH_PROTECT, 613 ¶ms, sizeof(params), 614 resp, sizeof(*resp)) != sizeof(*resp)) 615 return -1; 616 617 return 0; 618 } 619 620 static int cros_ec_check_version(struct cros_ec_dev *dev) 621 { 622 struct ec_params_hello req; 623 struct ec_response_hello *resp; 624 625 struct dm_cros_ec_ops *ops; 626 int ret; 627 628 ops = dm_cros_ec_get_ops(dev->dev); 629 if (ops->check_version) { 630 ret = ops->check_version(dev->dev); 631 if (ret) 632 return ret; 633 } 634 635 /* 636 * TODO(sjg (at) chromium.org). 637 * There is a strange oddity here with the EC. We could just ignore 638 * the response, i.e. pass the last two parameters as NULL and 0. 639 * In this case we won't read back very many bytes from the EC. 640 * On the I2C bus the EC gets upset about this and will try to send 641 * the bytes anyway. This means that we will have to wait for that 642 * to complete before continuing with a new EC command. 643 * 644 * This problem is probably unique to the I2C bus. 645 * 646 * So for now, just read all the data anyway. 647 */ 648 649 /* Try sending a version 3 packet */ 650 dev->protocol_version = 3; 651 req.in_data = 0; 652 if (ec_command_inptr(dev, EC_CMD_HELLO, 0, &req, sizeof(req), 653 (uint8_t **)&resp, sizeof(*resp)) > 0) { 654 return 0; 655 } 656 657 /* Try sending a version 2 packet */ 658 dev->protocol_version = 2; 659 if (ec_command_inptr(dev, EC_CMD_HELLO, 0, &req, sizeof(req), 660 (uint8_t **)&resp, sizeof(*resp)) > 0) { 661 return 0; 662 } 663 664 /* 665 * Fail if we're still here, since the EC doesn't understand any 666 * protcol version we speak. Version 1 interface without command 667 * version is no longer supported, and we don't know about any new 668 * protocol versions. 669 */ 670 dev->protocol_version = 0; 671 printf("%s: ERROR: old EC interface not supported\n", __func__); 672 return -1; 673 } 674 675 int cros_ec_test(struct cros_ec_dev *dev) 676 { 677 struct ec_params_hello req; 678 struct ec_response_hello *resp; 679 680 req.in_data = 0x12345678; 681 if (ec_command_inptr(dev, EC_CMD_HELLO, 0, &req, sizeof(req), 682 (uint8_t **)&resp, sizeof(*resp)) < sizeof(*resp)) { 683 printf("ec_command_inptr() returned error\n"); 684 return -1; 685 } 686 if (resp->out_data != req.in_data + 0x01020304) { 687 printf("Received invalid handshake %x\n", resp->out_data); 688 return -1; 689 } 690 691 return 0; 692 } 693 694 int cros_ec_flash_offset(struct cros_ec_dev *dev, enum ec_flash_region region, 695 uint32_t *offset, uint32_t *size) 696 { 697 struct ec_params_flash_region_info p; 698 struct ec_response_flash_region_info *r; 699 int ret; 700 701 p.region = region; 702 ret = ec_command_inptr(dev, EC_CMD_FLASH_REGION_INFO, 703 EC_VER_FLASH_REGION_INFO, 704 &p, sizeof(p), (uint8_t **)&r, sizeof(*r)); 705 if (ret != sizeof(*r)) 706 return -1; 707 708 if (offset) 709 *offset = r->offset; 710 if (size) 711 *size = r->size; 712 713 return 0; 714 } 715 716 int cros_ec_flash_erase(struct cros_ec_dev *dev, uint32_t offset, uint32_t size) 717 { 718 struct ec_params_flash_erase p; 719 720 p.offset = offset; 721 p.size = size; 722 return ec_command_inptr(dev, EC_CMD_FLASH_ERASE, 0, &p, sizeof(p), 723 NULL, 0); 724 } 725 726 /** 727 * Write a single block to the flash 728 * 729 * Write a block of data to the EC flash. The size must not exceed the flash 730 * write block size which you can obtain from cros_ec_flash_write_burst_size(). 731 * 732 * The offset starts at 0. You can obtain the region information from 733 * cros_ec_flash_offset() to find out where to write for a particular region. 734 * 735 * Attempting to write to the region where the EC is currently running from 736 * will result in an error. 737 * 738 * @param dev CROS-EC device 739 * @param data Pointer to data buffer to write 740 * @param offset Offset within flash to write to. 741 * @param size Number of bytes to write 742 * @return 0 if ok, -1 on error 743 */ 744 static int cros_ec_flash_write_block(struct cros_ec_dev *dev, 745 const uint8_t *data, uint32_t offset, uint32_t size) 746 { 747 struct ec_params_flash_write *p; 748 int ret; 749 750 p = malloc(sizeof(*p) + size); 751 if (!p) 752 return -ENOMEM; 753 754 p->offset = offset; 755 p->size = size; 756 assert(data && p->size <= EC_FLASH_WRITE_VER0_SIZE); 757 memcpy(p + 1, data, p->size); 758 759 ret = ec_command_inptr(dev, EC_CMD_FLASH_WRITE, 0, 760 p, sizeof(*p) + size, NULL, 0) >= 0 ? 0 : -1; 761 762 free(p); 763 764 return ret; 765 } 766 767 /** 768 * Return optimal flash write burst size 769 */ 770 static int cros_ec_flash_write_burst_size(struct cros_ec_dev *dev) 771 { 772 return EC_FLASH_WRITE_VER0_SIZE; 773 } 774 775 /** 776 * Check if a block of data is erased (all 0xff) 777 * 778 * This function is useful when dealing with flash, for checking whether a 779 * data block is erased and thus does not need to be programmed. 780 * 781 * @param data Pointer to data to check (must be word-aligned) 782 * @param size Number of bytes to check (must be word-aligned) 783 * @return 0 if erased, non-zero if any word is not erased 784 */ 785 static int cros_ec_data_is_erased(const uint32_t *data, int size) 786 { 787 assert(!(size & 3)); 788 size /= sizeof(uint32_t); 789 for (; size > 0; size -= 4, data++) 790 if (*data != -1U) 791 return 0; 792 793 return 1; 794 } 795 796 /** 797 * Read back flash parameters 798 * 799 * This function reads back parameters of the flash as reported by the EC 800 * 801 * @param dev Pointer to device 802 * @param info Pointer to output flash info struct 803 */ 804 int cros_ec_read_flashinfo(struct cros_ec_dev *dev, 805 struct ec_response_flash_info *info) 806 { 807 int ret; 808 809 ret = ec_command(dev, EC_CMD_FLASH_INFO, 0, 810 NULL, 0, info, sizeof(*info)); 811 if (ret < 0) 812 return ret; 813 814 return ret < sizeof(*info) ? -1 : 0; 815 } 816 817 int cros_ec_flash_write(struct cros_ec_dev *dev, const uint8_t *data, 818 uint32_t offset, uint32_t size) 819 { 820 uint32_t burst = cros_ec_flash_write_burst_size(dev); 821 uint32_t end, off; 822 int ret; 823 824 /* 825 * TODO: round up to the nearest multiple of write size. Can get away 826 * without that on link right now because its write size is 4 bytes. 827 */ 828 end = offset + size; 829 for (off = offset; off < end; off += burst, data += burst) { 830 uint32_t todo; 831 832 /* If the data is empty, there is no point in programming it */ 833 todo = min(end - off, burst); 834 if (dev->optimise_flash_write && 835 cros_ec_data_is_erased((uint32_t *)data, todo)) 836 continue; 837 838 ret = cros_ec_flash_write_block(dev, data, off, todo); 839 if (ret) 840 return ret; 841 } 842 843 return 0; 844 } 845 846 /** 847 * Read a single block from the flash 848 * 849 * Read a block of data from the EC flash. The size must not exceed the flash 850 * write block size which you can obtain from cros_ec_flash_write_burst_size(). 851 * 852 * The offset starts at 0. You can obtain the region information from 853 * cros_ec_flash_offset() to find out where to read for a particular region. 854 * 855 * @param dev CROS-EC device 856 * @param data Pointer to data buffer to read into 857 * @param offset Offset within flash to read from 858 * @param size Number of bytes to read 859 * @return 0 if ok, -1 on error 860 */ 861 static int cros_ec_flash_read_block(struct cros_ec_dev *dev, uint8_t *data, 862 uint32_t offset, uint32_t size) 863 { 864 struct ec_params_flash_read p; 865 866 p.offset = offset; 867 p.size = size; 868 869 return ec_command(dev, EC_CMD_FLASH_READ, 0, 870 &p, sizeof(p), data, size) >= 0 ? 0 : -1; 871 } 872 873 int cros_ec_flash_read(struct cros_ec_dev *dev, uint8_t *data, uint32_t offset, 874 uint32_t size) 875 { 876 uint32_t burst = cros_ec_flash_write_burst_size(dev); 877 uint32_t end, off; 878 int ret; 879 880 end = offset + size; 881 for (off = offset; off < end; off += burst, data += burst) { 882 ret = cros_ec_flash_read_block(dev, data, off, 883 min(end - off, burst)); 884 if (ret) 885 return ret; 886 } 887 888 return 0; 889 } 890 891 int cros_ec_flash_update_rw(struct cros_ec_dev *dev, 892 const uint8_t *image, int image_size) 893 { 894 uint32_t rw_offset, rw_size; 895 int ret; 896 897 if (cros_ec_flash_offset(dev, EC_FLASH_REGION_RW, &rw_offset, &rw_size)) 898 return -1; 899 if (image_size > (int)rw_size) 900 return -1; 901 902 /* Invalidate the existing hash, just in case the AP reboots 903 * unexpectedly during the update. If that happened, the EC RW firmware 904 * would be invalid, but the EC would still have the original hash. 905 */ 906 ret = cros_ec_invalidate_hash(dev); 907 if (ret) 908 return ret; 909 910 /* 911 * Erase the entire RW section, so that the EC doesn't see any garbage 912 * past the new image if it's smaller than the current image. 913 * 914 * TODO: could optimize this to erase just the current image, since 915 * presumably everything past that is 0xff's. But would still need to 916 * round up to the nearest multiple of erase size. 917 */ 918 ret = cros_ec_flash_erase(dev, rw_offset, rw_size); 919 if (ret) 920 return ret; 921 922 /* Write the image */ 923 ret = cros_ec_flash_write(dev, image, rw_offset, image_size); 924 if (ret) 925 return ret; 926 927 return 0; 928 } 929 930 int cros_ec_read_vbnvcontext(struct cros_ec_dev *dev, uint8_t *block) 931 { 932 struct ec_params_vbnvcontext p; 933 int len; 934 935 p.op = EC_VBNV_CONTEXT_OP_READ; 936 937 len = ec_command(dev, EC_CMD_VBNV_CONTEXT, EC_VER_VBNV_CONTEXT, 938 &p, sizeof(p), block, EC_VBNV_BLOCK_SIZE); 939 if (len < EC_VBNV_BLOCK_SIZE) 940 return -1; 941 942 return 0; 943 } 944 945 int cros_ec_write_vbnvcontext(struct cros_ec_dev *dev, const uint8_t *block) 946 { 947 struct ec_params_vbnvcontext p; 948 int len; 949 950 p.op = EC_VBNV_CONTEXT_OP_WRITE; 951 memcpy(p.block, block, sizeof(p.block)); 952 953 len = ec_command_inptr(dev, EC_CMD_VBNV_CONTEXT, EC_VER_VBNV_CONTEXT, 954 &p, sizeof(p), NULL, 0); 955 if (len < 0) 956 return -1; 957 958 return 0; 959 } 960 961 int cros_ec_set_ldo(struct udevice *dev, uint8_t index, uint8_t state) 962 { 963 struct cros_ec_dev *cdev = dev_get_uclass_priv(dev); 964 struct ec_params_ldo_set params; 965 966 params.index = index; 967 params.state = state; 968 969 if (ec_command_inptr(cdev, EC_CMD_LDO_SET, 0, ¶ms, sizeof(params), 970 NULL, 0)) 971 return -1; 972 973 return 0; 974 } 975 976 int cros_ec_get_ldo(struct udevice *dev, uint8_t index, uint8_t *state) 977 { 978 struct cros_ec_dev *cdev = dev_get_uclass_priv(dev); 979 struct ec_params_ldo_get params; 980 struct ec_response_ldo_get *resp; 981 982 params.index = index; 983 984 if (ec_command_inptr(cdev, EC_CMD_LDO_GET, 0, ¶ms, sizeof(params), 985 (uint8_t **)&resp, sizeof(*resp)) != 986 sizeof(*resp)) 987 return -1; 988 989 *state = resp->state; 990 991 return 0; 992 } 993 994 int cros_ec_register(struct udevice *dev) 995 { 996 struct cros_ec_dev *cdev = dev_get_uclass_priv(dev); 997 char id[MSG_BYTES]; 998 999 cdev->dev = dev; 1000 gpio_request_by_name(dev, "ec-interrupt", 0, &cdev->ec_int, 1001 GPIOD_IS_IN); 1002 cdev->optimise_flash_write = dev_read_bool(dev, "optimise-flash-write"); 1003 1004 if (cros_ec_check_version(cdev)) { 1005 debug("%s: Could not detect CROS-EC version\n", __func__); 1006 return -CROS_EC_ERR_CHECK_VERSION; 1007 } 1008 1009 if (cros_ec_read_id(cdev, id, sizeof(id))) { 1010 debug("%s: Could not read KBC ID\n", __func__); 1011 return -CROS_EC_ERR_READ_ID; 1012 } 1013 1014 /* Remember this device for use by the cros_ec command */ 1015 debug("Google Chrome EC v%d CROS-EC driver ready, id '%s'\n", 1016 cdev->protocol_version, id); 1017 1018 return 0; 1019 } 1020 1021 int cros_ec_decode_ec_flash(struct udevice *dev, struct fdt_cros_ec *config) 1022 { 1023 ofnode flash_node, node; 1024 1025 flash_node = dev_read_subnode(dev, "flash"); 1026 if (!ofnode_valid(flash_node)) { 1027 debug("Failed to find flash node\n"); 1028 return -1; 1029 } 1030 1031 if (of_read_fmap_entry(flash_node, "flash", &config->flash)) { 1032 debug("Failed to decode flash node in chrome-ec\n"); 1033 return -1; 1034 } 1035 1036 config->flash_erase_value = ofnode_read_s32_default(flash_node, 1037 "erase-value", -1); 1038 ofnode_for_each_subnode(node, flash_node) { 1039 const char *name = ofnode_get_name(node); 1040 enum ec_flash_region region; 1041 1042 if (0 == strcmp(name, "ro")) { 1043 region = EC_FLASH_REGION_RO; 1044 } else if (0 == strcmp(name, "rw")) { 1045 region = EC_FLASH_REGION_RW; 1046 } else if (0 == strcmp(name, "wp-ro")) { 1047 region = EC_FLASH_REGION_WP_RO; 1048 } else { 1049 debug("Unknown EC flash region name '%s'\n", name); 1050 return -1; 1051 } 1052 1053 if (of_read_fmap_entry(node, "reg", &config->region[region])) { 1054 debug("Failed to decode flash region in chrome-ec'\n"); 1055 return -1; 1056 } 1057 } 1058 1059 return 0; 1060 } 1061 1062 int cros_ec_i2c_tunnel(struct udevice *dev, int port, struct i2c_msg *in, 1063 int nmsgs) 1064 { 1065 struct cros_ec_dev *cdev = dev_get_uclass_priv(dev); 1066 union { 1067 struct ec_params_i2c_passthru p; 1068 uint8_t outbuf[EC_PROTO2_MAX_PARAM_SIZE]; 1069 } params; 1070 union { 1071 struct ec_response_i2c_passthru r; 1072 uint8_t inbuf[EC_PROTO2_MAX_PARAM_SIZE]; 1073 } response; 1074 struct ec_params_i2c_passthru *p = ¶ms.p; 1075 struct ec_response_i2c_passthru *r = &response.r; 1076 struct ec_params_i2c_passthru_msg *msg; 1077 uint8_t *pdata, *read_ptr = NULL; 1078 int read_len; 1079 int size; 1080 int rv; 1081 int i; 1082 1083 p->port = port; 1084 1085 p->num_msgs = nmsgs; 1086 size = sizeof(*p) + p->num_msgs * sizeof(*msg); 1087 1088 /* Create a message to write the register address and optional data */ 1089 pdata = (uint8_t *)p + size; 1090 1091 read_len = 0; 1092 for (i = 0, msg = p->msg; i < nmsgs; i++, msg++, in++) { 1093 bool is_read = in->flags & I2C_M_RD; 1094 1095 msg->addr_flags = in->addr; 1096 msg->len = in->len; 1097 if (is_read) { 1098 msg->addr_flags |= EC_I2C_FLAG_READ; 1099 read_len += in->len; 1100 read_ptr = in->buf; 1101 if (sizeof(*r) + read_len > sizeof(response)) { 1102 puts("Read length too big for buffer\n"); 1103 return -1; 1104 } 1105 } else { 1106 if (pdata - (uint8_t *)p + in->len > sizeof(params)) { 1107 puts("Params too large for buffer\n"); 1108 return -1; 1109 } 1110 memcpy(pdata, in->buf, in->len); 1111 pdata += in->len; 1112 } 1113 } 1114 1115 rv = ec_command(cdev, EC_CMD_I2C_PASSTHRU, 0, p, pdata - (uint8_t *)p, 1116 r, sizeof(*r) + read_len); 1117 if (rv < 0) 1118 return rv; 1119 1120 /* Parse response */ 1121 if (r->i2c_status & EC_I2C_STATUS_ERROR) { 1122 printf("Transfer failed with status=0x%x\n", r->i2c_status); 1123 return -1; 1124 } 1125 1126 if (rv < sizeof(*r) + read_len) { 1127 puts("Truncated read response\n"); 1128 return -1; 1129 } 1130 1131 /* We only support a single read message for each transfer */ 1132 if (read_len) 1133 memcpy(read_ptr, r->data, read_len); 1134 1135 return 0; 1136 } 1137 1138 UCLASS_DRIVER(cros_ec) = { 1139 .id = UCLASS_CROS_EC, 1140 .name = "cros_ec", 1141 .per_device_auto_alloc_size = sizeof(struct cros_ec_dev), 1142 .post_bind = dm_scan_fdt_dev, 1143 }; 1144
