mirror of
https://review.coreboot.org/flashrom.git
synced 2025-04-26 22:52:34 +02:00
40892b0c08
Projects using libflashrom like fwupd expect the user to wait for the operation to complete. To avoid the user thinking the process has "hung" or "got stuck" report back the progress complete of the erase, write and read operations. Add a new --progress flag to the CLI to report progress of operations. Include a test for the dummy spi25 device. TEST=./test_build.sh; ./flashrom -p lspcon_i2c_spi:bus=7 -r /dev/null --progress Change-Id: I7197572bb7f19e3bdb2bde855d70a0f50fd3854c Signed-off-by: Richard Hughes <richard@hughsie.com> Signed-off-by: Daniel Campello <campello@chromium.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/49643 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Edward O'Callaghan <quasisec@chromium.org> Reviewed-by: Anastasia Klimchuk <aklm@chromium.org> Reviewed-by: Thomas Heijligen <src@posteo.de>
121 lines
3.3 KiB
C
121 lines
3.3 KiB
C
/*
|
|
* This file is part of the flashrom project.
|
|
*
|
|
* Copyright (C) 2009 Sean Nelson <audiohacked@gmail.com>
|
|
* Copyright (C) 2011 Carl-Daniel Hailfinger
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*/
|
|
|
|
#include <stdio.h>
|
|
#include <stdarg.h>
|
|
#include <string.h>
|
|
#include <errno.h>
|
|
#include "flash.h"
|
|
|
|
enum flashrom_log_level verbose_screen = FLASHROM_MSG_INFO;
|
|
enum flashrom_log_level verbose_logfile = FLASHROM_MSG_DEBUG2;
|
|
|
|
static FILE *logfile = NULL;
|
|
|
|
int close_logfile(void)
|
|
{
|
|
if (!logfile)
|
|
return 0;
|
|
/* No need to call fflush() explicitly, fclose() already does that. */
|
|
if (fclose(logfile)) {
|
|
/* fclose returned an error. Stop writing to be safe. */
|
|
logfile = NULL;
|
|
msg_gerr("Closing the log file returned error %s\n", strerror(errno));
|
|
return 1;
|
|
}
|
|
logfile = NULL;
|
|
return 0;
|
|
}
|
|
|
|
int open_logfile(const char * const filename)
|
|
{
|
|
if (!filename) {
|
|
msg_gerr("No logfile name specified.\n");
|
|
return 1;
|
|
}
|
|
if ((logfile = fopen(filename, "w")) == NULL) {
|
|
msg_gerr("Error: opening log file \"%s\" failed: %s\n", filename, strerror(errno));
|
|
return 1;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
void start_logging(void)
|
|
{
|
|
enum flashrom_log_level oldverbose_screen = verbose_screen;
|
|
|
|
/* Shut up the console. */
|
|
verbose_screen = FLASHROM_MSG_ERROR;
|
|
print_version();
|
|
verbose_screen = oldverbose_screen;
|
|
}
|
|
|
|
static const char *flashrom_progress_stage_to_string(enum flashrom_progress_stage stage)
|
|
{
|
|
if (stage == FLASHROM_PROGRESS_READ)
|
|
return "READ";
|
|
if (stage == FLASHROM_PROGRESS_WRITE)
|
|
return "WRITE";
|
|
if (stage == FLASHROM_PROGRESS_ERASE)
|
|
return "ERASE";
|
|
return "UNKNOWN";
|
|
}
|
|
|
|
void flashrom_progress_cb(struct flashrom_flashctx *flashctx)
|
|
{
|
|
struct flashrom_progress *progress_state = flashctx->progress_state;
|
|
unsigned int pc = 0;
|
|
unsigned int *percentages = progress_state->user_data;
|
|
if (progress_state->current > 0 && progress_state->total > 0)
|
|
pc = ((unsigned long long) progress_state->current * 10000llu) /
|
|
((unsigned long long) progress_state->total * 100llu);
|
|
if (percentages[progress_state->stage] != pc) {
|
|
percentages[progress_state->stage] = pc;
|
|
msg_ginfo("[%s] %u%% complete... ", flashrom_progress_stage_to_string(progress_state->stage), pc);
|
|
}
|
|
}
|
|
|
|
/* Please note that level is the verbosity, not the importance of the message. */
|
|
int flashrom_print_cb(enum flashrom_log_level level, const char *fmt, va_list ap)
|
|
{
|
|
int ret = 0;
|
|
FILE *output_type = stdout;
|
|
|
|
va_list logfile_args;
|
|
va_copy(logfile_args, ap);
|
|
|
|
if (level < FLASHROM_MSG_INFO)
|
|
output_type = stderr;
|
|
|
|
if (level <= verbose_screen) {
|
|
ret = vfprintf(output_type, fmt, ap);
|
|
/* msg_*spew often happens inside chip accessors in possibly
|
|
* time-critical operations. Don't slow them down by flushing. */
|
|
if (level != FLASHROM_MSG_SPEW)
|
|
fflush(output_type);
|
|
}
|
|
|
|
if ((level <= verbose_logfile) && logfile) {
|
|
ret = vfprintf(logfile, fmt, logfile_args);
|
|
if (level != FLASHROM_MSG_SPEW)
|
|
fflush(logfile);
|
|
}
|
|
|
|
va_end(logfile_args);
|
|
return ret;
|
|
}
|