From 4af7255440f92013de7fd5904750885ddc0be0c2 Mon Sep 17 00:00:00 2001
From: icex2 <djh.icex2@gmail.com>
Date: Sat, 31 Oct 2020 15:26:02 +0100
Subject: [PATCH] Cleanup ezusb firmware folder and improve readme

---
 .../{v1/ezusb_v1.bin => C02-v1/ezusb.bin}     | Bin
 .../{v1/fpga_v1.bin => C02-v1/fpga.bin}       |   0
 .../{v2/ezusb_v2.bin => C02-v2/ezusb.bin}     | Bin
 .../{v2/fpga_v2.bin => C02-v2/fpga.bin}       |   0
 iidx/ezusb/firmware/{v2 => C02-v2}/sram.bin   | Bin
 iidx/ezusb/firmware/D01/ezusb.bin             | Bin 0 -> 7106 bytes
 .../{v1/fpga_d01.bin => D01/fpga.bin}         |   0
 iidx/ezusb/firmware/README.md                 |  28 ++++++++++--------
 8 files changed, 16 insertions(+), 12 deletions(-)
 rename iidx/ezusb/firmware/{v1/ezusb_v1.bin => C02-v1/ezusb.bin} (100%)
 rename iidx/ezusb/firmware/{v1/fpga_v1.bin => C02-v1/fpga.bin} (100%)
 rename iidx/ezusb/firmware/{v2/ezusb_v2.bin => C02-v2/ezusb.bin} (100%)
 rename iidx/ezusb/firmware/{v2/fpga_v2.bin => C02-v2/fpga.bin} (100%)
 rename iidx/ezusb/firmware/{v2 => C02-v2}/sram.bin (100%)
 create mode 100755 iidx/ezusb/firmware/D01/ezusb.bin
 rename iidx/ezusb/firmware/{v1/fpga_d01.bin => D01/fpga.bin} (100%)

diff --git a/iidx/ezusb/firmware/v1/ezusb_v1.bin b/iidx/ezusb/firmware/C02-v1/ezusb.bin
similarity index 100%
rename from iidx/ezusb/firmware/v1/ezusb_v1.bin
rename to iidx/ezusb/firmware/C02-v1/ezusb.bin
diff --git a/iidx/ezusb/firmware/v1/fpga_v1.bin b/iidx/ezusb/firmware/C02-v1/fpga.bin
similarity index 100%
rename from iidx/ezusb/firmware/v1/fpga_v1.bin
rename to iidx/ezusb/firmware/C02-v1/fpga.bin
diff --git a/iidx/ezusb/firmware/v2/ezusb_v2.bin b/iidx/ezusb/firmware/C02-v2/ezusb.bin
similarity index 100%
rename from iidx/ezusb/firmware/v2/ezusb_v2.bin
rename to iidx/ezusb/firmware/C02-v2/ezusb.bin
diff --git a/iidx/ezusb/firmware/v2/fpga_v2.bin b/iidx/ezusb/firmware/C02-v2/fpga.bin
similarity index 100%
rename from iidx/ezusb/firmware/v2/fpga_v2.bin
rename to iidx/ezusb/firmware/C02-v2/fpga.bin
diff --git a/iidx/ezusb/firmware/v2/sram.bin b/iidx/ezusb/firmware/C02-v2/sram.bin
similarity index 100%
rename from iidx/ezusb/firmware/v2/sram.bin
rename to iidx/ezusb/firmware/C02-v2/sram.bin
diff --git a/iidx/ezusb/firmware/D01/ezusb.bin b/iidx/ezusb/firmware/D01/ezusb.bin
new file mode 100755
index 0000000000000000000000000000000000000000..7c46401fc3d2e000e761578d10358242eb1fc762
GIT binary patch
literal 7106
zcmb7JeQ+Gbm7ks2U42+stJ#r^ERx8hF%jRvHg_ZtykKF3!zBw|;Noz2h~@Kz{NcT-
z-Ksdd+L=fxC!tK3Bt9d9Edla}z!pw|p+YJYYs-8Ul(kimgi5g8Rmdq@pHpC6?3J{8
zzt^*~yRze}JJoi->DRAczxVpR?$@n<jsyfrSS5(n_ew&GAU3`$3AX`UkOV=Hg{!|Q
ztZb4!0Z%@k58dOtMHK{}D0r&G8wHO?Ftb%&LG<Q@ytl&VkphCJ!q?>hNel@>h404>
z_^C$_(N{^J5%XDd`}<FK-Q69%pgt8aC0US82kHaSzpH|GwP1yW5!(uRP(&07#f##z
zRV(DDo(hyolq!^Jlm#d?C|95?M5#pypw!t`;x{P2MR^V7Fv_bauh?pQK(LHIvB>As
zb*t)X@Oc`<KUf3qKe*4fj9<mT&)5}v1@-n=67}wwiTb}{!>D^>&363fb(XP%BcF~z
z)Wlx;P7D%<hhvb}cphlEafiI9-AWt+I`J})hfrRQK_%m4tRD5jSRVDM7*sF@`S<Tw
z8?-k5Kp=j`6F)CliJg3gACK7mU_)gON-s(u$}W`MD9@toL)nk=9Ln=3FQELAkJ`@b
z9k!JW(O0sK*X_Ix)5OX9Q6Au5Yw;C<#K{Ly9^$Bn@%68y#6gq+uPqC!WkI(RPZMqs
zs!tCT>?yC3{bWzsmX+0V!;|urGGt)cem1j4AGZ?Q`6r=f``Mg!W^R0iH2dMiv*XW%
zTddY*;^)Zv%h;FgSb(%0VEQXmE4F#yVg^He<aUgNjm&MTWt?S){kK`h7@Je{8bz<w
za(bPjE9R0^ld;kapuXR%M!nATqTXN`A5FsEf1HAQC1@!D`j`@xMCn^vjzCJg0N{Os
zaK4B(OSoBTcvn*G|AH3O0Y0-jL+o%)H0gVbcot20ah73WvMg@jv1ibe6mH0$wr|f_
z&Bx^?Y1FPdtEIz#1_ARz%V*hPpEDTWBev-O8fWOam|^y;)tmxnKK_&N8LT=S$|V;s
zCbv58%(A(pVBC=s<fdy6`Ufixc~U}JOncM5PB96jI#_YgpQ*_B<;5Rc%|J*Qu^`>+
zBo}8fGy1CJFOyYrW!+ykdqIJc_7FDYbA_D_pV_j&wF~uBxIN?HGp+(Y@pEal_hKW?
zSAtAAp&f_o_-BhU7bN}wF^^Sr*#%sCScxaN=f(2tv`nboN_Mb_M{jb)L3ftr`dQw}
zkO4+*v+>fd=bWx85X(&qY4u*Tl8<7EpO|%dXU9K$Cd9oVxxUm<!X}>JQB0$f9a)HA
zCD(B)SVZrl9x0$Y;2Ewa-h#n9?<Ak%4x_ypzJf1MqGxD($TqP)J+Y9zMKo_I3IBFM
zFD=9MvJ!7YcGO(r(GKw&(F(LkD(Kb2vS){$2^}G>+MA9d<c-c&bIh?2=ftLWT8a4x
zj5@}7A1m_KxhWFIh`k#kp?|m};Y!RwZvPp!OGc5qT+zRw=o>`;r{!zMLV8Izcg;eD
zHQRV;S7FV}HJ5g|D}B>E{$ZE{g8ZZPH!og)GSGFF@ji@>ZG$3(j)GpM=!+G773~fc
zC$#ebmG@{_fU1yKeJcW%!7ljd6k;+~s}RsIJuq%aAhN~EmGfwEL^Z#QIdDESzXvD*
zrU9{gG`|D5z~17c&@kSoP*<H$p3ikUd~%CuB@VEe9|}B*uFH>qEmznEI`h~K7N4@3
z$y18s*yFTOoeRGwR^N=%r6jrv(Mjpj=JJyN0N-57wv|KD%VIG^i#!Xl%H6E6_er+&
z)k^Y=>br2J!4WVU>~k0Fnda_fC64kVV`yym=&tb9R^kZaU?|JZc{Kr!do2iin06!t
z`}V*X9t{C;y*r4QP;|pAQ`(Wq75Pvd27|$oEE{^pp(btSPc`<cuXglRFYQ^hE^vw!
z#E@?j>O3QjV)mol_m38RpW^B$k1N_K`pHzJ>m^e-N@E`9qo6p2ak*b+!Zk%P#A*b~
z{2(DrX@f(MP?HPFW24OS=J$$SJT}U^zFF+zu~FW&d>;Ss0^~EaE%YK#ii3E3lnp9v
zln9incGm(WIWyq~mk*3v4Kx2R1dIJ;)-v9pm`by>o$g9^r-if!CzeEKR@$GgNN3_1
z0Xf{-UrbrX0oI17Gms^;XtVk{jUmu#Zs+H8V6}D*t-5D<t8Two_j@O2G0w1v9&M7v
zZYw45yz6z!vEXo&kG(<PiKmHC-7A)Hn6=@6rJ-GXi7j4l=XE!W7|}&Y(O3t<5#XHF
zirf<)k<XDc-H$yz4EO*bC0J_#9{_w95NTGc2uQgV;UCVj$9auZYaMW5770a{6A!@a
zhzDQ`Isx@2ByuD`GD63g9|;|A-ADcgld>pSwQ*Nmqp!D;?Yy_0BeW|=SImZ&BE4gg
z9On5pi%fBV^ct{DUi>!<AVwyL3S(+USLCo*7(>R!m^Nq$z{gOAb`3I9rsH7Q%i1Ut
z?#F`SaM}y|P>Wl1FGJ3Z7K~OKt-(Ppc(18pkUsGn3Jt7eWR4p;6+&ntiA~X2_dMWg
z*yr1rkZW7-$P8iV06i8VLDo20Us;qX)ehMpW9nW&?3}4JWT+}6uGW8gNE$+jI$U&+
zbTJXEgWM2=_ZINjLLB^?VE-JmTEQssJfMv6cd`~7--#C@#Oy8zicCDU3Xrn#9n4DI
zg9X(wemh^3)II1T?RVjLXrr^?ir?}CbD=_wg&o{S7rvm)QEP;^YOA#jTD5=G?!t)?
z_$NdV1zle(XY<x>u&PybRnc!$^c9MJGso`Z#_okhQ*D^@fJ3`4hI1p)i#|@&=YH%4
z$v&4Il4bC_2H<w=_1J}JPQK?CC+|hR2b?>6erF#ggO`r!!;OfecQdfY*}jMieG|uV
zm3nanDz*CDR@(9Bqm(`nTb@WDU2)rFfNF=O3<BIqI9Xq;meX_nUxOX)hLZgH=a?_x
zN&}auAg>~)PV6R!;7y7PYI+O3WH~e|u@;bmybyj$@;FP2J~{-?q$Fh6xY|tGQ;5RW
zC9aJ~$|gm>R?)voOI`bx=5v-axydncauXe^#ClU<OgTp6b0s$*20F4VpArh^>*(fa
z&1AI7N^ZmjjE~-k(R|U9k2*>x*F*AR%GvQ1y^<1NEBP2=h7w>W`-D*nElNBc6IDAL
zAsB{i!nSB`ASl`9cgPm7`2t06QS`4X`rT%`<7v3v7AE5fYHzI0HgCXg<Vuw&Bj}^f
zfR*_5h;&T=1hOfZK5AkgcqfLyHD01CFm1c70)k0^K|O#_kao=!Ey)W^k|OCy2rH6h
zQpAjy*IJ=wYzix_l!SyJ8FDg*ln>`~vEd)X+rSdApmzin5N`>It^#EhI-|tD8Y4CW
z;%1)Q2%%DV5xD5={(jUuP63{(as0<gdnvW1t8IBN35(q&P$2d?%}}99Zy7C^irz0Y
zKzhSi3Rnv=+AL&6U#fkkU#DgCo2`@=8|yO43-Jkpee7_)1pwHqC{zh+%2+Drizf=4
z(s-R)^+nbOf-lM9+uXvHwi%TD7c2vKz6;W6=ZHH!kjc=kFyqU3Gq@6FJQ*R=o$1Qh
z8MaKg=noG=|NlQ#t{cZsmE|SQ4_~dtuVu1a`l09ci+(`eSN>Ctyp`Akr^b2Qs>K8w
z^l+>xMZXG2{qJVI)w;AC?c-=rsV;ph=+SVf3JuPw?yuyca;w`}Y^PvgK4)+^IE<^V
z{G#cX<ssPO<fK|ay+)`H9aLw9As}l{36ry|W_fVvliAG?&+Jq%KdyVHI=1B(PIgpA
zKkYwpati8gHkQlsr=67;;M*z(CwyD&{u9%{Q{La9L=`z0q||?Nw3-gsexytzs!@$z
z#B2Yl*_g?hd;lg!EmZ<4tJ&;qW_d7_KlN?xKXI-^^B~deB^u}y^}#BpMAqO&DYHY}
zIGb+>LZm98nPZFkVQE+nz7L~&huh3y*zM%R)VOqoqVkSU=696lhlR^zEK^w}Klkbl
z3LbJ4y;0G>sOYVVemzb+MZe8_0I8rHyu<uDL8ZmKg}1vgDCVaPXb*y8$p|1kzmfOt
z=M2p{Szb?Vd2@Wgq##mwWKIu^s31RRU(Tgf-&V`mN!1QE*4Av#$jTdII5arKSu%6E
zfxvUR<I9hSD#nm^&6t&A2)s)Mj1iYpY1QR=Ifk5WxMkS4mHD<JFO+IcFVQj-KKA5W
zd>U84vB)VdB`ms^%|J&smr5I=to&&rH)d4I^_~<e+&lM<*;8t&$MB;oB^X}xxUv*^
zq|E=dn@=${%O{cR-vBkAr_Ib6m1E#HUVtUpU=Pk5cI9S;ktx|dPi-!E{U=;9HNF+T
zc97wUyR<7T`nspP;E_ORKME~iv@PyOZPIHo-b1mJmhJ2E(j9$2_EQ{OUsm*bMPFjx
zK&xNhBR4!WWy=kZn_r-I!$WzweukPzXMe%8Y#13T1{QroY&bzS7K9fo2K--oUGRMI
zY&*{HhCi!T^1HOZ60llTJ02A16WM}`F=}u(Z}^DQVVf<`8NW*{AZ%+3i%1<Fz0wyv
z9n|K+M^6V2OX7$c^FVax7*A}Y44=+-I@^<UQTPtZBPjodqN6-Umzd;tNsJ9B9Vq{f
zvI!^W)i$zUoN$Qfr-IOx1c=O_vmmb`yrjfD)xqUMf0=zSI9-oC7+vs16L}Fx>Av8Q
zj^uN$9wmJZZ&AC*De=Oh5@(-sTG7sj_tH5yJ%IOjla44w5Aaz27tM>jsBxLtcq`t^
z<%UVUk&+E$xsA7Sqlm~t$T%KKcPJa74o(5xus@MT&<<a`V*~B%NbTW0GdzXg>8uLJ
z*IS8g&ehnt<mTl?JI!Db>0F8l2^7CJ(I_WTLKeAg-cw)r5!je_Q|46arU$=p2-G}(
zP3q*6$;TLovy5I+7a4qlf(H5sTx%yB7WcUg+;P#2!D$?04dM>*wj(irdYeFp`-peG
zpItc9A>K=m4g3)gjxzsM?sCs`AS}zSF^c?(XV&qbnDLLz_|KZ-KMmpk9PyrTJROcd
z`QLOMr^|TZ@*VR$*rWT__T<c}n21klZO@z|G4ck=6WFrCfXm$8!62>UxyE^#vG|M1
z=_3##O=btWs2sJNn*d+PwdtJMfjQIqqifTc^BAWjBW3Y#hVMnaqyM3|{a@|i4(C?H
zM1?B`CZfEMy!A3^5L;F!TrG@DXW~DqmxZhFA|VSenYm5E$BQR!%8%cXQzzEv#~;n9
zFLxj6>StQs9-i*{c{f{;w{z;!u4%q;sZ;bdc}w?nw@c@7=>*UXP3_K4?#iiYd*Ug3
Z&+uFJ2YaqR{-nL<#$3i$J;GIj`ajnv7kvN#

literal 0
HcmV?d00001

diff --git a/iidx/ezusb/firmware/v1/fpga_d01.bin b/iidx/ezusb/firmware/D01/fpga.bin
similarity index 100%
rename from iidx/ezusb/firmware/v1/fpga_d01.bin
rename to iidx/ezusb/firmware/D01/fpga.bin
diff --git a/iidx/ezusb/firmware/README.md b/iidx/ezusb/firmware/README.md
index 8ff0677..f9b1981 100644
--- a/iidx/ezusb/firmware/README.md
+++ b/iidx/ezusb/firmware/README.md
@@ -1,18 +1,22 @@
 # Firmware binaries Ezusb (legacy): C02 and D01 IO
 Firmware binary blobs. Requires appropriate tools from BT5 to load them to the
-hardware. There are two revisions of firmware images, **v1** and **v2**. 
+hardware. Pick the binary blobs according to your hardware.
 
-Firmware types:
-* `ezusb_XX.bin`: Base firmware which always needs to be uploaded to the board first.
-* `fpga_XX.bin`: FPGA firmware, needs to be uploaded after the base firmware.
-* `sram.bin`: SRAM dump with contents that need to be uploaded as well, only
-relevant when using **v2** files.
+Important: Do not mix different binary blobs from different packages.
 
-**v1** was used on IIDX 9 to 13 and **v2** on IIDX 14 to 24. It does not matter
-which revision of the base firmware and FPGA image as long as you do not mix
-different versions.
+## C02-v1
+Base firmware (`ezusb.bin`) and FPGA program (`fpga.bin`) which were used on IIDX 9 to 13 with the
+C02 IO board.
 
-Still, we recommend using the **v2** binaries as they are, from a development
-standpoint, the latest "update".
+## C02-v2
+Base firmware (`ezusb.bin`), FPGA program (`fpga.bin`) and SRAM contents (`sram.bin`) that are
+written to the C02 IO board on IIDX 14 to 24. Note that all three binary images need to be written
+to the IO using appropriate tooling. 
 
-Exception for D01 boards: Use the `ezusb_v1.bin` and `fpga_v1.bin`, only.
\ No newline at end of file
+There have been reports that not all C02 IO boards support the v2 binary data set (apparently, 
+there are different revisions of the board). Therefore, if v2 doesn't work for you, fallback to the
+v1 binary set.
+
+## D01
+Base firmware (`ezusb.bin`) and FPGA program (`fpga.bin`) which were used on IIDX 9 to 13 with the
+D01 IO board.