don't flip 1-pin horizontally
[linux-gpio-pinout] / gpio.pl
diff --git a/gpio.pl b/gpio.pl
index a2895c1..9c59299 100755 (executable)
--- a/gpio.pl
+++ b/gpio.pl
@@ -5,25 +5,37 @@ 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;
+my $opt_svg = 0;
+my $opt_alt = 0;
+my $opt_invert = 0;
+my $opt_vertical = 0;
+my $opt_horizontal = 0;
+my $opt_edge = 0;
+my $opt_middle = 0;
+my $opt_zebra = 0;
+my $opt_lines = 0;
+my $opt_read = '';
 GetOptions(
        'svg!' => \$opt_svg,
        'alt!' => \$opt_alt,
        'invert!' => \$opt_invert,
-       'vertical!' => \$opt_vertical,
-       'kernel!' => \$opt_kernel,
+       'vertical-flip!' => \$opt_vertical,
+       'horizontal-flip!' => \$opt_horizontal,
+       'edge-pins!' => \$opt_edge,
+       'middle-pins!' => \$opt_middle,
+       'zebra!' => \$opt_zebra,
+       'lines!' => \$opt_lines,
+       'read=s' => \$opt_read,
 );
 
 # svg font hints
 my $font_w = 1.67; # < 2.54, font is not perfect square
 my $font_b = 2.10; # font baseline position
 
+$opt_read .= '/' unless $opt_read =~ m/\/$/;
+
 sub slurp {
-       open(my $fh, '<', shift);
+       open(my $fh, '<', $opt_read . shift);
        local $/ = undef;
        <$fh>;
 }
@@ -40,12 +52,15 @@ my $line_i = 0;
 my $include = 0;
 while(<DATA>) {
        chomp;
-       if ( m/^#\s*$model/ ) {
-               $include = 1;
-       } elsif ( m/^#\s+/ ) {
-               $include = 0;
+       if ( m/^#\s(.+)/ ) {
+               warn "MODEL [$1] == [$model] ?\n";
+               if ( $model =~ m/$1/ ) {
+                       $include = 1;
+               } else {
+                       $include = 0;
+               }
        } elsif ( $include ) {
-               push @{ $pins->{$1} }, $line_i while ( m/\t(P\w\d+)/g );
+               push @{ $pins->{$1} }, $line_i while ( m/\t(\w+\d+)/g );
 
                push @lines, $_;
 
@@ -57,27 +72,43 @@ while(<DATA>) {
 
 die "add pin definition for # $model" unless $pins;
 
+shift(@lines) while ( ! $lines[0] );   # remove empty at beginning
+pop(@lines) while ( ! $lines[-1] );    # remove empty at end
+
 warn "# pins ",dump($pins);
 
+my $serial_tty;
+foreach ( glob $opt_read . '/sys//devices/platform/soc*/*.serial/tty/tty*' ) {
+       my @v = split(/\//, $_);
+       $serial_tty->{ $v[-3] } = $v[-1];
+}
+warn "# serial_tty = ",dump($serial_tty);
+
+
 my $pin_function;
+my $device;
 
-open(my $fh, '<', '/sys/kernel/debug/pinctrl/pinctrl-handles');
+open(my $fh, '<', $opt_read . '/sys/kernel/debug/pinctrl/pinctrl-handles');
 while(<$fh>) {
        chomp;
-       if ( m/group: (P\w\d+)\s.+function: (\S+)/ ) {
+       if ( m/device: (\S+)/ ) {
+               $device = $1;
+               if ( my $replace = $serial_tty->{$device} ) {
+                       $device = $replace; # replace serial hex with kernel name
+               } else {
+                       $device =~ s/^[0-9a-f]*\.//; # remove hex address
+               }
+       } elsif ( m/group: (\w+\d+)\s.+function: (\S+)/ ) {
                my ($pin, $function) = ($1,$2);
-               $pin_function->{$pin} = $function;
-
-               next unless $opt_kernel;
+               $pin_function->{$pin} = "$device $function";
 
                if ( $pins->{$pin} ) {
                        foreach my $line ( @{$pins->{$pin}} ) {
-warn "XXX $pin $line";
                                my $t = $lines[$line];
                                if ( $opt_svg ) {
-                                       $t =~ s/$pin/[$function]/;
+                                       $t =~ s/$pin/[$device $function]/;
                                } else {
-                                       $t =~ s/$pin/$pin [$function]/ || die "can't find $pin in [$t]";
+                                       $t =~ s/$pin/$pin [$device $function]/ || die "can't find $pin in [$t]";
                                }
                                $lines[$line] = $t;
                                warn "# $line: $lines[$line]\n";
@@ -88,6 +119,8 @@ warn "XXX $pin $line";
        }
 }
 
+warn "# pin_function = ",dump($pin_function);
+
 my @max_len = ( 0,0,0,0 );
 my @line_parts;
 foreach my $line (@lines) {
@@ -95,12 +128,18 @@ foreach my $line (@lines) {
                push @line_parts, [ $line ] unless $opt_svg;
                next;
        }
-       $line =~ s/(\[uart\d)(\]\s[^\t]*(rx|tx))/$1 $3$2/gi;
-       $line =~ s/(\[i2c\d)(\]\s[^\t]*(sck|sda))/$1 $3$2/gi;
-       $line =~ s/(\[spi\d)(\]\s[^\t]*(miso|mosi|clk|cs))/$1 $3$2/gi;
+       $line =~ s/(\[(?:uart|serial|tty\w+))([^\t]*\]\s[^\t]*(rx|tx)d?)/$1 $3$2/gi;
+       $line =~ s/(\[i2c)([^\t]*\]\s[^\t]*(scl?k?|sda))/$1 $3$2/gi;
+       $line =~ s/(\[spi)([^\t]*\]\s[^\t]*(miso|mosi|s?clk|c[se]\d*))/$1 $3$2/gi;
        $line =~ s/\s*\([^\)]+\)//g if ! $opt_alt;
 
+       # shorten duplicate kernel device/function
+       $line =~ s/\[serial (\w+) (uart\d+)\]/[$2 $1]/g;
+       $line =~ s/\[(\w+) (\w+) \1(\d+)\]/[$1$3 $2]/g;
+
        my @v = split(/\s*\t+\s*/,$line,4);
+       @v = ( $v[2], $v[3], $v[0], $v[1] ) if $opt_horizontal && $v[2];
+
        push @line_parts, [ @v ];
        foreach my $i ( 0 .. 3 ) {
                next unless exists $v[$i];
@@ -115,10 +154,8 @@ warn "# line_parts = ",dump( \@line_parts );
 
 #print "$_\n" foreach @lines;
 
-my $fmt = "%$max_len[0]s %-$max_len[1]s %$max_len[2]s %-$max_len[3]s\n";
-
-my $x = 30.00; # mm
-my $y = 30.00; # mm
+my $x = 20.00; # mm
+my $y = 20.00; # mm
 
 if ( $opt_svg ) {
        print qq{<?xml version="1.0" encoding="UTF-8" standalone="no"?>
@@ -151,7 +188,7 @@ my $cols = {        # foreground background
        vcc  => [ '#ff0000', '#ffff00' ],
        gnd  => [ '#000000', '#00ffff' ],
        i2c  => [ '#008800', '#ffcccc' ],
-       uart => [ '#000088', '#ccffcc' ],
+       serial=>[ '#000088', '#ccffcc' ],
        spi  => [ '#880000', '#ccccff' ],
 };
 
@@ -171,7 +208,7 @@ sub svg_style {
 
        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;stroke:#ffffff;stroke-width:0.10" />\n};
+               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};
 
        }
 
@@ -193,20 +230,21 @@ sub svg_style {
                return qq{ style="fill:$bg"};
        }
 
-       if ( $name =~ m/(VCC|3V3|3.3V)/i ) {
+       if ( $name =~ m/(VCC|3V3|3.3V|5v)/i ) {
                my ($fg,$bg) = @{ $cols->{vcc} };
                rect $x,$y,$col,$bg;
                return qq{ style="fill:$fg"};
-       } elsif ( $name =~ m/(G(ND|Round)|VSS)/i ) {
+       } elsif ( $name =~ m/(G(ND|Round)|VSS|0v)/i ) {
                my ($fg,$bg) = @{ $cols->{gnd} };
                rect $x,$y,$col,$bg;
                return qq{ style="fill:$fg"};
-       } elsif ( $name =~ m/\[(\w+)\d/ ) { # kernel
+       } elsif ( $name =~ m/\[(\w+)/ ) { # kernel
                my $dev = $1;
-               if ( my ($fg,$bg) = @{ $cols->{$dev} } ) {
-                       rect $x,$y,$col,$bg;
-                       return qq{ style="fill:$fg"};
-               }
+               my ($fg,$bg) = @{ $cols->{txt} };
+               $dev = 'serial' if $dev =~ m/^tty/;
+               ($fg,$bg) = @{ $cols->{$dev} } if exists $cols->{$dev};
+               rect $x,$y,$col,$bg;
+               return qq{ style="fill:$fg"};
        } else {
                my ( $fg, $bg ) = @{ $cols->{txt} };
                rect $x,$y,$col,$bg;
@@ -220,8 +258,35 @@ 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 = ( '','-','-','' );
+my @cols_shuffle = @cols_order;
+
+if ( $opt_edge ) {
+       # pins outside on the right
+       @cols_shuffle = ( 0,1,3,2 ) if $opt_edge;
+       @cols_align = ( '-','-','','' );
+} elsif ( $opt_middle ) {
+       # pins in middle
+       @cols_shuffle = ( 1,0,2,3 );
+       @cols_align = ( '','','-','-' );
+}
+
+sub cols_shuffle {
+       my ( $what, $order ) = @_;
+       my $new = [];
+       foreach my $i ( 0 .. $#$what ) {
+               $new->[$i] = $what->[ $order->[$i] ];
+       }
+       warn "# cols_shuffle what=",dump($what)," order=",dump($order)," new=",dump($new);
+       return @$new;
+}
+
+@cols_order = cols_shuffle( \@cols_order, \@cols_shuffle );
+@max_len    = cols_shuffle( \@max_len,    \@cols_shuffle );
+
+warn "# cols_order = ",dump( \@cols_order );
+warn "# cols_align = ",dump( \@cols_align );
+
+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";
 
 
 # cut marks
@@ -231,20 +296,26 @@ my $line_fmt = qq{<line x1="%s" y1="%s" x2="%s" y2="%s" style="stroke:$fg;stroke
 my @cut_marks;
 sub cut_mark {
        my ($x,$y) = @_;
-       push @cut_marks, printf($line_fmt, $x-5, $y-$font_b,   $x+5, $y-$font_b);
-       push @cut_marks, printf($line_fmt, $x,   $y-$font_b-5, $x,   $y-$font_b+5);
+       return unless $opt_svg;
+       push @cut_marks, sprintf($line_fmt, $x-5, $y-$font_b,   $x+5, $y-$font_b);
+       push @cut_marks, sprintf($line_fmt, $x,   $y-$font_b-5, $x,   $y-$font_b+5);
 }
 cut_mark $x, $y;
 my $max_x = $x;
 $max_x += $max_len[$_] * $font_w foreach ( 0 .. 3 );
 cut_mark $max_x, $y;
 
+sub line {
+       my ($x,$y,$max_x) = @_;
+       push @cut_marks, sprintf($line_fmt, $x, $y-$font_b, $max_x, $y-$font_b);
+}
+
+
 my $last_cut_mark = 0;
 
 foreach my $i ( 0 .. $#line_parts ) {
        $i = $#line_parts - $i if $opt_vertical;
        my $line = $line_parts[$i];
-       warn "# LINE ",dump($line);
 
        if ( $opt_svg ) {
 
@@ -254,6 +325,7 @@ foreach my $i ( 0 .. $#line_parts ) {
                                cut_mark $x, $y;
                                cut_mark $max_x, $y;
                                $last_cut_mark = 1;
+                               line $x, $y, $max_x if $opt_lines;
                                $y += 15; # make spacing between pinouts
                        }
                } elsif ( $last_cut_mark ) {
@@ -262,18 +334,21 @@ foreach my $i ( 0 .. $#line_parts ) {
                        cut_mark $max_x, $y;
                        $last_cut_mark = 0;
                } else {
-                       warn "CUTMARK no magic";
+                       #warn "CUTMARK no magic";
                }
 
+               line $x, $y, $max_x if $opt_lines && exists $line->[1];
+
                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;">\n};
+               my $tspan = qq{<tspan x="$x" y="$y" style="line-height:2.54;fill:$fg;stroke:none;">\n};
 
                my $x_pos = $x;
-               foreach my $i ( @cols_order ) {
-                       next unless $line->[$i];
+               foreach my $i ( 0 .. $#cols_order ) {
+                       my $order = $cols_order[$i];
+                       next unless $line->[$order];
                        my $text_anchor = 'middle';
                        my $x2 = $x_pos + ( $max_len[$i] * $font_w ) / 2;
-                       $tspan .= qq{<tspan x="$x2" text-anchor="$text_anchor"}.svg_style($line->[$i],$x_pos,$y,$i).sprintf( '>%' . $cols_align[$i] . $max_len[$i] . 's</tspan>', $line->[$i]);
+                       $tspan .= qq{<tspan x="$x2" text-anchor="$text_anchor"}.svg_style($line->[$order],$x_pos,$y,$i).sprintf( '>%' . $cols_align[$i] . $max_len[$i] . 's</tspan>', $line->[$order]);
                        $x_pos += $max_len[$i] * $font_w;
                }
 
@@ -281,8 +356,10 @@ foreach my $i ( 0 .. $#line_parts ) {
                push @later,sprintf $tspan, @$line;
                $y += 2.54;
 
-               # swap pin colors for line stripes
-               swap_cols $_ foreach qw( pins txt );
+               # swap pin colors for line stripe
+               if ( $opt_zebra ) {
+                       swap_cols $_ foreach qw( pins txt );
+               }
 
        } else {
 
@@ -290,33 +367,33 @@ foreach my $i ( 0 .. $#line_parts ) {
                        print $line->[0], "\n";
                } else {
                        push @$line, '' while ($#$line < 3); # fill-in single row header
-                       printf $fmt, @$line;
+                       printf $fmt, map { $line->[$_] } @cols_order;
                }
 
        }
 }
 
 if ( $opt_svg ) {
+       cut_mark $x,$y;
+       cut_mark $max_x,$y;
+       line $x, $y, $max_x if $opt_lines;
+
        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-opacity:1"
+       style="font-size:2.34px;line-height:2.54px;font-family:'Andale Mono';stroke:none"
        xml:space="preserve">
 
        }; #svg
 
-       print @later, @cut_marks, qq{
-</text>
-</g>
-</svg>
-       }; #svg
+       print @later, qq{</text>\n}, @cut_marks, qq{</g>\n</svg>};
 
 }
 
 __DATA__
-# Cubietech Cubieboard2
+# Cubietech Cubieboard
 ## U14 (Next to SATA connector)
 ###    SPI0
 48     PI13 (SPI0-MISO/UART6-RX/EINT25)        47      PI11 (SPI0-CLK/UART5-RX/EINT23)
@@ -345,7 +422,6 @@ __DATA__
 4      PD1 (LCDD1/LVDS0N0)                     3       PD2 (LCDD2/LVDS0P1)
 2      Ground                                  1       PD0 (LCDD0/LVDSP0)
 
-# Cubietech Cubieboard2
 ## U15 (Between Ethernet port and USB ports)
 ### CSI1/TS
 1      VCC-5V                                  2       PH15 (CSI1-PWR/EINT15)
@@ -407,3 +483,27 @@ __DATA__
 6      PI20 UART7_TX           5       PH3
 4      PI21 UART7_RX           3       PH5
 2      3V3                     1       SATA-5V
+
+# Raspberry Pi
+1      3.3v                    2       5v
+3      gpio2 (SDA.1)           4       5v
+5      gpio3 (SCL.1)           6       0v
+7      gpio4 (WPi 7)           8       gpio14  (TxD)
+9      0v                      10      gpio15  (RxD)
+11     gpio17 (WPi 0)          12      gpio18  (WPi 1)
+13     gpio27 (WPi 2)          14      0v
+15     gpio22 (WPi 3)          16      gpio23  (WPi 4)
+17     3.3v                    18      gpio24  (WPi 5)
+19     gpio10 (MOSI)           20      0v
+21     gpio9 (MISO)            22      gpio25  (WPi 6) 
+23     gpio11 (SCLK)           24      gpio8   (CE0)
+25     0v                      26      gpio7   (CE1)
+# Raspberry Pi 3 Model B Rev 1.2
+27     gpio0 (SDA.0)           28      gpio1   (SCL.0)
+29     gpio5 (WPi 21)          30      0v
+31     gpio6 (WPi 22)          32      gpio12  (WPi 26)
+33     gpio13 (WPi 23)         34      0v
+35     gpio19 (WPi 24)         36      gpio16  (WPi 27)
+37     gpio26 (WPi 25)         38      gpio20  (WPi 28)
+39     0v                      40      gpio21  (WPi 29)
+