move uart rx/tx into kernel port description
[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/(\[uart\d)(\]\s[^\t]*(rx|tx))/$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  => [ '#008888', '#ffcccc' ],
154         uart => [ '#880088', '#ccffcc' ],
155         spi  => [ '#888800', '#ccccff' ],
156 };
157
158 sub svg_style {
159         my ($name,$x,$y,$col) = @_;
160         $y -= 2.10; # shift box overlay to right vertical position based on font baseline
161
162         sub rect {
163                 my ($x,$y,$col,$fill) = @_;
164                 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" />};
165
166         }
167
168         if ( $name =~ m/^(\d+)$/ ) { # pins
169                 my $pin = $1;
170                 my ( $fg, $bg ) = @{ $cols->{pins} };
171                 if ( $pin == 1 ) {
172                         my $w  = $max_len[$col]*$font_w - 0.1;
173                         my $cx = $x + $w;
174                         my $cy = $y + 2.54;
175                         #print qq{<polygon points="$x,$y $cx,$y $x,$cy $x,$y" stroke="$fg" stroke-width="0.25" fill="$bg" />};
176                         #print qq{<polygon points="$x,$cy $cx,$cy $cx,$y $x,$cy" stroke="$bg" stroke-width="0.25" fill="$fg" />};
177                         print qq{<rect x="$x" y="$y" width="$w" height="2.54" stroke="$fg" stroke-width="0.3" fill="$bg" />};
178                         my ( $fg, $bg ) = @{ $cols->{txt} };
179                         print qq{<rect x="$x" y="$y" width="$w" height="2.54" rx="1" ry="1" stroke="$fg" stroke-width="0.3" fill="$bg" />};
180                 } else {
181                         rect $x,$y,$col,$fg;
182                 }
183                 return qq{ style="fill:$bg"};
184         }
185
186         if ( $name =~ m/(VCC|3V3|3.3V)/i ) {
187                 my ($fg,$bg) = @{ $cols->{vcc} };
188                 rect $x,$y,$col,$bg;
189                 return qq{ style="fill:$fg"};
190         } elsif ( $name =~ m/(G(ND|Round)|VSS)/i ) {
191                 my ($fg,$bg) = @{ $cols->{gnd} };
192                 rect $x,$y,$col,$bg;
193                 return qq{ style="fill:$fg"};
194         } elsif ( $name =~ m/\[(\w+)\d\]/ ) { # kernel
195                 my $dev = $1;
196                 if ( my ($fg,$bg) = @{ $cols->{$dev} } ) {
197                         rect $x,$y,$col,$bg;
198                         return qq{ style="fill:$fg"};
199                 }
200         } else {
201                 my ( $fg, $bg ) = @{ $cols->{txt} };
202                 rect $x,$y,$col,$bg;
203                 #return qq{ style="fill:$fg"};
204                 return '';
205         }
206 }
207
208 my $alt_col = 0;
209
210 my @cols_order = ( 0,1,2,3 );
211 my @cols_align = ( '','-','','-' ); # sprintf prefix
212
213 @cols_order = ( 0,1,3,2 ); # pins outside on the right
214 @cols_align = ( '','-','-','' );
215
216 foreach my $i ( 0 .. $#line_parts ) {
217         $i = $#line_parts - $i if $opt_vertical;
218         my $line = $line_parts[$i];
219
220         my $pin_color = $alt_col ? '#cccccc' : '#444444';
221         $alt_col = ! $alt_col;
222
223         if ( $opt_svg ) {
224
225                 my ($fg,$bg) = @{ $cols->{txt} };
226                 my $tspan = qq{<tspan x="$x" y="$y" style="line-height:2.54;fill-opacity:1;fill:$fg;stroke:none;">};
227
228                 my $x_pos = $x;
229                 foreach my $i ( @cols_order ) {
230                         next unless $line->[$i];
231                         $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]);
232                         $x_pos += $max_len[$i] * $font_w;
233                 }
234
235                 $tspan .= qq{</tspan>};
236                 push @later,sprintf $tspan, @$line;
237                 $y += 2.54;
238
239                 # swap pin colors for line stripes
240                 foreach my $swap (qw( pins txt )) {
241                         my ( $c1, $c2 ) = @{ $cols->{$swap} };
242                         $cols->{$swap} = [ $c2, $c1 ];
243                 };
244
245         } else {
246
247                 if ( $#$line == 0 ) {
248                         print $line->[0], "\n";
249                 } else {
250                         push @$line, '' while ($#$line < 3); # fill-in single row header
251                         printf $fmt, @$line;
252                 }
253
254         }
255 }
256
257 if ( $opt_svg ) {
258         print qq{
259     <text
260        id="text4506"
261        y="$x"
262        x="$y"
263        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"
264        xml:space="preserve">
265
266         }; #svg
267
268         print @later, qq{
269 </text>
270 </g>
271 </svg>
272         }; #svg
273
274 }
275
276 __DATA__
277 # Cubietech Cubieboard2
278 ## U14 (Next to SATA connector)
279 ###     SPI0
280 48      PI13 (SPI0-MISO/UART6-RX/EINT25)        47      PI11 (SPI0-CLK/UART5-RX/EINT23)
281 46      PI12 (SPI0-MOSI/UART6-TX/EINT24)        45      PI10 (SPI0-CS/UART5-TX/EINT22)
282 ###     LCD
283 44      3.3V (nc in 2012-08-08)                 43      VCC-5V
284 42      Ground                                  41      SPDIF
285 40      PB10 (LCD0-SCK/LCD-PIO1)                39      PB11 (LCD0-SDA/LCD-PIO2)
286 38      Ground                                  37      PH7 (LCD0-BL-EN/LCD-PIO0/UART5-RX/EINT7)
287 36      XN_TP (TP-X2)                           35      YN_TP (TP-Y2)
288 34      XP_TP (TP-X1)                           33      YP_TP (TP-Y1)
289 32      PD25 (LCDDE)                            31      PB2 (PWM0)
290 30      PD26 (LCDHSYNC/VGA-HSYNC)               29      PD24 (LCDCLK)
291 28      PD23 (LCDD23)                           27      PD27 (LCDVSYNC/VGA-VSYNC)
292 26      PD21 (LCDD21)                           25      PD22 (LCDD22)
293 24      PD19 (LCDD19/LVDS1N3)                   23      PD20 (LCDD20)
294 22      PD17 (LCDD17/LVDS1NC)                   21      PD18 (LCDD18/LVDS1P3)
295 20      Ground                                  19      PD16 (LCDD16/LVDS1PC)
296 18      PD14 (LCDD14/LVDS1P2)                   17      PD15 (LCDD15/LVDS1N2)
297 16      PD12 (LCDD12/LVDS1P1)                   15      PD13 (LCDD13/LVDS1N1)
298 14      PD10 (LCDD10/LVDS1P0)                   13      PD11 (LCDD11/LVDS1N0)
299 12      PD8 (LCDD8/LVDS0P3)                     11      PD9 (LCDD9/LVDS0N3)
300 10      PD7 (LCDD7/LVDS0NC)                     9       Ground
301 8       PD5 (LCDD5/LVDS0N2)                     7       PD6 (LCDD6/LVDS0PC)
302 6       PD3 (LCDD3/LVDS0N1)                     5       PD4 (LCDD4/LNVS0P2)
303 4       PD1 (LCDD1/LVDS0N0)                     3       PD2 (LCDD2/LVDS0P1)
304 2       Ground                                  1       PD0 (LCDD0/LVDSP0)
305
306 # Cubietech Cubieboard2
307 ## U15 (Between Ethernet port and USB ports)
308 ### CSI1/TS
309 1       VCC-5V                                  2       PH15 (CSI1-PWR/EINT15)
310 3       CSI1-IO-2V8                             4       PH14 (CSI1-RST#/EINT14)
311 5       PG0 (CSI1-PCLK/SDC1-CMD)                6       PB18 (TWI1-SCK)
312 7       PB19 (TWI1-SDA)                         8       PG3 (CSI1-VSYNC/SDC1-D1)
313 9       PG2 (CSI1-HSYNC/SDC1-D0)                10      PG1 (CSI1-MCLK/SDC1-CLK)
314 11      PG4 (CSI1-D0/SDC1-D2)                   12      PG5 (CSI1-D1/SDC1-D3)
315 13      PG6 (CSI1-D2/UART3-TX)                  14      PG7 (CSI1-D3/UART3-RX)
316 15      PG8 (CSI1-D4/UART3-RTS)                 16      PG9 (CSI1-D5/UART3-CTS)
317 17      PG10 (CSI1-D6/UART4-TX)                 18      PG11 (CSI1-D7/UART4-RX)
318 19      Ground                                  20      Ground
319 ###     Analog SDIO3
320 21      FMINL                                   22      PI4 (SDC3-CMD)
321 23      FMINR                                   24      PI5 (SDC3-CLK)
322 25      Ground                                  26      PI6 (SDC3-D0)
323 27      VGA-R                                   28      PI7 (SDC3-D1)
324 29      VGA-G                                   30      PI8 (SDC3-D2)
325 31      VGA-B                                   32      PI9 (SDC3-D3)
326 ###     CSI0/TS
327 33      LCD1-VSYNC                              34      PE4 (CSI0-D0)
328 35      LCD1-HSYNC                              36      PE5 (CSI0-D1)
329 37      Ground                                  38      PE6 (CSI0-D2)
330 39      AVCC                                    40      PE7 (CSI0-D3)
331 41      LRADC0                                  42      PE8 (CSI0-D4)
332 43      CVBS                                    44      PE9 (CSI0-D5)
333 45      HPL                                     46      PE10 (CSI0-D6)
334 47      HPR                                     48      PE11 (CSI0-D7)
335
336 ## DEBUG serial (middle of board)
337 4       PB22 (UART0-TX)
338 3       PB23 (UART0-RX)
339 2       VCC-3V3
340 1       GND
341
342
343 # Lamobo R1
344 ## CON3 rpi DIP26-254
345 1       3.3v                    2       5v     
346 3       PB20 SDA.1              4       5V     
347 5       PB21 SCL.1              6       0v     
348 7       PI3 PWM1                8       PH0 UART3_TX
349 9       0v                      10      PH1 UART3_RX
350 11      PI19 UART2_RX           12      PH2
351 13      PI18 UART2_TX           14      0v     
352 15      PI17 UART2_CTS          16      PH21 CAN_RX 
353 17      3.3v                    18      PH20 CAN_TX 
354 19      PI12 SPI0_MOSI          20      0v     
355 21      PI13 SPI0_MISO          22      PI16 UART2_RTS   
356 23      PI11 SPI0_SCLK          24      PI10 SPI0_CS0    
357 25      0v                      26      PI14 SPI0_CS1
358
359 ## J13 DIP2-254
360 2       PB22 UART0_TX
361 1       PB23 UART0_RX
362
363 ## J12 DIP8-254
364 8       GND                     7       GND
365 6       PI20 UART7_TX           5       PH3
366 4       PI21 UART7_RX           3       PH5
367 2       3V3                     1       SATA-5V