1/*
2 * Copyright (C) 2004  Manuel Novoa III  <mjn3@codepoet.org>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 */
18
19/* July 29, 2004
20 *
21 * This is a hacked replacement for the 'addpattern' utility used to
22 * create wrt54g .bin firmware files.  It isn't pretty, but it does
23 * the job for me.
24 *
25 * Extensions:
26 *  -v allows setting the version string on the command line.
27 *  -{0|1} sets the (currently ignored) hw_ver flag in the header
28 *      to 0 or 1 respectively.
29 */
30
31/* January 12, 2005
32 *
33 * Modified by rodent at rodent dot za dot net
34 * Support added for the new WRT54G v2.2 and WRT54GS v1.1 "flags"
35 * Without the flags set to 0x7, the above units will refuse to flash.
36 *
37 * Extensions:
38 *  -{0|1|2} sets {0|1} sets hw_ver flag to 0/1. {2} sets hw_ver to 1
39 *     and adds the new hardware "flags" for the v2.2/v1.1 units
40*/
41
42/* January 1, 2007
43 *
44 * Modified by juan.i.gonzalez at subdown dot net
45 * Support added for the AG241v2  and similar
46 *
47 * Extensions:
48 *  -r #.# adds revision hardware flags. AG241v2 and similar.
49 *
50 * AG241V2 firmware sets the hw_ver to 0x44.
51 *
52 * Example: -r 2.0
53 *
54 * Convert 2.0 to 20 to be an integer, and add 0x30 to skip special ASCII
55 * #define HW_Version ((HW_REV * 10) + 0x30)  -> from cyutils.h
56*/
57
58#include <stdio.h>
59#include <stdlib.h>
60#include <string.h>
61#include <time.h>
62#include <unistd.h>
63#include <sys/stat.h>
64
65/**********************************************************************/
66
67#define CODE_ID		"U2ND"		/* from code_pattern.h */
68#define CODE_PATTERN   "W54S"	/* from code_pattern.h */
69#define PBOT_PATTERN   "PBOT"
70
71#define CYBERTAN_VERSION	"v3.37.2" /* from cyutils.h */
72
73/* WRT54G v2.2 and WRT54GS v1.1 "flags" (from 3.37.32 firmware cyutils.h) */
74#define SUPPORT_4712_CHIP      0x0001
75#define SUPPORT_INTEL_FLASH    0x0002
76#define SUPPORT_5325E_SWITCH   0x0004
77/* (from 3.00.24 firmware cyutils.h) */
78#define SUPPORT_4704_CHIP      0x0008
79#define SUPPORT_5352E_CHIP     0x0010
80
81struct code_header {			/* from cyutils.h */
82	char magic[4];
83	char res1[4];				/* for extra magic */
84	char fwdate[3];
85	char fwvern[3];
86	char id[4];					/* U2ND */
87	char hw_ver;    			/* 0: for 4702, 1: for 4712 -- new in 2.04.3 */
88
89	unsigned char  sn;		// Serial Number
90	unsigned char  flags[2];	/* SUPPORT_ flags new for 3.37.2 (WRT54G v2.2 and WRT54GS v1.1) */
91	unsigned char  stable[2];	// The image is stable (for dual image)
92	unsigned char  try1[2];		// Try to boot image first time (for dual image)
93	unsigned char  try2[2];		// Try to boot image second time (for dual image)
94	unsigned char  try3[2];		// Try to boot image third time (for dual_image)
95	unsigned char  res3[2];
96} ;
97
98struct board_info {
99	char	*id;
100	char	*pattern;
101	char	hw_ver;
102	char	sn;
103	char	flags[2];
104};
105
106struct board_info boards[] = {
107	{
108		.id		= "WRT160NL",
109		.pattern	= "NL16",
110		.hw_ver		= 0x00,
111		.sn		= 0x0f,
112		.flags		= {0x3f, 0x00},
113	}, {
114		/* Terminating entry */
115		.id	= NULL,
116	}
117};
118
119/**********************************************************************/
120
121void usage(void) __attribute__ (( __noreturn__ ));
122
123void usage(void)
124{
125	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");
126	exit(EXIT_FAILURE);
127}
128
129struct board_info *find_board(char *id)
130{
131	struct board_info *board;
132
133	for (board = boards; board->id != NULL; board++)
134		if (strcasecmp(id, board->id) == 0)
135			return board;
136
137	return NULL;
138}
139
140int main(int argc, char **argv)
141{
142	char buf[1024];	/* keep this at 1k or adjust garbage calc below */
143	struct code_header *hdr;
144	FILE *in = stdin;
145	FILE *out = stdout;
146	char *ifn = NULL;
147	char *ofn = NULL;
148	char *pattern = CODE_PATTERN;
149	char *pbotpat = PBOT_PATTERN;
150	char *version = CYBERTAN_VERSION;
151	char *board_id = NULL;
152	struct board_info *board = NULL;
153	int gflag = 0;
154	int pbotflag = 0;
155	int c;
156	int v0, v1, v2;
157	size_t off, n;
158	time_t t;
159	struct tm *ptm;
160
161	fprintf(stderr, "mjn3's addpattern replacement - v0.81\n");
162
163	hdr = (struct code_header *) buf;
164	memset(hdr, 0, sizeof(struct code_header));
165
166	while ((c = getopt(argc, argv, "i:o:p:s:gbv:01245hr:B:")) != -1) {
167		switch (c) {
168			case 'i':
169				ifn = optarg;
170				break;
171			case 'o':
172				ofn = optarg;
173				break;
174			case 'p':
175				pattern = optarg;
176				break;
177			case 's':
178				hdr->sn = (unsigned char) atoi (optarg);
179				break;
180			case 'g':
181				gflag = 1;
182				break;
183			case 'b':
184				pbotflag = 1;
185				break;
186			case 'v':			/* extension to allow setting version */
187				version = optarg;
188				break;
189			case '0':
190				hdr->hw_ver = 0;
191				break;
192			case '1':
193				hdr->hw_ver = 1;
194				break;
195			case '2': 			/* new 54G v2.2 and 54GS v1.1 flags */
196				hdr->hw_ver = 1;
197				hdr->flags[0] |= SUPPORT_4712_CHIP;
198				hdr->flags[0] |= SUPPORT_INTEL_FLASH;
199				hdr->flags[0] |= SUPPORT_5325E_SWITCH;
200				break;
201			case '4':
202				/* V4 firmware sets the flags to 0x1f */
203				hdr->hw_ver = 0;
204				hdr->flags[0] = 0x1f;
205				break;
206			case '5':
207				/* V5 is appended to trxV2 image */
208				hdr->stable[0] = 0x73; // force image to be stable
209				hdr->stable[1] = 0x00;
210				hdr->try1[0]   = 0x74; // force try1 to be set
211				hdr->try1[1]   = 0x00;
212				hdr->try2[0]   = hdr->try2[1]   = 0xFF;
213				hdr->try3[0]   = hdr->try3[1]   = 0xFF;
214				break;
215                        case 'r':
216                                hdr->hw_ver = (char)(atof(optarg)*10)+0x30;
217                                break;
218                        case 'B':
219                                board_id = optarg;
220                                break;
221
222                        case 'h':
223			default:
224				usage();
225		}
226	}
227
228    	if (optind != argc || optind == 1) {
229		fprintf(stderr, "illegal arg \"%s\"\n", argv[optind]);
230		usage();
231	}
232
233	if (board_id) {
234		board = find_board(board_id);
235		if (board == NULL) {
236			fprintf(stderr, "unknown board \"%s\"\n", board_id);
237			usage();
238		}
239		pattern = board->pattern;
240		hdr->hw_ver = board->hw_ver;
241		hdr->sn = board->sn;
242		hdr->flags[0] = board->flags[0];
243		hdr->flags[1] = board->flags[1];
244	}
245
246	if (strlen(pattern) != 4) {
247		fprintf(stderr, "illegal pattern \"%s\": length != 4\n", pattern);
248		usage();
249	}
250
251	if (ifn && !(in = fopen(ifn, "r"))) {
252		fprintf(stderr, "can not open \"%s\" for reading\n", ifn);
253		usage();
254	}
255
256	if (ofn && !(out = fopen(ofn, "w"))) {
257		fprintf(stderr, "can not open \"%s\" for writing\n", ofn);
258		usage();
259	}
260
261	if (time(&t) == (time_t)(-1)) {
262		fprintf(stderr, "time call failed\n");
263		return EXIT_FAILURE;
264	}
265
266	ptm = localtime(&t);
267
268	if (3 != sscanf(version, "v%d.%d.%d", &v0, &v1, &v2)) {
269		fprintf(stderr, "bad version string \"%s\"\n", version);
270		return EXIT_FAILURE;
271	}
272
273	memcpy(&hdr->magic, pattern, 4);
274	if (pbotflag)
275		memcpy(&hdr->res1, pbotpat, 4);
276	hdr->fwdate[0] = ptm->tm_year % 100;
277	hdr->fwdate[1] = ptm->tm_mon + 1;
278	hdr->fwdate[2] = ptm->tm_mday;
279	hdr->fwvern[0] = v0;
280	hdr->fwvern[1] = v1;
281	hdr->fwvern[2] = v2;
282	memcpy(&hdr->id, CODE_ID, strlen(CODE_ID));
283
284	off = sizeof(struct code_header);
285
286	fprintf(stderr, "writing firmware v%d.%d.%d on %d/%d/%d (y/m/d)\n",
287			v0, v1, v2,
288			hdr->fwdate[0], hdr->fwdate[1], hdr->fwdate[2]);
289
290
291	while ((n = fread(buf + off, 1, sizeof(buf)-off, in) + off) > 0) {
292		off = 0;
293		if (n < sizeof(buf)) {
294			if (ferror(in)) {
295			FREAD_ERROR:
296				fprintf(stderr, "fread error\n");
297				return EXIT_FAILURE;
298			}
299			if (gflag) {
300				gflag = sizeof(buf) - n;
301				memset(buf + n, 0xff, gflag);
302				fprintf(stderr, "adding %d bytes of garbage\n", gflag);
303				n = sizeof(buf);
304			}
305		}
306		if (!fwrite(buf, n, 1, out)) {
307		FWRITE_ERROR:
308			fprintf(stderr, "fwrite error\n");
309			return EXIT_FAILURE;
310		}
311	}
312
313	if (ferror(in)) {
314		goto FREAD_ERROR;
315	}
316
317	if (fflush(out)) {
318		goto FWRITE_ERROR;
319	}
320
321	fclose(in);
322	fclose(out);
323
324	return EXIT_SUCCESS;
325}
326