riscv-openocd/doc/manual
J. Neuschäfer 79b51fedab remote_bitbang: Change sleep commands to Zz to avoid conflict with SWD
It was noticed that the remote_bitbang protocol has a design issue:
SWD and sleep commands cannot be implemented at the same time, because
they overlap:

 - SWD uses d,e,f,g for setting pin state
 - sleep uses d,D for microsecond and millisecond sleep, respectively

This has previously been reported by Marek Vrbka, but it wasn't fixed.

This commit does the following to resolve the issue:

 - Change the sleep commands to 'Z' for 1 ms, 'z' for 1 µs
 - Document 'D' and 'd' as deprecated aliases
 - Switch the remote_bitbang driver in OpenOCD to 'Z' and 'z'

Unfortunately that's a breaking change, because existing adapter-side
implementations of the protocol will have to implement the new commands
to keep working with future versions of OpenOCD. Fortunately, the
remote sleep commands haven't been part of an OpenOCD release yet,
which should limit the breakage somewhat.

Reported-by: Marek Vrbka <marek.vrbka@codasip.com>
Link: https://sourceforge.net/p/openocd/mailman/openocd-devel/thread/670d28d2-75a1-45ec-afe5-541415701d7a%40codasip.com/
Fixes: e8e09b1b5 ("remote_bitbang: add use_remote_sleep option to send delays to remote")
Change-Id: I04d2790a33bff9d47eb7f69b3275fd9a271625ae
Signed-off-by: J. Neuschäfer <j.neuschaefer@gmx.net>
Reviewed-on: https://review.openocd.org/c/openocd/+/8191
Reviewed-by: David Ryskalczyk <david.rysk@gmail.com>
Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
Tested-by: jenkins
Reviewed-by: Jeremy Herbert <jeremy.006@gmail.com>
2024-04-07 19:36:29 +00:00
..
images doxygen: use inline jtag state maching image 2013-07-01 08:50:31 +00:00
jtag/drivers remote_bitbang: Change sleep commands to Zz to avoid conflict with SWD 2024-04-07 19:36:29 +00:00
primer doc: use the new jimtcl syntax for 'expr' 2022-01-22 10:13:36 +00:00
target doc/target/mips: fix grammar 2020-07-26 20:08:48 +01:00
app.txt Commit skeleton files for high-level developer manual using doxygen. 2009-05-13 08:58:08 +00:00
endianness.txt doc: how to use QEMU to test big-endian build 2022-08-27 16:18:17 +00:00
flash.txt Remove annoying end-of-line whitespace from doc/* files. 2009-09-21 18:52:45 +00:00
helper.txt helper/command: pass command arguments also as Jim_Obj 2024-01-13 14:44:32 +00:00
jtag.txt zy1000: drop the code, deprecated in v0.10.0 2021-03-19 21:55:50 +00:00
main.txt doc: how to use QEMU to test big-endian build 2022-08-27 16:18:17 +00:00
release.txt doc: remove duplicated words 2020-07-14 00:39:18 +01:00
scripting.txt doc: fix several typos within manual documents 2018-05-09 11:43:23 +01:00
server.txt doc: remove duplicated words 2020-07-14 00:39:18 +01:00
style.txt doc/style: clarify default case for enumerators 2023-09-08 21:58:47 +00:00
target.txt doc: Added MIPS target document 2013-03-13 12:29:54 +00:00