[M] Change in flashrom[main]: libflashrom: Added API for capabilitible chips

[Dmitry Zhadinets (Code Review)]

Attention is currently required from: Anastasia Klimchuk.

Dmitry Zhadinets has uploaded this change for review. ( https://review.coreboot.org/c/flashrom/+/86946?usp=email )

Change subject: libflashrom: Added API for capabilitible chips
......................................................................

libflashrom: Added API for capabilitible chips

There were no options available to obtain the list of programmers,
compatible chips for the programmer, and layout region names.
The implementation is based on flashrom_supported_flash_chips.
Arrays of constant strings are returned, and the array must be
freed using flashrom_data_free.
BTW it would be good to add a notice about freeing memory to the
other flashrom_supported* functions.

Testing: Both unit tests and CLI tools serve as libflashrom clients.
    All unit tests run successfully.

Change-Id: I13c951f9404ae8b042cdb572e6117a09ac231747
Signed-off-by: Dmitry Zhadinets 
---
M include/libflashrom.h
M libflashrom.c
M libflashrom.map
M tests/libflashrom.c
M tests/tests.c
5 files changed, 51 insertions(+), 6 deletions(-)

git pull ssh://review.coreboot.org:29418/flashrom refs/changes/46/86946/1

diff --git a/include/libflashrom.h b/include/libflashrom.h
index e3893ac..7f90fa4 100644
--- a/include/libflashrom.h
+++ b/include/libflashrom.h
@@ -227,6 +227,14 @@
  */

/**
+ * @brief Returns list of supported chip names fo selected programmer
+ * @param[in] flashprog The flash programmer used to access the chip.
+ * @return List of supported flash chips, or NULL if an error occurred.
+ *  The pointer must be freed after using flashrom_data_free
+ */
+const char ** flashrom_programmer_capabilities(const struct flashrom_programmer *const flashprog);
+
+/**
  * @brief Probe for a flash chip.
  *
  * Probes for a flash chip and returns a flash context, that can be used
diff --git a/libflashrom.c b/libflashrom.c
index 9f177d7..76ab32a 100644
--- a/libflashrom.c
+++ b/libflashrom.c
@@ -279,7 +279,30 @@
    return programmer_shutdown();
 }

-/* TODO: flashrom_programmer_capabilities()? */
+const char ** flashrom_programmer_capabilities(const struct flashrom_programmer *const flashprog)
+{
+	(void) flashprog; /* unused */
+	unsigned int chipcount = 0;
+	const char ** result = malloc((flashchips_size + 1) * sizeof(char*));
+	struct flashrom_flashctx flashctx = { 0 };
+	for (int j = 0; j < registered_master_count; j++) {
+		int startchip = 0;
+
+		while (chipcount < flashchips_size) {
+			startchip = probe_flash(&registered_masters[j], startchip, &flashctx, 0, NULL);
+			if (startchip == -1)
+				break;
+			result[chipcount] = flashctx.chip->name;
+			chipcount++;
+			startchip++;
+			flashrom_layout_release(flashctx.default_layout);
+			free(flashctx.chip);
+		}
+	}
+	result = realloc(result, (chipcount + 1) * sizeof(char*));
+	result[chipcount] = 0;
+	return result;
+}

int flashrom_flash_probe(struct flashrom_flashctx **const flashctx,
    		 const struct flashrom_programmer *const flashprog,
diff --git a/libflashrom.map b/libflashrom.map
index 8e4635d..9af163e 100644
--- a/libflashrom.map
+++ b/libflashrom.map
@@ -21,6 +21,7 @@
     flashrom_layout_read_from_ifd;
     flashrom_layout_release;
     flashrom_layout_set;
+    flashrom_programmer_capabilities;
     flashrom_programmer_init;
     flashrom_programmer_shutdown;
     flashrom_set_log_callback;
@@ -30,6 +31,7 @@
     flashrom_supported_boards;
     flashrom_supported_chipsets;
     flashrom_supported_flash_chips;
+    flashrom_supported_programmers;
     flashrom_version_info;
     flashrom_wp_cfg_new;
     flashrom_wp_cfg_release;
diff --git a/tests/libflashrom.c b/tests/libflashrom.c
index 3d726c8..173c8a9 100644
--- a/tests/libflashrom.c
+++ b/tests/libflashrom.c
@@ -28,4 +28,16 @@
     while (*(ptr++)){}
    flashrom_data_free(array);
     assert_int_not_equal(ptr - array, 0);
+
+#if CONFIG_DUMMY == 1
+    struct flashrom_programmer *flashprog = NULL;
+    flashrom_programmer_init(&flashprog, "dummy", "emulate=SST25VF040.REMS");
+    array = flashrom_programmer_capabilities(flashprog);
+    ptr = array;
+    assert_non_null(array);
+    while (*(ptr++)){}
+	flashrom_data_free(array);
+    assert_int_equal(ptr - array, 2);
+    flashrom_programmer_shutdown(flashprog);
+#endif
 }
diff --git a/tests/tests.c b/tests/tests.c
index 2a4f597..49d8c0a 100644
--- a/tests/tests.c
+++ b/tests/tests.c
@@ -438,11 +438,6 @@
    };
    ret |= cmocka_run_group_tests_name("flashrom.c tests", flashrom_tests, NULL, NULL);

-	const struct CMUnitTest libflashrom_tests[] = {
-		cmocka_unit_test(enumerators_test_success),
-	};
-	ret |= cmocka_run_group_tests_name("libflashrom.c tests", libflashrom_tests, NULL, NULL);
-
    const struct CMUnitTest spi25_tests[] = {
    	cmocka_unit_test(spi_write_enable_test_success),
    	cmocka_unit_test(spi_write_disable_test_success),
@@ -458,6 +453,11 @@
    };
    ret |= cmocka_run_group_tests_name("spi25.c tests", spi25_tests, NULL, NULL);

+	const struct CMUnitTest libflashrom_tests[] = {
+		cmocka_unit_test(enumerators_test_success),
+	};
+	ret |= cmocka_run_group_tests_name("libflashrom.c tests", libflashrom_tests, NULL, NULL);
+
    const struct CMUnitTest lifecycle_tests[] = {
    	cmocka_unit_test(dummy_basic_lifecycle_test_success),
    	cmocka_unit_test(dummy_probe_lifecycle_test_success),