summaryrefslogtreecommitdiffstats
path: root/flashrom.8.tmpl
diff options
context:
space:
mode:
Diffstat (limited to 'flashrom.8.tmpl')
-rw-r--r--flashrom.8.tmpl64
1 files changed, 64 insertions, 0 deletions
diff --git a/flashrom.8.tmpl b/flashrom.8.tmpl
index eb7fdec45..27f38465a 100644
--- a/flashrom.8.tmpl
+++ b/flashrom.8.tmpl
@@ -341,6 +341,8 @@ bitbanging adapter)
.sp
.BR "* jlink_spi" " (for SPI flash ROMs attached to SEGGER J-Link and compatible devices)"
.sp
+.BR "* ni845x_spi" " (for SPI flash ROMs attached to National Instruments USB-8451 or USB-8452)"
+.sp
Some programmers have optional or mandatory parameters which are described
in detail in the
.B PROGRAMMER-SPECIFIC INFORMATION
@@ -1126,6 +1128,68 @@ Please also note that the mstarddc_spi driver only works on Linux.
The WCH CH341A programmer does not support any parameters currently. SPI frequency is fixed at 2 MHz, and CS0 is
used as per the device.
.SS
+.BR "ni845x_spi " programmer
+.IP
+An optional
+.B voltage
+parameter could be used to specify the IO voltage. This parameter is available for the NI USB-8452 device.
+The default unit is Volt if no unit is specified. You can use
+.BR mV ", " milliVolt ", " V " or " Volt
+as unit specifier.
+Syntax is
+.sp
+.B " flashrom \-p ni845x_spi:voltage=value"
+.sp
+where
+.B value
+can be
+.BR 1.2V ", " 1.5V ", " 1.8V ", " 2.5V ", " 3.3V
+or the equivalent in mV.
+.sp
+In the case if none of the programmer's supported IO voltage is within the supported voltage range of
+the detected flash chip the flashrom will abort the operation (to prevent damaging the flash chip).
+You can override this behaviour by passing "yes" to the
+.B ignore_io_voltage_limits
+parameter (for e.g. if you are using an external voltage translator circuit).
+Syntax is
+.sp
+.B " flashrom \-p ni845x_spi:ignore_io_voltage_limits=yes"
+.sp
+You can use the
+.B serial
+parameter to explicitly specify which connected NI USB-845x device should be used.
+You should use your device's 7 digit hexadecimal serial number.
+Usage example to select the device with 1230A12 serial number:
+.sp
+.B " flashrom \-p ni845x_spi:serial=1230A12"
+.sp
+An optional
+.B spispeed
+parameter specifies the frequency of the SPI bus.
+Syntax is
+.sp
+.B " flashrom \-p ni845x_spi:spispeed=frequency"
+.sp
+where
+.B frequency
+should a number corresponding to the desired frequency in kHz.
+The maximum
+.B frequency
+is 12 MHz (12000 kHz) for the USB-8451 and 50 MHz (50000 kHz) for the USB-8452.
+The default is a frequency of 1 MHz (1000 kHz).
+.sp
+An optional
+.B cs
+parameter specifies which target chip select line should be used. Syntax is
+.sp
+.B " flashrom \-p ni845x_spi:csnumber=value"
+.sp
+where
+.B value
+should be between
+.BR 0 " and " 7
+By default the CS0 is used.
+.SS
.BR "digilent_spi " programmer
.IP
An optional