layout/data2safety

   1 #!/usr/bin/perl -w
   2
   3 use strict qw(vars);
   4
   5 our ($basename);
   6 $basename= @ARGV ? $ARGV[0] : 'safety';
   7 die if $basename =~ m/^\-/;
   8 $basename =~ s/\.wiring$//;
   9
  10 our ($mistakes, $currentline);
  11
  12 our (%segs);
  13 # ->{BoOb}{Kind}  'pt' 'sense' 'reverse' 'waggle'
  14 # ->{BoOb}{Board}
  15 # ->{BoOb}{Obj}
  16 # ->{BoOb}{Indiv}   for `indiv' board objects like wagglers
  17 # $segs{$seg}{InvBoOb}
  18 # $segs{$seg}{BoOb}
  19 # $segs{$seg}{Posns}
  20 # $segs{$seg}{FeatCount}                does not include Fixed
  21 # $segs{$seg}{FeatCountFixed}
  22 # $segs{$seg}{Feats}{$feat}{Kind}       Point, Fixed, or Relay
  23 # $segs{$seg}{Feats}{$feat}{Weight}     ) for Point or Relay only
  24 # $segs{$seg}{Feats}{$feat}{Posns}      ) for Point or Relay only
  25 # $segs{$seg}{Feats}{$feat}{BoObs}[]    ) for Point or Relay only
  26 # $segs{$seg}{Feats}{$feat}{Fixed}      position, for Fixed only
  27 # $segs{$seg}{FeatMap}[]{Abstract}      as from ours.m4
  28 # $segs{$seg}{FeatMap}[]{Concrete}      as in ours.wiring, for safety:movpos.c
  29 # $segs{$seg}{FeatMap}[]{UsedAbstract}
  30 # $segs{$seg}{FeatMap}[]{UsedConcrete}
  31 # $segs{$seg}{Inter}{Seg}               ) calculated
  32 # $segs{$seg}{Inter}{Map}               )  in writeout
  33
  34 # $segs{$seg}{Num}
  35 # $segs{$seg}{Ends}[$combpos][$end] = [ $node,$side ]
  36 # $segs{$seg}{Dist}[$combpos]
  37
  38 our (@interfs);
  39 # $interfs[]{Invert} = $invert
  40 # $interfs[]{Segs}[] = "$seg/$posre"   "/.*" added during parsing if necc.
  41
  42 our (%nodes);
  43 # $nodes{$node}[$side]{Seg}
  44 # $nodes{$node}[$side]{End}
  45
  46 our ($maxptixln2) = 5;
  47 our ($maxwaggleixln2) = 4;
  48
  49 our ($nextboardnum,@boardtype,@sensesin,$maxreverseobjnum);
  50 our (@reversersboardnum,@sensesbase,@objkinds,%pin_used);
  51 # $boardtype[$boardnum]
  52 # $sensesin[$page]
  53 # $maxreverseobjnum
  54 # $reversersboardnum[$boardnum]  # undef => none; -1 => not yet determined
  55 # $sensesbase[$boardnum]= ($page << 7) | $baselsbyte
  56 # $pin_used{$objkind}[$objnum] = [ $boardnum, $pin_info, $objonboard ]
  57 $nextboardnum= 0;
  58 $sensesin[0]= 0;
  59 @objkinds= qw(pt sense reverse waggle);
  60
  61 our (%kind_count,%pin_info,%pin_info_indiv); # from BOARD.pin-info
  62
  63 our ($mode,$invertible);
  64 $mode= 'barf';
  65
  66 our (%sensepermute);
  67 # $sensepermute{$boardtype}[$objonboard]= $offset
  68
  69 sub sensepermute_bitmap ($$$) {
  70     my ($kind,$base,$mapstring) = @_;
  71     my ($objnum,$bitnum);
  72     my (@map)= split /\s+/, $mapstring;
  73     @map==8 or die;
  74     $bitnum= $base;
  75     while (@map) {
  76         $objnum= pop @map;
  77         next if $objnum =~ m/[a-z]/i;
  78         $objnum =~ m/^\d\d$/ or die "$kind $objnum ($bitnum) ?";
  79         $objnum =~ s/^0*\B//;
  80         die "$kind $objnum ($bitnum from $base)" if
  81             defined $sensepermute{$kind}[$objnum];
  82         $sensepermute{$kind}[$objnum]= $bitnum;
  83 #print STDERR "SPM $kind $objnum $bitnum\n";
  84         $bitnum++;
  85     }
  86 }
  87 # see detect.asm:
  88 sensepermute_bitmap('reversers',  0, 'MM zz 01 02  03 00 04 05');
  89 sensepermute_bitmap('detectors',  0, 'MM 05 B2 B1  10 13 16 08');
  90 sensepermute_bitmap('detectors',  5, '19 09 12 15  18 04 20 17');
  91 sensepermute_bitmap('detectors', 13, '06 01 07 02  11 14 03 00');
  92
  93 sub line_barf () {
  94     return if $mistakes;
  95     mistake("first input line does not determine phase");
  96 }
  97
  98 sub syntaxerror () {
  99     our (%syntaxerror_once);
 100     return if exists $syntaxerror_once{$mode};
 101     $syntaxerror_once{$mode}= 1;
 102     mistake("syntax error");
 103     return undef;
 104 }
 105
 106 sub ditch ($) {
 107     my ($m) = @_;
 108     print STDERR "info: ditching $m\n";
 109 }
 110
 111 sub seg_wiring ($$$) {
 112     my ($seg,$feat,$hash) = @_;
 113     return mistake("unknown wiring for $seg in $seg/$feat")
 114         unless exists $segs{$seg};
 115     mistake("duplicate wiring for $seg/$feat")
 116         if exists $segs{$seg}{Feats}{$feat};
 117     if (exists $hash->{Posns}) {
 118         $hash->{Weight}= $segs{$seg}{Posns};
 119         $segs{$seg}{Posns} *= 2;
 120         $segs{$seg}{FeatCount}++;
 121     }
 122     $segs{$seg}{Feats}{$feat}= $hash;
 123 }
 124
 125 sub begin_points () { }
 126 sub line_points () {
 127     my ($seg,$pt,@boobstr,$bodef,@boobs);
 128     m,^\s+(\w+)/([A-Za-z]+)\s+((\d+)\.\d+)\s+(\d*\.\d+)$, or
 129         return syntaxerror();
 130     ($seg,$pt,$boobstr[0],$bodef,$boobstr[1])=($1,$2,$3,$4,$5);
 131     $boobstr[1] =~ s/^\./$bodef./;
 132     @boobs= map { pa_boob('pt',$_) } @boobstr;
 133     seg_wiring($seg,$pt, {
 134         Kind => Point,
 135         Posns => 2,
 136         BoObs => [ @boobs ],
 137     });
 138 }
 139
 140 sub begin_relays () { }
 141 sub line_relays () {
 142     my ($seg,$rly,$waggle);
 143     m,^\s+(\w+)/([A-Za-z]+)\s+([1-9]\d*|0)\.(\w+)$, or return syntaxerror();
 144     ($seg,$rly)= ($1,$2);
 145     $waggle= { Kind => 'waggle', Board => $3, Indiv => $4 };
 146     seg_wiring($seg,$rly, {
 147         Kind => Relay,
 148         Posns => 2,
 149         BoObs => [ $waggle ],
 150     });
 151 }
 152
 153 sub begin_fixed () { }
 154 sub line_fixed () {
 155     my ($seg,$feat,$pos);
 156     m,^\s+(\w+)/([A-Za-z]+)(\d+)$, or return syntaxerror();
 157     ($seg,$feat,$pos)=($1,$2,$3);
 158     seg_wiring($seg,$feat, {
 159         Kind => Fixed,
 160         Fixed => $pos,
 161     });
 162     $segs{$seg}{FeatCountFixed}++;
 163 }
 164
 165 sub begin_segment () { }
 166 sub line_segment () {
 167     my ($seg,$boobstr,$boob);
 168     m/^\s+(\w+)\s+(\d+\.\d+)$/ or return syntaxerror();
 169     ($seg,$boobstr)=($1,$2);
 170     mistake("duplicate topology for segment $seg") if exists $segs{$seg};
 171     $boob= pa_boob('sense', $boobstr);
 172     $segs{$seg}= {
 173         BoOb => $boob,
 174         InvBoOb => $invertible ? { Kind => 'reverse',
 175                                    Board => $boob->{Board},
 176                                    Obj => $boob->{Obj} } : undef,
 177         Posns => 1,
 178         Feats => { },
 179         FeatCount => 0,
 180         FeatCountFixed => 0
 181     };
 182     &{"line_segment_".($invertible?'invertible':'vanilla')}($boob);
 183 }
 184
 185 sub begin_endwiring () {
 186 }
 187
 188 sub begin_boards () {
 189 }
 190 sub line_boards () {
 191     my ($num,$type,$k);
 192     m/^\s+(\d+)\s+(\w+)$/ or return syntaxerror();
 193     ($num,$type)=($1,$2);
 194     mistake("board $num when expected $nextboardnum")
 195         if $num != $nextboardnum;
 196
 197     $nextboardnum++;
 198     $boardtype[$num]= $type;
 199     require "./$type.pin-info";
 200
 201     my ($sense_count, $page);
 202     $sense_count= $kind_count{$type}{'sense'};
 203     for ($page=0;
 204          $sensesin[$page] + $sense_count > 128;
 205          $page++) {
 206         mistake("too many senses for encoding scheme")
 207             if $page > 7;
 208         push @sensesin, 0
 209             if $page > $#sensesin;
 210     }
 211     $sensesbase[$num]= ($page << 7) | $sensesin[$page];
 212     $sensesin[$page] += $sense_count;
 213
 214     &{"line_boards_$type"}($num);
 215 }
 216
 217 sub line_boards_reversers { }
 218 sub line_boards_detectors { }
 219 sub line_segment_vanilla ($) { }
 220 sub line_segment_invertible ($) {
 221     my ($boob) = @_;
 222     $reversersboardnum[ $boob->{Board} ]= -1;
 223 }
 224
 225 sub begin_interferences () {
 226 }
 227 sub line_interferences () {
 228     s/^\s+// or return syntaxerror();
 229     my ($is) = [ split /\s+/, $_ ];
 230     my ($invert)= 0;
 231     if ($is->[0] eq '-') {
 232         shift @$is;
 233         $invert= 1;
 234     }
 235     map {
 236         $invert ^= 1 if s/^\-//;
 237         s,$,/.*, unless m,/,;
 238     } @$is;
 239     return syntaxerror() if grep { !m,^\w+/, } @$is;
 240     push @interfs, { Invert => $invert, Segs => $is };
 241 }
 242
 243 # We read the movfeatmap and write out most things in the output to
 244 # have the concrete (RHS) version; the exception is layout-data.c
 245 # SegPosCombInfo.pname.
 246 #
 247 # The FeatMap is a bidirectional mapping constructed from "movfeatposmap"
 248 # lines, a map between ([A-Za-z]+[0-9]+)* and ([A-Za-z]+[0-9]+)*.
 249 #
 250 # It has two effects:
 251 #     - in line_endwiring, used "forwards"
 252 #     - when writing out .pname, used "backwards"
 253 # in each case we match only whole feature positions by regexp tricks
 254 # we record whether a mapping entry was used, and complain if not
 255
 256 sub begin_movfeatposmap () { }
 257 sub line_movfeatposmap () {
 258     my ($segr,$abstr_namebase,$abstr_firstpos,$abstr_lastpos,$conc_posns) =
 259        m,^\s+(\w+)\s+([A-Za-z]+)(\d+)(?:\-(\d+))?((?:\s+(?:[A-Za-z]+\d+)*)+)$,;
 260     defined $segr or return syntaxerror();
 261
 262     my $seg= $segs{$segr};
 263     return mistake("unknown segment $segr in movfeatposmap") unless $seg;
 264
 265     $abstr_lastpos= $abstr_firstpos unless defined $abstr_lastpos;
 266     my $nabstr_posns= $abstr_lastpos - $abstr_firstpos + 1;
 267
 268     $conc_posns =~ s/^\s+//;
 269     my (@conc_posns) = split /\s+/, $conc_posns;
 270
 271     @conc_posns == $nabstr_posns
 272         or return mistake("number of concrete poscombs ".@conc_posns.
 273                           " differs from number of abstract poscombs".
 274                           " $nabstr_posns");
 275     for (my $i=0; $i<@conc_posns; $i++) {
 276         push @{ $seg->{FeatMap} }, {
 277             Abstract => $abstr_namebase.($abstr_firstpos+$i),
 278             Concrete => $conc_posns[$i],
 279             Used => 0,
 280         };
 281     }
 282 }
 283
 284 sub mistake ($) {
 285     my ($m) = @_;
 286     print STDERR "mistake: $m\n in $mode, \`$currentline'\n";
 287     $mistakes++;
 288 }
 289
 290 sub endmistake ($) {
 291     my ($m) = @_;
 292     print STDERR "mistake: $m\n";
 293     $mistakes++;
 294 }
 295
 296 sub movfeatposmap ($$$$$) {
 297     my ($subspecr, $segr, $entfrom, $entto, $call) = @_;
 298     my $featmap= $segr->{FeatMap};
 299     return unless $featmap;
 300
 301     foreach my $mapent (@$featmap) {
 302         next unless
 303             $$subspecr =~ s/
 304                 (?<! [A-Za-z] ) $mapent->{$entfrom} (?! \d )
 305                 /$mapent->{$entto}/x;
 306         $mapent->{"Used$entfrom"}++;
 307         $call->($mapent);
 308     }
 309 }
 310
 311 sub movfeatposmap_checks () {
 312     foreach my $seg (keys %segs) {
 313         my $segr= $segs{$seg};
 314         my $featmap= $segr->{FeatMap};
 315         next unless $featmap;
 316         foreach my $mapent (@$featmap) {
 317             foreach my $chk (qw(Abstract Concrete)) {
 318                 next if $mapent->{"Used$chk"};
 319                 endmistake("movfeatposmap entry $seg $mapent->{Abstract}".
 320                            " $mapent->{Concrete} unused for \L$chk lookup");
 321                 last;
 322             }
 323         }
 324     }
 325 }
 326
 327 sub line_endwiring () {
 328     my (@ns,$seg,$subspec,$dist);
 329     my ($segr,@subsegil,$feat,$pos,$featr,$combpos,%featposwant);
 330     my ($end,$node,$side,$nsr,$endposr);
 331     m,^\s*segment\s+(\w+\.\d+)\s+(\w+\.\d+)\s+(\w+)(?:/((?:[A-Za-z]+\d+)+)\*\d+)?\s+([0-9.]+)$, or return syntaxerror();
 332     ($ns[0],$ns[1],$seg,$subspec,$dist)=($1,$2,$3,$4,$5);
 333     if (!exists $segs{$seg}) {
 334         ditch("unwired $seg".(defined $subspec ? "/$subspec" : ""));
 335         return;
 336     }
 337     $segr= $segs{$seg};
 338     my $desc= $seg;
 339     if (defined $subspec) {
 340         $desc .= "/$subspec";
 341         movfeatposmap(\$subspec, $segr, Abstract, Concrete, sub {
 342             my ($mapent) = @_;
 343             $desc .= "[$mapent->{Concrete}]";
 344         });
 345     }
 346     @subsegil= defined $subspec ? $subspec =~ m/([A-Za-z]+)(\d+)/g : ();
 347     while (@subsegil) {
 348         ($feat,$pos,@subsegil) = @subsegil;
 349         if (!exists $segr->{Feats}{$feat}) {
 350             mistake("no wiring for $seg/$feat");
 351             next;
 352         }
 353         $featr= $segr->{Feats}{$feat};
 354         if (exists $featr->{Fixed}) {
 355             if ($pos != $featr->{Fixed}) {
 356                 ditch("fixed-elsewise $desc");
 357                 return;
 358             }
 359         } else {
 360             mistake("position $seg/$feat$pos exceeds wiring")
 361                 unless $pos < $featr->{Posns};
 362             $featposwant{$feat}= $pos;
 363         }
 364     }
 365     $combpos= 0;
 366     for $feat (keys %{ $segr->{Feats} }) {
 367         $featr= $segr->{Feats}{$feat};
 368         next if exists $featr->{Fixed};
 369         mistake("wiring $seg/$feat not covered by $desc"),next
 370             if !exists $featposwant{$feat};
 371         $combpos += $featposwant{$feat} * $featr->{Weight};
 372     }
 373     mistake("duplicate topology subseg for $desc")
 374         if defined $segs{$seg}{Dist}[$combpos];
 375     $segs{$seg}{Dist}[$combpos]= $dist;
 376     $endposr= $segr->{Ends}[$combpos];
 377     die "$seg $combpos ".(map { "@$_" } @$endposr)." ?"
 378         if defined $endposr && @$endposr;
 379     for ($end=0; $end<2; $end++) {
 380         $ns[$end] =~ m/^([a-z]\w+)\.([01])$/;
 381         ($node,$side)=($1,$2);
 382         $nsr= $nodes{$node}[$side];
 383         if (!exists $nsr->{Seg}) {
 384             $nodes{$node}[$side]= { Seg => $seg, End => $end };
 385         } else {
 386             $seg eq $nsr->{Seg} or
 387                 mistake("topology for $node.$side both $seg and $nsr->{Seg}");
 388             $end == $nsr->{End} or
 389                 mistake("topology for $node.$side $seg both ends ($end".
 390                         " and also $nsr->{End})");
 391         }
 392         $segr->{Ends}[$combpos][$end]= [ $node, $side ];
 393     }
 394 }
 395
 396 sub o ($) {
 397     print STDOUT $_[0] or die $!;
 398 }
 399
 400 sub pa_boob ($$) {
 401     my ($kind,$str) = @_;
 402     if ($str !~ m/^([1-9]\d*|0)\.([1-9]\d*|0)$/) {
 403         mistake("invalid board object $str");
 404         return { Kind => $kind, Board => 0, Obj => 0 };
 405     }
 406     return { Kind => $kind, Board => $1, Obj => $2 };
 407 }
 408
 409 # boob2objnum_KIND($boob,$boardnum,$objnum,$boardtype,$mkused ...)
 410 #  -> global object number
 411
 412 sub boob2objnum_waggle {
 413     my ($boob,$boardnum,$obj) = @_;
 414     mistake("waggle encoding out of range") if
 415         $boardnum >= (1 << (9 - $maxwaggleixln2));
 416     die if $obj >= (1 << $maxwaggleixln2);
 417     # waggle command is      1010 1sss OSS wwwwV
 418     # so waggler objnum is   sss SS wwww
 419     $boardnum= (($boardnum & 0x07) << 2) | ($boardnum >> 3);
 420     return ($boardnum << $maxwaggleixln2) | $obj;
 421 }
 422
 423 sub boob2objnum_pt {
 424     my ($boob,$boardnum,$obj)=@_;
 425     mistake("point encoding out of range") if
 426         $boardnum >= (1 << (10 - $maxptixln2));
 427     die if $obj >= (1 << $maxptixln2);
 428     return ($boardnum << $maxptixln2) | $obj;
 429 }
 430
 431 sub boob2objnum_reverse {
 432     my ($boob,$orgboardnum,$obj,$boardtype)=@_;
 433     # Converts board and object number (in canonical pic number plus
 434     # and reverse0...reverse5 as seen on pinout diagrams), to the
 435     # segment number for POLARITY command numbered as shown in
 436     # README.protocol.
 437     #
 438     # There are three basic stages:
 439     #
 440     #  * We invert the on-board mapping; ie, we untangle the
 441     #    tangling between the message from master to slave pic
 442     #    and the actual pins (see reverse.asm, polarity_local_do)
 443     #
 444     #  * We figure out which bit of which message byte the
 445     #    object corresponds to.  (see reverse.asm, command_polarity)
 446     #
 447     #  * We compute the README.protocol segment number.
 448
 449     my ($cycle,$boardincycle,$cyclebasebyte,$byte,$bit,$boardnum,$rv);
 450     $boardnum= $reversersboardnum[$orgboardnum];
 451     die "$orgboardnum $boardnum" unless defined $boardnum;
 452     die "$orgboardnum $boardnum" unless $boardnum >= 0;
 453     die unless $boardtype eq 'reversers';
 454     die $obj if $obj > 5;
 455 #print STDERR "data2safety $boardnum.$obj ";
 456     $obj = sprintf '%d', $obj;
 457     $obj =~ y/302154/543210/; # mapping due to polarity_do_here
 458 #print STDERR " obj=$obj";
 459     $cycle= int(($boardnum+3) / 7);
 460 #print STDERR " cycle=$cycle";
 461     $boardincycle= ($boardnum+3) - $cycle*7;
 462 #print STDERR " boardin=$boardincycle";
 463     $cyclebasebyte= $cycle*6 - 2;
 464 #print STDERR " baseby=$cyclebasebyte";
 465     if ($boardnum==2 && $obj > 2) {
 466         $byte= 0; $bit= $obj-3;
 467         $rv= 3 - $bit; # only these three in byte 0, a special case;
 468 #print STDERR " special bit=$bit => $rv\n";
 469         return $rv;
 470     } elsif ($boardincycle<5) {
 471         $byte= $cyclebasebyte + $boardincycle; $bit= $obj + 1;
 472     } elsif ($boardincycle==6) {
 473         $byte= $cyclebasebyte + 5; $bit= $obj + 1;
 474     } elsif ($boardincycle==5) {
 475         $byte= $cyclebasebyte + 5 - $bit; $bit= 0;
 476     } else {
 477         die;
 478     }
 479     $rv= $byte*7 + 3 - $bit;
 480 #print STDERR " ordinary byte=$byte bit=$bit => $rv\n";
 481     return $rv;
 482 }
 483
 484 sub boob2objnum_sense {
 485     my ($boob,$boardnum,$obj)= @_;
 486     my $type= $boardtype[$boardnum];
 487     my $bitnum= $sensepermute{$type}[$obj];
 488     die "$type $obj ($boardnum)" unless defined $bitnum;
 489     my $base= $sensesbase[$boardnum];
 490     my $inpage= $base & 0x7f;
 491     die if $inpage+$bitnum > 127;
 492     return $base+$bitnum;
 493 }
 494
 495 sub boob2objnum ($$) {
 496     my ($mkused,$boob) = @_;
 497     my ($kind,$boardnum,$type);
 498     $kind= $boob->{Kind};
 499     $boardnum= $boob->{Board};
 500 #use Data::Dumper;
 501 #print STDERR "boob2objnum($mkused, ", Dumper($boob), " )\n";
 502     $type= $boardtype[$boardnum];
 503     return &{"boob2objnum_$kind"}
 504         ($boob, $boardnum, $boob->{Obj}, $type, $mkused);
 505 }
 506
 507 sub boob_used ($) {
 508     my ($boob) = @_;
 509     my ($objnum);
 510     $objnum= boob2objnum(0, $boob);
 511     return $pin_used{$boob->{Kind}}[$objnum];
 512 }
 513
 514 sub boob_used_bit ($) {
 515     my ($boob) = @_;
 516     return defined boob_used($boob) ? 1 : 0;
 517 }
 518
 519 sub boardtype ($) {
 520     my ($board)=@_;
 521 #print STDERR ">$board<\n";
 522     mistake("unknown board number $board") unless defined $boardtype[$board];
 523     return $boardtype[$board];
 524 }
 525
 526 sub kind2genkind ($) {
 527     my ($k) = @_;
 528     return 'indiv' if $k eq 'waggle';
 529     return $k;
 530 }
 531
 532 sub boob2genkind ($) {
 533     my ($boob) = @_;
 534     return kind2genkind($boob->{Kind});
 535 }
 536
 537 sub so_boob ($$;$) {
 538     my ($mkused,$bo, $objnum_rr) = @_;
 539     my ($type,$objnum,$pi,$genkind);
 540     if (defined $bo) {
 541         my ($kind,$board,$obj) = map { $bo->{$_} } qw(Kind Board Obj);
 542 #print STDERR "so_boob >$kind|$board$obj<\n";
 543         $genkind= boob2genkind($bo);
 544 #print STDERR "so_boob    >$board|$obj<\n";
 545         $type= boardtype($board);
 546         $pi= $pin_info{$type}{$genkind};
 547         mistake("object reference $genkind ($kind) $board.$obj out of range".
 548                 " for board type $type")
 549             unless defined $pi->[$obj];
 550 #print STDERR "so_boob >$kind|$board $obj|$pi->[$obj]<\n" if $kind eq 'waggle';
 551         $objnum= boob2objnum($mkused,$bo);
 552 #print "so_boob >$objnum_rr|$$objnum_rr< = $objnum\n";
 553         $$objnum_rr= $objnum;
 554         $pin_used{$kind}[$objnum]= [ $board, $pi->[$obj], $obj ]
 555             if $mkused;
 556         return sprintf("%#5x /* %d.%-*d*/", $objnum, $board,
 557                        $kind eq 'reverse' ? 1 : 2, $obj);
 558     } else {
 559 #print "so_boob >$objnum_rr|$$objnum_rr< -\n";
 560         return "    0 /*none*/ ";
 561     }
 562 }
 563
 564 sub so_objboob ($$;$) {
 565     my ($mkused,$obj,$objnum_rr) = @_;
 566     return so_boob($mkused, defined $obj ? $obj->{BoOb} : undef,
 567                    $objnum_rr);
 568 }
 569
 570 sub mainread () {
 571     $mistakes= 0;
 572     while (<>) {
 573         chomp;
 574         s/\#.*//;
 575         s/\s+$//;
 576         next unless m/\S/;
 577         last if m/^end$/;
 578         if (m/^(invertible|vanilla|points|relays|fixed|endwiring|boards|interferences|movfeatposmap)$/) {
 579             $mode= $1;
 580             $invertible= ($mode eq 'invertible');
 581             $mode= 'segment' if $mode =~ m/^(?:vanilla|invertible)$/;
 582             &{"begin_$mode"};
 583         } else {
 584             $currentline= $_;
 585             &{"line_$mode"};
 586         }
 587     }
 588 }
 589
 590 sub redact_indir ($$) {
 591     my ($r, $what)= @_;
 592 #use Data::Dumper;
 593 #print STDERR "redact ", Dumper($r), "\n";
 594     return unless exists $r->{Indiv};
 595     my ($board,$indiv);
 596     $board= $r->{Board};
 597     $indiv= $r->{Indiv};
 598 #print STDERR "redact >$board|$indiv<\n";
 599     my $boardtype= boardtype($board);
 600     if (defined $pin_info_indiv{$boardtype}{$indiv}) {
 601         $r->{Obj}= $pin_info_indiv{$boardtype}{$indiv};
 602     } else {
 603         mistake("unknown pin name $boardtype.$indiv for $what");
 604         $r->{Obj}= 0;
 605     }
 606 }
 607
 608 sub record_phys_pin_used ($$) {
 609     my ($r,$whatfor) = @_;
 610     my ($board,$obj,$kind,$type,$pi);
 611     our (%phys_pin_used);
 612     $obj= $r->{Obj};
 613     return if $obj==0 && $mistakes; # false positives, otherwise
 614     $board= $r->{Board};
 615     $kind= kind2genkind($r->{Kind});
 616     $type= $boardtype[$board];
 617     $whatfor .= " ($r->{Kind} $kind $obj)";
 618     $pi= $pin_info{$type}{$kind}[$obj];
 619     $pi =~ m/^([01234]),(\d),/ or die $!;
 620     my ($port,$bit)=($1,$2);
 621     if (exists $phys_pin_used{$board,$pi} &&
 622         $phys_pin_used{$board,$pi} ne $whatfor) {
 623         mistake("board $board physical pin ".
 624                 "R".(qw(A B C D E)[$port]).$bit.
 625                 " ($pi) used more than once:\n".
 626                 "  $phys_pin_used{$board,$pi};\n".
 627                 "  $whatfor");
 628     }
 629     $phys_pin_used{$board,$pi}= $whatfor;
 630 }
 631
 632 sub redaction () {
 633     my ($num,$mappednum,$i,$objnum);
 634     $maxreverseobjnum= 0;
 635     for ($num=0, $mappednum=0; $num<@boardtype; $num++) {
 636         next unless defined $reversersboardnum[$num];
 637         die if $reversersboardnum[$num] != -1;
 638         $reversersboardnum[$num]= $mappednum;
 639         for ($i=0; $i<6; $i++) {
 640             $objnum= boob2objnum(0, { Kind => 'reverse',
 641                                       Board => $num,
 642                                       Obj => $i });
 643             $maxreverseobjnum= $objnum+1 if $objnum >= $maxreverseobjnum;
 644         }
 645         $mappednum++;
 646     }
 647     my ($seg,$segr,$feat,$featr,$board,$indir,$boardtype,$why);
 648     foreach $seg (keys %segs) {
 649         $segr= $segs{$seg};
 650         foreach $feat (keys %{ $segr->{Feats} }) {
 651             $featr= $segr->{Feats}{$feat};
 652             map {
 653                 $why= "segment $featr->{Kind} $seg/$feat";
 654                 redact_indir($_,$why);
 655                 record_phys_pin_used($_, $why);
 656             } @{ $featr->{BoObs} };
 657         }
 658     }
 659 }
 660
 661 sub nummap ($) {
 662     my ($p) = @_;
 663     $p =~ s/\d{1,6}/ sprintf "%06d%d",$&,$& /ge;
 664     return $p;
 665 }
 666
 667 sub so_segnum ($) {
 668     return sprintf "s%s", $_[0];
 669 }
 670
 671 sub writeout () {
 672     my (@segs,$segn,$seg,$segr,$feat,$featv, $delim);
 673     my ($comb,$pi,$end,$boob);
 674     my ($node,$side,$otherend,$nodeotherside,$otherseg,$otherbackrelus);
 675     my ($ourinter,$pcname,$intere,$intother,$fixedi);
 676     o("/* autogenerated - do not edit */\n\n");
 677     @segs=();
 678     for $seg (sort { nummap($a) cmp nummap($b) } keys %segs) {
 679         $segs{$seg}{Num}= @segs;
 680         push @segs, $seg;
 681     }
 682     o(sprintf
 683       "#define NUM_SEGMENTS %s\n\n".
 684       "#include \"layout-data.h\"\n\n",
 685       scalar @segs);
 686
 687     my ($segnum);
 688     $segnum= 0;
 689     foreach $seg (@segs) {
 690         o(sprintf "#define s%-4s %4d\n", $seg, $segnum);
 691         $segnum++;
 692     }
 693     o("\n");
 694
 695     foreach $seg (@segs) {
 696         $segr= $segs{$seg};
 697
 698         o("static const SegPosCombInfo spci_${seg}"."[]= {");
 699         $delim='';
 700
 701         $segr->{Inter}{Map}= 0;
 702         $segr->{Inter}{Invert}= 0;
 703         $ourinter= $segr->{Inter};
 704         for ($comb=0; $comb < $segr->{Posns}; $comb++) {
 705             $pi='';
 706             foreach $feat (sort keys %{ $segr->{Feats} }) {
 707                 $featv= $segr->{Feats}{$feat};
 708                 next if exists $featv->{Fixed};
 709                 $pi.= sprintf("%s%d", $feat,
 710                               ($comb / $featv->{Weight}) % $featv->{Posns});
 711             }
 712             my $pi_abstr= $pi;
 713             movfeatposmap(\$pi_abstr, $segr, Concrete, Abstract, sub { });
 714             $pi_abstr =~
 715             o("$delim\n");
 716             my $dist= $segr->{Dist}[$comb];
 717             o(sprintf " { %-7s%4d, { ",
 718               '"'.$pi_abstr.'",',
 719               defined($dist) ? $dist : 1);
 720             for ($end=0; $end<2; $end++) {
 721                 o(", ") if $end;
 722                 o("{");
 723                 $otherend= $segr->{Ends}[$comb][!$end];
 724                 if (!defined $otherend) {
 725                     die "segment $seg combination $comb end $end undefined\n"
 726                         if defined $dist;
 727                     o(" 0,NOTA(Segment)");
 728                 } else {
 729                     ($node,$side) = @$otherend;
 730                     $nodeotherside= $nodes{$node}[1-$side];
 731                     if (defined $nodeotherside) {
 732                         $otherseg= $nodeotherside->{Seg};
 733                         $otherbackrelus= $nodeotherside->{End} ^ $end;
 734                         o(sprintf "/*%4s.%d*/ %d,%4s",
 735                           $node,$side,
 736                           $otherbackrelus,
 737                           so_segnum($otherseg));
 738                     } else {
 739                         o(sprintf "/*%5s.%d*/ 0,NOTA(Segment)",
 740                           $node,$side);
 741                     }
 742                 }
 743                 o(" }");
 744             }
 745             o(sprintf " } }");
 746             $delim= ',';
 747
 748             $pcname= "$seg/$pi";
 749             for $intere (@interfs) {
 750                 my ($inter)= $intere->{Segs};
 751                 next unless grep {
 752                     if ($pcname =~ m/^$_$/) {
 753                         s,/.*,/ ?,; 1;
 754                     } else {
 755                         0;
 756                     }
 757                 } @$inter;
 758                 for $intother (@$inter) {
 759                     $intother =~ m,^(\w+)/, or die "$intother ?";
 760                     next if $1 eq $seg;
 761                     exists $segs{$1} or
 762                         endmistake("unknown segment $1 in interference");
 763                     if (defined $ourinter->{Seg}) {
 764                         $1 eq $ourinter->{Seg} or
 765                             endmistake("unsupported complicated interference ".
 766                                        "involving $seg, $1, $ourinter->{Seg}");
 767                     } else {
 768                         $ourinter->{Seg}= $1;
 769                         $ourinter->{Invert}= $intere->{Invert};
 770                     }
 771                 }
 772                 endmistake("unsupported too-moveable interference")
 773                     if $comb>7;
 774                 $ourinter->{Map} |= 1 << $comb;
 775             }
 776         }
 777         o("\n};\n");
 778
 779         next unless $segr->{FeatCount} || $segr->{FeatCountFixed};
 780
 781         for $feat (keys %{ $segr->{Feats} }) {
 782             $featv= $segr->{Feats}{$feat};
 783             next if exists $featv->{Fixed};
 784             o("static const BoardObject mfbo_${seg}_${feat}"."[]= {");
 785             $delim=' ';
 786             foreach $boob (@{ $featv->{BoObs} }) {
 787                 o($delim);
 788                 o(so_boob(1, $boob));
 789                 $delim= ', ';
 790             }
 791             o(" };\n");
 792         }
 793
 794         o("static const MovFeatInfo mfi_${seg}"."[]= {");
 795         $delim='';
 796         for $fixedi (qw(0 1)) {
 797             for $feat (keys %{ $segr->{Feats} }) {
 798                 $featv= $segr->{Feats}{$feat};
 799                 next if $fixedi != !!exists $featv->{Fixed};
 800                 o("$delim\n");
 801                 o("  { \"$feat\", mfk_".lc($featv->{Kind}).",");
 802                 if (!$fixedi) {
 803                     o(" $featv->{Posns}, $featv->{Weight}, mfbo_${seg}_$feat");
 804                 } else {
 805                     o(" $featv->{Fixed}, 0, 0");
 806                 }
 807                 o(" }");
 808                 $delim=',';
 809             }
 810         }
 811         o("\n};\n");
 812     }
 813     for $intere (@interfs) {
 814         map {
 815             warn "warning: unused interference specification $_\n" unless m, ,;
 816         } @{ $intere->{Segs} };
 817     }
 818
 819     my (@sensemap,$sensenum,$i);
 820     o("const SegmentNum info_nsegments=NUM_SEGMENTS;\n");
 821     o("const SegmentInfo info_segments[NUM_SEGMENTS]= {");
 822     $delim= '';
 823     $segnum= 0;
 824     foreach $seg (@segs) {
 825         $segr= $segs{$seg};
 826         o("$delim\n");
 827         o(sprintf " { %-7s%d,%d,%2d,%d,%-9s%d,%-10s%-6s,%-7s",
 828           "\"$seg\",",$segr->{InvBoOb}?1:0,$segr->{Inter}{Invert},
 829           $segr->{FeatCount}, $segr->{FeatCountFixed},
 830           ($segr->{FeatCount}||$segr->{FeatCountFixed}) ? "mfi_$seg," : '0,',
 831           $segr->{Posns}, "spci_$seg,",
 832           so_objboob(1, $segr, \$sensenum),
 833           so_boob(1, $segr->{InvBoOb}).',');
 834         $ourinter= $segr->{Inter};
 835         if (defined $ourinter->{Seg}) {
 836             o(sprintf "%4s,0%o ", so_segnum($ourinter->{Seg}),
 837               $ourinter->{Map});
 838         } else {
 839             o(" -1 ");
 840         }
 841         o("}");
 842         $delim= ',';
 843         $sensemap[$sensenum]= $seg;
 844         $segnum++;
 845     }
 846     o("\n};\n");
 847     o("const BoardObject info_maxreverse= $maxreverseobjnum;\n");
 848     o("#define u -1\n");
 849     o("const SegmentNumInMap info_segmentmap[]= {\n");
 850     $i=0;
 851     foreach $seg (@sensemap) {
 852         o(!$i ? ' ' :
 853           !($i % 12) ? ",\n " :
 854           ",");
 855         o(defined($seg) ? sprintf("%4s",so_segnum($seg)) : '   u');
 856         $i++;
 857     }
 858     o("\n};\n".
 859       "#undef u\n".
 860       "const int info_segmentmaplen= ".scalar(@sensemap).";\n");
 861 }
 862
 863 # writeasm_KIND()
 864
 865 sub o_section ($$) {
 866     my ($sec,$docstring) = @_;
 867     o("\n;----------\n".
 868       "  org $sec\n");
 869     o($docstring);
 870 }
 871 sub o_section_end_fill ($$$) {
 872     my ($lastnumdone, $fillvalue, $entrysize) = @_;
 873     if ($entrysize == 1 and $lastnumdone & 1) {
 874         o(", $fillvalue & 0xff\n");
 875         $lastnumdone++;
 876     } else {
 877         o("\n");
 878     }
 879     o(sprintf "  fill %s, %d*(maxpics-%d)\n\n",
 880       $fillvalue, $entrysize, $lastnumdone);
 881 }
 882
 883 sub o_db ($;$) {
 884     my ($ix,$every) = @_;
 885     $every=16 unless defined $every;
 886     o(($every ? $ix % $every : $ix) ? ',' : "\n  db ");
 887 }
 888
 889 sub writeasm_sense {
 890     my ($num, $base);
 891     o_section('pic2detinfo',<<'END');
 892 ; Table indexed by pic no., giving information about sensing
 893 ; Each element is two bytes:
 894 ;  1st byte   bit 7     Set iff this board exists for the purposes of sensing
 895 ;             bits 6-3  Not used, set to zero
 896 ;             bits 2-0  Top 3 bits of sense segment numbers on this board
 897 ;  2nd byte   bit 7     Set iff this board is a Detectors board
 898 ;             bits 6-0  Base for bottom 7 bits of segment number
 899 ;                       (per-board segment no. is added to this; carry
 900 ;                        to upper 3 bits is not permitted)
 901 END
 902     o("SenseExists equ 0x80\n".
 903       "Detectors equ 0x80\n".
 904       "Reversers equ 0x00\n\n");
 905     for ($num=0; $num<@boardtype; $num++) {
 906         if (!defined $boardtype[$num]) { o("  dw  0\t\t\t\t; $num\n"); next; }
 907         $base= $sensesbase[$num];
 908         o(sprintf "  db  SenseExists | 0x%02x, %12s | 0x%02x\t; %d\n",
 909           $base >> 7, ucfirst($boardtype[$num]), $base & 0x7f, $num);
 910     }
 911     o_section_end_fill($num, 0, 2);
 912 }
 913
 914 sub writeasm_pt ($$) { writeasm_ptwag('pt',$maxptixln2); }
 915 sub writeasm_waggle ($$) { writeasm_ptwag('waggle',$maxwaggleixln2); }
 916 sub writeasm_ptwag ($$) {
 917     my ($ptwag, $maxthingixln2) = @_;
 918     my $bitmapbitsperpic= 1<<$maxthingixln2;
 919     my $bitmapbytesperpic= 1<<($maxthingixln2-3);
 920     my ($num, $elemsize, $byte, $bit, $objnum);
 921
 922     o_section("picno2${ptwag}map",<<"END");
 923 ; Bitmap indexed first by pic no, and then by thing no. on that board,
 924 ; saying whether the thing is present or not.  Each pic has
 925 ; $bitmapbytesperpic bytes, ie $bitmapbitsperpic bits.  First byte is
 926 ; objects 0 to 7, in bits 0 to 7 respectively so that MSbit of byte 3
 927 ; (4th byte) is object no.31.  Unused boards or boards with no such
 928 ; objects are all-bits-0.
 929 END
 930     for ($num=0; $num<@boardtype; $num++) {
 931         if (!defined $boardtype[$num]) { o("  dw  0\t\t\t\t; $num"); next; }
 932         die if $maxthingixln2 < 4; # must be whole no. of 16-bit words
 933         $elemsize= $bitmapbytesperpic;
 934         for ($byte=0; $byte < $elemsize; $byte++) {
 935             o_db($byte, 0);
 936             o("b'");
 937             for ($bit=7; $bit>=0; $bit--) {
 938                 o(boob_used_bit({ Kind => $ptwag,
 939                                   Board => $num,
 940                                   Obj => $byte*8 + $bit }));
 941             }
 942             o("'");
 943         }
 944         o(" ; $num");
 945     }
 946     o("\n");
 947     o_section_end_fill($num, 0, $elemsize);
 948
 949     my ($typeix,$type,$pi,$indexpr);
 950     $indexpr= '0'x(7-$maxthingixln2). 'D'. 'o'x$maxthingixln2;
 951     o_section("bk${ptwag}ix2portnumbitnum",<<"END");
 952 ; Table giving physical ports and pins for each $ptwag for each
 953 ; kind of board.  Index is object number (for reversers boards)
 954 ; or object number + 2^$maxthingixln2 (for detectors boards).
 955 ; Value is one byte, either 0xff meaning that board type has
 956 ; no such object, or top nybble being port number (0 for A, 1 for B,
 957 ; etc.) and bottom nybble being bit number.  Ie,
 958 ;   Index:  $indexpr    where D is 1 iff detectors board and o is obj
 959 ;   Value:  0ppp0bbb    where p is port num and b is bit num; or 0xff
 960 END
 961     o("  radix hex\n");
 962     for ($typeix=0; $typeix<2; $typeix++) {
 963         $type= qw(reversers detectors)[$typeix];
 964         die $type unless $pin_info{$type};
 965         o("; $type:");
 966         for ($objnum=0; $objnum < (1 << $maxthingixln2); $objnum++) {
 967             o_db($objnum);
 968             $pi= $pin_info{$type}{kind2genkind($ptwag)}[$objnum];
 969             if (defined $pi) {
 970                 $pi =~ m/^(\d)\,(\d)\,/ or die;
 971                 o($1.$2);
 972             } else {
 973                 o('ff');
 974             }
 975         }
 976         o("\n");
 977     }
 978     o("  radix dec\n\n");
 979 }
 980
 981 sub writeasm_reverse {
 982     my ($num,$kc,$bit, @portae,$pu);
 983     o_section('picno2revmasks',<<END);
 984 ; Table listing which reversers are connected/enabled.  Index is pic
 985 ; number.  Each entry is 2 bytes: mask for port A followed by mask for
 986 ; port E.  A 1 bit is a connected reverser.  Both masks are 0 for
 987 ; non-reversers boards.
 988 END
 989     for ($num=0; $num<@boardtype; $num++) {
 990         @portae= ([],[]);
 991         $kc= $kind_count{$boardtype[$num]}{'reverse'};
 992         for ($bit= $kc-1; $bit>=0; $bit--) {
 993             $pu= boob_used({ Board => $num,
 994                              Obj => $bit,
 995                              Kind => 'reverse' });
 996             next unless $pu;
 997             $pu->[1] =~ m/^([04])\,\d,(0x\w{2})$/ or die;
 998             push @{ $portae[!!$1] }, $2;
 999         }
1000         o('  db ');
1001         o(join(', ', map { @$_ ? join('|',@$_) : '0' } @portae));
1002         o(sprintf " ; %d\n",$num);
1003     }
1004     o_section_end_fill($num, '0x0000', 2);
1005 }
1006
1007 sub writeasm () {
1008     my ($k,$w,$i,@d,$or,$p,$portnum,$bit,$each);
1009     close STDOUT or die $!;
1010     open STDOUT, ">$basename+pindata.asm" or die $!;
1011     o("; autogenerated - do not edit\n");
1012     o("  include pindata.inc\n".
1013       "  radix dec\n".
1014       "ff equ 0xff\n");
1015     $each= 10;
1016     for $k (@objkinds) {
1017         &{"writeasm_$k"}();
1018     }
1019     o("\n  end\n");
1020 }
1021 mainread();
1022 redaction();
1023 writeout();
1024 writeasm();
1025 movfeatposmap_checks();
1026 exit 1 if $mistakes;