added funcs from raspi-gpio with -a flag
[linux-gpio-pinout] / 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                         if ( my $pin = $linux_gpio_name->{$1} ) {
185                                 $gpio_debug->{ $pin } = $l[2];
186                                 $l[3] =~ s/\s\s+/ /g;
187                                 annotate_pin $pin, qq{"$l[2]" $l[3]};
188                         } else {
189                                 warn "FIXME can't find $1 in ",dump( $linux_gpio_name );
190                         }
191                 }
192         }
193
194 }
195 warn "# gpio_debug = ",dump( $gpio_debug );
196
197
198
199 my $have_sunxi_pio = `which sunxi-pio`;
200 if ( $have_sunxi_pio ) {
201
202 open(my $pio, '-|', 'sunxi-pio -m print');
203 while(<$pio>) {
204         chomp;
205         s/[<>]+/ /g;
206         my @p = split(/\s+/,$_);
207         warn "# pio ",dump(\@p);
208         # annotate input 0 and output 1 pins
209 #       annotate_pin $p[0], ( $p[1] ? 'O' : 'I' ) . ':' . $p[4] if $p[1] == 0 || $p[1] == 1;
210         my $pin = shift @p;
211         annotate_pin $pin, join(' ',@p) if ! $opt_svg;
212 }
213 close($pio);
214
215 } # have_sunxi_pio
216
217 my $have_raspi_gpio = `which raspi-gpio`;
218 if ( $have_raspi_gpio ) {
219
220 my @gpio_pins;
221
222 open(my $pio, '-|', 'raspi-gpio get');
223 while(<$pio>) {
224         chomp;
225         if ( m/^GPIO (\d+): (.+)/ ) {
226                 my $pin = 'gpio' . $1;
227                 push @gpio_pins, $1;
228                 annotate_pin $pin, $2 if ! $opt_svg;
229         }
230 }
231 close($pio);
232
233 open(my $pio, '-|', 'raspi-gpio funcs '.join(',',@gpio_pins));
234 while(<$pio>) {
235         chomp;
236         s/,\s/ /g;
237         if (m/^(\d+)\s+(.*)/) {
238                 annotate_pin 'gpio'.$1,"($2)" if $opt_alt;
239         }
240 }
241 close($pio);
242
243 } # have_raspi_gpio
244
245
246 my $pinmux;
247 my $pinmux_path = (glob("/sys/kernel/debug/pinctrl/*/pinmux-functions"))[0];
248 if ( $opt_pinmux && -e $pinmux_path ) {
249         open(my $mux, '<', $pinmux_path);
250         while(<$mux>) {
251                 chomp;
252                 if ( m/function: (\w+), groups = \[ (.*) \]/ ) {
253                         my ( $func, $pins ) = ( $1, $2 );
254                         foreach ( split(/\s+/,$pins) ) {
255                                 push @{ $pinmux->{$_} }, $func;
256                         }
257                 } else {
258                         warn "IGNORED [$pinmux_path] [$_]\n";
259                 }
260         }
261
262         foreach my $pin ( keys %$pinmux ) {
263                 if ( exists $pins->{$pin} ) {
264                         annotate_pin $pin, '{' . join(' ', @{$pinmux->{$pin}}) . '}';
265                 } else {
266                         warn "IGNORED mux on $pin\n";
267                 }
268         }
269
270         warn "# pinmux = ",dump( $pinmux );
271 }
272
273
274
275 my @max_len = ( 0,0,0,0 );
276 my @line_parts;
277
278 shift(@lines) while ( ! $lines[0] );    # remove empty at beginning
279 pop(@lines) while ( ! $lines[-1] );     # remove empty at end
280
281 foreach my $line (@lines) {
282         if ( $line =~ m/^#/ ) {
283                 push @line_parts, [ $line ] unless $opt_svg && $line =~ m/^###+/; # SVG doesn't display 3rd level comments
284                 next;
285         }
286         $line =~ s/\[(\w+)\s+(\w+)\] \[\1\s+(\w+)\]/[$1 $2 $3]/g; # compress kernel annotation with same prefix
287         $line =~ s/(\[(?:uart\d*|serial|tty\w+))([^\t]*\]\s[^\t]*(rx|tx)d?)/$1 $3$2/gi;
288         $line =~ s/(\[i2c)([^\t]*\]\s[^\t]*(scl?k?|sda))/$1 $3$2/gi;
289         $line =~ s/(\[spi)([^\t]*\]\s[^\t]*(miso|mosi|s?clk|c[se]\d*))/$1 $3$2/gi;
290         $line =~ s/\s*\([^\)]+\)//g if ! $opt_alt;
291
292         # shorten duplicate kernel device/function
293         $line =~ s/\[serial (\w+) (uart\d+)\]/[$2 $1]/g;
294         $line =~ s/\[(\w+) (\w+) \1(\d+)\]/[$1$3 $2]/g;
295
296         $line =~ s/\[(\w+)\s+([^\]]+)\s+\1\]/[$1 $2]/g; # duplicate
297
298         my @v = split(/\s*\t+\s*/,$line,4);
299         @v = ( $v[2], $v[3], $v[0], $v[1] ) if $opt_horizontal && $v[2];
300
301         push @line_parts, [ @v ];
302         foreach my $i ( 0 .. 3 ) {
303                 next unless exists $v[$i];
304                 next if $v[$i] =~ m/^#/; # don't calculate comments into max length
305                 my $l = length($v[$i]);
306                 $max_len[$i] = $l if $l > $max_len[$i];
307         }
308 }
309
310 warn "# max_len = ",dump( \@max_len );
311 warn "# line_parts = ",dump( \@line_parts );
312
313 #print "$_\n" foreach @lines;
314
315 my $x = 20.00; # mm
316 my $y = 20.00; # mm
317
318 if ( $opt_svg ) {
319         print qq{<?xml version="1.0" encoding="UTF-8" standalone="no"?>
320 <svg
321    xmlns:dc="http://purl.org/dc/elements/1.1/"
322    xmlns:cc="http://creativecommons.org/ns#"
323    xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
324    xmlns:svg="http://www.w3.org/2000/svg"
325    xmlns="http://www.w3.org/2000/svg"
326    xmlns:xlink="http://www.w3.org/1999/xlink"
327    id="svg8"
328    version="1.1"
329    viewBox="0 0 210 297"
330    height="297mm"
331    width="210mm">
332
333
334 <g id="layer1">
335
336         }; # svg, insert rest of rect
337
338         print qq{<rect x="0" y="0" width="210" height="297" style="fill:#000000" id="high-contrast"/>} if $opt_invert;
339 }
340
341 my @later;
342
343 my $cols = {    # foreground background
344         txt  => [ '#000000', '#ffffff' ],
345         pins => [ '#ffffff', '#ff00ff' ],
346         vcc  => [ '#ff0000', '#ffff00' ],
347         gnd  => [ '#000000', '#00ffff' ],
348         i2c  => [ '#008800', '#ffcccc' ],
349         serial=>[ '#000088', '#ccffcc' ],
350         spi  => [ '#880000', '#ccccff' ],
351 };
352
353 sub swap_cols {
354         my $swap = shift;
355         die "$swap not found in ",dump($cols) unless $cols->{$swap};
356         my ( $c1, $c2 ) = @{ $cols->{$swap} };
357         $cols->{$swap} = [ $c2, $c1 ];
358 }
359
360 swap_cols 'txt' if $opt_invert;
361         
362
363 sub svg_style {
364         my ($name,$x,$y,$col) = @_;
365
366         return '' unless $opt_color;
367
368         $y -= $font_b; # shift box overlay to right vertical position based on font baseline
369
370         sub rect {
371                 my ($x,$y,$col,$fill) = @_;
372                 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};
373
374         }
375
376         if ( $name =~ m/^(\d+)$/ ) { # pins
377                 my $pin = $1;
378                 my ( $fg, $bg ) = @{ $cols->{pins} };
379                 if ( $pin == 1 ) {
380                         my $w  = $max_len[$col]*$font_w - 0.1;
381                         my $cx = $x + $w;
382                         my $cy = $y + 2.54;
383                         #print qq{<polygon points="$x,$y $cx,$y $x,$cy $x,$y" stroke="$fg" stroke-width="0.25" fill="$bg" />};
384                         #print qq{<polygon points="$x,$cy $cx,$cy $cx,$y $x,$cy" stroke="$bg" stroke-width="0.25" fill="$fg" />};
385                         print qq{<rect x="$x" y="$y" width="$w" height="2.54" stroke="$fg" stroke-width="0.3" fill="$bg" />};
386                         my ( $fg, $bg ) = @{ $cols->{txt} };
387                         print qq{<rect x="$x" y="$y" width="$w" height="2.54" rx="1" ry="1" stroke="$fg" stroke-width="0.3" fill="$bg" />};
388                 } else {
389                         rect $x,$y,$col,$fg;
390                 }
391                 return qq{ style="fill:$bg"};
392         }
393
394         if ( $name =~ m/(VCC|3V3|3.3V|5v)/i ) {
395                 my ($fg,$bg) = @{ $cols->{vcc} };
396                 rect $x,$y,$col,$bg;
397                 return qq{ style="fill:$fg"};
398         } elsif ( $name =~ m/(G(ND|Round)|VSS|0v)/i ) {
399                 my ($fg,$bg) = @{ $cols->{gnd} };
400                 rect $x,$y,$col,$bg;
401                 return qq{ style="fill:$fg"};
402         } elsif ( $name =~ m/\[(\w+)/ ) { # kernel
403                 my $dev = $1;
404                 my ($fg,$bg) = @{ $cols->{txt} };
405                 $dev = 'serial' if $dev =~ m/^tty/;
406                 ($fg,$bg) = @{ $cols->{$dev} } if exists $cols->{$dev};
407                 rect $x,$y,$col,$bg;
408                 return qq{ style="fill:$fg"};
409         } else {
410                 my ( $fg, $bg ) = @{ $cols->{txt} };
411                 rect $x,$y,$col,$bg;
412                 #return qq{ style="fill:$fg"};
413                 return '';
414         }
415 }
416
417 my $alt_col = 0;
418
419 my @cols_order = ( 0,1,2,3 );
420 my @cols_align = ( '','-','','-' ); # sprintf prefix
421
422 my @cols_shuffle = @cols_order;
423
424 if ( $opt_edge ) {
425         # pins outside on the right
426         @cols_shuffle = ( 0,1,3,2 ) if $opt_edge;
427         @cols_align = ( '-','-','','' );
428 } elsif ( $opt_middle ) {
429         # pins in middle
430         @cols_shuffle = ( 1,0,2,3 );
431         @cols_align = ( '','','-','-' );
432 }
433
434 sub cols_shuffle {
435         my ( $what, $order ) = @_;
436         my $new = [];
437         foreach my $i ( 0 .. $#$what ) {
438                 $new->[$i] = $what->[ $order->[$i] ];
439         }
440         warn "# cols_shuffle what=",dump($what)," order=",dump($order)," new=",dump($new);
441         return @$new;
442 }
443
444 @cols_order = cols_shuffle( \@cols_order, \@cols_shuffle );
445 @max_len    = cols_shuffle( \@max_len,    \@cols_shuffle );
446
447 warn "# cols_order = ",dump( \@cols_order );
448 warn "# cols_align = ",dump( \@cols_align );
449
450 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";
451
452
453 # cut marks
454 my ($fg,$bg) = @{ $cols->{txt} };
455 my $line_fmt = qq{<line x1="%s" y1="%s" x2="%s" y2="%s" style="stroke:$fg;stroke-width:0.10;fill:$bg" />\n};
456
457 my @cut_marks;
458 sub cut_mark {
459         my ($x,$y) = @_;
460         return unless $opt_svg;
461         push @cut_marks, sprintf($line_fmt, $x-5, $y-$font_b,   $x+5, $y-$font_b);
462         push @cut_marks, sprintf($line_fmt, $x,   $y-$font_b-5, $x,   $y-$font_b+5);
463 }
464 #cut_mark $x, $y;
465 my $max_x = $x;
466 $max_x += $max_len[$_] * $font_w foreach ( 0 .. 3 );
467 #cut_mark $max_x, $y;
468
469 sub line {
470         my ($x,$y,$max_x) = @_;
471         push @cut_marks, sprintf($line_fmt, $x, $y-$font_b, $max_x, $y-$font_b);
472 }
473
474
475 my $last_cut_mark = 0;
476
477 sub connector {
478         my ( $from, $to ) = @_;
479         warn "# connector $from - $to ",dump( $line_parts[$from], $line_parts[$to] );
480         if ( $opt_vertical ) {
481                 foreach my $i ( 0 .. int(($to-$from)/2) ) {
482                         my $t = $line_parts[$from + $i];
483                                 $line_parts[$from + $i] = $line_parts[$to - $i];
484                                                           $line_parts[$to - $i] = $t;
485                 }
486         }
487 }
488
489 my $from;
490 my $to;
491 foreach my $i ( 0 .. $#line_parts ) {
492         next if $line_parts[$i]->[0] =~ m/^###/;
493         if (exists $line_parts[$i]->[1]) {
494                 if (! $from) {
495                         $from = $i;
496                 } else {
497                         $to = $i;
498                 }
499         } elsif ($from && $to) {
500                 connector $from => $to;
501                 $from = $to = undef;
502         }
503 }
504 connector $from => $to if $from && $to;
505
506 foreach my $i ( 0 .. $#line_parts ) {
507 #       $i = $#line_parts - $i if $opt_vertical;
508         my $line = $line_parts[$i];
509
510         if ( $opt_svg ) {
511
512                 # not a minimal two column pin description
513                 if ( ! exists $line->[1] ) {
514                         $last_cut_mark = 1 if $line->[0] =~ m/^##/; # skip comments
515
516                         # before first empty line
517                         if ( $last_cut_mark == 0 ) {
518                                 cut_mark $x, $y;
519                                 cut_mark $max_x, $y;
520                                 $last_cut_mark = 1;
521                                 line $x, $y, $max_x if $opt_lines;
522                                 $y += 15; # make spacing between pinouts
523                         }
524                 } elsif ( $last_cut_mark ) {
525                         # first full line
526                         cut_mark $x, $y;
527                         cut_mark $max_x, $y;
528                         $last_cut_mark = 0;
529                 } else {
530                         #warn "CUTMARK no magic";
531                 }
532
533                 line $x, $y, $max_x if $opt_lines && exists $line->[1];
534
535                 my ($fg,$bg) = @{ $cols->{txt} };
536                 my $tspan = qq{<tspan x="$x" y="$y" style="line-height:2.54;fill:$fg;stroke:none;">\n};
537
538                 my $x_pos = $x;
539                 foreach my $i ( 0 .. $#cols_order ) {
540                         my $order = $cols_order[$i];
541                         next unless $line->[$order];
542
543                         my $text_anchor = 'middle';
544                         my $len = $max_len[$i];
545                         my $x2 = $x_pos + ( $len * $font_w ) / 2;
546                         # is this comment?
547                         if ( $#$line == 0 && $line->[$order] =~ s/^#+s*// ) {
548                                 # comment, center over whole width
549                                 $len = length($line->[$order]);
550                                 $x2 = $x + (($max_x-$x)/2); # middle
551                                 $tspan .= qq{\t<tspan x="$x2" text-anchor="$text_anchor"}.sprintf( '>%' . $cols_align[$i] . $len . 's</tspan>', $line->[0]);
552                         } else {
553                                 $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]);
554                         }
555                         $x_pos += $len * $font_w;
556                 }
557
558                 $tspan .= qq{\n</tspan>\n};
559                 push @later,sprintf $tspan, @$line;
560                 $y += 2.54;
561
562                 # swap pin colors for line stripe
563                 if ( $opt_zebra ) {
564                         swap_cols $_ foreach qw( pins txt );
565                 } else {
566                         swap_cols 'pins';
567                 }
568
569         } else {
570
571                 if ( $#$line == 0 ) {
572                         print $line->[0], "\n";
573                 } else {
574                         push @$line, '' while ($#$line < 3); # fill-in single row header
575                         printf $fmt, map { $line->[$_] } @cols_order;
576                 }
577
578         }
579 }
580
581 if ( $opt_svg ) {
582         cut_mark $x,$y;
583         cut_mark $max_x,$y;
584         line $x, $y, $max_x if $opt_lines;
585
586         print qq{
587     <text
588        id="text4506"
589        y="$x"
590        x="$y"
591        style="font-size:2.34px;line-height:2.54px;font-family:'Andale Mono';stroke:none"
592        xml:space="preserve">
593
594         }; #svg
595
596         print @later, qq{</text>\n}, @cut_marks, qq{</g>\n</svg>};
597
598 }
599
600 # you can add pin definitions below, but they should go into pins/
601 __DATA__
602