use pinctrl-maps to support 3.10 kernel uart ttys
[linux-gpio-pinout] / gpio.pl
diff --git a/gpio.pl b/gpio.pl
index 429982b..99134ac 100755 (executable)
--- a/gpio.pl
+++ b/gpio.pl
@@ -15,6 +15,8 @@ my $opt_middle = 0;
 my $opt_zebra = 0;
 my $opt_lines = 0;
 my $opt_read = '';
+my $opt_pins = '';
+my $opt_color = 0;
 GetOptions(
        'svg!' => \$opt_svg,
        'alt!' => \$opt_alt,
@@ -26,6 +28,8 @@ GetOptions(
        'zebra!' => \$opt_zebra,
        'lines!' => \$opt_lines,
        'read=s' => \$opt_read,
+       'pins=s' => \$opt_pins,
+       'color' => \$opt_color,
 );
 
 # svg font hints
@@ -46,6 +50,8 @@ my $model = slurp('/proc/device-tree/model');
 $model =~ s/\x00$//; # strip kernel NULL
 warn "# model [$model]";
 
+open(DATA, '<', $opt_pins) if $opt_pins;
+
 my @lines;
 my $line_i = 0;
 
@@ -59,7 +65,7 @@ while(<DATA>) {
                } else {
                        $include = 0;
                }
-       } elsif ( $include ) {
+       } elsif ( $include || $opt_pins ) {
                push @{ $pins->{$1} }, $line_i while ( m/\t(\w+\d+)/g );
 
                push @lines, $_;
@@ -72,38 +78,67 @@ 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 "# lines ",dump( \@lines );
 warn "# pins ",dump($pins);
 
+my $serial_tty;
+foreach (
+       glob($opt_read . '/sys/devices/platform/soc*/*.serial/tty/tty*'),       # 4.x
+       glob(            '/sys/devices/soc.*/*.uart/tty/tty*')                  # 3.10
+) {
+       my @v = split(/\//, $_);
+       $serial_tty->{ $v[-3] } = $v[-1];
+}
+warn "# serial_tty = ",dump($serial_tty);
+
+
 my $pin_function;
 my $device;
+my $pin;
+my $function;
 
-open(my $fh, '<', $opt_read . '/sys/kernel/debug/pinctrl/pinctrl-handles');
+open(my $fh, '<', $opt_read . '/sys/kernel/debug/pinctrl/pinctrl-maps');
 while(<$fh>) {
        chomp;
-       if ( m/device: (\S+)/ ) {
+       if ( m/^device (\S+)/ ) {
                $device = $1;
-               $device =~ s/^[0-9a-f]*\.//; # remove hex address
-       } elsif ( m/group: (\w+\d+)\s.+function: (\S+)/ ) {
-               my ($pin, $function) = ($1,$2);
-               $pin_function->{$pin} = "$device $function";
-
-               if ( $pins->{$pin} ) {
-                       foreach my $line ( @{$pins->{$pin}} ) {
-                               my $t = $lines[$line];
-                               if ( $opt_svg ) {
-                                       $t =~ s/$pin/[$device $function]/;
-                               } else {
-                                       $t =~ s/$pin/$pin [$device $function]/ || die "can't find $pin in [$t]";
+               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+)/ ) {
+               $pin = $1;
+
+       } elsif ( m/^function (\S+)/ ) {
+               $function = $1;
+       } elsif ( m/^$/ ) {
+               if ( $device && $pin && $function ) {
+                       push @{ $pin_function->{$pin} }, "$device $function";
+
+                       if ( $pins->{$pin} ) {
+                               foreach my $line ( @{$pins->{$pin}} ) {
+                                       my $t = $lines[$line];
+                                       if ( $opt_svg ) {
+                                               $t =~ s/$pin/[$device $function]/;
+                                       } else {
+                                               $t =~ s/$pin/$pin [$device $function]/ || warn "can't find $pin in [$t]";
+                                       }
+                                       $lines[$line] = $t;
+                                       warn "# $line: $lines[$line]\n";
                                }
-                               $lines[$line] = $t;
-                               warn "# $line: $lines[$line]\n";
+                       } else {
+                               warn "IGNORED: pin $pin function $function\n";
                        }
+
                } else {
-                       warn "IGNORED: pin $pin function $function\n";
+                       warn "missing one of ",dump( $device, $pin, $function );
                }
+
+               $device = undef;
+               $pin = undef;
+               $function = undef;
+
        }
 }
 
@@ -111,12 +146,17 @@ warn "# pin_function = ",dump($pin_function);
 
 my @max_len = ( 0,0,0,0 );
 my @line_parts;
+
+shift(@lines) while ( ! $lines[0] );   # remove empty at beginning
+pop(@lines) while ( ! $lines[-1] );    # remove empty at end
+
 foreach my $line (@lines) {
        if ( $line =~ m/^#/ ) {
-               push @line_parts, [ $line ] unless $opt_svg;
+               push @line_parts, [ $line ] unless $opt_svg && $line =~ m/^###+/; # SVG doesn't display 3rd level comments
                next;
        }
-       $line =~ s/(\[(?:uart|serial))([^\t]*\]\s[^\t]*(rx|tx)d?)/$1 $3$2/gi;
+       $line =~ s/\[(\w+)\s+(\w+)\] \[\1\s+(\w+)\]/[$1 $2 $3]/g; # compress kernel annotation with same prefix
+       $line =~ s/(\[(?:uart\d*|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;
@@ -125,8 +165,10 @@ foreach my $line (@lines) {
        $line =~ s/\[serial (\w+) (uart\d+)\]/[$2 $1]/g;
        $line =~ s/\[(\w+) (\w+) \1(\d+)\]/[$1$3 $2]/g;
 
+       $line =~ s/\[(\w+)\s+([^\]]+)\s+\1\]/[$1 $2]/g; # duplicate
+
        my @v = split(/\s*\t+\s*/,$line,4);
-       @v = ( $v[2], $v[3], $v[0], $v[1] ) if $opt_horizontal;
+       @v = ( $v[2], $v[3], $v[0], $v[1] ) if $opt_horizontal && $v[2];
 
        push @line_parts, [ @v ];
        foreach my $i ( 0 .. 3 ) {
@@ -192,6 +234,9 @@ swap_cols 'txt' if $opt_invert;
 
 sub svg_style {
        my ($name,$x,$y,$col) = @_;
+
+       return '' unless $opt_color;
+
        $y -= $font_b; # shift box overlay to right vertical position based on font baseline
 
        sub rect {
@@ -229,6 +274,7 @@ sub svg_style {
        } elsif ( $name =~ m/\[(\w+)/ ) { # kernel
                my $dev = $1;
                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"};
@@ -287,10 +333,10 @@ sub cut_mark {
        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;
+#cut_mark $x, $y;
 my $max_x = $x;
 $max_x += $max_len[$_] * $font_w foreach ( 0 .. 3 );
-cut_mark $max_x, $y;
+#cut_mark $max_x, $y;
 
 sub line {
        my ($x,$y,$max_x) = @_;
@@ -306,7 +352,10 @@ foreach my $i ( 0 .. $#line_parts ) {
 
        if ( $opt_svg ) {
 
-               if ( ! exists $line->[0] ) {
+               # not a minimal two column pin description
+               if ( ! exists $line->[1] ) {
+                       $last_cut_mark = 1 if $line->[0] =~ m/^##/; # skip comments
+
                        # before first empty line
                        if ( $last_cut_mark == 0 ) {
                                cut_mark $x, $y;
@@ -333,19 +382,31 @@ foreach my $i ( 0 .. $#line_parts ) {
                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->[$order],$x_pos,$y,$i).sprintf( '>%' . $cols_align[$i] . $max_len[$i] . 's</tspan>', $line->[$order]);
-                       $x_pos += $max_len[$i] * $font_w;
+                       my $len = $max_len[$i];
+                       my $x2 = $x_pos + ( $len * $font_w ) / 2;
+                       # is this comment?
+                       if ( $#$line == 0 && $line->[$order] =~ s/^#+s*// ) {
+                               # comment, center over whole width
+                               $len = length($line->[$order]);
+                               $x2 = $x + (($max_x-$x)/2); # middle
+                               $tspan .= qq{\t<tspan x="$x2" text-anchor="$text_anchor"}.sprintf( '>%' . $cols_align[$i] . $len . 's</tspan>', $line->[0]);
+                       } else {
+                               $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]);
+                       }
+                       $x_pos += $len * $font_w;
                }
 
-               $tspan .= qq{</tspan>\n};
+               $tspan .= qq{\n</tspan>\n};
                push @later,sprintf $tspan, @$line;
                $y += 2.54;
 
                # swap pin colors for line stripe
                if ( $opt_zebra ) {
                        swap_cols $_ foreach qw( pins txt );
+               } else {
+                       swap_cols 'pins';
                }
 
        } else {