mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
71153c7dbb
This extension allows running programs in QEMU similar to running them on a real chip: - 'idf.py qemu' — builds and runs the program in QEMU. User gets a QEMU instance launched, and can work with it as a normal QEMU instance. - 'idf.py qemu monitor' — same, but QEMU is launched in the background, and idf_monitor runs in the foreground, showing QEMU output. Compared to only running 'idf.py qemu' this enables, for example, automatic backtrace decoding. - 'idf.py qemu gdb' — launches QEMU in the background and opens an interactive GDB prompt, connecting it to QEMU. - 'idf.py qemu --gdb monitor' and 'idf.py gdb' in another shell: launches QEMU in the background, keeps it suspended until GDB is connected, and opens idf_monitor. GDB can be used in another shell to debug the application.
65 lines
2.8 KiB
ReStructuredText
65 lines
2.8 KiB
ReStructuredText
QEMU Emulator
|
|
=============
|
|
|
|
Espressif maintains a `fork <https://github.com/espressif/qemu>`_ of the QEMU emulator with support for {IDF_TARGET_NAME}. This fork implements emulation of the CPU, memory, and several peripherals of {IDF_TARGET_NAME}. For more information about QEMU for {IDF_TARGET_NAME}, see the `documentation <https://github.com/espressif/esp-toolchain-docs/blob/main/qemu/README.md>`_.
|
|
|
|
:doc:`idf.py<idf-py>` allows for running and debugging applications in QEMU. This is a convenient way to test applications without having to flash them to real hardware.
|
|
|
|
Prerequisites
|
|
-------------
|
|
|
|
To use QEMU with ``idf.py`` you first need to install the above-mentioned fork of QEMU. ESP-IDF provides pre-built binaries for x86_64 Linux. If you are using this platform, you can install the pre-built binaries with the following command:
|
|
|
|
.. code-block:: console
|
|
|
|
python $IDF_PATH/tools/idf_tools.py install qemu-xtensa qemu-riscv
|
|
|
|
After installing QEMU, make sure it is added to PATH by running ``. ./export.sh`` in the IDF directory.
|
|
|
|
If you are using a different platform, you need to build QEMU from source. Refer to official QEMU documentation for instructions.
|
|
|
|
Usage
|
|
-----
|
|
|
|
To run an IDF application in QEMU, use the following command:
|
|
|
|
.. code-block:: console
|
|
|
|
idf.py qemu monitor
|
|
|
|
This command builds the application, starts QEMU and opens :doc:`IDF monitor <idf-monitor>`, connecting it to the emulated UART port. You can see the console output of the application and interact with it. IDF Monitor also provides automatic decoding of panic backtraces and UART core dumps.
|
|
|
|
To debug an application in QEMU, use the following command:
|
|
|
|
.. code-block:: console
|
|
|
|
idf.py qemu gdb
|
|
|
|
This command builds the application, starts QEMU with the GDB server enabled, and opens an interactive GDB session. You can use GDB to debug the application as if it was running on real hardware.
|
|
|
|
To see console output while debugging in QEMU, use two terminals.
|
|
|
|
* In the first terminal, run:
|
|
|
|
.. code-block:: console
|
|
|
|
idf.py qemu --gdb monitor
|
|
|
|
This command starts QEMU and IDF Monitor, and tells QEMU to wait for a GDB connection.
|
|
|
|
* In the second terminal, run:
|
|
|
|
.. code-block:: console
|
|
|
|
idf.py gdb
|
|
|
|
This command starts an interactive GDB sessions and connects it to QEMU. You can now debug the application, and the console output will be visible in the first terminal.
|
|
|
|
It is also possible to run QEMU without the IDF Monitor:
|
|
|
|
.. code-block:: console
|
|
|
|
idf.py qemu
|
|
|
|
In this case, the IDF Monitor is not used, and you can interact with QEMU process directly. To switch between the emulated UART console and QEMU console ("QEMU monitor"), use Ctrl-A shortcut. For example, to exit QEMU, press Ctrl-A, then type ``q`` and press Enter. You can use the QEMU console to enter commands, such as for inspecting registers and memory.
|