Gitiles
Code Review Sign In
review.sourcearcade.org / flashprog / a1b7f3521f66a19a2d4c9a6a373c5a7ab36e1473
commita1b7f3521f66a19a2d4c9a6a373c5a7ab36e1473[log] [tgz]
authorNico Huber <nico.h@gmx.de>Mon Mar 25 18:32:11 2024 +0100
committerNico Huber <nico.h@gmx.de>Mon Jul 22 10:08:47 2024 +0000
treefd996296810ab45fe99d29d8dc254f6d496f3091
parent008a44fa1c33b8a77c90b4e9dba267ae23c01056 [diff]
dediprog: Implement multi-i/o reads

This implements i/o-mode switches and opcode handling for multi-i/o
reads with protocol versions 2 and 3. The mode switching is done by
a simple command  that takes an enum just as our internal `io_mode`
as argument.

The opcode handling differs between protocol versions. For protocol
v2, we keep the current behavior for single-i/o operations and only
set the matching opcode. Tests with an SF600Plus-G2 have shown that
the programmer automatically chooses the address length  and number
of dummy cycles. It is unknown, however,  if it chooses these para-
meters based on the opcode or the configured i/o mode. For dual-out
reads,  it seems to choose the wrong number of dummy cycles. Hence,
we mask the respective support bit for the v2 case.

For protocol v3,  a new `read mode' was discovered in traces of the
Dediprog Windows application.  It allows to explicitly specify  the
opcode, the address length, and the number of dummy cycles. We call
this READ_MODE_CONFIGURABLE. As this is the only way to make use of
the additional command bytes of the v3 protocol, we can assume that
this mode always works with v3.

For partial reads, i.e. not multiples of 512B blocks,  that have to
go through dediprog_spi_send_command(),  we temporarily disable the
chosen `.spi_fast_read` function. This is necessary, because multi-
io is not supported on this path.

We enable dual i/o by default for protocol v3 devices. This should
work out of the box with many compatible flash chips. The command-
line logic is a little convoluted this way,  but can be refactored
once protocol v2 devices are tested.

Change-Id: Ib07b1b61eccc19c7ead9f64c980b37feabfa70a8
Signed-off-by: Nico Huber <nico.h@gmx.de>
Reviewed-on: https://review.sourcearcade.org/c/flashprog/+/114
Reviewed-by: Arthur Heymans <arthur@aheymans.xyz>
4 files changed
tree: fd996296810ab45fe99d29d8dc254f6d496f3091
  1. Documentation/
  2. include/
  3. Makefile.d/
  4. platform/
  5. util/
  6. .editorconfig
  7. .gitattributes
  8. .gitignore
  9. .gitreview
  10. 82802ab.c
  11. amd_imc.c
  12. amd_spi100.c
  13. at45db.c
  14. atahpt.c
  15. atapromise.c
  16. atavia.c
  17. bitbang_spi.c
  18. board_enable.c
  19. buspirate_spi.c
  20. cbtable.c
  21. ch341a_spi.c
  22. ch347_spi.c
  23. chipset_enable.c
  24. cli_classic.c
  25. cli_common.c
  26. cli_output.c
  27. COPYING
  28. custom_baud.c
  29. custom_baud_darwin.c
  30. custom_baud_linux.c
  31. dediprog.c
  32. developerbox_spi.c
  33. digilent_spi.c
  34. dirtyjtag_spi.c
  35. dmi.c
  36. Doxyfile
  37. drkaiser.c
  38. dummyflasher.c
  39. edi.c
  40. en29lv640b.c
  41. flashchips.c
  42. flashprog.8.tmpl
  43. flashprog.c
  44. fmap.c
  45. ft2232_spi.c
  46. ft4222_spi.c
  47. gfxnvidia.c
  48. helpers.c
  49. helpers_fileio.c
  50. hwaccess_physmap.c
  51. hwaccess_x86_io.c
  52. hwaccess_x86_msr.c
  53. ich_descriptors.c
  54. ichspi.c
  55. internal.c
  56. it8212.c
  57. it87spi.c
  58. jedec.c
  59. jlink_spi.c
  60. known_boards.c
  61. layout.c
  62. libflashprog.c
  63. libflashprog.map
  64. linux_gpio2_spi.c
  65. linux_gpio_spi.c
  66. linux_mtd.c
  67. linux_spi.c
  68. Makefile
  69. Makefile.include
  70. mcp6x_spi.c
  71. memory_bus.c
  72. meson.build
  73. meson_options.txt
  74. mstarddc_spi.c
  75. ni845x_spi.c
  76. nic3com.c
  77. nicintel.c
  78. nicintel_eeprom.c
  79. nicintel_spi.c
  80. nicnatsemi.c
  81. nicrealtek.c
  82. ogp_spi.c
  83. opaque.c
  84. parallel.c
  85. pcidev.c
  86. pickit2_spi.c
  87. pony_spi.c
  88. print.c
  89. print_wiki.c
  90. processor_enable.c
  91. programmer.c
  92. programmer_table.c
  93. rayer_spi.c
  94. README.md
  95. satamv.c
  96. satasii.c
  97. sb600spi.c
  98. serial.c
  99. serprog.c
  100. sfdp.c
  101. spi.c
  102. spi25.c
  103. spi25_prepare.c
  104. spi25_statusreg.c
  105. spi95.c
  106. sst28sf040.c
  107. sst49lfxxxc.c
  108. sst_fwhub.c
  109. stlinkv3_spi.c
  110. stm50.c
  111. test_build.sh
  112. udelay.c
  113. usbblaster_spi.c
  114. usbdev.c
  115. w29ee011.c
  116. w39.c
  117. wbsio_spi.c
  118. writeprotect.c
  119. writeprotect_ranges.c
README.md

flashprog

flashprog is a utility for detecting, reading, writing, verifying and erasing flash chips. It is often used to flash BIOS/EFI/coreboot/firmware images in-system using a supported mainboard, but it also supports flashing of network cards (NICs), SATA controller cards, and other external devices which can program flash chips.

It supports a wide range of flash chips (most commonly found in SOIC8, DIP8, SOIC16, WSON8, PLCC32, DIP32, TSOP32, and TSOP40 packages), which use various protocols such as LPC, FWH, parallel flash, or SPI.

Do not use flashprog on laptops (yet)! The embedded controller (EC) present in many laptops might interact badly with any attempts to communicate with the flash chip and may brick your laptop.

Please make a backup of your flash chip before writing to it.

Please see the flashprog(8) manpage.

Packaging

To package flashprog and remove dependencies on Git, either use make export or make tarball

'make export' will export all flashprog files from the Git repository at revision HEAD into a directory named "$EXPORTDIR/flashprog-$RELEASENAME" and will additionally add a "versioninfo.inc" file in that directory to contain the Git revision of the exported tree and a date for the manual page.

'make tarball' will simply tar up the result of make export and compress it with bzip2.

The snapshot tarballs are the result of 'make tarball' and require no further processing.

Build Instructions

To build flashprog you need to install the following software:

  • pciutils+libpci (if you want support for mainboard or PCI device flashing)
  • libusb (if you want FT2232, Dediprog or USB-Blaster support)
  • libftdi (if you want FT2232 or USB-Blaster support)
  • libjaylink (if you want support for SEGGER J-Link and compatible devices)

Linux et al:

  • pciutils / libpci
  • pciutils-devel / pciutils-dev / libpci-dev
  • zlib-devel / zlib1g-dev (needed if libpci was compiled with libz support)
  • libgpiod-dev (if you want support for Linux GPIO devices)

On FreeBSD, you need the following ports:

  • devel/gmake
  • devel/libpci

On OpenBSD, you need the following ports:

  • devel/gmake
  • sysutils/pciutils

To compile on Linux, use:

make

To compile on FreeBSD, OpenBSD or DragonFly BSD, use:

gmake

To compile on Nexenta, use:

make

To compile on Solaris, use:

gmake LDFLAGS="-L$pathtolibpci" CC="gcc -I$pathtopciheaders" CFLAGS=-O2

To compile on NetBSD (with pciutils, libftdi, libusb installed in /usr/pkg/), use:

gmake

To compile and run on Darwin/Mac OS X:

Install DirectHW from coresystems GmbH. DirectHW is available at http://www.coreboot.org/DirectHW .

To cross-compile on Linux for DOS:

Get packages of the DJGPP cross compiler and install them: djgpp-filesystem djgpp-gcc djgpp-cpp djgpp-runtime djgpp-binutils

As an alternative, the DJGPP web site offers packages for download as well: djcross-binutils-2.29.1-1ap.x86_64.rpm djcross-gcc-7.2.0-1ap.x86_64.rpm djcrx-2.05-5.x86_64.rpm

The cross toolchain packages for your distribution may have slightly different names (look for packages named djgpp).

Alternatively, you could use a script to build it from scratch: https://github.com/andrewwutw/build-djgpp

You will need the libpci and libgetopt library source trees and their compiled static libraries and header files installed in some directory say libpci-libgetopt/, which will be later specified with LIBS_BASE parameter during flashprog compilation. Easiest way to handle it is to put pciutils, libgetopt and flashprog directories in one subdirectory. There will be an extra subdirectory libpci-libgetopt created, which will contain compiled libpci and libgetopt.

Download pciutils 3.5.6 and apply http://flashprog.org/File:Pciutils-3.5.6.patch.gz Compile pciutils, using following command line:

make ZLIB=no DNS=no HOST=i386-djgpp-djgpp CROSS_COMPILE=i586-pc-msdosdjgpp- \
  PREFIX=/ DESTDIR=$PWD/../libpci-libgetopt  \
  STRIP="--strip-program=i586-pc-msdosdjgpp-strip -s" install install-lib

Download and compile with 'make' http://flashprog.org/File:Libgetopt.tar.gz

Copy the libgetopt.a to ../libpci-libgetopt/lib and getopt.h to ../libpci-libgetopt/include

Enter the flashprog directory.

make CC=i586-pc-msdosdjgpp-gcc STRIP=i586-pc-msdosdjgpp-strip
LIBS_BASE=../libpci-libgetopt/ HAS_LIBPCI=yes CONFIG_LIBPCI_LDFLAGS=-lpci
strip

If you like, you can compress the resulting executable with UPX:

upx -9 flashprog.exe

To run flashprog.exe, download http://flashprog.org/File:Csdpmi7b.zip and unpack CWSDPMI.EXE into the current directory or one in PATH.

To cross-compile on Linux for Windows:

  • Get packages of the MinGW cross compiler and install them: mingw32-filesystem mingw32-cross-cpp mingw32-cross-binutils mingw32-cross-gcc mingw32-runtime mingw32-headers

  • The cross toolchain packages for your distribution may have slightly different names (look for packages named mingw). PCI-based programmers (internal etc.) are not supported on Windows.

  • Run (change CC= and STRIP= settings where appropriate) make CC=i686-w64-mingw32-gcc STRIP=i686-w64-mingw32-strip

Processor architecture dependent features:

On non-x86 architectures a few programmers don't work (yet) because they use port-based I/O which is not directly available on non-x86. Those programmers will be disabled automatically if you run "make".

Compiler quirks:

If you are using clang and if you want to enable only one driver, you may hit an overzealous compiler warning from clang. Compile with "make WARNERROR=no" to force it to continue and enjoy.

Installation

In order to install flashprog and the manpage into /usr/local, type:

make install

For installation in a different directory use DESTDIR, e.g. like this:

make DESTDIR=/usr install

If you have insufficient permissions for the destination directory, use sudo by adding sudo in front of the commands above.

Branching and release policy

  • Feature development happens on the main branch
  • Branch-off points for releases are tagged with tags that start with p, such as p1.0
  • Release branches have a .x suffix, for example 1.0.x
  • Release tags start with v, for example v1.0 or v1.0.1
  • Release candidate tags additionally end with -rcN, for example v1.0-rc1

Contact

The official flashprog website is:

http://www.flashprog.org/

Available contact methods are

https://www.flashprog.org/Contact