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