]> git.gag.com Git - fw/openocd/commitdiff
doc: command 'ftdi_layout_signal' can run after config
authorAntonio Borneo <borneo.antonio@gmail.com>
Wed, 7 Apr 2021 13:25:37 +0000 (15:25 +0200)
committerAntonio Borneo <borneo.antonio@gmail.com>
Sun, 25 Apr 2021 22:04:29 +0000 (23:04 +0100)
The mode of command 'ftdi_layout_signal' is set to COMMAND_ANY in
[1] and the command has no constraints that limits its use to the
config phase only.
But [2] documents it as '{Config Command}'.

Update the documentation to report the correct mode '{Command}'.

[1] commit f5e97b5e1b62 ("Add FTDI JTAG driver using MPSSE layer")
[2] commit 76afadeb7b4e ("doc: Add documentation for the ftdi driver")

Change-Id: I6b14aebb98e48f7080c585f3df881714bb188af0
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-on: http://openocd.zylin.com/6155
Tested-by: jenkins
Reviewed-by: Andreas Fritiofson <andreas.fritiofson@gmail.com>
doc/openocd.texi

index 3523a222a95df67ddfd3f0e3a79fb8ec87fa4ab9..4dd3a3389d62a9006d3c0cf30b6f0b6ba7d03147 100644 (file)
@@ -2531,7 +2531,7 @@ minimal impact on the target system. Avoid floating inputs, conflicting outputs
 and initially asserted reset signals.
 @end deffn
 
-@deffn {Config Command} {ftdi_layout_signal} name [@option{-data}|@option{-ndata} data_mask] [@option{-input}|@option{-ninput} input_mask] [@option{-oe}|@option{-noe} oe_mask] [@option{-alias}|@option{-nalias} name]
+@deffn {Command} {ftdi_layout_signal} name [@option{-data}|@option{-ndata} data_mask] [@option{-input}|@option{-ninput} input_mask] [@option{-oe}|@option{-noe} oe_mask] [@option{-alias}|@option{-nalias} name]
 Creates a signal with the specified @var{name}, controlled by one or more FTDI
 GPIO pins via a range of possible buffer connections. The masks are FTDI GPIO
 register bitmasks to tell the driver the connection and type of the output