2 * Chromium OS cros_ec driver
4 * Copyright (c) 2012 The Chromium OS Authors.
6 * SPDX-License-Identifier: GPL-2.0+
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
25 #include <asm/errno.h>
27 #include <asm-generic/gpio.h>
28 #include <dm/device-internal.h>
30 #include <dm/uclass-internal.h>
33 #define debug_trace(fmt, b...) debug(fmt, #b)
35 #define debug_trace(fmt, b...)
39 /* Timeout waiting for a flash erase command to complete */
40 CROS_EC_CMD_TIMEOUT_MS = 5000,
41 /* Timeout waiting for a synchronous hash to be recomputed */
42 CROS_EC_CMD_HASH_TIMEOUT_MS = 2000,
45 DECLARE_GLOBAL_DATA_PTR;
47 /* Note: depends on enum ec_current_image */
48 static const char * const ec_current_image_name[] = {"unknown", "RO", "RW"};
50 void cros_ec_dump_data(const char *name, int cmd, const uint8_t *data, int len)
57 printf("cmd=%#x: ", cmd);
58 for (i = 0; i < len; i++)
59 printf("%02x ", data[i]);
65 * Calculate a simple 8-bit checksum of a data block
67 * @param data Data block to checksum
68 * @param size Size of data block in bytes
69 * @return checksum value (0 to 255)
71 int cros_ec_calc_checksum(const uint8_t *data, int size)
75 for (i = csum = 0; i < size; i++)
81 * Create a request packet for protocol version 3.
83 * The packet is stored in the device's internal output buffer.
85 * @param dev CROS-EC device
86 * @param cmd Command to send (EC_CMD_...)
87 * @param cmd_version Version of command to send (EC_VER_...)
88 * @param dout Output data (may be NULL If dout_len=0)
89 * @param dout_len Size of output data in bytes
90 * @return packet size in bytes, or <0 if error.
92 static int create_proto3_request(struct cros_ec_dev *dev,
93 int cmd, int cmd_version,
94 const void *dout, int dout_len)
96 struct ec_host_request *rq = (struct ec_host_request *)dev->dout;
97 int out_bytes = dout_len + sizeof(*rq);
99 /* Fail if output size is too big */
100 if (out_bytes > (int)sizeof(dev->dout)) {
101 debug("%s: Cannot send %d bytes\n", __func__, dout_len);
102 return -EC_RES_REQUEST_TRUNCATED;
105 /* Fill in request packet */
106 rq->struct_version = EC_HOST_REQUEST_VERSION;
109 rq->command_version = cmd_version;
111 rq->data_len = dout_len;
113 /* Copy data after header */
114 memcpy(rq + 1, dout, dout_len);
116 /* Write checksum field so the entire packet sums to 0 */
117 rq->checksum = (uint8_t)(-cros_ec_calc_checksum(dev->dout, out_bytes));
119 cros_ec_dump_data("out", cmd, dev->dout, out_bytes);
121 /* Return size of request packet */
126 * Prepare the device to receive a protocol version 3 response.
128 * @param dev CROS-EC device
129 * @param din_len Maximum size of response in bytes
130 * @return maximum expected number of bytes in response, or <0 if error.
132 static int prepare_proto3_response_buffer(struct cros_ec_dev *dev, int din_len)
134 int in_bytes = din_len + sizeof(struct ec_host_response);
136 /* Fail if input size is too big */
137 if (in_bytes > (int)sizeof(dev->din)) {
138 debug("%s: Cannot receive %d bytes\n", __func__, din_len);
139 return -EC_RES_RESPONSE_TOO_BIG;
142 /* Return expected size of response packet */
147 * Handle a protocol version 3 response packet.
149 * The packet must already be stored in the device's internal input buffer.
151 * @param dev CROS-EC device
152 * @param dinp Returns pointer to response data
153 * @param din_len Maximum size of response in bytes
154 * @return number of bytes of response data, or <0 if error. Note that error
155 * codes can be from errno.h or -ve EC_RES_INVALID_CHECKSUM values (and they
158 static int handle_proto3_response(struct cros_ec_dev *dev,
159 uint8_t **dinp, int din_len)
161 struct ec_host_response *rs = (struct ec_host_response *)dev->din;
165 cros_ec_dump_data("in-header", -1, dev->din, sizeof(*rs));
167 /* Check input data */
168 if (rs->struct_version != EC_HOST_RESPONSE_VERSION) {
169 debug("%s: EC response version mismatch\n", __func__);
170 return -EC_RES_INVALID_RESPONSE;
174 debug("%s: EC response reserved != 0\n", __func__);
175 return -EC_RES_INVALID_RESPONSE;
178 if (rs->data_len > din_len) {
179 debug("%s: EC returned too much data\n", __func__);
180 return -EC_RES_RESPONSE_TOO_BIG;
183 cros_ec_dump_data("in-data", -1, dev->din + sizeof(*rs), rs->data_len);
185 /* Update in_bytes to actual data size */
186 in_bytes = sizeof(*rs) + rs->data_len;
188 /* Verify checksum */
189 csum = cros_ec_calc_checksum(dev->din, in_bytes);
191 debug("%s: EC response checksum invalid: 0x%02x\n", __func__,
193 return -EC_RES_INVALID_CHECKSUM;
196 /* Return error result, if any */
198 return -(int)rs->result;
200 /* If we're still here, set response data pointer and return length */
201 *dinp = (uint8_t *)(rs + 1);
206 static int send_command_proto3(struct cros_ec_dev *dev,
207 int cmd, int cmd_version,
208 const void *dout, int dout_len,
209 uint8_t **dinp, int din_len)
211 struct dm_cros_ec_ops *ops;
212 int out_bytes, in_bytes;
215 /* Create request packet */
216 out_bytes = create_proto3_request(dev, cmd, cmd_version,
221 /* Prepare response buffer */
222 in_bytes = prepare_proto3_response_buffer(dev, din_len);
226 ops = dm_cros_ec_get_ops(dev->dev);
227 rv = ops->packet ? ops->packet(dev->dev, out_bytes, in_bytes) : -ENOSYS;
231 /* Process the response */
232 return handle_proto3_response(dev, dinp, din_len);
235 static int send_command(struct cros_ec_dev *dev, uint8_t cmd, int cmd_version,
236 const void *dout, int dout_len,
237 uint8_t **dinp, int din_len)
239 struct dm_cros_ec_ops *ops;
242 /* Handle protocol version 3 support */
243 if (dev->protocol_version == 3) {
244 return send_command_proto3(dev, cmd, cmd_version,
245 dout, dout_len, dinp, din_len);
248 ops = dm_cros_ec_get_ops(dev->dev);
249 ret = ops->command(dev->dev, cmd, cmd_version,
250 (const uint8_t *)dout, dout_len, dinp, din_len);
256 * Send a command to the CROS-EC device and return the reply.
258 * The device's internal input/output buffers are used.
260 * @param dev CROS-EC device
261 * @param cmd Command to send (EC_CMD_...)
262 * @param cmd_version Version of command to send (EC_VER_...)
263 * @param dout Output data (may be NULL If dout_len=0)
264 * @param dout_len Size of output data in bytes
265 * @param dinp Response data (may be NULL If din_len=0).
266 * If not NULL, it will be updated to point to the data
267 * and will always be double word aligned (64-bits)
268 * @param din_len Maximum size of response in bytes
269 * @return number of bytes in response, or -ve on error
271 static int ec_command_inptr(struct cros_ec_dev *dev, uint8_t cmd,
272 int cmd_version, const void *dout, int dout_len, uint8_t **dinp,
278 len = send_command(dev, cmd, cmd_version, dout, dout_len,
281 /* If the command doesn't complete, wait a while */
282 if (len == -EC_RES_IN_PROGRESS) {
283 struct ec_response_get_comms_status *resp = NULL;
286 /* Wait for command to complete */
287 start = get_timer(0);
291 mdelay(50); /* Insert some reasonable delay */
292 ret = send_command(dev, EC_CMD_GET_COMMS_STATUS, 0,
294 (uint8_t **)&resp, sizeof(*resp));
298 if (get_timer(start) > CROS_EC_CMD_TIMEOUT_MS) {
299 debug("%s: Command %#02x timeout\n",
301 return -EC_RES_TIMEOUT;
303 } while (resp->flags & EC_COMMS_STATUS_PROCESSING);
305 /* OK it completed, so read the status response */
306 /* not sure why it was 0 for the last argument */
307 len = send_command(dev, EC_CMD_RESEND_RESPONSE, 0,
308 NULL, 0, &din, din_len);
311 debug("%s: len=%d, dinp=%p, *dinp=%p\n", __func__, len, dinp,
312 dinp ? *dinp : NULL);
314 /* If we have any data to return, it must be 64bit-aligned */
315 assert(len <= 0 || !((uintptr_t)din & 7));
323 * Send a command to the CROS-EC device and return the reply.
325 * The device's internal input/output buffers are used.
327 * @param dev CROS-EC device
328 * @param cmd Command to send (EC_CMD_...)
329 * @param cmd_version Version of command to send (EC_VER_...)
330 * @param dout Output data (may be NULL If dout_len=0)
331 * @param dout_len Size of output data in bytes
332 * @param din Response data (may be NULL If din_len=0).
333 * It not NULL, it is a place for ec_command() to copy the
335 * @param din_len Maximum size of response in bytes
336 * @return number of bytes in response, or -ve on error
338 static int ec_command(struct cros_ec_dev *dev, uint8_t cmd, int cmd_version,
339 const void *dout, int dout_len,
340 void *din, int din_len)
345 assert((din_len == 0) || din);
346 len = ec_command_inptr(dev, cmd, cmd_version, dout, dout_len,
347 &in_buffer, din_len);
350 * If we were asked to put it somewhere, do so, otherwise just
351 * disregard the result.
353 if (din && in_buffer) {
354 assert(len <= din_len);
355 memmove(din, in_buffer, len);
361 int cros_ec_scan_keyboard(struct cros_ec_dev *dev, struct mbkp_keyscan *scan)
363 if (ec_command(dev, EC_CMD_MKBP_STATE, 0, NULL, 0, scan,
364 sizeof(scan->data)) != sizeof(scan->data))
370 int cros_ec_read_id(struct cros_ec_dev *dev, char *id, int maxlen)
372 struct ec_response_get_version *r;
374 if (ec_command_inptr(dev, EC_CMD_GET_VERSION, 0, NULL, 0,
375 (uint8_t **)&r, sizeof(*r)) != sizeof(*r))
378 if (maxlen > (int)sizeof(r->version_string_ro))
379 maxlen = sizeof(r->version_string_ro);
381 switch (r->current_image) {
383 memcpy(id, r->version_string_ro, maxlen);
386 memcpy(id, r->version_string_rw, maxlen);
392 id[maxlen - 1] = '\0';
396 int cros_ec_read_version(struct cros_ec_dev *dev,
397 struct ec_response_get_version **versionp)
399 if (ec_command_inptr(dev, EC_CMD_GET_VERSION, 0, NULL, 0,
400 (uint8_t **)versionp, sizeof(**versionp))
401 != sizeof(**versionp))
407 int cros_ec_read_build_info(struct cros_ec_dev *dev, char **strp)
409 if (ec_command_inptr(dev, EC_CMD_GET_BUILD_INFO, 0, NULL, 0,
410 (uint8_t **)strp, EC_PROTO2_MAX_PARAM_SIZE) < 0)
416 int cros_ec_read_current_image(struct cros_ec_dev *dev,
417 enum ec_current_image *image)
419 struct ec_response_get_version *r;
421 if (ec_command_inptr(dev, EC_CMD_GET_VERSION, 0, NULL, 0,
422 (uint8_t **)&r, sizeof(*r)) != sizeof(*r))
425 *image = r->current_image;
429 static int cros_ec_wait_on_hash_done(struct cros_ec_dev *dev,
430 struct ec_response_vboot_hash *hash)
432 struct ec_params_vboot_hash p;
435 start = get_timer(0);
436 while (hash->status == EC_VBOOT_HASH_STATUS_BUSY) {
437 mdelay(50); /* Insert some reasonable delay */
439 p.cmd = EC_VBOOT_HASH_GET;
440 if (ec_command(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p),
441 hash, sizeof(*hash)) < 0)
444 if (get_timer(start) > CROS_EC_CMD_HASH_TIMEOUT_MS) {
445 debug("%s: EC_VBOOT_HASH_GET timeout\n", __func__);
446 return -EC_RES_TIMEOUT;
453 int cros_ec_read_hash(struct cros_ec_dev *dev,
454 struct ec_response_vboot_hash *hash)
456 struct ec_params_vboot_hash p;
459 p.cmd = EC_VBOOT_HASH_GET;
460 if (ec_command(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p),
461 hash, sizeof(*hash)) < 0)
464 /* If the EC is busy calculating the hash, fidget until it's done. */
465 rv = cros_ec_wait_on_hash_done(dev, hash);
469 /* If the hash is valid, we're done. Otherwise, we have to kick it off
470 * again and wait for it to complete. Note that we explicitly assume
471 * that hashing zero bytes is always wrong, even though that would
472 * produce a valid hash value. */
473 if (hash->status == EC_VBOOT_HASH_STATUS_DONE && hash->size)
476 debug("%s: No valid hash (status=%d size=%d). Compute one...\n",
477 __func__, hash->status, hash->size);
479 p.cmd = EC_VBOOT_HASH_START;
480 p.hash_type = EC_VBOOT_HASH_TYPE_SHA256;
482 p.offset = EC_VBOOT_HASH_OFFSET_RW;
484 if (ec_command(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p),
485 hash, sizeof(*hash)) < 0)
488 rv = cros_ec_wait_on_hash_done(dev, hash);
492 debug("%s: hash done\n", __func__);
497 static int cros_ec_invalidate_hash(struct cros_ec_dev *dev)
499 struct ec_params_vboot_hash p;
500 struct ec_response_vboot_hash *hash;
502 /* We don't have an explict command for the EC to discard its current
503 * hash value, so we'll just tell it to calculate one that we know is
504 * wrong (we claim that hashing zero bytes is always invalid).
506 p.cmd = EC_VBOOT_HASH_RECALC;
507 p.hash_type = EC_VBOOT_HASH_TYPE_SHA256;
512 debug("%s:\n", __func__);
514 if (ec_command_inptr(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p),
515 (uint8_t **)&hash, sizeof(*hash)) < 0)
518 /* No need to wait for it to finish */
522 int cros_ec_reboot(struct cros_ec_dev *dev, enum ec_reboot_cmd cmd,
525 struct ec_params_reboot_ec p;
530 if (ec_command_inptr(dev, EC_CMD_REBOOT_EC, 0, &p, sizeof(p), NULL, 0)
534 if (!(flags & EC_REBOOT_FLAG_ON_AP_SHUTDOWN)) {
536 * EC reboot will take place immediately so delay to allow it
537 * to complete. Note that some reboot types (EC_REBOOT_COLD)
538 * will reboot the AP as well, in which case we won't actually
542 * TODO(rspangler@chromium.org): Would be nice if we had a
543 * better way to determine when the reboot is complete. Could
544 * we poll a memory-mapped LPC value?
552 int cros_ec_interrupt_pending(struct cros_ec_dev *dev)
554 /* no interrupt support : always poll */
555 if (!dm_gpio_is_valid(&dev->ec_int))
558 return dm_gpio_get_value(&dev->ec_int);
561 int cros_ec_info(struct cros_ec_dev *dev, struct ec_response_mkbp_info *info)
563 if (ec_command(dev, EC_CMD_MKBP_INFO, 0, NULL, 0, info,
564 sizeof(*info)) != sizeof(*info))
570 int cros_ec_get_host_events(struct cros_ec_dev *dev, uint32_t *events_ptr)
572 struct ec_response_host_event_mask *resp;
575 * Use the B copy of the event flags, because the main copy is already
578 if (ec_command_inptr(dev, EC_CMD_HOST_EVENT_GET_B, 0, NULL, 0,
579 (uint8_t **)&resp, sizeof(*resp)) < (int)sizeof(*resp))
582 if (resp->mask & EC_HOST_EVENT_MASK(EC_HOST_EVENT_INVALID))
585 *events_ptr = resp->mask;
589 int cros_ec_clear_host_events(struct cros_ec_dev *dev, uint32_t events)
591 struct ec_params_host_event_mask params;
593 params.mask = events;
596 * Use the B copy of the event flags, so it affects the data returned
597 * by cros_ec_get_host_events().
599 if (ec_command_inptr(dev, EC_CMD_HOST_EVENT_CLEAR_B, 0,
600 ¶ms, sizeof(params), NULL, 0) < 0)
606 int cros_ec_flash_protect(struct cros_ec_dev *dev,
607 uint32_t set_mask, uint32_t set_flags,
608 struct ec_response_flash_protect *resp)
610 struct ec_params_flash_protect params;
612 params.mask = set_mask;
613 params.flags = set_flags;
615 if (ec_command(dev, EC_CMD_FLASH_PROTECT, EC_VER_FLASH_PROTECT,
616 ¶ms, sizeof(params),
617 resp, sizeof(*resp)) != sizeof(*resp))
623 static int cros_ec_check_version(struct cros_ec_dev *dev)
625 struct ec_params_hello req;
626 struct ec_response_hello *resp;
628 struct dm_cros_ec_ops *ops;
631 ops = dm_cros_ec_get_ops(dev->dev);
632 if (ops->check_version) {
633 ret = ops->check_version(dev->dev);
639 * TODO(sjg@chromium.org).
640 * There is a strange oddity here with the EC. We could just ignore
641 * the response, i.e. pass the last two parameters as NULL and 0.
642 * In this case we won't read back very many bytes from the EC.
643 * On the I2C bus the EC gets upset about this and will try to send
644 * the bytes anyway. This means that we will have to wait for that
645 * to complete before continuing with a new EC command.
647 * This problem is probably unique to the I2C bus.
649 * So for now, just read all the data anyway.
652 /* Try sending a version 3 packet */
653 dev->protocol_version = 3;
655 if (ec_command_inptr(dev, EC_CMD_HELLO, 0, &req, sizeof(req),
656 (uint8_t **)&resp, sizeof(*resp)) > 0) {
660 /* Try sending a version 2 packet */
661 dev->protocol_version = 2;
662 if (ec_command_inptr(dev, EC_CMD_HELLO, 0, &req, sizeof(req),
663 (uint8_t **)&resp, sizeof(*resp)) > 0) {
668 * Fail if we're still here, since the EC doesn't understand any
669 * protcol version we speak. Version 1 interface without command
670 * version is no longer supported, and we don't know about any new
673 dev->protocol_version = 0;
674 printf("%s: ERROR: old EC interface not supported\n", __func__);
678 int cros_ec_test(struct cros_ec_dev *dev)
680 struct ec_params_hello req;
681 struct ec_response_hello *resp;
683 req.in_data = 0x12345678;
684 if (ec_command_inptr(dev, EC_CMD_HELLO, 0, &req, sizeof(req),
685 (uint8_t **)&resp, sizeof(*resp)) < sizeof(*resp)) {
686 printf("ec_command_inptr() returned error\n");
689 if (resp->out_data != req.in_data + 0x01020304) {
690 printf("Received invalid handshake %x\n", resp->out_data);
697 int cros_ec_flash_offset(struct cros_ec_dev *dev, enum ec_flash_region region,
698 uint32_t *offset, uint32_t *size)
700 struct ec_params_flash_region_info p;
701 struct ec_response_flash_region_info *r;
705 ret = ec_command_inptr(dev, EC_CMD_FLASH_REGION_INFO,
706 EC_VER_FLASH_REGION_INFO,
707 &p, sizeof(p), (uint8_t **)&r, sizeof(*r));
708 if (ret != sizeof(*r))
719 int cros_ec_flash_erase(struct cros_ec_dev *dev, uint32_t offset, uint32_t size)
721 struct ec_params_flash_erase p;
725 return ec_command_inptr(dev, EC_CMD_FLASH_ERASE, 0, &p, sizeof(p),
730 * Write a single block to the flash
732 * Write a block of data to the EC flash. The size must not exceed the flash
733 * write block size which you can obtain from cros_ec_flash_write_burst_size().
735 * The offset starts at 0. You can obtain the region information from
736 * cros_ec_flash_offset() to find out where to write for a particular region.
738 * Attempting to write to the region where the EC is currently running from
739 * will result in an error.
741 * @param dev CROS-EC device
742 * @param data Pointer to data buffer to write
743 * @param offset Offset within flash to write to.
744 * @param size Number of bytes to write
745 * @return 0 if ok, -1 on error
747 static int cros_ec_flash_write_block(struct cros_ec_dev *dev,
748 const uint8_t *data, uint32_t offset, uint32_t size)
750 struct ec_params_flash_write p;
754 assert(data && p.size <= EC_FLASH_WRITE_VER0_SIZE);
755 memcpy(&p + 1, data, p.size);
757 return ec_command_inptr(dev, EC_CMD_FLASH_WRITE, 0,
758 &p, sizeof(p), NULL, 0) >= 0 ? 0 : -1;
762 * Return optimal flash write burst size
764 static int cros_ec_flash_write_burst_size(struct cros_ec_dev *dev)
766 return EC_FLASH_WRITE_VER0_SIZE;
770 * Check if a block of data is erased (all 0xff)
772 * This function is useful when dealing with flash, for checking whether a
773 * data block is erased and thus does not need to be programmed.
775 * @param data Pointer to data to check (must be word-aligned)
776 * @param size Number of bytes to check (must be word-aligned)
777 * @return 0 if erased, non-zero if any word is not erased
779 static int cros_ec_data_is_erased(const uint32_t *data, int size)
782 size /= sizeof(uint32_t);
783 for (; size > 0; size -= 4, data++)
790 int cros_ec_flash_write(struct cros_ec_dev *dev, const uint8_t *data,
791 uint32_t offset, uint32_t size)
793 uint32_t burst = cros_ec_flash_write_burst_size(dev);
798 * TODO: round up to the nearest multiple of write size. Can get away
799 * without that on link right now because its write size is 4 bytes.
802 for (off = offset; off < end; off += burst, data += burst) {
805 /* If the data is empty, there is no point in programming it */
806 todo = min(end - off, burst);
807 if (dev->optimise_flash_write &&
808 cros_ec_data_is_erased((uint32_t *)data, todo))
811 ret = cros_ec_flash_write_block(dev, data, off, todo);
820 * Read a single block from the flash
822 * Read a block of data from the EC flash. The size must not exceed the flash
823 * write block size which you can obtain from cros_ec_flash_write_burst_size().
825 * The offset starts at 0. You can obtain the region information from
826 * cros_ec_flash_offset() to find out where to read for a particular region.
828 * @param dev CROS-EC device
829 * @param data Pointer to data buffer to read into
830 * @param offset Offset within flash to read from
831 * @param size Number of bytes to read
832 * @return 0 if ok, -1 on error
834 static int cros_ec_flash_read_block(struct cros_ec_dev *dev, uint8_t *data,
835 uint32_t offset, uint32_t size)
837 struct ec_params_flash_read p;
842 return ec_command(dev, EC_CMD_FLASH_READ, 0,
843 &p, sizeof(p), data, size) >= 0 ? 0 : -1;
846 int cros_ec_flash_read(struct cros_ec_dev *dev, uint8_t *data, uint32_t offset,
849 uint32_t burst = cros_ec_flash_write_burst_size(dev);
854 for (off = offset; off < end; off += burst, data += burst) {
855 ret = cros_ec_flash_read_block(dev, data, off,
856 min(end - off, burst));
864 int cros_ec_flash_update_rw(struct cros_ec_dev *dev,
865 const uint8_t *image, int image_size)
867 uint32_t rw_offset, rw_size;
870 if (cros_ec_flash_offset(dev, EC_FLASH_REGION_RW, &rw_offset, &rw_size))
872 if (image_size > (int)rw_size)
875 /* Invalidate the existing hash, just in case the AP reboots
876 * unexpectedly during the update. If that happened, the EC RW firmware
877 * would be invalid, but the EC would still have the original hash.
879 ret = cros_ec_invalidate_hash(dev);
884 * Erase the entire RW section, so that the EC doesn't see any garbage
885 * past the new image if it's smaller than the current image.
887 * TODO: could optimize this to erase just the current image, since
888 * presumably everything past that is 0xff's. But would still need to
889 * round up to the nearest multiple of erase size.
891 ret = cros_ec_flash_erase(dev, rw_offset, rw_size);
895 /* Write the image */
896 ret = cros_ec_flash_write(dev, image, rw_offset, image_size);
903 int cros_ec_read_vbnvcontext(struct cros_ec_dev *dev, uint8_t *block)
905 struct ec_params_vbnvcontext p;
908 p.op = EC_VBNV_CONTEXT_OP_READ;
910 len = ec_command(dev, EC_CMD_VBNV_CONTEXT, EC_VER_VBNV_CONTEXT,
911 &p, sizeof(p), block, EC_VBNV_BLOCK_SIZE);
912 if (len < EC_VBNV_BLOCK_SIZE)
918 int cros_ec_write_vbnvcontext(struct cros_ec_dev *dev, const uint8_t *block)
920 struct ec_params_vbnvcontext p;
923 p.op = EC_VBNV_CONTEXT_OP_WRITE;
924 memcpy(p.block, block, sizeof(p.block));
926 len = ec_command_inptr(dev, EC_CMD_VBNV_CONTEXT, EC_VER_VBNV_CONTEXT,
927 &p, sizeof(p), NULL, 0);
934 int cros_ec_set_ldo(struct cros_ec_dev *dev, uint8_t index, uint8_t state)
936 struct ec_params_ldo_set params;
938 params.index = index;
939 params.state = state;
941 if (ec_command_inptr(dev, EC_CMD_LDO_SET, 0,
942 ¶ms, sizeof(params),
949 int cros_ec_get_ldo(struct cros_ec_dev *dev, uint8_t index, uint8_t *state)
951 struct ec_params_ldo_get params;
952 struct ec_response_ldo_get *resp;
954 params.index = index;
956 if (ec_command_inptr(dev, EC_CMD_LDO_GET, 0,
957 ¶ms, sizeof(params),
958 (uint8_t **)&resp, sizeof(*resp)) != sizeof(*resp))
961 *state = resp->state;
966 int cros_ec_register(struct udevice *dev)
968 struct cros_ec_dev *cdev = dev_get_uclass_priv(dev);
969 const void *blob = gd->fdt_blob;
970 int node = dev->of_offset;
974 gpio_request_by_name(dev, "ec-interrupt", 0, &cdev->ec_int,
976 cdev->optimise_flash_write = fdtdec_get_bool(blob, node,
977 "optimise-flash-write");
979 if (cros_ec_check_version(cdev)) {
980 debug("%s: Could not detect CROS-EC version\n", __func__);
981 return -CROS_EC_ERR_CHECK_VERSION;
984 if (cros_ec_read_id(cdev, id, sizeof(id))) {
985 debug("%s: Could not read KBC ID\n", __func__);
986 return -CROS_EC_ERR_READ_ID;
989 /* Remember this device for use by the cros_ec command */
990 debug("Google Chrome EC v%d CROS-EC driver ready, id '%s'\n",
991 cdev->protocol_version, id);
996 int cros_ec_decode_region(int argc, char * const argv[])
999 if (0 == strcmp(*argv, "rw"))
1000 return EC_FLASH_REGION_RW;
1001 else if (0 == strcmp(*argv, "ro"))
1002 return EC_FLASH_REGION_RO;
1004 debug("%s: Invalid region '%s'\n", __func__, *argv);
1006 debug("%s: Missing region parameter\n", __func__);
1012 int cros_ec_decode_ec_flash(const void *blob, int node,
1013 struct fdt_cros_ec *config)
1017 flash_node = fdt_subnode_offset(blob, node, "flash");
1018 if (flash_node < 0) {
1019 debug("Failed to find flash node\n");
1023 if (fdtdec_read_fmap_entry(blob, flash_node, "flash",
1025 debug("Failed to decode flash node in chrome-ec'\n");
1029 config->flash_erase_value = fdtdec_get_int(blob, flash_node,
1031 for (node = fdt_first_subnode(blob, flash_node); node >= 0;
1032 node = fdt_next_subnode(blob, node)) {
1033 const char *name = fdt_get_name(blob, node, NULL);
1034 enum ec_flash_region region;
1036 if (0 == strcmp(name, "ro")) {
1037 region = EC_FLASH_REGION_RO;
1038 } else if (0 == strcmp(name, "rw")) {
1039 region = EC_FLASH_REGION_RW;
1040 } else if (0 == strcmp(name, "wp-ro")) {
1041 region = EC_FLASH_REGION_WP_RO;
1043 debug("Unknown EC flash region name '%s'\n", name);
1047 if (fdtdec_read_fmap_entry(blob, node, "reg",
1048 &config->region[region])) {
1049 debug("Failed to decode flash region in chrome-ec'\n");
1057 int cros_ec_i2c_xfer_old(struct cros_ec_dev *dev, uchar chip, uint addr,
1058 int alen, uchar *buffer, int len, int is_read)
1061 struct ec_params_i2c_passthru p;
1062 uint8_t outbuf[EC_PROTO2_MAX_PARAM_SIZE];
1065 struct ec_response_i2c_passthru r;
1066 uint8_t inbuf[EC_PROTO2_MAX_PARAM_SIZE];
1068 struct ec_params_i2c_passthru *p = ¶ms.p;
1069 struct ec_response_i2c_passthru *r = &response.r;
1070 struct ec_params_i2c_passthru_msg *msg = p->msg;
1072 int read_len, write_len;
1079 printf("Unsupported address length %d\n", alen);
1088 write_len = alen + len;
1092 size = sizeof(*p) + p->num_msgs * sizeof(*msg);
1093 if (size + write_len > sizeof(params)) {
1094 puts("Params too large for buffer\n");
1097 if (sizeof(*r) + read_len > sizeof(response)) {
1098 puts("Read length too big for buffer\n");
1102 /* Create a message to write the register address and optional data */
1103 pdata = (uint8_t *)p + size;
1104 msg->addr_flags = chip;
1105 msg->len = write_len;
1108 memcpy(pdata + 1, buffer, len);
1112 msg->addr_flags = chip | EC_I2C_FLAG_READ;
1113 msg->len = read_len;
1116 rv = ec_command(dev, EC_CMD_I2C_PASSTHRU, 0, p, size + write_len,
1117 r, sizeof(*r) + read_len);
1121 /* Parse response */
1122 if (r->i2c_status & EC_I2C_STATUS_ERROR) {
1123 printf("Transfer failed with status=0x%x\n", r->i2c_status);
1127 if (rv < sizeof(*r) + read_len) {
1128 puts("Truncated read response\n");
1133 memcpy(buffer, r->data, read_len);
1138 int cros_ec_i2c_tunnel(struct udevice *dev, struct i2c_msg *in, int nmsgs)
1140 struct cros_ec_dev *cdev = dev_get_uclass_priv(dev);
1142 struct ec_params_i2c_passthru p;
1143 uint8_t outbuf[EC_PROTO2_MAX_PARAM_SIZE];
1146 struct ec_response_i2c_passthru r;
1147 uint8_t inbuf[EC_PROTO2_MAX_PARAM_SIZE];
1149 struct ec_params_i2c_passthru *p = ¶ms.p;
1150 struct ec_response_i2c_passthru *r = &response.r;
1151 struct ec_params_i2c_passthru_msg *msg;
1152 uint8_t *pdata, *read_ptr = NULL;
1160 p->num_msgs = nmsgs;
1161 size = sizeof(*p) + p->num_msgs * sizeof(*msg);
1163 /* Create a message to write the register address and optional data */
1164 pdata = (uint8_t *)p + size;
1167 for (i = 0, msg = p->msg; i < nmsgs; i++, msg++, in++) {
1168 bool is_read = in->flags & I2C_M_RD;
1170 msg->addr_flags = in->addr;
1173 msg->addr_flags |= EC_I2C_FLAG_READ;
1174 read_len += in->len;
1176 if (sizeof(*r) + read_len > sizeof(response)) {
1177 puts("Read length too big for buffer\n");
1181 if (pdata - (uint8_t *)p + in->len > sizeof(params)) {
1182 puts("Params too large for buffer\n");
1185 memcpy(pdata, in->buf, in->len);
1190 rv = ec_command(cdev, EC_CMD_I2C_PASSTHRU, 0, p, pdata - (uint8_t *)p,
1191 r, sizeof(*r) + read_len);
1195 /* Parse response */
1196 if (r->i2c_status & EC_I2C_STATUS_ERROR) {
1197 printf("Transfer failed with status=0x%x\n", r->i2c_status);
1201 if (rv < sizeof(*r) + read_len) {
1202 puts("Truncated read response\n");
1206 /* We only support a single read message for each transfer */
1208 memcpy(read_ptr, r->data, read_len);
1213 #ifdef CONFIG_CMD_CROS_EC
1216 * Perform a flash read or write command
1218 * @param dev CROS-EC device to read/write
1219 * @param is_write 1 do to a write, 0 to do a read
1220 * @param argc Number of arguments
1221 * @param argv Arguments (2 is region, 3 is address)
1222 * @return 0 for ok, 1 for a usage error or -ve for ec command error
1223 * (negative EC_RES_...)
1225 static int do_read_write(struct cros_ec_dev *dev, int is_write, int argc,
1226 char * const argv[])
1228 uint32_t offset, size = -1U, region_size;
1234 region = cros_ec_decode_region(argc - 2, argv + 2);
1239 addr = simple_strtoul(argv[3], &endp, 16);
1240 if (*argv[3] == 0 || *endp != 0)
1243 size = simple_strtoul(argv[4], &endp, 16);
1244 if (*argv[4] == 0 || *endp != 0)
1248 ret = cros_ec_flash_offset(dev, region, &offset, ®ion_size);
1250 debug("%s: Could not read region info\n", __func__);
1257 cros_ec_flash_write(dev, (uint8_t *)addr, offset, size) :
1258 cros_ec_flash_read(dev, (uint8_t *)addr, offset, size);
1260 debug("%s: Could not %s region\n", __func__,
1261 is_write ? "write" : "read");
1269 * get_alen() - Small parser helper function to get address length
1271 * Returns the address length.
1273 static uint get_alen(char *arg)
1279 for (j = 0; j < 8; j++) {
1280 if (arg[j] == '.') {
1281 alen = arg[j+1] - '0';
1283 } else if (arg[j] == '\0') {
1290 #define DISP_LINE_LEN 16
1293 * TODO(sjg@chromium.org): This code copied almost verbatim from cmd_i2c.c
1294 * so we can remove it later.
1296 static int cros_ec_i2c_md(struct cros_ec_dev *dev, int flag, int argc,
1297 char * const argv[])
1300 uint addr, alen, length = 0x10;
1301 int j, nbytes, linebytes;
1304 return CMD_RET_USAGE;
1306 if (1 || (flag & CMD_FLAG_REPEAT) == 0) {
1308 * New command specified.
1314 chip = simple_strtoul(argv[0], NULL, 16);
1317 * I2C data address within the chip. This can be 1 or
1318 * 2 bytes long. Some day it might be 3 bytes long :-).
1320 addr = simple_strtoul(argv[1], NULL, 16);
1321 alen = get_alen(argv[1]);
1323 return CMD_RET_USAGE;
1326 * If another parameter, it is the length to display.
1327 * Length is the number of objects, not number of bytes.
1330 length = simple_strtoul(argv[2], NULL, 16);
1336 * We buffer all read data, so we can make sure data is read only
1341 unsigned char linebuf[DISP_LINE_LEN];
1344 linebytes = (nbytes > DISP_LINE_LEN) ? DISP_LINE_LEN : nbytes;
1346 if (cros_ec_i2c_xfer_old(dev, chip, addr, alen, linebuf,
1348 puts("Error reading the chip.\n");
1350 printf("%04x:", addr);
1352 for (j = 0; j < linebytes; j++) {
1353 printf(" %02x", *cp++);
1358 for (j = 0; j < linebytes; j++) {
1359 if ((*cp < 0x20) || (*cp > 0x7e))
1367 nbytes -= linebytes;
1368 } while (nbytes > 0);
1373 static int cros_ec_i2c_mw(struct cros_ec_dev *dev, int flag, int argc,
1374 char * const argv[])
1382 if ((argc < 3) || (argc > 4))
1383 return CMD_RET_USAGE;
1386 * Chip is always specified.
1388 chip = simple_strtoul(argv[0], NULL, 16);
1391 * Address is always specified.
1393 addr = simple_strtoul(argv[1], NULL, 16);
1394 alen = get_alen(argv[1]);
1396 return CMD_RET_USAGE;
1399 * Value to write is always specified.
1401 byte = simple_strtoul(argv[2], NULL, 16);
1407 count = simple_strtoul(argv[3], NULL, 16);
1411 while (count-- > 0) {
1412 if (cros_ec_i2c_xfer_old(dev, chip, addr++, alen, &byte, 1, 0))
1413 puts("Error writing the chip.\n");
1415 * Wait for the write to complete. The write can take
1416 * up to 10mSec (we allow a little more time).
1419 * No write delay with FRAM devices.
1421 #if !defined(CONFIG_SYS_I2C_FRAM)
1429 /* Temporary code until we have driver model and can use the i2c command */
1430 static int cros_ec_i2c_passthrough(struct cros_ec_dev *dev, int flag,
1431 int argc, char * const argv[])
1436 return CMD_RET_USAGE;
1439 if (0 == strcmp("md", cmd))
1440 cros_ec_i2c_md(dev, flag, argc, argv);
1441 else if (0 == strcmp("mw", cmd))
1442 cros_ec_i2c_mw(dev, flag, argc, argv);
1444 return CMD_RET_USAGE;
1449 static int do_cros_ec(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1451 struct cros_ec_dev *dev;
1452 struct udevice *udev;
1457 return CMD_RET_USAGE;
1460 if (0 == strcmp("init", cmd)) {
1461 /* Remove any existing device */
1462 ret = uclass_find_device(UCLASS_CROS_EC, 0, &udev);
1464 device_remove(udev);
1465 ret = uclass_get_device(UCLASS_CROS_EC, 0, &udev);
1467 printf("Could not init cros_ec device (err %d)\n", ret);
1473 ret = uclass_get_device(UCLASS_CROS_EC, 0, &udev);
1475 printf("Cannot get cros-ec device (err=%d)\n", ret);
1478 dev = dev_get_uclass_priv(udev);
1479 if (0 == strcmp("id", cmd)) {
1482 if (cros_ec_read_id(dev, id, sizeof(id))) {
1483 debug("%s: Could not read KBC ID\n", __func__);
1487 } else if (0 == strcmp("info", cmd)) {
1488 struct ec_response_mkbp_info info;
1490 if (cros_ec_info(dev, &info)) {
1491 debug("%s: Could not read KBC info\n", __func__);
1494 printf("rows = %u\n", info.rows);
1495 printf("cols = %u\n", info.cols);
1496 printf("switches = %#x\n", info.switches);
1497 } else if (0 == strcmp("curimage", cmd)) {
1498 enum ec_current_image image;
1500 if (cros_ec_read_current_image(dev, &image)) {
1501 debug("%s: Could not read KBC image\n", __func__);
1504 printf("%d\n", image);
1505 } else if (0 == strcmp("hash", cmd)) {
1506 struct ec_response_vboot_hash hash;
1509 if (cros_ec_read_hash(dev, &hash)) {
1510 debug("%s: Could not read KBC hash\n", __func__);
1514 if (hash.hash_type == EC_VBOOT_HASH_TYPE_SHA256)
1515 printf("type: SHA-256\n");
1517 printf("type: %d\n", hash.hash_type);
1519 printf("offset: 0x%08x\n", hash.offset);
1520 printf("size: 0x%08x\n", hash.size);
1523 for (i = 0; i < hash.digest_size; i++)
1524 printf("%02x", hash.hash_digest[i]);
1526 } else if (0 == strcmp("reboot", cmd)) {
1528 enum ec_reboot_cmd cmd;
1530 if (argc >= 3 && !strcmp(argv[2], "cold"))
1531 cmd = EC_REBOOT_COLD;
1533 region = cros_ec_decode_region(argc - 2, argv + 2);
1534 if (region == EC_FLASH_REGION_RO)
1535 cmd = EC_REBOOT_JUMP_RO;
1536 else if (region == EC_FLASH_REGION_RW)
1537 cmd = EC_REBOOT_JUMP_RW;
1539 return CMD_RET_USAGE;
1542 if (cros_ec_reboot(dev, cmd, 0)) {
1543 debug("%s: Could not reboot KBC\n", __func__);
1546 } else if (0 == strcmp("events", cmd)) {
1549 if (cros_ec_get_host_events(dev, &events)) {
1550 debug("%s: Could not read host events\n", __func__);
1553 printf("0x%08x\n", events);
1554 } else if (0 == strcmp("clrevents", cmd)) {
1555 uint32_t events = 0x7fffffff;
1558 events = simple_strtol(argv[2], NULL, 0);
1560 if (cros_ec_clear_host_events(dev, events)) {
1561 debug("%s: Could not clear host events\n", __func__);
1564 } else if (0 == strcmp("read", cmd)) {
1565 ret = do_read_write(dev, 0, argc, argv);
1567 return CMD_RET_USAGE;
1568 } else if (0 == strcmp("write", cmd)) {
1569 ret = do_read_write(dev, 1, argc, argv);
1571 return CMD_RET_USAGE;
1572 } else if (0 == strcmp("erase", cmd)) {
1573 int region = cros_ec_decode_region(argc - 2, argv + 2);
1574 uint32_t offset, size;
1577 return CMD_RET_USAGE;
1578 if (cros_ec_flash_offset(dev, region, &offset, &size)) {
1579 debug("%s: Could not read region info\n", __func__);
1582 ret = cros_ec_flash_erase(dev, offset, size);
1584 debug("%s: Could not erase region\n",
1588 } else if (0 == strcmp("regioninfo", cmd)) {
1589 int region = cros_ec_decode_region(argc - 2, argv + 2);
1590 uint32_t offset, size;
1593 return CMD_RET_USAGE;
1594 ret = cros_ec_flash_offset(dev, region, &offset, &size);
1596 debug("%s: Could not read region info\n", __func__);
1598 printf("Region: %s\n", region == EC_FLASH_REGION_RO ?
1600 printf("Offset: %x\n", offset);
1601 printf("Size: %x\n", size);
1603 } else if (0 == strcmp("vbnvcontext", cmd)) {
1604 uint8_t block[EC_VBNV_BLOCK_SIZE];
1607 unsigned long result;
1610 ret = cros_ec_read_vbnvcontext(dev, block);
1612 printf("vbnv_block: ");
1613 for (i = 0; i < EC_VBNV_BLOCK_SIZE; i++)
1614 printf("%02x", block[i]);
1619 * TODO(clchiou): Move this to a utility function as
1620 * cmd_spi might want to call it.
1622 memset(block, 0, EC_VBNV_BLOCK_SIZE);
1623 len = strlen(argv[2]);
1625 for (i = 0; i < EC_VBNV_BLOCK_SIZE; i++) {
1628 buf[0] = argv[2][i * 2];
1629 if (i * 2 + 1 >= len)
1632 buf[1] = argv[2][i * 2 + 1];
1633 strict_strtoul(buf, 16, &result);
1636 ret = cros_ec_write_vbnvcontext(dev, block);
1639 debug("%s: Could not %s VbNvContext\n", __func__,
1640 argc <= 2 ? "read" : "write");
1642 } else if (0 == strcmp("test", cmd)) {
1643 int result = cros_ec_test(dev);
1646 printf("Test failed with error %d\n", result);
1648 puts("Test passed\n");
1649 } else if (0 == strcmp("version", cmd)) {
1650 struct ec_response_get_version *p;
1653 ret = cros_ec_read_version(dev, &p);
1655 /* Print versions */
1656 printf("RO version: %1.*s\n",
1657 (int)sizeof(p->version_string_ro),
1658 p->version_string_ro);
1659 printf("RW version: %1.*s\n",
1660 (int)sizeof(p->version_string_rw),
1661 p->version_string_rw);
1662 printf("Firmware copy: %s\n",
1664 ARRAY_SIZE(ec_current_image_name) ?
1665 ec_current_image_name[p->current_image] :
1667 ret = cros_ec_read_build_info(dev, &build_string);
1669 printf("Build info: %s\n", build_string);
1671 } else if (0 == strcmp("ldo", cmd)) {
1672 uint8_t index, state;
1676 return CMD_RET_USAGE;
1677 index = simple_strtoul(argv[2], &endp, 10);
1678 if (*argv[2] == 0 || *endp != 0)
1679 return CMD_RET_USAGE;
1681 state = simple_strtoul(argv[3], &endp, 10);
1682 if (*argv[3] == 0 || *endp != 0)
1683 return CMD_RET_USAGE;
1684 ret = cros_ec_set_ldo(dev, index, state);
1686 ret = cros_ec_get_ldo(dev, index, &state);
1688 printf("LDO%d: %s\n", index,
1689 state == EC_LDO_STATE_ON ?
1695 debug("%s: Could not access LDO%d\n", __func__, index);
1698 } else if (0 == strcmp("i2c", cmd)) {
1699 ret = cros_ec_i2c_passthrough(dev, flag, argc - 2, argv + 2);
1701 return CMD_RET_USAGE;
1705 printf("Error: CROS-EC command failed (error %d)\n", ret);
1712 int cros_ec_post_bind(struct udevice *dev)
1714 /* Scan for available EC devices (e.g. I2C tunnel) */
1715 return dm_scan_fdt_node(dev, gd->fdt_blob, dev->of_offset, false);
1719 crosec, 6, 1, do_cros_ec,
1720 "CROS-EC utility command",
1721 "init Re-init CROS-EC (done on startup automatically)\n"
1722 "crosec id Read CROS-EC ID\n"
1723 "crosec info Read CROS-EC info\n"
1724 "crosec curimage Read CROS-EC current image\n"
1725 "crosec hash Read CROS-EC hash\n"
1726 "crosec reboot [rw | ro | cold] Reboot CROS-EC\n"
1727 "crosec events Read CROS-EC host events\n"
1728 "crosec clrevents [mask] Clear CROS-EC host events\n"
1729 "crosec regioninfo <ro|rw> Read image info\n"
1730 "crosec erase <ro|rw> Erase EC image\n"
1731 "crosec read <ro|rw> <addr> [<size>] Read EC image\n"
1732 "crosec write <ro|rw> <addr> [<size>] Write EC image\n"
1733 "crosec vbnvcontext [hexstring] Read [write] VbNvContext from EC\n"
1734 "crosec ldo <idx> [<state>] Switch/Read LDO state\n"
1735 "crosec test run tests on cros_ec\n"
1736 "crosec version Read CROS-EC version\n"
1737 "crosec i2c md chip address[.0, .1, .2] [# of objects] - read from I2C passthru\n"
1738 "crosec i2c mw chip address[.0, .1, .2] value [count] - write to I2C passthru (fill)"
1742 UCLASS_DRIVER(cros_ec) = {
1743 .id = UCLASS_CROS_EC,
1745 .per_device_auto_alloc_size = sizeof(struct cros_ec_dev),
1746 .post_bind = cros_ec_post_bind,