1 // SPDX-License-Identifier: GPL-2.0+
3 * Chromium OS cros_ec driver
5 * Copyright (c) 2012 The Chromium OS Authors.
9 * This is the interface to the Chrome OS EC. It provides keyboard functions,
10 * power control and battery management. Quite a few other functions are
11 * provided to enable the EC software to be updated, talk to the EC's I2C bus
12 * and store a small amount of data in a memory which persists while the EC
16 #define LOG_CATEGORY UCLASS_CROS_EC
26 #include <linux/errno.h>
28 #include <asm-generic/gpio.h>
29 #include <dm/device-internal.h>
30 #include <dm/of_extra.h>
31 #include <dm/uclass-internal.h>
34 #define debug_trace(fmt, b...) debug(fmt, #b)
36 #define debug_trace(fmt, b...)
40 /* Timeout waiting for a flash erase command to complete */
41 CROS_EC_CMD_TIMEOUT_MS
= 5000,
42 /* Timeout waiting for a synchronous hash to be recomputed */
43 CROS_EC_CMD_HASH_TIMEOUT_MS
= 2000,
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
*cdev
,
89 int cmd
, int cmd_version
,
90 const void *dout
, int dout_len
)
92 struct ec_host_request
*rq
= (struct ec_host_request
*)cdev
->dout
;
93 int out_bytes
= dout_len
+ sizeof(*rq
);
95 /* Fail if output size is too big */
96 if (out_bytes
> (int)sizeof(cdev
->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(cdev
->dout
, out_bytes
));
115 cros_ec_dump_data("out", cmd
, cdev
->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
*cdev
, 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(cdev
->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
*cdev
,
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(cdev
, cmd
, cmd_version
,
217 /* Prepare response buffer */
218 in_bytes
= prepare_proto3_response_buffer(cdev
, din_len
);
222 ops
= dm_cros_ec_get_ops(cdev
->dev
);
223 rv
= ops
->packet
? ops
->packet(cdev
->dev
, out_bytes
, in_bytes
) :
228 /* Process the response */
229 return handle_proto3_response(cdev
, dinp
, din_len
);
232 static int send_command(struct cros_ec_dev
*dev
, uint cmd
, int cmd_version
,
233 const void *dout
, int dout_len
,
234 uint8_t **dinp
, int din_len
)
236 struct dm_cros_ec_ops
*ops
;
239 /* Handle protocol version 3 support */
240 if (dev
->protocol_version
== 3) {
241 return send_command_proto3(dev
, cmd
, cmd_version
,
242 dout
, dout_len
, dinp
, din_len
);
245 ops
= dm_cros_ec_get_ops(dev
->dev
);
246 ret
= ops
->command(dev
->dev
, cmd
, cmd_version
,
247 (const uint8_t *)dout
, dout_len
, dinp
, din_len
);
253 * Send a command to the CROS-EC device and return the reply.
255 * The device's internal input/output buffers are used.
257 * @param dev CROS-EC device
258 * @param cmd Command to send (EC_CMD_...)
259 * @param cmd_version Version of command to send (EC_VER_...)
260 * @param dout Output data (may be NULL If dout_len=0)
261 * @param dout_len Size of output data in bytes
262 * @param dinp Response data (may be NULL If din_len=0).
263 * If not NULL, it will be updated to point to the data
264 * and will always be double word aligned (64-bits)
265 * @param din_len Maximum size of response in bytes
266 * @return number of bytes in response, or -ve on error
268 static int ec_command_inptr(struct udevice
*dev
, uint8_t cmd
,
269 int cmd_version
, const void *dout
, int dout_len
,
270 uint8_t **dinp
, int din_len
)
272 struct cros_ec_dev
*cdev
= dev_get_uclass_priv(dev
);
276 len
= send_command(cdev
, cmd
, cmd_version
, dout
, dout_len
, &din
,
279 /* If the command doesn't complete, wait a while */
280 if (len
== -EC_RES_IN_PROGRESS
) {
281 struct ec_response_get_comms_status
*resp
= NULL
;
284 /* Wait for command to complete */
285 start
= get_timer(0);
289 mdelay(50); /* Insert some reasonable delay */
290 ret
= send_command(cdev
, EC_CMD_GET_COMMS_STATUS
, 0,
292 (uint8_t **)&resp
, sizeof(*resp
));
296 if (get_timer(start
) > CROS_EC_CMD_TIMEOUT_MS
) {
297 debug("%s: Command %#02x timeout\n",
299 return -EC_RES_TIMEOUT
;
301 } while (resp
->flags
& EC_COMMS_STATUS_PROCESSING
);
303 /* OK it completed, so read the status response */
304 /* not sure why it was 0 for the last argument */
305 len
= send_command(cdev
, EC_CMD_RESEND_RESPONSE
, 0, NULL
, 0,
309 debug("%s: len=%d, din=%p\n", __func__
, len
, din
);
311 /* If we have any data to return, it must be 64bit-aligned */
312 assert(len
<= 0 || !((uintptr_t)din
& 7));
320 * Send a command to the CROS-EC device and return the reply.
322 * The device's internal input/output buffers are used.
324 * @param dev CROS-EC device
325 * @param cmd Command to send (EC_CMD_...)
326 * @param cmd_version Version of command to send (EC_VER_...)
327 * @param dout Output data (may be NULL If dout_len=0)
328 * @param dout_len Size of output data in bytes
329 * @param din Response data (may be NULL If din_len=0).
330 * It not NULL, it is a place for ec_command() to copy the
332 * @param din_len Maximum size of response in bytes
333 * @return number of bytes in response, or -ve on error
335 static int ec_command(struct udevice
*dev
, uint cmd
, int cmd_version
,
336 const void *dout
, int dout_len
,
337 void *din
, int din_len
)
342 assert((din_len
== 0) || din
);
343 len
= ec_command_inptr(dev
, cmd
, cmd_version
, dout
, dout_len
,
344 &in_buffer
, din_len
);
347 * If we were asked to put it somewhere, do so, otherwise just
348 * disregard the result.
350 if (din
&& in_buffer
) {
351 assert(len
<= din_len
);
352 memmove(din
, in_buffer
, len
);
358 int cros_ec_scan_keyboard(struct udevice
*dev
, struct mbkp_keyscan
*scan
)
360 if (ec_command(dev
, EC_CMD_MKBP_STATE
, 0, NULL
, 0, scan
,
361 sizeof(scan
->data
)) != sizeof(scan
->data
))
367 int cros_ec_read_id(struct udevice
*dev
, char *id
, int maxlen
)
369 struct ec_response_get_version
*r
;
372 ret
= ec_command_inptr(dev
, EC_CMD_GET_VERSION
, 0, NULL
, 0,
373 (uint8_t **)&r
, sizeof(*r
));
374 if (ret
!= sizeof(*r
)) {
375 log_err("Got rc %d, expected %d\n", ret
, sizeof(*r
));
379 if (maxlen
> (int)sizeof(r
->version_string_ro
))
380 maxlen
= sizeof(r
->version_string_ro
);
382 switch (r
->current_image
) {
384 memcpy(id
, r
->version_string_ro
, maxlen
);
387 memcpy(id
, r
->version_string_rw
, maxlen
);
390 log_err("Invalid EC image %d\n", r
->current_image
);
394 id
[maxlen
- 1] = '\0';
398 int cros_ec_read_version(struct udevice
*dev
,
399 struct ec_response_get_version
**versionp
)
401 if (ec_command_inptr(dev
, EC_CMD_GET_VERSION
, 0, NULL
, 0,
402 (uint8_t **)versionp
, sizeof(**versionp
))
403 != sizeof(**versionp
))
409 int cros_ec_read_build_info(struct udevice
*dev
, char **strp
)
411 if (ec_command_inptr(dev
, EC_CMD_GET_BUILD_INFO
, 0, NULL
, 0,
412 (uint8_t **)strp
, EC_PROTO2_MAX_PARAM_SIZE
) < 0)
418 int cros_ec_read_current_image(struct udevice
*dev
,
419 enum ec_current_image
*image
)
421 struct ec_response_get_version
*r
;
423 if (ec_command_inptr(dev
, EC_CMD_GET_VERSION
, 0, NULL
, 0,
424 (uint8_t **)&r
, sizeof(*r
)) != sizeof(*r
))
427 *image
= r
->current_image
;
431 static int cros_ec_wait_on_hash_done(struct udevice
*dev
,
432 struct ec_response_vboot_hash
*hash
)
434 struct ec_params_vboot_hash p
;
437 start
= get_timer(0);
438 while (hash
->status
== EC_VBOOT_HASH_STATUS_BUSY
) {
439 mdelay(50); /* Insert some reasonable delay */
441 p
.cmd
= EC_VBOOT_HASH_GET
;
442 if (ec_command(dev
, EC_CMD_VBOOT_HASH
, 0, &p
, sizeof(p
),
443 hash
, sizeof(*hash
)) < 0)
446 if (get_timer(start
) > CROS_EC_CMD_HASH_TIMEOUT_MS
) {
447 debug("%s: EC_VBOOT_HASH_GET timeout\n", __func__
);
448 return -EC_RES_TIMEOUT
;
454 int cros_ec_read_hash(struct udevice
*dev
, uint hash_offset
,
455 struct ec_response_vboot_hash
*hash
)
457 struct ec_params_vboot_hash p
;
460 p
.cmd
= EC_VBOOT_HASH_GET
;
461 p
.offset
= hash_offset
;
462 if (ec_command(dev
, EC_CMD_VBOOT_HASH
, 0, &p
, sizeof(p
),
463 hash
, sizeof(*hash
)) < 0)
466 /* If the EC is busy calculating the hash, fidget until it's done. */
467 rv
= cros_ec_wait_on_hash_done(dev
, hash
);
471 /* If the hash is valid, we're done. Otherwise, we have to kick it off
472 * again and wait for it to complete. Note that we explicitly assume
473 * that hashing zero bytes is always wrong, even though that would
474 * produce a valid hash value. */
475 if (hash
->status
== EC_VBOOT_HASH_STATUS_DONE
&& hash
->size
)
478 debug("%s: No valid hash (status=%d size=%d). Compute one...\n",
479 __func__
, hash
->status
, hash
->size
);
481 p
.cmd
= EC_VBOOT_HASH_START
;
482 p
.hash_type
= EC_VBOOT_HASH_TYPE_SHA256
;
484 p
.offset
= hash_offset
;
486 if (ec_command(dev
, EC_CMD_VBOOT_HASH
, 0, &p
, sizeof(p
),
487 hash
, sizeof(*hash
)) < 0)
490 rv
= cros_ec_wait_on_hash_done(dev
, hash
);
494 debug("%s: hash done\n", __func__
);
499 static int cros_ec_invalidate_hash(struct udevice
*dev
)
501 struct ec_params_vboot_hash p
;
502 struct ec_response_vboot_hash
*hash
;
504 /* We don't have an explict command for the EC to discard its current
505 * hash value, so we'll just tell it to calculate one that we know is
506 * wrong (we claim that hashing zero bytes is always invalid).
508 p
.cmd
= EC_VBOOT_HASH_RECALC
;
509 p
.hash_type
= EC_VBOOT_HASH_TYPE_SHA256
;
514 debug("%s:\n", __func__
);
516 if (ec_command_inptr(dev
, EC_CMD_VBOOT_HASH
, 0, &p
, sizeof(p
),
517 (uint8_t **)&hash
, sizeof(*hash
)) < 0)
520 /* No need to wait for it to finish */
524 int cros_ec_reboot(struct udevice
*dev
, enum ec_reboot_cmd cmd
, uint8_t flags
)
526 struct ec_params_reboot_ec p
;
531 if (ec_command_inptr(dev
, EC_CMD_REBOOT_EC
, 0, &p
, sizeof(p
), NULL
, 0)
535 if (!(flags
& EC_REBOOT_FLAG_ON_AP_SHUTDOWN
)) {
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
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?
553 int cros_ec_interrupt_pending(struct udevice
*dev
)
555 struct cros_ec_dev
*cdev
= dev_get_uclass_priv(dev
);
557 /* no interrupt support : always poll */
558 if (!dm_gpio_is_valid(&cdev
->ec_int
))
561 return dm_gpio_get_value(&cdev
->ec_int
);
564 int cros_ec_info(struct udevice
*dev
, struct ec_response_mkbp_info
*info
)
566 if (ec_command(dev
, EC_CMD_MKBP_INFO
, 0, NULL
, 0, info
,
567 sizeof(*info
)) != sizeof(*info
))
573 int cros_ec_get_host_events(struct udevice
*dev
, uint32_t *events_ptr
)
575 struct ec_response_host_event_mask
*resp
;
578 * Use the B copy of the event flags, because the main copy is already
581 if (ec_command_inptr(dev
, EC_CMD_HOST_EVENT_GET_B
, 0, NULL
, 0,
582 (uint8_t **)&resp
, sizeof(*resp
)) < (int)sizeof(*resp
))
585 if (resp
->mask
& EC_HOST_EVENT_MASK(EC_HOST_EVENT_INVALID
))
588 *events_ptr
= resp
->mask
;
592 int cros_ec_clear_host_events(struct udevice
*dev
, uint32_t events
)
594 struct ec_params_host_event_mask params
;
596 params
.mask
= events
;
599 * Use the B copy of the event flags, so it affects the data returned
600 * by cros_ec_get_host_events().
602 if (ec_command_inptr(dev
, EC_CMD_HOST_EVENT_CLEAR_B
, 0,
603 ¶ms
, sizeof(params
), NULL
, 0) < 0)
609 int cros_ec_flash_protect(struct udevice
*dev
, uint32_t set_mask
,
611 struct ec_response_flash_protect
*resp
)
613 struct ec_params_flash_protect params
;
615 params
.mask
= set_mask
;
616 params
.flags
= set_flags
;
618 if (ec_command(dev
, EC_CMD_FLASH_PROTECT
, EC_VER_FLASH_PROTECT
,
619 ¶ms
, sizeof(params
),
620 resp
, sizeof(*resp
)) != sizeof(*resp
))
626 static int cros_ec_check_version(struct udevice
*dev
)
628 struct cros_ec_dev
*cdev
= dev_get_uclass_priv(dev
);
629 struct ec_params_hello req
;
630 struct ec_response_hello
*resp
;
632 struct dm_cros_ec_ops
*ops
;
635 ops
= dm_cros_ec_get_ops(dev
);
636 if (ops
->check_version
) {
637 ret
= ops
->check_version(dev
);
643 * TODO(sjg@chromium.org).
644 * There is a strange oddity here with the EC. We could just ignore
645 * the response, i.e. pass the last two parameters as NULL and 0.
646 * In this case we won't read back very many bytes from the EC.
647 * On the I2C bus the EC gets upset about this and will try to send
648 * the bytes anyway. This means that we will have to wait for that
649 * to complete before continuing with a new EC command.
651 * This problem is probably unique to the I2C bus.
653 * So for now, just read all the data anyway.
656 /* Try sending a version 3 packet */
657 cdev
->protocol_version
= 3;
659 if (ec_command_inptr(dev
, EC_CMD_HELLO
, 0, &req
, sizeof(req
),
660 (uint8_t **)&resp
, sizeof(*resp
)) > 0)
663 /* Try sending a version 2 packet */
664 cdev
->protocol_version
= 2;
665 if (ec_command_inptr(dev
, EC_CMD_HELLO
, 0, &req
, sizeof(req
),
666 (uint8_t **)&resp
, sizeof(*resp
)) > 0)
670 * Fail if we're still here, since the EC doesn't understand any
671 * protcol version we speak. Version 1 interface without command
672 * version is no longer supported, and we don't know about any new
675 cdev
->protocol_version
= 0;
676 printf("%s: ERROR: old EC interface not supported\n", __func__
);
680 int cros_ec_test(struct udevice
*dev
)
682 struct ec_params_hello req
;
683 struct ec_response_hello
*resp
;
685 req
.in_data
= 0x12345678;
686 if (ec_command_inptr(dev
, EC_CMD_HELLO
, 0, &req
, sizeof(req
),
687 (uint8_t **)&resp
, sizeof(*resp
)) < sizeof(*resp
)) {
688 printf("ec_command_inptr() returned error\n");
691 if (resp
->out_data
!= req
.in_data
+ 0x01020304) {
692 printf("Received invalid handshake %x\n", resp
->out_data
);
699 int cros_ec_flash_offset(struct udevice
*dev
, enum ec_flash_region region
,
700 uint32_t *offset
, uint32_t *size
)
702 struct ec_params_flash_region_info p
;
703 struct ec_response_flash_region_info
*r
;
707 ret
= ec_command_inptr(dev
, EC_CMD_FLASH_REGION_INFO
,
708 EC_VER_FLASH_REGION_INFO
,
709 &p
, sizeof(p
), (uint8_t **)&r
, sizeof(*r
));
710 if (ret
!= sizeof(*r
))
721 int cros_ec_flash_erase(struct udevice
*dev
, uint32_t offset
, uint32_t size
)
723 struct ec_params_flash_erase p
;
727 return ec_command_inptr(dev
, EC_CMD_FLASH_ERASE
, 0, &p
, sizeof(p
),
732 * Write a single block to the flash
734 * Write a block of data to the EC flash. The size must not exceed the flash
735 * write block size which you can obtain from cros_ec_flash_write_burst_size().
737 * The offset starts at 0. You can obtain the region information from
738 * cros_ec_flash_offset() to find out where to write for a particular region.
740 * Attempting to write to the region where the EC is currently running from
741 * will result in an error.
743 * @param dev CROS-EC device
744 * @param data Pointer to data buffer to write
745 * @param offset Offset within flash to write to.
746 * @param size Number of bytes to write
747 * @return 0 if ok, -1 on error
749 static int cros_ec_flash_write_block(struct udevice
*dev
, const uint8_t *data
,
750 uint32_t offset
, uint32_t size
)
752 struct ec_params_flash_write
*p
;
755 p
= malloc(sizeof(*p
) + size
);
761 assert(data
&& p
->size
<= EC_FLASH_WRITE_VER0_SIZE
);
762 memcpy(p
+ 1, data
, p
->size
);
764 ret
= ec_command_inptr(dev
, EC_CMD_FLASH_WRITE
, 0,
765 p
, sizeof(*p
) + size
, NULL
, 0) >= 0 ? 0 : -1;
773 * Return optimal flash write burst size
775 static int cros_ec_flash_write_burst_size(struct udevice
*dev
)
777 return EC_FLASH_WRITE_VER0_SIZE
;
781 * Check if a block of data is erased (all 0xff)
783 * This function is useful when dealing with flash, for checking whether a
784 * data block is erased and thus does not need to be programmed.
786 * @param data Pointer to data to check (must be word-aligned)
787 * @param size Number of bytes to check (must be word-aligned)
788 * @return 0 if erased, non-zero if any word is not erased
790 static int cros_ec_data_is_erased(const uint32_t *data
, int size
)
793 size
/= sizeof(uint32_t);
794 for (; size
> 0; size
-= 4, data
++)
802 * Read back flash parameters
804 * This function reads back parameters of the flash as reported by the EC
806 * @param dev Pointer to device
807 * @param info Pointer to output flash info struct
809 int cros_ec_read_flashinfo(struct udevice
*dev
,
810 struct ec_response_flash_info
*info
)
814 ret
= ec_command(dev
, EC_CMD_FLASH_INFO
, 0,
815 NULL
, 0, info
, sizeof(*info
));
819 return ret
< sizeof(*info
) ? -1 : 0;
822 int cros_ec_flash_write(struct udevice
*dev
, const uint8_t *data
,
823 uint32_t offset
, uint32_t size
)
825 struct cros_ec_dev
*cdev
= dev_get_uclass_priv(dev
);
826 uint32_t burst
= cros_ec_flash_write_burst_size(dev
);
834 * TODO: round up to the nearest multiple of write size. Can get away
835 * without that on link right now because its write size is 4 bytes.
838 for (off
= offset
; off
< end
; off
+= burst
, data
+= burst
) {
841 /* If the data is empty, there is no point in programming it */
842 todo
= min(end
- off
, burst
);
843 if (cdev
->optimise_flash_write
&&
844 cros_ec_data_is_erased((uint32_t *)data
, todo
))
847 ret
= cros_ec_flash_write_block(dev
, data
, off
, todo
);
856 * Read a single block from the flash
858 * Read a block of data from the EC flash. The size must not exceed the flash
859 * write block size which you can obtain from cros_ec_flash_write_burst_size().
861 * The offset starts at 0. You can obtain the region information from
862 * cros_ec_flash_offset() to find out where to read for a particular region.
864 * @param dev CROS-EC device
865 * @param data Pointer to data buffer to read into
866 * @param offset Offset within flash to read from
867 * @param size Number of bytes to read
868 * @return 0 if ok, -1 on error
870 static int cros_ec_flash_read_block(struct udevice
*dev
, uint8_t *data
,
871 uint32_t offset
, uint32_t size
)
873 struct ec_params_flash_read p
;
878 return ec_command(dev
, EC_CMD_FLASH_READ
, 0,
879 &p
, sizeof(p
), data
, size
) >= 0 ? 0 : -1;
882 int cros_ec_flash_read(struct udevice
*dev
, uint8_t *data
, uint32_t offset
,
885 uint32_t burst
= cros_ec_flash_write_burst_size(dev
);
890 for (off
= offset
; off
< end
; off
+= burst
, data
+= burst
) {
891 ret
= cros_ec_flash_read_block(dev
, data
, off
,
892 min(end
- off
, burst
));
900 int cros_ec_flash_update_rw(struct udevice
*dev
, const uint8_t *image
,
903 uint32_t rw_offset
, rw_size
;
906 if (cros_ec_flash_offset(dev
, EC_FLASH_REGION_ACTIVE
, &rw_offset
,
909 if (image_size
> (int)rw_size
)
912 /* Invalidate the existing hash, just in case the AP reboots
913 * unexpectedly during the update. If that happened, the EC RW firmware
914 * would be invalid, but the EC would still have the original hash.
916 ret
= cros_ec_invalidate_hash(dev
);
921 * Erase the entire RW section, so that the EC doesn't see any garbage
922 * past the new image if it's smaller than the current image.
924 * TODO: could optimize this to erase just the current image, since
925 * presumably everything past that is 0xff's. But would still need to
926 * round up to the nearest multiple of erase size.
928 ret
= cros_ec_flash_erase(dev
, rw_offset
, rw_size
);
932 /* Write the image */
933 ret
= cros_ec_flash_write(dev
, image
, rw_offset
, image_size
);
940 int cros_ec_read_nvdata(struct udevice
*dev
, uint8_t *block
, int size
)
942 struct ec_params_vbnvcontext p
;
945 if (size
!= EC_VBNV_BLOCK_SIZE
)
948 p
.op
= EC_VBNV_CONTEXT_OP_READ
;
950 len
= ec_command(dev
, EC_CMD_VBNV_CONTEXT
, EC_VER_VBNV_CONTEXT
,
951 &p
, sizeof(p
), block
, EC_VBNV_BLOCK_SIZE
);
952 if (len
< EC_VBNV_BLOCK_SIZE
)
958 int cros_ec_write_nvdata(struct udevice
*dev
, const uint8_t *block
, int size
)
960 struct ec_params_vbnvcontext p
;
963 if (size
!= EC_VBNV_BLOCK_SIZE
)
965 p
.op
= EC_VBNV_CONTEXT_OP_WRITE
;
966 memcpy(p
.block
, block
, sizeof(p
.block
));
968 len
= ec_command_inptr(dev
, EC_CMD_VBNV_CONTEXT
, EC_VER_VBNV_CONTEXT
,
969 &p
, sizeof(p
), NULL
, 0);
976 int cros_ec_set_ldo(struct udevice
*dev
, uint8_t index
, uint8_t state
)
978 struct ec_params_ldo_set params
;
980 params
.index
= index
;
981 params
.state
= state
;
983 if (ec_command_inptr(dev
, EC_CMD_LDO_SET
, 0, ¶ms
, sizeof(params
),
990 int cros_ec_get_ldo(struct udevice
*dev
, uint8_t index
, uint8_t *state
)
992 struct ec_params_ldo_get params
;
993 struct ec_response_ldo_get
*resp
;
995 params
.index
= index
;
997 if (ec_command_inptr(dev
, EC_CMD_LDO_GET
, 0, ¶ms
, sizeof(params
),
998 (uint8_t **)&resp
, sizeof(*resp
)) !=
1002 *state
= resp
->state
;
1007 int cros_ec_register(struct udevice
*dev
)
1009 struct cros_ec_dev
*cdev
= dev_get_uclass_priv(dev
);
1013 gpio_request_by_name(dev
, "ec-interrupt", 0, &cdev
->ec_int
,
1015 cdev
->optimise_flash_write
= dev_read_bool(dev
, "optimise-flash-write");
1017 if (cros_ec_check_version(dev
)) {
1018 debug("%s: Could not detect CROS-EC version\n", __func__
);
1019 return -CROS_EC_ERR_CHECK_VERSION
;
1022 if (cros_ec_read_id(dev
, id
, sizeof(id
))) {
1023 debug("%s: Could not read KBC ID\n", __func__
);
1024 return -CROS_EC_ERR_READ_ID
;
1027 /* Remember this device for use by the cros_ec command */
1028 debug("Google Chrome EC v%d CROS-EC driver ready, id '%s'\n",
1029 cdev
->protocol_version
, id
);
1034 int cros_ec_decode_ec_flash(struct udevice
*dev
, struct fdt_cros_ec
*config
)
1036 ofnode flash_node
, node
;
1038 flash_node
= dev_read_subnode(dev
, "flash");
1039 if (!ofnode_valid(flash_node
)) {
1040 debug("Failed to find flash node\n");
1044 if (ofnode_read_fmap_entry(flash_node
, &config
->flash
)) {
1045 debug("Failed to decode flash node in chrome-ec\n");
1049 config
->flash_erase_value
= ofnode_read_s32_default(flash_node
,
1051 ofnode_for_each_subnode(node
, flash_node
) {
1052 const char *name
= ofnode_get_name(node
);
1053 enum ec_flash_region region
;
1055 if (0 == strcmp(name
, "ro")) {
1056 region
= EC_FLASH_REGION_RO
;
1057 } else if (0 == strcmp(name
, "rw")) {
1058 region
= EC_FLASH_REGION_ACTIVE
;
1059 } else if (0 == strcmp(name
, "wp-ro")) {
1060 region
= EC_FLASH_REGION_WP_RO
;
1062 debug("Unknown EC flash region name '%s'\n", name
);
1066 if (ofnode_read_fmap_entry(node
, &config
->region
[region
])) {
1067 debug("Failed to decode flash region in chrome-ec'\n");
1075 int cros_ec_i2c_tunnel(struct udevice
*dev
, int port
, struct i2c_msg
*in
,
1079 struct ec_params_i2c_passthru p
;
1080 uint8_t outbuf
[EC_PROTO2_MAX_PARAM_SIZE
];
1083 struct ec_response_i2c_passthru r
;
1084 uint8_t inbuf
[EC_PROTO2_MAX_PARAM_SIZE
];
1086 struct ec_params_i2c_passthru
*p
= ¶ms
.p
;
1087 struct ec_response_i2c_passthru
*r
= &response
.r
;
1088 struct ec_params_i2c_passthru_msg
*msg
;
1089 uint8_t *pdata
, *read_ptr
= NULL
;
1097 p
->num_msgs
= nmsgs
;
1098 size
= sizeof(*p
) + p
->num_msgs
* sizeof(*msg
);
1100 /* Create a message to write the register address and optional data */
1101 pdata
= (uint8_t *)p
+ size
;
1104 for (i
= 0, msg
= p
->msg
; i
< nmsgs
; i
++, msg
++, in
++) {
1105 bool is_read
= in
->flags
& I2C_M_RD
;
1107 msg
->addr_flags
= in
->addr
;
1110 msg
->addr_flags
|= EC_I2C_FLAG_READ
;
1111 read_len
+= in
->len
;
1113 if (sizeof(*r
) + read_len
> sizeof(response
)) {
1114 puts("Read length too big for buffer\n");
1118 if (pdata
- (uint8_t *)p
+ in
->len
> sizeof(params
)) {
1119 puts("Params too large for buffer\n");
1122 memcpy(pdata
, in
->buf
, in
->len
);
1127 rv
= ec_command(dev
, EC_CMD_I2C_PASSTHRU
, 0, p
, pdata
- (uint8_t *)p
,
1128 r
, sizeof(*r
) + read_len
);
1132 /* Parse response */
1133 if (r
->i2c_status
& EC_I2C_STATUS_ERROR
) {
1134 printf("Transfer failed with status=0x%x\n", r
->i2c_status
);
1138 if (rv
< sizeof(*r
) + read_len
) {
1139 puts("Truncated read response\n");
1143 /* We only support a single read message for each transfer */
1145 memcpy(read_ptr
, r
->data
, read_len
);
1150 UCLASS_DRIVER(cros_ec
) = {
1151 .id
= UCLASS_CROS_EC
,
1153 .per_device_auto_alloc_size
= sizeof(struct cros_ec_dev
),
1154 .post_bind
= dm_scan_fdt_dev
,
1155 .flags
= DM_UC_FLAG_ALLOC_PRIV_DMA
,