flashrom: Trivial README change Flashrom->flashrom

[coreboot.git] / util / flashrom / README

diff --git a/util/flashrom/README b/util/flashrom/README
index 5f5686913568ae56afeb2d9f7be4d8aebfd0660b..b13d1a734fd6c311bddf7e1b4553d2cd06289724 100644 (file)
--- a/util/flashrom/README
+++ b/util/flashrom/README
@@ -1,9 +1,13 @@
 -------------------------------------------------------------------------------
-Flashrom README
+flashrom README
 -------------------------------------------------------------------------------
 
-Flashrom is a universal flash programming utility for DIP, PLCC, or SPI
-flash ROM chips. It can be used to flash BIOS/coreboot/firmware images.
+flashrom is a utility for reading, writing, and erasing flash ROM chips.
+It's often used to flash BIOS/coreboot/firmware images.
+
+It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, and
+TSOP40 chips, which use various protocols such as LPC, FWH, parallel flash,
+or SPI.
 
 (see http://coreboot.org for details on coreboot)
 
@@ -21,7 +25,7 @@ To build the flashrom utility you need to install the following packages:
 Usage
 -----
 
- $ flashrom [-rwvEVfh] [-c chipname] [-s exclude_start] [-e exclude_end]
+ $ flashrom [-rwvEVfLhR] [-c chipname] [-s exclude_start] [-e exclude_end]
             [-m [vendor:]part] [-l file.layout] [-i imagename] [file]
    -r | --read:                      read flash and save into file
    -w | --write:                     write file into flash (default when
@@ -36,17 +40,27 @@ Usage
    -f | --force:                     force write without checking image
    -l | --layout <file.layout>:      read rom layout from file
    -i | --image <name>:              only flash image name from flash layout
+   -L | --list-supported:            print supported devices
+   -h | --help:                      print this help text
+   -R | --version:                   print the version (release)
 
  If no file is specified, then all that happens
  is that flash info is dumped and the flash chip is set to writable.
 
 
+Exit status
+-----------
+
+flashrom exits with 0 on success, 1 on most failures but with 2 if /dev/mem
+(/dev/xsvc on Solaris) can not be opened and with 3 if a call to mmap() fails.
+
+
 coreboot Table and Mainboard Identification
 --------------------------------------------
 
-Flashrom reads the coreboot table to determine the current mainboard
-(parse DMI as well in future?). If no coreboot table could be read
-or if you want to override these values, you can specify -m, e.g.:
+flashrom reads the coreboot table to determine the current mainboard. If no
+coreboot table could be read or if you want to override these values, you can
+specify -m, e.g.:
 
  $ flashrom -w --mainboard AGAMI:ARUMA agami_aruma.rom
 
@@ -58,7 +72,7 @@ coreboot table is found.
 ROM Layout Support
 ------------------
 
-Flashrom supports ROM layouts. This allows you to flash certain parts of
+flashrom supports ROM layouts. This allows you to flash certain parts of
 the flash chip only. A ROM layout file looks like follows:
 
   00000000:00008fff gfxrom
@@ -85,15 +99,6 @@ flexible and they should lead to a ROM update file format with the
 ROM layout and the ROM image in one file (cpio, zip or something?).
 
 
-Disk on Chip support
---------------------
-
-Disk on Chip support was removed from flashrom in r3382. It had already
-been disabled by default in flashrom for several years because the code
-was considered unstable and incomplete. The products intended to work
-have been End-Of-Lifed by the manufacturer for a long time.
-
-
 Supported Flash Chips / Chipsets / Mainboards
 ---------------------------------------------