Change in flashrom[master]: libflashrom: add querying functions with meson integration

[Michał Żygowski (Code Review)]

Hello ?ukasz Dmitrowski,

I'd like you to do a code review. Please visit

https://review.coreboot.org/c/flashrom/+/34363

to review the following change.

Change subject: libflashrom: add querying functions with meson integration
......................................................................

libflashrom: add querying functions with meson integration

Work based on [e-mail] code

Change-Id: I49041b8fa5700dabe59fef0d2337339d34cd6c6f
Signed-off-by: Artur Raglis 
Signed-off-by: Lukasz Dmitrowski 
---
M libflashrom.c
M libflashrom.h
M libflashrom.map
M meson.build
4 files changed, 187 insertions(+), 3 deletions(-)

git pull ssh://review.coreboot.org:29418/flashrom refs/changes/63/34363/1

diff --git a/libflashrom.c b/libflashrom.c
index f90a22c..cc26835 100644
--- a/libflashrom.c
+++ b/libflashrom.c
@@ -103,7 +103,142 @@
  * @{
  */

-/* TBD */
+/**
+ * @brief Returns flashrom version
+ * @return Flashrom version
+ */
+const char *flashrom_version_info(void)
+{
+	return flashrom_version;
+}
+
+/**
+ * @brief Returns list of supported programmers
+ * @return List of supported programmers
+ */
+const char **flashrom_supported_programmers(void)
+{
+	enum programmer p = 0;
+	const char **supported_programmers = NULL;
+	supported_programmers = malloc((PROGRAMMER_INVALID + 1) * sizeof(char*));
+
+	if (supported_programmers != NULL) {
+		for (; p < PROGRAMMER_INVALID; ++p) {
+			supported_programmers[p] = programmer_table[p].name;
+		}
+	} else {
+		msg_gerr("Memory allocation error!\n");
+	}
+
+	return supported_programmers;
+}
+
+/**
+ * @brief Returns list of supported flash chips
+ * @return List of supported flash chips
+ */
+flashrom_flashchip_info *flashrom_supported_flash_chips(void)
+{
+	int i = 0;
+	flashrom_flashchip_info *supported_flashchips = malloc(flashchips_size * sizeof(flashrom_flashchip_info));
+
+	if (supported_flashchips != NULL) {
+		for (; i < flashchips_size; ++i) {
+			supported_flashchips[i].vendor = flashchips[i].vendor;
+			supported_flashchips[i].name = flashchips[i].name;
+			supported_flashchips[i].tested.erase = (flashrom_test_state) flashchips[i].tested.erase;
+			supported_flashchips[i].tested.probe =  (flashrom_test_state) flashchips[i].tested.probe;
+			supported_flashchips[i].tested.read = (flashrom_test_state) flashchips[i].tested.read;
+			supported_flashchips[i].tested.write = (flashrom_test_state) flashchips[i].tested.write;
+			supported_flashchips[i].total_size = flashchips[i].total_size;
+		}
+	} else {
+		msg_gerr("Memory allocation error!\n");
+	}
+
+	return supported_flashchips;
+}
+
+/**
+ * @brief Returns list of supported mainboards
+ * @return List of supported mainboards
+ */
+flashrom_board_info *flashrom_supported_boards(void)
+{
+	int boards_known_size = 0;
+	int i = 0;
+	const struct board_info *binfo = boards_known;
+
+	while ((binfo++)->vendor)
+		++boards_known_size;
+	binfo = boards_known;
+	/* add place for {0} */
+	++boards_known_size;
+
+	flashrom_board_info *supported_boards = malloc(boards_known_size * sizeof(flashrom_board_info));
+
+	if (supported_boards != NULL) {
+		for (; i < boards_known_size; ++i) {
+			supported_boards[i].vendor = binfo[i].vendor;
+			supported_boards[i].name = binfo[i].name;
+			supported_boards[i].working = binfo[i].working;
+		}
+	} else {
+		msg_gerr("Memory allocation error!\n");
+	}
+
+	return supported_boards;
+}
+
+/**
+ * @brief Returns list of supported chipsets
+ * @return List of supported chipsets
+ */
+flashrom_chipset_info *flashrom_supported_chipsets(void)
+{
+	int chipset_enables_size = 0;
+	int i = 0;
+	const struct penable *chipset = chipset_enables;
+
+	while ((chipset++)->vendor_name)
+		++chipset_enables_size;
+	chipset = chipset_enables;
+	/* add place for {0}*/
+	++chipset_enables_size;
+
+	flashrom_chipset_info *supported_chipsets = malloc(chipset_enables_size * sizeof(flashrom_chipset_info));
+
+	if (supported_chipsets != NULL) {
+		for (; i < chipset_enables_size; ++i) {
+			supported_chipsets[i].vendor = chipset[i].vendor_name;
+			supported_chipsets[i].chipset = chipset[i].device_name;
+			supported_chipsets[i].vendor_id = chipset[i].vendor_id;
+			supported_chipsets[i].chipset_id = chipset[i].device_id;
+			supported_chipsets[i].status = chipset[i].status;
+	  }
+	} else {
+		msg_gerr("Memory allocation error!\n");
+	}
+
+	return supported_chipsets;
+}
+
+/**
+ * @brief Frees memory allocated by libflashrom API
+ * @param Pointer to block of memory which should be freed
+ * @return 0 on success
+ *         1 on null pointer error
+ */
+int flashrom_data_free(void *const p)
+{
+	if (!p) {
+		msg_gerr("flashrom_data_free - Null pointer!\n");
+		return 1;
+	} else {
+		free(p);
+		return 0;
+	}
+}

/** @} */ /* end flashrom-query */

diff --git a/libflashrom.h b/libflashrom.h
index 38c95d2..ebba16b 100644
--- a/libflashrom.h
+++ b/libflashrom.h
@@ -37,6 +37,50 @@
 typedef int(flashrom_log_callback)(enum flashrom_log_level, const char *format, va_list);
 void flashrom_set_log_callback(flashrom_log_callback *);

+/** @ingroup flashrom-query */
+typedef enum {
+	FLASHROM_TESTED_OK  = 0,
+	FLASHROM_TESTED_NT  = 1,
+	FLASHROM_TESTED_BAD = 2,
+	FLASHROM_TESTED_DEP = 3,
+	FLASHROM_TESTED_NA  = 4,
+} flashrom_test_state;
+
+typedef struct flashrom_flashchip_info {
+	const char *vendor;
+	const char *name;
+	unsigned int total_size;
+	struct flashrom_tested {
+		flashrom_test_state probe;
+		flashrom_test_state read;
+		flashrom_test_state erase;
+		flashrom_test_state write;
+	} tested;
+} flashrom_flashchip_info;
+
+typedef struct flashrom_board_info {
+	const char *vendor;
+	const char *name;
+	flashrom_test_state working;
+} flashrom_board_info;
+
+typedef struct flashrom_chipset_info {
+	const char *vendor;
+	const char *chipset;
+	uint16_t vendor_id;
+	uint16_t chipset_id;
+	flashrom_test_state status;
+} flashrom_chipset_info;
+
+const char *flashrom_version_info(void);
+void flashrom_system_info(void);
+const char **flashrom_supported_programmers(void);
+flashrom_flashchip_info *flashrom_supported_flash_chips(void);
+flashrom_board_info *flashrom_supported_boards(void);
+flashrom_chipset_info *flashrom_supported_chipsets(void);
+int flashrom_data_free(void *const p);
+
+/** @ingroup flashrom-prog */
 struct flashrom_programmer;
 int flashrom_programmer_init(struct flashrom_programmer **, const char *prog_name, const char *prog_params);
 int flashrom_programmer_shutdown(struct flashrom_programmer *);
diff --git a/libflashrom.map b/libflashrom.map
index 3c287ff..d6dd24d 100644
--- a/libflashrom.map
+++ b/libflashrom.map
@@ -1,7 +1,11 @@
 LIBFLASHROM_1.0 {
   global:
+    flashrom_board_info;
+    flashrom_chipset_info;
+    flashrom_data_free;
     flashrom_flag_get;
     flashrom_flag_set;
+    flashrom_flashchip_info;
     flashrom_flash_erase;
     flashrom_flash_getsize;
     flashrom_flash_probe;
@@ -20,5 +24,8 @@
     flashrom_programmer_shutdown;
     flashrom_set_log_callback;
     flashrom_shutdown;
+    flashrom_supported_programmers;
+    flashrom_system_info;
+    flashrom_version_info;
   local: *;
 };
diff --git a/meson.build b/meson.build
index 1923fdf..00f4a2f 100644
--- a/meson.build
+++ b/meson.build
@@ -68,8 +68,6 @@
 srcs = []

need_libusb0 = false
-need_raw_access = false
-need_serial = false

# check for required symbols
 if cc.has_function('clock_gettime')