git.rot13.org Git - linux-gpio-pinout/blob - gpio.pl

   1 #!/usr/bin/perl
   2 use warnings;
   3 use strict;
   4 use autodie;
   5 use Data::Dump qw(dump);
   6 use Getopt::Long;
   7
   8 my $opt_svg = 0;
   9 my $opt_alt = 0;
  10 my $opt_invert = 0;
  11 my $opt_vertical = 0;
  12 my $opt_horizontal = 0;
  13 my $opt_edge = 0;
  14 my $opt_middle = 0;
  15 my $opt_zebra = 0;
  16 my $opt_lines = 0;
  17 my $opt_read = '';
  18 my $opt_pins = '';
  19 my $opt_color = 0;
  20 my $opt_pinmux = 0;
  21 GetOptions(
  22         'svg!' => \$opt_svg,
  23         'alt!' => \$opt_alt,
  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,
  35 );
  36
  37 # svg font hints
  38 my $font_w = 1.67; # < 2.54, font is not perfect square
  39 my $font_b = 2.10; # font baseline position
  40
  41 $opt_read .= '/' unless $opt_read =~ m/\/$/;
  42
  43 sub slurp {
  44         open(my $fh, '<', $opt_read . shift);
  45         local $/ = undef;
  46         <$fh>;
  47 }
  48
  49 my $pins;
  50
  51 my $model = slurp('/proc/device-tree/model');
  52 $model =~ s/\x00$//; # strip kernel NULL
  53 warn "# model [$model]";
  54
  55 OPEN_PINS_AGAIN:
  56 open(DATA, '<', $opt_pins) if $opt_pins;
  57
  58 my @lines;
  59 my $line_i = 0;
  60
  61 my $include = 0;
  62 while(<DATA>) {
  63         chomp;
  64         if ( m/^#\s(.+)/ ) {
  65                 warn "MODEL [$1] == [$model] ?\n";
  66                 if ( $model =~ m/$1/ ) {
  67                         $include = 1;
  68                 } else {
  69                         $include = 0;
  70                 }
  71         } elsif ( $include || $opt_pins ) {
  72                 push @{ $pins->{$1} }, $line_i while ( m/\t\s*(\w+\d+)/g );
  73
  74                 push @lines, $_;
  75
  76                 $line_i++;
  77         } else {
  78                 warn "IGNORE: [$_]\n";
  79         }
  80 }
  81
  82 if ( ! $opt_pins && ! $pins ) {
  83         my $glob = $model;
  84         $glob =~ s/^(\w+).*$/$1/;
  85         my @pins = glob "pins/${glob}*";
  86         warn "# possible pins: ",dump( \@pins );
  87         $opt_pins = $pins[0];
  88         goto OPEN_PINS_AGAIN;
  89 }
  90
  91 die "add pin definition for # $model" unless $pins;
  92
  93 #warn "# lines ",dump( \@lines );
  94 warn "# pins ",dump($pins);
  95
  96 my $serial_tty;
  97 foreach (
  98         glob($opt_read . '/sys/devices/platform/soc*/*.serial/tty/tty*'),       # 4.x
  99         glob(            '/sys/devices/soc.*/*.uart/tty/tty*')                  # 3.10
 100 ) {
 101         my @v = split(/\//, $_);
 102         $serial_tty->{ $v[-3] } = $v[-1];
 103 }
 104 warn "# serial_tty = ",dump($serial_tty);
 105
 106
 107 my $pin_function;
 108 my $device;
 109 my $pin;
 110 my $function;
 111
 112 sub annotate_pin {
 113         my ($pin, $note) = @_;
 114         if ( $pins->{$pin} ) {
 115                 foreach my $line ( @{$pins->{$pin}} ) {
 116                         my $t = $lines[$line];
 117                         if ( $opt_svg ) {
 118                                 $t =~ s/$pin/$note/;
 119                         } else {
 120                                 $t =~ s/$pin/$pin $note/ || warn "can't find $pin in [$t]";
 121                         }
 122                         $lines[$line] = $t;
 123                         warn "# $line: $lines[$line]\n";
 124                 }
 125         } else {
 126                 warn "IGNORED: pin $pin function $note\n";
 127         }
 128 }
 129
 130 open(my $fh, '<', $opt_read . '/sys/kernel/debug/pinctrl/pinctrl-maps');
 131 while(<$fh>) {
 132         chomp;
 133         if ( m/^device (\S+)/ ) {
 134                 $device = $1;
 135                 if ( my $replace = $serial_tty->{$device} ) {
 136                         $device = $replace; # replace serial hex with kernel name
 137                 } else {
 138                         $device =~ s/^[0-9a-f]*\.//; # remove hex address
 139                 }
 140         } elsif ( m/^group (\w+\d+)/ ) {
 141                 $pin = $1;
 142
 143         } elsif ( m/^function (\S+)/ ) {
 144                 $function = $1;
 145         } elsif ( m/^$/ ) {
 146                 if ( $device && $pin && $function ) {
 147                         push @{ $pin_function->{$pin} }, "$device $function";
 148
 149                         annotate_pin $pin, "[$device $function]";
 150                 } else {
 151                         warn "missing one of ",dump( $device, $pin, $function );
 152                 }
 153
 154                 $device = undef;
 155                 $pin = undef;
 156                 $function = undef;
 157
 158         }
 159 }
 160
 161 warn "# pin_function = ",dump($pin_function);
 162
 163
 164 # insert kernel gpio info
 165 my $linux_gpio_name;
 166 open(my $pins_fh, '<', (glob "/sys/kernel/debug/pinctrl/*/pins")[0]);
 167 while(<$pins_fh>) {
 168         if ( m/^pin (\d+) \(([^\)]+)\)/ ) {
 169                 $linux_gpio_name->{$1} = $2;
 170         }
 171 }
 172 warn "# linux_gpio_name = ",dump( $linux_gpio_name );
 173
 174
 175 my $gpio_debug;
 176 open(my $gpio_fh, '<', '/sys/kernel/debug/gpio');
 177 while(<$gpio_fh>) {
 178         if (m/|/ ) {
 179                 s/^\s+//;
 180                 s/\s+$//;
 181                 my @l = split(/\s*[\(\|\)]\s*/, $_);
 182                 warn "XXX ", dump( \@l );
 183                 if ( $l[0] =~ m/gpio-(\d+)/ ) {
 184                         my $pin = $linux_gpio_name->{$1} || die "can't find $1 in ",dump( $linux_gpio_name );
 185                         $gpio_debug->{ $pin } = $l[2];
 186                         $l[3] =~ s/\s\s+/ /g;
 187                         annotate_pin $pin, qq{"$l[2]" $l[3]};
 188                 }
 189         }
 190
 191 }
 192 warn "# gpio_debug = ",dump( $gpio_debug );
 193
 194
 195
 196 my $have_sunxi_pio = `which sunxi-pio`;
 197 if ( $have_sunxi_pio ) {
 198
 199 open(my $pio, '-|', 'sunxi-pio -m print');
 200 while(<$pio>) {
 201         chomp;
 202         s/[<>]+/ /g;
 203         my @p = split(/\s+/,$_);
 204         warn "# pio ",dump(\@p);
 205         # annotate input 0 and output 1 pins
 206 #       annotate_pin $p[0], ( $p[1] ? 'O' : 'I' ) . ':' . $p[4] if $p[1] == 0 || $p[1] == 1;
 207         my $pin = shift @p;
 208         annotate_pin $pin, join(' ',@p) if ! $opt_svg;
 209 }
 210 close($pio);
 211
 212 } # have_sunxi_pio
 213
 214
 215 my $pinmux;
 216 my $pinmux_path = (glob("/sys/kernel/debug/pinctrl/*/pinmux-functions"))[0];
 217 if ( $opt_pinmux && -e $pinmux_path ) {
 218         open(my $mux, '<', $pinmux_path);
 219         while(<$mux>) {
 220                 chomp;
 221                 if ( m/function: (\w+), groups = \[ (.*) \]/ ) {
 222                         my ( $func, $pins ) = ( $1, $2 );
 223                         foreach ( split(/\s+/,$pins) ) {
 224                                 push @{ $pinmux->{$_} }, $func;
 225                         }
 226                 } else {
 227                         warn "IGNORED [$pinmux_path] [$_]\n";
 228                 }
 229         }
 230
 231         foreach my $pin ( keys %$pinmux ) {
 232                 if ( exists $pins->{$pin} ) {
 233                         annotate_pin $pin, '{' . join(' ', @{$pinmux->{$pin}}) . '}';
 234                 } else {
 235                         warn "IGNORED mux on $pin\n";
 236                 }
 237         }
 238
 239         warn "# pinmux = ",dump( $pinmux );
 240 }
 241
 242
 243
 244 my @max_len = ( 0,0,0,0 );
 245 my @line_parts;
 246
 247 shift(@lines) while ( ! $lines[0] );    # remove empty at beginning
 248 pop(@lines) while ( ! $lines[-1] );     # remove empty at end
 249
 250 foreach my $line (@lines) {
 251         if ( $line =~ m/^#/ ) {
 252                 push @line_parts, [ $line ] unless $opt_svg && $line =~ m/^###+/; # SVG doesn't display 3rd level comments
 253                 next;
 254         }
 255         $line =~ s/\[(\w+)\s+(\w+)\] \[\1\s+(\w+)\]/[$1 $2 $3]/g; # compress kernel annotation with same prefix
 256         $line =~ s/(\[(?:uart\d*|serial|tty\w+))([^\t]*\]\s[^\t]*(rx|tx)d?)/$1 $3$2/gi;
 257         $line =~ s/(\[i2c)([^\t]*\]\s[^\t]*(scl?k?|sda))/$1 $3$2/gi;
 258         $line =~ s/(\[spi)([^\t]*\]\s[^\t]*(miso|mosi|s?clk|c[se]\d*))/$1 $3$2/gi;
 259         $line =~ s/\s*\([^\)]+\)//g if ! $opt_alt;
 260
 261         # shorten duplicate kernel device/function
 262         $line =~ s/\[serial (\w+) (uart\d+)\]/[$2 $1]/g;
 263         $line =~ s/\[(\w+) (\w+) \1(\d+)\]/[$1$3 $2]/g;
 264
 265         $line =~ s/\[(\w+)\s+([^\]]+)\s+\1\]/[$1 $2]/g; # duplicate
 266
 267         my @v = split(/\s*\t+\s*/,$line,4);
 268         @v = ( $v[2], $v[3], $v[0], $v[1] ) if $opt_horizontal && $v[2];
 269
 270         push @line_parts, [ @v ];
 271         foreach my $i ( 0 .. 3 ) {
 272                 next unless exists $v[$i];
 273                 next if $v[$i] =~ m/^#/; # don't calculate comments into max length
 274                 my $l = length($v[$i]);
 275                 $max_len[$i] = $l if $l > $max_len[$i];
 276         }
 277 }
 278
 279 warn "# max_len = ",dump( \@max_len );
 280 warn "# line_parts = ",dump( \@line_parts );
 281
 282 #print "$_\n" foreach @lines;
 283
 284 my $x = 20.00; # mm
 285 my $y = 20.00; # mm
 286
 287 if ( $opt_svg ) {
 288         print qq{<?xml version="1.0" encoding="UTF-8" standalone="no"?>
 289 <svg
 290    xmlns:dc="http://purl.org/dc/elements/1.1/"
 291    xmlns:cc="http://creativecommons.org/ns#"
 292    xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
 293    xmlns:svg="http://www.w3.org/2000/svg"
 294    xmlns="http://www.w3.org/2000/svg"
 295    xmlns:xlink="http://www.w3.org/1999/xlink"
 296    id="svg8"
 297    version="1.1"
 298    viewBox="0 0 210 297"
 299    height="297mm"
 300    width="210mm">
 301
 302
 303 <g id="layer1">
 304
 305         }; # svg, insert rest of rect
 306
 307         print qq{<rect x="0" y="0" width="210" height="297" style="fill:#000000" id="high-contrast"/>} if $opt_invert;
 308 }
 309
 310 my @later;
 311
 312 my $cols = {    # foreground background
 313         txt  => [ '#000000', '#ffffff' ],
 314         pins => [ '#ffffff', '#ff00ff' ],
 315         vcc  => [ '#ff0000', '#ffff00' ],
 316         gnd  => [ '#000000', '#00ffff' ],
 317         i2c  => [ '#008800', '#ffcccc' ],
 318         serial=>[ '#000088', '#ccffcc' ],
 319         spi  => [ '#880000', '#ccccff' ],
 320 };
 321
 322 sub swap_cols {
 323         my $swap = shift;
 324         die "$swap not found in ",dump($cols) unless $cols->{$swap};
 325         my ( $c1, $c2 ) = @{ $cols->{$swap} };
 326         $cols->{$swap} = [ $c2, $c1 ];
 327 }
 328
 329 swap_cols 'txt' if $opt_invert;
 330
 331
 332 sub svg_style {
 333         my ($name,$x,$y,$col) = @_;
 334
 335         return '' unless $opt_color;
 336
 337         $y -= $font_b; # shift box overlay to right vertical position based on font baseline
 338
 339         sub rect {
 340                 my ($x,$y,$col,$fill) = @_;
 341                 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};
 342
 343         }
 344
 345         if ( $name =~ m/^(\d+)$/ ) { # pins
 346                 my $pin = $1;
 347                 my ( $fg, $bg ) = @{ $cols->{pins} };
 348                 if ( $pin == 1 ) {
 349                         my $w  = $max_len[$col]*$font_w - 0.1;
 350                         my $cx = $x + $w;
 351                         my $cy = $y + 2.54;
 352                         #print qq{<polygon points="$x,$y $cx,$y $x,$cy $x,$y" stroke="$fg" stroke-width="0.25" fill="$bg" />};
 353                         #print qq{<polygon points="$x,$cy $cx,$cy $cx,$y $x,$cy" stroke="$bg" stroke-width="0.25" fill="$fg" />};
 354                         print qq{<rect x="$x" y="$y" width="$w" height="2.54" stroke="$fg" stroke-width="0.3" fill="$bg" />};
 355                         my ( $fg, $bg ) = @{ $cols->{txt} };
 356                         print qq{<rect x="$x" y="$y" width="$w" height="2.54" rx="1" ry="1" stroke="$fg" stroke-width="0.3" fill="$bg" />};
 357                 } else {
 358                         rect $x,$y,$col,$fg;
 359                 }
 360                 return qq{ style="fill:$bg"};
 361         }
 362
 363         if ( $name =~ m/(VCC|3V3|3.3V|5v)/i ) {
 364                 my ($fg,$bg) = @{ $cols->{vcc} };
 365                 rect $x,$y,$col,$bg;
 366                 return qq{ style="fill:$fg"};
 367         } elsif ( $name =~ m/(G(ND|Round)|VSS|0v)/i ) {
 368                 my ($fg,$bg) = @{ $cols->{gnd} };
 369                 rect $x,$y,$col,$bg;
 370                 return qq{ style="fill:$fg"};
 371         } elsif ( $name =~ m/\[(\w+)/ ) { # kernel
 372                 my $dev = $1;
 373                 my ($fg,$bg) = @{ $cols->{txt} };
 374                 $dev = 'serial' if $dev =~ m/^tty/;
 375                 ($fg,$bg) = @{ $cols->{$dev} } if exists $cols->{$dev};
 376                 rect $x,$y,$col,$bg;
 377                 return qq{ style="fill:$fg"};
 378         } else {
 379                 my ( $fg, $bg ) = @{ $cols->{txt} };
 380                 rect $x,$y,$col,$bg;
 381                 #return qq{ style="fill:$fg"};
 382                 return '';
 383         }
 384 }
 385
 386 my $alt_col = 0;
 387
 388 my @cols_order = ( 0,1,2,3 );
 389 my @cols_align = ( '','-','','-' ); # sprintf prefix
 390
 391 my @cols_shuffle = @cols_order;
 392
 393 if ( $opt_edge ) {
 394         # pins outside on the right
 395         @cols_shuffle = ( 0,1,3,2 ) if $opt_edge;
 396         @cols_align = ( '-','-','','' );
 397 } elsif ( $opt_middle ) {
 398         # pins in middle
 399         @cols_shuffle = ( 1,0,2,3 );
 400         @cols_align = ( '','','-','-' );
 401 }
 402
 403 sub cols_shuffle {
 404         my ( $what, $order ) = @_;
 405         my $new = [];
 406         foreach my $i ( 0 .. $#$what ) {
 407                 $new->[$i] = $what->[ $order->[$i] ];
 408         }
 409         warn "# cols_shuffle what=",dump($what)," order=",dump($order)," new=",dump($new);
 410         return @$new;
 411 }
 412
 413 @cols_order = cols_shuffle( \@cols_order, \@cols_shuffle );
 414 @max_len    = cols_shuffle( \@max_len,    \@cols_shuffle );
 415
 416 warn "# cols_order = ",dump( \@cols_order );
 417 warn "# cols_align = ",dump( \@cols_align );
 418
 419 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";
 420
 421
 422 # cut marks
 423 my ($fg,$bg) = @{ $cols->{txt} };
 424 my $line_fmt = qq{<line x1="%s" y1="%s" x2="%s" y2="%s" style="stroke:$fg;stroke-width:0.10;fill:$bg" />\n};
 425
 426 my @cut_marks;
 427 sub cut_mark {
 428         my ($x,$y) = @_;
 429         return unless $opt_svg;
 430         push @cut_marks, sprintf($line_fmt, $x-5, $y-$font_b,   $x+5, $y-$font_b);
 431         push @cut_marks, sprintf($line_fmt, $x,   $y-$font_b-5, $x,   $y-$font_b+5);
 432 }
 433 #cut_mark $x, $y;
 434 my $max_x = $x;
 435 $max_x += $max_len[$_] * $font_w foreach ( 0 .. 3 );
 436 #cut_mark $max_x, $y;
 437
 438 sub line {
 439         my ($x,$y,$max_x) = @_;
 440         push @cut_marks, sprintf($line_fmt, $x, $y-$font_b, $max_x, $y-$font_b);
 441 }
 442
 443
 444 my $last_cut_mark = 0;
 445
 446 sub connector {
 447         my ( $from, $to ) = @_;
 448         warn "# connector $from - $to ",dump( $line_parts[$from], $line_parts[$to] );
 449         if ( $opt_vertical ) {
 450                 foreach my $i ( 0 .. int(($to-$from)/2) ) {
 451                         my $t = $line_parts[$from + $i];
 452                                 $line_parts[$from + $i] = $line_parts[$to - $i];
 453                                                           $line_parts[$to - $i] = $t;
 454                 }
 455         }
 456 }
 457
 458 my $from;
 459 my $to;
 460 foreach my $i ( 0 .. $#line_parts ) {
 461         next if $line_parts[$i]->[0] =~ m/^###/;
 462         if (exists $line_parts[$i]->[1]) {
 463                 if (! $from) {
 464                         $from = $i;
 465                 } else {
 466                         $to = $i;
 467                 }
 468         } elsif ($from && $to) {
 469                 connector $from => $to;
 470                 $from = $to = undef;
 471         }
 472 }
 473 connector $from => $to if $from && $to;
 474
 475 foreach my $i ( 0 .. $#line_parts ) {
 476 #       $i = $#line_parts - $i if $opt_vertical;
 477         my $line = $line_parts[$i];
 478
 479         if ( $opt_svg ) {
 480
 481                 # not a minimal two column pin description
 482                 if ( ! exists $line->[1] ) {
 483                         $last_cut_mark = 1 if $line->[0] =~ m/^##/; # skip comments
 484
 485                         # before first empty line
 486                         if ( $last_cut_mark == 0 ) {
 487                                 cut_mark $x, $y;
 488                                 cut_mark $max_x, $y;
 489                                 $last_cut_mark = 1;
 490                                 line $x, $y, $max_x if $opt_lines;
 491                                 $y += 15; # make spacing between pinouts
 492                         }
 493                 } elsif ( $last_cut_mark ) {
 494                         # first full line
 495                         cut_mark $x, $y;
 496                         cut_mark $max_x, $y;
 497                         $last_cut_mark = 0;
 498                 } else {
 499                         #warn "CUTMARK no magic";
 500                 }
 501
 502                 line $x, $y, $max_x if $opt_lines && exists $line->[1];
 503
 504                 my ($fg,$bg) = @{ $cols->{txt} };
 505                 my $tspan = qq{<tspan x="$x" y="$y" style="line-height:2.54;fill:$fg;stroke:none;">\n};
 506
 507                 my $x_pos = $x;
 508                 foreach my $i ( 0 .. $#cols_order ) {
 509                         my $order = $cols_order[$i];
 510                         next unless $line->[$order];
 511
 512                         my $text_anchor = 'middle';
 513                         my $len = $max_len[$i];
 514                         my $x2 = $x_pos + ( $len * $font_w ) / 2;
 515                         # is this comment?
 516                         if ( $#$line == 0 && $line->[$order] =~ s/^#+s*// ) {
 517                                 # comment, center over whole width
 518                                 $len = length($line->[$order]);
 519                                 $x2 = $x + (($max_x-$x)/2); # middle
 520                                 $tspan .= qq{\t<tspan x="$x2" text-anchor="$text_anchor"}.sprintf( '>%' . $cols_align[$i] . $len . 's</tspan>', $line->[0]);
 521                         } else {
 522                                 $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]);
 523                         }
 524                         $x_pos += $len * $font_w;
 525                 }
 526
 527                 $tspan .= qq{\n</tspan>\n};
 528                 push @later,sprintf $tspan, @$line;
 529                 $y += 2.54;
 530
 531                 # swap pin colors for line stripe
 532                 if ( $opt_zebra ) {
 533                         swap_cols $_ foreach qw( pins txt );
 534                 } else {
 535                         swap_cols 'pins';
 536                 }
 537
 538         } else {
 539
 540                 if ( $#$line == 0 ) {
 541                         print $line->[0], "\n";
 542                 } else {
 543                         push @$line, '' while ($#$line < 3); # fill-in single row header
 544                         printf $fmt, map { $line->[$_] } @cols_order;
 545                 }
 546
 547         }
 548 }
 549
 550 if ( $opt_svg ) {
 551         cut_mark $x,$y;
 552         cut_mark $max_x,$y;
 553         line $x, $y, $max_x if $opt_lines;
 554
 555         print qq{
 556     <text
 557        id="text4506"
 558        y="$x"
 559        x="$y"
 560        style="font-size:2.34px;line-height:2.54px;font-family:'Andale Mono';stroke:none"
 561        xml:space="preserve">
 562
 563         }; #svg
 564
 565         print @later, qq{</text>\n}, @cut_marks, qq{</g>\n</svg>};
 566
 567 }
 568
 569 # you can add pin definitions below, but they should go into pins/
 570 __DATA__
 571