mirror of
				https://github.com/YosysHQ/yosys
				synced 2025-10-31 03:32:29 +00:00 
			
		
		
		
	Add proc_rom pass.
This commit is contained in:
		
							parent
							
								
									c862b1dbfb
								
							
						
					
					
						commit
						990c9b8e11
					
				
					 5 changed files with 283 additions and 1 deletions
				
			
		|  | @ -46,7 +46,7 @@ struct MemRd : RTLIL::AttrObject { | |||
| 	std::vector<bool> collision_x_mask; | ||||
| 	SigSpec clk, en, arst, srst, addr, data; | ||||
| 
 | ||||
| 	MemRd() : removed(false), cell(nullptr) {} | ||||
| 	MemRd() : removed(false), cell(nullptr), wide_log2(0), clk_enable(false), clk_polarity(true), ce_over_srst(false), clk(State::Sx), en(State::S1), arst(State::S0), srst(State::S0) {} | ||||
| 
 | ||||
| 	// Returns the address of given subword index accessed by this port.
 | ||||
| 	SigSpec sub_addr(int sub) { | ||||
|  |  | |||
|  | @ -5,6 +5,7 @@ OBJS += passes/proc/proc_clean.o | |||
| OBJS += passes/proc/proc_rmdead.o | ||||
| OBJS += passes/proc/proc_init.o | ||||
| OBJS += passes/proc/proc_arst.o | ||||
| OBJS += passes/proc/proc_rom.o | ||||
| OBJS += passes/proc/proc_mux.o | ||||
| OBJS += passes/proc/proc_dlatch.o | ||||
| OBJS += passes/proc/proc_dff.o | ||||
|  |  | |||
|  | @ -40,6 +40,7 @@ struct ProcPass : public Pass { | |||
| 		log("    proc_prune\n"); | ||||
| 		log("    proc_init\n"); | ||||
| 		log("    proc_arst\n"); | ||||
| 		log("    proc_rom\n"); | ||||
| 		log("    proc_mux\n"); | ||||
| 		log("    proc_dlatch\n"); | ||||
| 		log("    proc_dff\n"); | ||||
|  | @ -55,6 +56,9 @@ struct ProcPass : public Pass { | |||
| 		log("    -nomux\n"); | ||||
| 		log("        Will omit the proc_mux pass.\n"); | ||||
| 		log("\n"); | ||||
| 		log("    -norom\n"); | ||||
| 		log("        Will omit the proc_rom pass.\n"); | ||||
| 		log("\n"); | ||||
| 		log("    -global_arst [!]<netname>\n"); | ||||
| 		log("        This option is passed through to proc_arst.\n"); | ||||
| 		log("\n"); | ||||
|  | @ -72,6 +76,7 @@ struct ProcPass : public Pass { | |||
| 		bool ifxmode = false; | ||||
| 		bool nomux = false; | ||||
| 		bool noopt = false; | ||||
| 		bool norom = false; | ||||
| 
 | ||||
| 		log_header(design, "Executing PROC pass (convert processes to netlists).\n"); | ||||
| 		log_push(); | ||||
|  | @ -95,6 +100,10 @@ struct ProcPass : public Pass { | |||
| 				noopt = true; | ||||
| 				continue; | ||||
| 			} | ||||
| 			if (args[argidx] == "-norom") { | ||||
| 				norom = true; | ||||
| 				continue; | ||||
| 			} | ||||
| 			break; | ||||
| 		} | ||||
| 		extra_args(args, argidx, design); | ||||
|  | @ -108,6 +117,8 @@ struct ProcPass : public Pass { | |||
| 			Pass::call(design, "proc_arst"); | ||||
| 		else | ||||
| 			Pass::call(design, "proc_arst -global_arst " + global_arst); | ||||
| 		if (!norom) | ||||
| 			Pass::call(design, "proc_rom"); | ||||
| 		if (!nomux) | ||||
| 			Pass::call(design, ifxmode ? "proc_mux -ifx" : "proc_mux"); | ||||
| 		Pass::call(design, "proc_dlatch"); | ||||
|  |  | |||
							
								
								
									
										227
									
								
								passes/proc/proc_rom.cc
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										227
									
								
								passes/proc/proc_rom.cc
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,227 @@ | |||
| /*
 | ||||
|  *  yosys -- Yosys Open SYnthesis Suite | ||||
|  * | ||||
|  *  Copyright (C) 2022  Marcelina Kościelnicka <mwk@0x04.net> | ||||
|  * | ||||
|  *  Permission to use, copy, modify, and/or distribute this software for any | ||||
|  *  purpose with or without fee is hereby granted, provided that the above | ||||
|  *  copyright notice and this permission notice appear in all copies. | ||||
|  * | ||||
|  *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||||
|  *  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||||
|  *  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||||
|  *  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||||
|  *  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||||
|  *  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||||
|  *  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||||
|  * | ||||
|  */ | ||||
| 
 | ||||
| #include "kernel/register.h" | ||||
| #include "kernel/sigtools.h" | ||||
| #include "kernel/log.h" | ||||
| #include "kernel/mem.h" | ||||
| #include <stdlib.h> | ||||
| #include <stdio.h> | ||||
| 
 | ||||
| USING_YOSYS_NAMESPACE | ||||
| PRIVATE_NAMESPACE_BEGIN | ||||
| 
 | ||||
| struct RomWorker | ||||
| { | ||||
| 	RTLIL::Module *module; | ||||
| 	SigMap sigmap; | ||||
| 
 | ||||
| 	int count = 0; | ||||
| 
 | ||||
| 	RomWorker(RTLIL::Module *mod) : module(mod), sigmap(mod) {} | ||||
| 
 | ||||
| 	void do_switch(RTLIL::SwitchRule *sw) | ||||
| 	{ | ||||
| 		for (auto cs : sw->cases) { | ||||
| 			do_case(cs); | ||||
| 		} | ||||
| 
 | ||||
| 		if (sw->cases.empty()) { | ||||
| 			log_debug("rejecting switch: no cases\n"); | ||||
| 			return; | ||||
| 		} | ||||
| 		if (GetSize(sw->signal) > 30) { | ||||
| 			log_debug("rejecting switch: address too wide\n"); | ||||
| 			return; | ||||
| 		} | ||||
| 
 | ||||
| 		// A switch can be converted into ROM when:
 | ||||
| 		//
 | ||||
| 		// 1. No case contains a nested switch
 | ||||
| 		// 2. All cases have the same set of assigned signals
 | ||||
| 		// 3. All right-hand values in cases are constants
 | ||||
| 		// 4. All compare values used in cases are fully-defined constants
 | ||||
| 		// 5. The cases must cover all possible values (possibly by using default case)
 | ||||
| 
 | ||||
| 		SigSpec lhs; | ||||
| 		dict<SigBit, int> lhs_lookup; | ||||
| 		for (auto &it: sw->cases[0]->actions) { | ||||
| 			for (auto bit: it.first) { | ||||
| 				if (!lhs_lookup.count(bit)) { | ||||
| 					lhs_lookup[bit] = GetSize(lhs); | ||||
| 					lhs.append(bit); | ||||
| 				} | ||||
| 			} | ||||
| 		} | ||||
| 
 | ||||
| 		dict<int, Const> vals; | ||||
| 		Const default_val; | ||||
| 		bool got_default = false; | ||||
| 		for (auto cs : sw->cases) { | ||||
| 			if (!cs->switches.empty()) { | ||||
| 				log_debug("rejecting switch: has nested switches\n"); | ||||
| 				return; | ||||
| 			} | ||||
| 			Const val = Const(State::Sm, GetSize(lhs)); | ||||
| 			for (auto &it: cs->actions) { | ||||
| 				if (!it.second.is_fully_const()) { | ||||
| 					log_debug("rejecting switch: rhs not const\n"); | ||||
| 					return; | ||||
| 				} | ||||
| 				for (int i = 0; i < GetSize(it.first); i++) { | ||||
| 					auto it2 = lhs_lookup.find(it.first[i]); | ||||
| 					if (it2 == lhs_lookup.end()) { | ||||
| 						log_debug("rejecting switch: lhs not uniform\n"); | ||||
| 						return; | ||||
| 					} | ||||
| 					val[it2->second] = it.second[i].data; | ||||
| 				} | ||||
| 			} | ||||
| 			for (auto bit: val.bits) { | ||||
| 				if (bit == State::Sm) { | ||||
| 					log_debug("rejecting switch: lhs not uniform\n"); | ||||
| 					return; | ||||
| 				} | ||||
| 			} | ||||
| 
 | ||||
| 			for (auto &addr: cs->compare) { | ||||
| 				if (!addr.is_fully_def()) { | ||||
| 					log_debug("rejecting switch: case value has undef bits\n"); | ||||
| 					return; | ||||
| 				} | ||||
| 				int a = addr.as_int(); | ||||
| 				if (vals.count(a)) | ||||
| 					continue; | ||||
| 				vals[a] = val; | ||||
| 			} | ||||
| 			if (cs->compare.empty()) { | ||||
| 				default_val = val; | ||||
| 				got_default = true; | ||||
| 				break; | ||||
| 			} | ||||
| 		} | ||||
| 		int total = 1 << GetSize(sw->signal); | ||||
| 		if (!got_default && GetSize(vals) != total) { | ||||
| 			log_debug("rejecting switch: not all values are covered\n"); | ||||
| 			return; | ||||
| 		} | ||||
| 
 | ||||
| 		// TODO: better density heuristic?
 | ||||
| 		if (GetSize(vals) < 8) { | ||||
| 			log_debug("rejecting switch: not enough values\n"); | ||||
| 			return; | ||||
| 		} | ||||
| 		if (total / GetSize(vals) > 4) { | ||||
| 			log_debug("rejecting switch: not enough density\n"); | ||||
| 			return; | ||||
| 		} | ||||
| 
 | ||||
| 		// Ok, let's do it.
 | ||||
| 		SigSpec rdata = module->addWire(NEW_ID, GetSize(lhs)); | ||||
| 		Mem mem(module, NEW_ID, GetSize(lhs), 0, total); | ||||
| 		mem.attributes = sw->attributes; | ||||
| 
 | ||||
| 		Const init_data; | ||||
| 		for (int i = 0; i < total; i++) { | ||||
| 			auto it = vals.find(i); | ||||
| 			if (it == vals.end()) { | ||||
| 				log_assert(got_default); | ||||
| 				for (auto bit: default_val.bits) | ||||
| 					init_data.bits.push_back(bit); | ||||
| 			} else { | ||||
| 				for (auto bit: it->second.bits) | ||||
| 					init_data.bits.push_back(bit); | ||||
| 			} | ||||
| 		} | ||||
| 
 | ||||
| 		MemInit init; | ||||
| 		init.addr = 0; | ||||
| 		init.data = init_data; | ||||
| 		init.en = Const(State::S1, GetSize(lhs)); | ||||
| 		mem.inits.push_back(std::move(init)); | ||||
| 
 | ||||
| 		MemRd rd; | ||||
| 		rd.addr = sw->signal; | ||||
| 		rd.data = rdata; | ||||
| 		rd.init_value = Const(State::Sx, GetSize(lhs)); | ||||
| 		rd.arst_value = Const(State::Sx, GetSize(lhs)); | ||||
| 		rd.srst_value = Const(State::Sx, GetSize(lhs)); | ||||
| 		mem.rd_ports.push_back(std::move(rd)); | ||||
| 
 | ||||
| 		mem.emit(); | ||||
| 		for (auto cs: sw->cases) | ||||
| 			delete cs; | ||||
| 		sw->cases.clear(); | ||||
| 		sw->signal = SigSpec(); | ||||
| 		RTLIL::CaseRule *cs = new RTLIL::CaseRule; | ||||
| 		cs->actions.push_back(SigSig(lhs, rdata)); | ||||
| 		sw->cases.push_back(cs); | ||||
| 
 | ||||
| 		count += 1; | ||||
| 	} | ||||
| 
 | ||||
| 	void do_case(RTLIL::CaseRule *cs) | ||||
| 	{ | ||||
| 		for (auto sw: cs->switches) { | ||||
| 			do_switch(sw); | ||||
| 		} | ||||
| 	} | ||||
| 
 | ||||
| 	void do_process(RTLIL::Process *pr) | ||||
| 	{ | ||||
| 		do_case(&pr->root_case); | ||||
| 	} | ||||
| }; | ||||
| 
 | ||||
| struct ProcRomPass : public Pass { | ||||
| 	ProcRomPass() : Pass("proc_rom", "convert switches to ROMs") { } | ||||
| 	void help() override | ||||
| 	{ | ||||
| 		//   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
 | ||||
| 		log("\n"); | ||||
| 		log("    proc_rom [selection]\n"); | ||||
| 		log("\n"); | ||||
| 		log("This pass converts switches into read-only memories when appropriate.\n"); | ||||
| 		log("\n"); | ||||
| 	} | ||||
| 	void execute(std::vector<std::string> args, RTLIL::Design *design) override | ||||
| 	{ | ||||
| 		int total_count = 0; | ||||
| 		log_header(design, "Executing PROC_ROM pass (convert switches to ROMs).\n"); | ||||
| 
 | ||||
| 		extra_args(args, 1, design); | ||||
| 
 | ||||
| 		for (auto mod : design->modules()) { | ||||
| 			if (!design->selected(mod)) | ||||
| 				continue; | ||||
| 			RomWorker worker(mod); | ||||
| 			for (auto &proc_it : mod->processes) { | ||||
| 				if (!design->selected(mod, proc_it.second)) | ||||
| 					continue; | ||||
| 				worker.do_process(proc_it.second); | ||||
| 			} | ||||
| 			total_count += worker.count; | ||||
| 		} | ||||
| 
 | ||||
| 		log("Converted %d switch%s.\n", | ||||
| 		    total_count, total_count == 1 ? "" : "es"); | ||||
| 	} | ||||
| } ProcRomPass; | ||||
| 
 | ||||
| PRIVATE_NAMESPACE_END | ||||
							
								
								
									
										43
									
								
								tests/proc/proc_rom.ys
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										43
									
								
								tests/proc/proc_rom.ys
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,43 @@ | |||
| read_verilog << EOT | ||||
| 
 | ||||
| module top(input [3:0] a, input en, output [7:0] d); | ||||
| 
 | ||||
| always @* | ||||
| 	if (en) | ||||
| 		case(a) | ||||
| 			4'h0: d <= 8'h12; | ||||
| 			4'h1: d <= 8'h34; | ||||
| 			4'h2: d <= 8'h56; | ||||
| 			4'h3: d <= 8'h78; | ||||
| 			4'h4: d <= 8'h9a; | ||||
| 			4'h5: d <= 8'hbc; | ||||
| 			4'h6: d <= 8'hde; | ||||
| 			4'h7: d <= 8'hff; | ||||
| 			4'h8: d <= 8'h61; | ||||
| 			4'h9: d <= 8'h49; | ||||
| 			4'ha: d <= 8'h36; | ||||
| 			4'hb: d <= 8'h81; | ||||
| 			4'hc: d <= 8'h8c; | ||||
| 			4'hd: d <= 8'ha9; | ||||
| 			4'he: d <= 8'h99; | ||||
| 			4'hf: d <= 8'h51; | ||||
| 		endcase | ||||
| 	else | ||||
| 		d <= 0; | ||||
| 
 | ||||
| endmodule | ||||
| 
 | ||||
| EOT | ||||
| 
 | ||||
| hierarchy -auto-top | ||||
| 
 | ||||
| design -save orig | ||||
| proc | ||||
| memory | ||||
| opt_dff | ||||
| design -stash postopt | ||||
| design -load orig | ||||
| proc -norom | ||||
| design -stash preopt | ||||
| 
 | ||||
| equiv_opt -assert -run prepare: dummy | ||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue