1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<style type="text/css">
@import url('../css/main.css');
</style>
<title>How to programme an SPI flash chip with the BeagleBone Black</title>
</head>
<body>
<div class="section">
<h1 id="pagetop">How to programme an SPI flash chip with the BeagleBone Black</h1>
<p>
This document exists as a guide for reading from or writing to an SPI flash chip with the BeagleBone Black,
using the <a href="http://flashrom.org/Flashrom">flashrom</a> software.
BeagleBone Black rev. C was used when creating this guide, but earlier revisions
may also work.
</p>
<p><a href="index.html">Back to previous index</a></p>
</div>
<div class="section" id="hardware_requirements">
<h1>Hardware requirements</h1>
<p>
Shopping list (pictures of this hardware is shown later):
</p>
<ul>
<li>
External SPI programmer: <b>BeagleBone Black</b> (rev. C)
is highly recommended. Sometimes referred to as 'BBB'.
<a href="http://beagleboard.org/black">This page</a> contains a list of distributors.
</li>
<li>
Electrical tape: cover the entire bottom surface of the BBB (the part that
rests on a surface). This is important, when placing the BBB on top of a board
so that nothing shorts.
</li>
<li>
Clip for connecting to the flash chip: if you have a SOIC-16
flash chip (16 pins), you will need the <b>Pomona 5252</b>
or equivalent. For SOIC-8 flash chips (8 pins), you will
need the <b>Pomona 5250</b> or equivalent. Do check which chip you have,
before ordering a clip. Also, make sure to buy at least two clips
(they break easily).
</li>
<li>
<b>External 3.3V DC power supply</b>, for powering the flash chip.
An ATX power supply / PSU (common on Intel/AMD desktop computers) will work for this.
</li>
<li>
<b>External 5V DC power supply</b> (barrel connector), for powering the BBB.
The BeagleBone can have power supplied via USB, but a
dedicated power supply is recommended.
</li>
<li>
<b>Pin header / jumper cables</b> (2.54mm / 0.1" headers)
You should get male-male, male-female and female-female
cables in 10cm and 20cm sizes. Just get a load of them.
other possible names for these cables:
<ul>
<li>flying leads</li>
<li>dupont (this is just one possible brand name)</li>
<li>Often used on breadboards, so they might be called breadboard cables</li>
<li>Maybe they are called <b>wires</b> instead of cables or leads</li>
</ul>
</li>
<li>
<b>Mini USB A-B cable</b> (the BeagleBone probably already comes
with one.)
</li>
<li>
<b>FTDI TTL cable or debug board</b>, for accessing the serial console on your BBB.
<a href="http://elinux.org/Beagleboard:BeagleBone_Black_Serial">This page</a> contains
a list.
</li>
</ul>
<p>
<a href="#pagetop">Back to top of page.</a>
</p>
</div>
<div class="section" id="psu33">
<h1>Setting up the 3.3V DC PSU</h1>
<p>
ATX PSU pinouts are on <a href="https://en.wikipedia.org/wiki/Power_supply_unit_%28computer%29#Wiring_diagrams">wikipedia</a>
</p>
<p>
You can use pin 1 or 2 (orange wire) on a 20-pin or 24-pin ATX PSU for 3.3V,
and any of the ground/earth sources (black cables) for ground.
Short PS_ON# / Power on (green wire. pin 16 on 24-pin ATX PSU, or pin 14 on a 20-pin ATX PSU) to a ground
(black. there is one right next to it) using a wire/paperclip/jumper then
power on the PSU (grounding PS_ON# activates the PSU without it being connected
to an ATX motherboard).
</p>
<p>
<b>DO **NOT** use pin 4, 6, do **NOT** use pin 19 or 20 (on a 20-pin ATX PSU), and
DO **NOT** use pin 21, 22 or 23 (on a 24-pin ATX PSU). Those wires (the red ones) are 5V, and they **WILL**
kill your flash chip. ***NEVER*** supply more than 3.3V to your flash chip.
(that is, if it's a 3.3V flash chip. 5V and 1.8V SPI flash chips do exist, but they are rare. always
check what voltage your chip takes. most take 3.3V)</b>
</p>
<p>
You only need one 3.3V supply and one ground for the flash chip, after grounding PS_ON#.
</p>
<p>
The male end of a 0.1" or 2.54mm header cable is not thick enough to remain permanently
connected to the ATX PSU on its own.
When connecting header cables to the connector on the ATX PSU, use a female end attached to
a thicker piece of wire (you could use a paper clip), or wedge the male end of the jumper cable
into the sides of the hole in the connector, instead of going through the centre.
</p>
<p>
Here is an example set up:<br/>
<img src="images/x200/psu33.jpg" alt="" title="Copyright © 2015 Patrick "P. J." McDermott <pj@pehjota.net> CC BY-SA 3.0 or later" />
</p>
</div>
<div class="section" id="bbb_access">
<h1>Accessing the operating system on the BBB</h1>
<p>
The operating system on your BBB will probably have an SSH daemon
running where the root account has no password. Use SSH to access
the operating system and set a root password. By default, the OS
on your BBB will most likely use DHCP, so it should already have an IP
address.
</p>
<p>
You will also be using the OS on your BBB for programming an SPI flash chip.
</p>
<h2>Alternatives to SSH (in case SSH fails)</h2>
<p>
You can also use a serial FTDI debug board with GNU Screen, to access the serial console.<br/>
# <b>screen /dev/ttyUSB0 115200</b><br/>
Here are some example photos:<br/>
<img src="images/x200/ftdi.jpg" alt="" />
<img src="images/x200/ftdi_port.jpg" alt="" /><br/>
</p>
<p>
You can also connect the USB cable from the BBB to another computer and a new network interface will appear,
with its own IP address. This is directly accessible from SSH, or screen:<br/>
# <b>screen /dev/ttyACM0 115200</b>
</p>
<p>
You can also access the uboot console, using the serial method
instead of SSH.
</p>
</div>
<div class="section" id="spidev">
<h1>Setting up spidev on the BBB</h1>
<p>
Log on as root on the BBB, using either SSH or a serial console as defined in
<a href="#bbb_access">#bbb_access</a>. Make sure that you have internet access
on your BBB.
</p>
<p>
Follow the instructions at <a href="http://elinux.org/BeagleBone_Black_Enable_SPIDEV#SPI0">http://elinux.org/BeagleBone_Black_Enable_SPIDEV#SPI0</a>
up to (and excluding) the point where it tells you to modify uEnv.txt
</p>
<p>
You need to update the software on the BBB first. If you have an
element14 brand BBB (sold by Premier Farnell plc. stores like
Farnell element14, Newark element14, and Embest), you may need
to <a href="https://groups.google.com/forum/?_escaped_fragment_=msg/beagleboard/LPjCn4LEY2I/alozBGsbTJMJ#!msg/beagleboard/LPjCn4LEY2I/alozBGsbTJMJ">work around a bug</a>
in the LED aging init script before you can update your
software. If you don't have a file named
/etc/init.d/led_aging.sh, you can skip this step and update your
software as described below. Otherwise, replace the contents of
this file with:
</p>
<pre>
#!/bin/sh -e
### BEGIN INIT INFO
# Provides: led_aging.sh
# Required-Start: $local_fs
# Required-Stop: $local_fs
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: Start LED aging
# Description: Starts LED aging (whatever that is)
### END INIT INFO
x=$(/bin/ps -ef | /bin/grep "[l]ed_acc")
if [ ! -n "$x" -a -x /usr/bin/led_acc ]; then
/usr/bin/led_acc &
fi
</pre>
</p>
Run <b>apt-get update</b> and <b>apt-get upgrade</b> then reboot the BBB, before continuing.
</p>
<p>
Check that the firmware exists:<br/>
# <b>ls /lib/firmware/BB-SPI0-01-00A0.*</b><br/>
Output:
</p>
<pre>
/lib/firmware/BB-SPI0-01-00A0.dtbo
</pre>
<p>
Then:<br/>
# <b>echo BB-SPI0-01 > /sys/devices/bone_capemgr.*/slots</b><br/>
# <b>cat /sys/devices/bone_capemgr.*/slots</b><br/>
Output:
</p>
<pre>
0: 54:PF---
1: 55:PF---
2: 56:PF---
3: 57:PF---
4: ff:P-O-L Bone-LT-eMMC-2G,00A0,Texas Instrument,BB-BONE-EMMC-2G
5: ff:P-O-L Bone-Black-HDMI,00A0,Texas Instrument,BB-BONELT-HDMI
7: ff:P-O-L Override Board Name,00A0,Override Manuf,BB-SPI0-01
</pre>
<p>
Verify that the spidev device now exists:<br/>
# <b>ls -al /dev/spid*</b><br/>
Output:
</p>
<pre>
crw-rw---T 1 root spi 153, 0 Nov 19 21:07 /dev/spidev1.0
</pre>
<p>
Now the BBB is ready to be used for flashing. Make this persist
across reboots:<br/>
In /etc/default/capemgr add <b>CAPE=BB-SPI0-01</b> at the end
(or change the existing <b>CAPE=</b> entry to say that, if an
entry already exists.
</p>
<p>
Get flashrom from the libreboot_util release archive, or build it from libreboot_src/git if you need to.
An ARM binary (statically compiled) for flashrom exists in libreboot_util releases. Put the flashrom binary
on your BBB.
</p>
<p>
You may also need ich9gen, if you will be flashing an ICH9-M laptop (such as the X200). Get it from libreboot_util,
or build it from libreboot_src, and put the ARM binary for it on your BBB.
</p>
<p>
Finally, get the ROM image that you would like to flash and put that on your BBB.
</p>
<p>
Now test flashrom:<br/>
# <b>./flashrom -p linux_spi:dev=/dev/spidev1.0,spispeed=512</b><br/>
Output:
</p>
<pre>
Calibrating delay loop... OK.
No EEPROM/flash device found.
Note: flashrom can never write if the flash chip isn't found automatically.
</pre>
<p>
This means that it's working (the clip isn't connected to any flash chip,
so the error is fine).
</p>
</div>
<div class="section" id="clip">
<h1>
Connecting the Pomona 5250/5252
</h1>
<p>
Use this image for reference when connecting the pomona to the BBB:
<a href="http://beagleboard.org/Support/bone101#headers">http://beagleboard.org/Support/bone101#headers</a>
(D0 = MISO or connects to MISO).
</p>
<p>
The following shows how to connect clip to the BBB (on the P9 header), for SOIC-16 (clip: Pomona 5252):
</p>
<pre>
NC - - 21
1 - - 17
NC - - NC
NC - - NC
NC - - NC
NC - - NC
18 - - 3.3V (PSU)
22 - - NC - this is pin 1 on the flash chip
<i>This is how you will connect. Numbers refer to pin numbers on the BBB, on the plugs near the DC jack.</i>
You may also need to connect pins 1 and 9 (tie to 3.3V supply). These are HOLD# and WP#.
On some systems they are held high, if the flash chip is attached to the board.
If you're flashing a chip that isn't connected to a board, you'll almost certainly
have to connect them.
SOIC16 pinout (more info available online, or in the datasheet for your flash chip):
HOLD 1-16 SCK
VDD 2-15 MOSI
N/C 3-14 N/C
N/C 4-13 N/C
N/C 5-12 N/C
N/C 6-11 N/C
SS 7-10 GND
MISO 8-9 WP
</pre>
<p>
The following shows how to connect clip to the BBB (on the P9 header), for SOIC-8 (clip: Pomona 5250):
</p>
<pre>
18 - - 1
22 - - NC
NC - - 21
3.3V (PSU) - - 17 - this is pin 1 on the flash chip
<i>This is how you will connect. Numbers refer to pin numbers on the BBB, on the plugs near the DC jack.</i>
You may also need to connect pins 3 and 7 (tie to 3.3V supply). These are HOLD# and WP#.
On some systems they are held high, if the flash chip is attached to the board.
If you're flashing a chip that isn't connected to a board, you'll almost certainly
have to connect them.
SOIC8 pinout (more info available online, or in the datasheet for your flash chip):
SS 1-8 VDD
MISO 2-7 HOLD
WP 3-6 SCK
GND 4-5 MOSI
</pre>
<p>
<b>NC = no connection</b>
</p>
<p>
<b><u>DO NOT</u> connect 3.3V (PSU) yet. ONLY connect this once the pomona is connected to the flash chip.</b>
</p>
<p>
<b>You also need to connect the BLACK wire (ground/earth) from the 3.3V PSU to pin 2 on the BBB (P9 header).
It is safe to install this now
(that is, before you connect the pomona to the flash chip); in fact, you should.</b>
</p>
<p>
if you need to extend the 3.3v psu leads, just use the same colour M-F leads, <b>but</b> keep all other
leads short (10cm or less)
</p>
<p>
You should now have something that looks like this:<br/>
<img src="images/x200/5252_bbb0.jpg" alt="" />
<img src="images/x200/5252_bbb1.jpg" alt="" />
</p>
<p>
<a href="#pagetop">Back to top of page.</a>
</p>
</div>
<div class="section">
<h1 id="stability">Notes about stability</h1>
<p>
<a href="http://flashrom.org/ISP">http://flashrom.org/ISP</a>
is what we typically do in libreboot, though not always. That page
has some notes about using resistors to affect stability. Currently,
we use spispeed=512 but it is possible to use higher speeds while
maintaining stability.
</p>
<p>
tty0_ in #libreboot was able to get better flashing speeds with the following configuration:
</p>
<ul>
<li>"coax" with 0.1 mm core and aluminum foley (from my kitchen), add 100 Ohm resistors (serial)</li>
<li>put heatstrink above the foley, for: CS, CLK, D0, D1</li>
<li>Twisted pair used as core (in case more capacitors are needed)</li>
<li>
See this image:
<a href="http://i.imgur.com/qHGxKpj.jpg">http://i.imgur.com/qHGxKpj.jpg</a>
</li>
<li>He was able to flash at 50MHz (lower speeds are also fine).</li>
</ul>
</div>
<div class="section">
<h1>EHCI debugging</h1>
<ol class="toc">
<li><a href="#FindUSBportonthetargetthatsupportsEHCIdebug">Find
USB port on the target that supports EHCI debug</a></li>
<li><a href="#InitialsetupofBBBtoactasEHCIdebugdongle">Initial
setup of BBB to act as EHCI debug dongle</a></li>
<li><a href="#PatchBBBsgdbgpmoduleoptionalbuthighlyrecommended">Patch
BBB's <tt>g_dbgp</tt> module (optional, but highly recommended)</a></li>
<li><a href="#ConfigurelibrebootwithEHCIdebug">Configure
libreboot with EHCI debug</a>
<ol>
<li><a href="#SelectingHCDIndexandUSBDebugport">Selecting
<tt>HCD Index</tt> and <tt>USB Debug port</tt></a></li>
</ol></li>
<li><a href="#Howtogetthedebuglogs">How to get the debug
logs</a></li>
<li><a
href="#EnebleEHCIDebugonthetargetskerneloptionalrecommended">Eneble
EHCI Debug on the target's kernel (optional, recommended)</a></li>
<li><a href="#References">References</a></li>
</ol>
<p>If your computer does not boot after installing libreboot, it is
very useful to get debug logs from it, from the payload (grub) and/or
the kernel (if gets to there). All of them stream debug logs on the
available serial (RS-232) by default. However, most of todays laptops
lack RS-232 port. The other option is to stream the logs to USB EHCI
debug port.</p>
<p>This section explains step-by-step how to setup BBB as a
“USB EHCI debug dongle” and configure libreboot and the
linux kernel to stream logs to it (TODO: grub).</p>
<p>I will refer to three computers:</p>
<ul>
<li><b>host</b> - this is the computer you use, have
tools, compiler, Internet, etc</li>
<li><b>BBB</b> - Beaglebone Black (rev. B or higher, i
use rev. C)</li>
<li><b>target</b> - the computer you are trying to
install liberboot</li>
</ul>
<h3 id="FindUSBportonthetargetthatsupportsEHCIdebug">Find USB port
on the target that supports EHCI debug</h3>
<p>
Not all USB controllers support EHCI debug (see: <a
href="http://www.coreboot.org/EHCI_Debug_Port#Hardware_capability">EHCI
Debug Port</a> ). Even more, if a USB controller supports EHCI debug, it
is available only <b>on a single port</b> that might or might
not be exposed externally.
</p>
<ul>
<li>You need running OS (GNU/Linux) on your target for this step
(If you’ve flashed libreboot and it does not boot, you have to
flush back the stock bios)</li>
<li>You need USB memory stick (the data on it will not be
touched).</li>
<li>The EHCI debugging can not be done through external hub, BBB
must be connected directly to the debug port of the controller (so, no
hubs)</li>
</ul>
<ul>
<li>Download<sup class="footnote"><a href="#___fn1">1</a></sup> <a
href="http://www.coreboot.org/pipermail/coreboot/attachments/20080909/ae11c291/attachment.sh">this</a>
shell script.
</li>
</ul>
<ol>
<li>Plug the usb stick in the first available usb port</li>
<li>Run the script, you will get output similar to following:</li>
<pre>The following PCI devices support a USB debug port (says lspci): 0000:00:1a.0 0000:00:1d.0
The following PCI devices support a USB debug port (says the kernel): 0000:00:1a.0 0000:00:1d.0
*PCI device 0000:00:1a.0, USB bus 3, USB physical port 1*
*PCI device 0000:00:1d.0, USB bus 4, USB physical port 2*
Currently connected high-speed devices:
/: Bus 04.Port 1: Dev 1, Class=root_hub, Driver=ehci-pci/2p, 480M
|__ Port 1: Dev 2, If 0, Class=Hub, Driver=hub/8p, 480M
|__ Port 7: Dev 14, If 0, Class=Hub, Driver=hub/4p, 480M
|__ Port 1: Dev 15, If 0, Class=Hub, Driver=hub/4p, 480M
|__ Port 3: Dev 17, If 0, Class=Hub, Driver=hub/2p, 480M
|__ Port 4: Dev 18, If 0, Class=Hub, Driver=hub/4p, 480M
/: Bus 03.Port 1: Dev 1, Class=root_hub, Driver=ehci-pci/2p, 480M
|__ Port 1: Dev 2, If 0, Class=Hub, Driver=hub/6p, 480M
/: *Bus 01*.Port 1: Dev 1, Class=root_hub, Driver=xhci_hcd/4p, 480M
|__ *Port 3: Dev 31, If 0, Class=Mass Storage, Driver=usb-storage, 480M*
</pre>
<li>The buses the support debug are Bus 3 (0000:00:1a.0) on Port 1
and Bus 4 (0000:00:1d.0) on port 2. Your usb stick is plugged on Bus
1, Port 3</li>
<li>Repeat the steps, plugging the USB stick in the next available
port</li>
<li>Go through all available ports and remember(write down) those
for which bus/port of the usb stick matches one of the bus/port that
support debug (bold).</li>
</ol>
<p>Remember (write down) for each port (external plug) you found
that supports debug: <b>PCI device id, the bus id, the port number, and
the physical location of the usb plug.</b></p>
<p>If you do not find a match, you can not get debug over EHCI.
Sorry.</p>
<p id="___fn1" class="footnote">
<sup>1</sup> The guys from coreboot were talking about including the
script in coreboot distribution (check the status).
</p>
<h3 id="InitialsetupofBBBtoactasEHCIdebugdongle">Initial setup of
BBB to act as EHCI debug dongle</h3>
<p>BBB must be powered with a barrel power connector since the
mini-B USB plug will be used for the EHCI debug stream. So you will
need:</p>
<ul>
<li>power supply (5V, 2A(10W) is sufficient).</li>
<li>an extra usb cable: A to mini-B</li>
</ul>
<p>
(On BBB) The linux kernel includes module (g_dbgp that enables one of the usb ports on a computer to behave as EHCI
debug dongle. Make sure you have this module available on your BBB
(Debian 7.8 that comes with BBB should have it), if not, you should
compile it yourself (see next section):
</p>
<pre>ls /lib/modules/3.8.13-bone70/kernel/drivers/usb/gadget/g_dbgp.ko</pre>
<p>
Unload all other
g_*
modules:
</p>
<pre># lsmod
# rmmod g_multi
...
</pre>
<p>
Then load
g_dbgp
:
</p>
<pre># modprobe g_dbgp
# lsmod # should show that g_dbgp is loaded, and no other g_*
</pre>
<p>
Plug the mini-B side of the USB cable in your BBB and the A side in
your target. Then one of the usb devices on your target (with
lsusb
) should be:
</p>
<pre>Bus 001 Device 024: ID 0525:c0de Netchip Technology, Inc.</pre>
<p>If you see the device on the target, you are good to continue to
the next step.</p>
<h3 id="PatchBBBsgdbgpmoduleoptionalbuthighlyrecommended">
Patch BBB’s
g_dbgp
module (optional, but highly recommended)
</h3>
<p>
For the reasons why you need this, see: <a
href="http://www.coreboot.org/EHCI_Gadget_Debug">EHCI Gadget Debug</a>.<br />Make
sure that you have cross compiling environment for
arm-linux-gnueabihf
setup on your <em>host</em>.
</p>
<ul>
<li>On BBB: uname -r - this will give you version
number like 3.8.13-bone70 (I will refer to this as: $mav.$miv-$lv:
where mav=3.8, miv=13, lv=bone70
</li>
<li>Get the BBB kernel ready on your host for cross-compiling:</li>
</ul>
<pre>$ cd $work_dir
$ git clone https://github.com/beagleboard/kernel.git
$ cd kernel
$ git checkout $mav (see above)
$ ./patch.sh
$ wget http://arago-project.org/git/projects/?p=am33x-cm3.git\;a=blob_plain\;f=bin/am335x-pm-firmware.bin\;hb=HEAD -O kernel/firmware/am335x-pm-firmware.bin
$ cp configs/beaglebone kernel/arch/arm/configs/beaglebone_defconfig
</pre>
<ul>
<li>Download the patch from <a
href="http://www.coreboot.org/images/8/88/Ehci-debug-gadget-patches.tar.gz">here</a></li>
<li>tar -xf Ehci-debug-gadget-patches.tar.gz (will
create dir: usbdebug-gadget)</li>
<li>Note that there are two patches (patch_1 and patch_2) for each
of the two different version of the kernel (3.8 and 3.10). I will use
3.8. (If using kernel 3.12 patch_1 is not needed)</li>
<li>cd kernel (note that this is one more level: you
should be in $work_dir/kernel/kernel)</li>
<li>Apply the patches:</li>
</ul>
<pre>
git apply ../usbdebug-gadget/v3.8-debug-gadget/0001-usb-dbgp-gadget-Fix-re-connecting-after-USB-disconne.patch
git apply ../usbdebug-gadget/v3.8-debug-gadget/0002-usb-serial-gadget-no-TTY-hangup-on-USB-disconnect-WI.patch
;
make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- beaglebone_defconfig -j4@
</pre>
<ul>
<li>
You should also apply the linux-libre <i>deblob</i> script to turn it into linux-libre
(deletes all the blobs from the linux kernel).
<a href="http://www.fsfla.org/ikiwiki/selibre/linux-libre/">fsfla website</a>
- see <a href="http://www.fsfla.org/svn/fsfla/software/linux-libre/scripts/">scripts</a>.
</li>
<li>Get your current BBB kernel config (from: /boot/config-<ver>)
and copy it to your host as $work_dir/kernel/kernel/.config</li>
<pre>
make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- oldconfig - all default answers</pre>
<li>Set proper version number:
<ul>
<li>On your host, edit $work_dir/kernel/kernel/.config
(the one you’ve just copied from BBB), find the line CONFIG_LOCALVERSION="<something
or empty>" and change it to CONFIG_LOCALVERSION="-$lv",
so it will look something like: CONFIG_LOCALVERSION="-bone70"</li>
</ul>
</li>
<li>Also, make sure that: CONFIG_USB_G_DBGP=m (If
not, make menuconfig, and set @Device Drivers-> USB
Support -> USB Gadget Support -> EHCI Debug Device Gadget=m</li>
<li>Build the module:</li>
</ul>
<pre>
$ make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- -j4 (is it possoble to build only the gadget modules)
$ mkdir ../tmp && make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- INSTALL_MOD_PATH=../tmp modules_install
</pre>
<ul>
<li>on BBB, backup /lib/modules/3.8.13-bone70/kernel/drivers/usb/gadget
(i.e. mv
/lib/modules/3.8.13-bone70/kernel/drivers/usb/gadget $HOME)
</li>
<li>copy the freshly compiled usb/gadget dir to /lib/modules/3.8.13-bone70/kernel/drivers/usb</li>
<li>restart BBB</li>
<li>Remove all g_* modules (rmmod
g_<>)
</li>
<li>modprobpe g_dbgp</li>
</ul>
<h3 id="ConfigurelibrebootwithEHCIdebug">Configure libreboot with
EHCI debug</h3>
<p>
Libreboot(coreboot) should be configured with debug turned on and to
push debug messages to the EHCI debug port.<br />If you’ve
downloaded the binary distribution, you can check if it is properly
configured in the following way:
</p>
<ul>
<li>Go to the libreboot dist root directory cd
$libreboot_bin</li>
<li>Locate the rom image for your target (I will call it: $img_path)
</li>
<li>Running the following command will extract the config in a
file ./my_config:
</li>
</ul>
<pre>
./cbfstool/i686/cbfstool $img_path extract -n config -f ./my_config
</pre>
<ul>
<li>Make sure that the following params in the config are set as
following:</li>
</ul>
<pre>
CONFIG_USBDEBUG=y (Generic Drivers -> USB 2.0 EHCI debug dongle support)
CONFIG_USBDEBUG_IN_ROMSTAGE=y (Generic Drivers -> Enable early (pre-RAM) usbdebug)
CONFIG_USBDEBUG_HCD_INDEX=<HCD Index of usb controller - see below> (Generic Drivers -> Index for EHCI controller to use with usbdebug)
CONFIG_USBDEBUG_DEFAULT_PORT=<USB Debug port - see below> (Generic Drivers -> Default USB port to use as Debug Port)
</pre>
<p>
The following three are behind radio button in the menu. Only the first
one<sup class="footnote"><a href="#___fn2">2</a></sup> should be = y
</p>
<pre>
USBDEBUG_DONGLE_STD=y (Generic Drivers -> Type of dongle (Net20DC or compatible) -> Net20DC or compatible)
CONFIG_USBDEBUG_DONGLE_BEAGLEBONE=n (Generic Drivers -> Type of dongle (Net20DC or compatible) -> BeagleBone)
CONFIG_USBDEBUG_DONGLE_BEAGLEBONE_BLACK=n (Generic Drivers -> Type of dongle (Net20DC or compatible) -> BeagleBone Black)
</pre>
<p id="___fn2" class="footnote">
<sup>2</sup> The g_dbgp module on BeagleBone Black (Rev. C) reports it self as Net20DC, the
other options are for older BB(B) - ver1. This is documented <a
href="https://johnlewis.ie/coreboot-ehci-debug-gadget-demonstration/">here</a>
(also tested/verified).
</p>
<p>
Then:<br />
<pre>
CONFIG_CONSOLE_USB=y (Console -> USB dongle console output)
</pre>
</p>
<p>
Also
Debugging ---> Output verbose XYZ
) (<b>FIXME</b> somebody verify these):
</p>
<pre>
CONFIG_DEBUG_CBFS=y (Output verbose CBFS debug messages )
CONFIG_HAVE_DEBUG_RAM_SETUP=y (??? What/where is this)
CONFIG_DEBUG_RAM_SETUP=y (Output verbose RAM init debug messages)
CONFIG_DEBUG_SMI=y (Output verbose SMI debug messages)
CONFIG_DEBUG_ACPI=y (Output verbose ACPI debug messages )
CONFIG_DEBUG_USBDEBUG=y (Output verbose USB 2.0 EHCI debug dongle messages)
</pre>
<p>If some of the above mentioned configuration options are not as
specified, you have to configure and compile libreboot yourself. Please
refer to the doc(<b>FIXME: link</b> about compiling libreboot.</p>
<h4 id="SelectingHCDIndexandUSBDebugport">
Selecting
HCD Index
and
USB Debug port
</h4>
<p>
This applies (and works) only if the USB controller that supports debug
(found in the first section) is from Intel.<br />If the PCI ID of the
port you found in the first section is
0000:00:1a.0
or
0000:00:1d.0
, you are ok. Otherwise you have to try without guarantee that will
work.
</p>
<p>
If the externally exposed port is on a bus with
PCI ID == 0000:00:1a.0
then for
CONFIG_USBDEBUG_HCD_INDEX
choose 2, otherwise choose 0
.
</p>
<p>
For
CONFIG_USBDEBUG_DEFAULT_PORT
choose the port from the first section that correspond to the
PCI ID
</p>
<p>
Notes:<br />The above is based on the implementation of
coreboot/src/southbridge/intel/common/usb_debug.c : pci_ehci_dbg_dev()
.<br />This is enough as it applies for the supported GM45/G45
Thinkpads. coreboot support some other contollers too, but they are
irellevent for libreboot (for now).
</p>
<ul>
<li>On T500 (with switchable GPU) the debug ports for both intel
controllers is exposed.</li>
<li>On x200t the debug ports for both intel controllers is
exposed.</li>
</ul>
<h3 id="Howtogetthedebuglogs">How to get the debug logs</h3>
<ul>
<li>Plug the USB cable in the target’s debug port (the one
you found in step 1) and BBB’s mini-B USB</li>
<li>Make sure no other then g_dbgp of the g_*
modules is loaded on your BBB
</li>
<li>On the BBB:</li>
</ul>
<pre>
stty -icrnl -inlcr -F /dev/ttyGS0
cat /dev/ttyGS0
</pre>
<ul>
<li>Power on the target with libreboot</li>
<li>You should see debug logs comming on your BBB console</li>
</ul>
<p>
Note that this is not permanent on BBB, if you reboot it, you have to
rmmod g_*
and
modprobe g_dbgp
</p>
<h3 id="EnebleEHCIDebugonthetargetskerneloptionalrecommended">Eneble
EHCI Debug on the target’s kernel (optional, recommended)</h3>
<p>You have to know how to compile kernel for your target.</p>
<ol>
<li>Check if early debugging is already enabled: grep
CONFIG_EARLY_PRINTK_DBGP /boot/config-<ver></li>
<li>If enabled, you do not have to compile the kernel (skip this
step). Otherwise, prepare kernel source for your distribution and
select (Kernel hacking -> Early printk via EHCI debug
port). Compile and install the new kernel.
</li>
<li>Edit your grub configuration and add following to the kenel
parameters<sup class="footnote"><a href="#___fn20">20</a></sup><sup
class="footnote"><a href="#___fn21">21</a></sup>: earlyprintk=dbgp,keep.
Also, try: earlyprintk=dbgp<N>,keep where N
is the debug port id if the first does not work.
</li>
</ol>
<h3 id="References">References</h3>
<p id="___fn10" class="footnote">
<sup>10</sup> <a href="http://www.coreboot.org/EHCI_Debug_Port">EHCI
Debug Port</a>
</p>
<p id="___fn11" class="footnote">
<sup>11</sup> <a
href="https://johnlewis.ie/coreboot-ehci-debug-gadget-demonstration/">coreboot
EHCI debug gadget demonstration</a>
</p>
<p id="___fn12" class="footnote">
<sup>12</sup> <a href="http://www.coreboot.org/EHCI_Gadget_Debug">EHCI
Gadget Debug</a>
</p>
<p id="___fn13" class="footnote">
<sup>13</sup> <a
href="http://www.coreboot.org/images/8/88/Ehci-debug-gadget-patches.tar.gz">Ehci-debug-gadget-patches.tar.gz</a>
</p>
<p id="___fn14" class="footnote">
<sup>14</sup> <a
href="http://wiki.beyondlogic.org/index.php/BeagleBoneBlack_Building_Kernel">Compiling
the BeagleBone Black Kernel</a>
</p>
<p id="___fn15" class="footnote">
<sup>15</sup>
http://dumb-looks-free.blogspot.ca/2014/06/beaglebone-black-bbb-compile-kernel.html
</p>
<p id="___fn16" class="footnote">
<sup>16</sup>
http://dumb-looks-free.blogspot.fr/2014/06/beaglebone-black-bbb-kernal-headers.html
</p>
<p id="___fn17" class="footnote">
<sup>17</sup> <a href="http://elinux.org/Building_BBB_Kernel">Building
BBB Kernel</a>
</p>
<p id="___fn18" class="footnote">
<sup>18</sup>
http://komposter.com.ua/documents/USB-2.0-Debug-Port%28John-Keys%29.pdf
</p>
<p id="___fn19" class="footnote">
<sup>19</sup> <a href="http://cs.usfca.edu/~cruse/cs698s10/">Exploring
USB at the Hardware/Software Interface</a>
</p>
<p id="___fn20" class="footnote">
<sup>20</sup>
https://www.kernel.org/doc/Documentation/x86/earlyprintk.txt
</p>
<p id="___fn21" class="footnote">
<sup>21</sup> https://wiki.ubuntu.com/Kernel/Debugging/USBearlyprintk
</p>
<p>
<b>TODO</b>:
</p>
<ol>
<li>grub does not send messages to EHCI debug. Investigate.</li>
<li>The section “Configure libreboot with EHCI debug”
can be skipped/simplified if a common configuration works for all
relevant targets is selected as defualt</li>
<li>Patch and compule g_dbgp on BBB instead cross-compile</li>
<li>Find a simple way to send debug messages from targets userland</li>
</ol>
</div>
<div class="section">
<p>
Copyright © 2014, 2015 Francis Rowe <info@gluglug.org.uk><br/>
Copyright © 2015 Patrick "P. J." McDermott <pj@pehjota.net><br/>
Copyright © 2015 Alex David <opdecirkel@gmail.com><br/>
This document is released under the Creative Commons Attribution-ShareAlike 4.0 International Public License and all future versions.
A copy of the license can be found at <a href="../license.txt">../license.txt</a>.
</p>
<p>
This document is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See <a href="../license.txt">../license.txt</a> for more information.
</p>
</div>
</body>
</html>
|
