[brcm63xx] rework imagetag firmware generator and MTD partition parser to accomodate...
[openwrt.git] / target / linux / brcm63xx / image / README.images-bcm63xx
1 The image neede to flash onto a Broadcom 63xx-series board depends on the
2 board, method you are using to flash, and, for web-based flash, on the version
3 of the Broadcom code your router uses.
4
5 There are two major revisions of the Broadcom code as far as imagetags are
6 concerned, before 3.08 and after 3.08, however there are some variations 
7 within in that, either due to vendor differences or due to changes at 
8 Broadcom (it's not clear yet which is the case).  In addtion Pirelli modified
9 the Broadcom code, so Alice Gate models use a different imagetag than any 
10 other vendor.
11
12 The imagetag format for flashing via CFE is the same for almost all the 
13 boards, and is the same for all images generated by the imagetag utility.
14 Images flashable using cfe are labelled openwrt-<board>-<filesystem>-cfe.bin
15
16 The imagetags for tftp/ftp flashing is based on Broadcom 3.00-3.04 imagetags
17 and is known to be correct as the source code GPL and is available for reading.
18
19 Broadcom 3.00-3.02 flashing has been tested on Comtrend CT-5261, CT-536 and 
20 Tecom GW6000, and is the version of the flashing that was present before the
21 imagetags were split by broadcom code version (early June 2009)
22
23 3.04 is guessed to be the same as 3.00-3.02 based on available information
24
25 Broadom 3.06 is thought to be the same as 3.00-3.02, however the only 3.06 
26 this author (Daniel Dickinson) has seen is the Alice Gate (Pirelli) firmware
27 which is known to be different due to vendor (Pirelli) modifications to the
28 Broadcom code.
29
30 Broadcom 3.08 introduced changes to the imagetag to deal with TR69 (a remote
31 router management system developed by the DSL Forum).  The version we are
32 using as 3.08 is based on the BT Voyager firmware image I looked at.  It may
33 in fact be BT Voyager-specific, and may in fact not be 3.08, but modified 3.06
34 and not apply to all 3.08 versions.
35
36 Broadcom 3.10 uses an imagetag that is believed to apply to all 3.10 and 3.12
37 versions, and has been tested on the Tecom GW6200.  It is similar to 3.08.  
38 There is a field for vendor-specific information, that at least in some cases
39 is not optional.  It is based on the hexedit of a neufbox4 firmware image, the
40 information in https://dev.openwrt.org/ticket/4987, and the hexedit of a Tecom
41 GW6200 image.
42
43 Some boards share the same tag format, but require vendor-specific fields in
44 the board.  In that case the tagid is shared, but the filename of the generated
45 image reflects the router for which the image was created.
46
47 router     |method| codever |tagid |filename
48 +----------+------+---------+------+-------------------------------------------
49 |any       |cfe   |   any   |bccfe |openwrt-<board>-<filesystem>-bccfe-cfe.bin
50 |any       |t/ftp |   any   |bc300 |openwrt-<board>-<filesystem>-bc300-cfe.bin
51 |          |web   |3.00-3.06|bc300 |openwrt-<board>-<filesystem>-bc300-cfe.bin
52 |          |web   |3.08     |bc308 |openwrt-<board>-<filesystem>-bc308-cfe.bin
53 |          |web   |3.10-3.12|bc310 |openwrt-<board>-<filesystem>-bc310-cfe.bin
54 |CT536     |web   |3.02     |bc300 |openwrt-<board>-<filesystem>-bc300-cfe.bin
55 |CT5621    |web   |3.02     |bc300 |openwrt-<board>-<filesystem>-bc300-cfe.bin
56 |GW6000    |web   |3.00     |bc300 |openwrt-<board>-<filesystem>-bc300-cfe.bin
57 |USR9108?  |web   |?        |bc300 |openwrt-<board>-<filesystem>-bc300-cfe.bin
58 |USR9108?  |web   |?        |bc310 |openwrt-<board>-<filesystem>-bc310-cfe.bin
59 |DG834GT   |web   |3.02     |bc300 |openwrt-<board>-<filesystem>-bc300-cfe.bin
60 |V2500V    |web   |3.08     |bc308 |openwrt-<board>-<filesystem>-btvgr-cfe.bin
61 |GW6200    |web   |3.10     |bc310 |openwrt-<board>-<filesystem>-gw6200-cfe.bin
62 |Neufbox4  |web   |3.12     |bc310 |openwrt-<board>-<filesystem>-nb4-cfe.bin
63 |F@ST2404  |web   |?        |bc300 |openwrt-<board>-<filesystem>-bc300-cfe.bin
64 |F@ST2404  |web   |?        |bc310 |openwrt-<board>-<filesystem>-bc310-cfe.bin
65 |AGVoIP2+Wi|web   |alice3.06|ag306 |openwrt-<board>-<filesystem>-agv2+w-cfe.bin
66
67 Old imagetag routers
68 --------------------
69 Davolink DV201AMR
70
71 Redboot routers
72 ---------------
73 Inventel Livebox
74
75 Known router->code versions
76 ---------------------------
77
78 Vendor                     |Model                                     |Code Ver
79 ---------------------------+------------------------------------------+--------
80 Comtrend                   |CT-5261                                   |3.02
81 Comtrend                   |CT-536                                    |3.02
82 Tecom                      |GW6000                                    |3.00
83 Tecom                      |GW6200                                    |3.10
84 Pirelli                    |Alice Gate Wi-Fi (+VoIP models?)          |ag 3.06
85 ?                          |TD-88xx                                   |3.06
86 BT                         |Voyager V2500V                            |3.08 (?)
87 Belkin                     |F5D7633                                   |3.10
88 Neuf ?                     |Neufbox 4                                 |3.12
89 NetGear                    |DG834GT                                   |3.02
90 Sagem                      |F@ST2404                                  |?
91 USR                        |9108                                      |?