Peter Marheine has uploaded this change for review.
mediatek_i2c_spi: document programmer
This adds a manpage section describing the mediatek_i2c_spi programmer,
including some discussion of devices that are supported as well as which
systems use them.
Signed-off-by: Peter Marheine <pmarheine@chromium.org>
Change-Id: Ia63df470170fbadcabadcdad8e5acc0cde3a274b
---
M flashrom.8.tmpl
1 file changed, 38 insertions(+), 1 deletion(-)
git pull ssh://review.coreboot.org:29418/flashrom refs/changes/25/67825/1
diff --git a/flashrom.8.tmpl b/flashrom.8.tmpl
index 2cf3a38..45fb0e2 100644
--- a/flashrom.8.tmpl
+++ b/flashrom.8.tmpl
@@ -429,6 +429,8 @@
.sp
.BR "* parade_lspcon" " (for SPI flash ROMs attached to Parade Technologies LSPCONs (PS175))"
.sp
+.BR "* mediatek_i2c_spi" " (for SPI flash ROMs attached to some Mediatek display devices accessible over I2C)"
+.sp
Some programmers have optional or mandatory parameters which are described
in detail in the
.B PROGRAMMER-SPECIFIC INFORMATION
@@ -1521,7 +1523,7 @@
If the passed frequency is not supported by the adapter the nearest lower
supported frequency will be used.
.SS
-.BR "realtek_mst_i2c_spi " and " parade_lspcon " programmers
+.BR "realtek_mst_i2c_spi ", " parade_lspcon ", and " mediatek_i2c_spi " programmers
.IP
These programmers tunnel SPI commands through I2C-connected devices. The I2C
bus over which communication occurs must be specified either by device path
@@ -1575,6 +1577,27 @@
e.g. the PS175. Communication to the SPI flash is tunneled through the LSPCON
over I2C.
+.SS
+.BR "mediatek_i2c_spi " programmer
+.IP
+This programmer supports SPI flash programming for chips attached to some
+Mediatek display controllers, themselves accessed through I2C (tunneling
+SPI flash commands through a I2C connection with the host).
+.sp
+The programmer is designed to support the TSUMOP82JUQ integrated display driver
+and scaler as is used in the Google Meet Series One Desk 27 (which runs a
+version of ChromeOS and uses Flashrom in its \fBtsum-scaler-updater\fP scripts
+that ship with the OS). Other chips may use compatible protocols but have not
+been tested with this programmer, and external chip IOs may need to be
+controlled through other non-Flashrom means to configure the chip in order for
+it to operate as expected.
+.sp
+\fBdevpath\fP and \fBbus\fP options select the I2C bus to use, as described
+previously. \fBallow_brick\fP defaults to no, and must explicitly be set to
+"yes" in order for the programmer to operate. This is required because there is
+no mechanism in the driver to positively identify that a given I2C bus is
+actually connected to a supported device.
+
.SH EXAMPLES
To back up and update your BIOS, run
.sp
To view, visit change 67825. To unsubscribe, or for help writing mail filters, visit settings.