x86: ifdtool: Split microcode linking into its own function
[platform/kernel/u-boot.git] / tools / ifdtool.c
1 /*
2  * ifdtool - Manage Intel Firmware Descriptor information
3  *
4  * Copyright 2014 Google, Inc
5  *
6  * SPDX-License-Identifier:     GPL-2.0
7  *
8  * From Coreboot project, but it got a serious code clean-up
9  * and a few new features
10  */
11
12 #include <assert.h>
13 #include <fcntl.h>
14 #include <getopt.h>
15 #include <stdlib.h>
16 #include <stdio.h>
17 #include <string.h>
18 #include <unistd.h>
19 #include <sys/types.h>
20 #include <sys/stat.h>
21 #include <libfdt.h>
22 #include "ifdtool.h"
23
24 #undef DEBUG
25
26 #ifdef DEBUG
27 #define debug(fmt, args...)     printf(fmt, ##args)
28 #else
29 #define debug(fmt, args...)
30 #endif
31
32 #define FD_SIGNATURE            0x0FF0A55A
33 #define FLREG_BASE(reg)         ((reg & 0x00000fff) << 12);
34 #define FLREG_LIMIT(reg)        (((reg & 0x0fff0000) >> 4) | 0xfff);
35
36 enum input_file_type_t {
37         IF_normal,
38         IF_fdt,
39         IF_uboot,
40 };
41
42 struct input_file {
43         char *fname;
44         unsigned int addr;
45         enum input_file_type_t type;
46 };
47
48 /**
49  * find_fd() - Find the flash description in the ROM image
50  *
51  * @image:      Pointer to image
52  * @size:       Size of image in bytes
53  * @return pointer to structure, or NULL if not found
54  */
55 static struct fdbar_t *find_fd(char *image, int size)
56 {
57         uint32_t *ptr, *end;
58
59         /* Scan for FD signature */
60         for (ptr = (uint32_t *)image, end = ptr + size / 4; ptr < end; ptr++) {
61                 if (*ptr == FD_SIGNATURE)
62                         break;
63         }
64
65         if (ptr == end) {
66                 printf("No Flash Descriptor found in this image\n");
67                 return NULL;
68         }
69
70         debug("Found Flash Descriptor signature at 0x%08lx\n",
71               (char *)ptr - image);
72
73         return (struct fdbar_t *)ptr;
74 }
75
76 /**
77  * get_region() - Get information about the selected region
78  *
79  * @frba:               Flash region list
80  * @region_type:        Type of region (0..MAX_REGIONS-1)
81  * @region:             Region information is written here
82  * @return 0 if OK, else -ve
83  */
84 static int get_region(struct frba_t *frba, int region_type,
85                       struct region_t *region)
86 {
87         if (region_type >= MAX_REGIONS) {
88                 fprintf(stderr, "Invalid region type.\n");
89                 return -1;
90         }
91
92         region->base = FLREG_BASE(frba->flreg[region_type]);
93         region->limit = FLREG_LIMIT(frba->flreg[region_type]);
94         region->size = region->limit - region->base + 1;
95
96         return 0;
97 }
98
99 static const char *region_name(int region_type)
100 {
101         static const char *const regions[] = {
102                 "Flash Descriptor",
103                 "BIOS",
104                 "Intel ME",
105                 "GbE",
106                 "Platform Data"
107         };
108
109         assert(region_type < MAX_REGIONS);
110
111         return regions[region_type];
112 }
113
114 static const char *region_filename(int region_type)
115 {
116         static const char *const region_filenames[] = {
117                 "flashregion_0_flashdescriptor.bin",
118                 "flashregion_1_bios.bin",
119                 "flashregion_2_intel_me.bin",
120                 "flashregion_3_gbe.bin",
121                 "flashregion_4_platform_data.bin"
122         };
123
124         assert(region_type < MAX_REGIONS);
125
126         return region_filenames[region_type];
127 }
128
129 static int dump_region(int num, struct frba_t *frba)
130 {
131         struct region_t region;
132         int ret;
133
134         ret = get_region(frba, num, &region);
135         if (ret)
136                 return ret;
137
138         printf("  Flash Region %d (%s): %08x - %08x %s\n",
139                num, region_name(num), region.base, region.limit,
140                region.size < 1 ? "(unused)" : "");
141
142         return ret;
143 }
144
145 static void dump_frba(struct frba_t *frba)
146 {
147         int i;
148
149         printf("Found Region Section\n");
150         for (i = 0; i < MAX_REGIONS; i++) {
151                 printf("FLREG%d:    0x%08x\n", i, frba->flreg[i]);
152                 dump_region(i, frba);
153         }
154 }
155
156 static void decode_spi_frequency(unsigned int freq)
157 {
158         switch (freq) {
159         case SPI_FREQUENCY_20MHZ:
160                 printf("20MHz");
161                 break;
162         case SPI_FREQUENCY_33MHZ:
163                 printf("33MHz");
164                 break;
165         case SPI_FREQUENCY_50MHZ:
166                 printf("50MHz");
167                 break;
168         default:
169                 printf("unknown<%x>MHz", freq);
170         }
171 }
172
173 static void decode_component_density(unsigned int density)
174 {
175         switch (density) {
176         case COMPONENT_DENSITY_512KB:
177                 printf("512KiB");
178                 break;
179         case COMPONENT_DENSITY_1MB:
180                 printf("1MiB");
181                 break;
182         case COMPONENT_DENSITY_2MB:
183                 printf("2MiB");
184                 break;
185         case COMPONENT_DENSITY_4MB:
186                 printf("4MiB");
187                 break;
188         case COMPONENT_DENSITY_8MB:
189                 printf("8MiB");
190                 break;
191         case COMPONENT_DENSITY_16MB:
192                 printf("16MiB");
193                 break;
194         default:
195                 printf("unknown<%x>MiB", density);
196         }
197 }
198
199 static void dump_fcba(struct fcba_t *fcba)
200 {
201         printf("\nFound Component Section\n");
202         printf("FLCOMP     0x%08x\n", fcba->flcomp);
203         printf("  Dual Output Fast Read Support:       %ssupported\n",
204                (fcba->flcomp & (1 << 30)) ? "" : "not ");
205         printf("  Read ID/Read Status Clock Frequency: ");
206         decode_spi_frequency((fcba->flcomp >> 27) & 7);
207         printf("\n  Write/Erase Clock Frequency:         ");
208         decode_spi_frequency((fcba->flcomp >> 24) & 7);
209         printf("\n  Fast Read Clock Frequency:           ");
210         decode_spi_frequency((fcba->flcomp >> 21) & 7);
211         printf("\n  Fast Read Support:                   %ssupported",
212                (fcba->flcomp & (1 << 20)) ? "" : "not ");
213         printf("\n  Read Clock Frequency:                ");
214         decode_spi_frequency((fcba->flcomp >> 17) & 7);
215         printf("\n  Component 2 Density:                 ");
216         decode_component_density((fcba->flcomp >> 3) & 7);
217         printf("\n  Component 1 Density:                 ");
218         decode_component_density(fcba->flcomp & 7);
219         printf("\n");
220         printf("FLILL      0x%08x\n", fcba->flill);
221         printf("  Invalid Instruction 3: 0x%02x\n",
222                (fcba->flill >> 24) & 0xff);
223         printf("  Invalid Instruction 2: 0x%02x\n",
224                (fcba->flill >> 16) & 0xff);
225         printf("  Invalid Instruction 1: 0x%02x\n",
226                (fcba->flill >> 8) & 0xff);
227         printf("  Invalid Instruction 0: 0x%02x\n",
228                fcba->flill & 0xff);
229         printf("FLPB       0x%08x\n", fcba->flpb);
230         printf("  Flash Partition Boundary Address: 0x%06x\n\n",
231                (fcba->flpb & 0xfff) << 12);
232 }
233
234 static void dump_fpsba(struct fpsba_t *fpsba)
235 {
236         int i;
237
238         printf("Found PCH Strap Section\n");
239         for (i = 0; i < MAX_STRAPS; i++)
240                 printf("PCHSTRP%-2d:  0x%08x\n", i, fpsba->pchstrp[i]);
241 }
242
243 static const char *get_enabled(int flag)
244 {
245         return flag ? "enabled" : "disabled";
246 }
247
248 static void decode_flmstr(uint32_t flmstr)
249 {
250         printf("  Platform Data Region Write Access: %s\n",
251                get_enabled(flmstr & (1 << 28)));
252         printf("  GbE Region Write Access:           %s\n",
253                get_enabled(flmstr & (1 << 27)));
254         printf("  Intel ME Region Write Access:      %s\n",
255                get_enabled(flmstr & (1 << 26)));
256         printf("  Host CPU/BIOS Region Write Access: %s\n",
257                get_enabled(flmstr & (1 << 25)));
258         printf("  Flash Descriptor Write Access:     %s\n",
259                get_enabled(flmstr & (1 << 24)));
260
261         printf("  Platform Data Region Read Access:  %s\n",
262                get_enabled(flmstr & (1 << 20)));
263         printf("  GbE Region Read Access:            %s\n",
264                get_enabled(flmstr & (1 << 19)));
265         printf("  Intel ME Region Read Access:       %s\n",
266                get_enabled(flmstr & (1 << 18)));
267         printf("  Host CPU/BIOS Region Read Access:  %s\n",
268                get_enabled(flmstr & (1 << 17)));
269         printf("  Flash Descriptor Read Access:      %s\n",
270                get_enabled(flmstr & (1 << 16)));
271
272         printf("  Requester ID:                      0x%04x\n\n",
273                flmstr & 0xffff);
274 }
275
276 static void dump_fmba(struct fmba_t *fmba)
277 {
278         printf("Found Master Section\n");
279         printf("FLMSTR1:   0x%08x (Host CPU/BIOS)\n", fmba->flmstr1);
280         decode_flmstr(fmba->flmstr1);
281         printf("FLMSTR2:   0x%08x (Intel ME)\n", fmba->flmstr2);
282         decode_flmstr(fmba->flmstr2);
283         printf("FLMSTR3:   0x%08x (GbE)\n", fmba->flmstr3);
284         decode_flmstr(fmba->flmstr3);
285 }
286
287 static void dump_fmsba(struct fmsba_t *fmsba)
288 {
289         int i;
290
291         printf("Found Processor Strap Section\n");
292         for (i = 0; i < 4; i++)
293                 printf("????:      0x%08x\n", fmsba->data[0]);
294 }
295
296 static void dump_jid(uint32_t jid)
297 {
298         printf("    SPI Component Device ID 1:          0x%02x\n",
299                (jid >> 16) & 0xff);
300         printf("    SPI Component Device ID 0:          0x%02x\n",
301                (jid >> 8) & 0xff);
302         printf("    SPI Component Vendor ID:            0x%02x\n",
303                jid & 0xff);
304 }
305
306 static void dump_vscc(uint32_t vscc)
307 {
308         printf("    Lower Erase Opcode:                 0x%02x\n",
309                vscc >> 24);
310         printf("    Lower Write Enable on Write Status: 0x%02x\n",
311                vscc & (1 << 20) ? 0x06 : 0x50);
312         printf("    Lower Write Status Required:        %s\n",
313                vscc & (1 << 19) ? "Yes" : "No");
314         printf("    Lower Write Granularity:            %d bytes\n",
315                vscc & (1 << 18) ? 64 : 1);
316         printf("    Lower Block / Sector Erase Size:    ");
317         switch ((vscc >> 16) & 0x3) {
318         case 0:
319                 printf("256 Byte\n");
320                 break;
321         case 1:
322                 printf("4KB\n");
323                 break;
324         case 2:
325                 printf("8KB\n");
326                 break;
327         case 3:
328                 printf("64KB\n");
329                 break;
330         }
331
332         printf("    Upper Erase Opcode:                 0x%02x\n",
333                (vscc >> 8) & 0xff);
334         printf("    Upper Write Enable on Write Status: 0x%02x\n",
335                vscc & (1 << 4) ? 0x06 : 0x50);
336         printf("    Upper Write Status Required:        %s\n",
337                vscc & (1 << 3) ? "Yes" : "No");
338         printf("    Upper Write Granularity:            %d bytes\n",
339                vscc & (1 << 2) ? 64 : 1);
340         printf("    Upper Block / Sector Erase Size:    ");
341         switch (vscc & 0x3) {
342         case 0:
343                 printf("256 Byte\n");
344                 break;
345         case 1:
346                 printf("4KB\n");
347                 break;
348         case 2:
349                 printf("8KB\n");
350                 break;
351         case 3:
352                 printf("64KB\n");
353                 break;
354         }
355 }
356
357 static void dump_vtba(struct vtba_t *vtba, int vtl)
358 {
359         int i;
360         int num = (vtl >> 1) < 8 ? (vtl >> 1) : 8;
361
362         printf("ME VSCC table:\n");
363         for (i = 0; i < num; i++) {
364                 printf("  JID%d:  0x%08x\n", i, vtba->entry[i].jid);
365                 dump_jid(vtba->entry[i].jid);
366                 printf("  VSCC%d: 0x%08x\n", i, vtba->entry[i].vscc);
367                 dump_vscc(vtba->entry[i].vscc);
368         }
369         printf("\n");
370 }
371
372 static void dump_oem(uint8_t *oem)
373 {
374         int i, j;
375         printf("OEM Section:\n");
376         for (i = 0; i < 4; i++) {
377                 printf("%02x:", i << 4);
378                 for (j = 0; j < 16; j++)
379                         printf(" %02x", oem[(i<<4)+j]);
380                 printf("\n");
381         }
382         printf("\n");
383 }
384
385 /**
386  * dump_fd() - Display a dump of the full flash description
387  *
388  * @image:      Pointer to image
389  * @size:       Size of image in bytes
390  * @return 0 if OK, -1 on error
391  */
392 static int dump_fd(char *image, int size)
393 {
394         struct fdbar_t *fdb = find_fd(image, size);
395
396         if (!fdb)
397                 return -1;
398
399         printf("FLMAP0:    0x%08x\n", fdb->flmap0);
400         printf("  NR:      %d\n", (fdb->flmap0 >> 24) & 7);
401         printf("  FRBA:    0x%x\n", ((fdb->flmap0 >> 16) & 0xff) << 4);
402         printf("  NC:      %d\n", ((fdb->flmap0 >> 8) & 3) + 1);
403         printf("  FCBA:    0x%x\n", ((fdb->flmap0) & 0xff) << 4);
404
405         printf("FLMAP1:    0x%08x\n", fdb->flmap1);
406         printf("  ISL:     0x%02x\n", (fdb->flmap1 >> 24) & 0xff);
407         printf("  FPSBA:   0x%x\n", ((fdb->flmap1 >> 16) & 0xff) << 4);
408         printf("  NM:      %d\n", (fdb->flmap1 >> 8) & 3);
409         printf("  FMBA:    0x%x\n", ((fdb->flmap1) & 0xff) << 4);
410
411         printf("FLMAP2:    0x%08x\n", fdb->flmap2);
412         printf("  PSL:     0x%04x\n", (fdb->flmap2 >> 8) & 0xffff);
413         printf("  FMSBA:   0x%x\n", ((fdb->flmap2) & 0xff) << 4);
414
415         printf("FLUMAP1:   0x%08x\n", fdb->flumap1);
416         printf("  Intel ME VSCC Table Length (VTL):        %d\n",
417                (fdb->flumap1 >> 8) & 0xff);
418         printf("  Intel ME VSCC Table Base Address (VTBA): 0x%06x\n\n",
419                (fdb->flumap1 & 0xff) << 4);
420         dump_vtba((struct vtba_t *)
421                         (image + ((fdb->flumap1 & 0xff) << 4)),
422                         (fdb->flumap1 >> 8) & 0xff);
423         dump_oem((uint8_t *)image + 0xf00);
424         dump_frba((struct frba_t *)(image + (((fdb->flmap0 >> 16) & 0xff)
425                         << 4)));
426         dump_fcba((struct fcba_t *)(image + (((fdb->flmap0) & 0xff) << 4)));
427         dump_fpsba((struct fpsba_t *)
428                         (image + (((fdb->flmap1 >> 16) & 0xff) << 4)));
429         dump_fmba((struct fmba_t *)(image + (((fdb->flmap1) & 0xff) << 4)));
430         dump_fmsba((struct fmsba_t *)(image + (((fdb->flmap2) & 0xff) << 4)));
431
432         return 0;
433 }
434
435 /**
436  * write_regions() - Write each region from an image to its own file
437  *
438  * The filename to use in each case is fixed - see region_filename()
439  *
440  * @image:      Pointer to image
441  * @size:       Size of image in bytes
442  * @return 0 if OK, -ve on error
443  */
444 static int write_regions(char *image, int size)
445 {
446         struct fdbar_t *fdb;
447         struct frba_t *frba;
448         int ret = 0;
449         int i;
450
451         fdb =  find_fd(image, size);
452         if (!fdb)
453                 return -1;
454
455         frba = (struct frba_t *)(image + (((fdb->flmap0 >> 16) & 0xff) << 4));
456
457         for (i = 0; i < MAX_REGIONS; i++) {
458                 struct region_t region;
459                 int region_fd;
460
461                 ret = get_region(frba, i, &region);
462                 if (ret)
463                         return ret;
464                 dump_region(i, frba);
465                 if (region.size <= 0)
466                         continue;
467                 region_fd = open(region_filename(i),
468                                  O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR |
469                                  S_IWUSR | S_IRGRP | S_IROTH);
470                 if (write(region_fd, image + region.base, region.size) !=
471                                 region.size) {
472                         perror("Error while writing");
473                         ret = -1;
474                 }
475                 close(region_fd);
476         }
477
478         return ret;
479 }
480
481 static int perror_fname(const char *fmt, const char *fname)
482 {
483         char msg[strlen(fmt) + strlen(fname) + 1];
484
485         sprintf(msg, fmt, fname);
486         perror(msg);
487
488         return -1;
489 }
490
491 /**
492  * write_image() - Write the image to a file
493  *
494  * @filename:   Filename to use for the image
495  * @image:      Pointer to image
496  * @size:       Size of image in bytes
497  * @return 0 if OK, -ve on error
498  */
499 static int write_image(char *filename, char *image, int size)
500 {
501         int new_fd;
502
503         debug("Writing new image to %s\n", filename);
504
505         new_fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR |
506                       S_IWUSR | S_IRGRP | S_IROTH);
507         if (new_fd < 0)
508                 return perror_fname("Could not open file '%s'", filename);
509         if (write(new_fd, image, size) != size)
510                 return perror_fname("Could not write file '%s'", filename);
511         close(new_fd);
512
513         return 0;
514 }
515
516 /**
517  * set_spi_frequency() - Set the SPI frequency to use when booting
518  *
519  * Several frequencies are supported, some of which work with fast devices.
520  * For SPI emulators, the slowest (SPI_FREQUENCY_20MHZ) is often used. The
521  * Intel boot system uses this information somehow on boot.
522  *
523  * The image is updated with the supplied value
524  *
525  * @image:      Pointer to image
526  * @size:       Size of image in bytes
527  * @freq:       SPI frequency to use
528  */
529 static void set_spi_frequency(char *image, int size, enum spi_frequency freq)
530 {
531         struct fdbar_t *fdb = find_fd(image, size);
532         struct fcba_t *fcba;
533
534         fcba = (struct fcba_t *)(image + (((fdb->flmap0) & 0xff) << 4));
535
536         /* clear bits 21-29 */
537         fcba->flcomp &= ~0x3fe00000;
538         /* Read ID and Read Status Clock Frequency */
539         fcba->flcomp |= freq << 27;
540         /* Write and Erase Clock Frequency */
541         fcba->flcomp |= freq << 24;
542         /* Fast Read Clock Frequency */
543         fcba->flcomp |= freq << 21;
544 }
545
546 /**
547  * set_em100_mode() - Set a SPI frequency that will work with Dediprog EM100
548  *
549  * @image:      Pointer to image
550  * @size:       Size of image in bytes
551  */
552 static void set_em100_mode(char *image, int size)
553 {
554         struct fdbar_t *fdb = find_fd(image, size);
555         struct fcba_t *fcba;
556
557         fcba = (struct fcba_t *)(image + (((fdb->flmap0) & 0xff) << 4));
558         fcba->flcomp &= ~(1 << 30);
559         set_spi_frequency(image, size, SPI_FREQUENCY_20MHZ);
560 }
561
562 /**
563  * lock_descriptor() - Lock the NE descriptor so it cannot be updated
564  *
565  * @image:      Pointer to image
566  * @size:       Size of image in bytes
567  */
568 static void lock_descriptor(char *image, int size)
569 {
570         struct fdbar_t *fdb = find_fd(image, size);
571         struct fmba_t *fmba;
572
573         /*
574          * TODO: Dynamically take Platform Data Region and GbE Region into
575          * account.
576          */
577         fmba = (struct fmba_t *)(image + (((fdb->flmap1) & 0xff) << 4));
578         fmba->flmstr1 = 0x0a0b0000;
579         fmba->flmstr2 = 0x0c0d0000;
580         fmba->flmstr3 = 0x08080118;
581 }
582
583 /**
584  * unlock_descriptor() - Lock the NE descriptor so it can be updated
585  *
586  * @image:      Pointer to image
587  * @size:       Size of image in bytes
588  */
589 static void unlock_descriptor(char *image, int size)
590 {
591         struct fdbar_t *fdb = find_fd(image, size);
592         struct fmba_t *fmba;
593
594         fmba = (struct fmba_t *)(image + (((fdb->flmap1) & 0xff) << 4));
595         fmba->flmstr1 = 0xffff0000;
596         fmba->flmstr2 = 0xffff0000;
597         fmba->flmstr3 = 0x08080118;
598 }
599
600 /**
601  * open_for_read() - Open a file for reading
602  *
603  * @fname:      Filename to open
604  * @sizep:      Returns file size in bytes
605  * @return 0 if OK, -1 on error
606  */
607 int open_for_read(const char *fname, int *sizep)
608 {
609         int fd = open(fname, O_RDONLY);
610         struct stat buf;
611
612         if (fd == -1)
613                 return perror_fname("Could not open file '%s'", fname);
614         if (fstat(fd, &buf) == -1)
615                 return perror_fname("Could not stat file '%s'", fname);
616         *sizep = buf.st_size;
617         debug("File %s is %d bytes\n", fname, *sizep);
618
619         return fd;
620 }
621
622 /**
623  * inject_region() - Add a file to an image region
624  *
625  * This puts a file into a particular region of the flash. Several pre-defined
626  * regions are used.
627  *
628  * @image:              Pointer to image
629  * @size:               Size of image in bytes
630  * @region_type:        Region where the file should be added
631  * @region_fname:       Filename to add to the image
632  * @return 0 if OK, -ve on error
633  */
634 int inject_region(char *image, int size, int region_type, char *region_fname)
635 {
636         struct fdbar_t *fdb = find_fd(image, size);
637         struct region_t region;
638         struct frba_t *frba;
639         int region_size;
640         int offset = 0;
641         int region_fd;
642         int ret;
643
644         if (!fdb)
645                 exit(EXIT_FAILURE);
646         frba = (struct frba_t *)(image + (((fdb->flmap0 >> 16) & 0xff) << 4));
647
648         ret = get_region(frba, region_type, &region);
649         if (ret)
650                 return -1;
651         if (region.size <= 0xfff) {
652                 fprintf(stderr, "Region %s is disabled in target. Not injecting.\n",
653                         region_name(region_type));
654                 return -1;
655         }
656
657         region_fd = open_for_read(region_fname, &region_size);
658         if (region_fd < 0)
659                 return region_fd;
660
661         if ((region_size > region.size) ||
662             ((region_type != 1) && (region_size > region.size))) {
663                 fprintf(stderr, "Region %s is %d(0x%x) bytes. File is %d(0x%x)  bytes. Not injecting.\n",
664                         region_name(region_type), region.size,
665                         region.size, region_size, region_size);
666                 return -1;
667         }
668
669         if ((region_type == 1) && (region_size < region.size)) {
670                 fprintf(stderr, "Region %s is %d(0x%x) bytes. File is %d(0x%x) bytes. Padding before injecting.\n",
671                         region_name(region_type), region.size,
672                         region.size, region_size, region_size);
673                 offset = region.size - region_size;
674                 memset(image + region.base, 0xff, offset);
675         }
676
677         if (size < region.base + offset + region_size) {
678                 fprintf(stderr, "Output file is too small. (%d < %d)\n",
679                         size, region.base + offset + region_size);
680                 return -1;
681         }
682
683         if (read(region_fd, image + region.base + offset, region_size)
684                                                         != region_size) {
685                 perror("Could not read file");
686                 return -1;
687         }
688
689         close(region_fd);
690
691         debug("Adding %s as the %s section\n", region_fname,
692               region_name(region_type));
693
694         return 0;
695 }
696
697 /**
698  * write_data() - Write some raw data into a region
699  *
700  * This puts a file into a particular place in the flash, ignoring the
701  * regions. Be careful not to overwrite something important.
702  *
703  * @image:              Pointer to image
704  * @size:               Size of image in bytes
705  * @addr:               x86 ROM address to put file. The ROM ends at
706  *                      0xffffffff so use an address relative to that. For an
707  *                      8MB ROM the start address is 0xfff80000.
708  * @write_fname:        Filename to add to the image
709  * @offset_uboot_top:   Offset of the top of U-Boot
710  * @return number of bytes written if OK, -ve on error
711  */
712 static int write_data(char *image, int size, unsigned int addr,
713                       const char *write_fname, int offset_uboot_top)
714 {
715         int write_fd, write_size;
716         int offset;
717
718         write_fd = open_for_read(write_fname, &write_size);
719         if (write_fd < 0)
720                 return write_fd;
721
722         offset = (uint32_t)(addr + size);
723         if (offset_uboot_top && offset_uboot_top >= offset) {
724                 fprintf(stderr, "U-Boot image overlaps with region '%s'\n",
725                         write_fname);
726                 fprintf(stderr,
727                         "U-Boot finishes at offset %x, file starts at %x\n",
728                         offset_uboot_top, offset);
729                 return -EXDEV;
730         }
731         debug("Writing %s to offset %#x\n", write_fname, offset);
732
733         if (offset < 0 || offset + write_size > size) {
734                 fprintf(stderr, "Output file is too small. (%d < %d)\n",
735                         size, offset + write_size);
736                 return -1;
737         }
738
739         if (read(write_fd, image + offset, write_size) != write_size) {
740                 perror("Could not read file");
741                 return -1;
742         }
743
744         close(write_fd);
745
746         return write_size;
747 }
748
749 static int scan_ucode(const void *blob, char *ucode_base, int *countp,
750                       const char **datap, int *data_sizep)
751 {
752         const char *data = NULL;
753         int node, count;
754         int data_size;
755         char *ucode;
756
757         for (node = 0, count = 0, ucode = ucode_base; node >= 0; count++) {
758                 node = fdt_node_offset_by_compatible(blob, node,
759                                                      "intel,microcode");
760                 if (node < 0)
761                         break;
762
763                 data = fdt_getprop(blob, node, "data", &data_size);
764                 if (!data) {
765                         debug("Missing microcode data in FDT '%s': %s\n",
766                               fdt_get_name(blob, node, NULL),
767                               fdt_strerror(data_size));
768                         return -ENOENT;
769                 }
770
771                 ucode += data_size;
772         }
773
774         if (countp)
775                 *countp = count;
776         if (datap)
777                 *datap = data;
778         if (data_sizep)
779                 *data_sizep = data_size;
780
781         return ucode - ucode_base;
782 }
783
784 static int write_ucode(char *image, int size, struct input_file *fdt,
785                        int fdt_size, unsigned int ucode_ptr)
786 {
787         const char *data = NULL;
788         const void *blob;
789         uint32_t *ptr;
790         int ucode_size;
791         int data_size;
792         int offset;
793         int count;
794
795         blob = (void *)image + (uint32_t)(fdt->addr + size);
796
797         debug("DTB at %lx\n", (char *)blob - image);
798
799         /* Find out about the micrcode we have */
800         ucode_size = scan_ucode(blob, NULL, &count, &data, &data_size);
801         if (ucode_size < 0)
802                 return ucode_size;
803         if (!count) {
804                 debug("No microcode found in FDT\n");
805                 return -ENOENT;
806         }
807
808         if (count > 1) {
809                 fprintf(stderr,
810                         "Cannot handle multiple microcode blocks\n");
811                 return -EMLINK;
812         }
813
814         offset = (uint32_t)(ucode_ptr + size);
815         ptr = (void *)image + offset;
816
817         ptr[0] = (data - image) - size;
818         ptr[1] = data_size;
819         debug("Wrote microcode pointer at %x: addr=%x, size=%x\n", ucode_ptr,
820               ptr[0], ptr[1]);
821
822         return 0;
823 }
824
825 /**
826  * write_uboot() - Write U-Boot, device tree and microcode pointer
827  *
828  * This writes U-Boot into a place in the flash, followed by its device tree.
829  * The microcode pointer is written so that U-Boot can find the microcode in
830  * the device tree very early in boot.
831  *
832  * @image:      Pointer to image
833  * @size:       Size of image in bytes
834  * @uboot:      Input file information for u-boot.bin
835  * @fdt:        Input file information for u-boot.dtb
836  * @ucode_ptr:  Address in U-Boot where the microcode pointer should be placed
837  * @return 0 if OK, -ve on error
838  */
839 static int write_uboot(char *image, int size, struct input_file *uboot,
840                        struct input_file *fdt, unsigned int ucode_ptr)
841 {
842         const void *blob;
843         int uboot_size, fdt_size;
844
845         uboot_size = write_data(image, size, uboot->addr, uboot->fname, 0);
846         if (uboot_size < 0)
847                 return uboot_size;
848         fdt->addr = uboot->addr + uboot_size;
849         debug("U-Boot size %#x, FDT at %#x\n", uboot_size, fdt->addr);
850         fdt_size = write_data(image, size, fdt->addr, fdt->fname, 0);
851         if (fdt_size < 0)
852                 return fdt_size;
853         blob = (void *)image + (uint32_t)(fdt->addr + size);
854
855         if (ucode_ptr)
856                 return write_ucode(image, size, fdt, fdt_size, ucode_ptr);
857
858         return ((char *)blob + fdt_size) - image;
859 }
860
861 static void print_version(void)
862 {
863         printf("ifdtool v%s -- ", IFDTOOL_VERSION);
864         printf("Copyright (C) 2014 Google Inc.\n\n");
865         printf("SPDX-License-Identifier:        GPL-2.0+\n");
866 }
867
868 static void print_usage(const char *name)
869 {
870         printf("usage: %s [-vhdix?] <filename> [<outfile>]\n", name);
871         printf("\n"
872                "   -d | --dump:                      dump intel firmware descriptor\n"
873                "   -x | --extract:                   extract intel fd modules\n"
874                "   -i | --inject <region>:<module>   inject file <module> into region <region>\n"
875                "   -w | --write <addr>:<file>        write file to appear at memory address <addr>\n"
876                "                                     multiple files can be written simultaneously\n"
877                "   -s | --spifreq <20|33|50>         set the SPI frequency\n"
878                "   -e | --em100                      set SPI frequency to 20MHz and disable\n"
879                "                                     Dual Output Fast Read Support\n"
880                "   -l | --lock                       Lock firmware descriptor and ME region\n"
881                "   -u | --unlock                     Unlock firmware descriptor and ME region\n"
882                "   -r | --romsize                    Specify ROM size\n"
883                "   -D | --write-descriptor <file>    Write descriptor at base\n"
884                "   -c | --create                     Create a new empty image\n"
885                "   -v | --version:                   print the version\n"
886                "   -h | --help:                      print this help\n\n"
887                "<region> is one of Descriptor, BIOS, ME, GbE, Platform\n"
888                "\n");
889 }
890
891 /**
892  * get_two_words() - Convert a string into two words separated by :
893  *
894  * The supplied string is split at ':', two substrings are allocated and
895  * returned.
896  *
897  * @str:        String to split
898  * @firstp:     Returns first string
899  * @secondp:    Returns second string
900  * @return 0 if OK, -ve if @str does not have a :
901  */
902 static int get_two_words(const char *str, char **firstp, char **secondp)
903 {
904         const char *p;
905
906         p = strchr(str, ':');
907         if (!p)
908                 return -1;
909         *firstp = strdup(str);
910         (*firstp)[p - str] = '\0';
911         *secondp = strdup(p + 1);
912
913         return 0;
914 }
915
916 int main(int argc, char *argv[])
917 {
918         int opt, option_index = 0;
919         int mode_dump = 0, mode_extract = 0, mode_inject = 0;
920         int mode_spifreq = 0, mode_em100 = 0, mode_locked = 0;
921         int mode_unlocked = 0, mode_write = 0, mode_write_descriptor = 0;
922         int create = 0;
923         char *region_type_string = NULL, *inject_fname = NULL;
924         char *desc_fname = NULL, *addr_str = NULL;
925         int region_type = -1, inputfreq = 0;
926         enum spi_frequency spifreq = SPI_FREQUENCY_20MHZ;
927         struct input_file input_file[WRITE_MAX], *ifile, *fdt = NULL;
928         unsigned char wr_idx, wr_num = 0;
929         int rom_size = -1;
930         bool write_it;
931         char *filename;
932         char *outfile = NULL;
933         struct stat buf;
934         int size = 0;
935         unsigned int ucode_ptr = 0;
936         bool have_uboot = false;
937         int bios_fd;
938         char *image;
939         int ret;
940         static struct option long_options[] = {
941                 {"create", 0, NULL, 'c'},
942                 {"dump", 0, NULL, 'd'},
943                 {"descriptor", 1, NULL, 'D'},
944                 {"em100", 0, NULL, 'e'},
945                 {"extract", 0, NULL, 'x'},
946                 {"fdt", 1, NULL, 'f'},
947                 {"inject", 1, NULL, 'i'},
948                 {"lock", 0, NULL, 'l'},
949                 {"microcode", 1, NULL, 'm'},
950                 {"romsize", 1, NULL, 'r'},
951                 {"spifreq", 1, NULL, 's'},
952                 {"unlock", 0, NULL, 'u'},
953                 {"uboot", 1, NULL, 'U'},
954                 {"write", 1, NULL, 'w'},
955                 {"version", 0, NULL, 'v'},
956                 {"help", 0, NULL, 'h'},
957                 {0, 0, 0, 0}
958         };
959
960         while ((opt = getopt_long(argc, argv, "cdD:ef:hi:lm:r:s:uU:vw:x?",
961                                   long_options, &option_index)) != EOF) {
962                 switch (opt) {
963                 case 'c':
964                         create = 1;
965                         break;
966                 case 'd':
967                         mode_dump = 1;
968                         break;
969                 case 'D':
970                         mode_write_descriptor = 1;
971                         desc_fname = optarg;
972                         break;
973                 case 'e':
974                         mode_em100 = 1;
975                         break;
976                 case 'i':
977                         if (get_two_words(optarg, &region_type_string,
978                                           &inject_fname)) {
979                                 print_usage(argv[0]);
980                                 exit(EXIT_FAILURE);
981                         }
982                         if (!strcasecmp("Descriptor", region_type_string))
983                                 region_type = 0;
984                         else if (!strcasecmp("BIOS", region_type_string))
985                                 region_type = 1;
986                         else if (!strcasecmp("ME", region_type_string))
987                                 region_type = 2;
988                         else if (!strcasecmp("GbE", region_type_string))
989                                 region_type = 3;
990                         else if (!strcasecmp("Platform", region_type_string))
991                                 region_type = 4;
992                         if (region_type == -1) {
993                                 fprintf(stderr, "No such region type: '%s'\n\n",
994                                         region_type_string);
995                                 print_usage(argv[0]);
996                                 exit(EXIT_FAILURE);
997                         }
998                         mode_inject = 1;
999                         break;
1000                 case 'l':
1001                         mode_locked = 1;
1002                         break;
1003                 case 'm':
1004                         ucode_ptr = strtoul(optarg, NULL, 0);
1005                         break;
1006                 case 'r':
1007                         rom_size = strtol(optarg, NULL, 0);
1008                         debug("ROM size %d\n", rom_size);
1009                         break;
1010                 case 's':
1011                         /* Parse the requested SPI frequency */
1012                         inputfreq = strtol(optarg, NULL, 0);
1013                         switch (inputfreq) {
1014                         case 20:
1015                                 spifreq = SPI_FREQUENCY_20MHZ;
1016                                 break;
1017                         case 33:
1018                                 spifreq = SPI_FREQUENCY_33MHZ;
1019                                 break;
1020                         case 50:
1021                                 spifreq = SPI_FREQUENCY_50MHZ;
1022                                 break;
1023                         default:
1024                                 fprintf(stderr, "Invalid SPI Frequency: %d\n",
1025                                         inputfreq);
1026                                 print_usage(argv[0]);
1027                                 exit(EXIT_FAILURE);
1028                         }
1029                         mode_spifreq = 1;
1030                         break;
1031                 case 'u':
1032                         mode_unlocked = 1;
1033                         break;
1034                 case 'v':
1035                         print_version();
1036                         exit(EXIT_SUCCESS);
1037                         break;
1038                 case 'w':
1039                 case 'U':
1040                 case 'f':
1041                         ifile = &input_file[wr_num];
1042                         mode_write = 1;
1043                         if (wr_num < WRITE_MAX) {
1044                                 if (get_two_words(optarg, &addr_str,
1045                                                   &ifile->fname)) {
1046                                         print_usage(argv[0]);
1047                                         exit(EXIT_FAILURE);
1048                                 }
1049                                 ifile->addr = strtoll(optarg, NULL, 0);
1050                                 ifile->type = opt == 'f' ? IF_fdt :
1051                                         opt == 'U' ? IF_uboot : IF_normal;
1052                                 if (ifile->type == IF_fdt)
1053                                         fdt = ifile;
1054                                 else if (ifile->type == IF_uboot)
1055                                         have_uboot = true;
1056                                 wr_num++;
1057                         } else {
1058                                 fprintf(stderr,
1059                                         "The number of files to write simultaneously exceeds the limitation (%d)\n",
1060                                         WRITE_MAX);
1061                         }
1062                         break;
1063                 case 'x':
1064                         mode_extract = 1;
1065                         break;
1066                 case 'h':
1067                 case '?':
1068                 default:
1069                         print_usage(argv[0]);
1070                         exit(EXIT_SUCCESS);
1071                         break;
1072                 }
1073         }
1074
1075         if (mode_locked == 1 && mode_unlocked == 1) {
1076                 fprintf(stderr, "Locking/Unlocking FD and ME are mutually exclusive\n");
1077                 exit(EXIT_FAILURE);
1078         }
1079
1080         if (mode_inject == 1 && mode_write == 1) {
1081                 fprintf(stderr, "Inject/Write are mutually exclusive\n");
1082                 exit(EXIT_FAILURE);
1083         }
1084
1085         if ((mode_dump + mode_extract + mode_inject +
1086                 (mode_spifreq | mode_em100 | mode_unlocked |
1087                  mode_locked)) > 1) {
1088                 fprintf(stderr, "You may not specify more than one mode.\n\n");
1089                 print_usage(argv[0]);
1090                 exit(EXIT_FAILURE);
1091         }
1092
1093         if ((mode_dump + mode_extract + mode_inject + mode_spifreq +
1094              mode_em100 + mode_locked + mode_unlocked + mode_write +
1095              mode_write_descriptor) == 0 && !create) {
1096                 fprintf(stderr, "You need to specify a mode.\n\n");
1097                 print_usage(argv[0]);
1098                 exit(EXIT_FAILURE);
1099         }
1100
1101         if (create && rom_size == -1) {
1102                 fprintf(stderr, "You need to specify a rom size when creating.\n\n");
1103                 exit(EXIT_FAILURE);
1104         }
1105
1106         if (optind + 1 != argc) {
1107                 fprintf(stderr, "You need to specify a file.\n\n");
1108                 print_usage(argv[0]);
1109                 exit(EXIT_FAILURE);
1110         }
1111
1112         if (have_uboot && !fdt) {
1113                 fprintf(stderr,
1114                         "You must supply a device tree file for U-Boot\n\n");
1115                 print_usage(argv[0]);
1116                 exit(EXIT_FAILURE);
1117         }
1118
1119         filename = argv[optind];
1120         if (optind + 2 != argc)
1121                 outfile = argv[optind + 1];
1122
1123         if (create)
1124                 bios_fd = open(filename, O_WRONLY | O_CREAT, 0666);
1125         else
1126                 bios_fd = open(filename, outfile ? O_RDONLY : O_RDWR);
1127
1128         if (bios_fd == -1) {
1129                 perror("Could not open file");
1130                 exit(EXIT_FAILURE);
1131         }
1132
1133         if (!create) {
1134                 if (fstat(bios_fd, &buf) == -1) {
1135                         perror("Could not stat file");
1136                         exit(EXIT_FAILURE);
1137                 }
1138                 size = buf.st_size;
1139         }
1140
1141         debug("File %s is %d bytes\n", filename, size);
1142
1143         if (rom_size == -1)
1144                 rom_size = size;
1145
1146         image = malloc(rom_size);
1147         if (!image) {
1148                 printf("Out of memory.\n");
1149                 exit(EXIT_FAILURE);
1150         }
1151
1152         memset(image, '\xff', rom_size);
1153         if (!create && read(bios_fd, image, size) != size) {
1154                 perror("Could not read file");
1155                 exit(EXIT_FAILURE);
1156         }
1157         if (size != rom_size) {
1158                 debug("ROM size changed to %d bytes\n", rom_size);
1159                 size = rom_size;
1160         }
1161
1162         write_it = true;
1163         ret = 0;
1164         if (mode_dump) {
1165                 ret = dump_fd(image, size);
1166                 write_it = false;
1167         }
1168
1169         if (mode_extract) {
1170                 ret = write_regions(image, size);
1171                 write_it = false;
1172         }
1173
1174         if (mode_write_descriptor)
1175                 ret = write_data(image, size, -size, desc_fname, 0);
1176
1177         if (mode_inject)
1178                 ret = inject_region(image, size, region_type, inject_fname);
1179
1180         if (mode_write) {
1181                 int offset_uboot_top = 0;
1182
1183                 for (wr_idx = 0; wr_idx < wr_num; wr_idx++) {
1184                         ifile = &input_file[wr_idx];
1185                         if (ifile->type == IF_fdt) {
1186                                 continue;
1187                         } else if (ifile->type == IF_uboot) {
1188                                 ret = write_uboot(image, size, ifile, fdt,
1189                                                   ucode_ptr);
1190                                 offset_uboot_top = ret;
1191                         } else {
1192                                 ret = write_data(image, size, ifile->addr,
1193                                          ifile->fname, offset_uboot_top);
1194                         }
1195                         if (ret < 0)
1196                                 break;
1197                 }
1198         }
1199
1200         if (mode_spifreq)
1201                 set_spi_frequency(image, size, spifreq);
1202
1203         if (mode_em100)
1204                 set_em100_mode(image, size);
1205
1206         if (mode_locked)
1207                 lock_descriptor(image, size);
1208
1209         if (mode_unlocked)
1210                 unlock_descriptor(image, size);
1211
1212         if (write_it) {
1213                 if (outfile) {
1214                         ret = write_image(outfile, image, size);
1215                 } else {
1216                         if (lseek(bios_fd, 0, SEEK_SET)) {
1217                                 perror("Error while seeking");
1218                                 ret = -1;
1219                         }
1220                         if (write(bios_fd, image, size) != size) {
1221                                 perror("Error while writing");
1222                                 ret = -1;
1223                         }
1224                 }
1225         }
1226
1227         free(image);
1228         close(bios_fd);
1229
1230         return ret < 0 ? 1 : 0;
1231 }