update gs v4 pattern so that the latest linksys firmware accepts it
[openwrt.git] / target / utils / src / addpattern.c
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 #include <stdio.h>
43 #include <stdlib.h>
44 #include <string.h>
45 #include <time.h>
46 #include <unistd.h>
47 #include <sys/stat.h>
48
49 /**********************************************************************/
50
51 #define CODE_ID         "U2ND"          /* from code_pattern.h */
52 #define CODE_PATTERN   "W54S"   /* from code_pattern.h */
53 #define PBOT_PATTERN   "PBOT"
54
55 #define CYBERTAN_VERSION        "v3.37.2" /* from cyutils.h */
56
57 /* WRT54G v2.2 and WRT54GS v1.1 "flags" (from 3.37.32 firmware cyutils.h) */
58 #define SUPPORT_4712_CHIP      0x0001
59 #define SUPPORT_INTEL_FLASH    0x0002
60 #define SUPPORT_5325E_SWITCH   0x0004
61
62 struct code_header {                    /* from cyutils.h */
63         char magic[4];
64         char res1[4];                           /* for extra magic */
65         char fwdate[3];
66         char fwvern[3];
67         char id[4];                                     /* U2ND */
68         char hw_ver;                            /* 0: for 4702, 1: for 4712 -- new in 2.04.3 */
69         unsigned short flags;       /* SUPPORT_ flags new for 3.37.2 (WRT54G v2.2 and WRT54GS v1.1) */
70         unsigned char res2[10];
71 } ;
72
73 /**********************************************************************/
74
75 void usage(void) __attribute__ (( __noreturn__ ));
76
77 void usage(void)
78 {
79         fprintf(stderr, "Usage: addpattern [-i trxfile] [-o binfile] [-p pattern] [-g] [-b] [-v v#.#.#] [-{0|1|2|4}]\n");
80         exit(EXIT_FAILURE);
81 }
82
83 int main(int argc, char **argv)
84 {
85         char buf[1024]; /* keep this at 1k or adjust garbage calc below */
86         struct code_header *hdr;
87         FILE *in = stdin;
88         FILE *out = stdout;
89         char *ifn = NULL;
90         char *ofn = NULL;
91         char *pattern = CODE_PATTERN;
92         char *pbotpat = PBOT_PATTERN;
93         char *version = CYBERTAN_VERSION;
94         int gflag = 0;
95         int pbotflag = 0;
96         int c;
97         int v0, v1, v2;
98         size_t off, n;
99         time_t t;
100         struct tm *ptm;
101
102         fprintf(stderr, "mjn3's addpattern replacement - v0.81\n");
103
104         hdr = (struct code_header *) buf;
105         memset(hdr, 0, sizeof(struct code_header));
106
107         while ((c = getopt(argc, argv, "i:o:p:gbv:0124")) != -1) {
108                 switch (c) {
109                         case 'i':
110                                 ifn = optarg;
111                                 break;
112                         case 'o':
113                                 ofn = optarg;
114                                 break;
115                         case 'p':
116                                 pattern = optarg;
117                                 break;
118                         case 'g':
119                                 gflag = 1;
120                                 break;
121                         case 'b':
122                                 pbotflag = 1;
123                                 break;
124                         case 'v':                       /* extension to allow setting version */
125                                 version = optarg;
126                                 break;
127                         case '0':
128                                 hdr->hw_ver = 0;
129                                 break;
130                         case '1':
131                                 hdr->hw_ver = 1;
132                                 break;
133                         case '2':                       /* new 54G v2.2 and 54GS v1.1 flags */
134                                 hdr->hw_ver = 1;
135                                 hdr->flags |= SUPPORT_4712_CHIP;
136                                 hdr->flags |= SUPPORT_INTEL_FLASH;
137                                 hdr->flags |= SUPPORT_5325E_SWITCH;
138                                 break;
139                         case '4':
140                                 /* V4 firmware sets the flags to 0x1f */
141                                 hdr->hw_ver = 0;
142                                 hdr->flags = 0x1f;
143                                 break;
144
145                         default:
146                                 usage();
147                 }
148         }
149
150         if (optind != argc) {
151                 fprintf(stderr, "illegal arg \"%s\"\n", argv[optind]);
152                 usage();
153         }
154
155         if (strlen(pattern) != 4) {
156                 fprintf(stderr, "illegal pattern \"%s\": length != 4\n", pattern);
157                 usage();
158         }
159
160         if (ifn && !(in = fopen(ifn, "r"))) {
161                 fprintf(stderr, "can not open \"%s\" for reading\n", ifn);
162                 usage();
163         }
164
165         if (ofn && !(out = fopen(ofn, "w"))) {
166                 fprintf(stderr, "can not open \"%s\" for writing\n", ofn);
167                 usage();
168         }
169
170         if (time(&t) == (time_t)(-1)) {
171                 fprintf(stderr, "time call failed\n");
172                 return EXIT_FAILURE;
173         }
174
175         ptm = localtime(&t);
176
177         if (3 != sscanf(version, "v%d.%d.%d", &v0, &v1, &v2)) {
178                 fprintf(stderr, "bad version string \"%s\"\n", version);
179                 return EXIT_FAILURE;
180         }
181
182         memcpy(&hdr->magic, pattern, 4);
183         if (pbotflag)
184                 memcpy(&hdr->res1, pbotpat, 4);
185         hdr->fwdate[0] = ptm->tm_year % 100;
186         hdr->fwdate[1] = ptm->tm_mon + 1;
187         hdr->fwdate[2] = ptm->tm_mday;
188         hdr->fwvern[0] = v0;
189         hdr->fwvern[1] = v1;
190         hdr->fwvern[2] = v2;
191         memcpy(&hdr->id, CODE_ID, strlen(CODE_ID));
192
193         off = sizeof(struct code_header);
194
195         fprintf(stderr, "writing firmware v%d.%d.%d on %d/%d/%d (y/m/d)\n",
196                         v0, v1, v2,
197                         hdr->fwdate[0], hdr->fwdate[1], hdr->fwdate[2]);
198
199
200         while ((n = fread(buf + off, 1, sizeof(buf)-off, in) + off) > 0) {
201                 off = 0;
202                 if (n < sizeof(buf)) {
203                         if (ferror(in)) {
204                         FREAD_ERROR:
205                                 fprintf(stderr, "fread error\n");
206                                 return EXIT_FAILURE;
207                         }
208                         if (gflag) {
209                                 gflag = sizeof(buf) - n;
210                                 memset(buf + n, 0xff, gflag);
211                                 fprintf(stderr, "adding %d bytes of garbage\n", gflag);
212                                 n = sizeof(buf);
213                         }
214                 }
215                 if (!fwrite(buf, n, 1, out)) {
216                 FWRITE_ERROR:
217                         fprintf(stderr, "fwrite error\n");
218                         return EXIT_FAILURE;
219                 }
220         }
221         
222         if (ferror(in)) {
223                 goto FREAD_ERROR;
224         }
225
226         if (fflush(out)) {
227                 goto FWRITE_ERROR;
228         }
229
230         fclose(in);
231         fclose(out);
232
233         return EXIT_SUCCESS;
234 }