git.rot13.org Git - x300-pci/blob - openocd-jtag-boundary-scan.pl

   1 #!/usr/bin/perl
   2
   3 use warnings;
   4 use strict;
   5 use autodie;
   6 use Data::Dump qw(dump);
   7 use IO::Socket::INET;
   8 use Storable;
   9
  10 my $openocd_remote = shift @ARGV || 'picam:4444';
  11 my $bsdl_file = $ENV{BSDL} ||
  12         'EP4CE6E22.bsd';
  13 #       '_3128at100.bsd';
  14 #       '3064at44.bsd'; # XXX
  15 my $project_file = 'Altera/epm3064_dac/3064at44.qsf';
  16 $project_file = 'tb276/f32c.qsf';
  17
  18 my $BOUNDARY_LENGTH = -1;
  19 my $entity;
  20
  21 my $bit2pin;
  22 my $io2bit;
  23
  24 my $pin2io;
  25 my $parse;
  26 my $parse_in = 0;
  27 my $parse_regex = join('|', qw(
  28         PIN_MAP_STRING
  29         INSTRUCTION_OPCODE
  30         INSTRUCTION_LENGTH
  31         IDCODE_REGISTER
  32 ));
  33
  34 $|=1; # flush stdout
  35
  36 my $have_gpio = `which gpio`;
  37 warn "# ", ! $have_gpio ? "DOESN'T " : '', "have rpi gpio\n";
  38 require 'gpio.pl' if $have_gpio;
  39
  40 open(my $bsdl, '<', $bsdl_file);
  41 while(<$bsdl>) {
  42         if ( m/($parse_regex)/ ) {
  43                 $parse_in = $1;
  44                 $parse->{$1} .= $_;
  45         } elsif ( $parse_in ) {
  46                 next if m/^\s*--/;
  47                 s/\s+--.+$//; # remove comments and EOL
  48                 $parse->{$parse_in} .= $_;
  49                 $parse_in = 0 if m/;/;
  50         } elsif ( m/"(\d+)\s+\(BC_\d+,\s+(\S+),\s+(\S+)/ ) {
  51                 $bit2pin->{$1} = [ $2, $3 ];
  52                 push @{ $io2bit->{$2} }, $1;
  53         } elsif ( m/attribute\s+BOUNDARY_LENGTH\s+of\s+\S+\s*:\s*entity\s+is\s+(\d+);/ ) {
  54                 $BOUNDARY_LENGTH = $1;
  55                 warn "# BSDL $bsdl_file BOUNDARY_LENGTH = $BOUNDARY_LENGTH\n";
  56         } elsif ( ! $entity && m/^entity\s(\S+)\s+is/ ) {
  57                 $entity = $1;
  58                 warn "# entity = $entity\n";
  59         }
  60
  61 }
  62 close($bsdl);
  63
  64 warn "# bit2pin = ",dump($bit2pin);
  65 warn "# io2bit = ",dump($io2bit);
  66
  67 foreach my $chunk ( keys %$parse ) {
  68         $parse->{$chunk} =~ s/"\s*\&\s*"/ /gs; # concat lines back to single line
  69         $parse->{$chunk} =~ s/^.+?"//s; # strip upto first quote
  70         $parse->{$chunk} =~ s/"\s*;.*?$//s; # strip everything after closing
  71         $parse->{$chunk} =~ s/\s+/ /gs;
  72         $parse->{$chunk} =~ s/^\s+//;
  73         $parse->{$chunk} =~ s/\s+$//;
  74         $parse->{$chunk} =~ s/attribute\s+$chunk\s+of\s+$entity\s+:\s+entity\s+is\s+(\d+)\s*;/$1/;
  75
  76 }
  77
  78 warn "# parse = ",dump($parse);
  79
  80 my $pin_map = $parse->{PIN_MAP_STRING} || die "no PIN_MAP_STRING in ",dump($parse);
  81
  82 sub str_comma {
  83         my $t = shift;
  84         $t =~ s/\s*,\s*/ /gs;
  85         return $t;
  86 }
  87 warn "# pin_map = ",dump($pin_map);
  88 $pin_map =~ s/\(\s*([^\)]+?)\s*\)/str_comma($1)/gse;
  89 warn "# pin_map = ",dump($pin_map);
  90
  91 foreach my $map ( split(/\s*,\s*/, $pin_map) ) {
  92         warn "## $map\n";
  93         my ( $name, $pin ) = split(/\s*:\s*/, $map);
  94         $pin2io->[$_] = $name foreach split(/ /,$pin);
  95 }
  96
  97 warn "# pin2io = ",dump( $pin2io );
  98 #store \$pin2io, $bsdl_file . '.pin2io.storable';
  99 store \$pin2io, $entity . '.pin2io.storable';
 100
 101
 102 my $opcode;
 103 my $o = $parse->{INSTRUCTION_OPCODE} || die "no INSTRUCTION_OPCODE in ",dump($parse);
 104
 105 foreach ( split(/\)\s*,\s*/, $o) ) {
 106         s/\s+\(/ /g;
 107         s/\s*\)\s*$//g;
 108         warn "### [$_]\n";
 109         my ( $inst_opcode, $bin ) = split(/\s+/, $_);
 110         $opcode->{$inst_opcode} = sprintf "0x%02x", eval '0b' . $bin;
 111 }
 112 warn "# opcode = ",dump($opcode);
 113
 114 foreach (qw(SAMPLE EXTEST)) {
 115         die "missing INSTRUCTION_OPCODE $_ in ",dump($opcode) unless $opcode->{$_};
 116 }
 117
 118 my $pin_desc;
 119 foreach my $pin_file ( glob "pins/$entity*.tsv" ) {
 120         open(my $fh, '<', $pin_file);
 121         while(<$fh>) {
 122                 chomp;
 123                 my ($pin,$desc, $bcm) = split(/\t+/,$_,3);
 124                 $pin_desc->{$pin} = $desc;
 125                 gpio::add_bcm_desc( $bcm => $desc ) if $have_gpio;
 126         }
 127         close($fh);
 128         warn "# $pin_file ",dump($pin_desc);
 129 }
 130
 131 {
 132         open(my $fh, '<', $project_file);
 133         while(<$fh>) {
 134                 chomp;
 135                 s/[\r\n]+$//;
 136                 next if m/^\s*#/;
 137                 my ($set,$pin, $op, $desc) = split(/\s+/,$_,4);
 138                 if ( $set =~ m/set_location_assignment/i && $op =~ m/-to/i && $pin =~ s/^PIN_//ig ) {
 139                         $pin_desc->{$pin} = $desc; # overwrite pin description
 140                 } else {
 141                         #warn "## ignored $_\n";
 142                 }
 143         }
 144         close($fh);
 145         warn "# $project_file ",dump($pin_desc);
 146 }
 147
 148 =for remove
 149 my @sort = sort {
 150         my $aa = $a; $aa =~ s/\D+//g;
 151         my $bb = $b; $bb =~ s/\D+//g;
 152         $aa <=> $bb } keys %$io2bit;
 153 warn "# sort = ",dump(@sort);
 154 =cut
 155
 156 sub bits {
 157         my $bits = shift;
 158         return $bits; # FIXME disable for now
 159         $bits =~ s/0/ /;
 160         $bits =~ s/^(.)0/$1 /;
 161         $bits =~ s/^1/I/;
 162         $bits =~ s/^(.)1/$1./;
 163         return $bits;
 164 }
 165
 166 my $last_bits = '';
 167 sub print_io {
 168         my $bits = shift;
 169         return unless length($bits) == $BOUNDARY_LENGTH;
 170         my $o_bits = $bits;
 171         $bits = reverse $bits; # make substr work as expected
 172         my $last_bits_r = reverse $last_bits;
 173
 174         print "pin off io___ ICO          | " x 4, $openocd_remote,"\n";
 175         foreach my $i ( 0 .. ($#$pin2io/4)-1 ) {
 176                 foreach my $j ( 0 .. 3 ) {
 177                         #my $pin = ($i*4) + $j + 1; # rows
 178                         my $pin = ($#$pin2io/4) * $j + $i + 1; # columns
 179                         my $io = $pin2io->[$pin];
 180                         my $o = $io2bit->{$io}->[0];
 181
 182                         if ( defined $o ) {
 183                                 my $l = $b = substr($bits, $o, 3);
 184                                 $l = substr($last_bits_r,$o,3) if $last_bits;
 185
 186                                 my $desc = $pin_desc->{$pin} || '';
 187                                 my $bits = bits($b);
 188                                 if ( $b ne $l ) {
 189                                         my @b = split(//, $bits);
 190                                         my @l = split(//, bits($l));
 191                                         $bits = '';
 192                                         foreach ( 0 .. $#b ) {
 193                                                 $bits .= $b[$_] eq $l[$_] ? $b[$_] : "\e[33;7;1m$b[$_]\e[0m";
 194                                         }
 195                                 }
 196
 197                                 $desc = ' ' . $desc if length($desc) < 10;
 198                                 $desc = substr($desc,0,10);
 199
 200                                 printf "%-3d %-3d %-5s %3s%-10s| ", $pin, $o, $io, $bits, $desc;
 201                         } else {
 202                                 printf "%-3d ... %-18s | ", $pin, $io;
 203                         }
 204                 }
 205                 print "\n";
 206         }
 207         print "\n";
 208         $last_bits = $o_bits;
 209 }
 210
 211 #foreach my $h (qw(0 1 2 e f 10 11 12 1e 1f 20 30 40 50 100 200 1000)) {
 212 #        printf "hex = %4s  binary = %16s\n", $h, hex2bin($h);
 213 #}
 214
 215 my $sock = IO::Socket::INET->new($openocd_remote);
 216
 217 sub hex2bin {
 218         my $h = shift;
 219         my $hlen = length($h);
 220         my $blen = $hlen * 4;
 221         return unpack("B$blen", pack("H$hlen", $h));
 222 }
 223
 224 sub bin2hex {
 225         my $b = shift;
 226         $b =~ s/\s+//g;
 227         my $blen = length($b);
 228         my $hlen = $blen / 4;
 229         return unpack("H$hlen", pack("B$blen", $b));
 230 }
 231
 232
 233 my $tap;
 234 print $sock "jtag names\n"; # will fill-in $tap variable from openocd
 235
 236 my $BSR;
 237
 238 my $scan_chain;
 239
 240 while(1) {
 241
 242 while (<$sock>) {
 243         warn "<< ",dump($_);
 244         chomp;
 245         s/[\r\x00]+//g;
 246         if ( ! $tap && m/^(\w+\.tap)$/ ) {
 247                 $tap = $1;
 248                 warn "# using TAP $tap\n";
 249
 250                 print $sock "scan_chain\n";
 251                 $scan_chain = 0;
 252
 253         } elsif ( ! $scan_chain && m/\d+\s+$tap\s+Y\s+0x([0-9a-f]+)\s+0x[0-9a-f]+\s+(\d+)/ ) {
 254
 255                 my ($IdCode,$IrLen) = ( $1, $2 );
 256
 257                 my $bsdl_id_code = bin2hex( $parse->{IDCODE_REGISTER} );
 258                 die "IdCode != IDCODE_REGISTER $IdCode != $bsdl_id_code" if lc($IdCode) ne lc($bsdl_id_code);
 259
 260                 die "IrLen != INSTRUCTION_LENGTH $IrLen != $parse->{INSTRUCTION_LENGTH}" if $IrLen != $parse->{INSTRUCTION_LENGTH};
 261
 262                 warn "# OK IdCode $IdCode IrLen $IrLen\n";
 263                 $scan_chain = 1;
 264
 265                 # first sample
 266                 print $sock "irscan $tap $opcode->{SAMPLE}\n"; # SAMPLE/PRELOAD
 267                 print $sock "drscan $tap $BOUNDARY_LENGTH 0\n";
 268
 269         } elsif ( /^\s*([A-F0-9]+)$/ ) {
 270                 my $hex = $1;
 271                 my $bin = hex2bin($hex);
 272                 $bin = substr($bin,0, $BOUNDARY_LENGTH) if length($bin) > $BOUNDARY_LENGTH;
 273                 diff_bits($BSR, $bin);
 274                 $BSR = $bin;
 275                 print_io $bin if $bin ne $last_bits;
 276                 gpio::pins() if $have_gpio;
 277                 last;
 278         } elsif ( m/>\s+\S+/ ) {
 279                 # ignore command echo
 280         } else {
 281                 warn "# ignored ",dump($_);
 282         }
 283 }
 284
 285 sub diff_bits {
 286         my ($old, $new) = @_;
 287         return unless $old && $new;
 288         $old = reverse $old; # extra bits must be on the end
 289         $new = reverse $new;
 290         $old =~ s/(...)/$1 /g;
 291         $new =~ s/(...)/$1 /g;
 292         my @o = split(/ /, $old);
 293         my @n = split(/ /, $new);
 294         my $bsr_max_bit = $BOUNDARY_LENGTH / 3 - 1;
 295         foreach my $i ( 0 .. $bsr_max_bit ) {
 296                 if ( $o[$i] eq $n[$i] ) {
 297                         $o[$i]='.';
 298                 } else {
 299                         my $pin = $bit2pin->{ $i * 3 }->[0];
 300                         $o[$i] = " $pin@" . ( $i * 3 ) . ":" . $o[$i] . '>' . $n[$i];
 301                 }
 302         }
 303         my $diff = join('', @o[ 0 .. $bsr_max_bit ]);
 304         print "# diff_bits $diff\n";
 305 }
 306
 307 print "> ";
 308 my $cmd = <STDIN>;
 309 chomp $cmd;
 310 if ( $cmd =~ /(p|o)(\d+)=(\d+)/ ) {
 311         my ( $what, $p, $v ) = ( $1, $2, $3 );
 312
 313         my $old_bsr = reverse $BSR;
 314         my $b = $old_bsr;
 315
 316         if ( $what eq 'p' && length($v) == 1 ) {
 317
 318                 my $pin = $p;
 319                 my $io = $pin2io->[$pin];
 320                 my $bit = $io2bit->{$io}->[0];
 321
 322                 warn "# pin $pin = $v io=$io bit=$bit\n";
 323
 324                 $b =
 325                           substr($old_bsr,0,$bit+1) # leave input as-is
 326                         . ( $v eq 'Z' ? 1 : 0 )     # control
 327                         . ( $v & 1 )                # output
 328                         . substr($old_bsr,$bit+3)
 329                         ;
 330
 331
 332         } elsif ( $what eq 'o' && $p < $BOUNDARY_LENGTH ) {
 333                 my $o = $p;
 334                 #$b = substr($old_bsr,0,$o) . reverse $v . substr($old_bsr,$o+length($v));
 335                 $b = ( "0" x $o ) . reverse $v . ( "0" x ( length($old_bsr) - $o - length($v) ) );
 336 warn "XXX",length($old_bsr), " == ",length($b);
 337                 $old_bsr = "0" x length($old_bsr);
 338         } else {
 339                 print "IGNORED ",dump( $what, $p, $v );
 340         }
 341
 342         $b = reverse $b;
 343
 344         diff_bits( $BSR, $b );
 345
 346 #       print $sock "irscan $tap $opcode->{SAMPLE}\n"; # SAMPLE/PRELOAD
 347         print $sock "drscan $tap $BOUNDARY_LENGTH 0x", bin2hex($b), "\n";
 348         print $sock "irscan $tap $opcode->{EXTEST}\n"; # EXTEST
 349 #       print $sock "drscan $tap $BOUNDARY_LENGTH 0x", bin2hex($b), "\n";
 350
 351 } elsif ( $cmd =~ m/\?/ ) {
 352         $last_bits = '';
 353         print $sock "irscan $tap $opcode->{SAMPLE}\n"; # SAMPLE/PRELOAD
 354         print $sock "drscan $tap $BOUNDARY_LENGTH 0\n";
 355 } else {
 356         gpio::cmd( $cmd ) if $have_gpio;
 357         print $sock "irscan $tap $opcode->{SAMPLE}\n"; # SAMPLE/PRELOAD
 358         print $sock "drscan $tap $BOUNDARY_LENGTH 0\n";
 359 }
 360
 361
 362 }#while(1)