1 /* fmaptool, CLI utility for converting plaintext fmd files into fmap blobs */
2 /* SPDX-License-Identifier: GPL-2.0-only */
5 #include "cbfs_sections.h"
6 #include "fmap_from_fmd.h"
12 #define STDIN_FILENAME_SENTINEL "-"
14 #define HEADER_FMAP_OFFSET "FMAP_OFFSET"
15 #define HEADER_FMAP_SIZE "FMAP_SIZE"
17 enum fmaptool_return
{
18 FMAPTOOL_EXIT_SUCCESS
= 0,
19 FMAPTOOL_EXIT_BAD_ARGS
,
20 FMAPTOOL_EXIT_BAD_INPUT_PATH
,
21 FMAPTOOL_EXIT_BAD_OUTPUT_PATH
,
22 FMAPTOOL_EXIT_FAILED_DESCRIPTOR
,
23 FMAPTOOL_EXIT_MISSING_FMAP_SECTION
,
24 FMAPTOOL_EXIT_MISSING_PRIMARY_CBFS
,
25 FMAPTOOL_EXIT_FAILED_FMAP_CONVERSION
,
26 FMAPTOOL_EXIT_UNKNOWN_FMAP_SIZE
,
27 FMAPTOOL_EXIT_FAILED_WRITING_OUTPUT
,
28 FMAPTOOL_EXIT_FAILED_WRITING_HEADER
,
31 static void usage(const char *invoked_as
)
33 fputs("fmaptool: Compiler for fmd (flashmap descriptor) files\n",
35 fputs("\nUSAGE:\n", stderr
);
37 "\t%s [-h <header output file>] [-R <region output file>] <fmd input file> <binary output file>\n",
39 fputs("\nMANDATORY ARGUMENTS:\n", stderr
);
41 "<fmd input file> may be '%s' to read from standard input\n",
42 STDIN_FILENAME_SENTINEL
);
43 fputs("<binary output file> must be a regular file\n", stderr
);
44 fputs("\nOPTIONAL SWITCHES:\n", stderr
);
46 "-h\tAlso produce a C header defining %s to the FMAP section's flash offset.\n",
49 "-R\tAlso produce a text file listing the CBFS regions, comma separated.\n");
50 fputs("\nOUTPUT:\n", stderr
);
51 fputs("A successful invocation prints a summary of work done to standard error, and a comma-separated list\n",
53 fputs("of those sections that contain CBFSes, starting with the primary such section, to standard output.\n",
57 static void list_cbfs_section_names(FILE *out
)
59 cbfs_section_iterator_t cbfs_it
= cbfs_sections_iterator();
62 bool subsequent
= false;
64 const char *cur_name
=
65 cbfs_sections_iterator_deref(cbfs_it
)->name
;
66 if (cbfs_sections_iterator_advance(&cbfs_it
) && subsequent
)
74 static void write_header_fmap_sections(FILE *header
, const struct flashmap_descriptor
*root
,
79 * The offset may only be unknown for the root node in a system where the flash isn't
82 if (!root
->offset_known
&& offset
!= 0)
85 const unsigned int current_offset
= offset
+ (root
->offset_known
? root
->offset
: 0);
86 fprintf(header
, "#define FMAP_SECTION_%s_START %#x\n", root
->name
, current_offset
);
88 if (!root
->size_known
)
91 fprintf(header
, "#define FMAP_SECTION_%s_SIZE %#x\n", root
->name
, root
->size
);
93 fmd_foreach_child(child
, root
)
94 write_header_fmap_sections(header
, child
, current_offset
);
97 static bool write_header(const char *out_fname
,
98 const struct flashmap_descriptor
*root
,
103 FILE *header
= fopen(out_fname
, "w");
105 fprintf(stderr
, "FATAL: Unable to open file '%s' for writing\n",
110 unsigned fmap_offset
=
111 fmd_calc_absolute_offset(root
, SECTION_NAME_FMAP
);
112 assert(fmap_offset
!= FMD_NOTFOUND
);
114 fputs("#ifndef FMAPTOOL_GENERATED_HEADER_H_\n", header
);
115 fputs("#define FMAPTOOL_GENERATED_HEADER_H_\n\n", header
);
116 fprintf(header
, "#define %s %#x\n", HEADER_FMAP_OFFSET
, fmap_offset
);
117 fprintf(header
, "#define %s %#x\n\n", HEADER_FMAP_SIZE
, fmap_size
);
119 write_header_fmap_sections(header
, root
, 0);
122 fputs("#endif\n", header
);
128 static void full_fmd_cleanup(struct flashmap_descriptor
**victim
)
132 cbfs_sections_cleanup();
133 fmd_cleanup(*victim
);
137 int main(int argc
, char **argv
)
141 const char *fmd_filename
;
142 const char *fmap_filename
;
145 const char *header_filename
;
146 const char *region_filename
;
147 } args
= {NULL
, NULL
, NULL
, NULL
};
149 bool show_usage
= false;
151 while (!show_usage
&& (each_arg
= getopt(argc
, argv
, ":h:R:")) != -1) {
154 args
.header_filename
= optarg
;
157 args
.region_filename
= optarg
;
160 fprintf(stderr
, "-%c: Expected an accompanying value\n",
165 fprintf(stderr
, "-%c: Unexpected command-line switch\n",
171 if (show_usage
|| argc
- optind
!= 2) {
173 return FMAPTOOL_EXIT_BAD_ARGS
;
175 args
.fmd_filename
= argv
[optind
];
176 args
.fmap_filename
= argv
[optind
+ 1];
178 FILE *fmd_file
= stdin
;
179 if (strcmp(args
.fmd_filename
, STDIN_FILENAME_SENTINEL
) != 0) {
180 fmd_file
= fopen(args
.fmd_filename
, "r");
182 fprintf(stderr
, "FATAL: Unable to open file '%s'\n",
184 return FMAPTOOL_EXIT_BAD_INPUT_PATH
;
188 struct flashmap_descriptor
*descriptor
= fmd_create(fmd_file
);
191 fputs("FATAL: Failed while processing provided descriptor\n",
193 full_fmd_cleanup(&descriptor
);
194 return FMAPTOOL_EXIT_FAILED_DESCRIPTOR
;
197 if (!fmd_find_node(descriptor
, SECTION_NAME_FMAP
)) {
199 "FATAL: Flashmap descriptor must have an '%s' section\n",
201 full_fmd_cleanup(&descriptor
);
202 return FMAPTOOL_EXIT_MISSING_FMAP_SECTION
;
205 if (!cbfs_sections_primary_cbfs_accounted_for()) {
207 "FATAL: Flashmap descriptor must have a '%s' section that is annotated with '(%s)'\n",
208 SECTION_NAME_PRIMARY_CBFS
,
209 SECTION_ANNOTATION_CBFS
);
210 full_fmd_cleanup(&descriptor
);
211 return FMAPTOOL_EXIT_MISSING_PRIMARY_CBFS
;
214 struct fmap
*flashmap
= fmap_from_fmd(descriptor
);
216 fputs("FATAL: Failed while constructing FMAP section\n",
218 full_fmd_cleanup(&descriptor
);
219 return FMAPTOOL_EXIT_FAILED_FMAP_CONVERSION
;
222 int size
= fmap_size(flashmap
);
224 fputs("FATAL: Failed to determine FMAP section size\n",
226 fmap_destroy(flashmap
);
227 full_fmd_cleanup(&descriptor
);
228 return FMAPTOOL_EXIT_UNKNOWN_FMAP_SIZE
;
231 FILE *fmap_file
= fopen(args
.fmap_filename
, "wb");
233 fprintf(stderr
, "FATAL: Unable to open file '%s' for writing\n",
235 fmap_destroy(flashmap
);
236 full_fmd_cleanup(&descriptor
);
237 return FMAPTOOL_EXIT_BAD_OUTPUT_PATH
;
240 if (!fwrite(flashmap
, size
, 1, fmap_file
)) {
241 fputs("FATAL: Failed to write final FMAP to file\n", stderr
);
243 fmap_destroy(flashmap
);
244 full_fmd_cleanup(&descriptor
);
245 return FMAPTOOL_EXIT_FAILED_WRITING_OUTPUT
;
248 fmap_destroy(flashmap
);
250 if (args
.header_filename
&&
251 !write_header(args
.header_filename
, descriptor
, size
)) {
252 full_fmd_cleanup(&descriptor
);
253 return FMAPTOOL_EXIT_FAILED_WRITING_HEADER
;
256 fprintf(stderr
, "SUCCESS: Wrote %d bytes to file '%s'%s\n", size
,
258 args
.header_filename
? " (and generated header)" : "");
259 fputs("The sections containing CBFSes are: ", stderr
);
260 list_cbfs_section_names(stdout
);
261 if (args
.region_filename
) {
262 FILE *region_file
= fopen(args
.region_filename
, "w");
263 if (region_file
== NULL
)
264 return FMAPTOOL_EXIT_FAILED_WRITING_OUTPUT
;
266 list_cbfs_section_names(region_file
);
270 full_fmd_cleanup(&descriptor
);
271 return FMAPTOOL_EXIT_SUCCESS
;