third_party.pigweed.src/targets/lm3s6965evb-qemu/target_docs.rst
Wyatt Hepler f9fb90f299 docs: Make labels consistent; remove boilerplate
- Update labels so they use consistent naming. Instead of the
  copy-and-pasted `chapter` prefix, name labels with a prefix consistent
  with what they point to:
  - "module-" for module
  - "target-" for targets
  - "docs-" for general documentation
- Remove the unnecessary highlight and default-domain directives.
  Neither is necessary since the Pigweed docs always specify the
  language in code snippets and other directives.

Change-Id: I55c34e9ec919f6f4670e5d3d008e0edf5fecf05b
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/19328
Commit-Queue: Wyatt Hepler <hepler@google.com>
Reviewed-by: Keir Mierle <keir@google.com>
2020-10-01 21:47:35 +00:00

65 lines
1.6 KiB
ReStructuredText

.. _target-lm3s6965evb-qemu:
----------------
lm3s6965evb-qemu
----------------
This target is specifically for emulation of the Texas Instruments Stellaris
LM3S lm3s6965evb using QEMU. This may be useful for testing ARMv7-M code without
physical hardware.
This target configuration has **not** been tested on the physical Stellaris
development board.
Building
========
To build for this Pigweed target, simply build the top-level "qemu" Ninja
target.
.. code:: sh
$ ninja -C out qemu
Testing
=======
This target does not yet support automatic test running (though it would be
relatively easy to do so). To run a QEMU binary, see the instructions below.
Executing Binaries
==================
When running a QEMU binary, you may chose to run it interactively with GDB, or
allow the binary to run in a hands-off manner.
Running Without GDB
-------------------
When running without GDB, the firmware will execute normally without requiring
further interaction.
.. code:: sh
$ qemu-system-arm -cpu cortex-m3 -machine lm3s6965evb \
-nographic -no-reboot \
-kernel path/to/firmware.elf
Run With GDB
------------------
When running with GDB, execution of the binary will begin in a halted state. To
begin running the code, you must connect using GDB, set any breakpoints you
wish, and then continue execution.
.. code:: sh
# Start the VM and GDB server.
$ qemu-system-arm -cpu cortex-m3 -machine lm3s6965evb \
-gdb tcp::3333 -S
-nographic -no-reboot \
-kernel path/to/firmware.elf
In another window
.. code:: sh
$ arm-none-eabi-gdb path/to/firmare.elf
(gdb) target remote :3333
(gdb) break SomeFunction()
(gdb) continue