7
mirror of https://github.com/parallella/parallella-hw.git synced 2024-11-21 19:08:55 +00:00
parallella-hw/pararf/scout.ini
Andreas Olofsson f88518f602 Reorg
2016-11-23 10:01:40 -05:00

377 lines
15 KiB
INI

unit in
|
| scout.ini - Scout configuration file.
|
| Note that many of the Scout commands described in this file are highlighted
| using CAPITAL letters. This is for highlighting purposes only. In actual
| use all commands and keywords should be entered using lower case letters.
|
|*******************!!!!!!!!!!!!!!!!!!!!!*********************
| -----------------------------turn OATs on
disable_oats false
|disable_oats true
| ---------------------------------------------------------------------
| The VERSION command tells Scout which version of commands we are
| using. The allows Scout to adapt to potential changes in the
| command syntax from release to release. Should be 2 for Scout V6.n .
|
version 3
|
| ---------------------------------------------------------------------
| The ZONE commands specify how to partition the schematic sheets into
| horizontal and vertical zones and how to name each zone.
|
zone_size_horizontal 8.50
zone_size_vertical 5.50
zone_xoffset 0.00 | xoffset from bounding box
zone_yoffset 0.00 | yoffset from bounding box
|
zone_names_vertical 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
zone_names_horizontal A B C D E F G H J K L M N P Q R S T U V W X Y Z
|
zone_order_horizontal left_to_right | left_to_right or right_to_left
|zone_order_vertical bottom_to_top | bottom_to_top or top_to_bottom
zone_order_vertical top_to_bottom | bottom_to_top or top_to_bottom
|
| ---------------------------------------------------------------------
| The UNDO command instructs the Scout to remove all of the annotations
| from previous runs (and not add any new annotations.) This command is
| normally enabled via the command line, eg: "scout design -undo true".
|
undo false
|undo true
|
| ---------------------------------------------------------------------
| The DIRECT_REFERENCE command allow you to target specific objects directly for
| placement of attribute information.
|
| The ATTR command is used to specify target objects including where
| the attribute information should be placed. The syntax is
|
| ATTR block_type symbol_name attr_type attr_qualifier annotation_point text_origin
|
| The choices for block_type are COMPOSITE, MODULE, PRIMITIVE, ANNOTATE
| PIN or ANY.
|
| symbol_name should be the name of the symbol associated with the target component or
| the word ANY for any symbol is ok.
|
| attr_type can be PIN_ATTR or COMP_ATTR
|
| attr_qualifier is for future use, use ANY for now
|
| The value for annotation_point can be any positive or negative coordinates (x,y).
|
| The choices for text_origin are UPPER_LEFT, UPPER_CENTER, UPPER_RIGHT,
| MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT,
| LOWER_LEFT, LOWER_CENTER, LOWER_RIGHT or TRACK_OBJECT.
|
|
| tag composite components with sheet info
direct_reference
attr composite any comp_attr any 0.00,0.00 middle_center
format_prefix "SHEET"
format_entry "$lvlpage_range"
format_attr_vis value_visible
end
| tag all primitive components with page and zone location info
|direct_reference
| attr primitive any comp_attr any 0,-15 track_object
|
| format_prefix "SCHLOC="
| format_entry "$page_num$hzone$vzone"
| format_attr_vis invisible
|end
| tag all pins with pin location (page and zone) info
|direct_reference
| attr primitive any pin_attr any +10,0 track_object
| format_prefix "PINLOC="
| format_entry "$page_num$hzone$vzone"
| format_attr_vis invisible
|end
| tag all borders with sheet location (from parent) info.
direct_reference
attr any dsheet.1 comp_attr any 30.70,1.10 lower_left
format_prefix "SUBBLOCK"
format_entry "Located at $pblkpage_num-$phzone$pvzone"
format_attr_vis value_visible
format_attr_size 0.10
end
| tag border component with sheet location info. within block
direct_reference
attr any dsheet.1 comp_attr any 30.70,1.00 lower_left
format_prefix "BLOCKREF"
|format_entry "Block $sheet_name Page $page_num of $lvlpage_last"
format_entry "Block $sheet_name Page $blkpage_num of $blkpage_last"
format_attr_vis value_visible
format_attr_size 0.10
end
| tag border component with sheet location info. within block
direct_reference
| attr any bsheet.1 comp_attr any 1400,+80 lower_left
attr any dsheet.1 comp_attr any 33.40,0.60 lower_right
format_prefix "SHEET"
|format_entry "Block $sheet_name Page $page_num of $lvlpage_last"
format_entry "SHEET $page_num OF $page_total"
format_attr_vis value_visible
format_attr_size 0.15
end
| ---------------------------------------------------------------------
| The CROSS_REFERENCE command allow you to organize the objects found
| attached to each signal branch into lists. You can define as many
| cross reference lists as you like.
|
| The RECORD command defines which objects found on the net branch
| should be included in this list. The syntax is
|
| RECORD block_type selection_type selection_qualifier
|
| The PLACE command is used to specify where the list of recorded objects
| should be placed. The syntax is
|
| PLACE block_type selection_type selection_qualifier annotation_point text_origin
|
| The choices for block_type are COMPOSITE, MODULE, PRIMITIVE, ANNOTATE
| PIN or ANY.
|
| The choices for selection_type are SYMBOL_NAME, COMP_ATTR, PIN_ATTR,
| PIN_SIDE or DANGLING_NET.
|
| The choices for selection_qulaifier are based on the object_type:
|
| object_type object_argument
| ----------- ---------------
| SYMBOL_NAME [library:]symbol[.extension]
| COMP_ATTR/PIN_ATTR name=value
| PIN_SIDE/DANGLING_NET TOP/BOTTOM/LEFT/RIGHT
|
| The value for the annotation_point can be any positive or negative coordinates (x,y).
|
| The choices for text_origin are UPPER_LEFT, UPPER_CENTER, UPPER_RIGHT,
| MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT,
| LOWER_LEFT, LOWER_CENTER, LOWER_RIGHT or TRACK_OBJECT
|
|
| cross-reference all objects with an attribute "KJB=TESTRIP" with all other
| objects with the same attribute. Place pin name/number and location information
| for the recorded object onto the place object.
cross_reference
record pin symbol_name "builtin:in.1"
record pin symbol_name "builtin:out.1"
record pin symbol_name "builtin:bi.1"
record annotate symbol_name "onsheet.1"
record annotate symbol_name "offsheet.1"
record any dangling_net left
record any dangling_net right
record any dangling_net top
record any dangling_net bottom
place pin symbol_name "builtin:in.1" -0.30,-0.10 middle_right
place pin symbol_name "builtin:out.1" 0.40,-0.10 middle_left
place pin symbol_name "builtin:bi.1" -0.30,-0.10 middle_right
place annotate symbol_name "onsheet.1" -0.30,-0.10 middle_right
place annotate symbol_name "offsheet.1" 0.40,-0.10 middle_left
| place any dangling_net left -10,-10 middle_right
| place any dangling_net right +10,-10 middle_left
| place any dangling_net top +10,-10 track_object
| place any dangling_net bottom +10,-10 track_object
format_prefix "XREF"
|format_entry "$page_num-$vzone$hzone-$obj_name"
format_entry "$page_num-$vzone$hzone"
format_separator ","
format_suffix ""
format_attr_length 15
format_attr_size default
|format_attr_vis name_and_value_visible
format_attr_vis value_visible
|format_reset true
format_attr_shadow symbol_attr
|format_max_items 10
format_overflow reformat_and_wrap
|format_reformat "$page_num"
format_reformat "$page_num-$vzone$hzone"
format_wrap_vis value_visible
| format_entry "$pin_name[$pin_number]-$page_num$hzone$vzone"
end
| cross-reference all objects with an attribute "KJB=TESTRIP" with all other
| objects with the same attribute. Place pin name/number and location information
| for the recorded object onto the place object.
|cross_reference
| record any comp_attr KJB=TESTRIP
| place any comp_attr KJB=TESTRIP +10,-15 track_object
| format_entry "$pin_name[$pin_number]-$page_num$hzone$vzone"
| format_attr_vis value_visible
|end
| cross-reference all objects with an attribute named "CONN" with all objects with
| an attribute named "DEVICE=LEVELPIN". Move the pin number/name and
| location information (that would normally by placed on the place object) to a special
| annotation block called kjbtest.1 Place the annotation block at 2860,630.
|cross_reference
| record any comp_attr CONN
| place any comp_attr DEVICE=LEVELPIN +10,-15 track_object
| move kjbtest1.1 2860,630 horizontal by_col 0 0
|
| format_attr_length 1
| format_attr_vis value_visible
| format_entry "$pin_name[$pin_number]-$page_num$hzone$vzone[$refdes]"
| format_reformat "$pin_name[$pin_number]-$page_num$hzone$vzone[$refdes]"
| format_max_items 20
| format_min_items 0
|end
| ---------------------------------------------------------------------
| The FORMAT commands specify how to format the cross reference list.
| When used outside the CROSS_REFERENCE command they apply to all lists.
|
| Variables: $page_num $page_total $page_first $page_last $hzone $vzone
| $x_coord $y_coord $sheet_lib $sheet_name $sheet_num
| $obj_name $obj_path $pin_name $sym_name
| $obj_attr=<att_name> $sch_attr=<att_name> $pin_attr=<att_name>
|
format_prefix "XREF="
format_entry "$page_num$vzone$hzone$obj_name"
format_separator ","
format_suffix ""
format_attr_length 0
format_attr_size default
format_attr_vis name_and_value_visible
format_attr_shadow symbol_pin_attr
format_reset true
format_overflow reformat_and_wrap
format_reformat "$page_num"
format_wrap_vis value_visible
|
| ---------------------------------------------------------------------
| The PAGE commands define placement and formatting of a schematic
| attribute.
|
| Variables: $page_num $page_total $page_first $page_last $sheet_lib
| $sheet_name $sheet_num $subpage_first $subpage_last
|
| Page commands cannot be used with oats, since schematic attributes
| cannot be oats
|
|page_start_number 1
|page_string "SHEET=SHEET $page_num OF $page_total"
|page_origin_text lower_right
|page_origin_sheet lower_right
|page_placement -52,55 | X,Y coords relative to origin_sheet
|page_reset true
|page_attr_size default | Uses default size if not specified
|page_attr_vis value_visible
|page_attr_vis name_and_value_visible
|page_plot false | Create a plot macro
|
| ---------------------------------------------------------------------
| The SYM commands define placement and formatting of a symbol attribute.
|
| Variables: $page_total $page_first $page_last $sheet_lib $sheet_name
| $sheet_num $subpage_first $subpage_last
|
|sym_string "SHEET=$blkpage_range"
sym_origin_text lower_center
sym_origin_sheet lower_left
sym_placement 10,0 | X,Y coords relative to origin_sheet
sym_reset true
sym_attr_size default
sym_attr_vis name_and_value_visible
|
| ---------------------------------------------------------------------
| The EXPAND_BUS_NAMES command instructs Scout to group bus, bundle, and
| bit type nets into the same branch. They are normally defined as
| separate signal branches.
|
expand_bus_names true
|
| ---------------------------------------------------------------------
|
|
| ---------------------------------------------------------------------
| The IGNORE_SIGNAL and IGNORE_SYMBOL commands instruct the Scout program
| to act as if the specified signal or symbol did not exist on the design.
|
ignore_signal global VDD
ignore_signal global GND
|ignore_symbol fborder.1
|
|
| ---------------------------------------------------------------------
| The TRAVERSE command specifies how much of the design tree to process.
| The options are to process only a single sheet - ONE_SHEET, or to
| process all sheets at one level - ONE_LEVEL, or to process all sheets
| at all levels - ALL_SHEETS_AND_LEVELS.
|
traverse all_sheets_and_levels
|
| ---------------------------------------------------------------------
| The STOP_AT command identifies a component or symbol attribute that
| will instruct the Scout program to treat this symbol as a primitive
| and not push into its underlying schematic. This command is only
| required when traversing all sheets and levels. This command may
| be repeated to specify multiple strings.
|
stop_at LEVEL=STD
stop_at LEVEL=DONE
|
| ---------------------------------------------------------------------
| The SCOPE commands specify how small of a scope to use when cross
| referencing objects on a signal branch. If LEVEL_TO_LEVEL is true,
| then each annotation list will contain references to objects on other
| levels. If SHEET_TO_SHEET is true, the each annotation list will
| contain references to objects on other sheets. If OBJECT_TO_OBJECT
| is true, then each annotation list will contain references to objects
| on the same sheet.
|
scope_level_to_level true | Reference objs on other levels.
scope_sheet_to_sheet true | Reference objs on other sheets.
scope_object_to_object false | Reference objs on the same sheet.
|
| ---------------------------------------------------------------------
| The SUPPRESS command can be used to suppress message reports by
| either message type (status, note, warning, error) or by message number.
|
| suppress status
|
| Note: Do not suppress message type 'note' or message number '1030' if
| you are using the 'scout51' script.
|
suppress 1008 | Note 1008: Collecting free data ...
suppress 1023 | Note 1023: Writing .../sym/xxx.1 ...
suppress 1156 | Note 1156: Creating backup file ...
suppress 1235 | Note 1235: Searching for SCHEMATIC xxx.1 ...
suppress 1037 | Note 1037: xxx.1 read
suppress 1006 | Note 1006: Objects deleted
suppress 5202 | Note 5202: Checking ...
suppress 5255 | Note 5255: Check complete. 0 errors and 0 warnings in ...
suppress 1229 | Note 1229: Writing save file for .../sch/xxx.1 ...
suppress 1230 | Note 1230: Save file for .../sch/xxx.1 written.
suppress 1125 | Note 1125: Changed 1 string
suppress 122 | Status 122: Writing schematic xxx.2 ...
|suppress 136 | untagged dangling net messages
suppress 135 | untagged schematic pin messages
suppress 1502 | oat display overriding placeholder
suppress 177 | Property name .. not found in Common Properties