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