source: trunk/cli_classic.c @ 1484

Revision 1484, 14.6 KB checked in by hailfinger, 3 weeks ago (diff)

Postpone layout file reading

Layout file reading should happen after option parsing like all other
file accesses.
Guard against multiple --layout parameters.

Followup fix for r1483: Remove -m short option from getopt.

Signed-off-by: Carl-Daniel Hailfinger <c-d.hailfinger.devel.2006@…>
Acked-by: Stefan Tauner <stefan.tauner@…>
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1/*
2 * This file is part of the flashrom project.
3 *
4 * Copyright (C) 2000 Silicon Integrated System Corporation
5 * Copyright (C) 2004 Tyan Corp <yhlu@tyan.com>
6 * Copyright (C) 2005-2008 coresystems GmbH
7 * Copyright (C) 2008,2009,2010 Carl-Daniel Hailfinger
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
22 */
23
24#include <stdio.h>
25#include <fcntl.h>
26#include <sys/stat.h>
27#include <string.h>
28#include <stdlib.h>
29#include <getopt.h>
30#include "flash.h"
31#include "flashchips.h"
32#include "programmer.h"
33
34#if CONFIG_INTERNAL == 1
35static enum programmer default_programmer = PROGRAMMER_INTERNAL;
36#elif CONFIG_DUMMY == 1
37static enum programmer default_programmer = PROGRAMMER_DUMMY;
38#else
39/* If neither internal nor dummy are selected, we must pick a sensible default.
40 * Since there is no reason to prefer a particular external programmer, we fail
41 * if more than one of them is selected. If only one is selected, it is clear
42 * that the user wants that one to become the default.
43 */
44#if CONFIG_NIC3COM+CONFIG_NICREALTEK+CONFIG_NICNATSEMI+CONFIG_GFXNVIDIA+CONFIG_DRKAISER+CONFIG_SATASII+CONFIG_ATAHPT+CONFIG_FT2232_SPI+CONFIG_SERPROG+CONFIG_BUSPIRATE_SPI+CONFIG_DEDIPROG+CONFIG_RAYER_SPI+CONFIG_NICINTEL+CONFIG_NICINTEL_SPI+CONFIG_OGP_SPI+CONFIG_SATAMV > 1
45#error Please enable either CONFIG_DUMMY or CONFIG_INTERNAL or disable support for all programmers except one.
46#endif
47static enum programmer default_programmer =
48#if CONFIG_NIC3COM == 1
49        PROGRAMMER_NIC3COM
50#endif
51#if CONFIG_NICREALTEK == 1
52        PROGRAMMER_NICREALTEK
53#endif
54#if CONFIG_NICNATSEMI == 1
55        PROGRAMMER_NICNATSEMI
56#endif
57#if CONFIG_GFXNVIDIA == 1
58        PROGRAMMER_GFXNVIDIA
59#endif
60#if CONFIG_DRKAISER == 1
61        PROGRAMMER_DRKAISER
62#endif
63#if CONFIG_SATASII == 1
64        PROGRAMMER_SATASII
65#endif
66#if CONFIG_ATAHPT == 1
67        PROGRAMMER_ATAHPT
68#endif
69#if CONFIG_FT2232_SPI == 1
70        PROGRAMMER_FT2232_SPI
71#endif
72#if CONFIG_SERPROG == 1
73        PROGRAMMER_SERPROG
74#endif
75#if CONFIG_BUSPIRATE_SPI == 1
76        PROGRAMMER_BUSPIRATE_SPI
77#endif
78#if CONFIG_DEDIPROG == 1
79        PROGRAMMER_DEDIPROG
80#endif
81#if CONFIG_RAYER_SPI == 1
82        PROGRAMMER_RAYER_SPI
83#endif
84#if CONFIG_NICINTEL == 1
85        PROGRAMMER_NICINTEL
86#endif
87#if CONFIG_NICINTEL_SPI == 1
88        PROGRAMMER_NICINTEL_SPI
89#endif
90#if CONFIG_OGP_SPI == 1
91        PROGRAMMER_OGP_SPI
92#endif
93#if CONFIG_SATAMV == 1
94        PROGRAMMER_SATAMV
95#endif
96#if CONFIG_LINUX_SPI == 1
97        PROGRAMMER_LINUX_SPI
98#endif
99;
100#endif
101
102static void cli_classic_usage(const char *name)
103{
104        printf("Usage: flashrom [-n] [-V] [-f] [-h|-R|-L|"
105#if CONFIG_PRINT_WIKI == 1
106                 "-z|"
107#endif
108                 "-E|-r <file>|-w <file>|-v <file>]\n"
109               "       [-c <chipname>] [-l <file>]\n"
110               "       [-i <image>] [-p <programmername>[:<parameters>]]\n\n");
111
112        printf("Please note that the command line interface for flashrom has "
113                 "changed between\n"
114               "0.9.1 and 0.9.2 and will change again before flashrom 1.0.\n"
115               "Do not use flashrom in scripts or other automated tools "
116                 "without checking\n"
117               "that your flashrom version won't interpret options in a "
118                 "different way.\n\n");
119
120        printf("   -h | --help                       print this help text\n"
121               "   -R | --version                    print version (release)\n"
122               "   -r | --read <file>                read flash and save to "
123                 "<file>\n"
124               "   -w | --write <file>               write <file> to flash\n"
125               "   -v | --verify <file>              verify flash against "
126                 "<file>\n"
127               "   -E | --erase                      erase flash device\n"
128               "   -V | --verbose                    more verbose output\n"
129               "   -c | --chip <chipname>            probe only for specified "
130                 "flash chip\n"
131               "   -f | --force                      force specific operations "
132                 "(see man page)\n"
133               "   -n | --noverify                   don't auto-verify\n"
134               "   -l | --layout <file>              read ROM layout from "
135                 "<file>\n"
136               "   -i | --image <name>               only flash image <name> "
137                 "from flash layout\n"
138               "   -L | --list-supported             print supported devices\n"
139#if CONFIG_PRINT_WIKI == 1
140               "   -z | --list-supported-wiki        print supported devices "
141                 "in wiki syntax\n"
142#endif
143               "   -p | --programmer <name>[:<param>] specify the programmer "
144                 "device\n");
145
146        list_programmers_linebreak(37, 80, 1);
147        printf("\nYou can specify one of -h, -R, -L, "
148#if CONFIG_PRINT_WIKI == 1
149                 "-z, "
150#endif
151                 "-E, -r, -w, -v or no operation.\n"
152               "If no operation is specified, flashrom will only probe for "
153                 "flash chips.\n\n");
154}
155
156static void cli_classic_abort_usage(void)
157{
158        printf("Please run \"flashrom --help\" for usage info.\n");
159        exit(1);
160}
161
162int main(int argc, char *argv[])
163{
164        unsigned long size;
165        /* Probe for up to three flash chips. */
166        const struct flashchip *flash;
167        struct flashctx flashes[3];
168        struct flashctx *fill_flash;
169        const char *name;
170        int namelen, opt, i, j;
171        int startchip = 0, chipcount = 0, option_index = 0, force = 0;
172#if CONFIG_PRINT_WIKI == 1
173        int list_supported_wiki = 0;
174#endif
175        int read_it = 0, write_it = 0, erase_it = 0, verify_it = 0;
176        int dont_verify_it = 0, list_supported = 0, operation_specified = 0;
177        enum programmer prog = PROGRAMMER_INVALID;
178        int ret = 0;
179
180        static const char optstring[] = "r:Rw:v:nVEfc:l:i:p:Lzh";
181        static const struct option long_options[] = {
182                {"read",                1, NULL, 'r'},
183                {"write",               1, NULL, 'w'},
184                {"erase",               0, NULL, 'E'},
185                {"verify",              1, NULL, 'v'},
186                {"noverify",            0, NULL, 'n'},
187                {"chip",                1, NULL, 'c'},
188                {"verbose",             0, NULL, 'V'},
189                {"force",               0, NULL, 'f'},
190                {"layout",              1, NULL, 'l'},
191                {"image",               1, NULL, 'i'},
192                {"list-supported",      0, NULL, 'L'},
193                {"list-supported-wiki", 0, NULL, 'z'},
194                {"programmer",          1, NULL, 'p'},
195                {"help",                0, NULL, 'h'},
196                {"version",             0, NULL, 'R'},
197                {NULL,                  0, NULL, 0},
198        };
199
200        char *filename = NULL;
201        char *layoutfile = NULL;
202        char *tempstr = NULL;
203        char *pparam = NULL;
204
205        print_version();
206        print_banner();
207
208        if (selfcheck())
209                exit(1);
210
211        setbuf(stdout, NULL);
212        /* FIXME: Delay all operation_specified checks until after command
213         * line parsing to allow --help overriding everything else.
214         */
215        while ((opt = getopt_long(argc, argv, optstring,
216                                  long_options, &option_index)) != EOF) {
217                switch (opt) {
218                case 'r':
219                        if (++operation_specified > 1) {
220                                fprintf(stderr, "More than one operation "
221                                        "specified. Aborting.\n");
222                                cli_classic_abort_usage();
223                        }
224                        filename = strdup(optarg);
225                        read_it = 1;
226                        break;
227                case 'w':
228                        if (++operation_specified > 1) {
229                                fprintf(stderr, "More than one operation "
230                                        "specified. Aborting.\n");
231                                cli_classic_abort_usage();
232                        }
233                        filename = strdup(optarg);
234                        write_it = 1;
235                        break;
236                case 'v':
237                        //FIXME: gracefully handle superfluous -v
238                        if (++operation_specified > 1) {
239                                fprintf(stderr, "More than one operation "
240                                        "specified. Aborting.\n");
241                                cli_classic_abort_usage();
242                        }
243                        if (dont_verify_it) {
244                                fprintf(stderr, "--verify and --noverify are"
245                                        "mutually exclusive. Aborting.\n");
246                                cli_classic_abort_usage();
247                        }
248                        filename = strdup(optarg);
249                        verify_it = 1;
250                        break;
251                case 'n':
252                        if (verify_it) {
253                                fprintf(stderr, "--verify and --noverify are"
254                                        "mutually exclusive. Aborting.\n");
255                                cli_classic_abort_usage();
256                        }
257                        dont_verify_it = 1;
258                        break;
259                case 'c':
260                        chip_to_probe = strdup(optarg);
261                        break;
262                case 'V':
263                        verbose++;
264                        break;
265                case 'E':
266                        if (++operation_specified > 1) {
267                                fprintf(stderr, "More than one operation "
268                                        "specified. Aborting.\n");
269                                cli_classic_abort_usage();
270                        }
271                        erase_it = 1;
272                        break;
273                case 'f':
274                        force = 1;
275                        break;
276                case 'l':
277                        if (layoutfile) {
278                                fprintf(stderr, "Error: --layout specified "
279                                        "more than once. Aborting.\n");
280                                cli_classic_abort_usage();
281                        }
282                        layoutfile = strdup(optarg);
283                        break;
284                case 'i':
285                        tempstr = strdup(optarg);
286                        if (register_include_arg(tempstr))
287                                cli_classic_abort_usage();
288                        break;
289                case 'L':
290                        if (++operation_specified > 1) {
291                                fprintf(stderr, "More than one operation "
292                                        "specified. Aborting.\n");
293                                cli_classic_abort_usage();
294                        }
295                        list_supported = 1;
296                        break;
297                case 'z':
298#if CONFIG_PRINT_WIKI == 1
299                        if (++operation_specified > 1) {
300                                fprintf(stderr, "More than one operation "
301                                        "specified. Aborting.\n");
302                                cli_classic_abort_usage();
303                        }
304                        list_supported_wiki = 1;
305#else
306                        fprintf(stderr, "Error: Wiki output was not compiled "
307                                "in. Aborting.\n");
308                        cli_classic_abort_usage();
309#endif
310                        break;
311                case 'p':
312                        if (prog != PROGRAMMER_INVALID) {
313                                fprintf(stderr, "Error: --programmer specified "
314                                        "more than once. You can separate "
315                                        "multiple\nparameters for a programmer "
316                                        "with \",\". Please see the man page "
317                                        "for details.\n");
318                                cli_classic_abort_usage();
319                        }
320                        for (prog = 0; prog < PROGRAMMER_INVALID; prog++) {
321                                name = programmer_table[prog].name;
322                                namelen = strlen(name);
323                                if (strncmp(optarg, name, namelen) == 0) {
324                                        switch (optarg[namelen]) {
325                                        case ':':
326                                                pparam = strdup(optarg + namelen + 1);
327                                                if (!strlen(pparam)) {
328                                                        free(pparam);
329                                                        pparam = NULL;
330                                                }
331                                                break;
332                                        case '\0':
333                                                break;
334                                        default:
335                                                /* The continue refers to the
336                                                 * for loop. It is here to be
337                                                 * able to differentiate between
338                                                 * foo and foobar.
339                                                 */
340                                                continue;
341                                        }
342                                        break;
343                                }
344                        }
345                        if (prog == PROGRAMMER_INVALID) {
346                                fprintf(stderr, "Error: Unknown programmer "
347                                        "%s.\n", optarg);
348                                cli_classic_abort_usage();
349                        }
350                        break;
351                case 'R':
352                        /* print_version() is always called during startup. */
353                        if (++operation_specified > 1) {
354                                fprintf(stderr, "More than one operation "
355                                        "specified. Aborting.\n");
356                                cli_classic_abort_usage();
357                        }
358                        exit(0);
359                        break;
360                case 'h':
361                        if (++operation_specified > 1) {
362                                fprintf(stderr, "More than one operation "
363                                        "specified. Aborting.\n");
364                                cli_classic_abort_usage();
365                        }
366                        cli_classic_usage(argv[0]);
367                        exit(0);
368                        break;
369                default:
370                        cli_classic_abort_usage();
371                        break;
372                }
373        }
374
375        if (optind < argc) {
376                fprintf(stderr, "Error: Extra parameter found.\n");
377                cli_classic_abort_usage();
378        }
379
380        /* FIXME: Print the actions flashrom will take. */
381
382        if (list_supported) {
383                print_supported();
384                exit(0);
385        }
386
387#if CONFIG_PRINT_WIKI == 1
388        if (list_supported_wiki) {
389                print_supported_wiki();
390                exit(0);
391        }
392#endif
393
394        if (layoutfile && read_romlayout(layoutfile))
395                cli_classic_abort_usage();
396        if (process_include_args())
397                cli_classic_abort_usage();
398
399        /* Does a chip with the requested name exist in the flashchips array? */
400        if (chip_to_probe) {
401                for (flash = flashchips; flash && flash->name; flash++)
402                        if (!strcmp(flash->name, chip_to_probe))
403                                break;
404                if (!flash || !flash->name) {
405                        fprintf(stderr, "Error: Unknown chip '%s' specified.\n",
406                                chip_to_probe);
407                        printf("Run flashrom -L to view the hardware supported "
408                               "in this flashrom version.\n");
409                        exit(1);
410                }
411                /* Clean up after the check. */
412                flash = NULL;
413        }
414
415        if (prog == PROGRAMMER_INVALID)
416                prog = default_programmer;
417
418        /* FIXME: Delay calibration should happen in programmer code. */
419        myusec_calibrate_delay();
420
421        if (programmer_init(prog, pparam)) {
422                fprintf(stderr, "Error: Programmer initialization failed.\n");
423                ret = 1;
424                goto out_shutdown;
425        }
426        tempstr = flashbuses_to_text(get_buses_supported());
427        msg_pdbg("The following protocols are supported: %s.\n",
428                 tempstr);
429        free(tempstr);
430
431        for (j = 0; j < registered_programmer_count; j++) {
432                startchip = 0;
433                while (chipcount < ARRAY_SIZE(flashes)) {
434                        startchip = probe_flash(&registered_programmers[j],
435                                                startchip, 
436                                                &flashes[chipcount], 0);
437                        if (startchip == -1)
438                                break;
439                        chipcount++;
440                        startchip++;
441                }
442        }
443
444        if (chipcount > 1) {
445                printf("Multiple flash chips were detected: \"%s\"",
446                        flashes[0].name);
447                for (i = 1; i < chipcount; i++)
448                        printf(", \"%s\"", flashes[i].name);
449                printf("\nPlease specify which chip to use with the "
450                       "-c <chipname> option.\n");
451                ret = 1;
452                goto out_shutdown;
453        } else if (!chipcount) {
454                printf("No EEPROM/flash device found.\n");
455                if (!force || !chip_to_probe) {
456                        printf("Note: flashrom can never write if the flash "
457                               "chip isn't found automatically.\n");
458                }
459#if 0 // FIXME: What happens for a forced chip read if multiple compatible programmers are registered?
460                if (force && read_it && chip_to_probe) {
461                        printf("Force read (-f -r -c) requested, pretending "
462                               "the chip is there:\n");
463                        startchip = probe_flash(0, &flashes[0], 1);
464                        if (startchip == -1) {
465                                printf("Probing for flash chip '%s' failed.\n",
466                                       chip_to_probe);
467                                ret = 1;
468                                goto out_shutdown;
469                        }
470                        printf("Please note that forced reads most likely "
471                               "contain garbage.\n");
472                        return read_flash_to_file(&flashes[0], filename);
473                }
474#endif
475                ret = 1;
476                goto out_shutdown;
477        } else if (!chip_to_probe) {
478                /* repeat for convenience when looking at foreign logs */
479                tempstr = flashbuses_to_text(flashes[0].bustype);
480                msg_gdbg("Found %s flash chip \"%s\" (%d kB, %s).\n",
481                         flashes[0].vendor, flashes[0].name,
482                         flashes[0].total_size, tempstr);
483                free(tempstr);
484        }
485
486        fill_flash = &flashes[0];
487
488        check_chip_supported(fill_flash);
489
490        size = fill_flash->total_size * 1024;
491        if (check_max_decode(fill_flash->pgm->buses_supported & fill_flash->bustype, size) &&
492            (!force)) {
493                fprintf(stderr, "Chip is too big for this programmer "
494                        "(-V gives details). Use --force to override.\n");
495                ret = 1;
496                goto out_shutdown;
497        }
498
499        if (!(read_it | write_it | verify_it | erase_it)) {
500                printf("No operations were specified.\n");
501                goto out_shutdown;
502        }
503
504        if (!filename && !erase_it) {
505                printf("Error: No filename specified.\n");
506                ret = 1;
507                goto out_shutdown;
508        }
509
510        /* Always verify write operations unless -n is used. */
511        if (write_it && !dont_verify_it)
512                verify_it = 1;
513
514        /* FIXME: We should issue an unconditional chip reset here. This can be
515         * done once we have a .reset function in struct flashchip.
516         * Give the chip time to settle.
517         */
518        programmer_delay(100000);
519        return doit(fill_flash, force, filename, read_it, write_it, erase_it, verify_it);
520
521out_shutdown:
522        programmer_shutdown();
523        return ret;
524}
Note: See TracBrowser for help on using the repository browser.