mirror of
https://review.coreboot.org/flashrom.git
synced 2025-11-14 03:30:41 +01:00
d867ef7256
flashrom_create_context does create and all initialisations needed for flash context. The real life usage of flashrom_flash_probe_v2 discovered the issue: error: variable 'flashctx' has initializer but incomplete type error: storage size of 'flashctx' isn't known flashrom_create_context fixes this, it would need to be called prior to any other api calls that require flash context. The patch also adds test which runs as external client for libflashrom. The test runs in a separate test executable, so that it does not use flashrom source code but instead uses libflashrom as a library. It is also an example how to use libflashrom api. Change-Id: I483f6cabb2b4ed27e0ee10bf621ae1bddb1fc9f3 Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/89603 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Peter Marheine <pmarheine@chromium.org>
116 lines
4.2 KiB
C
116 lines
4.2 KiB
C
/*
|
|
* This file is part of the flashrom project.
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-only
|
|
* SPDX-FileCopyrightText: 2021 Google LLC
|
|
*/
|
|
|
|
#include "lifecycle.h"
|
|
|
|
static void probe_chip_v2(const struct programmer_entry *prog,
|
|
struct flashrom_programmer *flashprog,
|
|
const char *const chip_name,
|
|
const char **expected_matched_names,
|
|
unsigned int expected_matched_count)
|
|
{
|
|
struct flashrom_flashctx *flashctx = NULL;
|
|
assert_int_equal(0, flashrom_create_context(&flashctx));
|
|
const char **all_matched_names = NULL;
|
|
|
|
printf("Testing flashrom_flash_probe_v2 for programmer=%s, chip=%s ... \n", prog->name, chip_name);
|
|
assert_int_equal(expected_matched_count, flashrom_flash_probe_v2(flashctx, &all_matched_names,
|
|
flashprog, chip_name));
|
|
|
|
for (unsigned int i = 0; i < expected_matched_count; i++)
|
|
assert_int_equal(0, strcmp(expected_matched_names[i], all_matched_names[i]));
|
|
|
|
assert_null(all_matched_names[expected_matched_count]);
|
|
|
|
if (chip_name && expected_matched_count > 0)
|
|
assert_int_equal(0, strcmp(chip_name, flashctx->chip->name));
|
|
|
|
printf("... flashrom_flash_probe_v2 for programmer=%s successful\n", prog->name);
|
|
|
|
/* cleanup */
|
|
flashrom_data_free(all_matched_names);
|
|
flashrom_flash_release(flashctx);
|
|
}
|
|
|
|
static void run_lifecycle(void **state, const struct io_mock *io, const struct programmer_entry *prog,
|
|
const char *param, const char *const chip_name,
|
|
const char **expected_matched_names,
|
|
unsigned int expected_matched_count,
|
|
void (*action)(const struct programmer_entry *prog,
|
|
struct flashrom_programmer *flashprog,
|
|
const char *const chip_name,
|
|
const char **expected_matched_names,
|
|
unsigned int expected_matched_count))
|
|
{
|
|
(void) state; /* unused */
|
|
|
|
io_mock_register(io);
|
|
|
|
struct flashrom_programmer *flashprog;
|
|
|
|
printf("Testing flashrom_programmer_init for programmer=%s ...\n", prog->name);
|
|
assert_int_equal(0, flashrom_programmer_init(&flashprog, prog->name, param));
|
|
printf("... flashrom_programmer_init for programmer=%s successful\n", prog->name);
|
|
|
|
if (action)
|
|
action(prog, flashprog, chip_name, expected_matched_names, expected_matched_count);
|
|
|
|
printf("Testing flashrom_programmer_shutdown for programmer=%s ...\n", prog->name);
|
|
assert_int_equal(0, flashrom_programmer_shutdown(flashprog));
|
|
printf("... flashrom_programmer_shutdown for programmer=%s successful\n", prog->name);
|
|
|
|
io_mock_register(NULL);
|
|
}
|
|
|
|
void run_basic_lifecycle(void **state, const struct io_mock *io,
|
|
const struct programmer_entry *prog, const char *param)
|
|
{
|
|
/* Basic lifecycle only does init and shutdown,
|
|
* so neither chip name nor action is needed. */
|
|
run_lifecycle(state, io, prog, param, NULL /* chip_name */,
|
|
NULL /* expected_matched_names, */, 0 /* expected_matched_count, */,
|
|
NULL /* action */);
|
|
}
|
|
|
|
void run_probe_v2_lifecycle(void **state, const struct io_mock *io,
|
|
const struct programmer_entry *prog, const char *param,
|
|
const char *const chip_name,
|
|
const char **expected_matched_names, unsigned int expected_matched_count)
|
|
{
|
|
/* Each probe lifecycle should run independently, without cache. */
|
|
clear_spi_id_cache();
|
|
run_lifecycle(state, io, prog, param, chip_name,
|
|
expected_matched_names, expected_matched_count, &probe_chip_v2);
|
|
}
|
|
|
|
void run_init_error_path(void **state, const struct io_mock *io, const struct programmer_entry *prog,
|
|
const char *param, const int error_code)
|
|
{
|
|
(void) state; /* unused */
|
|
|
|
io_mock_register(io);
|
|
|
|
struct flashrom_programmer *flashprog;
|
|
|
|
printf("Testing init error path for programmer=%s with params: %s ...\n", prog->name, param);
|
|
assert_int_equal(error_code, flashrom_programmer_init(&flashprog, prog->name, param));
|
|
printf("... init failed with error code %i as expected\n", error_code);
|
|
|
|
/*
|
|
* `flashrom_programmer_shutdown` runs only registered shutdown functions, which means
|
|
* if nothing has been registered then nothing runs.
|
|
* Since this is testing error path on initialisation and error can happen at different
|
|
* phases of init, we don't know whether shutdown function has already been registered
|
|
* or not yet. Running `flashrom_programmer_shutdown` covers both situations.
|
|
*/
|
|
printf("Running programmer shutdown in case anything got registered...\n");
|
|
assert_int_equal(0, flashrom_programmer_shutdown(flashprog));
|
|
printf("... completed\n");
|
|
|
|
io_mock_register(NULL);
|
|
}
|