move uart rx/tx into kernel port description
[linux-gpio-pinout] / gpio.pl
diff --git a/gpio.pl b/gpio.pl
index 96b2e9d..c432c43 100755 (executable)
--- a/gpio.pl
+++ b/gpio.pl
@@ -3,6 +3,26 @@ use warnings;
 use strict;
 use autodie;
 use Data::Dump qw(dump);
+use Getopt::Long;
+
+my $opt_svg = $ENV{SVG} || 0;
+my $opt_alt = $ENV{ALT} || 0;
+my $opt_invert = $ENV{INVERT} = 0;
+my $opt_vertical = $ENV{VERTICAL} = 0;
+my $opt_kernel = $ENV{kernel} = 1;
+GetOptions(
+       'svg!' => \$opt_svg,
+       'alt!' => \$opt_alt,
+       'invert!' => \$opt_invert,
+       'vertical!' => \$opt_vertical,
+       'kernel!' => \$opt_kernel,
+);
+
+# svg font hints
+my $font_w = 1.67; # < 2.54, font is not perfect square
+
+my $txt_color = '#000000';
+   $txt_color = '#ffffff' if $opt_invert;
 
 sub slurp {
        open(my $fh, '<', shift);
@@ -27,8 +47,10 @@ while(<DATA>) {
        } elsif ( m/^#\s+/ ) {
                $include = 0;
        } elsif ( $include ) {
+               push @{ $pins->{$1} }, $line_i while ( m/\t(P\w\d+)/g );
+
                push @lines, $_;
-               push @{ $pins->{$1} }, $line_i while ( m/\t(P\w\w+)\s/g );
+
                $line_i++;
        } else {
                warn "IGNORE: [$_]\n";
@@ -39,16 +61,26 @@ die "add pin definition for # $model" unless $pins;
 
 warn "# pins ",dump($pins);
 
+my $pin_function;
+
 open(my $fh, '<', '/sys/kernel/debug/pinctrl/pinctrl-handles');
 while(<$fh>) {
        chomp;
        if ( m/group: (P\w\d+)\s.+function: (\S+)/ ) {
-               my ($pin, $function) = ($1,$2); 
+               my ($pin, $function) = ($1,$2);
+               $pin_function->{$pin} = $function;
+
+               next unless $opt_kernel;
+
                if ( $pins->{$pin} ) {
                        foreach my $line ( @{$pins->{$pin}} ) {
 warn "XXX $pin $line";
                                my $t = $lines[$line];
-                               $t =~ s/$pin/$pin [$function]/ || die "can't find $pin in [$t]";
+                               if ( $opt_svg ) {
+                                       $t =~ s/$pin/[$function]/;
+                               } else {
+                                       $t =~ s/$pin/$pin [$function]/ || die "can't find $pin in [$t]";
+                               }
                                $lines[$line] = $t;
                                warn "# $line: $lines[$line]\n";
                        }
@@ -56,18 +88,23 @@ warn "XXX $pin $line";
                        warn "IGNORED: pin $pin function $function\n";
                }
        }
-};
+}
 
 my @max_len = ( 0,0,0,0 );
 my @line_parts;
 foreach my $line (@lines) {
        if ( $line =~ m/^#/ ) {
-               push @line_parts, [ $line ];
+               push @line_parts, [ $line ] unless $opt_svg;
                next;
        }
+       $line =~ s/(\[uart\d)(\]\s[^\t]*(rx|tx))/$1 $3$2/gi;
+       $line =~ s/\s*\([^\)]+\)//g if ! $opt_alt;
+
        my @v = split(/\s*\t+\s*/,$line,4);
        push @line_parts, [ @v ];
        foreach my $i ( 0 .. 3 ) {
+               next unless exists $v[$i];
+               next if $v[$i] =~ m/^#/; # don't calculate comments into max length
                my $l = length($v[$i]);
                $max_len[$i] = $l if $l > $max_len[$i];
        }
@@ -80,15 +117,162 @@ warn "# line_parts = ",dump( \@line_parts );
 
 my $fmt = "%$max_len[0]s %-$max_len[1]s %$max_len[2]s %-$max_len[3]s\n";
 
-foreach my $line ( @line_parts ) {
-       if ( $#$line == 0 ) {
-               print $line->[0], "\n";
+my $x = 30.00; # mm
+my $y = 30.00; # mm
+
+if ( $opt_svg ) {
+       print qq{<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:xlink="http://www.w3.org/1999/xlink"
+   id="svg8"
+   version="1.1"
+   viewBox="0 0 210 297"
+   height="297mm"
+   width="210mm">
+
+
+<g id="layer1">
+
+       }; # svg, insert rest of rect
+
+       print qq{<rect x="0" y="0" width="210" height="297" style="fill:#000000" id="high-contrast"/>} if $opt_invert;
+}
+
+my @later;
+
+my $cols = {   # foreground background
+       txt  => [ '#000000', '#ffffff' ],
+       pins => [ '#ffffff', '#ff00ff' ],
+       vcc  => [ '#ff0000', '#ffff00' ],
+       gnd  => [ '#000000', '#00ffff' ],
+       i2c  => [ '#008888', '#ffcccc' ],
+       uart => [ '#880088', '#ccffcc' ],
+       spi  => [ '#888800', '#ccccff' ],
+};
+
+sub svg_style {
+       my ($name,$x,$y,$col) = @_;
+       $y -= 2.10; # shift box overlay to right vertical position based on font baseline
+
+       sub rect {
+               my ($x,$y,$col,$fill) = @_;
+               print qq{<rect x="$x" y="$y" height="2.54" width="}, $max_len[$col] * $font_w, qq{" style="opacity:1;fill:$fill;fill-opacity:1;stroke:#ffffff;stroke-width:0.10;stroke-opacity:1" />};
+
+       }
+
+       if ( $name =~ m/^(\d+)$/ ) { # pins
+               my $pin = $1;
+               my ( $fg, $bg ) = @{ $cols->{pins} };
+               if ( $pin == 1 ) {
+                       my $w  = $max_len[$col]*$font_w - 0.1;
+                       my $cx = $x + $w;
+                       my $cy = $y + 2.54;
+                       #print qq{<polygon points="$x,$y $cx,$y $x,$cy $x,$y" stroke="$fg" stroke-width="0.25" fill="$bg" />};
+                       #print qq{<polygon points="$x,$cy $cx,$cy $cx,$y $x,$cy" stroke="$bg" stroke-width="0.25" fill="$fg" />};
+                       print qq{<rect x="$x" y="$y" width="$w" height="2.54" stroke="$fg" stroke-width="0.3" fill="$bg" />};
+                       my ( $fg, $bg ) = @{ $cols->{txt} };
+                       print qq{<rect x="$x" y="$y" width="$w" height="2.54" rx="1" ry="1" stroke="$fg" stroke-width="0.3" fill="$bg" />};
+               } else {
+                       rect $x,$y,$col,$fg;
+               }
+               return qq{ style="fill:$bg"};
+       }
+
+       if ( $name =~ m/(VCC|3V3|3.3V)/i ) {
+               my ($fg,$bg) = @{ $cols->{vcc} };
+               rect $x,$y,$col,$bg;
+               return qq{ style="fill:$fg"};
+       } elsif ( $name =~ m/(G(ND|Round)|VSS)/i ) {
+               my ($fg,$bg) = @{ $cols->{gnd} };
+               rect $x,$y,$col,$bg;
+               return qq{ style="fill:$fg"};
+       } elsif ( $name =~ m/\[(\w+)\d\]/ ) { # kernel
+               my $dev = $1;
+               if ( my ($fg,$bg) = @{ $cols->{$dev} } ) {
+                       rect $x,$y,$col,$bg;
+                       return qq{ style="fill:$fg"};
+               }
+       } else {
+               my ( $fg, $bg ) = @{ $cols->{txt} };
+               rect $x,$y,$col,$bg;
+               #return qq{ style="fill:$fg"};
+               return '';
+       }
+}
+
+my $alt_col = 0;
+
+my @cols_order = ( 0,1,2,3 );
+my @cols_align = ( '','-','','-' ); # sprintf prefix
+
+@cols_order = ( 0,1,3,2 ); # pins outside on the right
+@cols_align = ( '','-','-','' );
+
+foreach my $i ( 0 .. $#line_parts ) {
+       $i = $#line_parts - $i if $opt_vertical;
+       my $line = $line_parts[$i];
+
+       my $pin_color = $alt_col ? '#cccccc' : '#444444';
+       $alt_col = ! $alt_col;
+
+       if ( $opt_svg ) {
+
+               my ($fg,$bg) = @{ $cols->{txt} };
+               my $tspan = qq{<tspan x="$x" y="$y" style="line-height:2.54;fill-opacity:1;fill:$fg;stroke:none;">};
+
+               my $x_pos = $x;
+               foreach my $i ( @cols_order ) {
+                       next unless $line->[$i];
+                       $tspan .= qq{<tspan x="$x_pos"}.svg_style($line->[$i],$x_pos,$y,$i).sprintf( '>%' . $cols_align[$i] . $max_len[$i] . 's</tspan>', $line->[$i]);
+                       $x_pos += $max_len[$i] * $font_w;
+               }
+
+               $tspan .= qq{</tspan>};
+               push @later,sprintf $tspan, @$line;
+               $y += 2.54;
+
+               # swap pin colors for line stripes
+               foreach my $swap (qw( pins txt )) {
+                       my ( $c1, $c2 ) = @{ $cols->{$swap} };
+                       $cols->{$swap} = [ $c2, $c1 ];
+               };
+
        } else {
-               push @$line, '' while ($#$line < 3); # fill-in single row header
-               printf $fmt, @$line;
+
+               if ( $#$line == 0 ) {
+                       print $line->[0], "\n";
+               } else {
+                       push @$line, '' while ($#$line < 3); # fill-in single row header
+                       printf $fmt, @$line;
+               }
+
        }
 }
 
+if ( $opt_svg ) {
+       print qq{
+    <text
+       id="text4506"
+       y="$x"
+       x="$y"
+       style="font-size:2.34px;line-height:2.54px;font-family:'Andale Mono';fill-opacity:1;stroke:none;stroke-width:0.10;stroke-opacity:1"
+       xml:space="preserve">
+
+       }; #svg
+
+       print @later, qq{
+</text>
+</g>
+</svg>
+       }; #svg
+
+}
+
 __DATA__
 # Cubietech Cubieboard2
 ## U14 (Next to SATA connector)
@@ -103,8 +287,8 @@ __DATA__
 36     XN_TP (TP-X2)                           35      YN_TP (TP-Y2)
 34     XP_TP (TP-X1)                           33      YP_TP (TP-Y1)
 32     PD25 (LCDDE)                            31      PB2 (PWM0)
-30     PD26 (LCDHSYNC)-VGA-HSYNC               29      PD24 (LCDCLK)
-28     PD23 (LCDD23)                           27      PD27 (LCDVSYNC)-VGA-VSYNC
+30     PD26 (LCDHSYNC/VGA-HSYNC)               29      PD24 (LCDCLK)
+28     PD23 (LCDD23)                           27      PD27 (LCDVSYNC/VGA-VSYNC)
 26     PD21 (LCDD21)                           25      PD22 (LCDD22)
 24     PD19 (LCDD19/LVDS1N3)                   23      PD20 (LCDD20)
 22     PD17 (LCDD17/LVDS1NC)                   21      PD18 (LCDD18/LVDS1P3)
@@ -128,7 +312,7 @@ __DATA__
 7      PB19 (TWI1-SDA)                         8       PG3 (CSI1-VSYNC/SDC1-D1)
 9      PG2 (CSI1-HSYNC/SDC1-D0)                10      PG1 (CSI1-MCLK/SDC1-CLK)
 11     PG4 (CSI1-D0/SDC1-D2)                   12      PG5 (CSI1-D1/SDC1-D3)
-13     PG6 (CSI1-D2/UART3-TX)                  14      PG7 (CSI1-D3/UART3-RX
+13     PG6 (CSI1-D2/UART3-TX)                  14      PG7 (CSI1-D3/UART3-RX)
 15     PG8 (CSI1-D4/UART3-RTS)                 16      PG9 (CSI1-D5/UART3-CTS)
 17     PG10 (CSI1-D6/UART4-TX)                 18      PG11 (CSI1-D7/UART4-RX)
 19     Ground                                  20      Ground
@@ -149,6 +333,13 @@ __DATA__
 45     HPL                                     46      PE10 (CSI0-D6)
 47     HPR                                     48      PE11 (CSI0-D7)
 
+## DEBUG serial (middle of board)
+4      PB22 (UART0-TX)
+3      PB23 (UART0-RX)
+2      VCC-3V3
+1      GND
+
+
 # Lamobo R1
 ## CON3 rpi DIP26-254
 1      3.3v                    2       5v