1
0
mirror of https://review.coreboot.org/flashrom.git synced 2025-11-14 03:30:41 +01:00

libflashrom: Add flashrom_create_context to create and init context

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>
This commit is contained in:
Anastasia Klimchuk
2025-10-16 15:25:24 +11:00
parent 666f6366c9
commit d867ef7256
13 changed files with 266 additions and 61 deletions

84
tests/external_client.c Normal file
View File

@@ -0,0 +1,84 @@
/*
* This file is part of the flashrom project.
*
* SPDX-License-Identifier: GPL-2.0-only
* SPDX-FileCopyrightText: 2025 Google LLC
*/
/*
* The purpose of this test is to use libflashrom API as an external client.
*
* Therefore, the test *must not* include any flashrom-internal headers.
* In meson files, test depends on a special `libflashrom_test_dep` and runs
* in a separate test executable `flashrom_client_tests`.
*/
#include <stdio.h>
#include <string.h>
#include "client_tests.h"
#include "libflashrom.h"
#define DUMMYFLASHER_NAME "dummy"
void flashrom_init_probe_erase_shutdown(void **state)
{
(void) state; /* unused */
assert_int_equal(0, flashrom_init(1));
printf("flashrom_init with selfcheck: OK\n");
struct flashrom_programmer *flashprog = NULL;
struct flashrom_flashctx *flashctx;
const char **all_matched_names = NULL;
assert_int_equal(0, flashrom_create_context(&flashctx));
printf("flashrom_create_context: OK\n");
const char **progs_names = flashrom_supported_programmers();
assert_non_null(progs_names);
const char **ptr = progs_names;
bool dummyflasher_support = false;
do {
if (!strcmp(*ptr, DUMMYFLASHER_NAME)) {
dummyflasher_support = true;
break;
}
} while (*(++ptr));
flashrom_data_free(progs_names);
if (dummyflasher_support) {
printf("dummyflasher supported: OK\n");
assert_int_equal(0, flashrom_programmer_init(
&flashprog,
DUMMYFLASHER_NAME,
"bus=spi,emulate=W25Q128FV"));
printf("flashrom_programmer_init for dummy with params 'bus=spi,emulate=W25Q128FV': OK\n");
assert_int_equal(1, flashrom_flash_probe_v2(
flashctx,
&all_matched_names,
flashprog,
NULL));
printf("flashrom_flash_probe_v2 found 1 chip: OK\n");
assert_int_equal(0, strcmp("W25Q128.V", all_matched_names[0]));
printf("chip name matches 'W25Q128.V': OK\n");
assert_int_equal(16777216, flashrom_flash_getsize(flashctx));
printf("chip size 16M: OK\n");
assert_int_equal(0, flashrom_flash_erase(flashctx));
printf("flashrom_flash_erase: OK\n");
assert_int_equal(0, flashrom_programmer_shutdown(flashprog));
printf("flashrom_programmer_shutdown: OK\n");
} else {
printf("WARNING: dummyflasher is disabled, cannot test probe and erase\n");
}
flashrom_flash_release(flashctx);
printf("flashrom_flash_release: OK\n");
assert_int_equal(0, flashrom_shutdown());
printf("flashrom_shutdown: OK\n");
}