Skip to content

Commit f0a9b66

Browse files
committed
doc: fix xtensa commands type
Config commands should be reported as {Config Command} Change-Id: Ic778df31bb1dc9aefdbe3d8006b06bb370d25e6f Signed-off-by: Antonio Borneo <[email protected]> Reviewed-on: https://review.openocd.org/c/openocd/+/7266 Tested-by: jenkins Reviewed-by: Ian Thompson <[email protected]> Reviewed-by: Erhan Kurubas <[email protected]>
1 parent ee87f2b commit f0a9b66

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

doc/openocd.texi

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10976,12 +10976,12 @@ NXP}.
1097610976

1097710977
@subsection Xtensa Configuration Commands
1097810978

10979-
@deffn {Command} {xtensa xtdef} (@option{LX}|@option{NX})
10979+
@deffn {Config Command} {xtensa xtdef} (@option{LX}|@option{NX})
1098010980
Configure the Xtensa target architecture. Currently, Xtensa support is limited
1098110981
to LX6, LX7, and NX cores.
1098210982
@end deffn
1098310983

10984-
@deffn {Command} {xtensa xtopt} option value
10984+
@deffn {Config Command} {xtensa xtopt} option value
1098510985
Configure Xtensa target options that are relevant to the debug subsystem.
1098610986
@var{option} is one of: @option{arnum}, @option{windowed},
1098710987
@option{cpenable}, @option{exceptions}, @option{intnum}, @option{hipriints},
@@ -10993,43 +10993,43 @@ NOTE: Some options are specific to Xtensa LX or Xtensa NX architecture, while
1099310993
others may be common to both but have different valid ranges.
1099410994
@end deffn
1099510995

10996-
@deffn {Command} {xtensa xtmem} (@option{iram}|@option{dram}|@option{sram}|@option{irom}|@option{drom}|@option{srom}) baseaddr bytes
10996+
@deffn {Config Command} {xtensa xtmem} (@option{iram}|@option{dram}|@option{sram}|@option{irom}|@option{drom}|@option{srom}) baseaddr bytes
1099710997
Configure Xtensa target memory. Memory type determines access rights,
1099810998
where RAMs are read/write while ROMs are read-only. @var{baseaddr} and
1099910999
@var{bytes} are both integers, typically hexadecimal and decimal, respectively.
1100011000
@end deffn
1100111001

11002-
@deffn {Command} {xtensa xtmem} (@option{icache}|@option{dcache}) linebytes cachebytes ways [writeback]
11002+
@deffn {Config Command} {xtensa xtmem} (@option{icache}|@option{dcache}) linebytes cachebytes ways [writeback]
1100311003
Configure Xtensa processor cache. All parameters are required except for
1100411004
the optional @option{writeback} parameter; all are integers.
1100511005
@end deffn
1100611006

11007-
@deffn {Command} {xtensa xtmpu} numfgseg minsegsz lockable execonly
11007+
@deffn {Config Command} {xtensa xtmpu} numfgseg minsegsz lockable execonly
1100811008
Configure an Xtensa Memory Protection Unit (MPU). MPUs can restrict access
1100911009
and/or control cacheability of specific address ranges, but are lighter-weight
1101011010
than a full traditional MMU. All parameters are required; all are integers.
1101111011
@end deffn
1101211012

11013-
@deffn {Command} {xtensa xtmmu} numirefillentries numdrefillentries
11013+
@deffn {Config Command} {xtensa xtmmu} numirefillentries numdrefillentries
1101411014
(Xtensa-LX only) Configure an Xtensa Memory Management Unit (MMU). Both
1101511015
parameters are required; both are integers.
1101611016
@end deffn
1101711017

11018-
@deffn {Command} {xtensa xtregs} numregs
11018+
@deffn {Config Command} {xtensa xtregs} numregs
1101911019
Configure the total number of registers for the Xtensa core. Configuration
1102011020
logic expects to subsequently process this number of @code{xtensa xtreg}
1102111021
definitions. @var{numregs} is an integer.
1102211022
@end deffn
1102311023

11024-
@deffn {Command} {xtensa xtregfmt} (@option{sparse}|@option{contiguous}) [general]
11024+
@deffn {Config Command} {xtensa xtregfmt} (@option{sparse}|@option{contiguous}) [general]
1102511025
Configure the type of register map used by GDB to access the Xtensa core.
1102611026
Generic Xtensa tools (e.g. xt-gdb) require @option{sparse} mapping (default) while
1102711027
Espressif tools expect @option{contiguous} mapping. Contiguous mapping takes an
1102811028
additional, optional integer parameter @option{numgregs}, which specifies the number
1102911029
of general registers used in handling g/G packets.
1103011030
@end deffn
1103111031

11032-
@deffn {Command} {xtensa xtreg} name offset
11032+
@deffn {Config Command} {xtensa xtreg} name offset
1103311033
Configure an Xtensa core register. All core registers are 32 bits wide,
1103411034
while TIE and user registers may have variable widths. @var{name} is a
1103511035
character string identifier while @var{offset} is a hexadecimal integer.

0 commit comments

Comments
 (0)