1 // SPDX-License-Identifier: GPL-2.0+
3 * Chromium OS cros_ec driver
5 * Copyright (c) 2016 The Chromium OS Authors.
6 * Copyright (c) 2016 National Instruments Corp
13 #include <dm/device-internal.h>
14 #include <dm/uclass-internal.h>
16 /* Note: depends on enum ec_current_image */
17 static const char * const ec_current_image_name
[] = {"unknown", "RO", "RW"};
20 * Decode a flash region parameter
22 * @param argc Number of params remaining
23 * @param argv List of remaining parameters
24 * @return flash region (EC_FLASH_REGION_...) or -1 on error
26 static int cros_ec_decode_region(int argc
, char * const argv
[])
29 if (0 == strcmp(*argv
, "rw"))
30 return EC_FLASH_REGION_RW
;
31 else if (0 == strcmp(*argv
, "ro"))
32 return EC_FLASH_REGION_RO
;
34 debug("%s: Invalid region '%s'\n", __func__
, *argv
);
36 debug("%s: Missing region parameter\n", __func__
);
43 * Perform a flash read or write command
45 * @param dev CROS-EC device to read/write
46 * @param is_write 1 do to a write, 0 to do a read
47 * @param argc Number of arguments
48 * @param argv Arguments (2 is region, 3 is address)
49 * @return 0 for ok, 1 for a usage error or -ve for ec command error
50 * (negative EC_RES_...)
52 static int do_read_write(struct cros_ec_dev
*dev
, int is_write
, int argc
,
55 uint32_t offset
, size
= -1U, region_size
;
61 region
= cros_ec_decode_region(argc
- 2, argv
+ 2);
66 addr
= simple_strtoul(argv
[3], &endp
, 16);
67 if (*argv
[3] == 0 || *endp
!= 0)
70 size
= simple_strtoul(argv
[4], &endp
, 16);
71 if (*argv
[4] == 0 || *endp
!= 0)
75 ret
= cros_ec_flash_offset(dev
, region
, &offset
, ®ion_size
);
77 debug("%s: Could not read region info\n", __func__
);
84 cros_ec_flash_write(dev
, (uint8_t *)addr
, offset
, size
) :
85 cros_ec_flash_read(dev
, (uint8_t *)addr
, offset
, size
);
87 debug("%s: Could not %s region\n", __func__
,
88 is_write
? "write" : "read");
95 static int do_cros_ec(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
97 struct cros_ec_dev
*dev
;
103 return CMD_RET_USAGE
;
106 if (0 == strcmp("init", cmd
)) {
107 /* Remove any existing device */
108 ret
= uclass_find_device(UCLASS_CROS_EC
, 0, &udev
);
110 device_remove(udev
, DM_REMOVE_NORMAL
);
111 ret
= uclass_get_device(UCLASS_CROS_EC
, 0, &udev
);
113 printf("Could not init cros_ec device (err %d)\n", ret
);
119 ret
= uclass_get_device(UCLASS_CROS_EC
, 0, &udev
);
121 printf("Cannot get cros-ec device (err=%d)\n", ret
);
124 dev
= dev_get_uclass_priv(udev
);
125 if (0 == strcmp("id", cmd
)) {
128 if (cros_ec_read_id(dev
, id
, sizeof(id
))) {
129 debug("%s: Could not read KBC ID\n", __func__
);
133 } else if (0 == strcmp("info", cmd
)) {
134 struct ec_response_mkbp_info info
;
136 if (cros_ec_info(dev
, &info
)) {
137 debug("%s: Could not read KBC info\n", __func__
);
140 printf("rows = %u\n", info
.rows
);
141 printf("cols = %u\n", info
.cols
);
142 printf("switches = %#x\n", info
.switches
);
143 } else if (0 == strcmp("curimage", cmd
)) {
144 enum ec_current_image image
;
146 if (cros_ec_read_current_image(dev
, &image
)) {
147 debug("%s: Could not read KBC image\n", __func__
);
150 printf("%d\n", image
);
151 } else if (0 == strcmp("hash", cmd
)) {
152 struct ec_response_vboot_hash hash
;
155 if (cros_ec_read_hash(dev
, &hash
)) {
156 debug("%s: Could not read KBC hash\n", __func__
);
160 if (hash
.hash_type
== EC_VBOOT_HASH_TYPE_SHA256
)
161 printf("type: SHA-256\n");
163 printf("type: %d\n", hash
.hash_type
);
165 printf("offset: 0x%08x\n", hash
.offset
);
166 printf("size: 0x%08x\n", hash
.size
);
169 for (i
= 0; i
< hash
.digest_size
; i
++)
170 printf("%02x", hash
.hash_digest
[i
]);
172 } else if (0 == strcmp("reboot", cmd
)) {
174 enum ec_reboot_cmd cmd
;
176 if (argc
>= 3 && !strcmp(argv
[2], "cold")) {
177 cmd
= EC_REBOOT_COLD
;
179 region
= cros_ec_decode_region(argc
- 2, argv
+ 2);
180 if (region
== EC_FLASH_REGION_RO
)
181 cmd
= EC_REBOOT_JUMP_RO
;
182 else if (region
== EC_FLASH_REGION_RW
)
183 cmd
= EC_REBOOT_JUMP_RW
;
185 return CMD_RET_USAGE
;
188 if (cros_ec_reboot(dev
, cmd
, 0)) {
189 debug("%s: Could not reboot KBC\n", __func__
);
192 } else if (0 == strcmp("events", cmd
)) {
195 if (cros_ec_get_host_events(dev
, &events
)) {
196 debug("%s: Could not read host events\n", __func__
);
199 printf("0x%08x\n", events
);
200 } else if (0 == strcmp("clrevents", cmd
)) {
201 uint32_t events
= 0x7fffffff;
204 events
= simple_strtol(argv
[2], NULL
, 0);
206 if (cros_ec_clear_host_events(dev
, events
)) {
207 debug("%s: Could not clear host events\n", __func__
);
210 } else if (0 == strcmp("read", cmd
)) {
211 ret
= do_read_write(dev
, 0, argc
, argv
);
213 return CMD_RET_USAGE
;
214 } else if (0 == strcmp("write", cmd
)) {
215 ret
= do_read_write(dev
, 1, argc
, argv
);
217 return CMD_RET_USAGE
;
218 } else if (0 == strcmp("erase", cmd
)) {
219 int region
= cros_ec_decode_region(argc
- 2, argv
+ 2);
220 uint32_t offset
, size
;
223 return CMD_RET_USAGE
;
224 if (cros_ec_flash_offset(dev
, region
, &offset
, &size
)) {
225 debug("%s: Could not read region info\n", __func__
);
228 ret
= cros_ec_flash_erase(dev
, offset
, size
);
230 debug("%s: Could not erase region\n",
234 } else if (0 == strcmp("regioninfo", cmd
)) {
235 int region
= cros_ec_decode_region(argc
- 2, argv
+ 2);
236 uint32_t offset
, size
;
239 return CMD_RET_USAGE
;
240 ret
= cros_ec_flash_offset(dev
, region
, &offset
, &size
);
242 debug("%s: Could not read region info\n", __func__
);
244 printf("Region: %s\n", region
== EC_FLASH_REGION_RO
?
246 printf("Offset: %x\n", offset
);
247 printf("Size: %x\n", size
);
249 } else if (0 == strcmp("flashinfo", cmd
)) {
250 struct ec_response_flash_info p
;
252 ret
= cros_ec_read_flashinfo(dev
, &p
);
254 printf("Flash size: %u\n", p
.flash_size
);
255 printf("Write block size: %u\n", p
.write_block_size
);
256 printf("Erase block size: %u\n", p
.erase_block_size
);
258 } else if (0 == strcmp("vbnvcontext", cmd
)) {
259 uint8_t block
[EC_VBNV_BLOCK_SIZE
];
262 unsigned long result
;
265 ret
= cros_ec_read_vbnvcontext(dev
, block
);
267 printf("vbnv_block: ");
268 for (i
= 0; i
< EC_VBNV_BLOCK_SIZE
; i
++)
269 printf("%02x", block
[i
]);
274 * TODO(clchiou): Move this to a utility function as
275 * cmd_spi might want to call it.
277 memset(block
, 0, EC_VBNV_BLOCK_SIZE
);
278 len
= strlen(argv
[2]);
280 for (i
= 0; i
< EC_VBNV_BLOCK_SIZE
; i
++) {
283 buf
[0] = argv
[2][i
* 2];
284 if (i
* 2 + 1 >= len
)
287 buf
[1] = argv
[2][i
* 2 + 1];
288 strict_strtoul(buf
, 16, &result
);
291 ret
= cros_ec_write_vbnvcontext(dev
, block
);
294 debug("%s: Could not %s VbNvContext\n", __func__
,
295 argc
<= 2 ? "read" : "write");
297 } else if (0 == strcmp("test", cmd
)) {
298 int result
= cros_ec_test(dev
);
301 printf("Test failed with error %d\n", result
);
303 puts("Test passed\n");
304 } else if (0 == strcmp("version", cmd
)) {
305 struct ec_response_get_version
*p
;
308 ret
= cros_ec_read_version(dev
, &p
);
311 printf("RO version: %1.*s\n",
312 (int)sizeof(p
->version_string_ro
),
313 p
->version_string_ro
);
314 printf("RW version: %1.*s\n",
315 (int)sizeof(p
->version_string_rw
),
316 p
->version_string_rw
);
317 printf("Firmware copy: %s\n",
319 ARRAY_SIZE(ec_current_image_name
) ?
320 ec_current_image_name
[p
->current_image
] :
322 ret
= cros_ec_read_build_info(dev
, &build_string
);
324 printf("Build info: %s\n", build_string
);
326 } else if (0 == strcmp("ldo", cmd
)) {
327 uint8_t index
, state
;
331 return CMD_RET_USAGE
;
332 index
= simple_strtoul(argv
[2], &endp
, 10);
333 if (*argv
[2] == 0 || *endp
!= 0)
334 return CMD_RET_USAGE
;
336 state
= simple_strtoul(argv
[3], &endp
, 10);
337 if (*argv
[3] == 0 || *endp
!= 0)
338 return CMD_RET_USAGE
;
339 ret
= cros_ec_set_ldo(udev
, index
, state
);
341 ret
= cros_ec_get_ldo(udev
, index
, &state
);
343 printf("LDO%d: %s\n", index
,
344 state
== EC_LDO_STATE_ON
?
350 debug("%s: Could not access LDO%d\n", __func__
, index
);
354 return CMD_RET_USAGE
;
358 printf("Error: CROS-EC command failed (error %d)\n", ret
);
366 crosec
, 6, 1, do_cros_ec
,
367 "CROS-EC utility command",
368 "init Re-init CROS-EC (done on startup automatically)\n"
369 "crosec id Read CROS-EC ID\n"
370 "crosec info Read CROS-EC info\n"
371 "crosec curimage Read CROS-EC current image\n"
372 "crosec hash Read CROS-EC hash\n"
373 "crosec reboot [rw | ro | cold] Reboot CROS-EC\n"
374 "crosec events Read CROS-EC host events\n"
375 "crosec clrevents [mask] Clear CROS-EC host events\n"
376 "crosec regioninfo <ro|rw> Read image info\n"
377 "crosec flashinfo Read flash info\n"
378 "crosec erase <ro|rw> Erase EC image\n"
379 "crosec read <ro|rw> <addr> [<size>] Read EC image\n"
380 "crosec write <ro|rw> <addr> [<size>] Write EC image\n"
381 "crosec vbnvcontext [hexstring] Read [write] VbNvContext from EC\n"
382 "crosec ldo <idx> [<state>] Switch/Read LDO state\n"
383 "crosec test run tests on cros_ec\n"
384 "crosec version Read CROS-EC version"