summaryrefslogtreecommitdiff
path: root/futility/cmd_flash_util.c
diff options
context:
space:
mode:
Diffstat (limited to 'futility/cmd_flash_util.c')
-rw-r--r--futility/cmd_flash_util.c260
1 files changed, 260 insertions, 0 deletions
diff --git a/futility/cmd_flash_util.c b/futility/cmd_flash_util.c
new file mode 100644
index 00000000..783a595e
--- /dev/null
+++ b/futility/cmd_flash_util.c
@@ -0,0 +1,260 @@
+/* Copyright 2023 The ChromiumOS Authors
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+
+#include <assert.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <getopt.h>
+
+#include "fmap.h"
+#include "futility.h"
+#include "updater.h"
+
+#ifdef USE_FLASHROM
+
+static int print_flash_size(struct updater_config *cfg)
+{
+ uint32_t flash_size;
+ if (flashrom_get_size(cfg->image.programmer, &flash_size,
+ cfg->verbosity + 1)) {
+ ERROR("%s failed.\n", __func__);
+ return -1;
+ }
+
+ printf("Flash size: %#010x\n", flash_size);
+ return 0;
+}
+
+static int get_ro_range(struct updater_config *cfg,
+ uint32_t *start, uint32_t *len)
+{
+ int ret = 0;
+
+ /* Read fmap */
+ const char *const regions[] = {FMAP_RO_FMAP, NULL};
+ if (flashrom_read_image(&cfg->image_current, regions,
+ cfg->verbosity + 1))
+ return -1;
+
+ FmapAreaHeader *wp_ro = NULL;
+ uint8_t *r = fmap_find_by_name(cfg->image_current.data,
+ cfg->image_current.size,
+ NULL, FMAP_RO, &wp_ro);
+ if (!r || !wp_ro) {
+ ERROR("Could not find WP_RO in the FMAP\n");
+ ret = -1;
+ goto err;
+ }
+
+ *start = wp_ro->area_offset;
+ *len = wp_ro->area_size;
+
+err:
+ free(cfg->image_current.data);
+ cfg->image_current.data = NULL;
+ cfg->image_current.size = 0;
+
+ return ret;
+}
+
+static int print_wp_status(struct updater_config *cfg)
+{
+ /* Get WP_RO region start and length from image */
+ uint32_t ro_start, ro_len;
+ if (get_ro_range(cfg, &ro_start, &ro_len))
+ return -1;
+
+ /* Get current WP region and mode from SPI flash */
+ bool wp_mode;
+ uint32_t wp_start, wp_len;
+ if (flashrom_get_wp(cfg->image.programmer, &wp_mode,
+ &wp_start, &wp_len, cfg->verbosity + 1)) {
+ ERROR("Failed to get WP status\n");
+ return -1;
+ }
+
+ if (!wp_mode && wp_start == 0 && wp_len == 0) {
+ printf("WP status: disabled\n");
+ } else if (wp_mode && wp_start == ro_start && wp_len == ro_len) {
+ printf("WP status: enabled\n");
+ } else {
+ printf("WP status: misconfigured (srp = %d, start = %#010x, length = %#010x)\n",
+ wp_mode, wp_start, wp_len);
+ }
+
+ return 0;
+}
+
+
+static int set_flash_wp(struct updater_config *cfg, bool enable)
+{
+ uint32_t wp_start = 0;
+ uint32_t wp_len = 0;
+
+ if (enable) {
+ /* Use the WP_RO region as the protection range */
+ if (get_ro_range(cfg, &wp_start, &wp_len))
+ return -1;
+ }
+
+ if (flashrom_set_wp(cfg->image.programmer, enable,
+ wp_start, wp_len, cfg->verbosity + 1)) {
+ ERROR("Failed to modify WP configuration.\n");
+ return -1;
+ }
+
+ printf("%s WP\n", enable ? "Enabled" : "Disabled");
+
+ return 0;
+}
+
+/* Command line options */
+static struct option const long_opts[] = {
+ SHARED_FLASH_ARGS_LONGOPTS
+ /* name has_arg *flag val */
+ {"help", 0, NULL, 'h'},
+ {"wp-status", 0, NULL, 's'},
+ {"wp-enable", 0, NULL, 'e'},
+ {"wp-disable", 0, NULL, 'd'},
+ {"flash-size", 0, NULL, 'z'},
+ {NULL, 0, NULL, 0},
+};
+
+static const char *const short_opts = "h" SHARED_FLASH_ARGS_SHORTOPTS;
+
+static void print_help(int argc, char *argv[])
+{
+ printf("\n"
+ "Allows for the management of AP SPI flash configuration.\n"
+ "\n"
+ "Usage: " MYNAME " %s [OPTIONS] \n"
+ "\n"
+ " --wp-status \tGet the current flash WP state.\n"
+ " --wp-enable \tEnable protection for the RO image section.\n"
+ " --wp-disable \tDisable all write protection.\n"
+ " --flash-size \tGet flash size.\n"
+ "\n"
+ SHARED_FLASH_ARGS_HELP,
+ argv[0]);
+}
+
+static int do_flash(int argc, char *argv[])
+{
+ int ret = 0;
+ struct updater_config_arguments args = {0};
+ const char *prepare_ctrl_name = NULL;
+ char *servo_programmer = NULL;
+ bool enable_wp = false;
+ bool disable_wp = false;
+ bool get_wp_status = false;
+ bool get_size = false;
+
+ struct updater_config *cfg = updater_new_config();
+ assert(cfg);
+
+ opterr = 0;
+ int i;
+ while ((i = getopt_long(argc, argv, short_opts, long_opts, 0)) != -1) {
+ if (handle_flash_argument(&args, i, optarg))
+ continue;
+ switch (i) {
+ case 'h':
+ print_help(argc, argv);
+ goto out_free;
+ case 's':
+ get_wp_status = true;
+ break;
+ case 'e':
+ enable_wp = true;
+ break;
+ case 'd':
+ disable_wp = true;
+ break;
+ case 'z':
+ get_size = true;
+ break;
+ case 'v':
+ args.verbosity++;
+ break;
+ case '?':
+ ret = -1;
+ if (optopt)
+ ERROR("Unrecognized option: -%c\n", optopt);
+ else if (argv[optind - 1])
+ ERROR("Unrecognized option (possibly '%s')\n",
+ argv[optind - 1]);
+ else
+ ERROR("Unrecognized option.\n");
+ break;
+ default:
+ ret = -1;
+ ERROR("Failed parsing options.\n");
+ }
+ }
+ if (optind < argc) {
+ ret = -1;
+ ERROR("Unexpected arguments.\n");
+ }
+
+ if (!get_size && !enable_wp && !disable_wp && !get_wp_status) {
+ print_help(argc, argv);
+ goto out_free;
+ }
+
+ if (enable_wp && disable_wp) {
+ ret = -1;
+ ERROR("--wp-enable and --wp-disable cannot be used together.\n");
+ goto out_free;
+ }
+
+ if (args.detect_servo) {
+ servo_programmer = host_detect_servo(&prepare_ctrl_name);
+
+ if (!servo_programmer) {
+ ret = -1;
+ ERROR("No servo detected.\n");
+ goto out_free;
+ }
+ if (!args.programmer)
+ args.programmer = servo_programmer;
+ }
+
+ int update_needed;
+ ret = updater_setup_config(cfg, &args, &update_needed);
+ prepare_servo_control(prepare_ctrl_name, 1);
+
+ if (!ret && get_size)
+ ret = print_flash_size(cfg);
+
+ if (!ret && enable_wp)
+ ret = set_flash_wp(cfg, true);
+
+ if (!ret && disable_wp)
+ ret = set_flash_wp(cfg, false);
+
+ if (!ret && get_wp_status)
+ ret = print_wp_status(cfg);
+
+out_free:
+ prepare_servo_control(prepare_ctrl_name, 0);
+ free(servo_programmer);
+ updater_delete_config(cfg);
+
+ return ret;
+}
+#define CMD_HELP_STR "Manage AP SPI flash properties and writeprotect configuration"
+
+#else /* USE_FLASHROM */
+
+static int do_flash(int argc, char *argv[])
+{
+ FATAL(MYNAME " was built without flashrom support, `flash` command unavailable!\n");
+ return -1;
+}
+#define CMD_HELP_STR "Manage AP SPI flash properties and writeprotect configuration (unavailable in this build)"
+
+#endif /* !USE_FLASHROM */
+
+DECLARE_FUTIL_COMMAND(flash, do_flash, VBOOT_VERSION_ALL, CMD_HELP_STR);
View Lorry Controller Status