git.sur5r.net Git - u-boot/blob - drivers/misc/cros_ec.c

   1 /*
   2  * Chromium OS cros_ec driver
   3  *
   4  * Copyright (c) 2012 The Chromium OS Authors.
   5  *
   6  * SPDX-License-Identifier:     GPL-2.0+
   7  */
   8
   9 /*
  10  * This is the interface to the Chrome OS EC. It provides keyboard functions,
  11  * power control and battery management. Quite a few other functions are
  12  * provided to enable the EC software to be updated, talk to the EC's I2C bus
  13  * and store a small amount of data in a memory which persists while the EC
  14  * is not reset.
  15  */
  16
  17 #include <common.h>
  18 #include <command.h>
  19 #include <dm.h>
  20 #include <i2c.h>
  21 #include <cros_ec.h>
  22 #include <fdtdec.h>
  23 #include <malloc.h>
  24 #include <spi.h>
  25 #include <linux/errno.h>
  26 #include <asm/io.h>
  27 #include <asm-generic/gpio.h>
  28 #include <dm/device-internal.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 DECLARE_GLOBAL_DATA_PTR;
  45
  46 /* Note: depends on enum ec_current_image */
  47 static const char * const ec_current_image_name[] = {"unknown", "RO", "RW"};
  48
  49 void cros_ec_dump_data(const char *name, int cmd, const uint8_t *data, int len)
  50 {
  51 #ifdef DEBUG
  52         int i;
  53
  54         printf("%s: ", name);
  55         if (cmd != -1)
  56                 printf("cmd=%#x: ", cmd);
  57         for (i = 0; i < len; i++)
  58                 printf("%02x ", data[i]);
  59         printf("\n");
  60 #endif
  61 }
  62
  63 /*
  64  * Calculate a simple 8-bit checksum of a data block
  65  *
  66  * @param data  Data block to checksum
  67  * @param size  Size of data block in bytes
  68  * @return checksum value (0 to 255)
  69  */
  70 int cros_ec_calc_checksum(const uint8_t *data, int size)
  71 {
  72         int csum, i;
  73
  74         for (i = csum = 0; i < size; i++)
  75                 csum += data[i];
  76         return csum & 0xff;
  77 }
  78
  79 /**
  80  * Create a request packet for protocol version 3.
  81  *
  82  * The packet is stored in the device's internal output buffer.
  83  *
  84  * @param dev           CROS-EC device
  85  * @param cmd           Command to send (EC_CMD_...)
  86  * @param cmd_version   Version of command to send (EC_VER_...)
  87  * @param dout          Output data (may be NULL If dout_len=0)
  88  * @param dout_len      Size of output data in bytes
  89  * @return packet size in bytes, or <0 if error.
  90  */
  91 static int create_proto3_request(struct cros_ec_dev *dev,
  92                                  int cmd, int cmd_version,
  93                                  const void *dout, int dout_len)
  94 {
  95         struct ec_host_request *rq = (struct ec_host_request *)dev->dout;
  96         int out_bytes = dout_len + sizeof(*rq);
  97
  98         /* Fail if output size is too big */
  99         if (out_bytes > (int)sizeof(dev->dout)) {
 100                 debug("%s: Cannot send %d bytes\n", __func__, dout_len);
 101                 return -EC_RES_REQUEST_TRUNCATED;
 102         }
 103
 104         /* Fill in request packet */
 105         rq->struct_version = EC_HOST_REQUEST_VERSION;
 106         rq->checksum = 0;
 107         rq->command = cmd;
 108         rq->command_version = cmd_version;
 109         rq->reserved = 0;
 110         rq->data_len = dout_len;
 111
 112         /* Copy data after header */
 113         memcpy(rq + 1, dout, dout_len);
 114
 115         /* Write checksum field so the entire packet sums to 0 */
 116         rq->checksum = (uint8_t)(-cros_ec_calc_checksum(dev->dout, out_bytes));
 117
 118         cros_ec_dump_data("out", cmd, dev->dout, out_bytes);
 119
 120         /* Return size of request packet */
 121         return out_bytes;
 122 }
 123
 124 /**
 125  * Prepare the device to receive a protocol version 3 response.
 126  *
 127  * @param dev           CROS-EC device
 128  * @param din_len       Maximum size of response in bytes
 129  * @return maximum expected number of bytes in response, or <0 if error.
 130  */
 131 static int prepare_proto3_response_buffer(struct cros_ec_dev *dev, int din_len)
 132 {
 133         int in_bytes = din_len + sizeof(struct ec_host_response);
 134
 135         /* Fail if input size is too big */
 136         if (in_bytes > (int)sizeof(dev->din)) {
 137                 debug("%s: Cannot receive %d bytes\n", __func__, din_len);
 138                 return -EC_RES_RESPONSE_TOO_BIG;
 139         }
 140
 141         /* Return expected size of response packet */
 142         return in_bytes;
 143 }
 144
 145 /**
 146  * Handle a protocol version 3 response packet.
 147  *
 148  * The packet must already be stored in the device's internal input buffer.
 149  *
 150  * @param dev           CROS-EC device
 151  * @param dinp          Returns pointer to response data
 152  * @param din_len       Maximum size of response in bytes
 153  * @return number of bytes of response data, or <0 if error. Note that error
 154  * codes can be from errno.h or -ve EC_RES_INVALID_CHECKSUM values (and they
 155  * overlap!)
 156  */
 157 static int handle_proto3_response(struct cros_ec_dev *dev,
 158                                   uint8_t **dinp, int din_len)
 159 {
 160         struct ec_host_response *rs = (struct ec_host_response *)dev->din;
 161         int in_bytes;
 162         int csum;
 163
 164         cros_ec_dump_data("in-header", -1, dev->din, sizeof(*rs));
 165
 166         /* Check input data */
 167         if (rs->struct_version != EC_HOST_RESPONSE_VERSION) {
 168                 debug("%s: EC response version mismatch\n", __func__);
 169                 return -EC_RES_INVALID_RESPONSE;
 170         }
 171
 172         if (rs->reserved) {
 173                 debug("%s: EC response reserved != 0\n", __func__);
 174                 return -EC_RES_INVALID_RESPONSE;
 175         }
 176
 177         if (rs->data_len > din_len) {
 178                 debug("%s: EC returned too much data\n", __func__);
 179                 return -EC_RES_RESPONSE_TOO_BIG;
 180         }
 181
 182         cros_ec_dump_data("in-data", -1, dev->din + sizeof(*rs), rs->data_len);
 183
 184         /* Update in_bytes to actual data size */
 185         in_bytes = sizeof(*rs) + rs->data_len;
 186
 187         /* Verify checksum */
 188         csum = cros_ec_calc_checksum(dev->din, in_bytes);
 189         if (csum) {
 190                 debug("%s: EC response checksum invalid: 0x%02x\n", __func__,
 191                       csum);
 192                 return -EC_RES_INVALID_CHECKSUM;
 193         }
 194
 195         /* Return error result, if any */
 196         if (rs->result)
 197                 return -(int)rs->result;
 198
 199         /* If we're still here, set response data pointer and return length */
 200         *dinp = (uint8_t *)(rs + 1);
 201
 202         return rs->data_len;
 203 }
 204
 205 static int send_command_proto3(struct cros_ec_dev *dev,
 206                                int cmd, int cmd_version,
 207                                const void *dout, int dout_len,
 208                                uint8_t **dinp, int din_len)
 209 {
 210         struct dm_cros_ec_ops *ops;
 211         int out_bytes, in_bytes;
 212         int rv;
 213
 214         /* Create request packet */
 215         out_bytes = create_proto3_request(dev, cmd, cmd_version,
 216                                           dout, dout_len);
 217         if (out_bytes < 0)
 218                 return out_bytes;
 219
 220         /* Prepare response buffer */
 221         in_bytes = prepare_proto3_response_buffer(dev, din_len);
 222         if (in_bytes < 0)
 223                 return in_bytes;
 224
 225         ops = dm_cros_ec_get_ops(dev->dev);
 226         rv = ops->packet ? ops->packet(dev->dev, out_bytes, in_bytes) : -ENOSYS;
 227         if (rv < 0)
 228                 return rv;
 229
 230         /* Process the response */
 231         return handle_proto3_response(dev, dinp, din_len);
 232 }
 233
 234 static int send_command(struct cros_ec_dev *dev, uint8_t cmd, int cmd_version,
 235                         const void *dout, int dout_len,
 236                         uint8_t **dinp, int din_len)
 237 {
 238         struct dm_cros_ec_ops *ops;
 239         int ret = -1;
 240
 241         /* Handle protocol version 3 support */
 242         if (dev->protocol_version == 3) {
 243                 return send_command_proto3(dev, cmd, cmd_version,
 244                                            dout, dout_len, dinp, din_len);
 245         }
 246
 247         ops = dm_cros_ec_get_ops(dev->dev);
 248         ret = ops->command(dev->dev, cmd, cmd_version,
 249                            (const uint8_t *)dout, dout_len, dinp, din_len);
 250
 251         return ret;
 252 }
 253
 254 /**
 255  * Send a command to the CROS-EC device and return the reply.
 256  *
 257  * The device's internal input/output buffers are used.
 258  *
 259  * @param dev           CROS-EC device
 260  * @param cmd           Command to send (EC_CMD_...)
 261  * @param cmd_version   Version of command to send (EC_VER_...)
 262  * @param dout          Output data (may be NULL If dout_len=0)
 263  * @param dout_len      Size of output data in bytes
 264  * @param dinp          Response data (may be NULL If din_len=0).
 265  *                      If not NULL, it will be updated to point to the data
 266  *                      and will always be double word aligned (64-bits)
 267  * @param din_len       Maximum size of response in bytes
 268  * @return number of bytes in response, or -ve on error
 269  */
 270 static int ec_command_inptr(struct cros_ec_dev *dev, uint8_t cmd,
 271                 int cmd_version, const void *dout, int dout_len, uint8_t **dinp,
 272                 int din_len)
 273 {
 274         uint8_t *din = NULL;
 275         int len;
 276
 277         len = send_command(dev, cmd, cmd_version, dout, dout_len,
 278                                 &din, din_len);
 279
 280         /* If the command doesn't complete, wait a while */
 281         if (len == -EC_RES_IN_PROGRESS) {
 282                 struct ec_response_get_comms_status *resp = NULL;
 283                 ulong start;
 284
 285                 /* Wait for command to complete */
 286                 start = get_timer(0);
 287                 do {
 288                         int ret;
 289
 290                         mdelay(50);     /* Insert some reasonable delay */
 291                         ret = send_command(dev, EC_CMD_GET_COMMS_STATUS, 0,
 292                                         NULL, 0,
 293                                         (uint8_t **)&resp, sizeof(*resp));
 294                         if (ret < 0)
 295                                 return ret;
 296
 297                         if (get_timer(start) > CROS_EC_CMD_TIMEOUT_MS) {
 298                                 debug("%s: Command %#02x timeout\n",
 299                                       __func__, cmd);
 300                                 return -EC_RES_TIMEOUT;
 301                         }
 302                 } while (resp->flags & EC_COMMS_STATUS_PROCESSING);
 303
 304                 /* OK it completed, so read the status response */
 305                 /* not sure why it was 0 for the last argument */
 306                 len = send_command(dev, EC_CMD_RESEND_RESPONSE, 0,
 307                                 NULL, 0, &din, din_len);
 308         }
 309
 310         debug("%s: len=%d, dinp=%p, *dinp=%p\n", __func__, len, dinp,
 311               dinp ? *dinp : NULL);
 312         if (dinp) {
 313                 /* If we have any data to return, it must be 64bit-aligned */
 314                 assert(len <= 0 || !((uintptr_t)din & 7));
 315                 *dinp = din;
 316         }
 317
 318         return len;
 319 }
 320
 321 /**
 322  * Send a command to the CROS-EC device and return the reply.
 323  *
 324  * The device's internal input/output buffers are used.
 325  *
 326  * @param dev           CROS-EC device
 327  * @param cmd           Command to send (EC_CMD_...)
 328  * @param cmd_version   Version of command to send (EC_VER_...)
 329  * @param dout          Output data (may be NULL If dout_len=0)
 330  * @param dout_len      Size of output data in bytes
 331  * @param din           Response data (may be NULL If din_len=0).
 332  *                      It not NULL, it is a place for ec_command() to copy the
 333  *      data to.
 334  * @param din_len       Maximum size of response in bytes
 335  * @return number of bytes in response, or -ve on error
 336  */
 337 static int ec_command(struct cros_ec_dev *dev, uint8_t cmd, int cmd_version,
 338                       const void *dout, int dout_len,
 339                       void *din, int din_len)
 340 {
 341         uint8_t *in_buffer;
 342         int len;
 343
 344         assert((din_len == 0) || din);
 345         len = ec_command_inptr(dev, cmd, cmd_version, dout, dout_len,
 346                         &in_buffer, din_len);
 347         if (len > 0) {
 348                 /*
 349                  * If we were asked to put it somewhere, do so, otherwise just
 350                  * disregard the result.
 351                  */
 352                 if (din && in_buffer) {
 353                         assert(len <= din_len);
 354                         memmove(din, in_buffer, len);
 355                 }
 356         }
 357         return len;
 358 }
 359
 360 int cros_ec_scan_keyboard(struct udevice *dev, struct mbkp_keyscan *scan)
 361 {
 362         struct cros_ec_dev *cdev = dev_get_uclass_priv(dev);
 363
 364         if (ec_command(cdev, EC_CMD_MKBP_STATE, 0, NULL, 0, scan,
 365                        sizeof(scan->data)) != sizeof(scan->data))
 366                 return -1;
 367
 368         return 0;
 369 }
 370
 371 int cros_ec_read_id(struct cros_ec_dev *dev, char *id, int maxlen)
 372 {
 373         struct ec_response_get_version *r;
 374
 375         if (ec_command_inptr(dev, EC_CMD_GET_VERSION, 0, NULL, 0,
 376                         (uint8_t **)&r, sizeof(*r)) != sizeof(*r))
 377                 return -1;
 378
 379         if (maxlen > (int)sizeof(r->version_string_ro))
 380                 maxlen = sizeof(r->version_string_ro);
 381
 382         switch (r->current_image) {
 383         case EC_IMAGE_RO:
 384                 memcpy(id, r->version_string_ro, maxlen);
 385                 break;
 386         case EC_IMAGE_RW:
 387                 memcpy(id, r->version_string_rw, maxlen);
 388                 break;
 389         default:
 390                 return -1;
 391         }
 392
 393         id[maxlen - 1] = '\0';
 394         return 0;
 395 }
 396
 397 int cros_ec_read_version(struct cros_ec_dev *dev,
 398                        struct ec_response_get_version **versionp)
 399 {
 400         if (ec_command_inptr(dev, EC_CMD_GET_VERSION, 0, NULL, 0,
 401                         (uint8_t **)versionp, sizeof(**versionp))
 402                         != sizeof(**versionp))
 403                 return -1;
 404
 405         return 0;
 406 }
 407
 408 int cros_ec_read_build_info(struct cros_ec_dev *dev, char **strp)
 409 {
 410         if (ec_command_inptr(dev, EC_CMD_GET_BUILD_INFO, 0, NULL, 0,
 411                         (uint8_t **)strp, EC_PROTO2_MAX_PARAM_SIZE) < 0)
 412                 return -1;
 413
 414         return 0;
 415 }
 416
 417 int cros_ec_read_current_image(struct cros_ec_dev *dev,
 418                 enum ec_current_image *image)
 419 {
 420         struct ec_response_get_version *r;
 421
 422         if (ec_command_inptr(dev, EC_CMD_GET_VERSION, 0, NULL, 0,
 423                         (uint8_t **)&r, sizeof(*r)) != sizeof(*r))
 424                 return -1;
 425
 426         *image = r->current_image;
 427         return 0;
 428 }
 429
 430 static int cros_ec_wait_on_hash_done(struct cros_ec_dev *dev,
 431                                   struct ec_response_vboot_hash *hash)
 432 {
 433         struct ec_params_vboot_hash p;
 434         ulong start;
 435
 436         start = get_timer(0);
 437         while (hash->status == EC_VBOOT_HASH_STATUS_BUSY) {
 438                 mdelay(50);     /* Insert some reasonable delay */
 439
 440                 p.cmd = EC_VBOOT_HASH_GET;
 441                 if (ec_command(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p),
 442                        hash, sizeof(*hash)) < 0)
 443                         return -1;
 444
 445                 if (get_timer(start) > CROS_EC_CMD_HASH_TIMEOUT_MS) {
 446                         debug("%s: EC_VBOOT_HASH_GET timeout\n", __func__);
 447                         return -EC_RES_TIMEOUT;
 448                 }
 449         }
 450         return 0;
 451 }
 452
 453
 454 int cros_ec_read_hash(struct cros_ec_dev *dev,
 455                 struct ec_response_vboot_hash *hash)
 456 {
 457         struct ec_params_vboot_hash p;
 458         int rv;
 459
 460         p.cmd = EC_VBOOT_HASH_GET;
 461         if (ec_command(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p),
 462                        hash, sizeof(*hash)) < 0)
 463                 return -1;
 464
 465         /* If the EC is busy calculating the hash, fidget until it's done. */
 466         rv = cros_ec_wait_on_hash_done(dev, hash);
 467         if (rv)
 468                 return rv;
 469
 470         /* If the hash is valid, we're done. Otherwise, we have to kick it off
 471          * again and wait for it to complete. Note that we explicitly assume
 472          * that hashing zero bytes is always wrong, even though that would
 473          * produce a valid hash value. */
 474         if (hash->status == EC_VBOOT_HASH_STATUS_DONE && hash->size)
 475                 return 0;
 476
 477         debug("%s: No valid hash (status=%d size=%d). Compute one...\n",
 478               __func__, hash->status, hash->size);
 479
 480         p.cmd = EC_VBOOT_HASH_START;
 481         p.hash_type = EC_VBOOT_HASH_TYPE_SHA256;
 482         p.nonce_size = 0;
 483         p.offset = EC_VBOOT_HASH_OFFSET_RW;
 484
 485         if (ec_command(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p),
 486                        hash, sizeof(*hash)) < 0)
 487                 return -1;
 488
 489         rv = cros_ec_wait_on_hash_done(dev, hash);
 490         if (rv)
 491                 return rv;
 492
 493         debug("%s: hash done\n", __func__);
 494
 495         return 0;
 496 }
 497
 498 static int cros_ec_invalidate_hash(struct cros_ec_dev *dev)
 499 {
 500         struct ec_params_vboot_hash p;
 501         struct ec_response_vboot_hash *hash;
 502
 503         /* We don't have an explict command for the EC to discard its current
 504          * hash value, so we'll just tell it to calculate one that we know is
 505          * wrong (we claim that hashing zero bytes is always invalid).
 506          */
 507         p.cmd = EC_VBOOT_HASH_RECALC;
 508         p.hash_type = EC_VBOOT_HASH_TYPE_SHA256;
 509         p.nonce_size = 0;
 510         p.offset = 0;
 511         p.size = 0;
 512
 513         debug("%s:\n", __func__);
 514
 515         if (ec_command_inptr(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p),
 516                        (uint8_t **)&hash, sizeof(*hash)) < 0)
 517                 return -1;
 518
 519         /* No need to wait for it to finish */
 520         return 0;
 521 }
 522
 523 int cros_ec_reboot(struct cros_ec_dev *dev, enum ec_reboot_cmd cmd,
 524                 uint8_t flags)
 525 {
 526         struct ec_params_reboot_ec p;
 527
 528         p.cmd = cmd;
 529         p.flags = flags;
 530
 531         if (ec_command_inptr(dev, EC_CMD_REBOOT_EC, 0, &p, sizeof(p), NULL, 0)
 532                         < 0)
 533                 return -1;
 534
 535         if (!(flags & EC_REBOOT_FLAG_ON_AP_SHUTDOWN)) {
 536                 /*
 537                  * EC reboot will take place immediately so delay to allow it
 538                  * to complete.  Note that some reboot types (EC_REBOOT_COLD)
 539                  * will reboot the AP as well, in which case we won't actually
 540                  * get to this point.
 541                  */
 542                 /*
 543                  * TODO(rspangler@chromium.org): Would be nice if we had a
 544                  * better way to determine when the reboot is complete.  Could
 545                  * we poll a memory-mapped LPC value?
 546                  */
 547                 udelay(50000);
 548         }
 549
 550         return 0;
 551 }
 552
 553 int cros_ec_interrupt_pending(struct udevice *dev)
 554 {
 555         struct cros_ec_dev *cdev = dev_get_uclass_priv(dev);
 556
 557         /* no interrupt support : always poll */
 558         if (!dm_gpio_is_valid(&cdev->ec_int))
 559                 return -ENOENT;
 560
 561         return dm_gpio_get_value(&cdev->ec_int);
 562 }
 563
 564 int cros_ec_info(struct cros_ec_dev *dev, struct ec_response_mkbp_info *info)
 565 {
 566         if (ec_command(dev, EC_CMD_MKBP_INFO, 0, NULL, 0, info,
 567                        sizeof(*info)) != sizeof(*info))
 568                 return -1;
 569
 570         return 0;
 571 }
 572
 573 int cros_ec_get_host_events(struct cros_ec_dev *dev, uint32_t *events_ptr)
 574 {
 575         struct ec_response_host_event_mask *resp;
 576
 577         /*
 578          * Use the B copy of the event flags, because the main copy is already
 579          * used by ACPI/SMI.
 580          */
 581         if (ec_command_inptr(dev, EC_CMD_HOST_EVENT_GET_B, 0, NULL, 0,
 582                        (uint8_t **)&resp, sizeof(*resp)) < (int)sizeof(*resp))
 583                 return -1;
 584
 585         if (resp->mask & EC_HOST_EVENT_MASK(EC_HOST_EVENT_INVALID))
 586                 return -1;
 587
 588         *events_ptr = resp->mask;
 589         return 0;
 590 }
 591
 592 int cros_ec_clear_host_events(struct cros_ec_dev *dev, uint32_t events)
 593 {
 594         struct ec_params_host_event_mask params;
 595
 596         params.mask = events;
 597
 598         /*
 599          * Use the B copy of the event flags, so it affects the data returned
 600          * by cros_ec_get_host_events().
 601          */
 602         if (ec_command_inptr(dev, EC_CMD_HOST_EVENT_CLEAR_B, 0,
 603                        &params, sizeof(params), NULL, 0) < 0)
 604                 return -1;
 605
 606         return 0;
 607 }
 608
 609 int cros_ec_flash_protect(struct cros_ec_dev *dev,
 610                        uint32_t set_mask, uint32_t set_flags,
 611                        struct ec_response_flash_protect *resp)
 612 {
 613         struct ec_params_flash_protect params;
 614
 615         params.mask = set_mask;
 616         params.flags = set_flags;
 617
 618         if (ec_command(dev, EC_CMD_FLASH_PROTECT, EC_VER_FLASH_PROTECT,
 619                        &params, sizeof(params),
 620                        resp, sizeof(*resp)) != sizeof(*resp))
 621                 return -1;
 622
 623         return 0;
 624 }
 625
 626 static int cros_ec_check_version(struct cros_ec_dev *dev)
 627 {
 628         struct ec_params_hello req;
 629         struct ec_response_hello *resp;
 630
 631         struct dm_cros_ec_ops *ops;
 632         int ret;
 633
 634         ops = dm_cros_ec_get_ops(dev->dev);
 635         if (ops->check_version) {
 636                 ret = ops->check_version(dev->dev);
 637                 if (ret)
 638                         return ret;
 639         }
 640
 641         /*
 642          * TODO(sjg@chromium.org).
 643          * There is a strange oddity here with the EC. We could just ignore
 644          * the response, i.e. pass the last two parameters as NULL and 0.
 645          * In this case we won't read back very many bytes from the EC.
 646          * On the I2C bus the EC gets upset about this and will try to send
 647          * the bytes anyway. This means that we will have to wait for that
 648          * to complete before continuing with a new EC command.
 649          *
 650          * This problem is probably unique to the I2C bus.
 651          *
 652          * So for now, just read all the data anyway.
 653          */
 654
 655         /* Try sending a version 3 packet */
 656         dev->protocol_version = 3;
 657         req.in_data = 0;
 658         if (ec_command_inptr(dev, EC_CMD_HELLO, 0, &req, sizeof(req),
 659                              (uint8_t **)&resp, sizeof(*resp)) > 0) {
 660                 return 0;
 661         }
 662
 663         /* Try sending a version 2 packet */
 664         dev->protocol_version = 2;
 665         if (ec_command_inptr(dev, EC_CMD_HELLO, 0, &req, sizeof(req),
 666                        (uint8_t **)&resp, sizeof(*resp)) > 0) {
 667                 return 0;
 668         }
 669
 670         /*
 671          * Fail if we're still here, since the EC doesn't understand any
 672          * protcol version we speak.  Version 1 interface without command
 673          * version is no longer supported, and we don't know about any new
 674          * protocol versions.
 675          */
 676         dev->protocol_version = 0;
 677         printf("%s: ERROR: old EC interface not supported\n", __func__);
 678         return -1;
 679 }
 680
 681 int cros_ec_test(struct cros_ec_dev *dev)
 682 {
 683         struct ec_params_hello req;
 684         struct ec_response_hello *resp;
 685
 686         req.in_data = 0x12345678;
 687         if (ec_command_inptr(dev, EC_CMD_HELLO, 0, &req, sizeof(req),
 688                        (uint8_t **)&resp, sizeof(*resp)) < sizeof(*resp)) {
 689                 printf("ec_command_inptr() returned error\n");
 690                 return -1;
 691         }
 692         if (resp->out_data != req.in_data + 0x01020304) {
 693                 printf("Received invalid handshake %x\n", resp->out_data);
 694                 return -1;
 695         }
 696
 697         return 0;
 698 }
 699
 700 int cros_ec_flash_offset(struct cros_ec_dev *dev, enum ec_flash_region region,
 701                       uint32_t *offset, uint32_t *size)
 702 {
 703         struct ec_params_flash_region_info p;
 704         struct ec_response_flash_region_info *r;
 705         int ret;
 706
 707         p.region = region;
 708         ret = ec_command_inptr(dev, EC_CMD_FLASH_REGION_INFO,
 709                          EC_VER_FLASH_REGION_INFO,
 710                          &p, sizeof(p), (uint8_t **)&r, sizeof(*r));
 711         if (ret != sizeof(*r))
 712                 return -1;
 713
 714         if (offset)
 715                 *offset = r->offset;
 716         if (size)
 717                 *size = r->size;
 718
 719         return 0;
 720 }
 721
 722 int cros_ec_flash_erase(struct cros_ec_dev *dev, uint32_t offset, uint32_t size)
 723 {
 724         struct ec_params_flash_erase p;
 725
 726         p.offset = offset;
 727         p.size = size;
 728         return ec_command_inptr(dev, EC_CMD_FLASH_ERASE, 0, &p, sizeof(p),
 729                         NULL, 0);
 730 }
 731
 732 /**
 733  * Write a single block to the flash
 734  *
 735  * Write a block of data to the EC flash. The size must not exceed the flash
 736  * write block size which you can obtain from cros_ec_flash_write_burst_size().
 737  *
 738  * The offset starts at 0. You can obtain the region information from
 739  * cros_ec_flash_offset() to find out where to write for a particular region.
 740  *
 741  * Attempting to write to the region where the EC is currently running from
 742  * will result in an error.
 743  *
 744  * @param dev           CROS-EC device
 745  * @param data          Pointer to data buffer to write
 746  * @param offset        Offset within flash to write to.
 747  * @param size          Number of bytes to write
 748  * @return 0 if ok, -1 on error
 749  */
 750 static int cros_ec_flash_write_block(struct cros_ec_dev *dev,
 751                 const uint8_t *data, uint32_t offset, uint32_t size)
 752 {
 753         struct ec_params_flash_write *p;
 754         int ret;
 755
 756         p = malloc(sizeof(*p) + size);
 757         if (!p)
 758                 return -ENOMEM;
 759
 760         p->offset = offset;
 761         p->size = size;
 762         assert(data && p->size <= EC_FLASH_WRITE_VER0_SIZE);
 763         memcpy(p + 1, data, p->size);
 764
 765         ret = ec_command_inptr(dev, EC_CMD_FLASH_WRITE, 0,
 766                           p, sizeof(*p) + size, NULL, 0) >= 0 ? 0 : -1;
 767
 768         free(p);
 769
 770         return ret;
 771 }
 772
 773 /**
 774  * Return optimal flash write burst size
 775  */
 776 static int cros_ec_flash_write_burst_size(struct cros_ec_dev *dev)
 777 {
 778         return EC_FLASH_WRITE_VER0_SIZE;
 779 }
 780
 781 /**
 782  * Check if a block of data is erased (all 0xff)
 783  *
 784  * This function is useful when dealing with flash, for checking whether a
 785  * data block is erased and thus does not need to be programmed.
 786  *
 787  * @param data          Pointer to data to check (must be word-aligned)
 788  * @param size          Number of bytes to check (must be word-aligned)
 789  * @return 0 if erased, non-zero if any word is not erased
 790  */
 791 static int cros_ec_data_is_erased(const uint32_t *data, int size)
 792 {
 793         assert(!(size & 3));
 794         size /= sizeof(uint32_t);
 795         for (; size > 0; size -= 4, data++)
 796                 if (*data != -1U)
 797                         return 0;
 798
 799         return 1;
 800 }
 801
 802 /**
 803  * Read back flash parameters
 804  *
 805  * This function reads back parameters of the flash as reported by the EC
 806  *
 807  * @param dev  Pointer to device
 808  * @param info Pointer to output flash info struct
 809  */
 810 int cros_ec_read_flashinfo(struct cros_ec_dev *dev,
 811                           struct ec_response_flash_info *info)
 812 {
 813         int ret;
 814
 815         ret = ec_command(dev, EC_CMD_FLASH_INFO, 0,
 816                          NULL, 0, info, sizeof(*info));
 817         if (ret < 0)
 818                 return ret;
 819
 820         return ret < sizeof(*info) ? -1 : 0;
 821 }
 822
 823 int cros_ec_flash_write(struct cros_ec_dev *dev, const uint8_t *data,
 824                      uint32_t offset, uint32_t size)
 825 {
 826         uint32_t burst = cros_ec_flash_write_burst_size(dev);
 827         uint32_t end, off;
 828         int ret;
 829
 830         /*
 831          * TODO: round up to the nearest multiple of write size.  Can get away
 832          * without that on link right now because its write size is 4 bytes.
 833          */
 834         end = offset + size;
 835         for (off = offset; off < end; off += burst, data += burst) {
 836                 uint32_t todo;
 837
 838                 /* If the data is empty, there is no point in programming it */
 839                 todo = min(end - off, burst);
 840                 if (dev->optimise_flash_write &&
 841                                 cros_ec_data_is_erased((uint32_t *)data, todo))
 842                         continue;
 843
 844                 ret = cros_ec_flash_write_block(dev, data, off, todo);
 845                 if (ret)
 846                         return ret;
 847         }
 848
 849         return 0;
 850 }
 851
 852 /**
 853  * Read a single block from the flash
 854  *
 855  * Read a block of data from the EC flash. The size must not exceed the flash
 856  * write block size which you can obtain from cros_ec_flash_write_burst_size().
 857  *
 858  * The offset starts at 0. You can obtain the region information from
 859  * cros_ec_flash_offset() to find out where to read for a particular region.
 860  *
 861  * @param dev           CROS-EC device
 862  * @param data          Pointer to data buffer to read into
 863  * @param offset        Offset within flash to read from
 864  * @param size          Number of bytes to read
 865  * @return 0 if ok, -1 on error
 866  */
 867 static int cros_ec_flash_read_block(struct cros_ec_dev *dev, uint8_t *data,
 868                                  uint32_t offset, uint32_t size)
 869 {
 870         struct ec_params_flash_read p;
 871
 872         p.offset = offset;
 873         p.size = size;
 874
 875         return ec_command(dev, EC_CMD_FLASH_READ, 0,
 876                           &p, sizeof(p), data, size) >= 0 ? 0 : -1;
 877 }
 878
 879 int cros_ec_flash_read(struct cros_ec_dev *dev, uint8_t *data, uint32_t offset,
 880                     uint32_t size)
 881 {
 882         uint32_t burst = cros_ec_flash_write_burst_size(dev);
 883         uint32_t end, off;
 884         int ret;
 885
 886         end = offset + size;
 887         for (off = offset; off < end; off += burst, data += burst) {
 888                 ret = cros_ec_flash_read_block(dev, data, off,
 889                                             min(end - off, burst));
 890                 if (ret)
 891                         return ret;
 892         }
 893
 894         return 0;
 895 }
 896
 897 int cros_ec_flash_update_rw(struct cros_ec_dev *dev,
 898                          const uint8_t *image, int image_size)
 899 {
 900         uint32_t rw_offset, rw_size;
 901         int ret;
 902
 903         if (cros_ec_flash_offset(dev, EC_FLASH_REGION_RW, &rw_offset, &rw_size))
 904                 return -1;
 905         if (image_size > (int)rw_size)
 906                 return -1;
 907
 908         /* Invalidate the existing hash, just in case the AP reboots
 909          * unexpectedly during the update. If that happened, the EC RW firmware
 910          * would be invalid, but the EC would still have the original hash.
 911          */
 912         ret = cros_ec_invalidate_hash(dev);
 913         if (ret)
 914                 return ret;
 915
 916         /*
 917          * Erase the entire RW section, so that the EC doesn't see any garbage
 918          * past the new image if it's smaller than the current image.
 919          *
 920          * TODO: could optimize this to erase just the current image, since
 921          * presumably everything past that is 0xff's.  But would still need to
 922          * round up to the nearest multiple of erase size.
 923          */
 924         ret = cros_ec_flash_erase(dev, rw_offset, rw_size);
 925         if (ret)
 926                 return ret;
 927
 928         /* Write the image */
 929         ret = cros_ec_flash_write(dev, image, rw_offset, image_size);
 930         if (ret)
 931                 return ret;
 932
 933         return 0;
 934 }
 935
 936 int cros_ec_read_vbnvcontext(struct cros_ec_dev *dev, uint8_t *block)
 937 {
 938         struct ec_params_vbnvcontext p;
 939         int len;
 940
 941         p.op = EC_VBNV_CONTEXT_OP_READ;
 942
 943         len = ec_command(dev, EC_CMD_VBNV_CONTEXT, EC_VER_VBNV_CONTEXT,
 944                         &p, sizeof(p), block, EC_VBNV_BLOCK_SIZE);
 945         if (len < EC_VBNV_BLOCK_SIZE)
 946                 return -1;
 947
 948         return 0;
 949 }
 950
 951 int cros_ec_write_vbnvcontext(struct cros_ec_dev *dev, const uint8_t *block)
 952 {
 953         struct ec_params_vbnvcontext p;
 954         int len;
 955
 956         p.op = EC_VBNV_CONTEXT_OP_WRITE;
 957         memcpy(p.block, block, sizeof(p.block));
 958
 959         len = ec_command_inptr(dev, EC_CMD_VBNV_CONTEXT, EC_VER_VBNV_CONTEXT,
 960                         &p, sizeof(p), NULL, 0);
 961         if (len < 0)
 962                 return -1;
 963
 964         return 0;
 965 }
 966
 967 int cros_ec_set_ldo(struct udevice *dev, uint8_t index, uint8_t state)
 968 {
 969         struct cros_ec_dev *cdev = dev_get_uclass_priv(dev);
 970         struct ec_params_ldo_set params;
 971
 972         params.index = index;
 973         params.state = state;
 974
 975         if (ec_command_inptr(cdev, EC_CMD_LDO_SET, 0, &params, sizeof(params),
 976                              NULL, 0))
 977                 return -1;
 978
 979         return 0;
 980 }
 981
 982 int cros_ec_get_ldo(struct udevice *dev, uint8_t index, uint8_t *state)
 983 {
 984         struct cros_ec_dev *cdev = dev_get_uclass_priv(dev);
 985         struct ec_params_ldo_get params;
 986         struct ec_response_ldo_get *resp;
 987
 988         params.index = index;
 989
 990         if (ec_command_inptr(cdev, EC_CMD_LDO_GET, 0, &params, sizeof(params),
 991                              (uint8_t **)&resp, sizeof(*resp)) !=
 992                              sizeof(*resp))
 993                 return -1;
 994
 995         *state = resp->state;
 996
 997         return 0;
 998 }
 999
1000 int cros_ec_register(struct udevice *dev)
1001 {
1002         struct cros_ec_dev *cdev = dev_get_uclass_priv(dev);
1003         const void *blob = gd->fdt_blob;
1004         int node = dev->of_offset;
1005         char id[MSG_BYTES];
1006
1007         cdev->dev = dev;
1008         gpio_request_by_name(dev, "ec-interrupt", 0, &cdev->ec_int,
1009                              GPIOD_IS_IN);
1010         cdev->optimise_flash_write = fdtdec_get_bool(blob, node,
1011                                                      "optimise-flash-write");
1012
1013         if (cros_ec_check_version(cdev)) {
1014                 debug("%s: Could not detect CROS-EC version\n", __func__);
1015                 return -CROS_EC_ERR_CHECK_VERSION;
1016         }
1017
1018         if (cros_ec_read_id(cdev, id, sizeof(id))) {
1019                 debug("%s: Could not read KBC ID\n", __func__);
1020                 return -CROS_EC_ERR_READ_ID;
1021         }
1022
1023         /* Remember this device for use by the cros_ec command */
1024         debug("Google Chrome EC v%d CROS-EC driver ready, id '%s'\n",
1025               cdev->protocol_version, id);
1026
1027         return 0;
1028 }
1029
1030 int cros_ec_decode_region(int argc, char * const argv[])
1031 {
1032         if (argc > 0) {
1033                 if (0 == strcmp(*argv, "rw"))
1034                         return EC_FLASH_REGION_RW;
1035                 else if (0 == strcmp(*argv, "ro"))
1036                         return EC_FLASH_REGION_RO;
1037
1038                 debug("%s: Invalid region '%s'\n", __func__, *argv);
1039         } else {
1040                 debug("%s: Missing region parameter\n", __func__);
1041         }
1042
1043         return -1;
1044 }
1045
1046 int cros_ec_decode_ec_flash(const void *blob, int node,
1047                             struct fdt_cros_ec *config)
1048 {
1049         int flash_node;
1050
1051         flash_node = fdt_subnode_offset(blob, node, "flash");
1052         if (flash_node < 0) {
1053                 debug("Failed to find flash node\n");
1054                 return -1;
1055         }
1056
1057         if (fdtdec_read_fmap_entry(blob, flash_node, "flash",
1058                                    &config->flash)) {
1059                 debug("Failed to decode flash node in chrome-ec'\n");
1060                 return -1;
1061         }
1062
1063         config->flash_erase_value = fdtdec_get_int(blob, flash_node,
1064                                                     "erase-value", -1);
1065         for (node = fdt_first_subnode(blob, flash_node); node >= 0;
1066              node = fdt_next_subnode(blob, node)) {
1067                 const char *name = fdt_get_name(blob, node, NULL);
1068                 enum ec_flash_region region;
1069
1070                 if (0 == strcmp(name, "ro")) {
1071                         region = EC_FLASH_REGION_RO;
1072                 } else if (0 == strcmp(name, "rw")) {
1073                         region = EC_FLASH_REGION_RW;
1074                 } else if (0 == strcmp(name, "wp-ro")) {
1075                         region = EC_FLASH_REGION_WP_RO;
1076                 } else {
1077                         debug("Unknown EC flash region name '%s'\n", name);
1078                         return -1;
1079                 }
1080
1081                 if (fdtdec_read_fmap_entry(blob, node, "reg",
1082                                            &config->region[region])) {
1083                         debug("Failed to decode flash region in chrome-ec'\n");
1084                         return -1;
1085                 }
1086         }
1087
1088         return 0;
1089 }
1090
1091 int cros_ec_i2c_tunnel(struct udevice *dev, int port, struct i2c_msg *in,
1092                        int nmsgs)
1093 {
1094         struct cros_ec_dev *cdev = dev_get_uclass_priv(dev);
1095         union {
1096                 struct ec_params_i2c_passthru p;
1097                 uint8_t outbuf[EC_PROTO2_MAX_PARAM_SIZE];
1098         } params;
1099         union {
1100                 struct ec_response_i2c_passthru r;
1101                 uint8_t inbuf[EC_PROTO2_MAX_PARAM_SIZE];
1102         } response;
1103         struct ec_params_i2c_passthru *p = &params.p;
1104         struct ec_response_i2c_passthru *r = &response.r;
1105         struct ec_params_i2c_passthru_msg *msg;
1106         uint8_t *pdata, *read_ptr = NULL;
1107         int read_len;
1108         int size;
1109         int rv;
1110         int i;
1111
1112         p->port = port;
1113
1114         p->num_msgs = nmsgs;
1115         size = sizeof(*p) + p->num_msgs * sizeof(*msg);
1116
1117         /* Create a message to write the register address and optional data */
1118         pdata = (uint8_t *)p + size;
1119
1120         read_len = 0;
1121         for (i = 0, msg = p->msg; i < nmsgs; i++, msg++, in++) {
1122                 bool is_read = in->flags & I2C_M_RD;
1123
1124                 msg->addr_flags = in->addr;
1125                 msg->len = in->len;
1126                 if (is_read) {
1127                         msg->addr_flags |= EC_I2C_FLAG_READ;
1128                         read_len += in->len;
1129                         read_ptr = in->buf;
1130                         if (sizeof(*r) + read_len > sizeof(response)) {
1131                                 puts("Read length too big for buffer\n");
1132                                 return -1;
1133                         }
1134                 } else {
1135                         if (pdata - (uint8_t *)p + in->len > sizeof(params)) {
1136                                 puts("Params too large for buffer\n");
1137                                 return -1;
1138                         }
1139                         memcpy(pdata, in->buf, in->len);
1140                         pdata += in->len;
1141                 }
1142         }
1143
1144         rv = ec_command(cdev, EC_CMD_I2C_PASSTHRU, 0, p, pdata - (uint8_t *)p,
1145                         r, sizeof(*r) + read_len);
1146         if (rv < 0)
1147                 return rv;
1148
1149         /* Parse response */
1150         if (r->i2c_status & EC_I2C_STATUS_ERROR) {
1151                 printf("Transfer failed with status=0x%x\n", r->i2c_status);
1152                 return -1;
1153         }
1154
1155         if (rv < sizeof(*r) + read_len) {
1156                 puts("Truncated read response\n");
1157                 return -1;
1158         }
1159
1160         /* We only support a single read message for each transfer */
1161         if (read_len)
1162                 memcpy(read_ptr, r->data, read_len);
1163
1164         return 0;
1165 }
1166
1167 #ifdef CONFIG_CMD_CROS_EC
1168
1169 /**
1170  * Perform a flash read or write command
1171  *
1172  * @param dev           CROS-EC device to read/write
1173  * @param is_write      1 do to a write, 0 to do a read
1174  * @param argc          Number of arguments
1175  * @param argv          Arguments (2 is region, 3 is address)
1176  * @return 0 for ok, 1 for a usage error or -ve for ec command error
1177  *      (negative EC_RES_...)
1178  */
1179 static int do_read_write(struct cros_ec_dev *dev, int is_write, int argc,
1180                          char * const argv[])
1181 {
1182         uint32_t offset, size = -1U, region_size;
1183         unsigned long addr;
1184         char *endp;
1185         int region;
1186         int ret;
1187
1188         region = cros_ec_decode_region(argc - 2, argv + 2);
1189         if (region == -1)
1190                 return 1;
1191         if (argc < 4)
1192                 return 1;
1193         addr = simple_strtoul(argv[3], &endp, 16);
1194         if (*argv[3] == 0 || *endp != 0)
1195                 return 1;
1196         if (argc > 4) {
1197                 size = simple_strtoul(argv[4], &endp, 16);
1198                 if (*argv[4] == 0 || *endp != 0)
1199                         return 1;
1200         }
1201
1202         ret = cros_ec_flash_offset(dev, region, &offset, &region_size);
1203         if (ret) {
1204                 debug("%s: Could not read region info\n", __func__);
1205                 return ret;
1206         }
1207         if (size == -1U)
1208                 size = region_size;
1209
1210         ret = is_write ?
1211                 cros_ec_flash_write(dev, (uint8_t *)addr, offset, size) :
1212                 cros_ec_flash_read(dev, (uint8_t *)addr, offset, size);
1213         if (ret) {
1214                 debug("%s: Could not %s region\n", __func__,
1215                       is_write ? "write" : "read");
1216                 return ret;
1217         }
1218
1219         return 0;
1220 }
1221
1222 static int do_cros_ec(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1223 {
1224         struct cros_ec_dev *dev;
1225         struct udevice *udev;
1226         const char *cmd;
1227         int ret = 0;
1228
1229         if (argc < 2)
1230                 return CMD_RET_USAGE;
1231
1232         cmd = argv[1];
1233         if (0 == strcmp("init", cmd)) {
1234                 /* Remove any existing device */
1235                 ret = uclass_find_device(UCLASS_CROS_EC, 0, &udev);
1236                 if (!ret)
1237                         device_remove(udev);
1238                 ret = uclass_get_device(UCLASS_CROS_EC, 0, &udev);
1239                 if (ret) {
1240                         printf("Could not init cros_ec device (err %d)\n", ret);
1241                         return 1;
1242                 }
1243                 return 0;
1244         }
1245
1246         ret = uclass_get_device(UCLASS_CROS_EC, 0, &udev);
1247         if (ret) {
1248                 printf("Cannot get cros-ec device (err=%d)\n", ret);
1249                 return 1;
1250         }
1251         dev = dev_get_uclass_priv(udev);
1252         if (0 == strcmp("id", cmd)) {
1253                 char id[MSG_BYTES];
1254
1255                 if (cros_ec_read_id(dev, id, sizeof(id))) {
1256                         debug("%s: Could not read KBC ID\n", __func__);
1257                         return 1;
1258                 }
1259                 printf("%s\n", id);
1260         } else if (0 == strcmp("info", cmd)) {
1261                 struct ec_response_mkbp_info info;
1262
1263                 if (cros_ec_info(dev, &info)) {
1264                         debug("%s: Could not read KBC info\n", __func__);
1265                         return 1;
1266                 }
1267                 printf("rows     = %u\n", info.rows);
1268                 printf("cols     = %u\n", info.cols);
1269                 printf("switches = %#x\n", info.switches);
1270         } else if (0 == strcmp("curimage", cmd)) {
1271                 enum ec_current_image image;
1272
1273                 if (cros_ec_read_current_image(dev, &image)) {
1274                         debug("%s: Could not read KBC image\n", __func__);
1275                         return 1;
1276                 }
1277                 printf("%d\n", image);
1278         } else if (0 == strcmp("hash", cmd)) {
1279                 struct ec_response_vboot_hash hash;
1280                 int i;
1281
1282                 if (cros_ec_read_hash(dev, &hash)) {
1283                         debug("%s: Could not read KBC hash\n", __func__);
1284                         return 1;
1285                 }
1286
1287                 if (hash.hash_type == EC_VBOOT_HASH_TYPE_SHA256)
1288                         printf("type:    SHA-256\n");
1289                 else
1290                         printf("type:    %d\n", hash.hash_type);
1291
1292                 printf("offset:  0x%08x\n", hash.offset);
1293                 printf("size:    0x%08x\n", hash.size);
1294
1295                 printf("digest:  ");
1296                 for (i = 0; i < hash.digest_size; i++)
1297                         printf("%02x", hash.hash_digest[i]);
1298                 printf("\n");
1299         } else if (0 == strcmp("reboot", cmd)) {
1300                 int region;
1301                 enum ec_reboot_cmd cmd;
1302
1303                 if (argc >= 3 && !strcmp(argv[2], "cold"))
1304                         cmd = EC_REBOOT_COLD;
1305                 else {
1306                         region = cros_ec_decode_region(argc - 2, argv + 2);
1307                         if (region == EC_FLASH_REGION_RO)
1308                                 cmd = EC_REBOOT_JUMP_RO;
1309                         else if (region == EC_FLASH_REGION_RW)
1310                                 cmd = EC_REBOOT_JUMP_RW;
1311                         else
1312                                 return CMD_RET_USAGE;
1313                 }
1314
1315                 if (cros_ec_reboot(dev, cmd, 0)) {
1316                         debug("%s: Could not reboot KBC\n", __func__);
1317                         return 1;
1318                 }
1319         } else if (0 == strcmp("events", cmd)) {
1320                 uint32_t events;
1321
1322                 if (cros_ec_get_host_events(dev, &events)) {
1323                         debug("%s: Could not read host events\n", __func__);
1324                         return 1;
1325                 }
1326                 printf("0x%08x\n", events);
1327         } else if (0 == strcmp("clrevents", cmd)) {
1328                 uint32_t events = 0x7fffffff;
1329
1330                 if (argc >= 3)
1331                         events = simple_strtol(argv[2], NULL, 0);
1332
1333                 if (cros_ec_clear_host_events(dev, events)) {
1334                         debug("%s: Could not clear host events\n", __func__);
1335                         return 1;
1336                 }
1337         } else if (0 == strcmp("read", cmd)) {
1338                 ret = do_read_write(dev, 0, argc, argv);
1339                 if (ret > 0)
1340                         return CMD_RET_USAGE;
1341         } else if (0 == strcmp("write", cmd)) {
1342                 ret = do_read_write(dev, 1, argc, argv);
1343                 if (ret > 0)
1344                         return CMD_RET_USAGE;
1345         } else if (0 == strcmp("erase", cmd)) {
1346                 int region = cros_ec_decode_region(argc - 2, argv + 2);
1347                 uint32_t offset, size;
1348
1349                 if (region == -1)
1350                         return CMD_RET_USAGE;
1351                 if (cros_ec_flash_offset(dev, region, &offset, &size)) {
1352                         debug("%s: Could not read region info\n", __func__);
1353                         ret = -1;
1354                 } else {
1355                         ret = cros_ec_flash_erase(dev, offset, size);
1356                         if (ret) {
1357                                 debug("%s: Could not erase region\n",
1358                                       __func__);
1359                         }
1360                 }
1361         } else if (0 == strcmp("regioninfo", cmd)) {
1362                 int region = cros_ec_decode_region(argc - 2, argv + 2);
1363                 uint32_t offset, size;
1364
1365                 if (region == -1)
1366                         return CMD_RET_USAGE;
1367                 ret = cros_ec_flash_offset(dev, region, &offset, &size);
1368                 if (ret) {
1369                         debug("%s: Could not read region info\n", __func__);
1370                 } else {
1371                         printf("Region: %s\n", region == EC_FLASH_REGION_RO ?
1372                                         "RO" : "RW");
1373                         printf("Offset: %x\n", offset);
1374                         printf("Size:   %x\n", size);
1375                 }
1376         } else if (0 == strcmp("flashinfo", cmd)) {
1377                 struct ec_response_flash_info p;
1378
1379                 ret = cros_ec_read_flashinfo(dev, &p);
1380                 if (!ret) {
1381                         printf("Flash size:         %u\n", p.flash_size);
1382                         printf("Write block size:   %u\n", p.write_block_size);
1383                         printf("Erase block size:   %u\n", p.erase_block_size);
1384                 }
1385         } else if (0 == strcmp("vbnvcontext", cmd)) {
1386                 uint8_t block[EC_VBNV_BLOCK_SIZE];
1387                 char buf[3];
1388                 int i, len;
1389                 unsigned long result;
1390
1391                 if (argc <= 2) {
1392                         ret = cros_ec_read_vbnvcontext(dev, block);
1393                         if (!ret) {
1394                                 printf("vbnv_block: ");
1395                                 for (i = 0; i < EC_VBNV_BLOCK_SIZE; i++)
1396                                         printf("%02x", block[i]);
1397                                 putc('\n');
1398                         }
1399                 } else {
1400                         /*
1401                          * TODO(clchiou): Move this to a utility function as
1402                          * cmd_spi might want to call it.
1403                          */
1404                         memset(block, 0, EC_VBNV_BLOCK_SIZE);
1405                         len = strlen(argv[2]);
1406                         buf[2] = '\0';
1407                         for (i = 0; i < EC_VBNV_BLOCK_SIZE; i++) {
1408                                 if (i * 2 >= len)
1409                                         break;
1410                                 buf[0] = argv[2][i * 2];
1411                                 if (i * 2 + 1 >= len)
1412                                         buf[1] = '0';
1413                                 else
1414                                         buf[1] = argv[2][i * 2 + 1];
1415                                 strict_strtoul(buf, 16, &result);
1416                                 block[i] = result;
1417                         }
1418                         ret = cros_ec_write_vbnvcontext(dev, block);
1419                 }
1420                 if (ret) {
1421                         debug("%s: Could not %s VbNvContext\n", __func__,
1422                                         argc <= 2 ?  "read" : "write");
1423                 }
1424         } else if (0 == strcmp("test", cmd)) {
1425                 int result = cros_ec_test(dev);
1426
1427                 if (result)
1428                         printf("Test failed with error %d\n", result);
1429                 else
1430                         puts("Test passed\n");
1431         } else if (0 == strcmp("version", cmd)) {
1432                 struct ec_response_get_version *p;
1433                 char *build_string;
1434
1435                 ret = cros_ec_read_version(dev, &p);
1436                 if (!ret) {
1437                         /* Print versions */
1438                         printf("RO version:    %1.*s\n",
1439                                (int)sizeof(p->version_string_ro),
1440                                p->version_string_ro);
1441                         printf("RW version:    %1.*s\n",
1442                                (int)sizeof(p->version_string_rw),
1443                                p->version_string_rw);
1444                         printf("Firmware copy: %s\n",
1445                                 (p->current_image <
1446                                         ARRAY_SIZE(ec_current_image_name) ?
1447                                 ec_current_image_name[p->current_image] :
1448                                 "?"));
1449                         ret = cros_ec_read_build_info(dev, &build_string);
1450                         if (!ret)
1451                                 printf("Build info:    %s\n", build_string);
1452                 }
1453         } else if (0 == strcmp("ldo", cmd)) {
1454                 uint8_t index, state;
1455                 char *endp;
1456
1457                 if (argc < 3)
1458                         return CMD_RET_USAGE;
1459                 index = simple_strtoul(argv[2], &endp, 10);
1460                 if (*argv[2] == 0 || *endp != 0)
1461                         return CMD_RET_USAGE;
1462                 if (argc > 3) {
1463                         state = simple_strtoul(argv[3], &endp, 10);
1464                         if (*argv[3] == 0 || *endp != 0)
1465                                 return CMD_RET_USAGE;
1466                         ret = cros_ec_set_ldo(udev, index, state);
1467                 } else {
1468                         ret = cros_ec_get_ldo(udev, index, &state);
1469                         if (!ret) {
1470                                 printf("LDO%d: %s\n", index,
1471                                         state == EC_LDO_STATE_ON ?
1472                                         "on" : "off");
1473                         }
1474                 }
1475
1476                 if (ret) {
1477                         debug("%s: Could not access LDO%d\n", __func__, index);
1478                         return ret;
1479                 }
1480         } else {
1481                 return CMD_RET_USAGE;
1482         }
1483
1484         if (ret < 0) {
1485                 printf("Error: CROS-EC command failed (error %d)\n", ret);
1486                 ret = 1;
1487         }
1488
1489         return ret;
1490 }
1491
1492 U_BOOT_CMD(
1493         crosec, 6,      1,      do_cros_ec,
1494         "CROS-EC utility command",
1495         "init                Re-init CROS-EC (done on startup automatically)\n"
1496         "crosec id                  Read CROS-EC ID\n"
1497         "crosec info                Read CROS-EC info\n"
1498         "crosec curimage            Read CROS-EC current image\n"
1499         "crosec hash                Read CROS-EC hash\n"
1500         "crosec reboot [rw | ro | cold]  Reboot CROS-EC\n"
1501         "crosec events              Read CROS-EC host events\n"
1502         "crosec clrevents [mask]    Clear CROS-EC host events\n"
1503         "crosec regioninfo <ro|rw>  Read image info\n"
1504         "crosec flashinfo           Read flash info\n"
1505         "crosec erase <ro|rw>       Erase EC image\n"
1506         "crosec read <ro|rw> <addr> [<size>]   Read EC image\n"
1507         "crosec write <ro|rw> <addr> [<size>]  Write EC image\n"
1508         "crosec vbnvcontext [hexstring]        Read [write] VbNvContext from EC\n"
1509         "crosec ldo <idx> [<state>] Switch/Read LDO state\n"
1510         "crosec test                run tests on cros_ec\n"
1511         "crosec version             Read CROS-EC version"
1512 );
1513 #endif
1514
1515 UCLASS_DRIVER(cros_ec) = {
1516         .id             = UCLASS_CROS_EC,
1517         .name           = "cros_ec",
1518         .per_device_auto_alloc_size = sizeof(struct cros_ec_dev),
1519         .post_bind      = dm_scan_fdt_dev,
1520 };