1
0
mirror of https://review.coreboot.org/flashrom.git synced 2025-04-27 07:02:34 +02:00

flashrom.8.tmpl: document lspcon_i2c_spi

This programmer operates much the same as realtek_mst_i2c_spi, so the
I2C options are moved to a new section describing both programmers
and a short description is added for this programmer itself.

Signed-off-by: Peter Marheine <pmarheine@chromium.org>
Change-Id: I9ccb9694fdea29e68f062cc049efc0204917a139
Reviewed-on: https://review.coreboot.org/c/flashrom/+/63104
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Edward O'Callaghan <quasisec@chromium.org>
Reviewed-by: Nikolai Artemiev <nartemiev@google.com>
This commit is contained in:
Peter Marheine 2022-03-25 04:35:47 +00:00 committed by Edward O'Callaghan
parent 878d1e8704
commit f93e098bfa

View File

@ -395,6 +395,8 @@ bitbanging adapter)
.sp
.BR "* realtek_mst_i2c_spi" " (for SPI flash ROMs attached to Realtek DisplayPort hubs accessible through I2C)"
.sp
.BR "* lspcon_i2c_spi" " (for SPI flash ROMs attached to Parade Technologies LSPCONs)"
.sp
Some programmers have optional or mandatory parameters which are described
in detail in the
.B PROGRAMMER-SPECIFIC INFORMATION
@ -1417,21 +1419,25 @@ syntax where \fBfrequency\fP is the SPI clock frequency in kHz.
If the passed frequency is not supported by the adapter the nearest lower
supported frequency will be used.
.SS
.BR "realtek_mst_i2c_spi " programmer
.BR "realtek_mst_i2c_spi " and " lspcon_i2c_spi " programmers
.IP
This programmer supports SPI flash programming for chips attached to Realtek
DisplayPort MST hubs, themselves accessed through I2C (tunneling SPI flash
commands through the MST hub's I2C connection with the host).
The I2C bus on which the hub is reachable must be specified by either a device
path with the \fBdevpath\fP option:
These programmers tunnel SPI commands through I2C-connected devices. The I2C
bus over which communication occurs must be specified either by device path
with the \fBdevpath\fP option:
.sp
.B " flashrom \-p realtek_mst_i2c_spi:devpath=/dev/i2c-8"
.sp
or by a bus number with the \fBbus\fP option, which implies a device path like
/dev/i2c-N where N is the specified bus number:
.sp
.B " flashrom \-p realtek_mst_i2c_spi:bus=8"
.B " flashrom \-p lspcon_i2c_spi:bus=8"
.SS
.BR "realtek_mst_i2c_spi " programmer
.IP
This programmer supports SPI flash programming for chips attached to Realtek
DisplayPort MST hubs, themselves accessed through I2C (tunneling SPI flash
commands through the MST hub's I2C connection with the host).
.TP
.B In-system programming (ISP) mode
.sp
@ -1456,7 +1462,12 @@ flash):
.B " flashrom -p realtek_mst_i2c_spi:bus=0,enter-isp=1,reset-mcu=0 -E"
.br
.B " flashrom -p realtek_mst_i2c_spi:bus=0,enter-isp=0,reset-mcu=1 -w new.bin"
.sp
.SS
.BR "lspcon_i2c_spi " programmer
.IP
This programmer supports SPI flash programming for chips attached to Parade
Technologies DisplayPort-to-HDMI level shifter/protocol converters (LSPCONs).
Communication to the SPI flash is tunneled through the LSPCON over I2C.
.SH EXAMPLES
To back up and update your BIOS, run
@ -1535,8 +1546,8 @@ permissions are set.
.B ogp
needs PCI configuration space read access and raw memory access.
.sp
.B realtek_mst_i2c_spi
needs userspace access to the selected I2C bus.
.BR realtek_mst_i2c_spi " and " lspcon_i2c_spi
need userspace access to the selected I2C bus.
.sp
On OpenBSD, you can obtain raw access permission by setting
.B "securelevel=-1"