mirror of
				https://review.coreboot.org/flashrom.git
				synced 2025-11-03 23:00:13 +01:00 
			
		
		
		
	Add a new layout_compare() function which will be used in a subsequent
patch to test equality between two layouts. Add a test function for
layout_compare(). Fix a small bug in compare_region_with_dump() which
was introduced in commit 74a1a54892 ("libflashrom: Fix comparison of
layout romentry regions"), which was discovered with the new test.
Change-Id: Ib37556bb83d4e1c26545a90b49128f1f78ffe2c6
Signed-off-by: Matt DeVillier <matt.devillier@gmail.com>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/89629
Reviewed-by: Anastasia Klimchuk <aklm@chromium.org>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
		
	
		
			
				
	
	
		
			223 lines
		
	
	
		
			7.4 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			223 lines
		
	
	
		
			7.4 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/*
 | 
						|
 * This file is part of the flashrom project.
 | 
						|
 *
 | 
						|
 * SPDX-License-Identifier: GPL-2.0-only
 | 
						|
 * SPDX-FileCopyrightText: 2025 Dmitry Zhadinets <dzhadinets@gmail.com>
 | 
						|
 * SPDX-FileCopyrightText: 2025 Google LLC
 | 
						|
 */
 | 
						|
 | 
						|
#include <stdlib.h>
 | 
						|
 | 
						|
#include <include/test.h>
 | 
						|
#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)
 | 
						|
{
 | 
						|
	char message[3] = {0};
 | 
						|
	vsnprintf(message, 3, format, vargs);
 | 
						|
	assert_string_equal(message, "1\n");
 | 
						|
	return 0x666 + (int)level;
 | 
						|
}
 | 
						|
 | 
						|
static void test_log_callback_v2(enum flashrom_log_level level,
 | 
						|
				 const char *message, void *user_data)
 | 
						|
{
 | 
						|
	/* check that user dta has passed */
 | 
						|
	assert_ptr_not_equal(user_data, 0);
 | 
						|
	/* check that user_data is correct */
 | 
						|
	assert_int_equal(*(int *)(user_data), 100500);
 | 
						|
	/* check that format is working correctly */
 | 
						|
	assert_string_equal(message, "2\n");
 | 
						|
	*(int*)user_data = 0x666 + (int)level;
 | 
						|
}
 | 
						|
 | 
						|
void flashrom_set_log_callback_test_success(void **state)
 | 
						|
{
 | 
						|
	(void)state; /* unused */
 | 
						|
	flashrom_set_log_callback(test_log_callback);
 | 
						|
	/* check that callback is called */
 | 
						|
	assert_int_equal(print(FLASHROM_MSG_INFO, "1%s", "\n"), 0x666 + (int)FLASHROM_MSG_INFO);
 | 
						|
	flashrom_set_log_callback(NULL);
 | 
						|
}
 | 
						|
 | 
						|
void flashrom_set_log_callback_v2_test_success(void **state)
 | 
						|
{
 | 
						|
	(void)state; /* unused */
 | 
						|
	int user_data = 100500;
 | 
						|
	flashrom_set_log_callback_v2(test_log_callback_v2, &user_data);
 | 
						|
	print(FLASHROM_MSG_ERROR, "2%s", "\n");
 | 
						|
	/* check that callback is called */
 | 
						|
	assert_int_equal(user_data, 0x666 + (int)FLASHROM_MSG_ERROR);
 | 
						|
	flashrom_set_log_callback_v2(NULL, NULL);
 | 
						|
}
 | 
						|
 | 
						|
void flashrom_set_log_level_test_success(void **state)
 | 
						|
{
 | 
						|
	(void)state; /* unused */
 | 
						|
	int user_data;
 | 
						|
 | 
						|
	flashrom_set_log_level(FLASHROM_MSG_WARN);
 | 
						|
 | 
						|
	/* v2 API check */
 | 
						|
	user_data = 100500;
 | 
						|
	flashrom_set_log_callback_v2(test_log_callback_v2, &user_data);
 | 
						|
	print(FLASHROM_MSG_DEBUG, "2%s", "\n");
 | 
						|
	/* check that callback is not called */
 | 
						|
	assert_int_equal(user_data, 100500);
 | 
						|
	print(FLASHROM_MSG_ERROR, "2%s", "\n");
 | 
						|
	/* check that callback is called for less */
 | 
						|
	assert_int_equal(user_data, 0x666 + (int)FLASHROM_MSG_ERROR);
 | 
						|
	user_data = 100500;
 | 
						|
	print(FLASHROM_MSG_WARN, "2%s", "\n");
 | 
						|
	/* check that callback is called for equal */
 | 
						|
	assert_int_equal(user_data, 0x666 + (int)FLASHROM_MSG_WARN);
 | 
						|
 | 
						|
	/* v1 API check */
 | 
						|
	flashrom_set_log_callback(test_log_callback);
 | 
						|
 | 
						|
	/* check that callback is not called */
 | 
						|
	assert_int_equal(print(FLASHROM_MSG_INFO, "1%s", "\n"), 0);
 | 
						|
	/* check that callback is called for equal */
 | 
						|
	assert_int_equal(print(FLASHROM_MSG_WARN, "1%s", "\n"), 0x666 + (int)FLASHROM_MSG_WARN);
 | 
						|
	/* check that callback is called for less*/
 | 
						|
	assert_int_equal(print(FLASHROM_MSG_ERROR, "1%s", "\n"), 0x666 + (int)FLASHROM_MSG_ERROR);
 | 
						|
 | 
						|
	flashrom_set_log_level(FLASHROM_MSG_INFO);
 | 
						|
	/* check that callback is called after the change*/
 | 
						|
	assert_int_equal(print(FLASHROM_MSG_INFO, "1%s", "\n"), 0x666 + (int)FLASHROM_MSG_INFO);
 | 
						|
	flashrom_set_log_callback(NULL);
 | 
						|
}
 | 
						|
 | 
						|
void flashrom_supported_programmers_test_success(void **state)
 | 
						|
{
 | 
						|
	(void) state; /* unused */
 | 
						|
	const char **array = flashrom_supported_programmers();
 | 
						|
	const char **ptr = array;
 | 
						|
 | 
						|
	assert_non_null(array);
 | 
						|
 | 
						|
	do {
 | 
						|
		assert_non_null(*ptr);
 | 
						|
	}while (*(++ptr));
 | 
						|
 | 
						|
	flashrom_data_free(array);
 | 
						|
 | 
						|
	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 */
 | 
						|
 | 
						|
void flashrom_layout_compare_test_success(void **state)
 | 
						|
{
 | 
						|
	(void)state; /* unused */
 | 
						|
	struct flashrom_layout *layout1 = NULL;
 | 
						|
	struct flashrom_layout *layout2 = NULL;
 | 
						|
	struct flashrom_layout *layout3 = NULL;
 | 
						|
 | 
						|
	/* Create three layouts */
 | 
						|
	assert_int_equal(0, flashrom_layout_new(&layout1));
 | 
						|
	assert_int_equal(0, flashrom_layout_new(&layout2));
 | 
						|
	assert_int_equal(0, flashrom_layout_new(&layout3));
 | 
						|
 | 
						|
	/* Test 1: NULL pointer handling */
 | 
						|
	assert_int_not_equal(0, flashrom_layout_compare(NULL, layout1));
 | 
						|
	assert_int_not_equal(0, flashrom_layout_compare(layout1, NULL));
 | 
						|
	assert_int_not_equal(0, flashrom_layout_compare(NULL, NULL));
 | 
						|
 | 
						|
	/* Test 2: Empty layouts should match */
 | 
						|
	assert_int_equal(0, flashrom_layout_compare(layout1, layout2));
 | 
						|
 | 
						|
	/* Test 3: Add same regions to layout1 and layout2 */
 | 
						|
	assert_int_equal(0, flashrom_layout_add_region(layout1, 0x00000000, 0x000fffff, "REGION1"));
 | 
						|
	assert_int_equal(0, flashrom_layout_add_region(layout1, 0x00100000, 0x001fffff, "REGION2"));
 | 
						|
 | 
						|
	assert_int_equal(0, flashrom_layout_add_region(layout2, 0x00000000, 0x000fffff, "REGION1"));
 | 
						|
	assert_int_equal(0, flashrom_layout_add_region(layout2, 0x00100000, 0x001fffff, "REGION2"));
 | 
						|
 | 
						|
	/* Identical layouts should match */
 | 
						|
	assert_int_equal(0, flashrom_layout_compare(layout1, layout2));
 | 
						|
 | 
						|
	/* Test 4: Add different region to layout3 */
 | 
						|
	assert_int_equal(0, flashrom_layout_add_region(layout3, 0x00000000, 0x000fffff, "REGION1"));
 | 
						|
	assert_int_equal(0, flashrom_layout_add_region(layout3, 0x00100000, 0x002fffff, "REGION2")); /* different end */
 | 
						|
 | 
						|
	/* Different layouts should not match */
 | 
						|
	assert_int_not_equal(0, flashrom_layout_compare(layout1, layout3));
 | 
						|
 | 
						|
	/* Test 5: Different number of regions */
 | 
						|
	flashrom_layout_release(layout3);
 | 
						|
	assert_int_equal(0, flashrom_layout_new(&layout3));
 | 
						|
	assert_int_equal(0, flashrom_layout_add_region(layout3, 0x00000000, 0x000fffff, "REGION1"));
 | 
						|
	/* layout3 has only 1 region, layout1 has 2 */
 | 
						|
	assert_int_not_equal(0, flashrom_layout_compare(layout1, layout3));
 | 
						|
 | 
						|
	/* Test 6: Same regions but different names */
 | 
						|
	flashrom_layout_release(layout3);
 | 
						|
	assert_int_equal(0, flashrom_layout_new(&layout3));
 | 
						|
	assert_int_equal(0, flashrom_layout_add_region(layout3, 0x00000000, 0x000fffff, "DIFFERENT_NAME"));
 | 
						|
	assert_int_equal(0, flashrom_layout_add_region(layout3, 0x00100000, 0x001fffff, "REGION2"));
 | 
						|
	assert_int_not_equal(0, flashrom_layout_compare(layout1, layout3));
 | 
						|
 | 
						|
	/* Cleanup */
 | 
						|
	flashrom_layout_release(layout1);
 | 
						|
	flashrom_layout_release(layout2);
 | 
						|
	flashrom_layout_release(layout3);
 | 
						|
}
 |