1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (C) 2004 Manuel Novoa III <mjn3@codepoet.org>
8 * This is a hacked replacement for the 'addpattern' utility used to
9 * create wrt54g .bin firmware files. It isn't pretty, but it does
13 * -v allows setting the version string on the command line.
14 * -{0|1} sets the (currently ignored) hw_ver flag in the header
15 * to 0 or 1 respectively.
20 * Modified by rodent at rodent dot za dot net
21 * Support added for the new WRT54G v2.2 and WRT54GS v1.1 "flags"
22 * Without the flags set to 0x7, the above units will refuse to flash.
25 * -{0|1|2} sets {0|1} sets hw_ver flag to 0/1. {2} sets hw_ver to 1
26 * and adds the new hardware "flags" for the v2.2/v1.1 units
31 * Modified by juan.i.gonzalez at subdown dot net
32 * Support added for the AG241v2 and similar
35 * -r #.# adds revision hardware flags. AG241v2 and similar.
37 * AG241V2 firmware sets the hw_ver to 0x44.
41 * Convert 2.0 to 20 to be an integer, and add 0x30 to skip special ASCII
42 * #define HW_Version ((HW_REV * 10) + 0x30) -> from cyutils.h
53 /**********************************************************************/
55 #define CODE_ID "U2ND" /* from code_pattern.h */
56 #define CODE_PATTERN "W54S" /* from code_pattern.h */
57 #define PBOT_PATTERN "PBOT"
59 #define CYBERTAN_VERSION "v3.37.2" /* from cyutils.h */
61 /* WRT54G v2.2 and WRT54GS v1.1 "flags" (from 3.37.32 firmware cyutils.h) */
62 #define SUPPORT_4712_CHIP 0x0001
63 #define SUPPORT_INTEL_FLASH 0x0002
64 #define SUPPORT_5325E_SWITCH 0x0004
65 /* (from 3.00.24 firmware cyutils.h) */
66 #define SUPPORT_4704_CHIP 0x0008
67 #define SUPPORT_5352E_CHIP 0x0010
68 /* (from WD My Net Wi-Fi Range Extender's cyutils.s) */
69 #define SUPPORT_4703_CHIP 0x0020
71 struct code_header
{ /* from cyutils.h */
75 char id
[4]; /* U2ND */
76 char hw_ver
; /* 0: for 4702, 1: for 4712 -- new in 2.04.3 */
78 unsigned char sn
; // Serial Number
79 unsigned char flags
[2]; /* SUPPORT_ flags new for 3.37.2 (WRT54G v2.2 and WRT54GS v1.1) */
80 unsigned char stable
[2]; // The image is stable (for dual image)
81 unsigned char try1
[2]; // Try to boot image first time (for dual image)
82 unsigned char try2
[2]; // Try to boot image second time (for dual image)
83 unsigned char try3
[2]; // Try to boot image third time (for dual_image)
84 unsigned char res3
[2];
95 struct board_info boards
[] = {
101 .flags
= {0x3f, 0x00},
108 .flags
= {0x3f, 0x00},
112 .pattern
= "WDHNSTFH",
115 .flags
= {0x3f, 0x00},
117 /* Terminating entry */
122 /**********************************************************************/
124 void usage(void) __attribute__ (( __noreturn__
));
128 fprintf(stderr
, "Usage: addpattern [-i trxfile] [-o binfile] [-B board_id] [-p pattern] [-s serial] [-g] [-b] [-v v#.#.#] [-r #.#] [-{0|1|2|4|5}] -h\n");
132 static time_t source_date_epoch
= -1;
133 static void set_source_date_epoch() {
134 char *env
= getenv("SOURCE_DATE_EPOCH");
138 source_date_epoch
= strtoull(env
, &endptr
, 10);
139 if (errno
|| (endptr
&& *endptr
!= '\0')) {
140 fprintf(stderr
, "Invalid SOURCE_DATE_EPOCH");
146 struct board_info
*find_board(char *id
)
148 struct board_info
*board
;
150 for (board
= boards
; board
->id
!= NULL
; board
++)
151 if (strcasecmp(id
, board
->id
) == 0)
157 int main(int argc
, char **argv
)
159 char buf
[1024]; /* keep this at 1k or adjust garbage calc below */
160 struct code_header
*hdr
;
165 char *pattern
= CODE_PATTERN
;
166 char *pbotpat
= PBOT_PATTERN
;
167 char *version
= CYBERTAN_VERSION
;
168 char *board_id
= NULL
;
169 struct board_info
*board
= NULL
;
178 fprintf(stderr
, "mjn3's addpattern replacement - v0.81\n");
180 hdr
= (struct code_header
*) buf
;
181 memset(hdr
, 0, sizeof(struct code_header
));
183 while ((c
= getopt(argc
, argv
, "i:o:p:s:gbv:01245hr:B:")) != -1) {
195 hdr
->sn
= (unsigned char) atoi (optarg
);
203 case 'v': /* extension to allow setting version */
212 case '2': /* new 54G v2.2 and 54GS v1.1 flags */
214 hdr
->flags
[0] |= SUPPORT_4712_CHIP
;
215 hdr
->flags
[0] |= SUPPORT_INTEL_FLASH
;
216 hdr
->flags
[0] |= SUPPORT_5325E_SWITCH
;
219 /* V4 firmware sets the flags to 0x1f */
221 hdr
->flags
[0] = 0x1f;
224 /* V5 is appended to trxV2 image */
225 hdr
->stable
[0] = 0x73; // force image to be stable
226 hdr
->stable
[1] = 0x00;
227 hdr
->try1
[0] = 0x74; // force try1 to be set
229 hdr
->try2
[0] = hdr
->try2
[1] = 0xFF;
230 hdr
->try3
[0] = hdr
->try3
[1] = 0xFF;
233 hdr
->hw_ver
= (char)(atof(optarg
)*10)+0x30;
245 if (optind
!= argc
|| optind
== 1) {
246 fprintf(stderr
, "illegal arg \"%s\"\n", argv
[optind
]);
251 board
= find_board(board_id
);
253 fprintf(stderr
, "unknown board \"%s\"\n", board_id
);
256 pattern
= board
->pattern
;
257 hdr
->hw_ver
= board
->hw_ver
;
259 hdr
->flags
[0] = board
->flags
[0];
260 hdr
->flags
[1] = board
->flags
[1];
263 if (strlen(pattern
) > 8) {
264 fprintf(stderr
, "illegal pattern \"%s\"\n", pattern
);
268 if (ifn
&& !(in
= fopen(ifn
, "r"))) {
269 fprintf(stderr
, "can not open \"%s\" for reading\n", ifn
);
273 if (ofn
&& !(out
= fopen(ofn
, "w"))) {
274 fprintf(stderr
, "can not open \"%s\" for writing\n", ofn
);
278 set_source_date_epoch();
279 if (source_date_epoch
!= -1) {
280 t
= source_date_epoch
;
281 } else if ((time(&t
) == (time_t)(-1))) {
282 fprintf(stderr
, "time call failed\n");
288 if (3 != sscanf(version
, "v%d.%d.%d", &v0
, &v1
, &v2
)) {
289 fprintf(stderr
, "bad version string \"%s\"\n", version
);
293 memcpy(hdr
->magic
, pattern
, strlen(pattern
));
295 memcpy(&hdr
->magic
[4], pbotpat
, 4);
296 hdr
->fwdate
[0] = ptm
->tm_year
% 100;
297 hdr
->fwdate
[1] = ptm
->tm_mon
+ 1;
298 hdr
->fwdate
[2] = ptm
->tm_mday
;
302 memcpy(hdr
->id
, CODE_ID
, strlen(CODE_ID
));
304 off
= sizeof(struct code_header
);
306 fprintf(stderr
, "writing firmware v%d.%d.%d on %d/%d/%d (y/m/d)\n",
308 hdr
->fwdate
[0], hdr
->fwdate
[1], hdr
->fwdate
[2]);
311 while ((n
= fread(buf
+ off
, 1, sizeof(buf
)-off
, in
) + off
) > 0) {
313 if (n
< sizeof(buf
)) {
316 fprintf(stderr
, "fread error\n");
320 gflag
= sizeof(buf
) - n
;
321 memset(buf
+ n
, 0xff, gflag
);
322 fprintf(stderr
, "adding %d bytes of garbage\n", gflag
);
326 if (!fwrite(buf
, n
, 1, out
)) {
328 fprintf(stderr
, "fwrite error\n");