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