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