diff --git a/Documentation/guides/minidumpserver.rst b/Documentation/guides/minidumpserver.rst index 4ad7cfee3a..c27b1469fc 100644 --- a/Documentation/guides/minidumpserver.rst +++ b/Documentation/guides/minidumpserver.rst @@ -7,26 +7,27 @@ Introduction This tool can utilize a crash log on a PC to simulate a set of GDB server functionalities, enabling the use of GDB to debug the context of a NuttX crash. -The script directory is located in `tools/minidumpserver.py`. +The script directory is located in ``tools/minidumpserver.py``. Usage ===== -We can use `-h` to get help information: -```bash -$usage: minidumpserver.py [-h] -e ELFFILE -l LOGFILE [-a {arm,arm-a,arm-t,riscv,esp32s3,xtensa}] [-p PORT] [--debug] +We can use ``-h`` to get help information: -options: - -h, --help show this help message and exit - -e ELFFILE, --elffile ELFFILE - elffile - -l LOGFILE, --logfile LOGFILE - logfile - -a {arm,arm-a,arm-t,riscv,esp32s3,xtensa}, --arch {arm,arm-a,arm-t,riscv,esp32s3,xtensa} - select architecture,if not use this options, The architecture will be inferred from the logfile - -p PORT, --port PORT gdbport - --debug -``` +.. code-block:: bash + + $ usage: minidumpserver.py [-h] -e ELFFILE -l LOGFILE [-a {arm,arm-a,arm-t,riscv,esp32s3,xtensa}] [-p PORT] [--debug] + + options: + -h, --help show this help message and exit + -e ELFFILE, --elffile ELFFILE + elffile + -l LOGFILE, --logfile LOGFILE + logfile + -a {arm,arm-a,arm-t,riscv,esp32s3,xtensa}, --arch {arm,arm-a,arm-t,riscv,esp32s3,xtensa} + select architecture, if not use this options, The architecture will be inferred from the logfile + -p PORT, --port PORT gdbport + --debug Example ======= @@ -36,74 +37,76 @@ Example 4. Run `minicom -D /dev/ttyUSB0 -b 115200` and reset esp32s3-devkit. 5. Use `mw -1` on nsh to trigger a crash. 6. Get the crash log from minicom and save it to `crash.log`. -``` -up_dump_register: PC: 42009cd8 PS: 00060820 -up_dump_register: A0: 82007d71 A1: 3fc8b6d0 A2: 3fc8b8e0 A3: 00000000 -up_dump_register: A4: ffffffff A5: 00000000 A6: 00000001 A7: 00000000 -up_dump_register: A8: ffffffff A9: 3fc8b690 A10: ffffffff A11: 00000000 -up_dump_register: A12: 0000002d A13: 0000002d A14: 3fc8bb6d A15: 0fffffff -up_dump_register: SAR: 00000000 CAUSE: 0000001c VADDR: ffffffff -up_dump_register: LBEG: 40055499 LEND: 400554a9 LCNT: fffffffc -dump_stack: User Stack: -dump_stack: base: 0x3fc8b0e0 -dump_stack: size: 00002000 -dump_stack: sp: 0x3fc8b6d0 -stack_dump: 0x3fc8b6c0: 82007770 3fc8b700 3fc8b8e0 00000002 ffffffff 3fc89f54 00060e20 00000000 -stack_dump: 0x3fc8b6e0: 3fc8b8e0 3fc8b778 00000000 3fc8b750 82007850 3fc8b720 3fc8b8e0 00000002 -stack_dump: 0x3fc8b700: 3fc8b720 42009c84 3fc8bb68 3fc8b8e0 82006b04 3fc8b7d0 3fc8b8e0 3fc8bb68 -stack_dump: 0x3fc8b720: 3fc8bb68 3fc8bb6b 00000000 00000000 00000000 00000000 00000000 00000000 -stack_dump: 0x3fc8b740: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 -stack_dump: 0x3fc8b760: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 3fc8bb69 -stack_dump: 0x3fc8b780: 82006ad5 00000000 00000000 00000040 00000040 3fc8bb6e 3fc8adf8 0000002c -stack_dump: 0x3fc8b7a0: ffffffff 00000005 00000000 00000000 3fc8bae0 00000000 00000000 00000000 -stack_dump: 0x3fc8b7c0: 820068a2 3fc8b800 3fc8b8e0 3c020837 00000001 3fc8b800 3fc8b8e0 3c020837 -stack_dump: 0x3fc8b7e0: 0000000a 3fc8bae0 00000001 3fc8bb68 82006865 3fc8b820 00000001 3fc8b0c0 -stack_dump: 0x3fc8b800: 00000001 3fc8bb68 00000000 3fc8ae1c 82003618 3fc8b840 00000001 3fc8b0c0 -stack_dump: 0x3fc8b820: 3fc8b8e0 00000000 00000000 00000000 820019dc 3fc8b870 42006834 00000001 -stack_dump: 0x3fc8b840: 00000064 00000000 00000000 00000000 3c0225d8 3fc89590 00000000 3fc880cc -stack_dump: 0x3fc8b860: 00000000 3fc8b890 00000000 00000000 3fc8b0c0 00000002 00000000 3fc8ad98 -stack_dump: 0x3fc8b880: 00000000 3fc8b8b0 00000000 00000000 00000000 00000000 00000000 00000000 -``` + +.. code-block:: bash + + up_dump_register: PC: 42009cd8 PS: 00060820 + up_dump_register: A0: 82007d71 A1: 3fc8b6d0 A2: 3fc8b8e0 A3: 00000000 + up_dump_register: A4: ffffffff A5: 00000000 A6: 00000001 A7: 00000000 + up_dump_register: A8: ffffffff A9: 3fc8b690 A10: ffffffff A11: 00000000 + up_dump_register: A12: 0000002d A13: 0000002d A14: 3fc8bb6d A15: 0fffffff + up_dump_register: SAR: 00000000 CAUSE: 0000001c VADDR: ffffffff + up_dump_register: LBEG: 40055499 LEND: 400554a9 LCNT: fffffffc + dump_stack: User Stack: + dump_stack: base: 0x3fc8b0e0 + dump_stack: size: 00002000 + dump_stack: sp: 0x3fc8b6d0 + stack_dump: 0x3fc8b6c0: 82007770 3fc8b700 3fc8b8e0 00000002 ffffffff 3fc89f54 00060e20 00000000 + stack_dump: 0x3fc8b6e0: 3fc8b8e0 3fc8b778 00000000 3fc8b750 82007850 3fc8b720 3fc8b8e0 00000002 + stack_dump: 0x3fc8b700: 3fc8b720 42009c84 3fc8bb68 3fc8b8e0 82006b04 3fc8b7d0 3fc8b8e0 3fc8bb68 + stack_dump: 0x3fc8b720: 3fc8bb68 3fc8bb6b 00000000 00000000 00000000 00000000 00000000 00000000 + stack_dump: 0x3fc8b740: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 + stack_dump: 0x3fc8b760: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 3fc8bb69 + stack_dump: 0x3fc8b780: 82006ad5 00000000 00000000 00000040 00000040 3fc8bb6e 3fc8adf8 0000002c + stack_dump: 0x3fc8b7a0: ffffffff 00000005 00000000 00000000 3fc8bae0 00000000 00000000 00000000 + stack_dump: 0x3fc8b7c0: 820068a2 3fc8b800 3fc8b8e0 3c020837 00000001 3fc8b800 3fc8b8e0 3c020837 + stack_dump: 0x3fc8b7e0: 0000000a 3fc8bae0 00000001 3fc8bb68 82006865 3fc8b820 00000001 3fc8b0c0 + stack_dump: 0x3fc8b800: 00000001 3fc8bb68 00000000 3fc8ae1c 82003618 3fc8b840 00000001 3fc8b0c0 + stack_dump: 0x3fc8b820: 3fc8b8e0 00000000 00000000 00000000 820019dc 3fc8b870 42006834 00000001 + stack_dump: 0x3fc8b840: 00000064 00000000 00000000 00000000 3c0225d8 3fc89590 00000000 3fc880cc + stack_dump: 0x3fc8b860: 00000000 3fc8b890 00000000 00000000 3fc8b0c0 00000002 00000000 3fc8ad98 + stack_dump: 0x3fc8b880: 00000000 3fc8b8b0 00000000 00000000 00000000 00000000 00000000 00000000 + 7. Run `./tools/minidumpserver.py -e nuttx -l crash.log -p 1234 -a esp32s3` 8. Run `xtensa-esp32s3-elf-gdb nuttx -ex "target remote 127.0.0.1:1234"` -```bash -GNU gdb (esp-gdb) 12.1_20221002 -Copyright (C) 2022 Free Software Foundation, Inc. -License GPLv3+: GNU GPL version 3 or later -This is free software: you are free to change and redistribute it. -There is NO WARRANTY, to the extent permitted by law. -Type "show copying" and "show warranty" for details. -This GDB was configured as "--host=x86_64-linux-gnu --target=xtensa-esp-elf". -Type "show configuration" for configuration details. -For bug reporting instructions, please see: -. -Find the GDB manual and other documentation resources online at: - . +.. code-block:: bash -For help, type "help". -Type "apropos word" to search for commands related to "word"... -Reading symbols from nuttx... -Remote debugging using 127.0.0.1:1234 -0x42009cd8 in cmd_mw (vtbl=0x3fc8b8e0, argc=, argv=) at nsh_dbgcmds.c:259 -259 nsh_output(vtbl, " %p = 0x%08" PRIx32, ptr, *ptr); -(gdb) bt -#0 0x42009cd8 in cmd_mw (vtbl=0x3fc8b8e0, argc=, argv=) at nsh_dbgcmds.c:259 -#1 0x42007d71 in nsh_command (vtbl=0x3fc8b8e0, argc=2, argv=0x3fc8b720) at nsh_command.c:1154 -#2 0x42007770 in nsh_execute (oflags=, redirfile=0x0, argv=0x3fc8b720, argc=2, vtbl=0x3fc8b8e0) - at nsh_parse.c:845 -#3 nsh_parse_command (vtbl=0x3fc8b8e0, cmdline=) at nsh_parse.c:2744 -#4 0x42007850 in nsh_parse (vtbl=0x3fc8b8e0, - cmdline=0x3fc8bb68 ) at nsh_parse.c:2828 -#5 0x42006b04 in nsh_session (pstate=0x3fc8b8e0, login=, argc=1, argv=) - at nsh_session.c:245 -#6 0x420068a2 in nsh_consolemain (argc=1, argv=0x3fc8b0c0) at nsh_consolemain.c:71 -#7 0x42006865 in nsh_main (argc=1, argv=0x3fc8b0c0) at nsh_main.c:74 -#8 0x42003618 in nxtask_startup (entrypt=0x42006834 , argc=1, argv=0x3fc8b0c0) - at sched/task_startup.c:70 -#9 0x420019dc in nxtask_start () at task/task_start.c:134 -(gdb) -```` + GNU gdb (esp-gdb) 12.1_20221002 + Copyright (C) 2022 Free Software Foundation, Inc. + License GPLv3+: GNU GPL version 3 or later + This is free software: you are free to change and redistribute it. + There is NO WARRANTY, to the extent permitted by law. + Type "show copying" and "show warranty" for details. + This GDB was configured as "--host=x86_64-linux-gnu --target=xtensa-esp-elf". + Type "show configuration" for configuration details. + For bug reporting instructions, please see: + . + Find the GDB manual and other documentation resources online at: + . + + For help, type "help". + Type "apropos word" to search for commands related to "word"... + Reading symbols from nuttx... + Remote debugging using 127.0.0.1:1234 + 0x42009cd8 in cmd_mw (vtbl=0x3fc8b8e0, argc=, argv=) at nsh_dbgcmds.c:259 + 259 nsh_output(vtbl, " %p = 0x%08" PRIx32, ptr, *ptr); + (gdb) bt + #0 0x42009cd8 in cmd_mw (vtbl=0x3fc8b8e0, argc=, argv=) at nsh_dbgcmds.c:259 + #1 0x42007d71 in nsh_command (vtbl=0x3fc8b8e0, argc=2, argv=0x3fc8b720) at nsh_command.c:1154 + #2 0x42007770 in nsh_execute (oflags=, redirfile=0x0, argv=0x3fc8b720, argc=2, vtbl=0x3fc8b8e0) + at nsh_parse.c:845 + #3 nsh_parse_command (vtbl=0x3fc8b8e0, cmdline=) at nsh_parse.c:2744 + #4 0x42007850 in nsh_parse (vtbl=0x3fc8b8e0, + cmdline=0x3fc8bb68 ) at nsh_parse.c:2828 + #5 0x42006b04 in nsh_session (pstate=0x3fc8b8e0, login=, argc=1, argv=) + at nsh_session.c:245 + #6 0x420068a2 in nsh_consolemain (argc=1, argv=0x3fc8b0c0) at nsh_consolemain.c:71 + #7 0x42006865 in nsh_main (argc=1, argv=0x3fc8b0c0) at nsh_main.c:74 + #8 0x42003618 in nxtask_startup (entrypt=0x42006834 , argc=1, argv=0x3fc8b0c0) + at sched/task_startup.c:70 + #9 0x420019dc in nxtask_start () at task/task_start.c:134 + (gdb) How to add new architecture =========================== diff --git a/Documentation/guides/ofloader.rst b/Documentation/guides/ofloader.rst index 5af13ff9d2..be19b6ffce 100644 --- a/Documentation/guides/ofloader.rst +++ b/Documentation/guides/ofloader.rst @@ -13,9 +13,10 @@ CONFIGURATION =============== .. code-block:: c - CONFIG_DISABLE_IDLE_LOOP=y - CONFIG_SYSTEM_OFLOADER=y - CONFIG_SYSTEM_OFLOADER_TABLE="/dev/flash,0x08000000,0x20000"，0 + + CONFIG_DISABLE_IDLE_LOOP=y + CONFIG_SYSTEM_OFLOADER=y + CONFIG_SYSTEM_OFLOADER_TABLE="/dev/flash,0x08000000,0x20000"，0 ```CONFIG_DISABLE_IDLE_LOOP`` is used to disable the idle loop in NuttX. ```CONFIG_SYSTEM_OFLOADER``` is used to enable the Open Flash Loader. @@ -32,13 +33,14 @@ Usage 1. Build NuttX with Open Flash Loader. 2. Configure the Jlink xml file. like -.. code-block:: - - - - - - +.. code-block:: xml + + + + + + + 3. Use ``JLinkExe -if SWD -speed 4000 -device STM32NUTTX``, then ``loadbin /home/ajh/work/nuttx.bin 0x08000000``,