doc: document 'cmsis-dap cmd' command
authorTomas Vanek <vanekt@fbl.cz>
Sat, 20 Nov 2021 16:53:03 +0000 (17:53 +0100)
committerAntonio Borneo <borneo.antonio@gmail.com>
Fri, 3 Dec 2021 21:54:03 +0000 (21:54 +0000)
Change-Id: I90b7f020ee2bf078fdf22e3d21423f333ae061ac
Signed-off-by: Tomas Vanek <vanekt@fbl.cz>
Reviewed-on: https://review.openocd.org/c/openocd/+/6732
Tested-by: jenkins
Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
doc/openocd.texi

index 7962093e419a1eadba1494e00fd9370c2616dadb..4923a872b50b30797b2d055514a5defcd29d098a 100644 (file)
@@ -2447,6 +2447,16 @@ interface string or for user class interface.
 @deffn {Command} {cmsis-dap info}
 Display various device information, like hardware version, firmware version, current bus status.
 @end deffn
+
+@deffn {Command} {cmsis-dap cmd} number number ...
+Execute an arbitrary CMSIS-DAP command. Use for adapter testing or for handling
+of an adapter vendor specific command from a Tcl script.
+
+Take given numbers as bytes, assemble a CMSIS-DAP protocol command packet
+from them and send it to the adapter. The first 4 bytes of the adapter response
+are logged.
+See @url{https://arm-software.github.io/CMSIS_5/DAP/html/group__DAP__Commands__gr.html}
+@end deffn
 @end deffn
 
 @deffn {Interface Driver} {dummy}