util/flashrom/README

   1 -------------------------------------------------------------------------------
   2 Flashrom README
   3 -------------------------------------------------------------------------------
   4
   5 Flashrom is a universal flash programming utility for DIP, PLCC, or SPI
   6 flash ROM chips. It can be used to flash BIOS/coreboot/firmware images.
   7
   8 (see http://coreboot.org for details on coreboot)
   9
  10
  11 Build Requirements
  12 ------------------
  13
  14 To build the flashrom utility you need to install the following packages:
  15
  16 * pciutils
  17 * pciutils-devel / pciutils-dev / libpci-dev
  18 * zlib-devel / zlib1g-dev
  19
  20
  21 Usage
  22 -----
  23
  24  $ flashrom [-rwvEVfLhR] [-c chipname] [-s exclude_start] [-e exclude_end]
  25             [-m [vendor:]part] [-l file.layout] [-i imagename] [file]
  26    -r | --read:                      read flash and save into file
  27    -w | --write:                     write file into flash (default when
  28                                      file is specified)
  29    -v | --verify:                    verify flash against file
  30    -E | --erase:                     erase flash device
  31    -V | --verbose:                   more verbose output
  32    -c | --chip <chipname>:           probe only for specified flash chip
  33    -s | --estart <addr>:             exclude start position
  34    -e | --eend <addr>:               exclude end postion
  35    -m | --mainboard <[vendor:]part>: override mainboard settings
  36    -f | --force:                     force write without checking image
  37    -l | --layout <file.layout>:      read rom layout from file
  38    -i | --image <name>:              only flash image name from flash layout
  39    -L | --list-supported:            print supported devices
  40    -h | --help:                      print this help text
  41    -R | --version:                   print the version (release)
  42
  43  If no file is specified, then all that happens
  44  is that flash info is dumped and the flash chip is set to writable.
  45
  46
  47 Exit status
  48 -----------
  49 flashrom exits with 0 on success, 1 on most failures but with 2 if /dev/mem
  50 (/dev/xsvc on Solaris) can not be opened and with 3 if a call to mmap() fails.
  51
  52
  53 coreboot Table and Mainboard Identification
  54 --------------------------------------------
  55
  56 Flashrom reads the coreboot table to determine the current mainboard
  57 (parse DMI as well in future?). If no coreboot table could be read
  58 or if you want to override these values, you can specify -m, e.g.:
  59
  60  $ flashrom -w --mainboard AGAMI:ARUMA agami_aruma.rom
  61
  62 See the 'Supported mainboards' section in the output of 'flashrom -L' for
  63 a list of boards which require the specification of the board name, if no
  64 coreboot table is found.
  65
  66
  67 ROM Layout Support
  68 ------------------
  69
  70 Flashrom supports ROM layouts. This allows you to flash certain parts of
  71 the flash chip only. A ROM layout file looks like follows:
  72
  73   00000000:00008fff gfxrom
  74   00009000:0003ffff normal
  75   00040000:0007ffff fallback
  76
  77   i.e.:
  78   startaddr:endaddr name
  79
  80   All addresses are offsets within the file, not absolute addresses!
  81
  82 If you only want to update the normal image in a ROM you can say:
  83
  84   flashrom -w --layout rom.layout --image normal agami_aruma.rom
  85
  86 To update normal and fallback but leave the VGA BIOS alone, say:
  87
  88   flashrom -w -l rom.layout -i normal -i fallback agami_aruma.rom
  89
  90 Currently overlapping sections are not supported.
  91
  92 ROM layouts should replace the -s and -e option since they are more
  93 flexible and they should lead to a ROM update file format with the
  94 ROM layout and the ROM image in one file (cpio, zip or something?).
  95
  96
  97 Disk on Chip support
  98 --------------------
  99
 100 Disk on Chip support was removed from flashrom in r3382. It had already
 101 been disabled by default in flashrom for several years because the code
 102 was considered unstable and incomplete. The products intended to work
 103 have been End-Of-Lifed by the manufacturer for a long time.
 104
 105
 106 Supported Flash Chips / Chipsets / Mainboards
 107 ---------------------------------------------
 108
 109 Please check the output of 'flashrom -L' for the list of supported
 110 flash chips, chipsets/southbridges, and mainboards.
 111
 112 See also http://coreboot.org/Flashrom for more details.
 113