openwrt/flashrom
1
0
Fork 0
mirror of https://review.coreboot.org/flashrom.git synced 2025-07-03 23:13:18 +02:00
Code Issues Releases Wiki Activity

probe_flash: Introduce an error code for "other" probing errors

Browse Source 
Previously probe_flash had the same return code for the case when
no chips were matched, and when some other error happened during
probing. However these are two different scenarios and it is useful
for the caller to distinguish between them.

In fact, the caller (libflashrom it is) wanted to distinguish
between "no chips found" and "some other probing error" from the
very beginning. libflashrom probe API documented returning special
error code for "other error".
However it was not possible to know when "other error" happened
because probe_flash never returned that back, it could only say
"no matched chips found".

This patch introduces -2 as "other error" code from probe_flash,
while -1 remains as "no chips found".
Both libflashrom probe APIs v1 and v2 are now handling "other error"
from probe_flash and return it to the API callers as was promised in
the documentation.

This also adds a unit test for error code propagation for "no chips
found" error.

Change-Id: I4a271550bea2b36c657c71ce6cb1927082663c3c
Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/88008
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
Reviewed-by: Peter Marheine <pmarheine@chromium.org>
This commit is contained in:
Anastasia Klimchuk
2025-06-09 23:06:44 +10:00
parent b41fc17099
commit e5f377c662
8 changed files with 98 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
tests/libflashrom.c
View File

@ -2,6 +2,7 @@
* This file is part of the flashrom project.
*
* Copyright 2025 Dmitry Zhadinets <dzhadinets@gmail.com>
* Copyright 2025 Google LLC
*
* 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
@ -19,6 +20,7 @@
#include "tests.h"
#include "libflashrom.h"
#include "flash.h"
#include "programmer.h"
static int test_log_callback(enum flashrom_log_level level, const char *format,
va_list vargs)
@ -114,3 +116,58 @@ void flashrom_supported_programmers_test_success(void **state)
assert_int_not_equal(ptr - array, 0);
}
#if CONFIG_DUMMY == 1
typedef void* (map_flash_fn)(const char *descr, uintptr_t phys_addr, size_t len);
typedef int (spi_send_fn)(const struct flashctx *flash, unsigned int writecnt,
unsigned int readcnt,
const unsigned char *writearr,
unsigned char *readarr);
static void *always_fail_map(const char *descr, uintptr_t phys_addr, size_t len)
{
return ERROR_PTR;
}
static int always_fail_spi_send_command(const struct flashctx *flash, unsigned int writecnt,
unsigned int readcnt,
const unsigned char *writearr,
unsigned char *readarr)
{
return -1;
}
void probe_v2_error_code_propagation(void **state)
{
(void) state; /* unused */
struct flashrom_flashctx flashctx = { 0 };
struct flashrom_programmer *flashprog;
const char **all_matched_names = NULL;
assert_int_equal(0, flashrom_programmer_init(&flashprog,
programmer_dummy.name,
"bus=spi,emulate=W25Q128FV"));
map_flash_fn *original_map_flash = registered_masters[0].spi.map_flash_region;
spi_send_fn *original_spi_send = registered_masters[0].spi.command;
/* This makes sure probe_flash fails. */
registered_masters[0].spi.map_flash_region = &always_fail_map;
registered_masters[0].spi.command = &always_fail_spi_send_command;
assert_int_equal(0 /* no chips found */,
flashrom_flash_probe_v2(&flashctx, &all_matched_names,
flashprog,
NULL));
/* restore programmer functions */
registered_masters[0].spi.map_flash_region = original_map_flash;
registered_masters[0].spi.command = original_spi_send;
assert_int_equal(0, flashrom_programmer_shutdown(flashprog));
flashrom_data_free(all_matched_names);
}
#else
SKIP_TEST(probe_v2_error_code_propagation)
#endif /* CONFIG_DUMMY */