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 <linux/errno.h>
27 #include <asm-generic/gpio.h>
28 #include <dm/device-internal.h>
29 #include <dm/uclass-internal.h>
32 #define debug_trace(fmt, b...) debug(fmt, #b)
34 #define debug_trace(fmt, b...)
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,
44 DECLARE_GLOBAL_DATA_PTR;
46 void cros_ec_dump_data(const char *name, int cmd, const uint8_t *data, int len)
53 printf("cmd=%#x: ", cmd);
54 for (i = 0; i < len; i++)
55 printf("%02x ", data[i]);
61 * Calculate a simple 8-bit checksum of a data block
63 * @param data Data block to checksum
64 * @param size Size of data block in bytes
65 * @return checksum value (0 to 255)
67 int cros_ec_calc_checksum(const uint8_t *data, int size)
71 for (i = csum = 0; i < size; i++)
77 * Create a request packet for protocol version 3.
79 * The packet is stored in the device's internal output buffer.
81 * @param dev CROS-EC device
82 * @param cmd Command to send (EC_CMD_...)
83 * @param cmd_version Version of command to send (EC_VER_...)
84 * @param dout Output data (may be NULL If dout_len=0)
85 * @param dout_len Size of output data in bytes
86 * @return packet size in bytes, or <0 if error.
88 static int create_proto3_request(struct cros_ec_dev *dev,
89 int cmd, int cmd_version,
90 const void *dout, int dout_len)
92 struct ec_host_request *rq = (struct ec_host_request *)dev->dout;
93 int out_bytes = dout_len + sizeof(*rq);
95 /* Fail if output size is too big */
96 if (out_bytes > (int)sizeof(dev->dout)) {
97 debug("%s: Cannot send %d bytes\n", __func__, dout_len);
98 return -EC_RES_REQUEST_TRUNCATED;
101 /* Fill in request packet */
102 rq->struct_version = EC_HOST_REQUEST_VERSION;
105 rq->command_version = cmd_version;
107 rq->data_len = dout_len;
109 /* Copy data after header */
110 memcpy(rq + 1, dout, dout_len);
112 /* Write checksum field so the entire packet sums to 0 */
113 rq->checksum = (uint8_t)(-cros_ec_calc_checksum(dev->dout, out_bytes));
115 cros_ec_dump_data("out", cmd, dev->dout, out_bytes);
117 /* Return size of request packet */
122 * Prepare the device to receive a protocol version 3 response.
124 * @param dev CROS-EC device
125 * @param din_len Maximum size of response in bytes
126 * @return maximum expected number of bytes in response, or <0 if error.
128 static int prepare_proto3_response_buffer(struct cros_ec_dev *dev, int din_len)
130 int in_bytes = din_len + sizeof(struct ec_host_response);
132 /* Fail if input size is too big */
133 if (in_bytes > (int)sizeof(dev->din)) {
134 debug("%s: Cannot receive %d bytes\n", __func__, din_len);
135 return -EC_RES_RESPONSE_TOO_BIG;
138 /* Return expected size of response packet */
143 * Handle a protocol version 3 response packet.
145 * The packet must already be stored in the device's internal input buffer.
147 * @param dev CROS-EC device
148 * @param dinp Returns pointer to response data
149 * @param din_len Maximum size of response in bytes
150 * @return number of bytes of response data, or <0 if error. Note that error
151 * codes can be from errno.h or -ve EC_RES_INVALID_CHECKSUM values (and they
154 static int handle_proto3_response(struct cros_ec_dev *dev,
155 uint8_t **dinp, int din_len)
157 struct ec_host_response *rs = (struct ec_host_response *)dev->din;
161 cros_ec_dump_data("in-header", -1, dev->din, sizeof(*rs));
163 /* Check input data */
164 if (rs->struct_version != EC_HOST_RESPONSE_VERSION) {
165 debug("%s: EC response version mismatch\n", __func__);
166 return -EC_RES_INVALID_RESPONSE;
170 debug("%s: EC response reserved != 0\n", __func__);
171 return -EC_RES_INVALID_RESPONSE;
174 if (rs->data_len > din_len) {
175 debug("%s: EC returned too much data\n", __func__);
176 return -EC_RES_RESPONSE_TOO_BIG;
179 cros_ec_dump_data("in-data", -1, dev->din + sizeof(*rs), rs->data_len);
181 /* Update in_bytes to actual data size */
182 in_bytes = sizeof(*rs) + rs->data_len;
184 /* Verify checksum */
185 csum = cros_ec_calc_checksum(dev->din, in_bytes);
187 debug("%s: EC response checksum invalid: 0x%02x\n", __func__,
189 return -EC_RES_INVALID_CHECKSUM;
192 /* Return error result, if any */
194 return -(int)rs->result;
196 /* If we're still here, set response data pointer and return length */
197 *dinp = (uint8_t *)(rs + 1);
202 static int send_command_proto3(struct cros_ec_dev *dev,
203 int cmd, int cmd_version,
204 const void *dout, int dout_len,
205 uint8_t **dinp, int din_len)
207 struct dm_cros_ec_ops *ops;
208 int out_bytes, in_bytes;
211 /* Create request packet */
212 out_bytes = create_proto3_request(dev, cmd, cmd_version,
217 /* Prepare response buffer */
218 in_bytes = prepare_proto3_response_buffer(dev, din_len);
222 ops = dm_cros_ec_get_ops(dev->dev);
223 rv = ops->packet ? ops->packet(dev->dev, out_bytes, in_bytes) : -ENOSYS;
227 /* Process the response */
228 return handle_proto3_response(dev, dinp, din_len);
231 static int send_command(struct cros_ec_dev *dev, uint8_t cmd, int cmd_version,
232 const void *dout, int dout_len,
233 uint8_t **dinp, int din_len)
235 struct dm_cros_ec_ops *ops;
238 /* Handle protocol version 3 support */
239 if (dev->protocol_version == 3) {
240 return send_command_proto3(dev, cmd, cmd_version,
241 dout, dout_len, dinp, din_len);
244 ops = dm_cros_ec_get_ops(dev->dev);
245 ret = ops->command(dev->dev, cmd, cmd_version,
246 (const uint8_t *)dout, dout_len, dinp, din_len);
252 * Send a command to the CROS-EC device and return the reply.
254 * The device's internal input/output buffers are used.
256 * @param dev CROS-EC device
257 * @param cmd Command to send (EC_CMD_...)
258 * @param cmd_version Version of command to send (EC_VER_...)
259 * @param dout Output data (may be NULL If dout_len=0)
260 * @param dout_len Size of output data in bytes
261 * @param dinp Response data (may be NULL If din_len=0).
262 * If not NULL, it will be updated to point to the data
263 * and will always be double word aligned (64-bits)
264 * @param din_len Maximum size of response in bytes
265 * @return number of bytes in response, or -ve on error
267 static int ec_command_inptr(struct cros_ec_dev *dev, uint8_t cmd,
268 int cmd_version, const void *dout, int dout_len, uint8_t **dinp,
274 len = send_command(dev, cmd, cmd_version, dout, dout_len,
277 /* If the command doesn't complete, wait a while */
278 if (len == -EC_RES_IN_PROGRESS) {
279 struct ec_response_get_comms_status *resp = NULL;
282 /* Wait for command to complete */
283 start = get_timer(0);
287 mdelay(50); /* Insert some reasonable delay */
288 ret = send_command(dev, EC_CMD_GET_COMMS_STATUS, 0,
290 (uint8_t **)&resp, sizeof(*resp));
294 if (get_timer(start) > CROS_EC_CMD_TIMEOUT_MS) {
295 debug("%s: Command %#02x timeout\n",
297 return -EC_RES_TIMEOUT;
299 } while (resp->flags & EC_COMMS_STATUS_PROCESSING);
301 /* OK it completed, so read the status response */
302 /* not sure why it was 0 for the last argument */
303 len = send_command(dev, EC_CMD_RESEND_RESPONSE, 0,
304 NULL, 0, &din, din_len);
307 debug("%s: len=%d, din=%p\n", __func__, len, din);
309 /* If we have any data to return, it must be 64bit-aligned */
310 assert(len <= 0 || !((uintptr_t)din & 7));
318 * Send a command to the CROS-EC device and return the reply.
320 * The device's internal input/output buffers are used.
322 * @param dev CROS-EC device
323 * @param cmd Command to send (EC_CMD_...)
324 * @param cmd_version Version of command to send (EC_VER_...)
325 * @param dout Output data (may be NULL If dout_len=0)
326 * @param dout_len Size of output data in bytes
327 * @param din Response data (may be NULL If din_len=0).
328 * It not NULL, it is a place for ec_command() to copy the
330 * @param din_len Maximum size of response in bytes
331 * @return number of bytes in response, or -ve on error
333 static int ec_command(struct cros_ec_dev *dev, uint8_t cmd, int cmd_version,
334 const void *dout, int dout_len,
335 void *din, int din_len)
340 assert((din_len == 0) || din);
341 len = ec_command_inptr(dev, cmd, cmd_version, dout, dout_len,
342 &in_buffer, din_len);
345 * If we were asked to put it somewhere, do so, otherwise just
346 * disregard the result.
348 if (din && in_buffer) {
349 assert(len <= din_len);
350 memmove(din, in_buffer, len);
356 int cros_ec_scan_keyboard(struct udevice *dev, struct mbkp_keyscan *scan)
358 struct cros_ec_dev *cdev = dev_get_uclass_priv(dev);
360 if (ec_command(cdev, EC_CMD_MKBP_STATE, 0, NULL, 0, scan,
361 sizeof(scan->data)) != sizeof(scan->data))
367 int cros_ec_read_id(struct cros_ec_dev *dev, char *id, int maxlen)
369 struct ec_response_get_version *r;
371 if (ec_command_inptr(dev, EC_CMD_GET_VERSION, 0, NULL, 0,
372 (uint8_t **)&r, sizeof(*r)) != sizeof(*r))
375 if (maxlen > (int)sizeof(r->version_string_ro))
376 maxlen = sizeof(r->version_string_ro);
378 switch (r->current_image) {
380 memcpy(id, r->version_string_ro, maxlen);
383 memcpy(id, r->version_string_rw, maxlen);
389 id[maxlen - 1] = '\0';
393 int cros_ec_read_version(struct cros_ec_dev *dev,
394 struct ec_response_get_version **versionp)
396 if (ec_command_inptr(dev, EC_CMD_GET_VERSION, 0, NULL, 0,
397 (uint8_t **)versionp, sizeof(**versionp))
398 != sizeof(**versionp))
404 int cros_ec_read_build_info(struct cros_ec_dev *dev, char **strp)
406 if (ec_command_inptr(dev, EC_CMD_GET_BUILD_INFO, 0, NULL, 0,
407 (uint8_t **)strp, EC_PROTO2_MAX_PARAM_SIZE) < 0)
413 int cros_ec_read_current_image(struct cros_ec_dev *dev,
414 enum ec_current_image *image)
416 struct ec_response_get_version *r;
418 if (ec_command_inptr(dev, EC_CMD_GET_VERSION, 0, NULL, 0,
419 (uint8_t **)&r, sizeof(*r)) != sizeof(*r))
422 *image = r->current_image;
426 static int cros_ec_wait_on_hash_done(struct cros_ec_dev *dev,
427 struct ec_response_vboot_hash *hash)
429 struct ec_params_vboot_hash p;
432 start = get_timer(0);
433 while (hash->status == EC_VBOOT_HASH_STATUS_BUSY) {
434 mdelay(50); /* Insert some reasonable delay */
436 p.cmd = EC_VBOOT_HASH_GET;
437 if (ec_command(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p),
438 hash, sizeof(*hash)) < 0)
441 if (get_timer(start) > CROS_EC_CMD_HASH_TIMEOUT_MS) {
442 debug("%s: EC_VBOOT_HASH_GET timeout\n", __func__);
443 return -EC_RES_TIMEOUT;
450 int cros_ec_read_hash(struct cros_ec_dev *dev,
451 struct ec_response_vboot_hash *hash)
453 struct ec_params_vboot_hash p;
456 p.cmd = EC_VBOOT_HASH_GET;
457 if (ec_command(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p),
458 hash, sizeof(*hash)) < 0)
461 /* If the EC is busy calculating the hash, fidget until it's done. */
462 rv = cros_ec_wait_on_hash_done(dev, hash);
466 /* If the hash is valid, we're done. Otherwise, we have to kick it off
467 * again and wait for it to complete. Note that we explicitly assume
468 * that hashing zero bytes is always wrong, even though that would
469 * produce a valid hash value. */
470 if (hash->status == EC_VBOOT_HASH_STATUS_DONE && hash->size)
473 debug("%s: No valid hash (status=%d size=%d). Compute one...\n",
474 __func__, hash->status, hash->size);
476 p.cmd = EC_VBOOT_HASH_START;
477 p.hash_type = EC_VBOOT_HASH_TYPE_SHA256;
479 p.offset = EC_VBOOT_HASH_OFFSET_RW;
481 if (ec_command(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p),
482 hash, sizeof(*hash)) < 0)
485 rv = cros_ec_wait_on_hash_done(dev, hash);
489 debug("%s: hash done\n", __func__);
494 static int cros_ec_invalidate_hash(struct cros_ec_dev *dev)
496 struct ec_params_vboot_hash p;
497 struct ec_response_vboot_hash *hash;
499 /* We don't have an explict command for the EC to discard its current
500 * hash value, so we'll just tell it to calculate one that we know is
501 * wrong (we claim that hashing zero bytes is always invalid).
503 p.cmd = EC_VBOOT_HASH_RECALC;
504 p.hash_type = EC_VBOOT_HASH_TYPE_SHA256;
509 debug("%s:\n", __func__);
511 if (ec_command_inptr(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p),
512 (uint8_t **)&hash, sizeof(*hash)) < 0)
515 /* No need to wait for it to finish */
519 int cros_ec_reboot(struct cros_ec_dev *dev, enum ec_reboot_cmd cmd,
522 struct ec_params_reboot_ec p;
527 if (ec_command_inptr(dev, EC_CMD_REBOOT_EC, 0, &p, sizeof(p), NULL, 0)
531 if (!(flags & EC_REBOOT_FLAG_ON_AP_SHUTDOWN)) {
533 * EC reboot will take place immediately so delay to allow it
534 * to complete. Note that some reboot types (EC_REBOOT_COLD)
535 * will reboot the AP as well, in which case we won't actually
539 * TODO(rspangler@chromium.org): Would be nice if we had a
540 * better way to determine when the reboot is complete. Could
541 * we poll a memory-mapped LPC value?
549 int cros_ec_interrupt_pending(struct udevice *dev)
551 struct cros_ec_dev *cdev = dev_get_uclass_priv(dev);
553 /* no interrupt support : always poll */
554 if (!dm_gpio_is_valid(&cdev->ec_int))
557 return dm_gpio_get_value(&cdev->ec_int);
560 int cros_ec_info(struct cros_ec_dev *dev, struct ec_response_mkbp_info *info)
562 if (ec_command(dev, EC_CMD_MKBP_INFO, 0, NULL, 0, info,
563 sizeof(*info)) != sizeof(*info))
569 int cros_ec_get_host_events(struct cros_ec_dev *dev, uint32_t *events_ptr)
571 struct ec_response_host_event_mask *resp;
574 * Use the B copy of the event flags, because the main copy is already
577 if (ec_command_inptr(dev, EC_CMD_HOST_EVENT_GET_B, 0, NULL, 0,
578 (uint8_t **)&resp, sizeof(*resp)) < (int)sizeof(*resp))
581 if (resp->mask & EC_HOST_EVENT_MASK(EC_HOST_EVENT_INVALID))
584 *events_ptr = resp->mask;
588 int cros_ec_clear_host_events(struct cros_ec_dev *dev, uint32_t events)
590 struct ec_params_host_event_mask params;
592 params.mask = events;
595 * Use the B copy of the event flags, so it affects the data returned
596 * by cros_ec_get_host_events().
598 if (ec_command_inptr(dev, EC_CMD_HOST_EVENT_CLEAR_B, 0,
599 ¶ms, sizeof(params), NULL, 0) < 0)
605 int cros_ec_flash_protect(struct cros_ec_dev *dev,
606 uint32_t set_mask, uint32_t set_flags,
607 struct ec_response_flash_protect *resp)
609 struct ec_params_flash_protect params;
611 params.mask = set_mask;
612 params.flags = set_flags;
614 if (ec_command(dev, EC_CMD_FLASH_PROTECT, EC_VER_FLASH_PROTECT,
615 ¶ms, sizeof(params),
616 resp, sizeof(*resp)) != sizeof(*resp))
622 static int cros_ec_check_version(struct cros_ec_dev *dev)
624 struct ec_params_hello req;
625 struct ec_response_hello *resp;
627 struct dm_cros_ec_ops *ops;
630 ops = dm_cros_ec_get_ops(dev->dev);
631 if (ops->check_version) {
632 ret = ops->check_version(dev->dev);
638 * TODO(sjg@chromium.org).
639 * There is a strange oddity here with the EC. We could just ignore
640 * the response, i.e. pass the last two parameters as NULL and 0.
641 * In this case we won't read back very many bytes from the EC.
642 * On the I2C bus the EC gets upset about this and will try to send
643 * the bytes anyway. This means that we will have to wait for that
644 * to complete before continuing with a new EC command.
646 * This problem is probably unique to the I2C bus.
648 * So for now, just read all the data anyway.
651 /* Try sending a version 3 packet */
652 dev->protocol_version = 3;
654 if (ec_command_inptr(dev, EC_CMD_HELLO, 0, &req, sizeof(req),
655 (uint8_t **)&resp, sizeof(*resp)) > 0) {
659 /* Try sending a version 2 packet */
660 dev->protocol_version = 2;
661 if (ec_command_inptr(dev, EC_CMD_HELLO, 0, &req, sizeof(req),
662 (uint8_t **)&resp, sizeof(*resp)) > 0) {
667 * Fail if we're still here, since the EC doesn't understand any
668 * protcol version we speak. Version 1 interface without command
669 * version is no longer supported, and we don't know about any new
672 dev->protocol_version = 0;
673 printf("%s: ERROR: old EC interface not supported\n", __func__);
677 int cros_ec_test(struct cros_ec_dev *dev)
679 struct ec_params_hello req;
680 struct ec_response_hello *resp;
682 req.in_data = 0x12345678;
683 if (ec_command_inptr(dev, EC_CMD_HELLO, 0, &req, sizeof(req),
684 (uint8_t **)&resp, sizeof(*resp)) < sizeof(*resp)) {
685 printf("ec_command_inptr() returned error\n");
688 if (resp->out_data != req.in_data + 0x01020304) {
689 printf("Received invalid handshake %x\n", resp->out_data);
696 int cros_ec_flash_offset(struct cros_ec_dev *dev, enum ec_flash_region region,
697 uint32_t *offset, uint32_t *size)
699 struct ec_params_flash_region_info p;
700 struct ec_response_flash_region_info *r;
704 ret = ec_command_inptr(dev, EC_CMD_FLASH_REGION_INFO,
705 EC_VER_FLASH_REGION_INFO,
706 &p, sizeof(p), (uint8_t **)&r, sizeof(*r));
707 if (ret != sizeof(*r))
718 int cros_ec_flash_erase(struct cros_ec_dev *dev, uint32_t offset, uint32_t size)
720 struct ec_params_flash_erase p;
724 return ec_command_inptr(dev, EC_CMD_FLASH_ERASE, 0, &p, sizeof(p),
729 * Write a single block to the flash
731 * Write a block of data to the EC flash. The size must not exceed the flash
732 * write block size which you can obtain from cros_ec_flash_write_burst_size().
734 * The offset starts at 0. You can obtain the region information from
735 * cros_ec_flash_offset() to find out where to write for a particular region.
737 * Attempting to write to the region where the EC is currently running from
738 * will result in an error.
740 * @param dev CROS-EC device
741 * @param data Pointer to data buffer to write
742 * @param offset Offset within flash to write to.
743 * @param size Number of bytes to write
744 * @return 0 if ok, -1 on error
746 static int cros_ec_flash_write_block(struct cros_ec_dev *dev,
747 const uint8_t *data, uint32_t offset, uint32_t size)
749 struct ec_params_flash_write *p;
752 p = malloc(sizeof(*p) + size);
758 assert(data && p->size <= EC_FLASH_WRITE_VER0_SIZE);
759 memcpy(p + 1, data, p->size);
761 ret = ec_command_inptr(dev, EC_CMD_FLASH_WRITE, 0,
762 p, sizeof(*p) + size, NULL, 0) >= 0 ? 0 : -1;
770 * Return optimal flash write burst size
772 static int cros_ec_flash_write_burst_size(struct cros_ec_dev *dev)
774 return EC_FLASH_WRITE_VER0_SIZE;
778 * Check if a block of data is erased (all 0xff)
780 * This function is useful when dealing with flash, for checking whether a
781 * data block is erased and thus does not need to be programmed.
783 * @param data Pointer to data to check (must be word-aligned)
784 * @param size Number of bytes to check (must be word-aligned)
785 * @return 0 if erased, non-zero if any word is not erased
787 static int cros_ec_data_is_erased(const uint32_t *data, int size)
790 size /= sizeof(uint32_t);
791 for (; size > 0; size -= 4, data++)
799 * Read back flash parameters
801 * This function reads back parameters of the flash as reported by the EC
803 * @param dev Pointer to device
804 * @param info Pointer to output flash info struct
806 int cros_ec_read_flashinfo(struct cros_ec_dev *dev,
807 struct ec_response_flash_info *info)
811 ret = ec_command(dev, EC_CMD_FLASH_INFO, 0,
812 NULL, 0, info, sizeof(*info));
816 return ret < sizeof(*info) ? -1 : 0;
819 int cros_ec_flash_write(struct cros_ec_dev *dev, const uint8_t *data,
820 uint32_t offset, uint32_t size)
822 uint32_t burst = cros_ec_flash_write_burst_size(dev);
827 * TODO: round up to the nearest multiple of write size. Can get away
828 * without that on link right now because its write size is 4 bytes.
831 for (off = offset; off < end; off += burst, data += burst) {
834 /* If the data is empty, there is no point in programming it */
835 todo = min(end - off, burst);
836 if (dev->optimise_flash_write &&
837 cros_ec_data_is_erased((uint32_t *)data, todo))
840 ret = cros_ec_flash_write_block(dev, data, off, todo);
849 * Read a single block from the flash
851 * Read a block of data from the EC flash. The size must not exceed the flash
852 * write block size which you can obtain from cros_ec_flash_write_burst_size().
854 * The offset starts at 0. You can obtain the region information from
855 * cros_ec_flash_offset() to find out where to read for a particular region.
857 * @param dev CROS-EC device
858 * @param data Pointer to data buffer to read into
859 * @param offset Offset within flash to read from
860 * @param size Number of bytes to read
861 * @return 0 if ok, -1 on error
863 static int cros_ec_flash_read_block(struct cros_ec_dev *dev, uint8_t *data,
864 uint32_t offset, uint32_t size)
866 struct ec_params_flash_read p;
871 return ec_command(dev, EC_CMD_FLASH_READ, 0,
872 &p, sizeof(p), data, size) >= 0 ? 0 : -1;
875 int cros_ec_flash_read(struct cros_ec_dev *dev, uint8_t *data, uint32_t offset,
878 uint32_t burst = cros_ec_flash_write_burst_size(dev);
883 for (off = offset; off < end; off += burst, data += burst) {
884 ret = cros_ec_flash_read_block(dev, data, off,
885 min(end - off, burst));
893 int cros_ec_flash_update_rw(struct cros_ec_dev *dev,
894 const uint8_t *image, int image_size)
896 uint32_t rw_offset, rw_size;
899 if (cros_ec_flash_offset(dev, EC_FLASH_REGION_RW, &rw_offset, &rw_size))
901 if (image_size > (int)rw_size)
904 /* Invalidate the existing hash, just in case the AP reboots
905 * unexpectedly during the update. If that happened, the EC RW firmware
906 * would be invalid, but the EC would still have the original hash.
908 ret = cros_ec_invalidate_hash(dev);
913 * Erase the entire RW section, so that the EC doesn't see any garbage
914 * past the new image if it's smaller than the current image.
916 * TODO: could optimize this to erase just the current image, since
917 * presumably everything past that is 0xff's. But would still need to
918 * round up to the nearest multiple of erase size.
920 ret = cros_ec_flash_erase(dev, rw_offset, rw_size);
924 /* Write the image */
925 ret = cros_ec_flash_write(dev, image, rw_offset, image_size);
932 int cros_ec_read_vbnvcontext(struct cros_ec_dev *dev, uint8_t *block)
934 struct ec_params_vbnvcontext p;
937 p.op = EC_VBNV_CONTEXT_OP_READ;
939 len = ec_command(dev, EC_CMD_VBNV_CONTEXT, EC_VER_VBNV_CONTEXT,
940 &p, sizeof(p), block, EC_VBNV_BLOCK_SIZE);
941 if (len < EC_VBNV_BLOCK_SIZE)
947 int cros_ec_write_vbnvcontext(struct cros_ec_dev *dev, const uint8_t *block)
949 struct ec_params_vbnvcontext p;
952 p.op = EC_VBNV_CONTEXT_OP_WRITE;
953 memcpy(p.block, block, sizeof(p.block));
955 len = ec_command_inptr(dev, EC_CMD_VBNV_CONTEXT, EC_VER_VBNV_CONTEXT,
956 &p, sizeof(p), NULL, 0);
963 int cros_ec_set_ldo(struct udevice *dev, uint8_t index, uint8_t state)
965 struct cros_ec_dev *cdev = dev_get_uclass_priv(dev);
966 struct ec_params_ldo_set params;
968 params.index = index;
969 params.state = state;
971 if (ec_command_inptr(cdev, EC_CMD_LDO_SET, 0, ¶ms, sizeof(params),
978 int cros_ec_get_ldo(struct udevice *dev, uint8_t index, uint8_t *state)
980 struct cros_ec_dev *cdev = dev_get_uclass_priv(dev);
981 struct ec_params_ldo_get params;
982 struct ec_response_ldo_get *resp;
984 params.index = index;
986 if (ec_command_inptr(cdev, EC_CMD_LDO_GET, 0, ¶ms, sizeof(params),
987 (uint8_t **)&resp, sizeof(*resp)) !=
991 *state = resp->state;
996 int cros_ec_register(struct udevice *dev)
998 struct cros_ec_dev *cdev = dev_get_uclass_priv(dev);
999 const void *blob = gd->fdt_blob;
1000 int node = dev_of_offset(dev);
1004 gpio_request_by_name(dev, "ec-interrupt", 0, &cdev->ec_int,
1006 cdev->optimise_flash_write = fdtdec_get_bool(blob, node,
1007 "optimise-flash-write");
1009 if (cros_ec_check_version(cdev)) {
1010 debug("%s: Could not detect CROS-EC version\n", __func__);
1011 return -CROS_EC_ERR_CHECK_VERSION;
1014 if (cros_ec_read_id(cdev, id, sizeof(id))) {
1015 debug("%s: Could not read KBC ID\n", __func__);
1016 return -CROS_EC_ERR_READ_ID;
1019 /* Remember this device for use by the cros_ec command */
1020 debug("Google Chrome EC v%d CROS-EC driver ready, id '%s'\n",
1021 cdev->protocol_version, id);
1026 int cros_ec_decode_ec_flash(const void *blob, int node,
1027 struct fdt_cros_ec *config)
1031 flash_node = fdt_subnode_offset(blob, node, "flash");
1032 if (flash_node < 0) {
1033 debug("Failed to find flash node\n");
1037 if (fdtdec_read_fmap_entry(blob, flash_node, "flash",
1039 debug("Failed to decode flash node in chrome-ec'\n");
1043 config->flash_erase_value = fdtdec_get_int(blob, flash_node,
1045 for (node = fdt_first_subnode(blob, flash_node); node >= 0;
1046 node = fdt_next_subnode(blob, node)) {
1047 const char *name = fdt_get_name(blob, node, NULL);
1048 enum ec_flash_region region;
1050 if (0 == strcmp(name, "ro")) {
1051 region = EC_FLASH_REGION_RO;
1052 } else if (0 == strcmp(name, "rw")) {
1053 region = EC_FLASH_REGION_RW;
1054 } else if (0 == strcmp(name, "wp-ro")) {
1055 region = EC_FLASH_REGION_WP_RO;
1057 debug("Unknown EC flash region name '%s'\n", name);
1061 if (fdtdec_read_fmap_entry(blob, node, "reg",
1062 &config->region[region])) {
1063 debug("Failed to decode flash region in chrome-ec'\n");
1071 int cros_ec_i2c_tunnel(struct udevice *dev, int port, struct i2c_msg *in,
1074 struct cros_ec_dev *cdev = dev_get_uclass_priv(dev);
1076 struct ec_params_i2c_passthru p;
1077 uint8_t outbuf[EC_PROTO2_MAX_PARAM_SIZE];
1080 struct ec_response_i2c_passthru r;
1081 uint8_t inbuf[EC_PROTO2_MAX_PARAM_SIZE];
1083 struct ec_params_i2c_passthru *p = ¶ms.p;
1084 struct ec_response_i2c_passthru *r = &response.r;
1085 struct ec_params_i2c_passthru_msg *msg;
1086 uint8_t *pdata, *read_ptr = NULL;
1094 p->num_msgs = nmsgs;
1095 size = sizeof(*p) + p->num_msgs * sizeof(*msg);
1097 /* Create a message to write the register address and optional data */
1098 pdata = (uint8_t *)p + size;
1101 for (i = 0, msg = p->msg; i < nmsgs; i++, msg++, in++) {
1102 bool is_read = in->flags & I2C_M_RD;
1104 msg->addr_flags = in->addr;
1107 msg->addr_flags |= EC_I2C_FLAG_READ;
1108 read_len += in->len;
1110 if (sizeof(*r) + read_len > sizeof(response)) {
1111 puts("Read length too big for buffer\n");
1115 if (pdata - (uint8_t *)p + in->len > sizeof(params)) {
1116 puts("Params too large for buffer\n");
1119 memcpy(pdata, in->buf, in->len);
1124 rv = ec_command(cdev, EC_CMD_I2C_PASSTHRU, 0, p, pdata - (uint8_t *)p,
1125 r, sizeof(*r) + read_len);
1129 /* Parse response */
1130 if (r->i2c_status & EC_I2C_STATUS_ERROR) {
1131 printf("Transfer failed with status=0x%x\n", r->i2c_status);
1135 if (rv < sizeof(*r) + read_len) {
1136 puts("Truncated read response\n");
1140 /* We only support a single read message for each transfer */
1142 memcpy(read_ptr, r->data, read_len);
1147 UCLASS_DRIVER(cros_ec) = {
1148 .id = UCLASS_CROS_EC,
1150 .per_device_auto_alloc_size = sizeof(struct cros_ec_dev),
1151 .post_bind = dm_scan_fdt_dev,