5 use Data::Dump qw(dump);
12 my $opt_horizontal = 0;
24 'invert!' => \$opt_invert,
25 'vertical-flip!' => \$opt_vertical,
26 'horizontal-flip!' => \$opt_horizontal,
27 'edge-pins!' => \$opt_edge,
28 'middle-pins!' => \$opt_middle,
29 'zebra!' => \$opt_zebra,
30 'lines!' => \$opt_lines,
31 'read=s' => \$opt_read,
32 'pins=s' => \$opt_pins,
33 'color' => \$opt_color,
34 'pinmux' => \$opt_pinmux,
38 my $font_w = 1.67; # < 2.54, font is not perfect square
39 my $font_b = 2.10; # font baseline position
41 $opt_read .= '/' unless $opt_read =~ m/\/$/;
44 open(my $fh, '<', $opt_read . shift);
51 my $model = slurp('/proc/device-tree/model');
52 $model =~ s/\x00$//; # strip kernel NULL
53 warn "# model [$model]";
56 open(DATA, '<', $opt_pins) if $opt_pins;
65 warn "MODEL [$1] == [$model] ?\n";
66 if ( $model =~ m/$1/ ) {
71 } elsif ( $include || $opt_pins ) {
72 push @{ $pins->{$1} }, $line_i while ( m/\t\s*(\w+\d+)/g );
78 warn "IGNORE: [$_]\n";
82 if ( ! $opt_pins && ! $pins ) {
84 $glob =~ s/^(\w+).*$/$1/;
85 my @pins = glob "pins/${glob}*";
86 warn "# possible pins: ",dump( \@pins );
91 die "add pin definition for # $model" unless $pins;
93 #warn "# lines ",dump( \@lines );
94 warn "# pins ",dump($pins);
98 glob($opt_read . '/sys/devices/platform/soc*/*.serial/tty/tty*'), # 4.x
99 glob( '/sys/devices/soc.*/*.uart/tty/tty*') # 3.10
101 my @v = split(/\//, $_);
102 $serial_tty->{ $v[-3] } = $v[-1];
104 warn "# serial_tty = ",dump($serial_tty);
113 my ($pin, $note) = @_;
114 if ( $pins->{$pin} ) {
115 foreach my $line ( @{$pins->{$pin}} ) {
116 my $t = $lines[$line];
120 $t =~ s/$pin/$pin $note/ || warn "can't find $pin in [$t]";
123 warn "# $line: $lines[$line]\n";
126 warn "IGNORED: pin $pin function $note\n";
130 open(my $fh, '<', $opt_read . '/sys/kernel/debug/pinctrl/pinctrl-maps');
133 if ( m/^device (\S+)/ ) {
135 if ( my $replace = $serial_tty->{$device} ) {
136 $device = $replace; # replace serial hex with kernel name
138 $device =~ s/^[0-9a-f]*\.//; # remove hex address
140 } elsif ( m/^group (\w+\d+)/ ) {
143 } elsif ( m/^function (\S+)/ ) {
146 if ( $device && $pin && $function ) {
147 push @{ $pin_function->{$pin} }, "$device $function";
149 annotate_pin $pin, "[$device $function]";
151 warn "missing one of ",dump( $device, $pin, $function );
161 warn "# pin_function = ",dump($pin_function);
164 # insert kernel gpio info
166 open(my $pins_fh, '<', (glob "/sys/kernel/debug/pinctrl/*/pins")[0]);
168 if ( m/^pin (\d+) \(([^\)]+)\)/ ) {
169 $linux_gpio_name->{$1} = $2;
172 warn "# linux_gpio_name = ",dump( $linux_gpio_name );
176 open(my $gpio_fh, '<', '/sys/kernel/debug/gpio');
181 my @l = split(/\s*[\(\|\)]\s*/, $_);
182 warn "XXX ", dump( \@l );
183 if ( $l[0] =~ m/gpio-(\d+)/ ) {
184 if ( my $pin = $linux_gpio_name->{$1} ) {
185 $gpio_debug->{ $pin } = $l[2];
186 $l[3] =~ s/\s\s+/ /g;
187 annotate_pin $pin, qq{"$l[2]" $l[3]};
189 warn "FIXME can't find $1 in ",dump( $linux_gpio_name );
195 warn "# gpio_debug = ",dump( $gpio_debug );
199 my $have_sunxi_pio = `which sunxi-pio`;
200 if ( $have_sunxi_pio ) {
202 open(my $pio, '-|', 'sunxi-pio -m print');
206 my @p = split(/\s+/,$_);
207 warn "# pio ",dump(\@p);
208 # annotate input 0 and output 1 pins
209 # annotate_pin $p[0], ( $p[1] ? 'O' : 'I' ) . ':' . $p[4] if $p[1] == 0 || $p[1] == 1;
211 annotate_pin $pin, join(' ',@p) if ! $opt_svg;
217 my $have_raspi_gpio = `which raspi-gpio`;
218 if ( $have_raspi_gpio ) {
222 open(my $pio, '-|', 'raspi-gpio get');
225 if ( m/^GPIO (\d+): (.+)/ ) {
226 my $pin = 'gpio' . $1;
228 annotate_pin $pin, $2 if ! $opt_svg;
233 open(my $pio, '-|', 'raspi-gpio funcs '.join(',',@gpio_pins));
237 if (m/^(\d+)\s+(.*)/) {
238 annotate_pin 'gpio'.$1,"($2)" if $opt_alt;
247 my $pinmux_path = (glob("/sys/kernel/debug/pinctrl/*/pinmux-functions"))[0];
248 if ( $opt_pinmux && -e $pinmux_path ) {
249 open(my $mux, '<', $pinmux_path);
252 if ( m/function: (\w+), groups = \[ (.*) \]/ ) {
253 my ( $func, $pins ) = ( $1, $2 );
254 foreach ( split(/\s+/,$pins) ) {
255 push @{ $pinmux->{$_} }, $func;
258 warn "IGNORED [$pinmux_path] [$_]\n";
262 foreach my $pin ( keys %$pinmux ) {
263 if ( exists $pins->{$pin} ) {
264 annotate_pin $pin, '{' . join(' ', @{$pinmux->{$pin}}) . '}';
266 warn "IGNORED mux on $pin\n";
270 warn "# pinmux = ",dump( $pinmux );
275 my @max_len = ( 0,0,0,0 );
278 shift(@lines) while ( ! $lines[0] ); # remove empty at beginning
279 pop(@lines) while ( ! $lines[-1] ); # remove empty at end
281 foreach my $line (@lines) {
282 if ( $line =~ m/^#/ ) {
283 push @line_parts, [ $line ] unless $opt_svg && $line =~ m/^###+/; # SVG doesn't display 3rd level comments
286 $line =~ s/\[(\w+)\s+(\w+)\] \[\1\s+(\w+)\]/[$1 $2 $3]/g; # compress kernel annotation with same prefix
287 $line =~ s/(\[(?:uart\d*|serial|tty\w+))([^\t]*\]\s[^\t]*(rx|tx)d?)/$1 $3$2/gi;
288 $line =~ s/(\[i2c)([^\t]*\]\s[^\t]*(scl?k?|sda))/$1 $3$2/gi;
289 $line =~ s/(\[spi)([^\t]*\]\s[^\t]*(miso|mosi|s?clk|c[se]\d*))/$1 $3$2/gi;
290 $line =~ s/\s*\([^\)]+\)//g if ! $opt_alt;
292 # shorten duplicate kernel device/function
293 $line =~ s/\[serial (\w+) (uart\d+)\]/[$2 $1]/g;
294 $line =~ s/\[(\w+) (\w+) \1(\d+)\]/[$1$3 $2]/g;
296 $line =~ s/\[(\w+)\s+([^\]]+)\s+\1\]/[$1 $2]/g; # duplicate
298 my @v = split(/\s*\t+\s*/,$line,4);
299 @v = ( $v[2], $v[3], $v[0], $v[1] ) if $opt_horizontal && $v[2];
301 push @line_parts, [ @v ];
302 foreach my $i ( 0 .. 3 ) {
303 next unless exists $v[$i];
304 next if $v[$i] =~ m/^#/; # don't calculate comments into max length
305 my $l = length($v[$i]);
306 $max_len[$i] = $l if $l > $max_len[$i];
310 warn "# max_len = ",dump( \@max_len );
311 warn "# line_parts = ",dump( \@line_parts );
313 #print "$_\n" foreach @lines;
319 print qq{<?xml version="1.0" encoding="UTF-8" standalone="no"?>
321 xmlns:dc="http://purl.org/dc/elements/1.1/"
322 xmlns:cc="http://creativecommons.org/ns#"
323 xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
324 xmlns:svg="http://www.w3.org/2000/svg"
325 xmlns="http://www.w3.org/2000/svg"
326 xmlns:xlink="http://www.w3.org/1999/xlink"
329 viewBox="0 0 210 297"
336 }; # svg, insert rest of rect
338 print qq{<rect x="0" y="0" width="210" height="297" style="fill:#000000" id="high-contrast"/>} if $opt_invert;
343 my $cols = { # foreground background
344 txt => [ '#000000', '#ffffff' ],
345 pins => [ '#ffffff', '#ff00ff' ],
346 vcc => [ '#ff0000', '#ffff00' ],
347 gnd => [ '#000000', '#00ffff' ],
348 i2c => [ '#008800', '#ffcccc' ],
349 serial=>[ '#000088', '#ccffcc' ],
350 spi => [ '#880000', '#ccccff' ],
355 die "$swap not found in ",dump($cols) unless $cols->{$swap};
356 my ( $c1, $c2 ) = @{ $cols->{$swap} };
357 $cols->{$swap} = [ $c2, $c1 ];
360 swap_cols 'txt' if $opt_invert;
364 my ($name,$x,$y,$col) = @_;
366 return '' unless $opt_color;
368 $y -= $font_b; # shift box overlay to right vertical position based on font baseline
371 my ($x,$y,$col,$fill) = @_;
372 print qq{<rect x="$x" y="$y" height="2.54" width="}, $max_len[$col] * $font_w, qq{" style="fill:$fill;stroke:#ffffff;stroke-width:0.10" />\n};
376 if ( $name =~ m/^(\d+)$/ ) { # pins
378 my ( $fg, $bg ) = @{ $cols->{pins} };
380 my $w = $max_len[$col]*$font_w - 0.1;
383 #print qq{<polygon points="$x,$y $cx,$y $x,$cy $x,$y" stroke="$fg" stroke-width="0.25" fill="$bg" />};
384 #print qq{<polygon points="$x,$cy $cx,$cy $cx,$y $x,$cy" stroke="$bg" stroke-width="0.25" fill="$fg" />};
385 print qq{<rect x="$x" y="$y" width="$w" height="2.54" stroke="$fg" stroke-width="0.3" fill="$bg" />};
386 my ( $fg, $bg ) = @{ $cols->{txt} };
387 print qq{<rect x="$x" y="$y" width="$w" height="2.54" rx="1" ry="1" stroke="$fg" stroke-width="0.3" fill="$bg" />};
391 return qq{ style="fill:$bg"};
394 if ( $name =~ m/(VCC|3V3|3.3V|5v)/i ) {
395 my ($fg,$bg) = @{ $cols->{vcc} };
397 return qq{ style="fill:$fg"};
398 } elsif ( $name =~ m/(G(ND|Round)|VSS|0v)/i ) {
399 my ($fg,$bg) = @{ $cols->{gnd} };
401 return qq{ style="fill:$fg"};
402 } elsif ( $name =~ m/\[(\w+)/ ) { # kernel
404 my ($fg,$bg) = @{ $cols->{txt} };
405 $dev = 'serial' if $dev =~ m/^tty/;
406 ($fg,$bg) = @{ $cols->{$dev} } if exists $cols->{$dev};
408 return qq{ style="fill:$fg"};
410 my ( $fg, $bg ) = @{ $cols->{txt} };
412 #return qq{ style="fill:$fg"};
419 my @cols_order = ( 0,1,2,3 );
420 my @cols_align = ( '','-','','-' ); # sprintf prefix
422 my @cols_shuffle = @cols_order;
425 # pins outside on the right
426 @cols_shuffle = ( 0,1,3,2 ) if $opt_edge;
427 @cols_align = ( '-','-','','' );
428 } elsif ( $opt_middle ) {
430 @cols_shuffle = ( 1,0,2,3 );
431 @cols_align = ( '','','-','-' );
435 my ( $what, $order ) = @_;
437 foreach my $i ( 0 .. $#$what ) {
438 $new->[$i] = $what->[ $order->[$i] ];
440 warn "# cols_shuffle what=",dump($what)," order=",dump($order)," new=",dump($new);
444 @cols_order = cols_shuffle( \@cols_order, \@cols_shuffle );
445 @max_len = cols_shuffle( \@max_len, \@cols_shuffle );
447 warn "# cols_order = ",dump( \@cols_order );
448 warn "# cols_align = ",dump( \@cols_align );
450 my $fmt = "%$cols_align[0]$max_len[0]s %$cols_align[1]$max_len[1]s %$cols_align[2]$max_len[2]s %$cols_align[3]$max_len[3]s\n";
454 my ($fg,$bg) = @{ $cols->{txt} };
455 my $line_fmt = qq{<line x1="%s" y1="%s" x2="%s" y2="%s" style="stroke:$fg;stroke-width:0.10;fill:$bg" />\n};
460 return unless $opt_svg;
461 push @cut_marks, sprintf($line_fmt, $x-5, $y-$font_b, $x+5, $y-$font_b);
462 push @cut_marks, sprintf($line_fmt, $x, $y-$font_b-5, $x, $y-$font_b+5);
466 $max_x += $max_len[$_] * $font_w foreach ( 0 .. 3 );
467 #cut_mark $max_x, $y;
470 my ($x,$y,$max_x) = @_;
471 push @cut_marks, sprintf($line_fmt, $x, $y-$font_b, $max_x, $y-$font_b);
475 my $last_cut_mark = 0;
478 my ( $from, $to ) = @_;
479 warn "# connector $from - $to ",dump( $line_parts[$from], $line_parts[$to] );
480 if ( $opt_vertical ) {
481 foreach my $i ( 0 .. int(($to-$from)/2) ) {
482 my $t = $line_parts[$from + $i];
483 $line_parts[$from + $i] = $line_parts[$to - $i];
484 $line_parts[$to - $i] = $t;
491 foreach my $i ( 0 .. $#line_parts ) {
492 next if $line_parts[$i]->[0] =~ m/^###/;
493 if (exists $line_parts[$i]->[1]) {
499 } elsif ($from && $to) {
500 connector $from => $to;
504 connector $from => $to if $from && $to;
506 foreach my $i ( 0 .. $#line_parts ) {
507 # $i = $#line_parts - $i if $opt_vertical;
508 my $line = $line_parts[$i];
512 # not a minimal two column pin description
513 if ( ! exists $line->[1] ) {
514 $last_cut_mark = 1 if $line->[0] =~ m/^##/; # skip comments
516 # before first empty line
517 if ( $last_cut_mark == 0 ) {
521 line $x, $y, $max_x if $opt_lines;
522 $y += 15; # make spacing between pinouts
524 } elsif ( $last_cut_mark ) {
530 #warn "CUTMARK no magic";
533 line $x, $y, $max_x if $opt_lines && exists $line->[1];
535 my ($fg,$bg) = @{ $cols->{txt} };
536 my $tspan = qq{<tspan x="$x" y="$y" style="line-height:2.54;fill:$fg;stroke:none;">\n};
539 foreach my $i ( 0 .. $#cols_order ) {
540 my $order = $cols_order[$i];
541 next unless $line->[$order];
543 my $text_anchor = 'middle';
544 my $len = $max_len[$i];
545 my $x2 = $x_pos + ( $len * $font_w ) / 2;
547 if ( $#$line == 0 && $line->[$order] =~ s/^#+s*// ) {
548 # comment, center over whole width
549 $len = length($line->[$order]);
550 $x2 = $x + (($max_x-$x)/2); # middle
551 $tspan .= qq{\t<tspan x="$x2" text-anchor="$text_anchor"}.sprintf( '>%' . $cols_align[$i] . $len . 's</tspan>', $line->[0]);
553 $tspan .= qq{\t<tspan x="$x2" text-anchor="$text_anchor"}.svg_style($line->[$order],$x_pos,$y,$i).sprintf( '>%' . $cols_align[$i] . $len . 's</tspan>', $line->[$order]);
555 $x_pos += $len * $font_w;
558 $tspan .= qq{\n</tspan>\n};
559 push @later,sprintf $tspan, @$line;
562 # swap pin colors for line stripe
564 swap_cols $_ foreach qw( pins txt );
571 if ( $#$line == 0 ) {
572 print $line->[0], "\n";
574 push @$line, '' while ($#$line < 3); # fill-in single row header
575 printf $fmt, map { $line->[$_] } @cols_order;
584 line $x, $y, $max_x if $opt_lines;
591 style="font-size:2.34px;line-height:2.54px;font-family:'Andale Mono';stroke:none"
592 xml:space="preserve">
596 print @later, qq{</text>\n}, @cut_marks, qq{</g>\n</svg>};
600 # you can add pin definitions below, but they should go into pins/