Difference between revisions of "Board Testing HOWTO"

From flashrom
Jump to: navigation, search
m
(-p internal)
Line 7: Line 7:
 
* To check whether flashrom knows about your chipset and ROM chip, run '''flashrom'''.
 
* To check whether flashrom knows about your chipset and ROM chip, run '''flashrom'''.
 
* If it says "Found chipset CHIPSETNAME..." and "CHIPNAME found at..." that's a good first sign.
 
* If it says "Found chipset CHIPSETNAME..." and "CHIPNAME found at..." that's a good first sign.
* To check if you can read the existing BIOS image from the chip, run '''flashrom -r backup.bin'''. Make sure that '''backup.bin''' contains a useful BIOS image (some chipsets will return 0xff for large areas of flash without any error messages).
+
* To check if you can read the existing BIOS image from the chip, run '''flashrom -p internal -r backup.bin'''. Make sure that '''backup.bin''' contains a useful BIOS image (some chipsets will return 0xff for large areas of flash without any error messages).
 
* Now the really important part, checking if ''writing'' an image on the chip works:
 
* Now the really important part, checking if ''writing'' an image on the chip works:
 
** First make sure you have a backup chip containing the original BIOS. Also, you should have verified that it actually boots your system successfully. Put away that backup chip somewhere safe.
 
** First make sure you have a backup chip containing the original BIOS. Also, you should have verified that it actually boots your system successfully. Put away that backup chip somewhere safe.
** Try inserting a ROM chip which you can safely overwrite (e.g. an empty one you bought). Then write an image onto the chip, which is ''different'' from what's on the chip right now: '''flashrom -w new.bin'''. If this works and flashrom reports "VERIFIED" your board is supported by flashrom.
+
** Try inserting a ROM chip which you can safely overwrite (e.g. an empty one you bought). Then write an image onto the chip, which is ''different'' from what's on the chip right now: '''flashrom -p internal -w new.bin'''. If this works and flashrom reports "VERIFIED" your board is supported by flashrom.
 
** If not, you might try to enable the "Enable BIOS Update" or "Write-protect BIOS" or similar options in your BIOS CMOS menu first, or set a jumper on your board (this is highly board-dependent). Also, you might have to use the flashrom '''--mainboard''' switch for some boards.
 
** If not, you might try to enable the "Enable BIOS Update" or "Write-protect BIOS" or similar options in your BIOS CMOS menu first, or set a jumper on your board (this is highly board-dependent). Also, you might have to use the flashrom '''--mainboard''' switch for some boards.
 
** If none of the above helps (but flashrom still ''does'' detect your chipset and ROM chip), there's quite likely a board-specific initialization required in flashrom, which is non-trivial to add (e.g. toggling certain custom GPIO lines etc). In that case, contact us as we may be able to help.
 
** If none of the above helps (but flashrom still ''does'' detect your chipset and ROM chip), there's quite likely a board-specific initialization required in flashrom, which is non-trivial to add (e.g. toggling certain custom GPIO lines etc). In that case, contact us as we may be able to help.
Line 17: Line 17:
 
*** For ICH/VIA SPI, lockdown can mean probe works, but write/erase doesn't. It can also mean that probe does not work, but write/read/erase (or any subset thereof) would work. For all other SPI chipsets, there is no such lockdown, so you can issue any erase/write/read command.
 
*** For ICH/VIA SPI, lockdown can mean probe works, but write/erase doesn't. It can also mean that probe does not work, but write/read/erase (or any subset thereof) would work. For all other SPI chipsets, there is no such lockdown, so you can issue any erase/write/read command.
 
*** However, some SPI chips have a WP# pin which causes the block protection bits to become readonly. Now if flashrom has a generic block protection checker for your chip, we're able to figure out if write/erase is possible. Basically, you can check if you need a board enable by setting all block protection bits, then unsetting them. If either of the operations fail, you need a board enable. If they succeed, erase and write are guaranteed to work.
 
*** However, some SPI chips have a WP# pin which causes the block protection bits to become readonly. Now if flashrom has a generic block protection checker for your chip, we're able to figure out if write/erase is possible. Basically, you can check if you need a board enable by setting all block protection bits, then unsetting them. If either of the operations fail, you need a board enable. If they succeed, erase and write are guaranteed to work.
* Please tell us about your results by sending the output of '''flashrom -V''', '''lspci -nnvvxxx''', '''superiotool -deV''' and the exact board manufacturer and model name and all of your observations and test results to the flashrom [[Mailinglist|mailing list]].
+
* Please tell us about your results by sending the output of '''flashrom -p internal -V''', '''lspci -nnvvxxx''', '''superiotool -deV''' and the exact board manufacturer and model name and all of your observations and test results to the flashrom [[Mailinglist|mailing list]].
  
 
If flashrom finds your flash chip and everything works, we'd like to hear about it. If your flash chip is found, but not all operations work, we'd like to hear about it. If your flash chip or your chipset is not found, we'd like to hear about it as well, and we'll check/update the [[Supported hardware#Supported_mainboards|list of boards supported by flashrom]] accordingly (whether it works or does not work on your board).
 
If flashrom finds your flash chip and everything works, we'd like to hear about it. If your flash chip is found, but not all operations work, we'd like to hear about it. If your flash chip or your chipset is not found, we'd like to hear about it as well, and we'll check/update the [[Supported hardware#Supported_mainboards|list of boards supported by flashrom]] accordingly (whether it works or does not work on your board).

Revision as of 23:23, 23 January 2013

This page gives you hints on how to test flashrom support for your mainboard / graphics card / network card / SATA card / external programmer device.

Important information

  • DO NOT ATTEMPT TO FOLLOW THESE INSTRUCTIONS UNLESS YOU KNOW WHAT YOU ARE DOING! THIS CAN RENDER YOUR MAINBOARD TOTALLY UNUSABLE! YOU HAVE BEEN WARNED!
  • If you have a laptop/notebook/netbook, please do NOT try flashrom because interactions with the EC on these machines might crash your machine during flashing. flashrom tries to detect if a machine is a laptop, but not all laptops follow the standard, so this is not 100% reliable.
  • To check whether flashrom knows about your chipset and ROM chip, run flashrom.
  • If it says "Found chipset CHIPSETNAME..." and "CHIPNAME found at..." that's a good first sign.
  • To check if you can read the existing BIOS image from the chip, run flashrom -p internal -r backup.bin. Make sure that backup.bin contains a useful BIOS image (some chipsets will return 0xff for large areas of flash without any error messages).
  • Now the really important part, checking if writing an image on the chip works:
    • First make sure you have a backup chip containing the original BIOS. Also, you should have verified that it actually boots your system successfully. Put away that backup chip somewhere safe.
    • Try inserting a ROM chip which you can safely overwrite (e.g. an empty one you bought). Then write an image onto the chip, which is different from what's on the chip right now: flashrom -p internal -w new.bin. If this works and flashrom reports "VERIFIED" your board is supported by flashrom.
    • If not, you might try to enable the "Enable BIOS Update" or "Write-protect BIOS" or similar options in your BIOS CMOS menu first, or set a jumper on your board (this is highly board-dependent). Also, you might have to use the flashrom --mainboard switch for some boards.
    • If none of the above helps (but flashrom still does detect your chipset and ROM chip), there's quite likely a board-specific initialization required in flashrom, which is non-trivial to add (e.g. toggling certain custom GPIO lines etc). In that case, contact us as we may be able to help.
    • If you can't risk a write on a given chip and if the chip is SPI, the following guidelines may help:
      • Try probing.
      • For ICH/VIA SPI, lockdown can mean probe works, but write/erase doesn't. It can also mean that probe does not work, but write/read/erase (or any subset thereof) would work. For all other SPI chipsets, there is no such lockdown, so you can issue any erase/write/read command.
      • However, some SPI chips have a WP# pin which causes the block protection bits to become readonly. Now if flashrom has a generic block protection checker for your chip, we're able to figure out if write/erase is possible. Basically, you can check if you need a board enable by setting all block protection bits, then unsetting them. If either of the operations fail, you need a board enable. If they succeed, erase and write are guaranteed to work.
  • Please tell us about your results by sending the output of flashrom -p internal -V, lspci -nnvvxxx, superiotool -deV and the exact board manufacturer and model name and all of your observations and test results to the flashrom mailing list.

If flashrom finds your flash chip and everything works, we'd like to hear about it. If your flash chip is found, but not all operations work, we'd like to hear about it. If your flash chip or your chipset is not found, we'd like to hear about it as well, and we'll check/update the list of boards supported by flashrom accordingly (whether it works or does not work on your board).

Updating the wiki

We try to collect the status for every supported mainboard/card/device. The status table is implemented using the status template in this wiki. The status table is designed to be created by running

$ flashrom --print-supported-wiki

Write access to the wiki is only available to regular flashrom contributors. It doesn't hurt to ask on IRC if you want to change a few things on the wiki. Either someone will change the wiki for you, or you get write access (if you want to change lots of stuff and have demonstrated that you're not trying to vandalize the wiki).