From dbc937b2a7482d243b16c5de1f508eee71b19a59 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Martin=20Povi=C5=A1er?= <povik@cutebit.org>
Date: Wed, 11 Sep 2024 21:09:28 +0200
Subject: [PATCH] aiger2: Describe supported cells in help

---
 backends/aiger2/aiger.cc | 47 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 46 insertions(+), 1 deletion(-)

diff --git a/backends/aiger2/aiger.cc b/backends/aiger2/aiger.cc
index 0c787f11d39..34b9eb3242d 100644
--- a/backends/aiger2/aiger.cc
+++ b/backends/aiger2/aiger.cc
@@ -21,6 +21,7 @@
 //  - gracefully handling inout ports (an error message probably)
 
 #include "kernel/register.h"
+#include "kernel/celltypes.h"
 
 USING_YOSYS_NAMESPACE
 PRIVATE_NAMESPACE_BEGIN
@@ -641,7 +642,51 @@ struct Aiger2Backend : Backend {
 		experimental();
 	}
 
-	void execute(std::ostream *&f, std::string filename, std::vector<std::string> args, RTLIL::Design *design) override
+	void help() override
+	{
+		//   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
+		log("\n");
+		log("    write_aiger2 [options] [filename]\n");
+		log("\n");
+		log("Write the current design to an AIGER file.\n");
+		log("\n");
+		log("This command is able to ingest all combinational cells except for:\n");
+		log("\n");
+		pool<IdString> supported = {KNOWN_OPS};
+		CellTypes ct;
+		ct.setup_internals_eval();
+		log("    ");
+		int col = 0;
+		for (auto pair : ct.cell_types)
+		if (!supported.count(pair.first)) {
+			if (col + pair.first.size() + 2 > 72) {
+				log("\n    ");
+				col = 0;
+			}
+			col += pair.first.size() + 2;
+			log("%s, ", log_id(pair.first));
+		}
+		log("\n");
+		log("\n");
+		log("And all combinational gates except for:\n");
+		log("\n");
+		CellTypes ct2;
+		ct2.setup_stdcells();
+		log("    ");
+		col = 0;
+		for (auto pair : ct2.cell_types)
+		if (!supported.count(pair.first)) {
+			if (col + pair.first.size() + 2 > 72) {
+				log("\n    ");
+				col = 0;
+			}
+			col += pair.first.size() + 2;
+			log("%s, ", log_id(pair.first));
+		}
+		log("\n");
+	}
+
+	void execute(std::ostream *&f, std::string filename, std::vector<std::string> args, Design *design) override
 	{
 		log_header(design, "Executing AIGER2 backend.\n");