Add a "locate" function cbfstool, which helps you find
[coreboot.git] / util / cbfstool / cbfstool.c
1 /*
2  * cbfstool, CLI utility for CBFS file manipulation
3  *
4  * Copyright (C) 2009 coresystems GmbH
5  *                 written by Patrick Georgi <patrick.georgi@coresystems.de>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; version 2 of the License.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA
19  */
20
21 #include <stdio.h>
22 #include <stdint.h>
23 #include "common.h"
24 #include "cbfs.h"
25
26 typedef enum {
27         CMD_ADD,
28         CMD_ADD_PAYLOAD,
29         CMD_ADD_STAGE,
30         CMD_CREATE,
31         CMD_LOCATE,
32         CMD_PRINT
33 } cmd_t;
34
35 struct command {
36         cmd_t id;
37         const char *name;
38         int (*function) (int argc, char **argv);
39 };
40
41 static int cbfs_add(int argc, char **argv)
42 {
43         char *romname = argv[1];
44         char *cmd = argv[2];
45         void *rom = loadrom(romname);
46
47         if (rom == NULL) {
48                 printf("Could not load ROM image '%s'.\n", romname);
49                 return 1;
50         }
51
52         if (argc < 5) {
53                 printf("not enough arguments to '%s'.\n", cmd);
54                 return 1;
55         }
56
57         char *filename = argv[3];
58         char *cbfsname = argv[4];
59
60         uint32_t filesize = 0;
61         void *filedata = loadfile(filename, &filesize, 0, SEEK_SET);
62         if (filedata == NULL) {
63                 printf("Could not load file '%s'.\n", filename);
64                 return 1;
65         }
66
67         uint32_t base = 0;
68         void *cbfsfile = NULL;
69
70         if (argc < 6) {
71                 printf("not enough arguments to 'add'.\n");
72                 return 1;
73         }
74         uint32_t type;
75         if (intfiletype(argv[5]) != ((uint64_t) - 1))
76                 type = intfiletype(argv[5]);
77         else
78                 type = strtoul(argv[5], NULL, 0);
79         if (argc > 6) {
80                 base = strtoul(argv[6], NULL, 0);
81         }
82         cbfsfile = create_cbfs_file(cbfsname, filedata, &filesize, type, &base);
83         if (add_file_to_cbfs(cbfsfile, filesize, base))
84                 return 1;
85         writerom(romname, rom, romsize);
86         return 0;
87 }
88
89 static int cbfs_add_payload(int argc, char **argv)
90 {
91         char *romname = argv[1];
92         char *cmd = argv[2];
93         void *rom = loadrom(romname);
94
95         if (rom == NULL) {
96                 printf("Could not load ROM image '%s'.\n", romname);
97                 return 1;
98         }
99
100         if (argc < 5) {
101                 printf("not enough arguments to '%s'.\n", cmd);
102                 return 1;
103         }
104
105         char *filename = argv[3];
106         char *cbfsname = argv[4];
107
108         uint32_t filesize = 0;
109         void *filedata = loadfile(filename, &filesize, 0, SEEK_SET);
110         if (filedata == NULL) {
111                 printf("Could not load file '%s'.\n", filename);
112                 return 1;
113         }
114
115         uint32_t base = 0;
116         void *cbfsfile = NULL;
117
118         comp_algo algo = CBFS_COMPRESS_NONE;
119         if (argc > 5) {
120                 if (argv[5][0] == 'l')
121                         algo = CBFS_COMPRESS_LZMA;
122         }
123         if (argc > 6) {
124                 base = strtoul(argv[6], NULL, 0);
125         }
126         unsigned char *payload;
127         filesize = parse_elf_to_payload(filedata, &payload, algo);
128         cbfsfile =
129             create_cbfs_file(cbfsname, payload, &filesize,
130                              CBFS_COMPONENT_PAYLOAD, &base);
131         if (add_file_to_cbfs(cbfsfile, filesize, base))
132                 return 1;
133         writerom(romname, rom, romsize);
134         return 0;
135 }
136
137 static int cbfs_add_stage(int argc, char **argv)
138 {
139         char *romname = argv[1];
140         char *cmd = argv[2];
141         void *rom = loadrom(romname);
142
143         if (rom == NULL) {
144                 printf("Could not load ROM image '%s'.\n", romname);
145                 return 1;
146         }
147
148         if (argc < 5) {
149                 printf("not enough arguments to '%s'.\n", cmd);
150                 return 1;
151         }
152
153         char *filename = argv[3];
154         char *cbfsname = argv[4];
155
156         uint32_t filesize = 0;
157         void *filedata = loadfile(filename, &filesize, 0, SEEK_SET);
158         if (filedata == NULL) {
159                 printf("Could not load file '%s'.\n", filename);
160                 return 1;
161         }
162
163         uint32_t base = 0;
164         void *cbfsfile = NULL;
165
166         comp_algo algo = CBFS_COMPRESS_NONE;
167         if (argc > 5) {
168                 if (argv[5][0] == 'l')
169                         algo = CBFS_COMPRESS_LZMA;
170         }
171         if (argc > 6) {
172                 base = strtoul(argv[6], NULL, 0);
173         }
174         unsigned char *stage;
175         filesize = parse_elf_to_stage(filedata, &stage, algo, &base);
176         cbfsfile =
177             create_cbfs_file(cbfsname, stage, &filesize,
178                              CBFS_COMPONENT_STAGE, &base);
179
180         if (add_file_to_cbfs(cbfsfile, filesize, base))
181                 return 1;
182         writerom(romname, rom, romsize);
183         return 0;
184 }
185
186 static int cbfs_create(int argc, char **argv)
187 {
188         char *romname = argv[1];
189         char *cmd = argv[2];
190         if (argc < 6) {
191                 printf("not enough arguments to 'create'.\n");
192                 return 1;
193         }
194
195         uint32_t size = strtoul(argv[3], NULL, 0);
196         /* ignore bootblock size. we use whatever we get and won't allocate any larger */
197         char *bootblock = argv[5];
198         uint32_t align = 0;
199
200         if (argc > 6)
201                 align = strtoul(argv[6], NULL, 0);
202
203         return create_cbfs_image(romname, size, bootblock, align);
204 }
205
206 static int cbfs_locate(int argc, char **argv)
207 {
208         char *romname = argv[1];
209         if (argc < 6) {
210                 printf("not enough arguments to 'locate'.\n");
211                 return 1;
212         }
213
214         const char *file = argv[3];
215         uint32_t filesize = getfilesize(file);
216         const char *filename = argv[4];
217         int align = strtoul(argv[5], NULL, 0);
218
219         printf("%x\n", cbfs_find_location(romname, filesize, filename, align));
220         return 0;
221 }
222
223 static int cbfs_print(int argc, char **argv)
224 {
225         char *romname = argv[1];
226         char *cmd = argv[2];
227         void *rom = loadrom(romname);
228
229         if (rom == NULL) {
230                 printf("Could not load ROM image '%s'.\n", romname);
231                 return 1;
232         }
233
234         print_cbfs_directory(romname);
235         return 0;
236 }
237
238 struct command commands[] = {
239         {CMD_ADD, "add", cbfs_add},
240         {CMD_ADD_PAYLOAD, "add-payload", cbfs_add_payload},
241         {CMD_ADD_STAGE, "add-stage", cbfs_add_stage},
242         {CMD_CREATE, "create", cbfs_create},
243         {CMD_LOCATE, "locate", cbfs_locate},
244         {CMD_PRINT, "print", cbfs_print}
245 };
246
247 void usage(void)
248 {
249         printf
250             ("cbfstool: Management utility for CBFS formatted ROM images\n"
251              "USAGE:\n" "cbfstool [-h]\n"
252              "cbfstool FILE COMMAND [PARAMETERS]...\n\n" "OPTIONs:\n"
253              " -h               Display this help message\n\n"
254              "COMMANDs:\n"
255              "add FILE NAME TYPE [base address]    Add a component\n"
256              "add-payload FILE NAME [COMP] [base]  Add a payload to the ROM\n"
257              "add-stage FILE NAME [COMP] [base]    Add a stage to the ROM\n"
258              "create SIZE BSIZE BOOTBLOCK [ALIGN]  Create a ROM file\n"
259              "locate FILE NAME ALIGN               Find a place for a file of that size\n"
260              "print                                Show the contents of the ROM\n");
261 }
262
263 int main(int argc, char **argv)
264 {
265         int i;
266
267         if (argc < 3) {
268                 usage();
269                 return 1;
270         }
271
272         char *cmd = argv[2];
273
274         for (i = 0; i < ARRAY_SIZE(commands); i++) {
275                 if (strcmp(cmd, commands[i].name) != 0)
276                         continue;
277                 return commands[i].function(argc, argv);
278         }
279
280         printf("Unknown command '%s'.\n", cmd);
281         usage();
282         return 1;
283 }