This file is indexed.

/usr/share/tkgate/doc/gateModules.html is in tkgate-doc 2.0~b10-6.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
    <TITLE>TKGate User Documentation (Modules)</TITLE>
    <META http-equiv="Content-Style-Type" content="text/css">
    <link rel="stylesheet" href="tkgate.css" type="text/css">
</HEAD>
<BODY>

<A NAME="modules"></A>
<H2>3. Working with Modules</H2>

While in theory you could create your entire design as a single flat
collection of primitive gates, when a design gets too large it becomes
too difficult to manage this way.  In order to manage the complexity
of a large design, we must use hierarchical design practices. As with
most other tools, TkGate uses modules to manage this complexity.
Modules serve a similar purpose as functions do in a C program.  They
allow the design to be broken into manageable chunks as well as allow
for reuse.

<a name="intro">
<h3>3.1 Module Implementations versus Module Instances</h3>

TkGate distinguishes between "Modules Implementations" and "Module
Instances."  A module implementation is analogous to the definition of
a C function.  It specifies what the module does, and what its
interface is.  This is divided into an internal definition which is
created in an editor window in the same way as any other circuit, and
an interface which specified the ports and properties of those ports
(analogous to the function prototype or parameter list in a C
function).
<p>
A module instance is analogous to an invocation of a function in a C
program.  It is generally displayed as a box with input and output
wire attached to it.  Each instance of a module operates independent
of the other instances.  When realized as a circuit, each instance
would take up chip area, and be comprised of its own physical wires
and components.  When simulating, TkGate maintains separate state for
the values of wires in each instance and the values of any registers
or memories.

<a name="instances">
<h3>3.2 Creating Module Instances</h3>


<div class=frame_rfig>
<IMG SRC="fig/makemodinst1.gif"><br>
<b>1) Select a module from the module list.</b><br>
<br>
<IMG SRC="fig/makemodinst2.gif"><br>
<b>2) Drag to the insertion location.</b><br>
<br>
<IMG SRC="fig/makemodinst3.gif"><br>
<b>3) Release mouse button to create.</b><br><br>
<b>Figure 3.1: Creating a Module Instance</b>
</div>

The easiest way to create a module instance is to drag the module name
from the module list.  To do this, first 1) select a module from the
module list.  In this example, we have selected the "REGS" module.
Next, 2) drag the module name onto the canvas.  The module name will
get dragged onto the canvas.  Finally, 3) release the mouse button to
create an instance of the module.  After you have created the module
instance, you can select it and drag it with the mouse to position it
exactly where you want it.
<p>

<div class=lfig>
<a href="fig/modcreate.gif" type="image/gif" target=_blank><IMG SRC="fig/small-modcreate.gif"><br>
(Click to Enlarge)</a><br><br>
<b>Figure 3.2: Module Function Selection</b>
</div>

Another way to create a module instance is to right click and select
"Make &rarr; Module &rarr; Module Instance" from the pop-up menu, or
use the "B" keyboard shortcut.  When you do this, the "Details" page
of the module properties box will appear to allow you to select which
module you wish to create an instance of.  Select a name from the list
box labeled "Function", or press "New..." to create an instance of a
new type of module that you intend to define later.  After you have
selected the type of module, press "OK" to create the module instance.
If you press "Cancel", the operation will be aborted and no module
will be created.
<p>
When you create a module instance, that instance will have a unique
instance name, distinct from the name of the module type or function.
The instance name allows you to distinguish between different
instances of a module.  For example, if you create two REGS modules,
one might have an instance name of "g1" and one might have an instance
name of "g2".  Normally, TkGate automatically assigns the instance
name, but you can change it on the "General" tab of the <a
href="gateEdit.html#gateprops">Gate Properties Box</a> dialog box.
Note that this dialog box displays and modifies properties of the
module instance, not the underlying module implementation.

<br style="clear: right;">
<br style="clear: left;">

<a name="hierarchy">
<h3>3.3 Module Hierarchy</h3>

Your design in TkGate is comprised of a hierarchy of module instances.
There is one module that is designated the top-level module.  By
default, this module is called "main", but you can rename it to any
module you wish.  You can also designate any module in your design to
be the top-level module.  Module instances that are directly included
in the top-level module form the next level in the hierarchy, and
modules instances included in those 2nd layer modules form the next
layer and so on.

<h4>3.3.1 Module Hierarchy View</h4>

<div class=rfig>
<IMG SRC="fig/multihierarchy.gif"><br><br>
<b>Figure 3.3: Module<br>Hierarchy View</b>
</div>

<p>
TkGate's module hierarchy view displays the module hierarchy of your
design.  Be sure you have selected <img class=tool
src="fig/modtree.gif"> to see the hierarchical view.  When you are in
edit mode, the hierarchy is shown in terms of module implementations.
That is, at each node in the tree, the children are the names of the
modules which are used as instances at least once in the module.
<p>
Consider the example shown to the right.  The top-level module "main"
is indicated by the <IMG SRC="fig/document.gif"> symbol next to it.
In this example, "main" uses one or more module instances of the
"EUNIT", "IUNIT" and "MEMORY" modules.  The "REG16" module uses one or
more instances of the "REG4" and "ZREG4" modules, but the <img
src="fig/unknown.gif"> symbol next to "REG4" tells us that there is no
definition for that module.  The module "<font style="text-decoration:
underline;" color=red>ZREG4</font>" shown in red with an underline
indicates that that module is the current module in the editor.  The
<img src="fig/conflict.gif"> symbol next to "EUNIT" underneath "ZREG4"
indicates a conflict.  ZREG4 includes an instance of "EUNIT", but
"ZREG4" itself is contained in an "EUNIT" (it is in "REG16" which is
in "EUNIT").  Circuits containing conflicts can not be simulated, all
conflicts must be resolved before you can simulate.

<p>
Each module in the module list or hierarchy view is preceded by a
symbol showing its type.  The possible types are:
<center>
<table>
<tr><th align=left width=100>Symbol</th><th align=left>Description</th></tr>
<tr><td><img src="fig/document.gif"></td><td>The top-level module.</td></tr>
<tr><td><img src="fig/mod_net.gif"></td><td>A normal net-list module.</td></tr>
<tr><td><img src="fig/mod_hdl.gif"></td><td>A text HDL module.</td></tr>
<tr><td><img src="fig/parts.gif"></td><td>Collection of module libraries.</td></tr>
<tr><td><img src="fig/ichipdir.gif"></td><td>A module library</td></tr>
<tr><td><img src="fig/chip.gif"></td><td>A module defined in a library.</td></tr>
<tr><td><img src="fig/unused.gif"></td><td>Collection of modules defined but not used in the circuit.</td></tr>
<tr><td><img src="fig/unknown.gif"></td><td>Reference to an undefined module in hierarchical list.</td></tr>
<tr><td><img src="fig/conflict.gif"></td><td>Conflict/recursive definition in hierarchical list.</td></tr>
</table>
</center>
<p>
HDL and net-list modules may also contain a "lock" on them (for
example <img src="fig/mod_netL.gif">).  The lock indicates that
editing of that module has been disabled in the module options dialog
box.

<a name=navigatetomodule>
<h4>3.3.2 Navigating to Modules</h4>

Double click on a module in the module hierarchy or module list view
to open that module in the editor.  You can also right click on a
module instance in the main editing window and select "<img
src="fig/blk_open.gif"> Open".  When you use "<img
src="fig/blk_open.gif"> Open" to open modules, TkGate will remember
    the modules you have opened on a stack.  The modules on the stack will
be displayed in red, with an underline under the module currently
displayed in the editor.  To close a module, and return to the parent
module on the stack, right click in a blank area on the canvas and
select "<img src="fig/blk_close.gif"> Close".

<br style="clear: right;">

<a name="create">
<h3>3.4 Creating and Manipulating Modules</h3>

<a name="create_modules">
<h4>3.4.1 Creating Modules</h4>

<div class=rfig>
<a href="fig/modnew.gif" type="image/gif" target=_blank><IMG SRC="fig/small-modnew.gif"><br>
(Click to Enlarge)</a><br><br>
<b><a name=modcreate>Figure 3.4: Module Creation</b>
</div>

To create a new module, press the <img class=tool
src="fig/blk_new.gif"> button on the toolbar.  This will open the
dialog box shown in <a href="#modcreate">Figure 3.4.</a> After you
have opened the dialog box, choose a name for your module and enter it
into the "Name" field.  Next, choose a module type.  A "netlist"
module is one that is defined graphically by connecting gates and
other modules, and "HDL" module is one that is defined by typing a
text description of the module.  You can not change the type once the
module has been created.  In order to change the type, you must delete
the module and create a new one of the new type.
<p>
There are also several property flags that you can set for your module:
<ul>

<li><b>Prevent editing of module definition:</b> While this property
is set, editing of the definition (inside) of the module is disabled.
However, you can still open the module to view the definition.

<li><b>Prevent all interface changes:</b> While this property is set,
editing of the module interface (size of box, position of ports, etc.) 
is disabled.

<li><b>Prevent edit mode interface changes:</b> While this property is
set, editing of the module interface is disabled in the edit window,
but the interface can still be modified through the interface editor.

<li><b>Block resize port position handling:</b> This property controls
how port positions will be handled when you change the size of the box
of a module interface.  If you select "scaled" the distance between
ports will grow and shrink proportionally as you expand and contract
the box.  If you select "fixed" the position of the ports will remain
constant, and their position will constrain the minimum size of the
box you can use for a module.

</ul>


<br style="clear: right;">

<a  href="module_properties">
<h4>3.4.2 Editing Module Properties</h4>

<div class=rfig>
<a href="fig/modprops.gif" type="image/gif" target=_blank><IMG SRC="fig/small-modprops.gif"><br>
(Click to Enlarge)</a><br><br>
<b>Figure 3.5: Module Properties</b>
</div>

You can edit the property flags of a module by right clicking on the
module name in the module list and selecting "<img class=tool
src="fig/i_modprops.gif"> Properties...".  This will bring up a dialog
box like the one shown in <a href="#modcreate">Figure 3.5</a>.  The
dialog box will show the name of the module, the name of the file from
which that module was loaded, and the type of the module (netlist or
HDL).  These properties can not be modified.  The modifiable
attributes of modules are the same as those previously described in
<a href="#create_modules">Section 3.4.1 Creating Modules</a>.

<br style="clear: right;">

<h4>3.4.3 Deleting, Copying and Renaming Modules</h4>


<div class=rfig>
<a name=moddelete>
<a href="fig/moddel.gif" type="image/gif" target=_blank><IMG SRC="fig/small-moddel.gif"><br>
(Click to Enlarge)</a><br><br>
<b>Figure 3.6: Module Deletion</b>
</div>

To delete a module implementation, right click on a module in the module list and
select "<img class=tool src=fig/blk_delete.gif> Delete".  This will
bring up the dialog box shown in <a href="#moddelete">Figure 3.6</a>.
Press "OK" to delete the module.  You can also change the module to be
deleted by selecting its name from the drop down list.  Any instances
of the deleted module used in your design, will not be deleted.  If
you attempt to simulate, you will get an undefined module error.

<div class=lfig>
<a name=modcopy>
<a href="fig/modcopy.gif" type="image/gif" target=_blank><IMG SRC="fig/small-modcopy.gif"><br>
(Click to Enlarge)</a><br><br>
<b>Figure 3.7: Copying Modules</b>
</div>
<p>
To copy a module implementation, right click on the module to be
copied from the module list and select "<img class=tool
src=fig/blk_copy.gif> Copy".  This will bring up a dialog
box like the one shown in <a href="#modcopy">Figure 3.7</a>.  Make sure the "From" field shows the
name of the module you wish to copy.  Enter the name of the new module
in the "To" field.  This will copy both the module definition and the
module interface.  The new module will appear in the list, or under
the "Unused" tree in the hierarchy view.
<p>
<div class=rfig>
<a name=modrename>
<a href="fig/modrename.gif" type="image/gif" target=_blank><IMG SRC="fig/small-modrename.gif"><br>
(Click to Enlarge)</a><br><br>
<b>Figure 3.8: Renaming Modules</b>
</div>

To rename a module implementation, right click on the module to be
copied from the module list and select "<img class=tool
src=fig/blk_rename.gif> Rename".  This will bring up a dialog
box like the one shown in <a href="#modrename">Figure 3.8</a>. Make sure the "From" field shows the
name of the module you wish to copy.  Enter the new name for the
module in the "To" field.


<br style="clear: both; ">

<h4>3.4.4 Claiming Modules</h4>

<div class=rfig>
<a name=modclaim>
<a href="fig/modclaim.gif" type="image/gif" target=_blank><IMG SRC="fig/small-modclaim.gif"><br>
(Click to Enlarge)</a><br><br>
<b>Figure 3.9: Claiming Modules</b>
</div>

Sometimes you may wish to modify a module that is part of a library.
But since modules that are part of a library can not be modified, you
must "claim" that module before you can make any changes.  Claiming
the module make that module part of your design, rather than part of
the library.  This allows you to edit and make changes to the module.
When you save your design, your version of the module will be saved.
<p>
Since modules that are defined in your design take precedence over
library modules, the next time you load your design, the claimed
module will continue to be used in lieu of the library version of that
module.  If you later decide that you would like to revert to the
library version, you can delete the module, and reload the library.
<p>
To claim a module, right click on the module to be copied from the
module list and select "<img class=tool src=fig/blk_claim.gif> Claim".
This will bring up a dialog box like the one shown in <a
href="#modclaim">Figure 3.9</a>.  Make sure the "Name" field shows the
name of the module you wish to claim.  The <img src="fig/chip.gif">
symbol next to the module will change to <img src="fig/mod_net.gif">
or <img src="fig/mod_hdl.gif"> to indicate that that module is now
part of your design.
<p>
Only modules that are part of a library can be claimed.  If you
attempt to open the claim dialog box when there are no library modules
in your circuit, you will get an error message.

<br style="clear: right;">

<h4>3.4.5 Setting the Top-Level Module</h4>

<div class=rfig>
<a name=setroot>
<a href="fig/modsetroot.gif" type="image/gif" target=_blank><IMG SRC="fig/small-modsetroot.gif"><br>
(Click to Enlarge)</a><br><br>
<b>Figure 3.10: Setting Top-<br>Level Module</b>
</div>

The top-level module is the highest-level module in your hierarchy.
It is the module that appears at the top of the hierarchy view and is
indicated by the <img src="fig/document.gif"> symbol. When simulating
your circuit, only modules that are reachable from the top-level
module are simulated.
<p>

To set the top-level module, right click on the module and select
"<img class=tool src=fig/blk_root.gif> Set As Root".  This will bring
up a dialog box like the one shown in <a href="#setroot">Figure
3.10</a>.  Make sure the "Name" field shows the name of the correct
module.  The module hierarchy view will be recomputed with the new
module as the top-level module.


<br style="clear: right;">

<a name="definitions">
<h3>3.5 Editing Module Definitions</h3>

<div class=rfig>
<a name=portfig>
<table>
<td>
   <td style="background-color: white;"><IMG SRC="fig/port_in.gif"></td>
   <td style="background-color: white;"><IMG SRC="fig/port_out.gif"></td>
</tr>
<td><td>a) Input Port</td><td>b) Output Port</td></tr>
<td><td style="background-color: white;"><IMG SRC="fig/port_inout.gif"></td></tr>
<td><td>c) Inout Port</td></tr>
</table>
<b><a name=modcreate>Figure 3.11: Module Ports</b>
</div>

To edit the definition of a netlist module, open the module as
described in section <a href="#navigatetomodule">3.3.2 Navigating to
Modules</a>.  Within the module you can use any of the gates you would
use at a higher level including more module instances.  Signals as
passed between the inside and outside through special circuit elements
called ports.  There are three types of ports: input, output and
inout.  These are shown in <a href="#portfig">Figure 3.11a, b and
c</a>, respectively.  Internal module ports are created the same way
as other gates.  Right click at the position you wish to create it and
select "Module Input", "Module Output" and "Module InOut" from
"Module" under the "Make" menu.  When you are creating a port, the net
properties dialog box will appear to allow you to set the name of the
port.  Enter a name, and click OK to create it.  The wire connected to
the port will have the same net name as the port.
<p>
The ports you define as part of the internal definition of a module
must match the ports that you define on the interface, both in the
names used, the type (input, output or inout), and the bit size.  If
you have already created the interface, then you can click on the
"Ports" tab on the lower left-hand side of the main window to see what
ports have been created on the interface.

<br style="clear: right;">

<a name="interfaces">
<h3>3.6 Editing Module Interfaces</h3>

<div class=rfig>
<a name=modintlist>
<a href="fig/miindex.gif" type="image/gif" target=_blank><IMG SRC="fig/small-miindex.gif"><br>
(Click to Enlarge)</a><br><br>
<b>Figure 3.12: Module Interface List</b>
</div>

The interface of a module, is its external appearance when it is
included by a higher-level module.  It includes the number and names
of the ports, as well as their position.  Each module has a canonical
interface which is stored as part of the module definition when you
save your design.  Individual instances of a module have an interface
as well which may or may not match the canonical interface.  If you
make changes to the interface of a module after you have created one
or more instances of it in your circuit, you may need to go back and
fix those instances.
<p>
While it is possible to edit the interface of a module directly in
edit mode then choose "Interface &rarr; Set" to make that instance the
canonical instance, this is not the recommended way of creating
interfaces.  The preferred way is to use the interface editor.  To use
the interface editor, select the "<font class=tool><img 
src="fig/editintr.gif">Interface</font>" tab in the main edit window.
<p>
If you have the top-level module selected, the interface editor will
display a graphical representation for the interfaces of all modules
loaded in your design as shown in <a href="#modintlist">Figure 3.12</a>.
You can edit the interfaces directly on this page, or you can double
click on a module, either its graphical form or its name in the module
list, to open the single-module interface editor.
<p>
There are two basic types of module interfaces: standard interfaces,
and symbol interfaces.  A standard interface is a rectangular box with
ports on the edges of the box.  A symbol interface is an arbitrary
user-defined symbol created through a bitmap editor.  Most of the
time, you will likely use standard interfaces, but if you wish to
create your own gates, you can create your own symbols for them.

<br style="clear: right;">

<h4>3.6.1 Standard Module Interfaces</h4>

<div class=rfig>
<a name=standardinterface>
<a href="fig/mialu.gif" type="image/gif" target=_blank><IMG SRC="fig/small-mialu.gif"><br>
(Click to Enlarge)</a><br><br>
<b>Figure 3.13: Module Interface Editor</b>
</div>

<a href="#standardinterface">Figure 3.13</a> shows the single-module
interface editor for a module with a standard interface.  At the top
of the "Interface Properties" box, is a selector that lets you choose
between the "Standard" and "Symbol" interface types.  While the module
is open, you can switch back and forth between the two types without
losing any work you have done on either interface.  Below the
interface type selector, are the module properties.  These are the
same properties that can be specified through the <a
href="#create_modules">module creation</a> and <a
href="#module_properties">module properties</a> dialog boxes.
<p>
<h5>Editing Through The Port List</h5>

Below the "Interface Properties" box, is the "Port List".  The Port
List lists all of the ports on the module.  For each port, the list
includes the name of the port, the type (input, output, or inout), the
bit width, and the side of the module box on which the port it
attached.  To change a value, double click on it.  For the port name,
you can enter a new port name.  Names that begin with a '_' will be
displayed with an over-bar to indicate that they are active low
signals.  For the other fields, a drop down selector will appear
allowing you to change the value.  Click anywhere outside the open
value to close it and make the change effective.  Your changes will be
reflected in the graphical view of interface.  You can also hit the
tab key to advance and enter a value for the next field.
<p>
To add a new port, you can either double click on the next empty line
in the port list, or press the "Add" button.  TkGate will attempt to
guess an appropriate name for the new port, but you can type in your
own name if you prefer.  To delete a port, select it and press the
"Delete" button.
<p>
You can reorder the ports by selecting and dragging them up or down in
the port list.  Ports that are on the same "Side" will be arranged in
the same in both the port list and in the graphical representation of
the interface.

<p>
<h5>Graphical Editing</h5>

<div class=rfig>
<a name=portparmfig>
<a href="fig/portparms.gif" type="image/gif" target=_blank><IMG SRC="fig/small-portparms.gif"><br>
(Click to Enlarge)</a><br><br>
<b>Figure 3.14: Port Parameters</b>
</div>

You can also edit the interface graphically.  To change the size of
the box, grab a corner or side with the mouse and drag in it or out.
To edit the properties of a port, double click on its name in the
graphical representation of the interface.  The Port Parameters dialog
box shown in <a href="#portparmfig">Figure 3.14</a> will appear
allowing you to change the name, type and bit size of the port.  The
new values will be updated in the port list after you click "OK".
<p>
To add a new port, right click on the edge of the rectangle at the
point you wish to add the port and select "Add Input..", "Add
Output.." or "Add InOut..".  The Port Parameters dialog box will
appear in this instance too allowing you to enter the port name and
bit size.  To delete a port, use the <img class=tool
src="fig/cut_curs.gif"> tool and "cut" the wire off the edge of the
interface.
<p>
To reposition ports, grab them and slide them back and forth on the
edge to which they are attached.  However, to change the edge to which
they are attached, you will need to change the "Side" in the port
list.

<br style="clear: right;">

<h4>3.6.2 Automatic Interface Generation</h4>

<div class=rfig>
<a name=interface_generator>
<a href="fig/modgen.gif" type="image/gif" target=_blank><IMG SRC="fig/small-modgen.gif"><br>
(Click to Enlarge)</a><br><br>
<b>Figure 3.15: Interface Generator</b>
</div>

Rather than manual edit the interface of a module, you can
automatically generate an interface after you have completed the
internal definition of a module.  To do this, open the module in the
interface editor and press the "Auto Generate..." button.  This will
bring up the Interface Generator dialog box shown in <a
href="#interface_generator">Figure 3.15</a>.  Select the module for
which you wish to create an interface, then choose "Port Selection"
and "Port Positions" options.
<p>
The port selection option tells the interface generator which ports
should be included on the generated interface.  The possible options are:
<ul>
<li><b>Use ports used in module only:</b> Only ports that are used in
the definition of the module will result in ports on the interface.
If you have not created the internal definition yet, then no ports
will be generated.

<li><b>Use ports from existing interface only:</b> Only ports that are
used on the current interface will be used.  This option can be used
when you want to regenerate the positions of the ports.

<li><b>Use both module and interface ports:</b> Ports that are used
either in the definition, or in the current interface will be
generated on the new interface.
</ul>
<p>
The port position option tells the interface generator how the ports
on the new interface should be positioned.  The possible options are:
<ul>
<li><b>Keep existing port position when possible:</b> If regenerating
an interface, the positions of ports that have already been positioned
will not be modified.  Only new ports will be positioned.
 
<li><b>Regenerate all port positions:</b> Existing positions of any
ports on the current interface will be ignored, and a new interface
will be generated from scratch.
</ul>

<br style="clear: right;">

<h4>3.6.3 Symbolic Module Interfaces</h5>

<div class=rfig>
<a href="fig/miregs.gif" type="image/gif" target=_blank><IMG SRC="fig/small-miregs.gif"><br>
(Click to Enlarge)</a><br><br>
<b>Figure 3.16: Symbol Interface Editor</b>
</div>

You can use the built-in bitmap editor to design your own symbols for
modules that you create.  Open the module in the interface editor and
select "Symbol" for the interface type.  The symbol editor includes a
bit map editor on the top, and a view of your device on the bottom.
You can edit the ports in the port list in the same way as for
standard modules.  Drag the name of any newly created ports onto the
bit-map editor to allow you to position it.
<p>
You must create an "Unselected" and a "Selected" version of your
symbol.  The "Unselected" version is the appearance when the symbol is
not selected, and the "Selected" version is the appearance when you
have selected it in the editor.  Normally you can just draw the
"Unselected" version, copy and paste it into the "Unselected" version,
then press the <img class=tool src="fig/symed_autobold.gif"> button on
the toolbar to automatically boldify your symbol.  However, you may
want to use the editor to do some final touch-ups.
<p>
There are six symbol editor tools that you can use in designing your
symbol:
<p>
<table>
<tr><th align=left>Tool</th><th align=left>Description</th></tr>
<tr><td colspan=2><hr></td></tr>

<tr><td class=tlb><img class=tool src="fig/symed_point.gif"></td><td class=tld>
<b>Bit Tool</b> - Click the left mouse button to set a bit, and
the right mouse button to clear a bit.  You can also press and hold
the mouse button to set/clear multiple bits and you move the mouse.

</td><tr><td class=tlb><img class=tool src="fig/symed_line.gif"></td><td class=tld>
<b>Line Tool</b> - Click and hold the left mouse button to set one end
of the line, and drag the mouse to the other end and release to draw a
line.  The same action with the right mouse button will clear a line.

</td><tr><td class=tlb><img class=tool src="fig/symed_rect.gif"></td><td class=tld>
<b>Rectangle Tool</b> - Click and hold the left mouse button to set
one corner of the rectangle, and drag the mouse to the other corner
and release to draw a rectangle.  The same action with the right mouse
button will clear the rectangle.

</td><tr><td class=tlb><img class=tool src="fig/symed_fillrect.gif"></td><td class=tld>
<b>Filled Rectangle Tool</b> - Click and hold the left mouse button to
set one corner of the filled rectangle, and drag the mouse to the
other corner and release to draw a filled rectangle.  The same action
with the right mouse button will clear the filled rectangle.

</td><tr><td class=tlb><img class=tool src="fig/symed_port.gif"></td><td class=tld>

<b>Port Tool</b> - Use this tool to select and manipulate ports.
Click and drag the port to move it.  Use the <img class=tool
src="fig/symed_pcrot.gif"> and <img class=tool
src="fig/symed_pccrot.gif"> buttons to rotate the port clockwise or
counter-clockwise.

</td><tr><td class=tlb><img class=tool src="fig/symed_select.gif"></td><td class=tld>

<b>Area Select Tool</b> - This tool allows you to select a rectangular
area, then use the cut, copy and paste tools.  There are two types of
paste operations.  A normal paste <img class=tool
src="fig/edit_paste.gif"> overwrites all bits with the contents of the
cut buffer.  The overlay paste <img class=tool
src="fig/edit_overlay.gif">, pastes only the bits that are set in the
cut buffer, combining the cut buffer with the existing image.  The
selection also limits the scope of the bit shifting and rotating
operations to the selection.
</td><tr>

<tr><td colspan=2><hr></td></tr>
</table>

<p>

You can also use the <img class=tool src="fig/symed_cwrotate.gif"> and
<img class=tool src="fig/symed_ccwrotate.gif"> buttons to rotate the
image clockwise or counter-clockwise, or the shift buttons such as
<img class=tool src="fig/arrow0.gif"> to shift the bits left, right,
up or down.  You can use the area selection tool <img class=tool
src="fig/symed_select.gif"> to limit the scope of these operations to
the selected area.

<br style="clear: right;">




</body>
</html>