From 5c998f7b6514182ad954509b5d6cbdf5a8b37257 Mon Sep 17 00:00:00 2001
From: annoyatron255 <annoyatron255@gmail.com>
Date: Mon, 6 May 2024 01:32:33 -0500
Subject: [PATCH] Add techmap README

---
 README.md           |  2 +-
 synth_gal.tcl       |  2 +-
 techmaps/README.md  | 18 ++++++++++++++++++
 techmaps/tristate.v | 17 -----------------
 4 files changed, 20 insertions(+), 19 deletions(-)
 create mode 100644 techmaps/README.md
 delete mode 100644 techmaps/tristate.v

diff --git a/README.md b/README.md
index f0beb18..83fe2b4 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ Usage
 -----
 To synthesize a Verilog file:
 ```
-./synth_gal.tcl <VERILOG_FILE> [CHIP]
+./synth_gal.tcl -- <VERILOG_FILE> [CHIP]
 ```
 Where `[CHIP]` is either `GAL16V8` (default) or `GAL22V10`. The synthesized
 JSON netlist will be put in `output/`.
diff --git a/synth_gal.tcl b/synth_gal.tcl
index b4e4a65..9361dc7 100755
--- a/synth_gal.tcl
+++ b/synth_gal.tcl
@@ -3,7 +3,7 @@ yosys -import
 
 ## Check arguments
 if { $argc != 1 && $argc != 2 } {
-	puts "USAGE: $argv0 -- <VERILOG FILE>"
+	puts "USAGE: $argv0 -- <VERILOG FILE> \[CHIP\]"
 	exit
 }
 
diff --git a/techmaps/README.md b/techmaps/README.md
new file mode 100644
index 0000000..fb076f4
--- /dev/null
+++ b/techmaps/README.md
@@ -0,0 +1,18 @@
+Techmaps
+========
+
+All the yosys techmapping libraries/Verilog files used for mapping to the GAL
+structure. See the `synth_gal.tcl` file for details on how they're used.
+A summary is below (in the order they're used):
+
+- `pla.v` splits SOPs into a chain of SOPs with a specified size
+- `trivial_sop.v` replaces SOPs which are just buffers/NOT gates with
+  buffer/NOT cells
+- `one_sop.v` converts GAL_SOPs with only one product into GAL_1SOPs. Used on
+  enabled (tristate) lines
+- `pla_olmc_int.v` adds a combinational GAL_OLMC after a GAL_SOP. Used to
+  insert GAL_OLMC between GAL_SOPs or enable lines
+- `olmc_comb.v` creates GAL_OLMCs for combinational/tristate output pads
+- `trivial_sop_olmc.v` adds a buffer GAL_SOP before a GAL_OLMC. Used to add
+  GAL_SOPs between directly connect GAL_OLMCs/GAL_INPUTs
+- `trivial_1sop_olmc.v` same as above but for enable lines
diff --git a/techmaps/tristate.v b/techmaps/tristate.v
deleted file mode 100644
index 48bc4c9..0000000
--- a/techmaps/tristate.v
+++ /dev/null
@@ -1,17 +0,0 @@
-module GAL_INOUT_TRI(A, E, I, Y);
-	input A, E;
-	output I;
-	inout Y;
-
-	generate
-		GAL_OLMC #(
-			REGISTERED = 0,
-			INVERTED = 0
-		) _TECHMAP_REPLACE_ (
-			.A(A),
-			.C(1'bX),
-			.E(E),
-			.Y(E ? Y : I);
-		);
-	endgenerate
-endmodule