Support AUTONOHOOKUP to not AUTOWIRE hookup AUTO_TEMPLATE signals. (#1526)

wsnyder · wsnyder · commit 2559a8cce549 · 2021-05-23T09:28:24.000-04:00
* verilog-mode.el (verilog-auto-inst, verilog-auto-inst-port) (verilog-read-auto-template-middle, verilog-read-sub-decls-line): Support AUTONOHOOKUP to not AUTOWIRE hookup AUTO_TEMPLATE signals. (#1526) Reported by firefoxtc.
diff --git a/tests/autoinput_nohookup.v b/tests/autoinput_nohookup.v
@@ -0,0 +1,88 @@
+module xyz (/*AUTOARG*/
+   // Outputs
+   signal_f, signal_c,
+   // Inputs
+   signal_e3, signal_b
+   );
+
+   /*AUTOINPUT*/
+   // Beginning of automatic inputs (from unused autoinst inputs)
+   input [2:0]		signal_b;		// To u_abc of abc.v
+   input		signal_e3;		// To u_def of def.v
+   // End of automatics
+
+   /*AUTOOUTPUT*/
+   // Beginning of automatic outputs (from unused autoinst outputs)
+   output		signal_c;		// From u_abc of abc.v
+   output		signal_f;		// From u_def of def.v
+   // End of automatics
+
+   /*AUTOWIRE*/
+
+   /* abc AUTO_TEMPLATE
+     (
+      // Outputs
+      .signal_c				(signal_c),
+      // Inputs
+      .signal_a				(signal_f),   // AUTONOHOOKUP
+      .signal_b				(signal_b[2:0]));
+    */
+   
+   abc u_abc
+     (/*AUTOINST*/
+      // Outputs
+      .signal_c				(signal_c),		 // Templated
+      // Inputs
+      .signal_a				(signal_f),		 // Templated AUTONOHOOKUP
+      .signal_b				(signal_b[2:0]));	 // Templated
+
+   /* def AUTO_TEMPLATE
+     (// Outputs
+      .signal_f				(signal_f),
+      // Inputs
+      .signal_d				(signal_c),   // AUTONOHOOKUP
+      .signal_e				(signal_e),   // AUTONOHOOKUP
+      .signal_e2			(signal_e2),   // AUTONOHOOKUP
+      .signal_e3			((signal_e3)),
+      );
+    */
+    
+   def u_def
+     (/*AUTOINST*/
+      // Outputs
+      .signal_f				(signal_f),		 // Templated
+      // Inputs
+      .signal_d				(signal_c),		 // Templated AUTONOHOOKUP
+      .signal_e				(signal_e),		 // Templated AUTONOHOOKUP
+      .signal_e2			(signal_e2),		 // Templated AUTONOHOOKUP
+      .signal_e3			((signal_e3)));		 // Templated
+   
+endmodule // xyz
+
+module abc (/*AUTOARG*/
+   // Outputs
+   signal_c,
+   // Inputs
+   signal_a, signal_b
+   );
+
+   input [1:0] signal_a;
+   input [2:0] signal_b;
+   output signal_c;
+
+endmodule // abc
+
+module def (/*AUTOARG*/
+   // Outputs
+   signal_f,
+   // Inputs
+   signal_d, signal_e, signal_e2, signal_e3
+   );
+
+   input [1:0] signal_d;
+   input [2:0] signal_e;
+   input [3:0] signal_e2;
+   input [3:0] signal_e3;
+   output signal_f;
+
+endmodule // def
diff --git a/tests_ok/autoinput_concat_ignore.v b/tests_ok/autoinput_concat_ignore.v
@@ -1,22 +1,22 @@
 module xyz (/*AUTOARG*/
-            // Outputs
-            signal_f, signal_c,
             // Inputs
-            signal_b
+            signal_e3, signal_e, signal_b
             );
    
    /*AUTOINPUT*/
    // Beginning of automatic inputs (from unused autoinst inputs)
    input [2:0] signal_b; // To u_abc of abc.v
+   input       signal_e; // To u_def of def.v
+   input       signal_e3; // To u_def of def.v
    // End of automatics
    
    /*AUTOOUTPUT*/
-   // Beginning of automatic outputs (from unused autoinst outputs)
-   output      signal_c; // From u_abc of abc.v
-   output      signal_f;                // From u_def of def.v
-   // End of automatics
    
    /*AUTOWIRE*/
+   // Beginning of automatic wires (for undeclared instantiated-module outputs)
+   wire        signal_c; // From u_abc of abc.v
+   wire        signal_f;                // From u_def of def.v
+   // End of automatics
    
    /* abc AUTO_TEMPLATE
     (
diff --git a/tests_ok/autoinput_nohookup.v b/tests_ok/autoinput_nohookup.v
@@ -0,0 +1,88 @@
+module xyz (/*AUTOARG*/
+            // Outputs
+            signal_f, signal_c,
+            // Inputs
+            signal_e3, signal_b
+            );
+   
+   /*AUTOINPUT*/
+   // Beginning of automatic inputs (from unused autoinst inputs)
+   input [2:0] signal_b; // To u_abc of abc.v
+   input       signal_e3; // To u_def of def.v
+   // End of automatics
+   
+   /*AUTOOUTPUT*/
+   // Beginning of automatic outputs (from unused autoinst outputs)
+   output      signal_c; // From u_abc of abc.v
+   output      signal_f;                // From u_def of def.v
+   // End of automatics
+   
+   /*AUTOWIRE*/
+   
+   /* abc AUTO_TEMPLATE
+    (
+    // Outputs
+    .signal_c                           (signal_c),
+    // Inputs
+    .signal_a                           (signal_f),   // AUTONOHOOKUP
+    .signal_b                           (signal_b[2:0]));
+    */
+   
+   abc u_abc
+     (/*AUTOINST*/
+      // Outputs
+      .signal_c                         (signal_c),              // Templated
+      // Inputs
+      .signal_a                         (signal_f),              // Templated AUTONOHOOKUP
+      .signal_b                         (signal_b[2:0]));        // Templated
+   
+   /* def AUTO_TEMPLATE
+    (// Outputs
+    .signal_f                           (signal_f),
+    // Inputs
+    .signal_d                           (signal_c),   // AUTONOHOOKUP
+    .signal_e                           (signal_e),   // AUTONOHOOKUP
+    .signal_e2                  (signal_e2),   // AUTONOHOOKUP
+    .signal_e3                  ((signal_e3)),
+    );
+    */
+   
+   def u_def
+     (/*AUTOINST*/
+      // Outputs
+      .signal_f                         (signal_f),              // Templated
+      // Inputs
+      .signal_d                         (signal_c),              // Templated AUTONOHOOKUP
+      .signal_e                         (signal_e),              // Templated AUTONOHOOKUP
+      .signal_e2                        (signal_e2),             // Templated AUTONOHOOKUP
+      .signal_e3                        ((signal_e3)));          // Templated
+   
+endmodule // xyz
+
+module abc (/*AUTOARG*/
+            // Outputs
+            signal_c,
+            // Inputs
+            signal_a, signal_b
+            );
+   
+   input [1:0] signal_a;
+   input [2:0] signal_b;
+   output      signal_c;
+   
+endmodule // abc
+
+module def (/*AUTOARG*/
+            // Outputs
+            signal_f,
+            // Inputs
+            signal_d, signal_e, signal_e2, signal_e3
+            );
+   
+   input [1:0] signal_d;
+   input [2:0] signal_e;
+   input [3:0] signal_e2;
+   input [3:0] signal_e3;
+   output      signal_f;
+   
+endmodule // def
diff --git a/verilog-mode.el b/verilog-mode.el
@@ -829,7 +829,7 @@ The name of the function or case will be set between the braces."
 (defcustom verilog-auto-ignore-concat nil
   "Non-nil means ignore signals in {...} concatenations for AUTOWIRE etc.
 This will exclude signals referenced as pin connections in {...}
-or (...) from AUTOWIRE, AUTOOUTPUT and friends."
+or (...) from AUTOWIRE, AUTOOUTPUT and friends. See also AUTONOHOOKUP."
   :group 'verilog-mode-actions
   :type 'boolean)
 (put 'verilog-auto-ignore-concat 'safe-local-variable #'verilog-booleanp)
@@ -9106,9 +9106,7 @@ Inserts the list of signals found, using submodi to look up each port."
 	;; We intentionally ignore (non-escaped) signals with .s in them
 	;; this prevents AUTOWIRE etc from noticing hierarchical sigs.
 	(when port
-          (cond ((and verilog-auto-ignore-concat
-                      (looking-at "[({]"))
-                 nil) ; {...} or (...) historically ignored with auto-ignore-concat
+          (cond ((looking-at "[^\n]*AUTONOHOOKUP"))
                 ((looking-at "\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\s-*)")
 		 (verilog-read-sub-decls-sig
                   submoddecls par-values comment port
@@ -9555,7 +9553,10 @@ Returns REGEXP and list of ( (signal_name connection_name)... )."
 		     (cons (list
 			    (match-string-no-properties 1)
 			    (match-string-no-properties 2)
-			    templateno lineno)
+                            templateno lineno
+                            (save-excursion
+                              (goto-char (match-end 0))
+                              (looking-at "[^\n]*AUTONOHOOKUP")))
 			   tpl-sig-list))
 	       (goto-char (match-end 0)))
               ;; Regexp form??
@@ -9571,7 +9572,10 @@ Returns REGEXP and list of ( (signal_name connection_name)... )."
 								    (match-string 1))
 				    "$")
 			    rep
-			    templateno lineno)
+                            templateno lineno
+                            (save-excursion
+                              (goto-char (match-end 0))
+                              (looking-at "[^\n]*AUTONOHOOKUP")))
 			   tpl-wild-list)))
 	      ((looking-at "[ \t\f]+")
 	       (goto-char (match-end 0)))
@@ -11689,15 +11693,14 @@ If PAR-VALUES replace final strings with these parameter values."
              ;; verilog-insert requires the complete comment in one call - including the newline
              (cond ((equal verilog-auto-inst-template-numbers 'lhs)
                     (verilog-insert " // Templated"
-                                    " LHS: " (nth 0 tpl-ass)
-                                    "\n"))
+                                    " LHS: " (nth 0 tpl-ass)))
                    (verilog-auto-inst-template-numbers
                     (verilog-insert " // Templated"
                                     " T" (int-to-string (nth 2 tpl-ass))
-                                    " L" (int-to-string (nth 3 tpl-ass))
-                                    "\n"))
+                                    " L" (int-to-string (nth 3 tpl-ass))))
                    (t
-                    (verilog-insert " // Templated\n"))))
+                    (verilog-insert " // Templated")))
+             (verilog-insert (if (nth 4 tpl-ass) " AUTONOHOOKUP\n" "\n")))
             (for-star
              (indent-to (+ (if (< verilog-auto-inst-column 48) 24 16)
                            verilog-auto-inst-column))
@@ -12087,6 +12090,16 @@ Lisp Templates:
   After the evaluation is completed, @ substitution and [] substitution
   occur.
 
+
+Ignoring Hookup:
+
+  AUTOWIRE and related AUTOs will read the signals created by a template.
+  To specify that a signal should not be parsed to participate in this
+  hookup, add a AUTONOHOOKUP comment to the template.  For example:
+
+            .pci_req_l  (pci_req_not_to_wire),  //AUTONOHOOKUP
+
+
 For more information see the \\[verilog-faq] and forums at URL
 `https://www.veripool.org'."
   (save-excursion
