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 = $ENV{SVG} || 0;
   9 my $opt_alt = $ENV{ALT} || 0;
  10 my $opt_invert = $ENV{INVERT} = 0;
  11 my $opt_vertical = $ENV{VERTICAL} = 0;
  12 my $opt_kernel = $ENV{kernel} = 1;
  13 GetOptions(
  14         'svg!' => \$opt_svg,
  15         'alt!' => \$opt_alt,
  16         'invert!' => \$opt_invert,
  17         'vertical!' => \$opt_vertical,
  18         'kernel!' => \$opt_kernel,
  19 );
  20
  21 # svg font hints
  22 my $font_w = 1.67; # < 2.54, font is not perfect square
  23 my $font_b = 2.10; # font baseline position
  24
  25 sub slurp {
  26         open(my $fh, '<', shift);
  27         local $/ = undef;
  28         <$fh>;
  29 }
  30
  31 my $pins;
  32
  33 my $model = slurp('/proc/device-tree/model');
  34 $model =~ s/\x00$//; # strip kernel NULL
  35 warn "# model [$model]";
  36
  37 my @lines;
  38 my $line_i = 0;
  39
  40 my $include = 0;
  41 while(<DATA>) {
  42         chomp;
  43         if ( m/^#\s*$model/ ) {
  44                 $include = 1;
  45         } elsif ( m/^#\s+/ ) {
  46                 $include = 0;
  47         } elsif ( $include ) {
  48                 push @{ $pins->{$1} }, $line_i while ( m/\t(P\w\d+)/g );
  49
  50                 push @lines, $_;
  51
  52                 $line_i++;
  53         } else {
  54                 warn "IGNORE: [$_]\n";
  55         }
  56 }
  57
  58 die "add pin definition for # $model" unless $pins;
  59
  60 warn "# pins ",dump($pins);
  61
  62 my $pin_function;
  63
  64 open(my $fh, '<', '/sys/kernel/debug/pinctrl/pinctrl-handles');
  65 while(<$fh>) {
  66         chomp;
  67         if ( m/group: (P\w\d+)\s.+function: (\S+)/ ) {
  68                 my ($pin, $function) = ($1,$2);
  69                 $pin_function->{$pin} = $function;
  70
  71                 next unless $opt_kernel;
  72
  73                 if ( $pins->{$pin} ) {
  74                         foreach my $line ( @{$pins->{$pin}} ) {
  75 warn "XXX $pin $line";
  76                                 my $t = $lines[$line];
  77                                 if ( $opt_svg ) {
  78                                         $t =~ s/$pin/[$function]/;
  79                                 } else {
  80                                         $t =~ s/$pin/$pin [$function]/ || die "can't find $pin in [$t]";
  81                                 }
  82                                 $lines[$line] = $t;
  83                                 warn "# $line: $lines[$line]\n";
  84                         }
  85                 } else {
  86                         warn "IGNORED: pin $pin function $function\n";
  87                 }
  88         }
  89 }
  90
  91 my @max_len = ( 0,0,0,0 );
  92 my @line_parts;
  93 foreach my $line (@lines) {
  94         if ( $line =~ m/^#/ ) {
  95                 push @line_parts, [ $line ] unless $opt_svg;
  96                 next;
  97         }
  98         $line =~ s/(\[uart\d)(\]\s[^\t]*(rx|tx))/$1 $3$2/gi;
  99         $line =~ s/(\[i2c\d)(\]\s[^\t]*(sck|sda))/$1 $3$2/gi;
 100         $line =~ s/(\[spi\d)(\]\s[^\t]*(miso|mosi|clk|cs))/$1 $3$2/gi;
 101         $line =~ s/\s*\([^\)]+\)//g if ! $opt_alt;
 102
 103         my @v = split(/\s*\t+\s*/,$line,4);
 104         push @line_parts, [ @v ];
 105         foreach my $i ( 0 .. 3 ) {
 106                 next unless exists $v[$i];
 107                 next if $v[$i] =~ m/^#/; # don't calculate comments into max length
 108                 my $l = length($v[$i]);
 109                 $max_len[$i] = $l if $l > $max_len[$i];
 110         }
 111 }
 112
 113 warn "# max_len = ",dump( \@max_len );
 114 warn "# line_parts = ",dump( \@line_parts );
 115
 116 #print "$_\n" foreach @lines;
 117
 118 my $fmt = "%$max_len[0]s %-$max_len[1]s %$max_len[2]s %-$max_len[3]s\n";
 119
 120 my $x = 30.00; # mm
 121 my $y = 30.00; # mm
 122
 123 if ( $opt_svg ) {
 124         print qq{<?xml version="1.0" encoding="UTF-8" standalone="no"?>
 125 <svg
 126    xmlns:dc="http://purl.org/dc/elements/1.1/"
 127    xmlns:cc="http://creativecommons.org/ns#"
 128    xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
 129    xmlns:svg="http://www.w3.org/2000/svg"
 130    xmlns="http://www.w3.org/2000/svg"
 131    xmlns:xlink="http://www.w3.org/1999/xlink"
 132    id="svg8"
 133    version="1.1"
 134    viewBox="0 0 210 297"
 135    height="297mm"
 136    width="210mm">
 137
 138
 139 <g id="layer1">
 140
 141         }; # svg, insert rest of rect
 142
 143         print qq{<rect x="0" y="0" width="210" height="297" style="fill:#000000" id="high-contrast"/>} if $opt_invert;
 144 }
 145
 146 my @later;
 147
 148 my $cols = {    # foreground background
 149         txt  => [ '#000000', '#ffffff' ],
 150         pins => [ '#ffffff', '#ff00ff' ],
 151         vcc  => [ '#ff0000', '#ffff00' ],
 152         gnd  => [ '#000000', '#00ffff' ],
 153         i2c  => [ '#008800', '#ffcccc' ],
 154         uart => [ '#000088', '#ccffcc' ],
 155         spi  => [ '#880000', '#ccccff' ],
 156 };
 157
 158 sub swap_cols {
 159         my $swap = shift;
 160         die "$swap not found in ",dump($cols) unless $cols->{$swap};
 161         my ( $c1, $c2 ) = @{ $cols->{$swap} };
 162         $cols->{$swap} = [ $c2, $c1 ];
 163 }
 164
 165 swap_cols 'txt' if $opt_invert;
 166
 167
 168 sub svg_style {
 169         my ($name,$x,$y,$col) = @_;
 170         $y -= $font_b; # shift box overlay to right vertical position based on font baseline
 171
 172         sub rect {
 173                 my ($x,$y,$col,$fill) = @_;
 174                 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};
 175
 176         }
 177
 178         if ( $name =~ m/^(\d+)$/ ) { # pins
 179                 my $pin = $1;
 180                 my ( $fg, $bg ) = @{ $cols->{pins} };
 181                 if ( $pin == 1 ) {
 182                         my $w  = $max_len[$col]*$font_w - 0.1;
 183                         my $cx = $x + $w;
 184                         my $cy = $y + 2.54;
 185                         #print qq{<polygon points="$x,$y $cx,$y $x,$cy $x,$y" stroke="$fg" stroke-width="0.25" fill="$bg" />};
 186                         #print qq{<polygon points="$x,$cy $cx,$cy $cx,$y $x,$cy" stroke="$bg" stroke-width="0.25" fill="$fg" />};
 187                         print qq{<rect x="$x" y="$y" width="$w" height="2.54" stroke="$fg" stroke-width="0.3" fill="$bg" />};
 188                         my ( $fg, $bg ) = @{ $cols->{txt} };
 189                         print qq{<rect x="$x" y="$y" width="$w" height="2.54" rx="1" ry="1" stroke="$fg" stroke-width="0.3" fill="$bg" />};
 190                 } else {
 191                         rect $x,$y,$col,$fg;
 192                 }
 193                 return qq{ style="fill:$bg"};
 194         }
 195
 196         if ( $name =~ m/(VCC|3V3|3.3V)/i ) {
 197                 my ($fg,$bg) = @{ $cols->{vcc} };
 198                 rect $x,$y,$col,$bg;
 199                 return qq{ style="fill:$fg"};
 200         } elsif ( $name =~ m/(G(ND|Round)|VSS)/i ) {
 201                 my ($fg,$bg) = @{ $cols->{gnd} };
 202                 rect $x,$y,$col,$bg;
 203                 return qq{ style="fill:$fg"};
 204         } elsif ( $name =~ m/\[(\w+)\d/ ) { # kernel
 205                 my $dev = $1;
 206                 if ( my ($fg,$bg) = @{ $cols->{$dev} } ) {
 207                         rect $x,$y,$col,$bg;
 208                         return qq{ style="fill:$fg"};
 209                 }
 210         } else {
 211                 my ( $fg, $bg ) = @{ $cols->{txt} };
 212                 rect $x,$y,$col,$bg;
 213                 #return qq{ style="fill:$fg"};
 214                 return '';
 215         }
 216 }
 217
 218 my $alt_col = 0;
 219
 220 my @cols_order = ( 0,1,2,3 );
 221 my @cols_align = ( '','-','','-' ); # sprintf prefix
 222
 223 @cols_order = ( 0,1,3,2 ); # pins outside on the right
 224 @cols_align = ( '','-','-','' );
 225
 226
 227 # cut marks
 228 my ($fg,$bg) = @{ $cols->{txt} };
 229 my $line_fmt = qq{<line x1="%s" y1="%s" x2="%s" y2="%s" style="stroke:$fg;stroke-width:0.10;fill:$bg" />\n};
 230
 231 my @cut_marks;
 232 sub cut_mark {
 233         my ($x,$y) = @_;
 234         push @cut_marks, printf($line_fmt, $x-5, $y-$font_b,   $x+5, $y-$font_b);
 235         push @cut_marks, printf($line_fmt, $x,   $y-$font_b-5, $x,   $y-$font_b+5);
 236 }
 237 cut_mark $x, $y;
 238 my $max_x = $x;
 239 $max_x += $max_len[$_] * $font_w foreach ( 0 .. 3 );
 240 cut_mark $max_x, $y;
 241
 242 my $last_cut_mark = 0;
 243
 244 foreach my $i ( 0 .. $#line_parts ) {
 245         $i = $#line_parts - $i if $opt_vertical;
 246         my $line = $line_parts[$i];
 247         warn "# LINE ",dump($line);
 248
 249         if ( $opt_svg ) {
 250
 251                 if ( ! exists $line->[0] ) {
 252                         # before first empty line
 253                         if ( $last_cut_mark == 0 ) {
 254                                 cut_mark $x, $y;
 255                                 cut_mark $max_x, $y;
 256                                 $last_cut_mark = 1;
 257                                 $y += 15; # make spacing between pinouts
 258                         }
 259                 } elsif ( $last_cut_mark ) {
 260                         # first full line
 261                         cut_mark $x, $y;
 262                         cut_mark $max_x, $y;
 263                         $last_cut_mark = 0;
 264                 } else {
 265                         warn "CUTMARK no magic";
 266                 }
 267
 268                 my ($fg,$bg) = @{ $cols->{txt} };
 269                 my $tspan = qq{<tspan x="$x" y="$y" style="line-height:2.54;fill-opacity:1;fill:$fg;stroke:none;">\n};
 270
 271                 my $x_pos = $x;
 272                 foreach my $i ( @cols_order ) {
 273                         next unless $line->[$i];
 274                         my $text_anchor = 'middle';
 275                         my $x2 = $x_pos + ( $max_len[$i] * $font_w ) / 2;
 276                         $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]);
 277                         $x_pos += $max_len[$i] * $font_w;
 278                 }
 279
 280                 $tspan .= qq{</tspan>\n};
 281                 push @later,sprintf $tspan, @$line;
 282                 $y += 2.54;
 283
 284                 # swap pin colors for line stripes
 285                 swap_cols $_ foreach qw( pins txt );
 286
 287         } else {
 288
 289                 if ( $#$line == 0 ) {
 290                         print $line->[0], "\n";
 291                 } else {
 292                         push @$line, '' while ($#$line < 3); # fill-in single row header
 293                         printf $fmt, @$line;
 294                 }
 295
 296         }
 297 }
 298
 299 if ( $opt_svg ) {
 300         print qq{
 301     <text
 302        id="text4506"
 303        y="$x"
 304        x="$y"
 305        style="font-size:2.34px;line-height:2.54px;font-family:'Andale Mono';fill-opacity:1;stroke:none;stroke-opacity:1"
 306        xml:space="preserve">
 307
 308         }; #svg
 309
 310         print @later, @cut_marks, qq{
 311 </text>
 312 </g>
 313 </svg>
 314         }; #svg
 315
 316 }
 317
 318 __DATA__
 319 # Cubietech Cubieboard2
 320 ## U14 (Next to SATA connector)
 321 ###     SPI0
 322 48      PI13 (SPI0-MISO/UART6-RX/EINT25)        47      PI11 (SPI0-CLK/UART5-RX/EINT23)
 323 46      PI12 (SPI0-MOSI/UART6-TX/EINT24)        45      PI10 (SPI0-CS/UART5-TX/EINT22)
 324 ###     LCD
 325 44      3.3V (nc in 2012-08-08)                 43      VCC-5V
 326 42      Ground                                  41      SPDIF
 327 40      PB10 (LCD0-SCK/LCD-PIO1)                39      PB11 (LCD0-SDA/LCD-PIO2)
 328 38      Ground                                  37      PH7 (LCD0-BL-EN/LCD-PIO0/UART5-RX/EINT7)
 329 36      XN_TP (TP-X2)                           35      YN_TP (TP-Y2)
 330 34      XP_TP (TP-X1)                           33      YP_TP (TP-Y1)
 331 32      PD25 (LCDDE)                            31      PB2 (PWM0)
 332 30      PD26 (LCDHSYNC/VGA-HSYNC)               29      PD24 (LCDCLK)
 333 28      PD23 (LCDD23)                           27      PD27 (LCDVSYNC/VGA-VSYNC)
 334 26      PD21 (LCDD21)                           25      PD22 (LCDD22)
 335 24      PD19 (LCDD19/LVDS1N3)                   23      PD20 (LCDD20)
 336 22      PD17 (LCDD17/LVDS1NC)                   21      PD18 (LCDD18/LVDS1P3)
 337 20      Ground                                  19      PD16 (LCDD16/LVDS1PC)
 338 18      PD14 (LCDD14/LVDS1P2)                   17      PD15 (LCDD15/LVDS1N2)
 339 16      PD12 (LCDD12/LVDS1P1)                   15      PD13 (LCDD13/LVDS1N1)
 340 14      PD10 (LCDD10/LVDS1P0)                   13      PD11 (LCDD11/LVDS1N0)
 341 12      PD8 (LCDD8/LVDS0P3)                     11      PD9 (LCDD9/LVDS0N3)
 342 10      PD7 (LCDD7/LVDS0NC)                     9       Ground
 343 8       PD5 (LCDD5/LVDS0N2)                     7       PD6 (LCDD6/LVDS0PC)
 344 6       PD3 (LCDD3/LVDS0N1)                     5       PD4 (LCDD4/LNVS0P2)
 345 4       PD1 (LCDD1/LVDS0N0)                     3       PD2 (LCDD2/LVDS0P1)
 346 2       Ground                                  1       PD0 (LCDD0/LVDSP0)
 347
 348 # Cubietech Cubieboard2
 349 ## U15 (Between Ethernet port and USB ports)
 350 ### CSI1/TS
 351 1       VCC-5V                                  2       PH15 (CSI1-PWR/EINT15)
 352 3       CSI1-IO-2V8                             4       PH14 (CSI1-RST#/EINT14)
 353 5       PG0 (CSI1-PCLK/SDC1-CMD)                6       PB18 (TWI1-SCK)
 354 7       PB19 (TWI1-SDA)                         8       PG3 (CSI1-VSYNC/SDC1-D1)
 355 9       PG2 (CSI1-HSYNC/SDC1-D0)                10      PG1 (CSI1-MCLK/SDC1-CLK)
 356 11      PG4 (CSI1-D0/SDC1-D2)                   12      PG5 (CSI1-D1/SDC1-D3)
 357 13      PG6 (CSI1-D2/UART3-TX)                  14      PG7 (CSI1-D3/UART3-RX)
 358 15      PG8 (CSI1-D4/UART3-RTS)                 16      PG9 (CSI1-D5/UART3-CTS)
 359 17      PG10 (CSI1-D6/UART4-TX)                 18      PG11 (CSI1-D7/UART4-RX)
 360 19      Ground                                  20      Ground
 361 ###     Analog SDIO3
 362 21      FMINL                                   22      PI4 (SDC3-CMD)
 363 23      FMINR                                   24      PI5 (SDC3-CLK)
 364 25      Ground                                  26      PI6 (SDC3-D0)
 365 27      VGA-R                                   28      PI7 (SDC3-D1)
 366 29      VGA-G                                   30      PI8 (SDC3-D2)
 367 31      VGA-B                                   32      PI9 (SDC3-D3)
 368 ###     CSI0/TS
 369 33      LCD1-VSYNC                              34      PE4 (CSI0-D0)
 370 35      LCD1-HSYNC                              36      PE5 (CSI0-D1)
 371 37      Ground                                  38      PE6 (CSI0-D2)
 372 39      AVCC                                    40      PE7 (CSI0-D3)
 373 41      LRADC0                                  42      PE8 (CSI0-D4)
 374 43      CVBS                                    44      PE9 (CSI0-D5)
 375 45      HPL                                     46      PE10 (CSI0-D6)
 376 47      HPR                                     48      PE11 (CSI0-D7)
 377
 378 ## DEBUG serial (middle of board)
 379 4       PB22 (UART0-TX)
 380 3       PB23 (UART0-RX)
 381 2       VCC-3V3
 382 1       GND
 383
 384
 385 # Lamobo R1
 386 ## CON3 rpi DIP26-254
 387 1       3.3v                    2       5v
 388 3       PB20 SDA.1              4       5V
 389 5       PB21 SCL.1              6       0v
 390 7       PI3 PWM1                8       PH0 UART3_TX
 391 9       0v                      10      PH1 UART3_RX
 392 11      PI19 UART2_RX           12      PH2
 393 13      PI18 UART2_TX           14      0v
 394 15      PI17 UART2_CTS          16      PH21 CAN_RX
 395 17      3.3v                    18      PH20 CAN_TX
 396 19      PI12 SPI0_MOSI          20      0v
 397 21      PI13 SPI0_MISO          22      PI16 UART2_RTS
 398 23      PI11 SPI0_SCLK          24      PI10 SPI0_CS0
 399 25      0v                      26      PI14 SPI0_CS1
 400
 401 ## J13 DIP2-254
 402 2       PB22 UART0_TX
 403 1       PB23 UART0_RX
 404
 405 ## J12 DIP8-254
 406 8       GND                     7       GND
 407 6       PI20 UART7_TX           5       PH3
 408 4       PI21 UART7_RX           3       PH5
 409 2       3V3                     1       SATA-5V