X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=doc%2Fopenocd.texi;h=5a803d2c7b61a83101cfab3484763b78cd28fe9c;hp=cc7f6c8247c6d6c464817db190648b57681b9846;hb=f3b1405fddf0b32af27ad3894841f7d1702d8e5a;hpb=6819468a78ce9f0835a9063d93bc839f3d55eb84 diff --git a/doc/openocd.texi b/doc/openocd.texi index cc7f6c8247..5a803d2c7b 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -3088,6 +3088,7 @@ which are not currently documented here. @end quotation @end deffn +@anchor{hla_interface} @deffn {Interface Driver} {hla} This is a driver that supports multiple High Level Adapters. This type of adapter does not expose some of the lower level api's @@ -3170,11 +3171,20 @@ displays the names of the transports supported by this version of OpenOCD. @end deffn -@deffn Command {transport select} transport_name +@deffn Command {transport select} @option{transport_name} Select which of the supported transports to use in this OpenOCD session. -The transport must be supported by the debug adapter hardware and by the -version of OpenOCD you are using (including the adapter's driver). -No arguments: returns name of session's selected transport. + +When invoked with @option{transport_name}, attempts to select the named +transport. The transport must be supported by the debug adapter +hardware and by the version of OpenOCD you are using (including the +adapter's driver). + +If no transport has been selected and no @option{transport_name} is +provided, @command{transport select} auto-selects the first transport +supported by the debug adapter. + +@command{transport select} always returns the name of the session's selected +transport, if any. @end deffn @subsection JTAG Transport @@ -3185,6 +3195,12 @@ JTAG transports expose a chain of one or more Test Access Points (TAPs), each of which must be explicitly declared. JTAG supports both debugging and boundary scan testing. Flash programming support is built on top of debug support. + +JTAG transport is selected with the command @command{transport select +jtag}. Unless your adapter uses @ref{hla_interface,the hla interface +driver}, in which case the command is @command{transport select +hla_jtag}. + @subsection SWD Transport @cindex SWD @cindex Serial Wire Debug @@ -3194,6 +3210,12 @@ Debug Access Point (DAP, which must be explicitly declared. SWD is debug-oriented, and does not support boundary scan testing. Flash programming support is built on top of debug support. (Some processors support both JTAG and SWD.) + +SWD transport is selected with the command @command{transport select +swd}. Unless your adapter uses @ref{hla_interface,the hla interface +driver}, in which case the command is @command{transport select +hla_swd}. + @deffn Command {swd newdap} ... Declares a single DAP which uses SWD transport. Parameters are currently the same as "jtag newtap" but this is @@ -3205,11 +3227,6 @@ Wire Control Register (WCR). No parameters: displays current settings. @end deffn -@subsection CMSIS-DAP Transport -@cindex CMSIS-DAP -CMSIS-DAP is an ARM-specific transport that is used to connect to -compilant debuggers. - @subsection SPI Transport @cindex SPI @cindex Serial Peripheral Interface @@ -4352,7 +4369,7 @@ The value should normally correspond to a static mapping for the @anchor{rtostype} @item @code{-rtos} @var{rtos_type} -- enable rtos support for target, @var{rtos_type} can be one of @option{auto}|@option{eCos}|@option{ThreadX}| -@option{FreeRTOS}|@option{linux}|@option{ChibiOS}|@option{embKernel} +@option{FreeRTOS}|@option{linux}|@option{ChibiOS}|@option{embKernel}|@option{mqx} @xref{gdbrtossupport,,RTOS Support}. @end itemize @@ -5135,6 +5152,20 @@ Atmel include internal flash and use ARM's Cortex-M4 core. This driver uses the same cmd names/syntax as @xref{at91sam3}. @end deffn +@deffn {Flash Driver} at91sam4l +@cindex at91sam4l +All members of the AT91SAM4L microcontroller family from +Atmel include internal flash and use ARM's Cortex-M4 core. +This driver uses the same cmd names/syntax as @xref{at91sam3}. + +The AT91SAM4L driver adds some additional commands: +@deffn Command {at91sam4l smap_reset_deassert} +This command releases internal reset held by SMAP +and prepares reset vector catch in case of reset halt. +Command is used internally in event event reset-deassert-post. +@end deffn +@end deffn + @deffn {Flash Driver} at91sam7 All members of the AT91SAM7 microcontroller family from Atmel include internal flash and use ARM7TDMI cores. The driver automatically @@ -6469,8 +6500,10 @@ Useful in connection with script files (@command{script} command and @command{target_name} configuration). @end deffn -@deffn Command shutdown -Close the OpenOCD daemon, disconnecting all clients (GDB, telnet, other). +@deffn Command shutdown [@option{error}] +Close the OpenOCD daemon, disconnecting all clients (GDB, telnet, +other). If option @option{error} is used, OpenOCD will return a +non-zero exit code to the parent process. @end deffn @anchor{debuglevel} @@ -8568,6 +8601,7 @@ Currently supported rtos's include: @item @option{linux} @item @option{ChibiOS} @item @option{embKernel} +@item @option{mqx} @end itemize @quotation Note @@ -8591,6 +8625,8 @@ rlist, ch_debug, chSysInit. @item embKernel symbols Rtos::sCurrentTask, Rtos::sListReady, Rtos::sListSleep, Rtos::sListSuspended, Rtos::sMaxPriorities, Rtos::sCurrentTaskCount. +@item mqx symbols +_mqx_kernel_data, MQX_init_struct. @end table For most RTOS supported the above symbols will be exported by default. However for