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